@jskit-ai/agent-docs 0.1.256 → 0.1.258

package/reference/autogen/tooling/config-eslint.md

@@ -32,17 +32,42 @@ Exports
 Exports
 - `baseConfig`
 
+### `clientFeatures.js`
+Exports
+- `clientFeaturesConfig(files, severity = "error")`
+Local functions
+- `clientFeaturesRules(severity)`
+- `componentRules(severity)`
+
+### `formatter.js`
+Exports
+- `formatterConfig(files, { ignores = [] } = {})`
+
 ### `index.js`
 Exports
 - `baseConfig`
 - `nodeConfig`
 - `webConfig`
 - `vueConfig`
+- `sizeLimitsConfig`
+- `typedFeaturesConfig`
+- `clientFeaturesConfig`
+- `formatterConfig`
+- `jskitPlugin`
 
 ### `node.js`
 Exports
 - `nodeConfig`
 
+### `typedFeatures.js`
+Exports
+- `sizeLimitRules(severity)`
+- `sizeLimitsConfig(files, { ignores = [] } = {})`
+- `typedFeaturesConfig(files, severity = "error")`
+Local functions
+- `typedFeaturesRules(severity)`
+- `requireGlobs(name, files)`
+
 ### `vue.js`
 Exports
 - `vueConfig`
@@ -50,3 +75,280 @@ Exports
 ### `web.js`
 Exports
 - `webConfig`
+
+### plugin
+
+### `plugin/factoryResults.js`
+Exports
+- `CREATE_NAME`
+- `FUNCTION_TYPES`
+- `VUE_STATE_CALLS`
+- `definedName(fn)`
+- `definitionOf(sourceCode, identifier)`
+- `enclosingFunction(sourceCode, node)`
+- `holdsBehaviour(sourceCode, object)`
+- `isInlineFunction(property)`
+- `isVueStateCall(node)`
+- `localFunction(sourceCode, identifier)`
+- `makesVueState(sourceCode, fn)`
+- `returnedFrom(sourceCode, node)`
+- `returnsOnlyData(sourceCode, fn)`
+Local functions
+- `findVariable(scope, name)`
+- `refersToFunction(sourceCode, property)`
+
+### `plugin/index.js`
+Exports
+- `jskitPlugin`
+
+### `plugin/packageSources.js`
+Exports
+- `clientSourceFiles(directory, files = [])`
+- `createSourceMemo(read, unreadable)`
+- `isGeneratedMirror(file)`
+- `isServerOrSharedFile(file, packageDirectory)`
+- `packageRootOf(file)`
+- `packageSourceFiles(directory, files = [])`
+- `toPosixPath(file)`
+Local functions
+- `isPackageDirectory(directory)`
+
+### `plugin/rules/actionCreator.js`
+Exports
+- `actionCreator`
+Local functions
+- `isCrudCustomAction(definition)`
+
+### `plugin/rules/actionExecuteShape.js`
+Exports
+- `actionExecuteShape`
+Local functions
+- `isPlainCallee(node)`
+- `unwrapCall(node)`
+- `shapeProblem(value)`
+
+### `plugin/rules/allowCommentForm.js`
+Exports
+- `allowCommentForm`
+Local functions
+- `holdsFunction(node)`
+- `excusedNode(sourceCode, comment)`
+- `allowLines(comment, opening = 2)`
+
+### `plugin/rules/appErrorCode.js`
+Exports
+- `appErrorCode`
+Local functions
+- `objectHasKey(node, name)`
+- `hasSpread(node)`
+- `setsOwnCode(classBody, sourceCode)`
+- `parameterIndex(parameters, name)`
+- `superCall(constructor)`
+- `forwardsRest(target, superOptions)`
+- `optionsIndex(parameters, superOptions)`
+- `localErrorClasses(program, sourceCode)`
+- `passesCode(node, { code, options })`
+- `literalText(node)`
+
+### `plugin/rules/collaboratorProps.js`
+Exports
+- `collaboratorProps`
+Local functions
+- `declaredProps(node)`
+- `unchain(node)`
+- `calledProp(callee, propsBinding, inTemplate)`
+- `optionText(sourceCode, prop, name)`
+
+### `plugin/rules/fixedResultShape.js`
+Exports
+- `fixedResultShape`
+Local functions
+- `calleeName(call)`
+- `addsBehaviour(sourceCode, value)`
+- `unwrapAwait(node)`
+- `callbackFactoryCall(call)`
+- `resultOwner(sourceCode, identifier)`
+
+### `plugin/rules/frozenFactoryResult.js`
+Exports
+- `frozenFactoryResult`
+
+### `plugin/rules/jsdocDescriptionInside.js`
+Exports
+- `jsdocDescriptionInside`
+Local functions
+- `startsItsLine(lines, comment)`
+
+### `plugin/rules/namedRepeatedType.js`
+Exports
+- `namedRepeatedType`
+Local functions
+- `balanced(text, start, open, close)`
+- `repeatableTypes(type)`
+- `moduleKey(specifier, directory)`
+- `importedNames(text, directory)`
+- `typeKey(text, file, imports)`
+- `commentTypes(text)`
+
+### `plugin/rules/noDualShape.js`
+Exports
+- `noDualShape`
+Local functions
+- `unwrapChain(node)`
+- `referenceText(sourceCode, node)`
+- `dualShape(sourceCode, member, fallback)`
+
+### `plugin/rules/noDuplicateHelper.js`
+Exports
+- `noDuplicateHelper`
+Local functions
+- `topLevelFunctions(program)`
+- `isNamedNoOp(fn)`
+- `topLevelHelpers(program, text)`
+- `comparisonRoot(file, packageDirectory)`
+- `compareCopies(left, right)`
+
+### `plugin/rules/noEnvDefault.js`
+Exports
+- `noEnvDefault`
+Local functions
+- `isProcessEnv(node)`
+
+### `plugin/rules/noFactorySpread.js`
+Exports
+- `noFactorySpread`
+Local functions
+- `unwrap(node)`
+- `factoryCall(sourceCode, argument)`
+- `spreadFactory(sourceCode, argument, factoryName)`
+- `returnedApi(sourceCode, object)`
+
+### `plugin/rules/noFrozenVueState.js`
+Exports
+- `noFrozenVueState`
+Local functions
+- `holdsVueState(sourceCode, value)`
+
+### `plugin/rules/noIdempotency.js`
+Exports
+- `noIdempotency`
+
+### `plugin/rules/noModuleRegistry.js`
+Exports
+- `noModuleRegistry`
+Local functions
+- `moduleBindings(program)`
+
+### `plugin/rules/noModuleState.js`
+Exports
+- `noModuleState`
+Local functions
+- `moduleDeclarations(program)`
+
+### `plugin/rules/noOptionalAfterDefault.js`
+Exports
+- `noOptionalAfterDefault`
+Local functions
+- `isPresentDefault(node)`
+- `defaultedNames(pattern, found = [])`
+
+### `plugin/rules/noPatchedError.js`
+Exports
+- `noPatchedError`
+Local functions
+- `calleeName(node)`
+- `isConstructedError(node)`
+
+### `plugin/rules/noSlotSetter.js`
+Exports
+- `noSlotSetter`
+
+### `plugin/rules/noTestOnlyExport.js`
+Exports
+- `noTestOnlyExport`
+Local functions
+- `exportedNames(node)`
+
+### `plugin/rules/oneLineAction.js`
+Exports
+- `oneLineAction`
+Local functions
+- `executeOf(definition)`
+- `isCrudCustomAction(definition)`
+- `definitionLiteral(element)`
+
+### `plugin/rules/onePropertyPerLine.js`
+Exports
+- `onePropertyPerLine`
+Local functions
+- `calleeName(call)`
+- `checkedPlace(object)`
+- `splitObjectLines(sourceCode, object)`
+
+### `plugin/rules/releasedListeners.js`
+Exports
+- `releasedListeners`
+Local functions
+- `calleeName(node)`
+- `eventType(sourceCode, node)`
+- `releasesItself(options)`
+- `keptAs(sourceCode, node)`
+- `listenedObject(sourceCode, node)`
+
+### `plugin/rules/requiredCollaborators.js`
+Exports
+- `requiredCollaborators`
+Local functions
+- `positionalCollaboratorDefaults(fn, visitorKeys)`
+
+### `plugin/rules/typedDependencies.js`
+Exports
+- `typedDependencies`
+Local functions
+- `hasParamJsdoc(sourceCode, node)`
+
+### `plugin/rules/typedInject.js`
+Exports
+- `typedInject`
+Local functions
+- `isTypedInjection(sourceCode, call)`
+
+### `plugin/support.js`
+Exports
+- `ABSENT_DEFAULT`
+- `CLIENT_GUIDE_URL`
+- `GUIDE_URL`
+- `compactText(sourceCode, node)`
+- `createReporter(context, ruleName)`
+- `deepFreezeNames(program)`
+- `factoryDependencies(fn, sourceCode, client = false)`
+- `followsOptionalLink(node)`
+- `functionName(fn)`
+- `functionSite(fn)`
+- `isActionDefinition(object)`
+- `isActionExecute(node, owner)`
+- `isActionsFile(filename)`
+- `isFreezeCall(node)`
+- `isFrozenValue(node, deepFreezing)`
+- `isFactory(fn, client = false)`
+- `isClientLint(context)`
+- `isInAction(context, node)`
+- `isWrittenActionDefinition(object)`
+- `keyName(property)`
+- `receivingFunction(context, node, name)`
+- `ruleMeta(description, messages, section, guide = GUIDE_URL)`
+- `walk(node, visitorKeys, visit)`
+Local functions
+- `enclosingFunctionLine(node)`
+- `templateElementLine(node)`
+- `isConstructor(fn)`
+- `collaboratorNames(fn, names, visitorKeys)`
+- `bodyDestructuring(fn, parameterName)`
+- `dependenciesPattern(fn, first)`
+
+### `plugin/vueSources.js`
+Exports
+- `hasJsdocBefore(sourceCode, node, tag)`
+- `hasTypeCast(sourceCode, node)`
+- `scriptSetupRanges(sourceCode)`
+- `vueImportNames(program, exported)`

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

@@ -23,12 +23,15 @@ Local functions
 - `buildCatalog({ repoRoot, packagesRoot, outputPath })`
 - `main()`
 
+### `scripts/files.mjs`
+Exports
+- `fileExists(absolutePath)`
+- `toPosixPath(value = "")`
+
 ### `scripts/framework-packages.mjs`
 Exports
 - `collectSingletonPackageIds(packageJsons)`
 - `discoverFrameworkPackages(packagesRoot)`
-Local functions
-- `fileExists(filePath)`
 
 ### `scripts/i18n.mjs`
 Exports
@@ -77,7 +80,6 @@ Exports
 - `parsePatternDocument(source = "", { documentPath = PATTERN_DOCUMENT_NAME } = {})`
 Local functions
 - `normalizeText(value = "")`
-- `normalizePath(value = "")`
 - `sortedUniqueStrings(values = [])`
 - `parseCommaSeparatedValue(value = "")`
 - `requirePatternFrontMatter(source = "", { documentPath = PATTERN_DOCUMENT_NAME } = {})`
@@ -85,6 +87,26 @@ Local functions
 - `directoryExists(directoryPath)`
 - `collectFiles(rootDirectory)`
 
+### `scripts/project-install.mjs`
+Exports
+- `readOptionalFile(absolutePath)`
+- `restoreProjectFiles(updates, packageLockPath, packageLockSnapshot)`
+- `runNpmInstall(projectRoot)`
+- `writeManifestUpdates(updates = [])`
+Local functions
+- `spawnNpmInstall(projectRoot)`
+
+### `scripts/project-manifests.mjs`
+Exports
+- `discoverProjectManifests(projectRoot, additionalManifests = [])`
+- `readJsonRecord(absolutePath)`
+- `serializePackageJson(value, originalContents = "")`
+Local functions
+- `normalizeWorkspacePatterns(value)`
+- `globToRegExp(pattern = "")`
+- `createWorkspaceMatcher(workspaces)`
+- `collectNestedPackageJsonPaths(directory, results = [])`
+
 ### `scripts/project-packages.mjs`
 Exports
 - `CATALOG_PACKAGE_ID`
@@ -95,30 +117,17 @@ Exports
 - `checkInstalledGraph({ catalog, manifestPaths = [], sourcePackages = {} } = {})`
 - `resolveInstalledPackage(consumerDirectory, packageId)`
 - `collectLockInstallations(packageLock = {})`
-- `discoverProjectManifests(projectRoot, additionalManifests = [])`
+- `discoverProjectManifests`
 - `normalizeCatalog(catalog = {})`
 - `updateProject({ projectRoot = process.cwd(), catalog, install = true, installProject = runNpmInstall, additionalManifests = [] } = {})`
 Local functions
-- `toPosixPath(value = "")`
-- `normalizeWorkspacePatterns(value)`
-- `globToRegExp(pattern = "")`
-- `createWorkspaceMatcher(workspaces)`
-- `fileExists(absolutePath)`
-- `readJsonRecord(absolutePath)`
-- `collectNestedPackageJsonPaths(directory, results = [])`
-- `serializePackageJson(value, originalContents = "")`
 - `collectManifestDeclarations(manifests, projectRoot)`
 - `collectLocalPackageNames(manifests)`
 - `resolveLockPackageName(packagePath = "", record = {})`
 - `collectJskitOverridePaths(value, currentPath = "overrides", results = [])`
-- `writeManifestUpdates(updates = [])`
-- `readOptionalFile(absolutePath)`
-- `restoreProjectFiles(updates, packageLockPath, packageLockSnapshot)`
 - `removeJskitDependencyRecords(dependencies = {}, localPackageNames = new Set())`
 - `alignLockManifestRecord(lockRecord, manifest, localPackageNames)`
 - `preparePackageLockForInstall(projectRoot, manifests, packageLockPath)`
-- `spawnNpmInstall(projectRoot)`
-- `runNpmInstall(projectRoot)`
 
 ### `scripts/verify-packages.mjs`
 Exports
@@ -129,9 +138,10 @@ Exports
 - `validateProviderList(packageRecord, side)`
 - `validateSingletonPeerDependencies(packages)`
 Local functions
-- `fileExists(filePath)`
 - `requireStringArray(value, label)`
 - `requireArchitectureId(value, label)`
 - `validateCapabilityMap(value, label)`
 - `validateProviderDefinition(value, label)`
+- `validateMigrationsAfter(packageJson)`
+- `validateMigrationDirectory(packageName, absoluteDirectory, relativeDirectory, migrationOwners)`
 - `validatePackage(packageRecord, localVersions, migrationOwners)`

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

@@ -14,6 +14,31 @@ Use this on demand; do not load the full index at startup.
 
 ### src
 
+### `src/manifests.mjs`
+Exports
+- `DEPENDENCY_FIELDS`
+- `bumpPatch(version)`
+- `collectPatternPackageJsonPaths(packageRoot, nestedManifests = ["patterns", "examples"])`
+- `collectPublishDependencies(packageJson, localNames)`
+- `collectVersionMismatches(packageJson, versions, source)`
+- `currentVersionMap(records)`
+- `discoverManifests(repoRoot)`
+- `discoverReleasePackages(repoRoot)`
+- `fileExists(absolutePath)`
+- `prepareManifests(records, versions, repoRoot, config)`
+- `readJsonFile(absolutePath)`
+- `releaseConfig(repoRoot)`
+- `serializeJson(value)`
+- `toPosixPath(value)`
+- `topologicalPublishOrder(records)`
+- `updatePackageDependencyVersions(packageJson, versions, changes = [])`
+- `updatePatternPackageJsonContents(contents, versions)`
+- `validateReleaseState(records, repoRoot)`
+Local functions
+- `followVersion(declared, version)`
+- `expandWorkspacePattern(repoRoot, pattern)`
+- `versionFilePaths(record)`
+
 ### `src/npm-publication.mjs`
 Exports
 - `createPublicationInspection({ directory, registry, configPath = "", env = process.env })`
@@ -30,31 +55,21 @@ Local functions
 ### `src/release.mjs`
 Exports
 - `assertMainReleaseCheckout(repoRoot)`
-- `bumpPatch(version)`
-- `collectPublishDependencies(packageJson, localNames)`
-- `collectPatternPackageJsonPaths(packageRoot, nestedManifests = ["patterns", "examples"])`
-- `collectVersionMismatches(packageJson, versions, source)`
+- `bumpPatch`
+- `collectPublishDependencies`
+- `collectPatternPackageJsonPaths`
+- `collectVersionMismatches`
 - `commitAndPush(repoRoot, message)`
-- `discoverManifests(repoRoot)`
-- `discoverReleasePackages(repoRoot)`
+- `discoverManifests`
+- `discoverReleasePackages`
 - `main(argv = process.argv.slice(2))`
 - `parseArgs(argv = [])`
-- `topologicalPublishOrder(records)`
-- `updatePackageDependencyVersions(packageJson, versions, changes = [])`
-- `updatePatternPackageJsonContents(contents, versions)`
-- `validateReleaseState(records, repoRoot)`
+- `topologicalPublishOrder`
+- `updatePackageDependencyVersions`
+- `updatePatternPackageJsonContents`
+- `validateReleaseState`
 Local functions
 - `normalizeRegistryUrl(value)`
-- `fileExists(absolutePath)`
-- `readJsonFile(absolutePath)`
-- `serializeJson(value)`
-- `toPosixPath(value)`
-- `followVersion(declared, version)`
-- `expandWorkspacePattern(repoRoot, pattern)`
-- `releaseConfig(repoRoot)`
-- `currentVersionMap(records)`
-- `prepareManifests(records, versions, repoRoot, config)`
-- `versionFilePaths(record)`
 - `runCommand(command, args, { cwd, env = process.env } = {})`
 - `compareVersions(left, right)`
 - `assertNoNewerVersions(records, inspection)`

package/reference/autogen/tooling/testUtils.md

@@ -24,4 +24,6 @@ Exports
 
 ### `fakeFastify.mjs`
 Exports
-- `createFakeFastifyPolicyRuntime({ csrfHandler, autoRunPlugin = null } = {})`
+- `createFakeFastifyPolicyRuntime({ csrfHandler = passCsrfProtection } = {})`
+Local functions
+- `passCsrfProtection(_request, _reply, done)`

package/skills/jskit/SKILL.md

@@ -38,11 +38,12 @@ manifests, migrations, tests, and runtime behaviour are the evidence.
 1. Read the request and nearest `AGENTS.md`.
 2. Inspect `package.json`, `package-lock.json`, installed package metadata, the
    existing tree, and the current diff when reviewing changes.
-3. Read the project's product documentation and current source. JSKIT does not
-   own a second project brain or prescribe a particular agent orchestrator.
+3. Read the project's product documentation and current source; JSKIT owns no
+   second project brain or agent orchestrator.
 4. Load only relevant references:
    - [port guide](references/existing-application-migration.md) for existing apps.
    - [heuristics index](references/heuristics/INDEX.md) for recurring traps.
+   - Before writing server code, read [typed features](references/typed-features.md) and its heuristic; client code, [client features](references/client-features.md). `npm run lint` checks both.
    - [multi-homing](references/multi-homing.md) for workspaces or invitations.
    - [translation](references/translation.md) for languages, translated texts
      or error codes.

package/skills/jskit/references/app-operations.md

@@ -1,4 +1,4 @@
-<!-- Generated from `packages/agent-docs/site/guide/framework/application-operations.md` by `npm run agent-docs:build`. -->
+<!-- Generated from `packages/agent-docs/site/guide/framework/application-operations.md`. -->
 
 # Application operations