@wular/pnext 0.0.4 → 0.0.7

package/src/api/link.tsx

@@ -1,45 +1,42 @@
-import { h, type ComponentChildren, type JSX } from 'preact';
-import { useEffect, useRef } from 'preact/hooks';
-import type {
-  AnchorHTMLAttributes,
-  MouseEvent,
-  ReactNode,
-} from 'react';
-import { routeHref, type SearchInput } from '../routing/href';
-import type { PrefetchMode, RouteParams, RoutePath } from '../types';
+import { h, type ComponentChildren, type JSX } from 'preact'
+import { useEffect, useRef } from 'preact/hooks'
+import type { AnchorHTMLAttributes, MouseEvent, ReactNode } from 'react'
+import { getDefaultPrefetchMode, routeHref, type SearchInput } from '../routing/href'
+import type { PrefetchMode, RouteParams, RoutePath } from '../types'
 
 export interface NavigateEvent {
-  preventDefault(): void;
+  preventDefault(): void
 }
 
-type LinkMouseEvent = MouseEvent<HTMLAnchorElement>;
+type LinkMouseEvent = MouseEvent<HTMLAnchorElement>
 
 type BaseLinkProps = Omit<AnchorHTMLAttributes<HTMLAnchorElement>, 'href' | 'onClick'> & {
-  prefetch?: PrefetchMode;
-  replace?: boolean;
-  scroll?: boolean;
-  search?: SearchInput;
-  hash?: string;
-  onClick?: (event: LinkMouseEvent) => void;
-  onNavigate?: (event: NavigateEvent) => void;
-  onPrefetchStart?: () => void;
-  onPrefetchFinish?: () => void;
-  children?: ReactNode;
-};
+  prefetch?: PrefetchMode
+  replace?: boolean
+  scroll?: boolean
+  search?: SearchInput
+  hash?: string
+  onClick?: (event: LinkMouseEvent) => void
+  onNavigate?: (event: NavigateEvent) => void
+  onPrefetchStart?: () => void
+  onPrefetchFinish?: () => void
+  children?: ReactNode
+}
 
-type ParamsProp<Route extends RoutePath> = RouteParams<Route> extends Record<string, never>
-  ? { params?: never }
-  : { params: RouteParams<Route> };
+type ParamsProp<Route extends RoutePath> =
+  RouteParams<Route> extends Record<string, never>
+    ? { params?: never }
+    : { params: RouteParams<Route> }
 
 export type LinkProps<Route extends RoutePath = RoutePath> = BaseLinkProps &
   ParamsProp<Route> & {
-    href: Route;
-  };
+    href: Route
+  }
 
 export function Link<Route extends RoutePath>({
   href,
   params,
-  prefetch = 'intent',
+  prefetch,
   replace,
   scroll,
   search,
@@ -51,8 +48,10 @@ export function Link<Route extends RoutePath>({
   children,
   ...anchorProps
 }: LinkProps<Route>): ReactNode {
-  const resolvedHref = routeHref(href, { params: params ?? {}, search, hash });
-  const anchorRef = usePrefetchLifecycle(onPrefetchStart, onPrefetchFinish);
+  const resolvedHref = routeHref(href, { params: params ?? {}, search, hash })
+  // A link's own prefetch prop wins; otherwise the app-wide config default.
+  const prefetchMode = prefetch ?? getDefaultPrefetchMode()
+  const anchorRef = usePrefetchLifecycle(onPrefetchStart, onPrefetchFinish)
   return h(
     'a',
     {
@@ -60,50 +59,50 @@ export function Link<Route extends RoutePath>({
       ref: anchorRef,
       href: resolvedHref,
       'data-pnext-link': true,
-      'data-prefetch': prefetch === false ? 'false' : prefetch,
+      'data-prefetch': prefetchMode === false ? 'false' : prefetchMode,
       'data-pnext-replace': replace ? 'true' : undefined,
       'data-pnext-scroll': scroll === false ? 'false' : undefined,
       onClick: event => {
-        const clickEvent = event as unknown as LinkMouseEvent;
-        onClick?.(clickEvent);
-        if (clickEvent.defaultPrevented || !onNavigate || !isPlainLeftClick(clickEvent)) return;
-        const navEvent = navigationEvent();
-        onNavigate(navEvent);
-        if (navEvent.defaultPrevented) clickEvent.preventDefault();
+        const clickEvent = event as unknown as LinkMouseEvent
+        onClick?.(clickEvent)
+        if (clickEvent.defaultPrevented || !onNavigate || !isPlainLeftClick(clickEvent)) return
+        const navEvent = navigationEvent()
+        onNavigate(navEvent)
+        if (navEvent.defaultPrevented) clickEvent.preventDefault()
       },
     } as JSX.HTMLAttributes<HTMLAnchorElement>,
     children as ComponentChildren,
-  ) as unknown as ReactNode;
+  ) as unknown as ReactNode
 }
 
 // The prefetch runtime dispatches lifecycle events on the anchor that
 // triggered a prefetch, for every mode (intent, visible, load).
 export function usePrefetchLifecycle(onStart?: () => void, onFinish?: () => void) {
-  const anchorRef = useRef<HTMLAnchorElement | null>(null);
+  const anchorRef = useRef<HTMLAnchorElement | null>(null)
 
   useEffect(() => {
-    const node = anchorRef.current;
-    if (!node || (!onStart && !onFinish)) return;
-    const handleStart = () => onStart?.();
-    const handleFinish = () => onFinish?.();
-    node.addEventListener('pnext:prefetchstart', handleStart);
-    node.addEventListener('pnext:prefetchfinish', handleFinish);
+    const node = anchorRef.current
+    if (!node || (!onStart && !onFinish)) return
+    const handleStart = () => onStart?.()
+    const handleFinish = () => onFinish?.()
+    node.addEventListener('pnext:prefetchstart', handleStart)
+    node.addEventListener('pnext:prefetchfinish', handleFinish)
     return () => {
-      node.removeEventListener('pnext:prefetchstart', handleStart);
-      node.removeEventListener('pnext:prefetchfinish', handleFinish);
-    };
-  }, [onStart, onFinish]);
+      node.removeEventListener('pnext:prefetchstart', handleStart)
+      node.removeEventListener('pnext:prefetchfinish', handleFinish)
+    }
+  }, [onStart, onFinish])
 
-  return anchorRef;
+  return anchorRef
 }
 
 function navigationEvent() {
   return {
     defaultPrevented: false,
     preventDefault() {
-      this.defaultPrevented = true;
+      this.defaultPrevented = true
     },
-  };
+  }
 }
 
 function isPlainLeftClick(event: LinkMouseEvent) {
@@ -115,5 +114,5 @@ function isPlainLeftClick(event: LinkMouseEvent) {
     !event.shiftKey &&
     !event.currentTarget.target &&
     !event.currentTarget.download
-  );
+  )
 }

package/src/api/navigation.ts

@@ -1,23 +1,23 @@
-import { routeHref, type SearchInput } from '../routing/href';
-import type { RouteParams, RoutePath } from '../types';
+import { routeHref, type SearchInput } from '../routing/href'
+import type { RouteParams, RoutePath } from '../types'
 
-export type { SearchInput, SearchValue } from '../routing/href';
+export type { SearchInput, SearchValue } from '../routing/href'
 
-const notFoundDigest = 'PNEXT_NOT_FOUND';
-const redirectDigest = 'PNEXT_REDIRECT';
-const forbiddenDigest = 'PNEXT_FORBIDDEN';
-const unauthorizedDigest = 'PNEXT_UNAUTHORIZED';
-const nextNotFoundDigest = 'NEXT_HTTP_ERROR_FALLBACK;404';
-const nextForbiddenDigest = 'NEXT_HTTP_ERROR_FALLBACK;403';
-const nextUnauthorizedDigest = 'NEXT_HTTP_ERROR_FALLBACK;401';
+const notFoundDigest = 'PNEXT_NOT_FOUND'
+const redirectDigest = 'PNEXT_REDIRECT'
+const forbiddenDigest = 'PNEXT_FORBIDDEN'
+const unauthorizedDigest = 'PNEXT_UNAUTHORIZED'
+const nextNotFoundDigest = 'NEXT_HTTP_ERROR_FALLBACK;404'
+const nextForbiddenDigest = 'NEXT_HTTP_ERROR_FALLBACK;403'
+const nextUnauthorizedDigest = 'NEXT_HTTP_ERROR_FALLBACK;401'
 
-export type RedirectStatus = 303 | 307 | 308;
+export type RedirectStatus = 303 | 307 | 308
 
 class ReadonlyURLSearchParamsError extends Error {
   constructor() {
     super(
       'Method unavailable on `ReadonlyURLSearchParams`. Read more: https://nextjs.org/docs/app/api-reference/functions/use-search-params#updating-searchparams',
-    );
+    )
   }
 }
 
@@ -29,34 +29,35 @@ class ReadonlyURLSearchParamsError extends Error {
 export class ReadonlyURLSearchParams extends URLSearchParams {
   /** @deprecated Method unavailable on `ReadonlyURLSearchParams`. */
   append(): never {
-    throw new ReadonlyURLSearchParamsError();
+    throw new ReadonlyURLSearchParamsError()
   }
   /** @deprecated Method unavailable on `ReadonlyURLSearchParams`. */
   delete(): never {
-    throw new ReadonlyURLSearchParamsError();
+    throw new ReadonlyURLSearchParamsError()
   }
   /** @deprecated Method unavailable on `ReadonlyURLSearchParams`. */
   set(): never {
-    throw new ReadonlyURLSearchParamsError();
+    throw new ReadonlyURLSearchParamsError()
   }
   /** @deprecated Method unavailable on `ReadonlyURLSearchParams`. */
   sort(): never {
-    throw new ReadonlyURLSearchParamsError();
+    throw new ReadonlyURLSearchParamsError()
   }
 }
 
-type ParamsProp<Route extends RoutePath> = RouteParams<Route> extends Record<string, never>
-  ? { params?: never }
-  : { params: RouteParams<Route> };
+type ParamsProp<Route extends RoutePath> =
+  RouteParams<Route> extends Record<string, never>
+    ? { params?: never }
+    : { params: RouteParams<Route> }
 
 export type HrefOptions<Route extends RoutePath> = ParamsProp<Route> & {
-  search?: SearchInput;
-  hash?: string;
-};
+  search?: SearchInput
+  hash?: string
+}
 
 export type RedirectOptions<Route extends RoutePath> = HrefOptions<Route> & {
-  status?: RedirectStatus;
-};
+  status?: RedirectStatus
+}
 
 export function href<Route extends RoutePath>(
   route: Route,
@@ -64,26 +65,26 @@ export function href<Route extends RoutePath>(
     ? [options?: HrefOptions<Route>]
     : [options: HrefOptions<Route>]
 ) {
-  return routeHref(route, options);
+  return routeHref(route, options)
 }
 
 export class PNextNotFoundError extends Error {
-  digest = notFoundDigest;
+  digest = notFoundDigest
 
   constructor() {
-    super('not found');
+    super('not found')
   }
 }
 
 export function notFound(): never {
-  throw new PNextNotFoundError();
+  throw new PNextNotFoundError()
 }
 
 export class PNextForbiddenError extends Error {
-  digest = forbiddenDigest;
+  digest = forbiddenDigest
 
   constructor() {
-    super('forbidden');
+    super('forbidden')
   }
 }
 
@@ -92,14 +93,14 @@ export class PNextForbiddenError extends Error {
  * `forbidden.{tsx,...}` boundary with a 403. Only active when compat.next is on.
  */
 export function forbidden(): never {
-  throw new PNextForbiddenError();
+  throw new PNextForbiddenError()
 }
 
 export class PNextUnauthorizedError extends Error {
-  digest = unauthorizedDigest;
+  digest = unauthorizedDigest
 
   constructor() {
-    super('unauthorized');
+    super('unauthorized')
   }
 }
 
@@ -108,50 +109,50 @@ export class PNextUnauthorizedError extends Error {
  * `unauthorized.{tsx,...}` boundary with a 401. Only active when compat.next is on.
  */
 export function unauthorized(): never {
-  throw new PNextUnauthorizedError();
+  throw new PNextUnauthorizedError()
 }
 
 export class PNextRedirectError extends Error {
-  digest = redirectDigest;
+  digest = redirectDigest
 
   constructor(
     public location: string,
     public status: RedirectStatus = 307,
   ) {
-    super(`redirect to ${location}`);
+    super(`redirect to ${location}`)
   }
 }
 
 export function redirect<Route extends RoutePath>(
   route: Route,
   options: RedirectOptions<Route>,
-): never;
-export function redirect(location: string, status?: RedirectStatus): never;
+): never
+export function redirect(location: string, status?: RedirectStatus): never
 export function redirect<Route extends RoutePath>(
   location: Route | string,
   optionsOrStatus: RedirectOptions<Route> | RedirectStatus = 307,
 ): never {
   if (typeof optionsOrStatus === 'number') {
-    if (redirectInBrowser(location, 'replace')) return undefined as never;
-    throw new PNextRedirectError(location, optionsOrStatus);
+    if (redirectInBrowser(location, 'replace')) return undefined as never
+    throw new PNextRedirectError(location, optionsOrStatus)
   }
-  const href = routeHref(location, optionsOrStatus);
-  if (redirectInBrowser(href, 'replace')) return undefined as never;
-  throw new PNextRedirectError(href, optionsOrStatus.status ?? 307);
+  const href = routeHref(location, optionsOrStatus)
+  if (redirectInBrowser(href, 'replace')) return undefined as never
+  throw new PNextRedirectError(href, optionsOrStatus.status ?? 307)
 }
 
 export function permanentRedirect<Route extends RoutePath>(
   route: Route,
   options: HrefOptions<Route>,
-): never;
-export function permanentRedirect(location: string): never;
+): never
+export function permanentRedirect(location: string): never
 export function permanentRedirect<Route extends RoutePath>(
   location: Route | string,
   options?: HrefOptions<Route>,
 ): never {
-  const href = options ? routeHref(location, options) : location;
-  if (redirectInBrowser(href, 'replace')) return undefined as never;
-  throw new PNextRedirectError(href, 308);
+  const href = options ? routeHref(location, options) : location
+  if (redirectInBrowser(href, 'replace')) return undefined as never
+  throw new PNextRedirectError(href, 308)
 }
 
 export function isNotFoundError(error: unknown) {
@@ -159,11 +160,11 @@ export function isNotFoundError(error: unknown) {
     error instanceof PNextNotFoundError ||
     errorDigest(error) === notFoundDigest ||
     errorDigest(error) === nextNotFoundDigest
-  );
+  )
 }
 
 export function isRedirectError(error: unknown): error is PNextRedirectError {
-  return error instanceof PNextRedirectError || errorDigest(error) === redirectDigest;
+  return error instanceof PNextRedirectError || errorDigest(error) === redirectDigest
 }
 
 export function isForbiddenError(error: unknown): error is PNextForbiddenError {
@@ -171,7 +172,7 @@ export function isForbiddenError(error: unknown): error is PNextForbiddenError {
     error instanceof PNextForbiddenError ||
     errorDigest(error) === forbiddenDigest ||
     errorDigest(error) === nextForbiddenDigest
-  );
+  )
 }
 
 export function isUnauthorizedError(error: unknown): error is PNextUnauthorizedError {
@@ -179,20 +180,20 @@ export function isUnauthorizedError(error: unknown): error is PNextUnauthorizedE
     error instanceof PNextUnauthorizedError ||
     errorDigest(error) === unauthorizedDigest ||
     errorDigest(error) === nextUnauthorizedDigest
-  );
+  )
 }
 
 function errorDigest(error: unknown) {
   return typeof error === 'object' && error !== null && 'digest' in error
     ? (error as { digest?: unknown }).digest
-    : undefined;
+    : undefined
 }
 
 function redirectInBrowser(location: string, mode: 'push' | 'replace') {
-  if (!process.browser && typeof window === 'undefined') return false;
+  if (!process.browser && typeof window === 'undefined') return false
 
-  const href = new URL(location, window.location.href).href;
-  if (mode === 'push') window.location.assign(href);
-  else window.location.replace(href);
-  return true;
+  const href = new URL(location, window.location.href).href
+  if (mode === 'push') window.location.assign(href)
+  else window.location.replace(href)
+  return true
 }