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

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

@@ -9,6 +9,6 @@ export interface IIdentityResolveRequest {
         /**
          * The identity to resolve.
          */
-        id: string;
+        identity: string;
     };
 }

package/dist/types/utils/documentHelper.d.ts

@@ -7,8 +7,15 @@ export declare class DocumentHelper {
      * @param documentId The full document id.
      * @returns The parsed document id.
      */
-    static parse(documentId: string): {
+    static parseId(documentId: string): {
         id: string;
-        hash: string | undefined;
+        fragment: string | undefined;
     };
+    /**
+     * 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: string, fragment?: string): string;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-service-models - Changelog
 
-## v0.0.1-next.23
+## v0.0.1-next.25
 
 - Initial Release

package/docs/reference/classes/DocumentHelper.md

@@ -14,9 +14,9 @@ Helper methods for documents.
 
 ## Methods
 
-### parse()
+### parseId()
 
-> `static` **parse**(`documentId`): `object`
+> `static` **parseId**(`documentId`): `object`
 
 Parse the document id into its parts.
 
@@ -38,6 +38,34 @@ The parsed document id.
 
 > **id**: `string`
 
-##### hash
+##### fragment
 
-> **hash**: `undefined` \| `string`
+> **fragment**: `undefined` \| `string`
+
+***
+
+### joinId()
+
+> `static` **joinId**(`documentId`, `fragment`?): `string`
+
+Join the document id parts.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The document id.
+
+##### fragment?
+
+`string`
+
+The fragment part for the identifier.
+
+#### Returns
+
+`string`
+
+The full id.

package/docs/reference/classes/JwtHelper.md

@@ -24,7 +24,7 @@ Runtime name for the class.
 
 ### parse()
 
-> `static` **parse**\<`U`, `T`\>(`jwt`, `paramsToCheck`?): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+> `static` **parse**\<`U`, `T`\>(`jwt`, `paramsToCheck`?): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
 Parse the token and check that the properties are valid.
 
@@ -50,7 +50,7 @@ Parameters to check they exist.
 
 #### Returns
 
-`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`\<`ArrayBufferLike`\>; \}\>
 
 The token components.
 

package/docs/reference/index.md

@@ -13,6 +13,28 @@
 - [IIdentityProfileConnector](interfaces/IIdentityProfileConnector.md)
 - [IIdentityResolverComponent](interfaces/IIdentityResolverComponent.md)
 - [IIdentityResolverConnector](interfaces/IIdentityResolverConnector.md)
+- [IIdentityCreateRequest](interfaces/IIdentityCreateRequest.md)
+- [IIdentityCreateResponse](interfaces/IIdentityCreateResponse.md)
+- [IIdentityProofCreateRequest](interfaces/IIdentityProofCreateRequest.md)
+- [IIdentityProofCreateResponse](interfaces/IIdentityProofCreateResponse.md)
+- [IIdentityProofVerifyRequest](interfaces/IIdentityProofVerifyRequest.md)
+- [IIdentityProofVerifyResponse](interfaces/IIdentityProofVerifyResponse.md)
+- [IIdentityServiceCreateRequest](interfaces/IIdentityServiceCreateRequest.md)
+- [IIdentityServiceCreateResponse](interfaces/IIdentityServiceCreateResponse.md)
+- [IIdentityServiceRemoveRequest](interfaces/IIdentityServiceRemoveRequest.md)
+- [IIdentityVerifiableCredentialCreateRequest](interfaces/IIdentityVerifiableCredentialCreateRequest.md)
+- [IIdentityVerifiableCredentialCreateResponse](interfaces/IIdentityVerifiableCredentialCreateResponse.md)
+- [IIdentityVerifiableCredentialRevokeRequest](interfaces/IIdentityVerifiableCredentialRevokeRequest.md)
+- [IIdentityVerifiableCredentialUnrevokeRequest](interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md)
+- [IIdentityVerifiableCredentialVerifyRequest](interfaces/IIdentityVerifiableCredentialVerifyRequest.md)
+- [IIdentityVerifiableCredentialVerifyResponse](interfaces/IIdentityVerifiableCredentialVerifyResponse.md)
+- [IIdentityVerifiablePresentationCreateRequest](interfaces/IIdentityVerifiablePresentationCreateRequest.md)
+- [IIdentityVerifiablePresentationCreateResponse](interfaces/IIdentityVerifiablePresentationCreateResponse.md)
+- [IIdentityVerifiablePresentationVerifyRequest](interfaces/IIdentityVerifiablePresentationVerifyRequest.md)
+- [IIdentityVerifiablePresentationVerifyResponse](interfaces/IIdentityVerifiablePresentationVerifyResponse.md)
+- [IIdentityVerificationMethodCreateRequest](interfaces/IIdentityVerificationMethodCreateRequest.md)
+- [IIdentityVerificationMethodCreateResponse](interfaces/IIdentityVerificationMethodCreateResponse.md)
+- [IIdentityVerificationMethodRemoveRequest](interfaces/IIdentityVerificationMethodRemoveRequest.md)
 - [IIdentityProfileCreateRequest](interfaces/IIdentityProfileCreateRequest.md)
 - [IIdentityProfileGetPublicRequest](interfaces/IIdentityProfileGetPublicRequest.md)
 - [IIdentityProfileGetPublicResponse](interfaces/IIdentityProfileGetPublicResponse.md)

package/docs/reference/interfaces/IIdentityComponent.md

@@ -10,23 +10,23 @@ Interface describing a contract which provides identity operations.
 
 ### identityCreate()
 
-> **identityCreate**(`controller`, `namespace`?): `Promise`\<`IDidDocument`\>
+> **identityCreate**(`namespace`?, `controller`?): `Promise`\<`IDidDocument`\>
 
 Create a new identity.
 
 #### Parameters
 
-##### controller
+##### namespace?
 
 `string`
 
-The controller of the identity who can make changes.
+The namespace of the connector to use for the identity, defaults to service configured namespace.
 
-##### namespace?
+##### controller?
 
 `string`
 
-The namespace of the connector to use for the identity, defaults to service configured namespace.
+The controller of the identity who can make changes.
 
 #### Returns
 
@@ -38,18 +38,12 @@ The created identity document.
 
 ### verificationMethodCreate()
 
-> **verificationMethodCreate**(`controller`, `identity`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>
+> **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId`?, `controller`?): `Promise`\<`IDidDocumentVerificationMethod`\>
 
 Add a verification method to the document in JSON Web key Format.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
 ##### identity
 
 `string`
@@ -68,6 +62,12 @@ The type of the verification method to add.
 
 The id of the verification method, if undefined uses the kid of the generated JWK.
 
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
 #### Returns
 
 `Promise`\<`IDidDocumentVerificationMethod`\>
@@ -86,23 +86,23 @@ NotSupportedError if the platform does not support multiple keys.
 
 ### verificationMethodRemove()
 
-> **verificationMethodRemove**(`controller`, `verificationMethodId`): `Promise`\<`void`\>
+> **verificationMethodRemove**(`verificationMethodId`, `controller`?): `Promise`\<`void`\>
 
 Remove a verification method from the document.
 
 #### Parameters
 
-##### controller
+##### verificationMethodId
 
 `string`
 
-The controller of the identity who can make changes.
+The id of the verification method.
 
-##### verificationMethodId
+##### controller?
 
 `string`
 
-The id of the verification method.
+The controller of the identity who can make changes.
 
 #### Returns
 
@@ -122,18 +122,12 @@ NotSupportedError if the platform does not support multiple revocable keys.
 
 ### serviceCreate()
 
-> **serviceCreate**(`controller`, `identity`, `serviceId`, `serviceType`, `serviceEndpoint`): `Promise`\<`IDidService`\>
+> **serviceCreate**(`identity`, `serviceId`, `serviceType`, `serviceEndpoint`, `controller`?): `Promise`\<`IDidService`\>
 
 Add a service to the document.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
 ##### identity
 
 `string`
@@ -148,15 +142,21 @@ The id of the service.
 
 ##### serviceType
 
-`string`
-
 The type of the service.
 
+`string` | `string`[]
+
 ##### serviceEndpoint
 
+The endpoint for the service.
+
+`string` | `string`[]
+
+##### controller?
+
 `string`
 
-The endpoint for the service.
+The controller of the identity who can make changes.
 
 #### Returns
 
@@ -172,23 +172,23 @@ NotFoundError if the id can not be resolved.
 
 ### serviceRemove()
 
-> **serviceRemove**(`controller`, `serviceId`): `Promise`\<`void`\>
+> **serviceRemove**(`serviceId`, `controller`?): `Promise`\<`void`\>
 
 Remove a service from the document.
 
 #### Parameters
 
-##### controller
+##### serviceId
 
 `string`
 
-The controller of the identity who can make changes.
+The id of the service.
 
-##### serviceId
+##### controller?
 
 `string`
 
-The id of the service.
+The controller of the identity who can make changes.
 
 #### Returns
 
@@ -204,18 +204,12 @@ NotFoundError if the id can not be resolved.
 
 ### verifiableCredentialCreate()
 
-> **verifiableCredentialCreate**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `revocationIndex`?, `controller`?): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
 ##### verificationMethodId
 
 `string`
@@ -228,11 +222,11 @@ The id of the credential.
 
 `undefined` | `string`
 
-##### credential
+##### subject
 
 `IJsonLdNodeObject`
 
-The credential to store in the verifiable credential.
+The credential subject to store in the verifiable credential.
 
 ##### revocationIndex?
 
@@ -240,6 +234,12 @@ The credential to store in the verifiable credential.
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
 #### Returns
 
 `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
@@ -276,18 +276,12 @@ The credential stored in the jwt and the revocation status.
 
 ### verifiableCredentialRevoke()
 
-> **verifiableCredentialRevoke**(`controller`, `issuerId`, `credentialIndex`): `Promise`\<`void`\>
+> **verifiableCredentialRevoke**(`issuerId`, `credentialIndex`, `controller`?): `Promise`\<`void`\>
 
 Revoke verifiable credential.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
 ##### issuerId
 
 `string`
@@ -300,6 +294,12 @@ The id of the document to update the revocation list for.
 
 The revocation bitmap index revoke.
 
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -310,18 +310,12 @@ Nothing.
 
 ### verifiableCredentialUnrevoke()
 
-> **verifiableCredentialUnrevoke**(`controller`, `issuerId`, `credentialIndex`): `Promise`\<`void`\>
+> **verifiableCredentialUnrevoke**(`issuerId`, `credentialIndex`, `controller`?): `Promise`\<`void`\>
 
 Unrevoke verifiable credential.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
 ##### issuerId
 
 `string`
@@ -334,6 +328,12 @@ The id of the document to update the revocation list for.
 
 The revocation bitmap index to un revoke.
 
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -344,19 +344,13 @@ Nothing.
 
 ### verifiablePresentationCreate()
 
-> **verifiablePresentationCreate**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?, `controller`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
-##### presentationMethodId
+##### verificationMethodId
 
 `string`
 
@@ -392,6 +386,12 @@ The credentials to use for creating the presentation in jwt format.
 
 The time in minutes for the presentation to expire.
 
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
 #### Returns
 
 `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
@@ -428,18 +428,12 @@ The presentation stored in the jwt and the revocation status.
 
 ### proofCreate()
 
-> **proofCreate**(`controller`, `verificationMethodId`, `bytes`): `Promise`\<`IDidProof`\>
+> **proofCreate**(`verificationMethodId`, `bytes`, `controller`?): `Promise`\<`IDidProof`\>
 
 Create a proof for arbitrary data with the specified verification method.
 
 #### Parameters
 
-##### controller
-
-`string`
-
-The controller of the identity who can make changes.
-
 ##### verificationMethodId
 
 `string`
@@ -452,6 +446,12 @@ The verification method id to use.
 
 The data bytes to sign.
 
+##### controller?
+
+`string`
+
+The controller of the identity who can make changes.
+
 #### Returns
 
 `Promise`\<`IDidProof`\>

package/docs/reference/interfaces/IIdentityConnector.md

@@ -142,16 +142,16 @@ The id of the service.
 
 ##### serviceType
 
-`string`
-
 The type of the service.
 
-##### serviceEndpoint
+`string` | `string`[]
 
-`string`
+##### serviceEndpoint
 
 The endpoint for the service.
 
+`string` | `string`[]
+
 #### Returns
 
 `Promise`\<`IDidService`\>
@@ -198,7 +198,7 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `revocationIndex`?): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -222,11 +222,11 @@ The id of the credential.
 
 `undefined` | `string`
 
-##### credential
+##### subject
 
 `IJsonLdNodeObject`
 
-The credential to store in the verifiable credential.
+The credential subject to store in the verifiable credential.
 
 ##### revocationIndex?
 
@@ -338,7 +338,7 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **createVerifiablePresentation**(`controller`, `verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
@@ -350,7 +350,7 @@ Create a verifiable presentation from the supplied verifiable credentials.
 
 The controller of the identity who can make changes.
 
-##### presentationMethodId
+##### verificationMethodId
 
 `string`
 

package/docs/reference/interfaces/IIdentityCreateRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityCreateRequest
+
+Request to create an identity.
+
+## Properties
+
+### body?
+
+> `optional` **body**: `object`
+
+The data for the request.
+
+#### namespace?
+
+> `optional` **namespace**: `string`
+
+The optional namespace to create the identity in.

package/docs/reference/interfaces/IIdentityCreateResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityCreateResponse
+
+Response to creating an identity.
+
+## Properties
+
+### body
+
+> **body**: `IDidDocument`
+
+The response payload.