Merge branch 'main' into dd/getDocsForUrl-lambda

.github/workflows/publish-parsers-package.yml

@@ -0,0 +1,44 @@
+name: Publish Parsers Package
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'packages/parsers/package.json'
+
+jobs:
+  check-and-publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 2 # This helps turbo resolve changes faster
+
+      - name: Install
+        uses: ./.github/actions/install
+
+      - name: Check package.json changes
+        id: check-version
+        run: |
+          CHANGED=$(git diff HEAD^ HEAD -- packages/parsers/package.json | grep '"version":' || true)
+          if [ ! -z "$CHANGED" ]; then
+            echo "version_changed=true" >> $GITHUB_OUTPUT
+          else
+            echo "version_changed=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Install dependencies
+        if: steps.check-version.outputs.version_changed == 'true'
+        run: pnpm install
+
+      - name: Compile package
+        if: steps.check-version.outputs.version_changed == 'true'
+        run: pnpm --filter @fern-api/docs-parsers compile
+
+      - name: Publish to npm
+        if: steps.check-version.outputs.version_changed == 'true'
+        run: |
+          echo "//registry.npmjs.org/:_authToken=${{ secrets.FERN_NPM_TOKEN }}" > ~/.npmrc
+          pnpm --filter @fern-api/docs-parsers publish --no-git-checks --access public

fern/apis/fdr/definition/docs/v1/db/__package__.yml

@@ -59,6 +59,7 @@ types:
       root: optional<navigationV1.RootNode>
       navbarLinks: optional<list<commons.NavbarLink>>
       footerLinks: optional<list<commons.FooterLink>>
+      hideNavLinks: optional<boolean>
 
       # logo
       logoHeight: optional<docsReadV1.Height>

fern/apis/fdr/definition/docs/v1/read/__package__.yml

@@ -98,6 +98,7 @@ types:
       root: optional<navigationV1.RootNode>
       navbarLinks: optional<list<commons.NavbarLink>>
       footerLinks: optional<list<commons.FooterLink>>
+      hideNavLinks: optional<boolean>
 
       # logo
       logoHeight: optional<Height>

fern/apis/fdr/definition/docs/v1/write/__package__.yml

@@ -93,6 +93,7 @@ types:
       root: optional<navigationV1.RootNode>
       navbarLinks: optional<list<commons.NavbarLink>>
       footerLinks: optional<list<commons.FooterLink>>
+      hideNavLinks: optional<boolean>
 
       # logo
       logoHeight: optional<Height>

packages/commons/fdr-utils/src/definition-object-factory.ts

@@ -22,6 +22,7 @@ export class DefinitionObjectFactory {
         },
         navbarLinks: [],
         navigation: { items: [], landingPage: undefined },
+        hideNavLinks: undefined,
         root: undefined,
         title: undefined,
         defaultLanguage: undefined,

packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts

@@ -110,6 +110,7 @@ export function convertDocsDefinitionToDb({
           : undefined,
       navbarLinks: writeShape.config.navbarLinks,
       footerLinks: writeShape.config.footerLinks,
+      hideNavLinks: writeShape.config.hideNavLinks,
       title: writeShape.config.title,
       favicon: writeShape.config.favicon,
       backgroundImage: writeShape.config.backgroundImage,

packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts

@@ -29,6 +29,7 @@ export function convertDbDocsConfigToRead({
     colorsV3: dbShape.colorsV3 ?? getColorsV3(dbShape),
     navbarLinks: dbShape.navbarLinks,
     footerLinks: dbShape.footerLinks,
+    hideNavLinks: dbShape.hideNavLinks,
     title: dbShape.title,
     favicon: dbShape.favicon,
     typographyV2:

packages/fdr-sdk/src/navigation/NodeCollector.ts

@@ -2,6 +2,7 @@ import { EMPTY_ARRAY } from "@fern-api/ui-core-utils";
 import { once } from "es-toolkit/function";
 import { FernNavigation } from "./..";
 import { pruneVersionNode } from "./utils/pruneVersionNode";
+import { NavigationNodeWithMetadata } from "./versions";
 
 interface NavigationNodeWithMetadataAndParents {
   node: FernNavigation.NavigationNodeWithMetadata;
@@ -134,7 +135,6 @@ export class NodeCollector {
       this.#setNode(node.slug, node, parents);
     } else {
       if (FernNavigation.isPage(existing.node)) {
-        // eslint-disable-next-line no-console
         console.warn(`Duplicate slug found: ${node.slug}`, node.title);
       }
       this.orphanedNodes.push(node);
@@ -236,6 +236,29 @@ export class NodeCollector {
     return this.#getIndexablePageSlugs();
   }
 
+  #getIndexablePageNodesWithAuth = once((): NavigationNodeWithMetadata[] => {
+    const slugRecord: Record<string, NavigationNodeWithMetadata> = {};
+
+    [...this.slugToNode.values()]
+      .filter(({ node }) => FernNavigation.isPage(node))
+      .filter(({ node }) => !node.hidden)
+      .filter(({ node }) =>
+        FernNavigation.hasMarkdown(node) ? !node.noindex : true
+      )
+      .forEach((node) => {
+        const canonicalSlug = node.node.canonicalSlug ?? node.node.slug;
+        // Only keep the first node we see for each canonical slug
+        if (!(canonicalSlug in slugRecord)) {
+          slugRecord[canonicalSlug] = node.node;
+        }
+      });
+
+    return Object.values(slugRecord);
+  });
+  get indexablePageNodesWithAuth(): NavigationNodeWithMetadata[] {
+    return this.#getIndexablePageNodesWithAuth();
+  }
+
   public getVersionNodes = (): FernNavigation.VersionNode[] => {
     return this.versionNodes;
   };

packages/fern-docs/components/src/CopyToClipboardButton.tsx

@@ -40,7 +40,7 @@ export const CopyToClipboardButton: React.FC<CopyToClipboardButton.Props> = ({
           copyToClipboard?.();
         }) ?? (
           <FernButton
-            className={cn("fern-copy-button group", className)}
+            className={cn("fern-copy-button group backdrop-blur", className)}
             disabled={copyToClipboard == null}
             onClickCapture={(e) => {
               onClick?.(e);

packages/fern-docs/components/src/__test__/__snapshots__/CopyToClipboardButton.test.tsx.snap

@@ -3,7 +3,7 @@
 exports[`CopyToClipboardButton > renders correctly 1`] = `
 <button
   aria-disabled={false}
-  className="fern-copy-button group fern-button minimal normal rounded square"
+  className="fern-copy-button group backdrop-blur fern-button minimal normal rounded square"
   data-state="closed"
   data-testid="copy-btn"
   onBlur={[Function]}

packages/fern-docs/search-server/src/turbopuffer/records/create-turbopuffer-records.ts

@@ -5,7 +5,6 @@ import {
   RootNode,
   getPageId,
   hasMarkdown,
-  isPage,
 } from "@fern-api/fdr-sdk/navigation";
 import { flatten } from "es-toolkit/array";
 import { FernTurbopufferRecordWithoutVector } from "../types";
@@ -35,12 +34,7 @@ export async function createTurbopufferRecords({
 > {
   const collector = NodeCollector.collect(root);
 
-  const pageNodes = Array.from(collector.slugMap.values())
-    .filter(isPage)
-    // exclude hidden pages
-    .filter((node) => node.hidden !== true)
-    // exclude pages that are noindexed
-    .filter((node) => (hasMarkdown(node) ? node.noindex !== true : true));
+  const pageNodes = collector.indexablePageNodesWithAuth;
 
   const markdownNodes = pageNodes.filter(hasMarkdown);
   // const apiLeafNodes = pageNodes.filter(isApiLeaf);

packages/fern-docs/syntax-highlighter/src/CodeBlockWithClipboardButton.tsx

@@ -21,8 +21,8 @@ export const CodeBlockWithClipboardButton: React.FC<
       <CopyToClipboardButton
         className={cn(
           "absolute z-20",
-          "z-10 opacity-0 transition group-hover/cb-container:opacity-100",
-          "right-1 top-1"
+          "z-10 opacity-0 backdrop-blur transition group-hover/cb-container:opacity-100",
+          "right-3 top-2"
         )}
         content={code}
       />

packages/fern-docs/ui/src/search/SearchV2.tsx

@@ -91,7 +91,7 @@ export function SearchV2(): ReactElement | false {
 
   // Rerouting to ferndocs.com for production environments to ensure streaming works
   // Also see: next.config.mjs, where we set CORS headers
-  if (process.env.NODE_ENV === "production") {
+  if (process.env.NEXT_PUBLIC_VERCEL_ENV === "production") {
     chatEndpoint = `https://app.ferndocs.com/api/fern-docs/search/v2/chat`;
     suggestEndpoint = `https://app.ferndocs.com/api/fern-docs/search/v2/suggest`;
   }

packages/parsers/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fern-api/docs-parsers",
-  "version": "0.0.25",
+  "version": "0.0.34",
   "repository": {
     "type": "git",
     "url": "https://github.com/fern-api/fern-platform.git",

packages/parsers/src/index.ts

@@ -1,2 +1,3 @@
 export * from "./ErrorCollector";
 export * from "./openapi";
+export * from "./openrpc";

packages/parsers/src/openapi/3.1/OpenApiDocumentConverter.node.ts

@@ -10,6 +10,7 @@ import {
 import { coalesceServers } from "../utils/3.1/coalesceServers";
 import { SecurityRequirementObjectConverterNode } from "./auth/SecurityRequirementObjectConverter.node";
 import { XFernBasePathConverterNode } from "./extensions/XFernBasePathConverter.node";
+import { XFernGlobalHeadersConverterNode } from "./extensions/XFernGlobalHeadersConverter.node";
 import { XFernGroupsConverterNode } from "./extensions/XFernGroupsConverter.node";
 import { PathsObjectConverterNode } from "./paths/PathsObjectConverter.node";
 import { ServerObjectConverterNode } from "./paths/ServerObjectConverter.node";
@@ -29,6 +30,7 @@ export class OpenApiDocumentConverterNode extends BaseOpenApiV3_1ConverterNode<
   basePath: XFernBasePathConverterNode | undefined;
   fernGroups: XFernGroupsConverterNode | undefined;
   tags: TagObjectConverterNode[] | undefined;
+  globalHeaders: XFernGlobalHeadersConverterNode | undefined;
 
   constructor(
     args: BaseOpenApiV3_1ConverterNodeConstructorArgs<OpenAPIV3_1.Document>
@@ -128,6 +130,13 @@ export class OpenApiDocumentConverterNode extends BaseOpenApiV3_1ConverterNode<
         pathId: "components",
       });
     }
+
+    this.globalHeaders = new XFernGlobalHeadersConverterNode({
+      input: this.input,
+      context: this.context,
+      accessPath: this.accessPath,
+      pathId: "x-fern-global-headers",
+    });
   }
 
   convert(): FernRegistry.api.latest.ApiDefinition | undefined {
@@ -188,8 +197,7 @@ export class OpenApiDocumentConverterNode extends BaseOpenApiV3_1ConverterNode<
       // This is not necessary and will be removed
       subpackages,
       auths: this.auth?.convert() ?? {},
-      // TODO: Implement globalHeaders
-      globalHeaders: undefined,
+      globalHeaders: this.globalHeaders?.convert(),
     };
   }
 }

packages/parsers/src/openapi/3.1/auth/__test__/HeaderSecuritySchemeConverter.node.test.ts

@@ -1,4 +1,4 @@
-import { createMockContext } from "../../../../__test__/createMockContext.util";
+import { createMockContext } from "../../../__test__/createMockContext.util";
 import { HeaderSecuritySchemeConverterNode } from "../HeaderSecuritySchemeConverter.node";
 
 describe("HeaderSecuritySchemeConverterNode", () => {

packages/parsers/src/openapi/3.1/auth/__test__/OAuth2SecuritySchemeConverter.node.test.ts

@@ -1,5 +1,5 @@
 import { OpenAPIV3_1 } from "openapi-types";
-import { createMockContext } from "../../../../__test__/createMockContext.util";
+import { createMockContext } from "../../../__test__/createMockContext.util";
 import { OAuth2SecuritySchemeConverterNode } from "../OAuth2SecuritySchemeConverter.node";
 
 describe("OAuth2SecuritySchemeConverterNode", () => {

packages/parsers/src/openapi/3.1/auth/__test__/SecurityRequirementObjectConverter.node.test.ts

@@ -1,5 +1,5 @@
 import { OpenAPIV3_1 } from "openapi-types";
-import { createMockContext } from "../../../../__test__/createMockContext.util";
+import { createMockContext } from "../../../__test__/createMockContext.util";
 import { SecurityRequirementObjectConverterNode } from "../SecurityRequirementObjectConverter.node";
 
 describe("SecurityRequirementObjectConverterNode", () => {

packages/parsers/src/openapi/3.1/auth/__test__/SecuritySchemeConverter.node.test.ts

@@ -1,5 +1,5 @@
 import { OpenAPIV3_1 } from "openapi-types";
-import { createMockContext } from "../../../../__test__/createMockContext.util";
+import { createMockContext } from "../../../__test__/createMockContext.util";
 import { SecuritySchemeConverterNode } from "../SecuritySchemeConverter.node";
 
 describe("SecuritySchemeConverterNode", () => {