@jskit-ai/agent-docs 0.1.119 → 0.1.120

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 (63) hide show
  1. package/guide/agent/app-extras/assistant.md +0 -1
  2. package/guide/agent/app-extras/mobile-capacitor.md +3 -3
  3. package/guide/agent/app-extras/realtime.md +1 -2
  4. package/guide/agent/app-setup/a-more-interesting-shell.md +6 -7
  5. package/guide/agent/app-setup/authentication.md +7 -15
  6. package/guide/agent/app-setup/console.md +0 -1
  7. package/guide/agent/app-setup/database-layer.md +15 -18
  8. package/guide/agent/app-setup/initial-scaffolding.md +61 -101
  9. package/guide/agent/app-setup/multi-homing.md +2 -10
  10. package/guide/agent/app-setup/quickstart.md +0 -1
  11. package/guide/agent/app-setup/upgrade-beta-1-to-final.md +134 -0
  12. package/guide/agent/app-setup/users.md +8 -15
  13. package/guide/agent/app-setup/working-with-the-jskit-cli.md +168 -997
  14. package/guide/agent/generators/advanced-cruds.md +2 -3
  15. package/guide/agent/generators/crud-generators.md +27 -54
  16. package/guide/agent/generators/row-policies.md +1 -1
  17. package/package.json +1 -1
  18. package/patterns/INDEX.md +1 -1
  19. package/patterns/crud-scaffolding.md +9 -10
  20. package/patterns/generated-ui-contract-tracking.md +3 -3
  21. package/patterns/live-actions.md +5 -4
  22. package/patterns/ui-testing.md +8 -15
  23. package/reference/autogen/packages/assistant-core.md +0 -6
  24. package/reference/autogen/packages/assistant-runtime.md +0 -6
  25. package/reference/autogen/packages/assistant.md +0 -6
  26. package/reference/autogen/packages/auth-core.md +0 -6
  27. package/reference/autogen/packages/auth-provider-local-core.md +0 -6
  28. package/reference/autogen/packages/auth-provider-local-db-core.md +0 -6
  29. package/reference/autogen/packages/auth-provider-supabase-core.md +0 -6
  30. package/reference/autogen/packages/auth-web.md +0 -6
  31. package/reference/autogen/packages/console-core.md +0 -6
  32. package/reference/autogen/packages/console-web.md +0 -6
  33. package/reference/autogen/packages/crud-core.md +0 -6
  34. package/reference/autogen/packages/crud-server-generator.md +0 -10
  35. package/reference/autogen/packages/crud-ui-generator.md +1 -8
  36. package/reference/autogen/packages/database-runtime-mysql.md +0 -6
  37. package/reference/autogen/packages/database-runtime-postgres.md +0 -6
  38. package/reference/autogen/packages/database-runtime.md +0 -6
  39. package/reference/autogen/packages/feature-server-generator.md +1 -11
  40. package/reference/autogen/packages/google-rewarded-core.md +0 -6
  41. package/reference/autogen/packages/google-rewarded-web.md +0 -6
  42. package/reference/autogen/packages/http-runtime.md +0 -6
  43. package/reference/autogen/packages/json-rest-api-core.md +0 -6
  44. package/reference/autogen/packages/kernel.md +45 -42
  45. package/reference/autogen/packages/mobile-capacitor.md +0 -6
  46. package/reference/autogen/packages/realtime.md +0 -6
  47. package/reference/autogen/packages/resource-core.md +0 -6
  48. package/reference/autogen/packages/resource-crud-core.md +0 -6
  49. package/reference/autogen/packages/shell-web.md +0 -6
  50. package/reference/autogen/packages/storage-runtime.md +0 -6
  51. package/reference/autogen/packages/ui-generator.md +0 -6
  52. package/reference/autogen/packages/uploads-image-web.md +0 -6
  53. package/reference/autogen/packages/uploads-runtime.md +0 -6
  54. package/reference/autogen/packages/users-core.md +0 -14
  55. package/reference/autogen/packages/users-web.md +8 -6
  56. package/reference/autogen/packages/workspaces-core.md +0 -6
  57. package/reference/autogen/packages/workspaces-web.md +0 -6
  58. package/reference/autogen/tooling/create-app.md +0 -14
  59. package/reference/autogen/tooling/jskit-cli.md +65 -190
  60. package/reference/autogen/tooling/testUtils.md +14 -0
  61. package/skills/jskit/SKILL.md +4 -4
  62. package/skills/jskit/references/crud-operations.md +7 -6
  63. package/skills/jskit/references/ui-operations.md +5 -9
@@ -682,13 +682,6 @@ Local functions
682
682
  Exports
683
683
  - `createComponentInteractionEmitter(emit)`
684
684
 
685
- ### `client/descriptorSections.js`
686
- Exports
687
- - `normalizeDescriptorUiRoutes(value)`
688
- - `normalizeDescriptorClientProviders(value)`
689
- - `normalizeDescriptorClientOptimizeSpecifiers(value)`
690
- - `normalizeClientDescriptorSections(descriptorValue)`
691
-
692
685
  ### `client/index.js`
693
686
  Exports
694
687
  - `getClientAppConfig`
@@ -733,17 +726,24 @@ Local functions
733
726
  - `normalizeRoute(route, { packageId, index })`
734
727
  - `normalizeRouteList(routes, { packageId })`
735
728
  - `toVueRouteRecord(route)`
736
- - `registerClientModuleRoutes({ packageId, routes = [], router, surfaceRuntime, surfaceMode, seenRoutePaths, seenRouteNames, logger = null, source = "module", descriptorRouteDeclarations = null } = {})`
729
+ - `registerClientModuleRoutes({ packageId, routes = [], router, surfaceRuntime, surfaceMode, seenRoutePaths, seenRouteNames, logger = null, source = "module", packageMetadataRouteDeclarations = null } = {})`
737
730
  - `isProviderClass(candidate)`
738
731
  - `normalizeExplicitProviderClasses(value, packageId)`
739
- - `resolveDescriptorProviderClasses(moduleNamespace, packageId, descriptorClientProviders = [])`
740
- - `resolveModuleProviderClasses(moduleNamespace, packageId, descriptorClientProviders = [])`
741
- - `buildDescriptorRouteDeclarationIndex({ packageId, descriptorUiRoutes = [] } = {})`
742
- - `assertRoutesDeclaredInDescriptor({ packageId, source, normalizedRoutes = [], descriptorRouteDeclarations = null } = {})`
743
- - `resolveDescriptorClientRoutes({ packageId, descriptorUiRoutes = [], routeComponents = {}, logger = null } = {})`
732
+ - `resolvePackageMetadataProviderClasses(moduleNamespace, packageId, packageMetadataClientProviders = [])`
733
+ - `resolveModuleProviderClasses(moduleNamespace, packageId, packageMetadataClientProviders = [])`
734
+ - `buildPackageMetadataRouteDeclarationIndex({ packageId, packageMetadataUiRoutes = [] } = {})`
735
+ - `assertRoutesDeclaredInPackageMetadata({ packageId, source, normalizedRoutes = [], packageMetadataRouteDeclarations = null } = {})`
736
+ - `resolvePackageMetadataClientRoutes({ packageId, packageMetadataUiRoutes = [], routeComponents = {}, logger = null } = {})`
744
737
  - `normalizeClientModuleEntries(clientModules)`
745
738
  - `createClientRuntimeApp({ profile = "client", app, pinia = null, queryClient = null, router, env, logger, surfaceRuntime, surfaceMode } = {})`
746
739
 
740
+ ### `client/packageMetadataSections.js`
741
+ Exports
742
+ - `normalizePackageMetadataUiRoutes(value)`
743
+ - `normalizePackageMetadataClientProviders(value)`
744
+ - `normalizePackageMetadataClientOptimizeSpecifiers(value)`
745
+ - `normalizeClientPackageMetadataSections(packageMetadataValue)`
746
+
747
747
  ### `client/pageRedirects.js`
748
748
  Exports
749
749
  - `redirectToChild(childTarget = "")`
@@ -794,19 +794,19 @@ Exports
794
794
  - `resolveClientOptimizeExcludeSpecifiers(clientModules = [])`
795
795
  - `resolveCanonicalLocalPackageId(resolvedId, localPackage)`
796
796
  - `resolveLocalPackageForSpecifier(source, localPackages = [])`
797
- - `resolveLocalPackageSources({ appRoot, lockPath })`
797
+ - `resolveLocalPackageSources({ appRoot })`
798
798
  - `resolveLocalScopeOptimizeExcludeSpecifiers(localScopePackageIds = [])`
799
799
  - `resolveInstalledClientPackageIds(options)`
800
- - `resolveLocalScopePackageIds({ appRoot, lockPath })`
801
- - `resolveInstalledClientModules({ appRoot, lockPath })`
802
- - `createJskitClientBootstrapPlugin({ lockPath = ".jskit/lock.json" } = {})`
800
+ - `resolveLocalScopePackageIds({ appRoot })`
801
+ - `resolveInstalledClientModules({ appRoot })`
802
+ - `createJskitClientBootstrapPlugin()`
803
803
  Local functions
804
804
  - `isLocalScopePackageId(value)`
805
805
  - `readJsonFile(filePath, fallback)`
806
806
  - `hasClientExport(packageJson)`
807
807
  - `isPathInsideRoot(rootPath, candidatePath)`
808
808
  - `splitSpecifierSuffix(source)`
809
- - `normalizeClientModuleDescriptors(value)`
809
+ - `normalizeClientModulePackageMetadataEntries(value)`
810
810
  - `resolveClientRuntimeDedupeSpecifiers(userResolveConfig = {})`
811
811
 
812
812
  ### `client/vite/index.js`
@@ -1044,17 +1044,7 @@ Exports
1044
1044
  ### `server/platform/providerRuntime.js`
1045
1045
  Exports
1046
1046
  - `createProviderRuntimeApp({ profile = "", providers = [], env = {}, logger = console, fastify = null } = {})`
1047
- - `createProviderRuntimeFromApp({ appRoot, lockPath = ".jskit/lock.json", profile = "", env = {}, logger = console, fastify = null } = {})`
1048
-
1049
- ### `server/platform/providerRuntime/descriptorCatalog.js`
1050
- Exports
1051
- - `collectGlobalUiPaths(descriptorEntries)`
1052
- - `resolveInstalledPackageDescriptors({ appRoot, lock })`
1053
- - `resolveDescriptorLoadOrder(descriptorEntries)`
1054
- - `validateDescriptorCapabilities(descriptorEntries, { builtinProvidersByCapability = {} } = {})`
1055
- Local functions
1056
- - `normalizeUiRoutePath(pathValue)`
1057
- - `registerCapabilityProvider(providersByCapability, capabilityId, providerPackageId)`
1047
+ - `createProviderRuntimeFromApp({ appRoot, profile = "", env = {}, logger = console, fastify = null } = {})`
1058
1048
 
1059
1049
  ### `server/platform/providerRuntime/helpers.js`
1060
1050
  Exports
@@ -1065,20 +1055,26 @@ Exports
1065
1055
  - `isInsidePackageRoot(packageRoot, candidatePath)`
1066
1056
  - `toAbsoluteSortedUniquePaths(values)`
1067
1057
 
1068
- ### `server/platform/providerRuntime/lockfile.js`
1058
+ ### `server/platform/providerRuntime/packageCatalog.js`
1069
1059
  Exports
1070
- - `readLockFromApp({ appRoot, lockPath = ".jskit/lock.json" } = {})`
1060
+ - `collectGlobalUiPaths(packageEntries)`
1061
+ - `resolveInstalledJskitPackages({ appRoot })`
1062
+ - `resolvePackageLoadOrder(packageEntries)`
1063
+ - `validatePackageCapabilities(packageEntries, { builtinProvidersByCapability = {} } = {})`
1064
+ Local functions
1065
+ - `normalizeUiRoutePath(pathValue)`
1066
+ - `registerCapabilityProvider(providersByCapability, capabilityId, providerPackageId)`
1071
1067
 
1072
1068
  ### `server/platform/providerRuntime/providerLoader.js`
1073
1069
  Exports
1074
- - `loadPackageProviders({ descriptorEntry })`
1070
+ - `loadPackageProviders({ packageEntry })`
1075
1071
  - `registerProviderClass({ providerClass, sourceId, seenProviderIds, orderedProviderClasses })`
1076
1072
  Local functions
1077
- - `normalizeServerProviderDefinitions(descriptor, packageId)`
1073
+ - `normalizeServerProviderDefinitions(packageMetadata, packageId)`
1078
1074
  - `isProviderDefinition(value)`
1079
1075
  - `normalizeProviderExportValue(value, { packageId, label })`
1080
1076
  - `resolveProviderClassesFromModule(moduleNamespace, { packageId, providerExport })`
1081
- - `collectDiscoveredProviderModulePaths({ descriptorEntry, providerDefinition })`
1077
+ - `collectDiscoveredProviderModulePaths({ packageEntry, providerDefinition })`
1082
1078
 
1083
1079
  ### `server/platform/runtime.js`
1084
1080
  Exports
@@ -1418,6 +1414,10 @@ Exports
1418
1414
  - `loadAppConfigFromAppRoot`
1419
1415
  - `loadAppConfigFromModuleUrl`
1420
1416
  - `importFreshModuleFromAbsolutePath`
1417
+ - `collectPackageDependencyIds`
1418
+ - `collectRootDependencySpecifiers`
1419
+ - `createPackageMetadata`
1420
+ - `discoverInstalledPackages`
1421
1421
  - `resolveRequiredAppRoot`
1422
1422
  - `toPosixPath`
1423
1423
  - `DEFAULT_PAGE_LINK_COMPONENT_TOKEN`
@@ -1503,8 +1503,7 @@ Local functions
1503
1503
  - `normalizeAppRouteOutletTarget({ outlet = {}, sourcePath = "" } = {})`
1504
1504
  - `discoverRouteMetaOutletTargetsFromVueSource(source = "", { context = "shell layout", enforceSingleDefault = true } = {})`
1505
1505
  - `collectVueFilePaths(rootDirectoryPath)`
1506
- - `readInstalledPackageStates(appRoot)`
1507
- - `normalizePackageOutletTarget({ packageId = "", outlet = {}, descriptorPath = "" } = {})`
1506
+ - `normalizePackageOutletTarget({ packageId = "", outlet = {}, manifestPath = "" } = {})`
1508
1507
  - `collectInstalledPackageOutletTargets(appRoot)`
1509
1508
  - `withTopologySource(placement = {}, sourcePath = "")`
1510
1509
  - `loadAppPlacementTopology(appRoot)`
@@ -1568,11 +1567,15 @@ Exports
1568
1567
  - `fileExists(filePath)`
1569
1568
  - `readJsonFile(filePath, fallback = {})`
1570
1569
 
1571
- ### `internal/node/installedPackageDescriptor.js`
1570
+ ### `internal/node/installedPackages.js`
1572
1571
  Exports
1573
- - `loadInstalledPackageDescriptor({ appRoot, packageId, installedPackageState, required = false })`
1574
- - `resolveDescriptorPathForInstalledPackage({ appRoot, packageId, installedPackageState, required = false })`
1572
+ - `ROOT_DEPENDENCY_SECTIONS`
1573
+ - `collectPackageDependencyIds(packageJson = {})`
1574
+ - `collectRootDependencySpecifiers(packageJson = {})`
1575
+ - `createPackageMetadata(packageJson = {})`
1576
+ - `discoverInstalledPackages({ appRoot } = {})`
1575
1577
  Local functions
1576
- - `resolveNodeModulesDescriptorCandidatePaths({ appRoot, packageId })`
1577
- - `resolveDescriptorCandidatePaths({ appRoot, packageId, installedPackageState })`
1578
- - `normalizeDescriptorPayload(descriptorModule)`
1578
+ - `readJsonFile(filePath, fallback = {})`
1579
+ - `resolveFileDependencyRoot(appRoot, specifier = "")`
1580
+ - `resolveInstalledPackageRoot({ appRoot, packageId, parentPackageRoot = "" })`
1581
+ - `resolvePackageRoots({ appRoot, packageId, directSpecifier = "", parentPackageRoot = "" })`
@@ -68,9 +68,3 @@ Local functions
68
68
  - `buildCapacitorServerBlock(mobileConfig = {})`
69
69
  - `buildAppLinkDomainsValue(appLinkDomains = [])`
70
70
  - `directoryContainsAnyFiles(directoryPath = "")`
71
-
72
- ### root
73
-
74
- ### `package.descriptor.mjs`
75
- Exports
76
- - None
@@ -89,9 +89,3 @@ Exports
89
89
  Local functions
90
90
  - `resolveHttpServer({ httpServer = null, fastify = null } = {})`
91
91
  - `buildSocketIoRedisAdapterKey(redisNamespace = "")`
92
-
93
- ### root
94
-
95
- ### `package.descriptor.mjs`
96
- Exports
97
- - None
@@ -27,9 +27,3 @@ Local functions
27
27
  - `normalizeOperationDefinition(operationName, operation = null, resourceMessages = null)`
28
28
  - `normalizeResourceOperations(operations = null, resourceMessages = null)`
29
29
  - `requireResourceNamespace(value, { context = "defineResource resource.namespace" } = {})`
30
-
31
- ### root
32
-
33
- ### `package.descriptor.mjs`
34
- Exports
35
- - None
@@ -43,9 +43,3 @@ Local functions
43
43
  - `createDefaultCrudOperations(resource = {})`
44
44
  - `mergeCrudOperationDefinition(baseDefinition, overrideDefinition)`
45
45
  - `mergeCrudOperations(defaultOperations = {}, overrides = {})`
46
-
47
- ### root
48
-
49
- ### `package.descriptor.mjs`
50
- Exports
51
- - None
@@ -540,12 +540,6 @@ Exports
540
540
  - `addPlacementTopology(value = {})`
541
541
  - `default`
542
542
 
543
- ### root
544
-
545
- ### `package.descriptor.mjs`
546
- Exports
547
- - None
548
-
549
543
  ### fixtures
550
544
 
551
545
  ### `fixtures/adaptive-shell/src/App.vue`
@@ -31,9 +31,3 @@ Exports
31
31
  - `createStorageBinding(scope, { rootDir = process.cwd() } = {})`
32
32
  Local functions
33
33
  - `resolveFsBasePath(fsBasePath, { rootDir } = {})`
34
-
35
- ### root
36
-
37
- ### `package.descriptor.mjs`
38
- Exports
39
- - None
@@ -125,9 +125,3 @@ Local functions
125
125
  - `normalizeExpectedTopologyVariantTargets(variantTargets = null)`
126
126
  - `describeTopologyVariantTargets(variantTargets = {})`
127
127
  - `placementMatchesExpectedVariantTargets(placement = {}, expectedVariantTargets = null)`
128
-
129
- ### root
130
-
131
- ### `package.descriptor.mjs`
132
- Exports
133
- - None
@@ -68,9 +68,3 @@ Exports
68
68
  - `DEFAULT_IMAGE_EDITOR_OPTIONS`
69
69
  - `DEFAULT_IMAGE_UPLOAD_ALLOWED_MIME_TYPES`
70
70
  - `DEFAULT_IMAGE_UPLOAD_MAX_BYTES`
71
-
72
- ### root
73
-
74
- ### `package.descriptor.mjs`
75
- Exports
76
- - None
@@ -77,9 +77,3 @@ Exports
77
77
  - `normalizeMaxUploadBytes(value, fallback = DEFAULT_IMAGE_UPLOAD_MAX_BYTES)`
78
78
  - `normalizeMimeType(value)`
79
79
  - `normalizeUploadPolicy(policy = {}, defaults = {})`
80
-
81
- ### root
82
-
83
- ### `package.descriptor.mjs`
84
- Exports
85
- - None
@@ -283,10 +283,6 @@ Local functions
283
283
  - `buildUsernameCandidate(baseUsername, suffix)`
284
284
  - `resolveUniqueUsername(baseUsername, usedUsernames)`
285
285
 
286
- ### `templates/packages/users-workspace/package.descriptor.mjs`
287
- Exports
288
- - None
289
-
290
286
  ### `templates/packages/users-workspace/src/server/actions.js`
291
287
  Exports
292
288
  - `createActions({ surface } = {})`
@@ -303,10 +299,6 @@ Exports
303
299
  Local functions
304
300
  - `resolveCrudPolicyFromApp(app)`
305
301
 
306
- ### `templates/packages/users/package.descriptor.mjs`
307
- Exports
308
- - None
309
-
310
302
  ### `templates/packages/users/src/server/actions.js`
311
303
  Exports
312
304
  - `createActions({ surface } = {})`
@@ -338,9 +330,3 @@ Exports
338
330
  ### `templates/packages/users/src/shared/userResource.js`
339
331
  Exports
340
332
  - `resource`
341
-
342
- ### root
343
-
344
- ### `package.descriptor.mjs`
345
- Exports
346
- - None
@@ -48,6 +48,13 @@ Local functions
48
48
  - `resolveFieldErrors(fieldKey)`
49
49
  - `resolveCancelTo(target = cancelTo.value)`
50
50
 
51
+ ### `src/client/components/CrudDeleteAction.vue`
52
+ Exports
53
+ - None
54
+ Local functions
55
+ - `closeDialog()`
56
+ - `handleDialogModelUpdate(isOpen)`
57
+
51
58
  ### `src/client/components/CrudListBulkActionSurface.vue`
52
59
  Exports
53
60
  - None
@@ -620,6 +627,7 @@ Exports
620
627
  - `UsersWebClientProvider`
621
628
  - `AccountSettingsClientElement`
622
629
  - `CrudAddEditScreen`
630
+ - `CrudDeleteAction`
623
631
  - `CrudListBulkActionSurface`
624
632
  - `CrudListFilterSurface`
625
633
  - `CrudListScreen`
@@ -714,12 +722,6 @@ Exports
714
722
  Exports
715
723
  - None
716
724
 
717
- ### root
718
-
719
- ### `package.descriptor.mjs`
720
- Exports
721
- - None
722
-
723
725
  ### fixtures
724
726
 
725
727
  ### `fixtures/crud-list-date-filters/App.vue`
@@ -425,9 +425,3 @@ Local functions
425
425
  ### `templates/packages/main/src/server/email/workspaceInviteEmail.js`
426
426
  Exports
427
427
  - `renderWorkspaceInviteEmail({ inviteUrl = "", workspace = {}, inviter = null, roleSid = "member", expiresAt = "" } = {})`
428
-
429
- ### root
430
-
431
- ### `package.descriptor.mjs`
432
- Exports
433
- - None
@@ -367,9 +367,3 @@ Exports
367
367
  ### `templates/src/surfaces/app/root.vue`
368
368
  Exports
369
369
  - None
370
-
371
- ### root
372
-
373
- ### `package.descriptor.mjs`
374
- Exports
375
- - None
@@ -82,10 +82,6 @@ Exports
82
82
  Exports
83
83
  - None
84
84
 
85
- ### `templates/base-shell/packages/main/package.descriptor.mjs`
86
- Exports
87
- - None
88
-
89
85
  ### `templates/base-shell/packages/main/src/client/index.js`
90
86
  Exports
91
87
  - `MainClientProvider`
@@ -236,10 +232,6 @@ Exports
236
232
  Exports
237
233
  - None
238
234
 
239
- ### `templates/minimal-shell/packages/main/package.descriptor.mjs`
240
- Exports
241
- - None
242
-
243
235
  ### `templates/minimal-shell/packages/main/src/client/index.js`
244
236
  Exports
245
237
  - `MainClientProvider`
@@ -333,9 +325,3 @@ Exports
333
325
  ### `bin/jskit-create-app.js`
334
326
  Exports
335
327
  - None
336
-
337
- ### root
338
-
339
- ### `package.descriptor.mjs`
340
- Exports
341
- - None