@twin.org/engine 0.0.1-next.14

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

@@ -0,0 +1,265 @@
+/**
+ * The engine core environment variables.
+ */
+export interface IEngineEnvironmentVariables {
+    /**
+     * Start the engine in debug mode.
+     */
+    debug: string;
+    /**
+     * The root directory for storing items like state file.
+     */
+    storageFileRoot: string;
+    /**
+     * The name of the state file.
+     */
+    stateFilename: string;
+    /**
+     * The type of the default entity storage: file, memory, aws-dynamodb, azure-cosmosdb, gcp-firestoredb, scylladb.
+     */
+    entityStorageConnectorType: string;
+    /**
+     * 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.
+     */
+    awsDynamodbAccessKeyId: string;
+    /**
+     * AWS Dynamo DB Endpoint if running local instance.
+     */
+    awsDynamodbEndpoint: string;
+    /**
+     * AWS Dynamo DB region.
+     */
+    awsDynamodbRegion: string;
+    /**
+     * AWS Dynamo DB secret access key.
+     */
+    awsDynamodbSecretAccessKey: string;
+    /**
+     * Azure Cosmos DB key.
+     */
+    azureCosmosdbKey: string;
+    /**
+     * Azure Cosmos DB container id.
+     */
+    azureCosmosdbContainerId: string;
+    /**
+     * Azure Cosmos DB database id.
+     */
+    azureCosmosdbDatabaseId: string;
+    /**
+     * Azure Cosmos DB endpoint.
+     */
+    azureCosmosdbEndpoint: string;
+    /**
+     * GCP Firestore collection name.
+     */
+    gcpFirestoreCollectionName: string;
+    /**
+     * GCP Firestore credentials.
+     */
+    gcpFirestoreCredentials: string;
+    /**
+     * GCP Firestore database id.
+     */
+    gcpFirestoreDatabaseId: string;
+    /**
+     * GCP Firestore endpoint.
+     */
+    gcpFirestoreApiEndpoint: string;
+    /**
+     * GCP Firestore project id.
+     */
+    gcpFirestoreProjectId: string;
+    /**
+     * ScyllaDB hosts as comma separated string.
+     */
+    scylladbHosts: string;
+    /**
+     * ScyllaDB keyspace.
+     */
+    scylladbKeyspace: string;
+    /**
+     * ScyllaDB local data center.
+     */
+    scylladbLocalDataCenter: string;
+    /**
+     * The security token for accessing IPFS API.
+     */
+    ipfsBearerToken: string;
+    /**
+     * The url for accessing IPFS API.
+     */
+    ipfsApiUrl: string;
+    /**
+     * The type of the default blob storage: memory, file, ipfs, aws-s3, azure-storage, gcp-storage.
+     */
+    blobStorageConnectorType: string;
+    /**
+     * Enable encryption for the blob storage.
+     */
+    blobStorageEnableEncryption: string;
+    /**
+     * The encryption key for the blob storage.
+     */
+    blobStorageEncryptionKey: string;
+    /**
+     * 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.
+     */
+    awsS3AccessKeyId: string;
+    /**
+     * AWS S3 bucket name.
+     */
+    awsS3BucketName: string;
+    /**
+     * AWS S3 endpoint.
+     */
+    awsS3Endpoint: string;
+    /**
+     * AWS S3 region.
+     */
+    awsS3Region: string;
+    /**
+     * AWS S3 secret access key.
+     */
+    awsS3SecretAccessKey: string;
+    /**
+     * Azure Storage account key.
+     */
+    azureStorageAccountKey: string;
+    /**
+     * Azure Storage account name.
+     */
+    azureStorageAccountName: string;
+    /**
+     * Azure Storage container.
+     */
+    azureStorageContainerName: string;
+    /**
+     * Azure Storage endpoint.
+     */
+    azureStorageEndpoint: string;
+    /**
+     * GCP Storage bucket.
+     */
+    gcpStorageBucketName: string;
+    /**
+     * GCP Storage credentials.
+     */
+    gcpStorageCredentials: string;
+    /**
+     * GCP Storage endpoint.
+     */
+    gcpStorageEndpoint: string;
+    /**
+     * GCP Storage project id.
+     */
+    gcpStorageProjectId: string;
+    /**
+     * The type of the default vault connector: entity-storage, hashicorp.
+     */
+    vaultConnector: string;
+    /**
+     * Hashicorp Vault token.
+     */
+    hashicorpVaultToken: string;
+    /**
+     * Hashicorp Vault endpoint.
+     */
+    hashicorpVaultEndpoint: string;
+    /**
+     * The type of background 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 telemetry connector: entity-storage.
+     */
+    telemetryConnector: string;
+    /**
+     * The type of faucet connector: entity-storage, iota.
+     */
+    faucetConnector: string;
+    /**
+     * The type of wallet connector: entity-storage, iota.
+     */
+    walletConnector: string;
+    /**
+     * The type of NFT connector: entity-storage, iota.
+     */
+    nftConnector: string;
+    /**
+     * The type of identity connector: entity-storage, iota.
+     */
+    identityConnector: string;
+    /**
+     * The type of immutable storage connector: entity-storage, iota.
+     */
+    immutableStorageConnector: string;
+    /**
+     * IOTA Faucet Endpoint.
+     */
+    iotaFaucetEndpoint: string;
+    /**
+     * IOTA Node Endpoint.
+     */
+    iotaNodeEndpoint: string;
+    /**
+     * IOTA Bech32 HRP
+     */
+    iotaBech32Hrp: string;
+    /**
+     * IOTA coin type.
+     */
+    iotaCoinType: string;
+    /**
+     * IOTA Explorer Endpoint.
+     */
+    iotaExplorerEndpoint: string;
+    /**
+     * The type of identity profile connector: entity-storage.
+     */
+    identityProfileConnector: string;
+    /**
+     * The identity assertion method id to use with immutable proofs.
+     */
+    immutableProofAssertionMethodId: string;
+    /**
+     * The hash key from the vault to use with immutable proofs.
+     */
+    immutableProofHashKeyId: string;
+    /**
+     * The type of attestation connector: entity-storage, iota.
+     */
+    attestationConnector: string;
+    /**
+     * The identity assertion method id to use with attestation.
+     */
+    attestationAssertionMethodId: string;
+}

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

@@ -0,0 +1,8 @@
+import { type IEngineCoreTypesConfig } from "@twin.org/engine-types";
+import type { IEngineEnvironmentVariables } from "../models/IEngineEnvironmentVariables";
+/**
+ * Build the engine core configuration from environment variables.
+ * @param envVars The environment variables.
+ * @returns The config for the core.
+ */
+export declare function buildEngineConfiguration(envVars: IEngineEnvironmentVariables): IEngineCoreTypesConfig;

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

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

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/engine - Changelog
+
+## v0.0.1-next.14
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/engine - Examples

package/docs/reference/classes/Engine.md

@@ -0,0 +1,47 @@
+# Class: Engine\<C, S\>
+
+The engine with built in types.
+
+## Extends
+
+- `EngineCore`\<`C`, `S`\>
+
+## Type Parameters
+
+• **C** *extends* `IEngineCoreTypesConfig` = `IEngineCoreTypesConfig`
+
+• **S** *extends* `IEngineState` = `IEngineState`
+
+## Constructors
+
+### new Engine()
+
+> **new Engine**\<`C`, `S`\>(`options`?): [`Engine`](Engine.md)\<`C`, `S`\>
+
+Create a new instance of Engine.
+
+#### Parameters
+
+• **options?**: `IEngineCoreOptions`\<`C`, `S`\>
+
+The options for the engine.
+
+#### Returns
+
+[`Engine`](Engine.md)\<`C`, `S`\>
+
+#### Overrides
+
+`EngineCore<C, S>.constructor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Overrides
+
+`EngineCore.CLASS_NAME`

package/docs/reference/classes/EnvHelper.md

@@ -0,0 +1,41 @@
+# Class: EnvHelper
+
+Environment variable helper.
+
+## Constructors
+
+### new EnvHelper()
+
+> **new EnvHelper**(): [`EnvHelper`](EnvHelper.md)
+
+#### Returns
+
+[`EnvHelper`](EnvHelper.md)
+
+## Methods
+
+### envToJson()
+
+> `static` **envToJson**\<`T`\>(`envVars`, `prefix`): `T`
+
+Get the environment variable as an object with camel cased names.
+
+#### Type Parameters
+
+• **T** = [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+#### Parameters
+
+• **envVars**
+
+The environment variables.
+
+• **prefix**: `string`
+
+The prefix of the environment variables.
+
+#### Returns
+
+`T`
+
+The object with camel cased names.

package/docs/reference/functions/buildEngineConfiguration.md

@@ -0,0 +1,17 @@
+# Function: buildEngineConfiguration()
+
+> **buildEngineConfiguration**(`envVars`): `IEngineCoreTypesConfig`
+
+Build the engine core configuration from environment variables.
+
+## Parameters
+
+• **envVars**: [`IEngineEnvironmentVariables`](../interfaces/IEngineEnvironmentVariables.md)
+
+The environment variables.
+
+## Returns
+
+`IEngineCoreTypesConfig`
+
+The config for the core.

package/docs/reference/index.md

@@ -0,0 +1,14 @@
+# @twin.org/engine
+
+## Classes
+
+- [Engine](classes/Engine.md)
+- [EnvHelper](classes/EnvHelper.md)
+
+## Interfaces
+
+- [IEngineEnvironmentVariables](interfaces/IEngineEnvironmentVariables.md)
+
+## Functions
+
+- [buildEngineConfiguration](functions/buildEngineConfiguration.md)