@jskit-ai/agent-docs 0.1.130 → 0.1.132

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 (171) hide show
  1. package/guide/agent/app-extras/assistant.md +29 -605
  2. package/guide/agent/app-extras/mobile-capacitor.md +29 -362
  3. package/guide/agent/app-extras/realtime.md +29 -277
  4. package/guide/agent/app-setup/a-more-interesting-shell.md +44 -815
  5. package/guide/agent/app-setup/authentication.md +43 -1073
  6. package/guide/agent/app-setup/console.md +26 -298
  7. package/guide/agent/app-setup/database-layer.md +110 -790
  8. package/guide/agent/app-setup/initial-scaffolding.md +50 -784
  9. package/guide/agent/app-setup/multi-homing.md +39 -712
  10. package/guide/agent/app-setup/quickstart.md +43 -179
  11. package/guide/agent/app-setup/users.md +34 -353
  12. package/guide/agent/index.md +16 -23
  13. package/package.json +2 -2
  14. package/patterns/INDEX.md +7 -7
  15. package/patterns/child-cruds.md +3 -3
  16. package/patterns/client-requests.md +6 -6
  17. package/patterns/crud-authoring.md +94 -0
  18. package/patterns/crud-links.md +1 -1
  19. package/patterns/feature-package/PATTERN.md +108 -0
  20. package/patterns/feature-package/example/booking-engine/package.json +48 -0
  21. package/patterns/feature-package/example/booking-engine/src/server/BookingEngineProvider.js +33 -0
  22. package/patterns/feature-package/example/booking-engine/src/server/actions.js +26 -0
  23. package/patterns/feature-package/example/booking-engine/src/server/inputSchemas.js +19 -0
  24. package/patterns/feature-package/example/variations/AvailabilityEngineProvider.js +31 -0
  25. package/patterns/feature-package/example/variations/InvoiceRollupProvider.js +36 -0
  26. package/patterns/feature-package/example/variations/customKnexRepository.js +34 -0
  27. package/patterns/feature-package/example/variations/orchestratorService.js +23 -0
  28. package/patterns/filters.md +8 -8
  29. package/patterns/live-actions.md +5 -18
  30. package/patterns/minimal-foundation/PATTERN.md +98 -0
  31. package/patterns/minimal-foundation/example/.nvmrc +1 -0
  32. package/patterns/minimal-foundation/example/AGENTS.md +17 -0
  33. package/patterns/minimal-foundation/example/Procfile +2 -0
  34. package/patterns/minimal-foundation/example/app.json +14 -0
  35. package/patterns/minimal-foundation/example/bin/develop.js +71 -0
  36. package/patterns/minimal-foundation/example/bin/server.js +8 -0
  37. package/patterns/minimal-foundation/example/config/public.js +40 -0
  38. package/patterns/minimal-foundation/example/config/server.js +1 -0
  39. package/patterns/minimal-foundation/example/config/surfaceAccessPolicies.js +3 -0
  40. package/patterns/minimal-foundation/example/eslint.config.mjs +19 -0
  41. package/patterns/minimal-foundation/example/favicon.svg +7 -0
  42. package/patterns/minimal-foundation/example/gitignore +9 -0
  43. package/patterns/minimal-foundation/example/index.html +13 -0
  44. package/patterns/minimal-foundation/example/jsconfig.json +8 -0
  45. package/patterns/minimal-foundation/example/package.json +57 -0
  46. package/patterns/minimal-foundation/example/packages/main/package.json +42 -0
  47. package/patterns/minimal-foundation/example/packages/main/src/shared/index.js +10 -0
  48. package/patterns/minimal-foundation/example/packages/main/src/shared/schemas/index.js +22 -0
  49. package/patterns/minimal-foundation/example/playwright.config.mjs +31 -0
  50. package/patterns/minimal-foundation/example/server/lib/runtimeEnv.js +45 -0
  51. package/patterns/minimal-foundation/example/server/lib/surfaceRuntime.js +10 -0
  52. package/patterns/minimal-foundation/example/server.js +195 -0
  53. package/patterns/minimal-foundation/example/src/App.vue +13 -0
  54. package/patterns/minimal-foundation/example/src/main.js +85 -0
  55. package/patterns/minimal-foundation/example/src/pages/home/index.vue +48 -0
  56. package/patterns/minimal-foundation/example/src/pages/home.vue +13 -0
  57. package/patterns/minimal-foundation/example/src/views/NotFound.vue +13 -0
  58. package/patterns/minimal-foundation/example/tests/client/smoke.vitest.js +7 -0
  59. package/patterns/minimal-foundation/example/tests/e2e/base-shell.spec.ts +23 -0
  60. package/patterns/minimal-foundation/example/tests/server/smoke.test.js +16 -0
  61. package/patterns/minimal-foundation/example/vite.config.mjs +81 -0
  62. package/patterns/page-scaffolding.md +20 -17
  63. package/patterns/placements.md +17 -15
  64. package/patterns/row-policies.md +4 -5
  65. package/patterns/server-search.md +3 -3
  66. package/patterns/shell-foundation/PATTERN.md +104 -0
  67. package/patterns/shell-foundation/example/.nvmrc +1 -0
  68. package/patterns/shell-foundation/example/AGENTS.md +17 -0
  69. package/patterns/shell-foundation/example/Procfile +2 -0
  70. package/patterns/shell-foundation/example/app.json +14 -0
  71. package/patterns/shell-foundation/example/bin/develop.js +71 -0
  72. package/patterns/shell-foundation/example/bin/server.js +8 -0
  73. package/patterns/shell-foundation/example/config/public.js +40 -0
  74. package/patterns/shell-foundation/example/config/server.js +1 -0
  75. package/patterns/shell-foundation/example/config/surfaceAccessPolicies.js +3 -0
  76. package/patterns/shell-foundation/example/eslint.config.mjs +19 -0
  77. package/patterns/shell-foundation/example/favicon.svg +7 -0
  78. package/patterns/shell-foundation/example/gitignore +9 -0
  79. package/patterns/shell-foundation/example/index.html +13 -0
  80. package/patterns/shell-foundation/example/jsconfig.json +8 -0
  81. package/patterns/shell-foundation/example/package.json +59 -0
  82. package/patterns/shell-foundation/example/packages/main/package.json +56 -0
  83. package/patterns/shell-foundation/example/packages/main/src/client/index.js +9 -0
  84. package/patterns/shell-foundation/example/packages/main/src/client/providers/MainClientProvider.js +18 -0
  85. package/patterns/shell-foundation/example/packages/main/src/shared/index.js +10 -0
  86. package/patterns/shell-foundation/example/packages/main/src/shared/schemas/index.js +22 -0
  87. package/patterns/shell-foundation/example/playwright.config.mjs +31 -0
  88. package/patterns/shell-foundation/example/server/lib/runtimeEnv.js +45 -0
  89. package/patterns/shell-foundation/example/server/lib/surfaceRuntime.js +10 -0
  90. package/patterns/shell-foundation/example/server.js +195 -0
  91. package/patterns/shell-foundation/example/src/App.vue +11 -0
  92. package/patterns/shell-foundation/example/src/components/ShellLayout.vue +12 -0
  93. package/patterns/shell-foundation/example/src/components/menus/MenuLinkItem.vue +30 -0
  94. package/patterns/shell-foundation/example/src/components/menus/SurfaceAwareMenuLinkItem.vue +42 -0
  95. package/patterns/shell-foundation/example/src/components/menus/TabLinkItem.vue +42 -0
  96. package/patterns/shell-foundation/example/src/error.js +19 -0
  97. package/patterns/shell-foundation/example/src/main.js +85 -0
  98. package/patterns/shell-foundation/example/src/pages/home/index.vue +116 -0
  99. package/patterns/shell-foundation/example/src/pages/home/settings/general/index.vue +40 -0
  100. package/patterns/shell-foundation/example/src/pages/home/settings/index.vue +7 -0
  101. package/patterns/shell-foundation/example/src/pages/home/settings.vue +109 -0
  102. package/patterns/shell-foundation/example/src/pages/home.vue +20 -0
  103. package/patterns/shell-foundation/example/src/placement.js +56 -0
  104. package/patterns/shell-foundation/example/src/placementTopology.js +149 -0
  105. package/patterns/shell-foundation/example/src/views/NotFound.vue +13 -0
  106. package/patterns/shell-foundation/example/tests/client/smoke.vitest.js +7 -0
  107. package/patterns/shell-foundation/example/tests/e2e/adaptive-shell.spec.ts +10 -0
  108. package/patterns/shell-foundation/example/tests/e2e/base-shell.spec.ts +23 -0
  109. package/patterns/shell-foundation/example/tests/server/smoke.test.js +16 -0
  110. package/patterns/shell-foundation/example/vite.config.mjs +81 -0
  111. package/patterns/ui-contract.md +56 -0
  112. package/patterns/ui-testing.md +10 -12
  113. package/reference/autogen/KERNEL_MAP.md +29 -107
  114. package/reference/autogen/PATTERN_INDEX.md +230 -0
  115. package/reference/autogen/README.md +4 -8
  116. package/reference/autogen/packages/agent-docs.md +259 -0
  117. package/reference/autogen/packages/assistant-core.md +3 -3
  118. package/reference/autogen/packages/assistant-runtime.md +32 -17
  119. package/reference/autogen/packages/auth-core.md +31 -33
  120. package/reference/autogen/packages/auth-provider-local-core.md +4 -12
  121. package/reference/autogen/packages/auth-provider-local-db-core.md +4 -4
  122. package/reference/autogen/packages/auth-provider-supabase-core.md +14 -18
  123. package/reference/autogen/packages/auth-web.md +42 -22
  124. package/reference/autogen/packages/console-core.md +8 -25
  125. package/reference/autogen/packages/console-web.md +5 -5
  126. package/reference/autogen/packages/crud-core.md +61 -17
  127. package/reference/autogen/packages/database-runtime-mysql.md +12 -2
  128. package/reference/autogen/packages/database-runtime-postgres.md +12 -2
  129. package/reference/autogen/packages/database-runtime.md +26 -25
  130. package/reference/autogen/packages/google-rewarded-core.md +19 -104
  131. package/reference/autogen/packages/http-runtime.md +4 -8
  132. package/reference/autogen/packages/http-web.md +32 -0
  133. package/reference/autogen/packages/json-rest-api-core.md +4 -6
  134. package/reference/autogen/packages/kernel.md +109 -390
  135. package/reference/autogen/packages/mobile-capacitor.md +2 -13
  136. package/reference/autogen/packages/realtime.md +29 -26
  137. package/reference/autogen/packages/resource-crud-core.md +6 -0
  138. package/reference/autogen/packages/shell-web.md +69 -54
  139. package/reference/autogen/packages/storage-runtime.md +3 -3
  140. package/reference/autogen/packages/uploads-image-web.md +0 -1
  141. package/reference/autogen/packages/uploads-runtime.md +3 -3
  142. package/reference/autogen/packages/users-core.md +45 -90
  143. package/reference/autogen/packages/users-web.md +5 -7
  144. package/reference/autogen/packages/workspaces-core.md +53 -74
  145. package/reference/autogen/packages/workspaces-web.md +15 -16
  146. package/reference/autogen/tooling/jskit-catalog.md +34 -0
  147. package/reference/autogen/tooling/testUtils.md +4 -4
  148. package/skills/jskit/SKILL.md +36 -28
  149. package/skills/jskit/agents/openai.yaml +2 -2
  150. package/skills/jskit/references/app-operations.md +68 -53
  151. package/skills/jskit/references/crud-operations.md +58 -106
  152. package/skills/jskit/references/material-3.md +105 -0
  153. package/skills/jskit/references/ui-operations.md +41 -44
  154. package/templates/app/AGENTS.md +7 -3
  155. package/guide/agent/app-setup/upgrade-beta-1-to-final.md +0 -252
  156. package/guide/agent/app-setup/working-with-the-jskit-cli.md +0 -325
  157. package/guide/agent/generators/advanced-cruds.md +0 -1935
  158. package/guide/agent/generators/crud-generators.md +0 -948
  159. package/guide/agent/generators/intro.md +0 -65
  160. package/guide/agent/generators/row-policies.md +0 -537
  161. package/guide/agent/generators/ui-generators.md +0 -690
  162. package/patterns/crud-scaffolding.md +0 -198
  163. package/patterns/generated-ui-contract-tracking.md +0 -66
  164. package/reference/autogen/packages/assistant.md +0 -68
  165. package/reference/autogen/packages/crud-server-generator.md +0 -215
  166. package/reference/autogen/packages/crud-ui-generator.md +0 -192
  167. package/reference/autogen/packages/feature-server-generator.md +0 -65
  168. package/reference/autogen/packages/ui-generator.md +0 -127
  169. package/reference/autogen/tooling/create-app.md +0 -317
  170. package/reference/autogen/tooling/jskit-cli.md +0 -933
  171. package/reference/autogen/tooling/test-support.md +0 -27
@@ -21,10 +21,6 @@ For the full repo inventory, read `reference/autogen/README.md` and the package
21
21
 
22
22
  ### support
23
23
 
24
- ### `support/containerToken.js`
25
- Exports
26
- - `isContainerToken(value)`
27
-
28
24
  ### `support/deepFreeze.js`
29
25
  Exports
30
26
  - `deepFreeze(value, seen = new WeakSet())`
@@ -33,35 +29,6 @@ Exports
33
29
  Exports
34
30
  - `formatDateTime(value, { fallback = "unknown" } = {})`
35
31
 
36
- ### `support/generatedUiContract.js`
37
- Exports
38
- - `GENERATED_UI_FORBIDDEN_CARD_SHELL_PATTERNS`
39
- - `GENERATED_UI_FORBIDDEN_LIVE_COPY_PATTERNS`
40
- - `GENERATED_UI_NAVIGATION_ROLE_DEFAULT`
41
- - `GENERATED_UI_NAVIGATION_ROLE_LINK_PLACEMENTS`
42
- - `GENERATED_UI_NAVIGATION_ROLE_OPTION`
43
- - `GENERATED_UI_NAVIGATION_ROLE_VALUES`
44
- - `GENERATED_UI_NO_LINK_NAVIGATION_ROLES`
45
- - `GENERATED_UI_SOURCE_CONTRACT_PROFILES`
46
- - `GENERATED_UI_SURFACE_PROFILES`
47
- - `assertGeneratedUiSourceContract(source = "", options = {})`
48
- - `buildGeneratedUiScreenClassName(baseClassName = "", { surfaceProfile = "" } = {})`
49
- - `collectGeneratedUiSourceContractIssues(source = "", { profile = "", forbidLiveCopy = undefined, forbidCardShell = undefined, forbiddenPatterns = [], requiredPatterns = [] } = {})`
50
- - `inferGeneratedUiNavigationRole(options = {}, { dynamicRoutePolicy = "leaf", routePath = "" } = {})`
51
- - `isGeneratedUiNoLinkNavigationRole(value = "")`
52
- - `normalizeGeneratedUiNavigationRole(value = "")`
53
- - `resolveGeneratedUiSurfaceProfile(surfaceProfile = "")`
54
- - `resolveGeneratedUiNavigationRoleLinkPlacement(options = {}, inferenceContext = {})`
55
- - `shouldCreateGeneratedUiNavigationLink(options = {}, { allowLinkTo = false, dynamicRoutePolicy = "leaf", routePath = "" } = {})`
56
- Local functions
57
- - `matchesGeneratedUiContractPattern(source = "", pattern)`
58
- - `normalizeGeneratedUiContractPattern(patternEntry = {}, fallbackMessage = "")`
59
- - `normalizeGeneratedUiContractPatternList(patternEntries = [], fallbackMessage = "")`
60
- - `resolveGeneratedUiSourceContractProfile(profile = "")`
61
- - `hasExplicitGeneratedUiNavigationRole(options = {})`
62
- - `normalizeGeneratedUiRouteSegments(routePath = "")`
63
- - `isGeneratedUiDynamicRouteSegment(routeSegment = "")`
64
-
65
32
  ### `support/index.js`
66
33
  Exports
67
34
  - `isRecord`
@@ -209,10 +176,6 @@ Exports
209
176
  - `toCamelCase(value = "")`
210
177
  - `toSnakeCase(value = "")`
211
178
 
212
- ### `support/tokens.js`
213
- Exports
214
- - `isContainerToken`
215
-
216
179
  ### `support/visibility.js`
217
180
  Exports
218
181
  - `ROUTE_VISIBILITY_LEVELS`
@@ -429,6 +392,7 @@ Local functions
429
392
  - `normalizeAuditConfig(audit, { actionId })`
430
393
  - `normalizeObservabilityConfig(observability)`
431
394
  - `normalizeActionExtensions(value)`
395
+ - `normalizeActionEvents(value, actionId)`
432
396
 
433
397
  ### `actions/audit.js`
434
398
  Exports
@@ -453,19 +417,15 @@ Exports
453
417
  Local functions
454
418
  - `resolveRequestIdempotencyKey(context)`
455
419
 
456
- ### `actions/index.js`
457
- Exports
458
- - `normalizeActionDefinition`
459
- - `withActionDefaults`
460
-
461
420
  ### `actions/observability.js`
462
421
  Exports
463
422
  - `createNoopObservabilityAdapter()`
464
423
 
465
424
  ### `actions/pipeline.js`
466
425
  Exports
467
- - `executeActionPipeline({ definition, input, context, deps = {}, idempotencyAdapter, auditAdapter, observabilityAdapter, logger = console } = {})`
426
+ - `executeActionPipeline({ definition, input, context, deps = {}, idempotencyAdapter, auditAdapter, observabilityAdapter, events, logger = console } = {})`
468
427
  Local functions
428
+ - `publishActionEvents(events, builders, execution)`
469
429
  - `normalizeOutcomeErrorCode(error)`
470
430
  - `buildActionLogPayload({ definition, context, outcome, durationMs, errorCode, idempotencyReplay })`
471
431
  - `emitAuditEvent(adapter, payload)`
@@ -484,7 +444,7 @@ Local functions
484
444
 
485
445
  ### `actions/registry.js`
486
446
  Exports
487
- - `createActionRegistry({ contributors = [], idempotencyAdapter, auditAdapter, observabilityAdapter, logger = console } = {})`
447
+ - `createActionRegistry({ contributors = [], idempotencyAdapter, auditAdapter, observabilityAdapter, events, logger = console } = {})`
488
448
  - `__testables`
489
449
  Local functions
490
450
  - `normalizeContributors(contributors)`
@@ -505,74 +465,36 @@ Exports
505
465
  Exports
506
466
  - `withActionDefaults(actions = [], defaults = {})`
507
467
 
508
- ### runtime
468
+ ### root
509
469
 
510
- ### `runtime/application.js`
470
+ ### `index.js`
511
471
  Exports
512
- - `Application`
513
- - `createApplication(options = {})`
514
- - `createProviderClass({ id, startsAfter = [], register = null, boot = null, shutdown = null } = {})`
515
- Local functions
516
- - `normalizeStringArray(value)`
517
- - `nowMilliseconds()`
518
- - `createProviderLifecycleError(providerId, phase, cause)`
472
+ - `resolveLinkPath`
473
+ - `normalizePathname`
519
474
 
520
- ### `runtime/container.js`
475
+ ### capabilities
476
+
477
+ ### `capabilities/defineProvider.js`
521
478
  Exports
522
- - `Container`
523
- - `createContainer(options = {})`
524
- - `tokenLabel(token)`
479
+ - `defineProvider({ id, requires = {}, optional = {}, provides = {}, setup, boot = null, shutdown = null } = {})`
480
+ - `normalizeArchitectureId(value, label)`
525
481
  Local functions
526
- - `normalizeToken(token)`
527
- - `ensureFactory(factory, token)`
528
- - `normalizeTagName(tagName)`
529
- - `normalizeScopeId(scopeId)`
530
-
531
- ### `runtime/containerErrors.js`
532
- Exports
533
- - `ContainerError`
534
- - `InvalidTokenError`
535
- - `InvalidFactoryError`
536
- - `DuplicateBindingError`
537
- - `UnresolvedTokenError`
538
- - `CircularDependencyError`
539
-
540
- ### `runtime/index.js`
541
- Exports
542
- - `Container`
543
- - `createContainer`
544
- - `tokenLabel`
545
- - `ContainerError`
546
- - `InvalidTokenError`
547
- - `InvalidFactoryError`
548
- - `DuplicateBindingError`
549
- - `UnresolvedTokenError`
550
- - `CircularDependencyError`
551
- - `Application`
552
- - `createApplication`
553
- - `createProviderClass`
554
- - `ServiceProvider`
555
- - `KernelError`
556
- - `ProviderNormalizationError`
557
- - `DuplicateProviderError`
558
- - `ProviderStartOrderError`
559
- - `ProviderLifecycleError`
560
-
561
- ### `runtime/kernelErrors.js`
562
- Exports
563
- - `KernelError`
564
- - `ProviderNormalizationError`
565
- - `DuplicateProviderError`
566
- - `ProviderStartOrderError`
567
- - `ProviderLifecycleError`
568
-
569
- ### `runtime/serviceProvider.js`
570
- Exports
571
- - `ServiceProvider`
482
+ - `normalizeCapabilityMap(value, label)`
483
+ - `assertDistinctLocalNames(maps)`
484
+ - `normalizeLifecycleMethod(value, label)`
572
485
 
573
- ### root
486
+ ### `capabilities/index.js`
487
+ Exports
488
+ - `defineProvider`
489
+ - `createCapabilityRuntime`
574
490
 
575
- ### `index.js`
491
+ ### `capabilities/runtime.js`
576
492
  Exports
577
- - `resolveLinkPath`
578
- - `normalizePathname`
493
+ - `createCapabilityRuntime({ providers = [], inputs = {}, profile = "" } = {})`
494
+ Local functions
495
+ - `normalizeProviderDefinition(value)`
496
+ - `normalizeInputCapabilities(value)`
497
+ - `providerCapabilityIds(provider, field)`
498
+ - `buildProviderOrder(providers, inputCapabilities)`
499
+ - `resolveProviderDependencies(provider, capabilities)`
500
+ - `normalizeProviderOutputs(provider, value)`
@@ -0,0 +1,230 @@
1
+ # JSKIT Source Pattern Index
2
+
3
+ Generated by `npm run agent-docs:build`.
4
+ Do not edit manually.
5
+
6
+ Patterns are ordinary package-owned Markdown and example files. Read the matching `PATTERN.md` completely, then use its example directly, adapt it, compose it with compatible patterns, or treat it as framework evidence. Copied source belongs to the application immediately.
7
+
8
+ Do not create or consult receipts recording that a pattern was used. Current source and verification are the evidence.
9
+
10
+ Resolve an installed pattern from the project root as `node_modules/<package-id>/<document-path>`. Example files are beside it under the listed example path.
11
+
12
+ ## Minimal JSKIT application foundation
13
+
14
+ A concrete Fastify, Vue, and JSKIT application foundation for products that do not yet need the full adaptive shell.
15
+
16
+ - Id: `app/minimal-foundation`
17
+ - Keywords: `app`, `fastify`, `foundation`, `minimal`, `server`, `vite`, `vue`
18
+ - Owner: `@jskit-ai/agent-docs@0.1.132`
19
+ - Read: `node_modules/@jskit-ai/agent-docs/patterns/minimal-foundation/PATTERN.md`
20
+ - Examples: `node_modules/@jskit-ai/agent-docs/patterns/minimal-foundation/example/`
21
+ - Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`
22
+
23
+ ## Adaptive-shell JSKIT application foundation
24
+
25
+ A concrete JSKIT web application foundation with responsive shell navigation, settings, placements, and browser verification.
26
+
27
+ - Id: `app/shell-foundation`
28
+ - Keywords: `app`, `foundation`, `material`, `navigation`, `placements`, `shell`, `vite`, `vue`
29
+ - Owner: `@jskit-ai/agent-docs@0.1.132`
30
+ - Read: `node_modules/@jskit-ai/agent-docs/patterns/shell-foundation/PATTERN.md`
31
+ - Examples: `node_modules/@jskit-ai/agent-docs/patterns/shell-foundation/example/`
32
+ - Requires: `@jskit-ai/http-runtime`, `@jskit-ai/kernel`, `@jskit-ai/shell-web`
33
+
34
+ ## Assistant surface and settings
35
+
36
+ Configure an assistant runtime for one application surface and expose its chat and settings elements through ordinary pages and placements.
37
+
38
+ - Id: `assistant/assistant-surface`
39
+ - Keywords: `ai`, `assistant`, `chat`, `config`, `environment`, `page`, `placement`, `settings`, `surface`
40
+ - Owner: `@jskit-ai/assistant-runtime@0.1.131`
41
+ - Read: `node_modules/@jskit-ai/assistant-runtime/patterns/assistant-surface/PATTERN.md`
42
+ - Examples: `node_modules/@jskit-ai/assistant-runtime/patterns/assistant-surface/example/`
43
+ - Requires: `@jskit-ai/assistant-runtime`, `@jskit-ai/shell-web`
44
+
45
+ ## Authentication surface
46
+
47
+ Compose JSKIT authentication routes, views, profile controls, and public surface configuration without generated source.
48
+
49
+ - Id: `auth/auth-surface`
50
+ - Keywords: `account`, `auth`, `login`, `logout`, `password`, `placement`, `profile`, `reset`, `surface`
51
+ - Owner: `@jskit-ai/auth-web@0.1.160`
52
+ - Read: `node_modules/@jskit-ai/auth-web/patterns/auth-surface/PATTERN.md`
53
+ - Examples: `node_modules/@jskit-ai/auth-web/patterns/auth-surface/example/`
54
+ - Requires: `@jskit-ai/auth-core`, `@jskit-ai/auth-web`, `@jskit-ai/shell-web`
55
+
56
+ ## Supabase authentication
57
+
58
+ Add Supabase authentication through normal npm composition, explicit environment values, and app-owned auth policy.
59
+
60
+ - Id: `auth/supabase-auth`
61
+ - Keywords: `auth`, `authentication`, `oauth`, `sessions`, `supabase`
62
+ - Owner: `@jskit-ai/auth-provider-supabase-core@0.1.157`
63
+ - Read: `node_modules/@jskit-ai/auth-provider-supabase-core/patterns/supabase-auth/PATTERN.md`
64
+ - Examples: `node_modules/@jskit-ai/auth-provider-supabase-core/patterns/supabase-auth/example/`
65
+ - Requires: `@jskit-ai/auth-provider-supabase-core`
66
+
67
+ ## Owner console surface
68
+
69
+ Add a protected administration surface, settings shell, and semantic navigation through JSKIT console and shell APIs.
70
+
71
+ - Id: `console/console-surface`
72
+ - Keywords: `admin`, `console`, `navigation`, `owner`, `placement`, `settings`, `surface`
73
+ - Owner: `@jskit-ai/console-web@0.1.128`
74
+ - Read: `node_modules/@jskit-ai/console-web/patterns/console-surface/PATTERN.md`
75
+ - Examples: `node_modules/@jskit-ai/console-web/patterns/console-surface/example/`
76
+ - Requires: `@jskit-ai/console-core`, `@jskit-ai/console-web`, `@jskit-ai/shell-web`
77
+
78
+ ## CRUD list, view, create, and edit screens
79
+
80
+ Build a routed CRUD user interface as thin application pages over JSKIT's shared screen components and composables.
81
+
82
+ - Id: `crud/crud-screen-set`
83
+ - Keywords: `actions`, `add`, `crud`, `delete`, `edit`, `filters`, `list`, `material`, `routes`, `view`, `vue`
84
+ - Owner: `@jskit-ai/http-web@0.1.5`
85
+ - Read: `node_modules/@jskit-ai/http-web/patterns/crud-screen-set/PATTERN.md`
86
+ - Examples: `node_modules/@jskit-ai/http-web/patterns/crud-screen-set/example/`
87
+ - Requires: `@jskit-ai/http-web`, `@jskit-ai/resource-crud-core`
88
+
89
+ ## JSON API CRUD resource package
90
+
91
+ Build a complete application-owned CRUD server package from a migration, resource contract, and one framework module declaration.
92
+
93
+ - Id: `crud/json-api-resource-package`
94
+ - Keywords: `actions`, `crud`, `database`, `json-api`, `migration`, `permissions`, `provider`, `repository`, `routes`, `service`
95
+ - Owner: `@jskit-ai/crud-core@0.1.171`
96
+ - Read: `node_modules/@jskit-ai/crud-core/patterns/json-api-resource-package/PATTERN.md`
97
+ - Examples: `node_modules/@jskit-ai/crud-core/patterns/json-api-resource-package/example/`
98
+ - Requires: `@jskit-ai/crud-core`, `@jskit-ai/resource-crud-core`
99
+
100
+ ## Owner-scoped CRUD resource contract
101
+
102
+ Define an authenticated application resource whose records belong to the current user.
103
+
104
+ - Id: `crud/resource-contract`
105
+ - Keywords: `authenticated`, `crud`, `database`, `owner-scoped`, `resource`, `user`
106
+ - Owner: `@jskit-ai/resource-crud-core@0.1.102`
107
+ - Read: `node_modules/@jskit-ai/resource-crud-core/patterns/resource-contract/PATTERN.md`
108
+ - Examples: `node_modules/@jskit-ai/resource-crud-core/patterns/resource-contract/example/`
109
+ - Requires: `@jskit-ai/resource-crud-core`
110
+
111
+ ## MySQL application database
112
+
113
+ Configure a JSKIT application for MySQL with a fixed driver, ordinary environment values, and rebuildable Knex migrations.
114
+
115
+ - Id: `database/mysql-application`
116
+ - Keywords: `database`, `knex`, `mariadb`, `migrations`, `mysql`, `mysql2`
117
+ - Owner: `@jskit-ai/database-runtime-mysql@0.1.158`
118
+ - Read: `node_modules/@jskit-ai/database-runtime-mysql/patterns/mysql-application/PATTERN.md`
119
+ - Examples: `node_modules/@jskit-ai/database-runtime-mysql/patterns/mysql-application/example/`
120
+ - Requires: `@jskit-ai/database-runtime-mysql`
121
+
122
+ ## PostgreSQL application database
123
+
124
+ Configure a JSKIT application for PostgreSQL with a fixed driver, ordinary environment values, and rebuildable Knex migrations.
125
+
126
+ - Id: `database/postgres-application`
127
+ - Keywords: `database`, `knex`, `migrations`, `pg`, `postgres`, `postgresql`
128
+ - Owner: `@jskit-ai/database-runtime-postgres@0.1.157`
129
+ - Read: `node_modules/@jskit-ai/database-runtime-postgres/patterns/postgres-application/PATTERN.md`
130
+ - Examples: `node_modules/@jskit-ai/database-runtime-postgres/patterns/postgres-application/example/`
131
+ - Requires: `@jskit-ai/database-runtime-postgres`
132
+
133
+ ## Capacitor Android application
134
+
135
+ Wrap a JSKIT web application in a Capacitor Android shell using native Capacitor and Android commands.
136
+
137
+ - Id: `mobile/android-application`
138
+ - Keywords: `android`, `capacitor`, `device`, `mobile`, `native`, `shell`, `webview`
139
+ - Owner: `@jskit-ai/mobile-capacitor@0.1.95`
140
+ - Read: `node_modules/@jskit-ai/mobile-capacitor/patterns/android-application/PATTERN.md`
141
+ - Examples: `node_modules/@jskit-ai/mobile-capacitor/patterns/android-application/example/`
142
+ - Requires: `@capacitor/android`, `@capacitor/app`, `@capacitor/cli`, `@jskit-ai/mobile-capacitor`
143
+
144
+ ## Realtime application
145
+
146
+ Add JSKIT realtime events with an optional Redis backplane and an explicit shell status contribution.
147
+
148
+ - Id: `realtime/realtime-application`
149
+ - Keywords: `realtime`, `redis`, `socket.io`, `sockets`, `status`, `websocket`
150
+ - Owner: `@jskit-ai/realtime@0.1.157`
151
+ - Read: `node_modules/@jskit-ai/realtime/patterns/realtime-application/PATTERN.md`
152
+ - Examples: `node_modules/@jskit-ai/realtime/patterns/realtime-application/example/`
153
+ - Requires: `@jskit-ai/realtime`, `@jskit-ai/shell-web`
154
+
155
+ ## App-local server feature package
156
+
157
+ Define a server feature through explicit capabilities and first-class actions, adding services or repositories only when its domain earns them.
158
+
159
+ - Id: `server/feature-package`
160
+ - Keywords: `actions`, `feature`, `json-rest`, `knex`, `orchestration`, `package`, `provider`, `repository`, `routes`, `server`
161
+ - Owner: `@jskit-ai/agent-docs@0.1.132`
162
+ - Read: `node_modules/@jskit-ai/agent-docs/patterns/feature-package/PATTERN.md`
163
+ - Examples: `node_modules/@jskit-ai/agent-docs/patterns/feature-package/example/`
164
+ - Requires: `@jskit-ai/kernel`
165
+
166
+ ## Responsive application shell
167
+
168
+ Compose the JSKIT responsive shell, semantic placements, settings navigation, and accessible adaptive-shell browser checks.
169
+
170
+ - Id: `shell/application-shell`
171
+ - Keywords: `adaptive`, `app`, `layout`, `navigation`, `placement`, `responsive`, `settings`, `shell`
172
+ - Owner: `@jskit-ai/shell-web@0.1.164`
173
+ - Read: `node_modules/@jskit-ai/shell-web/patterns/application-shell/PATTERN.md`
174
+ - Examples: `node_modules/@jskit-ai/shell-web/patterns/application-shell/example/`
175
+ - Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
176
+
177
+ ## Routed page, section navigation, and placed element
178
+
179
+ Add product routes and shell extensions through file routing, semantic placements, topology, and registered component tokens.
180
+
181
+ - Id: `ui/page-and-placement`
182
+ - Keywords: `component`, `navigation`, `outlet`, `page`, `placement`, `routes`, `section`, `shell`, `subpages`, `vue`
183
+ - Owner: `@jskit-ai/shell-web@0.1.164`
184
+ - Read: `node_modules/@jskit-ai/shell-web/patterns/page-and-placement/PATTERN.md`
185
+ - Examples: `node_modules/@jskit-ai/shell-web/patterns/page-and-placement/example/`
186
+ - Requires: `@jskit-ai/kernel`, `@jskit-ai/shell-web`
187
+
188
+ ## Account settings surface
189
+
190
+ Compose an account settings route and profile, preference, and notification sections from JSKIT user web components.
191
+
192
+ - Id: `users/account-settings`
193
+ - Keywords: `account`, `notifications`, `preferences`, `profile`, `settings`, `user`, `vue`
194
+ - Owner: `@jskit-ai/users-web@0.1.178`
195
+ - Read: `node_modules/@jskit-ai/users-web/patterns/account-settings/PATTERN.md`
196
+ - Examples: `node_modules/@jskit-ai/users-web/patterns/account-settings/example/`
197
+ - Requires: `@jskit-ai/shell-web`, `@jskit-ai/users-core`, `@jskit-ai/users-web`
198
+
199
+ ## User administration server package
200
+
201
+ Expose user administration and workspace-scoped member operations through app-owned packages backed by JSKIT users runtime APIs.
202
+
203
+ - Id: `users/user-administration-server`
204
+ - Keywords: `account`, `admin`, `member`, `repository`, `resource`, `routes`, `service`, `user`, `workspace`
205
+ - Owner: `@jskit-ai/users-core@0.1.173`
206
+ - Read: `node_modules/@jskit-ai/users-core/patterns/user-administration-server/PATTERN.md`
207
+ - Examples: `node_modules/@jskit-ai/users-core/patterns/user-administration-server/example/`
208
+ - Requires: `@jskit-ai/crud-core`, `@jskit-ai/users-core`
209
+
210
+ ## Workspace tenancy server composition
211
+
212
+ Configure roles, workspace access policy, invitations, and app-owned invitation email rendering around JSKIT workspace runtime APIs.
213
+
214
+ - Id: `workspaces/workspace-server`
215
+ - Keywords: `access`, `invite`, `membership`, `multitenancy`, `policy`, `role`, `tenancy`, `workspace`
216
+ - Owner: `@jskit-ai/workspaces-core@0.1.138`
217
+ - Read: `node_modules/@jskit-ai/workspaces-core/patterns/workspace-server/PATTERN.md`
218
+ - Examples: `node_modules/@jskit-ai/workspaces-core/patterns/workspace-server/example/`
219
+ - Requires: `@jskit-ai/users-core`, `@jskit-ai/workspaces-core`
220
+
221
+ ## Workspace application and administration surfaces
222
+
223
+ Compose workspace selection, invitation, member administration, settings, and responsive navigation using JSKIT workspace web APIs.
224
+
225
+ - Id: `workspaces/workspace-surfaces`
226
+ - Keywords: `admin`, `invite`, `member`, `navigation`, `settings`, `surface`, `switcher`, `workspace`
227
+ - Owner: `@jskit-ai/workspaces-web@0.1.139`
228
+ - Read: `node_modules/@jskit-ai/workspaces-web/patterns/workspace-surfaces/PATTERN.md`
229
+ - Examples: `node_modules/@jskit-ai/workspaces-web/patterns/workspace-surfaces/example/`
230
+ - Requires: `@jskit-ai/shell-web`, `@jskit-ai/workspaces-core`, `@jskit-ai/workspaces-web`
@@ -5,10 +5,13 @@ Do not edit manually.
5
5
 
6
6
  This directory contains generated, on-demand package maps.
7
7
  Startup navigation stays in `KERNEL_MAP.md`.
8
+ AI-first source patterns are indexed in `PATTERN_INDEX.md`.
9
+
10
+ ## Pattern Index
11
+ - [Published source patterns](/packages/agent-docs/reference/autogen/PATTERN_INDEX.md)
8
12
 
9
13
  ## Package Maps
10
14
  - [agent-docs](/packages/agent-docs/reference/autogen/packages/agent-docs.md)
11
- - [assistant](/packages/agent-docs/reference/autogen/packages/assistant.md)
12
15
  - [assistant-core](/packages/agent-docs/reference/autogen/packages/assistant-core.md)
13
16
  - [assistant-runtime](/packages/agent-docs/reference/autogen/packages/assistant-runtime.md)
14
17
  - [auth-core](/packages/agent-docs/reference/autogen/packages/auth-core.md)
@@ -19,12 +22,9 @@ Startup navigation stays in `KERNEL_MAP.md`.
19
22
  - [console-core](/packages/agent-docs/reference/autogen/packages/console-core.md)
20
23
  - [console-web](/packages/agent-docs/reference/autogen/packages/console-web.md)
21
24
  - [crud-core](/packages/agent-docs/reference/autogen/packages/crud-core.md)
22
- - [crud-server-generator](/packages/agent-docs/reference/autogen/packages/crud-server-generator.md)
23
- - [crud-ui-generator](/packages/agent-docs/reference/autogen/packages/crud-ui-generator.md)
24
25
  - [database-runtime](/packages/agent-docs/reference/autogen/packages/database-runtime.md)
25
26
  - [database-runtime-mysql](/packages/agent-docs/reference/autogen/packages/database-runtime-mysql.md)
26
27
  - [database-runtime-postgres](/packages/agent-docs/reference/autogen/packages/database-runtime-postgres.md)
27
- - [feature-server-generator](/packages/agent-docs/reference/autogen/packages/feature-server-generator.md)
28
28
  - [google-rewarded-core](/packages/agent-docs/reference/autogen/packages/google-rewarded-core.md)
29
29
  - [google-rewarded-web](/packages/agent-docs/reference/autogen/packages/google-rewarded-web.md)
30
30
  - [http-runtime](/packages/agent-docs/reference/autogen/packages/http-runtime.md)
@@ -37,7 +37,6 @@ Startup navigation stays in `KERNEL_MAP.md`.
37
37
  - [resource-crud-core](/packages/agent-docs/reference/autogen/packages/resource-crud-core.md)
38
38
  - [shell-web](/packages/agent-docs/reference/autogen/packages/shell-web.md)
39
39
  - [storage-runtime](/packages/agent-docs/reference/autogen/packages/storage-runtime.md)
40
- - [ui-generator](/packages/agent-docs/reference/autogen/packages/ui-generator.md)
41
40
  - [uploads-image-web](/packages/agent-docs/reference/autogen/packages/uploads-image-web.md)
42
41
  - [uploads-runtime](/packages/agent-docs/reference/autogen/packages/uploads-runtime.md)
43
42
  - [users-core](/packages/agent-docs/reference/autogen/packages/users-core.md)
@@ -47,8 +46,5 @@ Startup navigation stays in `KERNEL_MAP.md`.
47
46
 
48
47
  ## Tooling Maps
49
48
  - [config-eslint](/packages/agent-docs/reference/autogen/tooling/config-eslint.md)
50
- - [create-app](/packages/agent-docs/reference/autogen/tooling/create-app.md)
51
49
  - [jskit-catalog](/packages/agent-docs/reference/autogen/tooling/jskit-catalog.md)
52
- - [jskit-cli](/packages/agent-docs/reference/autogen/tooling/jskit-cli.md)
53
- - [test-support](/packages/agent-docs/reference/autogen/tooling/test-support.md)
54
50
  - [testUtils](/packages/agent-docs/reference/autogen/tooling/testUtils.md)