Merge pull request #267 from discordjs/main

Create a new pull request by comparing changes across two branches

.commitlintrc.json

@@ -5,7 +5,7 @@
 		"type-enum": [
 			2,
 			"always",
-			["chore", "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "types", "typings"]
+			["chore", "build", "ci", "docs", "feat", "fix", "perf", "refactor", "revert", "style", "test", "types"]
 		],
 		"scope-case": [0]
 	}

.github/COMMIT_CONVENTION.md

@@ -7,7 +7,7 @@
 Messages must be matched by the following regex:
 
 ```js
-/^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\(.+\))?: .{1,72}/;
+/^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\(.+\))?: .{1,72}/;
 ```
 
 #### Examples

.github/workflows/documentation.yml

@@ -75,7 +75,7 @@ jobs:
 
       - name: Apply tag to api-extractor config
         if: ${{ env.REF_TYPE == 'tag' && !inputs.ref }}
-        run: sed -i 's!https://github.com/discordjs/discord.js/tree/main!https://github.com/discordjs/discord.js/tree/${{ steps.extract-tag.outputs.semver }}!' "packages/${{ steps.extract-tag.outputs.package}}/api-extractor.json"
+        run: sed -i 's!https://github.com/discordjs/discord.js/tree/main!https://github.com/discordjs/discord.js/tree/${{ github.ref_name }}!' "packages/${{ steps.extract-tag.outputs.package}}/api-extractor.json"
 
       - name: Build docs
         run: pnpm run docs

.github/workflows/pr-triage.yml

@@ -23,9 +23,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Validate pull request title
+        env:
+          TITLE: ${{ github.event.pull_request.title }}
         run: |
-          TITLE="${{ github.event.pull_request.title }}"
-          REGEX="^(revert: )?(feat|fix|docs|style|refactor|perf|test|workflow|build|ci|chore|types|wip)(\\(.+\\))?: .{1,72}$"
+          REGEX="^(revert: )?(feat|fix|docs|style|refactor|perf|test|build|ci|chore|types)(\\(.+\\))?: .{1,72}$"
 
           echo "Title: \"$TITLE\""
 

apps/website/src/components/DocNode.tsx

@@ -30,7 +30,7 @@ export async function DocNode({ node, version }: { readonly node?: any; readonly
 							rel="external noreferrer noopener"
 							target="_blank"
 						>
-							{`${node.text}${node.members}`}
+							{`${node.text}${node.members ?? ''}`}
 						</a>
 					);
 				}

package.json

@@ -28,7 +28,7 @@
 	"contributors": [
 		"Crawl <[email protected]>",
 		"Amish Shah <[email protected]>",
-		"Vlad Frangu <[email protected]>",
+		"Vlad Frangu <[email protected]>",
 		"SpaceEEC <[email protected]>",
 		"Aura Román <[email protected]>"
 	],

packages/api-extractor-model/src/model/ModelReferenceResolver.ts

@@ -115,6 +115,7 @@ export class ModelReferenceResolver {
 			if (memberSelector === undefined) {
 				if (foundMembers.length > 1) {
 					const foundClass: ApiItem | undefined = foundMembers.find((member) => member.kind === ApiItemKind.Class);
+					const foundEvent: ApiItem | undefined = foundMembers.find((member) => member.kind === ApiItemKind.Event);
 					if (
 						foundClass &&
 						foundMembers.filter((member) => member.kind === ApiItemKind.Interface).length === foundMembers.length - 1
@@ -124,6 +125,11 @@ export class ModelReferenceResolver {
 						foundMembers.every((member) => member.kind === ApiItemKind.Method && (member as ApiMethod).overloadIndex)
 					) {
 						currentItem = foundMembers.find((member) => (member as ApiMethod).overloadIndex === 1)!;
+					} else if (
+						foundEvent &&
+						foundMembers.filter((member) => member.kind === ApiItemKind.Method).length === foundMembers.length - 1
+					) {
+						currentItem = foundEvent;
 					} else {
 						result.errorMessage = `The member reference ${JSON.stringify(identifier)} was ambiguous`;
 						return result;

packages/brokers/package.json

@@ -42,7 +42,7 @@
 		"Crawl <[email protected]>",
 		"Amish Shah <[email protected]>",
 		"SpaceEEC <[email protected]>",
-		"Vlad Frangu <[email protected]>",
+		"Vlad Frangu <[email protected]>",
 		"Aura Roman <[email protected]>",
 		"DD <[email protected]>"
 	],

packages/builders/__tests__/components/button.test.ts

@@ -50,6 +50,11 @@ describe('Button Components', () => {
 				button.toJSON();
 			}).not.toThrowError();
 
+			expect(() => {
+				const button = buttonComponent().setSKUId('123456789012345678').setStyle(ButtonStyle.Premium);
+				button.toJSON();
+			}).not.toThrowError();
+
 			expect(() => buttonComponent().setURL('https://google.com')).not.toThrowError();
 		});
 
@@ -101,6 +106,47 @@ describe('Button Components', () => {
 				button.toJSON();
 			}).toThrowError();
 
+			expect(() => {
+				const button = buttonComponent().setStyle(ButtonStyle.Primary).setSKUId('123456789012345678');
+				button.toJSON();
+			}).toThrowError();
+
+			expect(() => {
+				const button = buttonComponent()
+					.setStyle(ButtonStyle.Secondary)
+					.setLabel('button')
+					.setSKUId('123456789012345678');
+
+				button.toJSON();
+			}).toThrowError();
+
+			expect(() => {
+				const button = buttonComponent()
+					.setStyle(ButtonStyle.Success)
+					.setEmoji({ name: '😇' })
+					.setSKUId('123456789012345678');
+
+				button.toJSON();
+			}).toThrowError();
+
+			expect(() => {
+				const button = buttonComponent()
+					.setStyle(ButtonStyle.Danger)
+					.setCustomId('test')
+					.setSKUId('123456789012345678');
+
+				button.toJSON();
+			}).toThrowError();
+
+			expect(() => {
+				const button = buttonComponent()
+					.setStyle(ButtonStyle.Link)
+					.setURL('https://google.com')
+					.setSKUId('123456789012345678');
+
+				button.toJSON();
+			}).toThrowError();
+
 			// @ts-expect-error: Invalid style
 			expect(() => buttonComponent().setStyle(24)).toThrowError();
 			expect(() => buttonComponent().setLabel(longStr)).toThrowError();

packages/builders/__tests__/interactions/ContextMenuCommands.test.ts

@@ -1,4 +1,4 @@
-import { PermissionFlagsBits } from 'discord-api-types/v10';
+import { ApplicationIntegrationType, InteractionContextType, PermissionFlagsBits } from 'discord-api-types/v10';
 import { describe, test, expect } from 'vitest';
 import { ContextMenuCommandAssertions, ContextMenuCommandBuilder } from '../../src/index.js';
 
@@ -144,5 +144,51 @@ describe('Context Menu Commands', () => {
 				expect(() => getBuilder().setDefaultMemberPermissions(1.1)).toThrowError();
 			});
 		});
+
+		describe('contexts', () => {
+			test('GIVEN a builder with valid contexts THEN does not throw an error', () => {
+				expect(() =>
+					getBuilder().setContexts([InteractionContextType.Guild, InteractionContextType.BotDM]),
+				).not.toThrowError();
+
+				expect(() =>
+					getBuilder().setContexts(InteractionContextType.Guild, InteractionContextType.BotDM),
+				).not.toThrowError();
+			});
+
+			test('GIVEN a builder with invalid contexts THEN does throw an error', () => {
+				// @ts-expect-error: Invalid contexts
+				expect(() => getBuilder().setContexts(999)).toThrowError();
+
+				// @ts-expect-error: Invalid contexts
+				expect(() => getBuilder().setContexts([999, 998])).toThrowError();
+			});
+		});
+
+		describe('integration types', () => {
+			test('GIVEN a builder with valid integraton types THEN does not throw an error', () => {
+				expect(() =>
+					getBuilder().setIntegrationTypes([
+						ApplicationIntegrationType.GuildInstall,
+						ApplicationIntegrationType.UserInstall,
+					]),
+				).not.toThrowError();
+
+				expect(() =>
+					getBuilder().setIntegrationTypes(
+						ApplicationIntegrationType.GuildInstall,
+						ApplicationIntegrationType.UserInstall,
+					),
+				).not.toThrowError();
+			});
+
+			test('GIVEN a builder with invalid integration types THEN does throw an error', () => {
+				// @ts-expect-error: Invalid integration types
+				expect(() => getBuilder().setIntegrationTypes(999)).toThrowError();
+
+				// @ts-expect-error: Invalid integration types
+				expect(() => getBuilder().setIntegrationTypes([999, 998])).toThrowError();
+			});
+		});
 	});
 });

packages/builders/__tests__/interactions/SlashCommands/SlashCommands.test.ts

@@ -1,4 +1,11 @@
-import { ChannelType, PermissionFlagsBits, type APIApplicationCommandOptionChoice } from 'discord-api-types/v10';
+import {
+	ApplicationCommandType,
+	ApplicationIntegrationType,
+	ChannelType,
+	InteractionContextType,
+	PermissionFlagsBits,
+	type APIApplicationCommandOptionChoice,
+} from 'discord-api-types/v10';
 import { describe, test, expect } from 'vitest';
 import {
 	SlashCommandAssertions,
@@ -127,6 +134,10 @@ describe('Slash Commands', () => {
 		});
 
 		describe('Builder with simple options', () => {
+			test('GIVEN valid builder THEN returns type included', () => {
+				expect(getNamedBuilder().toJSON()).includes({ type: ApplicationCommandType.ChatInput });
+			});
+
 			test('GIVEN valid builder with options THEN does not throw error', () => {
 				expect(() =>
 					getBuilder()
@@ -532,5 +543,51 @@ describe('Slash Commands', () => {
 				expect(() => getBuilder().addChannelOption(getChannelOption()).setDMPermission(false)).not.toThrowError();
 			});
 		});
+
+		describe('contexts', () => {
+			test('GIVEN a builder with valid contexts THEN does not throw an error', () => {
+				expect(() =>
+					getBuilder().setContexts([InteractionContextType.Guild, InteractionContextType.BotDM]),
+				).not.toThrowError();
+
+				expect(() =>
+					getBuilder().setContexts(InteractionContextType.Guild, InteractionContextType.BotDM),
+				).not.toThrowError();
+			});
+
+			test('GIVEN a builder with invalid contexts THEN does throw an error', () => {
+				// @ts-expect-error: Invalid contexts
+				expect(() => getBuilder().setContexts(999)).toThrowError();
+
+				// @ts-expect-error: Invalid contexts
+				expect(() => getBuilder().setContexts([999, 998])).toThrowError();
+			});
+		});
+
+		describe('integration types', () => {
+			test('GIVEN a builder with valid integraton types THEN does not throw an error', () => {
+				expect(() =>
+					getBuilder().setIntegrationTypes([
+						ApplicationIntegrationType.GuildInstall,
+						ApplicationIntegrationType.UserInstall,
+					]),
+				).not.toThrowError();
+
+				expect(() =>
+					getBuilder().setIntegrationTypes(
+						ApplicationIntegrationType.GuildInstall,
+						ApplicationIntegrationType.UserInstall,
+					),
+				).not.toThrowError();
+			});
+
+			test('GIVEN a builder with invalid integration types THEN does throw an error', () => {
+				// @ts-expect-error: Invalid integration types
+				expect(() => getBuilder().setIntegrationTypes(999)).toThrowError();
+
+				// @ts-expect-error: Invalid integration types
+				expect(() => getBuilder().setIntegrationTypes([999, 998])).toThrowError();
+			});
+		});
 	});
 });

packages/builders/package.json

@@ -38,7 +38,7 @@
 		"dist"
 	],
 	"contributors": [
-		"Vlad Frangu <[email protected]>",
+		"Vlad Frangu <[email protected]>",
 		"Crawl <[email protected]>",
 		"Amish Shah <[email protected]>",
 		"SpaceEEC <[email protected]>",
@@ -68,7 +68,7 @@
 		"@discordjs/formatters": "workspace:^",
 		"@discordjs/util": "workspace:^",
 		"@sapphire/shapeshift": "^3.9.7",
-		"discord-api-types": "0.37.87",
+		"discord-api-types": "0.37.93",
 		"fast-deep-equal": "^3.1.3",
 		"ts-mixer": "^6.0.4",
 		"tslib": "^2.6.2"

packages/builders/src/components/Assertions.ts

@@ -81,21 +81,36 @@ export function validateRequiredButtonParameters(
 	label?: string,
 	emoji?: APIMessageComponentEmoji,
 	customId?: string,
+	skuId?: string,
 	url?: string,
 ) {
-	if (url && customId) {
-		throw new RangeError('URL and custom id are mutually exclusive');
-	}
+	if (style === ButtonStyle.Premium) {
+		if (!skuId) {
+			throw new RangeError('Premium buttons must have an SKU id.');
+		}
 
-	if (!label && !emoji) {
-		throw new RangeError('Buttons must have a label and/or an emoji');
-	}
+		if (customId || label || url || emoji) {
+			throw new RangeError('Premium buttons cannot have a custom id, label, URL, or emoji.');
+		}
+	} else {
+		if (skuId) {
+			throw new RangeError('Non-premium buttons must not have an SKU id.');
+		}
+
+		if (url && customId) {
+			throw new RangeError('URL and custom id are mutually exclusive.');
+		}
+
+		if (!label && !emoji) {
+			throw new RangeError('Non-premium buttons must have a label and/or an emoji.');
+		}
 
-	if (style === ButtonStyle.Link) {
-		if (!url) {
-			throw new RangeError('Link buttons must have a url');
+		if (style === ButtonStyle.Link) {
+			if (!url) {
+				throw new RangeError('Link buttons must have a URL.');
+			}
+		} else if (url) {
+			throw new RangeError('Non-premium and non-link buttons cannot have a URL.');
 		}
-	} else if (url) {
-		throw new RangeError('Non-link buttons cannot have a url');
 	}
 }