@aigne/afs-sqlite 1.1.0 → 1.11.0-beta

package/README.md

@@ -36,10 +36,12 @@ import { SQLiteAFS } from "@aigne/afs-sqlite";
 const afs = new AFS();
 
 // Mount SQLite module
-afs.mount(new SQLiteAFS({
-  url: "file:./database.sqlite3",
-  accessMode: "readwrite"
-}));
+afs.mount(
+  new SQLiteAFS({
+    url: "file:./database.sqlite3",
+    accessMode: "readwrite",
+  }),
+);
 
 // List all tables
 const tables = await afs.list("/modules/sqlite-afs");
@@ -52,12 +54,12 @@ const user = await afs.read("/modules/sqlite-afs/users/1");
 
 // Create a new row
 await afs.write("/modules/sqlite-afs/users", {
-  content: { name: "John", email: "john@example.com" }
+  content: { name: "John", email: "john@example.com" },
 });
 
 // Update an existing row
 await afs.write("/modules/sqlite-afs/users/1", {
-  content: { name: "John Doe" }
+  content: { name: "John Doe" },
 });
 
 // Delete a row
@@ -104,17 +106,17 @@ interface SQLiteAFSOptions {
 
 The module exposes the following path patterns:
 
-| Path | Description |
-|------|-------------|
-| `/` | List all tables |
-| `/:table` | List rows in table or create new row |
-| `/:table/@schema` | Get table schema |
-| `/:table/:pk` | Read/update/delete specific row |
-| `/:table/:pk/@attr` | List row attributes (columns) |
-| `/:table/:pk/@attr/:column` | Get specific column value |
-| `/:table/:pk/@meta` | Get row metadata |
-| `/:table/:pk/@actions` | List available actions |
-| `/:table/:pk/@actions/:action` | Execute an action |
+| Path                           | Description                          |
+| ------------------------------ | ------------------------------------ |
+| `/`                            | List all tables                      |
+| `/:table`                      | List rows in table or create new row |
+| `/:table/@schema`              | Get table schema                     |
+| `/:table/:pk`                  | Read/update/delete specific row      |
+| `/:table/:pk/@attr`            | List row attributes (columns)        |
+| `/:table/:pk/@attr/:column`    | Get specific column value            |
+| `/:table/:pk/@meta`            | Get row metadata                     |
+| `/:table/:pk/@actions`         | List available actions               |
+| `/:table/:pk/@actions/:action` | Execute an action                    |
 
 ## Built-in Actions
 
@@ -131,14 +133,20 @@ The module exposes the following path patterns:
 
 ```typescript
 // Validate a row
-const result = await afs.write("/modules/sqlite-afs/users/1/@actions/validate", {
-  content: {}
-});
+const result = await afs.write(
+  "/modules/sqlite-afs/users/1/@actions/validate",
+  {
+    content: {},
+  },
+);
 
 // Duplicate a row
-const result = await afs.write("/modules/sqlite-afs/users/1/@actions/duplicate", {
-  content: {}
-});
+const result = await afs.write(
+  "/modules/sqlite-afs/users/1/@actions/duplicate",
+  {
+    content: {},
+  },
+);
 
 // Export table data
 const jsonData = await sqliteAfs.exportTable("users", "json");
@@ -156,14 +164,16 @@ sqliteAfs.registerAction(
   "archive",
   async (ctx, params) => {
     // ctx contains: db, schemas, table, pk, row, module
-    await ctx.db.run(sql.raw(`UPDATE "${ctx.table}" SET archived = 1 WHERE id = '${ctx.pk}'`));
+    await ctx.db.run(
+      sql.raw(`UPDATE "${ctx.table}" SET archived = 1 WHERE id = '${ctx.pk}'`),
+    );
     return { archived: true };
   },
   {
     description: "Archive the row",
     rowLevel: true,
-    tableLevel: false
-  }
+    tableLevel: false,
+  },
 );
 ```
 
@@ -178,16 +188,19 @@ const sqliteAfs = new SQLiteAFS({
     enabled: true,
     tables: {
       posts: ["title", "content"],
-      users: ["name", "bio"]
-    }
-  }
+      users: ["name", "bio"],
+    },
+  },
 });
 
 // Search across all FTS-enabled tables
 const results = await afs.search("/modules/sqlite-afs", "search query");
 
 // Search within a specific table
-const postResults = await afs.search("/modules/sqlite-afs/posts", "search query");
+const postResults = await afs.search(
+  "/modules/sqlite-afs/posts",
+  "search query",
+);
 ```
 
 ## Advanced Usage
@@ -223,19 +236,21 @@ import { AFS } from "@aigne/afs";
 import { SQLiteAFS } from "@aigne/afs-sqlite";
 
 const afs = new AFS();
-afs.mount(new SQLiteAFS({
-  url: "file:./database.sqlite3",
-  accessMode: "readwrite"
-}));
+afs.mount(
+  new SQLiteAFS({
+    url: "file:./database.sqlite3",
+    accessMode: "readwrite",
+  }),
+);
 
 const agent = AIAgent.from({
   name: "database-assistant",
-  afs: afs
+  afs: afs,
 });
 
 const context = aigne.newContext();
 const result = await context.invoke(agent, {
-  message: "Show me all users in the database"
+  message: "Show me all users in the database",
 });
 ```