@jskit-ai/agent-docs 0.1.207 → 0.1.208

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.
Files changed (35) hide show
  1. package/guide/agent/app-extras/assistant-conversation.md +534 -6
  2. package/guide/agent/app-extras/assistant-voice.md +16 -1
  3. package/guide/agent/app-extras/assistant.md +8 -0
  4. package/guide/agent/framework/application-operations.md +29 -0
  5. package/guide/agent/framework/crud-operations.md +100 -0
  6. package/package.json +1 -1
  7. package/patterns/feature-package/example/booking-engine/package.json +1 -1
  8. package/patterns/minimal-foundation/example/package.json +4 -4
  9. package/patterns/server-search.md +16 -0
  10. package/patterns/shell-foundation/example/package.json +5 -5
  11. package/patterns/shell-foundation/example/packages/main/package.json +1 -1
  12. package/patterns/ui-testing.md +13 -0
  13. package/reference/autogen/PATTERN_INDEX.md +35 -35
  14. package/reference/autogen/packages/assistant-core.md +33 -10
  15. package/reference/autogen/packages/assistant-runtime.md +3 -2
  16. package/reference/autogen/packages/assistant-voice-sherpa.md +1 -0
  17. package/reference/autogen/packages/assistant-voice.md +1 -0
  18. package/reference/autogen/packages/shell-web.md +15 -0
  19. package/skills/jskit/SKILL.md +20 -7
  20. package/skills/jskit/references/app-operations.md +29 -0
  21. package/skills/jskit/references/crud-operations.md +100 -0
  22. package/skills/jskit/references/pattern-index.md +35 -35
  23. package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +4 -4
  24. package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +5 -5
  25. package/skills/jskit/references/patterns/app/shell-foundation/example/packages/main/package.json +1 -1
  26. package/skills/jskit/references/patterns/auth/supabase-auth/example/package.json +1 -1
  27. package/skills/jskit/references/patterns/connectors/calendar-cli/example/package.json +4 -4
  28. package/skills/jskit/references/patterns/crud/json-api-resource-package/PATTERN.md +33 -0
  29. package/skills/jskit/references/patterns/crud/json-api-resource-package/example/packages/books/package.json +2 -2
  30. package/skills/jskit/references/patterns/database/mysql-application/example/package.json +1 -1
  31. package/skills/jskit/references/patterns/database/postgres-application/example/package.json +1 -1
  32. package/skills/jskit/references/patterns/realtime/realtime-application/example/package.json +2 -2
  33. package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/package.json +1 -1
  34. package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +2 -2
  35. package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +3 -3
@@ -38,6 +38,35 @@ their own exact versions in dependency declarations; do not replace them with
38
38
  The copied files immediately belong to the application. Do not add pattern
39
39
  receipts, generator provenance, completion ledgers, or hidden operation state.
40
40
 
41
+ ## Implement before investigating internals
42
+
43
+ Use the relevant public API contract and one matching example to build the
44
+ smallest working slice, then verify its observable result. When the documented
45
+ contract answers the task, stop reading and implement it. Do not trace framework
46
+ or dependency internals to confirm documented options, routing, package
47
+ discovery, transport, or lifecycle behaviour before trying that API.
48
+
49
+ Implementation source is for a concrete failure or an API question the guide
50
+ and example cannot answer. Name that failure or question before investigating,
51
+ inspect only the relevant owner, and return to implementation and verification
52
+ as soon as it is resolved. Do not tour a dependency tree for confidence. This
53
+ applies to all features and dependencies, not only CRUD screens.
54
+
55
+ ## Discover files before reading them
56
+
57
+ Discover the file, then read it. Do not infer its location from a convention.
58
+ Use paths identified in the current tree, installed metadata, or the relevant
59
+ example. When inspecting an unfamiliar package, list its files with
60
+ `rg --files <observed-package-directory>` and select the relevant paths from
61
+ that inventory before reading or searching source. Do not try guessed source
62
+ directories. An import subpath is an `exports` alias, not necessarily a physical
63
+ path; resolve it through the installed `package.json#exports` or
64
+ `import.meta.resolve()` when following an import.
65
+
66
+ This applies to every package and task, including third-party dependencies.
67
+ Use a documented option directly when it already answers the question; source
68
+ inspection is a fallback for a concrete unresolved fact.
69
+
41
70
  ## Install and compose capabilities
42
71
 
43
72
  Install selected capabilities together at the exact versions in the matching
@@ -79,6 +79,15 @@ const bookResource = defineCrudResource({
79
79
  create: { required: true }
80
80
  }
81
81
  }
82
+ },
83
+ searchSchema: {
84
+ q: {
85
+ type: "string",
86
+ oneOf: ["title"],
87
+ filterOperator: "like",
88
+ splitBy: " ",
89
+ matchAll: true
90
+ }
82
91
  }
83
92
  });
84
93
  ```
@@ -164,6 +173,90 @@ When the same create action appears in more than one visible location, choose
164
173
  one visible action deliberately; do not relax the expected label to accept an
165
174
  unrelated fallback.
166
175
 
176
+ ## Browser tests verify validation and persistence
177
+
178
+ Exercise rejected and accepted input through the same form. Check the rendered
179
+ validation message and that rejection keeps the form open; then save an accepted
180
+ value and prove it appears in the list after reloading. Use the resource's
181
+ configured messages, the screen's `saveLabel`, and its actual browser routes.
182
+ Do not infer an `aria-invalid` attribute from the fact that validation exists:
183
+ the chosen field must actually implement that attribute contract before a test
184
+ can assert it.
185
+
186
+ For the public title-only Books variant above, using the pattern's
187
+ `saveLabel: "Save book"`, default minimum-length message, and a root public
188
+ surface:
189
+
190
+ ```ts
191
+ await page.goto("/books");
192
+ await page.getByRole("link", { name: "Add book", exact: true }).filter({ visible: true }).first().click();
193
+ await expect(page).toHaveURL(/\/books\/new$/);
194
+ await page.reload();
195
+ const title = page.getByRole("textbox", { name: "Title", exact: true });
196
+ const save = page.getByRole("button", { name: "Save book", exact: true });
197
+ await title.fill("");
198
+ await save.click();
199
+ await expect(page.getByText("Length must be at least 1 characters.", { exact: true })).toBeVisible();
200
+ await expect(page).toHaveURL(/\/books\/new$/);
201
+
202
+ await title.fill("A saved book");
203
+ await save.click();
204
+ await expect(page).toHaveURL(/\/books$/);
205
+ await expect(page.getByText("A saved book", { exact: true }).filter({ visible: true })).toBeVisible();
206
+ await page.reload();
207
+ await expect(page.getByText("A saved book", { exact: true }).filter({ visible: true })).toBeVisible();
208
+ ```
209
+
210
+ For client-side routing, a click finishing does not prove the route has changed.
211
+ Before reloading after a navigation control, wait for the destination with
212
+ `await expect(page).toHaveURL(...)`, as above. Otherwise reload can reopen the
213
+ origin page and a later form or Back locator waits on the wrong screen. Use the
214
+ actual destination URL, including required context; do not add fixed sleeps or
215
+ increase timeouts to hide this race. For a contextual Back check, wait for the
216
+ form route, reload, click Back, and assert the original list URL. Test direct
217
+ entry separately against the configured fallback.
218
+
219
+ Keep the application's existing browser configuration and isolated fixtures.
220
+ Adapt the route, labels and configured error message to that application's
221
+ contract, and retain compact, medium and expanded layout coverage. Direct API
222
+ checks additionally prove rejected input is not persisted.
223
+
224
+ ## Wire list search with the initial resource
225
+
226
+ `useCrudListScreen()` enables query search and the shared list renders a Search
227
+ box. When using that screen, configure `resource.searchSchema.q` with the
228
+ searchable fields from the start, as in the title-only Books resource above.
229
+ Showing a Search box alone does not implement storage filtering. Keep the
230
+ mapping in the resource; do not add page-local filtering or duplicate request
231
+ code. The full Books source example maps `q` to title, author and notes; narrow
232
+ it when adapting the example to fewer fields.
233
+
234
+ The browser page's route query and internal CRUD query use plain `q`. The
235
+ JSON:API HTTP transport uses `filter[q]`. Shared CRUD clients encode and decode
236
+ this automatically. Raw HTTP/API tests must send the transport key themselves:
237
+
238
+ ```ts
239
+ const headers = { Accept: "application/vnd.api+json" };
240
+ const matches = await request.get("/api/books", {
241
+ headers, params: { "filter[q]": "A saved book" }
242
+ });
243
+ expect(matches.status()).toBe(200);
244
+ expect((await matches.json()).data.some(book => book.attributes.title === "A saved book")).toBe(true);
245
+
246
+ const noMatches = await request.get("/api/books", {
247
+ headers, params: { "filter[q]": "no-matching-fixture-title" }
248
+ });
249
+ expect(noMatches.status()).toBe(200);
250
+ expect((await noMatches.json()).data).toEqual([]);
251
+ ```
252
+
253
+ Use controlled fixtures with a known matching and nonmatching value. A matching
254
+ row alone does not prove search works: an unfiltered response also includes it.
255
+ In the browser, fill Search, assert the expected visible rows and excluded rows,
256
+ then clear it and assert the list returns. Verify route/reload behaviour when
257
+ the screen synchronizes search to the route. Add these checks to the initial
258
+ create/list flow rather than discovering an unwired control at final review.
259
+
167
260
  ## Direct API tests use JSON:API documents
168
261
 
169
262
  JSKIT's CRUD screens and HTTP client apply the resource's JSON:API transport
@@ -210,6 +303,13 @@ decision. Use `CrudDeleteAction` and `useCrudDeleteAction()` through the view
210
303
  actions slot; do not rebuild their confirmation, request, invalidation, and
211
304
  navigation flow.
212
305
 
306
+ The delete action resolves its HTTP client from the resource's `apiAccess`, just
307
+ like the list, view and form helpers. For `apiAccess: "public"`, DELETE requests
308
+ skip session CSRF discovery; no `/api/session` endpoint or page-local client
309
+ wiring is required. Authenticated resources retain the configured client's CSRF
310
+ behavior. An explicit `client` override is supported and receives the same
311
+ resource-aware public request options. This does not change server authorization.
312
+
213
313
  For custom form actions, see
214
314
  [record form actions](https://mobily-enterprises.github.io/jskit-ai/guide/framework/crud-form-actions).
215
315
 
@@ -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.207`
18
+ - Owner: `@jskit-ai/agent-docs@0.1.208`
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.207`
29
+ - Owner: `@jskit-ai/agent-docs@0.1.208`
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`
@@ -37,7 +37,7 @@ Configure an assistant runtime for one application surface and expose its chat a
37
37
 
38
38
  - Id: `assistant/assistant-surface`
39
39
  - Keywords: `ai`, `assistant`, `chat`, `config`, `environment`, `page`, `placement`, `settings`, `surface`
40
- - Owner: `@jskit-ai/assistant-runtime@0.1.206`
40
+ - Owner: `@jskit-ai/assistant-runtime@0.1.207`
41
41
  - Read: [PATTERN.md](patterns/assistant/assistant-surface/PATTERN.md)
42
42
  - Examples: [example/](patterns/assistant/assistant-surface/example/)
43
43
  - Requires: `@jskit-ai/assistant-runtime`, `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`, `@jskit-ai/shell-web`
@@ -48,7 +48,7 @@ Compose JSKIT authentication routes, views, profile controls, and public surface
48
48
 
49
49
  - Id: `auth/auth-surface`
50
50
  - Keywords: `account`, `auth`, `login`, `logout`, `password`, `placement`, `profile`, `reset`, `surface`
51
- - Owner: `@jskit-ai/auth-web@0.1.235`
51
+ - Owner: `@jskit-ai/auth-web@0.1.236`
52
52
  - Read: [PATTERN.md](patterns/auth/auth-surface/PATTERN.md)
53
53
  - Examples: [example/](patterns/auth/auth-surface/example/)
54
54
  - Requires: `@jskit-ai/auth-core`, `@jskit-ai/auth-web`, `@jskit-ai/shell-web`
@@ -59,7 +59,7 @@ Add Supabase authentication through normal npm composition, explicit environment
59
59
 
60
60
  - Id: `auth/supabase-auth`
61
61
  - Keywords: `auth`, `authentication`, `oauth`, `sessions`, `supabase`
62
- - Owner: `@jskit-ai/auth-provider-supabase-core@0.1.232`
62
+ - Owner: `@jskit-ai/auth-provider-supabase-core@0.1.233`
63
63
  - Read: [PATTERN.md](patterns/auth/supabase-auth/PATTERN.md)
64
64
  - Examples: [example/](patterns/auth/supabase-auth/example/)
65
65
  - Requires: `@jskit-ai/auth-provider-supabase-core`
@@ -70,7 +70,7 @@ Resolve an administrator environment key or an individual user's grant, then use
70
70
 
71
71
  - Id: `connectors/ai-connections`
72
72
  - Keywords: `ai`, `api-key`, `big-pickle`, `cli`, `environment`, `free`, `models`, `ownership`, `zai`, `zen`
73
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
73
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
74
74
  - Read: [PATTERN.md](patterns/connectors/ai-connections/PATTERN.md)
75
75
  - Examples: [example/](patterns/connectors/ai-connections/example/)
76
76
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -81,7 +81,7 @@ Compose provider operations, authorization and encrypted file storage from a CLI
81
81
 
82
82
  - Id: `connectors/api-key-connection`
83
83
  - Keywords: `api-key`, `clay`, `cli`, `clickhouse`, `connectors`, `dbt`, `files`, `firecrawl`, `granola`, `integrations`, `metrics`, `prestashop`, `resend`, `semantic-layer`, `semrush`, `x-twitter`
84
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
84
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
85
85
  - Read: [PATTERN.md](patterns/connectors/api-key-connection/PATTERN.md)
86
86
  - Examples: [example/](patterns/connectors/api-key-connection/example/)
87
87
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -92,7 +92,7 @@ Compose token-based MCP discovery and explicitly authorized tool calls using the
92
92
 
93
93
  - Id: `connectors/assistant-mcp`
94
94
  - Keywords: `assistant`, `cli`, `connectors`, `files`, `integrations`, `mcp`, `n8n`, `sanity`
95
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
95
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
96
96
  - Read: [PATTERN.md](patterns/connectors/assistant-mcp/PATTERN.md)
97
97
  - Examples: [example/](patterns/connectors/assistant-mcp/example/)
98
98
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -103,7 +103,7 @@ Configure assistant OAuth clients, then compose existing state, encrypted file g
103
103
 
104
104
  - Id: `connectors/assistant-mcp-oauth`
105
105
  - Keywords: `amplitude`, `assistant`, `atlassian`, `canva`, `cli`, `client metadata`, `confidence`, `connectors`, `figma`, `files`, `granola`, `hex`, `mcp`, `miro`, `oauth`
106
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
106
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
107
107
  - Read: [PATTERN.md](patterns/connectors/assistant-mcp-oauth/PATTERN.md)
108
108
  - Examples: [example/](patterns/connectors/assistant-mcp-oauth/example/)
109
109
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -114,7 +114,7 @@ Compose signed AWS operations, file configuration and application authorization
114
114
 
115
115
  - Id: `connectors/aws-storage-queries`
116
116
  - Keywords: `athena`, `aws`, `cli`, `connectors`, `files`, `iam`, `queries`, `s3`, `storage`, `sts`
117
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
117
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
118
118
  - Read: [PATTERN.md](patterns/connectors/aws-storage-queries/PATTERN.md)
119
119
  - Examples: [example/](patterns/connectors/aws-storage-queries/example/)
120
120
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -125,7 +125,7 @@ Compose reusable connection libraries with portable configuration, application o
125
125
 
126
126
  - Id: `connectors/calendar-cli`
127
127
  - Keywords: `calendar`, `cli`, `connectors`, `google`, `integrations`, `oauth`, `permissions`
128
- - Owner: `@jskit-ai/connector-google-calendar@0.1.52`
128
+ - Owner: `@jskit-ai/connector-google-calendar@0.1.53`
129
129
  - Read: [PATTERN.md](patterns/connectors/calendar-cli/PATTERN.md)
130
130
  - Examples: [example/](patterns/connectors/calendar-cli/example/)
131
131
  - Requires: `@jskit-ai/connector-google-calendar`, `@jskit-ai/connectors-core`, `@jskit-ai/database-runtime-mysql`
@@ -136,7 +136,7 @@ Compose the shared connector runtime for event delivery while leaving workflow c
136
136
 
137
137
  - Id: `connectors/event-delivery`
138
138
  - Keywords: `cli`, `connectors`, `events`, `files`, `inngest`, `integrations`, `workflows`
139
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
139
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
140
140
  - Read: [PATTERN.md](patterns/connectors/event-delivery/PATTERN.md)
141
141
  - Examples: [example/](patterns/connectors/event-delivery/example/)
142
142
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -147,7 +147,7 @@ Wire service-account grants, file storage, explicit message actions and public b
147
147
 
148
148
  - Id: `connectors/firebase-messaging`
149
149
  - Keywords: `cli`, `connectors`, `fcm`, `files`, `firebase`, `integrations`, `jwt`, `notifications`, `push`, `service-account`, `vapid`
150
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
150
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
151
151
  - Read: [PATTERN.md](patterns/connectors/firebase-messaging/PATTERN.md)
152
152
  - Examples: [example/](patterns/connectors/firebase-messaging/example/)
153
153
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -158,7 +158,7 @@ Compose reviewed Search campaigns with project-owned Google OAuth and portable s
158
158
 
159
159
  - Id: `connectors/google-ads-search`
160
160
  - Keywords: `ads`, `campaigns`, `cli`, `connectors`, `conversion`, `google`, `search`
161
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
161
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
162
162
  - Read: [PATTERN.md](patterns/connectors/google-ads-search/PATTERN.md)
163
163
  - Examples: [example/](patterns/connectors/google-ads-search/example/)
164
164
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -169,7 +169,7 @@ Compose provider consent, verification and encrypted file persistence from an ap
169
169
 
170
170
  - Id: `connectors/oauth-connection`
171
171
  - Keywords: `accounting`, `assistant permissions`, `books`, `cli`, `client credentials`, `connectors`, `consent`, `crm`, `databricks`, `developer token`, `fabric`, `files`, `gaql`, `google ads`, `graphql`, `integrations`, `linkedin`, `microsoft`, `oauth`, `powerpoint`, `salesforce`, `service principal`, `shopify`, `soql`, `staffing`, `tiktok`, `twitch`, `wave`, `word`, `wordpress`, `workday`, `xero`, `zoho`
172
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
172
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
173
173
  - Read: [PATTERN.md](patterns/connectors/oauth-connection/PATTERN.md)
174
174
  - Examples: [example/](patterns/connectors/oauth-connection/example/)
175
175
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -180,7 +180,7 @@ Compose a sequential catalogue batch and preserve partial success for applicatio
180
180
 
181
181
  - Id: `connectors/paddle-catalogue`
182
182
  - Keywords: `batch`, `paddle`, `payments`, `prices`, `products`
183
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
183
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
184
184
  - Read: [PATTERN.md](patterns/connectors/paddle-catalogue/PATTERN.md)
185
185
  - Examples: [example/](patterns/connectors/paddle-catalogue/example/)
186
186
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -191,7 +191,7 @@ Resolve a publishable image key deliberately and use the shared URL library in a
191
191
 
192
192
  - Id: `connectors/public-image`
193
193
  - Keywords: `cli`, `connectors`, `files`, `images`, `integrations`, `logo-dev`, `public-key`
194
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
194
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
195
195
  - Read: [PATTERN.md](patterns/connectors/public-image/PATTERN.md)
196
196
  - Examples: [example/](patterns/connectors/public-image/example/)
197
197
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -202,7 +202,7 @@ Compose file configuration, Redshift Data API operations and application query o
202
202
 
203
203
  - Id: `connectors/redshift-queries`
204
204
  - Keywords: `aws`, `cli`, `connectors`, `files`, `iam`, `provisioned`, `redshift`, `serverless`, `sql`, `warehouse`
205
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
205
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
206
206
  - Read: [PATTERN.md](patterns/connectors/redshift-queries/PATTERN.md)
207
207
  - Examples: [example/](patterns/connectors/redshift-queries/example/)
208
208
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -213,7 +213,7 @@ Use the shared scanner runtime from a CLI or a host worker with portable configu
213
213
 
214
214
  - Id: `connectors/source-scanning`
215
215
  - Keywords: `cancellation`, `cli`, `connectors`, `integrations`, `scanning`, `security`, `source`, `wiz`, `worker`
216
- - Owner: `@jskit-ai/connectors-catalog@0.1.52`
216
+ - Owner: `@jskit-ai/connectors-catalog@0.1.53`
217
217
  - Read: [PATTERN.md](patterns/connectors/source-scanning/PATTERN.md)
218
218
  - Examples: [example/](patterns/connectors/source-scanning/example/)
219
219
  - Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
@@ -224,7 +224,7 @@ Add a protected administration surface, settings shell, and semantic navigation
224
224
 
225
225
  - Id: `console/console-surface`
226
226
  - Keywords: `admin`, `console`, `navigation`, `owner`, `placement`, `settings`, `surface`
227
- - Owner: `@jskit-ai/console-web@0.1.203`
227
+ - Owner: `@jskit-ai/console-web@0.1.204`
228
228
  - Read: [PATTERN.md](patterns/console/console-surface/PATTERN.md)
229
229
  - Examples: [example/](patterns/console/console-surface/example/)
230
230
  - Requires: `@jskit-ai/console-core`, `@jskit-ai/console-web`, `@jskit-ai/shell-web`
@@ -235,7 +235,7 @@ Build a routed CRUD user interface as thin application pages over JSKIT's shared
235
235
 
236
236
  - Id: `crud/crud-screen-set`
237
237
  - Keywords: `actions`, `add`, `crud`, `delete`, `edit`, `filters`, `list`, `material`, `routes`, `view`, `vue`
238
- - Owner: `@jskit-ai/http-web@0.1.80`
238
+ - Owner: `@jskit-ai/http-web@0.1.81`
239
239
  - Read: [PATTERN.md](patterns/crud/crud-screen-set/PATTERN.md)
240
240
  - Examples: [example/](patterns/crud/crud-screen-set/example/)
241
241
  - Requires: `@jskit-ai/http-web`, `@jskit-ai/resource-crud-core`
@@ -246,7 +246,7 @@ Build a complete application-owned CRUD server package from a migration, resourc
246
246
 
247
247
  - Id: `crud/json-api-resource-package`
248
248
  - Keywords: `actions`, `crud`, `database`, `json-api`, `migration`, `permissions`, `provider`, `repository`, `routes`, `service`
249
- - Owner: `@jskit-ai/crud-core@0.1.246`
249
+ - Owner: `@jskit-ai/crud-core@0.1.247`
250
250
  - Read: [PATTERN.md](patterns/crud/json-api-resource-package/PATTERN.md)
251
251
  - Examples: [example/](patterns/crud/json-api-resource-package/example/)
252
252
  - Requires: `@jskit-ai/crud-core`, `@jskit-ai/resource-crud-core`
@@ -257,7 +257,7 @@ Define an authenticated application resource whose records belong to the current
257
257
 
258
258
  - Id: `crud/resource-contract`
259
259
  - Keywords: `authenticated`, `crud`, `database`, `owner-scoped`, `resource`, `user`
260
- - Owner: `@jskit-ai/resource-crud-core@0.1.177`
260
+ - Owner: `@jskit-ai/resource-crud-core@0.1.178`
261
261
  - Read: [PATTERN.md](patterns/crud/resource-contract/PATTERN.md)
262
262
  - Examples: [example/](patterns/crud/resource-contract/example/)
263
263
  - Requires: `@jskit-ai/resource-crud-core`
@@ -268,7 +268,7 @@ Configure a JSKIT application for MySQL with a fixed driver, ordinary environmen
268
268
 
269
269
  - Id: `database/mysql-application`
270
270
  - Keywords: `database`, `knex`, `mariadb`, `migrations`, `mysql`, `mysql2`
271
- - Owner: `@jskit-ai/database-runtime-mysql@0.1.233`
271
+ - Owner: `@jskit-ai/database-runtime-mysql@0.1.234`
272
272
  - Read: [PATTERN.md](patterns/database/mysql-application/PATTERN.md)
273
273
  - Examples: [example/](patterns/database/mysql-application/example/)
274
274
  - Requires: `@jskit-ai/database-runtime-mysql`
@@ -279,7 +279,7 @@ Configure a JSKIT application for PostgreSQL with a fixed driver, ordinary envir
279
279
 
280
280
  - Id: `database/postgres-application`
281
281
  - Keywords: `database`, `knex`, `migrations`, `pg`, `postgres`, `postgresql`
282
- - Owner: `@jskit-ai/database-runtime-postgres@0.1.232`
282
+ - Owner: `@jskit-ai/database-runtime-postgres@0.1.233`
283
283
  - Read: [PATTERN.md](patterns/database/postgres-application/PATTERN.md)
284
284
  - Examples: [example/](patterns/database/postgres-application/example/)
285
285
  - Requires: `@jskit-ai/database-runtime-postgres`
@@ -290,7 +290,7 @@ Wrap a JSKIT web application in a Capacitor Android shell using native Capacitor
290
290
 
291
291
  - Id: `mobile/android-application`
292
292
  - Keywords: `android`, `capacitor`, `device`, `mobile`, `native`, `shell`, `webview`
293
- - Owner: `@jskit-ai/mobile-capacitor@0.1.170`
293
+ - Owner: `@jskit-ai/mobile-capacitor@0.1.171`
294
294
  - Read: [PATTERN.md](patterns/mobile/android-application/PATTERN.md)
295
295
  - Examples: [example/](patterns/mobile/android-application/example/)
296
296
  - Requires: `@capacitor/android`, `@capacitor/app`, `@capacitor/cli`, `@jskit-ai/mobile-capacitor`
@@ -301,7 +301,7 @@ Add JSKIT realtime events with an optional Redis backplane and an explicit shell
301
301
 
302
302
  - Id: `realtime/realtime-application`
303
303
  - Keywords: `realtime`, `redis`, `socket.io`, `sockets`, `status`, `websocket`
304
- - Owner: `@jskit-ai/realtime@0.1.232`
304
+ - Owner: `@jskit-ai/realtime@0.1.233`
305
305
  - Read: [PATTERN.md](patterns/realtime/realtime-application/PATTERN.md)
306
306
  - Examples: [example/](patterns/realtime/realtime-application/example/)
307
307
  - Requires: `@jskit-ai/realtime`, `@jskit-ai/shell-web`
@@ -312,7 +312,7 @@ Compose application-owned Google Publisher Tag delivery with the generic rewarde
312
312
 
313
313
  - Id: `rewards/google-rewarded`
314
314
  - Keywords: `ads`, `google`, `publisher tag`, `rewarded`, `unlock`
315
- - Owner: `@jskit-ai/rewarded-web@0.1.171`
315
+ - Owner: `@jskit-ai/rewarded-web@0.1.172`
316
316
  - Read: [PATTERN.md](patterns/rewards/google-rewarded/PATTERN.md)
317
317
  - Examples: [example/](patterns/rewards/google-rewarded/example/)
318
318
  - Requires: `@jskit-ai/rewarded-web`
@@ -323,7 +323,7 @@ Define a server feature through explicit capabilities and first-class actions, a
323
323
 
324
324
  - Id: `server/feature-package`
325
325
  - Keywords: `actions`, `feature`, `json-rest`, `knex`, `orchestration`, `package`, `provider`, `repository`, `routes`, `server`
326
- - Owner: `@jskit-ai/agent-docs@0.1.207`
326
+ - Owner: `@jskit-ai/agent-docs@0.1.208`
327
327
  - Read: [PATTERN.md](patterns/server/feature-package/PATTERN.md)
328
328
  - Examples: [example/](patterns/server/feature-package/example/)
329
329
  - Requires: `@jskit-ai/kernel`
@@ -334,7 +334,7 @@ Compose the JSKIT responsive shell, semantic placements, settings navigation, an
334
334
 
335
335
  - Id: `shell/application-shell`
336
336
  - Keywords: `adaptive`, `app`, `layout`, `navigation`, `placement`, `responsive`, `settings`, `shell`
337
- - Owner: `@jskit-ai/shell-web@0.1.239`
337
+ - Owner: `@jskit-ai/shell-web@0.1.240`
338
338
  - Read: [PATTERN.md](patterns/shell/application-shell/PATTERN.md)
339
339
  - Examples: [example/](patterns/shell/application-shell/example/)
340
340
  - Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
@@ -345,7 +345,7 @@ Add product routes and shell extensions through file routing, semantic placement
345
345
 
346
346
  - Id: `ui/page-and-placement`
347
347
  - Keywords: `component`, `navigation`, `outlet`, `page`, `placement`, `routes`, `section`, `shell`, `subpages`, `vue`
348
- - Owner: `@jskit-ai/shell-web@0.1.239`
348
+ - Owner: `@jskit-ai/shell-web@0.1.240`
349
349
  - Read: [PATTERN.md](patterns/ui/page-and-placement/PATTERN.md)
350
350
  - Examples: [example/](patterns/ui/page-and-placement/example/)
351
351
  - Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
@@ -356,7 +356,7 @@ Compose an account settings route and profile, preference, and notification sect
356
356
 
357
357
  - Id: `users/account-settings`
358
358
  - Keywords: `account`, `notifications`, `preferences`, `profile`, `settings`, `user`, `vue`
359
- - Owner: `@jskit-ai/users-web@0.1.253`
359
+ - Owner: `@jskit-ai/users-web@0.1.254`
360
360
  - Read: [PATTERN.md](patterns/users/account-settings/PATTERN.md)
361
361
  - Examples: [example/](patterns/users/account-settings/example/)
362
362
  - Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
@@ -367,7 +367,7 @@ Expose user administration and workspace-scoped member operations through app-ow
367
367
 
368
368
  - Id: `users/user-administration-server`
369
369
  - Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
370
- - Owner: `@jskit-ai/users-core@0.1.248`
370
+ - Owner: `@jskit-ai/users-core@0.1.249`
371
371
  - Read: [PATTERN.md](patterns/users/user-administration-server/PATTERN.md)
372
372
  - Examples: [example/](patterns/users/user-administration-server/example/)
373
373
  - Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
@@ -378,7 +378,7 @@ Configure roles, workspace access policy, invitations, and app-owned invitation
378
378
 
379
379
  - Id: `workspaces/workspace-server`
380
380
  - Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
381
- - Owner: `@jskit-ai/workspaces-core@0.1.213`
381
+ - Owner: `@jskit-ai/workspaces-core@0.1.214`
382
382
  - Read: [PATTERN.md](patterns/workspaces/workspace-server/PATTERN.md)
383
383
  - Examples: [example/](patterns/workspaces/workspace-server/example/)
384
384
  - Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
@@ -389,7 +389,7 @@ Compose workspace selection, invitation, member administration, settings, and re
389
389
 
390
390
  - Id: `workspaces/workspace-surfaces`
391
391
  - Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
392
- - Owner: `@jskit-ai/workspaces-web@0.1.214`
392
+ - Owner: `@jskit-ai/workspaces-web@0.1.215`
393
393
  - Read: [PATTERN.md](patterns/workspaces/workspace-surfaces/PATTERN.md)
394
394
  - Examples: [example/](patterns/workspaces/workspace-surfaces/example/)
395
395
  - Requires: `@jskit-ai/shell-web`, `@jskit-ai/workspaces-core`, `@jskit-ai/workspaces-web`
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "@local/main": "0.1.0",
36
36
  "@fastify/static": "^10.1.3",
37
- "@jskit-ai/kernel": "0.1.235",
37
+ "@jskit-ai/kernel": "0.1.236",
38
38
  "@tanstack/vue-query": "^5.101.0",
39
39
  "fastify": "^5.8.5",
40
40
  "json-rest-schema": "^1.0.17",
@@ -42,13 +42,13 @@
42
42
  "vue": "^3.5.43",
43
43
  "vue-router": "^5.3.1",
44
44
  "vuetify": "^4.1.2",
45
- "@jskit-ai/http-runtime": "0.1.233",
45
+ "@jskit-ai/http-runtime": "0.1.234",
46
46
  "@fastify/fast-json-stringify-compiler": "^5.1.0",
47
47
  "@vue/devtools-api": "^8.2.1"
48
48
  },
49
49
  "devDependencies": {
50
- "@jskit-ai/config-eslint": "0.1.232",
51
- "@jskit-ai/jskit-catalog": "0.1.260",
50
+ "@jskit-ai/config-eslint": "0.1.233",
51
+ "@jskit-ai/jskit-catalog": "0.1.261",
52
52
  "@playwright/test": "1.61.1",
53
53
  "@vitejs/plugin-vue": "^6.0.7",
54
54
  "eslint": "^10.8.0",
@@ -34,7 +34,7 @@
34
34
  "dependencies": {
35
35
  "@local/main": "0.1.0",
36
36
  "@fastify/static": "^10.1.3",
37
- "@jskit-ai/kernel": "0.1.235",
37
+ "@jskit-ai/kernel": "0.1.236",
38
38
  "@tanstack/vue-query": "^5.101.0",
39
39
  "fastify": "^5.8.5",
40
40
  "json-rest-schema": "^1.0.17",
@@ -42,15 +42,15 @@
42
42
  "vue": "^3.5.43",
43
43
  "vue-router": "^5.3.1",
44
44
  "vuetify": "^4.1.2",
45
- "@jskit-ai/http-runtime": "0.1.233",
45
+ "@jskit-ai/http-runtime": "0.1.234",
46
46
  "@mdi/js": "^7.4.47",
47
- "@jskit-ai/shell-web": "0.1.239",
47
+ "@jskit-ai/shell-web": "0.1.240",
48
48
  "@fastify/fast-json-stringify-compiler": "^5.1.0",
49
49
  "@vue/devtools-api": "^8.2.1"
50
50
  },
51
51
  "devDependencies": {
52
- "@jskit-ai/config-eslint": "0.1.232",
53
- "@jskit-ai/jskit-catalog": "0.1.260",
52
+ "@jskit-ai/config-eslint": "0.1.233",
53
+ "@jskit-ai/jskit-catalog": "0.1.261",
54
54
  "@playwright/test": "1.61.1",
55
55
  "@vitejs/plugin-vue": "^6.0.7",
56
56
  "eslint": "^10.8.0",
@@ -9,7 +9,7 @@
9
9
  },
10
10
  "description": "App-local runtime composition and lightweight glue.",
11
11
  "dependencies": {
12
- "@jskit-ai/kernel": "0.1.235"
12
+ "@jskit-ai/kernel": "0.1.236"
13
13
  },
14
14
  "jskit": {
15
15
  "kind": "runtime",
@@ -2,6 +2,6 @@
2
2
  "private": true,
3
3
  "type": "module",
4
4
  "dependencies": {
5
- "@jskit-ai/auth-provider-supabase-core": "0.1.232"
5
+ "@jskit-ai/auth-provider-supabase-core": "0.1.233"
6
6
  }
7
7
  }
@@ -7,10 +7,10 @@
7
7
  "db:migrate:status": "knex --knexfile ./knexfile.js migrate:list"
8
8
  },
9
9
  "dependencies": {
10
- "@jskit-ai/connectors-core": "0.1.52",
11
- "@jskit-ai/connector-google-calendar": "0.1.52",
12
- "@jskit-ai/database-runtime": "0.1.235",
13
- "@jskit-ai/database-runtime-mysql": "0.1.233",
10
+ "@jskit-ai/connectors-core": "0.1.53",
11
+ "@jskit-ai/connector-google-calendar": "0.1.53",
12
+ "@jskit-ai/database-runtime": "0.1.236",
13
+ "@jskit-ai/database-runtime-mysql": "0.1.234",
14
14
  "knex": "^3.1.0"
15
15
  }
16
16
  }
@@ -49,9 +49,42 @@ contracts, access policy, and HTTP routes.
49
49
  ## Example files
50
50
 
51
51
  `example/` contains a complete books package plus a source-controlled migration.
52
+ Paths below are relative to this pattern directory:
53
+
54
+ ```text
55
+ example/migrations/20260815000000_books.cjs
56
+ example/packages/books/package.json
57
+ example/packages/books/src/server/BooksFeature.js
58
+ example/packages/books/src/shared/bookResource.js
59
+ example/packages/books/src/shared/index.js
60
+ ```
61
+
62
+ The example's migration belongs to the application root (`example/migrations/`)
63
+ and is a `.cjs` file. The books package does not declare a migration directory.
64
+ For a package-owned migration instead, declare its actual directory in
65
+ `package.json#jskit.migrations.directories`, as described in the database-layer
66
+ guide.
67
+
52
68
  `BooksFeature.js` is deliberately tiny: it binds the readable resource contract
53
69
  to the framework module and exports the resulting provider.
54
70
 
71
+ ## List search is part of the initial composition
72
+
73
+ The shared `useCrudListScreen()` enables a query-backed Search box. Its server
74
+ mapping belongs in `bookResource.searchSchema.q`, as the example demonstrates.
75
+ When narrowing the resource, retain that mapping and update `oneOf` to the
76
+ fields that remain; a title-only resource searches `["title"]`. Do this before
77
+ the first list test, alongside the fields and validation.
78
+
79
+ Keep the query layers distinct: the page route and internal CRUD query use
80
+ `q`, while JSON:API HTTP requests use `filter[q]`. Shared CRUD clients handle
81
+ that transport automatically. A raw API test uses, for example,
82
+ `request.get("/api/books", { params: { "filter[q]": "Kindred" } })` with
83
+ JSON:API Accept headers and the application's actual API base/scope. Do not use
84
+ `/api/books?q=Kindred` to test the JSON:API search contract. Assert a matching
85
+ result, a nonmatching query returning no rows, and clearing the UI query;
86
+ an unfiltered collection can satisfy a matching-row-only assertion.
87
+
55
88
  ## Variation points
56
89
 
57
90
  Change the package name, resource fields, table, surface, ownership filter,
@@ -8,8 +8,8 @@
8
8
  "./shared": "./src/shared/index.js"
9
9
  },
10
10
  "dependencies": {
11
- "@jskit-ai/crud-core": "0.1.246",
12
- "@jskit-ai/resource-crud-core": "0.1.177"
11
+ "@jskit-ai/crud-core": "0.1.247",
12
+ "@jskit-ai/resource-crud-core": "0.1.178"
13
13
  },
14
14
  "jskit": {
15
15
  "kind": "runtime",
@@ -8,6 +8,6 @@
8
8
  "db:migrate:status": "knex --knexfile ./knexfile.js migrate:list"
9
9
  },
10
10
  "dependencies": {
11
- "@jskit-ai/database-runtime-mysql": "0.1.233"
11
+ "@jskit-ai/database-runtime-mysql": "0.1.234"
12
12
  }
13
13
  }
@@ -8,6 +8,6 @@
8
8
  "db:migrate:status": "knex --knexfile ./knexfile.js migrate:list"
9
9
  },
10
10
  "dependencies": {
11
- "@jskit-ai/database-runtime-postgres": "0.1.232"
11
+ "@jskit-ai/database-runtime-postgres": "0.1.233"
12
12
  }
13
13
  }
@@ -2,7 +2,7 @@
2
2
  "private": true,
3
3
  "type": "module",
4
4
  "dependencies": {
5
- "@jskit-ai/realtime": "0.1.232",
6
- "@jskit-ai/shell-web": "0.1.239"
5
+ "@jskit-ai/realtime": "0.1.233",
6
+ "@jskit-ai/shell-web": "0.1.240"
7
7
  }
8
8
  }
@@ -5,7 +5,7 @@
5
5
  "private": true,
6
6
  "type": "module",
7
7
  "dependencies": {
8
- "@jskit-ai/kernel": "0.1.235",
8
+ "@jskit-ai/kernel": "0.1.236",
9
9
  "json-rest-schema": "^1.0.17"
10
10
  },
11
11
  "exports": {