agentfs-sdk 0.1.2 → 0.2.0-pre.2

package/dist/index.d.ts

@@ -2,6 +2,23 @@ import { Database } from '@tursodatabase/database';
 import { KvStore } from './kvstore';
 import { Filesystem } from './filesystem';
 import { ToolCalls } from './toolcalls';
+/**
+ * Configuration options for opening an AgentFS instance
+ */
+export interface AgentFSOptions {
+    /**
+     * Unique identifier for the agent.
+     * - If provided without `path`: Creates storage at `.agentfs/{id}.db`
+     * - If provided with `path`: Uses the specified path
+     */
+    id?: string;
+    /**
+     * Explicit path to the database file.
+     * - If provided: Uses the specified path directly
+     * - Can be combined with `id`
+     */
+    path?: string;
+}
 export declare class AgentFS {
     private db;
     readonly kv: KvStore;
@@ -13,10 +30,21 @@ export declare class AgentFS {
     private constructor();
     /**
      * Open an agent filesystem
-     * @param dbPath Path to the database file (defaults to ':memory:')
+     * @param options Configuration options (id and/or path required)
      * @returns Fully initialized AgentFS instance
+     * @example
+     * ```typescript
+     * // Using id (creates .agentfs/my-agent.db)
+     * const agent = await AgentFS.open({ id: 'my-agent' });
+     *
+     * // Using id with custom path
+     * const agent = await AgentFS.open({ id: 'my-agent', path: './data/mydb.db' });
+     *
+     * // Using path only
+     * const agent = await AgentFS.open({ path: './data/mydb.db' });
+     * ```
      */
-    static open(dbPath?: string): Promise<AgentFS>;
+    static open(options: AgentFSOptions): Promise<AgentFS>;
     /**
      * Get the underlying Database instance
      */

package/dist/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolCalls = exports.Filesystem = exports.KvStore = exports.AgentFS = void 0;
 const database_1 = require("@tursodatabase/database");
+const fs_1 = require("fs");
 const kvstore_1 = require("./kvstore");
 const filesystem_1 = require("./filesystem");
 const toolcalls_1 = require("./toolcalls");
@@ -17,10 +18,43 @@ class AgentFS {
     }
     /**
      * Open an agent filesystem
-     * @param dbPath Path to the database file (defaults to ':memory:')
+     * @param options Configuration options (id and/or path required)
      * @returns Fully initialized AgentFS instance
+     * @example
+     * ```typescript
+     * // Using id (creates .agentfs/my-agent.db)
+     * const agent = await AgentFS.open({ id: 'my-agent' });
+     *
+     * // Using id with custom path
+     * const agent = await AgentFS.open({ id: 'my-agent', path: './data/mydb.db' });
+     *
+     * // Using path only
+     * const agent = await AgentFS.open({ path: './data/mydb.db' });
+     * ```
      */
-    static async open(dbPath = ':memory:') {
+    static async open(options) {
+        const { id, path } = options;
+        // Require at least id or path
+        if (!id && !path) {
+            throw new Error("AgentFS.open() requires at least 'id' or 'path'.");
+        }
+        // Validate agent ID if provided
+        if (id && !/^[a-zA-Z0-9_-]+$/.test(id)) {
+            throw new Error('Agent ID must contain only alphanumeric characters, hyphens, and underscores');
+        }
+        // Determine database path: explicit path takes precedence, otherwise use id-based path
+        let dbPath;
+        if (path) {
+            dbPath = path;
+        }
+        else {
+            // id is guaranteed to be defined here (we checked !id && !path above)
+            const dir = '.agentfs';
+            if (!(0, fs_1.existsSync)(dir)) {
+                (0, fs_1.mkdirSync)(dir, { recursive: true });
+            }
+            dbPath = `${dir}/${id}.db`;
+        }
         const db = new database_1.Database(dbPath);
         // Connect to the database to ensure it's created
         await db.connect();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agentfs-sdk",
-  "version": "0.1.2",
+  "version": "0.2.0-pre.2",
   "description": "AgentFS SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",