@jskit-ai/agent-docs 0.1.1

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 (73) hide show
  1. package/DISTR_AGENT.md +25 -0
  2. package/guide/agent/app-extras/assistant.md +636 -0
  3. package/guide/agent/app-extras/realtime.md +223 -0
  4. package/guide/agent/app-setup/a-more-interesting-shell.md +643 -0
  5. package/guide/agent/app-setup/authentication.md +948 -0
  6. package/guide/agent/app-setup/console.md +316 -0
  7. package/guide/agent/app-setup/database-layer.md +775 -0
  8. package/guide/agent/app-setup/initial-scaffolding.md +714 -0
  9. package/guide/agent/app-setup/multi-homing.md +655 -0
  10. package/guide/agent/app-setup/users.md +355 -0
  11. package/guide/agent/app-setup/working-with-the-jskit-cli.md +983 -0
  12. package/guide/agent/generators/advanced-cruds.md +923 -0
  13. package/guide/agent/generators/crud-generators.md +556 -0
  14. package/guide/agent/generators/intro.md +63 -0
  15. package/guide/agent/generators/ui-generators.md +648 -0
  16. package/guide/agent/index.md +39 -0
  17. package/guide/human/app-extras/assistant.md +695 -0
  18. package/guide/human/app-extras/realtime.md +270 -0
  19. package/guide/human/app-setup/a-more-interesting-shell.md +734 -0
  20. package/guide/human/app-setup/authentication.md +963 -0
  21. package/guide/human/app-setup/console.md +352 -0
  22. package/guide/human/app-setup/database-layer.md +822 -0
  23. package/guide/human/app-setup/initial-scaffolding.md +738 -0
  24. package/guide/human/app-setup/multi-homing.md +795 -0
  25. package/guide/human/app-setup/users.md +404 -0
  26. package/guide/human/app-setup/working-with-the-jskit-cli.md +997 -0
  27. package/guide/human/generators/advanced-cruds.md +923 -0
  28. package/guide/human/generators/crud-generators.md +556 -0
  29. package/guide/human/generators/intro.md +109 -0
  30. package/guide/human/generators/ui-generators.md +665 -0
  31. package/guide/human/index.md +39 -0
  32. package/package.json +28 -0
  33. package/reference/autogen/KERNEL_MAP.md +536 -0
  34. package/reference/autogen/README.md +44 -0
  35. package/reference/autogen/packages/agent-docs.md +13 -0
  36. package/reference/autogen/packages/assistant-core.md +310 -0
  37. package/reference/autogen/packages/assistant-runtime.md +219 -0
  38. package/reference/autogen/packages/assistant.md +73 -0
  39. package/reference/autogen/packages/auth-core.md +352 -0
  40. package/reference/autogen/packages/auth-provider-supabase-core.md +223 -0
  41. package/reference/autogen/packages/auth-web.md +267 -0
  42. package/reference/autogen/packages/console-core.md +116 -0
  43. package/reference/autogen/packages/console-web.md +37 -0
  44. package/reference/autogen/packages/crud-core.md +283 -0
  45. package/reference/autogen/packages/crud-server-generator.md +220 -0
  46. package/reference/autogen/packages/crud-ui-generator.md +154 -0
  47. package/reference/autogen/packages/database-runtime-mysql.md +61 -0
  48. package/reference/autogen/packages/database-runtime-postgres.md +39 -0
  49. package/reference/autogen/packages/database-runtime.md +216 -0
  50. package/reference/autogen/packages/http-runtime.md +213 -0
  51. package/reference/autogen/packages/kernel.md +1350 -0
  52. package/reference/autogen/packages/realtime.md +95 -0
  53. package/reference/autogen/packages/shell-web.md +349 -0
  54. package/reference/autogen/packages/storage-runtime.md +39 -0
  55. package/reference/autogen/packages/ui-generator.md +101 -0
  56. package/reference/autogen/packages/uploads-image-web.md +76 -0
  57. package/reference/autogen/packages/uploads-runtime.md +85 -0
  58. package/reference/autogen/packages/users-core.md +307 -0
  59. package/reference/autogen/packages/users-web.md +473 -0
  60. package/reference/autogen/packages/workspaces-core.md +415 -0
  61. package/reference/autogen/packages/workspaces-web.md +372 -0
  62. package/reference/autogen/tooling/config-eslint.md +52 -0
  63. package/reference/autogen/tooling/create-app.md +194 -0
  64. package/reference/autogen/tooling/jskit-catalog.md +27 -0
  65. package/reference/autogen/tooling/jskit-cli.md +624 -0
  66. package/reference/autogen/tooling/test-support.md +27 -0
  67. package/reference/autogen/tooling/testUtils.md +31 -0
  68. package/templates/APP_BLUEPRINT.md +57 -0
  69. package/workflow/app-state.md +33 -0
  70. package/workflow/bootstrap.md +24 -0
  71. package/workflow/feature-delivery.md +21 -0
  72. package/workflow/review.md +22 -0
  73. package/workflow/scoping.md +26 -0
@@ -0,0 +1,372 @@
1
+ # packages/workspaces-web
2
+
3
+ Generated by `npm run agent-docs:build`.
4
+ Do not edit manually.
5
+
6
+ Generated inventory for `packages/workspaces-web`.
7
+ Use this on demand; do not load the full index at startup.
8
+
9
+ ## Scope
10
+ - Source: `packages/workspaces-web/**/*{.js,.mjs,.cjs,.vue}`
11
+ - Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
12
+
13
+ ## Sections
14
+
15
+ ### src
16
+
17
+ ### `src/client/account-settings/accountSettingsInvitesRuntime.js`
18
+ Exports
19
+ - `createAccountSettingsInvitesRuntime({ invitesAvailable, isResolvingInvite, inviteAction, redeemInviteModel, redeemInviteCommand, pendingInvites, pendingInvitesModel, pendingInvitesView, openWorkspace, reportAccountFeedback } = {})`
20
+
21
+ ### `src/client/account-settings/useAccountSettingsInvitesSectionRuntime.js`
22
+ Exports
23
+ - `useAccountSettingsInvitesSectionRuntime()`
24
+ Local functions
25
+ - `normalizePendingInvite(entry)`
26
+
27
+ ### `src/client/components/AccountSettingsInvitesSection.vue`
28
+ Exports
29
+ - None
30
+
31
+ ### `src/client/components/MembersAdminClientElement.vue`
32
+ Exports
33
+ - None
34
+ Local functions
35
+ - `formatDateTime(value)`
36
+ - `showOwnerChip(member)`
37
+ - `isMemberRoleLocked(member)`
38
+ - `isMemberRemoveLocked(member)`
39
+ - `isRevokeInviteLoading(inviteId)`
40
+ - `isRemoveMemberLoading(memberUserId)`
41
+ - `onSubmitInvite()`
42
+ - `onRevokeInvite(inviteId)`
43
+ - `onMemberRoleUpdate(member, roleSid)`
44
+ - `onRemoveMember(member)`
45
+
46
+ ### `src/client/components/UsersProfileSurfaceSwitchMenuItem.vue`
47
+ Exports
48
+ - None
49
+
50
+ ### `src/client/components/UsersWorkspaceMembersMenuItem.vue`
51
+ Exports
52
+ - None
53
+
54
+ ### `src/client/components/UsersWorkspacePermissionMenuItem.vue`
55
+ Exports
56
+ - None
57
+ Local functions
58
+ - `normalizeRequiredPermissions(value)`
59
+
60
+ ### `src/client/components/UsersWorkspaceSelector.vue`
61
+ Exports
62
+ - None
63
+ Local functions
64
+ - `resolveBrowserPath()`
65
+ - `navigateToWorkspace(slug)`
66
+ - `workspaceAvatarStyle(workspace)`
67
+
68
+ ### `src/client/components/UsersWorkspaceSettingsMenuItem.vue`
69
+ Exports
70
+ - None
71
+
72
+ ### `src/client/components/UsersWorkspaceToolsWidget.vue`
73
+ Exports
74
+ - None
75
+
76
+ ### `src/client/components/WorkspaceMembersClientElement.vue`
77
+ Exports
78
+ - None
79
+ Local functions
80
+ - `workspaceMembersPath(memberId)`
81
+ - `workspaceInvitePath(inviteId)`
82
+ - `resetMessages()`
83
+ - `clearRoleOptions()`
84
+ - `resetViewState()`
85
+ - `toRoleTitle(roleSid)`
86
+ - `normalizeRoleCatalog(payload = {})`
87
+ - `applyRoleCatalog(payload = {})`
88
+ - `normalizeMembers(entries)`
89
+ - `normalizeInvites(entries)`
90
+ - `latestPage(pages)`
91
+ - `applyWorkspaceSettingsPolicy(payload = {})`
92
+ - `submitInvite()`
93
+ - `submitRevokeInvite(inviteId)`
94
+ - `submitMemberRoleUpdate(member, roleSid)`
95
+ - `submitRemoveMember(member)`
96
+
97
+ ### `src/client/components/WorkspaceProfileClientElement.vue`
98
+ Exports
99
+ - None
100
+
101
+ ### `src/client/components/WorkspacesClientElement.vue`
102
+ Exports
103
+ - None
104
+ Local functions
105
+ - `normalizePendingInvite(entry)`
106
+ - `reportFeedback({ message, severity = "error", channel = "banner", dedupeKey = "" } = {})`
107
+ - `workspaceInitials(workspace)`
108
+ - `workspaceAvatarStyle(workspace)`
109
+ - `workspaceHomePath(workspaceSlug)`
110
+ - `openWorkspace(workspaceSlug)`
111
+ - `respondToInvite(invite, decision)`
112
+ - `acceptInvite(invite)`
113
+ - `refuseInvite(invite)`
114
+ - `createWorkspace()`
115
+
116
+ ### `src/client/components/WorkspaceSettingsClientElement.vue`
117
+ Exports
118
+ - None
119
+ Local functions
120
+ - `toWorkspaceEntrySnapshot(entry = null)`
121
+ - `toWorkspaceListSnapshot(list = [])`
122
+ - `toWorkspaceSettingsSnapshot(settings = null)`
123
+ - `applyShellWorkspaceContext(payload = {})`
124
+ - `handleFormSaved()`
125
+
126
+ ### `src/client/components/WorkspaceSettingsFieldsClientElement.vue`
127
+ Exports
128
+ - None
129
+
130
+ ### `src/client/composables/useBootstrapQuery.js`
131
+ Exports
132
+ - `useBootstrapQuery({ workspaceSlug = "", enabled = true, staleTime = DEFAULT_BOOTSTRAP_STALE_TIME_MS, refetchOnMount = false, refetchOnWindowFocus = false } = {})`
133
+ Local functions
134
+ - `normalizeStaleTime(value, fallback = DEFAULT_BOOTSTRAP_STALE_TIME_MS)`
135
+
136
+ ### `src/client/composables/useWorkspaceRouteContext.js`
137
+ Exports
138
+ - `useWorkspaceRouteContext()`
139
+
140
+ ### `src/client/composables/useWorkspaceSurfaceId.js`
141
+ Exports
142
+ - `useWorkspaceSurfaceId({ route = null, placementContext = null } = {})`
143
+ Local functions
144
+ - `resolveCurrentPathname(route = null)`
145
+
146
+ ### `src/client/index.js`
147
+ Exports
148
+ - `WorkspacesWebClientProvider`
149
+ - `WorkspaceMembersClientElement`
150
+ - `clientProviders`
151
+
152
+ ### `src/client/lib/bootstrap.js`
153
+ Exports
154
+ - `buildBootstrapApiPath(workspaceSlug = "")`
155
+ - `findWorkspaceBySlug(entries = [], workspaceSlug = "")`
156
+ - `normalizeWorkspaceEntry(entry = null)`
157
+ - `normalizeWorkspaceList(entries = [])`
158
+ Local functions
159
+ - `normalizeWorkspaceSlug(value = "")`
160
+
161
+ ### `src/client/lib/httpClient.js`
162
+ Exports
163
+ - `workspacesWebHttpClient`
164
+
165
+ ### `src/client/lib/permissions.js`
166
+ Exports
167
+ - `normalizePermissionList`
168
+ - `arePermissionListsEqual(left, right)`
169
+ - `hasPermission`
170
+ Local functions
171
+ - `toPermissionSet(values)`
172
+
173
+ ### `src/client/lib/profileSurfaceMenuLinks.js`
174
+ Exports
175
+ - `resolveProfileSurfaceMenuLinks({ context, surface } = {})`
176
+ - `resolvePrimarySurfaceSwitchLink({ context, surface } = {})`
177
+ - `resolveSurfaceSwitchLinks({ context, surface } = {})`
178
+ - `hasWorkspaceMembership`
179
+ Local functions
180
+ - `resolveSurfaceSwitchIcon(surfaceId = "", explicitIcon = "")`
181
+ - `resolveCurrentWorkspaceSlug(contextValue, surfaceId)`
182
+ - `shouldIncludeSurfaceSwitchTarget(surfaceDefinition = null)`
183
+ - `resolveSurfaceSwitchLinkLabel(surfaceDefinition = null, surfaceId = "")`
184
+
185
+ ### `src/client/lib/surfaceAccessPolicy.js`
186
+ Exports
187
+ - `hasWorkspaceMembership(contextValue = null, workspaceSlug = "")`
188
+ - `resolveSurfaceAccessPolicy(contextValue = null, surfaceDefinition = null)`
189
+ - `evaluateSurfaceAccess({ context = null, surfaceId = "", workspaceSlug = "", allowOnUnknown = false } = {})`
190
+ Local functions
191
+ - `normalizeSurfaceAccessPolicyId(value = "")`
192
+ - `normalizeWorkspaceSlug(value = "")`
193
+ - `normalizeAccessFlagName(value = "")`
194
+ - `normalizeStringList(value)`
195
+ - `normalizeSurfaceAccessFlags(value = null)`
196
+ - `hasPlacementValue(source, key)`
197
+ - `hasKnownWorkspaceMembershipContext(contextValue = null)`
198
+ - `hasKnownPermissionsContext(contextValue = null)`
199
+ - `hasKnownSurfaceAccessContext(contextValue = null)`
200
+ - `resolveSurfaceAccessPolicies(contextValue = null)`
201
+ - `toAccessDecision({ allowed = false, pending = false, reason = "" } = {})`
202
+ - `evaluatePermissionRequirements(policy, permissions = [])`
203
+ - `evaluateFlagRequirements(policy, flags = {})`
204
+
205
+ ### `src/client/lib/theme.js`
206
+ Exports
207
+ - `hexColorToRgb(value = "")`
208
+ - `normalizeThemePreference(value)`
209
+ - `persistBootstrapThemePreference(payload = {}, options = {})`
210
+ - `persistThemePreference(themePreference, options = {})`
211
+ - `readPersistedThemePreference(options = {})`
212
+ - `resolveBootstrapThemePreference(payload = {}, options = {})`
213
+ - `resolveThemeNameForPreference(themePreference, options = {})`
214
+ - `resolveBootstrapThemeName(payload = {}, options = {})`
215
+ - `resolveVuetifyThemeController(vueApp)`
216
+ - `setVuetifyPrimaryColorOverride(themeController, themeInput = null)`
217
+ - `setVuetifyThemeName(themeController, themeName)`
218
+ Local functions
219
+ - `resolveSystemThemeName({ prefersDark } = {})`
220
+ - `resolveThemePreferenceStorage(options = {})`
221
+ - `normalizeHexColor(value = "")`
222
+ - `resolveVuetifyThemeDefinitions(themeController)`
223
+ - `normalizeThemeColors(colors)`
224
+ - `normalizeWorkspaceBaseThemeName(themeName = "")`
225
+ - `areThemeColorsEqual(leftColors = {}, rightColors = {})`
226
+ - `composeWorkspaceThemeDefinition(baseThemeDefinition, palette)`
227
+ - `upsertThemeDefinition(themeDefinitions, themeName, nextDefinition)`
228
+
229
+ ### `src/client/lib/workspaceLinkResolver.js`
230
+ Exports
231
+ - `resolveWorkspaceSlugFromContextOrPath({ context = null, surface = "", workspaceSlug = "", pathname = "" } = {})`
232
+ - `resolveWorkspaceShellLinkPath({ context = null, surface = "", mode = "auto", explicitTo = "", relativePath = "/", workspaceRelativePath = "", surfaceRelativePath = "", workspaceSlug = "", pathname = "" } = {})`
233
+ - `useWorkspaceLinkResolver({ surface = "", workspaceSlug = "", pathname = "" } = {})`
234
+ Local functions
235
+ - `resolveSurfaceBasePath(context = null, surface = "")`
236
+ - `resolveWorkspaceBasePath(context = null, surface = "", workspaceSlug = "")`
237
+
238
+ ### `src/client/lib/workspaceSurfaceContext.js`
239
+ Exports
240
+ - `listWorkspaceSurfaceIdsFromSurfaceConfig(surfaceConfig = null)`
241
+ - `surfaceRequiresWorkspaceFromPlacementContext(contextValue = null, surfaceId = "")`
242
+ - `resolveSurfaceSwitchTargetsFromPlacementContext(contextValue = null, surfaceId = "")`
243
+ Local functions
244
+ - `listNonWorkspaceSurfaceIdsFromSurfaceConfig(surfaceConfig = null)`
245
+ - `listSurfaceIdsFromSurfaceConfig(surfaceConfig = null, { requiresWorkspace = null } = {})`
246
+ - `firstAlternativeSurfaceId(surfaceIds = [], excludeSurfaceId = "")`
247
+
248
+ ### `src/client/lib/workspaceSurfacePaths.js`
249
+ Exports
250
+ - `resolveAccountSettingsPathFromPlacementContext(contextValue = null)`
251
+ - `resolveWorkspaceSurfaceIdFromPlacementPathname(contextValue = null, pathname = "")`
252
+ - `resolveSurfaceWorkspacePathFromPlacementContext(contextValue = null, surfaceId = "", workspaceSlug = "", suffix = "/")`
253
+ - `extractWorkspaceSlugFromSurfacePathname(contextValue = null, surfaceId = "", pathname = "")`
254
+ Local functions
255
+ - `normalizeWorkspaceSuffix(suffix)`
256
+ - `resolveWorkspaceSurfaceIdFromSurfaceConfig(surfaceConfig, pathname = "")`
257
+
258
+ ### `src/client/providers/WorkspacesWebClientProvider.js`
259
+ Exports
260
+ - `WorkspacesWebClientProvider`
261
+
262
+ ### `src/client/runtime/bootstrapPlacementRouteGuards.js`
263
+ Exports
264
+ - `createBootstrapPlacementRouteGuards({ placementRuntime, router = null, root = null, getWorkspaceBootstrapStatus = () => "" } = {})`
265
+
266
+ ### `src/client/runtime/bootstrapPlacementRuntime.js`
267
+ Exports
268
+ - `WORKSPACE_BOOTSTRAP_STATUS_RESOLVED`
269
+ - `WORKSPACE_BOOTSTRAP_STATUS_NOT_FOUND`
270
+ - `WORKSPACE_BOOTSTRAP_STATUS_FORBIDDEN`
271
+ - `WORKSPACE_BOOTSTRAP_STATUS_UNAUTHENTICATED`
272
+ - `WORKSPACE_BOOTSTRAP_STATUS_ERROR`
273
+ - `createBootstrapPlacementRuntime({ app, logger = null, fetchBootstrap = fetchBootstrapPayload } = {})`
274
+
275
+ ### `src/client/runtime/bootstrapPlacementRuntimeConstants.js`
276
+ Exports
277
+ - `SHELL_GUARD_EVALUATOR_KEY`
278
+ - `WORKSPACE_BOOTSTRAP_STATUSES`
279
+ - `WORKSPACE_BOOTSTRAP_STATUS_ERROR`
280
+ - `WORKSPACE_BOOTSTRAP_STATUS_FORBIDDEN`
281
+ - `WORKSPACE_BOOTSTRAP_STATUS_NOT_FOUND`
282
+ - `WORKSPACE_BOOTSTRAP_STATUS_RESOLVED`
283
+ - `WORKSPACE_BOOTSTRAP_STATUS_UNAUTHENTICATED`
284
+ - `WORKSPACE_FORBIDDEN_GUARD_REASON`
285
+ - `WORKSPACE_NOT_FOUND_GUARD_REASON`
286
+
287
+ ### `src/client/runtime/bootstrapPlacementRuntimeHelpers.js`
288
+ Exports
289
+ - `countPendingInvites(entries = [])`
290
+ - `createProviderLogger(app)`
291
+ - `fetchBootstrapPayload(workspaceSlug = "")`
292
+ - `isGuardDenied(outcome)`
293
+ - `normalizeSearch(search = "")`
294
+ - `normalizeWorkspaceBootstrapStatus(status = "")`
295
+ - `normalizeWorkspaceSlugKey(workspaceSlug = "")`
296
+ - `resolveAuthSignature(context = {})`
297
+ - `resolveRequestedWorkspaceBootstrapStatus(payload = {}, workspaceSlug = "")`
298
+ - `resolveRouteState(placementRuntime, router)`
299
+ - `resolveSearchFromFullPath(fullPath = "")`
300
+
301
+ ### `src/client/support/realtimeWorkspace.js`
302
+ Exports
303
+ - `matchesCurrentWorkspaceEvent(payload = {}, workspaceSlug = "")`
304
+ - `createWorkspaceRealtimeMatcher(workspaceSlugRef)`
305
+
306
+ ### `src/client/support/runtimeNormalization.js`
307
+ Exports
308
+ - `normalizeRecord(value)`
309
+ - `normalizeWorkspaceBootstrapStatusValue(status = "", allowedStatuses = null)`
310
+ - `resolveErrorStatusCode(error)`
311
+
312
+ ### `src/client/support/workspaceQueryKeys.js`
313
+ Exports
314
+ - `buildWorkspaceQueryKey(kind = "", surfaceId = "", workspaceSlug = "")`
315
+
316
+ ### `src/shared/toolsOutletContracts.js`
317
+ Exports
318
+ - `DEFAULT_TOOLS_LINK_COMPONENT_TOKEN`
319
+ - `WORKSPACE_TOOLS_OUTLET`
320
+
321
+ ### templates
322
+
323
+ ### `templates/packages/main/src/client/components/AccountPendingInvitesCue.vue`
324
+ Exports
325
+ - None
326
+ Local functions
327
+ - `normalizePendingInvitesCount(value)`
328
+ - `resolveReturnTo()`
329
+ - `resolveReturnToHref()`
330
+ - `countPendingInvites(entries = [])`
331
+
332
+ ### `templates/src/components/WorkspaceNotFoundCard.vue`
333
+ Exports
334
+ - None
335
+
336
+ ### `templates/src/composables/useWorkspaceNotFoundState.js`
337
+ Exports
338
+ - `useWorkspaceNotFoundState()`
339
+
340
+ ### `templates/src/pages/admin/members/index.vue`
341
+ Exports
342
+ - None
343
+
344
+ ### `templates/src/pages/admin/workspace/settings.vue`
345
+ Exports
346
+ - None
347
+
348
+ ### `templates/src/pages/admin/workspace/settings/index.vue`
349
+ Exports
350
+ - None
351
+
352
+ ### `templates/src/surfaces/admin/index.vue`
353
+ Exports
354
+ - None
355
+
356
+ ### `templates/src/surfaces/admin/root.vue`
357
+ Exports
358
+ - None
359
+
360
+ ### `templates/src/surfaces/app/index.vue`
361
+ Exports
362
+ - None
363
+
364
+ ### `templates/src/surfaces/app/root.vue`
365
+ Exports
366
+ - None
367
+
368
+ ### root
369
+
370
+ ### `package.descriptor.mjs`
371
+ Exports
372
+ - None
@@ -0,0 +1,52 @@
1
+ # tooling/config-eslint
2
+
3
+ Generated by `npm run agent-docs:build`.
4
+ Do not edit manually.
5
+
6
+ Generated inventory for `tooling/config-eslint`.
7
+ Use this on demand; do not load the full index at startup.
8
+
9
+ ## Scope
10
+ - Source: `tooling/config-eslint/**/*{.js,.mjs,.cjs,.vue}`
11
+ - Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
12
+
13
+ ## Sections
14
+
15
+ ### src
16
+
17
+ ### `src/client/index.js`
18
+ Exports
19
+ - None
20
+
21
+ ### `src/index.js`
22
+ Exports
23
+ - None
24
+
25
+ ### `src/server/index.js`
26
+ Exports
27
+ - None
28
+
29
+ ### root
30
+
31
+ ### `base.js`
32
+ Exports
33
+ - `baseConfig`
34
+
35
+ ### `index.js`
36
+ Exports
37
+ - `baseConfig`
38
+ - `nodeConfig`
39
+ - `webConfig`
40
+ - `vueConfig`
41
+
42
+ ### `node.js`
43
+ Exports
44
+ - `nodeConfig`
45
+
46
+ ### `vue.js`
47
+ Exports
48
+ - `vueConfig`
49
+
50
+ ### `web.js`
51
+ Exports
52
+ - `webConfig`
@@ -0,0 +1,194 @@
1
+ # tooling/create-app
2
+
3
+ Generated by `npm run agent-docs:build`.
4
+ Do not edit manually.
5
+
6
+ Generated inventory for `tooling/create-app`.
7
+ Use this on demand; do not load the full index at startup.
8
+
9
+ ## Scope
10
+ - Source: `tooling/create-app/**/*{.js,.mjs,.cjs,.vue}`
11
+ - Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
12
+
13
+ ## Sections
14
+
15
+ ### src
16
+
17
+ ### `src/client/index.js`
18
+ Exports
19
+ - None
20
+
21
+ ### `src/index.js`
22
+ Exports
23
+ - None
24
+
25
+ ### `src/server/cliEntrypoint.js`
26
+ Exports
27
+ - `shellQuote(value)`
28
+ - `runCliEntrypoint(runCli, argv = process.argv.slice(2))`
29
+
30
+ ### `src/server/cliError.js`
31
+ Exports
32
+ - `createCliError(message, { showUsage = false, exitCode = 1 } = {})`
33
+
34
+ ### `src/server/index.js`
35
+ Exports
36
+ - `createApp({ appName, appTitle = null, template = DEFAULT_TEMPLATE, target = null, initialBundles = DEFAULT_INITIAL_BUNDLES, tenancyMode = null, force = false, dryRun = false, cwd = process.cwd() })`
37
+ - `runCli(argv, { stdout = process.stdout, stderr = process.stderr, stdin = process.stdin, cwd = process.cwd(), readlineFactory = createReadlineInterface } = {})`
38
+ Local functions
39
+ - `toAppTitle(appName)`
40
+ - `normalizeInitialBundlesPreset(value, { showUsage = true } = {})`
41
+ - `normalizeTenancyMode(value, { showUsage = true } = {})`
42
+ - `buildInitialSetupCommands(initialBundles)`
43
+ - `validateAppName(appName, { showUsage = true } = {})`
44
+ - `parseOptionWithValue(argv, index, optionName)`
45
+ - `parseCliArgs(argv)`
46
+ - `printUsage(stream = process.stderr)`
47
+ - `applyPlaceholders(source, replacements)`
48
+ - `isPathWithinRoot(rootPath, candidatePath)`
49
+ - `normalizeTemplatePathSegments(templateName)`
50
+ - `resolveTemplateDirectory(templateName)`
51
+ - `ensureTargetDirectoryState(targetDirectory, { force = false, dryRun = false } = {})`
52
+ - `sortEntriesByName(entries)`
53
+ - `mapTemplatePathToTargetPath(relativePath)`
54
+ - `writeTemplateFile(sourcePath, targetPath, replacements)`
55
+ - `copyTemplateDirectory({ templateDirectory, targetDirectory, replacements, dryRun })`
56
+ - `toRelativeTargetLabel(cwd, targetDirectory)`
57
+ - `askQuestion(readline, label, defaultValue)`
58
+ - `askYesNoQuestion(readline, label, defaultValue)`
59
+ - `createReadlineInterface({ stdin = process.stdin, stdout = process.stdout } = {})`
60
+ - `collectInteractiveOptions({ parsed, stdout = process.stdout, stderr = process.stderr, stdin = process.stdin, readlineFactory = createReadlineInterface })`
61
+
62
+ ### templates
63
+
64
+ ### `templates/base-shell/bin/server.js`
65
+ Exports
66
+ - None
67
+
68
+ ### `templates/base-shell/config/public.js`
69
+ Exports
70
+ - `config`
71
+
72
+ ### `templates/base-shell/config/server.js`
73
+ Exports
74
+ - `config`
75
+
76
+ ### `templates/base-shell/config/surfaceAccessPolicies.js`
77
+ Exports
78
+ - `surfaceAccessPolicies`
79
+
80
+ ### `templates/base-shell/eslint.config.mjs`
81
+ Exports
82
+ - None
83
+
84
+ ### `templates/base-shell/packages/main/package.descriptor.mjs`
85
+ Exports
86
+ - None
87
+
88
+ ### `templates/base-shell/packages/main/src/client/index.js`
89
+ Exports
90
+ - `MainClientProvider`
91
+ - `registerMainClientComponent`
92
+
93
+ ### `templates/base-shell/packages/main/src/client/providers/MainClientProvider.js`
94
+ Exports
95
+ - `MainClientProvider`
96
+ - `registerMainClientComponent(token, resolveComponent)`
97
+
98
+ ### `templates/base-shell/packages/main/src/server/controllers/index.js`
99
+ Exports
100
+ - None
101
+
102
+ ### `templates/base-shell/packages/main/src/server/index.js`
103
+ Exports
104
+ - `MainServiceProvider`
105
+
106
+ ### `templates/base-shell/packages/main/src/server/providers/MainServiceProvider.js`
107
+ Exports
108
+ - `MainServiceProvider`
109
+
110
+ ### `templates/base-shell/packages/main/src/server/routes/index.js`
111
+ Exports
112
+ - None
113
+
114
+ ### `templates/base-shell/packages/main/src/server/services/index.js`
115
+ Exports
116
+ - None
117
+
118
+ ### `templates/base-shell/packages/main/src/server/support/loadAppConfig.js`
119
+ Exports
120
+ - `loadAppConfig({ moduleUrl = import.meta.url } = {})`
121
+
122
+ ### `templates/base-shell/packages/main/src/shared/index.js`
123
+ Exports
124
+ - None
125
+
126
+ ### `templates/base-shell/packages/main/src/shared/schemas/index.js`
127
+ Exports
128
+ - None
129
+
130
+ ### `templates/base-shell/server.js`
131
+ Exports
132
+ - `createServer()`
133
+ - `startServer(options = {})`
134
+ Local functions
135
+ - `toRequestPathname(urlValue)`
136
+ - `isApiPath(pathname)`
137
+ - `hasFileExtension(pathname)`
138
+ - `resolveGlobalUiPaths(runtimeGlobalUiPaths = [])`
139
+ - `resolveStaticFilePath(pathname)`
140
+ - `canServeStaticFile(distRoot, relativePath)`
141
+
142
+ ### `templates/base-shell/server/lib/runtimeEnv.js`
143
+ Exports
144
+ - `resolveRuntimeEnv()`
145
+ Local functions
146
+ - `toPort(value, fallback = 3000)`
147
+ - `ensureRuntimeEnvLoaded()`
148
+
149
+ ### `templates/base-shell/server/lib/surfaceRuntime.js`
150
+ Exports
151
+ - `surfaceRuntime`
152
+
153
+ ### `templates/base-shell/src/App.vue`
154
+ Exports
155
+ - None
156
+
157
+ ### `templates/base-shell/src/main.js`
158
+ Exports
159
+ - None
160
+
161
+ ### `templates/base-shell/src/pages/home.vue`
162
+ Exports
163
+ - None
164
+
165
+ ### `templates/base-shell/src/pages/home/index.vue`
166
+ Exports
167
+ - None
168
+
169
+ ### `templates/base-shell/src/views/NotFound.vue`
170
+ Exports
171
+ - None
172
+
173
+ ### `templates/base-shell/vite.config.mjs`
174
+ Exports
175
+ - None
176
+ Local functions
177
+ - `clientEntry(()`
178
+
179
+ ### `templates/base-shell/vite.shared.mjs`
180
+ Exports
181
+ - `toPositiveInt(value, fallback)`
182
+ - `loadViteDevProxyEntries({ appRootUrl = import.meta.url, fallbackTarget = "" } = {})`
183
+
184
+ ### bin
185
+
186
+ ### `bin/jskit-create-app.js`
187
+ Exports
188
+ - None
189
+
190
+ ### root
191
+
192
+ ### `package.descriptor.mjs`
193
+ Exports
194
+ - None
@@ -0,0 +1,27 @@
1
+ # tooling/jskit-catalog
2
+
3
+ Generated by `npm run agent-docs:build`.
4
+ Do not edit manually.
5
+
6
+ Generated inventory for `tooling/jskit-catalog`.
7
+ Use this on demand; do not load the full index at startup.
8
+
9
+ ## Scope
10
+ - Source: `tooling/jskit-catalog/**/*{.js,.mjs,.cjs,.vue}`
11
+ - Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
12
+
13
+ ## Sections
14
+
15
+ ### scripts
16
+
17
+ ### `scripts/build-catalog.mjs`
18
+ Exports
19
+ - None
20
+ Local functions
21
+ - `parseInlineArg(name)`
22
+ - `toSortedUniqueStrings(values)`
23
+ - `fileExists(absolutePath)`
24
+ - `collectPackageRoots(packagesRoot)`
25
+ - `readJson(absolutePath)`
26
+ - `buildCatalog({ repoRoot, packagesRoot, outputPath })`
27
+ - `main()`