@asla/yoursql 0.0.2 → 0.0.4

package/dist/mod.js

@@ -65,6 +65,16 @@ class SqlValuesCreator {
      */
     constructor(map = new Map()) {
         this.map = map;
+        const fn = (value) => this.toSqlStr(value);
+        Reflect.setPrototypeOf(fn, this);
+        return fn;
+    }
+    /** 设置转换器 */
+    setTransformer(type, transformer) {
+        if (!transformer)
+            this.map.delete(type);
+        else
+            this.map.set(type, transformer);
     }
     string(value) {
         return SqlValuesCreator.string(value);
@@ -72,7 +82,9 @@ class SqlValuesCreator {
     number(value) {
         return value.toString();
     }
-    /** 将 JS 对象转为 SQL 的字符值的形式 */
+    /**
+     * 将 JS 对象转为 SQL 的字符值的形式
+     */
     toSqlStr(value) {
         switch (typeof value) {
             case "bigint":
@@ -93,54 +105,73 @@ class SqlValuesCreator {
                     if (value instanceof Class)
                         return this.map.get(Class).call(this, value);
                 }
-                return this.string(JSON.stringify(value));
+                return this.defaultObject(value);
+            case "undefined":
+                return "NULL";
             default:
+                //function、symbol
                 let type = typeof value;
-                if (type === "object")
-                    type = value.constructor?.name ?? "object";
                 throw new Error("不支持转换 " + type + " 类型");
         }
     }
-    /**
-     * 将对象列表转为 SQL 的 VALUES
-     * @example 返回示例： " (...),(...) "
-     */
-    objectListToValuesList(objectList, keys = Object.keys(objectList[0])) {
-        let i = 0;
+    defaultObject(value) {
+        return this.string(JSON.stringify(value));
+    }
+    objectListToValuesList(objectList, keys_types) {
+        if (objectList.length <= 0)
+            throw new Error("objectList 不能是空数组");
+        let keys;
+        if (!keys_types) {
+            keys = getKeys(objectList);
+        }
+        else if (keys_types instanceof Array) {
+            keys = keys_types;
+        }
+        else {
+            keys = Object.keys(keys_types);
+        }
+        let str = "(" + this.objectToValues(objectList[0], keys_types ?? keys) + ")";
+        let i = 1;
         let j;
         let value;
-        const rowValues = new Array(objectList.length);
+        let rows;
         try {
             for (; i < objectList.length; i++) {
                 const object = objectList[i];
-                const values = [];
+                rows = [];
                 j = 0;
                 for (; j < keys.length; j++) {
-                    value = object[keys[j]];
-                    values[j] = this.toSqlStr(value);
+                    value = object[keys[j]] ?? null;
+                    rows[j] = this.toSqlStr(value);
                 }
-                rowValues[i] = "\n(" + values.join(",") + ")";
+                str += ",\n(" + rows.join(",") + ")";
             }
         }
         catch (error) {
             let message = error instanceof Error ? error.message : String(error);
             throw new Error("第 " + i + " 项，字段 '" + keys[j] + "' 异常，" + message);
         }
-        return rowValues.join(",");
+        return str;
     }
-    objectToValues(object, keys) {
+    objectToValues(object, keys_types) {
+        const { keys, type } = toKeyType(object, keys_types);
         const values = [];
         let i = 0;
+        let key;
         let value;
         try {
             for (; i < keys.length; i++) {
-                value = object[keys[i]];
-                values[i] = this.toSqlStr(value);
+                key = keys[i];
+                value = object[key] ?? null;
+                if (type[key])
+                    values[i] = this.toSqlStr(value) + "::" + type[key];
+                else
+                    values[i] = this.toSqlStr(value);
             }
         }
         catch (error) {
             let message = error instanceof Error ? error.message : String(error);
-            throw new Error("字段 '" + keys[i] + "' 异常，" + message);
+            throw new Error("字段 '" + key + "' 异常，" + message);
         }
         return values.join(",");
     }
@@ -152,14 +183,44 @@ class SqlValuesCreator {
         return values.map(this.toSqlStr.bind(this)).join(",");
     }
 }
+function toKeyType(object, keys_types) {
+    let type = {};
+    let keys;
+    if (keys_types instanceof Array) {
+        keys = keys_types;
+        type = {};
+    }
+    else if (keys_types) {
+        keys = Object.keys(keys_types);
+        type = keys_types;
+    }
+    else {
+        keys = Object.keys(object).filter((key) => typeof key === "string" && object[key] !== undefined);
+    }
+    return { type, keys };
+}
+function getKeys(objectList) {
+    let keys = new Set();
+    for (let i = 0; i < objectList.length; i++) {
+        let obj = objectList[i];
+        let hasKeys = Object.keys(obj);
+        let k;
+        for (let j = 0; j < hasKeys.length; j++) {
+            k = hasKeys[j];
+            if (obj[k] !== undefined && typeof k === "string")
+                keys.add(k);
+        }
+    }
+    return Array.from(keys);
+}
 
 /**
  * @public
  * PgSql的值转换
  */
 class PgSqlValue extends SqlValuesCreator {
-    constructor() {
-        const map = new Map();
+    constructor(custom) {
+        const map = new Map(custom);
         map.set(Array, PgSqlValue.prototype.array);
         map.set(Date, PgSqlValue.prototype.timestamp);
         super(map);
@@ -172,18 +233,53 @@ class PgSqlValue extends SqlValuesCreator {
     }
 }
 
-/** @public */
+/**
+ * 可选择项。可以是 table、查询结果等，它能被 select 语句选择
+ * @example
+ * ```ts
+ * declare const item: SqlSelectable<any>
+ * await query(`select * from ${item.toSelect()}`)
+ *
+ * ```
+ * @public
+ */
 class SqlSelectable {
+    constructor(columns) {
+        // Reflect.set(this, SQL_SELECTABLE, undefined);
+        let readonlyColumns;
+        if (typeof columns[Symbol.iterator] === "function") {
+            let iterable = columns;
+            readonlyColumns = [];
+            let iter = iterable[Symbol.iterator]();
+            let i = 0;
+            let item = iter.next();
+            while (!item.done) {
+                readonlyColumns[i++] = item.value;
+                item = iter.next();
+            }
+            // readonlyColumns.length = i;
+        }
+        else {
+            let arrayLike = columns;
+            readonlyColumns = new Array(arrayLike.length);
+            // readonlyColumns.length = arrayLike.length;
+            for (let i = 0; i < arrayLike.length; i++) {
+                readonlyColumns[i] = arrayLike[i];
+            }
+        }
+        this.columns = readonlyColumns;
+    }
 }
-/** @public */
+/**
+ * 数据库表
+ * @public
+ */
 class DbTable extends SqlSelectable {
     constructor(name, columns) {
-        super();
+        if (!(columns instanceof Array))
+            columns = Object.keys(columns);
+        super(columns);
         this.name = name;
-        if (columns instanceof Array)
-            this.columns = [...columns];
-        else
-            this.columns = Object.keys(columns);
     }
     toSelect() {
         return this.name;
@@ -193,14 +289,13 @@ class DbTable extends SqlSelectable {
     }
 }
 /**
- * SELECT、UPDATE、DELETE、INSERT INTO 带结果的返回值
+ * SELECT 以及 UPDATE、DELETE、INSERT INTO 带结果的 SQL 语句
  * @public
  */
 class SqlQueryStatement extends SqlSelectable {
     constructor(sql, columns) {
-        super();
+        super(columns);
         this.sql = sql;
-        this.columns = columns;
     }
     toString() {
         return this.sql;
@@ -324,18 +419,14 @@ const createSelect = function createSelect(tb, columns, option) {
     let select = createSelectMap(tb, columns, option).selects;
     return new SelectImpl(select);
 };
+function* mergeColumns(a, b) {
+    for (const { columns } of a)
+        yield* columns.keys();
+    yield* b;
+}
 class SelectImpl extends SqlSelectable {
-    get columns() {
-        return this.getColumns();
-    }
-    *getColumns() {
-        for (const { columns } of this.tableList.values()) {
-            yield* columns.keys();
-        }
-        yield* this.addedColumns.keys();
-    }
-    constructor(tableList, addedColumns = new Map()) {
-        super();
+    constructor(tableList, addedColumns) {
+        super(addedColumns ? mergeColumns(tableList.values(), addedColumns.keys()) : tableList.keys());
         _SelectImpl_instances.add(this);
         this.tableList = tableList;
         this.addedColumns = addedColumns;
@@ -375,11 +466,13 @@ class SelectImpl extends SqlSelectable {
                 }
             }
         }
-        for (const [asName, columnStr] of this.addedColumns) {
-            if (asName === columnStr)
-                selectColumns.push(asName);
-            else
-                selectColumns.push(columnStr + " AS " + asName);
+        if (this.addedColumns) {
+            for (const [asName, columnStr] of this.addedColumns) {
+                if (asName === columnStr)
+                    selectColumns.push(asName);
+                else
+                    selectColumns.push(columnStr + " AS " + asName);
+            }
         }
         if (selectColumns.length === 0)
             throw new Error("Columns 为空");
@@ -410,12 +503,13 @@ class SelectImpl extends SqlSelectable {
         return obj;
     }
     addColumns(add) {
+        let addedColumns = this.addedColumns ? new Map(this.addedColumns) : new Map();
         for (const [asNewName, columnStr] of Object.entries(add)) {
-            if (this.addedColumns.has(asNewName))
-                throw new Error();
-            this.addedColumns.set(asNewName, columnStr);
+            if (addedColumns.has(asNewName))
+                throw new Error(`The column ${asNewName} already exists`);
+            addedColumns.set(asNewName, columnStr);
         }
-        return this;
+        return new _a(this.tableList, addedColumns);
     }
     toQuery(option = {}) {
         const { where, orderNullRule } = option;
@@ -505,11 +599,11 @@ class DbTableQuery extends DbTable {
             if (values.length === 0)
                 throw new Error("值不能为空");
             insertCol = Object.keys(values[0]);
-            valuesStr = `VALUES ${this.statement.objectListToValuesList(values, insertCol)}`;
+            valuesStr = `VALUES\n${this.statement.objectListToValuesList(values, insertCol)}`;
         }
         else if (values instanceof SqlQueryStatement) {
             // todo 验证 values.columns 和 this.columns 是否匹配
-            valuesStr = values.toSelect();
+            valuesStr = values.toString();
             insertCol = values.columns;
         }
         else

package/dist/select/selectable.d.ts

@@ -1,29 +1,46 @@
 import { TableType } from "./type.ts";
 declare const SQL_SELECTABLE: unique symbol;
-/** @public */
+/**
+ * 可选择项。可以是 table、查询结果等，它能被 select 语句选择
+ * @example
+ * ```ts
+ * declare const item: SqlSelectable<any>
+ * await query(`select * from ${item.toSelect()}`)
+ *
+ * ```
+ * @public
+ */
 export declare abstract class SqlSelectable<T extends TableType> {
-    abstract readonly columns: Iterable<string>;
-    /** select from xxx 中的 xxx */
+    constructor(columns: ArrayLike<string> | Iterable<string>);
+    /** 结果列 */
+    readonly columns: readonly string[];
+    /**
+     * 转成子选择语句, 你可以使用 select form xxx 选择
+     * 如果是 table 则是 table name
+     * 如果是 选择语句，则是 (xxx)
+     */
     abstract toSelect(): string;
+    /** 获取 SQL 语句 */
     abstract toString(): string;
     /** 保留以推断类型 */
     [SQL_SELECTABLE]: T;
 }
-/** @public */
+/**
+ * 数据库表
+ * @public
+ */
 export declare class DbTable<T extends TableType> extends SqlSelectable<T> {
     readonly name: string;
-    readonly columns: readonly string[];
     constructor(name: string, columns: readonly (keyof T)[]);
     toSelect(): string;
     toString(): string;
 }
 /**
- * SELECT、UPDATE、DELETE、INSERT INTO 带结果的返回值
+ * SELECT 以及 UPDATE、DELETE、INSERT INTO 带结果的 SQL 语句
  * @public
  */
 export declare class SqlQueryStatement<T extends TableType = TableType> extends SqlSelectable<T> {
     private sql;
-    readonly columns: readonly string[];
     constructor(sql: string, columns: readonly string[]);
     toString(): string;
     toSelect(): string;

package/dist/sql_value/db_type.d.ts

@@ -1,10 +1,10 @@
-import { SqlValuesCreator } from "./sql_value.ts";
+import { SqlValuesCreator, JsObjectMapSql } from "./sql_value.ts";
 /**
  * @public
  * PgSql的值转换
  */
 export declare class PgSqlValue extends SqlValuesCreator {
-    constructor();
+    constructor(custom?: JsObjectMapSql);
     timestamp(value: Date): string;
     array(value: any[]): string;
 }

package/dist/sql_value/sql_value.d.ts

@@ -11,7 +11,14 @@ export declare class SqlRaw<T = any> {
     [SQL_RAW]: T;
 }
 /** @public */
-export type JsObjectMapSql = Map<new (...args: any[]) => any, (value: object) => string>;
+export type JsObjectMapSql = Map<new (...args: any[]) => any, (value: any) => string>;
+/**
+ * @public
+ */
+export interface SqlValuesCreator {
+    /** 将 JS 对象转为 SQL 的字符值的形式 */
+    (value: any): string;
+}
 /**
  * SQL value 生成器
  * @public
@@ -26,21 +33,32 @@ export declare class SqlValuesCreator {
      * @param map - 自定义对象转换
      */
     constructor(map?: JsObjectMapSql);
+    /** 设置转换器 */
+    setTransformer<T>(type: new (...args: any[]) => T, transformer?: (value: T) => string): void;
     private readonly map;
     string(value: string): string;
     number(value: number | bigint): string;
-    /** 将 JS 对象转为 SQL 的字符值的形式 */
+    /**
+     * 将 JS 对象转为 SQL 的字符值的形式
+     */
     toSqlStr(value: any): string;
+    protected defaultObject(value: object): string;
     /**
      * 将对象列表转为 SQL 的 VALUES
      * @example 返回示例： " (...),(...) "
+     * @param keys - 选择的键。如果指定了 keys, 值为 undefined 的属性将自动填充为 null; 如果未指定 keys，将选择 objectList 所有不是 undefined 项的键的并集
      */
-    objectListToValuesList<T extends object>(objectList: T[], keys?: (keyof T)[]): string;
+    objectListToValuesList<T extends object>(objectList: T[], keys?: readonly (keyof T)[] | {
+        [key in keyof T]?: string | undefined;
+    }): string;
     /**
      * 将对象转为 SQL 的 value
      * @example 返回示例： " 'abc', '6', 'now()' "
+     * @param keys - 如果指定了key, object undefined 的属性值将填充为 null，如果不指定，将自获取 object 所有非 undefined 的属性的key
      */
-    objectToValues(object: object, keys: readonly string[]): string;
+    objectToValues<T extends object>(object: T, keys?: readonly (keyof T)[] | {
+        [key in keyof T]?: string | undefined;
+    }): string;
     /**
      * 将数组列表转为 SQL 的一个 value
      * @example 返回示例： " 'abc', '6', 'now()' "

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asla/yoursql",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "",
   "type": "module",
   "types": "./dist/mod.d.ts",
@@ -17,6 +17,7 @@
     "@rollup/plugin-typescript": "^12.1.0",
     "rollup": "^4.22.4",
     "tslib": "^2.7.0",
+    "typescript": "^5.6.2",
     "typescritp": "^1.0.0",
     "vitest": "^2.1.1"
   },