@vertracloud/api-types 0.1.0 → 0.2.0

package/payloads/v1/application.d.ts

@@ -1,7 +1,8 @@
-import { ISODateString, SnowFlake, UserPlan } from '../../common/v1.js';
+import { SnowFlake, UserPlan, ISODateString } from '../../common/v1.js';
+import './api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 type ApplicationLanguage = "javascript" | "typescript" | "bun" | "python" | "static" | "php" | "go" | "ruby" | "java" | "rust";
 declare const ApplicationLanguage: {
@@ -17,7 +18,7 @@ declare const ApplicationLanguage: {
     readonly RUST: "rust";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 type ApplicationStatus = "up" | "down";
 declare const ApplicationStatus: {
@@ -25,7 +26,7 @@ declare const ApplicationStatus: {
     readonly DOWN: "down";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 type ApplicationCluster = number;
 declare const ApplicationCluster: {
@@ -34,7 +35,7 @@ declare const ApplicationCluster: {
     readonly USA_3: 3;
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 type ApplicationType = 1 | 2;
 declare const ApplicationType: {
@@ -42,7 +43,7 @@ declare const ApplicationType: {
     readonly WEBSITE: 2;
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files
  */
 type ApplicationFileType = "file" | "directory";
 declare const ApplicationFileType: {
@@ -50,7 +51,7 @@ declare const ApplicationFileType: {
     readonly DIRECTORY: "directory";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 type ApplicationVersion = "recommended" | "latest" | "auto" | (string & {});
 declare const ApplicationVersion: {
@@ -59,14 +60,14 @@ declare const ApplicationVersion: {
     readonly AUTO: "auto";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content
  */
-type ApplicationFileContentType = "buffer";
+type ApplicationFileContentType = "base64";
 declare const ApplicationFileContentType: {
-    readonly BUFFER: "buffer";
+    readonly BASE64: "base64";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files
  */
 interface APIApplicationFile {
     type: ApplicationFileType;
@@ -76,20 +77,44 @@ interface APIApplicationFile {
     last_modified: ISODateString;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/tree
  */
 interface APIApplicationFileTree extends APIApplicationFile {
     children?: APIApplicationFileTree[];
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content
  */
 interface APIApplicationFileContent {
-    type: ApplicationFileContentType;
-    data: number[];
+    type: "base64";
+    /** File bytes in standard base64 (with padding). */
+    data: string;
+    /** Actual size in bytes (not the length of the base64 string). */
+    size: number;
+    /** File mtime; send it back on PUT (`last_modified`) to detect edit conflicts. */
+    last_modified: ISODateString;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * Successful ZIP upload through `POST /v1/apps/:id/files/upload`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/upload
+ */
+interface APIApplicationFileUpload {
+    app_id: SnowFlake;
+    updated_at: ISODateString;
+    missing_dependencies: string[];
+    removed_directories: string[];
+}
+/**
+ * Repository linked to the application for auto-deploy. The webhook URL is not included here.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
+ */
+interface APIApplicationGithub {
+    repo_owner: string;
+    repo_name: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 interface APIApplication {
     id: SnowFlake;
@@ -103,56 +128,98 @@ interface APIApplication {
     ram: number;
     status: ApplicationStatus;
     subdomain: string | null;
+    /**
+     * Canonical public URL of the app, computed by the server (`custom_domain` > `subdomain` >
+     * `null`). Clients should use it as-is instead of building the URL from the subdomain.
+     */
+    public_url: string | null;
+    /**
+     * GitHub integration of this application, if any. `null` = the source is a zip (or snapshot).
+     * May be absent in older payloads. The webhook URL is available from
+     * `GET /v1/apps/:id/deploys/webhook`.
+     */
+    github?: APIApplicationGithub | null;
     custom_domain: string | null;
     last_snapshot: ISODateString | null;
     created_at: ISODateString;
     updated_at: ISODateString;
     main_file: string;
     version: ApplicationVersion;
+    /** @deprecated Always `true` since 2026-09-17 — auto-restart is on for every plan; any value sent is ignored. */
     auto_restart: boolean;
     start_command: string | null;
-    use_credits: boolean;
-    credits_used?: number;
+    /**
+     * Build command, run once per deploy, after dependencies are installed and before the app
+     * starts — in the build environment, with more memory than the app. `null` = no build step.
+     * If it fails, the deploy fails and the app does not start.
+     */
+    build_command: string | null;
     offline_since: ISODateString | null;
+    missing_dependencies?: string[];
+    /** Active Vertra Shield containment (burst/rate limit); `null` when there is none. */
+    shield_cooldown: APIApplicationShieldCooldown | null;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
  */
 interface APIApplicationNetwork {
     total: string;
     now: string;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
- */
-interface APIApplicationActivity {
-    message: string;
-    timestamp: ISODateString;
-}
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/status
  */
 interface APIApplicationStatus {
     id: SnowFlake;
     cpu: string;
     ram: string;
-    status: ApplicationStatus;
+    /** @deprecated Not returned by `GET /v1/apps/:id/status`; use `running`. */
+    status?: ApplicationStatus;
     running: boolean;
+    /**
+     * `true` while dependencies are being installed.
+     *
+     * During this window the app itself is not running yet, so `running: false` alone does not
+     * mean the app is stopped. Optional: omitted when no installation is in progress.
+     */
+    installing?: boolean;
     storage: string;
-    network: APIApplicationNetwork;
+    /** `null` when network usage is unavailable (e.g. the app is stopped). */
+    network: APIApplicationNetwork | null;
     uptime: number;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/allstatus
  */
 interface APIApplicationStatusShort {
     id: SnowFlake;
     cpu: string;
     ram: string;
+    /** Absent when the app's status could not be read. */
+    storage?: string;
+    /** Absent when the app's status could not be read; `null` when network usage is unavailable. */
+    network?: APIApplicationNetwork | null;
     running: boolean;
+    /**
+     * `true` while dependencies are being installed.
+     *
+     * During this window the app itself is not running yet, so `running: false` alone does not
+     * mean the app is stopped. Optional: omitted when no installation is in progress.
+     */
+    installing?: boolean;
+    /**
+     * Seconds since the app started.
+     *
+     * A duration, not a point in time — hence `number` rather than `ISODateString`. Same unit and
+     * type as `APIApplicationStatus.uptime`.
+     *
+     * `null` when unknown (the app is stopped or its status could not be read). **`0` is never used
+     * as a sentinel** — `0` means "just started".
+     */
+    uptime: number | null;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics
  */
 interface APIApplicationMetric {
     cpu: number;
@@ -162,7 +229,7 @@ interface APIApplicationMetric {
     network: number[];
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create
  */
 interface APIApplicationConfig {
     NAME: string;
@@ -170,12 +237,15 @@ interface APIApplicationConfig {
     MAIN: string;
     VERSION: ApplicationVersion;
     DESCRIPTION?: string;
+    /** @deprecated Always `true` since 2026-09-17 — auto-restart is on for every plan; any value sent is ignored. */
     AUTORESTART?: boolean;
     START?: string;
+    /** Build command (see `APIApplication.build_command`). */
+    BUILD?: string;
     SUBDOMAIN?: string;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/get
  */
 interface APIApplicationEnvironment {
     id: string;
@@ -185,13 +255,13 @@ interface APIApplicationEnvironment {
     created_at: ISODateString;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start
  */
 interface APIApplicationOperationResponse {
-    status: string;
+    status: "success";
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/recents
  */
 interface APIApplicationDeployment {
     app_id: SnowFlake;
@@ -202,31 +272,149 @@ interface APIApplicationDeployment {
     created_at: ISODateString;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns
+ */
+type ApplicationDnsRecordType = "CNAME" | "TXT";
+declare const ApplicationDnsRecordType: {
+    readonly CNAME: "CNAME";
+    readonly TXT: "TXT";
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns
+ */
+type ApplicationDnsRecordStatus = "active" | "pending_validation";
+declare const ApplicationDnsRecordStatus: {
+    readonly ACTIVE: "active";
+    readonly PENDING_VALIDATION: "pending_validation";
+};
+/**
+ * DNS record the user must create at their DNS provider for the custom domain.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns
  */
-interface APIDnsRecord {
-    type: string;
+interface APIApplicationDnsRecord {
+    type: ApplicationDnsRecordType;
     name: string;
     value: string;
-    status: string;
+    status: ApplicationDnsRecordStatus;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * Returned when the auto-deploy webhook is created.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/create
  */
-interface APIWebhookUrl {
+interface APIApplicationWebhookUrl {
     url: string;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * Auto-deploy webhook of an application and the repository it is linked to.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/webhookurl
  */
-interface APISubdomainResponse {
+interface APIApplicationWebhook {
+    webhook_url: string;
+    repo_owner: string;
+    repo_name: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/subdomain
+ */
+interface APIApplicationSubdomain {
+    /** Full hostname (`my-app.vertraweb.app`). */
     subdomain: string;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/applications
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain
  */
-interface APICustomDomainResponse {
+interface APIApplicationCustomDomain {
     domain: string;
 }
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
+ */
+type ShieldIncidentReason = "burst" | "rate_limit";
+declare const ShieldIncidentReason: {
+    readonly BURST: "burst";
+    readonly RATE_LIMIT: "rate_limit";
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
+ */
+type ShieldIncidentDirection = "in" | "out";
+declare const ShieldIncidentDirection: {
+    readonly IN: "in";
+    readonly OUT: "out";
+};
+/**
+ * Active Vertra Shield containment on this application (bandwidth limit after a burst/rate limit).
+ * `null` when no containment is in effect.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get
+ */
+interface APIApplicationShieldCooldown {
+    until: ISODateString;
+    reason: ShieldIncidentReason;
+    direction: ShieldIncidentDirection;
+    strikes: number;
+}
+/**
+ * Web publishing state of an application.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish
+ */
+interface APIApplicationWebPublish {
+    /** `null` when web publishing is off. */
+    subdomain: string | null;
+    custom_domain: string | null;
+    type: ApplicationType;
+}
+/**
+ * Suggestions from scanning the zip before creating an application. Nothing is applied
+ * automatically: they are meant to pre-fill a creation form that the user can edit.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/scan
+ */
+interface APIApplicationScanSuggestions {
+    suggested_start_command?: string;
+    suggested_build_command?: string;
+    suggested_memory_mb?: number;
+    suggested_public_web?: boolean;
+    missing_dependencies?: string[];
+}
+/**
+ * One runtime of `GET /v1/apps/runtimes`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/runtimes
+ */
+interface APIApplicationRuntime {
+    /** Recommended version for new applications. */
+    recommended: string;
+    latest: string;
+    /** Other exact versions that can be pinned. Empty for runtimes without version pinning. */
+    specific: string[];
+}
+/**
+ * Catalog of supported runtimes, keyed by language.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/runtimes
+ */
+type APIApplicationRuntimes = Record<ApplicationLanguage, APIApplicationRuntime>;
+/**
+ * `event` field of the `GET /v1/apps/:id/realtime` stream (`text/event-stream`).
+ * `logs` = application output (one or more lines); `system` = stream/platform notices (e.g.
+ * `install_note:started`); `heartbeat` = keep-alive, no content.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime
+ */
+type ApplicationRealtimeEventType = "logs" | "system" | "heartbeat";
+declare const ApplicationRealtimeEventType: {
+    readonly LOGS: "logs";
+    readonly SYSTEM: "system";
+    readonly HEARTBEAT: "heartbeat";
+};
+/**
+ * One server-sent event of `GET /v1/apps/:id/realtime`. `data` is plain text, not JSON; a `logs`
+ * event may carry several lines separated by `\n`.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime
+ */
+interface APIApplicationRealtimeEvent {
+    event: ApplicationRealtimeEventType;
+    data: string;
+}
 
-export { type APIApplication, type APIApplicationActivity, type APIApplicationConfig, type APIApplicationDeployment, type APIApplicationEnvironment, type APIApplicationFile, type APIApplicationFileContent, type APIApplicationFileTree, type APIApplicationMetric, type APIApplicationNetwork, type APIApplicationOperationResponse, type APIApplicationStatus, type APIApplicationStatusShort, type APICustomDomainResponse, type APIDnsRecord, type APISubdomainResponse, type APIWebhookUrl, ApplicationCluster, ApplicationFileContentType, ApplicationFileType, ApplicationLanguage, ApplicationStatus, ApplicationType, ApplicationVersion };
+export { type APIApplication, type APIApplicationConfig, type APIApplicationCustomDomain, type APIApplicationDeployment, type APIApplicationDnsRecord, type APIApplicationEnvironment, type APIApplicationFile, type APIApplicationFileContent, type APIApplicationFileTree, type APIApplicationFileUpload, type APIApplicationGithub, type APIApplicationMetric, type APIApplicationNetwork, type APIApplicationOperationResponse, type APIApplicationRealtimeEvent, type APIApplicationRuntime, type APIApplicationRuntimes, type APIApplicationScanSuggestions, type APIApplicationShieldCooldown, type APIApplicationStatus, type APIApplicationStatusShort, type APIApplicationSubdomain, type APIApplicationWebPublish, type APIApplicationWebhook, type APIApplicationWebhookUrl, ApplicationCluster, ApplicationDnsRecordStatus, ApplicationDnsRecordType, ApplicationFileContentType, ApplicationFileType, ApplicationLanguage, ApplicationRealtimeEventType, ApplicationStatus, ApplicationType, ApplicationVersion, ShieldIncidentDirection, ShieldIncidentReason };

package/payloads/v1/application.js

@@ -21,12 +21,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var application_exports = {};
 __export(application_exports, {
   ApplicationCluster: () => ApplicationCluster,
+  ApplicationDnsRecordStatus: () => ApplicationDnsRecordStatus,
+  ApplicationDnsRecordType: () => ApplicationDnsRecordType,
   ApplicationFileContentType: () => ApplicationFileContentType,
   ApplicationFileType: () => ApplicationFileType,
   ApplicationLanguage: () => ApplicationLanguage,
+  ApplicationRealtimeEventType: () => ApplicationRealtimeEventType,
   ApplicationStatus: () => ApplicationStatus,
   ApplicationType: () => ApplicationType,
-  ApplicationVersion: () => ApplicationVersion
+  ApplicationVersion: () => ApplicationVersion,
+  ShieldIncidentDirection: () => ShieldIncidentDirection,
+  ShieldIncidentReason: () => ShieldIncidentReason
 });
 module.exports = __toCommonJS(application_exports);
 var ApplicationLanguage = {
@@ -64,16 +69,42 @@ var ApplicationVersion = {
   AUTO: "auto"
 };
 var ApplicationFileContentType = {
-  BUFFER: "buffer"
+  BASE64: "base64"
+};
+var ApplicationDnsRecordType = {
+  CNAME: "CNAME",
+  TXT: "TXT"
+};
+var ApplicationDnsRecordStatus = {
+  ACTIVE: "active",
+  PENDING_VALIDATION: "pending_validation"
+};
+var ShieldIncidentReason = {
+  BURST: "burst",
+  RATE_LIMIT: "rate_limit"
+};
+var ShieldIncidentDirection = {
+  IN: "in",
+  OUT: "out"
+};
+var ApplicationRealtimeEventType = {
+  LOGS: "logs",
+  SYSTEM: "system",
+  HEARTBEAT: "heartbeat"
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ApplicationCluster,
+  ApplicationDnsRecordStatus,
+  ApplicationDnsRecordType,
   ApplicationFileContentType,
   ApplicationFileType,
   ApplicationLanguage,
+  ApplicationRealtimeEventType,
   ApplicationStatus,
   ApplicationType,
-  ApplicationVersion
+  ApplicationVersion,
+  ShieldIncidentDirection,
+  ShieldIncidentReason
 });
 //# sourceMappingURL=application.js.map

package/payloads/v1/application.js.map

@@ -1 +1 @@
-{"version":3,"sources":["application.ts"],"sourcesContent":["import type { ISODateString, SnowFlake, UserPlan } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationLanguage = \"javascript\" | \"typescript\" | \"bun\" | \"python\" | \"static\" | \"php\" | \"go\" | \"ruby\" | \"java\" | \"rust\";\nexport const ApplicationLanguage = {\n\tJAVASCRIPT: \"javascript\",\n\tTYPESCRIPT: \"typescript\",\n\tBUN: \"bun\",\n\tPYTHON: \"python\",\n\tSTATIC: \"static\",\n\tPHP: \"php\",\n\tGO: \"go\",\n\tRUBY: \"ruby\",\n\tJAVA: \"java\",\n\tRUST: \"rust\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationStatus = \"up\" | \"down\";\nexport const ApplicationStatus = {\n\tUP: \"up\",\n\tDOWN: \"down\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationCluster = number;\nexport const ApplicationCluster = {\n\tUSA_1: 1,\n\tUSA_2: 2,\n\tUSA_3: 3,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationType = 1 | 2;\nexport const ApplicationType = {\n\tBOT: 1,\n\tWEBSITE: 2,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationFileType = \"file\" | \"directory\";\nexport const ApplicationFileType = {\n\tFILE: \"file\",\n\tDIRECTORY: \"directory\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationVersion = \"recommended\" | \"latest\" | \"auto\" | (string & {});\nexport const ApplicationVersion = {\n\tRECOMMENDED: \"recommended\",\n\tLATEST: \"latest\",\n\tAUTO: \"auto\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport type ApplicationFileContentType = \"buffer\";\nexport const ApplicationFileContentType = {\n\tBUFFER: \"buffer\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationFile {\n\ttype: ApplicationFileType;\n\tname: string;\n\tpath: string;\n\tsize?: string;\n\tlast_modified: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationFileTree extends APIApplicationFile {\n\tchildren?: APIApplicationFileTree[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationFileContent {\n\ttype: ApplicationFileContentType;\n\tdata: number[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplication {\n\tid: SnowFlake;\n\tcluster: ApplicationCluster;\n\ttype: ApplicationType;\n\tname: string;\n\tdescription?: string;\n\towner_id: string; // UUID\n\towner_plan_id: UserPlan; // Owner App Plan\n\tlanguage: ApplicationLanguage;\n\tram: number;\n\tstatus: ApplicationStatus;\n\tsubdomain: string | null; // example: \"my-app.vertraweb.com\"\n\tcustom_domain: string | null; // example: \"my-app.com.br\"\n\tlast_snapshot: ISODateString | null;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n\tmain_file: string;\n\tversion: ApplicationVersion;\n\tauto_restart: boolean;\n\tstart_command: string | null;\n\tuse_credits: boolean;\n\tcredits_used?: number;\n\toffline_since: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationNetwork {\n\ttotal: string;\n\tnow: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationActivity {\n\tmessage: string;\n\ttimestamp: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationStatus {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\tstatus: ApplicationStatus;\n\trunning: boolean;\n\tstorage: string;\n\tnetwork: APIApplicationNetwork;\n\tuptime: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationStatusShort {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\trunning: boolean;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationMetric {\n\tcpu: number;\n\tram: number;\n\tstorage: number;\n\tdate: ISODateString;\n\tnetwork: number[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationConfig {\n\tNAME: string;\n\tMEMORY: number;\n\tMAIN: string;\n\tVERSION: ApplicationVersion;\n\tDESCRIPTION?: string;\n\tAUTORESTART?: boolean;\n\tSTART?: string;\n\tSUBDOMAIN?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationEnvironment {\n\tid: string;\n\tkey: string;\n\tvalue: string;\n\tnote: string | null;\n\tcreated_at: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationOperationResponse {\n\tstatus: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIApplicationDeployment {\n\tapp_id: SnowFlake;\n\tcommit_id: string;\n\tmessage: string;\n\tpusher: string;\n\tbranch: string;\n\tcreated_at: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIDnsRecord {\n\ttype: string;\n\tname: string;\n\tvalue: string;\n\tstatus: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APIWebhookUrl {\n\turl: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APISubdomainResponse {\n\tsubdomain: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/applications\n */\nexport interface APICustomDomainResponse {\n\tdomain: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,sBAAsB;AAAA,EAClC,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,KAAK;AAAA,EACL,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,KAAK;AAAA,EACL,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AACP;AAMO,IAAM,oBAAoB;AAAA,EAChC,IAAI;AAAA,EACJ,MAAM;AACP;AAMO,IAAM,qBAAqB;AAAA,EACjC,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACR;AAMO,IAAM,kBAAkB;AAAA,EAC9B,KAAK;AAAA,EACL,SAAS;AACV;AAMO,IAAM,sBAAsB;AAAA,EAClC,MAAM;AAAA,EACN,WAAW;AACZ;AAMO,IAAM,qBAAqB;AAAA,EACjC,aAAa;AAAA,EACb,QAAQ;AAAA,EACR,MAAM;AACP;AAMO,IAAM,6BAA6B;AAAA,EACzC,QAAQ;AACT;","names":[]}
+{"version":3,"sources":["application.ts"],"sourcesContent":["import type { ISODateString, SnowFlake, UserPlan } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ApplicationLanguage = \"javascript\" | \"typescript\" | \"bun\" | \"python\" | \"static\" | \"php\" | \"go\" | \"ruby\" | \"java\" | \"rust\";\nexport const ApplicationLanguage = {\n\tJAVASCRIPT: \"javascript\",\n\tTYPESCRIPT: \"typescript\",\n\tBUN: \"bun\",\n\tPYTHON: \"python\",\n\tSTATIC: \"static\",\n\tPHP: \"php\",\n\tGO: \"go\",\n\tRUBY: \"ruby\",\n\tJAVA: \"java\",\n\tRUST: \"rust\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ApplicationStatus = \"up\" | \"down\";\nexport const ApplicationStatus = {\n\tUP: \"up\",\n\tDOWN: \"down\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ApplicationCluster = number;\nexport const ApplicationCluster = {\n\tUSA_1: 1,\n\tUSA_2: 2,\n\tUSA_3: 3,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ApplicationType = 1 | 2;\nexport const ApplicationType = {\n\tBOT: 1,\n\tWEBSITE: 2,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files\n */\nexport type ApplicationFileType = \"file\" | \"directory\";\nexport const ApplicationFileType = {\n\tFILE: \"file\",\n\tDIRECTORY: \"directory\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ApplicationVersion = \"recommended\" | \"latest\" | \"auto\" | (string & {});\nexport const ApplicationVersion = {\n\tRECOMMENDED: \"recommended\",\n\tLATEST: \"latest\",\n\tAUTO: \"auto\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content\n */\nexport type ApplicationFileContentType = \"base64\";\nexport const ApplicationFileContentType = {\n\tBASE64: \"base64\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/files\n */\nexport interface APIApplicationFile {\n\ttype: ApplicationFileType;\n\tname: string;\n\tpath: string;\n\tsize?: string;\n\tlast_modified: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/tree\n */\nexport interface APIApplicationFileTree extends APIApplicationFile {\n\tchildren?: APIApplicationFileTree[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/content\n */\nexport interface APIApplicationFileContent {\n\ttype: \"base64\";\n\t/** File bytes in standard base64 (with padding). */\n\tdata: string;\n\t/** Actual size in bytes (not the length of the base64 string). */\n\tsize: number;\n\t/** File mtime; send it back on PUT (`last_modified`) to detect edit conflicts. */\n\tlast_modified: ISODateString;\n}\n\n/**\n * Successful ZIP upload through `POST /v1/apps/:id/files/upload`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/filemanager/upload\n */\nexport interface APIApplicationFileUpload {\n\tapp_id: SnowFlake;\n\tupdated_at: ISODateString;\n\tmissing_dependencies: string[];\n\tremoved_directories: string[];\n}\n\n/**\n * Repository linked to the application for auto-deploy. The webhook URL is not included here.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport interface APIApplicationGithub {\n\trepo_owner: string;\n\trepo_name: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport interface APIApplication {\n\tid: SnowFlake;\n\tcluster: ApplicationCluster;\n\ttype: ApplicationType;\n\tname: string;\n\tdescription?: string;\n\towner_id: string; // UUID\n\towner_plan_id: UserPlan; // Owner's plan\n\tlanguage: ApplicationLanguage;\n\tram: number;\n\tstatus: ApplicationStatus;\n\tsubdomain: string | null; // example: \"my-app.vertraweb.app\"\n\t/**\n\t * Canonical public URL of the app, computed by the server (`custom_domain` > `subdomain` >\n\t * `null`). Clients should use it as-is instead of building the URL from the subdomain.\n\t */\n\tpublic_url: string | null;\n\t/**\n\t * GitHub integration of this application, if any. `null` = the source is a zip (or snapshot).\n\t * May be absent in older payloads. The webhook URL is available from\n\t * `GET /v1/apps/:id/deploys/webhook`.\n\t */\n\tgithub?: APIApplicationGithub | null;\n\tcustom_domain: string | null; // example: \"my-app.com.br\"\n\tlast_snapshot: ISODateString | null;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n\tmain_file: string;\n\tversion: ApplicationVersion;\n\t/** @deprecated Always `true` since 2026-09-17 — auto-restart is on for every plan; any value sent is ignored. */\n\tauto_restart: boolean;\n\tstart_command: string | null;\n\t/**\n\t * Build command, run once per deploy, after dependencies are installed and before the app\n\t * starts — in the build environment, with more memory than the app. `null` = no build step.\n\t * If it fails, the deploy fails and the app does not start.\n\t */\n\tbuild_command: string | null;\n\toffline_since: ISODateString | null;\n\tmissing_dependencies?: string[]; // Undeclared packages detected on build/deploy\n\t/** Active Vertra Shield containment (burst/rate limit); `null` when there is none. */\n\tshield_cooldown: APIApplicationShieldCooldown | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport interface APIApplicationNetwork {\n\ttotal: string;\n\tnow: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/status\n */\nexport interface APIApplicationStatus {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\t/** @deprecated Not returned by `GET /v1/apps/:id/status`; use `running`. */\n\tstatus?: ApplicationStatus;\n\trunning: boolean;\n\t/**\n\t * `true` while dependencies are being installed.\n\t *\n\t * During this window the app itself is not running yet, so `running: false` alone does not\n\t * mean the app is stopped. Optional: omitted when no installation is in progress.\n\t */\n\tinstalling?: boolean;\n\tstorage: string;\n\t/** `null` when network usage is unavailable (e.g. the app is stopped). */\n\tnetwork: APIApplicationNetwork | null;\n\tuptime: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/allstatus\n */\nexport interface APIApplicationStatusShort {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\t/** Absent when the app's status could not be read. */\n\tstorage?: string;\n\t/** Absent when the app's status could not be read; `null` when network usage is unavailable. */\n\tnetwork?: APIApplicationNetwork | null;\n\trunning: boolean;\n\t/**\n\t * `true` while dependencies are being installed.\n\t *\n\t * During this window the app itself is not running yet, so `running: false` alone does not\n\t * mean the app is stopped. Optional: omitted when no installation is in progress.\n\t */\n\tinstalling?: boolean;\n\t/**\n\t * Seconds since the app started.\n\t *\n\t * A duration, not a point in time — hence `number` rather than `ISODateString`. Same unit and\n\t * type as `APIApplicationStatus.uptime`.\n\t *\n\t * `null` when unknown (the app is stopped or its status could not be read). **`0` is never used\n\t * as a sentinel** — `0` means \"just started\".\n\t */\n\tuptime: number | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/metrics\n */\nexport interface APIApplicationMetric {\n\tcpu: number;\n\tram: number;\n\tstorage: number;\n\tdate: ISODateString;\n\tnetwork: number[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/create\n */\nexport interface APIApplicationConfig {\n\tNAME: string;\n\tMEMORY: number;\n\tMAIN: string;\n\tVERSION: ApplicationVersion;\n\tDESCRIPTION?: string;\n\t/** @deprecated Always `true` since 2026-09-17 — auto-restart is on for every plan; any value sent is ignored. */\n\tAUTORESTART?: boolean;\n\tSTART?: string;\n\t/** Build command (see `APIApplication.build_command`). */\n\tBUILD?: string;\n\tSUBDOMAIN?: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/enviroments/get\n */\nexport interface APIApplicationEnvironment {\n\tid: string;\n\tkey: string;\n\tvalue: string;\n\tnote: string | null;\n\tcreated_at: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/start\n */\nexport interface APIApplicationOperationResponse {\n\tstatus: \"success\";\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/recents\n */\nexport interface APIApplicationDeployment {\n\tapp_id: SnowFlake;\n\tcommit_id: string;\n\tmessage: string;\n\tpusher: string;\n\tbranch: string;\n\tcreated_at: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns\n */\nexport type ApplicationDnsRecordType = \"CNAME\" | \"TXT\";\nexport const ApplicationDnsRecordType = {\n\tCNAME: \"CNAME\",\n\tTXT: \"TXT\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns\n */\nexport type ApplicationDnsRecordStatus = \"active\" | \"pending_validation\";\nexport const ApplicationDnsRecordStatus = {\n\tACTIVE: \"active\",\n\tPENDING_VALIDATION: \"pending_validation\",\n} as const;\n\n/**\n * DNS record the user must create at their DNS provider for the custom domain.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/dns\n */\nexport interface APIApplicationDnsRecord {\n\ttype: ApplicationDnsRecordType;\n\tname: string;\n\tvalue: string;\n\tstatus: ApplicationDnsRecordStatus;\n}\n\n/**\n * Returned when the auto-deploy webhook is created.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/create\n */\nexport interface APIApplicationWebhookUrl {\n\turl: string;\n}\n\n/**\n * Auto-deploy webhook of an application and the repository it is linked to.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/deploys/webhookurl\n */\nexport interface APIApplicationWebhook {\n\twebhook_url: string;\n\trepo_owner: string;\n\trepo_name: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/subdomain\n */\nexport interface APIApplicationSubdomain {\n\t/** Full hostname (`my-app.vertraweb.app`). */\n\tsubdomain: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/customdomain\n */\nexport interface APIApplicationCustomDomain {\n\tdomain: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ShieldIncidentReason = \"burst\" | \"rate_limit\";\nexport const ShieldIncidentReason = {\n\tBURST: \"burst\",\n\tRATE_LIMIT: \"rate_limit\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport type ShieldIncidentDirection = \"in\" | \"out\";\nexport const ShieldIncidentDirection = {\n\tIN: \"in\",\n\tOUT: \"out\",\n} as const;\n\n/**\n * Active Vertra Shield containment on this application (bandwidth limit after a burst/rate limit).\n * `null` when no containment is in effect.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/get\n */\nexport interface APIApplicationShieldCooldown {\n\tuntil: ISODateString;\n\treason: ShieldIncidentReason;\n\tdirection: ShieldIncidentDirection;\n\tstrikes: number;\n}\n\n/**\n * Web publishing state of an application.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/network/publish\n */\nexport interface APIApplicationWebPublish {\n\t/** `null` when web publishing is off. */\n\tsubdomain: string | null;\n\tcustom_domain: string | null;\n\ttype: ApplicationType;\n}\n\n/**\n * Suggestions from scanning the zip before creating an application. Nothing is applied\n * automatically: they are meant to pre-fill a creation form that the user can edit.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/scan\n */\nexport interface APIApplicationScanSuggestions {\n\tsuggested_start_command?: string;\n\tsuggested_build_command?: string;\n\tsuggested_memory_mb?: number;\n\tsuggested_public_web?: boolean;\n\tmissing_dependencies?: string[];\n}\n\n/**\n * One runtime of `GET /v1/apps/runtimes`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/runtimes\n */\nexport interface APIApplicationRuntime {\n\t/** Recommended version for new applications. */\n\trecommended: string;\n\tlatest: string;\n\t/** Other exact versions that can be pinned. Empty for runtimes without version pinning. */\n\tspecific: string[];\n}\n\n/**\n * Catalog of supported runtimes, keyed by language.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/runtimes\n */\nexport type APIApplicationRuntimes = Record<ApplicationLanguage, APIApplicationRuntime>;\n\n/**\n * `event` field of the `GET /v1/apps/:id/realtime` stream (`text/event-stream`).\n * `logs` = application output (one or more lines); `system` = stream/platform notices (e.g.\n * `install_note:started`); `heartbeat` = keep-alive, no content.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime\n */\nexport type ApplicationRealtimeEventType = \"logs\" | \"system\" | \"heartbeat\";\nexport const ApplicationRealtimeEventType = {\n\tLOGS: \"logs\",\n\tSYSTEM: \"system\",\n\tHEARTBEAT: \"heartbeat\",\n} as const;\n\n/**\n * One server-sent event of `GET /v1/apps/:id/realtime`. `data` is plain text, not JSON; a `logs`\n * event may carry several lines separated by `\\n`.\n * @see https://docs.vertracloud.app/api-reference/endpoint/apps/realtime\n */\nexport interface APIApplicationRealtimeEvent {\n\tevent: ApplicationRealtimeEventType;\n\tdata: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,sBAAsB;AAAA,EAClC,YAAY;AAAA,EACZ,YAAY;AAAA,EACZ,KAAK;AAAA,EACL,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,KAAK;AAAA,EACL,IAAI;AAAA,EACJ,MAAM;AAAA,EACN,MAAM;AAAA,EACN,MAAM;AACP;AAMO,IAAM,oBAAoB;AAAA,EAChC,IAAI;AAAA,EACJ,MAAM;AACP;AAMO,IAAM,qBAAqB;AAAA,EACjC,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACR;AAMO,IAAM,kBAAkB;AAAA,EAC9B,KAAK;AAAA,EACL,SAAS;AACV;AAMO,IAAM,sBAAsB;AAAA,EAClC,MAAM;AAAA,EACN,WAAW;AACZ;AAMO,IAAM,qBAAqB;AAAA,EACjC,aAAa;AAAA,EACb,QAAQ;AAAA,EACR,MAAM;AACP;AAMO,IAAM,6BAA6B;AAAA,EACzC,QAAQ;AACT;AAiOO,IAAM,2BAA2B;AAAA,EACvC,OAAO;AAAA,EACP,KAAK;AACN;AAMO,IAAM,6BAA6B;AAAA,EACzC,QAAQ;AAAA,EACR,oBAAoB;AACrB;AAmDO,IAAM,uBAAuB;AAAA,EACnC,OAAO;AAAA,EACP,YAAY;AACb;AAMO,IAAM,0BAA0B;AAAA,EACtC,IAAI;AAAA,EACJ,KAAK;AACN;AAkEO,IAAM,+BAA+B;AAAA,EAC3C,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,WAAW;AACZ;","names":[]}

package/payloads/v1/application.mjs

@@ -34,15 +34,41 @@ var ApplicationVersion = {
   AUTO: "auto"
 };
 var ApplicationFileContentType = {
-  BUFFER: "buffer"
+  BASE64: "base64"
+};
+var ApplicationDnsRecordType = {
+  CNAME: "CNAME",
+  TXT: "TXT"
+};
+var ApplicationDnsRecordStatus = {
+  ACTIVE: "active",
+  PENDING_VALIDATION: "pending_validation"
+};
+var ShieldIncidentReason = {
+  BURST: "burst",
+  RATE_LIMIT: "rate_limit"
+};
+var ShieldIncidentDirection = {
+  IN: "in",
+  OUT: "out"
+};
+var ApplicationRealtimeEventType = {
+  LOGS: "logs",
+  SYSTEM: "system",
+  HEARTBEAT: "heartbeat"
 };
 export {
   ApplicationCluster,
+  ApplicationDnsRecordStatus,
+  ApplicationDnsRecordType,
   ApplicationFileContentType,
   ApplicationFileType,
   ApplicationLanguage,
+  ApplicationRealtimeEventType,
   ApplicationStatus,
   ApplicationType,
-  ApplicationVersion
+  ApplicationVersion,
+  ShieldIncidentDirection,
+  ShieldIncidentReason
 };
 //# sourceMappingURL=application.mjs.map