gg-express 1.0.26 → 1.0.29

package/dist/GGApi.js

@@ -70,8 +70,8 @@ function run() {
     return __awaiter(this, void 0, void 0, function* () {
         const api = new GGApi();
         const data = yield api.post("/api/item", {
-            parameter: { bankID: 2 },
-            data: [{ id: 2, name: "2" }],
+            parameter: { lotNumber: 1223 },
+            data: [],
         });
         const data2 = yield api.get("/api/users", {});
         data.data;

package/dist/GGExpress.js

@@ -14,6 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
 const myExpressRouteList = [];
 class GGExpress {
     constructor(app, outputPath) {
@@ -112,7 +113,16 @@ class GGExpress {
                 let rawString = ``;
                 if (data.length === 0)
                     return "";
-                rawString = data
+                const filterDuplicateUrlOut = [];
+                for (let row of data) {
+                    const temp = filterDuplicateUrlOut.filter((fRow) => fRow.method === row.method && fRow.url === row.url);
+                    if (temp.length <= 0)
+                        filterDuplicateUrlOut.push(row);
+                    else {
+                        console.log(chalk_1.default.yellow(`!!! found duplicate url ${row.method} : ${row.url} -- system will keep only first one it found.`));
+                    }
+                }
+                rawString = filterDuplicateUrlOut
                     .map((row) => {
                     const parameterCode = genParamCodeParameter(row.requireParams);
                     const parameterDataCode = genDataParamCode(row.requireParams);

package/dist/staticRouteInterface.d.ts

@@ -20,11 +20,12 @@ export interface staticRouteInterface {
         "/api/item": {
             requireParams: {
                 parameter: {
-                    bankID: number;
+                    lotNumber: number;
                 };
                 data: {
                     id: number;
                     name: string;
+                    price: number;
                 }[];
             };
             responseStructure: {

package/dist/test.js

@@ -34,6 +34,32 @@ function run() {
             },
         });
     });
+    ggapp.get("/api/users", {
+        requireParams: {
+            parameter: {},
+            dataType: "singleObject",
+            structure: {},
+        },
+        responseStructure: {
+            parameter: { numberOfPeople: "number", itemName: "string" },
+            dataType: "arrayObject",
+            structure: {
+                id: "number",
+                name: "string",
+            },
+        },
+    }, (req, res, next) => {
+        const data = req.body.data.parameter;
+        return res.json({
+            message: "",
+            status: "SUCCESS",
+            data: [],
+            parameter: {
+                itemName: "",
+                numberOfPeople: 2,
+            },
+        });
+    });
     ggapp.post("/api/item", {
         requireParams: {
             parameter: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gg-express",
-  "version": "1.0.26",
+  "version": "1.0.29",
   "description": "",
   "main": "dist/GGExpress.js",
   "scripts": {
@@ -13,6 +13,7 @@
     "@types/axios": "^0.14.0",
     "app-root-path": "^3.1.0",
     "axios": "^1.7.7",
+    "chalk": "^4.1.2",
     "express": "^4.21.1",
     "fs": "^0.0.1-security",
     "path": "^0.12.7"

package/readme.md

@@ -1,14 +1,30 @@
 # GG-Express
 
-this is express wrapper. that force method get,post,put,delete to have strong require req.query and req.body structure and generate apiConnector class file for using in any front end
+**GG-Express** is an Express.js wrapper that enforces strong type requirements for `GET`, `POST`, `PUT`, and `DELETE` methods. It ensures that `req.query` and `req.body` follow strict structure definitions and automatically generates an `apiConnector` class file for easy use in front-end development.
 
+## Features
 
+- Enforces required request (`req.query` and `req.body`) and response parameter types for `GET`, `POST`, `PUT`, and `DELETE` methods in Express.
+- Automatically generates a static API URL class that strongly types parameters and auto-casts return types to match the backend's response structure.
+- Simplifies integrating strong typing between back-end and front-end.
 
 
-## Features
-- force express method get,post,put,delete to have strong require and response parameter  
-- generate strong static api url class combo with force require parameter and auto cast return type same as backend
+## Key Points
+
+- Strict Parameter Enforcement: GG-Express ensures that only the declared parameters are accessible in your req.body or req.query.
+
+- Type-Safe Responses: You can only return data that follows the predefined responseStructure, improving consistency between backend and frontend.
+
+- API Connector Generation: It automatically generates an API connector class file for your front-end, making API calls more reliable and type-safe.
+
+## Installation
+
+Install the package using either `npm` or `yarn`:
+
+### Using npm:
 
+```bash
+npm install gg-express
 
 ## Installation
 
@@ -22,70 +38,72 @@ npm install gg-express
 use case
 ```javascript 
 
-const app = express()
-
-const ggapp = new GGExpress(app,
-[
-    './server/location-for-generating-file', # example path to backend
-    './myapp/location-for-generating-file', # example path to frontend
-])
-
-// example force parameter
-    ggapp.post(
-    "/api/item",
-    {
-      requireParams: {
-        parameter: {
-          lotNumber: "number",
-        },
-        dataType: "arrayObject",
-        structure: {
-          id: "number",
-          name: "string",
-          price: "number",
-        },
+const express = require('express');
+const GGExpress = require('gg-express');  // Import GG-Express
+const app = express();
+
+// Initialize GG-Express with backend and frontend file paths
+const ggapp = new GGExpress(app, [
+  './server/location-for-generating-file',  // Path to generate backend file
+  './myapp/location-for-generating-file',   // Path to generate frontend file
+]);
+
+// Example of a POST request with enforced parameters
+ggapp.post(
+  "/api/item",
+  {
+    requireParams: {
+      parameter: { lotNumber: "number" },
+      dataType: "arrayObject",
+      structure: {
+        id: "number",
+        name: "string",
+        price: "number",
       },
-      responseStructure: {
-        parameter: { numberOfPeople: "number", itemName: "string" },
-        dataType: "arrayObject",
-        structure: {
-          id: "number",
-          name: "string",
-        },
+    },
+    responseStructure: {
+      parameter: { numberOfPeople: "number", itemName: "string" },
+      dataType: "arrayObject",
+      structure: {
+        id: "number",
+        name: "string",
       },
     },
-    (req, res, next) => {
-      //  in body or query, you can access only requireParams that you declare at start
-      const data = req.body.data
-      //data structure 
-      /* 
-         data: {
-            parameter: {
-                lotNumber: number;
-            };
-            data: {
-                id: number;
-                name: string;
-                price: number;
-            }[];
-        }
-        */
-
-      //  also res.json, you can access only return like responseStructure that you declare at start
-      return res.json({
-        message: "",
-        status: "SUCCESS",
-        data: [],
-        parameter: {
-          itemName: "",
-          numberOfPeople: 2,
-        },
-      })
-    }
-  )
-
-   app.listen(3000, () => {
-    ggapp.generateAPIFiles() // this will generate apiConnector class file that you can use in front end
-  })
-
-```
+  },
+  (req, res, next) => {
+    // You can only access the required parameters declared above
+    const data = req.body.data;
+
+    // Expected data structure:
+    // data: {
+    //   parameter: {
+    //     lotNumber: number;
+    //   };
+    //   data: [{
+    //     id: number;
+    //     name: string;
+    //     price: number;
+    //   }];
+    // }
+
+    // Response structure also follows the predefined format
+    return res.json({
+      message: "",
+      status: "SUCCESS",
+      data: [],
+      parameter: {
+        itemName: "",
+        numberOfPeople: 2,
+      },
+    });
+  }
+);
+
+// Start the server and generate the API files
+app.listen(3000, () => {
+  ggapp.generateAPIFiles();  // Generates the apiConnector class for front-end use
+});
+
+
+```
+

package/src/GGApi.ts

@@ -70,8 +70,8 @@ export class GGApi {
 async function run() {
   const api = new GGApi()
   const data = await api.post("/api/item", {
-    parameter: { bankID: 2 },
-    data: [{ id: 2, name: "2" }],
+    parameter: { lotNumber: 1223 },
+    data: [],
   })
 
   const data2 = await api.get("/api/users", {})

package/src/GGExpress.ts

@@ -3,6 +3,8 @@ import { NextFunction, Request, Response } from "express"
 import Express from "express-serve-static-core"
 import fs from "fs"
 import path from "path"
+import chalk from "chalk"
+
 // export { GGApi } from "./GGApi"
 type Unarray<T> = T extends (infer U)[] ? U : T
 type AsConstArray<T extends readonly any[]> = [...T]
@@ -302,7 +304,23 @@ export default class GGExpress {
     const genInterfaceString = (data: typeof myExpressRouteList) => {
       let rawString = ``
       if (data.length === 0) return ""
-      rawString = data
+
+      const filterDuplicateUrlOut: typeof data = []
+      for (let row of data) {
+        const temp = filterDuplicateUrlOut.filter(
+          (fRow) => fRow.method === row.method && fRow.url === row.url
+        )
+        if (temp.length <= 0) filterDuplicateUrlOut.push(row)
+        else {
+          console.log(
+            chalk.yellow(
+              `!!! found duplicate url ${row.method} : ${row.url} -- system will keep only first one it found.`
+            )
+          )
+        }
+      }
+
+      rawString = filterDuplicateUrlOut
         .map((row) => {
           const parameterCode = genParamCodeParameter(row.requireParams)
           const parameterDataCode = genDataParamCode(row.requireParams)

package/src/staticRouteInterface.ts

@@ -7,7 +7,7 @@ export interface staticRouteInterface {
           parameter : { numberOfPeople : number, itemName : string}, data : {  id : number, name : string } []}
         }  },
         post : {  "/api/item" : { 
-          requireParams : { parameter:{ bankID : number} , data:{ id : number, name : string}[]},
+          requireParams : { parameter:{ lotNumber : number} , data:{ id : number, name : string, price : number}[]},
           responseStructure : { 
           status : "SUCCESS" | "ERROR",
           message : string,

package/src/test.ts

@@ -3,6 +3,37 @@ import express, { Express } from "express"
 function run() {
   const app = express()
   const ggapp = new GGExpress(app, ["./"])
+  ggapp.get(
+    "/api/users",
+    {
+      requireParams: {
+        parameter: {},
+        dataType: "singleObject",
+        structure: {},
+      },
+      responseStructure: {
+        parameter: { numberOfPeople: "number", itemName: "string" },
+        dataType: "arrayObject",
+        structure: {
+          id: "number",
+          name: "string",
+        },
+      },
+    },
+    (req, res, next) => {
+      const data = req.body.data.parameter
+      return res.json({
+        message: "",
+        status: "SUCCESS",
+        data: [],
+        parameter: {
+          itemName: "",
+          numberOfPeople: 2,
+        },
+      })
+    }
+  )
+
   ggapp.get(
     "/api/users",
     {