@agentskit/doc-bridge 1.7.44 → 1.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +471 -0
- package/CONTRIBUTING.md +29 -4
- package/README.md +87 -40
- package/SECURITY.md +7 -0
- package/action.yml +1 -1
- package/bin/ak-docs.js +2 -2
- package/bin/ak-verify.js +13 -7
- package/dist/cli/program.d.ts +3 -1
- package/dist/cli/program.js +15888 -6061
- package/dist/cli/program.js.map +1 -1
- package/dist/config/index.d.ts +1 -1
- package/dist/config/index.js +91 -9
- package/dist/config/index.js.map +1 -1
- package/dist/index-Beor6Yhi.d.ts +792 -0
- package/dist/index.d.ts +9979 -3257
- package/dist/index.js +15954 -5774
- package/dist/index.js.map +1 -1
- package/docs/MARKETPLACE.md +1 -1
- package/docs/PRD-documentation-efficiency-study.md +406 -0
- package/docs/PRD-knowledge-retrieval-and-enrichment.md +466 -0
- package/docs/RELEASE.md +22 -8
- package/docs/adr/0002-documentation-audit-boundary.md +22 -0
- package/docs/adr/0003-study-protocol-and-historical-evidence.md +40 -0
- package/docs/adr/0004-controlled-study-runner.md +25 -0
- package/docs/adr/0005-documentation-quality-and-criticality.md +20 -0
- package/docs/adr/0006-registry-semantic-grounding.md +20 -0
- package/docs/adr/0007-longitudinal-study-metrics.md +21 -0
- package/docs/adr/0008-study-verification-boundary.md +21 -0
- package/docs/adr/0009-study-provider-cli-adapter.md +25 -0
- package/docs/agent-corpus/INDEX.md +14 -3
- package/docs/agent-corpus/OVERVIEW.md +25 -0
- package/docs/agent-corpus/chat.md +7 -3
- package/docs/agent-corpus/cli.md +18 -2
- package/docs/agent-corpus/conformance.md +14 -2
- package/docs/agent-corpus/doc-bridge.md +48 -1
- package/docs/agent-corpus/doctor.md +10 -2
- package/docs/agent-corpus/gates.md +6 -2
- package/docs/agent-corpus/mcp.md +15 -2
- package/docs/agent-corpus/memory.md +6 -2
- package/docs/agent-corpus/query.md +35 -2
- package/docs/bench/README.md +122 -0
- package/docs/bench/retrieval-baseline-v1.json +28 -0
- package/docs/bench/retrieval-suite-v1.json +1033 -0
- package/docs/chat-and-rag.md +3 -2
- package/docs/for-agents.md +9 -1
- package/docs/getting-started.md +4 -11
- package/docs/guides/gate-ci.md +11 -1
- package/docs/guides/install-and-run.md +9 -65
- package/docs/index.md +22 -1
- package/docs/knowledge-engine-runbook.md +51 -4
- package/docs/landing/assets/context-payload-reduction.svg +21 -0
- package/docs/landing/assets/controlled-ab-comparison.svg +30 -0
- package/docs/landing/index.html +119 -5
- package/docs/loop-workflow.md +117 -0
- package/docs/mcp.md +6 -1
- package/docs/parity/public-claims-v1.json +145 -0
- package/docs/playbook/doc-bridge-pattern.md +1 -1
- package/docs/query.md +90 -2
- package/docs/recipes/index-pipeline.md +1 -1
- package/docs/schemas/agent-handoff-v1.md +15 -0
- package/docs/schemas/doc-bridge-index-v1.md +65 -0
- package/docs/spec/benchmark-v1.md +39 -1
- package/docs/spec/cli.md +30 -10
- package/docs/spec/config-v1.md +192 -8
- package/docs/spec/documentation-audit-v1.md +61 -0
- package/docs/spec/enrichment-overlay-v1.md +241 -0
- package/docs/spec/graph-signals-v1.md +92 -0
- package/docs/spec/incremental-scan-v1.md +102 -0
- package/docs/spec/markdown-analyzer-v1.md +73 -0
- package/docs/spec/mcp-knowledge-tools-v1.md +147 -0
- package/docs/spec/measured-enrichment-v1.md +229 -0
- package/docs/spec/public-parity-v1.md +119 -0
- package/docs/spec/registry-agents.md +6 -0
- package/docs/spec/render-v1.md +122 -0
- package/docs/spec/retrieval-index-v1.md +164 -0
- package/docs/spec/study-metrics-v1.md +58 -0
- package/docs/spec/study-protocol-v1.md +46 -0
- package/docs/spec/study-provider-cli-v1.md +116 -0
- package/docs/spec/study-runner-v1.md +35 -0
- package/docs/spec/study-task-suite-v1.md +41 -0
- package/docs/spec/study-verification-v1.md +40 -0
- package/docs/study/README.md +84 -0
- package/docs/study/ab-adjudicated-cost-analysis-v1.md +29 -0
- package/docs/study/ab-adjudicated-cost-plan-v1.json +33 -0
- package/docs/study/ab-adjudicated-cost-plan-v2-v1.json +33 -0
- package/docs/study/ab-adjudicated-cost-result-v1.json +80 -0
- package/docs/study/ab-baseline-analysis-v1.md +21 -0
- package/docs/study/ab-baseline-plan-v1.json +33 -0
- package/docs/study/ab-baseline-recovery-plan-v1.json +33 -0
- package/docs/study/ab-baseline-result-v1.json +79 -0
- package/docs/study/documentation-audit-round-2026-08-31.json +183 -0
- package/docs/study/historical-evidence-v1.json +252 -0
- package/docs/study/observation-ledger-v1.json +30632 -0
- package/docs/study/phase3-task-coverage-v1.json +34 -0
- package/docs/study/phase4-public-pilot-ledger-v1.json +1344 -0
- package/docs/study/phase4-public-pilot-result-v1.json +52 -0
- package/docs/study/phase4-public-pilot-run-plan-v1.json +26 -0
- package/docs/study/phase4-public-pilot-task-suite-v1.json +71 -0
- package/docs/study/pilot-round-2026-08-31.json +46 -0
- package/docs/study/protocol-v1.json +90 -0
- package/docs/study/publication-gate-v1.md +45 -0
- package/docs/study/quality-scorecard-cycle-plan.md +545 -0
- package/docs/study/quality-scorecard-v1.json +38 -0
- package/docs/study/round-1-adjudicated-smoke-v1.json +30642 -0
- package/docs/study/round-1-instrumentation-plan-v1.md +39 -0
- package/docs/study/round-2-expanded-adjudication-v1.json +91 -0
- package/docs/study/round-2-expanded-validation-v1.md +58 -0
- package/docs/study/round-3-evidence-contract-v1.json +75 -0
- package/docs/study/round-3-evidence-contract-v1.md +57 -0
- package/docs/study/round-4-confirmation-v1.json +75 -0
- package/docs/study/round-4-confirmation-v1.md +55 -0
- package/docs/study/run-plan-v1.json +33 -0
- package/docs/study/semantic-adjudication-cycle-8.md +20 -0
- package/docs/study/task-suite-v1.json +96 -0
- package/docs/study/token-efficiency-plan-v1.md +337 -0
- package/docs/study/token-efficiency-protocol-v2.json +62 -0
- package/docs/study/verification-binding-v1.json +27 -0
- package/docs/validation-cycle-plan.md +33 -0
- package/docs/verification-harness.md +15 -6
- package/ecosystem-claims.json +2 -2
- package/ecosystem-upstream.json +2 -2
- package/ecosystem.json +4 -4
- package/mcpb/manifest.json +9 -1
- package/package.json +89 -72
- package/scripts/check-ecosystem-upstream.mjs +36 -7
- package/scripts/report-visual-check.mjs +20 -3
- package/skills/doc-bridge-handoff/fixtures/synthetic-repo/docs/for-agents/packages/payments.md +7 -0
- package/skills/doc-bridge-handoff/scripts/resolve-handoff.mjs +1 -1
- package/src/agents/registry-adapter.ts +192 -24
- package/src/audit/documentation.ts +513 -0
- package/src/bench/baseline.ts +198 -0
- package/src/bench/overlay-delta.ts +139 -0
- package/src/bench/retrieval.ts +319 -0
- package/src/budget/compile.ts +91 -0
- package/src/budget/sections.ts +70 -0
- package/src/cli/demo.ts +2 -2
- package/src/cli/program.ts +699 -79
- package/src/cli/usage.ts +71 -0
- package/src/config/defaults.ts +1 -0
- package/src/config/index.ts +4 -0
- package/src/config/load-config.ts +7 -1
- package/src/config/schema.ts +121 -4
- package/src/conformance/documentation-standard-v1.ts +22 -14
- package/src/discovery/areas.ts +182 -0
- package/src/discovery/documentation.ts +255 -23
- package/src/discovery/identity.ts +24 -0
- package/src/discovery/incremental.ts +314 -0
- package/src/discovery/inputs.ts +110 -0
- package/src/discovery/markdown.ts +481 -0
- package/src/discovery/repository.ts +557 -125
- package/src/doctor/run-doctor.ts +246 -27
- package/src/enrich/approvals.ts +190 -0
- package/src/enrich/cache.ts +93 -0
- package/src/enrich/context-pack.ts +272 -0
- package/src/enrich/overlay.ts +255 -0
- package/src/enrich/review.ts +106 -0
- package/src/enrich/stage.ts +374 -0
- package/src/enrich/stats.ts +100 -0
- package/src/enrich/validate.ts +410 -0
- package/src/federation/llms.ts +74 -24
- package/src/findings/report.ts +103 -0
- package/src/fixes/proposals.ts +4 -3
- package/src/graph/build.ts +356 -0
- package/src/graph/memory.ts +208 -0
- package/src/index-builder/build-handoffs.ts +22 -11
- package/src/index-builder/build-index.ts +132 -3
- package/src/index-builder/human-adapters/fumadocs.ts +1 -1
- package/src/index-builder/llms-txt.ts +48 -8
- package/src/index-builder/project-corpus.ts +111 -0
- package/src/index-builder/watch-index.ts +1 -1
- package/src/index.ts +630 -2
- package/src/lib/bounded-text.ts +15 -10
- package/src/lib/fuzzy-match.ts +235 -0
- package/src/mcp/knowledge.ts +554 -0
- package/src/mcp/server.ts +113 -18
- package/src/metrics/benchmark.ts +21 -0
- package/src/parity/check.ts +309 -0
- package/src/parity/claims.ts +259 -0
- package/src/parity/resolve.ts +160 -0
- package/src/query/handoff.ts +326 -0
- package/src/query/load-index.ts +53 -1
- package/src/query/query.ts +92 -59
- package/src/query/search.ts +289 -92
- package/src/query/text.ts +155 -0
- package/src/reconciliation/reconcile.ts +148 -15
- package/src/render/data.ts +356 -0
- package/src/render/engine.ts +398 -0
- package/src/render/generated.ts +77 -0
- package/src/render/render.ts +209 -0
- package/src/render/template-source.ts +52 -0
- package/src/render/templates.ts +289 -0
- package/src/report/html.ts +23 -17
- package/src/retrieval/bm25.ts +161 -0
- package/src/retrieval/project.ts +495 -0
- package/src/retrieval/rank.ts +383 -0
- package/src/retrieval/weights.ts +39 -0
- package/src/retriever/doc-bridge-retriever.ts +100 -15
- package/src/rules/engine.ts +45 -12
- package/src/safety/repository.ts +1 -1
- package/src/schemas/agent-handoff.ts +56 -0
- package/src/schemas/budget.ts +37 -0
- package/src/schemas/doc-bridge-index.ts +53 -2
- package/src/schemas/enrichment.ts +369 -0
- package/src/schemas/json-schemas.ts +39 -2
- package/src/schemas/knowledge.ts +19 -3
- package/src/schemas/retrieval-index.ts +152 -0
- package/src/shims/graphology.d.ts +91 -0
- package/src/study/adjudication.ts +196 -0
- package/src/study/execution.ts +350 -0
- package/src/study/expectations.ts +219 -0
- package/src/study/metrics.ts +467 -0
- package/src/study/protocol.ts +271 -0
- package/src/study/provider-cli.ts +115 -0
- package/src/study/provider-telemetry.ts +47 -0
- package/src/study/quality-scorecard.ts +164 -0
- package/src/study/runner.ts +461 -0
- package/src/study/task-suite.ts +321 -0
- package/src/study/verification.ts +134 -0
- package/src/validate.ts +8 -5
- package/src/version.ts +1 -1
- package/src/workflow/engine.ts +36 -11
- package/dist/index-C2PCQSrB.d.ts +0 -2251
- package/scripts/verification-harness.mjs +0 -483
|
@@ -0,0 +1,792 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
|
|
3
|
+
declare const AgentCorpusConfigSchema: z.ZodObject<{
|
|
4
|
+
root: z.ZodString;
|
|
5
|
+
index: z.ZodOptional<z.ZodString>;
|
|
6
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
7
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
8
|
+
okf: z.ZodOptional<z.ZodObject<{
|
|
9
|
+
requireType: z.ZodOptional<z.ZodBoolean>;
|
|
10
|
+
allowedTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
11
|
+
}, z.core.$strict>>;
|
|
12
|
+
}, z.core.$strict>;
|
|
13
|
+
declare const HumanCorpusConfigSchema: z.ZodObject<{
|
|
14
|
+
plugin: z.ZodEnum<{
|
|
15
|
+
"plain-markdown": "plain-markdown";
|
|
16
|
+
fumadocs: "fumadocs";
|
|
17
|
+
docusaurus: "docusaurus";
|
|
18
|
+
mkdocs: "mkdocs";
|
|
19
|
+
vitepress: "vitepress";
|
|
20
|
+
starlight: "starlight";
|
|
21
|
+
nextra: "nextra";
|
|
22
|
+
custom: "custom";
|
|
23
|
+
}>;
|
|
24
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
25
|
+
}, z.core.$strict>;
|
|
26
|
+
declare const RuleIdSchema: z.ZodEnum<{
|
|
27
|
+
ownership: "ownership";
|
|
28
|
+
"documentation-quality": "documentation-quality";
|
|
29
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
30
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
31
|
+
"unresolved-reference": "unresolved-reference";
|
|
32
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
33
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
34
|
+
"stale-documentation": "stale-documentation";
|
|
35
|
+
"centrality-risk": "centrality-risk";
|
|
36
|
+
"critical-path-risk": "critical-path-risk";
|
|
37
|
+
freshness: "freshness";
|
|
38
|
+
}>;
|
|
39
|
+
declare const RuleSeveritySchema: z.ZodEnum<{
|
|
40
|
+
error: "error";
|
|
41
|
+
off: "off";
|
|
42
|
+
info: "info";
|
|
43
|
+
warn: "warn";
|
|
44
|
+
}>;
|
|
45
|
+
declare const RulesConfigSchema: z.ZodObject<{
|
|
46
|
+
mode: z.ZodOptional<z.ZodEnum<{
|
|
47
|
+
default: "default";
|
|
48
|
+
strict: "strict";
|
|
49
|
+
recommended: "recommended";
|
|
50
|
+
}>>;
|
|
51
|
+
severity: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
52
|
+
ownership: "ownership";
|
|
53
|
+
"documentation-quality": "documentation-quality";
|
|
54
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
55
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
56
|
+
"unresolved-reference": "unresolved-reference";
|
|
57
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
58
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
59
|
+
"stale-documentation": "stale-documentation";
|
|
60
|
+
"centrality-risk": "centrality-risk";
|
|
61
|
+
"critical-path-risk": "critical-path-risk";
|
|
62
|
+
freshness: "freshness";
|
|
63
|
+
}> & z.core.$partial, z.ZodEnum<{
|
|
64
|
+
error: "error";
|
|
65
|
+
off: "off";
|
|
66
|
+
info: "info";
|
|
67
|
+
warn: "warn";
|
|
68
|
+
}>>>;
|
|
69
|
+
ignore: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
70
|
+
ownership: "ownership";
|
|
71
|
+
"documentation-quality": "documentation-quality";
|
|
72
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
73
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
74
|
+
"unresolved-reference": "unresolved-reference";
|
|
75
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
76
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
77
|
+
"stale-documentation": "stale-documentation";
|
|
78
|
+
"centrality-risk": "centrality-risk";
|
|
79
|
+
"critical-path-risk": "critical-path-risk";
|
|
80
|
+
freshness: "freshness";
|
|
81
|
+
}>>>;
|
|
82
|
+
criticalEntities: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
83
|
+
criticalPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
84
|
+
warningThresholds: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
85
|
+
ownership: "ownership";
|
|
86
|
+
"documentation-quality": "documentation-quality";
|
|
87
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
88
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
89
|
+
"unresolved-reference": "unresolved-reference";
|
|
90
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
91
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
92
|
+
"stale-documentation": "stale-documentation";
|
|
93
|
+
"centrality-risk": "centrality-risk";
|
|
94
|
+
"critical-path-risk": "critical-path-risk";
|
|
95
|
+
freshness: "freshness";
|
|
96
|
+
}> & z.core.$partial, z.ZodNumber>>;
|
|
97
|
+
}, z.core.$strict>;
|
|
98
|
+
declare const ReconciliationConfigSchema: z.ZodObject<{
|
|
99
|
+
scope: z.ZodOptional<z.ZodEnum<{
|
|
100
|
+
file: "file";
|
|
101
|
+
module: "module";
|
|
102
|
+
area: "area";
|
|
103
|
+
package: "package";
|
|
104
|
+
}>>;
|
|
105
|
+
requiredRelationKinds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
106
|
+
requiredRelationTargets: z.ZodOptional<z.ZodEnum<{
|
|
107
|
+
all: "all";
|
|
108
|
+
internal: "internal";
|
|
109
|
+
}>>;
|
|
110
|
+
includeOrphanedDocuments: z.ZodOptional<z.ZodBoolean>;
|
|
111
|
+
}, z.core.$strict>;
|
|
112
|
+
declare const DocumentationAuditConfigSchema: z.ZodObject<{
|
|
113
|
+
criticalPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
114
|
+
generatedPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
115
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
116
|
+
minWords: z.ZodOptional<z.ZodNumber>;
|
|
117
|
+
requiredSections: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
118
|
+
requireExamples: z.ZodOptional<z.ZodBoolean>;
|
|
119
|
+
exactDuplicates: z.ZodOptional<z.ZodBoolean>;
|
|
120
|
+
defaultTier: z.ZodOptional<z.ZodEnum<{
|
|
121
|
+
"tier-0": "tier-0";
|
|
122
|
+
"tier-1": "tier-1";
|
|
123
|
+
"tier-2": "tier-2";
|
|
124
|
+
}>>;
|
|
125
|
+
tierRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
126
|
+
pattern: z.ZodString;
|
|
127
|
+
tier: z.ZodEnum<{
|
|
128
|
+
"tier-0": "tier-0";
|
|
129
|
+
"tier-1": "tier-1";
|
|
130
|
+
"tier-2": "tier-2";
|
|
131
|
+
}>;
|
|
132
|
+
critical: z.ZodOptional<z.ZodBoolean>;
|
|
133
|
+
}, z.core.$strict>>>;
|
|
134
|
+
requiredCriticalMetadata: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
135
|
+
owner: "owner";
|
|
136
|
+
lifecycle: "lifecycle";
|
|
137
|
+
sourceOfTruth: "sourceOfTruth";
|
|
138
|
+
validationPath: "validationPath";
|
|
139
|
+
}>>>;
|
|
140
|
+
}, z.core.$strict>;
|
|
141
|
+
declare const WorkflowConfigSchema: z.ZodObject<{
|
|
142
|
+
stateDir: z.ZodOptional<z.ZodString>;
|
|
143
|
+
}, z.core.$strict>;
|
|
144
|
+
declare const RepositorySafetyConfigSchema: z.ZodObject<{
|
|
145
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
146
|
+
maxFiles: z.ZodOptional<z.ZodNumber>;
|
|
147
|
+
maxBytes: z.ZodOptional<z.ZodNumber>;
|
|
148
|
+
maxTimeMs: z.ZodOptional<z.ZodNumber>;
|
|
149
|
+
maxMemoryMb: z.ZodOptional<z.ZodNumber>;
|
|
150
|
+
redactSecrets: z.ZodOptional<z.ZodBoolean>;
|
|
151
|
+
}, z.core.$strict>;
|
|
152
|
+
declare const ReportConfigSchema: z.ZodObject<{
|
|
153
|
+
privacy: z.ZodOptional<z.ZodEnum<{
|
|
154
|
+
private: "private";
|
|
155
|
+
anonymized: "anonymized";
|
|
156
|
+
}>>;
|
|
157
|
+
}, z.core.$strict>;
|
|
158
|
+
declare const EcosystemContractEvidenceSchema: z.ZodObject<{
|
|
159
|
+
manifest: z.ZodString;
|
|
160
|
+
claims: z.ZodString;
|
|
161
|
+
productId: z.ZodString;
|
|
162
|
+
}, z.core.$strict>;
|
|
163
|
+
declare const DocumentationStandardRuleIdSchema: z.ZodEnum<{
|
|
164
|
+
"human-docs": "human-docs";
|
|
165
|
+
"llms-and-raw-source": "llms-and-raw-source";
|
|
166
|
+
"agent-handoffs": "agent-handoffs";
|
|
167
|
+
contribution: "contribution";
|
|
168
|
+
metadata: "metadata";
|
|
169
|
+
"cross-links": "cross-links";
|
|
170
|
+
"tested-quickstarts": "tested-quickstarts";
|
|
171
|
+
"visual-explanations": "visual-explanations";
|
|
172
|
+
"structured-diagrams": "structured-diagrams";
|
|
173
|
+
}>;
|
|
174
|
+
declare const DocumentationStandardV1ConfigSchema: z.ZodObject<{
|
|
175
|
+
rawSources: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
176
|
+
contributionPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
177
|
+
metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
178
|
+
path: z.ZodString;
|
|
179
|
+
contains: z.ZodArray<z.ZodString>;
|
|
180
|
+
}, z.core.$strict>>>;
|
|
181
|
+
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
182
|
+
url: z.ZodString;
|
|
183
|
+
paths: z.ZodArray<z.ZodString>;
|
|
184
|
+
}, z.core.$strict>>>;
|
|
185
|
+
quickstarts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
186
|
+
id: z.ZodString;
|
|
187
|
+
doc: z.ZodString;
|
|
188
|
+
test: z.ZodString;
|
|
189
|
+
command: z.ZodString;
|
|
190
|
+
testContains: z.ZodArray<z.ZodString>;
|
|
191
|
+
}, z.core.$strict>>>;
|
|
192
|
+
visuals: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
193
|
+
diagrams: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
194
|
+
path: z.ZodString;
|
|
195
|
+
contains: z.ZodArray<z.ZodString>;
|
|
196
|
+
}, z.core.$strict>>>;
|
|
197
|
+
ecosystemContract: z.ZodOptional<z.ZodObject<{
|
|
198
|
+
manifest: z.ZodString;
|
|
199
|
+
claims: z.ZodString;
|
|
200
|
+
productId: z.ZodString;
|
|
201
|
+
}, z.core.$strict>>;
|
|
202
|
+
exceptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
203
|
+
ruleId: z.ZodEnum<{
|
|
204
|
+
"human-docs": "human-docs";
|
|
205
|
+
"llms-and-raw-source": "llms-and-raw-source";
|
|
206
|
+
"agent-handoffs": "agent-handoffs";
|
|
207
|
+
contribution: "contribution";
|
|
208
|
+
metadata: "metadata";
|
|
209
|
+
"cross-links": "cross-links";
|
|
210
|
+
"tested-quickstarts": "tested-quickstarts";
|
|
211
|
+
"visual-explanations": "visual-explanations";
|
|
212
|
+
"structured-diagrams": "structured-diagrams";
|
|
213
|
+
}>;
|
|
214
|
+
reason: z.ZodString;
|
|
215
|
+
approvedBy: z.ZodString;
|
|
216
|
+
trackingUrl: z.ZodString;
|
|
217
|
+
}, z.core.$strict>>>;
|
|
218
|
+
}, z.core.$strict>;
|
|
219
|
+
/**
|
|
220
|
+
* Retrieval tuning. Weights and parameters are configuration rather than code so a repository can
|
|
221
|
+
* change what its agents find first without a release, and so the change is recorded in the index.
|
|
222
|
+
*/
|
|
223
|
+
declare const RetrievalConfigSchema: z.ZodObject<{
|
|
224
|
+
corpus: z.ZodOptional<z.ZodObject<{
|
|
225
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
226
|
+
}, z.core.$strict>>;
|
|
227
|
+
weights: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
|
|
228
|
+
params: z.ZodOptional<z.ZodObject<{
|
|
229
|
+
k1: z.ZodOptional<z.ZodNumber>;
|
|
230
|
+
b: z.ZodOptional<z.ZodNumber>;
|
|
231
|
+
}, z.core.$strict>>;
|
|
232
|
+
benchmark: z.ZodOptional<z.ZodObject<{
|
|
233
|
+
suite: z.ZodOptional<z.ZodString>;
|
|
234
|
+
}, z.core.$strict>>;
|
|
235
|
+
}, z.core.$strict>;
|
|
236
|
+
declare const ConformanceConfigSchema: z.ZodObject<{
|
|
237
|
+
documentationStandardV1: z.ZodOptional<z.ZodObject<{
|
|
238
|
+
rawSources: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
239
|
+
contributionPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
240
|
+
metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
241
|
+
path: z.ZodString;
|
|
242
|
+
contains: z.ZodArray<z.ZodString>;
|
|
243
|
+
}, z.core.$strict>>>;
|
|
244
|
+
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
245
|
+
url: z.ZodString;
|
|
246
|
+
paths: z.ZodArray<z.ZodString>;
|
|
247
|
+
}, z.core.$strict>>>;
|
|
248
|
+
quickstarts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
249
|
+
id: z.ZodString;
|
|
250
|
+
doc: z.ZodString;
|
|
251
|
+
test: z.ZodString;
|
|
252
|
+
command: z.ZodString;
|
|
253
|
+
testContains: z.ZodArray<z.ZodString>;
|
|
254
|
+
}, z.core.$strict>>>;
|
|
255
|
+
visuals: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
256
|
+
diagrams: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
257
|
+
path: z.ZodString;
|
|
258
|
+
contains: z.ZodArray<z.ZodString>;
|
|
259
|
+
}, z.core.$strict>>>;
|
|
260
|
+
ecosystemContract: z.ZodOptional<z.ZodObject<{
|
|
261
|
+
manifest: z.ZodString;
|
|
262
|
+
claims: z.ZodString;
|
|
263
|
+
productId: z.ZodString;
|
|
264
|
+
}, z.core.$strict>>;
|
|
265
|
+
exceptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
266
|
+
ruleId: z.ZodEnum<{
|
|
267
|
+
"human-docs": "human-docs";
|
|
268
|
+
"llms-and-raw-source": "llms-and-raw-source";
|
|
269
|
+
"agent-handoffs": "agent-handoffs";
|
|
270
|
+
contribution: "contribution";
|
|
271
|
+
metadata: "metadata";
|
|
272
|
+
"cross-links": "cross-links";
|
|
273
|
+
"tested-quickstarts": "tested-quickstarts";
|
|
274
|
+
"visual-explanations": "visual-explanations";
|
|
275
|
+
"structured-diagrams": "structured-diagrams";
|
|
276
|
+
}>;
|
|
277
|
+
reason: z.ZodString;
|
|
278
|
+
approvedBy: z.ZodString;
|
|
279
|
+
trackingUrl: z.ZodString;
|
|
280
|
+
}, z.core.$strict>>>;
|
|
281
|
+
}, z.core.$strict>>;
|
|
282
|
+
}, z.core.$strict>;
|
|
283
|
+
declare const DocBridgeConfigV1Schema: z.ZodObject<{
|
|
284
|
+
schemaVersion: z.ZodLiteral<1>;
|
|
285
|
+
project: z.ZodOptional<z.ZodObject<{
|
|
286
|
+
name: z.ZodOptional<z.ZodString>;
|
|
287
|
+
root: z.ZodOptional<z.ZodString>;
|
|
288
|
+
}, z.core.$strict>>;
|
|
289
|
+
corpus: z.ZodObject<{
|
|
290
|
+
agent: z.ZodObject<{
|
|
291
|
+
root: z.ZodString;
|
|
292
|
+
index: z.ZodOptional<z.ZodString>;
|
|
293
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
294
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
295
|
+
okf: z.ZodOptional<z.ZodObject<{
|
|
296
|
+
requireType: z.ZodOptional<z.ZodBoolean>;
|
|
297
|
+
allowedTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
298
|
+
}, z.core.$strict>>;
|
|
299
|
+
}, z.core.$strict>;
|
|
300
|
+
human: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
|
|
301
|
+
plugin: z.ZodEnum<{
|
|
302
|
+
"plain-markdown": "plain-markdown";
|
|
303
|
+
fumadocs: "fumadocs";
|
|
304
|
+
docusaurus: "docusaurus";
|
|
305
|
+
mkdocs: "mkdocs";
|
|
306
|
+
vitepress: "vitepress";
|
|
307
|
+
starlight: "starlight";
|
|
308
|
+
nextra: "nextra";
|
|
309
|
+
custom: "custom";
|
|
310
|
+
}>;
|
|
311
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
312
|
+
}, z.core.$strict>, z.ZodArray<z.ZodObject<{
|
|
313
|
+
plugin: z.ZodEnum<{
|
|
314
|
+
"plain-markdown": "plain-markdown";
|
|
315
|
+
fumadocs: "fumadocs";
|
|
316
|
+
docusaurus: "docusaurus";
|
|
317
|
+
mkdocs: "mkdocs";
|
|
318
|
+
vitepress: "vitepress";
|
|
319
|
+
starlight: "starlight";
|
|
320
|
+
nextra: "nextra";
|
|
321
|
+
custom: "custom";
|
|
322
|
+
}>;
|
|
323
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
324
|
+
}, z.core.$strict>>]>>;
|
|
325
|
+
}, z.core.$strict>;
|
|
326
|
+
index: z.ZodOptional<z.ZodObject<{
|
|
327
|
+
outFile: z.ZodOptional<z.ZodString>;
|
|
328
|
+
llmsTxt: z.ZodOptional<z.ZodObject<{
|
|
329
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
330
|
+
outFile: z.ZodOptional<z.ZodString>;
|
|
331
|
+
preamble: z.ZodOptional<z.ZodString>;
|
|
332
|
+
urlPrefix: z.ZodOptional<z.ZodString>;
|
|
333
|
+
pathPrefix: z.ZodOptional<z.ZodString>;
|
|
334
|
+
}, z.core.$strict>>;
|
|
335
|
+
capabilities: z.ZodOptional<z.ZodObject<{
|
|
336
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
337
|
+
outFile: z.ZodOptional<z.ZodString>;
|
|
338
|
+
}, z.core.$strict>>;
|
|
339
|
+
contentHash: z.ZodOptional<z.ZodLiteral<"sha256-normalized-v1">>;
|
|
340
|
+
}, z.core.$strict>>;
|
|
341
|
+
routing: z.ZodOptional<z.ZodObject<{
|
|
342
|
+
plugin: z.ZodOptional<z.ZodEnum<{
|
|
343
|
+
custom: "custom";
|
|
344
|
+
"pnpm-monorepo": "pnpm-monorepo";
|
|
345
|
+
"npm-workspaces": "npm-workspaces";
|
|
346
|
+
"yarn-workspaces": "yarn-workspaces";
|
|
347
|
+
nx: "nx";
|
|
348
|
+
"pattern-files": "pattern-files";
|
|
349
|
+
}>>;
|
|
350
|
+
options: z.ZodOptional<z.ZodObject<{
|
|
351
|
+
packages: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
352
|
+
ownershipFromCorpus: z.ZodOptional<z.ZodBoolean>;
|
|
353
|
+
ownership: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
354
|
+
path: z.ZodString;
|
|
355
|
+
group: z.ZodOptional<z.ZodString>;
|
|
356
|
+
layer: z.ZodOptional<z.ZodString>;
|
|
357
|
+
purpose: z.ZodOptional<z.ZodString>;
|
|
358
|
+
checks: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
359
|
+
agentDoc: z.ZodOptional<z.ZodString>;
|
|
360
|
+
humanDoc: z.ZodOptional<z.ZodString>;
|
|
361
|
+
}, z.core.$strict>>>;
|
|
362
|
+
intents: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
363
|
+
id: z.ZodString;
|
|
364
|
+
title: z.ZodString;
|
|
365
|
+
paths: z.ZodArray<z.ZodString>;
|
|
366
|
+
}, z.core.$strict>>>;
|
|
367
|
+
changes: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
368
|
+
id: z.ZodString;
|
|
369
|
+
title: z.ZodString;
|
|
370
|
+
startHere: z.ZodString;
|
|
371
|
+
relatedPackages: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
372
|
+
}, z.core.$strict>>>;
|
|
373
|
+
}, z.core.$strict>>;
|
|
374
|
+
}, z.core.$strict>>;
|
|
375
|
+
gates: z.ZodOptional<z.ZodObject<{
|
|
376
|
+
preset: z.ZodOptional<z.ZodEnum<{
|
|
377
|
+
minimal: "minimal";
|
|
378
|
+
standard: "standard";
|
|
379
|
+
strict: "strict";
|
|
380
|
+
playbook: "playbook";
|
|
381
|
+
}>>;
|
|
382
|
+
include: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
383
|
+
"index-freshness": "index-freshness";
|
|
384
|
+
"human-guide-links": "human-guide-links";
|
|
385
|
+
"link-rot": "link-rot";
|
|
386
|
+
"okf-type": "okf-type";
|
|
387
|
+
"docs-style": "docs-style";
|
|
388
|
+
"routing-currency": "routing-currency";
|
|
389
|
+
"bootstrap-size": "bootstrap-size";
|
|
390
|
+
"documentation-standard-v1": "documentation-standard-v1";
|
|
391
|
+
}>>>;
|
|
392
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
393
|
+
"index-freshness": "index-freshness";
|
|
394
|
+
"human-guide-links": "human-guide-links";
|
|
395
|
+
"link-rot": "link-rot";
|
|
396
|
+
"okf-type": "okf-type";
|
|
397
|
+
"docs-style": "docs-style";
|
|
398
|
+
"routing-currency": "routing-currency";
|
|
399
|
+
"bootstrap-size": "bootstrap-size";
|
|
400
|
+
"documentation-standard-v1": "documentation-standard-v1";
|
|
401
|
+
}>>>;
|
|
402
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
403
|
+
}, z.core.$strict>>;
|
|
404
|
+
reconciliation: z.ZodOptional<z.ZodObject<{
|
|
405
|
+
scope: z.ZodOptional<z.ZodEnum<{
|
|
406
|
+
file: "file";
|
|
407
|
+
module: "module";
|
|
408
|
+
area: "area";
|
|
409
|
+
package: "package";
|
|
410
|
+
}>>;
|
|
411
|
+
requiredRelationKinds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
412
|
+
requiredRelationTargets: z.ZodOptional<z.ZodEnum<{
|
|
413
|
+
all: "all";
|
|
414
|
+
internal: "internal";
|
|
415
|
+
}>>;
|
|
416
|
+
includeOrphanedDocuments: z.ZodOptional<z.ZodBoolean>;
|
|
417
|
+
}, z.core.$strict>>;
|
|
418
|
+
audit: z.ZodOptional<z.ZodObject<{
|
|
419
|
+
documentation: z.ZodOptional<z.ZodObject<{
|
|
420
|
+
criticalPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
421
|
+
generatedPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
422
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
423
|
+
minWords: z.ZodOptional<z.ZodNumber>;
|
|
424
|
+
requiredSections: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
425
|
+
requireExamples: z.ZodOptional<z.ZodBoolean>;
|
|
426
|
+
exactDuplicates: z.ZodOptional<z.ZodBoolean>;
|
|
427
|
+
defaultTier: z.ZodOptional<z.ZodEnum<{
|
|
428
|
+
"tier-0": "tier-0";
|
|
429
|
+
"tier-1": "tier-1";
|
|
430
|
+
"tier-2": "tier-2";
|
|
431
|
+
}>>;
|
|
432
|
+
tierRules: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
433
|
+
pattern: z.ZodString;
|
|
434
|
+
tier: z.ZodEnum<{
|
|
435
|
+
"tier-0": "tier-0";
|
|
436
|
+
"tier-1": "tier-1";
|
|
437
|
+
"tier-2": "tier-2";
|
|
438
|
+
}>;
|
|
439
|
+
critical: z.ZodOptional<z.ZodBoolean>;
|
|
440
|
+
}, z.core.$strict>>>;
|
|
441
|
+
requiredCriticalMetadata: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
442
|
+
owner: "owner";
|
|
443
|
+
lifecycle: "lifecycle";
|
|
444
|
+
sourceOfTruth: "sourceOfTruth";
|
|
445
|
+
validationPath: "validationPath";
|
|
446
|
+
}>>>;
|
|
447
|
+
}, z.core.$strict>>;
|
|
448
|
+
}, z.core.$strict>>;
|
|
449
|
+
analysis: z.ZodOptional<z.ZodObject<{
|
|
450
|
+
plugins: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
451
|
+
id: z.ZodString;
|
|
452
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
453
|
+
order: z.ZodOptional<z.ZodNumber>;
|
|
454
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
455
|
+
reason: z.ZodOptional<z.ZodString>;
|
|
456
|
+
}, z.core.$strict>>>;
|
|
457
|
+
jsTs: z.ZodOptional<z.ZodObject<{
|
|
458
|
+
runtimeWiringMethods: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
459
|
+
runtimeWiringAdapters: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
460
|
+
id: z.ZodString;
|
|
461
|
+
methods: z.ZodArray<z.ZodString>;
|
|
462
|
+
}, z.core.$strict>>>;
|
|
463
|
+
includeTestRuntimeWiring: z.ZodOptional<z.ZodBoolean>;
|
|
464
|
+
}, z.core.$strict>>;
|
|
465
|
+
areas: z.ZodOptional<z.ZodObject<{
|
|
466
|
+
depth: z.ZodOptional<z.ZodNumber>;
|
|
467
|
+
roots: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
468
|
+
}, z.core.$strict>>;
|
|
469
|
+
}, z.core.$strict>>;
|
|
470
|
+
rules: z.ZodOptional<z.ZodObject<{
|
|
471
|
+
mode: z.ZodOptional<z.ZodEnum<{
|
|
472
|
+
default: "default";
|
|
473
|
+
strict: "strict";
|
|
474
|
+
recommended: "recommended";
|
|
475
|
+
}>>;
|
|
476
|
+
severity: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
477
|
+
ownership: "ownership";
|
|
478
|
+
"documentation-quality": "documentation-quality";
|
|
479
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
480
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
481
|
+
"unresolved-reference": "unresolved-reference";
|
|
482
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
483
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
484
|
+
"stale-documentation": "stale-documentation";
|
|
485
|
+
"centrality-risk": "centrality-risk";
|
|
486
|
+
"critical-path-risk": "critical-path-risk";
|
|
487
|
+
freshness: "freshness";
|
|
488
|
+
}> & z.core.$partial, z.ZodEnum<{
|
|
489
|
+
error: "error";
|
|
490
|
+
off: "off";
|
|
491
|
+
info: "info";
|
|
492
|
+
warn: "warn";
|
|
493
|
+
}>>>;
|
|
494
|
+
ignore: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
495
|
+
ownership: "ownership";
|
|
496
|
+
"documentation-quality": "documentation-quality";
|
|
497
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
498
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
499
|
+
"unresolved-reference": "unresolved-reference";
|
|
500
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
501
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
502
|
+
"stale-documentation": "stale-documentation";
|
|
503
|
+
"centrality-risk": "centrality-risk";
|
|
504
|
+
"critical-path-risk": "critical-path-risk";
|
|
505
|
+
freshness: "freshness";
|
|
506
|
+
}>>>;
|
|
507
|
+
criticalEntities: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
508
|
+
criticalPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
509
|
+
warningThresholds: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
510
|
+
ownership: "ownership";
|
|
511
|
+
"documentation-quality": "documentation-quality";
|
|
512
|
+
"graph-undocumented-relation": "graph-undocumented-relation";
|
|
513
|
+
"declared-unobserved-relation": "declared-unobserved-relation";
|
|
514
|
+
"unresolved-reference": "unresolved-reference";
|
|
515
|
+
"conflicting-declaration": "conflicting-declaration";
|
|
516
|
+
"not-analyzed-coverage": "not-analyzed-coverage";
|
|
517
|
+
"stale-documentation": "stale-documentation";
|
|
518
|
+
"centrality-risk": "centrality-risk";
|
|
519
|
+
"critical-path-risk": "critical-path-risk";
|
|
520
|
+
freshness: "freshness";
|
|
521
|
+
}> & z.core.$partial, z.ZodNumber>>;
|
|
522
|
+
}, z.core.$strict>>;
|
|
523
|
+
workflow: z.ZodOptional<z.ZodObject<{
|
|
524
|
+
stateDir: z.ZodOptional<z.ZodString>;
|
|
525
|
+
}, z.core.$strict>>;
|
|
526
|
+
safety: z.ZodOptional<z.ZodObject<{
|
|
527
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
528
|
+
maxFiles: z.ZodOptional<z.ZodNumber>;
|
|
529
|
+
maxBytes: z.ZodOptional<z.ZodNumber>;
|
|
530
|
+
maxTimeMs: z.ZodOptional<z.ZodNumber>;
|
|
531
|
+
maxMemoryMb: z.ZodOptional<z.ZodNumber>;
|
|
532
|
+
redactSecrets: z.ZodOptional<z.ZodBoolean>;
|
|
533
|
+
}, z.core.$strict>>;
|
|
534
|
+
report: z.ZodOptional<z.ZodObject<{
|
|
535
|
+
privacy: z.ZodOptional<z.ZodEnum<{
|
|
536
|
+
private: "private";
|
|
537
|
+
anonymized: "anonymized";
|
|
538
|
+
}>>;
|
|
539
|
+
}, z.core.$strict>>;
|
|
540
|
+
surfaces: z.ZodOptional<z.ZodObject<{
|
|
541
|
+
cli: z.ZodOptional<z.ZodObject<{
|
|
542
|
+
bin: z.ZodOptional<z.ZodString>;
|
|
543
|
+
defaultFormat: z.ZodOptional<z.ZodEnum<{
|
|
544
|
+
json: "json";
|
|
545
|
+
text: "text";
|
|
546
|
+
}>>;
|
|
547
|
+
}, z.core.$strict>>;
|
|
548
|
+
mcp: z.ZodOptional<z.ZodObject<{
|
|
549
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
550
|
+
tools: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
551
|
+
"handoff.resolve": "handoff.resolve";
|
|
552
|
+
"doc.search": "doc.search";
|
|
553
|
+
"doc.get": "doc.get";
|
|
554
|
+
"gate.status": "gate.status";
|
|
555
|
+
"playbook.pattern.get": "playbook.pattern.get";
|
|
556
|
+
"retriever.query": "retriever.query";
|
|
557
|
+
"memory.classify": "memory.classify";
|
|
558
|
+
"memory.promoteDraft": "memory.promoteDraft";
|
|
559
|
+
"registry.topology": "registry.topology";
|
|
560
|
+
"docbridge.snapshot": "docbridge.snapshot";
|
|
561
|
+
"docbridge.report": "docbridge.report";
|
|
562
|
+
"docbridge.diagnostics": "docbridge.diagnostics";
|
|
563
|
+
"docbridge.relations": "docbridge.relations";
|
|
564
|
+
"docbridge.run": "docbridge.run";
|
|
565
|
+
"docbridge.proposals": "docbridge.proposals";
|
|
566
|
+
"knowledge.search": "knowledge.search";
|
|
567
|
+
"knowledge.lookup": "knowledge.lookup";
|
|
568
|
+
}>>>;
|
|
569
|
+
transport: z.ZodOptional<z.ZodEnum<{
|
|
570
|
+
stdio: "stdio";
|
|
571
|
+
http: "http";
|
|
572
|
+
}>>;
|
|
573
|
+
http: z.ZodOptional<z.ZodObject<{
|
|
574
|
+
port: z.ZodOptional<z.ZodNumber>;
|
|
575
|
+
path: z.ZodOptional<z.ZodString>;
|
|
576
|
+
}, z.core.$strict>>;
|
|
577
|
+
}, z.core.$strict>>;
|
|
578
|
+
}, z.core.$strict>>;
|
|
579
|
+
intelligence: z.ZodOptional<z.ZodObject<{
|
|
580
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
581
|
+
adapter: z.ZodOptional<z.ZodObject<{
|
|
582
|
+
provider: z.ZodEnum<{
|
|
583
|
+
custom: "custom";
|
|
584
|
+
openai: "openai";
|
|
585
|
+
anthropic: "anthropic";
|
|
586
|
+
ollama: "ollama";
|
|
587
|
+
openrouter: "openrouter";
|
|
588
|
+
}>;
|
|
589
|
+
model: z.ZodOptional<z.ZodString>;
|
|
590
|
+
apiKeyEnv: z.ZodOptional<z.ZodString>;
|
|
591
|
+
baseUrl: z.ZodOptional<z.ZodString>;
|
|
592
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
593
|
+
}, z.core.$strict>>;
|
|
594
|
+
chat: z.ZodOptional<z.ZodObject<{
|
|
595
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
596
|
+
sources: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
597
|
+
agent: "agent";
|
|
598
|
+
human: "human";
|
|
599
|
+
federation: "federation";
|
|
600
|
+
}>>>;
|
|
601
|
+
handoffFirst: z.ZodOptional<z.ZodBoolean>;
|
|
602
|
+
}, z.core.$strict>>;
|
|
603
|
+
retriever: z.ZodOptional<z.ZodObject<{
|
|
604
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
605
|
+
mode: z.ZodOptional<z.ZodEnum<{
|
|
606
|
+
local: "local";
|
|
607
|
+
remote: "remote";
|
|
608
|
+
bm25: "bm25";
|
|
609
|
+
"agentskit-rag": "agentskit-rag";
|
|
610
|
+
}>>;
|
|
611
|
+
embedModel: z.ZodOptional<z.ZodString>;
|
|
612
|
+
chunkSize: z.ZodOptional<z.ZodNumber>;
|
|
613
|
+
options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
614
|
+
}, z.core.$strict>>;
|
|
615
|
+
memory: z.ZodOptional<z.ZodObject<{
|
|
616
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
617
|
+
adapters: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
618
|
+
"playbook-memory": "playbook-memory";
|
|
619
|
+
"cursor-rules": "cursor-rules";
|
|
620
|
+
"session-export": "session-export";
|
|
621
|
+
"bootstrap-delta": "bootstrap-delta";
|
|
622
|
+
}>>>;
|
|
623
|
+
ingestDir: z.ZodOptional<z.ZodString>;
|
|
624
|
+
classify: z.ZodOptional<z.ZodBoolean>;
|
|
625
|
+
promote: z.ZodOptional<z.ZodObject<{
|
|
626
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
627
|
+
targets: z.ZodOptional<z.ZodArray<z.ZodEnum<{
|
|
628
|
+
agent: "agent";
|
|
629
|
+
human: "human";
|
|
630
|
+
"agents-md": "agents-md";
|
|
631
|
+
}>>>;
|
|
632
|
+
requireApproval: z.ZodOptional<z.ZodBoolean>;
|
|
633
|
+
}, z.core.$strict>>;
|
|
634
|
+
}, z.core.$strict>>;
|
|
635
|
+
runtime: z.ZodOptional<z.ZodEnum<{
|
|
636
|
+
custom: "custom";
|
|
637
|
+
agentskit: "agentskit";
|
|
638
|
+
}>>;
|
|
639
|
+
runtimeModule: z.ZodOptional<z.ZodString>;
|
|
640
|
+
registry: z.ZodOptional<z.ZodObject<{
|
|
641
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
642
|
+
agentId: z.ZodOptional<z.ZodString>;
|
|
643
|
+
agentRoot: z.ZodOptional<z.ZodString>;
|
|
644
|
+
runnerModule: z.ZodOptional<z.ZodString>;
|
|
645
|
+
cli: z.ZodOptional<z.ZodObject<{
|
|
646
|
+
command: z.ZodString;
|
|
647
|
+
args: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
648
|
+
}, z.core.$strict>>;
|
|
649
|
+
deterministic: z.ZodOptional<z.ZodBoolean>;
|
|
650
|
+
timeoutMs: z.ZodOptional<z.ZodNumber>;
|
|
651
|
+
maxInputBytes: z.ZodOptional<z.ZodNumber>;
|
|
652
|
+
maxTokens: z.ZodOptional<z.ZodNumber>;
|
|
653
|
+
maxResponseBytes: z.ZodOptional<z.ZodNumber>;
|
|
654
|
+
maxConcurrency: z.ZodOptional<z.ZodNumber>;
|
|
655
|
+
maxPackBytes: z.ZodOptional<z.ZodNumber>;
|
|
656
|
+
roles: z.ZodOptional<z.ZodObject<{
|
|
657
|
+
curator: z.ZodOptional<z.ZodObject<{
|
|
658
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
659
|
+
agentId: z.ZodOptional<z.ZodString>;
|
|
660
|
+
promptVersion: z.ZodOptional<z.ZodString>;
|
|
661
|
+
}, z.core.$strict>>;
|
|
662
|
+
reviewer: z.ZodOptional<z.ZodObject<{
|
|
663
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
664
|
+
agentId: z.ZodOptional<z.ZodString>;
|
|
665
|
+
promptVersion: z.ZodOptional<z.ZodString>;
|
|
666
|
+
}, z.core.$strict>>;
|
|
667
|
+
adjudicator: z.ZodOptional<z.ZodObject<{
|
|
668
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
669
|
+
agentId: z.ZodOptional<z.ZodString>;
|
|
670
|
+
promptVersion: z.ZodOptional<z.ZodString>;
|
|
671
|
+
}, z.core.$strict>>;
|
|
672
|
+
}, z.core.$strict>>;
|
|
673
|
+
}, z.core.$strict>>;
|
|
674
|
+
}, z.core.$strict>>;
|
|
675
|
+
federation: z.ZodOptional<z.ZodObject<{
|
|
676
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
677
|
+
sources: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
678
|
+
id: z.ZodString;
|
|
679
|
+
llmsTxt: z.ZodOptional<z.ZodString>;
|
|
680
|
+
rawBaseUrl: z.ZodOptional<z.ZodString>;
|
|
681
|
+
includeInRetriever: z.ZodOptional<z.ZodBoolean>;
|
|
682
|
+
includeInChat: z.ZodOptional<z.ZodBoolean>;
|
|
683
|
+
}, z.core.$strict>>>;
|
|
684
|
+
}, z.core.$strict>>;
|
|
685
|
+
conformance: z.ZodOptional<z.ZodObject<{
|
|
686
|
+
documentationStandardV1: z.ZodOptional<z.ZodObject<{
|
|
687
|
+
rawSources: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
688
|
+
contributionPaths: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
689
|
+
metadata: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
690
|
+
path: z.ZodString;
|
|
691
|
+
contains: z.ZodArray<z.ZodString>;
|
|
692
|
+
}, z.core.$strict>>>;
|
|
693
|
+
links: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
694
|
+
url: z.ZodString;
|
|
695
|
+
paths: z.ZodArray<z.ZodString>;
|
|
696
|
+
}, z.core.$strict>>>;
|
|
697
|
+
quickstarts: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
698
|
+
id: z.ZodString;
|
|
699
|
+
doc: z.ZodString;
|
|
700
|
+
test: z.ZodString;
|
|
701
|
+
command: z.ZodString;
|
|
702
|
+
testContains: z.ZodArray<z.ZodString>;
|
|
703
|
+
}, z.core.$strict>>>;
|
|
704
|
+
visuals: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
705
|
+
diagrams: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
706
|
+
path: z.ZodString;
|
|
707
|
+
contains: z.ZodArray<z.ZodString>;
|
|
708
|
+
}, z.core.$strict>>>;
|
|
709
|
+
ecosystemContract: z.ZodOptional<z.ZodObject<{
|
|
710
|
+
manifest: z.ZodString;
|
|
711
|
+
claims: z.ZodString;
|
|
712
|
+
productId: z.ZodString;
|
|
713
|
+
}, z.core.$strict>>;
|
|
714
|
+
exceptions: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
715
|
+
ruleId: z.ZodEnum<{
|
|
716
|
+
"human-docs": "human-docs";
|
|
717
|
+
"llms-and-raw-source": "llms-and-raw-source";
|
|
718
|
+
"agent-handoffs": "agent-handoffs";
|
|
719
|
+
contribution: "contribution";
|
|
720
|
+
metadata: "metadata";
|
|
721
|
+
"cross-links": "cross-links";
|
|
722
|
+
"tested-quickstarts": "tested-quickstarts";
|
|
723
|
+
"visual-explanations": "visual-explanations";
|
|
724
|
+
"structured-diagrams": "structured-diagrams";
|
|
725
|
+
}>;
|
|
726
|
+
reason: z.ZodString;
|
|
727
|
+
approvedBy: z.ZodString;
|
|
728
|
+
trackingUrl: z.ZodString;
|
|
729
|
+
}, z.core.$strict>>>;
|
|
730
|
+
}, z.core.$strict>>;
|
|
731
|
+
}, z.core.$strict>>;
|
|
732
|
+
retrieval: z.ZodOptional<z.ZodObject<{
|
|
733
|
+
corpus: z.ZodOptional<z.ZodObject<{
|
|
734
|
+
enabled: z.ZodOptional<z.ZodBoolean>;
|
|
735
|
+
}, z.core.$strict>>;
|
|
736
|
+
weights: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
|
|
737
|
+
params: z.ZodOptional<z.ZodObject<{
|
|
738
|
+
k1: z.ZodOptional<z.ZodNumber>;
|
|
739
|
+
b: z.ZodOptional<z.ZodNumber>;
|
|
740
|
+
}, z.core.$strict>>;
|
|
741
|
+
benchmark: z.ZodOptional<z.ZodObject<{
|
|
742
|
+
suite: z.ZodOptional<z.ZodString>;
|
|
743
|
+
}, z.core.$strict>>;
|
|
744
|
+
}, z.core.$strict>>;
|
|
745
|
+
render: z.ZodOptional<z.ZodObject<{
|
|
746
|
+
templates: z.ZodOptional<z.ZodRecord<z.ZodEnum<{
|
|
747
|
+
ownership: "ownership";
|
|
748
|
+
area: "area";
|
|
749
|
+
"llms.txt": "llms.txt";
|
|
750
|
+
"change-digest": "change-digest";
|
|
751
|
+
"overlay-review": "overlay-review";
|
|
752
|
+
}> & z.core.$partial, z.ZodString>>;
|
|
753
|
+
}, z.core.$strict>>;
|
|
754
|
+
}, z.core.$strict>;
|
|
755
|
+
type DocBridgeConfigV1 = z.infer<typeof DocBridgeConfigV1Schema>;
|
|
756
|
+
type AgentCorpusConfig = z.infer<typeof AgentCorpusConfigSchema>;
|
|
757
|
+
type DocumentationStandardV1Config = z.infer<typeof DocumentationStandardV1ConfigSchema>;
|
|
758
|
+
type DocumentationStandardRuleId = z.infer<typeof DocumentationStandardRuleIdSchema>;
|
|
759
|
+
type ReconciliationConfig = z.infer<typeof ReconciliationConfigSchema>;
|
|
760
|
+
type DocumentationAuditConfig = z.infer<typeof DocumentationAuditConfigSchema>;
|
|
761
|
+
type RuleId = z.infer<typeof RuleIdSchema>;
|
|
762
|
+
type RuleSeverity = z.infer<typeof RuleSeveritySchema>;
|
|
763
|
+
type RulesConfig = z.infer<typeof RulesConfigSchema>;
|
|
764
|
+
type WorkflowConfig = z.infer<typeof WorkflowConfigSchema>;
|
|
765
|
+
type RepositorySafetyConfig = z.infer<typeof RepositorySafetyConfigSchema>;
|
|
766
|
+
type ReportConfig = z.infer<typeof ReportConfigSchema>;
|
|
767
|
+
type RetrievalConfig = z.infer<typeof RetrievalConfigSchema>;
|
|
768
|
+
|
|
769
|
+
/** Type-safe config helper for `doc-bridge.config.ts`. */
|
|
770
|
+
declare const defineConfig: (config: DocBridgeConfigV1) => DocBridgeConfigV1;
|
|
771
|
+
|
|
772
|
+
declare const applyConfigDefaults: (config: DocBridgeConfigV1) => DocBridgeConfigV1;
|
|
773
|
+
|
|
774
|
+
type LoadConfigOptions = {
|
|
775
|
+
readonly cwd?: string;
|
|
776
|
+
readonly explicitPath?: string;
|
|
777
|
+
};
|
|
778
|
+
type LoadConfigResult = {
|
|
779
|
+
readonly config: DocBridgeConfigV1;
|
|
780
|
+
readonly path: string;
|
|
781
|
+
};
|
|
782
|
+
declare class ConfigNotFoundError extends Error {
|
|
783
|
+
readonly cwd: string;
|
|
784
|
+
constructor(cwd: string);
|
|
785
|
+
}
|
|
786
|
+
/** v0.1 — static JS/TS config, JSON config files, and package.json#docBridge. */
|
|
787
|
+
declare const loadConfig: (opts?: LoadConfigOptions) => LoadConfigResult;
|
|
788
|
+
declare const resolveProjectRoot: (start?: string) => string;
|
|
789
|
+
/** Project root for a loaded config file path (directory of the config). */
|
|
790
|
+
declare const projectRootFromConfigPath: (configFilePath: string, projectRootField?: string) => string;
|
|
791
|
+
|
|
792
|
+
export { type AgentCorpusConfig as A, ReconciliationConfigSchema as B, ConfigNotFoundError as C, type DocBridgeConfigV1 as D, EcosystemContractEvidenceSchema as E, type RetrievalConfig as F, RetrievalConfigSchema as G, HumanCorpusConfigSchema as H, type LoadConfigOptions as L, type RulesConfig as R, type WorkflowConfig as W, type DocumentationAuditConfig as a, type RuleId as b, type RuleSeverity as c, type DocumentationStandardRuleId as d, DocBridgeConfigV1Schema as e, DocumentationAuditConfigSchema as f, DocumentationStandardRuleIdSchema as g, type DocumentationStandardV1Config as h, DocumentationStandardV1ConfigSchema as i, type LoadConfigResult as j, type ReportConfig as k, ReportConfigSchema as l, type RepositorySafetyConfig as m, RepositorySafetyConfigSchema as n, RuleIdSchema as o, RuleSeveritySchema as p, RulesConfigSchema as q, WorkflowConfigSchema as r, applyConfigDefaults as s, defineConfig as t, loadConfig as u, projectRootFromConfigPath as v, resolveProjectRoot as w, AgentCorpusConfigSchema as x, ConformanceConfigSchema as y, type ReconciliationConfig as z };
|