zumito-framework 1.2.8 → 1.2.10

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.
@@ -1,6 +1,6 @@
1
1
  import { Client, GuildMember, TextChannel } from 'discord.js';
2
2
  import { DatabaseModel } from './definitions/DatabaseModel.js';
3
- import { EventEmitter } from 'events';
3
+ import { EventEmitter } from "tseep";
4
4
  import { FrameworkEvent } from './definitions/FrameworkEvent.js';
5
5
  import { FrameworkSettings } from './definitions/FrameworkSettings.js';
6
6
  import { StatusManager } from './services/StatusManager.js';
@@ -72,10 +72,10 @@ export declare class ZumitoFramework {
72
72
  */
73
73
  models: Array<DatabaseModel>;
74
74
  /**
75
- * The canario database schema instance.
76
- * @type {canario.Schema}
75
+ * The zumito-db database schema instance.
76
+ * @type {zumitoDb.Schema}
77
77
  * @private
78
- * @see {@link https://www.npmjs.com/package/canario}
78
+ * @see {@link https://www.npmjs.com/package/zumito-db}
79
79
  */
80
80
  database: any;
81
81
  /**
@@ -99,7 +99,7 @@ export declare class ZumitoFramework {
99
99
  * @private
100
100
  * @see {@link https://nodejs.org/api/events.html#events_class_eventemitter}
101
101
  */
102
- eventEmitter: EventEmitter;
102
+ eventEmitter: EventEmitter<import("tseep").DefaultEventMap>;
103
103
  /**
104
104
  * Event manager for the framework.
105
105
  * All events related to the framework and discord.js are handled here.
@@ -144,15 +144,21 @@ export declare class ZumitoFramework {
144
144
  */
145
145
  private initializeDiscordClient;
146
146
  /**
147
- * @deprecated use CommandParser service instead
147
+ * Use CommandParser service instead
148
+ *
149
+ * @deprecated
148
150
  */
149
151
  static splitCommandLine(commandLine: any): any;
150
152
  /**
151
- * @deprecated use MemberPermissionChecker service
153
+ * Use MemberPermissionChecker service
154
+ *
155
+ * @deprecated
152
156
  */
153
157
  memberHasPermission(member: GuildMember, channel: TextChannel, permission: bigint): Promise<any>;
154
158
  /**
155
- * @deprecated use GuildDataGetter service
159
+ * Use GuildDataGetter service
160
+ *
161
+ * @deprecated
156
162
  */
157
163
  getGuildSettings(guildId: string): Promise<unknown>;
158
164
  /**
@@ -2,11 +2,11 @@ import * as fs from 'fs';
2
2
  import * as url from 'url';
3
3
  import { Client, } from 'discord.js';
4
4
  import { ApiResponse } from './definitions/api/ApiResponse.js';
5
- import { EventEmitter } from 'events';
5
+ import { EventEmitter } from "tseep";
6
6
  import { StatusManager } from './services/StatusManager.js';
7
7
  import { TranslationManager } from './services/TranslationManager.js';
8
8
  import { betterLogging } from 'better-logging';
9
- import canario from 'canario';
9
+ import zumitoDb from 'zumito-db';
10
10
  import cookieParser from 'cookie-parser';
11
11
  import cors from 'cors';
12
12
  import express from 'express';
@@ -87,10 +87,10 @@ export class ZumitoFramework {
87
87
  */
88
88
  models;
89
89
  /**
90
- * The canario database schema instance.
91
- * @type {canario.Schema}
90
+ * The zumito-db database schema instance.
91
+ * @type {zumitoDb.Schema}
92
92
  * @private
93
- * @see {@link https://www.npmjs.com/package/canario}
93
+ * @see {@link https://www.npmjs.com/package/zumito-db}
94
94
  */
95
95
  database;
96
96
  /**
@@ -177,7 +177,7 @@ export class ZumitoFramework {
177
177
  fs.mkdirSync(folder);
178
178
  }
179
179
  }
180
- this.database = new canario.Schema(this.settings?.database?.type || 'tingodb', this.settings?.database || {});
180
+ this.database = new zumitoDb.Schema(this.settings?.database?.type || 'tingodb', this.settings?.database || {});
181
181
  await new Promise((resolve, reject) => {
182
182
  this.database.on('connected', resolve);
183
183
  this.database.on('error', reject);
@@ -297,20 +297,26 @@ export class ZumitoFramework {
297
297
  });
298
298
  }
299
299
  /**
300
- * @deprecated use CommandParser service instead
300
+ * Use CommandParser service instead
301
+ *
302
+ * @deprecated
301
303
  */
302
304
  static splitCommandLine(commandLine) {
303
305
  return CommandParser.splitCommandLine(commandLine);
304
306
  }
305
307
  /**
306
- * @deprecated use MemberPermissionChecker service
308
+ * Use MemberPermissionChecker service
309
+ *
310
+ * @deprecated
307
311
  */
308
312
  async memberHasPermission(member, channel, permission) {
309
313
  const memberPermissionChecker = ServiceContainer.getService(MemberPermissionChecker);
310
314
  return await memberPermissionChecker(member, channel, permission);
311
315
  }
312
316
  /**
313
- * @deprecated use GuildDataGetter service
317
+ * Use GuildDataGetter service
318
+ *
319
+ * @deprecated
314
320
  */
315
321
  async getGuildSettings(guildId) {
316
322
  const guildDataGetter = ServiceContainer.getService(GuildDataGetter);
@@ -13,11 +13,17 @@ export interface CommandParameters {
13
13
  interaction?: CommandInteraction;
14
14
  args: Map<string, any>;
15
15
  /**
16
- * @deprecated The client should be obtained from `ServiceContainer.get(Client);`
16
+ * Discord client instance
17
+ * The client should be obtained from `ServiceContainer.get(Client);`
18
+ *
19
+ * @deprecated
17
20
  */
18
21
  client: Client;
19
22
  /**
20
- * @deprecated The frameworkInstance should be obtained from `ServiceContainer.get(ZumitoFramework);`
23
+ * ZumitoFramework instance
24
+ * The frameworkInstance should be obtained from `ServiceContainer.get(ZumitoFramework);`
25
+ *
26
+ * @deprecated
21
27
  */
22
28
  framework: ZumitoFramework;
23
29
  guildSettings?: any;
@@ -48,7 +48,7 @@ export class StatusManager {
48
48
  this.framework.eventEmitter.emit("statusChanged", presenceData);
49
49
  }
50
50
  else {
51
- let status = this.getNextStatus();
51
+ const status = this.getNextStatus();
52
52
  if (status) {
53
53
  this.framework.client.user.setPresence(status);
54
54
  this.framework.eventEmitter.emit("statusChanged", status);
@@ -65,7 +65,7 @@ export class StatusManager {
65
65
  const matchingStatuses = [];
66
66
  this.options.statuses.forEach((status) => matchingStatuses.push(status));
67
67
  this.options.RuledStatuses.forEach((status) => {
68
- let match = status.rules.some((rule) => {
68
+ const match = status.rules.some((rule) => {
69
69
  if (rule.startTime && rule.startTime > now)
70
70
  return false;
71
71
  if (rule.endTime && rule.endTime < now)
@@ -83,7 +83,7 @@ export class StatusManager {
83
83
  * @private
84
84
  */
85
85
  getNextStatus() {
86
- let statuses = this.getMatchingStatuses();
86
+ const statuses = this.getMatchingStatuses();
87
87
  if (statuses.length === 0)
88
88
  return undefined;
89
89
  if (this.options.order === "random") {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zumito-framework",
3
- "version": "1.2.8",
3
+ "version": "1.2.10",
4
4
  "description": "Discord.js bot framework",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -24,7 +24,6 @@
24
24
  "autocorrect": "^1.2.0",
25
25
  "better-logging": "^5.0.0",
26
26
  "boxen": "^7.0.0",
27
- "canario": "^1.0.1",
28
27
  "chalk": "^4.1.2",
29
28
  "chokidar": "^3.5.3",
30
29
  "cookie-parser": "^1.4.6",
@@ -34,10 +33,12 @@
34
33
  "express": "^4.18.1",
35
34
  "leven": "^4.0.0",
36
35
  "mongoose": "^6.6.5",
37
- "tingodb": "^0.6.1"
36
+ "tingodb": "^0.6.1",
37
+ "tseep": "^1.2.2",
38
+ "zumito-db": "^1.0.0"
38
39
  },
39
40
  "devDependencies": {
40
- "@types/node": "^18.7.16",
41
+ "@types/node": "^18.19.44",
41
42
  "@typescript-eslint/eslint-plugin": "^5.48.2",
42
43
  "@typescript-eslint/parser": "^5.48.2",
43
44
  "eslint": "^8.32.0",