@sapphire/plugin-scheduled-tasks 10.0.4-next.f9d9e4d → 10.0.4
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.
- package/CHANGELOG.md +24 -0
- package/dist/cjs/index.cjs +1 -1
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/lib/ScheduledTaskHandler.cjs +7 -2
- package/dist/cjs/lib/ScheduledTaskHandler.cjs.map +1 -1
- package/dist/esm/index.mjs +1 -1
- package/dist/esm/index.mjs.map +1 -1
- package/dist/esm/lib/ScheduledTaskHandler.mjs +7 -2
- package/dist/esm/lib/ScheduledTaskHandler.mjs.map +1 -1
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,30 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
|
|
5
|
+
# [@sapphire/plugin-scheduled-tasks@10.0.4](https://github.com/sapphiredev/plugins/compare/@sapphire/plugin-scheduled-tasks@10.0.3...@sapphire/plugin-scheduled-tasks@10.0.4) - (2025-09-24)
|
|
6
|
+
|
|
7
|
+
## 🐛 Bug Fixes
|
|
8
|
+
|
|
9
|
+
- **ScheduledTaskHandler:** Throw task error on run if present ([1753289](https://github.com/sapphiredev/plugins/commit/1753289ea744691116c006bc3687667a6c2d8d7d)) ([#773](https://github.com/sapphiredev/plugins/pull/773) by @DemonWayne)
|
|
10
|
+
- **deps:** Update all non-major dependencies ([e6f8e31](https://github.com/sapphiredev/plugins/commit/e6f8e3115cca722c508899edbf7d02b008a3907f)) ([#772](https://github.com/sapphiredev/plugins/pull/772) by @renovate[bot])
|
|
11
|
+
- **deps:** Update all non-major dependencies ([58d318a](https://github.com/sapphiredev/plugins/commit/58d318a5566f9ee6072b17adb6b4476e2b4fd5c7)) ([#768](https://github.com/sapphiredev/plugins/pull/768) by @renovate[bot])
|
|
12
|
+
- **deps:** Update all non-major dependencies ([8db2053](https://github.com/sapphiredev/plugins/commit/8db2053a156b94574167fbe6f1a74f41cd33b65a)) ([#767](https://github.com/sapphiredev/plugins/pull/767) by @renovate[bot])
|
|
13
|
+
- **deps:** Update all non-major dependencies ([3024e3e](https://github.com/sapphiredev/plugins/commit/3024e3ef4e11bd15ee72ef0d2e55d6158f3e5526)) ([#765](https://github.com/sapphiredev/plugins/pull/765) by @renovate[bot])
|
|
14
|
+
- **deps:** Update all non-major dependencies ([f9d9e4d](https://github.com/sapphiredev/plugins/commit/f9d9e4db412d00f04fc1bd9777d53b421a6e1691)) ([#764](https://github.com/sapphiredev/plugins/pull/764) by @renovate[bot])
|
|
15
|
+
- **deps:** Update all non-major dependencies ([8bfa062](https://github.com/sapphiredev/plugins/commit/8bfa0621ac00351e51a496abb27b836b2e7d5355)) ([#763](https://github.com/sapphiredev/plugins/pull/763) by @renovate[bot])
|
|
16
|
+
- **deps:** Update dependency bullmq to v5.56.8 ([83a86a1](https://github.com/sapphiredev/plugins/commit/83a86a15ec5ad8af750da73ebfb2e879e7e5e793)) ([#762](https://github.com/sapphiredev/plugins/pull/762) by @renovate[bot])
|
|
17
|
+
- **deps:** Update all non-major dependencies ([29d9fa9](https://github.com/sapphiredev/plugins/commit/29d9fa9661c574e8c20483fa0ab501851ad4846b)) ([#761](https://github.com/sapphiredev/plugins/pull/761) by @renovate[bot])
|
|
18
|
+
- **deps:** Update all non-major dependencies ([46b6c27](https://github.com/sapphiredev/plugins/commit/46b6c27f69dd178a62e39883e45af8d1e9c367b6)) ([#760](https://github.com/sapphiredev/plugins/pull/760) by @renovate[bot])
|
|
19
|
+
- **deps:** Update all non-major dependencies ([4c40aed](https://github.com/sapphiredev/plugins/commit/4c40aedfff7d4ba0aeb96cf19335b27ad012858e)) ([#759](https://github.com/sapphiredev/plugins/pull/759) by @renovate[bot])
|
|
20
|
+
- **deps:** Update all non-major dependencies ([276da8c](https://github.com/sapphiredev/plugins/commit/276da8c06afa992133f0f57587575b0e008481e7)) ([#758](https://github.com/sapphiredev/plugins/pull/758) by @renovate[bot])
|
|
21
|
+
- **deps:** Update all non-major dependencies ([4c42df2](https://github.com/sapphiredev/plugins/commit/4c42df2a7ec779aa20b039ead15a7a5e586a2211)) ([#756](https://github.com/sapphiredev/plugins/pull/756) by @renovate[bot])
|
|
22
|
+
- **deps:** Update all non-major dependencies ([ae08934](https://github.com/sapphiredev/plugins/commit/ae089340f9e923b9e1d3a8373d703dfcfaff0183)) ([#754](https://github.com/sapphiredev/plugins/pull/754) by @renovate[bot])
|
|
23
|
+
- **deps:** Update all non-major dependencies ([d23894e](https://github.com/sapphiredev/plugins/commit/d23894e01c8ca84f8ff06b6921cbdc350b668f21)) ([#752](https://github.com/sapphiredev/plugins/pull/752) by @renovate[bot])
|
|
24
|
+
- **deps:** Update all non-major dependencies ([e18dc27](https://github.com/sapphiredev/plugins/commit/e18dc277f008fdb1935c24f549e5347bb3f79872)) ([#750](https://github.com/sapphiredev/plugins/pull/750) by @renovate[bot])
|
|
25
|
+
- **deps:** Update all non-major dependencies ([ae90958](https://github.com/sapphiredev/plugins/commit/ae90958bcead612768260afdb49ac1730f4c9186)) ([#748](https://github.com/sapphiredev/plugins/pull/748) by @renovate[bot])
|
|
26
|
+
- **deps:** Update all non-major dependencies ([0d9024f](https://github.com/sapphiredev/plugins/commit/0d9024f61a8eb43f6af9d3fbaec4a1271f9e919a)) ([#744](https://github.com/sapphiredev/plugins/pull/744) by @renovate[bot])
|
|
27
|
+
- **deps:** Update all non-major dependencies ([5106865](https://github.com/sapphiredev/plugins/commit/5106865eadcdece085cc00003100845d1e3a372a)) ([#742](https://github.com/sapphiredev/plugins/pull/742) by @renovate[bot])
|
|
28
|
+
|
|
5
29
|
# [@sapphire/plugin-scheduled-tasks@10.0.3](https://github.com/sapphiredev/plugins/compare/@sapphire/plugin-scheduled-tasks@10.0.2...@sapphire/plugin-scheduled-tasks@10.0.3) - (2025-05-12)
|
|
6
30
|
|
|
7
31
|
## 🐛 Bug Fixes
|
package/dist/cjs/index.cjs
CHANGED
|
@@ -7,7 +7,7 @@ var ScheduledTaskEvents_cjs = require('./lib/types/ScheduledTaskEvents.cjs');
|
|
|
7
7
|
var _load_cjs = require('./listeners/_load.cjs');
|
|
8
8
|
|
|
9
9
|
// src/index.ts
|
|
10
|
-
var version = "10.0.4
|
|
10
|
+
var version = "10.0.4";
|
|
11
11
|
|
|
12
12
|
Object.defineProperty(exports, "loadListeners", {
|
|
13
13
|
enumerable: true,
|
package/dist/cjs/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAwCO,IAAM,OAAA,GAAkB","file":"index.cjs","sourcesContent":["import type { ScheduledTaskHandler } from './lib/ScheduledTaskHandler';\nimport type { ScheduledTaskStore } from './lib/structures/ScheduledTaskStore';\nimport type { ScheduledTaskHandlerOptions } from './lib/types/ScheduledTaskTypes';\n\nexport * from './lib/ScheduledTaskHandler';\nexport * from './lib/structures/ScheduledTask';\nexport * from './lib/structures/ScheduledTaskStore';\nexport * from './lib/types/ScheduledTaskEvents';\nexport type * from './lib/types/ScheduledTaskTypes';\n\nexport { loadListeners } from './listeners/_load';\n\ndeclare module '@sapphire/pieces' {\n\tinterface Container {\n\t\ttasks: ScheduledTaskHandler;\n\t}\n\n\tinterface StoreRegistryEntries {\n\t\t'scheduled-tasks': ScheduledTaskStore;\n\t}\n}\n\ndeclare module 'discord.js' {\n\texport interface ClientOptions {\n\t\ttasks: ScheduledTaskHandlerOptions;\n\t\t/**\n\t\t * If the the pre-included scheduled task error listeners should be loaded\n\t\t * @default true\n\t\t */\n\t\tloadScheduledTaskErrorListeners?: boolean;\n\t}\n}\n\n/**\n * The [@sapphire/plugin-scheduled-tasks](https://github.com/sapphiredev/plugins/blob/main/packages/scheduled-tasks) 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 */\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nexport const version: string = '10.0.4
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;AAwCO,IAAM,OAAA,GAAkB","file":"index.cjs","sourcesContent":["import type { ScheduledTaskHandler } from './lib/ScheduledTaskHandler';\nimport type { ScheduledTaskStore } from './lib/structures/ScheduledTaskStore';\nimport type { ScheduledTaskHandlerOptions } from './lib/types/ScheduledTaskTypes';\n\nexport * from './lib/ScheduledTaskHandler';\nexport * from './lib/structures/ScheduledTask';\nexport * from './lib/structures/ScheduledTaskStore';\nexport * from './lib/types/ScheduledTaskEvents';\nexport type * from './lib/types/ScheduledTaskTypes';\n\nexport { loadListeners } from './listeners/_load';\n\ndeclare module '@sapphire/pieces' {\n\tinterface Container {\n\t\ttasks: ScheduledTaskHandler;\n\t}\n\n\tinterface StoreRegistryEntries {\n\t\t'scheduled-tasks': ScheduledTaskStore;\n\t}\n}\n\ndeclare module 'discord.js' {\n\texport interface ClientOptions {\n\t\ttasks: ScheduledTaskHandlerOptions;\n\t\t/**\n\t\t * If the the pre-included scheduled task error listeners should be loaded\n\t\t * @default true\n\t\t */\n\t\tloadScheduledTaskErrorListeners?: boolean;\n\t}\n}\n\n/**\n * The [@sapphire/plugin-scheduled-tasks](https://github.com/sapphiredev/plugins/blob/main/packages/scheduled-tasks) 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 */\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nexport const version: string = '10.0.4';\n"]}
|
|
@@ -183,8 +183,13 @@ var _ScheduledTaskHandler = class _ScheduledTaskHandler {
|
|
|
183
183
|
framework.container.client.emit(ScheduledTaskEvents_cjs.ScheduledTaskEvents.ScheduledTaskSuccess, piece, payload, taskRunResult, duration);
|
|
184
184
|
return duration;
|
|
185
185
|
});
|
|
186
|
-
|
|
187
|
-
|
|
186
|
+
const value = result.match({
|
|
187
|
+
ok: /* @__PURE__ */ __name((value2) => value2, "ok"),
|
|
188
|
+
err(error) {
|
|
189
|
+
framework.container.client.emit(ScheduledTaskEvents_cjs.ScheduledTaskEvents.ScheduledTaskError, error, piece, payload);
|
|
190
|
+
throw error;
|
|
191
|
+
}
|
|
192
|
+
});
|
|
188
193
|
framework.container.client.emit(ScheduledTaskEvents_cjs.ScheduledTaskEvents.ScheduledTaskFinished, piece, value, payload);
|
|
189
194
|
return value;
|
|
190
195
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/lib/ScheduledTaskHandler.ts"],"names":["Queue","Worker","isNotConnectionError","container","ScheduledTaskEvents","isNullish","Result","stopwatch","Stopwatch"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,IAAA,OAAA,EAAA,OAAA;AAsBO,IAAM,qBAAA,GAAN,MAAM,qBAAA,CAAqB;AAAA,EAc1B,YAAY,OAAA,EAAsC;AAVzD;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,SAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;AAEhB,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AAGC,IAAA,IAAA,CAAK,KAAA,GAAQ,QAAQ,KAAA,IAAS,iBAAA;AAC9B,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,IAAA;AAEvB,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAIA,YAAA,CAAM,IAAA,CAAK,KAAA,EAAO,KAAK,OAAO,CAAA,CAAA;AACjD,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAIC,aAAA;AAAA,MAClB,IAAA,CAAK,KAAA;AAAA;AAAA,MACL,OAAO,GAAA,KAAQ,IAAA,CAAK,GAAA,CAAI,EAAE,IAAA,EAAM,GAAA,CAAI,IAAA,EAA4B,OAAA,EAAS,GAAA,CAAI,IAAA,EAAM,CAAA;AAAA,MACnF,EAAE,UAAA,EAAY,IAAA,CAAK,OAAA,CAAQ,UAAA;AAAW,KACvC,CAAA;AAEA,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAIC,2BAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAAC,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAAD,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AACD,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAIF,2BAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAAC,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAAD,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AAAA,EAEA,IAAW,MAAA,GAAqB;AAC/B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA;AAAA,EACb;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,KAAA,GAAuB;AACnC,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MACjB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA,EAAM;AAAA;AAAA,MACnB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA;AAAM,KACnB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,MAAA,CACZ,IAAA,EACA,OAAA,EACgC;AAChC,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AAEzD,IAAA,IAAIC,mBAAA,CAAU,OAAO,CAAA,EAAG;AACvB,MAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,OAAO,CAAA;AAAA,IAC1C;AAEA,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAChC,MAAA,OAAA,GAAU;AAAA,QACT,QAAA,EAAU,KAAA;AAAA,QACV,KAAA,EAAO;AAAA,OACR;AAAA,IACD;AAEA,IAAA,MAAM,EAAE,QAAA,EAAU,OAAA,EAAS,UAAU,KAAA,EAAO,gBAAA,EAAkB,UAAS,GAAI,OAAA;AAC3E,IAAA,IAAI,UAAA,GAA0B;AAAA,MAC7B,KAAA;AAAA,MACA,GAAG;AAAA,KACJ;AAEA,IAAA,IAAI,QAAA,EAAU;AACb,MAAA,UAAA,GAAa;AAAA,QACZ,GAAG,UAAA;AAAA,QACH,MAAA,EAAQ,WACL,EAAE,KAAA,EAAO,UAAS,GAClB,EAAE,OAAA,EAAS,EAAA,EAAI,QAAA;AAAS,OAC5B;AAAA,IACD;AAEA,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,SAAS,UAAU,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,eAAe,KAAA,EAA0D;AACrF,IAAA,IAAI,UAAU,MAAA,EAAW;AACxB,MAAA,MAAM,gBAAmD,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc,GAAA,CAAI,CAAC,KAAA,MAAW;AAAA,QACjG,MAAM,KAAA,CAAM,IAAA;AAAA,QACZ,OAAA,EAAS;AAAA,UACR,QAAA,EAAU,IAAA;AAAA,UACV,GAAI,MAAM,QAAA,GACP;AAAA,YACA,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA,WACzB,GACC;AAAA,YACA,SAAS,KAAA,CAAM,OAAA;AAAA,YACf,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA;AACzB;AACH,OACD,CAAE,CAAA;AAEF,MAAA,KAAA,GAAQ,aAAA;AAAA,IACT;AAEA,IAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACzB,MAAA,MAAM,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,IAAA,EAAM,KAAK,OAAO,CAAA;AAAA,IAC1C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,OAAO,EAAA,EAA2B;AAC9C,IAAA,MAAM,GAAA,GAAO,MAAM,IAAA,CAAK,GAAA,CAAI,EAAwB,CAAA;AACpD,IAAA,OAAO,KAAK,MAAA,EAAO;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,KAAK,OAAA,EAA4D;AACvE,IAAA,MAAM,EAAE,KAAA,EAAO,KAAA,EAAO,GAAA,EAAK,KAAI,GAAI,OAAA;AAEnC,IAAA,OAAO,mBAAK,OAAA,CAAA,CAAQ,OAAA,CAAQ,KAAA,EAAO,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,aAAa,OAAA,EAAyF;AAC5G,IAAA,MAAM,EAAE,KAAA,EAAO,GAAA,EAAK,GAAA,EAAI,GAAI,OAAA;AAE5B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,iBAAA,CAAkB,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,IAAkC,EAAA,EAA2D;AACzG,IAAA,MAAM,GAAA,GAAM,MAAM,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,OAAO,EAAE,CAAA;AACxC,IAAA,IAAIA,mBAAA,CAAU,GAAG,CAAA,EAAG,OAAO,MAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,IAAI,IAAA,EAAoE;AACpF,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AACzD,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,KAAK,IAAI,CAAA;AAEtC,IAAA,IAAI,CAAC,KAAA,EAAO;AACX,MAAAF,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,qBAAA,EAAuB,UAAU,OAAO,CAAA;AAElF,MAAA,OAAO,MAAA;AAAA,IACR;AAEA,IAAA,MAAM,MAAA,GAAS,MAAME,gBAAA,CAAO,SAAA,CAAU,YAAY;AACjD,MAAAH,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,gBAAA,EAAkB,OAAO,OAAO,CAAA;AAE1E,MAAA,MAAMG,WAAA,GAAY,IAAIC,mBAAA,EAAU;AAChC,MAAA,MAAM,aAAA,GAAgB,MAAM,KAAA,CAAM,GAAA,CAAI,OAAO,CAAA;AAC7C,MAAA,MAAM,EAAE,QAAA,EAAS,GAAID,WAAA,CAAU,IAAA,EAAK;AAEpC,MAAAJ,mBAAA,CAAU,OAAO,IAAA,CAAKC,2CAAA,CAAoB,sBAAsB,KAAA,EAAO,OAAA,EAAS,eAAe,QAAQ,CAAA;AAEvG,MAAA,OAAO,QAAA;AAAA,IACR,CAAC,CAAA;AAED,IAAA,MAAA,CAAO,UAAA,CAAW,CAAC,KAAA,KAAUD,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,kBAAA,EAAoB,KAAA,EAAO,KAAA,EAAO,OAAO,CAAC,CAAA;AAEjH,IAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,QAAA,CAAS,IAAI,CAAA;AAElC,IAAAD,mBAAA,CAAU,OAAO,IAAA,CAAKC,2CAAA,CAAoB,qBAAA,EAAuB,KAAA,EAAO,OAAO,OAAO,CAAA;AAEtF,IAAA,OAAO,KAAA;AAAA,EACR;AAAA,EAEA,IAAY,KAAA,GAA4B;AACvC,IAAA,OAAOD,mBAAA,CAAU,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,iBAAiB,CAAA;AAAA,EACrD;AAAA,EAEQ,YAAY,IAAA,EAAiE;AACpF,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC7B,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,EAAM,OAAA,EAAS,MAAA,EAAU;AAAA,IACzC;AAEA,IAAA,IAAI,aAAa,IAAA,EAAM;AACtB,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,OAAA,EAAS,KAAK,OAAA,EAAQ;AAAA,IACjD;AAEA,IAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,SAAS,MAAA,EAAU;AAAA,EAC9C;AACD,CAAA;AAtNC,OAAA,GAAA,IAAA,OAAA,EAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;AAZiC,MAAA,CAAA,qBAAA,EAAA,sBAAA,CAAA;AAA3B,IAAM,oBAAA,GAAN","file":"ScheduledTaskHandler.cjs","sourcesContent":["import { container, Result } from '@sapphire/framework';\nimport { Stopwatch } from '@sapphire/stopwatch';\nimport { Job, Queue, Worker, type JobsOptions, type QueueOptions, isNotConnectionError } from 'bullmq';\nimport type { ScheduledTaskStore } from './structures/ScheduledTaskStore';\nimport { ScheduledTaskEvents } from './types/ScheduledTaskEvents';\nimport type {\n\tBullClient,\n\tScheduledTaskCreateRepeatedTask,\n\tScheduledTaskHandlerOptions,\n\tScheduledTaskListOptions,\n\tScheduledTaskListRepeatedOptions,\n\tScheduledTaskListRepeatedReturnType,\n\tScheduledTasksResolvable,\n\tScheduledTasksKeys,\n\tScheduledTasksTaskOptions,\n\tScheduledTasksKeysNoPayload,\n\tScheduledTasksJob,\n\tScheduledTasksResolvablePayload,\n\tScheduledTasksPayload\n} from './types/ScheduledTaskTypes';\nimport { isNullish } from '@sapphire/utilities';\n\nexport class ScheduledTaskHandler {\n\t/**\n\t * The queue options for the scheduled task handler.\n\t */\n\tpublic readonly options: QueueOptions;\n\n\t/**\n\t * The name of the queue associated with the scheduled task handler.\n\t */\n\tpublic readonly queue: string;\n\n\t#client: BullClient;\n\t#worker: Worker;\n\n\tpublic constructor(options: ScheduledTaskHandlerOptions) {\n\t\tthis.queue = options.queue ?? 'scheduled-tasks';\n\t\tthis.options = options.bull;\n\n\t\tthis.#client = new Queue(this.queue, this.options);\n\t\tthis.#worker = new Worker(\n\t\t\tthis.queue, //\n\t\t\tasync (job) => this.run({ name: job.name as ScheduledTasksKeys, payload: job.data }),\n\t\t\t{ connection: this.options.connection }\n\t\t);\n\n\t\tthis.#client.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyClientError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t\tthis.#worker.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyWorkerError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic get client(): BullClient {\n\t\treturn this.#client;\n\t}\n\n\t/**\n\t * Closes the internal client and worker.\n\t */\n\tpublic async close(): Promise<void> {\n\t\tawait Promise.all([\n\t\t\tthis.#client.close(), //\n\t\t\tthis.#worker.close()\n\t\t]);\n\t}\n\n\t/**\n\t * Creates a scheduled task.\n\t *\n\t * @param task - The task to be scheduled.\n\t * @param options - The options for the task.\n\t */\n\tpublic async create<T extends ScheduledTasksResolvable>(\n\t\ttask: T, //\n\t\toptions?: ScheduledTasksTaskOptions | number\n\t): Promise<ScheduledTasksJob<T>> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\n\t\tif (isNullish(options)) {\n\t\t\treturn this.#client.add(taskName, payload) as Promise<ScheduledTasksJob<T>>;\n\t\t}\n\n\t\tif (typeof options === 'number') {\n\t\t\toptions = {\n\t\t\t\trepeated: false,\n\t\t\t\tdelay: options\n\t\t\t};\n\t\t}\n\n\t\tconst { repeated, pattern, interval, delay, customJobOptions, timezone } = options;\n\t\tlet jobOptions: JobsOptions = {\n\t\t\tdelay,\n\t\t\t...customJobOptions\n\t\t};\n\n\t\tif (repeated) {\n\t\t\tjobOptions = {\n\t\t\t\t...jobOptions,\n\t\t\t\trepeat: interval //\n\t\t\t\t\t? { every: interval }\n\t\t\t\t\t: { pattern, tz: timezone }\n\t\t\t};\n\t\t}\n\n\t\treturn this.#client.add(taskName, payload, jobOptions) as Promise<ScheduledTasksJob<T>>;\n\t}\n\n\t/**\n\t * Creates repeated tasks.\n\t *\n\t * @param tasks - An optional array of tasks to create. If not provided, it will create tasks based on the stored repeated tasks.\n\t */\n\tpublic async createRepeated(tasks?: ScheduledTaskCreateRepeatedTask[]): Promise<void> {\n\t\tif (tasks === undefined) {\n\t\t\tconst repeatedTasks: ScheduledTaskCreateRepeatedTask[] = this.store.repeatedTasks.map((piece) => ({\n\t\t\t\tname: piece.name as ScheduledTasksKeysNoPayload,\n\t\t\t\toptions: {\n\t\t\t\t\trepeated: true,\n\t\t\t\t\t...(piece.interval\n\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\tinterval: piece.interval,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\tpattern: piece.pattern!,\n\t\t\t\t\t\t\t\ttimezone: piece.timezone,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t}));\n\n\t\t\ttasks = repeatedTasks;\n\t\t}\n\n\t\tfor (const task of tasks) {\n\t\t\tawait this.create(task.name, task.options);\n\t\t}\n\t}\n\n\t/**\n\t * Deletes a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the task to delete.\n\t */\n\tpublic async delete(id: string): Promise<void> {\n\t\tconst job = (await this.get(id as ScheduledTasksKeys)) as unknown as Job<unknown> | undefined;\n\t\treturn job?.remove();\n\t}\n\n\t/**\n\t * Retrieves a list of scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of scheduled tasks.\n\t */\n\tpublic list(options: ScheduledTaskListOptions): Promise<Job<unknown>[]> {\n\t\tconst { types, start, end, asc } = options;\n\n\t\treturn this.#client.getJobs(types, start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a list of repeated scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of repeated scheduled tasks.\n\t */\n\tpublic listRepeated(options: ScheduledTaskListRepeatedOptions): Promise<ScheduledTaskListRepeatedReturnType> {\n\t\tconst { start, end, asc } = options;\n\n\t\treturn this.#client.getRepeatableJobs(start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the scheduled task to retrieve.\n\t */\n\tpublic async get<T extends ScheduledTasksKeys>(id: T): Promise<Job<ScheduledTasksPayload<T>> | undefined> {\n\t\tconst job = await this.#client.getJob(id);\n\t\tif (isNullish(job)) return undefined;\n\n\t\treturn job as Job<ScheduledTasksPayload<T>>;\n\t}\n\n\t/**\n\t * Runs a scheduled task with the given name and payload.\n\t *\n\t * @param task - The name of the scheduled task to run.\n\t *\n\t * @remarks `undefined` will be returned if the task was not found.\n\t */\n\tpublic async run(task: ScheduledTasksResolvable): Promise<number | null | undefined> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\t\tconst piece = this.store.get(task.name);\n\n\t\tif (!piece) {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskNotFound, taskName, payload);\n\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst result = await Result.fromAsync(async () => {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskRun, piece, payload);\n\n\t\t\tconst stopwatch = new Stopwatch();\n\t\t\tconst taskRunResult = await piece.run(payload);\n\t\t\tconst { duration } = stopwatch.stop();\n\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskSuccess, piece, payload, taskRunResult, duration);\n\n\t\t\treturn duration;\n\t\t});\n\n\t\tresult.inspectErr((error) => container.client.emit(ScheduledTaskEvents.ScheduledTaskError, error, piece, payload));\n\n\t\tconst value = result.unwrapOr(null);\n\n\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskFinished, piece, value, payload);\n\n\t\treturn value;\n\t}\n\n\tprivate get store(): ScheduledTaskStore {\n\t\treturn container.client.stores.get('scheduled-tasks');\n\t}\n\n\tprivate resolveTask(task: ScheduledTasksResolvable): ScheduledTasksResolvablePayload {\n\t\tif (typeof task === 'string') {\n\t\t\treturn { name: task, payload: undefined };\n\t\t}\n\n\t\tif ('payload' in task) {\n\t\t\treturn { name: task.name, payload: task.payload };\n\t\t}\n\n\t\treturn { name: task.name, payload: undefined };\n\t}\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../../../src/lib/ScheduledTaskHandler.ts"],"names":["Queue","Worker","isNotConnectionError","container","ScheduledTaskEvents","isNullish","Result","stopwatch","Stopwatch","value"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA,IAAA,OAAA,EAAA,OAAA;AAsBO,IAAM,qBAAA,GAAN,MAAM,qBAAA,CAAqB;AAAA,EAc1B,YAAY,OAAA,EAAsC;AAVzD;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,SAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;AAEhB,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AAGC,IAAA,IAAA,CAAK,KAAA,GAAQ,QAAQ,KAAA,IAAS,iBAAA;AAC9B,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,IAAA;AAEvB,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAIA,YAAA,CAAM,IAAA,CAAK,KAAA,EAAO,KAAK,OAAO,CAAA,CAAA;AACjD,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAIC,aAAA;AAAA,MAClB,IAAA,CAAK,KAAA;AAAA;AAAA,MACL,OAAO,GAAA,KAAQ,IAAA,CAAK,GAAA,CAAI,EAAE,IAAA,EAAM,GAAA,CAAI,IAAA,EAA4B,OAAA,EAAS,GAAA,CAAI,IAAA,EAAM,CAAA;AAAA,MACnF,EAAE,UAAA,EAAY,IAAA,CAAK,OAAA,CAAQ,UAAA;AAAW,KACvC,CAAA;AAEA,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAIC,2BAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAAC,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAAD,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AACD,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAIF,2BAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAAC,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAAD,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AAAA,EAEA,IAAW,MAAA,GAAqB;AAC/B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA;AAAA,EACb;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,KAAA,GAAuB;AACnC,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MACjB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA,EAAM;AAAA;AAAA,MACnB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA;AAAM,KACnB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,MAAA,CACZ,IAAA,EACA,OAAA,EACgC;AAChC,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AAEzD,IAAA,IAAIC,mBAAA,CAAU,OAAO,CAAA,EAAG;AACvB,MAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,OAAO,CAAA;AAAA,IAC1C;AAEA,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAChC,MAAA,OAAA,GAAU;AAAA,QACT,QAAA,EAAU,KAAA;AAAA,QACV,KAAA,EAAO;AAAA,OACR;AAAA,IACD;AAEA,IAAA,MAAM,EAAE,QAAA,EAAU,OAAA,EAAS,UAAU,KAAA,EAAO,gBAAA,EAAkB,UAAS,GAAI,OAAA;AAC3E,IAAA,IAAI,UAAA,GAA0B;AAAA,MAC7B,KAAA;AAAA,MACA,GAAG;AAAA,KACJ;AAEA,IAAA,IAAI,QAAA,EAAU;AACb,MAAA,UAAA,GAAa;AAAA,QACZ,GAAG,UAAA;AAAA,QACH,MAAA,EAAQ,WACL,EAAE,KAAA,EAAO,UAAS,GAClB,EAAE,OAAA,EAAS,EAAA,EAAI,QAAA;AAAS,OAC5B;AAAA,IACD;AAEA,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,SAAS,UAAU,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,eAAe,KAAA,EAA0D;AACrF,IAAA,IAAI,UAAU,MAAA,EAAW;AACxB,MAAA,MAAM,gBAAmD,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc,GAAA,CAAI,CAAC,KAAA,MAAW;AAAA,QACjG,MAAM,KAAA,CAAM,IAAA;AAAA,QACZ,OAAA,EAAS;AAAA,UACR,QAAA,EAAU,IAAA;AAAA,UACV,GAAI,MAAM,QAAA,GACP;AAAA,YACA,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA,WACzB,GACC;AAAA,YACA,SAAS,KAAA,CAAM,OAAA;AAAA,YACf,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA;AACzB;AACH,OACD,CAAE,CAAA;AAEF,MAAA,KAAA,GAAQ,aAAA;AAAA,IACT;AAEA,IAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACzB,MAAA,MAAM,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,IAAA,EAAM,KAAK,OAAO,CAAA;AAAA,IAC1C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,OAAO,EAAA,EAA2B;AAC9C,IAAA,MAAM,GAAA,GAAO,MAAM,IAAA,CAAK,GAAA,CAAI,EAAwB,CAAA;AACpD,IAAA,OAAO,KAAK,MAAA,EAAO;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,KAAK,OAAA,EAA4D;AACvE,IAAA,MAAM,EAAE,KAAA,EAAO,KAAA,EAAO,GAAA,EAAK,KAAI,GAAI,OAAA;AAEnC,IAAA,OAAO,mBAAK,OAAA,CAAA,CAAQ,OAAA,CAAQ,KAAA,EAAO,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,aAAa,OAAA,EAAyF;AAC5G,IAAA,MAAM,EAAE,KAAA,EAAO,GAAA,EAAK,GAAA,EAAI,GAAI,OAAA;AAE5B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,iBAAA,CAAkB,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,IAAkC,EAAA,EAA2D;AACzG,IAAA,MAAM,GAAA,GAAM,MAAM,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,OAAO,EAAE,CAAA;AACxC,IAAA,IAAIA,mBAAA,CAAU,GAAG,CAAA,EAAG,OAAO,MAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,IAAI,IAAA,EAAoE;AACpF,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AACzD,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,KAAK,IAAI,CAAA;AAEtC,IAAA,IAAI,CAAC,KAAA,EAAO;AACX,MAAAF,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,qBAAA,EAAuB,UAAU,OAAO,CAAA;AAElF,MAAA,OAAO,MAAA;AAAA,IACR;AAEA,IAAA,MAAM,MAAA,GAAS,MAAME,gBAAA,CAAO,SAAA,CAAU,YAAY;AACjD,MAAAH,mBAAA,CAAU,MAAA,CAAO,IAAA,CAAKC,2CAAA,CAAoB,gBAAA,EAAkB,OAAO,OAAO,CAAA;AAE1E,MAAA,MAAMG,WAAA,GAAY,IAAIC,mBAAA,EAAU;AAChC,MAAA,MAAM,aAAA,GAAgB,MAAM,KAAA,CAAM,GAAA,CAAI,OAAO,CAAA;AAC7C,MAAA,MAAM,EAAE,QAAA,EAAS,GAAID,WAAA,CAAU,IAAA,EAAK;AAEpC,MAAAJ,mBAAA,CAAU,OAAO,IAAA,CAAKC,2CAAA,CAAoB,sBAAsB,KAAA,EAAO,OAAA,EAAS,eAAe,QAAQ,CAAA;AAEvG,MAAA,OAAO,QAAA;AAAA,IACR,CAAC,CAAA;AAED,IAAA,MAAM,KAAA,GAAQ,OAAO,KAAA,CAAM;AAAA,MAC1B,EAAA,kBAAI,MAAA,CAAA,CAACK,MAAAA,KAAUA,MAAAA,EAAX,IAAA,CAAA;AAAA,MACJ,IAAI,KAAA,EAAO;AACV,QAAAN,mBAAA,CAAU,OAAO,IAAA,CAAKC,2CAAA,CAAoB,kBAAA,EAAoB,KAAA,EAAO,OAAO,OAAO,CAAA;AACnF,QAAA,MAAM,KAAA;AAAA,MACP;AAAA,KACA,CAAA;AAED,IAAAD,mBAAA,CAAU,OAAO,IAAA,CAAKC,2CAAA,CAAoB,qBAAA,EAAuB,KAAA,EAAO,OAAO,OAAO,CAAA;AAEtF,IAAA,OAAO,KAAA;AAAA,EACR;AAAA,EAEA,IAAY,KAAA,GAA4B;AACvC,IAAA,OAAOD,mBAAA,CAAU,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,iBAAiB,CAAA;AAAA,EACrD;AAAA,EAEQ,YAAY,IAAA,EAAiE;AACpF,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC7B,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,EAAM,OAAA,EAAS,MAAA,EAAU;AAAA,IACzC;AAEA,IAAA,IAAI,aAAa,IAAA,EAAM;AACtB,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,OAAA,EAAS,KAAK,OAAA,EAAQ;AAAA,IACjD;AAEA,IAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,SAAS,MAAA,EAAU;AAAA,EAC9C;AACD,CAAA;AA1NC,OAAA,GAAA,IAAA,OAAA,EAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;AAZiC,MAAA,CAAA,qBAAA,EAAA,sBAAA,CAAA;AAA3B,IAAM,oBAAA,GAAN","file":"ScheduledTaskHandler.cjs","sourcesContent":["import { container, Result } from '@sapphire/framework';\nimport { Stopwatch } from '@sapphire/stopwatch';\nimport { Job, Queue, Worker, type JobsOptions, type QueueOptions, isNotConnectionError } from 'bullmq';\nimport type { ScheduledTaskStore } from './structures/ScheduledTaskStore';\nimport { ScheduledTaskEvents } from './types/ScheduledTaskEvents';\nimport type {\n\tBullClient,\n\tScheduledTaskCreateRepeatedTask,\n\tScheduledTaskHandlerOptions,\n\tScheduledTaskListOptions,\n\tScheduledTaskListRepeatedOptions,\n\tScheduledTaskListRepeatedReturnType,\n\tScheduledTasksResolvable,\n\tScheduledTasksKeys,\n\tScheduledTasksTaskOptions,\n\tScheduledTasksKeysNoPayload,\n\tScheduledTasksJob,\n\tScheduledTasksResolvablePayload,\n\tScheduledTasksPayload\n} from './types/ScheduledTaskTypes';\nimport { isNullish } from '@sapphire/utilities';\n\nexport class ScheduledTaskHandler {\n\t/**\n\t * The queue options for the scheduled task handler.\n\t */\n\tpublic readonly options: QueueOptions;\n\n\t/**\n\t * The name of the queue associated with the scheduled task handler.\n\t */\n\tpublic readonly queue: string;\n\n\t#client: BullClient;\n\t#worker: Worker;\n\n\tpublic constructor(options: ScheduledTaskHandlerOptions) {\n\t\tthis.queue = options.queue ?? 'scheduled-tasks';\n\t\tthis.options = options.bull;\n\n\t\tthis.#client = new Queue(this.queue, this.options);\n\t\tthis.#worker = new Worker(\n\t\t\tthis.queue, //\n\t\t\tasync (job) => this.run({ name: job.name as ScheduledTasksKeys, payload: job.data }),\n\t\t\t{ connection: this.options.connection }\n\t\t);\n\n\t\tthis.#client.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyClientError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t\tthis.#worker.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyWorkerError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic get client(): BullClient {\n\t\treturn this.#client;\n\t}\n\n\t/**\n\t * Closes the internal client and worker.\n\t */\n\tpublic async close(): Promise<void> {\n\t\tawait Promise.all([\n\t\t\tthis.#client.close(), //\n\t\t\tthis.#worker.close()\n\t\t]);\n\t}\n\n\t/**\n\t * Creates a scheduled task.\n\t *\n\t * @param task - The task to be scheduled.\n\t * @param options - The options for the task.\n\t */\n\tpublic async create<T extends ScheduledTasksResolvable>(\n\t\ttask: T, //\n\t\toptions?: ScheduledTasksTaskOptions | number\n\t): Promise<ScheduledTasksJob<T>> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\n\t\tif (isNullish(options)) {\n\t\t\treturn this.#client.add(taskName, payload) as Promise<ScheduledTasksJob<T>>;\n\t\t}\n\n\t\tif (typeof options === 'number') {\n\t\t\toptions = {\n\t\t\t\trepeated: false,\n\t\t\t\tdelay: options\n\t\t\t};\n\t\t}\n\n\t\tconst { repeated, pattern, interval, delay, customJobOptions, timezone } = options;\n\t\tlet jobOptions: JobsOptions = {\n\t\t\tdelay,\n\t\t\t...customJobOptions\n\t\t};\n\n\t\tif (repeated) {\n\t\t\tjobOptions = {\n\t\t\t\t...jobOptions,\n\t\t\t\trepeat: interval //\n\t\t\t\t\t? { every: interval }\n\t\t\t\t\t: { pattern, tz: timezone }\n\t\t\t};\n\t\t}\n\n\t\treturn this.#client.add(taskName, payload, jobOptions) as Promise<ScheduledTasksJob<T>>;\n\t}\n\n\t/**\n\t * Creates repeated tasks.\n\t *\n\t * @param tasks - An optional array of tasks to create. If not provided, it will create tasks based on the stored repeated tasks.\n\t */\n\tpublic async createRepeated(tasks?: ScheduledTaskCreateRepeatedTask[]): Promise<void> {\n\t\tif (tasks === undefined) {\n\t\t\tconst repeatedTasks: ScheduledTaskCreateRepeatedTask[] = this.store.repeatedTasks.map((piece) => ({\n\t\t\t\tname: piece.name as ScheduledTasksKeysNoPayload,\n\t\t\t\toptions: {\n\t\t\t\t\trepeated: true,\n\t\t\t\t\t...(piece.interval\n\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\tinterval: piece.interval,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\tpattern: piece.pattern!,\n\t\t\t\t\t\t\t\ttimezone: piece.timezone,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t}));\n\n\t\t\ttasks = repeatedTasks;\n\t\t}\n\n\t\tfor (const task of tasks) {\n\t\t\tawait this.create(task.name, task.options);\n\t\t}\n\t}\n\n\t/**\n\t * Deletes a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the task to delete.\n\t */\n\tpublic async delete(id: string): Promise<void> {\n\t\tconst job = (await this.get(id as ScheduledTasksKeys)) as unknown as Job<unknown> | undefined;\n\t\treturn job?.remove();\n\t}\n\n\t/**\n\t * Retrieves a list of scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of scheduled tasks.\n\t */\n\tpublic list(options: ScheduledTaskListOptions): Promise<Job<unknown>[]> {\n\t\tconst { types, start, end, asc } = options;\n\n\t\treturn this.#client.getJobs(types, start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a list of repeated scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of repeated scheduled tasks.\n\t */\n\tpublic listRepeated(options: ScheduledTaskListRepeatedOptions): Promise<ScheduledTaskListRepeatedReturnType> {\n\t\tconst { start, end, asc } = options;\n\n\t\treturn this.#client.getRepeatableJobs(start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the scheduled task to retrieve.\n\t */\n\tpublic async get<T extends ScheduledTasksKeys>(id: T): Promise<Job<ScheduledTasksPayload<T>> | undefined> {\n\t\tconst job = await this.#client.getJob(id);\n\t\tif (isNullish(job)) return undefined;\n\n\t\treturn job as Job<ScheduledTasksPayload<T>>;\n\t}\n\n\t/**\n\t * Runs a scheduled task with the given name and payload.\n\t *\n\t * @param task - The name of the scheduled task to run.\n\t *\n\t * @remarks `undefined` will be returned if the task was not found.\n\t */\n\tpublic async run(task: ScheduledTasksResolvable): Promise<number | null | undefined> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\t\tconst piece = this.store.get(task.name);\n\n\t\tif (!piece) {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskNotFound, taskName, payload);\n\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst result = await Result.fromAsync(async () => {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskRun, piece, payload);\n\n\t\t\tconst stopwatch = new Stopwatch();\n\t\t\tconst taskRunResult = await piece.run(payload);\n\t\t\tconst { duration } = stopwatch.stop();\n\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskSuccess, piece, payload, taskRunResult, duration);\n\n\t\t\treturn duration;\n\t\t});\n\n\t\tconst value = result.match({\n\t\t\tok: (value) => value,\n\t\t\terr(error) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskError, error, piece, payload);\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t});\n\n\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskFinished, piece, value, payload);\n\n\t\treturn value;\n\t}\n\n\tprivate get store(): ScheduledTaskStore {\n\t\treturn container.client.stores.get('scheduled-tasks');\n\t}\n\n\tprivate resolveTask(task: ScheduledTasksResolvable): ScheduledTasksResolvablePayload {\n\t\tif (typeof task === 'string') {\n\t\t\treturn { name: task, payload: undefined };\n\t\t}\n\n\t\tif ('payload' in task) {\n\t\t\treturn { name: task.name, payload: task.payload };\n\t\t}\n\n\t\treturn { name: task.name, payload: undefined };\n\t}\n}\n"]}
|
package/dist/esm/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ export * from './lib/structures/ScheduledTaskStore.mjs';
|
|
|
5
5
|
export * from './lib/types/ScheduledTaskEvents.mjs';
|
|
6
6
|
export { loadListeners } from './listeners/_load.mjs';
|
|
7
7
|
|
|
8
|
-
var version = "10.0.4
|
|
8
|
+
var version = "10.0.4";
|
|
9
9
|
|
|
10
10
|
export { version };
|
|
11
11
|
//# sourceMappingURL=index.mjs.map
|
package/dist/esm/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;AAwCO,IAAM,OAAA,GAAkB","file":"index.mjs","sourcesContent":["import type { ScheduledTaskHandler } from './lib/ScheduledTaskHandler';\nimport type { ScheduledTaskStore } from './lib/structures/ScheduledTaskStore';\nimport type { ScheduledTaskHandlerOptions } from './lib/types/ScheduledTaskTypes';\n\nexport * from './lib/ScheduledTaskHandler';\nexport * from './lib/structures/ScheduledTask';\nexport * from './lib/structures/ScheduledTaskStore';\nexport * from './lib/types/ScheduledTaskEvents';\nexport type * from './lib/types/ScheduledTaskTypes';\n\nexport { loadListeners } from './listeners/_load';\n\ndeclare module '@sapphire/pieces' {\n\tinterface Container {\n\t\ttasks: ScheduledTaskHandler;\n\t}\n\n\tinterface StoreRegistryEntries {\n\t\t'scheduled-tasks': ScheduledTaskStore;\n\t}\n}\n\ndeclare module 'discord.js' {\n\texport interface ClientOptions {\n\t\ttasks: ScheduledTaskHandlerOptions;\n\t\t/**\n\t\t * If the the pre-included scheduled task error listeners should be loaded\n\t\t * @default true\n\t\t */\n\t\tloadScheduledTaskErrorListeners?: boolean;\n\t}\n}\n\n/**\n * The [@sapphire/plugin-scheduled-tasks](https://github.com/sapphiredev/plugins/blob/main/packages/scheduled-tasks) 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 */\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nexport const version: string = '10.0.4
|
|
1
|
+
{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;AAwCO,IAAM,OAAA,GAAkB","file":"index.mjs","sourcesContent":["import type { ScheduledTaskHandler } from './lib/ScheduledTaskHandler';\nimport type { ScheduledTaskStore } from './lib/structures/ScheduledTaskStore';\nimport type { ScheduledTaskHandlerOptions } from './lib/types/ScheduledTaskTypes';\n\nexport * from './lib/ScheduledTaskHandler';\nexport * from './lib/structures/ScheduledTask';\nexport * from './lib/structures/ScheduledTaskStore';\nexport * from './lib/types/ScheduledTaskEvents';\nexport type * from './lib/types/ScheduledTaskTypes';\n\nexport { loadListeners } from './listeners/_load';\n\ndeclare module '@sapphire/pieces' {\n\tinterface Container {\n\t\ttasks: ScheduledTaskHandler;\n\t}\n\n\tinterface StoreRegistryEntries {\n\t\t'scheduled-tasks': ScheduledTaskStore;\n\t}\n}\n\ndeclare module 'discord.js' {\n\texport interface ClientOptions {\n\t\ttasks: ScheduledTaskHandlerOptions;\n\t\t/**\n\t\t * If the the pre-included scheduled task error listeners should be loaded\n\t\t * @default true\n\t\t */\n\t\tloadScheduledTaskErrorListeners?: boolean;\n\t}\n}\n\n/**\n * The [@sapphire/plugin-scheduled-tasks](https://github.com/sapphiredev/plugins/blob/main/packages/scheduled-tasks) 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 */\n// eslint-disable-next-line @typescript-eslint/no-inferrable-types\nexport const version: string = '10.0.4';\n"]}
|
|
@@ -171,8 +171,13 @@ var _ScheduledTaskHandler = class _ScheduledTaskHandler {
|
|
|
171
171
|
container.client.emit(ScheduledTaskEvents.ScheduledTaskSuccess, piece, payload, taskRunResult, duration);
|
|
172
172
|
return duration;
|
|
173
173
|
});
|
|
174
|
-
|
|
175
|
-
|
|
174
|
+
const value = result.match({
|
|
175
|
+
ok: /* @__PURE__ */ __name((value2) => value2, "ok"),
|
|
176
|
+
err(error) {
|
|
177
|
+
container.client.emit(ScheduledTaskEvents.ScheduledTaskError, error, piece, payload);
|
|
178
|
+
throw error;
|
|
179
|
+
}
|
|
180
|
+
});
|
|
176
181
|
container.client.emit(ScheduledTaskEvents.ScheduledTaskFinished, piece, value, payload);
|
|
177
182
|
return value;
|
|
178
183
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../../src/lib/ScheduledTaskHandler.ts"],"names":[],"mappings":";;;;;;;AAAA,IAAA,OAAA,EAAA,OAAA;AAsBO,IAAM,qBAAA,GAAN,MAAM,qBAAA,CAAqB;AAAA,EAc1B,YAAY,OAAA,EAAsC;AAVzD;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,SAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;AAEhB,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AAGC,IAAA,IAAA,CAAK,KAAA,GAAQ,QAAQ,KAAA,IAAS,iBAAA;AAC9B,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,IAAA;AAEvB,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAI,KAAA,CAAM,IAAA,CAAK,KAAA,EAAO,KAAK,OAAO,CAAA,CAAA;AACjD,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAI,MAAA;AAAA,MAClB,IAAA,CAAK,KAAA;AAAA;AAAA,MACL,OAAO,GAAA,KAAQ,IAAA,CAAK,GAAA,CAAI,EAAE,IAAA,EAAM,GAAA,CAAI,IAAA,EAA4B,OAAA,EAAS,GAAA,CAAI,IAAA,EAAM,CAAA;AAAA,MACnF,EAAE,UAAA,EAAY,IAAA,CAAK,OAAA,CAAQ,UAAA;AAAW,KACvC,CAAA;AAEA,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAI,oBAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AACD,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAI,oBAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AAAA,EAEA,IAAW,MAAA,GAAqB;AAC/B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA;AAAA,EACb;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,KAAA,GAAuB;AACnC,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MACjB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA,EAAM;AAAA;AAAA,MACnB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA;AAAM,KACnB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,MAAA,CACZ,IAAA,EACA,OAAA,EACgC;AAChC,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AAEzD,IAAA,IAAI,SAAA,CAAU,OAAO,CAAA,EAAG;AACvB,MAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,OAAO,CAAA;AAAA,IAC1C;AAEA,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAChC,MAAA,OAAA,GAAU;AAAA,QACT,QAAA,EAAU,KAAA;AAAA,QACV,KAAA,EAAO;AAAA,OACR;AAAA,IACD;AAEA,IAAA,MAAM,EAAE,QAAA,EAAU,OAAA,EAAS,UAAU,KAAA,EAAO,gBAAA,EAAkB,UAAS,GAAI,OAAA;AAC3E,IAAA,IAAI,UAAA,GAA0B;AAAA,MAC7B,KAAA;AAAA,MACA,GAAG;AAAA,KACJ;AAEA,IAAA,IAAI,QAAA,EAAU;AACb,MAAA,UAAA,GAAa;AAAA,QACZ,GAAG,UAAA;AAAA,QACH,MAAA,EAAQ,WACL,EAAE,KAAA,EAAO,UAAS,GAClB,EAAE,OAAA,EAAS,EAAA,EAAI,QAAA;AAAS,OAC5B;AAAA,IACD;AAEA,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,SAAS,UAAU,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,eAAe,KAAA,EAA0D;AACrF,IAAA,IAAI,UAAU,MAAA,EAAW;AACxB,MAAA,MAAM,gBAAmD,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc,GAAA,CAAI,CAAC,KAAA,MAAW;AAAA,QACjG,MAAM,KAAA,CAAM,IAAA;AAAA,QACZ,OAAA,EAAS;AAAA,UACR,QAAA,EAAU,IAAA;AAAA,UACV,GAAI,MAAM,QAAA,GACP;AAAA,YACA,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA,WACzB,GACC;AAAA,YACA,SAAS,KAAA,CAAM,OAAA;AAAA,YACf,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA;AACzB;AACH,OACD,CAAE,CAAA;AAEF,MAAA,KAAA,GAAQ,aAAA;AAAA,IACT;AAEA,IAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACzB,MAAA,MAAM,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,IAAA,EAAM,KAAK,OAAO,CAAA;AAAA,IAC1C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,OAAO,EAAA,EAA2B;AAC9C,IAAA,MAAM,GAAA,GAAO,MAAM,IAAA,CAAK,GAAA,CAAI,EAAwB,CAAA;AACpD,IAAA,OAAO,KAAK,MAAA,EAAO;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,KAAK,OAAA,EAA4D;AACvE,IAAA,MAAM,EAAE,KAAA,EAAO,KAAA,EAAO,GAAA,EAAK,KAAI,GAAI,OAAA;AAEnC,IAAA,OAAO,mBAAK,OAAA,CAAA,CAAQ,OAAA,CAAQ,KAAA,EAAO,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,aAAa,OAAA,EAAyF;AAC5G,IAAA,MAAM,EAAE,KAAA,EAAO,GAAA,EAAK,GAAA,EAAI,GAAI,OAAA;AAE5B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,iBAAA,CAAkB,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,IAAkC,EAAA,EAA2D;AACzG,IAAA,MAAM,GAAA,GAAM,MAAM,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,OAAO,EAAE,CAAA;AACxC,IAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG,OAAO,MAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,IAAI,IAAA,EAAoE;AACpF,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AACzD,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,KAAK,IAAI,CAAA;AAEtC,IAAA,IAAI,CAAC,KAAA,EAAO;AACX,MAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,qBAAA,EAAuB,UAAU,OAAO,CAAA;AAElF,MAAA,OAAO,MAAA;AAAA,IACR;AAEA,IAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,SAAA,CAAU,YAAY;AACjD,MAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,gBAAA,EAAkB,OAAO,OAAO,CAAA;AAE1E,MAAA,MAAM,SAAA,GAAY,IAAI,SAAA,EAAU;AAChC,MAAA,MAAM,aAAA,GAAgB,MAAM,KAAA,CAAM,GAAA,CAAI,OAAO,CAAA;AAC7C,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,SAAA,CAAU,IAAA,EAAK;AAEpC,MAAA,SAAA,CAAU,OAAO,IAAA,CAAK,mBAAA,CAAoB,sBAAsB,KAAA,EAAO,OAAA,EAAS,eAAe,QAAQ,CAAA;AAEvG,MAAA,OAAO,QAAA;AAAA,IACR,CAAC,CAAA;AAED,IAAA,MAAA,CAAO,UAAA,CAAW,CAAC,KAAA,KAAU,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,kBAAA,EAAoB,KAAA,EAAO,KAAA,EAAO,OAAO,CAAC,CAAA;AAEjH,IAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,QAAA,CAAS,IAAI,CAAA;AAElC,IAAA,SAAA,CAAU,OAAO,IAAA,CAAK,mBAAA,CAAoB,qBAAA,EAAuB,KAAA,EAAO,OAAO,OAAO,CAAA;AAEtF,IAAA,OAAO,KAAA;AAAA,EACR;AAAA,EAEA,IAAY,KAAA,GAA4B;AACvC,IAAA,OAAO,SAAA,CAAU,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,iBAAiB,CAAA;AAAA,EACrD;AAAA,EAEQ,YAAY,IAAA,EAAiE;AACpF,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC7B,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,EAAM,OAAA,EAAS,MAAA,EAAU;AAAA,IACzC;AAEA,IAAA,IAAI,aAAa,IAAA,EAAM;AACtB,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,OAAA,EAAS,KAAK,OAAA,EAAQ;AAAA,IACjD;AAEA,IAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,SAAS,MAAA,EAAU;AAAA,EAC9C;AACD,CAAA;AAtNC,OAAA,GAAA,IAAA,OAAA,EAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;AAZiC,MAAA,CAAA,qBAAA,EAAA,sBAAA,CAAA;AAA3B,IAAM,oBAAA,GAAN","file":"ScheduledTaskHandler.mjs","sourcesContent":["import { container, Result } from '@sapphire/framework';\nimport { Stopwatch } from '@sapphire/stopwatch';\nimport { Job, Queue, Worker, type JobsOptions, type QueueOptions, isNotConnectionError } from 'bullmq';\nimport type { ScheduledTaskStore } from './structures/ScheduledTaskStore';\nimport { ScheduledTaskEvents } from './types/ScheduledTaskEvents';\nimport type {\n\tBullClient,\n\tScheduledTaskCreateRepeatedTask,\n\tScheduledTaskHandlerOptions,\n\tScheduledTaskListOptions,\n\tScheduledTaskListRepeatedOptions,\n\tScheduledTaskListRepeatedReturnType,\n\tScheduledTasksResolvable,\n\tScheduledTasksKeys,\n\tScheduledTasksTaskOptions,\n\tScheduledTasksKeysNoPayload,\n\tScheduledTasksJob,\n\tScheduledTasksResolvablePayload,\n\tScheduledTasksPayload\n} from './types/ScheduledTaskTypes';\nimport { isNullish } from '@sapphire/utilities';\n\nexport class ScheduledTaskHandler {\n\t/**\n\t * The queue options for the scheduled task handler.\n\t */\n\tpublic readonly options: QueueOptions;\n\n\t/**\n\t * The name of the queue associated with the scheduled task handler.\n\t */\n\tpublic readonly queue: string;\n\n\t#client: BullClient;\n\t#worker: Worker;\n\n\tpublic constructor(options: ScheduledTaskHandlerOptions) {\n\t\tthis.queue = options.queue ?? 'scheduled-tasks';\n\t\tthis.options = options.bull;\n\n\t\tthis.#client = new Queue(this.queue, this.options);\n\t\tthis.#worker = new Worker(\n\t\t\tthis.queue, //\n\t\t\tasync (job) => this.run({ name: job.name as ScheduledTasksKeys, payload: job.data }),\n\t\t\t{ connection: this.options.connection }\n\t\t);\n\n\t\tthis.#client.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyClientError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t\tthis.#worker.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyWorkerError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic get client(): BullClient {\n\t\treturn this.#client;\n\t}\n\n\t/**\n\t * Closes the internal client and worker.\n\t */\n\tpublic async close(): Promise<void> {\n\t\tawait Promise.all([\n\t\t\tthis.#client.close(), //\n\t\t\tthis.#worker.close()\n\t\t]);\n\t}\n\n\t/**\n\t * Creates a scheduled task.\n\t *\n\t * @param task - The task to be scheduled.\n\t * @param options - The options for the task.\n\t */\n\tpublic async create<T extends ScheduledTasksResolvable>(\n\t\ttask: T, //\n\t\toptions?: ScheduledTasksTaskOptions | number\n\t): Promise<ScheduledTasksJob<T>> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\n\t\tif (isNullish(options)) {\n\t\t\treturn this.#client.add(taskName, payload) as Promise<ScheduledTasksJob<T>>;\n\t\t}\n\n\t\tif (typeof options === 'number') {\n\t\t\toptions = {\n\t\t\t\trepeated: false,\n\t\t\t\tdelay: options\n\t\t\t};\n\t\t}\n\n\t\tconst { repeated, pattern, interval, delay, customJobOptions, timezone } = options;\n\t\tlet jobOptions: JobsOptions = {\n\t\t\tdelay,\n\t\t\t...customJobOptions\n\t\t};\n\n\t\tif (repeated) {\n\t\t\tjobOptions = {\n\t\t\t\t...jobOptions,\n\t\t\t\trepeat: interval //\n\t\t\t\t\t? { every: interval }\n\t\t\t\t\t: { pattern, tz: timezone }\n\t\t\t};\n\t\t}\n\n\t\treturn this.#client.add(taskName, payload, jobOptions) as Promise<ScheduledTasksJob<T>>;\n\t}\n\n\t/**\n\t * Creates repeated tasks.\n\t *\n\t * @param tasks - An optional array of tasks to create. If not provided, it will create tasks based on the stored repeated tasks.\n\t */\n\tpublic async createRepeated(tasks?: ScheduledTaskCreateRepeatedTask[]): Promise<void> {\n\t\tif (tasks === undefined) {\n\t\t\tconst repeatedTasks: ScheduledTaskCreateRepeatedTask[] = this.store.repeatedTasks.map((piece) => ({\n\t\t\t\tname: piece.name as ScheduledTasksKeysNoPayload,\n\t\t\t\toptions: {\n\t\t\t\t\trepeated: true,\n\t\t\t\t\t...(piece.interval\n\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\tinterval: piece.interval,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\tpattern: piece.pattern!,\n\t\t\t\t\t\t\t\ttimezone: piece.timezone,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t}));\n\n\t\t\ttasks = repeatedTasks;\n\t\t}\n\n\t\tfor (const task of tasks) {\n\t\t\tawait this.create(task.name, task.options);\n\t\t}\n\t}\n\n\t/**\n\t * Deletes a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the task to delete.\n\t */\n\tpublic async delete(id: string): Promise<void> {\n\t\tconst job = (await this.get(id as ScheduledTasksKeys)) as unknown as Job<unknown> | undefined;\n\t\treturn job?.remove();\n\t}\n\n\t/**\n\t * Retrieves a list of scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of scheduled tasks.\n\t */\n\tpublic list(options: ScheduledTaskListOptions): Promise<Job<unknown>[]> {\n\t\tconst { types, start, end, asc } = options;\n\n\t\treturn this.#client.getJobs(types, start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a list of repeated scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of repeated scheduled tasks.\n\t */\n\tpublic listRepeated(options: ScheduledTaskListRepeatedOptions): Promise<ScheduledTaskListRepeatedReturnType> {\n\t\tconst { start, end, asc } = options;\n\n\t\treturn this.#client.getRepeatableJobs(start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the scheduled task to retrieve.\n\t */\n\tpublic async get<T extends ScheduledTasksKeys>(id: T): Promise<Job<ScheduledTasksPayload<T>> | undefined> {\n\t\tconst job = await this.#client.getJob(id);\n\t\tif (isNullish(job)) return undefined;\n\n\t\treturn job as Job<ScheduledTasksPayload<T>>;\n\t}\n\n\t/**\n\t * Runs a scheduled task with the given name and payload.\n\t *\n\t * @param task - The name of the scheduled task to run.\n\t *\n\t * @remarks `undefined` will be returned if the task was not found.\n\t */\n\tpublic async run(task: ScheduledTasksResolvable): Promise<number | null | undefined> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\t\tconst piece = this.store.get(task.name);\n\n\t\tif (!piece) {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskNotFound, taskName, payload);\n\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst result = await Result.fromAsync(async () => {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskRun, piece, payload);\n\n\t\t\tconst stopwatch = new Stopwatch();\n\t\t\tconst taskRunResult = await piece.run(payload);\n\t\t\tconst { duration } = stopwatch.stop();\n\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskSuccess, piece, payload, taskRunResult, duration);\n\n\t\t\treturn duration;\n\t\t});\n\n\t\tresult.inspectErr((error) => container.client.emit(ScheduledTaskEvents.ScheduledTaskError, error, piece, payload));\n\n\t\tconst value = result.unwrapOr(null);\n\n\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskFinished, piece, value, payload);\n\n\t\treturn value;\n\t}\n\n\tprivate get store(): ScheduledTaskStore {\n\t\treturn container.client.stores.get('scheduled-tasks');\n\t}\n\n\tprivate resolveTask(task: ScheduledTasksResolvable): ScheduledTasksResolvablePayload {\n\t\tif (typeof task === 'string') {\n\t\t\treturn { name: task, payload: undefined };\n\t\t}\n\n\t\tif ('payload' in task) {\n\t\t\treturn { name: task.name, payload: task.payload };\n\t\t}\n\n\t\treturn { name: task.name, payload: undefined };\n\t}\n}\n"]}
|
|
1
|
+
{"version":3,"sources":["../../../src/lib/ScheduledTaskHandler.ts"],"names":["value"],"mappings":";;;;;;;AAAA,IAAA,OAAA,EAAA,OAAA;AAsBO,IAAM,qBAAA,GAAN,MAAM,qBAAA,CAAqB;AAAA,EAc1B,YAAY,OAAA,EAAsC;AAVzD;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,SAAA,CAAA;AAKhB;AAAA;AAAA;AAAA,IAAA,aAAA,CAAA,IAAA,EAAgB,OAAA,CAAA;AAEhB,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AACA,IAAA,YAAA,CAAA,IAAA,EAAA,OAAA,CAAA;AAGC,IAAA,IAAA,CAAK,KAAA,GAAQ,QAAQ,KAAA,IAAS,iBAAA;AAC9B,IAAA,IAAA,CAAK,UAAU,OAAA,CAAQ,IAAA;AAEvB,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAI,KAAA,CAAM,IAAA,CAAK,KAAA,EAAO,KAAK,OAAO,CAAA,CAAA;AACjD,IAAA,YAAA,CAAA,IAAA,EAAK,SAAU,IAAI,MAAA;AAAA,MAClB,IAAA,CAAK,KAAA;AAAA;AAAA,MACL,OAAO,GAAA,KAAQ,IAAA,CAAK,GAAA,CAAI,EAAE,IAAA,EAAM,GAAA,CAAI,IAAA,EAA4B,OAAA,EAAS,GAAA,CAAI,IAAA,EAAM,CAAA;AAAA,MACnF,EAAE,UAAA,EAAY,IAAA,CAAK,OAAA,CAAQ,UAAA;AAAW,KACvC,CAAA;AAEA,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAI,oBAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AACD,IAAA,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAU;AACnC,MAAA,IAAI,oBAAA,CAAqB,KAAK,CAAA,EAAG;AAChC,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,gCAAA,EAAkC,KAAK,CAAA;AAAA,MAClF,CAAA,MAAO;AACN,QAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,iCAAA,EAAmC,KAAK,CAAA;AAAA,MACnF;AAAA,IACD,CAAC,CAAA;AAAA,EACF;AAAA,EAEA,IAAW,MAAA,GAAqB;AAC/B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA;AAAA,EACb;AAAA;AAAA;AAAA;AAAA,EAKA,MAAa,KAAA,GAAuB;AACnC,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MACjB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA,EAAM;AAAA;AAAA,MACnB,YAAA,CAAA,IAAA,EAAK,SAAQ,KAAA;AAAM,KACnB,CAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,MAAA,CACZ,IAAA,EACA,OAAA,EACgC;AAChC,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AAEzD,IAAA,IAAI,SAAA,CAAU,OAAO,CAAA,EAAG;AACvB,MAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,OAAO,CAAA;AAAA,IAC1C;AAEA,IAAA,IAAI,OAAO,YAAY,QAAA,EAAU;AAChC,MAAA,OAAA,GAAU;AAAA,QACT,QAAA,EAAU,KAAA;AAAA,QACV,KAAA,EAAO;AAAA,OACR;AAAA,IACD;AAEA,IAAA,MAAM,EAAE,QAAA,EAAU,OAAA,EAAS,UAAU,KAAA,EAAO,gBAAA,EAAkB,UAAS,GAAI,OAAA;AAC3E,IAAA,IAAI,UAAA,GAA0B;AAAA,MAC7B,KAAA;AAAA,MACA,GAAG;AAAA,KACJ;AAEA,IAAA,IAAI,QAAA,EAAU;AACb,MAAA,UAAA,GAAa;AAAA,QACZ,GAAG,UAAA;AAAA,QACH,MAAA,EAAQ,WACL,EAAE,KAAA,EAAO,UAAS,GAClB,EAAE,OAAA,EAAS,EAAA,EAAI,QAAA;AAAS,OAC5B;AAAA,IACD;AAEA,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,GAAA,CAAI,QAAA,EAAU,SAAS,UAAU,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,eAAe,KAAA,EAA0D;AACrF,IAAA,IAAI,UAAU,MAAA,EAAW;AACxB,MAAA,MAAM,gBAAmD,IAAA,CAAK,KAAA,CAAM,aAAA,CAAc,GAAA,CAAI,CAAC,KAAA,MAAW;AAAA,QACjG,MAAM,KAAA,CAAM,IAAA;AAAA,QACZ,OAAA,EAAS;AAAA,UACR,QAAA,EAAU,IAAA;AAAA,UACV,GAAI,MAAM,QAAA,GACP;AAAA,YACA,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA,WACzB,GACC;AAAA,YACA,SAAS,KAAA,CAAM,OAAA;AAAA,YACf,UAAU,KAAA,CAAM,QAAA;AAAA,YAChB,kBAAkB,KAAA,CAAM;AAAA;AACzB;AACH,OACD,CAAE,CAAA;AAEF,MAAA,KAAA,GAAQ,aAAA;AAAA,IACT;AAEA,IAAA,KAAA,MAAW,QAAQ,KAAA,EAAO;AACzB,MAAA,MAAM,IAAA,CAAK,MAAA,CAAO,IAAA,CAAK,IAAA,EAAM,KAAK,OAAO,CAAA;AAAA,IAC1C;AAAA,EACD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,OAAO,EAAA,EAA2B;AAC9C,IAAA,MAAM,GAAA,GAAO,MAAM,IAAA,CAAK,GAAA,CAAI,EAAwB,CAAA;AACpD,IAAA,OAAO,KAAK,MAAA,EAAO;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,KAAK,OAAA,EAA4D;AACvE,IAAA,MAAM,EAAE,KAAA,EAAO,KAAA,EAAO,GAAA,EAAK,KAAI,GAAI,OAAA;AAEnC,IAAA,OAAO,mBAAK,OAAA,CAAA,CAAQ,OAAA,CAAQ,KAAA,EAAO,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,aAAa,OAAA,EAAyF;AAC5G,IAAA,MAAM,EAAE,KAAA,EAAO,GAAA,EAAK,GAAA,EAAI,GAAI,OAAA;AAE5B,IAAA,OAAO,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,iBAAA,CAAkB,KAAA,EAAO,KAAK,GAAG,CAAA;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,IAAkC,EAAA,EAA2D;AACzG,IAAA,MAAM,GAAA,GAAM,MAAM,YAAA,CAAA,IAAA,EAAK,OAAA,CAAA,CAAQ,OAAO,EAAE,CAAA;AACxC,IAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG,OAAO,MAAA;AAE3B,IAAA,OAAO,GAAA;AAAA,EACR;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,IAAI,IAAA,EAAoE;AACpF,IAAA,MAAM,EAAE,IAAA,EAAM,QAAA,EAAU,SAAQ,GAAI,IAAA,CAAK,YAAY,IAAI,CAAA;AACzD,IAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,KAAK,IAAI,CAAA;AAEtC,IAAA,IAAI,CAAC,KAAA,EAAO;AACX,MAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,qBAAA,EAAuB,UAAU,OAAO,CAAA;AAElF,MAAA,OAAO,MAAA;AAAA,IACR;AAEA,IAAA,MAAM,MAAA,GAAS,MAAM,MAAA,CAAO,SAAA,CAAU,YAAY;AACjD,MAAA,SAAA,CAAU,MAAA,CAAO,IAAA,CAAK,mBAAA,CAAoB,gBAAA,EAAkB,OAAO,OAAO,CAAA;AAE1E,MAAA,MAAM,SAAA,GAAY,IAAI,SAAA,EAAU;AAChC,MAAA,MAAM,aAAA,GAAgB,MAAM,KAAA,CAAM,GAAA,CAAI,OAAO,CAAA;AAC7C,MAAA,MAAM,EAAE,QAAA,EAAS,GAAI,SAAA,CAAU,IAAA,EAAK;AAEpC,MAAA,SAAA,CAAU,OAAO,IAAA,CAAK,mBAAA,CAAoB,sBAAsB,KAAA,EAAO,OAAA,EAAS,eAAe,QAAQ,CAAA;AAEvG,MAAA,OAAO,QAAA;AAAA,IACR,CAAC,CAAA;AAED,IAAA,MAAM,KAAA,GAAQ,OAAO,KAAA,CAAM;AAAA,MAC1B,EAAA,kBAAI,MAAA,CAAA,CAACA,MAAAA,KAAUA,MAAAA,EAAX,IAAA,CAAA;AAAA,MACJ,IAAI,KAAA,EAAO;AACV,QAAA,SAAA,CAAU,OAAO,IAAA,CAAK,mBAAA,CAAoB,kBAAA,EAAoB,KAAA,EAAO,OAAO,OAAO,CAAA;AACnF,QAAA,MAAM,KAAA;AAAA,MACP;AAAA,KACA,CAAA;AAED,IAAA,SAAA,CAAU,OAAO,IAAA,CAAK,mBAAA,CAAoB,qBAAA,EAAuB,KAAA,EAAO,OAAO,OAAO,CAAA;AAEtF,IAAA,OAAO,KAAA;AAAA,EACR;AAAA,EAEA,IAAY,KAAA,GAA4B;AACvC,IAAA,OAAO,SAAA,CAAU,MAAA,CAAO,MAAA,CAAO,GAAA,CAAI,iBAAiB,CAAA;AAAA,EACrD;AAAA,EAEQ,YAAY,IAAA,EAAiE;AACpF,IAAA,IAAI,OAAO,SAAS,QAAA,EAAU;AAC7B,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,EAAM,OAAA,EAAS,MAAA,EAAU;AAAA,IACzC;AAEA,IAAA,IAAI,aAAa,IAAA,EAAM;AACtB,MAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,OAAA,EAAS,KAAK,OAAA,EAAQ;AAAA,IACjD;AAEA,IAAA,OAAO,EAAE,IAAA,EAAM,IAAA,CAAK,IAAA,EAAM,SAAS,MAAA,EAAU;AAAA,EAC9C;AACD,CAAA;AA1NC,OAAA,GAAA,IAAA,OAAA,EAAA;AACA,OAAA,GAAA,IAAA,OAAA,EAAA;AAZiC,MAAA,CAAA,qBAAA,EAAA,sBAAA,CAAA;AAA3B,IAAM,oBAAA,GAAN","file":"ScheduledTaskHandler.mjs","sourcesContent":["import { container, Result } from '@sapphire/framework';\nimport { Stopwatch } from '@sapphire/stopwatch';\nimport { Job, Queue, Worker, type JobsOptions, type QueueOptions, isNotConnectionError } from 'bullmq';\nimport type { ScheduledTaskStore } from './structures/ScheduledTaskStore';\nimport { ScheduledTaskEvents } from './types/ScheduledTaskEvents';\nimport type {\n\tBullClient,\n\tScheduledTaskCreateRepeatedTask,\n\tScheduledTaskHandlerOptions,\n\tScheduledTaskListOptions,\n\tScheduledTaskListRepeatedOptions,\n\tScheduledTaskListRepeatedReturnType,\n\tScheduledTasksResolvable,\n\tScheduledTasksKeys,\n\tScheduledTasksTaskOptions,\n\tScheduledTasksKeysNoPayload,\n\tScheduledTasksJob,\n\tScheduledTasksResolvablePayload,\n\tScheduledTasksPayload\n} from './types/ScheduledTaskTypes';\nimport { isNullish } from '@sapphire/utilities';\n\nexport class ScheduledTaskHandler {\n\t/**\n\t * The queue options for the scheduled task handler.\n\t */\n\tpublic readonly options: QueueOptions;\n\n\t/**\n\t * The name of the queue associated with the scheduled task handler.\n\t */\n\tpublic readonly queue: string;\n\n\t#client: BullClient;\n\t#worker: Worker;\n\n\tpublic constructor(options: ScheduledTaskHandlerOptions) {\n\t\tthis.queue = options.queue ?? 'scheduled-tasks';\n\t\tthis.options = options.bull;\n\n\t\tthis.#client = new Queue(this.queue, this.options);\n\t\tthis.#worker = new Worker(\n\t\t\tthis.queue, //\n\t\t\tasync (job) => this.run({ name: job.name as ScheduledTasksKeys, payload: job.data }),\n\t\t\t{ connection: this.options.connection }\n\t\t);\n\n\t\tthis.#client.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyClientError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t\tthis.#worker.on('error', (error) => {\n\t\t\tif (isNotConnectionError(error)) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyWorkerError, error);\n\t\t\t} else {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskStrategyConnectError, error);\n\t\t\t}\n\t\t});\n\t}\n\n\tpublic get client(): BullClient {\n\t\treturn this.#client;\n\t}\n\n\t/**\n\t * Closes the internal client and worker.\n\t */\n\tpublic async close(): Promise<void> {\n\t\tawait Promise.all([\n\t\t\tthis.#client.close(), //\n\t\t\tthis.#worker.close()\n\t\t]);\n\t}\n\n\t/**\n\t * Creates a scheduled task.\n\t *\n\t * @param task - The task to be scheduled.\n\t * @param options - The options for the task.\n\t */\n\tpublic async create<T extends ScheduledTasksResolvable>(\n\t\ttask: T, //\n\t\toptions?: ScheduledTasksTaskOptions | number\n\t): Promise<ScheduledTasksJob<T>> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\n\t\tif (isNullish(options)) {\n\t\t\treturn this.#client.add(taskName, payload) as Promise<ScheduledTasksJob<T>>;\n\t\t}\n\n\t\tif (typeof options === 'number') {\n\t\t\toptions = {\n\t\t\t\trepeated: false,\n\t\t\t\tdelay: options\n\t\t\t};\n\t\t}\n\n\t\tconst { repeated, pattern, interval, delay, customJobOptions, timezone } = options;\n\t\tlet jobOptions: JobsOptions = {\n\t\t\tdelay,\n\t\t\t...customJobOptions\n\t\t};\n\n\t\tif (repeated) {\n\t\t\tjobOptions = {\n\t\t\t\t...jobOptions,\n\t\t\t\trepeat: interval //\n\t\t\t\t\t? { every: interval }\n\t\t\t\t\t: { pattern, tz: timezone }\n\t\t\t};\n\t\t}\n\n\t\treturn this.#client.add(taskName, payload, jobOptions) as Promise<ScheduledTasksJob<T>>;\n\t}\n\n\t/**\n\t * Creates repeated tasks.\n\t *\n\t * @param tasks - An optional array of tasks to create. If not provided, it will create tasks based on the stored repeated tasks.\n\t */\n\tpublic async createRepeated(tasks?: ScheduledTaskCreateRepeatedTask[]): Promise<void> {\n\t\tif (tasks === undefined) {\n\t\t\tconst repeatedTasks: ScheduledTaskCreateRepeatedTask[] = this.store.repeatedTasks.map((piece) => ({\n\t\t\t\tname: piece.name as ScheduledTasksKeysNoPayload,\n\t\t\t\toptions: {\n\t\t\t\t\trepeated: true,\n\t\t\t\t\t...(piece.interval\n\t\t\t\t\t\t? {\n\t\t\t\t\t\t\t\tinterval: piece.interval,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t: {\n\t\t\t\t\t\t\t\tpattern: piece.pattern!,\n\t\t\t\t\t\t\t\ttimezone: piece.timezone,\n\t\t\t\t\t\t\t\tcustomJobOptions: piece.customJobOptions\n\t\t\t\t\t\t\t})\n\t\t\t\t}\n\t\t\t}));\n\n\t\t\ttasks = repeatedTasks;\n\t\t}\n\n\t\tfor (const task of tasks) {\n\t\t\tawait this.create(task.name, task.options);\n\t\t}\n\t}\n\n\t/**\n\t * Deletes a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the task to delete.\n\t */\n\tpublic async delete(id: string): Promise<void> {\n\t\tconst job = (await this.get(id as ScheduledTasksKeys)) as unknown as Job<unknown> | undefined;\n\t\treturn job?.remove();\n\t}\n\n\t/**\n\t * Retrieves a list of scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of scheduled tasks.\n\t */\n\tpublic list(options: ScheduledTaskListOptions): Promise<Job<unknown>[]> {\n\t\tconst { types, start, end, asc } = options;\n\n\t\treturn this.#client.getJobs(types, start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a list of repeated scheduled tasks based on the provided options.\n\t *\n\t * @param options - The options for filtering the list of repeated scheduled tasks.\n\t */\n\tpublic listRepeated(options: ScheduledTaskListRepeatedOptions): Promise<ScheduledTaskListRepeatedReturnType> {\n\t\tconst { start, end, asc } = options;\n\n\t\treturn this.#client.getRepeatableJobs(start, end, asc);\n\t}\n\n\t/**\n\t * Retrieves a scheduled task by its ID.\n\t *\n\t * @param id - The ID of the scheduled task to retrieve.\n\t */\n\tpublic async get<T extends ScheduledTasksKeys>(id: T): Promise<Job<ScheduledTasksPayload<T>> | undefined> {\n\t\tconst job = await this.#client.getJob(id);\n\t\tif (isNullish(job)) return undefined;\n\n\t\treturn job as Job<ScheduledTasksPayload<T>>;\n\t}\n\n\t/**\n\t * Runs a scheduled task with the given name and payload.\n\t *\n\t * @param task - The name of the scheduled task to run.\n\t *\n\t * @remarks `undefined` will be returned if the task was not found.\n\t */\n\tpublic async run(task: ScheduledTasksResolvable): Promise<number | null | undefined> {\n\t\tconst { name: taskName, payload } = this.resolveTask(task);\n\t\tconst piece = this.store.get(task.name);\n\n\t\tif (!piece) {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskNotFound, taskName, payload);\n\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst result = await Result.fromAsync(async () => {\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskRun, piece, payload);\n\n\t\t\tconst stopwatch = new Stopwatch();\n\t\t\tconst taskRunResult = await piece.run(payload);\n\t\t\tconst { duration } = stopwatch.stop();\n\n\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskSuccess, piece, payload, taskRunResult, duration);\n\n\t\t\treturn duration;\n\t\t});\n\n\t\tconst value = result.match({\n\t\t\tok: (value) => value,\n\t\t\terr(error) {\n\t\t\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskError, error, piece, payload);\n\t\t\t\tthrow error;\n\t\t\t}\n\t\t});\n\n\t\tcontainer.client.emit(ScheduledTaskEvents.ScheduledTaskFinished, piece, value, payload);\n\n\t\treturn value;\n\t}\n\n\tprivate get store(): ScheduledTaskStore {\n\t\treturn container.client.stores.get('scheduled-tasks');\n\t}\n\n\tprivate resolveTask(task: ScheduledTasksResolvable): ScheduledTasksResolvablePayload {\n\t\tif (typeof task === 'string') {\n\t\t\treturn { name: task, payload: undefined };\n\t\t}\n\n\t\tif ('payload' in task) {\n\t\t\treturn { name: task.name, payload: task.payload };\n\t\t}\n\n\t\treturn { name: task.name, payload: undefined };\n\t}\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sapphire/plugin-scheduled-tasks",
|
|
3
|
-
"version": "10.0.4
|
|
3
|
+
"version": "10.0.4",
|
|
4
4
|
"description": "Plugin for @sapphire/framework to have scheduled tasks",
|
|
5
5
|
"author": "@sapphire",
|
|
6
6
|
"license": "MIT",
|
|
@@ -51,14 +51,14 @@
|
|
|
51
51
|
"dependencies": {
|
|
52
52
|
"@sapphire/stopwatch": "^1.5.4",
|
|
53
53
|
"@sapphire/utilities": "^3.18.2",
|
|
54
|
-
"bullmq": "5.58.
|
|
54
|
+
"bullmq": "5.58.7"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
57
|
"@favware/cliff-jumper": "^6.0.0",
|
|
58
58
|
"@favware/rollup-type-bundler": "^4.0.0",
|
|
59
|
-
"concurrently": "^9.2.
|
|
59
|
+
"concurrently": "^9.2.1",
|
|
60
60
|
"tsup": "^8.5.0",
|
|
61
|
-
"tsx": "^4.20.
|
|
61
|
+
"tsx": "^4.20.5",
|
|
62
62
|
"typedoc": "^0.26.11",
|
|
63
63
|
"typedoc-json-parser": "^10.2.0",
|
|
64
64
|
"typescript": "~5.4.5"
|