@twin.org/identity-models 0.0.1-next.19 → 0.0.1-next.20

package/dist/cjs/index.cjs

@@ -1,6 +1,7 @@
 'use strict';
 
 var core = require('@twin.org/core');
+var web = require('@twin.org/web');
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -18,27 +19,6 @@ const IdentityConnectorFactory = core.Factory.createFactory("identity-connector"
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const IdentityProfileConnectorFactory = core.Factory.createFactory("identity-profile-connector");
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The roles that an identity can have.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const IdentityRole = {
-    /**
-     * Node.
-     */
-    Node: "node",
-    /**
-     * Organization.
-     */
-    Organization: "organization",
-    /**
-     * User.
-     */
-    User: "user"
-};
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -65,7 +45,45 @@ class DocumentHelper {
     }
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for JSON Web Tokens.
+ */
+class JwtHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "JwtHelper";
+    /**
+     * Parse the token and check that the properties are valid.
+     * @param jwt The token top validate.
+     * @param paramsToCheck Parameters to check they exist.
+     * @returns The token components.
+     * @throws Error if the token is invalid.
+     */
+    static async parse(jwt, paramsToCheck) {
+        const jwtDecoded = await web.Jwt.decode(jwt);
+        const jwtHeader = jwtDecoded.header;
+        const jwtPayload = jwtDecoded.payload;
+        const jwtSignature = jwtDecoded.signature;
+        if (core.Is.undefined(jwtHeader) || core.Is.undefined(jwtPayload) || core.Is.undefined(jwtSignature)) {
+            throw new core.GeneralError(JwtHelper.CLASS_NAME, "jwtDecodeFailed");
+        }
+        if (core.Is.arrayValue(paramsToCheck)) {
+            for (const param of paramsToCheck) {
+                if (!core.Is.stringValue(jwtPayload[param])) {
+                    throw new core.GeneralError(JwtHelper.CLASS_NAME, "jwtPayloadMissingParam", {
+                        param
+                    });
+                }
+            }
+        }
+        return jwtDecoded;
+    }
+}
+
 exports.DocumentHelper = DocumentHelper;
 exports.IdentityConnectorFactory = IdentityConnectorFactory;
 exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
-exports.IdentityRole = IdentityRole;
+exports.JwtHelper = JwtHelper;

package/dist/esm/index.mjs

@@ -1,4 +1,5 @@
-import { Factory, Is } from '@twin.org/core';
+import { Factory, Is, GeneralError } from '@twin.org/core';
+import { Jwt } from '@twin.org/web';
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
@@ -16,27 +17,6 @@ const IdentityConnectorFactory = Factory.createFactory("identity-connector");
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const IdentityProfileConnectorFactory = Factory.createFactory("identity-profile-connector");
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The roles that an identity can have.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const IdentityRole = {
-    /**
-     * Node.
-     */
-    Node: "node",
-    /**
-     * Organization.
-     */
-    Organization: "organization",
-    /**
-     * User.
-     */
-    User: "user"
-};
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -63,4 +43,42 @@ class DocumentHelper {
     }
 }
 
-export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityRole };
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Helper methods for JSON Web Tokens.
+ */
+class JwtHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "JwtHelper";
+    /**
+     * Parse the token and check that the properties are valid.
+     * @param jwt The token top validate.
+     * @param paramsToCheck Parameters to check they exist.
+     * @returns The token components.
+     * @throws Error if the token is invalid.
+     */
+    static async parse(jwt, paramsToCheck) {
+        const jwtDecoded = await Jwt.decode(jwt);
+        const jwtHeader = jwtDecoded.header;
+        const jwtPayload = jwtDecoded.payload;
+        const jwtSignature = jwtDecoded.signature;
+        if (Is.undefined(jwtHeader) || Is.undefined(jwtPayload) || Is.undefined(jwtSignature)) {
+            throw new GeneralError(JwtHelper.CLASS_NAME, "jwtDecodeFailed");
+        }
+        if (Is.arrayValue(paramsToCheck)) {
+            for (const param of paramsToCheck) {
+                if (!Is.stringValue(jwtPayload[param])) {
+                    throw new GeneralError(JwtHelper.CLASS_NAME, "jwtPayloadMissingParam", {
+                        param
+                    });
+                }
+            }
+        }
+        return jwtDecoded;
+    }
+}
+
+export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, JwtHelper };

package/dist/types/index.d.ts

@@ -1,18 +1,18 @@
 export * from "./factories/identityConnectorFactory";
 export * from "./factories/identityProfileConnectorFactory";
-export * from "./models/api/IIdentityProfileCreateRequest";
-export * from "./models/api/IIdentityProfileGetPublicRequest";
-export * from "./models/api/IIdentityProfileGetPublicResponse";
-export * from "./models/api/IIdentityProfileGetRequest";
-export * from "./models/api/IIdentityProfileGetResponse";
-export * from "./models/api/IIdentityProfileListRequest";
-export * from "./models/api/IIdentityProfileListResponse";
-export * from "./models/api/IIdentityProfileUpdateRequest";
-export * from "./models/api/IIdentityResolveRequest";
-export * from "./models/api/IIdentityResolveResponse";
-export * from "./models/identityRole";
+export * from "./models/api/identity/IIdentityResolveRequest";
+export * from "./models/api/identity/IIdentityResolveResponse";
+export * from "./models/api/profile/IIdentityProfileCreateRequest";
+export * from "./models/api/profile/IIdentityProfileGetPublicRequest";
+export * from "./models/api/profile/IIdentityProfileGetPublicResponse";
+export * from "./models/api/profile/IIdentityProfileGetRequest";
+export * from "./models/api/profile/IIdentityProfileGetResponse";
+export * from "./models/api/profile/IIdentityProfileListRequest";
+export * from "./models/api/profile/IIdentityProfileListResponse";
+export * from "./models/api/profile/IIdentityProfileUpdateRequest";
 export * from "./models/IIdentityComponent";
 export * from "./models/IIdentityConnector";
 export * from "./models/IIdentityProfileComponent";
 export * from "./models/IIdentityProfileConnector";
 export * from "./utils/documentHelper";
+export * from "./utils/jwtHelper";

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

@@ -1,13 +1,140 @@
 import type { IComponent } from "@twin.org/core";
-import type { IDidDocument } from "@twin.org/standards-w3c-did";
+import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing a contract which provides identity operations.
  */
 export interface IIdentityComponent extends IComponent {
+    /**
+     * Create a new identity.
+     * @param controller The controller of the identity who can make changes.
+     * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.
+     * @returns The created identity document.
+     */
+    identityCreate(controller: string, namespace?: string): Promise<IDidDocument>;
     /**
      * Resolve an identity.
-     * @param documentId The id of the document to resolve.
+     * @param identity The id of the document to resolve.
      * @returns The resolved document.
      */
-    resolve(documentId: string): Promise<IDidDocument>;
+    identityResolve(identity: string): Promise<IDidDocument>;
+    /**
+     * Add a verification method to the document in JSON Web key Format.
+     * @param controller The controller of the identity who can make changes.
+     * @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.
+     * @returns The verification method.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple keys.
+     */
+    verificationMethodCreate(controller: string, identity: string, verificationMethodType: DidVerificationMethodType, verificationMethodId?: string): Promise<IDidDocumentVerificationMethod>;
+    /**
+     * Remove a verification method from the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param verificationMethodId The id of the verification method.
+     * @returns Nothing.
+     * @throws NotFoundError if the id can not be resolved.
+     * @throws NotSupportedError if the platform does not support multiple revocable keys.
+     */
+    verificationMethodRemove(controller: string, verificationMethodId: string): Promise<void>;
+    /**
+     * Add a service to the document.
+     * @param controller The controller of the identity who can make changes.
+     * @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.
+     * @returns The service.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    serviceCreate(controller: string, identity: string, serviceId: string, serviceType: string, serviceEndpoint: string): Promise<IDidService>;
+    /**
+     * Remove a service from the document.
+     * @param controller The controller of the identity who can make changes.
+     * @param serviceId The id of the service.
+     * @returns Nothing.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    serviceRemove(controller: string, serviceId: string): Promise<void>;
+    /**
+     * Create a verifiable credential for a verification method.
+     * @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 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.
+     */
+    verifiableCredentialCreate(controller: string, verificationMethodId: string, id: string | undefined, credential: IJsonLdNodeObject, revocationIndex?: number): 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 controller The controller of the identity who can make changes.
+     * @param issuerId The id of the document to update the revocation list for.
+     * @param credentialIndex The revocation bitmap index revoke.
+     * @returns Nothing.
+     */
+    verifiableCredentialRevoke(controller: string, issuerId: string, credentialIndex: number): Promise<void>;
+    /**
+     * Unrevoke verifiable credential.
+     * @param controller The controller of the identity who can make changes.
+     * @param issuerId The id of the document to update the revocation list for.
+     * @param credentialIndex The revocation bitmap index to un revoke.
+     * @returns Nothing.
+     */
+    verifiableCredentialUnrevoke(controller: string, issuerId: string, credentialIndex: number): Promise<void>;
+    /**
+     * 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 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.
+     * @returns The created verifiable presentation and its token.
+     * @throws NotFoundError if the id can not be resolved.
+     */
+    verifiablePresentationCreate(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): 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 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.
+     */
+    proofCreate(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<IDidProof>;
+    /**
+     * Verify proof for arbitrary data with the specified verification method.
+     * @param bytes The data bytes to verify.
+     * @param proof The proof to verify.
+     * @returns True if the proof is verified.
+     */
+    proofVerify(bytes: Uint8Array, proof: IDidProof): Promise<boolean>;
 }

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

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

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

@@ -0,0 +1,22 @@
+import { type IJwtHeader, type IJwtPayload } from "@twin.org/web";
+/**
+ * Helper methods for JSON Web Tokens.
+ */
+export declare class JwtHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Parse the token and check that the properties are valid.
+     * @param jwt The token top validate.
+     * @param paramsToCheck Parameters to check they exist.
+     * @returns The token components.
+     * @throws Error if the token is invalid.
+     */
+    static parse<U extends IJwtHeader, T extends IJwtPayload>(jwt: string, paramsToCheck?: string[]): Promise<{
+        header?: U;
+        payload?: T;
+        signature?: Uint8Array;
+    }>;
+}

package/docs/changelog.md

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

package/docs/reference/classes/DocumentHelper.md

@@ -22,7 +22,9 @@ Parse the document id into its parts.
 
 #### Parameters
 
-• **documentId**: `string`
+##### documentId
+
+`string`
 
 The full document id.
 

package/docs/reference/classes/JwtHelper.md

@@ -0,0 +1,59 @@
+# Class: JwtHelper
+
+Helper methods for JSON Web Tokens.
+
+## Constructors
+
+### new JwtHelper()
+
+> **new JwtHelper**(): [`JwtHelper`](JwtHelper.md)
+
+#### Returns
+
+[`JwtHelper`](JwtHelper.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### parse()
+
+> `static` **parse**\<`U`, `T`\>(`jwt`, `paramsToCheck`?): `Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+
+Parse the token and check that the properties are valid.
+
+#### Type Parameters
+
+• **U** *extends* `IJwtHeader`
+
+• **T** *extends* `IJwtPayload`
+
+#### Parameters
+
+##### jwt
+
+`string`
+
+The token top validate.
+
+##### paramsToCheck?
+
+`string`[]
+
+Parameters to check they exist.
+
+#### Returns
+
+`Promise`\<\{ `header`: `U`; `payload`: `T`; `signature`: `Uint8Array`; \}\>
+
+The token components.
+
+#### Throws
+
+Error if the token is invalid.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [DocumentHelper](classes/DocumentHelper.md)
+- [JwtHelper](classes/JwtHelper.md)
 
 ## Interfaces
 
@@ -10,6 +11,8 @@
 - [IIdentityConnector](interfaces/IIdentityConnector.md)
 - [IIdentityProfileComponent](interfaces/IIdentityProfileComponent.md)
 - [IIdentityProfileConnector](interfaces/IIdentityProfileConnector.md)
+- [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
+- [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
 - [IIdentityProfileCreateRequest](interfaces/IIdentityProfileCreateRequest.md)
 - [IIdentityProfileGetPublicRequest](interfaces/IIdentityProfileGetPublicRequest.md)
 - [IIdentityProfileGetPublicResponse](interfaces/IIdentityProfileGetPublicResponse.md)
@@ -18,15 +21,8 @@
 - [IIdentityProfileListRequest](interfaces/IIdentityProfileListRequest.md)
 - [IIdentityProfileListResponse](interfaces/IIdentityProfileListResponse.md)
 - [IIdentityProfileUpdateRequest](interfaces/IIdentityProfileUpdateRequest.md)
-- [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
-- [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
-
-## Type Aliases
-
-- [IdentityRole](type-aliases/IdentityRole.md)
 
 ## Variables
 
 - [IdentityConnectorFactory](variables/IdentityConnectorFactory.md)
 - [IdentityProfileConnectorFactory](variables/IdentityProfileConnectorFactory.md)
-- [IdentityRole](variables/IdentityRole.md)