@hexaijs/sqlite 0.2.1 → 0.3.0

package/README.md

@@ -56,10 +56,11 @@ Unlike PostgreSQL's unit of work which accepts a client factory, `SqliteUnitOfWo
 
 ### Transaction Execution
 
-Use `wrap()` to execute operations within a transaction:
+Use `scope()` to define a transaction boundary:
 
 ```typescript
-const result = await unitOfWork.wrap(async (db) => {
+const result = await unitOfWork.scope(async () => {
+    const db = unitOfWork.getClient();
     await db.run("INSERT INTO orders (id, status) VALUES (?, ?)", [orderId, "pending"]);
     await db.run("INSERT INTO order_items (order_id, product_id) VALUES (?, ?)", [orderId, productId]);
     return { orderId };
@@ -67,11 +68,22 @@ const result = await unitOfWork.wrap(async (db) => {
 // Transaction commits if successful
 ```
 
+`wrap()` is also available but deprecated. In SQLite, `scope()` delegates to `wrap()` internally — both behave identically.
+
+```typescript
+/** @deprecated Use scope() instead. */
+const result = await unitOfWork.wrap(async (db) => {
+    await db.run("INSERT INTO orders (id, status) VALUES (?, ?)", [orderId, "pending"]);
+    return { orderId };
+});
+```
+
 If an error is thrown, the transaction rolls back:
 
 ```typescript
 try {
-    await unitOfWork.wrap(async (db) => {
+    await unitOfWork.scope(async () => {
+        const db = unitOfWork.getClient();
         await db.run("INSERT INTO orders (id, status) VALUES (?, ?)", [orderId, "pending"]);
         throw new Error("Something went wrong");
     });
@@ -90,17 +102,19 @@ const db = ctx.getUnitOfWork().getClient();
 await db.run("UPDATE orders SET status = ? WHERE id = ?", ["confirmed", orderId]);
 ```
 
-Note: `getClient()` throws an error if called outside of a `wrap()` call.
+Note: `getClient()` throws an error if called outside of a `scope()` or `wrap()` call.
 
 ### Nested Transactions
 
-Nested `wrap()` calls participate in the same transaction:
+Nested `scope()` calls participate in the same transaction:
 
 ```typescript
-await unitOfWork.wrap(async (db) => {
+await unitOfWork.scope(async () => {
+    const db = unitOfWork.getClient();
     await db.run("INSERT INTO orders (id) VALUES (?)", ["order-1"]);
 
-    await unitOfWork.wrap(async (db) => {
+    await unitOfWork.scope(async () => {
+        const db = unitOfWork.getClient();
         await db.run("INSERT INTO order_items (order_id) VALUES (?)", ["order-1"]);
     });
     // Both inserts are in the same transaction
@@ -112,10 +126,12 @@ If any nested call throws, the entire transaction rolls back:
 
 ```typescript
 try {
-    await unitOfWork.wrap(async (db) => {
+    await unitOfWork.scope(async () => {
+        const db = unitOfWork.getClient();
         await db.run("INSERT INTO orders (id) VALUES (?)", ["order-1"]);
 
-        await unitOfWork.wrap(async (db) => {
+        await unitOfWork.scope(async () => {
+            const db = unitOfWork.getClient();
             await db.run("INSERT INTO order_items (order_id) VALUES (?)", ["order-1"]);
             throw new Error("Nested failure");
         });
@@ -160,7 +176,8 @@ describe("OrderRepository", () => {
     });
 
     it("should persist orders", async () => {
-        await unitOfWork.wrap(async (db) => {
+        await unitOfWork.scope(async () => {
+            const db = unitOfWork.getClient();
             await db.run("INSERT INTO orders (id, status) VALUES (?, ?)", ["order-1", "pending"]);
         });
 

package/dist/index.d.ts

@@ -6,6 +6,7 @@ declare class SqliteUnitOfWork implements UnitOfWork<Database> {
     private static transactions;
     constructor(db: Database);
     getClient(): Database;
+    scope<T>(fn: () => Promise<T>): Promise<T>;
     wrap<T>(fn: (client: Database) => Promise<T>): Promise<T>;
 }
 

package/dist/index.js

@@ -17,6 +17,9 @@ var SqliteUnitOfWork = class _SqliteUnitOfWork {
     }
     return this.db;
   }
+  async scope(fn) {
+    return this.wrap(fn);
+  }
   async wrap(fn) {
     const current = _SqliteUnitOfWork.transactions.get(this.db);
     if (++current.level === 1) {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/sqlite-unit-of-work.ts"],"names":[],"mappings":";AAIO,IAAM,gBAAA,GAAN,MAAM,iBAAA,CAAiD;AAAA,EAS1D,YAAoB,EAAA,EAAc;AAAd,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA;AAChB,IAAA,IAAI,CAAC,iBAAA,CAAiB,YAAA,CAAa,GAAA,CAAI,EAAE,CAAA,EAAG;AACxC,MAAA,iBAAA,CAAiB,YAAA,CAAa,IAAI,EAAA,EAAI;AAAA,QAClC,KAAA,EAAO,CAAA;AAAA,QACP,OAAA,EAAS;AAAA,OACZ,CAAA;AAAA,IACL;AAAA,EACJ;AAAA,EAfA,OAAe,YAAA,mBAAe,IAAI,OAAA,EAMhC;AAAA,EAWF,SAAA,GAAsB;AAClB,IAAA,MAAM,OAAA,GAAU,iBAAA,CAAiB,YAAA,CAAa,GAAA,CAAI,KAAK,EAAE,CAAA;AACzD,IAAA,IAAI,CAAC,OAAA,IAAW,OAAA,CAAQ,KAAA,KAAU,CAAA,EAAG;AACjC,MAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,IAC9C;AACA,IAAA,OAAO,IAAA,CAAK,EAAA;AAAA,EAChB;AAAA,EAEA,MAAM,KAAQ,EAAA,EAAkD;AAC5D,IAAA,MAAM,OAAA,GAAU,iBAAA,CAAiB,YAAA,CAAa,GAAA,CAAI,KAAK,EAAE,CAAA;AACzD,IAAA,IAAI,EAAE,OAAA,CAAQ,KAAA,KAAU,CAAA,EAAG;AACvB,MAAA,MAAM,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,mBAAmB,CAAA;AAAA,IACzC;AAEA,IAAA,IAAI;AACA,MAAA,OAAO,MAAM,EAAA,CAAG,IAAA,CAAK,EAAE,CAAA;AAAA,IAC3B,SAAS,CAAA,EAAG;AACR,MAAA,IAAI,CAAC,QAAQ,OAAA,EAAS;AAClB,QAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAAA,MACtB;AAEA,MAAA,MAAM,CAAA;AAAA,IACV,CAAA,SAAE;AACE,MAAA,IAAI,EAAE,OAAA,CAAQ,KAAA,KAAU,CAAA,EAAG;AACvB,QAAA,IAAI,QAAQ,OAAA,EAAS;AACjB,UAAA,MAAM,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,UAAU,CAAA;AAAA,QAChC,CAAA,MAAO;AACH,UAAA,MAAM,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,QAAQ,CAAA;AAAA,QAC9B;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ","file":"index.js","sourcesContent":["import type { Database } from \"sqlite\";\n\nimport { UnitOfWork } from \"@hexaijs/core\";\n\nexport class SqliteUnitOfWork implements UnitOfWork<Database> {\n    private static transactions = new WeakMap<\n        Database,\n        {\n            level: number;\n            aborted: boolean;\n        }\n    >();\n\n    constructor(private db: Database) {\n        if (!SqliteUnitOfWork.transactions.has(db)) {\n            SqliteUnitOfWork.transactions.set(db, {\n                level: 0,\n                aborted: false,\n            });\n        }\n    }\n\n    getClient(): Database {\n        const current = SqliteUnitOfWork.transactions.get(this.db);\n        if (!current || current.level === 0) {\n            throw new Error(\"No transaction is active\");\n        }\n        return this.db;\n    }\n\n    async wrap<T>(fn: (client: Database) => Promise<T>): Promise<T> {\n        const current = SqliteUnitOfWork.transactions.get(this.db)!;\n        if (++current.level === 1) {\n            await this.db.run(\"BEGIN TRANSACTION\");\n        }\n\n        try {\n            return await fn(this.db);\n        } catch (e) {\n            if (!current.aborted) {\n                current.aborted = true;\n            }\n\n            throw e;\n        } finally {\n            if (--current.level === 0) {\n                if (current.aborted) {\n                    await this.db.run(\"ROLLBACK\");\n                } else {\n                    await this.db.run(\"COMMIT\");\n                }\n            }\n        }\n    }\n}\n"]}
+{"version":3,"sources":["../src/sqlite-unit-of-work.ts"],"names":[],"mappings":";AAIO,IAAM,gBAAA,GAAN,MAAM,iBAAA,CAAiD;AAAA,EAS1D,YAAoB,EAAA,EAAc;AAAd,IAAA,IAAA,CAAA,EAAA,GAAA,EAAA;AAChB,IAAA,IAAI,CAAC,iBAAA,CAAiB,YAAA,CAAa,GAAA,CAAI,EAAE,CAAA,EAAG;AACxC,MAAA,iBAAA,CAAiB,YAAA,CAAa,IAAI,EAAA,EAAI;AAAA,QAClC,KAAA,EAAO,CAAA;AAAA,QACP,OAAA,EAAS;AAAA,OACZ,CAAA;AAAA,IACL;AAAA,EACJ;AAAA,EAfA,OAAe,YAAA,mBAAe,IAAI,OAAA,EAMhC;AAAA,EAWF,SAAA,GAAsB;AAClB,IAAA,MAAM,OAAA,GAAU,iBAAA,CAAiB,YAAA,CAAa,GAAA,CAAI,KAAK,EAAE,CAAA;AACzD,IAAA,IAAI,CAAC,OAAA,IAAW,OAAA,CAAQ,KAAA,KAAU,CAAA,EAAG;AACjC,MAAA,MAAM,IAAI,MAAM,0BAA0B,CAAA;AAAA,IAC9C;AACA,IAAA,OAAO,IAAA,CAAK,EAAA;AAAA,EAChB;AAAA,EAEA,MAAM,MAAS,EAAA,EAAkC;AAC7C,IAAA,OAAO,IAAA,CAAK,KAAK,EAAE,CAAA;AAAA,EACvB;AAAA,EAEA,MAAM,KAAQ,EAAA,EAAkD;AAC5D,IAAA,MAAM,OAAA,GAAU,iBAAA,CAAiB,YAAA,CAAa,GAAA,CAAI,KAAK,EAAE,CAAA;AACzD,IAAA,IAAI,EAAE,OAAA,CAAQ,KAAA,KAAU,CAAA,EAAG;AACvB,MAAA,MAAM,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,mBAAmB,CAAA;AAAA,IACzC;AAEA,IAAA,IAAI;AACA,MAAA,OAAO,MAAM,EAAA,CAAG,IAAA,CAAK,EAAE,CAAA;AAAA,IAC3B,SAAS,CAAA,EAAG;AACR,MAAA,IAAI,CAAC,QAAQ,OAAA,EAAS;AAClB,QAAA,OAAA,CAAQ,OAAA,GAAU,IAAA;AAAA,MACtB;AAEA,MAAA,MAAM,CAAA;AAAA,IACV,CAAA,SAAE;AACE,MAAA,IAAI,EAAE,OAAA,CAAQ,KAAA,KAAU,CAAA,EAAG;AACvB,QAAA,IAAI,QAAQ,OAAA,EAAS;AACjB,UAAA,MAAM,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,UAAU,CAAA;AAAA,QAChC,CAAA,MAAO;AACH,UAAA,MAAM,IAAA,CAAK,EAAA,CAAG,GAAA,CAAI,QAAQ,CAAA;AAAA,QAC9B;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ","file":"index.js","sourcesContent":["import type { Database } from \"sqlite\";\n\nimport { UnitOfWork } from \"@hexaijs/core\";\n\nexport class SqliteUnitOfWork implements UnitOfWork<Database> {\n    private static transactions = new WeakMap<\n        Database,\n        {\n            level: number;\n            aborted: boolean;\n        }\n    >();\n\n    constructor(private db: Database) {\n        if (!SqliteUnitOfWork.transactions.has(db)) {\n            SqliteUnitOfWork.transactions.set(db, {\n                level: 0,\n                aborted: false,\n            });\n        }\n    }\n\n    getClient(): Database {\n        const current = SqliteUnitOfWork.transactions.get(this.db);\n        if (!current || current.level === 0) {\n            throw new Error(\"No transaction is active\");\n        }\n        return this.db;\n    }\n\n    async scope<T>(fn: () => Promise<T>): Promise<T> {\n        return this.wrap(fn);\n    }\n\n    async wrap<T>(fn: (client: Database) => Promise<T>): Promise<T> {\n        const current = SqliteUnitOfWork.transactions.get(this.db)!;\n        if (++current.level === 1) {\n            await this.db.run(\"BEGIN TRANSACTION\");\n        }\n\n        try {\n            return await fn(this.db);\n        } catch (e) {\n            if (!current.aborted) {\n                current.aborted = true;\n            }\n\n            throw e;\n        } finally {\n            if (--current.level === 0) {\n                if (current.aborted) {\n                    await this.db.run(\"ROLLBACK\");\n                } else {\n                    await this.db.run(\"COMMIT\");\n                }\n            }\n        }\n    }\n}\n"]}

package/package.json

@@ -3,7 +3,7 @@
     "publishConfig": {
         "access": "public"
     },
-    "version": "0.2.1",
+    "version": "0.3.0",
     "type": "module",
     "description": "SQLite support for hexai",
     "license": "MIT",
@@ -50,7 +50,7 @@
     },
     "dependencies": {},
     "peerDependencies": {
-        "@hexaijs/core": "^0.6.0",
+        "@hexaijs/core": "^0.7.0",
         "sqlite": "^5.1.1",
         "sqlite3": "^5.1.7"
     },