@fern-api/fdr-sdk 1.2.45-932269c163 → 1.2.46-1b9e2153be

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (102) hide show
  1. package/dist/client/docs-types/db.d.ts +47 -0
  2. package/dist/client/docs-types/db.d.ts.map +1 -1
  3. package/dist/client/docs-types/read.d.ts +21 -0
  4. package/dist/client/docs-types/read.d.ts.map +1 -1
  5. package/dist/client/docs-types/shared.d.ts +5 -0
  6. package/dist/client/docs-types/shared.d.ts.map +1 -1
  7. package/dist/client/docs-types/shared.js +5 -1
  8. package/dist/client/docs-types/shared.js.map +1 -1
  9. package/dist/client/docs-types/write.d.ts +12 -0
  10. package/dist/client/docs-types/write.d.ts.map +1 -1
  11. package/dist/js/client/FdrClient.js +3 -1
  12. package/dist/js/client/FdrClient.js.map +1 -1
  13. package/dist/js/client/FdrClient.mjs +3 -1
  14. package/dist/js/client/FdrClient.mjs.map +1 -1
  15. package/dist/js/client/types.js +3 -1
  16. package/dist/js/client/types.js.map +1 -1
  17. package/dist/js/client/types.mjs +3 -1
  18. package/dist/js/client/types.mjs.map +1 -1
  19. package/dist/js/converters/index.js +3 -1
  20. package/dist/js/converters/index.js.map +1 -1
  21. package/dist/js/converters/index.mjs +3 -1
  22. package/dist/js/converters/index.mjs.map +1 -1
  23. package/dist/js/docs/index.js +3 -1
  24. package/dist/js/docs/index.js.map +1 -1
  25. package/dist/js/docs/index.mjs +3 -1
  26. package/dist/js/docs/index.mjs.map +1 -1
  27. package/dist/js/index.js +3 -1
  28. package/dist/js/index.js.map +1 -1
  29. package/dist/js/index.mjs +3 -1
  30. package/dist/js/index.mjs.map +1 -1
  31. package/dist/js/navigation/index.js +3 -1
  32. package/dist/js/navigation/index.js.map +1 -1
  33. package/dist/js/navigation/index.mjs +3 -1
  34. package/dist/js/navigation/index.mjs.map +1 -1
  35. package/dist/js/navigation/ledger-root-builder.js +65 -18
  36. package/dist/js/navigation/ledger-root-builder.js.map +1 -1
  37. package/dist/js/navigation/ledger-root-builder.mjs +65 -18
  38. package/dist/js/navigation/ledger-root-builder.mjs.map +1 -1
  39. package/dist/js/orpc-client.js +39 -1
  40. package/dist/js/orpc-client.js.map +1 -1
  41. package/dist/js/orpc-client.mjs +39 -1
  42. package/dist/js/orpc-client.mjs.map +1 -1
  43. package/dist/navigation/__test__/ledger-root-builder.contentfulRedirectRepro.test.js +56 -1
  44. package/dist/navigation/__test__/ledger-root-builder.contentfulRedirectRepro.test.js.map +1 -1
  45. package/dist/navigation/__test__/ledger-root-builder.landingPageRedirect.test.d.ts +2 -0
  46. package/dist/navigation/__test__/ledger-root-builder.landingPageRedirect.test.d.ts.map +1 -0
  47. package/dist/navigation/__test__/ledger-root-builder.landingPageRedirect.test.js +227 -0
  48. package/dist/navigation/__test__/ledger-root-builder.landingPageRedirect.test.js.map +1 -0
  49. package/dist/navigation/__test__/ledger-root-builder.unversionedPointsTo.test.js +59 -1
  50. package/dist/navigation/__test__/ledger-root-builder.unversionedPointsTo.test.js.map +1 -1
  51. package/dist/navigation/__test__/ledger-root-builder.withinVersionDedup.test.d.ts +2 -0
  52. package/dist/navigation/__test__/ledger-root-builder.withinVersionDedup.test.d.ts.map +1 -0
  53. package/dist/navigation/__test__/ledger-root-builder.withinVersionDedup.test.js +408 -0
  54. package/dist/navigation/__test__/ledger-root-builder.withinVersionDedup.test.js.map +1 -0
  55. package/dist/navigation/ledger-root-builder.d.ts.map +1 -1
  56. package/dist/navigation/ledger-root-builder.js +100 -20
  57. package/dist/navigation/ledger-root-builder.js.map +1 -1
  58. package/dist/orpc-client/docs/v1/read/contract.d.ts +14 -0
  59. package/dist/orpc-client/docs/v1/read/contract.d.ts.map +1 -1
  60. package/dist/orpc-client/docs/v1/write/contract.d.ts +4 -0
  61. package/dist/orpc-client/docs/v1/write/contract.d.ts.map +1 -1
  62. package/dist/orpc-client/docs/v2/read/contract.d.ts +32 -0
  63. package/dist/orpc-client/docs/v2/read/contract.d.ts.map +1 -1
  64. package/dist/orpc-client/docs/v2/write/contract.d.ts +8 -0
  65. package/dist/orpc-client/docs/v2/write/contract.d.ts.map +1 -1
  66. package/dist/orpc-client/docs-ledger/__test__/config-files.navFiles.test.js +28 -1
  67. package/dist/orpc-client/docs-ledger/__test__/config-files.navFiles.test.js.map +1 -1
  68. package/dist/orpc-client/docs-ledger/config-files.d.ts.map +1 -1
  69. package/dist/orpc-client/docs-ledger/config-files.js +34 -0
  70. package/dist/orpc-client/docs-ledger/config-files.js.map +1 -1
  71. package/dist/orpc-client/docs-ledger/contract.d.ts +56 -0
  72. package/dist/orpc-client/docs-ledger/contract.d.ts.map +1 -1
  73. package/dist/orpc-client/docs-ledger/ledger-manifest.d.ts +14 -0
  74. package/dist/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
  75. package/dist/tsconfig.tsbuildinfo +1 -1
  76. package/dist/types/client/docs-types/db.d.ts +47 -0
  77. package/dist/types/client/docs-types/db.d.ts.map +1 -1
  78. package/dist/types/client/docs-types/read.d.ts +21 -0
  79. package/dist/types/client/docs-types/read.d.ts.map +1 -1
  80. package/dist/types/client/docs-types/shared.d.ts +5 -0
  81. package/dist/types/client/docs-types/shared.d.ts.map +1 -1
  82. package/dist/types/client/docs-types/write.d.ts +12 -0
  83. package/dist/types/client/docs-types/write.d.ts.map +1 -1
  84. package/dist/types/navigation/__test__/ledger-root-builder.landingPageRedirect.test.d.ts +2 -0
  85. package/dist/types/navigation/__test__/ledger-root-builder.landingPageRedirect.test.d.ts.map +1 -0
  86. package/dist/types/navigation/__test__/ledger-root-builder.withinVersionDedup.test.d.ts +2 -0
  87. package/dist/types/navigation/__test__/ledger-root-builder.withinVersionDedup.test.d.ts.map +1 -0
  88. package/dist/types/navigation/ledger-root-builder.d.ts.map +1 -1
  89. package/dist/types/orpc-client/docs/v1/read/contract.d.ts +14 -0
  90. package/dist/types/orpc-client/docs/v1/read/contract.d.ts.map +1 -1
  91. package/dist/types/orpc-client/docs/v1/write/contract.d.ts +4 -0
  92. package/dist/types/orpc-client/docs/v1/write/contract.d.ts.map +1 -1
  93. package/dist/types/orpc-client/docs/v2/read/contract.d.ts +32 -0
  94. package/dist/types/orpc-client/docs/v2/read/contract.d.ts.map +1 -1
  95. package/dist/types/orpc-client/docs/v2/write/contract.d.ts +8 -0
  96. package/dist/types/orpc-client/docs/v2/write/contract.d.ts.map +1 -1
  97. package/dist/types/orpc-client/docs-ledger/config-files.d.ts.map +1 -1
  98. package/dist/types/orpc-client/docs-ledger/contract.d.ts +56 -0
  99. package/dist/types/orpc-client/docs-ledger/contract.d.ts.map +1 -1
  100. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts +14 -0
  101. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
  102. package/package.json +1 -1
@@ -1306,7 +1306,7 @@ function mergeChildrenByPosition(ctx, nav, sectionChildren) {
1306
1306
  function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
1307
1307
  const { seg, nav } = scoped;
1308
1308
  const overview = overviewRoute(nav) ?? overviewRouteFromSegmentMeta(seg, nav);
1309
- const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
1309
+ const overviewPageId = metaStr(seg.metadata, "overviewPageId");
1310
1310
  const relSection = stripLeadingScopePrefix(seg.section, scopePrefix);
1311
1311
  let slug = structuralNodeSlug(ctx, overview?.fullPath, relSection, scopePrefix);
1312
1312
  if (relSection === "" && overview?.fullPath == null) {
@@ -1319,7 +1319,6 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
1319
1319
  }
1320
1320
  }
1321
1321
  }
1322
- const metaPointsTo = metaStr(seg.metadata, "pointsTo");
1323
1322
  const defaults = withMetadataDefaults({
1324
1323
  id: ctx.nodeId(`section:${slug}`),
1325
1324
  title: metaStr(seg.metadata, "title") ?? "",
@@ -1340,7 +1339,10 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
1340
1339
  collapsible: metaBool(seg.metadata, "collapsible") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
1341
1340
  collapsedByDefault: metaBool(seg.metadata, "collapsedByDefault") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
1342
1341
  availability: metaAvailability(seg.metadata),
1343
- pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
1342
+ // Don't read pointsTo from metadata for sections; let
1343
+ // mutableUpdatePointsTo compute it via followRedirect so that
1344
+ // self-referencing redirects are cleared, matching v2 behavior.
1345
+ pointsTo: void 0,
1344
1346
  children: mergeChildrenByPosition(ctx, nav, sectionChildren)
1345
1347
  };
1346
1348
  }
@@ -1405,7 +1407,7 @@ function buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix)
1405
1407
  function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scopePrefix) {
1406
1408
  const { seg, nav } = scoped;
1407
1409
  const overview = overviewRoute(nav);
1408
- const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
1410
+ const overviewPageId = metaStr(seg.metadata, "overviewPageId");
1409
1411
  const apiDefinitionId = metaStr(seg.metadata, "apiDefinitionId") ?? parentApiDefinitionId;
1410
1412
  const slug = structuralNodeSlug(
1411
1413
  ctx,
@@ -1413,7 +1415,6 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
1413
1415
  stripLeadingScopePrefix(seg.section, scopePrefix),
1414
1416
  scopePrefix
1415
1417
  );
1416
- const metaPointsTo = metaStr(seg.metadata, "pointsTo");
1417
1418
  const children = buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
1418
1419
  return {
1419
1420
  type: "apiPackage",
@@ -1432,7 +1433,9 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
1432
1433
  availability: metaAvailability(seg.metadata),
1433
1434
  overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
1434
1435
  noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
1435
- pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
1436
+ // Don't read pointsTo from metadata; let mutableUpdatePointsTo
1437
+ // compute it via followRedirect, matching v2 behavior.
1438
+ pointsTo: void 0,
1436
1439
  children,
1437
1440
  playground: void 0
1438
1441
  };
@@ -1492,7 +1495,7 @@ function mergeEndpointPairs(ctx, leafNodes, allNav) {
1492
1495
  function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
1493
1496
  const { seg, nav } = scoped;
1494
1497
  const overview = overviewRoute(nav);
1495
- const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
1498
+ const overviewPageId = metaStr(seg.metadata, "overviewPageId");
1496
1499
  const apiDefinitionId = metaStr(seg.metadata, "apiDefinitionId") ?? "";
1497
1500
  const slug = structuralNodeSlug(
1498
1501
  ctx,
@@ -1500,7 +1503,6 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
1500
1503
  stripLeadingScopePrefix(seg.section, scopePrefix),
1501
1504
  scopePrefix
1502
1505
  );
1503
- const metaPointsTo = metaStr(seg.metadata, "pointsTo");
1504
1506
  const children = buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
1505
1507
  const changelog = attachedApiChangelogNode(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
1506
1508
  return {
@@ -1523,7 +1525,9 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
1523
1525
  paginated: metaBool(seg.metadata, "paginated"),
1524
1526
  showErrors: metaBool(seg.metadata, "showErrors"),
1525
1527
  hideTitle: metaBool(seg.metadata, "hideTitle"),
1526
- pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
1528
+ // Don't read pointsTo from metadata; let mutableUpdatePointsTo
1529
+ // compute it via followRedirect, matching v2 behavior.
1530
+ pointsTo: void 0,
1527
1531
  children,
1528
1532
  changelog,
1529
1533
  playground: void 0,
@@ -1981,13 +1985,19 @@ function buildFullRootFromSegments(options) {
1981
1985
  }
1982
1986
  let rootPointsTo;
1983
1987
  if (child.type === "productgroup") {
1984
- const defaultProduct = child.children.find((p) => p.default) ?? child.children[0];
1985
- rootPointsTo = defaultProduct?.type === "product" ? defaultProduct.pointsTo : void 0;
1988
+ if (child.landingPage != null && !child.landingPage.hidden) {
1989
+ rootPointsTo = child.landingPage.slug;
1990
+ } else {
1991
+ const defaultProduct = child.children.find((p) => p.default) ?? child.children[0];
1992
+ rootPointsTo = defaultProduct?.type === "product" ? defaultProduct.pointsTo : void 0;
1993
+ }
1986
1994
  } else if (child.type === "versioned") {
1987
1995
  const defaultVersion = child.children.find((v) => v.default) ?? child.children[0];
1988
1996
  rootPointsTo = defaultVersion?.pointsTo;
1989
1997
  } else if (child.type === "unversioned") {
1990
- if (tabs.length > 0) {
1998
+ if (child.landingPage != null && !child.landingPage.hidden) {
1999
+ rootPointsTo = child.landingPage.slug;
2000
+ } else if (tabs.length > 0) {
1991
2001
  const firstTab = tabs[0];
1992
2002
  const pt = firstTab != null ? metaStr(firstTab.metadata, "pointsTo") : void 0;
1993
2003
  rootPointsTo = pt != null ? pointsToSlug(pt) : void 0;
@@ -2185,7 +2195,7 @@ function buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix) {
2185
2195
  }
2186
2196
  function buildUnversioned(ctx, scopeSegs, scopePrefix, tabsPresent) {
2187
2197
  const first = scopeSegs[0];
2188
- return {
2198
+ const node = {
2189
2199
  type: "unversioned",
2190
2200
  id: ctx.nodeId(`unversioned:${first?.seg.product?.id ?? "root"}`),
2191
2201
  collapsed: void 0,
@@ -2195,6 +2205,8 @@ function buildUnversioned(ctx, scopeSegs, scopePrefix, tabsPresent) {
2195
2205
  // namespace.
2196
2206
  child: buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix)
2197
2207
  };
2208
+ markWithinScopeCanonicalSlugs(node);
2209
+ return node;
2198
2210
  }
2199
2211
  function mergeSharedSections(defaultSegs, allScoped, defaultVersion, versionSlugs) {
2200
2212
  const defaultTabsByName = /* @__PURE__ */ new Map();
@@ -2278,6 +2290,7 @@ function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix, skipShar
2278
2290
  // version subtree stays inside the default-version prune window.
2279
2291
  child: buildTabbedOrSidebar(ctx, versionSegs, tabsPresent, asSlug(slug))
2280
2292
  };
2293
+ markWithinScopeCanonicalSlugs(node);
2281
2294
  if (node.default) {
2282
2295
  markDefaultVersionCanonicalSlugs(node, productPrefix != null ? asSlug(productPrefix) : rootSlug, node.slug);
2283
2296
  }
@@ -2388,6 +2401,34 @@ function buildLandingPage(ctx, scopeSegs) {
2388
2401
  landingSegment?.nav.find((route) => route.type === "markdown")
2389
2402
  );
2390
2403
  }
2404
+ function markWithinScopeCanonicalSlugs(scopeNode) {
2405
+ const keyToCanonical = /* @__PURE__ */ new Map();
2406
+ traverseDF(scopeNode, (child, parents) => {
2407
+ if (hasMetadata(child) && isPage(child)) {
2408
+ const keys = crossVersionDedupKeys(child, parents);
2409
+ let matched = false;
2410
+ for (const key of keys) {
2411
+ const canonical = keyToCanonical.get(key);
2412
+ if (canonical != null && canonical !== child.slug) {
2413
+ if (child.slug.startsWith(canonical + "/")) {
2414
+ continue;
2415
+ }
2416
+ child.canonicalSlug = canonical;
2417
+ matched = true;
2418
+ break;
2419
+ }
2420
+ }
2421
+ if (!matched) {
2422
+ const slug = child.canonicalSlug ?? child.slug;
2423
+ for (const key of keys) {
2424
+ if (!keyToCanonical.has(key)) {
2425
+ keyToCanonical.set(key, slug);
2426
+ }
2427
+ }
2428
+ }
2429
+ }
2430
+ });
2431
+ }
2391
2432
  function markCrossVersionCanonicalSlugs(versionNodes) {
2392
2433
  const keyToCanonical = /* @__PURE__ */ new Map();
2393
2434
  const sorted = [...versionNodes].sort((a, b) => {
@@ -2404,6 +2445,9 @@ function markCrossVersionCanonicalSlugs(versionNodes) {
2404
2445
  for (const key of keys) {
2405
2446
  const canonical = keyToCanonical.get(key);
2406
2447
  if (canonical != null && !version.default) {
2448
+ if (child.slug.startsWith(canonical + "/")) {
2449
+ continue;
2450
+ }
2407
2451
  child.canonicalSlug = canonical;
2408
2452
  matched = true;
2409
2453
  break;
@@ -2481,11 +2525,14 @@ function markCrossProductCanonicalSlugs(productNodes) {
2481
2525
  return;
2482
2526
  }
2483
2527
  const key = `pid:${pid}`;
2484
- const canonical = pageIdToCanonical.get(key);
2485
- if (canonical != null && !product.default) {
2486
- child.canonicalSlug = canonical;
2487
- } else if (canonical == null) {
2488
- pageIdToCanonical.set(key, child.canonicalSlug ?? child.slug);
2528
+ const entry = pageIdToCanonical.get(key);
2529
+ if (entry != null && !product.default && entry.productId !== product.productId) {
2530
+ child.canonicalSlug = entry.slug;
2531
+ } else if (entry == null) {
2532
+ pageIdToCanonical.set(key, {
2533
+ slug: child.canonicalSlug ?? child.slug,
2534
+ productId: product.productId
2535
+ });
2489
2536
  }
2490
2537
  }
2491
2538
  });