@zap-js/client 0.0.2 → 0.0.4

package/dist/router/scanner.d.ts

@@ -0,0 +1,86 @@
+/**
+ * Route file scanner for ZapJS (Next.js style conventions)
+ *
+ * File Routing Conventions:
+ * - index.tsx          → /
+ * - about.tsx          → /about
+ * - [param].tsx        → /:param (required dynamic segment)
+ * - [param]?.tsx       → /:param? (optional dynamic segment)
+ * - [...slug].tsx      → /*slug (catch-all)
+ * - [[...slug]].tsx    → /*slug? (optional catch-all)
+ * - posts.[id].tsx     → /posts/:id
+ * - _layout.tsx        → Layout scoped to directory segment
+ * - __root.tsx         → Root layout
+ * - (group)/           → Route group (no URL segment)
+ * - _excluded/         → Excluded from routing (underscore prefix for folders)
+ * - api/*.ts           → API routes (separate folder)
+ * - ws/*.ts            → WebSocket routes (dedicated folder)
+ *
+ * Legacy support: $param syntax is still supported for backwards compatibility
+ */
+import type { ScannedRoute, LayoutRoute, RouteTree, ScanOptions } from './types.js';
+export declare class RouteScanner {
+    private routesDir;
+    private extensions;
+    private includeApi;
+    constructor(options: ScanOptions);
+    /**
+     * Scan the routes directory and build a route tree
+     */
+    scan(): RouteTree;
+    /**
+     * Assign parent layouts to routes based on directory structure
+     */
+    private assignLayouts;
+    private scanDirectory;
+    private scanApiDirectory;
+    /**
+     * Scan dedicated WebSocket folder
+     */
+    private scanWsDirectory;
+    /**
+     * Parse a WebSocket route file
+     */
+    private parseWsRouteFile;
+    /**
+     * Parse a single segment for params
+     *
+     * Supports Next.js style:
+     * - [param]     → :param (required)
+     * - [param]?    → :param? (optional - file-level only)
+     * - [...slug]   → *slug (catch-all)
+     * - [[...slug]] → *slug? (optional catch-all)
+     *
+     * Legacy TanStack style (still supported):
+     * - $param      → :param
+     * - $param?     → :param?
+     * - $...rest    → *rest
+     * - $...rest?   → *rest?
+     */
+    private parseSegment;
+    private parseRouteFile;
+    private parseApiRouteFile;
+    private isRouteFile;
+    private getBaseName;
+    private fileNameToUrlSegment;
+    /**
+     * Split a filename by dots, but preserve bracketed segments
+     * e.g., "posts.[id]" -> ["posts", "[id]"]
+     * e.g., "[...slug]" -> ["[...slug]"]
+     * e.g., "[[...path]]" -> ["[[...path]]"]
+     */
+    private splitPreservingBrackets;
+    private prefixToUrl;
+}
+/**
+ * Convenience function to scan routes
+ */
+export declare function scanRoutes(routesDir: string, options?: Partial<ScanOptions>): RouteTree;
+/**
+ * Convert route tree to a flat list for debugging/display
+ */
+export declare function flattenRoutes(tree: RouteTree): ScannedRoute[];
+/**
+ * Get the parent layout for a route
+ */
+export declare function findParentLayout(route: ScannedRoute, layouts: LayoutRoute[]): LayoutRoute | null;