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

package/dist/types/models/config/typeConfig/loggingConnectorConfig.d.ts

@@ -0,0 +1,25 @@
+import type { IConsoleLoggingConnectorConfig } from "@twin.org/logging-connector-console";
+import type { IEntityStorageLoggingConnectorConfig } from "@twin.org/logging-connector-entity-storage";
+import type { ILoggingLevelsConfig } from "@twin.org/logging-models";
+import type { LoggingConnectorType } from "../../types/loggingConnectorType";
+/**
+ * Logging config connector types.
+ */
+export type LoggingConnectorConfig = {
+    type: typeof LoggingConnectorType.EntityStorage;
+    options?: {
+        logEntryStorageConnectorType?: string;
+        config?: IEntityStorageLoggingConnectorConfig;
+    };
+} | {
+    type: typeof LoggingConnectorType.Console;
+    options?: {
+        config?: IConsoleLoggingConnectorConfig;
+    };
+} | {
+    type: typeof LoggingConnectorType.Multi;
+    options: {
+        loggingConnectorTypes: string[];
+        config?: ILoggingLevelsConfig;
+    };
+};

package/dist/types/models/config/typeConfig/mimeTypeProcessorConfig.d.ts

@@ -0,0 +1,8 @@
+import type { MimeTypeProcessorType } from "../../types/mimeTypeProcessorType";
+/**
+ * Mime type processor config types.
+ */
+export type MimeTypeProcessorConfig = {
+    type: typeof MimeTypeProcessorType.Jwt;
+    options?: never;
+};

package/dist/types/models/config/typeConfig/nftComponentConfig.d.ts

@@ -0,0 +1,11 @@
+import type { INftServiceConfig } from "@twin.org/nft-service";
+import type { NftComponentType } from "../../types/nftComponentType";
+/**
+ * NFT component config types.
+ */
+export type NftComponentConfig = {
+    type: typeof NftComponentType.Service;
+    options?: {
+        config?: INftServiceConfig;
+    };
+};

package/dist/types/models/config/typeConfig/nftConnectorConfig.d.ts

@@ -0,0 +1,17 @@
+import type { IIotaNftConnectorConfig } from "@twin.org/nft-connector-iota";
+import type { NftConnectorType } from "../../types/nftConnectorType";
+/**
+ * NFT connector config types.
+ */
+export type NftConnectorConfig = {
+    type: typeof NftConnectorType.EntityStorage;
+    options?: {
+        nftEntityStorageType?: string;
+    };
+} | {
+    type: typeof NftConnectorType.Iota;
+    options: {
+        vaultConnectorType?: string;
+        config: IIotaNftConnectorConfig;
+    };
+};

package/dist/types/models/config/typeConfig/restRouteProcessorConfig.d.ts

@@ -0,0 +1,32 @@
+import type { IAuthHeaderProcessorConfig } from "@twin.org/api-auth-entity-storage-service";
+import type { ILoggingProcessorConfig, IRouteProcessorConfig, IStaticUserIdentityProcessorConfig } from "@twin.org/api-processors";
+import type { RestRouteProcessorType } from "../../types/restRouteProcessorType";
+/**
+ * REST route processor config types.
+ */
+export type RestRouteProcessorConfig = {
+    type: typeof RestRouteProcessorType.AuthHeader;
+    options?: {
+        vaultConnectorType?: string;
+        config?: IAuthHeaderProcessorConfig;
+    };
+} | {
+    type: typeof RestRouteProcessorType.Logging;
+    options?: {
+        loggingConnectorType?: string;
+        config?: ILoggingProcessorConfig;
+    };
+} | {
+    type: typeof RestRouteProcessorType.NodeIdentity;
+    options?: never;
+} | {
+    type: typeof RestRouteProcessorType.StaticUserIdentity;
+    options: {
+        config: IStaticUserIdentityProcessorConfig;
+    };
+} | {
+    type: typeof RestRouteProcessorType.RestRoute;
+    options?: {
+        config?: IRouteProcessorConfig;
+    };
+};

package/dist/types/models/config/typeConfig/socketRouteProcessorConfig.d.ts

@@ -0,0 +1,32 @@
+import type { IAuthHeaderProcessorConfig } from "@twin.org/api-auth-entity-storage-service";
+import type { ILoggingProcessorConfig, IRouteProcessorConfig, IStaticUserIdentityProcessorConfig } from "@twin.org/api-processors";
+import type { SocketRouteProcessorType } from "../../types/socketRouteProcessorType";
+/**
+ * Socket route processor config types.
+ */
+export type SocketRouteProcessorConfig = {
+    type: typeof SocketRouteProcessorType.AuthHeader;
+    options?: {
+        vaultConnectorType?: string;
+        config?: IAuthHeaderProcessorConfig;
+    };
+} | {
+    type: typeof SocketRouteProcessorType.Logging;
+    options: {
+        loggingConnectorType: string;
+        config: ILoggingProcessorConfig;
+    };
+} | {
+    type: typeof SocketRouteProcessorType.NodeIdentity;
+    options?: never;
+} | {
+    type: typeof SocketRouteProcessorType.StaticUserIdentity;
+    options: {
+        config: IStaticUserIdentityProcessorConfig;
+    };
+} | {
+    type: typeof SocketRouteProcessorType.SocketRoute;
+    options?: {
+        config?: IRouteProcessorConfig;
+    };
+};

package/dist/types/models/config/typeConfig/telemetryComponentConfig.d.ts

@@ -0,0 +1,10 @@
+import type { TelemetryComponentType } from "../../types/telemetryComponentType";
+/**
+ * Telemetry component config types.
+ */
+export type TelemetryComponentConfig = {
+    type: typeof TelemetryComponentType.Service;
+    options?: {
+        telemetryConnectorType?: string;
+    };
+};

package/dist/types/models/config/typeConfig/telemetryConnectorConfig.d.ts

@@ -0,0 +1,12 @@
+import type { TelemetryConnectorType } from "../../types/telemetryConnectorType";
+/**
+ * Telemetry connector config types.
+ */
+export type TelemetryConnectorConfig = {
+    type: typeof TelemetryConnectorType.EntityStorage;
+    options?: {
+        telemetryMetricStorageConnectorType?: string;
+        telemetryMetricValueStorageConnectorType?: string;
+        loggingConnectorType?: string;
+    };
+};

package/dist/types/models/config/typeConfig/vaultConnectorConfig.d.ts

@@ -0,0 +1,17 @@
+import type { IHashicorpVaultConnectorConfig } from "@twin.org/vault-connector-hashicorp";
+import type { VaultConnectorType } from "../../types/vaultConnectorType";
+/**
+ * Vault connector config types.
+ */
+export type VaultConnectorConfig = {
+    type: typeof VaultConnectorType.EntityStorage;
+    options?: {
+        vaultKeyEntityStorageType?: string;
+        vaultSecretEntityStorageType?: string;
+    };
+} | {
+    type: typeof VaultConnectorType.Hashicorp;
+    options: {
+        config: IHashicorpVaultConnectorConfig;
+    };
+};

package/dist/types/models/config/typeConfig/walletConnectorConfig.d.ts

@@ -0,0 +1,22 @@
+import type { IEntityStorageWalletConnectorConfig } from "@twin.org/wallet-connector-entity-storage";
+import type { IIotaWalletConnectorConfig } from "@twin.org/wallet-connector-iota";
+import type { WalletConnectorType } from "../../types/walletConnectorType";
+/**
+ * Wallet connector config types.
+ */
+export type WalletConnectorConfig = {
+    type: typeof WalletConnectorType.EntityStorage;
+    options?: {
+        vaultConnectorType?: string;
+        faucetConnectorType?: string;
+        walletAddressEntityStorageType?: string;
+        config?: IEntityStorageWalletConnectorConfig;
+    };
+} | {
+    type: typeof WalletConnectorType.Iota;
+    options: {
+        vaultConnectorType?: string;
+        faucetConnectorType?: string;
+        config: IIotaWalletConnectorConfig;
+    };
+};

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

@@ -0,0 +1,7 @@
+import type { IEngineCoreTypeBaseConfig } from "./config/IEngineCoreTypeBaseConfig";
+import type { IEngineCore } from "./IEngineCore";
+import type { IEngineCoreContext } from "./IEngineCoreContext";
+/**
+ * Method definition for the engine type initialiser.
+ */
+export type EngineTypeInitialiser<T extends IEngineCoreTypeBaseConfig = IEngineCoreTypeBaseConfig> = (engineCore: IEngineCore, context: IEngineCoreContext, instanceConfig: T, overrideInstanceType?: string) => string | undefined;

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

@@ -0,0 +1,5 @@
+import type { IRestRoute } from "@twin.org/api-models";
+/**
+ * Method definition for the REST route creation.
+ */
+export type RestRouteGenerator = (baseRouteName: string, componentName: string) => IRestRoute[];

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

@@ -0,0 +1,5 @@
+import type { ISocketRoute } from "@twin.org/api-models";
+/**
+ * Method definition for the socket route creation.
+ */
+export type SocketRouteGenerator = (baseRouteName: string, componentName: string) => ISocketRoute[];

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

@@ -0,0 +1,13 @@
+/**
+ * Attestation component types.
+ */
+export declare const AttestationComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Attestation component types.
+ */
+export type AttestationComponentType = (typeof AttestationComponentType)[keyof typeof AttestationComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * Attestation connector types.
+ */
+export declare const AttestationConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * Attestation connector types.
+ */
+export type AttestationConnectorType = (typeof AttestationConnectorType)[keyof typeof AttestationConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Auditable item graph component types.
+ */
+export declare const AuditableItemGraphComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Auditable item graph component types.
+ */
+export type AuditableItemGraphComponentType = (typeof AuditableItemGraphComponentType)[keyof typeof AuditableItemGraphComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Auditable item stream component types.
+ */
+export declare const AuditableItemStreamComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Auditable item stream component types.
+ */
+export type AuditableItemStreamComponentType = (typeof AuditableItemStreamComponentType)[keyof typeof AuditableItemStreamComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Authentication component types.
+ */
+export declare const AuthenticationComponentType: {
+    /**
+     * Authentication entity storage.
+     */
+    readonly AuthEntityStorage: "auth-entity-storage";
+};
+/**
+ * Authentication component types.
+ */
+export type AuthenticationComponentType = (typeof AuthenticationComponentType)[keyof typeof AuthenticationComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Background task connector types.
+ */
+export declare const BackgroundTaskConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+};
+/**
+ * Background task connector types.
+ */
+export type BackgroundTaskConnectorType = (typeof BackgroundTaskConnectorType)[keyof typeof BackgroundTaskConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Blob storage component types.
+ */
+export declare const BlobStorageComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Blob storage component types.
+ */
+export type BlobStorageComponentType = (typeof BlobStorageComponentType)[keyof typeof BlobStorageComponentType];

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

@@ -0,0 +1,33 @@
+/**
+ * Blob storage connector types.
+ */
+export declare const BlobStorageConnectorType: {
+    /**
+     * File storage.
+     */
+    readonly File: "file";
+    /**
+     * Memory.
+     */
+    readonly Memory: "memory";
+    /**
+     * IPFS.
+     */
+    readonly Ipfs: "ipfs";
+    /**
+     * AWS S3.
+     */
+    readonly AwsS3: "aws-s3";
+    /**
+     * Azure Storage.
+     */
+    readonly AzureStorage: "azure-storage";
+    /**
+     * GCP Storage.
+     */
+    readonly GcpStorage: "gcp-storage";
+};
+/**
+ * Blob storage connector types.
+ */
+export type BlobStorageConnectorType = (typeof BlobStorageConnectorType)[keyof typeof BlobStorageConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * DLT config types.
+ */
+export declare const DltConfigType: {
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * DLT config types.
+ */
+export type DltConfigType = (typeof DltConfigType)[keyof typeof DltConfigType];

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

@@ -0,0 +1,13 @@
+/**
+ * Entity storage component types.
+ */
+export declare const EntityStorageComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Entity storage component types.
+ */
+export type EntityStorageComponentType = (typeof EntityStorageComponentType)[keyof typeof EntityStorageComponentType];

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

@@ -0,0 +1,33 @@
+/**
+ * Entity storage connector types.
+ */
+export declare const EntityStorageConnectorType: {
+    /**
+     * Use storage.
+     */
+    readonly File: "file";
+    /**
+     * Memory.
+     */
+    readonly Memory: "memory";
+    /**
+     * ScyllaDb.
+     */
+    readonly ScyllaDb: "scylladb";
+    /**
+     * AWS DynamoDB.
+     */
+    readonly AwsDynamoDb: "aws-dynamodb";
+    /**
+     * Azure CosmosDB.
+     */
+    readonly AzureCosmosDb: "azure-cosmosdb";
+    /**
+     * GCP Firestore.
+     */
+    readonly GcpFirestoreDb: "gcp-firestoredb";
+};
+/**
+ * Entity storage connector types.
+ */
+export type EntityStorageConnectorType = (typeof EntityStorageConnectorType)[keyof typeof EntityStorageConnectorType];

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

@@ -0,0 +1,17 @@
+/**
+ * Faucet connector types.
+ */
+export declare const FaucetConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * Faucet connector types.
+ */
+export type FaucetConnectorType = (typeof FaucetConnectorType)[keyof typeof FaucetConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Identity component types.
+ */
+export declare const IdentityComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Identity component types.
+ */
+export type IdentityComponentType = (typeof IdentityComponentType)[keyof typeof IdentityComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * Identity connector types.
+ */
+export declare const IdentityConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * Identity connector types.
+ */
+export type IdentityConnectorType = (typeof IdentityConnectorType)[keyof typeof IdentityConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Identity profile component types.
+ */
+export declare const IdentityProfileComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Identity profile component types.
+ */
+export type IdentityProfileComponentType = (typeof IdentityProfileComponentType)[keyof typeof IdentityProfileComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Identity profile connector types.
+ */
+export declare const IdentityProfileConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+};
+/**
+ * Identity profile connector types.
+ */
+export type IdentityProfileConnectorType = (typeof IdentityProfileConnectorType)[keyof typeof IdentityProfileConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Immutable proof component types.
+ */
+export declare const ImmutableProofComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Immutable proof component types.
+ */
+export type IImmutableProofComponentType = (typeof ImmutableProofComponentType)[keyof typeof ImmutableProofComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * Immutable storage connector types.
+ */
+export declare const ImmutableStorageConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * Immutable storage connector types.
+ */
+export type ImmutableStorageConnectorType = (typeof ImmutableStorageConnectorType)[keyof typeof ImmutableStorageConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Information component types.
+ */
+export declare const InformationComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Information component types.
+ */
+export type InformationComponentType = (typeof InformationComponentType)[keyof typeof InformationComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Logging component types.
+ */
+export declare const LoggingComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * Logging component types.
+ */
+export type LoggingComponentType = (typeof LoggingComponentType)[keyof typeof LoggingComponentType];

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

@@ -0,0 +1,21 @@
+/**
+ * Logging connector types.
+ */
+export declare const LoggingConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * Console.
+     */
+    readonly Console: "console";
+    /**
+     * Multi combines other loggers.
+     */
+    readonly Multi: "multi";
+};
+/**
+ * Logging connector types.
+ */
+export type LoggingConnectorType = (typeof LoggingConnectorType)[keyof typeof LoggingConnectorType];

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

@@ -0,0 +1,13 @@
+/**
+ * Mime type route processor types.
+ */
+export declare const MimeTypeProcessorType: {
+    /**
+     * Jwt.
+     */
+    readonly Jwt: "jwt";
+};
+/**
+ * Mime type processor types.
+ */
+export type MimeTypeProcessorType = (typeof MimeTypeProcessorType)[keyof typeof MimeTypeProcessorType];

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

@@ -0,0 +1,13 @@
+/**
+ * NFT component types.
+ */
+export declare const NftComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+};
+/**
+ * NFT component types.
+ */
+export type NftComponentType = (typeof NftComponentType)[keyof typeof NftComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * NFT connector types.
+ */
+export declare const NftConnectorType: {
+    /**
+     * Entity storage.
+     */
+    readonly EntityStorage: "entity-storage";
+    /**
+     * IOTA.
+     */
+    readonly Iota: "iota";
+};
+/**
+ * NFT connector types.
+ */
+export type NftConnectorType = (typeof NftConnectorType)[keyof typeof NftConnectorType];