@fern-api/fdr-sdk 1.2.150-6ecd5b84b9 → 1.2.151-1537a7ea13

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

@@ -131,39 +131,65 @@ export declare const MigrateV2SiteInputSchema: z.ZodObject<{
  */
 export declare const StartStaticBuildInputSchema: z.ZodObject<{
     domain: z.ZodString;
-    /** "" for a root site, otherwise a leading-slash basepath. */
+    /** "" for a root site, otherwise a leading-slash basepath. Ignored when `path` is given. */
     basepath: z.ZodDefault<z.ZodString>;
+    /**
+     * A request path on `domain`: the site to build is the one whose basepath the
+     * path falls under (the longest match; the root site catches the rest). What
+     * the docs-router sends, since it does not know which basepaths a host publishes.
+     */
+    path: 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
+     * Job promotes itself when it succeeds. What the docs-router asks for when a
+     * visitor reaches a preview that has no static build yet.
+     */
+    priority: z.ZodDefault<z.ZodEnum<["publish", "background"]>>;
 }, "strip", z.ZodTypeAny, {
     domain: string;
     basepath: string;
+    priority: "background" | "publish";
+    path?: string | undefined;
 }, {
     domain: string;
+    path?: string | undefined;
     basepath?: 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"]>;
     domain: z.ZodString;
+    /** The site built: the requested basepath, or the one `path` resolved to. */
     basepath: z.ZodString;
+    /** Every basepath currently published at `domain` ("" is the root site). */
+    basepaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     /** The deployment being built, absent when the site has never published. */
     deploymentId: z.ZodOptional<z.ZodString>;
     jobName: z.ZodOptional<z.ZodString>;
     /** The host the build is exported to and served from, which may not be `domain`. */
     host: z.ZodOptional<z.ZodString>;
+    /** 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";
     domain: string;
     basepath: string;
     deploymentId?: string | undefined;
+    basepaths?: string[] | undefined;
     jobName?: string | undefined;
     host?: string | undefined;
+    outcome?: "succeeded" | "failed" | "timed-out" | "gone" | "unrouted" | "queued" | undefined;
 }, {
     status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
     domain: string;
     basepath: string;
     deploymentId?: string | undefined;
+    basepaths?: string[] | undefined;
     jobName?: string | undefined;
     host?: string | undefined;
+    outcome?: "succeeded" | "failed" | "timed-out" | "gone" | "unrouted" | "queued" | undefined;
 }>;
 /**
  * Input for `POST /static-build/rebuild-all`: rebuild every production static
@@ -58030,38 +58056,64 @@ export declare const docsLedgerContract: {
     }>]>, Record<never, never>, Record<never, never>>;
     startStaticBuild: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
         domain: z.ZodString;
-        /** "" for a root site, otherwise a leading-slash basepath. */
+        /** "" for a root site, otherwise a leading-slash basepath. Ignored when `path` is given. */
         basepath: z.ZodDefault<z.ZodString>;
+        /**
+         * A request path on `domain`: the site to build is the one whose basepath the
+         * path falls under (the longest match; the root site catches the rest). What
+         * the docs-router sends, since it does not know which basepaths a host publishes.
+         */
+        path: 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
+         * Job promotes itself when it succeeds. What the docs-router asks for when a
+         * visitor reaches a preview that has no static build yet.
+         */
+        priority: z.ZodDefault<z.ZodEnum<["publish", "background"]>>;
     }, "strip", z.ZodTypeAny, {
         domain: string;
         basepath: string;
+        priority: "background" | "publish";
+        path?: string | undefined;
     }, {
         domain: string;
+        path?: string | undefined;
         basepath?: 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"]>;
         domain: z.ZodString;
+        /** The site built: the requested basepath, or the one `path` resolved to. */
         basepath: z.ZodString;
+        /** Every basepath currently published at `domain` ("" is the root site). */
+        basepaths: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
         /** The deployment being built, absent when the site has never published. */
         deploymentId: z.ZodOptional<z.ZodString>;
         jobName: z.ZodOptional<z.ZodString>;
         /** The host the build is exported to and served from, which may not be `domain`. */
         host: z.ZodOptional<z.ZodString>;
+        /** 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";
         domain: string;
         basepath: string;
         deploymentId?: string | undefined;
+        basepaths?: string[] | undefined;
         jobName?: string | undefined;
         host?: string | undefined;
+        outcome?: "succeeded" | "failed" | "timed-out" | "gone" | "unrouted" | "queued" | undefined;
     }, {
         status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
         domain: string;
         basepath: string;
         deploymentId?: string | undefined;
+        basepaths?: string[] | undefined;
         jobName?: string | undefined;
         host?: string | undefined;
+        outcome?: "succeeded" | "failed" | "timed-out" | "gone" | "unrouted" | "queued" | undefined;
     }>, Record<never, never>, Record<never, never>>;
     rebuildAllStaticBuilds: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
         /** Resolve and report the sites without dispatching any build. */