@twin.org/identity-models 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/models/api/profile/IIdentityProfileUpdateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IIdentityProfileUpdateRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/profile/IIdentityProfileUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\n\n/**\n * Request to update an identity profile.\n */\nexport interface IIdentityProfileUpdateRequest {\n\t/**\n\t * The data for the request.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The public profile data.\n\t\t */\n\t\tpublicProfile?: IJsonLdDocument;\n\n\t\t/**\n\t\t * The private profile data.\n\t\t */\n\t\tprivateProfile?: IJsonLdDocument;\n\t};\n}\n"]}

package/dist/es/models/api/resolver/IIdentityResolveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IIdentityResolveRequest.js.map

package/dist/es/models/api/resolver/IIdentityResolveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IIdentityResolveRequest.js","sourceRoot":"","sources":["../../../../../src/models/api/resolver/IIdentityResolveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Resolve an identity.\n */\nexport interface IIdentityResolveRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The identity to resolve.\n\t\t */\n\t\tidentity: string;\n\t};\n}\n"]}

package/dist/es/models/api/resolver/IIdentityResolveResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IIdentityResolveResponse.js.map

package/dist/es/models/api/resolver/IIdentityResolveResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IIdentityResolveResponse.js","sourceRoot":"","sources":["../../../../../src/models/api/resolver/IIdentityResolveResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IDidDocument } from \"@twin.org/standards-w3c-did\";\n\n/**\n * Response to resolving an identity.\n */\nexport interface IIdentityResolveResponse {\n\t/**\n\t * The response payload.\n\t */\n\tbody: IDidDocument;\n}\n"]}

package/dist/es/types/did.js

@@ -0,0 +1,53 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GuardError, Urn } from "@twin.org/core";
+/**
+ * Helper methods for Ids.
+ */
+export class Did {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "Did";
+    /**
+     * Parse and id in to it's constituent parts.
+     * @param id The id to parse.
+     * @returns The parsed id.
+     * @throws GeneralError if the id is not valid.
+     */
+    static parse(id) {
+        Did.guard(Did.CLASS_NAME, "id", id);
+        const didUrn = Urn.fromValidString(id);
+        const didParts = didUrn.parts();
+        if (didParts.length === 3) {
+            return {
+                method: didParts[1],
+                id: didParts[2]
+            };
+        }
+        return {
+            method: didParts[1],
+            network: didParts[2],
+            id: didParts[didParts.length - 1]
+        };
+    }
+    /**
+     * Guard a string as a DID.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The urn to parse.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static guard(source, property, value) {
+        Urn.guard(Did.CLASS_NAME, "value", value);
+        const urn = Urn.fromValidString(value);
+        const parts = urn.parts();
+        if (parts.length < 3) {
+            throw new GuardError(Did.CLASS_NAME, "guard.didPartsTooFew", "value", value);
+        }
+        if (parts[0] !== "did") {
+            throw new GuardError(Did.CLASS_NAME, "guard.didInvalidStart", "value", value);
+        }
+    }
+}
+//# sourceMappingURL=did.js.map

package/dist/es/types/did.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"did.js","sourceRoot":"","sources":["../../../src/types/did.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAGjD;;GAEG;AACH,MAAM,OAAO,GAAG;IACf;;OAEG;IACI,MAAM,CAAU,UAAU,SAAyB;IAE1D;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,EAAU;QAK7B,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE1C,MAAM,MAAM,GAAG,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC;QAEhC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO;gBACN,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;gBACnB,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAC;aACf,CAAC;QACH,CAAC;QACD,OAAO;YACN,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YACnB,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;YACpB,EAAE,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC;SACjC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,MAAc,EAAE,QAAgB,EAAE,KAAc;QACnE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAChD,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;QAE1B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,sBAAsB,WAAiB,KAAK,CAAC,CAAC;QACpF,CAAC;QAED,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YACxB,MAAM,IAAI,UAAU,CAAC,GAAG,CAAC,UAAU,EAAE,uBAAuB,WAAiB,KAAK,CAAC,CAAC;QACrF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GuardError, Urn } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Helper methods for Ids.\n */\nexport class Did {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<Did>();\n\n\t/**\n\t * Parse and id in to it's constituent parts.\n\t * @param id The id to parse.\n\t * @returns The parsed id.\n\t * @throws GeneralError if the id is not valid.\n\t */\n\tpublic static parse(id: string): {\n\t\tmethod: string;\n\t\tnetwork?: string | undefined;\n\t\tid: string;\n\t} {\n\t\tDid.guard(Did.CLASS_NAME, nameof(id), id);\n\n\t\tconst didUrn = Urn.fromValidString(id);\n\t\tconst didParts = didUrn.parts();\n\n\t\tif (didParts.length === 3) {\n\t\t\treturn {\n\t\t\t\tmethod: didParts[1],\n\t\t\t\tid: didParts[2]\n\t\t\t};\n\t\t}\n\t\treturn {\n\t\t\tmethod: didParts[1],\n\t\t\tnetwork: didParts[2],\n\t\t\tid: didParts[didParts.length - 1]\n\t\t};\n\t}\n\n\t/**\n\t * Guard a string as a DID.\n\t * @param source The source of the error.\n\t * @param property The name of the property.\n\t * @param value The urn to parse.\n\t * @throws GuardError If the value does not match the assertion.\n\t */\n\tpublic static guard(source: string, property: string, value: unknown): asserts value is string {\n\t\tUrn.guard(Did.CLASS_NAME, nameof(value), value);\n\t\tconst urn = Urn.fromValidString(value);\n\t\tconst parts = urn.parts();\n\n\t\tif (parts.length < 3) {\n\t\t\tthrow new GuardError(Did.CLASS_NAME, \"guard.didPartsTooFew\", nameof(value), value);\n\t\t}\n\n\t\tif (parts[0] !== \"did\") {\n\t\t\tthrow new GuardError(Did.CLASS_NAME, \"guard.didInvalidStart\", nameof(value), value);\n\t\t}\n\t}\n}\n"]}

package/dist/es/utils/documentHelper.js

@@ -0,0 +1,92 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Is } from "@twin.org/core";
+import { DidVerificationMethodType } from "@twin.org/standards-w3c-did";
+/**
+ * Helper methods for documents.
+ */
+export class DocumentHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "DocumentHelper";
+    /**
+     * Parse the document id into its parts.
+     * @param documentId The full document id.
+     * @returns The parsed document id.
+     */
+    static parseId(documentId) {
+        if (!Is.stringValue(documentId)) {
+            return {
+                id: "",
+                fragment: ""
+            };
+        }
+        const fragmentIndex = documentId.indexOf("#");
+        return {
+            id: fragmentIndex === -1 ? documentId : documentId.slice(0, fragmentIndex),
+            fragment: fragmentIndex === -1 ? undefined : documentId.slice(fragmentIndex + 1)
+        };
+    }
+    /**
+     * 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, fragment) {
+        if (!Is.stringValue(documentId)) {
+            return "";
+        }
+        let fullId = documentId;
+        if (Is.stringValue(fragment)) {
+            if (fragment.startsWith(documentId)) {
+                fragment = fragment.slice(documentId.length);
+            }
+            if (fragment.startsWith("#")) {
+                fullId += fragment;
+            }
+            else {
+                fullId += `#${fragment}`;
+            }
+        }
+        return fullId;
+    }
+    /**
+     * Get a verification method from a DID document.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The verification method if found.
+     * @throws Error if the method is not found.
+     */
+    static getVerificationMethod(didDocument, methodName, methodType) {
+        const verificationMethod = didDocument[methodType ?? DidVerificationMethodType.VerificationMethod]?.find(vm => Is.object(vm) && vm.id === methodName);
+        if (Is.object(verificationMethod)) {
+            return verificationMethod;
+        }
+        throw new GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodNotFound", {
+            methodName,
+            methodType
+        });
+    }
+    /**
+     * Gets a JWK from a DID document verification method.
+     * @param didDocument The DID Document to get the method from.
+     * @param methodName The name of the method to get the JWK from.
+     * @param methodType The type of the method, defaults to verificationMethod.
+     * @returns The JWK if found.
+     * @throws Error if the method is not found.
+     */
+    static getJwk(didDocument, methodName, methodType) {
+        const verificationMethod = DocumentHelper.getVerificationMethod(didDocument, methodName, methodType);
+        if (Is.object(verificationMethod) && Is.object(verificationMethod.publicKeyJwk)) {
+            return verificationMethod.publicKeyJwk;
+        }
+        throw new GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodJwkNotFound", {
+            methodName,
+            methodType
+        });
+    }
+}
+//# sourceMappingURL=documentHelper.js.map

package/dist/es/utils/documentHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"documentHelper.js","sourceRoot":"","sources":["../../../src/utils/documentHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAElD,OAAO,EACN,yBAAyB,EAGzB,MAAM,6BAA6B,CAAC;AAGrC;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;OAEG;IACI,MAAM,CAAU,UAAU,oBAAoC;IAErE;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,UAAkB;QAIvC,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO;gBACN,EAAE,EAAE,EAAE;gBACN,QAAQ,EAAE,EAAE;aACZ,CAAC;QACH,CAAC;QAED,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAE9C,OAAO;YACN,EAAE,EAAE,aAAa,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC;YAC1E,QAAQ,EAAE,aAAa,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,aAAa,GAAG,CAAC,CAAC;SAChF,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,UAAkB,EAAE,QAAiB;QACzD,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC;YACjC,OAAO,EAAE,CAAC;QACX,CAAC;QAED,IAAI,MAAM,GAAG,UAAU,CAAC;QAExB,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,IAAI,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBACrC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;YAC9C,CAAC;YACD,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,QAAQ,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACP,MAAM,IAAI,IAAI,QAAQ,EAAE,CAAC;YAC1B,CAAC;QACF,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAClC,WAAyB,EACzB,UAAkB,EAClB,UAAsC;QAEtC,MAAM,kBAAkB,GAAG,WAAW,CACrC,UAAU,IAAI,yBAAyB,CAAC,kBAAkB,CAC1D,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;QAErD,IAAI,EAAE,CAAC,MAAM,CAAiC,kBAAkB,CAAC,EAAE,CAAC;YACnE,OAAO,kBAAkB,CAAC;QAC3B,CAAC;QACD,MAAM,IAAI,YAAY,CAAC,cAAc,CAAC,UAAU,EAAE,4BAA4B,EAAE;YAC/E,UAAU;YACV,UAAU;SACV,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,MAAM,CACnB,WAAyB,EACzB,UAAkB,EAClB,UAAsC;QAEtC,MAAM,kBAAkB,GAAG,cAAc,CAAC,qBAAqB,CAC9D,WAAW,EACX,UAAU,EACV,UAAU,CACV,CAAC;QAEF,IAAI,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC;YACjF,OAAO,kBAAkB,CAAC,YAAY,CAAC;QACxC,CAAC;QAED,MAAM,IAAI,YAAY,CAAC,cAAc,CAAC,UAAU,EAAE,+BAA+B,EAAE;YAClF,UAAU;YACV,UAAU;SACV,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Is } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tDidVerificationMethodType,\n\ttype IDidDocumentVerificationMethod,\n\ttype IDidDocument\n} from \"@twin.org/standards-w3c-did\";\nimport type { IJwk } from \"@twin.org/web\";\n\n/**\n * Helper methods for documents.\n */\nexport class DocumentHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DocumentHelper>();\n\n\t/**\n\t * Parse the document id into its parts.\n\t * @param documentId The full document id.\n\t * @returns The parsed document id.\n\t */\n\tpublic static parseId(documentId: string): {\n\t\tid: string;\n\t\tfragment: string | undefined;\n\t} {\n\t\tif (!Is.stringValue(documentId)) {\n\t\t\treturn {\n\t\t\t\tid: \"\",\n\t\t\t\tfragment: \"\"\n\t\t\t};\n\t\t}\n\n\t\tconst fragmentIndex = documentId.indexOf(\"#\");\n\n\t\treturn {\n\t\t\tid: fragmentIndex === -1 ? documentId : documentId.slice(0, fragmentIndex),\n\t\t\tfragment: fragmentIndex === -1 ? undefined : documentId.slice(fragmentIndex + 1)\n\t\t};\n\t}\n\n\t/**\n\t * Join the document id parts.\n\t * @param documentId The document id.\n\t * @param fragment The fragment part for the identifier.\n\t * @returns The full id.\n\t */\n\tpublic static joinId(documentId: string, fragment?: string): string {\n\t\tif (!Is.stringValue(documentId)) {\n\t\t\treturn \"\";\n\t\t}\n\n\t\tlet fullId = documentId;\n\n\t\tif (Is.stringValue(fragment)) {\n\t\t\tif (fragment.startsWith(documentId)) {\n\t\t\t\tfragment = fragment.slice(documentId.length);\n\t\t\t}\n\t\t\tif (fragment.startsWith(\"#\")) {\n\t\t\t\tfullId += fragment;\n\t\t\t} else {\n\t\t\t\tfullId += `#${fragment}`;\n\t\t\t}\n\t\t}\n\n\t\treturn fullId;\n\t}\n\n\t/**\n\t * Get a verification method from a DID document.\n\t * @param didDocument The DID Document to get the method from.\n\t * @param methodName The name of the method to get the JWK from.\n\t * @param methodType The type of the method, defaults to verificationMethod.\n\t * @returns The verification method if found.\n\t * @throws Error if the method is not found.\n\t */\n\tpublic static getVerificationMethod(\n\t\tdidDocument: IDidDocument,\n\t\tmethodName: string,\n\t\tmethodType?: DidVerificationMethodType\n\t): IDidDocumentVerificationMethod {\n\t\tconst verificationMethod = didDocument[\n\t\t\tmethodType ?? DidVerificationMethodType.VerificationMethod\n\t\t]?.find(vm => Is.object(vm) && vm.id === methodName);\n\n\t\tif (Is.object<IDidDocumentVerificationMethod>(verificationMethod)) {\n\t\t\treturn verificationMethod;\n\t\t}\n\t\tthrow new GeneralError(DocumentHelper.CLASS_NAME, \"verificationMethodNotFound\", {\n\t\t\tmethodName,\n\t\t\tmethodType\n\t\t});\n\t}\n\n\t/**\n\t * Gets a JWK from a DID document verification method.\n\t * @param didDocument The DID Document to get the method from.\n\t * @param methodName The name of the method to get the JWK from.\n\t * @param methodType The type of the method, defaults to verificationMethod.\n\t * @returns The JWK if found.\n\t * @throws Error if the method is not found.\n\t */\n\tpublic static getJwk(\n\t\tdidDocument: IDidDocument,\n\t\tmethodName: string,\n\t\tmethodType?: DidVerificationMethodType\n\t): IJwk {\n\t\tconst verificationMethod = DocumentHelper.getVerificationMethod(\n\t\t\tdidDocument,\n\t\t\tmethodName,\n\t\t\tmethodType\n\t\t);\n\n\t\tif (Is.object(verificationMethod) && Is.object(verificationMethod.publicKeyJwk)) {\n\t\t\treturn verificationMethod.publicKeyJwk;\n\t\t}\n\n\t\tthrow new GeneralError(DocumentHelper.CLASS_NAME, \"verificationMethodJwkNotFound\", {\n\t\t\tmethodName,\n\t\t\tmethodType\n\t\t});\n\t}\n}\n"]}

package/dist/es/utils/verificationHelper.js

@@ -0,0 +1,79 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Guards, Is } from "@twin.org/core";
+import { ProofHelper } from "@twin.org/standards-w3c-did";
+import { Jwk, Jwt } from "@twin.org/web";
+import { DocumentHelper } from "./documentHelper.js";
+/**
+ * Helper methods for verification.
+ */
+export class VerificationHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "VerificationHelper";
+    /**
+     * Verified the JWT.
+     * @param resolver The resolver to use for finding the document.
+     * @param jwt The token to verify.
+     * @returns The decoded payload.
+     */
+    static async verifyJwt(resolver, jwt) {
+        Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
+        Guards.string(VerificationHelper.CLASS_NAME, "jwt", jwt);
+        const jwtDecoded = await Jwt.decode(jwt);
+        const jwtHeader = jwtDecoded.header;
+        const jwtPayload = jwtDecoded.payload;
+        const jwtSignature = jwtDecoded.signature;
+        if (!Is.object(jwtHeader) || !Is.object(jwtPayload) || !Is.uint8Array(jwtSignature)) {
+            throw new GeneralError(VerificationHelper.CLASS_NAME, "jwtDecodeFailed");
+        }
+        const iss = jwtHeader?.iss;
+        const kid = jwtHeader?.kid;
+        Guards.stringValue(VerificationHelper.CLASS_NAME, "iss", iss);
+        Guards.stringValue(VerificationHelper.CLASS_NAME, "kid", kid);
+        const didDocument = await resolver.identityResolve(iss);
+        const jwk = DocumentHelper.getJwk(didDocument, kid);
+        const publicKey = await Jwk.toCryptoKey(jwk);
+        return Jwt.verify(jwt, publicKey);
+    }
+    /**
+     * Verified the proof for the document e.g. verifiable credential.
+     * @param resolver The resolver to use for finding the document.
+     * @param secureDocument The secure document to verify.
+     * @returns True if the verification is successful.
+     */
+    static async verifyProof(resolver, secureDocument) {
+        Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
+        Guards.object(VerificationHelper.CLASS_NAME, "secureDocument", secureDocument);
+        Guards.object(VerificationHelper.CLASS_NAME, "secureDocument.proof", secureDocument.proof);
+        const proofList = Is.array(secureDocument.proof)
+            ? secureDocument.proof
+            : [secureDocument.proof];
+        const documentCache = {};
+        for (const proof of proofList) {
+            if (!Is.stringValue(proof?.verificationMethod)) {
+                throw new GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
+            }
+            const proofVerificationMethod = DocumentHelper.parseId(proof.verificationMethod);
+            if (!Is.stringValue(proofVerificationMethod.fragment)) {
+                throw new GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
+            }
+            let document;
+            if (documentCache[proofVerificationMethod.id]) {
+                document = documentCache[proofVerificationMethod.id];
+            }
+            else {
+                document = await resolver.identityResolve(proofVerificationMethod.id);
+                documentCache[proofVerificationMethod.id] = document;
+            }
+            const verificationJwk = DocumentHelper.getJwk(document, proofVerificationMethod.id);
+            const verified = await ProofHelper.verifyProof(secureDocument, proof, verificationJwk);
+            if (!verified) {
+                return false;
+            }
+        }
+        return true;
+    }
+}
+//# sourceMappingURL=verificationHelper.js.map

package/dist/es/utils/verificationHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verificationHelper.js","sourceRoot":"","sources":["../../../src/utils/verificationHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAG1D,OAAO,EAAE,WAAW,EAAkC,MAAM,6BAA6B,CAAC;AAC1F,OAAO,EAAE,GAAG,EAAE,GAAG,EAAqC,MAAM,eAAe,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,SAAS,CAC5B,QAAoC,EACpC,GAAW;QAKX,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,cAE7B,QAAQ,CACR,CAAC;QACF,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAE/D,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,MAAM,CAAO,GAAG,CAAC,CAAC;QAE/C,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC;QACpC,MAAM,UAAU,GAAG,UAAU,CAAC,OAAO,CAAC;QACtC,MAAM,YAAY,GAAG,UAAU,CAAC,SAAS,CAAC;QAE1C,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YACrF,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,GAAG,GAAG,SAAS,EAAE,GAAG,CAAC;QAC3B,MAAM,GAAG,GAAG,SAAS,EAAE,GAAG,CAAC;QAE3B,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QACpE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,SAAe,GAAG,CAAC,CAAC;QAEpE,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAExD,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;QAEpD,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAE7C,OAAO,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAC9B,QAAoC,EACpC,cAAiC;QAEjC,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,cAE7B,QAAQ,CACR,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,oBAE7B,cAAc,CACd,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,0BAE7B,cAAc,CAAC,KAAK,CACpB,CAAC;QAEF,MAAM,SAAS,GAAG,EAAE,CAAC,KAAK,CAAS,cAAc,CAAC,KAAK,CAAC;YACvD,CAAC,CAAC,cAAc,CAAC,KAAK;YACtB,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE1B,MAAM,aAAa,GAAoC,EAAE,CAAC;QAE1D,KAAK,MAAM,KAAK,IAAI,SAAqB,EAAE,CAAC;YAC3C,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,kBAAkB,CAAC,EAAE,CAAC;gBAChD,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,UAAU,EAAE,gCAAgC,CAAC,CAAC;YACzF,CAAC;YAED,MAAM,uBAAuB,GAAG,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACjF,IAAI,CAAC,EAAE,CAAC,WAAW,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACvD,MAAM,IAAI,YAAY,CAAC,kBAAkB,CAAC,UAAU,EAAE,gCAAgC,CAAC,CAAC;YACzF,CAAC;YAED,IAAI,QAAsB,CAAC;YAE3B,IAAI,aAAa,CAAC,uBAAuB,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC/C,QAAQ,GAAG,aAAa,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;YACtD,CAAC;iBAAM,CAAC;gBACP,QAAQ,GAAG,MAAM,QAAQ,CAAC,eAAe,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;gBACtE,aAAa,CAAC,uBAAuB,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC;YACtD,CAAC;YAED,MAAM,eAAe,GAAG,cAAc,CAAC,MAAM,CAAC,QAAQ,EAAE,uBAAuB,CAAC,EAAE,CAAC,CAAC;YAEpF,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,cAAc,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;YAEvF,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACf,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;QACD,OAAO,IAAI,CAAC;IACb,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { ProofHelper, type IDidDocument, type IProof } from \"@twin.org/standards-w3c-did\";\nimport { Jwk, Jwt, type IJwtHeader, type IJwtPayload } from \"@twin.org/web\";\nimport { DocumentHelper } from \"./documentHelper.js\";\nimport type { IIdentityResolverComponent } from \"../models/IIdentityResolverComponent.js\";\n\n/**\n * Helper methods for verification.\n */\nexport class VerificationHelper {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<VerificationHelper>();\n\n\t/**\n\t * Verified the JWT.\n\t * @param resolver The resolver to use for finding the document.\n\t * @param jwt The token to verify.\n\t * @returns The decoded payload.\n\t */\n\tpublic static async verifyJwt<T extends IJwtHeader, U extends IJwtPayload>(\n\t\tresolver: IIdentityResolverComponent,\n\t\tjwt: string\n\t): Promise<{\n\t\theader: T;\n\t\tpayload: U;\n\t}> {\n\t\tGuards.object<IIdentityResolverComponent>(\n\t\t\tVerificationHelper.CLASS_NAME,\n\t\t\tnameof(resolver),\n\t\t\tresolver\n\t\t);\n\t\tGuards.string(VerificationHelper.CLASS_NAME, nameof(jwt), jwt);\n\n\t\tconst jwtDecoded = await Jwt.decode<T, U>(jwt);\n\n\t\tconst jwtHeader = jwtDecoded.header;\n\t\tconst jwtPayload = jwtDecoded.payload;\n\t\tconst jwtSignature = jwtDecoded.signature;\n\n\t\tif (!Is.object(jwtHeader) || !Is.object(jwtPayload) || !Is.uint8Array(jwtSignature)) {\n\t\t\tthrow new GeneralError(VerificationHelper.CLASS_NAME, \"jwtDecodeFailed\");\n\t\t}\n\n\t\tconst iss = jwtHeader?.iss;\n\t\tconst kid = jwtHeader?.kid;\n\n\t\tGuards.stringValue(VerificationHelper.CLASS_NAME, nameof(iss), iss);\n\t\tGuards.stringValue(VerificationHelper.CLASS_NAME, nameof(kid), kid);\n\n\t\tconst didDocument = await resolver.identityResolve(iss);\n\n\t\tconst jwk = DocumentHelper.getJwk(didDocument, kid);\n\n\t\tconst publicKey = await Jwk.toCryptoKey(jwk);\n\n\t\treturn Jwt.verify(jwt, publicKey);\n\t}\n\n\t/**\n\t * Verified the proof for the document e.g. verifiable credential.\n\t * @param resolver The resolver to use for finding the document.\n\t * @param secureDocument The secure document to verify.\n\t * @returns True if the verification is successful.\n\t */\n\tpublic static async verifyProof(\n\t\tresolver: IIdentityResolverComponent,\n\t\tsecureDocument: IJsonLdNodeObject\n\t): Promise<boolean> {\n\t\tGuards.object<IIdentityResolverComponent>(\n\t\t\tVerificationHelper.CLASS_NAME,\n\t\t\tnameof(resolver),\n\t\t\tresolver\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tVerificationHelper.CLASS_NAME,\n\t\t\tnameof(secureDocument),\n\t\t\tsecureDocument\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tVerificationHelper.CLASS_NAME,\n\t\t\tnameof(secureDocument.proof),\n\t\t\tsecureDocument.proof\n\t\t);\n\n\t\tconst proofList = Is.array<IProof>(secureDocument.proof)\n\t\t\t? secureDocument.proof\n\t\t\t: [secureDocument.proof];\n\n\t\tconst documentCache: { [key: string]: IDidDocument } = {};\n\n\t\tfor (const proof of proofList as IProof[]) {\n\t\t\tif (!Is.stringValue(proof?.verificationMethod)) {\n\t\t\t\tthrow new GeneralError(VerificationHelper.CLASS_NAME, \"proofMissingVerificationMethod\");\n\t\t\t}\n\n\t\t\tconst proofVerificationMethod = DocumentHelper.parseId(proof.verificationMethod);\n\t\t\tif (!Is.stringValue(proofVerificationMethod.fragment)) {\n\t\t\t\tthrow new GeneralError(VerificationHelper.CLASS_NAME, \"proofMissingVerificationMethod\");\n\t\t\t}\n\n\t\t\tlet document: IDidDocument;\n\n\t\t\tif (documentCache[proofVerificationMethod.id]) {\n\t\t\t\tdocument = documentCache[proofVerificationMethod.id];\n\t\t\t} else {\n\t\t\t\tdocument = await resolver.identityResolve(proofVerificationMethod.id);\n\t\t\t\tdocumentCache[proofVerificationMethod.id] = document;\n\t\t\t}\n\n\t\t\tconst verificationJwk = DocumentHelper.getJwk(document, proofVerificationMethod.id);\n\n\t\t\tconst verified = await ProofHelper.verifyProof(secureDocument, proof, verificationJwk);\n\n\t\t\tif (!verified) {\n\t\t\t\treturn false;\n\t\t\t}\n\t\t}\n\t\treturn true;\n\t}\n}\n"]}

package/dist/types/contextIdHandlers/didContextIdHandler.d.ts

@@ -0,0 +1,22 @@
+import type { IContextIdHandler } from "@twin.org/context";
+/**
+ * Context Id handler for testing as a DID.
+ */
+export declare class DidContextIdHandler implements IContextIdHandler {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Get the short form of the DID which is the last part.
+     * @param value The full context id value.
+     * @returns Short form string.
+     */
+    short(value: string): string;
+    /**
+     * Guard the value ensuring length.
+     * @param value The value to guard.
+     * @throws GeneralError if the value is too short.
+     */
+    guard(value: string): void;
+}

package/dist/types/factories/identityConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IIdentityConnector } from "../models/IIdentityConnector";
+import type { IIdentityConnector } from "../models/IIdentityConnector.js";
 /**
  * Factory for creating identity connectors.
  */

package/dist/types/factories/identityProfileConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IIdentityProfileConnector } from "../models/IIdentityProfileConnector";
+import type { IIdentityProfileConnector } from "../models/IIdentityProfileConnector.js";
 /**
  * Factory for creating identity profile connectors.
  */

package/dist/types/factories/identityResolverConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IIdentityResolverConnector } from "../models/IIdentityResolverConnector";
+import type { IIdentityResolverConnector } from "../models/IIdentityResolverConnector.js";
 /**
  * Factory for creating identity resolver connectors.
  */

package/dist/types/index.d.ts

@@ -1,45 +1,46 @@
-export * from "./factories/identityConnectorFactory";
-export * from "./factories/identityProfileConnectorFactory";
-export * from "./factories/identityResolverConnectorFactory";
-export * from "./models/api/identity/IIdentityCreateRequest";
-export * from "./models/api/identity/IIdentityCreateResponse";
-export * from "./models/api/identity/IIdentityProofCreateRequest";
-export * from "./models/api/identity/IIdentityProofCreateResponse";
-export * from "./models/api/identity/IIdentityProofVerifyRequest";
-export * from "./models/api/identity/IIdentityProofVerifyResponse";
-export * from "./models/api/identity/IIdentityRemoveRequest";
-export * from "./models/api/identity/IIdentityServiceCreateRequest";
-export * from "./models/api/identity/IIdentityServiceCreateResponse";
-export * from "./models/api/identity/IIdentityServiceRemoveRequest";
-export * from "./models/api/identity/IIdentityVerifiableCredentialCreateRequest";
-export * from "./models/api/identity/IIdentityVerifiableCredentialCreateResponse";
-export * from "./models/api/identity/IIdentityVerifiableCredentialRevokeRequest";
-export * from "./models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest";
-export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyRequest";
-export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyResponse";
-export * from "./models/api/identity/IIdentityVerifiablePresentationCreateRequest";
-export * from "./models/api/identity/IIdentityVerifiablePresentationCreateResponse";
-export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyRequest";
-export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyResponse";
-export * from "./models/api/identity/IIdentityVerificationMethodCreateRequest";
-export * from "./models/api/identity/IIdentityVerificationMethodCreateResponse";
-export * from "./models/api/identity/IIdentityVerificationMethodRemoveRequest";
-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/api/resolver/IIdentityResolveRequest";
-export * from "./models/api/resolver/IIdentityResolveResponse";
-export * from "./models/IIdentityComponent";
-export * from "./models/IIdentityConnector";
-export * from "./models/IIdentityProfileComponent";
-export * from "./models/IIdentityProfileConnector";
-export * from "./models/IIdentityResolverComponent";
-export * from "./models/IIdentityResolverConnector";
-export * from "./utils/documentHelper";
-export * from "./utils/idHelper";
-export * from "./utils/verificationHelper";
+export * from "./contextIdHandlers/didContextIdHandler.js";
+export * from "./factories/identityConnectorFactory.js";
+export * from "./factories/identityProfileConnectorFactory.js";
+export * from "./factories/identityResolverConnectorFactory.js";
+export * from "./models/api/identity/IIdentityCreateRequest.js";
+export * from "./models/api/identity/IIdentityCreateResponse.js";
+export * from "./models/api/identity/IIdentityProofCreateRequest.js";
+export * from "./models/api/identity/IIdentityProofCreateResponse.js";
+export * from "./models/api/identity/IIdentityProofVerifyRequest.js";
+export * from "./models/api/identity/IIdentityProofVerifyResponse.js";
+export * from "./models/api/identity/IIdentityRemoveRequest.js";
+export * from "./models/api/identity/IIdentityServiceCreateRequest.js";
+export * from "./models/api/identity/IIdentityServiceCreateResponse.js";
+export * from "./models/api/identity/IIdentityServiceRemoveRequest.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialCreateRequest.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialCreateResponse.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialRevokeRequest.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialUnrevokeRequest.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyRequest.js";
+export * from "./models/api/identity/IIdentityVerifiableCredentialVerifyResponse.js";
+export * from "./models/api/identity/IIdentityVerifiablePresentationCreateRequest.js";
+export * from "./models/api/identity/IIdentityVerifiablePresentationCreateResponse.js";
+export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyRequest.js";
+export * from "./models/api/identity/IIdentityVerifiablePresentationVerifyResponse.js";
+export * from "./models/api/identity/IIdentityVerificationMethodCreateRequest.js";
+export * from "./models/api/identity/IIdentityVerificationMethodCreateResponse.js";
+export * from "./models/api/identity/IIdentityVerificationMethodRemoveRequest.js";
+export * from "./models/api/profile/IIdentityProfileCreateRequest.js";
+export * from "./models/api/profile/IIdentityProfileGetPublicRequest.js";
+export * from "./models/api/profile/IIdentityProfileGetPublicResponse.js";
+export * from "./models/api/profile/IIdentityProfileGetRequest.js";
+export * from "./models/api/profile/IIdentityProfileGetResponse.js";
+export * from "./models/api/profile/IIdentityProfileListRequest.js";
+export * from "./models/api/profile/IIdentityProfileListResponse.js";
+export * from "./models/api/profile/IIdentityProfileUpdateRequest.js";
+export * from "./models/api/resolver/IIdentityResolveRequest.js";
+export * from "./models/api/resolver/IIdentityResolveResponse.js";
+export * from "./models/IIdentityComponent.js";
+export * from "./models/IIdentityConnector.js";
+export * from "./models/IIdentityProfileComponent.js";
+export * from "./models/IIdentityProfileConnector.js";
+export * from "./models/IIdentityResolverComponent.js";
+export * from "./models/IIdentityResolverConnector.js";
+export * from "./types/did.js";
+export * from "./utils/documentHelper.js";
+export * from "./utils/verificationHelper.js";

package/dist/types/types/did.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Helper methods for Ids.
+ */
+export declare class Did {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Parse and id in to it's constituent parts.
+     * @param id The id to parse.
+     * @returns The parsed id.
+     * @throws GeneralError if the id is not valid.
+     */
+    static parse(id: string): {
+        method: string;
+        network?: string | undefined;
+        id: string;
+    };
+    /**
+     * Guard a string as a DID.
+     * @param source The source of the error.
+     * @param property The name of the property.
+     * @param value The urn to parse.
+     * @throws GuardError If the value does not match the assertion.
+     */
+    static guard(source: string, property: string, value: unknown): asserts value is string;
+}

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

@@ -1,6 +1,6 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IJwtHeader, type IJwtPayload } from "@twin.org/web";
-import type { IIdentityResolverComponent } from "../models/IIdentityResolverComponent";
+import type { IIdentityResolverComponent } from "../models/IIdentityResolverComponent.js";
 /**
  * Helper methods for verification.
  */

package/docs/changelog.md

@@ -1,5 +1,42 @@
 # @twin.org/identity-service-models - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.3-next.1...identity-models-v0.0.3-next.2) (2025-11-14)
+
+
+### Bug Fixes
+
+* use base64Url for tenant id short form so it doesn't include slash ([53b9e27](https://github.com/twinfoundation/identity/commit/53b9e27351f20e2689734581c252a23527657926))
+
+## [0.0.3-next.1](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.3-next.0...identity-models-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add context id features ([#62](https://github.com/twinfoundation/identity/issues/62)) ([e02ecca](https://github.com/twinfoundation/identity/commit/e02ecca9c45a849104bfbf7bc18a1f44e6eea8a1))
+* add expiration date option to vc creation ([73e05e1](https://github.com/twinfoundation/identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
+* add identity remove ([eebc13f](https://github.com/twinfoundation/identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
+* add idHelper class ([57c8bdb](https://github.com/twinfoundation/identity/commit/57c8bdb81efaa163b5e83f8a7f16f3764d12fd75))
+* add validate-locales ([04d74b4](https://github.com/twinfoundation/identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
+* eslint migration to flat config ([fd6246d](https://github.com/twinfoundation/identity/commit/fd6246d566280b6d5d10a108eb1e92c4b510f2f2))
+* identity key separator use slash ([1319d0d](https://github.com/twinfoundation/identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
+* update framework core ([c824497](https://github.com/twinfoundation/identity/commit/c82449709af0215eb7af496cf687c93fb30b5ae0))
+* use shared store mechanism ([#27](https://github.com/twinfoundation/identity/issues/27)) ([ce41f3f](https://github.com/twinfoundation/identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
+
+
+### Bug Fixes
+
+* Import path and bump version ([#21](https://github.com/twinfoundation/identity/issues/21)) ([ccea845](https://github.com/twinfoundation/identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
+* Install sdk-wasm ([#20](https://github.com/twinfoundation/identity/issues/20)) ([75ec14e](https://github.com/twinfoundation/identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
+* query params force coercion ([d9347d2](https://github.com/twinfoundation/identity/commit/d9347d29d4a9cc58759f30f5d8526de864ea7522))
+* Use resolver component ([#22](https://github.com/twinfoundation/identity/issues/22)) ([d0b3a32](https://github.com/twinfoundation/identity/commit/d0b3a321c7f9f966d397a880d752e9f2c0a98a27))
+
+## [0.0.2-next.10](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.9...identity-models-v0.0.2-next.10) (2025-10-27)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.8...identity-models-v0.0.2-next.9) (2025-10-09)
 
 

package/docs/reference/classes/{IdHelper.md → Did.md}

@@ -1,4 +1,4 @@
-# Class: IdHelper
+# Class: Did
 
 Helper methods for Ids.
 
@@ -6,11 +6,11 @@ Helper methods for Ids.
 
 ### Constructor
 
-> **new IdHelper**(): `IdHelper`
+> **new Did**(): `Did`
 
 #### Returns
 
-`IdHelper`
+`Did`
 
 ## Properties
 
@@ -22,9 +22,9 @@ Runtime name for the class.
 
 ## Methods
 
-### parseId()
+### parse()
 
-> `static` **parseId**(`id`): `object`
+> `static` **parse**(`id`): `object`
 
 Parse and id in to it's constituent parts.
 
@@ -57,3 +57,39 @@ The parsed id.
 #### Throws
 
 GeneralError if the id is not valid.
+
+***
+
+### guard()
+
+> `static` **guard**(`source`, `property`, `value`): `asserts value is string`
+
+Guard a string as a DID.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The urn to parse.
+
+#### Returns
+
+`asserts value is string`
+
+#### Throws
+
+GuardError If the value does not match the assertion.