gg-express 1.0.24 → 1.0.26

package/dist/GGApi.js

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

package/dist/GGExpress.js

@@ -49,7 +49,7 @@ class GGExpress {
     generateStaticRouteFile() {
         return __awaiter(this, void 0, void 0, function* () {
             const genParamCodeParameter = (data) => {
-                let result;
+                let result = "";
                 const resultArray = Object.entries(data["parameter"]).map(([key, value]) => ({
                     name: key,
                     value: value,
@@ -74,8 +74,8 @@ class GGExpress {
                     .join(",");
                 return result;
             };
-            const genParamCode = (data) => {
-                let result;
+            const genDataParamCode = (data) => {
+                let result = "";
                 const resultArray = Object.entries(data["structure"]).map(([key, value]) => ({
                     name: key,
                     value: value,
@@ -114,12 +114,29 @@ class GGExpress {
                     return "";
                 rawString = data
                     .map((row) => {
+                    const parameterCode = genParamCodeParameter(row.requireParams);
+                    const parameterDataCode = genDataParamCode(row.requireParams);
+                    const requireParameterCode = () => {
+                        if (parameterCode === "")
+                            return "";
+                        else
+                            return ` parameter:{${parameterCode}} `;
+                    };
+                    const requireDataCode = () => {
+                        if (parameterDataCode === "")
+                            return "";
+                        else
+                            return ` data:{${parameterDataCode}}${isArray(row.requireParams)}`;
+                    };
+                    let requireParamCode = `{${[requireParameterCode(), requireDataCode()]
+                        .filter((row) => row.length > 0)
+                        .join(",")}}`;
                     return ` "${row.url}" : { 
-          requireParams : { parameter : {${genParamCodeParameter(row.requireParams)}}, data : { ${genParamCode(row.requireParams)} }${isArray(row.requireParams)}},
+          requireParams : ${requireParamCode},
           responseStructure : { 
           status : "SUCCESS" | "ERROR",
           message : string,
-          parameter : {${genParamCodeParameter(row.responseStructure)}}, data : { ${genParamCode(row.responseStructure)} } ${isArray(row.responseStructure)}}
+          parameter : {${genParamCodeParameter(row.responseStructure)}}, data : { ${genDataParamCode(row.responseStructure)} } ${isArray(row.responseStructure)}}
         } `;
                 })
                     .join(",");

package/dist/apiConnector.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -66,15 +57,3 @@ class GGApi {
     }
 }
 exports.GGApi = GGApi;
-function run() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const api = new GGApi();
-        const data = yield api.post("/api/item", {
-            parameter: {
-                bankID: 1,
-            },
-            data: [{ id: 2, name: "2" }],
-        });
-        data.data;
-    });
-}

package/dist/staticRouteInterface.d.ts

@@ -1,5 +1,21 @@
 export interface staticRouteInterface {
-    get: {};
+    get: {
+        "/api/users": {
+            requireParams: {};
+            responseStructure: {
+                status: "SUCCESS" | "ERROR";
+                message: string;
+                parameter: {
+                    numberOfPeople: number;
+                    itemName: string;
+                };
+                data: {
+                    id: number;
+                    name: string;
+                }[];
+            };
+        };
+    };
     post: {
         "/api/item": {
             requireParams: {

package/dist/test.js

@@ -8,15 +8,42 @@ const express_1 = __importDefault(require("express"));
 function run() {
     const app = (0, express_1.default)();
     const ggapp = new GGExpress_1.default(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.post("/api/item", {
         requireParams: {
             parameter: {
-                bankID: "number",
+                lotNumber: "number",
             },
             dataType: "arrayObject",
             structure: {
                 id: "number",
                 name: "string",
+                price: "number",
             },
         },
         responseStructure: {
@@ -28,7 +55,21 @@ function run() {
             },
         },
     }, (req, res, next) => {
-        const data = req.body.data.parameter;
+        //  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  only return structure like responseStructure that you declare at start
         return res.json({
             message: "",
             status: "SUCCESS",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gg-express",
-  "version": "1.0.24",
+  "version": "1.0.26",
   "description": "",
   "main": "dist/GGExpress.js",
   "scripts": {

package/readme.md

@@ -0,0 +1,91 @@
+# 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
+
+
+
+
+## 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
+
+
+## Installation
+
+You can install this package using npm or yarn:
+
+```bash
+# Using npm
+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",
+        },
+      },
+      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
+  })
+
+```

package/src/GGApi.ts

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

package/src/GGExpress.ts

@@ -246,7 +246,7 @@ export default class GGExpress {
   }
   private async generateStaticRouteFile() {
     const genParamCodeParameter = (data: requireParamsStructure) => {
-      let result: string
+      let result: string = ""
       const resultArray = Object.entries(data["parameter"]).map(
         ([key, value]) => ({
           name: key,
@@ -269,8 +269,8 @@ export default class GGExpress {
         .join(",")
       return result
     }
-    const genParamCode = (data: requireParamsStructure) => {
-      let result: string
+    const genDataParamCode = (data: requireParamsStructure) => {
+      let result: string = ""
       const resultArray = Object.entries(data["structure"]).map(
         ([key, value]) => ({
           name: key,
@@ -304,18 +304,30 @@ export default class GGExpress {
       if (data.length === 0) return ""
       rawString = data
         .map((row) => {
+          const parameterCode = genParamCodeParameter(row.requireParams)
+          const parameterDataCode = genDataParamCode(row.requireParams)
+
+          const requireParameterCode = () => {
+            if (parameterCode === "") return ""
+            else return ` parameter:{${parameterCode}} `
+          }
+          const requireDataCode = () => {
+            if (parameterDataCode === "") return ""
+            else
+              return ` data:{${parameterDataCode}}${isArray(row.requireParams)}`
+          }
+          let requireParamCode = `{${[requireParameterCode(), requireDataCode()]
+            .filter((row) => row.length > 0)
+            .join(",")}}`
+
           return ` "${row.url}" : { 
-          requireParams : { parameter : {${genParamCodeParameter(
-            row.requireParams
-          )}}, data : { ${genParamCode(row.requireParams)} }${isArray(
-            row.requireParams
-          )}},
+          requireParams : ${requireParamCode},
           responseStructure : { 
           status : "SUCCESS" | "ERROR",
           message : string,
           parameter : {${genParamCodeParameter(
             row.responseStructure
-          )}}, data : { ${genParamCode(row.responseStructure)} } ${isArray(
+          )}}, data : { ${genDataParamCode(row.responseStructure)} } ${isArray(
             row.responseStructure
           )}}
         } `

package/src/apiConnector.ts

@@ -1,4 +1,5 @@
-import axios from "axios"
+
+    import axios from "axios"
 import { staticRouteInterface } from "./staticRouteInterface"
 
 export class GGApi {
@@ -67,13 +68,5 @@ export class GGApi {
   }
 }
 
-async function run() {
-  const api = new GGApi()
-  const data = await api.post("/api/item", {
-    parameter: {
-      bankID: 1,
-    },
-    data: [{ id: 2, name: "2" }],
-  })
-  data.data
-}
+
+    

package/src/staticRouteInterface.ts

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

package/src/test.ts

@@ -3,17 +3,48 @@ 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.post(
     "/api/item",
     {
       requireParams: {
         parameter: {
-          bankID: "number",
+          lotNumber: "number",
         },
         dataType: "arrayObject",
         structure: {
           id: "number",
           name: "string",
+          price: "number",
         },
       },
       responseStructure: {
@@ -26,7 +57,22 @@ function run() {
       },
     },
     (req, res, next) => {
-      const data = req.body.data.parameter
+      //  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  only return structure like responseStructure that you declare at start
       return res.json({
         message: "",
         status: "SUCCESS",