@archildata/client 0.1.0 → 0.1.3

package/README.md

@@ -1,4 +1,4 @@
-# @archil/node
+# @archildata/client
 
 High-performance Node.js bindings for the Archil distributed filesystem client.
 
@@ -9,33 +9,46 @@ This package provides low-level N-API bindings to the Archil client library, exp
 ## Installation
 
 ```bash
-npm install @archil/node
+npm install @archildata/client
 ```
 
+## Supported Platforms
+
+This package includes pre-built binaries for:
+
+- **macOS** (Apple Silicon) - `darwin-arm64`
+- **Linux** (x86_64) - `linux-x64-gnu`
+- **Linux** (ARM64) - `linux-arm64-gnu`
+
+Other platforms are not currently supported.
+
+> **Note:** For best performance, run your application in the same region as your Archil disk (e.g., if your disk is in `aws-us-east-1`, deploy your app to AWS us-east-1).
+
 ## Usage
 
 ```typescript
-import { ArchilClient } from '@archil/node';
+import { ArchilClient } from '@archildata/client';
 
-// Connect to Archil (authenticated via mount server)
-const client = await ArchilClient.connectAuthenticated({
-  mountServer: 'https://mount.archil.io',
-  mountName: 'my-account/my-disk',
+// Connect to Archil
+const client = await ArchilClient.connect({
+  region: 'aws-us-east-1',
+  diskName: 'myaccount/mydisk',
+  authToken: process.env.ARCHIL_TOKEN, // optional, uses IAM if not provided
 });
 
 // Get root directory attributes
-const rootAttrs = await client.getAttributes(1n);
+const rootAttrs = await client.getAttributes(1);
 console.log('Root size:', rootAttrs.size);
 
 // List directory contents
-const entries = await client.readDirectory(1n);
+const entries = await client.readDirectory(1);
 for (const entry of entries) {
   console.log(`${entry.name} (inode: ${entry.inodeId})`);
 }
 
 // Read a file
-const lookup = await client.lookupInode(1n, 'myfile.txt');
-const data = await client.readInode(lookup.inodeId, 0n, 1024);
+const lookup = await client.lookupInode(1, 'myfile.txt');
+const data = await client.readInode(lookup.inodeId, 0, 1024);
 console.log('File content:', data.toString());
 
 // Close when done
@@ -50,8 +63,8 @@ The main client class for interacting with Archil filesystems.
 
 #### Connection Methods
 
+- `connect(config)` - Connect using region and disk name (recommended)
 - `connectDirect(config)` - Connect directly to a server (for testing)
-- `connectAuthenticated(config)` - Connect via mount server with authentication
 
 #### Metadata Operations
 
@@ -64,34 +77,45 @@ The main client class for interacting with Archil filesystems.
 #### Data Operations
 
 - `readInode(inodeId, offset, length, user?)` - Read file data
+- `writeData(inodeId, offset, data, user?)` - Write file data (requires delegation)
+- `sync()` - Sync all pending writes to server
 
 #### Delegation Operations
 
 - `checkout(inodeId, force?, user?)` - Acquire write delegation
 - `checkin(inodeId, user?)` - Release delegation
 - `checkinAll()` - Release all delegations
+- `listDelegations()` - List currently held delegations
 
 #### Mutation Operations
 
-- `conditionalCreate(parentInodeId, name, childInodeId, attributes, user?)` - Create file/directory
+- `create(parentInodeId, name, attributes, user?)` - Create file/directory
+- `unlink(parentInodeId, name, user?)` - Delete file or empty directory
+- `rename(parentInodeId, name, newParentInodeId, newName, user?)` - Move/rename
+- `setattr(inodeId, options, user)` - Update file attributes
 - `setImmutable(inodeId)` - Mark subtree as immutable
 - `setMutable(inodeId)` - Mark subtree as mutable
 - `listImmutableSubtrees()` - List immutable roots
 
 ### Types
 
-All inode IDs and file offsets use JavaScript `bigint` for 64-bit support:
-
 ```typescript
+interface SimpleConnectionConfig {
+  region: string;      // e.g., "aws-us-east-1"
+  diskName: string;    // e.g., "myaccount/mydisk"
+  authToken?: string;  // optional, uses IAM if not provided
+  logLevel?: string;   // optional: "trace", "debug", "info", "warn", "error"
+}
+
 interface UnixUser {
   uid: number;
   gid: number;
 }
 
 interface InodeAttributes {
-  inodeId: bigint;
+  inodeId: number;
   inodeType: 'File' | 'Directory' | 'Symlink' | ...;
-  size: bigint;
+  size: number;
   uid: number;
   gid: number;
   mode: number;
@@ -100,15 +124,24 @@ interface InodeAttributes {
   atimeMs: number;
   mtimeMs: number;
   btimeMs: number;
-  rdev?: bigint;
+  rdev?: number;
   symlinkTarget?: string;
 }
 
 interface DirectoryEntry {
   name: string;
-  inodeId: bigint;
+  inodeId: number;
   inodeType: string;
 }
+
+interface SetAttrOptions {
+  mode?: number;
+  uid?: number;
+  gid?: number;
+  size?: number;
+  atimeMs?: number;   // use -1 for current time
+  mtimeMs?: number;   // use -1 for current time
+}
 ```
 
 ## Building

package/package.json

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