gg-mysql-connector 1.0.10 → 1.0.12

package/README.md

@@ -0,0 +1,118 @@
+# gg-mysql-connector
+
+**`gg-mysql-connector`** is an intuitive MySQL model creator designed to simplify database management and operations by synchronizing TypeScript models with MySQL tables. This package allows you to declare and manage your MySQL database structure programmatically, with strong type enforcement.
+
+## Features
+
+- **Declare Database Structure**: Define your database tables and columns as TypeScript variables.
+- **Sync Database Structure**: Automatically synchronize your declared models with the actual MySQL database.
+- **Automated View Management**: Automatically create or update SQL views based on your declarations.
+- **Generate TypeScript Models**: Generate interfaces that mirror your MySQL structure, ensuring type-safe operations.
+- **Type-Safe MySQL Connector**: Provides type-enforced MySQL operations like CRUD (Select, Update, Delete).
+
+## Installation
+
+```bash
+npm install gg-mysql-connector
+```
+
+## 1. Declare Your Model
+
+Start by declaring your database tables and columns as TypeScript variables:
+
+```typescript
+import { MyModel } from "gg-mysql-connector"
+
+const model: MyModel[] = [
+  {
+    tableName: "user",
+    columns: [
+      { COLUMN_NAME: "id", DATA_TYPE: "int", AUTO_INCREMENT: true },
+      { COLUMN_NAME: "name", DATA_TYPE: "varchar(512)" },
+    ],
+  },
+  {
+    tableName: "item",
+    columns: [
+      { COLUMN_NAME: "id", DATA_TYPE: "int", AUTO_INCREMENT: true },
+      { COLUMN_NAME: "name", DATA_TYPE: "varchar(512)" },
+      { COLUMN_NAME: "price", DATA_TYPE: "float" },
+      {
+        COLUMN_NAME: "status",
+        DATA_TYPE: "varchar(64)",
+        POSSIBLE_VALUE: ["ACTIVE", "DISABLE"],
+      },
+      { COLUMN_NAME: "description", DATA_TYPE: "varchar(512)" },
+    ],
+  },
+]
+```
+
+## 2. Sync Model and Views with MySQL & Generate Model Interface
+
+Use the provided functions to sync your model with MySQL and generate TypeScript interfaces.
+
+```typescript
+import { ModelGenerator } from "gg-mysql-connector"
+
+const migrator = new ModelGenerator(
+  {
+    host: "your-host",
+    user: "your-user",
+    password: "your-password",
+    database: "test_ggdb_connector",
+  },
+  model
+)
+
+await migrator.init()
+await migrator.pushModelToDB()
+await migrator.pushViewToDB("./views")
+await migrator.generateModelInterface({
+  appName: "app",
+  model: model,
+  outputDirectory: ["./"],
+})
+
+process.exit()
+```
+
+## 3. CRUD Operations with Type Enforcement
+
+Once you've generated your interfaces, you can perform type-enforced MySQL operations.
+
+```typescript
+import GGMySQLConnector from "gg-mysql-connector"
+import app_INF from "./your-output-directory/app_INF" // Generated in step 2
+
+const db = new GGMySQLConnector<app_INF>({
+  host: "your-host",
+  user: "your-user",
+  password: "your-password",
+  database: "test_ggdb_connector",
+})
+
+await db.init()
+
+// Select operations
+let result_1 = await db.select("item")
+let result_2 = await db.selectByID("user", 2)
+let result_3 = await db.selectByMatchParams("item", { id: 5 })
+let result_4 = await db.selectByMatchParams("item", { name: "pen", price: 3 })
+
+// Update operations
+let result_5 = await db.update("user", { id: 3, name: "Tony" })
+let result_6 = await db.update("item", { id: 3, price: 4, name: "Ruler" })
+let result_7 = await db.updateOnlyID("item", { oldID: 7, newID: 4 })
+
+// Delete operations
+let result_8 = await db.deleteByID("item", 5)
+let result_9 = await db.deleteByMatchParams("item", { name: "pen", price: 5 })
+
+// raw query
+const result_10 = await db.query("SELECT * FROM item where id = ?", [5])
+```
+
+## License
+
+MIT License

package/dist/GGMySQLConnector.d.ts

@@ -45,10 +45,10 @@ export default class GGMySQLConnector<Main> implements ClassDBInterface<Main> {
     select<T extends keyof Main>(tableName: T extends string ? T : string): Promise<Main[T][]>;
     getTableNameList(): Promise<string[]>;
     getViewNameList(): Promise<string[]>;
-    deleteByMatchParams<T>(tableName: string, params: Partial<{
-        [K in keyof Unarray<T>]: string | number | undefined | null;
+    deleteByMatchParams<T extends keyof Main>(tableName: T extends string ? T : string, params: Partial<{
+        [K in keyof Main[T]]: T | string | number | undefined | null;
     }>): Promise<mysql.OkPacket | null>;
-    deleteByID(tableName: string, id: number): Promise<mysql.OkPacket>;
+    deleteByID<T extends keyof Main>(tableName: T extends string ? T : string, id: number): Promise<mysql.OkPacket>;
     insert<T extends keyof Main>(tableName: T, parameter: Partial<{
         [R in keyof Unarray<Main[T]>]: any;
     }> | Partial<{

package/dist/ModelGenerator.d.ts

@@ -20,5 +20,9 @@ export default class ModelGenerator {
     getTableNameList(): Promise<string[]>;
     getViewNameList(): Promise<string[]>;
     getColumnFullList(tableName: string): Promise<mysql.RowDataPacket[]>;
-    generateModelInterface(DBType: string, model: MyModel[], ouputDirectory: string[]): Promise<string>;
+    generateModelInterface(params: {
+        appName: string;
+        model: MyModel[];
+        ouputDirectory: string[];
+    }): Promise<string>;
 }

package/dist/ModelGenerator.js

@@ -90,11 +90,11 @@ class ModelGenerator {
         const result = (await this.query(`SELECT * FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_SCHEMA = '${this.dbInfo.database}' AND TABLE_NAME = '${tableName}'`, undefined, false));
         return result;
     }
-    async generateModelInterface(DBType, model, ouputDirectory) {
+    async generateModelInterface(params) {
         const isTableNameExistInModel = (tableName) => {
             if (tableName === "sessions")
                 return true;
-            const table = model.find((row) => row.tableName === tableName);
+            const table = params.model.find((row) => row.tableName === tableName);
             if (table)
                 return true;
             return false;
@@ -102,7 +102,7 @@ class ModelGenerator {
         const isColumnExistInModel = (tableName, columnName) => {
             if (tableName === "sessions")
                 return true;
-            const table = model.find((row) => row.tableName === tableName);
+            const table = params.model.find((row) => row.tableName === tableName);
             if (table) {
                 const column = table.columns.find((row) => row.COLUMN_NAME === columnName);
                 if (column)
@@ -111,7 +111,7 @@ class ModelGenerator {
             return false;
         };
         const getPossibleColumnValue = (tableName, columnName) => {
-            const foundTable = model.find((row) => row.tableName === tableName);
+            const foundTable = params.model.find((row) => row.tableName === tableName);
             if (foundTable) {
                 const foundColumn = foundTable["columns"].find((row) => row.COLUMN_NAME === columnName);
                 if (foundColumn) {
@@ -153,14 +153,14 @@ class ModelGenerator {
                 // console.log(`generate interface from ${tableName}`)
             }
         }
-        const fileName = `${DBType}_INF.ts`;
-        const code = `export default interface ${DBType}_INF  { ${array.join("\n")} }`;
-        ouputDirectory.forEach(async (tempPath) => {
+        const fileName = `${params.appName}_INF.ts`;
+        const code = `export default interface ${params.appName}_INF  { ${array.join("\n")} }`;
+        params.ouputDirectory.forEach(async (tempPath) => {
             const serverFilePath = path_1.default.join(tempPath, fileName);
             await fs_1.default.writeFileSync(serverFilePath, code);
             console.log("save to ", serverFilePath);
         });
-        console.log(`generate interface ${DBType} ${chalk_1.default.bgGreen(" SUCCESS ")}`);
+        console.log(`generate interface ${params.appName} ${chalk_1.default.bgGreen(" SUCCESS ")}`);
         return code;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gg-mysql-connector",
-  "version": "1.0.10",
+  "version": "1.0.12",
   "description": "",
   "main": "dist/index.js",
   "scripts": {

package/readme2.md

@@ -0,0 +1,117 @@
+# gg-mysql-connector
+
+gg-mysql-connector is an intuitive MySQL model creator designed to simplify database management and operations by synchronizing TypeScript models with MySQL tables. This package allows you to declare and manage your MySQL database structure programmatically while enforcing strong type constraints.
+
+Features
+
+    •	Declare Database Structure: Easily define your database tables and columns as TypeScript variables.
+    •	Sync Database Structure: Automatically synchronize your defined structures with the actual MySQL database.
+    •	Automated View Management: Automatically create or update SQL views based on your declarations.
+    •	Generate TypeScript Models: Generate interfaces that mirror your MySQL structure, ensuring type-safe operations.
+    •	Type-Safe MySQL Connector: Provides a type-enforced MySQL connector with basic functions such as:
+    •	Performing CRUD operations (Select, Update, Delete)
+
+## Installation
+
+```bash
+npm install gg-mysql-connector
+```
+
+## 1. Declare your model
+
+```typescript
+import { MyModel } from "../myModel"
+
+const model: MyModel[] = [
+  {
+    tableName: "user",
+    columns: [
+      {
+        COLUMN_NAME: "id",
+        DATA_TYPE: "int",
+        AUTO_INCREMENT: true,
+      },
+      {
+        COLUMN_NAME: "name",
+        DATA_TYPE: "varchar(512)",
+      },
+    ],
+  },
+  {
+    tableName: "item",
+    columns: [
+      {
+        COLUMN_NAME: "id",
+        DATA_TYPE: "int",
+        AUTO_INCREMENT: true,
+      },
+      {
+        COLUMN_NAME: "name",
+        DATA_TYPE: "varchar(512)",
+      },
+      {
+        COLUMN_NAME: "price",
+        DATA_TYPE: "float",
+      },
+      {
+        COLUMN_NAME: "status",
+        DATA_TYPE: "varchar(64)",
+        POSSIBLE_VALUE: ["ACTIVE", "DISABLE"],
+      },
+      {
+        COLUMN_NAME: "description",
+        DATA_TYPE: "varchar(512)",
+      },
+    ],
+  },
+]
+```
+
+## 2. Sync model and views to mysql and generate model interface file
+
+```typescript
+const migrator = new ModelGenerator(
+  {
+    host: "you-host",
+    user: "user",
+    password: "password",
+    database: "test_ggdb_connector",
+  },
+  model
+)
+await migrator.init()
+await migrator.pushModelToDB()
+await migrator.pushViewToDB("./views")
+await migrator.generateModelInterface({
+  appName: "app",
+  model: model,
+  ouputDirectory: ["./"],
+})
+process.exit()
+```
+
+## 3. CRUD with type enforced
+
+```typescript
+// app_INF is an interface that you generated from step 2
+import app_INF from "your-output-directory/app_INF"
+const db = new GGMySQLConnector<app_INF>({
+  host: "you-host",
+  user: "user",
+  password: "password",
+  database: "test_ggdb_connector",
+})
+await db.init()
+
+let result_1 = await db.select("item")
+let result_2 = await db.selectByID("user", 2)
+let result_3 = await db.selectByMatchParams("item", { id: 5 })
+let result_4 = await db.selectByMatchParams("item", { name: "pen", price: 3 })
+
+let result_5 = await db.update("user", { id: 3, name: "tony" })
+let result_6 = await db.update("item", { id: 3, price: 4, name: "ruler" })
+let result_7 = await db.updateOnlyID("item", { oldID: 7, newID: 4 })
+
+let result_8 = await db.deleteByID("item", 5)
+let result_9 = await db.deleteByMatchParams("item", { name: "pen", price: 5 })
+```

package/src/GGMySQLConnector.ts

@@ -194,10 +194,10 @@ export default class GGMySQLConnector<Main> implements ClassDBInterface<Main> {
     return data
   }
 
-  async deleteByMatchParams<T>(
-    tableName: string,
+  async deleteByMatchParams<T extends keyof Main>(
+    tableName: T extends string ? T : string,
     params: Partial<{
-      [K in keyof Unarray<T>]: string | number | undefined | null
+      [K in keyof Main[T]]: T | string | number | undefined | null
     }>
   ) {
     const columnList = await this.getColumnList(tableName)
@@ -220,7 +220,10 @@ export default class GGMySQLConnector<Main> implements ClassDBInterface<Main> {
     return result
   }
 
-  async deleteByID(tableName: string, id: number): Promise<mysql.OkPacket> {
+  async deleteByID<T extends keyof Main>(
+    tableName: T extends string ? T : string,
+    id: number
+  ): Promise<mysql.OkPacket> {
     let result = (await this.query(`DELETE FROM ${tableName} WHERE id = ?`, [
       id,
     ])) as mysql.OkPacket

package/src/ModelGenerator.ts

@@ -123,14 +123,14 @@ export default class ModelGenerator {
     )) as mysql.RowDataPacket[]
     return result
   }
-  async generateModelInterface(
-    DBType: string,
-    model: MyModel[],
+  async generateModelInterface(params: {
+    appName: string
+    model: MyModel[]
     ouputDirectory: string[]
-  ) {
+  }) {
     const isTableNameExistInModel = (tableName: string) => {
       if (tableName === "sessions") return true
-      const table = model.find((row) => row.tableName === tableName)
+      const table = params.model.find((row) => row.tableName === tableName)
       if (table) return true
 
       return false
@@ -138,7 +138,7 @@ export default class ModelGenerator {
     const isColumnExistInModel = (tableName: string, columnName: string) => {
       if (tableName === "sessions") return true
 
-      const table = model.find((row) => row.tableName === tableName)
+      const table = params.model.find((row) => row.tableName === tableName)
       if (table) {
         const column = table.columns.find(
           (row) => row.COLUMN_NAME === columnName
@@ -148,7 +148,7 @@ export default class ModelGenerator {
       return false
     }
     const getPossibleColumnValue = (tableName: string, columnName: string) => {
-      const foundTable = model.find((row) => row.tableName === tableName)
+      const foundTable = params.model.find((row) => row.tableName === tableName)
       if (foundTable) {
         const foundColumn = foundTable["columns"].find(
           (row) => row.COLUMN_NAME === columnName
@@ -202,18 +202,20 @@ export default class ModelGenerator {
         // console.log(`generate interface from ${tableName}`)
       }
     }
-    const fileName = `${DBType}_INF.ts`
-    const code = `export default interface ${DBType}_INF  { ${array.join(
-      "\n"
-    )} }`
+    const fileName = `${params.appName}_INF.ts`
+    const code = `export default interface ${
+      params.appName
+    }_INF  { ${array.join("\n")} }`
 
-    ouputDirectory.forEach(async (tempPath) => {
+    params.ouputDirectory.forEach(async (tempPath) => {
       const serverFilePath = path.join(tempPath, fileName)
       await fs.writeFileSync(serverFilePath, code)
       console.log("save to ", serverFilePath)
     })
 
-    console.log(`generate interface ${DBType} ${chalk.bgGreen(" SUCCESS ")}`)
+    console.log(
+      `generate interface ${params.appName} ${chalk.bgGreen(" SUCCESS ")}`
+    )
 
     return code
   }

package/src/app_INF.ts

@@ -1,12 +1,17 @@
-export default interface app_INF  {  item  : {  
- id: number; 
- name: "pen" | "ruler"; 
- price: number; 
- description: string; }
- user  : {  
- id: number; 
- name: string; }
- test_view  : {  
- id: number; 
- name: string; 
- itemName: string; } }
+export default interface app_INF {
+  item: {
+    id: number
+    name: "pen" | "ruler"
+    price: number
+    description: string
+  }
+  user: {
+    id: number
+    name: string
+  }
+  test_view: {
+    id: number
+    name: string
+    itemName: string
+  }
+}

package/src/test/test.ts

@@ -1,48 +0,0 @@
-import { MyModel } from "../myModel"
-
-const model: MyModel[] = [
-  {
-    tableName: "user",
-    columns: [
-      {
-        COLUMN_NAME: "id",
-        DATA_TYPE: "int",
-        AUTO_INCREMENT: true,
-      },
-      {
-        COLUMN_NAME: "name",
-        DATA_TYPE: "varchar(512)",
-      },
-    ],
-    meaning: "",
-  },
-  {
-    tableName: "item",
-    columns: [
-      {
-        COLUMN_NAME: "id",
-        DATA_TYPE: "int",
-        AUTO_INCREMENT: true,
-      },
-      {
-        COLUMN_NAME: "name",
-        DATA_TYPE: "varchar(512)",
-        POSSIBLE_VALUE: ["pen", "ruler"],
-      },
-      {
-        COLUMN_NAME: "price",
-        DATA_TYPE: "float",
-      },
-      {
-        COLUMN_NAME: "description",
-        DATA_TYPE: "varchar(512)",
-      },
-    ],
-    meaning: "",
-  },
-]
-
-async function run() {
-  process.exit()
-}
-run()