@jskit-ai/agent-docs 0.1.304 → 0.1.306
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/guide/agent/app-extras/assistant.md +9 -0
- package/guide/agent/framework/sanity-checks.md +2 -0
- package/guide/agent/framework/translation.md +13 -0
- package/package.json +1 -1
- package/patterns/minimal-foundation/example/package.json +1 -1
- package/patterns/shell-foundation/example/package.json +1 -1
- package/reference/autogen/PATTERN_INDEX.md +9 -9
- package/skills/jskit/references/pattern-index.md +9 -9
- package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +1 -1
- package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +1 -1
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +1 -1
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +2 -2
- package/skills/jskit/references/sanity-checks.md +2 -0
- package/skills/jskit/references/translation.md +13 -0
|
@@ -516,6 +516,15 @@ arguments and result pass 64 KiB. The model must still write the call in one
|
|
|
516
516
|
step: the API engine asks for at most 32,000 output tokens a step, and a model's
|
|
517
517
|
own output limit, or its reasoning, can leave less.
|
|
518
518
|
|
|
519
|
+
By default the assistant refuses a tool's arguments past 32 KiB and its result
|
|
520
|
+
past 48 KiB ([limits](./assistant-conversation.md#application-tools)). An
|
|
521
|
+
action that takes a whole document (a template, a plan, a long settings record)
|
|
522
|
+
as its input usually works on small documents and fails on the largest, and
|
|
523
|
+
the model must write the whole document again on every edit. Prefer actions
|
|
524
|
+
shaped as changes for the assistant (add, update or remove one part, by id),
|
|
525
|
+
and call each tool with the largest real document, seeded and library records
|
|
526
|
+
included, not only with the small ones tests create.
|
|
527
|
+
|
|
519
528
|
### Framework account and workspace actions
|
|
520
529
|
|
|
521
530
|
Account and workspace action owners supply assistant-specific descriptions,
|
|
@@ -57,6 +57,8 @@ truthful model-facing output; the assistant validates the result against
|
|
|
57
57
|
`extensions.assistant.output` and rejects unexpected fields, so a contract
|
|
58
58
|
that promises what execution cannot return fails at run time, not at review
|
|
59
59
|
([Assistant](/guide/app-extras/assistant#database-surface-action-tools)).
|
|
60
|
+
Call it with the largest real input too, seeded records included: a tool's
|
|
61
|
+
arguments stop at 32 KiB and its result at 48 KiB by default.
|
|
60
62
|
|
|
61
63
|
**Example:** sparse primary fields stay sparse, and an included record is read
|
|
62
64
|
from its lookup container (`items[0].lookups.pet.name`); a contract that
|
|
@@ -210,6 +210,19 @@ translate a key and show any other string as written:
|
|
|
210
210
|
{ label: "Reports" }
|
|
211
211
|
```
|
|
212
212
|
|
|
213
|
+
## Content the app ships as data
|
|
214
|
+
|
|
215
|
+
Names and descriptions in records the app seeds or ships, such as a
|
|
216
|
+
catalogue's items or a library's templates, are the app's own text. Prefer
|
|
217
|
+
storing their message key (`app.templates.starter.name`) with the English in
|
|
218
|
+
the app's `en` messages, and show the field with `text()` from
|
|
219
|
+
`useJskitText()`, the helper placement labels use: it translates a key and
|
|
220
|
+
shows any other string as written. Stored English cannot follow the user's
|
|
221
|
+
language, and matching it back to a key breaks once someone edits it. When a
|
|
222
|
+
person renames their own copy, the field takes what they wrote and shows it as
|
|
223
|
+
written. Server code that writes such a field into an email or an export
|
|
224
|
+
resolves the key with `createServerI18n` (see [Emails](#emails)).
|
|
225
|
+
|
|
213
226
|
## Dates and numbers
|
|
214
227
|
|
|
215
228
|
JSKIT formats dates, times, numbers and relative times with `Intl` in the
|
package/package.json
CHANGED
|
@@ -15,7 +15,7 @@ A concrete Fastify, Vue, and JSKIT application foundation for products that do n
|
|
|
15
15
|
|
|
16
16
|
- Id: `app/minimal-foundation`
|
|
17
17
|
- Keywords: `app`, `fastify`, `foundation`, `minimal`, `server`, `vite`, `vue`
|
|
18
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
18
|
+
- Owner: `@jskit-ai/agent-docs@0.1.306`
|
|
19
19
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/app/minimal-foundation/PATTERN.md)
|
|
20
20
|
- Examples: [example/](../../skills/jskit/references/patterns/app/minimal-foundation/example/)
|
|
21
21
|
- Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`
|
|
@@ -26,7 +26,7 @@ A concrete JSKIT web application foundation with responsive shell navigation, se
|
|
|
26
26
|
|
|
27
27
|
- Id: `app/shell-foundation`
|
|
28
28
|
- Keywords: `app`, `foundation`, `material`, `navigation`, `placements`, `shell`, `vite`, `vue`
|
|
29
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
29
|
+
- Owner: `@jskit-ai/agent-docs@0.1.306`
|
|
30
30
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/app/shell-foundation/PATTERN.md)
|
|
31
31
|
- Examples: [example/](../../skills/jskit/references/patterns/app/shell-foundation/example/)
|
|
32
32
|
- Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -246,7 +246,7 @@ Add a protected administration surface, settings shell, and semantic navigation
|
|
|
246
246
|
|
|
247
247
|
- Id: `console/console-surface`
|
|
248
248
|
- Keywords: `admin`, `console`, `navigation`, `owner`, `placement`, `settings`, `surface`
|
|
249
|
-
- Owner: `@jskit-ai/console-web@0.1.
|
|
249
|
+
- Owner: `@jskit-ai/console-web@0.1.258`
|
|
250
250
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/console/console-surface/PATTERN.md)
|
|
251
251
|
- Examples: [example/](../../skills/jskit/references/patterns/console/console-surface/example/)
|
|
252
252
|
- Requires: `@jskit-ai/console-core`, `@jskit-ai/console-web`, `@jskit-ai/shell-web`
|
|
@@ -345,7 +345,7 @@ Compose application-owned Google Publisher Tag delivery with the generic rewarde
|
|
|
345
345
|
|
|
346
346
|
- Id: `rewards/google-rewarded`
|
|
347
347
|
- Keywords: `ads`, `google`, `publisher tag`, `rewarded`, `unlock`
|
|
348
|
-
- Owner: `@jskit-ai/rewarded-web@0.2.
|
|
348
|
+
- Owner: `@jskit-ai/rewarded-web@0.2.36`
|
|
349
349
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/rewards/google-rewarded/PATTERN.md)
|
|
350
350
|
- Examples: [example/](../../skills/jskit/references/patterns/rewards/google-rewarded/example/)
|
|
351
351
|
- Requires: `@jskit-ai/rewarded-web`
|
|
@@ -356,7 +356,7 @@ Define a server feature through explicit capabilities and first-class actions, a
|
|
|
356
356
|
|
|
357
357
|
- Id: `server/feature-package`
|
|
358
358
|
- Keywords: `actions`, `aggregate`, `feature`, `handle`, `orchestration`, `owns`, `package`, `provider`, `repository`, `routes`, `server`, `table resource`
|
|
359
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
359
|
+
- Owner: `@jskit-ai/agent-docs@0.1.306`
|
|
360
360
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/server/feature-package/PATTERN.md)
|
|
361
361
|
- Examples: [example/](../../skills/jskit/references/patterns/server/feature-package/example/)
|
|
362
362
|
- Requires: `@jskit-ai/kernel`
|
|
@@ -389,7 +389,7 @@ Compose an account settings route and profile, preference, notification, and sig
|
|
|
389
389
|
|
|
390
390
|
- Id: `users/account-settings`
|
|
391
391
|
- Keywords: `account`, `link provider`, `notifications`, `oauth`, `preferences`, `profile`, `settings`, `sign-in methods`, `user`, `vue`
|
|
392
|
-
- Owner: `@jskit-ai/users-web@0.2.
|
|
392
|
+
- Owner: `@jskit-ai/users-web@0.2.41`
|
|
393
393
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/users/account-settings/PATTERN.md)
|
|
394
394
|
- Examples: [example/](../../skills/jskit/references/patterns/users/account-settings/example/)
|
|
395
395
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
|
|
@@ -400,7 +400,7 @@ Expose user administration and workspace-scoped member operations through app-ow
|
|
|
400
400
|
|
|
401
401
|
- Id: `users/user-administration-server`
|
|
402
402
|
- Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
|
|
403
|
-
- Owner: `@jskit-ai/users-core@0.2.
|
|
403
|
+
- Owner: `@jskit-ai/users-core@0.2.31`
|
|
404
404
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/users/user-administration-server/PATTERN.md)
|
|
405
405
|
- Examples: [example/](../../skills/jskit/references/patterns/users/user-administration-server/example/)
|
|
406
406
|
- Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
|
|
@@ -411,7 +411,7 @@ Configure roles, workspace access policy, invitations, and app-owned invitation
|
|
|
411
411
|
|
|
412
412
|
- Id: `workspaces/workspace-server`
|
|
413
413
|
- Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
|
|
414
|
-
- Owner: `@jskit-ai/workspaces-core@0.2.
|
|
414
|
+
- Owner: `@jskit-ai/workspaces-core@0.2.31`
|
|
415
415
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/workspaces/workspace-server/PATTERN.md)
|
|
416
416
|
- Examples: [example/](../../skills/jskit/references/patterns/workspaces/workspace-server/example/)
|
|
417
417
|
- Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
|
|
@@ -422,7 +422,7 @@ Compose workspace selection, invitation, member administration, settings, and re
|
|
|
422
422
|
|
|
423
423
|
- Id: `workspaces/workspace-surfaces`
|
|
424
424
|
- Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
|
|
425
|
-
- Owner: `@jskit-ai/workspaces-web@0.2.
|
|
425
|
+
- Owner: `@jskit-ai/workspaces-web@0.2.41`
|
|
426
426
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/workspaces/workspace-surfaces/PATTERN.md)
|
|
427
427
|
- Examples: [example/](../../skills/jskit/references/patterns/workspaces/workspace-surfaces/example/)
|
|
428
428
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/workspaces-core`, `@jskit-ai/workspaces-web`
|
|
@@ -15,7 +15,7 @@ A concrete Fastify, Vue, and JSKIT application foundation for products that do n
|
|
|
15
15
|
|
|
16
16
|
- Id: `app/minimal-foundation`
|
|
17
17
|
- Keywords: `app`, `fastify`, `foundation`, `minimal`, `server`, `vite`, `vue`
|
|
18
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
18
|
+
- Owner: `@jskit-ai/agent-docs@0.1.306`
|
|
19
19
|
- Read: [PATTERN.md](patterns/app/minimal-foundation/PATTERN.md)
|
|
20
20
|
- Examples: [example/](patterns/app/minimal-foundation/example/)
|
|
21
21
|
- Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`
|
|
@@ -26,7 +26,7 @@ A concrete JSKIT web application foundation with responsive shell navigation, se
|
|
|
26
26
|
|
|
27
27
|
- Id: `app/shell-foundation`
|
|
28
28
|
- Keywords: `app`, `foundation`, `material`, `navigation`, `placements`, `shell`, `vite`, `vue`
|
|
29
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
29
|
+
- Owner: `@jskit-ai/agent-docs@0.1.306`
|
|
30
30
|
- Read: [PATTERN.md](patterns/app/shell-foundation/PATTERN.md)
|
|
31
31
|
- Examples: [example/](patterns/app/shell-foundation/example/)
|
|
32
32
|
- Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -246,7 +246,7 @@ Add a protected administration surface, settings shell, and semantic navigation
|
|
|
246
246
|
|
|
247
247
|
- Id: `console/console-surface`
|
|
248
248
|
- Keywords: `admin`, `console`, `navigation`, `owner`, `placement`, `settings`, `surface`
|
|
249
|
-
- Owner: `@jskit-ai/console-web@0.1.
|
|
249
|
+
- Owner: `@jskit-ai/console-web@0.1.258`
|
|
250
250
|
- Read: [PATTERN.md](patterns/console/console-surface/PATTERN.md)
|
|
251
251
|
- Examples: [example/](patterns/console/console-surface/example/)
|
|
252
252
|
- Requires: `@jskit-ai/console-core`, `@jskit-ai/console-web`, `@jskit-ai/shell-web`
|
|
@@ -345,7 +345,7 @@ Compose application-owned Google Publisher Tag delivery with the generic rewarde
|
|
|
345
345
|
|
|
346
346
|
- Id: `rewards/google-rewarded`
|
|
347
347
|
- Keywords: `ads`, `google`, `publisher tag`, `rewarded`, `unlock`
|
|
348
|
-
- Owner: `@jskit-ai/rewarded-web@0.2.
|
|
348
|
+
- Owner: `@jskit-ai/rewarded-web@0.2.36`
|
|
349
349
|
- Read: [PATTERN.md](patterns/rewards/google-rewarded/PATTERN.md)
|
|
350
350
|
- Examples: [example/](patterns/rewards/google-rewarded/example/)
|
|
351
351
|
- Requires: `@jskit-ai/rewarded-web`
|
|
@@ -356,7 +356,7 @@ Define a server feature through explicit capabilities and first-class actions, a
|
|
|
356
356
|
|
|
357
357
|
- Id: `server/feature-package`
|
|
358
358
|
- Keywords: `actions`, `aggregate`, `feature`, `handle`, `orchestration`, `owns`, `package`, `provider`, `repository`, `routes`, `server`, `table resource`
|
|
359
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
359
|
+
- Owner: `@jskit-ai/agent-docs@0.1.306`
|
|
360
360
|
- Read: [PATTERN.md](patterns/server/feature-package/PATTERN.md)
|
|
361
361
|
- Examples: [example/](patterns/server/feature-package/example/)
|
|
362
362
|
- Requires: `@jskit-ai/kernel`
|
|
@@ -389,7 +389,7 @@ Compose an account settings route and profile, preference, notification, and sig
|
|
|
389
389
|
|
|
390
390
|
- Id: `users/account-settings`
|
|
391
391
|
- Keywords: `account`, `link provider`, `notifications`, `oauth`, `preferences`, `profile`, `settings`, `sign-in methods`, `user`, `vue`
|
|
392
|
-
- Owner: `@jskit-ai/users-web@0.2.
|
|
392
|
+
- Owner: `@jskit-ai/users-web@0.2.41`
|
|
393
393
|
- Read: [PATTERN.md](patterns/users/account-settings/PATTERN.md)
|
|
394
394
|
- Examples: [example/](patterns/users/account-settings/example/)
|
|
395
395
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
|
|
@@ -400,7 +400,7 @@ Expose user administration and workspace-scoped member operations through app-ow
|
|
|
400
400
|
|
|
401
401
|
- Id: `users/user-administration-server`
|
|
402
402
|
- Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
|
|
403
|
-
- Owner: `@jskit-ai/users-core@0.2.
|
|
403
|
+
- Owner: `@jskit-ai/users-core@0.2.31`
|
|
404
404
|
- Read: [PATTERN.md](patterns/users/user-administration-server/PATTERN.md)
|
|
405
405
|
- Examples: [example/](patterns/users/user-administration-server/example/)
|
|
406
406
|
- Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
|
|
@@ -411,7 +411,7 @@ Configure roles, workspace access policy, invitations, and app-owned invitation
|
|
|
411
411
|
|
|
412
412
|
- Id: `workspaces/workspace-server`
|
|
413
413
|
- Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
|
|
414
|
-
- Owner: `@jskit-ai/workspaces-core@0.2.
|
|
414
|
+
- Owner: `@jskit-ai/workspaces-core@0.2.31`
|
|
415
415
|
- Read: [PATTERN.md](patterns/workspaces/workspace-server/PATTERN.md)
|
|
416
416
|
- Examples: [example/](patterns/workspaces/workspace-server/example/)
|
|
417
417
|
- Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
|
|
@@ -422,7 +422,7 @@ Compose workspace selection, invitation, member administration, settings, and re
|
|
|
422
422
|
|
|
423
423
|
- Id: `workspaces/workspace-surfaces`
|
|
424
424
|
- Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
|
|
425
|
-
- Owner: `@jskit-ai/workspaces-web@0.2.
|
|
425
|
+
- Owner: `@jskit-ai/workspaces-web@0.2.41`
|
|
426
426
|
- Read: [PATTERN.md](patterns/workspaces/workspace-surfaces/PATTERN.md)
|
|
427
427
|
- Examples: [example/](patterns/workspaces/workspace-surfaces/example/)
|
|
428
428
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/workspaces-core`, `@jskit-ai/workspaces-web`
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
"dependencies": {
|
|
13
13
|
"@jskit-ai/crud-core": "0.2.28",
|
|
14
14
|
"@jskit-ai/resource-crud-core": "0.1.213",
|
|
15
|
-
"@jskit-ai/users-core": "0.2.
|
|
16
|
-
"@jskit-ai/workspaces-core": "0.2.
|
|
15
|
+
"@jskit-ai/users-core": "0.2.31",
|
|
16
|
+
"@jskit-ai/workspaces-core": "0.2.31"
|
|
17
17
|
},
|
|
18
18
|
"peerDependencies": {
|
|
19
19
|
"@jskit-ai/kernel": "0.2.20",
|
|
@@ -57,6 +57,8 @@ truthful model-facing output; the assistant validates the result against
|
|
|
57
57
|
`extensions.assistant.output` and rejects unexpected fields, so a contract
|
|
58
58
|
that promises what execution cannot return fails at run time, not at review
|
|
59
59
|
([Assistant](/guide/app-extras/assistant#database-surface-action-tools)).
|
|
60
|
+
Call it with the largest real input too, seeded records included: a tool's
|
|
61
|
+
arguments stop at 32 KiB and its result at 48 KiB by default.
|
|
60
62
|
|
|
61
63
|
**Example:** sparse primary fields stay sparse, and an included record is read
|
|
62
64
|
from its lookup container (`items[0].lookups.pet.name`); a contract that
|
|
@@ -210,6 +210,19 @@ translate a key and show any other string as written:
|
|
|
210
210
|
{ label: "Reports" }
|
|
211
211
|
```
|
|
212
212
|
|
|
213
|
+
## Content the app ships as data
|
|
214
|
+
|
|
215
|
+
Names and descriptions in records the app seeds or ships, such as a
|
|
216
|
+
catalogue's items or a library's templates, are the app's own text. Prefer
|
|
217
|
+
storing their message key (`app.templates.starter.name`) with the English in
|
|
218
|
+
the app's `en` messages, and show the field with `text()` from
|
|
219
|
+
`useJskitText()`, the helper placement labels use: it translates a key and
|
|
220
|
+
shows any other string as written. Stored English cannot follow the user's
|
|
221
|
+
language, and matching it back to a key breaks once someone edits it. When a
|
|
222
|
+
person renames their own copy, the field takes what they wrote and shows it as
|
|
223
|
+
written. Server code that writes such a field into an email or an export
|
|
224
|
+
resolves the key with `createServerI18n` (see [Emails](#emails)).
|
|
225
|
+
|
|
213
226
|
## Dates and numbers
|
|
214
227
|
|
|
215
228
|
JSKIT formats dates, times, numbers and relative times with `Intl` in the
|