express-endpoints-collection 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 pilotpirxie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,219 @@
+# express-endpoints-collection
+
+## Description
+
+This package provides easy to use helper for creating API endpoints in Express with TypeScript inference, validation and OpenAPI 3 schema out of the box.
+
+No need to duplicate OpenAPI definitions in your codebase. Just define your API endpoints and automatically generate OpenAPI 3 schema.
+
+You can configure exposed endpoints, request and response schemas, and validation rules.
+
+![output](./img/output1.png)
+
+## Features
+
+* Fully typed endpoints (TypeScript hints and checks)
+  * Request body
+  * Response body
+  * Query parameters
+  * Path parameters
+  * Headers
+* Automatic OpenAPI 3 schema generation
+* Request and response validation using Zod
+* Middleware support
+* Minimal setup
+
+## Installation
+
+```shell
+npm install express-endpoints-collection
+
+# or
+
+yarn add express-endpoints-collection
+
+# or
+
+pnpm add express-endpoints-collection
+```
+
+## Usage
+
+```typescript
+import express, { Express } from "express";
+import bodyParser from "body-parser";
+import { z } from "zod";
+import { EndpointsCollection } from "express-endpoints-collection";
+import { generateOpenAPI } from "express-endpoints-collection/generator";
+
+// 1. Create express app
+const app: Express = express();
+app.use(bodyParser.json());
+
+// 2. Create endpoints collection, this will store all your endpoints
+const endpointsCollection = new EndpointsCollection();
+
+// 3. Add new endpoint
+endpointsCollection.post(
+  "/add",
+  {
+    inputSchema: {
+      body: z.object({
+        a: z.number(),
+        b: z.number(),
+      }),
+    },
+    outputSchema: [
+      {
+        status: 200,
+        body: z.object({
+          result: z.number(),
+        }),
+      },
+    ],
+    summary: "Add two numbers",
+  },
+  // 4. req and res are fully typed!
+  (req, res) => {
+    const { a, b } = req.body;
+    res.json({ result: a + b });
+  },
+);
+
+// 5. Collection creates its own router, to use it just add it to your app
+app.use(endpointsCollection.getRouter());
+
+// 6. Expose OpenAPI 3 schema
+app.get("/openapi", (req, res) => {
+  res.json(
+    generateOpenAPI({
+      title: "Minimal demo",
+      version: "1.0.0",
+      endpoints: endpointsCollection.getEndpoints(),
+    }),
+  );
+});
+
+// 7. Start the server and done!
+app.listen(3000, () => {
+  console.info(`Server is running on port http://localhost:3000`);
+});
+```
+
+it will generate OpenAPI 3 definition as follow:
+
+```yaml
+openapi: 3.0.0
+info:
+  title: Minimal demo
+  version: 1.0.0
+components:
+  schemas: {}
+  parameters: {}
+paths:
+  /add:
+    post:
+      summary: Add two numbers
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                a:
+                  type: number
+                b:
+                  type: number
+              required:
+                - a
+                - b
+      responses:
+        '200':
+          description: Response for status code 200
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  result:
+                    type: number
+                required:
+                  - result
+```
+
+or as JSON
+
+```json
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Minimal demo",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {},
+    "parameters": {}
+  },
+  "paths": {
+    "/add": {
+      "post": {
+        "summary": "Add two numbers",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "a": {
+                    "type": "number"
+                  },
+                  "b": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "a",
+                  "b"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Response for status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "number"
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+## Example
+
+![output](./img/output0.png)
+
+Type inference and checks:
+
+![infer0](./img/infer0.png)
+
+![infer1](./img/infer1.png)
+
+### License
+MIT

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "express-endpoints-collection",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "repository": "https://github.com/pilotpirxie/express-endpoints-collection.git",
+  "author": "pilotpirxie <10637666+pilotpirxie@users.noreply.github.com>",
+  "license": "MIT",
+  "types": "./dist/index.d.ts",
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/jsonwebtoken": "^9.0.6",
+    "@types/node": "^20.14.9",
+    "body-parser": "^1.20.2",
+    "jsonwebtoken": "^9.0.2",
+    "node-cache": "^5.1.2",
+    "prettier": "3.3.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.5.2"
+  },
+  "scripts": {
+    "prettier": "prettier --write .",
+    "dev": "ts-node ./example/app.ts",
+    "minimal": "ts-node ./example/minimal.ts",
+    "build": "tsc"
+  },
+  "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^7.1.1",
+    "express": "^4.19.2",
+    "zod": "^3.23.8"
+  },
+  "files": [
+    "dist"
+  ]
+}