dsh-gitnexus-plus 0.1.1 → 0.1.3

package/lib/routes/search.js

@@ -0,0 +1,77 @@
+/**
+ * `GET /api/gitnexus/search?repo=<project>&q=<keyword>` — keyword search.
+ *
+ * The fourth route, and the first that is neither a reading of the index manifest
+ * nor a maintenance action: it queries the graph's symbol names and file paths.
+ * It is read-only in the strongest sense this plugin can offer — the engine opens
+ * LadybugDB with `readOnly: true` and takes no write lock — so the method policy is
+ * the read-only one (GET/HEAD), not the analyze route's wider set.
+ *
+ * The bound is the same project-root check the coverage route uses: a directory
+ * that is neither indexed nor a `.git` root is refused, so the route cannot be used
+ * to enumerate a filesystem. Search itself additionally requires a complete index
+ * store and returns a typed error when the graph is missing.
+ */
+import path from 'node:path';
+import { guardHandler, passGuard, answerHead, sendJson } from './guard.js';
+import { isProjectRoot } from '../gitnexus/index-meta.js';
+import { SearchError } from '../gitnexus/search.js';
+const SEARCH_METHODS = new Set(['GET', 'HEAD']);
+/**
+ * @returns disposer that unregisters the route
+ */
+export function mountSearchRoute(webServer, deps) {
+    const handler = guardHandler(async (req, res) => {
+        if (!passGuard(req, res, SEARCH_METHODS))
+            return;
+        const url = new URL(req.url ?? '/', 'http://127.0.0.1');
+        const repo = url.searchParams.get('repo');
+        if (repo === null || repo.trim() === '') {
+            sendJson(res, 400, { ok: false, code: 'missing-repo', message: 'repo query parameter is required' });
+            return;
+        }
+        const query = url.searchParams.get('q');
+        if (query === null || query.trim() === '') {
+            sendJson(res, 400, { ok: false, code: 'missing-query', message: 'q query parameter is required' });
+            return;
+        }
+        const absRepo = path.resolve(repo);
+        // The same boundary as the coverage route: a search must not become a way to
+        // ask whether an arbitrary directory exists. The engine repeats this check for
+        // direct callers; at the HTTP edge it saves opening a database to say no.
+        if (!(await isProjectRoot(absRepo))) {
+            sendJson(res, 404, {
+                ok: false,
+                code: 'not-a-project',
+                message: 'directory is neither a GitNexus index nor a git repository root',
+            });
+            return;
+        }
+        if (answerHead(req, res))
+            return;
+        // `limit` is optional; the engine clamps it. A malformed value is treated as
+        // absent rather than as an error — the search itself does not depend on it.
+        const rawLimit = url.searchParams.get('limit');
+        const parsed = rawLimit === null ? Number.NaN : Number.parseInt(rawLimit, 10);
+        const limit = Number.isFinite(parsed) ? parsed : undefined;
+        try {
+            const report = await deps.search(absRepo, query, { limit });
+            sendJson(res, 200, {
+                ok: true,
+                ...report,
+                readAt: new Date().toISOString(),
+            });
+        }
+        catch (error) {
+            if (error instanceof SearchError) {
+                sendJson(res, error.status, { ok: false, code: error.code, message: error.message });
+                return;
+            }
+            // `guardHandler` turns anything else into a 500; rethrow so its single error
+            // path stays the only place that formats an unexpected failure.
+            throw error;
+        }
+    });
+    return webServer.register({ kind: 'prefix', path: '/api/gitnexus/search', handler });
+}
+//# sourceMappingURL=search.js.map

package/lib/routes/search.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.js","sourceRoot":"","sources":["../../src/routes/search.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3E,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAqB,MAAM,uBAAuB,CAAC;AAEvE,MAAM,cAAc,GAAwB,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;AAOrE;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAA2B,EAAE,IAAqB;IACjF,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE;QAC9C,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,cAAc,CAAC;YAAE,OAAO;QAEjD,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,kBAAkB,CAAC,CAAC;QACxD,MAAM,IAAI,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACxC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,EAAE,kCAAkC,EAAE,CAAC,CAAC;YACrG,OAAO;QACT,CAAC;QACD,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YAC1C,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,+BAA+B,EAAE,CAAC,CAAC;YACnG,OAAO;QACT,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACnC,6EAA6E;QAC7E,+EAA+E;QAC/E,0EAA0E;QAC1E,IAAI,CAAC,CAAC,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACpC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE;gBACjB,EAAE,EAAE,KAAK;gBACT,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE,iEAAiE;aAC3E,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC;YAAE,OAAO;QAEjC,6EAA6E;QAC7E,4EAA4E;QAC5E,MAAM,QAAQ,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC9E,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QAE3D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;YAC5D,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE;gBACjB,EAAE,EAAE,IAAI;gBACR,GAAG,MAAM;gBACT,MAAM,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;aACjC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;gBACjC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBACrF,OAAO;YACT,CAAC;YACD,6EAA6E;YAC7E,gEAAgE;YAChE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,sBAAsB,EAAE,OAAO,EAAE,CAAC,CAAC;AACvF,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "dsh-gitnexus-plus",
-  "version": "0.1.1",
-  "description": "DSH plugin: visualize a GitNexus project index, report what it left out, and run its incremental refresh from a sidebar panel — including detecting a missing GitNexus and installing one on request.",
+  "version": "0.1.3",
+  "description": "DSH plugin: visualize a GitNexus project index, search its symbols by keyword, report what it left out, and run its incremental refresh from a sidebar panel — including detecting a missing GitNexus and installing one on request.",
   "type": "module",
   "license": "MIT",
   "repository": {
@@ -38,6 +38,7 @@
     "scripts/link-runtime.mjs",
     "cordis.patch.yml",
     "README.md",
+    "README-CN.md",
     "LICENSE"
   ],
   "engines": {