toiljs 0.0.11 → 0.0.14

package/src/client/index.ts

@@ -1,64 +1,79 @@
-/**
- * toiljs client runtime, published as `toiljs/client`. Re-exports the router (mount/Router/Link),
- * navigation hooks, prefetching, and the route types consumed by the compiler-generated entry.
- * Zero imports needed in user route files beyond this package.
- *
- * Internals are split by concern: route `types`, history-based `navigation`, the params
- * `params-context` + `hooks`, `lazy` component resolution, the `Link`/`Router` components,
- * `mount`, `match` (pure matcher), `prefetch` (link prefetcher), and `channel` (WebSocket helper).
- */
-
-export { mount } from './routing/mount.js';
-export { Router } from './routing/Router.js';
-export { Link } from './navigation/Link.js';
-export type { LinkProps } from './navigation/Link.js';
-export { NavLink, matchActive } from './navigation/NavLink.js';
-export type { NavLinkProps, NavLinkState } from './navigation/NavLink.js';
-export { navigate, back, forward, refresh, setViewTransitions } from './navigation/navigation.js';
-export type { NavigateOptions } from './navigation/navigation.js';
-export {
-    useParams,
-    useNavigate,
-    useLocation,
-    usePathname,
-    useSearchParams,
-    useRouter,
-    useNavigationPending,
-} from './routing/hooks.js';
-export type { RouterInstance } from './routing/hooks.js';
-export { useLoaderData, revalidate, invalidateLoaderData } from './routing/loader.js';
-export type { LoaderArgs, LoaderFunction, LoaderData, Revalidate } from './routing/loader.js';
-export { useAction } from './routing/action.js';
-export type {
-    UseActionOptions,
-    ActionState,
-    ActionHandle,
-    RevalidateTarget,
-} from './routing/action.js';
-export { prefetch } from './navigation/prefetch.js';
-export type {
-    RouteDef,
-    LayoutLoader,
-    LayoutComponentLoader,
-    NotFoundLoader,
-    RouteErrorProps,
-    Register,
-    RoutePath,
-    Href,
-} from './types.js';
-export { matchRoute } from './routing/match.js';
-export type { RouteParams } from './routing/match.js';
-export { connectChannel, useChannel, resolveChannelUrl } from './channel/channel.js';
-export type { Channel, ChannelOptions, ChannelHook, ChannelData } from './channel/channel.js';
-export { useHead, useTitle, Head, mergeHead } from './head/head.js';
-export type { HeadSpec, MetaTag, LinkTag, ResolvedHead } from './head/head.js';
-export { resolveMetadata } from './head/metadata.js';
-export type { Metadata, GenerateMetadata, GenerateMetadataArgs, OpenGraph } from './head/metadata.js';
-export { Image } from './components/Image.js';
-export type { ImageProps } from './components/Image.js';
-export { Script } from './components/Script.js';
-export type { ScriptProps, ScriptStrategy } from './components/Script.js';
-export { Form } from './components/Form.js';
-export type { FormProps } from './components/Form.js';
-export { Slot } from './components/Slot.js';
-export type { SlotProps } from './components/Slot.js';
+/**
+ * toiljs client runtime, published as `toiljs/client`. Re-exports the router (mount/Router/Link),
+ * navigation hooks, prefetching, and the route types consumed by the compiler-generated entry.
+ * Zero imports needed in user route files beyond this package.
+ *
+ * Internals are split by concern: route `types`, history-based `navigation`, the params
+ * `params-context` + `hooks`, `lazy` component resolution, the `Link`/`Router` components,
+ * `mount`, `match` (pure matcher), `prefetch` (link prefetcher), and `channel` (WebSocket helper).
+ */
+
+export { mount } from './routing/mount.js';
+export { Router } from './routing/Router.js';
+export { Link } from './navigation/Link.js';
+export type { LinkProps } from './navigation/Link.js';
+export { NavLink, matchActive } from './navigation/NavLink.js';
+export type { NavLinkProps, NavLinkState } from './navigation/NavLink.js';
+export { navigate, back, forward, refresh, setViewTransitions } from './navigation/navigation.js';
+export type { NavigateOptions } from './navigation/navigation.js';
+export {
+    useParams,
+    useNavigate,
+    useLocation,
+    usePathname,
+    useSearchParams,
+    useRouter,
+    useNavigationPending,
+} from './routing/hooks.js';
+export type { RouterInstance } from './routing/hooks.js';
+export { useLoaderData, revalidate, invalidateLoaderData } from './routing/loader.js';
+export type { LoaderArgs, LoaderFunction, LoaderData, Revalidate } from './routing/loader.js';
+export { useAction } from './routing/action.js';
+export type {
+    UseActionOptions,
+    ActionState,
+    ActionHandle,
+    RevalidateTarget,
+} from './routing/action.js';
+export { prefetch } from './navigation/prefetch.js';
+export type {
+    RouteDef,
+    LayoutLoader,
+    LayoutComponentLoader,
+    NotFoundLoader,
+    RouteErrorProps,
+    Register,
+    RoutePath,
+    Href,
+} from './types.js';
+export { matchRoute } from './routing/match.js';
+export type { RouteParams } from './routing/match.js';
+export { connectChannel, useChannel, resolveChannelUrl } from './channel/channel.js';
+export type { Channel, ChannelOptions, ChannelHook, ChannelData } from './channel/channel.js';
+export { useHead, useTitle, Head, mergeHead } from './head/head.js';
+export type { HeadSpec, MetaTag, LinkTag, ResolvedHead } from './head/head.js';
+export { resolveMetadata } from './head/metadata.js';
+export type {
+    Metadata,
+    GenerateMetadata,
+    GenerateMetadataArgs,
+    OpenGraph,
+} from './head/metadata.js';
+export { searchPages, registerPages, getPages, pagePath } from './search/search.js';
+export type {
+    PageMeta,
+    PageSearchResult,
+    PageSearchOptions,
+    SearchField,
+    SearchHints,
+} from './search/search.js';
+export { usePageSearch } from './search/use-page-search.js';
+export type { PageSearch } from './search/use-page-search.js';
+export { Image } from './components/Image.js';
+export type { ImageProps } from './components/Image.js';
+export { Script } from './components/Script.js';
+export type { ScriptProps, ScriptStrategy } from './components/Script.js';
+export { Form } from './components/Form.js';
+export type { FormProps } from './components/Form.js';
+export { Slot } from './components/Slot.js';
+export type { SlotProps } from './components/Slot.js';

package/src/client/navigation/Link.tsx

@@ -1,100 +1,94 @@
-import type {
-    ComponentPropsWithRef,
-    FocusEvent,
-    MouseEvent,
-    PointerEvent,
-    ReactNode,
-} from 'react';
-
-import { navigate } from './navigation.js';
-import { prefetch } from './prefetch.js';
-import type { Href } from '../types.js';
-
-/**
- * Props for {@link Link}: every standard `<a>` attribute (`rel`, `target`, `download`,
- * `referrerPolicy`, `hrefLang`, `className`, `style`, `ref`, `data-*`, `aria-*`, event handlers …)
- * plus toil's `replace` and `prefetch` controls. `href` is required and typed to the project's routes.
- */
-export interface LinkProps extends Omit<ComponentPropsWithRef<'a'>, 'href'> {
-    /** Destination. Same-origin hrefs navigate client-side; external / `target` / `download` / `#hash` use the browser. */
-    href: Href;
-    /** Replace the current history entry instead of pushing a new one. Default `false`. */
-    replace?: boolean;
-    /** Scroll to top after navigating. Default `true`. */
-    scroll?: boolean;
-    /** Prefetch the route chunk on hover/focus. Default `true`; `false` opts this link out. */
-    prefetch?: boolean;
-}
-
-/** True for cross-origin, opaque (`mailto:` / `tel:`), or otherwise non-same-origin hrefs. */
-function isExternalHref(href: string): boolean {
-    try {
-        return new URL(href, window.location.href).origin !== window.location.origin;
-    } catch {
-        return true;
-    }
-}
-
-/**
- * Client-side navigation link. Forwards all anchor attributes to the underlying `<a>`, and
- * prefetches the target route's chunk on hover/focus. Intercepts only plain same-origin clicks , 
- * modified clicks, `target=_blank`, `download`, in-page `#hash`, and external URLs fall through to
- * native browser behavior.
- */
-export function Link(props: LinkProps): ReactNode {
-    const {
-        href,
-        replace = false,
-        scroll = true,
-        prefetch: prefetchProp = true,
-        onClick,
-        onPointerEnter,
-        onFocus,
-        children,
-        ...rest
-    } = props;
-
-    const handleClick = (event: MouseEvent<HTMLAnchorElement>): void => {
-        onClick?.(event);
-        if (
-            event.defaultPrevented ||
-            event.button !== 0 ||
-            event.metaKey ||
-            event.ctrlKey ||
-            event.shiftKey ||
-            event.altKey ||
-            (rest.target !== undefined && rest.target !== '_self') ||
-            rest.download !== undefined ||
-            href.startsWith('#') ||
-            isExternalHref(href)
-        ) {
-            return;
-        }
-        event.preventDefault();
-        navigate(href, { replace, scroll });
-    };
-
-    const warm = (): void => {
-        if (prefetchProp) prefetch(href);
-    };
-    const handlePointerEnter = (event: PointerEvent<HTMLAnchorElement>): void => {
-        onPointerEnter?.(event);
-        warm();
-    };
-    const handleFocus = (event: FocusEvent<HTMLAnchorElement>): void => {
-        onFocus?.(event);
-        warm();
-    };
-
-    return (
-        <a
-            {...rest}
-            {...(prefetchProp ? {} : { 'data-no-prefetch': '' })}
-            href={href}
-            onClick={handleClick}
-            onPointerEnter={handlePointerEnter}
-            onFocus={handleFocus}>
-            {children}
-        </a>
-    );
-}
+import type { ComponentPropsWithRef, FocusEvent, MouseEvent, PointerEvent, ReactNode } from 'react';
+
+import { navigate } from './navigation.js';
+import { prefetch } from './prefetch.js';
+import type { Href } from '../types.js';
+
+/**
+ * Props for {@link Link}: every standard `<a>` attribute (`rel`, `target`, `download`,
+ * `referrerPolicy`, `hrefLang`, `className`, `style`, `ref`, `data-*`, `aria-*`, event handlers …)
+ * plus toil's `replace` and `prefetch` controls. `href` is required and typed to the project's routes.
+ */
+export interface LinkProps extends Omit<ComponentPropsWithRef<'a'>, 'href'> {
+    /** Destination. Same-origin hrefs navigate client-side; external / `target` / `download` / `#hash` use the browser. */
+    href: Href;
+    /** Replace the current history entry instead of pushing a new one. Default `false`. */
+    replace?: boolean;
+    /** Scroll to top after navigating. Default `true`. */
+    scroll?: boolean;
+    /** Prefetch the route chunk on hover/focus. Default `true`; `false` opts this link out. */
+    prefetch?: boolean;
+}
+
+/** True for cross-origin, opaque (`mailto:` / `tel:`), or otherwise non-same-origin hrefs. */
+function isExternalHref(href: string): boolean {
+    try {
+        return new URL(href, window.location.href).origin !== window.location.origin;
+    } catch {
+        return true;
+    }
+}
+
+/**
+ * Client-side navigation link. Forwards all anchor attributes to the underlying `<a>`, and
+ * prefetches the target route's chunk on hover/focus. Intercepts only plain same-origin clicks ,
+ * modified clicks, `target=_blank`, `download`, in-page `#hash`, and external URLs fall through to
+ * native browser behavior.
+ */
+export function Link(props: LinkProps): ReactNode {
+    const {
+        href,
+        replace = false,
+        scroll = true,
+        prefetch: prefetchProp = true,
+        onClick,
+        onPointerEnter,
+        onFocus,
+        children,
+        ...rest
+    } = props;
+
+    const handleClick = (event: MouseEvent<HTMLAnchorElement>): void => {
+        onClick?.(event);
+        if (
+            event.defaultPrevented ||
+            event.button !== 0 ||
+            event.metaKey ||
+            event.ctrlKey ||
+            event.shiftKey ||
+            event.altKey ||
+            (rest.target !== undefined && rest.target !== '_self') ||
+            rest.download !== undefined ||
+            href.startsWith('#') ||
+            isExternalHref(href)
+        ) {
+            return;
+        }
+        event.preventDefault();
+        navigate(href, { replace, scroll });
+    };
+
+    const warm = (): void => {
+        if (prefetchProp) prefetch(href);
+    };
+    const handlePointerEnter = (event: PointerEvent<HTMLAnchorElement>): void => {
+        onPointerEnter?.(event);
+        warm();
+    };
+    const handleFocus = (event: FocusEvent<HTMLAnchorElement>): void => {
+        onFocus?.(event);
+        warm();
+    };
+
+    return (
+        <a
+            {...rest}
+            {...(prefetchProp ? {} : { 'data-no-prefetch': '' })}
+            href={href}
+            onClick={handleClick}
+            onPointerEnter={handlePointerEnter}
+            onFocus={handleFocus}>
+            {children}
+        </a>
+    );
+}