@rwillians/qx 0.1.4 → 0.1.6

package/dist/cjs/experimental-migration.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defineMigrations = void 0;
+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) => {
+    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;
+        console.log(`running migration ${id}...`);
+        await migration(db);
+        console.log('done');
+        await (0, index_1.into)(migrations)
+            .insert({ id, migratedAt: new Date() })
+            .run(db);
+    }
+};
+exports.defineMigrations = defineMigrations;

package/dist/cjs/index.js

@@ -69,6 +69,14 @@ class ColumnPropsBuilder {
             throw new Error('Cannot make a nullable column a primary key');
         return new ColumnPropsBuilder({ ...this.props, primaryKey: true });
     }
+    /**
+     * @public  Marks the column as unique.
+     * @since   0.1.0
+     * @version 1
+     */
+    unique() {
+        return new ColumnPropsBuilder({ ...this.props, unique: true });
+    }
 }
 /**
  * @public  A way to define a column with a custom standard schema.
@@ -592,6 +600,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/experimental-migration.js

@@ -0,0 +1,26 @@
+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) => {
+    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;
+        console.log(`running migration ${id}...`);
+        await migration(db);
+        console.log('done');
+        await into(migrations)
+            .insert({ id, migratedAt: new Date() })
+            .run(db);
+    }
+};

package/dist/esm/index.js

@@ -66,6 +66,14 @@ class ColumnPropsBuilder {
             throw new Error('Cannot make a nullable column a primary key');
         return new ColumnPropsBuilder({ ...this.props, primaryKey: true });
     }
+    /**
+     * @public  Marks the column as unique.
+     * @since   0.1.0
+     * @version 1
+     */
+    unique() {
+        return new ColumnPropsBuilder({ ...this.props, unique: true });
+    }
 }
 /**
  * @public  A way to define a column with a custom standard schema.
@@ -583,6 +591,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/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

@@ -299,6 +299,14 @@ declare class ColumnPropsBuilder<T extends ColumnProps = ColumnProps> {
     primaryKey(): ColumnPropsBuilder<Expand<T & {
         primaryKey: true;
     }>>;
+    /**
+     * @public  Marks the column as unique.
+     * @since   0.1.0
+     * @version 1
+     */
+    unique(): ColumnPropsBuilder<Expand<T & {
+        unique: true;
+    }>>;
 }
 /**
  * @public  Built-in column types.
@@ -1125,6 +1133,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.4",
+  "version": "0.1.6",
   "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": {