@fern-api/fdr-sdk 1.2.16-3b754a56be → 1.2.16-3bf669ca8e

package/dist/navigation/utils/createBreadcrumb.js

@@ -0,0 +1,59 @@
+import visitDiscriminatedUnion from "@fern-api/ui-core-utils/visitDiscriminatedUnion";
+import { noop } from "ts-essentials";
+import { FernNavigation } from "../..";
+export function createBreadcrumb(nodes) {
+    const breadcrumb = [];
+    nodes.forEach((node) => {
+        if (!FernNavigation.hasMetadata(node) || FernNavigation.isLeaf(node)) {
+            return;
+        }
+        visitDiscriminatedUnion(node)._visit({
+            root: noop,
+            version: noop,
+            variant: noop,
+            tab: noop,
+            product: noop,
+            section: (section) => {
+                breadcrumb.push({
+                    title: section.title,
+                    pointsTo: section.overviewPageId != null ? section.slug : section.pointsTo
+                });
+            },
+            apiReference: (apiReference) => {
+                if (!apiReference.hideTitle) {
+                    breadcrumb.push({
+                        title: apiReference.title,
+                        pointsTo: apiReference.overviewPageId != null ? apiReference.slug : apiReference.pointsTo
+                    });
+                }
+            },
+            changelog: (changelog) => {
+                breadcrumb.push({
+                    title: changelog.title,
+                    pointsTo: changelog.slug
+                });
+            },
+            changelogYear: (changelogYear) => {
+                breadcrumb.push({
+                    title: changelogYear.title,
+                    pointsTo: changelogYear.slug
+                });
+            },
+            changelogMonth: (changelogMonth) => {
+                breadcrumb.push({
+                    title: changelogMonth.title,
+                    pointsTo: changelogMonth.slug
+                });
+            },
+            apiPackage: (apiPackage) => {
+                breadcrumb.push({
+                    title: apiPackage.title,
+                    pointsTo: apiPackage.overviewPageId != null ? apiPackage.slug : apiPackage.pointsTo
+                });
+            }
+        });
+    });
+    // Remove breadcrumbs with empty titles
+    return breadcrumb.filter((item) => item.title.trim().length > 0);
+}
+//# sourceMappingURL=createBreadcrumb.js.map

package/dist/navigation/utils/createBreadcrumb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createBreadcrumb.js","sourceRoot":"","sources":["../../../src/navigation/utils/createBreadcrumb.ts"],"names":[],"mappings":"AAAA,OAAO,uBAAuB,MAAM,iDAAiD,CAAC;AACtF,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAEvC,MAAM,UAAU,gBAAgB,CAAC,KAA+C;IAC5E,MAAM,UAAU,GAAoC,EAAE,CAAC;IACvD,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACnB,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YACnE,OAAO;QACX,CAAC;QACD,uBAAuB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;YACjC,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,IAAI;YACb,GAAG,EAAE,IAAI;YACT,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE;gBACjB,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,QAAQ,EAAE,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ;iBAC7E,CAAC,CAAC;YACP,CAAC;YACD,YAAY,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,CAAC;oBAC1B,UAAU,CAAC,IAAI,CAAC;wBACZ,KAAK,EAAE,YAAY,CAAC,KAAK;wBACzB,QAAQ,EAAE,YAAY,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ;qBAC5F,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACrB,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,SAAS,CAAC,KAAK;oBACtB,QAAQ,EAAE,SAAS,CAAC,IAAI;iBAC3B,CAAC,CAAC;YACP,CAAC;YACD,aAAa,EAAE,CAAC,aAAa,EAAE,EAAE;gBAC7B,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,aAAa,CAAC,KAAK;oBAC1B,QAAQ,EAAE,aAAa,CAAC,IAAI;iBAC/B,CAAC,CAAC;YACP,CAAC;YACD,cAAc,EAAE,CAAC,cAAc,EAAE,EAAE;gBAC/B,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,cAAc,CAAC,KAAK;oBAC3B,QAAQ,EAAE,cAAc,CAAC,IAAI;iBAChC,CAAC,CAAC;YACP,CAAC;YACD,UAAU,EAAE,CAAC,UAAU,EAAE,EAAE;gBACvB,UAAU,CAAC,IAAI,CAAC;oBACZ,KAAK,EAAE,UAAU,CAAC,KAAK;oBACvB,QAAQ,EAAE,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ;iBACtF,CAAC,CAAC;YACP,CAAC;SACJ,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,uCAAuC;IACvC,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACrE,CAAC"}

package/dist/navigation/utils/deleteChild.d.ts

@@ -0,0 +1,9 @@
+import { FernNavigation } from "../..";
+import type { DeleterAction } from "../../utils/traversers/types";
+/**
+ * @param parent delete node from this parent (mutable)
+ * @param node node to delete
+ * @returns the id of the deleted node or null if the node was not deletable from the parent
+ */
+export declare function mutableDeleteChild(parent: FernNavigation.NavigationNodeParent | undefined, node: FernNavigation.NavigationNode): DeleterAction;
+//# sourceMappingURL=deleteChild.d.ts.map

package/dist/navigation/utils/deleteChild.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteChild.d.ts","sourceRoot":"","sources":["../../../src/navigation/utils/deleteChild.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAElE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,cAAc,CAAC,oBAAoB,GAAG,SAAS,EACvD,IAAI,EAAE,cAAc,CAAC,cAAc,GACpC,aAAa,CA2Gf"}

package/dist/navigation/utils/deleteChild.js

@@ -0,0 +1,111 @@
+import { UnreachableCaseError } from "ts-essentials";
+import { FernNavigation } from "../..";
+/**
+ * @param parent delete node from this parent (mutable)
+ * @param node node to delete
+ * @returns the id of the deleted node or null if the node was not deletable from the parent
+ */
+export function mutableDeleteChild(parent, node) {
+    /**
+     * The idea here is we should only delete leaf nodes (we're treating changelogs here like a leaf node)
+     *
+     * In the case that we have sections that have content, deleting it from its parent would delete all its children as well.
+     * Instead, we'll just remove the overviewPageId, which will make the section a non-visitable node, yet still retain its children.
+     */
+    if (!FernNavigation.isLeaf(node) &&
+        FernNavigation.isPage(node) &&
+        FernNavigation.getChildren(node).length > 0 &&
+        node.type !== "changelog") {
+        // if the node to be deleted is a section, remove the overviewPageId
+        if (FernNavigation.isSectionOverview(node)) {
+            node.overviewPageId = undefined;
+            if (node.children.length === 0) {
+                return "deleted";
+            }
+            return "noop";
+        }
+        else {
+            throw new UnreachableCaseError(node);
+        }
+    }
+    // if the node is not a leaf node, don't delete it from the parent unless it has no children
+    if (!FernNavigation.isLeaf(node) && FernNavigation.getChildren(node).length > 0) {
+        return "noop";
+    }
+    if (parent == null) {
+        return "deleted";
+    }
+    switch (parent.type) {
+        case "apiPackage":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "apiReference":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            parent.changelog = parent.changelog?.id === node.id ? undefined : parent.changelog;
+            break;
+        case "changelog":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "changelogYear":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "changelogMonth":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "endpointPair":
+            return "should-delete-parent";
+        case "productgroup":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            parent.landingPage = parent.landingPage?.id === node.id ? undefined : parent.landingPage;
+            break;
+        case "product":
+        case "productLink":
+        case "root":
+            return "should-delete-parent";
+        case "unversioned":
+            if (node.id === parent.landingPage?.id) {
+                parent.landingPage = undefined;
+            }
+            break;
+        case "section":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "sidebarGroup":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "tab":
+            return "should-delete-parent";
+        case "sidebarRoot":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "tabbed":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "version":
+            if (node.id === parent.landingPage?.id) {
+                parent.landingPage = undefined;
+            }
+            break;
+        case "versioned":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "varianted":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        case "variant":
+            parent.children = parent.children.filter((child) => child.id !== node.id);
+            break;
+        default:
+            throw new UnreachableCaseError(parent);
+    }
+    if (FernNavigation.isPage(parent)) {
+        return "noop";
+    }
+    else if (FernNavigation.getChildren(parent).length > 0) {
+        return "deleted";
+    }
+    else {
+        return "should-delete-parent";
+    }
+}
+//# sourceMappingURL=deleteChild.js.map

package/dist/navigation/utils/deleteChild.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteChild.js","sourceRoot":"","sources":["../../../src/navigation/utils/deleteChild.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAExE,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAGvC;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAC9B,MAAuD,EACvD,IAAmC;IAEnC;;;;;OAKG;IACH,IACI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC;QAC5B,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC;QAC3B,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC;QAC3C,IAAI,CAAC,IAAI,KAAK,WAAW,EAC3B,CAAC;QACC,oEAAoE;QACpE,IAAI,cAAc,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YACxC,IAAoD,CAAC,cAAc,GAAG,SAAS,CAAC;YAEjF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YACrB,CAAC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC;IACL,CAAC;IAED,4FAA4F;IAC5F,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC9E,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACjB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,YAAY;YACb,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,cAAc;YACf,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,SAAS,EAAE,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC;YACnF,MAAM;QACV,KAAK,WAAW;YACZ,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,eAAe;YAChB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,gBAAgB;YACjB,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,cAAc;YACf,OAAO,sBAAsB,CAAC;QAClC,KAAK,cAAc;YACf,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,EAAE,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC;YACzF,MAAM;QACV,KAAK,SAAS,CAAC;QACf,KAAK,aAAa,CAAC;QACnB,KAAK,MAAM;YACP,OAAO,sBAAsB,CAAC;QAClC,KAAK,aAAa;YACd,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC;gBACrC,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;YACnC,CAAC;YACD,MAAM;QACV,KAAK,SAAS;YACV,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,cAAc;YACf,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,KAAK;YACN,OAAO,sBAAsB,CAAC;QAClC,KAAK,aAAa;YACd,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,QAAQ;YACT,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,SAAS;YACV,IAAI,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,CAAC;gBACrC,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;YACnC,CAAC;YACD,MAAM;QACV,KAAK,WAAW;YACZ,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,WAAW;YACZ,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV,KAAK,SAAS;YACV,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1E,MAAM;QACV;YACI,MAAM,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,OAAO,MAAM,CAAC;IAClB,CAAC;SAAM,IAAI,cAAc,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvD,OAAO,SAAS,CAAC;IACrB,CAAC;SAAM,CAAC;QACJ,OAAO,sBAAsB,CAAC;IAClC,CAAC;AACL,CAAC"}

package/dist/navigation/utils/findNode.d.ts

@@ -0,0 +1,55 @@
+import { FernNavigation } from "../..";
+import { NodeCollector } from "../NodeCollector";
+export type Node = Node.Found | Node.Redirect | Node.NotFound;
+export declare namespace Node {
+    interface Found {
+        type: "found";
+        node: FernNavigation.NavigationNodePage;
+        parents: readonly FernNavigation.NavigationNodeParent[];
+        breadcrumb: readonly FernNavigation.BreadcrumbItem[];
+        root: FernNavigation.RootNode;
+        products: readonly FernNavigation.ProductNode[];
+        currentProduct: FernNavigation.ProductNode | undefined;
+        /**
+         * This is true if the current product is the default product node (without the product slug prefix)
+         */
+        isCurrentProductDefault: boolean;
+        versions: readonly FernNavigation.VersionNode[];
+        currentVersion: FernNavigation.VersionNode | undefined;
+        /**
+         * This is true if the current version is the default version node (without the version slug prefix)
+         */
+        isCurrentVersionDefault: boolean;
+        variants: readonly FernNavigation.VariantNode[];
+        currentVariant: FernNavigation.VariantNode | undefined;
+        /**
+         * This is true if the current variant is the default variant node (without the variant slug prefix)
+         */
+        isCurrentVariantDefault: boolean;
+        currentTab: FernNavigation.TabNode | FernNavigation.ChangelogNode | undefined;
+        tabs: readonly FernNavigation.TabChild[];
+        sidebar: FernNavigation.SidebarRootNode | undefined;
+        apiReference: FernNavigation.ApiReferenceNode | undefined;
+        next: FernNavigation.NavigationNodeNeighbor | undefined;
+        prev: FernNavigation.NavigationNodeNeighbor | undefined;
+        collector: NodeCollector;
+        landingPage: FernNavigation.LandingPageNode | undefined;
+        /**
+         * This is the part of the slug after the version (or basepath) prefix.
+         *
+         * For example, if the original slug is "docs/v1.0.0/foo/bar", the unversionedSlug is "foo/bar".
+         */
+        unversionedSlug: FernNavigation.Slug;
+    }
+    interface Redirect {
+        type: "redirect";
+        redirect: FernNavigation.Slug;
+    }
+    interface NotFound {
+        type: "notFound";
+        redirect: FernNavigation.Slug | undefined;
+        authed: boolean | undefined;
+    }
+}
+export declare function findNode(root: FernNavigation.RootNode, slug: FernNavigation.Slug): Node;
+//# sourceMappingURL=findNode.d.ts.map

package/dist/navigation/utils/findNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findNode.d.ts","sourceRoot":"","sources":["../../../src/navigation/utils/findNode.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAYjD,MAAM,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;AAE9D,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC1B,UAAU,KAAK;QACX,IAAI,EAAE,OAAO,CAAC;QACd,IAAI,EAAE,cAAc,CAAC,kBAAkB,CAAC;QACxC,OAAO,EAAE,SAAS,cAAc,CAAC,oBAAoB,EAAE,CAAC;QACxD,UAAU,EAAE,SAAS,cAAc,CAAC,cAAc,EAAE,CAAC;QACrD,IAAI,EAAE,cAAc,CAAC,QAAQ,CAAC;QAC9B,QAAQ,EAAE,SAAS,cAAc,CAAC,WAAW,EAAE,CAAC;QAChD,cAAc,EAAE,cAAc,CAAC,WAAW,GAAG,SAAS,CAAC;QACvD;;WAEG;QACH,uBAAuB,EAAE,OAAO,CAAC;QACjC,QAAQ,EAAE,SAAS,cAAc,CAAC,WAAW,EAAE,CAAC;QAChD,cAAc,EAAE,cAAc,CAAC,WAAW,GAAG,SAAS,CAAC;QACvD;;WAEG;QACH,uBAAuB,EAAE,OAAO,CAAC;QACjC,QAAQ,EAAE,SAAS,cAAc,CAAC,WAAW,EAAE,CAAC;QAChD,cAAc,EAAE,cAAc,CAAC,WAAW,GAAG,SAAS,CAAC;QACvD;;WAEG;QACH,uBAAuB,EAAE,OAAO,CAAC;QACjC,UAAU,EAAE,cAAc,CAAC,OAAO,GAAG,cAAc,CAAC,aAAa,GAAG,SAAS,CAAC;QAC9E,IAAI,EAAE,SAAS,cAAc,CAAC,QAAQ,EAAE,CAAC;QACzC,OAAO,EAAE,cAAc,CAAC,eAAe,GAAG,SAAS,CAAC;QACpD,YAAY,EAAE,cAAc,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAC1D,IAAI,EAAE,cAAc,CAAC,sBAAsB,GAAG,SAAS,CAAC;QACxD,IAAI,EAAE,cAAc,CAAC,sBAAsB,GAAG,SAAS,CAAC;QACxD,SAAS,EAAE,aAAa,CAAC;QACzB,WAAW,EAAE,cAAc,CAAC,eAAe,GAAG,SAAS,CAAC;QAExD;;;;WAIG;QACH,eAAe,EAAE,cAAc,CAAC,IAAI,CAAC;KACxC;IAED,UAAU,QAAQ;QACd,IAAI,EAAE,UAAU,CAAC;QACjB,QAAQ,EAAE,cAAc,CAAC,IAAI,CAAC;KACjC;IAED,UAAU,QAAQ;QACd,IAAI,EAAE,UAAU,CAAC;QACjB,QAAQ,EAAE,cAAc,CAAC,IAAI,GAAG,SAAS,CAAC;QAC1C,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC;KAC/B;CACJ;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC,QAAQ,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,GAAG,IAAI,CAgNvF"}

package/dist/navigation/utils/findNode.js

@@ -0,0 +1,209 @@
+import { escapeRegExp } from "es-toolkit/string";
+import { FernNavigation } from "../..";
+import { NodeCollector } from "../NodeCollector";
+import { isApiReferenceNode } from "../versions/latest/isApiReferenceNode";
+import { isProductGroupNode } from "../versions/latest/isProductGroupNode";
+import { isProductNode } from "../versions/latest/isProductNode";
+import { isSidebarRootNode } from "../versions/latest/isSidebarRootNode";
+import { isTabbedNode } from "../versions/latest/isTabbedNode";
+import { isUnversionedNode } from "../versions/latest/isUnversionedNode";
+import { isVariantNode } from "../versions/latest/isVariantNode";
+import { isVersionNode } from "../versions/latest/isVersionNode";
+import { canonicalSlugKey } from "./canonicalSlugKey";
+import { createBreadcrumb } from "./createBreadcrumb";
+export function findNode(root, slug) {
+    const collector = NodeCollector.collect(root);
+    const found = collector.getSlugMapWithParents().get(canonicalSlugKey(slug));
+    // if the slug points to a node that doesn't exist, we should redirect to the first likely node
+    if (found == null) {
+        let maybeProductOrVersionNode = root;
+        let foundProductNode = false;
+        // the 404 behavior should be product-aware
+        for (const productNode of collector.getProductNodes()) {
+            // External product links don't have slugs, so skip them
+            if (productNode.type === "product" && slug.startsWith(productNode.slug)) {
+                maybeProductOrVersionNode = productNode;
+                foundProductNode = true;
+                break;
+            }
+        }
+        // if we didn't find a product node, try to find a version node
+        if (!foundProductNode) {
+            // the 404 behavior should be version-aware
+            for (const versionNode of collector.getVersionNodes()) {
+                if (slug.startsWith(versionNode.slug)) {
+                    maybeProductOrVersionNode = versionNode;
+                    break;
+                }
+            }
+        }
+        // if we still haven't found a matching product or version, check if the slug matches
+        // the productgroup's landing page (only if no product matched to avoid collisions)
+        if (!foundProductNode && isProductGroupNode(root.child) && root.child.landingPage != null) {
+            const landingPageSlug = root.child.landingPage.slug;
+            if (slug === landingPageSlug) {
+                return { type: "redirect", redirect: landingPageSlug };
+            }
+        }
+        return {
+            type: "notFound",
+            // External product links don't have pointsTo, only internal products and versions do
+            redirect: maybeProductOrVersionNode.type === "root" ||
+                maybeProductOrVersionNode.type === "product" ||
+                maybeProductOrVersionNode.type === "version"
+                ? maybeProductOrVersionNode.pointsTo
+                : undefined,
+            authed: maybeProductOrVersionNode.authed
+        };
+    }
+    let sidebar = found.parents.find(isSidebarRootNode);
+    const currentProductGroup = found.parents.find(isProductGroupNode);
+    const currentProduct = found.parents.find(isProductNode);
+    const currentVersion = found.parents.find(isVersionNode);
+    const unversionedNode = found.parents.find(isUnversionedNode);
+    const versionChild = (currentVersion ?? unversionedNode)?.child;
+    const currentVariant = found.parents.find(isVariantNode);
+    if (!sidebar && currentVersion != null) {
+        if (isSidebarRootNode(currentVersion.child)) {
+            sidebar = currentVersion.child;
+        }
+    }
+    const landingPage = (currentProductGroup ?? currentVersion ?? unversionedNode)?.landingPage;
+    const tabbedNode = found.parents.find(isTabbedNode) ??
+        // fallback to the version child because the current node may be a landing page
+        (versionChild != null && isTabbedNode(versionChild) ? versionChild : undefined);
+    const apiReference = found.parents.find(isApiReferenceNode) ?? (found.node.type === "apiReference" ? found.node : undefined);
+    // if the node is visible (because it's a page), return it as "found"
+    if (FernNavigation.isPage(found.node)) {
+        const parentsAndNode = [...found.parents, found.node];
+        const tabbedNodeIndex = parentsAndNode.findIndex((node) => node === tabbedNode);
+        const currentTabNode = tabbedNodeIndex !== -1 ? parentsAndNode[tabbedNodeIndex + 1] : undefined;
+        const products = collector.getProductNodes().map((node) => {
+            if (node.default) {
+                // if we're currently viewing the default product, we may be viewing the non-pruned product node
+                if (node.id === currentProduct?.id) {
+                    return currentProduct;
+                }
+                // otherwise, we should always use the pruned product node
+                return collector.defaultProductNode ?? node;
+            }
+            return node;
+        });
+        const versions = collector.getVersionNodes().map((node) => {
+            if (node.default) {
+                // if we're currently viewing the default version, we may be viewing the non-pruned version
+                if (node.id === currentVersion?.id) {
+                    return currentVersion;
+                }
+                // otherwise, we should always use the pruned version node
+                return collector.defaultVersionNode ?? node;
+            }
+            return node;
+        });
+        const variants = collector.getVariantNodes().map((node) => {
+            if (node.default) {
+                // if we're currently viewing the default variant, we may be viewing the non-pruned variant
+                if (node.id === currentVariant?.id) {
+                    return currentVariant;
+                }
+                // otherwise, we should always use the pruned variant node
+                return collector.defaultVariantNode ?? node;
+            }
+            return node;
+        });
+        let currentTab = currentTabNode?.type === "tab" || currentTabNode?.type === "changelog" ? currentTabNode : undefined;
+        // If currentTab is undefined and we have tabs, try to find the appropriate tab
+        if (currentTab == null && tabbedNode != null) {
+            // First, check if any tab's pointsTo matches the current page's slug
+            for (const tab of tabbedNode.children) {
+                if (tab.type === "tab" && tab.pointsTo === found.node.slug) {
+                    currentTab = tab;
+                    break;
+                }
+                if (tab.type === "changelog" && tab.slug === found.node.slug) {
+                    currentTab = tab;
+                    break;
+                }
+            }
+            // If still no tab found and we're on a landing page, select the first tab
+            if (currentTab == null && found.node.type === "landingPage") {
+                const firstTab = tabbedNode.children.find((tab) => tab.type === "tab" || tab.type === "changelog");
+                if (firstTab != null && (firstTab.type === "tab" || firstTab.type === "changelog")) {
+                    currentTab = firstTab;
+                }
+            }
+        }
+        // External product links don't have slugs, so fall back to version or root slug
+        const slugPrefix = currentVariant?.slug ??
+            (currentProduct?.type === "product" ? currentProduct.slug : undefined) ??
+            currentVersion?.slug ??
+            root.slug;
+        const unversionedSlug = FernNavigation.Slug(found.node.slug.replace(new RegExp(`^${escapeRegExp(slugPrefix)}/`), ""));
+        return {
+            type: "found",
+            node: found.node,
+            breadcrumb: createBreadcrumb(found.parents),
+            parents: found.parents,
+            root,
+            versions, // this is used to render the version switcher
+            tabs: tabbedNode?.children ?? [],
+            products,
+            currentProduct,
+            currentVersion,
+            isCurrentProductDefault: currentProduct?.default ? currentProduct === collector.defaultProductNode : false,
+            isCurrentVersionDefault: currentVersion?.default ? currentVersion === collector.defaultVersionNode : false,
+            variants, // this is used to render the variant switcher
+            currentVariant,
+            isCurrentVariantDefault: currentVariant?.default ? currentVariant === collector.defaultVariantNode : false,
+            currentTab,
+            sidebar,
+            apiReference,
+            landingPage,
+            next: found.next,
+            prev: found.prev,
+            collector,
+            unversionedSlug
+        };
+    }
+    // if the slug points matches the root node, redirect to the root node's pointsTo
+    if (root.type === "root" && root.slug === slug && root.pointsTo != null) {
+        return { type: "redirect", redirect: root.pointsTo };
+    }
+    // if the node has a redirect, return it
+    if (FernNavigation.hasRedirect(found.node) && found.node.pointsTo != null) {
+        return { type: "redirect", redirect: found.node.pointsTo };
+    }
+    // Special handling for variant nodes without pointsTo - find the first page in their children
+    if (found.node.type === "variant" && (found.node.pointsTo == null || found.node.pointsTo === undefined)) {
+        const firstPage = findFirstPageInNode(found.node);
+        if (firstPage != null) {
+            return { type: "redirect", redirect: firstPage };
+        }
+    }
+    // if the node does not have a redirect, return a 404
+    return {
+        type: "notFound",
+        redirect: currentVersion?.pointsTo ?? root.pointsTo,
+        authed: found.node.authed
+    };
+}
+/**
+ * Recursively searches for the first page node within a given node's children
+ */
+function findFirstPageInNode(node) {
+    if (FernNavigation.isPage(node)) {
+        return node.slug;
+    }
+    const children = FernNavigation.getChildren(node);
+    if (children == null) {
+        return undefined;
+    }
+    for (const child of children) {
+        const firstPage = findFirstPageInNode(child);
+        if (firstPage != null) {
+            return firstPage;
+        }
+    }
+    return undefined;
+}
+//# sourceMappingURL=findNode.js.map

package/dist/navigation/utils/findNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findNode.js","sourceRoot":"","sources":["../../../src/navigation/utils/findNode.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAC3E,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AA0DtD,MAAM,UAAU,QAAQ,CAAC,IAA6B,EAAE,IAAyB;IAC7E,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,MAAM,KAAK,GAAG,SAAS,CAAC,qBAAqB,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC;IAE5E,+FAA+F;IAC/F,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAChB,IAAI,yBAAyB,GAGM,IAAI,CAAC;QACxC,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,2CAA2C;QAC3C,KAAK,MAAM,WAAW,IAAI,SAAS,CAAC,eAAe,EAAE,EAAE,CAAC;YACpD,wDAAwD;YACxD,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtE,yBAAyB,GAAG,WAAW,CAAC;gBACxC,gBAAgB,GAAG,IAAI,CAAC;gBACxB,MAAM;YACV,CAAC;QACL,CAAC;QAED,+DAA+D;QAC/D,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACpB,2CAA2C;YAC3C,KAAK,MAAM,WAAW,IAAI,SAAS,CAAC,eAAe,EAAE,EAAE,CAAC;gBACpD,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;oBACpC,yBAAyB,GAAG,WAAW,CAAC;oBACxC,MAAM;gBACV,CAAC;YACL,CAAC;QACL,CAAC;QAED,qFAAqF;QACrF,mFAAmF;QACnF,IAAI,CAAC,gBAAgB,IAAI,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,IAAI,EAAE,CAAC;YACxF,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC;YACpD,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;gBAC3B,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC;YAC3D,CAAC;QACL,CAAC;QAED,OAAO;YACH,IAAI,EAAE,UAAU;YAChB,qFAAqF;YACrF,QAAQ,EACJ,yBAAyB,CAAC,IAAI,KAAK,MAAM;gBACzC,yBAAyB,CAAC,IAAI,KAAK,SAAS;gBAC5C,yBAAyB,CAAC,IAAI,KAAK,SAAS;gBACxC,CAAC,CAAC,yBAAyB,CAAC,QAAQ;gBACpC,CAAC,CAAC,SAAS;YACnB,MAAM,EAAE,yBAAyB,CAAC,MAAM;SAC3C,CAAC;IACN,CAAC;IAED,IAAI,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACpD,MAAM,mBAAmB,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;IACnE,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAEzD,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACzD,MAAM,eAAe,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC9D,MAAM,YAAY,GAAG,CAAC,cAAc,IAAI,eAAe,CAAC,EAAE,KAAK,CAAC;IAEhE,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAEzD,IAAI,CAAC,OAAO,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;QACrC,IAAI,iBAAiB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1C,OAAO,GAAG,cAAc,CAAC,KAAK,CAAC;QACnC,CAAC;IACL,CAAC;IAED,MAAM,WAAW,GAAG,CAAC,mBAAmB,IAAI,cAAc,IAAI,eAAe,CAAC,EAAE,WAAW,CAAC;IAE5F,MAAM,UAAU,GACZ,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC;QAChC,+EAA+E;QAC/E,CAAC,YAAY,IAAI,IAAI,IAAI,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAEpF,MAAM,YAAY,GACd,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAE5G,qEAAqE;IACrE,IAAI,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QACpC,MAAM,cAAc,GAAG,CAAC,GAAG,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACtD,MAAM,eAAe,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;QAChF,MAAM,cAAc,GAAG,eAAe,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEhG,MAAM,QAAQ,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACtD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,gGAAgG;gBAChG,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,EAAE,EAAE,EAAE,CAAC;oBACjC,OAAO,cAAc,CAAC;gBAC1B,CAAC;gBACD,0DAA0D;gBAC1D,OAAO,SAAS,CAAC,kBAAkB,IAAI,IAAI,CAAC;YAChD,CAAC;YACD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACtD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,2FAA2F;gBAC3F,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,EAAE,EAAE,EAAE,CAAC;oBACjC,OAAO,cAAc,CAAC;gBAC1B,CAAC;gBACD,0DAA0D;gBAC1D,OAAO,SAAS,CAAC,kBAAkB,IAAI,IAAI,CAAC;YAChD,CAAC;YACD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,SAAS,CAAC,eAAe,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACtD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,2FAA2F;gBAC3F,IAAI,IAAI,CAAC,EAAE,KAAK,cAAc,EAAE,EAAE,EAAE,CAAC;oBACjC,OAAO,cAAc,CAAC;gBAC1B,CAAC;gBACD,0DAA0D;gBAC1D,OAAO,SAAS,CAAC,kBAAkB,IAAI,IAAI,CAAC;YAChD,CAAC;YACD,OAAO,IAAI,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,IAAI,UAAU,GACV,cAAc,EAAE,IAAI,KAAK,KAAK,IAAI,cAAc,EAAE,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;QAExG,+EAA+E;QAC/E,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YAC3C,qEAAqE;YACrE,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,QAAQ,EAAE,CAAC;gBACpC,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACzD,UAAU,GAAG,GAAG,CAAC;oBACjB,MAAM;gBACV,CAAC;gBACD,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,IAAI,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBAC3D,UAAU,GAAG,GAAG,CAAC;oBACjB,MAAM;gBACV,CAAC;YACL,CAAC;YAED,0EAA0E;YAC1E,IAAI,UAAU,IAAI,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBAC1D,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,IAAI,GAAG,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;gBACnG,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,IAAI,QAAQ,CAAC,IAAI,KAAK,WAAW,CAAC,EAAE,CAAC;oBACjF,UAAU,GAAG,QAAQ,CAAC;gBAC1B,CAAC;YACL,CAAC;QACL,CAAC;QACD,gFAAgF;QAChF,MAAM,UAAU,GACZ,cAAc,EAAE,IAAI;YACpB,CAAC,cAAc,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YACtE,cAAc,EAAE,IAAI;YACpB,IAAI,CAAC,IAAI,CAAC;QACd,MAAM,eAAe,GAAG,cAAc,CAAC,IAAI,CACvC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAC3E,CAAC;QACF,OAAO;YACH,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,UAAU,EAAE,gBAAgB,CAAC,KAAK,CAAC,OAAO,CAAC;YAC3C,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,IAAI;YACJ,QAAQ,EAAE,8CAA8C;YACxD,IAAI,EAAE,UAAU,EAAE,QAAQ,IAAI,EAAE;YAChC,QAAQ;YACR,cAAc;YACd,cAAc;YACd,uBAAuB,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,cAAc,KAAK,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC,KAAK;YAC1G,uBAAuB,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,cAAc,KAAK,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC,KAAK;YAC1G,QAAQ,EAAE,8CAA8C;YACxD,cAAc;YACd,uBAAuB,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,cAAc,KAAK,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAC,KAAK;YAC1G,UAAU;YACV,OAAO;YACP,YAAY;YACZ,WAAW;YACX,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,SAAS;YACT,eAAe;SAClB,CAAC;IACN,CAAC;IAED,iFAAiF;IACjF,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QACtE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzD,CAAC;IAED,wCAAwC;IACxC,IAAI,cAAc,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QACxE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC/D,CAAC;IAED,8FAA8F;IAC9F,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,SAAS,CAAC,EAAE,CAAC;QACtG,MAAM,SAAS,GAAG,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;QACrD,CAAC;IACL,CAAC;IAED,qDAAqD;IACrD,OAAO;QACH,IAAI,EAAE,UAAU;QAChB,QAAQ,EAAE,cAAc,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ;QACnD,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM;KAC5B,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAC,IAAmC;IAC5D,IAAI,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9B,OAAQ,IAAY,CAAC,IAAI,CAAC;IAC9B,CAAC;IAED,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAClD,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;QACnB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC3B,MAAM,SAAS,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACrB,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC"}

package/dist/navigation/utils/followRedirect.d.ts

@@ -0,0 +1,4 @@
+import { FernNavigation } from "../..";
+export declare function followRedirect(nodeToFollow: FernNavigation.NavigationNode | undefined): FernNavigation.Slug | undefined;
+export declare function followRedirects(nodes: readonly FernNavigation.NavigationNode[]): FernNavigation.Slug | undefined;
+//# sourceMappingURL=followRedirect.d.ts.map

package/dist/navigation/utils/followRedirect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"followRedirect.d.ts","sourceRoot":"","sources":["../../../src/navigation/utils/followRedirect.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAEvC,wBAAgB,cAAc,CAC1B,YAAY,EAAE,cAAc,CAAC,cAAc,GAAG,SAAS,GACxD,cAAc,CAAC,IAAI,GAAG,SAAS,CA6CjC;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,cAAc,CAAC,cAAc,EAAE,GAAG,cAAc,CAAC,IAAI,GAAG,SAAS,CAahH"}

package/dist/navigation/utils/followRedirect.js

@@ -0,0 +1,65 @@
+import { UnreachableCaseError } from "ts-essentials";
+import { FernNavigation } from "../..";
+export function followRedirect(nodeToFollow) {
+    if (nodeToFollow == null) {
+        return undefined;
+    }
+    // skip authed pages (but do not skip authed edge nodes, since we want to follow redirects to unauthed children)
+    // TODO: the `authed: boolean` logic here is a bit convoluted and will cause confusion. We should revisit this.
+    if (FernNavigation.isPage(nodeToFollow) && !nodeToFollow.authed) {
+        return nodeToFollow.slug;
+    }
+    // skip other leaf nodes that were not returned above
+    if (FernNavigation.isLeaf(nodeToFollow)) {
+        return undefined;
+    }
+    switch (nodeToFollow.type) {
+        /**
+         * Versioned and ProductGroup nodes are special in that they have a default child.
+         */
+        case "productgroup":
+        case "versioned":
+            return followRedirects([...nodeToFollow.children].sort(defaultFirst));
+        case "apiReference":
+        case "apiPackage":
+        case "changelogMonth": // note: changelog month nodes don't exist yet as pages
+        case "changelogYear": // note: changelog month nodes don't exist yet as pages
+        case "endpointPair":
+        case "product":
+        case "productLink":
+        case "root":
+        case "section":
+        case "sidebarRoot":
+        case "sidebarGroup":
+        case "tab":
+        case "tabbed":
+        case "unversioned":
+        case "version":
+        case "changelog":
+        case "varianted":
+        case "variant":
+            return followRedirects(FernNavigation.getChildren(nodeToFollow));
+        default:
+            throw new UnreachableCaseError(nodeToFollow);
+    }
+}
+export function followRedirects(nodes) {
+    for (const node of nodes) {
+        // skip hidden nodes
+        if (FernNavigation.hasMetadata(node) && node.hidden) {
+            continue;
+        }
+        const redirect = followRedirect(node);
+        if (redirect != null) {
+            return redirect;
+        }
+    }
+    return;
+}
+function rank(node) {
+    return node.default && !node.hidden ? 1 : node.hidden ? -1 : 0;
+}
+function defaultFirst(a, b) {
+    return rank(b) - rank(a);
+}
+//# sourceMappingURL=followRedirect.js.map

package/dist/navigation/utils/followRedirect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"followRedirect.js","sourceRoot":"","sources":["../../../src/navigation/utils/followRedirect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAErD,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAEvC,MAAM,UAAU,cAAc,CAC1B,YAAuD;IAEvD,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,gHAAgH;IAChH,+GAA+G;IAC/G,IAAI,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAC9D,OAAO,YAAY,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,qDAAqD;IACrD,IAAI,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,QAAQ,YAAY,CAAC,IAAI,EAAE,CAAC;QACxB;;WAEG;QACH,KAAK,cAAc,CAAC;QACpB,KAAK,WAAW;YACZ,OAAO,eAAe,CAAC,CAAC,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;QAC1E,KAAK,cAAc,CAAC;QACpB,KAAK,YAAY,CAAC;QAClB,KAAK,gBAAgB,CAAC,CAAC,uDAAuD;QAC9E,KAAK,eAAe,CAAC,CAAC,uDAAuD;QAC7E,KAAK,cAAc,CAAC;QACpB,KAAK,SAAS,CAAC;QACf,KAAK,aAAa,CAAC;QACnB,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS,CAAC;QACf,KAAK,aAAa,CAAC;QACnB,KAAK,cAAc,CAAC;QACpB,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ,CAAC;QACd,KAAK,aAAa,CAAC;QACnB,KAAK,SAAS,CAAC;QACf,KAAK,WAAW,CAAC;QACjB,KAAK,WAAW,CAAC;QACjB,KAAK,SAAS;YACV,OAAO,eAAe,CAAC,cAAc,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC;QACrE;YACI,MAAM,IAAI,oBAAoB,CAAC,YAAY,CAAC,CAAC;IACrD,CAAC;AACL,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAA+C;IAC3E,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,oBAAoB;QACpB,IAAI,cAAc,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAClD,SAAS;QACb,CAAC;QAED,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACnB,OAAO,QAAQ,CAAC;QACpB,CAAC;IACL,CAAC;IACD,OAAO;AACX,CAAC;AAED,SAAS,IAAI,CAA8D,IAAO;IAC9E,OAAO,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,YAAY,CAA8D,CAAI,EAAE,CAAI;IACzF,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;AAC7B,CAAC"}

package/dist/navigation/utils/getApiReferenceId.d.ts

@@ -0,0 +1,3 @@
+import type { FernNavigation } from "../..";
+export declare function getApiReferenceId(node: FernNavigation.NavigationNode | undefined): FernNavigation.ApiDefinitionId | undefined;
+//# sourceMappingURL=getApiReferenceId.d.ts.map

package/dist/navigation/utils/getApiReferenceId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApiReferenceId.d.ts","sourceRoot":"","sources":["../../../src/navigation/utils/getApiReferenceId.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AAK5C,wBAAgB,iBAAiB,CAC7B,IAAI,EAAE,cAAc,CAAC,cAAc,GAAG,SAAS,GAChD,cAAc,CAAC,eAAe,GAAG,SAAS,CAqC5C"}

package/dist/navigation/utils/getApiReferenceId.js

@@ -0,0 +1,41 @@
+import visitDiscriminatedUnion from "@fern-api/ui-core-utils/visitDiscriminatedUnion";
+const RETURN_UNDEFINED = () => undefined;
+const RETURN_API_DEFINITION_ID = (node) => node.apiDefinitionId;
+export function getApiReferenceId(node) {
+    if (node == null) {
+        return undefined;
+    }
+    return visitDiscriminatedUnion(node)._visit({
+        root: RETURN_UNDEFINED,
+        versioned: RETURN_UNDEFINED,
+        varianted: RETURN_UNDEFINED,
+        tabbed: RETURN_UNDEFINED,
+        sidebarRoot: RETURN_UNDEFINED,
+        sidebarGroup: RETURN_UNDEFINED,
+        version: RETURN_UNDEFINED,
+        variant: RETURN_UNDEFINED,
+        tab: RETURN_UNDEFINED,
+        link: RETURN_UNDEFINED,
+        page: RETURN_UNDEFINED,
+        section: RETURN_UNDEFINED,
+        changelog: RETURN_UNDEFINED,
+        changelogYear: RETURN_UNDEFINED,
+        changelogMonth: RETURN_UNDEFINED,
+        changelogEntry: RETURN_UNDEFINED,
+        product: RETURN_UNDEFINED,
+        productLink: RETURN_UNDEFINED,
+        productgroup: RETURN_UNDEFINED,
+        // api nodes
+        apiReference: RETURN_API_DEFINITION_ID,
+        endpoint: RETURN_API_DEFINITION_ID,
+        endpointPair: (node) => node.nonStream.apiDefinitionId,
+        webSocket: RETURN_API_DEFINITION_ID,
+        webhook: RETURN_API_DEFINITION_ID,
+        grpc: RETURN_API_DEFINITION_ID,
+        graphql: RETURN_API_DEFINITION_ID,
+        apiPackage: RETURN_API_DEFINITION_ID,
+        unversioned: RETURN_UNDEFINED,
+        landingPage: RETURN_UNDEFINED
+    });
+}
+//# sourceMappingURL=getApiReferenceId.js.map

package/dist/navigation/utils/getApiReferenceId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getApiReferenceId.js","sourceRoot":"","sources":["../../../src/navigation/utils/getApiReferenceId.ts"],"names":[],"mappings":"AAAA,OAAO,uBAAuB,MAAM,iDAAiD,CAAC;AAItF,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,SAAS,CAAC;AACzC,MAAM,wBAAwB,GAAG,CAAC,IAAwC,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC;AAEpG,MAAM,UAAU,iBAAiB,CAC7B,IAA+C;IAE/C,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;QACf,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,uBAAuB,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;QACxC,IAAI,EAAE,gBAAgB;QACtB,SAAS,EAAE,gBAAgB;QAC3B,SAAS,EAAE,gBAAgB;QAC3B,MAAM,EAAE,gBAAgB;QACxB,WAAW,EAAE,gBAAgB;QAC7B,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,gBAAgB;QACzB,OAAO,EAAE,gBAAgB;QACzB,GAAG,EAAE,gBAAgB;QACrB,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,gBAAgB;QACtB,OAAO,EAAE,gBAAgB;QACzB,SAAS,EAAE,gBAAgB;QAC3B,aAAa,EAAE,gBAAgB;QAC/B,cAAc,EAAE,gBAAgB;QAChC,cAAc,EAAE,gBAAgB;QAChC,OAAO,EAAE,gBAAgB;QACzB,WAAW,EAAE,gBAAgB;QAC7B,YAAY,EAAE,gBAAgB;QAE9B,YAAY;QACZ,YAAY,EAAE,wBAAwB;QACtC,QAAQ,EAAE,wBAAwB;QAClC,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe;QACtD,SAAS,EAAE,wBAAwB;QACnC,OAAO,EAAE,wBAAwB;QACjC,IAAI,EAAE,wBAAwB;QAC9B,OAAO,EAAE,wBAAwB;QACjC,UAAU,EAAE,wBAAwB;QACpC,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,gBAAgB;KAChC,CAAC,CAAC;AACP,CAAC"}

package/dist/navigation/utils/getFrontmatter.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The use of gray-matter package is not allowed in edge-side code, because it uses `eval` internally.
+ * https://github.com/jonschlinkert/gray-matter/blob/ce67a86dba419381db0dd01cc84e2d30a1d1e6a5/lib/engines.js#L43
+ */
+export declare function getFrontmatter(markdown: string): string | undefined;
+//# sourceMappingURL=getFrontmatter.d.ts.map

package/dist/navigation/utils/getFrontmatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFrontmatter.d.ts","sourceRoot":"","sources":["../../../src/navigation/utils/getFrontmatter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAMnE"}