gg-express 1.0.26 → 1.0.27

package/package.json

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

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
+});
+
+
+```
+