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

package/dist/es/factories/backgroundTaskConnectorFactory.js

@@ -0,0 +1,9 @@
+// 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

@@ -0,0 +1 @@
+{"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/index.js

@@ -0,0 +1,10 @@
+// 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/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,+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"]}

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/IBackgroundTaskConnector.js

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

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

@@ -0,0 +1 @@
+{"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/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/factories/backgroundTaskConnectorFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IBackgroundTaskConnector } from "../models/IBackgroundTaskConnector";
+import type { IBackgroundTaskConnector } from "../models/IBackgroundTaskConnector.js";
 /**
  * Factory for creating background task connectors.
  */

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
-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 "./factories/backgroundTaskConnectorFactory.js";
+export * from "./models/IBackgroundTask.js";
+export * from "./models/IBackgroundTaskConnector.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

@@ -1,7 +1,7 @@
 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.
  */
@@ -67,10 +67,10 @@ export interface IBackgroundTaskConnector extends IComponent {
      * @param sortProperty The property to sort by, defaults to dateCreated.
      * @param sortDirection The order to sort by, defaults to ascending.
      * @param cursor The cursor to get the next page of tasks.
-     * @param pageSize The maximum number of entities in a page.
+     * @param limit Limit the number of entities to return.
      * @returns The list of tasks.
      */
-    query(taskType?: string, taskStatus?: TaskStatus, sortProperty?: "dateCreated" | "dateModified" | "dateCompleted" | "status", sortDirection?: SortDirection, cursor?: string, pageSize?: number): Promise<{
+    query(taskType?: string, taskStatus?: TaskStatus, sortProperty?: "dateCreated" | "dateModified" | "dateCompleted" | "status", sortDirection?: SortDirection, cursor?: string, limit?: number): Promise<{
         entities: IBackgroundTask[];
         cursor?: string;
     }>;

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,5 +1,28 @@
 # @twin.org/background-task-models - Changelog
 
+## [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)
+
+
+### Features
+
+* add context id features ([#29](https://github.com/twinfoundation/background-task/issues/29)) ([46ede49](https://github.com/twinfoundation/background-task/commit/46ede49a51a4955fe1530e645a66f0073db9a1fd))
+* add task scheduler ([754d973](https://github.com/twinfoundation/background-task/commit/754d973e7c8483e5e54e887c157661867d5a0375))
+* add validate-locales ([968cbf9](https://github.com/twinfoundation/background-task/commit/968cbf966fffb5060305e8b221fecc0b6c8105b9))
+* eslint migration to flat config ([6c9136c](https://github.com/twinfoundation/background-task/commit/6c9136c37bccdbbd109892d1503660aab7080d49))
+* 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))
+* update framework core ([a068098](https://github.com/twinfoundation/background-task/commit/a0680983d7923a1bfb980a67879019bb870ccc5d))
+* update IComponent signatures ([e1a79bc](https://github.com/twinfoundation/background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
+* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/background-task/commit/27ed20367d5ace7257bfa7a82b59ad70e5b5d209))
+
+## [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)
+
+
+### Features
+
+* add validate-locales ([968cbf9](https://github.com/twinfoundation/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)
 
 

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -138,7 +138,7 @@ The id of the created task.
 
 ### 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.
 
@@ -162,7 +162,7 @@ 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.
 
@@ -236,7 +236,7 @@ Nothing.
 
 ### query()
 
-> **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
+> **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `limit?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
 
 Get a list of tasks.
 
@@ -272,11 +272,11 @@ The order to sort by, defaults to ascending.
 
 The cursor to get the next page of tasks.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The maximum number of entities in a page.
+Limit the number of entities to return.
 
 #### Returns
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.2-next.8",
+	"version": "0.0.3-next.1",
 	"description": "Models which define the structure of the background task contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -18,22 +18,39 @@
 		"@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"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"background-task",
+		"tasks",
+		"scheduling",
+		"jobs",
+		"async",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/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;