@jskit-ai/agent-docs 0.1.131 → 0.1.132

package/patterns/crud-scaffolding.md

@@ -1,198 +0,0 @@
-# CRUD Scaffolding Patterns
-
-Use when:
-
-- creating a new CRUD-backed entity
-- deciding how to create a CRUD table
-- deciding whether to scaffold server first or UI first
-- deciding whether a CRUD needs a migration, a generator, or both
-
-Check first:
-
-- the intended ownership model
-- the real database table shape
-- `jskit show crud-server-generator --details`
-- whether the request is server-only CRUD or server-plus-UI CRUD
-
-## Fresh minimal-app order
-
-After `create-app`, run `npm install` before invoking the local CLI, and then
-use `npx --no-install jskit` so a missing local CLI fails clearly. For a fresh
-minimal CRUD app, the complete order is:
-
-1. create the app
-2. `npm install`
-3. add the database runtime
-4. `npm install`
-5. create the live table in a fresh disposable development database
-6. run `crud-server-generator scaffold`
-7. `npm install`
-8. run `crud-ui-generator crud`
-
-The server generator resolves its complete package dependency closure. In
-particular, `shell-web` owns and establishes `src/placement.js` before
-`realtime` appends its placement. Do not pre-install `shell-web` as a
-workaround.
-
-## Non-negotiable database contract
-
-Before database, schema, CRUD, repository, or persistence work, read this
-pattern completely. Use the database selected for this app's development
-runtime; never alter a production or other valuable database to develop or
-verify schema changes. Prove the complete migration
-chain against a fresh disposable database before reporting completion.
-
-For normal app-owned CRUD tables:
-
-- use exactly one non-null integer primary-key column, normally
-  `id BIGINT UNSIGNED AUTO_INCREMENT PRIMARY KEY`
-- make every foreign key single-column and point it directly to the referenced
-  table's single-column primary key
-- use multi-column unique indexes only for business uniqueness, never as
-  relationship targets
-- use only direct `workspace_id` and/or `user_id` columns for generated JSKIT
-  ownership, and select the ownership filter that matches those columns exactly
-- express tenant-safe relationships as direct ownership plus a normal
-  `parent_id -> parent.id` relationship; resolve related IDs through the
-  workspace-scoped service and test both allowed and cross-workspace cases
-
-Do not use composite primary keys or composite foreign keys to encode tenant
-ownership, target a business key from a foreign key, or duplicate parent
-identity when the related row ID already identifies it. Stop before generation
-if the proposed table violates these constraints.
-
-Rules:
-
-- For a CRUD-backed entity, create the validated table in the managed
-  development database first. Then make
-  `jskit generate crud-server-generator scaffold ...` the first JSKIT scaffold.
-- Unless the table is already owned by a JSKIT baseline package or is an explicit narrow exception recorded in `.jskit/table-ownership.json`, every persisted app-owned table must go through that server CRUD step first.
-- That server scaffold is the crucial first step even if no CRUD UI will be created yet.
-- If the table should already be CRUD-owned but should not expose public CRUD HTTP routes yet, scaffold it with `jskit generate crud-server-generator scaffold ... --internal` instead of dropping to direct knex or a hand-built pseudo-repository.
-- Create the real table directly in the database before scaffolding. `crud-server-generator` reads the live table shape.
-- If `crud-server-generator` is going to own the CRUD, do not hand-write a separate CRUD migration for that table. The generator installs and manages the CRUD migration scaffold itself.
-- Never modify or replace a generator-owned baseline migration after it has
-  been installed. Later schema evolution must use a new immutable,
-  package-owned additive migration declared through `install-migration`.
-- Keep generated table creation in `migrations/` and generated foreign keys in
-  `migrations/constraints/`. The database runtime deliberately runs those
-  phases in that order so valid mutual foreign keys rebuild cleanly without
-  disabling constraint checks.
-- Do not scaffold CRUD UI, hand-build CRUD routes, or hand-build CRUD endpoints before the server CRUD package and shared resource file exist.
-- Treat the generated shared resource file as the canonical CRUD contract for later UI scaffolding and CRUD behavior changes.
-- Treat the exact columns `workspace_id` and `user_id` as reserved JSKIT ownership columns. They are the only standard columns used for generated ownership filtering and create-time owner stamping.
-- Treat other foreign keys such as `recipient_user_id`, `created_by_user_id`, `assignee_user_id`, and similarly specific names as domain relationships, not ownership aliases. Do not rename a relationship to `user_id` or `workspace_id` merely to satisfy tooling.
-- Require the resolved ownership filter to match the reserved columns exactly: neither the filter nor the schema may silently add or omit `workspace_id` or `user_id` ownership.
-- `feature-server-generator` is not the default lane for ordinary persisted entities. Use it for workflows or orchestration that sit on top of CRUD-owned tables, or for rare explicit non-CRUD exceptions.
-- Generated CRUD UI must be compact-first. Lists need searchable cards on compact widths and tables only for medium/expanded layouts.
-- Generated CRUD list screens need real loading, empty, and error states. Empty copy should name the resource, such as "No customers yet", and offer the create action when available.
-- Generated CRUD view/new/edit screens should use page headers plus direct sheet panels. Do not use generic card shells as the page architecture.
-- Keep generated reusable Vue helpers outside `src/pages/`; the file router inventories every Vue file below that root as a browser route. CRUD form helpers mirror the validated target root under `src/components/`.
-- Permission-gated generated CRUD lists should pass `readEnabled` into `useCrudListScreen(...)` instead of replacing the shared list wrapper.
-- Compact CRUD actions should be reachable without a drawer. Use a mobile-visible primary action or FAB for create flows.
-- Row actions should be declared with `defineCrudListRowActions(...)` in a page-local `listRowActions.js` and passed into `useCrudListScreen(...)`; the shared list screen owns the compact/wide action rendering.
-- Use `syntheticRows` for display-only owner/master rows that should appear inside the shared list layout without becoming CRUD records.
-- Bulk actions should be declared in the generated page-local `listBulkActions.js`. The generated list owns selection state, keeps selection controls hidden until actions exist, and exposes selected ids/records to action handlers.
-- Structured filters should use shared filter definitions and collapse to compact filter controls/sheets when they outgrow simple search. Do not stack dense desktop filter bars on phone widths.
-- Use `--navigation-role` for CRUD list placement intent. Main resources can stay `primary`; nested/detail/workflow CRUD routes should usually be `secondary`, `workflow`, or `none`.
-- Add `--delete-confirmation` when the generated view needs the standard
-  destructive record action. The flag requires list and view pages and a
-  resource with a `DELETE` operation; it uses `CrudDeleteAction` in the public
-  view-screen action slot and the standard command composable rather than
-  generating page-local dialog or request code.
-
-## Temporal values at resource boundaries
-
-Resource validators accept strict string temporal values and reject JavaScript
-`Date` objects:
-
-- `date` is `YYYY-MM-DD`
-- `time` is offset-free `HH:MM[:SS[.fraction]]`
-- `dateTime` is RFC 3339 with seconds and `Z` or a numeric offset
-
-Use `epochMilliseconds` or `epochSeconds` for numeric epoch values after
-checking the stored unit. Preserve the field's
-`temporalPrecision`; do not truncate meaningful fractional seconds.
-
-Generated generic CRUD repositories serialize database temporal outputs
-before resource validation. App-owned/custom repositories must return strict
-strings and must write ISO/RFC 3339 strings rather than passing `Date` objects.
-
-## Baseline generation versus later schema evolution
-
-The initial CRUD scaffold and a later schema change are different operations:
-
-- The server generator owns the baseline migration that recreates the table
-  from zero. Do not edit, replace, or regenerate that installed baseline to
-  express a later change.
-- The table's app-local package owns later schema evolution. Create each change
-  as a new immutable additive migration:
-
-  ```bash
-  npx jskit create migration \
-    --package @local/workflow-record-report-values \
-    --id extend-report-value-field-types
-  ```
-
-- The authoring command creates an editable migration template and adds its
-  `install-migration` mutation to the owning package's `package.json.jskit` in
-  one operation. Implement and test the template before synchronizing it.
-- Synchronize the completed source with
-  `npx jskit migrations sync`, then apply it with
-  `npm run db:migrate`.
-- SQL or Knex schema operations inside that source-controlled migration are
-  supported. Ad-hoc SQL applied only to one database is not: it creates schema
-  drift and leaves fresh installations incorrect.
-- Installed migration ids and content are immutable. A correction to an
-  installed migration is another additive migration with a new id.
-
-A package-owned additive migration is not the prohibited "separate CRUD
-migration." The prohibition applies to competing with or modifying the
-generator-owned baseline.
-
-Meaning of `--internal`:
-
-- it keeps the generated repository, service, actions, provider, resource, and CRUD migration ownership chain
-- it only suppresses public HTTP CRUD route registration
-- it is not a substitute for ownership columns or action/route permissions
-- it does not suppress generated action permission ids or decide which role receives them
-
-Workspace role grants:
-
-- every workspace-required CRUD generation must explicitly choose `--grant-role <role-id>` or `--no-role-grant`
-- applications that assign generated CRUD permissions to `member` must say `--grant-role member`; fixed-role applications must name one of their real roles or choose no automatic grant
-- `--grant-role` and `--no-role-grant` are permission-design choices independent of `--internal`
-- never invent a `member` role only to satisfy the generator
-
-When a weird-custom persistence lane is proposed:
-
-- Treat hand-written repositories for persisted app-owned entity tables as an exception path, not a normal choice.
-- That includes things like:
-  - direct knex instead of generated CRUD ownership
-  - a custom repository/service/provider stack for a normal persisted entity table
-  - inherited-ownership or mixed-visibility workarounds that dodge the standard CRUD ownership model
-- Before taking that path, stop and ask the developer for explicit approval.
-- Record the exact approval and the approved exception in `.jskit/WORKBOARD.md` before coding.
-- If that exception changes the durable architecture rather than only the current chunk, record it in `.jskit/APP_BLUEPRINT.md` too.
-- Without that explicit approval record, do not take the weird-custom persistence path.
-- Record durable, approved schema exceptions in `.jskit/APP_BLUEPRINT.md` as
-  well as the table-ownership exception; an exception must not silently weaken
-  the normal generated CRUD contract.
-
-Before reporting completion:
-
-- verify there are no composite primary or foreign keys in the generated CRUD
-  tables
-- verify every generated CRUD foreign key targets a single-column primary key
-- apply the generated migrations from zero to a fresh disposable database
-- compare the recreated schema with the intended development schema
-- run positive and negative cross-workspace relationship tests where ownership
-  applies, then run JSKIT Doctor and the project's normal verifier
-
-Avoid:
-
-- writing a hand migration for a CRUD table that JSKIT CRUD scaffolding is supposed to own
-- starting with `crud-ui-generator` before the server scaffold exists
-- hand-building CRUD routes or validators that duplicate the generated server resource contract
-- letting a new app-owned table exist in the live database without either generated CRUD ownership or a documented `.jskit/table-ownership.json` exception
-- accepting table-only CRUD UI as "done" when the route is visible on phone widths

package/patterns/generated-ui-contract-tracking.md

@@ -1,66 +0,0 @@
-# Generated UI Contract Tracking
-
-Use this file to track the generator-level UI contract work. Keep entries concrete and update the checklist as each slice lands.
-
-## Goal
-
-Generated JSKIT apps should feel like real adaptive apps by default, not framework demos. The contract must be enforced in generators, package metadata, docs, and tests so it does not drift.
-
-## Current Scope
-
-- [x] Centralize navigation role behavior beyond per-generator helpers.
-- [x] Improve product-aware navigation inference and CLI prompting.
-- [x] Audit generated/package UI templates for placeholder or instructional live-page copy.
-- [x] Formalize surface density rules for app, admin, console, and settings screens.
-- [x] Add shared typography/density primitives or generator support helpers where they reduce duplication.
-- [x] Enforce "no cards inside cards" for generated page architecture while preserving intentional tool/dialog cards.
-- [x] Expand UI verification from shell smoke coverage to generator-pattern smoke coverage for current page, CRUD, and shell outputs.
-- [x] Centralize the JSKIT design contract and make tests consume it.
-
-## Work Slices
-
-- [x] Slice 1: create the central contract/support seam and move navigation-role constants into it.
-- [x] Slice 2: wire `ui-generator` and `crud-ui-generator` to the shared contract.
-- [x] Slice 3: add template/content contract scans for placeholder copy, card-shell misuse, and missing responsive hooks.
-- [x] Slice 4: audit package templates that ship live UI and classify intentional cards.
-- [x] Slice 5a: extend generated app Playwright smoke coverage to assert the generated screen contract.
-- [x] Slice 5b: enforce page, CRUD, and shell generator-pattern verification through shared source contracts plus responsive smoke checks.
-- [x] Slice 6: update distributed agent docs and regenerated references/catalog outputs.
-
-## Verification Checklist
-
-- [x] `npm run lint`
-- [x] `npm run check:runtime-deps`
-- [x] `npx jskit lint-packages`
-- [x] `npm run catalog:build`
-- [x] `npm run agent-docs:build`
-- [x] `npm test --workspace @jskit-ai/kernel`
-- [x] `npm test --workspace @jskit-ai/ui-generator`
-- [x] `npm test --workspace @jskit-ai/crud-ui-generator`
-- [x] `npm test --workspace @jskit-ai/shell-web`
-- [x] `npm test --workspace @jskit-ai/http-web`
-- [x] `npm test --workspace @jskit-ai/workspaces-web`
-- [x] `npm test --workspace @jskit-ai/jskit-cli`
-- [x] `npm test --workspace @jskit-ai/create-app`
-- [x] `npm test --workspace @jskit-ai/agent-docs`
-- [x] `git diff --check`
-
-## Notes
-
-- Do not weaken semantic placement defaults while adding navigation inference.
-- Do not turn the contract into runtime business logic; it is generator and template policy.
-- Do not remove intentional cards from specialist UI components just to satisfy a broad scan.
-- Keep generated files deterministic and update catalog/agent-doc outputs when package metadata or exported symbols change.
-- Kernel shared UI contract must stay surface-id agnostic. Concrete mappings like admin/console to operator profile belong in generators or package templates.
-- Item 3 is complete for current generated surfaces: page, CRUD, shell, and starter outputs require compact/medium/expanded coverage, horizontal overflow checks, generated screen checks, and compact generated-screen 48px tap target checks. Calendar/grid/bottom-sheet specialist generators remain future scope until those generators exist.
-- Item 5 is complete for current generators: `primary`, `secondary`, `utility`, `detail`, `workflow`, and `none` are centralized in the generated UI contract, generators consume that contract, and `utility` resolves to seeded `shell.global-actions` topology.
-- Item 6 is complete for the default shell: compact app bars use compact density and bounded top-left/top-right regions, while primary navigation remains in semantic bottom navigation instead of app-bar chrome.
-- CRUD filters are client-side by default: generated list pages create a page-local `listFilters.js` and pass it into `useCrudListScreen(...)`; the shared list screen wires `filterRuntime.queryParams` into the list request and renders `CrudListFilterSurface`. When server filtering is needed, promote the definitions into a shared package module and use `createCrudListFilterContract(...)` so route/action validators, JSON REST search schema, and repository query normalization stay derived from the same definition.
-- CRUD bulk actions are client-side by default: generated list pages create a page-local `listBulkActions.js` and pass it into `useCrudListScreen(...)`; the shared list screen wires `useCrudListBulkActions(...)` and keeps selection controls hidden until actions are declared.
-- CRUD row actions are client-side by default: generated list pages can create a page-local `listRowActions.js` with `defineCrudListRowActions(...)` and pass it into `useCrudListScreen(...)`; the shared list screen renders per-row actions in card and table layouts while action handlers stay explicit and page-owned.
-- CRUD synthetic rows are display-only: pass `syntheticRows` into `useCrudListScreen(...)` for owner/master rows that are not repository records. Synthetic rows render through the shared list screen, skip standard Open/Edit links, and are excluded from bulk selection unless explicitly marked selectable.
-- Generated CRUD page templates delegate their screen chrome to shared `http-web` screen components (`CrudListScreen`, `CrudViewScreen`, and `CrudAddEditScreen`) so list/view/form load states, retry actions, responsive shell layout, filters, bulk actions, row actions, and detail slots do not drift across generated pages.
-- Generated CRUD list pages should use `useCrudListScreen({ requestQueryParams, readEnabled })` for list read pass-throughs instead of replacing the shared list chrome for includes or permission-gated reads.
-- Generated CRUD detail pages should use `useCrudViewScreen({ requestQueryParams, readEnabled, queryKeyFactory })` for read pass-throughs and `CrudViewScreen` slots (`before-fields`, `fields`, `after-fields`, `supporting-content`) for domain sections instead of replacing the shared detail chrome.
-- Routine resource-load errors stay local to the generated screen and retry affordance. Action feedback uses the shell error policy through `action-feedback`.
-- `page.supporting-content` is a semantic supporting region in the default shell. Compact layout renders it as a closed bottom sheet; medium/expanded layouts render it as a closed side panel.

package/reference/autogen/packages/assistant.md

@@ -1,68 +0,0 @@
-# packages/assistant
-
-Generated by `npm run agent-docs:build`.
-Do not edit manually.
-
-Generated inventory for `packages/assistant`.
-Use this on demand; do not load the full index at startup.
-
-## Scope
-- Source: `packages/assistant/**/*{.js,.mjs,.cjs,.vue}`
-- Excludes: `test/`, `tests/`, `__tests__/`, `*.test.*`, `*.spec.*`, `*.vitest.*`, `node_modules/`, `dist/`, `coverage/`, `docs/`, `.vitepress/cache/`, `.vitepress/dist/`
-
-## Sections
-
-### src
-
-### `src/server/buildTemplateContext.js`
-Exports
-- `buildTemplateContext({ appRoot, options } = {})`
-
-### `src/server/pageSupport.js`
-Exports
-- `readAssistantPageTemplateSource(kind = "page")`
-- `renderAssistantPageSource(templateSource = "", surfaceId = "")`
-- `resolveAssistantPageGenerationContext({ appRoot, targetFile = "", options = {}, context = "assistant page" } = {})`
-- `renderAssistantPageLinkPlacementBlock({ marker = "", pageTarget = {}, generationContext = {} } = {})`
-- `renderAssistantPageSummary(pageTarget = {}, { pageAlreadyExisted = false, pageOverwritten = false } = {})`
-Local functions
-- `resolveLinkToPropLine(linkTo = "")`
-- `resolveOwnerLine(owner = "")`
-- `resolveTemplateFilePath(relativePath = "")`
-
-### `src/server/subcommands/page.js`
-Exports
-- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
-
-### `src/server/subcommands/settingsPage.js`
-Exports
-- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
-
-### `src/server/subcommands/support.js`
-Exports
-- `PLACEMENT_FILE`
-- `requireSinglePositionalTargetFile(args = [], { context = "assistant" } = {})`
-- `rejectUnexpectedOptions(options = {}, allowedOptionNames = [], { context = "assistant" } = {})`
-- `resolvePathWithinApp(appRoot, targetPath, { context = "assistant" } = {})`
-- `appendBlockIfMarkerMissing(source = "", marker = "", block = "")`
-- `requireEmptyPageSource(existingSource = "", targetRelativePath = "", { context = "assistant", forceOverwrite = false } = {})`
-Local functions
-- `ensureTrailingNewline(value = "")`
-
-### `src/server/support.js`
-Exports
-- `normalizeConfigScope(value = "")`
-- `loadAppConfig(appRoot = "")`
-- `resolveSurfaceDefinition(appConfig = {}, surfaceId = "", optionName = "surface")`
-- `assertAssistantSurfaceIsAvailable(appConfig = {}, surfaceId = "", expected = {})`
-- `resolveAiConfigPrefix(surfaceId = "", explicitPrefix = "")`
-
-### templates
-
-### `templates/src/pages/assistant/index.vue`
-Exports
-- None
-
-### `templates/src/pages/settings/assistant/index.vue`
-Exports
-- None

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

@@ -1,215 +0,0 @@
-# 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/`, `.vitepress/cache/`, `.vitepress/dist/`
-
-## Sections
-
-### src
-
-### `src/server/buildTemplateContext.js`
-Exports
-- `buildTemplateContext(input = {})`
-- `resolveScaffoldColumns(snapshot)`
-- `resolveGenerationSnapshot({ appRoot, tableName, idColumnOption } = {})`
-- `renderCanonicalResourceFieldSchema(column, { fieldContractEntry = null } = {})`
-- `buildFieldContractEntries({ outputColumns = [], writableColumns = [], snapshot = {} } = {})`
-- `resolveCrudGenerationSurfaceId({ appRoot, options, appConfig = null } = {})`
-- `prepareInstallHook({ appRoot, packageOptions = {} } = {})`
-- `__testables`
-Local functions
-- `resolveAllowedValues(schema = {}, fallbackValues = [])`
-- `resolveGlobalScaffoldCache()`
-- `asRecord(value)`
-- `resolveBooleanFlagOption(options = {}, optionName = "")`
-- `resolveInternalRouteOption(options = {})`
-- `resolveNoRoleGrantOption(options = {})`
-- `normalizeCrudAccess(value, { strict = false } = {})`
-- `assertCrudAccessCompatibility(access, { surfaceRequiresWorkspace = false, ownershipFilter = "" } = {})`
-- `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 = "", appConfig = null } = {})`
-- `loadCrudAppConfig(appRoot = "")`
-- `resolveSurfaceDefinitions(appConfig = {})`
-- `resolveDefaultCrudSurfaceIdFromAppConfig(appConfig = {})`
-- `resolveKnexFactory(moduleNamespace)`
-- `resolveMysqlSnapshotFromDatabase({ appRoot, tableName, idColumn } = {})`
-- `resolveColumnKey(column, idColumn)`
-- `normalizeNumericBoundValue(value, scale = null)`
-- `resolveNumericExclusiveStep(column)`
-- `applyLowerBound(current = null, candidate = null)`
-- `applyUpperBound(current = null, candidate = null)`
-- `applyNumericConstraintBound(target = {}, column = null, operator = "", rawValue = null)`
-- `resolveColumnNumericBounds(snapshot = {})`
-- `isIdentifier(value)`
-- `renderObjectPropertyKey(value)`
-- `renderBoundedNumberEntries(column)`
-- `resolveCanonicalResourceFieldRequired(column = {})`
-- `renderCanonicalResourceOperations(column = {})`
-- `renderCanonicalResourceSchemaPropertyLines(columns = [], { fieldContractEntries = [] } = {})`
-- `resolveJsonRestRelationshipScopeName(fieldContractEntry = null)`
-- `resolveJsonRestRelationshipAlias(column = null)`
-- `resolveJsonRestFieldType(column = {})`
-- `shouldRenderJsonRestSearch(column = {})`
-- `shouldRenderJsonRestStorage(column = {})`
-- `renderJsonRestFieldSchema(column, { fieldContractEntry = null } = {})`
-- `renderJsonRestSchemaPropertyLines(columns = [], { fieldContractEntries = [] } = {})`
-- `renderJsonRestSearchSchemaLines(columns = [])`
-- `renderJsonRestDefaultSortLine(columns = [])`
-- `renderResourceDefaultSortLiteral(columns = [])`
-- `renderCurrentTimestampExpression(expression, column)`
-- `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)`
-- `renderMigrationDropForeignKeyLine(foreignKey = {})`
-- `renderMigrationDropForeignKeyLines(snapshot)`
-- `renderMigrationForeignKeyBlock(snapshot, { drop = false } = {})`
-- `renderMigrationCheckConstraintLines(snapshot)`
-- `mergeFieldMetaEntries(...entryGroups)`
-- `resolveLookupNamespaceFromTableName(tableName = "")`
-- `toFieldLabel(key = "")`
-- `isSupportedSelectOptionValue(value)`
-- `toSelectOptionIdentity(value)`
-- `toSelectOptionLabel(value)`
-- `normalizeFieldMetaUiOptions(rawOptions = [])`
-- `resolveEnumFieldMetaUiOptions(enumValues = [])`
-- `buildCrudPermissionIds(namespace = "")`
-- `resolveConfiguredRoleEntries(appConfig = {})`
-- `formatAvailableRoleIds(roleEntries = [])`
-- `resolveCrudPermissionGrantRole(appConfig = {}, options = {}, { requiresNamedPermissions = true } = {})`
-- `normalizeCrudOperation(operation = "", context = "CRUD operation")`
-- `renderRoleCatalogPermissionGrants(namespace = "", { requiresNamedPermissions = true, grantRoleId = "" } = {})`
-- `renderActionPermissionSupport(namespace = "", { requiresNamedPermissions = true, access = ACCESS_DEFAULT } = {})`
-- `renderActionPermissionExpression(operation = "", { requiresNamedPermissions = true, access = ACCESS_DEFAULT } = {})`
-- `renderRouteWorkspaceSupportImports({ surfaceRequiresWorkspace = true } = {})`
-- `renderActionWorkspaceValidatorImport({ surfaceRequiresWorkspace = true } = {})`
-- `renderRouteParamsValidatorLine(operation = "", { surfaceRequiresWorkspace = true } = {})`
-- `renderOptionalTemplateLine(line = "")`
-- `renderRouteInputLines(operation = "", { surfaceRequiresWorkspace = true } = {})`
-- `renderActionInputSchemaDefinition(lines = [], { mode = "patch" } = {})`
-- `renderActionInputExpressions({ surfaceRequiresWorkspace = true } = {})`
-- `renderRouteValidatorConstants({ surfaceRequiresWorkspace = true } = {})`
-- `buildReplacementsFromSnapshot({ namespace = "", snapshot, resolvedOwnershipFilter, surfaceRequiresWorkspace = true, surfaceId = "", access = ACCESS_DEFAULT, routeInternal = false, permissionGrantRoleId = "" })`
-- `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" } = {})`
-- `buildFieldContractEntry(snapshot = {}, column = {})`
-
-### `src/server/subcommands/resourceAst.js`
-Exports
-- `resolveCrudResourceDefaults(source = "", context = "crud-server-generator scaffold-field")`
-- `applyCrudResourceFieldPatch(source = "", { fieldKey = "", resourceSchemaExpression = "", 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")`
-- `resolveNodeKeyName(keyNode, { computed = false } = {})`
-- `createObjectPropertyKeyNode(key = "")`
-- `findVariableDeclarator(programNode, variableName = "")`
-- `requireVariableDeclarator(programNode, variableName = "", context = "crud-server-generator scaffold-field")`
-- `requireCrudResourceConfigObject(programNode, context = "crud-server-generator scaffold-field")`
-- `requireResourceSchemaObject(programNode, context = "crud-server-generator scaffold-field")`
-- `assertNoExplicitCrudSchemaOverrides(resourceObject, context = "crud-server-generator scaffold-field")`
-- `findObjectPropertyByName(objectNode, propertyName = "")`
-- `hasObjectProperty(objectNode, propertyName = "")`
-- `insertObjectProperty(objectNode, propertyName = "", valueExpressionSource = "", { context = "crud-server-generator scaffold-field", insertBeforeComputed = false } = {})`
-- `resolveObjectPropertyStringValue(objectNode, propertyName = "")`
-
-### `src/shared/crud/crudResource.js`
-Exports
-- `crudResource`
-
-### `src/shared/index.js`
-Exports
-- `crudResource`
-
-### templates
-
-### `templates/migrations/crud_foreign_keys.cjs`
-Exports
-- None
-
-### `templates/migrations/crud_initial.cjs`
-Exports
-- None
-
-### `templates/src/local-package/server/actions.js`
-Exports
-- `createActions({ surface } = {})`
-
-### `templates/src/local-package/server/CrudProvider.js`
-Exports
-- `${option:namespace|pascal`
-Local functions
-- `resolveCrudPolicyFromApp(app)`
-
-### `templates/src/local-package/server/registerRoutes.js`
-Exports
-- `registerRoutes(app, { routeOwnershipFilter = "public", routeSurface = "", routeRelativePath = "" } = {})`
-
-### `templates/src/local-package/server/repository.js`
-Exports
-- `createRepository({ api, knex } = {})`
-
-### `templates/src/local-package/server/service.js`
-Exports
-- `createService({ ${option:namespace|camel}Repository } = {})`
-Local functions
-- `return404IfNotFound(document = null)`
-
-### `templates/src/local-package/shared/crudResource.js`
-Exports
-- `resource`
-
-### `templates/src/local-package/shared/index.js`
-Exports
-- `resource`
-
-### test-support
-
-### `test-support/templateServerFixture.js`
-Exports
-- `resource`
-- `createTemplateServerFixture(options = {})`
-Local functions
-- `buildTemplateReplacements({ surfaceRequiresWorkspace = true, requiresNamedPermissions = surfaceRequiresWorkspace === true, surfaceId = surfaceRequiresWorkspace ? "admin" : "home", access = "authenticated", routeInternal = false } = {})`
-- `applyTemplateReplacements(sourceText = "", options = {})`
-- `buildResourceStubSource()`
-- `renderServerTemplateFile(targetServerDirectory, fileName, options)`