@solidjs/router 0.15.4 → 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/data/response.d.ts

@@ -1,4 +1,4 @@
-import type { RouterResponseInit, CustomResponse } from "../types";
+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/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.js

@@ -237,8 +237,18 @@ function expandOptionals(pattern) {
   }
   return expandOptionals(suffix).reduce((results, expansion) => [...results, ...prefixes.map(p => p + expansion)], []);
 }
+function setFunctionName(obj, value) {
+  Object.defineProperty(obj, "name", {
+    value,
+    writable: false,
+    configurable: false
+  });
+  return obj;
+}
 
 const MAX_REDIRECTS = 100;
+
+/** Consider this API opaque and internal. It is likely to change in the future. */
 const RouterContextObj = createContext();
 const RouteContextObj = createContext();
 const useRouter = () => invariant(useContext(RouterContextObj), "<A> and 'use' router primitives can be only used inside a Route.");
@@ -1323,8 +1333,10 @@ function action(fn, options = {}) {
   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) {
@@ -1386,7 +1398,12 @@ async function handleResponse(response, error, navigate) {
   } : undefined;
 }
 
-function setupNativeEvents(preload = true, explicitLinks = false, actionBase = "/_server", transformUrl) {
+function setupNativeEvents({
+  preload = true,
+  explicitLinks = false,
+  actionBase = "/_server",
+  transformUrl
+} = {}) {
   return router => {
     const basePath = router.base.path();
     const navigateFromRoute = router.navigatorFactory(router.base);
@@ -1528,7 +1545,12 @@ function Router(props) {
         });
       }
     })),
-    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
@@ -1569,7 +1591,11 @@ 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}`,
@@ -1631,7 +1657,11 @@ 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
     }
@@ -1715,6 +1745,7 @@ function createAsync(fn, options) {
   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;
@@ -1845,4 +1876,4 @@ function json(data, init = {}) {
   return response;
 }
 
-export { A, HashRouter, MemoryRouter, Navigate, Route, Router, StaticRouter, mergeSearchString as _mergeSearchString, action, cache, createAsync, createAsyncStore, createBeforeLeave, createMemoryHistory, createRouter, json, keepDepth, notifyIfNotBlocked, query, redirect, reload, revalidate, saveCurrentDepth, useAction, useBeforeLeave, useCurrentMatches, useHref, useIsRouting, useLocation, useMatch, useNavigate, useParams, usePreloadRoute, useResolvedPath, useSearchParams, useSubmission, useSubmissions };
+export { A, HashRouter, MemoryRouter, Navigate, Route, Router, RouterContextObj as RouterContext, StaticRouter, mergeSearchString as _mergeSearchString, action, cache, createAsync, createAsyncStore, createBeforeLeave, createMemoryHistory, createRouter, json, keepDepth, notifyIfNotBlocked, query, redirect, reload, revalidate, saveCurrentDepth, useAction, useBeforeLeave, useCurrentMatches, useHref, useIsRouting, useLocation, useMatch, useNavigate, useParams, usePreloadRoute, useResolvedPath, useSearchParams, useSubmission, useSubmissions };

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.d.ts

@@ -1,5 +1,5 @@
 import type { JSX } from "solid-js";
-import type { BaseRouterProps } from "./components.js";
+import type { BaseRouterProps } from "./components.jsx";
 export declare function hashParser(str: string): string;
 export type HashRouterProps = BaseRouterProps & {
     actionBase?: string;

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/routers/createRouter.d.ts

@@ -1,4 +1,4 @@
-import type { LocationChange, RouterContext, RouterUtils } from "../types.ts";
+import type { LocationChange, RouterContext, RouterUtils } from "../types.js";
 export declare function createRouter(config: {
     get: () => string | LocationChange;
     set: (next: LocationChange) => void;

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

@@ -1,4 +1,4 @@
-import type { MatchFilters, PathMatch, RouteDescription, SearchParams, SetSearchParams } from "./types.ts";
+import type { MatchFilters, PathMatch, RouteDescription, SearchParams, SetSearchParams } from "./types.js";
 export declare const mockBase = "http://sr";
 export declare function normalizePath(path: string, omitSlash?: boolean): string;
 export declare function resolvePath(base: string, path: string, from?: string): string | undefined;
@@ -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.15.4",
+  "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",