@fern-api/fdr-sdk 1.2.151-c3ff0e9296 → 1.2.152-45fab339da

package/dist/orpc-client/docs-ledger/contract.d.ts

@@ -139,6 +139,20 @@ export declare const StartStaticBuildInputSchema: z.ZodObject<{
      * the docs-router sends, since it does not know which basepaths a host publishes.
      */
     path: z.ZodOptional<z.ZodString>;
+    /**
+     * The build the caller is serving for the site (the docs-router's pointer names it by
+     * deployment id). When it is the site's current deployment, made with the current renderer
+     * as far as `servingRenderer` tells, there is nothing to build and the answer is
+     * `up-to-date`; otherwise the site is rebuilt as usual.
+     */
+    servingBuildId: z.ZodOptional<z.ZodString>;
+    /**
+     * The renderer (build image digest) the served build was made with, `""` when the caller
+     * knows it was made before that was recorded. Omitted when the caller cannot tell (a
+     * basepath build), in which case only the deployment is judged. Any value other than the
+     * digest FDR currently dispatches builds with makes the build stale.
+     */
+    servingRenderer: z.ZodOptional<z.ZodString>;
     /**
      * `publish` (the default) waits for the Job and reports how it ended.
      * `background` returns as soon as the Job exists (`outcome: "queued"`): the
@@ -151,15 +165,25 @@ export declare const StartStaticBuildInputSchema: z.ZodObject<{
     basepath: string;
     priority: "background" | "publish";
     path?: string | undefined;
+    servingBuildId?: string | undefined;
+    servingRenderer?: string | undefined;
 }, {
     domain: string;
     path?: string | undefined;
     basepath?: string | undefined;
+    servingBuildId?: string | undefined;
+    servingRenderer?: string | undefined;
     priority?: "background" | "publish" | undefined;
 }>;
 export declare const StartStaticBuildResponseSchema: z.ZodObject<{
-    /** Mirrors the dispatcher's own outcomes, plus the sites it can't resolve. */
-    status: z.ZodEnum<["created", "already-running", "host-not-enabled", "disabled", "not-published"]>;
+    /**
+     * Mirrors the dispatcher's own outcomes, plus the sites it can't resolve and
+     * `up-to-date`: `servingBuildId` already is the current deployment (made with the current
+     * renderer, when `servingRenderer` was given), nothing started; `busy`: a `background`
+     * ask FDR did not plan because as many background builds as it allows are already being
+     * created — ask again later.
+     */
+    status: z.ZodEnum<["created", "already-running", "host-not-enabled", "disabled", "not-published", "up-to-date", "busy"]>;
     domain: z.ZodString;
     /** The site built: the requested basepath, or the one `path` resolved to. */
     basepath: z.ZodString;
@@ -173,7 +197,7 @@ export declare const StartStaticBuildResponseSchema: z.ZodObject<{
     /** How the Job ended, or `queued` for a `background` build nobody waited on. */
     outcome: z.ZodOptional<z.ZodEnum<["succeeded", "failed", "timed-out", "gone", "unrouted", "queued"]>>;
 }, "strip", z.ZodTypeAny, {
-    status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+    status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published" | "up-to-date" | "busy";
     domain: string;
     basepath: string;
     deploymentId?: string | undefined;
@@ -182,7 +206,7 @@ export declare const StartStaticBuildResponseSchema: z.ZodObject<{
     host?: string | undefined;
     outcome?: "succeeded" | "failed" | "timed-out" | "gone" | "unrouted" | "queued" | undefined;
 }, {
-    status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+    status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published" | "up-to-date" | "busy";
     domain: string;
     basepath: string;
     deploymentId?: string | undefined;
@@ -58064,6 +58088,20 @@ export declare const docsLedgerContract: {
          * the docs-router sends, since it does not know which basepaths a host publishes.
          */
         path: z.ZodOptional<z.ZodString>;
+        /**
+         * The build the caller is serving for the site (the docs-router's pointer names it by
+         * deployment id). When it is the site's current deployment, made with the current renderer
+         * as far as `servingRenderer` tells, there is nothing to build and the answer is
+         * `up-to-date`; otherwise the site is rebuilt as usual.
+         */
+        servingBuildId: z.ZodOptional<z.ZodString>;
+        /**
+         * The renderer (build image digest) the served build was made with, `""` when the caller
+         * knows it was made before that was recorded. Omitted when the caller cannot tell (a
+         * basepath build), in which case only the deployment is judged. Any value other than the
+         * digest FDR currently dispatches builds with makes the build stale.
+         */
+        servingRenderer: z.ZodOptional<z.ZodString>;
         /**
          * `publish` (the default) waits for the Job and reports how it ended.
          * `background` returns as soon as the Job exists (`outcome: "queued"`): the
@@ -58076,14 +58114,24 @@ export declare const docsLedgerContract: {
         basepath: string;
         priority: "background" | "publish";
         path?: string | undefined;
+        servingBuildId?: string | undefined;
+        servingRenderer?: string | undefined;
     }, {
         domain: string;
         path?: string | undefined;
         basepath?: string | undefined;
+        servingBuildId?: string | undefined;
+        servingRenderer?: string | undefined;
         priority?: "background" | "publish" | undefined;
     }>, z.ZodObject<{
-        /** Mirrors the dispatcher's own outcomes, plus the sites it can't resolve. */
-        status: z.ZodEnum<["created", "already-running", "host-not-enabled", "disabled", "not-published"]>;
+        /**
+         * Mirrors the dispatcher's own outcomes, plus the sites it can't resolve and
+         * `up-to-date`: `servingBuildId` already is the current deployment (made with the current
+         * renderer, when `servingRenderer` was given), nothing started; `busy`: a `background`
+         * ask FDR did not plan because as many background builds as it allows are already being
+         * created — ask again later.
+         */
+        status: z.ZodEnum<["created", "already-running", "host-not-enabled", "disabled", "not-published", "up-to-date", "busy"]>;
         domain: z.ZodString;
         /** The site built: the requested basepath, or the one `path` resolved to. */
         basepath: z.ZodString;
@@ -58097,7 +58145,7 @@ export declare const docsLedgerContract: {
         /** How the Job ended, or `queued` for a `background` build nobody waited on. */
         outcome: z.ZodOptional<z.ZodEnum<["succeeded", "failed", "timed-out", "gone", "unrouted", "queued"]>>;
     }, "strip", z.ZodTypeAny, {
-        status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+        status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published" | "up-to-date" | "busy";
         domain: string;
         basepath: string;
         deploymentId?: string | undefined;
@@ -58106,7 +58154,7 @@ export declare const docsLedgerContract: {
         host?: string | undefined;
         outcome?: "succeeded" | "failed" | "timed-out" | "gone" | "unrouted" | "queued" | undefined;
     }, {
-        status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+        status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published" | "up-to-date" | "busy";
         domain: string;
         basepath: string;
         deploymentId?: string | undefined;