@twin.org/node-core 0.0.3-next.34 → 0.0.3-next.36

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -674,6 +674,38 @@ The type of telemetry connector: entity-storage.
 
 ***
 
+### openTelemetryMeterName? {#opentelemetrymetername}
+
+> `optional` **openTelemetryMeterName?**: `string`
+
+The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
+
+***
+
+### openTelemetryMeterVersion? {#opentelemetrymeterversion}
+
+> `optional` **openTelemetryMeterVersion?**: `string`
+
+The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
+
+***
+
+### openTelemetryReader? {#opentelemetryreader}
+
+> `optional` **openTelemetryReader?**: `string`
+
+The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
+
+***
+
+### openTelemetryPrometheusPort? {#opentelemetryprometheusport}
+
+> `optional` **openTelemetryPrometheusPort?**: `string`
+
+The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.
+
+***
+
 ### faucetConnector? {#faucetconnector}
 
 > `optional` **faucetConnector?**: `string`
@@ -982,14 +1014,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 +1022,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 +1056,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 +1127,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,14 +1174,6 @@ Example: "dataspace/entities"
 
 ***
 
-### automationEnabled? {#automationenabled}
-
-> `optional` **automationEnabled?**: `string`
-
-Are the automation components enabled, defaults to false.
-
-***
-
 ### healthEnabled? {#healthenabled}
 
 > `optional` **healthEnabled?**: `string`
@@ -1191,11 +1182,11 @@ Are the health components enabled, defaults to false.
 
 ***
 
-### urlTransformerEnabled? {#urltransformerenabled}
+### healthIntervalSeconds? {#healthintervalseconds}
 
-> `optional` **urlTransformerEnabled?**: `string`
+> `optional` **healthIntervalSeconds?**: `string`
 
-Is the url transformer enabled, defaults to false.
+The interval in seconds for performing health checks, defaults to 60.
 
 ***
 

package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md

@@ -1010,6 +1010,54 @@ The type of telemetry connector: entity-storage.
 
 ***
 
+### openTelemetryMeterName? {#opentelemetrymetername}
+
+> `optional` **openTelemetryMeterName?**: `string`
+
+The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterName`](IEngineEnvironmentVariables.md#opentelemetrymetername)
+
+***
+
+### openTelemetryMeterVersion? {#opentelemetrymeterversion}
+
+> `optional` **openTelemetryMeterVersion?**: `string`
+
+The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryMeterVersion`](IEngineEnvironmentVariables.md#opentelemetrymeterversion)
+
+***
+
+### openTelemetryReader? {#opentelemetryreader}
+
+> `optional` **openTelemetryReader?**: `string`
+
+The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryReader`](IEngineEnvironmentVariables.md#opentelemetryreader)
+
+***
+
+### openTelemetryPrometheusPort? {#opentelemetryprometheusport}
+
+> `optional` **openTelemetryPrometheusPort?**: `string`
+
+The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.
+
+#### Inherited from
+
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`openTelemetryPrometheusPort`](IEngineEnvironmentVariables.md#opentelemetryprometheusport)
+
+***
+
 ### faucetConnector? {#faucetconnector}
 
 > `optional` **faucetConnector?**: `string`
@@ -1458,18 +1506,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 +1518,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 +1568,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 +1671,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,18 +1734,6 @@ Example: "dataspace/entities"
 
 ***
 
-### automationEnabled? {#automationenabled}
-
-> `optional` **automationEnabled?**: `string`
-
-Are the automation components enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`automationEnabled`](IEngineEnvironmentVariables.md#automationenabled)
-
-***
-
 ### healthEnabled? {#healthenabled}
 
 > `optional` **healthEnabled?**: `string`
@@ -1763,15 +1746,15 @@ Are the health components enabled, defaults to false.
 
 ***
 
-### urlTransformerEnabled? {#urltransformerenabled}
+### healthIntervalSeconds? {#healthintervalseconds}
 
-> `optional` **urlTransformerEnabled?**: `string`
+> `optional` **healthIntervalSeconds?**: `string`
 
-Is the url transformer enabled, defaults to false.
+The interval in seconds for performing health checks, defaults to 60.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`urlTransformerEnabled`](IEngineEnvironmentVariables.md#urltransformerenabled)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineEnvironmentVariables.md#healthintervalseconds)
 
 ***
 
@@ -1892,6 +1875,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

@@ -1006,6 +1006,54 @@ The type of telemetry connector: entity-storage.
 
 ***
 
+### openTelemetryMeterName? {#opentelemetrymetername}
+
+> `optional` **openTelemetryMeterName?**: `string`
+
+The name of the Open Telemetry meter to use, only required if using open-telemetry as telemetry connector, defaults to twin-node.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`openTelemetryMeterName`](IEngineServerEnvironmentVariables.md#opentelemetrymetername)
+
+***
+
+### openTelemetryMeterVersion? {#opentelemetrymeterversion}
+
+> `optional` **openTelemetryMeterVersion?**: `string`
+
+The version of the Open Telemetry metrics specification to use, only required if using open-telemetry as telemetry connector, defaults to 1.0.0.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`openTelemetryMeterVersion`](IEngineServerEnvironmentVariables.md#opentelemetrymeterversion)
+
+***
+
+### openTelemetryReader? {#opentelemetryreader}
+
+> `optional` **openTelemetryReader?**: `string`
+
+The type of Open Telemetry metric reader to use, only required if using open-telemetry as telemetry connector, values: prometheus.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`openTelemetryReader`](IEngineServerEnvironmentVariables.md#opentelemetryreader)
+
+***
+
+### openTelemetryPrometheusPort? {#opentelemetryprometheusport}
+
+> `optional` **openTelemetryPrometheusPort?**: `string`
+
+The port to use for the Open Telemetry Prometheus metrics server, only required if using open-telemetry as telemetry connector and prometheus as reader, defaults to 9464.
+
+#### Inherited from
+
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`openTelemetryPrometheusPort`](IEngineServerEnvironmentVariables.md#opentelemetryprometheusport)
+
+***
+
 ### faucetConnector? {#faucetconnector}
 
 > `optional` **faucetConnector?**: `string`
@@ -1454,18 +1502,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 +1514,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 +1564,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 +1667,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,18 +1730,6 @@ Example: "dataspace/entities"
 
 ***
 
-### automationEnabled? {#automationenabled}
-
-> `optional` **automationEnabled?**: `string`
-
-Are the automation components enabled, defaults to false.
-
-#### Inherited from
-
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`automationEnabled`](IEngineServerEnvironmentVariables.md#automationenabled)
-
-***
-
 ### healthEnabled? {#healthenabled}
 
 > `optional` **healthEnabled?**: `string`
@@ -1759,15 +1742,15 @@ Are the health components enabled, defaults to false.
 
 ***
 
-### urlTransformerEnabled? {#urltransformerenabled}
+### healthIntervalSeconds? {#healthintervalseconds}
 
-> `optional` **urlTransformerEnabled?**: `string`
+> `optional` **healthIntervalSeconds?**: `string`
 
-Is the url transformer enabled, defaults to false.
+The interval in seconds for performing health checks, defaults to 60.
 
 #### Inherited from
 
-[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`urlTransformerEnabled`](IEngineServerEnvironmentVariables.md#urltransformerenabled)
+[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`healthIntervalSeconds`](IEngineServerEnvironmentVariables.md#healthintervalseconds)
 
 ***
 
@@ -1928,6 +1911,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/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.3-next.34",
+	"version": "0.0.3-next.36",
 	"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",
@@ -34,10 +34,11 @@
 		"@twin.org/rights-management-rest-client": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/standards-w3c-odrl": "next",
+		"@twin.org/telemetry-connector-opentelemetry": "next",
 		"@twin.org/trust-models": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-models": "next",
-		"dotenv": "17.3.1",
+		"dotenv": "17.4.2",
 		"schema-dts": "2.0.0"
 	},
 	"main": "./dist/es/index.js",
@@ -68,7 +69,7 @@
 		"utilities"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/node/issues"
+		"url": "git+https://github.com/iotaledger/node/issues"
 	},
 	"homepage": "https://twindev.org"
 }