@faable/deploy-sdk 2.12.1 → 2.13.0

package/dist/api/types.d.ts

@@ -367,6 +367,46 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/app/{id}/repo/directories": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List repository directories
+         * @description Directories of the linked repository on the deploy branch, flagged with whether each one holds a buildable manifest. Feeds the Root Directory picker so a monorepo is configured from what the repository actually contains. Limited to three levels deep; dotted directories and node_modules are excluded.
+         */
+        get: operations["app/repo_directories"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/app/{id}/root-dir": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Set the Root Directory
+         * @description Set the platform Root Directory: the subdirectory of the repository the build runs from. Takes precedence over the repo's faable.json `rootDir`; `null` clears it and hands precedence back. The path must exist on the deploy branch.
+         */
+        post: operations["app/set_root_dir"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/app/{id}/deploy-mode": {
         parameters: {
             query?: never;
@@ -407,6 +447,50 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/app/{app_id}/waf": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get App WAF
+         * @description Get the WAF rules in effect for an App
+         */
+        get: operations["app/waf"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/app/{app_id}/waf/rules": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Add App WAF Rule
+         * @description Add a WAF rule to an App
+         */
+        post: operations["app/waf/addRule"];
+        /**
+         * Remove App WAF Rule
+         * @description Remove a WAF rule from an App
+         */
+        delete: operations["app/waf/removeRule"];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/deployment": {
         parameters: {
             query?: never;
@@ -479,6 +563,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/deployment/{deployment_id}/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Cancel a queued or building deployment
+         * @description Cancel a deployment that has not been handed over to the controller yet (QUEUED or BUILDING)
+         */
+        post: operations["deployment/cancel"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/domain": {
         parameters: {
             query?: never;
@@ -855,6 +959,26 @@ export interface components {
                 /** @description Container that was OOMKilled */
                 container?: string;
             } | null;
+            /** @description Runtime health flag for the promoted deployment (owner-facing outage signal) */
+            runtime_health?: {
+                /**
+                 * @description The container keeps exiting and being restarted (CrashLoopBackOff)
+                 * @enum {string}
+                 */
+                state: "crash_loop";
+                /** @description Deployment whose pod is crash-looping */
+                deployment: string;
+                /** @description ISO time the crash loop was last observed */
+                at: string;
+                /** @description Container that is crash-looping */
+                container?: string;
+                /** @description Restart count when observed */
+                restarts?: number;
+                /** @description Last exit code, when reported */
+                exit_code?: number;
+                /** @description K8s waiting/terminated reason */
+                reason?: string;
+            } | null;
         };
         AppRuntimeStrategy: string;
         /** @enum {unknown} */
@@ -885,7 +1009,7 @@ export interface components {
             active: boolean;
             /** @description Reason the app was administratively disabled. Null when the app is active. */
             disabled_reason?: string | null;
-            runtime: components["schemas"]["AppRuntime"];
+            runtime: ("node" | "php" | "python") | null;
             runtime_strategy: string | null;
             detected?: {
                 buildpack: string;
@@ -990,12 +1114,36 @@ export interface components {
             root_dir: string | null;
             root_dir_source: "platform" | "faable.json" | null;
         };
+        RepoDirectories: {
+            directories: {
+                path: string;
+                buildable: boolean;
+            }[];
+            truncated: boolean;
+        };
         DeployNowResult: {
             /** @enum {string} */
             status: "created";
             commit: string;
             branch: string;
         };
+        AppWafView: {
+            enabled: boolean;
+            platform_profiles: {
+                name: string;
+                action: string;
+                rule_count: number;
+                rules?: {
+                    pattern: string;
+                    description?: string;
+                }[];
+            }[];
+            rules: {
+                pattern: string;
+                action: string;
+                description?: string;
+            }[];
+        };
         DeploymentStatus: {
             /**
              * @description High-level summary of where the Deployment is in its lifecycle
@@ -1014,8 +1162,12 @@ export interface components {
             reason?: string;
             /** @description Scale-to-zero sub-state (admin-only): asleep, waking or null */
             cold_state?: "asleep" | "waking" | null;
-            /** @description Digest-pinned runtime image stamped at first materialization (artifact deploys) */
+            /** @description Runtime image (immutable version tag) this artifact deployment runs */
             runtime_image?: string;
+            /** @description Fetcher image (immutable version tag) of the artifact-prepare initContainer */
+            fetcher_image?: string;
+            /** @description Builder image (immutable version tag) that built this deployment */
+            builder_image?: string;
         };
         DeploymentSource: {
             manifest?: {
@@ -1073,6 +1225,9 @@ export interface components {
             artifact_id?: string;
             /** Format: date-time */
             artifact_ready_at?: string;
+            /** Format: date-time */
+            build_started_at?: string;
+            build_ms?: number;
             redeploy_of?: string;
             /** Format: date-time */
             quota_released_at?: string;
@@ -1242,9 +1397,11 @@ export interface components {
              */
             app_id: string | null;
             source: "builtin" | "manual" | "auto";
-            action: "deny" | "ratelimit" | "probe";
+            action: "deny" | "sink" | "ratelimit" | "probe";
             match: "path" | "user_agent";
             apply: "all" | "node" | "php" | "manual";
+            /** @description Runtimes excluded from `apply` (e.g. ["php"]) */
+            except?: ("all" | "node" | "php" | "manual")[];
             rules: {
                 /** @description RE2 path-regex fragment */
                 pattern: string;
@@ -1297,7 +1454,7 @@ export interface components {
             /** @description Owning App */
             app_id?: string;
             source?: "builtin" | "manual" | "auto";
-            action?: "deny" | "ratelimit" | "probe";
+            action?: "deny" | "sink" | "ratelimit" | "probe";
             match?: "path" | "user_agent";
             apply?: "all" | "node" | "php" | "manual";
             rules?: {
@@ -1313,7 +1470,7 @@ export interface components {
         };
         WafProfileUpdate: {
             name?: string;
-            action?: "deny" | "ratelimit" | "probe";
+            action?: "deny" | "sink" | "ratelimit" | "probe";
             match?: "path" | "user_agent";
             apply?: "all" | "node" | "php" | "manual";
             rules?: {
@@ -1579,6 +1736,98 @@ export interface components {
             released: string[];
             canceled: string[];
         };
+        /** @description PlatformImage */
+        PlatformImage: {
+            /** @description PlatformImage ID */
+            id: string;
+            team: string;
+            kind: "runtime" | "builder" | "fetcher" | "buildkit";
+            /** @description Canonical key: node:22, python:3.11, static, fetcher, buildkit */
+            key: string;
+            /** @description Repository ref without tag */
+            repository: string;
+            /** @description Version served to NEW deployments/builds */
+            current: string;
+            /** @description Floor: deployments stamped below it are rolled to current (mandatory update) */
+            min_version: string;
+            /** @description A CI registration of a newer release moves current */
+            auto_promote: boolean;
+            versions: {
+                /** @description Buildpacks release, X.Y.Z */
+                version: string;
+                /** @description Immutable image tag, e.g. 22-v1.20.1 */
+                tag: string;
+                /** @description sha256 the tag resolved to in ECR */
+                digest: string;
+                /** @default null */
+                size: number | null;
+                /** Format: date-time */
+                registered_at: string;
+                source: "ci" | "seed" | "manual";
+            }[];
+            /**
+             * Format: date-time
+             * @default null
+             */
+            updated_at: string | null;
+            /** @default {} */
+            metadata: {
+                [key: string]: unknown;
+            };
+            /** @description PlatformImage creation date */
+            createdAt: string;
+            /** @description PlatformImage updated date */
+            updatedAt?: string;
+        };
+        /** @description Event Platformimage Create */
+        EventPlatformimageCreate: {
+            /** @enum {string} */
+            type: "platformimage.create";
+            /** @description Timestamp */
+            produced_at: number;
+            payload: components["schemas"]["PlatformImage"];
+        };
+        /** @description Event Platformimage Update */
+        EventPlatformimageUpdate: {
+            /** @enum {string} */
+            type: "platformimage.update";
+            /** @description Timestamp */
+            produced_at: number;
+            payload: components["schemas"]["PlatformImage"];
+        };
+        /** @description Event Platformimage Delete */
+        EventPlatformimageDelete: {
+            /** @enum {string} */
+            type: "platformimage.delete";
+            /** @description Timestamp */
+            produced_at: number;
+            payload: components["schemas"]["PlatformImage"];
+        };
+        PlatformImageCreate: {
+            kind: "runtime" | "builder" | "fetcher" | "buildkit";
+            key: string;
+            repository: string;
+            current: string;
+            min_version: string;
+            auto_promote?: boolean;
+            versions?: {
+                /** @description Buildpacks release, X.Y.Z */
+                version: string;
+                /** @description Immutable image tag, e.g. 22-v1.20.1 */
+                tag: string;
+                /** @description sha256 the tag resolved to in ECR */
+                digest: string;
+                /** @default null */
+                size: number | null;
+                /** Format: date-time */
+                registered_at: string;
+                source: "ci" | "seed" | "manual";
+            }[];
+        };
+        PlatformImageUpdate: {
+            auto_promote?: boolean;
+            repository?: string;
+        };
         AppChecknameResponse: {
             name: string;
             slug: string;
@@ -1944,7 +2193,7 @@ export interface operations {
                         active: boolean;
                         /** @description Reason the app was administratively disabled. Null when the app is active. */
                         disabled_reason?: string | null;
-                        runtime: components["schemas"]["AppRuntime"];
+                        runtime: ("node" | "php" | "python") | null;
                         runtime_strategy: string | null;
                         detected?: {
                             buildpack: string;
@@ -2029,7 +2278,7 @@ export interface operations {
                         active: boolean;
                         /** @description Reason the app was administratively disabled. Null when the app is active. */
                         disabled_reason?: string | null;
-                        runtime: components["schemas"]["AppRuntime"];
+                        runtime: ("node" | "php" | "python") | null;
                         runtime_strategy: string | null;
                         detected?: {
                             buildpack: string;
@@ -2122,7 +2371,7 @@ export interface operations {
                         active: boolean;
                         /** @description Reason the app was administratively disabled. Null when the app is active. */
                         disabled_reason?: string | null;
-                        runtime: components["schemas"]["AppRuntime"];
+                        runtime: ("node" | "php" | "python") | null;
                         runtime_strategy: string | null;
                         detected?: {
                             buildpack: string;
@@ -2204,7 +2453,7 @@ export interface operations {
                         active: boolean;
                         /** @description Reason the app was administratively disabled. Null when the app is active. */
                         disabled_reason?: string | null;
-                        runtime: components["schemas"]["AppRuntime"];
+                        runtime: ("node" | "php" | "python") | null;
                         runtime_strategy: string | null;
                         detected?: {
                             buildpack: string;
@@ -2600,6 +2849,62 @@ export interface operations {
             };
         };
     };
+    "app/repo_directories": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        directories: {
+                            path: string;
+                            buildable: boolean;
+                        }[];
+                        truncated: boolean;
+                    };
+                };
+            };
+        };
+    };
+    "app/set_root_dir": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    root_dir: string | null;
+                };
+            };
+        };
+        responses: {
+            /** @description App */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["App"];
+                };
+            };
+        };
+    };
     "app/set_deploy_mode": {
         parameters: {
             query?: never;
@@ -2655,6 +2960,136 @@ export interface operations {
             };
         };
     };
+    "app/waf": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                app_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        enabled: boolean;
+                        platform_profiles: {
+                            name: string;
+                            action: string;
+                            rule_count: number;
+                            rules?: {
+                                pattern: string;
+                                description?: string;
+                            }[];
+                        }[];
+                        rules: {
+                            pattern: string;
+                            action: string;
+                            description?: string;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
+    "app/waf/addRule": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                app_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description RE2 path-regex fragment, e.g. ^/robots\.txt$ */
+                    pattern: string;
+                    /** @description deny → 403 at the edge; sink → synthetic 404 from the platform (the app is never woken) */
+                    action: "deny" | "sink";
+                    description?: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        enabled: boolean;
+                        platform_profiles: {
+                            name: string;
+                            action: string;
+                            rule_count: number;
+                            rules?: {
+                                pattern: string;
+                                description?: string;
+                            }[];
+                        }[];
+                        rules: {
+                            pattern: string;
+                            action: string;
+                            description?: string;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
+    "app/waf/removeRule": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                app_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    pattern: string;
+                };
+            };
+        };
+        responses: {
+            /** @description Default Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        enabled: boolean;
+                        platform_profiles: {
+                            name: string;
+                            action: string;
+                            rule_count: number;
+                            rules?: {
+                                pattern: string;
+                                description?: string;
+                            }[];
+                        }[];
+                        rules: {
+                            pattern: string;
+                            action: string;
+                            description?: string;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
     "deployment/list": {
         parameters: {
             query?: {
@@ -2730,6 +3165,9 @@ export interface operations {
                         artifact_id?: string;
                         /** Format: date-time */
                         artifact_ready_at?: string;
+                        /** Format: date-time */
+                        build_started_at?: string;
+                        build_ms?: number;
                         redeploy_of?: string;
                         /** Format: date-time */
                         quota_released_at?: string;
@@ -2780,6 +3218,9 @@ export interface operations {
                         artifact_id?: string;
                         /** Format: date-time */
                         artifact_ready_at?: string;
+                        /** Format: date-time */
+                        build_started_at?: string;
+                        build_ms?: number;
                         redeploy_of?: string;
                         /** Format: date-time */
                         quota_released_at?: string;
@@ -2839,6 +3280,9 @@ export interface operations {
                         artifact_id?: string;
                         /** Format: date-time */
                         artifact_ready_at?: string;
+                        /** Format: date-time */
+                        build_started_at?: string;
+                        build_ms?: number;
                         redeploy_of?: string;
                         /** Format: date-time */
                         quota_released_at?: string;
@@ -2889,6 +3333,9 @@ export interface operations {
                         artifact_id?: string;
                         /** Format: date-time */
                         artifact_ready_at?: string;
+                        /** Format: date-time */
+                        build_started_at?: string;
+                        build_ms?: number;
                         redeploy_of?: string;
                         /** Format: date-time */
                         quota_released_at?: string;
@@ -2943,6 +3390,59 @@ export interface operations {
             };
         };
     };
+    "deployment/cancel": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                deployment_id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Deployment */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /** @description Deployment ID */
+                        id: string;
+                        team: string;
+                        app_id: string;
+                        image?: string;
+                        release?: string;
+                        github_commit?: string;
+                        github_ref?: string;
+                        github_actor?: string;
+                        github_commit_message?: string;
+                        artifact_id?: string;
+                        /** Format: date-time */
+                        artifact_ready_at?: string;
+                        /** Format: date-time */
+                        build_started_at?: string;
+                        build_ms?: number;
+                        redeploy_of?: string;
+                        /** Format: date-time */
+                        quota_released_at?: string;
+                        trigger?: string | null;
+                        detected?: components["schemas"]["DeploymentDetected"];
+                        status: components["schemas"]["DeploymentStatus"];
+                        /** @default {} */
+                        metadata: {
+                            [key: string]: unknown;
+                        };
+                        /** @description Deployment creation date */
+                        createdAt: string;
+                        /** @description Deployment updated date */
+                        updatedAt?: string;
+                    };
+                };
+            };
+        };
+    };
     "domain/list": {
         parameters: {
             query?: {