@jskit-ai/agent-docs 0.1.205 → 0.1.207
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-conversation.md +51 -2
- package/guide/agent/app-setup/multi-homing.md +29 -0
- package/guide/agent/framework/crud-operations.md +162 -0
- package/package.json +1 -1
- package/patterns/feature-package/example/booking-engine/package.json +1 -1
- package/patterns/minimal-foundation/example/package.json +4 -4
- package/patterns/shell-foundation/example/package.json +5 -5
- package/patterns/shell-foundation/example/packages/main/package.json +1 -1
- package/patterns/ui-testing.md +7 -0
- package/reference/autogen/PATTERN_INDEX.md +35 -35
- package/reference/autogen/packages/assistant-core.md +1 -1
- package/reference/autogen/packages/assistant-voice-sherpa.md +1 -1
- package/reference/autogen/packages/workspaces-core.md +3 -3
- package/reference/autogen/packages/workspaces-web.md +11 -0
- package/skills/jskit/SKILL.md +9 -0
- package/skills/jskit/references/crud-operations.md +162 -0
- package/skills/jskit/references/multi-homing.md +29 -0
- package/skills/jskit/references/pattern-index.md +35 -35
- package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +4 -4
- package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +5 -5
- package/skills/jskit/references/patterns/app/shell-foundation/example/packages/main/package.json +1 -1
- package/skills/jskit/references/patterns/auth/supabase-auth/example/package.json +1 -1
- package/skills/jskit/references/patterns/connectors/calendar-cli/example/package.json +4 -4
- package/skills/jskit/references/patterns/crud/crud-screen-set/PATTERN.md +30 -0
- package/skills/jskit/references/patterns/crud/crud-screen-set/example/books/BookEditPage.vue +1 -0
- package/skills/jskit/references/patterns/crud/crud-screen-set/example/books/BookNewPage.vue +1 -0
- package/skills/jskit/references/patterns/crud/json-api-resource-package/PATTERN.md +5 -0
- package/skills/jskit/references/patterns/crud/json-api-resource-package/example/packages/books/package.json +2 -2
- package/skills/jskit/references/patterns/database/mysql-application/example/package.json +1 -1
- package/skills/jskit/references/patterns/database/postgres-application/example/package.json +1 -1
- package/skills/jskit/references/patterns/realtime/realtime-application/example/package.json +2 -2
- package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/package.json +1 -1
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +2 -2
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +3 -3
- package/skills/jskit/references/patterns/workspaces/workspace-server/PATTERN.md +20 -0
- package/skills/jskit/references/patterns/workspaces/workspace-server/example/config/roles.js +2 -0
|
@@ -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.207`
|
|
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.207`
|
|
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.
|
|
40
|
+
- Owner: `@jskit-ai/assistant-runtime@0.1.206`
|
|
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.
|
|
51
|
+
- Owner: `@jskit-ai/auth-web@0.1.235`
|
|
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.
|
|
62
|
+
- Owner: `@jskit-ai/auth-provider-supabase-core@0.1.232`
|
|
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.
|
|
73
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
84
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
95
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
106
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
117
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
128
|
+
- Owner: `@jskit-ai/connector-google-calendar@0.1.52`
|
|
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.
|
|
139
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
150
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
161
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
172
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
183
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
194
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
205
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
216
|
+
- Owner: `@jskit-ai/connectors-catalog@0.1.52`
|
|
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.
|
|
227
|
+
- Owner: `@jskit-ai/console-web@0.1.203`
|
|
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.
|
|
238
|
+
- Owner: `@jskit-ai/http-web@0.1.80`
|
|
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.
|
|
249
|
+
- Owner: `@jskit-ai/crud-core@0.1.246`
|
|
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.
|
|
260
|
+
- Owner: `@jskit-ai/resource-crud-core@0.1.177`
|
|
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.
|
|
271
|
+
- Owner: `@jskit-ai/database-runtime-mysql@0.1.233`
|
|
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.
|
|
282
|
+
- Owner: `@jskit-ai/database-runtime-postgres@0.1.232`
|
|
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.
|
|
293
|
+
- Owner: `@jskit-ai/mobile-capacitor@0.1.170`
|
|
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.
|
|
304
|
+
- Owner: `@jskit-ai/realtime@0.1.232`
|
|
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.
|
|
315
|
+
- Owner: `@jskit-ai/rewarded-web@0.1.171`
|
|
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.
|
|
326
|
+
- Owner: `@jskit-ai/agent-docs@0.1.207`
|
|
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.
|
|
337
|
+
- Owner: `@jskit-ai/shell-web@0.1.239`
|
|
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.
|
|
348
|
+
- Owner: `@jskit-ai/shell-web@0.1.239`
|
|
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.
|
|
359
|
+
- Owner: `@jskit-ai/users-web@0.1.253`
|
|
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.
|
|
370
|
+
- Owner: `@jskit-ai/users-core@0.1.248`
|
|
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.
|
|
381
|
+
- Owner: `@jskit-ai/workspaces-core@0.1.213`
|
|
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.
|
|
392
|
+
- Owner: `@jskit-ai/workspaces-web@0.1.214`
|
|
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.
|
|
37
|
+
"@jskit-ai/kernel": "0.1.235",
|
|
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.
|
|
45
|
+
"@jskit-ai/http-runtime": "0.1.233",
|
|
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.
|
|
51
|
-
"@jskit-ai/jskit-catalog": "0.1.
|
|
50
|
+
"@jskit-ai/config-eslint": "0.1.232",
|
|
51
|
+
"@jskit-ai/jskit-catalog": "0.1.260",
|
|
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.
|
|
37
|
+
"@jskit-ai/kernel": "0.1.235",
|
|
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.
|
|
45
|
+
"@jskit-ai/http-runtime": "0.1.233",
|
|
46
46
|
"@mdi/js": "^7.4.47",
|
|
47
|
-
"@jskit-ai/shell-web": "0.1.
|
|
47
|
+
"@jskit-ai/shell-web": "0.1.239",
|
|
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.
|
|
53
|
-
"@jskit-ai/jskit-catalog": "0.1.
|
|
52
|
+
"@jskit-ai/config-eslint": "0.1.232",
|
|
53
|
+
"@jskit-ai/jskit-catalog": "0.1.260",
|
|
54
54
|
"@playwright/test": "1.61.1",
|
|
55
55
|
"@vitejs/plugin-vue": "^6.0.7",
|
|
56
56
|
"eslint": "^10.8.0",
|
|
@@ -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.
|
|
11
|
-
"@jskit-ai/connector-google-calendar": "0.1.
|
|
12
|
-
"@jskit-ai/database-runtime": "0.1.
|
|
13
|
-
"@jskit-ai/database-runtime-mysql": "0.1.
|
|
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",
|
|
14
14
|
"knex": "^3.1.0"
|
|
15
15
|
}
|
|
16
16
|
}
|
|
@@ -42,6 +42,13 @@ questionnaire.
|
|
|
42
42
|
- Resource-load errors stay inside the screen with retry. Command success and
|
|
43
43
|
failure use JSKIT's shared toast/snackbar feedback path.
|
|
44
44
|
- URLs are route templates or route objects resolved through the screen runtime.
|
|
45
|
+
- Browser URL templates include the configured surface prefix; unlike API
|
|
46
|
+
suffixes, `/new` and `/` are absolute browser paths. Use the complete route or
|
|
47
|
+
`paths.page()` for a link without record placeholders, and the owning CRUD
|
|
48
|
+
runtime's `resolveParams()` for record placeholders.
|
|
49
|
+
- `CrudListScreen` applies `createLabel` to all create actions. Its responsive
|
|
50
|
+
card and table layouts both remain in the DOM; Playwright text assertions
|
|
51
|
+
should filter to visible matches rather than match a hidden layout too.
|
|
45
52
|
- Product field components are ordinary application source.
|
|
46
53
|
- Query keys and placement sources describe the resource, not an authoring tool.
|
|
47
54
|
- No generated-file markers, overwrite contracts, receipts, or provenance remain.
|
|
@@ -63,6 +70,29 @@ filters and actions explicit without adding empty screen machinery elsewhere.
|
|
|
63
70
|
|
|
64
71
|
## Variation points
|
|
65
72
|
|
|
73
|
+
`useCrudAddEditScreen()` requires `addEditOptions.queryKeyFactory` even when
|
|
74
|
+
`readEnabled` is false. Include the resource, surface, route scope and record
|
|
75
|
+
id (or a distinct new-record marker) so form cache entries stay separate.
|
|
76
|
+
The New/Edit examples supply it; list/view screen wrappers derive their
|
|
77
|
+
standard keys from `resourceNamespace`.
|
|
78
|
+
|
|
79
|
+
Save navigation is configured in the top-level `saveSuccess` object. The default
|
|
80
|
+
prefers a configured record-view URL, then the list. A create-and-list variation
|
|
81
|
+
sets `navigateToView: false` and `listUrlTemplate` to its list route. Set both
|
|
82
|
+
`navigateToView` and `navigateToList` to `false` to stay on the form. A custom
|
|
83
|
+
`addEditOptions.onSaveSuccess` replaces default invalidation and navigation;
|
|
84
|
+
it is unnecessary for ordinary list navigation. The generic CRUD guide explains
|
|
85
|
+
this contract under **Save navigation**.
|
|
86
|
+
|
|
87
|
+
Ownership and permission-bootstrap mode are different options. For a public
|
|
88
|
+
resource on a public surface, use `ownershipFilter: "public"` in form options
|
|
89
|
+
or lower-level request composables. List/view screen wrappers derive request
|
|
90
|
+
scope from the configured surface and do not expose this option. Keep the
|
|
91
|
+
default `access: "auto"` when there are no permission
|
|
92
|
+
requirements. `access` accepts only `auto`, `always`, or `never`; `public` is
|
|
93
|
+
not an access mode. `always` requires bootstrap permissions even when there
|
|
94
|
+
are no permission requirements. Do not add accounts to satisfy that override.
|
|
95
|
+
|
|
66
96
|
Change routes, labels, visible fields, field components, filters, query params,
|
|
67
97
|
realtime events, delete availability, and action definitions. Use the screen
|
|
68
98
|
slots for domain-specific content. Use a lower-level request composable only
|
package/skills/jskit/references/patterns/crud/crud-screen-set/example/books/BookEditPage.vue
CHANGED
|
@@ -21,6 +21,7 @@ const screen = useCrudAddEditScreen({
|
|
|
21
21
|
addEditOptions: {
|
|
22
22
|
apiUrlTemplate: "/books/:bookId",
|
|
23
23
|
placementSource: "crud.books.edit",
|
|
24
|
+
queryKeyFactory: (surfaceId = "", scope = "") => ["crud", "books", surfaceId, scope, routeRecordId.value],
|
|
24
25
|
writeMethod: "PATCH",
|
|
25
26
|
requestRecoveryLabel: "Book",
|
|
26
27
|
fallbackLoadError: "Unable to load this book.",
|
|
@@ -15,6 +15,7 @@ const screen = useCrudAddEditScreen({
|
|
|
15
15
|
addEditOptions: {
|
|
16
16
|
apiSuffix: "/books",
|
|
17
17
|
placementSource: "crud.books.new",
|
|
18
|
+
queryKeyFactory: (surfaceId = "", scope = "") => ["crud", "books", surfaceId, scope, "new"],
|
|
18
19
|
readEnabled: false,
|
|
19
20
|
writeMethod: "POST",
|
|
20
21
|
recordIdParam: "bookId",
|
|
@@ -145,6 +145,11 @@ const BookingsFeature = defineCrudJsonApiFeature({
|
|
|
145
145
|
when both drivers are supported by the application.
|
|
146
146
|
- Validate representative accepted and rejected resource values.
|
|
147
147
|
- Exercise every enabled route and JSON API document shape.
|
|
148
|
+
- Direct HTTP tests send `Content-Type` and `Accept` as
|
|
149
|
+
`application/vnd.api+json`, with `data.type` and `data.attributes`; raw
|
|
150
|
+
response fields remain in `data.attributes`. Use the configured API route,
|
|
151
|
+
transport type and existing identity/CSRF fixture. The generic CRUD guide's
|
|
152
|
+
**Direct API tests use JSON:API documents** section has a complete example.
|
|
148
153
|
- Prove positive owner access and negative cross-owner access.
|
|
149
154
|
- Verify public routes require neither identity nor CSRF only when explicitly
|
|
150
155
|
declared public.
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
"./shared": "./src/shared/index.js"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@jskit-ai/crud-core": "0.1.
|
|
12
|
-
"@jskit-ai/resource-crud-core": "0.1.
|
|
11
|
+
"@jskit-ai/crud-core": "0.1.246",
|
|
12
|
+
"@jskit-ai/resource-crud-core": "0.1.177"
|
|
13
13
|
},
|
|
14
14
|
"jskit": {
|
|
15
15
|
"kind": "runtime",
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
"./shared": "./src/shared/index.js"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@jskit-ai/crud-core": "0.1.
|
|
13
|
-
"@jskit-ai/resource-crud-core": "0.1.
|
|
12
|
+
"@jskit-ai/crud-core": "0.1.246",
|
|
13
|
+
"@jskit-ai/resource-crud-core": "0.1.177"
|
|
14
14
|
},
|
|
15
15
|
"jskit": {
|
|
16
16
|
"kind": "runtime",
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
"./shared": "./src/shared/index.js"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@jskit-ai/crud-core": "0.1.
|
|
13
|
-
"@jskit-ai/resource-crud-core": "0.1.
|
|
14
|
-
"@jskit-ai/workspaces-core": "0.1.
|
|
12
|
+
"@jskit-ai/crud-core": "0.1.246",
|
|
13
|
+
"@jskit-ai/resource-crud-core": "0.1.177",
|
|
14
|
+
"@jskit-ai/workspaces-core": "0.1.213"
|
|
15
15
|
},
|
|
16
16
|
"jskit": {
|
|
17
17
|
"kind": "runtime",
|
|
@@ -28,6 +28,26 @@ member permissions, personal-workspace behavior, and surface access rules.
|
|
|
28
28
|
Use workspace routes, resources, scope helpers, tenancy profiles, and settings
|
|
29
29
|
contracts exported by `@jskit-ai/workspaces-core`.
|
|
30
30
|
|
|
31
|
+
## Role display labels
|
|
32
|
+
|
|
33
|
+
Each `roleCatalog.roles[roleId]` definition may include an optional string
|
|
34
|
+
`label`. JSKIT trims it and preserves nonempty labels in role descriptors,
|
|
35
|
+
catalogue clones and Members/Workspace Settings responses. Labels are display
|
|
36
|
+
metadata; they do not inherit from a parent role. Missing, blank or non-string
|
|
37
|
+
labels keep the existing role-title fallback.
|
|
38
|
+
|
|
39
|
+
Shared Members invitation and member-role selectors show the label but submit
|
|
40
|
+
the role id. Pending invitation captions, workspace role captions and the
|
|
41
|
+
default invitation email use the same configured labels. Pending invitation
|
|
42
|
+
responses expose optional `roleLabel` alongside the unchanged `roleSid`.
|
|
43
|
+
Applications with their own invitation renderer may use its optional
|
|
44
|
+
`roleLabel` input; `roleSid` remains the stored role id.
|
|
45
|
+
|
|
46
|
+
Keep existing permissions, inheritance, assignability and
|
|
47
|
+
`workspace.defaultInviteRole` when adding a label. `owner` remains
|
|
48
|
+
nonassignable. Custom roles, including specialised Training roles, are ordinary
|
|
49
|
+
catalogue entries. Updating labels requires no database migration.
|
|
50
|
+
|
|
31
51
|
## Transactional invitation participation
|
|
32
52
|
|
|
33
53
|
Through `workspaces.core`, register one callback during feature setup with
|
package/skills/jskit/references/patterns/workspaces/workspace-server/example/config/roles.js
CHANGED
|
@@ -8,6 +8,7 @@ export const roleCatalog = {
|
|
|
8
8
|
permissions: ["*"]
|
|
9
9
|
},
|
|
10
10
|
admin: {
|
|
11
|
+
label: "Administrator",
|
|
11
12
|
assignable: true,
|
|
12
13
|
inherits: "member",
|
|
13
14
|
permissions: [
|
|
@@ -20,6 +21,7 @@ export const roleCatalog = {
|
|
|
20
21
|
]
|
|
21
22
|
},
|
|
22
23
|
member: {
|
|
24
|
+
label: "Team member",
|
|
23
25
|
assignable: true,
|
|
24
26
|
permissions: ["workspace.settings.view"]
|
|
25
27
|
}
|