cl-orm 1.0.0 → 2.1.0

package/README.md

@@ -1,10 +1,16 @@
+[npm-image]: https://img.shields.io/npm/v/cl-orm.svg
+[npm-url]: https://npmjs.org/package/cl-orm
+[downloads-image]: https://img.shields.io/npm/dt/cl-orm.svg
+[downloads-url]: https://npmjs.org/package/cl-orm
+
 # CL ORM
 
 <img align="right" width="64" height="64" alt="Logo" src="website/static/img/favicon.svg">
 
-A lightweight **ORM** for **Cloudflare Workers** (**D1** and **Durable Objects**), designed to be intuitive, productive and focused on essential functionality.
+⛅️ A lightweight **ORM** for **Cloudflare Workers** (**D1** and **Durable Objects**), designed to be intuitive and productive, focused on essential functionality.
 
-- This project supports **Cloudflare D1** and **Durable Objects SQL Storage** as database drivers.
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
 
 ---
 
@@ -14,10 +20,10 @@ A lightweight **ORM** for **Cloudflare Workers** (**D1** and **Durable Objects**
 
 ## Why
 
-- Supports both **Cloudflare D1** and **Durable Objects** SQL Storage.
+- Supports both **Cloudflare D1** and **Durable Objects SQL Storage**.
 - Unified **Connection** interface across different database drivers.
-- An user-friendly ORM for **INSERT**, **SELECT**, **UPDATE**, **DELETE** and **WHERE** clauses.
-- Automatic **Prepared Statements** (including **LIMIT** and **OFFSET**).
+- User-friendly **ORM** for **INSERT**, **SELECT**, **UPDATE**, **DELETE** and **WHERE** clauses.
+- Automatic **Prepared Statements**.
 
 ---
 
@@ -82,7 +88,7 @@ import { OP } from 'cl-orm';
 
 export const getUser = async (db: Connection, id: number) => {
   const user = await db.select({
-    table: 'users',
+    from: 'users',
     where: OP.eq('id', id),
     limit: 1,
   });

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 export { useD1 } from './drivers/d1.js';
 export { useDO } from './drivers/do.js';
 export { OP } from './queries/where/operators.js';
-export type { QueryResult, Connection, Meta, Condition, Param, WhereClause, WhereItem, } from './types.js';
+export { backtick as bt } from './queries/_utils.js';
+export type { QueryResult, Connection, Meta, Condition, Param, WhereClause, WhereItem, WhereShorthand, } from './types.js';

package/lib/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OP = exports.useDO = exports.useD1 = void 0;
+exports.bt = exports.OP = exports.useDO = exports.useD1 = void 0;
 var d1_js_1 = require("./drivers/d1.js");
 Object.defineProperty(exports, "useD1", { enumerable: true, get: function () { return d1_js_1.useD1; } });
 var do_js_1 = require("./drivers/do.js");
 Object.defineProperty(exports, "useDO", { enumerable: true, get: function () { return do_js_1.useDO; } });
 var operators_js_1 = require("./queries/where/operators.js");
 Object.defineProperty(exports, "OP", { enumerable: true, get: function () { return operators_js_1.OP; } });
+var _utils_js_1 = require("./queries/_utils.js");
+Object.defineProperty(exports, "bt", { enumerable: true, get: function () { return _utils_js_1.backtick; } });

package/lib/queries/_utils.d.ts

@@ -1 +1 @@
-export declare const quoteIdentifier: (name: string) => string;
+export declare const backtick: (name: string) => string;

package/lib/queries/_utils.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.quoteIdentifier = void 0;
-const quoteIdentifier = (name) => {
-    if (name.includes('.')) {
+exports.backtick = void 0;
+const backtick = (name) => {
+    if (name.includes('`'))
+        return name;
+    if (name.includes('.'))
         return name
             .split('.')
             .map((part) => `\`${part}\``)
             .join('.');
-    }
     return `\`${name}\``;
 };
-exports.quoteIdentifier = quoteIdentifier;
+exports.backtick = backtick;

package/lib/queries/delete.js

@@ -4,7 +4,7 @@ exports.buildDelete = void 0;
 const _utils_js_1 = require("./_utils.js");
 const where_js_1 = require("./where/where.js");
 const buildDelete = (options) => {
-    const parts = ['DELETE FROM', (0, _utils_js_1.quoteIdentifier)(options.table)];
+    const parts = ['DELETE FROM', (0, _utils_js_1.backtick)(options.from)];
     const params = [];
     if (options.where) {
         const where = (0, where_js_1.buildWhere)(options.where);

package/lib/queries/insert.js

@@ -7,12 +7,12 @@ const buildInsert = (options) => {
         ? options.values
         : [options.values];
     const columns = Object.keys(rows[0]);
-    const columnsSql = columns.map(_utils_js_1.quoteIdentifier).join(', ');
+    const columnsSql = columns.map(_utils_js_1.backtick).join(', ');
     const placeholders = `(${columns.map(() => '?').join(', ')})`;
     const valuesSql = rows.map(() => placeholders).join(', ');
     const params = rows.flatMap((row) => columns.map((col) => row[col]));
     return {
-        sql: `INSERT INTO ${(0, _utils_js_1.quoteIdentifier)(options.table)} (${columnsSql}) VALUES ${valuesSql}`,
+        sql: `INSERT INTO ${(0, _utils_js_1.backtick)(options.into)} (${columnsSql}) VALUES ${valuesSql}`,
         params,
     };
 };

package/lib/queries/select.js

@@ -8,13 +8,13 @@ const buildColumns = (columns) => {
         return '*';
     if (typeof columns === 'string')
         return columns;
-    return columns.map(_utils_js_1.quoteIdentifier).join(', ');
+    return columns.map(_utils_js_1.backtick).join(', ');
 };
 const buildJoin = (join) => {
     const type = join.outer
         ? `${join.type.toUpperCase()} OUTER`
         : join.type.toUpperCase();
-    return `${type} JOIN ${(0, _utils_js_1.quoteIdentifier)(join.table)} ON ${(0, _utils_js_1.quoteIdentifier)(join.on.a)} = ${(0, _utils_js_1.quoteIdentifier)(join.on.b)}`;
+    return `${type} JOIN ${(0, _utils_js_1.backtick)(join.table)} ON ${(0, _utils_js_1.backtick)(join.on.a)} = ${(0, _utils_js_1.backtick)(join.on.b)}`;
 };
 const buildSelect = (options) => {
     const parts = ['SELECT'];
@@ -22,7 +22,7 @@ const buildSelect = (options) => {
     if (options.distinct)
         parts.push('DISTINCT');
     parts.push(buildColumns(options.columns));
-    parts.push('FROM', (0, _utils_js_1.quoteIdentifier)(options.table));
+    parts.push('FROM', (0, _utils_js_1.backtick)(options.from));
     if (options.join) {
         const joins = Array.isArray(options.join) ? options.join : [options.join];
         for (const join of joins) {
@@ -35,10 +35,10 @@ const buildSelect = (options) => {
         params.push(...where.params);
     }
     if (options.groupBy)
-        parts.push('GROUP BY', (0, _utils_js_1.quoteIdentifier)(options.groupBy));
+        parts.push('GROUP BY', (0, _utils_js_1.backtick)(options.groupBy));
     if (options.orderBy) {
         const [column, direction = 'ASC'] = options.orderBy;
-        parts.push('ORDER BY', (0, _utils_js_1.quoteIdentifier)(column), direction);
+        parts.push('ORDER BY', (0, _utils_js_1.backtick)(column), direction);
     }
     if (options.limit !== undefined) {
         parts.push('LIMIT ?');

package/lib/queries/update.js

@@ -5,14 +5,9 @@ const _utils_js_1 = require("./_utils.js");
 const where_js_1 = require("./where/where.js");
 const buildUpdate = (options) => {
     const columns = Object.keys(options.set);
-    const setSql = columns.map((col) => `${(0, _utils_js_1.quoteIdentifier)(col)} = ?`).join(', ');
+    const setSql = columns.map((col) => `${(0, _utils_js_1.backtick)(col)} = ?`).join(', ');
     const params = columns.map((col) => options.set[col]);
-    const parts = [
-        'UPDATE',
-        (0, _utils_js_1.quoteIdentifier)(options.table),
-        'SET',
-        setSql,
-    ];
+    const parts = ['UPDATE', (0, _utils_js_1.backtick)(options.table), 'SET', setSql];
     if (options.where) {
         const where = (0, where_js_1.buildWhere)(options.where);
         parts.push('WHERE', where.sql);

package/lib/queries/where/operators.d.ts

@@ -20,4 +20,7 @@ export declare const OP: {
     };
     between: (column: string, params: [Param, Param]) => Condition;
     notBetween: (column: string, params: [Param, Param]) => Condition;
+    AND: (...conditions: Condition[]) => Condition;
+    OR: (...conditions: Condition[]) => Condition;
+    XOR: (...conditions: Condition[]) => Condition;
 };

package/lib/queries/where/operators.js

@@ -2,8 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OP = void 0;
 const _utils_js_1 = require("../_utils.js");
+const logical = (connector, conditions) => ({
+    condition: `(${conditions.map((c) => c.condition).join(` ${connector} `)})`,
+    params: conditions.flatMap((c) => c.params),
+});
 const comparison = (column, operator, param) => ({
-    condition: `${(0, _utils_js_1.quoteIdentifier)(column)} ${operator} ?`,
+    condition: `${(0, _utils_js_1.backtick)(column)} ${operator} ?`,
     params: [param],
 });
 exports.OP = {
@@ -16,45 +20,48 @@ exports.OP = {
     like: (column, param) => comparison(column, 'LIKE', param),
     notLike: (column, param) => comparison(column, 'NOT LIKE', param),
     isNull: (column) => ({
-        condition: `${(0, _utils_js_1.quoteIdentifier)(column)} IS NULL`,
+        condition: `${(0, _utils_js_1.backtick)(column)} IS NULL`,
         params: [],
     }),
     isNotNull: (column) => ({
-        condition: `${(0, _utils_js_1.quoteIdentifier)(column)} IS NOT NULL`,
+        condition: `${(0, _utils_js_1.backtick)(column)} IS NOT NULL`,
         params: [],
     }),
     in: ((column, valuesOrSubquery, subqueryParams) => {
         if (typeof valuesOrSubquery === 'string') {
             return {
-                condition: `${(0, _utils_js_1.quoteIdentifier)(column)} IN (${valuesOrSubquery})`,
+                condition: `${(0, _utils_js_1.backtick)(column)} IN (${valuesOrSubquery})`,
                 params: subqueryParams ?? [],
             };
         }
         const placeholders = valuesOrSubquery.map(() => '?').join(', ');
         return {
-            condition: `${(0, _utils_js_1.quoteIdentifier)(column)} IN (${placeholders})`,
+            condition: `${(0, _utils_js_1.backtick)(column)} IN (${placeholders})`,
             params: valuesOrSubquery,
         };
     }),
     notIn: ((column, valuesOrSubquery, subqueryParams) => {
         if (typeof valuesOrSubquery === 'string') {
             return {
-                condition: `${(0, _utils_js_1.quoteIdentifier)(column)} NOT IN (${valuesOrSubquery})`,
+                condition: `${(0, _utils_js_1.backtick)(column)} NOT IN (${valuesOrSubquery})`,
                 params: subqueryParams ?? [],
             };
         }
         const placeholders = valuesOrSubquery.map(() => '?').join(', ');
         return {
-            condition: `${(0, _utils_js_1.quoteIdentifier)(column)} NOT IN (${placeholders})`,
+            condition: `${(0, _utils_js_1.backtick)(column)} NOT IN (${placeholders})`,
             params: valuesOrSubquery,
         };
     }),
     between: (column, params) => ({
-        condition: `${(0, _utils_js_1.quoteIdentifier)(column)} BETWEEN ? AND ?`,
+        condition: `${(0, _utils_js_1.backtick)(column)} BETWEEN ? AND ?`,
         params,
     }),
     notBetween: (column, params) => ({
-        condition: `${(0, _utils_js_1.quoteIdentifier)(column)} NOT BETWEEN ? AND ?`,
+        condition: `${(0, _utils_js_1.backtick)(column)} NOT BETWEEN ? AND ?`,
         params,
     }),
+    AND: (...conditions) => logical('AND', conditions),
+    OR: (...conditions) => logical('OR', conditions),
+    XOR: (...conditions) => logical('XOR', conditions),
 };

package/lib/queries/where/where.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildWhere = void 0;
+const _utils_js_1 = require("../_utils.js");
 const isConnector = (value) => typeof value === 'string' && ['AND', 'OR', 'XOR', 'NOT'].includes(value);
 const isCondition = (value) => typeof value === 'object' && !Array.isArray(value) && 'condition' in value;
+const isShorthand = (value) => typeof value === 'object' && !Array.isArray(value) && !('condition' in value);
+const fromShorthand = (shorthand) => {
+    const entries = Object.entries(shorthand);
+    const sql = entries.map(([key]) => `${(0, _utils_js_1.backtick)(key)} = ?`).join(' AND ');
+    const params = entries.map(([, value]) => value);
+    return { sql, params };
+};
 const processItems = (items) => {
     const parts = [];
     const params = [];
@@ -27,6 +35,8 @@ const processItems = (items) => {
 const buildWhere = (where) => {
     if (typeof where === 'string')
         return { sql: where, params: [] };
+    if (isShorthand(where))
+        return fromShorthand(where);
     if (isCondition(where))
         return { sql: where.condition, params: [...where.params] };
     return processItems(where);

package/lib/types.d.ts

@@ -5,10 +5,11 @@ export type Condition = {
 };
 export type Connector = 'AND' | 'OR' | 'XOR' | 'NOT';
 export type WhereItem = Condition | Connector | WhereItem[];
-export type WhereClause = string | Condition | WhereItem[];
+export type WhereShorthand = Record<string, Param>;
+export type WhereClause = string | Condition | WhereItem[] | WhereShorthand;
 type Values = Record<string, unknown>;
 export type InsertOptions = {
-    table: string;
+    into: string;
     values: Values | Values[];
 };
 export type JoinOptions = {
@@ -23,7 +24,7 @@ export type JoinOptions = {
 export type SelectOptions = {
     distinct?: boolean;
     columns?: string | string[];
-    table: string;
+    from: string;
     join?: JoinOptions | JoinOptions[];
     where?: WhereClause;
     limit?: number;
@@ -39,7 +40,7 @@ export type UpdateOptions = {
     params?: unknown[];
 };
 export type DeleteOptions = {
-    table: string;
+    from: string;
     where?: WhereClause;
     limit?: number;
     params?: unknown[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cl-orm",
   "main": "./lib/index.js",
-  "version": "1.0.0",
+  "version": "2.1.0",
   "description": "A lightweight ORM for Cloudflare Workers (D1 and Durable Objects), designed to be intuitive, productive and focused on essential functionality",
   "homepage": "https://wellwelwel.github.io/cl-orm/docs/",
   "license": "MIT",