@twin.org/identity-service 0.0.1-next.9 → 0.0.1

package/dist/types/identityProfileRoutes.d.ts

@@ -1,4 +1,4 @@
-import type { IHttpRequestContext, INoContentRequest, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import { type IHttpRequestContext, type INoContentRequest, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
 import type { IIdentityProfileCreateRequest, IIdentityProfileGetPublicRequest, IIdentityProfileGetPublicResponse, IIdentityProfileGetRequest, IIdentityProfileGetResponse, IIdentityProfileListRequest, IIdentityProfileListResponse, IIdentityProfileUpdateRequest } from "@twin.org/identity-models";
 /**
  * The tag to associate with the routes.

package/dist/types/identityProfileService.d.ts

@@ -1,9 +1,14 @@
 import type { IJsonLdDocument } from "@twin.org/data-json-ld";
 import { type IIdentityProfileComponent } from "@twin.org/identity-models";
+import type { IIdentityProfileServiceConstructorOptions } from "./models/IIdentityProfileServiceConstructorOptions";
 /**
  * Class which implements the identity profile contract.
  */
 export declare class IdentityProfileService<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> implements IIdentityProfileComponent<T, U> {
+    /**
+     * The namespace supported by the identity profile service.
+     */
+    static readonly NAMESPACE: string;
     /**
      * Runtime name for the class.
      */
@@ -11,11 +16,8 @@ export declare class IdentityProfileService<T extends IJsonLdDocument = IJsonLdD
     /**
      * Create a new instance of IdentityProfileService.
      * @param options The dependencies for the identity profile service.
-     * @param options.profileEntityConnectorType The storage connector for the profiles, default to "identity-profile".
      */
-    constructor(options?: {
-        profileEntityConnectorType?: string;
-    });
+    constructor(options?: IIdentityProfileServiceConstructorOptions);
     /**
      * Create the profile properties for an identity.
      * @param publicProfile The public profile data as JSON-LD.

package/dist/types/identityResolverRoutes.d.ts

@@ -0,0 +1,21 @@
+import type { IHttpRequestContext, IRestRoute, ITag } from "@twin.org/api-models";
+import type { IIdentityResolveRequest, IIdentityResolveResponse } from "@twin.org/identity-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsIdentityResolver: ITag[];
+/**
+ * The REST routes for identity.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesIdentityResolver(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Resolve an identity.
+ * @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 identityResolve(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityResolveRequest): Promise<IIdentityResolveResponse>;

package/dist/types/identityResolverService.d.ts

@@ -0,0 +1,27 @@
+import { type IIdentityResolverComponent } from "@twin.org/identity-models";
+import type { IDidDocument } from "@twin.org/standards-w3c-did";
+import type { IIdentityResolverServiceConstructorOptions } from "./models/IIdentityResolverServiceConstructorOptions";
+/**
+ * Class which implements the identity resolver contract.
+ */
+export declare class IdentityResolverService implements IIdentityResolverComponent {
+    /**
+     * The namespace supported by the identity service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of IdentityResolverService.
+     * @param options The options for the service.
+     */
+    constructor(options?: IIdentityResolverServiceConstructorOptions);
+    /**
+     * Resolve an identity.
+     * @param identity The id of the document to resolve.
+     * @returns The resolved document.
+     */
+    identityResolve(identity: string): Promise<IDidDocument>;
+}

package/dist/types/identityRoutes.d.ts

@@ -1,5 +1,5 @@
-import type { IHttpRequestContext, IRestRoute, ITag } from "@twin.org/api-models";
-import type { IIdentityResolveRequest, IIdentityResolveResponse } from "@twin.org/identity-models";
+import type { IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import { type IIdentityRemoveRequest, type IIdentityCreateRequest, type IIdentityCreateResponse, type IIdentityProofCreateRequest, type IIdentityProofCreateResponse, type IIdentityProofVerifyRequest, type IIdentityProofVerifyResponse, 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";
 /**
  * The tag to associate with the routes.
  */
@@ -12,10 +12,114 @@ export declare const tagsIdentity: ITag[];
  */
 export declare function generateRestRoutesIdentity(baseRouteName: string, componentName: string): IRestRoute[];
 /**
- * Resolve an identity.
+ * Create an identity.
  * @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 identityResolve(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityResolveRequest): Promise<IIdentityResolveResponse>;
+export declare function identityCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityCreateRequest): Promise<IIdentityCreateResponse>;
+/**
+ * Remove an identity.
+ * @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 identityRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Create an identity verification method.
+ * @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 identityVerificationMethodCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerificationMethodCreateRequest): Promise<IIdentityVerificationMethodCreateResponse>;
+/**
+ * Remove an identity verification method.
+ * @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 identityVerificationMethodRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerificationMethodRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Create an identity service.
+ * @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 identityServiceCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityServiceCreateRequest): Promise<IIdentityServiceCreateResponse>;
+/**
+ * Remove an identity service.
+ * @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 identityServiceRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityServiceRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Create a verifiable credential.
+ * @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 identityVerifiableCredentialCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiableCredentialCreateRequest): Promise<IIdentityVerifiableCredentialCreateResponse>;
+/**
+ * Verify a verifiable credential.
+ * @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 identityVerifiableCredentialVerify(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiableCredentialVerifyRequest): Promise<IIdentityVerifiableCredentialVerifyResponse>;
+/**
+ * Revoke a verifiable credential.
+ * @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 identityVerifiableCredentialRevoke(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiableCredentialRevokeRequest): Promise<INoContentResponse>;
+/**
+ * Unrevoke a verifiable credential.
+ * @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 identityVerifiableCredentialUnrevoke(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiableCredentialUnrevokeRequest): Promise<INoContentResponse>;
+/**
+ * Create a verifiable presentation.
+ * @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 identityVerifiablePresentationCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiablePresentationCreateRequest): Promise<IIdentityVerifiablePresentationCreateResponse>;
+/**
+ * Verify a verifiable presentation.
+ * @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 identityVerifiablePresentationVerify(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityVerifiablePresentationVerifyRequest): Promise<IIdentityVerifiablePresentationVerifyResponse>;
+/**
+ * Create an identity proof.
+ * @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 identityProofCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProofCreateRequest): Promise<IIdentityProofCreateResponse>;
+/**
+ * Verify an identity proof.
+ * @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 identityProofVerify(httpRequestContext: IHttpRequestContext, componentName: string, request: IIdentityProofVerifyRequest): Promise<IIdentityProofVerifyResponse>;

package/dist/types/identityService.d.ts

@@ -1,6 +1,7 @@
+import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IIdentityComponent } from "@twin.org/identity-models";
-import type { IDidDocument } from "@twin.org/standards-w3c-did";
-import type { IIdentityServiceConfig } from "./models/IIdentityServiceConfig";
+import { DidVerificationMethodType, ProofTypes, type IDidDocument, type IDidDocumentVerificationMethod, type IProof, type IDidService, type IDidVerifiableCredential, type IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+import type { IIdentityServiceConstructorOptions } from "./models/IIdentityServiceConstructorOptions";
 /**
  * Class which implements the identity contract.
  */
@@ -16,15 +17,140 @@ export declare class IdentityService implements IIdentityComponent {
     /**
      * Create a new instance of IdentityService.
      * @param options The options for the service.
-     * @param options.config The configuration for the service.
      */
-    constructor(options?: {
-        config?: IIdentityServiceConfig;
-    });
+    constructor(options?: IIdentityServiceConstructorOptions);
     /**
-     * Resolve an identity.
-     * @param documentId The id of the document to resolve.
-     * @returns The resolved document.
+     * Create a new identity.
+     * @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.
      */
-    resolve(documentId: string): Promise<IDidDocument>;
+    identityCreate(namespace?: string, controller?: string): Promise<IDidDocument>;
+    /**
+     * 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.
+     */
+    identityRemove(identity: string, controller?: string): Promise<void>;
+    /**
+     * Add a verification method to the document in JSON Web key Format.
+     * @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(identity: string, verificationMethodType: DidVerificationMethodType, verificationMethodId?: string, controller?: string): Promise<IDidDocumentVerificationMethod>;
+    /**
+     * 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.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple revocable keys.
+     */
+    verificationMethodRemove(verificationMethodId: string, controller?: string): Promise<void>;
+    /**
+     * Add a service to the document.
+     * @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(identity: string, serviceId: string, serviceType: string | string[], serviceEndpoint: string | string[], controller?: string): Promise<IDidService>;
+    /**
+     * 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.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    serviceRemove(serviceId: string, controller?: string): Promise<void>;
+    /**
+     * Create a verifiable credential for a verification method.
+     * @param verificationMethodId The verification method id to use.
+     * @param id The id of the 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(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, revocationIndex?: number, controller?: string): Promise<{
+        verifiableCredential: IDidVerifiableCredential;
+        jwt: string;
+    }>;
+    /**
+     * Verify a verifiable credential is valid.
+     * @param credentialJwt The credential to verify.
+     * @returns The credential stored in the jwt and the revocation status.
+     */
+    verifiableCredentialVerify(credentialJwt: string): 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 controller The controller of the identity who can make changes.
+     * @returns Nothing.
+     */
+    verifiableCredentialRevoke(issuerIdentity: string, credentialIndex: number, controller?: string): Promise<void>;
+    /**
+     * Unrevoke verifiable credential.
+     * @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.
+     */
+    verifiableCredentialUnrevoke(issuerIdentity: string, credentialIndex: number, controller?: string): Promise<void>;
+    /**
+     * Create a verifiable presentation from the supplied verifiable credentials.
+     * @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(verificationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number, controller?: string): Promise<{
+        verifiablePresentation: IDidVerifiablePresentation;
+        jwt: string;
+    }>;
+    /**
+     * Verify a verifiable presentation is valid.
+     * @param presentationJwt The presentation to verify.
+     * @returns The presentation stored in the jwt and the revocation status.
+     */
+    verifiablePresentationVerify(presentationJwt: string): Promise<{
+        revoked: boolean;
+        verifiablePresentation?: IDidVerifiablePresentation;
+        issuers?: IDidDocument[];
+    }>;
+    /**
+     * Create a proof for a document with the specified verification method.
+     * @param verificationMethodId The verification method id to use.
+     * @param proofType The type of proof to create.
+     * @param unsecureDocument The unsecure document to create the proof for.
+     * @param controller The controller of the identity who can make changes.
+     * @returns The proof.
+     */
+    proofCreate(verificationMethodId: string, proofType: ProofTypes, unsecureDocument: IJsonLdNodeObject, controller?: string): Promise<IProof>;
+    /**
+     * Verify proof for a document with the specified verification method.
+     * @param document The document to verify.
+     * @param proof The proof to verify.
+     * @returns True if the proof is verified.
+     */
+    proofVerify(document: IJsonLdNodeObject, proof: IProof): Promise<boolean>;
 }

package/dist/types/index.d.ts

@@ -1,6 +1,12 @@
 export * from "./identityProfileRoutes";
 export * from "./identityProfileService";
+export * from "./identityResolverRoutes";
+export * from "./identityResolverService";
 export * from "./identityRoutes";
 export * from "./identityService";
+export * from "./models/IIdentityProfileServiceConstructorOptions";
+export * from "./models/IIdentityResolverServiceConfig";
+export * from "./models/IIdentityResolverServiceConstructorOptions";
 export * from "./models/IIdentityServiceConfig";
+export * from "./models/IIdentityServiceConstructorOptions";
 export * from "./restEntryPoints";

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

@@ -0,0 +1,10 @@
+/**
+ * Options for the identity profile service constructor.
+ */
+export interface IIdentityProfileServiceConstructorOptions {
+    /**
+     * The storage connector for the profiles.
+     * @default identity-profile
+     */
+    profileEntityConnectorType?: string;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Configuration for the Identity Resolver Service.
+ */
+export interface IIdentityResolverServiceConfig {
+    /**
+     * What is the default connector to use for Identity. If not provided the first connector from the factory will be used.
+     */
+    defaultNamespace?: string;
+}

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

@@ -0,0 +1,15 @@
+import type { IIdentityResolverServiceConfig } from "./IIdentityResolverServiceConfig";
+/**
+ * Options for the identity resolver service constructor.
+ */
+export interface IIdentityResolverServiceConstructorOptions {
+    /**
+     * Fallback connector type to use if the namespace connector is not available.
+     * @default universal
+     */
+    fallbackResolverConnectorType?: string;
+    /**
+     * The configuration for the identity service.
+     */
+    config?: IIdentityResolverServiceConfig;
+}

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

@@ -0,0 +1,10 @@
+import type { IIdentityServiceConfig } from "./IIdentityServiceConfig";
+/**
+ * Options for the identity service constructor.
+ */
+export interface IIdentityServiceConstructorOptions {
+    /**
+     * The configuration for the identity service.
+     */
+    config?: IIdentityServiceConfig;
+}