@solidjs/router 0.17.0-next.6 → 1.0.0-next.11

package/dist/fs.d.ts

@@ -0,0 +1,53 @@
+import type { RouteSectionComponent } from "./types.js";
+/** A code-split module ref: delivered as a dynamic import. */
+export interface FileRouteLazyRef<M = Record<string, unknown>> {
+    src: string;
+    import(): Promise<M>;
+}
+/** An eager module ref: its picked exports are imported statically. */
+export interface FileRouteEagerRef<M = Record<string, unknown>> {
+    require(): M;
+}
+/** The shape of a nested route-manifest entry the adapter consumes. */
+export interface FileRouteEntry {
+    path: string;
+    page?: boolean;
+    $component?: FileRouteLazyRef<any> | undefined;
+    $$route?: FileRouteEagerRef<any> | undefined;
+    children?: readonly FileRouteEntry[] | undefined;
+}
+type RouteConfigOf<E> = E extends {
+    $$route: {
+        require(): {
+            route: infer R;
+        };
+    };
+} ? R : {};
+/**
+ * One manifest entry as a route definition. `children` is a required key on
+ * purpose: an optional key infers as `C | undefined`, and that union
+ * distributes `RoutePaths` into an uncallable shape.
+ */
+export type FileRouteFrom<E> = RouteConfigOf<E> & {
+    path: E extends {
+        path: infer P extends string;
+    } ? P : never;
+    component: E extends {
+        $component: object;
+    } ? RouteSectionComponent : undefined;
+    children: E extends {
+        children: infer C extends readonly FileRouteEntry[];
+    } ? FileRoutesFrom<C> : undefined;
+};
+export type FileRoutesFrom<T extends readonly FileRouteEntry[]> = {
+    [K in keyof T]: FileRouteFrom<T[K]>;
+};
+/**
+ * Converts the nested page entries of a file-system route manifest into
+ * route definitions: `$component` refs become code-split `lazy` components
+ * (their `src` doubles as the `moduleUrl` core resolves assets and islands
+ * against), and each entry's `route` config export is spread into its
+ * definition. Pass the result to `createRouter({ routes })`.
+ */
+export declare function fileRoutes<const T extends readonly FileRouteEntry[]>(entries: T): FileRoutesFrom<T>;
+export {};

package/dist/fs.js

@@ -0,0 +1,30 @@
+import { lazy } from "solid-js";
+/**
+ * Converts the nested page entries of a file-system route manifest into
+ * route definitions: `$component` refs become code-split `lazy` components
+ * (their `src` doubles as the `moduleUrl` core resolves assets and islands
+ * against), and each entry's `route` config export is spread into its
+ * definition. Pass the result to `createRouter({ routes })`.
+ */
+export function fileRoutes(entries) {
+    const components = new Map();
+    const componentOf = (ref) => {
+        let component = components.get(ref.src);
+        if (!component) {
+            component = lazy(ref.import, ref.src);
+            components.set(ref.src, component);
+        }
+        return component;
+    };
+    const toRoute = (entry) => {
+        const config = (entry.$$route?.require().route ?? {});
+        return {
+            ...config,
+            path: entry.path,
+            component: entry.$component ? componentOf(entry.$component) : undefined,
+            info: { ...config.info, filesystem: true },
+            children: entry.children ? entry.children.map(toRoute) : undefined
+        };
+    };
+    return entries.map(toRoute);
+}

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 export * from "./routers/index.js";
-export * from "./components.jsx";
 export * from "./lifecycle.js";
-export { useHref, useIsRouting, useLocation, useMatch, useCurrentMatches, useNavigate, useParams, useResolvedPath, useSearchParams, useBeforeLeave, usePreloadRoute, RouterContextObj as RouterContext } from "./routing.js";
+export { useHref, useIsRouting, useLinkState, useLocation, useMatch, useNavigate, usePreloadRoute, useParams, useResolvedPath, useRouteMatches, useSearchParams, RouterContextObj as RouterContext } from "./routing.js";
+export type { LinkState } from "./routing.js";
 export { mergeSearchString as _mergeSearchString } from "./utils.js";
+export { int } from "./paths.js";
+export type { RoutePaths, PathParamsOf, PathEnd, TypedMatchFilter, DefaultSearchTypes } from "./paths.js";
 export * from "./data/index.js";
-export type { Location, LocationChange, SearchParams, MatchFilter, MatchFilters, NavigateOptions, Navigator, OutputMatch, Params, PathMatch, RouteSectionProps, RoutePreloadFunc, RoutePreloadFuncArgs, RouteDefinition, RouteDescription, RouteMatch, RouterIntegration, RouterUtils, SetParams, Submission, BeforeLeaveEventArgs } from "./types.js";
+export type { Location, LocationChange, SearchParams, MatchFilter, MatchFilters, NavigateOptions, Navigator, OutputMatch, Params, PathMatch, RouteSectionProps, RoutePreloadFunc, RoutePreloadFuncArgs, RouteDefinition, RouteDescription, RouteMatch, RouterIntegration, RouterUtils, SetParams, SetSearchParams, Submission, BeforeLeaveEventArgs, TypedPath, TypedSearchPath, StandardSchemaV1 } from "./types.js";