@jskit-ai/agent-docs 0.1.265 → 0.1.267
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 +18 -4
- package/guide/agent/app-setup/authentication.md +8 -0
- package/guide/agent/app-setup/multi-homing.md +5 -3
- package/guide/agent/framework/translation.md +56 -10
- package/guide/agent/framework/ui-operations.md +11 -12
- 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/reference/autogen/PATTERN_INDEX.md +37 -37
- package/reference/autogen/packages/assistant-core.md +5 -3
- package/reference/autogen/packages/auth-core.md +4 -1
- package/reference/autogen/packages/oidc-issuer-core.md +23 -4
- package/reference/autogen/packages/resource-crud-core.md +2 -1
- package/reference/autogen/packages/users-web.md +26 -0
- package/reference/autogen/packages/workspaces-core.md +2 -1
- package/reference/autogen/tooling/config-eslint.md +8 -0
- package/skills/jskit/references/multi-homing.md +5 -3
- package/skills/jskit/references/pattern-index.md +37 -37
- 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/accounts-hub/example/package.json +2 -2
- package/skills/jskit/references/patterns/auth/oidc-sign-in/example/package.json +2 -2
- 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/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/translation.md +56 -10
- package/skills/jskit/references/ui-operations.md +11 -12
|
@@ -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.267`
|
|
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.267`
|
|
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.2.
|
|
40
|
+
- Owner: `@jskit-ai/assistant-runtime@0.2.17`
|
|
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 @@ Run one OpenID Connect sign-in for all of an owner's apps as its own JSKIT proje
|
|
|
48
48
|
|
|
49
49
|
- Id: `auth/accounts-hub`
|
|
50
50
|
- Keywords: `accounts hub`, `auth`, `authentication`, `issuer`, `master login`, `oidc`, `openid connect`, `single sign-on`, `sso`
|
|
51
|
-
- Owner: `@jskit-ai/oidc-issuer-core@0.1.
|
|
51
|
+
- Owner: `@jskit-ai/oidc-issuer-core@0.1.13`
|
|
52
52
|
- Read: [PATTERN.md](patterns/auth/accounts-hub/PATTERN.md)
|
|
53
53
|
- Examples: [example/](patterns/auth/accounts-hub/example/)
|
|
54
54
|
- Requires: `@jskit-ai/oidc-issuer-core`
|
|
@@ -59,7 +59,7 @@ Compose JSKIT authentication routes, views, profile controls, and public surface
|
|
|
59
59
|
|
|
60
60
|
- Id: `auth/auth-surface`
|
|
61
61
|
- Keywords: `account`, `auth`, `login`, `logout`, `password`, `placement`, `profile`, `reset`, `surface`
|
|
62
|
-
- Owner: `@jskit-ai/auth-web@0.2.
|
|
62
|
+
- Owner: `@jskit-ai/auth-web@0.2.9`
|
|
63
63
|
- Read: [PATTERN.md](patterns/auth/auth-surface/PATTERN.md)
|
|
64
64
|
- Examples: [example/](patterns/auth/auth-surface/example/)
|
|
65
65
|
- Requires: `@jskit-ai/auth-core`, `@jskit-ai/auth-web`, `@jskit-ai/shell-web`
|
|
@@ -70,7 +70,7 @@ Let people sign in with the accounts they already have in an accounts hub or ano
|
|
|
70
70
|
|
|
71
71
|
- Id: `auth/oidc-sign-in`
|
|
72
72
|
- Keywords: `accounts hub`, `auth`, `authentication`, `back-channel logout`, `dynamic client registration`, `issuer`, `master login`, `oidc`, `openid connect`, `single sign-on`, `sso`
|
|
73
|
-
- Owner: `@jskit-ai/auth-provider-oidc-core@0.2.
|
|
73
|
+
- Owner: `@jskit-ai/auth-provider-oidc-core@0.2.11`
|
|
74
74
|
- Read: [PATTERN.md](patterns/auth/oidc-sign-in/PATTERN.md)
|
|
75
75
|
- Examples: [example/](patterns/auth/oidc-sign-in/example/)
|
|
76
76
|
- Requires: `@jskit-ai/auth-provider-oidc-core`, `@jskit-ai/auth-web`
|
|
@@ -81,7 +81,7 @@ Add Supabase authentication through normal npm composition, explicit environment
|
|
|
81
81
|
|
|
82
82
|
- Id: `auth/supabase-auth`
|
|
83
83
|
- Keywords: `auth`, `authentication`, `oauth`, `sessions`, `supabase`
|
|
84
|
-
- Owner: `@jskit-ai/auth-provider-supabase-core@0.2.
|
|
84
|
+
- Owner: `@jskit-ai/auth-provider-supabase-core@0.2.8`
|
|
85
85
|
- Read: [PATTERN.md](patterns/auth/supabase-auth/PATTERN.md)
|
|
86
86
|
- Examples: [example/](patterns/auth/supabase-auth/example/)
|
|
87
87
|
- Requires: `@jskit-ai/auth-provider-supabase-core`
|
|
@@ -92,7 +92,7 @@ Resolve an administrator environment key or an individual user's grant, then use
|
|
|
92
92
|
|
|
93
93
|
- Id: `connectors/ai-connections`
|
|
94
94
|
- Keywords: `ai`, `api-key`, `cli`, `environment`, `free`, `models`, `ownership`, `zai`, `zen`
|
|
95
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
95
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
96
96
|
- Read: [PATTERN.md](patterns/connectors/ai-connections/PATTERN.md)
|
|
97
97
|
- Examples: [example/](patterns/connectors/ai-connections/example/)
|
|
98
98
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -103,7 +103,7 @@ Compose provider operations, authorization and encrypted file storage from a CLI
|
|
|
103
103
|
|
|
104
104
|
- Id: `connectors/api-key-connection`
|
|
105
105
|
- Keywords: `api-key`, `clay`, `cli`, `clickhouse`, `connectors`, `dbt`, `files`, `firecrawl`, `granola`, `integrations`, `metrics`, `prestashop`, `resend`, `semantic-layer`, `semrush`, `x-twitter`
|
|
106
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
106
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
107
107
|
- Read: [PATTERN.md](patterns/connectors/api-key-connection/PATTERN.md)
|
|
108
108
|
- Examples: [example/](patterns/connectors/api-key-connection/example/)
|
|
109
109
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -114,7 +114,7 @@ Compose token-based MCP discovery and explicitly authorized tool calls using the
|
|
|
114
114
|
|
|
115
115
|
- Id: `connectors/assistant-mcp`
|
|
116
116
|
- Keywords: `assistant`, `cli`, `connectors`, `files`, `integrations`, `mcp`, `n8n`, `sanity`
|
|
117
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
117
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
118
118
|
- Read: [PATTERN.md](patterns/connectors/assistant-mcp/PATTERN.md)
|
|
119
119
|
- Examples: [example/](patterns/connectors/assistant-mcp/example/)
|
|
120
120
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -125,7 +125,7 @@ Configure assistant OAuth clients, then compose existing state, encrypted file g
|
|
|
125
125
|
|
|
126
126
|
- Id: `connectors/assistant-mcp-oauth`
|
|
127
127
|
- Keywords: `amplitude`, `assistant`, `atlassian`, `canva`, `cli`, `client metadata`, `confidence`, `connectors`, `figma`, `files`, `granola`, `hex`, `mcp`, `miro`, `oauth`
|
|
128
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
128
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
129
129
|
- Read: [PATTERN.md](patterns/connectors/assistant-mcp-oauth/PATTERN.md)
|
|
130
130
|
- Examples: [example/](patterns/connectors/assistant-mcp-oauth/example/)
|
|
131
131
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -136,7 +136,7 @@ Compose signed AWS operations, file configuration and application authorization
|
|
|
136
136
|
|
|
137
137
|
- Id: `connectors/aws-storage-queries`
|
|
138
138
|
- Keywords: `athena`, `aws`, `cli`, `connectors`, `files`, `iam`, `queries`, `s3`, `storage`, `sts`
|
|
139
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
139
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
140
140
|
- Read: [PATTERN.md](patterns/connectors/aws-storage-queries/PATTERN.md)
|
|
141
141
|
- Examples: [example/](patterns/connectors/aws-storage-queries/example/)
|
|
142
142
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -147,7 +147,7 @@ Compose reusable connection libraries with portable configuration, application o
|
|
|
147
147
|
|
|
148
148
|
- Id: `connectors/calendar-cli`
|
|
149
149
|
- Keywords: `calendar`, `cli`, `connectors`, `google`, `integrations`, `oauth`, `permissions`
|
|
150
|
-
- Owner: `@jskit-ai/connector-google-calendar@0.2.
|
|
150
|
+
- Owner: `@jskit-ai/connector-google-calendar@0.2.7`
|
|
151
151
|
- Read: [PATTERN.md](patterns/connectors/calendar-cli/PATTERN.md)
|
|
152
152
|
- Examples: [example/](patterns/connectors/calendar-cli/example/)
|
|
153
153
|
- Requires: `@jskit-ai/connector-google-calendar`, `@jskit-ai/connectors-core`, `@jskit-ai/database-runtime-mysql`
|
|
@@ -158,7 +158,7 @@ Compose the shared connector runtime for event delivery while leaving workflow c
|
|
|
158
158
|
|
|
159
159
|
- Id: `connectors/event-delivery`
|
|
160
160
|
- Keywords: `cli`, `connectors`, `events`, `files`, `inngest`, `integrations`, `workflows`
|
|
161
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
161
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
162
162
|
- Read: [PATTERN.md](patterns/connectors/event-delivery/PATTERN.md)
|
|
163
163
|
- Examples: [example/](patterns/connectors/event-delivery/example/)
|
|
164
164
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -169,7 +169,7 @@ Wire service-account grants, file storage, explicit message actions and public b
|
|
|
169
169
|
|
|
170
170
|
- Id: `connectors/firebase-messaging`
|
|
171
171
|
- Keywords: `cli`, `connectors`, `fcm`, `files`, `firebase`, `integrations`, `jwt`, `notifications`, `push`, `service-account`, `vapid`
|
|
172
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
172
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
173
173
|
- Read: [PATTERN.md](patterns/connectors/firebase-messaging/PATTERN.md)
|
|
174
174
|
- Examples: [example/](patterns/connectors/firebase-messaging/example/)
|
|
175
175
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -180,7 +180,7 @@ Compose reviewed Search campaigns with project-owned Google OAuth and portable s
|
|
|
180
180
|
|
|
181
181
|
- Id: `connectors/google-ads-search`
|
|
182
182
|
- Keywords: `ads`, `campaigns`, `cli`, `connectors`, `conversion`, `google`, `search`
|
|
183
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
183
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
184
184
|
- Read: [PATTERN.md](patterns/connectors/google-ads-search/PATTERN.md)
|
|
185
185
|
- Examples: [example/](patterns/connectors/google-ads-search/example/)
|
|
186
186
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -191,7 +191,7 @@ Compose provider consent, verification and encrypted file persistence from an ap
|
|
|
191
191
|
|
|
192
192
|
- Id: `connectors/oauth-connection`
|
|
193
193
|
- 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`
|
|
194
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
194
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
195
195
|
- Read: [PATTERN.md](patterns/connectors/oauth-connection/PATTERN.md)
|
|
196
196
|
- Examples: [example/](patterns/connectors/oauth-connection/example/)
|
|
197
197
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -202,7 +202,7 @@ Compose a sequential catalogue batch and preserve partial success for applicatio
|
|
|
202
202
|
|
|
203
203
|
- Id: `connectors/paddle-catalogue`
|
|
204
204
|
- Keywords: `batch`, `paddle`, `payments`, `prices`, `products`
|
|
205
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
205
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
206
206
|
- Read: [PATTERN.md](patterns/connectors/paddle-catalogue/PATTERN.md)
|
|
207
207
|
- Examples: [example/](patterns/connectors/paddle-catalogue/example/)
|
|
208
208
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -213,7 +213,7 @@ Resolve a publishable image key deliberately and use the shared URL library in a
|
|
|
213
213
|
|
|
214
214
|
- Id: `connectors/public-image`
|
|
215
215
|
- Keywords: `cli`, `connectors`, `files`, `images`, `integrations`, `logo-dev`, `public-key`
|
|
216
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
216
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
217
217
|
- Read: [PATTERN.md](patterns/connectors/public-image/PATTERN.md)
|
|
218
218
|
- Examples: [example/](patterns/connectors/public-image/example/)
|
|
219
219
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -224,7 +224,7 @@ Compose file configuration, Redshift Data API operations and application query o
|
|
|
224
224
|
|
|
225
225
|
- Id: `connectors/redshift-queries`
|
|
226
226
|
- Keywords: `aws`, `cli`, `connectors`, `files`, `iam`, `provisioned`, `redshift`, `serverless`, `sql`, `warehouse`
|
|
227
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
227
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
228
228
|
- Read: [PATTERN.md](patterns/connectors/redshift-queries/PATTERN.md)
|
|
229
229
|
- Examples: [example/](patterns/connectors/redshift-queries/example/)
|
|
230
230
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -235,7 +235,7 @@ Use the shared scanner runtime from a CLI or a host worker with portable configu
|
|
|
235
235
|
|
|
236
236
|
- Id: `connectors/source-scanning`
|
|
237
237
|
- Keywords: `cancellation`, `cli`, `connectors`, `integrations`, `scanning`, `security`, `source`, `wiz`, `worker`
|
|
238
|
-
- Owner: `@jskit-ai/connectors-catalog@0.2.
|
|
238
|
+
- Owner: `@jskit-ai/connectors-catalog@0.2.7`
|
|
239
239
|
- Read: [PATTERN.md](patterns/connectors/source-scanning/PATTERN.md)
|
|
240
240
|
- Examples: [example/](patterns/connectors/source-scanning/example/)
|
|
241
241
|
- Requires: `@jskit-ai/connectors-catalog`, `@jskit-ai/connectors-core`
|
|
@@ -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.230`
|
|
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`
|
|
@@ -257,7 +257,7 @@ Build a routed CRUD user interface as thin application pages over JSKIT's shared
|
|
|
257
257
|
|
|
258
258
|
- Id: `crud/crud-screen-set`
|
|
259
259
|
- Keywords: `actions`, `add`, `crud`, `delete`, `edit`, `filters`, `list`, `material`, `routes`, `view`, `vue`
|
|
260
|
-
- Owner: `@jskit-ai/http-web@0.2.
|
|
260
|
+
- Owner: `@jskit-ai/http-web@0.2.12`
|
|
261
261
|
- Read: [PATTERN.md](patterns/crud/crud-screen-set/PATTERN.md)
|
|
262
262
|
- Examples: [example/](patterns/crud/crud-screen-set/example/)
|
|
263
263
|
- Requires: `@jskit-ai/http-web`, `@jskit-ai/resource-crud-core`
|
|
@@ -268,7 +268,7 @@ Build a complete application-owned CRUD server package from a migration, resourc
|
|
|
268
268
|
|
|
269
269
|
- Id: `crud/json-api-resource-package`
|
|
270
270
|
- Keywords: `actions`, `crud`, `database`, `json-api`, `migration`, `permissions`, `provider`, `repository`, `routes`, `service`
|
|
271
|
-
- Owner: `@jskit-ai/crud-core@0.2.
|
|
271
|
+
- Owner: `@jskit-ai/crud-core@0.2.6`
|
|
272
272
|
- Read: [PATTERN.md](patterns/crud/json-api-resource-package/PATTERN.md)
|
|
273
273
|
- Examples: [example/](patterns/crud/json-api-resource-package/example/)
|
|
274
274
|
- Requires: `@jskit-ai/crud-core`, `@jskit-ai/resource-crud-core`
|
|
@@ -279,7 +279,7 @@ Define an authenticated application resource whose records belong to the current
|
|
|
279
279
|
|
|
280
280
|
- Id: `crud/resource-contract`
|
|
281
281
|
- Keywords: `authenticated`, `crud`, `database`, `owner-scoped`, `resource`, `user`
|
|
282
|
-
- Owner: `@jskit-ai/resource-crud-core@0.1.
|
|
282
|
+
- Owner: `@jskit-ai/resource-crud-core@0.1.197`
|
|
283
283
|
- Read: [PATTERN.md](patterns/crud/resource-contract/PATTERN.md)
|
|
284
284
|
- Examples: [example/](patterns/crud/resource-contract/example/)
|
|
285
285
|
- Requires: `@jskit-ai/resource-crud-core`
|
|
@@ -290,7 +290,7 @@ Configure a JSKIT application for MySQL with a fixed driver, ordinary environmen
|
|
|
290
290
|
|
|
291
291
|
- Id: `database/mysql-application`
|
|
292
292
|
- Keywords: `database`, `knex`, `mariadb`, `migrations`, `mysql`, `mysql2`
|
|
293
|
-
- Owner: `@jskit-ai/database-runtime-mysql@0.1.
|
|
293
|
+
- Owner: `@jskit-ai/database-runtime-mysql@0.1.253`
|
|
294
294
|
- Read: [PATTERN.md](patterns/database/mysql-application/PATTERN.md)
|
|
295
295
|
- Examples: [example/](patterns/database/mysql-application/example/)
|
|
296
296
|
- Requires: `@jskit-ai/database-runtime-mysql`
|
|
@@ -301,7 +301,7 @@ Configure a JSKIT application for PostgreSQL with a fixed driver, ordinary envir
|
|
|
301
301
|
|
|
302
302
|
- Id: `database/postgres-application`
|
|
303
303
|
- Keywords: `database`, `knex`, `migrations`, `pg`, `postgres`, `postgresql`
|
|
304
|
-
- Owner: `@jskit-ai/database-runtime-postgres@0.1.
|
|
304
|
+
- Owner: `@jskit-ai/database-runtime-postgres@0.1.252`
|
|
305
305
|
- Read: [PATTERN.md](patterns/database/postgres-application/PATTERN.md)
|
|
306
306
|
- Examples: [example/](patterns/database/postgres-application/example/)
|
|
307
307
|
- Requires: `@jskit-ai/database-runtime-postgres`
|
|
@@ -312,7 +312,7 @@ Wrap a JSKIT web application in a Capacitor Android shell using native Capacitor
|
|
|
312
312
|
|
|
313
313
|
- Id: `mobile/android-application`
|
|
314
314
|
- Keywords: `android`, `capacitor`, `device`, `mobile`, `native`, `shell`, `webview`
|
|
315
|
-
- Owner: `@jskit-ai/mobile-capacitor@0.2.
|
|
315
|
+
- Owner: `@jskit-ai/mobile-capacitor@0.2.7`
|
|
316
316
|
- Read: [PATTERN.md](patterns/mobile/android-application/PATTERN.md)
|
|
317
317
|
- Examples: [example/](patterns/mobile/android-application/example/)
|
|
318
318
|
- Requires: `@capacitor/android`, `@capacitor/app`, `@capacitor/cli`, `@jskit-ai/mobile-capacitor`
|
|
@@ -323,7 +323,7 @@ Add JSKIT realtime events with an optional Redis backplane and an explicit shell
|
|
|
323
323
|
|
|
324
324
|
- Id: `realtime/realtime-application`
|
|
325
325
|
- Keywords: `realtime`, `redis`, `socket.io`, `sockets`, `status`, `websocket`
|
|
326
|
-
- Owner: `@jskit-ai/realtime@0.2.
|
|
326
|
+
- Owner: `@jskit-ai/realtime@0.2.10`
|
|
327
327
|
- Read: [PATTERN.md](patterns/realtime/realtime-application/PATTERN.md)
|
|
328
328
|
- Examples: [example/](patterns/realtime/realtime-application/example/)
|
|
329
329
|
- Requires: `@jskit-ai/realtime`, `@jskit-ai/shell-web`
|
|
@@ -334,7 +334,7 @@ Compose application-owned Google Publisher Tag delivery with the generic rewarde
|
|
|
334
334
|
|
|
335
335
|
- Id: `rewards/google-rewarded`
|
|
336
336
|
- Keywords: `ads`, `google`, `publisher tag`, `rewarded`, `unlock`
|
|
337
|
-
- Owner: `@jskit-ai/rewarded-web@0.2.
|
|
337
|
+
- Owner: `@jskit-ai/rewarded-web@0.2.8`
|
|
338
338
|
- Read: [PATTERN.md](patterns/rewards/google-rewarded/PATTERN.md)
|
|
339
339
|
- Examples: [example/](patterns/rewards/google-rewarded/example/)
|
|
340
340
|
- Requires: `@jskit-ai/rewarded-web`
|
|
@@ -345,7 +345,7 @@ Define a server feature through explicit capabilities and first-class actions, a
|
|
|
345
345
|
|
|
346
346
|
- Id: `server/feature-package`
|
|
347
347
|
- Keywords: `actions`, `feature`, `json-rest`, `knex`, `orchestration`, `package`, `provider`, `repository`, `routes`, `server`
|
|
348
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
348
|
+
- Owner: `@jskit-ai/agent-docs@0.1.267`
|
|
349
349
|
- Read: [PATTERN.md](patterns/server/feature-package/PATTERN.md)
|
|
350
350
|
- Examples: [example/](patterns/server/feature-package/example/)
|
|
351
351
|
- Requires: `@jskit-ai/kernel`
|
|
@@ -356,7 +356,7 @@ Compose the JSKIT responsive shell, semantic placements, settings navigation, an
|
|
|
356
356
|
|
|
357
357
|
- Id: `shell/application-shell`
|
|
358
358
|
- Keywords: `adaptive`, `app`, `layout`, `navigation`, `placement`, `responsive`, `settings`, `shell`
|
|
359
|
-
- Owner: `@jskit-ai/shell-web@0.2.
|
|
359
|
+
- Owner: `@jskit-ai/shell-web@0.2.7`
|
|
360
360
|
- Read: [PATTERN.md](patterns/shell/application-shell/PATTERN.md)
|
|
361
361
|
- Examples: [example/](patterns/shell/application-shell/example/)
|
|
362
362
|
- Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -367,7 +367,7 @@ Add product routes and shell extensions through file routing, semantic placement
|
|
|
367
367
|
|
|
368
368
|
- Id: `ui/page-and-placement`
|
|
369
369
|
- Keywords: `component`, `navigation`, `outlet`, `page`, `placement`, `routes`, `section`, `shell`, `subpages`, `vue`
|
|
370
|
-
- Owner: `@jskit-ai/shell-web@0.2.
|
|
370
|
+
- Owner: `@jskit-ai/shell-web@0.2.7`
|
|
371
371
|
- Read: [PATTERN.md](patterns/ui/page-and-placement/PATTERN.md)
|
|
372
372
|
- Examples: [example/](patterns/ui/page-and-placement/example/)
|
|
373
373
|
- Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -378,7 +378,7 @@ Compose an account settings route and profile, preference, notification, and sig
|
|
|
378
378
|
|
|
379
379
|
- Id: `users/account-settings`
|
|
380
380
|
- Keywords: `account`, `link provider`, `notifications`, `oauth`, `preferences`, `profile`, `settings`, `sign-in methods`, `user`, `vue`
|
|
381
|
-
- Owner: `@jskit-ai/users-web@0.2.
|
|
381
|
+
- Owner: `@jskit-ai/users-web@0.2.13`
|
|
382
382
|
- Read: [PATTERN.md](patterns/users/account-settings/PATTERN.md)
|
|
383
383
|
- Examples: [example/](patterns/users/account-settings/example/)
|
|
384
384
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
|
|
@@ -389,7 +389,7 @@ Expose user administration and workspace-scoped member operations through app-ow
|
|
|
389
389
|
|
|
390
390
|
- Id: `users/user-administration-server`
|
|
391
391
|
- Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
|
|
392
|
-
- Owner: `@jskit-ai/users-core@0.2.
|
|
392
|
+
- Owner: `@jskit-ai/users-core@0.2.7`
|
|
393
393
|
- Read: [PATTERN.md](patterns/users/user-administration-server/PATTERN.md)
|
|
394
394
|
- Examples: [example/](patterns/users/user-administration-server/example/)
|
|
395
395
|
- Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
|
|
@@ -400,7 +400,7 @@ Configure roles, workspace access policy, invitations, and app-owned invitation
|
|
|
400
400
|
|
|
401
401
|
- Id: `workspaces/workspace-server`
|
|
402
402
|
- Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
|
|
403
|
-
- Owner: `@jskit-ai/workspaces-core@0.2.
|
|
403
|
+
- Owner: `@jskit-ai/workspaces-core@0.2.7`
|
|
404
404
|
- Read: [PATTERN.md](patterns/workspaces/workspace-server/PATTERN.md)
|
|
405
405
|
- Examples: [example/](patterns/workspaces/workspace-server/example/)
|
|
406
406
|
- Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
|
|
@@ -411,7 +411,7 @@ Compose workspace selection, invitation, member administration, settings, and re
|
|
|
411
411
|
|
|
412
412
|
- Id: `workspaces/workspace-surfaces`
|
|
413
413
|
- Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
|
|
414
|
-
- Owner: `@jskit-ai/workspaces-web@0.2.
|
|
414
|
+
- Owner: `@jskit-ai/workspaces-web@0.2.13`
|
|
415
415
|
- Read: [PATTERN.md](patterns/workspaces/workspace-surfaces/PATTERN.md)
|
|
416
416
|
- Examples: [example/](patterns/workspaces/workspace-surfaces/example/)
|
|
417
417
|
- 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.2.
|
|
37
|
+
"@jskit-ai/kernel": "0.2.6",
|
|
38
38
|
"@tanstack/vue-query": "^5.101.0",
|
|
39
39
|
"fastify": "^5.8.5",
|
|
40
40
|
"pino": "^10.3.1",
|
|
@@ -43,13 +43,13 @@
|
|
|
43
43
|
"vue": "^3.5.44",
|
|
44
44
|
"vue-router": "^5.3.1",
|
|
45
45
|
"vuetify": "^4.1.2",
|
|
46
|
-
"@jskit-ai/http-runtime": "0.2.
|
|
46
|
+
"@jskit-ai/http-runtime": "0.2.6",
|
|
47
47
|
"@fastify/fast-json-stringify-compiler": "^5.1.0",
|
|
48
48
|
"@vue/devtools-api": "^8.2.1"
|
|
49
49
|
},
|
|
50
50
|
"devDependencies": {
|
|
51
|
-
"@jskit-ai/config-eslint": "0.1.
|
|
52
|
-
"@jskit-ai/jskit-catalog": "0.2.
|
|
51
|
+
"@jskit-ai/config-eslint": "0.1.245",
|
|
52
|
+
"@jskit-ai/jskit-catalog": "0.2.19",
|
|
53
53
|
"@playwright/test": "1.61.1",
|
|
54
54
|
"@vitejs/plugin-vue": "^6.0.7",
|
|
55
55
|
"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.2.
|
|
37
|
+
"@jskit-ai/kernel": "0.2.6",
|
|
38
38
|
"@tanstack/vue-query": "^5.101.0",
|
|
39
39
|
"fastify": "^5.8.5",
|
|
40
40
|
"pino": "^10.3.1",
|
|
@@ -43,15 +43,15 @@
|
|
|
43
43
|
"vue": "^3.5.44",
|
|
44
44
|
"vue-router": "^5.3.1",
|
|
45
45
|
"vuetify": "^4.1.2",
|
|
46
|
-
"@jskit-ai/http-runtime": "0.2.
|
|
46
|
+
"@jskit-ai/http-runtime": "0.2.6",
|
|
47
47
|
"@mdi/js": "^7.4.47",
|
|
48
|
-
"@jskit-ai/shell-web": "0.2.
|
|
48
|
+
"@jskit-ai/shell-web": "0.2.7",
|
|
49
49
|
"@fastify/fast-json-stringify-compiler": "^5.1.0",
|
|
50
50
|
"@vue/devtools-api": "^8.2.1"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"@jskit-ai/config-eslint": "0.1.
|
|
54
|
-
"@jskit-ai/jskit-catalog": "0.2.
|
|
53
|
+
"@jskit-ai/config-eslint": "0.1.245",
|
|
54
|
+
"@jskit-ai/jskit-catalog": "0.2.19",
|
|
55
55
|
"@playwright/test": "1.61.1",
|
|
56
56
|
"@vitejs/plugin-vue": "^6.0.7",
|
|
57
57
|
"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.2.
|
|
11
|
-
"@jskit-ai/connector-google-calendar": "0.2.
|
|
12
|
-
"@jskit-ai/database-runtime": "0.1.
|
|
13
|
-
"@jskit-ai/database-runtime-mysql": "0.1.
|
|
10
|
+
"@jskit-ai/connectors-core": "0.2.7",
|
|
11
|
+
"@jskit-ai/connector-google-calendar": "0.2.7",
|
|
12
|
+
"@jskit-ai/database-runtime": "0.1.255",
|
|
13
|
+
"@jskit-ai/database-runtime-mysql": "0.1.253",
|
|
14
14
|
"knex": "^3.1.0"
|
|
15
15
|
}
|
|
16
16
|
}
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
"./shared": "./src/shared/index.js"
|
|
10
10
|
},
|
|
11
11
|
"dependencies": {
|
|
12
|
-
"@jskit-ai/crud-core": "0.2.
|
|
13
|
-
"@jskit-ai/resource-crud-core": "0.1.
|
|
12
|
+
"@jskit-ai/crud-core": "0.2.6",
|
|
13
|
+
"@jskit-ai/resource-crud-core": "0.1.197"
|
|
14
14
|
},
|
|
15
15
|
"jskit": {
|
|
16
16
|
"kind": "runtime",
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
"./shared": "./src/shared/index.js"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@jskit-ai/crud-core": "0.2.
|
|
14
|
-
"@jskit-ai/resource-crud-core": "0.1.
|
|
13
|
+
"@jskit-ai/crud-core": "0.2.6",
|
|
14
|
+
"@jskit-ai/resource-crud-core": "0.1.197"
|
|
15
15
|
},
|
|
16
16
|
"jskit": {
|
|
17
17
|
"kind": "runtime",
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
"./shared": "./src/shared/index.js"
|
|
11
11
|
},
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@jskit-ai/crud-core": "0.2.
|
|
14
|
-
"@jskit-ai/resource-crud-core": "0.1.
|
|
15
|
-
"@jskit-ai/workspaces-core": "0.2.
|
|
13
|
+
"@jskit-ai/crud-core": "0.2.6",
|
|
14
|
+
"@jskit-ai/resource-crud-core": "0.1.197",
|
|
15
|
+
"@jskit-ai/workspaces-core": "0.2.7"
|
|
16
16
|
},
|
|
17
17
|
"jskit": {
|
|
18
18
|
"kind": "runtime",
|
|
@@ -135,6 +135,9 @@ the English `message`:
|
|
|
135
135
|
values and render from `jskit.errors.<code>`.
|
|
136
136
|
- Validation errors keep `details.fieldErrors` (English) and add
|
|
137
137
|
`details.fieldErrorCodes: { field: { code, params } }`.
|
|
138
|
+
- A schema's field `messages` may give a message as a string or as
|
|
139
|
+
`{ code, message, params }` (see below); the coded form travels as that
|
|
140
|
+
field's code.
|
|
138
141
|
- Where one code covers several different sentences (for example
|
|
139
142
|
`connector_input_invalid`), the response also has `messageCode` and
|
|
140
143
|
`messageParams` for the exact sentence.
|
|
@@ -164,6 +167,33 @@ throw new AppError(409, "That slug is taken.", { code: "app.project.slugTaken" }
|
|
|
164
167
|
// en: { jskit: { app: { project: { slugTaken: "That slug is taken." } } } }
|
|
165
168
|
```
|
|
166
169
|
|
|
170
|
+
### Field messages in schemas
|
|
171
|
+
|
|
172
|
+
A field's `messages` in a resource or command schema map a validation keyword
|
|
173
|
+
(or `default`) to the message shown when that check fails. A plain string is
|
|
174
|
+
sent as written and is never translated. To make it translatable, give the
|
|
175
|
+
coded form instead: the code, the English (exactly the catalog's English with
|
|
176
|
+
the params filled in) and any params.
|
|
177
|
+
|
|
178
|
+
```js
|
|
179
|
+
const NAME_MESSAGES = Object.freeze({
|
|
180
|
+
required: { code: "app.project.nameRequired", message: "Name is required." },
|
|
181
|
+
maxLength: { code: "app.project.nameTooLong", message: "Use at most 80 characters.", params: { max: 80 } }
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
const schema = {
|
|
185
|
+
name: { type: "string", required: true, maxLength: 80, messages: NAME_MESSAGES }
|
|
186
|
+
};
|
|
187
|
+
// en: { jskit: { app: { project: {
|
|
188
|
+
// nameRequired: "Name is required.", nameTooLong: "Use at most {max} characters." } } } }
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
The server still sends the English in `details.fieldErrors` and adds the code
|
|
192
|
+
and params to `details.fieldErrorCodes`, so an untranslated app shows exactly
|
|
193
|
+
the English it showed before. The failed check's own params (for example
|
|
194
|
+
`limit`) are sent too, and the coded entry's `params` win over them. JSKIT's
|
|
195
|
+
own schemas use this form, which is why their field messages translate.
|
|
196
|
+
|
|
167
197
|
## Placement labels
|
|
168
198
|
|
|
169
199
|
A placement `label` or `title` may be a message key, `{ key, fallback, params }`
|
|
@@ -186,12 +216,21 @@ App code can use the same helpers from `useJskitText()`: `formatDate`,
|
|
|
186
216
|
|
|
187
217
|
## Emails
|
|
188
218
|
|
|
189
|
-
The
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
219
|
+
The server reads the same `src/locales/<code>/jskit.json` files the client
|
|
220
|
+
uses, so translating a JSKIT email's keys there translates the email too. It
|
|
221
|
+
looks for the exact locale (`it-IT`), then the language (`it`), then English.
|
|
222
|
+
|
|
223
|
+
- The workspace invitation email (`jskit.workspaces.inviteEmail.*`) is rendered
|
|
224
|
+
in the recipient's saved `user_settings.locale` when the recipient already
|
|
225
|
+
has an account, and in English otherwise. Its expiry date is written with
|
|
226
|
+
`Intl` in that locale and the recipient's saved time zone (UTC otherwise).
|
|
227
|
+
The app's invite mailer also receives the chosen `locale`.
|
|
228
|
+
- JSKIT's accounts hub (`@jskit-ai/oidc-issuer-core`) sends the account
|
|
229
|
+
confirmation, password recovery, Google link and test emails itself, from
|
|
230
|
+
`jskit.accounts.*`. Hub accounts keep no saved language, so each email
|
|
231
|
+
follows the request that sent it: the app's `ui_locales`, then the browser's
|
|
232
|
+
`Accept-Language`, then English. The hub reads the hub project's
|
|
233
|
+
`src/locales/<code>/jskit.json`; its README has the details.
|
|
195
234
|
|
|
196
235
|
Server code that renders JSKIT-style messages itself uses the same lookup:
|
|
197
236
|
|
|
@@ -202,9 +241,10 @@ const i18n = createServerI18n({ appRoot, catalogs: [english] });
|
|
|
202
241
|
i18n.t("it-IT", "jskit.workspaces.inviteEmail.subject", { workspace: "Acme" });
|
|
203
242
|
```
|
|
204
243
|
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
244
|
+
An app that signs in through JSKIT's accounts hub gets its password-reset
|
|
245
|
+
email from the hub, translated as above. With another identity provider
|
|
246
|
+
(Supabase, a third-party OIDC issuer) the provider sends it, so its language is
|
|
247
|
+
the provider's choice.
|
|
208
248
|
|
|
209
249
|
## What the app translates itself
|
|
210
250
|
|
|
@@ -223,6 +263,12 @@ JSKIT's catalogs cover JSKIT's own code. These texts belong to the app:
|
|
|
223
263
|
|
|
224
264
|
Each JSKIT package with a catalog has a test that compiles every message with
|
|
225
265
|
vue-i18n, requires every key and dotted code its source uses to exist, rejects
|
|
226
|
-
unused keys and refuses a key another package already defines.
|
|
266
|
+
unused keys and refuses a key another package already defines. It also requires
|
|
267
|
+
an undotted code sent with fixed English to have its `jskit.errors.<code>`
|
|
268
|
+
entry (or a `messageCode`), and a literal `{ code, message }` to send its
|
|
269
|
+
catalog's English. A browser test exports a pseudo-locale with
|
|
270
|
+
`jskit i18n export`, switches a fixture app to it, and fails on any English left
|
|
271
|
+
on the sign-in, registration, password reset, sign-out, profile menu, account
|
|
272
|
+
settings and error screens. ESLint's
|
|
227
273
|
`@intlify/vue-i18n/no-raw-text` rule rejects untranslated template text in JSKIT
|
|
228
274
|
client code.
|