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

package/docs/changelog.md

@@ -1,5 +1,68 @@
 # @twin.org/identity-service-models - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.9...identity-models-v0.0.2-next.10) (2025-10-27)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
+## [0.0.2-next.6](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.5...identity-models-v0.0.2-next.6) (2025-09-23)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
+## [0.0.2-next.5](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.4...identity-models-v0.0.2-next.5) (2025-09-15)
+
+
+### Miscellaneous Chores
+
+* **identity-models:** Synchronize repo versions
+
+## [0.0.2-next.4](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.3...identity-models-v0.0.2-next.4) (2025-09-12)
+
+
+### Features
+
+* add expiration date option to vc creation ([73e05e1](https://github.com/twinfoundation/identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
+
+## [0.0.2-next.3](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.2...identity-models-v0.0.2-next.3) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([fd6246d](https://github.com/twinfoundation/identity/commit/fd6246d566280b6d5d10a108eb1e92c4b510f2f2))
+
+## [0.0.2-next.2](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.1...identity-models-v0.0.2-next.2) (2025-08-20)
+
+
+### Features
+
+* update framework core ([c824497](https://github.com/twinfoundation/identity/commit/c82449709af0215eb7af496cf687c93fb30b5ae0))
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.0...identity-models-v0.0.2-next.1) (2025-08-18)
 
 

package/docs/reference/classes/Did.md

@@ -0,0 +1,95 @@
+# Class: Did
+
+Helper methods for Ids.
+
+## Constructors
+
+### Constructor
+
+> **new Did**(): `Did`
+
+#### Returns
+
+`Did`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### parse()
+
+> `static` **parse**(`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.
+
+***
+
+### guard()
+
+> `static` **guard**(`source`, `property`, `value`): `asserts value is string`
+
+Guard a string as a DID.
+
+#### Parameters
+
+##### source
+
+`string`
+
+The source of the error.
+
+##### property
+
+`string`
+
+The name of the property.
+
+##### value
+
+`unknown`
+
+The urn to parse.
+
+#### Returns
+
+`asserts value is string`
+
+#### Throws
+
+GuardError If the value does not match the assertion.

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

@@ -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,6 +2,8 @@
 
 ## Classes
 
+- [DidContextIdHandler](classes/DidContextIdHandler.md)
+- [Did](classes/Did.md)
 - [DocumentHelper](classes/DocumentHelper.md)
 - [VerificationHelper](classes/VerificationHelper.md)
 

package/docs/reference/interfaces/IIdentityComponent.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`
+
+***
+
 ### identityCreate()
 
 > **identityCreate**(`namespace?`, `controller?`): `Promise`\<`IDidDocument`\>
@@ -232,7 +328,7 @@ NotFoundError if the id can not be resolved.
 
 ### verifiableCredentialCreate()
 
-> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `revocationIndex?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `options?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -256,12 +352,22 @@ The id of the credential.
 
 The credential subject to store in the verifiable credential.
 
-##### revocationIndex?
+##### options?
+
+Additional options for creating the verifiable credential.
+
+###### revocationIndex?
 
 `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
+###### expirationDate?
+
+`Date`
+
+The date the verifiable credential is valid until.
+
 ##### controller?
 
 `string`

package/docs/reference/interfaces/IIdentityConnector.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`
+
+***
+
 ### createDocument()
 
 > **createDocument**(`controller`): `Promise`\<`IDidDocument`\>
@@ -226,7 +322,7 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `revocationIndex?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `options?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -256,12 +352,22 @@ The id of the credential.
 
 The credential subject to store in the verifiable credential.
 
-##### revocationIndex?
+##### options?
+
+Additional options for creating the verifiable credential.
+
+###### revocationIndex?
 
 `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
+###### expirationDate?
+
+`Date`
+
+The date the verifiable credential is valid until.
+
 #### Returns
 
 `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>

package/docs/reference/interfaces/IIdentityProfileComponent.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**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
@@ -172,7 +268,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 +292,7 @@ The public properties to get for the profile, defaults to all.
 
 The cursor for paged requests.
 
-##### pageSize?
+##### limit?
 
 `number`