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

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/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.
+ * @param favIconPath The path to the favicon.
  * @returns The 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): IEngineServerConfig;

package/dist/types/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./bootstrap";
 export * from "./builders/engineEnvBuilder";
+export * from "./builders/engineServerEnvBuilder";
 export * from "./models/IEngineEnvironmentVariables";
 export * from "./models/IEngineServerEnvironmentVariables";
 export * from "./models/INodeEnvironmentVariables";

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

@@ -15,21 +15,18 @@ export interface IEngineEnvironmentVariables {
      */
     stateFilename?: string;
     /**
-     * The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb, mysql, mongodb, postgresql.
+     * 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
      */
     entityStorageConnectorType?: string;
     /**
-     * A prefix for all the table in entity-storage, can be empty.
-     */
-    entityStorageTablePrefix?: string;
-    /**
-     * Enable the file entity storage connector.
+     * The default entity storage connector to use, defaults to the first one in the list.
      */
-    entityFileEnable?: string;
+    entityStorageConnectorDefault?: string;
     /**
-     * Enable the memory entity storage connector.
+     * A prefix for all the table in entity-storage, can be empty.
      */
-    entityMemoryEnable?: string;
+    entityStorageTablePrefix?: string;
     /**
      * AWS Dynamo DB access key id.
      */
@@ -94,6 +91,10 @@ export interface IEngineEnvironmentVariables {
      * ScyllaDB local data center.
      */
     scylladbLocalDataCenter?: string;
+    /**
+     * ScyllaDB port.
+     */
+    scylladbPort?: string;
     /**
      * MySQL host.
      */
@@ -163,29 +164,35 @@ export interface IEngineEnvironmentVariables {
      */
     ipfsApiUrl?: string;
     /**
-     * The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
+     * The type of the entity storage to create, comma separate for more than one connector.
+     * values: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
      */
     blobStorageConnectorType?: string;
     /**
-     * Enable encryption for the blob storage.
+     * The default blob storage connector to use, defaults to the first one in the list.
      */
-    blobStorageEnableEncryption?: string;
+    blobStorageConnectorDefault?: string;
     /**
-     * The encryption key for the blob storage.
+     * Blog storage connector which has public access.
      */
-    blobStorageEncryptionKey?: string;
+    blobStorageConnectorPublic?: string;
     /**
-     * A prefix for all the blobs in blob-storage, can be empty.
+     * Enable encryption for the blob storage.
      */
-    blobStoragePrefix?: string;
+    blobStorageEnableEncryption?: string;
     /**
-     * Enable the file blob storage connector.
+     * The id of the encryption key for the blob storage.
      */
-    blobFileEnable?: string;
+    blobStorageEncryptionKeyId?: string;
     /**
-     * Enable the memory blob storage connector.
+     * 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.
      */
-    blobMemoryEnable?: string;
+    blobStorageSymmetricEncryptionKey?: string;
+    /**
+     * A prefix for all the blobs in blob-storage, can be empty.
+     */
+    blobStoragePrefix?: string;
     /**
      * AWS S3 access key id.
      */
@@ -370,6 +377,59 @@ export interface IEngineEnvironmentVariables {
      * The type of the default data extractor, can be a comma separated list: json-path.
      */
     dataExtractorConnectors?: 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 the the network name.
+     */
+    synchronisedStorageVerifiableStorageKeyId?: string;
+    /**
+     * The identity verification method id to use with synchronised storage for signing/verifying changesets.
+     * Defaults to synchronised-storage-assertion.
+     */
+    synchronisedStorageVerificationMethodId?: 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.
      */
@@ -383,7 +443,41 @@ export interface IEngineEnvironmentVariables {
      */
     rightsManagementEnabled?: string;
     /**
-     * Is the task scheduler enabled, defaults to true.
+     * The rights management verification method id to use when signing/verifying negotiation requests.
+     * Defaults to policy-negotiation-assertion.
+     */
+    rightsManagementNegotiationMethodId?: 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 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 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;
+    /**
+     * Is the task scheduler enabled, defaults to false.
      */
     taskSchedulerEnabled?: string;
+    /**
+     * Is the data space connector enabled, defaults to false.
+     */
+    dataSpaceConnectorEnabled?: string;
+    /**
+     * The application configuration for the data space connector.
+     * Use the @json: prefix to specify the path to the JSON configuration file.
+     */
+    dataSpaceConnectorApps?: string;
 }

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

@@ -45,6 +45,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.
      */

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

@@ -24,3 +24,8 @@ export declare function buildConfiguration(processEnv: {
     };
     engineServerConfig: IEngineServerConfig;
 }>;
+/**
+ * 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/utils.d.ts

@@ -16,6 +16,12 @@ export declare function getExecutionDirectory(): string;
  * @returns True if the file exists.
  */
 export declare function fileExists(filename: string): Promise<boolean>;
+/**
+ * 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.

package/docs/changelog.md

@@ -1,5 +1,97 @@
 # @twin.org/node-core - Changelog
 
+## [0.0.2-next.10](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.9...node-core-v0.0.2-next.10) (2025-09-05)
+
+
+### Features
+
+* add rights management components ([0fc6293](https://github.com/twinfoundation/node/commit/0fc629332db24494bd73003625c7bf3f939a2597))
+
+## [0.0.2-next.9](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.8...node-core-v0.0.2-next.9) (2025-08-31)
+
+
+### Features
+
+* eslint migration to flat config ([080db74](https://github.com/twinfoundation/node/commit/080db746390230f78725d214bc957da2efee9eb1))
+
+## [0.0.2-next.8](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.7...node-core-v0.0.2-next.8) (2025-08-27)
+
+
+### Features
+
+* add module override for better local import resolution ([ba00d17](https://github.com/twinfoundation/node/commit/ba00d17beea0a9a1851c89ad7c6a33256051c818))
+
+## [0.0.2-next.7](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.6...node-core-v0.0.2-next.7) (2025-08-26)
+
+
+### Features
+
+* add data space connector ([5a57087](https://github.com/twinfoundation/node/commit/5a57087d938265d3a4a812ff7c83d130ea4e103c))
+* add data space connector ([f7a3644](https://github.com/twinfoundation/node/commit/f7a364477ec664e333e5ad018795acec6ee61edc))
+* add data space connector ([157e8b0](https://github.com/twinfoundation/node/commit/157e8b0a76e3a8a63c1991924f7f963eb83e27ae))
+
+## [0.0.2-next.6](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.5...node-core-v0.0.2-next.6) (2025-08-22)
+
+
+### Features
+
+* add rights management ([78fba62](https://github.com/twinfoundation/node/commit/78fba62f82afdbe615d55dd90eca8ee70ea62fc0))
+* remove unused properties ([d8344b5](https://github.com/twinfoundation/node/commit/d8344b5aee5dc1c8104d75fad5093097f6530168))
+
+## [0.0.2-next.5](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.4...node-core-v0.0.2-next.5) (2025-08-21)
+
+
+### Features
+
+* update framework core ([8bd769a](https://github.com/twinfoundation/node/commit/8bd769a4451f5f1f6be3f115a5e94eeb05bce7f1))
+
+## [0.0.2-next.4](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.3...node-core-v0.0.2-next.4) (2025-08-14)
+
+
+### Features
+
+* add synchronised storage config ([e315869](https://github.com/twinfoundation/node/commit/e315869adbffcd7fe5d3ce151dd35f662f6134a9))
+
+## [0.0.2-next.3](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.2...node-core-v0.0.2-next.3) (2025-07-21)
+
+
+### Features
+
+* update to latest engine config ([347386c](https://github.com/twinfoundation/node/commit/347386c0609e717dc20c456ad2264c83df793c59))
+
+## [0.0.2-next.2](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.1...node-core-v0.0.2-next.2) (2025-07-17)
+
+
+### Features
+
+* support multiple entity and blob storage connectors ([a489f79](https://github.com/twinfoundation/node/commit/a489f7907544aef5708d5111e9f72985e1377bae))
+
+## [0.0.2-next.1](https://github.com/twinfoundation/node/compare/node-core-v0.0.2-next.0...node-core-v0.0.2-next.1) (2025-07-15)
+
+
+### Features
+
+* add auth admin component ([1661e57](https://github.com/twinfoundation/node/commit/1661e57a699d5cf9ebde333e3cbc3aaea89d7c9c))
+* add extend engine and server methods ([ec09c7e](https://github.com/twinfoundation/node/commit/ec09c7eb882d9f5797f2fd372e96cad1a3716f59))
+* add extend engine and server methods ([0136a6f](https://github.com/twinfoundation/node/commit/0136a6f3f4e1a82b1427ee9618b8a17c79bc7fda))
+* add missing export ([e8eb621](https://github.com/twinfoundation/node/commit/e8eb6213937a202520b164a9970a891004122b61))
+* additional run options ([c35e5bb](https://github.com/twinfoundation/node/commit/c35e5bbb8a80fe6a36628d41f64585b3723d9ad7))
+* additional startup logging ([0740293](https://github.com/twinfoundation/node/commit/0740293b366032f2907046603abf587c9c324aff))
+* improve default options and spec ([b538721](https://github.com/twinfoundation/node/commit/b538721902e7f65021d2715148ba59409ccce035))
+* improve error reporting ([fcd39a1](https://github.com/twinfoundation/node/commit/fcd39a18da2a6ce33965a99ca5f2f36f4aba712f))
+* initial commit ([522f1e5](https://github.com/twinfoundation/node/commit/522f1e515348f9b1dd1eeb3170b1249e2b0b5371))
+* migrate env config from engine to node ([5da29b8](https://github.com/twinfoundation/node/commit/5da29b8d714495308320d237a68e84355bba2b47))
+* node app use JavaScript ([14fe08c](https://github.com/twinfoundation/node/commit/14fe08cb760dd885a5dac9056a4d5dbc3d61df64))
+* update dependencies ([9d25f16](https://github.com/twinfoundation/node/commit/9d25f16f1d554cd38f3bec28fdf7f8fff892ceaf))
+
+
+### Bug Fixes
+
+* adding a condition to verify if the password exists when bootstrapping ([6030a42](https://github.com/twinfoundation/node/commit/6030a42bdaf581678d96932fd0b809396bf7b8b0))
+* adding a condition to verify if the password exists when bootstrapping ([c66f396](https://github.com/twinfoundation/node/commit/c66f396717394161a7647d1f08b3d87729d96e96))
+* broken docs ([61479fd](https://github.com/twinfoundation/node/commit/61479fd618f766d22c5aafec5277e1a89e22b453))
+* pr comments [#1](https://github.com/twinfoundation/node/issues/1) ([66e795b](https://github.com/twinfoundation/node/commit/66e795b16c372ab131ec1de30085aee90e4dbbd0))
+
 ## 0.0.1 (2025-07-11)
 
 

package/docs/reference/functions/{bootstrapAttestationMethod.md → bootstrapSynchronisedStorage.md}

@@ -1,8 +1,8 @@
-# Function: bootstrapAttestationMethod()
+# Function: bootstrapSynchronisedStorage()
 
-> **bootstrapAttestationMethod**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
+> **bootstrapSynchronisedStorage**(`engineCore`, `context`, `envVars`, `features`): `Promise`\<`void`\>
 
-Bootstrap the attestation verification methods.
+Bootstrap the synchronised storage blob encryption and verification methods.
 
 ## Parameters
 

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -0,0 +1,43 @@
+# Function: buildEngineServerConfiguration()
+
+> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`, `favIconPath?`): `IEngineServerConfig`
+
+Handles the configuration of the server.
+
+## Parameters
+
+### envVars
+
+[`IEngineServerEnvironmentVariables`](../interfaces/IEngineServerEnvironmentVariables.md)
+
+The environment variables for the engine server.
+
+### coreEngineConfig
+
+`IEngineCoreConfig`
+
+The core engine config.
+
+### serverInfo
+
+`IServerInfo`
+
+The server information.
+
+### openApiSpecPath?
+
+`string`
+
+The path to the open api spec.
+
+### favIconPath?
+
+`string`
+
+The path to the favicon.
+
+## Returns
+
+`IEngineServerConfig`
+
+The the config for the core and the server.

package/docs/reference/functions/loadTextFile.md

@@ -0,0 +1,19 @@
+# Function: loadTextFile()
+
+> **loadTextFile**(`filename`): `Promise`\<`string`\>
+
+Load the text file.
+
+## Parameters
+
+### filename
+
+`string`
+
+The filename of the text file to load.
+
+## Returns
+
+`Promise`\<`string`\>
+
+The contents of the text file if it could not be loaded.

package/docs/reference/functions/overrideModuleImport.md

@@ -0,0 +1,17 @@
+# Function: overrideModuleImport()
+
+> **overrideModuleImport**(`executionDirectory`): `void`
+
+Override module imports to use local files where possible.
+
+## Parameters
+
+### executionDirectory
+
+`string`
+
+The execution directory for resolving local module paths.
+
+## Returns
+
+`void`

package/docs/reference/index.md

@@ -20,16 +20,19 @@
 - [bootstrap](functions/bootstrap.md)
 - [bootstrapNodeIdentity](functions/bootstrapNodeIdentity.md)
 - [bootstrapNodeUser](functions/bootstrapNodeUser.md)
-- [bootstrapAttestationMethod](functions/bootstrapAttestationMethod.md)
 - [bootstrapImmutableProofMethod](functions/bootstrapImmutableProofMethod.md)
 - [bootstrapBlobEncryption](functions/bootstrapBlobEncryption.md)
 - [bootstrapAuth](functions/bootstrapAuth.md)
+- [bootstrapSynchronisedStorage](functions/bootstrapSynchronisedStorage.md)
 - [buildEngineConfiguration](functions/buildEngineConfiguration.md)
+- [buildEngineServerConfiguration](functions/buildEngineServerConfiguration.md)
 - [run](functions/run.md)
 - [buildConfiguration](functions/buildConfiguration.md)
+- [overrideModuleImport](functions/overrideModuleImport.md)
 - [start](functions/start.md)
 - [initialiseLocales](functions/initialiseLocales.md)
 - [getExecutionDirectory](functions/getExecutionDirectory.md)
 - [fileExists](functions/fileExists.md)
+- [loadTextFile](functions/loadTextFile.md)
 - [loadJsonFile](functions/loadJsonFile.md)
 - [getFeatures](functions/getFeatures.md)