@twin.org/identity-connector-entity-storage 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/entities/identityDocument.js

@@ -0,0 +1,45 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { entity, property } from "@twin.org/entity";
+/**
+ * Class describing the identity document.
+ */
+let IdentityDocument = class IdentityDocument {
+    /**
+     * The identity of the document.
+     */
+    id;
+    /**
+     * The DID document.
+     */
+    document;
+    /**
+     * The signature of the document.
+     */
+    signature;
+    /**
+     * The controller of the document.
+     */
+    controller;
+};
+__decorate([
+    property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], IdentityDocument.prototype, "id", void 0);
+__decorate([
+    property({ type: "object" }),
+    __metadata("design:type", Object)
+], IdentityDocument.prototype, "document", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], IdentityDocument.prototype, "signature", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], IdentityDocument.prototype, "controller", void 0);
+IdentityDocument = __decorate([
+    entity()
+], IdentityDocument);
+export { IdentityDocument };
+//# sourceMappingURL=identityDocument.js.map

package/dist/es/entities/identityDocument.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityDocument.js","sourceRoot":"","sources":["../../../src/entities/identityDocument.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAGpD;;GAEG;AAEI,IAAM,gBAAgB,GAAtB,MAAM,gBAAgB;IAC5B;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,QAAQ,CAAgB;IAE/B;;OAEG;IAEI,SAAS,CAAU;IAE1B;;OAEG;IAEI,UAAU,CAAU;CAC3B,CAAA;AAnBO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;4CAC3B;AAMZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;kDACE;AAMxB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;mDACH;AAMnB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;oDACF;AAvBf,gBAAgB;IAD5B,MAAM,EAAE;GACI,gBAAgB,CAwB5B","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property } from \"@twin.org/entity\";\nimport type { IDidDocument } from \"@twin.org/standards-w3c-did\";\n\n/**\n * Class describing the identity document.\n */\n@entity()\nexport class IdentityDocument {\n\t/**\n\t * The identity of the document.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic id!: string;\n\n\t/**\n\t * The DID document.\n\t */\n\t@property({ type: \"object\" })\n\tpublic document!: IDidDocument;\n\n\t/**\n\t * The signature of the document.\n\t */\n\t@property({ type: \"string\" })\n\tpublic signature!: string;\n\n\t/**\n\t * The controller of the document.\n\t */\n\t@property({ type: \"string\" })\n\tpublic controller!: string;\n}\n"]}

package/dist/es/entities/identityProfile.js

@@ -0,0 +1,37 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { entity, property } from "@twin.org/entity";
+/**
+ * Class representing profile details for the identity.
+ */
+let IdentityProfile = class IdentityProfile {
+    /**
+     * The id for the identity.
+     */
+    identity;
+    /**
+     * The public profile data.
+     */
+    publicProfile;
+    /**
+     * The private profile data.
+     */
+    privateProfile;
+};
+__decorate([
+    property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], IdentityProfile.prototype, "identity", void 0);
+__decorate([
+    property({ type: "object", optional: true }),
+    __metadata("design:type", Object)
+], IdentityProfile.prototype, "publicProfile", void 0);
+__decorate([
+    property({ type: "object", optional: true }),
+    __metadata("design:type", Object)
+], IdentityProfile.prototype, "privateProfile", void 0);
+IdentityProfile = __decorate([
+    entity()
+], IdentityProfile);
+export { IdentityProfile };
+//# sourceMappingURL=identityProfile.js.map

package/dist/es/entities/identityProfile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityProfile.js","sourceRoot":"","sources":["../../../src/entities/identityProfile.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAEpD;;GAEG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAC3B;;OAEG;IAEI,QAAQ,CAAU;IAEzB;;OAEG;IAEI,aAAa,CAAW;IAE/B;;OAEG;IAEI,cAAc,CAAW;CAChC,CAAA;AAbO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;iDACrB;AAMlB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACd;AAMxB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;uDACb;AAjBpB,eAAe;IAD3B,MAAM,EAAE;GACI,eAAe,CAkB3B","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property } from \"@twin.org/entity\";\n\n/**\n * Class representing profile details for the identity.\n */\n@entity()\nexport class IdentityProfile {\n\t/**\n\t * The id for the identity.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic identity!: string;\n\n\t/**\n\t * The public profile data.\n\t */\n\t@property({ type: \"object\", optional: true })\n\tpublic publicProfile?: unknown;\n\n\t/**\n\t * The private profile data.\n\t */\n\t@property({ type: \"object\", optional: true })\n\tpublic privateProfile?: unknown;\n}\n"]}

package/dist/{esm/index.mjs → es/entityStorageIdentityConnector.js}

@@ -1,96 +1,16 @@
-import { property, entity, ComparisonOperator, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { JsonHelper, Converter, GeneralError, Guards, RandomHelper, BitString, Compression, CompressionType, Is, NotFoundError, ObjectHelper, BaseError, Coerce, AlreadyExistsError } from '@twin.org/core';
-import { JsonLdProcessor } from '@twin.org/data-json-ld';
-import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
-import { DocumentHelper } from '@twin.org/identity-models';
-import { DidContexts, DidVerificationMethodType, DidTypes, ProofTypes, ProofHelper } from '@twin.org/standards-w3c-did';
-import { VaultConnectorFactory, VaultKeyType, VaultConnectorHelper } from '@twin.org/vault-models';
-import { Jwk, Jwt } from '@twin.org/web';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class describing the identity document.
- */
-let IdentityDocument = class IdentityDocument {
-    /**
-     * The identity of the document.
-     */
-    id;
-    /**
-     * The DID document.
-     */
-    document;
-    /**
-     * The signature of the document.
-     */
-    signature;
-    /**
-     * The controller of the document.
-     */
-    controller;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], IdentityDocument.prototype, "id", void 0);
-__decorate([
-    property({ type: "object" }),
-    __metadata("design:type", Object)
-], IdentityDocument.prototype, "document", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], IdentityDocument.prototype, "signature", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], IdentityDocument.prototype, "controller", void 0);
-IdentityDocument = __decorate([
-    entity()
-], IdentityDocument);
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class representing profile details for the identity.
- */
-let IdentityProfile = class IdentityProfile {
-    /**
-     * The id for the identity.
-     */
-    identity;
-    /**
-     * The public profile data.
-     */
-    publicProfile;
-    /**
-     * The private profile data.
-     */
-    privateProfile;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], IdentityProfile.prototype, "identity", void 0);
-__decorate([
-    property({ type: "object", optional: true }),
-    __metadata("design:type", Object)
-], IdentityProfile.prototype, "publicProfile", void 0);
-__decorate([
-    property({ type: "object", optional: true }),
-    __metadata("design:type", Object)
-], IdentityProfile.prototype, "privateProfile", void 0);
-IdentityProfile = __decorate([
-    entity()
-], IdentityProfile);
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseError, BitString, Coerce, Compression, CompressionType, Converter, GeneralError, Guards, Is, JsonHelper, NotFoundError, ObjectHelper, RandomHelper } from "@twin.org/core";
+import { JsonLdProcessor } from "@twin.org/data-json-ld";
+import { EntityStorageConnectorFactory } from "@twin.org/entity-storage-models";
+import { DocumentHelper } from "@twin.org/identity-models";
+import { DidContexts, DidTypes, DidVerificationMethodType, ProofHelper, ProofTypes } from "@twin.org/standards-w3c-did";
+import { VaultConnectorFactory, VaultConnectorHelper, VaultKeyType } from "@twin.org/vault-models";
+import { Jwk, Jwt } from "@twin.org/web";
 /**
  * Class for performing identity operations using entity storage.
  */
-class EntityStorageIdentityConnector {
+export class EntityStorageIdentityConnector {
     /**
      * Runtime name for the class.
      */
@@ -144,6 +64,13 @@ class EntityStorageIdentityConnector {
             throw new GeneralError(EntityStorageIdentityConnector.CLASS_NAME, "signatureVerificationFailed");
         }
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return EntityStorageIdentityConnector.CLASS_NAME;
+    }
     /**
      * Create a new document.
      * @param controller The controller of the identity who can make changes.
@@ -982,7 +909,8 @@ class EntityStorageIdentityConnector {
                     method: proof.verificationMethod
                 });
             }
-            return ProofHelper.verifyProof(document, proof, didMethod.publicKeyJwk);
+            const result = await ProofHelper.verifyProof(document, proof, didMethod.publicKeyJwk);
+            return result;
         }
         catch (error) {
             throw new GeneralError(EntityStorageIdentityConnector.CLASS_NAME, "verifyProofFailed", undefined, error);
@@ -1053,269 +981,4 @@ class EntityStorageIdentityConnector {
         });
     }
 }
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class which implements the identity profile connector contract.
- */
-class EntityStorageIdentityProfileConnector {
-    /**
-     * The namespace supported by the identity profile connector.
-     */
-    static NAMESPACE = "entity-storage";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EntityStorageIdentityProfileConnector";
-    /**
-     * The storage connector for the profiles.
-     * @internal
-     */
-    _profileEntityStorage;
-    /**
-     * Create a new instance of EntityStorageIdentityProfileConnector.
-     * @param options The options for the identity service.
-     */
-    constructor(options) {
-        this._profileEntityStorage = EntityStorageConnectorFactory.get(options?.profileEntityStorageType ?? "identity-profile");
-    }
-    /**
-     * Create the profile properties for an identity.
-     * @param identity The identity of the profile to create.
-     * @param publicProfile The public profile data.
-     * @param privateProfile The private profile data.
-     * @returns Nothing.
-     */
-    async create(identity, publicProfile, privateProfile) {
-        Guards.stringValue(EntityStorageIdentityProfileConnector.CLASS_NAME, "identity", identity);
-        try {
-            const profile = await this._profileEntityStorage.get(identity);
-            if (!Is.empty(profile)) {
-                throw new AlreadyExistsError(EntityStorageIdentityProfileConnector.CLASS_NAME, "alreadyExists", identity);
-            }
-            await this._profileEntityStorage.set({
-                identity,
-                publicProfile,
-                privateProfile
-            });
-        }
-        catch (error) {
-            if (BaseError.someErrorClass(error, EntityStorageIdentityProfileConnector.CLASS_NAME)) {
-                throw error;
-            }
-            throw new GeneralError(EntityStorageIdentityProfileConnector.CLASS_NAME, "createFailed", { identity }, error);
-        }
-    }
-    /**
-     * Get the profile properties for an identity.
-     * @param identity The identity of the item to get.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
-     * @returns The items properties.
-     */
-    async get(identity, publicPropertyNames, privatePropertyNames) {
-        try {
-            const profile = await this._profileEntityStorage.get(identity);
-            if (!profile) {
-                throw new NotFoundError(EntityStorageIdentityProfileConnector.CLASS_NAME, "identityNotFound", identity);
-            }
-            return this.pickProperties(profile, publicPropertyNames, privatePropertyNames);
-        }
-        catch (error) {
-            if (BaseError.someErrorClass(error, EntityStorageIdentityProfileConnector.CLASS_NAME)) {
-                throw error;
-            }
-            throw new GeneralError(EntityStorageIdentityProfileConnector.CLASS_NAME, "getFailed", { identity }, error);
-        }
-    }
-    /**
-     * Update the profile properties of an identity.
-     * @param identity The identity to update.
-     * @param publicProfile The public profile data.
-     * @param privateProfile The private profile data.
-     * @returns Nothing.
-     */
-    async update(identity, publicProfile, privateProfile) {
-        Guards.stringValue(EntityStorageIdentityProfileConnector.CLASS_NAME, "identity", identity);
-        try {
-            const profile = await this._profileEntityStorage.get(identity);
-            if (Is.empty(profile)) {
-                throw new NotFoundError(EntityStorageIdentityProfileConnector.CLASS_NAME, "notFound", identity);
-            }
-            profile.publicProfile = publicProfile ?? profile.publicProfile;
-            profile.privateProfile = privateProfile ?? profile.privateProfile;
-            await this._profileEntityStorage.set(profile);
-        }
-        catch (error) {
-            if (BaseError.someErrorClass(error, EntityStorageIdentityProfileConnector.CLASS_NAME)) {
-                throw error;
-            }
-            throw new GeneralError(EntityStorageIdentityProfileConnector.CLASS_NAME, "updateFailed", { identity }, error);
-        }
-    }
-    /**
-     * Delete the profile for an identity.
-     * @param identity The identity to delete.
-     * @returns Nothing.
-     */
-    async remove(identity) {
-        Guards.stringValue(EntityStorageIdentityProfileConnector.CLASS_NAME, "identity", identity);
-        try {
-            const profile = await this._profileEntityStorage.get(identity);
-            if (Is.empty(profile)) {
-                throw new NotFoundError(EntityStorageIdentityProfileConnector.CLASS_NAME, "notFound", identity);
-            }
-            await this._profileEntityStorage.remove(identity);
-        }
-        catch (error) {
-            if (BaseError.someErrorClass(error, EntityStorageIdentityProfileConnector.CLASS_NAME)) {
-                throw error;
-            }
-            throw new GeneralError(EntityStorageIdentityProfileConnector.CLASS_NAME, "removeFailed", { identity }, error);
-        }
-    }
-    /**
-     * Get a list of the requested types.
-     * @param publicFilters The filters to apply to the identities public profiles.
-     * @param privateFilters The filters to apply to the identities private profiles.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
-     * @param cursor The cursor for paged requests.
-     * @param limit The maximum number of items in a page.
-     * @returns The list of items and cursor for paging.
-     */
-    async list(publicFilters, privateFilters, publicPropertyNames, privatePropertyNames, cursor, limit) {
-        try {
-            const conditions = [];
-            if (Is.arrayValue(publicFilters)) {
-                for (const filter of publicFilters) {
-                    conditions.push({
-                        property: `publicProfile.${filter.propertyName}`,
-                        value: filter.propertyValue,
-                        comparison: ComparisonOperator.Equals
-                    });
-                }
-            }
-            if (Is.arrayValue(privateFilters)) {
-                for (const filter of privateFilters) {
-                    conditions.push({
-                        property: `privateProfile.${filter.propertyName}`,
-                        value: filter.propertyValue,
-                        comparison: ComparisonOperator.Equals
-                    });
-                }
-            }
-            const result = await this._profileEntityStorage.query(Is.arrayValue(conditions)
-                ? {
-                    conditions
-                }
-                : undefined, undefined, undefined, cursor, limit);
-            const items = [];
-            for (const resultEntity of result.entities) {
-                items.push({
-                    identity: resultEntity.identity ?? "",
-                    ...this.pickProperties(resultEntity, publicPropertyNames, privatePropertyNames)
-                });
-            }
-            return {
-                items,
-                cursor: result.cursor
-            };
-        }
-        catch (error) {
-            throw new GeneralError(EntityStorageIdentityProfileConnector.CLASS_NAME, "listFailed", undefined, error);
-        }
-    }
-    /**
-     * Get the profile properties for an identity.
-     * @param profile The profile to pick the properties from.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
-     * @returns The identity profile, will only return private data if you have correct permissions.
-     * @internal
-     */
-    pickProperties(profile, publicPropertyNames, privatePropertyNames) {
-        return {
-            publicProfile: Is.array(publicPropertyNames)
-                ? ObjectHelper.pick(profile.publicProfile, publicPropertyNames)
-                : profile.publicProfile,
-            privateProfile: Is.array(privatePropertyNames)
-                ? ObjectHelper.pick(profile.privateProfile, privatePropertyNames)
-                : profile.privateProfile
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for performing identity operations using entity storage.
- */
-class EntityStorageIdentityResolverConnector {
-    /**
-     * The namespace supported by the identity connector.
-     */
-    static NAMESPACE = "entity-storage";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EntityStorageIdentityResolverConnector";
-    /**
-     * The entity storage for identities.
-     * @internal
-     */
-    _didDocumentEntityStorage;
-    /**
-     * The vault for the keys.
-     * @internal
-     */
-    _vaultConnector;
-    /**
-     * Create a new instance of EntityStorageIdentityResolverConnector.
-     * @param options The options for the identity connector.
-     */
-    constructor(options) {
-        this._didDocumentEntityStorage = EntityStorageConnectorFactory.get(options?.didDocumentEntityStorageType ?? "identity-document");
-        this._vaultConnector = VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
-    }
-    /**
-     * Resolve a document from its id.
-     * @param documentId The id of the document to resolve.
-     * @returns The resolved document.
-     * @throws NotFoundError if the id can not be resolved.
-     */
-    async resolveDocument(documentId) {
-        Guards.stringValue(EntityStorageIdentityResolverConnector.CLASS_NAME, "documentId", documentId);
-        try {
-            const didIdentityDocument = await this._didDocumentEntityStorage.get(documentId);
-            if (Is.undefined(didIdentityDocument)) {
-                throw new NotFoundError(EntityStorageIdentityResolverConnector.CLASS_NAME, "documentNotFound", documentId);
-            }
-            await EntityStorageIdentityConnector.verifyDocument(didIdentityDocument, this._vaultConnector);
-            return didIdentityDocument.document;
-        }
-        catch (error) {
-            throw new GeneralError(EntityStorageIdentityResolverConnector.CLASS_NAME, "resolveDocumentFailed", undefined, error);
-        }
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialize the schema for the identity entity storage connector.
- * @param options Options for which entities to register.
- * @param options.includeDocument Whether to include the document entity, defaults to true.
- * @param options.includeProfile Whether to include the profile entity, defaults to true.
- */
-function initSchema(options) {
-    if (options?.includeDocument ?? true) {
-        EntitySchemaFactory.register("IdentityDocument", () => EntitySchemaHelper.getSchema(IdentityDocument));
-    }
-    if (options?.includeProfile ?? true) {
-        EntitySchemaFactory.register("IdentityProfile", () => EntitySchemaHelper.getSchema(IdentityProfile));
-    }
-}
-
-export { EntityStorageIdentityConnector, EntityStorageIdentityProfileConnector, EntityStorageIdentityResolverConnector, IdentityDocument, IdentityProfile, initSchema };
+//# sourceMappingURL=entityStorageIdentityConnector.js.map