gg-express 1.0.25 → 1.0.26

package/dist/GGApi.js

@@ -70,9 +70,7 @@ 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", {});

package/dist/test.js

@@ -37,12 +37,13 @@ function run() {
     ggapp.post("/api/item", {
         requireParams: {
             parameter: {
-                bankID: "number",
+                lotNumber: "number",
             },
             dataType: "arrayObject",
             structure: {
                 id: "number",
                 name: "string",
+                price: "number",
             },
         },
         responseStructure: {
@@ -54,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.25",
+  "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,7 @@ 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" }],
   })
 

package/src/test.ts

@@ -38,12 +38,13 @@ function run() {
     {
       requireParams: {
         parameter: {
-          bankID: "number",
+          lotNumber: "number",
         },
         dataType: "arrayObject",
         structure: {
           id: "number",
           name: "string",
+          price: "number",
         },
       },
       responseStructure: {
@@ -56,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",