@stonyx/orm 0.3.2-beta.166 → 0.3.2-beta.168

package/README.md

@@ -113,6 +113,12 @@ export default {
 };
 ```
 
+> **`route` and JSON:API `links`.** Generated endpoints are mounted under `route`, and every
+> `links.self` / `links.related` the ORM emits is an absolute URL that includes it. With
+> `ORM_REST_ROUTE='/api'` the animal collection is served at `/api/animals` and advertises
+> `http://host/api/animals`, so published links are followable as-is — do not prepend the
+> mount yourself.
+
 Then run the application via the Stonyx CLI, which auto-initializes all modules including the ORM:
 
 ```bash
@@ -322,6 +328,36 @@ export default class GlobalAccess {
 }
 ```
 
+### Upgrading: behaviour changes
+
+**Advertised `links.self` / `links.related` now carry the REST mount route.**
+Consumer-visible for any deployment where `orm.restServer.route` is not the
+default `'/'`.
+
+Measured on this repo's mounted-route harness at `ORM_REST_ROUTE='/api'`, resource
+`links.self` in the response to `GET /api/animals/1`:
+
+| | published `links.self` | fetching that URL |
+|---|---|---|
+| before | `http://host/animals/1` | **404** |
+| after | `http://host/api/animals/1` | **200** |
+
+The ORM previously built links from the request origin alone, so at any non-default
+mount every URL it advertised pointed at a route that did not exist
+(abofs/stonyx-orm#254). Links are now built from the path the routes are actually
+mounted at, and are followable verbatim.
+
+**⚠️ Breaking if you carry a prepending workaround.** The usual workaround for #254
+was for the client to prepend the mount to every link the ORM published. That now
+double-prefixes: prepending `/api` to the new `http://host/api/animals/1` yields
+`http://host/api/api/animals/1`, measured **404**. Remove the prepending. There is no
+configuration flag that restores the old link shape.
+
+**Unaffected.** Deployments on the default `ORM_REST_ROUTE='/'` see byte-identical
+output — the prefix is empty, and this is pinned by a byte-identity test against a
+golden fixture captured *before* the fix. Response structure, field names and the
+public API are unchanged; only the URL value inside `links` changes.
+
 ### Include Parameter (Sideloading Relationships)
 
 The ORM supports JSON API-compliant relationship sideloading via the `include` query parameter. This reduces the need for multiple API requests by embedding related records in a single response.

package/dist/orm-request.d.ts

@@ -1,6 +1,7 @@
 import { Request } from '@stonyx/rest-server';
 interface OrmRequest$ extends Request {
     protocol?: string;
+    baseUrl?: string;
     method: string;
     params: {
         [key: string]: string;

package/dist/orm-request.js

@@ -42,11 +42,28 @@ function getModelRelationships(modelName) {
     }
     return relationships;
 }
-// Helper to build base URL from request
-function getBaseUrl(request) {
+/**
+ * Build the absolute base URL that every advertised link hangs off — origin
+ * plus the prefix the ORM's routes are actually mounted at.
+ *
+ * The prefix is derived from the *request*, not from
+ * `config.orm.restServer.route`. Express sets `request.baseUrl` to the real
+ * mountpath registered by `RestServer.mountRoute`, which for this module is
+ * always `<prefix>/<pluralizedModel>` (see setup-rest-server.ts). Stripping the
+ * trailing model segment therefore yields the prefix by construction, and the
+ * link builder cannot drift from the mount registrar the way a second,
+ * independent normalisation of `route` would.
+ *
+ * When `request.baseUrl` is absent or does not end in the model segment the
+ * prefix is empty, which reproduces the previous origin-only behaviour.
+ */
+function getBaseUrl(request, pluralizedModel) {
     const protocol = request.protocol || 'http';
     const host = request.get('host');
-    return `${protocol}://${host}`;
+    const modelSegment = `/${pluralizedModel}`;
+    const mountPath = request.baseUrl ?? '';
+    const prefix = mountPath.endsWith(modelSegment) ? mountPath.slice(0, -modelSegment.length) : '';
+    return `${protocol}://${host}${prefix}`;
 }
 function getId(params) {
     const id = params.id;
@@ -209,7 +226,7 @@ export default class OrmRequest extends Request {
                 recordsToReturn = recordsToReturn.filter(accessFilter);
             if (queryFilterPredicate)
                 recordsToReturn = recordsToReturn.filter(queryFilterPredicate);
-            const baseUrl = getBaseUrl(request);
+            const baseUrl = getBaseUrl(request, pluralizedModel);
             const data = recordsToReturn.map(record => record.toJSON?.({ fields: modelFields, baseUrl }));
             return buildResponse(data, request.query?.include, recordsToReturn, {
                 links: { self: `${baseUrl}/${pluralizedModel}` },
@@ -222,7 +239,7 @@ export default class OrmRequest extends Request {
                 return 404;
             const fieldsMap = parseFields(request.query);
             const modelFields = fieldsMap.get(pluralizedModel) || fieldsMap.get(model);
-            const baseUrl = getBaseUrl(request);
+            const baseUrl = getBaseUrl(request, pluralizedModel);
             return buildResponse(record.toJSON?.({ fields: modelFields, baseUrl }), request.query?.include, record, {
                 links: { self: `${baseUrl}/${pluralizedModel}/${request.params.id}` },
                 baseUrl
@@ -397,7 +414,7 @@ export default class OrmRequest extends Request {
                 if (!record)
                     return 404;
                 const relatedData = record.__relationships[relationshipName];
-                const baseUrl = getBaseUrl(request);
+                const baseUrl = getBaseUrl(request, pluralizedModel);
                 let data;
                 if (info.isArray) {
                     // hasMany - return array
@@ -419,7 +436,7 @@ export default class OrmRequest extends Request {
                 if (!record)
                     return 404;
                 const relatedData = record.__relationships[relationshipName];
-                const baseUrl = getBaseUrl(request);
+                const baseUrl = getBaseUrl(request, pluralizedModel);
                 let data;
                 if (info.isArray) {
                     // hasMany - return array of linkage objects

package/package.json

@@ -4,7 +4,7 @@
     "stonyx-async",
     "stonyx-module"
   ],
-  "version": "0.3.2-beta.166",
+  "version": "0.3.2-beta.168",
   "description": "",
   "main": "dist/index.js",
   "type": "module",
@@ -103,7 +103,8 @@
   "scripts": {
     "build": "tsc",
     "build:test": "tsc -p tsconfig.test.json",
-    "test": "pnpm build && NODE_ENV=test node --import tsx/esm --import ./test/setup.ts node_modules/qunit/bin/qunit.js 'test/**/*-test.ts'",
+    "test": "pnpm build && NODE_ENV=test node --import tsx/esm --import ./test/setup.ts node_modules/qunit/bin/qunit.js 'test/**/*-test.ts' && ORM_TEST_ROUTE=/ pnpm test:mounted && ORM_TEST_ROUTE=/api pnpm test:mounted && ORM_TEST_ROUTE=api pnpm test:mounted && ORM_TEST_ROUTE=/api/v1 pnpm test:mounted && ORM_TEST_ROUTE=/api/ pnpm test:mounted",
+    "test:mounted": "node --import tsx/esm --import ./test/integration/mounted-route/setup.ts node_modules/qunit/bin/qunit.js 'test/integration/mounted-route/links-mounted.ts' 'test/zz-exit-test.ts'",
     "test:dynamodb": "pnpm build && node --import tsx/esm --import ./test/integration/dynamodb/setup.ts node_modules/qunit/bin/qunit.js 'test/integration/dynamodb/**/*-test.ts'"
   }
 }

package/src/orm-request.ts

@@ -10,6 +10,10 @@ import { isOrmRecord } from './utils.js';
 
 interface OrmRequest$ extends Request {
   protocol?: string;
+  // Express sets this to the path the router was mounted at, e.g. '/api/animals'
+  // when orm.restServer.route is '/api'. Optional because non-Express callers
+  // (unit tests, programmatic handler invocation) do not supply it.
+  baseUrl?: string;
   method: string;
   params: { [key: string]: string };
   body?: { [key: string]: unknown };
@@ -77,11 +81,30 @@ function getModelRelationships(modelName: string): { [key: string]: Relationship
   return relationships;
 }
 
-// Helper to build base URL from request
-function getBaseUrl(request: OrmRequest$): string {
+/**
+ * Build the absolute base URL that every advertised link hangs off — origin
+ * plus the prefix the ORM's routes are actually mounted at.
+ *
+ * The prefix is derived from the *request*, not from
+ * `config.orm.restServer.route`. Express sets `request.baseUrl` to the real
+ * mountpath registered by `RestServer.mountRoute`, which for this module is
+ * always `<prefix>/<pluralizedModel>` (see setup-rest-server.ts). Stripping the
+ * trailing model segment therefore yields the prefix by construction, and the
+ * link builder cannot drift from the mount registrar the way a second,
+ * independent normalisation of `route` would.
+ *
+ * When `request.baseUrl` is absent or does not end in the model segment the
+ * prefix is empty, which reproduces the previous origin-only behaviour.
+ */
+function getBaseUrl(request: OrmRequest$, pluralizedModel: string): string {
   const protocol = request.protocol || 'http';
   const host = request.get('host');
-  return `${protocol}://${host}`;
+
+  const modelSegment = `/${pluralizedModel}`;
+  const mountPath = request.baseUrl ?? '';
+  const prefix = mountPath.endsWith(modelSegment) ? mountPath.slice(0, -modelSegment.length) : '';
+
+  return `${protocol}://${host}${prefix}`;
 }
 
 function getId(params: { id?: string; [key: string]: unknown }): string | number {
@@ -278,7 +301,7 @@ export default class OrmRequest extends Request {
       if (accessFilter) recordsToReturn = recordsToReturn.filter(accessFilter as (record: OrmRecord) => boolean);
       if (queryFilterPredicate) recordsToReturn = recordsToReturn.filter(queryFilterPredicate as (record: OrmRecord) => boolean);
 
-      const baseUrl = getBaseUrl(request);
+      const baseUrl = getBaseUrl(request, pluralizedModel);
       const data = recordsToReturn.map(record => record.toJSON?.({ fields: modelFields, baseUrl }));
 
       return buildResponse(data, request.query?.include, recordsToReturn, {
@@ -294,7 +317,7 @@ export default class OrmRequest extends Request {
       const fieldsMap = parseFields(request.query);
       const modelFields = fieldsMap.get(pluralizedModel) || fieldsMap.get(model);
 
-      const baseUrl = getBaseUrl(request);
+      const baseUrl = getBaseUrl(request, pluralizedModel);
       return buildResponse(record.toJSON?.({ fields: modelFields, baseUrl }), request.query?.include, record, {
         links: { self: `${baseUrl}/${pluralizedModel}/${request.params.id}` },
         baseUrl
@@ -502,7 +525,7 @@ export default class OrmRequest extends Request {
         if (!record) return 404;
 
         const relatedData = record.__relationships[relationshipName];
-        const baseUrl = getBaseUrl(request);
+        const baseUrl = getBaseUrl(request, pluralizedModel);
 
         let data: unknown;
         if (info.isArray) {
@@ -526,7 +549,7 @@ export default class OrmRequest extends Request {
         if (!record) return 404;
 
         const relatedData = record.__relationships[relationshipName];
-        const baseUrl = getBaseUrl(request);
+        const baseUrl = getBaseUrl(request, pluralizedModel);
 
         let data: unknown;
         if (info.isArray) {