2026-05-13 17:01:48 +02:00
|
|
|
import {
|
|
|
|
|
createKtxSetupPromptAdapter,
|
|
|
|
|
type KtxSetupPromptOption,
|
|
|
|
|
} from './setup-prompts.js';
|
2026-05-10 23:51:24 +02:00
|
|
|
import type { KtxSetupStatus } from './setup.js';
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-17 10:27:29 +02:00
|
|
|
export type KtxSetupReadyAction =
|
|
|
|
|
| 'models'
|
|
|
|
|
| 'embeddings'
|
|
|
|
|
| 'databases'
|
|
|
|
|
| 'sources'
|
|
|
|
|
| 'runtime'
|
|
|
|
|
| 'context'
|
|
|
|
|
| 'agents'
|
|
|
|
|
| 'exit';
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-06-03 01:00:21 +02:00
|
|
|
/**
|
|
|
|
|
* Where a project stands once its `ktx.yaml` exists. Single source of truth for the
|
|
|
|
|
* end-of-setup interception: each state maps to exactly one obvious next action.
|
|
|
|
|
*/
|
|
|
|
|
export type KtxSetupCompletion = 'incomplete' | 'needs-context' | 'needs-agents' | 'ready';
|
|
|
|
|
|
chore(workspace): gate dead-code with knip production mode (#196)
* refactor(workspace): relocate @ktx/llm source into packages/cli/src/llm
* refactor(workspace): rewrite @ktx/llm imports to relative paths
* refactor(workspace): fold internal packages into cli
* chore(workspace): gate dead-code with knip production mode
Turn on production-mode knip plus an autofix run in pre-commit and the
`pnpm dead-code` script, document the `/** @internal */` convention for
test-only exports in AGENTS.md, annotate test-only exports across the
CLI with that JSDoc, and drop dead exports/wrappers the new gate
surfaced (e.g. `cli-project.ts`, `lookerRuntimeSourceToFileAdapterSource`,
`createLocalScanEnrichmentProvidersFromConfig`,
`PGLITE_OWNER_PROCESS_BACKEND_CAPABILITIES`, stale type re-exports).
Replace the loose `ignoreIssues` allowlist in `knip.json` with explicit
production entries so cross-package barrel leaks are caught.
* refactor(cli): delete internal barrel index.ts files
The 34 `index.ts` re-export barrels inside `packages/cli/src/` were
holdovers from the pre-fold multi-workspace structure. Post-fold-in they
served no production purpose: external consumers go through the single
package main entry, and in-repo callers mostly imported through them
only because the path was short. Internally, knip flagged most barrel
re-exports as production-dead (only reached via tests).
This change:
- Deletes every internal barrel except `packages/cli/src/index.ts`
(the published package entry).
- Rewrites ~270 source/test files to import each name directly from
the file that defines it.
- Moves `tools/warehouse-verification/index.ts` to
`create-warehouse-verification-tools.ts` (the function it defined
locally) and updates its single consumer.
- Renames `search/backend-conformance.ts` → `.test-utils.ts` to match
the existing test-helper file convention.
- Deletes 13 dead test-only chains (dbt-descriptions/*,
live-database/extracted-schema, live-database/structural-sync,
relationship-* feedback/review chain) plus their tests and a
cascading orphan integration test.
- Updates test mocks that pointed at deleted barrel paths
(notion-client, connector barrels in scan/local-scan-connectors
tests) to mock the source files instead.
- Points the maintainer benchmark script
(`scripts/relationship-benchmark-report.mjs`) at source files
instead of `dist/context/scan/index.js`.
- Drops the barrel `!` entries from `knip.json`; adds explicit
production entries only for the benchmark code reached via dist by
the maintainer script.
Net: 413 files changed, ~1.2k insertions, ~9.4k deletions.
`pnpm run dead-code` (Biome + knip default + knip production) and
`pnpm run type-check` are clean; 2277 tests pass.
* refactor(workspace): rename @ktx/cli to @kaelio/ktx and pack it directly
Promote the CLI workspace package to the public name `@kaelio/ktx` and
drop the separate `scripts/build-public-npm-package.mjs` wrapper. The
CLI package is now publishable in place (`publishConfig.access: public`,
`provenance: true`), so artifact packing uses `pnpm pack` against
`packages/cli/` instead of assembling a parallel package tree.
Updates all workspace filter invocations, docs, tests, and release
readiness checks to reference the new package name, and folds the
tarball-name helper into `scripts/public-npm-release-metadata.mjs`.
* docs: align "agent clients" and "data agents" terminology
Replace "client agents" with "agent clients" and "database agents" with
"data agents" across AGENTS.md, README.md, the docs-site copy, and the
matching setup-agents test description, matching the canonical
vocabulary in docs/terminology.md.
Also moves packages/cli/tsconfig.json's tsBuildInfoFile from
node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive
node_modules reinstalls.
* refactor(release): single source of truth for package version
Make packages/cli/package.json the single source of truth for the
@kaelio/ktx version. publicNpmPackageVersion() now reads it directly,
so artifact filenames, release-readiness checks, and the Python wheel
version all derive from one field. The duplicate
release-policy.json.publicNpmPackageVersion is removed.
Previously the two fields could drift: tarballs were named
kaelio-ktx-0.4.1.tgz while internally containing
@kaelio/ktx@0.0.0-private.
- update-public-release-version.mjs rewrites both Python pyproject.toml
files (ktx-daemon, ktx-sl) alongside the npm package.jsons,
normalizing the version for PEP 440 (e.g. 0.1.0-rc.2 -> 0.1.0rc2).
- semantic-release-config.cjs adds the two pyproject.toml files to
@semantic-release/git assets so the release commit back to main
carries every version source in lockstep.
- The six "?? '0.0.0-private'" fallback literals across the CLI are
replaced with "?? getKtxCliPackageInfo().version", and
createDefaultKtxMcpServer makes its version arg required.
- docs/release.md describes the actual commit-back model: the dev tree
always reflects the most recent release; no sentinel pin to
maintain.
Verified: pnpm run artifacts:build now produces
kaelio-ktx-0.4.1.tgz and kaelio_ktx-0.4.1-py3-none-any.whl with
@kaelio/ktx@0.4.1 inside. Full type-check, dead-code, and
2287 vitests + 173 script tests pass.
* refactor(cli): inject embedding provider resolution and detect sentence-transformers runtime
Make resolveProjectEmbeddingProvider and runtimeIo injectable in ingest and
scan command entrypoints so tests can stub them, and teach
resolvePublicIngestRuntimeRequirements to flag the local-embeddings runtime
feature when ktx.yaml selects sentence-transformers.
* chore(cli): mark buildLocalStatsStatus and LocalStatsStatus as @internal
Both symbols are consumed only by status-project.test.ts. Annotating with
/** @internal */ keeps knip's production-mode check clean without changing
runtime behavior.
* fix(cli): use real package metadata in print-command-tree
The stubbed package name embedded a forbidden product identifier that
tripped the boundary check in CI. Read the metadata from package.json
instead — keeps the rendered tree unchanged and removes a duplicate
source of truth.
* feat(cli): show embedding coverage in `ktx status`, drop duplicate disk counts
Inline `(N embedded)` next to the Wiki scope counts and Semantic-layer
source counts, computed with `SUM(embedding_json IS NOT NULL)` over
`knowledge_pages` and `local_sl_sources`. Rename the "Knowledge" label to
"Wiki" (canonical per `docs/terminology.md`) and rename the matching
`localStats.knowledgePages` field to `localStats.wikiPages`.
Drop `wiki=N md` and `semantic-layer=N yaml` from the Disk row — those
duplicated the per-surface rows above. Disk now reports only actual byte
usage (db, cache, raw-sources). The unused `wikiGlobalMarkdownCount` /
`semanticLayerYamlCount` fields, the `isMarkdownEntry` / `isYamlEntry`
helpers, and the `filter` arg on `summarizeDir` are removed.
2026-05-21 15:28:58 +02:00
|
|
|
interface KtxSetupReadyMenuPromptAdapter {
|
2026-05-13 17:01:48 +02:00
|
|
|
select(options: { message: string; options: KtxSetupPromptOption[] }): Promise<string>;
|
2026-05-10 23:12:26 +02:00
|
|
|
cancel(message: string): void;
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
export interface KtxSetupReadyMenuDeps {
|
|
|
|
|
prompts?: KtxSetupReadyMenuPromptAdapter;
|
2026-05-10 23:12:26 +02:00
|
|
|
}
|
|
|
|
|
|
2026-06-03 01:00:21 +02:00
|
|
|
export function setupHasContextTargets(status: KtxSetupStatus): boolean {
|
|
|
|
|
return status.databases.length > 0 || status.sources.length > 0;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function setupConfigReady(status: KtxSetupStatus): boolean {
|
2026-05-10 23:12:26 +02:00
|
|
|
return (
|
|
|
|
|
status.project.ready &&
|
|
|
|
|
status.llm.ready &&
|
|
|
|
|
status.embeddings.ready &&
|
|
|
|
|
status.databases.every((database) => database.ready) &&
|
|
|
|
|
status.sources.every((source) => source.ready) &&
|
2026-05-17 10:27:29 +02:00
|
|
|
status.runtime.ready &&
|
2026-06-03 01:00:21 +02:00
|
|
|
setupHasContextTargets(status)
|
2026-05-10 23:12:26 +02:00
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2026-06-03 01:00:21 +02:00
|
|
|
export function classifyKtxSetupCompletion(status: KtxSetupStatus): KtxSetupCompletion {
|
|
|
|
|
if (!setupConfigReady(status)) {
|
|
|
|
|
return 'incomplete';
|
|
|
|
|
}
|
|
|
|
|
if (!status.context.ready) {
|
|
|
|
|
return 'needs-context';
|
|
|
|
|
}
|
|
|
|
|
if (!status.agents.some((agent) => agent.ready)) {
|
|
|
|
|
return 'needs-agents';
|
|
|
|
|
}
|
|
|
|
|
return 'ready';
|
2026-05-10 23:13:17 -07:00
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
function createPromptAdapter(): KtxSetupReadyMenuPromptAdapter {
|
2026-05-13 17:01:48 +02:00
|
|
|
return createKtxSetupPromptAdapter({ selectCancelValue: 'exit' });
|
2026-05-10 23:12:26 +02:00
|
|
|
}
|
|
|
|
|
|
2026-06-03 01:00:21 +02:00
|
|
|
/**
|
|
|
|
|
* Shown when a returning user re-runs `ktx setup` on a fully-ready project. Leads with
|
|
|
|
|
* "you're done" (the readiness note is printed by the caller first) and keeps the
|
|
|
|
|
* section editor one explicit step away rather than defaulting into it.
|
|
|
|
|
*/
|
|
|
|
|
export async function runKtxSetupReadyMenu(
|
|
|
|
|
status: KtxSetupStatus,
|
|
|
|
|
deps: KtxSetupReadyMenuDeps = {},
|
|
|
|
|
): Promise<{ action: KtxSetupReadyAction }> {
|
|
|
|
|
const prompts = deps.prompts ?? createPromptAdapter();
|
|
|
|
|
const choice = await prompts.select({
|
|
|
|
|
message: 'Anything else?',
|
|
|
|
|
options: [
|
|
|
|
|
{ value: 'done', label: "Done — I'll start using ktx" },
|
|
|
|
|
{ value: 'change', label: 'Change a setting' },
|
|
|
|
|
],
|
|
|
|
|
});
|
|
|
|
|
if (choice !== 'change') {
|
|
|
|
|
return { action: 'exit' };
|
|
|
|
|
}
|
|
|
|
|
return runKtxSetupReadyChangeMenu(status, { prompts });
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** @internal Reached only through {@link runKtxSetupReadyMenu}; exported for unit tests. */
|
2026-05-10 23:51:24 +02:00
|
|
|
export async function runKtxSetupReadyChangeMenu(
|
|
|
|
|
status: KtxSetupStatus,
|
|
|
|
|
deps: KtxSetupReadyMenuDeps = {},
|
|
|
|
|
): Promise<{ action: KtxSetupReadyAction }> {
|
2026-05-10 23:12:26 +02:00
|
|
|
const prompts = deps.prompts ?? createPromptAdapter();
|
|
|
|
|
const action = (await prompts.select({
|
2026-06-03 01:00:21 +02:00
|
|
|
message: 'What would you like to change?',
|
2026-05-10 23:12:26 +02:00
|
|
|
options: [
|
|
|
|
|
{ value: 'models', label: 'Models' },
|
|
|
|
|
{ value: 'embeddings', label: 'Embeddings' },
|
2026-05-14 01:43:06 +02:00
|
|
|
{ value: 'databases', label: 'Databases' },
|
2026-05-10 23:12:26 +02:00
|
|
|
{ value: 'sources', label: 'Context sources' },
|
2026-05-17 10:27:29 +02:00
|
|
|
...(status.runtime.required ? [{ value: 'runtime', label: 'Runtime' }] : []),
|
2026-05-10 23:51:24 +02:00
|
|
|
{ value: 'context', label: 'Rebuild KTX context' },
|
2026-05-10 23:12:26 +02:00
|
|
|
{ value: 'agents', label: 'Agent integration' },
|
|
|
|
|
{ value: 'exit', label: 'Exit' },
|
|
|
|
|
],
|
2026-05-10 23:51:24 +02:00
|
|
|
})) as KtxSetupReadyAction;
|
2026-05-10 23:12:26 +02:00
|
|
|
return { action };
|
|
|
|
|
}
|