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

package/dist/cjs/index.cjs

@@ -118,6 +118,46 @@ class DocumentHelper {
     }
 }
 
+// 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.
 /**
@@ -194,6 +234,7 @@ class VerificationHelper {
 }
 
 exports.DocumentHelper = DocumentHelper;
+exports.IdHelper = IdHelper;
 exports.IdentityConnectorFactory = IdentityConnectorFactory;
 exports.IdentityProfileConnectorFactory = IdentityProfileConnectorFactory;
 exports.IdentityResolverConnectorFactory = IdentityResolverConnectorFactory;

package/dist/esm/index.mjs

@@ -1,4 +1,4 @@
-import { Factory, Is, GeneralError, Guards } from '@twin.org/core';
+import { Factory, Is, GeneralError, Urn, Guards } from '@twin.org/core';
 import { DidVerificationMethodType, ProofHelper } from '@twin.org/standards-w3c-did';
 import { Jwt, Jwk } from '@twin.org/web';
 
@@ -116,6 +116,46 @@ class DocumentHelper {
     }
 }
 
+// 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) {
+        Urn.guard(IdHelper.CLASS_NAME, "id", id);
+        const didUrn = Urn.fromValidString(id);
+        const didParts = didUrn.parts();
+        if (didParts[0] !== "did") {
+            throw new 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 GeneralError(IdHelper.CLASS_NAME, "invalidDocumentId", { id });
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -191,4 +231,4 @@ class VerificationHelper {
     }
 }
 
-export { DocumentHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityResolverConnectorFactory, VerificationHelper };
+export { DocumentHelper, IdHelper, IdentityConnectorFactory, IdentityProfileConnectorFactory, IdentityResolverConnectorFactory, VerificationHelper };

package/dist/types/index.d.ts

@@ -41,4 +41,5 @@ export * from "./models/IIdentityProfileConnector";
 export * from "./models/IIdentityResolverComponent";
 export * from "./models/IIdentityResolverConnector";
 export * from "./utils/documentHelper";
+export * from "./utils/idHelper";
 export * from "./utils/verificationHelper";

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

@@ -50,13 +50,13 @@ export interface IIdentityProfileComponent<T extends IJsonLdDocument = IJsonLdDo
      * @param publicFilters The filters to apply to the identities public profiles.
      * @param publicPropertyNames The public properties to get for the profile, defaults to all.
      * @param cursor The cursor for paged requests.
-     * @param pageSize The maximum number of items in a page.
+     * @param limit The maximum number of items in a page.
      * @returns The list of items and cursor for paging.
      */
     list(publicFilters?: {
         propertyName: string;
         propertyValue: unknown;
-    }[], publicPropertyNames?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+    }[], publicPropertyNames?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The identities.
          */

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

@@ -44,7 +44,7 @@ export interface IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDo
      * @param publicPropertyNames The public properties to get for the profile, defaults to all.
      * @param privatePropertyNames The private properties to get for the profile, defaults to all.
      * @param cursor The cursor for paged requests.
-     * @param pageSize The maximum number of items in a page.
+     * @param limit The maximum number of items in a page.
      * @returns The list of items and cursor for paging.
      */
     list(publicFilters?: {
@@ -53,7 +53,7 @@ export interface IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDo
     }[], privateFilters?: {
         propertyName: string;
         propertyValue: unknown;
-    }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, pageSize?: number): Promise<{
+    }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, limit?: number): Promise<{
         /**
          * The identity profiles.
          */

package/dist/types/models/api/profile/IIdentityProfileListRequest.d.ts

@@ -21,6 +21,6 @@ export interface IIdentityProfileListRequest {
         /**
          * Number of items to return.
          */
-        pageSize?: number | string;
+        limit?: string;
     };
 }

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

@@ -0,0 +1,20 @@
+/**
+ * Helper methods for Ids.
+ */
+export declare class IdHelper {
+    /**
+     * 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 parseId(id: string): {
+        method: string;
+        network?: string | undefined;
+        id: string;
+    };
+}

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/identity-service-models - Changelog
 
+## [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)
+
+
+### Features
+
+* add validate-locales ([04d74b4](https://github.com/twinfoundation/identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
+
+## [0.0.2-next.8](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.7...identity-models-v0.0.2-next.8) (2025-09-25)
+
+
+### Features
+
+* add idHelper class ([57c8bdb](https://github.com/twinfoundation/identity/commit/57c8bdb81efaa163b5e83f8a7f16f3764d12fd75))
+
 ## [0.0.2-next.7](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.6...identity-models-v0.0.2-next.7) (2025-09-23)
 
 

package/docs/reference/classes/IdHelper.md

@@ -0,0 +1,59 @@
+# Class: IdHelper
+
+Helper methods for Ids.
+
+## Constructors
+
+### Constructor
+
+> **new IdHelper**(): `IdHelper`
+
+#### Returns
+
+`IdHelper`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### parseId()
+
+> `static` **parseId**(`id`): `object`
+
+Parse and id in to it's constituent parts.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id to parse.
+
+#### Returns
+
+`object`
+
+The parsed id.
+
+##### method
+
+> **method**: `string`
+
+##### network?
+
+> `optional` **network**: `string`
+
+##### id
+
+> **id**: `string`
+
+#### Throws
+
+GeneralError if the id is not valid.

package/docs/reference/index.md

@@ -3,6 +3,7 @@
 ## Classes
 
 - [DocumentHelper](classes/DocumentHelper.md)
+- [IdHelper](classes/IdHelper.md)
 - [VerificationHelper](classes/VerificationHelper.md)
 
 ## Interfaces

package/docs/reference/interfaces/IIdentityComponent.md

@@ -6,6 +6,14 @@ 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()

package/docs/reference/interfaces/IIdentityConnector.md

@@ -6,6 +6,14 @@ 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()

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -16,6 +16,14 @@ 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()
@@ -172,7 +180,7 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+> **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 
 Get a list of the requested identities.
 
@@ -196,7 +204,7 @@ The public properties to get for the profile, defaults to all.
 
 The cursor for paged requests.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -16,6 +16,14 @@ 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()
@@ -144,7 +152,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 +188,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

@@ -6,6 +6,14 @@ 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,6 +6,14 @@ 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

@@ -2,18 +2,14 @@
 	"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"
+		},
+		"idHelper": {
+			"invalidDocumentId": "The document id \"{id}\" is invalid"
 		}
-	},
-	"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.7",
+	"version": "0.0.2-next.9",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -38,5 +38,23 @@
 		"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"
 }