@kingsworld/plugin-cron 1.2.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (58) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/index.cjs +37 -0
  3. package/dist/cjs/index.cjs.map +1 -0
  4. package/dist/cjs/index.d.cts +80 -0
  5. package/dist/cjs/lib/CronTaskHandler.cjs +34 -0
  6. package/dist/cjs/lib/CronTaskHandler.cjs.map +1 -0
  7. package/dist/cjs/lib/structures/CronTask.cjs +47 -0
  8. package/dist/cjs/lib/structures/CronTask.cjs.map +1 -0
  9. package/dist/cjs/lib/structures/CronTaskStore.cjs +73 -0
  10. package/dist/cjs/lib/structures/CronTaskStore.cjs.map +1 -0
  11. package/dist/cjs/lib/types/CronTaskTypes.cjs +4 -0
  12. package/dist/cjs/lib/types/CronTaskTypes.cjs.map +1 -0
  13. package/dist/cjs/register.cjs +36 -0
  14. package/dist/cjs/register.cjs.map +1 -0
  15. package/dist/cjs/register.d.cts +11 -0
  16. package/dist/esm/chunk-6QB3UK4Q.mjs +11 -0
  17. package/dist/esm/chunk-6QB3UK4Q.mjs.map +1 -0
  18. package/dist/esm/index.d.mts +80 -0
  19. package/dist/esm/index.mjs +11 -0
  20. package/dist/esm/index.mjs.map +1 -0
  21. package/dist/esm/lib/CronTaskHandler.mjs +26 -0
  22. package/dist/esm/lib/CronTaskHandler.mjs.map +1 -0
  23. package/dist/esm/lib/structures/CronTask.mjs +44 -0
  24. package/dist/esm/lib/structures/CronTask.mjs.map +1 -0
  25. package/dist/esm/lib/structures/CronTaskStore.mjs +70 -0
  26. package/dist/esm/lib/structures/CronTaskStore.mjs.map +1 -0
  27. package/dist/esm/lib/types/CronTaskTypes.mjs +3 -0
  28. package/dist/esm/lib/types/CronTaskTypes.mjs.map +1 -0
  29. package/dist/esm/register.d.mts +11 -0
  30. package/dist/esm/register.mjs +33 -0
  31. package/dist/esm/register.mjs.map +1 -0
  32. package/package.json +37 -17
  33. package/dist/index.d.ts +0 -21
  34. package/dist/index.d.ts.map +0 -1
  35. package/dist/index.js +0 -8
  36. package/dist/index.js.map +0 -1
  37. package/dist/index.mjs +0 -6
  38. package/dist/lib/CronTaskHandler.d.ts +0 -9
  39. package/dist/lib/CronTaskHandler.d.ts.map +0 -1
  40. package/dist/lib/CronTaskHandler.js +0 -26
  41. package/dist/lib/CronTaskHandler.js.map +0 -1
  42. package/dist/lib/structures/CronTask.d.ts +0 -21
  43. package/dist/lib/structures/CronTask.d.ts.map +0 -1
  44. package/dist/lib/structures/CronTask.js +0 -26
  45. package/dist/lib/structures/CronTask.js.map +0 -1
  46. package/dist/lib/structures/CronTaskStore.d.ts +0 -11
  47. package/dist/lib/structures/CronTaskStore.d.ts.map +0 -1
  48. package/dist/lib/structures/CronTaskStore.js +0 -59
  49. package/dist/lib/structures/CronTaskStore.js.map +0 -1
  50. package/dist/lib/types/CronTaskTypes.d.ts +0 -7
  51. package/dist/lib/types/CronTaskTypes.d.ts.map +0 -1
  52. package/dist/lib/types/CronTaskTypes.js +0 -3
  53. package/dist/lib/types/CronTaskTypes.js.map +0 -1
  54. package/dist/register.d.ts +0 -9
  55. package/dist/register.d.ts.map +0 -1
  56. package/dist/register.js +0 -23
  57. package/dist/register.js.map +0 -1
  58. package/dist/register.mjs +0 -4
package/README.md CHANGED
@@ -23,7 +23,7 @@ new SapphireClient({
23
23
  ...otherClientOptions,
24
24
  cron: {
25
25
  // the cron object is optional
26
- defaultTimezone: "Europe/London", // the cron pacakge defaults to UTC
26
+ defaultTimezone: "Europe/London", // the cron package defaults to UTC
27
27
  },
28
28
  });
29
29
  ```
@@ -0,0 +1,37 @@
1
+ 'use strict';
2
+
3
+ var CronTaskHandler_cjs = require('./lib/CronTaskHandler.cjs');
4
+ var CronTask_cjs = require('./lib/structures/CronTask.cjs');
5
+ var CronTaskStore_cjs = require('./lib/structures/CronTaskStore.cjs');
6
+ var CronTaskTypes_cjs = require('./lib/types/CronTaskTypes.cjs');
7
+
8
+ // src/index.ts
9
+ var version = "1.4.0";
10
+
11
+ exports.version = version;
12
+ Object.keys(CronTaskHandler_cjs).forEach(function (k) {
13
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
14
+ enumerable: true,
15
+ get: function () { return CronTaskHandler_cjs[k]; }
16
+ });
17
+ });
18
+ Object.keys(CronTask_cjs).forEach(function (k) {
19
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
20
+ enumerable: true,
21
+ get: function () { return CronTask_cjs[k]; }
22
+ });
23
+ });
24
+ Object.keys(CronTaskStore_cjs).forEach(function (k) {
25
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
26
+ enumerable: true,
27
+ get: function () { return CronTaskStore_cjs[k]; }
28
+ });
29
+ });
30
+ Object.keys(CronTaskTypes_cjs).forEach(function (k) {
31
+ if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
32
+ enumerable: true,
33
+ get: function () { return CronTaskTypes_cjs[k]; }
34
+ });
35
+ });
36
+ //# sourceMappingURL=out.js.map
37
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +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.4.0\";\n"]}
@@ -0,0 +1,80 @@
1
+ import { Piece, Store } from '@sapphire/pieces';
2
+ import { CronJobParams, CronJob } from 'cron';
3
+ import { Awaitable } from '@sapphire/framework';
4
+ import Sentry from '@sentry/node';
5
+
6
+ interface CronTaskHandlerOptions {
7
+ /**
8
+ * The default timezone to use for all cron tasks.
9
+ * You can override this per task, using the timeZone option.
10
+ * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
11
+ * @default "UTC"
12
+ */
13
+ defaultTimezone?: string;
14
+ /**
15
+ * The Sentry instance to use for instrumenting cron jobs.
16
+ * If you don't use Sentry, you can ignore this option.
17
+ * @see https://docs.sentry.io/product/crons/
18
+ * @default undefined
19
+ */
20
+ sentry?: typeof Sentry;
21
+ }
22
+ type CronJobOptions = Omit<CronJobParams<null, CronTask>, "onTick" | "onComplete" | "start" | "context" | "utcOffset">;
23
+
24
+ declare abstract class CronTask<Options extends CronTask.Options = CronTask.Options> extends Piece<Options, "cron-tasks"> {
25
+ job: CronJob<null, CronTask>;
26
+ constructor(context: CronTask.LoaderContext, options: Options);
27
+ abstract run(): Awaitable<unknown>;
28
+ info(message: string, ...other: unknown[]): void;
29
+ error(message: string, ...other: unknown[]): void;
30
+ warn(message: string, ...other: unknown[]): void;
31
+ debug(message: string, ...other: unknown[]): void;
32
+ trace(message: string, ...other: unknown[]): void;
33
+ }
34
+ declare namespace CronTask {
35
+ type Options = Piece.Options & CronJobOptions;
36
+ /** @deprecated Use {@linkcode LoaderContext} instead. */
37
+ type Context = LoaderContext;
38
+ type LoaderContext = Piece.LoaderContext<"cron-tasks">;
39
+ }
40
+
41
+ declare class CronTaskStore extends Store<CronTask, "cron-tasks"> {
42
+ constructor();
43
+ startAll(): this;
44
+ stopAll(): this;
45
+ set(key: string, value: CronTask): this;
46
+ delete(key: string): boolean;
47
+ clear(): void;
48
+ }
49
+
50
+ declare class CronTaskHandler {
51
+ defaultTimezone?: CronTaskHandlerOptions["defaultTimezone"];
52
+ sentry?: CronTaskHandlerOptions["sentry"];
53
+ constructor(options?: CronTaskHandlerOptions);
54
+ startAll(): void;
55
+ stopAll(): void;
56
+ private get store();
57
+ }
58
+
59
+ declare module "@sapphire/pieces" {
60
+ interface Container {
61
+ cron: CronTaskHandler;
62
+ }
63
+ interface StoreRegistryEntries {
64
+ "cron-tasks": CronTaskStore;
65
+ }
66
+ }
67
+ declare module "discord.js" {
68
+ interface ClientOptions {
69
+ cron?: CronTaskHandlerOptions;
70
+ }
71
+ }
72
+ /**
73
+ * The [@kingsworld/plugin-cron](https://github.com/Kings-World/sapphire-plugins/tree/main/packages/cron) version that you are currently using.
74
+ * An example use of this is showing it of in a bot information command.
75
+ *
76
+ * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild
77
+ */
78
+ declare const version: string;
79
+
80
+ export { type CronJobOptions, CronTask, CronTaskHandler, type CronTaskHandlerOptions, CronTaskStore, version };
@@ -0,0 +1,34 @@
1
+ 'use strict';
2
+
3
+ var framework = require('@sapphire/framework');
4
+
5
+ var __defProp = Object.defineProperty;
6
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
7
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
8
+ var __publicField = (obj, key, value) => {
9
+ __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
10
+ return value;
11
+ };
12
+ var _CronTaskHandler = class _CronTaskHandler {
13
+ constructor(options) {
14
+ __publicField(this, "defaultTimezone");
15
+ __publicField(this, "sentry");
16
+ this.defaultTimezone = options?.defaultTimezone;
17
+ this.sentry = options?.sentry;
18
+ }
19
+ startAll() {
20
+ this.store.startAll();
21
+ }
22
+ stopAll() {
23
+ this.store.stopAll();
24
+ }
25
+ get store() {
26
+ return framework.container.stores.get("cron-tasks");
27
+ }
28
+ };
29
+ __name(_CronTaskHandler, "CronTaskHandler");
30
+ var CronTaskHandler = _CronTaskHandler;
31
+
32
+ exports.CronTaskHandler = CronTaskHandler;
33
+ //# sourceMappingURL=out.js.map
34
+ //# sourceMappingURL=CronTaskHandler.cjs.map
@@ -0,0 +1 @@
1
+ {"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"]}
@@ -0,0 +1,47 @@
1
+ 'use strict';
2
+
3
+ var pieces = require('@sapphire/pieces');
4
+
5
+ var __defProp = Object.defineProperty;
6
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
7
+ var _CronTask = class _CronTask extends pieces.Piece {
8
+ constructor(context, options) {
9
+ super(context, options);
10
+ }
11
+ info(message, ...other) {
12
+ this.container.logger.info(
13
+ `CronTask[${this.name}] ${message}`,
14
+ ...other
15
+ );
16
+ }
17
+ error(message, ...other) {
18
+ this.container.logger.error(
19
+ `CronTask[${this.name}] ${message}`,
20
+ ...other
21
+ );
22
+ }
23
+ warn(message, ...other) {
24
+ this.container.logger.warn(
25
+ `CronTask[${this.name}] ${message}`,
26
+ ...other
27
+ );
28
+ }
29
+ debug(message, ...other) {
30
+ this.container.logger.debug(
31
+ `CronTask[${this.name}] ${message}`,
32
+ ...other
33
+ );
34
+ }
35
+ trace(message, ...other) {
36
+ this.container.logger.trace(
37
+ `CronTask[${this.name}] ${message}`,
38
+ ...other
39
+ );
40
+ }
41
+ };
42
+ __name(_CronTask, "CronTask");
43
+ var CronTask = _CronTask;
44
+
45
+ exports.CronTask = CronTask;
46
+ //# sourceMappingURL=out.js.map
47
+ //# sourceMappingURL=CronTask.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":";;;;AAAA,SAAS,aAAa;AAKf,IAAe,YAAf,MAAe,kBAEZ,MAA6B;AAAA,EAGnC,YAAY,SAAiC,SAAkB;AAC3D,UAAM,SAAS,OAAO;AAAA,EAC1B;AAAA,EAIA,KAAK,YAAoB,OAAkB;AACvC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,MAAM,YAAoB,OAAkB;AACxC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,KAAK,YAAoB,OAAkB;AACvC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,MAAM,YAAoB,OAAkB;AACxC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,MAAM,YAAoB,OAAkB;AACxC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AACJ;AA3CuC;AAFhC,IAAe,WAAf","sourcesContent":["import { Piece } from \"@sapphire/pieces\";\nimport type { CronJob } from \"cron\";\nimport type { CronJobOptions } from \"../types/CronTaskTypes\";\nimport type { Awaitable } from \"@sapphire/framework\";\n\nexport abstract class CronTask<\n Options extends CronTask.Options = CronTask.Options\n> extends Piece<Options, \"cron-tasks\"> {\n declare job: CronJob<null, CronTask>;\n\n constructor(context: CronTask.LoaderContext, options: Options) {\n super(context, options);\n }\n\n abstract run(): Awaitable<unknown>;\n\n info(message: string, ...other: unknown[]) {\n this.container.logger.info(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n error(message: string, ...other: unknown[]) {\n this.container.logger.error(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n warn(message: string, ...other: unknown[]) {\n this.container.logger.warn(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n debug(message: string, ...other: unknown[]) {\n this.container.logger.debug(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n trace(message: string, ...other: unknown[]) {\n this.container.logger.trace(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n}\n\nexport namespace CronTask {\n export type Options = Piece.Options & CronJobOptions;\n /** @deprecated Use {@linkcode LoaderContext} instead. */\n export type Context = LoaderContext;\n export type LoaderContext = Piece.LoaderContext<\"cron-tasks\">;\n}\n"]}
@@ -0,0 +1,73 @@
1
+ 'use strict';
2
+
3
+ var pieces = require('@sapphire/pieces');
4
+ var CronTask_cjs = require('./CronTask.cjs');
5
+ var cron = require('cron');
6
+
7
+ var __defProp = Object.defineProperty;
8
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
9
+ var _CronTaskStore = class _CronTaskStore extends pieces.Store {
10
+ constructor() {
11
+ super(CronTask_cjs.CronTask, { name: "cron-tasks" });
12
+ }
13
+ startAll() {
14
+ for (const task of this.values()) {
15
+ if (!task.enabled)
16
+ continue;
17
+ task.job.start();
18
+ }
19
+ pieces.Store.logger?.(
20
+ `[STORE => ${this.name}] [START] Started all cronjob tasks.`
21
+ );
22
+ return this;
23
+ }
24
+ stopAll() {
25
+ for (const task of this.values()) {
26
+ if (!task.job.running)
27
+ continue;
28
+ task.job.stop();
29
+ }
30
+ pieces.Store.logger?.(
31
+ `[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`
32
+ );
33
+ return this;
34
+ }
35
+ set(key, value) {
36
+ const options = value.options;
37
+ const { sentry, defaultTimezone } = this.container.cron;
38
+ const cronJob = sentry ? sentry.cron.instrumentCron(cron.CronJob, key) : cron.CronJob;
39
+ try {
40
+ value.job = cronJob.from({
41
+ ...options,
42
+ onTick: () => void value.run.bind(value)(),
43
+ start: false,
44
+ context: value,
45
+ timeZone: options.timeZone ?? defaultTimezone
46
+ });
47
+ } catch (error) {
48
+ value.error(
49
+ "Encountered an error while creating the cron job",
50
+ error
51
+ );
52
+ value.unload();
53
+ }
54
+ return super.set(key, value);
55
+ }
56
+ delete(key) {
57
+ const task = this.get(key);
58
+ if (task?.job.running) {
59
+ task.job.stop();
60
+ }
61
+ return super.delete(key);
62
+ }
63
+ clear() {
64
+ this.stopAll();
65
+ return super.clear();
66
+ }
67
+ };
68
+ __name(_CronTaskStore, "CronTaskStore");
69
+ var CronTaskStore = _CronTaskStore;
70
+
71
+ exports.CronTaskStore = CronTaskStore;
72
+ //# sourceMappingURL=out.js.map
73
+ //# sourceMappingURL=CronTaskStore.cjs.map
@@ -0,0 +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,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"]}
@@ -0,0 +1,4 @@
1
+ 'use strict';
2
+
3
+ //# sourceMappingURL=out.js.map
4
+ //# sourceMappingURL=CronTaskTypes.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,36 @@
1
+ 'use strict';
2
+
3
+ var index_cjs = require('./index.cjs');
4
+ var framework = require('@sapphire/framework');
5
+
6
+ var __defProp = Object.defineProperty;
7
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
8
+ var _CronTaskPlugin = class _CronTaskPlugin extends framework.Plugin {
9
+ static [framework.preGenericsInitialization](options) {
10
+ framework.container.cron = new index_cjs.CronTaskHandler(options.cron);
11
+ }
12
+ static [framework.postInitialization]() {
13
+ this.stores.register(new index_cjs.CronTaskStore());
14
+ }
15
+ static [framework.postLogin]() {
16
+ framework.container.cron.startAll();
17
+ }
18
+ };
19
+ __name(_CronTaskPlugin, "CronTaskPlugin");
20
+ var CronTaskPlugin = _CronTaskPlugin;
21
+ framework.SapphireClient.plugins.registerPreGenericsInitializationHook(
22
+ CronTaskPlugin[framework.preGenericsInitialization],
23
+ "Cron-Task-PreGenericsInitialization"
24
+ );
25
+ framework.SapphireClient.plugins.registerPostInitializationHook(
26
+ CronTaskPlugin[framework.postInitialization],
27
+ "Cron-Task-PostInitialization"
28
+ );
29
+ framework.SapphireClient.plugins.registerPostLoginHook(
30
+ CronTaskPlugin[framework.postLogin],
31
+ "Cron-Task-PostLogin"
32
+ );
33
+
34
+ exports.CronTaskPlugin = CronTaskPlugin;
35
+ //# sourceMappingURL=out.js.map
36
+ //# sourceMappingURL=register.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/register.ts"],"names":[],"mappings":";;;;AAAA,OAAO;AAEP;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAEP,SAAS,iBAAiB,qBAAqB;AAExC,IAAM,kBAAN,MAAM,wBAAuB,OAAO;AAAA,EACvC,QAAQ,yBAAyB,EAE7B,SACF;AACE,cAAU,OAAO,IAAI,gBAAgB,QAAQ,IAAI;AAAA,EACrD;AAAA,EAEA,QAAQ,kBAAkB,IAAwB;AAC9C,SAAK,OAAO,SAAS,IAAI,cAAc,CAAC;AAAA,EAC5C;AAAA,EAEA,QAAQ,SAAS,IAAwB;AACrC,cAAU,KAAK,SAAS;AAAA,EAC5B;AACJ;AAf2C;AAApC,IAAM,iBAAN;AAiBP,eAAe,QAAQ;AAAA,EACnB,eAAe,yBAAyB;AAAA,EACxC;AACJ;AAEA,eAAe,QAAQ;AAAA,EACnB,eAAe,kBAAkB;AAAA,EACjC;AACJ;AAEA,eAAe,QAAQ;AAAA,EACnB,eAAe,SAAS;AAAA,EACxB;AACJ","sourcesContent":["import \"./index\";\n\nimport {\n container,\n Plugin,\n postInitialization,\n postLogin,\n preGenericsInitialization,\n SapphireClient,\n} from \"@sapphire/framework\";\nimport type { ClientOptions } from \"discord.js\";\nimport { CronTaskHandler, CronTaskStore } from \"./index\";\n\nexport class CronTaskPlugin extends Plugin {\n static [preGenericsInitialization](\n this: SapphireClient,\n options: ClientOptions\n ) {\n container.cron = new CronTaskHandler(options.cron);\n }\n\n static [postInitialization](this: SapphireClient) {\n this.stores.register(new CronTaskStore());\n }\n\n static [postLogin](this: SapphireClient) {\n container.cron.startAll();\n }\n}\n\nSapphireClient.plugins.registerPreGenericsInitializationHook(\n CronTaskPlugin[preGenericsInitialization],\n \"Cron-Task-PreGenericsInitialization\"\n);\n\nSapphireClient.plugins.registerPostInitializationHook(\n CronTaskPlugin[postInitialization],\n \"Cron-Task-PostInitialization\"\n);\n\nSapphireClient.plugins.registerPostLoginHook(\n CronTaskPlugin[postLogin],\n \"Cron-Task-PostLogin\"\n);\n"]}
@@ -0,0 +1,11 @@
1
+ import './index.js';
2
+ import { Plugin, preGenericsInitialization, SapphireClient, postInitialization, postLogin } from '@sapphire/framework';
3
+ import { ClientOptions } from 'discord.js';
4
+
5
+ declare class CronTaskPlugin extends Plugin {
6
+ static [preGenericsInitialization](this: SapphireClient, options: ClientOptions): void;
7
+ static [postInitialization](this: SapphireClient): void;
8
+ static [postLogin](this: SapphireClient): void;
9
+ }
10
+
11
+ export { CronTaskPlugin };
@@ -0,0 +1,11 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
3
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
4
+ var __publicField = (obj, key, value) => {
5
+ __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
6
+ return value;
7
+ };
8
+
9
+ export { __name, __publicField };
10
+ //# sourceMappingURL=out.js.map
11
+ //# sourceMappingURL=chunk-6QB3UK4Q.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}
@@ -0,0 +1,80 @@
1
+ import { Piece, Store } from '@sapphire/pieces';
2
+ import { CronJobParams, CronJob } from 'cron';
3
+ import { Awaitable } from '@sapphire/framework';
4
+ import Sentry from '@sentry/node';
5
+
6
+ interface CronTaskHandlerOptions {
7
+ /**
8
+ * The default timezone to use for all cron tasks.
9
+ * You can override this per task, using the timeZone option.
10
+ * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
11
+ * @default "UTC"
12
+ */
13
+ defaultTimezone?: string;
14
+ /**
15
+ * The Sentry instance to use for instrumenting cron jobs.
16
+ * If you don't use Sentry, you can ignore this option.
17
+ * @see https://docs.sentry.io/product/crons/
18
+ * @default undefined
19
+ */
20
+ sentry?: typeof Sentry;
21
+ }
22
+ type CronJobOptions = Omit<CronJobParams<null, CronTask>, "onTick" | "onComplete" | "start" | "context" | "utcOffset">;
23
+
24
+ declare abstract class CronTask<Options extends CronTask.Options = CronTask.Options> extends Piece<Options, "cron-tasks"> {
25
+ job: CronJob<null, CronTask>;
26
+ constructor(context: CronTask.LoaderContext, options: Options);
27
+ abstract run(): Awaitable<unknown>;
28
+ info(message: string, ...other: unknown[]): void;
29
+ error(message: string, ...other: unknown[]): void;
30
+ warn(message: string, ...other: unknown[]): void;
31
+ debug(message: string, ...other: unknown[]): void;
32
+ trace(message: string, ...other: unknown[]): void;
33
+ }
34
+ declare namespace CronTask {
35
+ type Options = Piece.Options & CronJobOptions;
36
+ /** @deprecated Use {@linkcode LoaderContext} instead. */
37
+ type Context = LoaderContext;
38
+ type LoaderContext = Piece.LoaderContext<"cron-tasks">;
39
+ }
40
+
41
+ declare class CronTaskStore extends Store<CronTask, "cron-tasks"> {
42
+ constructor();
43
+ startAll(): this;
44
+ stopAll(): this;
45
+ set(key: string, value: CronTask): this;
46
+ delete(key: string): boolean;
47
+ clear(): void;
48
+ }
49
+
50
+ declare class CronTaskHandler {
51
+ defaultTimezone?: CronTaskHandlerOptions["defaultTimezone"];
52
+ sentry?: CronTaskHandlerOptions["sentry"];
53
+ constructor(options?: CronTaskHandlerOptions);
54
+ startAll(): void;
55
+ stopAll(): void;
56
+ private get store();
57
+ }
58
+
59
+ declare module "@sapphire/pieces" {
60
+ interface Container {
61
+ cron: CronTaskHandler;
62
+ }
63
+ interface StoreRegistryEntries {
64
+ "cron-tasks": CronTaskStore;
65
+ }
66
+ }
67
+ declare module "discord.js" {
68
+ interface ClientOptions {
69
+ cron?: CronTaskHandlerOptions;
70
+ }
71
+ }
72
+ /**
73
+ * The [@kingsworld/plugin-cron](https://github.com/Kings-World/sapphire-plugins/tree/main/packages/cron) version that you are currently using.
74
+ * An example use of this is showing it of in a bot information command.
75
+ *
76
+ * Note to Sapphire developers: This needs to explicitly be `string` so it is not typed as the string that gets replaced by esbuild
77
+ */
78
+ declare const version: string;
79
+
80
+ export { type CronJobOptions, CronTask, CronTaskHandler, type CronTaskHandlerOptions, CronTaskStore, version };
@@ -0,0 +1,11 @@
1
+ import './chunk-6QB3UK4Q.mjs';
2
+ export * from './lib/CronTaskHandler.mjs';
3
+ export * from './lib/structures/CronTask.mjs';
4
+ export * from './lib/structures/CronTaskStore.mjs';
5
+ export * from './lib/types/CronTaskTypes.mjs';
6
+
7
+ var version = "1.4.0";
8
+
9
+ export { version };
10
+ //# sourceMappingURL=out.js.map
11
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +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.4.0\";\n"]}
@@ -0,0 +1,26 @@
1
+ import { __name, __publicField } from '../chunk-6QB3UK4Q.mjs';
2
+ import { container } from '@sapphire/framework';
3
+
4
+ var _CronTaskHandler = class _CronTaskHandler {
5
+ constructor(options) {
6
+ __publicField(this, "defaultTimezone");
7
+ __publicField(this, "sentry");
8
+ this.defaultTimezone = options?.defaultTimezone;
9
+ this.sentry = options?.sentry;
10
+ }
11
+ startAll() {
12
+ this.store.startAll();
13
+ }
14
+ stopAll() {
15
+ this.store.stopAll();
16
+ }
17
+ get store() {
18
+ return container.stores.get("cron-tasks");
19
+ }
20
+ };
21
+ __name(_CronTaskHandler, "CronTaskHandler");
22
+ var CronTaskHandler = _CronTaskHandler;
23
+
24
+ export { CronTaskHandler };
25
+ //# sourceMappingURL=out.js.map
26
+ //# sourceMappingURL=CronTaskHandler.mjs.map
@@ -0,0 +1 @@
1
+ {"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"]}
@@ -0,0 +1,44 @@
1
+ import { __name } from '../../chunk-6QB3UK4Q.mjs';
2
+ import { Piece } from '@sapphire/pieces';
3
+
4
+ var _CronTask = class _CronTask extends Piece {
5
+ constructor(context, options) {
6
+ super(context, options);
7
+ }
8
+ info(message, ...other) {
9
+ this.container.logger.info(
10
+ `CronTask[${this.name}] ${message}`,
11
+ ...other
12
+ );
13
+ }
14
+ error(message, ...other) {
15
+ this.container.logger.error(
16
+ `CronTask[${this.name}] ${message}`,
17
+ ...other
18
+ );
19
+ }
20
+ warn(message, ...other) {
21
+ this.container.logger.warn(
22
+ `CronTask[${this.name}] ${message}`,
23
+ ...other
24
+ );
25
+ }
26
+ debug(message, ...other) {
27
+ this.container.logger.debug(
28
+ `CronTask[${this.name}] ${message}`,
29
+ ...other
30
+ );
31
+ }
32
+ trace(message, ...other) {
33
+ this.container.logger.trace(
34
+ `CronTask[${this.name}] ${message}`,
35
+ ...other
36
+ );
37
+ }
38
+ };
39
+ __name(_CronTask, "CronTask");
40
+ var CronTask = _CronTask;
41
+
42
+ export { CronTask };
43
+ //# sourceMappingURL=out.js.map
44
+ //# sourceMappingURL=CronTask.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":";;;;;AAAA,SAAS,aAAa;AAKf,IAAe,YAAf,MAAe,kBAEZ,MAA6B;AAAA,EAGnC,YAAY,SAAiC,SAAkB;AAC3D,UAAM,SAAS,OAAO;AAAA,EAC1B;AAAA,EAIA,KAAK,YAAoB,OAAkB;AACvC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,MAAM,YAAoB,OAAkB;AACxC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,KAAK,YAAoB,OAAkB;AACvC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,MAAM,YAAoB,OAAkB;AACxC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AAAA,EAEA,MAAM,YAAoB,OAAkB;AACxC,SAAK,UAAU,OAAO;AAAA,MAClB,YAAY,KAAK,IAAI,KAAK,OAAO;AAAA,MACjC,GAAG;AAAA,IACP;AAAA,EACJ;AACJ;AA3CuC;AAFhC,IAAe,WAAf","sourcesContent":["import { Piece } from \"@sapphire/pieces\";\nimport type { CronJob } from \"cron\";\nimport type { CronJobOptions } from \"../types/CronTaskTypes\";\nimport type { Awaitable } from \"@sapphire/framework\";\n\nexport abstract class CronTask<\n Options extends CronTask.Options = CronTask.Options\n> extends Piece<Options, \"cron-tasks\"> {\n declare job: CronJob<null, CronTask>;\n\n constructor(context: CronTask.LoaderContext, options: Options) {\n super(context, options);\n }\n\n abstract run(): Awaitable<unknown>;\n\n info(message: string, ...other: unknown[]) {\n this.container.logger.info(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n error(message: string, ...other: unknown[]) {\n this.container.logger.error(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n warn(message: string, ...other: unknown[]) {\n this.container.logger.warn(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n debug(message: string, ...other: unknown[]) {\n this.container.logger.debug(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n\n trace(message: string, ...other: unknown[]) {\n this.container.logger.trace(\n `CronTask[${this.name}] ${message}`,\n ...other\n );\n }\n}\n\nexport namespace CronTask {\n export type Options = Piece.Options & CronJobOptions;\n /** @deprecated Use {@linkcode LoaderContext} instead. */\n export type Context = LoaderContext;\n export type LoaderContext = Piece.LoaderContext<\"cron-tasks\">;\n}\n"]}
@@ -0,0 +1,70 @@
1
+ import { __name } from '../../chunk-6QB3UK4Q.mjs';
2
+ import { Store } from '@sapphire/pieces';
3
+ import { CronTask } from './CronTask.mjs';
4
+ import { CronJob } from 'cron';
5
+
6
+ var _CronTaskStore = class _CronTaskStore extends Store {
7
+ constructor() {
8
+ super(CronTask, { name: "cron-tasks" });
9
+ }
10
+ startAll() {
11
+ for (const task of this.values()) {
12
+ if (!task.enabled)
13
+ continue;
14
+ task.job.start();
15
+ }
16
+ Store.logger?.(
17
+ `[STORE => ${this.name}] [START] Started all cronjob tasks.`
18
+ );
19
+ return this;
20
+ }
21
+ stopAll() {
22
+ for (const task of this.values()) {
23
+ if (!task.job.running)
24
+ continue;
25
+ task.job.stop();
26
+ }
27
+ Store.logger?.(
28
+ `[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`
29
+ );
30
+ return this;
31
+ }
32
+ set(key, value) {
33
+ const options = value.options;
34
+ const { sentry, defaultTimezone } = this.container.cron;
35
+ const cronJob = sentry ? sentry.cron.instrumentCron(CronJob, key) : CronJob;
36
+ try {
37
+ value.job = cronJob.from({
38
+ ...options,
39
+ onTick: () => void value.run.bind(value)(),
40
+ start: false,
41
+ context: value,
42
+ timeZone: options.timeZone ?? defaultTimezone
43
+ });
44
+ } catch (error) {
45
+ value.error(
46
+ "Encountered an error while creating the cron job",
47
+ error
48
+ );
49
+ value.unload();
50
+ }
51
+ return super.set(key, value);
52
+ }
53
+ delete(key) {
54
+ const task = this.get(key);
55
+ if (task?.job.running) {
56
+ task.job.stop();
57
+ }
58
+ return super.delete(key);
59
+ }
60
+ clear() {
61
+ this.stopAll();
62
+ return super.clear();
63
+ }
64
+ };
65
+ __name(_CronTaskStore, "CronTaskStore");
66
+ var CronTaskStore = _CronTaskStore;
67
+
68
+ export { CronTaskStore };
69
+ //# sourceMappingURL=out.js.map
70
+ //# sourceMappingURL=CronTaskStore.mjs.map
@@ -0,0 +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,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"]}
@@ -0,0 +1,3 @@
1
+
2
+ //# sourceMappingURL=out.js.map
3
+ //# sourceMappingURL=CronTaskTypes.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":[],"names":[],"mappings":""}
@@ -0,0 +1,11 @@
1
+ import './index.mjs';
2
+ import { Plugin, preGenericsInitialization, SapphireClient, postInitialization, postLogin } from '@sapphire/framework';
3
+ import { ClientOptions } from 'discord.js';
4
+
5
+ declare class CronTaskPlugin extends Plugin {
6
+ static [preGenericsInitialization](this: SapphireClient, options: ClientOptions): void;
7
+ static [postInitialization](this: SapphireClient): void;
8
+ static [postLogin](this: SapphireClient): void;
9
+ }
10
+
11
+ export { CronTaskPlugin };
@@ -0,0 +1,33 @@
1
+ import { __name } from './chunk-6QB3UK4Q.mjs';
2
+ import { CronTaskHandler, CronTaskStore } from './index.mjs';
3
+ import { SapphireClient, preGenericsInitialization, postInitialization, postLogin, Plugin, container } from '@sapphire/framework';
4
+
5
+ var _CronTaskPlugin = class _CronTaskPlugin extends Plugin {
6
+ static [preGenericsInitialization](options) {
7
+ container.cron = new CronTaskHandler(options.cron);
8
+ }
9
+ static [postInitialization]() {
10
+ this.stores.register(new CronTaskStore());
11
+ }
12
+ static [postLogin]() {
13
+ container.cron.startAll();
14
+ }
15
+ };
16
+ __name(_CronTaskPlugin, "CronTaskPlugin");
17
+ var CronTaskPlugin = _CronTaskPlugin;
18
+ SapphireClient.plugins.registerPreGenericsInitializationHook(
19
+ CronTaskPlugin[preGenericsInitialization],
20
+ "Cron-Task-PreGenericsInitialization"
21
+ );
22
+ SapphireClient.plugins.registerPostInitializationHook(
23
+ CronTaskPlugin[postInitialization],
24
+ "Cron-Task-PostInitialization"
25
+ );
26
+ SapphireClient.plugins.registerPostLoginHook(
27
+ CronTaskPlugin[postLogin],
28
+ "Cron-Task-PostLogin"
29
+ );
30
+
31
+ export { CronTaskPlugin };
32
+ //# sourceMappingURL=out.js.map
33
+ //# sourceMappingURL=register.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/register.ts"],"names":[],"mappings":";;;;;AAAA,OAAO;AAEP;AAAA,EACI;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACG;AAEP,SAAS,iBAAiB,qBAAqB;AAExC,IAAM,kBAAN,MAAM,wBAAuB,OAAO;AAAA,EACvC,QAAQ,yBAAyB,EAE7B,SACF;AACE,cAAU,OAAO,IAAI,gBAAgB,QAAQ,IAAI;AAAA,EACrD;AAAA,EAEA,QAAQ,kBAAkB,IAAwB;AAC9C,SAAK,OAAO,SAAS,IAAI,cAAc,CAAC;AAAA,EAC5C;AAAA,EAEA,QAAQ,SAAS,IAAwB;AACrC,cAAU,KAAK,SAAS;AAAA,EAC5B;AACJ;AAf2C;AAApC,IAAM,iBAAN;AAiBP,eAAe,QAAQ;AAAA,EACnB,eAAe,yBAAyB;AAAA,EACxC;AACJ;AAEA,eAAe,QAAQ;AAAA,EACnB,eAAe,kBAAkB;AAAA,EACjC;AACJ;AAEA,eAAe,QAAQ;AAAA,EACnB,eAAe,SAAS;AAAA,EACxB;AACJ","sourcesContent":["import \"./index\";\n\nimport {\n container,\n Plugin,\n postInitialization,\n postLogin,\n preGenericsInitialization,\n SapphireClient,\n} from \"@sapphire/framework\";\nimport type { ClientOptions } from \"discord.js\";\nimport { CronTaskHandler, CronTaskStore } from \"./index\";\n\nexport class CronTaskPlugin extends Plugin {\n static [preGenericsInitialization](\n this: SapphireClient,\n options: ClientOptions\n ) {\n container.cron = new CronTaskHandler(options.cron);\n }\n\n static [postInitialization](this: SapphireClient) {\n this.stores.register(new CronTaskStore());\n }\n\n static [postLogin](this: SapphireClient) {\n container.cron.startAll();\n }\n}\n\nSapphireClient.plugins.registerPreGenericsInitializationHook(\n CronTaskPlugin[preGenericsInitialization],\n \"Cron-Task-PreGenericsInitialization\"\n);\n\nSapphireClient.plugins.registerPostInitializationHook(\n CronTaskPlugin[postInitialization],\n \"Cron-Task-PostInitialization\"\n);\n\nSapphireClient.plugins.registerPostLoginHook(\n CronTaskPlugin[postLogin],\n \"Cron-Task-PostLogin\"\n);\n"]}
package/package.json CHANGED
@@ -1,39 +1,59 @@
1
1
  {
2
2
  "name": "@kingsworld/plugin-cron",
3
3
  "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.",
4
- "version": "1.2.0",
4
+ "version": "1.4.0",
5
5
  "author": "Seren_Modz 21 <seren@kings-world.net>",
6
6
  "license": "MIT",
7
- "main": "dist/index.js",
8
- "module": "dist/index.mjs",
9
- "types": "dist/index.d.ts",
7
+ "main": "dist/cjs/index.cjs",
8
+ "module": "dist/esm/index.mjs",
9
+ "types": "dist/cjs/index.d.cts",
10
10
  "exports": {
11
11
  ".": {
12
- "import": "./dist/index.mjs",
13
- "require": "./dist/index.js",
14
- "types": "./dist/index.d.ts"
12
+ "import": {
13
+ "types": "./dist/esm/index.d.mts",
14
+ "default": "./dist/esm/index.mjs"
15
+ },
16
+ "require": {
17
+ "types": "./dist/cjs/index.d.cts",
18
+ "default": "./dist/cjs/index.cjs"
19
+ }
15
20
  },
16
21
  "./register": {
17
- "import": "./dist/register.mjs",
18
- "require": "./dist/register.js",
19
- "types": "./dist/register.d.ts"
22
+ "import": {
23
+ "types": "./dist/esm/register.d.mts",
24
+ "default": "./dist/esm/register.mjs"
25
+ },
26
+ "require": {
27
+ "types": "./dist/cjs/register.d.cts",
28
+ "default": "./dist/cjs/register.cjs"
29
+ }
20
30
  }
21
31
  },
22
32
  "sideEffects": [
23
- "./dist/register.js",
24
- "./dist/register.mjs"
33
+ "./dist/cjs/register.cjs",
34
+ "./dist/esm/register.mjs"
25
35
  ],
26
36
  "scripts": {
27
- "build": "tsc && yarn esm:register && yarn esm:default",
28
- "esm:register": "gen-esm-wrapper dist/register.js dist/register.mjs",
29
- "esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs"
37
+ "build": "tsup && yarn build:types && yarn build:rename-cjs-register",
38
+ "build:types": "concurrently \"yarn:build:types:*\"",
39
+ "build:types:cjs": "rollup-type-bundler -d dist/cjs -ot .cts",
40
+ "build:types:esm": "rollup-type-bundler -d dist/esm -t .mts",
41
+ "build:types:cleanup": "tsx ../../scripts/clean-register-imports.mts",
42
+ "build:rename-cjs-register": "tsx ../../scripts/rename-cjs-register.mts",
43
+ "typecheck": "tsc -b src"
30
44
  },
31
45
  "dependencies": {
32
46
  "cron": "^3.1.6"
33
47
  },
48
+ "optionalDependencies": {
49
+ "@sentry/node": "^7.98.0"
50
+ },
34
51
  "devDependencies": {
35
- "@types/node": "^20.10.4",
36
- "gen-esm-wrapper": "^1.1.3",
52
+ "@favware/rollup-type-bundler": "^3.3.0",
53
+ "@types/node": "^20.11.6",
54
+ "concurrently": "^8.2.2",
55
+ "tsup": "^8.0.1",
56
+ "tsx": "^4.7.0",
37
57
  "typescript": "^5.3.3"
38
58
  },
39
59
  "homepage": "https://github.com/Kings-World/sapphire-plugins",
package/dist/index.d.ts DELETED
@@ -1,21 +0,0 @@
1
- import type { CronTaskStore } from "./lib/structures/CronTaskStore";
2
- import type { CronTaskHandler } from "./lib/CronTaskHandler";
3
- import type { CronTaskHandlerOptions } from "./lib/types/CronTaskTypes";
4
- export * from "./lib/CronTaskHandler";
5
- export * from "./lib/structures/CronTask";
6
- export * from "./lib/structures/CronTaskStore";
7
- export * from "./lib/types/CronTaskTypes";
8
- declare module "@sapphire/pieces" {
9
- interface Container {
10
- cron: CronTaskHandler;
11
- }
12
- interface StoreRegistryEntries {
13
- "cron-tasks": CronTaskStore;
14
- }
15
- }
16
- declare module "discord.js" {
17
- interface ClientOptions {
18
- cron?: CronTaskHandlerOptions;
19
- }
20
- }
21
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AAExE,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,2BAA2B,CAAC;AAE1C,OAAO,QAAQ,kBAAkB,CAAC;IAC9B,UAAU,SAAS;QACf,IAAI,EAAE,eAAe,CAAC;KACzB;IAED,UAAU,oBAAoB;QAC1B,YAAY,EAAE,aAAa,CAAC;KAC/B;CACJ;AAED,OAAO,QAAQ,YAAY,CAAC;IACxB,UAAiB,aAAa;QAC1B,IAAI,CAAC,EAAE,sBAAsB,CAAC;KACjC;CACJ"}
package/dist/index.js DELETED
@@ -1,8 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const tslib_1 = require("tslib");
4
- tslib_1.__exportStar(require("./lib/CronTaskHandler"), exports);
5
- tslib_1.__exportStar(require("./lib/structures/CronTask"), exports);
6
- tslib_1.__exportStar(require("./lib/structures/CronTaskStore"), exports);
7
- tslib_1.__exportStar(require("./lib/types/CronTaskTypes"), exports);
8
- //# sourceMappingURL=index.js.map
package/dist/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAIA,gEAAsC;AACtC,oEAA0C;AAC1C,yEAA+C;AAC/C,oEAA0C"}
package/dist/index.mjs DELETED
@@ -1,6 +0,0 @@
1
- import mod from "./index.js";
2
-
3
- export default mod;
4
- export const CronTask = mod.CronTask;
5
- export const CronTaskHandler = mod.CronTaskHandler;
6
- export const CronTaskStore = mod.CronTaskStore;
@@ -1,9 +0,0 @@
1
- import type { CronTaskHandlerOptions } from "./types/CronTaskTypes";
2
- export declare class CronTaskHandler {
3
- defaultTimezone?: CronTaskHandlerOptions["defaultTimezone"];
4
- constructor(options?: CronTaskHandlerOptions);
5
- startAll(): void;
6
- stopAll(): void;
7
- private get store();
8
- }
9
- //# sourceMappingURL=CronTaskHandler.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTaskHandler.d.ts","sourceRoot":"","sources":["../../src/lib/CronTaskHandler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE,qBAAa,eAAe;IACxB,eAAe,CAAC,EAAE,sBAAsB,CAAC,iBAAiB,CAAC,CAAC;gBAEhD,OAAO,CAAC,EAAE,sBAAsB;IAI5C,QAAQ;IAIR,OAAO;IAIP,OAAO,KAAK,KAAK,GAEhB;CACJ"}
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CronTaskHandler = void 0;
4
- const framework_1 = require("@sapphire/framework");
5
- class CronTaskHandler {
6
- constructor(options) {
7
- Object.defineProperty(this, "defaultTimezone", {
8
- enumerable: true,
9
- configurable: true,
10
- writable: true,
11
- value: void 0
12
- });
13
- this.defaultTimezone = options?.defaultTimezone;
14
- }
15
- startAll() {
16
- this.store.startAll();
17
- }
18
- stopAll() {
19
- this.store.stopAll();
20
- }
21
- get store() {
22
- return framework_1.container.stores.get("cron-tasks");
23
- }
24
- }
25
- exports.CronTaskHandler = CronTaskHandler;
26
- //# sourceMappingURL=CronTaskHandler.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTaskHandler.js","sourceRoot":"","sources":["../../src/lib/CronTaskHandler.ts"],"names":[],"mappings":";;;AAAA,mDAAgD;AAGhD,MAAa,eAAe;IAGxB,YAAY,OAAgC;QAF5C;;;;;WAA4D;QAGxD,IAAI,CAAC,eAAe,GAAG,OAAO,EAAE,eAAe,CAAC;IACpD,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1B,CAAC;IAED,OAAO;QACH,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAED,IAAY,KAAK;QACb,OAAO,qBAAS,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;CACJ;AAlBD,0CAkBC"}
@@ -1,21 +0,0 @@
1
- import { Piece } from "@sapphire/pieces";
2
- import type { CronJob } from "cron";
3
- import type { CronJobOptions } from "../types/CronTaskTypes";
4
- import type { Awaitable } from "@sapphire/framework";
5
- export declare abstract class CronTask<Options extends CronTask.Options = CronTask.Options> extends Piece<Options, "cron-tasks"> {
6
- job: CronJob<null, CronTask>;
7
- constructor(context: CronTask.LoaderContext, options: Options);
8
- abstract run(): Awaitable<unknown>;
9
- info(message: string, ...other: unknown[]): void;
10
- error(message: string, ...other: unknown[]): void;
11
- warn(message: string, ...other: unknown[]): void;
12
- debug(message: string, ...other: unknown[]): void;
13
- trace(message: string, ...other: unknown[]): void;
14
- }
15
- export declare namespace CronTask {
16
- type Options = Piece.Options & CronJobOptions;
17
- /** @deprecated Use {@linkcode LoaderContext} instead. */
18
- type Context = LoaderContext;
19
- type LoaderContext = Piece.LoaderContext<"cron-tasks">;
20
- }
21
- //# sourceMappingURL=CronTask.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTask.d.ts","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAErD,8BAAsB,QAAQ,CAC1B,OAAO,SAAS,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CACrD,SAAQ,KAAK,CAAC,OAAO,EAAE,YAAY,CAAC;IAC1B,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;gBAEzB,OAAO,EAAE,QAAQ,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO;IAI7D,QAAQ,CAAC,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC;IAElC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAOzC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAO1C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAOzC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAO1C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;CAM7C;AAED,yBAAiB,QAAQ,CAAC;IACtB,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC;IACrD,yDAAyD;IACzD,KAAY,OAAO,GAAG,aAAa,CAAC;IACpC,KAAY,aAAa,GAAG,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;CACjE"}
@@ -1,26 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CronTask = void 0;
4
- const pieces_1 = require("@sapphire/pieces");
5
- class CronTask extends pieces_1.Piece {
6
- constructor(context, options) {
7
- super(context, options);
8
- }
9
- info(message, ...other) {
10
- this.container.logger.info(`CronTask[${this.name}] ${message}`, ...other);
11
- }
12
- error(message, ...other) {
13
- this.container.logger.error(`CronTask[${this.name}] ${message}`, ...other);
14
- }
15
- warn(message, ...other) {
16
- this.container.logger.warn(`CronTask[${this.name}] ${message}`, ...other);
17
- }
18
- debug(message, ...other) {
19
- this.container.logger.debug(`CronTask[${this.name}] ${message}`, ...other);
20
- }
21
- trace(message, ...other) {
22
- this.container.logger.trace(`CronTask[${this.name}] ${message}`, ...other);
23
- }
24
- }
25
- exports.CronTask = CronTask;
26
- //# sourceMappingURL=CronTask.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTask.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAKzC,MAAsB,QAEpB,SAAQ,cAA4B;IAGlC,YAAY,OAA+B,EAAE,OAAgB;QACzD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAID,IAAI,CAAC,OAAe,EAAE,GAAG,KAAgB;QACrC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CACtB,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CACvB,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,KAAgB;QACrC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CACtB,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CACvB,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CACvB,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EACnC,GAAG,KAAK,CACX,CAAC;IACN,CAAC;CACJ;AA7CD,4BA6CC"}
@@ -1,11 +0,0 @@
1
- import { Store } from "@sapphire/pieces";
2
- import { CronTask } from "./CronTask";
3
- export declare class CronTaskStore extends Store<CronTask, "cron-tasks"> {
4
- constructor();
5
- startAll(): this;
6
- stopAll(): this;
7
- set(key: string, value: CronTask): this;
8
- delete(key: string): boolean;
9
- clear(): void;
10
- }
11
- //# sourceMappingURL=CronTaskStore.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTaskStore.d.ts","sourceRoot":"","sources":["../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,qBAAa,aAAc,SAAQ,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC;;IAK5D,QAAQ;IAYR,OAAO;IAYE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI;IAuBvC,MAAM,CAAC,GAAG,EAAE,MAAM;IASlB,KAAK;CAIjB"}
@@ -1,59 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CronTaskStore = void 0;
4
- const pieces_1 = require("@sapphire/pieces");
5
- const CronTask_1 = require("./CronTask");
6
- const cron_1 = require("cron");
7
- class CronTaskStore extends pieces_1.Store {
8
- constructor() {
9
- super(CronTask_1.CronTask, { name: "cron-tasks" });
10
- }
11
- startAll() {
12
- for (const task of this.values()) {
13
- if (!task.enabled)
14
- continue;
15
- task.job.start();
16
- }
17
- pieces_1.Store.logger?.(`[STORE => ${this.name}] [START] Started all cronjob tasks.`);
18
- return this;
19
- }
20
- stopAll() {
21
- for (const task of this.values()) {
22
- if (!task.job.running)
23
- continue;
24
- task.job.stop();
25
- }
26
- pieces_1.Store.logger?.(`[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`);
27
- return this;
28
- }
29
- set(key, value) {
30
- const options = value.options;
31
- try {
32
- value.job = cron_1.CronJob.from({
33
- ...options,
34
- onTick: () => void value.run.bind(value)(),
35
- start: false,
36
- context: value,
37
- timeZone: options.timeZone ?? this.container.cron.defaultTimezone,
38
- });
39
- }
40
- catch (error) {
41
- value.error("Encountered an error while creating the cron job", error);
42
- value.unload();
43
- }
44
- return super.set(key, value);
45
- }
46
- delete(key) {
47
- const task = this.get(key);
48
- if (task?.job.running) {
49
- task.job.stop();
50
- }
51
- return super.delete(key);
52
- }
53
- clear() {
54
- this.stopAll();
55
- return super.clear();
56
- }
57
- }
58
- exports.CronTaskStore = CronTaskStore;
59
- //# sourceMappingURL=CronTaskStore.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTaskStore.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTaskStore.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,yCAAsC;AACtC,+BAA+B;AAE/B,MAAa,aAAc,SAAQ,cAA6B;IAC5D;QACI,KAAK,CAAC,mBAAQ,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,QAAQ;QACJ,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,SAAS;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QAED,cAAK,CAAC,MAAM,EAAE,CACV,aAAa,IAAI,CAAC,IAAI,sCAAsC,CAC/D,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YAC/B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO;gBAAE,SAAS;YAChC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;QAED,cAAK,CAAC,MAAM,EAAE,CACV,aAAa,IAAI,CAAC,IAAI,qCAAqC,CAC9D,CAAC;QACF,OAAO,IAAI,CAAC;IAChB,CAAC;IAEQ,GAAG,CAAC,GAAW,EAAE,KAAe;QACrC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE9B,IAAI,CAAC;YACD,KAAK,CAAC,GAAG,GAAG,cAAO,CAAC,IAAI,CAAC;gBACrB,GAAG,OAAO;gBACV,MAAM,EAAE,GAAG,EAAE,CAAC,KAAK,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAC1C,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,KAAK;gBACd,QAAQ,EACJ,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;aAC9D,CAAC,CAAC;QACP,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,KAAK,CAAC,KAAK,CACP,kDAAkD,EAClD,KAAK,CACR,CAAC;YACF,KAAK,CAAC,MAAM,EAAE,CAAC;QACnB,CAAC;QAED,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IAEQ,MAAM,CAAC,GAAW;QACvB,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,IAAI,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC;IAEQ,KAAK;QACV,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,KAAK,CAAC,KAAK,EAAE,CAAC;IACzB,CAAC;CACJ;AAjED,sCAiEC"}
@@ -1,7 +0,0 @@
1
- import type { CronJobParams } from "cron";
2
- import type { CronTask } from "../structures/CronTask";
3
- export interface CronTaskHandlerOptions {
4
- defaultTimezone?: string;
5
- }
6
- export type CronJobOptions = Omit<CronJobParams<null, CronTask>, "onTick" | "onComplete" | "start" | "context" | "utcOffset">;
7
- //# sourceMappingURL=CronTaskTypes.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTaskTypes.d.ts","sourceRoot":"","sources":["../../../src/lib/types/CronTaskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,MAAM,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,MAAM,WAAW,sBAAsB;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAC7B,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,CAC9D,CAAC"}
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=CronTaskTypes.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"CronTaskTypes.js","sourceRoot":"","sources":["../../../src/lib/types/CronTaskTypes.ts"],"names":[],"mappings":""}
@@ -1,9 +0,0 @@
1
- import "./index";
2
- import { Plugin, postInitialization, postLogin, preGenericsInitialization, SapphireClient } from "@sapphire/framework";
3
- import type { ClientOptions } from "discord.js";
4
- export declare class CronTaskPlugin extends Plugin {
5
- static [preGenericsInitialization](this: SapphireClient, options: ClientOptions): void;
6
- static [postInitialization](this: SapphireClient): void;
7
- static [postLogin](this: SapphireClient): void;
8
- }
9
- //# sourceMappingURL=register.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AAEjB,OAAO,EAEH,MAAM,EACN,kBAAkB,EAClB,SAAS,EACT,yBAAyB,EACzB,cAAc,EACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAKhD,qBAAa,cAAe,SAAQ,MAAM;IACtC,MAAM,CAAC,CAAC,yBAAyB,CAAC,CAC9B,IAAI,EAAE,cAAc,EACpB,OAAO,EAAE,aAAa;IAK1B,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,cAAc;IAIhD,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,cAAc;CAG1C"}
package/dist/register.js DELETED
@@ -1,23 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CronTaskPlugin = void 0;
4
- require("./index");
5
- const framework_1 = require("@sapphire/framework");
6
- const CronTaskStore_1 = require("./lib/structures/CronTaskStore");
7
- const CronTaskHandler_1 = require("./lib/CronTaskHandler");
8
- class CronTaskPlugin extends framework_1.Plugin {
9
- static [framework_1.preGenericsInitialization](options) {
10
- framework_1.container.cron = new CronTaskHandler_1.CronTaskHandler(options.cron);
11
- }
12
- static [framework_1.postInitialization]() {
13
- this.stores.register(new CronTaskStore_1.CronTaskStore());
14
- }
15
- static [framework_1.postLogin]() {
16
- framework_1.container.cron.startAll();
17
- }
18
- }
19
- exports.CronTaskPlugin = CronTaskPlugin;
20
- framework_1.SapphireClient.plugins.registerPreGenericsInitializationHook(CronTaskPlugin[framework_1.preGenericsInitialization], "Cron-Task-PreGenericsInitialization");
21
- framework_1.SapphireClient.plugins.registerPostInitializationHook(CronTaskPlugin[framework_1.postInitialization], "Cron-Task-PostInitialization");
22
- framework_1.SapphireClient.plugins.registerPostLoginHook(CronTaskPlugin[framework_1.postLogin], "Cron-Task-PostLogin");
23
- //# sourceMappingURL=register.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,mBAAiB;AAEjB,mDAO6B;AAG7B,kEAA+D;AAC/D,2DAAwD;AAExD,MAAa,cAAe,SAAQ,kBAAM;IACtC,MAAM,CAAC,CAAC,qCAAyB,CAAC,CAE9B,OAAsB;QAEtB,qBAAS,CAAC,IAAI,GAAG,IAAI,iCAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,CAAC,8BAAkB,CAAC;QACvB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,6BAAa,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,CAAC,qBAAS,CAAC;QACd,qBAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC9B,CAAC;CACJ;AAfD,wCAeC;AAED,0BAAc,CAAC,OAAO,CAAC,qCAAqC,CACxD,cAAc,CAAC,qCAAyB,CAAC,EACzC,qCAAqC,CACxC,CAAC;AAEF,0BAAc,CAAC,OAAO,CAAC,8BAA8B,CACjD,cAAc,CAAC,8BAAkB,CAAC,EAClC,8BAA8B,CACjC,CAAC;AAEF,0BAAc,CAAC,OAAO,CAAC,qBAAqB,CACxC,cAAc,CAAC,qBAAS,CAAC,EACzB,qBAAqB,CACxB,CAAC"}
package/dist/register.mjs DELETED
@@ -1,4 +0,0 @@
1
- import mod from "./register.js";
2
-
3
- export default mod;
4
- export const CronTaskPlugin = mod.CronTaskPlugin;