@twin.org/engine-types 0.0.1-next.79 → 0.0.1-next.81

package/dist/cjs/index.cjs

@@ -60,6 +60,7 @@ var nftModels = require('@twin.org/nft-models');
 var nftService = require('@twin.org/nft-service');
 var rightsManagementService = require('@twin.org/rights-management-service');
 var rightsManagementPapService = require('@twin.org/rights-management-pap-service');
+var backgroundTaskScheduler = require('@twin.org/background-task-scheduler');
 var telemetryConnectorEntityStorage = require('@twin.org/telemetry-connector-entity-storage');
 var telemetryModels = require('@twin.org/telemetry-models');
 var telemetryService = require('@twin.org/telemetry-service');
@@ -2141,6 +2142,57 @@ function initialiseRightsManagementPapComponent(engineCore, context, instanceCon
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Task scheduler component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const TaskSchedulerComponentType = {
+    /**
+     * Task scheduler.
+     */
+    Default: "default"
+};
+
+/**
+ * Initialise a task scheduler.
+ * @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 connector type is unknown.
+ */
+function initialiseTaskSchedulerComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(core.I18n.formatMessage("engineCore.configuring", {
+        element: `Task Scheduler: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === TaskSchedulerComponentType.Default) {
+        component = new backgroundTaskScheduler.TaskSchedulerComponent({
+            loggingConnectorType: context.defaultTypes.loggingConnector,
+            ...instanceConfig.options
+        });
+        instanceType = backgroundTaskScheduler.TaskSchedulerComponent.NAMESPACE;
+    }
+    else {
+        throw new core.GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "taskSchedulerComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    core.ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -2559,6 +2611,7 @@ exports.NftComponentType = NftComponentType;
 exports.NftConnectorType = NftConnectorType;
 exports.RightsManagementComponentType = RightsManagementComponentType;
 exports.RightsManagementPapComponentType = RightsManagementPapComponentType;
+exports.TaskSchedulerComponentType = TaskSchedulerComponentType;
 exports.TelemetryComponentType = TelemetryComponentType;
 exports.TelemetryConnectorType = TelemetryConnectorType;
 exports.VaultConnectorType = VaultConnectorType;
@@ -2599,6 +2652,7 @@ exports.initialiseNftComponent = initialiseNftComponent;
 exports.initialiseNftConnector = initialiseNftConnector;
 exports.initialiseRightsManagementComponent = initialiseRightsManagementComponent;
 exports.initialiseRightsManagementPapComponent = initialiseRightsManagementPapComponent;
+exports.initialiseTaskSchedulerComponent = initialiseTaskSchedulerComponent;
 exports.initialiseTelemetryComponent = initialiseTelemetryComponent;
 exports.initialiseTelemetryConnector = initialiseTelemetryConnector;
 exports.initialiseVaultConnector = initialiseVaultConnector;

package/dist/esm/index.mjs

@@ -58,6 +58,7 @@ import { NftConnectorFactory } from '@twin.org/nft-models';
 import { NftService } from '@twin.org/nft-service';
 import { RightsManagementService } from '@twin.org/rights-management-service';
 import { initSchema as initSchema$c, PolicyAdministrationPointService } from '@twin.org/rights-management-pap-service';
+import { TaskSchedulerComponent } from '@twin.org/background-task-scheduler';
 import { initSchema as initSchema$d, EntityStorageTelemetryConnector } from '@twin.org/telemetry-connector-entity-storage';
 import { TelemetryConnectorFactory } from '@twin.org/telemetry-models';
 import { TelemetryService } from '@twin.org/telemetry-service';
@@ -2139,6 +2140,57 @@ function initialiseRightsManagementPapComponent(engineCore, context, instanceCon
     return finalInstanceType;
 }
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Task scheduler component types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const TaskSchedulerComponentType = {
+    /**
+     * Task scheduler.
+     */
+    Default: "default"
+};
+
+/**
+ * Initialise a task scheduler.
+ * @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 connector type is unknown.
+ */
+function initialiseTaskSchedulerComponent(engineCore, context, instanceConfig, overrideInstanceType) {
+    engineCore.logInfo(I18n.formatMessage("engineCore.configuring", {
+        element: `Task Scheduler: ${instanceConfig.type}`
+    }));
+    const type = instanceConfig.type;
+    let component;
+    let instanceType;
+    if (type === TaskSchedulerComponentType.Default) {
+        component = new TaskSchedulerComponent({
+            loggingConnectorType: context.defaultTypes.loggingConnector,
+            ...instanceConfig.options
+        });
+        instanceType = TaskSchedulerComponent.NAMESPACE;
+    }
+    else {
+        throw new GeneralError("engineCore", "componentUnknownType", {
+            type,
+            componentType: "taskSchedulerComponent"
+        });
+    }
+    const finalInstanceType = overrideInstanceType ?? instanceType;
+    context.componentInstances.push({
+        instanceType: finalInstanceType,
+        component
+    });
+    ComponentFactory.register(finalInstanceType, () => component);
+    return finalInstanceType;
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -2522,4 +2574,4 @@ const DltConfigType = {
     Iota: "iota"
 };
 
-export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DltConfigType, DocumentManagementComponentType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, RightsManagementComponentType, RightsManagementPapComponentType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseDataConverterConnector, initialiseDataExtractorConnector, initialiseDataProcessingComponent, initialiseDocumentManagementComponent, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseFederatedCatalogueComponent, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseIdentityResolverComponent, initialiseIdentityResolverConnector, initialiseImmutableProofComponent, initialiseLoggingComponent, initialiseLoggingConnector, initialiseMessagingComponent, initialiseMessagingEmailConnector, initialiseMessagingPushNotificationConnector, initialiseMessagingSmsConnector, initialiseNftComponent, initialiseNftConnector, initialiseRightsManagementComponent, initialiseRightsManagementPapComponent, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseVerifiableStorageComponent, initialiseVerifiableStorageConnector, initialiseWalletConnector, initialiseWalletStorage };
+export { AttestationComponentType, AttestationConnectorType, AuditableItemGraphComponentType, AuditableItemStreamComponentType, BackgroundTaskConnectorType, BlobStorageComponentType, BlobStorageConnectorType, DataConverterConnectorType, DataExtractorConnectorType, DataProcessingComponentType, DltConfigType, DocumentManagementComponentType, EntityStorageComponentType, EntityStorageConnectorType, EventBusComponentType, EventBusConnectorType, FaucetConnectorType, FederatedCatalogueComponentType, IdentityComponentType, IdentityConnectorType, IdentityProfileComponentType, IdentityProfileConnectorType, IdentityResolverComponentType, IdentityResolverConnectorType, ImmutableProofComponentType, LoggingComponentType, LoggingConnectorType, MessagingComponentType, MessagingEmailConnectorType, MessagingPushNotificationConnectorType, MessagingSmsConnectorType, NftComponentType, NftConnectorType, RightsManagementComponentType, RightsManagementPapComponentType, TaskSchedulerComponentType, TelemetryComponentType, TelemetryConnectorType, VaultConnectorType, VerifiableStorageComponentType, VerifiableStorageConnectorType, WalletConnectorType, initialiseAttestationComponent, initialiseAttestationConnector, initialiseAuditableItemGraphComponent, initialiseAuditableItemStreamComponent, initialiseBackgroundTaskConnector, initialiseBlobStorageComponent, initialiseBlobStorageConnector, initialiseDataConverterConnector, initialiseDataExtractorConnector, initialiseDataProcessingComponent, initialiseDocumentManagementComponent, initialiseEntityStorageComponent, initialiseEntityStorageConnector, initialiseEventBusComponent, initialiseEventBusConnector, initialiseFaucetConnector, initialiseFederatedCatalogueComponent, initialiseIdentityComponent, initialiseIdentityConnector, initialiseIdentityProfileComponent, initialiseIdentityProfileConnector, initialiseIdentityResolverComponent, initialiseIdentityResolverConnector, initialiseImmutableProofComponent, initialiseLoggingComponent, initialiseLoggingConnector, initialiseMessagingComponent, initialiseMessagingEmailConnector, initialiseMessagingPushNotificationConnector, initialiseMessagingSmsConnector, initialiseNftComponent, initialiseNftConnector, initialiseRightsManagementComponent, initialiseRightsManagementPapComponent, initialiseTaskSchedulerComponent, initialiseTelemetryComponent, initialiseTelemetryConnector, initialiseVaultConnector, initialiseVerifiableStorageComponent, initialiseVerifiableStorageConnector, initialiseWalletConnector, initialiseWalletStorage };

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

@@ -1,4 +1,4 @@
-import type { IEngineCoreContext, IEngineCore } from "@twin.org/engine-models";
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
 import type { BackgroundTaskConnectorConfig } from "../models/config/backgroundTaskConnectorConfig";
 import type { IEngineConfig } from "../models/IEngineConfig";
 /**

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

@@ -0,0 +1,13 @@
+import type { IEngineCore, IEngineCoreContext } from "@twin.org/engine-models";
+import type { TaskSchedulerComponentConfig } from "../models/config/taskSchedulerComponentConfig";
+import type { IEngineConfig } from "../models/IEngineConfig";
+/**
+ * Initialise a task scheduler.
+ * @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 connector type is unknown.
+ */
+export declare function initialiseTaskSchedulerComponent(engineCore: IEngineCore<IEngineConfig>, context: IEngineCoreContext<IEngineConfig>, instanceConfig: TaskSchedulerComponentConfig, overrideInstanceType?: string): string | undefined;

package/dist/types/index.d.ts

@@ -18,6 +18,7 @@ export * from "./components/messaging";
 export * from "./components/nft";
 export * from "./components/rightsManagement";
 export * from "./components/rightsManagementPap";
+export * from "./components/taskScheduler";
 export * from "./components/telemetry";
 export * from "./components/vault";
 export * from "./components/verifiableStorage";
@@ -57,6 +58,7 @@ export * from "./models/config/nftComponentConfig";
 export * from "./models/config/nftConnectorConfig";
 export * from "./models/config/rightsManagementComponentConfig";
 export * from "./models/config/rightsManagementPapComponentConfig";
+export * from "./models/config/taskSchedulerComponentConfig";
 export * from "./models/config/telemetryComponentConfig";
 export * from "./models/config/telemetryConnectorConfig";
 export * from "./models/config/vaultConnectorConfig";
@@ -99,6 +101,7 @@ export * from "./models/types/nftComponentType";
 export * from "./models/types/nftConnectorType";
 export * from "./models/types/rightsManagementComponentType";
 export * from "./models/types/rightsManagementPapComponentType";
+export * from "./models/types/taskSchedulerComponentType";
 export * from "./models/types/telemetryComponentType";
 export * from "./models/types/telemetryConnectorType";
 export * from "./models/types/vaultConnectorType";

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

@@ -34,6 +34,7 @@ import type { NftComponentConfig } from "./config/nftComponentConfig";
 import type { NftConnectorConfig } from "./config/nftConnectorConfig";
 import type { RightsManagementComponentConfig } from "./config/rightsManagementComponentConfig";
 import type { RightsManagementPapComponentConfig } from "./config/rightsManagementPapComponentConfig";
+import type { TaskSchedulerComponentConfig } from "./config/taskSchedulerComponentConfig";
 import type { TelemetryComponentConfig } from "./config/telemetryComponentConfig";
 import type { TelemetryConnectorConfig } from "./config/telemetryConnectorConfig";
 import type { VaultConnectorConfig } from "./config/vaultConnectorConfig";
@@ -101,6 +102,10 @@ export interface IEngineConfig extends IEngineCoreConfig {
          * Background task connector options which can be overridden by individual components by specifying types other than default.
          */
         backgroundTaskConnector?: IEngineCoreTypeConfig<BackgroundTaskConnectorConfig>[];
+        /**
+         * Task scheduler component options which can be overridden by individual components by specifying types other than default.
+         */
+        taskSchedulerComponent?: IEngineCoreTypeConfig<TaskSchedulerComponentConfig>[];
         /**
          * Event bus connector options which can be overridden by individual components by specifying types other than default.
          */

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

@@ -0,0 +1,9 @@
+import type { ITaskSchedulerConstructorOptions } from "@twin.org/background-task-scheduler";
+import type { TaskSchedulerComponentType } from "../types/taskSchedulerComponentType";
+/**
+ * Background task scheduled component config types.
+ */
+export type TaskSchedulerComponentConfig = {
+    type: typeof TaskSchedulerComponentType.Default;
+    options?: ITaskSchedulerConstructorOptions;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Task scheduler component types.
+ */
+export declare const TaskSchedulerComponentType: {
+    /**
+     * Task scheduler.
+     */
+    readonly Default: "default";
+};
+/**
+ * Task scheduler component types.
+ */
+export type TaskSchedulerComponentType = (typeof TaskSchedulerComponentType)[keyof typeof TaskSchedulerComponentType];

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/engine-types - Changelog
 
+## [0.0.1-next.81](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.1-next.80...engine-types-v0.0.1-next.81) (2025-07-07)
+
+
+### Miscellaneous Chores
+
+* **engine-types:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.1-next.80 to 0.0.1-next.81
+
+## [0.0.1-next.80](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.1-next.79...engine-types-v0.0.1-next.80) (2025-06-23)
+
+
+### Features
+
+* add task scheduler ([0951107](https://github.com/twinfoundation/engine/commit/09511073ad042194a45206303f0ef31d8d6af5db))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/engine-models bumped from 0.0.1-next.79 to 0.0.1-next.80
+
 ## [0.0.1-next.79](https://github.com/twinfoundation/engine/compare/engine-types-v0.0.1-next.78...engine-types-v0.0.1-next.79) (2025-06-18)
 
 

package/docs/reference/functions/initialiseTaskSchedulerComponent.md

@@ -0,0 +1,41 @@
+# Function: initialiseTaskSchedulerComponent()
+
+> **initialiseTaskSchedulerComponent**(`engineCore`, `context`, `instanceConfig`, `overrideInstanceType?`): `undefined` \| `string`
+
+Initialise a task scheduler.
+
+## Parameters
+
+### engineCore
+
+`IEngineCore`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The engine core.
+
+### context
+
+`IEngineCoreContext`\<[`IEngineConfig`](../interfaces/IEngineConfig.md)\>
+
+The context for the engine.
+
+### instanceConfig
+
+[`TaskSchedulerComponentConfig`](../type-aliases/TaskSchedulerComponentConfig.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 connector type is unknown.

package/docs/reference/index.md

@@ -41,6 +41,7 @@
 - [NftConnectorConfig](type-aliases/NftConnectorConfig.md)
 - [RightsManagementComponentConfig](type-aliases/RightsManagementComponentConfig.md)
 - [RightsManagementPapComponentConfig](type-aliases/RightsManagementPapComponentConfig.md)
+- [TaskSchedulerComponentConfig](type-aliases/TaskSchedulerComponentConfig.md)
 - [TelemetryComponentConfig](type-aliases/TelemetryComponentConfig.md)
 - [TelemetryConnectorConfig](type-aliases/TelemetryConnectorConfig.md)
 - [VaultConnectorConfig](type-aliases/VaultConnectorConfig.md)
@@ -82,6 +83,7 @@
 - [NftConnectorType](type-aliases/NftConnectorType.md)
 - [RightsManagementComponentType](type-aliases/RightsManagementComponentType.md)
 - [RightsManagementPapComponentType](type-aliases/RightsManagementPapComponentType.md)
+- [TaskSchedulerComponentType](type-aliases/TaskSchedulerComponentType.md)
 - [TelemetryComponentType](type-aliases/TelemetryComponentType.md)
 - [TelemetryConnectorType](type-aliases/TelemetryConnectorType.md)
 - [VaultConnectorType](type-aliases/VaultConnectorType.md)
@@ -126,6 +128,7 @@
 - [NftConnectorType](variables/NftConnectorType.md)
 - [RightsManagementComponentType](variables/RightsManagementComponentType.md)
 - [RightsManagementPapComponentType](variables/RightsManagementPapComponentType.md)
+- [TaskSchedulerComponentType](variables/TaskSchedulerComponentType.md)
 - [TelemetryComponentType](variables/TelemetryComponentType.md)
 - [TelemetryConnectorType](variables/TelemetryConnectorType.md)
 - [VaultConnectorType](variables/VaultConnectorType.md)
@@ -169,6 +172,7 @@
 - [initialiseNftComponent](functions/initialiseNftComponent.md)
 - [initialiseRightsManagementComponent](functions/initialiseRightsManagementComponent.md)
 - [initialiseRightsManagementPapComponent](functions/initialiseRightsManagementPapComponent.md)
+- [initialiseTaskSchedulerComponent](functions/initialiseTaskSchedulerComponent.md)
 - [initialiseTelemetryConnector](functions/initialiseTelemetryConnector.md)
 - [initialiseTelemetryComponent](functions/initialiseTelemetryComponent.md)
 - [initialiseVaultConnector](functions/initialiseVaultConnector.md)

package/docs/reference/interfaces/IEngineConfig.md

@@ -96,6 +96,12 @@ Messaging component options which can be overridden by individual components by
 
 Background task connector options which can be overridden by individual components by specifying types other than default.
 
+#### taskSchedulerComponent?
+
+> `optional` **taskSchedulerComponent**: `IEngineCoreTypeConfig`\<[`TaskSchedulerComponentConfig`](../type-aliases/TaskSchedulerComponentConfig.md)\>[]
+
+Task scheduler component options which can be overridden by individual components by specifying types other than default.
+
 #### eventBusConnector?
 
 > `optional` **eventBusConnector**: `IEngineCoreTypeConfig`\<[`EventBusConnectorConfig`](../type-aliases/EventBusConnectorConfig.md)\>[]

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

@@ -0,0 +1,17 @@
+# Type Alias: TaskSchedulerComponentConfig
+
+> **TaskSchedulerComponentConfig** = `object`
+
+Background task scheduled component config types.
+
+## Properties
+
+### type
+
+> **type**: *typeof* [`Default`](../variables/TaskSchedulerComponentType.md#default)
+
+***
+
+### options?
+
+> `optional` **options**: `ITaskSchedulerConstructorOptions`

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

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

package/docs/reference/variables/TaskSchedulerComponentType.md

@@ -0,0 +1,13 @@
+# Variable: TaskSchedulerComponentType
+
+> `const` **TaskSchedulerComponentType**: `object`
+
+Task scheduler component types.
+
+## Type declaration
+
+### Default
+
+> `readonly` **Default**: `"default"` = `"default"`
+
+Task scheduler.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/engine-types",
-	"version": "0.0.1-next.79",
+	"version": "0.0.1-next.81",
 	"description": "Types to use in an engine.",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-core": "next",
-		"@twin.org/engine-models": "0.0.1-next.79",
+		"@twin.org/engine-models": "0.0.1-next.81",
 		"@twin.org/entity": "next",
 		"@twin.org/modules": "next",
 		"@twin.org/nameof": "next"
@@ -32,6 +32,7 @@
 		"@twin.org/auditable-item-stream-service": "next",
 		"@twin.org/background-task-connector-entity-storage": "next",
 		"@twin.org/background-task-models": "next",
+		"@twin.org/background-task-scheduler": "next",
 		"@twin.org/blob-storage-connector-aws-s3": "next",
 		"@twin.org/blob-storage-connector-azure": "next",
 		"@twin.org/blob-storage-connector-file": "next",