@antelopejs/interface-api-util 0.0.3 → 0.1.0

package/README.md

@@ -7,7 +7,7 @@
 <a href="./docs/1.introduction.md"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
 </div>
 
-Utility functions for API request validation and error handling in AntelopeJS. This package provides `assert` and `assertValidation` helpers that throw structured HTTP error responses when conditions fail or input validation does not pass.
+Utility helpers for API request validation, rate limiting, and error handling in AntelopeJS. This package provides the `assert` and `assertValidation` helpers that throw structured HTTP error responses when conditions fail or input validation does not pass, plus the `@RateLimit` decorator that caps how often a handler can be called.
 
 ## Installation
 
@@ -23,4 +23,4 @@ Detailed documentation is available in the `docs` directory:
 
 ## License
 
-This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./rate-limit";
 /**
  * Assert a condition is truthy, throwing an HTTPResult error if false.
  *

package/dist/index.js

@@ -1,8 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.assert = assert;
 exports.assertValidation = assertValidation;
 const interface_api_1 = require("@antelopejs/interface-api");
+__exportStar(require("./rate-limit"), exports);
 /**
  * Assert a condition is truthy, throwing an HTTPResult error if false.
  *

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAwBA,wBAQC;AA0BD,4CAYC;AAtED,6DAAuD;AAEvD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,MAAM,CACpB,SAAY,EACZ,IAAY,EACZ,OAAe;IAEf,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,0BAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,gBAAgB,CAC9B,IAAa,EACb,SAA+B,EAC/B,SAAqC,EACrC,IAAI,GAAG,GAAG;IAEV,IAAI,CAAC;QACH,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,IAAI,0BAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AA0BA,wBAQC;AA0BD,4CAYC;AAxED,6DAAuD;AAEvD,+CAA6B;AAE7B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,MAAM,CACpB,SAAY,EACZ,IAAY,EACZ,OAAe;IAEf,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,0BAAU,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,gBAAgB,CAC9B,IAAa,EACb,SAA+B,EAC/B,SAAqC,EACrC,IAAI,GAAG,GAAG;IAEV,IAAI,CAAC;QACH,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACpD,MAAM,IAAI,0BAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACrC,CAAC;AACH,CAAC"}

package/dist/rate-limit.d.ts

@@ -0,0 +1,91 @@
+import { type RequestContext } from "@antelopejs/interface-api";
+interface RateLimitWindow {
+    count: number;
+    windowStart: number;
+}
+interface RateLimitDecision {
+    allowed: boolean;
+    remaining: number;
+    resetMs: number;
+}
+/**
+ * Options for the {@link RateLimit} decorator.
+ */
+export interface RateLimitOptions {
+    /**
+     * Derive the rate-limit key from the request context. When omitted, or when
+     * it returns a falsy value, the client IP
+     * (`context.rawRequest.socket.remoteAddress`) is used. Provide a custom
+     * function to key by user id, API key, or a forwarded header. The return
+     * type allows `null`/`undefined` so optional sources (a missing route
+     * parameter or header) can be returned directly without a cast.
+     */
+    key?: (context: RequestContext) => string | null | undefined;
+    /**
+     * Body sent with the `429` response. Defaults to `"Too many requests"`.
+     */
+    message?: string;
+}
+/**
+ * Apply the fixed-window algorithm to a single key.
+ *
+ * The window resets lazily on access once `windowMs` has elapsed since it
+ * started. `now` is passed in so callers (and tests) control the clock.
+ *
+ * @internal
+ */
+export declare function hitWindow(store: Map<string, RateLimitWindow>, key: string, limit: number, windowMs: number, now: number): RateLimitDecision;
+/**
+ * Drop windows that have fully elapsed, bounding the store to the keys seen
+ * within the current window rather than letting it grow forever.
+ *
+ * @internal
+ */
+export declare function pruneExpired(store: Map<string, RateLimitWindow>, windowMs: number, now: number): void;
+/**
+ * Resolve the rate-limit key for a request, falling back to the client IP when
+ * no custom key is provided or the custom key yields a falsy value.
+ *
+ * @internal
+ */
+export declare function resolveKey(context: RequestContext, options: RateLimitOptions): string;
+/**
+ * Rate-limit a route handler using a fixed window, counted per client.
+ *
+ * Each decorated handler keeps an in-memory, per-process count of requests for
+ * every key within a `windowMs` window. Successful responses carry the
+ * `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`
+ * (epoch seconds) headers so clients can self-pace. Once the count exceeds
+ * `limit`, the handler instead throws an `HTTPResult` with status `429` (adding
+ * a `Retry-After` header) without running, exactly like `assert`. Elapsed
+ * windows are pruned periodically, so the store is bounded by the keys seen
+ * within a single window (counts are not shared across processes).
+ *
+ * Place `@RateLimit` **directly beneath** the route decorator. The route
+ * decorator captures the handler's parameters when it is applied, so a
+ * `@RateLimit` placed above it would be ignored — this is detected at startup
+ * and throws rather than silently leaving the route unprotected.
+ *
+ * @param limit Maximum number of requests allowed per window
+ * @param windowMs Window duration in milliseconds
+ * @param options Optional custom key function and `429` message
+ * @throws {HTTPResult} Status `429` when the limit is exceeded
+ * @throws {Error} At decoration time if placed above its route decorator
+ *
+ * Example:
+ * ```ts
+ * @Get("users")
+ * @RateLimit(100, 60_000)
+ * getUsers() {
+ *   return new HTTPResult(200, { users: [] });
+ * }
+ *
+ * @Post("login")
+ * @RateLimit(5, 60_000, { key: (ctx) => ctx.routeParameters.tenant })
+ * login() {
+ *   return new HTTPResult(200, { ok: true });
+ * }
+ * ```
+ */
+export declare const RateLimit: (limit: number, windowMs: number, options?: RateLimitOptions | undefined) => import("@antelopejs/interface-core/decorators").MethodDecorator;
+export {};

package/dist/rate-limit.js

@@ -0,0 +1,158 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimit = void 0;
+exports.hitWindow = hitWindow;
+exports.pruneExpired = pruneExpired;
+exports.resolveKey = resolveKey;
+const interface_api_1 = require("@antelopejs/interface-api");
+const interface_core_1 = require("@antelopejs/interface-core");
+const decorators_1 = require("@antelopejs/interface-core/decorators");
+const TOO_MANY_REQUESTS = 429;
+const DEFAULT_MESSAGE = "Too many requests";
+const UNKNOWN_KEY = "unknown";
+const MILLISECONDS_PER_SECOND = 1000;
+const RETRY_AFTER_HEADER = "Retry-After";
+const RATELIMIT_LIMIT_HEADER = "X-RateLimit-Limit";
+const RATELIMIT_REMAINING_HEADER = "X-RateLimit-Remaining";
+const RATELIMIT_RESET_HEADER = "X-RateLimit-Reset";
+const ORDERING_ERROR = "@RateLimit must be placed directly beneath its route decorator (@Get, @Post, ...). " +
+    "A route for this handler is already registered, so the rate-limit guard would be ignored.";
+/**
+ * Apply the fixed-window algorithm to a single key.
+ *
+ * The window resets lazily on access once `windowMs` has elapsed since it
+ * started. `now` is passed in so callers (and tests) control the clock.
+ *
+ * @internal
+ */
+function hitWindow(store, key, limit, windowMs, now) {
+    const existing = store.get(key);
+    const isActive = existing !== undefined && now - existing.windowStart < windowMs;
+    const window = isActive ? existing : { count: 0, windowStart: now };
+    window.count += 1;
+    store.set(key, window);
+    return {
+        allowed: window.count <= limit,
+        remaining: Math.max(0, limit - window.count),
+        resetMs: window.windowStart + windowMs - now,
+    };
+}
+/**
+ * Drop windows that have fully elapsed, bounding the store to the keys seen
+ * within the current window rather than letting it grow forever.
+ *
+ * @internal
+ */
+function pruneExpired(store, windowMs, now) {
+    for (const [key, window] of store) {
+        if (now - window.windowStart >= windowMs) {
+            store.delete(key);
+        }
+    }
+}
+/**
+ * Resolve the rate-limit key for a request, falling back to the client IP when
+ * no custom key is provided or the custom key yields a falsy value.
+ *
+ * @internal
+ */
+function resolveKey(context, options) {
+    const custom = options.key?.(context);
+    if (custom) {
+        return custom;
+    }
+    return context.rawRequest.socket.remoteAddress ?? UNKNOWN_KEY;
+}
+function applyRateLimitHeaders(target, limit, decision, now) {
+    const resetEpochSeconds = Math.ceil((now + decision.resetMs) / MILLISECONDS_PER_SECOND);
+    target.addHeader(RATELIMIT_LIMIT_HEADER, String(limit));
+    target.addHeader(RATELIMIT_REMAINING_HEADER, String(decision.remaining));
+    target.addHeader(RATELIMIT_RESET_HEADER, String(resetEpochSeconds));
+}
+function buildLimitResult(limit, decision, now, options) {
+    const result = new interface_api_1.HTTPResult(TOO_MANY_REQUESTS, options.message ?? DEFAULT_MESSAGE);
+    const retryAfterSeconds = Math.ceil(decision.resetMs / MILLISECONDS_PER_SECOND);
+    result.addHeader(RETRY_AFTER_HEADER, String(retryAfterSeconds));
+    applyRateLimitHeaders(result, limit, decision, now);
+    return result;
+}
+function getControllerMeta(target) {
+    return (0, interface_core_1.GetMetadata)(target.constructor, interface_api_1.ControllerMeta);
+}
+function assertGuardWiringOrder(meta, key) {
+    const name = String(key);
+    const alreadyRouted = (0, interface_api_1.getRegisteredRoutes)().some((route) => route.properties === meta.computed_props && route.callbackName === name);
+    if (alreadyRouted) {
+        throw new Error(ORDERING_ERROR);
+    }
+}
+function nextFreeIndex(meta, key) {
+    const params = meta.computed_params[key];
+    if (!params) {
+        return 0;
+    }
+    const indices = Object.keys(params).map((value) => Number.parseInt(value, 10));
+    return indices.length === 0 ? 0 : Math.max(...indices) + 1;
+}
+/**
+ * Rate-limit a route handler using a fixed window, counted per client.
+ *
+ * Each decorated handler keeps an in-memory, per-process count of requests for
+ * every key within a `windowMs` window. Successful responses carry the
+ * `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`
+ * (epoch seconds) headers so clients can self-pace. Once the count exceeds
+ * `limit`, the handler instead throws an `HTTPResult` with status `429` (adding
+ * a `Retry-After` header) without running, exactly like `assert`. Elapsed
+ * windows are pruned periodically, so the store is bounded by the keys seen
+ * within a single window (counts are not shared across processes).
+ *
+ * Place `@RateLimit` **directly beneath** the route decorator. The route
+ * decorator captures the handler's parameters when it is applied, so a
+ * `@RateLimit` placed above it would be ignored — this is detected at startup
+ * and throws rather than silently leaving the route unprotected.
+ *
+ * @param limit Maximum number of requests allowed per window
+ * @param windowMs Window duration in milliseconds
+ * @param options Optional custom key function and `429` message
+ * @throws {HTTPResult} Status `429` when the limit is exceeded
+ * @throws {Error} At decoration time if placed above its route decorator
+ *
+ * Example:
+ * ```ts
+ * @Get("users")
+ * @RateLimit(100, 60_000)
+ * getUsers() {
+ *   return new HTTPResult(200, { users: [] });
+ * }
+ *
+ * @Post("login")
+ * @RateLimit(5, 60_000, { key: (ctx) => ctx.routeParameters.tenant })
+ * login() {
+ *   return new HTTPResult(200, { ok: true });
+ * }
+ * ```
+ */
+exports.RateLimit = (0, decorators_1.MakeMethodDecorator)((target, key, _descriptor, limit, windowMs, options) => {
+    const resolvedOptions = options ?? {};
+    const meta = getControllerMeta(target);
+    assertGuardWiringOrder(meta, key);
+    const store = new Map();
+    let lastSweep = 0;
+    const index = nextFreeIndex(meta, key);
+    (0, interface_api_1.SetParameterProvider)(target, key, index, (context) => {
+        const now = Date.now();
+        if (now - lastSweep >= windowMs) {
+            pruneExpired(store, windowMs, now);
+            lastSweep = now;
+        }
+        const decision = hitWindow(store, resolveKey(context, resolvedOptions), limit, windowMs, now);
+        if (!decision.allowed) {
+            throw buildLimitResult(limit, decision, now, resolvedOptions);
+        }
+        if (context.response) {
+            applyRateLimitHeaders(context.response, limit, decision, now);
+        }
+        return undefined;
+    });
+});
+//# sourceMappingURL=rate-limit.js.map

package/dist/rate-limit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limit.js","sourceRoot":"","sources":["../src/rate-limit.ts"],"names":[],"mappings":";;;AA6DA,8BAkBC;AAQD,oCAUC;AAQD,gCASC;AAlHD,6DAMmC;AACnC,+DAAyD;AACzD,sEAA4E;AAE5E,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,eAAe,GAAG,mBAAmB,CAAC;AAC5C,MAAM,WAAW,GAAG,SAAS,CAAC;AAC9B,MAAM,uBAAuB,GAAG,IAAI,CAAC;AACrC,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AACnD,MAAM,0BAA0B,GAAG,uBAAuB,CAAC;AAC3D,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AACnD,MAAM,cAAc,GAClB,qFAAqF;IACrF,2FAA2F,CAAC;AAiC9F;;;;;;;GAOG;AACH,SAAgB,SAAS,CACvB,KAAmC,EACnC,GAAW,EACX,KAAa,EACb,QAAgB,EAChB,GAAW;IAEX,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,MAAM,QAAQ,GACZ,QAAQ,KAAK,SAAS,IAAI,GAAG,GAAG,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC;IAClE,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC;IACpE,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC;IAClB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACvB,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,KAAK,IAAI,KAAK;QAC9B,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC5C,OAAO,EAAE,MAAM,CAAC,WAAW,GAAG,QAAQ,GAAG,GAAG;KAC7C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,KAAmC,EACnC,QAAgB,EAChB,GAAW;IAEX,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,KAAK,EAAE,CAAC;QAClC,IAAI,GAAG,GAAG,MAAM,CAAC,WAAW,IAAI,QAAQ,EAAE,CAAC;YACzC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,OAAuB,EACvB,OAAyB;IAEzB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;IACtC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,aAAa,IAAI,WAAW,CAAC;AAChE,CAAC;AAED,SAAS,qBAAqB,CAC5B,MAAkB,EAClB,KAAa,EACb,QAA2B,EAC3B,GAAW;IAEX,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CACjC,CAAC,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,uBAAuB,CACnD,CAAC;IACF,MAAM,CAAC,SAAS,CAAC,sBAAsB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,MAAM,CAAC,SAAS,CAAC,0BAA0B,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IACzE,MAAM,CAAC,SAAS,CAAC,sBAAsB,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;AACtE,CAAC;AAED,SAAS,gBAAgB,CACvB,KAAa,EACb,QAA2B,EAC3B,GAAW,EACX,OAAyB;IAEzB,MAAM,MAAM,GAAG,IAAI,0BAAU,CAC3B,iBAAiB,EACjB,OAAO,CAAC,OAAO,IAAI,eAAe,CACnC,CAAC;IACF,MAAM,iBAAiB,GAAG,IAAI,CAAC,IAAI,CACjC,QAAQ,CAAC,OAAO,GAAG,uBAAuB,CAC3C,CAAC;IACF,MAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAChE,qBAAqB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IACpD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAgC;IACzD,OAAO,IAAA,4BAAW,EAAC,MAAM,CAAC,WAAoB,EAAE,8BAAc,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,sBAAsB,CAAC,IAAoB,EAAE,GAAgB;IACpE,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IACzB,MAAM,aAAa,GAAG,IAAA,mCAAmB,GAAE,CAAC,IAAI,CAC9C,CAAC,KAAK,EAAE,EAAE,CACR,KAAK,CAAC,UAAU,KAAK,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,YAAY,KAAK,IAAI,CAC1E,CAAC;IACF,IAAI,aAAa,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CAAC,IAAoB,EAAE,GAAgB;IAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,CAAC;IACX,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAChD,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAC3B,CAAC;IACF,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACU,QAAA,SAAS,GAAG,IAAA,gCAAmB,EAC1C,CACE,MAAM,EACN,GAAG,EACH,WAAW,EACX,KAAa,EACb,QAAgB,EAChB,OAA0B,EAC1B,EAAE;IACF,MAAM,eAAe,GAAG,OAAO,IAAI,EAAE,CAAC;IACtC,MAAM,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACvC,sBAAsB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,GAAG,EAA2B,CAAC;IACjD,IAAI,SAAS,GAAG,CAAC,CAAC;IAClB,MAAM,KAAK,GAAG,aAAa,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IACvC,IAAA,oCAAoB,EAAC,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE;QACnD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,GAAG,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC;YAChC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;YACnC,SAAS,GAAG,GAAG,CAAC;QAClB,CAAC;QACD,MAAM,QAAQ,GAAG,SAAS,CACxB,KAAK,EACL,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC,EACpC,KAAK,EACL,QAAQ,EACR,GAAG,CACJ,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,gBAAgB,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,eAAe,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrB,qBAAqB,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;QAChE,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC,CACF,CAAC"}

package/dist/tests/rate-limit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/rate-limit.test.js

@@ -0,0 +1,202 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_assert_1 = __importDefault(require("node:assert"));
+const interface_api_1 = require("@antelopejs/interface-api");
+const interface_core_1 = require("@antelopejs/interface-core");
+const rate_limit_1 = require("../rate-limit");
+const TOO_MANY_REQUESTS = 429;
+const LIMIT = 2;
+const WINDOW_MS = 60_000;
+const RETRY_AFTER_HEADER = "Retry-After";
+const RATELIMIT_LIMIT_HEADER = "X-RateLimit-Limit";
+const RATELIMIT_REMAINING_HEADER = "X-RateLimit-Remaining";
+const RATELIMIT_RESET_HEADER = "X-RateLimit-Reset";
+function toHTTPResult(error) {
+    if (!(error instanceof interface_api_1.HTTPResult)) {
+        throw new Error("Expected an HTTPResult error");
+    }
+    return error;
+}
+function makeContext(remoteAddress) {
+    return {
+        rawRequest: { socket: { remoteAddress } },
+        response: new interface_api_1.HTTPResult(),
+    };
+}
+function captureThrow(action) {
+    try {
+        action();
+    }
+    catch (error) {
+        return error;
+    }
+    throw new Error("Expected the action to throw");
+}
+function guardProvider(controller) {
+    const meta = (0, interface_core_1.GetMetadata)(controller, interface_api_1.ControllerMeta);
+    const provider = meta.computed_params.handler[0]?.provider;
+    if (!provider) {
+        throw new Error("Expected a rate-limit provider to be registered");
+    }
+    return provider;
+}
+describe("RateLimit", () => {
+    describe("hitWindow", () => {
+        it("allows up to the limit then denies within the window", () => {
+            const store = new Map();
+            const first = (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 0);
+            const second = (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 10);
+            const third = (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 20);
+            node_assert_1.default.equal(first.allowed, true);
+            node_assert_1.default.equal(first.remaining, 1);
+            node_assert_1.default.equal(second.allowed, true);
+            node_assert_1.default.equal(second.remaining, 0);
+            node_assert_1.default.equal(third.allowed, false);
+            node_assert_1.default.equal(third.remaining, 0);
+        });
+        it("reports the time remaining until the window resets", () => {
+            const store = new Map();
+            (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 1000);
+            const decision = (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 1500);
+            node_assert_1.default.equal(decision.resetMs, WINDOW_MS - 500);
+        });
+        it("resets the window once it has elapsed", () => {
+            const store = new Map();
+            (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 0);
+            (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 1);
+            const denied = (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 2);
+            const afterReset = (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, WINDOW_MS + 5);
+            node_assert_1.default.equal(denied.allowed, false);
+            node_assert_1.default.equal(afterReset.allowed, true);
+            node_assert_1.default.equal(afterReset.remaining, 1);
+        });
+        it("tracks each key independently", () => {
+            const store = new Map();
+            (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 0);
+            (0, rate_limit_1.hitWindow)(store, "a", LIMIT, WINDOW_MS, 1);
+            const otherKey = (0, rate_limit_1.hitWindow)(store, "b", LIMIT, WINDOW_MS, 2);
+            node_assert_1.default.equal(otherKey.allowed, true);
+            node_assert_1.default.equal(otherKey.remaining, 1);
+        });
+    });
+    describe("pruneExpired", () => {
+        it("removes only windows whose duration has fully elapsed", () => {
+            const store = new Map();
+            (0, rate_limit_1.hitWindow)(store, "old", LIMIT, WINDOW_MS, 0);
+            (0, rate_limit_1.hitWindow)(store, "fresh", LIMIT, WINDOW_MS, WINDOW_MS);
+            (0, rate_limit_1.pruneExpired)(store, WINDOW_MS, WINDOW_MS + 1);
+            node_assert_1.default.equal(store.has("old"), false);
+            node_assert_1.default.equal(store.has("fresh"), true);
+        });
+    });
+    describe("resolveKey", () => {
+        it("uses the custom key function when provided", () => {
+            const options = { key: () => "custom" };
+            node_assert_1.default.equal((0, rate_limit_1.resolveKey)(makeContext("1.2.3.4"), options), "custom");
+        });
+        it("falls back to the client IP", () => {
+            node_assert_1.default.equal((0, rate_limit_1.resolveKey)(makeContext("1.2.3.4"), {}), "1.2.3.4");
+        });
+        it("uses a fallback key when the IP is unknown", () => {
+            node_assert_1.default.equal((0, rate_limit_1.resolveKey)(makeContext(undefined), {}), "unknown");
+        });
+        it("falls back to the client IP when the custom key is falsy", () => {
+            const options = { key: () => undefined };
+            node_assert_1.default.equal((0, rate_limit_1.resolveKey)(makeContext("1.2.3.4"), options), "1.2.3.4");
+        });
+    });
+    describe("decorator", () => {
+        it("registers a guard provider at the trailing parameter index", () => {
+            class Indexed extends (0, interface_api_1.Controller)("rate-limit-index") {
+                handler() { }
+            }
+            const proto = Indexed.prototype;
+            (0, interface_api_1.SetParameterProvider)(proto, "handler", 0, () => "existing");
+            (0, rate_limit_1.RateLimit)(LIMIT, WINDOW_MS)(proto, "handler", {
+                value: proto.handler,
+            });
+            const meta = (0, interface_core_1.GetMetadata)(Indexed, interface_api_1.ControllerMeta);
+            node_assert_1.default.ok(meta.computed_params.handler[1]?.provider);
+        });
+        it("passes while under the limit and throws 429 once exceeded", () => {
+            class Limited extends (0, interface_api_1.Controller)("rate-limit-behavior") {
+                handler() {
+                    return new interface_api_1.HTTPResult(200, "ok");
+                }
+            }
+            __decorate([
+                (0, rate_limit_1.RateLimit)(LIMIT, WINDOW_MS),
+                __metadata("design:type", Function),
+                __metadata("design:paramtypes", []),
+                __metadata("design:returntype", void 0)
+            ], Limited.prototype, "handler", null);
+            const provider = guardProvider(Limited);
+            const context = makeContext("9.9.9.9");
+            node_assert_1.default.equal(provider(context), undefined);
+            node_assert_1.default.equal(provider(context), undefined);
+            const error = toHTTPResult(captureThrow(() => provider(context)));
+            const headers = error.getHeaders();
+            const retryAfter = Number(headers[RETRY_AFTER_HEADER]);
+            node_assert_1.default.equal(error.getStatus(), TOO_MANY_REQUESTS);
+            node_assert_1.default.equal(headers[RATELIMIT_LIMIT_HEADER], String(LIMIT));
+            node_assert_1.default.equal(headers[RATELIMIT_REMAINING_HEADER], "0");
+            node_assert_1.default.ok(retryAfter > 0);
+            node_assert_1.default.ok(Number(headers[RATELIMIT_RESET_HEADER]) > retryAfter);
+        });
+        it("emits rate-limit headers on the successful response", () => {
+            class Counted extends (0, interface_api_1.Controller)("rate-limit-headers") {
+                handler() { }
+            }
+            __decorate([
+                (0, rate_limit_1.RateLimit)(LIMIT, WINDOW_MS),
+                __metadata("design:type", Function),
+                __metadata("design:paramtypes", []),
+                __metadata("design:returntype", void 0)
+            ], Counted.prototype, "handler", null);
+            const provider = guardProvider(Counted);
+            const context = makeContext("5.5.5.5");
+            node_assert_1.default.equal(provider(context), undefined);
+            const headers = context.response.getHeaders();
+            node_assert_1.default.equal(headers[RATELIMIT_LIMIT_HEADER], String(LIMIT));
+            node_assert_1.default.equal(headers[RATELIMIT_REMAINING_HEADER], String(LIMIT - 1));
+            node_assert_1.default.ok(Number(headers[RATELIMIT_RESET_HEADER]) > 0);
+        });
+        it("keys requests separately so other clients are unaffected", () => {
+            class Scoped extends (0, interface_api_1.Controller)("rate-limit-scope") {
+                handler() { }
+            }
+            __decorate([
+                (0, rate_limit_1.RateLimit)(LIMIT, WINDOW_MS),
+                __metadata("design:type", Function),
+                __metadata("design:paramtypes", []),
+                __metadata("design:returntype", void 0)
+            ], Scoped.prototype, "handler", null);
+            const provider = guardProvider(Scoped);
+            provider(makeContext("1.1.1.1"));
+            provider(makeContext("1.1.1.1"));
+            node_assert_1.default.equal(provider(makeContext("2.2.2.2")), undefined);
+        });
+        it("throws at decoration time when placed above its route decorator", () => {
+            class Misordered extends (0, interface_api_1.Controller)("rate-limit-misorder") {
+                handler() { }
+            }
+            const proto = Misordered.prototype;
+            const descriptor = { value: proto.handler };
+            (0, interface_api_1.Get)()(proto, "handler", descriptor);
+            node_assert_1.default.throws(() => (0, rate_limit_1.RateLimit)(LIMIT, WINDOW_MS)(proto, "handler", descriptor), /directly beneath/);
+        });
+    });
+});
+//# sourceMappingURL=rate-limit.test.js.map

package/dist/tests/rate-limit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rate-limit.test.js","sourceRoot":"","sources":["../../src/tests/rate-limit.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,8DAAqC;AACrC,6DAQmC;AACnC,+DAAyD;AACzD,8CAMuB;AAEvB,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,KAAK,GAAG,CAAC,CAAC;AAChB,MAAM,SAAS,GAAG,MAAM,CAAC;AACzB,MAAM,kBAAkB,GAAG,aAAa,CAAC;AACzC,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AACnD,MAAM,0BAA0B,GAAG,uBAAuB,CAAC;AAC3D,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEnD,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,CAAC,CAAC,KAAK,YAAY,0BAAU,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,aAAsB;IACzC,OAAO;QACL,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE;QACzC,QAAQ,EAAE,IAAI,0BAAU,EAAE;KACE,CAAC;AACjC,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACtC,IAAI,CAAC;QACH,MAAM,EAAE,CAAC;IACX,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,aAAa,CACpB,UAA2B;IAE3B,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,UAAU,EAAE,8BAAc,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;IAC3D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IACzB,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YACzD,MAAM,MAAM,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;YAC3D,MAAM,KAAK,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;YAE1D,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACtC,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACrC,qBAAU,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACvC,qBAAU,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;YACtC,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACvC,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YACxB,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC9C,MAAM,QAAQ,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAE/D,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,GAAG,GAAG,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YACxB,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC3C,MAAM,MAAM,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC1D,MAAM,UAAU,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;YAE1E,qBAAU,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACxC,qBAAU,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC3C,qBAAU,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YACxB,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC3C,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC3C,MAAM,QAAQ,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAE5D,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACzC,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,MAAM,KAAK,GAAG,IAAI,GAAG,EAAE,CAAC;YACxB,IAAA,sBAAS,EAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC;YAC7C,IAAA,sBAAS,EAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;YAEvD,IAAA,yBAAY,EAAC,KAAK,EAAE,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC;YAE9C,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;YAC1C,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,OAAO,GAAqB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAC1D,qBAAU,CAAC,KAAK,CAAC,IAAA,uBAAU,EAAC,WAAW,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC1E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,qBAAU,CAAC,KAAK,CAAC,IAAA,uBAAU,EAAC,WAAW,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,qBAAU,CAAC,KAAK,CAAC,IAAA,uBAAU,EAAC,WAAW,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,OAAO,GAAqB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,SAAS,EAAE,CAAC;YAC3D,qBAAU,CAAC,KAAK,CAAC,IAAA,uBAAU,EAAC,WAAW,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,OAAQ,SAAQ,IAAA,0BAAU,EAAC,kBAAkB,CAAC;gBAClD,OAAO,KAAI,CAAC;aACb;YACD,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC;YAChC,IAAA,oCAAoB,EAAC,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,UAAU,CAAC,CAAC;YAC5D,IAAA,sBAAS,EAAC,KAAK,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE;gBAC5C,KAAK,EAAE,KAAK,CAAC,OAAO;aACC,CAAC,CAAC;YAEzB,MAAM,IAAI,GAAG,IAAA,4BAAW,EAAC,OAAO,EAAE,8BAAc,CAAC,CAAC;YAClD,qBAAU,CAAC,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC3D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,OAAQ,SAAQ,IAAA,0BAAU,EAAC,qBAAqB,CAAC;gBAErD,OAAO;oBACL,OAAO,IAAI,0BAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBACnC,CAAC;aACF;YAHC;gBADC,IAAA,sBAAS,EAAC,KAAK,EAAE,SAAS,CAAC;;;;kDAG3B;YAEH,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACxC,MAAM,OAAO,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YAEvC,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;YAC/C,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;YAE/C,MAAM,KAAK,GAAG,YAAY,CAAC,YAAY,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAClE,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;YACnC,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;YACvD,qBAAU,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,iBAAiB,CAAC,CAAC;YACvD,qBAAU,CAAC,KAAK,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACjE,qBAAU,CAAC,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,EAAE,GAAG,CAAC,CAAC;YAC3D,qBAAU,CAAC,EAAE,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;YAC9B,qBAAU,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,OAAQ,SAAQ,IAAA,0BAAU,EAAC,oBAAoB,CAAC;gBAEpD,OAAO,KAAI,CAAC;aACb;YADC;gBADC,IAAA,sBAAS,EAAC,KAAK,EAAE,SAAS,CAAC;;;;kDAChB;YAEd,MAAM,QAAQ,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACxC,MAAM,OAAO,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;YAEvC,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;YAE/C,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC9C,qBAAU,CAAC,KAAK,CAAC,OAAO,CAAC,sBAAsB,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACjE,qBAAU,CAAC,KAAK,CAAC,OAAO,CAAC,0BAA0B,CAAC,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;YACzE,qBAAU,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,MAAO,SAAQ,IAAA,0BAAU,EAAC,kBAAkB,CAAC;gBAEjD,OAAO,KAAI,CAAC;aACb;YADC;gBADC,IAAA,sBAAS,EAAC,KAAK,EAAE,SAAS,CAAC;;;;iDAChB;YAEd,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YAEvC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACjC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,CAAC;YACjC,qBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;YACzE,MAAM,UAAW,SAAQ,IAAA,0BAAU,EAAC,qBAAqB,CAAC;gBACxD,OAAO,KAAI,CAAC;aACb;YACD,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC;YACnC,MAAM,UAAU,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAwB,CAAC;YAElE,IAAA,mBAAG,GAAE,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;YAEpC,qBAAU,CAAC,MAAM,CACf,GAAG,EAAE,CAAC,IAAA,sBAAS,EAAC,KAAK,EAAE,SAAS,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,UAAU,CAAC,EAC/D,kBAAkB,CACnB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antelopejs/interface-api-util",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "AntelopeJS utility functions for API request validation and error handling",
   "keywords": [
     "antelopejs",
@@ -39,7 +39,7 @@
     "test": "src/antelope.test.ts"
   },
   "dependencies": {
-    "@antelopejs/interface-api": "^0.0.2",
+    "@antelopejs/interface-api": "^0.0.3",
     "@antelopejs/interface-core": "^0.0.3"
   },
   "devDependencies": {