@stonyx/rest-server 0.2.1-alpha.32 → 0.2.1-alpha.34

package/README.md

@@ -15,6 +15,12 @@ REST server module for the [Stonyx framework](https://github.com/abofs/stonyx),
 * **Singleton server:** Only one RestServer instance runs, preventing accidental multiple listeners.
 * **Framework integration:** Works seamlessly as part of the Stonyx framework—auto-initialized with the rest of your modules.
 
+## Usage reference
+
+The sample request classes in [`test/sample/`](https://github.com/abofs/stonyx-rest-server/tree/dev/test/sample) are the canonical usage reference for this module; the integration tests run against them. They are not included in the npm package.
+
+The package has a single export, `@stonyx/rest-server` (the `RestServer` default export and the named `Request` export). There are no subpath exports.
+
 ## RestServer
 
 The `RestServer` class wraps an Express.js instance to provide:
@@ -74,7 +80,7 @@ Configuration is read from `stonyx/config` under `restServer`:
 |       Option      |         Type        | Default     | Description                                                |
 | :---------------: | :-----------------: | :---------- | :--------------------------------------------------------- |
 |       `dir`       |      **String**     | `'./requests'` | Directory containing request classes to mount as routes    |
-| `camelCaseRoutes` |     **Boolean**     | `true`      | Convert filenames to camelCase when generating route paths |
+| `camelCaseRoutes` |     **Boolean**     | *(unset — `config/environment.js` sets no default)* | When explicitly `true`, converts hyphenated filenames to camelCase when generating route paths. Unset, so filenames are used **verbatim** |
 |       `port`      |      **Number**     | `2666`      | Port to listen on                                          |
 |      `origin`     | **String \| Array** | `'*'`       | CORS origin(s) allowed                                     |
 |    `methods`      | **String**          | `'GET,POST,PATCH,PUT,DELETE'` | CORS allowed methods                              |
@@ -116,7 +122,7 @@ Case-sensitive matching is a **behaviour change**. Requests that previously reac
 **Who is affected:**
 
 * Any client sending a URL whose case does not exactly match the mounted path — hand-written links, bookmarked or cached URLs, third-party callers, anything that upper-cases path segments.
-* Any app with a capitalised or hyphenated request filename. Mount paths come from filenames, and `camelCaseRoutes` never lower-cases anything: it only upper-cases the letter following a `-`. So `Users.ts` mounts at `/Users` under **both** `camelCaseRoutes` settings, including the default `true`, and `phone-number.ts` mounts at `/phoneNumber` under the default. Clients that hardcode `/users` or `/phonenumber` start 404ing.
+* Any app with a capitalised or hyphenated request filename. Mount paths come from filenames, and `camelCaseRoutes` never lower-cases anything: it only upper-cases the letter following a `-`. So `Users.ts` mounts at `/Users` under **both** `camelCaseRoutes` settings, including the default. `phone-number.ts` mounts at `/phone-number` by default — `config/environment.js` declares no `camelCaseRoutes` key, so filenames are used verbatim — and at `/phoneNumber` only if you have explicitly set `camelCaseRoutes: true`. Clients that hardcode `/users` or `/phonenumber` start 404ing.
 * Anything matching the URL downstream of the router — reverse proxies, WAF path rules, analytics path grouping, `originalUrl`-based routing.
 * `GET /HEALTH` no longer answers. Only `GET /health` does.
 
@@ -138,7 +144,7 @@ If routes appear to have vanished after upgrading, `Cannot GET` in the response
 ls requests/    # every filename becomes a mount path
 ```
 
-Any filename that is not already all-lowercase — and any hyphenated filename under the default `camelCaseRoutes: true` — produces a mixed-case mount that now requires exact casing from callers.
+Any filename that is not already all-lowercase produces a mixed-case mount that now requires exact casing from callers. Hyphenated filenames are **not** affected by default, because `camelCaseRoutes` is unset and filenames are used verbatim; they are only at risk if you have explicitly set `camelCaseRoutes: true`, which mounts `phone-number.ts` at `/phoneNumber`.
 
 **Opting out (temporary).** Two forms, and they are **not** interchangeable:
 
@@ -237,7 +243,7 @@ project-root/
 * `public.js` — contains public-facing routes without authentication
 * `private.js` — contains routes with authentication via the `auth` hook
 
-The `RestServer` will automatically mount these routes using the filenames as paths (`/public` and `/private` by default, or verbatim if `camelCaseRoutes` is disabled).
+The `RestServer` will automatically mount these routes using the filenames as paths (`/public` and `/private` by default, or camelCased if `camelCaseRoutes` is enabled).
 
 ### Example Requests
 

package/package.json

@@ -4,7 +4,7 @@
     "stonyx-async",
     "stonyx-module"
   ],
-  "version": "0.2.1-alpha.32",
+  "version": "0.2.1-alpha.34",
   "description": "Rest Server Module for Stonyx Framework",
   "repository": {
     "type": "git",
@@ -36,10 +36,10 @@
   "dependencies": {
     "cors": "^2.8.5",
     "express": "^5.1.0",
-    "stonyx": "0.2.3-beta.81"
+    "stonyx": "0.2.3-beta.98"
   },
   "devDependencies": {
-    "@stonyx/utils": "0.2.3-beta.26",
+    "@stonyx/utils": "0.2.3-beta.27",
     "@types/cors": "^2.8.17",
     "@types/express": "^5.0.6",
     "@types/node": "^25.5.2",