@antelopejs/interface-data-api 0.4.0 → 0.6.0

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

@@ -118,9 +118,11 @@ This exposes `GET /tasks/get?id=`, `GET /tasks/list`, `POST /tasks/new`, `PUT /t
 - `list` responds `{ results, total, offset, limit }`. `limit` defaults to 10 and is capped at 100
   (`maxPage`). Sorting uses `sortKey`/`sortDirection` query params and requires `@Sortable` on the
   field (400 otherwise). List responses only include `@Listable` fields unless `noPluck` is set.
-- Filters come from `filter_<name>=<mode>:<value>` query params (plain value means `eq`); modes are
-  `eq|ne|gt|ge|lt|le` (the default filter compares the raw query-string value — pass a custom filter
-  function to cast for numeric ranges). Only fields declared with `@Filter()` are filterable.
+- Filters come from `filter_<name>=<mode>:<value>` query params (plain value means `eq`). `mode` is
+  text: the default filter accepts `eq|ne|gt|ge|lt|le` and answers 400 for anything else (it compares
+  the raw query-string value — pass a custom filter function to cast for numeric ranges), and a custom
+  filter receives it unchecked and defines its own modes. Only fields declared with `@Filter()` are
+  filterable.
   Repeating a field's filter (`filter_age=ge:18&filter_age=lt:65`) keeps the rows passing them all;
   the route then receives a list of tuples for it (`FieldFilter`, read with `FilterValuesOf`).
 - `@Joined` and `@Computed` fields are materialized in-database, so `@Sortable` and `@Filter()` work
@@ -134,12 +136,20 @@ This exposes `GET /tasks/get?id=`, `GET /tasks/list`, `POST /tasks/new`, `PUT /t
 - A custom list route reads its page with `Query.ListPage(db, meta, query, options)` (`offset`,
   `limit`, `filters`, `sortKey`, `pluck`, `noForeign`, `deferredJoined`): joined, then computed, then
   foreign, then pluck.
+- A route is `DataControllerCallback<O, R, A>`: `A` is the tuple `func` receives, one element per
+  `args` entry. The default routes declare theirs (`Get` takes `[RequestContext, GetParameters]`), so a
+  wrapper generic over `[RequestContext, P, ...Rest]` calls `route.func.call(this, ctx, params, ...rest)`
+  typed; without `A` its parameters are not checked.
 - `new` answers the created row as `get` reads it, with its `_id`; `edit` answers the stored row after
   the update. Both accept a body already parsed (`Validation.WrittenBody`), so a wrapping route can
   amend it before the write.
 - `edit` is a partial update: a field absent from the body is left unchanged, `null` clears it, and
   setters only run for the fields present. `@Mandatory("edit")` rejects a field cleared by the body
   (`null`, `""`, `[]`), not an absent one. `new` still writes every writable field and runs every setter.
+- A parsed request body is `FieldValues` (fields by name; a `FieldValue` is JSON or a `Date`). A
+  `@Validator` receives `FieldValue | undefined`, and `Validation.ParseBody` answers 400 for a body that
+  holds anything else, even one a wrapping route already parsed. The default routes run with the
+  controller as `this` (`DataControllerInstance`); a wrapper calls `route.func.call(this, ...)`.
 - A `@Validator` may return a parse result `{ success, data }` (e.g. zod's `safeParseAsync(value)`)
   instead of a boolean: `data` is then written in place of the raw value.
 

package/skills/data-api-interface/cases.json

@@ -0,0 +1,99 @@
+{
+  "version": 1,
+  "cases": [
+    {
+      "id": "data-api-interface-crud-endpoints",
+      "area": "framework",
+      "style": "clean",
+      "prompt": "Expose my orders table as REST endpoints for get, list, create, update and delete. Only the status column should be sortable and customer filterable.",
+      "expect": {
+        "skills": ["data-api-interface"],
+        "acceptable": [
+          "api-interface",
+          "database-decorators-interface",
+          "database-interface",
+          "ajs-consume-interface",
+          "antelopejs"
+        ],
+        "mustMention": [
+          "DataController",
+          "RegisterDataController",
+          "Sortable",
+          "Filter"
+        ]
+      }
+    },
+    {
+      "id": "data-api-interface-crud-casual",
+      "area": "framework",
+      "style": "casual",
+      "prompt": "can i get a crud api straight from my table without writing every route",
+      "expect": {
+        "skills": ["data-api-interface"],
+        "acceptable": [
+          "api-interface",
+          "database-decorators-interface",
+          "database-interface",
+          "antelopejs"
+        ],
+        "mustMention": ["DataController", "DefaultRoutes"]
+      }
+    },
+    {
+      "id": "data-api-interface-field-hidden",
+      "area": "framework",
+      "style": "clean",
+      "prompt": "The list endpoint I generated from my table never returns the email field and I cannot write to it either. Why?",
+      "expect": {
+        "skills": ["data-api-interface"],
+        "acceptable": [
+          "api-interface",
+          "database-decorators-interface",
+          "ajs-consume-interface"
+        ],
+        "mustMention": ["Access"]
+      }
+    },
+    {
+      "id": "data-api-interface-sort-400-casual",
+      "area": "framework",
+      "style": "casual",
+      "prompt": "sorting the list by createdAt gives me a 400",
+      "expect": {
+        "skills": ["data-api-interface"],
+        "acceptable": ["api-interface", "database-decorators-interface"],
+        "mustMention": ["Sortable"]
+      }
+    },
+    {
+      "id": "data-api-interface-table-neighbour",
+      "area": "framework",
+      "style": "clean",
+      "prompt": "Add a hashed passphrase and an encrypted supplier code to my chef table class, plus created and updated timestamps.",
+      "expect": {
+        "skills": ["database-decorators-interface"],
+        "acceptable": [
+          "database-interface",
+          "antelopejs",
+          "ajs-consume-interface"
+        ],
+        "avoid": ["data-api-interface"]
+      }
+    },
+    {
+      "id": "data-api-interface-wrap-new-stamp",
+      "area": "framework",
+      "style": "clean",
+      "prompt": "I want the generated create route to stamp a source field on every body before it is validated and written. How do I wrap it, and what type does the parsed body have?",
+      "expect": {
+        "skills": ["data-api-interface"],
+        "acceptable": [
+          "api-interface",
+          "database-decorators-interface",
+          "ajs-consume-interface"
+        ],
+        "mustMention": ["ParseBody", "WrittenBody", "FieldValues"]
+      }
+    }
+  ]
+}