@twin.org/identity-models 0.0.1-next.23 → 0.0.1-next.24

package/dist/cjs/index.cjs

@@ -38,19 +38,43 @@ class DocumentHelper {
      * @param documentId The full document id.
      * @returns The parsed document id.
      */
-    static parse(documentId) {
+    static parseId(documentId) {
         if (!core.Is.stringValue(documentId)) {
             return {
                 id: "",
-                hash: ""
+                fragment: ""
             };
         }
-        const hashIndex = documentId.indexOf("#");
+        const fragmentIndex = documentId.indexOf("#");
         return {
-            id: hashIndex === -1 ? documentId : documentId.slice(0, hashIndex),
-            hash: hashIndex === -1 ? undefined : documentId.slice(hashIndex + 1)
+            id: fragmentIndex === -1 ? documentId : documentId.slice(0, fragmentIndex),
+            fragment: fragmentIndex === -1 ? undefined : documentId.slice(fragmentIndex + 1)
         };
     }
+    /**
+     * Join the document id parts.
+     * @param documentId The document id.
+     * @param fragment The fragment part for the identifier.
+     * @returns The full id.
+     */
+    static joinId(documentId, fragment) {
+        if (!core.Is.stringValue(documentId)) {
+            return "";
+        }
+        let fullId = documentId;
+        if (core.Is.stringValue(fragment)) {
+            if (fragment.startsWith(documentId)) {
+                fragment = fragment.slice(documentId.length);
+            }
+            if (fragment.startsWith("#")) {
+                fullId += fragment;
+            }
+            else {
+                fullId += `#${fragment}`;
+            }
+        }
+        return fullId;
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/esm/index.mjs

@@ -36,19 +36,43 @@ class DocumentHelper {
      * @param documentId The full document id.
      * @returns The parsed document id.
      */
-    static parse(documentId) {
+    static parseId(documentId) {
         if (!Is.stringValue(documentId)) {
             return {
                 id: "",
-                hash: ""
+                fragment: ""
             };
         }
-        const hashIndex = documentId.indexOf("#");
+        const fragmentIndex = documentId.indexOf("#");
         return {
-            id: hashIndex === -1 ? documentId : documentId.slice(0, hashIndex),
-            hash: hashIndex === -1 ? undefined : documentId.slice(hashIndex + 1)
+            id: fragmentIndex === -1 ? documentId : documentId.slice(0, fragmentIndex),
+            fragment: fragmentIndex === -1 ? undefined : documentId.slice(fragmentIndex + 1)
         };
     }
+    /**
+     * Join the document id parts.
+     * @param documentId The document id.
+     * @param fragment The fragment part for the identifier.
+     * @returns The full id.
+     */
+    static joinId(documentId, fragment) {
+        if (!Is.stringValue(documentId)) {
+            return "";
+        }
+        let fullId = documentId;
+        if (Is.stringValue(fragment)) {
+            if (fragment.startsWith(documentId)) {
+                fragment = fragment.slice(documentId.length);
+            }
+            if (fragment.startsWith("#")) {
+                fullId += fragment;
+            }
+            else {
+                fullId += `#${fragment}`;
+            }
+        }
+        return fullId;
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.

package/dist/types/index.d.ts

@@ -1,6 +1,28 @@
 export * from "./factories/identityConnectorFactory";
 export * from "./factories/identityProfileConnectorFactory";
 export * from "./factories/identityResolverConnectorFactory";
+export * from "./models/api/identity/IIdentityCreateRequest";
+export * from "./models/api/identity/IIdentityCreateResponse";
+export * from "./models/api/identity/IIdentityProofCreateRequest";
+export * from "./models/api/identity/IIdentityProofCreateResponse";
+export * from "./models/api/identity/IIdentityProofVerifyRequest";
+export * from "./models/api/identity/IIdentityProofVerifyResponse";
+export * from "./models/api/identity/IIdentityServiceCreateRequest";
+export * from "./models/api/identity/IIdentityServiceCreateResponse";
+export * from "./models/api/identity/IIdentityServiceRemoveRequest";
+export * from "./models/api/identity/IIdentityVerifiableCredentialCreateRequest";
+export * from "./models/api/identity/IIdentityVerifiableCredentialCreateResponse";
+export * from "./models/api/identity/IIdentityVerifiableCredentialRevokeRequest";
+export * from "./models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest";
+export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyRequest";
+export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyResponse";
+export * from "./models/api/identity/IIdentityVerifiablePresentationCreateRequest";
+export * from "./models/api/identity/IIdentityVerifiablePresentationCreateResponse";
+export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyRequest";
+export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyResponse";
+export * from "./models/api/identity/IIdentityVerificationMethodCreateRequest";
+export * from "./models/api/identity/IIdentityVerificationMethodCreateResponse";
+export * from "./models/api/identity/IIdentityVerificationMethodRemoveRequest";
 export * from "./models/api/profile/IIdentityProfileCreateRequest";
 export * from "./models/api/profile/IIdentityProfileGetPublicRequest";
 export * from "./models/api/profile/IIdentityProfileGetPublicResponse";

package/dist/types/models/IIdentityComponent.d.ts

@@ -7,61 +7,61 @@ import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationM
 export interface IIdentityComponent extends IComponent {
     /**
      * Create a new identity.
-     * @param controller The controller of the identity who can make changes.
      * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.
+     * @param controller The controller of the identity who can make changes.
      * @returns The created identity document.
      */
-    identityCreate(controller: string, namespace?: string): Promise<IDidDocument>;
+    identityCreate(namespace?: string, controller?: 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 identity 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.
+     * @param controller The controller of the identity who can make changes.
      * @returns The verification method.
      * @throws NotFoundError if the id can not be resolved.
      * @throws NotSupportedError if the platform does not support multiple keys.
      */
-    verificationMethodCreate(controller: string, identity: string, verificationMethodType: DidVerificationMethodType, verificationMethodId?: string): Promise<IDidDocumentVerificationMethod>;
+    verificationMethodCreate(identity: string, verificationMethodType: DidVerificationMethodType, verificationMethodId?: string, controller?: 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.
+     * @param controller The controller of the identity who can make changes.
      * @returns Nothing.
      * @throws NotFoundError if the id can not be resolved.
      * @throws NotSupportedError if the platform does not support multiple revocable keys.
      */
-    verificationMethodRemove(controller: string, verificationMethodId: string): Promise<void>;
+    verificationMethodRemove(verificationMethodId: string, controller?: string): Promise<void>;
     /**
      * Add a service to the document.
-     * @param controller The controller of the identity who can make changes.
      * @param identity 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.
+     * @param controller The controller of the identity who can make changes.
      * @returns The service.
      * @throws NotFoundError if the id can not be resolved.
      */
-    serviceCreate(controller: string, identity: string, serviceId: string, serviceType: string, serviceEndpoint: string): Promise<IDidService>;
+    serviceCreate(identity: string, serviceId: string, serviceType: string | string[], serviceEndpoint: string | string[], controller?: 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.
+     * @param controller The controller of the identity who can make changes.
      * @returns Nothing.
      * @throws NotFoundError if the id can not be resolved.
      */
-    serviceRemove(controller: string, serviceId: string): Promise<void>;
+    serviceRemove(serviceId: string, controller?: 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 subject The credential subject to store in the verifiable credential.
      * @param revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @param controller The controller of the identity who can make changes.
      * @returns The created verifiable credential and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    verifiableCredentialCreate(controller: string, verificationMethodId: string, id: string | undefined, credential: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+    verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, revocationIndex?: number, controller?: string): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
@@ -76,33 +76,33 @@ export interface IIdentityComponent extends IComponent {
     }>;
     /**
      * Revoke verifiable credential.
-     * @param controller The controller of the identity who can make changes.
      * @param issuerId The id of the document to update the revocation list for.
      * @param credentialIndex The revocation bitmap index revoke.
+     * @param controller The controller of the identity who can make changes.
      * @returns Nothing.
      */
-    verifiableCredentialRevoke(controller: string, issuerId: string, credentialIndex: number): Promise<void>;
+    verifiableCredentialRevoke(issuerId: string, credentialIndex: number, controller?: string): Promise<void>;
     /**
      * Unrevoke verifiable credential.
-     * @param controller The controller of the identity who can make changes.
      * @param issuerId The id of the document to update the revocation list for.
      * @param credentialIndex The revocation bitmap index to un revoke.
+     * @param controller The controller of the identity who can make changes.
      * @returns Nothing.
      */
-    verifiableCredentialUnrevoke(controller: string, issuerId: string, credentialIndex: number): Promise<void>;
+    verifiableCredentialUnrevoke(issuerId: string, credentialIndex: number, controller?: string): 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 verificationMethodId 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.
+     * @param controller The controller of the identity who can make changes.
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    verifiablePresentationCreate(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): Promise<{
+    verifiablePresentationCreate(verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number, controller?: string): Promise<{
         verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;
@@ -118,12 +118,12 @@ export interface IIdentityComponent extends IComponent {
     }>;
     /**
      * 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.
+     * @param controller The controller of the identity who can make changes.
      * @returns The proof.
      */
-    proofCreate(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<IDidProof>;
+    proofCreate(verificationMethodId: string, bytes: Uint8Array, controller?: string): Promise<IDidProof>;
     /**
      * Verify proof for arbitrary data with the specified verification method.
      * @param bytes The data bytes to verify.

package/dist/types/models/IIdentityConnector.d.ts

@@ -41,7 +41,7 @@ export interface IIdentityConnector extends IComponent {
      * @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>;
+    addService(controller: string, documentId: string, serviceId: string, serviceType: string | string[], serviceEndpoint: string | string[]): Promise<IDidService>;
     /**
      * Remove a service from the document.
      * @param controller The controller of the identity who can make changes.
@@ -55,12 +55,12 @@ export interface IIdentityConnector extends IComponent {
      * @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 subject The credential subject 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(controller: string, verificationMethodId: string, id: string | undefined, credential: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+    createVerifiableCredential(controller: string, verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, revocationIndex?: number): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
@@ -92,7 +92,7 @@ export interface IIdentityConnector extends IComponent {
     /**
      * 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 verificationMethodId 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.
@@ -101,7 +101,7 @@ export interface IIdentityConnector extends IComponent {
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiablePresentation(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): Promise<{
+    createVerifiablePresentation(controller: string, verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): Promise<{
         verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;

package/dist/types/models/api/identity/IIdentityCreateRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request to create an identity.
+ */
+export interface IIdentityCreateRequest {
+    /**
+     * The data for the request.
+     */
+    body?: {
+        /**
+         * The optional namespace to create the identity in.
+         */
+        namespace?: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityCreateResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Response to creating an identity.
+ */
+export interface IIdentityCreateResponse {
+    /**
+     * The response payload.
+     */
+    body: IDidDocument;
+}

package/dist/types/models/api/identity/IIdentityProofCreateRequest.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Request to create a proof.
+ */
+export interface IIdentityProofCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the proof for.
+         */
+        identity: string;
+        /**
+         * The verification method id to use.
+         */
+        verificationMethodId: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The data bytes base64 encoded.
+         */
+        bytes: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityProofCreateResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IDidProof } from "@twin.org/standards-w3c-did";
+/**
+ * Response to creating a proof.
+ */
+export interface IIdentityProofCreateResponse {
+    /**
+     * The response payload.
+     */
+    body: IDidProof;
+}

package/dist/types/models/api/identity/IIdentityProofVerifyRequest.d.ts

@@ -0,0 +1,19 @@
+import type { IDidProof } from "@twin.org/standards-w3c-did";
+/**
+ * Request to verify a proof.
+ */
+export interface IIdentityProofVerifyRequest {
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The data bytes base64 encoded.
+         */
+        bytes: string;
+        /**
+         * The proof to verify.
+         */
+        proof: IDidProof;
+    };
+}

package/dist/types/models/api/identity/IIdentityProofVerifyResponse.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Response to verifying a proof.
+ */
+export interface IIdentityProofVerifyResponse {
+    /**
+     * The response payload.
+     */
+    body: {
+        verified: boolean;
+    };
+}

package/dist/types/models/api/identity/IIdentityServiceCreateRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Request to create a service.
+ */
+export interface IIdentityServiceCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the service for.
+         */
+        identity: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The id of the service.
+         */
+        serviceId: string;
+        /**
+         * The type of the service.
+         */
+        type: string | string[];
+        /**
+         * The endpoint for the service.
+         */
+        endpoint: string | string[];
+    };
+}

package/dist/types/models/api/identity/IIdentityServiceCreateResponse.d.ts

@@ -0,0 +1,10 @@
+import type { IDidService } from "@twin.org/standards-w3c-did";
+/**
+ * Response to creating a service.
+ */
+export interface IIdentityServiceCreateResponse {
+    /**
+     * The response payload.
+     */
+    body: IDidService;
+}

package/dist/types/models/api/identity/IIdentityServiceRemoveRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Request to remove a service.
+ */
+export interface IIdentityServiceRemoveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to remove the service from.
+         */
+        identity: string;
+        /**
+         * The service to remove.
+         */
+        serviceId: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialCreateRequest.d.ts

@@ -0,0 +1,36 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Request to create a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the verification credential for.
+         */
+        identity: string;
+        /**
+         * The verification method id to use.
+         */
+        verificationMethodId: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The id of the credential.
+         */
+        credentialId?: string;
+        /**
+         * The credential subject to store in the verifiable credential.
+         */
+        subject: IJsonLdNodeObject;
+        /**
+         * The bitmap revocation index of the credential, if undefined will not have revocation status.
+         */
+        revocationIndex?: number;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialCreateResponse.d.ts

@@ -0,0 +1,19 @@
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+/**
+ * Response to creating a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialCreateResponse {
+    /**
+     * The response payload.
+     */
+    body: {
+        /**
+         * The verifiable credential that was created.
+         */
+        verifiableCredential: IDidVerifiableCredential;
+        /**
+         * The JWT token for the verifiable credential.
+         */
+        jwt: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialRevokeRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Request to revoke a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialRevokeRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to revoke the verification credential for.
+         */
+        identity: string;
+        /**
+         * The revocation index to revoke.
+         */
+        revocationIndex: number;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Request to unrevoke a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialUnrevokeRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to unrevoke the verification credential for.
+         */
+        identity: string;
+        /**
+         * The revocation index to unrevoke.
+         */
+        revocationIndex: number;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialVerifyRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request to verify a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialVerifyRequest {
+    /**
+     * The path parameters.
+     */
+    query: {
+        /**
+         * The jwt to verify.
+         */
+        jwt: string;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiableCredentialVerifyResponse.d.ts

@@ -0,0 +1,19 @@
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+/**
+ * Response to verifying a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialVerifyResponse {
+    /**
+     * The response payload.
+     */
+    body: {
+        /**
+         * Has the credential been revoked.
+         */
+        revoked: boolean;
+        /**
+         * The verifiable credential that was verified.
+         */
+        verifiableCredential?: IDidVerifiableCredential;
+    };
+}

package/dist/types/models/api/identity/IIdentityVerifiablePresentationCreateRequest.d.ts

@@ -0,0 +1,45 @@
+import type { IJsonLdContextDefinitionRoot } from "@twin.org/data-json-ld";
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+/**
+ * Request to create a verifiable presentation.
+ */
+export interface IIdentityVerifiablePresentationCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the verification presentation for.
+         */
+        identity: string;
+        /**
+         * The verification method id to use.
+         */
+        verificationMethodId: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The id of the presentation.
+         */
+        presentationId?: string;
+        /**
+         * The context to use for the presentation.
+         */
+        contexts?: IJsonLdContextDefinitionRoot;
+        /**
+         * The types of the presentation.
+         */
+        types?: string | string[];
+        /**
+         * The verifiable credentials to include in the presentation.
+         */
+        verifiableCredentials: (string | IDidVerifiableCredential)[];
+        /**
+         * The expiration time for the presentation.
+         */
+        expiresInMinutes?: number;
+    };
+}