@twin.org/identity-service 0.9.2-next.3 → 0.9.2-next.4

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

@@ -11,4 +11,9 @@ export interface IIdentityServiceConstructorOptions {
      * The component type for the optional telemetry component used for event metrics.
      */
     telemetryComponentType?: string;
+    /**
+     * The vault connector type to use for migrating the mnemonic during health check initialisation.
+     * @default vault
+     */
+    vaultConnectorType?: string;
 }

package/docs/changelog.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.9.2-next.4](https://github.com/iotaledger/twin-identity/compare/identity-service-v0.9.2-next.3...identity-service-v0.9.2-next.4) (2026-08-07)
+
+
+### Features
+
+* health and key removal ([934391f](https://github.com/iotaledger/twin-identity/commit/934391f9307beda34bc594e3aa506137e3df631b))
+* health and key removal ([#191](https://github.com/iotaledger/twin-identity/issues/191)) ([8504101](https://github.com/iotaledger/twin-identity/commit/8504101a7a08b2a042a4e59f666c245308527088))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.9.2-next.3 to 0.9.2-next.4
+  * devDependencies
+    * @twin.org/identity-connector-entity-storage bumped from 0.9.2-next.3 to 0.9.2-next.4
+
 ## [0.9.2-next.3](https://github.com/iotaledger/twin-identity/compare/identity-service-v0.9.2-next.2...identity-service-v0.9.2-next.3) (2026-08-03)
 
 

package/docs/open-api/spec.json

@@ -152,6 +152,15 @@
 						},
 						"style": "simple",
 						"example": "did:iota:tst:0xe3088ba9aa8c28e1d139708a14e8c0fdff11ee8223baac4aa5bcf3321e4bfc6a"
+					},
+					{
+						"name": "removeKeys",
+						"description": "Also remove any associated private keys from the vault.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
 					}
 				],
 				"security": [
@@ -492,6 +501,15 @@
 						},
 						"style": "simple",
 						"example": "my-assertion"
+					},
+					{
+						"name": "removeKeys",
+						"description": "Also remove any associated private key from the vault.",
+						"in": "query",
+						"required": false,
+						"schema": {
+							"type": "string"
+						}
 					}
 				],
 				"security": [

package/docs/reference/classes/IdentityService.md

@@ -77,21 +77,14 @@ A promise that resolves when all metrics have been registered.
 
 ***
 
-### healthInit() {#healthinit}
+### healthApplicationInit() {#healthapplicationinit}
 
-> **healthInit**(`lastTimestamp`, `contextIds`): `Promise`\<`void`\>
+> **healthApplicationInit**(`contextIds`): `Promise`\<`void`\>
 
-Creates a temporary DID document for the health check using the default namespace connector.
-Skipped when called within the configured health interval.
+Creates a temporary DID document for the application health check.
 
 #### Parameters
 
-##### lastTimestamp
-
-`number`
-
-The Unix timestamp (ms) recorded at the start of the previous cycle.
-
 ##### contextIds
 
 `IContextIds`
@@ -104,50 +97,42 @@ The context IDs accumulated by prior init steps.
 
 #### Implementation of
 
-`IHealthProviderComponent.healthInit`
+`IHealthProviderComponent.healthApplicationInit`
 
 ***
 
-### health() {#health}
+### healthApplication() {#healthapplication}
 
-> **health**(`lastTimestamp`): `Promise`\<`IHealth`[]\>
+> **healthApplication**(`callback`): `Promise`\<`IHealth`[] \| `undefined`\>
 
 Returns the application health status of the identity service by resolving the DID created
-in healthInit. On cycles where healthInit was skipped, returns the cached result.
+in healthApplicationInit.
 
 #### Parameters
 
-##### lastTimestamp
+##### callback
 
-`number`
+`HealthApplicationCallback`
 
-The Unix timestamp (ms) recorded at the start of the previous cycle.
+Callback for deferred results.
 
 #### Returns
 
-`Promise`\<`IHealth`[]\>
+`Promise`\<`IHealth`[] \| `undefined`\>
 
 The health status of the service.
 
 #### Implementation of
 
-`IHealthProviderComponent.health`
+`IHealthProviderComponent.healthApplication`
 
 ***
 
-### healthTeardown() {#healthteardown}
-
-> **healthTeardown**(`lastTimestamp`): `Promise`\<`void`\>
+### healthApplicationTeardown() {#healthapplicationteardown}
 
-Removes the DID document created in healthInit using the default namespace connector.
+> **healthApplicationTeardown**(): `Promise`\<`void`\>
 
-#### Parameters
-
-##### lastTimestamp
-
-`number`
-
-The Unix timestamp (ms) recorded at the start of the previous cycle.
+Removes the DID document created in healthApplicationInit.
 
 #### Returns
 
@@ -155,7 +140,7 @@ The Unix timestamp (ms) recorded at the start of the previous cycle.
 
 #### Implementation of
 
-`IHealthProviderComponent.healthTeardown`
+`IHealthProviderComponent.healthApplicationTeardown`
 
 ***
 
@@ -193,7 +178,7 @@ The created identity document.
 
 ### identityRemove() {#identityremove}
 
-> **identityRemove**(`identity`, `controller?`): `Promise`\<`void`\>
+> **identityRemove**(`identity`, `options?`, `controller?`): `Promise`\<`void`\>
 
 Remove an identity.
 
@@ -205,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`
@@ -277,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.
 
@@ -289,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/interfaces/IIdentityServiceConfig.md

@@ -9,17 +9,3 @@ Configuration for the Identity Service.
 > `optional` **defaultNamespace?**: `string`
 
 The default connector namespace to use for identity operations. If not provided, the first registered connector is used.
-
-***
-
-### healthIntervalMs? {#healthintervalms}
-
-> `optional` **healthIntervalMs?**: `number`
-
-The minimum interval in ms between full application-level health checks (DID create, resolve, remove).
-
-#### Default
-
-```ts
-300000
-```

package/docs/reference/interfaces/IIdentityServiceConstructorOptions.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-service",
-	"version": "0.9.2-next.3",
+	"version": "0.9.2-next.4",
 	"description": "Service contracts and REST endpoint definitions for exposing identity workflows through stable interfaces.",
 	"repository": {
 		"type": "git",
@@ -17,15 +17,16 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
+		"@twin.org/dlt-account": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/identity-models": "0.9.2-next.3",
+		"@twin.org/identity-models": "0.9.2-next.4",
+		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/telemetry-models": "next",
 		"@twin.org/vault-models": "next",
+		"@twin.org/wallet-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",