@twin.org/node-core 0.0.3-next.2 → 0.0.3-next.21

package/dist/types/commands/tenantCreate.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 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.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;
+    label?: string;
+    publicOrigin?: string;
+    outputJson?: string;
+    outputEnv?: string;
+    outputEnvPrefix?: string;
+}): Promise<{
+    apiKey: string;
+    tenantId: string;
+    label: string;
+    publicOrigin: string;
+}>;

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

@@ -0,0 +1,26 @@
+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.
+ * @param params.publicOrigin The public URL origin for the tenant.
+ */
+export declare function tenantImport(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    apiKey?: string;
+    tenantId?: string;
+    label?: string;
+    publicOrigin?: string;
+}): Promise<void>;

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

@@ -0,0 +1,26 @@
+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 the api key to.
+ * @param params.label The label for the api key.
+ * @param params.publicOrigin The public URL origin for the tenant.
+ */
+export declare function tenantUpdate(engineCore: IEngineCore, envVars: INodeEnvironmentVariables, params: {
+    apiKey?: string;
+    tenantId?: string;
+    label?: string;
+    publicOrigin?: string;
+}): Promise<void>;

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

@@ -0,0 +1,49 @@
+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.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;
+    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,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 getCommandDefinitionUserUpdate(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.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;
+    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>;

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

@@ -2,5 +2,15 @@ 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 = "node-authentication-assertion";
+export declare const TRUST_VERIFICATION_METHOD_ID = "trust-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,9 +1,14 @@
-export * from "./bootstrap.js";
 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";
@@ -14,7 +19,6 @@ export * from "./models/INodeOptions.js";
 export * from "./models/IProtocolHandlerResult.js";
 export * from "./models/moduleProtocol.js";
 export * from "./models/nodeExtensionMethods.js";
-export * from "./models/nodeFeatures.js";
 export * from "./node.js";
-export * from "./server.js";
+export * from "./start.js";
 export * from "./utils.js";

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;
+}

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

@@ -6,6 +6,10 @@ export interface IEngineEnvironmentVariables {
      * Start the engine in debug mode.
      */
     debug?: string;
+    /**
+     * Start the engine in silent mode.
+     */
+    silent?: string;
     /**
      * The root directory for storing items like state file.
      */
@@ -15,17 +19,13 @@ export interface IEngineEnvironmentVariables {
      */
     stateFilename?: string;
     /**
-     * Is multi-tenant support enabled, defaults to false.
-     */
-    tenantEnabled?: string;
-    /**
-     * A tenant id to use as a default for the node.
+     * Does the node have a unique ID, defaults to true.
      */
-    tenantId?: string;
+    nodeIdentityEnabled?: string;
     /**
-     * A tenant api key to use as a default for the node.
+     * Is multi-tenant support enabled, defaults to false.
      */
-    tenantApiKey?: string;
+    tenantEnabled?: string;
     /**
      * The type of the entity storage to create, comma separate for more than one connector.
      * values: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql
@@ -59,6 +59,10 @@ export interface IEngineEnvironmentVariables {
      * AWS Dynamo DB secret access key.
      */
     awsDynamodbSecretAccessKey?: string;
+    /**
+     * AWS Dynamo DB connection timeout.
+     */
+    awsDynamodbConnectionTimeoutMs?: string;
     /**
      * Azure Cosmos DB key.
      */
@@ -200,11 +204,6 @@ export interface IEngineEnvironmentVariables {
      * The id of the encryption key for the blob storage.
      */
     blobStorageEncryptionKeyId?: string;
-    /**
-     * A symmetric encryption key for the blob storage, should be ChaCha20Poly1305 in base64 format.
-     * If encryption is enabled but a key is not provided one will be generated.
-     */
-    blobStorageSymmetricEncryptionKey?: string;
     /**
      * A prefix for all the blobs in blob-storage, can be empty.
      */
@@ -269,6 +268,10 @@ export interface IEngineEnvironmentVariables {
      * The type of the default vault connector: entity-storage, hashicorp.
      */
     vaultConnector?: string;
+    /**
+     * Prefix to prepend to entries in the vault.
+     */
+    vaultPrefix?: string;
     /**
      * Hashicorp Vault token.
      */
@@ -281,10 +284,6 @@ export interface IEngineEnvironmentVariables {
      * The type of logging task connector, can be a comma separated list: console, entity-storage.
      */
     loggingConnector?: string;
-    /**
-     * The type of background task connector: entity-storage.
-     */
-    backgroundTaskConnector?: string;
     /**
      * The type of event bus connector: local.
      */
@@ -353,6 +352,10 @@ export interface IEngineEnvironmentVariables {
      * The type of identity connector: entity-storage, iota.
      */
     identityConnector?: string;
+    /**
+     * The index of the wallet address to use, defaults to 0.
+     */
+    identityWalletAddressIndex?: string;
     /**
      * The type of identity resolver connector: entity-storage, iota.
      */
@@ -482,56 +485,71 @@ export interface IEngineEnvironmentVariables {
      */
     federatedCatalogueEnabled?: string;
     /**
-     * Federated catalog TTL for the cache.
+     * Federated catalog filters, command separated list of filters to add.
+     */
+    federatedCatalogueFilters?: string;
+    /**
+     * Is the trust management enabled, defaults to false.
+     */
+    trustEnabled?: string;
+    /**
+     * The trust generators to add to the factory, comma separated list.
+     */
+    trustGenerators?: string;
+    /**
+     * The trust verifiers to add to the factory, comma separated list.
      */
-    federatedCatalogueCacheTtlMs?: number;
+    trustVerifiers?: string;
     /**
-     * Federated catalog clearing house approver list, stringified array of DIDs.
+     * The verification method to use for trust identities.
+     * Defaults to trust-assertion.
      */
-    federatedCatalogueClearingHouseApproverList?: string;
+    trustVerificationMethodId?: string;
+    /**
+     * The trust time to live for generating JWTs.
+     * Defaults to undefined for never expiring.
+     */
+    trustJwtTtlSeconds?: string;
     /**
      * Is the rights management enabled, defaults to false.
      */
     rightsManagementEnabled?: string;
     /**
-     * What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+     * What is the callback path for rights management negotiations, will be combined with hosting public url e.g. /callback.
+     */
+    rightsManagementCallbackPath?: string;
+    /**
+     * The rights management policy information sources to add to the factory.
      */
-    rightsManagementBaseCallbackUrl?: string;
+    rightsManagementPolicyInformationSources?: string;
     /**
-     * The rights management configuration which includes the information sources modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy negotiators sources to add to the factory.
      */
-    rightsManagementInformationSources?: string;
+    rightsManagementPolicyNegotiators?: string;
     /**
-     * The rights management configuration which includes the negotiator modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy requesters to add to the factory.
      */
-    rightsManagementNegotiators?: string;
+    rightsManagementPolicyRequesters?: string;
     /**
-     * The rights management configuration which includes the requester modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy execution actions to add to the factory.
      */
-    rightsManagementRequesters?: string;
+    rightsManagementPolicyExecutionActions?: string;
     /**
-     * The rights management configuration which includes the execution actions modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy enforcement processors to add to the factory.
      */
-    rightsManagementExecutionActions?: string;
+    rightsManagementPolicyEnforcementProcessors?: string;
     /**
-     * The rights management configuration which includes the enforcement processor modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy arbiters to add to the factory.
      */
-    rightsManagementEnforcementProcessors?: string;
+    rightsManagementPolicyArbiters?: string;
     /**
-     * The rights management configuration which includes the arbiter modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * The rights management policy obligation enforcers to add to the factory.
      */
-    rightsManagementArbiters?: string;
+    rightsManagementPolicyObligationEnforcers?: string;
     /**
-     * The rights management configuration which includes the offer modules to load.
-     * Use the @json: prefix to specify the path to the JSON configuration file.
+     * Are background tasks enabled, defaults to false.
      */
-    rightsManagementOffers?: string;
+    backgroundTasksEnabled?: string;
     /**
      * Is the task scheduler enabled, defaults to false.
      */
@@ -550,15 +568,6 @@ export interface IEngineEnvironmentVariables {
      * @default 60
      */
     dataSpaceConnectorActivityLogsCleanUpInterval?: string;
-    /**
-     * Enable verifiable credential authentication for the API.
-     */
-    vcAuthenticationEnabled?: string;
-    /**
-     * Verifiable credential assertion for node to node communication.
-     * Defaults to node-authentication-assertion.
-     */
-    vcAuthenticationVerificationMethodId?: string;
     /**
      * A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
      */

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

@@ -27,6 +27,10 @@ export interface IEngineServerEnvironmentVariables extends IEngineEnvironmentVar
      * The CORS headers to expose.
      */
     httpExposedHeaders?: string;
+    /**
+     * The public origin URL for the API e.g. https://api.example.com:1234
+     */
+    publicOrigin?: string;
     /**
      * The type of auth admin processor to use on the API: entity-storage.
      */

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

@@ -11,12 +11,4 @@ export interface INodeEngineState extends IEngineState {
      * The tenant id for the node.
      */
     nodeTenantId?: string;
-    /**
-     * The identity for the organization.
-     */
-    nodeOrganizationId?: string;
-    /**
-     * The identity for the admin user.
-     */
-    nodeAdminUserId?: string;
 }