@twin.org/node-core 0.9.1-next.1 → 0.9.1-next.10

package/dist/types/commands/{nodeSetIdentity.d.ts → nodeIdentitySet.d.ts}

@@ -7,7 +7,7 @@ import type { INodeEngineState } from "../models/INodeEngineState.js";
  * Get the command definition parameters.
  * @param commandDefinitions The registered command definitions.
  */
-export declare function getCommandDefinitionNodeSetIdentity(commandDefinitions: {
+export declare function getCommandDefinitionNodeIdentitySet(commandDefinitions: {
     [id: string]: ICliCommandDefinition;
 }): void;
 /**
@@ -18,6 +18,6 @@ export declare function getCommandDefinitionNodeSetIdentity(commandDefinitions:
  * @param params.identity The DID to set for the node.
  * @returns A promise that resolves when the node identity has been persisted.
  */
-export declare function nodeSetIdentity(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: IEnvironmentVariables, params: {
+export declare function nodeIdentitySet(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: IEnvironmentVariables, params: {
     identity?: string;
 }): Promise<void>;

package/dist/types/commands/nodeOrgIdGet.d.ts

@@ -0,0 +1,19 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionNodeOrgIdGet(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for retrieving the organization ID currently assigned to the node.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @returns The node organization DID.
+ */
+export declare function nodeOrgIdGet(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: IEnvironmentVariables): Promise<string>;

package/dist/types/commands/{setNodeOrgId.d.ts → nodeOrgIdSet.d.ts}

@@ -7,7 +7,7 @@ import type { INodeEngineState } from "../models/INodeEngineState.js";
  * Get the command definition parameters.
  * @param commandDefinitions The registered command definitions.
  */
-export declare function getCommandDefinitionSetNodeOrgId(commandDefinitions: {
+export declare function getCommandDefinitionNodeOrgIdSet(commandDefinitions: {
     [id: string]: ICliCommandDefinition;
 }): void;
 /**
@@ -19,6 +19,6 @@ export declare function getCommandDefinitionSetNodeOrgId(commandDefinitions: {
  * @returns A promise that resolves when the node organization ID has been persisted.
  * @throws GeneralError if called while multi-tenant mode is enabled.
  */
-export declare function setNodeOrgId(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: IEnvironmentVariables, params: {
+export declare function nodeOrgIdSet(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: IEnvironmentVariables, params: {
     organizationId?: string;
 }): Promise<void>;

package/dist/types/commands/orgUsersList.d.ts

@@ -0,0 +1,27 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionOrgUsersList(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for listing all users belonging to a given organization DID.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.orgDid The organization DID to filter by. Defaults to the node organization ID in single-tenant mode.
+ * @returns The list of users for the organization.
+ */
+export declare function orgUsersList(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: IEnvironmentVariables, params: {
+    orgDid?: string;
+}): Promise<{
+    email: string;
+    identity: string;
+    scope: string;
+}[]>;

package/dist/types/commands/tenantGet.d.ts

@@ -0,0 +1,22 @@
+import type { ITenant } from "@twin.org/api-models";
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionTenantGet(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for retrieving a single tenant by ID.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.tenantId The ID of the tenant to retrieve.
+ * @returns The tenant record.
+ */
+export declare function tenantGet(engineCore: IEngineCore, envVars: IEnvironmentVariables, params: {
+    tenantId?: string;
+}): Promise<ITenant>;

package/dist/types/commands/tenantList.d.ts

@@ -0,0 +1,22 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionTenantList(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for listing all tenants.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @returns The list of tenants.
+ */
+export declare function tenantList(engineCore: IEngineCore, envVars: IEnvironmentVariables): Promise<{
+    id: string;
+    apiKey: string;
+    organizationId: string;
+    label: string;
+}[]>;

package/dist/types/commands/tenantListByOrg.d.ts

@@ -0,0 +1,22 @@
+import type { ITenant } from "@twin.org/api-models";
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionTenantListByOrg(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for listing all tenants associated with an organization DID.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.orgId The organization DID to filter by.
+ * @returns The matching tenants.
+ */
+export declare function tenantListByOrg(engineCore: IEngineCore, envVars: IEnvironmentVariables, params: {
+    orgId?: string;
+}): Promise<ITenant[]>;

package/dist/types/commands/{setTenantOrgId.d.ts → tenantOrgIdSet.d.ts}

@@ -5,7 +5,7 @@ import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
  * Get the command definition parameters.
  * @param commandDefinitions The registered command definitions.
  */
-export declare function getCommandDefinitionSetTenantOrgId(commandDefinitions: {
+export declare function getCommandDefinitionTenantOrgIdSet(commandDefinitions: {
     [id: string]: ICliCommandDefinition;
 }): void;
 /**
@@ -17,7 +17,7 @@ export declare function getCommandDefinitionSetTenantOrgId(commandDefinitions: {
  * @param params.organizationId The organization ID to set.
  * @returns A promise that resolves when the tenant organization ID has been stored.
  */
-export declare function setTenantOrgId(engineCore: IEngineCore, envVars: IEnvironmentVariables, params: {
+export declare function tenantOrgIdSet(engineCore: IEngineCore, envVars: IEnvironmentVariables, params: {
     tenantId?: string;
     organizationId?: string;
 }): Promise<void>;

package/dist/types/commands/userGet.d.ts

@@ -0,0 +1,24 @@
+import type { IAuthenticationUser } from "@twin.org/api-auth-entity-storage-models";
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { IEnvironmentVariables } from "../models/IEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionUserGet(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for retrieving a single user by email address.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.email The email address of the user to retrieve.
+ * @param params.tenantId The tenant ID (multi-tenant mode only).
+ * @returns The user record.
+ */
+export declare function userGet(engineCore: IEngineCore, envVars: IEnvironmentVariables, params: {
+    email?: string;
+    tenantId?: string;
+}): Promise<IAuthenticationUser>;

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

@@ -22,6 +22,10 @@ export interface ICliCommandDefinition {
      * The params available for the command.
      */
     params: ICliCommandDefinitionParam[];
+    /**
+     * Deprecated names that resolve to this command with a warning.
+     */
+    aliases?: string[];
     /**
      * The method to execute for the command.
      */
@@ -43,4 +47,8 @@ export interface ICliCommandDefinition {
      * @default true
      */
     requiresOrgIdentity?: boolean;
+    /**
+     * Indicates whether this command is only available in single-tenant mode.
+     */
+    singleTenantOnly?: boolean;
 }

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

@@ -289,7 +289,7 @@ export interface IEngineEnvironmentVariables {
      */
     hashicorpVaultEndpoint?: string;
     /**
-     * The type of logging task connector, can be a comma separated list: console, entity-storage.
+     * The type of logging task connector, can be a comma separated list: console, entity-storage, otel, file.
      */
     loggingConnector?: string;
     /**
@@ -304,6 +304,22 @@ export interface IEngineEnvironmentVariables {
      * A list of components to exclude from logging, can be a comma separated list of component Class names e.g. "ComponentA,ComponentB".
      */
     loggingSilentComponents?: string;
+    /**
+     * The directory to write log files into when using the file logging connector. Required when TWIN_LOGGING_CONNECTOR includes "file".
+     */
+    loggingFileDirectory?: string;
+    /**
+     * The log filename when using the file logging connector, defaults to "app.log".
+     */
+    loggingFileFilename?: string;
+    /**
+     * The maximum log file size in bytes before rotation when using the file logging connector, defaults to 10485760 (10 MB). Set to 0 or negative to disable rotation.
+     */
+    loggingFileMaxFileSizeBytes?: string;
+    /**
+     * The number of rotated log files to retain when using the file logging connector, defaults to 5. Set to 0 or negative to keep all rotated files.
+     */
+    loggingFileMaxRetainedFiles?: string;
     /**
      * The name of the OpenTelemetry logger, only required if using open-telemetry as logging connector, defaults to twin-logging.
      */
@@ -428,6 +444,10 @@ export interface IEngineEnvironmentVariables {
      * The index of the wallet address to use, defaults to 0.
      */
     identityWalletAddressIndex?: string;
+    /**
+     * The TTL in milliseconds for caching resolved DIDs when using the IOTA identity connector. Omit to use the connector default.
+     */
+    identityDidResolutionCacheTtlMs?: string;
     /**
      * The type of identity resolver connector: entity-storage, iota.
      */
@@ -448,6 +468,14 @@ export interface IEngineEnvironmentVariables {
      * IOTA coin type.
      */
     iotaCoinType?: string;
+    /**
+     * IOTA gas budget, in nanos.
+     */
+    iotaGasBudget?: string;
+    /**
+     * IOTA gas reservation duration, in seconds.
+     */
+    iotaGasReservationDuration?: string;
     /**
      * IOTA Explorer Endpoint.
      */
@@ -524,6 +552,10 @@ export interface IEngineEnvironmentVariables {
      * Federated catalog remote endpoint, if set will use a REST client instead of local service.
      */
     federatedCatalogueRemoteEndpoint?: string;
+    /**
+     * The path prefix used by the federated catalogue REST client when forwarding requests to the remote endpoint, defaults to "federated-catalogue".
+     */
+    federatedCatalogueRestClientPathPrefix?: string;
     /**
      * The trust generators to add to the factory, comma separated list.
      */
@@ -604,10 +636,18 @@ export interface IEngineEnvironmentVariables {
      */
     dataspaceActivityLogsCleanupInterval?: string;
     /**
-     * The data plane path for PULL transfers (path only, not full URL).
-     * Will be combined with public origin.
-     * Required if PULL transfers should be supported.
-     * Example: "dataspace/entities"
+     * Base route path for the data plane service (path only, not full URL).
+     * Combined with the public origin to form the `dataAddress.endpoint` sent to PULL consumers
+     * and the inbox URL sent to PUSH providers.
+     *
+     * This must be the mount-point prefix of the data plane routes, NOT a specific route path.
+     * Do NOT append sub-paths such as `/entities` or `/inbox` — those are appended automatically
+     * by each transfer handler and by the data plane REST client.
+     *
+     * REQUIRED if PULL or PUSH transfers are supported.
+     * If not specified, PULL and PUSH transfers will not be available.
+     *
+     * Example: "dataspace"
      */
     dataspaceDataPlanePath?: string;
     /**

package/docs/changelog.md

@@ -1,5 +1,70 @@
 # Changelog
 
+## [0.9.1-next.10](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.9...node-core-v0.9.1-next.10) (2026-07-21)
+
+
+### Features
+
+* update dependencies ([64c8ea8](https://github.com/iotaledger/twin-node/commit/64c8ea8c8b5e918f7ad419c4e3b8d08faf5e3fdd))
+
+## [0.9.1-next.9](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.8...node-core-v0.9.1-next.9) (2026-07-21)
+
+
+### Features
+
+* enhanced cli commands ([#288](https://github.com/iotaledger/twin-node/issues/288)) ([479fb34](https://github.com/iotaledger/twin-node/commit/479fb3448c493a134aee35b69ae39458e493a4ad))
+* expose gasBudget and gasReservationDuration as configurable env vars ([#286](https://github.com/iotaledger/twin-node/issues/286)) ([d678b27](https://github.com/iotaledger/twin-node/commit/d678b27d629930a6ce85eeab9caf89d1187c3461))
+* file logging config ([#287](https://github.com/iotaledger/twin-node/issues/287)) ([a567b25](https://github.com/iotaledger/twin-node/commit/a567b253cbb8b9af872bb0e494c013212f4f55a2))
+
+## [0.9.1-next.8](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.7...node-core-v0.9.1-next.8) (2026-07-10)
+
+
+### Miscellaneous Chores
+
+* **node-core:** Synchronize repo versions
+
+## [0.9.1-next.7](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.6...node-core-v0.9.1-next.7) (2026-07-08)
+
+
+### Bug Fixes
+
+* update dependencies ([#279](https://github.com/iotaledger/twin-node/issues/279)) ([2c0de07](https://github.com/iotaledger/twin-node/commit/2c0de07a15541e73612ba5bd62f4f566e4efca34))
+
+## [0.9.1-next.6](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.5...node-core-v0.9.1-next.6) (2026-07-03)
+
+
+### Features
+
+* use core env helpers ([568fbc5](https://github.com/iotaledger/twin-node/commit/568fbc53906b022bc8465ffb941a160075d88e96))
+
+## [0.9.1-next.5](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.4...node-core-v0.9.1-next.5) (2026-07-02)
+
+
+### Features
+
+* dataspace plane path ([#272](https://github.com/iotaledger/twin-node/issues/272)) ([5998eeb](https://github.com/iotaledger/twin-node/commit/5998eeb6fa1392ae753eb6bafeccefa1fb690573))
+
+## [0.9.1-next.4](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.3...node-core-v0.9.1-next.4) (2026-07-01)
+
+
+### Features
+
+* additional cli commands ([#269](https://github.com/iotaledger/twin-node/issues/269)) ([c9e7c93](https://github.com/iotaledger/twin-node/commit/c9e7c939aedfceed9cbe501f2dc936e84289ed62))
+
+## [0.9.1-next.3](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.2...node-core-v0.9.1-next.3) (2026-06-30)
+
+
+### Features
+
+* add new endpoints ([cc6e30d](https://github.com/iotaledger/twin-node/commit/cc6e30d85f7ed8018697462a7100e5c2f4e8f407))
+
+## [0.9.1-next.2](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.1...node-core-v0.9.1-next.2) (2026-06-29)
+
+
+### Features
+
+* update components ([35cdfdc](https://github.com/iotaledger/twin-node/commit/35cdfdcba2b52599b4db3afd8c9e6dd17468b21e))
+
 ## [0.9.1-next.1](https://github.com/iotaledger/twin-node/compare/node-core-v0.9.1-next.0...node-core-v0.9.1-next.1) (2026-06-26)
 
 

package/docs/reference/interfaces/ICliCommandDefinition.md

@@ -36,6 +36,14 @@ The params available for the command.
 
 ***
 
+### aliases? {#aliases}
+
+> `optional` **aliases?**: `string`[]
+
+Deprecated names that resolve to this command with a warning.
+
+***
+
 ### action {#action}
 
 > **action**: (`engineCore`, `envVars`, `params`) => `Promise`\<`unknown`\>
@@ -99,3 +107,11 @@ Indicates whether the engine needs the organization identity to be set.
 ```ts
 true
 ```
+
+***
+
+### singleTenantOnly? {#singletenantonly}
+
+> `optional` **singleTenantOnly?**: `boolean`
+
+Indicates whether this command is only available in single-tenant mode.

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -575,7 +575,7 @@ Hashicorp Vault endpoint.
 
 > `optional` **loggingConnector?**: `string`
 
-The type of logging task connector, can be a comma separated list: console, entity-storage.
+The type of logging task connector, can be a comma separated list: console, entity-storage, otel, file.
 
 ***
 
@@ -603,6 +603,38 @@ A list of components to exclude from logging, can be a comma separated list of c
 
 ***
 
+### loggingFileDirectory? {#loggingfiledirectory}
+
+> `optional` **loggingFileDirectory?**: `string`
+
+The directory to write log files into when using the file logging connector. Required when TWIN_LOGGING_CONNECTOR includes "file".
+
+***
+
+### loggingFileFilename? {#loggingfilefilename}
+
+> `optional` **loggingFileFilename?**: `string`
+
+The log filename when using the file logging connector, defaults to "app.log".
+
+***
+
+### loggingFileMaxFileSizeBytes? {#loggingfilemaxfilesizebytes}
+
+> `optional` **loggingFileMaxFileSizeBytes?**: `string`
+
+The maximum log file size in bytes before rotation when using the file logging connector, defaults to 10485760 (10 MB). Set to 0 or negative to disable rotation.
+
+***
+
+### loggingFileMaxRetainedFiles? {#loggingfilemaxretainedfiles}
+
+> `optional` **loggingFileMaxRetainedFiles?**: `string`
+
+The number of rotated log files to retain when using the file logging connector, defaults to 5. Set to 0 or negative to keep all rotated files.
+
+***
+
 ### openTelemetryLoggingLoggerName? {#opentelemetryloggingloggername}
 
 > `optional` **openTelemetryLoggingLoggerName?**: `string`
@@ -851,6 +883,14 @@ The index of the wallet address to use, defaults to 0.
 
 ***
 
+### identityDidResolutionCacheTtlMs? {#identitydidresolutioncachettlms}
+
+> `optional` **identityDidResolutionCacheTtlMs?**: `string`
+
+The TTL in milliseconds for caching resolved DIDs when using the IOTA identity connector. Omit to use the connector default.
+
+***
+
 ### identityResolverConnector? {#identityresolverconnector}
 
 > `optional` **identityResolverConnector?**: `string`
@@ -891,6 +931,22 @@ IOTA coin type.
 
 ***
 
+### iotaGasBudget? {#iotagasbudget}
+
+> `optional` **iotaGasBudget?**: `string`
+
+IOTA gas budget, in nanos.
+
+***
+
+### iotaGasReservationDuration? {#iotagasreservationduration}
+
+> `optional` **iotaGasReservationDuration?**: `string`
+
+IOTA gas reservation duration, in seconds.
+
+***
+
 ### iotaExplorerEndpoint? {#iotaexplorerendpoint}
 
 > `optional` **iotaExplorerEndpoint?**: `string`
@@ -1043,6 +1099,14 @@ Federated catalog remote endpoint, if set will use a REST client instead of loca
 
 ***
 
+### federatedCatalogueRestClientPathPrefix? {#federatedcataloguerestclientpathprefix}
+
+> `optional` **federatedCatalogueRestClientPathPrefix?**: `string`
+
+The path prefix used by the federated catalogue REST client when forwarding requests to the remote endpoint, defaults to "federated-catalogue".
+
+***
+
 ### trustGenerators? {#trustgenerators}
 
 > `optional` **trustGenerators?**: `string`
@@ -1204,10 +1268,18 @@ The interval in seconds for cleaning up the activity logs.
 
 > `optional` **dataspaceDataPlanePath?**: `string`
 
-The data plane path for PULL transfers (path only, not full URL).
-Will be combined with public origin.
-Required if PULL transfers should be supported.
-Example: "dataspace/entities"
+Base route path for the data plane service (path only, not full URL).
+Combined with the public origin to form the `dataAddress.endpoint` sent to PULL consumers
+and the inbox URL sent to PUSH providers.
+
+This must be the mount-point prefix of the data plane routes, NOT a specific route path.
+Do NOT append sub-paths such as `/entities` or `/inbox` — those are appended automatically
+by each transfer handler and by the data plane REST client.
+
+REQUIRED if PULL or PUSH transfers are supported.
+If not specified, PULL and PUSH transfers will not be available.
+
+Example: "dataspace"
 
 ***