@twin.org/identity-service 0.0.3-next.9 → 0.9.0

package/dist/types/identityRoutes.d.ts

@@ -1,5 +1,5 @@
 import type { IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
-import { type IIdentityCreateRequest, type IIdentityCreateResponse, type IIdentityProofCreateRequest, type IIdentityProofCreateResponse, type IIdentityProofVerifyRequest, type IIdentityProofVerifyResponse, type IIdentityRemoveRequest, type IIdentityServiceCreateRequest, type IIdentityServiceCreateResponse, type IIdentityServiceRemoveRequest, type IIdentityVerifiableCredentialCreateRequest, type IIdentityVerifiableCredentialCreateResponse, type IIdentityVerifiableCredentialRevokeRequest, type IIdentityVerifiableCredentialUnrevokeRequest, type IIdentityVerifiableCredentialVerifyRequest, type IIdentityVerifiableCredentialVerifyResponse, type IIdentityVerifiablePresentationCreateRequest, type IIdentityVerifiablePresentationCreateResponse, type IIdentityVerifiablePresentationVerifyRequest, type IIdentityVerifiablePresentationVerifyResponse, type IIdentityVerificationMethodCreateRequest, type IIdentityVerificationMethodCreateResponse, type IIdentityVerificationMethodRemoveRequest } from "@twin.org/identity-models";
+import { type IIdentityAlsoKnownAsCreateRequest, type IIdentityAlsoKnownAsRemoveRequest, type IIdentityCreateRequest, type IIdentityCreateResponse, type IIdentityProofCreateRequest, type IIdentityProofCreateResponse, type IIdentityProofVerifyRequest, type IIdentityProofVerifyResponse, type IIdentityRemoveRequest, type IIdentityServiceCreateRequest, type IIdentityServiceCreateResponse, type IIdentityServiceRemoveRequest, type IIdentityVerifiableCredentialCreateRequest, type IIdentityVerifiableCredentialCreateResponse, type IIdentityVerifiableCredentialRevokeRequest, type IIdentityVerifiableCredentialUnrevokeRequest, type IIdentityVerifiableCredentialVerifyRequest, type IIdentityVerifiableCredentialVerifyDocumentRequest, type IIdentityVerifiableCredentialVerifyResponse, type IIdentityVerifiablePresentationCreateRequest, type IIdentityVerifiablePresentationCreateResponse, type IIdentityVerifiablePresentationVerifyRequest, type IIdentityVerifiablePresentationVerifyResponse, type IIdentityVerificationMethodCreateRequest, type IIdentityVerificationMethodCreateResponse, type IIdentityVerificationMethodRemoveRequest, type IIdentityVerifiablePresentationVerifyDocumentRequest } from "@twin.org/identity-models";
 /**
  * The tag to associate with the routes.
  */
@@ -59,6 +59,22 @@ export declare function identityServiceCreate(httpRequestContext: IHttpRequestCo
  * @returns The response object with additional http response properties.
  */
 export declare function identityServiceRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityServiceRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Create an identity alias.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function identityAlsoKnownAsCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityAlsoKnownAsCreateRequest): Promise<INoContentResponse>;
+/**
+ * Remove an identity alias.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function identityAlsoKnownAsRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityAlsoKnownAsRemoveRequest): Promise<INoContentResponse>;
 /**
  * Create a verifiable credential.
  * @param httpRequestContext The request context for the API.
@@ -75,6 +91,14 @@ export declare function identityVerifiableCredentialCreate(httpRequestContext: I
  * @returns The response object with additional http response properties.
  */
 export declare function identityVerifiableCredentialVerify(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiableCredentialVerifyRequest): Promise<IIdentityVerifiableCredentialVerifyResponse>;
+/**
+ * Verify a verifiable credential document.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function identityVerifiableCredentialVerifyDocument(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiableCredentialVerifyDocumentRequest): Promise<IIdentityVerifiableCredentialVerifyResponse>;
 /**
  * Revoke a verifiable credential.
  * @param httpRequestContext The request context for the API.
@@ -107,6 +131,14 @@ export declare function identityVerifiablePresentationCreate(httpRequestContext:
  * @returns The response object with additional http response properties.
  */
 export declare function identityVerifiablePresentationVerify(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiablePresentationVerifyRequest): Promise<IIdentityVerifiablePresentationVerifyResponse>;
+/**
+ * Verify a verifiable presentation document.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function identityVerifiablePresentationVerifyDocument(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiablePresentationVerifyDocumentRequest): Promise<IIdentityVerifiablePresentationVerifyResponse>;
 /**
  * Create an identity proof.
  * @param httpRequestContext The request context for the API.

package/dist/types/identityService.d.ts

@@ -13,6 +13,7 @@ export declare class IdentityService implements IIdentityComponent {
     /**
      * Create a new instance of IdentityService.
      * @param options The options for the service.
+     * @throws GeneralError if no connectors are registered.
      */
     constructor(options?: IIdentityServiceConstructorOptions);
     /**
@@ -20,6 +21,11 @@ export declare class IdentityService implements IIdentityComponent {
      * @returns The class name of the component.
      */
     className(): string;
+    /**
+     * Register all identity metrics with the telemetry component.
+     * @returns A promise that resolves when all metrics have been registered.
+     */
+    start(): Promise<void>;
     /**
      * Create a new identity.
      * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.
@@ -31,7 +37,7 @@ export declare class IdentityService implements IIdentityComponent {
      * Remove an identity.
      * @param identity The id of the document to remove.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the identity has been removed.
      */
     identityRemove(identity: string, controller?: string): Promise<void>;
     /**
@@ -49,7 +55,7 @@ export declare class IdentityService implements IIdentityComponent {
      * Remove a verification method from the document.
      * @param verificationMethodId The id of the verification method.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the verification method has been removed.
      * @throws NotFoundError if the id can not be resolved.
      * @throws NotSupportedError if the platform does not support multiple revocable keys.
      */
@@ -69,10 +75,32 @@ export declare class IdentityService implements IIdentityComponent {
      * Remove a service from the document.
      * @param serviceId The id of the service.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the service has been removed.
      * @throws NotFoundError if the id can not be resolved.
      */
     serviceRemove(serviceId: string, controller?: 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 documentId The id of the document to update.
+     * @param alias The alias to add. Must be a Url or Urn (typically another DID).
+     * @param controller The controller of the identity who can make changes.
+     * @returns A promise that resolves when the alias has been added.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    alsoKnownAsAdd(documentId: string, alias: string, controller?: 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 documentId The id of the document to update.
+     * @param alias The alias to remove. Must be a Url or Urn.
+     * @param controller The controller of the identity who can make changes.
+     * @returns A promise that resolves when the alias has been removed.
+     * @throws GeneralError if the alias is not a Url or Urn.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    alsoKnownAsRemove(documentId: string, alias: string, controller?: string): Promise<void>;
     /**
      * Create a verifiable credential for a verification method.
      * @param verificationMethodId The verification method id to use.
@@ -81,6 +109,8 @@ export declare class IdentityService implements IIdentityComponent {
      * @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.
      * @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.
@@ -88,25 +118,31 @@ export declare class IdentityService implements IIdentityComponent {
     verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, options?: {
         revocationIndex?: number;
         expirationDate?: Date;
+        jwtHeaderFields?: {
+            [id: string]: string;
+        };
+        jwtPayloadFields?: {
+            [id: string]: string;
+        };
     }, controller?: string): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
      * Verify 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.
      */
-    verifiableCredentialVerify(credentialJwt: string): Promise<{
+    verifiableCredentialVerify(credential: string | IDidVerifiableCredential): Promise<{
         revoked: boolean;
         verifiableCredential?: IDidVerifiableCredential;
     }>;
     /**
      * Revoke verifiable credential.
      * @param issuerIdentity The id of the document to update the revocation list for.
-     * @param credentialIndex The revocation bitmap index revoke.
+     * @param credentialIndex The revocation bitmap index to revoke.
      * @param controller The controller of the identity who can make changes.
-     * @returns Nothing.
+     * @returns A promise that resolves when the credential has been revoked.
      */
     verifiableCredentialRevoke(issuerIdentity: string, credentialIndex: number, controller?: string): Promise<void>;
     /**
@@ -114,7 +150,7 @@ export declare class IdentityService implements IIdentityComponent {
      * @param issuerIdentity 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.
+     * @returns A promise that resolves when the credential has been unrevoked.
      */
     verifiableCredentialUnrevoke(issuerIdentity: string, credentialIndex: number, controller?: string): Promise<void>;
     /**
@@ -124,21 +160,32 @@ export declare class IdentityService implements IIdentityComponent {
      * @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.
      * @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(verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number, controller?: string): Promise<{
+    verifiablePresentationCreate(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;
+        };
+    }, controller?: string): Promise<{
         verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;
     /**
      * Verify 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.
      */
-    verifiablePresentationVerify(presentationJwt: string): Promise<{
+    verifiablePresentationVerify(presentation: string | IDidVerifiablePresentation): Promise<{
         revoked: boolean;
         verifiablePresentation?: IDidVerifiablePresentation;
         issuers?: IDidDocument[];

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

@@ -3,7 +3,7 @@
  */
 export interface IIdentityResolverServiceConfig {
     /**
-     * What is the default connector to use for Identity. If not provided the first connector from the factory will be used.
+     * The default connector namespace to use for identity resolution. If not provided, the first registered connector is used.
      */
     defaultNamespace?: string;
 }

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

@@ -3,7 +3,7 @@
  */
 export interface IIdentityServiceConfig {
     /**
-     * What is the default connector to use for Identity. If not provided the first connector from the factory will be used.
+     * The default connector namespace to use for identity operations. If not provided, the first registered connector is used.
      */
     defaultNamespace?: string;
 }

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

@@ -7,4 +7,8 @@ export interface IIdentityServiceConstructorOptions {
      * The configuration for the identity service.
      */
     config?: IIdentityServiceConfig;
+    /**
+     * The component type for the optional telemetry component used for event metrics.
+     */
+    telemetryComponentType?: string;
 }

package/dist/types/restEntryPoints.d.ts

@@ -1,2 +1,5 @@
 import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * REST entry points for the identity, identity resolver, and identity profile services.
+ */
 export declare const restEntryPoints: IRestRouteEntryPoint[];