feat: command menu

packages/api-extractor-utils/src/parse.ts

@@ -47,7 +47,7 @@ export function generatePath(items: readonly ApiItem[], version: string) {
 			case ApiItemKind.MethodSignature:
 			case ApiItemKind.PropertySignature:
 				// TODO: Take overloads into account
-				path += `#${item.displayName}:${item.kind}`;
+				path += `#${item.displayName}`;
 				break;
 			default:
 				path += `/${item.displayName}:${item.kind}`;

packages/scripts/src/generateIndex.ts

@@ -8,6 +8,7 @@ import {
 	ApiItem,
 	ApiModel,
 	type ApiPackage,
+	ApiItemKind,
 } from '@microsoft/api-extractor-model';
 import {
 	DocNodeKind,
@@ -102,6 +103,10 @@ export function visitNodes(item: ApiItem, tag: string) {
 			continue;
 		}
 
+		if (member.kind === ApiItemKind.Constructor) {
+			continue;
+		}
+
 		if (ApiItemContainerMixin.isBaseClassOf(member)) {
 			members.push(...visitNodes(member, tag));
 		}
@@ -109,7 +114,7 @@ export function visitNodes(item: ApiItem, tag: string) {
 		members.push({
 			name: member.displayName,
 			kind: member.kind,
-			summary: tryResolveSummaryText(member),
+			summary: tryResolveSummaryText(member) ?? '',
 			path: generatePath(member.getHierarchy(), tag),
 		});
 	}
@@ -123,13 +128,13 @@ export async function generateIndex(model: ApiModel, packageName: string, tag =
 	const dir = 'searchIndex';
 
 	try {
-		(await stat(join(cwd(), dir))).isDirectory();
+		(await stat(join(cwd(), 'public', dir))).isDirectory();
 	} catch {
-		await mkdir(join(cwd(), dir));
+		await mkdir(join(cwd(), 'public', dir));
 	}
 
 	await writeFile(
-		join(cwd(), 'searchIndex', `${packageName}-${tag}-index.json`),
+		join(cwd(), 'public', dir, `${packageName}-${tag}-index.json`),
 		JSON.stringify(members, undefined, 2),
 	);
 }

packages/website/.gitignore

@@ -27,3 +27,4 @@ src/styles/unocss.css
 .tmp/
 coverage/
 .vercel
+public/searchIndex

packages/website/next.config.js

@@ -12,10 +12,8 @@ export default {
 	},
 	cleanDistDir: true,
 	experimental: {
-		images: {
-			allowFutureImage: true,
-		},
 		outputFileTracingRoot: fileURLToPath(new URL('../../', import.meta.url)),
+		fallbackNodePolyfills: true,
 	},
 	images: {
 		dangerouslyAllowSVG: true,

packages/website/package.json

@@ -5,8 +5,8 @@
 	"private": true,
 	"scripts": {
 		"test": "vitest run",
-		"build:local": "NEXT_PUBLIC_LOCAL_DEV=true yarn run --top-level docs --force && yarn build:prod",
-		"build:prod": "yarn build:css && yarn build:next",
+		"build:local": "NEXT_PUBLIC_LOCAL_DEV=true yarn build:prod",
+		"build:prod": "yarn run --top-level docs --force && yarn build:css && yarn build:next && yarn node scripts/generateAllIndicies.js",
 		"build:next": "next build",
 		"build:css": "yarn generate:css",
 		"dev": "yarn run --top-level docs && concurrently 'yarn dev:css' 'yarn dev:next'",
@@ -41,15 +41,18 @@
 	"dependencies": {
 		"@discordjs/api-extractor-utils": "workspace:^",
 		"@discordjs/scripts": "workspace:^",
+		"@lyrasearch/lyra": "^0.2.3",
 		"@microsoft/api-extractor-model": "7.24.0",
 		"@microsoft/tsdoc": "0.14.1",
 		"@vscode/codicons": "^0.0.32",
 		"ariakit": "^2.0.0-next.41",
+		"cmdk": "^0.1.20",
+		"flexsearch": "^0.7.21",
 		"minisearch": "^5.0.0",
-		"next": "^12.2.5",
+		"next": "^12.3.0",
 		"next-mdx-remote": "^4.1.0",
 		"next-progress": "^2.2.0",
-		"next-themes": "^0.2.0",
+		"next-themes": "^0.2.1",
 		"react": "^18.2.0",
 		"react-custom-scrollbars-2": "^4.5.0",
 		"react-dom": "^18.2.0",
@@ -68,22 +71,23 @@
 	"devDependencies": {
 		"@testing-library/react": "^13.4.0",
 		"@testing-library/user-event": "^14.4.3",
-		"@types/node": "^16.11.57",
+		"@types/flexsearch": "^0.7.3",
+		"@types/node": "^16.11.58",
 		"@types/react-dom": "^18.0.6",
 		"@types/react-syntax-highlighter": "^15.5.5",
-		"@unocss/cli": "^0.45.15",
-		"@unocss/reset": "^0.45.15",
+		"@unocss/cli": "^0.45.18",
+		"@unocss/reset": "^0.45.18",
 		"@vitejs/plugin-react": "^2.1.0",
 		"@vitest/coverage-c8": "^0.23.1",
-		"concurrently": "^7.3.0",
+		"concurrently": "^7.4.0",
 		"eslint": "^8.23.0",
 		"eslint-config-neon": "^0.1.33",
 		"happy-dom": "^6.0.4",
 		"prettier": "^2.7.1",
 		"prettier-plugin-tailwindcss": "^0.1.13",
-		"typescript": "^4.8.2",
-		"unocss": "^0.45.15",
-		"vercel": "^28.2.2",
+		"typescript": "^4.8.3",
+		"unocss": "^0.45.18",
+		"vercel": "^28.2.3",
 		"vitest": "^0.23.1"
 	},
 	"engines": {

packages/website/scripts/generateAllIndicies.js

@@ -0,0 +1,5 @@
+import { generateAllIndicies } from '@discordjs/scripts';
+
+console.log('Generating all indicies...');
+await generateAllIndicies();
+console.log('Generated all indicies.');

packages/website/src/components/Cmdk.tsx

@@ -0,0 +1,225 @@
+// import { insertBatch, search as searchDb } from '@lyrasearch/lyra';
+// import type { ApiItemKind } from '@microsoft/api-extractor-model';
+import { Dialog, useDialogState } from 'ariakit/dialog';
+import { Command } from 'cmdk';
+import { useRouter } from 'next/router';
+import { useEffect, useMemo, useState } from 'react';
+import {
+	VscArrowRight,
+	VscPackage,
+	// VscSymbolClass,
+	// VscSymbolEnum,
+	// VscSymbolField,
+	// VscSymbolInterface,
+	// VscSymbolMethod,
+	// VscSymbolProperty,
+	// VscSymbolVariable,
+	VscVersions,
+} from 'react-icons/vsc';
+import { useKey } from 'react-use';
+import useSWR from 'swr';
+import { PACKAGES } from '~/util/constants';
+import { fetcher } from '~/util/fetcher';
+
+// function resolveIcon(item: keyof ApiItemKind) {
+// 	switch (item) {
+// 		case 'Class':
+// 			return <VscSymbolClass size={25} />;
+// 		case 'Enum':
+// 			return <VscSymbolEnum size={25} />;
+// 		case 'Interface':
+// 			return <VscSymbolInterface size={25} />;
+// 		case 'Property':
+// 			return <VscSymbolProperty size={25} />;
+// 		case 'TypeAlias':
+// 			return <VscSymbolField size={25} />;
+// 		case 'Variables':
+// 			return <VscSymbolVariable size={25} />;
+// 		default:
+// 			return <VscSymbolMethod size={25} />;
+// 	}
+// }
+
+// const searchIndex: any[] = [];
+
+export function CmdkDialog() {
+	const router = useRouter();
+	const dialog = useDialogState();
+	const [search, setSearch] = useState('');
+	const [page, setPage] = useState('');
+	const [packageName, setPackageName] = useState('');
+	// const [searchResults, setSearchResults] = useState<any[]>([]);
+
+	const { data: versions, isValidating } = useSWR<string[]>(
+		packageName ? `https://docs.discordjs.dev/api/info?package=${packageName}` : null,
+		fetcher,
+	);
+
+	// const { data: searchIndex } = useSWR<any[]>(
+	// 	packageName ? `http://localhost:3000/searchIndex/${packageName}-main-index.json` : null,
+	// 	fetcher,
+	// );
+
+	const packageCommandItems = useMemo(
+		() =>
+			PACKAGES.map((pkg) => (
+				<Command.Item
+					key={pkg}
+					className="dark:border-dark-100 dark:hover:bg-dark-300 dark:active:bg-dark-200 [&[aria-selected]]:ring-blurple [&[aria-selected]]:ring-offset-0 [&[aria-selected]]:ring-width-4 [&[aria-selected]]:ring flex flex h-11 w-full transform-gpu cursor-pointer select-none appearance-none flex-col place-content-center rounded bg-transparent p-4 text-base font-semibold leading-none text-black outline-0 hover:bg-neutral-100 active:translate-y-px active:bg-neutral-200 dark:text-white"
+					onSelect={() => {
+						setPackageName(pkg);
+						setPage('version');
+						setSearch('');
+					}}
+				>
+					<div className="flex w-full grow flex-row place-content-between place-items-center gap-4">
+						<div className="flex grow flex-row place-content-between place-items-center gap-4">
+							<div className="flex flex-row place-content-between place-items-center gap-4">
+								<VscPackage size={25} />
+								<h2 className="font-semibold">{pkg}</h2>
+							</div>
+						</div>
+						<VscArrowRight size={20} />
+					</div>
+				</Command.Item>
+			)),
+		[],
+	);
+
+	const versionCommandItems = useMemo(
+		() =>
+			versions
+				?.map((version) => (
+					<Command.Item
+						key={version}
+						className="dark:border-dark-100 dark:hover:bg-dark-300 dark:active:bg-dark-200 [&[aria-selected]]:ring-blurple [&[aria-selected]]:ring-offset-0 [&[aria-selected]]:ring-width-4 [&[aria-selected]]:ring flex flex h-11 w-full transform-gpu cursor-pointer select-none appearance-none flex-col place-content-center rounded bg-transparent p-4 text-base font-semibold leading-none text-black outline-0 hover:bg-neutral-100 active:translate-y-px active:bg-neutral-200 dark:text-white"
+						onSelect={() => {
+							void router.push(`/docs/packages/${packageName}/${version}`);
+							dialog.setOpen(false);
+						}}
+					>
+						<div className="flex w-full grow flex-row place-content-between place-items-center gap-4">
+							<div className="flex grow flex-row place-content-between place-items-center gap-4">
+								<div className="flex flex-row place-content-between place-items-center gap-4">
+									<VscVersions size={25} />
+									<h2 className="font-semibold">{version}</h2>
+								</div>
+							</div>
+							<VscArrowRight size={20} />
+						</div>
+					</Command.Item>
+				))
+				.reverse() ?? [],
+		// eslint-disable-next-line react-hooks/exhaustive-deps
+		[packageName],
+	);
+
+	// const searchResultItems = useMemo(
+	// 	() =>
+	// 		searchResults?.map((item) => (
+	// 			<Command.Item
+	// 				key={item.id}
+	// 				className="dark:border-dark-100 dark:hover:bg-dark-300 dark:active:bg-dark-200 [&[aria-selected]]:ring-blurple [&[aria-selected]]:ring-offset-0 [&[aria-selected]]:ring-width-4 [&[aria-selected]]:ring flex flex h-11 w-full transform-gpu cursor-pointer select-none appearance-none flex-col place-content-center rounded bg-transparent p-4 text-base font-semibold leading-none text-black outline-0 hover:bg-neutral-100 active:translate-y-px active:bg-neutral-200 dark:text-white"
+	// 				onSelect={() => {
+	// 					void router.push(item.path);
+	// 					dialog.setOpen(false);
+	// 				}}
+	// 			>
+	// 				<div className="flex w-full grow flex-row place-content-between place-items-center gap-4">
+	// 					<div className="flex grow flex-row place-content-between place-items-center gap-4">
+	// 						<div className="flex flex-row place-content-between place-items-center gap-4">
+	// 							{resolveIcon(item.kind)}
+	// 							<div className="flex flex-col">
+	// 								<h2 className="font-semibold">{item.name}</h2>
+	// 								<span className="text-sm font-normal">{item.summary}</span>
+	// 							</div>
+	// 						</div>
+	// 					</div>
+	// 					<VscArrowRight size={20} />
+	// 				</div>
+	// 			</Command.Item>
+	// 		)) ?? [],
+	// 	// eslint-disable-next-line react-hooks/exhaustive-deps
+	// 	[searchResults],
+	// );
+
+	useKey((event) => event.key === 'k' && event.metaKey, dialog.toggle, { event: 'keydown' }, []);
+	useKey(
+		(event) => event.key === 'Backspace' && !search,
+		() => setPage(''),
+		{ event: 'keydown' },
+		[],
+	);
+
+	useEffect(() => {
+		if (!dialog.open) {
+			setSearch('');
+			setPage('');
+		}
+	}, [dialog.open]);
+
+	// useEffect(() => {
+	// 	if (searchIndex?.length) {
+	// 		void insertBatch(db, searchIndex);
+	// 	}
+	// 	// eslint-disable-next-line react-hooks/exhaustive-deps
+	// }, [searchIndex]);
+
+	// useEffect(() => {
+	// 	if (search) {
+	// 		const results = searchDb(db, {
+	// 			term: search,
+	// 			properties: ['name', 'kind', 'summary'],
+	// 		});
+	// 		setSearchResults(results.hits);
+	// 	}
+	// 	// eslint-disable-next-line react-hooks/exhaustive-deps
+	// }, [search]);
+
+	return (
+		<Dialog className="fixed top-1/4 left-1/2 z-50 -translate-x-1/2" state={dialog}>
+			<Command label="Command Menu" className="bg-dark-300 w-lg rounded">
+				<Command.Input
+					className="bg-dark-300 caret-blurple mt-4 w-full border-0 p-4 pt-0 text-lg outline-0"
+					placeholder="Type to search..."
+					value={search}
+					onValueChange={setSearch}
+				/>
+				<Command.List className="pt-0">
+					<Command.Empty className="p-4 text-center">No results found</Command.Empty>
+
+					{isValidating ? (
+						<Command.Loading>
+							<div className="p-4 text-center" role="status">
+								<span className="animate-fade-in animate-delay-1000 animate-fill-forwards opacity-0" aria-hidden="true">
+									<svg
+										className="fill-blurple inline h-8 w-8 animate-spin text-white dark:text-white"
+										viewBox="0 0 100 101"
+										fill="none"
+										xmlns="http://www.w3.org/2000/svg"
+									>
+										<path
+											d="M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z"
+											fill="currentColor"
+										/>
+										<path
+											d="M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z"
+											fill="currentFill"
+										/>
+									</svg>
+								</span>
+								<span className="sr-only">Loading...</span>
+							</div>
+						</Command.Loading>
+					) : null}
+
+					{page /* || search */ ? null : packageCommandItems}
+
+					{page === 'version' /* && !search */ ? versionCommandItems : null}
+
+					{/* {search && !page ? searchResultItems : null} */}
+				</Command.List>
+			</Command>
+		</Dialog>
+	);
+}

packages/website/src/components/SidebarLayout.tsx

@@ -12,15 +12,12 @@ import { VscChevronDown, VscColorMode, VscGithubInverted, VscMenu, VscPackage, V
 import { useMedia /* useLockBodyScroll */ } from 'react-use';
 import useSWR from 'swr';
 import vercelLogo from '../assets/powered-by-vercel.svg';
+import { CmdkDialog } from './Cmdk';
 import { SidebarItems } from './SidebarItems';
 import { PACKAGES } from '~/util/constants';
+import { fetcher } from '~/util/fetcher';
 import type { findMember } from '~/util/model.server';
 
-const fetcher = async (url: string) => {
-	const res = await fetch(url);
-	return res.json();
-};
-
 export interface SidebarLayoutProps {
 	branchName: string;
 	data: {
@@ -310,6 +307,7 @@ export function SidebarLayout({
 					</footer>
 				</article>
 			</main>
+			<CmdkDialog />
 		</>
 	);
 }

packages/website/src/pages/_app.tsx

@@ -4,6 +4,7 @@ import NextProgress from 'next-progress';
 import { ThemeProvider } from 'next-themes';
 import '@unocss/reset/tailwind.css';
 import '../styles/unocss.css';
+import '../styles/cmdk.css';
 import '../styles/main.css';
 
 export default function MyApp({ Component, pageProps }: AppProps) {

packages/website/src/pages/docs/[...slug].tsx

@@ -171,16 +171,9 @@ export const getStaticProps: GetStaticProps = async ({ params }) => {
 		});
 
 		let data;
-		let searchIndex = [];
 		if (process.env.NEXT_PUBLIC_LOCAL_DEV) {
 			const res = await readFile(join(cwd(), '..', packageName, 'docs', 'docs.api.json'), 'utf8');
 			data = JSON.parse(res);
-
-			const response = await readFile(
-				join(cwd(), '..', 'scripts', 'searchIndex', `${packageName}-main-index.json`),
-				'utf8',
-			);
-			searchIndex = JSON.parse(response);
 		} else {
 			const res = await fetch(`https://docs.discordjs.dev/docs/${packageName}/${branchName}.api.json`);
 			data = await res.json();
@@ -204,7 +197,6 @@ export const getStaticProps: GetStaticProps = async ({ params }) => {
 					member:
 						memberName && containerKey ? findMemberByKey(model, packageName, containerKey, branchName) ?? null : null,
 					source: mdxSource,
-					searchIndex,
 				},
 			},
 			revalidate: 3_600,
@@ -215,7 +207,7 @@ export const getStaticProps: GetStaticProps = async ({ params }) => {
 
 		return {
 			props: {
-				error: error_,
+				error: error.message,
 			},
 			revalidate: 1,
 		};

packages/website/src/pages/docs/packages/[package]/index.tsx

@@ -53,7 +53,7 @@ export const getStaticProps: GetStaticProps = async ({ params }) => {
 
 		return {
 			props: {
-				error: error_,
+				error: error.message,
 			},
 			revalidate: 1,
 		};

packages/website/src/pages/docs/packages/index.tsx

@@ -35,7 +35,7 @@ export const getStaticProps: GetStaticProps = async () => {
 
 		return {
 			props: {
-				error: error_,
+				error: error.message,
 			},
 			revalidate: 1,
 		};
@@ -44,6 +44,7 @@ export const getStaticProps: GetStaticProps = async () => {
 
 export default function PackagesRoute(props: Partial<PackageProps> & { error?: string }) {
 	const router = useRouter();
+
 	const findLatestVersion = useCallback(
 		(pkg: string) => props.data?.versions.find((version) => version.packageName === pkg),
 		[props.data?.versions],

packages/website/src/styles/cmdk.css

@@ -0,0 +1,3 @@
+[data-backdrop] {
+	background-color: rgb(0 0 0 / 25%);
+}

packages/website/src/util/fetcher.ts

@@ -0,0 +1,4 @@
+export const fetcher = async (url: string) => {
+	const res = await fetch(url);
+	return res.json();
+};