@jskit-ai/agent-docs 0.1.291 → 0.1.293
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-setup/authentication.md +19 -8
- package/guide/agent/app-setup/multi-homing.md +19 -0
- package/guide/agent/app-setup/upgrading-jskit.md +4 -0
- package/guide/agent/framework/client-features.md +26 -1
- package/guide/agent/framework/data-access.md +118 -12
- package/guide/agent/framework/sanity-checks.md +4 -0
- package/guide/agent/framework/typed-features.md +33 -2
- package/package.json +1 -1
- package/patterns/feature-package/example/booking-engine/package.json +2 -2
- package/patterns/minimal-foundation/example/AGENTS.md +5 -1
- package/patterns/minimal-foundation/example/package.json +5 -5
- package/patterns/shell-foundation/example/AGENTS.md +5 -1
- package/patterns/shell-foundation/example/package.json +6 -6
- package/patterns/shell-foundation/example/packages/main/package.json +1 -1
- package/reference/autogen/PATTERN_INDEX.md +38 -38
- package/reference/autogen/packages/crud-core.md +1 -1
- package/reference/autogen/packages/kernel.md +7 -1
- package/reference/autogen/packages/resource-runtime.md +13 -4
- package/reference/autogen/packages/workspaces-core.md +8 -2
- package/reference/autogen/packages/workspaces-web.md +1 -0
- package/reference/autogen/tooling/config-eslint.md +18 -1
- package/reference/autogen/tooling/jskit-catalog.md +8 -0
- package/skills/jskit/references/client-features.md +26 -1
- package/skills/jskit/references/data-access.md +118 -12
- package/skills/jskit/references/heuristics/ui-testing.md +6 -3
- package/skills/jskit/references/multi-homing.md +19 -0
- package/skills/jskit/references/pattern-index.md +38 -38
- package/skills/jskit/references/patterns/app/minimal-foundation/example/AGENTS.md +5 -1
- package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +5 -5
- package/skills/jskit/references/patterns/app/shell-foundation/example/AGENTS.md +5 -1
- package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +6 -6
- 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 +3 -3
- 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/crud-feature-package/example/packages/books/package.json +3 -3
- package/skills/jskit/references/patterns/crud/crud-screen-set/PATTERN.md +3 -1
- package/skills/jskit/references/patterns/database/mysql-application/example/package.json +2 -2
- package/skills/jskit/references/patterns/database/postgres-application/example/package.json +2 -2
- 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 +2 -2
- package/skills/jskit/references/patterns/users/account-settings/example/src/components/account/settings/AccountSettingsPreferencesSection.vue +7 -0
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +3 -3
- package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +6 -6
- package/skills/jskit/references/patterns/workspaces/workspace-server/PATTERN.md +9 -0
- package/skills/jskit/references/sanity-checks.md +4 -0
- package/skills/jskit/references/typed-features.md +33 -2
|
@@ -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.293`
|
|
19
19
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/app/minimal-foundation/PATTERN.md)
|
|
20
20
|
- Examples: [example/](../../skills/jskit/references/patterns/app/minimal-foundation/example/)
|
|
21
21
|
- Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`
|
|
@@ -26,7 +26,7 @@ A concrete JSKIT web application foundation with responsive shell navigation, se
|
|
|
26
26
|
|
|
27
27
|
- Id: `app/shell-foundation`
|
|
28
28
|
- Keywords: `app`, `foundation`, `material`, `navigation`, `placements`, `shell`, `vite`, `vue`
|
|
29
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
29
|
+
- Owner: `@jskit-ai/agent-docs@0.1.293`
|
|
30
30
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/app/shell-foundation/PATTERN.md)
|
|
31
31
|
- Examples: [example/](../../skills/jskit/references/patterns/app/shell-foundation/example/)
|
|
32
32
|
- Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -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.39`
|
|
41
41
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/assistant/assistant-surface/PATTERN.md)
|
|
42
42
|
- Examples: [example/](../../skills/jskit/references/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.26`
|
|
52
52
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/accounts-hub/PATTERN.md)
|
|
53
53
|
- Examples: [example/](../../skills/jskit/references/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.24`
|
|
63
63
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/auth-surface/PATTERN.md)
|
|
64
64
|
- Examples: [example/](../../skills/jskit/references/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.26`
|
|
74
74
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/oidc-sign-in/PATTERN.md)
|
|
75
75
|
- Examples: [example/](../../skills/jskit/references/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.20`
|
|
85
85
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/auth/supabase-auth/PATTERN.md)
|
|
86
86
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
96
96
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/ai-connections/PATTERN.md)
|
|
97
97
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
107
107
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/api-key-connection/PATTERN.md)
|
|
108
108
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
118
118
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/assistant-mcp/PATTERN.md)
|
|
119
119
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
129
129
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/assistant-mcp-oauth/PATTERN.md)
|
|
130
130
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
140
140
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/aws-storage-queries/PATTERN.md)
|
|
141
141
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
151
151
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/calendar-cli/PATTERN.md)
|
|
152
152
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
162
162
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/event-delivery/PATTERN.md)
|
|
163
163
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
173
173
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/firebase-messaging/PATTERN.md)
|
|
174
174
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
184
184
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/google-ads-search/PATTERN.md)
|
|
185
185
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
195
195
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/oauth-connection/PATTERN.md)
|
|
196
196
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
206
206
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/paddle-catalogue/PATTERN.md)
|
|
207
207
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
217
217
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/public-image/PATTERN.md)
|
|
218
218
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
228
228
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/redshift-queries/PATTERN.md)
|
|
229
229
|
- Examples: [example/](../../skills/jskit/references/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.23`
|
|
239
239
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/connectors/source-scanning/PATTERN.md)
|
|
240
240
|
- Examples: [example/](../../skills/jskit/references/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.250`
|
|
250
250
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/console/console-surface/PATTERN.md)
|
|
251
251
|
- Examples: [example/](../../skills/jskit/references/patterns/console/console-surface/example/)
|
|
252
252
|
- Requires: `@jskit-ai/console-core`, `@jskit-ai/console-web`, `@jskit-ai/shell-web`
|
|
@@ -257,7 +257,7 @@ Define an application table resource whose records belong to the current user, a
|
|
|
257
257
|
|
|
258
258
|
- Id: `crud/crud-contract`
|
|
259
259
|
- Keywords: `authenticated`, `crud`, `database`, `owner-scoped`, `resource`, `table`, `user`
|
|
260
|
-
- Owner: `@jskit-ai/resource-crud-core@0.1.
|
|
260
|
+
- Owner: `@jskit-ai/resource-crud-core@0.1.209`
|
|
261
261
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/crud/crud-contract/PATTERN.md)
|
|
262
262
|
- Examples: [example/](../../skills/jskit/references/patterns/crud/crud-contract/example/)
|
|
263
263
|
- Requires: `@jskit-ai/resource-core`, `@jskit-ai/resource-crud-core`
|
|
@@ -268,7 +268,7 @@ Build a complete application-owned CRUD server package from a migration, a table
|
|
|
268
268
|
|
|
269
269
|
- Id: `crud/crud-feature-package`
|
|
270
270
|
- Keywords: `actions`, `crud`, `database`, `defineCrudFeature`, `json-api`, `migration`, `owns`, `permissions`, `repository`, `routes`, `service`, `table resource`
|
|
271
|
-
- Owner: `@jskit-ai/crud-core@0.2.
|
|
271
|
+
- Owner: `@jskit-ai/crud-core@0.2.23`
|
|
272
272
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/crud/crud-feature-package/PATTERN.md)
|
|
273
273
|
- Examples: [example/](../../skills/jskit/references/patterns/crud/crud-feature-package/example/)
|
|
274
274
|
- Requires: `@jskit-ai/crud-core`, `@jskit-ai/resource-core`, `@jskit-ai/resource-crud-core`
|
|
@@ -279,7 +279,7 @@ Build a routed CRUD user interface as thin application pages over JSKIT's shared
|
|
|
279
279
|
|
|
280
280
|
- Id: `crud/crud-screen-set`
|
|
281
281
|
- Keywords: `actions`, `add`, `crud`, `delete`, `edit`, `filters`, `list`, `material`, `routes`, `view`, `vue`
|
|
282
|
-
- Owner: `@jskit-ai/http-web@0.2.
|
|
282
|
+
- Owner: `@jskit-ai/http-web@0.2.27`
|
|
283
283
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/crud/crud-screen-set/PATTERN.md)
|
|
284
284
|
- Examples: [example/](../../skills/jskit/references/patterns/crud/crud-screen-set/example/)
|
|
285
285
|
- Requires: `@jskit-ai/http-web`, `@jskit-ai/resource-core`, `@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.265`
|
|
294
294
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/database/mysql-application/PATTERN.md)
|
|
295
295
|
- Examples: [example/](../../skills/jskit/references/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.264`
|
|
305
305
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/database/postgres-application/PATTERN.md)
|
|
306
306
|
- Examples: [example/](../../skills/jskit/references/patterns/database/postgres-application/example/)
|
|
307
307
|
- Requires: `@jskit-ai/database-runtime-postgres`
|
|
@@ -312,7 +312,7 @@ Describe one database table once (its fields, columns, ownership, search and sor
|
|
|
312
312
|
|
|
313
313
|
- Id: `database/table-resource`
|
|
314
314
|
- Keywords: `database`, `defaultTo`, `defineTableResource`, `lockVersionField`, `lookup`, `ownership`, `owns`, `resource`, `system`, `table`, `workspace_or_shared`
|
|
315
|
-
- Owner: `@jskit-ai/resource-core@0.1.
|
|
315
|
+
- Owner: `@jskit-ai/resource-core@0.1.209`
|
|
316
316
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/database/table-resource/PATTERN.md)
|
|
317
317
|
- Examples: [example/](../../skills/jskit/references/patterns/database/table-resource/example/)
|
|
318
318
|
- Requires: `@jskit-ai/resource-core`
|
|
@@ -323,7 +323,7 @@ Wrap a JSKIT web application in a Capacitor Android shell using native Capacitor
|
|
|
323
323
|
|
|
324
324
|
- Id: `mobile/android-application`
|
|
325
325
|
- Keywords: `android`, `capacitor`, `device`, `mobile`, `native`, `shell`, `webview`
|
|
326
|
-
- Owner: `@jskit-ai/mobile-capacitor@0.2.
|
|
326
|
+
- Owner: `@jskit-ai/mobile-capacitor@0.2.22`
|
|
327
327
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/mobile/android-application/PATTERN.md)
|
|
328
328
|
- Examples: [example/](../../skills/jskit/references/patterns/mobile/android-application/example/)
|
|
329
329
|
- Requires: `@capacitor/android`, `@capacitor/app`, `@capacitor/cli`, `@jskit-ai/mobile-capacitor`
|
|
@@ -334,7 +334,7 @@ Add JSKIT realtime events with an optional Redis backplane and an explicit shell
|
|
|
334
334
|
|
|
335
335
|
- Id: `realtime/realtime-application`
|
|
336
336
|
- Keywords: `realtime`, `redis`, `socket.io`, `sockets`, `status`, `websocket`
|
|
337
|
-
- Owner: `@jskit-ai/realtime@0.2.
|
|
337
|
+
- Owner: `@jskit-ai/realtime@0.2.25`
|
|
338
338
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/realtime/realtime-application/PATTERN.md)
|
|
339
339
|
- Examples: [example/](../../skills/jskit/references/patterns/realtime/realtime-application/example/)
|
|
340
340
|
- Requires: `@jskit-ai/realtime`, `@jskit-ai/shell-web`
|
|
@@ -345,7 +345,7 @@ Compose application-owned Google Publisher Tag delivery with the generic rewarde
|
|
|
345
345
|
|
|
346
346
|
- Id: `rewards/google-rewarded`
|
|
347
347
|
- Keywords: `ads`, `google`, `publisher tag`, `rewarded`, `unlock`
|
|
348
|
-
- Owner: `@jskit-ai/rewarded-web@0.2.
|
|
348
|
+
- Owner: `@jskit-ai/rewarded-web@0.2.28`
|
|
349
349
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/rewards/google-rewarded/PATTERN.md)
|
|
350
350
|
- Examples: [example/](../../skills/jskit/references/patterns/rewards/google-rewarded/example/)
|
|
351
351
|
- Requires: `@jskit-ai/rewarded-web`
|
|
@@ -356,7 +356,7 @@ Define a server feature through explicit capabilities and first-class actions, a
|
|
|
356
356
|
|
|
357
357
|
- Id: `server/feature-package`
|
|
358
358
|
- Keywords: `actions`, `aggregate`, `feature`, `handle`, `orchestration`, `owns`, `package`, `provider`, `repository`, `routes`, `server`, `table resource`
|
|
359
|
-
- Owner: `@jskit-ai/agent-docs@0.1.
|
|
359
|
+
- Owner: `@jskit-ai/agent-docs@0.1.293`
|
|
360
360
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/server/feature-package/PATTERN.md)
|
|
361
361
|
- Examples: [example/](../../skills/jskit/references/patterns/server/feature-package/example/)
|
|
362
362
|
- Requires: `@jskit-ai/kernel`
|
|
@@ -367,7 +367,7 @@ Compose the JSKIT responsive shell, semantic placements, settings navigation, an
|
|
|
367
367
|
|
|
368
368
|
- Id: `shell/application-shell`
|
|
369
369
|
- Keywords: `adaptive`, `app`, `layout`, `navigation`, `placement`, `responsive`, `settings`, `shell`
|
|
370
|
-
- Owner: `@jskit-ai/shell-web@0.2.
|
|
370
|
+
- Owner: `@jskit-ai/shell-web@0.2.22`
|
|
371
371
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/shell/application-shell/PATTERN.md)
|
|
372
372
|
- Examples: [example/](../../skills/jskit/references/patterns/shell/application-shell/example/)
|
|
373
373
|
- Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -378,7 +378,7 @@ Add product routes and shell extensions through file routing, semantic placement
|
|
|
378
378
|
|
|
379
379
|
- Id: `ui/page-and-placement`
|
|
380
380
|
- Keywords: `component`, `navigation`, `outlet`, `page`, `placement`, `routes`, `section`, `shell`, `subpages`, `vue`
|
|
381
|
-
- Owner: `@jskit-ai/shell-web@0.2.
|
|
381
|
+
- Owner: `@jskit-ai/shell-web@0.2.22`
|
|
382
382
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/ui/page-and-placement/PATTERN.md)
|
|
383
383
|
- Examples: [example/](../../skills/jskit/references/patterns/ui/page-and-placement/example/)
|
|
384
384
|
- Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
|
|
@@ -389,7 +389,7 @@ Compose an account settings route and profile, preference, notification, and sig
|
|
|
389
389
|
|
|
390
390
|
- Id: `users/account-settings`
|
|
391
391
|
- Keywords: `account`, `link provider`, `notifications`, `oauth`, `preferences`, `profile`, `settings`, `sign-in methods`, `user`, `vue`
|
|
392
|
-
- Owner: `@jskit-ai/users-web@0.2.
|
|
392
|
+
- Owner: `@jskit-ai/users-web@0.2.33`
|
|
393
393
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/users/account-settings/PATTERN.md)
|
|
394
394
|
- Examples: [example/](../../skills/jskit/references/patterns/users/account-settings/example/)
|
|
395
395
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
|
|
@@ -400,7 +400,7 @@ Expose user administration and workspace-scoped member operations through app-ow
|
|
|
400
400
|
|
|
401
401
|
- Id: `users/user-administration-server`
|
|
402
402
|
- Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
|
|
403
|
-
- Owner: `@jskit-ai/users-core@0.2.
|
|
403
|
+
- Owner: `@jskit-ai/users-core@0.2.24`
|
|
404
404
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/users/user-administration-server/PATTERN.md)
|
|
405
405
|
- Examples: [example/](../../skills/jskit/references/patterns/users/user-administration-server/example/)
|
|
406
406
|
- Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
|
|
@@ -411,7 +411,7 @@ Configure roles, workspace access policy, invitations, and app-owned invitation
|
|
|
411
411
|
|
|
412
412
|
- Id: `workspaces/workspace-server`
|
|
413
413
|
- Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
|
|
414
|
-
- Owner: `@jskit-ai/workspaces-core@0.2.
|
|
414
|
+
- Owner: `@jskit-ai/workspaces-core@0.2.24`
|
|
415
415
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/workspaces/workspace-server/PATTERN.md)
|
|
416
416
|
- Examples: [example/](../../skills/jskit/references/patterns/workspaces/workspace-server/example/)
|
|
417
417
|
- Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
|
|
@@ -422,7 +422,7 @@ Compose workspace selection, invitation, member administration, settings, and re
|
|
|
422
422
|
|
|
423
423
|
- Id: `workspaces/workspace-surfaces`
|
|
424
424
|
- Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
|
|
425
|
-
- Owner: `@jskit-ai/workspaces-web@0.2.
|
|
425
|
+
- Owner: `@jskit-ai/workspaces-web@0.2.33`
|
|
426
426
|
- Read: [PATTERN.md](../../skills/jskit/references/patterns/workspaces/workspace-surfaces/PATTERN.md)
|
|
427
427
|
- Examples: [example/](../../skills/jskit/references/patterns/workspaces/workspace-surfaces/example/)
|
|
428
428
|
- Requires: `@jskit-ai/shell-web`, `@jskit-ai/workspaces-core`, `@jskit-ai/workspaces-web`
|
|
@@ -100,7 +100,7 @@ Exports
|
|
|
100
100
|
Local functions
|
|
101
101
|
- `documentNotFound()`
|
|
102
102
|
- `requireDocument(document)`
|
|
103
|
-
- `isNotFound(error)`
|
|
103
|
+
- `isNotFound(error, resourceName)`
|
|
104
104
|
- `recordOutput(crud)`
|
|
105
105
|
- `contractShape(crud)`
|
|
106
106
|
- `includedShape({ attributes, relationships }, labelKey = "")`
|
|
@@ -792,9 +792,10 @@ Local functions
|
|
|
792
792
|
- `messageCodeFields(error, expose = true)`
|
|
793
793
|
- `hiddenServerErrorFields(code = "")`
|
|
794
794
|
- `resolveRequestRouteTransport(request)`
|
|
795
|
-
- `applyRouteTransportErrorResponse(reply, request, error, { statusCode = 500, normalizedErrorCode = "", message = error?.message, exposeDetails = true, messageFields = {} } = {})`
|
|
795
|
+
- `applyRouteTransportErrorResponse(reply, request, error, { statusCode = 500, normalizedErrorCode = "", message = error?.message, exposeDetails = true, messageFields = {}, outcomeFields = {} } = {})`
|
|
796
796
|
- `resolveApiErrorStatus(error, code)`
|
|
797
797
|
- `applyErrorHeaders(reply, error)`
|
|
798
|
+
- `findRefusal(thrown)`
|
|
798
799
|
|
|
799
800
|
### `server/http/HttpProvider.js`
|
|
800
801
|
Exports
|
|
@@ -944,6 +945,7 @@ Exports
|
|
|
944
945
|
- `registerSurfaceRequestConstraint`
|
|
945
946
|
- `resolveRuntimeProfileFromSurface`
|
|
946
947
|
- `createInstalledRuntime`
|
|
948
|
+
- `packageCapabilityDrift`
|
|
947
949
|
|
|
948
950
|
### `server/platform/installedRuntime.js`
|
|
949
951
|
Exports
|
|
@@ -974,11 +976,14 @@ Exports
|
|
|
974
976
|
Exports
|
|
975
977
|
- `assertManifestMatchesProviders(packageEntry, packageProviders, { logger })`
|
|
976
978
|
- `collectGlobalUiPaths(packageEntries)`
|
|
979
|
+
- `manifestCapabilityDrift(packageEntry, packageProviders)`
|
|
980
|
+
- `packageCapabilityDrift(packageEntry)`
|
|
977
981
|
- `resolveInstalledJskitPackages({ appRoot })`
|
|
978
982
|
- `resolvePackageLoadOrder(packageEntries)`
|
|
979
983
|
- `validatePackageCapabilities(packageEntries, { builtinProvidersByCapability = {} } = {})`
|
|
980
984
|
- `type ProviderDefinition`
|
|
981
985
|
- `type RuntimeLogger`
|
|
986
|
+
- `type ManifestCapabilityDrift`
|
|
982
987
|
Local functions
|
|
983
988
|
- `normalizeUiRoutePath(pathValue)`
|
|
984
989
|
- `registerCapabilityProvider(providersByCapability, capabilityId, providerPackageId)`
|
|
@@ -1164,6 +1169,7 @@ Exports
|
|
|
1164
1169
|
- `type ProviderSetupContext`
|
|
1165
1170
|
- `type ProviderLifecycleContext`
|
|
1166
1171
|
- `type ProviderDefinition`
|
|
1172
|
+
- `type ManifestCapabilityDrift`
|
|
1167
1173
|
- `type FeatureSetupContext`
|
|
1168
1174
|
- `type FeatureDefinition`
|
|
1169
1175
|
- `type ResourceRuntime`
|
|
@@ -42,6 +42,14 @@ Exports
|
|
|
42
42
|
- `UnpagedQueryError`
|
|
43
43
|
- `UnsupportedDatabaseError`
|
|
44
44
|
|
|
45
|
+
### `src/server/filterJoinSources.js`
|
|
46
|
+
Exports
|
|
47
|
+
- `filterJoinSources(featureId, resource, searchSchema)`
|
|
48
|
+
- `joinSourceHooks({ resourceName, declared, ownerOf })`
|
|
49
|
+
- `withCallOptions(jsonRestContext, options)`
|
|
50
|
+
Local functions
|
|
51
|
+
- `preparedFilter(resourceName, filter, applyFilter)`
|
|
52
|
+
|
|
45
53
|
### `src/server/foreignKeyCheck.js`
|
|
46
54
|
Exports
|
|
47
55
|
- `checkForeignKeys({ knex, resources, tables = [] })`
|
|
@@ -102,14 +110,16 @@ Local functions
|
|
|
102
110
|
|
|
103
111
|
### `src/server/handleLocks.js`
|
|
104
112
|
Exports
|
|
105
|
-
- `createLockReads({ name, resource, jsonRest, readFields, contextOf, hiddenFields })`
|
|
113
|
+
- `createLockReads({ api, name, resource, jsonRest, readFields, contextOf, hiddenFields, handleNamed, resourceNamed })`
|
|
106
114
|
- `lockModeOf(name, caller, lockMode)`
|
|
107
115
|
Local functions
|
|
108
|
-
- `
|
|
116
|
+
- `lockedIncludes(resource, caller, include)`
|
|
109
117
|
|
|
110
118
|
### `src/server/handleRecords.js`
|
|
111
119
|
Exports
|
|
112
120
|
- `aggregateMeasures(measures)`
|
|
121
|
+
- `defaultFieldList({ outputFields, outputRelationships, idProperty })`
|
|
122
|
+
- `includedRelationships(include)`
|
|
113
123
|
- `MANY_RETURNING`
|
|
114
124
|
- `SINGLE_RETURNING`
|
|
115
125
|
- `handleRecords(resource, records, { include, fields } = {}, resourceNamed)`
|
|
@@ -131,7 +141,6 @@ Local functions
|
|
|
131
141
|
- `setsOwnTimestamps(context)`
|
|
132
142
|
- `atPrecision(field, value)`
|
|
133
143
|
- `stampedAttributes(resource, attributes, stamp, context)`
|
|
134
|
-
- `includedRelationships(include)`
|
|
135
144
|
- `handleRecord(resource, record, included, named, resourceNamed)`
|
|
136
145
|
|
|
137
146
|
### `src/server/index.js`
|
|
@@ -181,7 +190,7 @@ Local functions
|
|
|
181
190
|
### `src/server/resourceHandle.js`
|
|
182
191
|
Exports
|
|
183
192
|
- `MANY_ROW_CHANNEL`
|
|
184
|
-
- `createResourceHandle({ api, resource, hooks, settings, resourceNamed })`
|
|
193
|
+
- `createResourceHandle({ api, resource, hooks, settings, resourceNamed, handleNamed })`
|
|
185
194
|
Local functions
|
|
186
195
|
- `reportManyRow(resource, operation, rows, chunkSize)`
|
|
187
196
|
- `requireHandleTransaction(name, options)`
|
|
@@ -58,7 +58,7 @@ Local functions
|
|
|
58
58
|
### `src/server/common/services/workspaceDirectoryService.js`
|
|
59
59
|
Exports
|
|
60
60
|
- `buildWorkspaceName(user)`
|
|
61
|
-
- `createService({ tenancyProfile, roleCatalog, personalWorkspaceName, workspacesRepository, workspaceMembershipsRepository, workspaceSettingsRepository })`
|
|
61
|
+
- `createService({ tenancyProfile, roleCatalog, personalWorkspaceName, createdParticipant, workspacesRepository, workspaceMembershipsRepository, workspaceSettingsRepository })`
|
|
62
62
|
Local functions
|
|
63
63
|
- `toSlugPart(value)`
|
|
64
64
|
- `buildWorkspaceBaseSlug(user)`
|
|
@@ -146,6 +146,7 @@ Exports
|
|
|
146
146
|
- `type WorkspaceInviteMailer`
|
|
147
147
|
- `type WorkspaceInviteEmailTemplate`
|
|
148
148
|
- `type WorkspaceInviteAcceptanceParticipant`
|
|
149
|
+
- `type WorkspaceCreatedParticipant`
|
|
149
150
|
- `type PersonalWorkspaceName`
|
|
150
151
|
|
|
151
152
|
### `src/server/workspaceBootstrapContributor.js`
|
|
@@ -157,6 +158,10 @@ Local functions
|
|
|
157
158
|
- `buildRequestedWorkspacePayload(workspaceSlug, status)`
|
|
158
159
|
- `resolveRequestedWorkspaceStatusFromError(error)`
|
|
159
160
|
|
|
161
|
+
### `src/server/workspaceDirectory/noWorkspaceCreatedParticipant.js`
|
|
162
|
+
Exports
|
|
163
|
+
- `noWorkspaceCreatedParticipant()`
|
|
164
|
+
|
|
160
165
|
### `src/server/workspaceDirectory/workspaceDirectoryActions.js`
|
|
161
166
|
Exports
|
|
162
167
|
- `createWorkspaceDirectoryActions({ workspaceService })`
|
|
@@ -247,6 +252,7 @@ Exports
|
|
|
247
252
|
- `createWorkspaceRecords`
|
|
248
253
|
- `createWorkspacesRuntime`
|
|
249
254
|
- `noInviteAcceptanceParticipant`
|
|
255
|
+
- `noWorkspaceCreatedParticipant`
|
|
250
256
|
- `renderDefaultWorkspaceInviteEmail`
|
|
251
257
|
- `unconfiguredWorkspaceInviteMailer`
|
|
252
258
|
|
|
@@ -260,7 +266,7 @@ Local functions
|
|
|
260
266
|
Exports
|
|
261
267
|
- `WORKSPACES_TABLES`
|
|
262
268
|
- `createWorkspaceRecords(resources)`
|
|
263
|
-
- `createWorkspacesRuntime({ appRoot, config, env, inviteMailer, inviteEmailTemplate, inviteAcceptanceParticipant, personalWorkspaceName, resources, userProfiles, userSettings, workspaces: workspacesRepository, workspaceMemberships: workspaceMembershipsRepository })`
|
|
269
|
+
- `createWorkspacesRuntime({ appRoot, config, env, inviteMailer, inviteEmailTemplate, inviteAcceptanceParticipant, personalWorkspaceName, resources, userProfiles, userSettings, workspaceCreatedParticipant, workspaces: workspacesRepository, workspaceMemberships: workspaceMembershipsRepository })`
|
|
264
270
|
Local functions
|
|
265
271
|
- `requirePositiveInteger(value, label)`
|
|
266
272
|
- `requireBoolean(value, label)`
|
|
@@ -248,7 +248,9 @@ Exports
|
|
|
248
248
|
Local functions
|
|
249
249
|
- `topLevelFunctions(program)`
|
|
250
250
|
- `isNamedNoOp(fn)`
|
|
251
|
-
- `
|
|
251
|
+
- `inside(range, [start, end])`
|
|
252
|
+
- `componentClosures(scopeManager, setupRanges)`
|
|
253
|
+
- `topLevelHelpers(program, text, isComponentClosure)`
|
|
252
254
|
- `comparisonRoot(file, packageDirectory)`
|
|
253
255
|
- `compareCopies(left, right)`
|
|
254
256
|
|
|
@@ -370,6 +372,21 @@ Exports
|
|
|
370
372
|
Local functions
|
|
371
373
|
- `positionalCollaboratorDefaults(fn, visitorKeys)`
|
|
372
374
|
|
|
375
|
+
### `plugin/rules/selectionField.js`
|
|
376
|
+
Exports
|
|
377
|
+
- `selectionField`
|
|
378
|
+
Local functions
|
|
379
|
+
- `kebabName(rawName)`
|
|
380
|
+
- `isWrittenList(node)`
|
|
381
|
+
- `isWrittenValue(node)`
|
|
382
|
+
- `computedResult(getter)`
|
|
383
|
+
- `isFixedValue(node, { freezing, computing })`
|
|
384
|
+
- `fixedBindings(program)`
|
|
385
|
+
- `propAttribute(element, name)`
|
|
386
|
+
- `bindsObject(element)`
|
|
387
|
+
- `rootIdentifier(expression)`
|
|
388
|
+
- `hasFixedItems(attribute, bindings)`
|
|
389
|
+
|
|
373
390
|
### `plugin/rules/sqlLiteral.js`
|
|
374
391
|
Exports
|
|
375
392
|
- `sqlLiteral`
|
|
@@ -166,6 +166,14 @@ Local functions
|
|
|
166
166
|
- `runI18n({ subcommand, locale, projectRoot })`
|
|
167
167
|
- `readCatalog()`
|
|
168
168
|
|
|
169
|
+
### `scripts/manifest-capabilities.mjs`
|
|
170
|
+
Exports
|
|
171
|
+
- `checkManifestCapabilities({ projectRoot, manifests })`
|
|
172
|
+
- `formatManifestCapabilitiesReport(result)`
|
|
173
|
+
Local functions
|
|
174
|
+
- `capabilityLine(contents, capabilityId = "")`
|
|
175
|
+
- `kernelPlatform(manifestPath, root)`
|
|
176
|
+
|
|
169
177
|
### `scripts/material3-source.mjs`
|
|
170
178
|
Exports
|
|
171
179
|
- `DEFAULT_IMPORT`
|
|
@@ -384,6 +384,29 @@ const emit = defineEmits(["close"]);
|
|
|
384
384
|
emit("closed");
|
|
385
385
|
```
|
|
386
386
|
|
|
387
|
+
### Selection fields
|
|
388
|
+
|
|
389
|
+
**A select, autocomplete or combobox whose options load from the server, or
|
|
390
|
+
whose value is a record id, is `SelectField` from
|
|
391
|
+
`@jskit-ai/http-web/client/components/SelectField`, with `loading` bound while
|
|
392
|
+
the options load.** A raw `v-select`, `v-autocomplete` or `v-combobox` takes
|
|
393
|
+
fixed options only: a list written out in the template, a top-level `const`
|
|
394
|
+
holding one (as written, frozen, or `computed()` over one written out), or an
|
|
395
|
+
import from a `shared` module. The model's name decides nothing.
|
|
396
|
+
|
|
397
|
+
Why: Vuetify titles a value missing from `items` with the value itself, so a
|
|
398
|
+
stored id such as `53` shows until the options arrive; `SelectField` hides it
|
|
399
|
+
while `loading` is true.
|
|
400
|
+
|
|
401
|
+
```vue
|
|
402
|
+
<!-- good -->
|
|
403
|
+
<SelectField v-model="form.serviceId" :items="services.items" :loading="services.loading" />
|
|
404
|
+
<v-select v-model="form.size" :items="SIZE_OPTIONS" />
|
|
405
|
+
|
|
406
|
+
<!-- bad: a stored id shows while the services load -->
|
|
407
|
+
<v-select v-model="form.serviceId" :items="services.items" />
|
|
408
|
+
```
|
|
409
|
+
|
|
387
410
|
### Presenting scripts
|
|
388
411
|
|
|
389
412
|
**A component's `<script>` presents: props, emits, element refs, display
|
|
@@ -558,6 +581,7 @@ client-only rules below. The server's action and error rules do not apply.
|
|
|
558
581
|
| `jskit/no-frozen-vue-state` | `Object.freeze` over refs, computeds or reactive state | [Fixed result shape](#fixed-result-shape) |
|
|
559
582
|
| `jskit/released-listeners` | a listener, interval, observer or subscription the file starts and never releases | [Released listeners](#released-listeners) |
|
|
560
583
|
| `jskit/no-module-state` | a module-level `let`, `ref()` or `reactive()` | [Module state](#module-state) |
|
|
584
|
+
| `jskit/selection-field` | a `v-select`, `v-autocomplete` or `v-combobox` whose items are not fixed, and a `SelectField` whose items are not fixed that binds no `loading` | [Selection fields](#selection-fields) |
|
|
561
585
|
| `vue/require-prop-types`, `vue/require-default-prop`, `vue/require-valid-default-prop`, `vue/no-required-prop-with-default` | a prop without a type, optional without a default, or both | [Collaborator props](#collaborator-props) |
|
|
562
586
|
| `vue/require-explicit-emits` | an emitted event the component does not declare | [Declared emits](#declared-emits) |
|
|
563
587
|
|
|
@@ -578,10 +602,11 @@ Simplicity, effect order and presenting scripts are checked by reading.
|
|
|
578
602
|
Client exceptions use the
|
|
579
603
|
[typed features exceptions](typed-features.md#exceptions): a
|
|
580
604
|
comment on the line before the finding, naming the rule or the finding, with a
|
|
581
|
-
reason prefix. Client code adds
|
|
605
|
+
reason prefix. Client code adds four placements:
|
|
582
606
|
|
|
583
607
|
| Placement | The exception |
|
|
584
608
|
| --- | --- |
|
|
585
609
|
| `// readable-check: allow module-state - shared resource: <what the page shares>` | module state every instance on the page shares on purpose |
|
|
586
610
|
| `<!-- readable-check: allow optional-call - optional operation: <what lacks it> -->` above an element | that element's bindings call an optional operation |
|
|
611
|
+
| `<!-- readable-check: allow selection-field - data: <where the options come from> -->` above an element | a selection whose options are in memory and whose value is no record id |
|
|
587
612
|
| `// readable-check: allow method-probe - input validation: <the shapes>` above a function | the probes of a function whose one job is normalizing an external value of several shapes |
|