@jskit-ai/agent-docs 0.1.19 → 0.1.21

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

@@ -0,0 +1,74 @@
+# 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/`, `LEGACY/`, `.vitepress/cache/`, `.vitepress/dist/`
+
+## Sections
+
+### src
+
+### `src/server/buildTemplateContext.js`
+Exports
+- `buildTemplateContext({ options = {} } = {})`
+Local functions
+- `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 })`
+- `buildDescriptorContext({ featureName, mode })`
+
+### templates
+
+### `templates/src/local-package/package.descriptor.mjs`
+Exports
+- None
+
+### `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 } = {})`
+
+### root
+
+### `package.descriptor.mjs`
+Exports
+- None

package/reference/autogen/packages/json-rest-api-core.md

@@ -28,11 +28,11 @@ Exports
 - `createJsonApiRelationship(resourceType = "", id = null)`
 - `createJsonRestResourceScopeOptions(resource = {}, { writeSerializers = {}, normalizeId = null } = {})`
 - `createJsonRestContext(context = null)`
+- `extractJsonRestCollectionRows(payload = null)`
 - `isJsonRestResourceMissingError(error = null)`
 - `returnNullWhenJsonRestResourceMissing(run)`
 - `resolveWorkspaceScopeValue(context = null)`
 - `resolveUserScopeValue(context = null)`
-- `simplifyJsonApiDocument(payload = {})`
 - `createJsonRestApiHost({ knex })`
 - `registerJsonRestApiHost(app)`
 Local functions
@@ -43,10 +43,6 @@ Local functions
 - `normalizeJsonRestObject(value)`
 - `normalizeJsonRestList(value)`
 - `extractJsonApiInputRelationships(attributes = {}, resource = null, relationships = null)`
-- `normalizeJsonApiResourceObject(resource = {})`
-- `buildJsonApiIncludedIndex(payload = {})`
-- `simplifyJsonApiRelationshipData(data, { includedIndex = null, seen = null } = {})`
-- `simplifyJsonApiResourceObject(resource = {}, { includedIndex = null, seen = null } = {})`
 
 ### root
 

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

@@ -84,6 +84,7 @@ Exports
 ### `src/client/composables/crud/crudJsonApiTransportSupport.js`
 Exports
 - `inferCrudJsonApiTransport(resource = null, { mode = "", operationName = "" } = {})`
+- `inferCrudLookupJsonApiTransport({ namespace = "", apiPath = "" } = {})`
 - `resolveCrudJsonApiTransport(transport = null, resource = null, options = {})`
 - `resolveLookupFieldMap(resource = null)`
 Local functions

package/reference/autogen/tooling/create-app.md

@@ -95,29 +95,17 @@ Exports
 - `MainClientProvider`
 - `registerMainClientComponent(token, resolveComponent)`
 
-### `templates/base-shell/packages/main/src/server/controllers/index.js`
-Exports
-- None
-
 ### `templates/base-shell/packages/main/src/server/index.js`
 Exports
 - `MainServiceProvider`
 
-### `templates/base-shell/packages/main/src/server/providers/MainServiceProvider.js`
+### `templates/base-shell/packages/main/src/server/loadAppConfig.js`
 Exports
-- `MainServiceProvider`
-
-### `templates/base-shell/packages/main/src/server/routes/index.js`
-Exports
-- None
-
-### `templates/base-shell/packages/main/src/server/services/index.js`
-Exports
-- None
+- `loadAppConfig({ moduleUrl = import.meta.url } = {})`
 
-### `templates/base-shell/packages/main/src/server/support/loadAppConfig.js`
+### `templates/base-shell/packages/main/src/server/MainServiceProvider.js`
 Exports
-- `loadAppConfig({ moduleUrl = import.meta.url } = {})`
+- `MainServiceProvider`
 
 ### `templates/base-shell/packages/main/src/shared/index.js`
 Exports

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

@@ -371,6 +371,7 @@ Exports
 Local functions
 - `collectDeclaredPackageNames(packageJson = {})`
 - `verifySymlinkTarget(targetPath = "", sourceDir = "", { packageName = "" } = {})`
+- `replaceWithSymlink(targetPath = "", sourceDir = "", { packageName = "" } = {})`
 - `maybeLinkCompanionPackages({ appRoot = "", repoRoot = "", stdout, createCliError })`
 
 ### `src/server/commandHandlers/appCommands/release.js`
@@ -429,6 +430,10 @@ Exports
 Local functions
 - `collectTokenMatches(source = "", pattern = COMPONENT_TOKEN_PATTERN)`
 - `appendTokenSource(map, token = "", source = "")`
+- `toShortPackageId(packageId = "")`
+- `resolveGeneratorPrimarySubcommand(packageEntry = {})`
+- `resolveGeneratorDescription(packageEntry = {})`
+- `resolveGeneratorQuickStartRows(packageEntry = {}, { limit = 3 } = {})`
 - `isLinkItemToken(token = "")`
 - `readFileIfExists(filePath = "")`
 - `resolveDescriptorFromLockEntry({ appRoot = "", packageId = "", installedPackageEntry = {} } = {})`
@@ -469,6 +474,7 @@ Local functions
 - `normalizeHelpParagraphRows(rawValue = "")`
 - `appendHelpLongDescription(lines = [], rawLongDescription = "", { color = null } = {})`
 - `appendHelpExamples(lines = [], exampleRows = [], { color = null } = {})`
+- `appendHelpExamplesWithHeading(lines = [], exampleRows = [], heading = "", { color = null } = {})`
 - `appendHelpNotes(lines = [], rawNotes = [], { color = null } = {})`
 - `appendSeparatedBlocks(lines = [], blocks = [])`
 - `resolveGeneratorSubcommandMetadata(packageEntry = {})`
@@ -477,6 +483,7 @@ Local functions
 - `formatPositionalArgSummary(arg = {}, { color = null } = {})`
 - `findGeneratorSubcommandRow(packageEntry = {}, subcommandName = "")`
 - `buildSubcommandOptionRows(optionRows = [], subcommandRow = {})`
+- `resolvePrimaryGeneratorQuickStartRows(packageEntry = {}, { limit = 3 } = {})`
 
 ### `src/server/commandHandlers/packageCommands/generate.js`
 Exports
@@ -563,6 +570,9 @@ Local functions
 ### `src/server/commandHandlers/show/renderPackageText.js`
 Exports
 - `renderPackagePayloadText({ payload, provides, requires, capabilityDetails, options, stdout, color, resolveWrapWidth, writeWrappedItems, normalizeRelativePosixPath, formatPackageSubpathImport, normalizePlacementOutlets, normalizePlacementContributions, shouldShowPackageExportTarget, classifyExportedSymbols, deriveProviderDisplayName } = {})`
+Local functions
+- `resolveGeneratorSubcommandRows(payload = {})`
+- `resolveOwnershipGuidance(payload = {})`
 
 ### `src/server/core/argParser.js`
 Exports
@@ -691,7 +701,8 @@ Exports
 - `isUiVerificationPath(relativePath = "")`
 - `isValidUiVerificationReceipt(receipt)`
 - `normalizeUiVerificationReceipt(rawReceipt = {})`
-- `resolveChangedUiFilesFromGit(appRoot = "")`
+- `resolveChangedPathsFromGit(appRoot = "", { against = "", pathspecs = ["src", "packages"] } = {})`
+- `resolveChangedUiFilesFromGit(appRoot = "", { against = "" } = {})`
 - `sortUniqueStrings(values = [])`
 Local functions
 - `normalizeText(value = "")`

package/templates/app/AGENTS.md

@@ -73,7 +73,7 @@ Core rules:
 - For CRUD chunks, ask the developer which operations are allowed, which fields belong in the list view if one exists, and the intended look of the view and edit/new forms before generating code.
 - Every user-facing screen must pass a Material Design and Vuetify quality review before the chunk is considered done.
 - Any chunk that adds or changes user-facing UI must include a Playwright check that exercises the changed behavior before the chunk is considered done.
-- Record that Playwright run with `jskit app verify-ui --command "<playwright command>" --feature "<label>" --auth-mode <mode>` so `jskit doctor` can verify the receipt.
+- Record that Playwright run with `jskit app verify-ui --command "<playwright command>" --feature "<label>" --auth-mode <mode>` so `jskit doctor` can verify the receipt. For local pre-merge review, normally follow it with `jskit doctor --against <base-ref>`. Advanced CI setups may also use `--against <base-ref>`, but that is app-specific.
 - If the UI flow requires login, use the app's development-only auth bypass or session bootstrap path instead of a live external auth login flow.
 - In JSKIT apps using the standard auth stack, that means enabling the dev auth bypass in development and using `POST /api/dev-auth/login-as` during Playwright setup.
 - If authenticated UI work has no usable local auth bootstrap path yet, treat that as a testability gap and call it out before the chunk can be considered complete.

package/workflow/feature-delivery.md

@@ -62,6 +62,8 @@ Playwright note:
 
 - When login is required, use a test-only auth bypass or session bootstrap path instead of dependence on a live external auth provider.
 - Record the run through `jskit app verify-ui --command "<playwright command>" --feature "<label>" --auth-mode <mode>` so `jskit doctor` can verify the receipt against the current changed UI files.
+- In local pre-merge review, use `jskit doctor --against <base-ref>` after the recorded Playwright run so JSKIT compares against the branch delta, not only the current dirty worktree.
+- Advanced CI setups may also use `--against <base-ref>`, but JSKIT does not scaffold hosted browser/auth/database verification by default.
 - In the standard JSKIT auth stack, the default development path is `POST /api/dev-auth/login-as`, guarded by `AUTH_DEV_BYPASS_ENABLED=true` and `AUTH_DEV_BYPASS_SECRET=...`.
 - That route is development-only and must not be enabled in production.
 - Because it is still an unsafe POST, fetch `csrfToken` from `/api/session`, send it as the `csrf-token` header, and make the request in the same browser context that will run the Playwright assertions so the session cookies land in the page session.

package/workflow/review.md

@@ -33,6 +33,7 @@ Before calling a chunk or a whole changeset done, review it in four passes:
    - run the widest relevant verification commands for a whole changeset
    - any added or changed user-facing UI must be exercised with Playwright
    - that Playwright run should normally be recorded through `jskit app verify-ui`
+   - for local pre-merge review, prefer following that receipt with `jskit doctor --against <base-ref>`
    - if login is required, use the chosen local test-auth path instead of live external auth
    - in the standard JSKIT auth stack, prefer the development-only `POST /api/dev-auth/login-as` path
    - if there is no usable local auth bootstrap path, explicitly record that as a blocking testability gap