neosqlite 1.0.15 → 1.0.17

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.15",
+    "version": "1.0.17",
     "main": "lib/src/index.js",
     "scripts": {
         "build": "tsc",

package/lib/src/client/util.js

@@ -21,12 +21,15 @@ const runQuery = (config, params, fn) => {
     const result = fn();
     const endTime = process.hrtime(startTime);
     const endTimeMs = endTime[0] * 1_000 + endTime[1] / 1_000_000;
-    if (config.onQueryComplete || config.onQueryLog) {
+    if (config.onQueryComplete || config.onQueryLog || config.onQueryTime) {
         const queryString = (0, exports.getFullQueryString)(params);
         config.onQueryComplete?.({ query: queryString, time: endTimeMs });
         if (typeof params === "object" && params.logQuery) {
             config.onQueryLog?.(queryString);
         }
+        if (typeof params === "object" && params.timeQuery) {
+            config.onQueryTime?.(endTimeMs);
+        }
     }
     return result;
 };

package/lib/src/jobs/index.d.ts

@@ -21,7 +21,7 @@ export declare class NeosqliteJobs {
     /**
      * Register a job to be run
      */
-    register<T extends Record<string, any> = Record<string, any>>(name: string, options: JobOptions, fn: (data: T) => void, onFailure?: (data: T, error: Error) => void): void;
+    register<T extends Record<string, any> = Record<string, any>>(name: string, options: JobOptions<T>): void;
     /**
      * Queue a job to run instantly based on its
      * priority

package/lib/src/jobs/index.js

@@ -45,8 +45,8 @@ class NeosqliteJobs {
     /**
      * Register a job to be run
      */
-    register(name, options, fn, onFailure) {
-        this.jobsRegistry[name] = { name, options, fn, onFailure };
+    register(name, options) {
+        this.jobsRegistry[name] = { name, options: options };
     }
     /**
      * Queue a job to run instantly based on its
@@ -161,13 +161,14 @@ class NeosqliteJobs {
         const id = Number(row["id"]);
         const name = String(row["name"]);
         const attempts = Number(row["attempts"]);
+        const data = (0, util_1.Jsonify)(String(row["data"])) ?? {};
         const cron = row["cron"] ? String(row["cron"]) : null;
-        const data = row["data"] ? (0, util_1.Jsonify)(String(row["data"])) : null;
         const job = this.jobsRegistry[name];
         if (!job)
             return;
+        const handler = job.options.handler(data);
         try {
-            await Promise.resolve(job.fn(data));
+            await Promise.resolve(handler.onRun());
             this.db.write({
                 sql: (0, util_1.queryString)("UPDATE " + this.jobsTable, "SET status = :status, updatedAt = CURRENT_TIMESTAMP", "WHERE id = :id"),
                 args: { id, status: types_1.JobStatus.Completed },
@@ -194,8 +195,8 @@ class NeosqliteJobs {
                 sql: (0, util_1.queryString)("UPDATE " + this.jobsTable, "SET status = :status, updatedAt = CURRENT_TIMESTAMP", "WHERE id = :id"),
                 args: { id, status: updatedStatus },
             });
-            if (updatedStatus === types_1.JobStatus.Failed && job.onFailure) {
-                await Promise.resolve(job.onFailure(data, err));
+            if (updatedStatus === types_1.JobStatus.Failed && handler.onFailure) {
+                await Promise.resolve(handler.onFailure(err));
             }
         }
     }

package/lib/src/types.d.ts

@@ -4,6 +4,8 @@ export type NeosqliteConfig = {
     file: ":memory:" | string;
     /** When a query is logged using `logQuery: true`, you will receive the full query string via this callback */
     onQueryLog?: (query: string) => void;
+    /** When a query is timed using `timeQuery: true` you will receive the full query time via this callback (in ms) */
+    onQueryTime?: (time: number) => void;
     /** When a query finishes, gather data about the query from this callback */
     onQueryComplete?: (data: OnQueryFinishData) => void;
 };
@@ -39,6 +41,8 @@ export type OnQueryFinishData = {
 export type QueryParams = {
     /** The SQL query to execute */
     sql: string;
+    /** When true, logs the time that a query took to onQuery */
+    timeQuery?: boolean;
     /** When true, the query string will be sent to onQueryLog */
     logQuery?: boolean;
     /** The values to bind to the query string */
@@ -73,7 +77,14 @@ export interface CreateJobsOptions {
     /** The maximum number of jobs to execute at once. Defaults to 10 */
     maxJobs?: number;
 }
-export interface JobOptions {
+export interface JobOptions<T extends Record<string, any> = Record<string, any>> {
     /** The priority of the job */
     priority?: number;
+    /** The handler for the runner */
+    handler: (data: T) => {
+        /** The runner function for the job, receives the data passed when creating the job */
+        onRun: () => void;
+        /** The failure function for the job, receives the data passed when creating the job and the error that was thrown */
+        onFailure?: (error: Error) => void;
+    };
 }

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.15",
+  "version": "1.0.17",
   "main": "lib/src/index.js",
   "scripts": {
     "build": "tsc",

package/src/client/util.ts

@@ -25,7 +25,7 @@ export const runQuery = (config: NeosqliteConfig, params: ExecuteQueryParams, fn
   const endTime = process.hrtime(startTime);
   const endTimeMs = endTime[0] * 1_000 + endTime[1] / 1_000_000;
 
-  if (config.onQueryComplete || config.onQueryLog) {
+  if (config.onQueryComplete || config.onQueryLog || config.onQueryTime) {
     const queryString = getFullQueryString(params);
 
     config.onQueryComplete?.({ query: queryString, time: endTimeMs });
@@ -33,6 +33,10 @@ export const runQuery = (config: NeosqliteConfig, params: ExecuteQueryParams, fn
     if (typeof params === "object" && params.logQuery) {
       config.onQueryLog?.(queryString);
     }
+
+    if (typeof params === "object" && params.timeQuery) {
+      config.onQueryTime?.(endTimeMs);
+    }
   }
 
   return result;

package/src/jobs/index.ts

@@ -7,8 +7,6 @@ import { CreateJobsOptions, JobOptions, JobStatus, Row, NeosqliteClient } from "
 interface JobRegistryValue {
   name: string;
   options: JobOptions;
-  fn: (data: any) => void;
-  onFailure?: (data: any, error: any) => void;
 }
 
 export class NeosqliteJobs {
@@ -57,13 +55,8 @@ export class NeosqliteJobs {
   /**
    * Register a job to be run
    */
-  public register<T extends Record<string, any> = Record<string, any>>(
-    name: string,
-    options: JobOptions,
-    fn: (data: T) => void,
-    onFailure?: (data: T, error: Error) => void,
-  ) {
-    this.jobsRegistry[name] = { name, options, fn, onFailure };
+  public register<T extends Record<string, any> = Record<string, any>>(name: string, options: JobOptions<T>) {
+    this.jobsRegistry[name] = { name, options: options as JobOptions };
   }
 
   /**
@@ -240,14 +233,16 @@ export class NeosqliteJobs {
     const name = String(row["name"]);
     const attempts = Number(row["attempts"]);
 
+    const data = Jsonify(String(row["data"])) ?? {};
     const cron = row["cron"] ? String(row["cron"]) : null;
-    const data = row["data"] ? Jsonify(String(row["data"])) : null;
 
     const job = this.jobsRegistry[name];
     if (!job) return;
 
+    const handler = job.options.handler(data);
+
     try {
-      await Promise.resolve(job.fn(data));
+      await Promise.resolve(handler.onRun());
 
       this.db.write({
         sql: queryString("UPDATE " + this.jobsTable, "SET status = :status, updatedAt = CURRENT_TIMESTAMP", "WHERE id = :id"),
@@ -282,8 +277,8 @@ export class NeosqliteJobs {
         args: { id, status: updatedStatus },
       });
 
-      if (updatedStatus === JobStatus.Failed && job.onFailure) {
-        await Promise.resolve(job.onFailure(data, err));
+      if (updatedStatus === JobStatus.Failed && handler.onFailure) {
+        await Promise.resolve(handler.onFailure(err as Error));
       }
     }
   }

package/src/types.ts

@@ -7,6 +7,9 @@ export type NeosqliteConfig = {
   /** When a query is logged using `logQuery: true`, you will receive the full query string via this callback */
   onQueryLog?: (query: string) => void;
 
+  /** When a query is timed using `timeQuery: true` you will receive the full query time via this callback (in ms) */
+  onQueryTime?: (time: number) => void;
+
   /** When a query finishes, gather data about the query from this callback */
   onQueryComplete?: (data: OnQueryFinishData) => void;
 };
@@ -52,6 +55,9 @@ export type QueryParams = {
   /** The SQL query to execute */
   sql: string;
 
+  /** When true, logs the time that a query took to onQuery */
+  timeQuery?: boolean;
+
   /** When true, the query string will be sent to onQueryLog */
   logQuery?: boolean;
 
@@ -98,7 +104,16 @@ export interface CreateJobsOptions {
   maxJobs?: number;
 }
 
-export interface JobOptions {
+export interface JobOptions<T extends Record<string, any> = Record<string, any>> {
   /** The priority of the job */
   priority?: number;
+
+  /** The handler for the runner */
+  handler: (data: T) => {
+    /** The runner function for the job, receives the data passed when creating the job */
+    onRun: () => void;
+
+    /** The failure function for the job, receives the data passed when creating the job and the error that was thrown */
+    onFailure?: (error: Error) => void;
+  };
 }