Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add identity deletion #41

Merged
merged 4 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nmshd/connector-tui",
"version": "2.1.0",
"version": "2.2.0",
"repository": "github:nmshd/connector-tui",
"license": "MIT",
"author": "j&s-soft GmbH",
Expand Down Expand Up @@ -29,6 +29,7 @@
},
"dependencies": {
"@nmshd/connector-sdk": "^6.7.0",
"axios": "^1.7.9",
"chalk": "^5.3.0",
"dotenv": "^16.4.7",
"luxon": "^3.5.0",
Expand Down
20 changes: 16 additions & 4 deletions src/ConnectorTUI.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,17 @@ import { ConnectorClient } from "@nmshd/connector-sdk"
import { ConnectorVersionInfo } from "@nmshd/connector-sdk/dist/types/monitoring"
import chalk from "chalk"
import { readFile } from "fs/promises"
import { DateTime } from "luxon"
import prompts from "prompts"
import { ConnectorTUIBaseWithMixins } from "./mixins/index.js"

export class ConnectorTUI extends ConnectorTUIBaseWithMixins {
public static async create(baseUrl: string, apiKey: string) {
const client = ConnectorClient.create({ baseUrl, apiKey })
const address = (await client.account.getIdentityInfo()).result.address
const support = await client.monitoring.getSupport()

return new ConnectorTUI(client, address)
return new ConnectorTUI(client, address, support)
}

public async run() {
Expand All @@ -21,11 +23,22 @@ export class ConnectorTUI extends ConnectorTUIBaseWithMixins {

// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, no-constant-condition
while (true) {
const activeIdentityDeletionProcess = this.isDebugMode() ? await this.identityDeletionProcessEndpoint.getActiveIdentityDeletionProcess() : undefined

if (activeIdentityDeletionProcess?.isSuccess && activeIdentityDeletionProcess.result.status === "Approved") {
const gracePeriodEndsAtDateTime = DateTime.fromISO(activeIdentityDeletionProcess.result.gracePeriodEndsAt!)

if (gracePeriodEndsAtDateTime.diffNow().milliseconds < 0) {
console.log(chalk.red("Grace period has ended. Identity is deleted."))
process.exit(0)
}
}

const result = await prompts({
type: "select",
name: "action",
message: "What do you want to do?",
choices: this.choices,
choices: activeIdentityDeletionProcess?.isSuccess ? this.choicesInDeletion : this.choices,
})

if (!result.action) break
Expand Down Expand Up @@ -57,8 +70,7 @@ export class ConnectorTUI extends ConnectorTUIBaseWithMixins {
const jsonString = (await readFile(new URL("../package.json", import.meta.url))).toString()
const packageJson = JSON.parse(jsonString)

const support = await this.connectorClient.monitoring.getSupport()
const baseUrl = (support.configuration.transportLibrary as any)?.baseUrl
const baseUrl = (this.support.configuration.transportLibrary as any)?.baseUrl

console.log(`Welcome to the ${chalk.blue("enmeshed V2 TUI")}!`)
console.log(`TUI Version: ${chalk.yellow(packageJson.version)}`)
Expand Down
15 changes: 13 additions & 2 deletions src/ConnectorTUIBase.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { ConnectorClient, ConnectorFile, ConnectorRelationship, ConnectorRelationshipStatus } from "@nmshd/connector-sdk"
import { ConnectorSupportInformation } from "@nmshd/connector-sdk/dist/types/monitoring"
import { DisplayNameJSON, GivenNameJSON, SurnameJSON } from "@nmshd/content"
import prompts from "prompts"
import { IdentityDeletionProcessEndpoint } from "./IdentityDeletionProcessEndpoint"

export type ConnectorTUIBaseConstructor = new (...args: any[]) => ConnectorTUIBase

Expand All @@ -10,11 +12,16 @@ export interface ConnectorTUIChoice extends prompts.Choice {

export class ConnectorTUIBase {
protected choices: ConnectorTUIChoice[] = []
protected choicesInDeletion: ConnectorTUIChoice[] = []
protected identityDeletionProcessEndpoint: IdentityDeletionProcessEndpoint

public constructor(
protected connectorClient: ConnectorClient,
protected connectorAddress: string
) {}
protected connectorAddress: string,
protected support: ConnectorSupportInformation
) {
this.identityDeletionProcessEndpoint = new IdentityDeletionProcessEndpoint(this.connectorClient.account["httpClient"])
}

protected async selectRelationship(prompt: string, ...status: ConnectorRelationshipStatus[]): Promise<ConnectorRelationship | undefined> {
if (status.length === 0) status.push(ConnectorRelationshipStatus.Active)
Expand Down Expand Up @@ -112,4 +119,8 @@ export class ConnectorTUIBase {
private renderFile(file: ConnectorFile): prompts.Choice {
return { title: file.title, value: file }
}

protected isDebugMode() {
return this.support.configuration.debug as boolean | undefined
}
}
37 changes: 37 additions & 0 deletions src/IdentityDeletionProcessEndpoint.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import { ConnectorHttpResponse } from "@nmshd/connector-sdk"
import { Endpoint } from "@nmshd/connector-sdk/dist/endpoints/Endpoint"

export enum IdentityDeletionProcessStatus {
WaitingForApproval = "WaitingForApproval",
Rejected = "Rejected",
Approved = "Approved",
Cancelled = "Cancelled",
}
export interface IdentityDeletionProcess {
id: string
status: IdentityDeletionProcessStatus
createdAt?: string
createdByDevice?: string
approvalPeriodEndsAt?: string
rejectedAt?: string
rejectedByDevice?: string
approvedAt?: string
approvedByDevice?: string
gracePeriodEndsAt?: string
cancelledAt?: string
cancelledByDevice?: string
}

export class IdentityDeletionProcessEndpoint extends Endpoint {
public async initiateIdentityDeletionProcess(lengthOfGracePeriodInDays?: number): Promise<ConnectorHttpResponse<IdentityDeletionProcess>> {
return await this.post("/api/v2/IdentityDeletionProcess", undefined, 200, { lengthOfGracePeriodInDays })
}

public async getActiveIdentityDeletionProcess(): Promise<ConnectorHttpResponse<IdentityDeletionProcess>> {
return await this.get("/api/v2/IdentityDeletionProcess")
}

public async cancelIdentityDeletionProcess(): Promise<ConnectorHttpResponse<IdentityDeletionProcess>> {
return await this.delete("/api/v2/IdentityDeletionProcess", undefined, 200)
}
}
85 changes: 85 additions & 0 deletions src/mixins/AddIdentityDeletionProcess.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
import chalk from "chalk"
import { DateTime } from "luxon"
import prompts from "prompts"
import { ConnectorTUIBaseConstructor } from "../ConnectorTUIBase.js"
import { IdentityDeletionProcess } from "../IdentityDeletionProcessEndpoint.js"

export function AddIdentityDeletionProcess<TBase extends ConnectorTUIBaseConstructor>(Base: TBase) {
return class IdentityDeletionProcessHandler extends Base {
public constructor(...args: any[]) {
super(...args)
if (!this.isDebugMode()) return

const identityDeletionProcessChoices = { title: "IdentityDeletionProcess", value: this.identityDeletionProcess }

this.choices.push(identityDeletionProcessChoices)
this.choicesInDeletion.push(identityDeletionProcessChoices)
}

protected async identityDeletionProcess() {
const choices = []

const activeIdentityDeletionProcess = await this.identityDeletionProcessEndpoint.getActiveIdentityDeletionProcess()

if (activeIdentityDeletionProcess.isSuccess) {
choices.push({ title: "Show IdentityDeletionProcess", value: "Show" })

if (activeIdentityDeletionProcess.result.status === "Approved") {
choices.push({ title: "Cancel IdentityDeletionProcess", value: "Cancel" })
}
} else {
choices.push({ title: "Init IdentityDeletionProcess", value: "Init" })
}

const result = await prompts({
message: "Identity Deletion Process",
type: "select",
name: "Identity Deletion Process",
choices,
})

switch (result["Identity Deletion Process"]) {
case "Show":
this.showIdentityDeletionProcesses(activeIdentityDeletionProcess.result)
break
case "Init":
await this.initIdentityDeletionProcess()
break
case "Cancel":
await this.cancelIdentityDeletionProcess()
break
}
}

protected async initIdentityDeletionProcess() {
const confirmation = await prompts({
message: "Do you want to delete the identity immediately (Grace period will be one second)?",
type: "confirm",
name: "IdentityDeletionProcess grace period",
})

const oneSecondInDays = 1 / (24 * 60 * 60)
const lengthOfGracePeriodInDays = confirmation["IdentityDeletionProcess grace period"] ? oneSecondInDays : undefined
const identityDeletionProcess = (await this.identityDeletionProcessEndpoint.initiateIdentityDeletionProcess(lengthOfGracePeriodInDays)).result

console.log("Identity Deletion Process initiated.")

this.showIdentityDeletionProcesses(identityDeletionProcess)
}

protected async cancelIdentityDeletionProcess() {
const identityDeletionProcess = (await this.identityDeletionProcessEndpoint.cancelIdentityDeletionProcess()).result
console.log("Identity Deletion Process canceled.")

this.showIdentityDeletionProcesses(identityDeletionProcess)
}

protected showIdentityDeletionProcesses(identityDeletionProcess: IdentityDeletionProcess) {
console.log(`Identity deletion status: ${chalk.yellow(identityDeletionProcess.status)}`)

if (identityDeletionProcess.status === "Approved") {
console.log(`End of grace period: ${chalk.yellow(DateTime.fromISO(identityDeletionProcess.gracePeriodEndsAt!).toLocaleString())}`)
}
}
}
}
7 changes: 5 additions & 2 deletions src/mixins/ConnectorTUIBaseWithMixins.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {
AddDecomposeRelationship,
AddExit,
AddGetAttributesOfRelationship,
AddIdentityDeletionProcess,
AddSendMail,
AddSendRequestByMessage,
AddShareRequestByTemplate,
Expand All @@ -30,8 +31,10 @@ export class ConnectorTUIBaseWithMixins
AddShareRequestByTemplate(
AddSync(
AddUploadFile(
//
ConnectorTUIBase
AddIdentityDeletionProcess(
//
ConnectorTUIBase
)
)
)
)
Expand Down
1 change: 1 addition & 0 deletions src/mixins/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export * from "./AddCreateAndShowTemplate.js"
export * from "./AddDecomposeRelationship.js"
export * from "./AddExit.js"
export * from "./AddGetAttributesOfRelationship.js"
export * from "./AddIdentityDeletionProcess.js"
export * from "./AddSendMail.js"
export * from "./AddSendRequestByMessage.js"
export * from "./AddShareRequestByTemplate.js"
Expand Down