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

package/docs/examples.md

@@ -1 +1,157 @@
-# @twin.org/identity-service-models - Examples
+# Identity Models Examples
+
+These examples focus on building and validating DID identifiers, extracting data from DID documents, and verifying signed materials.
+
+## DocumentHelper
+
+```typescript
+import { DocumentHelper } from '@twin.org/identity-models';
+
+const parsed = DocumentHelper.parseId('did:iota:tst:0x1234abcd#key-1');
+
+console.log(parsed.id); // did:iota:tst:0x1234abcd
+console.log(parsed.fragment); // key-1
+```
+
+```typescript
+import { DocumentHelper } from '@twin.org/identity-models';
+import { DidVerificationMethodType, type IDidDocument } from '@twin.org/standards-w3c-did';
+
+const didDocument: IDidDocument = {
+  id: 'did:iota:tst:0x1234abcd',
+  verificationMethod: [
+    {
+      id: 'did:iota:tst:0x1234abcd#key-1',
+      controller: 'did:iota:tst:0x1234abcd',
+      type: 'JsonWebKey',
+      publicKeyJwk: {
+        kty: 'OKP',
+        crv: 'Ed25519',
+        x: 'S4e4WQ9Hj1et0eS2e0_ExampleBase64Url'
+      }
+    }
+  ]
+};
+
+const fullVerificationMethodId = DocumentHelper.joinId(didDocument.id, 'key-1');
+const verificationMethod = DocumentHelper.getVerificationMethod(
+  didDocument,
+  fullVerificationMethodId,
+  DidVerificationMethodType.VerificationMethod
+);
+const publicJwk = DocumentHelper.getJwk(
+  didDocument,
+  fullVerificationMethodId,
+  DidVerificationMethodType.VerificationMethod
+);
+
+console.log(verificationMethod.id); // did:iota:tst:0x1234abcd#key-1
+console.log(publicJwk.crv); // Ed25519
+```
+
+## DidContextIdHandler
+
+```typescript
+import { DidContextIdHandler } from '@twin.org/identity-models';
+
+const contextIdHandler = new DidContextIdHandler();
+
+const className = contextIdHandler.className();
+const shortened = contextIdHandler.short('did:iota:tst:0x8f2f0d7a5c4b3a2f1e0d9c8b7a6f5e4d');
+contextIdHandler.guard('did:iota:tst:0x8f2f0d7a5c4b3a2f1e0d9c8b7a6f5e4d');
+
+console.log(className); // DidContextIdHandler
+console.log(shortened); // jy8NelxLOi8eDZyLem9eTQ
+```
+
+## Did
+
+```typescript
+import { Did } from '@twin.org/identity-models';
+
+const parsedDid = Did.parse('did:iota:tst:0x1234abcd');
+Did.guard('ExampleWorkflow', 'issuerDid', 'did:iota:tst:0x1234abcd');
+
+console.log(parsedDid.method); // iota
+console.log(parsedDid.network); // tst
+console.log(parsedDid.id); // 0x1234abcd
+```
+
+## VerificationHelper
+
+```typescript
+import { VerificationHelper, type IIdentityResolverComponent } from '@twin.org/identity-models';
+
+const resolver: IIdentityResolverComponent = {
+  className: () => 'IdentityResolverService',
+  identityResolve: async (identity: string) => ({
+    id: identity,
+    verificationMethod: [
+      {
+        id: `${identity}#signing-key`,
+        controller: identity,
+        type: 'JsonWebKey',
+        publicKeyJwk: {
+          kty: 'OKP',
+          crv: 'Ed25519',
+          x: 'S4e4WQ9Hj1et0eS2e0_ExampleBase64Url'
+        }
+      }
+    ]
+  })
+};
+
+const jwt =
+  'eyJraWQiOiJkaWQ6aW90YTp0c3Q6MHgxMjM0YWJjZCNzaWduaW5nLWtleSIsImlzcyI6ImRpZDppb3RhOnRzdDoweDEyMzRhYmNkIiwiYWxnIjoiRWREU0EiLCJ0eXAiOiJKV1QifQ.eyJzdWIiOiJhbGljZSJ9.Q2hhbmdlTWVXaXRoUmVhbFNpZ25hdHVyZQ';
+
+const jwtVerification = await VerificationHelper.verifyJwt(resolver, jwt);
+
+console.log(typeof jwtVerification.payload.sub); // string
+```
+
+```typescript
+import { VerificationHelper, type IIdentityResolverComponent } from '@twin.org/identity-models';
+import type { IJsonLdNodeObject } from '@twin.org/data-json-ld';
+
+const resolver: IIdentityResolverComponent = {
+  className: () => 'IdentityResolverService',
+  identityResolve: async (identity: string) => ({
+    id: identity,
+    verificationMethod: [
+      {
+        id: `${identity}#signing-key`,
+        controller: identity,
+        type: 'JsonWebKey',
+        publicKeyJwk: {
+          kty: 'OKP',
+          crv: 'Ed25519',
+          x: 'S4e4WQ9Hj1et0eS2e0_ExampleBase64Url'
+        }
+      }
+    ]
+  })
+};
+
+const verifiableCredential: IJsonLdNodeObject = {
+  '@context': ['https://www.w3.org/2018/credentials/v1'],
+  type: ['VerifiableCredential'],
+  issuer: 'did:iota:tst:0x1234abcd',
+  issuanceDate: '2026-03-10T00:00:00.000Z',
+  credentialSubject: {
+    id: 'did:iota:tst:0x5678efab',
+    role: 'Developer'
+  },
+  proof: {
+    type: 'DataIntegrityProof',
+    verificationMethod: 'did:iota:tst:0x1234abcd#signing-key',
+    cryptosuite: 'eddsa-jcs-2022',
+    created: '2026-03-10T00:00:00.000Z',
+    proofPurpose: 'assertionMethod',
+    proofValue: 'z4ExampleProofValue'
+  }
+};
+
+const verified = await VerificationHelper.verifyProof(resolver, verifiableCredential);
+
+console.log(verified); // true
+```

package/docs/reference/classes/Did.md

@@ -1,6 +1,6 @@
 # Class: Did
 
-Helper methods for Ids.
+Helper methods for parsing and validating DID identifiers.
 
 ## Constructors
 
@@ -14,7 +14,7 @@ Helper methods for Ids.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,11 +22,11 @@ Runtime name for the class.
 
 ## Methods
 
-### parse()
+### parse() {#parse}
 
 > `static` **parse**(`id`): `object`
 
-Parse and id in to it's constituent parts.
+Parse an id into its constituent parts.
 
 #### Parameters
 
@@ -48,7 +48,7 @@ The parsed id.
 
 ##### network?
 
-> `optional` **network**: `string`
+> `optional` **network?**: `string`
 
 ##### id
 
@@ -60,7 +60,7 @@ GeneralError if the id is not valid.
 
 ***
 
-### guard()
+### guard() {#guard}
 
 > `static` **guard**(`source`, `property`, `value`): `asserts value is string`
 
@@ -84,7 +84,7 @@ The name of the property.
 
 `unknown`
 
-The urn to parse.
+The value to assert as a valid DID.
 
 #### Returns
 

package/docs/reference/classes/DidContextIdHandler.md

@@ -1,6 +1,6 @@
 # Class: DidContextIdHandler
 
-Context Id handler for testing as a DID.
+Context ID handler that treats context identifiers as DIDs.
 
 ## Implements
 
@@ -18,7 +18,7 @@ Context Id handler for testing as a DID.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -26,7 +26,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -44,7 +44,7 @@ The class name.
 
 ***
 
-### short()
+### short() {#short}
 
 > **short**(`value`): `string`
 
@@ -70,11 +70,11 @@ Short form string.
 
 ***
 
-### guard()
+### guard() {#guard}
 
 > **guard**(`value`): `void`
 
-Guard the value ensuring length.
+Guard the value ensuring it is a valid DID.
 
 #### Parameters
 
@@ -90,7 +90,7 @@ The value to guard.
 
 #### Throws
 
-GeneralError if the value is too short.
+GeneralError if the value is not a valid DID.
 
 #### Implementation of
 

package/docs/reference/classes/DocumentHelper.md

@@ -14,7 +14,7 @@ Helper methods for documents.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,7 +22,7 @@ Runtime name for the class.
 
 ## Methods
 
-### parseId()
+### parseId() {#parseid}
 
 > `static` **parseId**(`documentId`): `object`
 
@@ -52,7 +52,7 @@ The parsed document id.
 
 ***
 
-### joinId()
+### joinId() {#joinid}
 
 > `static` **joinId**(`documentId`, `fragment?`): `string`
 
@@ -80,7 +80,7 @@ The full id.
 
 ***
 
-### getVerificationMethod()
+### getVerificationMethod() {#getverificationmethod}
 
 > `static` **getVerificationMethod**(`didDocument`, `methodName`, `methodType?`): `IDidDocumentVerificationMethod`
 
@@ -118,7 +118,7 @@ Error if the method is not found.
 
 ***
 
-### getJwk()
+### getJwk() {#getjwk}
 
 > `static` **getJwk**(`didDocument`, `methodName`, `methodType?`): `JWK`
 

package/docs/reference/classes/VerificationHelper.md

@@ -14,7 +14,7 @@ Helper methods for verification.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -22,11 +22,11 @@ Runtime name for the class.
 
 ## Methods
 
-### verifyJwt()
+### verifyJwt() {#verifyjwt}
 
 > `static` **verifyJwt**\<`T`, `U`\>(`resolver`, `jwt`): `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
-Verified the JWT.
+Verify the JWT and return the decoded header and payload.
 
 #### Type Parameters
 
@@ -56,15 +56,15 @@ The token to verify.
 
 `Promise`\<\{ `header`: `T`; `payload`: `U`; \}\>
 
-The decoded payload.
+The decoded header and payload.
 
 ***
 
-### verifyProof()
+### verifyProof() {#verifyproof}
 
 > `static` **verifyProof**(`resolver`, `secureDocument`): `Promise`\<`boolean`\>
 
-Verified the proof for the document e.g. verifiable credential.
+Verify the proof for the document.
 
 #### Parameters
 
@@ -84,4 +84,4 @@ The secure document to verify.
 
 `Promise`\<`boolean`\>
 
-True if the verification is successful.
+True if all proofs in the document are verified successfully.

package/docs/reference/index.md

@@ -15,6 +15,8 @@
 - [IIdentityProfileConnector](interfaces/IIdentityProfileConnector.md)
 - [IIdentityResolverComponent](interfaces/IIdentityResolverComponent.md)
 - [IIdentityResolverConnector](interfaces/IIdentityResolverConnector.md)
+- [IIdentityAlsoKnownAsCreateRequest](interfaces/IIdentityAlsoKnownAsCreateRequest.md)
+- [IIdentityAlsoKnownAsRemoveRequest](interfaces/IIdentityAlsoKnownAsRemoveRequest.md)
 - [IIdentityCreateRequest](interfaces/IIdentityCreateRequest.md)
 - [IIdentityCreateResponse](interfaces/IIdentityCreateResponse.md)
 - [IIdentityProofCreateRequest](interfaces/IIdentityProofCreateRequest.md)
@@ -29,10 +31,12 @@
 - [IIdentityVerifiableCredentialCreateResponse](interfaces/IIdentityVerifiableCredentialCreateResponse.md)
 - [IIdentityVerifiableCredentialRevokeRequest](interfaces/IIdentityVerifiableCredentialRevokeRequest.md)
 - [IIdentityVerifiableCredentialUnrevokeRequest](interfaces/IIdentityVerifiableCredentialUnrevokeRequest.md)
+- [IIdentityVerifiableCredentialVerifyDocumentRequest](interfaces/IIdentityVerifiableCredentialVerifyDocumentRequest.md)
 - [IIdentityVerifiableCredentialVerifyRequest](interfaces/IIdentityVerifiableCredentialVerifyRequest.md)
 - [IIdentityVerifiableCredentialVerifyResponse](interfaces/IIdentityVerifiableCredentialVerifyResponse.md)
 - [IIdentityVerifiablePresentationCreateRequest](interfaces/IIdentityVerifiablePresentationCreateRequest.md)
 - [IIdentityVerifiablePresentationCreateResponse](interfaces/IIdentityVerifiablePresentationCreateResponse.md)
+- [IIdentityVerifiablePresentationVerifyDocumentRequest](interfaces/IIdentityVerifiablePresentationVerifyDocumentRequest.md)
 - [IIdentityVerifiablePresentationVerifyRequest](interfaces/IIdentityVerifiablePresentationVerifyRequest.md)
 - [IIdentityVerifiablePresentationVerifyResponse](interfaces/IIdentityVerifiablePresentationVerifyResponse.md)
 - [IIdentityVerificationMethodCreateRequest](interfaces/IIdentityVerificationMethodCreateRequest.md)
@@ -49,8 +53,14 @@
 - [IIdentityResolveRequest](interfaces/IIdentityResolveRequest.md)
 - [IIdentityResolveResponse](interfaces/IIdentityResolveResponse.md)
 
+## Type Aliases
+
+- [IdentityMetricIds](type-aliases/IdentityMetricIds.md)
+
 ## Variables
 
 - [IdentityConnectorFactory](variables/IdentityConnectorFactory.md)
 - [IdentityProfileConnectorFactory](variables/IdentityProfileConnectorFactory.md)
 - [IdentityResolverConnectorFactory](variables/IdentityResolverConnectorFactory.md)
+- [IdentityMetricIds](variables/IdentityMetricIds.md)
+- [IdentityMetrics](variables/IdentityMetrics.md)

package/docs/reference/interfaces/IIdentityAlsoKnownAsCreateRequest.md

@@ -0,0 +1,31 @@
+# Interface: IIdentityAlsoKnownAsCreateRequest
+
+Request to create an alias for an identity.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to create the alias for.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The data for the request.
+
+#### alias
+
+> **alias**: `string`
+
+The alias to create for the identity.

package/docs/reference/interfaces/IIdentityAlsoKnownAsRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityAlsoKnownAsRemoveRequest
+
+Request to remove an alias from an identity.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to remove the alias from.
+
+#### alias
+
+> **alias**: `string`
+
+The alias to remove.