fix: Settings delete core event (#477)

* fix: Added core event handler for settingsDelete

* docs: Updated IncludedEvents

* docs: Correct changelog PR number

* fix: Don't check this.client.shard in both core settings event handlers

* misc: Add IS support for both core settings events handlers

* misc: Much better and faster shard check for both settings events

CHANGELOG.md

@@ -14,6 +14,7 @@ NOTE: For the contributors, you add new entries to this document following this
 
 ### Added
 
+- [[#477](https://github.com/dirigeants/klasa/pull/477)] Added core `KlasaClient#settingsDelete` event handler to destroy instances in other shards. (kyranet)
 - [[#475](https://github.com/dirigeants/klasa/pull/475)] Added `KlasaClient#settingsSync` event. (kyranet)
 - [[#471](https://github.com/dirigeants/klasa/pull/471)] Added `Gateway#create` and `Gateway#acquire`. (kyranet)
 - [[#471](https://github.com/dirigeants/klasa/pull/471)] Added `SETTING_GATEWAY_CHOOSE_KEY` and `SETTING_GATEWAY_UNCONFIGURABLE_FOLDER` i18n keys into en-US. (kyranet)

guides/Included Pieces/IncludedEvents.md

@@ -14,9 +14,17 @@ Replies with the reason why the command was inhibited.
 
 [events/commandInhibited.js](https://github.com/dirigeants/klasa/blob/master/src/events/commandInhibited.js)
 
+## settingsDelete
+
+Deletes settings in all shards, if the bot is sharded.
+
+**Source:**
+
+[events/coreSettingsDelete.js](https://github.com/dirigeants/klasa/blob/master/src/events/coreSettingsDelete.js)
+
 ## settingsUpdate
 
-Synchronises the user settings between all shards, if the bot is sharded.
+Synchronises settings between all shards, if the bot is sharded.
 
 **Source:**
 

src/events/coreSettingsDelete.js

@@ -0,0 +1,28 @@
+const { Event } = require('klasa');
+const gateways = ['users', 'clientStorage'];
+
+module.exports = class extends Event {
+
+	constructor(...args) {
+		super(...args, { event: 'settingsDelete' });
+	}
+
+	run(settings) {
+		if (gateways.includes(settings.gateway.name)) {
+			this.client.shard.broadcastEval(`
+				if (String(this.shard.id) === '${this.client.shard.id}') return;
+				const entry = this.gateways.get('${settings.gateway.name}').get('${settings.id}');
+				if (entry && entry.existenceStatus) {
+					this.emit('settingsDelete', settings);
+					entry.init(entry, entry.schema);
+					entry.existenceStatus = false;
+				}
+			`);
+		}
+	}
+
+	init() {
+		if (!this.client.shard) this.disable();
+	}
+
+};

src/events/coreSettingsUpdate.js

@@ -8,15 +8,14 @@ module.exports = class extends Event {
 	}
 
 	run(settings) {
-		if (this.client.shard && gateways.includes(settings.gateway.name)) {
+		if (gateways.includes(settings.gateway.name)) {
 			this.client.shard.broadcastEval(`
-				if (this.shard.id !== ${this.client.shard.id}) {
-					const entry = this.gateways.get('${settings.gateway.name}').get('${settings.id}');
-					if (entry) {
-						entry._patch(${JSON.stringify(settings)});
-						entry.existenceStatus = true;
-						this.emit('settingsSync', settings);
-					}
+				if (String(this.shard.id) === '${this.client.shard.id}') return;
+				const entry = this.gateways.get('${settings.gateway.name}').get('${settings.id}');
+				if (entry) {
+					entry._patch(${JSON.stringify(settings)});
+					entry.existenceStatus = true;
+					this.emit('settingsSync', settings);
 				}
 			`);
 		}

src/lib/settings/Settings.js

@@ -105,7 +105,7 @@ class Settings extends SettingsFolder {
 		if (this.existenceStatus) {
 			await this.gateway.provider.delete(this.gateway.name, this.id);
 			this.gateway.client.emit('settingsDelete', this);
-			this.init();
+			this.init(this, this.schema);
 		}
 		return this;
 	}