@twin.org/identity-connector-entity-storage 0.0.1-next.55 → 0.0.1-next.57

package/dist/cjs/index.cjs

@@ -176,6 +176,26 @@ class EntityStorageIdentityConnector {
             throw new core.GeneralError(this.CLASS_NAME, "createDocumentFailed", undefined, error);
         }
     }
+    /**
+     * Remove a document.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to remove.
+     * @returns Nothing.
+     */
+    async removeDocument(controller, documentId) {
+        core.Guards.stringValue(this.CLASS_NAME, "controller", controller);
+        core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
+        try {
+            const didDocument = await this._didDocumentEntityStorage.get(documentId);
+            if (core.Is.empty(didDocument)) {
+                throw new core.NotFoundError(this.CLASS_NAME, "documentNotFound", documentId);
+            }
+            await this._didDocumentEntityStorage.remove(documentId);
+        }
+        catch (error) {
+            throw new core.GeneralError(this.CLASS_NAME, "removeDocumentFailed", undefined, error);
+        }
+    }
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.
@@ -190,6 +210,7 @@ class EntityStorageIdentityConnector {
         core.Guards.stringValue(this.CLASS_NAME, "controller", controller);
         core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         core.Guards.arrayOneOf(this.CLASS_NAME, "verificationMethodType", verificationMethodType, Object.values(standardsW3cDid.DidVerificationMethodType));
+        let tempKeyId;
         try {
             const didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);
             if (core.Is.undefined(didIdentityDocument)) {
@@ -197,17 +218,35 @@ class EntityStorageIdentityConnector {
             }
             await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
-            const tempKeyId = `temp-vm-${core.Converter.bytesToBase64Url(core.RandomHelper.generate(16))}`;
-            const verificationPublicKey = await this._vaultConnector.createKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), vaultModels.VaultKeyType.Ed25519);
+            let methodKeyPublic;
+            if (core.Is.stringValue(verificationMethodId)) {
+                // If there is a verification method id, we will try to get the key from the vault.
+                try {
+                    const defaultMethodId = `${controller}/${verificationMethodId}`;
+                    // If there is an existing key, we will use it.
+                    const existingKey = await this._vaultConnector.getKey(defaultMethodId);
+                    methodKeyPublic = existingKey.publicKey;
+                }
+                catch { }
+            }
+            if (core.Is.empty(methodKeyPublic)) {
+                // If there is no existing key, we will create a new one with a temporary name.
+                tempKeyId = `temp-vm-${core.Converter.bytesToBase64Url(core.RandomHelper.generate(16))}`;
+                methodKeyPublic = await this._vaultConnector.createKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), vaultModels.VaultKeyType.Ed25519);
+            }
             const jwkParams = {
                 alg: "EdDSA",
                 kty: "OKP",
                 crv: "Ed25519",
-                x: core.Converter.bytesToBase64Url(verificationPublicKey)
+                x: core.Converter.bytesToBase64Url(methodKeyPublic)
             };
             const kid = await web.Jwk.generateKid(jwkParams);
             const methodId = `${documentId}#${verificationMethodId ?? kid}`;
-            await this._vaultConnector.renameKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), EntityStorageIdentityConnector.buildVaultKey(didDocument.id, verificationMethodId ?? kid));
+            if (core.Is.stringValue(tempKeyId)) {
+                // If we created a temporary key, we will rename it to the final method id.
+                await this._vaultConnector.renameKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), EntityStorageIdentityConnector.buildVaultKey(didDocument.id, verificationMethodId ?? kid));
+                tempKeyId = undefined;
+            }
             const methods = this.getAllMethods(didDocument);
             const existingMethodIndex = methods.findIndex(m => {
                 if (core.Is.string(m.method)) {
@@ -238,6 +277,15 @@ class EntityStorageIdentityConnector {
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "addVerificationMethodFailed", undefined, error);
         }
+        finally {
+            if (core.Is.stringValue(tempKeyId)) {
+                // If we created a temporary key and it is still in use, we will remove it from the vault.
+                try {
+                    await this._vaultConnector.removeKey(tempKeyId);
+                }
+                catch { }
+            }
+        }
     }
     /**
      * Remove a verification method from the document.

package/dist/esm/index.mjs

@@ -174,6 +174,26 @@ class EntityStorageIdentityConnector {
             throw new GeneralError(this.CLASS_NAME, "createDocumentFailed", undefined, error);
         }
     }
+    /**
+     * Remove a document.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to remove.
+     * @returns Nothing.
+     */
+    async removeDocument(controller, documentId) {
+        Guards.stringValue(this.CLASS_NAME, "controller", controller);
+        Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
+        try {
+            const didDocument = await this._didDocumentEntityStorage.get(documentId);
+            if (Is.empty(didDocument)) {
+                throw new NotFoundError(this.CLASS_NAME, "documentNotFound", documentId);
+            }
+            await this._didDocumentEntityStorage.remove(documentId);
+        }
+        catch (error) {
+            throw new GeneralError(this.CLASS_NAME, "removeDocumentFailed", undefined, error);
+        }
+    }
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.
@@ -188,6 +208,7 @@ class EntityStorageIdentityConnector {
         Guards.stringValue(this.CLASS_NAME, "controller", controller);
         Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         Guards.arrayOneOf(this.CLASS_NAME, "verificationMethodType", verificationMethodType, Object.values(DidVerificationMethodType));
+        let tempKeyId;
         try {
             const didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);
             if (Is.undefined(didIdentityDocument)) {
@@ -195,17 +216,35 @@ class EntityStorageIdentityConnector {
             }
             await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
             const didDocument = didIdentityDocument.document;
-            const tempKeyId = `temp-vm-${Converter.bytesToBase64Url(RandomHelper.generate(16))}`;
-            const verificationPublicKey = await this._vaultConnector.createKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), VaultKeyType.Ed25519);
+            let methodKeyPublic;
+            if (Is.stringValue(verificationMethodId)) {
+                // If there is a verification method id, we will try to get the key from the vault.
+                try {
+                    const defaultMethodId = `${controller}/${verificationMethodId}`;
+                    // If there is an existing key, we will use it.
+                    const existingKey = await this._vaultConnector.getKey(defaultMethodId);
+                    methodKeyPublic = existingKey.publicKey;
+                }
+                catch { }
+            }
+            if (Is.empty(methodKeyPublic)) {
+                // If there is no existing key, we will create a new one with a temporary name.
+                tempKeyId = `temp-vm-${Converter.bytesToBase64Url(RandomHelper.generate(16))}`;
+                methodKeyPublic = await this._vaultConnector.createKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), VaultKeyType.Ed25519);
+            }
             const jwkParams = {
                 alg: "EdDSA",
                 kty: "OKP",
                 crv: "Ed25519",
-                x: Converter.bytesToBase64Url(verificationPublicKey)
+                x: Converter.bytesToBase64Url(methodKeyPublic)
             };
             const kid = await Jwk.generateKid(jwkParams);
             const methodId = `${documentId}#${verificationMethodId ?? kid}`;
-            await this._vaultConnector.renameKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), EntityStorageIdentityConnector.buildVaultKey(didDocument.id, verificationMethodId ?? kid));
+            if (Is.stringValue(tempKeyId)) {
+                // If we created a temporary key, we will rename it to the final method id.
+                await this._vaultConnector.renameKey(EntityStorageIdentityConnector.buildVaultKey(didDocument.id, tempKeyId), EntityStorageIdentityConnector.buildVaultKey(didDocument.id, verificationMethodId ?? kid));
+                tempKeyId = undefined;
+            }
             const methods = this.getAllMethods(didDocument);
             const existingMethodIndex = methods.findIndex(m => {
                 if (Is.string(m.method)) {
@@ -236,6 +275,15 @@ class EntityStorageIdentityConnector {
         catch (error) {
             throw new GeneralError(this.CLASS_NAME, "addVerificationMethodFailed", undefined, error);
         }
+        finally {
+            if (Is.stringValue(tempKeyId)) {
+                // If we created a temporary key and it is still in use, we will remove it from the vault.
+                try {
+                    await this._vaultConnector.removeKey(tempKeyId);
+                }
+                catch { }
+            }
+        }
     }
     /**
      * Remove a verification method from the document.

package/dist/types/entityStorageIdentityConnector.d.ts

@@ -25,6 +25,13 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @returns The created document.
      */
     createDocument(controller: string): Promise<IDidDocument>;
+    /**
+     * Remove a document.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to remove.
+     * @returns Nothing.
+     */
+    removeDocument(controller: string, documentId: string): Promise<void>;
     /**
      * Add a verification method to the document in JSON Web key Format.
      * @param controller The controller of the identity who can make changes.

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/identity-connector-entity-storage- Changelog
 
+## [0.0.1-next.57](https://github.com/twinfoundation/identity/compare/identity-connector-entity-storage-v0.0.1-next.56...identity-connector-entity-storage-v0.0.1-next.57) (2025-07-08)
+
+
+### Features
+
+* add identity remove ([eebc13f](https://github.com/twinfoundation/identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.1-next.56 to 0.0.1-next.57
+
+## [0.0.1-next.56](https://github.com/twinfoundation/identity/compare/identity-connector-entity-storage-v0.0.1-next.55...identity-connector-entity-storage-v0.0.1-next.56) (2025-06-30)
+
+
+### Features
+
+* re-use vault keys if available ([5a848d7](https://github.com/twinfoundation/identity/commit/5a848d7520829d9c891ec889fd773fbc0ee77ba5))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.1-next.55 to 0.0.1-next.56
+
 ## [0.0.1-next.55](https://github.com/twinfoundation/identity/compare/identity-connector-entity-storage-v0.0.1-next.54...identity-connector-entity-storage-v0.0.1-next.55) (2025-06-26)
 
 

package/docs/reference/classes/EntityStorageIdentityConnector.md

@@ -74,6 +74,38 @@ The created document.
 
 ***
 
+### removeDocument()
+
+> **removeDocument**(`controller`, `documentId`): `Promise`\<`void`\>
+
+Remove a document.
+
+#### Parameters
+
+##### controller
+
+`string`
+
+The controller of the identity who can make changes.
+
+##### documentId
+
+`string`
+
+The id of the document to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityConnector.removeDocument`
+
+***
+
 ### addVerificationMethod()
 
 > **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId?`): `Promise`\<`IDidDocumentVerificationMethod`\>

package/locales/en.json

@@ -6,13 +6,14 @@
 		},
 		"entityStorageIdentityConnector": {
 			"createDocumentFailed": "Creating the document failed",
+			"removeDocumentFailed": "Removing the document failed",
 			"signatureVerificationFailed": "The document integrity check failed",
 			"missingDid": "The full id including DID is required",
 			"addVerificationMethodFailed": "Adding the verification method failed",
 			"removeVerificationMethodFailed": "Removing the verification method failed",
 			"addServiceFailed": "Adding the service failed",
 			"removeServiceFailed": "Removing the service failed",
-			"documentNotFound": "The document could not be found",
+			"documentNotFound": "The document could not be found \"{notFoundId}\"",
 			"documentPrivateKeyNotFound": "The private key for document could not be found in the vault",
 			"verificationMethodNotFound": "The verification method could not be found",
 			"verificationPrivateKeyNotFound": "The private key for the verification method could not be found in the vault",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-connector-entity-storage",
-	"version": "0.0.1-next.55",
+	"version": "0.0.1-next.57",
 	"description": "Identity connector implementation using entity storage",
 	"repository": {
 		"type": "git",
@@ -19,7 +19,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.0.1-next.55",
+		"@twin.org/identity-models": "0.0.1-next.57",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",