@fern-api/fdr-sdk 1.2.42-0c024f5b0d → 1.2.42-23647d2912

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

@@ -51,6 +51,17 @@ var VersionIdSchema = z.string();
 function VersionId(value) {
   return value;
 }
+var Availability = {
+  Alpha: "Alpha",
+  Stable: "Stable",
+  GenerallyAvailable: "GenerallyAvailable",
+  InDevelopment: "InDevelopment",
+  PreRelease: "PreRelease",
+  Deprecated: "Deprecated",
+  Beta: "Beta",
+  Preview: "Preview",
+  Legacy: "Legacy"
+};
 var SnippetsByEndpointMethodSchema = z.record(
   HttpMethodSchema,
   z.array(z.unknown())
@@ -847,6 +858,35 @@ function metaStr(metadata, key) {
   }
   return void 0;
 }
+var AVAILABILITY_LOOKUP = {
+  // V1 lowercase values (stored by docsPublishTransform from V1 navigation tree)
+  alpha: Availability.Alpha,
+  stable: Availability.Stable,
+  "generally-available": Availability.GenerallyAvailable,
+  "in-development": Availability.InDevelopment,
+  "pre-release": Availability.PreRelease,
+  deprecated: Availability.Deprecated,
+  beta: Availability.Beta,
+  preview: Availability.Preview,
+  legacy: Availability.Legacy,
+  // Latest PascalCase values (pass-through)
+  Alpha: Availability.Alpha,
+  Stable: Availability.Stable,
+  GenerallyAvailable: Availability.GenerallyAvailable,
+  InDevelopment: Availability.InDevelopment,
+  PreRelease: Availability.PreRelease,
+  Deprecated: Availability.Deprecated,
+  Beta: Availability.Beta,
+  Preview: Availability.Preview,
+  Legacy: Availability.Legacy
+};
+function metaAvailability(metadata) {
+  const raw = metaStr(metadata, "availability");
+  if (raw == null) {
+    return void 0;
+  }
+  return AVAILABILITY_LOOKUP[raw];
+}
 function metaBool(metadata, key) {
   if (metadata != null && typeof metadata === "object" && key in metadata) {
     const v = metadata[key];
@@ -964,7 +1004,7 @@ function artifactToNode(ctx, route) {
         }),
         pageId: PageId(pageId),
         noindex: metaBool(md, "noindex"),
-        availability: metaStr(md, "availability")
+        availability: metaAvailability(md)
       };
       return node;
     }
@@ -1029,7 +1069,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       endpointId: EndpointId(endpointId),
       apiDefinitionId,
       isResponseStream: metaBool(md, "isResponseStream"),
-      availability: metaStr(md, "availability"),
+      availability: metaAvailability(md),
       playground: void 0
     };
   }
@@ -1045,7 +1085,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       method,
       webhookId: WebhookId(webhookId),
       apiDefinitionId,
-      availability: metaStr(md, "availability")
+      availability: metaAvailability(md)
     };
   }
   if (route.type === "asyncapi") {
@@ -1058,7 +1098,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       ...meta,
       webSocketId: WebSocketId(webSocketId),
       apiDefinitionId,
-      availability: metaStr(md, "availability"),
+      availability: metaAvailability(md),
       playground: void 0
     };
   }
@@ -1074,7 +1114,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       method,
       grpcId: GrpcId(grpcId),
       apiDefinitionId,
-      availability: metaStr(md, "availability")
+      availability: metaAvailability(md)
     };
   }
   if (route.type === "graphql") {
@@ -1090,7 +1130,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       graphqlOperationId: GraphQlOperationId(graphqlOperationId),
       graphqlOperationIds: void 0,
       apiDefinitionId,
-      availability: metaStr(md, "availability"),
+      availability: metaAvailability(md),
       playground: void 0
     };
   }
@@ -1219,6 +1259,30 @@ function stripLeadingScopePrefix(section, scopePrefix) {
   }
   return section;
 }
+function computeDuplicateSiblingSortBoundaries(siblings) {
+  const result = /* @__PURE__ */ new Map();
+  const byPath = /* @__PURE__ */ new Map();
+  for (const sibling of siblings) {
+    if (metaStr(sibling.seg.metadata, "type") !== "section") {
+      continue;
+    }
+    const group = byPath.get(sibling.seg.section) ?? [];
+    group.push(sibling);
+    byPath.set(sibling.seg.section, group);
+  }
+  for (const [, group] of byPath) {
+    if (group.length <= 1) {
+      continue;
+    }
+    for (let i = 0; i < group.length; i++) {
+      result.set(group[i], {
+        lo: group[i].seg.sortOrder,
+        hi: i + 1 < group.length ? group[i + 1].seg.sortOrder : Number.MAX_SAFE_INTEGER
+      });
+    }
+  }
+  return result;
+}
 function mergeChildrenByPosition(ctx, nav, sectionChildren) {
   const leafNodes = [];
   for (let i = 0; i < nav.length; i++) {
@@ -1268,17 +1332,20 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
     noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
     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"),
+    availability: metaAvailability(seg.metadata),
     pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
     children: mergeChildrenByPosition(ctx, nav, sectionChildren)
   };
 }
-function directChildApiPackages(parentSection, scopeSegs) {
+function directChildApiPackages(parentSection, scopeSegs, apiDefinitionId) {
   const sectionPaths = new Set(scopeSegs.map((s) => s.seg.section));
   return scopeSegs.filter((s) => {
     if (metaStr(s.seg.metadata, "type") !== "apiPackage") {
       return false;
     }
+    if (metaStr(s.seg.metadata, "apiDefinitionId") !== apiDefinitionId) {
+      return false;
+    }
     const parent = parentSectionPath(s.seg.section);
     if (parent === parentSection) {
       return true;
@@ -1292,7 +1359,7 @@ function directChildApiPackages(parentSection, scopeSegs) {
 function buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix) {
   const { seg, nav } = scoped;
   const leafNodes = positionedApiLeafChildren(ctx, nav, apiDefinitionId);
-  const childPackages = directChildApiPackages(seg.section, scopeSegs);
+  const childPackages = directChildApiPackages(seg.section, scopeSegs, apiDefinitionId);
   const packageNodes = childPackages.map((child) => ({
     node: apiPackageChildNode(
       ctx,
@@ -1342,7 +1409,7 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
       featureFlags: metaFeatureFlags(seg.metadata)
     }),
     apiDefinitionId: ApiDefinitionId(apiDefinitionId),
-    availability: metaStr(seg.metadata, "availability"),
+    availability: metaAvailability(seg.metadata),
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
     noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
     pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
@@ -1430,10 +1497,10 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
       featureFlags: metaFeatureFlags(seg.metadata)
     }),
     apiDefinitionId: ApiDefinitionId(apiDefinitionId),
-    availability: metaStr(seg.metadata, "availability"),
+    availability: metaAvailability(seg.metadata),
     overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
     noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
-    paginated: true,
+    paginated: metaBool(seg.metadata, "paginated"),
     showErrors: metaBool(seg.metadata, "showErrors"),
     hideTitle: metaBool(seg.metadata, "hideTitle"),
     pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
@@ -1451,7 +1518,10 @@ function attachedApiChangelogNode(ctx, scoped, scopeSegs, apiDefinitionId, scope
     }
     return metaStr(candidate.seg.metadata, "apiDefinitionId") === apiDefinitionId;
   });
-  const changelogSeg = candidates.find((candidate) => parentSectionPath(candidate.seg.section) === seg.section) ?? candidates[0];
+  const apiReferenceCount = scopeSegs.filter((candidate) => {
+    return metaStr(candidate.seg.metadata, "type") === "apiReference" && metaStr(candidate.seg.metadata, "apiDefinitionId") === apiDefinitionId;
+  }).length;
+  const changelogSeg = candidates.find((candidate) => parentSectionPath(candidate.seg.section) === seg.section) ?? (apiReferenceCount === 1 ? candidates[0] : void 0);
   return changelogSeg != null ? changelogNode(ctx, changelogSeg, scopePrefix) : void 0;
 }
 function hasOwningApiReference(scoped, scopeSegs) {
@@ -1459,12 +1529,13 @@ function hasOwningApiReference(scoped, scopeSegs) {
   if (apiDefinitionId == null || metaStr(scoped.seg.metadata, "type") !== "changelog") {
     return false;
   }
-  return scopeSegs.some((candidate) => {
+  const candidates = scopeSegs.filter((candidate) => {
     if (metaStr(candidate.seg.metadata, "type") !== "apiReference") {
       return false;
     }
     return metaStr(candidate.seg.metadata, "apiDefinitionId") === apiDefinitionId;
   });
+  return candidates.some((candidate) => parentSectionPath(scoped.seg.section) === candidate.seg.section) || candidates.length === 1;
 }
 function isNestedApiPackage(scoped, scopeSegs) {
   if (metaStr(scoped.seg.metadata, "type") !== "apiPackage") {
@@ -1619,6 +1690,7 @@ function buildSectionTree(ctx, scopeSegs, parentPath, scopePrefix, changelogScop
     }
     return false;
   }).sort((a, b) => a.seg.sortOrder - b.seg.sortOrder);
+  const siblingBoundaries = computeDuplicateSiblingSortBoundaries(direct);
   return direct.map((s) => {
     const type = metaStr(s.seg.metadata, "type");
     const childIndex = metaNum(s.seg.metadata, "childIndex");
@@ -1628,10 +1700,14 @@ function buildSectionTree(ctx, scopeSegs, parentPath, scopePrefix, changelogScop
     } else if (type === "changelog") {
       node = changelogNode(ctx, s, changelogScopePrefix ?? scopePrefix);
     } else {
+      const boundary = siblingBoundaries.get(s);
+      const childScopeSegs = boundary != null ? scopeSegs.filter(
+        (candidate) => candidate.seg.sortOrder >= boundary.lo && candidate.seg.sortOrder < boundary.hi
+      ) : scopeSegs;
       node = sectionNode(
         ctx,
         s,
-        buildSectionTree(ctx, scopeSegs, s.seg.section, scopePrefix, changelogScopePrefix),
+        buildSectionTree(ctx, childScopeSegs, s.seg.section, scopePrefix, changelogScopePrefix),
         scopePrefix
       );
     }
@@ -1645,7 +1721,11 @@ function computeSiblingSortBoundaries(ordered) {
   for (const s of ordered) {
     const type = metaStr(s.seg.metadata, "type");
     const sec = s.seg.section;
-    if (type !== "section" || sec === "") {
+    if (type !== "section") {
+      continue;
+    }
+    if (sec === "") {
+      rootSections.push(s);
       continue;
     }
     const parent = parentSectionPath(sec);
@@ -1676,8 +1756,10 @@ function buildSidebarRootChildren(ctx, scopeSegs, scopePrefix, changelogScopePre
   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);
+  const hasRootSection = ordered.some(
+    (s) => metaStr(s.seg.metadata, "type") === "section" && s.seg.section === "" && (metaNum(s.seg.metadata, "childIndex") == null || siblingBoundaries.has(s))
+  );
   for (const s of ordered) {
     const type = metaStr(s.seg.metadata, "type");
     const sec = s.seg.section;
@@ -1696,8 +1778,10 @@ function buildSidebarRootChildren(ctx, scopeSegs, scopePrefix, changelogScopePre
       }
       continue;
     }
-    if (type === "section" && sec === "") {
-      const sectionChildren = buildSectionTree(ctx, scopeSegs, "", scopePrefix);
+    if (type === "section" && sec === "" && hasRootSection) {
+      const bounds = siblingBoundaries.get(s);
+      const ownedSegs = bounds != null ? scopeSegs.filter((seg) => seg.seg.sortOrder >= bounds.lo && seg.seg.sortOrder < bounds.hi) : scopeSegs;
+      const sectionChildren = buildSectionTree(ctx, ownedSegs, "", scopePrefix, changelogScopePrefix);
       const node = sectionNode(ctx, s, sectionChildren, scopePrefix);
       annotated.push({ node, pos: metaNum(s.seg.metadata, "childIndex"), isLeaf: false });
       continue;
@@ -1716,12 +1800,9 @@ function buildSidebarRootChildren(ctx, scopeSegs, scopePrefix, changelogScopePre
       } 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, ownedSegs, sec, scopePrefix, changelogScopePrefix),
-          scopePrefix
-        );
+        const isUnboundedSkipSlugSibling = sec === "" && metaNum(s.seg.metadata, "childIndex") != null && bounds == null;
+        const sectionChildren = isUnboundedSkipSlugSibling ? [] : buildSectionTree(ctx, ownedSegs, sec, scopePrefix, changelogScopePrefix);
+        node = sectionNode(ctx, s, sectionChildren, scopePrefix);
       }
       const isSharedSection = siblingBoundaries.size > 0 && scopePrefix !== "" && sec !== "" && !sec.startsWith(scopePrefix);
       annotated.push({
@@ -1759,10 +1840,6 @@ function groupSidebarRootChildren(ctx, children) {
     } else if (child.type === "section" && !child.collapsible) {
       flushRun();
       out.push(child);
-    } else if (child.type === "changelog") {
-      flushRun();
-      run.push(child);
-      flushRun();
     } else {
       run.push(child);
     }
@@ -1877,7 +1954,7 @@ function buildVariantedNode(ctx, variants, scopeSegs, scopePrefix) {
     const variantIndividualSlug = detailSlug(variant);
     const variantSlug = variantIndividualSlug !== "" ? asSlug(slugjoin(scopePrefix, variantIndividualSlug)) : scopePrefix;
     const metaPointsTo = metaStr(variant.metadata, "pointsTo");
-    const children = buildSidebarRootChildren(ctx, variantSegs, scopePrefix);
+    const children = buildSidebarRootChildren(ctx, variantSegs, variantSlug);
     return {
       type: "variant",
       ...withMetadataDefaults({
@@ -2279,6 +2356,7 @@ function buildProductGroup(ctx, products, scoped, rootSlug, skipSharedSectionMer
     };
     return node;
   });
+  markCrossProductCanonicalSlugs(children);
   return {
     type: "productgroup",
     id: ctx.nodeId("productgroup"),
@@ -2290,6 +2368,32 @@ function buildProductGroup(ctx, products, scoped, rootSlug, skipSharedSectionMer
     children
   };
 }
+function markCrossProductCanonicalSlugs(productNodes) {
+  const pageIdToCanonical = /* @__PURE__ */ new Map();
+  const sorted = [...productNodes].sort((a, b) => {
+    if (a.default !== b.default) {
+      return a.default ? -1 : 1;
+    }
+    return 0;
+  });
+  for (const product of sorted) {
+    traverseDF(product, (child) => {
+      if (hasMetadata(child) && isPage(child)) {
+        const pid = getPageId(child);
+        if (pid == null) {
+          return;
+        }
+        const key = `pid:${pid}`;
+        const canonical = pageIdToCanonical.get(key);
+        if (canonical != null && !product.default) {
+          child.canonicalSlug = canonical;
+        } else if (canonical == null) {
+          pageIdToCanonical.set(key, child.canonicalSlug ?? child.slug);
+        }
+      }
+    });
+  }
+}
 export {
   apiLeafNodeFromNavRoute,
   buildFullRootFromSegments,