@twin.org/identity-models 0.0.1-next.41 → 0.0.1-next.42

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/identity-service-models - Changelog
 
+## [0.0.1-next.42](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.41...identity-models-v0.0.1-next.42) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#27](https://github.com/twinfoundation/identity/issues/27)) ([ce41f3f](https://github.com/twinfoundation/identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
+
 ## [0.0.1-next.41](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.1-next.40...identity-models-v0.0.1-next.41) (2025-04-09)
 
 

package/docs/reference/classes/DocumentHelper.md

@@ -4,13 +4,13 @@ Helper methods for documents.
 
 ## Constructors
 
-### new DocumentHelper()
+### Constructor
 
-> **new DocumentHelper**(): [`DocumentHelper`](DocumentHelper.md)
+> **new DocumentHelper**(): `DocumentHelper`
 
 #### Returns
 
-[`DocumentHelper`](DocumentHelper.md)
+`DocumentHelper`
 
 ## Properties
 
@@ -54,7 +54,7 @@ The parsed document id.
 
 ### joinId()
 
-> `static` **joinId**(`documentId`, `fragment`?): `string`
+> `static` **joinId**(`documentId`, `fragment?`): `string`
 
 Join the document id parts.
 
@@ -82,7 +82,7 @@ The full id.
 
 ### getVerificationMethod()
 
-> `static` **getVerificationMethod**(`didDocument`, `methodName`, `methodType`?): `IDidDocumentVerificationMethod`
+> `static` **getVerificationMethod**(`didDocument`, `methodName`, `methodType?`): `IDidDocumentVerificationMethod`
 
 Get a verification method from a DID document.
 
@@ -120,7 +120,7 @@ Error if the method is not found.
 
 ### getJwk()
 
-> `static` **getJwk**(`didDocument`, `methodName`, `methodType`?): `IJwk`
+> `static` **getJwk**(`didDocument`, `methodName`, `methodType?`): `IJwk`
 
 Gets a JWK from a DID document verification method.
 

package/docs/reference/classes/VerificationHelper.md

@@ -4,13 +4,13 @@ Helper methods for verification.
 
 ## Constructors
 
-### new VerificationHelper()
+### Constructor
 
-> **new VerificationHelper**(): [`VerificationHelper`](VerificationHelper.md)
+> **new VerificationHelper**(): `VerificationHelper`
 
 #### Returns
 
-[`VerificationHelper`](VerificationHelper.md)
+`VerificationHelper`
 
 ## Properties
 
@@ -30,9 +30,13 @@ Verified the JWT.
 
 #### Type Parameters
 
-• **T** *extends* `IJwtHeader`
+##### T
 
-• **U** *extends* `IJwtPayload`
+`T` *extends* `IJwtHeader`
+
+##### U
+
+`U` *extends* `IJwtPayload`
 
 #### Parameters
 

package/docs/reference/interfaces/IIdentityComponent.md

@@ -10,7 +10,7 @@ Interface describing a contract which provides identity operations.
 
 ### identityCreate()
 
-> **identityCreate**(`namespace`?, `controller`?): `Promise`\<`IDidDocument`\>
+> **identityCreate**(`namespace?`, `controller?`): `Promise`\<`IDidDocument`\>
 
 Create a new identity.
 
@@ -38,7 +38,7 @@ The created identity document.
 
 ### verificationMethodCreate()
 
-> **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId`?, `controller`?): `Promise`\<`IDidDocumentVerificationMethod`\>
+> **verificationMethodCreate**(`identity`, `verificationMethodType`, `verificationMethodId?`, `controller?`): `Promise`\<`IDidDocumentVerificationMethod`\>
 
 Add a verification method to the document in JSON Web key Format.
 
@@ -86,7 +86,7 @@ NotSupportedError if the platform does not support multiple keys.
 
 ### verificationMethodRemove()
 
-> **verificationMethodRemove**(`verificationMethodId`, `controller`?): `Promise`\<`void`\>
+> **verificationMethodRemove**(`verificationMethodId`, `controller?`): `Promise`\<`void`\>
 
 Remove a verification method from the document.
 
@@ -122,7 +122,7 @@ NotSupportedError if the platform does not support multiple revocable keys.
 
 ### serviceCreate()
 
-> **serviceCreate**(`identity`, `serviceId`, `serviceType`, `serviceEndpoint`, `controller`?): `Promise`\<`IDidService`\>
+> **serviceCreate**(`identity`, `serviceId`, `serviceType`, `serviceEndpoint`, `controller?`): `Promise`\<`IDidService`\>
 
 Add a service to the document.
 
@@ -172,7 +172,7 @@ NotFoundError if the id can not be resolved.
 
 ### serviceRemove()
 
-> **serviceRemove**(`serviceId`, `controller`?): `Promise`\<`void`\>
+> **serviceRemove**(`serviceId`, `controller?`): `Promise`\<`void`\>
 
 Remove a service from the document.
 
@@ -204,7 +204,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`, `revocationIndex?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -276,7 +276,7 @@ The credential stored in the jwt and the revocation status.
 
 ### verifiableCredentialRevoke()
 
-> **verifiableCredentialRevoke**(`issuerId`, `credentialIndex`, `controller`?): `Promise`\<`void`\>
+> **verifiableCredentialRevoke**(`issuerId`, `credentialIndex`, `controller?`): `Promise`\<`void`\>
 
 Revoke verifiable credential.
 
@@ -310,7 +310,7 @@ Nothing.
 
 ### verifiableCredentialUnrevoke()
 
-> **verifiableCredentialUnrevoke**(`issuerId`, `credentialIndex`, `controller`?): `Promise`\<`void`\>
+> **verifiableCredentialUnrevoke**(`issuerId`, `credentialIndex`, `controller?`): `Promise`\<`void`\>
 
 Unrevoke verifiable credential.
 
@@ -344,7 +344,7 @@ Nothing.
 
 ### verifiablePresentationCreate()
 
-> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?, `controller`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **verifiablePresentationCreate**(`verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`, `controller?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
@@ -428,7 +428,7 @@ The presentation stored in the jwt and the revocation status.
 
 ### proofCreate()
 
-> **proofCreate**(`verificationMethodId`, `proofType`, `unsecureDocument`, `controller`?): `Promise`\<`IProof`\>
+> **proofCreate**(`verificationMethodId`, `proofType`, `unsecureDocument`, `controller?`): `Promise`\<`IProof`\>
 
 Create a proof for a document with the specified verification method.
 

package/docs/reference/interfaces/IIdentityConnector.md

@@ -32,7 +32,7 @@ The created document.
 
 ### addVerificationMethod()
 
-> **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId`?): `Promise`\<`IDidDocumentVerificationMethod`\>
+> **addVerificationMethod**(`controller`, `documentId`, `verificationMethodType`, `verificationMethodId?`): `Promise`\<`IDidDocumentVerificationMethod`\>
 
 Add a verification method to the document in JSON Web key Format.
 
@@ -198,7 +198,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`, `revocationIndex?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -338,7 +338,7 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**(`controller`, `verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
+> **createVerifiablePresentation**(`controller`, `verificationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes?`): `Promise`\<\{ `verifiablePresentation`: `IDidVerifiablePresentation`; `jwt`: `string`; \}\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 

package/docs/reference/interfaces/IIdentityProfileComponent.md

@@ -8,15 +8,19 @@ Interface describing a contract which provides profile operations.
 
 ## Type Parameters
 
-• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+### T
 
-• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+`T` *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+### U
+
+`U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
 ## Methods
 
 ### create()
 
-> **create**(`publicProfile`?, `privateProfile`?, `identity`?): `Promise`\<`void`\>
+> **create**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
 Create the profile properties for an identity.
 
@@ -50,7 +54,7 @@ Nothing.
 
 ### get()
 
-> **get**(`publicPropertyNames`?, `privatePropertyNames`?, `identity`?): `Promise`\<\{ `identity`: `string`; `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
+> **get**(`publicPropertyNames?`, `privatePropertyNames?`, `identity?`): `Promise`\<\{ `identity`: `string`; `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
@@ -84,7 +88,7 @@ The items identity and the properties.
 
 ### getPublic()
 
-> **getPublic**(`identity`, `propertyNames`?): `Promise`\<`Partial`\<`T`\>\>
+> **getPublic**(`identity`, `propertyNames?`): `Promise`\<`Partial`\<`T`\>\>
 
 Get the public profile properties for an identity.
 
@@ -112,7 +116,7 @@ The items properties.
 
 ### update()
 
-> **update**(`publicProfile`?, `privateProfile`?, `identity`?): `Promise`\<`void`\>
+> **update**(`publicProfile?`, `privateProfile?`, `identity?`): `Promise`\<`void`\>
 
 Update the profile properties of an identity.
 
@@ -146,7 +150,7 @@ Nothing.
 
 ### remove()
 
-> **remove**(`identity`?): `Promise`\<`void`\>
+> **remove**(`identity?`): `Promise`\<`void`\>
 
 Delete the profile for an identity.
 
@@ -168,7 +172,7 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `publicPropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
+> **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested identities.
 

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -8,15 +8,19 @@ Interface describing a contract which provides profile operations.
 
 ## Type Parameters
 
-• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+### T
 
-• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+`T` *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+### U
+
+`U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
 
 ## Methods
 
 ### create()
 
-> **create**(`identity`, `publicProfile`?, `privateProfile`?): `Promise`\<`void`\>
+> **create**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
 
 Create the profile properties for an identity.
 
@@ -50,7 +54,7 @@ Nothing.
 
 ### get()
 
-> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
+> **get**(`identity`, `publicPropertyNames?`, `privatePropertyNames?`): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
@@ -84,7 +88,7 @@ The identity profile, will only return private data if you have correct permissi
 
 ### update()
 
-> **update**(`identity`, `publicProfile`?, `privateProfile`?): `Promise`\<`void`\>
+> **update**(`identity`, `publicProfile?`, `privateProfile?`): `Promise`\<`void`\>
 
 Update the profile properties of an identity.
 
@@ -140,7 +144,7 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
+> **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested identities.
 

package/package.json

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