sv-router 0.0.2 → 0.0.4

package/dist/helpers/validate-routes.js

@@ -1,34 +0,0 @@
-export function validateRoutes(routes) {
-    const paths = getRoutePaths(routes);
-    const wildcardPaths = paths.filter((path) => path.endsWith('*'));
-    for (const wildcardPath of wildcardPaths) {
-        const parentPath = wildcardPath.slice(0, -1);
-        const dynamicPath = paths.find((p) => p !== '/' &&
-            !p.endsWith('*') &&
-            p.startsWith(parentPath === '' ? '/:' : parentPath) &&
-            p.match(/:[^/]*$/g));
-        if (dynamicPath) {
-            console.warn(`Router warning: Wildcard route \`${wildcardPath}\` should not be at the same level as dynamic route \`${dynamicPath}\`.`);
-        }
-    }
-}
-export function getRoutePaths(routes) {
-    const paths = [];
-    for (const [key, value] of Object.entries(routes)) {
-        if (typeof value === 'object') {
-            paths.push(...getRoutePaths(value).map((path) => {
-                if (path === '*') {
-                    return key + '/*';
-                }
-                if (path === '/') {
-                    return key;
-                }
-                return key + path;
-            }));
-        }
-        else {
-            paths.push(key);
-        }
-    }
-    return paths;
-}

package/dist/helpers/validate-routes.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/helpers/validate-routes.test.js

@@ -1,67 +0,0 @@
-import { getRoutePaths, validateRoutes } from "./validate-routes.js";
-const component = (() => ({}));
-const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(vi.fn());
-beforeEach(() => {
-    vi.clearAllMocks();
-});
-describe('validateRoutes', () => {
-    it('should validate routes', () => {
-        validateRoutes({
-            '/': component,
-            '/about': component,
-            '/posts': {
-                '/': component,
-                '/:id': component,
-            },
-            '*': component,
-        });
-        expect(consoleSpy).not.toHaveBeenCalled();
-    });
-    it('should raise a warning if a wildcard route is at the same level as a dynamic route', () => {
-        validateRoutes({
-            '/': component,
-            '/:id': component,
-            '*': component,
-        });
-        expect(consoleSpy).toHaveBeenCalledWith('Router warning: Wildcard route `*` should not be at the same level as dynamic route `/:id`.');
-    });
-    it.each([
-        {
-            '/': component,
-            '/posts/*': component,
-            '/posts/:id': component,
-            '/:id': component,
-            '*': component,
-        },
-        {
-            '/': component,
-            '/posts': {
-                '*': component,
-                '/:id': component,
-            },
-            '/:id': component,
-            '*': component,
-        },
-    ])('should raise multiple warnings if wildcard routes are at the same level as dynamic routes', (routes) => {
-        validateRoutes(routes);
-        expect(consoleSpy).toHaveBeenCalledTimes(2);
-        expect(consoleSpy).toHaveBeenCalledWith('Router warning: Wildcard route `*` should not be at the same level as dynamic route `/:id`.');
-        expect(consoleSpy).toHaveBeenCalledWith('Router warning: Wildcard route `/posts/*` should not be at the same level as dynamic route `/posts/:id`.');
-    });
-});
-describe('getRoutePaths', () => {
-    it('should return all paths in an array', () => {
-        const result = getRoutePaths({
-            '/': component,
-            '/about': component,
-            '/posts': {
-                '/': component,
-                '/:id': component,
-                '*': component,
-            },
-            '/foo/bar': component,
-            '*': component,
-        });
-        expect(result).toEqual(['/', '/about', '/posts', '/posts/:id', '/posts/*', '/foo/bar', '*']);
-    });
-});

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export { default as Router } from './Router.svelte';
-export { createRouter } from './router.svelte.ts';

package/dist/index.js

@@ -1,2 +0,0 @@
-export { default as Router } from './Router.svelte';
-export { createRouter } from "./router.svelte.js";

package/dist/router.svelte.d.ts

@@ -1,13 +0,0 @@
-import type { Component } from 'svelte';
-import { type ConstructPathArgs } from './helpers/utils.ts';
-import type { AllParams, Path, Routes } from './types/types.ts';
-export declare let routes: Routes;
-export declare const componentTree: Component<{}, {}, string>[];
-export declare const paramsStore: Record<string, string>;
-export declare function createRouter<T extends Routes>(r: T): {
-    path<U extends Path<T>>(...args: ConstructPathArgs<U>): string;
-    goto<U extends Path<T>>(...args: ConstructPathArgs<U>): void;
-    params(): AllParams<T>;
-};
-export declare function onNavigate(): void;
-export declare function onGlobalClick(event: Event): void;

package/dist/router.svelte.js

@@ -1,49 +0,0 @@
-import { BROWSER, DEV } from 'esm-env';
-import { matchRoute } from "./helpers/match-route.js";
-import { constructPath, resolveRouteComponents } from "./helpers/utils.js";
-export let routes;
-export const componentTree = $state([]);
-export const paramsStore = $state({});
-export function createRouter(r) {
-    routes = r;
-    if (DEV && BROWSER) {
-        import('./helpers/validate-routes.js').then(({ validateRoutes }) => {
-            validateRoutes(routes);
-        });
-    }
-    return {
-        path(...args) {
-            return constructPath(...args);
-        },
-        goto(...args) {
-            const path = constructPath(...args);
-            globalThis.history.pushState({}, '', path);
-            onNavigate();
-        },
-        params() {
-            const readonly = $derived(paramsStore);
-            return readonly;
-        },
-    };
-}
-export function onNavigate() {
-    const { match, layouts, params } = matchRoute(globalThis.location.pathname, routes);
-    resolveRouteComponents(match ? [...layouts, match] : layouts).then((components) => {
-        Object.assign(componentTree, components);
-    });
-    Object.assign(paramsStore, params);
-}
-export function onGlobalClick(event) {
-    const anchor = event.target.closest('a');
-    if (!anchor)
-        return;
-    if (anchor.hasAttribute('target') || anchor.hasAttribute('download'))
-        return;
-    const url = new URL(anchor.href);
-    const currentOrigin = globalThis.location.origin;
-    if (url.origin !== currentOrigin)
-        return;
-    event.preventDefault();
-    globalThis.history.pushState({}, '', anchor.href);
-    onNavigate();
-}

package/dist/types/test-types.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/test-types.js

@@ -1 +0,0 @@
-export {};

package/dist/types/types.d.ts

@@ -1,26 +0,0 @@
-import type { Component, Snippet } from 'svelte';
-type BaseProps = Record<string, any>;
-export type LazyRouteComponent<Props extends BaseProps = BaseProps> = () => Promise<{
-    default: Component<Props>;
-}>;
-export type RouteComponent<Props extends BaseProps = BaseProps> = Component<Props> | LazyRouteComponent<Props>;
-export type LayoutComponent = RouteComponent<{
-    children: Snippet;
-}>;
-export type Routes = {
-    [_: `/${string}`]: RouteComponent | Routes;
-    '*'?: RouteComponent;
-    layout?: LayoutComponent;
-};
-export type Path<T extends Routes> = RemoveLastSlash<RecursiveKeys<StripNonRoutes<T>>>;
-export type PathParams<T extends string> = ExtractParams<T> extends never ? never : Record<ExtractParams<T>, string>;
-export type AllParams<T extends Routes> = Partial<Record<ExtractParams<RecursiveKeys<T>>, string>>;
-type StripNonRoutes<T extends Routes> = {
-    [K in keyof T as K extends '*' ? never : K extends 'layout' ? never : K]: T[K] extends Routes ? StripNonRoutes<T[K]> : T[K];
-};
-type RecursiveKeys<T extends Routes, Prefix extends string = ''> = {
-    [K in keyof T]: K extends string ? T[K] extends Routes ? RecursiveKeys<T[K], `${Prefix}${K}`> : `${Prefix}${K}` : never;
-}[keyof T];
-type RemoveLastSlash<T extends string> = T extends '/' ? T : T extends `${infer R}/` ? R : T;
-type ExtractParams<T extends string> = T extends `${string}:${infer Param}/${infer Rest}` ? Param | ExtractParams<`/${Rest}`> : T extends `${string}:${infer Param}` ? Param : never;
-export {};

package/dist/types/types.js

@@ -1 +0,0 @@
-export {};

package/dist/vite-plugin/index.d.ts

@@ -1 +0,0 @@
-export { router } from './plugin.ts';

package/dist/vite-plugin/index.js

@@ -1 +0,0 @@
-export { router } from "./plugin.js";

package/dist/vite-plugin/plugin.d.ts

@@ -1,2 +0,0 @@
-import type { Plugin } from 'vite';
-export declare function router(): Plugin;

package/dist/vite-plugin/plugin.js

@@ -1,31 +0,0 @@
-import path from 'node:path';
-import { GEN_CODE_ALIAS, ROUTER_PATH, ROUTES_PATH } from "../common.js";
-import { writeRouterCode } from "../gen/write-router-code.js";
-export function router() {
-    return {
-        name: 'sv-router',
-        config(config) {
-            if (!config.resolve) {
-                config.resolve = {};
-            }
-            if (!config.resolve.alias) {
-                config.resolve.alias = {};
-            }
-            const replacement = path.resolve(process.cwd(), ROUTER_PATH);
-            if (Array.isArray(config.resolve.alias)) {
-                config.resolve.alias.push({ find: GEN_CODE_ALIAS, replacement });
-            }
-            else {
-                config.resolve.alias[GEN_CODE_ALIAS] = replacement;
-            }
-        },
-        buildStart() {
-            writeRouterCode();
-        },
-        watchChange(file) {
-            if (file.includes(ROUTES_PATH)) {
-                writeRouterCode();
-            }
-        },
-    };
-}