@canonical/pragma-cli 0.35.0 → 0.36.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 +2 -2
- package/bundled-skills/add-standard/SKILL.md +338 -0
- package/bundled-skills/adoption-a1-styles/SKILL.md +269 -0
- package/bundled-skills/adoption-a2-components/SKILL.md +291 -0
- package/bundled-skills/adoption-a3-forms/SKILL.md +260 -0
- package/bundled-skills/anatomy-author/ANATOMY_DSL_SPEC.md +406 -0
- package/bundled-skills/anatomy-author/SKILL.md +1226 -0
- package/bundled-skills/design-auditor/SKILL.md +455 -0
- package/bundled-skills/implement-component/SKILL.md +333 -0
- package/bundled-skills/specify-component/SKILL.md +331 -0
- package/bundled-skills/specify-pattern/SKILL.md +292 -0
- package/dist/package.json +16 -15
- package/dist/pragma.conf.js +236 -34
- package/dist/pragma.conf.js.map +1 -1
- package/dist/src/bin.js +1 -1
- package/dist/src/bin.js.map +1 -1
- package/dist/src/capabilities/colophon/colophon.render.js +1 -1
- package/dist/src/capabilities/colophon/colophon.render.js.map +1 -1
- package/dist/src/capabilities/create/mount.js +4 -3
- package/dist/src/capabilities/create/mount.js.map +1 -1
- package/dist/src/capabilities/doctor/checks/checkPackageRefs.js +60 -4
- package/dist/src/capabilities/doctor/checks/checkPackageRefs.js.map +1 -1
- package/dist/src/capabilities/doctor/checks/checkShellCompletions.js +8 -8
- package/dist/src/capabilities/doctor/checks/checkShellCompletions.js.map +1 -1
- package/dist/src/capabilities/doctor/checks/harnessInventory.js +195 -0
- package/dist/src/capabilities/doctor/checks/harnessInventory.js.map +1 -0
- package/dist/src/capabilities/doctor/checks/index.js +6 -6
- package/dist/src/capabilities/doctor/checks/targetHealth.js +194 -50
- package/dist/src/capabilities/doctor/checks/targetHealth.js.map +1 -1
- package/dist/src/capabilities/doctor/doctor.render.js +43 -64
- package/dist/src/capabilities/doctor/doctor.render.js.map +1 -1
- package/dist/src/capabilities/doctor/doctor.verb.js +6 -2
- package/dist/src/capabilities/doctor/doctor.verb.js.map +1 -1
- package/dist/src/capabilities/doctor/runChecks.js +14 -11
- package/dist/src/capabilities/doctor/runChecks.js.map +1 -1
- package/dist/src/capabilities/graph/query.render.js +2 -2
- package/dist/src/capabilities/graph/query.render.js.map +1 -1
- package/dist/src/capabilities/info/collectInfo.js +8 -2
- package/dist/src/capabilities/info/collectInfo.js.map +1 -1
- package/dist/src/capabilities/info/info.render.js +6 -2
- package/dist/src/capabilities/info/info.render.js.map +1 -1
- package/dist/src/capabilities/prompt/prompt.render.js +2 -2
- package/dist/src/capabilities/prompt/prompt.render.js.map +1 -1
- package/dist/src/capabilities/setup/buildPlan.js +43 -39
- package/dist/src/capabilities/setup/buildPlan.js.map +1 -1
- package/dist/src/capabilities/setup/mode.js +2 -2
- package/dist/src/capabilities/setup/operations/index.js +4 -4
- package/dist/src/capabilities/setup/operations/index.js.map +1 -1
- package/dist/src/capabilities/setup/operations/setupGenerator.js +92 -45
- package/dist/src/capabilities/setup/operations/setupGenerator.js.map +1 -1
- package/dist/src/capabilities/setup/operations/setupLsp.js +88 -36
- package/dist/src/capabilities/setup/operations/setupLsp.js.map +1 -1
- package/dist/src/capabilities/setup/operations/setupMcp.js +97 -51
- package/dist/src/capabilities/setup/operations/setupMcp.js.map +1 -1
- package/dist/src/capabilities/setup/operations/setupSkills.js +325 -47
- package/dist/src/capabilities/setup/operations/setupSkills.js.map +1 -1
- package/dist/src/capabilities/setup/plan.js.map +1 -1
- package/dist/src/capabilities/setup/plan.render.js +144 -66
- package/dist/src/capabilities/setup/plan.render.js.map +1 -1
- package/dist/src/capabilities/setup/setup.render.js +1 -1
- package/dist/src/capabilities/setup/setup.verb.js +86 -33
- package/dist/src/capabilities/setup/setup.verb.js.map +1 -1
- package/dist/src/capabilities/setup/targets.js +110 -45
- package/dist/src/capabilities/setup/targets.js.map +1 -1
- package/dist/src/capabilities/shared/index.js +6 -5
- package/dist/src/capabilities/shared/index.js.map +1 -1
- package/dist/src/capabilities/shared/packageManager.js +300 -54
- package/dist/src/capabilities/shared/packageManager.js.map +1 -1
- package/dist/src/capabilities/skill/discover.js +97 -11
- package/dist/src/capabilities/skill/discover.js.map +1 -1
- package/dist/src/capabilities/skill/render.js +2 -2
- package/dist/src/capabilities/skill/render.js.map +1 -1
- package/dist/src/capabilities/sources/installSkills.js +145 -3
- package/dist/src/capabilities/sources/installSkills.js.map +1 -1
- package/dist/src/capabilities/sources/runUpdate.js +68 -2
- package/dist/src/capabilities/sources/runUpdate.js.map +1 -1
- package/dist/src/capabilities/sources/update.verb.js +3 -3
- package/dist/src/capabilities/sources/update.verb.js.map +1 -1
- package/dist/src/capabilities/upgrade/runUpgrade.js +43 -7
- package/dist/src/capabilities/upgrade/runUpgrade.js.map +1 -1
- package/dist/src/capabilities/upgrade/upgrade.render.js +10 -2
- package/dist/src/capabilities/upgrade/upgrade.render.js.map +1 -1
- package/dist/src/constants.js +6 -1
- package/dist/src/constants.js.map +1 -1
- package/dist/src/kernel/index.js +11 -2
- package/dist/src/kernel/index.js.map +1 -1
- package/dist/src/kernel/interactivity.js +68 -0
- package/dist/src/kernel/interactivity.js.map +1 -0
- package/dist/src/kernel/packs/renderPack.js +3 -3
- package/dist/src/kernel/packs/renderPack.js.map +1 -1
- package/dist/src/kernel/packs/resolveEntity.js +63 -12
- package/dist/src/kernel/packs/resolveEntity.js.map +1 -1
- package/dist/src/kernel/packs/runBodies.js +57 -4
- package/dist/src/kernel/packs/runBodies.js.map +1 -1
- package/dist/src/kernel/packs/schema.js +54 -2
- package/dist/src/kernel/packs/schema.js.map +1 -1
- package/dist/src/kernel/packs/sparql/applyFilters.js +104 -5
- package/dist/src/kernel/packs/sparql/applyFilters.js.map +1 -1
- package/dist/src/kernel/packs/sparql/buildLookupQuery.js +306 -43
- package/dist/src/kernel/packs/sparql/buildLookupQuery.js.map +1 -1
- package/dist/src/kernel/packs/types.js.map +1 -1
- package/dist/src/kernel/project/cli/buildProgram.js +1 -1
- package/dist/src/kernel/project/cli/buildProgram.js.map +1 -1
- package/dist/src/kernel/project/cli/dispatch.js +23 -23
- package/dist/src/kernel/project/cli/dispatch.js.map +1 -1
- package/dist/src/kernel/project/cli/globalFlags.js +4 -1
- package/dist/src/kernel/project/cli/globalFlags.js.map +1 -1
- package/dist/src/kernel/project/cli/helpFormat.js +1 -2
- package/dist/src/kernel/project/cli/helpFormat.js.map +1 -1
- package/dist/src/kernel/project/cli/rootHelp.js +34 -4
- package/dist/src/kernel/project/cli/rootHelp.js.map +1 -1
- package/dist/src/kernel/project/mcp/registerVerb.js +16 -1
- package/dist/src/kernel/project/mcp/registerVerb.js.map +1 -1
- package/dist/src/kernel/render/renderers.js +1 -1
- package/dist/src/kernel/render/style.js +29 -9
- package/dist/src/kernel/render/style.js.map +1 -1
- package/dist/src/kernel/render/vocabulary.js +174 -0
- package/dist/src/kernel/render/vocabulary.js.map +1 -0
- package/dist/src/kernel/spec/emitReference.js +1 -1
- package/dist/src/kernel/spec/emitReference.js.map +1 -1
- package/package.json +16 -15
- package/pragma.conf.ts +241 -34
- package/src/bin.ts +8 -1
- package/src/capabilities/block.parity.test.ts +25 -11
- package/src/capabilities/block.shipped.exec.test.ts +282 -0
- package/src/capabilities/block.tierRank.exec.test.ts +300 -0
- package/src/capabilities/colophon/colophon.render.ts +1 -2
- package/src/capabilities/colophon/colophon.test.ts +2 -2
- package/src/capabilities/create/createGrammar.test.ts +1 -1
- package/src/capabilities/create/mount.ts +3 -3
- package/src/capabilities/distribution.parity.test.ts +4 -0
- package/src/capabilities/doctor/checks/checkPackageRefs.ts +69 -4
- package/src/capabilities/doctor/checks/checkShellCompletions.test.ts +6 -4
- package/src/capabilities/doctor/checks/checkShellCompletions.ts +8 -8
- package/src/capabilities/doctor/checks/harnessInventory.test.ts +219 -0
- package/src/capabilities/doctor/checks/harnessInventory.ts +298 -0
- package/src/capabilities/doctor/checks/index.ts +6 -6
- package/src/capabilities/doctor/checks/targetHealth.ts +229 -59
- package/src/capabilities/doctor/doctor.render.test.ts +108 -32
- package/src/capabilities/doctor/doctor.render.ts +56 -80
- package/src/capabilities/doctor/doctor.test.ts +247 -35
- package/src/capabilities/doctor/doctor.verb.ts +7 -2
- package/src/capabilities/doctor/runChecks.ts +14 -11
- package/src/capabilities/doctor/types.ts +15 -24
- package/src/capabilities/emptyRecovery.test.ts +10 -2
- package/src/capabilities/graph/query.render.ts +2 -2
- package/src/capabilities/info/collectInfo.ts +8 -1
- package/src/capabilities/info/info.render.ts +6 -2
- package/src/capabilities/info/info.test.ts +37 -1
- package/src/capabilities/info/types.ts +10 -2
- package/src/capabilities/prompt/prompt.render.ts +2 -2
- package/src/capabilities/renderVocabularySync.test.ts +82 -0
- package/src/capabilities/scopeTypeSync.test.ts +29 -15
- package/src/capabilities/setup/buildPlan.ts +45 -41
- package/src/capabilities/setup/index.ts +1 -1
- package/src/capabilities/setup/mode.ts +2 -2
- package/src/capabilities/setup/operations/index.ts +6 -1
- package/src/capabilities/setup/operations/setupGenerator.ts +144 -70
- package/src/capabilities/setup/operations/setupLsp.ts +129 -37
- package/src/capabilities/setup/operations/setupMcp.ts +132 -61
- package/src/capabilities/setup/operations/setupSkills.ts +392 -58
- package/src/capabilities/setup/plan.render.ts +171 -76
- package/src/capabilities/setup/plan.ts +17 -12
- package/src/capabilities/setup/setup.mcp.correctness.test.ts +9 -9
- package/src/capabilities/setup/setup.render.test.ts +50 -36
- package/src/capabilities/setup/setup.render.ts +1 -1
- package/src/capabilities/setup/setup.test.ts +881 -50
- package/src/capabilities/setup/setup.verb.ts +91 -33
- package/src/capabilities/setup/targets.ts +120 -52
- package/src/capabilities/setup/types.ts +10 -18
- package/src/capabilities/shared/index.ts +17 -6
- package/src/capabilities/shared/packageManager.test.ts +421 -6
- package/src/capabilities/shared/packageManager.ts +394 -59
- package/src/capabilities/skill/bundledSkills.test.ts +347 -0
- package/src/capabilities/skill/discover.ts +100 -11
- package/src/capabilities/skill/render.ts +2 -2
- package/src/capabilities/skill/skill.test.ts +17 -4
- package/src/capabilities/sources/installSkills.ts +181 -3
- package/src/capabilities/sources/runUpdate.ts +78 -2
- package/src/capabilities/sources/sources.test.ts +228 -0
- package/src/capabilities/sources/update.verb.ts +3 -3
- package/src/capabilities/surface.test.ts +2 -2
- package/src/capabilities/upgrade/runUpgrade.ts +45 -6
- package/src/capabilities/upgrade/types.ts +10 -2
- package/src/capabilities/upgrade/upgrade.render.ts +9 -2
- package/src/capabilities/upgrade/upgrade.test.ts +72 -0
- package/src/constants.ts +6 -1
- package/src/identity.test.ts +18 -5
- package/src/kernel/completion/entitySource.test.ts +15 -2
- package/src/kernel/completion/safety.test.ts +16 -9
- package/src/kernel/config/defaults.test.ts +2 -1
- package/src/kernel/index.ts +11 -2
- package/src/kernel/interactivity.test.ts +76 -0
- package/src/kernel/interactivity.ts +69 -0
- package/src/kernel/packs/compile.test.ts +92 -0
- package/src/kernel/packs/renderPack.ts +3 -3
- package/src/kernel/packs/resolveEntity.test.ts +75 -14
- package/src/kernel/packs/resolveEntity.ts +88 -24
- package/src/kernel/packs/runBodies.ts +84 -19
- package/src/kernel/packs/schema.ts +60 -4
- package/src/kernel/packs/sparql/applyFilters.ts +125 -4
- package/src/kernel/packs/sparql/buildLookupQuery.test.ts +290 -0
- package/src/kernel/packs/sparql/buildLookupQuery.ts +323 -45
- package/src/kernel/packs/toolDescription.test.ts +35 -1
- package/src/kernel/packs/types.ts +125 -2
- package/src/kernel/project/cli/buildProgram.test.ts +73 -2
- package/src/kernel/project/cli/buildProgram.ts +8 -1
- package/src/kernel/project/cli/dispatch.test.ts +5 -4
- package/src/kernel/project/cli/dispatch.ts +25 -24
- package/src/kernel/project/cli/globalFlags.ts +4 -1
- package/src/kernel/project/cli/helpFormat.ts +1 -2
- package/src/kernel/project/cli/rootHelp.ts +36 -3
- package/src/kernel/project/mcp/registerVerb.ts +20 -1
- package/src/kernel/render/renderers.ts +1 -1
- package/src/kernel/render/style.ts +32 -9
- package/src/kernel/render/vocabulary.ts +276 -0
- package/src/kernel/spec/emitReference.ts +1 -1
- package/src/kernel/spec/types.ts +35 -6
- package/src/testing/PARITY_GAPS.ts +9 -3
- package/src/testing/behavioral/docExamples.test.ts +4 -2
- package/src/testing/behavioral/errorMatrix.mcp.test.ts +110 -7
- package/src/testing/behavioral/journeys.firstInstall.test.ts +7 -2
- package/src/testing/behavioral/journeys.packageStories.test.ts +6 -3
- package/src/testing/eval/__snapshots__/eval.test.ts.snap +26 -1
- package/src/testing/eval/cases/readNouns.ts +245 -9
- package/src/testing/fixtures/blockGraph.ts +28 -13
- package/src/testing/fixtures/graph/canonical.ts +95 -12
- package/dist/src/capabilities/shared/bands.js +0 -16
- package/dist/src/capabilities/shared/bands.js.map +0 -1
- package/src/capabilities/shared/bands.ts +0 -16
|
@@ -5,15 +5,47 @@
|
|
|
5
5
|
* and which properties to read; the query text is generated here so
|
|
6
6
|
* user-supplied names are always escaped SPARQL string literals, and level-gated
|
|
7
7
|
* fields below the active level are excluded from the projection (fetch-gating).
|
|
8
|
-
* Matching on the
|
|
8
|
+
* Matching on the name is exact and case-insensitive.
|
|
9
9
|
*
|
|
10
|
-
*
|
|
11
|
-
*
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
10
|
+
* WHAT an entity's name IS lives in one place — {@link nameBinding} — and every
|
|
11
|
+
* form here uses it: the asserted `by` value, plus, for a lookup that DECLARES
|
|
12
|
+
* `nameFallback: "iri"`, the IRI-derived name its class constraint can vouch
|
|
13
|
+
* for. That single binding is what makes the population a `list` publishes and
|
|
14
|
+
* the population a `lookup` answers to the same population.
|
|
15
|
+
*
|
|
16
|
+
* A name-addressed resolve RANKS, and returns every row it ranked. A name can
|
|
17
|
+
* reach several entities (25 of the live design system's block names do), and
|
|
18
|
+
* the `LIMIT 1` that used to sit under the ordering discarded all but the first
|
|
19
|
+
* inside the STORE, where nothing downstream could see that it had happened —
|
|
20
|
+
* `block lookup button` answered with Launchpad's Button and gave no sign the
|
|
21
|
+
* global one existed, because `apps_launchpad…` sorts before `global…`.
|
|
22
|
+
*
|
|
23
|
+
* The limit is gone from the NAME forms so the resolver can see what it is
|
|
24
|
+
* choosing between. It still answers with one entity — the arity is the tool's
|
|
25
|
+
* contract — but the rows it did not take become the IRIs of its notice, which
|
|
26
|
+
* is the only address that reaches them. (An IRI-addressed form keeps its
|
|
27
|
+
* `LIMIT 1`: an IRI is one entity by construction, so there is nothing to rank
|
|
28
|
+
* and nothing set aside.)
|
|
29
|
+
*
|
|
30
|
+
* The losers are NOT free, and an earlier draft of this comment claimed they
|
|
31
|
+
* were. `lookupProjection`'s optionals sit in the same SELECT as the ranking, so
|
|
32
|
+
* every matching URI has its declared fields projected, and a multi-valued field
|
|
33
|
+
* multiplies rows per entity before `firstRowPerEntity` throws them away. On the
|
|
34
|
+
* live graph that is small — 25 shared names, two entities each — but it is a
|
|
35
|
+
* product, not a constant, and the honest shape is a two-phase resolve: rank the
|
|
36
|
+
* URIs in a minimal SELECT, then project fields for the ones actually answered
|
|
37
|
+
* with. That restructure is deliberately not done here: it is the same query the
|
|
38
|
+
* pending no-limit change would rewrite again, and doing it twice would land two
|
|
39
|
+
* migrations on one seam.
|
|
40
|
+
*
|
|
41
|
+
* The order is {@link rankingClause}'s `?score`, then `STR(?uri)`. The score
|
|
42
|
+
* multiplies the two things a pack may declare about which entity a bare name
|
|
43
|
+
* MEANS — `weights` (which KIND of thing) and `scopeWeight` (WHOSE) — and a
|
|
44
|
+
* story that declares neither falls through to `STR(?uri)` alone, a total,
|
|
45
|
+
* engine-independent order over a variable that is always bound (`?uri` carries
|
|
46
|
+
* the class constraint, or the `by` triple when the name is not derived), so it
|
|
47
|
+
* needs no unbound-value sentinel. That final key is what makes the ranking a
|
|
48
|
+
* TOTAL order rather than a better arbitrary one.
|
|
17
49
|
*/
|
|
18
50
|
|
|
19
51
|
import { activeExpands, activeFields } from "../disclosure.js";
|
|
@@ -43,11 +75,15 @@ function buildTypeConstraint(lookup: PackLookup): string {
|
|
|
43
75
|
* differ ONLY in how `?uri` is bound (a `FILTER` on the escaped name vs a `BIND`
|
|
44
76
|
* of the resolved IRI), so both thread the active level through here and gate
|
|
45
77
|
* identically — an IRI-addressed lookup honours `--detail` just like a name one.
|
|
78
|
+
*
|
|
79
|
+
* `constraint` and `optionals` are handed back SEPARATELY because the `?name`
|
|
80
|
+
* binding has to sit between them: it reads `?uri`, which the class constraint
|
|
81
|
+
* binds, and a SPARQL `BIND` may only name variables already in scope.
|
|
46
82
|
*/
|
|
47
83
|
function lookupProjection(
|
|
48
84
|
lookup: PackLookup,
|
|
49
85
|
level: string | undefined,
|
|
50
|
-
): { header: string;
|
|
86
|
+
): { header: string; constraint: string; optionals: string } {
|
|
51
87
|
const fields = activeFields(lookup, level);
|
|
52
88
|
const vars = fields.map((field) => `?${field.name}`).join(" ");
|
|
53
89
|
const optionals = fields
|
|
@@ -58,56 +94,286 @@ function lookupProjection(
|
|
|
58
94
|
.join("\n");
|
|
59
95
|
return {
|
|
60
96
|
header: `SELECT ?uri ?name${vars.length > 0 ? ` ${vars}` : ""} WHERE {`,
|
|
61
|
-
|
|
97
|
+
constraint: buildTypeConstraint(lookup).trimEnd(),
|
|
98
|
+
optionals,
|
|
62
99
|
};
|
|
63
100
|
}
|
|
64
101
|
|
|
65
102
|
/**
|
|
66
|
-
*
|
|
103
|
+
* The IRI-derived display name, in ONE spelling every relaxed form shares.
|
|
104
|
+
*
|
|
105
|
+
* The local name is everything after the last `#` or `/`, and its dot-separated
|
|
106
|
+
* hierarchy segments are published with slashes — `cs:react.component.props` →
|
|
107
|
+
* `react/component/props`. That is not an invention here: it is the derivation
|
|
108
|
+
* the `standard` list story already performs to PUBLISH a row's name, so this is
|
|
109
|
+
* the same rule read from the other side. Written once, so the name a list hands
|
|
110
|
+
* out and the name a lookup answers to cannot drift apart.
|
|
111
|
+
*/
|
|
112
|
+
const DERIVED_NAME = 'REPLACE(REPLACE(STR(?uri), "^.*[#/]", ""), "\\\\.", "/")';
|
|
113
|
+
|
|
114
|
+
/**
|
|
115
|
+
* The `?name` binding shared by every lookup form.
|
|
116
|
+
*
|
|
117
|
+
* By DEFAULT the `by` triple is required, and that is the honest default: `by`
|
|
118
|
+
* is documented as "the property whose value names the entity", so an entity
|
|
119
|
+
* without one has no name, is not addressable, and is not drawn by `sample`.
|
|
120
|
+
* It is also the one thing standing between a typo'd IRI and an empty entity.
|
|
121
|
+
*
|
|
122
|
+
* A story whose `list` SYNTHESIZES a name instead of reading one declares
|
|
123
|
+
* `nameFallback: "iri"`, and then the triple becomes OPTIONAL with
|
|
124
|
+
* {@link DERIVED_NAME} behind it. `standard` is the case that exists: 22 of the
|
|
125
|
+
* 156 live code standards carry a `cs:name`, and the code-standards ontology
|
|
126
|
+
* says so deliberately — it is "an optional human-readable display title" that
|
|
127
|
+
* "never participates in identity". `standard list` published
|
|
128
|
+
* `react/component/tsdoc` while `standard lookup react/component/tsdoc`
|
|
129
|
+
* answered ENTITY_NOT_FOUND with empty suggestions, because the only
|
|
130
|
+
* addressable population was the ~13% carrying an asserted name.
|
|
131
|
+
*
|
|
132
|
+
* INFERRING the fallback from the mere PRESENCE of a class constraint is what
|
|
133
|
+
* this option replaced, and it was over-reach in both directions of the same
|
|
134
|
+
* defect: `token list` requires `ds:tokenId`, so an inferred fallback made a
|
|
135
|
+
* `ds:Token` without one addressable and sampleable under a name `token list`
|
|
136
|
+
* never publishes. The declaration is per story because the list/lookup
|
|
137
|
+
* agreement is per story.
|
|
138
|
+
*
|
|
139
|
+
* The class constraint is still required for the fallback (the schema rejects
|
|
140
|
+
* the pairing, and this guard keeps a statically-compiled story from generating
|
|
141
|
+
* a query with nothing bounding `?uri`): a derived name is only as trustworthy
|
|
142
|
+
* as the class vouching for the entity it came from.
|
|
143
|
+
*
|
|
144
|
+
* One binding then serves the name resolve, the miss-suggestion pool, glob
|
|
145
|
+
* expansion and `sample`'s draw pool alike — every form that decides WHICH
|
|
146
|
+
* entities a name can reach. (The IRI-addressed forms reach an entity without
|
|
147
|
+
* going through a name at all: see {@link iriNameBinding}.)
|
|
148
|
+
*/
|
|
149
|
+
function nameBinding(lookup: PackLookup): string {
|
|
150
|
+
if (!derivesNames(lookup)) return ` ?uri ${formatTerm(lookup.by)} ?name .`;
|
|
151
|
+
return [
|
|
152
|
+
` OPTIONAL { ?uri ${formatTerm(lookup.by)} ?byName . }`,
|
|
153
|
+
` BIND(COALESCE(?byName, ${DERIVED_NAME}) AS ?name)`,
|
|
154
|
+
].join("\n");
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Whether this lookup names an entity that carries no `by` value.
|
|
159
|
+
*
|
|
160
|
+
* The class constraint is part of the condition, not merely a schema rule the
|
|
161
|
+
* builders trust: without one there is no triple bounding `?uri`, so a derived
|
|
162
|
+
* name would be scanned over the whole graph. The schema rejects the pairing
|
|
163
|
+
* for declared packs; this keeps a statically-compiled story from generating
|
|
164
|
+
* that query.
|
|
165
|
+
*/
|
|
166
|
+
function derivesNames(lookup: PackLookup): boolean {
|
|
167
|
+
return (
|
|
168
|
+
lookup.nameFallback === "iri" &&
|
|
169
|
+
Boolean(lookup.type ?? lookup.types?.length)
|
|
170
|
+
);
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* The `?name` binding for an IRI-ADDRESSED form.
|
|
175
|
+
*
|
|
176
|
+
* An IRI names the entity by itself, so here the `by` value is a LABEL to
|
|
177
|
+
* project, not the thing that identifies it — and the class constraint is
|
|
178
|
+
* already a sufficient existence check. So the triple is OPTIONAL wherever a
|
|
179
|
+
* class vouches for the entity, and `?name` is simply left unbound when there is
|
|
180
|
+
* no label; it is REQUIRED only for a lookup constraining no class, where it is
|
|
181
|
+
* the one thing standing between a typo'd IRI and an empty entity.
|
|
182
|
+
*
|
|
183
|
+
* A story that {@link derivesNames} gets the same COALESCE the name forms use,
|
|
184
|
+
* so an entity reached by IRI reports the name `list` published for it rather
|
|
185
|
+
* than a blank.
|
|
186
|
+
*/
|
|
187
|
+
function iriNameBinding(lookup: PackLookup): string {
|
|
188
|
+
if (derivesNames(lookup)) return nameBinding(lookup);
|
|
189
|
+
const named = `?uri ${formatTerm(lookup.by)} ?name .`;
|
|
190
|
+
const constrained = Boolean(lookup.type ?? lookup.types?.length);
|
|
191
|
+
return constrained ? ` OPTIONAL { ${named} }` : ` ${named}`;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Render a declared weight as a SPARQL numeric literal (never exponential).
|
|
196
|
+
*
|
|
197
|
+
* `toFixed` is the wrong instrument twice over, and both bite inside the 0–1
|
|
198
|
+
* range the schema allows. It ROUNDS — `0.1234567` became `0.123457`, silently
|
|
199
|
+
* altering a ranking a pack author declared — and stripping the trailing zeros
|
|
200
|
+
* off its output turns `0.0000001` into `0.`, which is not a numeric literal at
|
|
201
|
+
* all and makes the query a parse error rather than a wrong answer.
|
|
202
|
+
*
|
|
203
|
+
* `String` already prints the shortest exact round-trip, so it is the right
|
|
204
|
+
* source of digits; the only thing it does that SPARQL cannot read is
|
|
205
|
+
* exponent notation, which xsd:decimal's grammar has no form for. Expand that
|
|
206
|
+
* case and pass everything else through untouched.
|
|
207
|
+
*/
|
|
208
|
+
function sparqlNumber(value: number): string {
|
|
209
|
+
if (Number.isInteger(value)) return String(value);
|
|
210
|
+
const text = String(value);
|
|
211
|
+
const exponent = /e-(\d+)$/i.exec(text);
|
|
212
|
+
if (exponent === null) return text;
|
|
213
|
+
// `1e-7` / `1.5e-7`: the decimal places needed are the exponent plus whatever
|
|
214
|
+
// the mantissa already carried, which is exact — no rounding can occur.
|
|
215
|
+
const mantissaPlaces = text.split("e")[0]?.split(".")[1]?.length ?? 0;
|
|
216
|
+
return value.toFixed(Number(exponent[1]) + mantissaPlaces);
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* `left * right`, guarded where an operand may be ZERO.
|
|
221
|
+
*
|
|
222
|
+
* Not defensiveness — a MEASURED engine defect, and the top scope hits it every
|
|
223
|
+
* time. oxigraph raises on an xsd:decimal times a zero (`0.2 * 0` errors, while
|
|
224
|
+
* `0.2 * 1` is `0.2`), and a raising expression inside a `BIND` leaves its
|
|
225
|
+
* variable unbound. Written the arithmetic way, the depth-0 scope — the one that
|
|
226
|
+
* is supposed to WIN — is the only one whose weight never binds, and what
|
|
227
|
+
* happens next is decided by whatever the surrounding `COALESCE` falls back to.
|
|
228
|
+
* The same expression on the `block list` side fell back to 0 and sorted every
|
|
229
|
+
* top-tier row LAST, which is how this was found. Both sides now say what they
|
|
230
|
+
* mean. Only VARIABLE operands are tested; a declared literal is resolved at
|
|
231
|
+
* build time by the callers.
|
|
232
|
+
*/
|
|
233
|
+
function sparqlProduct(left: string, right: string): string {
|
|
234
|
+
const guards = [left, right]
|
|
235
|
+
.filter((operand) => operand.startsWith("?"))
|
|
236
|
+
.map((operand) => `${operand} = 0`);
|
|
237
|
+
const product = `${left} * ${right}`;
|
|
238
|
+
return guards.length === 0
|
|
239
|
+
? product
|
|
240
|
+
: `IF(${guards.join(" || ")}, 0, ${product})`;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
/**
|
|
244
|
+
* The type factor: the LOWEST weight declared for any class the entity belongs
|
|
245
|
+
* to, 1 when none is.
|
|
246
|
+
*
|
|
247
|
+
* An IF-ladder over `EXISTS` rather than a weight column on the class VALUES,
|
|
248
|
+
* because a join would multiply rows for an entity in two weighted classes and
|
|
249
|
+
* the resolve now returns every row it finds. Lowest weight tested FIRST, so the
|
|
250
|
+
* ladder means MIN — the same rule the MCP listing's `effectiveWeight` states in
|
|
251
|
+
* prose: a demotion any membership asks for is not cancelled by a membership
|
|
252
|
+
* that asked for nothing.
|
|
253
|
+
*/
|
|
254
|
+
function typeWeightBind(lookup: PackLookup): string {
|
|
255
|
+
const declared = Object.entries(lookup.weights ?? {});
|
|
256
|
+
if (declared.length === 0) return "";
|
|
257
|
+
const ladder = [...declared]
|
|
258
|
+
.sort(([aType, aWeight], [bType, bWeight]) =>
|
|
259
|
+
aWeight === bWeight ? aType.localeCompare(bType) : aWeight - bWeight,
|
|
260
|
+
)
|
|
261
|
+
.reduceRight(
|
|
262
|
+
(fallback, [type, weight]) =>
|
|
263
|
+
`IF(EXISTS { ?uri a ${formatTerm(type)} }, ${sparqlNumber(weight)}, ${fallback})`,
|
|
264
|
+
"1",
|
|
265
|
+
);
|
|
266
|
+
return ` BIND(${ladder} AS ?rankType)`;
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* The scope factor: how much the entity's containing scope is worth, DERIVED
|
|
271
|
+
* from the depth of that scope's own path-shaped name.
|
|
272
|
+
*
|
|
273
|
+
* Nested OPTIONALs, not a flat sequence: `?rankScope` is unbound for an entity
|
|
274
|
+
* outside any scope, and a following top-level `OPTIONAL { ?rankScope <by> ?n }`
|
|
275
|
+
* would then match every such triple in the graph and multiply the row.
|
|
276
|
+
*
|
|
277
|
+
* The depth is the separator count, so nothing is enumerated and a scope the
|
|
278
|
+
* ontology adds tomorrow inherits its place. `COALESCE` states the retirement
|
|
279
|
+
* path in the query itself: an ASSERTED weight wins, the derived one answers
|
|
280
|
+
* until there is one, and an entity with no scope at all scores a neutral 1
|
|
281
|
+
* rather than dropping below entities that have one.
|
|
282
|
+
*/
|
|
283
|
+
function scopeWeightBinds(lookup: PackLookup): string {
|
|
284
|
+
const scope = lookup.scopeWeight;
|
|
285
|
+
if (!scope) return "";
|
|
286
|
+
const name = "?rankScopeName";
|
|
287
|
+
const asserted = scope.asserted
|
|
288
|
+
? [
|
|
289
|
+
` OPTIONAL { ?rankScope ${formatTerm(scope.asserted)} ?rankAsserted . }`,
|
|
290
|
+
]
|
|
291
|
+
: [];
|
|
292
|
+
// A falloff of 0 ranks every scope alike, so the derived weight is the
|
|
293
|
+
// constant — and the depth it would multiply is never computed.
|
|
294
|
+
const derived =
|
|
295
|
+
scope.falloff === 0
|
|
296
|
+
? "1"
|
|
297
|
+
: `1 - ${sparqlProduct(sparqlNumber(scope.falloff), "?rankDepth")}`;
|
|
298
|
+
return [
|
|
299
|
+
" OPTIONAL {",
|
|
300
|
+
` ?uri ${formatTerm(scope.via)} ?rankScope .`,
|
|
301
|
+
` OPTIONAL { ?rankScope ${formatTerm(scope.by)} ${name} . }`,
|
|
302
|
+
...asserted,
|
|
303
|
+
" }",
|
|
304
|
+
` BIND(STRLEN(${name}) - STRLEN(REPLACE(${name}, "/", "")) AS ?rankDepth)`,
|
|
305
|
+
` BIND(${derived} AS ?rankDerived)`,
|
|
306
|
+
// Floored at 0: a scope deep enough to drive the factor negative would
|
|
307
|
+
// otherwise INVERT the type factor it multiplies, promoting a part of a
|
|
308
|
+
// block above a whole one.
|
|
309
|
+
` BIND(COALESCE(${scope.asserted ? "?rankAsserted, " : ""}IF(?rankDerived < 0, 0, ?rankDerived), 1) AS ?rankScopeWeight)`,
|
|
310
|
+
].join("\n");
|
|
311
|
+
}
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* The `?score` a name resolve orders by, and the ORDER BY that reads it.
|
|
315
|
+
*
|
|
316
|
+
* The two factors MULTIPLY rather than tiebreak, and that is the editorial
|
|
317
|
+
* ruling, not an implementation convenience: neither question subsumes the
|
|
318
|
+
* other. A whole component in a nested scope (1 × 0.8) outranks a mere PART of a
|
|
319
|
+
* block in the widest one (0.6 × 1), while two components of equal kind are
|
|
320
|
+
* separated by their scopes alone (1 × 1 beats 1 × 0.8). Both live cases fall
|
|
321
|
+
* out of one product.
|
|
322
|
+
*
|
|
323
|
+
* @returns The BIND lines to splice into the WHERE clause, and the ORDER BY
|
|
324
|
+
* line — a story declaring neither factor gets no BINDs and `STR(?uri)` alone.
|
|
325
|
+
*/
|
|
326
|
+
function rankingClause(lookup: PackLookup): {
|
|
327
|
+
binds: string;
|
|
328
|
+
orderBy: string;
|
|
329
|
+
} {
|
|
330
|
+
const factors = [typeWeightBind(lookup), scopeWeightBinds(lookup)].filter(
|
|
331
|
+
(line) => line !== "",
|
|
332
|
+
);
|
|
333
|
+
if (factors.length === 0) return { binds: "", orderBy: "ORDER BY STR(?uri)" };
|
|
334
|
+
const terms = [
|
|
335
|
+
lookup.weights && Object.keys(lookup.weights).length > 0 ? "?rankType" : "",
|
|
336
|
+
lookup.scopeWeight ? "?rankScopeWeight" : "",
|
|
337
|
+
].filter((term) => term !== "");
|
|
338
|
+
return {
|
|
339
|
+
binds: [
|
|
340
|
+
...factors,
|
|
341
|
+
` BIND(${terms.length === 2 ? sparqlProduct(terms[0] as string, terms[1] as string) : terms.join("")} AS ?score)`,
|
|
342
|
+
].join("\n"),
|
|
343
|
+
orderBy: "ORDER BY DESC(?score) STR(?uri)",
|
|
344
|
+
};
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
/**
|
|
348
|
+
* Build the SELECT retrieving the entities a name reaches, with their declared
|
|
349
|
+
* fields, best first. The caller answers with the first and names the rest.
|
|
67
350
|
*
|
|
68
351
|
* @param lookup - The pack's lookup declaration.
|
|
69
352
|
* @param name - User-supplied entity name (escaped here).
|
|
70
353
|
* @param level - Active canonical level; gated fields below it are excluded.
|
|
71
|
-
* @returns SPARQL SELECT text.
|
|
354
|
+
* @returns SPARQL SELECT text, ranked and unlimited.
|
|
72
355
|
*/
|
|
73
356
|
export function buildLookupQuery(
|
|
74
357
|
lookup: PackLookup,
|
|
75
358
|
name: string,
|
|
76
359
|
level?: string,
|
|
77
360
|
): string {
|
|
78
|
-
const { header,
|
|
361
|
+
const { header, constraint, optionals } = lookupProjection(lookup, level);
|
|
362
|
+
const ranking = rankingClause(lookup);
|
|
79
363
|
return [
|
|
80
364
|
header,
|
|
81
|
-
|
|
82
|
-
|
|
365
|
+
constraint,
|
|
366
|
+
nameBinding(lookup),
|
|
367
|
+
ranking.binds,
|
|
368
|
+
optionals,
|
|
83
369
|
` FILTER (LCASE(STR(?name)) = LCASE("${escapeSparqlString(name)}"))`,
|
|
84
370
|
"}",
|
|
85
|
-
|
|
86
|
-
"LIMIT 1",
|
|
371
|
+
ranking.orderBy,
|
|
87
372
|
]
|
|
88
373
|
.filter((line) => line !== "")
|
|
89
374
|
.join("\n");
|
|
90
375
|
}
|
|
91
376
|
|
|
92
|
-
/**
|
|
93
|
-
* The `?name` clause for an IRI-addressed form.
|
|
94
|
-
*
|
|
95
|
-
* An IRI names the entity by itself, so the `by` value is a LABEL to project,
|
|
96
|
-
* not the thing that identifies it — and a class constraint is already a
|
|
97
|
-
* sufficient existence check. Requiring the `by` triple here made every entity
|
|
98
|
-
* that carries no name unaddressable by any means at all: 131 of the 144 live
|
|
99
|
-
* code standards have no `cs:name` (their displayed name is synthesized from the
|
|
100
|
-
* IRI by the list story), and shell completion offers their IRIs. So the triple
|
|
101
|
-
* is OPTIONAL wherever a class constraint can vouch for the entity, and
|
|
102
|
-
* REQUIRED only for a lookup that declares no `type`/`types` — where it is the
|
|
103
|
-
* one thing standing between a typo'd IRI and an empty entity.
|
|
104
|
-
*/
|
|
105
|
-
function iriNameClause(lookup: PackLookup): string {
|
|
106
|
-
const named = `?uri ${formatTerm(lookup.by)} ?name .`;
|
|
107
|
-
const constrained = Boolean(lookup.type ?? lookup.types?.length);
|
|
108
|
-
return constrained ? ` OPTIONAL { ${named} }` : ` ${named}`;
|
|
109
|
-
}
|
|
110
|
-
|
|
111
377
|
/**
|
|
112
378
|
* Build the SELECT retrieving one entity addressed directly by IRI.
|
|
113
379
|
*
|
|
@@ -126,12 +392,13 @@ export function buildLookupByIriQuery(
|
|
|
126
392
|
iri: string,
|
|
127
393
|
level?: string,
|
|
128
394
|
): string {
|
|
129
|
-
const { header,
|
|
395
|
+
const { header, constraint, optionals } = lookupProjection(lookup, level);
|
|
130
396
|
return [
|
|
131
397
|
header,
|
|
132
398
|
` BIND(<${iri}> AS ?uri)`,
|
|
133
|
-
|
|
134
|
-
|
|
399
|
+
constraint,
|
|
400
|
+
iriNameBinding(lookup),
|
|
401
|
+
optionals,
|
|
135
402
|
"}",
|
|
136
403
|
"LIMIT 1",
|
|
137
404
|
]
|
|
@@ -142,21 +409,28 @@ export function buildLookupByIriQuery(
|
|
|
142
409
|
/**
|
|
143
410
|
* Build the minimal name→URI resolve for a graphql-sourced lookup (and the
|
|
144
411
|
* shared entry point for the sparql path's name form): maps the user-supplied
|
|
145
|
-
* name to the entity
|
|
412
|
+
* name to the entity IRIs, everything else comes from the field fetch. The name
|
|
146
413
|
* is an escaped literal; all terms are validated pack terms.
|
|
414
|
+
*
|
|
415
|
+
* Ranked and unlimited, exactly like {@link buildLookupQuery} — the two paths
|
|
416
|
+
* differ in where the VALUES come from, never in which entities a name reaches.
|
|
417
|
+
* `?score` is deliberately NOT projected: it orders the rows and is none of the
|
|
418
|
+
* caller's business, and projecting it would leak a ranking artefact into
|
|
419
|
+
* `--format json`.
|
|
147
420
|
*/
|
|
148
421
|
export function buildNameResolveQuery(
|
|
149
422
|
lookup: PackLookup,
|
|
150
423
|
name: string,
|
|
151
424
|
): string {
|
|
425
|
+
const ranking = rankingClause(lookup);
|
|
152
426
|
return [
|
|
153
427
|
"SELECT ?uri ?name WHERE {",
|
|
154
|
-
` ?uri ${formatTerm(lookup.by)} ?name .`,
|
|
155
428
|
buildTypeConstraint(lookup).trimEnd(),
|
|
429
|
+
nameBinding(lookup),
|
|
430
|
+
ranking.binds,
|
|
156
431
|
` FILTER (LCASE(STR(?name)) = LCASE("${escapeSparqlString(name)}"))`,
|
|
157
432
|
"}",
|
|
158
|
-
|
|
159
|
-
"LIMIT 1",
|
|
433
|
+
ranking.orderBy,
|
|
160
434
|
]
|
|
161
435
|
.filter((line) => line !== "")
|
|
162
436
|
.join("\n");
|
|
@@ -175,8 +449,8 @@ export function buildIriResolveQuery(lookup: PackLookup, iri: string): string {
|
|
|
175
449
|
return [
|
|
176
450
|
"SELECT ?uri ?name WHERE {",
|
|
177
451
|
` BIND(<${iri}> AS ?uri)`,
|
|
178
|
-
iriNameClause(lookup),
|
|
179
452
|
buildTypeConstraint(lookup).trimEnd(),
|
|
453
|
+
iriNameBinding(lookup),
|
|
180
454
|
"}",
|
|
181
455
|
"LIMIT 1",
|
|
182
456
|
]
|
|
@@ -239,8 +513,12 @@ export function buildLookupNamesQuery(lookup: PackLookup): string {
|
|
|
239
513
|
// `block lookup 'Butt*'` listed one Button twice while the other Button
|
|
240
514
|
// never appeared at all.
|
|
241
515
|
"SELECT DISTINCT ?name WHERE {",
|
|
242
|
-
` ?uri ${formatTerm(lookup.by)} ?name .`,
|
|
243
516
|
buildTypeConstraint(lookup).trimEnd(),
|
|
517
|
+
// Same {@link nameBinding} the resolves use, so the addressable population
|
|
518
|
+
// and the resolvable population are the same population. When they were
|
|
519
|
+
// not, a name a miss-suggestion offered could itself miss, and a glob
|
|
520
|
+
// expanded over a pool the resolve could not answer from.
|
|
521
|
+
nameBinding(lookup),
|
|
244
522
|
"}",
|
|
245
523
|
]
|
|
246
524
|
.filter((line) => line !== "")
|
|
@@ -68,7 +68,11 @@ describe("pack toolDescription wiring (PROTECTED)", () => {
|
|
|
68
68
|
(t) => t.name === "standard_categories",
|
|
69
69
|
)?.description;
|
|
70
70
|
await mcp.cleanup();
|
|
71
|
-
|
|
71
|
+
// The authored prose reaches the extra verb's tool, whole. Asserted by
|
|
72
|
+
// fragment rather than by exact string: the wiring is what this pins, and
|
|
73
|
+
// tool descriptions are explicitly not frozen (`registerVerb.ts:324-326`).
|
|
74
|
+
expect(desc).toContain("List all code standard categories");
|
|
75
|
+
expect(desc).toContain("Example: standard_categories {}");
|
|
72
76
|
});
|
|
73
77
|
|
|
74
78
|
it("CLI --help shows the rich prose but NEVER the MCP tool-call syntax", () => {
|
|
@@ -126,3 +130,33 @@ describe("a tool-call example names a parameter the tool ACCEPTS (PROTECTED)", (
|
|
|
126
130
|
}
|
|
127
131
|
});
|
|
128
132
|
});
|
|
133
|
+
|
|
134
|
+
describe("every story tool CARRIES a call example (PROTECTED)", () => {
|
|
135
|
+
// The check above only polices examples that exist. `standard` authored NONE,
|
|
136
|
+
// and the auto-generated one fires only for a filter declaring `values` —
|
|
137
|
+
// which the category filter deliberately does not, because the graph is the
|
|
138
|
+
// vocabulary. So the four `standard_*` tools shipped with no worked call at
|
|
139
|
+
// all, and the model that could not form one had nothing to copy.
|
|
140
|
+
//
|
|
141
|
+
// This asserts the gap cannot reappear on a future story: a compiled story
|
|
142
|
+
// tool must show an agent one call it can make, spelled with its OWN name so
|
|
143
|
+
// the example cannot be copied from a sibling tool and left stale.
|
|
144
|
+
it("names its own tool in an `Example: <tool_name> {…}` fragment", async () => {
|
|
145
|
+
const mcp = await projectMcp([...storyModules.values()]);
|
|
146
|
+
try {
|
|
147
|
+
const tools = await mcp.listTools();
|
|
148
|
+
expect(tools.length).toBeGreaterThan(0);
|
|
149
|
+
const missing = tools
|
|
150
|
+
.filter(
|
|
151
|
+
(tool) =>
|
|
152
|
+
!new RegExp(`Example:\\s*${tool.name}\\s*\\{`).test(
|
|
153
|
+
tool.description ?? "",
|
|
154
|
+
),
|
|
155
|
+
)
|
|
156
|
+
.map((tool) => tool.name);
|
|
157
|
+
expect(missing).toEqual([]);
|
|
158
|
+
} finally {
|
|
159
|
+
await mcp.cleanup();
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
});
|
|
@@ -150,10 +150,56 @@ export interface PackFilter {
|
|
|
150
150
|
* string matched case-insensitively against the variable).
|
|
151
151
|
*/
|
|
152
152
|
readonly values?: readonly string[];
|
|
153
|
+
/**
|
|
154
|
+
* How a provided value is compared to the row's cell.
|
|
155
|
+
*
|
|
156
|
+
* `"exact"` (the default) compares the whole cell. `"set"` reads the cell as
|
|
157
|
+
* a SPACE-SEPARATED set and matches when ANY member equals the provided
|
|
158
|
+
* value — the shape a `GROUP_CONCAT` produces, for a dimension where one row
|
|
159
|
+
* legitimately belongs to several values at once. The standing case is a
|
|
160
|
+
* hierarchy: a standard filed under `testing-unit` is, by the definition of
|
|
161
|
+
* the hierarchy, also a `testing` standard, and a filter that compared only
|
|
162
|
+
* the leaf answered `--category testing` with 1 of 8 — a silently wrong
|
|
163
|
+
* answer, exit 0.
|
|
164
|
+
*/
|
|
165
|
+
readonly match?: "exact" | "set";
|
|
166
|
+
/**
|
|
167
|
+
* Where the dimension's VOCABULARY lives in the graph, for a filter with no
|
|
168
|
+
* declared {@link values}.
|
|
169
|
+
*
|
|
170
|
+
* A value-free filter rejects a value the data does not carry. The question is
|
|
171
|
+
* what "the data" means. The rows a list just returned are the wrong answer:
|
|
172
|
+
* they are a POPULATION, and a value can be real while no row carries it — a
|
|
173
|
+
* category the graph declares with zero standards filed under it, a
|
|
174
|
+
* `ds:ConceptType` no concept uses yet. Validating against rows turns those
|
|
175
|
+
* into `INVALID_INPUT`, when the honest answer is a calm empty list.
|
|
176
|
+
*
|
|
177
|
+
* So the vocabulary is read from the graph directly, from the same terms the
|
|
178
|
+
* surface that ENUMERATES it reads (`standard categories` reads `cs:Category`
|
|
179
|
+
* / `cs:slug`; so does the `category` filter's vocabulary query). The ruling
|
|
180
|
+
* this honours is "the graph is the vocabulary, don't hard-code the slugs" —
|
|
181
|
+
* rows were never the graph, just the part of it that answered.
|
|
182
|
+
*
|
|
183
|
+
* Without it a value-free filter falls back to the observed rows, which is the
|
|
184
|
+
* only evidence available; that is a NARROWER vocabulary than the truth, and a
|
|
185
|
+
* story whose dimension has an authoritative source should declare it.
|
|
186
|
+
*/
|
|
187
|
+
readonly vocabulary?: PackFilterVocabulary;
|
|
153
188
|
/** Help text (defaults to a generated description). */
|
|
154
189
|
readonly description?: string;
|
|
155
190
|
}
|
|
156
191
|
|
|
192
|
+
/** The authoritative value set for a value-free {@link PackFilter}. */
|
|
193
|
+
export interface PackFilterVocabulary {
|
|
194
|
+
/** SPARQL SELECT producing one row per admissible value. */
|
|
195
|
+
readonly query: string;
|
|
196
|
+
/**
|
|
197
|
+
* SELECT variable carrying the value (without `?`). Defaults to the filter's
|
|
198
|
+
* own {@link PackFilter.variable}.
|
|
199
|
+
*/
|
|
200
|
+
readonly variable?: string;
|
|
201
|
+
}
|
|
202
|
+
|
|
157
203
|
/**
|
|
158
204
|
* Free-text search over list rows: a `--search` string keeping a row when ANY
|
|
159
205
|
* named SELECT variable contains the term (case-insensitive substring). Applied
|
|
@@ -239,6 +285,49 @@ export interface PackCompletion {
|
|
|
239
285
|
readonly minChars?: number;
|
|
240
286
|
}
|
|
241
287
|
|
|
288
|
+
/**
|
|
289
|
+
* How much an entity's containing SCOPE is worth when a name reaches several
|
|
290
|
+
* entities at once — the ranking factor {@link PackLookup.scopeWeight} declares.
|
|
291
|
+
*
|
|
292
|
+
* DERIVED, never enumerated. The scope's own name is a path (`Global`,
|
|
293
|
+
* `Apps/Launchpad`), so its DEPTH is a fact the graph already states, and a
|
|
294
|
+
* scope nobody has heard of yet inherits its place the day it appears. An
|
|
295
|
+
* enumerated ranking would have to be edited for each new one, and the one
|
|
296
|
+
* nobody edited would silently rank first.
|
|
297
|
+
*
|
|
298
|
+
* The weight falls by {@link falloff} per level below the top, so the top level
|
|
299
|
+
* is worth 1 and each nesting step costs the same again; floored at 0, so a very
|
|
300
|
+
* deep scope can never turn negative and invert the type factor it multiplies.
|
|
301
|
+
*
|
|
302
|
+
* {@link asserted} is the retirement path for the DERIVATION, not for this
|
|
303
|
+
* declaration: an asserted value wins over the derived one
|
|
304
|
+
* (`COALESCE(?asserted, ?derived)`), so the day the ontology states the ranking
|
|
305
|
+
* itself, the depth heuristic stops mattering and `falloff` becomes inert.
|
|
306
|
+
*
|
|
307
|
+
* The declaration itself must stay. Every read of {@link asserted} is reached
|
|
308
|
+
* through this object, so deleting it does not fall back to the ontology's rank
|
|
309
|
+
* — it removes scope ranking from the query altogether and silently returns the
|
|
310
|
+
* lookup to `STR(?uri)` order, which is the defect this exists to fix. What
|
|
311
|
+
* retires is the derivation, and what remains is `via` plus `asserted`.
|
|
312
|
+
*/
|
|
313
|
+
export interface PackScopeWeight {
|
|
314
|
+
/** The entity → scope edge (e.g. `ds:tier`). */
|
|
315
|
+
readonly via: string;
|
|
316
|
+
/**
|
|
317
|
+
* The scope property holding its path-shaped name (e.g. `ds:name`), whose
|
|
318
|
+
* `/`-separated depth derives the weight.
|
|
319
|
+
*
|
|
320
|
+
* It must be the NAME, not the IRI: the live tiers spell the same scope
|
|
321
|
+
* `ds:apps_launchpad` and `"Apps/Launchpad"`, and only the name carries the
|
|
322
|
+
* separator that makes the hierarchy legible.
|
|
323
|
+
*/
|
|
324
|
+
readonly by: string;
|
|
325
|
+
/** Score cost per level below the top, 0–1 (e.g. 0.2 → 1, 0.8, 0.6, …). */
|
|
326
|
+
readonly falloff: number;
|
|
327
|
+
/** An asserted weight on the scope, which WINS over the derived one. */
|
|
328
|
+
readonly asserted?: string;
|
|
329
|
+
}
|
|
330
|
+
|
|
242
331
|
/**
|
|
243
332
|
* The lookup half of a pack. The query is generated from `by` and `type`/`types`
|
|
244
333
|
* — user-supplied names are escaped by the generator, never interpolated by the
|
|
@@ -256,6 +345,29 @@ export interface PackLookup {
|
|
|
256
345
|
readonly source?: "sparql" | "graphql";
|
|
257
346
|
/** Property whose value names the entity — prefixed name or IRI. */
|
|
258
347
|
readonly by: string;
|
|
348
|
+
/**
|
|
349
|
+
* What names an entity that carries no {@link by} value. Absent (the default)
|
|
350
|
+
* means NOTHING does: the `by` triple is required, and an entity without one
|
|
351
|
+
* is not addressable by name and never drawn by `sample`.
|
|
352
|
+
*
|
|
353
|
+
* `"iri"` opts the family into an IRI-DERIVED name — the local name after the
|
|
354
|
+
* last `#`/`/`, with dot-separated hierarchy segments published as slashes
|
|
355
|
+
* (`cs:react.component.props` → `react/component/props`).
|
|
356
|
+
*
|
|
357
|
+
* DECLARE IT ONLY WHEN THE STORY'S `list` PUBLISHES THE SAME DERIVED NAME.
|
|
358
|
+
* The option exists to keep the two halves of the two-step grammar over ONE
|
|
359
|
+
* population: `standard list` synthesizes a name for the ~87% of code
|
|
360
|
+
* standards carrying no `cs:name`, so `standard lookup` must answer to it.
|
|
361
|
+
* Turning it on where the list does NOT publish such a name is the mirror
|
|
362
|
+
* defect — `token list` requires `ds:tokenId`, so a `ds:Token` without one
|
|
363
|
+
* would become addressable and sampleable under a name the list never
|
|
364
|
+
* published.
|
|
365
|
+
*
|
|
366
|
+
* Requires a class constraint ({@link type}/{@link types}): the derived name
|
|
367
|
+
* is only as trustworthy as the class that vouches for the entity, and
|
|
368
|
+
* without one there is nothing to bound the scan with either.
|
|
369
|
+
*/
|
|
370
|
+
readonly nameFallback?: "iri";
|
|
259
371
|
/** Optional single class constraint — prefixed name or IRI. */
|
|
260
372
|
readonly type?: string;
|
|
261
373
|
/** CLI description for the lookup command (defaults to a generated one). */
|
|
@@ -271,8 +383,9 @@ export interface PackLookup {
|
|
|
271
383
|
* Relative importance per addressed type, prefixed type → 0–1 (unlisted types
|
|
272
384
|
* default to 1). Editorial judgement about which of a noun's classes matters
|
|
273
385
|
* most, declared as DATA rather than frozen into the kernel — it feeds the MCP
|
|
274
|
-
* listing's `annotations.priority
|
|
275
|
-
*
|
|
386
|
+
* listing's `annotations.priority`, breaks ties in URI-completion ranking, AND
|
|
387
|
+
* is one factor of the score a name resolve ORDERS BY, so a `ds:Subcomponent`
|
|
388
|
+
* at 0.6 sinks below every component at equal match.
|
|
276
389
|
*
|
|
277
390
|
* A separate map rather than an entry shape on `types` so `types` keeps its
|
|
278
391
|
* flat `readonly string[]` form and the addition is non-breaking. A key naming
|
|
@@ -280,6 +393,16 @@ export interface PackLookup {
|
|
|
280
393
|
* is how a weight that never applied survives review.
|
|
281
394
|
*/
|
|
282
395
|
readonly weights?: Readonly<Record<string, number>>;
|
|
396
|
+
/**
|
|
397
|
+
* The OTHER factor of that score: how much an entity's containing scope is
|
|
398
|
+
* worth, derived from how DEEP that scope sits in its own hierarchy.
|
|
399
|
+
*
|
|
400
|
+
* {@link weights} answers "which KIND of thing did they mean"; this answers
|
|
401
|
+
* "whose?". They multiply rather than tiebreak, because neither subsumes the
|
|
402
|
+
* other: a whole component in a narrow scope still beats a mere part of a
|
|
403
|
+
* block in the widest one.
|
|
404
|
+
*/
|
|
405
|
+
readonly scopeWeight?: PackScopeWeight;
|
|
283
406
|
/**
|
|
284
407
|
* GraphQL type or interface the generated document's inline fragment targets
|
|
285
408
|
* (`source: "graphql"` only). Defaults to the local name of `type`; required
|