@solidjs/router 1.0.0 → 2.0.0-next.12

package/dist/data/createAsync.d.ts

@@ -1,32 +0,0 @@
-import { type ReconcileOptions } from "solid-js/store";
-/**
- * As `createAsync` and `createAsyncStore` are wrappers for `createResource`,
- * this type allows to support `latest` field for these primitives.
- * It will be removed in the future.
- */
-export type AccessorWithLatest<T> = {
-    (): T;
-    latest: T;
-};
-export declare function createAsync<T>(fn: (prev: T) => Promise<T>, options: {
-    name?: string;
-    initialValue: T;
-    deferStream?: boolean;
-}): AccessorWithLatest<T>;
-export declare function createAsync<T>(fn: (prev: T | undefined) => Promise<T>, options?: {
-    name?: string;
-    initialValue?: T;
-    deferStream?: boolean;
-}): AccessorWithLatest<T | undefined>;
-export declare function createAsyncStore<T>(fn: (prev: T) => Promise<T>, options: {
-    name?: string;
-    initialValue: T;
-    deferStream?: boolean;
-    reconcile?: ReconcileOptions;
-}): AccessorWithLatest<T>;
-export declare function createAsyncStore<T>(fn: (prev: T | undefined) => Promise<T>, options?: {
-    name?: string;
-    initialValue?: T;
-    deferStream?: boolean;
-    reconcile?: ReconcileOptions;
-}): AccessorWithLatest<T | undefined>;

package/dist/data/createAsync.js

@@ -1,96 +0,0 @@
-/**
- * This is mock of the eventual Solid 2.0 primitive. It is not fully featured.
- */
-import { createResource, sharedConfig, untrack, catchError } from "solid-js";
-import { createStore, reconcile, unwrap } from "solid-js/store";
-import { isServer } from "solid-js/web";
-import { setFunctionName } from "../utils.js";
-export function createAsync(fn, options) {
-    let resource;
-    let prev = () => !resource || resource.state === "unresolved" ? undefined : resource.latest;
-    [resource] = createResource(() => subFetch(fn, catchError(() => untrack(prev), () => undefined)), v => v, options);
-    const resultAccessor = (() => resource());
-    if (options?.name)
-        setFunctionName(resultAccessor, options.name);
-    Object.defineProperty(resultAccessor, "latest", {
-        get() {
-            return resource.latest;
-        }
-    });
-    return resultAccessor;
-}
-export function createAsyncStore(fn, options = {}) {
-    let resource;
-    let prev = () => !resource || resource.state === "unresolved"
-        ? undefined
-        : unwrap(resource.latest);
-    [resource] = createResource(() => subFetch(fn, catchError(() => untrack(prev), () => undefined)), v => v, {
-        ...options,
-        storage: (init) => createDeepSignal(init, options.reconcile)
-    });
-    const resultAccessor = (() => resource());
-    Object.defineProperty(resultAccessor, "latest", {
-        get() {
-            return resource.latest;
-        }
-    });
-    return resultAccessor;
-}
-function createDeepSignal(value, options) {
-    const [store, setStore] = createStore({
-        value: structuredClone(value)
-    });
-    return [
-        () => store.value,
-        (v) => {
-            typeof v === "function" && (v = v());
-            setStore("value", reconcile(structuredClone(v), options));
-            return store.value;
-        }
-    ];
-}
-// mock promise while hydrating to prevent fetching
-class MockPromise {
-    static all() {
-        return new MockPromise();
-    }
-    static allSettled() {
-        return new MockPromise();
-    }
-    static any() {
-        return new MockPromise();
-    }
-    static race() {
-        return new MockPromise();
-    }
-    static reject() {
-        return new MockPromise();
-    }
-    static resolve() {
-        return new MockPromise();
-    }
-    catch() {
-        return new MockPromise();
-    }
-    then() {
-        return new MockPromise();
-    }
-    finally() {
-        return new MockPromise();
-    }
-}
-function subFetch(fn, prev) {
-    if (isServer || !sharedConfig.context)
-        return fn(prev);
-    const ogFetch = fetch;
-    const ogPromise = Promise;
-    try {
-        window.fetch = () => new MockPromise();
-        Promise = MockPromise;
-        return fn(prev);
-    }
-    finally {
-        window.fetch = ogFetch;
-        Promise = ogPromise;
-    }
-}

package/dist/data/response.d.ts

@@ -1,4 +0,0 @@
-import type { RouterResponseInit, CustomResponse } from "../types.js";
-export declare function redirect(url: string, init?: number | RouterResponseInit): CustomResponse<never>;
-export declare function reload(init?: RouterResponseInit): CustomResponse<never>;
-export declare function json<T>(data: T, init?: RouterResponseInit): CustomResponse<T>;

package/dist/data/response.js

@@ -1,42 +0,0 @@
-export function redirect(url, init = 302) {
-    let responseInit;
-    let revalidate;
-    if (typeof init === "number") {
-        responseInit = { status: init };
-    }
-    else {
-        ({ revalidate, ...responseInit } = init);
-        if (typeof responseInit.status === "undefined") {
-            responseInit.status = 302;
-        }
-    }
-    const headers = new Headers(responseInit.headers);
-    headers.set("Location", url);
-    revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-    const response = new Response(null, {
-        ...responseInit,
-        headers: headers
-    });
-    return response;
-}
-export function reload(init = {}) {
-    const { revalidate, ...responseInit } = init;
-    const headers = new Headers(responseInit.headers);
-    revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-    return new Response(null, {
-        ...responseInit,
-        headers
-    });
-}
-export function json(data, init = {}) {
-    const { revalidate, ...responseInit } = init;
-    const headers = new Headers(responseInit.headers);
-    revalidate !== undefined && headers.set("X-Revalidate", revalidate.toString());
-    headers.set("Content-Type", "application/json");
-    const response = new Response(JSON.stringify(data), {
-        ...responseInit,
-        headers
-    });
-    response.customBody = () => data;
-    return response;
-}

package/dist/routers/HashRouter.d.ts

@@ -1,9 +0,0 @@
-import type { JSX } from "solid-js";
-import type { BaseRouterProps } from "./components.jsx";
-export declare function hashParser(str: string): string;
-export type HashRouterProps = BaseRouterProps & {
-    actionBase?: string;
-    explicitLinks?: boolean;
-    preload?: boolean;
-};
-export declare function HashRouter(props: HashRouterProps): JSX.Element;

package/dist/routers/HashRouter.js

@@ -1,41 +0,0 @@
-import { setupNativeEvents } from "../data/events.js";
-import { createRouter, scrollToHash, bindEvent } from "./createRouter.js";
-import { createBeforeLeave, keepDepth, notifyIfNotBlocked, saveCurrentDepth } from "../lifecycle.js";
-export function hashParser(str) {
-    const to = str.replace(/^.*?#/, "");
-    // Hash-only hrefs like `#foo` from plain anchors will come in as `/#foo` whereas a link to
-    // `/foo` will be `/#/foo`. Check if the to starts with a `/` and if not append it as a hash
-    // to the current path so we can handle these in-page anchors correctly.
-    if (!to.startsWith("/")) {
-        const [, path = "/"] = window.location.hash.split("#", 2);
-        return `${path}#${to}`;
-    }
-    return to;
-}
-export function HashRouter(props) {
-    const getSource = () => window.location.hash.slice(1);
-    const beforeLeave = createBeforeLeave();
-    return createRouter({
-        get: getSource,
-        set({ value, replace, scroll, state }) {
-            if (replace) {
-                window.history.replaceState(keepDepth(state), "", "#" + value);
-            }
-            else {
-                window.history.pushState(state, "", "#" + value);
-            }
-            const hashIndex = value.indexOf("#");
-            const hash = hashIndex >= 0 ? value.slice(hashIndex + 1) : "";
-            scrollToHash(hash, scroll);
-            saveCurrentDepth();
-        },
-        init: notify => bindEvent(window, "hashchange", notifyIfNotBlocked(notify, delta => !beforeLeave.confirm(delta && delta < 0 ? delta : getSource()))),
-        create: setupNativeEvents({ preload: props.preload, explicitLinks: props.explicitLinks, actionBase: props.actionBase }),
-        utils: {
-            go: delta => window.history.go(delta),
-            renderPath: path => `#${path}`,
-            parsePath: hashParser,
-            beforeLeave
-        }
-    })(props);
-}

package/dist/routers/MemoryRouter.d.ts

@@ -1,24 +0,0 @@
-import type { LocationChange } from "../types.js";
-import type { BaseRouterProps } from "./components.jsx";
-import type { JSX } from "solid-js";
-export type MemoryHistory = {
-    get: () => string;
-    set: (change: LocationChange) => void;
-    go: (delta: number) => void;
-    listen: (listener: (value: string) => void) => () => void;
-};
-export declare function createMemoryHistory(): {
-    get: () => string;
-    set: ({ value, scroll, replace }: LocationChange) => void;
-    back: () => void;
-    forward: () => void;
-    go: (n: number) => void;
-    listen: (listener: (value: string) => void) => () => void;
-};
-export type MemoryRouterProps = BaseRouterProps & {
-    history?: MemoryHistory;
-    actionBase?: string;
-    explicitLinks?: boolean;
-    preload?: boolean;
-};
-export declare function MemoryRouter(props: MemoryRouterProps): JSX.Element;

package/dist/routers/MemoryRouter.js

@@ -1,57 +0,0 @@
-import { createRouter, scrollToHash } from "./createRouter.js";
-import { setupNativeEvents } from "../data/events.js";
-export function createMemoryHistory() {
-    const entries = ["/"];
-    let index = 0;
-    const listeners = [];
-    const go = (n) => {
-        // https://github.com/remix-run/react-router/blob/682810ca929d0e3c64a76f8d6e465196b7a2ac58/packages/router/history.ts#L245
-        index = Math.max(0, Math.min(index + n, entries.length - 1));
-        const value = entries[index];
-        listeners.forEach(listener => listener(value));
-    };
-    return {
-        get: () => entries[index],
-        set: ({ value, scroll, replace }) => {
-            if (replace) {
-                entries[index] = value;
-            }
-            else {
-                entries.splice(index + 1, entries.length - index, value);
-                index++;
-            }
-            listeners.forEach(listener => listener(value));
-            setTimeout(() => {
-                if (scroll) {
-                    scrollToHash(value.split("#")[1] || "", true);
-                }
-            }, 0);
-        },
-        back: () => {
-            go(-1);
-        },
-        forward: () => {
-            go(1);
-        },
-        go,
-        listen: (listener) => {
-            listeners.push(listener);
-            return () => {
-                const index = listeners.indexOf(listener);
-                listeners.splice(index, 1);
-            };
-        }
-    };
-}
-export function MemoryRouter(props) {
-    const memoryHistory = props.history || createMemoryHistory();
-    return createRouter({
-        get: memoryHistory.get,
-        set: memoryHistory.set,
-        init: memoryHistory.listen,
-        create: setupNativeEvents({ preload: props.preload, explicitLinks: props.explicitLinks, actionBase: props.actionBase }),
-        utils: {
-            go: memoryHistory.go
-        }
-    })(props);
-}

package/dist/routers/Router.d.ts

@@ -1,17 +0,0 @@
-import type { BaseRouterProps } from "./components.jsx";
-import type { JSX } from "solid-js";
-export type RouterProps = BaseRouterProps & {
-    url?: string;
-    actionBase?: string;
-    explicitLinks?: boolean;
-    preload?: boolean;
-    /**
-     * Opt-in explicit scroll restoration for back/forward navigation (read
-     * once, not reactive). Sets `history.scrollRestoration = "manual"` and
-     * restores saved positions after the navigation settles, replacing the
-     * browser heuristic that loses offsets when the destination route forces
-     * a layout while rendering (#577).
-     */
-    scrollRestoration?: boolean;
-};
-export declare function Router(props: RouterProps): JSX.Element;

package/dist/routers/Router.js

@@ -1,59 +0,0 @@
-import { isServer } from "solid-js/web";
-import { createRouter, scrollToHash, bindEvent } from "./createRouter.js";
-import { StaticRouter } from "./StaticRouter.js";
-import { setupNativeEvents } from "../data/events.js";
-import { createBeforeLeave, keepDepth, notifyIfNotBlocked, saveCurrentDepth } from "../lifecycle.js";
-import { createScrollRestoration } from "./scrollRestoration.js";
-export function Router(props) {
-    if (isServer)
-        return StaticRouter(props);
-    const restoration = props.scrollRestoration ? createScrollRestoration() : undefined;
-    const getSource = () => {
-        const url = window.location.pathname + window.location.search;
-        const state = window.history.state && window.history.state._depth && Object.keys(window.history.state).length === 1 ? undefined : window.history.state;
-        return {
-            value: url + window.location.hash,
-            state
-        };
-    };
-    const beforeLeave = createBeforeLeave();
-    return createRouter({
-        get: getSource,
-        set({ value, replace, scroll, state }) {
-            if (replace) {
-                window.history.replaceState(keepDepth(state), "", value);
-            }
-            else {
-                window.history.pushState(state, "", value);
-            }
-            scrollToHash(decodeURIComponent(window.location.hash.slice(1)), scroll);
-            saveCurrentDepth();
-            restoration && !replace && restoration.onPush();
-        },
-        init: notify => {
-            const handler = notifyIfNotBlocked(notify, delta => {
-                if (delta) {
-                    return !beforeLeave.confirm(delta);
-                }
-                else {
-                    const s = getSource();
-                    return !beforeLeave.confirm(s.value, { state: s.state });
-                }
-            });
-            return bindEvent(window, "popstate", restoration
-                ? () => {
-                    restoration.onPop();
-                    handler();
-                }
-                : handler);
-        },
-        create: router => {
-            setupNativeEvents({ preload: props.preload, explicitLinks: props.explicitLinks, actionBase: props.actionBase, transformUrl: props.transformUrl })(router);
-            restoration && restoration.create(router);
-        },
-        utils: {
-            go: delta => window.history.go(delta),
-            beforeLeave
-        }
-    })(props);
-}

package/dist/routers/StaticRouter.d.ts

@@ -1,6 +0,0 @@
-import { type BaseRouterProps } from "./components.jsx";
-import type { JSX } from "solid-js";
-export type StaticRouterProps = BaseRouterProps & {
-    url?: string;
-};
-export declare function StaticRouter(props: StaticRouterProps): JSX.Element;

package/dist/routers/StaticRouter.js

@@ -1,15 +0,0 @@
-import { getRequestEvent } from "solid-js/web";
-import { createRouterComponent } from "./components.jsx";
-function getPath(url) {
-    const u = new URL(url);
-    return u.pathname + u.search;
-}
-export function StaticRouter(props) {
-    let e;
-    const obj = {
-        value: props.url || ((e = getRequestEvent()) && getPath(e.request.url)) || "",
-    };
-    return createRouterComponent({
-        signal: [() => obj, next => Object.assign(obj, next)]
-    })(props);
-}

package/dist/routers/createRouter.d.ts

@@ -1,10 +0,0 @@
-import type { LocationChange, RouterContext, RouterUtils } from "../types.js";
-export declare function createRouter(config: {
-    get: () => string | LocationChange;
-    set: (next: LocationChange) => void;
-    init?: (notify: (value?: string | LocationChange) => void) => () => void;
-    create?: (router: RouterContext) => void;
-    utils?: Partial<RouterUtils>;
-}): (props: import("./components.jsx").BaseRouterProps) => import("solid-js").JSX.Element;
-export declare function bindEvent(target: EventTarget, type: string, handler: EventListener): () => void;
-export declare function scrollToHash(hash: string, fallbackTop?: boolean): void;

package/dist/routers/createRouter.js

@@ -1,41 +0,0 @@
-import { createSignal, onCleanup, sharedConfig } from "solid-js";
-import { createRouterComponent } from "./components.jsx";
-function intercept([value, setValue], get, set) {
-    return [get ? () => get(value()) : value, set ? (v) => setValue(set(v)) : setValue];
-}
-export function createRouter(config) {
-    let ignore = false;
-    const wrap = (value) => (typeof value === "string" ? { value } : value);
-    const signal = intercept(createSignal(wrap(config.get()), {
-        equals: (a, b) => a.value === b.value && a.state === b.state
-    }), undefined, next => {
-        !ignore && config.set(next);
-        if (sharedConfig.registry && !sharedConfig.done)
-            sharedConfig.done = true;
-        return next;
-    });
-    config.init &&
-        onCleanup(config.init((value = config.get()) => {
-            ignore = true;
-            signal[1](wrap(value));
-            ignore = false;
-        }));
-    return createRouterComponent({
-        signal,
-        create: config.create,
-        utils: config.utils
-    });
-}
-export function bindEvent(target, type, handler) {
-    target.addEventListener(type, handler);
-    return () => target.removeEventListener(type, handler);
-}
-export function scrollToHash(hash, fallbackTop) {
-    const el = hash && document.getElementById(hash);
-    if (el) {
-        el.scrollIntoView();
-    }
-    else if (fallbackTop) {
-        window.scrollTo(0, 0);
-    }
-}