@weftlet/toolkit 0.2.1 → 0.4.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/README.md +80 -0
- package/dist/application/agent-context.d.ts +3 -1
- package/dist/application/agent-context.js +15 -6
- package/dist/application/application.js +7 -4
- package/dist/application/cache-adoption.d.ts +43 -0
- package/dist/application/cache-adoption.js +129 -0
- package/dist/application/extraction-identity.d.ts +6 -0
- package/dist/application/extraction-identity.js +15 -0
- package/dist/application/hydration-failure.d.ts +41 -0
- package/dist/application/hydration-failure.js +43 -0
- package/dist/application/hydration-plan.d.ts +54 -0
- package/dist/application/hydration-plan.js +71 -0
- package/dist/application/hydrator.d.ts +3 -5
- package/dist/application/hydrator.js +30 -61
- package/dist/application/overlay.js +10 -3
- package/dist/application/saved-evidence.d.ts +6 -3
- package/dist/application/saved-evidence.js +7 -1
- package/dist/application/semantic-artifact-store.d.ts +4 -0
- package/dist/application/semantic-artifact-store.js +7 -0
- package/dist/application/semantic-run.d.ts +29 -0
- package/dist/application/semantic-run.js +111 -0
- package/dist/application/semantic-scope.d.ts +13 -0
- package/dist/application/semantic-scope.js +12 -0
- package/dist/application/snapshot-checks.d.ts +2 -1
- package/dist/application/snapshot-checks.js +8 -1
- package/dist/configuration/cache.d.ts +6 -0
- package/dist/configuration/cache.js +18 -0
- package/dist/extraction/document.js +1 -1
- package/dist/extraction/providers.js +12 -5
- package/dist/extraction/repository-nodes.d.ts +2 -3
- package/dist/extraction/repository-nodes.js +5 -11
- package/dist/extraction/routing.d.ts +1 -1
- package/dist/extraction/routing.js +3 -6
- package/dist/extraction/semantic-cache.d.ts +13 -0
- package/dist/extraction/semantic-cache.js +66 -0
- package/dist/extraction/semantic-diagnostics.d.ts +9 -0
- package/dist/extraction/semantic-diagnostics.js +15 -0
- package/dist/extraction/semantic-identity.d.ts +7 -0
- package/dist/extraction/semantic-identity.js +29 -0
- package/dist/extraction/semantic-sources.d.ts +27 -0
- package/dist/extraction/semantic-sources.js +35 -0
- package/dist/extraction/semantic.d.ts +5 -1
- package/dist/extraction/semantic.js +47 -24
- package/dist/extraction/static.d.ts +13 -5
- package/dist/extraction/static.js +8 -15
- package/dist/governance/governance.js +11 -7
- package/dist/graph/query.js +2 -0
- package/dist/graph/rdf.d.ts +1 -1
- package/dist/graph/rdf.js +13 -28
- package/dist/graph/shacl-shapes.d.ts +5 -0
- package/dist/graph/shacl-shapes.js +27 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +4 -0
- package/dist/interfaces/cli.js +86 -19
- package/dist/repository/git.d.ts +1 -1
- package/dist/repository/git.js +5 -1
- package/dist/storage/storage.d.ts +7 -1
- package/dist/storage/storage.js +15 -3
- package/dist/visualization/visualization.js +1 -0
- package/docs/ADR-016-hydration-preview.md +91 -0
- package/docs/ADR-017-shacl-validation-union.md +102 -0
- package/docs/ADR-018-operational-semantic-cache.md +100 -0
- package/docs/ADR-019-semantic-failure-diagnostics.md +82 -0
- package/docs/ADR-020-canonical-physical-file-producers.md +97 -0
- package/docs/PROVIDERS.md +51 -1
- package/docs/RELEASE-1.0-PLAN.md +148 -32
- package/docs/RELEASING.md +19 -6
- package/docs/ROADMAP.md +46 -5
- package/docs/VALIDATION.md +341 -3
- package/docs/WEFTLET-2.0-PLAN.md +9 -8
- package/docs/extraction-manifest.json +55 -23
- package/package.json +3 -2
package/dist/graph/rdf.js
CHANGED
|
@@ -1,39 +1,16 @@
|
|
|
1
1
|
import { QueryEngine } from '@comunica/query-sparql';
|
|
2
|
-
import { DataFactory,
|
|
2
|
+
import { DataFactory, Store, Writer } from 'n3';
|
|
3
3
|
import SHACLValidator from 'rdf-validate-shacl';
|
|
4
4
|
import { contextPackEvidenceAuthority } from "./authority.js";
|
|
5
5
|
import { stableJson } from "../infrastructure/util.js";
|
|
6
6
|
import { createRequire } from 'node:module';
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
const XSD = 'http://www.w3.org/2001/XMLSchema#';
|
|
7
|
+
import { CG, RDF, XSD, evidenceShapes } from './shacl-shapes.js';
|
|
8
|
+
const { namedNode: iri, literal } = DataFactory;
|
|
9
|
+
export { CG } from './shacl-shapes.js';
|
|
11
10
|
export const nodeIri = (id) => `urn:context-graph:node:${encodeURIComponent(id)}`;
|
|
12
11
|
export const factIri = (id) => `urn:context-graph:fact:${encodeURIComponent(id)}`;
|
|
13
12
|
const engine = new QueryEngine();
|
|
14
13
|
const SparqlParser = createRequire(import.meta.url)('sparqljs').Parser;
|
|
15
|
-
const shapes = new Parser().parse(`
|
|
16
|
-
@prefix cg: <${CG}>.
|
|
17
|
-
@prefix rdf: <${RDF}>.
|
|
18
|
-
@prefix sh: <http://www.w3.org/ns/shacl#>.
|
|
19
|
-
@prefix xsd: <${XSD}>.
|
|
20
|
-
cg:FactShape a sh:NodeShape; sh:targetClass rdf:Statement;
|
|
21
|
-
sh:property [ sh:path cg:record; sh:minCount 1; sh:maxCount 1; sh:datatype xsd:string ];
|
|
22
|
-
sh:property [ sh:path rdf:subject; sh:minCount 1; sh:maxCount 1; sh:nodeKind sh:IRI ];
|
|
23
|
-
sh:property [ sh:path rdf:predicate; sh:minCount 1; sh:maxCount 1; sh:nodeKind sh:IRI ];
|
|
24
|
-
sh:property [ sh:path rdf:object; sh:minCount 1; sh:maxCount 1; sh:nodeKind sh:IRI ];
|
|
25
|
-
sh:property [ sh:path cg:authority; sh:minCount 1; sh:maxCount 1;
|
|
26
|
-
sh:in ("declared" "implemented" "validated" "observed" "inferred" "draft") ];
|
|
27
|
-
sh:property [ sh:path cg:path; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ];
|
|
28
|
-
sh:property [ sh:path cg:commit; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ];
|
|
29
|
-
sh:property [ sh:path cg:sourceDigest; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ];
|
|
30
|
-
sh:property [ sh:path cg:startLine; sh:minCount 1; sh:datatype xsd:integer; sh:minInclusive 1 ];
|
|
31
|
-
sh:property [ sh:path cg:endLine; sh:minCount 1; sh:datatype xsd:integer; sh:minInclusive 1 ];
|
|
32
|
-
sh:property [ sh:path cg:confidence; sh:minCount 1; sh:datatype xsd:decimal; sh:minInclusive 0; sh:maxInclusive 1 ];
|
|
33
|
-
sh:property [ sh:path cg:extractor; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ].
|
|
34
|
-
cg:NodeShape a sh:NodeShape; sh:targetClass cg:Node;
|
|
35
|
-
sh:property [ sh:path cg:kind; sh:minCount 1; sh:maxCount 1 ].
|
|
36
|
-
`);
|
|
37
14
|
/** Lossless RDF dataset: one named graph per cited assertion, with provenance in the default graph. */
|
|
38
15
|
export class RdfEvidenceGraph {
|
|
39
16
|
snapshot;
|
|
@@ -85,7 +62,15 @@ export class RdfEvidenceGraph {
|
|
|
85
62
|
}
|
|
86
63
|
}
|
|
87
64
|
async validate() {
|
|
88
|
-
|
|
65
|
+
// These graph-independent shapes already read the dataset as a union. Index
|
|
66
|
+
// that union once so every property lookup avoids scanning one graph per fact.
|
|
67
|
+
// Keep every triple; the original named dataset retains assertion provenance
|
|
68
|
+
// and remains the source for queries and serialization.
|
|
69
|
+
const validationGraph = new Store();
|
|
70
|
+
for (const { subject, predicate, object } of this.dataset) {
|
|
71
|
+
validationGraph.addQuad(subject, predicate, object);
|
|
72
|
+
}
|
|
73
|
+
const report = await new SHACLValidator(new Store(evidenceShapes)).validate(validationGraph);
|
|
89
74
|
const issues = report.results.map((result) => ({
|
|
90
75
|
category: 'extraction-gap',
|
|
91
76
|
focus: result.focusNode?.value,
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare const CG = "https://context-graph.dev/record#";
|
|
2
|
+
export declare const RDF = "http://www.w3.org/1999/02/22-rdf-syntax-ns#";
|
|
3
|
+
export declare const XSD = "http://www.w3.org/2001/XMLSchema#";
|
|
4
|
+
/** Graph-independent evidence constraints, evaluated over the union of all assertion graphs. */
|
|
5
|
+
export declare const evidenceShapes: import("n3").Quad[];
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { Parser } from 'n3';
|
|
2
|
+
export const CG = 'https://context-graph.dev/record#';
|
|
3
|
+
export const RDF = 'http://www.w3.org/1999/02/22-rdf-syntax-ns#';
|
|
4
|
+
export const XSD = 'http://www.w3.org/2001/XMLSchema#';
|
|
5
|
+
/** Graph-independent evidence constraints, evaluated over the union of all assertion graphs. */
|
|
6
|
+
export const evidenceShapes = new Parser().parse(`
|
|
7
|
+
@prefix cg: <${CG}>.
|
|
8
|
+
@prefix rdf: <${RDF}>.
|
|
9
|
+
@prefix sh: <http://www.w3.org/ns/shacl#>.
|
|
10
|
+
@prefix xsd: <${XSD}>.
|
|
11
|
+
cg:FactShape a sh:NodeShape; sh:targetClass rdf:Statement;
|
|
12
|
+
sh:property [ sh:path cg:record; sh:minCount 1; sh:maxCount 1; sh:datatype xsd:string ];
|
|
13
|
+
sh:property [ sh:path rdf:subject; sh:minCount 1; sh:maxCount 1; sh:nodeKind sh:IRI ];
|
|
14
|
+
sh:property [ sh:path rdf:predicate; sh:minCount 1; sh:maxCount 1; sh:nodeKind sh:IRI ];
|
|
15
|
+
sh:property [ sh:path rdf:object; sh:minCount 1; sh:maxCount 1; sh:nodeKind sh:IRI ];
|
|
16
|
+
sh:property [ sh:path cg:authority; sh:minCount 1; sh:maxCount 1;
|
|
17
|
+
sh:in ("declared" "implemented" "validated" "observed" "inferred" "draft") ];
|
|
18
|
+
sh:property [ sh:path cg:path; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ];
|
|
19
|
+
sh:property [ sh:path cg:commit; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ];
|
|
20
|
+
sh:property [ sh:path cg:sourceDigest; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ];
|
|
21
|
+
sh:property [ sh:path cg:startLine; sh:minCount 1; sh:datatype xsd:integer; sh:minInclusive 1 ];
|
|
22
|
+
sh:property [ sh:path cg:endLine; sh:minCount 1; sh:datatype xsd:integer; sh:minInclusive 1 ];
|
|
23
|
+
sh:property [ sh:path cg:confidence; sh:minCount 1; sh:datatype xsd:decimal; sh:minInclusive 0; sh:maxInclusive 1 ];
|
|
24
|
+
sh:property [ sh:path cg:extractor; sh:minCount 1; sh:datatype xsd:string; sh:minLength 1 ].
|
|
25
|
+
cg:NodeShape a sh:NodeShape; sh:targetClass cg:Node;
|
|
26
|
+
sh:property [ sh:path cg:kind; sh:minCount 1; sh:maxCount 1 ].
|
|
27
|
+
`);
|
package/dist/index.d.ts
CHANGED
|
@@ -9,3 +9,7 @@ export * from "./visualization/visualization.js";
|
|
|
9
9
|
export * from "./application/overlay.js";
|
|
10
10
|
export * from "./graph/rdf.js";
|
|
11
11
|
export * from "./extraction/providers.js";
|
|
12
|
+
export * from './application/hydration-plan.js';
|
|
13
|
+
export * from './application/cache-adoption.js';
|
|
14
|
+
export * from './application/hydration-failure.js';
|
|
15
|
+
export * from './extraction/semantic-diagnostics.js';
|
package/dist/index.js
CHANGED
|
@@ -10,3 +10,7 @@ export * from "./visualization/visualization.js";
|
|
|
10
10
|
export * from "./application/overlay.js";
|
|
11
11
|
export * from "./graph/rdf.js";
|
|
12
12
|
export * from "./extraction/providers.js";
|
|
13
|
+
export * from './application/hydration-plan.js';
|
|
14
|
+
export * from './application/cache-adoption.js';
|
|
15
|
+
export * from './application/hydration-failure.js';
|
|
16
|
+
export * from './extraction/semantic-diagnostics.js';
|
package/dist/interfaces/cli.js
CHANGED
|
@@ -15,6 +15,9 @@ import { FileSnapshotStore } from "../storage/storage.js";
|
|
|
15
15
|
import { diagnoseSetup } from "./doctor.js";
|
|
16
16
|
import { runInit } from "./init.js";
|
|
17
17
|
import { loadConfig } from "../configuration/config.js";
|
|
18
|
+
import { planHydration } from '../application/hydration-plan.js';
|
|
19
|
+
import { adoptSemanticCache } from '../application/cache-adoption.js';
|
|
20
|
+
import { SemanticHydrationError } from '../application/hydration-failure.js';
|
|
18
21
|
function valueAfter(args, name) {
|
|
19
22
|
const index = args.indexOf(name);
|
|
20
23
|
return index >= 0 ? args[index + 1] : undefined;
|
|
@@ -45,10 +48,41 @@ export function impactRequestFromArgs(args) {
|
|
|
45
48
|
continuation: valueAfter(args, '--continuation'),
|
|
46
49
|
};
|
|
47
50
|
}
|
|
51
|
+
function formatHydrationPlan(plan) {
|
|
52
|
+
const readiness = plan.issues.some((issue) => issue.severity === 'error')
|
|
53
|
+
? 'blocked' : plan.ready ? 'ready' : 'needs review';
|
|
54
|
+
const lines = [
|
|
55
|
+
`Hydration plan: ${plan.repositoryId}`,
|
|
56
|
+
`Commit: ${plan.commitSha} (ref ${plan.ref})`,
|
|
57
|
+
`Configuration: ${plan.configurationDigest}`,
|
|
58
|
+
`Scope: ${plan.scope.mode}, ${plan.scope.complete ? 'complete' : 'incomplete'}; head ${plan.scope.headName}`,
|
|
59
|
+
`Documents: ${plan.budgets.selectedDocuments}/${plan.budgets.maxDocuments}; ${plan.budgets.totalSourceBytes} bytes total; ${plan.budgets.maxSourceBytes} bytes maximum per document`,
|
|
60
|
+
`Expected cache reuse: ${plan.estimates.reusableArtifacts}; extractions: ${plan.estimates.extractions}; unknown cache entries: ${plan.estimates.unknownArtifacts}`,
|
|
61
|
+
`Source/cache/budget checks: ${readiness}`,
|
|
62
|
+
];
|
|
63
|
+
for (const document of plan.documents) {
|
|
64
|
+
lines.push(`- ${JSON.stringify(document.path)} [${document.sourceId}]: ${document.bytes} bytes, ${document.lines} lines; ${document.role}; source ${document.sourceAuthority}, extraction ${document.extractionReview}; cache ${document.cache.status}; selected by ${document.selectedBy.map((selector) => JSON.stringify(selector)).join(', ')}`);
|
|
65
|
+
}
|
|
66
|
+
for (const selection of plan.selections.filter((item) => item.status !== 'matched')) {
|
|
67
|
+
lines.push(`Selection ${JSON.stringify(selection.selector)}: ${selection.status}`);
|
|
68
|
+
}
|
|
69
|
+
for (const issue of plan.issues)
|
|
70
|
+
lines.push(`${issue.severity.toUpperCase()} [${issue.code}]: ${issue.message}`);
|
|
71
|
+
if (plan.scope.omittedDocuments.length) {
|
|
72
|
+
lines.push(`Documents omitted by scope limits: ${plan.scope.omittedDocuments.map((path) => JSON.stringify(path)).join(', ')}`);
|
|
73
|
+
}
|
|
74
|
+
if (plan.scope.ignoredSearchTerms)
|
|
75
|
+
lines.push(`Search terms omitted by scope limits: ${plan.scope.ignoredSearchTerms}`);
|
|
76
|
+
if (plan.excludedWorkingChanges.length) {
|
|
77
|
+
lines.push(`Working changes excluded: ${plan.excludedWorkingChanges.map((path) => JSON.stringify(path)).join(', ')}`);
|
|
78
|
+
}
|
|
79
|
+
lines.push(...plan.assumptions.map((assumption) => `Note: ${assumption}`));
|
|
80
|
+
return `${lines.join('\n')}\n`;
|
|
81
|
+
}
|
|
48
82
|
async function main() {
|
|
49
83
|
const args = process.argv.slice(2);
|
|
50
84
|
if (args.includes('--help') || !args.length) {
|
|
51
|
-
process.stdout.write('weftlet init|config show|config validate|doctor|hydrate|overlay|impact scan|sparql|validate|govern|visualize|diagnostics show|invariant check|clean-compare|ontology compile\nUse --config <file>; queries accept --snapshot <id>. impact scan accepts --changed-file, --capability, --max-facts, --max-depth, --continuation.\ninit [--yes] [--directory <project>] [--config <file>] [--repository-id <id>] [--code-root <path>] [--semantic-source <path>] [--evidence-root <path>] [--model <name>] [--no-gitignore]\nSource flags may be repeated. init never overwrites an existing config. See README.md for examples.\n');
|
|
85
|
+
process.stdout.write('weftlet init|config show|config validate|doctor|hydrate|cache adopt|overlay|impact scan|sparql|validate|govern|visualize|diagnostics show|invariant check|clean-compare|ontology compile\nUse --config <file>; queries accept --snapshot <id>. impact scan accepts --changed-file, --capability, --max-facts, --max-depth, --continuation.\nhydrate --plan [--json] [--ref <commit>] [--force-semantic] previews scope, cache and budgets without model calls or graph writes. Preview readiness is advisory and does not add a hydration gate.\nhydrate --json --quiet emits structured semantic failures on stderr with no progress lines; failure stdout stays empty. hydrate --plan maps opaque source IDs to local document paths.\ncache adopt --from-config <previous.json> [--config <current.json>] [--ref <commit>] [--dry-run] returns JSON and copies only validated compatible artifacts, without model calls or snapshot writes. --dry-run performs no cache writes. Agent configurations accept the same --owner-doc, --task and --capability selection as hydrate.\ninit [--yes] [--directory <project>] [--config <file>] [--repository-id <id>] [--code-root <path>] [--semantic-source <path>] [--evidence-root <path>] [--model <name>] [--no-gitignore]\nSource flags may be repeated. init never overwrites an existing config. See README.md for examples.\n');
|
|
52
86
|
return;
|
|
53
87
|
}
|
|
54
88
|
if (args[0] === 'init') {
|
|
@@ -81,10 +115,35 @@ async function main() {
|
|
|
81
115
|
return;
|
|
82
116
|
}
|
|
83
117
|
const configPath = valueAfter(args, '--config') ?? defaultConfigPath();
|
|
118
|
+
if (args[0] === 'cache') {
|
|
119
|
+
const fromConfigPath = valueAfter(args, '--from-config');
|
|
120
|
+
if (args[1] !== 'adopt' || !fromConfigPath || fromConfigPath.startsWith('--')) {
|
|
121
|
+
throw new Error('Usage: weftlet cache adopt --from-config <previous.json> [--config <current.json>] [--ref <commit>] [--dry-run]');
|
|
122
|
+
}
|
|
123
|
+
const result = await adoptSemanticCache(configPath, {
|
|
124
|
+
fromConfigPath, ref: valueAfter(args, '--ref') ?? 'HEAD', dryRun: args.includes('--dry-run'),
|
|
125
|
+
request: impactRequestFromArgs(args),
|
|
126
|
+
});
|
|
127
|
+
process.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
|
|
128
|
+
if (!result.ready)
|
|
129
|
+
process.exitCode = 1;
|
|
130
|
+
return;
|
|
131
|
+
}
|
|
84
132
|
if (args[0] === 'doctor') {
|
|
85
133
|
process.stdout.write(`${JSON.stringify(await diagnoseSetup(configPath), null, 2)}\n`);
|
|
86
134
|
return;
|
|
87
135
|
}
|
|
136
|
+
if (args[0] === 'hydrate' && args.includes('--plan')) {
|
|
137
|
+
const plan = await planHydration(configPath, {
|
|
138
|
+
ref: valueAfter(args, '--ref') ?? 'HEAD',
|
|
139
|
+
forceSemantic: args.includes('--force-semantic'),
|
|
140
|
+
request: impactRequestFromArgs(args),
|
|
141
|
+
});
|
|
142
|
+
process.stdout.write(args.includes('--json') ? `${JSON.stringify(plan, null, 2)}\n` : formatHydrationPlan(plan));
|
|
143
|
+
if (!plan.ready)
|
|
144
|
+
process.exitCode = 1;
|
|
145
|
+
return;
|
|
146
|
+
}
|
|
88
147
|
const application = await createContextGraphApplication(configPath);
|
|
89
148
|
const [command, subcommand] = args;
|
|
90
149
|
if (command === 'sparql' || command === 'validate') {
|
|
@@ -120,23 +179,29 @@ async function main() {
|
|
|
120
179
|
const controller = new AbortController();
|
|
121
180
|
const cancel = () => controller.abort();
|
|
122
181
|
process.once('SIGINT', cancel);
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
182
|
+
try {
|
|
183
|
+
const ref = valueAfter(args, '--ref') ?? 'HEAD';
|
|
184
|
+
const scope = await application.scopeResolver?.resolve(impactRequestFromArgs(args), ref);
|
|
185
|
+
const result = await application.hydrator.hydrate({
|
|
186
|
+
ref: scope?.commitSha ?? ref,
|
|
187
|
+
headName: scope?.headName ?? application.headName,
|
|
188
|
+
semanticSources: scope?.semanticSources,
|
|
189
|
+
forceSemantic: args.includes('--force-semantic'),
|
|
190
|
+
signal: controller.signal,
|
|
191
|
+
onProgress: args.includes('--quiet') ? undefined : (event) => process.stderr.write(`[context-graph] ${event.phase}${event.total === undefined ? '' : ` ${event.completed}/${event.total}`}` +
|
|
192
|
+
`${event.sourceId === undefined ? '' : ` ${event.sourceId}`}${event.elapsedMs === undefined ? '' : ` ${event.elapsedMs} ms`}\n`),
|
|
193
|
+
});
|
|
194
|
+
process.stdout.write(`${JSON.stringify({
|
|
195
|
+
snapshotId: result.snapshot.manifest.snapshotId,
|
|
196
|
+
commitSha: result.snapshot.manifest.commitSha,
|
|
197
|
+
contentDigest: result.snapshot.manifest.contentDigest,
|
|
198
|
+
semanticExtracted: result.semanticExtracted,
|
|
199
|
+
semanticReused: result.semanticReused,
|
|
200
|
+
}, null, 2)}\n`);
|
|
201
|
+
}
|
|
202
|
+
finally {
|
|
203
|
+
process.removeListener('SIGINT', cancel);
|
|
204
|
+
}
|
|
140
205
|
return;
|
|
141
206
|
}
|
|
142
207
|
if (command === 'clean-compare') {
|
|
@@ -192,6 +257,8 @@ async function main() {
|
|
|
192
257
|
throw new Error('Usage: weftlet hydrate|clean-compare|impact scan|diagnostics show --snapshot <id>|invariant check|ontology compile|visualize --output <file.html|file.dot|file.svg>');
|
|
193
258
|
}
|
|
194
259
|
main().catch((error) => {
|
|
195
|
-
process.stderr.write(`${error instanceof
|
|
260
|
+
process.stderr.write(`${error instanceof SemanticHydrationError
|
|
261
|
+
? process.argv.includes('--json') ? JSON.stringify(error.report, null, 2) : error.message
|
|
262
|
+
: error instanceof Error ? (error.stack ?? error.message) : String(error)}\n`);
|
|
196
263
|
process.exitCode = 1;
|
|
197
264
|
});
|
package/dist/repository/git.d.ts
CHANGED
|
@@ -22,5 +22,5 @@ export declare class GitRepository {
|
|
|
22
22
|
readFileAt(commitSha: string, path: string): Promise<string>;
|
|
23
23
|
findTextAt(commitSha: string, needles: readonly string[], roots: readonly string[]): Promise<readonly GitTextMatch[]>;
|
|
24
24
|
delta(baseSha: string | undefined, headSha: string, roots: readonly string[]): Promise<GitDelta>;
|
|
25
|
-
semanticSources(context: ExtractionContext, roots: readonly string[]): Promise<readonly SemanticSource[]>;
|
|
25
|
+
semanticSources(context: Pick<ExtractionContext, 'commitSha'>, roots: readonly string[]): Promise<readonly SemanticSource[]>;
|
|
26
26
|
}
|
package/dist/repository/git.js
CHANGED
|
@@ -26,7 +26,7 @@ export class GitRepository {
|
|
|
26
26
|
}
|
|
27
27
|
async workingChanges() {
|
|
28
28
|
const prefix = await this.run(['rev-parse', '--show-prefix']);
|
|
29
|
-
const output = await this.execute(['status', '--porcelain=v1', '-z', '--untracked-files=all'], false);
|
|
29
|
+
const output = await this.execute(['--no-optional-locks', 'status', '--porcelain=v1', '-z', '--untracked-files=all'], false);
|
|
30
30
|
const records = output.split('\0');
|
|
31
31
|
const paths = new Set();
|
|
32
32
|
for (let index = 0; index < records.length; index++) {
|
|
@@ -65,6 +65,8 @@ export class GitRepository {
|
|
|
65
65
|
}
|
|
66
66
|
}
|
|
67
67
|
async listFilesAt(commitSha, roots) {
|
|
68
|
+
if (roots.length === 0)
|
|
69
|
+
return [];
|
|
68
70
|
const output = await this.run(['ls-tree', '-r', '--name-only', commitSha, '--', ...roots]);
|
|
69
71
|
return output.split('\n').filter(Boolean).sort();
|
|
70
72
|
}
|
|
@@ -107,6 +109,8 @@ export class GitRepository {
|
|
|
107
109
|
return [...matches.values()].sort((left, right) => left.path.localeCompare(right.path));
|
|
108
110
|
}
|
|
109
111
|
async delta(baseSha, headSha, roots) {
|
|
112
|
+
if (roots.length === 0)
|
|
113
|
+
return { changedPaths: [], deletedPaths: [], renamedPaths: {} };
|
|
110
114
|
if (!baseSha) {
|
|
111
115
|
return {
|
|
112
116
|
changedPaths: await this.listFilesAt(headSha, roots),
|
|
@@ -9,7 +9,13 @@ export declare class FileSnapshotStore implements SnapshotStore {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class SemanticArtifactStore {
|
|
11
11
|
private readonly root;
|
|
12
|
-
|
|
12
|
+
private readonly legacyRoots;
|
|
13
|
+
constructor(root: string, legacyRoots?: readonly string[]);
|
|
13
14
|
read(key: string): Promise<SemanticArtifact | undefined>;
|
|
15
|
+
/** Only explicitly supplied roots are consulted; never enumerate other consumers' profiles. */
|
|
16
|
+
readEntry(key: string): Promise<{
|
|
17
|
+
artifact: SemanticArtifact;
|
|
18
|
+
origin: 'primary' | 'legacy';
|
|
19
|
+
} | undefined>;
|
|
14
20
|
write(artifact: SemanticArtifact): Promise<void>;
|
|
15
21
|
}
|
package/dist/storage/storage.js
CHANGED
|
@@ -87,11 +87,23 @@ export class FileSnapshotStore {
|
|
|
87
87
|
}
|
|
88
88
|
export class SemanticArtifactStore {
|
|
89
89
|
root;
|
|
90
|
-
|
|
90
|
+
legacyRoots;
|
|
91
|
+
constructor(root, legacyRoots = []) {
|
|
91
92
|
this.root = root;
|
|
93
|
+
this.legacyRoots = legacyRoots;
|
|
94
|
+
}
|
|
95
|
+
async read(key) {
|
|
96
|
+
return (await this.readEntry(key))?.artifact;
|
|
92
97
|
}
|
|
93
|
-
|
|
94
|
-
|
|
98
|
+
/** Only explicitly supplied roots are consulted; never enumerate other consumers' profiles. */
|
|
99
|
+
async readEntry(key) {
|
|
100
|
+
const filename = `${safeKey(key)}.json`;
|
|
101
|
+
for (const [index, root] of [this.root, ...this.legacyRoots].entries()) {
|
|
102
|
+
const artifact = await readJson(join(root, 'artifacts', 'semantic', filename));
|
|
103
|
+
if (artifact !== undefined)
|
|
104
|
+
return { artifact, origin: index === 0 ? 'primary' : 'legacy' };
|
|
105
|
+
}
|
|
106
|
+
return undefined;
|
|
95
107
|
}
|
|
96
108
|
async write(artifact) {
|
|
97
109
|
const path = join(this.root, 'artifacts', 'semantic', `${safeKey(artifact.key)}.json`);
|
|
@@ -394,6 +394,7 @@ export function renderContextPackHtml(pack, sourceUrlTemplate) {
|
|
|
394
394
|
<strong>${pack.snapshot.overlayDigest ? 'DRAFT overlay' : pack.evidenceState?.stale ? 'HISTORICAL evidence' : pack.evidenceState ? 'Saved evidence at current commit' : 'Saved evidence — current checkout not assessed'}</strong>
|
|
395
395
|
<p>Configuration: ${escapeXml(pack.snapshot.configurationDigest ?? 'unknown')}; ${pack.evidenceState ? (pack.evidenceState.configurationMatches ? 'matches current configuration' : 'configuration mismatch') : 'configuration match unknown'}.
|
|
396
396
|
Scope: ${escapeXml(pack.snapshot.scope?.join(', ') ?? 'unknown')}.
|
|
397
|
+
Extraction compatibility: ${pack.evidenceState?.extractionCompatible === undefined ? 'not assessed' : pack.evidenceState.extractionCompatible ? 'current' : `refresh required (${escapeXml(pack.evidenceState.incompatibleExtractors?.join(', ') ?? 'unknown versions')})`}.
|
|
397
398
|
Excluded working paths: ${pack.evidenceState?.excludedWorkingChanges.length ?? 'unknown'}.
|
|
398
399
|
${pack.snapshot.overlayDigest ? `Overlay freshness: ${escapeXml(pack.evidenceState?.overlayFreshness ?? 'unknown')}.` : ''}
|
|
399
400
|
This view does not validate the current diff.</p>
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# ADR-016: Read-only hydration planning
|
|
2
|
+
|
|
3
|
+
Status: accepted and implemented in 0.3.0; absent from 0.2.1.
|
|
4
|
+
See [validation](VALIDATION.md) for recorded publication evidence.
|
|
5
|
+
|
|
6
|
+
## Problem
|
|
7
|
+
|
|
8
|
+
Consumers need to inspect document selection, extraction work and configured limits before
|
|
9
|
+
invoking a model. Constructing the execution application is unsuitable for that preview because
|
|
10
|
+
it loads configured repository adapters. Independently calculating source selection or cache keys
|
|
11
|
+
would also allow the preview to disagree with hydration.
|
|
12
|
+
|
|
13
|
+
## Decision
|
|
14
|
+
|
|
15
|
+
Provide `hydrate --plan` with a human summary and `hydrate --plan --json` with a structured
|
|
16
|
+
`hydration-plan` record. The public `planHydration(configPath, options)` function uses the same
|
|
17
|
+
planner. `--ref` resolves once to a commit SHA, including for agent scope. Configuration and
|
|
18
|
+
artifact storage are read from the current local environment, and the plan reports excluded
|
|
19
|
+
working changes rather than using their bytes as committed evidence.
|
|
20
|
+
|
|
21
|
+
The planner reads configuration, committed Git objects and existing semantic artifacts. It never
|
|
22
|
+
constructs an execution application or loads a configured provider/adapter. It does not probe
|
|
23
|
+
credentials, index TypeScript, collect runtime evidence, compile ontology artifacts, validate RDF,
|
|
24
|
+
publish snapshots or create cache directories. Git status disables optional locks so the preview
|
|
25
|
+
does not refresh the index. Source bodies and raw model output are not included in the result.
|
|
26
|
+
|
|
27
|
+
Committed source selection, duplicate semantic-ID checks and budget assessment are shared with
|
|
28
|
+
hydration. Provider identity and semantic artifact keys are pure functions shared with execution.
|
|
29
|
+
Per-source entries identify exact path/content digest, stable semantic identity, inclusion selectors,
|
|
30
|
+
line and UTF-8 byte counts, configured evidence role and matched source-approval patterns.
|
|
31
|
+
|
|
32
|
+
Classification follows configuration, not an inference about prose meaning. `sourceAuthority`
|
|
33
|
+
can be declared by an approved path while `extractionReview` remains unreviewed. A source matching
|
|
34
|
+
`evidenceRoots` is labeled validation evidence, but selecting it still schedules semantic extraction.
|
|
35
|
+
Recursive SOT traversal and default separation of validation documents belong to T07.
|
|
36
|
+
|
|
37
|
+
## Cache and readiness semantics
|
|
38
|
+
|
|
39
|
+
Cache inspection distinguishes these states without modifying evidence:
|
|
40
|
+
|
|
41
|
+
| State | Planned meaning |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| `hit` | Readable artifact matches source identity/content, extraction contract, structure and output digest |
|
|
44
|
+
| `miss` | No artifact exists for the current key; extraction is expected |
|
|
45
|
+
| `forced` | Explicit force requests fresh extraction; no forced key or artifact is created by planning |
|
|
46
|
+
| `corrupt` | Stored JSON, identity, structure or content digest is invalid; reuse is not claimed |
|
|
47
|
+
| `unavailable` | The artifact could not be read; its reuse state is unknown |
|
|
48
|
+
|
|
49
|
+
Corrupt/unavailable entries are not ordinary misses and are never silently repaired or overwritten.
|
|
50
|
+
An artifact can remain reusable after a source rename or a different commit with unchanged content;
|
|
51
|
+
its original path/commit need not equal the current path/commit. Hydration rebinds current provenance.
|
|
52
|
+
The preview's estimate is conditional on unchanged inputs and storage state, not a guarantee against
|
|
53
|
+
concurrent changes or a successful provider run.
|
|
54
|
+
|
|
55
|
+
Limits apply to every selected document, including cache hits: `maxDocuments` bounds the document
|
|
56
|
+
count and `maxSourceBytes` bounds each document's UTF-8 bytes. Total source bytes are reported but
|
|
57
|
+
are not a token or monetary budget. Selection is never trimmed to make these limits pass.
|
|
58
|
+
|
|
59
|
+
Budget, duplicate-ID and cache errors produce a blocked plan. Missing/no-document selectors and
|
|
60
|
+
omissions from existing bounded agent selection produce warnings and an incomplete scope that
|
|
61
|
+
needs review. Both yield `ready: false` and CLI exit 1, while retaining the full plan. `ready: true`
|
|
62
|
+
and exit 0 mean only that these planning checks passed; execution prerequisites and product-intent
|
|
63
|
+
completeness have not been established.
|
|
64
|
+
|
|
65
|
+
Warnings do not create new hard hydration gates. Existing hydration behavior can still publish a
|
|
66
|
+
new graph after deleting the last selected document, removing its old relationships. The preview
|
|
67
|
+
exposes that empty match for review. An explicitly empty source list is complete and selects none.
|
|
68
|
+
|
|
69
|
+
## Compatibility
|
|
70
|
+
|
|
71
|
+
The shared key/output-digest implementation preserves the released 0.2.1 semantic artifact contract,
|
|
72
|
+
including document identity-policy invalidation. Valid existing artifacts remain reusable; no
|
|
73
|
+
semantic re-extraction is required merely by this refactor. Operational configuration changes can
|
|
74
|
+
still affect cache identity/storage profiles; that is separate T03 work.
|
|
75
|
+
|
|
76
|
+
The empty-source fix changes graph assembly behavior: empty roots previously could enumerate all
|
|
77
|
+
repository documents. Assembly advances to `graph-v6` so corrected snapshots cannot collide with
|
|
78
|
+
immutable older snapshots at the same commit/configuration. Old snapshots remain readable and
|
|
79
|
+
unchanged. The requested ref also controls agent source selection instead of always using HEAD.
|
|
80
|
+
|
|
81
|
+
## Validation and next work
|
|
82
|
+
|
|
83
|
+
Public regressions cover committed and dirty inputs, unchanged index/files, absent or side-effecting
|
|
84
|
+
provider/adapter modules, empty scope, warm/cold/forced cache, malformed and unreadable artifacts,
|
|
85
|
+
released-key compatibility, budgets, duplicate IDs, missing selectors and historical agent scope
|
|
86
|
+
with explicit omissions. Existing rename/delete lifecycle checks remain applicable. Full validation
|
|
87
|
+
and release evidence are recorded separately in [VALIDATION.md](VALIDATION.md).
|
|
88
|
+
|
|
89
|
+
This increment makes no SHACL performance change. T05 will measure graph construction and full
|
|
90
|
+
validation before selecting caching, incremental validation or backend changes. See the
|
|
91
|
+
[1.0 plan](RELEASE-1.0-PLAN.md) for bounded follow-ups and the separate 2.0 platform direction.
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
# ADR-017: Validate a temporary RDF union without changing canonical evidence
|
|
2
|
+
|
|
3
|
+
Status: accepted and implemented in the focused 0.3.0 release; absent from 0.2.1.
|
|
4
|
+
See [validation](VALIDATION.md) for checks and recorded publication evidence.
|
|
5
|
+
|
|
6
|
+
## Problem and measured mechanism
|
|
7
|
+
|
|
8
|
+
The canonical RDF dataset has one named relationship graph per assertion, with assertion records,
|
|
9
|
+
node metadata and provenance in the default graph. The JavaScript `rdf-validate-shacl` validator
|
|
10
|
+
uses graph-wildcard dataset lookups through clownface. N3 indexes graphs first, so a lookup with
|
|
11
|
+
no graph restriction visits each graph before consulting its subject/predicate/object indexes.
|
|
12
|
+
Repeating those lookups for each focus node and shape property becomes expensive as assertion
|
|
13
|
+
graphs grow.
|
|
14
|
+
|
|
15
|
+
Bounded public experiments measured this cost in the current layout and compared an indexed union
|
|
16
|
+
using the same validator and shapes. They establish a synthetic scaling problem and a useful
|
|
17
|
+
optimization; they do not reproduce the private consumer's complete generation or diagnose its
|
|
18
|
+
reported 30-minute timeout. The consumer's total graph size and other phase costs remain unknown.
|
|
19
|
+
|
|
20
|
+
## Decision
|
|
21
|
+
|
|
22
|
+
For each `RdfEvidenceGraph.validate()` call, build a temporary single-default-graph N3 store from
|
|
23
|
+
every subject/predicate/object triple in the canonical dataset. Run the unchanged SHACL shapes
|
|
24
|
+
and validator on that store, and retain the existing explicit citation-order check. The canonical
|
|
25
|
+
named dataset remains unchanged and continues to serve SPARQL, fact projection and serialization.
|
|
26
|
+
|
|
27
|
+
This is still full-graph validation on every refresh. It introduces no GraphDB service, native/Rust
|
|
28
|
+
validator, incremental validation or validation-result cache. The short-lived union is not retained
|
|
29
|
+
as another persistent graph or used to replace canonical evidence.
|
|
30
|
+
|
|
31
|
+
RDF graphs are sets: identical SPO triples from multiple named graphs collapse in the validation
|
|
32
|
+
projection. The present shapes already use union lookups and node/value sets, and do not inspect
|
|
33
|
+
graph identity. Separate assertion records and their cited provenance remain intact in the original
|
|
34
|
+
dataset; no assertion, shape or constraint is removed. A future graph-sensitive shape requires an
|
|
35
|
+
explicit compatibility decision and new equivalence tests before using this projection.
|
|
36
|
+
|
|
37
|
+
## Bounded public measurements
|
|
38
|
+
|
|
39
|
+
Environment: Linux cloud workspace, Node 24.19.0, N3 2.7.2 and rdf-validate-shacl 0.6.5.
|
|
40
|
+
Each case ran once in a fresh child process with a 45-second hard deadline. The prototype copied
|
|
41
|
+
the same original dataset into a single graph only for validation; production-patch verification
|
|
42
|
+
is recorded separately in [VALIDATION.md](VALIDATION.md).
|
|
43
|
+
|
|
44
|
+
Fixtures contain public synthetic Workflow-to-Component assertions, cited metadata and one named
|
|
45
|
+
relationship graph per fact. Shared topology repeats 50 nodes; unique topology uses two distinct
|
|
46
|
+
nodes per fact. Timings below are seconds, with union construction separated from SHACL. RSS is
|
|
47
|
+
the process sample after validation, including Node, libraries and both datasets, not a measurement
|
|
48
|
+
of projection memory alone.
|
|
49
|
+
|
|
50
|
+
| Facts / topology | Original quads | Original SHACL | Union construction | Union SHACL | Union RSS MiB |
|
|
51
|
+
| --- | ---: | ---: | ---: | ---: | ---: |
|
|
52
|
+
| 1,000 shared | 20,203 | 3.889 | 0.061 | 0.239 | 352.3 |
|
|
53
|
+
| 2,000 shared | 40,203 | 19.550 | 0.102 | 0.410 | 440.0 |
|
|
54
|
+
| 1,000 unique | 28,003 | 5.731 | 0.104 | 0.308 | 352.6 |
|
|
55
|
+
| 2,000 unique | 56,003 | 31.502 | 0.153 | 0.467 | 457.9 |
|
|
56
|
+
| 5,000 shared | 100,203 | No verdict before process deadline | 0.251 | 1.131 | 825.5 |
|
|
57
|
+
| 10,000 unique | 280,003 | Not measured | 0.779 | 2.119 | 1,287.3 |
|
|
58
|
+
|
|
59
|
+
The 5,000-fact original-mode process was terminated after 45.051 seconds total elapsed time,
|
|
60
|
+
including startup and construction. It produced no SHACL verdict; this is not an inferred
|
|
61
|
+
completed validation duration. For the 10,000-fact unique union case, initial canonical graph
|
|
62
|
+
construction took 1.058 seconds in addition to the times shown. Its roughly 1.3 GiB RSS is a
|
|
63
|
+
material memory cost and should be measured on larger or different workloads.
|
|
64
|
+
|
|
65
|
+
These single runs are not statistical latency estimates or production guarantees. The experiment
|
|
66
|
+
does not measure semantic extraction, SCIP, SPARQL, serialization, snapshot publication or disk
|
|
67
|
+
storage. No private consumer data or live provider calls were used. The repository benchmark
|
|
68
|
+
`pnpm benchmark:shacl` reproduces bounded public comparisons using the current build; retain its
|
|
69
|
+
configuration, versions and raw output when comparing results.
|
|
70
|
+
|
|
71
|
+
## Correctness and compatibility
|
|
72
|
+
|
|
73
|
+
The prototype compared sorted conformance issues between the original and union paths across
|
|
74
|
+
valid repeated relationships/attributes, conflicting node kinds, out-of-range confidence, invalid
|
|
75
|
+
citations, empty citation paths, colliding assertion IDs and combined violations. All seven paired
|
|
76
|
+
cases agreed, and before/after serialization hashes preserved the canonical named dataset.
|
|
77
|
+
|
|
78
|
+
Production regressions must compare both paths for all supported constraints, including negative
|
|
79
|
+
cases, and preserve named-graph SPARQL results, fact projection, serialization and repeated calls.
|
|
80
|
+
Those checks establish parity for the current shapes, not arbitrary future SHACL rules. Failed
|
|
81
|
+
validation must continue to prevent publication and preserve the previous valid snapshot.
|
|
82
|
+
|
|
83
|
+
The optimization changes neither facts nor evidence authority and does not require a new semantic
|
|
84
|
+
cache identity. It does not make old evidence eligible for current-diff gates. Normal snapshot
|
|
85
|
+
commit, configuration, scope and provenance checks continue to apply.
|
|
86
|
+
|
|
87
|
+
## Release boundary and remaining T05 work
|
|
88
|
+
|
|
89
|
+
Ship the demonstrated cold-validation improvement after its independent review and required
|
|
90
|
+
validation, ahead of unrelated 1.0 work. A first graph cannot benefit from reusing a successful
|
|
91
|
+
validation result that does not yet exist. Private consumer acceptance remains pending after release.
|
|
92
|
+
|
|
93
|
+
Early identity checks, detailed progress/elapsed reporting, validation-result caching and safe
|
|
94
|
+
incremental validation remain open. The validator's main validation loop is synchronous; timers
|
|
95
|
+
on the same JavaScript thread cannot show a live heartbeat while it is blocked. Keep phase
|
|
96
|
+
boundaries honest and evaluate bounded worker execution before promising in-phase progress or
|
|
97
|
+
cancellation. Any later cached or incremental result must account for graph content, shapes,
|
|
98
|
+
validator/policy versions, deletions, affected relationships and global constraints, with full
|
|
99
|
+
validation when safe scope cannot be established.
|
|
100
|
+
|
|
101
|
+
Native engines and optional persistent database backends remain measurement-driven alternatives,
|
|
102
|
+
not prerequisites of this release. See the [1.0 task list](RELEASE-1.0-PLAN.md).
|