@twin.org/identity-models 0.0.3-next.3 → 0.0.3-next.30

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

@@ -57,6 +57,28 @@ export interface IIdentityConnector extends IComponent {
      * @throws NotFoundError if the id can not be resolved.
      */
     removeService(controller: string, serviceId: string): Promise<void>;
+    /**
+     * Add an alias to the alsoKnownAs property on the document.
+     * If the alias is already present the operation is a no-op.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to update.
+     * @param alias The alias to add. Must be a Url or Urn (typically another DID).
+     * @returns Nothing.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    addAlsoKnownAs(controller: string, documentId: string, alias: string): Promise<void>;
+    /**
+     * Remove an alias from the alsoKnownAs property on the document.
+     * If the alias is not present the operation is a no-op.
+     * @param controller The controller of the identity who can make changes.
+     * @param documentId The id of the document to update.
+     * @param alias The alias to remove. Must be a Url or Urn.
+     * @returns Nothing.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    removeAlsoKnownAs(controller: string, documentId: string, alias: string): Promise<void>;
     /**
      * Create a verifiable credential for a verification method.
      * @param controller The controller of the identity who can make changes.
@@ -66,22 +88,30 @@ export interface IIdentityConnector extends IComponent {
      * @param options Additional options for creating the verifiable credential.
      * @param options.revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
      * @param options.expirationDate The date the verifiable credential is valid until.
+     * @param options.jwtHeaderFields Additional fields to include in the JWT header when creating the verifiable credential in jwt format.
+     * @param options.jwtPayloadFields	Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
      * @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, subject: IJsonLdNodeObject, options?: {
         revocationIndex?: number;
         expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     }): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
      * Check a verifiable credential is valid.
-     * @param credentialJwt The credential to verify.
+     * @param credential The credential to verify.
      * @returns The credential stored in the jwt and the revocation status.
      */
-    checkVerifiableCredential(credentialJwt: string): Promise<{
+    checkVerifiableCredential(credential: string | IDidVerifiableCredential): Promise<{
         revoked: boolean;
         verifiableCredential?: IDidVerifiableCredential;
     }>;
@@ -109,20 +139,31 @@ export interface IIdentityConnector extends IComponent {
      * @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 options Additional options for creating the verifiable presentation.
+     * @param options.expirationDate The date the verifiable presentation is valid until.
+     * @param options.jwtHeaderFields Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+     * @param options.jwtPayloadFields Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiablePresentation(controller: string, verificationMethodId: 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)[], options?: {
+        expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
+    }): Promise<{
         verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;
     /**
      * Check a verifiable presentation is valid.
-     * @param presentationJwt The presentation to verify.
+     * @param presentation The presentation to verify.
      * @returns The presentation stored in the jwt and the revocation status.
      */
-    checkVerifiablePresentation(presentationJwt: string): Promise<{
+    checkVerifiablePresentation(presentation: string | IDidVerifiablePresentation): Promise<{
         revoked: boolean;
         verifiablePresentation?: IDidVerifiablePresentation;
         issuers?: IDidDocument[];

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

@@ -0,0 +1,23 @@
+/**
+ * Request to create an alias for an identity.
+ */
+export interface IIdentityAlsoKnownAsCreateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to create the alias for.
+         */
+        identity: string;
+    };
+    /**
+     * The data for the request.
+     */
+    body: {
+        /**
+         * The alias to create for the identity.
+         */
+        alias: string;
+    };
+}

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

@@ -0,0 +1,18 @@
+/**
+ * Request to remove an alias from an identity.
+ */
+export interface IIdentityAlsoKnownAsRemoveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The identity to remove the alias from.
+         */
+        identity: string;
+        /**
+         * The alias to remove.
+         */
+        alias: string;
+    };
+}

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

@@ -36,5 +36,17 @@ export interface IIdentityVerifiableCredentialCreateRequest {
          * The date the verifiable credential is valid until.
          */
         expirationDate?: string;
+        /**
+         * Additional fields to include in the JWT when creating the verifiable credential in jwt format.
+         */
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        /**
+         * Additional fields to include in the JWT payload when creating the verifiable credential in jwt format.
+         */
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     };
 }

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

@@ -13,6 +13,6 @@ export interface IIdentityVerifiableCredentialRevokeRequest {
         /**
          * The revocation index to revoke.
          */
-        revocationIndex: number;
+        revocationIndex: string;
     };
 }

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

@@ -13,6 +13,6 @@ export interface IIdentityVerifiableCredentialUnrevokeRequest {
         /**
          * The revocation index to unrevoke.
          */
-        revocationIndex: number;
+        revocationIndex: string;
     };
 }

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

@@ -0,0 +1,10 @@
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+/**
+ * Request to verify a verifiable credential.
+ */
+export interface IIdentityVerifiableCredentialVerifyDocumentRequest {
+    /**
+     * The body parameters.
+     */
+    body: IDidVerifiableCredential;
+}

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

@@ -38,8 +38,20 @@ export interface IIdentityVerifiablePresentationCreateRequest {
          */
         verifiableCredentials: (string | IDidVerifiableCredential)[];
         /**
-         * The expiration time for the presentation.
+         * The expiration date/time for the presentation.
          */
-        expiresInMinutes?: number;
+        expirationDate?: string;
+        /**
+         * Additional fields to include in the JWT header when creating the verifiable presentation in jwt format.
+         */
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        /**
+         * Additional fields to include in the JWT payload when creating the verifiable presentation in jwt format.
+         */
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     };
 }

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

@@ -0,0 +1,10 @@
+import type { IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+/**
+ * Request to verify a verifiable presentation.
+ */
+export interface IIdentityVerifiablePresentationVerifyDocumentRequest {
+    /**
+     * The body parameters.
+     */
+    body: IDidVerifiablePresentation;
+}

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

@@ -0,0 +1,49 @@
+/**
+ * Metric IDs for the identity service.
+ */
+export declare const IdentityMetricIds: {
+    /**
+     * Number of DIDs created.
+     */
+    readonly DidsCreated: "identity_dids_created";
+    /**
+     * Number of DIDs removed.
+     */
+    readonly DidsRemoved: "identity_dids_removed";
+    /**
+     * Number of verifiable credentials created.
+     */
+    readonly VcsCreated: "identity_vcs_created";
+    /**
+     * Number of VC verifications succeeded.
+     */
+    readonly VcsVerified: "identity_vcs_verified";
+    /**
+     * Number of VC verifications failed.
+     */
+    readonly VcsVerificationFailed: "identity_vcs_verification_failed";
+    /**
+     * Number of VCs revoked.
+     */
+    readonly VcsRevoked: "identity_vcs_revoked";
+    /**
+     * Number of VCs unrevoked.
+     */
+    readonly VcsUnrevoked: "identity_vcs_unrevoked";
+    /**
+     * Number of verifiable presentations created.
+     */
+    readonly VpsCreated: "identity_vps_created";
+    /**
+     * Number of VP verifications succeeded.
+     */
+    readonly VpsVerified: "identity_vps_verified";
+    /**
+     * Number of VP verifications failed.
+     */
+    readonly VpsVerificationFailed: "identity_vps_verification_failed";
+};
+/**
+ * Metric IDs for the identity service.
+ */
+export type IdentityMetricIds = (typeof IdentityMetricIds)[keyof typeof IdentityMetricIds];

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

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the identity service.
+ */
+export declare const IdentityMetrics: ITelemetryMetric[];