@rangojs/router 0.10.1 → 0.11.0

package/src/types/handler-context.ts

@@ -541,8 +541,10 @@ export type RevalidateParams<TParams = GenericParams, TEnv = any> = Parameters<
 /**
  * A reference to a server action, used by `isAction()` in a revalidate predicate.
  *
- * Either a directly imported action (`import { addToCart }`) or a namespace
- * import of an action module (`import * as CartActions`). Matching resolves the
+ * Either a directly imported action (`import { addToCart }`), a namespace
+ * import of an action module (`import * as CartActions`), an object
+ * literal of actions (`{ addToCart, removeFromCart }`), or a grouped
+ * namespace (`{ Cart: CartActions, Order: OrderActions }`). Matching resolves the
  * action's build-injected id (`path#export`) — the same identity the router uses
  * for `actionId` — so a renamed or moved action breaks at compile time instead
  * of silently failing to match.
@@ -551,6 +553,9 @@ export type ActionRef =
   | ((...args: never[]) => unknown)
   | Record<string, unknown>;
 
+/** The `isAction()` matcher passed to server and client `revalidate()` predicates. */
+export type IsActionFn = (...actions: ActionRef[]) => boolean;
+
 /**
  * Revalidation function called during client-side navigation to decide whether
  * a segment (layout, route, parallel slot, or loader) should be re-rendered.
@@ -643,8 +648,10 @@ export type ShouldRevalidateFn<TParams = GenericParams, TEnv = any> = (args: {
   /**
    * Typed, rename-safe action matching. Returns `true` when the action that
    * triggered this revalidation is one of the given references — or, for a
-   * namespace import (`import * as CartActions`), any export of that module —
-   * and `false` otherwise (including plain navigation with no action).
+   * namespace import (`import * as CartActions`), object literal
+   * (`{ addToCart, removeFromCart }`), or grouped namespaces
+   * (`{ Cart: CartActions }`), any of those exports — and `false`
+   * otherwise (including plain navigation with no action).
    *
    * Called with NO arguments it answers "is this request an action at all?":
    * `true` for any action, `false` on plain navigation. Use the bare form when
@@ -668,9 +675,10 @@ export type ShouldRevalidateFn<TParams = GenericParams, TEnv = any> = (args: {
    * revalidate((ctx) => ctx.isAction(addToCart) || undefined); // one action
    * revalidate((ctx) => ctx.isAction(addToCart, removeFromCart) || undefined); // several
    * revalidate((ctx) => ctx.isAction(CartActions) || undefined); // any in the module
+   * revalidate((ctx) => ctx.isAction({ addToCart, removeFromCart }) || undefined); // object form
    * ```
    */
-  isAction: (...actions: ActionRef[]) => boolean;
+  isAction: IsActionFn;
   /** URL where the action was executed (the page the user was on when they triggered the action). */
   actionUrl?: URL;
   /** Return value from the action execution. Can be used to conditionally revalidate based on the action's outcome. */

package/src/types/index.ts

@@ -38,6 +38,7 @@ export type {
   RevalidateParams,
   ShouldRevalidateFn,
   ActionRef,
+  IsActionFn,
   RouteKeys,
   ExtractRouteParams,
   HandlersForRouteMap,

package/src/vite/plugins/expose-action-id.ts

@@ -92,6 +92,27 @@ function isUseServerModule(filePath: string): boolean {
   }
 }
 
+/**
+ * Per-reference own `bind` injected next to `$$id`. React's client.browser
+ * build carries no server-reference metadata across `.bind()` (the
+ * edge/node/server builds install an own `bind` on each reference that
+ * does), so `isAction(boundStub)` would silently miss in the browser only.
+ * Installing the same per-reference own `bind` here — scoped to the stubs
+ * this plugin already wraps, guarded to never override an existing own
+ * `bind` — closes that without mutating the global Function.prototype
+ * (which would re-wrap once per Vite environment/HMR pass and break
+ * native-function detection for co-loaded code). The helper re-installs
+ * itself on the bound result so chained binds keep the metadata too.
+ */
+export const ACTION_BIND_HELPER_NAME: string = "__rangoActionBind";
+export const ACTION_BIND_HELPER_SOURCE: string = `var ${ACTION_BIND_HELPER_NAME} = function () {
+  var bound = Function.prototype.bind.apply(this, arguments);
+  if (typeof this.$id === "string") bound.$id = this.$id;
+  if (typeof this.$$id === "string") bound.$$id = this.$$id;
+  bound.bind = ${ACTION_BIND_HELPER_NAME};
+  return bound;
+};`;
+
 function applyServerReferenceWrapping(
   code: string,
   s: MagicString,
@@ -126,10 +147,17 @@ function applyServerReferenceWrapping(
       }
     }
 
-    const replacement = `(function(fn) { fn.$$id = ${finalIdArg}; return fn; })(${fnCall}(${idArg}${rest}))`;
+    const replacement =
+      `(function(fn) { fn.$$id = ${finalIdArg}; ` +
+      `if (!Object.prototype.hasOwnProperty.call(fn, "bind")) fn.bind = ${ACTION_BIND_HELPER_NAME}; ` +
+      `return fn; })(${fnCall}(${idArg}${rest}))`;
     s.overwrite(start, end, replacement);
   }
 
+  if (hasChanges) {
+    s.prepend(`${ACTION_BIND_HELPER_SOURCE}\n`);
+  }
+
   return hasChanges;
 }