@twin.org/node-core 0.0.2-next.9 → 0.0.3-next.10

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

@@ -0,0 +1,23 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionHelp(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for displaying help information.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The command parameters.
+ * @param params.command The command to display help for.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function help(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    command?: string;
+}, commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): Promise<void>;

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

@@ -0,0 +1,39 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionIdentityCreate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating an identity.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.mnemonic The mnemonic to use for the identity.
+ * @param params.identity The DID of the identity to create.
+ * @param params.controller The controller DID for the identity.
+ * @param params.fundWallet Whether to fund the wallet associated with the identity from a faucet.
+ * @param params.outputJson The output .json file to store the command output.
+ * @param params.outputEnv The output .env file to store the command output.
+ * @param params.outputEnvPrefix The prefix to use for variables in the output .env file.
+ * @returns The identity details.
+ */
+export declare function identityCreate(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    mnemonic?: string;
+    identity?: string;
+    controller?: string;
+    fundWallet?: boolean;
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    mnemonic: string;
+    did: string;
+    walletAddress?: string;
+}>;

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

@@ -0,0 +1,24 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionIdentityImport(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for importing an identity.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID of the identity to import.
+ * @param params.mnemonic The mnemonic to use for the identity.
+ */
+export declare function identityImport(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+    mnemonic?: string;
+}): Promise<void>;

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

@@ -0,0 +1,43 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { IDidVerifiableCredential } from "@twin.org/standards-w3c-did";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionIdentityVerifiableCredentialCreate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating an identity verifiable credential.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.verificationMethodId The ID of the verification method to create the credential with.
+ * @param params.identity The DID of the identity to create the credential for.
+ * @param params.controller The controller DID for the identity.
+ * @param params.subjectJson The subject JSON file for the verifiable credential.
+ * @param params.credentialId The ID of the verifiable credential.
+ * @param params.expirationDate The expiration date of the verifiable credential.
+ * @param params.outputJson The output .json file to store the command output.
+ * @param params.outputEnv The output .env file to store the command output.
+ * @param params.outputEnvPrefix The prefix to use for variables in the output .env file.
+ * @returns The created verifiable credential and JWT.
+ */
+export declare function identityVerifiableCredentialCreate(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    verificationMethodId?: string;
+    identity?: string;
+    controller?: string;
+    subjectJson?: string;
+    credentialId?: string;
+    expirationDate?: string;
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    verifiableCredential: IDidVerifiableCredential;
+    jwt: string;
+}>;

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

@@ -0,0 +1,47 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import { DidVerificationMethodType } from "@twin.org/standards-w3c-did";
+import { type IJwk } from "@twin.org/web";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionIdentityVerificationMethodCreate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating an identity verification method.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID of the identity to create.
+ * @param params.verificationMethodType The type of verification method to create.
+ * @param params.verificationMethodId The ID of the verification method to create.
+ * @param params.controller The controller DID for the identity.
+ * @param params.overwriteMode The mode to use when a verification method with the same ID already exists.
+ * @param params.outputJson The output .json file to store the command output.
+ * @param params.outputEnv The output .env file to store the command output.
+ * @param params.outputEnvPrefix The prefix to use for variables in the output .env file.
+ * @returns The created verification method details or undefined if skipped.
+ */
+export declare function identityVerificationMethodCreate(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+    verificationMethodType?: DidVerificationMethodType;
+    verificationMethodId?: string;
+    controller?: string;
+    overwriteMode?: "skip" | "overwrite" | "error";
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    verificationMethodId: string;
+    verificationMethodType: string;
+    privateKeyJwk: IJwk;
+    privateKeyHex: string;
+    publicKeyHex: string;
+    privateKeyBase64: string;
+    publicKeyBase64: string;
+} | undefined>;

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

@@ -0,0 +1,31 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import { DidVerificationMethodType } from "@twin.org/standards-w3c-did";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionIdentityVerificationMethodImport(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating an identity verification method.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID of the identity to create.
+ * @param params.verificationMethodType The type of verification method to create.
+ * @param params.verificationMethodId The ID of the verification method to create.
+ * @param params.controller The controller DID for the identity.
+ * @param params.privateKeyHex The private key in hex format.
+ */
+export declare function identityVerificationMethodImport(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+    verificationMethodType?: DidVerificationMethodType;
+    verificationMethodId?: string;
+    controller?: string;
+    privateKeyHex?: string;
+}): Promise<void>;

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

@@ -0,0 +1,22 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionNodeSetIdentity(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for setting a node identity.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID to set for the node.
+ */
+export declare function nodeSetIdentity(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+}): Promise<void>;

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

@@ -0,0 +1,22 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionNodeSetTenant(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for setting a node tenant.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.tenantId The tenant id to set for the node.
+ */
+export declare function nodeSetTenant(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    tenantId?: string;
+}): Promise<void>;

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

@@ -0,0 +1,35 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionTenantCreate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating a tenant.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.apiKey The api key to add.
+ * @param params.tenantId The tenant ID to add the api key to.
+ * @param params.label The label for the api key.
+ * @param params.outputJson The output .json file to store the command output.
+ * @param params.outputEnv The output .env file to store the command output.
+ * @param params.outputEnvPrefix The prefix to use for variables in the output .env file.
+ * @returns The created tenant details.
+ */
+export declare function tenantCreate(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    apiKey?: string;
+    tenantId?: string;
+    label?: string;
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    apiKey: string;
+    tenantId: string;
+    label: string;
+}>;

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

@@ -0,0 +1,24 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionTenantImport(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for importing a tenant.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.apiKey The api key to import.
+ * @param params.tenantId The tenant ID to import the api key to.
+ * @param params.label The label for the api key.
+ */
+export declare function tenantImport(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    apiKey?: string;
+    tenantId?: string;
+    label?: string;
+}): Promise<void>;

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

@@ -0,0 +1,46 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionUserCreate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating a user.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.userIdentity The DID for the user.
+ * @param params.organizationIdentity The organization DID for the user.
+ * @param params.email The email for the user.
+ * @param params.password The password for the user.
+ * @param params.givenName The given name for the user.
+ * @param params.familyName The family name for the user.
+ * @param params.overwriteMode The mode to use when a user with the same identity already exists.
+ * @param params.outputJson The output .json file to store the command output.
+ * @param params.outputEnv The output .env file to store the command output.
+ * @param params.outputEnvPrefix The prefix to use for variables in the output .env file.
+ * @returns The created user details or undefined if skipped.
+ */
+export declare function userCreate(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    userIdentity?: string;
+    organizationIdentity?: string;
+    email?: string;
+    password?: string;
+    givenName?: string;
+    familyName?: string;
+    overwriteMode?: "skip" | "overwrite" | "error";
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    did: string;
+    organizationDid: string;
+    email: string;
+    password: string;
+    givenName: string;
+    familyName: string;
+} | undefined>;

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

@@ -0,0 +1,43 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionVaultKeyCreate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for creating a vault key.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID to create the vault key for.
+ * @param params.keyId The ID of the key to create.
+ * @param params.keyType The type of key to create.
+ * @param params.overwriteMode The mode to use when a user with the same identity already exists.
+ * @param params.outputJson The output .json file to store the command output.
+ * @param params.outputEnv The output .env file to store the command output.
+ * @param params.outputEnvPrefix The prefix to use for variables in the output .env file.
+ * @returns The created vault key details or undefined if skipped.
+ */
+export declare function vaultKeyCreate(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+    keyType?: string;
+    keyId?: string;
+    overwriteMode?: "skip" | "overwrite" | "error";
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    identity: string;
+    keyId: string;
+    keyType?: string;
+    privateKeyBase64?: string;
+    publicKeyBase64?: string;
+    privateKeyHex?: string;
+    publicKeyHex?: string;
+} | undefined>;

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

@@ -0,0 +1,28 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { ICliCommandDefinition } from "../models/ICliCommandDefinition.js";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig.js";
+import type { INodeEngineState } from "../models/INodeEngineState.js";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables.js";
+/**
+ * Get the command definition parameters.
+ * @param commandDefinitions The registered command definitions.
+ */
+export declare function getCommandDefinitionVaultKeyImport(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for importing a vault key.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.identity The DID to create the vault key for.
+ * @param params.keyId The ID of the key to create.
+ * @param params.keyType The type of key to create.
+ * @param params.privateKeyHex The private key in hexadecimal format.
+ */
+export declare function vaultKeyImport(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+    keyType?: string;
+    keyId?: string;
+    privateKeyHex?: string;
+}): Promise<void>;

package/dist/types/defaults.d.ts

@@ -0,0 +1,16 @@
+export declare const ATTESTATION_VERIFICATION_METHOD_ID = "attestation-assertion";
+export declare const IMMUTABLE_PROOF_VERIFICATION_METHOD_ID = "immutable-proof-assertion";
+export declare const BLOB_STORAGE_ENCRYPTION_KEY_ID = "blob-encryption";
+export declare const SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID = "synchronised-storage-blob-encryption";
+export declare const VC_AUTHENTICATION_VERIFICATION_METHOD_ID = "vc-authentication-assertion";
+export declare const AUTH_SIGNING_KEY_ID = "auth-signing";
+export declare const CONTEXT_ID_HANDLER_FEATURE_DID = "did";
+export declare const CONTEXT_ID_HANDLER_FEATURE_TENANT = "tenant";
+/**
+ * Get the default environment variables for the node.
+ * @param envPrefix The environment variable prefix.
+ * @returns The default environment variables.
+ */
+export declare function getEnvDefaults(envPrefix: string): {
+    [key: string]: string;
+};

package/dist/types/index.d.ts

@@ -1,11 +1,24 @@
-export * from "./bootstrap";
-export * from "./builders/engineEnvBuilder";
-export * from "./builders/engineServerEnvBuilder";
-export * from "./models/IEngineEnvironmentVariables";
-export * from "./models/IEngineServerEnvironmentVariables";
-export * from "./models/INodeEnvironmentVariables";
-export * from "./models/INodeOptions";
-export * from "./models/nodeFeatures";
-export * from "./node";
-export * from "./server";
-export * from "./utils";
+export * from "./builders/engineEnvBuilder.js";
+export * from "./builders/engineServerEnvBuilder.js";
+export * from "./builders/extensionsBuilder.js";
+export * from "./cli.js";
+export * from "./defaults.js";
+export * from "./models/cliCommandParamType.js";
+export * from "./models/ICacheMetadata.js";
+export * from "./models/ICliArgs.js";
+export * from "./models/ICliCommand.js";
+export * from "./models/ICliCommandDefinition.js";
+export * from "./models/ICliCommandDefinitionParam.js";
+export * from "./models/IEngineEnvironmentVariables.js";
+export * from "./models/IEngineServerEnvironmentVariables.js";
+export * from "./models/IModuleProtocol.js";
+export * from "./models/INodeEngineConfig.js";
+export * from "./models/INodeEngineState.js";
+export * from "./models/INodeEnvironmentVariables.js";
+export * from "./models/INodeOptions.js";
+export * from "./models/IProtocolHandlerResult.js";
+export * from "./models/moduleProtocol.js";
+export * from "./models/nodeExtensionMethods.js";
+export * from "./node.js";
+export * from "./start.js";
+export * from "./utils.js";

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

@@ -0,0 +1,17 @@
+/**
+ * Metadata for cached HTTPS extensions.
+ */
+export interface ICacheMetadata {
+    /**
+     * Timestamp when the file was downloaded.
+     */
+    downloadedAt: number;
+    /**
+     * Original URL of the cached file.
+     */
+    url: string;
+    /**
+     * Size of the cached file in bytes.
+     */
+    size: number;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * Command to execute in the CLI.
+ */
+export interface ICliArgs {
+    /**
+     * The path of the node executable.
+     */
+    nodePath?: string;
+    /**
+     * The path of the script to execute.
+     */
+    scriptPath?: string;
+    /**
+     * The command line options.
+     */
+    options?: {
+        key: string;
+        value: string;
+    }[];
+}

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

@@ -0,0 +1,17 @@
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+import type { ICliCommandDefinition } from "./ICliCommandDefinition.js";
+/**
+ * Command to execute in the CLI.
+ */
+export interface ICliCommand {
+    /**
+     * The command to execute.
+     */
+    definition: ICliCommandDefinition;
+    /**
+     * The params to execute the command with.
+     */
+    params: {
+        [id: string]: CliCommandParamType;
+    };
+}

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

@@ -0,0 +1,46 @@
+import type { IEngineCore } from "@twin.org/engine-models";
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+import type { ICliCommandDefinitionParam } from "./ICliCommandDefinitionParam.js";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables.js";
+/**
+ * Command to execute in the CLI.
+ */
+export interface ICliCommandDefinition {
+    /**
+     * The command name.
+     */
+    command: string;
+    /**
+     * The command description.
+     */
+    description: string;
+    /**
+     * The example.
+     */
+    example: string;
+    /**
+     * The params available for the command.
+     */
+    params: ICliCommandDefinitionParam[];
+    /**
+     * The method to execute for the command.
+     */
+    action: (engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+        [id: string]: CliCommandParamType;
+    }) => Promise<unknown>;
+    /**
+     * Indicates whether the engine needs to be started before executing the command.
+     * @default true
+     */
+    requiresEngineStarted?: boolean;
+    /**
+     * Indicates whether the engine needs the node identity to be set if configured to use.
+     * @default true
+     */
+    requiresNodeIdentity?: boolean;
+    /**
+     * Indicates whether the engine needs the tenant id to be set if configured to use.
+     * @default true
+     */
+    requiresTenantId?: boolean;
+}

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

@@ -0,0 +1,35 @@
+import type { CliCommandParamType } from "./cliCommandParamType.js";
+/**
+ * Command param to execute in the CLI.
+ */
+export interface ICliCommandDefinitionParam {
+    /**
+     * The param key.
+     */
+    key: string;
+    /**
+     * The param type.
+     */
+    type: "string" | "number" | "boolean";
+    /**
+     * Possible options for the param.
+     */
+    options?: string[];
+    /**
+     * The extended type e.g. hex etc.
+     */
+    extendedType?: string;
+    /**
+     * Whether the param is required.
+     * @default true
+     */
+    required?: boolean;
+    /**
+     * The default value of the param.
+     */
+    defaultValue?: CliCommandParamType;
+    /**
+     * The param description.
+     */
+    description: string;
+}