@jskit-ai/agent-docs 0.1.1

package/reference/autogen/packages/crud-core.md

@@ -0,0 +1,283 @@
+# packages/crud-core
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/crud-core`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/crud-core/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/client/composables/createCrudClientSupport.js`
+Exports
+- `useCrudClientContext(source = {})`
+- `useCrudListRuntime(source = {})`
+- `useCrudCreateRuntime(source = {})`
+- `useCrudRecordRuntime(source = {}, { recordIdParam = "recordId" } = {})`
+- `createCrudClientSupport(source = {})`
+Local functions
+- `normalizeText(value = "")`
+- `normalizeRouteParams(params = {})`
+- `normalizePathTemplate(value = "")`
+- `resolvePathTemplate(pathTemplate = "", { routeParams = {}, params = {}, context = "resolvePathTemplate" } = {})`
+
+### `src/client/composables/crudClientSupportHelpers.js`
+Exports
+- `DEFAULT_CRUD_OWNERSHIP_FILTER`
+- `requireCrudNamespace`
+- `resolveCrudClientConfig(source = {})`
+- `formatDateTime`
+- `resolveCrudRecordChangedEvent`
+- `crudScopeQueryKey(namespace = "")`
+- `invalidateCrudQueries(queryClient, namespace = "")`
+- `crudListQueryKey(surfaceId = "", workspaceSlug = "", namespace = "")`
+- `crudViewQueryKey(surfaceId = "", workspaceSlug = "", recordId = "", namespace = "")`
+- `toRouteRecordId(value)`
+- `normalizeCrudRouteParamName(value, { context = "normalizeCrudRouteParamName" } = {})`
+- `resolveCrudRecordPathTemplates(relativePath = "", recordIdParam = "recordId")`
+- `resolveCrudRecordPathParams(recordIdLike = "", recordIdParam = "recordId")`
+Local functions
+- `normalizeRelativePath(value, { context = "resolveCrudClientConfig" } = {})`
+
+### `src/client/composables/useCrudRealtimeInvalidation.js`
+Exports
+- `useCrudRealtimeInvalidation(namespace = "", { event = "", enabled = true, matches = null, queryKey = null } = {})`
+
+### `src/client/index.js`
+Exports
+- `DEFAULT_CRUD_OWNERSHIP_FILTER`
+- `resolveCrudClientConfig`
+- `crudListQueryKey`
+- `crudViewQueryKey`
+- `crudScopeQueryKey`
+- `invalidateCrudQueries`
+- `formatDateTime`
+- `resolveCrudRecordChangedEvent`
+- `toRouteRecordId`
+- `requireCrudNamespace`
+- `useCrudClientContext`
+- `useCrudListRuntime`
+- `useCrudCreateRuntime`
+- `useCrudRecordRuntime`
+- `createCrudClientSupport`
+- `useCrudRealtimeInvalidation`
+
+### `src/server/createCrudRepositoryFromResource.js`
+Exports
+- `createCrudRepositoryFromResource(resource = {}, { context = "crudRepository", list = {} } = {})`
+
+### `src/server/createCrudServiceFromResource.js`
+Exports
+- `createCrudServiceFromResource(resource = {}, { context = "crudService" } = {})`
+
+### `src/server/createHooksToCollectChildren.js`
+Exports
+- `createHooksToCollectChildren(options = {})`
+Local functions
+- `normalizeOwnerKey(value)`
+- `toDefaultChildCallOptions(callOptions = {})`
+- `resolveListChildrenHandler(options = {}, { context = "createHooksToCollectChildren" } = {})`
+- `resolveGetChildOwnerId(options = {}, { context = "createHooksToCollectChildren" } = {})`
+- `resolveLookupContainerKey(record = {}, hookContext = {}, options = {})`
+
+### `src/server/crudModuleConfig.js`
+Exports
+- `CRUD_MODULE_ID`
+- `DEFAULT_OWNERSHIP_FILTER`
+- `CRUD_REQUESTED_OWNERSHIP_FILTER_AUTO`
+- `normalizeCrudNamespace`
+- `normalizeCrudOwnershipFilter(value, { fallback = DEFAULT_OWNERSHIP_FILTER } = {})`
+- `normalizeCrudRequestedOwnershipFilter(value, { fallback = CRUD_REQUESTED_OWNERSHIP_FILTER_AUTO } = {})`
+- `isWorkspaceRouteVisibility`
+- `requireCrudNamespace`
+- `resolveCrudNamespacePath(namespace = "")`
+- `resolveCrudRelativePath(namespace = "")`
+- `normalizeCrudRelativePath(relativePath = "", { context = "resolveCrudSurfacePolicy" } = {})`
+- `resolveCrudApiBasePath({ namespace = "", surfaceRequiresWorkspace = false } = {})`
+- `resolveCrudTableName(namespace = "")`
+- `resolveCrudActionIdPrefix(namespace = "")`
+- `resolveCrudContributorId(namespace = "")`
+- `resolveCrudDomain(namespace = "")`
+- `resolveCrudConfig(source = {})`
+- `resolveCrudSurfacePolicy(sourceConfig = {}, { surfaceDefinitions = {}, defaultSurfaceId = "", context = "resolveCrudSurfacePolicy" } = {})`
+- `resolveCrudSurfacePolicyFromAppConfig(sourceConfig = {}, appConfig = {}, options = {})`
+- `resolveCrudConfigsFromModules(modulesSource = {})`
+- `resolveCrudConfigFromModules(modulesSource = {}, options = {})`
+Local functions
+- `asRecord(value)`
+- `resolveCrudTokenPart(namespace = "")`
+- `resolveCrudToken(namespace = "", suffix = "")`
+- `normalizeSurfaceDefinitions(sourceDefinitions = {})`
+- `resolveOwnershipFilterFromSurfaceDefinition(definition = {})`
+
+### `src/server/fieldAccess.js`
+Exports
+- `createCrudFieldAccessRuntime(resource = {}, { context = "crudFieldAccess" } = {})`
+- `createFieldAccessForRoleMatrix(matrix = {}, { context = "crudFieldAccess" } = {})`
+Local functions
+- `isSchemaNullable(schema = {})`
+- `normalizeFieldSet(value, { context = "crudFieldAccess", label = "field list" } = {})`
+- `resolveFieldSet(resolver, input = {}, { context = "crudFieldAccess", label = "field list" } = {})`
+- `resolveWriteMode(fieldAccess = {}, { context = "crudFieldAccess" } = {})`
+- `buildOutputFieldRules(resource = {})`
+- `resolveRoleFromFieldAccessInput(input = {})`
+- `resolveActionFromFieldAccessInput(input = {})`
+- `resolveOperationPolicyValue(operationPolicy, input = {}, action = "*")`
+- `resolveRoleMatrixPolicy(matrix = {}, operation = "readable", input = {})`
+- `applyReadableFieldPolicyToRecord(record, allowedFields, outputRules = null, { context = "crudFieldAccess" } = {})`
+
+### `src/server/listQueryValidators.js`
+Exports
+- `createCrudCursorPaginationQueryValidator(list = {})`
+- `listSearchQueryValidator`
+- `lookupIncludeQueryValidator`
+- `resolveCrudParentFilterKeys(resource = {})`
+- `createCrudParentFilterQueryValidator(resource = {})`
+Local functions
+- `resolveCrudListUsesOrderedCursor(list = {})`
+
+### `src/server/lookupHydration.js`
+Exports
+- `createCrudLookupRuntime(resource = {}, { outputKeys = [] } = {})`
+- `hydrateCrudLookupRecords(records = [], runtime = {}, { include, mode = "list", repositoryOptions = {}, callOptions = {} } = {})`
+Local functions
+- `normalizeLookupRelationEntry(entry = {}, outputKeys = new Set())`
+- `normalizeLookupDefaultInclude(value)`
+- `normalizeLookupMaxDepth(value)`
+- `resolveLookupRuntimeDefaults(resource = {})`
+- `normalizeLookupIdentifier(value)`
+- `normalizeIncludePaths(include, { defaultInclude = DEFAULT_LOOKUP_INCLUDE } = {})`
+- `resolveChildIncludeFromPaths(paths = [])`
+- `buildLookupHydrationPlan(runtime = {}, include, { mode = "list", context = "crudRepository", includeWasExplicit = false, skippedNamespaces = new Set() } = {})`
+- `resolveLookupProviderResolver(repositoryOptions = {}, callOptions = {}, { context = "crudRepository" } = {})`
+- `resolveLookupDepthRuntime(runtime = {}, repositoryOptions = {}, callOptions = {})`
+- `buildLookupGroupKey(relation = {})`
+- `normalizeLookupRelationValues(records = [], entries = [], childIncludeByKey = {})`
+- `resolveGroupChildInclude(group = {})`
+- `normalizeLookupProvider(provider, relation = {}, { context = "crudRepository" } = {})`
+- `resolveLookupProviderOwnershipFilter(provider = {}, { context = "crudRepository" } = {})`
+- `resolveLookupVisibilityContext(provider = {}, relation = {}, callOptions = {}, { context = "crudRepository" } = {})`
+- `buildLookupRecordMap(records = [], valueKey = "")`
+- `buildLookupCollectionMap(records = [], foreignKey = "")`
+- `resolveLookupVisitedNamespaces(runtime = {}, callOptions = {})`
+
+### `src/server/lookupPathSupport.js`
+Exports
+- `normalizeCrudLookupApiPath`
+- `normalizeCrudLookupNamespace`
+- `requireCrudLookupNamespace(value = "", { context = "crudLookupProvider" } = {})`
+- `resolveCrudLookupNamespaceFromRelation(relation = {}, { context = "crudLookupProvider" } = {})`
+- `resolveCrudLookupProviderToken(namespace = "", { context = "crudLookupProvider" } = {})`
+
+### `src/server/lookupProviders.js`
+Exports
+- `resolveCrudLookupProviderToken`
+- `createCrudLookupProviderResolver(scope, { context = "crudLookupProvider" } = {})`
+- `createCrudLookupProvider(repository, { context = "crudLookupProvider", ownershipFilter = "" } = {})`
+Local functions
+- `normalizeLookupProviderOwnershipFilter(value, { context = "crudLookupProvider ownershipFilter" } = {})`
+
+### `src/server/repositoryMethods.js`
+Exports
+- `createCrudRepositoryRuntime(resource = {}, { context = "crudRepository", list = {} } = {})`
+- `crudRepositoryList(runtime, knex, query = {}, repositoryOptions = {}, callOptions = {}, hooks = null)`
+- `crudRepositoryFindById(runtime, knex, recordId, repositoryOptions = {}, callOptions = {}, hooks = null)`
+- `crudRepositoryListByIds(runtime, knex, ids = [], repositoryOptions = {}, callOptions = {}, hooks = null)`
+- `crudRepositoryListByForeignIds(runtime, knex, ids = [], foreignKey = "", repositoryOptions = {}, callOptions = {}, hooks = null)`
+- `crudRepositoryCreate(runtime, knex, payload = {}, repositoryOptions = {}, callOptions = {}, hooks = null)`
+- `crudRepositoryUpdateById(runtime, knex, recordId, patch = {}, repositoryOptions = {}, callOptions = {}, hooks = null)`
+- `crudRepositoryDeleteById(runtime, knex, recordId, repositoryOptions = {}, callOptions = {}, hooks = null)`
+Local functions
+- `requireCrudRecordId(value, { context = "crudRepository" } = {})`
+- `resolveRepositoryDefaults(resource = {}, repositoryMapping = {})`
+- `normalizeSearchColumns(searchColumns = [], fallbackColumns = [])`
+- `normalizeListOrderDirection(value = LIST_ORDER_DIRECTION_ASC)`
+- `normalizeListOrderNulls(value = LIST_ORDER_NULLS_LAST)`
+- `normalizeListOrderBy(orderBy = [], { idColumn = "id" } = {})`
+- `resolveListRuntimeConfig(list = {}, fallbackSearchColumns = [], { idColumn = "id" } = {})`
+- `encodeOrderedListCursorValue(value = null)`
+- `decodeOrderedListCursorValue(value = null)`
+- `encodeOrderedListCursor(row = null, orderBy = [])`
+- `decodeOrderedListCursor(cursor = "", orderBy = [])`
+- `applyOrderedListCursorEquality(query, descriptor = {}, value = null)`
+- `applyOrderedListCursorAfterBranch(query, descriptor = {}, value = null)`
+- `canApplyOrderedListCursorAfterBranch(descriptor = {}, value = null)`
+- `appendOrderedListCursorBranches(query, orderBy = [], cursorValues = [], index = 0, { useOr = false } = {})`
+- `applyOrderedListCursorFilter(query, { orderBy = [], cursor = "" } = {})`
+- `resolveRecordOutputValidator(resource = {}, { context = "crudRepository" } = {})`
+- `formatOutputValidationError(error = {})`
+- `normalizeRepositoryOutputRecord(runtime, record = {}, { operation = "read" } = {})`
+- `resolveCrudRepositoryCall(runtime, knex, repositoryOptions = {}, callOptions = {})`
+- `normalizeCrudRepositoryHooks(hooks = null, allowedHookKeys = [], { context = "crudRepository" } = {})`
+- `resolveOptionalCrudRepositoryHook(hooks = {}, hookKey = "", { context = "crudRepository" } = {})`
+- `applyCrudRepositoryQueryHook(dbQuery, hook = null, hookContext = {}, { context = "crudRepository", hookKey = "modifyQuery" } = {})`
+- `normalizeCrudRepositoryObjectInput(value = {})`
+- `applyCrudRepositoryPayloadHook(payload = {}, hook = null, hookContext = {}, { context = "crudRepository", hookKey = "modifyPayload" } = {})`
+- `applyCrudRepositoryRecordsHook(items = [], hook = null, hookContext = {}, { context = "crudRepository", hookKey = "afterQuery" } = {})`
+- `applyCrudRepositoryRecordHook(record = null, hook = null, hookContext = {}, { context = "crudRepository", hookKey = "transformReturnedRecord" } = {})`
+- `applyCrudRepositoryOutputHook(output, hook = null, hookContext = {}, { context = "crudRepository", hookKey = "finalizeOutput", validateOutput = null } = {})`
+- `applyCrudRepositoryAfterWriteHook(meta = {}, hook = null, hookContext = {}, { context = "crudRepository", hookKey = "afterWrite" } = {})`
+- `applyOrderedListControls(dbQuery, orderBy = [])`
+- `enforceCrudRepositoryListControls(dbQuery, { idColumn = "id", limit = DEFAULT_LIST_LIMIT + 1, orderBy = [] } = {})`
+- `createCrudRepositoryHookContextBase(runtime, repositoryOptions = {}, callOptions = {})`
+
+### `src/server/repositorySupport.js`
+Exports
+- `DEFAULT_LIST_LIMIT`
+- `MAX_LIST_LIMIT`
+- `normalizeCrudListLimit(value, { fallback = DEFAULT_LIST_LIMIT, max = MAX_LIST_LIMIT } = {})`
+- `normalizeCrudListCursor(cursor = null, { allowEmpty = true } = {})`
+- `requireCrudTableName(tableName, { context = "crudRepository" } = {})`
+- `deriveRepositoryMappingFromResource(resource = {}, { context = "crudRepository" } = {})`
+- `applyCrudListQueryFilters(query, { idColumn = "id", cursor = "", applyCursor = true, q = "", searchColumns = [], parentFilters = {}, parentFilterColumns = {} } = {})`
+- `mapRecordRow(row, fieldKeys = [], overrides = {}, { recordIdKeys = [] } = {})`
+- `buildWritePayload(sourcePayload = {}, fieldKeys = [], overrides = {})`
+- `resolveColumnName(fieldKey, overrides = {})`
+- `resolveCrudIdColumn(idColumn, { fallback = "id" } = {})`
+- `buildRepositoryColumnMetadata({ outputKeys = [], writeKeys = [], columnOverrides = {} } = {})`
+Local functions
+- `requireObjectSchemaProperties(schema, { context = "crudRepository", schemaLabel = "schema" } = {})`
+- `normalizeResourceFieldMetaEntries(fieldMeta = [])`
+- `schemaIncludesStringType(schema = {})`
+- `schemaIncludesRecordIdType(schema = {})`
+
+### `src/server/serviceEvents.js`
+Exports
+- `createCrudServiceEvents(resource = {}, { context = "crudService" } = {})`
+
+### `src/server/serviceMethods.js`
+Exports
+- `createCrudServiceRuntime(resource = {}, { context = "crudService" } = {})`
+- `crudServiceListRecords(runtime, repository, fieldAccess = {}, query = {}, options = {})`
+- `crudServiceGetRecord(runtime, repository, fieldAccess = {}, recordId, options = {})`
+- `crudServiceCreateRecord(runtime, repository, fieldAccess = {}, payload = {}, options = {})`
+- `crudServiceUpdateRecord(runtime, repository, fieldAccess = {}, recordId, payload = {}, options = {})`
+- `crudServiceDeleteRecord(runtime, repository, fieldAccess = {}, recordId, options = {})`
+Local functions
+- `requireCrudServiceRepository(runtime = {}, repository = null)`
+
+### `src/shared/crudFieldMetaSupport.js`
+Exports
+- `CRUD_LOOKUP_FORM_CONTROL_AUTOCOMPLETE`
+- `CRUD_LOOKUP_FORM_CONTROL_SELECT`
+- `CRUD_RUNTIME_LOOKUPS_FIELD_KEY`
+- `checkCrudLookupFormControl(value, { context = "crud fieldMeta ui.formControl", defaultValue = CRUD_LOOKUP_FORM_CONTROL_AUTOCOMPLETE } = {})`
+- `isCrudRuntimeOutputOnlyFieldKey(value = "", { lookupContainerKey = CRUD_RUNTIME_LOOKUPS_FIELD_KEY } = {})`
+
+### `src/shared/crudNamespaceSupport.js`
+Exports
+- `normalizeCrudNamespace(value = "")`
+- `requireCrudNamespace(namespace, { context = "requireCrudNamespace" } = {})`
+- `resolveCrudRecordChangedEvent(namespace = "")`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

package/reference/autogen/packages/crud-server-generator.md

@@ -0,0 +1,220 @@
+# packages/crud-server-generator
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/crud-server-generator`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/crud-server-generator/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/server/buildTemplateContext.js`
+Exports
+- `buildTemplateContext(input = {})`
+- `resolveScaffoldColumns(snapshot)`
+- `renderPropertyAccess(sourceName, key)`
+- `resolveGenerationSnapshot({ appRoot, tableName, idColumnOption } = {})`
+- `renderResourceFieldSchema(column, { forOutput = false } = {})`
+- `renderInputNormalizer(column)`
+- `renderOutputNormalizerExpression(column)`
+- `buildFieldMetaEntries({ outputColumns = [], writableColumns = [], snapshot = {} } = {})`
+- `resolveCrudGenerationSurfaceId({ appRoot, options } = {})`
+- `__testables`
+Local functions
+- `resolveAllowedValues(schema = {}, fallbackValues = [])`
+- `resolveGlobalScaffoldCache()`
+- `asRecord(value)`
+- `normalizeRequestedOwnershipFilter(value, { strict = false } = {})`
+- `inferOwnershipFilterFromSnapshot(snapshot)`
+- `assertOwnershipColumnsForFilter(snapshot, filter)`
+- `resolveOwnershipFilterForGeneration(snapshot, requestedOwnershipFilter, { enforceTableColumns = false } = {})`
+- `parseDotEnvLine(line = "")`
+- `loadEnvFromApp(appRoot)`
+- `createAppRequire(appRoot)`
+- `importModuleFromApp(appRequire, moduleId, contextLabel)`
+- `resolveCrudSurfaceRequiresWorkspace({ appRoot, options, surface = "" } = {})`
+- `loadCrudAppConfig(appRoot = "")`
+- `resolveSurfaceDefinitions(appConfig = {})`
+- `resolveDefaultCrudSurfaceIdFromAppConfig(appConfig = {})`
+- `resolveKnexFactory(moduleNamespace)`
+- `resolveMysqlSnapshotFromDatabase({ appRoot, tableName, idColumn } = {})`
+- `resolveColumnKey(column, idColumn)`
+- `isIdentifier(value)`
+- `renderObjectPropertyKey(value)`
+- `renderIntegerSchema(column)`
+- `renderStringSchema(column, { forOutput = false } = {})`
+- `renderResourceValidatorsImport({ needsHtmlTimeSchemas = false, needsRecordIdSchemas = false } = {})`
+- `renderResourceSchemaPropertyLines(columns, { forOutput = false } = {})`
+- `renderResourceInputNormalizationLines(columns)`
+- `renderResourceOutputNormalizationLines(columns)`
+- `renderResourceDatabaseRuntimeImport({ needsToIsoString = false, needsToDatabaseDateTimeUtc = false } = {})`
+- `renderResourceJsonImport({ needsJson = false } = {})`
+- `renderResourceNormalizeSupportImport({ needsNormalizeText = false, needsNormalizeBoolean = false, needsNormalizeFiniteNumber = false, needsNormalizeFiniteInteger = false, needsNormalizeRecordId = false, needsNormalizeIfInSource = false, needsNormalizeIfPresent = false, needsNormalizeOrNull = false } = {})`
+- `renderMigrationDefaultClause(column)`
+- `renderMigrationSpecificStringType(column, { tableCollation = "" } = {})`
+- `renderTemporalColumnBuilder(column, methodName)`
+- `renderMigrationColumnLine(column, { idColumn = DEFAULT_ID_COLUMN, primaryKeyColumns = [], foreignKeyColumnNames = new Set(), tableCollation = "" } = {})`
+- `renderMigrationColumnLines(snapshot)`
+- `renderMigrationIndexLine(index)`
+- `renderMigrationIndexLines(snapshot)`
+- `renderMigrationForeignKeyLine(foreignKey = {})`
+- `renderMigrationForeignKeyLines(snapshot)`
+- `renderMigrationCheckConstraintLines(snapshot)`
+- `mergeFieldMetaEntries(...entryGroups)`
+- `resolveLookupNamespaceFromTableName(tableName = "")`
+- `toFieldLabel(key = "")`
+- `isSupportedSelectOptionValue(value)`
+- `toSelectOptionIdentity(value)`
+- `toSelectOptionLabel(value)`
+- `normalizeFieldMetaUiOptions(rawOptions = [])`
+- `resolveEnumFieldMetaUiOptions(enumValues = [])`
+- `renderFieldMetaEntryLines(entry = {})`
+- `renderResourceFieldMetaPushLines(entries = [])`
+- `renderRepositoryListConfigLines(snapshot = {})`
+- `buildCrudPermissionIds(namespace = "")`
+- `normalizeCrudOperation(operation = "", context = "CRUD operation")`
+- `renderRoleCatalogPermissionGrants(namespace = "", { requiresNamedPermissions = true } = {})`
+- `renderActionPermissionSupport(namespace = "", { requiresNamedPermissions = true } = {})`
+- `renderActionPermissionExpression(operation = "", { requiresNamedPermissions = true } = {})`
+- `renderRouteWorkspaceSupportImports({ surfaceRequiresWorkspace = true } = {})`
+- `renderActionWorkspaceValidatorImport({ surfaceRequiresWorkspace = true } = {})`
+- `renderRouteParamsValidatorLine(operation = "", { surfaceRequiresWorkspace = true } = {})`
+- `renderRouteInputLines(operation = "", { surfaceRequiresWorkspace = true } = {})`
+- `renderActionInputValidatorExpression(operation = "", { surfaceRequiresWorkspace = true } = {})`
+- `buildReplacementsFromSnapshot({ namespace = "", snapshot, resolvedOwnershipFilter, surfaceRequiresWorkspace = true, surfaceId = "" })`
+- `resolveCrudGenerationTableName(options = {})`
+- `createCacheKey({ appRoot, options })`
+- `buildCrudTemplateContext(input = {})`
+
+### `src/server/crudModuleConfig.js`
+Exports
+- None
+
+### `src/server/CrudProvider.js`
+Exports
+- `CrudProvider`
+
+### `src/server/subcommands/addField.js`
+Exports
+- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false, resolveSnapshot = resolveGenerationSnapshot } = {})`
+Local functions
+- `toPosixPath(value = "")`
+- `resolveTargetFilePath(appRoot, targetFile)`
+- `parseSubcommandArgs(args = [])`
+- `resolveRequestedTableConfig(source = "", options = {}, context = "crud-server-generator scaffold-field")`
+- `resolveColumnForField(snapshot = {}, fieldKey = "", { idColumn = "id" } = {})`
+- `buildFieldMetaEntry(snapshot = {}, column = {})`
+- `collectKnownIdentifiers(expression = "")`
+- `resolveImportsForField({ inputNormalizationExpression = "", outputNormalizationExpression = "" } = {})`
+- `resolveOutputNormalizationExpression(column = {})`
+
+### `src/server/subcommands/resourceAst.js`
+Exports
+- `resolveCrudResourceDefaults(source = "", context = "crud-server-generator scaffold-field")`
+- `applyCrudResourceFieldPatch(source = "", { fieldKey = "", outputSchemaExpression = "", createSchemaExpression = "", outputNormalizationExpression = "", inputNormalizationExpression = "", fieldMetaEntry = null, normalizeImportNames = [], databaseRuntimeImportNames = [], databaseRuntimeRepositoryOptionsImportNames = [], context = "crud-server-generator scaffold-field" } = {})`
+Local functions
+- `isIdentifierName(value = "")`
+- `parseModule(source = "", context = "crud-server-generator scaffold-field")`
+- `parseExpression(source = "", context = "crud-server-generator scaffold-field")`
+- `parseStatement(source = "", context = "crud-server-generator scaffold-field")`
+- `resolveNodeKeyName(keyNode, { computed = false } = {})`
+- `createObjectPropertyKeyNode(key = "")`
+- `findVariableDeclarator(programNode, variableName = "")`
+- `requireVariableDeclarator(programNode, variableName = "", context = "crud-server-generator scaffold-field")`
+- `requireSchemaPropertiesObject(programNode, variableName = "", context = "crud-server-generator scaffold-field")`
+- `requireObjectFreezePayloadObject(programNode, variableName = "", context = "crud-server-generator scaffold-field")`
+- `findObjectPropertyByName(objectNode, propertyName = "")`
+- `requireNormalizeFunctionBody(programNode, variableName = "", context = "crud-server-generator scaffold-field")`
+- `requireNormalizedObjectLiteral(functionBody, context = "crud-server-generator scaffold-field")`
+- `hasObjectProperty(objectNode, propertyName = "")`
+- `insertObjectProperty(objectNode, propertyName = "", valueExpressionSource = "", { context = "crud-server-generator scaffold-field", insertBeforeComputed = false } = {})`
+- `hasNormalizeIfInSourceCall(functionBody, fieldKey = "")`
+- `resolveReturnNormalizedIndex(functionBody)`
+- `hasResourceFieldMetaEntry(programNode, fieldKey = "")`
+- `sortImportSpecifiers(importDeclaration)`
+- `ensureNamedImport(programNode, modulePath = "", importName = "")`
+- `resolveObjectPropertyStringValue(objectNode, propertyName = "")`
+- `renderResourceFieldMetaPushStatement(entry = {})`
+
+### `src/shared/crud/crudResource.js`
+Exports
+- `crudResource`
+
+### `src/shared/index.js`
+Exports
+- `crudResource`
+
+### templates
+
+### `templates/migrations/crud_initial.cjs`
+Exports
+- None
+
+### `templates/src/local-package/package.descriptor.mjs`
+Exports
+- None
+
+### `templates/src/local-package/server/actionIds.js`
+Exports
+- `actionIds`
+
+### `templates/src/local-package/server/actions.js`
+Exports
+- `createActions({ surface = "" } = {})`
+Local functions
+- `requireActionSurface(surface = "")`
+
+### `templates/src/local-package/server/CrudProvider.js`
+Exports
+- `${option:namespace|pascal`
+Local functions
+- `resolveCrudPolicyFromApp(app)`
+
+### `templates/src/local-package/server/listConfig.js`
+Exports
+- `LIST_CONFIG`
+
+### `templates/src/local-package/server/registerRoutes.js`
+Exports
+- `registerRoutes(app, { routeOwnershipFilter = "public", routeSurface = "", routeRelativePath = "" } = {})`
+
+### `templates/src/local-package/server/repository.js`
+Exports
+- `createRepository(knex, options = {})`
+
+### `templates/src/local-package/server/service.js`
+Exports
+- `createService({ ${option:namespace|camel}Repository, fieldAccess = DEFAULT_FIELD_ACCESS } = {})`
+- `serviceEvents`
+
+### `templates/src/local-package/shared/crudResource.js`
+Exports
+- `resource`
+
+### `templates/src/local-package/shared/index.js`
+Exports
+- `resource`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None
+
+### test-support
+
+### `test-support/templateServerFixture.js`
+Exports
+- `resource`
+- `createTemplateServerFixture(options = {})`
+Local functions
+- `buildTemplateReplacements({ surfaceRequiresWorkspace = true, requiresNamedPermissions = surfaceRequiresWorkspace === true, surfaceId = surfaceRequiresWorkspace ? "admin" : "home" } = {})`
+- `applyTemplateReplacements(sourceText = "", options = {})`
+- `buildResourceStubSource()`
+- `renderServerTemplateFile(targetServerDirectory, fileName, options)`

package/reference/autogen/packages/crud-ui-generator.md

@@ -0,0 +1,154 @@
+# packages/crud-ui-generator
+
+Generated by `npm run agent-docs:build`.
+Do not edit manually.
+
+Generated inventory for `packages/crud-ui-generator`.
+Use this on demand; do not load the full index at startup.
+
+## Scope
+- Source: `packages/crud-ui-generator/**/*{.js,.mjs,.cjs,.vue}`
+- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `LEGACY/`
+
+## Sections
+
+### src
+
+### `src/server/buildTemplateContext.js`
+Exports
+- `buildUiTemplateContext({ appRoot, options } = {})`
+Local functions
+- `resolveAllowedValues(schema = {}, fallbackValues = [])`
+- `splitTextIntoWords(value = "")`
+- `wordsToKebab(words = [])`
+- `wordsToTitle(words = [])`
+- `toSingularKebab(value = "")`
+- `toPluralKebab(value = "")`
+- `toTitleFromKebab(value = "", fallback = "")`
+- `normalizeRelativeAppPath(value = "")`
+- `requireTargetRootOption(options = {})`
+- `resolveListTargetFile(targetRoot = "")`
+- `parseOperationsOption(options)`
+- `parseDisplayFieldsOption(options)`
+- `validateDisplayFieldsForOperation(selectedFieldKeys, fields, operationName)`
+- `filterDisplayFields(selectedFieldKeys, fields)`
+- `filterDefaultHiddenListFields(selectedFieldKeys, fields, { recordIdFieldKey = "" } = {})`
+- `ensureFields(fields, fallbackFields = createFieldDefinitions({}))`
+- `resolveViewTitleFallbackFieldKey(fields = [])`
+- `resolveResourceNamespace(resource = {}, pageTarget = {}, options = {})`
+- `resolveResourceLabels(namespace = "", pageTarget = {})`
+- `resolveTargetRootRelativeRoutePath(pageTarget = {})`
+- `resolveMenuToPropLine(linkTo = "")`
+- `resolveCrudRelativePath(namespace = "")`
+
+### `src/server/resourceSupport.js`
+Exports
+- `normalizeText`
+- `requireOption(options, optionName, { context = "ui-generator" } = {})`
+- `resolveResourceModulePath(appRoot, resourceFile, { context = "ui-generator" } = {})`
+- `loadResourceDefinition({ appRoot, options = {}, context = "ui-generator" } = {})`
+- `requireOperation(resource, operationName, { context = "ui-generator" } = {})`
+- `resolveOperationRealtimeEvents(operation = {}, { defaultEvents = [], context = "ui-generator" } = {})`
+- `requireOutputSchema(operation, operationName, { context = "ui-generator" } = {})`
+- `requireBodySchema(operation, operationName, { context = "ui-generator" } = {})`
+- `requireObjectProperties(schema, contextLabel, { context = "ui-generator" } = {})`
+- `resolveListItemProperties(listOutputSchema, { context = "ui-generator" } = {})`
+- `resolveLookupContainerKey(resource = {}, { context = "ui-generator" } = {})`
+- `buildResourceFieldMetaMap(resource = {})`
+- `createFieldDefinitions(properties = {}, { fieldMetaMap = {}, lookupContainerKey = "lookups" } = {})`
+- `createFormFieldDefinitions(properties = {}, { fieldMetaMap = {}, lookupContainerKey = "lookups", parentRouteParamKey = "" } = {})`
+- `resolveNearestParentRouteParamKey(routePath = "", { recordIdParam = "recordId" } = {})`
+- `buildListHeaderColumns(fields = [])`
+- `buildListRowColumns(fields = [])`
+- `buildViewColumns(fields = [])`
+- `buildFormColumns(fields = [])`
+- `resolveRecordIdFieldKey(fields = [])`
+- `renderObjectPushLines(arrayName, entries = [])`
+- `resolveRecordChangedEventName`
+- `resolveRecordIdExpression(fields = [])`
+Local functions
+- `normalizeRealtimeEventList(events = [])`
+- `resolveUnionSchemaVariant(schema = {})`
+- `resolveSchemaType(schema)`
+- `toFieldLabel(key)`
+- `isSupportedSelectOptionValue(value)`
+- `toSelectOptionLabel(value)`
+- `toSelectOptionIdentity(value)`
+- `normalizeFieldUiOptions(rawOptions, { context = "resource fieldMeta ui.options" } = {})`
+- `stripLookupIdSuffix(key = "")`
+- `resolveFieldLabel(key = "", relation = null)`
+- `extractDynamicRouteParamKeys(routePath = "")`
+- `normalizeLookupRelation(relation = {})`
+- `toLookupRelation(fieldMetaMap = {}, fieldKey = "", { lookupContainerKey = "lookups" } = {})`
+- `resolveFormInputType(fieldType, fieldFormat)`
+- `resolveFormFieldComponent(fieldType, relation = null)`
+- `toPositiveInteger(value)`
+- `toAccessorExpression(baseName, fieldKey)`
+- `toOptionalAccessorExpression(baseName, fieldKey)`
+- `escapeHtml(value)`
+- `serializeTemplateBindingValue(value)`
+- `isLookupField(field = {})`
+- `toLookupDisplayFieldDescriptor(field = {})`
+- `toLookupDisplayFieldExpression(field = {})`
+
+### `src/server/subcommands/addField.js`
+Exports
+- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
+Local functions
+- `toPosixPath(value = "")`
+- `resolveOperation(rawOperation = "")`
+- `resolveTargetFilePath(appRoot, targetFile)`
+- `resolvePathWithinAppRoot(appRoot, absolutePath)`
+- `inferResourceOptionsFromSource(screenSource = "")`
+- `resolveResourceOptions(options = {}, inferredOptions = {})`
+- `resolveOperationFields(resource, operationName)`
+- `resolveFieldDefinition(fields = [], fieldKey = "")`
+- `insertBeforeAnchor(source, { anchor = "", snippet = "" } = {})`
+- `resolveAnchorScopeStart(source = "", { anchorIndex = -1, anchor = "" } = {})`
+- `buildAnchorInsertions(operationName, field)`
+- `resolveGeneratedTargetComment(source = "", commentName = "")`
+- `resolveOperationTargetFiles({ appRoot, operationName, targetAbsolutePath, source = "" } = {})`
+- `parseSubcommandArgs(args = [])`
+
+### templates
+
+### `templates/src/pages/admin/ui-generator/AddEditForm.vue`
+Exports
+- None
+Local functions
+- `resolveCancelTo(target)`
+
+### `templates/src/pages/admin/ui-generator/AddEditFormFields.js`
+Exports
+- `UI_CREATE_FORM_FIELDS`
+- `UI_EDIT_FORM_FIELDS`
+
+### `templates/src/pages/admin/ui-generator/EditElement.vue`
+Exports
+- None
+
+### `templates/src/pages/admin/ui-generator/EditWrapperElement.vue`
+Exports
+- None
+
+### `templates/src/pages/admin/ui-generator/ListElement.vue`
+Exports
+- None
+
+### `templates/src/pages/admin/ui-generator/NewElement.vue`
+Exports
+- None
+
+### `templates/src/pages/admin/ui-generator/NewWrapperElement.vue`
+Exports
+- None
+
+### `templates/src/pages/admin/ui-generator/ViewElement.vue`
+Exports
+- None
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None