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

package/docs/reference/classes/DidContextIdHandler.md

@@ -0,0 +1,79 @@
+# Class: DidContextIdHandler
+
+Context Id handler for testing as a DID.
+
+## Implements
+
+- `IContextIdHandler`
+
+## Constructors
+
+### Constructor
+
+> **new DidContextIdHandler**(): `DidContextIdHandler`
+
+#### Returns
+
+`DidContextIdHandler`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### short()
+
+> **short**(`value`): `string`
+
+Get the short form of the DID which is the last part.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The full context id value.
+
+#### Returns
+
+`string`
+
+Short form string.
+
+#### Implementation of
+
+`IContextIdHandler.short`
+
+***
+
+### guard()
+
+> **guard**(`value`): `void`
+
+Guard the value ensuring length.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to guard.
+
+#### Returns
+
+`void`
+
+#### Throws
+
+GeneralError if the value is too short.
+
+#### Implementation of
+
+`IContextIdHandler.guard`

package/docs/reference/classes/DocumentHelper.md

@@ -48,7 +48,7 @@ The parsed document id.
 
 ##### fragment
 
-> **fragment**: `undefined` \| `string`
+> **fragment**: `string` \| `undefined`
 
 ***
 
@@ -120,7 +120,7 @@ Error if the method is not found.
 
 ### getJwk()
 
-> `static` **getJwk**(`didDocument`, `methodName`, `methodType?`): `IJwk`
+> `static` **getJwk**(`didDocument`, `methodName`, `methodType?`): `JWK`
 
 Gets a JWK from a DID document verification method.
 
@@ -146,7 +146,7 @@ The type of the method, defaults to verificationMethod.
 
 #### Returns
 
-`IJwk`
+`JWK`
 
 The JWK if found.
 

package/docs/reference/classes/VerificationHelper.md

@@ -32,11 +32,11 @@ Verified the JWT.
 
 ##### T
 
-`T` *extends* `IJwtHeader`
+`T` *extends* `JWTHeaderParameters`
 
 ##### U
 
-`U` *extends* `IJwtPayload`
+`U` *extends* `JWTPayload`
 
 #### Parameters
 

package/docs/reference/index.md

@@ -2,8 +2,9 @@
 
 ## Classes
 
+- [DidContextIdHandler](classes/DidContextIdHandler.md)
+- [Did](classes/Did.md)
 - [DocumentHelper](classes/DocumentHelper.md)
-- [IdHelper](classes/IdHelper.md)
 - [VerificationHelper](classes/VerificationHelper.md)
 
 ## Interfaces

package/docs/reference/interfaces/IIdentityComponent.md

@@ -6,14 +6,6 @@ Interface describing a contract which provides identity operations.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### identityCreate()
@@ -256,7 +248,7 @@ The verification method id to use.
 
 The id of the credential.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### subject
 
@@ -406,19 +398,19 @@ The method to associate with the presentation.
 
 The id of the presentation.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### contexts
 
 The contexts for the data stored in the verifiable credential.
 
-`undefined` | `IJsonLdContextDefinitionRoot`
+`IJsonLdContextDefinitionRoot` | `undefined`
 
 ##### types
 
 The types for the data stored in the verifiable credential.
 
-`undefined` | `string` | `string`[]
+`string` | `string`[] | `undefined`
 
 ##### verifiableCredentials
 

package/docs/reference/interfaces/IIdentityConnector.md

@@ -6,14 +6,6 @@ Interface describing an identity connector.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### createDocument()
@@ -256,7 +248,7 @@ The verification method id to use.
 
 The id of the credential.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### subject
 
@@ -406,19 +398,19 @@ The method to associate with the presentation.
 
 The id of the presentation.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### contexts
 
 The contexts for the data stored in the verifiable credential.
 
-`undefined` | `IJsonLdContextDefinitionRoot`
+`IJsonLdContextDefinitionRoot` | `undefined`
 
 ##### types
 
 The types for the data stored in the verifiable credential.
 
-`undefined` | `string` | `string`[]
+`string` | `string`[] | `undefined`
 
 ##### verifiableCredentials
 

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -16,14 +16,6 @@ Interface describing a contract which provides profile operations.
 
 `U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### create()

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -16,14 +16,6 @@ Interface describing a contract which provides profile operations.
 
 `U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### create()

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -6,14 +6,6 @@ Interface describing a contract which provides identity operations.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### identityResolve()

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -6,14 +6,6 @@ Interface describing an identity connector.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### resolveDocument()

package/locales/en.json

@@ -8,8 +8,9 @@
 			"verificationMethodNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" could not be found",
 			"verificationMethodJwkNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" is missing the JWK"
 		},
-		"idHelper": {
-			"invalidDocumentId": "The document id \"{id}\" is invalid"
+		"guard": {
+			"didPartsTooFew": "The DID \"{value}\" is invalid: expected at least 3 parts but got fewer",
+			"didInvalidStart": "The DID \"{value}\" is invalid: expected to start with 'did'"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -14,6 +14,7 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
@@ -21,20 +22,18 @@
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,241 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var standardsW3cDid = require('@twin.org/standards-w3c-did');
-var web = require('@twin.org/web');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating identity connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const IdentityConnectorFactory = core.Factory.createFactory("identity-connector");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating identity profile connectors.
- */
-// 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.
-/**
- * Factory for creating identity resolver connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const IdentityResolverConnectorFactory = core.Factory.createFactory("identity-resolver-connector");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper methods for documents.
- */
-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 (!core.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 (!core.Is.stringValue(documentId)) {
-            return "";
-        }
-        let fullId = documentId;
-        if (core.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 ?? standardsW3cDid.DidVerificationMethodType.VerificationMethod]?.find(vm => core.Is.object(vm) && vm.id === methodName);
-        if (core.Is.object(verificationMethod)) {
-            return verificationMethod;
-        }
-        throw new core.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 (core.Is.object(verificationMethod) && core.Is.object(verificationMethod.publicKeyJwk)) {
-            return verificationMethod.publicKeyJwk;
-        }
-        throw new core.GeneralError(DocumentHelper.CLASS_NAME, "verificationMethodJwkNotFound", {
-            methodName,
-            methodType
-        });
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper methods for Ids.
- */
-class IdHelper {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "IdHelper";
-    /**
-     * 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 parseId(id) {
-        core.Urn.guard(IdHelper.CLASS_NAME, "id", id);
-        const didUrn = core.Urn.fromValidString(id);
-        const didParts = didUrn.parts();
-        if (didParts[0] !== "did") {
-            throw new core.GeneralError(IdHelper.CLASS_NAME, "invalidDocumentId", { id });
-        }
-        if (didParts.length === 3) {
-            return {
-                method: didParts[1],
-                id: didParts[2]
-            };
-        }
-        else if (didParts.length === 4) {
-            return {
-                method: didParts[1],
-                network: didParts[2],
-                id: didParts[3]
-            };
-        }
-        throw new core.GeneralError(IdHelper.CLASS_NAME, "invalidDocumentId", { id });
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Helper methods for verification.
- */
-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) {
-        core.Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
-        core.Guards.string(VerificationHelper.CLASS_NAME, "jwt", jwt);
-        const jwtDecoded = await web.Jwt.decode(jwt);
-        const jwtHeader = jwtDecoded.header;
-        const jwtPayload = jwtDecoded.payload;
-        const jwtSignature = jwtDecoded.signature;
-        if (!core.Is.object(jwtHeader) || !core.Is.object(jwtPayload) || !core.Is.uint8Array(jwtSignature)) {
-            throw new core.GeneralError(VerificationHelper.CLASS_NAME, "jwtDecodeFailed");
-        }
-        const iss = jwtHeader?.iss;
-        const kid = jwtHeader?.kid;
-        core.Guards.stringValue(VerificationHelper.CLASS_NAME, "iss", iss);
-        core.Guards.stringValue(VerificationHelper.CLASS_NAME, "kid", kid);
-        const didDocument = await resolver.identityResolve(iss);
-        const jwk = DocumentHelper.getJwk(didDocument, kid);
-        const publicKey = await web.Jwk.toCryptoKey(jwk);
-        return web.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) {
-        core.Guards.object(VerificationHelper.CLASS_NAME, "resolver", resolver);
-        core.Guards.object(VerificationHelper.CLASS_NAME, "secureDocument", secureDocument);
-        core.Guards.object(VerificationHelper.CLASS_NAME, "secureDocument.proof", secureDocument.proof);
-        const proofList = core.Is.array(secureDocument.proof)
-            ? secureDocument.proof
-            : [secureDocument.proof];
-        const documentCache = {};
-        for (const proof of proofList) {
-            if (!core.Is.stringValue(proof?.verificationMethod)) {
-                throw new core.GeneralError(VerificationHelper.CLASS_NAME, "proofMissingVerificationMethod");
-            }
-            const proofVerificationMethod = DocumentHelper.parseId(proof.verificationMethod);
-            if (!core.Is.stringValue(proofVerificationMethod.fragment)) {
-                throw new core.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 = await DocumentHelper.getJwk(document, proofVerificationMethod.id);
-            const verified = standardsW3cDid.ProofHelper.verifyProof(secureDocument, proof, verificationJwk);
-            if (!verified) {
-                return false;
-            }
-        }
-        return true;
-    }
-}
-
-exports.DocumentHelper = DocumentHelper;
-exports.IdHelper = IdHelper;
-exports.IdentityConnectorFactory = IdentityConnectorFactory;
-exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
-exports.IdentityResolverConnectorFactory = IdentityResolverConnectorFactory;
-exports.VerificationHelper = VerificationHelper;