@fern-api/fdr-sdk 1.2.111-cfdc56c4fc → 1.2.112-47e5377045

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

@@ -124,6 +124,91 @@ export declare const MigrateV2SiteInputSchema: z.ZodObject<{
     dryRun?: boolean | undefined;
     allowRemigration?: boolean | undefined;
 }>;
+/**
+ * Input for `POST /static-build`: build a site's current deployment again
+ * without waiting for it to be republished. A Fern-operator action — the
+ * server restricts it to members of the `fern` org.
+ */
+export declare const StartStaticBuildInputSchema: z.ZodObject<{
+    domain: z.ZodString;
+    /** "" for a root site, otherwise a leading-slash basepath. */
+    basepath: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    domain: string;
+    basepath: string;
+}, {
+    domain: string;
+    basepath?: string | 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;
+    basepath: z.ZodString;
+    /** 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>;
+}, "strip", z.ZodTypeAny, {
+    status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+    domain: string;
+    basepath: string;
+    deploymentId?: string | undefined;
+    jobName?: string | undefined;
+    host?: string | undefined;
+}, {
+    status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+    domain: string;
+    basepath: string;
+    deploymentId?: string | undefined;
+    jobName?: string | undefined;
+    host?: string | undefined;
+}>;
+/**
+ * Input for `POST /static-build/serving-host`: which hostname this
+ * environment's docs-router serves a site's static builds from. Also a
+ * Fern-operator action — it reads another org's ledger.
+ */
+export declare const ResolveStaticServingHostInputSchema: z.ZodObject<{
+    domain: z.ZodString;
+    /** "" for a root site, otherwise a leading-slash basepath. */
+    basepath: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    domain: string;
+    basepath: string;
+}, {
+    domain: string;
+    basepath?: string | undefined;
+}>;
+export declare const ResolveStaticServingHostResponseSchema: z.ZodObject<{
+    domain: z.ZodString;
+    basepath: z.ZodString;
+    /**
+     * The hostname the static build is exported to and served from — always a
+     * hostname Fern owns for a published site, even one on a customer's domain.
+     */
+    servingHost: z.ZodString;
+    /** False when nothing routes to the serving host, so cutting over would serve nothing. */
+    routable: z.ZodBoolean;
+    /**
+     * The deployment the serving host was derived from; absent when the site
+     * has never published, in which case only its own hostname was available.
+     */
+    deploymentId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    domain: string;
+    basepath: string;
+    servingHost: string;
+    routable: boolean;
+    deploymentId?: string | undefined;
+}, {
+    domain: string;
+    basepath: string;
+    servingHost: string;
+    routable: boolean;
+    deploymentId?: string | undefined;
+}>;
 export declare const MigrateV2SiteSkipReasonSchema: z.ZodEnum<["not-registered", "preview", "already-ledger", "has-translations", "no-navigation"]>;
 export declare const MigrateV2SiteResponseSchema: z.ZodDiscriminatedUnion<"outcome", [z.ZodObject<{
     outcome: z.ZodLiteral<"skipped">;
@@ -4097,9 +4182,9 @@ export declare const LedgerConfigSchema: z.ZodObject<{
         host: z.ZodDefault<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         branch: string;
+        host: string;
         owner: string;
         repo: string;
-        host: string;
     }, {
         owner: string;
         repo: string;
@@ -5024,9 +5109,9 @@ export declare const LedgerConfigSchema: z.ZodObject<{
     rootSlug?: string | undefined;
     editThisPageGithub?: {
         branch: string;
+        host: string;
         owner: string;
         repo: string;
-        host: string;
     } | undefined;
 }, {
     js?: {
@@ -16017,9 +16102,9 @@ export declare const DocsContentFieldsSchema: z.ZodObject<{
             host: z.ZodDefault<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         }, {
             owner: string;
             repo: string;
@@ -16944,9 +17029,9 @@ export declare const DocsContentFieldsSchema: z.ZodObject<{
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     }, {
         js?: {
@@ -18883,9 +18968,9 @@ export declare const DocsContentFieldsSchema: z.ZodObject<{
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     } | undefined;
     redirects?: {
@@ -23728,9 +23813,9 @@ declare const LocaleEntrySchemaInternal: z.ZodObject<{
             host: z.ZodDefault<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         }, {
             owner: string;
             repo: string;
@@ -24655,9 +24740,9 @@ declare const LocaleEntrySchemaInternal: z.ZodObject<{
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     }, {
         js?: {
@@ -26585,9 +26670,9 @@ declare const LocaleEntrySchemaInternal: z.ZodObject<{
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     } | undefined;
     redirects?: {
@@ -28543,9 +28628,9 @@ declare const DocsPublishInputSchemaInternal: z.ZodEffects<z.ZodObject<{
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -30472,9 +30557,9 @@ declare const DocsPublishInputSchemaInternal: z.ZodEffects<z.ZodObject<{
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -32412,9 +32497,9 @@ declare const DocsPublishInputSchemaInternal: z.ZodEffects<z.ZodObject<{
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -37276,9 +37361,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
             host: z.ZodDefault<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         }, {
             owner: string;
             repo: string;
@@ -38203,9 +38288,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     }, {
         js?: {
@@ -40154,9 +40239,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -42073,9 +42158,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     } | undefined;
     redirects?: {
@@ -43042,9 +43127,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -45927,9 +46012,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     } | undefined;
     redirects?: {
@@ -46896,9 +46981,9 @@ declare const LedgerPreviewRegisterInputSchemaInternal: z.ZodEffects<z.ZodObject
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -48915,6 +49000,10 @@ export type ArchiveSiteInput = z.infer<typeof ArchiveSiteInputSchema>;
 export type ArchiveSiteResponse = z.infer<typeof ArchiveSiteResponseSchema>;
 export type MigrateV2SiteInput = z.output<typeof MigrateV2SiteInputSchema>;
 export type MigrateV2SiteResponse = z.infer<typeof MigrateV2SiteResponseSchema>;
+export type StartStaticBuildInput = z.output<typeof StartStaticBuildInputSchema>;
+export type StartStaticBuildResponse = z.infer<typeof StartStaticBuildResponseSchema>;
+export type ResolveStaticServingHostInput = z.output<typeof ResolveStaticServingHostInputSchema>;
+export type ResolveStaticServingHostResponse = z.infer<typeof ResolveStaticServingHostResponseSchema>;
 export type LedgerPreviewRegisterResponse = z.infer<typeof LedgerPreviewRegisterResponseSchema>;
 export declare const docsLedgerContract: {
     register: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodType<{
@@ -49849,9 +49938,9 @@ export declare const docsLedgerContract: {
                 rootSlug?: string | undefined;
                 editThisPageGithub?: {
                     branch: string;
+                    host: string;
                     owner: string;
                     repo: string;
-                    host: string;
                 } | undefined;
             } | undefined;
             redirects?: {
@@ -51804,9 +51893,9 @@ export declare const docsLedgerContract: {
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | undefined;
         redirects?: {
@@ -52773,9 +52862,9 @@ export declare const docsLedgerContract: {
                 rootSlug?: string | undefined;
                 editThisPageGithub?: {
                     branch: string;
+                    host: string;
                     owner: string;
                     repo: string;
-                    host: string;
                 } | undefined;
             } | undefined;
             redirects?: {
@@ -55709,9 +55798,9 @@ export declare const docsLedgerContract: {
                 rootSlug?: string | undefined;
                 editThisPageGithub?: {
                     branch: string;
+                    host: string;
                     owner: string;
                     repo: string;
-                    host: string;
                 } | undefined;
             } | undefined;
             redirects?: {
@@ -56844,6 +56933,79 @@ export declare const docsLedgerContract: {
         deploymentId: string;
         outcome: "migrated";
     }>]>, 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. */
+        basepath: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        domain: string;
+        basepath: string;
+    }, {
+        domain: string;
+        basepath?: string | 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;
+        basepath: z.ZodString;
+        /** 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>;
+    }, "strip", z.ZodTypeAny, {
+        status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+        domain: string;
+        basepath: string;
+        deploymentId?: string | undefined;
+        jobName?: string | undefined;
+        host?: string | undefined;
+    }, {
+        status: "created" | "already-running" | "host-not-enabled" | "disabled" | "not-published";
+        domain: string;
+        basepath: string;
+        deploymentId?: string | undefined;
+        jobName?: string | undefined;
+        host?: string | undefined;
+    }>, Record<never, never>, Record<never, never>>;
+    resolveStaticServingHost: import("@orpc/contract").ContractProcedureBuilderWithInputOutput<z.ZodObject<{
+        domain: z.ZodString;
+        /** "" for a root site, otherwise a leading-slash basepath. */
+        basepath: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        domain: string;
+        basepath: string;
+    }, {
+        domain: string;
+        basepath?: string | undefined;
+    }>, z.ZodObject<{
+        domain: z.ZodString;
+        basepath: z.ZodString;
+        /**
+         * The hostname the static build is exported to and served from — always a
+         * hostname Fern owns for a published site, even one on a customer's domain.
+         */
+        servingHost: z.ZodString;
+        /** False when nothing routes to the serving host, so cutting over would serve nothing. */
+        routable: z.ZodBoolean;
+        /**
+         * The deployment the serving host was derived from; absent when the site
+         * has never published, in which case only its own hostname was available.
+         */
+        deploymentId: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        domain: string;
+        basepath: string;
+        servingHost: string;
+        routable: boolean;
+        deploymentId?: string | undefined;
+    }, {
+        domain: string;
+        basepath: string;
+        servingHost: string;
+        routable: boolean;
+        deploymentId?: string | undefined;
+    }>, Record<never, never>, Record<never, never>>;
 };
 export declare const CurrentVersionInputSchema: z.ZodObject<{
     domain: z.ZodString;
@@ -60815,9 +60977,9 @@ export declare const VersionMetadataResponseSchema: z.ZodObject<{
             host: z.ZodDefault<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         }, {
             owner: string;
             repo: string;
@@ -61742,9 +61904,9 @@ export declare const VersionMetadataResponseSchema: z.ZodObject<{
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     }, {
         js?: {
@@ -65159,9 +65321,9 @@ export declare const VersionMetadataResponseSchema: z.ZodObject<{
         rootSlug?: string | undefined;
         editThisPageGithub?: {
             branch: string;
+            host: string;
             owner: string;
             repo: string;
-            host: string;
         } | undefined;
     } | null;
     cssInline: {
@@ -83343,9 +83505,9 @@ export declare const docsLedgerReadContract: {
                 host: z.ZodDefault<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             }, {
                 owner: string;
                 repo: string;
@@ -84270,9 +84432,9 @@ export declare const docsLedgerReadContract: {
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         }, {
             js?: {
@@ -87687,9 +87849,9 @@ export declare const docsLedgerReadContract: {
             rootSlug?: string | undefined;
             editThisPageGithub?: {
                 branch: string;
+                host: string;
                 owner: string;
                 repo: string;
-                host: string;
             } | undefined;
         } | null;
         cssInline: {