@spawnco/sdk-types 0.0.49 → 0.0.50

package/dist/index.d.mts

@@ -236,6 +236,30 @@ interface SpawnServerSDK__V1<TConfig = any> {
          * List all document names for this variant.
          */
         list(): Promise<string[]>;
+        /**
+         * Acquire a distributed lock on a key. Blocks until lock is acquired or timeout.
+         * Always use try/finally to ensure unlock() is called.
+         *
+         * @example
+         * await sdk.documents.lock("leaderboard");
+         * try {
+         *   const data = await sdk.documents.get("leaderboard");
+         *   // ... mutate data ...
+         *   await sdk.documents.set("leaderboard", data);
+         * } finally {
+         *   await sdk.documents.unlock("leaderboard");
+         * }
+         */
+        lock(key: string, options?: {
+            /** Auto-expire if worker crashes (default: 30000ms) */
+            ttlMs?: number;
+            /** Max time to wait for lock (default: 10000ms) */
+            waitMs?: number;
+        }): Promise<void>;
+        /**
+         * Release a distributed lock. Must be called after lock() in a finally block.
+         */
+        unlock(key: string): Promise<void>;
     };
     config: {
         get(): Promise<TConfig>;

package/dist/index.d.ts

@@ -236,6 +236,30 @@ interface SpawnServerSDK__V1<TConfig = any> {
          * List all document names for this variant.
          */
         list(): Promise<string[]>;
+        /**
+         * Acquire a distributed lock on a key. Blocks until lock is acquired or timeout.
+         * Always use try/finally to ensure unlock() is called.
+         *
+         * @example
+         * await sdk.documents.lock("leaderboard");
+         * try {
+         *   const data = await sdk.documents.get("leaderboard");
+         *   // ... mutate data ...
+         *   await sdk.documents.set("leaderboard", data);
+         * } finally {
+         *   await sdk.documents.unlock("leaderboard");
+         * }
+         */
+        lock(key: string, options?: {
+            /** Auto-expire if worker crashes (default: 30000ms) */
+            ttlMs?: number;
+            /** Max time to wait for lock (default: 10000ms) */
+            waitMs?: number;
+        }): Promise<void>;
+        /**
+         * Release a distributed lock. Must be called after lock() in a finally block.
+         */
+        unlock(key: string): Promise<void>;
     };
     config: {
         get(): Promise<TConfig>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spawnco/sdk-types",
-  "version": "0.0.49",
+  "version": "0.0.50",
   "description": "TypeScript type definitions for Spawn SDK",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

package/src/v1.ts

@@ -260,6 +260,35 @@ export interface SpawnServerSDK__V1<TConfig = any> {
      * List all document names for this variant.
      */
     list(): Promise<string[]>;
+
+    /**
+     * Acquire a distributed lock on a key. Blocks until lock is acquired or timeout.
+     * Always use try/finally to ensure unlock() is called.
+     *
+     * @example
+     * await sdk.documents.lock("leaderboard");
+     * try {
+     *   const data = await sdk.documents.get("leaderboard");
+     *   // ... mutate data ...
+     *   await sdk.documents.set("leaderboard", data);
+     * } finally {
+     *   await sdk.documents.unlock("leaderboard");
+     * }
+     */
+    lock(
+      key: string,
+      options?: {
+        /** Auto-expire if worker crashes (default: 30000ms) */
+        ttlMs?: number;
+        /** Max time to wait for lock (default: 10000ms) */
+        waitMs?: number;
+      }
+    ): Promise<void>;
+
+    /**
+     * Release a distributed lock. Must be called after lock() in a finally block.
+     */
+    unlock(key: string): Promise<void>;
   };
 
   config: {