@jsenv/navi 0.29.223 → 0.29.225

package/dist/jsenv_navi.js

@@ -1632,18 +1632,6 @@ const reportErrorIfNobodyDisplaysIt = (error, { action } = {}) => {
   });
 };
 
-const actionPrivatePropertiesWeakMap = new WeakMap();
-const getActionPrivateProperties = (action) => {
-  const actionPrivateProperties = actionPrivatePropertiesWeakMap.get(action);
-  if (!actionPrivateProperties) {
-    throw new Error(`Cannot find action private properties for "${action}"`);
-  }
-  return actionPrivateProperties;
-};
-const setActionPrivateProperties = (action, properties) => {
-  actionPrivatePropertiesWeakMap.set(action, properties);
-};
-
 const IDLE = { id: "idle" };
 const RUNNING = { id: "running" };
 const ABORTED = { id: "aborted" };
@@ -1791,19 +1779,7 @@ const ActionRenderer = ({
   if (aborted) {
     return renderAborted(action);
   }
-  let renderCompletedSafe;
-  if (renderCompleted) {
-    renderCompletedSafe = renderCompleted;
-  } else {
-    const {
-      ui
-    } = getActionPrivateProperties(action);
-    if (ui.renderCompleted) {
-      renderCompletedSafe = ui.renderCompleted;
-    } else {
-      renderCompletedSafe = renderCompletedDefault;
-    }
-  }
+  const renderCompletedSafe = renderCompleted || renderCompletedDefault;
   if (loading) {
     if (action.canDisplayOldData && data !== undefined) {
       return renderCompletedSafe(data, action);
@@ -2552,6 +2528,18 @@ const weakEffect = (values, callback) => {
   return dispose;
 };
 
+const actionPrivatePropertiesWeakMap = new WeakMap();
+const getActionPrivateProperties = (action) => {
+  const actionPrivateProperties = actionPrivatePropertiesWeakMap.get(action);
+  if (!actionPrivateProperties) {
+    throw new Error(`Cannot find action private properties for "${action}"`);
+  }
+  return actionPrivateProperties;
+};
+const setActionPrivateProperties = (action, properties) => {
+  actionPrivatePropertiesWeakMap.set(action, properties);
+};
+
 const SYMBOL_OBJECT_SIGNAL = Symbol.for("navi_object_signal");
 
 /*
@@ -3204,7 +3192,6 @@ const createAction = (callback, rootOptions = {}) => {
       data = dataDefault,
 
       completed = false,
-      renderLoadedAsync,
       sideEffect = () => {},
       meta = {},
 
@@ -3609,10 +3596,6 @@ const createAction = (callback, rootOptions = {}) => {
     }
 
     {
-      const ui = {
-        renderLoaded: null,
-        renderLoadedAsync,
-      };
       let sideEffectCleanup;
       let completeSideEffectCleanup;
 
@@ -3809,20 +3792,6 @@ const createAction = (callback, rootOptions = {}) => {
           } else {
             runResult = callbackResult;
           }
-          if (ui.renderLoadedAsync && !ui.renderLoaded) {
-            const renderLoadedPromise = ui.renderLoadedAsync(...args).then(
-              (renderLoaded) => {
-                ui.renderLoaded = renderLoaded;
-              },
-              (e) => {
-                if (!rejected) {
-                  rejected = true;
-                  rejectedValue = e;
-                }
-              },
-            );
-            thenableArray.push(renderLoadedPromise);
-          }
           if (thenableArray.length === 0) {
             return onRunEnd();
           }
@@ -3876,7 +3845,6 @@ const createAction = (callback, rootOptions = {}) => {
 
         performRun,
         performReset,
-        ui,
 
         nameSignal: actionNameSignal,
         callSourceSignal: actionCallSourceSignal,
@@ -4151,10 +4119,8 @@ const createActionProxyFromSignal = (
 
       performRun: proxyPrivateMethod("performRun"),
       performReset: proxyPrivateMethod("performReset"),
-      ui: currentActionPrivateProperties.ui,
     };
     onActionTargetChange(() => {
-      proxyPrivateProperties.ui = currentActionPrivateProperties.ui;
       proxyPrivateProperties.childActionWeakSet =
         currentActionPrivateProperties.childActionWeakSet;
     });
@@ -17100,6 +17066,17 @@ const useAsyncData = (promiseOrAction, {
   run,
   onLoad
 } = {}) => {
+  // The request this component owns, as a function: one action per instance,
+  // made on the first render and kept — the function's identity changes on
+  // every render when it is written inline, the action's does not.
+  const ownActionRef = useRef(null);
+  if (typeof promiseOrAction === "function" && !promiseOrAction.isAction) {
+    if (!ownActionRef.current) {
+      ownActionRef.current = createAction(promiseOrAction);
+    }
+    promiseOrAction = ownActionRef.current;
+    run = true;
+  }
   const isAction = Boolean(promiseOrAction && promiseOrAction.isAction);
   if (loading === true) {
     loading = "use";
@@ -24688,11 +24665,24 @@ const route = (
     matchesParams: undefined,
     navTo: undefined,
     redirectTo: undefined,
+    preload: undefined,
     subscribeStatus,
     toString: () => {
       return `route "${cleanPattern}"`;
     },
   };
+  // Asks ahead of the arrival for what this route's actions ask without the
+  // address — a page's code, a read without params (see routeAction). An
+  // action keyed by a param waits for the arrival: a prefetch has no address.
+  route.preload = () => {
+    const preloadSet = routePreloadMap.get(route);
+    if (!preloadSet) {
+      return;
+    }
+    for (const preload of preloadSet) {
+      preload();
+    }
+  };
   Object.preventExtensions(route);
 
   // route private props
@@ -25151,6 +25141,34 @@ const paramsTargetCanPlace = (redirectRoute, urlParams) => {
 };
 
 let setupRoutesCalled = false;
+let activeRouteSet = null;
+
+const routePreloadMap = new WeakMap();
+const registerRoutePreload = (route, preload) => {
+  let preloadSet = routePreloadMap.get(route);
+  if (!preloadSet) {
+    preloadSet = new Set();
+    routePreloadMap.set(route, preloadSet);
+  }
+  preloadSet.add(preload);
+};
+/**
+ * Preloads every route the url leads to, a section and the page inside it
+ * alike. What a link does when the pointer or the focus reaches it (see
+ * use_preload_on_intent.js), available to anything else that knows where it
+ * is about to go.
+ */
+const preloadUrl = (url) => {
+  if (!activeRouteSet) {
+    return;
+  }
+  for (const route of activeRouteSet) {
+    const { routePattern } = getRoutePrivateProperties(route);
+    if (routePattern.applyOn(url)) {
+      route.preload();
+    }
+  }
+};
 const setupRoutes = (routes) => {
   if (setupRoutesCalled) {
     throw new Error(
@@ -25162,6 +25180,7 @@ This prevents cross-test pollution and ensures clean state.`,
   setupRoutesCalled = true;
 
   const routeSet = new Set();
+  activeRouteSet = routeSet;
   let currentUrl = null;
   const getUrl = () => currentUrl;
   // PHASE 1: Setup patterns with unified objects (includes all relationships and signal connections)
@@ -25454,6 +25473,7 @@ This prevents cross-test pollution and ensures clean state.`,
     routeSet.clear();
     redirectingRouteSet = null;
     setupRoutesCalled = false;
+    activeRouteSet = null;
   };
   return {
     updateRoutes,
@@ -30753,20 +30773,55 @@ const writeCover = (edge, element, size) => {
   style.setProperty(property, value);
 };
 
+/**
+ * Binds an action to a route: it runs when the route matches, with the params
+ * the effect reads off the address, and is aborted when the route is left.
+ * Its data, its wait and its failure are read by the page through
+ * `useAsyncData`.
+ *
+ * A page's CODE is declared the same way — the import is one more thing the
+ * address asks for, started with the data rather than after it:
+ *
+ * ```js
+ * const GAME_PAGE_CODE = routeAction(GAME_ROUTE, () =>
+ *   import("./game_page.jsx").then((m) => m.GamePage),
+ * );
+ * ```
+ *
+ * @param {object | object[]} routeOrRoutes - the route, or the routes, this
+ *   action belongs to.
+ * @param {object | Function} action - an action, or a function made into one.
+ * @param {() => any} [paramsEffect] - what the action runs with, read off
+ *   signals (the route's params, a search param): re-read when they change.
+ *   Return a falsy value to run nothing. Without it the action asks nothing of
+ *   the address, which is also what makes it worth fetching AHEAD of the
+ *   arrival: a link to the route preruns it when the pointer or the focus
+ *   reaches the link (see docs/dynamic_import.md). An action whose params
+ *   come from the address is never prefetched — a prefetch has no address.
+ * @param {object} [options]
+ * @param {boolean} [options.prefetch=true] - `false` keeps a param-less action
+ *   from being prerun on intent, when the read is not worth a hover.
+ */
 const routeAction = (
   routeOrRoutes,
   action,
-  paramsEffect = () => true,
-  options = {},
+  paramsEffect,
+  { prefetch = true, ...options } = {},
 ) => {
-  const routeMatchingSignal = Array.isArray(routeOrRoutes)
-    ? anyMatchingRouteSignal(routeOrRoutes)
-    : routeOrRoutes.matchingSignal;
+  if (typeof action === "function") {
+    action = createAction(action);
+  }
+  const routes = Array.isArray(routeOrRoutes) ? routeOrRoutes : [routeOrRoutes];
+  const routeMatchingSignal =
+    routes.length === 1
+      ? routes[0].matchingSignal
+      : anyMatchingRouteSignal(routes);
+  const readParams = paramsEffect || (() => true);
   const actionBoundToRoute = actionRunEffect(
     action,
     () => {
       const matching = routeMatchingSignal.value;
-      const params = paramsEffect();
+      const params = readParams();
       if (!matching) {
         return null;
       }
@@ -30774,10 +30829,37 @@ const routeAction = (
     },
     options,
   );
-
+  if (!paramsEffect && prefetch) {
+    for (const route of routes) {
+      registerRoutePreload(route, () => {
+        prefetchParamless(action);
+      });
+    }
+  }
   return actionBoundToRoute;
 };
 
+// The instance the effect above runs on the match is the one bound to `true`
+// (the default params), so a prerun here is what the arrival promotes to a
+// run. A prefetch that fails is forgotten rather than reported: nothing on
+// screen asked for it, and the arrival asks again and shows its own failure.
+const prefetchParamless = (action) => {
+  const instance = action.bindParams(true);
+  const forget = () => {
+    instance.reset({ reason: "prefetch failed" });
+  };
+  let result;
+  try {
+    result = instance.prerun({ reason: "intent" });
+  } catch {
+    forget();
+    return;
+  }
+  if (result && typeof result.catch === "function") {
+    result.catch(forget);
+  }
+};
+
 // I delibrately prefer the term "any" and avoid "some" so dev are not tempted to think
 // "well I could just use array.some" and bypass this helper entirely, which would be incorrect:
 // This helper does return if some/any route is matching but ensure all route matching signals are read (subscribed to)
@@ -40641,6 +40723,34 @@ const Icon = ({
   });
 };
 
+/**
+ * Where a link leads, asked for when the pointer or the focus arrives on it:
+ * the moment the user signals a destination, before the press. Only what the
+ * route's actions ask without the address is fetched (see route.preload), so
+ * a link whose address is not the final one — an id still to be chosen —
+ * loses nothing by asking.
+ */
+const usePreloadOnIntent = (ref, href, prefetch = true) => {
+  useEffect(() => {
+    if (!prefetch || !href) {
+      return undefined;
+    }
+    const element = ref.current;
+    if (!element) {
+      return undefined;
+    }
+    const preload = () => {
+      preloadUrl(href);
+    };
+    element.addEventListener("pointerenter", preload);
+    element.addEventListener("focusin", preload);
+    return () => {
+      element.removeEventListener("pointerenter", preload);
+      element.removeEventListener("focusin", preload);
+    };
+  }, [ref, href, prefetch]);
+};
+
 /**
  * Hook that reactively checks if a URL is visited.
  * Re-renders when the visited URL set changes.
@@ -41150,6 +41260,12 @@ Object.assign(PSEUDO_CLASSES, {
  *   way there changes. What a row of tabs wants — the neighbour is a lateral
  *   move, not a step deeper, so the whole row weighs one entry and the back
  *   button leaves by where the reader came in.
+ * @param {boolean} [props.prefetch=true] Fetch the code of where this leads when the
+ *   pointer or the focus arrives, ahead of the press (see
+ *   docs/dynamic_import.md): the route actions that ask nothing of the
+ *   address — a page's code, a read without params — are prerun; one keyed by
+ *   a param waits for the arrival. `false` for a destination not worth
+ *   fetching on a hover.
  * @param {string} [props.command] - What the press asks of a control around
  *   the link — `"--navi-close"` on a link that leaves the sheet it is in.
  *   Triggered on the press, before the navigation.
@@ -41246,11 +41362,13 @@ const LinkPlain = props => {
     routeTransition,
     pressableDuringRouteTransition,
     replace,
+    prefetch = true,
     children
   } = props;
   if (anchor && !props.id) {
     props.id = href.slice(1);
   }
+  usePreloadOnIntent(props.ref, href, prefetch);
   const selectionContext = useContext(SelectionContext);
   const nav = useContext(NavContext);
   const visited = useIsVisited(href);
@@ -41418,6 +41536,7 @@ const LinkPlain = props => {
     routeTransition: undefined,
     pressableDuringRouteTransition: undefined,
     replace: undefined,
+    prefetch: undefined,
     "data-navi-route-transition-request": routeTransitionRequest,
     ...(pressableDuringRouteTransition ? {
       [PRESSABLE_ATTRIBUTE]: ""
@@ -47285,6 +47404,7 @@ const ButtonUI = props => {
     rel,
     replace,
     pressableDuringRouteTransition,
+    prefetch = true,
     // visual
     variant,
     pressEffect,
@@ -47343,6 +47463,7 @@ const ButtonUI = props => {
     [PRESSABLE_ATTRIBUTE]: ""
   } : null;
   const visualSelector = ".navi_button_content";
+  usePreloadOnIntent(ref, href, prefetch);
   useAccentColorAttributes(ref, null, {
     elementSelector: visualSelector
   });
@@ -47372,8 +47493,10 @@ const ButtonUI = props => {
     ...replaceRequest,
     pressableDuringRouteTransition: undefined,
     ...pressableRequest,
+    prefetch: undefined
     // Respond with the JS prop value directly so callers (e.g. resolveCommandValue)
     // get the original type instead of the DOM-coerced string (e.g. "[object Object]").
+    ,
     onnavi_get_value: e => {
       e.detail.respondWith(props.value);
     },
@@ -47602,6 +47725,12 @@ const COMMAND_DEFAULT_PROPS_FACTORIES = {
  *   `--navi-nav-to` command — by TAKING THE PLACE of the current history entry
  *   rather than stacking on it: what `<Link replace>` says, for a press drawn
  *   as a button.
+ * @param {boolean} [prefetch=true] Fetch the code of where this leads when the
+ *   pointer or the focus arrives, ahead of the press (see
+ *   docs/dynamic_import.md): the route actions that ask nothing of the
+ *   address — a page's code, a read without params — are prerun; one keyed by
+ *   a param waits for the arrival. `false` for a destination not worth
+ *   fetching on a hover.
  * @param {boolean} [pressableDuringRouteTransition] Keep answering presses
  *   while a route transition plays: what a movement photographs goes deaf to
  *   the pointer for its whole length, and the door that opened the page — a
@@ -82525,5 +82654,5 @@ const UserSvg = () => jsx("svg", {
   })
 });
 
-export { ActionRenderer, ActiveKeyboardShortcuts, Address, Badge, BadgeCount, BadgeList, Binder, Box, Button, ButtonCopyToClipboard, CalloutStatusIcon, Caption, CardLayout, CheckSvg, CheckboxGroup, CloseSvg, Code, Col, Colgroup, Color, ConstructionSvg, ControlGroup, ControlSwap, DaySpin, Details, Dialog, Editable, ErrorBoundary, ErrorBoundaryContext, ExclamationSvg, Expandable, EyeClosedSvg, EyeSvg, Field, FixedBar, Form, Group, Head, HeartSvg, HomeSvg, Icon, Image, InfoSvg, Input, InputDuration, Interpolate, Label, Link, LinkAnchorSvg, LinkBlankTargetSvg, LinkCurrentSvg, List, ListItem, ListItemGroup, ListItems, Loading, LoadingDotsSvg, LoadingIndicator, LoadingIndicatorFluid, LoadingOutline, MessageBox, Meter, Nav, NaviDebug, NumberSpin, OfflineError, Paragraph, Picker, Popover, Popup, Quantity, RadioGroup, Route, RouteTransitionArea, RouteTravel, RowNumberCol, RowNumberTableCell, SVGMaskOverlay, SearchSvg, Select, SelectableInput, SelectionContext, Separator, SettingsSvg, SidePanel, Slide, SlideContainer, Spin, SpinGroup, SplitButton, StarSvg, Step, StepList, SummaryMarker, Svg, Table, TableCell, Tbody, Text, TextBox, Textarea, TextareaCharCount, Thead, Time, TimeRange, TimeRangeSpin, TimeRangeWheel, TimeSpin, TimeWheel, Title, Tr, UITransition, Unit, UserSvg, ViewportLayout, Wheel, WheelGroup, WheelItem, actionRunEffect, anyMatchingRouteSignal, applySearch, arraySignalMembership, canNavBackSignal, canNavForwardSignal, coarsePointerSignal, compareTwoJsValues, constraintFromValidityRule, createAction, createAvailableConstraint, createRequestCanceller, createSearch, createSelectionKeyboardShortcuts, createSlot, defineInteractionDetector, defineRouteDefaultTransition, defineRouteTransition, detectHorizontalOverflow, dispatchRequestSetUIState, enableDebugActions, enableDebugOnDocumentLoading, ensureDocumentStartViewTransition, errorIsDisplayed, filterTableSelection, getNowHours, getNowHoursRoundedToStep, isCellSelected, isColumnSelected, isOfflineError, isRowSelected, isScrolling, isToday, languagesSignal, localStorageSignal, markAsOutsideTextFlow, markErrorAsDisplayedBy, moveArrayItemByIndex, moveFocusTo, navBack, navForward, navIntegratedVia, navTo, naviI18n, openCallout, rawUrlPart, registerGlobalConstraint, reload, rerunActions, resource, route, routeAction, scrollActivitySignal, setBaseUrl, setNetworkPolicy, setPreferredLanguage, setSupportedLanguages, setUrlTargetOptions, setupRoutes, smallTouchScreenSignal, stateSignal, stopLoad, stringifyTableSelectionValue, swapArrayItemByIndex, syncOwnedResourceToSignals, syncResourceToSignals, triggerNaviCommand, updateActions, useActionStatus, useArraySignalMembership, useAsyncData, useCalloutElement, useCalloutRequestClose, useCanNavBack, useCanNavForward, useCancelPrevious, useCellGridFromRows, useConstraintValidityState, useDependenciesDiff, useDisplayedLayoutEffect, useDocumentResource, useDocumentState, useDocumentUrl, useEditionController, useFocusGroup, useInputGroup, useKeyboardShortcuts, useNavState, useNetworkPolicyReason, useOrderedColumns, usePopupMode, useRouteStatus, useSearchText, useSelectableElement, useSelectionController, useSignalSync, useSlideContainer, useSlideValue, useStateArray, useTitleLevel, useTransitionCover, useUrlSearchParam, useUrlTargetId, valueInLocalStorage, windowWidthSignal };
+export { ActionRenderer, ActiveKeyboardShortcuts, Address, Badge, BadgeCount, BadgeList, Binder, Box, Button, ButtonCopyToClipboard, CalloutStatusIcon, Caption, CardLayout, CheckSvg, CheckboxGroup, CloseSvg, Code, Col, Colgroup, Color, ConstructionSvg, ControlGroup, ControlSwap, DaySpin, Details, Dialog, Editable, ErrorBoundary, ErrorBoundaryContext, ExclamationSvg, Expandable, EyeClosedSvg, EyeSvg, Field, FixedBar, Form, Group, Head, HeartSvg, HomeSvg, Icon, Image, InfoSvg, Input, InputDuration, Interpolate, Label, Link, LinkAnchorSvg, LinkBlankTargetSvg, LinkCurrentSvg, List, ListItem, ListItemGroup, ListItems, Loading, LoadingDotsSvg, LoadingIndicator, LoadingIndicatorFluid, LoadingOutline, MessageBox, Meter, Nav, NaviDebug, NumberSpin, OfflineError, Paragraph, Picker, Popover, Popup, Quantity, RadioGroup, Route, RouteTransitionArea, RouteTravel, RowNumberCol, RowNumberTableCell, SVGMaskOverlay, SearchSvg, Select, SelectableInput, SelectionContext, Separator, SettingsSvg, SidePanel, Slide, SlideContainer, Spin, SpinGroup, SplitButton, StarSvg, Step, StepList, SummaryMarker, Svg, Table, TableCell, Tbody, Text, TextBox, Textarea, TextareaCharCount, Thead, Time, TimeRange, TimeRangeSpin, TimeRangeWheel, TimeSpin, TimeWheel, Title, Tr, UITransition, Unit, UserSvg, ViewportLayout, Wheel, WheelGroup, WheelItem, actionRunEffect, anyMatchingRouteSignal, applySearch, arraySignalMembership, canNavBackSignal, canNavForwardSignal, coarsePointerSignal, compareTwoJsValues, constraintFromValidityRule, createAction, createAvailableConstraint, createRequestCanceller, createSearch, createSelectionKeyboardShortcuts, createSlot, defineInteractionDetector, defineRouteDefaultTransition, defineRouteTransition, detectHorizontalOverflow, dispatchRequestSetUIState, enableDebugActions, enableDebugOnDocumentLoading, ensureDocumentStartViewTransition, errorIsDisplayed, filterTableSelection, getNowHours, getNowHoursRoundedToStep, isCellSelected, isColumnSelected, isOfflineError, isRowSelected, isScrolling, isToday, languagesSignal, localStorageSignal, markAsOutsideTextFlow, markErrorAsDisplayedBy, moveArrayItemByIndex, moveFocusTo, navBack, navForward, navIntegratedVia, navTo, naviI18n, openCallout, preloadUrl, rawUrlPart, registerGlobalConstraint, reload, rerunActions, resource, route, routeAction, scrollActivitySignal, setBaseUrl, setNetworkPolicy, setPreferredLanguage, setSupportedLanguages, setUrlTargetOptions, setupRoutes, smallTouchScreenSignal, stateSignal, stopLoad, stringifyTableSelectionValue, swapArrayItemByIndex, syncOwnedResourceToSignals, syncResourceToSignals, triggerNaviCommand, updateActions, useActionStatus, useArraySignalMembership, useAsyncData, useCalloutElement, useCalloutRequestClose, useCanNavBack, useCanNavForward, useCancelPrevious, useCellGridFromRows, useConstraintValidityState, useDependenciesDiff, useDisplayedLayoutEffect, useDocumentResource, useDocumentState, useDocumentUrl, useEditionController, useFocusGroup, useInputGroup, useKeyboardShortcuts, useNavState, useNetworkPolicyReason, useOrderedColumns, usePopupMode, useRouteStatus, useSearchText, useSelectableElement, useSelectionController, useSignalSync, useSlideContainer, useSlideValue, useStateArray, useTitleLevel, useTransitionCover, useUrlSearchParam, useUrlTargetId, valueInLocalStorage, windowWidthSignal };
 //# sourceMappingURL=jsenv_navi.js.map