@pristine-ts/scheduling 0.0.173 → 0.0.177

package/dist/lib/cjs/managers/scheduler.manager.js

@@ -25,7 +25,25 @@ exports.SchedulerManager = void 0;
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
 const scheduling_module_keyname_1 = require("../scheduling.module.keyname");
+/**
+ * The Scheduler Manager runs the scheduled tasks.A scheduled task cannot specify the interval at which it wants to be triggered.
+ * It's only a mechanism to understand that must be triggered by a CRON.
+ * When used with a CRON, a scheduled task will be triggered at a recurring interval, it is your own responsibility to implement a
+ * logic of executing or not based on how long it's been since the last execution.
+ * Please look at the aws-scheduling module for an example of how to setup a CRON using AWS Event Bridge with Pristine's listeners.
+ * It is tagged so it can be injected using SchedulerInterface.
+ * It is module scoped to the scheduling module.
+ */
 let SchedulerManager = class SchedulerManager {
+    /**
+     * The Scheduler Manager runs the scheduled tasks.A scheduled task cannot specify the interval at which it wants to be triggered.
+     * It's only a mechanism to understand that must be triggered by a CRON.
+     * When used with a CRON, a scheduled task will be triggered at a recurring interval, it is your own responsibility to implement a
+     * logic of executing or not based on how long it's been since the last execution.
+     * Please look at the aws-scheduling module for an example of how to setup a CRON using AWS Event Bridge with Pristine's listeners.
+     * @param scheduledTasks The scheduled tasks to run. All services with the tag ServiceDefinitionTagEnum.ScheduledTask will be automatically injected here.
+     * @param logHandler The log handler to use to output logs.
+     */
     constructor(scheduledTasks, logHandler) {
         this.scheduledTasks = scheduledTasks;
         this.logHandler = logHandler;
@@ -41,7 +59,7 @@ let SchedulerManager = class SchedulerManager {
                 this.scheduledTasks.forEach(scheduledTask => {
                     promises.push(scheduledTask.run());
                 });
-                this.logHandler.debug("Completed the execution of the tasks.", { scheduledTasks: this.scheduledTasks }, scheduling_module_keyname_1.SchedulingModuleKeyname);
+                this.logHandler.debug("Completed triggering all the tasks.", { scheduledTasks: this.scheduledTasks }, scheduling_module_keyname_1.SchedulingModuleKeyname);
                 Promise.allSettled(promises).then(results => {
                     results.forEach(result => {
                         if (result.status === 'fulfilled') {

package/dist/lib/cjs/managers/scheduler.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"scheduler.manager.js","sourceRoot":"","sources":["../../../../src/managers/scheduler.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAuD;AAEvD,gDAAgF;AAChF,4EAAqE;AAOrE,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IACzB,YAAgF,cAAwC,EAC5D,UAA+B;QADX,mBAAc,GAAd,cAAc,CAA0B;QAC5D,eAAU,GAAV,UAAU,CAAqB;IAC3F,CAAC;IAED;;OAEG;IACG,QAAQ;;YACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sCAAsC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,mDAAuB,CAAC,CAAC;YAE9H,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBACzB,MAAM,QAAQ,GAAoB,EAAE,CAAC;gBAErC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;oBACxC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,uCAAuC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,mDAAuB,CAAC,CAAC;gBAE/H,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;oBACxC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;wBACrB,IAAG,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE;4BAC9B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAC,MAAM,EAAC,EAAE,mDAAuB,CAAC,CAAA;yBACvF;6BACI;4BACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;gCAC1C,MAAM,EAAE;oCACJ,MAAM,EAAE,MAAM,CAAC,MAAM;oCACrB,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,EAAE;iCAC7B;6BACJ,EAAE,mDAAuB,CAAC,CAAA;yBAC9B;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,OAAO,EAAE,CAAC;gBACrB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAA;QACN,CAAC;KAAA;CACJ,CAAA;AAvCY,gBAAgB;IAH5B,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,oBAAoB,CAAC;IACzB,qBAAU,EAAE;IAEI,WAAA,oBAAS,CAAC,iCAAwB,CAAC,aAAa,CAAC,CAAA;IACjD,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;;GAFjC,gBAAgB,CAuC5B;AAvCY,4CAAgB"}
+{"version":3,"file":"scheduler.manager.js","sourceRoot":"","sources":["../../../../src/managers/scheduler.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAAA,uCAAuD;AAEvD,gDAAgF;AAChF,4EAAqE;AAIrE;;;;;;;;GAQG;AAIH,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAEzB;;;;;;;;OAQG;IACH,YAAgF,cAAwC,EAC5D,UAA+B;QADX,mBAAc,GAAd,cAAc,CAA0B;QAC5D,eAAU,GAAV,UAAU,CAAqB;IAC3F,CAAC;IAED;;OAEG;IACG,QAAQ;;YACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sCAAsC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,mDAAuB,CAAC,CAAC;YAE9H,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBACzB,MAAM,QAAQ,GAAoB,EAAE,CAAC;gBAErC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;oBACxC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qCAAqC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,mDAAuB,CAAC,CAAC;gBAE7H,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;oBACxC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;wBACrB,IAAG,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE;4BAC9B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAC,MAAM,EAAC,EAAE,mDAAuB,CAAC,CAAA;yBACvF;6BACI;4BACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;gCAC1C,MAAM,EAAE;oCACJ,MAAM,EAAE,MAAM,CAAC,MAAM;oCACrB,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,EAAE;iCAC7B;6BACJ,EAAE,mDAAuB,CAAC,CAAA;yBAC9B;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,OAAO,EAAE,CAAC;gBACrB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAA;QACN,CAAC;KAAA;CACJ,CAAA;AAjDY,gBAAgB;IAH5B,qBAAY,CAAC,mDAAuB,CAAC;IACrC,YAAG,CAAC,oBAAoB,CAAC;IACzB,qBAAU,EAAE;IAYI,WAAA,oBAAS,CAAC,iCAAwB,CAAC,aAAa,CAAC,CAAA;IACjD,WAAA,iBAAM,CAAC,qBAAqB,CAAC,CAAA;;GAZjC,gBAAgB,CAiD5B;AAjDY,4CAAgB"}

package/dist/lib/cjs/scheduling.module.js

@@ -13,7 +13,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SchedulingModule = void 0;
 const logging_1 = require("@pristine-ts/logging");
 const scheduling_module_keyname_1 = require("./scheduling.module.keyname");
-const event_1 = require("@pristine-ts/event");
 const core_1 = require("@pristine-ts/core");
 __exportStar(require("./interfaces/interfaces"), exports);
 __exportStar(require("./managers/managers"), exports);
@@ -22,7 +21,6 @@ exports.SchedulingModule = {
     keyname: scheduling_module_keyname_1.SchedulingModuleKeyname,
     importModules: [
         logging_1.LoggingModule,
-        event_1.EventModule,
         core_1.CoreModule,
     ],
     providerRegistrations: [],

package/dist/lib/cjs/scheduling.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"scheduling.module.js","sourceRoot":"","sources":["../../../src/scheduling.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,kDAAmD;AACnD,2EAAoE;AACpE,8CAA+C;AAC/C,4CAA6C;AAE7C,0DAAwC;AACxC,sDAAoC;AACpC,gDAA8B;AAEjB,QAAA,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,mDAAuB;IAChC,aAAa,EAAE;QACX,uBAAa;QACb,mBAAW;QACX,iBAAU;KACb;IACD,qBAAqB,EAAE,EAAE;IACzB,wBAAwB,EAAE,EACzB;CAEJ,CAAA"}
+{"version":3,"file":"scheduling.module.js","sourceRoot":"","sources":["../../../src/scheduling.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;AACA,kDAAmD;AACnD,2EAAoE;AACpE,4CAA6C;AAE7C,0DAAwC;AACxC,sDAAoC;AACpC,gDAA8B;AAEjB,QAAA,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,mDAAuB;IAChC,aAAa,EAAE;QACX,uBAAa;QACb,iBAAU;KACb;IACD,qBAAqB,EAAE,EAAE;IACzB,wBAAwB,EAAE,EACzB;CAEJ,CAAA"}

package/dist/lib/cjs/tasks/default.task.js

@@ -18,6 +18,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultTask = void 0;
 const tsyringe_1 = require("tsyringe");
 const common_1 = require("@pristine-ts/common");
+/**
+ * The default task is here so that there is at least one service with the ServiceDefinitionTagEnum.ScheduledTask.
+ * It does not do anything.
+ * Until there's a fix for: https://github.com/microsoft/tsyringe/issues/63
+ */
 let DefaultTask = class DefaultTask {
     run() {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/lib/cjs/tasks/default.task.js.map

@@ -1 +1 @@
-{"version":3,"file":"default.task.js","sourceRoot":"","sources":["../../../../src/tasks/default.task.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,uCAAoC;AACpC,gDAAkE;AAIlE,IAAa,WAAW,GAAxB,MAAa,WAAW;IACd,GAAG;;QACT,CAAC;KAAA;CACJ,CAAA;AAHY,WAAW;IAFvB,qBAAU,EAAE;IACZ,YAAG,CAAC,iCAAwB,CAAC,aAAa,CAAC;GAC/B,WAAW,CAGvB;AAHY,kCAAW"}
+{"version":3,"file":"default.task.js","sourceRoot":"","sources":["../../../../src/tasks/default.task.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AACA,uCAAoC;AACpC,gDAAkE;AAElE;;;;GAIG;AAGH,IAAa,WAAW,GAAxB,MAAa,WAAW;IACd,GAAG;;QACT,CAAC;KAAA;CACJ,CAAA;AAHY,WAAW;IAFvB,qBAAU,EAAE;IACZ,YAAG,CAAC,iCAAwB,CAAC,aAAa,CAAC;GAC/B,WAAW,CAGvB;AAHY,kCAAW"}

package/dist/lib/esm/managers/scheduler.manager.js

@@ -22,7 +22,25 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { injectable, injectAll, inject } from "tsyringe";
 import { moduleScoped, ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
 import { SchedulingModuleKeyname } from "../scheduling.module.keyname";
+/**
+ * The Scheduler Manager runs the scheduled tasks.A scheduled task cannot specify the interval at which it wants to be triggered.
+ * It's only a mechanism to understand that must be triggered by a CRON.
+ * When used with a CRON, a scheduled task will be triggered at a recurring interval, it is your own responsibility to implement a
+ * logic of executing or not based on how long it's been since the last execution.
+ * Please look at the aws-scheduling module for an example of how to setup a CRON using AWS Event Bridge with Pristine's listeners.
+ * It is tagged so it can be injected using SchedulerInterface.
+ * It is module scoped to the scheduling module.
+ */
 let SchedulerManager = class SchedulerManager {
+    /**
+     * The Scheduler Manager runs the scheduled tasks.A scheduled task cannot specify the interval at which it wants to be triggered.
+     * It's only a mechanism to understand that must be triggered by a CRON.
+     * When used with a CRON, a scheduled task will be triggered at a recurring interval, it is your own responsibility to implement a
+     * logic of executing or not based on how long it's been since the last execution.
+     * Please look at the aws-scheduling module for an example of how to setup a CRON using AWS Event Bridge with Pristine's listeners.
+     * @param scheduledTasks The scheduled tasks to run. All services with the tag ServiceDefinitionTagEnum.ScheduledTask will be automatically injected here.
+     * @param logHandler The log handler to use to output logs.
+     */
     constructor(scheduledTasks, logHandler) {
         this.scheduledTasks = scheduledTasks;
         this.logHandler = logHandler;
@@ -38,7 +56,7 @@ let SchedulerManager = class SchedulerManager {
                 this.scheduledTasks.forEach(scheduledTask => {
                     promises.push(scheduledTask.run());
                 });
-                this.logHandler.debug("Completed the execution of the tasks.", { scheduledTasks: this.scheduledTasks }, SchedulingModuleKeyname);
+                this.logHandler.debug("Completed triggering all the tasks.", { scheduledTasks: this.scheduledTasks }, SchedulingModuleKeyname);
                 Promise.allSettled(promises).then(results => {
                     results.forEach(result => {
                         if (result.status === 'fulfilled') {

package/dist/lib/esm/managers/scheduler.manager.js.map

@@ -1 +1 @@
-{"version":3,"file":"scheduler.manager.js","sourceRoot":"","sources":["../../../../src/managers/scheduler.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAEvD,OAAO,EAAC,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAOrE,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IACzB,YAAgF,cAAwC,EAC5D,UAA+B;QADX,mBAAc,GAAd,cAAc,CAA0B;QAC5D,eAAU,GAAV,UAAU,CAAqB;IAC3F,CAAC;IAED;;OAEG;IACG,QAAQ;;YACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sCAAsC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,uBAAuB,CAAC,CAAC;YAE9H,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBACzB,MAAM,QAAQ,GAAoB,EAAE,CAAC;gBAErC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;oBACxC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,uCAAuC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,uBAAuB,CAAC,CAAC;gBAE/H,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;oBACxC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;wBACrB,IAAG,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE;4BAC9B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAC,MAAM,EAAC,EAAE,uBAAuB,CAAC,CAAA;yBACvF;6BACI;4BACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;gCAC1C,MAAM,EAAE;oCACJ,MAAM,EAAE,MAAM,CAAC,MAAM;oCACrB,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,EAAE;iCAC7B;6BACJ,EAAE,uBAAuB,CAAC,CAAA;yBAC9B;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,OAAO,EAAE,CAAC;gBACrB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAA;QACN,CAAC;KAAA;CACJ,CAAA;AAvCY,gBAAgB;IAH5B,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,oBAAoB,CAAC;IACzB,UAAU,EAAE;IAEI,WAAA,SAAS,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAA;IACjD,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GAFjC,gBAAgB,CAuC5B;SAvCY,gBAAgB"}
+{"version":3,"file":"scheduler.manager.js","sourceRoot":"","sources":["../../../../src/managers/scheduler.manager.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAC,UAAU,EAAE,SAAS,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAEvD,OAAO,EAAC,YAAY,EAAE,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAC,uBAAuB,EAAC,MAAM,8BAA8B,CAAC;AAIrE;;;;;;;;GAQG;AAIH,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAEzB;;;;;;;;OAQG;IACH,YAAgF,cAAwC,EAC5D,UAA+B;QADX,mBAAc,GAAd,cAAc,CAA0B;QAC5D,eAAU,GAAV,UAAU,CAAqB;IAC3F,CAAC;IAED;;OAEG;IACG,QAAQ;;YACV,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sCAAsC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,uBAAuB,CAAC,CAAC;YAE9H,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBACzB,MAAM,QAAQ,GAAoB,EAAE,CAAC;gBAErC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;oBACxC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,CAAC,CAAC;gBACvC,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,qCAAqC,EAAE,EAAC,cAAc,EAAE,IAAI,CAAC,cAAc,EAAC,EAAE,uBAAuB,CAAC,CAAC;gBAE7H,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;oBACxC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;wBACrB,IAAG,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE;4BAC9B,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,0BAA0B,EAAE,EAAC,MAAM,EAAC,EAAE,uBAAuB,CAAC,CAAA;yBACvF;6BACI;4BACD,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,sBAAsB,EAAE;gCAC1C,MAAM,EAAE;oCACJ,MAAM,EAAE,MAAM,CAAC,MAAM;oCACrB,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,EAAE;iCAC7B;6BACJ,EAAE,uBAAuB,CAAC,CAAA;yBAC9B;oBACL,CAAC,CAAC,CAAC;oBAEH,OAAO,OAAO,EAAE,CAAC;gBACrB,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAA;QACN,CAAC;KAAA;CACJ,CAAA;AAjDY,gBAAgB;IAH5B,YAAY,CAAC,uBAAuB,CAAC;IACrC,GAAG,CAAC,oBAAoB,CAAC;IACzB,UAAU,EAAE;IAYI,WAAA,SAAS,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAA;IACjD,WAAA,MAAM,CAAC,qBAAqB,CAAC,CAAA;;GAZjC,gBAAgB,CAiD5B;SAjDY,gBAAgB"}

package/dist/lib/esm/scheduling.module.js

@@ -1,6 +1,5 @@
 import { LoggingModule } from "@pristine-ts/logging";
 import { SchedulingModuleKeyname } from "./scheduling.module.keyname";
-import { EventModule } from "@pristine-ts/event";
 import { CoreModule } from "@pristine-ts/core";
 export * from "./interfaces/interfaces";
 export * from "./managers/managers";
@@ -9,7 +8,6 @@ export const SchedulingModule = {
     keyname: SchedulingModuleKeyname,
     importModules: [
         LoggingModule,
-        EventModule,
         CoreModule,
     ],
     providerRegistrations: [],

package/dist/lib/esm/scheduling.module.js.map

@@ -1 +1 @@
-{"version":3,"file":"scheduling.module.js","sourceRoot":"","sources":["../../../src/scheduling.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAC,WAAW,EAAC,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAE7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAE9B,MAAM,CAAC,MAAM,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,uBAAuB;IAChC,aAAa,EAAE;QACX,aAAa;QACb,WAAW;QACX,UAAU;KACb;IACD,qBAAqB,EAAE,EAAE;IACzB,wBAAwB,EAAE,EACzB;CAEJ,CAAA"}
+{"version":3,"file":"scheduling.module.js","sourceRoot":"","sources":["../../../src/scheduling.module.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,aAAa,EAAC,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAC,uBAAuB,EAAC,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAC;AAE7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAE9B,MAAM,CAAC,MAAM,gBAAgB,GAAoB;IAC7C,OAAO,EAAE,uBAAuB;IAChC,aAAa,EAAE;QACX,aAAa;QACb,UAAU;KACb;IACD,qBAAqB,EAAE,EAAE;IACzB,wBAAwB,EAAE,EACzB;CAEJ,CAAA"}

package/dist/lib/esm/tasks/default.task.js

@@ -15,6 +15,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import { injectable } from "tsyringe";
 import { ServiceDefinitionTagEnum, tag } from "@pristine-ts/common";
+/**
+ * The default task is here so that there is at least one service with the ServiceDefinitionTagEnum.ScheduledTask.
+ * It does not do anything.
+ * Until there's a fix for: https://github.com/microsoft/tsyringe/issues/63
+ */
 let DefaultTask = class DefaultTask {
     run() {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/lib/esm/tasks/default.task.js.map

@@ -1 +1 @@
-{"version":3,"file":"default.task.js","sourceRoot":"","sources":["../../../../src/tasks/default.task.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACpC,OAAO,EAAC,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAIlE,IAAa,WAAW,GAAxB,MAAa,WAAW;IACd,GAAG;;QACT,CAAC;KAAA;CACJ,CAAA;AAHY,WAAW;IAFvB,UAAU,EAAE;IACZ,GAAG,CAAC,wBAAwB,CAAC,aAAa,CAAC;GAC/B,WAAW,CAGvB;SAHY,WAAW"}
+{"version":3,"file":"default.task.js","sourceRoot":"","sources":["../../../../src/tasks/default.task.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,OAAO,EAAC,UAAU,EAAC,MAAM,UAAU,CAAC;AACpC,OAAO,EAAC,wBAAwB,EAAE,GAAG,EAAC,MAAM,qBAAqB,CAAC;AAElE;;;;GAIG;AAGH,IAAa,WAAW,GAAxB,MAAa,WAAW;IACd,GAAG;;QACT,CAAC;KAAA;CACJ,CAAA;AAHY,WAAW;IAFvB,UAAU,EAAE;IACZ,GAAG,CAAC,wBAAwB,CAAC,aAAa,CAAC;GAC/B,WAAW,CAGvB;SAHY,WAAW"}

package/dist/types/interfaces/scheduled-task.interface.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This interface defines what a Scheduled task should implement.
+ */
 export interface ScheduledTaskInterface {
+    /**
+     * This method runs the actual task.
+     */
     run(): Promise<void>;
 }

package/dist/types/interfaces/scheduler.interface.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This interface defines what a Scheduler should implement.
+ */
 export interface SchedulerInterface {
+    /**
+     * This method runs all the tasks that were registered.
+     */
     runTasks(): Promise<void>;
 }

package/dist/types/managers/scheduler.manager.d.ts

@@ -1,9 +1,27 @@
 import { ScheduledTaskInterface } from "../interfaces/scheduled-task.interface";
 import { SchedulerInterface } from "../interfaces/scheduler.interface";
 import { LogHandlerInterface } from "@pristine-ts/logging";
+/**
+ * The Scheduler Manager runs the scheduled tasks.A scheduled task cannot specify the interval at which it wants to be triggered.
+ * It's only a mechanism to understand that must be triggered by a CRON.
+ * When used with a CRON, a scheduled task will be triggered at a recurring interval, it is your own responsibility to implement a
+ * logic of executing or not based on how long it's been since the last execution.
+ * Please look at the aws-scheduling module for an example of how to setup a CRON using AWS Event Bridge with Pristine's listeners.
+ * It is tagged so it can be injected using SchedulerInterface.
+ * It is module scoped to the scheduling module.
+ */
 export declare class SchedulerManager implements SchedulerInterface {
     private readonly scheduledTasks;
     private readonly logHandler;
+    /**
+     * The Scheduler Manager runs the scheduled tasks.A scheduled task cannot specify the interval at which it wants to be triggered.
+     * It's only a mechanism to understand that must be triggered by a CRON.
+     * When used with a CRON, a scheduled task will be triggered at a recurring interval, it is your own responsibility to implement a
+     * logic of executing or not based on how long it's been since the last execution.
+     * Please look at the aws-scheduling module for an example of how to setup a CRON using AWS Event Bridge with Pristine's listeners.
+     * @param scheduledTasks The scheduled tasks to run. All services with the tag ServiceDefinitionTagEnum.ScheduledTask will be automatically injected here.
+     * @param logHandler The log handler to use to output logs.
+     */
     constructor(scheduledTasks: ScheduledTaskInterface[], logHandler: LogHandlerInterface);
     /**
      * This method runs all the tasks that were registered.

package/dist/types/tasks/default.task.d.ts

@@ -1,4 +1,9 @@
 import { ScheduledTaskInterface } from "../interfaces/scheduled-task.interface";
+/**
+ * The default task is here so that there is at least one service with the ServiceDefinitionTagEnum.ScheduledTask.
+ * It does not do anything.
+ * Until there's a fix for: https://github.com/microsoft/tsyringe/issues/63
+ */
 export declare class DefaultTask implements ScheduledTaskInterface {
     run(): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pristine-ts/scheduling",
-  "version": "0.0.173",
+  "version": "0.0.177",
   "description": "",
   "module": "dist/lib/esm/scheduling.module.js",
   "main": "dist/lib/cjs/scheduling.module.js",
@@ -19,10 +19,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@pristine-ts/common": "^0.0.173",
-    "@pristine-ts/core": "^0.0.173",
-    "@pristine-ts/event": "^0.0.173",
-    "@pristine-ts/logging": "^0.0.173"
+    "@pristine-ts/common": "^0.0.177",
+    "@pristine-ts/core": "^0.0.177",
+    "@pristine-ts/logging": "^0.0.177"
   },
   "jest": {
     "transform": {
@@ -58,5 +57,5 @@
       "src/*.{js,ts}"
     ]
   },
-  "gitHead": "9c4e43f029a4e7ed49adb0f183ee56502dde3253"
+  "gitHead": "814886bbf3c28c5588cbd5f7bb9a2d5e323d6850"
 }