@twin.org/background-task-models 0.0.1-next.8 → 0.0.1

package/dist/types/index.d.ts

@@ -1,4 +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";

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

@@ -1,7 +1,7 @@
 import type { IError } from "@twin.org/core";
 import type { TaskStatus } from "./taskStatus";
 /**
- * Interface describing a background task connector.
+ * Interface describing a background task.
  */
 export interface IBackgroundTask<T = any, U = any> {
     /**

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

@@ -0,0 +1,12 @@
+import type { IScheduledTaskTime } from "./IScheduledTaskTime";
+/**
+ * Interface describing a scheduled task information.
+ */
+export interface IScheduledTaskInfo {
+    /**
+     * The information for the tasks.
+     */
+    tasks: {
+        [id: string]: IScheduledTaskTime[];
+    };
+}

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

@@ -0,0 +1,21 @@
+/**
+ * Interface describing a scheduled task time.
+ */
+export interface IScheduledTaskTime {
+    /**
+     * The date/time to start the task, if not provided defaults to first interval from now.
+     */
+    nextTriggerTime?: number;
+    /**
+     * The interval in days to repeat the task, if no intervals are set the task will not repeat.
+     */
+    intervalDays?: number;
+    /**
+     * The interval in hours to repeat the task, if no intervals are set the task will not repeat.
+     */
+    intervalHours?: number;
+    /**
+     * The interval in minutes to repeat the task, if no intervals are set the task will not repeat.
+     */
+    intervalMinutes?: number;
+}

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

@@ -0,0 +1,27 @@
+import type { IComponent } from "@twin.org/core";
+import type { IScheduledTaskInfo } from "./IScheduledTaskInfo";
+import type { IScheduledTaskTime } from "./IScheduledTaskTime";
+/**
+ * Interface describing a task scheduler.
+ */
+export interface ITaskSchedulerComponent extends IComponent {
+    /**
+     * Add a task to the scheduler.
+     * @param taskId The id of the task to add.
+     * @param times The times at which the task should be scheduled.
+     * @param taskCallback The callback to execute when the task is scheduled.
+     * @returns Nothing.
+     */
+    addTask(taskId: string, times: IScheduledTaskTime[], taskCallback: () => Promise<void>): Promise<void>;
+    /**
+     * Remove a task from the scheduler.
+     * @param taskId The id of the task to remove.
+     * @returns Nothing.
+     */
+    removeTask(taskId: string): Promise<void>;
+    /**
+     * Get the information about the tasks.
+     * @returns The tasks information.
+     */
+    tasksInfo(): Promise<IScheduledTaskInfo>;
+}

package/docs/changelog.md

@@ -1,5 +1,78 @@
 # @twin.org/background-task-models - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-07)
+
+
+### Features
+
+* release to production ([7ce9896](https://github.com/twinfoundation/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)
+
+
+### 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)
+
+
+### 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))
+
+## [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)
+
+
+### Features
+
+* add task scheduler ([754d973](https://github.com/twinfoundation/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)
+
+
+### 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)
+
+
+### Features
+
+* update dependencies ([8e65767](https://github.com/twinfoundation/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)
+
+
+### 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)
+
+
+### Features
+
+* use shared store mechanism ([#6](https://github.com/twinfoundation/background-task/issues/6)) ([27ed203](https://github.com/twinfoundation/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)
+
+
+### 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)
+
+
+### Features
+
+* improve comment ([f2b4ac2](https://github.com/twinfoundation/background-task/commit/f2b4ac22fb8f735d2bf4ce28583cf7c54acdf272))
+
+## v0.0.1-next.12
 
 - Initial Release

package/docs/reference/index.md

@@ -4,6 +4,9 @@
 
 - [IBackgroundTask](interfaces/IBackgroundTask.md)
 - [IBackgroundTaskConnector](interfaces/IBackgroundTaskConnector.md)
+- [IScheduledTaskInfo](interfaces/IScheduledTaskInfo.md)
+- [IScheduledTaskTime](interfaces/IScheduledTaskTime.md)
+- [ITaskSchedulerComponent](interfaces/ITaskSchedulerComponent.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/IBackgroundTask.md

@@ -1,12 +1,16 @@
 # Interface: IBackgroundTask\<T, U\>
 
-Interface describing a background task connector.
+Interface describing a background task.
 
 ## Type Parameters
 
-• **T** = `any`
+### T
 
-• **U** = `any`
+`T` = `any`
+
+### U
+
+`U` = `any`
 
 ## Properties
 

package/docs/reference/interfaces/IBackgroundTaskConnector.md

@@ -10,31 +10,43 @@ Interface describing a background task connector.
 
 ### registerHandler()
 
-> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback`?): `Promise`\<`void`\>
+> **registerHandler**\<`T`, `U`\>(`taskType`, `module`, `method`, `stateChangeCallback?`): `Promise`\<`void`\>
 
 Register a handler for a task.
 
 #### Type Parameters
 
-• **T**
+##### T
 
-• **U**
+`T`
+
+##### U
+
+`U`
 
 #### Parameters
 
-• **taskType**: `string`
+##### taskType
+
+`string`
 
 The type of the task the handler can process.
 
-• **module**: `string`
+##### module
+
+`string`
 
 The module the handler is in.
 
-• **method**: `string`
+##### method
+
+`string`
 
 The method in the module to execute.
 
-• **stateChangeCallback?**
+##### stateChangeCallback?
+
+(`task`) => `Promise`\<`void`\>
 
 The callback to execute when the task state is updated.
 
@@ -54,7 +66,9 @@ Unregister a handler for a task.
 
 #### Parameters
 
-• **taskType**: `string`
+##### taskType
+
+`string`
 
 The type of the task handler to remove.
 
@@ -68,37 +82,49 @@ Nothing.
 
 ### create()
 
-> **create**\<`T`\>(`type`, `payload`?, `options`?): `Promise`\<`string`\>
+> **create**\<`T`\>(`type`, `payload?`, `options?`): `Promise`\<`string`\>
 
 Create a new task.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
 #### Parameters
 
-• **type**: `string`
+##### type
+
+`string`
 
 The type of the task.
 
-• **payload?**: `T`
+##### payload?
+
+`T`
 
 The payload for the task.
 
-• **options?**
+##### options?
 
 Additional options for the task.
 
-• **options.retryCount?**: `number`
+###### retryCount?
+
+`number`
 
 The number of times to retry the task if it fails, leave undefined to retry forever.
 
-• **options.retryInterval?**: `number`
+###### retryInterval?
+
+`number`
 
 The interval in milliseconds to wait between retries, defaults to 5000, leave undefined for default scheduling.
 
-• **options.retainFor?**: `number`
+###### retainFor?
+
+`number`
 
 The amount of time in milliseconds to retain the result until removal, defaults to 0 for immediate removal, set to -1 to keep forever.
 
@@ -118,13 +144,19 @@ Get the task details.
 
 #### Type Parameters
 
-• **T**
+##### T
+
+`T`
 
-• **U**
+##### U
+
+`U`
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to get the details for.
 
@@ -144,7 +176,9 @@ Retry a failed task immediately instead of waiting for it's next scheduled retry
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to retry.
 
@@ -164,7 +198,9 @@ Remove a task ignoring any retain until date.
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to remove.
 
@@ -184,7 +220,9 @@ Cancel a task, will only be actioned if the task is currently pending.
 
 #### Parameters
 
-• **taskId**: `string`
+##### taskId
+
+`string`
 
 The id of the task to cancel.
 
@@ -198,46 +236,50 @@ Nothing.
 
 ### query()
 
-> **query**(`taskType`?, `taskStatus`?, `sortProperty`?, `sortDirection`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`taskType?`, `taskStatus?`, `sortProperty?`, `sortDirection?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
 
 Get a list of tasks.
 
 #### Parameters
 
-• **taskType?**: `string`
+##### taskType?
+
+`string`
 
 The type of the task to get.
 
-• **taskStatus?**: [`TaskStatus`](../type-aliases/TaskStatus.md)
+##### taskStatus?
+
+[`TaskStatus`](../type-aliases/TaskStatus.md)
 
 The status of the task to get.
 
-• **sortProperty?**: `"status"` \| `"dateCreated"` \| `"dateModified"` \| `"dateCompleted"`
+##### sortProperty?
 
 The property to sort by, defaults to dateCreated.
 
-• **sortDirection?**: `SortDirection`
+`"dateCreated"` | `"dateModified"` | `"dateCompleted"` | `"status"`
+
+##### sortDirection?
+
+`SortDirection`
 
 The order to sort by, defaults to ascending.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to get the next page of tasks.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]; `cursor?`: `string`; \}\>
 
 The list of tasks.
-
-##### entities
-
-> **entities**: [`IBackgroundTask`](IBackgroundTask.md)\<`any`, `any`\>[]
-
-##### cursor?
-
-> `optional` **cursor**: `string`

package/docs/reference/interfaces/IScheduledTaskInfo.md

@@ -0,0 +1,15 @@
+# Interface: IScheduledTaskInfo
+
+Interface describing a scheduled task information.
+
+## Properties
+
+### tasks
+
+> **tasks**: `object`
+
+The information for the tasks.
+
+#### Index Signature
+
+\[`id`: `string`\]: [`IScheduledTaskTime`](IScheduledTaskTime.md)[]

package/docs/reference/interfaces/IScheduledTaskTime.md

@@ -0,0 +1,35 @@
+# Interface: IScheduledTaskTime
+
+Interface describing a scheduled task time.
+
+## Properties
+
+### nextTriggerTime?
+
+> `optional` **nextTriggerTime**: `number`
+
+The date/time to start the task, if not provided defaults to first interval from now.
+
+***
+
+### intervalDays?
+
+> `optional` **intervalDays**: `number`
+
+The interval in days to repeat the task, if no intervals are set the task will not repeat.
+
+***
+
+### intervalHours?
+
+> `optional` **intervalHours**: `number`
+
+The interval in hours to repeat the task, if no intervals are set the task will not repeat.
+
+***
+
+### intervalMinutes?
+
+> `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

@@ -0,0 +1,77 @@
+# Interface: ITaskSchedulerComponent
+
+Interface describing a task scheduler.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### addTask()
+
+> **addTask**(`taskId`, `times`, `taskCallback`): `Promise`\<`void`\>
+
+Add a task to the scheduler.
+
+#### Parameters
+
+##### taskId
+
+`string`
+
+The id of the task to add.
+
+##### times
+
+[`IScheduledTaskTime`](IScheduledTaskTime.md)[]
+
+The times at which the task should be scheduled.
+
+##### taskCallback
+
+() => `Promise`\<`void`\>
+
+The callback to execute when the task is scheduled.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### removeTask()
+
+> **removeTask**(`taskId`): `Promise`\<`void`\>
+
+Remove a task from the scheduler.
+
+#### Parameters
+
+##### taskId
+
+`string`
+
+The id of the task to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### tasksInfo()
+
+> **tasksInfo**(): `Promise`\<[`IScheduledTaskInfo`](IScheduledTaskInfo.md)\>
+
+Get the information about the tasks.
+
+#### Returns
+
+`Promise`\<[`IScheduledTaskInfo`](IScheduledTaskInfo.md)\>
+
+The tasks information.

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

@@ -1,5 +1,5 @@
 # Type Alias: TaskStatus
 
-> **TaskStatus**: *typeof* [`TaskStatus`](../variables/TaskStatus.md)\[keyof *typeof* [`TaskStatus`](../variables/TaskStatus.md)\]
+> **TaskStatus** = *typeof* [`TaskStatus`](../variables/TaskStatus.md)\[keyof *typeof* [`TaskStatus`](../variables/TaskStatus.md)\]
 
 Task statuses.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Models which define the structure of the background task contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -14,18 +14,18 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next"
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},