@faable/deploy-sdk 2.13.1 → 2.15.0

package/dist/api/types.d.ts

@@ -3,6 +3,26 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
+    "/project/limits": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Project creation limits for the caller
+         * @description Whether the caller can create another project, and why not
+         */
+        get: operations["project/limits"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/project/{id}/invite": {
         parameters: {
             query?: never;
@@ -187,6 +207,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/app/repo-linkable": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Check whether a repository can be linked to a new app
+         * @description Runs the free-plan "one repository, one app" guard before the app exists. Always 200: `linkable:false` names the app that already has the repository (and its project when it is another one of yours), with the same message the link would refuse with.
+         */
+        get: operations["app/repo_linkable"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/app/{app_id}/registry": {
         parameters: {
             query?: never;
@@ -833,6 +873,19 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        ProjectLimits: {
+            can_create: boolean;
+            reason: "free_project_limit" | "new_account_window" | null;
+            message: string | null;
+            free_projects: number | null;
+            max_free_projects: number | null;
+            upgradable_projects: {
+                id: string;
+                name: string;
+            }[];
+            new_account_window_ends_at: string | null;
+            resolved: boolean;
+        };
         ProjectInvite: {
             emails: string[];
         };
@@ -854,6 +907,7 @@ export interface components {
             team: string;
             user_id?: string;
             collaborators: string[];
+            product_intent?: "deploy" | "auth" | "undecided";
             owner_suspended?: boolean;
             owner_email?: string;
             /** @description Project creation date */
@@ -889,6 +943,7 @@ export interface components {
             name: string;
             description?: string;
             collaborators?: string[];
+            product_intent?: "deploy" | "auth" | "undecided";
         };
         ProjectUpdate: {
             name?: string;
@@ -1096,6 +1151,18 @@ export interface components {
             instance_type?: string;
             notify_deploy_success?: boolean | null;
         };
+        /** @description Repository link pre-check */
+        AppRepoLinkable: {
+            linkable: boolean;
+            /** @enum {string} */
+            code?: "repository_already_linked";
+            message?: string;
+            details?: {
+                app_id: string;
+                app_name?: string;
+                project?: string;
+            };
+        };
         DeployBranchResult: {
             github_branch: string;
             workflow_synced: boolean;
@@ -1132,15 +1199,21 @@ export interface components {
             platform_profiles: {
                 name: string;
                 action: string;
+                match: string;
                 rule_count: number;
                 rules?: {
                     pattern: string;
+                    user_agent?: string;
+                    query?: string;
                     description?: string;
                 }[];
             }[];
             rules: {
-                pattern: string;
+                pattern?: string;
+                user_agent?: string;
+                query?: string;
                 action: string;
+                match: string;
                 description?: string;
             }[];
         };
@@ -1160,6 +1233,12 @@ export interface components {
             controlled_by?: string;
             /** @description Why the deployment failed (shown to the user on ERROR) */
             reason?: string;
+            /** @description Producer's own name for what failed (e.g. detect_no_buildpack). Not the fault taxonomy. */
+            failure_code?: string;
+            /** @description Structured context the producer had before writing `reason` (found_files, subdir_hits, workdir, root_dir…). Never free build output: it must carry no repository paths beyond the entry names detection already lists. */
+            failure_detail?: {
+                [key: string]: unknown;
+            };
             /** @description Scale-to-zero sub-state (admin-only): asleep, waking or null */
             cold_state?: "asleep" | "waking" | null;
             /** @description Runtime image (immutable version tag) this artifact deployment runs */
@@ -1311,6 +1390,11 @@ export interface components {
              * @default null
              */
             dns_message: string | null;
+            /**
+             * @description Advisory for a verified domain whose DNS is functional but not the record we publish
+             * @default null
+             */
+            dns_warning: string | null;
         };
         /** @description Domain */
         Domain: {
@@ -1398,13 +1482,17 @@ export interface components {
             app_id: string | null;
             source: "builtin" | "manual" | "auto";
             action: "deny" | "sink" | "ratelimit" | "probe";
-            match: "path" | "user_agent";
+            match: "path" | "user_agent" | "path_user_agent" | "query" | "path_query";
             apply: "all" | "node" | "php" | "manual";
             /** @description Runtimes excluded from `apply` (e.g. ["php"]) */
             except?: ("all" | "node" | "php" | "manual")[];
             rules: {
-                /** @description RE2 path-regex fragment */
+                /** @description RE2 fragment; see the profile `match` */
                 pattern: string;
+                /** @description RE2 fragment matched against User-Agent. Only in `path_user_agent` profiles, where BOTH must match. */
+                user_agent?: string;
+                /** @description LITERAL query parameter name (never a regex). Only in `path_query` profiles, where BOTH must match. */
+                query?: string;
                 /** @description What this rule blocks (human annotation) */
                 description?: string;
             }[];
@@ -1455,11 +1543,15 @@ export interface components {
             app_id?: string;
             source?: "builtin" | "manual" | "auto";
             action?: "deny" | "sink" | "ratelimit" | "probe";
-            match?: "path" | "user_agent";
+            match?: "path" | "user_agent" | "path_user_agent" | "query" | "path_query";
             apply?: "all" | "node" | "php" | "manual";
             rules?: {
-                /** @description RE2 path-regex fragment */
+                /** @description RE2 fragment; see the profile `match` */
                 pattern: string;
+                /** @description RE2 fragment matched against User-Agent. Only in `path_user_agent` profiles, where BOTH must match. */
+                user_agent?: string;
+                /** @description LITERAL query parameter name (never a regex). Only in `path_query` profiles, where BOTH must match. */
+                query?: string;
                 /** @description What this rule blocks (human annotation) */
                 description?: string;
             }[];
@@ -1471,11 +1563,15 @@ export interface components {
         WafProfileUpdate: {
             name?: string;
             action?: "deny" | "sink" | "ratelimit" | "probe";
-            match?: "path" | "user_agent";
+            match?: "path" | "user_agent" | "path_user_agent" | "query" | "path_query";
             apply?: "all" | "node" | "php" | "manual";
             rules?: {
-                /** @description RE2 path-regex fragment */
+                /** @description RE2 fragment; see the profile `match` */
                 pattern: string;
+                /** @description RE2 fragment matched against User-Agent. Only in `path_user_agent` profiles, where BOTH must match. */
+                user_agent?: string;
+                /** @description LITERAL query parameter name (never a regex). Only in `path_query` profiles, where BOTH must match. */
+                query?: string;
                 /** @description What this rule blocks (human annotation) */
                 description?: string;
             }[];
@@ -1742,6 +1838,7 @@ export interface components {
             id: string;
             team: string;
             kind: "runtime" | "builder" | "fetcher" | "buildkit";
+            role: "workload" | "cluster";
             /** @description Canonical key: node:22, python:3.11, static, fetcher, buildkit */
             key: string;
             /** @description Repository ref without tag */
@@ -1752,6 +1849,36 @@ export interface components {
             min_version: string;
             /** @description A CI registration of a newer release moves current */
             auto_promote: boolean;
+            rollout: {
+                mode: "manual" | "auto";
+                /** @default null */
+                target: string | null;
+                /** @default null */
+                previous: string | null;
+                state: "idle" | "running" | "reverting" | "halted" | "done" | "stalled";
+                /**
+                 * Format: date-time
+                 * @default null
+                 */
+                started_at: string | null;
+                /**
+                 * Format: date-time
+                 * @default null
+                 */
+                updated_at: string | null;
+                /**
+                 * Format: date-time
+                 * @default null
+                 */
+                deadline_at: string | null;
+                failures: number;
+                /** @default null */
+                halted_reason: string | null;
+                /** @default null */
+                failed_version: string | null;
+                /** @default null */
+                gate: string | null;
+            };
             versions: {
                 /** @description Buildpacks release, X.Y.Z */
                 version: string;
@@ -1809,6 +1936,7 @@ export interface components {
             repository: string;
             current: string;
             min_version: string;
+            role?: "workload" | "cluster";
             auto_promote?: boolean;
             versions?: {
                 /** @description Buildpacks release, X.Y.Z */
@@ -1881,6 +2009,26 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
+    "project/limits": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ProjectLimits"];
+                };
+            };
+        };
+    };
     "project/invite": {
         parameters: {
             query?: never;
@@ -1977,6 +2125,7 @@ export interface operations {
                     name: string;
                     description?: string;
                     collaborators?: string[];
+                    product_intent?: "deploy" | "auth" | "undecided";
                 };
             };
         };
@@ -1996,6 +2145,7 @@ export interface operations {
                         team: string;
                         user_id?: string;
                         collaborators: string[];
+                        product_intent?: "deploy" | "auth" | "undecided";
                         owner_suspended?: boolean;
                         owner_email?: string;
                         /** @description Project creation date */
@@ -2033,6 +2183,7 @@ export interface operations {
                         team: string;
                         user_id?: string;
                         collaborators: string[];
+                        product_intent?: "deploy" | "auth" | "undecided";
                         owner_suspended?: boolean;
                         owner_email?: string;
                         /** @description Project creation date */
@@ -2077,6 +2228,7 @@ export interface operations {
                         team: string;
                         user_id?: string;
                         collaborators: string[];
+                        product_intent?: "deploy" | "auth" | "undecided";
                         owner_suspended?: boolean;
                         owner_email?: string;
                         /** @description Project creation date */
@@ -2114,6 +2266,7 @@ export interface operations {
                         team: string;
                         user_id?: string;
                         collaborators: string[];
+                        product_intent?: "deploy" | "auth" | "undecided";
                         owner_suspended?: boolean;
                         owner_email?: string;
                         /** @description Project creation date */
@@ -2552,6 +2705,31 @@ export interface operations {
             };
         };
     };
+    "app/repo_linkable": {
+        parameters: {
+            query: {
+                /** @description GitHub repository full name, e.g. acme/api */
+                repository: string;
+                /** @description GitHub App installation the repo belongs to */
+                github_installation_id?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Repository link pre-check */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AppRepoLinkable"];
+                };
+            };
+        };
+    };
     "app/get_registry": {
         parameters: {
             query?: never;
@@ -2681,6 +2859,7 @@ export interface operations {
                             user_agent: string;
                             requests: number;
                         }[];
+                        degraded: string[];
                     };
                 };
             };
@@ -2982,15 +3161,21 @@ export interface operations {
                         platform_profiles: {
                             name: string;
                             action: string;
+                            match: string;
                             rule_count: number;
                             rules?: {
                                 pattern: string;
+                                user_agent?: string;
+                                query?: string;
                                 description?: string;
                             }[];
                         }[];
                         rules: {
-                            pattern: string;
+                            pattern?: string;
+                            user_agent?: string;
+                            query?: string;
                             action: string;
+                            match: string;
                             description?: string;
                         }[];
                     };
@@ -3011,10 +3196,16 @@ export interface operations {
             content: {
                 "application/json": {
                     /** @description RE2 path-regex fragment, e.g. ^/robots\.txt$ */
-                    pattern: string;
+                    pattern?: string;
+                    /** @description RE2 fragment matched against User-Agent. With `pattern`, BOTH must match. */
+                    user_agent?: string;
+                    /** @description LITERAL query parameter name, e.g. rest_route (never a regex). With `pattern`, BOTH must match. */
+                    query?: string;
                     /** @description deny → 403 at the edge; sink → synthetic 404 from the platform (the app is never woken) */
                     action: "deny" | "sink";
                     description?: string;
+                    /** @description Accept a user-agent pattern that also matches a known search/AI crawler or uptime monitor, or a query parameter that carries an auth flow */
+                    force?: boolean;
                 };
             };
         };
@@ -3030,15 +3221,21 @@ export interface operations {
                         platform_profiles: {
                             name: string;
                             action: string;
+                            match: string;
                             rule_count: number;
                             rules?: {
                                 pattern: string;
+                                user_agent?: string;
+                                query?: string;
                                 description?: string;
                             }[];
                         }[];
                         rules: {
-                            pattern: string;
+                            pattern?: string;
+                            user_agent?: string;
+                            query?: string;
                             action: string;
+                            match: string;
                             description?: string;
                         }[];
                     };
@@ -3058,7 +3255,10 @@ export interface operations {
         requestBody: {
             content: {
                 "application/json": {
-                    pattern: string;
+                    pattern?: string;
+                    user_agent?: string;
+                    query?: string;
+                    action?: "deny" | "sink";
                 };
             };
         };
@@ -3074,15 +3274,21 @@ export interface operations {
                         platform_profiles: {
                             name: string;
                             action: string;
+                            match: string;
                             rule_count: number;
                             rules?: {
                                 pattern: string;
+                                user_agent?: string;
+                                query?: string;
                                 description?: string;
                             }[];
                         }[];
                         rules: {
-                            pattern: string;
+                            pattern?: string;
+                            user_agent?: string;
+                            query?: string;
                             action: string;
+                            match: string;
                             description?: string;
                         }[];
                     };