@antelopejs/interface-data-api 0.1.8 → 0.1.10

package/dist/tests/utils.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFunctionName = getFunctionName;
 exports.request = request;
@@ -10,15 +13,54 @@ exports.deleteRequest = deleteRequest;
 exports.validateObject = validateObject;
 exports.getSchemaInstance = getSchemaInstance;
 exports.validateObjectList = validateObjectList;
-const interface_database_1 = require("@antelopejs/interface-database");
+const node_path_1 = __importDefault(require("node:path"));
 const chai_1 = require("chai");
+const interface_database_1 = require("@antelopejs/interface-database");
 const constants_1 = require("./constants");
+const UNKNOWN_FUNCTION_NAME = "unknown";
+const PREPARE_STACK_TRACE = "prepareStackTrace";
+const TESTS_FOLDER_PREFIX = `${__dirname}${node_path_1.default.sep}`;
+function readCallSites(_error, callSites) {
+    return callSites;
+}
+function isCallSiteList(stack) {
+    return Array.isArray(stack);
+}
+function restoreErrorProperty(property, descriptor) {
+    if (!descriptor) {
+        Reflect.deleteProperty(Error, property);
+        return;
+    }
+    Object.defineProperty(Error, property, descriptor);
+}
+function captureCallSites() {
+    const { stackTraceLimit } = Error;
+    const prepareStackTrace = Object.getOwnPropertyDescriptor(Error, PREPARE_STACK_TRACE);
+    Error.stackTraceLimit = Infinity;
+    Error.prepareStackTrace = readCallSites;
+    try {
+        const stack = new Error().stack;
+        return isCallSiteList(stack) ? stack : [];
+    }
+    finally {
+        restoreErrorProperty(PREPARE_STACK_TRACE, prepareStackTrace);
+        Error.stackTraceLimit = stackTraceLimit;
+    }
+}
+function isTestCallSite(callSite) {
+    const fileName = callSite.getFileName();
+    return fileName !== __filename && !!fileName?.startsWith(TESTS_FOLDER_PREFIX);
+}
+/**
+ * Returns the name of the test function that called it.
+ *
+ * The caller is the first stack frame located in the tests folder, so frames
+ * added between the test and this helper (module loader facades, async
+ * context wrappers) do not change the result.
+ */
 function getFunctionName() {
-    const err = new Error();
-    const stack = err.stack?.split("\n");
-    const line = stack?.[2] ?? "";
-    const match = line.match(/at (\w+)/);
-    return match?.[1] ?? "unknown";
+    const caller = captureCallSites().find(isTestCallSite);
+    return caller?.getFunctionName() ?? UNKNOWN_FUNCTION_NAME;
 }
 async function request(functionName, uri, method, payload, queryParams) {
     return await fetch(`${constants_1.URL_BASE}/${functionName}/${uri}?${new URLSearchParams(queryParams).toString()}`, {

package/dist/tests/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":";;AAIA,0CAMC;AAED,0BAiBC;AAED,gCAMC;AAED,gCAKC;AAED,kCAKC;AAED,kCAMC;AAED,sCAWC;AAED,wCAQC;AAED,8CAIC;AAED,gDAcC;AAxGD,uEAAwD;AACxD,+BAA8B;AAC9B,2CAAuC;AAEvC,SAAgB,eAAe;IAC7B,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IACxB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;AACjC,CAAC;AAEM,KAAK,UAAU,OAAO,CAC3B,YAAoB,EACpB,GAAW,EACX,MAAc,EACd,OAAiB,EACjB,WAAoC;IAEpC,OAAO,MAAM,KAAK,CAChB,GAAG,oBAAQ,IAAI,YAAY,IAAI,GAAG,IAAI,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE,EACnF;QACE,MAAM;QACN,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;KACpD,CACF,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,YAAoB,EACpB,OAAgB,EAChB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AAC1E,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,YAAoB,EACpB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;AAC3E,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,YAAoB,EACpB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;AAC5E,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,YAAoB,EACpB,OAAgB,EAChB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AAC1E,CAAC;AAEM,KAAK,UAAU,aAAa,CACjC,YAAoB,EACpB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAClB,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,WAAW,CACZ,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,cAAc,CAClC,MAAS,EACT,cAA0B,EAC1B,aAA0B;IAE1B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;QAClC,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAAC,UAAkB;IAClD,MAAM,MAAM,GAAG,2BAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,aAAa,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAEM,KAAK,UAAU,kBAAkB,CACtC,UAAe,EACf,kBAAgC,EAChC,aAA0B;IAE1B,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,MAAM,cAAc,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAA,aAAM,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,qCAAqC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,MAAM,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/tests/utils.ts"],"names":[],"mappings":";;;;;AA6DA,0CAGC;AAED,0BAiBC;AAED,gCAMC;AAED,gCAKC;AAED,kCAKC;AAED,kCAMC;AAED,sCAWC;AAED,wCAQC;AAED,8CAIC;AAED,gDAcC;AA9JD,0DAA6B;AAC7B,+BAA8B;AAC9B,uEAAwD;AAExD,2CAAuC;AAEvC,MAAM,qBAAqB,GAAG,SAAS,CAAC;AACxC,MAAM,mBAAmB,GAAG,mBAAmB,CAAC;AAChD,MAAM,mBAAmB,GAAG,GAAG,SAAS,GAAG,mBAAI,CAAC,GAAG,EAAE,CAAC;AAEtD,SAAS,aAAa,CACpB,MAAa,EACb,SAA4B;IAE5B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAgB,EAChB,UAA0C;IAE1C,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACxC,OAAO;IACT,CAAC;IACD,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,gBAAgB;IACvB,MAAM,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;IAClC,MAAM,iBAAiB,GAAG,MAAM,CAAC,wBAAwB,CACvD,KAAK,EACL,mBAAmB,CACpB,CAAC;IACF,KAAK,CAAC,eAAe,GAAG,QAAQ,CAAC;IACjC,KAAK,CAAC,iBAAiB,GAAG,aAAa,CAAC;IACxC,IAAI,CAAC;QACH,MAAM,KAAK,GAAY,IAAI,KAAK,EAAE,CAAC,KAAK,CAAC;QACzC,OAAO,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5C,CAAC;YAAS,CAAC;QACT,oBAAoB,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QAC7D,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;IAC1C,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,QAAyB;IAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;IACxC,OAAO,QAAQ,KAAK,UAAU,IAAI,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;AAChF,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,eAAe;IAC7B,MAAM,MAAM,GAAG,gBAAgB,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvD,OAAO,MAAM,EAAE,eAAe,EAAE,IAAI,qBAAqB,CAAC;AAC5D,CAAC;AAEM,KAAK,UAAU,OAAO,CAC3B,YAAoB,EACpB,GAAW,EACX,MAAc,EACd,OAAiB,EACjB,WAAoC;IAEpC,OAAO,MAAM,KAAK,CAChB,GAAG,oBAAQ,IAAI,YAAY,IAAI,GAAG,IAAI,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE,EAAE,EACnF;QACE,MAAM;QACN,OAAO,EAAE;YACP,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;KACpD,CACF,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,YAAoB,EACpB,OAAgB,EAChB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AAC1E,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,YAAoB,EACpB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;AAC3E,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,YAAoB,EACpB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;AAC5E,CAAC;AAEM,KAAK,UAAU,WAAW,CAC/B,YAAoB,EACpB,OAAgB,EAChB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AAC1E,CAAC;AAEM,KAAK,UAAU,aAAa,CACjC,YAAoB,EACpB,WAAoC;IAEpC,OAAO,MAAM,OAAO,CAClB,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,WAAW,CACZ,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,cAAc,CAClC,MAAS,EACT,cAA0B,EAC1B,aAA0B;IAE1B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;QAClC,IAAA,aAAM,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAAC,UAAkB;IAClD,MAAM,MAAM,GAAG,2BAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,WAAW,UAAU,aAAa,CAAC,CAAC;IACjE,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAEM,KAAK,UAAU,kBAAkB,CACtC,UAAe,EACf,kBAAgC,EAChC,aAA0B;IAE1B,KAAK,MAAM,MAAM,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC;QACtB,MAAM,cAAc,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;QAC1E,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,IAAA,aAAM,EAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,qCAAqC,EAAE,EAAE,CAAC,CAAC;QAC1E,CAAC;aAAM,CAAC;YACN,MAAM,cAAc,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/tests/utils.test.d.ts

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

package/dist/tests/utils.test.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_async_hooks_1 = require("node:async_hooks");
+const chai_1 = require("chai");
+const utils_1 = require("./utils");
+const WRAPPER_DEPTHS = [1, 2, 5, 20];
+describe("Test utils", () => {
+    it("returns the name of the calling function", () => returnsTheCallerName());
+    it("skips frames added outside the tests folder", () => skipsFramesAddedOutsideTheTestsFolder());
+});
+function returnsTheCallerName() {
+    (0, chai_1.expect)((0, utils_1.getFunctionName)()).to.equal("returnsTheCallerName");
+}
+function nameSeenThroughAsyncContexts(depth) {
+    const storage = new node_async_hooks_1.AsyncLocalStorage();
+    const run = storage.run.bind(storage);
+    const nestedRuns = Array.from({ length: depth - 1 }, (_, store) => [
+        run,
+        store,
+    ]).flat();
+    return run(depth, ...nestedRuns, utils_1.getFunctionName);
+}
+function skipsFramesAddedOutsideTheTestsFolder() {
+    for (const depth of WRAPPER_DEPTHS) {
+        (0, chai_1.expect)(nameSeenThroughAsyncContexts(depth)).to.equal("nameSeenThroughAsyncContexts");
+    }
+}
+//# sourceMappingURL=utils.test.js.map

package/dist/tests/utils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.test.js","sourceRoot":"","sources":["../../src/tests/utils.test.ts"],"names":[],"mappings":";;AAAA,uDAAqD;AACrD,+BAA8B;AAE9B,mCAA0C;AAI1C,MAAM,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;AAErC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE,CAAC,oBAAoB,EAAE,CAAC,CAAC;IAC7E,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE,CACrD,qCAAqC,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC,CAAC;AAEH,SAAS,oBAAoB;IAC3B,IAAA,aAAM,EAAC,IAAA,uBAAe,GAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;AAC7D,CAAC;AAED,SAAS,4BAA4B,CAAC,KAAa;IACjD,MAAM,OAAO,GAAG,IAAI,oCAAiB,EAAU,CAAC;IAChD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAa,CAAC;IAClD,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QACjE,GAAG;QACH,KAAK;KACN,CAAC,CAAC,IAAI,EAAE,CAAC;IACV,OAAO,GAAG,CAAC,KAAK,EAAE,GAAG,UAAU,EAAE,uBAAe,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,qCAAqC;IAC5C,KAAK,MAAM,KAAK,IAAI,cAAc,EAAE,CAAC;QACnC,IAAA,aAAM,EAAC,4BAA4B,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAClD,8BAA8B,CAC/B,CAAC;IACJ,CAAC;AACH,CAAC"}

package/docs/1.introduction.md

@@ -106,13 +106,13 @@ class UserAPI extends DataController(
 
 This generates the following REST endpoints:
 
-| Method | Endpoint | Description |
-| ------ | -------- | ----------- |
-| GET | `/users/get?id=<id>` | Retrieve a single user |
-| GET | `/users/list?limit=10` | List users with pagination |
-| POST | `/users/new` | Create a new user |
-| PUT | `/users/edit?id=<id>` | Update an existing user |
-| DELETE | `/users/delete?id=<id>` | Delete a user |
+| Method | Endpoint                | Description                |
+| ------ | ----------------------- | -------------------------- |
+| GET    | `/users/get?id=<id>`    | Retrieve a single user     |
+| GET    | `/users/list?limit=10`  | List users with pagination |
+| POST   | `/users/new`            | Create a new user          |
+| PUT    | `/users/edit?id=<id>`   | Update an existing user    |
+| DELETE | `/users/delete?id=<id>` | Delete a user              |
 
 ## Documentation Sections
 

package/docs/10.joined.md

@@ -91,13 +91,13 @@ A GET request to `/orders/get?id=order-123` returns the joined value at the top
 @Joined({ table, localKey, remoteField, remoteIndex?, schema? })
 ```
 
-| Option | Type | Required | Default | Description |
-| ------ | ---- | -------- | ------- | ----------- |
-| `table` | `Class<Table>` or `string` | Yes | - | The remote table class or registered table name string |
-| `localKey` | `string` | Yes | - | The field on the local row holding the value matched against the remote table |
-| `remoteField` | `string` | Yes | - | The remote field whose value is flattened onto the row |
-| `remoteIndex` | `string` | No | `"_id"` | The index on the remote table to match `localKey` against |
-| `schema` | `string` | No | Controller schema | Name of the schema the remote table is registered in, when it differs from the controller's schema |
+| Option        | Type                       | Required | Default           | Description                                                                                        |
+| ------------- | -------------------------- | -------- | ----------------- | -------------------------------------------------------------------------------------------------- |
+| `table`       | `Class<Table>` or `string` | Yes      | -                 | The remote table class or registered table name string                                             |
+| `localKey`    | `string`                   | Yes      | -                 | The field on the local row holding the value matched against the remote table                      |
+| `remoteField` | `string`                   | Yes      | -                 | The remote field whose value is flattened onto the row                                             |
+| `remoteIndex` | `string`                   | No       | `"_id"`           | The index on the remote table to match `localKey` against                                          |
+| `schema`      | `string`                   | No       | Controller schema | Name of the schema the remote table is registered in, when it differs from the controller's schema |
 
 ## Sorting and Filtering
 
@@ -145,12 +145,12 @@ When a table class is passed, its schema is inferred from its `@RegisterTable` m
 
 ## Joined vs. Foreign
 
-| Aspect | `@Joined` | `@Foreign` |
-| ------ | --------- | ---------- |
-| Result shape | A single scalar value flattened onto the row | The full referenced record (or plucked subset) nested under the field |
-| Access | Read-only (enforced) | Configurable via `@Access` |
-| Sort / filter | Native (join applied before sort/filter) | Not natively sortable/filterable on remote fields |
-| Multiple references | One remote field per decorator | Single or array (`multi`) references |
+| Aspect              | `@Joined`                                    | `@Foreign`                                                            |
+| ------------------- | -------------------------------------------- | --------------------------------------------------------------------- |
+| Result shape        | A single scalar value flattened onto the row | The full referenced record (or plucked subset) nested under the field |
+| Access              | Read-only (enforced)                         | Configurable via `@Access`                                            |
+| Sort / filter       | Native (join applied before sort/filter)     | Not natively sortable/filterable on remote fields                     |
+| Multiple references | One remote field per decorator               | Single or array (`multi`) references                                  |
 
 ## Next Steps
 

package/docs/11.computed.md

@@ -54,11 +54,7 @@ class GroupAPI extends DataController(
   // Aggregate: number of devices referencing this group, computed in DB
   @Listable()
   @Computed(
-    (row, db) =>
-      db
-        .table("devices")
-        .getAll(row.key("_id"), "group_id")
-        .count(),
+    (row, db) => db.table("devices").getAll(row.key("_id"), "group_id").count(),
     { default: 0 },
   )
   @Sortable()
@@ -88,10 +84,10 @@ A GET request to `/groups/get?id=group-123` returns the computed values at the t
 @Computed(expr, options?)
 ```
 
-| Parameter | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `expr` | `(row, db) => expression` | Yes | Expression receiving the row proxy and the schema instance; returns a `ValueProxy` expression or a subquery (`Datum`) |
-| `options.default` | `unknown` | No | Fallback merged over the computed value when the expression yields `null` |
+| Parameter         | Type                      | Required | Description                                                                                                           |
+| ----------------- | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------- |
+| `expr`            | `(row, db) => expression` | Yes      | Expression receiving the row proxy and the schema instance; returns a `ValueProxy` expression or a subquery (`Datum`) |
+| `options.default` | `unknown`                 | No       | Fallback merged over the computed value when the expression yields `null`                                             |
 
 ### The `default` option
 
@@ -134,12 +130,12 @@ declare devices_count: number;
 
 ## Computed vs. Joined
 
-| Aspect | `@Computed` | `@Joined` |
-| ------ | ----------- | --------- |
-| Source | Arbitrary expression: row-local computation or per-row subquery | One scalar field from another table matched by a foreign key |
-| Typical use | Aggregates (`count`, `sum`), derived values | Flattening a referenced record's field |
-| Access | Read-only (enforced) | Read-only (enforced) |
-| Sort / filter | Native, lazily injected only where needed | Native, always applied before sort/filter |
+| Aspect        | `@Computed`                                                     | `@Joined`                                                    |
+| ------------- | --------------------------------------------------------------- | ------------------------------------------------------------ |
+| Source        | Arbitrary expression: row-local computation or per-row subquery | One scalar field from another table matched by a foreign key |
+| Typical use   | Aggregates (`count`, `sum`), derived values                     | Flattening a referenced record's field                       |
+| Access        | Read-only (enforced)                                            | Read-only (enforced)                                         |
+| Sort / filter | Native, lazily injected only where needed                       | Native, always applied before sort/filter                    |
 
 `@Joined` remains the simpler choice for the 1:1 flattening case; `@Computed` generalizes the same merge mechanism to arbitrary expressions.
 

package/docs/2.data-controllers.md

@@ -81,11 +81,11 @@ DataController(
 )
 ```
 
-| Parameter | Description |
-| --------- | ----------- |
+| Parameter    | Description                                                                                                                       |
+| ------------ | --------------------------------------------------------------------------------------------------------------------------------- |
 | `tableClass` | The database table class decorated with `@RegisterTable`. The controller validates that this table exists in the database schema. |
-| `routes` | An object mapping endpoint names to route callbacks. Use `DefaultRoutes.All` for standard CRUD or pass a custom subset. |
-| `base` | The controller base, typically created with `Controller("/path")`, which sets the URL prefix for all endpoints. |
+| `routes`     | An object mapping endpoint names to route callbacks. Use `DefaultRoutes.All` for standard CRUD or pass a custom subset.           |
+| `base`       | The controller base, typically created with `Controller("/path")`, which sets the URL prefix for all endpoints.                   |
 
 ## Required Components
 

package/docs/3.routes.md

@@ -12,13 +12,13 @@ The `DefaultRoutes` namespace provides five built-in routes covering standard CR
 import { DefaultRoutes } from "@antelopejs/interface-data-api";
 ```
 
-| Route | Object | HTTP Method | Endpoint Pattern |
-| ----- | ------ | ----------- | ---------------- |
-| Get | `DefaultRoutes.Get` | GET | `/resource/get?id=<id>` |
-| List | `DefaultRoutes.List` | GET | `/resource/list` |
-| New | `DefaultRoutes.New` | POST | `/resource/new` |
-| Edit | `DefaultRoutes.Edit` | PUT | `/resource/edit?id=<id>` |
-| Delete | `DefaultRoutes.Delete` | DELETE | `/resource/delete?id=<id>` |
+| Route  | Object                 | HTTP Method | Endpoint Pattern           |
+| ------ | ---------------------- | ----------- | -------------------------- |
+| Get    | `DefaultRoutes.Get`    | GET         | `/resource/get?id=<id>`    |
+| List   | `DefaultRoutes.List`   | GET         | `/resource/list`           |
+| New    | `DefaultRoutes.New`    | POST        | `/resource/new`            |
+| Edit   | `DefaultRoutes.Edit`   | PUT         | `/resource/edit?id=<id>`   |
+| Delete | `DefaultRoutes.Delete` | DELETE      | `/resource/delete?id=<id>` |
 
 Use `DefaultRoutes.All` to include all five routes at once.
 
@@ -62,9 +62,9 @@ Retrieves a single record by its identifier.
 
 **Query Parameters:**
 
-| Parameter | Required | Description |
-| --------- | -------- | ----------- |
-| `id` | Yes | Record identifier |
+| Parameter | Required | Description       |
+| --------- | -------- | ----------------- |
+| `id`      | Yes      | Record identifier |
 
 **Example:**
 
@@ -90,12 +90,12 @@ Retrieves multiple records with pagination, sorting, and filtering support.
 
 **Query Parameters:**
 
-| Parameter | Required | Default | Description |
-| --------- | -------- | ------- | ----------- |
-| `limit` | No | `10` | Maximum number of records to return |
-| `offset` | No | `0` | Number of records to skip |
-| `sortKey` | No | - | Field to sort by (must be marked `@Sortable`) |
-| `sortDirection` | No | `asc` | Sort direction: `asc` or `desc` |
+| Parameter       | Required | Default | Description                                   |
+| --------------- | -------- | ------- | --------------------------------------------- |
+| `limit`         | No       | `10`    | Maximum number of records to return           |
+| `offset`        | No       | `0`     | Number of records to skip                     |
+| `sortKey`       | No       | -       | Field to sort by (must be marked `@Sortable`) |
+| `sortDirection` | No       | `asc`   | Sort direction: `asc` or `desc`               |
 
 **Example:**
 
@@ -154,9 +154,9 @@ Updates an existing record by its identifier.
 
 **Query Parameters:**
 
-| Parameter | Required | Description |
-| --------- | -------- | ----------- |
-| `id` | Yes | Record identifier |
+| Parameter | Required | Description       |
+| --------- | -------- | ----------------- |
+| `id`      | Yes      | Record identifier |
 
 **Body:** JSON object with fields to update.
 
@@ -188,9 +188,9 @@ Deletes one or more records by their identifiers.
 
 **Query Parameters:**
 
-| Parameter | Required | Description |
-| --------- | -------- | ----------- |
-| `id` | Yes | Record identifier(s). Pass multiple `id` parameters to delete several records at once. |
+| Parameter | Required | Description                                                                            |
+| --------- | -------- | -------------------------------------------------------------------------------------- |
+| `id`      | Yes      | Record identifier(s). Pass multiple `id` parameters to delete several records at once. |
 
 **Example:**
 
@@ -212,11 +212,11 @@ The `DefaultRoutes.WithOptions` function customizes route behavior by overriding
 DefaultRoutes.WithOptions(callback, options?, endpoint?)
 ```
 
-| Parameter | Description |
-| --------- | ----------- |
-| `callback` | The route callback to customize (e.g., `DefaultRoutes.Edit`). |
-| `options` | An object with option overrides. These values take precedence over query parameters. |
-| `endpoint` | An optional custom endpoint path. Defaults to the route key name. |
+| Parameter  | Description                                                                          |
+| ---------- | ------------------------------------------------------------------------------------ |
+| `callback` | The route callback to customize (e.g., `DefaultRoutes.Edit`).                        |
+| `options`  | An object with option overrides. These values take precedence over query parameters. |
+| `endpoint` | An optional custom endpoint path. Defaults to the route key name.                    |
 
 ### Example
 
@@ -239,32 +239,32 @@ class UserAPI extends DataController(User, routes, Controller("/users")) {
 
 **Get:**
 
-| Option | Type | Description |
-| ------ | ---- | ----------- |
-| `index` | `string` | Use a secondary index instead of the primary key |
-| `noForeign` | `string` | Skip foreign key resolution |
+| Option      | Type     | Description                                      |
+| ----------- | -------- | ------------------------------------------------ |
+| `index`     | `string` | Use a secondary index instead of the primary key |
+| `noForeign` | `string` | Skip foreign key resolution                      |
 
 **List:**
 
-| Option | Type | Description |
-| ------ | ---- | ----------- |
-| `maxPage` | `number` | Maximum allowed value for `limit` (caps the page size) |
-| `noForeign` | `boolean` | Skip foreign key resolution |
-| `noPluck` | `boolean` | Return all database fields instead of plucked fields |
-| `pluckMode` | `string` | Select a named pluck mode (see `@Listable`) |
+| Option      | Type      | Description                                            |
+| ----------- | --------- | ------------------------------------------------------ |
+| `maxPage`   | `number`  | Maximum allowed value for `limit` (caps the page size) |
+| `noForeign` | `boolean` | Skip foreign key resolution                            |
+| `noPluck`   | `boolean` | Return all database fields instead of plucked fields   |
+| `pluckMode` | `string`  | Select a named pluck mode (see `@Listable`)            |
 
 **New:**
 
-| Option | Type | Description |
-| ------ | ---- | ----------- |
+| Option        | Type     | Description                     |
+| ------------- | -------- | ------------------------------- |
 | `noMandatory` | `string` | Skip mandatory field validation |
 
 **Edit:**
 
-| Option | Type | Description |
-| ------ | ---- | ----------- |
-| `index` | `string` | Use a secondary index instead of the primary key |
-| `noMandatory` | `string` | Skip mandatory field validation |
+| Option        | Type     | Description                                      |
+| ------------- | -------- | ------------------------------------------------ |
+| `index`       | `string` | Use a secondary index instead of the primary key |
+| `noMandatory` | `string` | Skip mandatory field validation                  |
 
 ## Custom Routes
 
@@ -307,11 +307,11 @@ The `args` array contains parameter decorators that extract values from the requ
 
 Default routes return standard HTTP error responses:
 
-| Status | Condition |
-| ------ | --------- |
-| `400 Bad Request` | Validation fails, missing required fields, or invalid parameters |
-| `404 Not Found` | Record does not exist |
-| `500 Internal Server Error` | Database operation fails |
+| Status                      | Condition                                                        |
+| --------------------------- | ---------------------------------------------------------------- |
+| `400 Bad Request`           | Validation fails, missing required fields, or invalid parameters |
+| `404 Not Found`             | Record does not exist                                            |
+| `500 Internal Server Error` | Database operation fails                                         |
 
 Error messages are returned as plain text in the response body.
 

package/docs/4.access-rights.md

@@ -12,11 +12,11 @@ The `AccessMode` enum defines three permission levels:
 import { Access, AccessMode } from "@antelopejs/interface-data-api/metadata";
 ```
 
-| Mode | Value | Description |
-| ---- | ----- | ----------- |
-| `AccessMode.ReadOnly` | `1` | Field appears in GET and LIST responses but is ignored in POST and PUT bodies |
-| `AccessMode.WriteOnly` | `2` | Field is accepted in POST and PUT bodies but never appears in responses |
-| `AccessMode.ReadWrite` | `3` | Field is both readable and writable |
+| Mode                   | Value | Description                                                                   |
+| ---------------------- | ----- | ----------------------------------------------------------------------------- |
+| `AccessMode.ReadOnly`  | `1`   | Field appears in GET and LIST responses but is ignored in POST and PUT bodies |
+| `AccessMode.WriteOnly` | `2`   | Field is accepted in POST and PUT bodies but never appears in responses       |
+| `AccessMode.ReadWrite` | `3`   | Field is both readable and writable                                           |
 
 ## Basic Usage
 

package/docs/6.listable.md

@@ -140,10 +140,10 @@ List responses include pagination metadata. The response structure is:
 
 ### Query Parameters
 
-| Parameter | Default | Description |
-| --------- | ------- | ----------- |
-| `limit` | `10` | Maximum number of records to return |
-| `offset` | `0` | Number of records to skip |
+| Parameter | Default | Description                         |
+| --------- | ------- | ----------------------------------- |
+| `limit`   | `10`    | Maximum number of records to return |
+| `offset`  | `0`     | Number of records to skip           |
 
 ### Example
 
@@ -214,9 +214,9 @@ class UserAPI extends DataController(
 
 ### Sort Query Parameters
 
-| Parameter | Description |
-| --------- | ----------- |
-| `sortKey` | The field name to sort by. Must be decorated with `@Sortable`. |
+| Parameter       | Description                                                        |
+| --------------- | ------------------------------------------------------------------ |
+| `sortKey`       | The field name to sort by. Must be decorated with `@Sortable`.     |
 | `sortDirection` | `"asc"` (ascending) or `"desc"` (descending). Defaults to `"asc"`. |
 
 ### The `noIndex` Option

package/docs/7.foreign-keys.md

@@ -90,13 +90,13 @@ A GET request to `/orders/get?id=order-123` returns the full user object instead
 @Foreign(table, index?, multi?, pluck?, schema?)
 ```
 
-| Parameter | Type | Required | Default | Description |
-| --------- | ---- | -------- | ------- | ----------- |
-| `table` | `Class<Table>` or `string` | Yes | - | The target table class or table name string |
-| `index` | `string` | No | `"_id"` | The index on the target table to match against |
-| `multi` | `boolean` | No | `false` | Set to `true` when the field holds an array of foreign keys |
-| `pluck` | `string[]` | No | All fields | List of fields to include from the referenced record |
-| `schema` | `string` | No | Controller schema | Name of the schema the target table is registered in, when it differs from the controller's schema |
+| Parameter | Type                       | Required | Default           | Description                                                                                        |
+| --------- | -------------------------- | -------- | ----------------- | -------------------------------------------------------------------------------------------------- |
+| `table`   | `Class<Table>` or `string` | Yes      | -                 | The target table class or table name string                                                        |
+| `index`   | `string`                   | No       | `"_id"`           | The index on the target table to match against                                                     |
+| `multi`   | `boolean`                  | No       | `false`           | Set to `true` when the field holds an array of foreign keys                                        |
+| `pluck`   | `string[]`                 | No       | All fields        | List of fields to include from the referenced record                                               |
+| `schema`  | `string`                   | No       | Controller schema | Name of the schema the target table is registered in, when it differs from the controller's schema |
 
 ## Table Reference Methods
 

package/docs/8.filters.md

@@ -52,14 +52,14 @@ When no operator is specified, `eq` (equal) is used by default.
 
 ### Comparison Operators
 
-| Operator | Description |
-| -------- | ----------- |
-| `eq` | Equal to (default) |
-| `ne` | Not equal to |
-| `gt` | Greater than |
-| `ge` | Greater than or equal to |
-| `lt` | Less than |
-| `le` | Less than or equal to |
+| Operator | Description              |
+| -------- | ------------------------ |
+| `eq`     | Equal to (default)       |
+| `ne`     | Not equal to             |
+| `gt`     | Greater than             |
+| `ge`     | Greater than or equal to |
+| `lt`     | Less than                |
+| `le`     | Less than or equal to    |
 
 ### Examples
 
@@ -98,14 +98,14 @@ type FilterFunction<T, U> = (
 ) => ValueProxyOrValue<boolean>;
 ```
 
-| Parameter | Description |
-| --------- | ----------- |
-| `context` | The request context, extended with `this` referencing the controller instance |
-| `proxy` | A `ValueProxy` representing the field value with modifier transformations applied (e.g., decrypted, localized) |
-| `key` | The field name being filtered |
-| `value` | The filter value from the query parameter |
-| `mode` | The comparison operator from the query parameter |
-| `row` | The full database row as a `ValueProxy` |
+| Parameter | Description                                                                                                    |
+| --------- | -------------------------------------------------------------------------------------------------------------- |
+| `context` | The request context, extended with `this` referencing the controller instance                                  |
+| `proxy`   | A `ValueProxy` representing the field value with modifier transformations applied (e.g., decrypted, localized) |
+| `key`     | The field name being filtered                                                                                  |
+| `value`   | The filter value from the query parameter                                                                      |
+| `mode`    | The comparison operator from the query parameter                                                               |
+| `row`     | The full database row as a `ValueProxy`                                                                        |
 
 ### Example: Pattern Matching Filter
 

package/docs/9.modifiers.md

@@ -20,8 +20,8 @@ import { ModifierKey } from "@antelopejs/interface-data-api/metadata";
 @ModifierKey(modifierClass: typeof ContainerModifier<any>)
 ```
 
-| Parameter | Description |
-| --------- | ----------- |
+| Parameter       | Description                                                                   |
+| --------------- | ----------------------------------------------------------------------------- |
 | `modifierClass` | The modifier class that requires a runtime key (e.g., `LocalizationModifier`) |
 
 ### Example: Localized Content