@antelopejs/interface-api-util 0.1.0 → 0.1.2

package/docs/1.introduction.md

@@ -0,0 +1,190 @@
+# Interface API Util Documentation
+
+## Overview
+
+Interface API Util provides utilities for validating API requests, rate limiting handlers, and returning structured HTTP error responses. The package exports `assert` for checking conditions, `assertValidation` for running input validators, and the `@RateLimit` decorator for throttling handlers. All of them surface failures as `HTTPResult` errors from `@antelopejs/interface-api`.
+
+## Getting Started
+
+Install the package in your project:
+
+```bash
+npm install @antelopejs/interface-api-util
+```
+
+## `assert`
+
+The `assert` function checks whether a condition is truthy. If the condition is falsy, it throws an `HTTPResult` with the specified HTTP status code and error message.
+
+```typescript
+function assert<T>(condition: T, code: number, message: string): asserts condition;
+```
+
+| Parameter   | Type     | Description                                          |
+| ----------- | -------- | ---------------------------------------------------- |
+| `condition` | `T`      | The value to check (falsy values trigger the error)  |
+| `code`      | `number` | HTTP status code for the error response              |
+| `message`   | `string` | Error message included in the response body          |
+
+The function uses TypeScript's `asserts` keyword, so the compiler narrows the type of `condition` to truthy after the call.
+
+### Check that a resource exists
+
+```typescript
+import { assert } from "@antelopejs/interface-api-util";
+import { HTTPResult } from "@antelopejs/interface-api";
+
+async function getUser(id: string) {
+  const user = await findUser(id);
+  assert(user, 404, "User not found");
+
+  // TypeScript knows `user` is defined here
+  return new HTTPResult(200, user);
+}
+```
+
+### Validate permissions
+
+```typescript
+import { assert } from "@antelopejs/interface-api-util";
+import { HTTPResult } from "@antelopejs/interface-api";
+
+async function deletePost(postId: string, currentUserId: string) {
+  const post = await findPost(postId);
+  assert(post, 404, "Post not found");
+  assert(post.authorId === currentUserId, 403, "Not authorized to delete this post");
+
+  await removePost(postId);
+  return new HTTPResult(200, { deleted: true });
+}
+```
+
+## `assertValidation`
+
+The `assertValidation` function runs a validator on an input value. If the validator throws, `assertValidation` catches the error and throws an `HTTPResult` instead.
+
+```typescript
+function assertValidation<T>(
+  body: unknown,
+  validator: (body: unknown) => T,
+  errorFunc?: (err: unknown) => unknown,
+  code?: number,
+): T;
+```
+
+| Parameter   | Type                          | Default | Description                                             |
+| ----------- | ----------------------------- | ------- | ------------------------------------------------------- |
+| `body`      | `unknown`                     |         | The input value to validate                             |
+| `validator` | `(body: unknown) => T`        |         | A function that returns the validated value or throws   |
+| `errorFunc` | `(err: unknown) => unknown`   |         | Optional error transformer for customizing the response |
+| `code`      | `number`                      | `400`   | HTTP status code for the error response                 |
+
+The function returns the validated value on success. On failure, it throws an `HTTPResult` whose body is either the result of `errorFunc` or the stringified error.
+
+### Validate with Zod
+
+```typescript
+import { assertValidation } from "@antelopejs/interface-api-util";
+import * as z from "zod";
+
+const createUserSchema = z.object({
+  name: z.string().min(1),
+  email: z.string().email(),
+});
+
+function createUser(requestBody: unknown) {
+  const { name, email } = assertValidation(requestBody, createUserSchema.parse);
+
+  // `name` and `email` are typed strings here
+  return saveUser({ name, email });
+}
+```
+
+### Custom error formatting
+
+Pass an `errorFunc` to control the error response body.
+
+```typescript
+import { assertValidation } from "@antelopejs/interface-api-util";
+import * as z from "zod";
+
+const schema = z.object({ age: z.number().min(18) });
+
+function validateAge(requestBody: unknown) {
+  return assertValidation(
+    requestBody,
+    schema.parse,
+    (err) => {
+      if (err instanceof z.ZodError) {
+        return { errors: err.errors.map((e) => e.message) };
+      }
+      return { errors: [String(err)] };
+    },
+    422,
+  );
+}
+```
+
+## `RateLimit`
+
+The `@RateLimit` decorator caps how often a route handler can be called. It counts requests per client in a fixed time window (in-memory, per process). Successful responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` (a UNIX epoch-seconds timestamp) so clients can self-pace. Once the count exceeds `limit` within `windowMs`, the handler instead throws an `HTTPResult` with status `429` (adding a `Retry-After` header) without running.
+
+```typescript
+function RateLimit(
+  limit: number,
+  windowMs: number,
+  options?: RateLimitOptions,
+): MethodDecorator;
+```
+
+| Parameter  | Type               | Description                                              |
+| ---------- | ------------------ | -------------------------------------------------------- |
+| `limit`    | `number`           | Maximum number of requests allowed per window            |
+| `windowMs` | `number`           | Window duration in milliseconds                          |
+| `options`  | `RateLimitOptions` | Optional custom key function and `429` response body     |
+
+```typescript
+interface RateLimitOptions {
+  key?: (context: RequestContext) => string | null | undefined;
+  message?: string;
+}
+```
+
+By default, requests are counted per client IP (`context.rawRequest.socket.remoteAddress`). Provide `options.key` to count by user id, API key, or a forwarded header instead. If the custom key function returns a falsy value (for example a missing route parameter), the limiter falls back to the client IP rather than collapsing every such request into one shared bucket.
+
+> **Ordering matters.** Place `@RateLimit` **directly beneath** the route decorator (`@Get`, `@Post`, …). The route decorator captures the handler's parameters when it is applied, so a `@RateLimit` above it would be ignored — this is detected at startup and throws, rather than silently leaving the route unprotected.
+
+### Limit by client IP
+
+```typescript
+import { RateLimit } from "@antelopejs/interface-api-util";
+import { Controller, Get, HTTPResult } from "@antelopejs/interface-api";
+
+class UsersController extends Controller("users") {
+  @Get()
+  @RateLimit(100, 60_000)
+  list() {
+    return new HTTPResult(200, { users: [] });
+  }
+}
+```
+
+### Limit by a custom key
+
+```typescript
+import { RateLimit } from "@antelopejs/interface-api-util";
+import { Controller, Post, HTTPResult } from "@antelopejs/interface-api";
+
+class AuthController extends Controller("auth") {
+  @Post("login")
+  @RateLimit(5, 60_000, {
+    key: (ctx) => ctx.routeParameters.tenant,
+    message: "Too many login attempts, slow down",
+  })
+  login() {
+    return new HTTPResult(200, { ok: true });
+  }
+}
+```
+
+Counts are kept in process memory, so they are not shared across instances and reset on restart. Elapsed windows are pruned periodically, so the store is bounded by the number of distinct keys seen within a single window rather than growing forever. For distributed limits, key by a stable identifier and enforce limits in a shared store at the edge. Behind a proxy, the socket address is the proxy's — supply `options.key` to read a forwarded header, but only trust the hop your proxy sets (a raw client-supplied `X-Forwarded-For` is spoofable and can be used to evade or to inflate the key cardinality).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-api-util",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "AntelopeJS utility functions for API request validation and error handling",
   "keywords": [
     "antelopejs",
@@ -17,7 +17,9 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "docs",
+    "skills"
   ],
   "exports": {
     ".": {
@@ -36,13 +38,14 @@
     "test": "pnpm run build && ajs module test ."
   },
   "antelopeJs": {
-    "test": "src/antelope.test.ts"
-  },
-  "dependencies": {
-    "@antelopejs/interface-api": "^0.0.3",
-    "@antelopejs/interface-core": "^0.0.3"
+    "test": "src/antelope.test.ts",
+    "skills": [
+      "./skills"
+    ]
   },
   "devDependencies": {
+    "@antelopejs/interface-api": "^0.0.5",
+    "@antelopejs/interface-core": "^0.0.5",
     "@biomejs/biome": "2.3.2",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.19.15",
@@ -51,6 +54,10 @@
     "rimraf": "^6.1.3",
     "typescript": "^5.9.3"
   },
+  "peerDependencies": {
+    "@antelopejs/interface-api": ">=0.0.3 <1.0.0",
+    "@antelopejs/interface-core": ">=0.0.3 <1.0.0"
+  },
   "publishConfig": {
     "access": "public"
   }

package/skills/api-util-interface/SKILL.md

@@ -0,0 +1,81 @@
+---
+name: api-util-interface
+description: Provides handler-side utilities for AntelopeJS APIs built on @antelopejs/interface-api - assert and assertValidation turn failed checks into HTTPResult error responses, and the @RateLimit method decorator adds fixed-window throttling with 429/Retry-After and X-RateLimit headers. Use when code imports from "@antelopejs/interface-api-util", when validating request bodies (e.g. with a Zod schema) inside @Get/@Post handlers, when returning 400/404/403-style errors from API controllers, or when asked to rate limit a route.
+category: antelopejs-interface
+tags: [antelopejs, api, validation, rate-limit, http]
+---
+
+# API Util Interface
+
+Consumer-side helper library for AntelopeJS API modules. It is NOT an interface proxy itself:
+nothing here crosses an interface boundary, so there is no `ImplementInterface` side. Everything
+builds on its peer dependencies `@antelopejs/interface-api` (for `HTTPResult`, `RequestContext`,
+controller metadata) and `@antelopejs/interface-core` (decorator machinery). All failures surface
+as thrown `HTTPResult` values, which the API interface converts into HTTP responses.
+
+## Imports
+
+The package has a single export subpath (root only):
+
+```ts
+import { assert, assertValidation, RateLimit, type RateLimitOptions } from "@antelopejs/interface-api-util";
+```
+
+`hitWindow`, `pruneExpired`, and `resolveKey` are also exported but marked `@internal` (rate-limit
+plumbing, exposed for tests) — do not reach for them in application code.
+
+## Usage
+
+```ts
+import { Controller, Get, Post, HTTPResult, Parameter, RawBody } from "@antelopejs/interface-api";
+import { assert, assertValidation, RateLimit } from "@antelopejs/interface-api-util";
+import * as z from "zod";
+
+const createMemberSchema = z.object({ fullName: z.string().min(1), email: z.string().email() });
+
+class MembersController extends Controller("members") {
+  @Get(":id")
+  @RateLimit(100, 60_000)
+  async get(@Parameter("id") id: string) {
+    const member = await findMember(id);
+    assert(member, 404, "Member not found"); // narrows `member` to non-falsy below
+    return new HTTPResult(200, member);
+  }
+
+  @Post()
+  async create(@RawBody() body: Buffer) {
+    const { fullName, email } = assertValidation(body, (b) => createMemberSchema.parse(JSON.parse((b as Buffer).toString())));
+    return new HTTPResult(201, await saveMember({ fullName, email }));
+  }
+}
+```
+
+- `assert(condition, code, message)` — throws `new HTTPResult(code, message)` when falsy; uses
+  TypeScript `asserts condition`, so the compiler narrows after the call.
+- `assertValidation(body, validator, errorFunc?, code = 400)` — returns the validator's result;
+  if the validator throws, rethrows an `HTTPResult` whose body is `errorFunc(err)` if provided,
+  otherwise `String(err)`.
+- `RateLimit(limit, windowMs, options?)` — fixed-window counter per key; over-limit requests throw
+  a 429 `HTTPResult` (with `Retry-After`) before the handler runs. Successful responses get
+  `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` (epoch seconds) headers.
+
+## Gotchas
+
+- Decorator ordering: `@RateLimit` must sit directly BENEATH the route decorator
+  (`@Get`, `@Post`, ...). Placed above it, the guard would be ignored — this is detected at
+  decoration time and throws an `Error` at startup instead of silently unprotecting the route.
+- Rate-limit keys default to the client IP (`context.rawRequest.socket.remoteAddress`). Behind a
+  proxy that is the proxy's address — supply `options.key` reading a trusted forwarded header. If
+  the custom `key` function returns a falsy value, the limiter falls back to the client IP rather
+  than merging those requests into one shared bucket.
+- Counts live in process memory: not shared across instances, reset on restart, pruned once the
+  window elapses. For distributed limits, enforce them in a shared store at the edge.
+- `options.message` customizes only the 429 body; the status code is fixed at 429.
+- These helpers only throw `HTTPResult`; they do not send responses themselves — they rely on the
+  API interface's handling of thrown `HTTPResult` values.
+
+## Deeper reference
+
+See this package's `docs/1.introduction.md` (Interface API Util Documentation: `assert`,
+`assertValidation`, `RateLimit` sections) and the shipped `dist/*.d.ts` typings. Do not duplicate
+them here.