@archildata/client 0.1.6 → 0.1.8

package/README.md

@@ -82,7 +82,7 @@ The main client class for interacting with Archil filesystems.
 
 #### Delegation Operations
 
-- `checkout(inodeId, force?, user?)` - Acquire write delegation
+- `checkout(inodeId, options?, user?)` - Acquire write delegation
 - `checkin(inodeId, user?)` - Release delegation
 - `checkinAll()` - Release all delegations
 - `listDelegations()` - List currently held delegations

package/index.d.ts

@@ -148,6 +148,11 @@ export interface DelegationInfo {
   /** State of the delegation: "Active", "Pending", or "Removing" */
   state: string
 }
+/** Options for checkout operation */
+export interface CheckoutOptions {
+  /** Force revoke existing delegations held by other clients (default: false) */
+  force?: boolean
+}
 /**
  * Options for setattr operation
  *
@@ -231,8 +236,20 @@ export declare class ArchilClient {
    *
    * This tracks the delegation locally so that subsequent write operations
    * can proceed without additional server round-trips for permission checks.
+   *
+   * @example
+   * ```typescript
+   * // Basic checkout
+   * await client.checkout(inodeId);
+   *
+   * // Force revoke existing delegations from other clients
+   * await client.checkout(inodeId, { force: true });
+   *
+   * // With user context
+   * await client.checkout(inodeId, { force: false }, { uid: 1000, gid: 1000 });
+   * ```
    */
-  checkout(inodeId: number, force?: boolean | undefined | null, user?: UnixUser | undefined | null): Promise<void>
+  checkout(inodeId: number, options?: CheckoutOptions | undefined | null, user?: UnixUser | undefined | null): Promise<void>
   /**
    * Checkin (release delegation for) an inode.
    *
@@ -258,11 +275,11 @@ export declare class ArchilClient {
    * @example
    * ```typescript
    * // First checkout to get write delegation
-   * await client.checkout(inodeId, false, user);
+   * await client.checkout(inodeId);
    * // Then write data
-   * await client.writeData(inodeId, 0n, Buffer.from('Hello World'), user);
+   * await client.writeData(inodeId, 0, Buffer.from('Hello World'), user);
    * // Optionally checkin when done
-   * await client.checkin(inodeId, user);
+   * await client.checkin(inodeId);
    * ```
    */
   writeData(inodeId: number, offset: number, data: Buffer, user?: UnixUser | undefined | null): Promise<void>
@@ -277,13 +294,13 @@ export declare class ArchilClient {
    * @example
    * ```typescript
    * // First checkout to get write delegation
-   * await client.checkout(inodeId, false, user);
+   * await client.checkout(inodeId);
    * // Update timestamps (touch)
    * await client.setattr(inodeId, { atimeMs: -1, mtimeMs: -1 }, user);
    * // Or change mode
    * await client.setattr(inodeId, { mode: 0o755 }, user);
    * // Checkin when done
-   * await client.checkin(inodeId, user);
+   * await client.checkin(inodeId);
    * ```
    */
   setattr(inodeId: number, options: SetAttrOptions, user: UnixUser): Promise<InodeAttributes>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@archildata/client",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "High-performance Node.js client for Archil distributed filesystem",
   "main": "index.js",
   "types": "index.d.ts",
@@ -50,10 +50,10 @@
     "native"
   ],
   "optionalDependencies": {
-    "@archildata/client-win32-x64-msvc": "0.1.6",
-    "@archildata/client-darwin-x64": "0.1.6",
-    "@archildata/client-linux-x64-gnu": "0.1.6",
-    "@archildata/client-darwin-arm64": "0.1.6",
-    "@archildata/client-linux-arm64-gnu": "0.1.6"
+    "@archildata/client-win32-x64-msvc": "0.1.8",
+    "@archildata/client-darwin-x64": "0.1.8",
+    "@archildata/client-linux-x64-gnu": "0.1.8",
+    "@archildata/client-darwin-arm64": "0.1.8",
+    "@archildata/client-linux-arm64-gnu": "0.1.8"
   }
 }