@jskit-ai/agent-docs 0.1.305 → 0.1.307

package/guide/agent/app-extras/assistant.md

@@ -516,6 +516,15 @@ arguments and result pass 64 KiB. The model must still write the call in one
 step: the API engine asks for at most 32,000 output tokens a step, and a model's
 own output limit, or its reasoning, can leave less.
 
+By default the assistant refuses a tool's arguments past 32 KiB and its result
+past 48 KiB ([limits](./assistant-conversation.md#application-tools)). An
+action that takes a whole document (a template, a plan, a long settings record)
+as its input usually works on small documents and fails on the largest, and
+the model must write the whole document again on every edit. Prefer actions
+shaped as changes for the assistant (add, update or remove one part, by id),
+and call each tool with the largest real document, seeded and library records
+included, not only with the small ones tests create.
+
 ### Framework account and workspace actions
 
 Account and workspace action owners supply assistant-specific descriptions,

package/guide/agent/app-setup/multi-homing.md

@@ -228,9 +228,12 @@ To send invitation email, provide the optional `workspaces.invite-mailer`
 capability from one of the application's providers. Without one, invitations
 are still created and delivery reports `mailer_unconfigured`. The mailer, typed
 `WorkspaceInviteMailer` in `@jskit-ai/workspaces-core/server/types`, is an
-object whose `sendWorkspaceInvite(message, options)` receives `{ email,
-inviteUrl, workspace, inviter, roleSid, expiresAt, message }`, where the inner
-`message` is the rendered `{ subject, text, html }`:
+object whose `sendWorkspaceInvite(message, options)` receives `{ inviteId,
+email, inviteUrl, workspace, inviter, roleSid, expiresAt, locale, message }`,
+where the inner `message` is the rendered `{ subject, text, html }`. `inviteId`
+is the saved invitation's id and `workspace.id` its workspace's, so a mailer
+that holds email until delivery is set up can record which invitation each one
+belongs to without reading `workspace_invites`:
 
 ```js
 const InviteMailerProvider = defineProvider({

package/guide/agent/framework/data-access.md

@@ -463,6 +463,38 @@ async function noticeVisibilityPolicy({ query, caller, context, column, value })
 }
 ```
 
+A policy narrows with `where` calls only: `where`, `andWhere`, `orWhere` and
+their kin (`whereIn`, `whereExists`, `whereNot`, `orWhereNull`...). Its calls
+run inside one parenthesised `where` group, where Knex compiles predicates and
+drops a join without a word, which would leave the policy hiding nothing; any
+other call (`join`, `leftJoin`, `select`) throws a TypeError naming the
+feature, the policy and the table. To narrow through another table, tie a
+subquery to the row with `whereExists`: over `ownTable(name)`, which may join
+the owner's other tables, or over another owner's join source. A policy is told
+the call's `options`, `{ context, trx }` as the caller passed them, and passes
+them on unchanged to `joinSource({ alias }, options)`, so the join source reads
+in the caller's scope and transaction; never build them by hand.
+
+```js
+// good: a member of the document's team sees it, through the teams owner's join source
+async function teamDocumentsPolicy({ query, caller, column, options, requires }) {
+  if (caller.kind !== "user") {
+    return caller.kind !== "anonymous";
+  }
+  const member = await requires.teams.joinSource({ alias: "tm" }, options);
+  query.whereExists(
+    member.query.select(1).whereColumn(member.column("teamId"), column("teamId")).where(member.column("userId"), caller.userId)
+  );
+  return true;
+}
+
+// bad: a join inside the policy, which Knex would drop from the where group; it throws
+function teamDocumentsPolicy({ query, caller, column }) {
+  query.join("team_members as tm", "tm.team_id", column("teamId")).where("tm.user_id", caller.userId);
+  return true;
+}
+```
+
 A rule that depends on the caller's role reads `context.permissions` with
 `hasPermission(context.permissions, "bookings.view-all")` from
 `@jskit-ai/kernel/shared/support`, never with `includes()`. A role may hold
@@ -762,6 +794,47 @@ is `FOR NO KEY UPDATE`, which still keeps every other lock and write of the row
 out but lets those inserts through; MySQL, MariaDB and SQLite lock as for the
 default `"update"`. Any other value throws a `TypeError` before anything runs.
 
+A check that only reads rows, and needs them unchanged until the transaction
+ends while other checks read them at once (is the membership still active
+while this document is filed under it?), takes a shared lock: `lockMode:
+"share"` on `lock`, `lockMany` or `lockWhere`, and so on an owner API that
+passes its options on, such as `workspaces.lock(workspaceId, { ...txOptions,
+lockMode: "share" })` or
+`workspaces.memberships.lockByWorkspaceIdAndUserId(workspaceId, userId, {
+...txOptions, lockMode: "share" })`. It is `FOR SHARE` on PostgreSQL and `LOCK
+IN SHARE MODE` on MySQL and MariaDB: other reads, shared locks and inserts of
+rows that reference the locked ones go on, and an update, a delete or an
+exclusive lock of them waits until the transaction ends; SQLite still runs one
+transaction at a time. Never write a row the transaction holds shared: two
+transactions that each hold it shared and then write it wait for each other,
+and the database fails one as a deadlock. Lock a row the work will write with
+the default `"update"` from the start. `claim`, `patchWhere` and
+`lockOrCreate` refuse `"share"` with a `TypeError`, since they take or write
+their rows.
+
+```js
+// good: concurrent filings check the membership at once; a change to it waits until this commits
+const file = (input, options) => documents.withTransaction(options, async (txOptions) => {
+  const membership = await memberships.lock(input.membershipId, { ...txOptions, lockMode: "share", fields: ["status"] });
+  if (membership.status !== "active") {
+    throw new ConflictError("documents.membershipInactive");
+  }
+  return documents.create(input, txOptions);
+});
+
+// bad: the transaction holds the membership shared, then writes it; two such filings deadlock
+await memberships.patch(input.membershipId, { lastFiledAt: new Date() }, txOptions);
+```
+
+Locks stay on the owner's handle and its owner API. A `scopedQuery()` or
+`joinSource()` builder takes no lock, and a row policy is not told a read's
+lock mode: it says which rows a caller may see, the same for every read. Rows
+of several owners are never locked in one statement over a join, which on
+MySQL and MariaDB locks every joined row the read examines: lock each owner's
+rows with its own `lock`, `lockMany` or `lockWhere`, the owners in one fixed
+order on every path (a parent's owner before its children's), so two
+transactions never take them in opposite orders.
+
 A record that a person edits from a form it read earlier carries a version
 number: the table resource names it with `lockVersionField`, an integer field
 over a non-null integer column with `defaultTo: 0`.
@@ -1217,10 +1290,30 @@ three more times, so the work must
 be safe to repeat: an HTTP call or an email goes after commit, or into an
 outbox row written inside it. Work that cannot be repeated passes `{ ...options, retry: false }`, and work that must
 commit before its caller goes on passes `{ ...options, outermost: true }`.
-Code never asks whether it runs in a transaction: `withTransaction` joins the
-caller's, `outermost` refuses one, and `lock`, `lockMany`, `lockWhere` and
-`claim` refuse to run outside one; `lockOrCreate` opens its own (and retries a
-lost insert race only then).
+Work that must commit or roll back with its caller's transaction, and so must
+never open one of its own, passes `{ ...options, joinOnly: true }`: called
+outside a transaction it throws a TypeError before the work runs. Code never
+asks whether it runs in a transaction: `withTransaction` joins the caller's,
+`outermost` refuses one, `joinOnly` requires one, and `lock`, `lockMany`,
+`lockWhere` and `claim` refuse to run outside one; `lockOrCreate` opens its own
+(and retries a lost insert race only then).
+
+```js
+// good: both moves land with the caller's transaction, or neither does
+async function moveStock(transfer, options) {
+  return stock.withTransaction({ ...options, joinOnly: true }, async (txOptions) => {
+    await stock.patch(transfer.fromId, { quantity: transfer.fromQuantity }, txOptions);
+    await stock.patch(transfer.toId, { quantity: transfer.toQuantity }, txOptions);
+  });
+}
+
+// bad: asks whether it runs in a transaction by reading it out of options
+async function moveStock(transfer, options) {
+  if (!options.trx) throw new Error("moveStock runs inside its caller's transaction");
+  await stock.patch(transfer.fromId, { quantity: transfer.fromQuantity }, options);
+  await stock.patch(transfer.toId, { quantity: transfer.toQuantity }, options);
+}
+```
 
 When the work throws, the transaction rolls back and the caller gets the
 work's own error, with its status and code, reporting `transactionOutcome:
@@ -1505,7 +1598,7 @@ server code is server code. Neither `eslint-disable`, an inline
 | Rule | Reports | Section |
 | --- | --- | --- |
 | `jskit/no-direct-knex` | a table reached by name with Knex, a `.knex` read or `knex` destructured, a transaction opened by hand | [The resource is the only door](#the-resource-is-the-only-door) |
-| `jskit/no-transaction-reader` | `options.trx`, `trx \|\| knex`, a `trx = knex` default, `trx` destructured from options, any key but `context` and `trx` read from the `txOptions` work receives | [Transactions](#transactions) |
+| `jskit/no-transaction-reader` | `options.trx`, `trx \|\| knex`, a `trx = knex` default, `trx` destructured from options, any key but `context` and `trx` read from the `txOptions` work receives; a read an `if` tests before throwing points to `joinOnly` or `outermost` | [Transactions](#transactions) |
 | `jskit/no-hand-scope` | a hand-written `where` on `workspace_id` or `workspaceId` | [Layer 1: the table resource](#layer-1-the-table-resource) |
 | `jskit/sql-literal` | raw SQL built from strings or templates instead of one literal with bindings | [Layer 5: reports the resource cannot express](#layer-5-reports-the-resource-cannot-express) |
 | `jskit/no-hand-context` | a system context made with `createSystemContext` or `declareSystemScope`, a context's `scopeValues` written by hand | [Background work](#background-work) |

package/guide/agent/framework/material-3.md

@@ -97,7 +97,13 @@ Exactly this, and nothing more:
    top-level: no arrow, a fresh trail. Placements are literal declarative data,
    one `addPlacement({ ... })` per destination with plain string `surface`,
    `scopedSuffix` and `unscopedSuffix`, never built by a helper, a spread or a
-   template, so a reader and `jskit check` can map every destination.
+   template, so a reader and `jskit check` can map every destination. One
+   dynamic page may serve several destinations: `modules/[moduleKey]/index.vue`
+   renders each module a placement names literally (`scopedSuffix:
+   "/modules/incidents"`, `"/modules/hazards"`), so it is top-level and declares
+   no parent. A literal destination is served by a page whose route matches it
+   segment by segment, each `:param` standing for exactly one segment; the
+   page's deeper pages (`modules/[moduleKey]/settings.vue`) are inner pages.
 3. **Every in-app link and navigation goes through JSKIT navigation:**
    `:to="paths.page('/suppliers')"` and `router.push(paths.page(...))` with
    `usePaths()`, the CRUD runtime's `resolveViewUrl()`, `resolveEditUrl()` and
@@ -133,7 +139,7 @@ Exactly this, and nothing more:
 | `nav/raw-link` | a hand-built in-app path in `to`, `href`, `router.push()`, `router.replace()` or a `to:`/`href:` object key outside a placement |
 | `nav/back-control` | any back control but the shell's Up that navigates the app: "Back to X", "← Suppliers", back arrows and navigating chevrons, breadcrumbs, a custom app-bar back button, a back component (`<ContextBackButton />` or `<page-back-link>`, and its import), a `goBack()`-style handler |
 | `nav/missing-parent` | an inner page of a shell surface without a declared parent, when it always renders under the shell's top app bar (a layout that also renders its pages without `ShellLayout`, such as a shop device's sign-in in a `v-if`, leaves its pages unjudged) |
-| `nav/top-level-parent` | a main-navigation destination that declares a parent |
+| `nav/top-level-parent` | a main-navigation destination that declares a parent, including a dynamic page whose route serves a literal destination (`/modules/:moduleKey` for `/modules/incidents`) |
 | `nav/placement-data` | a main-navigation placement that isn't literal data (no page is judged for a missing parent until it is) |
 | `nav/missing-shell-layout` | a page that declares a parent with no shell layout rendering it, so its title, Up and actions never show |
 | `nav/surface-parent` | a parent declared beside `jskit.surface`, which the shell never reads |

package/guide/agent/framework/sanity-checks.md

@@ -57,6 +57,8 @@ truthful model-facing output; the assistant validates the result against
 `extensions.assistant.output` and rejects unexpected fields, so a contract
 that promises what execution cannot return fails at run time, not at review
 ([Assistant](/guide/app-extras/assistant#database-surface-action-tools)).
+Call it with the largest real input too, seeded records included: a tool's
+arguments stop at 32 KiB and its result at 48 KiB by default.
 
 **Example:** sparse primary fields stay sparse, and an included record is read
 from its lookup container (`items[0].lookups.pet.name`); a contract that

package/guide/agent/framework/translation.md

@@ -210,6 +210,19 @@ translate a key and show any other string as written:
 { label: "Reports" }
 ```
 
+## Content the app ships as data
+
+Names and descriptions in records the app seeds or ships, such as a
+catalogue's items or a library's templates, are the app's own text. Prefer
+storing their message key (`app.templates.starter.name`) with the English in
+the app's `en` messages, and show the field with `text()` from
+`useJskitText()`, the helper placement labels use: it translates a key and
+shows any other string as written. Stored English cannot follow the user's
+language, and matching it back to a key breaks once someone edits it. When a
+person renames their own copy, the field takes what they wrote and shows it as
+written. Server code that writes such a field into an email or an export
+resolves the key with `createServerI18n` (see [Emails](#emails)).
+
 ## Dates and numbers
 
 JSKIT formats dates, times, numbers and relative times with `Intl` in the

package/guide/agent/framework/typed-features.md

@@ -824,6 +824,14 @@ for anything that reads or writes the domain.**
   address and refuses with 429, `kernel.http.rateLimited` and `Retry-After`.
   A limit worth changing per application is read from its config, as
   `config.auth.rateLimits` is.
+- A route's `body` is validated by the kernel, on every method, DELETE
+  included. A request without a body is validated as an empty one: a body
+  validated in `create` or `replace` mode answers 400 `validation_failed`
+  naming its required fields, and one in the default `patch` mode, or with no
+  required fields, reaches the handler as `{}`. A body that is not a JSON
+  object answers 400 with the field error `request: "must be object"`. On the
+  client, a `useCommand()` DELETE sends its parsed input as the body when the
+  command declares `input` or `buildRawPayload`.
 
 Why: an action is the one place a domain operation's policy, input and
 events are declared.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/agent-docs",
-  "version": "0.1.305",
+  "version": "0.1.307",
   "description": "Distributed JSKIT agent references, prompts, guides, and generated reference maps.",
   "type": "module",
   "files": [

package/patterns/feature-package/example/booking-engine/package.json

@@ -5,7 +5,7 @@
   "private": true,
   "type": "module",
   "dependencies": {
-    "@jskit-ai/kernel": "0.2.20",
+    "@jskit-ai/kernel": "0.2.21",
     "json-rest-schema": "^1.0.20"
   },
   "exports": {

package/patterns/minimal-foundation/example/package.json

@@ -34,7 +34,7 @@
   "dependencies": {
     "@local/main": "0.1.0",
     "@fastify/static": "^10.1.3",
-    "@jskit-ai/kernel": "0.2.20",
+    "@jskit-ai/kernel": "0.2.21",
     "@jskit-ai/material-web": "0.1.5",
     "@tanstack/vue-query": "^5.101.0",
     "fastify": "^5.12.7",
@@ -44,13 +44,13 @@
     "vue": "^3.5.44",
     "vue-router": "^5.3.1",
     "vuetify": "^4.3.0",
-    "@jskit-ai/http-runtime": "0.2.20",
+    "@jskit-ai/http-runtime": "0.2.21",
     "@fastify/fast-json-stringify-compiler": "^5.1.0",
     "@vue/devtools-api": "^8.2.1"
   },
   "devDependencies": {
-    "@jskit-ai/config-eslint": "0.1.250",
-    "@jskit-ai/jskit-catalog": "0.2.57",
+    "@jskit-ai/config-eslint": "0.1.251",
+    "@jskit-ai/jskit-catalog": "0.2.59",
     "@playwright/test": "1.61.1",
     "@vitejs/plugin-vue": "^6.0.7",
     "eslint": "^10.8.0",

package/patterns/shell-foundation/example/package.json

@@ -34,7 +34,7 @@
   "dependencies": {
     "@local/main": "0.1.0",
     "@fastify/static": "^10.1.3",
-    "@jskit-ai/kernel": "0.2.20",
+    "@jskit-ai/kernel": "0.2.21",
     "@jskit-ai/material-web": "0.1.5",
     "@tanstack/vue-query": "^5.101.0",
     "fastify": "^5.12.7",
@@ -44,14 +44,14 @@
     "vue": "^3.5.44",
     "vue-router": "^5.3.1",
     "vuetify": "^4.3.0",
-    "@jskit-ai/http-runtime": "0.2.20",
-    "@jskit-ai/shell-web": "0.2.27",
+    "@jskit-ai/http-runtime": "0.2.21",
+    "@jskit-ai/shell-web": "0.2.28",
     "@fastify/fast-json-stringify-compiler": "^5.1.0",
     "@vue/devtools-api": "^8.2.1"
   },
   "devDependencies": {
-    "@jskit-ai/config-eslint": "0.1.250",
-    "@jskit-ai/jskit-catalog": "0.2.57",
+    "@jskit-ai/config-eslint": "0.1.251",
+    "@jskit-ai/jskit-catalog": "0.2.59",
     "@playwright/test": "1.61.1",
     "@vitejs/plugin-vue": "^6.0.7",
     "eslint": "^10.8.0",

package/patterns/shell-foundation/example/packages/main/package.json

@@ -9,7 +9,7 @@
   },
   "description": "App-local runtime composition and lightweight glue.",
   "dependencies": {
-    "@jskit-ai/kernel": "0.2.20"
+    "@jskit-ai/kernel": "0.2.21"
   },
   "jskit": {
     "kind": "runtime",