@fern-api/fdr-sdk 1.2.165-67370398 → 1.2.165-d20adf518b

package/dist/docs-ledger/buildLedgerManifest.d.ts

@@ -0,0 +1,80 @@
+import type { LedgerManifest, LedgerSiblingSite } from "../orpc-client/index.js";
+import type { TransformResult } from "./docsPublishTransform.js";
+import type { ArtifactInput, InlineTranslationParams, PublishParams } from "./inputTypes.js";
+export interface BuildLedgerManifestArgs {
+    /** Base-locale entities + deployment/site identity (canonical fern URL). */
+    params: PublishParams;
+    /** Base-locale transform result (carries config + file dimensions). */
+    baseResult: TransformResult;
+    /** Additional-locale entities, persisted in the same deployment. */
+    inlineTranslations: InlineTranslationParams[];
+    /**
+     * pageId → bare `fullPath`s of the files each page embeds, merged across all
+     * locales (ADR 0016, "File metadata on the render path"). Used to pack each
+     * route shard's `files` identity map and to prune the relocated files from
+     * the pointer's global `files` map. Empty ⇒ no shard-side files; the pointer
+     * keeps every file (graceful when the publishing CLI predates the field).
+     */
+    referencedFilesByPageId: Record<string, string[]>;
+    deploymentId: string;
+    siteId: string;
+    deploymentHash: string;
+    orgId: string;
+    /** Canonical fern domain (the per-URL manifest is written once per URL by the caller). */
+    domain: string;
+    /**
+     * Domain used for file anchoring (S3 keys + manifest `files[].domain`).
+     * When set, overrides `params.site.domain` so preview publishes anchor
+     * files on the canonical production domain (ADR 0010).
+     */
+    fileDomain?: string;
+    basepath: string;
+    isPreview: boolean;
+    isPrivate: boolean;
+    /** FAI Ask AI enablement for this URL; omitted when it could not be resolved. */
+    askAiEnabled?: boolean;
+    /** Live sites on this host; only for basepath-aware production publishes. */
+    siblingSites?: LedgerSiblingSite[];
+    /** ISO-8601 — request time the publish became live. */
+    assignedAt: string;
+    assignedBy: string | null;
+    /** artifact hash → ISO-8601 `created_at` from `docs_ledger_artifacts`. */
+    artifactHashToCreatedAt?: Map<string, string>;
+}
+export interface LedgerReadModelBlob {
+    hash: string;
+    bytes: Buffer;
+    contentType: string;
+}
+export interface BuildLedgerReadModelResult {
+    pointer: LedgerManifest;
+    blobs: LedgerReadModelBlob[];
+}
+/**
+ * Overlay CAS content `created_at` onto the artifact-keyed `createdAt` map
+ * used for manifest route entries (sitemap `<lastmod>`). Artifact hashes are
+ * salted with `FDR_VERSION`, so their rows are re-minted on the first publish
+ * after every FDR deploy; the unsalted content row survives deploys and
+ * reflects when the page bytes first appeared. Content-less artifacts (links,
+ * files) keep the artifact row's timestamp.
+ */
+export declare function overlayContentCreatedAt({ artifacts, artifactHashToCreatedAt, contentHashToCreatedAt }: {
+    artifacts: ReadonlyArray<Pick<ArtifactInput, "hash" | "contentHash">>;
+    artifactHashToCreatedAt: ReadonlyMap<string, string>;
+    contentHashToCreatedAt: ReadonlyMap<string, string>;
+}): Map<string, string>;
+/**
+ * Assemble the pointer + immutable CAS read model (ADR 0016) from the
+ * in-memory transform result the DAO just persisted. No DB read-back: every
+ * field comes from `params` / `baseResult` / `inlineTranslations`, and segment /
+ * artifact ids are content hashes (the S3-only reader never correlates against
+ * postgres).
+ *
+ * Leaf content (page markdown, API definitions) is referenced by CAS hash only
+ * — the bundle fetches those blobs directly. Hot-path chrome text
+ * (header/footer/css.inline/js.inline) is re-inlined into the pointer so page
+ * renders do not pay extra CAS reads for site chrome.
+ */
+export declare function buildLedgerReadModel(args: BuildLedgerManifestArgs): BuildLedgerReadModelResult;
+export declare function buildLedgerManifest(args: BuildLedgerManifestArgs): LedgerManifest;
+//# sourceMappingURL=buildLedgerManifest.d.ts.map

package/dist/docs-ledger/buildLedgerManifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildLedgerManifest.d.ts","sourceRoot":"","sources":["../../src/docs-ledger/buildLedgerManifest.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAMR,cAAc,EAKd,iBAAiB,EAUpB,MAAM,yBAAyB,CAAC;AAWjC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EACR,aAAa,EACb,uBAAuB,EACvB,aAAa,EAGhB,MAAM,iBAAiB,CAAC;AA8JzB,MAAM,WAAW,uBAAuB;IACpC,4EAA4E;IAC5E,MAAM,EAAE,aAAa,CAAC;IACtB,uEAAuE;IACvE,UAAU,EAAE,eAAe,CAAC;IAC5B,oEAAoE;IACpE,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;IAC9C;;;;;;OAMG;IACH,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAClD,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,0FAA0F;IAC1F,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,iFAAiF;IACjF,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,6EAA6E;IAC7E,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAC;IACnC,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,0EAA0E;IAC1E,uBAAuB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,mBAAmB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC,OAAO,EAAE,cAAc,CAAC;IACxB,KAAK,EAAE,mBAAmB,EAAE,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,wBAAgB,uBAAuB,CAAC,EACpC,SAAS,EACT,uBAAuB,EACvB,sBAAsB,EACzB,EAAE;IACC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC;IACtE,uBAAuB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrD,sBAAsB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvD,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAYtB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,uBAAuB,GAAG,0BAA0B,CA2uB9F;AA0CD,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,uBAAuB,GAAG,cAAc,CAEjF"}