@solidjs/router 0.16.0 → 0.16.1

package/dist/data/action.js

@@ -1,7 +1,7 @@
 import { $TRACK, createMemo, createSignal, onCleanup, getOwner } from "solid-js";
 import { isServer } from "solid-js/web";
 import { useRouter } from "../routing.js";
-import { mockBase } from "../utils.js";
+import { mockBase, setFunctionName } from "../utils.js";
 import { cacheKeyOp, hashKey, revalidate, query } from "./query.js";
 export const actions = /* #__PURE__ */ new Map();
 export function useSubmissions(fn, filter) {
@@ -53,7 +53,7 @@ export function action(fn, options = {}) {
                     error: result?.error,
                     pending: false,
                     retry() {
-                        return retry = submission.retry();
+                        return (retry = submission.retry());
                     }
                 });
                 if (retry)
@@ -93,10 +93,11 @@ export function action(fn, options = {}) {
         return p.then(handler(), handler(true));
     }
     const o = typeof options === "string" ? { name: options } : options;
-    const url = fn.url ||
-        (o.name && `https://action/${o.name}`) ||
-        (!isServer ? `https://action/${hashString(fn.toString())}` : "");
+    const name = o.name || (!isServer ? String(hashString(fn.toString())) : undefined);
+    const url = fn.url || (name && `https://action/${name}`) || "";
     mutate.base = url;
+    if (name)
+        setFunctionName(mutate, name);
     return toAction(mutate, url);
 }
 function toAction(fn, url) {

package/dist/data/createAsync.js

@@ -4,11 +4,14 @@
 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;

package/dist/data/events.d.ts

@@ -1,2 +1,9 @@
 import type { RouterContext } from "../types.js";
-export declare function setupNativeEvents(preload?: boolean, explicitLinks?: boolean, actionBase?: string, transformUrl?: (url: string) => string): (router: RouterContext) => void;
+type NativeEventConfig = {
+    preload?: boolean;
+    explicitLinks?: boolean;
+    actionBase?: string;
+    transformUrl?: (url: string) => string;
+};
+export declare function setupNativeEvents({ preload, explicitLinks, actionBase, transformUrl }?: NativeEventConfig): (router: RouterContext) => void;
+export {};

package/dist/data/events.js

@@ -2,7 +2,7 @@ import { delegateEvents } from "solid-js/web";
 import { onCleanup } from "solid-js";
 import { actions } from "./action.js";
 import { mockBase } from "../utils.js";
-export function setupNativeEvents(preload = true, explicitLinks = false, actionBase = "/_server", transformUrl) {
+export function setupNativeEvents({ preload = true, explicitLinks = false, actionBase = "/_server", transformUrl } = {}) {
     return (router) => {
         const basePath = router.base.path();
         const navigateFromRoute = router.navigatorFactory(router.base);
@@ -65,7 +65,7 @@ export function setupNativeEvents(preload = true, explicitLinks = false, actionB
             clearTimeout(preloadTimeout);
             const res = handleAnchor(evt);
             if (!res)
-                return lastElement = null;
+                return (lastElement = null);
             const [a, url] = res;
             if (lastElement === a)
                 return;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 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 } from "./routing.js";
+export { useHref, useIsRouting, useLocation, useMatch, useCurrentMatches, useNavigate, useParams, useResolvedPath, useSearchParams, useBeforeLeave, usePreloadRoute, RouterContextObj as RouterContext } from "./routing.js";
 export { mergeSearchString as _mergeSearchString } from "./utils.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, RouteLoadFunc, RouteLoadFuncArgs, RouterResponseInit, CustomResponse } from "./types.js";

package/dist/index.jsx

@@ -1,6 +1,6 @@
 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 } from "./routing.js";
+export { useHref, useIsRouting, useLocation, useMatch, useCurrentMatches, useNavigate, useParams, useResolvedPath, useSearchParams, useBeforeLeave, usePreloadRoute, RouterContextObj as RouterContext } from "./routing.js";
 export { mergeSearchString as _mergeSearchString } from "./utils.js";
 export * from "./data/index.js";

package/dist/routers/HashRouter.js

@@ -30,7 +30,7 @@ export function HashRouter(props) {
             saveCurrentDepth();
         },
         init: notify => bindEvent(window, "hashchange", notifyIfNotBlocked(notify, delta => !beforeLeave.confirm(delta && delta < 0 ? delta : getSource()))),
-        create: setupNativeEvents(props.preload, props.explicitLinks, props.actionBase),
+        create: setupNativeEvents({ preload: props.preload, explicitLinks: props.explicitLinks, actionBase: props.actionBase }),
         utils: {
             go: delta => window.history.go(delta),
             renderPath: path => `#${path}`,

package/dist/routers/MemoryRouter.js

@@ -49,7 +49,7 @@ export function MemoryRouter(props) {
         get: memoryHistory.get,
         set: memoryHistory.set,
         init: memoryHistory.listen,
-        create: setupNativeEvents(props.preload, props.explicitLinks, props.actionBase),
+        create: setupNativeEvents({ preload: props.preload, explicitLinks: props.explicitLinks, actionBase: props.actionBase }),
         utils: {
             go: memoryHistory.go
         }

package/dist/routers/Router.js

@@ -36,7 +36,7 @@ export function Router(props) {
                 return !beforeLeave.confirm(s.value, { state: s.state });
             }
         })),
-        create: setupNativeEvents(props.preload, props.explicitLinks, props.actionBase, props.transformUrl),
+        create: setupNativeEvents({ preload: props.preload, explicitLinks: props.explicitLinks, actionBase: props.actionBase, transformUrl: props.transformUrl }),
         utils: {
             go: delta => window.history.go(delta),
             beforeLeave

package/dist/routing.d.ts

@@ -1,11 +1,12 @@
 import { JSX, Accessor } from "solid-js";
 import type { BeforeLeaveEventArgs, Branch, Intent, Location, MatchFilters, NavigateOptions, Navigator, Params, RouteDescription, RouteContext, RouteDefinition, RouteMatch, RouterContext, RouterIntegration, SearchParams, SetSearchParams } from "./types.js";
+/** Consider this API opaque and internal. It is likely to change in the future. */
 export declare const RouterContextObj: import("solid-js").Context<RouterContext | undefined>;
 export declare const RouteContextObj: import("solid-js").Context<RouteContext | undefined>;
 export declare const useRouter: () => RouterContext;
 export declare const useRoute: () => RouteContext;
 export declare const useResolvedPath: (path: () => string) => Accessor<string | undefined>;
-export declare const useHref: (to: () => string | undefined) => Accessor<string | undefined>;
+export declare const useHref: <T extends string | undefined>(to: () => T) => () => string | T;
 /**
  * Retrieves method to do navigation. The method accepts a path to navigate to and an optional object with the following options:
  *

package/dist/routing.js

@@ -4,6 +4,7 @@ import { isServer, getRequestEvent } from "solid-js/web";
 import { createBeforeLeave } from "./lifecycle.js";
 import { mockBase, createMemoObject, extractSearchParams, invariant, resolvePath, createMatcher, joinPaths, scoreRoute, mergeSearchString, expandOptionals } from "./utils.js";
 const MAX_REDIRECTS = 100;
+/** Consider this API opaque and internal. It is likely to change in the future. */
 export const RouterContextObj = createContext();
 export const RouteContextObj = createContext();
 export const useRouter = () => invariant(useContext(RouterContextObj), "<A> and 'use' router primitives can be only used inside a Route.");

package/dist/types.d.ts

@@ -42,7 +42,7 @@ export interface NavigateOptions<S = unknown> {
     state: S;
 }
 export interface Navigator {
-    (to: string, options?: Partial<NavigateOptions>): void;
+    (to: string | number, options?: Partial<NavigateOptions>): void;
     (delta: number): void;
 }
 export type NavigatorFactory = (route?: RouteContext) => Navigator;

package/dist/utils.d.ts

@@ -10,3 +10,4 @@ export declare function scoreRoute(route: RouteDescription): number;
 export declare function createMemoObject<T extends Record<string | symbol, unknown>>(fn: () => T): T;
 export declare function mergeSearchString(search: string, params: SetSearchParams): string;
 export declare function expandOptionals(pattern: string): string[];
+export declare function setFunctionName<T>(obj: T, value: string): T;

package/dist/utils.js

@@ -175,3 +175,11 @@ export function expandOptionals(pattern) {
     }
     return expandOptionals(suffix).reduce((results, expansion) => [...results, ...prefixes.map(p => p + expansion)], []);
 }
+export function setFunctionName(obj, value) {
+    Object.defineProperty(obj, "name", {
+        value,
+        writable: false,
+        configurable: false
+    });
+    return obj;
+}

package/package.json

@@ -6,7 +6,7 @@
     "Ryan Turnquist"
   ],
   "license": "MIT",
-  "version": "0.16.0",
+  "version": "0.16.1",
   "homepage": "https://github.com/solidjs/solid-router#readme",
   "repository": {
     "type": "git",
@@ -51,7 +51,7 @@
     "solid-js": "^1.8.6"
   },
   "scripts": {
-    "build": "tsc && rollup -c",
+    "build": "rm -rf dist && tsc && rollup -c",
     "test": "vitest run && npm run test:types",
     "test:watch": "vitest",
     "test:types": "tsc --project tsconfig.test.json",

package/dist/src/components.d.ts

@@ -1,31 +0,0 @@
-import type { JSX } from "solid-js";
-import type { Location, Navigator } from "./types.js";
-declare module "solid-js" {
-    namespace JSX {
-        interface AnchorHTMLAttributes<T> {
-            state?: string;
-            noScroll?: boolean;
-            replace?: boolean;
-            preload?: boolean;
-            link?: boolean;
-        }
-    }
-}
-export interface AnchorProps extends Omit<JSX.AnchorHTMLAttributes<HTMLAnchorElement>, "state"> {
-    href: string;
-    replace?: boolean | undefined;
-    noScroll?: boolean | undefined;
-    state?: unknown | undefined;
-    inactiveClass?: string | undefined;
-    activeClass?: string | undefined;
-    end?: boolean | undefined;
-}
-export declare function A(props: AnchorProps): JSX.Element;
-export interface NavigateProps {
-    href: ((args: {
-        navigate: Navigator;
-        location: Location;
-    }) => string) | string;
-    state?: unknown;
-}
-export declare function Navigate(props: NavigateProps): null;

package/dist/src/components.jsx

@@ -1,39 +0,0 @@
-import { createMemo, mergeProps, splitProps } from "solid-js";
-import { useHref, useLocation, useNavigate, useResolvedPath } from "./routing.js";
-import { normalizePath } from "./utils.js";
-export function A(props) {
-    props = mergeProps({ inactiveClass: "inactive", activeClass: "active" }, props);
-    const [, rest] = splitProps(props, [
-        "href",
-        "state",
-        "class",
-        "activeClass",
-        "inactiveClass",
-        "end"
-    ]);
-    const to = useResolvedPath(() => props.href);
-    const href = useHref(to);
-    const location = useLocation();
-    const isActive = createMemo(() => {
-        const to_ = to();
-        if (to_ === undefined)
-            return [false, false];
-        const path = normalizePath(to_.split(/[?#]/, 1)[0]).toLowerCase();
-        const loc = decodeURI(normalizePath(location.pathname).toLowerCase());
-        return [props.end ? path === loc : loc.startsWith(path + "/") || loc === path, path === loc];
-    });
-    return (<a {...rest} href={href() || props.href} state={JSON.stringify(props.state)} classList={{
-            ...(props.class && { [props.class]: true }),
-            [props.inactiveClass]: !isActive()[0],
-            [props.activeClass]: isActive()[0],
-            ...rest.classList
-        }} link aria-current={isActive()[1] ? "page" : undefined}/>);
-}
-export function Navigate(props) {
-    const navigate = useNavigate();
-    const location = useLocation();
-    const { href, state } = props;
-    const path = typeof href === "function" ? href({ navigate, location }) : href;
-    navigate(path, { replace: true, state });
-    return null;
-}

package/dist/src/data/action.d.ts

@@ -1,17 +0,0 @@
-import { JSX } from "solid-js";
-import type { Submission, SubmissionStub, NarrowResponse } from "../types.js";
-export type Action<T extends Array<any>, U, V = T> = (T extends [FormData | URLSearchParams] | [] ? JSX.SerializableAttributeValue : unknown) & ((...vars: T) => Promise<NarrowResponse<U>>) & {
-    url: string;
-    with<A extends any[], B extends any[]>(this: (this: any, ...args: [...A, ...B]) => Promise<NarrowResponse<U>>, ...args: A): Action<B, U, V>;
-};
-export declare const actions: Map<string, Action<any, any, any>>;
-export declare function useSubmissions<T extends Array<any>, U, V>(fn: Action<T, U, V>, filter?: (input: V) => boolean): Submission<T, NarrowResponse<U>>[] & {
-    pending: boolean;
-};
-export declare function useSubmission<T extends Array<any>, U, V>(fn: Action<T, U, V>, filter?: (input: V) => boolean): Submission<T, NarrowResponse<U>> | SubmissionStub;
-export declare function useAction<T extends Array<any>, U, V>(action: Action<T, U, V>): (...args: Parameters<Action<T, U, V>>) => Promise<NarrowResponse<U>>;
-export declare function action<T extends Array<any>, U = void>(fn: (...args: T) => Promise<U>, name?: string): Action<T, U>;
-export declare function action<T extends Array<any>, U = void>(fn: (...args: T) => Promise<U>, options?: {
-    name?: string;
-    onComplete?: (s: Submission<T, U>) => void;
-}): Action<T, U>;

package/dist/src/data/action.js

@@ -1,163 +0,0 @@
-import { $TRACK, createMemo, createSignal, onCleanup, getOwner } from "solid-js";
-import { isServer } from "solid-js/web";
-import { useRouter } from "../routing.js";
-import { mockBase, setFunctionName } from "../utils.js";
-import { cacheKeyOp, hashKey, revalidate, query } from "./query.js";
-export const actions = /* #__PURE__ */ new Map();
-export function useSubmissions(fn, filter) {
-    const router = useRouter();
-    const subs = createMemo(() => router.submissions[0]().filter(s => s.url === fn.base && (!filter || filter(s.input))));
-    return new Proxy([], {
-        get(_, property) {
-            if (property === $TRACK)
-                return subs();
-            if (property === "pending")
-                return subs().some(sub => !sub.result);
-            return subs()[property];
-        },
-        has(_, property) {
-            return property in subs();
-        }
-    });
-}
-export function useSubmission(fn, filter) {
-    const submissions = useSubmissions(fn, filter);
-    return new Proxy({}, {
-        get(_, property) {
-            if ((submissions.length === 0 && property === "clear") || property === "retry")
-                return () => { };
-            return submissions[submissions.length - 1]?.[property];
-        }
-    });
-}
-export function useAction(action) {
-    const r = useRouter();
-    return (...args) => action.apply({ r }, args);
-}
-export function action(fn, options = {}) {
-    function mutate(...variables) {
-        const router = this.r;
-        const form = this.f;
-        const p = (router.singleFlight && fn.withOptions
-            ? fn.withOptions({ headers: { "X-Single-Flight": "true" } })
-            : fn)(...variables);
-        const [result, setResult] = createSignal();
-        let submission;
-        function handler(error) {
-            return async (res) => {
-                const result = await handleResponse(res, error, router.navigatorFactory());
-                let retry = null;
-                o.onComplete?.({
-                    ...submission,
-                    result: result?.data,
-                    error: result?.error,
-                    pending: false,
-                    retry() {
-                        return (retry = submission.retry());
-                    }
-                });
-                if (retry)
-                    return retry;
-                if (!result)
-                    return submission.clear();
-                setResult(result);
-                if (result.error && !form)
-                    throw result.error;
-                return result.data;
-            };
-        }
-        router.submissions[1](s => [
-            ...s,
-            (submission = {
-                input: variables,
-                url,
-                get result() {
-                    return result()?.data;
-                },
-                get error() {
-                    return result()?.error;
-                },
-                get pending() {
-                    return !result();
-                },
-                clear() {
-                    router.submissions[1](v => v.filter(i => i !== submission));
-                },
-                retry() {
-                    setResult(undefined);
-                    const p = fn(...variables);
-                    return p.then(handler(), handler(true));
-                }
-            })
-        ]);
-        return p.then(handler(), handler(true));
-    }
-    const o = typeof options === "string" ? { name: options } : options;
-    const name = o.name || (!isServer ? String(hashString(fn.toString())) : undefined);
-    const url = fn.url || (name && `https://action/${name}`) || "";
-    mutate.base = url;
-    if (name)
-        setFunctionName(mutate, name);
-    return toAction(mutate, url);
-}
-function toAction(fn, url) {
-    fn.toString = () => {
-        if (!url)
-            throw new Error("Client Actions need explicit names if server rendered");
-        return url;
-    };
-    fn.with = function (...args) {
-        const newFn = function (...passedArgs) {
-            return fn.call(this, ...args, ...passedArgs);
-        };
-        newFn.base = fn.base;
-        const uri = new URL(url, mockBase);
-        uri.searchParams.set("args", hashKey(args));
-        return toAction(newFn, (uri.origin === "https://action" ? uri.origin : "") + uri.pathname + uri.search);
-    };
-    fn.url = url;
-    if (!isServer) {
-        actions.set(url, fn);
-        getOwner() && onCleanup(() => actions.delete(url));
-    }
-    return fn;
-}
-const hashString = (s) => s.split("").reduce((a, b) => ((a << 5) - a + b.charCodeAt(0)) | 0, 0);
-async function handleResponse(response, error, navigate) {
-    let data;
-    let custom;
-    let keys;
-    let flightKeys;
-    if (response instanceof Response) {
-        if (response.headers.has("X-Revalidate"))
-            keys = response.headers.get("X-Revalidate").split(",");
-        if (response.customBody) {
-            data = custom = await response.customBody();
-            if (response.headers.has("X-Single-Flight")) {
-                data = data._$value;
-                delete custom._$value;
-                flightKeys = Object.keys(custom);
-            }
-        }
-        if (response.headers.has("Location")) {
-            const locationUrl = response.headers.get("Location") || "/";
-            if (locationUrl.startsWith("http")) {
-                window.location.href = locationUrl;
-            }
-            else {
-                navigate(locationUrl);
-            }
-        }
-    }
-    else if (error)
-        return { error: response };
-    else
-        data = response;
-    // invalidate
-    cacheKeyOp(keys, entry => (entry[0] = 0));
-    // set cache
-    flightKeys && flightKeys.forEach(k => query.set(k, custom[k]));
-    // trigger revalidation
-    await revalidate(keys, false);
-    return data != null ? { data } : undefined;
-}

package/dist/src/data/action.spec.d.ts

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