@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
@@ -1347,7 +1347,7 @@ function mergeChildrenByPosition(ctx, nav, sectionChildren) {
1347
1347
  function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
1348
1348
  const { seg, nav } = scoped;
1349
1349
  const overview = overviewRoute(nav) ?? overviewRouteFromSegmentMeta(seg, nav);
1350
- const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
1350
+ const overviewPageId = metaStr(seg.metadata, "overviewPageId");
1351
1351
  const relSection = stripLeadingScopePrefix(seg.section, scopePrefix);
1352
1352
  let slug = structuralNodeSlug(ctx, overview?.fullPath, relSection, scopePrefix);
1353
1353
  if (relSection === "" && overview?.fullPath == null) {
@@ -1360,7 +1360,6 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
1360
1360
  }
1361
1361
  }
1362
1362
  }
1363
- const metaPointsTo = metaStr(seg.metadata, "pointsTo");
1364
1363
  const defaults = withMetadataDefaults({
1365
1364
  id: ctx.nodeId(`section:${slug}`),
1366
1365
  title: metaStr(seg.metadata, "title") ?? "",
@@ -1381,7 +1380,10 @@ function sectionNode(ctx, scoped, sectionChildren, scopePrefix) {
1381
1380
  collapsible: metaBool(seg.metadata, "collapsible") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
1382
1381
  collapsedByDefault: metaBool(seg.metadata, "collapsedByDefault") ?? (metaCollapsed(seg.metadata) === true ? true : void 0),
1383
1382
  availability: metaAvailability(seg.metadata),
1384
- pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
1383
+ // Don't read pointsTo from metadata for sections; let
1384
+ // mutableUpdatePointsTo compute it via followRedirect so that
1385
+ // self-referencing redirects are cleared, matching v2 behavior.
1386
+ pointsTo: void 0,
1385
1387
  children: mergeChildrenByPosition(ctx, nav, sectionChildren)
1386
1388
  };
1387
1389
  }
@@ -1446,7 +1448,7 @@ function buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix)
1446
1448
  function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scopePrefix) {
1447
1449
  const { seg, nav } = scoped;
1448
1450
  const overview = overviewRoute(nav);
1449
- const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
1451
+ const overviewPageId = metaStr(seg.metadata, "overviewPageId");
1450
1452
  const apiDefinitionId = metaStr(seg.metadata, "apiDefinitionId") ?? parentApiDefinitionId;
1451
1453
  const slug = structuralNodeSlug(
1452
1454
  ctx,
@@ -1454,7 +1456,6 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
1454
1456
  stripLeadingScopePrefix(seg.section, scopePrefix),
1455
1457
  scopePrefix
1456
1458
  );
1457
- const metaPointsTo = metaStr(seg.metadata, "pointsTo");
1458
1459
  const children = buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
1459
1460
  return {
1460
1461
  type: "apiPackage",
@@ -1473,7 +1474,9 @@ function apiPackageChildNode(ctx, scoped, scopeSegs, parentApiDefinitionId, scop
1473
1474
  availability: metaAvailability(seg.metadata),
1474
1475
  overviewPageId: overviewPageId != null ? PageId(overviewPageId) : void 0,
1475
1476
  noindex: metaBool(overview?.metadata, "noindex") ?? metaBool(seg.metadata, "noindex"),
1476
- pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
1477
+ // Don't read pointsTo from metadata; let mutableUpdatePointsTo
1478
+ // compute it via followRedirect, matching v2 behavior.
1479
+ pointsTo: void 0,
1477
1480
  children,
1478
1481
  playground: void 0
1479
1482
  };
@@ -1533,7 +1536,7 @@ function mergeEndpointPairs(ctx, leafNodes, allNav) {
1533
1536
  function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
1534
1537
  const { seg, nav } = scoped;
1535
1538
  const overview = overviewRoute(nav);
1536
- const overviewPageId = overview != null ? metaStr(overview.metadata, "pageId") : void 0;
1539
+ const overviewPageId = metaStr(seg.metadata, "overviewPageId");
1537
1540
  const apiDefinitionId = metaStr(seg.metadata, "apiDefinitionId") ?? "";
1538
1541
  const slug = structuralNodeSlug(
1539
1542
  ctx,
@@ -1541,7 +1544,6 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
1541
1544
  stripLeadingScopePrefix(seg.section, scopePrefix),
1542
1545
  scopePrefix
1543
1546
  );
1544
- const metaPointsTo = metaStr(seg.metadata, "pointsTo");
1545
1547
  const children = buildApiChildren(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
1546
1548
  const changelog = attachedApiChangelogNode(ctx, scoped, scopeSegs, apiDefinitionId, scopePrefix);
1547
1549
  return {
@@ -1564,7 +1566,9 @@ function apiReferenceNode(ctx, scoped, scopeSegs, scopePrefix) {
1564
1566
  paginated: metaBool(seg.metadata, "paginated"),
1565
1567
  showErrors: metaBool(seg.metadata, "showErrors"),
1566
1568
  hideTitle: metaBool(seg.metadata, "hideTitle"),
1567
- pointsTo: metaPointsTo != null ? pointsToSlug(metaPointsTo) : void 0,
1569
+ // Don't read pointsTo from metadata; let mutableUpdatePointsTo
1570
+ // compute it via followRedirect, matching v2 behavior.
1571
+ pointsTo: void 0,
1568
1572
  children,
1569
1573
  changelog,
1570
1574
  playground: void 0,
@@ -2022,13 +2026,19 @@ function buildFullRootFromSegments(options) {
2022
2026
  }
2023
2027
  let rootPointsTo;
2024
2028
  if (child.type === "productgroup") {
2025
- const defaultProduct = child.children.find((p) => p.default) ?? child.children[0];
2026
- rootPointsTo = defaultProduct?.type === "product" ? defaultProduct.pointsTo : void 0;
2029
+ if (child.landingPage != null && !child.landingPage.hidden) {
2030
+ rootPointsTo = child.landingPage.slug;
2031
+ } else {
2032
+ const defaultProduct = child.children.find((p) => p.default) ?? child.children[0];
2033
+ rootPointsTo = defaultProduct?.type === "product" ? defaultProduct.pointsTo : void 0;
2034
+ }
2027
2035
  } else if (child.type === "versioned") {
2028
2036
  const defaultVersion = child.children.find((v) => v.default) ?? child.children[0];
2029
2037
  rootPointsTo = defaultVersion?.pointsTo;
2030
2038
  } else if (child.type === "unversioned") {
2031
- if (tabs.length > 0) {
2039
+ if (child.landingPage != null && !child.landingPage.hidden) {
2040
+ rootPointsTo = child.landingPage.slug;
2041
+ } else if (tabs.length > 0) {
2032
2042
  const firstTab = tabs[0];
2033
2043
  const pt = firstTab != null ? metaStr(firstTab.metadata, "pointsTo") : void 0;
2034
2044
  rootPointsTo = pt != null ? pointsToSlug(pt) : void 0;
@@ -2226,7 +2236,7 @@ function buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix) {
2226
2236
  }
2227
2237
  function buildUnversioned(ctx, scopeSegs, scopePrefix, tabsPresent) {
2228
2238
  const first = scopeSegs[0];
2229
- return {
2239
+ const node = {
2230
2240
  type: "unversioned",
2231
2241
  id: ctx.nodeId(`unversioned:${first?.seg.product?.id ?? "root"}`),
2232
2242
  collapsed: void 0,
@@ -2236,6 +2246,8 @@ function buildUnversioned(ctx, scopeSegs, scopePrefix, tabsPresent) {
2236
2246
  // namespace.
2237
2247
  child: buildTabbedOrSidebar(ctx, scopeSegs, tabsPresent, scopePrefix)
2238
2248
  };
2249
+ markWithinScopeCanonicalSlugs(node);
2250
+ return node;
2239
2251
  }
2240
2252
  function mergeSharedSections(defaultSegs, allScoped, defaultVersion, versionSlugs) {
2241
2253
  const defaultTabsByName = /* @__PURE__ */ new Map();
@@ -2319,6 +2331,7 @@ function buildVersioned(ctx, versions, scoped, rootSlug, productPrefix, skipShar
2319
2331
  // version subtree stays inside the default-version prune window.
2320
2332
  child: buildTabbedOrSidebar(ctx, versionSegs, tabsPresent, asSlug(slug))
2321
2333
  };
2334
+ markWithinScopeCanonicalSlugs(node);
2322
2335
  if (node.default) {
2323
2336
  markDefaultVersionCanonicalSlugs(node, productPrefix != null ? asSlug(productPrefix) : rootSlug, node.slug);
2324
2337
  }
@@ -2429,6 +2442,34 @@ function buildLandingPage(ctx, scopeSegs) {
2429
2442
  landingSegment?.nav.find((route) => route.type === "markdown")
2430
2443
  );
2431
2444
  }
2445
+ function markWithinScopeCanonicalSlugs(scopeNode) {
2446
+ const keyToCanonical = /* @__PURE__ */ new Map();
2447
+ traverseDF(scopeNode, (child, parents) => {
2448
+ if (hasMetadata(child) && isPage(child)) {
2449
+ const keys = crossVersionDedupKeys(child, parents);
2450
+ let matched = false;
2451
+ for (const key of keys) {
2452
+ const canonical = keyToCanonical.get(key);
2453
+ if (canonical != null && canonical !== child.slug) {
2454
+ if (child.slug.startsWith(canonical + "/")) {
2455
+ continue;
2456
+ }
2457
+ child.canonicalSlug = canonical;
2458
+ matched = true;
2459
+ break;
2460
+ }
2461
+ }
2462
+ if (!matched) {
2463
+ const slug = child.canonicalSlug ?? child.slug;
2464
+ for (const key of keys) {
2465
+ if (!keyToCanonical.has(key)) {
2466
+ keyToCanonical.set(key, slug);
2467
+ }
2468
+ }
2469
+ }
2470
+ }
2471
+ });
2472
+ }
2432
2473
  function markCrossVersionCanonicalSlugs(versionNodes) {
2433
2474
  const keyToCanonical = /* @__PURE__ */ new Map();
2434
2475
  const sorted = [...versionNodes].sort((a, b) => {
@@ -2445,6 +2486,9 @@ function markCrossVersionCanonicalSlugs(versionNodes) {
2445
2486
  for (const key of keys) {
2446
2487
  const canonical = keyToCanonical.get(key);
2447
2488
  if (canonical != null && !version.default) {
2489
+ if (child.slug.startsWith(canonical + "/")) {
2490
+ continue;
2491
+ }
2448
2492
  child.canonicalSlug = canonical;
2449
2493
  matched = true;
2450
2494
  break;
@@ -2522,11 +2566,14 @@ function markCrossProductCanonicalSlugs(productNodes) {
2522
2566
  return;
2523
2567
  }
2524
2568
  const key = `pid:${pid}`;
2525
- const canonical = pageIdToCanonical.get(key);
2526
- if (canonical != null && !product.default) {
2527
- child.canonicalSlug = canonical;
2528
- } else if (canonical == null) {
2529
- pageIdToCanonical.set(key, child.canonicalSlug ?? child.slug);
2569
+ const entry = pageIdToCanonical.get(key);
2570
+ if (entry != null && !product.default && entry.productId !== product.productId) {
2571
+ child.canonicalSlug = entry.slug;
2572
+ } else if (entry == null) {
2573
+ pageIdToCanonical.set(key, {
2574
+ slug: child.canonicalSlug ?? child.slug,
2575
+ productId: product.productId
2576
+ });
2530
2577
  }
2531
2578
  }
2532
2579
  });