@jskit-ai/agent-docs 0.1.27 → 0.1.28

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

@@ -17,6 +17,10 @@ Use this on demand; do not load the full index at startup.
 ### `src/server/buildTemplateContext.js`
 Exports
 - `buildUiPageTemplateContext({ appRoot, targetFile = "", options = {} } = {})`
+- `normalizeNavigationRole`
+- `resolveNavigationInferenceRoutePath(pageTarget = {})`
+- `resolveNavigationRoleLinkPlacement(options = {}, inferenceContext = {})`
+- `shouldCreateNavigationLink(options = {}, inferenceContext = {})`
 Local functions
 - `resolveLinkToPropLine(linkTo = "")`
 - `resolveOwnerLine(owner = "")`
@@ -44,14 +48,23 @@ Local functions
 - `applyScriptImports(source = "")`
 - `createOutletBlock({ target = "" } = {})`
 - `resolveOutletOwner(target = "")`
-- `resolveSemanticPlacementOption(options = {})`
-- `resolveSemanticPlacementOwner({ placementId = "", targetId = "", owner = "" } = {})`
+- `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 = "")`
-- `renderOutletTopologyBlock({ marker = "", placementId = "", owner = "", surfaces = ["*"], description = "", target = "", 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
@@ -69,11 +82,12 @@ Exports
 - `resolvePageTargetDetails`
 - `resolveNearestParentSubpagesHost`
 - `deriveDefaultSubpagesHost`
-- `renderPlainPageSource(pageTitle = "")`
+- `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 = "")`
@@ -101,9 +115,16 @@ Exports
 - `appendBlockIfMarkerMissing(source = "", marker = "", block = "")`
 - `insertImportIfMissing(source = "", importLine = "")`
 - `insertBeforeClassDeclaration(source = "", line = "", { className = "", contextFile = "" } = {})`
-- `findScriptBlock(source = "")`
+- `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)`
 
 ### root
 

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

@@ -289,6 +289,8 @@ Exports
 ### `templates/packages/users-workspace/src/server/actions.js`
 Exports
 - `createActions({ surface } = {})`
+Local functions
+- `buildListQuery(input = {})`
 
 ### `templates/packages/users-workspace/src/server/registerRoutes.js`
 Exports

package/reference/autogen/packages/users-web.md

@@ -28,6 +28,12 @@ Exports
 - `createUsersBootstrapUserHandler()`
 - `registerUsersBootstrapPayloadHandlers(app)`
 
+### `src/client/bulkActions.js`
+Exports
+- `defineCrudListBulkActions(actions = [])`
+Local functions
+- `normalizeCrudListBulkAction(rawAction = {}, index = 0)`
+
 ### `src/client/components/AccountSettingsClientElement.vue`
 Exports
 - None
@@ -35,6 +41,44 @@ Local functions
 - `normalizeSection(value)`
 - `readRouteSection()`
 
+### `src/client/components/CrudAddEditScreen.vue`
+Exports
+- None
+Local functions
+- `resolveFieldErrors(fieldKey)`
+- `resolveCancelTo(target = cancelTo.value)`
+
+### `src/client/components/CrudListBulkActionSurface.vue`
+Exports
+- None
+Local functions
+- `clearSelection()`
+- `execute(action = {})`
+- `isActionDisabled(action = {})`
+- `isActionExecuting(action = {})`
+
+### `src/client/components/CrudListFilterSurface.vue`
+Exports
+- None
+Local functions
+- `optionItems(filter = {})`
+- `placeholder(filter = {}, fallback = "")`
+- `clearChip(chip = {})`
+- `clearFilters()`
+
+### `src/client/components/CrudListScreen.vue`
+Exports
+- None
+Local functions
+- `resolveListRecordTitle(record)`
+- `formatListCardValue(value)`
+- `resolveViewLocation(record)`
+- `resolveEditLocation(record)`
+
+### `src/client/components/CrudViewScreen.vue`
+Exports
+- None
+
 ### `src/client/components/ProfileClientElement.vue`
 Exports
 - None
@@ -226,7 +270,7 @@ Exports
 ### `src/client/composables/runtime/operationUiHelpers.js`
 Exports
 - `setupRouteChangeCleanup({ enabled = true, route = null, feedback = null, fieldBag = null } = {})`
-- `setupOperationErrorReporting({ enabled = true, source = "users-web.operation", loadError = null, notFoundError = null, loadActionFactory = null, notFoundActionFactory = null, loadChannel = "banner", notFoundChannel = "banner", loadSeverity = "error", notFoundSeverity = "warning", dedupeWindowMs = 2000 } = {})`
+- `setupOperationErrorReporting({ enabled = true, source = "users-web.operation", loadError = null, notFoundError = null, loadActionFactory = null, notFoundActionFactory = null, loadChannel = "", notFoundChannel = "", loadSeverity = "error", notFoundSeverity = "warning", dedupeWindowMs = 2000 } = {})`
 Local functions
 - `normalizeMessage(value)`
 
@@ -246,7 +290,7 @@ Exports
 Exports
 - `buildEndpointReadRequestOptions({ method = "GET", query = null, transport = null } = {})`
 - `buildEndpointWriteRequestOptions({ method = "PATCH", body = undefined, options = null, transport = null } = {})`
-- `useEndpointResource({ queryKey, path = "", enabled = true, client = usersWebHttpClient, readMethod = "GET", writeMethod = "PATCH", readQuery = null, transport = null, queryOptions = null, mutationOptions = null, fallbackLoadError = "Unable to load resource.", fallbackSaveError = "Unable to save resource." } = {})`
+- `useEndpointResource({ queryKey, path = "", enabled = true, client = usersWebHttpClient, readMethod = "GET", writeMethod = "PATCH", readQuery = null, transport = null, refreshOnPull = false, queryOptions = null, mutationOptions = null, fallbackLoadError = "Unable to load resource.", fallbackSaveError = "Unable to save resource." } = {})`
 Local functions
 - `resolveRequestQuery(value = null)`
 
@@ -265,7 +309,7 @@ Local functions
 
 ### `src/client/composables/runtime/useUiFeedback.js`
 Exports
-- `useUiFeedback({ initialType = "success", source = "users-web.ui-feedback", successChannel = "snackbar", errorChannel = "banner", dedupeWindowMs = 2000 } = {})`
+- `useUiFeedback({ initialType = "success", source = "users-web.ui-feedback", successChannel = "", errorChannel = "", dedupeWindowMs = 2000 } = {})`
 
 ### `src/client/composables/runtime/useViewCore.js`
 Exports
@@ -337,6 +381,7 @@ Exports
 ### `src/client/composables/support/resourceLoadStateHelpers.js`
 Exports
 - `hasResolvedQueryData({ query = null, data = null } = {})`
+- `mergeQueryMeta(queryOptions = null, meta = {})`
 
 ### `src/client/composables/support/routeTemplateHelpers.js`
 Exports
@@ -388,6 +433,19 @@ Exports
 Exports
 - `useCommand({ ownershipFilter = ROUTE_VISIBILITY_WORKSPACE, surfaceId = "", access = "auto", apiSuffix = "", runPermissions = [], writeMethod = "POST", transport = null, placementSource = "users-web.command", fallbackRunError = "Unable to complete action.", fieldErrorKeys = [], clearOnRouteChange = true, model, input, buildRawPayload, buildCommandPayload, buildCommandOptions, onRunSuccess, onRunError, suppressSuccessMessage = false, messages = {}, realtime = null } = {})`
 
+### `src/client/composables/useCrudAddEditScreen.js`
+Exports
+- `useCrudAddEditScreen({ screen = null, mode = "new", title = "", subtitle = "", saveLabel = "Save", cancelTo = "", resource = null, operationName = "", formFields = [], addEditOptions = {}, saveSuccess = {}, fieldBinding = null, createModel = null, buildPayload = null, mapPayloadToModel = null, input = null, preserveCancelQuery = false } = {})`
+Local functions
+- `normalizeProvidedScreen(screen = null)`
+
+### `src/client/composables/useCrudListBulkActions.js`
+Exports
+- `useCrudListBulkActions(actions = [], { resolveRecordId = null, resolveContext = null } = {})`
+Local functions
+- `normalizeSelectedId(value = "")`
+- `resolveActionKey(actionOrKey = "")`
+
 ### `src/client/composables/useCrudListFilterLookups.js`
 Exports
 - `useCrudListFilterLookups(definitions = {}, { values = {}, adapter = null, recordIdParam = "recordId", queryKeyPrefix = [], placementSourcePrefix = "", requestQueryParams = {}, labelResolvers = {} } = {})`
@@ -412,6 +470,16 @@ Exports
 Local functions
 - `normalizeQueryKeyPrefix(value = [])`
 
+### `src/client/composables/useCrudListScreen.js`
+Exports
+- `useCrudListScreen({ adapter = null, resource = null, resourceNamespace = "resource", apiSuffix = "", recordIdParam = "recordId", recordIdSelector = null, titleFallbackFieldKey = "", viewUrlTemplate = "", editUrlTemplate = "", newUrlTemplate = "", recordChangedEvents = [], listFilters = {}, listBulkActions = [], routeQueryBlacklist = Object.freeze(["include", "cursor", "limit"]), fallbackLoadError = "Unable to load records." } = {})`
+Local functions
+- `formatCrudListCardValue(value)`
+
+### `src/client/composables/useCrudViewScreen.js`
+Exports
+- `useCrudViewScreen({ adapter = null, resource = null, resourceNamespace = "resource", apiUrlTemplate = "", recordIdParam = "recordId", titleFallbackFieldKey = "", listUrlTemplate = "", editUrlTemplate = "", recordChangedEvent = "", fallbackLoadError = "Unable to load record.", notFoundMessage = "Record not found." } = {})`
+
 ### `src/client/composables/usePagedCollection.js`
 Exports
 - `usePagedCollection({ queryKey, enabled = true, initialPageParam = null, queryFn, getNextPageParam = defaultGetNextPageParam, selectItems = defaultSelectItems, dedupeBy = null, queryOptions = null, fallbackLoadError = "Unable to load list." } = {})`
@@ -450,10 +518,31 @@ Local functions
 Exports
 - `useSurfaceRouteContext()`
 
+### `src/client/filters.js`
+Exports
+- `CRUD_LIST_FILTER_TYPE_FLAG`
+- `CRUD_LIST_FILTER_TYPE_ENUM`
+- `CRUD_LIST_FILTER_TYPE_ENUM_MANY`
+- `CRUD_LIST_FILTER_TYPE_RECORD_ID`
+- `CRUD_LIST_FILTER_TYPE_RECORD_ID_MANY`
+- `CRUD_LIST_FILTER_TYPE_DATE`
+- `CRUD_LIST_FILTER_TYPE_DATE_RANGE`
+- `CRUD_LIST_FILTER_TYPE_NUMBER_RANGE`
+- `CRUD_LIST_FILTER_TYPE_PRESENCE`
+- `CRUD_LIST_FILTER_PRESENCE_PRESENT`
+- `CRUD_LIST_FILTER_PRESENCE_MISSING`
+- `CRUD_LIST_FILTER_PRESENCE_OPTIONS`
+- `defineCrudListFilters`
+
 ### `src/client/index.js`
 Exports
 - `UsersWebClientProvider`
 - `AccountSettingsClientElement`
+- `CrudAddEditScreen`
+- `CrudListBulkActionSurface`
+- `CrudListFilterSurface`
+- `CrudListScreen`
+- `CrudViewScreen`
 - `clientProviders`
 
 ### `src/client/lib/bootstrap.js`

package/reference/autogen/packages/workspaces-web.md

@@ -89,6 +89,7 @@ Local functions
 - `normalizeInvites(entries)`
 - `latestPage(pages)`
 - `applyWorkspaceSettingsPolicy(payload = {})`
+- `refreshLoad()`
 - `submitInvite()`
 - `submitRevokeInvite(inviteId)`
 - `submitMemberRoleUpdate(member, roleSid)`
@@ -103,7 +104,7 @@ Exports
 - None
 Local functions
 - `normalizePendingInvite(entry)`
-- `reportFeedback({ message, severity = "error", channel = "banner", dedupeKey = "" } = {})`
+- `reportFeedback({ message, severity = "error", channel = "", dedupeKey = "" } = {})`
 - `workspaceInitials(workspace)`
 - `workspaceAvatarStyle(workspace)`
 - `workspaceHomePath(workspaceSlug)`
@@ -112,6 +113,7 @@ Local functions
 - `acceptInvite(invite)`
 - `refuseInvite(invite)`
 - `createWorkspace()`
+- `refreshBootstrap()`
 
 ### `src/client/components/WorkspaceSettingsClientElement.vue`
 Exports

package/reference/autogen/tooling/jskit-cli.md

@@ -440,16 +440,29 @@ Local functions
 - `resolveGeneratorDescription(packageEntry = {})`
 - `resolveGeneratorQuickStartRows(packageEntry = {}, { limit = 3 } = {})`
 - `isLinkItemToken(token = "")`
+- `collectPlacementRendererKinds(placementTarget = {})`
+- `collectPlacementConcreteOutlets(placementTarget = {})`
+- `classifyPlacementTarget(placementTarget = {})`
+- `createConcreteTargetSourcePathMap(concreteTargets = [])`
+- `resolveChildPagePatternFromHostSourcePath(sourcePath = "")`
+- `resolveOwnerScopedChildPagePattern(placementTarget = {}, concreteSourcePathByTarget = new Map())`
+- `createPlacementTargetSummary(placementTarget = {}, color, { concreteSourcePathByTarget = new Map() } = {})`
+- `appendPlacementLayoutDetails(lines, placementTarget = {}, color)`
+- `collectMappedConcreteOutletIds(semanticPlacements = [])`
+- `resolveUnmappedConcreteTargets({ semanticPlacements = [], concreteTargets = [] } = {})`
+- `formatPlacementGuidanceLine(line = "", color)`
+- `appendPlacementGroup(lines, { color, title = "", description = "", guidance = [], targets = [], concreteSourcePathByTarget = new Map(), showLayoutDetails = false } = {})`
+- `appendUnmappedConcreteTargetWarnings(lines, { color, concreteTargets = [] } = {})`
+- `appendSemanticPlacementGroups(lines, { color, semanticPlacements = [], concreteTargets = [], showLayoutDetails = false } = {})`
 - `readFileIfExists(filePath = "")`
 - `resolveDescriptorFromLockEntry({ appRoot = "", packageId = "", installedPackageEntry = {} } = {})`
 - `collectProviderSourceFiles(rootPath = "")`
 
 ### `src/server/commandHandlers/mobile.js`
 Exports
-- `createMobileCommands(ctx = {}, { commandAdd } = {})`
+- `createMobileCommands(ctx = {})`
 Local functions
 - `collectManagedMobileFileDriftIssues({ ctx, appRoot, issues = [] } = {})`
-- `collectMissingInstalledDependencyNames(ctx, appRoot = "", packageJson = {})`
 - `renderAndroidMobileCommandList(lines, color)`
 - `renderMobileHelp(stream, definition = null, platform = "")`
 - `isValidHttpOrHttpsUrl(value = "")`
@@ -462,17 +475,19 @@ Local functions
 - `resolveAndroidDeviceTarget({ ctx, appRoot, explicitTarget = "", commandLabel = "this mobile command" } = {})`
 - `resolveInstalledMobileConfigForCommand({ appRoot, createCliError } = {})`
 - `runLocalBinary(binaryName, args = [], { appRoot, cwd = appRoot, env = {}, stderr, stdout, pathModule, createCliError, dryRun = false } = {})`
-- `runMobileAppInstall({ ctx, appRoot, stdout, stderr, dryRun = false, devlinks = false } = {})`
-- `refreshManagedMobileFiles({ ctx, commandAdd, appRoot, options = {}, stdout, stderr } = {})`
-- `runMobileSyncAndroidCommand({ ctx, commandAdd, appRoot, options = {}, stdout, stderr })`
-- `runMobileRunAndroidCommand({ ctx, commandAdd, appRoot, options = {}, stdout, stderr })`
+- `hasPackageDependency(packageJson = {}, packageId = "")`
+- `readJsonFileForMobileCommand(filePath = "", label = "", createCliError)`
+- `assertMobileRuntimePackageInstalled({ ctx, appRoot } = {})`
+- `refreshManagedMobileFiles({ ctx, appRoot, options = {}, stdout } = {})`
+- `runMobileSyncAndroidCommand({ ctx, appRoot, options = {}, stdout, stderr })`
+- `runMobileRunAndroidCommand({ ctx, appRoot, options = {}, stdout, stderr })`
 - `runCapRunAndroidCommand({ ctx, appRoot, pathModule, target = "", stdout, stderr, dryRun = false } = {})`
-- `runMobileBuildAndroidCommand({ ctx, commandAdd, appRoot, options = {}, stdout, stderr })`
+- `runMobileBuildAndroidCommand({ ctx, appRoot, options = {}, stdout, stderr })`
 - `runMobileDoctorCommand({ ctx, appRoot, stdout })`
 - `runMobileDevicesAndroidCommand({ ctx, appRoot, stdout })`
 - `runMobileTunnelAndroidCommand({ ctx, appRoot, options = {}, stdout })`
 - `runMobileRestartAndroidCommand({ ctx, appRoot, options = {}, stdout })`
-- `runMobileDevAndroidCommand({ ctx, commandAdd, appRoot, options = {}, stdout, stderr })`
+- `runMobileDevAndroidCommand({ ctx, appRoot, options = {}, stdout, stderr })`
 
 ### `src/server/commandHandlers/mobileCommandCatalog.js`
 Exports
@@ -487,6 +502,7 @@ Exports
 - `ANDROID_DIRECTORY_NAME`
 - `ANDROID_MANIFEST_RELATIVE_PATH`
 - `buildManagedMobileConfigStub({ packageJson = {} } = {})`
+- `isEmptyDisabledMobileConfigPlaceholder(mobileConfig = {})`
 - `resolveInstalledMobileConfig(appRoot = "")`
 - `resolveAndroidSdkDetails({ appRoot = "" } = {})`
 - `collectAndroidSdkComponentIssues({ appRoot = "", sdkRoot = "" } = {})`

package/templates/app/AGENTS.md

@@ -63,6 +63,7 @@ Core rules:
   - `Not doing: ...`
 - Keep that checkpoint compact. Do not expand it into a long preamble unless the developer asks for detail.
 - Reuse existing JSKIT helpers and runtime seams before adding new local helpers.
+- If `npm install` is run while the app is using local JSKIT checkout links, run `npm run devlinks` immediately afterward.
 - A freshly scaffolded JSKIT app can still be in Stage 1. If the app was just created and platform decisions are not settled yet, continue with the initialize workflow before adding runtime packages.
 - Do not treat a missing `config.tenancyMode` line or an untouched minimal scaffold as a final tenancy decision.
 - Do not install tenancy-sensitive packages until Stage 1 decisions are complete and the chosen tenancy is written into `config/public.js`.

package/workflow/bootstrap.md

@@ -54,6 +54,7 @@ Baseline expectations after initialization:
 - create the app scaffold
 - install the baseline runtime packages in the documented order
 - install dependencies
+- run `npm run devlinks` immediately after `npm install` when the app is using local JSKIT checkout links
 - run database migrations when the chosen package set requires them
 - use the standard packaged workflows that come with those packages unless the blueprint records an override
 - leave the app in a reproducible, verified baseline state