@lizard-build/sdk 0.1.60 → 0.1.62

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,13 @@ 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>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
         key: string;
@@ -136,6 +143,25 @@ 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;
+    }>;
+}
+/** 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 +180,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 +238,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 +356,13 @@ 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>;
     /** Scale a service. */
     scale(id: string, opts: ScaleOpts): Promise<void>;
     /**
@@ -1432,6 +1472,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.
      *
@@ -1982,11 +2029,11 @@ declare class Lizard {
     /**
      * The account this credential belongs to — the SDK's `lizard whoami`.
      *
-     * A **scoped** key gets identity only: `id`, `username`, `avatarUrl`, `scoped: true`
-     * and the key's own `scopes`. The account's email, balance, plan and billing status
-     * are withheld — they belong to the account, not to the key holder, and a scoped key
-     * is meant to be handed to an end user or injected into a sandbox. An unscoped key
-     * or a session sees the full account.
+     * A **scoped** key never learns whose account it is: it gets only `scoped: true` and
+     * its `scopes`, each project or workspace with its name. No id, username, avatar,
+     * email, balance or plan -- a scoped key is meant to be handed to someone who is not
+     * the account's member, or injected into a sandbox. An unscoped key or a session
+     * sees the full account.
      *
      * Reading back `scopes` is the cheapest way to answer "what can this key reach".
      */
@@ -1995,21 +2042,27 @@ declare class Lizard {
     get platform(): PlatformClient;
 }
 /**
- * The account behind a credential — see {@link Lizard.whoami}.
+ * The account behind a credential -- see {@link Lizard.whoami}.
  *
- * Everything past `avatarUrl` is present only for an unscoped key or a session; a
- * scoped key gets `scoped: true` and `scopes` in their place.
+ * A scoped key gets only `scoped: true` and `scopes`; every other field is present only
+ * for an unscoped key or a session.
  */
 interface Account {
-    id: string;
-    username: string;
+    /** Absent for a scoped key. */
+    id?: string;
+    /** Absent for a scoped key. */
+    username?: string;
     avatarUrl?: string | null;
-    /** True when the calling key is scoped, meaning the account fields below are absent. */
+    /** True when the calling key is scoped, meaning the account fields are absent. */
     scoped?: boolean;
-    /** What the calling key may reach. Present when `scoped` is true. */
+    /** What the calling key may reach, by name. Present when `scoped` is true. */
     scopes?: Array<{
         type: 'workspace' | 'project';
         id: string;
+        name?: string | null;
+        /** For a project scope: the workspace it belongs to. */
+        workspaceId?: string | null;
+        workspaceName?: string | null;
     }>;
     email?: string | null;
     plan?: string;

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,13 @@ 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>;
     rename(projectId: string, addonId: string, name: string): Promise<unknown>;
     secrets(projectId: string, addonId: string): Promise<Array<{
         key: string;
@@ -136,6 +143,25 @@ 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;
+    }>;
+}
+/** 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 +180,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 +238,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 +356,13 @@ 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>;
     /** Scale a service. */
     scale(id: string, opts: ScaleOpts): Promise<void>;
     /**
@@ -1432,6 +1472,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.
      *
@@ -1982,11 +2029,11 @@ declare class Lizard {
     /**
      * The account this credential belongs to — the SDK's `lizard whoami`.
      *
-     * A **scoped** key gets identity only: `id`, `username`, `avatarUrl`, `scoped: true`
-     * and the key's own `scopes`. The account's email, balance, plan and billing status
-     * are withheld — they belong to the account, not to the key holder, and a scoped key
-     * is meant to be handed to an end user or injected into a sandbox. An unscoped key
-     * or a session sees the full account.
+     * A **scoped** key never learns whose account it is: it gets only `scoped: true` and
+     * its `scopes`, each project or workspace with its name. No id, username, avatar,
+     * email, balance or plan -- a scoped key is meant to be handed to someone who is not
+     * the account's member, or injected into a sandbox. An unscoped key or a session
+     * sees the full account.
      *
      * Reading back `scopes` is the cheapest way to answer "what can this key reach".
      */
@@ -1995,21 +2042,27 @@ declare class Lizard {
     get platform(): PlatformClient;
 }
 /**
- * The account behind a credential — see {@link Lizard.whoami}.
+ * The account behind a credential -- see {@link Lizard.whoami}.
  *
- * Everything past `avatarUrl` is present only for an unscoped key or a session; a
- * scoped key gets `scoped: true` and `scopes` in their place.
+ * A scoped key gets only `scoped: true` and `scopes`; every other field is present only
+ * for an unscoped key or a session.
  */
 interface Account {
-    id: string;
-    username: string;
+    /** Absent for a scoped key. */
+    id?: string;
+    /** Absent for a scoped key. */
+    username?: string;
     avatarUrl?: string | null;
-    /** True when the calling key is scoped, meaning the account fields below are absent. */
+    /** True when the calling key is scoped, meaning the account fields are absent. */
     scoped?: boolean;
-    /** What the calling key may reach. Present when `scoped` is true. */
+    /** What the calling key may reach, by name. Present when `scoped` is true. */
     scopes?: Array<{
         type: 'workspace' | 'project';
         id: string;
+        name?: string | null;
+        /** For a project scope: the workspace it belongs to. */
+        workspaceId?: string | null;
+        workspaceName?: string | null;
     }>;
     email?: string | null;
     plan?: string;

package/dist/index.js

@@ -407,6 +407,17 @@ 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`, {});
+  }
   /** Scale a service. */
   async scale(id, opts) {
     if (opts.storageMi !== void 0) throw new LizardError("Storage scaling is only supported for addons");
@@ -1393,6 +1404,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 +1495,17 @@ 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`, {});
+  }
   rename(projectId, addonId, name) {
     return this.client.patch(`/api/projects/${projectId}/addons/${addonId}`, { name });
   }
@@ -1663,6 +1696,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.
    *
@@ -1990,11 +2034,11 @@ var Lizard = class {
   /**
    * The account this credential belongs to — the SDK's `lizard whoami`.
    *
-   * A **scoped** key gets identity only: `id`, `username`, `avatarUrl`, `scoped: true`
-   * and the key's own `scopes`. The account's email, balance, plan and billing status
-   * are withheld — they belong to the account, not to the key holder, and a scoped key
-   * is meant to be handed to an end user or injected into a sandbox. An unscoped key
-   * or a session sees the full account.
+   * A **scoped** key never learns whose account it is: it gets only `scoped: true` and
+   * its `scopes`, each project or workspace with its name. No id, username, avatar,
+   * email, balance or plan -- a scoped key is meant to be handed to someone who is not
+   * the account's member, or injected into a sandbox. An unscoped key or a session
+   * sees the full account.
    *
    * Reading back `scopes` is the cheapest way to answer "what can this key reach".
    */

package/dist/index.mjs

@@ -354,6 +354,17 @@ 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`, {});
+  }
   /** Scale a service. */
   async scale(id, opts) {
     if (opts.storageMi !== void 0) throw new LizardError("Storage scaling is only supported for addons");
@@ -1340,6 +1351,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 +1442,17 @@ 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`, {});
+  }
   rename(projectId, addonId, name) {
     return this.client.patch(`/api/projects/${projectId}/addons/${addonId}`, { name });
   }
@@ -1610,6 +1643,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.
    *
@@ -1937,11 +1981,11 @@ var Lizard = class {
   /**
    * The account this credential belongs to — the SDK's `lizard whoami`.
    *
-   * A **scoped** key gets identity only: `id`, `username`, `avatarUrl`, `scoped: true`
-   * and the key's own `scopes`. The account's email, balance, plan and billing status
-   * are withheld — they belong to the account, not to the key holder, and a scoped key
-   * is meant to be handed to an end user or injected into a sandbox. An unscoped key
-   * or a session sees the full account.
+   * A **scoped** key never learns whose account it is: it gets only `scoped: true` and
+   * its `scopes`, each project or workspace with its name. No id, username, avatar,
+   * email, balance or plan -- a scoped key is meant to be handed to someone who is not
+   * the account's member, or injected into a sandbox. An unscoped key or a session
+   * sees the full account.
    *
    * Reading back `scopes` is the cheapest way to answer "what can this key reach".
    */

package/package.json

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