@twin.org/identity-models 0.0.1-next.8 → 0.0.1

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation, ProofTypes } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing an identity connector.
  */
@@ -12,12 +12,12 @@ export interface IIdentityConnector extends IComponent {
      */
     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.
+     * 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.
      */
-    resolveDocument(documentId: string): Promise<IDidDocument>;
+    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.
@@ -48,7 +48,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.
@@ -62,13 +62,13 @@ 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<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, verificationMethodId: string, id: string | undefined, credential: T, revocationIndex?: number): Promise<{
-        verifiableCredential: IDidVerifiableCredential<T>;
+    createVerifiableCredential(controller: string, verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+        verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
@@ -76,9 +76,9 @@ export interface IIdentityConnector extends IComponent {
      * @param credentialJwt The credential to verify.
      * @returns The credential stored in the jwt and the revocation status.
      */
-    checkVerifiableCredential<T extends IJsonLdNodeObject = IJsonLdNodeObject>(credentialJwt: string): Promise<{
+    checkVerifiableCredential(credentialJwt: string): Promise<{
         revoked: boolean;
-        verifiableCredential?: IDidVerifiableCredential<T>;
+        verifiableCredential?: IDidVerifiableCredential;
     }>;
     /**
      * Revoke verifiable credential(s).
@@ -99,7 +99,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.
@@ -108,8 +108,8 @@ export interface IIdentityConnector extends IComponent {
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiablePresentation<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential<T>)[], expiresInMinutes?: number): Promise<{
-        verifiablePresentation: IDidVerifiablePresentation<T>;
+    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;
     }>;
     /**
@@ -117,29 +117,25 @@ export interface IIdentityConnector extends IComponent {
      * @param presentationJwt The presentation to verify.
      * @returns The presentation stored in the jwt and the revocation status.
      */
-    checkVerifiablePresentation<T extends IJsonLdNodeObject = IJsonLdNodeObject>(presentationJwt: string): Promise<{
+    checkVerifiablePresentation(presentationJwt: string): Promise<{
         revoked: boolean;
-        verifiablePresentation?: IDidVerifiablePresentation<T>;
+        verifiablePresentation?: IDidVerifiablePresentation;
         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.
+     * @param proofType The type of proof to create.
+     * @param unsecureDocument The unsecure document to create the proof for.
+     * @returns The proof.
      */
-    createProof(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<{
-        type: string;
-        value: Uint8Array;
-    }>;
+    createProof(controller: string, verificationMethodId: string, proofType: ProofTypes, unsecureDocument: IJsonLdNodeObject): Promise<IProof>;
     /**
      * 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.
+     * @param document The document to verify.
+     * @param proof The proof to verify.
+     * @returns True if the proof is verified.
      */
-    verifyProof(verificationMethodId: string, bytes: Uint8Array, signatureType: string, signatureValue: Uint8Array): Promise<boolean>;
+    verifyProof(document: IJsonLdNodeObject, proof: IProof): Promise<boolean>;
 }

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

@@ -0,0 +1,13 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Interface describing a contract which provides identity operations.
+ */
+export interface IIdentityResolverComponent extends IComponent {
+    /**
+     * Resolve an identity.
+     * @param identity The id of the document to resolve.
+     * @returns The resolved document.
+     */
+    identityResolve(identity: string): Promise<IDidDocument>;
+}

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

@@ -0,0 +1,14 @@
+import type { IComponent } from "@twin.org/core";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+/**
+ * Interface describing an identity connector.
+ */
+export interface IIdentityResolverConnector extends IComponent {
+    /**
+     * 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>;
+}

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,33 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { ProofTypes } from "@twin.org/standards-w3c-did";
+/**
+ * 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 type of proof to create.
+         */
+        proofType: ProofTypes;
+        /**
+         * The document to create the proof for.
+         */
+        document: IJsonLdNodeObject;
+    };
+}

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

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

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

@@ -0,0 +1,20 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IProof } from "@twin.org/standards-w3c-did";
+/**
+ * Request to verify a proof.
+ */
+export interface IIdentityProofVerifyRequest {
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The document to verify the proof for.
+         */
+        document: IJsonLdNodeObject;
+        /**
+         * The proof to verify.
+         */
+        proof: IProof;
+    };
+}

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/IIdentityRemoveRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Request to remove an identity.
+ */
+export interface IIdentityRemoveRequest {
+    /**
+     * The data for the request.
+     */
+    pathParams: {
+        /**
+         * The identity to remove.
+         */
+        identity: string;
+    };
+}

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;
+    };
+}

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

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

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

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

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

@@ -0,0 +1,23 @@
+import type { IDidDocument, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+/**
+ * Response to verifying a verifiable presentation.
+ */
+export interface IIdentityVerifiablePresentationVerifyResponse {
+    /**
+     * The response payload.
+     */
+    body: {
+        /**
+         * Has the presentation been revoked.
+         */
+        revoked: boolean;
+        /**
+         * The verifiable presentation that was verified.
+         */
+        verifiablePresentation?: IDidVerifiablePresentation;
+        /**
+         * The issuers of the presentation.
+         */
+        issuers?: IDidDocument[];
+    };
+}

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

@@ -0,0 +1,28 @@
+import type { DidVerificationMethodType } from "@twin.org/standards-w3c-did";
+/**
+ * Request to create a verification method.
+ */
+export interface IIdentityVerificationMethodCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the verification method for.
+         */
+        identity: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The type of the verification method to create.
+         */
+        verificationMethodType: DidVerificationMethodType;
+        /**
+         * The optional id for the verification method, will be allocated if not supplied.
+         */
+        verificationMethodId?: string;
+    };
+}

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

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

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

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

package/dist/types/models/api/{IIdentityProfileListRequest.d.ts → profile/IIdentityProfileListRequest.d.ts}

@@ -21,6 +21,6 @@ export interface IIdentityProfileListRequest {
         /**
          * Number of items to return.
          */
-        pageSize?: number;
+        pageSize?: number | string;
     };
 }

package/dist/types/models/api/{IIdentityResolveRequest.d.ts → resolver/IIdentityResolveRequest.d.ts}

@@ -7,8 +7,8 @@ export interface IIdentityResolveRequest {
      */
     pathParams: {
         /**
-         * The identity to get the document for.
+         * The identity to resolve.
          */
-        id: string;
+        identity: string;
     };
 }