@fern-api/fdr-sdk 1.2.36-eaea1f74f7 → 1.2.37-159d98cf30

package/dist/js/client/FdrClient.mjs

@@ -3540,7 +3540,17 @@ var PageBlobRefSchema = z21.object({
   /** SHA-256 hex of the page content bytes. */
   hash: z21.string(),
   contentType: z21.string().default("text/markdown"),
-  contentLength: z21.number()
+  contentLength: z21.number(),
+  /**
+   * Bare `fullPath`s of the file/image artifacts this page's rendered
+   * markdown references (the `<fullPath>` of each `file:<fullPath>` token).
+   * Captured CLI-side from the already-rewritten page markdown (same `file:`
+   * regex the bundle serializer uses) so FDR can materialise the page→file
+   * join into the route shards without re-fetching or re-parsing content
+   * (ADR 0016, "File metadata on the render path"). Optional — older CLIs
+   * omit it and the page simply contributes no shard-side file identities.
+   */
+  referencedFiles: z21.array(z21.string()).optional()
 });
 var FileManifestEntrySchema = z21.object({
   /** SHA-256 hex of the file bytes (= CAS content hash). */
@@ -3570,6 +3580,21 @@ var BackgroundColorSchema = z21.discriminatedUnion("type", [
   z21.object({ type: z21.literal("solid"), ...RgbaSchema.shape }),
   z21.object({ type: z21.literal("gradient") })
 ]);
+var ACCENT_SCALE_KEYS = [
+  "accent1",
+  "accent2",
+  "accent3",
+  "accent4",
+  "accent5",
+  "accent6",
+  "accent7",
+  "accent8",
+  "accent9",
+  "accent10",
+  "accent11",
+  "accent12"
+];
+var accentScaleShape = Object.fromEntries(ACCENT_SCALE_KEYS.map((key) => [key, RgbaSchema.optional()]));
 var LedgerThemeConfigSchema = z21.object({
   logo: ImageRefSchema.optional(),
   backgroundImage: z21.string().optional(),
@@ -3579,18 +3604,7 @@ var LedgerThemeConfigSchema = z21.object({
   sidebarBackground: RgbaSchema.optional(),
   headerBackground: RgbaSchema.optional(),
   cardBackground: RgbaSchema.optional(),
-  accent1: RgbaSchema.optional(),
-  accent2: RgbaSchema.optional(),
-  accent3: RgbaSchema.optional(),
-  accent4: RgbaSchema.optional(),
-  accent5: RgbaSchema.optional(),
-  accent6: RgbaSchema.optional(),
-  accent7: RgbaSchema.optional(),
-  accent8: RgbaSchema.optional(),
-  accent9: RgbaSchema.optional(),
-  accent10: RgbaSchema.optional(),
-  accent11: RgbaSchema.optional(),
-  accent12: RgbaSchema.optional()
+  ...accentScaleShape
 });
 var LedgerColorsConfigSchema = z21.discriminatedUnion("type", [
   z21.object({ type: z21.literal("dark"), ...LedgerThemeConfigSchema.shape }),
@@ -3644,6 +3658,14 @@ var LedgerMetadataConfigSchema = z21.record(z21.string(), z21.unknown()).and(
     "og:dynamic:background-image": PathOrUrlSchema.optional()
   })
 );
+var NavbarLinksFieldSchema = z21.array(NavbarLinkSchema);
+var FooterLinksFieldSchema = z21.array(FooterLinkSchema);
+var LayoutFieldSchema = DocsLayoutConfigSchema;
+var ThemeFieldSchema = DocsThemeConfigSchema;
+var SettingsFieldSchema = DocsSettingsConfigSchema;
+var AnalyticsFieldSchema = AnalyticsConfigSchema;
+var AIChatFieldSchema = AIChatConfigSchema;
+var PageActionsFieldSchema = PageActionsConfigSchema;
 var LedgerAgentsConfigSchema = z21.object({
   pageDirective: z21.string().optional(),
   pageDescriptionSource: z21.enum(["description", "subtitle"]).optional(),
@@ -3657,31 +3679,272 @@ var LedgerConfigSchema = z21.object({
     translations: z21.array(z21.string()).optional()
   }).optional(),
   announcement: z21.object({ text: z21.string() }).optional(),
-  navbarLinks: z21.array(z21.unknown()).optional(),
-  footerLinks: z21.array(z21.unknown()).optional(),
+  navbarLinks: NavbarLinksFieldSchema.optional(),
+  footerLinks: FooterLinksFieldSchema.optional(),
   logoHeight: z21.number().optional(),
   logoHref: z21.string().optional(),
   logoRightText: z21.string().optional(),
+  /** fullPath of the favicon file artifact (any extension: .svg/.png/.ico). */
+  favicon: z21.string().nullish(),
   agents: LedgerAgentsConfigSchema.optional(),
   metadata: LedgerMetadataConfigSchema.optional(),
   redirects: z21.array(z21.object({ source: z21.string(), destination: z21.string(), permanent: z21.boolean().optional() })).optional(),
   colorsV3: LedgerColorsConfigSchema.optional(),
-  layout: z21.record(z21.string(), z21.unknown()).optional(),
-  theme: z21.record(z21.string(), z21.unknown()).optional(),
-  settings: z21.record(z21.string(), z21.unknown()).optional(),
+  layout: LayoutFieldSchema.optional(),
+  theme: ThemeFieldSchema.optional(),
+  settings: SettingsFieldSchema.optional(),
   typographyV2: LedgerTypographySchema.optional(),
-  analyticsConfig: z21.record(z21.string(), z21.unknown()).optional(),
+  analyticsConfig: AnalyticsFieldSchema.optional(),
   integrations: z21.object({
     intercom: z21.string().optional()
   }).optional(),
   css: z21.object({ inline: z21.array(z21.string()).optional() }).optional(),
   js: LedgerJsConfigSchema.optional(),
-  aiChatConfig: z21.record(z21.string(), z21.unknown()).optional(),
-  pageActions: z21.record(z21.string(), z21.unknown()).optional(),
+  aiChatConfig: AIChatFieldSchema.optional(),
+  pageActions: PageActionsFieldSchema.optional(),
   editThisPageLaunch: z21.enum(["github", "dashboard"]).optional(),
   header: z21.string().optional(),
   footer: z21.string().optional()
 });
+var MetadataStringArraySchema = z21.array(z21.string());
+var FeatureFlagMetadataSchema = z21.array(
+  z21.union([
+    z21.string(),
+    z21.object({
+      flag: z21.string(),
+      fallbackValue: z21.unknown().optional(),
+      match: z21.unknown().optional()
+    })
+  ])
+);
+var LinkTargetSchema2 = z21.enum(["_blank", "_self", "_parent", "_top"]);
+var CollapsedSchema = z21.union([z21.boolean(), z21.literal("open-by-default")]);
+var LedgerAvailabilitySchema = z21.union([
+  AvailabilitySchema,
+  z21.enum([
+    "alpha",
+    "stable",
+    "generally-available",
+    "in-development",
+    "pre-release",
+    "beta",
+    "preview",
+    "deprecated",
+    "legacy"
+  ])
+]);
+var LedgerArtifactTypeSchema = z21.enum([
+  "markdown",
+  "page",
+  "rest",
+  "asyncapi",
+  "webhook",
+  "grpc",
+  "graphql",
+  "changelog",
+  "link",
+  "file",
+  "image",
+  "redirect"
+]);
+var LedgerMetadataBaseSchema = z21.object({}).passthrough();
+var NodeMetadataFields = {
+  title: z21.string().optional(),
+  slug: z21.string().optional(),
+  icon: z21.string().optional(),
+  viewers: MetadataStringArraySchema.optional(),
+  orphaned: z21.boolean().optional(),
+  featureFlags: FeatureFlagMetadataSchema.optional()
+};
+var ApiNodeMetadataFields = {
+  ...NodeMetadataFields,
+  apiDefinitionId: z21.string(),
+  availability: LedgerAvailabilitySchema.optional()
+};
+var LedgerSegmentDetailMetadataObjectSchema = LedgerMetadataBaseSchema.extend({
+  slug: z21.string().optional(),
+  default: z21.boolean().optional(),
+  subtitle: z21.string().optional(),
+  href: z21.string().optional(),
+  url: z21.string().optional(),
+  target: LinkTargetSchema2.optional(),
+  image: z21.string().optional(),
+  pointsTo: z21.string().optional(),
+  availability: LedgerAvailabilitySchema.optional(),
+  tab_type: z21.enum(["tab", "link", "changelog"]).optional()
+});
+var LedgerSegmentDetailMetadataSchema = LedgerSegmentDetailMetadataObjectSchema.nullable();
+var LedgerSegmentMetadataObjectSchema = z21.discriminatedUnion("type", [
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("tabRoot")
+  }),
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("section"),
+    title: z21.string().optional(),
+    icon: z21.string().optional(),
+    collapsed: CollapsedSchema.optional(),
+    collapsible: z21.boolean().optional(),
+    collapsedByDefault: z21.boolean().optional(),
+    availability: LedgerAvailabilitySchema.optional(),
+    overviewPageId: z21.string().optional(),
+    pointsTo: z21.string().optional(),
+    viewers: MetadataStringArraySchema.optional()
+  }),
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("apiReference"),
+    title: z21.string().optional(),
+    icon: z21.string().optional(),
+    apiDefinitionId: z21.string().optional(),
+    overviewPageId: z21.string().optional(),
+    availability: LedgerAvailabilitySchema.optional(),
+    pointsTo: z21.string().optional(),
+    paginated: z21.boolean().optional(),
+    showErrors: z21.boolean().optional(),
+    hideTitle: z21.boolean().optional(),
+    viewers: MetadataStringArraySchema.optional()
+  }),
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("apiPackage"),
+    title: z21.string().optional(),
+    icon: z21.string().optional(),
+    apiDefinitionId: z21.string().optional(),
+    overviewPageId: z21.string().optional(),
+    availability: LedgerAvailabilitySchema.optional(),
+    pointsTo: z21.string().optional(),
+    viewers: MetadataStringArraySchema.optional()
+  }),
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("changelog"),
+    title: z21.string().optional(),
+    icon: z21.string().optional(),
+    overviewPageId: z21.string().optional(),
+    apiDefinitionId: z21.string().optional(),
+    viewers: MetadataStringArraySchema.optional()
+  }),
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("files")
+  }),
+  LedgerMetadataBaseSchema.extend({
+    type: z21.literal("redirects")
+  })
+]);
+var LedgerSegmentMetadataSchema = LedgerSegmentMetadataObjectSchema;
+var LedgerMarkdownMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...NodeMetadataFields,
+  pageId: z21.string().optional(),
+  isOverview: z21.boolean().optional(),
+  noindex: z21.boolean().optional()
+});
+var LedgerRestMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...ApiNodeMetadataFields,
+  endpointId: z21.string(),
+  method: HttpMethodSchema,
+  isResponseStream: z21.boolean().optional(),
+  endpointPairKey: z21.string().optional()
+});
+var LedgerWebSocketMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...ApiNodeMetadataFields,
+  webSocketId: z21.string()
+});
+var LedgerWebhookMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...ApiNodeMetadataFields,
+  webhookId: z21.string(),
+  // V1.WebhookNode carries the full HttpMethod union, so the read model must accept it too.
+  method: HttpMethodSchema
+});
+var LedgerGrpcMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...ApiNodeMetadataFields,
+  grpcId: z21.string(),
+  method: GrpcMethodSchema
+});
+var LedgerGraphQlMetadataSchema = LedgerMetadataBaseSchema.extend({
+  ...ApiNodeMetadataFields,
+  graphqlOperationId: z21.string(),
+  operationType: GraphQlOperationTypeSchema
+});
+var LedgerChangelogEntryMetadataSchema = LedgerMetadataBaseSchema.extend({
+  title: z21.string().optional(),
+  slug: z21.string().optional(),
+  icon: z21.string().optional(),
+  pageId: z21.string(),
+  date: z21.string().optional(),
+  tags: MetadataStringArraySchema.optional()
+});
+var LedgerLinkMetadataSchema = LedgerMetadataBaseSchema.extend({
+  title: z21.string().optional(),
+  slug: z21.string().optional(),
+  icon: z21.string().optional(),
+  url: z21.string(),
+  target: LinkTargetSchema2.optional()
+});
+var LedgerFileArtifactMetadataSchema = LedgerMetadataBaseSchema.extend({
+  contentType: z21.string(),
+  filename: z21.string(),
+  width: z21.number().optional(),
+  height: z21.number().optional(),
+  blurDataURL: z21.string().optional()
+});
+var LedgerRedirectMetadataSchema = LedgerMetadataBaseSchema.extend({
+  href: z21.string().optional()
+});
+var LedgerArtifactMetadataSchema = z21.union([
+  LedgerMarkdownMetadataSchema,
+  LedgerRestMetadataSchema,
+  LedgerWebSocketMetadataSchema,
+  LedgerWebhookMetadataSchema,
+  LedgerGrpcMetadataSchema,
+  LedgerGraphQlMetadataSchema,
+  LedgerChangelogEntryMetadataSchema,
+  LedgerLinkMetadataSchema,
+  LedgerFileArtifactMetadataSchema,
+  LedgerRedirectMetadataSchema
+]);
+var LEDGER_ARTIFACT_METADATA_SCHEMAS = {
+  markdown: LedgerMarkdownMetadataSchema,
+  page: LedgerMarkdownMetadataSchema,
+  rest: LedgerRestMetadataSchema,
+  asyncapi: LedgerWebSocketMetadataSchema,
+  webhook: LedgerWebhookMetadataSchema,
+  grpc: LedgerGrpcMetadataSchema,
+  graphql: LedgerGraphQlMetadataSchema,
+  changelog: LedgerChangelogEntryMetadataSchema,
+  link: LedgerLinkMetadataSchema,
+  file: LedgerFileArtifactMetadataSchema,
+  image: LedgerFileArtifactMetadataSchema,
+  redirect: LedgerRedirectMetadataSchema
+};
+function artifactTypeVariant(base, type) {
+  return base.extend({
+    artifactType: z21.literal(type),
+    artifactMetadata: LEDGER_ARTIFACT_METADATA_SCHEMAS[type]
+  });
+}
+var NavRouteBaseSchema = z21.object({
+  fullPath: z21.string().nullable(),
+  artifactId: z21.string(),
+  hidden: z21.boolean(),
+  displaySortOrder: z21.number().nullable().optional()
+});
+function navRouteVariant(type) {
+  return NavRouteBaseSchema.extend({
+    type: z21.literal(type),
+    metadata: LEDGER_ARTIFACT_METADATA_SCHEMAS[type]
+  });
+}
+var LedgerNavRouteSchema = z21.discriminatedUnion("type", [
+  navRouteVariant("markdown"),
+  navRouteVariant("page"),
+  navRouteVariant("rest"),
+  navRouteVariant("asyncapi"),
+  navRouteVariant("webhook"),
+  navRouteVariant("grpc"),
+  navRouteVariant("graphql"),
+  navRouteVariant("changelog"),
+  navRouteVariant("link"),
+  navRouteVariant("file"),
+  navRouteVariant("image"),
+  navRouteVariant("redirect")
+]);
 var DocsPublishGitInputSchema = z21.object({
   /** Full HTTPS URL of the repo (e.g. `https://github.com/acme/docs`). */
   repoUrl: z21.string(),
@@ -3719,11 +3982,12 @@ var DocsContentFieldsSchema = z21.object({
    */
   git: DocsPublishGitInputSchema.optional()
 });
-var LocaleEntrySchema = DocsContentFieldsSchema.extend({
+var LocaleEntrySchemaInternal = DocsContentFieldsSchema.extend({
   /** Locale identifier (e.g. "en", "es", "ja"). Required — no default. */
   locale: z21.string()
 });
-var DocsPublishInputSchema = z21.object({
+var LocaleEntrySchema = LocaleEntrySchemaInternal;
+var DocsPublishInputSchemaInternal = z21.object({
   orgId: z21.string(),
   domain: z21.string(),
   basepath: z21.string().default(""),
@@ -3750,7 +4014,8 @@ var DocsPublishInputSchema = z21.object({
   message: "defaultLocale must match one of the locales in the locales array",
   path: ["defaultLocale"]
 });
-var LedgerPreviewRegisterInputSchema = DocsContentFieldsSchema.extend({
+var DocsPublishInputSchema = DocsPublishInputSchemaInternal;
+var LedgerPreviewRegisterInputSchemaInternal = DocsContentFieldsSchema.extend({
   orgId: z21.string(),
   /**
    * Optional caller-supplied identifier for the preview hostname. Sanitized
@@ -3767,6 +4032,7 @@ var LedgerPreviewRegisterInputSchema = DocsContentFieldsSchema.extend({
    */
   basePath: z21.string().default("")
 });
+var LedgerPreviewRegisterInputSchema = LedgerPreviewRegisterInputSchemaInternal;
 var LedgerPreviewRegisterResponseSchema = z21.object({
   deploymentHash: z21.string(),
   missingContent: z21.array(MissingContentSchema),
@@ -3818,7 +4084,7 @@ var SegmentDetailSchema = z21.object({
   orphaned: z21.boolean(),
   featureFlags: z21.array(z21.string()),
   /** Type-specific fields: slug, default, subtitle, href, target, image, availability, pointsTo, tab_type. */
-  metadata: z21.unknown()
+  metadata: LedgerSegmentDetailMetadataSchema
 });
 var SegmentSchema = z21.object({
   segmentId: z21.string(),
@@ -3830,7 +4096,7 @@ var SegmentSchema = z21.object({
   /** Whether the segment is hidden from the sidebar. */
   hidden: z21.boolean(),
   /** Segment type descriptor (seg.metadata): { type, title, icon, apiDefinitionId, overviewPageId, pointsTo, ... }. */
-  metadata: z21.unknown(),
+  metadata: LedgerSegmentMetadataSchema,
   /** Full product/version/variant/tab detail metadata, or null when the dimension is absent. */
   product: SegmentDetailSchema.nullable(),
   version: SegmentDetailSchema.nullable(),
@@ -3899,16 +4165,19 @@ var VersionMetadataResponseSchema = z21.object({
 var PageContentInputSchema = z21.object({
   deploymentId: z21.string(),
   fullPath: z21.string().optional(),
-  pageId: z21.string().optional()
+  pageId: z21.string().optional(),
+  locale: z21.string().optional()
 });
 var PageContentResponseSchema = z21.object({
   s3Key: z21.string(),
   segmentHash: z21.string(),
-  url: z21.string()
+  url: z21.string(),
+  pageId: z21.string().optional()
 });
 var BatchPageContentInputSchema = z21.object({
   deploymentId: z21.string(),
-  pageIds: z21.array(z21.string()).min(1).max(2e3)
+  pageIds: z21.array(z21.string()).min(1).max(2e3),
+  locale: z21.string().optional()
 });
 var BatchPageContentItemSchema = z21.object({
   pageId: z21.string(),
@@ -3921,32 +4190,21 @@ var BatchPageContentResponseSchema = z21.object({
 var NavInputSchema = z21.object({
   segmentHash: z21.string()
 });
-var NavRouteSchema = z21.object({
-  fullPath: z21.string().nullable(),
-  artifactId: z21.string(),
-  type: z21.string(),
-  /** Whether the artifact is hidden from the sidebar. */
-  hidden: z21.boolean(),
-  metadata: z21.unknown()
-});
 var NavResponseSchema = z21.object({
-  routes: z21.array(NavRouteSchema)
+  routes: z21.array(LedgerNavRouteSchema)
 });
 var RouteContextInputSchema = z21.object({
   deploymentId: z21.string(),
   fullPath: z21.string(),
   locale: z21.string().optional()
 });
-var RouteContextResponseSchema = z21.object({
+var RouteContextResponseBaseSchema = z21.object({
+  artifactId: z21.string(),
   /** Hash of the segment that owns the matched route — feed to `nav`. */
   segmentHash: z21.string(),
   /** Section path of the owning segment (e.g. "models/command"). */
   section: z21.string(),
   locale: z21.string(),
-  /** The artifact matched at `fullPath`. */
-  artifactId: z21.string(),
-  artifactType: z21.string(),
-  artifactMetadata: z21.unknown(),
   /**
    * Page content reference, or null for non-page artifacts (links/redirects)
    * and route-only aliases that carry no content blob.
@@ -3961,6 +4219,20 @@ var RouteContextResponseSchema = z21.object({
   variant: SegmentDetailSchema.nullable(),
   tab: SegmentDetailSchema.nullable()
 });
+var RouteContextResponseSchema = z21.discriminatedUnion("artifactType", [
+  artifactTypeVariant(RouteContextResponseBaseSchema, "markdown"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "page"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "rest"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "asyncapi"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "webhook"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "grpc"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "graphql"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "changelog"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "link"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "file"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "image"),
+  artifactTypeVariant(RouteContextResponseBaseSchema, "redirect")
+]);
 var TopLevelNavigationInputSchema = z21.object({
   deploymentId: z21.string(),
   locale: z21.string().optional()
@@ -4077,17 +4349,6 @@ function createDocsLedgerClient(options) {
   });
   return createORPCClient11(link);
 }
-function createDocsLedgerReadClient(options) {
-  const baseUrl = options.baseUrl.replace(/\/+$/, "");
-  const link = new OpenAPILink11(docsLedgerReadContract, {
-    url: `${baseUrl}/docs-ledger`,
-    headers: () => ({
-      Authorization: `Bearer ${options.token}`,
-      ...options.headers
-    })
-  });
-  return createORPCClient11(link);
-}
 
 // src/orpc-client/editor-snapshot/client.ts
 import { createORPCClient as createORPCClient12 } from "@orpc/client";
@@ -4963,7 +5224,6 @@ function createFdrORPCClient(options) {
     docsCache: createDocsCacheClient(normalizedOptions),
     docsDeployment: createDocsDeploymentClient(normalizedOptions),
     docsLedger: createDocsLedgerClient(normalizedOptions),
-    docsLedgerRead: createDocsLedgerReadClient(normalizedOptions),
     editorSnapshot: createEditorSnapshotClient(normalizedOptions),
     generators: {
       root: createGeneratorsRootClient(normalizedOptions),