confirm that changelog still works

fern-api · Jun 3, 2024 · 464b1db · 464b1db
1 parent c099a39
commit 464b1db
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 54 deletions.
diff --git a/packages/ui/app/src/sidebar/SidebarLink.tsx b/packages/ui/app/src/sidebar/SidebarLink.tsx
@@ -138,7 +138,7 @@ const SidebarLinkInternal = forwardRef<HTMLButtonElement, SidebarLinkProps>((pro
             data-state={showIndicator ? "active" : "inactive"}
         >
             <ChevronDown
-                className={cn("size-5 lg:size-icon lg:my-0.5", {
+                className={cn("size-5 lg:size-icon", {
                     "-rotate-90": !expanded,
                     "rotate-0": expanded,
                 })}
@@ -167,7 +167,7 @@ const SidebarLinkInternal = forwardRef<HTMLButtonElement, SidebarLinkProps>((pro
                             ))}
                             <span className="fern-sidebar-link-content">
                                 {icon != null && (
-                                    <span className="mr-3 inline-flex items-center text-faded group-data-[state=active]:text-text-default">
+                                    <span className="mr-3 inline-flex items-center text-faded group-data-[state=active]:t-accent-aaa my-0.5">
                                         {typeof icon === "string" ? (
                                             <RemoteFontAwesomeIcon
                                                 icon={icon}

diff --git a/packages/ui/app/src/sidebar/nodes/SidebarApiGroupNode.tsx b/packages/ui/app/src/sidebar/nodes/SidebarApiGroupNode.tsx
@@ -2,7 +2,7 @@ import { FernNavigation } from "@fern-api/fdr-sdk";
 import { SidebarApiSectionChild } from "./SidebarApiSectionChild";
 
 interface SidebarApiGroupNodeProps {
-    nodeChildren: FernNavigation.ApiSectionChild[];
+    nodeChildren: (FernNavigation.ApiSectionChild | FernNavigation.ChangelogNode)[];
 }
 export function SidebarApiGroupNode({ nodeChildren }: SidebarApiGroupNodeProps): React.ReactElement {
     return (

diff --git a/packages/ui/app/src/sidebar/nodes/SidebarApiSectionChild.tsx b/packages/ui/app/src/sidebar/nodes/SidebarApiSectionChild.tsx
@@ -2,12 +2,13 @@ import { FernNavigation } from "@fern-api/fdr-sdk";
 import { visitDiscriminatedUnion } from "@fern-ui/core-utils";
 import { SidebarApiLeafNode } from "./SidebarApiLeafNode";
 import { SidebarApiSectionNode } from "./SidebarApiSectionNode";
+import { SidebarChangelogNode } from "./SidebarChangelogNode";
 import { SidebarEndpointPairNode } from "./SidebarEndpointPairNode";
 import { SidebarLinkNode } from "./SidebarLinkNode";
 import { SidebarPageNode } from "./SidebarPageNode";
 
 interface SidebarApiSectionChild {
-    node: FernNavigation.ApiSectionChild;
+    node: FernNavigation.ApiSectionChild | FernNavigation.ChangelogNode;
     depth: number;
 }
 
@@ -20,5 +21,6 @@ export function SidebarApiSectionChild({ node, depth }: SidebarApiSectionChild):
         webSocket: (node) => <SidebarApiLeafNode node={node} depth={depth} />,
         webhook: (node) => <SidebarApiLeafNode node={node} depth={depth} />,
         apiSection: (node) => <SidebarApiSectionNode node={node} depth={depth} />,
+        changelog: (node) => <SidebarChangelogNode node={node} depth={depth} />,
     });
 }
diff --git a/packages/ui/app/src/sidebar/nodes/SidebarRootApiSectionNode.tsx b/packages/ui/app/src/sidebar/nodes/SidebarRootApiSectionNode.tsx
@@ -71,6 +71,11 @@ export function SidebarRootApiSectionNode({
                         <SidebarApiSectionChild node={child} depth={1} />
                     </li>
                 ))}
+                {node.type === "apiReference" && node.changelog != null && (
+                    <li>
+                        <SidebarApiSectionChild node={node.changelog} depth={1} />
+                    </li>
+                )}
             </ul>
         </>
     );

diff --git a/packages/ui/app/src/sidebar/nodes/SidebarRootNode.tsx b/packages/ui/app/src/sidebar/nodes/SidebarRootNode.tsx
@@ -12,7 +12,7 @@ interface SidebarRootNodeProps {
 }
 
 type ApiGroupOrSection =
-    | { type: "apiGroup"; children: FernNavigation.ApiSectionChild[] }
+    | { type: "apiGroup"; children: (FernNavigation.ApiSectionChild | FernNavigation.ChangelogNode)[] }
     | FernNavigation.ApiSectionNode;
 
 export function SidebarRootNode({ node }: SidebarRootNodeProps): React.ReactElement {
@@ -36,18 +36,20 @@ export function SidebarRootNode({ node }: SidebarRootNodeProps): React.ReactElem
 
                         const groups: ApiGroupOrSection[] = [];
 
-                        apiRef.children.forEach((child) => {
-                            if (child.type === "apiSection") {
-                                groups.push(child);
-                            } else {
-                                const lastGroup = last(groups);
-                                if (lastGroup?.type === "apiGroup") {
-                                    lastGroup.children.push(child);
+                        [...apiRef.children, ...(apiRef.changelog != null ? [apiRef.changelog] : [])].forEach(
+                            (child) => {
+                                if (child.type === "apiSection") {
+                                    groups.push(child);
                                 } else {
-                                    groups.push({ type: "apiGroup", children: [child] });
+                                    const lastGroup = last(groups);
+                                    if (lastGroup?.type === "apiGroup") {
+                                        lastGroup.children.push(child);
+                                    } else {
+                                        groups.push({ type: "apiGroup", children: [child] });
+                                    }
                                 }
-                            }
-                        });
+                            },
+                        );
 
                         return (
                             <Fragment key={child.id}>

diff --git a/packages/ui/app/src/util/convertNavigatableToResolvedPath.ts b/packages/ui/app/src/util/convertNavigatableToResolvedPath.ts
@@ -79,33 +79,7 @@ export async function convertNavigatableToResolvedPath({
     const neighbors = await getNeighbors(found, pages);
     const { node, apiReference } = found;
 
-    if (apiReference != null) {
-        const api = apis[apiReference.apiDefinitionId];
-        if (api == null) {
-            return;
-        }
-        const holder = FernNavigation.ApiDefinitionHolder.create(api);
-        const typeResolver = new ApiTypeResolver(api.types);
-        // const [prunedApiDefinition] = findAndPruneApiSection(fullSlug, flattenedApiDefinition);
-        const apiDefinition = await ApiDefinitionResolver.resolve(
-            apiReference,
-            holder,
-            typeResolver,
-            pages,
-            mdxOptions,
-            featureFlags,
-            domain,
-        );
-        return {
-            type: "api-page",
-            fullSlug: found.node.slug,
-            api: apiReference.apiDefinitionId,
-            apiDefinition,
-            // artifacts: apiSection.artifacts ?? null, // TODO: add artifacts
-            showErrors: apiReference.showErrors ?? false,
-            neighbors,
-        };
-    } else if (node.type === "changelog") {
+    if (node.type === "changelog") {
         const pageContent = node.overviewPageId != null ? pages[node.overviewPageId] : undefined;
         const serializedMdxContent =
             pageContent != null ? await serializeMdxWithFrontmatter(pageContent.markdown, mdxOptions) : null;
@@ -137,6 +111,32 @@ export async function convertNavigatableToResolvedPath({
             items: await Promise.all(itemsPromise),
             neighbors,
         };
+    } else if (apiReference != null) {
+        const api = apis[apiReference.apiDefinitionId];
+        if (api == null) {
+            return;
+        }
+        const holder = FernNavigation.ApiDefinitionHolder.create(api);
+        const typeResolver = new ApiTypeResolver(api.types);
+        // const [prunedApiDefinition] = findAndPruneApiSection(fullSlug, flattenedApiDefinition);
+        const apiDefinition = await ApiDefinitionResolver.resolve(
+            apiReference,
+            holder,
+            typeResolver,
+            pages,
+            mdxOptions,
+            featureFlags,
+            domain,
+        );
+        return {
+            type: "api-page",
+            fullSlug: found.node.slug,
+            api: apiReference.apiDefinitionId,
+            apiDefinition,
+            // artifacts: apiSection.artifacts ?? null, // TODO: add artifacts
+            showErrors: apiReference.showErrors ?? false,
+            neighbors,
+        };
     } else if (node.type === "page") {
         const pageContent = pages[node.pageId];
         if (pageContent == null) {

diff --git a/packages/ui/docs-bundle/src/utils/getDocsPageProps.ts b/packages/ui/docs-bundle/src/utils/getDocsPageProps.ts
@@ -271,12 +271,14 @@ async function convertDocsToDocsPageProps({
                 }),
             ),
             currentVersionIndex: node.currentVersion == null ? undefined : node.versions.indexOf(node.currentVersion),
-            versions: node.versions.map((version, index) => ({
-                id: version.versionId,
-                slug: version.slug,
-                index,
-                availability: version.availability,
-            })),
+            versions: node.versions
+                .filter((version) => !version.hidden)
+                .map((version, index) => ({
+                    id: version.versionId,
+                    slug: version.slug,
+                    index,
+                    availability: version.availability,
+                })),
             sidebar: node.sidebar,
         },
         featureFlags,

diff --git a/packages/ui/local-preview-bundle/src/utils/getDocsPageProps.ts b/packages/ui/local-preview-bundle/src/utils/getDocsPageProps.ts
@@ -116,12 +116,14 @@ export async function getDocsPageProps(
                 }),
             ),
             currentVersionIndex: node.currentVersion == null ? undefined : node.versions.indexOf(node.currentVersion),
-            versions: node.versions.map((version, index) => ({
-                id: version.versionId,
-                slug: version.slug,
-                index,
-                availability: version.availability,
-            })),
+            versions: node.versions
+                .filter((version) => !version.hidden)
+                .map((version, index) => ({
+                    id: version.versionId,
+                    slug: version.slug,
+                    index,
+                    availability: version.availability,
+                })),
             sidebar: node.sidebar,
         },
         featureFlags,
-Original file line number
+Diff line change
@@ Expand Up / @@ -71,6 +71,11 @@ export function SidebarRootApiSectionNode({ @@
                             <SidebarApiSectionChild node={child} depth={1} />
                         </li>
                     ))}
+                    {node.type === "apiReference" && node.changelog != null && (
+                        <li>
+                            <SidebarApiSectionChild node={node.changelog} depth={1} />
+                        </li>
+                    )}
                 </ul>
             </>
         );
@@ Expand Down @@