@rwillians/qx 0.1.19 → 0.1.21

package/dist/cjs/console-logger.js

@@ -3,12 +3,133 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createConsoleLogger = void 0;
 const node_util_1 = require("node:util");
 /**
- * @public  Creates a basic console logger that logs all queries.
+ * @private Non-exhaustive table of ASCII codes for styled console
+ *          output.
+ * @since   0.1.21
+ * @version 1
+ */
+const ASCII_STYLE_CODES = {
+    blue: { open: 34, close: 39 },
+    bold: { open: 1, close: 22 },
+    brightRed: { open: 91, close: 39 },
+    dim: { open: 2, close: 22 },
+    green: { open: 32, close: 39 },
+    italic: { open: 3, close: 23 },
+    red: { open: 31, close: 39 },
+    yellow: { open: 33, close: 39 },
+};
+/**
+ * @private A registry of style functions for console output, one for
+ *          each style in the ASCII codes table.
+ * @since   0.1.21
+ * @version 1
+ */
+const s = Object.fromEntries(Object
+    .entries(ASCII_STYLE_CODES)
+    .map(([key, style]) => [key, (str) => `\u001b[${style.open}m${str.toString()}\u001b[${style.close}m`])
+    .concat([['default', (str) => str.toString()]]));
+/**
+ * @private Split the given query into a tuple, where the first elment
+ *          is the statement name (e.g. SELECT, INSERT, etc) and the
+ *          second element is the rest of the query.
+ * @since   0.1.21
+ * @version 1
+ */
+const splitAtStatementName = (str) => [str.split(' ')[0], str.slice(str.indexOf(' '))];
+/**
+ * @private Paints the given SQL depending on what it does (e.g.
+ *          DELETEs are red, SELECTs are green, etc).
+ * @since   0.1.21
+ * @version 1
+ */
+const dye = (sql) => {
+    const [statement, rest] = splitAtStatementName(sql);
+    if (statement === 'INSERT')
+        return s.green(`${s.bold(statement)} ${rest}`);
+    if (statement === 'SELECT')
+        return s.blue(`${s.bold(statement)} ${rest}`);
+    if (statement === 'UPDATE')
+        return s.yellow(`${s.bold(statement)} ${rest}`);
+    if (statement === 'DELETE')
+        return s.brightRed(`${s.bold(statement)} ${rest}`);
+    return sql;
+};
+/**
+ * @private Renders a query parameter value for logging purposes.
+ * @since   0.1.21
+ * @version 1
+ */
+const render = (value) => {
+    if (value === null)
+        return s.dim('null');
+    if (value === undefined)
+        return s.dim('null');
+    if (typeof value === 'boolean')
+        return value.toString();
+    if (typeof value === 'number')
+        return s.blue(value.toString());
+    if (typeof value === 'string')
+        return [s.dim('`'), value, s.dim('`')].join('');
+    if (value instanceof Date)
+        return s.blue(`${value.toISOString()}`);
+    if (Array.isArray(value))
+        return [s.dim('['), value.map(render).join(s.dim(', ')), s.dim(']')].join('');
+    throw new Error(`Unable to render value: ${(0, node_util_1.inspect)(value, true, null, true)}`);
+};
+/**
+ * @private A function that [p]retty-[p]rints the given SQL query, its
+ *          parameters and its error.
+ * @since   0.1.21
+ * @version 1
+ */
+const pp = (sql, params, error) => [
+    dye(sql),
+    ' ',
+    render(params),
+    error
+        ? ('\n\n' + s.red(`${s.bold(error.constructor.name)} ${error.message}\n${error.stack}`.trim()) + '\n\n')
+        : '',
+].join('');
+/**
+ * @private A function that prints the given SQL query, its parameters
+ *          and its error as [p]lain [t]ext (no ASCII styling).
+ * @since   0.1.21
+ * @version 1
+ */
+const pt = (sql, params, error) => [
+    sql,
+    ' ',
+    render(params),
+    error
+        ? ('\n\n' + (`${error.constructor.name} ${error.message}\n${error.stack}`.trim()) + '\n\n')
+        : '',
+].join('');
+/**
+ * @private Returns a function that pretty-prints its given arguments
+ *          to the specified stream.
+ * @since   0.1.21
+ * @version 1
+ */
+const handler = (stream, fn) => (...args) => { stream.write(fn(...args)); };
+/**
+ * @public  Creates a basic console logger that pretty-prints queries.
+ *
+ *          Pretty printing is enabled by default but you can disable
+ *          it to print plain-text instead (no ASCII styling), just
+ *          set the option `pretty` to `false`.
  * @since   0.1.0
- * @version 2
+ * @version 3
+ *
+ * @example
+ * ```ts
+ * import { createConsoleLogger } from '@rwillians/qx/console-logger';
+ *
+ * const prettyLogger = createConsoleLogger();
+ * const plainLogger = createConsoleLogger({ pretty: false });
+ * ```
  */
-const createConsoleLogger = () => ({
-    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'); },
+const createConsoleLogger = (opts = { pretty: true }) => ({
+    debug: handler(process.stdout, opts.pretty ? pp : pt),
+    error: handler(process.stderr, opts.pretty ? pp : pt),
 });
 exports.createConsoleLogger = createConsoleLogger;

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.transaction = exports.is = exports.into = exports.from = exports.expr = exports.table = void 0;
+exports.t = exports.transaction = exports.is = exports.into = exports.from = exports.expr = exports.table = exports.column = void 0;
 const std = require("./standard-schema");
 const u = require("./utils");
 // // // // // // // // // // // // // // // // // // // // // // // //
@@ -89,6 +89,7 @@ class ColumnPropsBuilder {
  * @version 1
  */
 const defineColumn = (baseProps) => new ColumnPropsBuilder(baseProps);
+exports.column = defineColumn;
 /**
  * @public  Built-in column types.
  * @since   0.1.0

package/dist/esm/console-logger.js

@@ -1,11 +1,132 @@
 import { inspect } from 'node:util';
 import {} from './index';
 /**
- * @public  Creates a basic console logger that logs all queries.
+ * @private Non-exhaustive table of ASCII codes for styled console
+ *          output.
+ * @since   0.1.21
+ * @version 1
+ */
+const ASCII_STYLE_CODES = {
+    blue: { open: 34, close: 39 },
+    bold: { open: 1, close: 22 },
+    brightRed: { open: 91, close: 39 },
+    dim: { open: 2, close: 22 },
+    green: { open: 32, close: 39 },
+    italic: { open: 3, close: 23 },
+    red: { open: 31, close: 39 },
+    yellow: { open: 33, close: 39 },
+};
+/**
+ * @private A registry of style functions for console output, one for
+ *          each style in the ASCII codes table.
+ * @since   0.1.21
+ * @version 1
+ */
+const s = Object.fromEntries(Object
+    .entries(ASCII_STYLE_CODES)
+    .map(([key, style]) => [key, (str) => `\u001b[${style.open}m${str.toString()}\u001b[${style.close}m`])
+    .concat([['default', (str) => str.toString()]]));
+/**
+ * @private Split the given query into a tuple, where the first elment
+ *          is the statement name (e.g. SELECT, INSERT, etc) and the
+ *          second element is the rest of the query.
+ * @since   0.1.21
+ * @version 1
+ */
+const splitAtStatementName = (str) => [str.split(' ')[0], str.slice(str.indexOf(' '))];
+/**
+ * @private Paints the given SQL depending on what it does (e.g.
+ *          DELETEs are red, SELECTs are green, etc).
+ * @since   0.1.21
+ * @version 1
+ */
+const dye = (sql) => {
+    const [statement, rest] = splitAtStatementName(sql);
+    if (statement === 'INSERT')
+        return s.green(`${s.bold(statement)} ${rest}`);
+    if (statement === 'SELECT')
+        return s.blue(`${s.bold(statement)} ${rest}`);
+    if (statement === 'UPDATE')
+        return s.yellow(`${s.bold(statement)} ${rest}`);
+    if (statement === 'DELETE')
+        return s.brightRed(`${s.bold(statement)} ${rest}`);
+    return sql;
+};
+/**
+ * @private Renders a query parameter value for logging purposes.
+ * @since   0.1.21
+ * @version 1
+ */
+const render = (value) => {
+    if (value === null)
+        return s.dim('null');
+    if (value === undefined)
+        return s.dim('null');
+    if (typeof value === 'boolean')
+        return value.toString();
+    if (typeof value === 'number')
+        return s.blue(value.toString());
+    if (typeof value === 'string')
+        return [s.dim('`'), value, s.dim('`')].join('');
+    if (value instanceof Date)
+        return s.blue(`${value.toISOString()}`);
+    if (Array.isArray(value))
+        return [s.dim('['), value.map(render).join(s.dim(', ')), s.dim(']')].join('');
+    throw new Error(`Unable to render value: ${inspect(value, true, null, true)}`);
+};
+/**
+ * @private A function that [p]retty-[p]rints the given SQL query, its
+ *          parameters and its error.
+ * @since   0.1.21
+ * @version 1
+ */
+const pp = (sql, params, error) => [
+    dye(sql),
+    ' ',
+    render(params),
+    error
+        ? ('\n\n' + s.red(`${s.bold(error.constructor.name)} ${error.message}\n${error.stack}`.trim()) + '\n\n')
+        : '',
+].join('');
+/**
+ * @private A function that prints the given SQL query, its parameters
+ *          and its error as [p]lain [t]ext (no ASCII styling).
+ * @since   0.1.21
+ * @version 1
+ */
+const pt = (sql, params, error) => [
+    sql,
+    ' ',
+    render(params),
+    error
+        ? ('\n\n' + (`${error.constructor.name} ${error.message}\n${error.stack}`.trim()) + '\n\n')
+        : '',
+].join('');
+/**
+ * @private Returns a function that pretty-prints its given arguments
+ *          to the specified stream.
+ * @since   0.1.21
+ * @version 1
+ */
+const handler = (stream, fn) => (...args) => { stream.write(fn(...args)); };
+/**
+ * @public  Creates a basic console logger that pretty-prints queries.
+ *
+ *          Pretty printing is enabled by default but you can disable
+ *          it to print plain-text instead (no ASCII styling), just
+ *          set the option `pretty` to `false`.
  * @since   0.1.0
- * @version 2
+ * @version 3
+ *
+ * @example
+ * ```ts
+ * import { createConsoleLogger } from '@rwillians/qx/console-logger';
+ *
+ * const prettyLogger = createConsoleLogger();
+ * const plainLogger = createConsoleLogger({ pretty: false });
+ * ```
  */
-export const createConsoleLogger = () => ({
-    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'); },
+export const createConsoleLogger = (opts = { pretty: true }) => ({
+    debug: handler(process.stdout, opts.pretty ? pp : pt),
+    error: handler(process.stderr, opts.pretty ? pp : pt),
 });

package/dist/esm/index.js

@@ -689,4 +689,4 @@ const from = (table) => new QueryBuilder({
 // // // // // // // // // // // // // // // // // // // // // // // //
 //                              EXPORTS                              //
 // // // // // // // // // // // // // // // // // // // // // // // //
-export { defineTable as table, expr, from, into, is, transaction, types as t, };
+export { defineColumn as column, defineTable as table, expr, from, into, is, transaction, types as t, };

package/dist/types/console-logger.d.ts

@@ -1,7 +1,21 @@
 import { type ILogger } from './index';
 /**
- * @public  Creates a basic console logger that logs all queries.
+ * @public  Creates a basic console logger that pretty-prints queries.
+ *
+ *          Pretty printing is enabled by default but you can disable
+ *          it to print plain-text instead (no ASCII styling), just
+ *          set the option `pretty` to `false`.
  * @since   0.1.0
- * @version 2
+ * @version 3
+ *
+ * @example
+ * ```ts
+ * import { createConsoleLogger } from '@rwillians/qx/console-logger';
+ *
+ * const prettyLogger = createConsoleLogger();
+ * const plainLogger = createConsoleLogger({ pretty: false });
+ * ```
  */
-export declare const createConsoleLogger: () => ILogger;
+export declare const createConsoleLogger: (opts?: {
+    pretty: boolean;
+}) => ILogger;

package/dist/types/index.d.ts

@@ -310,6 +310,12 @@ declare class ColumnPropsBuilder<T extends ColumnProps = ColumnProps> {
         unique: true;
     }>>;
 }
+/**
+ * @public  A way to define a column with a custom standard schema.
+ * @since   0.1.0
+ * @version 1
+ */
+declare const defineColumn: <T extends ColumnProps>(baseProps: T) => ColumnPropsBuilder<T>;
 /**
  * @public  Built-in column types.
  * @since   0.1.0
@@ -1224,4 +1230,4 @@ declare class QueryBuilder<T extends Record<string, Aliased<string, Table>>, S e
  * @version 1
  */
 declare const from: <S extends string, T extends Aliased<S, Table>>(table: T) => QueryBuilder<{ [K in T[typeof TABLE_ALIAS]]: T; }, T>;
-export { type CodecsRegistry, type Column, type CreateTableStatement, type DDL, type Expr, type ExprAnd, type ExprBinaryOp, type ExprEq, type ExprGt, type ExprGte, type ExprIn, type ExprIs, type ExprIsNot, type ExprLike, type ExprLiteral, type ExprLt, type ExprLte, type ExprNe, type ExprNot, type ExprNotIn, type ExprNotLike, type ExprOr, type IDatabase, type ILogger, type Join, type InsertStatement, type OrderDirection, type Primitive, type PrimitiveToNativeTypeFactory, type SelectStatement, type Table, defineTable as table, expr, from, into, is, transaction, types as t, };
+export { type CodecsRegistry, type Column, type CreateTableStatement, type DDL, type Expr, type ExprAnd, type ExprBinaryOp, type ExprEq, type ExprGt, type ExprGte, type ExprIn, type ExprIs, type ExprIsNot, type ExprLike, type ExprLiteral, type ExprLt, type ExprLte, type ExprNe, type ExprNot, type ExprNotIn, type ExprNotLike, type ExprOr, type IDatabase, type ILogger, type Join, type InsertStatement, type OrderDirection, type Primitive, type PrimitiveToNativeTypeFactory, type SelectStatement, type Table, defineColumn as column, defineTable as table, expr, from, into, is, transaction, types as t, };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rwillians/qx",
   "description": "A zero-dependencies teeny tiny ORM for SQLite.",
-  "version": "0.1.19",
+  "version": "0.1.21",
   "author": "Rafael Willians <me@rwillians.com>",
   "license": "MIT",
   "repository": {
@@ -62,7 +62,8 @@
     "build:esm": "bun run --bun tsc --project tsconfig-esm.json"
   },
   "devDependencies": {
-    "@types/bun": "latest"
+    "@types/bun": "^1.3.9",
+    "@types/node": "^25.3.0"
   },
   "peerDependencies": {
     "typescript": "^5.9.3"