express-speed 1.0.5 → 1.0.7

package/README.md

@@ -21,9 +21,45 @@ npm install express-speed
 
 ---
 
-## Basic Usage
+## Quick Start
 
-Creating a simple page:
+```js
+import { expressSpeed } from "express-speed";
+
+expressSpeed.listen(80, {
+  page: {
+    render: ["./page/**/*.js"],
+    exclude: [],
+    nodir: true,
+  },
+  use: [
+    (req, res, next) => {
+      console.log("request received");
+      next();
+    },
+  ],
+  settings: {
+    "view engine": "pug",
+    views: "./pug",
+  },
+});
+```
+
+### `expressSpeed.listen` Options
+
+| Key | Type | Description |
+|-----|------|-------------|
+| `page.render` | `string[]` | Glob patterns to match page files |
+| `page.exclude` | `string[]` | Glob patterns to exclude |
+| `page.nodir` | `boolean` | Skip directories |
+| `use` | `function[]` | Global middleware applied to all routes |
+| `settings` | `object` | Express app settings (`view engine`, `views`, etc.) |
+
+---
+
+## Usage
+
+### Basic Page
 
 ```js
 import { pager } from "express-speed";
@@ -39,9 +75,7 @@ let page = pager
 export default page;
 ```
 
----
-
-## Multiple GET Handlers
+### Multiple Handlers
 
 You can define multiple handlers for the same route.
 
@@ -60,48 +94,7 @@ export default pager
   .build();
 ```
 
-This pattern works in line with Express middleware logic.
-
----
-
-## Sub Path Routes
-
-Use `get(path, handler)` to create different endpoints within the same pager. Sub paths must be written as full paths.
-
-```js
-import { pager } from "express-speed";
-
-export default pager
-  .url("/blog")
-
-  .get((req, res) => {
-    res.send("Blog Home");
-  })
-
-  .get("/blog/post/:id", (req, res) => {
-    res.send(`Post ${req.params.id}`);
-  })
-
-  .get("/blog/latest", (req, res) => {
-    res.send("Latest posts");
-  })
-
-  .build();
-```
-
-Generated routes:
-
-```
-/blog
-/blog/post/:id
-/blog/latest
-```
-
----
-
-## Middleware Usage
-
-You can add middleware inside a pager.
+### Middleware
 
 ```js
 import { pager } from "express-speed";
@@ -120,11 +113,7 @@ export default pager
   .build();
 ```
 
----
-
-## Role Based Access
-
-Restrict page access using roles.
+### Role Based Access
 
 ```js
 import { pager } from "express-speed";
@@ -138,40 +127,59 @@ export default pager
   .build();
 ```
 
----
-
-## API Endpoint Example
+### Sub Path Routes
 
-Pager can also be used for API endpoints.
+Use `get(path, handler)` to create different endpoints within the same pager.
 
 ```js
 import { pager } from "express-speed";
 
 export default pager
-  .url("/api/user")
+  .url("/blog")
   .get((req, res) => {
-    res.json({
-      name: "Murat",
-      role: "user",
-    });
+    res.send("Blog Home");
+  })
+  .get("/blog/post/:id", (req, res) => {
+    res.send(`Post ${req.params.id}`);
+  })
+  .get("/blog/latest", (req, res) => {
+    res.send("Latest posts");
   })
   .build();
 ```
 
----
+Generated routes:
 
-## GraphQL Integration
+```
+/blog
+/blog/post/:id
+/blog/latest
+```
 
-`express-speed` also supports GraphQL endpoints.
+### Router Style
 
-The following packages must be installed in your project:
+```js
+import { pager } from "express-speed";
+
+export default pager
+  .url("/api")
+  .get("/users", (req, res) => {
+    res.json(["user1", "user2"]);
+  })
+  .get("/products", (req, res) => {
+    res.json(["product1", "product2"]);
+  })
+  .build();
+```
+
+---
+
+## GraphQL Integration
 
 ```bash
 npm install express-graphql graphql
 ```
 
-### Basic GraphQL Example
-
 ```js
 import { pager } from "express-speed";
 import { graphqlHTTP } from "express-graphql";
@@ -199,76 +207,6 @@ export default pager
   .build();
 ```
 
-### GraphQLObjectType Schema Example
-
-`express-speed` also supports the classic GraphQL schema structure.
-
-```js
-import { pager } from "express-speed";
-import { graphqlHTTP } from "express-graphql";
-import { GraphQLObjectType, GraphQLString, GraphQLSchema } from "graphql";
-
-const UserType = new GraphQLObjectType({
-  name: "User",
-  fields: {
-    name: { type: GraphQLString },
-    surname: { type: GraphQLString },
-  },
-});
-
-const RootQuery = new GraphQLObjectType({
-  name: "RootQueryType",
-  fields: {
-    user: {
-      type: UserType,
-      resolve() {
-        return {
-          name: "Ali",
-          surname: "Yılmaz",
-        };
-      },
-    },
-  },
-});
-
-const schema = new GraphQLSchema({
-  query: RootQuery,
-});
-
-export default pager
-  .url("/graphql")
-  .use(
-    graphqlHTTP({
-      schema: schema,
-      graphiql: true,
-    }),
-  )
-  .build();
-```
-
----
-
-## Router Style Usage
-
-Pager can be used like a mini router.
-
-```js
-import { pager } from "express-speed";
-
-export default pager
-  .url("/api")
-
-  .get("/users", (req, res) => {
-    res.json(["user1", "user2"]);
-  })
-
-  .get("/products", (req, res) => {
-    res.json(["product1", "product2"]);
-  })
-
-  .build();
-```
-
 ---
 
 ## Features
@@ -278,7 +216,6 @@ export default pager
 - Role based access control
 - Multiple route handlers
 - Sub path routing
+- Global middleware and settings via `listen`
 - GraphQL integration
-- API and page route support
-
----
+- API and page route support

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "express-speed",
   "description": "A simple pager system for Express apps",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "main": "index.js",
   "type": "module",
   "files": [

package/src/expressSpeed.js

@@ -1,7 +1,6 @@
 // * ExpressSpeed mvc yapısına uygun daha hızlı şekilde kullanılabilir formatta
 // * Sayfalara özel Rol kontrol özelliği
 // * Graphql Uyumlu
-
 import express from "express";
 import { globSync } from "glob";
 import pager from "./pager.js";
@@ -20,12 +19,6 @@ let expressSpeed = {
     use: [],
     settings: {},
   },
-  trigger: {
-    start: {
-    },
-    end: {
-    }
-  },
   complier: {
     pagesMap(renderPathArrayValue, pageExcludeArrayValue, nodirBooleanValue) {
       const pageFiles = renderPathArrayValue.flatMap((pathValue) =>
@@ -56,36 +49,16 @@ let expressSpeed = {
       const app = expressSpeed.app;
       for (const router of pageObjectValue.methods) {
         let parameters = ("string" == typeof router.parameters[0]) ? [...router.parameters] : [router.url, ...router.parameters];
-        switch (router.method.toString().toLowerCase()) {
-          case "use":
-            app.use(...parameters);
-            break;
-          case "all":
-            app.all(...parameters);
-            break;
-          case "param":
-            app.param(...parameters);
-            break;
-          case "get":
-            app.get(...parameters);
-            break;
-          case "post":
-            app.post(...parameters);
-            break;
-          case "put":
-            app.put(...parameters);
-            break;
-          case "delete":
-            app.delete(...parameters);
-            break;
-
-          default:
-            break;
+        if (app[router.method.toString().toLowerCase()]) {
+          app[router.method.toString().toLowerCase()](...parameters);
         }
       }
     },
     async load() {
-      for (const useValue of expressSpeed.config.use) expressSpeed.app.use(useValue);
+      for (const useValue of expressSpeed.config.use) {
+        if (Array.isArray(useValue)) expressSpeed.app.use(...useValue);
+        else expressSpeed.app.use(useValue);
+      }
       for (let [setKey, setValue] of Object.entries(expressSpeed.config.settings)) expressSpeed.app.set(setKey, setValue);
       let pagesMap = expressSpeed.complier.pagesMap(expressSpeed.config.path.page.render, expressSpeed.config.path.page.exclude);
       let pages = await expressSpeed.complier.pagesImport(pagesMap);
@@ -102,21 +75,20 @@ let expressSpeed = {
   }) {
     if (typeof config.go == "function") config.go(expressSpeed);
     config.port = port;
-    if (typeof config == "object") {
-    }
-      expressSpeed.config.path.page = {
-        ...expressSpeed.config.path.page,
-        ...config.page
-      } || {};
-      expressSpeed.config.port = config.port || 80;
-      expressSpeed.config.use = config.use || [];
-      expressSpeed.config.settings = config.settings || {};
+    expressSpeed.config.path.page = {
+      ...expressSpeed.config.path.page,
+      ...config.page
+    } || {};
+    expressSpeed.config.port = config.port || 80;
+    expressSpeed.config.use = config.use || [];
+    expressSpeed.config.settings = config.settings || {};
 
     expressSpeed.complier.load();
     expressSpeed.app.listen(expressSpeed.config.port);
   },
 }
 
+
 expressSpeed.pager = pager;
 
 export default expressSpeed;

package/src/pager.d.ts

@@ -0,0 +1,47 @@
+type MethodHandler = (...args: any[]) => typeof pager;
+
+declare const pager: {
+    _id: number;
+    _config: {
+        url: string | null;
+        role: string | string[] | null;
+        usings: any[] | null;
+        methods: Array<{ url: string, method: string, parameters: any[] }>;
+    };
+    url(value: string): typeof pager;
+    role(value: string | string[]): typeof pager;
+    usings(value: any[]): typeof pager;
+    build(): object;
+
+    // Standart
+    use: MethodHandler;
+    param: MethodHandler;
+    all: MethodHandler;
+    get: MethodHandler;
+    post: MethodHandler;
+    put: MethodHandler;
+    delete: MethodHandler;
+    patch: MethodHandler;
+    head: MethodHandler;
+    options: MethodHandler;
+    // WebDAV
+    checkout: MethodHandler;
+    copy: MethodHandler;
+    lock: MethodHandler;
+    merge: MethodHandler;
+    mkactivity: MethodHandler;
+    mkcol: MethodHandler;
+    move: MethodHandler;
+    notify: MethodHandler;
+    propfind: MethodHandler;
+    proppatch: MethodHandler;
+    purge: MethodHandler;
+    report: MethodHandler;
+    search: MethodHandler;
+    subscribe: MethodHandler;
+    trace: MethodHandler;
+    unlock: MethodHandler;
+    unsubscribe: MethodHandler;
+};
+
+export default pager;

package/src/pager.js

@@ -1,4 +1,11 @@
-// * Sayfa yapısını oluşturan obje haline getiren zincir fonksiyonlar
+const HTTP_METHODS = [
+    "use", "param", "all",
+    "get", "post", "put", "delete", "patch", "head", "options",
+    "checkout", "copy", "lock", "merge", "mkactivity",
+    "mkcol", "move", "notify", "propfind", "proppatch",
+    "purge", "report", "search", "subscribe", "trace",
+    "unlock", "unsubscribe"
+];
 
 const pager = {
     _id: 0,
@@ -7,17 +14,6 @@ const pager = {
         role: null,
         usings: null,
         methods: [],
-        // method: {
-        //     use: null,
-        //     all: null,
-        //     param: null,
-        //     get: null,
-        //     post: null,
-        //     put: null,
-        //     delete: null,
-        // },
-        render: null,
-        renderConfig: null,
     },
     url(urlStringValue) {
         pager._config.url = urlStringValue;
@@ -31,74 +27,6 @@ const pager = {
         pager._config.usings = usingsArrayValue;
         return pager;
     },
-    use(...useVariableValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "use",
-            parameters: [...useVariableValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    param(...paramVariableValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "param",
-            parameters: [...paramVariableValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    all(...allFunctionValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "all",
-            parameters: [...allFunctionValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    get(...getFunctionValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "get",
-            parameters: [...getFunctionValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    post(...postFunctionValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "post",
-            parameters: [...postFunctionValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    put(...putFunctionValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "put",
-            parameters: [...putFunctionValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    delete(...deleteFunctionValue) {
-        pager._config.methods.push({
-            url: pager._config.url,
-            method: "delete",
-            parameters: [...deleteFunctionValue],
-        });
-        // ? delete pager.url;
-        return pager;
-    },
-    // render(renderStringValue, renderObjectConfiguration = {}) {
-    //     pager._config.render = renderStringValue;
-    //     pager._config.renderConfig = renderObjectConfiguration;
-    //     return pager;
-    // },
     build() {
         const data = { ...pager._config }
         pager._config = {
@@ -107,20 +35,20 @@ const pager = {
             usings: [],
             settings: [],
             methods: [],
-            // method: {
-            //     use: null,
-            //     all: null,
-            //     param: null,
-            //     get: null,
-            //     post: null,
-            //     put: null,
-            //     delete: null,
-            // },
-            render: null,
-            renderConfig: null,
         };
         return data;
     },
-}
+};
+
+HTTP_METHODS.forEach(method => {
+    pager[method] = (...args) => {
+        pager._config.methods.push({
+            url: pager._config.url,
+            method,
+            parameters: [...args],
+        });
+        return pager;
+    };
+});
 
 export default pager;