@aicblock/emysql 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 dpapejs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.en.md

@@ -0,0 +1,71 @@
+# @aicblock/emysql
+
+![npm](https://img.shields.io/npm/v/@aicblock/emysql)
+![npm](https://img.shields.io/npm/dm/@aicblock/emysql)
+![NPM](https://img.shields.io/npm/l/@aicblock/emysql)
+
+#### Description
+
+🛠️ Based on the basic secondary package of `mysql`, the pursuit of creating a simple and easy to use `mysql-ORM` library.
+
+#### Installation
+
+```sh
+npm i @aicblock/emysql@latest -S
+```
+
+#### Instructions
+
+```ts
+import emysql, { DefineTable } from '@aicblock/emysql' // Reference library
+// Function instantiation
+const mysql = new emysql({
+  password: '[database login password]',
+  user: '[database login username]',
+  database: 'database name'
+})
+// Create table structure
+const createTable = DefineTable({
+  tableName: 'create_table',
+    columns: [
+      {
+        name: 'id',
+        dataType: 'INT',
+        primaryKey: true,
+        autoIncrement: true,
+        comments: '主键id'
+      },
+      {
+        name: 'name',
+        dataType: 'VARCHAR',
+        length: 45,
+        notNull: true,
+        comments: '名称'
+      },
+      {
+        name: 'create_at',
+        dataType: 'DATETIME',
+        notNull: true,
+        comments: '创建时间'
+      }
+    ]
+  }
+})
+// Initialize database
+await mysql.init()
+// Create table
+await mysql.table.create([createTable])
+// Insert data
+const now = new Date()
+await mysql.change.insert({
+  t: createTable,
+  params: { name: 'test', create_at: now }
+})
+// Query data
+const list = await mysql.query({
+  t: createTable,
+  fields: ['name', 'id'],
+  condition: { id: 1 }
+})
+console.log(list) // [{id:1,name:"test"}]
+```

package/README.md

@@ -0,0 +1,71 @@
+# @aicblock/emysql
+
+![npm](https://img.shields.io/npm/v/@aicblock/emysql)
+![npm](https://img.shields.io/npm/dm/@aicblock/emysql)
+![NPM](https://img.shields.io/npm/l/@aicblock/emysql)
+
+#### 介绍
+
+🛠️ 基于 `mysql` 基础二次封装，追求打造简单、好用的 `mysql-ORM` 库.
+
+#### 安装教程
+
+```sh
+npm i @aicblock/emysql@latest -S
+```
+
+#### 使用说明
+
+```ts
+import emysql, { DefineTable } from '@aicblock/emysql' // 引用库
+// 函数实例化
+const mysql = new emysql({
+  password: '[database login password]',
+  user: '[database login username]',
+  database: 'database name'
+})
+
+// 创建表结构
+const createTable = DefineTable({
+  tableName: 'create_table',
+  columns: [
+    {
+      name: 'id',
+      dataType: 'INT',
+      primaryKey: true,
+      autoIncrement: true,
+      comments: '主键id'
+    },
+    {
+      name: 'name',
+      dataType: 'VARCHAR',
+      length: 45,
+      notNull: true,
+      comments: '名称'
+    },
+    {
+      name: 'create_at',
+      dataType: 'DATETIME',
+      notNull: true,
+      comments: '创建时间'
+    }
+  ]
+})
+// 初始化数据库
+await mysql.init()
+// 创建表
+await mysql.table.create([createTable])
+// 插入数据
+const now = new Date()
+await mysql.change.insert({
+  t: createTable,
+  params: { name: 'test', create_at: now }
+})
+// 查询数据
+const list = await mysql.query({
+  t: createTable,
+  fields: ['name', 'id'],
+  condition: { id: 1 }
+})
+console.log(list) // [{id:1,name:"test"}]
+```

package/lib/index.d.ts

@@ -0,0 +1,35 @@
+/// <reference types="./types" />
+import type { QueryResult, ResultSetHeader } from 'mysql2/promise';
+import mysql from 'mysql2/promise';
+declare class emysql {
+    db?: string;
+    log: 'none' | 'error' | 'warn' | 'info' | 'debug';
+    private pool?;
+    private conf;
+    constructor(param: EMsqlInstantiate & {
+        connConfig: mysql.PoolOptions;
+    });
+    private check_db;
+    init(): Promise<void>;
+    private create_conn;
+    detail(param: ExecQueryBaseParam): Promise<Record<string, any>>;
+    query(param: ExecQueryParam): Promise<Record<string, any>[]>;
+    count(param: QueryCountParam): Promise<number>;
+    change: {
+        insert: (v: InsertParam) => Promise<ResultSetHeader>;
+        delete: (v: DeleteParam) => Promise<ResultSetHeader>;
+        update: (v: UpdateParam) => Promise<ResultSetHeader>;
+        batchUpdate: (v: BatchUpdateParam<DuplicateUpdateParam | ConditionBatchUpdateParam>) => Promise<ResultSetHeader>;
+    };
+    transaction(exec: (v: TransactionParams<DuplicateUpdateParam | ConditionBatchUpdateParam, ResultSetHeader, QueryResult>) => Promise<any>): Promise<any>;
+    table: {
+        create: (v: DefineTableResult | DefineTableResult[]) => Promise<void>;
+        truncate: (name: string) => Promise<void>;
+        drop: (name: string) => Promise<void>;
+        exist: (name: string) => Promise<boolean>;
+    };
+    close(): Promise<void>;
+}
+export declare const DefineTable: (param: DefineTableParam) => DefineTableResult;
+export declare const version: string;
+export default emysql;

package/lib/index.js

@@ -0,0 +1,3 @@
+"use strict";var oe=Object.create;var $=Object.defineProperty;var se=Object.getOwnPropertyDescriptor;var ae=Object.getOwnPropertyNames;var ie=Object.getPrototypeOf,ce=Object.prototype.hasOwnProperty;var le=(r,t)=>{for(var e in t)$(r,e,{get:t[e],enumerable:!0})},G=(r,t,e,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let o of ae(t))!ce.call(r,o)&&o!==e&&$(r,o,{get:()=>t[o],enumerable:!(n=se(t,o))||n.enumerable});return r};var ue=(r,t,e)=>(e=r!=null?oe(ie(r)):{},G(t||!r||!r.__esModule?$(e,"default",{value:r,enumerable:!0}):e,r)),pe=r=>G($({},"__esModule",{value:!0}),r);var Oe={};le(Oe,{DefineTable:()=>Ie,default:()=>Fe,version:()=>Ce});module.exports=pe(Oe);var K=ue(require("mysql2/promise")),me=async r=>{try{let t=K.default.createPool(r);return process.on("SIGINT",async()=>{t==null||t.end(),process.env.NODE_ENV!=="test"&&process.exit(0)}),(await t.getConnection()).release(),t}catch(t){return Promise.reject(t)}},Q=me;var J=(m=>(m.EQUAL="=",m.IN="IN",m.NOT_IN="NOT IN",m.LIKE="LIKE",m.LIKE_UPPER="LIKE",m.LIKE_LOWER="LIKE",m.NOT="!=",m.IS_NOT_NULL="IS NOT NULL",m.IS_NULL="IS NULL",m.GREATER_THAN_OR_EQUAL=">=",m.GREATER_THAN=">",m.LESS_THAN_OR_EQUAL="<=",m.LESS_THAN="<",m))(J||{}),V=(n=>(n["="]="?",n.IN="(?)",n["NOT IN"]="(?)",n.LIKE="?",n.NOT="?",n[">="]="?",n[">"]="?",n["<="]="?",n["<"]="?",n))(V||{});function S(r){let t=Array.isArray(r)&&r.length!==0,e=!Array.isArray(r)&&r!==void 0&&r!==null&&r!=="";return t||e}function W(r,t){let e=[`\`${r}\``];typeof t=="string"?e.push(`\`${t}\``):e.push(`\`${t.name}\``);let n=[e.join(".")];return typeof t!="string"&&t.alias&&n.push("AS",`\`${t.alias}\``),n.join(" ")}function he(r,t){let e=["SELECT"],n=de(t.fields);e.push(n.join(",")),e.push("FROM");let o=fe(r,t.t);e.push(o);let{where:s,values:a}=t.condition&&x(r,t.condition)||{};return t.join&&e.push(ye(r,t.join).join(`
+`)),s&&(s==null?void 0:s.length)>0&&e.push("WHERE",...s),t.orderBy&&e.push(...Y(t.orderBy)),t.limit&&e.push(...D(t.limit)),{sql:e.join(" "),values:a}}function x(r,t){let e=[],n=[],o=[],s=[],a=Object.keys(t),c=(p,d)=>{let i=typeof d=="string"?{value:d}:d,{value:f,type:m,or:g,t:j,subquery:q}=i,R;if(q){let E=q.fields||[p],{sql:h,values:y}=he(r,Object.assign({},q,{fields:E}));o.push(...y),R=h}else if(!["IS_NOT_NULL","IS_NULL"].includes(m||""))if((m==="IN"||m==="NOT_IN")&&Array.isArray(f)){let E=f;g?s.push(...E):o.push(...E)}else g?s.push(f):m!=="TO_DAYS"&&o.push(f);let b=[],_=j&&`\`${j}\`.\`${p}\``||`\`${p}\``;if(m==="TO_DAYS")b.push(`TO_DAYS(${_})`,"=","TO_DAYS(NOW())");else{let E=m&&J[m]||"=";if(b.push(_,E),!["IS_NOT_NULL","IS_NULL"].includes(m||""))if(R)b.push(`(${R})`);else if((m==="IN"||m==="NOT_IN")&&Array.isArray(f)){let h=f.map(()=>"?").join(",");b.push(`(${h})`)}else b.push(V[E]||"?")}let A=b.join(" ");g&&n.push(A)||e.push(A)};a.forEach(p=>{let d=t[p];(typeof d!=="object"?[{value:d,type:"EQUAL"}]:Array.isArray(d)?d:[d]).forEach(m=>c(p,m))});let u=[e.join(" AND ")];return n.length>0&&(e.length>0&&n.length>1&&u.push(" AND "),e.length>0&&n.length===1&&u.push(" OR "),u.push(`(${n.join(" OR ")})`)),{where:u.filter(p=>S(p)),values:o.concat(s)}}function de(r){return r?(Array.isArray(r)?r:[r]).map(n=>{let o=typeof n=="string"?{name:n}:n,a=[o.t?`\`${o.t}\`.\`${o.name}\``:`\`${o.name}\``];return o.alias&&a.push("AS",`\`${o.alias}\``),a.join(" ")}):["*"]}function fe(r,t){return(Array.isArray(t)?t:[t]).map(o=>W(r,o)).join(",")}function ye(r,t){return(Array.isArray(t)?t:[t]).map(o=>{let{type:s,on:a}=o,{name:c,alias:u}=typeof o.t=="string"?{name:o.t,alias:void 0}:o.t,p=W(r,o.t),d=s==="LEFT"?"LEFT JOIN":s==="RIGHT"?"RIGHT JOIN":"INNER JOIN",i=u?[`\`${u}\``,`\`${a.joinField}\``]:[`\`${c}\``,`\`${a.joinField}\``],f=[`\`${a.mainTable}\``,`\`${a.mainField}\``];return[d,p,"ON",i.join("."),"=",f.join(".")].join(" ")})}function Y(r){let{field:t,type:e,t:n}=r,o=["ORDER BY"];return n?o.push([l(n),l(t)].join(".")):o.push(t),e&&o.push(e),o}var D=r=>["LIMIT",[r.start.toString(),",",r.length.toFixed()].join("")],l=r=>`\`${r}\``;function _e(r){let e=Object.assign({},{charset:"utf8mb4",collate:"utf8mb4_0900_bin",engine:"InnoDB"},r),n=[],{tableName:o,columns:s,engine:a,charset:c,collate:u}=e;n.push(l(o));let p=s.filter(i=>i.primaryKey),d=s.map(i=>{let f=[];f.push(l(i.name));let m=i.dataType,g=m;if(m==="DECIMAL"&&i.length&&i.point?g=`${m}(${i.length},${i.point})`:i.length&&(g=`${m}(${i.length})`),f.push(g),i.primaryKey&&(p.length===1?f.push("PRIMARY KEY","NOT NULL"):f.push("NOT NULL")),i.autoIncrement&&f.push("AUTO_INCREMENT"),i.notNull&&!i.primaryKey&&f.push("NOT NULL"),i.unique&&f.push("UNIQUE"),S(i.defaultValue)){let j=i.defaultValue,q=typeof j=="string"&&!j.startsWith("CURRENT_")?`'${j}'`:j;f.push("DEFAULT",q)}return S(i.comments)&&f.push(`COMMENT '${i.comments}'`),f.join(" ")});return p.length>1&&d.push(["PRIMARY KEY",`(${p.map(i=>l(i.name)).join(",")})`].join(" ")),n.push(`(${d.join(",")})`),n.push(`ENGINE=${a}`),n.push(`DEFAULT CHARSET=${c}`),n.push(`COLLATE=${u}`),n.join(" ")}async function X(r,t,e){try{let s=["TRUNCATE TABLE",[l(r),l(e)].join(".")].join(" ");return await t.query(s),Promise.resolve()}catch(n){return t.release(),Promise.reject(n)}}async function z(r,t,e){try{let s=["DROP TABLE IF EXISTS",[l(r),l(e)].join(".")].join(" ");return await t.query(s),Promise.resolve()}catch(n){return t.release(),Promise.reject(n)}}async function Z(r,t,e){try{let n=`SHOW TABLES IN ${l(r)} LIKE ?`,o=[e],[s]=await t.query({sql:n,values:o});return s.length===0?Promise.resolve(!1):Promise.resolve(!0)}catch(n){return t.release(),Promise.reject(n)}}var v=async(r,t,e)=>{try{let o=(Array.isArray(e)?e:[e]).map(a=>{let c=["CREATE TABLE IF NOT EXISTS"];return c.push([l(r),a.createSQL].join(".")),c.join(" ")}),s=a=>t.query(a);await Promise.all(o.map(s))}catch(n){return t.release(),Promise.reject(n)}},ee=r=>{let{tableName:t}=r,e=r.columns.map(u=>u.name),n={charset:"utf8mb4",collate:"utf8mb4_0900_bin",engine:"InnoDB"},{charset:o,collate:s,engine:a}=Object.assign({},n,r);return{name:t,createSQL:_e(r),fields:e,columns:r.columns,tableCharacter:{charset:o,collate:s,engine:a}}};var te=r=>(Array.isArray(r)?r:[r]).map(n=>{let o=typeof n=="string"?{name:n}:n,s=[];o.t&&s.push(o.t),s.push(o.name);let c=[s.map(l).join(".")];return o.alias&&c.push("AS",l(o.alias)),c.join(" ")}),P=(r,t)=>{let e=[];return(Array.isArray(t)?t:[t]).forEach(o=>{let a=[[l(r),l(o.name)].join(".")];o.alias&&a.push("AS",l(o.alias)),e.push(a.join(" "))}),e.join(",")},ge=(r,t)=>{let e=Array.isArray(t)?t:[t],n=[];return e.forEach(o=>{let{type:s,t:a,on:c}=o,u=s==="LEFT"?"LEFT JOIN":s==="RIGHT"?"RIGHT JOIN":"INNER JOIN",p=P(r,a),d=[u,p,"ON"],i=[];i.push(a.alias?l(a.alias):l(a.name),l(c.joinField)),d.push(i.join("."),"=");let f=[];f.push(c.mainTable.alias?l(c.mainTable.alias):l(c.mainTable.name),l(c.mainField)),d.push(f.join(".")),n.push(d.join(" "))}),n};function w(r){let t=["SELECT"];t.push(r.escape_fields.join(",")),t.push("FROM"),t.push(P(r.db,r.t));let e,n;if(r.condition&&Object.keys(r.condition).length>0){let s=x(r.db,r.condition);e=s.where,n=s.values}return r.join&&t.push(ge(r.db,r.join).join(`
+`)),e&&e.length>0&&t.push("WHERE",...e),r.orderBy&&t.push(...Y(r.orderBy)),r.limit&&t.push(...D(r.limit)),{sql:t.join(" "),values:n}}var Pe=async(r,t,e)=>{try{let[n,o]=await r.query({sql:t,values:e});return{data:n,fields:o}}catch(n){return r.release(),Promise.reject(n)}},I=Pe;var je=(r,t,e)=>{let n=[],o=Array.isArray(r)?r:[r];if(o.forEach(c=>{n.push(...c.fields.map(u=>{let p=[];return(o.length>1||e)&&p.push(l(c.alias||c.name)),p.push(l(u)),p.join(".")}))}),e&&(Array.isArray(e)?e:[e]).forEach(u=>{let p=u.t;typeof p!="string"&&p.fields&&n.push(...p.fields.map(d=>{let i=[];return i.push(l(p.alias||p.name)),i.push(l(d)),i.join(".")}))}),!t)return n;if(!(Array.isArray(t)?t:[t]).every(c=>{let u=typeof c=="string"?{name:c}:c,p=[];u.t&&p.push(u.t),p.push(u.name);let d=p.map(l).join(".");return n.includes(d)}))throw new Error("fields not found");return te(t)},qe=async(r,t,e)=>{try{let n=je(e.t,e.fields,e.join),{sql:o,values:s}=w({...e,db:t,escape_fields:n});console.info("[info] sql query::",o);let{data:a}=await I(r,o,s);return a}catch(n){return r.release(),Promise.reject(n)}},L=qe;var H=r=>{let t=Array.isArray(r)?r:[r],e=Array.from(new Set(t.map(o=>Object.keys(o)).flat())).map(o=>l(o)),n=t.map(o=>e.map(s=>{let a=s.replace(/`/g,"");return a in o?o[a]:null}));return{fields:e,values:n}},Ee=(r,t)=>{let e=["INSERT INTO"],n="table"in t.t?t.t.table.name:t.t.name,o=[l(r),l(n)];e.push(o.join("."));let s="table"in t.t?t.t.alias:void 0;s&&e.push("AS",l(s));let{fields:a,values:c}=H(t.params),u=["("].concat(a.join(",")).concat(")");return e.push(u.join(""),"VALUES"),e.push("?"),{sql:e.join(" "),values:[c]}},be=async(r,t,e)=>{try{let{sql:n,values:o}=Ee(r,e);console.info("[info] sql insert::",n);let[s]=await t.query({sql:n,values:o});return s}catch(n){return t.release(),Promise.reject(n)}},C=be;var Te=async(r,t,e)=>{var n,o;try{let s=typeof e.field=="string"?e.field:((n=e.field)==null?void 0:n.name)||"id",a=[];typeof e.field=="object"&&e.field.t&&(e.field.t.alias?a.push(l(e.field.t.alias)):a.push(l(e.field.t.name))),a.push(l(s));let c=[`COUNT(${a.join(".")}) AS total`],{sql:u,values:p}=w({...e,db:t,escape_fields:c});console.info("[info] sql query::",u);let{data:d}=await I(r,u,p);return((o=d[0])==null?void 0:o.total)||0}catch(s){return r.release(),Promise.reject(s)}},F=Te;var Re=async(r,t,e)=>{try{if(!e.condition||Object.keys(e.condition).length===0)throw Error("The deletion condition cannot be empty.");let n=["DELETE FROM",P(r,e.t)],{where:o,values:s}=x(r,e.condition),a=n.concat("WHERE").concat(o).join(" ");console.info("[info] sql delte::",a);let[c]=await t.execute({sql:a,values:s});return c}catch(n){return t.release(),Promise.reject(n)}},O=Re;var Ae=async(r,t,e)=>{try{if(!e.params||Object.keys(e.params).length===0)throw Error("The update params cannot be empty.");if(!e.condition||Object.keys(e.condition).length===0)throw Error("The update condition cannot be empty.");let n=["UPDATE",P(r,e.t),"SET"],{fields:o,values:s}=H(e.params);n.push(o.map(i=>`${i}=?`).join(","));let{where:a,values:c}=x(r,e.condition),u=n.concat("WHERE").concat(a).join(" ");console.info("[info] sql update::",u);let p=[...s[0],...c],[d]=await t.query({sql:u,values:p});return d}catch(n){return t.release(),Promise.reject(n)}},U=Ae;var Se=(r,t)=>{let{t:e,unique:n,excludeField:o}=t,s=t.data,a=["INSERT INTO",P(r,e)],c=Array.isArray(s),u=Array.isArray(s)?s:[s],d=Array.from(new Set(u.map(_=>Object.keys(_)).flat())).map(_=>l(_)),i=u.map(_=>d.map(A=>{let E=A.replace(/`/g,"");return E in _?_[E]:null})),f=["("].concat(d.join(","),")");a.push(f.join(""),"VALUES");let m=d.map(()=>"?"),g=["("].concat(m.join(",")).concat(")");c?a.push("?"):a.push(g.join(""));let j=[n||"id"].concat(o||[]),q=d.filter(_=>{let A=_.replace(/`/g,"");return!j.includes(A)}).map(_=>`${_} = VALUES(${_})`).join(",");a.push("ON DUPLICATE KEY UPDATE",q);let R=a.join(" "),b=c?[i]:i[0];return{sql:R,values:b}},xe=(r,t)=>{let{t:e,conditionField:n}=t,o=t.data,s=["UPDATE",P(r,e),"SET"],a={},c=[];Array.from(new Set(o.map(i=>Object.keys(i)).flat())).filter(i=>i!==n).forEach(i=>{let f=[];o.forEach(m=>{i in m&&(f.push(["WHEN","?","THEN","?"]),c.push(m[n],m[i]))}),a[i]=f}),Object.keys(a).forEach((i,f,m)=>{let g=a[i].map(q=>q.join(" ")).join(" "),j=[l(i),"=","CASE",n,g,"END"];m.length-1!==f&&j.push(","),s.push(...j)}),s.push("WHERE",n,"IN","?");let p=o.map(i=>i[n]);c.push([p]);let d=s.join(" ");return{values:c,sql:d}},Le=(r,t)=>{let{t:e}=t,{charset:n,collate:o,engine:s}=e.tableCharacter,a=t.data;if(!t.conditionField)throw Error("PARAM_ERROR::[CONDITIONFIELD] IS NOT NULL");let c=["temp_",e.name].join(""),u=Array.from(new Set(a.map(h=>Object.keys(h)).flat()));console.info("[info] allFields::",u);let p=u.map(h=>e.columns.find(y=>y.name===h)).filter(h=>h!==void 0),d=p.filter(h=>h.primaryKey),i=p.map(h=>{let y=[];y.push(l(h.name));let T=h.dataType,M=T;if(T==="DECIMAL"&&h.length&&h.point?M=`${T}(${h.length},${h.point})`:h.length&&(M=`${T}(${h.length})`),y.push(M),h.primaryKey&&(d.length===1?y.push("PRIMARY KEY","NOT NULL"):y.push("NOT NULL")),h.autoIncrement&&y.push("AUTO_INCREMENT"),h.notNull&&!h.primaryKey&&y.push("NOT NULL"),h.unique&&y.push("UNIQUE"),S(h.defaultValue)){let N=h.defaultValue,ne=typeof N=="string"&&!N.startsWith("CURRENT_")?`'${N}'`:N;y.push("DEFAULT",ne)}return S(h.comments)&&y.push(`COMMENT '${h.comments}'`),y.join(" ")}),f=["CREATE TEMPORARY TABLE IF NOT EXISTS",l(c),`(${i.join(",")})`,`ENGINE=${s}`,`DEFAULT CHARSET=${n}`,`COLLATE=${o}`].join(" ");console.info("[info] sql create temporary table::",f);let m={name:c,createSQL:f,fields:u,columns:e.columns,tableCharacter:{charset:n,collate:o,engine:s}},g=["INSERT INTO",l(c)],j=u.map(h=>l(h)).join(",");g.push("(",j,") VALUES");let q=a.map(h=>`(${u.map(T=>T in h?h[T]:null).map(()=>"?").join(",")})`).join(",");g.push(q);let R=a.flatMap(h=>u.map(y=>y in h?h[y]:null)),b={sql:g.join(" "),values:R},_=["UPDATE",P(r,e),"JOIN",P(r,m),"ON",`${P(r,e)}.${l(t.conditionField)}`,"=",`${P(r,m)}.${l(t.conditionField)}`,"SET"];return u.filter(h=>h!==t.conditionField).forEach((h,y,T)=>{_.push(`${P(r,e)}.${l(h)}`,"=",`${P(r,m)}.${l(h)}`),T.length-1!==y&&_.push(",")}),{create:{values:[],sql:f},insert:b,update:{values:[],sql:_.join(" ")},drop:{values:[],sql:["DROP TEMPORARY TABLE IF EXISTS",l(c)].join(" ")}}},we=async(r,t,e)=>{try{if(!e.params)throw new Error("params is required");if(e.type==="TEMPORARY"){let a=e.params,{create:c,insert:u,update:p,drop:d}=Le(r,a);console.info("[info] sql temporary batch create::",c.sql),await t.query(c),console.info("[info] sql temporary batch insert::",u.sql),await t.query(u),console.info("[info] sql temporary batch update::",p.sql);let[i]=await t.query(p);return await t.query(d),i}let{values:n,sql:o}=e.type==="DUPLICATE"?Se(r,e.params):xe(r,e.params);console.info("[info] sql batch update::",o);let[s]=await t.query({sql:o,values:n});return s}catch(n){return t.release(),Promise.reject(n)}},B=we;var Ne=(r,t)=>{let e=async(o,s,a)=>{try{console.info("[info] trx::sql query::",s);let[c]=await o.query(s,a);return c}catch(c){return Promise.reject(c)}};return{sql:(o,s)=>e(t,o,s),query:o=>L(t,r,o),detail:async o=>{try{return(await L(t,r,Object.assign({},o,{limit:{start:0,length:1}})))[0]}catch(s){return Promise.reject(s)}},count:o=>F(t,r,o),change:{insert:o=>C(r,t,o),batchUpdate:o=>B(r,t,o),delete:o=>O(r,t,o),update:o=>U(r,t,o)}}},$e=async(r,t,e)=>{try{await t.beginTransaction();let n=Ne(r,t);console.info("[info] transaction exec list");let o=await e(n);return await t.commit(),o}catch(n){return await t.rollback(),t.release(),Promise.reject(n)}},re=$e;var k=class{constructor(t){this.log="none";this.pool=void 0;this.conf={};this.change={insert:async t=>{try{this.check_db();let e=await this.create_conn(),n=await C(this.db,e,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}},delete:async t=>{try{this.check_db();let e=await this.create_conn(),n=await O(this.db,e,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}},update:async t=>{try{this.check_db();let e=await this.create_conn(),n=await U(this.db,e,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}},batchUpdate:async t=>{try{this.check_db();let e=await this.create_conn(),n=await B(this.db,e,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}};this.table={create:async t=>{try{let e=await this.create_conn();return this.check_db(),await v(this.db,e,t),e.release(),Promise.resolve()}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}},truncate:async t=>{try{this.check_db();let e=await this.create_conn();return await X(this.db,e,t),e.release(),Promise.resolve()}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}},drop:async t=>{try{this.check_db();let e=await this.create_conn();return await z(this.db,e,t),e.release(),Promise.resolve()}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}},exist:async t=>{try{this.check_db();let e=await this.create_conn(),n=await Z(this.db,e,t);return e.release(),Promise.resolve(n)}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}};if(this.log=t.log||"none",!t.connConfig)throw Error("CONN_CONFIG_REQUIRED");this.db=t.connConfig.database,this.conf=t.connConfig}check_db(){if(!this.db)throw this.log==="error"&&console.error("The database name is not initialized. Procedure"),Error("DB_UNINITIALIZED")}async init(){try{if(this.pool)return;this.pool=await Q(this.conf)}catch(t){throw this.log==="error"&&console.error(t),Error("CREATE_POOL_FAILED")}}async create_conn(){try{return this.pool?await this.pool.getConnection():(this.log==="error"&&console.error("The connection pool is not initialized. Procedure"),Promise.reject("POOL_UNINITIALIZED"))}catch(t){return Promise.reject(t)}}async detail(t){try{this.check_db();let e=await this.create_conn(),n=await L(e,this.db,Object.assign({},t,{limit:{start:0,length:1}}));return e.release(),n[0]}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}async query(t){try{this.check_db();let e=await this.create_conn(),n=await L(e,this.db,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}async count(t){try{this.check_db();let e=await this.create_conn(),n=await F(e,this.db,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}async transaction(t){try{this.check_db();let e=await this.create_conn(),n=await re(this.db,e,t);return e.release(),n}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}async close(){var t;try{return await((t=this.pool)==null?void 0:t.end()),this.pool=void 0,Promise.resolve()}catch(e){return this.log==="error"&&console.error(e),Promise.reject(e)}}},Ie=ee,Ce=`1.3.0:${Date.now()}`,Fe=k;0&&(module.exports={DefineTable,version});

package/lib/types.d.ts

@@ -0,0 +1,537 @@
+/**
+ * 表参数配置
+ */
+interface TableConfig {
+  /**
+   * 表名
+   */
+  name: string
+  /**
+   * 表别名
+   */
+  alias?: string
+}
+
+/**
+ * 表信息类型
+ */
+type TABLE_TYPE = DefineTableResult & { alias?: string }
+
+/**
+ * 表信息配置项
+ */
+type TABLE_OPTION = TABLE_TYPE | TABLE_TYPE[]
+
+/**
+ * 查询等式类型
+ */
+type CONDITION_EQUATION_TYPE =
+  | 'EQUAL' // 等于
+  | 'TO_DAYS' // 转换为天数
+  | 'IN' // 包含
+  | 'NOT_IN' // 不包含
+  | 'LIKE' // 模糊查询
+  | 'LIKE_UPPER' // 转大写查询
+  | 'LIKE_LOWER' // 转小写查询
+  | 'NOT' // 不等于
+  | 'IS_NOT_NULL' // 不为空
+  | 'IS_NULL' // 为空
+  | 'GREATER_THAN_OR_EQUAL' // 大于等于
+  | 'GREATER_THAN' // 大于
+  | 'LESS_THAN_OR_EQUAL' // 小于等于
+  | 'LESS_THAN' // 小于
+  | 'LESS_THAN' // 小于
+
+/**
+ * 值类型
+ */
+type VALUE_TYPE = string | number | Date | boolean | VALUE_TYPE[]
+
+interface ConditionOption {
+  /**
+   * 匹配值
+   */
+  value?: VALUE_TYPE
+  /**
+   * 等式类型
+   */
+  type?: CONDITION_EQUATION_TYPE
+  /**
+   * 是否为或语句
+   */
+  or?: boolean
+  /**
+   * 表名或表别名
+   */
+  t?: string
+  /**
+   * 子查询
+   */
+  subquery?: ExecQueryParam
+}
+
+/**
+ * 查询条件配置项
+ */
+type CONDITION_TYPE = Record<
+  string,
+  VALUE_TYPE | ConditionOption | ConditionOption[]
+>
+
+/**
+ * 查询条目区间配置项
+ */
+interface LIMIT_PARAM {
+  /**
+   * 开始位置
+   */
+  start: number
+  /**
+   * 查询数量
+   */
+  length: number
+}
+
+/**
+ * 表连接查询配置项
+ */
+interface JOIN_PARAM_TYPE {
+  /**
+   * 连接方式，默认：INNER JOIN
+   */
+  type?: 'LEFT' | 'RIGHT' | 'INNER'
+  /**
+   * 连接表配置信息
+   */
+  t: TABLE_TYPE
+  /**
+   * 连接条件配置信息
+   */
+  on: {
+    /**
+     * 连接字段名
+     */
+    joinField: string
+    /**
+     * 主表字段名
+     */
+    mainField: string
+    /**
+     * 主表表名或表别名
+     */
+    mainTable: TABLE_TYPE
+  }
+}
+
+/**
+ * 排序配置项
+ */
+interface OrderByParam {
+  /**
+   * 数据库字段名
+   */
+  field: string
+  /**
+   * 排序类型
+   * ASC | 升序
+   * DESC ｜ 降序
+   */
+  type?: 'ASC' | 'DESC'
+  /**
+   * 表名或表别名
+   */
+  t?: string
+}
+
+/**
+ * 字段配置项
+ */
+interface FIELD_OPTION {
+  /**
+   * 字段名
+   */
+  name: string
+  /**z
+   * 字段别名
+   */
+  alias?: string
+  /**
+   * 表名或表别名
+   */
+  t?: string
+}
+
+/**
+ * 字段配置类型
+ */
+type FIELDS_OPTION = string | FIELD_OPTION | (FIELD_OPTION | string)[]
+
+interface ExecQueryBaseParam {
+  /**
+   * 表信息
+   */
+  t: TABLE_OPTION
+  /**
+   * 查询条件
+   */
+  condition?: CONDITION_TYPE
+  /**
+   * 查询字段
+   */
+  fields?: FIELDS_OPTION
+  /**
+   * 表连接查询配置信息
+   */
+  join?: JOIN_PARAM_TYPE | JOIN_PARAM_TYPE[]
+  /**
+   * 排序
+   */
+  orderBy?: OrderByParam
+}
+
+/**
+ * 查询字段配置
+ */
+interface COUNT_FIELD_OPTION {
+  /**
+   * 字段名
+   */
+  name: string
+  /**
+   * 表名或表别名
+   */
+  t?: TABLE_TYPE
+}
+
+interface QueryCountParam {
+  /**
+   * 表信息
+   */
+  t: TABLE_OPTION
+  /**
+   * 查询条件
+   */
+  condition?: CONDITION_TYPE
+  /**
+   * 统计字段
+   */
+  field?: string | COUNT_FIELD_OPTION
+  /**
+   * 表连接查询配置信息
+   */
+  join?: JOIN_PARAM_TYPE | JOIN_PARAM_TYPE[]
+}
+
+/**
+ * 执行查询参数
+ */
+interface ExecQueryParam extends ExecQueryBaseParam {
+  /**
+   * 查询条目区间
+   */
+  limit?: LIMIT_PARAM
+}
+
+/**
+ * SQL查询语句转换参数
+ */
+interface SQLConvertQueryParam extends ExecQueryParam {
+  /**
+   * 数据库名称
+   */
+  db: string
+}
+
+interface EMsqlInstantiate {
+  /**
+   * 日志等级
+   */
+  log?: 'none' | 'error' | 'warn' | 'info' | 'debug'
+}
+
+/**
+ * 表字段类型
+ */
+type COLUMN_DATA_TYPE =
+  | 'INT'
+  | 'BINARY'
+  | 'BIGINT'
+  | 'BIT'
+  | 'BLOB'
+  | 'CHAR'
+  | 'DATE'
+  | 'DATETIME'
+  | 'DECIMAL'
+  | 'DOUBLE'
+  | 'ENUM'
+  | 'FLOAT'
+  | 'GEOMETRY'
+  | 'GEOMETRYCOLLECTION'
+  | 'INTEGER'
+  | 'JSON'
+  | 'LINESTRING'
+  | 'LONGBLOB'
+  | 'LONGTEXT'
+  | 'MEDIUMBLOB'
+  | 'MEDIUMINT'
+  | 'MEDIUMTEXT'
+  | 'MULTILINESTRING'
+  | 'MULTIPOINT'
+  | 'MULTIPOLYGON'
+  | 'NUMERIC'
+  | 'POINT'
+  | 'POLYGON'
+  | 'REAL'
+  | 'SET'
+  | 'SMALLINT'
+  | 'TEXT'
+  | 'TIME'
+  | 'TIMESTAMP'
+  | 'TINYBLOB'
+  | 'TINYINT'
+  | 'TINYTEXT'
+  | 'VARBINARY'
+  | 'VARCHAR'
+  | 'YEAR'
+
+/**
+ * 表字段配置信息
+ */
+interface ColumnOption {
+  name: string
+  dataType: COLUMN_DATA_TYPE
+  length?: number
+  point?: number
+  primaryKey?: boolean
+  notNull?: boolean
+  unique?: boolean
+  unsigned?: boolean
+  zeroFill?: boolean
+  autoIncrement?: boolean
+  comments?: string
+  defaultValue?: any
+}
+
+/**
+ * mysql 存储引擎
+ */
+type TABLE_ENGINE =
+  | 'InnoDB'
+  | 'MyISAM'
+  | 'MEMORY'
+  | 'PERFORMANCE_SCHEMA'
+  | 'MRG_MYISAM'
+  | 'BLACKHOLE'
+  | 'CSV'
+  | 'ARCHIVE'
+
+/**
+ * 定义数据表参数
+ */
+interface DefineTableParam {
+  /**
+   * 表名
+   */
+  tableName: string
+  /**
+   * 表字段
+   */
+  columns: ColumnOption[]
+  /**
+   * 定义存储文本数据时使用的编码. default: utf8mb4
+   */
+  charset?: string
+  /**
+   * 定义字符排序和比较规则的关键字. default: utf8mb4_0900_bin
+   */
+  collate?: string
+  /**
+   * 存储引擎. default: InnoDB
+   */
+  engine?: TABLE_ENGINE
+}
+
+interface tableCharacterParam {
+  charset: string
+  collate: string
+  engine: TABLE_ENGINE
+}
+interface DefineTableResult {
+  /**
+   * 表名
+   */
+  name: string
+  /**
+   * 创建表语句
+   */
+  createSQL: string
+  /**
+   * 表字段列表
+   */
+  fields: string[]
+  /**
+   * 表字段配置信息
+   */
+  columns: ColumnOption[]
+  /**
+   * 表字符集配置
+   */
+  tableCharacter: tableCharacterParam
+}
+
+interface InsertParam {
+  /**
+   * 表信息
+   */
+  t: DefineTableResult | { table: DefineTableResult; alias?: string }
+  /**
+   * 插入数据
+   */
+  params: Record<string, any> | Record<string, any>[]
+}
+
+interface DeleteParam {
+  /**
+   * 表名
+   */
+  t: TABLE_TYPE
+  /**
+   * 删除条件
+   */
+  condition: CONDITION_TYPE
+}
+
+interface UpdateParam {
+  /**
+   * 表信息
+   */
+  t: TABLE_TYPE
+  /**
+   * 更新数据
+   */
+  params: Record<string, any>
+  /**
+   * 更新条件
+   */
+  condition: CONDITION_TYPE
+}
+
+/**
+ * 批量更新参数｜唯一索引键更新
+ */
+interface DuplicateUpdateParam {
+  /**
+   * 表信息
+   */
+  t: TABLE_TYPE
+  /**
+   * 配置参数
+   */
+  data: Record<string, any>[]
+  /**
+   * 唯一索引字段名
+   */
+  unique?: string
+  /**
+   * 不更新字段
+   */
+  excludeField?: string | string[]
+  /**
+   * 更新条件
+   */
+  condition?: CONDITION_TYPE
+}
+
+/**
+ * 批量更新参数｜条件更新
+ */
+interface ConditionBatchUpdateParam {
+  /**
+   * 表信息
+   */
+  t: TABLE_TYPE
+  /**
+   * 条件字段
+   */
+  conditionField: string
+  /**
+   * 数据
+   */
+  data: Record<string, any>[]
+}
+
+interface BatchUpdateParam<
+  T extends DuplicateUpdateParam | ConditionBatchUpdateParam
+> {
+  type: 'DUPLICATE' | 'CASE_WHEN' | 'TEMPORARY'
+  params: T
+}
+
+interface TransactionChange<T, ResultSetHeader> {
+  /**
+   * 执行数据插入语句
+   *
+   * Execute the data insert statement
+   */
+  insert(v: InsertParam): Promise<ResultSetHeader>
+  /**
+   * 执行数据批量更新语句
+   *
+   * Execute data batch update statements
+   */
+  batchUpdate(v: T): Promise<ResultSetHeader>
+  /**
+   * 执行数据删除语句
+   *
+   * Execute a data delete statement
+   */
+  delete(v: DeleteParam): Promise<ResultSetHeader>
+  /**
+   * 执行数据更新语句
+   *
+   * Execute the data update statement
+   */
+  update(v: UpdateParam): Promise<ResultSetHeader>
+}
+
+/**
+ * 事务参数配置
+ */
+interface TransactionParams<
+  T extends DuplicateUpdateParam | ConditionBatchUpdateParam,
+  ResultSetHeader,
+  QueryResult
+> {
+  /**
+   * 执行原SQL语句
+   *
+   * Execute query statement
+   * @param param 参数值
+   * @returns
+   */
+  sql(sql: string, param?: VALUE_TYPE): Promise<QueryResult>
+  /**
+   * 执行查询语句
+   *
+   * Execute query statement
+   * @param v 配置参数信息
+   * @returns
+   */
+  query(v: ExecQueryParam): Promise<Record<string, any>[]>
+  /**
+   * 执行查询数据详情语句
+   *
+   * Execute the statement to query data details
+   * @param v 参数信息
+   */
+  detail(v: ExecQueryBaseParam): Promise<Record<string, any> | undefined>
+  /**
+   * 获取数据总数
+   * @param v 参数信息
+   */
+  count(v: QueryCountParam): Promise<number>
+  /**
+   * 数据更新函数
+   */
+  change: TransactionChange<BatchUpdateParam<T>, ResultSetHeader>
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@aicblock/emysql",
+  "version": "1.3.0",
+  "description": "🛠️ Based on the basic secondary package of `mysql`, the pursuit of creating a simple and easy to use `mysql-ORM` library.",
+  "main": "lib/index.js",
+  "scripts": {
+    "package": "ts-node ./scripts/build.ts",
+    "doc": "npm run -C ./doc dev",
+    "doc:build": "npm run -C ./doc build",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 1",
+    "test": "jest --coverage",
+    "prepare": "husky"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/aiclouddigit/e-mysql"
+  },
+  "homepage": "http://emysql.aicblock.cn/",
+  "keywords": [
+    "MYSQL",
+    "AICBLOCKCN",
+    "ORM",
+    "nodejs",
+    "mysql-orm"
+  ],
+  "files": [
+    "lib"
+  ],
+  "author": "jieyang;damon;",
+  "license": "MIT",
+  "devDependencies": {
+    "@commitlint/cli": "^19.6.0",
+    "@commitlint/config-conventional": "^19.6.0",
+    "@dpapejs/node-utils": "^0.1.0",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^16.4.10",
+    "conventional-changelog-cli": "^5.0.0",
+    "esbuild": "^0.21.3",
+    "husky": "^9.1.7",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.3",
+    "ts-node": "^10.9.2"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS,"
+    }
+  },
+  "dependencies": {
+    "mysql2": "^3.14.1"
+  }
+}