@twin.org/identity-connector-entity-storage 0.0.1-next.10

package/docs/reference/classes/EntityStorageIdentityProfileConnector.md

@@ -0,0 +1,239 @@
+# Class: EntityStorageIdentityProfileConnector\<T, U\>
+
+Class which implements the identity profile connector contract.
+
+## Type Parameters
+
+• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+## Implements
+
+- `IIdentityProfileConnector`\<`T`, `U`\>
+
+## Constructors
+
+### new EntityStorageIdentityProfileConnector()
+
+> **new EntityStorageIdentityProfileConnector**\<`T`, `U`\>(`options`?): [`EntityStorageIdentityProfileConnector`](EntityStorageIdentityProfileConnector.md)\<`T`, `U`\>
+
+Create a new instance of Identity.
+
+#### Parameters
+
+• **options?**
+
+The dependencies for the identity service.
+
+• **options.profileEntityStorageType?**: `string`
+
+The storage connector for the profiles, default to "identity-profile".
+
+#### Returns
+
+[`EntityStorageIdentityProfileConnector`](EntityStorageIdentityProfileConnector.md)\<`T`, `U`\>
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
+
+The namespace supported by the identity profile connector.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IIdentityProfileConnector.CLASS_NAME`
+
+## Methods
+
+### create()
+
+> **create**(`identity`, `publicProfile`?, `privateProfile`?): `Promise`\<`void`\>
+
+Create the profile properties for an identity.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the profile to create.
+
+• **publicProfile?**: `T`
+
+The public profile data.
+
+• **privateProfile?**: `U`
+
+The private profile data.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityProfileConnector.create`
+
+***
+
+### get()
+
+> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<`object`\>
+
+Get the profile properties for an identity.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity of the item to get.
+
+• **publicPropertyNames?**: keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+• **privatePropertyNames?**: keyof `U`[]
+
+The private properties to get for the profile, defaults to all.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The items properties.
+
+##### publicProfile
+
+> **publicProfile**: `Partial`\<`T`\>
+
+##### privateProfile
+
+> **privateProfile**: `Partial`\<`U`\>
+
+#### Implementation of
+
+`IIdentityProfileConnector.get`
+
+***
+
+### update()
+
+> **update**(`identity`, `publicProfile`?, `privateProfile`?): `Promise`\<`void`\>
+
+Update the profile properties of an identity.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity to update.
+
+• **publicProfile?**: `T`
+
+The public profile data.
+
+• **privateProfile?**: `U`
+
+The private profile data.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityProfileConnector.update`
+
+***
+
+### remove()
+
+> **remove**(`identity`): `Promise`\<`void`\>
+
+Delete the profile for an identity.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity to delete.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IIdentityProfileConnector.remove`
+
+***
+
+### list()
+
+> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Get a list of the requested types.
+
+#### Parameters
+
+• **publicFilters?**: `object`[]
+
+The filters to apply to the identities public profiles.
+
+• **privateFilters?**: `object`[]
+
+The filters to apply to the identities private profiles.
+
+• **publicPropertyNames?**: keyof `T`[]
+
+The public properties to get for the profile, defaults to all.
+
+• **privatePropertyNames?**: keyof `U`[]
+
+The private properties to get for the profile, defaults to all.
+
+• **cursor?**: `string`
+
+The cursor for paged requests.
+
+• **pageSize?**: `number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+The list of items and cursor for paging.
+
+##### items
+
+> **items**: `object`[]
+
+The identities.
+
+##### cursor?
+
+> `optional` **cursor**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.
+
+#### Implementation of
+
+`IIdentityProfileConnector.list`

package/docs/reference/classes/IdentityDocument.md

@@ -0,0 +1,45 @@
+# Class: IdentityDocument
+
+Class describing the identity document.
+
+## Constructors
+
+### new IdentityDocument()
+
+> **new IdentityDocument**(): [`IdentityDocument`](IdentityDocument.md)
+
+#### Returns
+
+[`IdentityDocument`](IdentityDocument.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The identity of the document.
+
+***
+
+### document
+
+> **document**: `IDidDocument`
+
+The DID document.
+
+***
+
+### signature
+
+> **signature**: `string`
+
+The signature of the document.
+
+***
+
+### controller
+
+> **controller**: `string`
+
+The controller of the document.

package/docs/reference/classes/IdentityProfile.md

@@ -0,0 +1,37 @@
+# Class: IdentityProfile
+
+Class representing profile details for the identity.
+
+## Constructors
+
+### new IdentityProfile()
+
+> **new IdentityProfile**(): [`IdentityProfile`](IdentityProfile.md)
+
+#### Returns
+
+[`IdentityProfile`](IdentityProfile.md)
+
+## Properties
+
+### identity
+
+> **identity**: `string`
+
+The id for the identity.
+
+***
+
+### publicProfile?
+
+> `optional` **publicProfile**: `unknown`
+
+The public profile data.
+
+***
+
+### privateProfile?
+
+> `optional` **privateProfile**: `unknown`
+
+The private profile data.

package/docs/reference/functions/initSchema.md

@@ -0,0 +1,23 @@
+# Function: initSchema()
+
+> **initSchema**(`options`?): `void`
+
+Initialize the schema for the identity entity storage connector.
+
+## Parameters
+
+• **options?**
+
+Options for which entities to register.
+
+• **options.includeDocument?**: `boolean`
+
+Whether to include the document entity, defaults to true.
+
+• **options.includeProfile?**: `boolean`
+
+Whether to include the profile entity, defaults to true.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -0,0 +1,12 @@
+# @twin.org/identity-connector-entity-storage
+
+## Classes
+
+- [IdentityDocument](classes/IdentityDocument.md)
+- [IdentityProfile](classes/IdentityProfile.md)
+- [EntityStorageIdentityConnector](classes/EntityStorageIdentityConnector.md)
+- [EntityStorageIdentityProfileConnector](classes/EntityStorageIdentityProfileConnector.md)
+
+## Functions
+
+- [initSchema](functions/initSchema.md)

package/locales/en.json

@@ -0,0 +1,41 @@
+{
+	"error": {
+		"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",
+			"addServiceFailed": "Adding the service failed",
+			"removeServiceFailed": "Removing the service failed",
+			"documentNotFound": "The document could not be found",
+			"documentPrivateKeyNotFound": "The private key for document could not be found in the vault",
+			"verificationMethodNotFound": "The verification method could not be found",
+			"verificationPrivateKeyNotFound": "The private key for the verification method could not be found in the vault",
+			"serviceNotFound": "The service could not be found",
+			"publicKeyJwkMissing": "The verification method contains no publicKeyJwk",
+			"jwkSignatureFailed": "The signature on the JWK failed verification",
+			"createVerifiableCredentialFailed": "Creating the verifiable credential failed",
+			"checkingVerifiableCredentialFailed": "Checking the verifiable credential failed",
+			"createVerifiablePresentationFailed": "Creating the verifiable presentation failed",
+			"checkingVerifiablePresentationFailed": "Checking the verifiable presentation failed",
+			"expectingJwtCredential": "Expecting JWT credential in the presentation",
+			"keyIndexOutOfRange": "The supplied keyIndex is not in the range of the key list",
+			"createProofFailed": "Creating the signature for the data failed",
+			"methodMissing": "The verification method specified does not exist",
+			"verifyProofFailed": "Verifying the signature for the data failed",
+			"revokeVerifiableCredentialsFailed": "Revoking verifiable credentials failed",
+			"unrevokeVerifiableCredentialsFailed": "Unrevoking verifiable credentials failed"
+		},
+		"entityStorageIdentityProfileConnector": {
+			"alreadyExists": "The identity profile already exists for the identity \"{existingId}\"",
+			"createFailed": "Creating the identity profile failed \"{identity}\"",
+			"getFailed": "Getting the identity profile failed \"{notFoundId}\"",
+			"updateFailed": "Updating the identity profile failed \"{identity}\"",
+			"notFound": "The identity profile failed \"{notFoundId}\"",
+			"removeFailed": "Removing the identity profile failed \"{identity}\"",
+			"listFailed": "Failed listing identities"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@twin.org/identity-connector-entity-storage",
+	"version": "0.0.1-next.10",
+	"description": "Identity connector implementation using entity storage",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/identity.git",
+		"directory": "packages/identity-connector-entity-storage"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/identity-models": "0.0.1-next.10",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}