@kingsworld/plugin-cron 1.3.0 → 1.4.0

package/README.md

@@ -23,7 +23,7 @@ new SapphireClient({
     ...otherClientOptions,
     cron: {
         // the cron object is optional
-        defaultTimezone: "Europe/London", // the cron pacakge defaults to UTC
+        defaultTimezone: "Europe/London", // the cron package defaults to UTC
     },
 });
 ```

package/dist/cjs/index.cjs

@@ -6,7 +6,7 @@ var CronTaskStore_cjs = require('./lib/structures/CronTaskStore.cjs');
 var CronTaskTypes_cjs = require('./lib/types/CronTaskTypes.cjs');
 
 // src/index.ts
-var version = "1.3.0";
+var version = "1.4.0";
 
 exports.version = version;
 Object.keys(CronTaskHandler_cjs).forEach(function (k) {

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";AAIA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAwBP,IAAM,UAAkB","sourcesContent":["import type { CronTaskStore } from \"./lib/structures/CronTaskStore\";\nimport type { CronTaskHandler } from \"./lib/CronTaskHandler\";\nimport type { CronTaskHandlerOptions } from \"./lib/types/CronTaskTypes\";\n\nexport * from \"./lib/CronTaskHandler\";\nexport * from \"./lib/structures/CronTask\";\nexport * from \"./lib/structures/CronTaskStore\";\nexport * from \"./lib/types/CronTaskTypes\";\n\ndeclare module \"@sapphire/pieces\" {\n    interface Container {\n        cron: CronTaskHandler;\n    }\n\n    interface StoreRegistryEntries {\n        \"cron-tasks\": CronTaskStore;\n    }\n}\n\ndeclare module \"discord.js\" {\n    export interface ClientOptions {\n        cron?: CronTaskHandlerOptions;\n    }\n}\n\n/**\n * The [@kingsworld/plugin-cron](https://github.com/Kings-World/sapphire-plugins/tree/main/packages/cron) version that you are currently using.\n * An example use of this is showing it of in a bot information command.\n *\n * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild\n */\nexport const version: string = '1.3.0';\n"]}
+{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";AAIA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAwBP,IAAM,UAAkB","sourcesContent":["import type { CronTaskStore } from \"./lib/structures/CronTaskStore\";\nimport type { CronTaskHandler } from \"./lib/CronTaskHandler\";\nimport type { CronTaskHandlerOptions } from \"./lib/types/CronTaskTypes\";\n\nexport * from \"./lib/CronTaskHandler\";\nexport * from \"./lib/structures/CronTask\";\nexport * from \"./lib/structures/CronTaskStore\";\nexport * from \"./lib/types/CronTaskTypes\";\n\ndeclare module \"@sapphire/pieces\" {\n    interface Container {\n        cron: CronTaskHandler;\n    }\n\n    interface StoreRegistryEntries {\n        \"cron-tasks\": CronTaskStore;\n    }\n}\n\ndeclare module \"discord.js\" {\n    export interface ClientOptions {\n        cron?: CronTaskHandlerOptions;\n    }\n}\n\n/**\n * The [@kingsworld/plugin-cron](https://github.com/Kings-World/sapphire-plugins/tree/main/packages/cron) version that you are currently using.\n * An example use of this is showing it of in a bot information command.\n *\n * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild\n */\nexport const version: string = \"1.4.0\";\n"]}

package/dist/cjs/{index.d.ts → index.d.cts}

@@ -1,9 +1,23 @@
 import { Piece, Store } from '@sapphire/pieces';
 import { CronJobParams, CronJob } from 'cron';
 import { Awaitable } from '@sapphire/framework';
+import Sentry from '@sentry/node';
 
 interface CronTaskHandlerOptions {
+    /**
+     * The default timezone to use for all cron tasks.
+     * You can override this per task, using the timeZone option.
+     * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     * @default "UTC"
+     */
     defaultTimezone?: string;
+    /**
+     * The Sentry instance to use for instrumenting cron jobs.
+     * If you don't use Sentry, you can ignore this option.
+     * @see https://docs.sentry.io/product/crons/
+     * @default undefined
+     */
+    sentry?: typeof Sentry;
 }
 type CronJobOptions = Omit<CronJobParams<null, CronTask>, "onTick" | "onComplete" | "start" | "context" | "utcOffset">;
 
@@ -35,6 +49,7 @@ declare class CronTaskStore extends Store<CronTask, "cron-tasks"> {
 
 declare class CronTaskHandler {
     defaultTimezone?: CronTaskHandlerOptions["defaultTimezone"];
+    sentry?: CronTaskHandlerOptions["sentry"];
     constructor(options?: CronTaskHandlerOptions);
     startAll(): void;
     stopAll(): void;

package/dist/cjs/lib/CronTaskHandler.cjs

@@ -12,7 +12,9 @@ var __publicField = (obj, key, value) => {
 var _CronTaskHandler = class _CronTaskHandler {
   constructor(options) {
     __publicField(this, "defaultTimezone");
+    __publicField(this, "sentry");
     this.defaultTimezone = options?.defaultTimezone;
+    this.sentry = options?.sentry;
   }
   startAll() {
     this.store.startAll();

package/dist/cjs/lib/CronTaskHandler.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/CronTaskHandler.ts"],"names":[],"mappings":";;;;;;;;;AAAA,SAAS,iBAAiB;AAGnB,IAAM,mBAAN,MAAM,iBAAgB;AAAA,EAGzB,YAAY,SAAkC;AAF9C;AAGI,SAAK,kBAAkB,SAAS;AAAA,EACpC;AAAA,EAEA,WAAW;AACP,SAAK,MAAM,SAAS;AAAA,EACxB;AAAA,EAEA,UAAU;AACN,SAAK,MAAM,QAAQ;AAAA,EACvB;AAAA,EAEA,IAAY,QAAQ;AAChB,WAAO,UAAU,OAAO,IAAI,YAAY;AAAA,EAC5C;AACJ;AAlB6B;AAAtB,IAAM,kBAAN","sourcesContent":["import { container } from \"@sapphire/framework\";\nimport type { CronTaskHandlerOptions } from \"./types/CronTaskTypes\";\n\nexport class CronTaskHandler {\n    defaultTimezone?: CronTaskHandlerOptions[\"defaultTimezone\"];\n\n    constructor(options?: CronTaskHandlerOptions) {\n        this.defaultTimezone = options?.defaultTimezone;\n    }\n\n    startAll() {\n        this.store.startAll();\n    }\n\n    stopAll() {\n        this.store.stopAll();\n    }\n\n    private get store() {\n        return container.stores.get(\"cron-tasks\");\n    }\n}\n"]}
+{"version":3,"sources":["../../../src/lib/CronTaskHandler.ts"],"names":[],"mappings":";;;;;;;;;AAAA,SAAS,iBAAiB;AAGnB,IAAM,mBAAN,MAAM,iBAAgB;AAAA,EAIzB,YAAY,SAAkC;AAH9C;AACA;AAGI,SAAK,kBAAkB,SAAS;AAChC,SAAK,SAAS,SAAS;AAAA,EAC3B;AAAA,EAEA,WAAW;AACP,SAAK,MAAM,SAAS;AAAA,EACxB;AAAA,EAEA,UAAU;AACN,SAAK,MAAM,QAAQ;AAAA,EACvB;AAAA,EAEA,IAAY,QAAQ;AAChB,WAAO,UAAU,OAAO,IAAI,YAAY;AAAA,EAC5C;AACJ;AApB6B;AAAtB,IAAM,kBAAN","sourcesContent":["import { container } from \"@sapphire/framework\";\nimport type { CronTaskHandlerOptions } from \"./types/CronTaskTypes\";\n\nexport class CronTaskHandler {\n    defaultTimezone?: CronTaskHandlerOptions[\"defaultTimezone\"];\n    sentry?: CronTaskHandlerOptions[\"sentry\"];\n\n    constructor(options?: CronTaskHandlerOptions) {\n        this.defaultTimezone = options?.defaultTimezone;\n        this.sentry = options?.sentry;\n    }\n\n    startAll() {\n        this.store.startAll();\n    }\n\n    stopAll() {\n        this.store.stopAll();\n    }\n\n    private get store() {\n        return container.stores.get(\"cron-tasks\");\n    }\n}\n"]}

package/dist/cjs/lib/structures/CronTaskStore.cjs

@@ -34,13 +34,15 @@ var _CronTaskStore = class _CronTaskStore extends pieces.Store {
   }
   set(key, value) {
     const options = value.options;
+    const { sentry, defaultTimezone } = this.container.cron;
+    const cronJob = sentry ? sentry.cron.instrumentCron(cron.CronJob, key) : cron.CronJob;
     try {
-      value.job = cron.CronJob.from({
+      value.job = cronJob.from({
         ...options,
         onTick: () => void value.run.bind(value)(),
         start: false,
         context: value,
-        timeZone: options.timeZone ?? this.container.cron.defaultTimezone
+        timeZone: options.timeZone ?? defaultTimezone
       });
     } catch (error) {
       value.error(

package/dist/cjs/lib/structures/CronTaskStore.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;;AAAA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,eAAe;AAEjB,IAAM,iBAAN,MAAM,uBAAsB,MAA8B;AAAA,EAC7D,cAAc;AACV,UAAM,UAAU,EAAE,MAAM,aAAa,CAAC;AAAA,EAC1C;AAAA,EAEA,WAAW;AACP,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK;AAAS;AACnB,WAAK,IAAI,MAAM;AAAA,IACnB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAEA,UAAU;AACN,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK,IAAI;AAAS;AACvB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAES,IAAI,KAAa,OAAuB;AAC7C,UAAM,UAAU,MAAM;AAEtB,QAAI;AACA,YAAM,MAAM,QAAQ,KAAK;AAAA,QACrB,GAAG;AAAA,QACH,QAAQ,MAAM,KAAK,MAAM,IAAI,KAAK,KAAK,EAAE;AAAA,QACzC,OAAO;AAAA,QACP,SAAS;AAAA,QACT,UACI,QAAQ,YAAY,KAAK,UAAU,KAAK;AAAA,MAChD,CAAC;AAAA,IACL,SAAS,OAAO;AACZ,YAAM;AAAA,QACF;AAAA,QACA;AAAA,MACJ;AACA,YAAM,OAAO;AAAA,IACjB;AAEA,WAAO,MAAM,IAAI,KAAK,KAAK;AAAA,EAC/B;AAAA,EAES,OAAO,KAAa;AACzB,UAAM,OAAO,KAAK,IAAI,GAAG;AACzB,QAAI,MAAM,IAAI,SAAS;AACnB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,WAAO,MAAM,OAAO,GAAG;AAAA,EAC3B;AAAA,EAES,QAAQ;AACb,SAAK,QAAQ;AACb,WAAO,MAAM,MAAM;AAAA,EACvB;AACJ;AAjEiE;AAA1D,IAAM,gBAAN","sourcesContent":["import { Store } from \"@sapphire/pieces\";\nimport { CronTask } from \"./CronTask\";\nimport { CronJob } from \"cron\";\n\nexport class CronTaskStore extends Store<CronTask, \"cron-tasks\"> {\n    constructor() {\n        super(CronTask, { name: \"cron-tasks\" });\n    }\n\n    startAll() {\n        for (const task of this.values()) {\n            if (!task.enabled) continue;\n            task.job.start();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [START] Started all cronjob tasks.`\n        );\n        return this;\n    }\n\n    stopAll() {\n        for (const task of this.values()) {\n            if (!task.job.running) continue;\n            task.job.stop();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`\n        );\n        return this;\n    }\n\n    override set(key: string, value: CronTask): this {\n        const options = value.options;\n\n        try {\n            value.job = CronJob.from({\n                ...options,\n                onTick: () => void value.run.bind(value)(),\n                start: false,\n                context: value,\n                timeZone:\n                    options.timeZone ?? this.container.cron.defaultTimezone,\n            });\n        } catch (error) {\n            value.error(\n                \"Encountered an error while creating the cron job\",\n                error\n            );\n            value.unload();\n        }\n\n        return super.set(key, value);\n    }\n\n    override delete(key: string) {\n        const task = this.get(key);\n        if (task?.job.running) {\n            task.job.stop();\n        }\n\n        return super.delete(key);\n    }\n\n    override clear() {\n        this.stopAll();\n        return super.clear();\n    }\n}\n"]}
+{"version":3,"sources":["../../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;;AAAA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,eAAe;AAEjB,IAAM,iBAAN,MAAM,uBAAsB,MAA8B;AAAA,EAC7D,cAAc;AACV,UAAM,UAAU,EAAE,MAAM,aAAa,CAAC;AAAA,EAC1C;AAAA,EAEA,WAAW;AACP,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK;AAAS;AACnB,WAAK,IAAI,MAAM;AAAA,IACnB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAEA,UAAU;AACN,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK,IAAI;AAAS;AACvB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAES,IAAI,KAAa,OAAuB;AAC7C,UAAM,UAAU,MAAM;AAEtB,UAAM,EAAE,QAAQ,gBAAgB,IAAI,KAAK,UAAU;AACnD,UAAM,UAAU,SACV,OAAO,KAAK,eAAe,SAAS,GAAG,IACvC;AAEN,QAAI;AACA,YAAM,MAAM,QAAQ,KAAK;AAAA,QACrB,GAAG;AAAA,QACH,QAAQ,MAAM,KAAK,MAAM,IAAI,KAAK,KAAK,EAAE;AAAA,QACzC,OAAO;AAAA,QACP,SAAS;AAAA,QACT,UAAU,QAAQ,YAAY;AAAA,MAClC,CAAC;AAAA,IACL,SAAS,OAAO;AACZ,YAAM;AAAA,QACF;AAAA,QACA;AAAA,MACJ;AACA,YAAM,OAAO;AAAA,IACjB;AAEA,WAAO,MAAM,IAAI,KAAK,KAAK;AAAA,EAC/B;AAAA,EAES,OAAO,KAAa;AACzB,UAAM,OAAO,KAAK,IAAI,GAAG;AACzB,QAAI,MAAM,IAAI,SAAS;AACnB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,WAAO,MAAM,OAAO,GAAG;AAAA,EAC3B;AAAA,EAES,QAAQ;AACb,SAAK,QAAQ;AACb,WAAO,MAAM,MAAM;AAAA,EACvB;AACJ;AArEiE;AAA1D,IAAM,gBAAN","sourcesContent":["import { Store } from \"@sapphire/pieces\";\nimport { CronTask } from \"./CronTask\";\nimport { CronJob } from \"cron\";\n\nexport class CronTaskStore extends Store<CronTask, \"cron-tasks\"> {\n    constructor() {\n        super(CronTask, { name: \"cron-tasks\" });\n    }\n\n    startAll() {\n        for (const task of this.values()) {\n            if (!task.enabled) continue;\n            task.job.start();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [START] Started all cronjob tasks.`,\n        );\n        return this;\n    }\n\n    stopAll() {\n        for (const task of this.values()) {\n            if (!task.job.running) continue;\n            task.job.stop();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`,\n        );\n        return this;\n    }\n\n    override set(key: string, value: CronTask): this {\n        const options = value.options;\n\n        const { sentry, defaultTimezone } = this.container.cron;\n        const cronJob = sentry\n            ? sentry.cron.instrumentCron(CronJob, key)\n            : CronJob;\n\n        try {\n            value.job = cronJob.from({\n                ...options,\n                onTick: () => void value.run.bind(value)(),\n                start: false,\n                context: value,\n                timeZone: options.timeZone ?? defaultTimezone,\n            });\n        } catch (error) {\n            value.error(\n                \"Encountered an error while creating the cron job\",\n                error,\n            );\n            value.unload();\n        }\n\n        return super.set(key, value);\n    }\n\n    override delete(key: string) {\n        const task = this.get(key);\n        if (task?.job.running) {\n            task.job.stop();\n        }\n\n        return super.delete(key);\n    }\n\n    override clear() {\n        this.stopAll();\n        return super.clear();\n    }\n}\n"]}

package/dist/esm/index.d.mts

@@ -1,9 +1,23 @@
 import { Piece, Store } from '@sapphire/pieces';
 import { CronJobParams, CronJob } from 'cron';
 import { Awaitable } from '@sapphire/framework';
+import Sentry from '@sentry/node';
 
 interface CronTaskHandlerOptions {
+    /**
+     * The default timezone to use for all cron tasks.
+     * You can override this per task, using the timeZone option.
+     * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+     * @default "UTC"
+     */
     defaultTimezone?: string;
+    /**
+     * The Sentry instance to use for instrumenting cron jobs.
+     * If you don't use Sentry, you can ignore this option.
+     * @see https://docs.sentry.io/product/crons/
+     * @default undefined
+     */
+    sentry?: typeof Sentry;
 }
 type CronJobOptions = Omit<CronJobParams<null, CronTask>, "onTick" | "onComplete" | "start" | "context" | "utcOffset">;
 
@@ -35,6 +49,7 @@ declare class CronTaskStore extends Store<CronTask, "cron-tasks"> {
 
 declare class CronTaskHandler {
     defaultTimezone?: CronTaskHandlerOptions["defaultTimezone"];
+    sentry?: CronTaskHandlerOptions["sentry"];
     constructor(options?: CronTaskHandlerOptions);
     startAll(): void;
     stopAll(): void;

package/dist/esm/index.mjs

@@ -4,7 +4,7 @@ export * from './lib/structures/CronTask.mjs';
 export * from './lib/structures/CronTaskStore.mjs';
 export * from './lib/types/CronTaskTypes.mjs';
 
-var version = "1.3.0";
+var version = "1.4.0";
 
 export { version };
 //# sourceMappingURL=out.js.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;AAIA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAwBP,IAAM,UAAkB","sourcesContent":["import type { CronTaskStore } from \"./lib/structures/CronTaskStore\";\nimport type { CronTaskHandler } from \"./lib/CronTaskHandler\";\nimport type { CronTaskHandlerOptions } from \"./lib/types/CronTaskTypes\";\n\nexport * from \"./lib/CronTaskHandler\";\nexport * from \"./lib/structures/CronTask\";\nexport * from \"./lib/structures/CronTaskStore\";\nexport * from \"./lib/types/CronTaskTypes\";\n\ndeclare module \"@sapphire/pieces\" {\n    interface Container {\n        cron: CronTaskHandler;\n    }\n\n    interface StoreRegistryEntries {\n        \"cron-tasks\": CronTaskStore;\n    }\n}\n\ndeclare module \"discord.js\" {\n    export interface ClientOptions {\n        cron?: CronTaskHandlerOptions;\n    }\n}\n\n/**\n * The [@kingsworld/plugin-cron](https://github.com/Kings-World/sapphire-plugins/tree/main/packages/cron) version that you are currently using.\n * An example use of this is showing it of in a bot information command.\n *\n * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild\n */\nexport const version: string = '1.3.0';\n"]}
+{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;AAIA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AAwBP,IAAM,UAAkB","sourcesContent":["import type { CronTaskStore } from \"./lib/structures/CronTaskStore\";\nimport type { CronTaskHandler } from \"./lib/CronTaskHandler\";\nimport type { CronTaskHandlerOptions } from \"./lib/types/CronTaskTypes\";\n\nexport * from \"./lib/CronTaskHandler\";\nexport * from \"./lib/structures/CronTask\";\nexport * from \"./lib/structures/CronTaskStore\";\nexport * from \"./lib/types/CronTaskTypes\";\n\ndeclare module \"@sapphire/pieces\" {\n    interface Container {\n        cron: CronTaskHandler;\n    }\n\n    interface StoreRegistryEntries {\n        \"cron-tasks\": CronTaskStore;\n    }\n}\n\ndeclare module \"discord.js\" {\n    export interface ClientOptions {\n        cron?: CronTaskHandlerOptions;\n    }\n}\n\n/**\n * The [@kingsworld/plugin-cron](https://github.com/Kings-World/sapphire-plugins/tree/main/packages/cron) version that you are currently using.\n * An example use of this is showing it of in a bot information command.\n *\n * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild\n */\nexport const version: string = \"1.4.0\";\n"]}

package/dist/esm/lib/CronTaskHandler.mjs

@@ -4,7 +4,9 @@ import { container } from '@sapphire/framework';
 var _CronTaskHandler = class _CronTaskHandler {
   constructor(options) {
     __publicField(this, "defaultTimezone");
+    __publicField(this, "sentry");
     this.defaultTimezone = options?.defaultTimezone;
+    this.sentry = options?.sentry;
   }
   startAll() {
     this.store.startAll();

package/dist/esm/lib/CronTaskHandler.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/lib/CronTaskHandler.ts"],"names":[],"mappings":";;;;;;AAAA,SAAS,iBAAiB;AAGnB,IAAM,mBAAN,MAAM,iBAAgB;AAAA,EAGzB,YAAY,SAAkC;AAF9C;AAGI,SAAK,kBAAkB,SAAS;AAAA,EACpC;AAAA,EAEA,WAAW;AACP,SAAK,MAAM,SAAS;AAAA,EACxB;AAAA,EAEA,UAAU;AACN,SAAK,MAAM,QAAQ;AAAA,EACvB;AAAA,EAEA,IAAY,QAAQ;AAChB,WAAO,UAAU,OAAO,IAAI,YAAY;AAAA,EAC5C;AACJ;AAlB6B;AAAtB,IAAM,kBAAN","sourcesContent":["import { container } from \"@sapphire/framework\";\nimport type { CronTaskHandlerOptions } from \"./types/CronTaskTypes\";\n\nexport class CronTaskHandler {\n    defaultTimezone?: CronTaskHandlerOptions[\"defaultTimezone\"];\n\n    constructor(options?: CronTaskHandlerOptions) {\n        this.defaultTimezone = options?.defaultTimezone;\n    }\n\n    startAll() {\n        this.store.startAll();\n    }\n\n    stopAll() {\n        this.store.stopAll();\n    }\n\n    private get store() {\n        return container.stores.get(\"cron-tasks\");\n    }\n}\n"]}
+{"version":3,"sources":["../../../src/lib/CronTaskHandler.ts"],"names":[],"mappings":";;;;;;AAAA,SAAS,iBAAiB;AAGnB,IAAM,mBAAN,MAAM,iBAAgB;AAAA,EAIzB,YAAY,SAAkC;AAH9C;AACA;AAGI,SAAK,kBAAkB,SAAS;AAChC,SAAK,SAAS,SAAS;AAAA,EAC3B;AAAA,EAEA,WAAW;AACP,SAAK,MAAM,SAAS;AAAA,EACxB;AAAA,EAEA,UAAU;AACN,SAAK,MAAM,QAAQ;AAAA,EACvB;AAAA,EAEA,IAAY,QAAQ;AAChB,WAAO,UAAU,OAAO,IAAI,YAAY;AAAA,EAC5C;AACJ;AApB6B;AAAtB,IAAM,kBAAN","sourcesContent":["import { container } from \"@sapphire/framework\";\nimport type { CronTaskHandlerOptions } from \"./types/CronTaskTypes\";\n\nexport class CronTaskHandler {\n    defaultTimezone?: CronTaskHandlerOptions[\"defaultTimezone\"];\n    sentry?: CronTaskHandlerOptions[\"sentry\"];\n\n    constructor(options?: CronTaskHandlerOptions) {\n        this.defaultTimezone = options?.defaultTimezone;\n        this.sentry = options?.sentry;\n    }\n\n    startAll() {\n        this.store.startAll();\n    }\n\n    stopAll() {\n        this.store.stopAll();\n    }\n\n    private get store() {\n        return container.stores.get(\"cron-tasks\");\n    }\n}\n"]}

package/dist/esm/lib/structures/CronTaskStore.mjs

@@ -31,13 +31,15 @@ var _CronTaskStore = class _CronTaskStore extends Store {
   }
   set(key, value) {
     const options = value.options;
+    const { sentry, defaultTimezone } = this.container.cron;
+    const cronJob = sentry ? sentry.cron.instrumentCron(CronJob, key) : CronJob;
     try {
-      value.job = CronJob.from({
+      value.job = cronJob.from({
         ...options,
         onTick: () => void value.run.bind(value)(),
         start: false,
         context: value,
-        timeZone: options.timeZone ?? this.container.cron.defaultTimezone
+        timeZone: options.timeZone ?? defaultTimezone
       });
     } catch (error) {
       value.error(

package/dist/esm/lib/structures/CronTaskStore.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;;;AAAA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,eAAe;AAEjB,IAAM,iBAAN,MAAM,uBAAsB,MAA8B;AAAA,EAC7D,cAAc;AACV,UAAM,UAAU,EAAE,MAAM,aAAa,CAAC;AAAA,EAC1C;AAAA,EAEA,WAAW;AACP,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK;AAAS;AACnB,WAAK,IAAI,MAAM;AAAA,IACnB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAEA,UAAU;AACN,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK,IAAI;AAAS;AACvB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAES,IAAI,KAAa,OAAuB;AAC7C,UAAM,UAAU,MAAM;AAEtB,QAAI;AACA,YAAM,MAAM,QAAQ,KAAK;AAAA,QACrB,GAAG;AAAA,QACH,QAAQ,MAAM,KAAK,MAAM,IAAI,KAAK,KAAK,EAAE;AAAA,QACzC,OAAO;AAAA,QACP,SAAS;AAAA,QACT,UACI,QAAQ,YAAY,KAAK,UAAU,KAAK;AAAA,MAChD,CAAC;AAAA,IACL,SAAS,OAAO;AACZ,YAAM;AAAA,QACF;AAAA,QACA;AAAA,MACJ;AACA,YAAM,OAAO;AAAA,IACjB;AAEA,WAAO,MAAM,IAAI,KAAK,KAAK;AAAA,EAC/B;AAAA,EAES,OAAO,KAAa;AACzB,UAAM,OAAO,KAAK,IAAI,GAAG;AACzB,QAAI,MAAM,IAAI,SAAS;AACnB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,WAAO,MAAM,OAAO,GAAG;AAAA,EAC3B;AAAA,EAES,QAAQ;AACb,SAAK,QAAQ;AACb,WAAO,MAAM,MAAM;AAAA,EACvB;AACJ;AAjEiE;AAA1D,IAAM,gBAAN","sourcesContent":["import { Store } from \"@sapphire/pieces\";\nimport { CronTask } from \"./CronTask\";\nimport { CronJob } from \"cron\";\n\nexport class CronTaskStore extends Store<CronTask, \"cron-tasks\"> {\n    constructor() {\n        super(CronTask, { name: \"cron-tasks\" });\n    }\n\n    startAll() {\n        for (const task of this.values()) {\n            if (!task.enabled) continue;\n            task.job.start();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [START] Started all cronjob tasks.`\n        );\n        return this;\n    }\n\n    stopAll() {\n        for (const task of this.values()) {\n            if (!task.job.running) continue;\n            task.job.stop();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`\n        );\n        return this;\n    }\n\n    override set(key: string, value: CronTask): this {\n        const options = value.options;\n\n        try {\n            value.job = CronJob.from({\n                ...options,\n                onTick: () => void value.run.bind(value)(),\n                start: false,\n                context: value,\n                timeZone:\n                    options.timeZone ?? this.container.cron.defaultTimezone,\n            });\n        } catch (error) {\n            value.error(\n                \"Encountered an error while creating the cron job\",\n                error\n            );\n            value.unload();\n        }\n\n        return super.set(key, value);\n    }\n\n    override delete(key: string) {\n        const task = this.get(key);\n        if (task?.job.running) {\n            task.job.stop();\n        }\n\n        return super.delete(key);\n    }\n\n    override clear() {\n        this.stopAll();\n        return super.clear();\n    }\n}\n"]}
+{"version":3,"sources":["../../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;;;AAAA,SAAS,aAAa;AACtB,SAAS,gBAAgB;AACzB,SAAS,eAAe;AAEjB,IAAM,iBAAN,MAAM,uBAAsB,MAA8B;AAAA,EAC7D,cAAc;AACV,UAAM,UAAU,EAAE,MAAM,aAAa,CAAC;AAAA,EAC1C;AAAA,EAEA,WAAW;AACP,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK;AAAS;AACnB,WAAK,IAAI,MAAM;AAAA,IACnB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAEA,UAAU;AACN,eAAW,QAAQ,KAAK,OAAO,GAAG;AAC9B,UAAI,CAAC,KAAK,IAAI;AAAS;AACvB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,UAAM;AAAA,MACF,aAAa,KAAK,IAAI;AAAA,IAC1B;AACA,WAAO;AAAA,EACX;AAAA,EAES,IAAI,KAAa,OAAuB;AAC7C,UAAM,UAAU,MAAM;AAEtB,UAAM,EAAE,QAAQ,gBAAgB,IAAI,KAAK,UAAU;AACnD,UAAM,UAAU,SACV,OAAO,KAAK,eAAe,SAAS,GAAG,IACvC;AAEN,QAAI;AACA,YAAM,MAAM,QAAQ,KAAK;AAAA,QACrB,GAAG;AAAA,QACH,QAAQ,MAAM,KAAK,MAAM,IAAI,KAAK,KAAK,EAAE;AAAA,QACzC,OAAO;AAAA,QACP,SAAS;AAAA,QACT,UAAU,QAAQ,YAAY;AAAA,MAClC,CAAC;AAAA,IACL,SAAS,OAAO;AACZ,YAAM;AAAA,QACF;AAAA,QACA;AAAA,MACJ;AACA,YAAM,OAAO;AAAA,IACjB;AAEA,WAAO,MAAM,IAAI,KAAK,KAAK;AAAA,EAC/B;AAAA,EAES,OAAO,KAAa;AACzB,UAAM,OAAO,KAAK,IAAI,GAAG;AACzB,QAAI,MAAM,IAAI,SAAS;AACnB,WAAK,IAAI,KAAK;AAAA,IAClB;AAEA,WAAO,MAAM,OAAO,GAAG;AAAA,EAC3B;AAAA,EAES,QAAQ;AACb,SAAK,QAAQ;AACb,WAAO,MAAM,MAAM;AAAA,EACvB;AACJ;AArEiE;AAA1D,IAAM,gBAAN","sourcesContent":["import { Store } from \"@sapphire/pieces\";\nimport { CronTask } from \"./CronTask\";\nimport { CronJob } from \"cron\";\n\nexport class CronTaskStore extends Store<CronTask, \"cron-tasks\"> {\n    constructor() {\n        super(CronTask, { name: \"cron-tasks\" });\n    }\n\n    startAll() {\n        for (const task of this.values()) {\n            if (!task.enabled) continue;\n            task.job.start();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [START] Started all cronjob tasks.`,\n        );\n        return this;\n    }\n\n    stopAll() {\n        for (const task of this.values()) {\n            if (!task.job.running) continue;\n            task.job.stop();\n        }\n\n        Store.logger?.(\n            `[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`,\n        );\n        return this;\n    }\n\n    override set(key: string, value: CronTask): this {\n        const options = value.options;\n\n        const { sentry, defaultTimezone } = this.container.cron;\n        const cronJob = sentry\n            ? sentry.cron.instrumentCron(CronJob, key)\n            : CronJob;\n\n        try {\n            value.job = cronJob.from({\n                ...options,\n                onTick: () => void value.run.bind(value)(),\n                start: false,\n                context: value,\n                timeZone: options.timeZone ?? defaultTimezone,\n            });\n        } catch (error) {\n            value.error(\n                \"Encountered an error while creating the cron job\",\n                error,\n            );\n            value.unload();\n        }\n\n        return super.set(key, value);\n    }\n\n    override delete(key: string) {\n        const task = this.get(key);\n        if (task?.job.running) {\n            task.job.stop();\n        }\n\n        return super.delete(key);\n    }\n\n    override clear() {\n        this.stopAll();\n        return super.clear();\n    }\n}\n"]}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@kingsworld/plugin-cron",
   "description": "A simple @sapphire/framework plugin that aims to make use of the cron package and allow users to make cron jobs within their Sapphire discord bot.",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "author": "Seren_Modz 21 <seren@kings-world.net>",
   "license": "MIT",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
-  "types": "dist/cjs/index.d.ts",
+  "types": "dist/cjs/index.d.cts",
   "exports": {
     ".": {
       "import": {
@@ -14,7 +14,7 @@
         "default": "./dist/esm/index.mjs"
       },
       "require": {
-        "types": "./dist/cjs/index.d.ts",
+        "types": "./dist/cjs/index.d.cts",
         "default": "./dist/cjs/index.cjs"
       }
     },
@@ -24,7 +24,7 @@
         "default": "./dist/esm/register.mjs"
       },
       "require": {
-        "types": "./dist/cjs/register.d.ts",
+        "types": "./dist/cjs/register.d.cts",
         "default": "./dist/cjs/register.cjs"
       }
     }
@@ -34,22 +34,26 @@
     "./dist/esm/register.mjs"
   ],
   "scripts": {
-    "build": "tsup && yarn build:types",
+    "build": "tsup && yarn build:types && yarn build:rename-cjs-register",
     "build:types": "concurrently \"yarn:build:types:*\"",
-    "build:types:cjs": "rollup-type-bundler -d dist/cjs",
+    "build:types:cjs": "rollup-type-bundler -d dist/cjs -ot .cts",
     "build:types:esm": "rollup-type-bundler -d dist/esm -t .mts",
     "build:types:cleanup": "tsx ../../scripts/clean-register-imports.mts",
+    "build:rename-cjs-register": "tsx ../../scripts/rename-cjs-register.mts",
     "typecheck": "tsc -b src"
   },
   "dependencies": {
     "cron": "^3.1.6"
   },
+  "optionalDependencies": {
+    "@sentry/node": "^7.98.0"
+  },
   "devDependencies": {
-    "@favware/rollup-type-bundler": "^3.2.1",
-    "@types/node": "^20.10.4",
+    "@favware/rollup-type-bundler": "^3.3.0",
+    "@types/node": "^20.11.6",
     "concurrently": "^8.2.2",
     "tsup": "^8.0.1",
-    "tsx": "^4.6.2",
+    "tsx": "^4.7.0",
     "typescript": "^5.3.3"
   },
   "homepage": "https://github.com/Kings-World/sapphire-plugins",