@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.
- package/DISTR_AGENT.md +25 -0
- package/guide/agent/app-extras/assistant.md +636 -0
- package/guide/agent/app-extras/realtime.md +223 -0
- package/guide/agent/app-setup/a-more-interesting-shell.md +643 -0
- package/guide/agent/app-setup/authentication.md +948 -0
- package/guide/agent/app-setup/console.md +316 -0
- package/guide/agent/app-setup/database-layer.md +775 -0
- package/guide/agent/app-setup/initial-scaffolding.md +714 -0
- package/guide/agent/app-setup/multi-homing.md +655 -0
- package/guide/agent/app-setup/users.md +355 -0
- package/guide/agent/app-setup/working-with-the-jskit-cli.md +983 -0
- package/guide/agent/generators/advanced-cruds.md +923 -0
- package/guide/agent/generators/crud-generators.md +556 -0
- package/guide/agent/generators/intro.md +63 -0
- package/guide/agent/generators/ui-generators.md +648 -0
- package/guide/agent/index.md +39 -0
- package/guide/human/app-extras/assistant.md +695 -0
- package/guide/human/app-extras/realtime.md +270 -0
- package/guide/human/app-setup/a-more-interesting-shell.md +734 -0
- package/guide/human/app-setup/authentication.md +963 -0
- package/guide/human/app-setup/console.md +352 -0
- package/guide/human/app-setup/database-layer.md +822 -0
- package/guide/human/app-setup/initial-scaffolding.md +738 -0
- package/guide/human/app-setup/multi-homing.md +795 -0
- package/guide/human/app-setup/users.md +404 -0
- package/guide/human/app-setup/working-with-the-jskit-cli.md +997 -0
- package/guide/human/generators/advanced-cruds.md +923 -0
- package/guide/human/generators/crud-generators.md +556 -0
- package/guide/human/generators/intro.md +109 -0
- package/guide/human/generators/ui-generators.md +665 -0
- package/guide/human/index.md +39 -0
- package/package.json +28 -0
- package/reference/autogen/KERNEL_MAP.md +536 -0
- package/reference/autogen/README.md +44 -0
- package/reference/autogen/packages/agent-docs.md +13 -0
- package/reference/autogen/packages/assistant-core.md +310 -0
- package/reference/autogen/packages/assistant-runtime.md +219 -0
- package/reference/autogen/packages/assistant.md +73 -0
- package/reference/autogen/packages/auth-core.md +352 -0
- package/reference/autogen/packages/auth-provider-supabase-core.md +223 -0
- package/reference/autogen/packages/auth-web.md +267 -0
- package/reference/autogen/packages/console-core.md +116 -0
- package/reference/autogen/packages/console-web.md +37 -0
- package/reference/autogen/packages/crud-core.md +283 -0
- package/reference/autogen/packages/crud-server-generator.md +220 -0
- package/reference/autogen/packages/crud-ui-generator.md +154 -0
- package/reference/autogen/packages/database-runtime-mysql.md +61 -0
- package/reference/autogen/packages/database-runtime-postgres.md +39 -0
- package/reference/autogen/packages/database-runtime.md +216 -0
- package/reference/autogen/packages/http-runtime.md +213 -0
- package/reference/autogen/packages/kernel.md +1350 -0
- package/reference/autogen/packages/realtime.md +95 -0
- package/reference/autogen/packages/shell-web.md +349 -0
- package/reference/autogen/packages/storage-runtime.md +39 -0
- package/reference/autogen/packages/ui-generator.md +101 -0
- package/reference/autogen/packages/uploads-image-web.md +76 -0
- package/reference/autogen/packages/uploads-runtime.md +85 -0
- package/reference/autogen/packages/users-core.md +307 -0
- package/reference/autogen/packages/users-web.md +473 -0
- package/reference/autogen/packages/workspaces-core.md +415 -0
- package/reference/autogen/packages/workspaces-web.md +372 -0
- package/reference/autogen/tooling/config-eslint.md +52 -0
- package/reference/autogen/tooling/create-app.md +194 -0
- package/reference/autogen/tooling/jskit-catalog.md +27 -0
- package/reference/autogen/tooling/jskit-cli.md +624 -0
- package/reference/autogen/tooling/test-support.md +27 -0
- package/reference/autogen/tooling/testUtils.md +31 -0
- package/templates/APP_BLUEPRINT.md +57 -0
- package/workflow/app-state.md +33 -0
- package/workflow/bootstrap.md +24 -0
- package/workflow/feature-delivery.md +21 -0
- package/workflow/review.md +22 -0
- package/workflow/scoping.md +26 -0
package/package.json
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@jskit-ai/agent-docs",
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Distributed JSKIT agent workflows, guides, and generated reference maps.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"files": [
|
|
7
|
+
"DISTR_AGENT.md",
|
|
8
|
+
"guide",
|
|
9
|
+
"reference",
|
|
10
|
+
"templates",
|
|
11
|
+
"workflow"
|
|
12
|
+
],
|
|
13
|
+
"scripts": {
|
|
14
|
+
"test": "node --test"
|
|
15
|
+
},
|
|
16
|
+
"engines": {
|
|
17
|
+
"node": "20.x"
|
|
18
|
+
},
|
|
19
|
+
"publishConfig": {
|
|
20
|
+
"access": "public"
|
|
21
|
+
},
|
|
22
|
+
"keywords": [
|
|
23
|
+
"jskit",
|
|
24
|
+
"agent",
|
|
25
|
+
"docs",
|
|
26
|
+
"workflow"
|
|
27
|
+
]
|
|
28
|
+
}
|
|
@@ -0,0 +1,536 @@
|
|
|
1
|
+
# Kernel Shared Map
|
|
2
|
+
|
|
3
|
+
Generated by `npm run agent-docs:build`.
|
|
4
|
+
Do not edit manually.
|
|
5
|
+
|
|
6
|
+
Use this as startup navigation for canonical shared helpers before adding new helpers locally.
|
|
7
|
+
For the full repo inventory, read `reference/autogen/README.md` and the package maps it lists.
|
|
8
|
+
|
|
9
|
+
## Reuse Order
|
|
10
|
+
1. `packages/kernel/shared/support/*`
|
|
11
|
+
2. `packages/kernel/shared/surface/*`
|
|
12
|
+
3. `packages/kernel/shared/validators/*`
|
|
13
|
+
4. `packages/kernel/shared/actions/*`
|
|
14
|
+
5. `packages/kernel/shared/runtime/*`
|
|
15
|
+
|
|
16
|
+
## Scope
|
|
17
|
+
- Source: `packages/kernel/shared/**/*{.js,.mjs,.cjs,.vue}`
|
|
18
|
+
- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`
|
|
19
|
+
|
|
20
|
+
## Sections
|
|
21
|
+
|
|
22
|
+
### support
|
|
23
|
+
|
|
24
|
+
### `support/containerToken.js`
|
|
25
|
+
Exports
|
|
26
|
+
- `isContainerToken(value)`
|
|
27
|
+
|
|
28
|
+
### `support/crudLookup.js`
|
|
29
|
+
Exports
|
|
30
|
+
- `DEFAULT_CRUD_LOOKUP_CONTAINER_KEY`
|
|
31
|
+
- `normalizeCrudLookupApiPath(value = "")`
|
|
32
|
+
- `normalizeCrudLookupNamespace(value = "")`
|
|
33
|
+
- `resolveCrudLookupApiPathFromNamespace(value = "")`
|
|
34
|
+
- `normalizeCrudLookupContainerKey(value, { defaultValue = DEFAULT_CRUD_LOOKUP_CONTAINER_KEY, context = "crud lookup container key" } = {})`
|
|
35
|
+
- `resolveCrudLookupContainerKey(resource = {}, options = {})`
|
|
36
|
+
- `resolveCrudLookupFieldKeys(resource = {}, { allowKeys = [] } = {})`
|
|
37
|
+
- `resolveCrudParentFilterKeys(resource = {})`
|
|
38
|
+
- `resolveCrudLookupFieldKeyFromRouteParam(resource = {}, routeParamKey = "", { allowKeys = [] } = {})`
|
|
39
|
+
- `resolveCrudParentFilterFieldKeyFromRouteParam(resource = {}, routeParamKey = "")`
|
|
40
|
+
Local functions
|
|
41
|
+
- `resolveCrudLookupFieldEntries(resource = {}, { allowKeys = [] } = {})`
|
|
42
|
+
- `resolveCrudLookupCreateSchemaKeys(resource = {})`
|
|
43
|
+
|
|
44
|
+
### `support/deepFreeze.js`
|
|
45
|
+
Exports
|
|
46
|
+
- `deepFreeze(value, seen = new WeakSet())`
|
|
47
|
+
|
|
48
|
+
### `support/formatDateTime.js`
|
|
49
|
+
Exports
|
|
50
|
+
- `formatDateTime(value, { fallback = "unknown" } = {})`
|
|
51
|
+
|
|
52
|
+
### `support/index.js`
|
|
53
|
+
Exports
|
|
54
|
+
- `isRecord`
|
|
55
|
+
- `pickOwnProperties`
|
|
56
|
+
- `formatDateTime`
|
|
57
|
+
- `appendQueryString`
|
|
58
|
+
- `splitPathQueryAndHash`
|
|
59
|
+
- `normalizePermissionList`
|
|
60
|
+
- `hasPermission`
|
|
61
|
+
- `normalizeReturnToPath`
|
|
62
|
+
- `resolveAllowedOriginsFromPlacementContext`
|
|
63
|
+
- `toCamelCase`
|
|
64
|
+
- `toSnakeCase`
|
|
65
|
+
- `isTransientQueryError`
|
|
66
|
+
- `shouldRetryTransientQueryFailure`
|
|
67
|
+
- `transientQueryRetryDelay`
|
|
68
|
+
|
|
69
|
+
### `support/linkPath.js`
|
|
70
|
+
Exports
|
|
71
|
+
- `isExternalLinkTarget(target = "")`
|
|
72
|
+
- `splitPathQueryHash(target = "")`
|
|
73
|
+
- `resolveLinkPath(basePath = "/", relativePath = "/")`
|
|
74
|
+
|
|
75
|
+
### `support/listenerSet.js`
|
|
76
|
+
Exports
|
|
77
|
+
- `subscribeListener(listeners, listener)`
|
|
78
|
+
- `createListenerSubscription(listeners)`
|
|
79
|
+
|
|
80
|
+
### `support/normalize.js`
|
|
81
|
+
Exports
|
|
82
|
+
- `normalizeText(value, { fallback = "" } = {})`
|
|
83
|
+
- `hasValue(value)`
|
|
84
|
+
- `normalizeBoolean(value)`
|
|
85
|
+
- `normalizeFiniteNumber(value)`
|
|
86
|
+
- `normalizeFiniteInteger(value)`
|
|
87
|
+
- `normalizeLowerText(value, { fallback = "" } = {})`
|
|
88
|
+
- `normalizeQueryToken(value, { fallback = "__none__" } = {})`
|
|
89
|
+
- `normalizeObject(value, { fallback = {} } = {})`
|
|
90
|
+
- `normalizeIfInSource(source, normalized, fieldName, normalizer = (value) => value)`
|
|
91
|
+
- `normalizeIfPresent(value, normalizer = (entry) => entry)`
|
|
92
|
+
- `normalizeOrNull(value, normalizer = (entry) => entry)`
|
|
93
|
+
- `isRecord(value)`
|
|
94
|
+
- `normalizeArray(value)`
|
|
95
|
+
- `normalizeUniqueTextList(value, { acceptSingle = false } = {})`
|
|
96
|
+
- `normalizeInteger(value, { fallback = 0, min = null, max = null } = {})`
|
|
97
|
+
- `normalizePositiveInteger(value, { fallback = 0 } = {})`
|
|
98
|
+
- `normalizeCanonicalRecordIdText(value, { fallback = null } = {})`
|
|
99
|
+
- `normalizeRecordId(value, { fallback = null } = {})`
|
|
100
|
+
- `normalizeOpaqueId(value, { fallback = null } = {})`
|
|
101
|
+
- `normalizeOneOf(value, allowedValues = [], fallback = "")`
|
|
102
|
+
- `ensureNonEmptyText(value, label = "value")`
|
|
103
|
+
|
|
104
|
+
### `support/permissions.js`
|
|
105
|
+
Exports
|
|
106
|
+
- `normalizePermissionList(value)`
|
|
107
|
+
- `hasPermission(permissionSet = [], permission = "")`
|
|
108
|
+
|
|
109
|
+
### `support/pickOwnProperties.js`
|
|
110
|
+
Exports
|
|
111
|
+
- `pickOwnProperties(source, keys)`
|
|
112
|
+
|
|
113
|
+
### `support/policies.js`
|
|
114
|
+
Exports
|
|
115
|
+
- `AUTH_POLICY_PUBLIC`
|
|
116
|
+
- `AUTH_POLICY_AUTHENTICATED`
|
|
117
|
+
- `ROUTE_VISIBILITY_PUBLIC`
|
|
118
|
+
- `ROUTE_VISIBILITY_USER`
|
|
119
|
+
|
|
120
|
+
### `support/providerLogger.js`
|
|
121
|
+
Exports
|
|
122
|
+
- `createProviderLogger(loggerLike = null, { debugEnabled = false, debugMethod = "info" } = {})`
|
|
123
|
+
Local functions
|
|
124
|
+
- `asLogger(value)`
|
|
125
|
+
- `callLoggerMethod(logger, methodName, fallbackMethodName, args)`
|
|
126
|
+
|
|
127
|
+
### `support/queryPath.js`
|
|
128
|
+
Exports
|
|
129
|
+
- `appendQueryString(path = "", queryString = "")`
|
|
130
|
+
- `splitPathQueryAndHash(path = "")`
|
|
131
|
+
Local functions
|
|
132
|
+
- `splitPathAndHash(path = "")`
|
|
133
|
+
|
|
134
|
+
### `support/queryResilience.js`
|
|
135
|
+
Exports
|
|
136
|
+
- `TRANSIENT_QUERY_ERROR_STATUSES`
|
|
137
|
+
- `MAX_TRANSIENT_QUERY_RETRIES`
|
|
138
|
+
- `MAX_TRANSIENT_RETRY_DELAY_MS`
|
|
139
|
+
- `normalizeQueryErrorStatus(error)`
|
|
140
|
+
- `isTransientQueryError(error)`
|
|
141
|
+
- `shouldRetryTransientQueryFailure(failureCount, error)`
|
|
142
|
+
- `transientQueryRetryDelay(attemptIndex)`
|
|
143
|
+
|
|
144
|
+
### `support/returnToPath.js`
|
|
145
|
+
Exports
|
|
146
|
+
- `normalizeAllowedOrigins(allowedOrigins = [])`
|
|
147
|
+
- `normalizeHttpOrigin(value = "")`
|
|
148
|
+
- `normalizeReturnToPath(value, { fallback = "/", allowedOrigins = [], blockedPathnames = [], pickFirstArrayValue = false } = {})`
|
|
149
|
+
- `resolveAllowedOriginsFromSurfaceDefinitions(surfaceDefinitions = {}, { seedOrigins = [] } = {})`
|
|
150
|
+
- `resolveAllowedOriginsFromPlacementContext(contextValue = null, { includeWindowOrigin = true } = {})`
|
|
151
|
+
Local functions
|
|
152
|
+
- `appendNormalizedOrigin(origins, value)`
|
|
153
|
+
- `normalizeBlockedPathnames(blockedPathnames = [])`
|
|
154
|
+
|
|
155
|
+
### `support/shellLayoutTargets.js`
|
|
156
|
+
Exports
|
|
157
|
+
- `describeShellOutletTargets(targets = [])`
|
|
158
|
+
- `discoverShellOutletTargetsFromVueSource(source = "", { context = "shell layout" } = {})`
|
|
159
|
+
- `findShellOutletTargetById(targets = [], targetId = "")`
|
|
160
|
+
- `normalizeShellOutletTargetId(value = "")`
|
|
161
|
+
- `normalizeShellOutletTargetRecord(value = {}, { context = "shell layout" } = {})`
|
|
162
|
+
- `resolveShellOutletTargetParts({ target = "" } = {})`
|
|
163
|
+
Local functions
|
|
164
|
+
- `parseTagAttributes(attributesSource = "")`
|
|
165
|
+
- `isDefaultAttributeEnabled(value)`
|
|
166
|
+
|
|
167
|
+
### `support/sorting.js`
|
|
168
|
+
Exports
|
|
169
|
+
- `sortStrings(values = [])`
|
|
170
|
+
- `sortById(items = [], { idSelector = (item) => item?.id } = {})`
|
|
171
|
+
|
|
172
|
+
### `support/stringCase.js`
|
|
173
|
+
Exports
|
|
174
|
+
- `toCamelCase(value = "")`
|
|
175
|
+
- `toSnakeCase(value = "")`
|
|
176
|
+
|
|
177
|
+
### `support/tokens.js`
|
|
178
|
+
Exports
|
|
179
|
+
- `isContainerToken`
|
|
180
|
+
|
|
181
|
+
### `support/visibility.js`
|
|
182
|
+
Exports
|
|
183
|
+
- `ROUTE_VISIBILITY_LEVELS`
|
|
184
|
+
- `ROUTE_VISIBILITY_PUBLIC`
|
|
185
|
+
- `ROUTE_VISIBILITY_USER`
|
|
186
|
+
- `ROUTE_VISIBILITY_WORKSPACE`
|
|
187
|
+
- `ROUTE_VISIBILITY_WORKSPACE_USER`
|
|
188
|
+
- `ROUTE_VISIBILITY_TOKENS`
|
|
189
|
+
- `normalizeRouteVisibilityToken(value, { fallback = ROUTE_VISIBILITY_PUBLIC } = {})`
|
|
190
|
+
- `normalizeRouteVisibility(value, { fallback = ROUTE_VISIBILITY_PUBLIC } = {})`
|
|
191
|
+
- `checkRouteVisibility(value, { context = "checkRouteVisibility" } = {})`
|
|
192
|
+
- `isWorkspaceRouteVisibility(value = "")`
|
|
193
|
+
- `normalizeVisibilityContext(value = {})`
|
|
194
|
+
Local functions
|
|
195
|
+
- `normalizeVisibilityScopeKind(value)`
|
|
196
|
+
|
|
197
|
+
### surface
|
|
198
|
+
|
|
199
|
+
### `surface/apiPaths.js`
|
|
200
|
+
Exports
|
|
201
|
+
- `API_BASE_PATH`
|
|
202
|
+
- `API_PREFIX`
|
|
203
|
+
- `API_PREFIX_SLASH`
|
|
204
|
+
- `API_DOCS_PATH`
|
|
205
|
+
- `API_REALTIME_PATH`
|
|
206
|
+
- `materializeRouteTemplate(routeTemplate = "/", { params = {}, strictParams = true, context = "materializeRouteTemplate" } = {})`
|
|
207
|
+
- `normalizePathname`
|
|
208
|
+
- `isApiPath(pathname)`
|
|
209
|
+
- `isVersionedApiPath(pathname)`
|
|
210
|
+
- `toVersionedApiPath(pathname)`
|
|
211
|
+
- `toVersionedApiPrefix(pathnameOrPrefix)`
|
|
212
|
+
- `buildVersionedApiPath(suffix)`
|
|
213
|
+
- `isVersionedApiPrefixMatch(pathname)`
|
|
214
|
+
- `resolveScopedRouteBase(routeBase = "/")`
|
|
215
|
+
- `resolveScopedApiBasePath({ routeBase = "/", relativePath = "/", params = {}, strictParams = true } = {})`
|
|
216
|
+
Local functions
|
|
217
|
+
- `normalizeRouteTemplateParams(params = null)`
|
|
218
|
+
|
|
219
|
+
### `surface/escapeRegExp.js`
|
|
220
|
+
Exports
|
|
221
|
+
- `escapeRegExp(value)`
|
|
222
|
+
|
|
223
|
+
### `surface/index.js`
|
|
224
|
+
Exports
|
|
225
|
+
- `normalizeSurfaceId`
|
|
226
|
+
- `normalizeSurfacePagesRoot`
|
|
227
|
+
- `deriveSurfaceRouteBaseFromPagesRoot`
|
|
228
|
+
- `createSurfacePathHelpers`
|
|
229
|
+
- `resolveScopedRouteBase`
|
|
230
|
+
- `resolveScopedApiBasePath`
|
|
231
|
+
|
|
232
|
+
### `surface/paths.js`
|
|
233
|
+
Exports
|
|
234
|
+
- `createSurfacePathHelpers(options = {})`
|
|
235
|
+
- `normalizePathname(pathname)`
|
|
236
|
+
- `matchesPathPrefix(pathname, prefix)`
|
|
237
|
+
Local functions
|
|
238
|
+
- `compileSurfaceRouteMatcher(routeBase)`
|
|
239
|
+
- `compareSurfaceRouteSpecificity(left, right)`
|
|
240
|
+
|
|
241
|
+
### `surface/registry.js`
|
|
242
|
+
Exports
|
|
243
|
+
- `createSurfaceRegistry(options = {})`
|
|
244
|
+
- `normalizeSurfaceId(value)`
|
|
245
|
+
- `normalizeSurfacePagesRoot(pagesRootLike)`
|
|
246
|
+
- `deriveSurfaceRouteBaseFromPagesRoot(pagesRootLike)`
|
|
247
|
+
Local functions
|
|
248
|
+
- `normalizeRouteSegment(segmentLike)`
|
|
249
|
+
|
|
250
|
+
### `surface/runtime.js`
|
|
251
|
+
Exports
|
|
252
|
+
- `createSurfaceRuntime(options = {})`
|
|
253
|
+
- `filterRoutesBySurface(routeList, { surfaceRuntime, surfaceMode } = {})`
|
|
254
|
+
Local functions
|
|
255
|
+
- `uniqueSurfaceIds(ids)`
|
|
256
|
+
- `resolveSurfaceIds({ surfaces = {} } = {})`
|
|
257
|
+
- `normalizeRoutePath(pathLike = "")`
|
|
258
|
+
- `resolveAbsoluteRoutePath(parentAbsolutePath = "/", routePath = "")`
|
|
259
|
+
- `readRouteJskitMeta(route)`
|
|
260
|
+
- `resolveRouteExplicitSurface(route)`
|
|
261
|
+
- `resolveOwnRouteScope(route)`
|
|
262
|
+
- `resolveRouteSurface(route, inheritedSurfaceId = "", { surfaceRuntime, absolutePath = "/" } = {})`
|
|
263
|
+
- `normalizeRoutesBySurfaceBoundaries(routeList = [], { surfaceRuntime } = {})`
|
|
264
|
+
|
|
265
|
+
### validators
|
|
266
|
+
|
|
267
|
+
### `validators/createCursorListValidator.js`
|
|
268
|
+
Exports
|
|
269
|
+
- `createCursorListValidator(itemValidator)`
|
|
270
|
+
|
|
271
|
+
### `validators/cursorPaginationQueryValidator.js`
|
|
272
|
+
Exports
|
|
273
|
+
- `cursorPaginationQueryValidator`
|
|
274
|
+
Local functions
|
|
275
|
+
- `normalizeCursorPaginationQuery(input = {})`
|
|
276
|
+
|
|
277
|
+
### `validators/htmlTimeSchemas.js`
|
|
278
|
+
Exports
|
|
279
|
+
- `HTML_TIME_STRING_SCHEMA`
|
|
280
|
+
- `NULLABLE_HTML_TIME_STRING_SCHEMA`
|
|
281
|
+
|
|
282
|
+
### `validators/index.js`
|
|
283
|
+
Exports
|
|
284
|
+
- `normalizeObjectInput`
|
|
285
|
+
- `createCursorListValidator`
|
|
286
|
+
- `cursorPaginationQueryValidator`
|
|
287
|
+
- `HTML_TIME_STRING_SCHEMA`
|
|
288
|
+
- `NULLABLE_HTML_TIME_STRING_SCHEMA`
|
|
289
|
+
- `mergeObjectSchemas`
|
|
290
|
+
- `mergeValidators`
|
|
291
|
+
- `nestValidator`
|
|
292
|
+
- `RECORD_ID_PATTERN`
|
|
293
|
+
- `recordIdSchema`
|
|
294
|
+
- `recordIdInputSchema`
|
|
295
|
+
- `nullableRecordIdSchema`
|
|
296
|
+
- `nullableRecordIdInputSchema`
|
|
297
|
+
- `recordIdValidator`
|
|
298
|
+
- `nullableRecordIdValidator`
|
|
299
|
+
- `recordIdParamsValidator`
|
|
300
|
+
- `positiveIntegerValidator`
|
|
301
|
+
- `normalizeSettingsFieldInput`
|
|
302
|
+
- `normalizeSettingsFieldOutput`
|
|
303
|
+
- `normalizeRequiredFieldList`
|
|
304
|
+
- `deriveRequiredFieldsFromSchema`
|
|
305
|
+
- `deriveResourceRequiredMetadata`
|
|
306
|
+
|
|
307
|
+
### `validators/inputNormalization.js`
|
|
308
|
+
Exports
|
|
309
|
+
- `normalizeObjectInput(value)`
|
|
310
|
+
|
|
311
|
+
### `validators/mergeObjectSchemas.js`
|
|
312
|
+
Exports
|
|
313
|
+
- `mergeObjectSchemas(schemas)`
|
|
314
|
+
|
|
315
|
+
### `validators/mergeValidators.js`
|
|
316
|
+
Exports
|
|
317
|
+
- `mergeValidators(validators = [], options = {})`
|
|
318
|
+
Local functions
|
|
319
|
+
- `isPromiseLike(value)`
|
|
320
|
+
- `createErrorFactory(createError)`
|
|
321
|
+
|
|
322
|
+
### `validators/nestValidator.js`
|
|
323
|
+
Exports
|
|
324
|
+
- `nestValidator(key, validator, { required = true } = {})`
|
|
325
|
+
Local functions
|
|
326
|
+
- `normalizeValidator(validator)`
|
|
327
|
+
|
|
328
|
+
### `validators/recordIdParamsValidator.js`
|
|
329
|
+
Exports
|
|
330
|
+
- `RECORD_ID_PATTERN`
|
|
331
|
+
- `recordIdSchema`
|
|
332
|
+
- `recordIdInputSchema`
|
|
333
|
+
- `nullableRecordIdSchema`
|
|
334
|
+
- `nullableRecordIdInputSchema`
|
|
335
|
+
- `recordIdValidator`
|
|
336
|
+
- `nullableRecordIdValidator`
|
|
337
|
+
- `recordIdParamsValidator`
|
|
338
|
+
- `positiveIntegerValidator`
|
|
339
|
+
|
|
340
|
+
### `validators/resourceRequiredMetadata.js`
|
|
341
|
+
Exports
|
|
342
|
+
- `normalizeRequiredFieldList(value)`
|
|
343
|
+
- `deriveRequiredFieldsFromSchema(schema)`
|
|
344
|
+
- `deriveResourceRequiredMetadata(resourceSchema)`
|
|
345
|
+
|
|
346
|
+
### `validators/settingsFieldNormalization.js`
|
|
347
|
+
Exports
|
|
348
|
+
- `normalizeSettingsFieldInput(payload = {}, fields = [])`
|
|
349
|
+
- `normalizeSettingsFieldOutput(payload = {}, fields = [])`
|
|
350
|
+
|
|
351
|
+
### actions
|
|
352
|
+
|
|
353
|
+
### `actions/actionContributorHelpers.js`
|
|
354
|
+
Exports
|
|
355
|
+
- `normalizeObject`
|
|
356
|
+
- `toPositiveInteger`
|
|
357
|
+
- `requireServiceMethod(service, methodName, contributorId, { serviceLabel } = {})`
|
|
358
|
+
- `resolveRequest(context)`
|
|
359
|
+
- `hasPermission`
|
|
360
|
+
- `EMPTY_INPUT_VALIDATOR`
|
|
361
|
+
- `OBJECT_INPUT_VALIDATOR`
|
|
362
|
+
|
|
363
|
+
### `actions/actionDefinitions.js`
|
|
364
|
+
Exports
|
|
365
|
+
- `ActionRuntimeError`
|
|
366
|
+
- `createActionRuntimeError(status, message, options = {})`
|
|
367
|
+
- `normalizeActionDefinition(definition, { contributorId = "", contributorDomain = "" } = {})`
|
|
368
|
+
- `normalizeActionContributor(contributor)`
|
|
369
|
+
- `normalizeActionDomain(value, { context = "domain", errorCode = "ACTION_DEFINITION_INVALID" } = {})`
|
|
370
|
+
- `createActionVersionKey(actionId, version)`
|
|
371
|
+
- `isPlainObject`
|
|
372
|
+
- `__testables`
|
|
373
|
+
Local functions
|
|
374
|
+
- `normalizeStringArray(value, { fieldName, allowedSet, allowEmpty = false } = {})`
|
|
375
|
+
- `normalizeSingleActionValidator(value, fieldName, { required = false } = {})`
|
|
376
|
+
- `isActionValidatorShape(value)`
|
|
377
|
+
- `normalizeSectionActionValidatorMap(value, fieldName)`
|
|
378
|
+
- `mergeNormalizedActionValidators(validators, fieldName)`
|
|
379
|
+
- `normalizeActionValidators(value, fieldName, { required = false } = {})`
|
|
380
|
+
- `normalizeActionOutputValidator(value, fieldName, { required = false } = {})`
|
|
381
|
+
- `normalizeActionPermission(permission, actionId)`
|
|
382
|
+
- `normalizeAuditConfig(audit, { actionId })`
|
|
383
|
+
- `normalizeObservabilityConfig(observability)`
|
|
384
|
+
- `normalizeActionExtensions(value)`
|
|
385
|
+
|
|
386
|
+
### `actions/audit.js`
|
|
387
|
+
Exports
|
|
388
|
+
- `createNoopAuditAdapter()`
|
|
389
|
+
|
|
390
|
+
### `actions/executionContext.js`
|
|
391
|
+
Exports
|
|
392
|
+
- `normalizeExecutionContext(context = {})`
|
|
393
|
+
- `__testables`
|
|
394
|
+
Local functions
|
|
395
|
+
- `copyRecord(value)`
|
|
396
|
+
- `normalizeActor(actor)`
|
|
397
|
+
- `normalizeTimeMeta(timeMeta)`
|
|
398
|
+
- `copyPassthroughContextEntries(source = {})`
|
|
399
|
+
|
|
400
|
+
### `actions/idempotency.js`
|
|
401
|
+
Exports
|
|
402
|
+
- `resolveActionIdempotencyKey(definition, context)`
|
|
403
|
+
- `ensureIdempotencyKeyIfRequired(definition, context, key)`
|
|
404
|
+
- `createNoopIdempotencyAdapter()`
|
|
405
|
+
- `__testables`
|
|
406
|
+
Local functions
|
|
407
|
+
- `resolveRequestIdempotencyKey(context)`
|
|
408
|
+
|
|
409
|
+
### `actions/index.js`
|
|
410
|
+
Exports
|
|
411
|
+
- `normalizeActionDefinition`
|
|
412
|
+
- `withActionDefaults`
|
|
413
|
+
|
|
414
|
+
### `actions/observability.js`
|
|
415
|
+
Exports
|
|
416
|
+
- `createNoopObservabilityAdapter()`
|
|
417
|
+
|
|
418
|
+
### `actions/pipeline.js`
|
|
419
|
+
Exports
|
|
420
|
+
- `executeActionPipeline({ definition, input, context, deps = {}, idempotencyAdapter, auditAdapter, observabilityAdapter, logger = console } = {})`
|
|
421
|
+
Local functions
|
|
422
|
+
- `normalizeOutcomeErrorCode(error)`
|
|
423
|
+
- `buildActionLogPayload({ definition, context, outcome, durationMs, errorCode, idempotencyReplay })`
|
|
424
|
+
- `emitAuditEvent(adapter, payload)`
|
|
425
|
+
- `executeIdempotencyClaim(adapter, payload)`
|
|
426
|
+
|
|
427
|
+
### `actions/policies.js`
|
|
428
|
+
Exports
|
|
429
|
+
- `ensureActionChannelAllowed(definition, context)`
|
|
430
|
+
- `ensureActionSurfaceAllowed(definition, context)`
|
|
431
|
+
- `ensureActionPermissionAllowed(definition, context)`
|
|
432
|
+
- `normalizeActionInput(definition, input, context)`
|
|
433
|
+
- `normalizeActionOutput(definition, output, context)`
|
|
434
|
+
- `__testables`
|
|
435
|
+
Local functions
|
|
436
|
+
- `createActionValidationError({ status = 400, message = "Validation failed.", code = "ACTION_VALIDATION_FAILED", details, cause } = {})`
|
|
437
|
+
- `normalizeSchemaValidationErrors(schema)`
|
|
438
|
+
- `buildSchemaValidatorError({ phase, definition } = {})`
|
|
439
|
+
- `normalizeTypeBoxValidationErrors(schema, payload)`
|
|
440
|
+
- `normalizeFunctionSchemaResult(result, payload, { phase, definition } = {})`
|
|
441
|
+
- `normalizeValidatorPayload(validator, payload, { phase, definition, context })`
|
|
442
|
+
- `validateSchemaPayload(schema, payload, { phase, definition })`
|
|
443
|
+
|
|
444
|
+
### `actions/registry.js`
|
|
445
|
+
Exports
|
|
446
|
+
- `createActionRegistry({ contributors = [], idempotencyAdapter, auditAdapter, observabilityAdapter, logger = console } = {})`
|
|
447
|
+
- `__testables`
|
|
448
|
+
Local functions
|
|
449
|
+
- `normalizeContributors(contributors)`
|
|
450
|
+
- `buildDefinitionIndex(contributors)`
|
|
451
|
+
- `normalizeRequestedVersion(version)`
|
|
452
|
+
- `resolveActionDefinition(index, actionId, version)`
|
|
453
|
+
|
|
454
|
+
### `actions/requestMeta.js`
|
|
455
|
+
Exports
|
|
456
|
+
- `normalizeRequestMeta(requestMeta = {}, { fields = DEFAULT_FIELDS, emptyAsNull = false } = {})`
|
|
457
|
+
|
|
458
|
+
### `actions/textNormalization.js`
|
|
459
|
+
Exports
|
|
460
|
+
- `normalizeText`
|
|
461
|
+
- `normalizeLowerText`
|
|
462
|
+
|
|
463
|
+
### `actions/withActionDefaults.js`
|
|
464
|
+
Exports
|
|
465
|
+
- `withActionDefaults(actions = [], defaults = {})`
|
|
466
|
+
|
|
467
|
+
### runtime
|
|
468
|
+
|
|
469
|
+
### `runtime/application.js`
|
|
470
|
+
Exports
|
|
471
|
+
- `Application`
|
|
472
|
+
- `createApplication(options = {})`
|
|
473
|
+
- `createProviderClass({ id, dependsOn = [], register = null, boot = null, shutdown = null } = {})`
|
|
474
|
+
Local functions
|
|
475
|
+
- `normalizeStringArray(value)`
|
|
476
|
+
- `nowMilliseconds()`
|
|
477
|
+
|
|
478
|
+
### `runtime/container.js`
|
|
479
|
+
Exports
|
|
480
|
+
- `Container`
|
|
481
|
+
- `createContainer(options = {})`
|
|
482
|
+
- `tokenLabel(token)`
|
|
483
|
+
Local functions
|
|
484
|
+
- `normalizeToken(token)`
|
|
485
|
+
- `ensureFactory(factory, token)`
|
|
486
|
+
- `normalizeTagName(tagName)`
|
|
487
|
+
- `normalizeScopeId(scopeId)`
|
|
488
|
+
|
|
489
|
+
### `runtime/containerErrors.js`
|
|
490
|
+
Exports
|
|
491
|
+
- `ContainerError`
|
|
492
|
+
- `InvalidTokenError`
|
|
493
|
+
- `InvalidFactoryError`
|
|
494
|
+
- `DuplicateBindingError`
|
|
495
|
+
- `UnresolvedTokenError`
|
|
496
|
+
- `CircularDependencyError`
|
|
497
|
+
|
|
498
|
+
### `runtime/index.js`
|
|
499
|
+
Exports
|
|
500
|
+
- `Container`
|
|
501
|
+
- `createContainer`
|
|
502
|
+
- `tokenLabel`
|
|
503
|
+
- `ContainerError`
|
|
504
|
+
- `InvalidTokenError`
|
|
505
|
+
- `InvalidFactoryError`
|
|
506
|
+
- `DuplicateBindingError`
|
|
507
|
+
- `UnresolvedTokenError`
|
|
508
|
+
- `CircularDependencyError`
|
|
509
|
+
- `Application`
|
|
510
|
+
- `createApplication`
|
|
511
|
+
- `createProviderClass`
|
|
512
|
+
- `ServiceProvider`
|
|
513
|
+
- `KernelError`
|
|
514
|
+
- `ProviderNormalizationError`
|
|
515
|
+
- `DuplicateProviderError`
|
|
516
|
+
- `ProviderDependencyError`
|
|
517
|
+
- `ProviderLifecycleError`
|
|
518
|
+
|
|
519
|
+
### `runtime/kernelErrors.js`
|
|
520
|
+
Exports
|
|
521
|
+
- `KernelError`
|
|
522
|
+
- `ProviderNormalizationError`
|
|
523
|
+
- `DuplicateProviderError`
|
|
524
|
+
- `ProviderDependencyError`
|
|
525
|
+
- `ProviderLifecycleError`
|
|
526
|
+
|
|
527
|
+
### `runtime/serviceProvider.js`
|
|
528
|
+
Exports
|
|
529
|
+
- `ServiceProvider`
|
|
530
|
+
|
|
531
|
+
### root
|
|
532
|
+
|
|
533
|
+
### `index.js`
|
|
534
|
+
Exports
|
|
535
|
+
- `resolveLinkPath`
|
|
536
|
+
- `normalizePathname`
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Agent Reference Index
|
|
2
|
+
|
|
3
|
+
Generated by `npm run agent-docs:build`.
|
|
4
|
+
Do not edit manually.
|
|
5
|
+
|
|
6
|
+
This directory contains generated, on-demand package maps.
|
|
7
|
+
Startup navigation stays in `KERNEL_MAP.md`.
|
|
8
|
+
|
|
9
|
+
## Package Maps
|
|
10
|
+
- [agent-docs](/packages/agent-docs/reference/autogen/packages/agent-docs.md)
|
|
11
|
+
- [assistant](/packages/agent-docs/reference/autogen/packages/assistant.md)
|
|
12
|
+
- [assistant-core](/packages/agent-docs/reference/autogen/packages/assistant-core.md)
|
|
13
|
+
- [assistant-runtime](/packages/agent-docs/reference/autogen/packages/assistant-runtime.md)
|
|
14
|
+
- [auth-core](/packages/agent-docs/reference/autogen/packages/auth-core.md)
|
|
15
|
+
- [auth-provider-supabase-core](/packages/agent-docs/reference/autogen/packages/auth-provider-supabase-core.md)
|
|
16
|
+
- [auth-web](/packages/agent-docs/reference/autogen/packages/auth-web.md)
|
|
17
|
+
- [console-core](/packages/agent-docs/reference/autogen/packages/console-core.md)
|
|
18
|
+
- [console-web](/packages/agent-docs/reference/autogen/packages/console-web.md)
|
|
19
|
+
- [crud-core](/packages/agent-docs/reference/autogen/packages/crud-core.md)
|
|
20
|
+
- [crud-server-generator](/packages/agent-docs/reference/autogen/packages/crud-server-generator.md)
|
|
21
|
+
- [crud-ui-generator](/packages/agent-docs/reference/autogen/packages/crud-ui-generator.md)
|
|
22
|
+
- [database-runtime](/packages/agent-docs/reference/autogen/packages/database-runtime.md)
|
|
23
|
+
- [database-runtime-mysql](/packages/agent-docs/reference/autogen/packages/database-runtime-mysql.md)
|
|
24
|
+
- [database-runtime-postgres](/packages/agent-docs/reference/autogen/packages/database-runtime-postgres.md)
|
|
25
|
+
- [http-runtime](/packages/agent-docs/reference/autogen/packages/http-runtime.md)
|
|
26
|
+
- [kernel](/packages/agent-docs/reference/autogen/packages/kernel.md)
|
|
27
|
+
- [realtime](/packages/agent-docs/reference/autogen/packages/realtime.md)
|
|
28
|
+
- [shell-web](/packages/agent-docs/reference/autogen/packages/shell-web.md)
|
|
29
|
+
- [storage-runtime](/packages/agent-docs/reference/autogen/packages/storage-runtime.md)
|
|
30
|
+
- [ui-generator](/packages/agent-docs/reference/autogen/packages/ui-generator.md)
|
|
31
|
+
- [uploads-image-web](/packages/agent-docs/reference/autogen/packages/uploads-image-web.md)
|
|
32
|
+
- [uploads-runtime](/packages/agent-docs/reference/autogen/packages/uploads-runtime.md)
|
|
33
|
+
- [users-core](/packages/agent-docs/reference/autogen/packages/users-core.md)
|
|
34
|
+
- [users-web](/packages/agent-docs/reference/autogen/packages/users-web.md)
|
|
35
|
+
- [workspaces-core](/packages/agent-docs/reference/autogen/packages/workspaces-core.md)
|
|
36
|
+
- [workspaces-web](/packages/agent-docs/reference/autogen/packages/workspaces-web.md)
|
|
37
|
+
|
|
38
|
+
## Tooling Maps
|
|
39
|
+
- [config-eslint](/packages/agent-docs/reference/autogen/tooling/config-eslint.md)
|
|
40
|
+
- [create-app](/packages/agent-docs/reference/autogen/tooling/create-app.md)
|
|
41
|
+
- [jskit-catalog](/packages/agent-docs/reference/autogen/tooling/jskit-catalog.md)
|
|
42
|
+
- [jskit-cli](/packages/agent-docs/reference/autogen/tooling/jskit-cli.md)
|
|
43
|
+
- [test-support](/packages/agent-docs/reference/autogen/tooling/test-support.md)
|
|
44
|
+
- [testUtils](/packages/agent-docs/reference/autogen/tooling/testUtils.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# packages/agent-docs
|
|
2
|
+
|
|
3
|
+
Generated by `npm run agent-docs:build`.
|
|
4
|
+
Do not edit manually.
|
|
5
|
+
|
|
6
|
+
Generated inventory for `packages/agent-docs`.
|
|
7
|
+
Use this on demand; do not load the full index at startup.
|
|
8
|
+
|
|
9
|
+
## Scope
|
|
10
|
+
- Source: `packages/agent-docs/**/*{.js,.mjs,.cjs,.vue}`
|
|
11
|
+
- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
|
|
12
|
+
|
|
13
|
+
## Sections
|