@twin.org/background-task-models 0.0.3-next.1 → 0.0.3-next.3

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Background Task Models
 
-Models which define the structure of the background task contracts and connectors.
+Models which define the structure of the background task contracts.
 
 ## Installation
 

package/dist/es/index.js

@@ -1,8 +1,7 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
-export * from "./factories/backgroundTaskConnectorFactory.js";
 export * from "./models/IBackgroundTask.js";
-export * from "./models/IBackgroundTaskConnector.js";
+export * from "./models/IBackgroundTaskComponent.js";
 export * from "./models/IScheduledTaskInfo.js";
 export * from "./models/IScheduledTaskTime.js";
 export * from "./models/ITaskSchedulerComponent.js";

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+CAA+C,CAAC;AAC9D,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 \"./factories/backgroundTaskConnectorFactory.js\";\nexport * from \"./models/IBackgroundTask.js\";\nexport * from \"./models/IBackgroundTaskConnector.js\";\nexport * from \"./models/IScheduledTaskInfo.js\";\nexport * from \"./models/IScheduledTaskTime.js\";\nexport * from \"./models/ITaskSchedulerComponent.js\";\nexport * from \"./models/taskStatus.js\";\n"]}
+{"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/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/types/index.d.ts

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

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

@@ -3,18 +3,28 @@ import type { SortDirection } from "@twin.org/entity";
 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/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/background-task-models - Changelog
 
+## [0.0.3-next.3](https://github.com/twinfoundation/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/twinfoundation/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/twinfoundation/background-task/issues/32)) ([60fb5ef](https://github.com/twinfoundation/background-task/commit/60fb5ef55d3f7dc46a27c38d4497812d80b98e3b))
+
 ## [0.0.3-next.1](https://github.com/twinfoundation/background-task/compare/background-task-models-v0.0.3-next.0...background-task-models-v0.0.3-next.1) (2025-11-11)
 
 

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/{IBackgroundTaskConnector.md → IBackgroundTaskComponent.md}

@@ -1,6 +1,6 @@
-# Interface: IBackgroundTaskConnector
+# Interface: IBackgroundTaskComponent
 
-Interface describing a background task connector.
+Interface describing a background task component.
 
 ## Extends
 
@@ -10,7 +10,7 @@ Interface describing a background task connector.
 
 ### 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.
 
@@ -50,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`\>
@@ -82,7 +110,7 @@ Nothing.
 
 ### create()
 
-> **create**\<`T`\>(`type`, `payload?`, `options?`): `Promise`\<`string`\>
+> **create**\<`T`\>(`taskType`, `payload?`, `options?`): `Promise`\<`string`\>
 
 Create a new task.
 
@@ -94,7 +122,7 @@ Create a new task.
 
 #### Parameters
 
-##### type
+##### taskType
 
 `string`
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.3-next.1",
-	"description": "Models which define the structure of the background task contracts and connectors",
+	"version": "0.0.3-next.3",
+	"description": "Models which define the structure of the background task contracts",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/background-task.git",

package/dist/es/factories/backgroundTaskConnectorFactory.js

@@ -1,9 +0,0 @@
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-import { Factory } from "@twin.org/core";
-/**
- * Factory for creating background task connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export const BackgroundTaskConnectorFactory = Factory.createFactory("background-task");
-//# sourceMappingURL=backgroundTaskConnectorFactory.js.map

package/dist/es/factories/backgroundTaskConnectorFactory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"backgroundTaskConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/backgroundTaskConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAC1C,OAAO,CAAC,aAAa,CAA2B,iBAAiB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IBackgroundTaskConnector } from \"../models/IBackgroundTaskConnector.js\";\n\n/**\n * Factory for creating background task connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const BackgroundTaskConnectorFactory =\n\tFactory.createFactory<IBackgroundTaskConnector>(\"background-task\");\n"]}

package/dist/es/models/IBackgroundTaskConnector.js

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"IBackgroundTaskConnector.js","sourceRoot":"","sources":["../../../src/models/IBackgroundTaskConnector.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 connector.\n */\nexport interface IBackgroundTaskConnector 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 * @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): 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 type 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\ttype: 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/types/factories/backgroundTaskConnectorFactory.d.ts

@@ -1,6 +0,0 @@
-import { Factory } from "@twin.org/core";
-import type { IBackgroundTaskConnector } from "../models/IBackgroundTaskConnector.js";
-/**
- * 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.