@jskit-ai/agent-docs 0.1.130 → 0.1.132

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

@@ -1,192 +0,0 @@
-# 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/`, `.vitepress/cache/`, `.vitepress/dist/`
-
-## 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 = "")`
-- `buildCrudListCopy(resourceLabels = {})`
-- `normalizeRelativeAppPath(value = "")`
-- `requireTargetRootOption(options = {})`
-- `resolveListTargetFile(targetRoot = "")`
-- `resolveFormHelperPaths(targetRoot = "")`
-- `parseOperationsOption(options)`
-- `parseDisplayFieldsOption(options)`
-- `parseParentTitleOption(options)`
-- `resolveBooleanFlagOption(options = {}, optionName = "")`
-- `shouldCreateNavigationLink(options = {}, inferenceContext = {})`
-- `resolveNavigationRoleLinkPlacement(options = {}, inferenceContext = {})`
-- `validateDisplayFieldsForOperation(selectedFieldKeys, fields, operationName)`
-- `filterDisplayFields(selectedFieldKeys, fields)`
-- `rewriteGeneratedBlockIndent(source = "", { trimPrefix = "", addPrefix = "" } = {})`
-- `hasLookupFormFields(fields = [])`
-- `hasLookupDisplayFields(fields = [])`
-- `buildListCardSlotProps(fields = [])`
-- `buildListRowSlotProps(fields = [])`
-- `buildCrudFieldsSlotProps(fields = [], { includeMode = false } = {})`
-- `buildLookupImportLine(fields = [])`
-- `buildLookupRuntimeSetup(fields = [], { formFieldsVariable = "", resourceNamespace = "", mode = "" } = {})`
-- `buildLookupFormProps(fields = [], { sourcePrefix = "" } = {})`
-- `buildLookupFormPropDefinitions({ createFields = [], editFields = [] } = {})`
-- `filterDefaultHiddenListFields(selectedFieldKeys, fields, { recordIdFieldKey = "" } = {})`
-- `ensureFields(fields, fallbackFields = createFieldDefinitions({}))`
-- `resolveViewTitleFallbackFieldKey(fields = [], { recordIdFieldKey = "" } = {})`
-- `resolveResourceNamespace(resource = {}, pageTarget = {}, options = {})`
-- `resolveResourceLabels(namespace = "", pageTarget = {})`
-- `resolveTargetRootRelativeRoutePath(pageTarget = {})`
-- `resolveNavigationInferenceRoutePath(pageTarget = {})`
-- `resolveMenuToPropLine(linkTo = "")`
-- `resolveMenuOwnerLine(owner = "")`
-- `buildMenuAppendBlock({ hasListOperation = false, menuMarker = "", pageLinkTarget = null, pageTarget = {} } = {})`
-- `resolveCrudRelativePath(namespace = "")`
-- `buildListParentTitleImportLine(parentTitleMode = "contextual")`
-- `buildListHeadingTitleSetup({ parentTitleMode = "contextual", resourceNamespace = "", routeTitle = "Records" } = {})`
-- `buildViewDeleteActionSlot({ resourceSingularTitle = "Record" } = {})`
-- `buildViewDeleteSetup({ resourceNamespace = "resource" } = {})`
-
-### `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", rootSchema = schema } = {})`
-- `resolveListItemProperties(listOutputSchema, { context = "ui-generator" } = {})`
-- `resolveLookupContainerKey(resource = {}, { context = "ui-generator" } = {})`
-- `buildResourceFieldContractMap(resource = {})`
-- `createFieldDefinitions(properties = {}, { fieldContractMap = {}, lookupContainerKey = "lookups" } = {})`
-- `createFormFieldDefinitions(properties = {}, { fieldContractMap = {}, lookupContainerKey = "lookups", parentRouteParamKey = "" } = {})`
-- `resolveNearestParentRouteParamKey(routePath = "", { recordIdParam = "recordId" } = {})`
-- `buildListHeaderColumns(fields = [])`
-- `buildListRowColumns(fields = [])`
-- `buildListCardFields(fields = [])`
-- `buildViewColumns(fields = [])`
-- `buildFormColumns(fields = [])`
-- `resolveRecordIdFieldKey(fields = [])`
-- `renderObjectArrayEntryLines(entries = [], { indent = " " } = {})`
-- `resolveRecordChangedEventName`
-- `resolveRecordIdExpression(fields = [])`
-Local functions
-- `normalizeRealtimeEventList(events = [])`
-- `resolveOperationTransportSchema(definition, { context = "ui-generator", defaultMode = "replace", label = "schema definition" } = {})`
-- `resolveUnionSchemaVariant(schema = {})`
-- `decodeJsonPointerSegment(segment = "")`
-- `resolveSchemaReference(ref = "", rootSchema = {}, { context = "ui-generator", contextLabel = "schema" } = {})`
-- `resolveObjectSchema(schema = {}, contextLabel, { context = "ui-generator", rootSchema = schema } = {})`
-- `resolveJsonRestCastType(schema = {})`
-- `resolveTemporalPrecision(...schemas)`
-- `resolveSchemaType(schema)`
-- `toFieldLabel(key)`
-- `isSupportedSelectOptionValue(value)`
-- `toSelectOptionLabel(value)`
-- `toSelectOptionIdentity(value)`
-- `normalizeFieldUiOptions(rawOptions, { context = "resource field ui.options" } = {})`
-- `stripLookupIdSuffix(key = "")`
-- `resolveFieldLabel(key = "", relation = null)`
-- `extractDynamicRouteParamKeys(routePath = "")`
-- `normalizeLookupRelation(relation = {})`
-- `toLookupRelation(fieldContractMap = {}, fieldKey = "", { lookupContainerKey = "lookups" } = {})`
-- `resolveFormInputType(fieldType, fieldFormat)`
-- `resolveFormFieldComponent(fieldType, relation = null)`
-- `resolveTemporalInputStep(field = {})`
-- `buildDefaultNullableBooleanOptions()`
-- `toPositiveInteger(value)`
-- `toAccessorExpression(baseName, fieldKey)`
-- `toOptionalAccessorExpression(baseName, fieldKey)`
-- `escapeHtml(value)`
-- `serializeTemplateBindingValue(value)`
-- `renderTemplateJsStringLiteral(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 = "" } = {})`
-- `findMatchingDelimiter(sourceText = "", openIndex = -1, openChar = "[", closeChar = "]")`
-- `resolveAnchorLineIndex(sourceText = "", anchor = "")`
-- `findArrayDeclarationBeforeIndex(sourceText = "", arrayName = "", index = -1)`
-- `insertFormFieldDefinition(source, insertion = {})`
-- `resolveAnchorScopeStart(source = "", { anchorIndex = -1, anchor = "" } = {})`
-- `buildAnchorInsertions(operationName, field)`
-- `resolveGeneratedTargetComment(source = "", commentName = "")`
-- `resolveGeneratedTargetPath(appRoot, targetAbsolutePath, generatedTarget = "")`
-- `resolveOperationTargetFiles({ appRoot, operationName, targetAbsolutePath, source = "" } = {})`
-- `parseSubcommandArgs(args = [])`
-
-### templates
-
-### `templates/src/pages/admin/ui-generator/AddEditForm.vue`
-Exports
-- None
-
-### `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/listBulkActions.js`
-Exports
-- `listBulkActions`
-
-### `templates/src/pages/admin/ui-generator/ListElement.vue`
-Exports
-- None
-
-### `templates/src/pages/admin/ui-generator/listFilters.js`
-Exports
-- `listFilters`
-
-### `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

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

@@ -1,65 +0,0 @@
-# packages/feature-server-generator
-
-Generated by `npm run agent-docs:build`.
-Do not edit manually.
-
-Generated inventory for `packages/feature-server-generator`.
-Use this on demand; do not load the full index at startup.
-
-## Scope
-- Source: `packages/feature-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({ options = {} } = {})`
-Local functions
-- `runtimeDependencyVersion(packageName)`
-- `splitTextIntoWords(value)`
-- `wordsToPascal(words = [])`
-- `wordsToKebab(words = [])`
-- `wordsToCamel(words = [])`
-- `normalizeFeatureName(value)`
-- `normalizeSurfaceId(value)`
-- `normalizeRoutePrefix(value)`
-- `quoteArray(values = [])`
-- `buildProviderContext({ featureName, mode, routePrefix, surface })`
-- `buildActionsContext({ surface })`
-- `buildServiceContext({ featureName, mode })`
-- `buildRouteContext({ surface })`
-- `buildManifestContext({ featureName, mode })`
-
-### templates
-
-### `templates/src/local-package/server/actions.js`
-Exports
-- `featureActions`
-
-### `templates/src/local-package/server/FeatureProvider.js`
-Exports
-- `${option:feature-name|pascal`
-
-### `templates/src/local-package/server/inputSchemas.js`
-Exports
-- `statusQueryInputValidator`
-- `executeCommandInputValidator`
-
-### `templates/src/local-package/server/registerRoutes.js`
-Exports
-- `registerRoutes(app, { routeSurface = "", routeRelativePath = "" } = {})`
-
-### `templates/src/local-package/server/repositoryCustomKnex.js`
-Exports
-- `createRepository({ knex } = {})`
-
-### `templates/src/local-package/server/repositoryJsonRest.js`
-Exports
-- `createRepository({ api } = {})`
-
-### `templates/src/local-package/server/service.js`
-Exports
-- `createService({ featureRepository } = {})`

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

@@ -1,127 +0,0 @@
-# packages/ui-generator
-
-Generated by `npm run agent-docs:build`.
-Do not edit manually.
-
-Generated inventory for `packages/ui-generator`.
-Use this on demand; do not load the full index at startup.
-
-## Scope
-- Source: `packages/ui-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
-- `buildUiPageTemplateContext({ appRoot, targetFile = "", options = {} } = {})`
-- `normalizeNavigationRole`
-- `resolveNavigationInferenceRoutePath(pageTarget = {})`
-- `resolveNavigationRoleLinkPlacement(options = {}, inferenceContext = {})`
-- `shouldCreateNavigationLink(options = {}, inferenceContext = {})`
-Local functions
-- `resolveLinkToPropLine(linkTo = "")`
-- `resolveOwnerLine(owner = "")`
-
-### `src/server/subcommands/addSubpages.js`
-Exports
-- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
-Local functions
-- `resolveOutletOwner(target = "")`
-- `renderSectionNavTopologyBlock({ marker = "", owner = "", surface = "", target = "" } = {})`
-- `resolveSubpagesOutletTarget(options = {}, pageTarget = {})`
-
-### `src/server/subcommands/element.js`
-Exports
-- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
-Local functions
-- `renderElementComponentSource(elementName = "")`
-- `resolvePlacedElementSurface({ appRoot, placementTarget = {}, surface = "", context = "ui-generator placed-element" } = {})`
-
-### `src/server/subcommands/outlet.js`
-Exports
-- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
-Local functions
-- `hasShellOutletTarget(source = "", { target = "" } = {})`
-- `applyScriptImports(source = "")`
-- `createOutletBlock({ target = "" } = {})`
-- `resolveOutletOwner(target = "")`
-- `resolveSemanticPlacementOption(options = {}, { context = "ui-generator outlet" } = {})`
-- `resolveOptionalSemanticPlacementOption(options = {}, { context = "ui-generator outlet" } = {})`
-- `resolveVariantOwners(variantTargets = {})`
-- `resolveSemanticPlacementOwner({ placementId = "", targetId = "", variantTargets = null, owner = "", context = "ui-generator outlet" } = {})`
-- `resolveTopologyKind(options = {}, { context = "ui-generator outlet", defaultKind = "", required = false } = {})`
-- `resolveTopologyVariantTargets(options = {}, { context = "ui-generator topology", fallbackTarget = "" } = {})`
-- `hasTopologyOptions(options = {})`
-- `resolveTopologySurfaces(options = {})`
-- `renderTopologyOwnerLine(owner = "")`
-- `renderLinkRendererBlock(rendererToken = "")`
-- `renderTopologyVariantBlock({ layoutClass = "", target = "", kind = "", rendererToken = "" } = {})`
-- `renderOutletTopologyBlock({ marker = "", placementId = "", owner = "", surfaces = ["*"], description = "", target = "", variantTargets = null, kind = "link", rendererToken = "" } = {})`
-- `findLastTemplateCloseTag(source = "")`
-- `applyOutletTemplateBlock(source = "", { target = "" } = {})`
-- `prepareTopologyBlock({ appRoot, topologyPath = null, context = "ui-generator topology", placementId = "", owner = "", surfaces = ["*"], description = "", target = "", variantTargets = null, kind = "", rendererToken = "" } = {})`
-- `applyTopologyBlock(options = {})`
-- `runTopologySubcommand({ appRoot, options = {}, dryRun = false } = {})`
-
-### `src/server/subcommands/page.js`
-Exports
-- `runGeneratorSubcommand({ appRoot, subcommand = "", args = [], options = {}, dryRun = false } = {})`
-Local functions
-- `renderPageLinkPlacementBlock({ marker = "", context = {}, label = "", surface = "" } = {})`
-
-### `src/server/subcommands/pageSupport.js`
-Exports
-- `DEFAULT_SUBPAGES_POSITION`
-- `DEFAULT_COMPONENT_DIRECTORY`
-- `SECTION_CONTAINER_SHELL_COMPONENT`
-- `SUBPAGES_LINK_COMPONENT`
-- `SUBPAGES_LINK_COMPONENT_TOKEN`
-- `resolvePageTargetDetails`
-- `resolveNearestParentSubpagesHost`
-- `deriveDefaultSubpagesHost`
-- `renderPlainPageSource(pageTitle = "", { surfaceId = "", routePath = "" } = {})`
-- `ensureSubpagesSupportScaffold({ appRoot, componentDirectory = DEFAULT_COMPONENT_DIRECTORY, dryRun = false } = {})`
-- `applySubpagesUpgradeToPageSource(source = "", { target = "", title = "", subtitle = "", sectionContainerComponentImportPath = "/src/components/SectionContainerShell.vue", preserveExistingContent = true } = {})`
-- `upgradePageFileToSubpages({ appRoot, targetFile, target = "", title = "", subtitle = "", componentDirectory = DEFAULT_COMPONENT_DIRECTORY, preserveExistingContent = true, dryRun = false } = {})`
-Local functions
-- `resolveGeneratedPageSurfaceProfile({ surfaceId = "", routePath = "" } = {})`
-- `trimEdgeBlankLines(source = "")`
-- `renderSectionContainerShellSource()`
-- `findTemplateBlock(source = "")`
-- `unwrapSectionContainerShell(source = "")`
-- `stripExistingSubpagesStructure(source = "")`
-- `renderSectionContainerOpenTag({ title = "", subtitle = "" } = {})`
-- `renderSubpagesTemplate({ bodyContent = "", title = "", subtitle = "", target = "" } = {})`
-- `applySubpagesScriptImports(source = "", { sectionContainerComponentImportPath = "" } = {})`
-- `hasExistingSubpagesRouting(source = "")`
-
-### `src/server/subcommands/support.js`
-Exports
-- `DEFAULT_COMPONENT_DIRECTORY`
-- `MAIN_CLIENT_PROVIDER_FILE`
-- `PLACEMENT_FILE`
-- `PLACEMENT_TOPOLOGY_FILE`
-- `toKebabCase(value = "")`
-- `toPascalCase(value = "")`
-- `requireOption(options = {}, optionName = "", { context = "ui-generator" } = {})`
-- `requireSinglePositionalTargetFile(args = [], { context = "ui-generator" } = {})`
-- `resolveOutletTargetId(rawTarget = "", { context = "ui-generator", optionName = "target" } = {})`
-- `rejectUnexpectedOptions(options = {}, allowedOptionNames = [], { context = "ui-generator" } = {})`
-- `resolvePathWithinApp(appRoot, targetPath, { context = "ui-generator" } = {})`
-- `ensureTrailingNewline(value = "")`
-- `appendBlockIfMarkerMissing(source = "", marker = "", block = "")`
-- `insertImportIfMissing(source = "", importLine = "")`
-- `insertBeforeClassDeclaration(source = "", line = "", { className = "", contextFile = "" } = {})`
-- `findScriptSetupBlock(source = "")`
-- `insertScriptSetupBlock(source = "", content = "")`
-- `appendTopologyBlockIfPlacementMissing({ topologyPath = {}, source = "", marker = "", block = "", placementId = "", owner = "", variantTargets = null, context = "ui-generator topology" } = {})`
-- `parseTagAttributes(attributesSource = "")`
-- `indentBlock(source = "", indent = "")`
-Local functions
-- `loadPlacementTopologyDefinitionFromPath(topologyPath = {}, { context = "ui-generator topology" } = {})`
-- `normalizeExpectedTopologyVariantTargets(variantTargets = null)`
-- `describeTopologyVariantTargets(variantTargets = {})`
-- `placementMatchesExpectedVariantTargets(placement = {}, expectedVariantTargets = null)`