@antelopejs/interface-data-api 0.1.9 → 0.1.10

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

package/package.json

@@ -1,26 +1,35 @@
 {
   "name": "@antelopejs/interface-data-api",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "description": "AntelopeJS interface for data API with CRUD controllers and route generation",
   "keywords": [
     "antelopejs",
-    "interface",
+    "crud",
     "data-api",
-    "crud"
+    "interface"
   ],
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/AntelopeJS/interface-data-api.git"
   },
-  "license": "Apache-2.0",
-  "packageManager": "pnpm@10.6.5",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
   "files": [
     "dist",
     "docs",
     "skills"
   ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "components": [
+        "dist/components.d.ts"
+      ],
+      "metadata": [
+        "dist/metadata.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -32,54 +41,53 @@
     },
     "./package.json": "./package.json"
   },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "scripts": {
     "build": "rimraf dist && tsc",
-    "format": "biome format --write .",
-    "lint:fix": "biome check --write .",
-    "lint": "biome check .",
+    "format": "oxfmt .",
+    "lint:fix": "oxlint --fix",
+    "lint": "oxlint",
     "prepack": "pnpm run build",
     "release": "pnpm run lint && pnpm run prepack && release-it",
-    "test": "pnpm run build && ajs module test ."
+    "test": "pnpm run build && ajs module test .",
+    "format:check": "oxfmt --check .",
+    "knip": "knip"
   },
   "devDependencies": {
-    "@antelopejs/interface-api": "^0.0.5",
-    "@antelopejs/interface-api-util": "^0.1.1",
-    "@antelopejs/interface-core": "^0.0.5",
-    "@antelopejs/interface-database": "^0.1.3",
-    "@antelopejs/interface-database-decorators": "^0.1.4",
-    "@biomejs/biome": "2.3.2",
+    "@antelopejs/core": "^1.13.4",
+    "@antelopejs/interface-api": "^0.0.13",
+    "@antelopejs/interface-api-util": "^0.1.2",
+    "@antelopejs/interface-core": "^0.1.1",
+    "@antelopejs/interface-database": "^0.1.7",
+    "@antelopejs/interface-database-decorators": "^0.1.6",
+    "@antelopejs/tooling-configs": "^0.0.6",
     "@types/chai": "^4.3.20",
     "@types/mocha": "^10.0.10",
     "@types/node": "^22.19.15",
     "@types/semver": "^7.7.1",
     "chai": "^4.5.0",
+    "eslint-plugin-perfectionist": "^5.11.0",
+    "knip": "^6.34.0",
     "mongodb-memory-server-core": "^10.4.3",
+    "oxfmt": "^0.66.0",
+    "oxlint": "1.81.0",
+    "oxlint-tsgolint": "^7.0.2001",
     "release-it": "^19.2.4",
     "release-it-changelogen": "^0.1.0",
     "rimraf": "^6.1.3",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@antelopejs/interface-api": ">=0.0.3 <1.0.0",
-    "@antelopejs/interface-api-util": ">=0.0.4 <1.0.0",
-    "@antelopejs/interface-core": ">=0.0.3 <1.0.0",
-    "@antelopejs/interface-database": ">=0.1.2 <1.0.0",
-    "@antelopejs/interface-database-decorators": ">=0.1.1 <1.0.0"
-  },
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
-  "typesVersions": {
-    "*": {
-      "components": [
-        "dist/components.d.ts"
-      ],
-      "metadata": [
-        "dist/metadata.d.ts"
-      ]
-    }
+    "@antelopejs/interface-api": ">=0.0.13 <1.0.0",
+    "@antelopejs/interface-api-util": ">=0.1.2 <1.0.0",
+    "@antelopejs/interface-core": ">=0.1.1 <1.0.0",
+    "@antelopejs/interface-database": ">=0.1.7 <1.0.0",
+    "@antelopejs/interface-database-decorators": ">=0.1.6 <1.0.0"
   },
+  "packageManager": "pnpm@10.6.5",
   "antelopeJs": {
     "standalone": true,
     "test": "src/antelope.test.ts",

package/skills/data-api-interface/SKILL.md

@@ -17,9 +17,32 @@ your module must also import those peer interfaces.
 ## Imports
 
 ```typescript
-import { DataController, DefaultRoutes, RegisterDataController, GetDataControllerMeta } from "@antelopejs/interface-data-api";
-import { Access, AccessMode, Listable, Mandatory, Optional, Sortable, Filter, Foreign, Joined, Computed, Validator, ModelReference, ModifierKey } from "@antelopejs/interface-data-api/metadata";
-import { Parameters, Query, Validation } from "@antelopejs/interface-data-api/components";
+import {
+  DataController,
+  DefaultRoutes,
+  RegisterDataController,
+  GetDataControllerMeta,
+} from "@antelopejs/interface-data-api";
+import {
+  Access,
+  AccessMode,
+  Listable,
+  Mandatory,
+  Optional,
+  Sortable,
+  Filter,
+  Foreign,
+  Joined,
+  Computed,
+  Validator,
+  ModelReference,
+  ModifierKey,
+} from "@antelopejs/interface-data-api/metadata";
+import {
+  Parameters,
+  Query,
+  Validation,
+} from "@antelopejs/interface-data-api/components";
 ```
 
 `/components` is only needed for custom route callbacks (query building, validation helpers).
@@ -28,9 +51,26 @@ import { Parameters, Query, Validation } from "@antelopejs/interface-data-api/co
 
 ```typescript
 import { Controller } from "@antelopejs/interface-api";
-import { DataController, DefaultRoutes, RegisterDataController } from "@antelopejs/interface-data-api";
-import { Access, AccessMode, Listable, Mandatory, ModelReference, Sortable } from "@antelopejs/interface-data-api/metadata";
-import { BasicDataModel, Field, Model, RegisterTable, Table } from "@antelopejs/interface-database-decorators";
+import {
+  DataController,
+  DefaultRoutes,
+  RegisterDataController,
+} from "@antelopejs/interface-data-api";
+import {
+  Access,
+  AccessMode,
+  Listable,
+  Mandatory,
+  ModelReference,
+  Sortable,
+} from "@antelopejs/interface-data-api/metadata";
+import {
+  BasicDataModel,
+  Field,
+  Model,
+  RegisterTable,
+  Table,
+} from "@antelopejs/interface-database-decorators";
 
 @RegisterTable("tasks", "default")
 class Task extends Table {
@@ -43,7 +83,11 @@ class Task extends Table {
 class TaskModel extends BasicDataModel(Task, "tasks") {}
 
 @RegisterDataController()
-class TaskAPI extends DataController(Task, DefaultRoutes.All, Controller("/tasks")) {
+class TaskAPI extends DataController(
+  Task,
+  DefaultRoutes.All,
+  Controller("/tasks"),
+) {
   @ModelReference()
   @Model(TaskModel, "my-database")
   declare taskModel: TaskModel;