@rwillians/qx 0.1.16 → 0.1.17

package/dist/cjs/adapter.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.is = exports.withLoggedQuery = void 0;
+const u = require("./utils");
+/**
+ * @public  Wraps a function call that executes DDL with logging
+ *          capabilities.
+ *
+ *          A `debug` log is emitted before the function is executed,
+ *          and an `error` log if the function throws an error. After
+ *          logging, the error is re-thrown.
+ * @since   0.1.17
+ * @version 1
+ */
+const withLoggedQuery = async (logger, data, fn) => {
+    const loggers = u.wrap(logger);
+    const { sql, params } = data;
+    loggers.forEach(logger => logger.debug(sql, params));
+    return Promise.resolve().then(() => fn(sql, params)).catch(error => {
+        loggers.forEach(logger => logger.error(sql, params, error));
+        return Promise.reject(error); // propagate the error without
+        // appending stack traces
+    });
+};
+exports.withLoggedQuery = withLoggedQuery;
+var index_1 = require("./index");
+Object.defineProperty(exports, "is", { enumerable: true, get: function () { return index_1.is; } });

package/dist/cjs/bun-sqlite.js

@@ -4,7 +4,7 @@ exports.inmemory = exports.connect = void 0;
 const bun_sqlite_1 = require("bun:sqlite");
 const node_util_1 = require("node:util");
 const u = require("./utils");
-const index_1 = require("./index");
+const adapter_1 = require("./adapter");
 /**
  * @private Mapping of qx's primitive types to SQLite native types.
  * @since   0.1.0
@@ -178,17 +178,17 @@ const render = {
          * @version 1
          */
         any: glue((value) => {
-            if (index_1.is.binaryOp(value))
+            if (adapter_1.is.binaryOp(value))
                 return render.expr.binaryOp(value);
-            if (index_1.is.and(value))
+            if (adapter_1.is.and(value))
                 return render.expr.and(value);
-            if (index_1.is.or(value))
+            if (adapter_1.is.or(value))
                 return render.expr.or(value);
-            if (index_1.is.not(value))
+            if (adapter_1.is.not(value))
                 return render.expr.not(value);
-            if (index_1.is.column(value))
+            if (adapter_1.is.column(value))
                 return render.expr.column(value);
-            if (index_1.is.literal(value))
+            if (adapter_1.is.literal(value))
                 return render.expr.literal(value);
             throw new Error(`Unsupported expression type: ${(0, node_util_1.inspect)(value)}`);
         }),
@@ -260,15 +260,15 @@ const render = {
          * @version 1
          */
         literal: glue((value) => {
-            if (index_1.is.null(value))
+            if (adapter_1.is.null(value))
                 return render.expr.null();
-            if (index_1.is.boolean(value))
+            if (adapter_1.is.boolean(value))
                 return render.expr.boolean(value);
-            if (index_1.is.date(value))
+            if (adapter_1.is.date(value))
                 return render.expr.date(value);
-            if (index_1.is.number(value))
+            if (adapter_1.is.number(value))
                 return render.expr.number(value);
-            if (index_1.is.string(value))
+            if (adapter_1.is.string(value))
                 return render.expr.string(value);
             throw new Error(`Unsupported literal expression: ${(0, node_util_1.inspect)(value)}`);
         }),
@@ -457,9 +457,8 @@ class BunSQLite {
      * @version 1
      */
     async createTable(op) {
-        const { sql } = ddl.createTable(op);
-        this.loggers.forEach(logger => logger.query.debug(sql, []));
-        this.conn.run(sql);
+        const { sql, params } = ddl.createTable(op);
+        await (0, adapter_1.withLoggedQuery)(this.loggers, { sql, params }, () => this.conn.run(sql));
     }
     /**
      * @public  Executes an insert statement.
@@ -472,9 +471,9 @@ class BunSQLite {
             records: op.records.map(createEncoder(op.insertShape)),
             insertShape: u.mapKeys(op.insertShape, u.snakeCase),
         });
-        this.loggers.forEach(logger => logger.query.debug(sql, params));
-        const stmt = this.conn.prepare(sql);
-        const rows = stmt.all(...params);
+        const rows = await (0, adapter_1.withLoggedQuery)(this.loggers, { sql, params }, () => this.conn
+            .prepare(sql)
+            .all(...params));
         return rows.map(createDecoder(op.returnShape));
     }
     /**
@@ -484,9 +483,9 @@ class BunSQLite {
      */
     async query(op) {
         const { sql, params } = ddl.select(op);
-        this.loggers.forEach(logger => logger.query.debug(sql, params));
-        const stmt = this.conn.prepare(sql);
-        const rows = stmt.all(...params);
+        const rows = await (0, adapter_1.withLoggedQuery)(this.loggers, { sql, params }, () => this.conn
+            .prepare(sql)
+            .all(...params));
         return rows.map(createDecoder(op.select));
     }
     /**
@@ -495,7 +494,7 @@ class BunSQLite {
      * @version 1
      */
     async transaction(fn) {
-        return await this.conn.transaction(fn)();
+        return this.conn.transaction(fn)();
     }
 }
 /**
@@ -506,7 +505,7 @@ class BunSQLite {
 const connect = (...args) => new BunSQLite(new bun_sqlite_1.Database(...args));
 exports.connect = connect;
 /**
- * @public  An in-memory database connection.
+ * @public  Creates a connection to an in-memory database.
  * @since   0.1.12
  * @version 2
  */

package/dist/cjs/console-logger.js

@@ -8,9 +8,7 @@ const node_util_1 = require("node:util");
  * @version 2
  */
 const createConsoleLogger = () => ({
-    query: {
-        debug: (sql, params) => { process.stdout.write(sql + ' ' + (0, node_util_1.inspect)(params, false, null, true) + '\n'); },
-        error: (sql, params) => { process.stderr.write(sql + ' ' + (0, node_util_1.inspect)(params, false, null, true) + '\n'); },
-    },
+    debug: (sql, params) => { process.stdout.write(sql + ' ' + (0, node_util_1.inspect)(params, false, null, true) + '\n'); },
+    error: (sql, params) => { process.stderr.write(sql + ' ' + (0, node_util_1.inspect)(params, false, null, true) + '\n'); },
 });
 exports.createConsoleLogger = createConsoleLogger;

package/dist/cjs/utils.js

@@ -1,13 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrap = exports.snakeCase = exports.resolve = exports.mapValues = exports.mapKeys = exports.lte = exports.isPlainObject = exports.camelCase = void 0;
+exports.wrap = exports.snakeCase = exports.resolve = exports.mapValues = exports.mapKeys = exports.lte = exports.keys = exports.isPlainObject = exports.entries = exports.camelCase = void 0;
 /**
  * @private Converts a snake_case string to camelCase.
  * @since   0.1.0
- * @version 1
+ * @version 2
  */
 const camelCase = (str) => str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
 exports.camelCase = camelCase;
+/**
+ * @private Same as {@link Object.prototype.entries} but with better
+ *          types.
+ * @since   0.1.17
+ * @version 1
+ */
+const entries = (obj) => Object.entries(obj);
+exports.entries = entries;
 /**
    * @private Simplified check for plain objects.
    * @since   0.1.0
@@ -22,6 +30,14 @@ const isPlainObject = (value) => {
     return proto === Object.prototype;
 };
 exports.isPlainObject = isPlainObject;
+/**
+ * @private Same as {@link Object.prototype.keys} but with better
+ *          types.
+ * @since   0.1.17
+ * @version 1
+ */
+const keys = (obj) => Object.keys(obj);
+exports.keys = keys;
 /**
    * @private Throws an error if the given number is greater than the
    *          specified maximum.
@@ -39,14 +55,14 @@ exports.lte = lte;
  * @since   0.1.0
  * @version 1
  */
-const mapKeys = (obj, fn) => Object.fromEntries(Object.entries(obj).map(([key, value]) => [fn(key), value]));
+const mapKeys = (obj, fn) => Object.fromEntries((0, exports.entries)(obj).map(([key, value]) => [fn(key), value]));
 exports.mapKeys = mapKeys;
 /**
  * @private Maps over the values of an object.
  * @since   0.1.0
  * @version 1
  */
-const mapValues = (obj, fn) => Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, fn(value, key)]));
+const mapValues = (obj, fn) => Object.fromEntries((0, exports.entries)(obj).map(([key, value]) => [key, fn(value, key)]));
 exports.mapValues = mapValues;
 /**
    * @private Resolves the given value or function to a value.

package/dist/esm/adapter.js

@@ -0,0 +1,23 @@
+import {} from './index';
+import * as u from './utils';
+/**
+ * @public  Wraps a function call that executes DDL with logging
+ *          capabilities.
+ *
+ *          A `debug` log is emitted before the function is executed,
+ *          and an `error` log if the function throws an error. After
+ *          logging, the error is re-thrown.
+ * @since   0.1.17
+ * @version 1
+ */
+export const withLoggedQuery = async (logger, data, fn) => {
+    const loggers = u.wrap(logger);
+    const { sql, params } = data;
+    loggers.forEach(logger => logger.debug(sql, params));
+    return Promise.resolve().then(() => fn(sql, params)).catch(error => {
+        loggers.forEach(logger => logger.error(sql, params, error));
+        return Promise.reject(error); // propagate the error without
+        // appending stack traces
+    });
+};
+export { is, } from './index';

package/dist/esm/bun-sqlite.js

@@ -1,7 +1,7 @@
 import { Database } from 'bun:sqlite';
 import { inspect } from 'node:util';
 import * as u from './utils';
-import { is, } from './index';
+import { is, withLoggedQuery, } from './adapter';
 /**
  * @private Mapping of qx's primitive types to SQLite native types.
  * @since   0.1.0
@@ -454,9 +454,8 @@ class BunSQLite {
      * @version 1
      */
     async createTable(op) {
-        const { sql } = ddl.createTable(op);
-        this.loggers.forEach(logger => logger.query.debug(sql, []));
-        this.conn.run(sql);
+        const { sql, params } = ddl.createTable(op);
+        await withLoggedQuery(this.loggers, { sql, params }, () => this.conn.run(sql));
     }
     /**
      * @public  Executes an insert statement.
@@ -469,9 +468,9 @@ class BunSQLite {
             records: op.records.map(createEncoder(op.insertShape)),
             insertShape: u.mapKeys(op.insertShape, u.snakeCase),
         });
-        this.loggers.forEach(logger => logger.query.debug(sql, params));
-        const stmt = this.conn.prepare(sql);
-        const rows = stmt.all(...params);
+        const rows = await withLoggedQuery(this.loggers, { sql, params }, () => this.conn
+            .prepare(sql)
+            .all(...params));
         return rows.map(createDecoder(op.returnShape));
     }
     /**
@@ -481,9 +480,9 @@ class BunSQLite {
      */
     async query(op) {
         const { sql, params } = ddl.select(op);
-        this.loggers.forEach(logger => logger.query.debug(sql, params));
-        const stmt = this.conn.prepare(sql);
-        const rows = stmt.all(...params);
+        const rows = await withLoggedQuery(this.loggers, { sql, params }, () => this.conn
+            .prepare(sql)
+            .all(...params));
         return rows.map(createDecoder(op.select));
     }
     /**
@@ -492,7 +491,7 @@ class BunSQLite {
      * @version 1
      */
     async transaction(fn) {
-        return await this.conn.transaction(fn)();
+        return this.conn.transaction(fn)();
     }
 }
 /**
@@ -502,7 +501,7 @@ class BunSQLite {
  */
 const connect = (...args) => new BunSQLite(new Database(...args));
 /**
- * @public  An in-memory database connection.
+ * @public  Creates a connection to an in-memory database.
  * @since   0.1.12
  * @version 2
  */

package/dist/esm/console-logger.js

@@ -6,8 +6,6 @@ import {} from './index';
  * @version 2
  */
 export const createConsoleLogger = () => ({
-    query: {
-        debug: (sql, params) => { process.stdout.write(sql + ' ' + inspect(params, false, null, true) + '\n'); },
-        error: (sql, params) => { process.stderr.write(sql + ' ' + inspect(params, false, null, true) + '\n'); },
-    },
+    debug: (sql, params) => { process.stdout.write(sql + ' ' + inspect(params, false, null, true) + '\n'); },
+    error: (sql, params) => { process.stderr.write(sql + ' ' + inspect(params, false, null, true) + '\n'); },
 });

package/dist/esm/utils.js

@@ -1,9 +1,16 @@
 /**
  * @private Converts a snake_case string to camelCase.
  * @since   0.1.0
- * @version 1
+ * @version 2
  */
 export const camelCase = (str) => str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase());
+/**
+ * @private Same as {@link Object.prototype.entries} but with better
+ *          types.
+ * @since   0.1.17
+ * @version 1
+ */
+export const entries = (obj) => Object.entries(obj);
 /**
    * @private Simplified check for plain objects.
    * @since   0.1.0
@@ -17,6 +24,13 @@ export const isPlainObject = (value) => {
         return true;
     return proto === Object.prototype;
 };
+/**
+ * @private Same as {@link Object.prototype.keys} but with better
+ *          types.
+ * @since   0.1.17
+ * @version 1
+ */
+export const keys = (obj) => Object.keys(obj);
 /**
    * @private Throws an error if the given number is greater than the
    *          specified maximum.
@@ -33,13 +47,13 @@ export const lte = (n, max) => {
  * @since   0.1.0
  * @version 1
  */
-export const mapKeys = (obj, fn) => Object.fromEntries(Object.entries(obj).map(([key, value]) => [fn(key), value]));
+export const mapKeys = (obj, fn) => Object.fromEntries(entries(obj).map(([key, value]) => [fn(key), value]));
 /**
  * @private Maps over the values of an object.
  * @since   0.1.0
  * @version 1
  */
-export const mapValues = (obj, fn) => Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, fn(value, key)]));
+export const mapValues = (obj, fn) => Object.fromEntries(entries(obj).map(([key, value]) => [key, fn(value, key)]));
 /**
    * @private Resolves the given value or function to a value.
    * @since   0.1.0

package/dist/types/adapter.d.ts

@@ -0,0 +1,16 @@
+import { type ILogger } from './index';
+/**
+ * @public  Wraps a function call that executes DDL with logging
+ *          capabilities.
+ *
+ *          A `debug` log is emitted before the function is executed,
+ *          and an `error` log if the function throws an error. After
+ *          logging, the error is re-thrown.
+ * @since   0.1.17
+ * @version 1
+ */
+export declare const withLoggedQuery: <T>(logger: ILogger | ILogger[], data: {
+    sql: string;
+    params: any[];
+}, fn: (sql: string, params: any[]) => Promise<T> | T) => Promise<T>;
+export { type CodecsRegistry, type Column, type CreateTableStatement, type DDL, type Expr, type ExprAnd, type ExprBinaryOp, type ExprLiteral, type ExprNot, type ExprOr, type IDatabase, type ILogger, type InsertStatement, type Join, type OrderDirection, type PrimitiveToNativeTypeFactory, type SelectStatement, is, } from './index';

package/dist/types/bun-sqlite.d.ts

@@ -1,5 +1,5 @@
 import { Database } from 'bun:sqlite';
-import { type CreateTableStatement, type IDatabase, type ILogger, type InsertStatement, type SelectStatement } from './index';
+import { type CreateTableStatement, type IDatabase, type ILogger, type InsertStatement, type SelectStatement } from './adapter';
 /**
  * @private Bun SQLite database adapter implementation.
  * @since   0.1.0
@@ -51,7 +51,7 @@ declare class BunSQLite implements IDatabase {
  */
 declare const connect: (...args: ConstructorParameters<typeof Database>) => BunSQLite;
 /**
- * @public  An in-memory database connection.
+ * @public  Creates a connection to an in-memory database.
  * @since   0.1.12
  * @version 2
  */

package/dist/types/index.d.ts

@@ -802,6 +802,25 @@ declare const is: {
      */
     column: (expr: Expr) => expr is Column;
 };
+/**
+ * @public  Query logger interface.
+ * @since   0.1.0
+ * @version 2
+ */
+interface ILogger {
+    /**
+     * @public  Logs a query that has executed successfully.
+     * @since   0.1.17
+     * @version 1
+     */
+    debug(sql: string, params: any[]): void;
+    /**
+     * @public  Logs a query that has failed with an error.
+     * @since   0.1.12
+     * @version 2
+     */
+    error(sql: string, params: any[], error?: Error): void;
+}
 /**
  * @public  Represents the direction of ordering in an ORDER BY
  *          clause.
@@ -977,33 +996,6 @@ type DDL = {
     sql: string;
     params: any[];
 };
-/**
- * @public  Query logger interface.
- * @since   0.1.0
- * @version 1
- */
-interface ILogger {
-    /**
-     * @public  Query specific logging methods, so this interface plays
-     *          nice with existing logging libraries (by extending them).
-     * @since   0.1.0
-     * @version 1
-     */
-    query: {
-        /**
-         * @public  Logs a query that has executed successfully.
-         * @since   0.1.0
-         * @version 1
-         */
-        debug(sql: string, params: any[]): void;
-        /**
-         * @public  Logs a query that has failed with an error.
-         * @since   0.1.12
-         * @version 1
-         */
-        error(sql: string, params: any[], error: Error): void;
-    };
-}
 /**
  * @public  The interface that all database adapters must implement.
  * @since   0.1.0

package/dist/types/utils.d.ts

@@ -1,15 +1,43 @@
+/**
+ * @private Converts a snake_case string to camelCase at the type
+ *          level.
+ * @since   0.1.17
+ * @version 1
+ */
+type CamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${T}${Capitalize<CamelCase<U>>}` : S;
+/**
+ * @private Converts a camelCase string to snake_case at the type
+ *          level.
+ * @since   0.1.17
+ * @version 1
+ */
+type SnakeCase<S extends string> = S extends `${infer T}${infer U}` ? U extends Uncapitalize<U> ? `${Lowercase<T>}${SnakeCase<U>}` : `${Lowercase<T>}_${SnakeCase<Uncapitalize<U>>}` : S;
 /**
  * @private Converts a snake_case string to camelCase.
  * @since   0.1.0
+ * @version 2
+ */
+export declare const camelCase: <T extends string>(str: T) => CamelCase<T>;
+/**
+ * @private Same as {@link Object.prototype.entries} but with better
+ *          types.
+ * @since   0.1.17
  * @version 1
  */
-export declare const camelCase: (str: string) => string;
+export declare const entries: <T extends Record<string, any>>(obj: T) => [keyof T, T[keyof T]][];
 /**
    * @private Simplified check for plain objects.
    * @since   0.1.0
    * @version 1
    */
 export declare const isPlainObject: (value: unknown) => value is Record<string, any>;
+/**
+ * @private Same as {@link Object.prototype.keys} but with better
+ *          types.
+ * @since   0.1.17
+ * @version 1
+ */
+export declare const keys: <T extends Record<string, any>>(obj: T) => (keyof T)[];
 /**
    * @private Throws an error if the given number is greater than the
    *          specified maximum.
@@ -40,7 +68,7 @@ export declare const resolve: <T>(value: T | (() => T)) => T;
  * @since   0.1.0
  * @version 1
  */
-export declare const snakeCase: (str: string) => string;
+export declare const snakeCase: <T extends string>(str: T) => SnakeCase<T>;
 /**
    * @public  Wraps the given value in an array, unless it's already an
    *          array.
@@ -48,3 +76,4 @@ export declare const snakeCase: (str: string) => string;
    * @version 1
    */
 export declare const wrap: <T>(value: T | T[]) => T[];
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rwillians/qx",
-  "description": "A teeny tiny ORM for SQLite.",
-  "version": "0.1.16",
+  "description": "A zero-dependencies teeny tiny ORM for SQLite.",
+  "version": "0.1.17",
   "author": "Rafael Willians <me@rwillians.com>",
   "license": "MIT",
   "repository": {
@@ -21,7 +21,8 @@
     "bun"
   ],
   "type": "module",
-  "module": "dist/index.js",
+  "module": "dist/esm/index.js",
+  "main": "dist/cjs/index.js",
   "files": ["dist/", "LICENSE"],
   "exports": {
     ".": {
@@ -30,6 +31,12 @@
       "require": "./dist/cjs/index.js",
       "default": "./dist/cjs/index.js"
     },
+    "./adapter": {
+      "types": "./dist/types/adapter.d.ts",
+      "import": "./dist/esm/adapter.js",
+      "require": "./dist/cjs/adapter.js",
+      "default": "./dist/cjs/adapter.js"
+    },
     "./bun-sqlite": {
       "types": "./dist/types/bun-sqlite.d.ts",
       "import": "./dist/esm/bun-sqlite.js",
@@ -42,11 +49,11 @@
       "require": "./dist/cjs/console-logger.js",
       "default": "./dist/cjs/console-logger.js"
     },
-    "./experimental-migration": {
-      "types": "./dist/types/experimental-migration.d.ts",
-      "import": "./dist/esm/experimental-migration.js",
-      "require": "./dist/cjs/experimental-migration.js",
-      "default": "./dist/cjs/experimental-migration.js"
+    "./experimental-migrations": {
+      "types": "./dist/types/experimental-migrations.d.ts",
+      "import": "./dist/esm/experimental-migrations.js",
+      "require": "./dist/cjs/experimental-migrations.js",
+      "default": "./dist/cjs/experimental-migrations.js"
     }
   },
   "scripts": {