@lizard-build/sdk 0.1.61 → 0.1.63

package/dist/index.d.mts

@@ -68,7 +68,7 @@ interface Addon {
     name: string;
     type: AddonType;
     projectId: string;
-    status: 'none' | 'running' | 'crashed' | 'stopped';
+    status: 'none' | 'running' | 'crashed' | 'stopped' | 'paused';
     deployStatus: string;
     version?: string;
     /** Exposed connection variables (e.g. DATABASE_URL, REDIS_URL). */
@@ -117,6 +117,17 @@ declare class AddonsAPI {
     }): Promise<Addon>;
     /** Restart an addon. */
     redeploy(projectId: string, addonId: string): Promise<void>;
+    /**
+     * Pause a managed database: it scales to 0 (connections are refused) and keeps its host,
+     * port, password and data. Postgres and Redis.
+     */
+    pause(projectId: string, addonId: string): Promise<PauseState>;
+    /** Resume a paused database: same host, port, password and data. */
+    resume(projectId: string, addonId: string): Promise<PauseState>;
+    /** Serverless setting of a database (Postgres, Redis). */
+    getSleep(projectId: string, addonId: string): Promise<SleepSetting>;
+    /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+    setSleep(projectId: string, addonId: string, opts: SleepOpts): Promise<SleepSetting>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
         key: string;
@@ -136,6 +147,45 @@ interface CreateProjectOpts {
     workspaceId: string;
     name: string;
 }
+/** One app or managed database a project / workspace pause or resume acted on. */
+interface PausedService {
+    kind: 'app' | 'database';
+    id: string;
+    name: string;
+}
+/** What `projects.pause/resume` and `workspaces.pause/resume` answer: what was done, and
+ *  what was skipped with why (already paused, not running, busy, a storage bucket...). */
+interface PauseResult {
+    done: PausedService[];
+    skipped: Array<PausedService & {
+        reason: string;
+    }>;
+}
+/**
+ * Serverless ("sleep when idle"): after `idleMinutes` with no traffic the service sleeps with
+ * its memory saved, and the next request or connection wakes it in about a second.
+ */
+interface SleepSetting {
+    enabled: boolean;
+    idleMinutes: number;
+    lastSleptAt: number | null;
+    lastWokeAt: number | null;
+    lastError: string | null;
+    sleeps: number;
+    wakes: number;
+    /** On a change: whether the service restarted to apply it. */
+    restarted?: boolean;
+}
+/** Turn serverless on (`idleMinutes` 5-1440, default 15) or off. */
+interface SleepOpts {
+    enabled: boolean;
+    idleMinutes?: number;
+}
+/** What pausing or resuming one service answers. */
+interface PauseState {
+    ok: boolean;
+    status: 'paused' | 'running';
+}
 declare class ProjectsAPI {
     private readonly client;
     constructor(client: PlatformClient);
@@ -154,6 +204,13 @@ declare class ProjectsAPI {
     update(id: string, opts: {
         name?: string;
     }): Promise<Project>;
+    /**
+     * Pause every app and managed database of a project: each scales to 0 and keeps its URL,
+     * host, port, password, settings and volumes. Skipped ones are listed with why.
+     */
+    pause(id: string): Promise<PauseResult>;
+    /** Resume what was paused in a project (not what a billing freeze paused). */
+    resume(id: string): Promise<PauseResult>;
     /** Delete a project. */
     delete(id: string): Promise<void>;
     apply(id: string, config: ProjectConfig): Promise<ConfigResult>;
@@ -205,7 +262,7 @@ interface Service {
     id: string;
     name: string;
     projectId: string;
-    status: 'none' | 'running' | 'crashed' | 'stopped';
+    status: 'none' | 'running' | 'crashed' | 'stopped' | 'paused';
     deployStatus: 'idle' | 'building' | 'deploying' | 'restarting' | 'failed' | 'deleting';
     domain?: string;
     region?: string;
@@ -323,6 +380,20 @@ declare class ServicesAPI {
     redeploy(id: string): Promise<DeployHandle>;
     /** Restart a service without rebuilding. */
     restart(id: string): Promise<void>;
+    /**
+     * Pause a service: it scales to 0 (its URL answers 503) and keeps its URL, settings, env
+     * and volumes. Restart and redeploy are refused until it is resumed.
+     */
+    pause(id: string): Promise<PauseState>;
+    /** Resume a paused service: it starts again from the same image, with its data. */
+    resume(id: string): Promise<PauseState>;
+    /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+    getSleep(id: string): Promise<SleepSetting>;
+    /**
+     * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+     * always on. Turning it on restarts it once. Needs one replica and a port.
+     */
+    setSleep(id: string, opts: SleepOpts): Promise<SleepSetting>;
     /** Scale a service. */
     scale(id: string, opts: ScaleOpts): Promise<void>;
     /**
@@ -1432,6 +1503,13 @@ declare class WorkspacesAPI {
      * `code: 'ACCOUNT_SCOPE_REQUIRED'`.
      */
     create(opts: CreateWorkspaceOpts): Promise<Workspace>;
+    /**
+     * Pause every app and managed database in every project of a workspace (owner only).
+     * Each keeps its URL, host, port, password, settings and volumes.
+     */
+    pause(id: string): Promise<PauseResult>;
+    /** Resume what was paused in a workspace (owner only; not what a billing freeze paused). */
+    resume(id: string): Promise<PauseResult>;
     /**
      * Delete a workspace.
      *

package/dist/index.d.ts

@@ -68,7 +68,7 @@ interface Addon {
     name: string;
     type: AddonType;
     projectId: string;
-    status: 'none' | 'running' | 'crashed' | 'stopped';
+    status: 'none' | 'running' | 'crashed' | 'stopped' | 'paused';
     deployStatus: string;
     version?: string;
     /** Exposed connection variables (e.g. DATABASE_URL, REDIS_URL). */
@@ -117,6 +117,17 @@ declare class AddonsAPI {
     }): Promise<Addon>;
     /** Restart an addon. */
     redeploy(projectId: string, addonId: string): Promise<void>;
+    /**
+     * Pause a managed database: it scales to 0 (connections are refused) and keeps its host,
+     * port, password and data. Postgres and Redis.
+     */
+    pause(projectId: string, addonId: string): Promise<PauseState>;
+    /** Resume a paused database: same host, port, password and data. */
+    resume(projectId: string, addonId: string): Promise<PauseState>;
+    /** Serverless setting of a database (Postgres, Redis). */
+    getSleep(projectId: string, addonId: string): Promise<SleepSetting>;
+    /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+    setSleep(projectId: string, addonId: string, opts: SleepOpts): Promise<SleepSetting>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
         key: string;
@@ -136,6 +147,45 @@ interface CreateProjectOpts {
     workspaceId: string;
     name: string;
 }
+/** One app or managed database a project / workspace pause or resume acted on. */
+interface PausedService {
+    kind: 'app' | 'database';
+    id: string;
+    name: string;
+}
+/** What `projects.pause/resume` and `workspaces.pause/resume` answer: what was done, and
+ *  what was skipped with why (already paused, not running, busy, a storage bucket...). */
+interface PauseResult {
+    done: PausedService[];
+    skipped: Array<PausedService & {
+        reason: string;
+    }>;
+}
+/**
+ * Serverless ("sleep when idle"): after `idleMinutes` with no traffic the service sleeps with
+ * its memory saved, and the next request or connection wakes it in about a second.
+ */
+interface SleepSetting {
+    enabled: boolean;
+    idleMinutes: number;
+    lastSleptAt: number | null;
+    lastWokeAt: number | null;
+    lastError: string | null;
+    sleeps: number;
+    wakes: number;
+    /** On a change: whether the service restarted to apply it. */
+    restarted?: boolean;
+}
+/** Turn serverless on (`idleMinutes` 5-1440, default 15) or off. */
+interface SleepOpts {
+    enabled: boolean;
+    idleMinutes?: number;
+}
+/** What pausing or resuming one service answers. */
+interface PauseState {
+    ok: boolean;
+    status: 'paused' | 'running';
+}
 declare class ProjectsAPI {
     private readonly client;
     constructor(client: PlatformClient);
@@ -154,6 +204,13 @@ declare class ProjectsAPI {
     update(id: string, opts: {
         name?: string;
     }): Promise<Project>;
+    /**
+     * Pause every app and managed database of a project: each scales to 0 and keeps its URL,
+     * host, port, password, settings and volumes. Skipped ones are listed with why.
+     */
+    pause(id: string): Promise<PauseResult>;
+    /** Resume what was paused in a project (not what a billing freeze paused). */
+    resume(id: string): Promise<PauseResult>;
     /** Delete a project. */
     delete(id: string): Promise<void>;
     apply(id: string, config: ProjectConfig): Promise<ConfigResult>;
@@ -205,7 +262,7 @@ interface Service {
     id: string;
     name: string;
     projectId: string;
-    status: 'none' | 'running' | 'crashed' | 'stopped';
+    status: 'none' | 'running' | 'crashed' | 'stopped' | 'paused';
     deployStatus: 'idle' | 'building' | 'deploying' | 'restarting' | 'failed' | 'deleting';
     domain?: string;
     region?: string;
@@ -323,6 +380,20 @@ declare class ServicesAPI {
     redeploy(id: string): Promise<DeployHandle>;
     /** Restart a service without rebuilding. */
     restart(id: string): Promise<void>;
+    /**
+     * Pause a service: it scales to 0 (its URL answers 503) and keeps its URL, settings, env
+     * and volumes. Restart and redeploy are refused until it is resumed.
+     */
+    pause(id: string): Promise<PauseState>;
+    /** Resume a paused service: it starts again from the same image, with its data. */
+    resume(id: string): Promise<PauseState>;
+    /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+    getSleep(id: string): Promise<SleepSetting>;
+    /**
+     * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+     * always on. Turning it on restarts it once. Needs one replica and a port.
+     */
+    setSleep(id: string, opts: SleepOpts): Promise<SleepSetting>;
     /** Scale a service. */
     scale(id: string, opts: ScaleOpts): Promise<void>;
     /**
@@ -1432,6 +1503,13 @@ declare class WorkspacesAPI {
      * `code: 'ACCOUNT_SCOPE_REQUIRED'`.
      */
     create(opts: CreateWorkspaceOpts): Promise<Workspace>;
+    /**
+     * Pause every app and managed database in every project of a workspace (owner only).
+     * Each keeps its URL, host, port, password, settings and volumes.
+     */
+    pause(id: string): Promise<PauseResult>;
+    /** Resume what was paused in a workspace (owner only; not what a billing freeze paused). */
+    resume(id: string): Promise<PauseResult>;
     /**
      * Delete a workspace.
      *

package/dist/index.js

@@ -407,6 +407,28 @@ var ServicesAPI = class {
   restart(id) {
     return this.client.post(`/api/apps/${id}/restart`, {});
   }
+  /**
+   * Pause a service: it scales to 0 (its URL answers 503) and keeps its URL, settings, env
+   * and volumes. Restart and redeploy are refused until it is resumed.
+   */
+  pause(id) {
+    return this.client.post(`/api/apps/${id}/pause`, {});
+  }
+  /** Resume a paused service: it starts again from the same image, with its data. */
+  resume(id) {
+    return this.client.post(`/api/apps/${id}/resume`, {});
+  }
+  /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+  getSleep(id) {
+    return this.client.get(`/api/apps/${id}/sleep`);
+  }
+  /**
+   * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+   * always on. Turning it on restarts it once. Needs one replica and a port.
+   */
+  setSleep(id, opts) {
+    return this.client.put(`/api/apps/${id}/sleep`, opts);
+  }
   /** Scale a service. */
   async scale(id, opts) {
     if (opts.storageMi !== void 0) throw new LizardError("Storage scaling is only supported for addons");
@@ -1393,6 +1415,17 @@ var ProjectsAPI = class {
   update(id, opts) {
     return this.client.patch(`/api/projects/${id}`, opts);
   }
+  /**
+   * Pause every app and managed database of a project: each scales to 0 and keeps its URL,
+   * host, port, password, settings and volumes. Skipped ones are listed with why.
+   */
+  pause(id) {
+    return this.client.post(`/api/projects/${id}/pause`, {});
+  }
+  /** Resume what was paused in a project (not what a billing freeze paused). */
+  resume(id) {
+    return this.client.post(`/api/projects/${id}/resume`, {});
+  }
   /** Delete a project. */
   delete(id) {
     return this.client.delete(`/api/projects/${id}`);
@@ -1473,6 +1506,25 @@ var AddonsAPI = class {
   redeploy(projectId, addonId) {
     return this.client.post(`/api/projects/${projectId}/addons/${addonId}/redeploy`, {});
   }
+  /**
+   * Pause a managed database: it scales to 0 (connections are refused) and keeps its host,
+   * port, password and data. Postgres and Redis.
+   */
+  pause(projectId, addonId) {
+    return this.client.post(`/api/projects/${projectId}/addons/${addonId}/pause`, {});
+  }
+  /** Resume a paused database: same host, port, password and data. */
+  resume(projectId, addonId) {
+    return this.client.post(`/api/projects/${projectId}/addons/${addonId}/resume`, {});
+  }
+  /** Serverless setting of a database (Postgres, Redis). */
+  getSleep(projectId, addonId) {
+    return this.client.get(`/api/projects/${projectId}/addons/${addonId}/sleep`);
+  }
+  /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+  setSleep(projectId, addonId, opts) {
+    return this.client.put(`/api/projects/${projectId}/addons/${addonId}/sleep`, opts);
+  }
   rename(projectId, addonId, name) {
     return this.client.patch(`/api/projects/${projectId}/addons/${addonId}`, { name });
   }
@@ -1663,6 +1715,17 @@ var WorkspacesAPI = class {
   create(opts) {
     return this.client.post("/api/workspaces", opts);
   }
+  /**
+   * Pause every app and managed database in every project of a workspace (owner only).
+   * Each keeps its URL, host, port, password, settings and volumes.
+   */
+  pause(id) {
+    return this.client.post(`/api/workspaces/${id}/pause`, {});
+  }
+  /** Resume what was paused in a workspace (owner only; not what a billing freeze paused). */
+  resume(id) {
+    return this.client.post(`/api/workspaces/${id}/resume`, {});
+  }
   /**
    * Delete a workspace.
    *

package/dist/index.mjs

@@ -354,6 +354,28 @@ var ServicesAPI = class {
   restart(id) {
     return this.client.post(`/api/apps/${id}/restart`, {});
   }
+  /**
+   * Pause a service: it scales to 0 (its URL answers 503) and keeps its URL, settings, env
+   * and volumes. Restart and redeploy are refused until it is resumed.
+   */
+  pause(id) {
+    return this.client.post(`/api/apps/${id}/pause`, {});
+  }
+  /** Resume a paused service: it starts again from the same image, with its data. */
+  resume(id) {
+    return this.client.post(`/api/apps/${id}/resume`, {});
+  }
+  /** Serverless setting of a service: whether it sleeps when idle, and how often it did. */
+  getSleep(id) {
+    return this.client.get(`/api/apps/${id}/sleep`);
+  }
+  /**
+   * Make a service serverless (sleep when idle, wake in about a second on the next request) or
+   * always on. Turning it on restarts it once. Needs one replica and a port.
+   */
+  setSleep(id, opts) {
+    return this.client.put(`/api/apps/${id}/sleep`, opts);
+  }
   /** Scale a service. */
   async scale(id, opts) {
     if (opts.storageMi !== void 0) throw new LizardError("Storage scaling is only supported for addons");
@@ -1340,6 +1362,17 @@ var ProjectsAPI = class {
   update(id, opts) {
     return this.client.patch(`/api/projects/${id}`, opts);
   }
+  /**
+   * Pause every app and managed database of a project: each scales to 0 and keeps its URL,
+   * host, port, password, settings and volumes. Skipped ones are listed with why.
+   */
+  pause(id) {
+    return this.client.post(`/api/projects/${id}/pause`, {});
+  }
+  /** Resume what was paused in a project (not what a billing freeze paused). */
+  resume(id) {
+    return this.client.post(`/api/projects/${id}/resume`, {});
+  }
   /** Delete a project. */
   delete(id) {
     return this.client.delete(`/api/projects/${id}`);
@@ -1420,6 +1453,25 @@ var AddonsAPI = class {
   redeploy(projectId, addonId) {
     return this.client.post(`/api/projects/${projectId}/addons/${addonId}/redeploy`, {});
   }
+  /**
+   * Pause a managed database: it scales to 0 (connections are refused) and keeps its host,
+   * port, password and data. Postgres and Redis.
+   */
+  pause(projectId, addonId) {
+    return this.client.post(`/api/projects/${projectId}/addons/${addonId}/pause`, {});
+  }
+  /** Resume a paused database: same host, port, password and data. */
+  resume(projectId, addonId) {
+    return this.client.post(`/api/projects/${projectId}/addons/${addonId}/resume`, {});
+  }
+  /** Serverless setting of a database (Postgres, Redis). */
+  getSleep(projectId, addonId) {
+    return this.client.get(`/api/projects/${projectId}/addons/${addonId}/sleep`);
+  }
+  /** Make a database serverless (sleep when idle, wake on the next connection) or always on. */
+  setSleep(projectId, addonId, opts) {
+    return this.client.put(`/api/projects/${projectId}/addons/${addonId}/sleep`, opts);
+  }
   rename(projectId, addonId, name) {
     return this.client.patch(`/api/projects/${projectId}/addons/${addonId}`, { name });
   }
@@ -1610,6 +1662,17 @@ var WorkspacesAPI = class {
   create(opts) {
     return this.client.post("/api/workspaces", opts);
   }
+  /**
+   * Pause every app and managed database in every project of a workspace (owner only).
+   * Each keeps its URL, host, port, password, settings and volumes.
+   */
+  pause(id) {
+    return this.client.post(`/api/workspaces/${id}/pause`, {});
+  }
+  /** Resume what was paused in a workspace (owner only; not what a billing freeze paused). */
+  resume(id) {
+    return this.client.post(`/api/workspaces/${id}/resume`, {});
+  }
   /**
    * Delete a workspace.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.61",
+  "version": "0.1.63",
   "description": "TypeScript SDK for Lizard: Firecracker microVM sandboxes, code execution and cloud apps.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",