gg-express 1.0.43 → 1.0.44

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "gg-express",
-  "version": "1.0.43",
+  "version": "1.0.44",
   "description": "",
   "main": "dist/GGExpress.js",
   "scripts": {
     "build": "npm version patch && tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
-  "author": "",
+  "author": "goomgum",
   "license": "ISC",
   "dependencies": {
     "@types/axios": "^0.14.0",
@@ -20,5 +20,15 @@
   },
   "devDependencies": {
     "@types/express": "^5.0.0"
-  }
+  },
+  "keywords": [
+    "express",
+    "typescript",
+    "api",
+    "wrapper",
+    "type-safe",
+    "backend",
+    "frontend",
+    "api-connector"
+  ]
 }

package/readme.md

@@ -1,39 +1,37 @@
-# GG-Express
+# 🚀 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
+## ✨ 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.
+- **Strict Type Enforcement**: Ensures that `req.query` and `req.body` follow the declared types.
+- **Auto-Generated API Connector**: Automatically creates a static API class for strongly-typed parameters.
+- **Seamless Front-End Integration**: Simplifies the connection between the back-end and front-end by enforcing consistency.
 
+## 🔑 Key Points
 
-## Key Points
+- **Strict Parameter Enforcement**: GG-Express ensures only the declared parameters are accessible in `req.body` or `req.query`.
+- **Type-Safe Responses**: Ensures that the backend responds with a structure that matches front-end expectations.
+- **API Connector Generation**: It automatically generates a type-safe API connector class file for the front-end.
 
-- Strict Parameter Enforcement: GG-Express ensures that only the declared parameters are accessible in your req.body or req.query.
+## 🛠 Installation
 
-- 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
 ```bash
 npm install gg-express
 ```
 
-use case
-```javascript 
+🧑‍💻 Use Case in Backend
 
-const express = require('express');
-const GGExpress = require('gg-express');  // Import GG-Express
-const app = express();
+```typescript
+import express from "express"
+import GGExpress from "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
-]);
+  "./server/output-path-for-apiConnector.ts", // Path to generate apiConnector.ts backend file
+  "./myapp/output-path-for-apiConnector.ts", // Path to generate apiConnector.ts frontend file
+])
 
 // Example of a POST request with enforced parameters
 ggapp.post(
@@ -58,22 +56,10 @@ ggapp.post(
     },
   },
   (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
+    // Access only the required parameters declared above
+    const data = req.body.data
+
+    // Response structure follows the predefined format
     return res.json({
       message: "",
       status: "SUCCESS",
@@ -82,15 +68,49 @@ ggapp.post(
         itemName: "",
         numberOfPeople: 2,
       },
-    });
+    })
   }
-);
+)
 
 // Start the server and generate the API files
 app.listen(3000, () => {
-  ggapp.generateAPIFiles();  // Generates the apiConnector class for front-end use
-});
+  ggapp.generateAPIFiles() // Generates the apiConnector class for front-end use
+})
+```
 
+📲 Use Case in Frontend
+• The apiConnector.ts file will be automatically generated by the GGExpress class you configured in the backend
 
+```typescript
+import GGApi from "apiConnector.ts"
+
+const api = new GGApi()
+const response = await api.post("/api/item", {
+  parameter: {
+    lotNumber: 2,
+  },
+  data: [
+    {
+      id: 1032,
+      name: "machete",
+      price: 4599,
+    },
+  ],
+})
+console.log(response.data)
+// Expected data structure:
+//  parameter: { numberOfPeople: number, itemName: string },
+//       structure: {
+//         id: number,
+//         name: string,
+//       }[],
+// }
 ```
 
+## 🔑 Keywords
+
+- Express.js
+- TypeScript
+- API wrapper
+- Type-safe API
+- Backend-frontend integration