@fern-api/fdr-sdk 1.2.38-cc77d6a840 → 1.2.39-4f09cc17dc

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)
 });
@@ -657,6 +660,77 @@ function getChildren(node) {
   }
 }
 
+// ../commons/core-utils/dist/assertNever.js
+function assertNever(x) {
+  throw new Error("Unexpected value: " + JSON.stringify(x));
+}
+
+// ../commons/core-utils/dist/visitDiscriminatedUnion.js
+function visitDiscriminatedUnion(item, discriminant = "type") {
+  return {
+    _visit: (visitor) => {
+      const visit = visitor[item[discriminant]];
+      if (visit != null) {
+        return visit(item);
+      } else {
+        if (visitor._other == null) {
+          assertNever(item);
+        }
+        return visitor._other(item);
+      }
+    }
+  };
+}
+var visitDiscriminatedUnion_default = visitDiscriminatedUnion;
+
+// src/navigation/versions/latest/getPageId.ts
+var RETURN_PAGEID = (node) => node.pageId;
+var RETURN_OVERVIEW_PAGEID = (node) => node.overviewPageId;
+var RETURN_UNDEFINED = () => void 0;
+function getPageId(node) {
+  return visitDiscriminatedUnion_default(node)._visit({
+    section: RETURN_OVERVIEW_PAGEID,
+    apiReference: RETURN_OVERVIEW_PAGEID,
+    changelog: RETURN_OVERVIEW_PAGEID,
+    apiPackage: RETURN_OVERVIEW_PAGEID,
+    changelogEntry: RETURN_PAGEID,
+    page: RETURN_PAGEID,
+    landingPage: RETURN_PAGEID,
+    // if the following changes, make sure to update the algolia records generator
+    endpoint: RETURN_UNDEFINED,
+    webSocket: RETURN_UNDEFINED,
+    webhook: RETURN_UNDEFINED,
+    grpc: RETURN_UNDEFINED,
+    graphql: RETURN_UNDEFINED,
+    graphqlType: RETURN_UNDEFINED
+    // changelogYear: RETURN_UNDEFINED,
+    // changelogMonth: RETURN_UNDEFINED,
+  });
+}
+
+// src/navigation/versions/latest/NavigationNodeSection.ts
+function isSection(node) {
+  return node.type === "section" || node.type === "apiReference" || node.type === "changelog" || node.type === "apiPackage";
+}
+
+// src/navigation/versions/latest/NavigationNodeSectionOverview.ts
+function isSectionOverview(node) {
+  return isSection(node) && node.overviewPageId != null;
+}
+
+// src/navigation/versions/latest/NavigationNodeMarkdown.ts
+function hasMarkdown(node) {
+  return isMarkdownLeaf(node) || isSectionOverview(node);
+}
+
+// src/navigation/versions/latest/NavigationNodePage.ts
+function isPage(node) {
+  return isApiLeaf(node) || node.type === "changelog" || // TODO: Uncomment when changelog years and months are visitable
+  // node.type === "changelogYear" ||
+  // node.type === "changelogMonth" ||
+  hasMarkdown(node);
+}
+
 // src/navigation/versions/latest/NavigationNodeWithMetadata.ts
 function hasMetadata(node) {
   return typeof node.title === "string" && typeof node.slug === "string";
@@ -794,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;
@@ -829,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) {
@@ -862,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"),
@@ -878,7 +962,7 @@ function artifactToNode(ctx, route) {
         title,
         icon,
         url: Url(metaStr(md, "url") ?? ""),
-        target: void 0
+        target: metaStr(md, "target")
       };
       return node;
     }
@@ -913,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");
@@ -928,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
     };
   }
@@ -944,7 +1031,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       method,
       webhookId: WebhookId(webhookId),
       apiDefinitionId,
-      availability: void 0
+      availability: metaStr(md, "availability")
     };
   }
   if (route.type === "asyncapi") {
@@ -957,7 +1044,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       ...meta,
       webSocketId: WebSocketId(webSocketId),
       apiDefinitionId,
-      availability: void 0,
+      availability: metaStr(md, "availability"),
       playground: void 0
     };
   }
@@ -973,7 +1060,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       method,
       grpcId: GrpcId(grpcId),
       apiDefinitionId,
-      availability: void 0
+      availability: metaStr(md, "availability")
     };
   }
   if (route.type === "graphql") {
@@ -989,7 +1076,7 @@ function apiLeafNodeFromNavRouteInternal(ctx, route, segmentApiDefinitionId2) {
       graphqlOperationId: GraphQlOperationId(graphqlOperationId),
       graphqlOperationIds: void 0,
       apiDefinitionId,
-      availability: void 0,
+      availability: metaStr(md, "availability"),
       playground: void 0
     };
   }
@@ -1084,8 +1171,9 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
   const { seg, nav } = scoped;
   const overview = overviewRoute(nav) ?? overviewRouteFromSegmentMeta(seg, nav);
   const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
-  let slug = structuralNodeSlug(ctx, overview?.fullPath, seg.section, scopePrefix);
-  if (seg.section === "" && overview?.fullPath == null) {
+  const relSection = stripLeadingScopePrefix(seg.section, scopePrefix);
+  let slug = structuralNodeSlug(ctx, overview?.fullPath, relSection, scopePrefix);
+  if (relSection === "" && overview?.fullPath == null) {
     slug = inferSectionSlugFromNav(ctx, nav, scopePrefix) ?? slug;
   }
   const metaPointsTo = metaStr(seg.metadata, "pointsTo");
@@ -1095,17 +1183,20 @@ 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,
     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)
   };
@@ -1166,7 +1257,12 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
   const overview = overviewRoute(nav);
   const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
   const apiDefinitionId = metaStr(seg.metadata, "apiDefinitionId") ?? parentApiDefinitionId;
-  const slug = structuralNodeSlug(ctx, overview?.fullPath, seg.section, scopePrefix);
+  const slug = structuralNodeSlug(
+    ctx,
+    overview?.fullPath,
+    stripLeadingScopePrefix(seg.section, scopePrefix),
+    scopePrefix
+  );
   const metaPointsTo = metaStr(seg.metadata, "pointsTo");
   const children = buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
   return {
@@ -1177,12 +1273,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
@@ -1245,7 +1344,12 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
   const overview = overviewRoute(nav);
   const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
   const apiDefinitionId = metaStr(seg.metadata, "apiDefinitionId") ?? "";
-  const slug = structuralNodeSlug(ctx, overview?.fullPath, seg.section, scopePrefix);
+  const slug = structuralNodeSlug(
+    ctx,
+    overview?.fullPath,
+    stripLeadingScopePrefix(seg.section, scopePrefix),
+    scopePrefix
+  );
   const metaPointsTo = metaStr(seg.metadata, "pointsTo");
   const children = buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
   const changelog = attachedApiChangelogNode(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
@@ -1257,12 +1361,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"),
@@ -1315,10 +1422,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
     };
@@ -1364,10 +1474,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
   };
 }
@@ -1553,6 +1666,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",
@@ -1613,7 +1744,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
     };
@@ -1650,7 +1781,10 @@ function buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix) {
   const tabDetails = uniqueDetails(scopeSegs, "tab");
   const children = tabDetails.map((tab) => {
     const tabType = metaStr(tab.metadata, "tab_type");
-    const tabSlug = asSlug(scopeSlugPrefix(scopePrefix, tab));
+    const rawTabSlug = detailSlug(tab);
+    const versionDetail = scopeSegs[0]?.seg.version;
+    const versionSlugStr = versionDetail != null ? detailSlug(versionDetail) : void 0;
+    const tabSlug = versionSlugStr != null && rawTabSlug !== "" && (rawTabSlug === versionSlugStr || rawTabSlug.startsWith(versionSlugStr + "/")) ? asSlug(rawTabSlug) : asSlug(scopeSlugPrefix(scopePrefix, tab));
     if (tabType === "link") {
       return {
         type: "link",
@@ -1659,7 +1793,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") {
@@ -1747,7 +1881,7 @@ function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix) {
       default: detailIsDefault(version),
       versionId: VersionId(version.id),
       availability: void 0,
-      landingPage: void 0,
+      landingPage: buildVersionLandingPage(ctx, versionSegs, asSlug(slug)),
       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
@@ -1759,6 +1893,7 @@ function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix) {
     }
     return node;
   });
+  markCrossVersionCanonicalSlugs(children);
   return {
     type: "versioned",
     id: ctx.nodeId(`versioned:${productPrefix ?? "root"}`),
@@ -1784,6 +1919,111 @@ function markDefaultVersionCanonicalSlugs(node, pruneSlug, versionSlug) {
     return;
   });
 }
+function unversionedParents(parents) {
+  let versionIdx = -1;
+  for (let i = parents.length - 1; i >= 0; i--) {
+    if (parents[i].type === "version") {
+      versionIdx = i;
+      break;
+    }
+  }
+  return versionIdx >= 0 ? parents.slice(versionIdx + 1) : parents;
+}
+function crossVersionDedupKeys(node, parents) {
+  const keys = [];
+  const uParents = unversionedParents(parents);
+  const pid = getPageId(node);
+  if (pid != null) {
+    keys.push(`pid:${pid}`);
+  }
+  if (node.type === "endpoint" || node.type === "webSocket" || node.type === "webhook" || node.type === "grpc" || node.type === "graphql") {
+    const apiParentTitles = uParents.filter(
+      (p) => p.type === "apiReference"
+    ).map((p) => p.title.replaceAll(" ", ""));
+    const apiPrefix = apiParentTitles.join(":");
+    if (node.type === "endpoint") {
+      keys.push(`${apiPrefix}:api:endpoint:${node.method}:${node.endpointId}`);
+    } else if (node.type === "webSocket") {
+      keys.push(`${apiPrefix}:api:websocket:${node.webSocketId}`);
+    } else if (node.type === "webhook") {
+      keys.push(`${apiPrefix}:api:webhook:${node.method}:${node.webhookId}`);
+    } else if (node.type === "grpc") {
+      keys.push(`${apiPrefix}:api:grpc:${node.method}:${node.grpcId}`);
+    } else if (node.type === "graphql") {
+      keys.push(`${apiPrefix}:api:graphql:${node.id}`);
+    }
+  }
+  const parentTitles = [];
+  for (const p of uParents) {
+    if (hasMetadata(p)) {
+      parentTitles.push(p.title);
+    }
+  }
+  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) {
+    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")
+        };
+      }
+    }
+  }
+  return void 0;
+}
+function markCrossVersionCanonicalSlugs(versionNodes) {
+  const keyToCanonical = /* @__PURE__ */ new Map();
+  const sorted = [...versionNodes].sort((a, b) => {
+    if (a.default !== b.default) {
+      return a.default ? -1 : 1;
+    }
+    return 0;
+  });
+  for (const version of sorted) {
+    traverseDF(version, (child, parents) => {
+      if (hasMetadata(child) && isPage(child)) {
+        const keys = crossVersionDedupKeys(child, parents);
+        let matched = false;
+        for (const key of keys) {
+          const canonical = keyToCanonical.get(key);
+          if (canonical != null && !version.default) {
+            child.canonicalSlug = canonical;
+            matched = true;
+            break;
+          }
+        }
+        if (!matched) {
+          const canonical = child.canonicalSlug ?? child.slug;
+          for (const key of keys) {
+            if (!keyToCanonical.has(key)) {
+              keyToCanonical.set(key, canonical);
+            }
+          }
+        }
+      }
+    });
+  }
+}
 function buildProductGroup(ctx, products, scoped, rootSlug) {
   const children = products.map((product) => {
     const productSegs = scoped.filter((s) => s.seg.product?.id === product.id);
@@ -1809,7 +2049,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