@skyramp/mcp 0.3.8 → 0.4.0-rc.1

package/build/utils/screenRoutes.d.ts

@@ -0,0 +1,66 @@
+/** One route that renders the queried file, with the import path that proves it. */
+export interface ScreenRouteCandidate {
+    /** The route pattern, in the framework's own spelling. */
+    routePattern: string;
+    /** Route entry file first, queried file last. The EVIDENCE for `routePattern`:
+     *  a caller can read the chain and check the claim instead of trusting it. */
+    mountChain: string[];
+}
+/** A framework that routes by file path. */
+export type FrameworkKind = "next" | "nuxt" | "sveltekit";
+/**
+ * Which framework routes which part of the repository, as directory -> framework,
+ * the directory being repository-relative posix and `""` for the root.
+ *
+ * Reads the file list the index already walked, so it inherits that walk's skip
+ * list and caps and costs no I/O. Locating the config beats a list of likely
+ * directories: a frontend under `packages/` is as common as one under `apps/`,
+ * and the config's directory is also the only honest bound on which files the
+ * framework owns when a repository holds more than one app.
+ *
+ * Exported for the convention matrix in the tests; nothing else calls it.
+ */
+export declare function detectFrameworkRoots(files: string[]): Map<string, FrameworkKind>;
+/**
+ * The URL `relativePath` serves under `framework`, or undefined when the file is
+ * not a page in that framework's convention. `relativePath` is relative to the
+ * framework root, not to the repository.
+ *
+ * The conventions are kept PER FRAMEWORK because they disagree. Route groups
+ * `(shop)` vanish from the URL in the Next app router and in SvelteKit, and are a
+ * literal directory name in the Next pages router and in Nuxt. An underscore
+ * names a parameter in Nuxt 2 and marks a non-route file in Next. Pooling the
+ * rules produced URLs no framework serves.
+ *
+ * Exported for the convention matrix in the tests; `fileSystemRouteEntries` is
+ * the only caller in this module.
+ */
+export declare function frameworkRouteFor(relativePath: string, framework: FrameworkKind): string | undefined;
+/** One repository's scan, asked more than one kind of question. */
+export interface ScreenRouteLookup {
+    /** The routes that render a file, with the import chain that proves each. */
+    candidatesFor(relativePath: string): ScreenRouteCandidate[] | undefined;
+    /** Every route pattern the scan found, in no particular order. Empty when the
+     *  scan cannot speak for the repository at all. Used to work out which route the
+     *  browser's current url belongs to, which is a question about the repository
+     *  rather than about any one file. */
+    routePatterns(): string[];
+}
+/**
+ * A lookup bound to one repository. The index is built on the first question and
+ * reused for the rest, so a plan with ten UI tests scans the repository once.
+ *
+ * Fails closed: any error anywhere becomes `undefined`. A scan is best-effort, and
+ * its failure is not evidence about the file it was asked about.
+ */
+export declare function createScreenRouteLookup(repositoryPath: string): ScreenRouteLookup;
+/** The routes for a file, without the evidence. */
+export declare function createScreenRouteResolver(repositoryPath: string): (relativePath: string) => string[] | undefined;
+/** The same answer with its evidence: every route, and the import chain that
+ *  reaches the file from that route's entry file. */
+export declare function createScreenRouteCandidateResolver(repositoryPath: string): (relativePath: string) => ScreenRouteCandidate[] | undefined;
+/** One question, one scan. Convenience over {@link createScreenRouteResolver} for
+ *  callers that ask about a single file. */
+export declare function resolveScreenRoutes(repositoryPath: string, relativePath: string): string[] | undefined;
+/** One question, one scan, with the mount chains. */
+export declare function resolveScreenRouteCandidates(repositoryPath: string, relativePath: string): ScreenRouteCandidate[] | undefined;