uidex 0.3.0 → 0.4.0

package/dist/scan/index.d.cts

@@ -31,11 +31,16 @@ interface Route {
     path: string;
     page: string;
 }
+interface FlowStep {
+    entityId: string;
+    action?: string;
+}
 interface Flow {
     kind: "flow";
     id: string;
     loc: Location;
     touches: string[];
+    steps: FlowStep[];
 }
 interface Page extends EntityWithMetaBase {
     kind: "page";

package/dist/scan/index.d.ts

@@ -31,11 +31,16 @@ interface Route {
     path: string;
     page: string;
 }
+interface FlowStep {
+    entityId: string;
+    action?: string;
+}
 interface Flow {
     kind: "flow";
     id: string;
     loc: Location;
     touches: string[];
+    steps: FlowStep[];
 }
 interface Page extends EntityWithMetaBase {
     kind: "page";

package/dist/scan/index.js

@@ -4,6 +4,10 @@ import * as path from "path";
 
 // src/scan/config.ts
 var DEFAULT_TYPE_MODE = "strict";
+var WELL_KNOWN_FILES = {
+  page: "uidex.page.ts",
+  feature: "uidex.feature.ts"
+};
 var ConfigError = class extends Error {
   constructor(message) {
     super(message);
@@ -41,14 +45,14 @@ var ALLOWED_AUDIT_KEYS = /* @__PURE__ */ new Set(["scopeLeak", "coverage", "acce
 function fail(msg) {
   throw new ConfigError(`Invalid .uidex.json: ${msg}`);
 }
-function assertObject(value, path9) {
+function assertObject(value, path10) {
   if (value === null || typeof value !== "object" || Array.isArray(value)) {
-    fail(`${path9} must be an object`);
+    fail(`${path10} must be an object`);
   }
 }
-function assertStringArray(value, path9) {
+function assertStringArray(value, path10) {
   if (!Array.isArray(value) || !value.every((v) => typeof v === "string")) {
-    fail(`${path9} must be a string[]`);
+    fail(`${path10} must be a string[]`);
   }
 }
 function validateConfig(raw) {
@@ -1769,7 +1773,24 @@ function resolve2(ctx) {
   const routes = conventions.pages === "auto" ? detectRoutes(ctx.extracted.map((e) => e.file)) : [];
   const handledPageFiles = /* @__PURE__ */ new Set();
   for (const route of routes) {
-    const exp = exportFor(route.file, "page");
+    const routeDir = path3.posix.dirname(route.file);
+    const wellKnownPath = `${routeDir}/${WELL_KNOWN_FILES.page}`;
+    const wellKnownExp = exportFor(wellKnownPath, "page");
+    const routeExp = exportFor(route.file, "page");
+    const exp = wellKnownExp ?? routeExp;
+    const locFile = wellKnownExp ? wellKnownPath : route.file;
+    if (wellKnownExp) handledPageFiles.add(wellKnownPath);
+    handledPageFiles.add(route.file);
+    if (wellKnownExp && routeExp) {
+      diagnostics.push({
+        code: "competing-uidex-export",
+        severity: "warning",
+        message: `Page metadata declared in both ${wellKnownPath} and ${route.file}; ${wellKnownPath} takes precedence.`,
+        file: route.file,
+        line: routeExp.loc.line,
+        hint: `Remove the export from ${route.file} or delete ${wellKnownPath}.`
+      });
+    }
     if (exp && exp.id === false) continue;
     const effectiveId = exp && typeof exp.id === "string" ? exp.id : route.id;
     const meta = exp ? buildMetaFromExport(exp) : void 0;
@@ -1777,11 +1798,10 @@ function resolve2(ctx) {
     const page = {
       kind: "page",
       id: effectiveId,
-      loc: { file: route.file, line: exp?.loc.line },
+      loc: { file: locFile, line: exp?.loc.line },
       ...meta ? { meta } : {}
     };
     registry.add(page);
-    handledPageFiles.add(route.file);
   }
   for (const ef of ctx.extracted) {
     const exp = exportFor(ef.file.displayPath, "page");
@@ -1797,7 +1817,8 @@ function resolve2(ctx) {
   }
   const featureGlob = typeof conventions.features === "string" ? conventions.features : null;
   const conventionalFeatureDirs = /* @__PURE__ */ new Set();
-  const featureExportsByDir = /* @__PURE__ */ new Map();
+  const featureExportFilesByDir = /* @__PURE__ */ new Map();
+  const wellKnownFeatureFileByDir = /* @__PURE__ */ new Map();
   const suppressedFeatureDirs = /* @__PURE__ */ new Set();
   if (featureGlob) {
     const re = globToRegExp(featureGlob + "/**");
@@ -1806,16 +1827,43 @@ function resolve2(ctx) {
       const dir = extractFeatureDir(ef.file.displayPath, featureGlob);
       if (!dir) continue;
       conventionalFeatureDirs.add(dir);
+      const isWellKnown = path3.posix.basename(ef.file.displayPath) === WELL_KNOWN_FILES.feature;
+      if (isWellKnown) wellKnownFeatureFileByDir.set(dir, ef.file.displayPath);
       const exp = exportFor(ef.file.displayPath, "feature");
       if (exp) {
         if (exp.id === false) suppressedFeatureDirs.add(dir);
-        else if (!featureExportsByDir.has(dir))
-          featureExportsByDir.set(dir, exp);
+        else {
+          let arr = featureExportFilesByDir.get(dir);
+          if (!arr) {
+            arr = [];
+            featureExportFilesByDir.set(dir, arr);
+          }
+          arr.push({ file: ef.file.displayPath, exp });
+        }
       }
     }
     for (const dir of conventionalFeatureDirs) {
       if (suppressedFeatureDirs.has(dir)) continue;
-      const exp = featureExportsByDir.get(dir);
+      const allExports = featureExportFilesByDir.get(dir) ?? [];
+      const wellKnownPath = wellKnownFeatureFileByDir.get(dir);
+      const wellKnownEntry = wellKnownPath ? allExports.find((e) => e.file === wellKnownPath) : void 0;
+      let exp;
+      if (wellKnownEntry) {
+        exp = wellKnownEntry.exp;
+        for (const other of allExports) {
+          if (other.file === wellKnownEntry.file) continue;
+          diagnostics.push({
+            code: "competing-uidex-export",
+            severity: "warning",
+            message: `Feature metadata declared in both ${wellKnownEntry.file} and ${other.file}; ${wellKnownEntry.file} takes precedence.`,
+            file: other.file,
+            line: other.exp.loc.line,
+            hint: `Remove the export from ${other.file} or delete ${wellKnownEntry.file}.`
+          });
+        }
+      } else if (allExports.length > 0) {
+        exp = allExports[0].exp;
+      }
       const id = exp && typeof exp.id === "string" ? exp.id : path3.posix.basename(dir);
       const meta = exp ? buildMetaFromExport(exp) : void 0;
       const feature = {
@@ -1948,11 +1996,12 @@ function resolve2(ctx) {
         exp.id,
         buildMetaFromExport(exp)
       );
+      const scope = computeScope(file);
       const primitive = {
         kind: "primitive",
         id: exp.id,
         loc: { file, line: exp.loc.line },
-        scopes: [computeScope(file)],
+        ...scope ? { scopes: [scope] } : {},
         ...meta ? { meta } : {}
       };
       registry.add(primitive);
@@ -1964,11 +2013,12 @@ function resolve2(ctx) {
     if (domPrimitives.length > 0) {
       for (const p2 of domPrimitives) {
         const meta = metaWithComposes("primitive", p2.id);
+        const domScope = computeScope(p2.file);
         const primitive = {
           kind: "primitive",
           id: p2.id,
           loc: { file: p2.file, line: p2.line },
-          scopes: [computeScope(p2.file)],
+          ...domScope ? { scopes: [domScope] } : {},
           ...meta ? { meta } : {}
         };
         registry.add(primitive);
@@ -1978,13 +2028,13 @@ function resolve2(ctx) {
     if (primitiveConventions && fileMatchesAny(file, primitiveConventions)) {
       const name = kebab(baseName(file));
       if (!name) continue;
-      const scope = computeScope(file);
+      const convScope = computeScope(file);
       const meta = metaWithComposes("primitive", name);
       const primitive = {
         kind: "primitive",
         id: name,
         loc: { file },
-        scopes: [scope],
+        ...convScope ? { scopes: [convScope] } : {},
         ...meta ? { meta } : {}
       };
       registry.add(primitive);
@@ -2014,7 +2064,8 @@ function resolve2(ctx) {
           kind: "flow",
           id: flowExport.id,
           loc: base.loc,
-          touches: base.touches
+          touches: base.touches,
+          steps: base.steps
         };
         registry.add(flow);
       } else {
@@ -2059,7 +2110,7 @@ function computeScope(displayPath) {
   if (pagesIdx !== -1 && parts[pagesIdx + 1]) {
     return `page:${parts[pagesIdx + 1]}`;
   }
-  return "global";
+  return null;
 }
 function extractFlowsFromSource(file) {
   const flows = [];
@@ -2093,17 +2144,18 @@ function extractFlowsFromSource(file) {
       kind: "flow",
       id,
       loc: { file: file.displayPath, line },
-      touches: dedupe(touches.map((t) => t.id))
+      touches: dedupe(touches.map((t) => t.id)),
+      steps: touches.filter((t) => t.action).map((t) => ({ entityId: t.id, action: t.action }))
     });
   }
   return flows;
 }
 function captureUidexIds(body) {
   const out2 = [];
-  const re = /uidex\(\s*(?:'([^']+)'|"([^"]+)"|`([^`$]+)`)\s*\)/g;
+  const re = /uidex\(\s*(?:'([^']+)'|"([^"]+)"|`([^`$]+)`)\s*\)(?:\.(\w+)\s*\()?/g;
   let m;
   while ((m = re.exec(body)) !== null) {
-    out2.push({ id: m[1] || m[2] || m[3] });
+    out2.push({ id: m[1] || m[2] || m[3], action: m[4] });
   }
   return out2;
 }
@@ -2112,6 +2164,7 @@ function dedupe(arr) {
 }
 
 // src/scan/audit.ts
+import * as path4 from "path";
 var MARKER_FILENAMES = ["UIDEX_PAGE.md", "UIDEX_FEATURE.md"];
 function audit(opts) {
   const diagnostics = [];
@@ -2213,6 +2266,32 @@ function audit(opts) {
       }
     }
   }
+  if (lint) {
+    const scannedPaths = new Set(files.map((f) => f.displayPath));
+    for (const ef of extracted) {
+      if (!ef.metadata) continue;
+      for (const m of ef.metadata) {
+        if (m.kind !== "page" && m.kind !== "feature") continue;
+        if (typeof m.id !== "string") continue;
+        const filePath = ef.file.displayPath;
+        const wellKnownName = WELL_KNOWN_FILES[m.kind];
+        if (path4.posix.basename(filePath) === wellKnownName) continue;
+        const dir = path4.posix.dirname(filePath);
+        const wellKnownPath = dir === "." ? wellKnownName : `${dir}/${wellKnownName}`;
+        if (scannedPaths.has(wellKnownPath)) continue;
+        const kindLabel = m.kind === "page" ? "Page" : "Feature";
+        diagnostics.push({
+          code: "prefer-well-known-file",
+          severity: "info",
+          message: `${kindLabel} "${m.id}" metadata lives on ${filePath}; prefer ${wellKnownPath}`,
+          file: filePath,
+          line: m.loc.line,
+          entity: { kind: m.kind, id: m.id },
+          hint: `Move the \`export const uidex\` block to ${wellKnownPath} and remove it from ${filePath}.`
+        });
+      }
+    }
+  }
   if (lint) {
     for (const f of files) {
       const lines = f.content.split("\n");
@@ -2249,8 +2328,8 @@ function audit(opts) {
           baseName2.replace(/\.(tsx|ts|jsx|js|mjs|cjs)$/, "").replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase()
         );
         if (!primitive) continue;
-        const scope = primitive.scopes?.[0] ?? "global";
-        if (scope === "global") continue;
+        const scope = primitive.scopes?.[0];
+        if (!scope) continue;
         const [kind, id] = scope.split(":");
         const importerSegments = f.displayPath.split("/");
         if (!importerSegments.includes(id) || !importerSegments.includes(kind + "s")) {
@@ -2648,7 +2727,7 @@ function parseGitHubRef(ref) {
 
 // src/scan/scaffold.ts
 import * as fs3 from "fs";
-import * as path4 from "path";
+import * as path5 from "path";
 function scaffoldWidgetSpec(opts) {
   const {
     registry,
@@ -2663,7 +2742,7 @@ function scaffoldWidgetSpec(opts) {
   }
   const criteria = widget.meta?.acceptance ?? [];
   const filename = `widget-${widgetId}.spec.ts`;
-  const outputPath = path4.resolve(outDir, filename);
+  const outputPath = path5.resolve(outDir, filename);
   if (fs3.existsSync(outputPath) && !force) {
     return {
       outputPath,
@@ -2677,7 +2756,7 @@ function scaffoldWidgetSpec(opts) {
     criteria,
     fixtureImport
   });
-  fs3.mkdirSync(path4.dirname(outputPath), { recursive: true });
+  fs3.mkdirSync(path5.dirname(outputPath), { recursive: true });
   fs3.writeFileSync(outputPath, content, "utf8");
   return { outputPath, written: true, skipped: false };
 }
@@ -2711,7 +2790,7 @@ function renderSpec(args) {
 
 // src/scan/pipeline.ts
 import * as fs4 from "fs";
-import * as path5 from "path";
+import * as path6 from "path";
 function runScan(opts = {}) {
   const cwd = opts.cwd ?? process.cwd();
   const configs = opts.configs ?? discover({ cwd });
@@ -2743,7 +2822,7 @@ function runOne(dc, opts) {
     gitContext,
     typeMode: config.typeMode
   });
-  const outputPath = path5.resolve(configDir, config.output);
+  const outputPath = path6.resolve(configDir, config.output);
   const outputRel = config.output;
   let existingOnDisk = null;
   if (opts.check) {
@@ -2779,29 +2858,29 @@ function runOne(dc, opts) {
   };
 }
 function writeScanResult(result) {
-  fs4.mkdirSync(path5.dirname(result.outputPath), { recursive: true });
+  fs4.mkdirSync(path6.dirname(result.outputPath), { recursive: true });
   fs4.writeFileSync(result.outputPath, result.generated, "utf8");
 }
 
 // src/scan/cli.ts
 import * as fs7 from "fs";
-import * as path8 from "path";
+import * as path9 from "path";
 
 // src/scan/ai/index.ts
 import * as p from "@clack/prompts";
 
 // src/scan/ai/providers/claude.ts
 import * as fs6 from "fs";
-import * as path7 from "path";
+import * as path8 from "path";
 
 // src/scan/ai/templates.ts
 import * as fs5 from "fs";
-import * as path6 from "path";
+import * as path7 from "path";
 function templatePath(rel) {
   const candidates = [
-    path6.resolve(__dirname, "../../templates", rel),
+    path7.resolve(__dirname, "../../templates", rel),
     // dist/cli/cli.cjs    → ../../templates
-    path6.resolve(__dirname, "../../../templates", rel)
+    path7.resolve(__dirname, "../../../templates", rel)
     // src/scan/ai/foo.ts → ../../../templates
   ];
   for (const c of candidates) {
@@ -2833,7 +2912,7 @@ var claudeProvider = {
   async install({ cwd, force }) {
     const changes = [];
     for (const file of CLAUDE_FILES) {
-      const dest = path7.join(cwd, file.dest);
+      const dest = path8.join(cwd, file.dest);
       const exists = fs6.existsSync(dest);
       if (exists && !force) {
         changes.push({
@@ -2843,7 +2922,7 @@ var claudeProvider = {
         });
         continue;
       }
-      fs6.mkdirSync(path7.dirname(dest), { recursive: true });
+      fs6.mkdirSync(path8.dirname(dest), { recursive: true });
       fs6.writeFileSync(dest, readTemplate(file.template));
       changes.push({
         path: file.dest,
@@ -2855,7 +2934,7 @@ var claudeProvider = {
   async uninstall({ cwd }) {
     const changes = [];
     for (const file of CLAUDE_FILES) {
-      const dest = path7.join(cwd, file.dest);
+      const dest = path8.join(cwd, file.dest);
       if (!fs6.existsSync(dest)) {
         changes.push({ path: file.dest, action: "skipped", reason: "absent" });
         continue;
@@ -2863,9 +2942,9 @@ var claudeProvider = {
       fs6.unlinkSync(dest);
       changes.push({ path: file.dest, action: "removed" });
     }
-    cleanupEmpty(path7.join(cwd, ".claude/commands/uidex"));
-    cleanupEmpty(path7.join(cwd, ".claude/commands"));
-    cleanupEmpty(path7.join(cwd, ".claude/rules"));
+    cleanupEmpty(path8.join(cwd, ".claude/commands/uidex"));
+    cleanupEmpty(path8.join(cwd, ".claude/commands"));
+    cleanupEmpty(path8.join(cwd, ".claude/rules"));
     return { changes };
   }
 };
@@ -3076,7 +3155,7 @@ function helpText2() {
   ].join("\n");
 }
 function runInit(cwd, w) {
-  const configPath = path8.join(cwd, CONFIG_FILENAME);
+  const configPath = path9.join(cwd, CONFIG_FILENAME);
   if (fs7.existsSync(configPath)) {
     w.err(`.uidex.json already exists at ${configPath}`);
     return w.result(1);
@@ -3088,7 +3167,7 @@ function runInit(cwd, w) {
   };
   fs7.writeFileSync(configPath, JSON.stringify(config, null, 2) + "\n", "utf8");
   w.out(`Created ${configPath}`);
-  const gitignorePath = path8.join(cwd, ".gitignore");
+  const gitignorePath = path9.join(cwd, ".gitignore");
   const entry = "*.gen.ts";
   if (fs7.existsSync(gitignorePath)) {
     const existing = fs7.readFileSync(gitignorePath, "utf8");
@@ -3166,7 +3245,7 @@ function runScaffold(cwd, args, flags, w) {
   for (const r of results) {
     const widget = r.registry.get("widget", id);
     if (!widget) continue;
-    const outDir = path8.resolve(r.configDir, "e2e");
+    const outDir = path9.resolve(r.configDir, "e2e");
     const result = scaffoldWidgetSpec({
       registry: r.registry,
       widgetId: id,