@twin.org/identity-service 0.9.1 → 0.9.2-next.10

package/docs/reference/classes/IdentityProfileService.md

@@ -277,3 +277,59 @@ The list of items and cursor for paging.
 #### Implementation of
 
 `IIdentityProfileComponent.list`
+
+***
+
+### listAdmin() {#listadmin}
+
+> **listAdmin**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+Get a list of identities including private profile data.
+
+#### 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 none.
+
+##### cursor?
+
+`string`
+
+The cursor for paged requests.
+
+##### limit?
+
+`number`
+
+The maximum number of items in a page.
+
+#### Returns
+
+`Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+
+The list of items and cursor for paging.
+
+#### Implementation of
+
+`IIdentityProfileComponent.listAdmin`

package/docs/reference/classes/IdentityService.md

@@ -5,6 +5,7 @@ Class which implements the identity contract.
 ## Implements
 
 - `IIdentityComponent`
+- `IHealthProviderComponent`
 
 ## Constructors
 
@@ -76,6 +77,73 @@ A promise that resolves when all metrics have been registered.
 
 ***
 
+### healthApplicationInit() {#healthapplicationinit}
+
+> **healthApplicationInit**(`contextIds`): `Promise`\<`void`\>
+
+Creates a temporary DID document for the application health check.
+
+#### Parameters
+
+##### contextIds
+
+`IContextIds`
+
+The context IDs accumulated by prior init steps.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplicationInit`
+
+***
+
+### healthApplication() {#healthapplication}
+
+> **healthApplication**(`callback`): `Promise`\<`IHealth`[] \| `undefined`\>
+
+Returns the application health status of the identity service by resolving the DID created
+in healthApplicationInit.
+
+#### Parameters
+
+##### callback
+
+`HealthApplicationCallback`
+
+Callback for deferred results.
+
+#### Returns
+
+`Promise`\<`IHealth`[] \| `undefined`\>
+
+The health status of the service.
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplication`
+
+***
+
+### healthApplicationTeardown() {#healthapplicationteardown}
+
+> **healthApplicationTeardown**(): `Promise`\<`void`\>
+
+Removes the DID document created in healthApplicationInit.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Implementation of
+
+`IHealthProviderComponent.healthApplicationTeardown`
+
+***
+
 ### identityCreate() {#identitycreate}
 
 > **identityCreate**(`namespace?`, `controller?`): `Promise`\<`IDidDocument`\>
@@ -110,7 +178,7 @@ The created identity document.
 
 ### identityRemove() {#identityremove}
 
-> **identityRemove**(`identity`, `controller?`): `Promise`\<`void`\>
+> **identityRemove**(`identity`, `options?`, `controller?`): `Promise`\<`void`\>
 
 Remove an identity.
 
@@ -122,6 +190,16 @@ Remove an identity.
 
 The id of the document to remove.
 
+##### options?
+
+Optional settings.
+
+###### removeKeys?
+
+`boolean`
+
+Also remove any associated private keys from the vault.
+
 ##### controller?
 
 `string`
@@ -194,7 +272,7 @@ NotSupportedError if the platform does not support multiple keys.
 
 ### verificationMethodRemove() {#verificationmethodremove}
 
-> **verificationMethodRemove**(`verificationMethodId`, `controller?`): `Promise`\<`void`\>
+> **verificationMethodRemove**(`verificationMethodId`, `options?`, `controller?`): `Promise`\<`void`\>
 
 Remove a verification method from the document.
 
@@ -206,6 +284,16 @@ Remove a verification method from the document.
 
 The id of the verification method.
 
+##### options?
+
+Optional settings.
+
+###### removeKeys?
+
+`boolean`
+
+Also remove any associated private key from the vault.
+
 ##### controller?
 
 `string`

package/docs/reference/functions/identitiesAdminList.md

@@ -0,0 +1,31 @@
+# Function: identitiesAdminList()
+
+> **identitiesAdminList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileAdminListResponse`\>
+
+Get the list of identity profiles including private properties as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileAdminListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileAdminGet.md

@@ -0,0 +1,31 @@
+# Function: identityProfileAdminGet()
+
+> **identityProfileAdminGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IIdentityProfileGetResponse`\>
+
+Get the identity profile of another user as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IIdentityProfileGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileAdminRemove.md

@@ -0,0 +1,31 @@
+# Function: identityProfileAdminRemove()
+
+> **identityProfileAdminRemove**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the identity profile of another user as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminRemoveRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/identityProfileAdminUpdate.md

@@ -0,0 +1,31 @@
+# Function: identityProfileAdminUpdate()
+
+> **identityProfileAdminUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Update the identity profile of another user as an admin.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes stored in the ComponentFactory.
+
+### request
+
+`IIdentityProfileAdminUpdateRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -26,10 +26,14 @@
 - [generateRestRoutesIdentityProfile](functions/generateRestRoutesIdentityProfile.md)
 - [identityProfileCreate](functions/identityProfileCreate.md)
 - [identityGet](functions/identityGet.md)
+- [identityProfileAdminGet](functions/identityProfileAdminGet.md)
 - [identityGetPublic](functions/identityGetPublic.md)
 - [identityProfileUpdate](functions/identityProfileUpdate.md)
+- [identityProfileAdminUpdate](functions/identityProfileAdminUpdate.md)
 - [identityProfileRemove](functions/identityProfileRemove.md)
+- [identityProfileAdminRemove](functions/identityProfileAdminRemove.md)
 - [identitiesList](functions/identitiesList.md)
+- [identitiesAdminList](functions/identitiesAdminList.md)
 - [generateRestRoutesIdentityResolver](functions/generateRestRoutesIdentityResolver.md)
 - [identityResolve](functions/identityResolve.md)
 - [generateRestRoutesIdentity](functions/generateRestRoutesIdentity.md)

package/docs/reference/interfaces/IIdentityServiceConstructorOptions.md

@@ -17,3 +17,25 @@ The configuration for the identity service.
 > `optional` **telemetryComponentType?**: `string`
 
 The component type for the optional telemetry component used for event metrics.
+
+***
+
+### tracingComponentType? {#tracingcomponenttype}
+
+> `optional` **tracingComponentType?**: `string`
+
+The component type for the optional tracing component used for spans.
+
+***
+
+### vaultConnectorType? {#vaultconnectortype}
+
+> `optional` **vaultConnectorType?**: `string`
+
+The vault connector type to use for migrating the mnemonic during health check initialisation.
+
+#### Default
+
+```ts
+vault
+```

package/locales/en.json

@@ -1,4 +1,11 @@
 {
+	"health": {
+		"identityService": {
+			"healthDescription": "DID document lifecycle (create, resolve, remove) using the \"{namespace}\" namespace",
+			"createDocumentFailed": "Failed to create the health check identity document",
+			"resolveDocumentFailed": "Failed to resolve the health check identity document"
+		}
+	},
 	"error": {
 		"identityService": {
 			"noConnectors": "There are no connectors registered with the identity factory",
@@ -35,7 +42,8 @@
 			"updateFailed": "Updating the identity profile failed \"{identity}\"",
 			"notFound": "The identity profile could not be found \"{notFoundId}\"",
 			"removeFailed": "Removing the identity profile failed \"{identity}\"",
-			"listFailed": "Failed listing identities"
+			"listFailed": "Failed listing identities",
+			"listAdminFailed": "Failed listing identities with private data"
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-service",
-	"version": "0.9.1",
+	"version": "0.9.2-next.10",
 	"description": "Service contracts and REST endpoint definitions for exposing identity workflows through stable interfaces.",
 	"repository": {
 		"type": "git",
@@ -14,19 +14,21 @@
 		"node": ">=24.0.0"
 	},
 	"dependencies": {
-		"@twin.org/api-models": "^0.9.1",
-		"@twin.org/context": "^0.9.1",
-		"@twin.org/core": "^0.9.1",
-		"@twin.org/crypto": "^0.9.1",
-		"@twin.org/data-core": "^0.9.1",
-		"@twin.org/data-json-ld": "^0.9.1",
-		"@twin.org/entity": "^0.9.1",
-		"@twin.org/entity-storage-models": "^0.9.1",
-		"@twin.org/identity-models": "^0.9.1",
-		"@twin.org/standards-w3c-did": "^0.9.1",
-		"@twin.org/telemetry-models": "^0.9.1",
-		"@twin.org/vault-models": "^0.9.1",
-		"@twin.org/web": "^0.9.1"
+		"@twin.org/api-models": "next",
+		"@twin.org/context": "next",
+		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/dlt-account": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/identity-models": "0.9.2-next.10",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/telemetry-models": "next",
+		"@twin.org/tracing-models": "next",
+		"@twin.org/vault-models": "next",
+		"@twin.org/wallet-models": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",