@fern-api/fdr-sdk 1.2.39-38c6f9a29c → 1.2.39-4a89db5dd2

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

@@ -94,6 +94,9 @@ var AuthSchemeIdSchema = z2.string();
 var SubpackageIdSchema = z2.string();
 var WebSocketMessageIdSchema = z2.string();
 var FileIdSchema = z2.string();
+function FileId(value) {
+  return value;
+}
 var MultipleAuthTypeSchema = z2.object({
   schemes: z2.array(AuthSchemeIdSchema)
 });
@@ -865,6 +868,13 @@ function metaStrArr(metadata, key) {
   }
   return void 0;
 }
+function metaFeatureFlags(metadata) {
+  if (metadata != null && typeof metadata === "object" && "featureFlags" in metadata) {
+    const v = metadata.featureFlags;
+    return Array.isArray(v) && v.length > 0 ? v : void 0;
+  }
+  return void 0;
+}
 function toViewers(viewers) {
   if (viewers == null || viewers.length === 0) {
     return void 0;
@@ -900,17 +910,17 @@ function scopeKey(seg) {
   return [seg.product?.id ?? "", seg.version?.id ?? "", seg.variant?.id ?? "", seg.tab?.id ?? ""].join("|");
 }
 function withMetadataDefaults(base) {
-  const { viewers, ...rest } = base;
+  const { viewers, featureFlags, ...rest } = base;
   return {
     ...rest,
     canonicalSlug: void 0,
-    authed: void 0,
+    authed: base.authed === true ? true : void 0,
     collapsed: void 0,
     // Normalise empty arrays to undefined so unrestricted nodes don't add
     // filter-level noise; a non-empty array engages the RBAC view gate.
     viewers: viewers != null && viewers.length > 0 ? viewers : void 0,
-    orphaned: void 0,
-    featureFlags: void 0
+    orphaned: base.orphaned === true ? true : void 0,
+    featureFlags: featureFlags != null && featureFlags.length > 0 ? featureFlags : void 0
   };
 }
 function artifactToNode(ctx, route) {
@@ -933,7 +943,10 @@ function artifactToNode(ctx, route) {
           slug,
           icon,
           hidden: route.hidden,
-          viewers
+          authed: metaBool(md, "authed"),
+          viewers,
+          orphaned: metaBool(md, "orphaned"),
+          featureFlags: metaFeatureFlags(md)
         }),
         pageId: PageId(pageId),
         noindex: metaBool(md, "noindex"),
@@ -949,7 +962,7 @@ function artifactToNode(ctx, route) {
         title,
         icon,
         url: Url(metaStr(md, "url") ?? ""),
-        target: void 0
+        target: metaStr(md, "target")
       };
       return node;
     }
@@ -984,7 +997,10 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
     slug,
     icon,
     hidden: route.hidden,
-    viewers
+    authed: metaBool(md, "authed"),
+    viewers,
+    orphaned: metaBool(md, "orphaned"),
+    featureFlags: metaFeatureFlags(md)
   });
   if (route.type === "rest") {
     const endpointId = metaStr(md, "endpointId");
@@ -999,7 +1015,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       endpointId: EndpointId(endpointId),
       apiDefinitionId,
       isResponseStream: metaBool(md, "isResponseStream"),
-      availability: void 0,
+      availability: metaStr(md, "availability"),
       playground: void 0
     };
   }
@@ -1015,7 +1031,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       method,
       webhookId: WebhookId(webhookId),
       apiDefinitionId,
-      availability: void 0
+      availability: metaStr(md, "availability")
     };
   }
   if (route.type === "asyncapi") {
@@ -1028,7 +1044,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       ...meta,
       webSocketId: WebSocketId(webSocketId),
       apiDefinitionId,
-      availability: void 0,
+      availability: metaStr(md, "availability"),
       playground: void 0
     };
   }
@@ -1044,7 +1060,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       method,
       grpcId: GrpcId(grpcId),
       apiDefinitionId,
-      availability: void 0
+      availability: metaStr(md, "availability")
     };
   }
   if (route.type === "graphql") {
@@ -1060,12 +1076,69 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       graphqlOperationId: GraphQlOperationId(graphqlOperationId),
       graphqlOperationIds: void 0,
       apiDefinitionId,
-      availability: void 0,
+      availability: metaStr(md, "availability"),
       playground: void 0
     };
   }
   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);
@@ -1167,17 +1240,22 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
     slug,
     icon: metaStr(seg.metadata, "icon"),
     hidden: seg.hidden,
-    viewers: mergeVariantViewers(seg)
+    authed: metaBool(seg.metadata, "authed"),
+    viewers: mergeVariantViewers(seg),
+    orphaned: metaBool(seg.metadata, "orphaned"),
+    featureFlags: metaFeatureFlags(seg.metadata)
   });
   return {
     type: "section",
     ...defaults,
-    collapsed: metaCollapsed(seg.metadata) ?? defaults.collapsed,
+    // 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,
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
-    noindex: void 0,
+    noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
     collapsible: metaBool(seg.metadata, "collapsible") ?? (metaCollapsed(seg.metadata) != null ? true : void 0),
     collapsedByDefault: metaBool(seg.metadata, "collapsedByDefault") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
-    availability: void 0,
+    availability: metaStr(seg.metadata, "availability"),
     pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
     children: mergeChildrenByPosition(ctx, nav, sectionChildren)
   };
@@ -1200,8 +1278,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(
@@ -1215,18 +1292,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 });
   }
@@ -1254,12 +1323,15 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
       slug,
       icon: metaStr(seg.metadata, "icon"),
       hidden: seg.hidden,
-      viewers: toViewers(metaStrArr(seg.metadata, "viewers"))
+      authed: metaBool(seg.metadata, "authed"),
+      viewers: toViewers(metaStrArr(seg.metadata, "viewers")),
+      orphaned: metaBool(seg.metadata, "orphaned"),
+      featureFlags: metaFeatureFlags(seg.metadata)
     }),
     apiDefinitionId: ApiDefinitionId(apiDefinitionId),
     availability: metaStr(seg.metadata, "availability"),
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
-    noindex: void 0,
+    noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
     pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
     children,
     playground: void 0
@@ -1339,12 +1411,15 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
       slug,
       icon: metaStr(seg.metadata, "icon"),
       hidden: seg.hidden,
-      viewers: mergeVariantViewers(seg)
+      authed: metaBool(seg.metadata, "authed"),
+      viewers: mergeVariantViewers(seg),
+      orphaned: metaBool(seg.metadata, "orphaned"),
+      featureFlags: metaFeatureFlags(seg.metadata)
     }),
     apiDefinitionId: ApiDefinitionId(apiDefinitionId),
-    availability: void 0,
+    availability: metaStr(seg.metadata, "availability"),
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
-    noindex: void 0,
+    noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
     paginated: true,
     showErrors: metaBool(seg.metadata, "showErrors"),
     hideTitle: metaBool(seg.metadata, "hideTitle"),
@@ -1397,10 +1472,13 @@ function changelogNode(ctx, scoped, scopePrefix) {
         slug: ctx.contentSlug(r.fullPath ?? ""),
         icon: metaStr(r.metadata, "icon"),
         hidden: r.hidden,
-        viewers: toViewers(metaStrArr(r.metadata, "viewers"))
+        authed: metaBool(r.metadata, "authed"),
+        viewers: toViewers(metaStrArr(r.metadata, "viewers")),
+        orphaned: metaBool(r.metadata, "orphaned"),
+        featureFlags: metaFeatureFlags(r.metadata)
       }),
       pageId: PageId(metaStr(r.metadata, "pageId") ?? ""),
-      noindex: void 0,
+      noindex: metaBool(r.metadata, "noindex"),
       date: dateStr ?? "",
       tags: void 0
     };
@@ -1446,10 +1524,13 @@ function changelogNode(ctx, scoped, scopePrefix) {
       slug: baseSlug,
       icon: metaStr(seg.metadata, "icon"),
       hidden: seg.hidden,
-      viewers: mergeVariantViewers(seg)
+      authed: metaBool(seg.metadata, "authed"),
+      viewers: mergeVariantViewers(seg),
+      orphaned: metaBool(seg.metadata, "orphaned"),
+      featureFlags: metaFeatureFlags(seg.metadata)
     }),
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
-    noindex: void 0,
+    noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
     children: years
   };
 }
@@ -1517,6 +1598,9 @@ function buildSidebarRootChildren(ctx, scopeSegs, scopePrefix, changelogScopePre
     if (hasOwningApiReference(s, scopeSegs)) {
       continue;
     }
+    if (type === "tabRoot" && metaBool(s.seg.metadata, "landingPage") === true) {
+      continue;
+    }
     if (type === "tabRoot" || sec === "" && type !== "section") {
       for (const r of s.nav) {
         const node = artifactToNode(ctx, r);
@@ -1603,13 +1687,13 @@ function buildSidebarRoot(ctx, scopeSegs, scopePrefix, changelogScopePrefix) {
   };
 }
 function buildFullRootFromSegments(options) {
-  const { basePath, title, segments, navBySegment } = options;
+  const { basePath, rootSlug: sourceRootSlug, title, segments, navBySegment } = options;
   const ctx = createBuildContext(basePath);
   const scoped = segments.filter((seg) => {
     const t = metaStr(seg.metadata, "type");
     return t !== "files" && t !== "redirects";
   }).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);
@@ -1635,6 +1719,24 @@ function buildFullRootFromSegments(options) {
   } else if (child.type === "versioned") {
     const defaultVersion = child.children.find((v) => v.default) ?? child.children[0];
     rootPointsTo = defaultVersion?.pointsTo;
+  } else if (child.type === "unversioned") {
+    if (tabs.length > 0) {
+      const firstTab = tabs[0];
+      const pt = firstTab != null ? metaStr(firstTab.metadata, "pointsTo") : void 0;
+      rootPointsTo = pt != null ? pointsToSlug(pt) : void 0;
+    } else {
+      const sorted = [...scoped].sort((a, b) => a.seg.sortOrder - b.seg.sortOrder);
+      for (const s of sorted) {
+        if (s.seg.hidden) {
+          continue;
+        }
+        const pt = metaStr(s.seg.metadata, "pointsTo");
+        if (pt != null) {
+          rootPointsTo = pointsToSlug(pt);
+          break;
+        }
+      }
+    }
   }
   const root = {
     type: "root",
@@ -1647,21 +1749,22 @@ function buildFullRootFromSegments(options) {
   return root;
 }
 function uniqueDetails(scoped, dim) {
-  const bySlug = /* @__PURE__ */ new Map();
+  const byKey = /* @__PURE__ */ new Map();
   for (const s of scoped) {
     const d = s.seg[dim];
     if (d == null) {
       continue;
     }
     const slug = detailSlug(d);
-    const existing = bySlug.get(slug);
+    const key = dim === "tab" ? d.id : slug !== "" ? slug : d.id;
+    const existing = byKey.get(key);
     if (existing == null) {
-      bySlug.set(slug, d);
+      byKey.set(key, d);
     } else if (metaStr(d.metadata, "pointsTo") != null && metaStr(existing.metadata, "pointsTo") == null) {
-      bySlug.set(slug, d);
+      byKey.set(key, d);
     }
   }
-  return [...bySlug.values()].sort((a, b) => a.sortOrder - b.sortOrder);
+  return [...byKey.values()].sort((a, b) => a.sortOrder - b.sortOrder);
 }
 function scopeSlugPrefix(rootSlug, ...details) {
   const parts = [rootSlug];
@@ -1695,7 +1798,7 @@ function buildVariantedNode(ctx, variants, scopeSegs, scopePrefix) {
       default: detailIsDefault(variant),
       variantId: VariantId(String(variant.id)),
       subtitle: metaStr(variant.metadata, "subtitle") ?? void 0,
-      image: void 0,
+      image: metaStr(variant.metadata, "image") != null ? FileId(metaStr(variant.metadata, "image")) : void 0,
       pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
       children
     };
@@ -1744,7 +1847,7 @@ function buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix) {
         title: tab.displayName,
         icon: tab.icon ?? void 0,
         url: Url(metaStr(tab.metadata, "url") ?? ""),
-        target: void 0
+        target: metaStr(tab.metadata, "target")
       };
     }
     if (tabType === "changelog") {
@@ -1805,7 +1908,7 @@ 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.
@@ -1832,7 +1935,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
@@ -1913,34 +2016,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();
@@ -2000,7 +2110,7 @@ function buildProductGroup(ctx, products, scoped, rootSlug) {
       // here; sourcing it from the hash makes that filter match nothing.
       productId: ProductId(product.displayName),
       subtitle: metaStr(product.metadata, "subtitle") ?? "",
-      image: void 0,
+      image: metaStr(product.metadata, "image") != null ? FileId(metaStr(product.metadata, "image")) : void 0,
       announcement: void 0,
       pointsTo: metaStr(product.metadata, "pointsTo") != null ? pointsToSlug(metaStr(product.metadata, "pointsTo")) : void 0,
       child: productChild
@@ -2011,7 +2121,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
   };
 }