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

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

@@ -0,0 +1,67 @@
+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 getCommandDefinitionBootstrapLegacy(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for legacy bootstrap.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @returns A promise that resolves when the bootstrap sequence has completed.
+ */
+export declare function bootstrapLegacy(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables & {
+    /**
+     * 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 node identity, if empty it will be randomly generated.
+     */
+    nodeMnemonic?: string;
+    /**
+     * A tenant id to use as a default for the node.
+     */
+    tenantId?: string;
+    /**
+     * A tenant api key to use as a default for the node.
+     */
+    tenantApiKey?: string;
+    /**
+     * The organisation identity. If not provided it will be generated.
+     */
+    organizationIdentity?: string;
+    /**
+     * The mnemonic for the organisation identity, if empty it will be randomly generated.
+     */
+    organizationMnemonic?: string;
+    /**
+     * If the admin-user feature is enabled, this will be the identity of the user. If not provided it will be generated.
+     */
+    adminUserIdentity?: string;
+    /**
+     * The mnemonic for the admin user, if empty it will be randomly generated.
+     */
+    adminUserMnemonic?: string;
+    /**
+     * If the admin-user feature is enabled, this will be the name of the user.
+     * @default admin@node
+     */
+    adminUserName?: string;
+    /**
+     * If the admin-user feature is enabled, this will be the password of the user. If empty it will be randomly generated.
+     */
+    adminUserPassword?: string;
+}, params: {}): Promise<void>;

package/dist/types/commands/help.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 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.
+ * @returns A promise that resolves when help output has been displayed.
+ */
+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,45 @@
+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.nodeId If true, set the created DID as the node identity.
+ * @param params.nodeOrganizationId If true, set the created DID as the node organization ID.
+ * @param params.tenantOrganizationId The tenant ID to set the created DID as the organization ID for.
+ * @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;
+    nodeId?: boolean;
+    nodeOrganizationId?: boolean;
+    tenantOrganizationId?: string;
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    mnemonic: string;
+    did: string;
+    walletAddress?: string;
+}>;

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

@@ -0,0 +1,25 @@
+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.
+ * @returns A promise that resolves when the identity mnemonic has been stored in the vault.
+ */
+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,32 @@
+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 importing an existing key as a verification method on an identity document.
+ * @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.
+ * @returns A promise that resolves when the verification method has been imported.
+ */
+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,23 @@
+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.
+ * @returns A promise that resolves when the node identity has been persisted.
+ */
+export declare function nodeSetIdentity(engineCore: IEngineCore<INodeEngineConfig, INodeEngineState>, envVars: INodeEnvironmentVariables, params: {
+    identity?: string;
+}): Promise<void>;

package/dist/types/commands/removeTenantOrgAlias.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 getCommandDefinitionRemoveTenantOrgAlias(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for removing an alias from the tenant organization ID legacy list.
+ * @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 update.
+ * @param params.alias The alias to remove from the legacy list.
+ * @returns A promise that resolves when the alias has been removed.
+ * @throws GeneralError if the tenant admin component is not registered, or the alias is not found.
+ */
+export declare function removeTenantOrgAlias(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    tenantId?: string;
+    alias?: string;
+}): Promise<void>;

package/dist/types/commands/setNodeOrgId.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 getCommandDefinitionSetNodeOrgId(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for setting the node organization ID.
+ * @param engineCore The engine core.
+ * @param envVars The environment variables for the node.
+ * @param params The parameters for the command.
+ * @param params.organizationId The organization ID to set.
+ * @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: INodeEnvironmentVariables, params: {
+    organizationId?: string;
+}): Promise<void>;

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

@@ -0,0 +1,38 @@
+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 getCommandDefinitionSetTenantOrgId(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for setting the organization ID on a 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 update.
+ * @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: INodeEnvironmentVariables, params: {
+    tenantId?: string;
+    organizationId?: string;
+}): Promise<void>;
+/**
+ * Apply a new organization ID to a tenant.
+ * @param engineCore The engine core used to look up the tenantAdminComponent.
+ * @param tenantId The ID of the tenant to update.
+ * @param newOrganizationId The new organization DID to set.
+ * @param options Optional display and behaviour overrides.
+ * @param options.sectionLabel When set, emits a CLI section header before and done marker after.
+ * @param options.required When false, returns silently when the component is not registered (default true).
+ * @returns A promise that resolves when the tenant record has been updated.
+ * @throws GeneralError if the component is required but not registered.
+ */
+export declare function applyOrganizationIdToTenant(engineCore: IEngineCore, tenantId: string, newOrganizationId: string, options?: {
+    sectionLabel?: string;
+    required?: boolean;
+}): Promise<void>;

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

@@ -0,0 +1,41 @@
+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.organizationId The organization DID to associate with the tenant.
+ * @param params.label The label for the api key.
+ * @param params.publicOrigin The public URL origin for the tenant.
+ * @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;
+    organizationId?: string;
+    label?: string;
+    publicOrigin?: string;
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    apiKey: string;
+    tenantId: string;
+    organizationId?: string;
+    label: string;
+    publicOrigin: string;
+}>;

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

@@ -0,0 +1,29 @@
+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 with a known tenant ID and API key.
+ * @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.
+ * @param params.organizationId The organization DID to associate with the tenant.
+ * @param params.label The label for the tenant.
+ * @param params.publicOrigin The public URL origin for the tenant.
+ * @returns A promise that resolves when the tenant record has been created.
+ */
+export declare function tenantImport(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    apiKey?: string;
+    tenantId?: string;
+    organizationId?: string;
+    label?: string;
+    publicOrigin?: string;
+}): Promise<void>;

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

@@ -0,0 +1,29 @@
+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 getCommandDefinitionTenantUpdate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for updating 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 update.
+ * @param params.tenantId The tenant ID to update.
+ * @param params.organizationId The organization DID to associate with the tenant.
+ * @param params.label The label for the tenant.
+ * @param params.publicOrigin The public URL origin for the tenant.
+ * @returns A promise that resolves when the tenant record has been updated.
+ */
+export declare function tenantUpdate(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    apiKey?: string;
+    tenantId?: string;
+    organizationId?: string;
+    label?: string;
+    publicOrigin?: string;
+}): Promise<void>;

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

@@ -0,0 +1,51 @@
+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.tenantId The tenant ID for the user.
+ * @param params.email The email for the user.
+ * @param params.password The password for the user.
+ * @param params.scope The scope 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;
+    tenantId?: string;
+    email?: string;
+    password?: string;
+    scope?: string;
+    givenName?: string;
+    familyName?: string;
+    overwriteMode?: "skip" | "overwrite" | "error";
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    did: string;
+    organizationDid: string;
+    email: string;
+    password: string;
+    scope: string[];
+    givenName: string;
+    familyName: string;
+} | undefined>;

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

@@ -0,0 +1,40 @@
+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 getCommandDefinitionUserUpdate(commandDefinitions: {
+    [id: string]: ICliCommandDefinition;
+}): void;
+/**
+ * Command for updating 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.tenantId The tenant ID for the user.
+ * @param params.email The email for the user.
+ * @param params.scope The scope for the user.
+ * @param params.givenName The given name for the user.
+ * @param params.familyName The family name for the user.
+ * @returns The updated user details or undefined if skipped.
+ */
+export declare function userUpdate(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    userIdentity?: string;
+    organizationIdentity?: string;
+    tenantId?: string;
+    email?: string;
+    scope?: string;
+    givenName?: string;
+    familyName?: string;
+}): Promise<{
+    did: string;
+    organizationDid: string;
+    email: string;
+    scope: 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>;