@twin.org/identity-models 0.0.2-next.1 → 0.0.2-next.11

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -18,6 +18,102 @@ Interface describing a contract which provides profile operations.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Inherited from
+
+`IComponent.className`
+
+***
+
+### bootstrap()?
+
+> `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Inherited from
+
+`IComponent.bootstrap`
+
+***
+
+### start()?
+
+> `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.start`
+
+***
+
+### stop()?
+
+> `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.stop`
+
+***
+
 ### create()
 
 > **create**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
@@ -144,7 +240,7 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+> **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 
 Get a list of the requested identities.
 
@@ -180,7 +276,7 @@ The private properties to get for the profile, defaults to all.
 
 The cursor for paged requests.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/docs/reference/interfaces/IIdentityProfileListRequest.md

@@ -28,8 +28,8 @@ The public properties to get for the profile, defaults to all, should be a comma
 
 The cursor for paged requests.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
 Number of items to return.

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -8,6 +8,102 @@ Interface describing a contract which provides identity operations.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Inherited from
+
+`IComponent.className`
+
+***
+
+### bootstrap()?
+
+> `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Inherited from
+
+`IComponent.bootstrap`
+
+***
+
+### start()?
+
+> `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.start`
+
+***
+
+### stop()?
+
+> `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.stop`
+
+***
+
 ### identityResolve()
 
 > **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -8,6 +8,102 @@ Interface describing an identity connector.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Inherited from
+
+`IComponent.className`
+
+***
+
+### bootstrap()?
+
+> `optional` **bootstrap**(`nodeLoggingComponentType?`): `Promise`\<`boolean`\>
+
+Bootstrap the component by creating and initializing any resources it needs.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the bootstrapping process was successful.
+
+#### Inherited from
+
+`IComponent.bootstrap`
+
+***
+
+### start()?
+
+> `optional` **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be started when the node is initialized.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.start`
+
+***
+
+### stop()?
+
+> `optional` **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+The component needs to be stopped when the node is closed.
+
+#### Parameters
+
+##### nodeLoggingComponentType?
+
+`string`
+
+The node logging component type.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Inherited from
+
+`IComponent.stop`
+
+***
+
 ### resolveDocument()
 
 > **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateRequest.md

@@ -47,3 +47,9 @@ The credential subject to store in the verifiable credential.
 > `optional` **revocationIndex**: `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
+
+#### expirationDate?
+
+> `optional` **expirationDate**: `string`
+
+The date the verifiable credential is valid until.

package/locales/en.json

@@ -2,18 +2,15 @@
 	"error": {
 		"verificationHelper": {
 			"jwtDecodeFailed": "Decoding the JWT failed",
-			"proofTypeNotSupported": "The proof type \"{proofType}\" is not supported",
 			"proofMissingVerificationMethod": "The proof is missing the verification method"
 		},
 		"documentHelper": {
 			"verificationMethodNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" could not be found",
 			"verificationMethodJwkNotFound": "The verification method \"{methodName}\" of type \"{methodType}\" is missing the JWK"
+		},
+		"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'"
 		}
-	},
-	"verifiableCredentialStates": {
-		"pendingVerification": "Pending Verification",
-		"rejected": "Rejected",
-		"issued": "Issued",
-		"revoked": "Revoked"
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.11",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -13,7 +13,22 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"dev": "nodemon --watch src --ext ts --exec \"npm run build\"",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"test:build": "tspc -p ./tests/tsconfig.json --noEmit",
+		"validate-locales": "validate-locales",
+		"test:coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run validate-locales && npm run test:build && npm run test && npm run docs",
+		"dist:no-test": "npm run clean && npm run build && npm run test:build && npm run docs"
+	},
 	"dependencies": {
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
@@ -21,22 +36,52 @@
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@twin.org/nameof-vitest-plugin": "next",
+		"@twin.org/validate-locales": "next",
+		"@vitest/coverage-v8": "3.2.4",
+		"copyfiles": "2.4.1",
+		"nodemon": "3.1.10",
+		"rimraf": "6.0.1",
+		"ts-patch": "3.3.0",
+		"typedoc": "0.28.13",
+		"typedoc-plugin-markdown": "4.9.0",
+		"typescript": "5.9.3",
+		"vitest": "3.2.4"
+	},
+	"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"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"identity",
+		"did",
+		"credentials",
+		"authentication",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/identity/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,200 +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 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.IdentityConnectorFactory = IdentityConnectorFactory;
-exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
-exports.IdentityResolverConnectorFactory = IdentityResolverConnectorFactory;
-exports.VerificationHelper = VerificationHelper;