@twin.org/node-core 0.0.3-next.33 → 0.0.3-next.35

package/docs/reference/functions/isAuthEntityStorageRequired.md

@@ -0,0 +1,20 @@
+# Function: isAuthEntityStorageRequired()
+
+> **isAuthEntityStorageRequired**(`envVars`): `boolean`
+
+Checks if the authentication entity storage subsystem is required.
+Returns true when any component that depends on the authentication entity storage subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if authentication entity storage is enabled.

package/docs/reference/functions/isAutomationRequired.md

@@ -0,0 +1,20 @@
+# Function: isAutomationRequired()
+
+> **isAutomationRequired**(`envVars`): `boolean`
+
+Checks if the automation subsystem is required.
+Returns true when any component that depends on the automation subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if automation is enabled.

package/docs/reference/functions/isBackgroundTasksRequired.md

@@ -0,0 +1,20 @@
+# Function: isBackgroundTasksRequired()
+
+> **isBackgroundTasksRequired**(`envVars`): `boolean`
+
+Checks if the background tasks subsystem is required.
+Returns true when any component that depends on the background tasks subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if dataspace or verifiable storage is enabled.

package/docs/reference/functions/isFederatedCatalogueRequired.md

@@ -0,0 +1,20 @@
+# Function: isFederatedCatalogueRequired()
+
+> **isFederatedCatalogueRequired**(`envVars`): `boolean`
+
+Checks if the immutable proof subsystem is required.
+Returns true when any component that depends on the immutable proof subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if verifiable storage is enabled.

package/docs/reference/functions/isImmutableProofRequired.md

@@ -0,0 +1,20 @@
+# Function: isImmutableProofRequired()
+
+> **isImmutableProofRequired**(`envVars`): `boolean`
+
+Checks if the immutable proof subsystem is required.
+Returns true when any component that depends on the immutable proof subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if verifiable storage is enabled.

package/docs/reference/functions/isRightsManagementRequired.md

@@ -0,0 +1,20 @@
+# Function: isRightsManagementRequired()
+
+> **isRightsManagementRequired**(`envVars`): `boolean`
+
+Checks if the rights management subsystem is required.
+Returns true when any component that depends on the rights management subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if rights management is enabled.

package/docs/reference/functions/isTaskSchedulerRequired.md

@@ -0,0 +1,20 @@
+# Function: isTaskSchedulerRequired()
+
+> **isTaskSchedulerRequired**(`envVars`): `boolean`
+
+Checks if the task scheduler subsystem is required.
+Returns true when any component that depends on the task scheduler subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if task scheduler is enabled.

package/docs/reference/functions/isTrustRequired.md

@@ -0,0 +1,20 @@
+# Function: isTrustRequired()
+
+> **isTrustRequired**(`envVars`): `boolean`
+
+Checks if the trust subsystem is required.
+Returns true when any component that depends on the trust subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if rights-management, synchronised-storage, or dataspace is enabled.

package/docs/reference/functions/isUrlTransformerRequired.md

@@ -0,0 +1,20 @@
+# Function: isUrlTransformerRequired()
+
+> **isUrlTransformerRequired**(`envVars`): `boolean`
+
+Checks if the URL transformer subsystem is required.
+Returns true when any component that depends on the URL transformer subsystem is enabled.
+
+## Parameters
+
+### envVars
+
+[`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`boolean`
+
+True if rights-management, dataspace, federated-catalogue, or tenant is enabled.

package/docs/reference/index.md

@@ -33,6 +33,7 @@
 - [SYNCHRONISED\_STORAGE\_BLOB\_STORAGE\_ENCRYPTION\_KEY\_ID](variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md)
 - [TRUST\_VERIFICATION\_METHOD\_ID](variables/TRUST_VERIFICATION_METHOD_ID.md)
 - [AUTH\_SIGNING\_KEY\_ID](variables/AUTH_SIGNING_KEY_ID.md)
+- [URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID](variables/URL_TRANSFORMER_ENCRYPTION_KEY_ID.md)
 - [CONTEXT\_ID\_HANDLER\_FEATURE\_DID](variables/CONTEXT_ID_HANDLER_FEATURE_DID.md)
 - [CONTEXT\_ID\_HANDLER\_FEATURE\_TENANT](variables/CONTEXT_ID_HANDLER_FEATURE_TENANT.md)
 - [ModuleProtocol](variables/ModuleProtocol.md)
@@ -40,7 +41,16 @@
 ## Functions
 
 - [buildEngineConfiguration](functions/buildEngineConfiguration.md)
+- [isTrustRequired](functions/isTrustRequired.md)
+- [isUrlTransformerRequired](functions/isUrlTransformerRequired.md)
+- [isBackgroundTasksRequired](functions/isBackgroundTasksRequired.md)
+- [isImmutableProofRequired](functions/isImmutableProofRequired.md)
+- [isFederatedCatalogueRequired](functions/isFederatedCatalogueRequired.md)
+- [isRightsManagementRequired](functions/isRightsManagementRequired.md)
+- [isTaskSchedulerRequired](functions/isTaskSchedulerRequired.md)
+- [isAutomationRequired](functions/isAutomationRequired.md)
 - [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
+- [isAuthEntityStorageRequired](functions/isAuthEntityStorageRequired.md)
 - [extensionsConfiguration](functions/extensionsConfiguration.md)
 - [extensionsInitialiseEngine](functions/extensionsInitialiseEngine.md)
 - [extensionsInitialiseEngineServer](functions/extensionsInitialiseEngineServer.md)

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -982,14 +982,6 @@ The maximum number of consolidations to keep in storage, only used if this is a
 
 ***
 
-### federatedCatalogueEnabled? {#federatedcatalogueenabled}
-
-> `optional` **federatedCatalogueEnabled?**: `string`
-
-Is the federated catalogue enabled, defaults to false.
-
-***
-
 ### federatedCatalogueFilters? {#federatedcataloguefilters}
 
 > `optional` **federatedCatalogueFilters?**: `string`
@@ -998,14 +990,6 @@ Federated catalog filters, command separated list of filters to add.
 
 ***
 
-### trustEnabled? {#trustenabled}
-
-> `optional` **trustEnabled?**: `string`
-
-Is the trust management enabled, defaults to false.
-
-***
-
 ### trustGenerators? {#trustgenerators}
 
 > `optional` **trustGenerators?**: `string`
@@ -1040,19 +1024,18 @@ Defaults to undefined for never expiring.
 
 ***
 
-### rightsManagementEnabled? {#rightsmanagementenabled}
-
-> `optional` **rightsManagementEnabled?**: `string`
-
-Is the rights management enabled, defaults to false.
-
-***
-
 ### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
 
 > `optional` **rightsManagementCallbackPath?**: `string`
 
-What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
+Path under which the rights management service is mounted (single source
+of truth). The same value drives:
+- the server route mount (via engine config)
+- the PNP service's callback URL builder (`buildCallbackUrl`)
+- the PNP rest-client's pathPrefix (consumer side)
+Defaults to `rights-management`. Set when deploying behind a reverse proxy
+with path rewriting, K8s ingress with path-based routing, or any custom
+mount point.
 
 ***
 
@@ -1112,22 +1095,6 @@ The rights management policy obligation enforcers to add to the factory.
 
 ***
 
-### backgroundTasksEnabled? {#backgroundtasksenabled}
-
-> `optional` **backgroundTasksEnabled?**: `string`
-
-Are background tasks enabled, defaults to false.
-
-***
-
-### taskSchedulerEnabled? {#taskschedulerenabled}
-
-> `optional` **taskSchedulerEnabled?**: `string`
-
-Is the task scheduler enabled, defaults to false.
-
-***
-
 ### dataspaceEnabled? {#dataspaceenabled}
 
 > `optional` **dataspaceEnabled?**: `string`
@@ -1175,11 +1142,27 @@ Example: "dataspace/entities"
 
 ***
 
-### automationEnabled? {#automationenabled}
+### healthEnabled? {#healthenabled}
+
+> `optional` **healthEnabled?**: `string`
+
+Are the health components enabled, defaults to false.
+
+***
+
+### healthIntervalSeconds? {#healthintervalseconds}
+
+> `optional` **healthIntervalSeconds?**: `string`
+
+The interval in seconds for performing health checks, defaults to 60.
+
+***
+
+### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
 
-> `optional` **automationEnabled?**: `string`
+> `optional` **urlTransformerEncryptionKeyId?**: `string`
 
-Are the automation components enabled, defaults to false.
+The id of the key in the vault to use for encrypting parameters in url transformer.
 
 ***
 

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -1458,18 +1458,6 @@ The maximum number of consolidations to keep in storage, only used if this is a
 
 ***
 
-### federatedCatalogueEnabled? {#federatedcatalogueenabled}
-
-> `optional` **federatedCatalogueEnabled?**: `string`
-
-Is the federated catalogue enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineEnvironmentVariables.md#federatedcatalogueenabled)
-
-***
-
 ### federatedCatalogueFilters? {#federatedcataloguefilters}
 
 > `optional` **federatedCatalogueFilters?**: `string`
@@ -1482,18 +1470,6 @@ Federated catalog filters, command separated list of filters to add.
 
 ***
 
-### trustEnabled? {#trustenabled}
-
-> `optional` **trustEnabled?**: `string`
-
-Is the trust management enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`trustEnabled`](IEngineEnvironmentVariables.md#trustenabled)
-
-***
-
 ### trustGenerators? {#trustgenerators}
 
 > `optional` **trustGenerators?**: `string`
@@ -1544,23 +1520,18 @@ Defaults to undefined for never expiring.
 
 ***
 
-### rightsManagementEnabled? {#rightsmanagementenabled}
-
-> `optional` **rightsManagementEnabled?**: `string`
-
-Is the rights management enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineEnvironmentVariables.md#rightsmanagementenabled)
-
-***
-
 ### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
 
 > `optional` **rightsManagementCallbackPath?**: `string`
 
-What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
+Path under which the rights management service is mounted (single source
+of truth). The same value drives:
+- the server route mount (via engine config)
+- the PNP service's callback URL builder (`buildCallbackUrl`)
+- the PNP rest-client's pathPrefix (consumer side)
+Defaults to `rights-management`. Set when deploying behind a reverse proxy
+with path rewriting, K8s ingress with path-based routing, or any custom
+mount point.
 
 #### Inherited from
 
@@ -1652,30 +1623,6 @@ The rights management policy obligation enforcers to add to the factory.
 
 ***
 
-### backgroundTasksEnabled? {#backgroundtasksenabled}
-
-> `optional` **backgroundTasksEnabled?**: `string`
-
-Are background tasks enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineEnvironmentVariables.md#backgroundtasksenabled)
-
-***
-
-### taskSchedulerEnabled? {#taskschedulerenabled}
-
-> `optional` **taskSchedulerEnabled?**: `string`
-
-Is the task scheduler enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineEnvironmentVariables.md#taskschedulerenabled)
-
-***
-
 ### dataspaceEnabled? {#dataspaceenabled}
 
 > `optional` **dataspaceEnabled?**: `string`
@@ -1739,15 +1686,39 @@ Example: "dataspace/entities"
 
 ***
 
-### automationEnabled? {#automationenabled}
+### healthEnabled? {#healthenabled}
+
+> `optional` **healthEnabled?**: `string`
+
+Are the health components enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthEnabled`](IEngineEnvironmentVariables.md#healthenabled)
+
+***
+
+### healthIntervalSeconds? {#healthintervalseconds}
 
-> `optional` **automationEnabled?**: `string`
+> `optional` **healthIntervalSeconds?**: `string`
 
-Are the automation components enabled, defaults to false.
+The interval in seconds for performing health checks, defaults to 60.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`automationEnabled`](IEngineEnvironmentVariables.md#automationenabled)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineEnvironmentVariables.md#healthintervalseconds)
+
+***
+
+### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
+
+> `optional` **urlTransformerEncryptionKeyId?**: `string`
+
+The id of the key in the vault to use for encrypting parameters in url transformer.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`urlTransformerEncryptionKeyId`](IEngineEnvironmentVariables.md#urltransformerencryptionkeyid)
 
 ***
 
@@ -1856,6 +1827,14 @@ The id of the key in the vault to use for signing in auth operations.
 
 ***
 
+### hostingParamEncryptionKeyId? {#hostingparamencryptionkeyid}
+
+> `optional` **hostingParamEncryptionKeyId?**: `string`
+
+The id of the key in the vault to use for encrypting hosting parameters in auth operations.
+
+***
+
 ### mimeTypeProcessors? {#mimetypeprocessors}
 
 > `optional` **mimeTypeProcessors?**: `string`

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -1454,18 +1454,6 @@ The maximum number of consolidations to keep in storage, only used if this is a
 
 ***
 
-### federatedCatalogueEnabled? {#federatedcatalogueenabled}
-
-> `optional` **federatedCatalogueEnabled?**: `string`
-
-Is the federated catalogue enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`federatedCatalogueEnabled`](IEngineServerEnvironmentVariables.md#federatedcatalogueenabled)
-
-***
-
 ### federatedCatalogueFilters? {#federatedcataloguefilters}
 
 > `optional` **federatedCatalogueFilters?**: `string`
@@ -1478,18 +1466,6 @@ Federated catalog filters, command separated list of filters to add.
 
 ***
 
-### trustEnabled? {#trustenabled}
-
-> `optional` **trustEnabled?**: `string`
-
-Is the trust management enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`trustEnabled`](IEngineServerEnvironmentVariables.md#trustenabled)
-
-***
-
 ### trustGenerators? {#trustgenerators}
 
 > `optional` **trustGenerators?**: `string`
@@ -1540,23 +1516,18 @@ Defaults to undefined for never expiring.
 
 ***
 
-### rightsManagementEnabled? {#rightsmanagementenabled}
-
-> `optional` **rightsManagementEnabled?**: `string`
-
-Is the rights management enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`rightsManagementEnabled`](IEngineServerEnvironmentVariables.md#rightsmanagementenabled)
-
-***
-
 ### rightsManagementCallbackPath? {#rightsmanagementcallbackpath}
 
 > `optional` **rightsManagementCallbackPath?**: `string`
 
-What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
+Path under which the rights management service is mounted (single source
+of truth). The same value drives:
+- the server route mount (via engine config)
+- the PNP service's callback URL builder (`buildCallbackUrl`)
+- the PNP rest-client's pathPrefix (consumer side)
+Defaults to `rights-management`. Set when deploying behind a reverse proxy
+with path rewriting, K8s ingress with path-based routing, or any custom
+mount point.
 
 #### Inherited from
 
@@ -1648,30 +1619,6 @@ The rights management policy obligation enforcers to add to the factory.
 
 ***
 
-### backgroundTasksEnabled? {#backgroundtasksenabled}
-
-> `optional` **backgroundTasksEnabled?**: `string`
-
-Are background tasks enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`backgroundTasksEnabled`](IEngineServerEnvironmentVariables.md#backgroundtasksenabled)
-
-***
-
-### taskSchedulerEnabled? {#taskschedulerenabled}
-
-> `optional` **taskSchedulerEnabled?**: `string`
-
-Is the task scheduler enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`taskSchedulerEnabled`](IEngineServerEnvironmentVariables.md#taskschedulerenabled)
-
-***
-
 ### dataspaceEnabled? {#dataspaceenabled}
 
 > `optional` **dataspaceEnabled?**: `string`
@@ -1735,15 +1682,39 @@ Example: "dataspace/entities"
 
 ***
 
-### automationEnabled? {#automationenabled}
+### healthEnabled? {#healthenabled}
+
+> `optional` **healthEnabled?**: `string`
+
+Are the health components enabled, defaults to false.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`healthEnabled`](IEngineServerEnvironmentVariables.md#healthenabled)
+
+***
+
+### healthIntervalSeconds? {#healthintervalseconds}
 
-> `optional` **automationEnabled?**: `string`
+> `optional` **healthIntervalSeconds?**: `string`
 
-Are the automation components enabled, defaults to false.
+The interval in seconds for performing health checks, defaults to 60.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`automationEnabled`](IEngineServerEnvironmentVariables.md#automationenabled)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineServerEnvironmentVariables.md#healthintervalseconds)
+
+***
+
+### urlTransformerEncryptionKeyId? {#urltransformerencryptionkeyid}
+
+> `optional` **urlTransformerEncryptionKeyId?**: `string`
+
+The id of the key in the vault to use for encrypting parameters in url transformer.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`urlTransformerEncryptionKeyId`](IEngineServerEnvironmentVariables.md#urltransformerencryptionkeyid)
 
 ***
 
@@ -1892,6 +1863,18 @@ The id of the key in the vault to use for signing in auth operations.
 
 ***
 
+### hostingParamEncryptionKeyId? {#hostingparamencryptionkeyid}
+
+> `optional` **hostingParamEncryptionKeyId?**: `string`
+
+The id of the key in the vault to use for encrypting hosting parameters in auth operations.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`hostingParamEncryptionKeyId`](IEngineServerEnvironmentVariables.md#hostingparamencryptionkeyid)
+
+***
+
 ### mimeTypeProcessors? {#mimetypeprocessors}
 
 > `optional` **mimeTypeProcessors?**: `string`

package/docs/reference/variables/URL_TRANSFORMER_ENCRYPTION_KEY_ID.md

@@ -0,0 +1,3 @@
+# Variable: URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID
+
+> `const` **URL\_TRANSFORMER\_ENCRYPTION\_KEY\_ID**: `"param-encryption"` = `"param-encryption"`

package/locales/en.json

@@ -104,7 +104,8 @@
 						"attestationMethodCreate": "Creating attestation method for organisation identity",
 						"immutableProofMethodCreate": "Creating immutable proof method for organisation identity",
 						"adminIdentityCreate": "Creating admin user identity",
-						"adminUserCreate": "Creating admin user"
+						"adminUserCreate": "Creating admin user",
+						"urlTransformParamKeyAdd": "Adding URL transform parameter encryption key"
 					}
 				},
 				"identity-create": {

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.3-next.33",
+	"version": "0.0.3-next.35",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/node.git",
+		"url": "git+https://github.com/iotaledger/node.git",
 		"directory": "packages/node-core"
 	},
 	"author": "martyn.janes@iota.org",
@@ -68,7 +68,7 @@
 		"utilities"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/node/issues"
+		"url": "git+https://github.com/iotaledger/node/issues"
 	},
 	"homepage": "https://twindev.org"
 }