@philiprehberger/middleware-ts 0.1.3 → 0.2.0

package/README.md

@@ -1,21 +1,21 @@
-# @philiprehberger/ts-middleware
+# @philiprehberger/middleware-ts
 
-[![CI](https://github.com/philiprehberger/ts-middleware/actions/workflows/publish.yml/badge.svg)](https://github.com/philiprehberger/ts-middleware/actions/workflows/publish.yml)
-[![npm version](https://img.shields.io/npm/v/@philiprehberger/ts-middleware.svg)](https://www.npmjs.com/package/@philiprehberger/ts-middleware)
-[![License](https://img.shields.io/github/license/philiprehberger/ts-middleware)](LICENSE)
+[![CI](https://github.com/philiprehberger/ts-middleware/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/ts-middleware/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/@philiprehberger/middleware-ts.svg)](https://www.npmjs.com/package/@philiprehberger/middleware-ts)
+[![Last updated](https://img.shields.io/github/last-commit/philiprehberger/ts-middleware)](https://github.com/philiprehberger/ts-middleware/commits/main)
 
-Framework-agnostic middleware composition engine.
+Framework-agnostic middleware composition engine
 
 ## Installation
 
 ```bash
-npm install @philiprehberger/ts-middleware
+npm install @philiprehberger/middleware-ts
 ```
 
 ## Usage
 
 ```ts
-import { compose, createPipeline } from '@philiprehberger/ts-middleware';
+import { compose, createPipeline } from '@philiprehberger/middleware-ts';
 
 type Ctx = { req: Request; user?: User };
 
@@ -31,7 +31,7 @@ await app({ req: new Request('/api') });
 ### Conditional Branching
 
 ```ts
-import { branch } from '@philiprehberger/ts-middleware';
+import { branch } from '@philiprehberger/middleware-ts';
 
 const authBranch = branch(
   (ctx) => ctx.req.url.startsWith('/api'),
@@ -40,6 +40,27 @@ const authBranch = branch(
 );
 ```
 
+### Timeout
+
+```ts
+import { withTimeout, MiddlewareTimeoutError } from '@philiprehberger/middleware-ts';
+
+const slowOp = withTimeout(async (ctx, next) => {
+  await fetchSomethingSlow(ctx);
+  await next();
+}, 5000);
+```
+
+### Tap (Side Effects)
+
+```ts
+import { tap } from '@philiprehberger/middleware-ts';
+
+const logger = tap<Ctx>((ctx) => {
+  console.log(`[req] ${ctx.req.url}`);
+});
+```
+
 ## API
 
 | Function | Description |
@@ -48,7 +69,8 @@ const authBranch = branch(
 | `createPipeline<Ctx>()` | Builder with `.use()` and `.useIf()` |
 | `branch(condition, trueMw, falseMw?)` | Conditional middleware |
 | `withErrorHandler(mw, handler)` | Wrap with error catching |
-
+| `withTimeout(mw, ms)` | Reject with `MiddlewareTimeoutError` if `mw` exceeds `ms` |
+| `tap(fn)` | Run a side-effect and continue the pipeline |
 
 ## Development
 
@@ -58,6 +80,24 @@ npm run build
 npm test
 ```
 
+## Support
+
+If you find this project useful:
+
+⭐ [Star the repo](https://github.com/philiprehberger/ts-middleware)
+
+🐛 [Report issues](https://github.com/philiprehberger/ts-middleware/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
+
+💡 [Suggest features](https://github.com/philiprehberger/ts-middleware/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
+
+❤️ [Sponsor development](https://github.com/sponsors/philiprehberger)
+
+🌐 [All Open Source Projects](https://philiprehberger.com/open-source-packages)
+
+💻 [GitHub Profile](https://github.com/philiprehberger)
+
+🔗 [LinkedIn Profile](https://www.linkedin.com/in/philiprehberger)
+
 ## License
 
-MIT
+[MIT](LICENSE)

package/dist/index.cjs

@@ -72,9 +72,44 @@ function withErrorHandler(mw, handler) {
   };
 }
 
+// src/timeout.ts
+var MiddlewareTimeoutError = class extends Error {
+  constructor(timeoutMs) {
+    super(`Middleware timed out after ${timeoutMs}ms`);
+    this.name = "MiddlewareTimeoutError";
+    this.timeoutMs = timeoutMs;
+  }
+};
+function withTimeout(mw, ms) {
+  return async (ctx, next) => {
+    let timer;
+    try {
+      await Promise.race([
+        mw(ctx, next),
+        new Promise((_, reject) => {
+          timer = setTimeout(() => reject(new MiddlewareTimeoutError(ms)), ms);
+        })
+      ]);
+    } finally {
+      if (timer) clearTimeout(timer);
+    }
+  };
+}
+
+// src/tap.ts
+function tap(fn) {
+  return async (ctx, next) => {
+    await fn(ctx);
+    await next();
+  };
+}
+
+exports.MiddlewareTimeoutError = MiddlewareTimeoutError;
 exports.branch = branch;
 exports.compose = compose;
 exports.createPipeline = createPipeline;
+exports.tap = tap;
 exports.withErrorHandler = withErrorHandler;
+exports.withTimeout = withTimeout;
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/compose.ts","../src/pipeline.ts","../src/branch.ts","../src/error.ts"],"names":[],"mappings":";;;AAEO,SAAS,WAAgB,WAAA,EAAiD;AAC/E,EAAA,OAAO,OAAO,KAAU,IAAA,KAA8B;AACpD,IAAA,IAAI,KAAA,GAAQ,EAAA;AAEZ,IAAA,eAAe,SAAS,CAAA,EAA0B;AAChD,MAAA,IAAI,CAAA,IAAK,KAAA,EAAO,MAAM,IAAI,MAAM,8BAA8B,CAAA;AAC9D,MAAA,KAAA,GAAQ,CAAA;AAER,MAAA,MAAM,KAAK,CAAA,GAAI,WAAA,CAAY,MAAA,GAAS,WAAA,CAAY,CAAC,CAAA,GAAI,IAAA;AACrD,MAAA,IAAI,CAAC,EAAA,EAAI;AAET,MAAA,MAAM,GAAG,GAAA,EAAK,MAAM,QAAA,CAAS,CAAA,GAAI,CAAC,CAAC,CAAA;AAAA,IACrC;AAEA,IAAA,MAAM,SAAS,CAAC,CAAA;AAAA,EAClB,CAAA;AACF;;;ACTO,SAAS,cAAA,GAA+C;AAC7D,EAAA,MAAM,QAA2B,EAAC;AAElC,EAAA,MAAM,QAAA,GAAoC;AAAA,IACxC,IAAI,EAAA,EAAqB;AACvB,MAAA,KAAA,CAAM,KAAK,EAAE,CAAA;AACb,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,CAAM,WAA8C,EAAA,EAAqB;AACvE,MAAA,IAAI,OAAO,cAAc,SAAA,EAAW;AAClC,QAAA,IAAI,SAAA,EAAW,KAAA,CAAM,IAAA,CAAK,EAAE,CAAA;AAAA,MAC9B,CAAA,MAAO;AACL,QAAA,KAAA,CAAM,IAAA,CAAK,OAAO,GAAA,EAAK,IAAA,KAAS;AAC9B,UAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,YAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,UACpB,CAAA,MAAO;AACL,YAAA,MAAM,IAAA,EAAK;AAAA,UACb;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AACA,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,GAAQ;AACN,MAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,GAAG,KAAK,CAAA;AACjC,MAAA,OAAO,OAAO,GAAA,KAAa;AACzB,QAAA,MAAM,QAAA,CAAS,KAAK,YAAY;AAAA,QAAC,CAAC,CAAA;AAAA,MACpC,CAAA;AAAA,IACF;AAAA,GACF;AAEA,EAAA,OAAO,QAAA;AACT;;;ACxCO,SAAS,MAAA,CACd,SAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,MAAA,MAAM,MAAA,CAAO,KAAK,IAAI,CAAA;AAAA,IACxB,WAAW,OAAA,EAAS;AAClB,MAAA,MAAM,OAAA,CAAQ,KAAK,IAAI,CAAA;AAAA,IACzB,CAAA,MAAO;AACL,MAAA,MAAM,IAAA,EAAK;AAAA,IACb;AAAA,EACF,CAAA;AACF;;;ACdO,SAAS,gBAAA,CACd,IACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,IACpB,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,OAAA,CAAQ,KAAK,GAAG,CAAA;AAAA,IACxB;AAAA,EACF,CAAA;AACF","file":"index.cjs","sourcesContent":["import type { Middleware } from './types';\n\nexport function compose<Ctx>(...middlewares: Middleware<Ctx>[]): Middleware<Ctx> {\n  return async (ctx: Ctx, next: () => Promise<void>) => {\n    let index = -1;\n\n    async function dispatch(i: number): Promise<void> {\n      if (i <= index) throw new Error('next() called multiple times');\n      index = i;\n\n      const mw = i < middlewares.length ? middlewares[i] : next;\n      if (!mw) return;\n\n      await mw(ctx, () => dispatch(i + 1));\n    }\n\n    await dispatch(0);\n  };\n}\n","import type { Middleware } from './types';\nimport { compose } from './compose';\n\nexport interface MiddlewarePipeline<Ctx> {\n  use(mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  build(): (ctx: Ctx) => Promise<void>;\n}\n\nexport function createPipeline<Ctx>(): MiddlewarePipeline<Ctx> {\n  const stack: Middleware<Ctx>[] = [];\n\n  const pipeline: MiddlewarePipeline<Ctx> = {\n    use(mw: Middleware<Ctx>) {\n      stack.push(mw);\n      return pipeline;\n    },\n\n    useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>) {\n      if (typeof condition === 'boolean') {\n        if (condition) stack.push(mw);\n      } else {\n        stack.push(async (ctx, next) => {\n          if (condition(ctx)) {\n            await mw(ctx, next);\n          } else {\n            await next();\n          }\n        });\n      }\n      return pipeline;\n    },\n\n    build() {\n      const composed = compose(...stack);\n      return async (ctx: Ctx) => {\n        await composed(ctx, async () => {});\n      };\n    },\n  };\n\n  return pipeline;\n}\n","import type { Middleware } from './types';\n\nexport function branch<Ctx>(\n  condition: (ctx: Ctx) => boolean,\n  trueMw: Middleware<Ctx>,\n  falseMw?: Middleware<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    if (condition(ctx)) {\n      await trueMw(ctx, next);\n    } else if (falseMw) {\n      await falseMw(ctx, next);\n    } else {\n      await next();\n    }\n  };\n}\n","import type { Middleware, ErrorHandler } from './types';\n\nexport function withErrorHandler<Ctx>(\n  mw: Middleware<Ctx>,\n  handler: ErrorHandler<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    try {\n      await mw(ctx, next);\n    } catch (err) {\n      await handler(err, ctx);\n    }\n  };\n}\n"]}
+{"version":3,"sources":["../src/compose.ts","../src/pipeline.ts","../src/branch.ts","../src/error.ts","../src/timeout.ts","../src/tap.ts"],"names":[],"mappings":";;;AAEO,SAAS,WAAgB,WAAA,EAAiD;AAC/E,EAAA,OAAO,OAAO,KAAU,IAAA,KAA8B;AACpD,IAAA,IAAI,KAAA,GAAQ,EAAA;AAEZ,IAAA,eAAe,SAAS,CAAA,EAA0B;AAChD,MAAA,IAAI,CAAA,IAAK,KAAA,EAAO,MAAM,IAAI,MAAM,8BAA8B,CAAA;AAC9D,MAAA,KAAA,GAAQ,CAAA;AAER,MAAA,MAAM,KAAK,CAAA,GAAI,WAAA,CAAY,MAAA,GAAS,WAAA,CAAY,CAAC,CAAA,GAAI,IAAA;AACrD,MAAA,IAAI,CAAC,EAAA,EAAI;AAET,MAAA,MAAM,GAAG,GAAA,EAAK,MAAM,QAAA,CAAS,CAAA,GAAI,CAAC,CAAC,CAAA;AAAA,IACrC;AAEA,IAAA,MAAM,SAAS,CAAC,CAAA;AAAA,EAClB,CAAA;AACF;;;ACTO,SAAS,cAAA,GAA+C;AAC7D,EAAA,MAAM,QAA2B,EAAC;AAElC,EAAA,MAAM,QAAA,GAAoC;AAAA,IACxC,IAAI,EAAA,EAAqB;AACvB,MAAA,KAAA,CAAM,KAAK,EAAE,CAAA;AACb,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,CAAM,WAA8C,EAAA,EAAqB;AACvE,MAAA,IAAI,OAAO,cAAc,SAAA,EAAW;AAClC,QAAA,IAAI,SAAA,EAAW,KAAA,CAAM,IAAA,CAAK,EAAE,CAAA;AAAA,MAC9B,CAAA,MAAO;AACL,QAAA,KAAA,CAAM,IAAA,CAAK,OAAO,GAAA,EAAK,IAAA,KAAS;AAC9B,UAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,YAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,UACpB,CAAA,MAAO;AACL,YAAA,MAAM,IAAA,EAAK;AAAA,UACb;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AACA,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,GAAQ;AACN,MAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,GAAG,KAAK,CAAA;AACjC,MAAA,OAAO,OAAO,GAAA,KAAa;AACzB,QAAA,MAAM,QAAA,CAAS,KAAK,YAAY;AAAA,QAAC,CAAC,CAAA;AAAA,MACpC,CAAA;AAAA,IACF;AAAA,GACF;AAEA,EAAA,OAAO,QAAA;AACT;;;ACxCO,SAAS,MAAA,CACd,SAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,MAAA,MAAM,MAAA,CAAO,KAAK,IAAI,CAAA;AAAA,IACxB,WAAW,OAAA,EAAS;AAClB,MAAA,MAAM,OAAA,CAAQ,KAAK,IAAI,CAAA;AAAA,IACzB,CAAA,MAAO;AACL,MAAA,MAAM,IAAA,EAAK;AAAA,IACb;AAAA,EACF,CAAA;AACF;;;ACdO,SAAS,gBAAA,CACd,IACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,IACpB,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,OAAA,CAAQ,KAAK,GAAG,CAAA;AAAA,IACxB;AAAA,EACF,CAAA;AACF;;;ACXO,IAAM,sBAAA,GAAN,cAAqC,KAAA,CAAM;AAAA,EAEhD,YAAY,SAAA,EAAmB;AAC7B,IAAA,KAAA,CAAM,CAAA,2BAAA,EAA8B,SAAS,CAAA,EAAA,CAAI,CAAA;AACjD,IAAA,IAAA,CAAK,IAAA,GAAO,wBAAA;AACZ,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AAAA,EACnB;AACF;AAEO,SAAS,WAAA,CAAiB,IAAqB,EAAA,EAA6B;AACjF,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI,KAAA;AACJ,IAAA,IAAI;AACF,MAAA,MAAM,QAAQ,IAAA,CAAK;AAAA,QACjB,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,QACZ,IAAI,OAAA,CAAe,CAAC,CAAA,EAAG,MAAA,KAAW;AAChC,UAAA,KAAA,GAAQ,UAAA,CAAW,MAAM,MAAA,CAAO,IAAI,uBAAuB,EAAE,CAAC,GAAG,EAAE,CAAA;AAAA,QACrE,CAAC;AAAA,OACF,CAAA;AAAA,IACH,CAAA,SAAE;AACA,MAAA,IAAI,KAAA,eAAoB,KAAK,CAAA;AAAA,IAC/B;AAAA,EACF,CAAA;AACF;;;ACvBO,SAAS,IAAS,EAAA,EAAyD;AAChF,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,MAAM,GAAG,GAAG,CAAA;AACZ,IAAA,MAAM,IAAA,EAAK;AAAA,EACb,CAAA;AACF","file":"index.cjs","sourcesContent":["import type { Middleware } from './types';\n\nexport function compose<Ctx>(...middlewares: Middleware<Ctx>[]): Middleware<Ctx> {\n  return async (ctx: Ctx, next: () => Promise<void>) => {\n    let index = -1;\n\n    async function dispatch(i: number): Promise<void> {\n      if (i <= index) throw new Error('next() called multiple times');\n      index = i;\n\n      const mw = i < middlewares.length ? middlewares[i] : next;\n      if (!mw) return;\n\n      await mw(ctx, () => dispatch(i + 1));\n    }\n\n    await dispatch(0);\n  };\n}\n","import type { Middleware } from './types';\nimport { compose } from './compose';\n\nexport interface MiddlewarePipeline<Ctx> {\n  use(mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  build(): (ctx: Ctx) => Promise<void>;\n}\n\nexport function createPipeline<Ctx>(): MiddlewarePipeline<Ctx> {\n  const stack: Middleware<Ctx>[] = [];\n\n  const pipeline: MiddlewarePipeline<Ctx> = {\n    use(mw: Middleware<Ctx>) {\n      stack.push(mw);\n      return pipeline;\n    },\n\n    useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>) {\n      if (typeof condition === 'boolean') {\n        if (condition) stack.push(mw);\n      } else {\n        stack.push(async (ctx, next) => {\n          if (condition(ctx)) {\n            await mw(ctx, next);\n          } else {\n            await next();\n          }\n        });\n      }\n      return pipeline;\n    },\n\n    build() {\n      const composed = compose(...stack);\n      return async (ctx: Ctx) => {\n        await composed(ctx, async () => {});\n      };\n    },\n  };\n\n  return pipeline;\n}\n","import type { Middleware } from './types';\n\nexport function branch<Ctx>(\n  condition: (ctx: Ctx) => boolean,\n  trueMw: Middleware<Ctx>,\n  falseMw?: Middleware<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    if (condition(ctx)) {\n      await trueMw(ctx, next);\n    } else if (falseMw) {\n      await falseMw(ctx, next);\n    } else {\n      await next();\n    }\n  };\n}\n","import type { Middleware, ErrorHandler } from './types';\n\nexport function withErrorHandler<Ctx>(\n  mw: Middleware<Ctx>,\n  handler: ErrorHandler<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    try {\n      await mw(ctx, next);\n    } catch (err) {\n      await handler(err, ctx);\n    }\n  };\n}\n","import type { Middleware } from './types';\n\nexport class MiddlewareTimeoutError extends Error {\n  public readonly timeoutMs: number;\n  constructor(timeoutMs: number) {\n    super(`Middleware timed out after ${timeoutMs}ms`);\n    this.name = 'MiddlewareTimeoutError';\n    this.timeoutMs = timeoutMs;\n  }\n}\n\nexport function withTimeout<Ctx>(mw: Middleware<Ctx>, ms: number): Middleware<Ctx> {\n  return async (ctx, next) => {\n    let timer: ReturnType<typeof setTimeout> | undefined;\n    try {\n      await Promise.race([\n        mw(ctx, next),\n        new Promise<never>((_, reject) => {\n          timer = setTimeout(() => reject(new MiddlewareTimeoutError(ms)), ms);\n        }),\n      ]);\n    } finally {\n      if (timer) clearTimeout(timer);\n    }\n  };\n}\n","import type { Middleware } from './types';\n\nexport function tap<Ctx>(fn: (ctx: Ctx) => void | Promise<void>): Middleware<Ctx> {\n  return async (ctx, next) => {\n    await fn(ctx);\n    await next();\n  };\n}\n"]}

package/dist/index.d.cts

@@ -14,4 +14,12 @@ declare function branch<Ctx>(condition: (ctx: Ctx) => boolean, trueMw: Middlewar
 
 declare function withErrorHandler<Ctx>(mw: Middleware<Ctx>, handler: ErrorHandler<Ctx>): Middleware<Ctx>;
 
-export { type ErrorHandler, type Middleware, type MiddlewarePipeline, branch, compose, createPipeline, withErrorHandler };
+declare class MiddlewareTimeoutError extends Error {
+    readonly timeoutMs: number;
+    constructor(timeoutMs: number);
+}
+declare function withTimeout<Ctx>(mw: Middleware<Ctx>, ms: number): Middleware<Ctx>;
+
+declare function tap<Ctx>(fn: (ctx: Ctx) => void | Promise<void>): Middleware<Ctx>;
+
+export { type ErrorHandler, type Middleware, type MiddlewarePipeline, MiddlewareTimeoutError, branch, compose, createPipeline, tap, withErrorHandler, withTimeout };

package/dist/index.d.ts

@@ -14,4 +14,12 @@ declare function branch<Ctx>(condition: (ctx: Ctx) => boolean, trueMw: Middlewar
 
 declare function withErrorHandler<Ctx>(mw: Middleware<Ctx>, handler: ErrorHandler<Ctx>): Middleware<Ctx>;
 
-export { type ErrorHandler, type Middleware, type MiddlewarePipeline, branch, compose, createPipeline, withErrorHandler };
+declare class MiddlewareTimeoutError extends Error {
+    readonly timeoutMs: number;
+    constructor(timeoutMs: number);
+}
+declare function withTimeout<Ctx>(mw: Middleware<Ctx>, ms: number): Middleware<Ctx>;
+
+declare function tap<Ctx>(fn: (ctx: Ctx) => void | Promise<void>): Middleware<Ctx>;
+
+export { type ErrorHandler, type Middleware, type MiddlewarePipeline, MiddlewareTimeoutError, branch, compose, createPipeline, tap, withErrorHandler, withTimeout };

package/dist/index.js

@@ -70,6 +70,38 @@ function withErrorHandler(mw, handler) {
   };
 }
 
-export { branch, compose, createPipeline, withErrorHandler };
+// src/timeout.ts
+var MiddlewareTimeoutError = class extends Error {
+  constructor(timeoutMs) {
+    super(`Middleware timed out after ${timeoutMs}ms`);
+    this.name = "MiddlewareTimeoutError";
+    this.timeoutMs = timeoutMs;
+  }
+};
+function withTimeout(mw, ms) {
+  return async (ctx, next) => {
+    let timer;
+    try {
+      await Promise.race([
+        mw(ctx, next),
+        new Promise((_, reject) => {
+          timer = setTimeout(() => reject(new MiddlewareTimeoutError(ms)), ms);
+        })
+      ]);
+    } finally {
+      if (timer) clearTimeout(timer);
+    }
+  };
+}
+
+// src/tap.ts
+function tap(fn) {
+  return async (ctx, next) => {
+    await fn(ctx);
+    await next();
+  };
+}
+
+export { MiddlewareTimeoutError, branch, compose, createPipeline, tap, withErrorHandler, withTimeout };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/compose.ts","../src/pipeline.ts","../src/branch.ts","../src/error.ts"],"names":[],"mappings":";AAEO,SAAS,WAAgB,WAAA,EAAiD;AAC/E,EAAA,OAAO,OAAO,KAAU,IAAA,KAA8B;AACpD,IAAA,IAAI,KAAA,GAAQ,EAAA;AAEZ,IAAA,eAAe,SAAS,CAAA,EAA0B;AAChD,MAAA,IAAI,CAAA,IAAK,KAAA,EAAO,MAAM,IAAI,MAAM,8BAA8B,CAAA;AAC9D,MAAA,KAAA,GAAQ,CAAA;AAER,MAAA,MAAM,KAAK,CAAA,GAAI,WAAA,CAAY,MAAA,GAAS,WAAA,CAAY,CAAC,CAAA,GAAI,IAAA;AACrD,MAAA,IAAI,CAAC,EAAA,EAAI;AAET,MAAA,MAAM,GAAG,GAAA,EAAK,MAAM,QAAA,CAAS,CAAA,GAAI,CAAC,CAAC,CAAA;AAAA,IACrC;AAEA,IAAA,MAAM,SAAS,CAAC,CAAA;AAAA,EAClB,CAAA;AACF;;;ACTO,SAAS,cAAA,GAA+C;AAC7D,EAAA,MAAM,QAA2B,EAAC;AAElC,EAAA,MAAM,QAAA,GAAoC;AAAA,IACxC,IAAI,EAAA,EAAqB;AACvB,MAAA,KAAA,CAAM,KAAK,EAAE,CAAA;AACb,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,CAAM,WAA8C,EAAA,EAAqB;AACvE,MAAA,IAAI,OAAO,cAAc,SAAA,EAAW;AAClC,QAAA,IAAI,SAAA,EAAW,KAAA,CAAM,IAAA,CAAK,EAAE,CAAA;AAAA,MAC9B,CAAA,MAAO;AACL,QAAA,KAAA,CAAM,IAAA,CAAK,OAAO,GAAA,EAAK,IAAA,KAAS;AAC9B,UAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,YAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,UACpB,CAAA,MAAO;AACL,YAAA,MAAM,IAAA,EAAK;AAAA,UACb;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AACA,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,GAAQ;AACN,MAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,GAAG,KAAK,CAAA;AACjC,MAAA,OAAO,OAAO,GAAA,KAAa;AACzB,QAAA,MAAM,QAAA,CAAS,KAAK,YAAY;AAAA,QAAC,CAAC,CAAA;AAAA,MACpC,CAAA;AAAA,IACF;AAAA,GACF;AAEA,EAAA,OAAO,QAAA;AACT;;;ACxCO,SAAS,MAAA,CACd,SAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,MAAA,MAAM,MAAA,CAAO,KAAK,IAAI,CAAA;AAAA,IACxB,WAAW,OAAA,EAAS;AAClB,MAAA,MAAM,OAAA,CAAQ,KAAK,IAAI,CAAA;AAAA,IACzB,CAAA,MAAO;AACL,MAAA,MAAM,IAAA,EAAK;AAAA,IACb;AAAA,EACF,CAAA;AACF;;;ACdO,SAAS,gBAAA,CACd,IACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,IACpB,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,OAAA,CAAQ,KAAK,GAAG,CAAA;AAAA,IACxB;AAAA,EACF,CAAA;AACF","file":"index.js","sourcesContent":["import type { Middleware } from './types';\n\nexport function compose<Ctx>(...middlewares: Middleware<Ctx>[]): Middleware<Ctx> {\n  return async (ctx: Ctx, next: () => Promise<void>) => {\n    let index = -1;\n\n    async function dispatch(i: number): Promise<void> {\n      if (i <= index) throw new Error('next() called multiple times');\n      index = i;\n\n      const mw = i < middlewares.length ? middlewares[i] : next;\n      if (!mw) return;\n\n      await mw(ctx, () => dispatch(i + 1));\n    }\n\n    await dispatch(0);\n  };\n}\n","import type { Middleware } from './types';\nimport { compose } from './compose';\n\nexport interface MiddlewarePipeline<Ctx> {\n  use(mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  build(): (ctx: Ctx) => Promise<void>;\n}\n\nexport function createPipeline<Ctx>(): MiddlewarePipeline<Ctx> {\n  const stack: Middleware<Ctx>[] = [];\n\n  const pipeline: MiddlewarePipeline<Ctx> = {\n    use(mw: Middleware<Ctx>) {\n      stack.push(mw);\n      return pipeline;\n    },\n\n    useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>) {\n      if (typeof condition === 'boolean') {\n        if (condition) stack.push(mw);\n      } else {\n        stack.push(async (ctx, next) => {\n          if (condition(ctx)) {\n            await mw(ctx, next);\n          } else {\n            await next();\n          }\n        });\n      }\n      return pipeline;\n    },\n\n    build() {\n      const composed = compose(...stack);\n      return async (ctx: Ctx) => {\n        await composed(ctx, async () => {});\n      };\n    },\n  };\n\n  return pipeline;\n}\n","import type { Middleware } from './types';\n\nexport function branch<Ctx>(\n  condition: (ctx: Ctx) => boolean,\n  trueMw: Middleware<Ctx>,\n  falseMw?: Middleware<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    if (condition(ctx)) {\n      await trueMw(ctx, next);\n    } else if (falseMw) {\n      await falseMw(ctx, next);\n    } else {\n      await next();\n    }\n  };\n}\n","import type { Middleware, ErrorHandler } from './types';\n\nexport function withErrorHandler<Ctx>(\n  mw: Middleware<Ctx>,\n  handler: ErrorHandler<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    try {\n      await mw(ctx, next);\n    } catch (err) {\n      await handler(err, ctx);\n    }\n  };\n}\n"]}
+{"version":3,"sources":["../src/compose.ts","../src/pipeline.ts","../src/branch.ts","../src/error.ts","../src/timeout.ts","../src/tap.ts"],"names":[],"mappings":";AAEO,SAAS,WAAgB,WAAA,EAAiD;AAC/E,EAAA,OAAO,OAAO,KAAU,IAAA,KAA8B;AACpD,IAAA,IAAI,KAAA,GAAQ,EAAA;AAEZ,IAAA,eAAe,SAAS,CAAA,EAA0B;AAChD,MAAA,IAAI,CAAA,IAAK,KAAA,EAAO,MAAM,IAAI,MAAM,8BAA8B,CAAA;AAC9D,MAAA,KAAA,GAAQ,CAAA;AAER,MAAA,MAAM,KAAK,CAAA,GAAI,WAAA,CAAY,MAAA,GAAS,WAAA,CAAY,CAAC,CAAA,GAAI,IAAA;AACrD,MAAA,IAAI,CAAC,EAAA,EAAI;AAET,MAAA,MAAM,GAAG,GAAA,EAAK,MAAM,QAAA,CAAS,CAAA,GAAI,CAAC,CAAC,CAAA;AAAA,IACrC;AAEA,IAAA,MAAM,SAAS,CAAC,CAAA;AAAA,EAClB,CAAA;AACF;;;ACTO,SAAS,cAAA,GAA+C;AAC7D,EAAA,MAAM,QAA2B,EAAC;AAElC,EAAA,MAAM,QAAA,GAAoC;AAAA,IACxC,IAAI,EAAA,EAAqB;AACvB,MAAA,KAAA,CAAM,KAAK,EAAE,CAAA;AACb,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,CAAM,WAA8C,EAAA,EAAqB;AACvE,MAAA,IAAI,OAAO,cAAc,SAAA,EAAW;AAClC,QAAA,IAAI,SAAA,EAAW,KAAA,CAAM,IAAA,CAAK,EAAE,CAAA;AAAA,MAC9B,CAAA,MAAO;AACL,QAAA,KAAA,CAAM,IAAA,CAAK,OAAO,GAAA,EAAK,IAAA,KAAS;AAC9B,UAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,YAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,UACpB,CAAA,MAAO;AACL,YAAA,MAAM,IAAA,EAAK;AAAA,UACb;AAAA,QACF,CAAC,CAAA;AAAA,MACH;AACA,MAAA,OAAO,QAAA;AAAA,IACT,CAAA;AAAA,IAEA,KAAA,GAAQ;AACN,MAAA,MAAM,QAAA,GAAW,OAAA,CAAQ,GAAG,KAAK,CAAA;AACjC,MAAA,OAAO,OAAO,GAAA,KAAa;AACzB,QAAA,MAAM,QAAA,CAAS,KAAK,YAAY;AAAA,QAAC,CAAC,CAAA;AAAA,MACpC,CAAA;AAAA,IACF;AAAA,GACF;AAEA,EAAA,OAAO,QAAA;AACT;;;ACxCO,SAAS,MAAA,CACd,SAAA,EACA,MAAA,EACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI,SAAA,CAAU,GAAG,CAAA,EAAG;AAClB,MAAA,MAAM,MAAA,CAAO,KAAK,IAAI,CAAA;AAAA,IACxB,WAAW,OAAA,EAAS;AAClB,MAAA,MAAM,OAAA,CAAQ,KAAK,IAAI,CAAA;AAAA,IACzB,CAAA,MAAO;AACL,MAAA,MAAM,IAAA,EAAK;AAAA,IACb;AAAA,EACF,CAAA;AACF;;;ACdO,SAAS,gBAAA,CACd,IACA,OAAA,EACiB;AACjB,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,IACpB,SAAS,GAAA,EAAK;AACZ,MAAA,MAAM,OAAA,CAAQ,KAAK,GAAG,CAAA;AAAA,IACxB;AAAA,EACF,CAAA;AACF;;;ACXO,IAAM,sBAAA,GAAN,cAAqC,KAAA,CAAM;AAAA,EAEhD,YAAY,SAAA,EAAmB;AAC7B,IAAA,KAAA,CAAM,CAAA,2BAAA,EAA8B,SAAS,CAAA,EAAA,CAAI,CAAA;AACjD,IAAA,IAAA,CAAK,IAAA,GAAO,wBAAA;AACZ,IAAA,IAAA,CAAK,SAAA,GAAY,SAAA;AAAA,EACnB;AACF;AAEO,SAAS,WAAA,CAAiB,IAAqB,EAAA,EAA6B;AACjF,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,IAAI,KAAA;AACJ,IAAA,IAAI;AACF,MAAA,MAAM,QAAQ,IAAA,CAAK;AAAA,QACjB,EAAA,CAAG,KAAK,IAAI,CAAA;AAAA,QACZ,IAAI,OAAA,CAAe,CAAC,CAAA,EAAG,MAAA,KAAW;AAChC,UAAA,KAAA,GAAQ,UAAA,CAAW,MAAM,MAAA,CAAO,IAAI,uBAAuB,EAAE,CAAC,GAAG,EAAE,CAAA;AAAA,QACrE,CAAC;AAAA,OACF,CAAA;AAAA,IACH,CAAA,SAAE;AACA,MAAA,IAAI,KAAA,eAAoB,KAAK,CAAA;AAAA,IAC/B;AAAA,EACF,CAAA;AACF;;;ACvBO,SAAS,IAAS,EAAA,EAAyD;AAChF,EAAA,OAAO,OAAO,KAAK,IAAA,KAAS;AAC1B,IAAA,MAAM,GAAG,GAAG,CAAA;AACZ,IAAA,MAAM,IAAA,EAAK;AAAA,EACb,CAAA;AACF","file":"index.js","sourcesContent":["import type { Middleware } from './types';\n\nexport function compose<Ctx>(...middlewares: Middleware<Ctx>[]): Middleware<Ctx> {\n  return async (ctx: Ctx, next: () => Promise<void>) => {\n    let index = -1;\n\n    async function dispatch(i: number): Promise<void> {\n      if (i <= index) throw new Error('next() called multiple times');\n      index = i;\n\n      const mw = i < middlewares.length ? middlewares[i] : next;\n      if (!mw) return;\n\n      await mw(ctx, () => dispatch(i + 1));\n    }\n\n    await dispatch(0);\n  };\n}\n","import type { Middleware } from './types';\nimport { compose } from './compose';\n\nexport interface MiddlewarePipeline<Ctx> {\n  use(mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>): MiddlewarePipeline<Ctx>;\n  build(): (ctx: Ctx) => Promise<void>;\n}\n\nexport function createPipeline<Ctx>(): MiddlewarePipeline<Ctx> {\n  const stack: Middleware<Ctx>[] = [];\n\n  const pipeline: MiddlewarePipeline<Ctx> = {\n    use(mw: Middleware<Ctx>) {\n      stack.push(mw);\n      return pipeline;\n    },\n\n    useIf(condition: boolean | ((ctx: Ctx) => boolean), mw: Middleware<Ctx>) {\n      if (typeof condition === 'boolean') {\n        if (condition) stack.push(mw);\n      } else {\n        stack.push(async (ctx, next) => {\n          if (condition(ctx)) {\n            await mw(ctx, next);\n          } else {\n            await next();\n          }\n        });\n      }\n      return pipeline;\n    },\n\n    build() {\n      const composed = compose(...stack);\n      return async (ctx: Ctx) => {\n        await composed(ctx, async () => {});\n      };\n    },\n  };\n\n  return pipeline;\n}\n","import type { Middleware } from './types';\n\nexport function branch<Ctx>(\n  condition: (ctx: Ctx) => boolean,\n  trueMw: Middleware<Ctx>,\n  falseMw?: Middleware<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    if (condition(ctx)) {\n      await trueMw(ctx, next);\n    } else if (falseMw) {\n      await falseMw(ctx, next);\n    } else {\n      await next();\n    }\n  };\n}\n","import type { Middleware, ErrorHandler } from './types';\n\nexport function withErrorHandler<Ctx>(\n  mw: Middleware<Ctx>,\n  handler: ErrorHandler<Ctx>,\n): Middleware<Ctx> {\n  return async (ctx, next) => {\n    try {\n      await mw(ctx, next);\n    } catch (err) {\n      await handler(err, ctx);\n    }\n  };\n}\n","import type { Middleware } from './types';\n\nexport class MiddlewareTimeoutError extends Error {\n  public readonly timeoutMs: number;\n  constructor(timeoutMs: number) {\n    super(`Middleware timed out after ${timeoutMs}ms`);\n    this.name = 'MiddlewareTimeoutError';\n    this.timeoutMs = timeoutMs;\n  }\n}\n\nexport function withTimeout<Ctx>(mw: Middleware<Ctx>, ms: number): Middleware<Ctx> {\n  return async (ctx, next) => {\n    let timer: ReturnType<typeof setTimeout> | undefined;\n    try {\n      await Promise.race([\n        mw(ctx, next),\n        new Promise<never>((_, reject) => {\n          timer = setTimeout(() => reject(new MiddlewareTimeoutError(ms)), ms);\n        }),\n      ]);\n    } finally {\n      if (timer) clearTimeout(timer);\n    }\n  };\n}\n","import type { Middleware } from './types';\n\nexport function tap<Ctx>(fn: (ctx: Ctx) => void | Promise<void>): Middleware<Ctx> {\n  return async (ctx, next) => {\n    await fn(ctx);\n    await next();\n  };\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@philiprehberger/middleware-ts",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Framework-agnostic middleware composition engine",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "tsup": "^8.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^6.0.2"
   },
   "keywords": [
     "middleware",