Merge branch 'main' into main

kodiakhq[bot] · web-flow · commit 4c7a95d126df · 2023-11-06T09:14:43.000Z
diff --git a/packages/collection/__tests__/collection.test.ts b/packages/collection/__tests__/collection.test.ts
@@ -908,3 +908,73 @@ describe('random thisArg tests', () => {
 		}, array);
 	});
 });
+
+describe('findLast() tests', () => {
+	const coll = createTestCollection();
+	test('it returns last matched element', () => {
+		expect(coll.findLast((value) => value % 2 === 1)).toStrictEqual(3);
+	});
+
+	test('throws if fn is not a function', () => {
+		// @ts-expect-error: Invalid function
+		expectInvalidFunctionError(() => createCollection().findLast());
+		// @ts-expect-error: Invalid function
+		expectInvalidFunctionError(() => createCollection().findLast(123), 123);
+	});
+
+	test('binds the thisArg', () => {
+		coll.findLast(function findLast() {
+			expect(this).toBeNull();
+			return true;
+		}, null);
+	});
+});
+
+describe('findLastKey() tests', () => {
+	const coll = createTestCollection();
+	test('it returns last matched element', () => {
+		expect(coll.findLastKey((value) => value % 2 === 1)).toStrictEqual('c');
+	});
+
+	test('throws if fn is not a function', () => {
+		// @ts-expect-error: Invalid function
+		expectInvalidFunctionError(() => createCollection().findLastKey());
+		// @ts-expect-error: Invalid function
+		expectInvalidFunctionError(() => createCollection().findLastKey(123), 123);
+	});
+
+	test('binds the thisArg', () => {
+		coll.findLastKey(function findLastKey() {
+			expect(this).toBeNull();
+			return true;
+		}, null);
+	});
+});
+
+describe('reduceRight() tests', () => {
+	const coll = createTestCollection();
+
+	test('throws if fn is not a function', () => {
+		// @ts-expect-error: Invalid function
+		expectInvalidFunctionError(() => coll.reduceRight());
+		// @ts-expect-error: Invalid function
+		expectInvalidFunctionError(() => coll.reduceRight(123), 123);
+	});
+
+	test('reduce collection into a single value with initial value', () => {
+		const sum = coll.reduceRight((a, x) => a + x, 0);
+		expect(sum).toStrictEqual(6);
+	});
+
+	test('reduce collection into a single value without initial value', () => {
+		const sum = coll.reduceRight<number>((a, x) => a + x);
+		expect(sum).toStrictEqual(6);
+	});
+
+	test('reduce empty collection without initial value', () => {
+		const coll = createCollection();
+		expect(() => coll.reduceRight((a: number, x) => a + x)).toThrowError(
+			new TypeError('Reduce of empty collection with no initial value'),
+		);
+	});
+});
diff --git a/packages/collection/src/collection.ts b/packages/collection/src/collection.ts
@@ -274,6 +274,64 @@ export class Collection<K, V> extends Map<K, V> {
 		return undefined;
 	}
 
+	/**
+	 * Searches for a last item where the given function returns a truthy value. This behaves like
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findLast | Array.findLast()}.
+	 *
+	 * @param fn - The function to test with (should return a boolean)
+	 * @param thisArg - Value to use as `this` when executing the function
+	 */
+	public findLast<V2 extends V>(fn: (value: V, key: K, collection: this) => value is V2): V2 | undefined;
+	public findLast(fn: (value: V, key: K, collection: this) => unknown): V | undefined;
+	public findLast<This, V2 extends V>(
+		fn: (this: This, value: V, key: K, collection: this) => value is V2,
+		thisArg: This,
+	): V2 | undefined;
+	public findLast<This>(fn: (this: This, value: V, key: K, collection: this) => unknown, thisArg: This): V | undefined;
+	public findLast(fn: (value: V, key: K, collection: this) => unknown, thisArg?: unknown): V | undefined {
+		if (typeof fn !== 'function') throw new TypeError(`${fn} is not a function`);
+		if (thisArg !== undefined) fn = fn.bind(thisArg);
+		const entries = [...this.entries()];
+		for (let index = entries.length - 1; index >= 0; index--) {
+			const val = entries[index]![1];
+			const key = entries[index]![0];
+			if (fn(val, key, this)) return val;
+		}
+
+		return undefined;
+	}
+
+	/**
+	 * Searches for the key of a last item where the given function returns a truthy value. This behaves like
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/findLastIndex | Array.findLastIndex()},
+	 * but returns the key rather than the positional index.
+	 *
+	 * @param fn - The function to test with (should return a boolean)
+	 * @param thisArg - Value to use as `this` when executing the function
+	 */
+	public findLastKey<K2 extends K>(fn: (value: V, key: K, collection: this) => key is K2): K2 | undefined;
+	public findLastKey(fn: (value: V, key: K, collection: this) => unknown): K | undefined;
+	public findLastKey<This, K2 extends K>(
+		fn: (this: This, value: V, key: K, collection: this) => key is K2,
+		thisArg: This,
+	): K2 | undefined;
+	public findLastKey<This>(
+		fn: (this: This, value: V, key: K, collection: this) => unknown,
+		thisArg: This,
+	): K | undefined;
+	public findLastKey(fn: (value: V, key: K, collection: this) => unknown, thisArg?: unknown): K | undefined {
+		if (typeof fn !== 'function') throw new TypeError(`${fn} is not a function`);
+		if (thisArg !== undefined) fn = fn.bind(thisArg);
+		const entries = [...this.entries()];
+		for (let index = entries.length - 1; index >= 0; index--) {
+			const key = entries[index]![0];
+			const val = entries[index]![1];
+			if (fn(val, key, this)) return key;
+		}
+
+		return undefined;
+	}
+
 	/**
 	 * Removes items that satisfy the provided filter function.
 	 *
@@ -533,6 +591,37 @@ export class Collection<K, V> extends Map<K, V> {
 		return accumulator;
 	}
 
+	/**
+	 * Applies a function to produce a single value. Identical in behavior to
+	 * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/reduceRight | Array.reduceRight()}.
+	 *
+	 * @param fn - Function used to reduce, taking four arguments; `accumulator`, `value`, `key`, and `collection`
+	 * @param initialValue - Starting value for the accumulator
+	 */
+	public reduceRight<T>(fn: (accumulator: T, value: V, key: K, collection: this) => T, initialValue?: T): T {
+		if (typeof fn !== 'function') throw new TypeError(`${fn} is not a function`);
+		const entries = [...this.entries()];
+		let accumulator!: T;
+
+		let index: number;
+		if (initialValue === undefined) {
+			if (entries.length === 0) throw new TypeError('Reduce of empty collection with no initial value');
+			accumulator = entries[entries.length - 1]![1] as unknown as T;
+			index = entries.length - 1;
+		} else {
+			accumulator = initialValue;
+			index = entries.length;
+		}
+
+		while (--index >= 0) {
+			const key = entries[index]![0];
+			const val = entries[index]![1];
+			accumulator = fn(accumulator, val, key, this);
+		}
+
+		return accumulator;
+	}
+
 	/**
 	 * Identical to
 	 * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map/forEach | Map.forEach()},
diff --git a/packages/core/src/api/guild.ts b/packages/core/src/api/guild.ts
@@ -92,6 +92,8 @@ import {
 	type RESTPostAPIGuildsMFAResult,
 	type RESTPostAPIGuildsResult,
 	type RESTPutAPIGuildBanJSONBody,
+	type RESTPutAPIGuildMemberJSONBody,
+	type RESTPutAPIGuildMemberResult,
 	type RESTPutAPIGuildOnboardingJSONBody,
 	type RESTPutAPIGuildOnboardingResult,
 	type RESTPutAPIGuildTemplateSyncResult,
@@ -167,6 +169,27 @@ export class GuildsAPI {
 		await this.rest.delete(Routes.guild(guildId), { reason, signal });
 	}
 
+	/**
+	 * Adds user to the guild
+	 *
+	 * @see {@link https://discord.com/developers/docs/resources/guild#add-guild-member}
+	 * @param guildId - The id of the guild to add the user to
+	 * @param userId - The id of the user to add
+	 * @param body - The data for adding users to the guild
+	 * @param options - The options for adding users to the guild
+	 */
+	public async addMember(
+		guildId: Snowflake,
+		userId: Snowflake,
+		body: RESTPutAPIGuildMemberJSONBody,
+		{ signal }: Pick<RequestData, 'signal'> = {},
+	) {
+		return this.rest.put(Routes.guildMember(guildId, userId), {
+			body,
+			signal,
+		}) as Promise<RESTPutAPIGuildMemberResult>;
+	}
+
 	/**
 	 * Fetches all the members of a guild
 	 *
diff --git a/packages/discord.js/src/client/BaseClient.js b/packages/discord.js/src/client/BaseClient.js
@@ -2,6 +2,7 @@
 
 const EventEmitter = require('node:events');
 const { REST } = require('@discordjs/rest');
+const { Routes } = require('discord-api-types/v10');
 const { DiscordjsTypeError, ErrorCodes } = require('../errors');
 const Options = require('../util/Options');
 const { mergeDefault, flatten } = require('../util/Util');
@@ -48,6 +49,23 @@ class BaseClient extends EventEmitter {
     this.rest.clearHandlerSweeper();
   }
 
+  /**
+   * Options used for deleting a webhook.
+   * @typedef {Object} WebhookDeleteOptions
+   * @property {string} [token] Token of the webhook
+   * @property {string} [reason] The reason for deleting the webhook
+   */
+
+  /**
+   * Deletes a webhook.
+   * @param {Snowflake} id The webhook's id
+   * @param {WebhookDeleteOptions} [options] Options for deleting the webhook
+   * @returns {Promise<void>}
+   */
+  async deleteWebhook(id, { token, reason } = {}) {
+    await this.rest.delete(Routes.webhook(id, token), { auth: !token, reason });
+  }
+
   /**
    * Increments max listeners by one, if they are not zero.
    * @private
diff --git a/packages/discord.js/src/client/Client.js b/packages/discord.js/src/client/Client.js
@@ -255,23 +255,6 @@ class Client extends BaseClient {
     this.rest.setToken(null);
   }
 
-  /**
-   * Options used for deleting a webhook.
-   * @typedef {Object} WebhookDeleteOptions
-   * @property {string} [token] Token of the webhook
-   * @property {string} [reason] The reason for deleting the webhook
-   */
-
-  /**
-   * Deletes a webhook.
-   * @param {Snowflake} id The webhook's id
-   * @param {WebhookDeleteOptions} [options] Options for deleting the webhook
-   * @returns {Promise<void>}
-   */
-  async deleteWebhook(id, { token, reason } = {}) {
-    await this.rest.delete(Routes.webhook(id, token), { auth: !token, reason });
-  }
-
   /**
    * Options used when fetching an invite from Discord.
    * @typedef {Object} ClientFetchInviteOptions
diff --git a/packages/discord.js/src/managers/GuildManager.js b/packages/discord.js/src/managers/GuildManager.js
@@ -6,6 +6,7 @@ const { Collection } = require('@discordjs/collection');
 const { makeURLSearchParams } = require('@discordjs/rest');
 const { Routes, RouteBases } = require('discord-api-types/v10');
 const CachedManager = require('./CachedManager');
+const ShardClientUtil = require('../sharding/ShardClientUtil');
 const { Guild } = require('../structures/Guild');
 const GuildChannel = require('../structures/GuildChannel');
 const GuildEmoji = require('../structures/GuildEmoji');
@@ -272,6 +273,7 @@ class GuildManager extends CachedManager {
       const data = await this.client.rest.get(Routes.guild(id), {
         query: makeURLSearchParams({ with_counts: options.withCounts ?? true }),
       });
+      data.shardId = ShardClientUtil.shardIdForGuildId(id, this.client.options.shardCount);
       return this._add(data, options.cache);
     }
 
diff --git a/packages/discord.js/src/structures/BaseGuildEmoji.js b/packages/discord.js/src/structures/BaseGuildEmoji.js
@@ -53,4 +53,23 @@ class BaseGuildEmoji extends Emoji {
   }
 }
 
+/**
+ * Returns a URL for the emoji.
+ * @method imageURL
+ * @memberof BaseGuildEmoji
+ * @instance
+ * @param {BaseImageURLOptions} [options] Options for the image URL
+ * @returns {string}
+ */
+
+/**
+ * Returns a URL for the emoji.
+ * @name url
+ * @memberof BaseGuildEmoji
+ * @instance
+ * @type {string}
+ * @readonly
+ * @deprecated Use {@link BaseGuildEmoji#imageURL} instead.
+ */
+
 module.exports = BaseGuildEmoji;
diff --git a/packages/discord.js/src/structures/Emoji.js b/packages/discord.js/src/structures/Emoji.js
@@ -1,8 +1,11 @@
 'use strict';
 
+const process = require('node:process');
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const Base = require('./Base');
 
+let deprecationEmittedForURL = false;
+
 /**
  * Represents an emoji, see {@link GuildEmoji} and {@link ReactionEmoji}.
  * @extends {Base}
@@ -40,12 +43,27 @@ class Emoji extends Base {
   }
 
   /**
-   * The URL to the emoji file if it's a custom emoji
+   * Returns a URL for the emoji or `null` if this is not a custom emoji.
+   * @param {BaseImageURLOptions} [options] Options for the image URL
+   * @returns {?string}
+   */
+  imageURL(options) {
+    return this.id && this.client.rest.cdn.emoji(this.id, options);
+  }
+
+  /**
+   * Returns a URL for the emoji or `null` if this is not a custom emoji.
    * @type {?string}
    * @readonly
+   * @deprecated Use {@link Emoji#imageURL} instead.
    */
   get url() {
-    return this.id && this.client.rest.cdn.emoji(this.id, this.animated ? 'gif' : 'png');
+    if (!deprecationEmittedForURL) {
+      process.emitWarning('The Emoji#url getter is deprecated. Use Emoji#imageURL() instead.', 'DeprecationWarning');
+      deprecationEmittedForURL = true;
+    }
+
+    return this.imageURL({ extension: this.animated ? 'gif' : 'png' });
   }
 
   /**
diff --git a/packages/discord.js/src/structures/Message.js b/packages/discord.js/src/structures/Message.js
@@ -148,7 +148,7 @@ class Message extends Base {
 
     if ('components' in data) {
       /**
-       * An array of of action rows in the message.
+       * An array of action rows in the message.
        * <info>This property requires the {@link GatewayIntentBits.MessageContent} privileged intent
        * in a guild for messages that do not mention the client.</info>
        * @type {ActionRow[]}
diff --git a/packages/discord.js/src/util/Util.js b/packages/discord.js/src/util/Util.js
diff --git a/packages/discord.js/typings/index.d.ts b/packages/discord.js/typings/index.d.ts
diff --git a/packages/formatters/src/formatters.ts b/packages/formatters/src/formatters.ts
