@fern-api/fdr-sdk 1.2.39-4ae10c3282 → 1.2.39-4e8e68c5b4

package/dist/js/navigation/ledger-root-builder.mjs

@@ -805,6 +805,14 @@ function traverseDF(node, visit) {
 }
 
 // src/navigation/ledger-root-builder.ts
+var STRUCTURAL_SEGMENT_TYPES = /* @__PURE__ */ new Set([
+  "section",
+  "apiReference",
+  "apiPackage",
+  "changelog"
+]);
+var API_NODE_SEGMENT_TYPES = /* @__PURE__ */ new Set(["apiReference", "apiPackage"]);
+var INFRA_SEGMENT_TYPES = /* @__PURE__ */ new Set(["files", "redirects"]);
 function createBuildContext(basePath) {
   const seen = /* @__PURE__ */ new Map();
   const basePrefix = basePath.replace(/^\/+|\/+$/g, "");
@@ -882,7 +890,7 @@ function toViewers(viewers) {
   return viewers.map((v) => RoleId(v));
 }
 function mergeVariantViewers(seg) {
-  const segViewers = seg.metadata.type === "section" || seg.metadata.type === "apiReference" || seg.metadata.type === "apiPackage" || seg.metadata.type === "changelog" ? seg.metadata.viewers : void 0;
+  const segViewers = STRUCTURAL_SEGMENT_TYPES.has(seg.metadata.type) ? seg.metadata.viewers : void 0;
   const variantViewers = seg.variant?.viewers;
   if ((segViewers == null || segViewers.length === 0) && (variantViewers == null || variantViewers.length === 0)) {
     return void 0;
@@ -1082,6 +1090,63 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
   }
   return void 0;
 }
+function apiLeafPositionKey(node) {
+  switch (node.type) {
+    case "endpoint":
+      return `endpoint:${node.endpointId}`;
+    case "webhook":
+      return `webhook:${node.webhookId}`;
+    case "webSocket":
+      return `webSocket:${node.webSocketId}`;
+    case "grpc":
+      return `grpc:${node.grpcId}`;
+    case "graphql":
+      return `graphql:${node.graphqlOperationId}`;
+  }
+}
+function apiChildPositionKey(node) {
+  switch (node.type) {
+    case "endpoint":
+    case "webhook":
+    case "webSocket":
+    case "grpc":
+    case "graphql":
+      return apiLeafPositionKey(node);
+    default:
+      return void 0;
+  }
+}
+function positionedApiLeafChildren(ctx, nav, apiDefinitionId) {
+  const rawLeafNodes = [];
+  const leafPositions = /* @__PURE__ */ new Map();
+  const nonApiLeafNodes = [];
+  for (let i = 0; i < nav.length; i++) {
+    const route = nav[i];
+    const pos = route.displaySortOrder ?? i;
+    const apiLeaf = apiLeafNodeFromNavRouteInternal(ctx, route, apiDefinitionId);
+    if (apiLeaf != null) {
+      rawLeafNodes.push(apiLeaf);
+      const key = apiLeafPositionKey(apiLeaf);
+      leafPositions.set(key, Math.min(leafPositions.get(key) ?? pos, pos));
+      continue;
+    }
+    const node = artifactToNode(ctx, route);
+    if (node?.type === "page" || node?.type === "link") {
+      nonApiLeafNodes.push({ node, pos });
+    }
+  }
+  const apiLeafNodes = mergeEndpointPairs(ctx, rawLeafNodes, nav);
+  const positionedApiLeafNodes = apiLeafNodes.map((node, index) => {
+    if (node.type === "endpointPair") {
+      const streamPos = leafPositions.get(apiLeafPositionKey(node.stream)) ?? index;
+      const nonStreamPos = leafPositions.get(apiLeafPositionKey(node.nonStream)) ?? index;
+      return { node, pos: Math.min(streamPos, nonStreamPos) };
+    }
+    const key = apiChildPositionKey(node);
+    return { node, pos: key != null ? leafPositions.get(key) ?? index : index };
+  });
+  return [...positionedApiLeafNodes, ...nonApiLeafNodes];
+}
 function collectApiLeafNodesFromNav(routes, basePath, segmentApiDefinitionId2) {
   const ctx = createBuildContext(basePath);
   return routes.map((route) => apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2)).filter((node) => node != null);
@@ -1191,12 +1256,10 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
   return {
     type: "section",
     ...defaults,
-    // V2 convention: collapsed:false in docs.yml maps to "open-by-default"
-    // so getInitiallyOpenByDefaultNodes picks it up and the UI starts open.
-    collapsed: metaCollapsed(seg.metadata) === false ? "open-by-default" : metaCollapsed(seg.metadata) ?? defaults.collapsed,
+    collapsed: metaCollapsed(seg.metadata) ?? defaults.collapsed,
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
     noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
-    collapsible: metaBool(seg.metadata, "collapsible") ?? (metaCollapsed(seg.metadata) != null ? true : void 0),
+    collapsible: metaBool(seg.metadata, "collapsible") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
     collapsedByDefault: metaBool(seg.metadata, "collapsedByDefault") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
     availability: metaStr(seg.metadata, "availability"),
     pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
@@ -1221,8 +1284,7 @@ function directChildApiPackages(parentSection, scopeSegs) {
 }
 function buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix) {
   const { seg, nav } = scoped;
-  const rawLeafNodes = nav.map((route) => apiLeafNodeFromNavRouteInternal(ctx, route, apiDefinitionId)).filter((node) => node != null);
-  const leafNodes = mergeEndpointPairs(ctx, rawLeafNodes, nav);
+  const leafNodes = positionedApiLeafChildren(ctx, nav, apiDefinitionId);
   const childPackages = directChildApiPackages(seg.section, scopeSegs);
   const packageNodes = childPackages.map((child) => ({
     node: apiPackageChildNode(
@@ -1236,18 +1298,10 @@ function buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix)
   }));
   const hasChildIndex = packageNodes.some((p) => p.childIndex != null);
   if (!hasChildIndex) {
-    return [...leafNodes, ...packageNodes.map((p) => p.node)];
-  }
-  const leafPositions = [];
-  for (const route of nav) {
-    if (route.displaySortOrder != null) {
-      leafPositions.push(route.displaySortOrder);
-    }
+    return [...leafNodes, ...packageNodes.map((p) => ({ node: p.node, pos: Number.MAX_SAFE_INTEGER }))].sort((a, b) => a.pos - b.pos).map((p) => p.node);
   }
   const positioned = [];
-  for (let i = 0; i < leafNodes.length; i++) {
-    positioned.push({ node: leafNodes[i], pos: leafPositions[i] ?? i });
-  }
+  positioned.push(...leafNodes);
   for (const p of packageNodes) {
     positioned.push({ node: p.node, pos: p.childIndex ?? Number.MAX_SAFE_INTEGER });
   }
@@ -1432,7 +1486,7 @@ function changelogNode(ctx, scoped, scopePrefix) {
       pageId: PageId(metaStr(r.metadata, "pageId") ?? ""),
       noindex: metaBool(r.metadata, "noindex"),
       date: dateStr ?? "",
-      tags: void 0
+      tags: metaStrArr(r.metadata, "tags")
     };
     let months = byYear.get(year);
     if (months == null) {
@@ -1524,7 +1578,7 @@ function buildSectionTree(ctx, scopeSegs, parentPath, scopePrefix, changelogScop
     const type = metaStr(s.seg.metadata, "type");
     const childIndex = metaNum(s.seg.metadata, "childIndex");
     let node;
-    if (type === "apiReference" || type === "apiPackage") {
+    if (API_NODE_SEGMENT_TYPES.has(type ?? "")) {
       node = apiReferenceNode(ctx, s, scopeSegs, scopePrefix);
     } else if (type === "changelog") {
       node = changelogNode(ctx, s, changelogScopePrefix ?? scopePrefix);
@@ -1539,18 +1593,56 @@ function buildSectionTree(ctx, scopeSegs, parentPath, scopePrefix, changelogScop
     return { node, childIndex };
   });
 }
+function computeSiblingSortBoundaries(ordered) {
+  const result = /* @__PURE__ */ new Map();
+  const sectionPaths = new Set(ordered.map((s) => s.seg.section));
+  const rootSections = [];
+  for (const s of ordered) {
+    const type = metaStr(s.seg.metadata, "type");
+    const sec = s.seg.section;
+    if (type !== "section" || sec === "") {
+      continue;
+    }
+    const parent = parentSectionPath(sec);
+    const isRootLevel = parent === "" || !sectionPaths.has(parent) && nearestExistingAncestor(sec, sectionPaths) === "";
+    if (isRootLevel) {
+      rootSections.push(s);
+    }
+  }
+  const byPath = /* @__PURE__ */ new Map();
+  for (const s of rootSections) {
+    const group = byPath.get(s.seg.section) ?? [];
+    group.push(s);
+    byPath.set(s.seg.section, group);
+  }
+  for (const [, siblings] of byPath) {
+    if (siblings.length <= 1) {
+      continue;
+    }
+    for (let i = 0; i < siblings.length; i++) {
+      const lo = siblings[i].seg.sortOrder;
+      const hi = i + 1 < siblings.length ? siblings[i + 1].seg.sortOrder : Number.MAX_SAFE_INTEGER;
+      result.set(siblings[i], { lo, hi });
+    }
+  }
+  return result;
+}
 function buildSidebarRootChildren(ctx, scopeSegs, scopePrefix, changelogScopePrefix) {
   const ordered = [...scopeSegs].sort((a, b) => a.seg.sortOrder - b.seg.sortOrder);
   const sectionPaths = new Set(ordered.map((s) => s.seg.section));
   const annotated = [];
   const hasRootSection = ordered.some((s) => metaStr(s.seg.metadata, "type") === "section" && s.seg.section === "");
+  const siblingBoundaries = computeSiblingSortBoundaries(ordered);
   for (const s of ordered) {
     const type = metaStr(s.seg.metadata, "type");
     const sec = s.seg.section;
     if (hasOwningApiReference(s, scopeSegs)) {
       continue;
     }
-    if (type === "tabRoot" || sec === "" && type !== "section") {
+    if (type === "tabRoot" && metaBool(s.seg.metadata, "landingPage") === true) {
+      continue;
+    }
+    if (type === "tabRoot" || sec === "" && !STRUCTURAL_SEGMENT_TYPES.has(type ?? "")) {
       for (const r of s.nav) {
         const node = artifactToNode(ctx, r);
         if (node != null) {
@@ -1567,24 +1659,31 @@ function buildSidebarRootChildren(ctx, scopeSegs, scopePrefix, changelogScopePre
     }
     const parent = parentSectionPath(sec);
     const isRootLevel = parent === "" || !sectionPaths.has(parent) && nearestExistingAncestor(sec, sectionPaths) === "";
-    if (isRootLevel && hasRootSection) {
+    if (isRootLevel && hasRootSection && sec !== "") {
       continue;
     }
     if (isRootLevel) {
       let node;
-      if (type === "apiReference" || type === "apiPackage") {
+      if (API_NODE_SEGMENT_TYPES.has(type ?? "")) {
         node = apiReferenceNode(ctx, s, scopeSegs, scopePrefix);
       } else if (type === "changelog") {
         node = changelogNode(ctx, s, changelogScopePrefix ?? scopePrefix);
       } else {
+        const bounds = siblingBoundaries.get(s);
+        const ownedSegs = bounds != null ? scopeSegs.filter((seg) => seg.seg.sortOrder >= bounds.lo && seg.seg.sortOrder < bounds.hi) : scopeSegs;
         node = sectionNode(
           ctx,
           s,
-          buildSectionTree(ctx, scopeSegs, sec, scopePrefix, changelogScopePrefix),
+          buildSectionTree(ctx, ownedSegs, sec, scopePrefix, changelogScopePrefix),
           scopePrefix
         );
       }
-      annotated.push({ node, pos: metaNum(s.seg.metadata, "childIndex"), isLeaf: false });
+      const isSharedSection = siblingBoundaries.size > 0 && scopePrefix !== "" && sec !== "" && !sec.startsWith(scopePrefix);
+      annotated.push({
+        node,
+        pos: isSharedSection ? void 0 : metaNum(s.seg.metadata, "childIndex"),
+        isLeaf: false
+      });
     }
   }
   const hasLeafPos = annotated.some((a) => a.isLeaf && a.pos != null);
@@ -1636,13 +1735,13 @@ function buildSidebarRoot(ctx, scopeSegs, scopePrefix, changelogScopePrefix) {
   };
 }
 function buildFullRootFromSegments(options) {
-  const { basePath, title, segments, navBySegment } = options;
+  const { basePath, rootSlug: sourceRootSlug, title, segments, navBySegment, skipSharedSectionMerge } = options;
   const ctx = createBuildContext(basePath);
   const scoped = segments.filter((seg) => {
     const t = metaStr(seg.metadata, "type");
-    return t !== "files" && t !== "redirects";
+    return !INFRA_SEGMENT_TYPES.has(t ?? "");
   }).map((seg) => ({ seg, nav: navBySegment.get(seg.segmentHash) ?? [] }));
-  const rootSlug = asSlug(basePath);
+  const rootSlug = asSlug(sourceRootSlug ?? basePath);
   const scopesByKey = /* @__PURE__ */ new Map();
   for (const s of scoped) {
     const key = scopeKey(s.seg);
@@ -1655,9 +1754,9 @@ function buildFullRootFromSegments(options) {
   const tabs = uniqueDetails(scoped, "tab");
   let child;
   if (products.length > 0) {
-    child = buildProductGroup(ctx, products, scoped, rootSlug);
+    child = buildProductGroup(ctx, products, scoped, rootSlug, skipSharedSectionMerge);
   } else if (versions.length > 0) {
-    child = buildVersioned(ctx, versions, scoped, rootSlug, void 0);
+    child = buildVersioned(ctx, versions, scoped, rootSlug, void 0, skipSharedSectionMerge);
   } else {
     child = buildUnversioned(ctx, scoped, rootSlug, tabs.length > 0);
   }
@@ -1764,20 +1863,34 @@ function buildSidebarRootWithVariants(ctx, scopeSegs, scopePrefix, changelogScop
   if (variants.length <= 1) {
     return buildSidebarRoot(ctx, scopeSegs, scopePrefix, changelogScopePrefix);
   }
+  const sharedSegs = scopeSegs.filter((s) => s.seg.variant == null);
   const variantedNode = buildVariantedNode(ctx, variants, scopeSegs, scopePrefix);
+  const sharedChildren = sharedSegs.length > 0 ? buildSidebarRootChildren(ctx, sharedSegs, scopePrefix, changelogScopePrefix) : [];
   const first = scopeSegs[0];
   return {
     type: "sidebarRoot",
     id: ctx.nodeId(`sidebar:${first != null ? scopeKey(first.seg) : "root"}`),
     collapsed: void 0,
-    children: [variantedNode]
+    children: [...sharedChildren, variantedNode]
   };
 }
 function buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix) {
   if (!tabsPresent) {
     const variants = uniqueDetails(scopeSegs, "variant");
     if (variants.length > 1) {
-      return buildVariantedNode(ctx, variants, scopeSegs, scopePrefix);
+      const sharedSegs = scopeSegs.filter((s) => s.seg.variant == null);
+      const variantedNode = buildVariantedNode(ctx, variants, scopeSegs, scopePrefix);
+      if (sharedSegs.length > 0) {
+        const sharedChildren = buildSidebarRootChildren(ctx, sharedSegs, scopePrefix);
+        const first2 = scopeSegs[0];
+        return {
+          type: "sidebarRoot",
+          id: ctx.nodeId(`sidebar:${first2 != null ? scopeKey(first2.seg) : "root"}`),
+          collapsed: void 0,
+          children: [...sharedChildren, variantedNode]
+        };
+      }
+      return variantedNode;
     }
     return buildSidebarRoot(ctx, scopeSegs, scopePrefix);
   }
@@ -1857,16 +1970,71 @@ function buildUnversioned(ctx, scopeSegs, scopePrefix, tabsPresent) {
     type: "unversioned",
     id: ctx.nodeId(`unversioned:${first?.seg.product?.id ?? "root"}`),
     collapsed: void 0,
-    landingPage: void 0,
+    landingPage: buildLandingPage(ctx, scopeSegs),
     // The enclosing scope prefix (product slug, or rootSlug at the top
     // level) roots structural sections so they share the scope's slug
     // namespace.
     child: buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix)
   };
 }
-function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix) {
+function mergeSharedSections(defaultSegs, allScoped, defaultVersion, versionSlugs) {
+  const defaultTabsByName = /* @__PURE__ */ new Map();
+  for (const s of defaultSegs) {
+    if (s.seg.tab != null) {
+      const tabName = s.seg.tab.displayName;
+      if (!defaultTabsByName.has(tabName)) {
+        defaultTabsByName.set(tabName, s.seg.tab);
+      }
+    }
+  }
+  const existingSections = new Set(
+    defaultSegs.filter((s) => metaStr(s.seg.metadata, "type") === "section").map((s) => s.seg.section)
+  );
+  const maxSortOrder = defaultSegs.reduce((max, s) => Math.max(max, s.seg.sortOrder), 0);
+  let nextSortOrder = maxSortOrder + 1;
+  const merged = [...defaultSegs];
+  for (const s of allScoped) {
+    if (s.seg.version?.id === defaultVersion.id) {
+      continue;
+    }
+    const type = metaStr(s.seg.metadata, "type");
+    if (type !== "section") {
+      continue;
+    }
+    const sectionPath = s.seg.section;
+    if (versionSlugs.some((vs) => sectionPath === vs || sectionPath.startsWith(vs + "/"))) {
+      continue;
+    }
+    if (existingSections.has(sectionPath)) {
+      continue;
+    }
+    const sourceTabName = s.seg.tab?.displayName ?? "";
+    const targetTab = defaultTabsByName.get(sourceTabName);
+    if (targetTab == null) {
+      continue;
+    }
+    const metadata = s.seg.metadata != null ? { ...s.seg.metadata, childIndex: void 0 } : s.seg.metadata;
+    merged.push({
+      seg: {
+        ...s.seg,
+        tab: targetTab,
+        version: defaultVersion,
+        sortOrder: nextSortOrder++,
+        metadata
+      },
+      nav: s.nav
+    });
+    existingSections.add(sectionPath);
+  }
+  return merged;
+}
+function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix, skipSharedSectionMerge) {
+  const versionSlugs = versions.map((v) => detailSlug(v)).filter((s) => s !== "");
   const children = versions.map((version) => {
-    const versionSegs = scoped.filter((s) => s.seg.version?.id === version.id);
+    let versionSegs = scoped.filter((s) => s.seg.version?.id === version.id);
+    if (detailIsDefault(version) && !skipSharedSectionMerge) {
+      versionSegs = mergeSharedSections(versionSegs, scoped, version, versionSlugs);
+    }
     const tabsPresent = uniqueDetails(versionSegs, "tab").length > 0;
     const prefix = productPrefix != null ? productPrefix : rootSlug;
     const versionSegment = detailSlug(version);
@@ -1884,7 +2052,7 @@ function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix) {
       default: detailIsDefault(version),
       versionId: VersionId(version.id),
       availability: void 0,
-      landingPage: buildVersionLandingPage(ctx, versionSegs, asSlug(slug)),
+      landingPage: buildLandingPage(ctx, versionSegs),
       announcement: void 0,
       pointsTo: metaStr(version.metadata, "pointsTo") != null ? pointsToSlug(metaStr(version.metadata, "pointsTo")) : void 0,
       // The version's full slug roots structural sections so the whole
@@ -1965,34 +2133,41 @@ function crossVersionDedupKeys(node, parents) {
   keys.push([...parentTitles, node.title].join("###"));
   return keys;
 }
-function buildVersionLandingPage(ctx, versionSegs, versionSlug) {
-  const tablessSegs = versionSegs.filter((s) => s.seg.tab == null);
-  if (tablessSegs.length === 0) {
+function routeToLandingPage(ctx, route) {
+  if (route == null || route.type !== "markdown" || route.fullPath == null) {
     return void 0;
   }
-  for (const s of tablessSegs) {
-    for (const r of s.nav) {
-      if (r.type === "markdown" && r.fullPath != null) {
-        const md = r.metadata;
-        const pageId = metaStr(md, "pageId") ?? "";
-        const slug = ctx.contentSlug(r.fullPath);
-        return {
-          type: "landingPage",
-          ...withMetadataDefaults({
-            id: ctx.nodeId(`landing:${slug}`),
-            title: metaStr(md, "title") ?? "",
-            slug,
-            icon: metaStr(md, "icon"),
-            hidden: r.hidden,
-            viewers: toViewers(metaStrArr(md, "viewers"))
-          }),
-          pageId: PageId(pageId),
-          noindex: metaBool(md, "noindex")
-        };
-      }
-    }
+  const md = route.metadata;
+  const pageId = metaStr(md, "pageId");
+  if (pageId == null) {
+    return void 0;
   }
-  return void 0;
+  const slug = ctx.contentSlug(route.fullPath);
+  return {
+    type: "landingPage",
+    ...withMetadataDefaults({
+      id: ctx.nodeId(`landing:${slug}`),
+      title: metaStr(md, "title") ?? "",
+      slug,
+      icon: metaStr(md, "icon"),
+      hidden: route.hidden,
+      authed: metaBool(md, "authed"),
+      viewers: toViewers(metaStrArr(md, "viewers")),
+      orphaned: metaBool(md, "orphaned"),
+      featureFlags: metaFeatureFlags(md)
+    }),
+    pageId: PageId(pageId),
+    noindex: metaBool(md, "noindex")
+  };
+}
+function buildLandingPage(ctx, scopeSegs) {
+  const landingSegment = scopeSegs.find(
+    (s) => metaStr(s.seg.metadata, "type") === "tabRoot" && metaBool(s.seg.metadata, "landingPage") === true
+  );
+  return routeToLandingPage(
+    ctx,
+    landingSegment?.nav.find((route) => route.type === "markdown")
+  );
 }
 function markCrossVersionCanonicalSlugs(versionNodes) {
   const keyToCanonical = /* @__PURE__ */ new Map();
@@ -2027,13 +2202,13 @@ function markCrossVersionCanonicalSlugs(versionNodes) {
     });
   }
 }
-function buildProductGroup(ctx, products, scoped, rootSlug) {
+function buildProductGroup(ctx, products, scoped, rootSlug, skipSharedSectionMerge) {
   const children = products.map((product) => {
     const productSegs = scoped.filter((s) => s.seg.product?.id === product.id);
     const versions = uniqueDetails(productSegs, "version");
     const tabsPresent = uniqueDetails(productSegs, "tab").length > 0;
     const productPrefix = scopeSlugPrefix(rootSlug, product);
-    const productChild = versions.length > 0 ? buildVersioned(ctx, versions, productSegs, rootSlug, productPrefix) : buildUnversioned(ctx, productSegs, asSlug(productPrefix), tabsPresent);
+    const productChild = versions.length > 0 ? buildVersioned(ctx, versions, productSegs, rootSlug, productPrefix, skipSharedSectionMerge) : buildUnversioned(ctx, productSegs, asSlug(productPrefix), tabsPresent);
     const node = {
       type: "product",
       ...withMetadataDefaults({
@@ -2063,7 +2238,10 @@ function buildProductGroup(ctx, products, scoped, rootSlug) {
     type: "productgroup",
     id: ctx.nodeId("productgroup"),
     collapsed: void 0,
-    landingPage: void 0,
+    landingPage: buildLandingPage(
+      ctx,
+      scoped.filter((s) => s.seg.product == null)
+    ),
     children
   };
 }