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

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

@@ -0,0 +1,9 @@
+import type { IBackgroundTaskServiceConstructorOptions } from "@twin.org/background-task-service";
+import type { BackgroundTaskComponentType } from "../types/backgroundTaskComponentType.js";
+/**
+ * Background task component config types.
+ */
+export type BackgroundTaskComponentConfig = {
+    type: typeof BackgroundTaskComponentType.Service;
+    options?: IBackgroundTaskServiceConstructorOptions;
+};

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

@@ -3,6 +3,7 @@ import type { IAzureBlobStorageConnectorConstructorOptions } from "@twin.org/blo
 import type { IFileBlobStorageConnectorConstructorOptions } from "@twin.org/blob-storage-connector-file";
 import type { IGcpBlobStorageConnectorConstructorOptions } from "@twin.org/blob-storage-connector-gcp";
 import type { IIpfsBlobStorageConnectorConstructorOptions } from "@twin.org/blob-storage-connector-ipfs";
+import type { IMemoryStorageConnectorConstructorOptions } from "@twin.org/blob-storage-connector-memory";
 import type { BlobStorageConnectorType } from "../types/blobStorageConnectorType.js";
 /**
  * Blob storage connector config types.
@@ -14,7 +15,9 @@ export type BlobStorageConnectorConfig = {
     };
 } | {
     type: typeof BlobStorageConnectorType.Memory;
-    options?: never;
+    options?: IMemoryStorageConnectorConstructorOptions & {
+        config: never;
+    };
 } | {
     type: typeof BlobStorageConnectorType.AwsS3;
     options: IS3BlobStorageConnectorConstructorOptions & {

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

@@ -0,0 +1,11 @@
+import type { ContextIdHandlerComponentType } from "../types/contextIdHandlerComponentType.js";
+/**
+ * Context Id Handler component config types.
+ */
+export type ContextIdHandlerComponentConfig = {
+    type: typeof ContextIdHandlerComponentType.Did;
+    options?: never;
+} | {
+    type: typeof ContextIdHandlerComponentType.Tenant;
+    options?: never;
+};

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

@@ -0,0 +1,9 @@
+import type { IFilterByExampleConstructorOptions } from "@twin.org/federated-catalogue-filters";
+import type { FederatedCatalogueFilterComponentType } from "../types/federatedCatalogueFilterComponentType.js";
+/**
+ * Federated catalog filter component config types.
+ */
+export type FederatedCatalogueFilterComponentConfig = {
+    type: typeof FederatedCatalogueFilterComponentType.FilterByExample;
+    options: IFilterByExampleConstructorOptions;
+};

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

@@ -1,4 +1,3 @@
-import type { IEngineModuleConfig } from "@twin.org/engine-models";
 import type { IPolicyDecisionPointServiceConstructorOptions } from "@twin.org/rights-management-pdp-service";
 import type { RightsManagementPdpComponentType } from "../types/rightsManagementPdpComponentType.js";
 /**
@@ -6,7 +5,5 @@ import type { RightsManagementPdpComponentType } from "../types/rightsManagement
  */
 export type RightsManagementPdpComponentConfig = {
     type: typeof RightsManagementPdpComponentType.Service;
-    options?: IPolicyDecisionPointServiceConstructorOptions & {
-        arbiterModulesConfig?: IEngineModuleConfig[];
-    };
+    options?: IPolicyDecisionPointServiceConstructorOptions;
 };

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

@@ -1,4 +1,3 @@
-import type { IEngineModuleConfig } from "@twin.org/engine-models";
 import type { IPolicyEnforcementPointServiceConstructorOptions } from "@twin.org/rights-management-pep-service";
 import type { RightsManagementPepComponentType } from "../types/rightsManagementPepComponentType.js";
 /**
@@ -6,7 +5,5 @@ import type { RightsManagementPepComponentType } from "../types/rightsManagement
  */
 export type RightsManagementPepComponentConfig = {
     type: typeof RightsManagementPepComponentType.Service;
-    options?: IPolicyEnforcementPointServiceConstructorOptions & {
-        processorModulesConfig?: IEngineModuleConfig[];
-    };
+    options?: IPolicyEnforcementPointServiceConstructorOptions;
 };

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

@@ -1,4 +1,3 @@
-import type { IEngineModuleConfig } from "@twin.org/engine-models";
 import type { IPolicyInformationPointServiceConstructorOptions } from "@twin.org/rights-management-pip-service";
 import type { RightsManagementPipComponentType } from "../types/rightsManagementPipComponentType.js";
 /**
@@ -6,7 +5,5 @@ import type { RightsManagementPipComponentType } from "../types/rightsManagement
  */
 export type RightsManagementPipComponentConfig = {
     type: typeof RightsManagementPipComponentType.Service;
-    options?: IPolicyInformationPointServiceConstructorOptions & {
-        informationModulesConfig?: IEngineModuleConfig[];
-    };
+    options?: IPolicyInformationPointServiceConstructorOptions;
 };

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

@@ -1,5 +1,4 @@
 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.js";
 /**
@@ -7,10 +6,7 @@ import type { RightsManagementPnpComponentType } from "../types/rightsManagement
  */
 export type RightsManagementPnpComponentConfig = {
     type: typeof RightsManagementPnpComponentType.Service;
-    options: IPolicyNegotiationPointServiceConstructorOptions & {
-        negotiatorModulesConfig?: IEngineModuleConfig[];
-        requesterModulesConfig?: IEngineModuleConfig[];
-    };
+    options: IPolicyNegotiationPointServiceConstructorOptions;
 } | {
     type: typeof RightsManagementPnpComponentType.RestClient;
     options: IBaseRestClientConfig;

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

@@ -0,0 +1,12 @@
+import type { IDefaultPolicyArbiterConstructorOptions, IPassThroughPolicyArbiterConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyArbiterComponentType } from "../types/rightsManagementPolicyArbiterComponentType.js";
+/**
+ * Rights management policy arbiter component config types.
+ */
+export type RightsManagementPolicyArbiterComponentConfig = {
+    type: typeof RightsManagementPolicyArbiterComponentType.PassThrough;
+    options?: IPassThroughPolicyArbiterConstructorOptions;
+} | {
+    type: typeof RightsManagementPolicyArbiterComponentType.Default;
+    options?: IDefaultPolicyArbiterConstructorOptions;
+};

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

@@ -0,0 +1,12 @@
+import type { IDefaultPolicyEnforcementProcessorConstructorOptions, IPassThroughPolicyEnforcementProcessorConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyEnforcementProcessorComponentType } from "../types/rightsManagementPolicyEnforcementProcessorComponentType.js";
+/**
+ * Rights management policy enforcement processor component config types.
+ */
+export type RightsManagementPolicyEnforcementProcessorComponentConfig = {
+    type: typeof RightsManagementPolicyEnforcementProcessorComponentType.PassThrough;
+    options?: IPassThroughPolicyEnforcementProcessorConstructorOptions;
+} | {
+    type: typeof RightsManagementPolicyEnforcementProcessorComponentType.Default;
+    options?: IDefaultPolicyEnforcementProcessorConstructorOptions;
+};

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

@@ -0,0 +1,9 @@
+import type { ILoggingPolicyExecutionActionConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyExecutionActionComponentType } from "../types/rightsManagementPolicyExecutionActionComponentType.js";
+/**
+ * Rights management policy execution action component config types.
+ */
+export type RightsManagementPolicyExecutionActionComponentConfig = {
+    type: typeof RightsManagementPolicyExecutionActionComponentType.Logging;
+    options?: ILoggingPolicyExecutionActionConstructorOptions;
+};

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

@@ -0,0 +1,12 @@
+import type { IIdentityPolicyInformationSourceConstructorOptions, IStaticPolicyInformationSourceConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyInformationSourceComponentType } from "../types/rightsManagementPolicyInformationSourceComponentType.js";
+/**
+ * Rights management policy information source component config types.
+ */
+export type RightsManagementPolicyInformationSourceComponentConfig = {
+    type: typeof RightsManagementPolicyInformationSourceComponentType.Identity;
+    options?: IIdentityPolicyInformationSourceConstructorOptions;
+} | {
+    type: typeof RightsManagementPolicyInformationSourceComponentType.Static;
+    options?: IStaticPolicyInformationSourceConstructorOptions;
+};

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

@@ -0,0 +1,9 @@
+import type { IPassThroughPolicyNegotiatorConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyNegotiatorComponentType } from "../types/rightsManagementPolicyNegotiatorComponentType.js";
+/**
+ * Rights management policy negotiator component config types.
+ */
+export type RightsManagementPolicyNegotiatorComponentConfig = {
+    type: typeof RightsManagementPolicyNegotiatorComponentType.PassThrough;
+    options?: IPassThroughPolicyNegotiatorConstructorOptions;
+};

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

@@ -0,0 +1,9 @@
+import type { IPassThroughPolicyObligationEnforcerConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyObligationEnforcerComponentType } from "../types/rightsManagementPolicyObligationEnforcerComponentType.js";
+/**
+ * Rights management policy obligation enforcer component config types.
+ */
+export type RightsManagementPolicyObligationEnforcerComponentConfig = {
+    type: typeof RightsManagementPolicyObligationEnforcerComponentType.PassThrough;
+    options?: IPassThroughPolicyObligationEnforcerConstructorOptions;
+};

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

@@ -0,0 +1,9 @@
+import type { IPassThroughPolicyRequesterConstructorOptions } from "@twin.org/rights-management-plugins";
+import type { RightsManagementPolicyRequesterComponentType } from "../types/rightsManagementPolicyRequesterComponentType.js";
+/**
+ * Rights management policy requester component config types.
+ */
+export type RightsManagementPolicyRequesterComponentConfig = {
+    type: typeof RightsManagementPolicyRequesterComponentType.PassThrough;
+    options?: IPassThroughPolicyRequesterConstructorOptions;
+};

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

@@ -1,4 +1,3 @@
-import type { IEngineModuleConfig } from "@twin.org/engine-models";
 import type { IPolicyExecutionPointServiceConstructorOptions } from "@twin.org/rights-management-pxp-service";
 import type { RightsManagementPxpComponentType } from "../types/rightsManagementPxpComponentType.js";
 /**
@@ -6,7 +5,5 @@ import type { RightsManagementPxpComponentType } from "../types/rightsManagement
  */
 export type RightsManagementPxpComponentConfig = {
     type: typeof RightsManagementPxpComponentType.Service;
-    options?: IPolicyExecutionPointServiceConstructorOptions & {
-        actionModulesConfig?: IEngineModuleConfig[];
-    };
+    options?: IPolicyExecutionPointServiceConstructorOptions;
 };

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

@@ -0,0 +1,9 @@
+import type { ITrustServiceConstructorOptions } from "@twin.org/trust-service";
+import type { TrustComponentType } from "../types/trustComponentType.js";
+/**
+ * Trust component config types.
+ */
+export type TrustComponentConfig = {
+    type: typeof TrustComponentType.Service;
+    options?: ITrustServiceConstructorOptions;
+};

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

@@ -0,0 +1,9 @@
+import type { IJwtVerifiableCredentialGeneratorConstructorOptions } from "@twin.org/trust-generators";
+import type { TrustGeneratorComponentType } from "../types/trustGeneratorComponentType.js";
+/**
+ * Trust Generator component config types.
+ */
+export type TrustGeneratorComponentConfig = {
+    type: typeof TrustGeneratorComponentType.JwtVerifiableCredential;
+    options: IJwtVerifiableCredentialGeneratorConstructorOptions;
+};

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

@@ -0,0 +1,9 @@
+import type { IJwtVerifiableCredentialVerifierConstructorOptions } from "@twin.org/trust-verifiers";
+import type { TrustVerifierComponentType } from "../types/trustVerifierComponentType.js";
+/**
+ * Trust verifier component config types.
+ */
+export type TrustVerifierComponentConfig = {
+    type: typeof TrustVerifierComponentType.JwtVerifiableCredential;
+    options?: IJwtVerifiableCredentialVerifierConstructorOptions;
+};

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

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

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

@@ -0,0 +1,17 @@
+/**
+ * Context Id Handler types.
+ */
+export declare const ContextIdHandlerComponentType: {
+    /**
+     * Did.
+     */
+    readonly Did: "Did";
+    /**
+     * Tenant.
+     */
+    readonly Tenant: "Tenant";
+};
+/**
+ * Context Id Handler component types.
+ */
+export type ContextIdHandlerComponentType = (typeof ContextIdHandlerComponentType)[keyof typeof ContextIdHandlerComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Federated catalogue filter component types.
+ */
+export declare const FederatedCatalogueFilterComponentType: {
+    /**
+     * Filter By Example.
+     */
+    readonly FilterByExample: "filter-by-example";
+};
+/**
+ * Federated catalogue filter component types.
+ */
+export type FederatedCatalogueFilterComponentType = (typeof FederatedCatalogueFilterComponentType)[keyof typeof FederatedCatalogueFilterComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * Rights management Policy Arbiter component types.
+ */
+export declare const RightsManagementPolicyArbiterComponentType: {
+    /**
+     * PassThrough.
+     */
+    readonly PassThrough: "pass-through";
+    /**
+     * Default.
+     */
+    readonly Default: "default";
+};
+/**
+ * Rights management Policy Arbiter component types.
+ */
+export type RightsManagementPolicyArbiterComponentType = (typeof RightsManagementPolicyArbiterComponentType)[keyof typeof RightsManagementPolicyArbiterComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * Rights management Policy Enforcement Processor component types.
+ */
+export declare const RightsManagementPolicyEnforcementProcessorComponentType: {
+    /**
+     * Pass Through.
+     */
+    readonly PassThrough: "pass-through";
+    /**
+     * Default.
+     */
+    readonly Default: "default";
+};
+/**
+ * Rights management Policy Enforcement Processor component types.
+ */
+export type RightsManagementPolicyEnforcementProcessorComponentType = (typeof RightsManagementPolicyEnforcementProcessorComponentType)[keyof typeof RightsManagementPolicyEnforcementProcessorComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Rights management Policy Execution Action component types.
+ */
+export declare const RightsManagementPolicyExecutionActionComponentType: {
+    /**
+     * Logging.
+     */
+    readonly Logging: "logging";
+};
+/**
+ * Rights management Policy Execution Action component types.
+ */
+export type RightsManagementPolicyExecutionActionComponentType = (typeof RightsManagementPolicyExecutionActionComponentType)[keyof typeof RightsManagementPolicyExecutionActionComponentType];

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

@@ -0,0 +1,17 @@
+/**
+ * Rights management Policy Information Source component types.
+ */
+export declare const RightsManagementPolicyInformationSourceComponentType: {
+    /**
+     * Identity.
+     */
+    readonly Identity: "identity";
+    /**
+     * Static.
+     */
+    readonly Static: "static";
+};
+/**
+ * Rights management Policy Information Source component types.
+ */
+export type RightsManagementPolicyInformationSourceComponentType = (typeof RightsManagementPolicyInformationSourceComponentType)[keyof typeof RightsManagementPolicyInformationSourceComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Rights management Policy Negotiator component types.
+ */
+export declare const RightsManagementPolicyNegotiatorComponentType: {
+    /**
+     * Pass Through.
+     */
+    readonly PassThrough: "pass-through";
+};
+/**
+ * Rights management Policy Negotiator component types.
+ */
+export type RightsManagementPolicyNegotiatorComponentType = (typeof RightsManagementPolicyNegotiatorComponentType)[keyof typeof RightsManagementPolicyNegotiatorComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Rights management Policy Obligation Enforcer component types.
+ */
+export declare const RightsManagementPolicyObligationEnforcerComponentType: {
+    /**
+     * PassThrough.
+     */
+    readonly PassThrough: "pass-through";
+};
+/**
+ * Rights management Policy Obligation Enforcer component types.
+ */
+export type RightsManagementPolicyObligationEnforcerComponentType = (typeof RightsManagementPolicyObligationEnforcerComponentType)[keyof typeof RightsManagementPolicyObligationEnforcerComponentType];

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

@@ -0,0 +1,13 @@
+/**
+ * Rights management Policy Requester component types.
+ */
+export declare const RightsManagementPolicyRequesterComponentType: {
+    /**
+     * PassThrough.
+     */
+    readonly PassThrough: "pass-through";
+};
+/**
+ * Rights management Policy Requester component types.
+ */
+export type RightsManagementPolicyRequesterComponentType = (typeof RightsManagementPolicyRequesterComponentType)[keyof typeof RightsManagementPolicyRequesterComponentType];

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

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

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

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

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

@@ -0,0 +1,13 @@
+/**
+ * Trust verifier component types.
+ */
+export declare const TrustVerifierComponentType: {
+    /**
+     * JWT Verifiable Credential.
+     */
+    readonly JwtVerifiableCredential: "jwt-verifiable-credential";
+};
+/**
+ * Trust verifier component types.
+ */
+export type TrustVerifierComponentType = (typeof TrustVerifierComponentType)[keyof typeof TrustVerifierComponentType];

package/dist/types/utils/engineTypeHelper.d.ts

@@ -16,4 +16,15 @@ export declare class EngineTypeHelper {
      * @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;
+    /**
+     * Merge multiple config objects into one.
+     * Each config parameter can be a different partial type, and they are merged together.
+     * @param config1 The first config object.
+     * @param config2 Optional additional config object to merge.
+     * @param config3 Optional additional config object to merge.
+     * @param config4 Optional additional config object to merge.
+     * @param config5 Optional additional config object to merge.
+     * @returns The merged config object combining all input types.
+     */
+    static mergeConfig<T extends IEngineCoreTypeBaseConfig["options"]>(config1?: Partial<T>, config2?: Partial<T>, config3?: Partial<T>, config4?: Partial<T>, config5?: Partial<T>): T;
 }