@fern-api/fdr-sdk 1.2.79-88e3cf0ca5 → 1.2.80-050d6c9417

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 (82) hide show
  1. package/dist/js/client/FdrClient.js +13 -3
  2. package/dist/js/client/FdrClient.js.map +1 -1
  3. package/dist/js/client/FdrClient.mjs +13 -3
  4. package/dist/js/client/FdrClient.mjs.map +1 -1
  5. package/dist/js/client/types.js.map +1 -1
  6. package/dist/js/client/types.mjs.map +1 -1
  7. package/dist/js/converters/index.js +39 -25
  8. package/dist/js/converters/index.js.map +1 -1
  9. package/dist/js/converters/index.mjs +39 -25
  10. package/dist/js/converters/index.mjs.map +1 -1
  11. package/dist/js/index.js +52 -28
  12. package/dist/js/index.js.map +1 -1
  13. package/dist/js/index.mjs +52 -28
  14. package/dist/js/index.mjs.map +1 -1
  15. package/dist/js/navigation/index.js +39 -25
  16. package/dist/js/navigation/index.js.map +1 -1
  17. package/dist/js/navigation/index.mjs +39 -25
  18. package/dist/js/navigation/index.mjs.map +1 -1
  19. package/dist/js/navigation/ledger-root-builder.js +29 -5
  20. package/dist/js/navigation/ledger-root-builder.js.map +1 -1
  21. package/dist/js/navigation/ledger-root-builder.mjs +29 -5
  22. package/dist/js/navigation/ledger-root-builder.mjs.map +1 -1
  23. package/dist/js/navigation/types/latest.js.map +1 -1
  24. package/dist/js/navigation/types/latest.mjs.map +1 -1
  25. package/dist/js/navigation/types/v1.js.map +1 -1
  26. package/dist/js/navigation/types/v1.mjs.map +1 -1
  27. package/dist/js/orpc-client.js +13 -3
  28. package/dist/js/orpc-client.js.map +1 -1
  29. package/dist/js/orpc-client.mjs +13 -3
  30. package/dist/js/orpc-client.mjs.map +1 -1
  31. package/dist/navigation/__test__/ledger-root-builder.playgroundPreservation.test.d.ts +2 -0
  32. package/dist/navigation/__test__/ledger-root-builder.playgroundPreservation.test.d.ts.map +1 -0
  33. package/dist/navigation/__test__/ledger-root-builder.playgroundPreservation.test.js +185 -0
  34. package/dist/navigation/__test__/ledger-root-builder.playgroundPreservation.test.js.map +1 -0
  35. package/dist/navigation/ledger-root-builder.d.ts.map +1 -1
  36. package/dist/navigation/ledger-root-builder.js +41 -5
  37. package/dist/navigation/ledger-root-builder.js.map +1 -1
  38. package/dist/navigation/types/latest.d.ts +1 -0
  39. package/dist/navigation/types/latest.d.ts.map +1 -1
  40. package/dist/navigation/types/v1.d.ts +1 -0
  41. package/dist/navigation/types/v1.d.ts.map +1 -1
  42. package/dist/navigation/utils/__test__/resolveCurrentTab.test.d.ts +2 -0
  43. package/dist/navigation/utils/__test__/resolveCurrentTab.test.d.ts.map +1 -0
  44. package/dist/navigation/utils/__test__/resolveCurrentTab.test.js +70 -0
  45. package/dist/navigation/utils/__test__/resolveCurrentTab.test.js.map +1 -0
  46. package/dist/navigation/utils/findNode.d.ts.map +1 -1
  47. package/dist/navigation/utils/findNode.js +3 -30
  48. package/dist/navigation/utils/findNode.js.map +1 -1
  49. package/dist/navigation/utils/index.d.ts +1 -0
  50. package/dist/navigation/utils/index.d.ts.map +1 -1
  51. package/dist/navigation/utils/index.js +1 -0
  52. package/dist/navigation/utils/index.js.map +1 -1
  53. package/dist/navigation/utils/resolveCurrentTab.d.ts +26 -0
  54. package/dist/navigation/utils/resolveCurrentTab.d.ts.map +1 -0
  55. package/dist/navigation/utils/resolveCurrentTab.js +60 -0
  56. package/dist/navigation/utils/resolveCurrentTab.js.map +1 -0
  57. package/dist/orpc-client/docs-ledger/contract.d.ts +5126 -0
  58. package/dist/orpc-client/docs-ledger/contract.d.ts.map +1 -1
  59. package/dist/orpc-client/docs-ledger/contract.js +17 -3
  60. package/dist/orpc-client/docs-ledger/contract.js.map +1 -1
  61. package/dist/orpc-client/docs-ledger/ledger-manifest.d.ts +7356 -0
  62. package/dist/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
  63. package/dist/tsconfig.tsbuildinfo +1 -1
  64. package/dist/types/navigation/__test__/ledger-root-builder.playgroundPreservation.test.d.ts +2 -0
  65. package/dist/types/navigation/__test__/ledger-root-builder.playgroundPreservation.test.d.ts.map +1 -0
  66. package/dist/types/navigation/ledger-root-builder.d.ts.map +1 -1
  67. package/dist/types/navigation/types/latest.d.ts +1 -0
  68. package/dist/types/navigation/types/latest.d.ts.map +1 -1
  69. package/dist/types/navigation/types/v1.d.ts +1 -0
  70. package/dist/types/navigation/types/v1.d.ts.map +1 -1
  71. package/dist/types/navigation/utils/__test__/resolveCurrentTab.test.d.ts +2 -0
  72. package/dist/types/navigation/utils/__test__/resolveCurrentTab.test.d.ts.map +1 -0
  73. package/dist/types/navigation/utils/findNode.d.ts.map +1 -1
  74. package/dist/types/navigation/utils/index.d.ts +1 -0
  75. package/dist/types/navigation/utils/index.d.ts.map +1 -1
  76. package/dist/types/navigation/utils/resolveCurrentTab.d.ts +26 -0
  77. package/dist/types/navigation/utils/resolveCurrentTab.d.ts.map +1 -0
  78. package/dist/types/orpc-client/docs-ledger/contract.d.ts +5126 -0
  79. package/dist/types/orpc-client/docs-ledger/contract.d.ts.map +1 -1
  80. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts +7356 -0
  81. package/dist/types/orpc-client/docs-ledger/ledger-manifest.d.ts.map +1 -1
  82. package/package.json +1 -1
package/dist/js/index.js CHANGED
@@ -9423,6 +9423,13 @@ var FeatureFlagMetadataSchema = z21.array(
9423
9423
  );
9424
9424
  var LinkTargetSchema2 = z21.enum(["_blank", "_self", "_parent", "_top"]);
9425
9425
  var CollapsedSchema = z21.union([z21.boolean(), z21.literal("open-by-default")]);
9426
+ var PlaygroundSettingsSchema = z21.object({
9427
+ hidden: z21.boolean().optional(),
9428
+ environments: z21.array(z21.string()).optional(),
9429
+ button: z21.object({ href: z21.string().optional() }).optional(),
9430
+ "limit-websocket-messages-per-connection": z21.number().optional(),
9431
+ "send-optional-defaults": z21.boolean().optional()
9432
+ });
9426
9433
  var LedgerAvailabilitySchema = z21.union([
9427
9434
  AvailabilitySchema,
9428
9435
  z21.enum([
@@ -9464,7 +9471,8 @@ var NodeMetadataFields = {
9464
9471
  var ApiNodeMetadataFields = {
9465
9472
  ...NodeMetadataFields,
9466
9473
  apiDefinitionId: z21.string(),
9467
- availability: LedgerAvailabilitySchema.optional()
9474
+ availability: LedgerAvailabilitySchema.optional(),
9475
+ playground: PlaygroundSettingsSchema.optional()
9468
9476
  };
9469
9477
  var LedgerSegmentDetailMetadataObjectSchema = LedgerMetadataBaseSchema.extend({
9470
9478
  slug: z21.string().optional(),
@@ -9514,7 +9522,8 @@ var LedgerSegmentMetadataObjectSchema = z21.discriminatedUnion("type", [
9514
9522
  hideTitle: z21.boolean().optional(),
9515
9523
  viewers: MetadataStringArraySchema.optional(),
9516
9524
  orphaned: z21.boolean().optional(),
9517
- featureFlags: FeatureFlagMetadataSchema.optional()
9525
+ featureFlags: FeatureFlagMetadataSchema.optional(),
9526
+ playground: PlaygroundSettingsSchema.optional()
9518
9527
  }),
9519
9528
  LedgerMetadataBaseSchema.extend({
9520
9529
  type: z21.literal("apiPackage"),
@@ -9528,7 +9537,8 @@ var LedgerSegmentMetadataObjectSchema = z21.discriminatedUnion("type", [
9528
9537
  pointsTo: z21.string().optional(),
9529
9538
  viewers: MetadataStringArraySchema.optional(),
9530
9539
  orphaned: z21.boolean().optional(),
9531
- featureFlags: FeatureFlagMetadataSchema.optional()
9540
+ featureFlags: FeatureFlagMetadataSchema.optional(),
9541
+ playground: PlaygroundSettingsSchema.optional()
9532
9542
  }),
9533
9543
  LedgerMetadataBaseSchema.extend({
9534
9544
  type: z21.literal("changelog"),
@@ -19698,8 +19708,10 @@ __export(utils_exports, {
19698
19708
  createBreadcrumb: () => createBreadcrumb,
19699
19709
  findNode: () => findNode,
19700
19710
  getApiReferenceId: () => getApiReferenceId,
19711
+ getEnclosingTabbedNode: () => getEnclosingTabbedNode,
19701
19712
  getNoIndexFromFrontmatter: () => getNoIndexFromFrontmatter,
19702
19713
  mutableUpdatePointsTo: () => mutableUpdatePointsTo,
19714
+ resolveCurrentTab: () => resolveCurrentTab,
19703
19715
  stripSyntheticSegments: () => stripSyntheticSegments,
19704
19716
  toApis: () => toApis,
19705
19717
  toPages: () => toPages,
@@ -19845,6 +19857,41 @@ function createBreadcrumb(nodes) {
19845
19857
 
19846
19858
  // src/navigation/utils/findNode.ts
19847
19859
  var import_string8 = require("es-toolkit/string");
19860
+
19861
+ // src/navigation/utils/resolveCurrentTab.ts
19862
+ var isHeaderTab = (child) => child.type === "tab" || child.type === "changelog";
19863
+ function getEnclosingTabbedNode(parents) {
19864
+ const versionChild = (parents.find(isVersionNode) ?? parents.find(isUnversionedNode))?.child;
19865
+ return parents.find(isTabbedNode) ?? (versionChild != null && isTabbedNode(versionChild) ? versionChild : void 0);
19866
+ }
19867
+ function resolveCurrentTab(node, parents) {
19868
+ const tabbedNode = getEnclosingTabbedNode(parents);
19869
+ if (tabbedNode == null) {
19870
+ return void 0;
19871
+ }
19872
+ const parentsAndNode = [...parents, node];
19873
+ const tabbedNodeIndex = parentsAndNode.indexOf(tabbedNode);
19874
+ const currentTabNode = tabbedNodeIndex !== -1 ? parentsAndNode[tabbedNodeIndex + 1] : void 0;
19875
+ let currentTab = currentTabNode?.type === "tab" || currentTabNode?.type === "changelog" ? currentTabNode : void 0;
19876
+ if (currentTab == null) {
19877
+ for (const tab of tabbedNode.children) {
19878
+ if (tab.type === "tab" && tab.pointsTo === node.slug) {
19879
+ currentTab = tab;
19880
+ break;
19881
+ }
19882
+ if (tab.type === "changelog" && tab.slug === node.slug) {
19883
+ currentTab = tab;
19884
+ break;
19885
+ }
19886
+ }
19887
+ if (currentTab == null && node.type === "landingPage") {
19888
+ currentTab = tabbedNode.children.find(isHeaderTab);
19889
+ }
19890
+ }
19891
+ return currentTab;
19892
+ }
19893
+
19894
+ // src/navigation/utils/findNode.ts
19848
19895
  function findNode(root, slug) {
19849
19896
  const collector = NodeCollector.collect(root);
19850
19897
  const found = collector.getSlugMapWithParents().get(canonicalSlugKey(slug));
@@ -19878,7 +19925,6 @@ function findNode(root, slug) {
19878
19925
  const currentProduct = found.parents.find(isProductNode);
19879
19926
  const currentVersion = found.parents.find(isVersionNode);
19880
19927
  const unversionedNode = found.parents.find(isUnversionedNode);
19881
- const versionChild = (currentVersion ?? unversionedNode)?.child;
19882
19928
  const currentVariant = found.parents.find(isVariantNode);
19883
19929
  if (!sidebar && currentVersion != null) {
19884
19930
  if (isSidebarRootNode(currentVersion.child)) {
@@ -19886,13 +19932,9 @@ function findNode(root, slug) {
19886
19932
  }
19887
19933
  }
19888
19934
  const landingPage = (currentProductGroup ?? currentVersion ?? unversionedNode)?.landingPage;
19889
- const tabbedNode = found.parents.find(isTabbedNode) ?? // fallback to the version child because the current node may be a landing page
19890
- (versionChild != null && isTabbedNode(versionChild) ? versionChild : void 0);
19935
+ const tabbedNode = getEnclosingTabbedNode(found.parents);
19891
19936
  const apiReference = found.parents.find(isApiReferenceNode) ?? (found.node.type === "apiReference" ? found.node : void 0);
19892
19937
  if (navigation_exports.isPage(found.node)) {
19893
- const parentsAndNode = [...found.parents, found.node];
19894
- const tabbedNodeIndex = parentsAndNode.findIndex((node) => node === tabbedNode);
19895
- const currentTabNode = tabbedNodeIndex !== -1 ? parentsAndNode[tabbedNodeIndex + 1] : void 0;
19896
19938
  const products = collector.getProductNodes().map((node) => {
19897
19939
  if (node.default) {
19898
19940
  if (node.id === currentProduct?.id) {
@@ -19920,25 +19962,7 @@ function findNode(root, slug) {
19920
19962
  }
19921
19963
  return node;
19922
19964
  });
19923
- let currentTab = currentTabNode?.type === "tab" || currentTabNode?.type === "changelog" ? currentTabNode : void 0;
19924
- if (currentTab == null && tabbedNode != null) {
19925
- for (const tab of tabbedNode.children) {
19926
- if (tab.type === "tab" && tab.pointsTo === found.node.slug) {
19927
- currentTab = tab;
19928
- break;
19929
- }
19930
- if (tab.type === "changelog" && tab.slug === found.node.slug) {
19931
- currentTab = tab;
19932
- break;
19933
- }
19934
- }
19935
- if (currentTab == null && found.node.type === "landingPage") {
19936
- const firstTab = tabbedNode.children.find((tab) => tab.type === "tab" || tab.type === "changelog");
19937
- if (firstTab != null && (firstTab.type === "tab" || firstTab.type === "changelog")) {
19938
- currentTab = firstTab;
19939
- }
19940
- }
19941
- }
19965
+ const currentTab = resolveCurrentTab(found.node, found.parents);
19942
19966
  const slugPrefix = currentVariant?.slug ?? (currentProduct?.type === "product" ? currentProduct.slug : void 0) ?? currentVersion?.slug ?? root.slug;
19943
19967
  const unversionedSlug = navigation_exports.Slug(
19944
19968
  found.node.slug.replace(new RegExp(`^${(0, import_string8.escapeRegExp)(slugPrefix)}/`), "")