@jskit-ai/agent-docs 0.1.261 → 0.1.263

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/guide/agent/app-extras/assistant-conversation.md +5 -2
  2. package/guide/agent/app-extras/realtime.md +5 -0
  3. package/guide/agent/framework/client-features.md +63 -1
  4. package/package.json +1 -1
  5. package/patterns/feature-package/example/booking-engine/package.json +1 -1
  6. package/patterns/minimal-foundation/example/package.json +4 -4
  7. package/patterns/shell-foundation/example/package.json +5 -5
  8. package/patterns/shell-foundation/example/packages/main/package.json +1 -1
  9. package/reference/autogen/PATTERN_INDEX.md +37 -37
  10. package/reference/autogen/packages/assistant-core.md +4 -1
  11. package/reference/autogen/packages/assistant-runtime.md +1 -0
  12. package/reference/autogen/packages/auth-web.md +63 -28
  13. package/reference/autogen/packages/connectors-catalog.md +2 -2
  14. package/reference/autogen/packages/connectors-web.md +13 -9
  15. package/reference/autogen/packages/http-runtime.md +6 -1
  16. package/reference/autogen/packages/http-web.md +127 -54
  17. package/reference/autogen/packages/kernel.md +25 -12
  18. package/reference/autogen/packages/mobile-capacitor.md +36 -9
  19. package/reference/autogen/packages/realtime.md +17 -6
  20. package/reference/autogen/packages/rewarded-web.md +9 -4
  21. package/reference/autogen/packages/shell-web.md +115 -80
  22. package/reference/autogen/packages/uploads-image-web.md +35 -8
  23. package/reference/autogen/packages/users-web.md +38 -2
  24. package/reference/autogen/packages/workspaces-web.md +96 -55
  25. package/reference/autogen/tooling/config-eslint.md +1 -0
  26. package/reference/autogen/tooling/jskit-release.md +1 -1
  27. package/skills/jskit/references/client-features.md +63 -1
  28. package/skills/jskit/references/heuristics/client-features.md +4 -0
  29. package/skills/jskit/references/pattern-index.md +37 -37
  30. package/skills/jskit/references/patterns/app/minimal-foundation/example/package.json +4 -4
  31. package/skills/jskit/references/patterns/app/shell-foundation/example/package.json +5 -5
  32. package/skills/jskit/references/patterns/app/shell-foundation/example/packages/main/package.json +1 -1
  33. package/skills/jskit/references/patterns/auth/accounts-hub/example/package.json +2 -2
  34. package/skills/jskit/references/patterns/auth/oidc-sign-in/example/package.json +2 -2
  35. package/skills/jskit/references/patterns/auth/supabase-auth/example/package.json +1 -1
  36. package/skills/jskit/references/patterns/connectors/calendar-cli/example/package.json +4 -4
  37. package/skills/jskit/references/patterns/crud/json-api-resource-package/example/packages/books/package.json +2 -2
  38. package/skills/jskit/references/patterns/database/mysql-application/example/package.json +1 -1
  39. package/skills/jskit/references/patterns/database/postgres-application/example/package.json +1 -1
  40. package/skills/jskit/references/patterns/realtime/realtime-application/example/package.json +2 -2
  41. package/skills/jskit/references/patterns/rewards/google-rewarded/example/googlePublisherTag.js +13 -10
  42. package/skills/jskit/references/patterns/server/feature-package/example/booking-engine/package.json +1 -1
  43. package/skills/jskit/references/patterns/ui/page-and-placement/example/src/placementTopology.js +1 -0
  44. package/skills/jskit/references/patterns/users/account-settings/example/src/components/account/settings/AccountSettingsPreferencesSection.vue +7 -7
  45. package/skills/jskit/references/patterns/users/account-settings/example/src/components/account/settings/AccountSettingsProfileSection.vue +1 -1
  46. package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users/package.json +2 -2
  47. package/skills/jskit/references/patterns/users/user-administration-server/example/packages/users-workspace/package.json +3 -3
  48. package/skills/jskit/references/patterns/workspaces/workspace-surfaces/example/src/composables/useWorkspaceNotFoundState.js +2 -2
@@ -14,6 +14,13 @@ Use this on demand; do not load the full index at startup.
14
14
 
15
15
  ### src
16
16
 
17
+ ### `src/client/browser.js`
18
+ Exports
19
+ - `pageDocument()`
20
+ - `pageLocation()`
21
+ - `pageWindow()`
22
+ - `replacePage(path)`
23
+
17
24
  ### `src/client/composables/loginView/constants.js`
18
25
  Exports
19
26
  - `LOGIN_MODE`
@@ -50,18 +57,18 @@ Local functions
50
57
 
51
58
  ### `src/client/composables/loginView/useLoginViewActions.js`
52
59
  Exports
53
- - `useLoginViewActions({ state, validation, queryClient, errorRuntime, oauthLaunchClient = null } = {})`
60
+ - `useLoginViewActions({ state, validation, queryClient, errorRuntime, oauthLaunchClient })`
54
61
 
55
62
  ### `src/client/composables/loginView/useLoginViewState.js`
56
63
  Exports
57
- - `useLoginViewState({ placementContext } = {})`
64
+ - `useLoginViewState({ placementContext })`
58
65
  Local functions
59
66
  - `readWindowSearchParam(name = "")`
60
67
  - `resolveInitialMode()`
61
68
 
62
69
  ### `src/client/composables/loginView/useLoginViewValidation.js`
63
70
  Exports
64
- - `useLoginViewValidation({ state } = {})`
71
+ - `useLoginViewValidation({ state })`
65
72
 
66
73
  ### `src/client/composables/loginView/useSessionRecheckOnShow.js`
67
74
  Exports
@@ -76,6 +83,10 @@ Exports
76
83
  Local functions
77
84
  - `validationFieldMessages(validationResult)`
78
85
 
86
+ ### `src/client/composables/useDefaultResetPasswordView.js`
87
+ Exports
88
+ - `useDefaultResetPasswordView()`
89
+
79
90
  ### `src/client/composables/useDefaultSignOutView.js`
80
91
  Exports
81
92
  - `useDefaultSignOutView()`
@@ -132,23 +143,25 @@ Exports
132
143
 
133
144
  ### `src/client/runtime/authClient.js`
134
145
  Exports
135
- - `createAuthClient({ mobile = null, pinia, realtime = null, shell, vueApp } = {})`
146
+ - `createAuthClient({ mobile, pinia, realtime, shell, vueApp })`
136
147
  - `createMobileCallbackCompleter()`
148
+ - `NO_AUTH_REALTIME`
149
+ Local functions
150
+ - `releaseNothing()`
137
151
 
138
152
  ### `src/client/runtime/authGuardRuntime.js`
139
153
  Exports
140
- - `createAuthGuardRuntime({ placementRuntime = null, sessionPath = DEFAULT_SESSION_PATH, loginRoute = DEFAULT_LOGIN_ROUTE, fetchImplementation = globalThis.fetch, refreshOnForeground = DEFAULT_REFRESH_ON_FOREGROUND, refreshOnReconnect = DEFAULT_REFRESH_ON_RECONNECT, realtimeSocket = null, realtimeRefreshEvents = DEFAULT_REALTIME_REFRESH_EVENTS } = {})`
154
+ - `createAuthGuardRuntime({ placementRuntime, sessionPath = DEFAULT_SESSION_PATH, loginRoute = DEFAULT_LOGIN_ROUTE, fetchImplementation = globalThis.fetch, refreshOnForeground = DEFAULT_REFRESH_ON_FOREGROUND, refreshOnReconnect = DEFAULT_REFRESH_ON_RECONNECT, realtimeSocket = NO_REALTIME_REFRESH_SOCKET, realtimeRefreshEvents = DEFAULT_REALTIME_REFRESH_EVENTS })`
141
155
  - `isAuthGuardRuntime(value)`
142
156
  - `initializeAuthGuardRuntime(input = {})`
143
157
  - `refreshAuthGuardState(input = {})`
144
158
  - `getAuthGuardState(input = {})`
145
159
  Local functions
146
- - `asGlobalObject()`
160
+ - `ignoreRealtimeEvent()`
147
161
  - `normalizePathname(pathname, fallback = "/")`
148
162
  - `normalizeLoginRoute(loginRoute, fallback = DEFAULT_LOGIN_ROUTE)`
149
163
  - `normalizeOAuthProviders(rawProviders)`
150
164
  - `normalizeAuthState(payload = {})`
151
- - `isPlacementRuntime(value)`
152
165
  - `applyAuthContext(nextState, placementRuntime)`
153
166
  - `readSessionState({ sessionPath = DEFAULT_SESSION_PATH, fetchImplementation = globalThis.fetch } = {})`
154
167
  - `resolveReturnToPath(context, { absolute = false } = {})`
@@ -159,11 +172,7 @@ Local functions
159
172
  - `hasOAuthCallbackParams({ search = "", hash = "" } = {})`
160
173
  - `stripOAuthCallbackParamsFromSearch(search = "")`
161
174
  - `redirectOAuthCallbackToLoginRoute(loginRoute)`
162
- - `asEventTarget(value)`
163
- - `getWindowEventTarget()`
164
- - `getDocumentEventTarget()`
165
175
  - `isDocumentVisible()`
166
- - `asRealtimeSocket(value)`
167
176
  - `normalizeRealtimeRefreshEvents(value)`
168
177
  - `resolveRuntimeInput(input = {})`
169
178
 
@@ -180,24 +189,27 @@ Exports
180
189
  Exports
181
190
  - `AUTH_GUARD_RUNTIME_INJECTION_KEY`
182
191
  - `AUTH_OAUTH_LAUNCH_CLIENT_INJECTION_KEY`
183
- - `EMPTY_AUTH_GUARD_STATE`
184
- - `EMPTY_AUTH_GUARD_RUNTIME`
185
- - `useAuthGuardRuntime({ required = false } = {})`
186
- - `useAuthOAuthLaunchClient({ required = false } = {})`
192
+ - `NO_AUTH_GUARD_STATE`
193
+ - `NO_AUTH_GUARD_RUNTIME`
194
+ - `useAuthGuardRuntime()`
195
+ - `useAuthOAuthLaunchClient()`
196
+ - `useRequiredAuthGuardRuntime()`
197
+ Local functions
198
+ - `stopListening()`
187
199
 
188
200
  ### `src/client/runtime/oauthCallbackRuntime.js`
189
201
  Exports
190
202
  - `completeOAuthCallbackFromCurrentLocation(options = {})`
191
- - `completeOAuthCallbackFromUrl({ url = "", fallbackReturnTo = "/", allowedReturnToOrigins = [], defaultProvider = "", request = authHttpRequest, refreshSession = async () => null } = {})`
203
+ - `completeOAuthCallbackFromUrl({ url = "", fallbackReturnTo = "/", allowedReturnToOrigins = [], defaultProvider = "", request = authHttpRequest, refreshSession = noRefreshedSession } = {})`
192
204
  - `readOAuthCallbackParamsFromUrl(url = "")`
193
205
  Local functions
206
+ - `noRefreshedSession()`
194
207
  - `readErrorParams(value = "")`
195
208
  - `buildOAuthCompletePayload({ callbackParams = null, provider = "", hasSessionPair = false } = {})`
196
209
 
197
210
  ### `src/client/runtime/oauthLaunchClient.js`
198
211
  Exports
199
- - `createBrowserOAuthLaunchClient({ location = null } = {})`
200
- - `isAuthOAuthLaunchClient(value = null)`
212
+ - `createBrowserOAuthLaunchClient({ location = pageLocation() } = {})`
201
213
 
202
214
  ### `src/client/runtime/passwordRecoveryCallbackRuntime.js`
203
215
  Exports
@@ -210,11 +222,10 @@ Exports
210
222
  Exports
211
223
  - `OAUTH_POPUP_BLOCKED_MESSAGE`
212
224
  - `OAUTH_POPUP_MESSAGE_TYPE`
213
- - `completeOAuthPopupSignIn(win = browserWindow())`
214
- - `createPopupOAuthLaunchClient({ window: win = browserWindow(), fallback = createBrowserOAuthLaunchClient(), onComplete = null } = {})`
225
+ - `completeOAuthPopupSignIn(win = pageWindow())`
226
+ - `createPopupOAuthLaunchClient({ window: win = pageWindow(), fallback = createBrowserOAuthLaunchClient(), onComplete = () => win.location.reload() } = {})`
215
227
  - `isFramedWindow(win)`
216
228
  Local functions
217
- - `browserWindow()`
218
229
  - `storageOf(win)`
219
230
  - `popupFeatures(win, width = 520, height = 680)`
220
231
  - `openChannel(win)`
@@ -226,19 +237,37 @@ Exports
226
237
 
227
238
  ### `src/client/runtime/useSignOut.js`
228
239
  Exports
229
- - `useSignOut(options = {})`
230
- - `createSignOutAction({ currentSurface, goToEntry, authGuardRuntime, returnTo = "", resolveReturnToPath = null } = {})`
231
- - `performSignOutRequest({ authGuardRuntime } = {})`
240
+ - `useSignOut({ currentSurface, goToEntry, authGuardRuntime = useRequiredAuthGuardRuntime(), returnTo, resolveReturnToPath })`
241
+ - `createSignOutAction({ currentSurface, goToEntry, authGuardRuntime, returnTo = "", resolveReturnToPath = noReturnToPath })`
242
+ - `performSignOutRequest({ authGuardRuntime })`
232
243
  Local functions
233
244
  - `readSessionState()`
234
245
  - `waitForSignedOutState({ attempts = 4, delayMs = 120 } = {})`
235
246
  - `createHttpLogoutApi()`
247
+ - `noReturnToPath()`
236
248
 
237
249
  ### `src/client/stores/useAuthStore.js`
238
250
  Exports
239
251
  - `useAuthStore`
240
252
  Local functions
241
253
  - `normalizeAuthStateValue(nextState)`
254
+ - `stopListening()`
255
+
256
+ ### `src/client/types.js`
257
+ Exports
258
+ - `type AuthGuardState`
259
+ - `type AuthGuardRuntime`
260
+ - `type AuthPlacementRuntime`
261
+ - `type AuthRealtimeSocket`
262
+ - `type AuthRealtime`
263
+ - `type AuthShell`
264
+ - `type AuthOAuthLaunchClient`
265
+ - `type AuthMobile`
266
+ - `type AuthErrorRuntime`
267
+ - `type AuthRequest`
268
+ - `type LoginViewState`
269
+ - `type LoginViewValidation`
270
+ - `type AuthClient`
242
271
 
243
272
  ### `src/client/views/AuthProfileMenuLinkItem.vue`
244
273
  Exports
@@ -260,10 +289,6 @@ Local functions
260
289
  ### `src/client/views/DefaultResetPasswordView.vue`
261
290
  Exports
262
291
  - None
263
- Local functions
264
- - `readRecoveryPayload()`
265
- - `exchangeRecoveryToken()`
266
- - `submitReset()`
267
292
 
268
293
  ### `src/client/views/DefaultSignOutView.vue`
269
294
  Exports
@@ -321,6 +346,16 @@ Exports
321
346
  Exports
322
347
  - `type AuthWeb`
323
348
 
349
+ ### fixtures
350
+
351
+ ### `fixtures/sign-in/main.js`
352
+ Exports
353
+ - None
354
+
355
+ ### `fixtures/sign-in/vite.config.mjs`
356
+ Exports
357
+ - None
358
+
324
359
  ### patterns
325
360
 
326
361
  ### `patterns/auth-surface/example/src/pages/auth/login.vue`
@@ -20,11 +20,11 @@ Exports
20
20
 
21
21
  ### `src/client/google-analytics.js`
22
22
  Exports
23
- - `createGoogleAnalytics({ measurementId, window: browser = globalThis.window } = {})`
23
+ - `createGoogleAnalytics({ measurementId, window: browser = globalThis.window })`
24
24
 
25
25
  ### `src/client/google-maps-platform.js`
26
26
  Exports
27
- - `mountGoogleMap({ element, maps = globalThis.google?.maps, center, zoom = 12, mapId, markers = [], path = [], signal } = {})`
27
+ - `mountGoogleMap({ element, maps = globalThis.google?.maps, center, zoom = 12, mapId, markers = [], path = [], signal = new AbortController().signal })`
28
28
 
29
29
  ### `src/client/logo-dev.js`
30
30
  Exports
@@ -26,16 +26,20 @@ Exports
26
26
  Exports
27
27
  - None
28
28
  Local functions
29
- - `environmentPrefix(id)`
30
- - `accountModeForGrant(grant, settings, accountMode)`
31
29
  - `settingValue(field)`
32
30
  - `settingHint(field)`
33
31
  - `settingItems(field)`
34
32
  - `settingErrors(field)`
35
- - `editAssistantPolicy(changes)`
36
- - `editIntegration(changes)`
37
- - `editSetting(field, value)`
38
- - `editAuthentication(method, current = integration.value)`
39
- - `editSecretReference(value)`
40
- - `editRegistration(field, value)`
41
- - `editGrantType(value)`
33
+
34
+ ### `src/client/types.js`
35
+ Exports
36
+ - `type IntegrationConfiguration`
37
+ - `type IntegrationConfigurationProps`
38
+ - `type IntegrationConfigurationEditor`
39
+
40
+ ### `src/client/useIntegrationConfiguration.js`
41
+ Exports
42
+ - `environmentPrefix(id)`
43
+ - `useIntegrationConfiguration({ props, emit })`
44
+ Local functions
45
+ - `hasSettingsFunction(provider)`
@@ -32,12 +32,17 @@ Exports
32
32
 
33
33
  ### `src/client/transientRetryHttpClient.js`
34
34
  Exports
35
- - `createTransientRetryHttpClient(options = {})`
35
+ - `createTransientRetryHttpClient(options)`
36
36
  Local functions
37
37
  - `sleep(delayMs)`
38
38
  - `shouldRetryTransientHttpFailure(error, method, attemptIndex)`
39
39
  - `requestWithTransientRetry(executor, method, signal)`
40
40
 
41
+ ### `src/client/types.js`
42
+ Exports
43
+ - `type HttpClientOptions`
44
+ - `type TransientRetryHttpClient`
45
+
41
46
  ### `src/client/validationErrors.js`
42
47
  Exports
43
48
  - `normalizeFieldErrors`