@twin.org/identity-models 0.0.1-next.19 → 0.0.1-next.21

package/docs/reference/interfaces/IIdentityProfileConnector.md

@@ -22,15 +22,21 @@ Create the profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity of the profile to create.
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
@@ -44,38 +50,36 @@ Nothing.
 
 ### get()
 
-> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<`object`\>
+> **get**(`identity`, `publicPropertyNames`?, `privatePropertyNames`?): `Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 Get the profile properties for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity of the item to get.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **privatePropertyNames?**: keyof `U`[]
+##### privatePropertyNames?
+
+keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `publicProfile`: `Partial`\<`T`\>; `privateProfile`: `Partial`\<`U`\>; \}\>
 
 The identity profile, will only return private data if you have correct permissions.
 
-##### publicProfile
-
-> **publicProfile**: `Partial`\<`T`\>
-
-##### privateProfile
-
-> **privateProfile**: `Partial`\<`U`\>
-
 ***
 
 ### update()
@@ -86,15 +90,21 @@ Update the profile properties of an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to update.
 
-• **publicProfile?**: `T`
+##### publicProfile?
+
+`T`
 
 The public profile data as JSON-LD.
 
-• **privateProfile?**: `U`
+##### privateProfile?
+
+`U`
 
 The private profile data as JSON-LD.
 
@@ -114,7 +124,9 @@ Delete the profile for an identity.
 
 #### Parameters
 
-• **identity**: `string`
+##### identity
+
+`string`
 
 The identity to delete.
 
@@ -128,50 +140,50 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **list**(`publicFilters`?, `privateFilters`?, `publicPropertyNames`?, `privatePropertyNames`?, `cursor`?, `pageSize`?): `Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 Get a list of the requested identities.
 
 #### Parameters
 
-• **publicFilters?**: `object`[]
+##### publicFilters?
+
+`object`[]
 
 The filters to apply to the identities public profiles.
 
-• **privateFilters?**: `object`[]
+##### privateFilters?
+
+`object`[]
 
 The filters to apply to the identities private profiles.
 
-• **publicPropertyNames?**: keyof `T`[]
+##### publicPropertyNames?
+
+keyof `T`[]
 
 The public properties to get for the profile, defaults to all.
 
-• **privatePropertyNames?**: keyof `U`[]
+##### privatePropertyNames?
+
+keyof `U`[]
 
 The private properties to get for the profile, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor for paged requests.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of items in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `items`: `object`[]; `cursor`: `string`; \}\>
 
 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/IIdentityResolveRequest.md

@@ -14,4 +14,4 @@ The path parameters.
 
 > **id**: `string`
 
-The identity to get the document for.
+The identity to resolve.

package/docs/reference/interfaces/IIdentityResolverComponent.md

@@ -0,0 +1,29 @@
+# Interface: IIdentityResolverComponent
+
+Interface describing a contract which provides identity operations.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### identityResolve()
+
+> **identityResolve**(`identity`): `Promise`\<`IDidDocument`\>
+
+Resolve an identity.
+
+#### Parameters
+
+##### identity
+
+`string`
+
+The id of the document to resolve.
+
+#### Returns
+
+`Promise`\<`IDidDocument`\>
+
+The resolved document.

package/docs/reference/interfaces/IIdentityResolverConnector.md

@@ -0,0 +1,33 @@
+# Interface: IIdentityResolverConnector
+
+Interface describing an identity connector.
+
+## Extends
+
+- `IComponent`
+
+## 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.

package/docs/reference/variables/IdentityProfileConnectorFactory.md

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

package/docs/reference/variables/IdentityResolverConnectorFactory.md

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

package/locales/en.json

@@ -1,8 +1,9 @@
 {
-	"identityRole": {
-		"organization": "Organization",
-		"user": "User",
-		"node": "Node"
+	"error": {
+		"jwtHelper": {
+			"jwtDecodeFailed": "Decoding the JWT failed",
+			"jwtPayloadMissingParam": "The JWT is missing the required parameter \"{param}\""
+		}
 	},
 	"verifiableCredentialStates": {
 		"pendingVerification": "Pending Verification",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.19",
+	"version": "0.0.1-next.21",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -26,9 +26,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"
 	},

package/dist/types/models/identityRole.d.ts

@@ -1,21 +0,0 @@
-/**
- * The roles that an identity can have.
- */
-export declare const IdentityRole: {
-    /**
-     * Node.
-     */
-    readonly Node: "node";
-    /**
-     * Organization.
-     */
-    readonly Organization: "organization";
-    /**
-     * User.
-     */
-    readonly User: "user";
-};
-/**
- * The roles that an identity can have.
- */
-export type IdentityRole = (typeof IdentityRole)[keyof typeof IdentityRole];

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

@@ -1,5 +0,0 @@
-# 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/IdentityRole.md

@@ -1,25 +0,0 @@
-# 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.