@twin.org/node-core 0.0.2-next.4 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -485,8 +485,7 @@ async function bootstrapSynchronisedStorage(engineCore, context, envVars, featur
         await addVerificationMethod(engineCore, context, "synchronised storage", envVars.synchronisedStorageVerificationMethodId);
         // If this is a trusted node we need to add the blob encryption key pair
         if (core.Is.stringValue(envVars.synchronisedStorageBlobStorageEncryptionKeyId) &&
-            core.Is.stringBase64(envVars.synchronisedStorageBlobStoragePrivateKey) &&
-            core.Is.stringBase64(envVars.synchronisedStorageBlobStoragePublicKey)) {
+            core.Is.stringBase64(envVars.synchronisedStorageBlobStorageKey)) {
             const defaultVaultConnectorType = engineCore.getRegisteredInstanceType("vaultConnector");
             const vaultConnector = vaultModels.VaultConnectorFactory.get(defaultVaultConnectorType);
             const keyName = envVars.synchronisedStorageBlobStorageEncryptionKeyId;
@@ -497,7 +496,7 @@ async function bootstrapSynchronisedStorage(engineCore, context, envVars, featur
             catch { }
             if (core.Is.empty(existingKey)) {
                 engineCore.logInfo(core.I18n.formatMessage("node.addingSynchronisedStorageBlobEncryptionKey", { keyName }));
-                await vaultConnector.addKey(keyName, vaultModels.VaultKeyType.Rsa2048, core.Converter.base64ToBytes(envVars.synchronisedStorageBlobStoragePrivateKey), core.Converter.base64ToBytes(envVars.synchronisedStorageBlobStoragePublicKey));
+                await vaultConnector.addKey(keyName, vaultModels.VaultKeyType.ChaCha20Poly1305, core.Converter.base64ToBytes(envVars.synchronisedStorageBlobStorageKey));
             }
             else {
                 engineCore.logInfo(core.I18n.formatMessage("node.existingSynchronisedStorageBlobEncryptionKey", { keyName }));
@@ -1476,9 +1475,10 @@ function configureDlt(coreConfig, envVars) {
  * @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.
  */
-function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath) {
+function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath, favIconPath) {
     envVars.authSigningKeyId ??= "auth-signing";
     const webServerOptions = {
         port: core.Coerce.number(envVars.port),
@@ -1505,7 +1505,8 @@ function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, o
                     options: {
                         config: {
                             serverInfo,
-                            openApiSpecPath
+                            openApiSpecPath,
+                            favIconPath
                         }
                     }
                 }
@@ -1678,7 +1679,7 @@ async function run(nodeOptions) {
         nodeOptions ??= {};
         const serverInfo = {
             name: nodeOptions?.serverName ?? "TWIN Node Server",
-            version: nodeOptions?.serverVersion ?? "0.0.2-next.4" // x-release-please-version
+            version: nodeOptions?.serverVersion ?? "0.0.2-next.5" // x-release-please-version
         };
         console.log(`\u001B[4m🌩️  ${serverInfo.name} v${serverInfo.version}\u001B[24m\n`);
         if (!core.Is.stringValue(nodeOptions?.executionDirectory)) {
@@ -1691,13 +1692,21 @@ async function run(nodeOptions) {
         console.info("Locales Directory:", nodeOptions.localesDirectory);
         await initialiseLocales(nodeOptions.localesDirectory);
         if (core.Is.empty(nodeOptions?.openApiSpecFile)) {
-            const specFile = path.resolve(path.join(nodeOptions.executionDirectory, "docs", "open-api", "spec.json"));
+            const specFile = path.resolve(path.join(nodeOptions.executionDirectory ?? "", "docs", "open-api", "spec.json"));
             console.info("Default OpenAPI Spec File:", specFile);
             if (await fileExists(specFile)) {
                 nodeOptions ??= {};
                 nodeOptions.openApiSpecFile = specFile;
             }
         }
+        if (core.Is.empty(nodeOptions?.favIconFile)) {
+            const favIconFile = path.resolve(path.join(nodeOptions.executionDirectory ?? "", "static", "favicon.png"));
+            console.info("Default Favicon File:", favIconFile);
+            if (await fileExists(favIconFile)) {
+                nodeOptions ??= {};
+                nodeOptions.favIconFile = favIconFile;
+            }
+        }
         nodeOptions.envPrefix ??= "TWIN_NODE_";
         console.info("Environment Prefix:", nodeOptions.envPrefix);
         const { engineServerConfig, nodeEnvVars: envVars } = await buildConfiguration(process.env, nodeOptions, serverInfo);
@@ -1767,7 +1776,7 @@ async function buildConfiguration(processEnv, options, serverInfo) {
     }
     // Build the engine configuration from the environment variables.
     const coreConfig = buildEngineConfiguration(envVars);
-    const engineServerConfig = buildEngineServerConfiguration(envVars, coreConfig, serverInfo, options?.openApiSpecFile);
+    const engineServerConfig = buildEngineServerConfiguration(envVars, coreConfig, serverInfo, options?.openApiSpecFile, options?.favIconFile);
     // Merge any custom configuration provided in the options.
     if (core.Is.arrayValue(options?.configFilenames)) {
         for (const configFile of options.configFilenames) {

package/dist/esm/index.mjs

@@ -464,8 +464,7 @@ async function bootstrapSynchronisedStorage(engineCore, context, envVars, featur
         await addVerificationMethod(engineCore, context, "synchronised storage", envVars.synchronisedStorageVerificationMethodId);
         // If this is a trusted node we need to add the blob encryption key pair
         if (Is.stringValue(envVars.synchronisedStorageBlobStorageEncryptionKeyId) &&
-            Is.stringBase64(envVars.synchronisedStorageBlobStoragePrivateKey) &&
-            Is.stringBase64(envVars.synchronisedStorageBlobStoragePublicKey)) {
+            Is.stringBase64(envVars.synchronisedStorageBlobStorageKey)) {
             const defaultVaultConnectorType = engineCore.getRegisteredInstanceType("vaultConnector");
             const vaultConnector = VaultConnectorFactory.get(defaultVaultConnectorType);
             const keyName = envVars.synchronisedStorageBlobStorageEncryptionKeyId;
@@ -476,7 +475,7 @@ async function bootstrapSynchronisedStorage(engineCore, context, envVars, featur
             catch { }
             if (Is.empty(existingKey)) {
                 engineCore.logInfo(I18n.formatMessage("node.addingSynchronisedStorageBlobEncryptionKey", { keyName }));
-                await vaultConnector.addKey(keyName, VaultKeyType.Rsa2048, Converter.base64ToBytes(envVars.synchronisedStorageBlobStoragePrivateKey), Converter.base64ToBytes(envVars.synchronisedStorageBlobStoragePublicKey));
+                await vaultConnector.addKey(keyName, VaultKeyType.ChaCha20Poly1305, Converter.base64ToBytes(envVars.synchronisedStorageBlobStorageKey));
             }
             else {
                 engineCore.logInfo(I18n.formatMessage("node.existingSynchronisedStorageBlobEncryptionKey", { keyName }));
@@ -1455,9 +1454,10 @@ function configureDlt(coreConfig, envVars) {
  * @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.
  */
-function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath) {
+function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, openApiSpecPath, favIconPath) {
     envVars.authSigningKeyId ??= "auth-signing";
     const webServerOptions = {
         port: Coerce.number(envVars.port),
@@ -1484,7 +1484,8 @@ function buildEngineServerConfiguration(envVars, coreEngineConfig, serverInfo, o
                     options: {
                         config: {
                             serverInfo,
-                            openApiSpecPath
+                            openApiSpecPath,
+                            favIconPath
                         }
                     }
                 }
@@ -1657,7 +1658,7 @@ async function run(nodeOptions) {
         nodeOptions ??= {};
         const serverInfo = {
             name: nodeOptions?.serverName ?? "TWIN Node Server",
-            version: nodeOptions?.serverVersion ?? "0.0.2-next.4" // x-release-please-version
+            version: nodeOptions?.serverVersion ?? "0.0.2-next.5" // x-release-please-version
         };
         console.log(`\u001B[4m🌩️  ${serverInfo.name} v${serverInfo.version}\u001B[24m\n`);
         if (!Is.stringValue(nodeOptions?.executionDirectory)) {
@@ -1670,13 +1671,21 @@ async function run(nodeOptions) {
         console.info("Locales Directory:", nodeOptions.localesDirectory);
         await initialiseLocales(nodeOptions.localesDirectory);
         if (Is.empty(nodeOptions?.openApiSpecFile)) {
-            const specFile = path.resolve(path.join(nodeOptions.executionDirectory, "docs", "open-api", "spec.json"));
+            const specFile = path.resolve(path.join(nodeOptions.executionDirectory ?? "", "docs", "open-api", "spec.json"));
             console.info("Default OpenAPI Spec File:", specFile);
             if (await fileExists(specFile)) {
                 nodeOptions ??= {};
                 nodeOptions.openApiSpecFile = specFile;
             }
         }
+        if (Is.empty(nodeOptions?.favIconFile)) {
+            const favIconFile = path.resolve(path.join(nodeOptions.executionDirectory ?? "", "static", "favicon.png"));
+            console.info("Default Favicon File:", favIconFile);
+            if (await fileExists(favIconFile)) {
+                nodeOptions ??= {};
+                nodeOptions.favIconFile = favIconFile;
+            }
+        }
         nodeOptions.envPrefix ??= "TWIN_NODE_";
         console.info("Environment Prefix:", nodeOptions.envPrefix);
         const { engineServerConfig, nodeEnvVars: envVars } = await buildConfiguration(process.env, nodeOptions, serverInfo);
@@ -1746,7 +1755,7 @@ async function buildConfiguration(processEnv, options, serverInfo) {
     }
     // Build the engine configuration from the environment variables.
     const coreConfig = buildEngineConfiguration(envVars);
-    const engineServerConfig = buildEngineServerConfiguration(envVars, coreConfig, serverInfo, options?.openApiSpecFile);
+    const engineServerConfig = buildEngineServerConfiguration(envVars, coreConfig, serverInfo, options?.openApiSpecFile, options?.favIconFile);
     // Merge any custom configuration provided in the options.
     if (Is.arrayValue(options?.configFilenames)) {
         for (const configFile of options.configFilenames) {

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/models/IEngineEnvironmentVariables.d.ts

@@ -402,15 +402,10 @@ export interface IEngineEnvironmentVariables {
      */
     synchronisedStorageBlobStorageEncryptionKeyId?: string;
     /**
-     * The private key used for blob encryption, should be RSA-2048 DER format encoded as base64.
+     * 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.
      */
-    synchronisedStorageBlobStoragePrivateKey?: string;
-    /**
-     * The public key used for blob decryption, should be RSA-2048 DER format encoded as base64.
-     * Only required for trusted nodes, as regular nodes will request the key from trusted nodes.
-     */
-    synchronisedStorageBlobStoragePublicKey?: string;
+    synchronisedStorageBlobStorageKey?: string;
     /**
      * How often to check for entity updates in minutes.
      * @default 5

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/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/node-core - Changelog
 
+## [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)
 
 

package/docs/reference/functions/buildEngineServerConfiguration.md

@@ -1,6 +1,6 @@
 # Function: buildEngineServerConfiguration()
 
-> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`): `IEngineServerConfig`
+> **buildEngineServerConfiguration**(`envVars`, `coreEngineConfig`, `serverInfo`, `openApiSpecPath?`, `favIconPath?`): `IEngineServerConfig`
 
 Handles the configuration of the server.
 
@@ -30,6 +30,12 @@ The server information.
 
 The path to the open api spec.
 
+### favIconPath?
+
+`string`
+
+The path to the favicon.
+
 ## Returns
 
 `IEngineServerConfig`

package/docs/reference/interfaces/IEngineEnvironmentVariables.md

@@ -799,24 +799,15 @@ Defaults to synchronised-storage-blob-encryption
 
 ***
 
-### synchronisedStorageBlobStoragePrivateKey?
+### synchronisedStorageBlobStorageKey?
 
-> `optional` **synchronisedStorageBlobStoragePrivateKey**: `string`
+> `optional` **synchronisedStorageBlobStorageKey**: `string`
 
-The private key used for blob encryption, should be RSA-2048 DER format encoded as base64.
+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.
 
 ***
 
-### synchronisedStorageBlobStoragePublicKey?
-
-> `optional` **synchronisedStorageBlobStoragePublicKey**: `string`
-
-The public key used for blob decryption, should be RSA-2048 DER format encoded as base64.
-Only required for trusted nodes, as regular nodes will request the key from trusted nodes.
-
-***
-
 ### synchronisedStorageEntityUpdateIntervalMinutes?
 
 > `optional` **synchronisedStorageEntityUpdateIntervalMinutes**: `string`

package/docs/reference/interfaces/INodeEnvironmentVariables.md

@@ -1191,29 +1191,16 @@ Defaults to synchronised-storage-blob-encryption
 
 ***
 
-### synchronisedStorageBlobStoragePrivateKey?
+### synchronisedStorageBlobStorageKey?
 
-> `optional` **synchronisedStorageBlobStoragePrivateKey**: `string`
+> `optional` **synchronisedStorageBlobStorageKey**: `string`
 
-The private key used for blob encryption, should be RSA-2048 DER format encoded as base64.
+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.
 
 #### Inherited from
 
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStoragePrivateKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstorageprivatekey)
-
-***
-
-### synchronisedStorageBlobStoragePublicKey?
-
-> `optional` **synchronisedStorageBlobStoragePublicKey**: `string`
-
-The public key used for blob decryption, should be RSA-2048 DER format encoded as base64.
-Only required for trusted nodes, as regular nodes will request the key from trusted nodes.
-
-#### Inherited from
-
-[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStoragePublicKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragepublickey)
+[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`synchronisedStorageBlobStorageKey`](IEngineEnvironmentVariables.md#synchronisedstorageblobstoragekey)
 
 ***
 

package/docs/reference/interfaces/INodeOptions.md

@@ -85,6 +85,14 @@ The path to the OpenAPI spec file, defaults to docs/open-api/spec.json.
 
 ***
 
+### favIconFile?
+
+> `optional` **favIconFile**: `string`
+
+The path to the favicon, defaults to static/favicon.png.
+
+***
+
 ### extendEnvVars()?
 
 > `optional` **extendEnvVars**: (`envVars`) => `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/node-core",
-	"version": "0.0.2-next.4",
+	"version": "0.0.2-next.5",
 	"description": "TWIN Node Core for serving APIs using the specified configuration",
 	"repository": {
 		"type": "git",
@@ -28,7 +28,7 @@
 		"@twin.org/identity-models": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/wallet-models": "next",
-		"dotenv": "17.2.0",
+		"dotenv": "17.2.1",
 		"schema-dts": "1.1.5"
 	},
 	"main": "./dist/cjs/index.cjs",