@primate/mysql 0.1.2 → 0.2.0

package/lib/private/ColumnTypes.d.ts

@@ -0,0 +1,25 @@
+import type TypedArray from "@rcompat/type/TypedArray";
+type Param = bigint | boolean | Date | null | number | string | TypedArray;
+type Validate<T extends {
+    [K in keyof T]: Param;
+}> = T;
+type ColumnTypes = Validate<{
+    BIGINT: string;
+    "BIGINT UNSIGNED": string;
+    BLOB: Uint8Array<ArrayBuffer>;
+    BOOL: number;
+    "DATETIME(3)": Date;
+    "DECIMAL(39, 0)": string;
+    DOUBLE: number;
+    INT: number;
+    "INT NOT NULL AUTO_INCREMENT PRIMARY KEY": number;
+    "INT UNSIGNED": number;
+    SMALLINT: number;
+    "SMALLINT UNSIGNED": number;
+    TEXT: string;
+    "TIME": string;
+    TINYINT: number;
+    "TINYINT UNSIGNED": number;
+}>;
+export type { ColumnTypes as default };
+//# sourceMappingURL=ColumnTypes.d.ts.map

package/lib/private/ColumnTypes.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ColumnTypes.js.map

package/lib/private/Database.d.ts

@@ -0,0 +1,47 @@
+import Database from "@primate/core/Database";
+import type As from "@primate/core/database/As";
+import type DataDict from "@primate/core/database/DataDict";
+import type TypeMap from "@primate/core/database/TypeMap";
+import type Dict from "@rcompat/type/Dict";
+import type StoreSchema from "pema/StoreSchema";
+declare const schema: import("pema").ObjectType<{
+    database: import("pema/string").StringType;
+    host: import("pema").DefaultType<import("pema/string").StringType, "localhost">;
+    password: import("pema").OptionalType<import("pema/string").StringType>;
+    port: import("pema").DefaultType<import("pema/uint").UintType<"u32">, 3306>;
+    username: import("pema").OptionalType<import("pema/string").StringType>;
+}>;
+export default class MySQLDatabase extends Database {
+    #private;
+    static config: typeof schema.input;
+    constructor(config?: typeof schema.input);
+    get typemap(): TypeMap<Dict>;
+    formatBinds(binds: Dict): Dict;
+    close(): Promise<void>;
+    get schema(): {
+        create: (name: string, store: StoreSchema) => Promise<void>;
+        delete: (name: string) => Promise<void>;
+    };
+    create<O extends Dict>(as: As, args: {
+        record: DataDict;
+    }): Promise<O>;
+    read(as: As, args: {
+        count: true;
+        criteria: DataDict;
+    }): Promise<number>;
+    read(as: As, args: {
+        criteria: DataDict;
+        fields?: string[];
+        limit?: number;
+        sort?: Dict<"asc" | "desc">;
+    }): Promise<Dict[]>;
+    update(as: As, args: {
+        changes: DataDict;
+        criteria: DataDict;
+    }): Promise<number>;
+    delete(as: As, args: {
+        criteria: DataDict;
+    }): Promise<number>;
+}
+export {};
+//# sourceMappingURL=Database.d.ts.map

package/lib/private/Database.js

@@ -0,0 +1,148 @@
+import typemap from "#typemap";
+import Database from "@primate/core/Database";
+import assert from "@rcompat/assert";
+import mysql from "mysql2/promise";
+import pema from "pema";
+import string from "pema/string";
+import uint from "pema/uint";
+const schema = pema({
+    database: string,
+    host: string.default("localhost"),
+    password: string.optional(),
+    port: uint.port().default(3306),
+    username: string.optional(),
+});
+export default class MySQLDatabase extends Database {
+    #factory;
+    #client;
+    static config;
+    constructor(config) {
+        super(":");
+        const parsed = schema.parse(config);
+        this.#factory = () => mysql.createPool({
+            host: parsed.host,
+            port: parsed.port,
+            database: parsed.database,
+            user: parsed.username,
+            password: parsed.password,
+            connectionLimit: 10,
+            queueLimit: 0,
+            keepAliveInitialDelay: 0,
+            enableKeepAlive: true,
+            waitForConnections: true,
+            namedPlaceholders: true,
+            bigNumberStrings: true,
+            supportBigNumbers: true,
+        });
+    }
+    get typemap() {
+        return typemap;
+    }
+    #get() {
+        if (this.#client === undefined) {
+            this.#client = this.#factory();
+        }
+        return this.#client;
+    }
+    formatBinds(binds) {
+        return Object.fromEntries(Object.entries(binds).map(([k, v]) => [k.replace(/^[:$]/, ""), v]));
+    }
+    async close() {
+        await this.#get().end();
+    }
+    async #with(executor) {
+        const connection = await this.#get().getConnection();
+        try {
+            return await executor(connection);
+        }
+        finally {
+            connection.release();
+        }
+    }
+    async #new(name, store) {
+        const body = Object.entries(store)
+            .map(([key, value]) => `${this.ident(key)} ${this.column(value.datatype)}`)
+            .join(",");
+        const query = `CREATE TABLE IF NOT EXISTS ${this.ident(name)} (${body})`;
+        await this.#with(async (connection) => {
+            await connection.query(query);
+        });
+    }
+    async #drop(name) {
+        const query = `DROP TABLE IF EXISTS ${this.ident(name)}`;
+        await this.#with(async (connection) => {
+            await connection.query(query);
+        });
+    }
+    get schema() {
+        return {
+            create: this.#new.bind(this),
+            delete: this.#drop.bind(this),
+        };
+    }
+    async create(as, args) {
+        const keys = Object.keys(args.record);
+        const columns = keys.map(k => this.ident(k));
+        const values = keys.map(key => `:${key}`).join(",");
+        const payload = `(${columns.join(",")}) VALUES (${values})`;
+        const query = `INSERT INTO ${this.table(as)} ${payload};`;
+        const binds = await this.bind(as.types, args.record);
+        return this.#with(async (connection) => {
+            const [{ insertId }] = await connection.query(query, binds);
+            return this.unbind(as.types, { ...args.record, id: insertId });
+        });
+    }
+    async read(as, args) {
+        const where = this.toWhere(as.types, args.criteria);
+        const binds = await this.bindCriteria(as.types, args.criteria);
+        if (args.count === true) {
+            return this.#with(async (connection) => {
+                const query = `SELECT COUNT(*) AS n FROM ${this.table(as)} ${where}`;
+                const [[{ n }]] = await connection.query(query, binds);
+                return Number(n);
+            });
+        }
+        const select = this.toSelect(as.types, args.fields);
+        const sort = this.toSort(as.types, args.sort);
+        const limit = this.toLimit(args.limit);
+        const query = `SELECT ${select}
+      FROM ${this.table(as)} ${where}${sort}${limit};`;
+        return this.#with(async (connection) => {
+            const [records] = await connection.query(query, binds);
+            return records.map(record => this.unbind(as.types, record));
+        });
+    }
+    async update(as, args) {
+        assert(Object.keys(args.criteria).length > 0, "update: no criteria");
+        const where = this.toWhere(as.types, args.criteria);
+        const criteria = await this.bindCriteria(as.types, args.criteria);
+        const { set, binds: set_binds } = await this.toSet(as.types, args.changes);
+        const binds = { ...criteria, ...set_binds };
+        const query = `
+      UPDATE ${this.table(as)}
+      ${set}
+      WHERE id IN (
+        SELECT id FROM (
+          SELECT id FROM ${this.table(as)}
+          ${where}
+        ) AS to_update
+      );
+    `;
+        return this.#with(async (connection) => {
+            const [{ affectedRows }] = await connection.query(query, binds);
+            return affectedRows;
+        });
+    }
+    async delete(as, args) {
+        assert(Object.keys(args.criteria).length > 0, "delete: no criteria");
+        const where = this.toWhere(as.types, args.criteria);
+        const binds = await this.bindCriteria(as.types, args.criteria);
+        const query = `DELETE FROM ${this.table(as)} ${where}`;
+        return this.#with(async (connection) => {
+            const [{ affectedRows }] = await connection.query(query, binds);
+            return affectedRows;
+        });
+    }
+    ;
+}
+//# sourceMappingURL=Database.js.map

package/lib/private/typemap.d.ts

@@ -0,0 +1,5 @@
+import type ColumnTypes from "#ColumnTypes";
+import type TypeMap from "@primate/core/database/TypeMap";
+declare const typemap: TypeMap<ColumnTypes>;
+export default typemap;
+//# sourceMappingURL=typemap.d.ts.map

package/lib/private/typemap.js

@@ -0,0 +1,106 @@
+import numeric from "@rcompat/is/numeric";
+function identity(column) {
+    return {
+        bind: value => value,
+        column,
+        unbind: value => value,
+    };
+}
+function number(column) {
+    return {
+        bind: (value) => value,
+        column,
+        unbind: (value) => Number(value),
+    };
+}
+const typemap = {
+    blob: {
+        async bind(value) {
+            const arrayBuffer = await value.arrayBuffer();
+            return new Uint8Array(arrayBuffer);
+        },
+        column: "BLOB",
+        unbind(value) {
+            return new Blob([value], { type: "application/octet-stream" });
+        },
+    },
+    boolean: {
+        bind(value) {
+            return value === true ? 1 : 0;
+        },
+        column: "BOOL",
+        unbind(value) {
+            return Number(value) === 1;
+        },
+    },
+    datetime: identity("DATETIME(3)"),
+    f32: identity("DOUBLE"),
+    f64: identity("DOUBLE"),
+    i128: {
+        bind(value) {
+            return String(value);
+        },
+        column: "DECIMAL(39, 0)",
+        unbind(value) {
+            return BigInt(value);
+        },
+    },
+    i16: number("SMALLINT"),
+    i32: number("INT"),
+    i64: {
+        bind(value) {
+            return String(value);
+        },
+        column: "BIGINT",
+        unbind(value) {
+            return BigInt(value);
+        },
+    },
+    i8: number("TINYINT"),
+    primary: {
+        bind(value) {
+            if (numeric(value)) {
+                return Number(value);
+            }
+            throw new Error(`\`${value}\` is not a valid primary key value`);
+        },
+        column: "INT NOT NULL AUTO_INCREMENT PRIMARY KEY",
+        unbind(value) {
+            return String(value);
+        },
+    },
+    string: identity("TEXT"),
+    time: identity("TEXT"),
+    u128: {
+        bind(value) {
+            return String(value);
+        },
+        column: "DECIMAL(39, 0)",
+        unbind(value) {
+            return BigInt(value);
+        },
+    },
+    u16: number("SMALLINT UNSIGNED"),
+    u32: number("INT UNSIGNED"),
+    u64: {
+        bind(value) {
+            return String(value);
+        },
+        column: "BIGINT UNSIGNED",
+        unbind(value) {
+            return BigInt(value);
+        },
+    },
+    u8: number("TINYINT UNSIGNED"),
+    url: {
+        bind(value) {
+            return value.toString();
+        },
+        column: "TEXT",
+        unbind(value) {
+            return new URL(value);
+        },
+    },
+};
+export default typemap;
+//# sourceMappingURL=typemap.js.map

package/lib/public/index.d.ts

@@ -0,0 +1,4 @@
+import Database from "#Database";
+declare const _default: (config: typeof Database.config) => Database;
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/public/index.js

@@ -0,0 +1,3 @@
+import Database from "#Database";
+export default (config) => new Database(config);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,34 +1,45 @@
 {
   "name": "@primate/mysql",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Primate MySQL database",
-  "homepage": "https://primatejs.com/modules/mysql",
-  "bugs": "https://github.com/primatejs/primate/issues",
+  "homepage": "https://primate.run/docs/database/mysql",
+  "bugs": "https://github.com/primate-run/primate/issues",
   "license": "MIT",
   "files": [
-    "src/**/*.js",
-    "!src/**/*.spec.js"
+    "/lib/**/*.js",
+    "/lib/**/*.d.ts",
+    "!/**/*.spec.*"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/primatejs/primate",
+    "url": "https://github.com/primate-run/primate",
     "directory": "packages/mysql"
   },
   "dependencies": {
-    "@rcompat/invariant": "^0.5.0",
-    "@rcompat/object": "^0.5.0",
-    "mysql2": "^3.11.0",
-    "@primate/core": "^0.1.4",
-    "@primate/store": "^0.25.1"
+    "@rcompat/assert": "^0.3.1",
+    "@rcompat/is": "^0.1.4",
+    "@rcompat/record": "^0.9.1",
+    "mysql2": "^3.15.1",
+    "pema": "",
+    "@primate/core": "^0.2.0"
   },
   "type": "module",
   "imports": {
     "#*": {
-      "@primate/lt": "./src/private/*.js",
-      "default": "./src/private/*.js"
+      "apekit": "./src/private/*.ts",
+      "default": "./lib/private/*.js"
     }
   },
   "exports": {
-    ".": "./src/default.js"
+    ".": {
+      "apekit": "./src/public/index.ts",
+      "default": "./lib/public/index.js"
+    }
+  },
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "clean": "rm -rf ./lib",
+    "lint": "eslint .",
+    "test": "npm run build && npx proby"
   }
 }

package/src/default.js

@@ -1,12 +0,0 @@
-import defaults from "#defaults";
-import serve from "#serve";
-
-export default ({
-  host = defaults.host,
-  port = defaults.port,
-  database,
-  username,
-  password,
-} = {}) => ({
-  serve: serve({ host, port, database, username, password }),
-});

package/src/private/Facade.js

@@ -1,105 +0,0 @@
-import typemap from "#typemap";
-import make_sort from "@primate/store/sql/make-sort";
-import filter from "@rcompat/object/filter";
-import keymap from "@rcompat/object/keymap";
-import valmap from "@rcompat/object/valmap";
-
-const filter_null = object => filter(object, ([, value]) => value !== null);
-const filter_nulls = objects => objects.map(object => filter_null(object));
-
-const predicate = criteria => {
-  const keys = Object.keys(criteria);
-  if (keys.length === 0) {
-    return { where: "", bindings: {} };
-  }
-
-  const where = `where ${keys.map(key => `\`${key}\`=:${key}`).join(" and ")}`;
-
-  return { where, bindings: criteria };
-};
-
-const change = delta => {
-  const keys = Object.keys(delta);
-  const set = keys.map(field => `\`${field}\`=:s_${field}`).join(",");
-  return {
-    set: `set ${set}`,
-    bindings: keymap(delta, key => `s_${key}`),
-  };
-};
-
-export default class Connection {
-  schema = {
-    create: async (name, description) => {
-      const { connection } = this;
-      const body =
-        Object.entries(valmap(description, value => typemap(value.base)))
-          .map(([column, dataType]) => `\`${column}\` ${dataType}`).join(",");
-      const query = `create table if not exists ${name} (${body})`;
-      await connection.query(query);
-    },
-    delete: async name => {
-      const query = `drop table if exists ${name}`;
-      await this.connection.query(query);
-    },
-  };
-
-  constructor(connection) {
-    this.connection = connection;
-  }
-
-  async find(collection, criteria = {}, projection = [], options = {}) {
-    const { where, bindings } = predicate(criteria);
-    const select = projection.length === 0 ? "*" : projection.join(", ");
-    const rest = make_sort(options);
-    const query = `select ${select} from ${collection} ${where} ${rest}`;
-    const [result] = await this.connection.query(query, bindings);
-
-    return filter_nulls(result);
-  }
-
-  async count(collection, criteria = {}) {
-    const { where, bindings } = predicate(criteria);
-    const query = `select count(*) as count from ${collection} ${where}`;
-    const [[{ count }]] = await this.connection.query(query, bindings);
-    return count;
-  }
-
-  async get(collection, primary, value) {
-    const query = `select * from ${collection} where ${primary}=:primary`;
-    const [[result]] = await this.connection.query(query, { primary: value });
-
-    return result === undefined
-      ? result
-      : filter(result, ([, $value]) => $value !== null);
-  }
-
-  async insert(collection, primary, document) {
-    const keys = Object.keys(document);
-    const columns = keys.map(key => `\`${key}\``);
-    const values = keys.map(key => `:${key}`).join(",");
-    const $predicate = `(${columns.join(",")}) values (${values})`;
-    const query = `insert into ${collection} ${$predicate}`;
-    const [{ insertId: id }] = await this.connection.query(query, document);
-
-    return { ...document, id };
-  }
-
-  async update(collection, criteria = {}, delta = {}) {
-    const { where, bindings } = predicate(criteria);
-    const { set, bindings: bindings2 } = change(delta);
-    const query = `update ${collection} ${set} ${where}`;
-    const params = { ... bindings, ...bindings2 };
-    const [{ affectedRows }] = await this.connection.query(query, params);
-
-    return affectedRows;
-  }
-
-  async delete(collection, criteria = {}) {
-    const { where, bindings } = predicate(criteria);
-    const query = `delete from ${collection} ${where}`;
-
-    const [{ affectedRows }] = await this.connection.query(query, bindings);
-
-    return affectedRows;
-  }
-}

package/src/private/connect.js

@@ -1,16 +0,0 @@
-import mysql from "mysql2/promise";
-
-export default ({ host, port, database, username, password }) =>
-  mysql.createPool({
-    host,
-    port,
-    database,
-    user: username,
-    password,
-    waitForConnections: true,
-    connectionLimit: 10,
-    queueLimit: 0,
-    enableKeepAlive: true,
-    keepAliveInitialDelay: 0,
-    namedPlaceholders: true,
-  });

package/src/private/defaults.js

@@ -1,4 +0,0 @@
-export default {
-  host: "localhost",
-  port: 3306,
-};

package/src/private/serve.js

@@ -1,81 +0,0 @@
-import Facade from "#Facade";
-import connect from "#connect";
-import ident from "@primate/store/core/ident";
-import wrap from "@primate/store/core/wrap";
-import numeric from "@rcompat/invariant/numeric";
-
-export default options => async () => {
-  const client = await connect(options);
-
-  const types = {
-    primary: {
-      validate(value) {
-        if (typeof value === "number" || numeric(value)) {
-          return Number(value);
-        }
-        throw new Error(`\`${value}\` is not a valid primary key value`);
-      },
-      ...ident,
-    },
-    object: {
-      in(value) {
-        return JSON.stringify(value);
-      },
-      out(value) {
-        return JSON.parse(value);
-      },
-    },
-    number: ident,
-    bigint: {
-      in(value) {
-        return value.toString();
-      },
-      out(value) {
-        return BigInt(value);
-      },
-    },
-    boolean: {
-      in(value) {
-        return value === true ? 1 : 0;
-      },
-      out(value) {
-        return Number(value) === 1;
-      },
-    },
-    date: {
-      in(value) {
-        return value;
-      },
-      out(value) {
-        return new Date(value);
-      },
-    },
-    string: ident,
-  };
-
-  return {
-    name: "@primate/mysql",
-    types,
-    async transact(stores) {
-      return async (others, next) => {
-        const connection = await client.getConnection();
-        const facade = new Facade(connection);
-        try {
-          await connection.query("start transaction");
-          const response = await next([...others, ...stores.map(([_, store]) =>
-            [_, wrap(store, facade, types)]),
-          ]);
-          await connection.query("commit");
-          return response;
-        } catch (error) {
-          await connection.query("rollback");
-          // bubble up
-          throw error;
-        } finally {
-          // noop, no end transaction
-          client.releaseConnection(connection);
-        }
-      };
-    },
-  };
-};

package/src/private/typemap.js

@@ -1,24 +0,0 @@
-const types = {
-  /* array */
-  blob: "blob",
-  boolean: "bool",
-  datetime: "datetime",
-  embedded: "text",
-  f64: "double",
-  i8: "tinyint",
-  i16: "smallint",
-  i32: "int",
-  i64: "bigint",
-  i128: "decimal",
-  json: "json",
-  primary: "int not null auto_increment primary key",
-  string: "text",
-  time: "time",
-  u8: "tinyint",
-  u16: "smallint",
-  u32: "int",
-  u64: "bigint",
-  u128: "decimal",
-};
-
-export default value => types[value];