@prosopo/api-route 2.6.52 → 2.6.53

package/.turbo/turbo-build$colon$cjs.log

@@ -1,5 +1,5 @@
 
-> @prosopo/api-route@2.6.52 build:cjs
+> @prosopo/api-route@2.6.53 build:cjs
 > NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV
 
 ViteCommonJSConfig: .
@@ -10,14 +10,16 @@ ViteCommonJSConfig: .
   ]
 }
 { externals: [ '@prosopo/logger', '@prosopo/util' ] }
-vite v6.4.1 building SSR bundle for production...
+The plugin "vite-tsconfig-paths" is detected. Vite now supports tsconfig paths resolution natively via the resolve.tsconfigPaths option. You can remove the plugin and set resolve.tsconfigPaths: true in your Vite config instead.
+vite v8.1.5 building ssr environment for production...
 Bundle build started
-transforming...
-Build end
-✓ 4 modules transformed.
+
+✓ 5 modules transformed.
 rendering chunks...
-dist/cjs/.export.cjs                             0.01 kB
-dist/cjs/endpoint/.export.cjs                    0.25 kB
-dist/cjs/index.cjs                               0.32 kB
-dist/cjs/endpoint/apiEndpointResponseStatus.cjs  0.47 kB
-✓ built in 122ms
+computing gzip size...
+dist/cjs/.export.cjs                             0.00 kB │ gzip: 0.02 kB
+dist/cjs/endpoint/.export.cjs                    0.18 kB │ gzip: 0.09 kB
+dist/cjs/index.cjs                               0.26 kB │ gzip: 0.15 kB
+dist/cjs/endpoint/apiEndpointResponseStatus.cjs  0.43 kB │ gzip: 0.19 kB
+
+✓ built in 64ms

package/.turbo/turbo-build$colon$tsc.log

@@ -1,20 +1,20 @@
 
-> @prosopo/api-route@2.6.52 build:tsc
+> @prosopo/api-route@2.6.53 build:tsc
 > tsc --build --verbose
 
-1:21:07 PM - Projects in this build: 
+8:58:52 PM - Projects in this build: 
     * ../../dev/config/tsconfig.json
     * ../util/tsconfig.json
     * ../logger/tsconfig.json
     * tsconfig.json
 
-1:21:08 PM - Project '../../dev/config/tsconfig.json' is up to date because newest input '../../dev/config/src/webpack/webpack.config.ts' is older than output '../../dev/config/tsconfig.tsbuildinfo'
+8:58:52 PM - Project '../../dev/config/tsconfig.json' is up to date because newest input '../../dev/config/src/webpack/webpack.config.ts' is older than output '../../dev/config/tsconfig.tsbuildinfo'
 
-1:21:08 PM - Project '../util/tsconfig.json' is up to date because newest input '../util/src/url.ts' is older than output '../util/tsconfig.tsbuildinfo'
+8:58:52 PM - Project '../util/tsconfig.json' is up to date because newest input '../util/src/url.ts' is older than output '../util/tsconfig.tsbuildinfo'
 
-1:21:08 PM - Project '../logger/tsconfig.json' is up to date because newest input '../logger/src/index.ts' is older than output '../logger/tsconfig.tsbuildinfo'
+8:58:52 PM - Project '../logger/tsconfig.json' is up to date because newest input '../logger/src/index.ts' is older than output '../logger/tsconfig.tsbuildinfo'
 
-1:21:08 PM - Project 'tsconfig.json' is out of date because output file 'tsconfig.tsbuildinfo' does not exist
+8:58:52 PM - Project 'tsconfig.json' is out of date because output file 'tsconfig.tsbuildinfo' does not exist
 
-1:21:08 PM - Building project '/home/runner/work/captcha/captcha/packages/api-route/tsconfig.json'...
+8:58:52 PM - Building project '/home/runner/work/captcha/captcha/packages/api-route/tsconfig.json'...
 

package/.turbo/turbo-build.log

@@ -1,9 +1,9 @@
 
-> @prosopo/api-route@2.6.52 build
+> @prosopo/api-route@2.6.53 build
 > npm run build:cross-env -- --mode ${NODE_ENV:-development}
 
 
-> @prosopo/api-route@2.6.52 build:cross-env
+> @prosopo/api-route@2.6.53 build:cross-env
 > vite build --config vite.esm.config.ts --mode production
 
 ViteEsmConfig: .
@@ -14,14 +14,17 @@ ViteEsmConfig: .
   ]
 }
 { externals: [ '@prosopo/logger', '@prosopo/util' ] }
-vite v6.4.1 building SSR bundle for production...
+The plugin "vite-tsconfig-paths" is detected. Vite now supports tsconfig paths resolution natively via the resolve.tsconfigPaths option. You can remove the plugin and set resolve.tsconfigPaths: true in your Vite config instead.
+vite v8.1.5 building ssr environment for production...
 Bundle build started
-transforming...
-Build end
-✓ 4 modules transformed.
+
+✓ 5 modules transformed.
 rendering chunks...
-dist/.export.js                             0.00 kB
-dist/endpoint/.export.js                    0.12 kB
-dist/index.js                               0.18 kB
-dist/endpoint/apiEndpointResponseStatus.js  0.36 kB
-✓ built in 119ms
+computing gzip size...
+dist/.export.js                             0.01 kB │ gzip: 0.03 kB
+dist/_virtual/_rolldown/runtime.js          0.04 kB │ gzip: 0.06 kB
+dist/endpoint/.export.js                    0.11 kB │ gzip: 0.08 kB
+dist/index.js                               0.16 kB │ gzip: 0.11 kB
+dist/endpoint/apiEndpointResponseStatus.js  0.41 kB │ gzip: 0.19 kB
+
+✓ built in 88ms

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @prosopo/api-route
 
+## 2.6.53
+### Patch Changes
+
+- a58d007: test(api-route): cover the endpoint contract, and export ApiRouteLimit
+  
+  This package ships exactly one runtime value, so most of its business logic
+  lives in its types — notably the conditional signature of
+  `ApiEndpoint.processRequest`, which gives an endpoint with a schema its parsed
+  arguments and an endpoint without one no arguments at all. Both branches are
+  now covered by type tests, alongside runtime tests for the response status enum
+  (its strings cross the wire and are compared literally by clients) and for the
+  package's export surface.
+  
+  Writing them surfaced a gap: `ApiRouteLimit` was declared but never re-exported,
+  so a consumer assembling an `ApiRouteLimits` record entry by entry had no way to
+  name what it was building and had to redeclare the shape. It is now exported.
+  - @prosopo/logger@2.0.4
+
 ## 2.6.52
 ### Patch Changes
 

package/dist/.export.d.ts

@@ -1,2 +1,2 @@
-export type { ApiRoutes, ApiRoutesProvider, ApiRouteLimits, } from "./apiRoutes.js";
+export type { ApiRoutes, ApiRoutesProvider, ApiRouteLimit, ApiRouteLimits, } from "./apiRoutes.js";
 //# sourceMappingURL=.export.d.ts.map

package/dist/.export.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":".export.d.ts","sourceRoot":"","sources":["../src/.export.ts"],"names":[],"mappings":"AAcA,YAAY,EACX,SAAS,EACT,iBAAiB,EACjB,cAAc,GACd,MAAM,gBAAgB,CAAC"}
+{"version":3,"file":".export.d.ts","sourceRoot":"","sources":["../src/.export.ts"],"names":[],"mappings":"AAcA,YAAY,EACX,SAAS,EACT,iBAAiB,EAIjB,aAAa,EACb,cAAc,GACd,MAAM,gBAAgB,CAAC"}

package/dist/.export.js

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

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,3 @@
+import "node:module";
+//#endregion
+export {};

package/dist/cjs/.export.cjs

@@ -1 +0,0 @@
-"use strict";

package/dist/cjs/endpoint/.export.cjs

@@ -1,4 +1,2 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const apiEndpointResponseStatus = require("./apiEndpointResponseStatus.cjs");
-exports.ApiEndpointResponseStatus = apiEndpointResponseStatus.ApiEndpointResponseStatus;
+const require_apiEndpointResponseStatus = require("./apiEndpointResponseStatus.cjs");
+exports.ApiEndpointResponseStatus = require_apiEndpointResponseStatus.ApiEndpointResponseStatus;

package/dist/cjs/endpoint/apiEndpointResponseStatus.cjs

@@ -1,9 +1,9 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-var ApiEndpointResponseStatus = /* @__PURE__ */ ((ApiEndpointResponseStatus2) => {
-  ApiEndpointResponseStatus2["SUCCESS"] = "SUCCESS";
-  ApiEndpointResponseStatus2["FAIL"] = "FAIL";
-  ApiEndpointResponseStatus2["PROCESSING"] = "PROCESSING";
-  return ApiEndpointResponseStatus2;
-})(ApiEndpointResponseStatus || {});
+//#region src/endpoint/apiEndpointResponseStatus.ts
+var ApiEndpointResponseStatus = /* @__PURE__ */ function(ApiEndpointResponseStatus) {
+	ApiEndpointResponseStatus["SUCCESS"] = "SUCCESS";
+	ApiEndpointResponseStatus["FAIL"] = "FAIL";
+	ApiEndpointResponseStatus["PROCESSING"] = "PROCESSING";
+	return ApiEndpointResponseStatus;
+}(ApiEndpointResponseStatus || {});
+//#endregion
 exports.ApiEndpointResponseStatus = ApiEndpointResponseStatus;

package/dist/cjs/index.cjs

@@ -1,6 +1,3 @@
-"use strict";
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-require("./.export.cjs");
-require("./endpoint/.export.cjs");
-const apiEndpointResponseStatus = require("./endpoint/apiEndpointResponseStatus.cjs");
-exports.ApiEndpointResponseStatus = apiEndpointResponseStatus.ApiEndpointResponseStatus;
+const require_apiEndpointResponseStatus = require("./endpoint/apiEndpointResponseStatus.cjs");
+exports.ApiEndpointResponseStatus = require_apiEndpointResponseStatus.ApiEndpointResponseStatus;

package/dist/endpoint/.export.js

@@ -1,4 +1,2 @@
 import { ApiEndpointResponseStatus } from "./apiEndpointResponseStatus.js";
-export {
-  ApiEndpointResponseStatus
-};
+export { ApiEndpointResponseStatus };

package/dist/endpoint/apiEndpointResponseStatus.js

@@ -1,9 +1,9 @@
-var ApiEndpointResponseStatus = /* @__PURE__ */ ((ApiEndpointResponseStatus2) => {
-  ApiEndpointResponseStatus2["SUCCESS"] = "SUCCESS";
-  ApiEndpointResponseStatus2["FAIL"] = "FAIL";
-  ApiEndpointResponseStatus2["PROCESSING"] = "PROCESSING";
-  return ApiEndpointResponseStatus2;
-})(ApiEndpointResponseStatus || {});
-export {
-  ApiEndpointResponseStatus
-};
+//#region src/endpoint/apiEndpointResponseStatus.ts
+var ApiEndpointResponseStatus = /* @__PURE__ */ function(ApiEndpointResponseStatus) {
+	ApiEndpointResponseStatus["SUCCESS"] = "SUCCESS";
+	ApiEndpointResponseStatus["FAIL"] = "FAIL";
+	ApiEndpointResponseStatus["PROCESSING"] = "PROCESSING";
+	return ApiEndpointResponseStatus;
+}(ApiEndpointResponseStatus || {});
+//#endregion
+export { ApiEndpointResponseStatus };

package/dist/index.js

@@ -1,6 +1,3 @@
-import "./.export.js";
-import "./endpoint/.export.js";
+import "./_virtual/_rolldown/runtime.js";
 import { ApiEndpointResponseStatus } from "./endpoint/apiEndpointResponseStatus.js";
-export {
-  ApiEndpointResponseStatus
-};
+export { ApiEndpointResponseStatus };

package/dist/tests/apiRoute.test-d.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=apiRoute.test-d.d.ts.map

package/dist/tests/apiRoute.test-d.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiRoute.test-d.d.ts","sourceRoot":"","sources":["../../src/tests/apiRoute.test-d.ts"],"names":[],"mappings":""}

package/dist/tests/apiRoute.test-d.js

@@ -0,0 +1,126 @@
+import { assertType, describe, expectTypeOf, it } from "vitest";
+import { ApiEndpointResponseStatus } from "../index.js";
+describe("ApiEndpoint.processRequest", () => {
+    it("takes the parsed arguments when the endpoint declares a schema", () => {
+        expectTypeOf().parameters.toEqualTypeOf();
+    });
+    it("takes no arguments at all when the schema is undefined", () => {
+        expectTypeOf().parameters.toEqualTypeOf();
+    });
+    it("keeps the logger optional on both branches", () => {
+        const withArgs = async () => ({
+            status: ApiEndpointResponseStatus.SUCCESS,
+        });
+        expectTypeOf(withArgs).toBeCallableWith({ siteKey: "abc" });
+        const withoutArgs = async () => ({
+            status: ApiEndpointResponseStatus.SUCCESS,
+        });
+        expectTypeOf(withoutArgs).toBeCallableWith();
+    });
+    it("always resolves to a response, never to void", () => {
+        expectTypeOf().returns.toEqualTypeOf();
+        expectTypeOf().returns.toEqualTypeOf();
+    });
+    it("rejects arguments that do not match the declared schema", () => {
+        const endpoint = {
+            getRequestArgsSchema: () => {
+                throw new Error("not called");
+            },
+            processRequest: async () => ({
+                status: ApiEndpointResponseStatus.SUCCESS,
+            }),
+        };
+        endpoint.processRequest({});
+    });
+    it("rejects an argument-free endpoint being called with arguments", () => {
+        const endpoint = {
+            getRequestArgsSchema: () => undefined,
+            processRequest: async () => ({
+                status: ApiEndpointResponseStatus.SUCCESS,
+            }),
+        };
+        endpoint.processRequest({ siteKey: "abc" });
+    });
+});
+describe("ApiEndpoint.getRequestArgsSchema", () => {
+    it("returns exactly the schema the endpoint was parameterised with", () => {
+        expectTypeOf().returns.toEqualTypeOf();
+        expectTypeOf().returns.toEqualTypeOf();
+    });
+    it("takes no arguments", () => {
+        expectTypeOf().parameters.toEqualTypeOf();
+    });
+});
+describe("ApiEndpointResponse", () => {
+    it("requires a status and nothing else", () => {
+        assertType({
+            status: ApiEndpointResponseStatus.SUCCESS,
+        });
+        assertType({ data: {} });
+    });
+    it("keeps data and error independently optional", () => {
+        expectTypeOf().toEqualTypeOf();
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("types the status as the enum, not a bare string", () => {
+        expectTypeOf().toEqualTypeOf();
+        assertType({ status: "OK" });
+    });
+    it("rejects an error that is not a string", () => {
+        assertType({
+            status: ApiEndpointResponseStatus.FAIL,
+            error: new Error("boom"),
+        });
+    });
+});
+describe("ApiRoutes", () => {
+    it("is keyed by route string and valued by endpoints of any schema", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+    it("accepts an empty record, for a provider with no endpoints yet", () => {
+        assertType({});
+    });
+    it("rejects a plain function in place of an endpoint", () => {
+        assertType({ "/x": async () => { } });
+    });
+});
+describe("ApiRoutesProvider", () => {
+    it("exposes the routes through a method, not a property", () => {
+        expectTypeOf().toEqualTypeOf();
+    });
+});
+describe("ApiRouteLimits", () => {
+    it("requires a limit for every member of the route enum", () => {
+        let Route;
+        (function (Route) {
+            Route["Verify"] = "verify";
+            Route["Submit"] = "submit";
+        })(Route || (Route = {}));
+        assertType({
+            [Route.Verify]: { windowMs: 1000, limit: 5 },
+            [Route.Submit]: { windowMs: 1000, limit: 5 },
+        });
+        assertType({
+            [Route.Verify]: { windowMs: 1000, limit: 5 },
+        });
+    });
+    it("requires both the window and the count on each limit", () => {
+        assertType({
+            verify: { windowMs: 1000 },
+        });
+        assertType({
+            verify: { limit: 5 },
+        });
+    });
+    it("exposes the entry type, so a consumer can name one limit", () => {
+        expectTypeOf().toEqualTypeOf();
+        assertType({ windowMs: 1000, limit: 5 });
+    });
+    it("works with a numeric route enum as well as a string one", () => {
+        assertType({
+            0: { windowMs: 1000, limit: 5 },
+            1: { windowMs: 1000, limit: 5 },
+        });
+    });
+});
+//# sourceMappingURL=apiRoute.test-d.js.map

package/dist/tests/apiRoute.test-d.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiRoute.test-d.js","sourceRoot":"","sources":["../../src/tests/apiRoute.test-d.ts"],"names":[],"mappings":"AAoBA,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAUhE,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAIxD,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC3C,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QAGzE,YAAY,EAET,CAAC,UAAU,CAAC,aAAa,EAEzB,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAIjE,YAAY,EAET,CAAC,UAAU,CAAC,aAAa,EAA2B,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QAGrD,MAAM,QAAQ,GACb,KAAK,IAAI,EAAE,CAAC,CAAC;YACZ,MAAM,EAAE,yBAAyB,CAAC,OAAO;SACzC,CAAC,CAAC;QACJ,YAAY,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5D,MAAM,WAAW,GAA6C,KAAK,IAAI,EAAE,CAAC,CAAC;YAC1E,MAAM,EAAE,yBAAyB,CAAC,OAAO;SACzC,CAAC,CAAC;QACH,YAAY,CAAC,WAAW,CAAC,CAAC,gBAAgB,EAAE,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAGvD,YAAY,EAET,CAAC,OAAO,CAAC,aAAa,EAAgC,CAAC;QAC1D,YAAY,EAET,CAAC,OAAO,CAAC,aAAa,EAAgC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QAClE,MAAM,QAAQ,GAA+B;YAC5C,oBAAoB,EAAE,GAAkB,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YAC/B,CAAC;YACD,cAAc,EAAE,KAAK,IAAkC,EAAE,CAAC,CAAC;gBAC1D,MAAM,EAAE,yBAAyB,CAAC,OAAO;aACzC,CAAC;SACF,CAAC;QAEF,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACxE,MAAM,QAAQ,GAA2B;YACxC,oBAAoB,EAAE,GAAc,EAAE,CAAC,SAAS;YAChD,cAAc,EAAE,KAAK,IAAkC,EAAE,CAAC,CAAC;gBAC1D,MAAM,EAAE,yBAAyB,CAAC,OAAO;aACzC,CAAC;SACF,CAAC;QAEF,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QAGzE,YAAY,EAET,CAAC,OAAO,CAAC,aAAa,EAAiB,CAAC;QAC3C,YAAY,EAET,CAAC,OAAO,CAAC,aAAa,EAAa,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAC7B,YAAY,EAET,CAAC,UAAU,CAAC,aAAa,EAAM,CAAC;IACpC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAE7C,UAAU,CAAsB;YAC/B,MAAM,EAAE,yBAAyB,CAAC,OAAO;SACzC,CAAC,CAAC;QAEH,UAAU,CAAsB,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QAGtD,YAAY,EAA+B,CAAC,aAAa,EAEtD,CAAC;QACJ,YAAY,EAAgC,CAAC,aAAa,EAEvD,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAC1D,YAAY,EAET,CAAC,aAAa,EAA6B,CAAC;QAE/C,UAAU,CAAsB,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAChD,UAAU,CAAsB;YAC/B,MAAM,EAAE,yBAAyB,CAAC,IAAI;YAEtC,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,CAAC;SACxB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACzE,YAAY,EAAa,CAAC,aAAa,EAEpC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACxE,UAAU,CAAY,EAAE,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAE3D,UAAU,CAAY,EAAE,IAAI,EAAE,KAAK,IAAmB,EAAE,GAAE,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAG9D,YAAY,EAAkC,CAAC,aAAa,EAEzD,CAAC;IACL,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;QAE9D,IAAK,KAGJ;QAHD,WAAK,KAAK;YACT,0BAAiB,CAAA;YACjB,0BAAiB,CAAA;QAClB,CAAC,EAHI,KAAK,KAAL,KAAK,QAGT;QACD,UAAU,CAAwB;YACjC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE;YAC5C,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE;SAC5C,CAAC,CAAC;QAEH,UAAU,CAAwB;YACjC,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE;SAC5C,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAG/D,UAAU,CAA2B;YAEpC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;SAC1B,CAAC,CAAC;QACH,UAAU,CAA2B;YAEpC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE;SACpB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAGnE,YAAY,EAET,CAAC,aAAa,EAAiB,CAAC;QACnC,UAAU,CAAgB,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QAElE,UAAU,CAAwB;YACjC,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE;YAC/B,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE;SAC/B,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/tests/apiRoute.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=apiRoute.unit.test.d.ts.map

package/dist/tests/apiRoute.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiRoute.unit.test.d.ts","sourceRoot":"","sources":["../../src/tests/apiRoute.unit.test.ts"],"names":[],"mappings":""}

package/dist/tests/apiRoute.unit.test.js

@@ -0,0 +1,102 @@
+import { describe, expect, it } from "vitest";
+import { z } from "zod";
+import * as api from "../index.js";
+import { ApiEndpointResponseStatus } from "../index.js";
+describe("ApiEndpointResponseStatus", () => {
+    it("keeps the exact strings clients compare against", () => {
+        expect(ApiEndpointResponseStatus.SUCCESS).toBe("SUCCESS");
+        expect(ApiEndpointResponseStatus.FAIL).toBe("FAIL");
+        expect(ApiEndpointResponseStatus.PROCESSING).toBe("PROCESSING");
+    });
+    it("declares exactly three statuses", () => {
+        expect(Object.keys(ApiEndpointResponseStatus)).toEqual([
+            "SUCCESS",
+            "FAIL",
+            "PROCESSING",
+        ]);
+    });
+    it("is a string enum, so it has no reverse numeric mapping", () => {
+        expect(Object.values(ApiEndpointResponseStatus)).toEqual([
+            "SUCCESS",
+            "FAIL",
+            "PROCESSING",
+        ]);
+    });
+    it("distinguishes failure from a still-running request", () => {
+        expect(ApiEndpointResponseStatus.PROCESSING).not.toBe(ApiEndpointResponseStatus.FAIL);
+        expect(ApiEndpointResponseStatus.PROCESSING).not.toBe(ApiEndpointResponseStatus.SUCCESS);
+    });
+});
+describe("public export surface", () => {
+    it("re-exports the status enum from the package root", () => {
+        expect(api.ApiEndpointResponseStatus).toBe(ApiEndpointResponseStatus);
+    });
+    it("ships the enum as its only runtime export", () => {
+        expect(Object.keys(api)).toEqual(["ApiEndpointResponseStatus"]);
+    });
+});
+describe("endpoint contract", () => {
+    const schema = z.object({ siteKey: z.string() });
+    const endpointWithArgs = {
+        getRequestArgsSchema: () => schema,
+        processRequest: async (args) => ({
+            status: ApiEndpointResponseStatus.SUCCESS,
+            data: { siteKey: args.siteKey },
+        }),
+    };
+    const endpointWithoutArgs = {
+        getRequestArgsSchema: () => undefined,
+        processRequest: async () => ({
+            status: ApiEndpointResponseStatus.SUCCESS,
+        }),
+    };
+    it("lets an implementation validate its own arguments with its schema", () => {
+        const parsed = endpointWithArgs
+            .getRequestArgsSchema()
+            .safeParse({ siteKey: "abc" });
+        expect(parsed.success).toBe(true);
+    });
+    it("rejects arguments the endpoint's own schema does not accept", () => {
+        const parsed = endpointWithArgs.getRequestArgsSchema().safeParse({});
+        expect(parsed.success).toBe(false);
+    });
+    it("allows an endpoint that takes no arguments at all", async () => {
+        expect(endpointWithoutArgs.getRequestArgsSchema()).toBeUndefined();
+        await expect(endpointWithoutArgs.processRequest()).resolves.toEqual({
+            status: ApiEndpointResponseStatus.SUCCESS,
+        });
+    });
+    it("carries the request arguments through to the response", async () => {
+        await expect(endpointWithArgs.processRequest({ siteKey: "abc" })).resolves.toEqual({
+            status: ApiEndpointResponseStatus.SUCCESS,
+            data: { siteKey: "abc" },
+        });
+    });
+    it("permits a response with neither data nor error", async () => {
+        const response = await endpointWithoutArgs.processRequest();
+        expect(response.data).toBeUndefined();
+        expect(response.error).toBeUndefined();
+    });
+    it("holds endpoints with differing schemas in one routes record", () => {
+        const routes = {
+            "/with": endpointWithArgs,
+            "/without": endpointWithoutArgs,
+        };
+        const provider = { getRoutes: () => routes };
+        expect(Object.keys(provider.getRoutes())).toEqual(["/with", "/without"]);
+    });
+    it("tolerates a provider that exposes no routes", () => {
+        const provider = { getRoutes: () => ({}) };
+        expect(Object.keys(provider.getRoutes())).toHaveLength(0);
+    });
+    it("surfaces a rejection rather than swallowing it into a FAIL response", async () => {
+        const throwing = {
+            getRequestArgsSchema: () => undefined,
+            processRequest: async () => {
+                throw new Error("boom");
+            },
+        };
+        await expect(throwing.processRequest()).rejects.toThrow("boom");
+    });
+});
+//# sourceMappingURL=apiRoute.unit.test.js.map

package/dist/tests/apiRoute.unit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiRoute.unit.test.js","sourceRoot":"","sources":["../../src/tests/apiRoute.unit.test.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,GAAG,MAAM,aAAa,CAAC;AAOnC,OAAO,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAExD,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QAG1D,MAAM,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1D,MAAM,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpD,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QAG1C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAC;YACtD,SAAS;YACT,MAAM;YACN,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAGjE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAC;YACxD,SAAS;YACT,MAAM;YACN,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAG7D,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CACpD,yBAAyB,CAAC,IAAI,CAC9B,CAAC;QACF,MAAM,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CACpD,yBAAyB,CAAC,OAAO,CACjC,CAAC;IACH,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACtC,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAE3D,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QAGpD,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,2BAA2B,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IAElC,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAEjD,MAAM,gBAAgB,GAA+B;QACpD,oBAAoB,EAAE,GAAG,EAAE,CAAC,MAAM;QAClC,cAAc,EAAE,KAAK,EACpB,IAA4B,EACG,EAAE,CAAC,CAAC;YACnC,MAAM,EAAE,yBAAyB,CAAC,OAAO;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE;SAC/B,CAAC;KACF,CAAC;IAEF,MAAM,mBAAmB,GAA2B;QACnD,oBAAoB,EAAE,GAAG,EAAE,CAAC,SAAS;QACrC,cAAc,EAAE,KAAK,IAAkC,EAAE,CAAC,CAAC;YAC1D,MAAM,EAAE,yBAAyB,CAAC,OAAO;SACzC,CAAC;KACF,CAAC;IAEF,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAG5E,MAAM,MAAM,GAAG,gBAAgB;aAC7B,oBAAoB,EAAE;aACtB,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAChC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACtE,MAAM,MAAM,GAAG,gBAAgB,CAAC,oBAAoB,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;QACrE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QAGlE,MAAM,CAAC,mBAAmB,CAAC,oBAAoB,EAAE,CAAC,CAAC,aAAa,EAAE,CAAC;QACnE,MAAM,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;YACnE,MAAM,EAAE,yBAAyB,CAAC,OAAO;SACzC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,MAAM,CACX,gBAAgB,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CACnD,CAAC,QAAQ,CAAC,OAAO,CAAC;YAClB,MAAM,EAAE,yBAAyB,CAAC,OAAO;YACzC,IAAI,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE;SACxB,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAE/D,MAAM,QAAQ,GACb,MAAM,mBAAmB,CAAC,cAAc,EAAE,CAAC;QAC5C,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QAGtE,MAAM,MAAM,GAAc;YACzB,OAAO,EAAE,gBAAgB;YACzB,UAAU,EAAE,mBAAmB;SAC/B,CAAC;QACF,MAAM,QAAQ,GAAsB,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM,EAAE,CAAC;QAEhE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QAGtD,MAAM,QAAQ,GAAsB,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9D,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QAGpF,MAAM,QAAQ,GAA2B;YACxC,oBAAoB,EAAE,GAAG,EAAE,CAAC,SAAS;YACrC,cAAc,EAAE,KAAK,IAAkC,EAAE;gBACxD,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC;YACzB,CAAC;SACD,CAAC;QACF,MAAM,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prosopo/api-route",
-	"version": "2.6.52",
+	"version": "2.6.53",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
 	"type": "module",
@@ -21,16 +21,21 @@
 		"build:cross-env": "vite build --config vite.esm.config.ts",
 		"build:tsc": "tsc --build --verbose",
 		"build:cjs": "NODE_ENV=${NODE_ENV:-development}; vite build --config vite.cjs.config.ts --mode $NODE_ENV",
-		"typecheck": "tsc --project tsconfig.types.json"
+		"typecheck": "tsc --project tsconfig.types.json",
+		"test": "NODE_ENV=${NODE_ENV:-test}; npx vitest run --config ./vite.test.config.ts",
+		"test:watch": "NODE_ENV=${NODE_ENV:-test}; npx vitest watch --config ./vite.test.config.ts"
 	},
 	"dependencies": {
-		"@prosopo/logger": "2.0.3",
+		"@prosopo/logger": "2.0.4",
 		"zod": "3.23.8"
 	},
 	"devDependencies": {
-		"@prosopo/config": "3.3.4",
+		"@prosopo/config": "3.3.5",
 		"@types/node": "22.10.2",
-		"del-cli": "6.0.0"
+		"@vitest/coverage-v8": "4.1.10",
+		"del-cli": "6.0.0",
+		"vite": "8.1.5",
+		"vitest": "4.1.10"
 	},
 	"author": "PROSOPO LIMITED <info@prosopo.io>",
 	"license": "Apache-2.0",

package/src/.export.ts

@@ -15,5 +15,9 @@
 export type {
 	ApiRoutes,
 	ApiRoutesProvider,
+	// ApiRouteLimit is the value type of an ApiRouteLimits record: without it,
+	// a consumer building one entry at a time has no way to name what it is
+	// building, and has to redeclare the shape.
+	ApiRouteLimit,
 	ApiRouteLimits,
 } from "./apiRoutes.js";