@kingsworld/plugin-cron 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kings World
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# @kingsworld/plugin-cron
+
+A simple [@sapphire/framework](https://www.npmjs.com/package/@sapphire/framework) plugin that aims to make use of the [cron](https://www.npmjs.com/package/cron) package and allow users to make cron jobs within their Sapphire discord bot.
+
+## Installation
+
+```sh
+yarn add @kingsworld/plugin-cron @sapphire/framework
+```
+
+## Usage
+
+Make sure to register the plegin before creating the client
+
+```ts
+import "@kingsworld/plugin-cron/register";
+```
+
+If you would like to set the default cron job timezone for all your cron jobs, you can do so within the client options. A list of TZ identifers can be found on [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
+
+```ts
+new SapphireClient({
+    ...otherClientOptions,
+    cron: {
+        // the cron object is optional
+        defaultTimezone: "Europe/London", // the cron pacakge defaults to UTC
+    },
+});
+```
+
+However, if you would like to do so for a single task, you can do so in the cron task options
+
+```js
+{
+    cronTime: "* * * * *", // every minute
+    timeZone: "Europe/London"
+}
+```
+
+### Creating a task
+
+Cron Tasks come with their own store, just like Sapphire commands, listeners, and so on. They must be located within a `cron-tasks` directory that is located alongside your other stores.
+
+```
+src
+├── listeners
+|   └── ready.ts
+└── cron-tasks
+    └── ping.ts
+```
+
+Using decorators from [@sapphire/decorators](https://www.npmjs.com/package/@sapphire/decorators):
+
+```ts
+import { ApplyOptions } from "@sapphire/decorators";
+import { CronTask } from "@kingsworld/plugin-cron";
+
+@ApplyOptions<CronTask.Options>({
+    cronTime: "* * * * *",
+})
+export class PingPong extends CronTask {
+    run() {
+        this.container.logger.info("Ping Pong! 🏓");
+    }
+}
+```
+
+Using the command constructor:
+
+```ts
+import { CronTask } from "@kingsworld/plugin-cron";
+
+export class PingPong extends CronTask {
+    constructor(context: CronTask.Context, options: CronTask.Options) {
+        super(context, {
+            ...options,
+            cronTime: "* * * * *",
+        });
+    }
+
+    run() {
+        this.container.logger.info("Ping Pong! 🏓");
+    }
+}
+```
+
+### Frequently Asked Questions
+
+##### What does the `this.info()`, `this.error()`, `this.warn()`, `this.debug()`, and `this.trace()` methods do instead the CronTask#run() method?
+
+These methods are small helpers towards Sapphire's logger that prefixes logs with `CronTask[$name]`. The helpers are optional, however, I find them useful when using them in my own projects.
+
+```ts
+export class PingPong extends CronTask {
+    run() {
+        this.info("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - INFO - CronTask[ping] Ping Pong! 🏓
+        this.error("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - ERROR - CronTask[ping] Ping Pong! 🏓
+        this.warn("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - WARN - CronTask[ping] Ping Pong! 🏓
+        this.debug("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - DEBUG - CronTask[ping] Ping Pong! 🏓
+        this.trace("Ping Pong! 🏓"); // YYYY-MM-DD HH:MM:SS - TRACE - CronTask[ping] Ping Pong! 🏓
+    }
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import "tslib";
+import type { CronTaskStore } from "./lib/structures/CronTaskStore";
+import type { CronTaskHandler } from "./lib/CronTaskHandler";
+import type { CronTaskHandlerOptions } from "./lib/types/CronTaskTypes";
+export * from "./lib/CronTaskHandler";
+export * from "./lib/structures/CronTask";
+export * from "./lib/structures/CronTaskStore";
+export * from "./lib/types/CronTaskTypes";
+declare module "@sapphire/pieces" {
+    interface Container {
+        cron: CronTaskHandler;
+    }
+    interface StoreRegistryEntries {
+        "cron-tasks": CronTaskStore;
+    }
+}
+declare module "discord.js" {
+    interface ClientOptions {
+        cron?: CronTaskHandlerOptions;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,CAAC;AAEf,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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("tslib");
+__exportStar(require("./lib/CronTaskHandler"), exports);
+__exportStar(require("./lib/structures/CronTask"), exports);
+__exportStar(require("./lib/structures/CronTaskStore"), exports);
+__exportStar(require("./lib/types/CronTaskTypes"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,iBAAe;AAMf,wDAAsC;AACtC,4DAA0C;AAC1C,iEAA+C;AAC/C,4DAA0C"}

package/dist/index.mjs

@@ -0,0 +1,6 @@
+import mod from "./index.js";
+
+export default mod;
+export const CronTask = mod.CronTask;
+export const CronTaskHandler = mod.CronTaskHandler;
+export const CronTaskStore = mod.CronTaskStore;

package/dist/lib/CronTaskHandler.d.ts

@@ -0,0 +1,9 @@
+import type { CronTaskHandlerOptions } from "./types/CronTaskTypes";
+export declare class CronTaskHandler {
+    defaultTimezone?: CronTaskHandlerOptions["defaultTimezone"];
+    constructor(options?: CronTaskHandlerOptions);
+    startAll(): void;
+    stopAll(): void;
+    private get store();
+}
+//# sourceMappingURL=CronTaskHandler.d.ts.map

package/dist/lib/CronTaskHandler.d.ts.map

@@ -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"}

package/dist/lib/CronTaskHandler.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronTaskHandler = void 0;
+const framework_1 = require("@sapphire/framework");
+class CronTaskHandler {
+    constructor(options) {
+        Object.defineProperty(this, "defaultTimezone", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.defaultTimezone = options?.defaultTimezone;
+    }
+    startAll() {
+        this.store.startAll();
+    }
+    stopAll() {
+        this.store.stopAll();
+    }
+    get store() {
+        return framework_1.container.stores.get("cron-tasks");
+    }
+}
+exports.CronTaskHandler = CronTaskHandler;
+//# sourceMappingURL=CronTaskHandler.js.map

package/dist/lib/CronTaskHandler.js.map

@@ -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"}

package/dist/lib/structures/CronTask.d.ts

@@ -0,0 +1,22 @@
+import { Piece } from "@sapphire/pieces";
+import { CronJob } from "cron";
+import type { CronTaskStore } from "./CronTaskStore";
+import type { CronJobOptions } from "../types/CronTaskTypes";
+export declare abstract class CronTask extends Piece {
+    job: CronJob;
+    store: CronTaskStore;
+    options: CronTask.Options;
+    constructor(context: Piece.Context, options: CronTask.Options);
+    abstract run(): unknown;
+    info(message: string, ...other: unknown[]): void;
+    error(message: string, ...other: unknown[]): void;
+    warn(message: string, ...other: unknown[]): void;
+    debug(message: string, ...other: unknown[]): void;
+    trace(message: string, ...other: unknown[]): void;
+    unload(): Promise<void>;
+}
+export declare namespace CronTask {
+    type Options = Piece.Options & CronJobOptions;
+    type Context = Piece.Context;
+}
+//# sourceMappingURL=CronTask.d.ts.map

package/dist/lib/structures/CronTask.d.ts.map

@@ -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,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE7D,8BAAsB,QAAS,SAAQ,KAAK;IACxC,GAAG,EAAE,OAAO,CAAC;IAEL,KAAK,EAAE,aAAa,CAAC;IACrB,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;gBAEtB,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO;IAY7D,QAAQ,CAAC,GAAG,IAAI,OAAO;IAEvB,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAIzC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAI1C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAIzC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAI1C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE;IAIjC,MAAM;CASlB;AAED,yBAAiB,QAAQ,CAAC;IACtB,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,GAAG,cAAc,CAAC;IACrD,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;CACvC"}

package/dist/lib/structures/CronTask.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronTask = void 0;
+const pieces_1 = require("@sapphire/pieces");
+const cron_1 = require("cron");
+class CronTask extends pieces_1.Piece {
+    constructor(context, options) {
+        super(context, options);
+        Object.defineProperty(this, "job", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.job = new cron_1.CronJob({
+            ...options,
+            start: false,
+            context: this,
+            onTick: this.run.bind(this),
+            timeZone: options.timeZone ?? this.container.cron.defaultTimezone
+        });
+    }
+    info(message, ...other) {
+        return this.container.logger.info(`CronTask[${this.name}] ${message}`, ...other);
+    }
+    error(message, ...other) {
+        return this.container.logger.error(`CronTask[${this.name}] ${message}`, ...other);
+    }
+    warn(message, ...other) {
+        return this.container.logger.warn(`CronTask[${this.name}] ${message}`, ...other);
+    }
+    debug(message, ...other) {
+        return this.container.logger.debug(`CronTask[${this.name}] ${message}`, ...other);
+    }
+    trace(message, ...other) {
+        return this.container.logger.trace(`CronTask[${this.name}] ${message}`, ...other);
+    }
+    unload() {
+        // job is undefined when an error occurrs during the CronJob construction
+        // it is not typed as optional because it should never be undefined otherwise
+        if (this.job?.running) {
+            this.job.stop();
+        }
+        return super.unload();
+    }
+}
+exports.CronTask = CronTask;
+//# sourceMappingURL=CronTask.js.map

package/dist/lib/structures/CronTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CronTask.js","sourceRoot":"","sources":["../../../src/lib/structures/CronTask.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,+BAA+B;AAI/B,MAAsB,QAAS,SAAQ,cAAK;IAMxC,YAAY,OAAsB,EAAE,OAAyB;QACzD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAN5B;;;;;WAAa;QAQT,IAAI,CAAC,GAAG,GAAG,IAAI,cAAO,CAAC;YACnB,GAAG,OAAO;YACV,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;SACpE,CAAC,CAAC;IACP,CAAC;IAID,IAAI,CAAC,OAAe,EAAE,GAAG,KAAgB;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;IACrF,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;IACtF,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,GAAG,KAAgB;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;IACrF,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;IACtF,CAAC;IAED,KAAK,CAAC,OAAe,EAAE,GAAG,KAAgB;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,EAAE,GAAG,KAAK,CAAC,CAAC;IACtF,CAAC;IAEQ,MAAM;QACX,yEAAyE;QACzE,6EAA6E;QAC7E,IAAI,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;YACnB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IAC1B,CAAC;CACJ;AAjDD,4BAiDC"}

package/dist/lib/structures/CronTaskStore.d.ts

@@ -0,0 +1,11 @@
+import { Store } from "@sapphire/pieces";
+import { CronTask } from "./CronTask";
+export declare class CronTaskStore extends Store<CronTask> {
+    constructor();
+    startAll(): this;
+    stopAll(): this;
+    set(key: string, value: CronTask): this;
+    delete(key: string): boolean;
+    clear(): void;
+}
+//# sourceMappingURL=CronTaskStore.d.ts.map

package/dist/lib/structures/CronTaskStore.d.ts.map

@@ -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,CAAC;;IAK9C,QAAQ;IAUR,OAAO;IAUE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAI;IAmBvC,MAAM,CAAC,GAAG,EAAE,MAAM;IASlB,KAAK;CAIjB"}

package/dist/lib/structures/CronTaskStore.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronTaskStore = void 0;
+const pieces_1 = require("@sapphire/pieces");
+const CronTask_1 = require("./CronTask");
+const cron_1 = require("cron");
+class CronTaskStore extends pieces_1.Store {
+    constructor() {
+        super(CronTask_1.CronTask, { name: "cron-tasks" });
+    }
+    startAll() {
+        for (const task of this.values()) {
+            if (!task.enabled)
+                continue;
+            task.job.start();
+        }
+        pieces_1.Store.logger?.(`[STORE => ${this.name}] [START] Started all cronjob tasks.`);
+        return this;
+    }
+    stopAll() {
+        for (const task of this.values()) {
+            if (!task.job.running)
+                continue;
+            task.job.stop();
+        }
+        pieces_1.Store.logger?.(`[STORE => ${this.name}] [STOP] Stopped all cronjob tasks.`);
+        return this;
+    }
+    set(key, value) {
+        const options = value.options;
+        try {
+            value.job = new cron_1.CronJob({
+                ...options,
+                start: false,
+                context: value,
+                onTick: value.run.bind(value),
+                timeZone: options.timeZone ?? this.container.cron.defaultTimezone
+            });
+        }
+        catch (error) {
+            value.error("Encountered an error while creating the cron job", error);
+            value.unload();
+        }
+        return super.set(key, value);
+    }
+    delete(key) {
+        const task = this.get(key);
+        if (task?.job.running) {
+            task.job.stop();
+        }
+        return super.delete(key);
+    }
+    clear() {
+        this.stopAll();
+        return super.clear();
+    }
+}
+exports.CronTaskStore = CronTaskStore;
+//# sourceMappingURL=CronTaskStore.js.map

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

@@ -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,cAAe;IAC9C;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;YAC9B,IAAI,CAAC,IAAI,CAAC,OAAO;gBAAE,SAAS;YAC5B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;SACpB;QAED,cAAK,CAAC,MAAM,EAAE,CAAC,aAAa,IAAI,CAAC,IAAI,sCAAsC,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,OAAO;QACH,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE;YAC9B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO;gBAAE,SAAS;YAChC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SACnB;QAED,cAAK,CAAC,MAAM,EAAE,CAAC,aAAa,IAAI,CAAC,IAAI,qCAAqC,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC;IAChB,CAAC;IAEQ,GAAG,CAAC,GAAW,EAAE,KAAe;QACrC,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;QAE9B,IAAI;YACA,KAAK,CAAC,GAAG,GAAG,IAAI,cAAO,CAAC;gBACpB,GAAG,OAAO;gBACV,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,KAAK;gBACd,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC;gBAC7B,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,eAAe;aACpE,CAAC,CAAC;SACN;QAAC,OAAO,KAAK,EAAE;YACZ,KAAK,CAAC,KAAK,CAAC,kDAAkD,EAAE,KAAK,CAAC,CAAC;YACvE,KAAK,CAAC,MAAM,EAAE,CAAC;SAClB;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;YACnB,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;SACnB;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;AAzDD,sCAyDC"}

package/dist/lib/types/CronTaskTypes.d.ts

@@ -0,0 +1,6 @@
+import type { CronJobParameters } from "cron";
+export interface CronTaskHandlerOptions {
+    defaultTimezone?: string;
+}
+export type CronJobOptions = Omit<CronJobParameters, "onTick" | "onComplete" | "start" | "context">;
+//# sourceMappingURL=CronTaskTypes.d.ts.map

package/dist/lib/types/CronTaskTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CronTaskTypes.d.ts","sourceRoot":"","sources":["../../../src/lib/types/CronTaskTypes.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAE9C,MAAM,WAAW,sBAAsB;IACnC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,iBAAiB,EACjB,QAAQ,GAAG,YAAY,GAAG,OAAO,GAAG,SAAS,CAChD,CAAA"}

package/dist/lib/types/CronTaskTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=CronTaskTypes.js.map

package/dist/lib/types/CronTaskTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CronTaskTypes.js","sourceRoot":"","sources":["../../../src/lib/types/CronTaskTypes.ts"],"names":[],"mappings":""}

package/dist/register.d.ts

@@ -0,0 +1,10 @@
+import "./index";
+import { Plugin, postInitialization, postLogin, preGenericsInitialization, SapphireClient } from "@sapphire/framework";
+import type { ClientOptions } from "discord.js";
+export declare class CronTaskPlugin extends Plugin {
+    service: string | undefined;
+    static [preGenericsInitialization](this: SapphireClient, options: ClientOptions): void;
+    static [postInitialization](this: SapphireClient): void;
+    static [postLogin](this: SapphireClient): void;
+}
+//# sourceMappingURL=register.d.ts.map

package/dist/register.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AAEjB,OAAO,EAAa,MAAM,EAAE,kBAAkB,EAAE,SAAS,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAClI,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAKhD,qBAAa,cAAe,SAAQ,MAAM;IACtC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B,MAAM,CAAC,CAAC,yBAAyB,CAAC,CAAC,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,aAAa;IAI/E,MAAM,CAAC,CAAC,kBAAkB,CAAC,CAAC,IAAI,EAAE,cAAc;IAIhD,MAAM,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,cAAc;CAG1C"}

package/dist/register.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CronTaskPlugin = void 0;
+require("./index");
+const framework_1 = require("@sapphire/framework");
+const CronTaskStore_1 = require("./lib/structures/CronTaskStore");
+const CronTaskHandler_1 = require("./lib/CronTaskHandler");
+class CronTaskPlugin extends framework_1.Plugin {
+    constructor() {
+        super(...arguments);
+        Object.defineProperty(this, "service", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    static [framework_1.preGenericsInitialization](options) {
+        framework_1.container.cron = new CronTaskHandler_1.CronTaskHandler(options.cron);
+    }
+    static [framework_1.postInitialization]() {
+        this.stores.register(new CronTaskStore_1.CronTaskStore());
+    }
+    static [framework_1.postLogin]() {
+        framework_1.container.cron.startAll();
+    }
+}
+exports.CronTaskPlugin = CronTaskPlugin;
+framework_1.SapphireClient.plugins.registerPreGenericsInitializationHook(CronTaskPlugin[framework_1.preGenericsInitialization], "Cron-Task-PreGenericsInitialization");
+framework_1.SapphireClient.plugins.registerPostInitializationHook(CronTaskPlugin[framework_1.postInitialization], "Cron-Task-PostInitialization");
+framework_1.SapphireClient.plugins.registerPostLoginHook(CronTaskPlugin[framework_1.postLogin], "Cron-Task-PostLogin");
+//# sourceMappingURL=register.js.map

package/dist/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,mBAAiB;AAEjB,mDAAkI;AAGlI,kEAA+D;AAC/D,2DAAwD;AAExD,MAAa,cAAe,SAAQ,kBAAM;IAA1C;;QACI;;;;;WAA4B;IAahC,CAAC;IAXG,MAAM,CAAC,CAAC,qCAAyB,CAAC,CAAuB,OAAsB;QAC3E,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;AAdD,wCAcC;AAED,0BAAc,CAAC,OAAO,CAAC,qCAAqC,CAAC,cAAc,CAAC,qCAAyB,CAAC,EAAE,qCAAqC,CAAC,CAAC;AAE/I,0BAAc,CAAC,OAAO,CAAC,8BAA8B,CAAC,cAAc,CAAC,8BAAkB,CAAC,EAAE,8BAA8B,CAAC,CAAC;AAE1H,0BAAc,CAAC,OAAO,CAAC,qBAAqB,CAAC,cAAc,CAAC,qBAAS,CAAC,EAAE,qBAAqB,CAAC,CAAC"}

package/dist/register.mjs

@@ -0,0 +1,4 @@
+import mod from "./register.js";
+
+export default mod;
+export const CronTaskPlugin = mod.CronTaskPlugin;

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@kingsworld/plugin-cron",
+  "version": "1.0.0",
+  "author": "Seren_Modz 21 <seren@kings-world.net>",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./register": {
+      "import": "./register.mjs",
+      "require": "./register.js",
+      "types": "./register.d.ts"
+    }
+  },
+  "sideEffects": [
+    "./dist/register.js",
+    "./register.js",
+    "./register.mjs"
+  ],
+  "scripts": {
+    "build": "tsc && yarn esm:register && yarn esm:default",
+    "clean:build": "rimraf dist && yarn build",
+    "esm:register": "gen-esm-wrapper dist/register.js dist/register.mjs",
+    "esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs",
+    "postinstall": "is-ci || husky install"
+  },
+  "dependencies": {
+    "cron": "^2.3.1",
+    "tslib": "^2.6.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.6.6",
+    "@commitlint/config-conventional": "^17.6.6",
+    "@sapphire/framework": "^4.5.0",
+    "@sapphire/pieces": "^3.6.3",
+    "@sapphire/ts-config": "^4.0.0",
+    "@types/cron": "^2",
+    "@types/is-ci": "^3",
+    "@types/node": "^20.4.2",
+    "discord.js": "^14.11.0",
+    "gen-esm-wrapper": "^1.1.3",
+    "husky": "^8.0.3",
+    "is-ci": "^3.0.1",
+    "prettier": "^2.8.8",
+    "pretty-quick": "^3.1.3",
+    "typescript": "^5.1.6"
+  },
+  "homepage": "https://github.com/Kings-World/cron-plugin",
+  "repository": "github://Kings-World/cron-plugin",
+  "keywords": [
+    "sapphire",
+    "plugin",
+    "cron",
+    "typescript",
+    "ts",
+    "discord",
+    "yarn",
+    "bot"
+  ],
+  "bugs": {
+    "url": "https://github.com/Kings-World/cron-plugin/issues",
+    "email": "seren@kings-world.net"
+  },
+  "files": [
+    "dist/",
+    "!dist/.tsbuildinfo",
+    "./register.*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "packageManager": "yarn@3.6.1"
+}

package/register.d.ts

@@ -0,0 +1 @@
+export * from "./dist/register";

package/register.js

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const tslib = require("tslib");
+
+tslib.__exportStar(require("./dist/register.js"), exports);

package/register.mjs

@@ -0,0 +1 @@
+export * from "./dist/register.mjs";