neosqlite 1.0.0 → 1.0.2

package/lib/package.json

@@ -1,7 +1,7 @@
 {
     "name": "neosqlite",
     "description": "A lightweight wrapper around better-sqlite3 that adds developer-friendly features like job scheduling, migrations, error handling, query logging, SQL utilities, and more",
-    "version": "1.0.0",
+    "version": "1.0.2",
     "main": "lib/src/index.js",
     "scripts": {
         "build": "tsc",

package/lib/src/client/index.js

@@ -10,9 +10,11 @@ function createClient(config) {
     const { file } = config;
     const db = new better_sqlite3_1.default(file);
     const transaction = (fn) => {
+        let result;
         db.transaction(() => {
-            fn();
+            result = fn();
         });
+        return result;
     };
     /**
      * Read data from the database, returns all matching rows
@@ -50,10 +52,23 @@ function createClient(config) {
         const statement = db.prepare(query.sql);
         return (0, util_1.runQuery)(config, params, () => statement.all(query.args));
     };
+    /**
+     * Batch writes to the database
+     */
+    const batchWrite = (statements) => {
+        db.transaction(() => {
+            for (const statement of statements) {
+                const query = (0, util_1.parseQuery)(statement);
+                const sqlStatement = db.prepare(query.sql);
+                sqlStatement.run(query.args);
+            }
+        });
+    };
     return {
         read,
         readOne,
         write,
+        batchWrite,
         transaction,
         writeReturning,
         pragma: db.pragma,

package/lib/src/index.d.ts

@@ -1 +1,4 @@
 export * from "./types";
+export * from "./client/util";
+export { createClient } from "./client";
+export { createNeosqliteMigrationCli } from "./migrations";

package/lib/src/index.js

@@ -14,4 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createNeosqliteMigrationCli = exports.createClient = void 0;
 __exportStar(require("./types"), exports);
+__exportStar(require("./client/util"), exports);
+var client_1 = require("./client");
+Object.defineProperty(exports, "createClient", { enumerable: true, get: function () { return client_1.createClient; } });
+var migrations_1 = require("./migrations");
+Object.defineProperty(exports, "createNeosqliteMigrationCli", { enumerable: true, get: function () { return migrations_1.createNeosqliteMigrationCli; } });

package/lib/src/types.d.ts

@@ -13,13 +13,15 @@ export type NeosqliteClient = {
     /** Backup the database */
     backup: (destinationFile: string, options?: BackupOptions | undefined) => Promise<BackupMetadata>;
     /** Create a transaction and execute queries within it */
-    transaction: (fn: Function) => void;
+    transaction: <T = void>(fn: () => T) => T;
     /** Read data from the database, returns all matching rows */
     read: (params: ExecuteQueryParams) => Row[];
     /** Read data from the database, returns the first matching row */
     readOne: (params: ExecuteQueryParams) => Row | undefined;
     /** Write data to the database, returns all matching rows via RETURNING */
     writeReturning: (params: ExecuteQueryParams) => Row[];
+    /** Batch writes by running all of them at the same time, in one transaction */
+    batchWrite: (statements: ExecuteQueryParams[]) => void;
     /** Write data to the database, returns the number of rows affected */
     write: (params: ExecuteQueryParams) => {
         changes: number;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "neosqlite",
   "description": "A lightweight wrapper around better-sqlite3 that adds developer-friendly features like job scheduling, migrations, error handling, query logging, SQL utilities, and more",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "lib/src/index.js",
   "scripts": {
     "build": "tsc",

package/src/client/index.ts

@@ -8,10 +8,14 @@ export function createClient(config: NeosqliteConfig): NeosqliteClient {
   const { file } = config;
   const db = new Database(file);
 
-  const transaction = (fn: Function) => {
+  const transaction = <T = void>(fn: () => T): T => {
+    let result!: T;
+
     db.transaction(() => {
-      fn();
+      result = fn();
     });
+
+    return result;
   };
 
   /**
@@ -58,10 +62,24 @@ export function createClient(config: NeosqliteConfig): NeosqliteClient {
     return runQuery(config, params, () => statement.all(query.args));
   };
 
+  /**
+   * Batch writes to the database
+   */
+  const batchWrite = (statements: ExecuteQueryParams[]) => {
+    db.transaction(() => {
+      for (const statement of statements) {
+        const query = parseQuery(statement);
+        const sqlStatement = db.prepare(query.sql);
+        sqlStatement.run(query.args);
+      }
+    });
+  };
+
   return {
     read,
     readOne,
     write,
+    batchWrite,
     transaction,
     writeReturning,
     pragma: db.pragma,

package/src/index.ts

@@ -1 +1,5 @@
 export * from "./types";
+
+export * from "./client/util";
+export { createClient } from "./client";
+export { createNeosqliteMigrationCli } from "./migrations";

package/src/types.ts

@@ -19,7 +19,7 @@ export type NeosqliteClient = {
   backup: (destinationFile: string, options?: BackupOptions | undefined) => Promise<BackupMetadata>;
 
   /** Create a transaction and execute queries within it */
-  transaction: (fn: Function) => void;
+  transaction: <T = void>(fn: () => T) => T;
 
   /** Read data from the database, returns all matching rows */
   read: (params: ExecuteQueryParams) => Row[];
@@ -30,6 +30,9 @@ export type NeosqliteClient = {
   /** Write data to the database, returns all matching rows via RETURNING */
   writeReturning: (params: ExecuteQueryParams) => Row[];
 
+  /** Batch writes by running all of them at the same time, in one transaction */
+  batchWrite: (statements: ExecuteQueryParams[]) => void;
+
   /** Write data to the database, returns the number of rows affected */
   write: (params: ExecuteQueryParams) => { changes: number; lastInsertedRowid: number };
 };