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

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

package/docs/reference/interfaces/IIdentityComponent.md

@@ -6,15 +6,103 @@ Interface describing a contract which provides identity operations.
 
 - `IComponent`
 
-## Indexable
+## Methods
 
-\[`key`: `string`\]: `any`
+### className()
 
-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.
+> **className**(): `string`
 
-## Methods
+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()
 

package/docs/reference/interfaces/IIdentityConnector.md

@@ -6,15 +6,103 @@ Interface describing an identity connector.
 
 - `IComponent`
 
-## Indexable
+## Methods
 
-\[`key`: `string`\]: `any`
+### className()
 
-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.
+> **className**(): `string`
 
-## Methods
+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()
 

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -16,15 +16,103 @@ Interface describing a contract which provides profile operations.
 
 `U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
-## Indexable
+## Methods
 
-\[`key`: `string`\]: `any`
+### className()
 
-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.
+> **className**(): `string`
 
-## Methods
+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()
 

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -16,15 +16,103 @@ Interface describing a contract which provides profile operations.
 
 `U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
-## Indexable
+## Methods
 
-\[`key`: `string`\]: `any`
+### className()
 
-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.
+> **className**(): `string`
 
-## Methods
+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()
 

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -6,15 +6,103 @@ Interface describing a contract which provides identity operations.
 
 - `IComponent`
 
-## Indexable
+## Methods
 
-\[`key`: `string`\]: `any`
+### className()
 
-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.
+> **className**(): `string`
 
-## Methods
+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()
 

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -6,15 +6,103 @@ Interface describing an identity connector.
 
 - `IComponent`
 
-## Indexable
+## Methods
 
-\[`key`: `string`\]: `any`
+### className()
 
-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.
+> **className**(): `string`
 
-## Methods
+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()
 

package/locales/en.json

@@ -8,8 +8,9 @@
 			"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"
+		"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'"
 		}
 	}
 }