@rexeus/typeweaver-server 0.5.1

package/README.md

@@ -0,0 +1,393 @@
+# 🧵✨ @rexeus/typeweaver-server
+
+[![npm version](https://img.shields.io/npm/v/@rexeus/typeweaver-server.svg)](https://www.npmjs.com/package/@rexeus/typeweaver-server)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+
+Typeweaver is a type-safe HTTP API framework built for API-first development with a focus on
+developer experience. Use typeweaver to specify your HTTP APIs in TypeScript and Zod, and generate
+clients, validators, routers, and more ✨
+
+## 📝 Server Plugin
+
+This plugin generates a **lightweight, dependency-free server** with built-in routing and middleware
+from your typeweaver API definitions. No external framework required — everything runs on the
+standard Fetch API (`Request`/`Response`).
+
+For each resource, it produces a `<ResourceName>Router` class that registers routes, validates
+requests, and wires your handler methods with full type safety. Mount routers on the provided
+`TypeweaverApp` to get a complete server with middleware support.
+
+> Choose this plugin for a zero-dependency, Fetch API-native server. For Hono framework integration,
+> see [@rexeus/typeweaver-hono](../hono/README.md).
+
+### Key Features
+
+- **Zero runtime dependencies** — no Hono, Express, or Fastify required
+- **Fetch API compatible** — works with Bun, Deno, Cloudflare Workers, and Node.js (>=18)
+- **High-performance radix tree router** — O(d) lookup where d = number of path segments
+- **Type-safe middleware** — compile-time state guarantees via `defineMiddleware`, `StateMap`, and
+  `InferState`
+- **Automatic HEAD handling** — falls back to GET handlers per HTTP spec
+- **405 Method Not Allowed** — with proper `Allow` header
+
+---
+
+## 📥 Installation
+
+```bash
+# Install the CLI and the plugin as a dev dependency
+npm install -D @rexeus/typeweaver @rexeus/typeweaver-server
+
+# Install the runtime as a dependency
+npm install @rexeus/typeweaver-core
+```
+
+## 💡 How to use
+
+```bash
+npx typeweaver generate --input ./api/definition --output ./api/generated --plugins server
+```
+
+More on the CLI in
+[@rexeus/typeweaver](https://github.com/rexeus/typeweaver/tree/main/packages/cli/README.md#️-cli).
+
+## 📂 Generated Output
+
+For a resource `User`, the plugin generates:
+
+```
+generated/
+  lib/server/              ← TypeweaverApp, middleware types, etc.
+  user/
+    UserRouter.ts          ← Router class + UserApiHandler type
+    GetUserRequest.ts      ← Request types (IGetUserRequest)
+    GetUserResponse.ts     ← Response types + factory classes
+    ...
+```
+
+Import `TypeweaverApp`, routers, and types from `./generated`.
+
+## 🚀 Usage
+
+### Implement handlers
+
+Each handler receives the typed request and returns a typed response — plain objects with
+`statusCode`, `header`, and `body`. Content-Type is auto-set to `application/json` for object
+bodies.
+
+```ts
+// user-handlers.ts
+import { HttpStatusCode } from "@rexeus/typeweaver-core";
+import type { UserApiHandler } from "./generated";
+
+export const userHandlers: UserApiHandler = {
+  async handleListUsersRequest() {
+    return {
+      statusCode: HttpStatusCode.OK,
+      body: [{ id: "1", name: "Jane", email: "jane@example.com" }],
+    };
+  },
+
+  async handleCreateUserRequest(request) {
+    return {
+      statusCode: HttpStatusCode.CREATED,
+      body: { id: "1", name: request.body.name, email: request.body.email },
+    };
+  },
+
+  async handleGetUserRequest(request) {
+    return {
+      statusCode: HttpStatusCode.OK,
+      body: { id: request.param.userId, name: "Jane", email: "jane@example.com" },
+    };
+  },
+
+  async handleDeleteUserRequest() {
+    return { statusCode: HttpStatusCode.NO_CONTENT };
+  },
+};
+```
+
+> Generated response classes (e.g. `GetUserSuccessResponse`) are also available for when you need
+> runtime type checks or `instanceof` discrimination in error handling.
+
+### Create the app
+
+```ts
+// server.ts
+import { TypeweaverApp, UserRouter } from "./generated";
+import { userHandlers } from "./user-handlers";
+
+const app = new TypeweaverApp();
+app.route(new UserRouter({ requestHandlers: userHandlers }));
+
+export default app;
+```
+
+### Start the server
+
+**Bun**
+
+```ts
+import app from "./server";
+
+Bun.serve({ fetch: app.fetch, port: 3000 });
+```
+
+**Deno**
+
+```ts
+import app from "./server.ts";
+
+Deno.serve({ port: 3000 }, app.fetch);
+```
+
+**Node.js**
+
+```ts
+import { createServer } from "node:http";
+import { nodeAdapter } from "./generated/lib/server";
+import app from "./server";
+
+createServer(nodeAdapter(app)).listen(3000);
+```
+
+### Multiple routers
+
+```ts
+app.route(new UserRouter({ requestHandlers: userHandlers }));
+app.route("/api/v1", new OrderRouter({ requestHandlers: orderHandlers }));
+```
+
+### 🔗 Middleware
+
+Middleware is defined with `defineMiddleware` and follows a return-based onion model. Each
+middleware declares what state it **provides** downstream and what state it **requires** from
+upstream — all checked at compile time.
+
+**Providing state** — pass state to `next()`:
+
+```ts
+import { defineMiddleware } from "./generated/lib/server";
+
+const auth = defineMiddleware<{ userId: string }>(async (ctx, next) => {
+  const token = ctx.request.header?.["authorization"];
+  return next({ userId: parseToken(token) });
+});
+```
+
+When `TProvides` has keys, `next()` **requires** the state object as its argument — you can't forget
+to provide it.
+
+**Requiring upstream state** — declare dependencies:
+
+```ts
+const permissions = defineMiddleware<{ permissions: string[] }, { userId: string }>(
+  async (ctx, next) => {
+    const userId = ctx.state.get("userId"); // string — no cast, no undefined
+    return next({ permissions: await loadPermissions(userId) });
+  }
+);
+```
+
+Registering `permissions` before `auth` produces a **compile-time error** because `userId` is not
+yet available in the accumulated state.
+
+**Pass-through middleware** — `next()` takes no arguments:
+
+```ts
+const logger = defineMiddleware(async (ctx, next) => {
+  const start = Date.now();
+  const response = await next();
+  console.log(
+    `${ctx.request.method} ${ctx.request.path} -> ${response.statusCode} (${Date.now() - start}ms)`
+  );
+  return response;
+});
+```
+
+**Short-circuit** — return a response without calling `next()`:
+
+```ts
+const guard = defineMiddleware(async (ctx, next) => {
+  if (!ctx.request.header?.["authorization"]) {
+    return { statusCode: 401, body: { message: "Unauthorized" } };
+  }
+  return next();
+});
+```
+
+**Path-scoped guard** — use `pathMatcher` to limit middleware to specific routes:
+
+```ts
+import { defineMiddleware, pathMatcher } from "./generated/lib/server";
+
+const isUsersPath = pathMatcher("/users/*");
+
+const usersGuard = defineMiddleware(async (ctx, next) => {
+  if (!isUsersPath(ctx.request.path)) return next();
+  if (!ctx.request.header?.["authorization"]) {
+    return { statusCode: 401, body: { message: "Unauthorized" } };
+  }
+  return next();
+});
+```
+
+`pathMatcher` supports exact matches (`"/health"`) and prefix matches (`"/users/*"`).
+
+**Chaining** — state accumulates through `.use()`:
+
+```ts
+const app = new TypeweaverApp()
+  .use(auth) // provides { userId: string }
+  .use(permissions) // requires { userId }, provides { permissions: string[] }
+  .route(new TodoRouter({ requestHandlers: todoHandlers }));
+```
+
+**`InferState`** — extract the accumulated state type for handlers:
+
+```ts
+import type { InferState } from "./generated/lib/server";
+
+type AppState = InferState<typeof app>;
+// { userId: string } & { permissions: string[] }
+```
+
+Middleware runs for **all** requests, including 404s and 405s, so global concerns like logging and
+CORS always execute.
+
+### 🛠️ App Options
+
+`TypeweaverApp` accepts an optional options object:
+
+| Option        | Type                       | Default            | Description                                                 |
+| ------------- | -------------------------- | ------------------ | ----------------------------------------------------------- |
+| `maxBodySize` | `number`                   | `1_048_576` (1 MB) | Max request body size in bytes. Exceeding returns `413`.    |
+| `onError`     | `(error: unknown) => void` | `console.error`    | Error callback. Falls back to `console.error` if it throws. |
+
+```ts
+const app = new TypeweaverApp({
+  maxBodySize: 5 * 1024 * 1024, // 5 MB
+  onError: error => logger.error("Unhandled error", error),
+});
+```
+
+### ⚙️ Router Configuration
+
+Each router accepts `TypeweaverRouterOptions`:
+
+| Option                     | Type                   | Default    | Description                        |
+| -------------------------- | ---------------------- | ---------- | ---------------------------------- |
+| `requestHandlers`          | `<Resource>ApiHandler` | _required_ | Handler methods for each operation |
+| `validateRequests`         | `boolean`              | `true`     | Enable/disable request validation  |
+| `handleValidationErrors`   | `boolean \| function`  | `true`     | Handle validation errors           |
+| `handleHttpResponseErrors` | `boolean \| function`  | `true`     | Handle thrown `HttpResponse`       |
+| `handleUnknownErrors`      | `boolean \| function`  | `true`     | Handle unexpected errors           |
+
+When set to `true`, error handlers use sensible defaults (400/500 responses). When set to `false`,
+errors fall through to the next handler in the chain. When set to a function, it receives the error
+and `ServerContext` and must return an `IHttpResponse`.
+
+### 🚨 Error Handling
+
+#### Throwing errors in handlers
+
+All generated error response classes (e.g. `NotFoundErrorResponse`, `ValidationErrorResponse`)
+extend `HttpResponse`. Throw them in your handlers — the framework catches them automatically:
+
+```ts
+import { HttpStatusCode } from "@rexeus/typeweaver-core";
+import { GetUserSuccessResponse, NotFoundErrorResponse } from "./generated";
+
+async handleGetUserRequest(request) {
+  const user = await db.findUser(request.param.userId);
+  if (!user) {
+    throw new NotFoundErrorResponse({
+      statusCode: HttpStatusCode.NOT_FOUND,
+      header: { "Content-Type": "application/json" },
+      body: { message: "Resource not found", code: "NOT_FOUND_ERROR" },
+    });
+  }
+  return new GetUserSuccessResponse({
+    statusCode: HttpStatusCode.OK,
+    header: { "Content-Type": "application/json" },
+    body: user,
+  });
+}
+```
+
+When `handleHttpResponseErrors` is `true` (the default), thrown `HttpResponse` instances are
+returned as-is. No extra configuration needed.
+
+#### Custom error mapping
+
+Use custom handler functions to transform errors into your own response shape.
+
+**Validation errors** — map framework validation errors to your spec-defined format:
+
+```ts
+new UserRouter({
+  requestHandlers: userHandlers,
+  handleValidationErrors: (error, ctx) =>
+    new ValidationErrorResponse({
+      statusCode: HttpStatusCode.BAD_REQUEST,
+      header: { "Content-Type": "application/json" },
+      body: {
+        code: "VALIDATION_ERROR",
+        message: "Request is invalid",
+        issues: {
+          body: error.bodyIssues,
+          query: error.queryIssues,
+          param: error.pathParamIssues,
+          header: error.headerIssues,
+        },
+      },
+    }),
+});
+```
+
+**HTTP response errors** — log thrown errors and pass them through:
+
+```ts
+new UserRouter({
+  requestHandlers: userHandlers,
+  handleHttpResponseErrors: (error, ctx) => {
+    logger.warn("HTTP error", { status: error.statusCode, path: ctx.request.path });
+    return error;
+  },
+});
+```
+
+**Unknown errors** — catch unexpected failures and return a safe response:
+
+```ts
+new UserRouter({
+  requestHandlers: userHandlers,
+  handleUnknownErrors: (error, ctx) => {
+    logger.error("Unhandled error", { error, path: ctx.request.path });
+    return new InternalServerErrorResponse({
+      statusCode: HttpStatusCode.INTERNAL_SERVER_ERROR,
+      header: { "Content-Type": "application/json" },
+      body: { code: "INTERNAL_SERVER_ERROR", message: "Something went wrong" },
+    });
+  },
+});
+```
+
+### 📋 Error Responses
+
+| Status | Code                    | When                                                          |
+| ------ | ----------------------- | ------------------------------------------------------------- |
+| `400`  | `BAD_REQUEST`           | Malformed request body                                        |
+| `400`  | Validation issues       | `handleValidationErrors: true` and request fails validation   |
+| `404`  | `NOT_FOUND`             | No matching route                                             |
+| `405`  | `METHOD_NOT_ALLOWED`    | Route exists but method not allowed (includes `Allow` header) |
+| `413`  | `PAYLOAD_TOO_LARGE`     | Request body exceeds `maxBodySize`                            |
+| `500`  | `INTERNAL_SERVER_ERROR` | Unhandled error in handler                                    |
+
+All error responses follow the shape: `{ code: string, message: string }`.
+
+## 📄 License
+
+Apache 2.0 © Dennis Wentzien 2026

package/dist/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Dennis Wentzien
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/NOTICE

@@ -0,0 +1,4 @@
+Copyright 2026 Dennis Wentzien
+
+This project is licensed under the Apache License, Version 2.0
+See LICENSE file for details.