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

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

@@ -0,0 +1,9 @@
+import type { IVerifiableCredentialAuthenticationGeneratorConstructorOptions } from "@twin.org/identity-authentication";
+import type { AuthenticationGeneratorComponentType } from "../types/authenticationGeneratorComponentType";
+/**
+ * Authentication generator component config types.
+ */
+export type AuthenticationGeneratorComponentConfig = {
+    type: typeof AuthenticationGeneratorComponentType.VerifiableCredential;
+    options: IVerifiableCredentialAuthenticationGeneratorConstructorOptions;
+};

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

@@ -0,0 +1,17 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IDataSpaceConnectorServiceConstructorOptions } from "@twin.org/data-space-connector-service";
+import type { IDataSpaceConnectorSocketClientConstructorOptions } from "@twin.org/data-space-connector-socket-client";
+import type { DataSpaceConnectorComponentType } from "../types/dataSpaceConnectorComponentType";
+/**
+ * Data space connector component config types.
+ */
+export type DataSpaceConnectorComponentConfig = {
+    type: typeof DataSpaceConnectorComponentType.Service;
+    options?: IDataSpaceConnectorServiceConstructorOptions;
+} | {
+    type: typeof DataSpaceConnectorComponentType.RestClient;
+    options: IBaseRestClientConfig;
+} | {
+    type: typeof DataSpaceConnectorComponentType.SocketClient;
+    options: IDataSpaceConnectorSocketClientConstructorOptions;
+};

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

@@ -6,6 +6,7 @@ import type { IMongoDbEntityStorageConnectorConstructorOptions } from "@twin.org
 import type { IMySqlEntityStorageConnectorConstructorOptions } from "@twin.org/entity-storage-connector-mysql";
 import type { IPostgreSqlEntityStorageConnectorConstructorOptions } from "@twin.org/entity-storage-connector-postgresql";
 import type { IScyllaDBTableConnectorConstructorOptions } from "@twin.org/entity-storage-connector-scylladb";
+import type { ISynchronisedEntityStorageConnectorConstructorOptions } from "@twin.org/entity-storage-connector-synchronised";
 import type { EntityStorageConnectorType } from "../types/entityStorageConnectorType";
 /**
  * Entity storage connector config types.
@@ -60,4 +61,7 @@ export type EntityStorageConnectorConfig = {
         config: Omit<IPostgreSqlEntityStorageConnectorConstructorOptions["config"], "tableName">;
         tablePrefix?: string;
     };
+} | {
+    type: typeof EntityStorageConnectorType.Synchronised;
+    options: Omit<ISynchronisedEntityStorageConnectorConstructorOptions, "entitySchema">;
 };

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

@@ -0,0 +1,9 @@
+import type { IMessagingAdminServiceConstructorOptions } from "@twin.org/messaging-service";
+import type { MessagingAdminComponentType } from "../types/messagingAdminComponentType";
+/**
+ * Messaging admin component config types.
+ */
+export type MessagingAdminComponentConfig = {
+    type: typeof MessagingAdminComponentType.Service;
+    options?: IMessagingAdminServiceConstructorOptions;
+};

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

@@ -0,0 +1,16 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IDataAccessPointServiceConstructorOptions } from "@twin.org/rights-management-dap-service";
+import type { RightsManagementDapComponentType } from "../types/rightsManagementDapComponentType";
+/**
+ * Rights management DAP component config types.
+ */
+export type RightsManagementDapComponentConfig = {
+    type: typeof RightsManagementDapComponentType.Service;
+    options?: IDataAccessPointServiceConstructorOptions & {
+        negotiatorModulesConfig?: IEngineModuleConfig[];
+    };
+} | {
+    type: typeof RightsManagementDapComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

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

@@ -0,0 +1,12 @@
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IDataAccessRequestPointServiceConstructorOptions } from "@twin.org/rights-management-dap-service";
+import type { RightsManagementDarpComponentType } from "../types/rightsManagementDarpComponentType";
+/**
+ * Rights management DARP component config types.
+ */
+export type RightsManagementDarpComponentConfig = {
+    type: typeof RightsManagementDarpComponentType.Service;
+    options: IDataAccessRequestPointServiceConstructorOptions & {
+        negotiatorModulesConfig?: IEngineModuleConfig[];
+    };
+};

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

@@ -1,9 +1,13 @@
-import type { IPolicyAdministrationPointServiceOptions } from "@twin.org/rights-management-pap-service";
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IPolicyAdministrationPointServiceConstructorOptions } from "@twin.org/rights-management-pap-service";
 import type { RightsManagementPapComponentType } from "../types/rightsManagementPapComponentType";
 /**
  * Rights management PAP component config types.
  */
 export type RightsManagementPapComponentConfig = {
     type: typeof RightsManagementPapComponentType.Service;
-    options?: IPolicyAdministrationPointServiceOptions;
+    options?: IPolicyAdministrationPointServiceConstructorOptions;
+} | {
+    type: typeof RightsManagementPapComponentType.RestClient;
+    options: IBaseRestClientConfig;
 };

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

@@ -0,0 +1,12 @@
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IPolicyDecisionPointServiceConstructorOptions } from "@twin.org/rights-management-pdp-service";
+import type { RightsManagementPdpComponentType } from "../types/rightsManagementPdpComponentType";
+/**
+ * Rights management PDP component config types.
+ */
+export type RightsManagementPdpComponentConfig = {
+    type: typeof RightsManagementPdpComponentType.Service;
+    options?: IPolicyDecisionPointServiceConstructorOptions & {
+        arbiterModulesConfig?: IEngineModuleConfig[];
+    };
+};

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

@@ -0,0 +1,12 @@
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IPolicyEnforcementPointServiceConstructorOptions } from "@twin.org/rights-management-pep-service";
+import type { RightsManagementPepComponentType } from "../types/rightsManagementPepComponentType";
+/**
+ * Rights management PEP component config types.
+ */
+export type RightsManagementPepComponentConfig = {
+    type: typeof RightsManagementPepComponentType.Service;
+    options?: IPolicyEnforcementPointServiceConstructorOptions & {
+        processorModulesConfig?: IEngineModuleConfig[];
+    };
+};

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

@@ -0,0 +1,12 @@
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IPolicyInformationPointServiceConstructorOptions } from "@twin.org/rights-management-pip-service";
+import type { RightsManagementPipComponentType } from "../types/rightsManagementPipComponentType";
+/**
+ * Rights management PIP component config types.
+ */
+export type RightsManagementPipComponentConfig = {
+    type: typeof RightsManagementPipComponentType.Service;
+    options?: IPolicyInformationPointServiceConstructorOptions & {
+        informationModulesConfig?: IEngineModuleConfig[];
+    };
+};

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

@@ -0,0 +1,9 @@
+import type { IPolicyManagementPointServiceConstructorOptions } from "@twin.org/rights-management-pmp-service";
+import type { RightsManagementPmpComponentType } from "../types/rightsManagementPmpComponentType";
+/**
+ * Rights management PMP component config types.
+ */
+export type RightsManagementPmpComponentConfig = {
+    type: typeof RightsManagementPmpComponentType.Service;
+    options?: IPolicyManagementPointServiceConstructorOptions;
+};

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

@@ -0,0 +1,13 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IPolicyNegotiationAdminPointServiceConstructorOptions } from "@twin.org/rights-management-pnp-service";
+import type { RightsManagementPnapComponentType } from "../types/rightsManagementPnapComponentType";
+/**
+ * Rights management PNAP component config types.
+ */
+export type RightsManagementPnapComponentConfig = {
+    type: typeof RightsManagementPnapComponentType.Service;
+    options?: IPolicyNegotiationAdminPointServiceConstructorOptions;
+} | {
+    type: typeof RightsManagementPnapComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

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

@@ -0,0 +1,17 @@
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IPolicyNegotiationPointServiceConstructorOptions } from "@twin.org/rights-management-pnp-service";
+import type { RightsManagementPnpComponentType } from "../types/rightsManagementPnpComponentType";
+/**
+ * Rights management PNP component config types.
+ */
+export type RightsManagementPnpComponentConfig = {
+    type: typeof RightsManagementPnpComponentType.Service;
+    options: IPolicyNegotiationPointServiceConstructorOptions & {
+        negotiatorModulesConfig?: IEngineModuleConfig[];
+        requesterModulesConfig?: IEngineModuleConfig[];
+    };
+} | {
+    type: typeof RightsManagementPnpComponentType.RestClient;
+    options: IBaseRestClientConfig;
+};

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

@@ -0,0 +1,12 @@
+import type { IEngineModuleConfig } from "@twin.org/engine-models";
+import type { IPolicyExecutionPointServiceConstructorOptions } from "@twin.org/rights-management-pxp-service";
+import type { RightsManagementPxpComponentType } from "../types/rightsManagementPxpComponentType";
+/**
+ * Rights management PXP component config types.
+ */
+export type RightsManagementPxpComponentConfig = {
+    type: typeof RightsManagementPxpComponentType.Service;
+    options?: IPolicyExecutionPointServiceConstructorOptions & {
+        actionModulesConfig?: IEngineModuleConfig[];
+    };
+};

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * Authentication generator component types.
+ */
+export declare const AuthenticationGeneratorComponentType: {
+    /**
+     * Verifiable Credential.
+     */
+    readonly VerifiableCredential: "verifiable-credential";
+};
+/**
+ * Authentication generator component types.
+ */
+export type AuthenticationGeneratorComponentType = (typeof AuthenticationGeneratorComponentType)[keyof typeof AuthenticationGeneratorComponentType];

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

@@ -0,0 +1,21 @@
+/**
+ * Data space connector component types.
+ */
+export declare const DataSpaceConnectorComponentType: {
+    /**
+     * Service.
+     */
+    readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
+    /**
+     * Socket client.
+     */
+    readonly SocketClient: "socket-client";
+};
+/**
+ * Data space connector component types.
+ */
+export type DataSpaceConnectorComponentType = (typeof DataSpaceConnectorComponentType)[keyof typeof DataSpaceConnectorComponentType];

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

@@ -38,6 +38,10 @@ export declare const EntityStorageConnectorType: {
      * Postgre SQL.
      */
     readonly PostgreSql: "postgresql";
+    /**
+     * Synchronised.
+     */
+    readonly Synchronised: "synchronised";
 };
 /**
  * Entity storage connector types.

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

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

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

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

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

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

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

@@ -6,6 +6,10 @@ export declare const RightsManagementPapComponentType: {
      * Service.
      */
     readonly Service: "service";
+    /**
+     * REST client.
+     */
+    readonly RestClient: "rest-client";
 };
 /**
  * Rights management PAP component types.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * 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/utils/engineTypeHelper.d.ts

@@ -0,0 +1,19 @@
+import type { IEngineCoreTypeBaseConfig, IEngineCoreTypeConfig } from "@twin.org/engine-models";
+import type { IEngineConfig } from "../models/IEngineConfig";
+/**
+ * Helper methods for engine config types.
+ */
+export declare class EngineTypeHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Get the config for the specified component and type.
+     * @param engineConfig The engine configuration.
+     * @param component The component name.
+     * @param type The type name.
+     * @returns The config for the specified component and type or undefined if it does not exist.
+     */
+    static getConfigOfType<T extends IEngineCoreTypeBaseConfig>(engineConfig: IEngineConfig, component: string, type: string): IEngineCoreTypeConfig<T> | undefined;
+}