@snaptrude/plugin-core 0.9.16 → 0.9.18-networks-20261016.1
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/AGENTS.md +231 -231
- package/CHANGELOG.md +408 -402
- package/CLAUDE.md +11 -11
- package/dist/api/analysis/daylight.d.ts +5 -5
- package/dist/api/analysis/solar.d.ts +2 -2
- package/dist/api/core/camera/index.d.ts +29 -0
- package/dist/api/core/camera/index.d.ts.map +1 -1
- package/dist/api/core/geom/create/index.d.ts +7 -1
- package/dist/api/core/geom/create/index.d.ts.map +1 -1
- package/dist/api/core/geom/update/contour.d.ts +8 -2
- package/dist/api/core/geom/update/contour.d.ts.map +1 -1
- package/dist/api/core/zoom/index.d.ts +13 -0
- package/dist/api/core/zoom/index.d.ts.map +1 -1
- package/dist/api/design/bim.d.ts +209 -0
- package/dist/api/design/bim.d.ts.map +1 -0
- package/dist/api/design/boolean/index.d.ts +2 -0
- package/dist/api/design/boolean/index.d.ts.map +1 -1
- package/dist/api/design/catalog.d.ts +320 -0
- package/dist/api/design/catalog.d.ts.map +1 -0
- package/dist/api/design/create/bulk-items.d.ts +65 -25
- package/dist/api/design/create/bulk-items.d.ts.map +1 -1
- package/dist/api/design/create/index.d.ts +272 -99
- package/dist/api/design/create/index.d.ts.map +1 -1
- package/dist/api/design/create/opening-fields.d.ts +13 -12
- package/dist/api/design/create/opening-fields.d.ts.map +1 -1
- package/dist/api/design/delete/index.d.ts +1 -0
- package/dist/api/design/delete/index.d.ts.map +1 -1
- package/dist/api/design/doors/index.d.ts +18 -24
- package/dist/api/design/doors/index.d.ts.map +1 -1
- package/dist/api/design/family.d.ts +797 -27
- package/dist/api/design/family.d.ts.map +1 -1
- package/dist/api/design/index.d.ts +16 -0
- package/dist/api/design/index.d.ts.map +1 -1
- package/dist/api/design/networks.d.ts +1763 -0
- package/dist/api/design/networks.d.ts.map +1 -0
- package/dist/api/design/query/index.d.ts +42 -32
- package/dist/api/design/query/index.d.ts.map +1 -1
- package/dist/api/design/selection/index.d.ts +10 -10
- package/dist/api/design/types/index.d.ts +40 -24
- package/dist/api/design/types/index.d.ts.map +1 -1
- package/dist/api/design/update/index.d.ts +43 -3
- package/dist/api/design/update/index.d.ts.map +1 -1
- package/dist/api/design/windows/index.d.ts +8 -8
- package/dist/api/design/windows/index.d.ts.map +1 -1
- package/dist/api/presentation/aiInspiration.d.ts +10 -10
- package/dist/api/presentation/annotate.d.ts +38 -22
- package/dist/api/presentation/annotate.d.ts.map +1 -1
- package/dist/api/presentation/drawingContract.d.ts +32 -0
- package/dist/api/presentation/drawingContract.d.ts.map +1 -0
- package/dist/api/presentation/drawings.d.ts +3523 -0
- package/dist/api/presentation/drawings.d.ts.map +1 -0
- package/dist/api/presentation/export.d.ts +23 -5
- package/dist/api/presentation/export.d.ts.map +1 -1
- package/dist/api/presentation/index.d.ts +41 -12
- package/dist/api/presentation/index.d.ts.map +1 -1
- package/dist/api/presentation/placedViews.d.ts +106 -6
- package/dist/api/presentation/placedViews.d.ts.map +1 -1
- package/dist/api/presentation/sections.d.ts +461 -0
- package/dist/api/presentation/sections.d.ts.map +1 -0
- package/dist/api/presentation/shapes.d.ts +2 -2
- package/dist/api/presentation/sheets.d.ts +175 -19
- package/dist/api/presentation/sheets.d.ts.map +1 -1
- package/dist/api/presentation/viewPresets.d.ts +222 -0
- package/dist/api/presentation/viewPresets.d.ts.map +1 -0
- package/dist/api/presentation/views.d.ts +103 -5
- package/dist/api/presentation/views.d.ts.map +1 -1
- package/dist/api/presentation/walkthroughs.d.ts +6 -6
- package/dist/errors/codes.d.ts +3 -1
- package/dist/errors/codes.d.ts.map +1 -1
- package/dist/index.cjs +3788 -2328
- package/dist/index.cjs.map +1 -1
- package/dist/index.js +3650 -2328
- package/dist/index.js.map +1 -1
- package/package.json +42 -42
- package/scripts/check-dist-fresh.mjs +22 -22
- package/scripts/generate-manifest.mjs +243 -238
- package/scripts/generate-manifest.test.mjs +303 -303
- package/src/api/analysis/daylight.ts +470 -470
- package/src/api/analysis/heatmaps.ts +683 -683
- package/src/api/analysis/illuminance.ts +155 -155
- package/src/api/analysis/index.ts +61 -61
- package/src/api/analysis/shadows.ts +183 -183
- package/src/api/analysis/solar.ts +237 -237
- package/src/api/analysis/sunlightHours.ts +211 -211
- package/src/api/analysis/sunpath.ts +83 -83
- package/src/api/analysis/weather.ts +179 -179
- package/src/api/core/buildings.ts +485 -485
- package/src/api/core/camera/index.ts +696 -667
- package/src/api/core/comment/index.ts +376 -376
- package/src/api/core/geom/create/index.ts +2139 -2133
- package/src/api/core/geom/delete/index.ts +84 -84
- package/src/api/core/geom/index.ts +35 -35
- package/src/api/core/geom/query/arc.ts +169 -169
- package/src/api/core/geom/query/brep.ts +621 -621
- package/src/api/core/geom/query/circle.ts +404 -404
- package/src/api/core/geom/query/contour.ts +540 -540
- package/src/api/core/geom/query/curve.ts +1102 -1102
- package/src/api/core/geom/query/edge.ts +130 -130
- package/src/api/core/geom/query/face.ts +508 -508
- package/src/api/core/geom/query/halfedge.ts +210 -210
- package/src/api/core/geom/query/index.ts +63 -63
- package/src/api/core/geom/query/profile.ts +473 -473
- package/src/api/core/geom/query/vertex.ts +205 -205
- package/src/api/core/geom/update/contour.ts +323 -317
- package/src/api/core/geom/update/curve.ts +209 -209
- package/src/api/core/geom/update/index.ts +29 -29
- package/src/api/core/geom/update/profile.ts +379 -379
- package/src/api/core/groups.ts +521 -521
- package/src/api/core/handles/index.ts +234 -234
- package/src/api/core/history/index.ts +84 -84
- package/src/api/core/index.ts +99 -99
- package/src/api/core/io/export/index.ts +126 -126
- package/src/api/core/io/import/index.ts +504 -504
- package/src/api/core/io/index.ts +42 -42
- package/src/api/core/io/job/index.ts +140 -140
- package/src/api/core/io/query/index.ts +71 -71
- package/src/api/core/io/terrain/index.ts +360 -360
- package/src/api/core/io/underlay/index.ts +705 -705
- package/src/api/core/layers.ts +540 -540
- package/src/api/core/math/index.ts +20 -20
- package/src/api/core/math/quat.ts +172 -172
- package/src/api/core/math/vec3.ts +179 -179
- package/src/api/core/mode/index.ts +108 -108
- package/src/api/core/project/index.ts +479 -479
- package/src/api/core/proposals/index.ts +570 -570
- package/src/api/core/storeys/index.ts +308 -308
- package/src/api/core/storeys/layers.ts +339 -339
- package/src/api/core/tags.ts +911 -911
- package/src/api/core/units/index.ts +164 -164
- package/src/api/core/user.ts +46 -46
- package/src/api/core/zoom/index.ts +64 -51
- package/src/api/design/bim.ts +121 -0
- package/src/api/design/boolean/index.ts +181 -179
- package/src/api/design/catalog.ts +203 -0
- package/src/api/design/create/bulk-items.ts +294 -254
- package/src/api/design/create/grids.ts +137 -137
- package/src/api/design/create/index.ts +2148 -1980
- package/src/api/design/create/opening-fields.ts +40 -37
- package/src/api/design/delete/index.ts +75 -74
- package/src/api/design/dimensions.ts +453 -453
- package/src/api/design/doors/index.ts +516 -500
- package/src/api/design/edit/index.ts +54 -54
- package/src/api/design/erase/index.ts +151 -151
- package/src/api/design/family.ts +1334 -704
- package/src/api/design/furniture/index.ts +319 -319
- package/src/api/design/grids.ts +237 -237
- package/src/api/design/index.ts +304 -274
- package/src/api/design/lock.ts +69 -69
- package/src/api/design/materials/index.ts +608 -608
- package/src/api/design/networks.ts +667 -0
- package/src/api/design/query/geometry/index.ts +319 -319
- package/src/api/design/query/grids.ts +197 -197
- package/src/api/design/query/index.ts +1236 -1226
- package/src/api/design/query/referenceLines.ts +52 -52
- package/src/api/design/query/spaces.ts +275 -275
- package/src/api/design/selection/index.ts +273 -273
- package/src/api/design/shared.ts +40 -40
- package/src/api/design/transform/index.ts +254 -254
- package/src/api/design/types/index.ts +163 -156
- package/src/api/design/update/index.ts +1024 -983
- package/src/api/design/visibility.ts +143 -143
- package/src/api/design/windows/index.ts +351 -333
- package/src/api/entity/buildableEnvelope.ts +322 -322
- package/src/api/entity/index.ts +30 -30
- package/src/api/entity/referenceLine.ts +235 -235
- package/src/api/entity/space.ts +612 -612
- package/src/api/entity/story.ts +517 -517
- package/src/api/index.ts +47 -47
- package/src/api/presentation/aiInspiration.ts +1116 -1116
- package/src/api/presentation/annotate.ts +417 -385
- package/src/api/presentation/camera.ts +289 -289
- package/src/api/presentation/diagrams.ts +194 -194
- package/src/api/presentation/drawingContract.ts +70 -0
- package/src/api/presentation/drawings.ts +1179 -0
- package/src/api/presentation/export.ts +134 -108
- package/src/api/presentation/import.ts +159 -159
- package/src/api/presentation/index.ts +160 -126
- package/src/api/presentation/placedViews.ts +1211 -1120
- package/src/api/presentation/sections.ts +420 -0
- package/src/api/presentation/shapes.ts +274 -274
- package/src/api/presentation/sheets.ts +746 -585
- package/src/api/presentation/slideshow.ts +134 -134
- package/src/api/presentation/tables.ts +84 -84
- package/src/api/presentation/viewPresets.ts +241 -0
- package/src/api/presentation/views.ts +713 -673
- package/src/api/presentation/walkthroughs.ts +1201 -1201
- package/src/api/program/adjacency.ts +164 -164
- package/src/api/program/areas.ts +408 -408
- package/src/api/program/classification.ts +138 -138
- package/src/api/program/cores.ts +83 -83
- package/src/api/program/departments.ts +517 -517
- package/src/api/program/index.ts +73 -73
- package/src/api/program/labels.ts +332 -332
- package/src/api/program/layout.ts +422 -422
- package/src/api/program/metadata.ts +364 -364
- package/src/api/program/metrics.ts +120 -120
- package/src/api/program/site.ts +748 -748
- package/src/api/program/spreadsheet.ts +2698 -2698
- package/src/api/workspace/index.ts +612 -612
- package/src/errors/codes.ts +143 -136
- package/src/errors/envelope.ts +75 -75
- package/src/errors/index.ts +21 -21
- package/src/errors/plugin-error.ts +134 -134
- package/src/handles.ts +297 -297
- package/src/host-utils.ts +67 -67
- package/src/index.ts +7 -7
- package/src/massParameters.ops.ts +246 -246
- package/src/massParameters.ts +427 -427
- package/src/types.ts +16 -16
- package/test/drawingContract.test.mjs +288 -0
- package/test/errors.test.mjs +185 -184
- package/test/massParameters.test.mjs +952 -952
- package/tsconfig.json +22 -22
- package/tsup.config.ts +12 -12
- package/api-manifest.json +0 -9618
package/package.json
CHANGED
|
@@ -1,42 +1,42 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@snaptrude/plugin-core",
|
|
3
|
-
"version": "0.9.
|
|
4
|
-
"type": "module",
|
|
5
|
-
"main": "./dist/index.js",
|
|
6
|
-
"module": "./dist/index.js",
|
|
7
|
-
"types": "./dist/index.d.ts",
|
|
8
|
-
"exports": {
|
|
9
|
-
".": {
|
|
10
|
-
"types": "./dist/index.d.ts",
|
|
11
|
-
"require": "./dist/index.cjs",
|
|
12
|
-
"import": "./dist/index.js",
|
|
13
|
-
"default": "./dist/index.js"
|
|
14
|
-
}
|
|
15
|
-
},
|
|
16
|
-
"publishConfig": {
|
|
17
|
-
"access": "public"
|
|
18
|
-
},
|
|
19
|
-
"
|
|
20
|
-
"
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
"
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
"
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
"
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
"
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
"
|
|
41
|
-
}
|
|
42
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@snaptrude/plugin-core",
|
|
3
|
+
"version": "0.9.18-networks-20261016.1",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"module": "./dist/index.js",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"require": "./dist/index.cjs",
|
|
12
|
+
"import": "./dist/index.js",
|
|
13
|
+
"default": "./dist/index.js"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"publishConfig": {
|
|
17
|
+
"access": "public"
|
|
18
|
+
},
|
|
19
|
+
"scripts": {
|
|
20
|
+
"check-types": "tsc --noEmit",
|
|
21
|
+
"build": "tsup --clean",
|
|
22
|
+
"dev": "tsup --watch",
|
|
23
|
+
"clean-dist": "rm -rf dist",
|
|
24
|
+
"pretest": "node scripts/check-dist-fresh.mjs",
|
|
25
|
+
"test": "node --test test/*.test.mjs",
|
|
26
|
+
"generate:manifest": "node scripts/generate-manifest.mjs",
|
|
27
|
+
"generate:manifest:check": "node scripts/generate-manifest.mjs --check",
|
|
28
|
+
"generate:manifest:all": "node scripts/generate-manifest.mjs --all",
|
|
29
|
+
"generate:manifest:all:check": "node scripts/generate-manifest.mjs --all --check"
|
|
30
|
+
},
|
|
31
|
+
"devDependencies": {
|
|
32
|
+
"ts-morph": "^28.0.0",
|
|
33
|
+
"tsup": "^8.5.1",
|
|
34
|
+
"typescript": "^5.5.4"
|
|
35
|
+
},
|
|
36
|
+
"dependencies": {
|
|
37
|
+
"zod": "^4.3.6"
|
|
38
|
+
},
|
|
39
|
+
"peerDependencies": {
|
|
40
|
+
"zod": "^3.25.0 || ^4.0.0"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
// `npm test` imports ../dist; refuse to run against a build older than the source.
|
|
2
|
-
// A check, not a rebuild: the host dev checkout symlinks this package, so a
|
|
3
|
-
// rebuild here would blank `dist` under a running editor.
|
|
4
|
-
import { readdirSync, statSync } from "node:fs";
|
|
5
|
-
import { join } from "node:path";
|
|
6
|
-
|
|
7
|
-
const newest = (dir) =>
|
|
8
|
-
readdirSync(dir, { withFileTypes: true }).reduce((max, entry) => {
|
|
9
|
-
const path = join(dir, entry.name);
|
|
10
|
-
return Math.max(max, entry.isDirectory() ? newest(path) : statSync(path).mtimeMs);
|
|
11
|
-
}, 0);
|
|
12
|
-
|
|
13
|
-
let built = 0;
|
|
14
|
-
try {
|
|
15
|
-
built = statSync("dist/index.js").mtimeMs;
|
|
16
|
-
} catch {
|
|
17
|
-
// no dist at all
|
|
18
|
-
}
|
|
19
|
-
if (newest("src") > built) {
|
|
20
|
-
console.error("dist is older than src — run `pnpm build` (tsup --clean) first, then test.");
|
|
21
|
-
process.exit(1);
|
|
22
|
-
}
|
|
1
|
+
// `npm test` imports ../dist; refuse to run against a build older than the source.
|
|
2
|
+
// A check, not a rebuild: the host dev checkout symlinks this package, so a
|
|
3
|
+
// rebuild here would blank `dist` under a running editor.
|
|
4
|
+
import { readdirSync, statSync } from "node:fs";
|
|
5
|
+
import { join } from "node:path";
|
|
6
|
+
|
|
7
|
+
const newest = (dir) =>
|
|
8
|
+
readdirSync(dir, { withFileTypes: true }).reduce((max, entry) => {
|
|
9
|
+
const path = join(dir, entry.name);
|
|
10
|
+
return Math.max(max, entry.isDirectory() ? newest(path) : statSync(path).mtimeMs);
|
|
11
|
+
}, 0);
|
|
12
|
+
|
|
13
|
+
let built = 0;
|
|
14
|
+
try {
|
|
15
|
+
built = statSync("dist/index.js").mtimeMs;
|
|
16
|
+
} catch {
|
|
17
|
+
// no dist at all
|
|
18
|
+
}
|
|
19
|
+
if (newest("src") > built) {
|
|
20
|
+
console.error("dist is older than src — run `pnpm build` (tsup --clean) first, then test.");
|
|
21
|
+
process.exit(1);
|
|
22
|
+
}
|
|
@@ -1,238 +1,243 @@
|
|
|
1
|
-
// Discovery-manifest generator.
|
|
2
|
-
//
|
|
3
|
-
// The plugin API surface is a tree of abstract `Plugin*Api` classes; the wire
|
|
4
|
-
// method map (`PluginApiMethodMap`) is TYPE-LEVEL ONLY and cannot be enumerated
|
|
5
|
-
// at runtime. This script statically walks the abstract+Zod source with ts-morph
|
|
6
|
-
// and emits a flat, machine-readable manifest of every leaf method:
|
|
7
|
-
//
|
|
8
|
-
// { path, namespace, summary, examplePrompts[], argsType, resultType }
|
|
9
|
-
//
|
|
10
|
-
// The manifest is the substrate the discovery server (plugin-mcp-server) and the
|
|
11
|
-
// retrieval-accuracy eval harness key on. Authors only ever write the abstract
|
|
12
|
-
// class + Zod schemas + JSDoc + `@examplePrompt` lines — this regenerates the rest.
|
|
13
|
-
//
|
|
14
|
-
// Run: `pnpm --filter @snaptrude/plugin-core generate:manifest`
|
|
15
|
-
// add `--check` to assert the on-disk manifest is up-to-date (CI gate);
|
|
16
|
-
// exits non-zero without writing if regeneration would change it.
|
|
17
|
-
import { Project } from "ts-morph"
|
|
18
|
-
import { fileURLToPath } from "node:url"
|
|
19
|
-
import { dirname, resolve } from "node:path"
|
|
20
|
-
import { writeFileSync, readFileSync, existsSync } from "node:fs"
|
|
21
|
-
|
|
22
|
-
const here = dirname(fileURLToPath(import.meta.url))
|
|
23
|
-
const pkgRoot = resolve(here, "..")
|
|
24
|
-
const apiGlob = resolve(pkgRoot, "src/api/**/*.ts")
|
|
25
|
-
const outFile = resolve(pkgRoot, "api-manifest.json")
|
|
26
|
-
|
|
27
|
-
const ROOT_CLASS = "PluginApi"
|
|
28
|
-
const RETURN_WRAPPER = "PluginApiReturn"
|
|
29
|
-
|
|
30
|
-
/** First paragraph of a JSDoc description, whitespace-collapsed. */
|
|
31
|
-
function summaryOf(jsDoc) {
|
|
32
|
-
if (!jsDoc) return ""
|
|
33
|
-
const desc = (jsDoc.getDescription() ?? "").trim()
|
|
34
|
-
const firstPara = desc.split(/\n\s*\n/)[0] ?? ""
|
|
35
|
-
return firstPara.replace(/\s+/g, " ").trim()
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
/** All `@examplePrompt` comment strings on a method's JSDoc. */
|
|
39
|
-
function examplePromptsOf(jsDoc) {
|
|
40
|
-
if (!jsDoc) return []
|
|
41
|
-
return jsDoc
|
|
42
|
-
.getTags()
|
|
43
|
-
.filter((t) => t.getTagName() === "examplePrompt")
|
|
44
|
-
.map((t) => (t.getCommentText() ?? "").trim())
|
|
45
|
-
.filter(Boolean)
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* The single `@performance` note on a method's JSDoc, if any.
|
|
50
|
-
*
|
|
51
|
-
* A short throughput hint the discovery layer surfaces so a code generator picks
|
|
52
|
-
* the bulk/array API over a per-item loop (each API call is one host round-trip).
|
|
53
|
-
* Authored on the plural/array methods; absent on everything else (the field is
|
|
54
|
-
* omitted from the manifest entry entirely when there is no tag, to keep the diff
|
|
55
|
-
* — and the LLM's attention — on the methods where it matters).
|
|
56
|
-
*/
|
|
57
|
-
function performanceOf(jsDoc) {
|
|
58
|
-
if (!jsDoc) return ""
|
|
59
|
-
const tag = jsDoc.getTags().find((t) => t.getTagName() === "performance")
|
|
60
|
-
return (tag?.getCommentText() ?? "").replace(/\s+/g, " ").trim()
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
* The `@deprecated` marker for a method, or "" when the method is not deprecated.
|
|
65
|
-
*
|
|
66
|
-
* When the tag text names a replacement API as a dotted path — conventionally in
|
|
67
|
-
* backticks, e.g. `` `core.handles.release([profile])` `` — we surface just that
|
|
68
|
-
* path (call/array suffix stripped) so the discovery layer can point callers
|
|
69
|
-
* straight at the successor. Otherwise we fall back to the tag's prose, or `true`
|
|
70
|
-
* when the tag carries no comment. Methods with no `@deprecated` tag return "" and
|
|
71
|
-
* get NO key in the manifest (the spread of "" is dropped), keeping the diff lean.
|
|
72
|
-
*/
|
|
73
|
-
function deprecatedOf(jsDoc) {
|
|
74
|
-
if (!jsDoc) return ""
|
|
75
|
-
const tag = jsDoc.getTags().find((t) => t.getTagName() === "deprecated")
|
|
76
|
-
if (!tag) return ""
|
|
77
|
-
const text = (tag.getCommentText() ?? "").replace(/\s+/g, " ").trim()
|
|
78
|
-
for (const span of text.match(/`[^`]+`/g) ?? []) {
|
|
79
|
-
const path = span.match(/[A-Za-z_$][\w$]*(?:\.[A-Za-z_$][\w$]*)+/)
|
|
80
|
-
if (path) return path[0]
|
|
81
|
-
}
|
|
82
|
-
return text || true
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
/** Strip the `PluginApiReturn<...>` wrapper to the inner result type text. */
|
|
86
|
-
function unwrapReturn(text) {
|
|
87
|
-
if (!text) return "void"
|
|
88
|
-
const m = text.match(new RegExp(`^${RETURN_WRAPPER}<([\\s\\S]*)>$`))
|
|
89
|
-
return (m ? m[1] : text).trim()
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
/**
|
|
93
|
-
* Statically walk the abstract `PluginApi` class tree and return one flat,
|
|
94
|
-
* sorted manifest entry per leaf method. Pure (no side effects) so it is unit
|
|
95
|
-
* testable; the CLI below adds the write + report.
|
|
96
|
-
*/
|
|
97
|
-
export function buildManifest({ includeOptional = false } = {}) {
|
|
98
|
-
const project = new Project({ skipAddingFilesFromTsConfig: true })
|
|
99
|
-
project.addSourceFilesAtPaths(apiGlob)
|
|
100
|
-
|
|
101
|
-
// className -> ClassDeclaration, for every abstract Plugin*Api class.
|
|
102
|
-
const classes = new Map()
|
|
103
|
-
for (const sf of project.getSourceFiles()) {
|
|
104
|
-
for (const cls of sf.getClasses()) {
|
|
105
|
-
const name = cls.getName()
|
|
106
|
-
if (name && name.startsWith("Plugin") && name.endsWith("Api")) {
|
|
107
|
-
classes.set(name, cls)
|
|
108
|
-
}
|
|
109
|
-
}
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
const leaves = []
|
|
113
|
-
|
|
114
|
-
function walk(className, pathPrefix) {
|
|
115
|
-
const cls = classes.get(className)
|
|
116
|
-
if (!cls) return
|
|
117
|
-
|
|
118
|
-
//
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
//
|
|
143
|
-
//
|
|
144
|
-
//
|
|
145
|
-
// the
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
}
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
)
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
1
|
+
// Discovery-manifest generator.
|
|
2
|
+
//
|
|
3
|
+
// The plugin API surface is a tree of abstract `Plugin*Api` classes; the wire
|
|
4
|
+
// method map (`PluginApiMethodMap`) is TYPE-LEVEL ONLY and cannot be enumerated
|
|
5
|
+
// at runtime. This script statically walks the abstract+Zod source with ts-morph
|
|
6
|
+
// and emits a flat, machine-readable manifest of every leaf method:
|
|
7
|
+
//
|
|
8
|
+
// { path, namespace, summary, examplePrompts[], argsType, resultType }
|
|
9
|
+
//
|
|
10
|
+
// The manifest is the substrate the discovery server (plugin-mcp-server) and the
|
|
11
|
+
// retrieval-accuracy eval harness key on. Authors only ever write the abstract
|
|
12
|
+
// class + Zod schemas + JSDoc + `@examplePrompt` lines — this regenerates the rest.
|
|
13
|
+
//
|
|
14
|
+
// Run: `pnpm --filter @snaptrude/plugin-core generate:manifest`
|
|
15
|
+
// add `--check` to assert the on-disk manifest is up-to-date (CI gate);
|
|
16
|
+
// exits non-zero without writing if regeneration would change it.
|
|
17
|
+
import { Project } from "ts-morph"
|
|
18
|
+
import { fileURLToPath } from "node:url"
|
|
19
|
+
import { dirname, resolve } from "node:path"
|
|
20
|
+
import { writeFileSync, readFileSync, existsSync } from "node:fs"
|
|
21
|
+
|
|
22
|
+
const here = dirname(fileURLToPath(import.meta.url))
|
|
23
|
+
const pkgRoot = resolve(here, "..")
|
|
24
|
+
const apiGlob = resolve(pkgRoot, "src/api/**/*.ts")
|
|
25
|
+
const outFile = resolve(pkgRoot, "api-manifest.json")
|
|
26
|
+
|
|
27
|
+
const ROOT_CLASS = "PluginApi"
|
|
28
|
+
const RETURN_WRAPPER = "PluginApiReturn"
|
|
29
|
+
|
|
30
|
+
/** First paragraph of a JSDoc description, whitespace-collapsed. */
|
|
31
|
+
function summaryOf(jsDoc) {
|
|
32
|
+
if (!jsDoc) return ""
|
|
33
|
+
const desc = (jsDoc.getDescription() ?? "").trim()
|
|
34
|
+
const firstPara = desc.split(/\n\s*\n/)[0] ?? ""
|
|
35
|
+
return firstPara.replace(/\s+/g, " ").trim()
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/** All `@examplePrompt` comment strings on a method's JSDoc. */
|
|
39
|
+
function examplePromptsOf(jsDoc) {
|
|
40
|
+
if (!jsDoc) return []
|
|
41
|
+
return jsDoc
|
|
42
|
+
.getTags()
|
|
43
|
+
.filter((t) => t.getTagName() === "examplePrompt")
|
|
44
|
+
.map((t) => (t.getCommentText() ?? "").trim())
|
|
45
|
+
.filter(Boolean)
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* The single `@performance` note on a method's JSDoc, if any.
|
|
50
|
+
*
|
|
51
|
+
* A short throughput hint the discovery layer surfaces so a code generator picks
|
|
52
|
+
* the bulk/array API over a per-item loop (each API call is one host round-trip).
|
|
53
|
+
* Authored on the plural/array methods; absent on everything else (the field is
|
|
54
|
+
* omitted from the manifest entry entirely when there is no tag, to keep the diff
|
|
55
|
+
* — and the LLM's attention — on the methods where it matters).
|
|
56
|
+
*/
|
|
57
|
+
function performanceOf(jsDoc) {
|
|
58
|
+
if (!jsDoc) return ""
|
|
59
|
+
const tag = jsDoc.getTags().find((t) => t.getTagName() === "performance")
|
|
60
|
+
return (tag?.getCommentText() ?? "").replace(/\s+/g, " ").trim()
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* The `@deprecated` marker for a method, or "" when the method is not deprecated.
|
|
65
|
+
*
|
|
66
|
+
* When the tag text names a replacement API as a dotted path — conventionally in
|
|
67
|
+
* backticks, e.g. `` `core.handles.release([profile])` `` — we surface just that
|
|
68
|
+
* path (call/array suffix stripped) so the discovery layer can point callers
|
|
69
|
+
* straight at the successor. Otherwise we fall back to the tag's prose, or `true`
|
|
70
|
+
* when the tag carries no comment. Methods with no `@deprecated` tag return "" and
|
|
71
|
+
* get NO key in the manifest (the spread of "" is dropped), keeping the diff lean.
|
|
72
|
+
*/
|
|
73
|
+
function deprecatedOf(jsDoc) {
|
|
74
|
+
if (!jsDoc) return ""
|
|
75
|
+
const tag = jsDoc.getTags().find((t) => t.getTagName() === "deprecated")
|
|
76
|
+
if (!tag) return ""
|
|
77
|
+
const text = (tag.getCommentText() ?? "").replace(/\s+/g, " ").trim()
|
|
78
|
+
for (const span of text.match(/`[^`]+`/g) ?? []) {
|
|
79
|
+
const path = span.match(/[A-Za-z_$][\w$]*(?:\.[A-Za-z_$][\w$]*)+/)
|
|
80
|
+
if (path) return path[0]
|
|
81
|
+
}
|
|
82
|
+
return text || true
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/** Strip the `PluginApiReturn<...>` wrapper to the inner result type text. */
|
|
86
|
+
function unwrapReturn(text) {
|
|
87
|
+
if (!text) return "void"
|
|
88
|
+
const m = text.match(new RegExp(`^${RETURN_WRAPPER}<([\\s\\S]*)>$`))
|
|
89
|
+
return (m ? m[1] : text).trim()
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* Statically walk the abstract `PluginApi` class tree and return one flat,
|
|
94
|
+
* sorted manifest entry per leaf method. Pure (no side effects) so it is unit
|
|
95
|
+
* testable; the CLI below adds the write + report.
|
|
96
|
+
*/
|
|
97
|
+
export function buildManifest({ includeOptional = false } = {}) {
|
|
98
|
+
const project = new Project({ skipAddingFilesFromTsConfig: true })
|
|
99
|
+
project.addSourceFilesAtPaths(apiGlob)
|
|
100
|
+
|
|
101
|
+
// className -> ClassDeclaration, for every abstract Plugin*Api class.
|
|
102
|
+
const classes = new Map()
|
|
103
|
+
for (const sf of project.getSourceFiles()) {
|
|
104
|
+
for (const cls of sf.getClasses()) {
|
|
105
|
+
const name = cls.getName()
|
|
106
|
+
if (name && name.startsWith("Plugin") && name.endsWith("Api")) {
|
|
107
|
+
classes.set(name, cls)
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
const leaves = []
|
|
113
|
+
|
|
114
|
+
function walk(className, pathPrefix) {
|
|
115
|
+
const cls = classes.get(className)
|
|
116
|
+
if (!cls) return
|
|
117
|
+
|
|
118
|
+
// Domain network namespaces inherit their transport methods. Include these
|
|
119
|
+
// leaves so discovery exposes the same API as the generic worker proxy.
|
|
120
|
+
const base = cls.getExtends()?.getExpression().getText()
|
|
121
|
+
if (base && classes.has(base)) walk(base, pathPrefix)
|
|
122
|
+
|
|
123
|
+
// Leaf methods on this namespace.
|
|
124
|
+
for (const method of cls.getMethods()) {
|
|
125
|
+
const name = method.getName()
|
|
126
|
+
const jsDoc = method.getJsDocs().at(-1) ?? null
|
|
127
|
+
const param = method.getParameters()[0]
|
|
128
|
+
const performance = performanceOf(jsDoc)
|
|
129
|
+
const deprecated = deprecatedOf(jsDoc)
|
|
130
|
+
leaves.push({
|
|
131
|
+
path: `${pathPrefix}${name}`,
|
|
132
|
+
namespace: pathPrefix.replace(/\.$/, ""),
|
|
133
|
+
summary: summaryOf(jsDoc),
|
|
134
|
+
examplePrompts: examplePromptsOf(jsDoc),
|
|
135
|
+
argsType: param?.getTypeNode()?.getText() ?? null,
|
|
136
|
+
resultType: unwrapReturn(method.getReturnTypeNode()?.getText()),
|
|
137
|
+
...(performance ? { performance } : {}),
|
|
138
|
+
...(deprecated ? { deprecated } : {}),
|
|
139
|
+
})
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
// Sub-namespaces are abstract properties typed as another Plugin*Api class.
|
|
143
|
+
//
|
|
144
|
+
// Author-ahead discipline: a member declared optional (`?`) is authored
|
|
145
|
+
// BEFORE the host implements it — present in the type tree (so plugins and
|
|
146
|
+
// codegen see the shape) but kept OUT of the discovery manifest until it is
|
|
147
|
+
// promoted to a required `abstract` member in the wave the host lands it.
|
|
148
|
+
// The default (discovery) build skips optional members; the authored-surface
|
|
149
|
+
// build (`includeOptional`, used by the retrieval eval) includes them — both
|
|
150
|
+
// the optional sub-namespaces and the optional function-property leaves.
|
|
151
|
+
for (const prop of cls.getProperties()) {
|
|
152
|
+
const optional = prop.hasQuestionToken()
|
|
153
|
+
if (optional && !includeOptional) continue
|
|
154
|
+
const typeNode = prop.getTypeNode()
|
|
155
|
+
const childType = typeNode?.getText()
|
|
156
|
+
if (childType && classes.has(childType)) {
|
|
157
|
+
walk(childType, `${pathPrefix}${prop.getName()}.`)
|
|
158
|
+
} else if (
|
|
159
|
+
includeOptional &&
|
|
160
|
+
typeNode &&
|
|
161
|
+
typeNode.getKindName() === "FunctionType"
|
|
162
|
+
) {
|
|
163
|
+
// An optional author-ahead leaf, written as a function-property.
|
|
164
|
+
const jsDoc = prop.getJsDocs().at(-1) ?? null
|
|
165
|
+
const param = typeNode.getParameters()[0]
|
|
166
|
+
const performance = performanceOf(jsDoc)
|
|
167
|
+
const deprecated = deprecatedOf(jsDoc)
|
|
168
|
+
leaves.push({
|
|
169
|
+
path: `${pathPrefix}${prop.getName()}`,
|
|
170
|
+
namespace: pathPrefix.replace(/\.$/, ""),
|
|
171
|
+
summary: summaryOf(jsDoc),
|
|
172
|
+
examplePrompts: examplePromptsOf(jsDoc),
|
|
173
|
+
argsType: param?.getTypeNode()?.getText() ?? null,
|
|
174
|
+
resultType: unwrapReturn(typeNode.getReturnTypeNode()?.getText()),
|
|
175
|
+
...(performance ? { performance } : {}),
|
|
176
|
+
...(deprecated ? { deprecated } : {}),
|
|
177
|
+
})
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
walk(ROOT_CLASS, "")
|
|
183
|
+
leaves.sort((a, b) => a.path.localeCompare(b.path))
|
|
184
|
+
return leaves
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// --- CLI: write + report (skipped when imported, e.g. by tests) ------------
|
|
188
|
+
if (
|
|
189
|
+
process.argv[1] &&
|
|
190
|
+
resolve(process.argv[1]) === fileURLToPath(import.meta.url)
|
|
191
|
+
) {
|
|
192
|
+
// `--all` builds the AUTHORED-surface manifest (includes optional author-ahead
|
|
193
|
+
// members) to a separate file, for the retrieval eval. Default builds the
|
|
194
|
+
// discovery manifest (required/host-landed members only).
|
|
195
|
+
const all = process.argv.includes("--all")
|
|
196
|
+
const check = process.argv.includes("--check")
|
|
197
|
+
const target = all ? resolve(pkgRoot, "api-manifest.full.json") : outFile
|
|
198
|
+
const leaves = buildManifest({ includeOptional: all })
|
|
199
|
+
const json = JSON.stringify(leaves, null, 2) + "\n"
|
|
200
|
+
|
|
201
|
+
if (check) {
|
|
202
|
+
// Determinism / staleness gate: regenerate and compare, never write.
|
|
203
|
+
const current = existsSync(target) ? readFileSync(target, "utf8") : ""
|
|
204
|
+
if (current !== json) {
|
|
205
|
+
console.error(
|
|
206
|
+
`${target} is STALE or non-deterministic — run \`generate:manifest${all ? " --all" : ""}\` and commit the result.`,
|
|
207
|
+
)
|
|
208
|
+
process.exit(1)
|
|
209
|
+
}
|
|
210
|
+
console.log(
|
|
211
|
+
`manifest up-to-date & deterministic (${leaves.length} methods)`,
|
|
212
|
+
)
|
|
213
|
+
process.exit(0)
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
writeFileSync(target, json)
|
|
217
|
+
|
|
218
|
+
const missingPrompts = leaves.filter((l) => l.examplePrompts.length === 0)
|
|
219
|
+
console.log(
|
|
220
|
+
`manifest${all ? " (authored surface)" : ""}: ${leaves.length} methods -> ${target}`,
|
|
221
|
+
)
|
|
222
|
+
console.log(
|
|
223
|
+
`coverage: ${leaves.length - missingPrompts.length}/${leaves.length} methods have @examplePrompt lines`,
|
|
224
|
+
)
|
|
225
|
+
if (missingPrompts.length) {
|
|
226
|
+
console.log(
|
|
227
|
+
` (no @examplePrompt yet: ${missingPrompts.map((l) => l.path).join(", ")})`,
|
|
228
|
+
)
|
|
229
|
+
}
|
|
230
|
+
const slice = [
|
|
231
|
+
"program.departments.list",
|
|
232
|
+
"program.departments.get",
|
|
233
|
+
"program.metrics.get",
|
|
234
|
+
"presentation.views.list",
|
|
235
|
+
]
|
|
236
|
+
console.log("slice methods present:")
|
|
237
|
+
for (const p of slice) {
|
|
238
|
+
const hit = leaves.find((l) => l.path === p)
|
|
239
|
+
console.log(
|
|
240
|
+
` ${hit ? "OK " : "MISS"} ${p}${hit ? ` (${hit.examplePrompts.length} prompts)` : ""}`,
|
|
241
|
+
)
|
|
242
|
+
}
|
|
243
|
+
}
|