npm - @twin.org/engine-types - Versions diffs - 0.0.2-next.9 → 0.0.3-next.2 - Mend

@twin.org/engine-types 0.0.2-next.9 → 0.0.3-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (552) hide show

package/dist/types/components/rightsManagement.d.ts DELETED Viewed

@@ -1,13 +0,0 @@
-import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
-import type { RightsManagementComponentConfig } from "../models/config/rightsManagementComponentConfig";
-import type { IEngineConfig } from "../models/IEngineConfig";
-/**
- * Initialise the rights management component.
- * @param engineCore The engine core.
- * @param context The context for the engine.
- * @param instanceConfig The instance config.
- * @param overrideInstanceType The instance type to override the default.
- * @returns The name of the instance created.
- * @throws GeneralError if the component type is unknown.
- */
-export declare function initialiseRightsManagementComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: RightsManagementComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/models/config/rightsManagementComponentConfig.d.ts DELETED Viewed

@@ -1,13 +0,0 @@
-import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { IRightsManagementServiceConstructorOptions } from "@twin.org/rights-management-service";
-import type { RightsManagementComponentType } from "../types/rightsManagementComponentType";
-/**
- * Rights management component config types.
- */
-export type RightsManagementComponentConfig = {
-    type: typeof RightsManagementComponentType.Service;
-    options?: IRightsManagementServiceConstructorOptions;
-} | {
-    type: typeof RightsManagementComponentType.RestClient;
-    options: IBaseRestClientConfig;
-};

package/dist/types/models/types/rightsManagementComponentType.d.ts DELETED Viewed

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

package/docs/reference/functions/initialiseRightsManagementComponent.md DELETED Viewed

@@ -1,41 +0,0 @@
-# Function: initialiseRightsManagementComponent()
-> **initialiseRightsManagementComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
-Initialise the rights management component.
-## Parameters
-### engineCore
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The engine core.
-### context
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The context for the engine.
-### instanceConfig
-[`RightsManagementComponentConfig`](../type-aliases/RightsManagementComponentConfig.md)
-The instance config.
-### overrideInstanceType?
-`string`
-The instance type to override the default.
-## Returns
-`undefined` \| `string`
-The name of the instance created.
-## Throws
-GeneralError if the component type is unknown.

package/docs/reference/functions/initialiseWalletStorage.md DELETED Viewed

@@ -1,41 +0,0 @@
-# Function: initialiseWalletStorage()
-> **initialiseWalletStorage**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
-Initialise the wallet storage.
-## Parameters
-### engineCore
-`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The engine core.
-### context
-`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
-The context for the engine.
-### instanceConfig
-[`WalletConnectorConfig`](../type-aliases/WalletConnectorConfig.md)
-The instance config.
-### overrideInstanceType?
-`string`
-The instance type to override the default.
-## Returns
-`undefined` \| `string`
-Nothing.
-## Throws
-GeneralError if the connector type is unknown.

package/docs/reference/type-aliases/RightsManagementComponentConfig.md DELETED Viewed

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

package/docs/reference/type-aliases/RightsManagementComponentType.md DELETED Viewed

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