Merge branch 'main' into types/narrow-button-type

.github/workflows/publish-dev.yml

@@ -42,6 +42,8 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Install node.js v18
         uses: actions/setup-node@v3

apps/guide/package.json

@@ -49,11 +49,11 @@
 		"@react-icons/all-files": "^4.1.0",
 		"@vercel/analytics": "^1.0.1",
 		"@vercel/edge-config": "^0.2.1",
-		"@vercel/og": "^0.5.8",
+		"@vercel/og": "^0.5.9",
 		"ariakit": "^2.0.0-next.44",
 		"cmdk": "^0.2.0",
 		"contentlayer": "0.3.1",
-		"next": "^13.4.11-canary.0",
+		"next": "^13.4.12",
 		"next-contentlayer": "0.3.1",
 		"next-themes": "^0.2.1",
 		"react": "^18.2.0",
@@ -62,36 +62,36 @@
 		"rehype-autolink-headings": "^6.1.1",
 		"rehype-slug": "^5.1.0",
 		"remark-gfm": "^3.0.1",
-		"sharp": "^0.32.3"
+		"sharp": "^0.32.4"
 	},
 	"devDependencies": {
-		"@next/bundle-analyzer": "^13.4.10",
+		"@next/bundle-analyzer": "^13.4.12",
 		"@testing-library/react": "^14.0.0",
 		"@testing-library/user-event": "^14.4.3",
 		"@types/html-escaper": "^3.0.0",
-		"@types/node": "18.16.19",
-		"@types/react": "^18.2.15",
+		"@types/node": "18.17.1",
+		"@types/react": "^18.2.17",
 		"@types/react-dom": "^18.2.7",
-		"@unocss/cli": "^0.53.5",
-		"@unocss/eslint-config": "^0.53.5",
-		"@unocss/reset": "^0.53.5",
+		"@unocss/cli": "^0.54.0",
+		"@unocss/eslint-config": "^0.54.0",
+		"@unocss/reset": "^0.54.0",
 		"@vitejs/plugin-react": "^4.0.3",
 		"@vitest/coverage-c8": "^0.33.0",
 		"concurrently": "^8.2.0",
 		"cross-env": "^7.0.3",
-		"eslint": "^8.45.0",
+		"eslint": "^8.46.0",
 		"eslint-config-neon": "^0.1.47",
 		"eslint-formatter-pretty": "^5.0.0",
-		"happy-dom": "^10.5.1",
+		"happy-dom": "^10.5.2",
 		"hast-util-to-string": "^2.0.0",
 		"hastscript": "^7.2.0",
 		"html-escaper": "^3.0.3",
 		"lighthouse": "^10.4.0",
 		"prettier": "^2.8.8",
-		"turbo": "^1.10.8",
+		"turbo": "^1.10.12",
 		"typescript": "^5.1.6",
-		"unocss": "^0.53.5",
-		"vercel": "^31.0.4",
+		"unocss": "^0.54.0",
+		"vercel": "^31.2.0",
 		"vitest": "^0.33.0"
 	},
 	"engines": {

apps/guide/src/app/_global-error.tsx

@@ -3,7 +3,7 @@
 import { Providers } from './providers';
 import { inter } from '~/util/fonts';
 
-export default function GlobalError({ error }: { error: Error }) {
+export default function GlobalError({ error }: { readonly error: Error }) {
 	console.error(error);
 
 	return (

apps/guide/src/app/error.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-export default function Error({ error }: { error: Error }) {
+export default function Error({ error }: { readonly error: Error }) {
 	console.error(error);
 
 	return (

apps/guide/src/app/guide/[...slug]/page.tsx

@@ -6,7 +6,7 @@ export async function generateStaticParams() {
 	return allContents.map((content) => ({ slug: [content.slug] }));
 }
 
-export default function Page({ params }: { params: { slug: string[] } }) {
+export default function Page({ params }: { readonly params: { slug: string[] } }) {
 	const content = allContents.find((content) => content.slug === params.slug?.join('/'));
 
 	if (!content) {

apps/guide/src/components/DiscordAPITypesLink.tsx

@@ -12,26 +12,26 @@ interface DiscordAPITypesLinkOptions {
 	 *
 	 * @example `'RESTJSONErrorCodes'`
 	 */
-	parent?: string;
+	readonly parent?: string;
 	/**
 	 * The scope of where this link lives.
 	 *
 	 * @remarks API does not have a scope.
 	 */
-	scope?: 'gateway' | 'globals' | 'payloads' | 'rest' | 'rpc' | 'utils' | 'voice';
+	readonly scope?: 'gateway' | 'globals' | 'payloads' | 'rest' | 'rpc' | 'utils' | 'voice';
 	/**
 	 * The symbol belonging to the parent.
 	 *
 	 * @example '`MaximumNumberOfGuildsReached'`
 	 */
-	symbol?: string;
+	readonly symbol?: string;
 	/**
 	 * The type of the {@link DiscordAPITypesLinkOptions.parent}.
 	 *
 	 * @example `'enum'`
 	 * @example `'interface'`
 	 */
-	type?: string;
+	readonly type?: string;
 }
 
 export function DiscordAPITypesLink({

apps/guide/src/components/DocsLink.tsx

@@ -8,40 +8,40 @@ interface DocsLinkOptions {
 	 *
 	 * @remarks Functions automatically infer this.
 	 */
-	brackets?: boolean;
+	readonly brackets?: boolean;
 	/**
 	 * The package.
 	 *
 	 * @defaultValue `'discord.js'`
 	 */
-	package?: (typeof PACKAGES)[number];
+	readonly package?: (typeof PACKAGES)[number];
 	/**
 	 * The initial documentation class, function, interface etc.
 	 *
 	 * @example `'Client'`
 	 */
-	parent?: string;
+	readonly parent?: string;
 	/**
 	 * Whether to reference a static property.
 	 *
 	 * @remarks
 	 * This should only be used for the https://discord.js.org domain
 	 * as static properties are not identified in the URL.
 	 */
-	static?: boolean;
+	readonly static?: boolean;
 	/**
 	 * The symbol belonging to the parent.
 	 *
 	 * @example '`login'`
 	 */
-	symbol?: string;
+	readonly symbol?: string;
 	/**
 	 * The type of the {@link DocsLinkOptions.parent}.
 	 *
 	 * @example `'class'`
 	 * @example `'Function'`
 	 */
-	type?: string;
+	readonly type?: string;
 }
 
 export function DocsLink({

apps/guide/src/components/Mdx.tsx

@@ -10,7 +10,7 @@ import { H4 } from './H4';
 import { DocsLink } from '~/components/DocsLink';
 import { ResultingCode } from '~/components/ResultingCode';
 
-export function Mdx({ code }: { code: string }) {
+export function Mdx({ code }: { readonly code: string }) {
 	const Component = useMDXComponent(code);
 
 	return (

apps/guide/src/components/Outline.tsx

@@ -5,7 +5,7 @@ const LINK_HEIGHT = 30;
 const INDICATOR_SIZE = 10;
 const INDICATOR_OFFSET = (LINK_HEIGHT - INDICATOR_SIZE) / 2;
 
-export function Outline({ headings }: { headings: any[] }) {
+export function Outline({ headings }: { readonly headings: any[] }) {
 	// eslint-disable-next-line react/hook-use-state
 	const [active /* setActive */] = useState(0);
 

apps/guide/src/components/PageButton.tsx

@@ -1,4 +1,12 @@
-export function PageButton({ url, title, direction }: { direction: 'next' | 'prev'; title: string; url: string }) {
+export function PageButton({
+	url,
+	title,
+	direction,
+}: {
+	readonly direction: 'next' | 'prev';
+	readonly title: string;
+	readonly url: string;
+}) {
 	return (
 		<a
 			className="flex flex-row flex-col transform-gpu cursor-pointer select-none appearance-none place-items-center gap-2 rounded bg-light-600 px-4 py-3 leading-none no-underline outline-none active:translate-y-px active:bg-light-800 dark:bg-dark-600 hover:bg-light-700 focus:ring focus:ring-width-2 focus:ring-blurple dark:active:bg-dark-400 dark:hover:bg-dark-500"

apps/website/package.json

@@ -55,13 +55,13 @@
 		"@react-icons/all-files": "^4.1.0",
 		"@vercel/analytics": "^1.0.1",
 		"@vercel/edge-config": "^0.2.1",
-		"@vercel/og": "^0.5.8",
+		"@vercel/og": "^0.5.9",
 		"ariakit": "^2.0.0-next.44",
-		"bright": "^0.8.3",
+		"bright": "^0.8.4",
 		"class-variance-authority": "^0.7.0",
 		"cmdk": "^0.2.0",
 		"meilisearch": "^0.33.0",
-		"next": "^13.4.11-canary.0",
+		"next": "^13.4.12",
 		"next-mdx-remote": "^4.4.1",
 		"next-themes": "^0.2.1",
 		"react": "^18.2.0",
@@ -71,33 +71,33 @@
 		"rehype-raw": "^6.1.1",
 		"rehype-slug": "^5.1.0",
 		"remark-gfm": "^3.0.1",
-		"sharp": "^0.32.3",
+		"sharp": "^0.32.4",
 		"swr": "^2.2.0"
 	},
 	"devDependencies": {
-		"@next/bundle-analyzer": "^13.4.10",
+		"@next/bundle-analyzer": "^13.4.12",
 		"@testing-library/react": "^14.0.0",
 		"@testing-library/user-event": "^14.4.3",
-		"@types/node": "18.16.19",
-		"@types/react": "^18.2.15",
+		"@types/node": "18.17.1",
+		"@types/react": "^18.2.17",
 		"@types/react-dom": "^18.2.7",
-		"@unocss/cli": "^0.53.5",
-		"@unocss/eslint-config": "^0.53.5",
-		"@unocss/reset": "^0.53.5",
+		"@unocss/cli": "^0.54.0",
+		"@unocss/eslint-config": "^0.54.0",
+		"@unocss/reset": "^0.54.0",
 		"@vitejs/plugin-react": "^4.0.3",
 		"@vitest/coverage-c8": "^0.33.0",
 		"concurrently": "^8.2.0",
 		"cpy-cli": "^5.0.0",
 		"cross-env": "^7.0.3",
-		"eslint": "^8.45.0",
+		"eslint": "^8.46.0",
 		"eslint-config-neon": "^0.1.47",
 		"eslint-formatter-pretty": "^5.0.0",
-		"happy-dom": "^10.5.1",
+		"happy-dom": "^10.5.2",
 		"lighthouse": "^10.4.0",
 		"prettier": "^2.8.8",
-		"turbo": "^1.10.8",
+		"turbo": "^1.10.12",
 		"typescript": "^5.1.6",
-		"vercel": "^31.0.4",
+		"vercel": "^31.2.0",
 		"vitest": "^0.33.0"
 	},
 	"engines": {

apps/website/src/app/_global-error.tsx

@@ -73,7 +73,7 @@ export const metadata: Metadata = {
 	},
 };
 
-export default function GlobalError({ error }: { error: Error }) {
+export default function GlobalError({ error }: { readonly error: Error }) {
 	console.error(error);
 
 	return (

apps/website/src/app/docs/packages/[package]/[version]/[item]/page.tsx

@@ -116,7 +116,7 @@ export async function generateStaticParams({ params: { package: packageName, ver
 	}));
 }
 
-function Member({ member }: { member?: ApiItem }) {
+function Member({ member }: { readonly member?: ApiItem }) {
 	switch (member?.kind) {
 		case 'Class':
 			return <Class clazz={member as ApiClass} />;

apps/website/src/app/docs/packages/[package]/[version]/error.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-export default function Error({ error }: { error: Error }) {
+export default function Error({ error }: { readonly error: Error }) {
 	console.error(error);
 
 	return (

apps/website/src/app/error.tsx

@@ -1,6 +1,6 @@
 'use client';
 
-export default function Error({ error }: { error: Error }) {
+export default function Error({ error }: { readonly error: Error }) {
 	console.error(error);
 
 	return (

apps/website/src/app/page.tsx

@@ -20,9 +20,12 @@ export default function Page() {
 							Discord bots.
 						</h1>
 						<p className="my-6 leading-normal text-neutral-700 dark:text-neutral-300">{DESCRIPTION}</p>
-						<div className="flex gap-4 md:flex-row">
-							<Link className={buttonVariants()} href="/docs">
+						<div className="flex flex-wrap place-content-center gap-4 md:flex-row">
+							<a className={buttonVariants()} href="https://old.discordjs.dev/#/docs" rel="noopener noreferrer">
 								Docs
+							</a>
+							<Link className={buttonVariants()} href="/docs">
+								Module docs
 							</Link>
 							<a
 								className={buttonVariants({ variant: 'secondary' })}

apps/website/src/components/Anchor.tsx

@@ -1,6 +1,6 @@
 import { FiLink } from '@react-icons/all-files/fi/FiLink';
 
-export function Anchor({ href }: { href: string }) {
+export function Anchor({ href }: { readonly href: string }) {
 	return (
 		<a className="mr-1 inline-block rounded outline-none focus:ring focus:ring-width-2 focus:ring-blurple" href={href}>
 			<FiLink size={20} />

apps/website/src/components/Badges.tsx

@@ -8,7 +8,10 @@ export enum BadgeColor {
 	Warning = 'bg-yellow-500',
 }
 
-export function Badge({ children, color = BadgeColor.Primary }: PropsWithChildren<{ color?: BadgeColor | undefined }>) {
+export function Badge({
+	children,
+	color = BadgeColor.Primary,
+}: PropsWithChildren<{ readonly color?: BadgeColor | undefined }>) {
 	return (
 		<span
 			className={`h-5 flex flex-row place-content-center place-items-center rounded-full px-3 text-center text-xs font-semibold uppercase text-white ${color}`}
@@ -18,7 +21,7 @@ export function Badge({ children, color = BadgeColor.Primary }: PropsWithChildre
 	);
 }
 
-export function Badges({ item }: { item: ApiDocumentedItem }) {
+export function Badges({ item }: { readonly item: ApiDocumentedItem }) {
 	const isStatic = ApiStaticMixin.isBaseClassOf(item) && item.isStatic;
 	const isProtected = ApiProtectedMixin.isBaseClassOf(item) && item.isProtected;
 	const isReadonly = ApiReadonlyMixin.isBaseClassOf(item) && item.isReadonly;

apps/website/src/components/CodeHeading.tsx

@@ -5,15 +5,15 @@ export interface CodeListingProps {
 	/**
 	 * The value of this heading.
 	 */
-	children: ReactNode;
+	readonly children: ReactNode;
 	/**
 	 * Additional class names to apply to the root element.
 	 */
-	className?: string | undefined;
+	readonly className?: string | undefined;
 	/**
 	 * The href of this heading.
 	 */
-	href?: string | undefined;
+	readonly href?: string | undefined;
 }
 
 export function CodeHeading({ href, className, children }: CodeListingProps) {

apps/website/src/components/ExcerptText.tsx

@@ -8,11 +8,11 @@ export interface ExcerptTextProps {
 	/**
 	 * The tokens to render.
 	 */
-	excerpt: Excerpt;
+	readonly excerpt: Excerpt;
 	/**
 	 * The model to resolve item references from.
 	 */
-	model: ApiModel;
+	readonly model: ApiModel;
 }
 
 /**

apps/website/src/components/InheritanceText.tsx

@@ -2,7 +2,7 @@ import type { ApiDeclaredItem } from '@microsoft/api-extractor-model';
 import { ItemLink } from './ItemLink';
 import { resolveItemURI } from './documentation/util';
 
-export function InheritanceText({ parent }: { parent: ApiDeclaredItem }) {
+export function InheritanceText({ parent }: { readonly parent: ApiDeclaredItem }) {
 	return (
 		<span className="font-semibold">
 			Inherited from{' '}