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

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/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,12 @@
 # @twin.org/identity-service-models - Changelog
 
+## [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/locales/en.json

@@ -8,6 +8,9 @@
 		"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": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.2-next.7",
+	"version": "0.0.2-next.8",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",