@faable/deploy-sdk 2.16.0 → 2.17.1

package/dist/api/types.d.ts

@@ -1073,6 +1073,7 @@ export interface components {
                     name: string;
                     version?: string;
                 };
+                dockerfile_ignored?: boolean;
             } | null;
             mode: components["schemas"]["AppMode"];
             build_mode?: ("local" | "remote") | null;
@@ -1091,6 +1092,8 @@ export interface components {
             region: "gui1" | "poz1" | "ams1";
             /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
             notify_deploy_success?: boolean | null;
+            /** @description Whether HTTP/3 is advertised for this app. Absent/null = advertised; false = not advertised. Note it controls the advertisement, not the listener: clients that already discovered HTTP/3 may keep using it until the advertisement expires, and the server does not refuse it. */
+            http3?: boolean | null;
             status: components["schemas"]["AppStatus"];
             repository?: string;
             github_branch?: string;
@@ -1149,13 +1152,15 @@ export interface components {
             runtime?: components["schemas"]["AppRuntime"];
             runtime_strategy?: components["schemas"]["AppRuntimeStrategy"];
             instance_type?: string;
-            notify_deploy_success?: boolean | null;
+            /** @default null */
+            notify_deploy_success: boolean | null;
+            /** @default null */
+            http3: boolean | null;
         };
         /** @description Repository link pre-check */
         AppRepoLinkable: {
             linkable: boolean;
-            /** @enum {string} */
-            code?: "repository_already_linked";
+            code?: "repository_already_linked" | "repository_taken_down";
             message?: string;
             details?: {
                 app_id: string;
@@ -1280,6 +1285,20 @@ export interface components {
             static?: {
                 spa: boolean;
             };
+            images?: {
+                deviceSizes?: number[];
+                imageSizes?: number[];
+                formats?: string[];
+                qualities?: number[];
+                minimumCacheTTL?: number;
+                unoptimized?: boolean;
+                loader?: string;
+                path?: string;
+                basePath?: string;
+                assetPrefix?: boolean;
+                dangerouslyAllowSVG?: boolean;
+                remotePatterns?: number;
+            };
         };
         DeploymentDetected: {
             buildpack: string;
@@ -1288,6 +1307,7 @@ export interface components {
                 name: string;
                 version?: string;
             };
+            dockerfile_ignored?: boolean;
         };
         /** @description Deployment */
         Deployment: {
@@ -1362,6 +1382,9 @@ export interface components {
             artifact?: components["schemas"]["DeploymentArtifact"];
             type?: string;
             detected?: components["schemas"]["DeploymentDetected"];
+            plan?: {
+                [key: string]: unknown;
+            };
         };
         DomainStatus: {
             /**
@@ -1371,10 +1394,21 @@ export interface components {
              */
             dns_state: "pending" | "ok" | "misconfigured" | "error";
             /**
-             * @description ISO timestamp of the last DNS check
+             * @description ISO timestamp of the last DNS change
              * @default null
              */
             dns_checked_at: string | null;
+            /**
+             * @description ISO timestamp of the last DNS check
+             * @default null
+             */
+            dns_last_seen_at: string | null;
+            /**
+             * @description Why an `error` verdict could not conclude
+             * @default null
+             * @enum {string|null}
+             */
+            dns_error_kind: "transient" | "proxy" | null;
             /**
              * @description Expected CNAME target(s) the fqdn should point to
              * @default []
@@ -1385,6 +1419,11 @@ export interface components {
              * @default []
              */
             dns_observed: string[];
+            /**
+             * @description IPv4 address(es) the expected target currently resolves to
+             * @default []
+             */
+            dns_expected_ips: string[];
             /**
              * @description Human-readable diagnostic of the DNS check
              * @default null
@@ -1837,7 +1876,7 @@ export interface components {
             /** @description PlatformImage ID */
             id: string;
             team: string;
-            kind: "runtime" | "builder" | "fetcher" | "buildkit";
+            kind: "runtime" | "builder" | "fetcher" | "buildkit" | "detector";
             role: "workload" | "cluster";
             /** @description Canonical key: node:22, python:3.11, static, fetcher, buildkit */
             key: string;
@@ -1931,7 +1970,7 @@ export interface components {
             payload: components["schemas"]["PlatformImage"];
         };
         PlatformImageCreate: {
-            kind: "runtime" | "builder" | "fetcher" | "buildkit";
+            kind: "runtime" | "builder" | "fetcher" | "buildkit" | "detector";
             key: string;
             repository: string;
             current: string;
@@ -2030,8 +2069,11 @@ export interface components {
          *     - `build_token_unusable` (401): The deployment reached a terminal phase, so its build token no longer works.
          *     - `build_token_app_missing` (401): The app the build token was minted for no longer exists.
          *     - `user_token_required` (401): The endpoint acts on behalf of a person and the credential carries no user (an API key or a service account).
-         *     - `team_required` (400): The operation needs a project: send it in the `x-faable-team` header.
-         *     - `team_or_scope_required` (401): Listing needs either a project in `x-faable-team` or a global scope on the token.
+         *     - `team_required` (400): The operation needs a project: send it in the `x-faable-project` header (`project_<id>`).
+         *     - `team_or_scope_required` (401): Listing needs either a project in the `x-faable-project` header or a global scope on the token.
+         *     - `project_access_denied` (403): The caller is not a member of the project named in `x-faable-project`, or the credential belongs to another project.
+         *     - `project_header_conflict` (400): The request names two different projects (`x-faable-project` and the deprecated `x-faable-team`, or a query param). Send only `x-faable-project`.
+         *     - `invalid_project_id` (400): The project in `x-faable-project` is not a valid project id (`project_` followed by 24 hex characters).
          *     - `user_suspended` (403): The account is suspended. Contact support@faable.com.
          *     - `superadmin_only` (403): The operation is restricted to platform staff.
          *     - `project_not_found` (404): No project with that id for this caller.
@@ -2066,8 +2108,11 @@ export interface components {
          *     - `github_installation_suspended` (403): The GitHub App installation is suspended.
          *     - `github_installation_not_found` (412): The installation id is unknown or the App was uninstalled.
          *     - `github_repository_blocked` (403): GitHub refuses to serve the source of that repository (403 or 451).
+         *     - `github_rate_limited` (429): GitHub is rate-limiting Faable. Transient: retry after a short wait.
+         *     - `github_token_refresh_failed` (401): GitHub refused to refresh the stored authorization. The user has to reconnect.
          *     - `github_error` (502): GitHub failed upstream. `message` carries what it said.
          *     - `repository_already_linked` (409): The repository is already linked to another app. `details.app_id` / `details.app_name` name it.
+         *     - `repository_taken_down` (409): An app built from this repository was taken down for abuse, so the repository cannot be linked again. Not a plan limit — upgrading does not lift it. Restoring the taken-down app does.
          *     - `invalid_installation_id` (400): The `installation_id` is not a number.
          *     - `oidc_untrusted` (401): The GitHub Actions OIDC token was rejected. `message` says why.
          *     - `app_repository_mismatch` (403): The app does not exist or is not linked to the repository the token comes from.
@@ -2092,7 +2137,7 @@ export interface components {
          *     - `missing_github_event` (400): The `x-github-event` header is missing.
          * @enum {string}
          */
-        ApiErrorCode: "bad_request" | "validation_error" | "unauthorized" | "payment_required" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "payload_too_large" | "unsupported_media_type" | "unprocessable_entity" | "too_many_requests" | "internal_error" | "gone" | "bad_gateway" | "service_unavailable" | "already_exists" | "invalid_id" | "invalid_query" | "invalid_expand" | "search_not_supported" | "access_denied" | "invalid_token" | "invalid_apikey" | "apikey_expired" | "invalid_build_token" | "build_token_expired" | "build_token_unusable" | "build_token_app_missing" | "user_token_required" | "team_required" | "team_or_scope_required" | "user_suspended" | "superadmin_only" | "project_not_found" | "owner_only" | "owner_not_removable" | "collaborator_not_found" | "invalid_project_name" | "moderation_hold" | "app_not_found" | "repository_not_linked" | "repository_empty" | "branch_missing" | "deploy_mode_conflict" | "deploy_refused" | "invalid_root_dir" | "root_dir_not_found" | "root_dir_mismatch" | "no_workflows" | "no_deploy_workflow" | "invalid_secret_name" | "invalid_secret_context" | "app_secrets_only" | "secrets_access_denied" | "status_forbidden_resource" | "status_forbidden_field" | "status_forbidden_phase" | "github_identity_missing" | "github_installation_missing" | "github_repository_not_found" | "github_token_invalid" | "github_permission_denied" | "github_installation_suspended" | "github_installation_not_found" | "github_repository_blocked" | "github_error" | "repository_already_linked" | "invalid_installation_id" | "oidc_untrusted" | "app_repository_mismatch" | "no_app_for_repository" | "ambiguous_app_for_repository" | "app_disabled" | "app_rate_limited" | "plan_required" | "remote_build_disabled" | "artifact_deploy_disabled" | "artifact_too_large" | "metrics_unavailable" | "transfer_refused" | "user_not_found" | "waf_rule_not_found" | "project_rate_limited" | "project_plan_limited" | "domain_invalid" | "domain_reserved" | "domain_taken" | "invalid_json" | "missing_github_event";
+        ApiErrorCode: "bad_request" | "validation_error" | "unauthorized" | "payment_required" | "forbidden" | "not_found" | "method_not_allowed" | "conflict" | "payload_too_large" | "unsupported_media_type" | "unprocessable_entity" | "too_many_requests" | "internal_error" | "gone" | "bad_gateway" | "service_unavailable" | "already_exists" | "invalid_id" | "invalid_query" | "invalid_expand" | "search_not_supported" | "access_denied" | "invalid_token" | "invalid_apikey" | "apikey_expired" | "invalid_build_token" | "build_token_expired" | "build_token_unusable" | "build_token_app_missing" | "user_token_required" | "team_required" | "team_or_scope_required" | "project_access_denied" | "project_header_conflict" | "invalid_project_id" | "user_suspended" | "superadmin_only" | "project_not_found" | "owner_only" | "owner_not_removable" | "collaborator_not_found" | "invalid_project_name" | "moderation_hold" | "app_not_found" | "repository_not_linked" | "repository_empty" | "branch_missing" | "deploy_mode_conflict" | "deploy_refused" | "invalid_root_dir" | "root_dir_not_found" | "root_dir_mismatch" | "no_workflows" | "no_deploy_workflow" | "invalid_secret_name" | "invalid_secret_context" | "app_secrets_only" | "secrets_access_denied" | "status_forbidden_resource" | "status_forbidden_field" | "status_forbidden_phase" | "github_identity_missing" | "github_installation_missing" | "github_repository_not_found" | "github_token_invalid" | "github_permission_denied" | "github_installation_suspended" | "github_installation_not_found" | "github_repository_blocked" | "github_rate_limited" | "github_token_refresh_failed" | "github_error" | "repository_already_linked" | "repository_taken_down" | "invalid_installation_id" | "oidc_untrusted" | "app_repository_mismatch" | "no_app_for_repository" | "ambiguous_app_for_repository" | "app_disabled" | "app_rate_limited" | "plan_required" | "remote_build_disabled" | "artifact_deploy_disabled" | "artifact_too_large" | "metrics_unavailable" | "transfer_refused" | "user_not_found" | "waf_rule_not_found" | "project_rate_limited" | "project_plan_limited" | "domain_invalid" | "domain_reserved" | "domain_taken" | "invalid_json" | "missing_github_event";
         /** @description Every error response has this shape. Branch on `error_code`, never on `message`: the message is written for a person and may change. */
         ApiErrorResponse: {
             /** @description The HTTP status, repeated. */
@@ -2474,7 +2519,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description `team_or_scope_required` — Listing needs either a project in `x-faable-team` or a global scope on the token.
+            /** @description `team_or_scope_required` — Listing needs either a project in the `x-faable-project` header or a global scope on the token.
              *
              *     `unauthorized` — The request carries no valid credentials.
              *
@@ -2577,7 +2622,7 @@ export interface operations {
              *
              *     `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
              *
-             *     `team_required` — The operation needs a project: send it in the `x-faable-team` header. */
+             *     `team_required` — The operation needs a project: send it in the `x-faable-project` header (`project_<id>`). */
             400: {
                 headers: {
                     [name: string]: unknown;
@@ -3074,7 +3119,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description `team_or_scope_required` — Listing needs either a project in `x-faable-team` or a global scope on the token.
+            /** @description `team_or_scope_required` — Listing needs either a project in the `x-faable-project` header or a global scope on the token.
              *
              *     `unauthorized` — The request carries no valid credentials.
              *
@@ -3173,6 +3218,7 @@ export interface operations {
                                 name: string;
                                 version?: string;
                             };
+                            dockerfile_ignored?: boolean;
                         } | null;
                         mode: components["schemas"]["AppMode"];
                         build_mode?: ("local" | "remote") | null;
@@ -3191,6 +3237,8 @@ export interface operations {
                         region: "gui1" | "poz1" | "ams1";
                         /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
                         notify_deploy_success?: boolean | null;
+                        /** @description Whether HTTP/3 is advertised for this app. Absent/null = advertised; false = not advertised. Note it controls the advertisement, not the listener: clients that already discovered HTTP/3 may keep using it until the advertisement expires, and the server does not refuse it. */
+                        http3?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
@@ -3220,7 +3268,7 @@ export interface operations {
              *
              *     `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
              *
-             *     `team_required` — The operation needs a project: send it in the `x-faable-team` header. */
+             *     `team_required` — The operation needs a project: send it in the `x-faable-project` header (`project_<id>`). */
             400: {
                 headers: {
                     [name: string]: unknown;
@@ -3328,6 +3376,7 @@ export interface operations {
                                 name: string;
                                 version?: string;
                             };
+                            dockerfile_ignored?: boolean;
                         } | null;
                         mode: components["schemas"]["AppMode"];
                         build_mode?: ("local" | "remote") | null;
@@ -3346,6 +3395,8 @@ export interface operations {
                         region: "gui1" | "poz1" | "ams1";
                         /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
                         notify_deploy_success?: boolean | null;
+                        /** @description Whether HTTP/3 is advertised for this app. Absent/null = advertised; false = not advertised. Note it controls the advertisement, not the listener: clients that already discovered HTTP/3 may keep using it until the advertisement expires, and the server does not refuse it. */
+                        http3?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
@@ -3472,7 +3523,10 @@ export interface operations {
                     runtime?: components["schemas"]["AppRuntime"];
                     runtime_strategy?: components["schemas"]["AppRuntimeStrategy"];
                     instance_type?: string;
+                    /** @default null */
                     notify_deploy_success?: boolean | null;
+                    /** @default null */
+                    http3?: boolean | null;
                 };
             };
         };
@@ -3503,6 +3557,7 @@ export interface operations {
                                 name: string;
                                 version?: string;
                             };
+                            dockerfile_ignored?: boolean;
                         } | null;
                         mode: components["schemas"]["AppMode"];
                         build_mode?: ("local" | "remote") | null;
@@ -3521,6 +3576,8 @@ export interface operations {
                         region: "gui1" | "poz1" | "ams1";
                         /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
                         notify_deploy_success?: boolean | null;
+                        /** @description Whether HTTP/3 is advertised for this app. Absent/null = advertised; false = not advertised. Note it controls the advertisement, not the listener: clients that already discovered HTTP/3 may keep using it until the advertisement expires, and the server does not refuse it. */
+                        http3?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
@@ -3667,6 +3724,7 @@ export interface operations {
                                 name: string;
                                 version?: string;
                             };
+                            dockerfile_ignored?: boolean;
                         } | null;
                         mode: components["schemas"]["AppMode"];
                         build_mode?: ("local" | "remote") | null;
@@ -3685,6 +3743,8 @@ export interface operations {
                         region: "gui1" | "poz1" | "ams1";
                         /** @description Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this. */
                         notify_deploy_success?: boolean | null;
+                        /** @description Whether HTTP/3 is advertised for this app. Absent/null = advertised; false = not advertised. Note it controls the advertisement, not the listener: clients that already discovered HTTP/3 may keep using it until the advertisement expires, and the server does not refuse it. */
+                        http3?: boolean | null;
                         status: components["schemas"]["AppStatus"];
                         repository?: string;
                         github_branch?: string;
@@ -4552,7 +4612,9 @@ export interface operations {
                     };
                 };
             };
-            /** @description `repository_already_linked` — The repository is already linked to another app. `details.app_id` / `details.app_name` name it. */
+            /** @description `repository_already_linked` — The repository is already linked to another app. `details.app_id` / `details.app_name` name it.
+             *
+             *     `repository_taken_down` — An app built from this repository was taken down for abuse, so the repository cannot be linked again. Not a plan limit — upgrading does not lift it. Restoring the taken-down app does. */
             409: {
                 headers: {
                     [name: string]: unknown;
@@ -4560,7 +4622,7 @@ export interface operations {
                 content: {
                     "application/json": components["schemas"]["ApiErrorResponse"] & {
                         /** @enum {string} */
-                        error_code?: "repository_already_linked";
+                        error_code?: "repository_already_linked" | "repository_taken_down";
                     };
                 };
             };
@@ -5988,7 +6050,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description `team_or_scope_required` — Listing needs either a project in `x-faable-team` or a global scope on the token.
+            /** @description `team_or_scope_required` — Listing needs either a project in the `x-faable-project` header or a global scope on the token.
              *
              *     `unauthorized` — The request carries no valid credentials.
              *
@@ -6111,7 +6173,7 @@ export interface operations {
              *
              *     `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
              *
-             *     `team_required` — The operation needs a project: send it in the `x-faable-team` header. */
+             *     `team_required` — The operation needs a project: send it in the `x-faable-project` header (`project_<id>`). */
             400: {
                 headers: {
                     [name: string]: unknown;
@@ -6346,6 +6408,9 @@ export interface operations {
                     artifact?: components["schemas"]["DeploymentArtifact"];
                     type?: string;
                     detected?: components["schemas"]["DeploymentDetected"];
+                    plan?: {
+                        [key: string]: unknown;
+                    };
                 };
             };
         };
@@ -6883,7 +6948,7 @@ export interface operations {
                     };
                 };
             };
-            /** @description `team_or_scope_required` — Listing needs either a project in `x-faable-team` or a global scope on the token.
+            /** @description `team_or_scope_required` — Listing needs either a project in the `x-faable-project` header or a global scope on the token.
              *
              *     `unauthorized` — The request carries no valid credentials.
              *
@@ -7001,7 +7066,7 @@ export interface operations {
              *
              *     `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
              *
-             *     `team_required` — The operation needs a project: send it in the `x-faable-team` header.
+             *     `team_required` — The operation needs a project: send it in the `x-faable-project` header (`project_<id>`).
              *
              *     `domain_invalid` — Not a valid hostname. No protocol, port or path. */
             400: {