@rwillians/qx 0.1.8 → 0.1.10

package/dist/cjs/bun-sqlite.js

@@ -154,6 +154,18 @@ const render = {
         const { frags, params } = render.expr.any(expr);
         return { frags: [[...frags, dir].join(' ')], params };
     },
+    /**
+     * @private Renders a join clause.
+     * @since   0.1.9
+     * @version 1
+     */
+    join: glue((join) => {
+        const result = render.expr.any(join.on);
+        return {
+            frags: [' ', join.type, ' ', render.ref(join.table), ' AS ', render.ref(join.alias), ' ON ', ...result.frags],
+            params: result.params,
+        };
+    }),
     /**
      * @private Expression rendering functions.
      * @since   0.1.0
@@ -357,6 +369,9 @@ const ddl = {
      * @version 1
      */
     select: (op) => {
+        const joins = op.joins && op.joins.length > 0
+            ? op.joins.reduce(collect(render.join), EMPTY_RENDER_RESULT)
+            : EMPTY_RENDER_RESULT;
         const where = op.where
             ? render.expr.any(op.where)
             : EMPTY_RENDER_RESULT;
@@ -376,6 +391,7 @@ const ddl = {
             render.ref(op.registry[op.from]),
             ' AS ',
             render.ref(op.from),
+            ...joins.frags,
             (where.frags.length > 0 ? ' WHERE ' : ''),
             ...where.frags,
             (orderBy.frags.length > 0 ? ' ORDER BY ' + orderBy.frags.join(', ') : ''),
@@ -383,7 +399,7 @@ const ddl = {
             ...offset.frags,
             ';'
         ];
-        return { sql: frags.join(''), params: [...where.params, ...limit.params, ...offset.params] };
+        return { sql: frags.join(''), params: [...joins.params, ...where.params, ...limit.params, ...offset.params] };
     },
 };
 /**
@@ -473,6 +489,14 @@ class BunSQLite {
         const rows = stmt.all(...params);
         return rows.map(createDecoder(op.select));
     }
+    /**
+     * @public  Executes a function within a transaction.
+     * @since   0.1.10
+     * @version 1
+     */
+    async transaction(fn) {
+        return await this.conn.transaction(fn)();
+    }
 }
 /**
  * @public  Creates a connection to the database.

package/dist/cjs/experimental-migration.js

@@ -2,28 +2,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defineMigrations = void 0;
 const index_1 = require("./index");
-const migrations = (0, index_1.table)('migrations', t => ({
+const migrations = (0, index_1.table)('schema_migrations', t => ({
     id: t.string({ size: 36 }).primaryKey(),
-    migratedAt: t.datetime(),
+    timestamp: t.datetime(),
 }));
 /**
- * @public  Defines and runs migrations against the given database.
+ * @public  Defines a set of migrations to be executed against a
+ *          database.
  * @since   0.1.6
- * @version 1
+ * @version 2
  */
 const defineMigrations = (migs) => async (db) => {
     await index_1.create.table(migrations, { ifNotExists: true }).onto(db);
-    for (const [id, migration] of Object.entries(migs)) {
+    for (const [id, migrate] 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;
-        // @TODO run in a transaction
-        await migration(db);
-        await (0, index_1.into)(migrations)
-            .insert({ id, migratedAt: new Date() })
-            .run(db);
+        await (0, index_1.transaction)(db, async () => {
+            await migrate(db);
+            await (0, index_1.into)(migrations).insert({ id, timestamp: new Date() }).run(db);
+        });
     }
 };
 exports.defineMigrations = defineMigrations;

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.t = exports.is = exports.into = exports.from = exports.expr = exports.table = exports.create = void 0;
+exports.t = exports.transaction = exports.is = exports.into = exports.from = exports.expr = exports.table = exports.create = void 0;
 const std = require("./standard-schema");
 const u = require("./utils");
 // // // // // // // // // // // // // // // // // // // // // // // //
@@ -441,6 +441,16 @@ const is = {
 exports.is = is;
 ;
 // // // // // // // // // // // // // // // // // // // // // // // //
+//                            TRANSACTION                            //
+// // // // // // // // // // // // // // // // // // // // // // // //
+/**
+ * @public  Executes the given function within a transaction.
+ * @since   0.1.10
+ * @version 1
+ */
+const transaction = async (db, fn) => db.transaction(fn);
+exports.transaction = transaction;
+// // // // // // // // // // // // // // // // // // // // // // // //
 //                         CREATE STATEMENTS                         //
 // // // // // // // // // // // // // // // // // // // // // // // //
 /**
@@ -609,6 +619,20 @@ class QueryBuilder {
         const results = await db.query(toSelectStatement({ ...this.query, limit: 1, offset: 0 }));
         return results.length > 0;
     }
+    /**
+     * @public  Adds an INNER JOIN clause to the query.
+     * @since   0.1.9
+     * @version 1
+     */
+    innerJoin(table, on) {
+        const registry = { ...this.query.registry, [table[TABLE_ALIAS]]: table };
+        const join = { type: 'INNER JOIN', table: table[TABLE_NAME], alias: table[TABLE_ALIAS], on: on(registry) };
+        return new QueryBuilder({
+            ...this.query,
+            registry,
+            joins: [...(this.query.joins ?? []), join],
+        });
+    }
     /**
      * @public  Sets a limit on the number of rows to be returned.
      * @since   0.1.0

package/dist/esm/bun-sqlite.js

@@ -151,6 +151,18 @@ const render = {
         const { frags, params } = render.expr.any(expr);
         return { frags: [[...frags, dir].join(' ')], params };
     },
+    /**
+     * @private Renders a join clause.
+     * @since   0.1.9
+     * @version 1
+     */
+    join: glue((join) => {
+        const result = render.expr.any(join.on);
+        return {
+            frags: [' ', join.type, ' ', render.ref(join.table), ' AS ', render.ref(join.alias), ' ON ', ...result.frags],
+            params: result.params,
+        };
+    }),
     /**
      * @private Expression rendering functions.
      * @since   0.1.0
@@ -354,6 +366,9 @@ const ddl = {
      * @version 1
      */
     select: (op) => {
+        const joins = op.joins && op.joins.length > 0
+            ? op.joins.reduce(collect(render.join), EMPTY_RENDER_RESULT)
+            : EMPTY_RENDER_RESULT;
         const where = op.where
             ? render.expr.any(op.where)
             : EMPTY_RENDER_RESULT;
@@ -373,6 +388,7 @@ const ddl = {
             render.ref(op.registry[op.from]),
             ' AS ',
             render.ref(op.from),
+            ...joins.frags,
             (where.frags.length > 0 ? ' WHERE ' : ''),
             ...where.frags,
             (orderBy.frags.length > 0 ? ' ORDER BY ' + orderBy.frags.join(', ') : ''),
@@ -380,7 +396,7 @@ const ddl = {
             ...offset.frags,
             ';'
         ];
-        return { sql: frags.join(''), params: [...where.params, ...limit.params, ...offset.params] };
+        return { sql: frags.join(''), params: [...joins.params, ...where.params, ...limit.params, ...offset.params] };
     },
 };
 /**
@@ -470,6 +486,14 @@ class BunSQLite {
         const rows = stmt.all(...params);
         return rows.map(createDecoder(op.select));
     }
+    /**
+     * @public  Executes a function within a transaction.
+     * @since   0.1.10
+     * @version 1
+     */
+    async transaction(fn) {
+        return await this.conn.transaction(fn)();
+    }
 }
 /**
  * @public  Creates a connection to the database.

package/dist/esm/experimental-migration.js

@@ -1,25 +1,25 @@
-import { create, expr, from, into, table } from './index';
-const migrations = table('migrations', t => ({
+import { create, expr, from, into, table, transaction } from './index';
+const migrations = table('schema_migrations', t => ({
     id: t.string({ size: 36 }).primaryKey(),
-    migratedAt: t.datetime(),
+    timestamp: t.datetime(),
 }));
 /**
- * @public  Defines and runs migrations against the given database.
+ * @public  Defines a set of migrations to be executed against a
+ *          database.
  * @since   0.1.6
- * @version 1
+ * @version 2
  */
 export const defineMigrations = (migs) => async (db) => {
     await create.table(migrations, { ifNotExists: true }).onto(db);
-    for (const [id, migration] of Object.entries(migs)) {
+    for (const [id, migrate] of Object.entries(migs)) {
         const alreadyMigrated = await from(migrations.as('m'))
             .where(({ m }) => expr.eq(m.id, id))
             .exists(db);
         if (alreadyMigrated)
             continue;
-        // @TODO run in a transaction
-        await migration(db);
-        await into(migrations)
-            .insert({ id, migratedAt: new Date() })
-            .run(db);
+        await transaction(db, async () => {
+            await migrate(db);
+            await into(migrations).insert({ id, timestamp: new Date() }).run(db);
+        });
     }
 };

package/dist/esm/index.js

@@ -434,6 +434,15 @@ const is = {
 };
 ;
 // // // // // // // // // // // // // // // // // // // // // // // //
+//                            TRANSACTION                            //
+// // // // // // // // // // // // // // // // // // // // // // // //
+/**
+ * @public  Executes the given function within a transaction.
+ * @since   0.1.10
+ * @version 1
+ */
+const transaction = async (db, fn) => db.transaction(fn);
+// // // // // // // // // // // // // // // // // // // // // // // //
 //                         CREATE STATEMENTS                         //
 // // // // // // // // // // // // // // // // // // // // // // // //
 /**
@@ -600,6 +609,20 @@ class QueryBuilder {
         const results = await db.query(toSelectStatement({ ...this.query, limit: 1, offset: 0 }));
         return results.length > 0;
     }
+    /**
+     * @public  Adds an INNER JOIN clause to the query.
+     * @since   0.1.9
+     * @version 1
+     */
+    innerJoin(table, on) {
+        const registry = { ...this.query.registry, [table[TABLE_ALIAS]]: table };
+        const join = { type: 'INNER JOIN', table: table[TABLE_NAME], alias: table[TABLE_ALIAS], on: on(registry) };
+        return new QueryBuilder({
+            ...this.query,
+            registry,
+            joins: [...(this.query.joins ?? []), join],
+        });
+    }
     /**
      * @public  Sets a limit on the number of rows to be returned.
      * @since   0.1.0
@@ -674,4 +697,4 @@ const from = (table) => new QueryBuilder({
 // // // // // // // // // // // // // // // // // // // // // // // //
 //                              EXPORTS                              //
 // // // // // // // // // // // // // // // // // // // // // // // //
-export { create, defineTable as table, expr, from, into, is, types as t, };
+export { create, defineTable as table, expr, from, into, is, transaction, types as t, };

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

@@ -37,6 +37,12 @@ declare class BunSQLite implements IDatabase {
     query(op: SelectStatement): Promise<{
         [k: string]: any;
     }[]>;
+    /**
+     * @public  Executes a function within a transaction.
+     * @since   0.1.10
+     * @version 1
+     */
+    transaction<T>(fn: () => Promise<T>): Promise<T>;
 }
 /**
  * @public  Creates a connection to the database.

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

@@ -6,9 +6,10 @@ import { type IDatabase } from './index';
  */
 type Migration = (db: IDatabase) => Promise<void>;
 /**
- * @public  Defines and runs migrations against the given database.
+ * @public  Defines a set of migrations to be executed against a
+ *          database.
  * @since   0.1.6
- * @version 1
+ * @version 2
  */
 export declare const defineMigrations: (migs: Record<string, Migration>) => (db: IDatabase) => Promise<void>;
 export {};

package/dist/types/index.d.ts

@@ -871,6 +871,12 @@ type SelectStatement = {
      * @version 1
      */
     registry: Record<string, string>;
+    /**
+     * @public  The query's selection.
+     * @since   0.1.0
+     * @version 1
+     */
+    select: Record<string, Column>;
     /**
      * @public  The alias of the table from which to select.
      * @since   0.1.0
@@ -878,11 +884,11 @@ type SelectStatement = {
      */
     from: string;
     /**
-     * @public  The query's selection.
-     * @since   0.1.0
+     * @public  The query's join clauses.
+     * @since   0.1.9
      * @version 1
      */
-    select: Record<string, Column>;
+    joins?: Join[];
     /**
      * @public  The query's where clause.
      * @since   0.1.0
@@ -1009,7 +1015,19 @@ interface IDatabase {
      * @version 1
      */
     query(op: SelectStatement): Promise<any[]>;
+    /**
+     * @public  Executes a function within a transaction.
+     * @since   0.1.10
+     * @version 1
+     */
+    transaction<T>(fn: () => Promise<T>): Promise<T>;
 }
+/**
+ * @public  Executes the given function within a transaction.
+ * @since   0.1.10
+ * @version 1
+ */
+declare const transaction: <T>(db: IDatabase, fn: () => Promise<T>) => Promise<T>;
 /**
  * @public  Create statement builder.
  * @since   0.1.0
@@ -1062,6 +1080,17 @@ declare class InsertBuilder<T extends Table> {
  * @version 1
  */
 declare const into: <T extends Table>(table: T) => InsertBuilder<T>;
+/**
+ * @public  Represents a join clause in a select statement.
+ * @since   0.1.9
+ * @version 1
+ */
+type Join = {
+    type: 'INNER JOIN' | 'LEFT OUTER JOIN' | 'RIGHT OUTER JOIN';
+    table: string;
+    alias: string;
+    on: Expr;
+};
 /**
  * @private It's the object type for a query being built, that will
  *          later been transformed into a {@link SelectStatement}.
@@ -1075,6 +1104,12 @@ type Query<T extends Record<string, Aliased<string, Table>> = Record<string, Ali
      * @version 1
      */
     registry: T;
+    /**
+     * @private The query's selection.
+     * @since   0.1.0
+     * @version 1
+     */
+    select: S;
     /**
      * @private The alias of the table from which to select.
      * @since   0.1.0
@@ -1082,11 +1117,11 @@ type Query<T extends Record<string, Aliased<string, Table>> = Record<string, Ali
      */
     from: string;
     /**
-     * @private The query's selection.
-     * @since   0.1.0
+     * @private The query's join clauses.
+     * @since   0.1.9
      * @version 1
      */
-    select: S;
+    joins?: Join[];
     /**
      * @private The query's where clause.
      * @since   0.1.0
@@ -1147,6 +1182,14 @@ declare class QueryBuilder<T extends Record<string, Aliased<string, Table>>, S e
      * @version 1
      */
     exists(db: IDatabase): Promise<boolean>;
+    /**
+     * @public  Adds an INNER JOIN clause to the query.
+     * @since   0.1.9
+     * @version 1
+     */
+    innerJoin<U extends Aliased<string, Table>>(table: U, on: (registry: Expand<T & {
+        [K in U[typeof TABLE_ALIAS]]: U;
+    }>) => Expr): QueryBuilder<Expand<T & { [K in U[typeof TABLE_ALIAS]]: U; }>, S>;
     /**
      * @public  Sets a limit on the number of rows to be returned.
      * @since   0.1.0
@@ -1193,4 +1236,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 InsertStatement, type OrderDirection, type Primitive, type PrimitiveToNativeTypeFactory, type SelectStatement, type Table, create, defineTable as table, expr, from, into, is, 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, create, defineTable as table, expr, from, into, is, transaction, types as t, };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rwillians/qx",
   "description": "A teeny tiny ORM for SQLite.",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "author": "Rafael Willians <me@rwillians.com>",
   "license": "MIT",
   "repository": {