@twin.org/node-core 0.0.3-next.6 → 0.0.3-next.60

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

@@ -8,15 +8,8 @@ export interface INodeEngineState extends IEngineState {
      */
     nodeId?: string;
     /**
-     * The tenant id for the node.
-     */
-    nodeTenantId?: string;
-    /**
-     * The identity for the organization.
+     * This is the default organization used in the context ids when a user is not authenticated.
+     * It is not used in multi-tenant mode, which gets the organization from the tenant table.
      */
     nodeOrganizationId?: string;
-    /**
-     * The identity for the admin user.
-     */
-    nodeAdminUserId?: string;
 }

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

@@ -3,44 +3,6 @@ import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironme
  * The environment variables for the node.
  */
 export interface INodeEnvironmentVariables extends IEngineServerEnvironmentVariables {
-    /**
-     * The features that are enabled on the node.
-     * @default []
-     */
-    features?: string;
-    /**
-     * The identity of the node which, if empty and node-identity feature is enabled it will be generated.
-     */
-    nodeIdentity?: string;
-    /**
-     * The mnemonic for the identity, if empty and node-identity feature is enabled it will be randomly generated.
-     */
-    nodeMnemonic?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the organization of the user, if one is not provided it will be generated
-     */
-    organizationIdentity?: string;
-    /**
-     * The mnemonic for the organization, if empty and node-admin-user feature is enabled it will be randomly generated.
-     */
-    organizationMnemonic?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the identity of the user, if one is not provided it will be generated
-     */
-    adminUserIdentity?: string;
-    /**
-     * The mnemonic for the admin user, if empty and node-admin-user feature is enabled it will be randomly generated.
-     */
-    adminUserMnemonic?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the name of the user.
-     * @default admin@node
-     */
-    adminUserName?: string;
-    /**
-     * If the node-admin-user feature is enabled, this will be the password of the user, if empty it will be randomly generated.
-     */
-    adminUserPassword?: string;
     /**
      * Maximum size in MB for HTTPS extensions downloads.
      * @default 10

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

@@ -7,8 +7,8 @@ import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
  */
 export interface INodeOptions {
     /**
-     * The name of the server, defaults to "TWIN Node Server".
-     * @default "TWIN Node Server"
+     * The name of the server, defaults to "TWIN Node".
+     * @default "TWIN Node"
      */
     serverName?: string;
     /**
@@ -40,6 +40,10 @@ export interface INodeOptions {
      * This will be merged with any configuration loaded from the environment variables.
      */
     config?: IEngineConfig;
+    /**
+     * The directory to override the script location, defaults to location of index.js.
+     */
+    scriptDirectory?: string;
     /**
      * The directory to override the execution location, defaults to process directory.
      */

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

@@ -0,0 +1,4 @@
+/**
+ * Type for the properties in commands.
+ */
+export type CliCommandParamType = string | number | boolean;

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

@@ -0,0 +1,8 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+/**
+ * The type for the initialise engine method of an extension module.
+ * This is called when the engine has been constructed but not yet started.
+ * @param engineCore The engine core instance.
+ * @returns A promise that resolves when the extension engine initialisation is complete.
+ */
+export type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;

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

@@ -0,0 +1,9 @@
+import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
+/**
+ * The type for the initialise engine server method of an extension module.
+ * This is called when the engine server has been constructed but not yet started.
+ * @param engineCore The engine core instance.
+ * @param engineServer The engine server instance.
+ * @returns A promise that resolves when the extension engine-server initialisation is complete.
+ */
+export type NodeExtensionInitialiseEngineServerMethod = (engineCore: IEngineCore, engineServer: IEngineServer) => Promise<void>;

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

@@ -0,0 +1,9 @@
+import type { INodeEngineConfig } from "./INodeEngineConfig.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
+/**
+ * The type for the initialise method of an extension module.
+ * @param envVars The environment variables for the node.
+ * @param nodeEngineConfig The node engine config.
+ * @returns A promise that resolves when the extension configuration initialisation is complete.
+ */
+export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;

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

@@ -0,0 +1,6 @@
+/**
+ * The type for the shutdown method of an extension module.
+ * This is called when the engine is shutting down.
+ * @returns A promise that resolves when the extension shutdown is complete.
+ */
+export type NodeExtensionShutdownMethod = () => Promise<void>;

package/dist/types/node.d.ts

@@ -7,17 +7,18 @@ import type { INodeEngineState } from "./models/INodeEngineState.js";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
 import type { INodeOptions } from "./models/INodeOptions.js";
 /**
- * Run the TWIN Node server.
+ * Run the TWIN Node.
  * @param nodeOptions Optional configuration options for running the server.
+ * @param args Optional command line arguments.
  * @returns A promise that resolves when the server is started containing a shutdown method.
  */
-export declare function run(nodeOptions?: INodeOptions): Promise<{
+export declare function run(nodeOptions?: INodeOptions, args?: string[]): Promise<{
     engine: Engine<IEngineServerConfig, INodeEngineState>;
     server: EngineServer;
     shutdown: () => Promise<void>;
 } | undefined>;
 /**
- * Build the configuration for the TWIN Node server.
+ * Build the configuration for the TWIN Node.
  * @param processEnv The environment variables from the process.
  * @param options The options for running the server.
  * @param serverInfo The server information.
@@ -33,7 +34,7 @@ export declare function buildConfiguration(processEnv: {
     nodeEngineConfig: INodeEngineConfig;
     availableContextIdKeys: {
         key: string;
-        componentFeatures: string[];
+        requiredHandlerFeatures: string[];
     }[];
 }>;
 /**

package/dist/types/{server.d.ts → start.d.ts}

@@ -1,6 +1,7 @@
 import { Engine } from "@twin.org/engine";
 import { EngineServer } from "@twin.org/engine-server";
 import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import type { ICliCommand } from "./models/ICliCommand.js";
 import type { INodeEngineConfig } from "./models/INodeEngineConfig.js";
 import type { INodeEngineState } from "./models/INodeEngineState.js";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
@@ -10,12 +11,13 @@ import type { INodeOptions } from "./models/INodeOptions.js";
  * @param nodeOptions Optional run options for the engine server.
  * @param nodeEngineConfig The configuration for the engine server.
  * @param envVars The environment variables.
+ * @param cliCommand The constructed CLI command (optional).
  * @param availableContextIdKeys The context ID keys available for operation.
  * @returns The engine server.
  */
-export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables, availableContextIdKeys?: {
+export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables, cliCommand?: ICliCommand, availableContextIdKeys?: {
     key: string;
-    componentFeatures: string[];
+    requiredHandlerFeatures: string[];
 }[]): Promise<{
     engine: Engine<IEngineServerConfig, INodeEngineState>;
     server: EngineServer;

package/dist/types/utils.d.ts

@@ -1,11 +1,10 @@
 import type { IModuleProtocol } from "./models/IModuleProtocol.js";
-import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables.js";
 import type { IProtocolHandlerResult } from "./models/IProtocolHandlerResult.js";
 import { ModuleProtocol } from "./models/moduleProtocol.js";
-import { NodeFeatures } from "./models/nodeFeatures.js";
 /**
  * Initialise the locales for the application.
  * @param localesDirectory The directory containing the locales.
+ * @returns A promise that resolves when the locale dictionary has been loaded.
  */
 export declare function initialiseLocales(localesDirectory: string): Promise<void>;
 /**
@@ -13,6 +12,12 @@ export declare function initialiseLocales(localesDirectory: string): Promise<voi
  * @returns The execution directory.
  */
 export declare function getExecutionDirectory(): string;
+/**
+ * Get the directory where the script is located.
+ * @param args The command line arguments.
+ * @returns The directory containing the entry-point script, or the current working directory if not determinable.
+ */
+export declare function getScriptDirectory(args?: string[]): string;
 /**
  * Does the specified file exist.
  * @param filename The filename to check for existence.
@@ -40,21 +45,15 @@ export declare function getFiles(directory: string): Promise<string[]>;
 /**
  * Load the text file.
  * @param filename The filename of the text file to load.
- * @returns The contents of the text file if it could not be loaded.
+ * @returns The contents of the text file as a UTF-8 string.
  */
 export declare function loadTextFile(filename: string): Promise<string>;
 /**
  * Load the JSON file.
  * @param filename The filename of the JSON file to load.
- * @returns The contents of the JSON file or null if it could not be loaded.
+ * @returns The parsed JSON content of the file.
  */
 export declare function loadJsonFile<T>(filename: string): Promise<T>;
-/**
- * Get the features that are enabled on the node.
- * @param env The environment variables for the node.
- * @returns The features that are enabled on the node.
- */
-export declare function getFeatures(env: INodeEnvironmentVariables): NodeFeatures[];
 /**
  * Parse the protocol from a module name.
  * @param moduleName The module name to parse.