@lizard-build/sdk 0.1.62 → 0.1.63

package/dist/index.d.mts

@@ -124,6 +124,10 @@ declare class AddonsAPI {
     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;
@@ -157,6 +161,26 @@ interface PauseResult {
         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;
@@ -363,6 +387,13 @@ declare class ServicesAPI {
     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>;
     /**

package/dist/index.d.ts

@@ -124,6 +124,10 @@ declare class AddonsAPI {
     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;
@@ -157,6 +161,26 @@ interface PauseResult {
         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;
@@ -363,6 +387,13 @@ declare class ServicesAPI {
     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>;
     /**

package/dist/index.js

@@ -418,6 +418,17 @@ var ServicesAPI = class {
   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");
@@ -1506,6 +1517,14 @@ var AddonsAPI = class {
   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 });
   }

package/dist/index.mjs

@@ -365,6 +365,17 @@ var ServicesAPI = class {
   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");
@@ -1453,6 +1464,14 @@ var AddonsAPI = class {
   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 });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizard-build/sdk",
-  "version": "0.1.62",
+  "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",