@twin.org/identity-connector-entity-storage 0.0.1-next.19 → 0.0.1-next.21

package/docs/reference/classes/EntityStorageIdentityResolverConnector.md

@@ -0,0 +1,77 @@
+# Class: EntityStorageIdentityResolverConnector
+
+Class for performing identity operations using entity storage.
+
+## Implements
+
+- `IIdentityResolverConnector`
+
+## Constructors
+
+### new EntityStorageIdentityResolverConnector()
+
+> **new EntityStorageIdentityResolverConnector**(`options`?): [`EntityStorageIdentityResolverConnector`](EntityStorageIdentityResolverConnector.md)
+
+Create a new instance of EntityStorageIdentityResolverConnector.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageIdentityResolverConnectorConstructorOptions`](../interfaces/IEntityStorageIdentityResolverConnectorConstructorOptions.md)
+
+The options for the identity connector.
+
+#### Returns
+
+[`EntityStorageIdentityResolverConnector`](EntityStorageIdentityResolverConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
+
+The namespace supported by the identity connector.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IIdentityResolverConnector.CLASS_NAME`
+
+## Methods
+
+### resolveDocument()
+
+> **resolveDocument**(`documentId`): `Promise`\<`IDidDocument`\>
+
+Resolve a document from its id.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.
+
+#### Throws
+
+NotFoundError if the id can not be resolved.
+
+#### Implementation of
+
+`IIdentityResolverConnector.resolveDocument`

package/docs/reference/functions/initSchema.md

@@ -6,15 +6,19 @@ Initialize the schema for the identity entity storage connector.
 
 ## Parameters
 
-• **options?**
+### options?
 
 Options for which entities to register.
 
-• **options.includeDocument?**: `boolean`
+#### includeDocument
+
+`boolean`
 
 Whether to include the document entity, defaults to true.
 
-• **options.includeProfile?**: `boolean`
+#### includeProfile
+
+`boolean`
 
 Whether to include the profile entity, defaults to true.
 

package/docs/reference/index.md

@@ -6,6 +6,13 @@
 - [IdentityProfile](classes/IdentityProfile.md)
 - [EntityStorageIdentityConnector](classes/EntityStorageIdentityConnector.md)
 - [EntityStorageIdentityProfileConnector](classes/EntityStorageIdentityProfileConnector.md)
+- [EntityStorageIdentityResolverConnector](classes/EntityStorageIdentityResolverConnector.md)
+
+## Interfaces
+
+- [IEntityStorageIdentityConnectorConstructorOptions](interfaces/IEntityStorageIdentityConnectorConstructorOptions.md)
+- [IEntityStorageIdentityProfileConnectorConstructorOptions](interfaces/IEntityStorageIdentityProfileConnectorConstructorOptions.md)
+- [IEntityStorageIdentityResolverConnectorConstructorOptions](interfaces/IEntityStorageIdentityResolverConnectorConstructorOptions.md)
 
 ## Functions
 

package/docs/reference/interfaces/IEntityStorageIdentityConnectorConstructorOptions.md

@@ -0,0 +1,43 @@
+# Interface: IEntityStorageIdentityConnectorConstructorOptions
+
+Options for the entity storage identity connector constructor.
+
+## Extends
+
+- [`IEntityStorageIdentityResolverConnectorConstructorOptions`](IEntityStorageIdentityResolverConnectorConstructorOptions.md)
+
+## Properties
+
+### didDocumentEntityStorageType?
+
+> `optional` **didDocumentEntityStorageType**: `string`
+
+The entity storage for the did documents.
+
+#### Default
+
+```ts
+identity-document
+```
+
+#### Inherited from
+
+[`IEntityStorageIdentityResolverConnectorConstructorOptions`](IEntityStorageIdentityResolverConnectorConstructorOptions.md).[`didDocumentEntityStorageType`](IEntityStorageIdentityResolverConnectorConstructorOptions.md#diddocumententitystoragetype)
+
+***
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The vault for the private keys.
+
+#### Default
+
+```ts
+vault
+```
+
+#### Inherited from
+
+[`IEntityStorageIdentityResolverConnectorConstructorOptions`](IEntityStorageIdentityResolverConnectorConstructorOptions.md).[`vaultConnectorType`](IEntityStorageIdentityResolverConnectorConstructorOptions.md#vaultconnectortype)

package/docs/reference/interfaces/IEntityStorageIdentityProfileConnectorConstructorOptions.md

@@ -0,0 +1,17 @@
+# Interface: IEntityStorageIdentityProfileConnectorConstructorOptions
+
+Options for the entity storage identity profile connector constructor.
+
+## Properties
+
+### profileEntityStorageType?
+
+> `optional` **profileEntityStorageType**: `string`
+
+The storage connector for the profiles.
+
+#### Default
+
+```ts
+identity-profile
+```

package/docs/reference/interfaces/IEntityStorageIdentityResolverConnectorConstructorOptions.md

@@ -0,0 +1,35 @@
+# Interface: IEntityStorageIdentityResolverConnectorConstructorOptions
+
+Options for the entity storage identity connector constructor.
+
+## Extended by
+
+- [`IEntityStorageIdentityConnectorConstructorOptions`](IEntityStorageIdentityConnectorConstructorOptions.md)
+
+## Properties
+
+### didDocumentEntityStorageType?
+
+> `optional` **didDocumentEntityStorageType**: `string`
+
+The entity storage for the did documents.
+
+#### Default
+
+```ts
+identity-document
+```
+
+***
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The vault for the private keys.
+
+#### Default
+
+```ts
+vault
+```

package/locales/en.json

@@ -1,9 +1,12 @@
 {
 	"error": {
+		"entityStorageIdentityResolverConnector": {
+			"documentNotFound": "The document could not be found",
+			"resolveDocumentFailed": "Resolving the document failed"
+		},
 		"entityStorageIdentityConnector": {
 			"createDocumentFailed": "Creating the document failed",
 			"signatureVerificationFailed": "The document integrity check failed",
-			"resolveDocumentFailed": "Resolving the document failed",
 			"missingDid": "The full id including DID is required",
 			"addVerificationMethodFailed": "Adding the verification method failed",
 			"removeVerificationMethodFailed": "Removing the verification method failed",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-connector-entity-storage",
-	"version": "0.0.1-next.19",
+	"version": "0.0.1-next.21",
 	"description": "Identity connector implementation using entity storage",
 	"repository": {
 		"type": "git",
@@ -19,7 +19,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.0.1-next.19",
+		"@twin.org/identity-models": "0.0.1-next.21",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",
@@ -30,9 +30,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},