@apify/docusaurus-plugin-typedoc-api 3.0.0 → 4.2.0

package/src/utils/hierarchy.ts

@@ -8,11 +8,15 @@ export interface HierarchyNode {
 
 // The JSON output does not include hierarchy information, so we need to duplicate the logic!
 // https://github.com/TypeStrong/typedoc/blob/master/src/lib/converter/plugins/TypePlugin.ts#L98
-export function createHierarchy(reflection: JSONOutput.DeclarationReflection) {
+export function createHierarchy(reflection: JSONOutput.Reflection) {
 	let root!: HierarchyNode;
 	let hierarchy!: HierarchyNode;
 
-	function push(types: JSONOutput.SomeType[]) {
+	function push(types?: JSONOutput.SomeType[]) {
+		if (!types) {
+			return;
+		}
+
 		const level: HierarchyNode = { types };
 
 		if (hierarchy) {
@@ -24,22 +28,22 @@ export function createHierarchy(reflection: JSONOutput.DeclarationReflection) {
 		}
 	}
 
-	if (reflection.extendedTypes) {
-		push(reflection.extendedTypes);
+	if ('extendedTypes' in reflection && reflection.extendedTypes) {
+		push((reflection as JSONOutput.DeclarationReflection).extendedTypes);
 	}
 
 	push([
 		{
-			id: reflection.id,
 			name: reflection.name,
+			target: reflection.id,
 			type: 'reference',
 		},
 	]);
 
 	hierarchy.isTarget = true;
 
-	if (reflection.extendedBy) {
-		push(reflection.extendedBy);
+	if ('extendedBy' in reflection && reflection.extendedBy) {
+		push((reflection as JSONOutput.DeclarationReflection).extendedBy);
 	}
 
 	return root;

package/src/utils/icons.ts

@@ -26,9 +26,8 @@ const KIND_ICONS: Record<ReflectionKind, string> = {
 	262_144: 'symbol-field', // Accessor
 	524_288: 'symbol-field', // GetSignature
 	1_048_576: 'symbol-field', // SetSignature
-	2_097_152: 'bracket', // ObjectLiteral
-	4_194_304: 'symbol-parameter', // TypeAlias
-	8_388_608: 'references', // Reference
+	2_097_152: 'symbol-parameter', // TypeAlias
+	4_194_304: 'references', // Reference
 };
 
 export function getKindIcon(kind: ReflectionKind, name: string): string {

package/src/utils/markdown.ts

@@ -1,5 +1,5 @@
 import type { PropVersionMetadata } from '@docusaurus/plugin-content-docs';
-import type { DeclarationReflectionMap } from '../types';
+import type { TSDDeclarationReflectionMap } from '../types';
 
 function splitLinkText(text: string): { caption: string; target: string } {
 	let splitIndex = text.indexOf('|');
@@ -25,7 +25,7 @@ function splitLinkText(text: string): { caption: string; target: string } {
 }
 
 function findReflectionWithMatchingTarget(
-	reflections: DeclarationReflectionMap,
+	reflections: TSDDeclarationReflectionMap,
 	symbol: string,
 	member?: string,
 ) {
@@ -39,7 +39,7 @@ function findReflectionWithMatchingTarget(
 }
 
 function replaceApiLinks(
-	reflections: DeclarationReflectionMap,
+	reflections: TSDDeclarationReflectionMap,
 ): (match: string, tagName: string, content: string) => string {
 	return (match: string, tagName: string, content: string) => {
 		const { caption, target } = splitLinkText(content);
@@ -57,13 +57,15 @@ function replaceApiLinks(
 
 function replaceDocLinks(
 	currentVersion: PropVersionMetadata,
+	baseUrl: string,
 ): (match: string, content: string) => string {
 	return (match: string, content: string) => {
 		const { caption, target } = splitLinkText(content);
 		const version = currentVersion.version === 'current' ? 'next' : currentVersion.version;
 
-		// TODO: Handle `routeBasePath`? Something else besides "docs"?
-		const url = currentVersion.isLast ? `/docs/${target}` : `/docs/${version}/${target}`;
+		const url = currentVersion.isLast
+			? `${baseUrl === '/' ? '' : baseUrl}/${target}`
+			: `${baseUrl === '/' ? '' : baseUrl}/${version}/${target}`;
 
 		return `[${caption}](${url})`;
 	};
@@ -73,10 +75,11 @@ function replaceDocLinks(
 // @see https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/plugins/MarkedLinksPlugin.ts
 export function replaceLinkTokens(
 	markdown: string,
-	reflections: DeclarationReflectionMap,
+	reflections: TSDDeclarationReflectionMap,
 	currentVersion: PropVersionMetadata,
+	docsBaseUrl: string,
 ) {
 	return markdown
 		.replace(/{@(link|linkcode|linkplain|apilink)\s+([^}]+?)}/gi, replaceApiLinks(reflections))
-		.replace(/{@doclink\s+([^}]+?)}/gi, replaceDocLinks(currentVersion));
+		.replace(/{@doclink\s+([^}]+?)}/gi, replaceDocLinks(currentVersion, docsBaseUrl));
 }

package/src/utils/visibility.ts

@@ -1,8 +1,8 @@
 import type { JSONOutput } from 'typedoc';
-import type { DeclarationReflectionMap } from '../types';
+import type { TSDDeclarationReflectionMap } from '../types';
 
 // https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/themes/DefaultTheme.ts#L264
-export function hasOwnDocument(id: number, reflections: DeclarationReflectionMap): boolean {
+export function hasOwnDocument(id: number, reflections: TSDDeclarationReflectionMap): boolean {
 	const reflection = reflections[id];
 
 	return Boolean(reflection?.permalink && !reflection.permalink.includes('#'));
@@ -11,7 +11,7 @@ export function hasOwnDocument(id: number, reflections: DeclarationReflectionMap
 // https://github.com/TypeStrong/typedoc/blob/2103f347c9cba40fcaa1f67e36f7cea0bdea2f0f/src/lib/models/ReflectionCategory.ts#L44
 export function allCategoryChildrenHaveOwnDocument(
 	category: JSONOutput.ReflectionCategory,
-	reflections: DeclarationReflectionMap,
+	reflections: TSDDeclarationReflectionMap,
 ): boolean {
 	let onlyOwnDocuments = true;
 
@@ -25,7 +25,7 @@ export function allCategoryChildrenHaveOwnDocument(
 // https://github.com/TypeStrong/typedoc/blob/2103f347c9cba40fcaa1f67e36f7cea0bdea2f0f/src/lib/models/ReflectionGroup.ts#L81
 export function allGroupChildrenHaveOwnDocument(
 	group: JSONOutput.ReflectionGroup,
-	reflections: DeclarationReflectionMap,
+	reflections: TSDDeclarationReflectionMap,
 ): boolean {
 	return Boolean(group.children?.every((child) => hasOwnDocument(child, reflections)));
 }