@twin.org/background-task-scheduler 0.0.2-next.9 → 0.0.3-next.2

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/ITaskSchedulerConfig.js";
+export * from "./models/ITaskSchedulerConstructorOptions.js";
+export * from "./taskSchedulerService.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,kCAAkC,CAAC;AACjD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2BAA2B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/ITaskSchedulerConfig.js\";\nexport * from \"./models/ITaskSchedulerConstructorOptions.js\";\nexport * from \"./taskSchedulerService.js\";\n"]}

package/dist/es/models/ITaskSchedulerConfig.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITaskSchedulerConfig.js","sourceRoot":"","sources":["../../../src/models/ITaskSchedulerConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Interface for the task scheduler configuration.\n */\nexport interface ITaskSchedulerConfig {\n\t/**\n\t * The interval between checks for running tasks, defaults to 1 minute since that is the resolution of the tasks.\n\t * @default 60000\n\t */\n\toverrideInterval?: number;\n}\n"]}

package/dist/es/models/ITaskSchedulerConstructorOptions.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"ITaskSchedulerConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/ITaskSchedulerConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ITaskSchedulerConfig } from \"./ITaskSchedulerConfig.js\";\n\n/**\n * Options for the task scheduler constructor.\n */\nexport interface ITaskSchedulerConstructorOptions {\n\t/**\n\t * The logging component type.\n\t * @default logging\n\t */\n\tloggingComponentType?: string;\n\n\t/**\n\t * The configuration for the task scheduler.\n\t */\n\tconfig?: ITaskSchedulerConfig;\n}\n"]}

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

@@ -1,9 +1,8 @@
-import { ComponentFactory, Is, BaseError } from '@twin.org/core';
-
+import { BaseError, ComponentFactory, Is } from "@twin.org/core";
 /**
  * Class for scheduling tasks.
  */
-class TaskSchedulerService {
+export class TaskSchedulerService {
     /**
      * Runtime name for the class.
      */
@@ -37,13 +36,19 @@ class TaskSchedulerService {
         this._tasks = {};
         this._tickInterval = options?.config?.overrideInterval ?? 60 * 1000; // Default to 1 minute
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return TaskSchedulerService.CLASS_NAME;
+    }
     /**
      * The component needs to be stopped when the node is closed.
-     * @param nodeIdentity The identity of the node stopping the component.
      * @param nodeLoggingComponentType The node logging component type.
      * @returns Nothing.
      */
-    async stop(nodeIdentity, nodeLoggingComponentType) {
+    async stop(nodeLoggingComponentType) {
         this.stopTimer();
     }
     /**
@@ -63,7 +68,7 @@ class TaskSchedulerService {
             })),
             taskCallback
         };
-        this._logging?.log({
+        await this._logging?.log({
             level: "info",
             source: TaskSchedulerService.CLASS_NAME,
             ts: Date.now(),
@@ -81,7 +86,7 @@ class TaskSchedulerService {
      */
     async removeTask(taskId) {
         if (!Is.empty(this._tasks[taskId])) {
-            this._logging?.log({
+            await this._logging?.log({
                 level: "info",
                 source: TaskSchedulerService.CLASS_NAME,
                 ts: Date.now(),
@@ -163,7 +168,7 @@ class TaskSchedulerService {
             const task = this._tasks[taskId];
             for (const taskTime of task.times) {
                 if (!Is.empty(taskTime.nextTriggerTime) && taskTime.nextTriggerTime <= now) {
-                    this._logging?.log({
+                    await this._logging?.log({
                         level: "info",
                         source: TaskSchedulerService.CLASS_NAME,
                         ts: Date.now(),
@@ -177,7 +182,7 @@ class TaskSchedulerService {
                         await task.taskCallback();
                     }
                     catch (error) {
-                        this._logging?.log({
+                        await this._logging?.log({
                             level: "error",
                             source: TaskSchedulerService.CLASS_NAME,
                             ts: Date.now(),
@@ -203,5 +208,4 @@ class TaskSchedulerService {
         }
     }
 }
-
-export { TaskSchedulerService };
+//# sourceMappingURL=taskSchedulerService.js.map

package/dist/es/taskSchedulerService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"taskSchedulerService.js","sourceRoot":"","sources":["../../src/taskSchedulerService.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAKjE;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAU,UAAU,0BAA0C;IAE3E;;;OAGG;IACc,QAAQ,CAAqB;IAE9C;;;OAGG;IACc,aAAa,CAAS;IAEvC;;;OAGG;IACc,MAAM,CAKrB;IAEF;;;OAGG;IACK,MAAM,CAAkB;IAEhC;;;OAGG;IACH,YAAY,OAA0C;QACrD,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,EAAE,oBAAoB,IAAI,SAAS,CAAC,CAAC;QACzF,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;QACjB,IAAI,CAAC,aAAa,GAAG,OAAO,EAAE,MAAM,EAAE,gBAAgB,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,sBAAsB;IAC5F,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,oBAAoB,CAAC,UAAU,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CAAC,wBAAiC;QAClD,IAAI,CAAC,SAAS,EAAE,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO,CACnB,MAAc,EACd,KAA2B,EAC3B,YAAiC;QAEjC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG;YACrB,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACzB,GAAG,IAAI;gBACP,eAAe,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC;oBAC9C,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC;oBACrC,CAAC,CAAC,IAAI,CAAC,eAAe;aACvB,CAAC,CAAC;YACH,YAAY;SACZ,CAAC;QAEF,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;YACxB,KAAK,EAAE,MAAM;YACb,MAAM,EAAE,oBAAoB,CAAC,UAAU;YACvC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,WAAW;YACpB,IAAI,EAAE;gBACL,EAAE,EAAE,MAAM;aACV;SACD,CAAC,CAAC;QAEH,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QACrC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;gBACxB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,oBAAoB,CAAC,UAAU;gBACvC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,aAAa;gBACtB,IAAI,EAAE;oBACL,EAAE,EAAE,MAAM;iBACV;aACD,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAE3B,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,SAAS,EAAE,CAAC;YAClB,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,SAAS,GAAuB;YACrC,KAAK,EAAE,EAAE;SACT,CAAC;QACF,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAClC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC;QACrD,CAAC;QACD,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,IAAwB;QACxD,IAAI,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;QAE3C,IAAI,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/B,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YAClC,eAAe,IAAI,IAAI,CAAC,YAAY,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QAC5D,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACnC,eAAe,IAAI,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;QACxD,CAAC;QAED,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACrC,eAAe,IAAI,IAAI,CAAC,eAAe,GAAG,EAAE,GAAG,IAAI,CAAC;QACrD,CAAC;QAED,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,UAAU;QACvB,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC3B,sDAAsD;YACtD,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACnC,iDAAiD;YACjD,IAAI,CAAC,MAAM,GAAG,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QACzF,CAAC;IACF,CAAC;IAED;;;OAGG;IACK,SAAS;QAChB,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACzB,CAAC;IACF,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,qBAAqB;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAClC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAEjC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACnC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,IAAI,QAAQ,CAAC,eAAe,IAAI,GAAG,EAAE,CAAC;oBAC5E,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;wBACxB,KAAK,EAAE,MAAM;wBACb,MAAM,EAAE,oBAAoB,CAAC,UAAU;wBACvC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;wBACd,OAAO,EAAE,eAAe;wBACxB,IAAI,EAAE;4BACL,EAAE,EAAE,MAAM;4BACV,IAAI,EAAE,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,WAAW,EAAE;yBACtD;qBACD,CAAC,CAAC;oBAEH,IAAI,CAAC;wBACJ,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;oBAC3B,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBAChB,MAAM,IAAI,CAAC,QAAQ,EAAE,GAAG,CAAC;4BACxB,KAAK,EAAE,OAAO;4BACd,MAAM,EAAE,oBAAoB,CAAC,UAAU;4BACvC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;4BACd,OAAO,EAAE,YAAY;4BACrB,IAAI,EAAE;gCACL,EAAE,EAAE,MAAM;6BACV;4BACD,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;yBACjC,CAAC,CAAC;oBACJ,CAAC;oBAED,oEAAoE;oBACpE,IACC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;wBAC/B,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC;wBAChC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,eAAe,CAAC,EACjC,CAAC;wBACF,QAAQ,CAAC,eAAe,GAAG,SAAS,CAAC;oBACtC,CAAC;yBAAM,CAAC;wBACP,4EAA4E;wBAC5E,QAAQ,CAAC,eAAe,GAAG,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CAAC;oBACpE,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type {\n\tIScheduledTaskInfo,\n\tIScheduledTaskTime,\n\tITaskSchedulerComponent\n} from \"@twin.org/background-task-models\";\nimport { BaseError, ComponentFactory, Is } from \"@twin.org/core\";\nimport type { ILoggingComponent } from \"@twin.org/logging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { ITaskSchedulerConstructorOptions } from \"./models/ITaskSchedulerConstructorOptions.js\";\n\n/**\n * Class for scheduling tasks.\n */\nexport class TaskSchedulerService implements ITaskSchedulerComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<TaskSchedulerService>();\n\n\t/**\n\t * The logger for the task service.\n\t * @internal\n\t */\n\tprivate readonly _logging?: ILoggingComponent;\n\n\t/**\n\t * The interval in milliseconds at which the tasks are checked.\n\t * @internal\n\t */\n\tprivate readonly _tickInterval: number;\n\n\t/**\n\t * The tasks that are scheduled.\n\t * @internal\n\t */\n\tprivate readonly _tasks: {\n\t\t[id: string]: {\n\t\t\ttimes: IScheduledTaskTime[];\n\t\t\ttaskCallback: () => Promise<void>;\n\t\t};\n\t};\n\n\t/**\n\t * The timer for running scheduled tasks.\n\t * @internal\n\t */\n\tprivate _timer?: NodeJS.Timeout;\n\n\t/**\n\t * Create a new instance of TaskSchedulerComponent.\n\t * @param options The options for the scheduler.\n\t */\n\tconstructor(options?: ITaskSchedulerConstructorOptions) {\n\t\tthis._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? \"logging\");\n\t\tthis._tasks = {};\n\t\tthis._tickInterval = options?.config?.overrideInterval ?? 60 * 1000; // Default to 1 minute\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn TaskSchedulerService.CLASS_NAME;\n\t}\n\n\t/**\n\t * The component needs to be stopped when the node is closed.\n\t * @param nodeLoggingComponentType The node logging component type.\n\t * @returns Nothing.\n\t */\n\tpublic async stop(nodeLoggingComponentType?: string): Promise<void> {\n\t\tthis.stopTimer();\n\t}\n\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\tpublic async addTask(\n\t\ttaskId: string,\n\t\ttimes: IScheduledTaskTime[],\n\t\ttaskCallback: () => Promise<void>\n\t): Promise<void> {\n\t\tthis._tasks[taskId] = {\n\t\t\ttimes: times.map(time => ({\n\t\t\t\t...time,\n\t\t\t\tnextTriggerTime: Is.empty(time.nextTriggerTime)\n\t\t\t\t\t? this.calculateNextTriggerTime(time)\n\t\t\t\t\t: time.nextTriggerTime\n\t\t\t})),\n\t\t\ttaskCallback\n\t\t};\n\n\t\tawait this._logging?.log({\n\t\t\tlevel: \"info\",\n\t\t\tsource: TaskSchedulerService.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"taskAdded\",\n\t\t\tdata: {\n\t\t\t\tid: taskId\n\t\t\t}\n\t\t});\n\n\t\tawait this.startTimer();\n\t}\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\tpublic async removeTask(taskId: string): Promise<void> {\n\t\tif (!Is.empty(this._tasks[taskId])) {\n\t\t\tawait this._logging?.log({\n\t\t\t\tlevel: \"info\",\n\t\t\t\tsource: TaskSchedulerService.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"taskRemoved\",\n\t\t\t\tdata: {\n\t\t\t\t\tid: taskId\n\t\t\t\t}\n\t\t\t});\n\n\t\t\tdelete this._tasks[taskId];\n\n\t\t\tif (Object.keys(this._tasks).length === 0) {\n\t\t\t\tthis.stopTimer();\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Get the information about the tasks.\n\t * @returns The tasks information.\n\t */\n\tpublic async tasksInfo(): Promise<IScheduledTaskInfo> {\n\t\tconst tasksInfo: IScheduledTaskInfo = {\n\t\t\ttasks: {}\n\t\t};\n\t\tfor (const taskId in this._tasks) {\n\t\t\ttasksInfo.tasks[taskId] = this._tasks[taskId].times;\n\t\t}\n\t\treturn tasksInfo;\n\t}\n\n\t/**\n\t * Calculate the next run time for a task based on its scheduled times.\n\t * @param time The times at which the task should be scheduled.\n\t * @returns The update time with the next run.\n\t * @internal\n\t */\n\tprivate calculateNextTriggerTime(time: IScheduledTaskTime): number {\n\t\tlet nextTriggerTime = time.nextTriggerTime;\n\n\t\tif (Is.empty(nextTriggerTime)) {\n\t\t\tnextTriggerTime = Date.now();\n\t\t}\n\n\t\tif (!Is.empty(time.intervalDays)) {\n\t\t\tnextTriggerTime += time.intervalDays * 24 * 60 * 60 * 1000;\n\t\t}\n\n\t\tif (!Is.empty(time.intervalHours)) {\n\t\t\tnextTriggerTime += time.intervalHours * 60 * 60 * 1000;\n\t\t}\n\n\t\tif (!Is.empty(time.intervalMinutes)) {\n\t\t\tnextTriggerTime += time.intervalMinutes * 60 * 1000;\n\t\t}\n\n\t\treturn nextTriggerTime;\n\t}\n\n\t/**\n\t * Start the timer for running scheduled tasks.\n\t * @internal\n\t */\n\tprivate async startTimer(): Promise<void> {\n\t\tif (Is.empty(this._timer)) {\n\t\t\t// Trigger immediately to catch up on any missed tasks\n\t\t\tawait this.triggerScheduledTasks();\n\t\t\t// Set the timer to run at the specified interval\n\t\t\tthis._timer = setInterval(async () => this.triggerScheduledTasks(), this._tickInterval);\n\t\t}\n\t}\n\n\t/**\n\t * Stop the timer for running scheduled tasks.\n\t * @internal\n\t */\n\tprivate stopTimer(): void {\n\t\tif (!Is.empty(this._timer)) {\n\t\t\tclearInterval(this._timer);\n\t\t\tthis._timer = undefined;\n\t\t}\n\t}\n\n\t/**\n\t * Trigger scheduled tasks based on their next run times.\n\t * @internal\n\t */\n\tprivate async triggerScheduledTasks(): Promise<void> {\n\t\tconst now = Date.now();\n\n\t\tfor (const taskId in this._tasks) {\n\t\t\tconst task = this._tasks[taskId];\n\n\t\t\tfor (const taskTime of task.times) {\n\t\t\t\tif (!Is.empty(taskTime.nextTriggerTime) && taskTime.nextTriggerTime <= now) {\n\t\t\t\t\tawait this._logging?.log({\n\t\t\t\t\t\tlevel: \"info\",\n\t\t\t\t\t\tsource: TaskSchedulerService.CLASS_NAME,\n\t\t\t\t\t\tts: Date.now(),\n\t\t\t\t\t\tmessage: \"taskTriggered\",\n\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\tid: taskId,\n\t\t\t\t\t\t\ttime: new Date(taskTime.nextTriggerTime).toISOString()\n\t\t\t\t\t\t}\n\t\t\t\t\t});\n\n\t\t\t\t\ttry {\n\t\t\t\t\t\tawait task.taskCallback();\n\t\t\t\t\t} catch (error) {\n\t\t\t\t\t\tawait this._logging?.log({\n\t\t\t\t\t\t\tlevel: \"error\",\n\t\t\t\t\t\t\tsource: TaskSchedulerService.CLASS_NAME,\n\t\t\t\t\t\t\tts: Date.now(),\n\t\t\t\t\t\t\tmessage: \"taskFailed\",\n\t\t\t\t\t\t\tdata: {\n\t\t\t\t\t\t\t\tid: taskId\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\terror: BaseError.fromError(error)\n\t\t\t\t\t\t});\n\t\t\t\t\t}\n\n\t\t\t\t\t// If the intervals are empty, we do not recalculate a next run time\n\t\t\t\t\tif (\n\t\t\t\t\t\tIs.empty(taskTime.intervalDays) &&\n\t\t\t\t\t\tIs.empty(taskTime.intervalHours) &&\n\t\t\t\t\t\tIs.empty(taskTime.intervalMinutes)\n\t\t\t\t\t) {\n\t\t\t\t\t\ttaskTime.nextTriggerTime = undefined;\n\t\t\t\t\t} else {\n\t\t\t\t\t\t// Recalculate the next run time based on the current time and the intervals\n\t\t\t\t\t\ttaskTime.nextTriggerTime = this.calculateNextTriggerTime(taskTime);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n"]}

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./models/ITaskSchedulerConfig";
-export * from "./models/ITaskSchedulerConstructorOptions";
-export * from "./taskSchedulerService";
+export * from "./models/ITaskSchedulerConfig.js";
+export * from "./models/ITaskSchedulerConstructorOptions.js";
+export * from "./taskSchedulerService.js";

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

@@ -1,4 +1,4 @@
-import type { ITaskSchedulerConfig } from "./ITaskSchedulerConfig";
+import type { ITaskSchedulerConfig } from "./ITaskSchedulerConfig.js";
 /**
  * Options for the task scheduler constructor.
  */

package/dist/types/taskSchedulerService.d.ts

@@ -1,5 +1,5 @@
 import type { IScheduledTaskInfo, IScheduledTaskTime, ITaskSchedulerComponent } from "@twin.org/background-task-models";
-import type { ITaskSchedulerConstructorOptions } from "./models/ITaskSchedulerConstructorOptions";
+import type { ITaskSchedulerConstructorOptions } from "./models/ITaskSchedulerConstructorOptions.js";
 /**
  * Class for scheduling tasks.
  */
@@ -13,13 +13,17 @@ export declare class TaskSchedulerService implements ITaskSchedulerComponent {
      * @param options The options for the scheduler.
      */
     constructor(options?: ITaskSchedulerConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * The component needs to be stopped when the node is closed.
-     * @param nodeIdentity The identity of the node stopping the component.
      * @param nodeLoggingComponentType The node logging component type.
      * @returns Nothing.
      */
-    stop(nodeIdentity: string, nodeLoggingComponentType: string | undefined): Promise<void>;
+    stop(nodeLoggingComponentType?: string): Promise<void>;
     /**
      * Add a task to the scheduler.
      * @param taskId The id of the task to add.

package/docs/changelog.md

@@ -1,5 +1,47 @@
 # Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/background-task/compare/background-task-scheduler-v0.0.3-next.1...background-task-scheduler-v0.0.3-next.2) (2025-11-28)
+
+
+### Miscellaneous Chores
+
+* **background-task-scheduler:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/background-task-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/background-task/compare/background-task-scheduler-v0.0.3-next.0...background-task-scheduler-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))
+* background tasks immediately trigger ([a0a847b](https://github.com/twinfoundation/background-task/commit/a0a847ba9686adcd0460e810540959f87dcaeab1))
+* eslint migration to flat config ([6c9136c](https://github.com/twinfoundation/background-task/commit/6c9136c37bccdbbd109892d1503660aab7080d49))
+* remove unused parameters ([1028b3c](https://github.com/twinfoundation/background-task/commit/1028b3cc147c25da22a8ba8d7207acfb34f89cdb))
+* rename task scheduler component ([2f8aa59](https://github.com/twinfoundation/background-task/commit/2f8aa59c069055ff020a3c0c149601f20c656022))
+* rename task scheduler component to service ([f097a98](https://github.com/twinfoundation/background-task/commit/f097a988c9ee0795aa55d74deda616365ec4ffb1))
+* update framework core ([a068098](https://github.com/twinfoundation/background-task/commit/a0680983d7923a1bfb980a67879019bb870ccc5d))
+* update IComponent signatures ([e1a79bc](https://github.com/twinfoundation/background-task/commit/e1a79bc4dd813435c56e376f231a4b4ecd2276bf))
+
+
+### Bug Fixes
+
+* models import ([c830b0d](https://github.com/twinfoundation/background-task/commit/c830b0da4deb06f8aeca6fec8988be4da877e73b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/background-task-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/background-task/compare/background-task-scheduler-v0.0.2-next.8...background-task-scheduler-v0.0.2-next.9) (2025-10-09)
 
 

package/docs/reference/classes/TaskSchedulerService.md

@@ -36,26 +36,38 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`ITaskSchedulerComponent.className`
+
+***
+
 ### stop()
 
-> **stop**(`nodeIdentity`, `nodeLoggingComponentType`): `Promise`\<`void`\>
+> **stop**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
 
 The component needs to be stopped when the node is closed.
 
 #### Parameters
 
-##### nodeIdentity
+##### nodeLoggingComponentType?
 
 `string`
 
-The identity of the node stopping the component.
-
-##### nodeLoggingComponentType
-
 The node logging component type.
 
-`undefined` | `string`
-
 #### Returns
 
 `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/background-task-scheduler",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.2",
 	"description": "Background task scheduler",
 	"repository": {
 		"type": "git",
@@ -14,25 +14,23 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/background-task-models": "0.0.2-next.9",
+		"@twin.org/background-task-models": "0.0.3-next.2",
 		"@twin.org/core": "next",
 		"@twin.org/logging-models": "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"

package/dist/cjs/index.cjs

@@ -1,209 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-
-/**
- * Class for scheduling tasks.
- */
-class TaskSchedulerService {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "TaskSchedulerService";
-    /**
-     * The logger for the task service.
-     * @internal
-     */
-    _logging;
-    /**
-     * The interval in milliseconds at which the tasks are checked.
-     * @internal
-     */
-    _tickInterval;
-    /**
-     * The tasks that are scheduled.
-     * @internal
-     */
-    _tasks;
-    /**
-     * The timer for running scheduled tasks.
-     * @internal
-     */
-    _timer;
-    /**
-     * Create a new instance of TaskSchedulerComponent.
-     * @param options The options for the scheduler.
-     */
-    constructor(options) {
-        this._logging = core.ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
-        this._tasks = {};
-        this._tickInterval = options?.config?.overrideInterval ?? 60 * 1000; // Default to 1 minute
-    }
-    /**
-     * The component needs to be stopped when the node is closed.
-     * @param nodeIdentity The identity of the node stopping the component.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
-     */
-    async stop(nodeIdentity, nodeLoggingComponentType) {
-        this.stopTimer();
-    }
-    /**
-     * 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.
-     */
-    async addTask(taskId, times, taskCallback) {
-        this._tasks[taskId] = {
-            times: times.map(time => ({
-                ...time,
-                nextTriggerTime: core.Is.empty(time.nextTriggerTime)
-                    ? this.calculateNextTriggerTime(time)
-                    : time.nextTriggerTime
-            })),
-            taskCallback
-        };
-        this._logging?.log({
-            level: "info",
-            source: TaskSchedulerService.CLASS_NAME,
-            ts: Date.now(),
-            message: "taskAdded",
-            data: {
-                id: taskId
-            }
-        });
-        await this.startTimer();
-    }
-    /**
-     * Remove a task from the scheduler.
-     * @param taskId The id of the task to remove.
-     * @returns Nothing.
-     */
-    async removeTask(taskId) {
-        if (!core.Is.empty(this._tasks[taskId])) {
-            this._logging?.log({
-                level: "info",
-                source: TaskSchedulerService.CLASS_NAME,
-                ts: Date.now(),
-                message: "taskRemoved",
-                data: {
-                    id: taskId
-                }
-            });
-            delete this._tasks[taskId];
-            if (Object.keys(this._tasks).length === 0) {
-                this.stopTimer();
-            }
-        }
-    }
-    /**
-     * Get the information about the tasks.
-     * @returns The tasks information.
-     */
-    async tasksInfo() {
-        const tasksInfo = {
-            tasks: {}
-        };
-        for (const taskId in this._tasks) {
-            tasksInfo.tasks[taskId] = this._tasks[taskId].times;
-        }
-        return tasksInfo;
-    }
-    /**
-     * Calculate the next run time for a task based on its scheduled times.
-     * @param time The times at which the task should be scheduled.
-     * @returns The update time with the next run.
-     * @internal
-     */
-    calculateNextTriggerTime(time) {
-        let nextTriggerTime = time.nextTriggerTime;
-        if (core.Is.empty(nextTriggerTime)) {
-            nextTriggerTime = Date.now();
-        }
-        if (!core.Is.empty(time.intervalDays)) {
-            nextTriggerTime += time.intervalDays * 24 * 60 * 60 * 1000;
-        }
-        if (!core.Is.empty(time.intervalHours)) {
-            nextTriggerTime += time.intervalHours * 60 * 60 * 1000;
-        }
-        if (!core.Is.empty(time.intervalMinutes)) {
-            nextTriggerTime += time.intervalMinutes * 60 * 1000;
-        }
-        return nextTriggerTime;
-    }
-    /**
-     * Start the timer for running scheduled tasks.
-     * @internal
-     */
-    async startTimer() {
-        if (core.Is.empty(this._timer)) {
-            // Trigger immediately to catch up on any missed tasks
-            await this.triggerScheduledTasks();
-            // Set the timer to run at the specified interval
-            this._timer = setInterval(async () => this.triggerScheduledTasks(), this._tickInterval);
-        }
-    }
-    /**
-     * Stop the timer for running scheduled tasks.
-     * @internal
-     */
-    stopTimer() {
-        if (!core.Is.empty(this._timer)) {
-            clearInterval(this._timer);
-            this._timer = undefined;
-        }
-    }
-    /**
-     * Trigger scheduled tasks based on their next run times.
-     * @internal
-     */
-    async triggerScheduledTasks() {
-        const now = Date.now();
-        for (const taskId in this._tasks) {
-            const task = this._tasks[taskId];
-            for (const taskTime of task.times) {
-                if (!core.Is.empty(taskTime.nextTriggerTime) && taskTime.nextTriggerTime <= now) {
-                    this._logging?.log({
-                        level: "info",
-                        source: TaskSchedulerService.CLASS_NAME,
-                        ts: Date.now(),
-                        message: "taskTriggered",
-                        data: {
-                            id: taskId,
-                            time: new Date(taskTime.nextTriggerTime).toISOString()
-                        }
-                    });
-                    try {
-                        await task.taskCallback();
-                    }
-                    catch (error) {
-                        this._logging?.log({
-                            level: "error",
-                            source: TaskSchedulerService.CLASS_NAME,
-                            ts: Date.now(),
-                            message: "taskFailed",
-                            data: {
-                                id: taskId
-                            },
-                            error: core.BaseError.fromError(error)
-                        });
-                    }
-                    // If the intervals are empty, we do not recalculate a next run time
-                    if (core.Is.empty(taskTime.intervalDays) &&
-                        core.Is.empty(taskTime.intervalHours) &&
-                        core.Is.empty(taskTime.intervalMinutes)) {
-                        taskTime.nextTriggerTime = undefined;
-                    }
-                    else {
-                        // Recalculate the next run time based on the current time and the intervals
-                        taskTime.nextTriggerTime = this.calculateNextTriggerTime(taskTime);
-                    }
-                }
-            }
-        }
-    }
-}
-
-exports.TaskSchedulerService = TaskSchedulerService;