fix(website): remove several obsolete special handling of dtypes (#10898)

* fix(website): remove several obsolete special handling of dtypes

* fix: reduce hardcoded places

* chore: api-extractor.json setting mainEntryPointName

Author: Qjuh

apps/website/src/components/EntrypointSelect.tsx

@@ -17,24 +17,21 @@ export function EntryPointSelect({
 	const { entryPoints: parsedEntrypoints } = parseDocsPathParams(params.item as string[] | undefined);
 
 	return (
-		<Select
-			aria-label="Select an entrypoint"
-			defaultSelectedKey={parsedEntrypoints.length ? parsedEntrypoints.join('/') : 'global'}
-		>
+		<Select aria-label="Select an entrypoint" defaultSelectedKey={parsedEntrypoints.join('/')}>
 			<SelectTrigger className="bg-[#f3f3f4] dark:bg-[#121214]" />
 			<SelectList classNames={{ popover: 'bg-[#f3f3f4] dark:bg-[#28282d]' }} items={entryPoints}>
 				{(item) => (
 					<SelectOption
 						className="dark:pressed:bg-[#313135] bg-[#f3f3f4] dark:bg-[#28282d] dark:hover:bg-[#313135]"
 						href={`/docs/packages/${params.packageName}/${params.version}/${item.entryPoint}`}
-						id={item.entryPoint || 'global'}
-						key={item.entryPoint || 'global'}
+						id={item.entryPoint}
+						key={item.entryPoint}
 						onHoverStart={() =>
 							router.prefetch(`/docs/packages/${params.packageName}/${params.version}/${item.entryPoint}`)
 						}
-						textValue={item.entryPoint || 'global'}
+						textValue={item.entryPoint}
 					>
-						{item.entryPoint || 'global'}
+						{item.entryPoint}
 					</SelectOption>
 				)}
 			</SelectList>

apps/website/src/middleware.ts

@@ -1,14 +1,19 @@
 import Cloudflare from 'cloudflare';
 import { NextResponse, type NextRequest } from 'next/server';
-import { PACKAGES } from './util/constants';
+import { DEFAULT_ENTRY_POINT, PACKAGES, PACKAGES_WITH_ENTRY_POINTS } from './util/constants';
 import { ENV } from './util/env';
 
 const client = new Cloudflare({
 	apiToken: process.env.CF_D1_DOCS_API_KEY,
 });
 
 async function fetchLatestVersion(packageName: string): Promise<string> {
+	const hasEntryPoints = PACKAGES_WITH_ENTRY_POINTS.includes(packageName);
 	if (ENV.IS_LOCAL_DEV) {
+		if (hasEntryPoints) {
+			return ['main', ...DEFAULT_ENTRY_POINT].join('/');
+		}
+
 		return 'main';
 	}
 
@@ -19,7 +24,7 @@ async function fetchLatestVersion(packageName: string): Promise<string> {
 			params: [packageName],
 		});
 
-		return (result[0]?.results as { version: string }[] | undefined)?.[0]?.version ?? 'main';
+		return `${(result[0]?.results as { version: string }[] | undefined)?.[0]?.version ?? 'main'}${hasEntryPoints ? ['', ...DEFAULT_ENTRY_POINT].join('/') : ''}`;
 	} catch {
 		return '';
 	}

apps/website/src/util/constants.ts

@@ -16,5 +16,7 @@ export const PACKAGES = [
 
 export const PACKAGES_WITH_ENTRY_POINTS = ['discord-api-types'];
 
+export const DEFAULT_ENTRY_POINT = ['v10'];
+
 export const DESCRIPTION =
 	"discord.js is a powerful Node.js module that allows you to interact with the Discord API very easily. It takes a much more object-oriented approach than most other JS Discord libraries, making your bot's code significantly tidier and easier to comprehend.";

apps/website/src/util/parseDocsPathParams.ts

@@ -1,3 +1,5 @@
+import { DEFAULT_ENTRY_POINT } from './constants';
+
 export function parseDocsPathParams(item: string[] | undefined): {
 	entryPoints: string[];
 	foundItem: string | undefined;
@@ -10,7 +12,7 @@ export function parseDocsPathParams(item: string[] | undefined): {
 	const hasTypeMarker = lastElement?.includes('%3A');
 
 	return {
-		entryPoints: hasTypeMarker ? item.slice(0, -1) : item,
+		entryPoints: hasTypeMarker ? item.slice(0, -1) : lastElement?.length === 0 ? DEFAULT_ENTRY_POINT : item,
 		foundItem: hasTypeMarker ? lastElement : undefined,
 	};
 }

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

@@ -15,16 +15,14 @@ import { ApiPackage } from './ApiPackage.js';
 export interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions {}
 
 /**
- * Represents the entry point for an NPM package.
+ * Represents an entry point for an NPM package.
  *
  * @remarks
  *
  * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
  * API declarations.
  *
- * `ApiEntryPoint` represents the entry point to an NPM package.  API Extractor does not currently support
- * analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature.
- * In the current implementation, `ApiEntryPoint.importPath` is always the empty string.
+ * `ApiEntryPoint` represents an entry point to an NPM package.
  *
  * For example, suppose the package.json file looks like this:
  *
@@ -37,7 +35,7 @@ export interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IA
  * }
  * ```
  *
- * In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`.
+ * In this example, the main `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`.
  * @public
  */
 export class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) {
@@ -62,12 +60,7 @@ export class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem))
 
 	/**
 	 * The module path for this entry point, relative to the parent `ApiPackage`.  In the current implementation,
-	 * this is always the empty string, indicating the default entry point.
-	 *
-	 * @remarks
-	 *
-	 * API Extractor does not currently support analysis of multiple entry points.  If that feature is implemented
-	 * in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points,
+	 * this is used to distinguish different entry points,
 	 * for example: `controls/Button` in `import { Button } from "example-package/controls/Button";`.
 	 *
 	 * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.

packages/api-extractor/src/api/ExtractorConfig.ts

@@ -209,6 +209,7 @@ interface IExtractorConfigParameters {
 	docModelIncludeForgottenExports: boolean;
 	enumMemberOrder: EnumMemberOrder;
 	mainEntryPointFilePath: string;
+	mainEntryPointName: string;
 	messages: IExtractorMessagesConfig;
 	newlineKind: NewlineKind;
 	omitTrimmingComments: boolean;
@@ -474,6 +475,7 @@ export class ExtractorConfig {
 		projectFolder,
 		packageJson,
 		packageFolder,
+		mainEntryPointName,
 		mainEntryPointFilePath,
 		additionalEntryPoints,
 		bundledPackages,
@@ -509,7 +511,7 @@ export class ExtractorConfig {
 		this.packageJson = packageJson;
 		this.packageFolder = packageFolder;
 		this.mainEntryPointFilePath = {
-			modulePath: '',
+			modulePath: mainEntryPointName,
 			filePath: mainEntryPointFilePath,
 		};
 		this.additionalEntryPoints = additionalEntryPoints;
@@ -1003,6 +1005,8 @@ export class ExtractorConfig {
 				tokenContext,
 			);
 
+			const mainEntryPointName = configObject.mainEntryPointName ?? '';
+
 			if (!ExtractorConfig.hasDtsFileExtension(mainEntryPointFilePath)) {
 				throw new Error('The "mainEntryPointFilePath" value is not a declaration file: ' + mainEntryPointFilePath);
 			}
@@ -1289,6 +1293,7 @@ export class ExtractorConfig {
 				packageJson,
 				packageFolder,
 				mainEntryPointFilePath,
+				mainEntryPointName,
 				additionalEntryPoints,
 				bundledPackages,
 				tsconfigFilePath,

packages/api-extractor/src/api/IConfigFile.ts

@@ -491,6 +491,11 @@ export interface IConfigFile {
 	 */
 	mainEntryPointFilePath: string;
 
+	/**
+	 * Specifies the import path of the entrypoint used as the starting point for analysis.
+	 */
+	mainEntryPointName: string;
+
 	/**
 	 * {@inheritDoc IExtractorMessagesConfig}
 	 */

packages/api-extractor/src/generators/ApiModelGenerator.ts

@@ -291,6 +291,7 @@ export class ApiModelGenerator {
 			docComment: packageDocComment,
 			tsdocConfiguration: this._collector.extractorConfig.tsdocConfiguration,
 			projectFolderUrl: this._collector.extractorConfig.projectFolderUrl,
+			preserveMemberOrder: true,
 		});
 		this._apiModel.addMember(apiPackage);
 

packages/api-extractor/src/schemas/api-extractor-defaults.json

@@ -3,6 +3,8 @@
 
 	// ("mainEntryPointFilePath" is required)
 
+	"mainEntryPointName": "",
+
 	"bundledPackages": [],
 
 	"newlineKind": "crlf",

packages/api-extractor/src/schemas/api-extractor-template.json

@@ -47,6 +47,11 @@
 	 */
 	"mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
 
+	/**
+	 * Specifies the import path of the entrypoint used as the starting point for analysis.
+	 */
+	// "mainEntryPointName": "",
+
 	/**
 	 * A list of NPM package names whose exports should be treated as part of this package.
 	 *