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

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/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,12 @@
 # @twin.org/background-task-models - Changelog
 
+## [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)
 
 

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/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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-models",
-	"version": "0.0.1-next.18",
+	"version": "0.0.1-next.19",
 	"description": "Models which define the structure of the background task contracts and connectors",
 	"repository": {
 		"type": "git",