@twin.org/engine-types 0.0.3-next.46 → 0.0.3-next.47

package/dist/es/models/types/verifiableStorageConnectorType.js

@@ -1,17 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Verifiable storage connector types.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const VerifiableStorageConnectorType = {
-    /**
-     * Entity storage.
-     */
-    EntityStorage: "entity-storage",
-    /**
-     * IOTA.
-     */
-    Iota: "iota"
-};
-//# sourceMappingURL=verifiableStorageConnectorType.js.map

package/dist/es/models/types/verifiableStorageConnectorType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"verifiableStorageConnectorType.js","sourceRoot":"","sources":["../../../../src/models/types/verifiableStorageConnectorType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC7C;;OAEG;IACH,aAAa,EAAE,gBAAgB;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM;CACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Verifiable storage connector types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VerifiableStorageConnectorType = {\n\t/**\n\t * Entity storage.\n\t */\n\tEntityStorage: \"entity-storage\",\n\n\t/**\n\t * IOTA.\n\t */\n\tIota: \"iota\"\n} as const;\n\n/**\n * Verifiable storage connector types.\n */\nexport type VerifiableStorageConnectorType =\n\t(typeof VerifiableStorageConnectorType)[keyof typeof VerifiableStorageConnectorType];\n"]}

package/dist/types/components/synchronisedStorage.d.ts

@@ -1,12 +0,0 @@
-import { ComponentFactory } from "@twin.org/core";
-import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import type { SynchronisedStorageComponentConfig } from "../models/config/synchronisedStorageComponentConfig.js";
-import type { IEngineConfig } from "../models/IEngineConfig.js";
-/**
- * Initialise the synchronised storage component.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @returns The instance created and the factory for it.
- */
-export declare function initialiseSynchronisedStorageComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: SynchronisedStorageComponentConfig): EngineTypeInitialiserReturn<typeof instanceConfig, typeof ComponentFactory>;

package/dist/types/components/verifiableStorage.d.ts

@@ -1,22 +0,0 @@
-import { ComponentFactory } from "@twin.org/core";
-import type { EngineTypeInitialiserReturn, IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import { VerifiableStorageConnectorFactory } from "@twin.org/verifiable-storage-models";
-import type { VerifiableStorageComponentConfig } from "../models/config/verifiableStorageComponentConfig.js";
-import type { VerifiableStorageConnectorConfig } from "../models/config/verifiableStorageConnectorConfig.js";
-import type { IEngineConfig } from "../models/IEngineConfig.js";
-/**
- * Initialise the verifiable storage connector.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @returns The instance created and the factory for it.
- */
-export declare function initialiseVerifiableStorageConnector(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: VerifiableStorageConnectorConfig): EngineTypeInitialiserReturn<typeof instanceConfig, typeof VerifiableStorageConnectorFactory>;
-/**
- * Initialise the verifiable storage component.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @returns The instance created and the factory for it.
- */
-export declare function initialiseVerifiableStorageComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: VerifiableStorageComponentConfig): EngineTypeInitialiserReturn<typeof instanceConfig, typeof ComponentFactory>;

package/dist/types/models/config/synchronisedStorageComponentConfig.d.ts

@@ -1,13 +0,0 @@
-import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { ISynchronisedStorageServiceConstructorOptions } from "@twin.org/synchronised-storage-service";
-import type { SynchronisedStorageComponentType } from "../types/synchronisedStorageComponentType.js";
-/**
- * Synchronised storage component config types.
- */
-export type SynchronisedStorageComponentConfig = {
-    type: typeof SynchronisedStorageComponentType.Service;
-    options: ISynchronisedStorageServiceConstructorOptions;
-} | {
-    type: typeof SynchronisedStorageComponentType.RestClient;
-    options: IBaseRestClientConfig;
-};

package/dist/types/models/config/verifiableStorageComponentConfig.d.ts

@@ -1,13 +0,0 @@
-import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { IVerifiableStorageServiceConstructorOptions } from "@twin.org/verifiable-storage-service";
-import type { VerifiableStorageComponentType } from "../types/verifiableStorageComponentType.js";
-/**
- * Verifiable storage component config types.
- */
-export type VerifiableStorageComponentConfig = {
-    type: typeof VerifiableStorageComponentType.Service;
-    options?: IVerifiableStorageServiceConstructorOptions;
-} | {
-    type: typeof VerifiableStorageComponentType.RestClient;
-    options: IBaseRestClientConfig;
-};

package/dist/types/models/config/verifiableStorageConnectorConfig.d.ts

@@ -1,13 +0,0 @@
-import type { IEntityStorageVerifiableStorageConnectorConstructorOptions } from "@twin.org/verifiable-storage-connector-entity-storage";
-import type { IIotaVerifiableStorageConnectorConstructorOptions } from "@twin.org/verifiable-storage-connector-iota";
-import type { VerifiableStorageConnectorType } from "../types/verifiableStorageConnectorType.js";
-/**
- * Verifiable storage connector config types.
- */
-export type VerifiableStorageConnectorConfig = {
-    type: typeof VerifiableStorageConnectorType.EntityStorage;
-    options?: IEntityStorageVerifiableStorageConnectorConstructorOptions;
-} | {
-    type: typeof VerifiableStorageConnectorType.Iota;
-    options: IIotaVerifiableStorageConnectorConstructorOptions;
-};

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

@@ -1,17 +0,0 @@
-/**
- * Synchronised storage component types.
- */
-export declare const SynchronisedStorageComponentType: {
-    /**
-     * Service.
-     */
-    readonly Service: "service";
-    /**
-     * REST client.
-     */
-    readonly RestClient: "rest-client";
-};
-/**
- * Synchronised storage component types.
- */
-export type SynchronisedStorageComponentType = (typeof SynchronisedStorageComponentType)[keyof typeof SynchronisedStorageComponentType];

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

@@ -1,17 +0,0 @@
-/**
- * Verifiable storage component types.
- */
-export declare const VerifiableStorageComponentType: {
-    /**
-     * Service.
-     */
-    readonly Service: "service";
-    /**
-     * REST client.
-     */
-    readonly RestClient: "rest-client";
-};
-/**
- * Verifiable storage component types.
- */
-export type IVerifiableStorageComponentType = (typeof VerifiableStorageComponentType)[keyof typeof VerifiableStorageComponentType];

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

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

package/docs/reference/functions/initialiseSynchronisedStorageComponent.md

@@ -1,31 +0,0 @@
-# Function: initialiseSynchronisedStorageComponent()
-
-> **initialiseSynchronisedStorageComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-Initialise the synchronised storage component.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md)
-
-The instance config.
-
-## Returns
-
-`EngineTypeInitialiserReturn`\<[`SynchronisedStorageComponentConfig`](../type-aliases/SynchronisedStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-The instance created and the factory for it.

package/docs/reference/functions/initialiseVerifiableStorageComponent.md

@@ -1,31 +0,0 @@
-# Function: initialiseVerifiableStorageComponent()
-
-> **initialiseVerifiableStorageComponent**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`VerifiableStorageComponentConfig`](../type-aliases/VerifiableStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-Initialise the verifiable storage component.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`VerifiableStorageComponentConfig`](../type-aliases/VerifiableStorageComponentConfig.md)
-
-The instance config.
-
-## Returns
-
-`EngineTypeInitialiserReturn`\<[`VerifiableStorageComponentConfig`](../type-aliases/VerifiableStorageComponentConfig.md), `Factory`\<`IComponent`\>\>
-
-The instance created and the factory for it.

package/docs/reference/functions/initialiseVerifiableStorageConnector.md

@@ -1,31 +0,0 @@
-# Function: initialiseVerifiableStorageConnector()
-
-> **initialiseVerifiableStorageConnector**(`engineCore`, `context`, `instanceConfig`): `EngineTypeInitialiserReturn`\<[`VerifiableStorageConnectorConfig`](../type-aliases/VerifiableStorageConnectorConfig.md), `Factory`\<`IVerifiableStorageConnector`\>\>
-
-Initialise the verifiable storage connector.
-
-## Parameters
-
-### engineCore
-
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The engine core.
-
-### context
-
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-
-The context for the engine.
-
-### instanceConfig
-
-[`VerifiableStorageConnectorConfig`](../type-aliases/VerifiableStorageConnectorConfig.md)
-
-The instance config.
-
-## Returns
-
-`EngineTypeInitialiserReturn`\<[`VerifiableStorageConnectorConfig`](../type-aliases/VerifiableStorageConnectorConfig.md), `Factory`\<`IVerifiableStorageConnector`\>\>
-
-The instance created and the factory for it.

package/docs/reference/type-aliases/IVerifiableStorageComponentType.md

@@ -1,5 +0,0 @@
-# Type Alias: IVerifiableStorageComponentType
-
-> **IVerifiableStorageComponentType** = *typeof* [`VerifiableStorageComponentType`](../variables/VerifiableStorageComponentType.md)\[keyof *typeof* [`VerifiableStorageComponentType`](../variables/VerifiableStorageComponentType.md)\]
-
-Verifiable storage component types.

package/docs/reference/type-aliases/SynchronisedStorageComponentConfig.md

@@ -1,5 +0,0 @@
-# Type Alias: SynchronisedStorageComponentConfig
-
-> **SynchronisedStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/SynchronisedStorageComponentType.md#service); `options`: `ISynchronisedStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/SynchronisedStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
-
-Synchronised storage component config types.

package/docs/reference/type-aliases/SynchronisedStorageComponentType.md

@@ -1,5 +0,0 @@
-# Type Alias: SynchronisedStorageComponentType
-
-> **SynchronisedStorageComponentType** = *typeof* [`SynchronisedStorageComponentType`](../variables/SynchronisedStorageComponentType.md)\[keyof *typeof* [`SynchronisedStorageComponentType`](../variables/SynchronisedStorageComponentType.md)\]
-
-Synchronised storage component types.

package/docs/reference/type-aliases/VerifiableStorageComponentConfig.md

@@ -1,5 +0,0 @@
-# Type Alias: VerifiableStorageComponentConfig
-
-> **VerifiableStorageComponentConfig** = \{ `type`: *typeof* [`Service`](../variables/VerifiableStorageComponentType.md#service); `options?`: `IVerifiableStorageServiceConstructorOptions`; \} \| \{ `type`: *typeof* [`RestClient`](../variables/VerifiableStorageComponentType.md#restclient); `options`: `IBaseRestClientConfig`; \}
-
-Verifiable storage component config types.

package/docs/reference/type-aliases/VerifiableStorageConnectorConfig.md

@@ -1,5 +0,0 @@
-# Type Alias: VerifiableStorageConnectorConfig
-
-> **VerifiableStorageConnectorConfig** = \{ `type`: *typeof* [`EntityStorage`](../variables/VerifiableStorageConnectorType.md#entitystorage); `options?`: `IEntityStorageVerifiableStorageConnectorConstructorOptions`; \} \| \{ `type`: *typeof* [`Iota`](../variables/VerifiableStorageConnectorType.md#iota); `options`: `IIotaVerifiableStorageConnectorConstructorOptions`; \}
-
-Verifiable storage connector config types.

package/docs/reference/type-aliases/VerifiableStorageConnectorType.md

@@ -1,5 +0,0 @@
-# Type Alias: VerifiableStorageConnectorType
-
-> **VerifiableStorageConnectorType** = *typeof* [`VerifiableStorageConnectorType`](../variables/VerifiableStorageConnectorType.md)\[keyof *typeof* [`VerifiableStorageConnectorType`](../variables/VerifiableStorageConnectorType.md)\]
-
-Verifiable storage connector types.

package/docs/reference/variables/SynchronisedStorageComponentType.md

@@ -1,19 +0,0 @@
-# Variable: SynchronisedStorageComponentType
-
-> `const` **SynchronisedStorageComponentType**: `object`
-
-Synchronised storage component types.
-
-## Type Declaration
-
-### Service {#service}
-
-> `readonly` **Service**: `"service"` = `"service"`
-
-Service.
-
-### RestClient {#restclient}
-
-> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
-
-REST client.

package/docs/reference/variables/VerifiableStorageComponentType.md

@@ -1,19 +0,0 @@
-# Variable: VerifiableStorageComponentType
-
-> `const` **VerifiableStorageComponentType**: `object`
-
-Verifiable storage component types.
-
-## Type Declaration
-
-### Service {#service}
-
-> `readonly` **Service**: `"service"` = `"service"`
-
-Service.
-
-### RestClient {#restclient}
-
-> `readonly` **RestClient**: `"rest-client"` = `"rest-client"`
-
-REST client.

package/docs/reference/variables/VerifiableStorageConnectorType.md

@@ -1,19 +0,0 @@
-# Variable: VerifiableStorageConnectorType
-
-> `const` **VerifiableStorageConnectorType**: `object`
-
-Verifiable storage connector types.
-
-## Type Declaration
-
-### EntityStorage {#entitystorage}
-
-> `readonly` **EntityStorage**: `"entity-storage"` = `"entity-storage"`
-
-Entity storage.
-
-### Iota {#iota}
-
-> `readonly` **Iota**: `"iota"` = `"iota"`
-
-IOTA.