@twin.org/engine-core 0.0.1-next.6 → 0.0.1-next.8

package/dist/cjs/index.cjs

@@ -1673,13 +1673,24 @@ function buildEngineCoreConfiguration(envVars) {
     envVars.attestationAssertionMethodId ??= "attestation-assertion";
     envVars.immutableProofHashKeyId ??= "immutable-proof-hash";
     envVars.immutableProofAssertionMethodId ??= "immutable-proof-assertion";
+    envVars.blobStorageEnableEncryption ??= "false";
+    envVars.blobStorageEncryptionKey ??= "blob-encryption";
     const coreConfig = {
         debug: core.Coerce.boolean(envVars.debug) ?? false,
         loggingConnector: [],
         loggingComponent: [{ type: engineModels.LoggingComponentType.Service }],
         entityStorageConnector: [],
         blobStorageConnector: [],
-        blobStorageComponent: [{ type: engineModels.BlobStorageComponentType.Service }],
+        blobStorageComponent: [
+            {
+                type: engineModels.BlobStorageComponentType.Service,
+                options: {
+                    config: {
+                        vaultKeyId: envVars.blobStorageEncryptionKey
+                    }
+                }
+            }
+        ],
         backgroundTaskConnector: [],
         telemetryConnector: [],
         telemetryComponent: [{ type: engineModels.TelemetryComponentType.Service }],
@@ -1735,10 +1746,14 @@ function buildEngineCoreConfiguration(envVars) {
  */
 function configureEntityStorageConnectors(coreConfig, envVars) {
     coreConfig.entityStorageConnector ??= [];
-    coreConfig.entityStorageConnector.push({
-        type: engineModels.EntityStorageConnectorType.Memory
-    });
-    if (core.Is.stringValue(envVars.storageFileRoot)) {
+    if ((core.Coerce.boolean(envVars.entityMemoryEnable) ?? false) ||
+        envVars.blobStorageConnectorType === engineModels.EntityStorageConnectorType.Memory) {
+        coreConfig.entityStorageConnector.push({
+            type: engineModels.EntityStorageConnectorType.Memory
+        });
+    }
+    if ((core.Coerce.boolean(envVars.entityFileEnable) ?? false) ||
+        envVars.entityStorageConnectorType === engineModels.EntityStorageConnectorType.File) {
         coreConfig.entityStorageConnector.push({
             type: engineModels.EntityStorageConnectorType.File,
             options: { config: { directory: envVars.storageFileRoot } }
@@ -1815,13 +1830,15 @@ function configureEntityStorageConnectors(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 function configureBlobStorageConnectors(coreConfig, envVars) {
-    envVars.blobStorageEnableEncryption ??= "false";
-    envVars.blobStorageEncryptionKey ??= "blob-encryption";
     coreConfig.blobStorageConnector ??= [];
-    coreConfig.blobStorageConnector.push({
-        type: engineModels.BlobStorageConnectorType.Memory
-    });
-    if (core.Is.stringValue(envVars.storageFileRoot)) {
+    if ((core.Coerce.boolean(envVars.blobMemoryEnable) ?? false) ||
+        envVars.blobStorageConnectorType === engineModels.BlobStorageConnectorType.Memory) {
+        coreConfig.blobStorageConnector.push({
+            type: engineModels.BlobStorageConnectorType.Memory
+        });
+    }
+    if ((core.Coerce.boolean(envVars.blobFileEnable) ?? false) ||
+        envVars.blobStorageConnectorType === engineModels.BlobStorageConnectorType.File) {
         coreConfig.blobStorageConnector.push({
             type: engineModels.BlobStorageConnectorType.File,
             options: {
@@ -2145,7 +2162,6 @@ function configureAttestationConnectors(coreConfig, envVars) {
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-// SPDX-License-Identifier: Apache-2.0.
 /**
  * Environment variable helper.
  */
@@ -2156,7 +2172,7 @@ class EnvHelper {
      * @param prefix The prefix of the environment variables.
      * @returns The object with camel cased names.
      */
-    envToJson(envVars, prefix) {
+    static envToJson(envVars, prefix) {
         const result = {};
         for (const envVar in envVars) {
             if (envVar.startsWith(prefix) && core.Is.stringValue(process.env[envVar])) {

package/dist/esm/index.mjs

@@ -1671,13 +1671,24 @@ function buildEngineCoreConfiguration(envVars) {
     envVars.attestationAssertionMethodId ??= "attestation-assertion";
     envVars.immutableProofHashKeyId ??= "immutable-proof-hash";
     envVars.immutableProofAssertionMethodId ??= "immutable-proof-assertion";
+    envVars.blobStorageEnableEncryption ??= "false";
+    envVars.blobStorageEncryptionKey ??= "blob-encryption";
     const coreConfig = {
         debug: Coerce.boolean(envVars.debug) ?? false,
         loggingConnector: [],
         loggingComponent: [{ type: LoggingComponentType.Service }],
         entityStorageConnector: [],
         blobStorageConnector: [],
-        blobStorageComponent: [{ type: BlobStorageComponentType.Service }],
+        blobStorageComponent: [
+            {
+                type: BlobStorageComponentType.Service,
+                options: {
+                    config: {
+                        vaultKeyId: envVars.blobStorageEncryptionKey
+                    }
+                }
+            }
+        ],
         backgroundTaskConnector: [],
         telemetryConnector: [],
         telemetryComponent: [{ type: TelemetryComponentType.Service }],
@@ -1733,10 +1744,14 @@ function buildEngineCoreConfiguration(envVars) {
  */
 function configureEntityStorageConnectors(coreConfig, envVars) {
     coreConfig.entityStorageConnector ??= [];
-    coreConfig.entityStorageConnector.push({
-        type: EntityStorageConnectorType.Memory
-    });
-    if (Is.stringValue(envVars.storageFileRoot)) {
+    if ((Coerce.boolean(envVars.entityMemoryEnable) ?? false) ||
+        envVars.blobStorageConnectorType === EntityStorageConnectorType.Memory) {
+        coreConfig.entityStorageConnector.push({
+            type: EntityStorageConnectorType.Memory
+        });
+    }
+    if ((Coerce.boolean(envVars.entityFileEnable) ?? false) ||
+        envVars.entityStorageConnectorType === EntityStorageConnectorType.File) {
         coreConfig.entityStorageConnector.push({
             type: EntityStorageConnectorType.File,
             options: { config: { directory: envVars.storageFileRoot } }
@@ -1813,13 +1828,15 @@ function configureEntityStorageConnectors(coreConfig, envVars) {
  * @param envVars The environment variables.
  */
 function configureBlobStorageConnectors(coreConfig, envVars) {
-    envVars.blobStorageEnableEncryption ??= "false";
-    envVars.blobStorageEncryptionKey ??= "blob-encryption";
     coreConfig.blobStorageConnector ??= [];
-    coreConfig.blobStorageConnector.push({
-        type: BlobStorageConnectorType.Memory
-    });
-    if (Is.stringValue(envVars.storageFileRoot)) {
+    if ((Coerce.boolean(envVars.blobMemoryEnable) ?? false) ||
+        envVars.blobStorageConnectorType === BlobStorageConnectorType.Memory) {
+        coreConfig.blobStorageConnector.push({
+            type: BlobStorageConnectorType.Memory
+        });
+    }
+    if ((Coerce.boolean(envVars.blobFileEnable) ?? false) ||
+        envVars.blobStorageConnectorType === BlobStorageConnectorType.File) {
         coreConfig.blobStorageConnector.push({
             type: BlobStorageConnectorType.File,
             options: {
@@ -2143,7 +2160,6 @@ function configureAttestationConnectors(coreConfig, envVars) {
 
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-// SPDX-License-Identifier: Apache-2.0.
 /**
  * Environment variable helper.
  */
@@ -2154,7 +2170,7 @@ class EnvHelper {
      * @param prefix The prefix of the environment variables.
      * @returns The object with camel cased names.
      */
-    envToJson(envVars, prefix) {
+    static envToJson(envVars, prefix) {
         const result = {};
         for (const envVar in envVars) {
             if (envVar.startsWith(prefix) && Is.stringValue(process.env[envVar])) {

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

@@ -22,6 +22,14 @@ export interface IEngineCoreEnvironmentVariables {
      * A prefix for all the table in entity-storage, can be empty.
      */
     entityStorageTablePrefix: string;
+    /**
+     * Enable the file entity storage connector.
+     */
+    entityFileEnable: string;
+    /**
+     * Enable the memory entity storage connector.
+     */
+    entityMemoryEnable: string;
     /**
      * AWS Dynamo DB access key id.
      */
@@ -110,6 +118,14 @@ export interface IEngineCoreEnvironmentVariables {
      * A prefix for all the blobs in blob-storage, can be empty.
      */
     blobStoragePrefix: string;
+    /**
+     * Enable the file blob storage connector.
+     */
+    blobFileEnable: string;
+    /**
+     * Enable the memory blob storage connector.
+     */
+    blobMemoryEnable: string;
     /**
      * AWS S3 access key id.
      */

package/dist/types/utils/envHelper.d.ts

@@ -1,3 +1,4 @@
+import type { IEngineCoreEnvironmentVariables } from "../models/IEngineCoreEnvironmentVariables";
 /**
  * Environment variable helper.
  */
@@ -8,7 +9,7 @@ export declare class EnvHelper {
      * @param prefix The prefix of the environment variables.
      * @returns The object with camel cased names.
      */
-    envToJson<T = unknown>(envVars: {
+    static envToJson<T = IEngineCoreEnvironmentVariables>(envVars: {
         [id: string]: string | undefined;
     }, prefix: string): T;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/engine-core - Changelog
 
-## v0.0.1-next.6
+## v0.0.1-next.8
 
 - Initial Release

package/docs/reference/classes/EnvHelper.md

@@ -16,13 +16,13 @@ Environment variable helper.
 
 ### envToJson()
 
-> **envToJson**\<`T`\>(`envVars`, `prefix`): `T`
+> `static` **envToJson**\<`T`\>(`envVars`, `prefix`): `T`
 
 Get the environment variable as an object with camel cased names.
 
 #### Type Parameters
 
-• **T** = `unknown`
+• **T** = [`IEngineCoreEnvironmentVariables`](../interfaces/IEngineCoreEnvironmentVariables.md)
 
 #### Parameters
 

package/docs/reference/interfaces/IEngineCoreEnvironmentVariables.md

@@ -44,6 +44,22 @@ A prefix for all the table in entity-storage, can be empty.
 
 ***
 
+### entityFileEnable
+
+> **entityFileEnable**: `string`
+
+Enable the file entity storage connector.
+
+***
+
+### entityMemoryEnable
+
+> **entityMemoryEnable**: `string`
+
+Enable the memory entity storage connector.
+
+***
+
 ### awsDynamodbAccessKeyId
 
 > **awsDynamodbAccessKeyId**: `string`
@@ -220,6 +236,22 @@ A prefix for all the blobs in blob-storage, can be empty.
 
 ***
 
+### blobFileEnable
+
+> **blobFileEnable**: `string`
+
+Enable the file blob storage connector.
+
+***
+
+### blobMemoryEnable
+
+> **blobMemoryEnable**: `string`
+
+Enable the memory blob storage connector.
+
+***
+
 ### awsS3AccessKeyId
 
 > **awsS3AccessKeyId**: `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-core",
-	"version": "0.0.1-next.6",
+	"version": "0.0.1-next.8",
 	"description": "Engine implementation for a core.",
 	"repository": {
 		"type": "git",
@@ -43,7 +43,7 @@
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
 		"@twin.org/data-schema-org": "next",
-		"@twin.org/engine-models": "0.0.1-next.6",
+		"@twin.org/engine-models": "0.0.1-next.8",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-connector-cosmosdb": "next",
 		"@twin.org/entity-storage-connector-dynamodb": "next",