gg-express 1.0.25 → 1.0.27

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.27",
   "description": "",
   "main": "dist/GGExpress.js",
   "scripts": {

package/readme.md

@@ -0,0 +1,109 @@
+# GG-Express
+
+**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.
+
+
+## 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
+
+You can install this package using npm or yarn:
+
+```bash
+# Using npm
+npm install gg-express
+```
+
+use case
+```javascript 
+
+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",
+      },
+    },
+  },
+  (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,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",