@twin.org/identity-models 0.0.1-next.3

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -0,0 +1,177 @@
+# Interface: IIdentityProfileConnector\<T, U\>
+
+Interface describing a contract which provides profile operations.
+
+## Extends
+
+- `IComponent`
+
+## Type Parameters
+
+• **T** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+• **U** *extends* `IJsonLdDocument` = `IJsonLdDocument`
+
+## 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 as JSON-LD.
+
+• **privateProfile?**: `U`
+
+The private profile data as JSON-LD.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### 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 identity profile, will only return private data if you have correct permissions.
+
+##### publicProfile
+
+> **publicProfile**: `Partial`\<`T`\>
+
+##### privateProfile
+
+> **privateProfile**: `Partial`\<`U`\>
+
+***
+
+### 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 as JSON-LD.
+
+• **privateProfile?**: `U`
+
+The private profile data as JSON-LD.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### remove()
+
+> **remove**(`identity`): `Promise`\<`void`\>
+
+Delete the profile for an identity.
+
+#### Parameters
+
+• **identity**: `string`
+
+The identity to delete.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### list()
+
+> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+
+Get a list of the requested identities.
+
+#### 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 identity profiles.
+
+##### cursor?
+
+> `optional` **cursor**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IIdentityProfileCreateRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityProfileCreateRequest
+
+Request to create an identity profile.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### publicProfile?
+
+> `optional` **publicProfile**: `IJsonLdDocument`
+
+The public profile data.
+
+#### privateProfile?
+
+> `optional` **privateProfile**: `IJsonLdDocument`
+
+The private profile data.

package/docs/reference/interfaces/IIdentityProfileGetPublicRequest.md

@@ -0,0 +1,31 @@
+# Interface: IIdentityProfileGetPublicRequest
+
+Get the public profile for an identity.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### identity
+
+> **identity**: `string`
+
+The identity to get the profile for.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### propertyNames?
+
+> `optional` **propertyNames**: `string`
+
+The properties to get for the public profile, defaults to all, should be a comma separated list.

package/docs/reference/interfaces/IIdentityProfileGetPublicResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityProfileGetPublicResponse
+
+Response to get an identity public profile.
+
+## Properties
+
+### headers
+
+> **headers**: `object`
+
+The response headers.
+
+#### Content-Type
+
+> **Content-Type**: `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: `Partial`\<`IJsonLdDocument`\>
+
+The response payload.

package/docs/reference/interfaces/IIdentityProfileGetRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityProfileGetRequest
+
+Get the profile for an identity.
+
+## Properties
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### publicPropertyNames?
+
+> `optional` **publicPropertyNames**: `string`
+
+The public properties to get for the profile, defaults to all, should be a comma separated list.
+
+#### privatePropertyNames?
+
+> `optional` **privatePropertyNames**: `string`
+
+The private properties to get for the profile, defaults to all, should be a comma separated list.

package/docs/reference/interfaces/IIdentityProfileGetResponse.md

@@ -0,0 +1,29 @@
+# Interface: IIdentityProfileGetResponse
+
+Response to get an identity details.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### identity
+
+> **identity**: `string`
+
+The identity of the profile, this is the authenticated user identity.
+
+#### publicProfile?
+
+> `optional` **publicProfile**: `Partial`\<`IJsonLdDocument`\>
+
+The public profile data.
+
+#### privateProfile?
+
+> `optional` **privateProfile**: `Partial`\<`IJsonLdDocument`\>
+
+The private profile data.

package/docs/reference/interfaces/IIdentityProfileListRequest.md

@@ -0,0 +1,35 @@
+# Interface: IIdentityProfileListRequest
+
+Request to get a list of identities.
+
+## Properties
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### publicFilters?
+
+> `optional` **publicFilters**: `string`
+
+The public filters to apply to the list, comma separated list with color between key and value for each pair e.g. prop1:value1,prop2:value2.
+
+#### publicPropertyNames?
+
+> `optional` **publicPropertyNames**: `string`
+
+The public properties to get for the profile, defaults to all, should be a comma separated list.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor for paged requests.
+
+#### pageSize?
+
+> `optional` **pageSize**: `number`
+
+Number of items to return.

package/docs/reference/interfaces/IIdentityProfileListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityProfileListResponse
+
+Response to get a list of identities.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The response payload.
+
+#### items
+
+> **items**: `object`[]
+
+The identities.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IIdentityProfileUpdateRequest.md

@@ -0,0 +1,23 @@
+# Interface: IIdentityProfileUpdateRequest
+
+Request to update an identity profile.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The data for the request.
+
+#### publicProfile?
+
+> `optional` **publicProfile**: `IJsonLdDocument`
+
+The public profile data.
+
+#### privateProfile?
+
+> `optional` **privateProfile**: `IJsonLdDocument`
+
+The private profile data.

package/docs/reference/interfaces/IIdentityResolveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IIdentityResolveRequest
+
+Resolve an identity.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The identity to get the document for.

package/docs/reference/interfaces/IIdentityResolveResponse.md

@@ -0,0 +1,11 @@
+# Interface: IIdentityResolveResponse
+
+Response to resolving an identity.
+
+## Properties
+
+### body
+
+> **body**: `IDidDocument`
+
+The response payload.

package/docs/reference/type-aliases/IdentityRole.md

@@ -0,0 +1,5 @@
+# Type Alias: IdentityRole
+
+> **IdentityRole**: *typeof* [`IdentityRole`](../variables/IdentityRole.md)\[keyof *typeof* [`IdentityRole`](../variables/IdentityRole.md)\]
+
+The roles that an identity can have.

package/docs/reference/variables/IdentityConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: IdentityConnectorFactory
+
+> `const` **IdentityConnectorFactory**: `Factory`\<[`IIdentityConnector`](../interfaces/IIdentityConnector.md)\>
+
+Factory for creating identity connectors.

package/docs/reference/variables/IdentityProfileConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: IdentityProfileConnectorFactory
+
+> `const` **IdentityProfileConnectorFactory**: `Factory`\<[`IIdentityProfileConnector`](../interfaces/IIdentityProfileConnector.md)\<`IJsonLdDocument`, `IJsonLdDocument`\>\>
+
+Factory for creating identity profile connectors.

package/docs/reference/variables/IdentityRole.md

@@ -0,0 +1,25 @@
+# Variable: IdentityRole
+
+> `const` **IdentityRole**: `object`
+
+The roles that an identity can have.
+
+## Type declaration
+
+### Node
+
+> `readonly` **Node**: `"node"` = `"node"`
+
+Node.
+
+### Organization
+
+> `readonly` **Organization**: `"organization"` = `"organization"`
+
+Organization.
+
+### User
+
+> `readonly` **User**: `"user"` = `"user"`
+
+User.

package/locales/en.json

@@ -0,0 +1,13 @@
+{
+	"identityRole": {
+		"organization": "Organization",
+		"user": "User",
+		"node": "Node"
+	},
+	"verifiableCredentialStates": {
+		"pendingVerification": "Pending Verification",
+		"rejected": "Rejected",
+		"issued": "Issued",
+		"revoked": "Revoked"
+	}
+}

package/package.json

@@ -0,0 +1,68 @@
+{
+	"name": "@twin.org/identity-models",
+	"version": "0.0.1-next.3",
+	"description": "Models which define the structure of the contracts and connectors",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/identity.git",
+		"directory": "packages/identity-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/web": "next"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.22.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"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"
+	]
+}