@twin.org/background-task-models 0.0.2-next.9 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Background Task Models
 
-Models which define the structure of the background task contracts and connectors.
+This package is part of the background task toolkit and helps build reliable asynchronous workflows in TWIN applications.
 
 ## Installation
 

package/dist/es/index.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/IBackgroundTask.js";
+export * from "./models/IBackgroundTaskComponent.js";
+export * from "./models/IScheduledTaskInfo.js";
+export * from "./models/IScheduledTaskTime.js";
+export * from "./models/ITaskSchedulerComponent.js";
+export * from "./models/taskStatus.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,wBAAwB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/IBackgroundTask.js\";\nexport * from \"./models/IBackgroundTaskComponent.js\";\nexport * from \"./models/IScheduledTaskInfo.js\";\nexport * from \"./models/IScheduledTaskTime.js\";\nexport * from \"./models/ITaskSchedulerComponent.js\";\nexport * from \"./models/taskStatus.js\";\n"]}

package/dist/es/models/IBackgroundTask.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IBackgroundTask.js.map

package/dist/es/models/IBackgroundTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBackgroundTask.js","sourceRoot":"","sources":["../../../src/models/IBackgroundTask.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@twin.org/core\";\nimport type { TaskStatus } from \"./taskStatus.js\";\n\n/**\n * Interface describing a background task.\n */\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nexport interface IBackgroundTask<T = any, U = any> {\n\t/**\n\t * The id.\n\t */\n\tid: string;\n\n\t/**\n\t * The type of the task.\n\t */\n\ttype: string;\n\n\t/**\n\t * The thread id for the task.\n\t */\n\tthreadId: string;\n\n\t/**\n\t * The retry interval in milliseconds, undefined if default scheduling.\n\t */\n\tretryInterval?: number;\n\n\t/**\n\t * The number of retries remaining, undefined if infinite retries.\n\t */\n\tretriesRemaining?: number;\n\n\t/**\n\t * The date the task was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date the task was last modified.\n\t */\n\tdateModified: string;\n\n\t/**\n\t * The date the task was complete.\n\t */\n\tdateCompleted?: string;\n\n\t/**\n\t * The date the task was cancelled.\n\t */\n\tdateCancelled?: string;\n\n\t/**\n\t * The date until when to retain.\n\t */\n\tdateRetainUntil?: string;\n\n\t/**\n\t * The status of the task.\n\t */\n\tstatus: TaskStatus;\n\n\t/**\n\t * The payload to execute the task with.\n\t */\n\tpayload?: T;\n\n\t/**\n\t * The result of the execution.\n\t */\n\tresult?: U;\n\n\t/**\n\t * The error at last execution.\n\t */\n\terror?: IError;\n}\n"]}

package/dist/es/models/IBackgroundTaskComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IBackgroundTaskComponent.js.map

package/dist/es/models/IBackgroundTaskComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBackgroundTaskComponent.js","sourceRoot":"","sources":["../../../src/models/IBackgroundTaskComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { SortDirection } from \"@twin.org/entity\";\nimport type { IBackgroundTask } from \"./IBackgroundTask.js\";\nimport type { TaskStatus } from \"./taskStatus.js\";\n\n/**\n * Interface describing a background task component.\n */\nexport interface IBackgroundTaskComponent extends IComponent {\n\t/**\n\t * Register a handler for a task.\n\t * @param taskType The type of the task the handler can process.\n\t * @param module The module the handler is in.\n\t * @param method The method in the module to execute.\n\t * @param stateChangeCallback The callback to execute when the task state is updated.\n\t * @param options Additional options for the task.\n\t * @param options.maxWorkerCount The maximum number of workers in the pool.\n\t * @param options.idleShutdownTimeout Terminate the worker after it has been idle for the specified timeout in milliseconds, defaults to 0 shutdown immediately, -1 to keep forever.\n\t * @param options.initialiseMethod The initialisation method to call on the module when a worker is started.\n\t * @param options.shutdownMethod The shutdown method to call on the module when a worker is stopped.\n\t * @returns Nothing.\n\t */\n\tregisterHandler<T, U>(\n\t\ttaskType: string,\n\t\tmodule: string,\n\t\tmethod: string,\n\t\tstateChangeCallback?: (task: IBackgroundTask<T, U>) => Promise<void>,\n\t\toptions?: {\n\t\t\tmaxWorkerCount?: number;\n\t\t\tidleShutdownTimeout?: number;\n\t\t\tinitialiseMethod?: string;\n\t\t\tshutdownMethod?: string;\n\t\t}\n\t): Promise<void>;\n\n\t/**\n\t * Unregister a handler for a task.\n\t * @param taskType The type of the task handler to remove.\n\t * @returns Nothing.\n\t */\n\tunregisterHandler(taskType: string): Promise<void>;\n\n\t/**\n\t * Create a new task.\n\t * @param taskType The type of the task.\n\t * @param payload The payload for the task.\n\t * @param options Additional options for the task.\n\t * @param options.retryCount The number of times to retry the task if it fails, leave undefined to retry forever.\n\t * @param options.retryInterval The interval in milliseconds to wait between retries, defaults to 5000, leave undefined for default scheduling.\n\t * @param options.retainFor The amount of time in milliseconds to retain the result until removal, defaults to 0 for immediate removal, set to -1 to keep forever.\n\t * @returns The id of the created task.\n\t */\n\tcreate<T>(\n\t\ttaskType: string,\n\t\tpayload?: T,\n\t\toptions?: {\n\t\t\tretryCount?: number;\n\t\t\tretryInterval?: number;\n\t\t\tretainFor?: number;\n\t\t}\n\t): Promise<string>;\n\n\t/**\n\t * Get the task details.\n\t * @param taskId The id of the task to get the details for.\n\t * @returns The details of the task.\n\t */\n\tget<T, U>(taskId: string): Promise<IBackgroundTask<T, U> | undefined>;\n\n\t/**\n\t * Retry a failed task immediately instead of waiting for it's next scheduled retry time.\n\t * @param taskId The id of the task to retry.\n\t * @returns Nothing.\n\t */\n\tretry(taskId: string): Promise<void>;\n\n\t/**\n\t * Remove a task ignoring any retain until date.\n\t * @param taskId The id of the task to remove.\n\t * @returns Nothing.\n\t */\n\tremove(taskId: string): Promise<void>;\n\n\t/**\n\t * Cancel a task, will only be actioned if the task is currently pending.\n\t * @param taskId The id of the task to cancel.\n\t * @returns Nothing.\n\t */\n\tcancel(taskId: string): Promise<void>;\n\n\t/**\n\t * Get a list of tasks.\n\t * @param taskType The type of the task to get.\n\t * @param taskStatus The status of the task to get.\n\t * @param sortProperty The property to sort by, defaults to dateCreated.\n\t * @param sortDirection The order to sort by, defaults to ascending.\n\t * @param cursor The cursor to get the next page of tasks.\n\t * @param limit Limit the number of entities to return.\n\t * @returns The list of tasks.\n\t */\n\tquery(\n\t\ttaskType?: string,\n\t\ttaskStatus?: TaskStatus,\n\t\tsortProperty?: \"dateCreated\" | \"dateModified\" | \"dateCompleted\" | \"status\",\n\t\tsortDirection?: SortDirection,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentities: IBackgroundTask[];\n\t\tcursor?: string;\n\t}>;\n}\n"]}

package/dist/es/models/IScheduledTaskInfo.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IScheduledTaskInfo.js.map

package/dist/es/models/IScheduledTaskInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IScheduledTaskInfo.js","sourceRoot":"","sources":["../../../src/models/IScheduledTaskInfo.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IScheduledTaskTime } from \"./IScheduledTaskTime.js\";\n\n/**\n * Interface describing a scheduled task information.\n */\nexport interface IScheduledTaskInfo {\n\t/**\n\t * The information for the tasks.\n\t */\n\ttasks: {\n\t\t[id: string]: IScheduledTaskTime[];\n\t};\n}\n"]}

package/dist/es/models/IScheduledTaskTime.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IScheduledTaskTime.js.map

package/dist/es/models/IScheduledTaskTime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IScheduledTaskTime.js","sourceRoot":"","sources":["../../../src/models/IScheduledTaskTime.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface describing a scheduled task time.\n */\nexport interface IScheduledTaskTime {\n\t/**\n\t * The date/time to start the task, if not provided defaults to first interval from now.\n\t */\n\tnextTriggerTime?: number;\n\n\t/**\n\t * The interval in days to repeat the task, if no intervals are set the task will not repeat.\n\t */\n\tintervalDays?: number;\n\n\t/**\n\t * The interval in hours to repeat the task, if no intervals are set the task will not repeat.\n\t */\n\tintervalHours?: number;\n\n\t/**\n\t * The interval in minutes to repeat the task, if no intervals are set the task will not repeat.\n\t */\n\tintervalMinutes?: number;\n}\n"]}

package/dist/es/models/ITaskSchedulerComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ITaskSchedulerComponent.js.map

package/dist/es/models/ITaskSchedulerComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ITaskSchedulerComponent.js","sourceRoot":"","sources":["../../../src/models/ITaskSchedulerComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IScheduledTaskInfo } from \"./IScheduledTaskInfo.js\";\nimport type { IScheduledTaskTime } from \"./IScheduledTaskTime.js\";\n\n/**\n * Interface describing a task scheduler.\n */\nexport interface ITaskSchedulerComponent extends IComponent {\n\t/**\n\t * Add a task to the scheduler.\n\t * @param taskId The id of the task to add.\n\t * @param times The times at which the task should be scheduled.\n\t * @param taskCallback The callback to execute when the task is scheduled.\n\t * @returns Nothing.\n\t */\n\taddTask(\n\t\ttaskId: string,\n\t\ttimes: IScheduledTaskTime[],\n\t\ttaskCallback: () => Promise<void>\n\t): Promise<void>;\n\n\t/**\n\t * Remove a task from the scheduler.\n\t * @param taskId The id of the task to remove.\n\t * @returns Nothing.\n\t */\n\tremoveTask(taskId: string): Promise<void>;\n\n\t/**\n\t * Get the information about the tasks.\n\t * @returns The tasks information.\n\t */\n\ttasksInfo(): Promise<IScheduledTaskInfo>;\n}\n"]}

package/dist/{esm/index.mjs → es/models/taskStatus.js}

@@ -1,20 +1,10 @@
-import { Factory } from '@twin.org/core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating background task connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BackgroundTaskConnectorFactory = Factory.createFactory("background-task");
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
  * Task statuses.
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const TaskStatus = {
+export const TaskStatus = {
     /**
      * Pending.
      */
@@ -36,5 +26,4 @@ const TaskStatus = {
      */
     Cancelled: "cancelled"
 };
-
-export { BackgroundTaskConnectorFactory, TaskStatus };
+//# sourceMappingURL=taskStatus.js.map

package/dist/es/models/taskStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskStatus.js","sourceRoot":"","sources":["../../../src/models/taskStatus.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,UAAU,EAAE,YAAY;IAExB;;OAEG;IACH,OAAO,EAAE,SAAS;IAElB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,SAAS,EAAE,WAAW;CACb,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Task statuses.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const TaskStatus = {\n\t/**\n\t * Pending.\n\t */\n\tPending: \"pending\",\n\n\t/**\n\t * Processing.\n\t */\n\tProcessing: \"processing\",\n\n\t/**\n\t * Success.\n\t */\n\tSuccess: \"success\",\n\n\t/**\n\t * Failed.\n\t */\n\tFailed: \"failed\",\n\n\t/**\n\t * Cancelled.\n\t */\n\tCancelled: \"cancelled\"\n} as const;\n\n/**\n * Task statuses.\n */\nexport type TaskStatus = (typeof TaskStatus)[keyof typeof TaskStatus];\n"]}

package/dist/types/index.d.ts

@@ -1,7 +1,6 @@
-export * from "./factories/backgroundTaskConnectorFactory";
-export * from "./models/IBackgroundTask";
-export * from "./models/IBackgroundTaskConnector";
-export * from "./models/IScheduledTaskInfo";
-export * from "./models/IScheduledTaskTime";
-export * from "./models/ITaskSchedulerComponent";
-export * from "./models/taskStatus";
+export * from "./models/IBackgroundTask.js";
+export * from "./models/IBackgroundTaskComponent.js";
+export * from "./models/IScheduledTaskInfo.js";
+export * from "./models/IScheduledTaskTime.js";
+export * from "./models/ITaskSchedulerComponent.js";
+export * from "./models/taskStatus.js";

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

@@ -1,5 +1,5 @@
 import type { IError } from "@twin.org/core";
-import type { TaskStatus } from "./taskStatus";
+import type { TaskStatus } from "./taskStatus.js";
 /**
  * Interface describing a background task.
  */

package/dist/types/models/{IBackgroundTaskConnector.d.ts → IBackgroundTaskComponent.d.ts}

@@ -1,20 +1,30 @@
 import type { IComponent } from "@twin.org/core";
 import type { SortDirection } from "@twin.org/entity";
-import type { IBackgroundTask } from "./IBackgroundTask";
-import type { TaskStatus } from "./taskStatus";
+import type { IBackgroundTask } from "./IBackgroundTask.js";
+import type { TaskStatus } from "./taskStatus.js";
 /**
- * Interface describing a background task connector.
+ * Interface describing a background task component.
  */
-export interface IBackgroundTaskConnector extends IComponent {
+export interface IBackgroundTaskComponent extends IComponent {
     /**
      * Register a handler for a task.
      * @param taskType The type of the task the handler can process.
      * @param module The module the handler is in.
      * @param method The method in the module to execute.
      * @param stateChangeCallback The callback to execute when the task state is updated.
+     * @param options Additional options for the task.
+     * @param options.maxWorkerCount The maximum number of workers in the pool.
+     * @param options.idleShutdownTimeout Terminate the worker after it has been idle for the specified timeout in milliseconds, defaults to 0 shutdown immediately, -1 to keep forever.
+     * @param options.initialiseMethod The initialisation method to call on the module when a worker is started.
+     * @param options.shutdownMethod The shutdown method to call on the module when a worker is stopped.
      * @returns Nothing.
      */
-    registerHandler<T, U>(taskType: string, module: string, method: string, stateChangeCallback?: (task: IBackgroundTask<T, U>) => Promise<void>): Promise<void>;
+    registerHandler<T, U>(taskType: string, module: string, method: string, stateChangeCallback?: (task: IBackgroundTask<T, U>) => Promise<void>, options?: {
+        maxWorkerCount?: number;
+        idleShutdownTimeout?: number;
+        initialiseMethod?: string;
+        shutdownMethod?: string;
+    }): Promise<void>;
     /**
      * Unregister a handler for a task.
      * @param taskType The type of the task handler to remove.
@@ -23,7 +33,7 @@ export interface IBackgroundTaskConnector extends IComponent {
     unregisterHandler(taskType: string): Promise<void>;
     /**
      * Create a new task.
-     * @param type The type of the task.
+     * @param taskType The type of the task.
      * @param payload The payload for the task.
      * @param options Additional options for the task.
      * @param options.retryCount The number of times to retry the task if it fails, leave undefined to retry forever.
@@ -31,7 +41,7 @@ export interface IBackgroundTaskConnector extends IComponent {
      * @param options.retainFor The amount of time in milliseconds to retain the result until removal, defaults to 0 for immediate removal, set to -1 to keep forever.
      * @returns The id of the created task.
      */
-    create<T>(type: string, payload?: T, options?: {
+    create<T>(taskType: string, payload?: T, options?: {
         retryCount?: number;
         retryInterval?: number;
         retainFor?: number;

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

@@ -1,4 +1,4 @@
-import type { IScheduledTaskTime } from "./IScheduledTaskTime";
+import type { IScheduledTaskTime } from "./IScheduledTaskTime.js";
 /**
  * Interface describing a scheduled task information.
  */

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
-import type { IScheduledTaskInfo } from "./IScheduledTaskInfo";
-import type { IScheduledTaskTime } from "./IScheduledTaskTime";
+import type { IScheduledTaskInfo } from "./IScheduledTaskInfo.js";
+import type { IScheduledTaskTime } from "./IScheduledTaskTime.js";
 /**
  * Interface describing a task scheduler.
  */

package/docs/changelog.md

@@ -1,148 +1,239 @@
-# @twin.org/background-task-models - Changelog
+# Changelog
 
-## [0.0.2-next.9](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.8...background-task-models-v0.0.2-next.9) (2025-10-09)
+## [0.0.3-next.10](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.9...background-task-models-v0.0.3-next.10) (2026-06-09)
+
+
+### Miscellaneous Chores
+
+* **background-task-models:** Synchronize repo versions
+
+## [0.0.3-next.9](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.8...background-task-models-v0.0.3-next.9) (2026-06-08)
+
+
+### Features
+
+* add context id features ([#29](https://github.com/iotaledger/twin-background-task/issues/29)) ([46ede49](https://github.com/iotaledger/twin-background-task/commit/46ede49a51a4955fe1530e645a66f0073db9a1fd))
+* add multi-threading ([#32](https://github.com/iotaledger/twin-background-task/issues/32)) ([60fb5ef](https://github.com/iotaledger/twin-background-task/commit/60fb5ef55d3f7dc46a27c38d4497812d80b98e3b))
+* add task scheduler ([754d973](https://github.com/iotaledger/twin-background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* add validate-locales ([968cbf9](https://github.com/iotaledger/twin-background-task/commit/968cbf966fffb5060305e8b221fecc0b6c8105b9))
+* eslint migration to flat config ([6c9136c](https://github.com/iotaledger/twin-background-task/commit/6c9136c37bccdbbd109892d1503660aab7080d49))
+* improve comment ([f2b4ac2](https://github.com/iotaledger/twin-background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+* only run tasks from your own thread ([c7d305b](https://github.com/iotaledger/twin-background-task/commit/c7d305b9807e65b8b1af6d0c2ca59e74190cab69))
+* typescript 6 update ([e3f2727](https://github.com/iotaledger/twin-background-task/commit/e3f272783e0de7cf4d31f3e84a8e6f5ff633961b))
+* update dependencies ([0867e02](https://github.com/iotaledger/twin-background-task/commit/0867e02fc3c034f8e8cf5918ac6cc4e6b5ca0c93))
+* update dependencies ([8e65767](https://github.com/iotaledger/twin-background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
+* update framework core ([a068098](https://github.com/iotaledger/twin-background-task/commit/a0680983d7923a1bfb980a67879019bb870ccc5d))
+* update IComponent signatures ([e1a79bc](https://github.com/iotaledger/twin-background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-background-task/issues/6)) ([27ed203](https://github.com/iotaledger/twin-background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.7...background-task-models-v0.0.3-next.8) (2026-06-08)
+
+
+### Miscellaneous Chores
+
+* **background-task-models:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.6...background-task-models-v0.0.3-next.7) (2026-05-20)
+
+
+### Features
+
+* update dependencies ([0867e02](https://github.com/iotaledger/twin-background-task/commit/0867e02fc3c034f8e8cf5918ac6cc4e6b5ca0c93))
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.5...background-task-models-v0.0.3-next.6) (2026-05-11)
+
+
+### Features
+
+* typescript 6 update ([e3f2727](https://github.com/iotaledger/twin-background-task/commit/e3f272783e0de7cf4d31f3e84a8e6f5ff633961b))
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.4...background-task-models-v0.0.3-next.5) (2026-04-10)
+
+
+### Miscellaneous Chores
+
+* **background-task-models:** Synchronize repo versions
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.3...background-task-models-v0.0.3-next.4) (2026-02-23)
+
+
+### Miscellaneous Chores
+
+* **background-task-models:** Synchronize repo versions
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.2...background-task-models-v0.0.3-next.3) (2026-01-07)
+
+
+### Miscellaneous Chores
+
+* **background-task-models:** Synchronize repo versions
+
+## [0.0.3-next.2](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.1...background-task-models-v0.0.3-next.2) (2025-11-28)
+
+
+### Features
+
+* add multi-threading ([#32](https://github.com/iotaledger/twin-background-task/issues/32)) ([60fb5ef](https://github.com/iotaledger/twin-background-task/commit/60fb5ef55d3f7dc46a27c38d4497812d80b98e3b))
+
+## [0.0.3-next.1](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.3-next.0...background-task-models-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add context id features ([#29](https://github.com/iotaledger/twin-background-task/issues/29)) ([46ede49](https://github.com/iotaledger/twin-background-task/commit/46ede49a51a4955fe1530e645a66f0073db9a1fd))
+* add task scheduler ([754d973](https://github.com/iotaledger/twin-background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* add validate-locales ([968cbf9](https://github.com/iotaledger/twin-background-task/commit/968cbf966fffb5060305e8b221fecc0b6c8105b9))
+* eslint migration to flat config ([6c9136c](https://github.com/iotaledger/twin-background-task/commit/6c9136c37bccdbbd109892d1503660aab7080d49))
+* improve comment ([f2b4ac2](https://github.com/iotaledger/twin-background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+* only run tasks from your own thread ([c7d305b](https://github.com/iotaledger/twin-background-task/commit/c7d305b9807e65b8b1af6d0c2ca59e74190cab69))
+* update dependencies ([8e65767](https://github.com/iotaledger/twin-background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
+* update framework core ([a068098](https://github.com/iotaledger/twin-background-task/commit/a0680983d7923a1bfb980a67879019bb870ccc5d))
+* update IComponent signatures ([e1a79bc](https://github.com/iotaledger/twin-background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-background-task/issues/6)) ([27ed203](https://github.com/iotaledger/twin-background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+
+## [0.0.2-next.9](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.8...background-task-models-v0.0.2-next.9) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([968cbf9](https://github.com/twinfoundation/background-task/commit/968cbf966fffb5060305e8b221fecc0b6c8105b9))
+* add validate-locales ([968cbf9](https://github.com/iotaledger/twin-background-task/commit/968cbf966fffb5060305e8b221fecc0b6c8105b9))
 
-## [0.0.2-next.8](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.7...background-task-models-v0.0.2-next.8) (2025-09-29)
+## [0.0.2-next.8](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.7...background-task-models-v0.0.2-next.8) (2025-09-29)
 
 
 ### Features
 
-* update IComponent signatures ([e1a79bc](https://github.com/twinfoundation/background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
+* update IComponent signatures ([e1a79bc](https://github.com/iotaledger/twin-background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
 
-## [0.0.2-next.7](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.6...background-task-models-v0.0.2-next.7) (2025-08-29)
+## [0.0.2-next.7](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.6...background-task-models-v0.0.2-next.7) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([6c9136c](https://github.com/twinfoundation/background-task/commit/6c9136c37bccdbbd109892d1503660aab7080d49))
+* eslint migration to flat config ([6c9136c](https://github.com/iotaledger/twin-background-task/commit/6c9136c37bccdbbd109892d1503660aab7080d49))
 
-## [0.0.2-next.6](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.5...background-task-models-v0.0.2-next.6) (2025-08-22)
+## [0.0.2-next.6](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.5...background-task-models-v0.0.2-next.6) (2025-08-22)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.2-next.5](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.4...background-task-models-v0.0.2-next.5) (2025-08-20)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.4...background-task-models-v0.0.2-next.5) (2025-08-20)
 
 
 ### Features
 
-* update framework core ([a068098](https://github.com/twinfoundation/background-task/commit/a0680983d7923a1bfb980a67879019bb870ccc5d))
+* update framework core ([a068098](https://github.com/iotaledger/twin-background-task/commit/a0680983d7923a1bfb980a67879019bb870ccc5d))
 
-## [0.0.2-next.4](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.3...background-task-models-v0.0.2-next.4) (2025-07-23)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.3...background-task-models-v0.0.2-next.4) (2025-07-23)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.2-next.3](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.2...background-task-models-v0.0.2-next.3) (2025-07-21)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.2...background-task-models-v0.0.2-next.3) (2025-07-21)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.2-next.2](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.1...background-task-models-v0.0.2-next.2) (2025-07-09)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.1...background-task-models-v0.0.2-next.2) (2025-07-09)
 
 
 ### Features
 
-* add task scheduler ([754d973](https://github.com/twinfoundation/background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
-* improve comment ([f2b4ac2](https://github.com/twinfoundation/background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
-* only run tasks from your own thread ([c7d305b](https://github.com/twinfoundation/background-task/commit/c7d305b9807e65b8b1af6d0c2ca59e74190cab69))
-* update dependencies ([8e65767](https://github.com/twinfoundation/background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
-* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+* add task scheduler ([754d973](https://github.com/iotaledger/twin-background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* improve comment ([f2b4ac2](https://github.com/iotaledger/twin-background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+* only run tasks from your own thread ([c7d305b](https://github.com/iotaledger/twin-background-task/commit/c7d305b9807e65b8b1af6d0c2ca59e74190cab69))
+* update dependencies ([8e65767](https://github.com/iotaledger/twin-background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-background-task/issues/6)) ([27ed203](https://github.com/iotaledger/twin-background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
 
-## [0.0.2-next.1](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.2-next.0...background-task-models-v0.0.2-next.1) (2025-07-09)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.2-next.0...background-task-models-v0.0.2-next.1) (2025-07-09)
 
 
 ### Features
 
-* add task scheduler ([754d973](https://github.com/twinfoundation/background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
-* improve comment ([f2b4ac2](https://github.com/twinfoundation/background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
-* only run tasks from your own thread ([c7d305b](https://github.com/twinfoundation/background-task/commit/c7d305b9807e65b8b1af6d0c2ca59e74190cab69))
-* update dependencies ([8e65767](https://github.com/twinfoundation/background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
-* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+* add task scheduler ([754d973](https://github.com/iotaledger/twin-background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* improve comment ([f2b4ac2](https://github.com/iotaledger/twin-background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+* only run tasks from your own thread ([c7d305b](https://github.com/iotaledger/twin-background-task/commit/c7d305b9807e65b8b1af6d0c2ca59e74190cab69))
+* update dependencies ([8e65767](https://github.com/iotaledger/twin-background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-background-task/issues/6)) ([27ed203](https://github.com/iotaledger/twin-background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
 
 ## 0.0.1 (2025-07-07)
 
 
 ### Features
 
-* release to production ([7ce9896](https://github.com/twinfoundation/background-task/commit/7ce989659e6819f05655c86b1bda2a265af5d281))
+* release to production ([7ce9896](https://github.com/iotaledger/twin-background-task/commit/7ce989659e6819f05655c86b1bda2a265af5d281))
 
-## [0.0.1-next.21](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.20...background-task-models-v0.0.1-next.21) (2025-06-23)
+## [0.0.1-next.21](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.20...background-task-models-v0.0.1-next.21) (2025-06-23)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.1-next.20](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.19...background-task-models-v0.0.1-next.20) (2025-06-23)
+## [0.0.1-next.20](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.19...background-task-models-v0.0.1-next.20) (2025-06-23)
 
 
 ### Features
 
-* add task scheduler ([754d973](https://github.com/twinfoundation/background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
-* improve comment ([f2b4ac2](https://github.com/twinfoundation/background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
-* update dependencies ([8e65767](https://github.com/twinfoundation/background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
-* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+* add task scheduler ([754d973](https://github.com/iotaledger/twin-background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* improve comment ([f2b4ac2](https://github.com/iotaledger/twin-background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+* update dependencies ([8e65767](https://github.com/iotaledger/twin-background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-background-task/issues/6)) ([27ed203](https://github.com/iotaledger/twin-background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
 
-## [0.0.1-next.19](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.18...background-task-models-v0.0.1-next.19) (2025-06-23)
+## [0.0.1-next.19](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.18...background-task-models-v0.0.1-next.19) (2025-06-23)
 
 
 ### Features
 
-* add task scheduler ([754d973](https://github.com/twinfoundation/background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* add task scheduler ([754d973](https://github.com/iotaledger/twin-background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
 
-## [0.0.1-next.18](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.17...background-task-models-v0.0.1-next.18) (2025-06-19)
+## [0.0.1-next.18](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.17...background-task-models-v0.0.1-next.18) (2025-06-19)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.1-next.17](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.16...background-task-models-v0.0.1-next.17) (2025-06-12)
+## [0.0.1-next.17](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.16...background-task-models-v0.0.1-next.17) (2025-06-12)
 
 
 ### Features
 
-* update dependencies ([8e65767](https://github.com/twinfoundation/background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
+* update dependencies ([8e65767](https://github.com/iotaledger/twin-background-task/commit/8e657679f5e4305dbcb15ac7bcb3ab8a4613a60b))
 
-## [0.0.1-next.16](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.15...background-task-models-v0.0.1-next.16) (2025-06-05)
+## [0.0.1-next.16](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.15...background-task-models-v0.0.1-next.16) (2025-06-05)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.1-next.15](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.14...background-task-models-v0.0.1-next.15) (2025-04-17)
+## [0.0.1-next.15](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.14...background-task-models-v0.0.1-next.15) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-background-task/issues/6)) ([27ed203](https://github.com/iotaledger/twin-background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
 
-## [0.0.1-next.14](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.13...background-task-models-v0.0.1-next.14) (2025-04-11)
+## [0.0.1-next.14](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.13...background-task-models-v0.0.1-next.14) (2025-04-11)
 
 
 ### Miscellaneous Chores
 
 * **background-task-models:** Synchronize repo versions
 
-## [0.0.1-next.13](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.1-next.12...background-task-models-v0.0.1-next.13) (2025-03-28)
+## [0.0.1-next.13](https://github.com/iotaledger/twin-background-task/compare/background-task-models-v0.0.1-next.12...background-task-models-v0.0.1-next.13) (2025-03-28)
 
 
 ### Features
 
-* improve comment ([f2b4ac2](https://github.com/twinfoundation/background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+* improve comment ([f2b4ac2](https://github.com/iotaledger/twin-background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
 
 ## v0.0.1-next.12
 

package/docs/examples.md

@@ -1 +1,179 @@
-# @twin.org/background-task-models - Examples
+# Background Task Models Examples
+
+Use these snippets to model task payloads, status transitions and scheduler contracts in a strongly typed way.
+
+## IBackgroundTask
+
+```typescript
+import type { IBackgroundTask } from '@twin.org/background-task-models';
+import { TaskStatus } from '@twin.org/background-task-models';
+
+type ImportPayload = {
+  source: string;
+  batchSize: number;
+};
+
+type ImportResult = {
+  inserted: number;
+  skipped: number;
+};
+
+const queuedTask: IBackgroundTask<ImportPayload, ImportResult> = {
+  id: '7f4b2c18a4f44f1f9ff7348e260ca4c2',
+  type: 'catalogue-import',
+  threadId: '0',
+  dateCreated: '2026-03-09T10:30:00.000Z',
+  dateModified: '2026-03-09T10:30:00.000Z',
+  status: TaskStatus.Pending,
+  payload: {
+    source: 'tenant-a',
+    batchSize: 250
+  },
+  retriesRemaining: 3,
+  retryInterval: 5000
+};
+
+console.log(queuedTask.status); // pending
+```
+
+```typescript
+import type { IBackgroundTask } from '@twin.org/background-task-models';
+import { TaskStatus } from '@twin.org/background-task-models';
+
+type ImportResult = {
+  inserted: number;
+  skipped: number;
+};
+
+const completedTask: IBackgroundTask<unknown, ImportResult> = {
+  id: '7f4b2c18a4f44f1f9ff7348e260ca4c2',
+  type: 'catalogue-import',
+  threadId: '3',
+  dateCreated: '2026-03-09T10:30:00.000Z',
+  dateModified: '2026-03-09T10:31:22.000Z',
+  dateCompleted: '2026-03-09T10:31:22.000Z',
+  status: TaskStatus.Success,
+  result: {
+    inserted: 248,
+    skipped: 2
+  }
+};
+
+console.log(completedTask.result?.inserted); // 248
+```
+
+## IBackgroundTaskComponent
+
+```typescript
+import type { IBackgroundTask, IBackgroundTaskComponent } from '@twin.org/background-task-models';
+import { TaskStatus } from '@twin.org/background-task-models';
+
+type ResizePayload = {
+  imageId: string;
+  width: number;
+  height: number;
+};
+
+type ResizeResult = {
+  imageId: string;
+  location: string;
+};
+
+export async function configureImageHandler(
+  taskComponent: IBackgroundTaskComponent
+): Promise<void> {
+  await taskComponent.registerHandler<ResizePayload, ResizeResult>(
+    'image-resize',
+    './workers/imageWorker',
+    'resize',
+    async (task: IBackgroundTask<ResizePayload, ResizeResult>) => {
+      if (task.status === TaskStatus.Success) {
+        console.log(task.result?.location); // s3://tenant-a/images/hero-1920x1080.webp
+      }
+    },
+    {
+      maxWorkerCount: 4,
+      idleShutdownTimeout: 60000,
+      initialiseMethod: 'initialise',
+      shutdownMethod: 'shutdown'
+    }
+  );
+
+  const taskId = await taskComponent.create<ResizePayload>(
+    'image-resize',
+    {
+      imageId: 'hero',
+      width: 1920,
+      height: 1080
+    },
+    {
+      retryCount: 2,
+      retryInterval: 3000,
+      retainFor: 120000
+    }
+  );
+
+  const task = await taskComponent.get<ResizePayload, ResizeResult>(taskId);
+  console.log(task?.status); // pending
+}
+```
+
+## ITaskSchedulerComponent
+
+```typescript
+import type { ITaskSchedulerComponent } from '@twin.org/background-task-models';
+
+export async function registerDailySync(
+  scheduler: ITaskSchedulerComponent,
+  syncTaskId: string
+): Promise<void> {
+  await scheduler.addTask(
+    syncTaskId,
+    [
+      {
+        nextTriggerTime: Date.now() + 15 * 60 * 1000,
+        intervalDays: 1
+      }
+    ],
+    async () => {
+      console.log('sync running at', new Date().toISOString()); // sync running at 2026-03-09T10:45:00.000Z
+    }
+  );
+
+  const info = await scheduler.tasksInfo();
+  console.log(info.tasks[syncTaskId].length); // 1
+}
+```
+
+## IScheduledTaskInfo and IScheduledTaskTime
+
+```typescript
+import type { IScheduledTaskInfo, IScheduledTaskTime } from '@twin.org/background-task-models';
+
+const everyQuarterHour: IScheduledTaskTime = {
+  intervalMinutes: 15
+};
+
+const schedule: IScheduledTaskInfo = {
+  tasks: {
+    'cleanup-cache': [everyQuarterHour]
+  }
+};
+
+console.log(schedule.tasks['cleanup-cache'][0].intervalMinutes); // 15
+```
+
+## TaskStatus
+
+```typescript
+import type { TaskStatus } from '@twin.org/background-task-models';
+import { TaskStatus as TaskStatuses } from '@twin.org/background-task-models';
+
+const terminalStatuses: TaskStatus[] = [
+  TaskStatuses.Success,
+  TaskStatuses.Failed,
+  TaskStatuses.Cancelled
+];
+
+console.log(terminalStatuses.join(', ')); // success, failed, cancelled
+```

package/docs/reference/index.md

@@ -3,7 +3,7 @@
 ## Interfaces
 
 - [IBackgroundTask](interfaces/IBackgroundTask.md)
-- [IBackgroundTaskConnector](interfaces/IBackgroundTaskConnector.md)
+- [IBackgroundTaskComponent](interfaces/IBackgroundTaskComponent.md)
 - [IScheduledTaskInfo](interfaces/IScheduledTaskInfo.md)
 - [IScheduledTaskTime](interfaces/IScheduledTaskTime.md)
 - [ITaskSchedulerComponent](interfaces/ITaskSchedulerComponent.md)
@@ -14,5 +14,4 @@
 
 ## Variables
 
-- [BackgroundTaskConnectorFactory](variables/BackgroundTaskConnectorFactory.md)
 - [TaskStatus](variables/TaskStatus.md)

package/docs/reference/interfaces/IBackgroundTask.md

@@ -14,7 +14,7 @@ Interface describing a background task.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,7 +22,7 @@ The id.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `string`
 
@@ -30,7 +30,7 @@ The type of the task.
 
 ***
 
-### threadId
+### threadId {#threadid}
 
 > **threadId**: `string`
 
@@ -38,23 +38,23 @@ The thread id for the task.
 
 ***
 
-### retryInterval?
+### retryInterval? {#retryinterval}
 
-> `optional` **retryInterval**: `number`
+> `optional` **retryInterval?**: `number`
 
 The retry interval in milliseconds, undefined if default scheduling.
 
 ***
 
-### retriesRemaining?
+### retriesRemaining? {#retriesremaining}
 
-> `optional` **retriesRemaining**: `number`
+> `optional` **retriesRemaining?**: `number`
 
 The number of retries remaining, undefined if infinite retries.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -62,7 +62,7 @@ The date the task was created.
 
 ***
 
-### dateModified
+### dateModified {#datemodified}
 
 > **dateModified**: `string`
 
@@ -70,31 +70,31 @@ The date the task was last modified.
 
 ***
 
-### dateCompleted?
+### dateCompleted? {#datecompleted}
 
-> `optional` **dateCompleted**: `string`
+> `optional` **dateCompleted?**: `string`
 
 The date the task was complete.
 
 ***
 
-### dateCancelled?
+### dateCancelled? {#datecancelled}
 
-> `optional` **dateCancelled**: `string`
+> `optional` **dateCancelled?**: `string`
 
 The date the task was cancelled.
 
 ***
 
-### dateRetainUntil?
+### dateRetainUntil? {#dateretainuntil}
 
-> `optional` **dateRetainUntil**: `string`
+> `optional` **dateRetainUntil?**: `string`
 
 The date until when to retain.
 
 ***
 
-### status
+### status {#status}
 
 > **status**: [`TaskStatus`](../type-aliases/TaskStatus.md)
 
@@ -102,24 +102,24 @@ The status of the task.
 
 ***
 
-### payload?
+### payload? {#payload}
 
-> `optional` **payload**: `T`
+> `optional` **payload?**: `T`
 
 The payload to execute the task with.
 
 ***
 
-### result?
+### result? {#result}
 
-> `optional` **result**: `U`
+> `optional` **result?**: `U`
 
 The result of the execution.
 
 ***
 
-### error?
+### error? {#error}
 
-> `optional` **error**: `IError`
+> `optional` **error?**: `IError`
 
 The error at last execution.

package/docs/reference/interfaces/{IBackgroundTaskConnector.md → IBackgroundTaskComponent.md}

@@ -1,24 +1,16 @@
-# Interface: IBackgroundTaskConnector
+# Interface: IBackgroundTaskComponent
 
-Interface describing a background task connector.
+Interface describing a background task component.
 
 ## Extends
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
-### registerHandler()
+### registerHandler() {#registerhandler}
 
-> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback?`): `Promise`\<`void`\>
+> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback?`, `options?`): `Promise`\<`void`\>
 
 Register a handler for a task.
 
@@ -58,6 +50,34 @@ The method in the module to execute.
 
 The callback to execute when the task state is updated.
 
+##### options?
+
+Additional options for the task.
+
+###### maxWorkerCount?
+
+`number`
+
+The maximum number of workers in the pool.
+
+###### idleShutdownTimeout?
+
+`number`
+
+Terminate the worker after it has been idle for the specified timeout in milliseconds, defaults to 0 shutdown immediately, -1 to keep forever.
+
+###### initialiseMethod?
+
+`string`
+
+The initialisation method to call on the module when a worker is started.
+
+###### shutdownMethod?
+
+`string`
+
+The shutdown method to call on the module when a worker is stopped.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -66,7 +86,7 @@ Nothing.
 
 ***
 
-### unregisterHandler()
+### unregisterHandler() {#unregisterhandler}
 
 > **unregisterHandler**(`taskType`): `Promise`\<`void`\>
 
@@ -88,9 +108,9 @@ Nothing.
 
 ***
 
-### create()
+### create() {#create}
 
-> **create**\<`T`\>(`type`, `payload?`, `options?`): `Promise`\<`string`\>
+> **create**\<`T`\>(`taskType`, `payload?`, `options?`): `Promise`\<`string`\>
 
 Create a new task.
 
@@ -102,7 +122,7 @@ Create a new task.
 
 #### Parameters
 
-##### type
+##### taskType
 
 `string`
 
@@ -144,9 +164,9 @@ The id of the created task.
 
 ***
 
-### get()
+### get() {#get}
 
-> **get**\<`T`, `U`\>(`taskId`): `Promise`\<`undefined` \| [`IBackgroundTask`](IBackgroundTask.md)\<`T`, `U`\>\>
+> **get**\<`T`, `U`\>(`taskId`): `Promise`\<[`IBackgroundTask`](IBackgroundTask.md)\<`T`, `U`\> \| `undefined`\>
 
 Get the task details.
 
@@ -170,13 +190,13 @@ The id of the task to get the details for.
 
 #### Returns
 
-`Promise`\<`undefined` \| [`IBackgroundTask`](IBackgroundTask.md)\<`T`, `U`\>\>
+`Promise`\<[`IBackgroundTask`](IBackgroundTask.md)\<`T`, `U`\> \| `undefined`\>
 
 The details of the task.
 
 ***
 
-### retry()
+### retry() {#retry}
 
 > **retry**(`taskId`): `Promise`\<`void`\>
 
@@ -198,7 +218,7 @@ Nothing.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`taskId`): `Promise`\<`void`\>
 
@@ -220,7 +240,7 @@ Nothing.
 
 ***
 
-### cancel()
+### cancel() {#cancel}
 
 > **cancel**(`taskId`): `Promise`\<`void`\>
 
@@ -242,7 +262,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
 
@@ -264,9 +284,9 @@ The status of the task to get.
 
 ##### sortProperty?
 
-The property to sort by, defaults to dateCreated.
+`"dateCreated"` \| `"dateModified"` \| `"dateCompleted"` \| `"status"`
 
-`"dateCreated"` | `"dateModified"` | `"dateCompleted"` | `"status"`
+The property to sort by, defaults to dateCreated.
 
 ##### sortDirection?
 

package/docs/reference/interfaces/IScheduledTaskInfo.md

@@ -4,7 +4,7 @@ Interface describing a scheduled task information.
 
 ## Properties
 
-### tasks
+### tasks {#tasks}
 
 > **tasks**: `object`
 

package/docs/reference/interfaces/IScheduledTaskTime.md

@@ -4,32 +4,32 @@ Interface describing a scheduled task time.
 
 ## Properties
 
-### nextTriggerTime?
+### nextTriggerTime? {#nexttriggertime}
 
-> `optional` **nextTriggerTime**: `number`
+> `optional` **nextTriggerTime?**: `number`
 
 The date/time to start the task, if not provided defaults to first interval from now.
 
 ***
 
-### intervalDays?
+### intervalDays? {#intervaldays}
 
-> `optional` **intervalDays**: `number`
+> `optional` **intervalDays?**: `number`
 
 The interval in days to repeat the task, if no intervals are set the task will not repeat.
 
 ***
 
-### intervalHours?
+### intervalHours? {#intervalhours}
 
-> `optional` **intervalHours**: `number`
+> `optional` **intervalHours?**: `number`
 
 The interval in hours to repeat the task, if no intervals are set the task will not repeat.
 
 ***
 
-### intervalMinutes?
+### intervalMinutes? {#intervalminutes}
 
-> `optional` **intervalMinutes**: `number`
+> `optional` **intervalMinutes?**: `number`
 
 The interval in minutes to repeat the task, if no intervals are set the task will not repeat.

package/docs/reference/interfaces/ITaskSchedulerComponent.md

@@ -6,17 +6,9 @@ Interface describing a task scheduler.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
-### addTask()
+### addTask() {#addtask}
 
 > **addTask**(`taskId`, `times`, `taskCallback`): `Promise`\<`void`\>
 
@@ -50,7 +42,7 @@ Nothing.
 
 ***
 
-### removeTask()
+### removeTask() {#removetask}
 
 > **removeTask**(`taskId`): `Promise`\<`void`\>
 
@@ -72,7 +64,7 @@ Nothing.
 
 ***
 
-### tasksInfo()
+### tasksInfo() {#tasksinfo}
 
 > **tasksInfo**(): `Promise`\<[`IScheduledTaskInfo`](IScheduledTaskInfo.md)\>
 

package/docs/reference/variables/TaskStatus.md

@@ -6,31 +6,31 @@ Task statuses.
 
 ## Type Declaration
 
-### Pending
+### Pending {#pending}
 
 > `readonly` **Pending**: `"pending"` = `"pending"`
 
 Pending.
 
-### Processing
+### Processing {#processing}
 
 > `readonly` **Processing**: `"processing"` = `"processing"`
 
 Processing.
 
-### Success
+### Success {#success}
 
 > `readonly` **Success**: `"success"` = `"success"`
 
 Success.
 
-### Failed
+### Failed {#failed}
 
 > `readonly` **Failed**: `"failed"` = `"failed"`
 
 Failed.
 
-### Cancelled
+### Cancelled {#cancelled}
 
 > `readonly` **Cancelled**: `"cancelled"` = `"cancelled"`
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.2-next.9",
-	"description": "Models which define the structure of the background task contracts and connectors",
+	"version": "0.0.3-next.10",
+	"description": "Defines shared contracts and status models for background task workflows",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/background-task.git",
+		"url": "git+https://github.com/iotaledger/twin-background-task.git",
 		"directory": "packages/background-task-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -18,20 +18,18 @@
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -52,7 +50,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/background-task/issues"
+		"url": "git+https://github.com/iotaledger/twin-background-task/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,43 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating background task connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BackgroundTaskConnectorFactory = core.Factory.createFactory("background-task");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Task statuses.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const TaskStatus = {
-    /**
-     * Pending.
-     */
-    Pending: "pending",
-    /**
-     * Processing.
-     */
-    Processing: "processing",
-    /**
-     * Success.
-     */
-    Success: "success",
-    /**
-     * Failed.
-     */
-    Failed: "failed",
-    /**
-     * Cancelled.
-     */
-    Cancelled: "cancelled"
-};
-
-exports.BackgroundTaskConnectorFactory = BackgroundTaskConnectorFactory;
-exports.TaskStatus = TaskStatus;

package/dist/types/factories/backgroundTaskConnectorFactory.d.ts

@@ -1,6 +0,0 @@
-import { Factory } from "@twin.org/core";
-import type { IBackgroundTaskConnector } from "../models/IBackgroundTaskConnector";
-/**
- * Factory for creating background task connectors.
- */
-export declare const BackgroundTaskConnectorFactory: Factory<IBackgroundTaskConnector>;

package/docs/reference/variables/BackgroundTaskConnectorFactory.md

@@ -1,5 +0,0 @@
-# Variable: BackgroundTaskConnectorFactory
-
-> `const` **BackgroundTaskConnectorFactory**: `Factory`\<[`IBackgroundTaskConnector`](../interfaces/IBackgroundTaskConnector.md)\>
-
-Factory for creating background task connectors.