@guanghechen/middleware 1.0.6 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+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,131 @@
+<header>
+  <h1 align="center">
+    <a href="https://github.com/guanghechen/sora/tree/@guanghechen/middleware@2.0.0/packages/middleware#readme">@guanghechen/middleware</a>
+  </h1>
+  <div align="center">
+    <a href="https://www.npmjs.com/package/@guanghechen/middleware">
+      <img
+        alt="Npm Version"
+        src="https://img.shields.io/npm/v/@guanghechen/middleware.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/middleware">
+      <img
+        alt="Npm Download"
+        src="https://img.shields.io/npm/dm/@guanghechen/middleware.svg"
+      />
+    </a>
+    <a href="https://www.npmjs.com/package/@guanghechen/middleware">
+      <img
+        alt="Npm License"
+        src="https://img.shields.io/npm/l/@guanghechen/middleware.svg"
+      />
+    </a>
+    <a href="#install">
+      <img
+        alt="Module Formats: cjs, esm"
+        src="https://img.shields.io/badge/module_formats-cjs%2C%20esm-green.svg"
+      />
+    </a>
+    <a href="https://github.com/nodejs/node">
+      <img
+        alt="Node.js Version"
+        src="https://img.shields.io/node/v/@guanghechen/middleware"
+      />
+    </a>
+    <a href="https://github.com/facebook/jest">
+      <img
+        alt="Tested with Jest"
+        src="https://img.shields.io/badge/tested_with-jest-9c465e.svg"
+      />
+    </a>
+    <a href="https://github.com/prettier/prettier">
+      <img
+        alt="Code Style: prettier"
+        src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"
+      />
+    </a>
+  </div>
+</header>
+<br/>
+
+Middleware pattern implementation for both synchronous and asynchronous processing pipelines.
+
+## Install
+
+- npm
+
+  ```bash
+  npm install --save @guanghechen/middleware
+  ```
+
+- yarn
+
+  ```bash
+  yarn add @guanghechen/middleware
+  ```
+
+## Usage
+
+|        Name         |                        Description                        |
+| :-----------------: | :-------------------------------------------------------: |
+| `AsyncMiddlewares`  |   Asynchronous middleware chain for processing data      |
+|   `Middlewares`     |   Synchronous middleware chain for processing data       |
+
+## Example
+
+- Async middleware:
+
+  ```typescript
+  import { AsyncMiddlewares } from '@guanghechen/middleware'
+
+  const middlewares = new AsyncMiddlewares<string, string, { prefix: string }>()
+
+  // Add middlewares (executed in registration order)
+  middlewares.use(async (input, embryo, api, next) => {
+    // Transform input to uppercase, pass to next middleware
+    return next(input.toUpperCase())
+  })
+
+  middlewares.use(async (input, embryo, api, next) => {
+    // Wrap with brackets, embryo contains result from previous middleware
+    return next(embryo ? `[${embryo}]` : null)
+  })
+
+  middlewares.use(async (input, embryo, api, next) => {
+    // Add prefix from api
+    return embryo ? `${api.prefix}${embryo}` : null
+  })
+
+  // Execute middleware chain
+  const reducer = middlewares.reducer('hello', { prefix: '> ' })
+  const result = await reducer(null) // Result: "> [HELLO]"
+  ```
+
+- Sync middleware:
+
+  ```typescript
+  import { Middlewares } from '@guanghechen/middleware'
+
+  const middlewares = new Middlewares<number, number, { multiplier: number }>()
+
+  middlewares.use((input, embryo, api, next) => {
+    // First middleware: multiply input
+    return next(input * api.multiplier)
+  })
+
+  middlewares.use((input, embryo, api, next) => {
+    // Second middleware: add 1 to embryo (result from previous)
+    return embryo !== null ? embryo + 1 : null
+  })
+
+  const reducer = middlewares.reducer(5, { multiplier: 2 })
+  const result = reducer(null) // Result: 11 (5 * 2 + 1)
+  ```
+
+## Reference
+
+- [homepage][homepage]
+
+[homepage]:
+  https://github.com/guanghechen/sora/tree/@guanghechen/middleware@2.0.0/packages/middleware#readme

package/lib/types/index.d.ts

@@ -1,9 +1,5 @@
-interface IAsyncMiddlewareNext<Output> {
-    (embryo: Readonly<Output | null>): Promise<Output | null>;
-}
-interface IAsyncMiddleware<Input, Output, Api> {
-    (input: Readonly<Input>, embryo: Readonly<Output> | null, api: Readonly<Api>, next: IAsyncMiddlewareNext<Output>): Promise<Output | null>;
-}
+type IAsyncMiddlewareNext<Output> = (embryo: Readonly<Output | null>) => Promise<Output | null>;
+type IAsyncMiddleware<Input, Output, Api> = (input: Readonly<Input>, embryo: Readonly<Output> | null, api: Readonly<Api>, next: IAsyncMiddlewareNext<Output>) => Promise<Output | null>;
 interface IAsyncMiddlewares<Input, Output, Api> {
     /**
      * Use a middleware.
@@ -24,12 +20,8 @@ declare class AsyncMiddlewares<Input, Output, Api> implements IAsyncMiddlewares<
     reducer(input: Readonly<Input>, api: Readonly<Api>): IAsyncMiddlewareNext<Output>;
 }
 
-interface IMiddlewareNext<Output> {
-    (embryo: Readonly<Output | null>): Output | null;
-}
-interface IMiddleware<Input, Output, Api> {
-    (input: Readonly<Input>, embryo: Readonly<Output> | null, api: Readonly<Api>, next: IMiddlewareNext<Output>): Output | null;
-}
+type IMiddlewareNext<Output> = (embryo: Readonly<Output | null>) => Output | null;
+type IMiddleware<Input, Output, Api> = (input: Readonly<Input>, embryo: Readonly<Output> | null, api: Readonly<Api>, next: IMiddlewareNext<Output>) => Output | null;
 interface IMiddlewares<Input, Output, Api> {
     /**
      * Use a middleware.
@@ -50,4 +42,5 @@ declare class Middlewares<Input, Output, Api> implements IMiddlewares<Input, Out
     reducer(input: Readonly<Input>, api: Readonly<Api>): IMiddlewareNext<Output>;
 }
 
-export { AsyncMiddlewares, type IAsyncMiddleware, type IAsyncMiddlewareNext, type IAsyncMiddlewares, type IMiddleware, type IMiddlewareNext, type IMiddlewares, Middlewares };
+export { AsyncMiddlewares, Middlewares };
+export type { IAsyncMiddleware, IAsyncMiddlewareNext, IAsyncMiddlewares, IMiddleware, IMiddlewareNext, IMiddlewares };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/middleware",
-  "version": "1.0.6",
+  "version": "2.0.1",
   "description": "types of @guanghechen/middleware",
   "author": {
     "name": "guanghechen",
@@ -8,17 +8,17 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/middleware@1.0.5",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/middleware@2.0.0",
     "directory": "packages/middleware"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/middleware@1.0.5/packages/middleware#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/middleware@2.0.0/packages/middleware#readme",
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -34,5 +34,11 @@
     "LICENSE",
     "README.md"
   ],
-  "gitHead": "c46c7cc64c02c61047fbc7dff2ce8f6b21d4da2c"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}