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

package/dist/types/bootstrap.d.ts

@@ -1,5 +1,5 @@
 import type { IEngineCore, IEngineCoreContext, IEngineState } from "@twin.org/engine-models";
-import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import { type IEngineServerConfig } from "@twin.org/engine-server-types";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
 import { NodeFeatures } from "./models/nodeFeatures";
 /**
@@ -25,14 +25,6 @@ export declare function bootstrapNodeIdentity(engineCore: IEngineCore, context:
  * @param features The features that are enabled on the node.
  */
 export declare function bootstrapNodeUser(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
-/**
- * Bootstrap the attestation verification methods.
- * @param engineCore The engine core for the node.
- * @param context The context for the node.
- * @param envVars The environment variables for the node.
- * @param features The features that are enabled on the node.
- */
-export declare function bootstrapAttestationMethod(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
 /**
  * Bootstrap the immutable proof verification methods.
  * @param engineCore The engine core for the node.
@@ -57,3 +49,11 @@ export declare function bootstrapBlobEncryption(engineCore: IEngineCore, context
  * @param features The features that are enabled on the node.
  */
 export declare function bootstrapAuth(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;
+/**
+ * Bootstrap the synchronised storage blob encryption and verification methods.
+ * @param engineCore The engine core for the node.
+ * @param context The context for the node.
+ * @param envVars The environment variables for the node.
+ * @param features The features that are enabled on the node.
+ */
+export declare function bootstrapSynchronisedStorage(engineCore: IEngineCore, context: IEngineCoreContext<IEngineServerConfig, IEngineState>, envVars: INodeEnvironmentVariables, features: NodeFeatures[]): Promise<void>;

package/dist/types/builders/engineEnvBuilder.d.ts

@@ -5,4 +5,4 @@ import type { IEngineEnvironmentVariables } from "../models/IEngineEnvironmentVa
  * @param envVars The environment variables.
  * @returns The config for the core.
  */
-export declare function buildEngineConfiguration(envVars: IEngineEnvironmentVariables): IEngineConfig;
+export declare function buildEngineConfiguration(envVars: IEngineEnvironmentVariables): Promise<IEngineConfig>;

package/dist/types/builders/engineServerEnvBuilder.d.ts

@@ -8,6 +8,7 @@ import type { IEngineServerEnvironmentVariables } from "../models/IEngineServerE
  * @param coreEngineConfig The core engine config.
  * @param serverInfo The server information.
  * @param openApiSpecPath The path to the open api spec.
- * @returns The the config for the core and the server.
+ * @param favIconPath The path to the favicon.
+ * @returns The config for the core and the server.
  */
-export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo, openApiSpecPath?: string): IEngineServerConfig;
+export declare function buildEngineServerConfiguration(envVars: IEngineServerEnvironmentVariables, coreEngineConfig: IEngineCoreConfig, serverInfo: IServerInfo, openApiSpecPath?: string, favIconPath?: string): Promise<IEngineServerConfig>;

package/dist/types/builders/extensionsBuilder.d.ts

@@ -0,0 +1,32 @@
+import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
+import type { INodeEngineConfig } from "../models/INodeEngineConfig";
+import type { INodeEnvironmentVariables } from "../models/INodeEnvironmentVariables";
+/**
+ * Handles the configuration of the extensions.
+ * @param envVars The environment variables for the node.
+ * @param nodeEngineConfig The node engine config.
+ * @returns The config for the core and the server.
+ */
+export declare function extensionsConfiguration(envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig): Promise<INodeEngineConfig>;
+/**
+ * Handles the initialisation of the extensions when the engine has been constructed.
+ * @param envVars The environment variables for the node.
+ * @param engineCore The engine core instance.
+ * @returns Nothing.
+ */
+export declare function extensionsInitialiseEngine(envVars: INodeEnvironmentVariables, engineCore: IEngineCore): Promise<void>;
+/**
+ * Handles the initialisation of the extensions when the engine server has been constructed.
+ * @param envVars The environment variables for the node.
+ * @param engineCore The engine core instance.
+ * @param engineServer The engine server instance.
+ * @returns Nothing.
+ */
+export declare function extensionsInitialiseEngineServer(envVars: INodeEnvironmentVariables, engineCore: IEngineCore, engineServer: IEngineServer): Promise<void>;
+/**
+ * Handles the shutdown of the extensions.
+ * @param envVars The environment variables for the node.
+ * @param engineCore The engine core instance.
+ * @returns Nothing.
+ */
+export declare function shutdownExtensions(envVars: INodeEnvironmentVariables, engineCore: IEngineCore): Promise<void>;

package/dist/types/defaults.d.ts

@@ -0,0 +1,6 @@
+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 AUTH_SIGNING_KEY_ID = "auth-signing";

package/dist/types/index.d.ts

@@ -1,10 +1,14 @@
 export * from "./bootstrap";
 export * from "./builders/engineEnvBuilder";
 export * from "./builders/engineServerEnvBuilder";
+export * from "./builders/extensionsBuilder";
+export * from "./defaults";
 export * from "./models/IEngineEnvironmentVariables";
 export * from "./models/IEngineServerEnvironmentVariables";
+export * from "./models/INodeEngineConfig";
 export * from "./models/INodeEnvironmentVariables";
 export * from "./models/INodeOptions";
+export * from "./models/nodeExtensionMethods";
 export * from "./models/nodeFeatures";
 export * from "./node";
 export * from "./server";

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

@@ -23,14 +23,14 @@ export interface IEngineEnvironmentVariables {
      * The default entity storage connector to use, defaults to the first one in the list.
      */
     entityStorageConnectorDefault?: string;
-    /**
-     * Entity storage connector for decentralized storage
-     */
-    entityStorageConnectorDecentralised?: string;
     /**
      * A prefix for all the table in entity-storage, can be empty.
      */
     entityStorageTablePrefix?: string;
+    /**
+     * AWS DynamoDB auth mode, either credentials or pod.
+     */
+    awsDynamodbAuthMode?: string;
     /**
      * AWS Dynamo DB access key id.
      */
@@ -177,41 +177,50 @@ export interface IEngineEnvironmentVariables {
      */
     blobStorageConnectorDefault?: string;
     /**
-     * Blog storage connector for decentralized storage
+     * Blog storage connector which has public access.
      */
-    blobStorageConnectorDecentralised?: string;
+    blobStorageConnectorPublic?: string;
     /**
      * Enable encryption for the blob storage.
      */
     blobStorageEnableEncryption?: string;
     /**
-     * The encryption key for the blob storage.
+     * The id of the encryption key for the blob storage.
      */
-    blobStorageEncryptionKey?: string;
+    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.
      */
     blobStoragePrefix?: string;
     /**
-     * AWS S3 access key id.
+     * AWS S3 region.
      */
-    awsS3AccessKeyId?: string;
+    awsS3Region?: string;
     /**
      * AWS S3 bucket name.
      */
     awsS3BucketName?: string;
     /**
-     * AWS S3 endpoint.
+     * AWS S3 auth mode, either credentials or pod, defaults to credentials.
      */
-    awsS3Endpoint?: string;
+    awsS3AuthMode?: string;
     /**
-     * AWS S3 region.
+     * AWS S3 access key id.
      */
-    awsS3Region?: string;
+    awsS3AccessKeyId?: string;
     /**
      * AWS S3 secret access key.
      */
     awsS3SecretAccessKey?: string;
+    /**
+     * AWS S3 endpoint.
+     */
+    awsS3Endpoint?: string;
     /**
      * Azure Storage account key.
      */
@@ -257,7 +266,7 @@ export interface IEngineEnvironmentVariables {
      */
     hashicorpVaultEndpoint?: string;
     /**
-     * The type of background task connector, can be a comma separated list: console, entity-storage.
+     * The type of logging task connector, can be a comma separated list: console, entity-storage.
      */
     loggingConnector?: string;
     /**
@@ -273,25 +282,50 @@ export interface IEngineEnvironmentVariables {
      */
     eventBusComponent?: string;
     /**
-     * The type of messaging email connector: entity-storage, aws.
+     * Are the messaging components enabled, defaults to false.
      */
-    messagingEmailConnector?: string;
+    messagingEnabled?: string;
     /**
-     * The type of messaging sms connector: entity-storage, aws.
+     * An initial set of templates for the messages.
+     * Use the @json: prefix to specify the path to the JSON file.
      */
-    messagingSmsConnector?: string;
+    messagingTemplates?: string;
     /**
-     * The type of messaging push notification connector: entity-storage, aws.
+     * AWS SES region.
      */
-    messagingPushNotificationConnector?: string;
+    awsSesRegion?: string;
+    /**
+     * AWS SES auth mode, either credentials or pod, defaults to credentials.
+     */
+    awsSesAuthMode?: string;
+    /**
+     * AWS SES secret access key.
+     */
+    awsSesSecretAccessKey?: string;
+    /**
+     * AWS SES access key id.
+     */
+    awsSesAccessKeyId?: string;
+    /**
+     * AWS SES endpoint.
+     */
+    awsSesEndpoint?: string;
     /**
      * The applications for the push notifications JSON stringified array of IAwsApplicationSettings.
      */
     awsMessagingPushNotificationApplications?: string;
     /**
-     * The type of messaging component: service.
+     * The type of messaging email connector: entity-storage, aws.
      */
-    messagingComponent?: string;
+    messagingEmailConnector?: string;
+    /**
+     * The type of messaging sms connector: entity-storage, aws.
+     */
+    messagingSmsConnector?: string;
+    /**
+     * The type of messaging push notification connector: entity-storage, aws.
+     */
+    messagingPushNotificationConnector?: string;
     /**
      * The type of telemetry connector: entity-storage.
      */
@@ -368,6 +402,10 @@ export interface IEngineEnvironmentVariables {
      * The identity verification method id to use with attestation.
      */
     attestationVerificationMethodId?: string;
+    /**
+     * Is the data processing enabled, defaults to false.
+     */
+    dataProcessingEnabled?: string;
     /**
      * The type of the default data converters, can be a comma separated list: json, xml.
      */
@@ -376,6 +414,66 @@ export interface IEngineEnvironmentVariables {
      * The type of the default data extractor, can be a comma separated list: json-path.
      */
     dataExtractorConnectors?: string;
+    /**
+     * Is the auditable item graph enabled, defaults to false.
+     */
+    auditableItemGraphEnabled?: string;
+    /**
+     * Is the auditable item stream enabled, defaults to false.
+     */
+    auditableItemStreamEnabled?: string;
+    /**
+     * Is the document management enabled, defaults to false.
+     */
+    documentManagementEnabled?: string;
+    /**
+     * Is the synchronised storage enabled, defaults to false.
+     */
+    synchronisedStorageEnabled?: string;
+    /**
+     * Url which points to the api for a trusted synchronised storage node, not required if this is a trusted node.
+     */
+    synchronisedStorageTrustedUrl?: string;
+    /**
+     * The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
+     * This only required if using a custom verifiable storage item, otherwise it will default to the network name.
+     */
+    synchronisedStorageVerifiableStorageKeyId?: string;
+    /**
+     * The key from the vault which is used to encrypt the synchronised storage blobs.
+     * Only required for trusted nodes, as regular nodes will request from the trusted nodes.
+     * Defaults to synchronised-storage-blob-encryption
+     */
+    synchronisedStorageBlobStorageEncryptionKeyId?: string;
+    /**
+     * The key used for blob encryption, should be ChaCha20Poly1305 encoded as base64.
+     * Only required for trusted nodes, as regular nodes will not write encrypted data.
+     */
+    synchronisedStorageBlobStorageKey?: string;
+    /**
+     * How often to check for entity updates in minutes.
+     * @default 5
+     */
+    synchronisedStorageEntityUpdateIntervalMinutes?: string;
+    /**
+     * Interval to perform consolidation of changesets, only used if this is a trusted node.
+     * @default 60
+     */
+    synchronisedStorageConsolidationIntervalMinutes?: string;
+    /**
+     * The number of entities to process in a single consolidation batch, only used if this is a trusted node.
+     * @default 1000
+     */
+    synchronisedStorageConsolidationBatchSize?: string;
+    /**
+     * The maximum number of consolidations to keep in storage, only used if this is a trusted node.
+     * @default 5
+     */
+    synchronisedStorageMaxConsolidations?: string;
+    /**
+     * Is the federated catalogue enabled, defaults to false.
+     */
+    federatedCatalogueEnabled?: string;
     /**
      * Federated catalog TTL for the cache.
      */
@@ -389,7 +487,73 @@ export interface IEngineEnvironmentVariables {
      */
     rightsManagementEnabled?: string;
     /**
-     * Is the task scheduler enabled, defaults to true.
+     * What is the base callback url for rights management negotiations e.g. https://my-node/rights-management.
+     */
+    rightsManagementBaseCallbackUrl?: 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.
+     */
+    rightsManagementInformationSources?: 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.
+     */
+    rightsManagementNegotiators?: 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.
+     */
+    rightsManagementRequesters?: 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.
+     */
+    rightsManagementExecutionActions?: 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.
+     */
+    rightsManagementEnforcementProcessors?: 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.
+     */
+    rightsManagementArbiters?: 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.
+     */
+    rightsManagementOffers?: string;
+    /**
+     * Is the task scheduler enabled, defaults to false.
      */
     taskSchedulerEnabled?: string;
+    /**
+     * Is the data space connector enabled, defaults to false.
+     */
+    dataSpaceConnectorEnabled?: string;
+    /**
+     * The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
+     * @default 10
+     */
+    dataSpaceConnectorRetainActivityLogsFor?: string;
+    /**
+     * The interval for cleaning up the activity logs.
+     * @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.
+     */
+    extensions?: string;
 }

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

@@ -1,7 +1,8 @@
+import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables";
 /**
  * The engine server environment variables.
  */
-export interface IEngineServerEnvironmentVariables {
+export interface IEngineServerEnvironmentVariables extends IEngineEnvironmentVariables {
     /**
      * The port to serve the API from.
      */
@@ -43,7 +44,15 @@ export interface IEngineServerEnvironmentVariables {
      */
     mimeTypeProcessors?: string;
     /**
-     * Disable Node Identity route processors.
+     * Include the body in the REST logging output, useful for debugging.
      */
-    disableNodeIdentity?: string;
+    routeLoggingIncludeBody?: string;
+    /**
+     * Include the full base 64 output in the REST logging output, useful for debugging.
+     */
+    routeLoggingFullBase64?: string;
+    /**
+     * List of properties to obfuscate in the REST logging output, comma separated.
+     */
+    routeLoggingObfuscateProperties?: string;
 }

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

@@ -0,0 +1,6 @@
+import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+/**
+ * The config for the node.
+ */
+export interface INodeEngineConfig extends IEngineServerConfig {
+}

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

@@ -1,9 +1,8 @@
-import type { IEngineEnvironmentVariables } from "./IEngineEnvironmentVariables";
 import type { IEngineServerEnvironmentVariables } from "./IEngineServerEnvironmentVariables";
 /**
  * The environment variables for the node.
  */
-export interface INodeEnvironmentVariables extends IEngineEnvironmentVariables, IEngineServerEnvironmentVariables {
+export interface INodeEnvironmentVariables extends IEngineServerEnvironmentVariables {
     /**
      * The features that are enabled on the node.
      * @default [NodeFeatures.NodeIdentity]

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

@@ -1,5 +1,6 @@
 import type { IEngineCore, IEngineServer, IEngineStateStorage } from "@twin.org/engine-models";
 import type { IEngineConfig } from "@twin.org/engine-types";
+import type { INodeEngineConfig } from "./INodeEngineConfig";
 import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables";
 /**
  * The options when running the node.
@@ -45,6 +46,10 @@ export interface INodeOptions {
      * The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
      */
     openApiSpecFile?: string;
+    /**
+     * The path to the favicon, defaults to static/favicon.png.
+     */
+    favIconFile?: string;
     /**
      * Method to extend the engine environment variables with any additional custom configuration.
      */
@@ -52,7 +57,7 @@ export interface INodeOptions {
     /**
      * Method to extend the engine configuration with any additional custom configuration.
      */
-    extendConfig?: (config: IEngineConfig) => Promise<void>;
+    extendConfig?: (envVars: INodeEnvironmentVariables, config: INodeEngineConfig) => Promise<void>;
     /**
      * Method to extend the engine with any additional options.
      */

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

@@ -0,0 +1,27 @@
+import type { IEngineCore, IEngineServer } from "@twin.org/engine-models";
+import type { INodeEngineConfig } from "./INodeEngineConfig";
+import type { INodeEnvironmentVariables } from "./INodeEnvironmentVariables";
+/**
+ * The type for the initialise method of an extension module.
+ * @param envVars The environment variables for the node.
+ * @param nodeEngineConfig The node engine config.
+ */
+export type NodeExtensionInitialiseMethod = (envVars: INodeEnvironmentVariables, nodeEngineConfig: INodeEngineConfig) => Promise<void>;
+/**
+ * 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.
+ */
+export type NodeExtensionInitialiseEngineMethod = (engineCore: IEngineCore) => Promise<void>;
+/**
+ * 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.
+ */
+export type NodeExtensionInitialiseEngineServerMethod = (engineCore: IEngineCore, engineServer: IEngineServer) => Promise<void>;
+/**
+ * The type for the shutdown method of an extension module.
+ * This is called when the engine is shutting down.
+ */
+export type NodeExtensionShutdownMethod = () => Promise<void>;

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

@@ -10,6 +10,10 @@ export declare const NodeFeatures: {
      * NodeUser - generates a user for the node if not provided in config.
      */
     readonly NodeUser: "node-user";
+    /**
+     * NodeWallet - generates a wallet for the node and funds it when there is a faucet available.
+     */
+    readonly NodeWallet: "node-wallet";
 };
 /**
  * The features that can be enabled on the node.

package/dist/types/node.d.ts

@@ -1,5 +1,5 @@
 import type { IServerInfo } from "@twin.org/api-models";
-import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import type { INodeEngineConfig } from "./models/INodeEngineConfig";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
 import type { INodeOptions } from "./models/INodeOptions";
 /**
@@ -22,5 +22,10 @@ export declare function buildConfiguration(processEnv: {
     nodeEnvVars: INodeEnvironmentVariables & {
         [id: string]: string | unknown;
     };
-    engineServerConfig: IEngineServerConfig;
+    nodeEngineConfig: INodeEngineConfig;
 }>;
+/**
+ * Override module imports to use local files where possible.
+ * @param executionDirectory The execution directory for resolving local module paths.
+ */
+export declare function overrideModuleImport(executionDirectory: string): void;

package/dist/types/server.d.ts

@@ -2,16 +2,18 @@ import { Engine } from "@twin.org/engine";
 import { type IEngineState } from "@twin.org/engine-models";
 import { EngineServer } from "@twin.org/engine-server";
 import type { IEngineServerConfig } from "@twin.org/engine-server-types";
+import type { INodeEngineConfig } from "./models/INodeEngineConfig";
 import type { INodeEnvironmentVariables } from "./models/INodeEnvironmentVariables";
 import type { INodeOptions } from "./models/INodeOptions";
 /**
  * Start the engine server.
  * @param nodeOptions Optional run options for the engine server.
- * @param engineServerConfig The configuration for the engine server.
+ * @param nodeEngineConfig The configuration for the engine server.
  * @param envVars The environment variables.
  * @returns The engine server.
  */
-export declare function start(nodeOptions: INodeOptions | undefined, engineServerConfig: IEngineServerConfig, envVars: INodeEnvironmentVariables): Promise<{
+export declare function start(nodeOptions: INodeOptions | undefined, nodeEngineConfig: INodeEngineConfig, envVars: INodeEnvironmentVariables): Promise<{
     engine: Engine<IEngineServerConfig, IEngineState>;
     server: EngineServer;
+    shutdown: () => Promise<void>;
 } | undefined>;

package/dist/types/utils.d.ts

@@ -16,6 +16,30 @@ export declare function getExecutionDirectory(): string;
  * @returns True if the file exists.
  */
 export declare function fileExists(filename: string): Promise<boolean>;
+/**
+ * Does the specified directory exist.
+ * @param directory The directory to check for existence.
+ * @returns True if the directory exists.
+ */
+export declare function directoryExists(directory: string): Promise<boolean>;
+/**
+ * Get the sub folders for the folder.
+ * @param directory The directory to get the sub folders.
+ * @returns The list of sub folders.
+ */
+export declare function getSubFolders(directory: string): Promise<string[]>;
+/**
+ * Get the files in the directory.
+ * @param directory The directory to get the files from.
+ * @returns The list of files in the directory.
+ */
+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.
+ */
+export declare function loadTextFile(filename: string): Promise<string>;
 /**
  * Load the JSON file.
  * @param filename The filename of the JSON file to load.