@rwillians/qx 0.1.5 → 0.1.7

package/dist/cjs/bun-sqlite.js

@@ -442,7 +442,7 @@ class BunSQLite {
      */
     async createTable(op) {
         const { sql } = ddl.createTable(op);
-        this.loggers.forEach(logger => logger.debug(sql, []));
+        this.loggers.forEach(logger => logger.query.debug(sql, []));
         this.conn.run(sql);
     }
     /**
@@ -456,7 +456,7 @@ class BunSQLite {
             records: op.records.map(createEncoder(op.insertShape)),
             insertShape: u.mapKeys(op.insertShape, u.snakeCase),
         });
-        this.loggers.forEach(logger => logger.debug(sql, params));
+        this.loggers.forEach(logger => logger.query.debug(sql, params));
         const stmt = this.conn.prepare(sql);
         const rows = stmt.all(...params);
         return rows.map(createDecoder(op.returnShape));
@@ -468,7 +468,7 @@ class BunSQLite {
      */
     async query(op) {
         const { sql, params } = ddl.select(op);
-        this.loggers.forEach(logger => logger.debug(sql, params));
+        this.loggers.forEach(logger => logger.query.debug(sql, params));
         const stmt = this.conn.prepare(sql);
         const rows = stmt.all(...params);
         return rows.map(createDecoder(op.select));

package/dist/cjs/experimental-migration.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineMigrations = void 0;
+const ora_1 = require("ora");
+const index_1 = require("./index");
+const migrations = (0, index_1.table)('migrations', t => ({
+    id: t.string({ size: 36 }).primaryKey(),
+    migratedAt: t.datetime(),
+}));
+/**
+ * @public  Defines and runs migrations against the given database.
+ * @since   0.1.6
+ * @version 1
+ */
+const defineMigrations = (migs) => async (db) => {
+    let spinner;
+    await index_1.create.table(migrations, { ifNotExists: true }).onto(db);
+    for (const [id, migration] of Object.entries(migs)) {
+        const alreadyMigrated = await (0, index_1.from)(migrations.as('m'))
+            .where(({ m }) => index_1.expr.eq(m.id, id))
+            .exists(db);
+        if (alreadyMigrated)
+            continue;
+        spinner ??= (0, ora_1.default)('running migrations...').start();
+        spinner.text = `running migration ${id}...`;
+        // @TODO run in a transaction
+        await migration(db);
+        await (0, index_1.into)(migrations)
+            .insert({ id, migratedAt: new Date() })
+            .run(db);
+    }
+    spinner?.stop();
+};
+exports.defineMigrations = defineMigrations;

package/dist/cjs/index.js

@@ -440,7 +440,6 @@ const is = {
 };
 exports.is = is;
 ;
-;
 // // // // // // // // // // // // // // // // // // // // // // // //
 //                         CREATE STATEMENTS                         //
 // // // // // // // // // // // // // // // // // // // // // // // //
@@ -600,6 +599,16 @@ class QueryBuilder {
         // @TODO calls query engine with the query object
         return db.query(toSelectStatement(this.query));
     }
+    /**
+     * @public  Checks whether any rows exist matching the query.
+     * @since   0.1.6
+     * @version 1
+     */
+    async exists(db) {
+        // @TODO optimize this, maybe do a SELECT 1 or something
+        const results = await db.query(toSelectStatement({ ...this.query, limit: 1, offset: 0 }));
+        return results.length > 0;
+    }
     /**
      * @public  Sets a limit on the number of rows to be returned.
      * @since   0.1.0

package/dist/cjs/pretty-logger.js

@@ -9,6 +9,8 @@ const sql_highlight_1 = require("sql-highlight");
  * @version 1
  */
 const createPrettyLogger = () => ({
-    debug: (sql, params) => { process.stdout.write((0, sql_highlight_1.highlight)(sql) + ' ' + (0, node_util_1.inspect)(params, false, null, true) + '\n'); },
+    query: {
+        debug: (sql, params) => { process.stdout.write((0, sql_highlight_1.highlight)(sql) + ' ' + (0, node_util_1.inspect)(params, false, null, true) + '\n'); },
+    },
 });
 exports.createPrettyLogger = createPrettyLogger;

package/dist/esm/bun-sqlite.js

@@ -439,7 +439,7 @@ class BunSQLite {
      */
     async createTable(op) {
         const { sql } = ddl.createTable(op);
-        this.loggers.forEach(logger => logger.debug(sql, []));
+        this.loggers.forEach(logger => logger.query.debug(sql, []));
         this.conn.run(sql);
     }
     /**
@@ -453,7 +453,7 @@ class BunSQLite {
             records: op.records.map(createEncoder(op.insertShape)),
             insertShape: u.mapKeys(op.insertShape, u.snakeCase),
         });
-        this.loggers.forEach(logger => logger.debug(sql, params));
+        this.loggers.forEach(logger => logger.query.debug(sql, params));
         const stmt = this.conn.prepare(sql);
         const rows = stmt.all(...params);
         return rows.map(createDecoder(op.returnShape));
@@ -465,7 +465,7 @@ class BunSQLite {
      */
     async query(op) {
         const { sql, params } = ddl.select(op);
-        this.loggers.forEach(logger => logger.debug(sql, params));
+        this.loggers.forEach(logger => logger.query.debug(sql, params));
         const stmt = this.conn.prepare(sql);
         const rows = stmt.all(...params);
         return rows.map(createDecoder(op.select));

package/dist/esm/experimental-migration.js

@@ -0,0 +1,30 @@
+import ora from 'ora';
+import { create, expr, from, into, table } from './index';
+const migrations = table('migrations', t => ({
+    id: t.string({ size: 36 }).primaryKey(),
+    migratedAt: t.datetime(),
+}));
+/**
+ * @public  Defines and runs migrations against the given database.
+ * @since   0.1.6
+ * @version 1
+ */
+export const defineMigrations = (migs) => async (db) => {
+    let spinner;
+    await create.table(migrations, { ifNotExists: true }).onto(db);
+    for (const [id, migration] of Object.entries(migs)) {
+        const alreadyMigrated = await from(migrations.as('m'))
+            .where(({ m }) => expr.eq(m.id, id))
+            .exists(db);
+        if (alreadyMigrated)
+            continue;
+        spinner ??= ora('running migrations...').start();
+        spinner.text = `running migration ${id}...`;
+        // @TODO run in a transaction
+        await migration(db);
+        await into(migrations)
+            .insert({ id, migratedAt: new Date() })
+            .run(db);
+    }
+    spinner?.stop();
+};

package/dist/esm/index.js

@@ -433,7 +433,6 @@ const is = {
     column: (expr) => u.isPlainObject(expr) && 'type' in expr && 'schema' in expr,
 };
 ;
-;
 // // // // // // // // // // // // // // // // // // // // // // // //
 //                         CREATE STATEMENTS                         //
 // // // // // // // // // // // // // // // // // // // // // // // //
@@ -591,6 +590,16 @@ class QueryBuilder {
         // @TODO calls query engine with the query object
         return db.query(toSelectStatement(this.query));
     }
+    /**
+     * @public  Checks whether any rows exist matching the query.
+     * @since   0.1.6
+     * @version 1
+     */
+    async exists(db) {
+        // @TODO optimize this, maybe do a SELECT 1 or something
+        const results = await db.query(toSelectStatement({ ...this.query, limit: 1, offset: 0 }));
+        return results.length > 0;
+    }
     /**
      * @public  Sets a limit on the number of rows to be returned.
      * @since   0.1.0

package/dist/esm/pretty-logger.js

@@ -7,5 +7,7 @@ import {} from './index';
  * @version 1
  */
 export const createPrettyLogger = () => ({
-    debug: (sql, params) => { process.stdout.write(highlight(sql) + ' ' + inspect(params, false, null, true) + '\n'); },
+    query: {
+        debug: (sql, params) => { process.stdout.write(highlight(sql) + ' ' + inspect(params, false, null, true) + '\n'); },
+    },
 });

package/dist/types/experimental-migration.d.ts

@@ -0,0 +1,14 @@
+import { type IDatabase } from './index';
+/**
+ * @private Defines the type for a migration function.
+ * @since   0.1.6
+ * @version 1
+ */
+type Migration = (db: IDatabase) => Promise<void>;
+/**
+ * @public  Defines and runs migrations against the given database.
+ * @since   0.1.6
+ * @version 1
+ */
+export declare const defineMigrations: (migs: Record<string, Migration>) => (db: IDatabase) => Promise<void>;
+export {};

package/dist/types/index.d.ts

@@ -964,11 +964,19 @@ type DDL = {
  */
 interface ILogger {
     /**
-     * @public  Logs a query that has executed successfully.
+     * @public  Query specific logging methods, so this interface plays
+     *          nice with existing logging libraries (by extending them).
      * @since   0.1.0
      * @version 1
      */
-    debug(sql: string, params: any[]): void;
+    query: {
+        /**
+         * @public  Logs a query that has executed successfully.
+         * @since   0.1.0
+         * @version 1
+         */
+        debug(sql: string, params: any[]): void;
+    };
 }
 /**
  * @public  The interface that all database adapters must implement.
@@ -1133,6 +1141,12 @@ declare class QueryBuilder<T extends Record<string, Aliased<string, Table>>, S e
      * @version 1
      */
     all(db: IDatabase): Promise<Expand<InferSelection<Query<T, S>>>[]>;
+    /**
+     * @public  Checks whether any rows exist matching the query.
+     * @since   0.1.6
+     * @version 1
+     */
+    exists(db: IDatabase): Promise<boolean>;
     /**
      * @public  Sets a limit on the number of rows to be returned.
      * @since   0.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rwillians/qx",
   "description": "A teeny tiny ORM for SQLite.",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "author": "Rafael Willians <me@rwillians.com>",
   "license": "MIT",
   "repository": {
@@ -41,6 +41,12 @@
       "import": "./dist/esm/pretty-logger.js",
       "require": "./dist/cjs/pretty-logger.js",
       "default": "./dist/cjs/pretty-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"
     }
   },
   "scripts": {
@@ -50,6 +56,7 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
+    "ora": "^9.0.0",
     "sql-highlight": "^6.1.0"
   },
   "devDependencies": {