@twin.org/engine-models 0.0.1-next.1

package/dist/esm/index.mjs

@@ -0,0 +1,517 @@
+import { Factory } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating engine cores.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const EngineCoreFactory = Factory.createFactory("engine-core");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating engine servers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const EngineServerFactory = Factory.createFactory("engine-server");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Attestation component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AttestationComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Attestation connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AttestationConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Auditable item graph component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuditableItemGraphComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Auditable item stream component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuditableItemStreamComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Authentication component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const AuthenticationComponentType = {
+    /**
+     * Authentication entity storage.
+     */
+    AuthEntityStorage: "auth-entity-storage"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Background task connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BackgroundTaskConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Blob storage component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Blob storage connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageConnectorType = {
+    /**
+     * File storage.
+     */
+    File: "file",
+    /**
+     * Memory.
+     */
+    Memory: "memory",
+    /**
+     * IPFS.
+     */
+    Ipfs: "ipfs",
+    /**
+     * AWS S3.
+     */
+    AwsS3: "aws-s3",
+    /**
+     * Azure Storage.
+     */
+    AzureStorage: "azure-storage",
+    /**
+     * GCP Storage.
+     */
+    GcpStorage: "gcp-storage"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * DLT config types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DltConfigType = {
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Entity storage component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const EntityStorageComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Entity storage connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const EntityStorageConnectorType = {
+    /**
+     * Use storage.
+     */
+    File: "file",
+    /**
+     * Memory.
+     */
+    Memory: "memory",
+    /**
+     * ScyllaDb.
+     */
+    ScyllaDb: "scylladb",
+    /**
+     * AWS DynamoDB.
+     */
+    AwsDynamoDb: "aws-dynamodb",
+    /**
+     * Azure CosmosDB.
+     */
+    AzureCosmosDb: "azure-cosmosdb",
+    /**
+     * GCP Firestore.
+     */
+    GcpFirestoreDb: "gcp-firestoredb"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Faucet connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const FaucetConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Identity component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Identity connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Identity profile component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityProfileComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Identity profile connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentityProfileConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Immutable proof component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableProofComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Immutable storage connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const ImmutableStorageConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Information component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const InformationComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Logging component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const LoggingComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Logging connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const LoggingConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * Console.
+     */
+    Console: "console",
+    /**
+     * Multi combines other loggers.
+     */
+    Multi: "multi"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Mime type route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const MimeTypeProcessorType = {
+    /**
+     * Jwt.
+     */
+    Jwt: "jwt"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * NFT component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const NftComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * NFT connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const NftConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * REST route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const RestRouteProcessorType = {
+    /**
+     * Auth header.
+     */
+    AuthHeader: "auth-header",
+    /**
+     * Logging.
+     */
+    Logging: "logging",
+    /**
+     * Node Identity.
+     */
+    NodeIdentity: "node-identity",
+    /**
+     * Static User Identity.
+     */
+    StaticUserIdentity: "static-user-identity",
+    /**
+     * REST Route.
+     */
+    RestRoute: "rest-route"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Socket route processor types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SocketRouteProcessorType = {
+    /**
+     * Auth header.
+     */
+    AuthHeader: "auth-header",
+    /**
+     * Logging.
+     */
+    Logging: "logging",
+    /**
+     * Node Identity.
+     */
+    NodeIdentity: "node-identity",
+    /**
+     * Static User Identity.
+     */
+    StaticUserIdentity: "static-user-identity",
+    /**
+     * Socket Route.
+     */
+    SocketRoute: "socket-route"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Telemetry component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const TelemetryComponentType = {
+    /**
+     * Service.
+     */
+    Service: "service"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Telemetry connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const TelemetryConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Vault connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const VaultConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * Hashicorp.
+     */
+    Hashicorp: "hashicorp"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Wallet connector types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const WalletConnectorType = {
+    /**
+     * Entity storage.
+     */
+    EntityStorage: "entity-storage",
+    /**
+     * IOTA.
+     */
+    Iota: "iota"
+};
+
+export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, AuthenticationComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DltConfigType, EngineCoreFactory, EngineServerFactory, EntityStorageComponentType, EntityStorageConnectorType, FaucetConnectorType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, ImmutableProofComponentType, ImmutableStorageConnectorType, InformationComponentType, LoggingComponentType, LoggingConnectorType, MimeTypeProcessorType, NftComponentType, NftConnectorType, RestRouteProcessorType, SocketRouteProcessorType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, WalletConnectorType };

package/dist/types/factories/engineCoreFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IEngineCore } from "../models/IEngineCore";
+/**
+ * Factory for creating engine cores.
+ */
+export declare const EngineCoreFactory: Factory<IEngineCore>;

package/dist/types/factories/engineServerFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IEngineServer } from "../models/IEngineServer";
+/**
+ * Factory for creating engine servers.
+ */
+export declare const EngineServerFactory: Factory<IEngineServer>;

package/dist/types/index.d.ts

@@ -0,0 +1,74 @@
+export * from "./factories/engineCoreFactory";
+export * from "./factories/engineServerFactory";
+export * from "./models/config/IEngineCoreConfig";
+export * from "./models/config/IEngineCoreTypeBaseConfig";
+export * from "./models/config/IEngineCoreTypeConfig";
+export * from "./models/config/IEngineServerConfig";
+export * from "./models/config/typeConfig/attestationComponentConfig";
+export * from "./models/config/typeConfig/attestationConnectorConfig";
+export * from "./models/config/typeConfig/auditableItemGraphComponentConfig";
+export * from "./models/config/typeConfig/auditableItemStreamComponentConfig";
+export * from "./models/config/typeConfig/authenticationComponentConfig";
+export * from "./models/config/typeConfig/backgroundTaskConnectorConfig";
+export * from "./models/config/typeConfig/blobStorageComponentConfig";
+export * from "./models/config/typeConfig/blobStorageConnectorConfig";
+export * from "./models/config/typeConfig/dltConfig";
+export * from "./models/config/typeConfig/entityStorageComponentConfig";
+export * from "./models/config/typeConfig/entityStorageConnectorConfig";
+export * from "./models/config/typeConfig/faucetConnectorConfig";
+export * from "./models/config/typeConfig/identityComponentConfig";
+export * from "./models/config/typeConfig/identityConnectorConfig";
+export * from "./models/config/typeConfig/identityProfileComponentConfig";
+export * from "./models/config/typeConfig/identityProfileConnectorConfig";
+export * from "./models/config/typeConfig/immutableProofComponentConfig";
+export * from "./models/config/typeConfig/immutableStorageConnectorConfig";
+export * from "./models/config/typeConfig/informationComponentConfig";
+export * from "./models/config/typeConfig/loggingComponentConfig";
+export * from "./models/config/typeConfig/loggingConnectorConfig";
+export * from "./models/config/typeConfig/mimeTypeProcessorConfig";
+export * from "./models/config/typeConfig/nftComponentConfig";
+export * from "./models/config/typeConfig/nftConnectorConfig";
+export * from "./models/config/typeConfig/restRouteProcessorConfig";
+export * from "./models/config/typeConfig/socketRouteProcessorConfig";
+export * from "./models/config/typeConfig/telemetryComponentConfig";
+export * from "./models/config/typeConfig/telemetryConnectorConfig";
+export * from "./models/config/typeConfig/vaultConnectorConfig";
+export * from "./models/config/typeConfig/walletConnectorConfig";
+export * from "./models/engineTypeInitialiser";
+export * from "./models/IEngineCore";
+export * from "./models/IEngineCoreContext";
+export * from "./models/IEngineServer";
+export * from "./models/IEngineState";
+export * from "./models/IEngineStateStorage";
+export * from "./models/restRouteGenerator";
+export * from "./models/socketRouteGenerator";
+export * from "./models/types/attestationComponentType";
+export * from "./models/types/attestationConnectorType";
+export * from "./models/types/auditableItemGraphComponentType";
+export * from "./models/types/auditableItemStreamComponentType";
+export * from "./models/types/authenticationComponentType";
+export * from "./models/types/backgroundTaskConnectorType";
+export * from "./models/types/blobStorageComponentType";
+export * from "./models/types/blobStorageConnectorType";
+export * from "./models/types/dltConfigType";
+export * from "./models/types/entityStorageComponentType";
+export * from "./models/types/entityStorageConnectorType";
+export * from "./models/types/faucetConnectorType";
+export * from "./models/types/identityComponentType";
+export * from "./models/types/identityConnectorType";
+export * from "./models/types/identityProfileComponentType";
+export * from "./models/types/identityProfileConnectorType";
+export * from "./models/types/immutableProofComponentType";
+export * from "./models/types/immutableStorageConnectorType";
+export * from "./models/types/informationComponentType";
+export * from "./models/types/loggingComponentType";
+export * from "./models/types/loggingConnectorType";
+export * from "./models/types/mimeTypeProcessorType";
+export * from "./models/types/nftComponentType";
+export * from "./models/types/nftConnectorType";
+export * from "./models/types/restRouteProcessorType";
+export * from "./models/types/socketRouteProcessorType";
+export * from "./models/types/telemetryComponentType";
+export * from "./models/types/telemetryConnectorType";
+export * from "./models/types/vaultConnectorType";
+export * from "./models/types/walletConnectorType";

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

@@ -0,0 +1,55 @@
+import type { IError } from "@twin.org/core";
+import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
+import type { IEngineCoreTypeBaseConfig } from "./config/IEngineCoreTypeBaseConfig";
+import type { IEngineCoreTypeConfig } from "./config/IEngineCoreTypeConfig";
+import type { EngineTypeInitialiser } from "./engineTypeInitialiser";
+import type { IEngineState } from "./IEngineState";
+/**
+ * Interface describing the engine core methods.
+ */
+export interface IEngineCore {
+    /**
+     * Add a type initialiser.
+     * @param type The type to add the initialiser for.
+     * @param typeConfig The type config.
+     * @param initialiser The initialiser to add.
+     */
+    addTypeInitialiser<T extends IEngineCoreTypeBaseConfig>(type: string, typeConfig: IEngineCoreTypeConfig[] | undefined, initialiser: EngineTypeInitialiser<T>): void;
+    /**
+     * Start the engine core.
+     * @returns Nothing.
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the engine core.
+     * @returns Nothing.
+     */
+    stop(): Promise<void>;
+    /**
+     * Log info.
+     * @param message The message to log.
+     */
+    logInfo(message: string): void;
+    /**
+     * Log error.
+     * @param error The error to log.
+     */
+    logError(error: IError): void;
+    /**
+     * Get the config for the engine.
+     * @returns The config for the engine.
+     */
+    getConfig(): IEngineCoreConfig;
+    /**
+     * Get the state of the engine.
+     * @returns The state of the engine.
+     */
+    getState(): IEngineState;
+    /**
+     * Get the types for the component.
+     * @returns The default types.
+     */
+    getDefaultTypes(): {
+        [type: string]: string;
+    };
+}

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

@@ -0,0 +1,33 @@
+import type { IComponent } from "@twin.org/core";
+import type { IEngineCoreConfig } from "./config/IEngineCoreConfig";
+import type { IEngineState } from "./IEngineState";
+/**
+ * The context for the engine core.
+ */
+export interface IEngineCoreContext {
+    /**
+     * The engine core config.
+     */
+    config: IEngineCoreConfig;
+    /**
+     * The engine core state.
+     */
+    state: IEngineState;
+    /**
+     * The state dirty flag, which flags that the state needs saving.
+     */
+    stateDirty: boolean;
+    /**
+     * The default types to use when components don't have custom types.
+     */
+    defaultTypes: {
+        [type: string]: string;
+    };
+    /**
+     * The components.
+     */
+    componentInstances: {
+        instanceType: string;
+        component: IComponent;
+    }[];
+}