@twin.org/identity-connector-entity-storage 0.0.1-next.10

package/dist/types/entities/identityDocument.d.ts

@@ -0,0 +1,22 @@
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Class describing the identity document.
+ */
+export declare class IdentityDocument {
+    /**
+     * The identity of the document.
+     */
+    id: string;
+    /**
+     * The DID document.
+     */
+    document: IDidDocument;
+    /**
+     * The signature of the document.
+     */
+    signature: string;
+    /**
+     * The controller of the document.
+     */
+    controller: string;
+}

package/dist/types/entities/identityProfile.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Class representing profile details for the identity.
+ */
+export declare class IdentityProfile {
+    /**
+     * The id for the identity.
+     */
+    identity: string;
+    /**
+     * The public profile data.
+     */
+    publicProfile?: unknown;
+    /**
+     * The private profile data.
+     */
+    privateProfile?: unknown;
+}

package/dist/types/entityStorageIdentityConnector.d.ts

@@ -0,0 +1,163 @@
+import { type IJsonLdObject, type IJsonLdContextDefinitionRoot } from "@twin.org/data-json-ld";
+import { type IIdentityConnector } from "@twin.org/identity-models";
+import { DidVerificationMethodType, type IDidDocument, type IDidDocumentVerificationMethod, type IDidService, type IDidVerifiableCredential, type IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+/**
+ * Class for performing identity operations using entity storage.
+ */
+export declare class EntityStorageIdentityConnector implements IIdentityConnector {
+    /**
+     * The namespace supported by the identity connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageIdentityConnector.
+     * @param options The dependencies for the identity connector.
+     * @param options.didDocumentEntityStorageType The entity storage for the did documents, defaults to "identity-document".
+     * @param options.vaultConnectorType The vault for the private keys, defaults to "vault".
+     */
+    constructor(options?: {
+        didDocumentEntityStorageType?: string;
+        vaultConnectorType?: string;
+    });
+    /**
+     * Create a new document.
+     * @param controller The controller of the identity who can make changes.
+     * @returns The created document.
+     */
+    createDocument(controller: string): Promise<IDidDocument>;
+    /**
+     * 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.
+     */
+    resolveDocument(documentId: string): Promise<IDidDocument>;
+    /**
+     * Add a verification method to the document in JSON Web key Format.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to add the verification method to.
+     * @param verificationMethodType The type of the verification method to add.
+     * @param verificationMethodId The id of the verification method, if undefined uses the kid of the generated JWK.
+     * @returns The verification method.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple keys.
+     */
+    addVerificationMethod(controller: string, documentId: string, verificationMethodType: DidVerificationMethodType, verificationMethodId?: string): Promise<IDidDocumentVerificationMethod>;
+    /**
+     * Remove a verification method from the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The id of the verification method.
+     * @returns Nothing.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple revocable keys.
+     */
+    removeVerificationMethod(controller: string, verificationMethodId: string): Promise<void>;
+    /**
+     * Add a service to the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to add the service to.
+     * @param serviceId The id of the service.
+     * @param serviceType The type of the service.
+     * @param serviceEndpoint The endpoint for the service.
+     * @returns The service.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    addService(controller: string, documentId: string, serviceId: string, serviceType: string, serviceEndpoint: string): Promise<IDidService>;
+    /**
+     * Remove a service from the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param serviceId The id of the service.
+     * @returns Nothing.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    removeService(controller: string, serviceId: string): Promise<void>;
+    /**
+     * Create a verifiable credential for a verification method.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The verification method id to use.
+     * @param id The id of the credential.
+     * @param credential The credential to store in the verifiable credential.
+     * @param revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @returns The created verifiable credential and its token.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    createVerifiableCredential<T extends IJsonLdObject = IJsonLdObject>(controller: string, verificationMethodId: string, id: string | undefined, credential: T, revocationIndex?: number): Promise<{
+        verifiableCredential: IDidVerifiableCredential<T>;
+        jwt: string;
+    }>;
+    /**
+     * Check a verifiable credential is valid.
+     * @param credentialJwt The credential to verify.
+     * @returns The credential stored in the jwt and the revocation status.
+     */
+    checkVerifiableCredential<T extends IJsonLdObject = IJsonLdObject>(credentialJwt: string): Promise<{
+        revoked: boolean;
+        verifiableCredential?: IDidVerifiableCredential<T>;
+    }>;
+    /**
+     * Revoke verifiable credential(s).
+     * @param controller The controller of the identity who can make changes.
+     * @param issuerDocumentId The id of the document to update the revocation list for.
+     * @param credentialIndices The revocation bitmap index or indices to revoke.
+     * @returns Nothing.
+     */
+    revokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
+    /**
+     * Unrevoke verifiable credential(s).
+     * @param controller The controller of the identity who can make changes.
+     * @param issuerDocumentId The id of the document to update the revocation list for.
+     * @param credentialIndices The revocation bitmap index or indices to un revoke.
+     * @returns Nothing.
+     */
+    unrevokeVerifiableCredentials(controller: string, issuerDocumentId: string, credentialIndices: number[]): Promise<void>;
+    /**
+     * Create a verifiable presentation from the supplied verifiable credentials.
+     * @param controller The controller of the identity who can make changes.
+     * @param presentationMethodId The method to associate with the presentation.
+     * @param presentationId The id of the presentation.
+     * @param contexts The contexts for the data stored in the verifiable credential.
+     * @param types The types for the data stored in the verifiable credential.
+     * @param verifiableCredentials The credentials to use for creating the presentation in jwt format.
+     * @param expiresInMinutes The time in minutes for the presentation to expire.
+     * @returns The created verifiable presentation and its token.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    createVerifiablePresentation<T extends IJsonLdObject = IJsonLdObject>(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential<T>)[], expiresInMinutes?: number): Promise<{
+        verifiablePresentation: IDidVerifiablePresentation<T>;
+        jwt: string;
+    }>;
+    /**
+     * Check a verifiable presentation is valid.
+     * @param presentationJwt The presentation to verify.
+     * @returns The presentation stored in the jwt and the revocation status.
+     */
+    checkVerifiablePresentation<T extends IJsonLdObject = IJsonLdObject>(presentationJwt: string): Promise<{
+        revoked: boolean;
+        verifiablePresentation?: IDidVerifiablePresentation<T>;
+        issuers?: IDidDocument[];
+    }>;
+    /**
+     * Create a proof for arbitrary data with the specified verification method.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The verification method id to use.
+     * @param bytes The data bytes to sign.
+     * @returns The proof signature type and value.
+     */
+    createProof(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<{
+        type: string;
+        value: Uint8Array;
+    }>;
+    /**
+     * Verify proof for arbitrary data with the specified verification method.
+     * @param verificationMethodId The verification method id to use.
+     * @param bytes The data bytes to verify.
+     * @param signatureType The type of the signature for the proof.
+     * @param signatureValue The value of the signature for the proof.
+     * @returns True if the signature is valid.
+     */
+    verifyProof(verificationMethodId: string, bytes: Uint8Array, signatureType: string, signatureValue: Uint8Array): Promise<boolean>;
+}

package/dist/types/entityStorageIdentityProfileConnector.d.ts

@@ -0,0 +1,86 @@
+import type { IJsonLdDocument } from "@twin.org/data-json-ld";
+import type { IIdentityProfileConnector } from "@twin.org/identity-models";
+/**
+ * Class which implements the identity profile connector contract.
+ */
+export declare class EntityStorageIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> implements IIdentityProfileConnector<T, U> {
+    /**
+     * The namespace supported by the identity profile connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of Identity.
+     * @param options The dependencies for the identity service.
+     * @param options.profileEntityStorageType The storage connector for the profiles, default to "identity-profile".
+     */
+    constructor(options?: {
+        profileEntityStorageType?: string;
+    });
+    /**
+     * 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.
+     */
+    create(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
+    /**
+     * 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.
+     */
+    get(identity: string, publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[]): Promise<{
+        publicProfile: Partial<T>;
+        privateProfile: Partial<U>;
+    }>;
+    /**
+     * 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.
+     */
+    update(identity: string, publicProfile?: T, privateProfile?: U): Promise<void>;
+    /**
+     * Delete the profile for an identity.
+     * @param identity The identity to delete.
+     * @returns Nothing.
+     */
+    remove(identity: string): Promise<void>;
+    /**
+     * 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 pageSize The maximum number of items in a page.
+     * @returns The list of items and cursor for paging.
+     */
+    list(publicFilters?: {
+        propertyName: string;
+        propertyValue: unknown;
+    }[], privateFilters?: {
+        propertyName: string;
+        propertyValue: unknown;
+    }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, pageSize?: number): Promise<{
+        /**
+         * The identities.
+         */
+        items: {
+            identity: string;
+            publicProfile?: Partial<T>;
+            privateProfile?: Partial<U>;
+        }[];
+        /**
+         * An optional cursor, when defined can be used to call find to get more entities.
+         */
+        cursor?: string;
+    }>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./entities/identityDocument";
+export * from "./entities/identityProfile";
+export * from "./entityStorageIdentityConnector";
+export * from "./entityStorageIdentityProfileConnector";
+export * from "./schema";

package/dist/types/schema.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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.
+ */
+export declare function initSchema(options?: {
+    includeDocument?: boolean;
+    includeProfile?: boolean;
+}): void;

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/identity-connector-entity-storage- Changelog
+
+## v0.0.1-next.10
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/identity-connector-entity-storage - Examples