@orpc/swr 2.0.0-beta.23 → 2.0.0-beta.25

package/README.md

@@ -44,6 +44,7 @@ You can read the documentation [here](https://orpc.dev).
 
 - [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
 - [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
+- [@orpc/hibernation](https://www.npmjs.com/package/@orpc/hibernation): Leverage Hibernation APIs like [Cloudflare's Hibernation WebSocket](https://developers.cloudflare.com/durable-objects/best-practices/websockets/#durable-objects-hibernation-websocket-api).
 - [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
 
 **Framework & ecosystem integrations**
@@ -114,6 +115,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   </tr>
   <tr>
    <td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
+   <td align="center"><a href="https://github.com/ellis-driscoll?ref=orpc" target="_blank" rel="noopener" title="Ellis Driscoll"><img src="https://avatars.githubusercontent.com/u/70685966?u=c5f95bc33b5991d9744abe00052542e4a2ed3cb9&amp;v=4" width="139" alt="Ellis Driscoll"/><br />Ellis Driscoll</a></td>
   </tr>
 </table>
 
@@ -139,8 +141,9 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&amp;v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/guyariely?ref=orpc" target="_blank" rel="noopener" title="Guy Ariely"><img src="https://avatars.githubusercontent.com/u/42813496?u=edb6b7f563bf28e160a290832e7da57c0506f8ca&amp;v=4" width="119" alt="Guy Ariely"/><br />Guy Ariely</a></td>
    <td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&amp;v=4" width="119" alt="Alex"/><br />Alex</a></td>
-   <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
+   <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=c5f2daf7ebece498e85c83367bb37b4e10e2649d&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
   </tr>
 </table>
 

package/dist/index.d.mts

@@ -16,14 +16,26 @@ type OperationKey<TInput> = [path: string[], options: Omit<OperationKeyOptions<T
 /**
  * Generate a **full matching** key for SWR operations.
  *
- * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Key Docs}
+ * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
  */
 declare function generateOperationKey<TInput>(path: string[], options?: OperationKeyOptions<TInput>): OperationKey<TInput>;
 
 type InferSubscriberOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type InferLiveSubscriberOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
 type OperationType = 'fetcher' | 'mutator' | 'subscriber' | 'liveSubscriber';
+/**
+ * The symbol under which SWR utils attach operation details
+ * (key and operation type) to the client context.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/swr#operation-context | SWR Integration - Operation Context}
+ */
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
+/**
+ * A client context automatically populated by SWR utils,
+ * exposing the operation key and type of the calling operation.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/swr#operation-context | SWR Integration - Operation Context}
+ */
 interface OperationContext {
     [OPERATION_CONTEXT_SYMBOL]?: {
         key: unknown;
@@ -82,7 +94,7 @@ declare class SharedUtils<TInput> {
     /**
      * Generate a matcher function that returns `true` if the key matches the specified conditions.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#manual-revalidation SWR Manual Revalidation Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#manual-revalidation | SWR Integration - Manual Revalidation}
      */
     matcher<TStrategy extends MatcherStrategy>(...rest: MaybeOptionalOptions<MatcherOptions<TStrategy, TInput>>): Matcher;
 }
@@ -93,38 +105,38 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Calling corresponding procedure client
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#calling-clients SWR Calling Procedure Client Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#calling-clients | SWR Integration - Calling Clients}
      */
     call: Client<TClientContext, TInput, TOutput, TError>;
     constructor(path: string[], client: Client<TClientContext, TInput, TOutput, TError>, options?: ProcedureUtilsOptions);
     /**
      * Generate a **full matching** key for SWR operations.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
      */
     key(...rest: MaybeOptionalOptions<KeyOptions<TInput>>): OperationKey<TInput>;
     /**
      * Generate a fetcher function for use with useSWR, useSWRInfinite, and other SWR hooks.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Data Fetching Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
      */
     fetcher(...rest: MaybeOptionalOptions<FetcherOptions<TClientContext>>): Fetcher<TInput, TOutput>;
     /**
      * Generate a subscriber function that subscribes to an [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object) for use with useSWRSubscription, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions SWR Subscriptions Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions | SWR Integration - Subscriptions}
      */
     subscriber(...rest: MaybeOptionalOptions<SubscriberOptions<TClientContext>>): Subscriber<TInput, InferSubscriberOutput<TOutput>, TError>;
     /**
      * Generate a live subscriber that subscribes to the latest events from an [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object) for use with useSWRSubscription, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions SWR Subscriptions Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions | SWR Integration - Subscriptions}
      */
     liveSubscriber(...rest: MaybeOptionalOptions<FetcherOptions<TClientContext>>): Subscriber<TInput, InferLiveSubscriberOutput<TOutput>, TError>;
     /**
      * Generate a mutator function for use with useSWRMutation, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#mutations SWR Mutations Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#mutations | SWR Integration - Mutations}
      */
     mutator(...rest: MaybeOptionalOptions<MutatorOptions<TClientContext>>): Mutator<TInput, TOutput>;
 }
@@ -141,10 +153,13 @@ interface RouterUtilsOptions extends OperationKeyPrefixOptions {
     path?: string[] | undefined;
 }
 /**
- * Create a swr router utils from a client.
+ * Creates SWR utils from a client, exposing fetcher/mutator/subscriber
+ * helpers for every procedure in the router.
+ *
+ * @remarks
+ * **Note**: Both client-side and server-side clients are supported.
  *
- * @info Both client-side and server-side clients are supported.
- * @see {@link https://orpc.dev/docs/integrations/swr SWR Integration}
+ * @see {@link https://orpc.dev/docs/integrations/swr | SWR Integration}
  */
 declare function createRouterUtils<T extends AnyNestedClient>(client: T, options?: RouterUtilsOptions): RouterUtils<T>;
 

package/dist/index.d.ts

@@ -16,14 +16,26 @@ type OperationKey<TInput> = [path: string[], options: Omit<OperationKeyOptions<T
 /**
  * Generate a **full matching** key for SWR operations.
  *
- * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Key Docs}
+ * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
  */
 declare function generateOperationKey<TInput>(path: string[], options?: OperationKeyOptions<TInput>): OperationKey<TInput>;
 
 type InferSubscriberOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U[] : never;
 type InferLiveSubscriberOutput<TOutput> = TOutput extends AsyncIterable<infer U> ? U : never;
 type OperationType = 'fetcher' | 'mutator' | 'subscriber' | 'liveSubscriber';
+/**
+ * The symbol under which SWR utils attach operation details
+ * (key and operation type) to the client context.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/swr#operation-context | SWR Integration - Operation Context}
+ */
 declare const OPERATION_CONTEXT_SYMBOL: unique symbol;
+/**
+ * A client context automatically populated by SWR utils,
+ * exposing the operation key and type of the calling operation.
+ *
+ * @see {@link https://orpc.dev/docs/integrations/swr#operation-context | SWR Integration - Operation Context}
+ */
 interface OperationContext {
     [OPERATION_CONTEXT_SYMBOL]?: {
         key: unknown;
@@ -82,7 +94,7 @@ declare class SharedUtils<TInput> {
     /**
      * Generate a matcher function that returns `true` if the key matches the specified conditions.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#manual-revalidation SWR Manual Revalidation Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#manual-revalidation | SWR Integration - Manual Revalidation}
      */
     matcher<TStrategy extends MatcherStrategy>(...rest: MaybeOptionalOptions<MatcherOptions<TStrategy, TInput>>): Matcher;
 }
@@ -93,38 +105,38 @@ declare class ProcedureUtils<TClientContext extends ClientContext, TInput, TOutp
     /**
      * Calling corresponding procedure client
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#calling-clients SWR Calling Procedure Client Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#calling-clients | SWR Integration - Calling Clients}
      */
     call: Client<TClientContext, TInput, TOutput, TError>;
     constructor(path: string[], client: Client<TClientContext, TInput, TOutput, TError>, options?: ProcedureUtilsOptions);
     /**
      * Generate a **full matching** key for SWR operations.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Key Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
      */
     key(...rest: MaybeOptionalOptions<KeyOptions<TInput>>): OperationKey<TInput>;
     /**
      * Generate a fetcher function for use with useSWR, useSWRInfinite, and other SWR hooks.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Data Fetching Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
      */
     fetcher(...rest: MaybeOptionalOptions<FetcherOptions<TClientContext>>): Fetcher<TInput, TOutput>;
     /**
      * Generate a subscriber function that subscribes to an [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object) for use with useSWRSubscription, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions SWR Subscriptions Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions | SWR Integration - Subscriptions}
      */
     subscriber(...rest: MaybeOptionalOptions<SubscriberOptions<TClientContext>>): Subscriber<TInput, InferSubscriberOutput<TOutput>, TError>;
     /**
      * Generate a live subscriber that subscribes to the latest events from an [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object) for use with useSWRSubscription, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions SWR Subscriptions Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions | SWR Integration - Subscriptions}
      */
     liveSubscriber(...rest: MaybeOptionalOptions<FetcherOptions<TClientContext>>): Subscriber<TInput, InferLiveSubscriberOutput<TOutput>, TError>;
     /**
      * Generate a mutator function for use with useSWRMutation, etc.
      *
-     * @see {@link https://orpc.dev/docs/integrations/swr#mutations SWR Mutations Docs}
+     * @see {@link https://orpc.dev/docs/integrations/swr#mutations | SWR Integration - Mutations}
      */
     mutator(...rest: MaybeOptionalOptions<MutatorOptions<TClientContext>>): Mutator<TInput, TOutput>;
 }
@@ -141,10 +153,13 @@ interface RouterUtilsOptions extends OperationKeyPrefixOptions {
     path?: string[] | undefined;
 }
 /**
- * Create a swr router utils from a client.
+ * Creates SWR utils from a client, exposing fetcher/mutator/subscriber
+ * helpers for every procedure in the router.
+ *
+ * @remarks
+ * **Note**: Both client-side and server-side clients are supported.
  *
- * @info Both client-side and server-side clients are supported.
- * @see {@link https://orpc.dev/docs/integrations/swr SWR Integration}
+ * @see {@link https://orpc.dev/docs/integrations/swr | SWR Integration}
  */
 declare function createRouterUtils<T extends AnyNestedClient>(client: T, options?: RouterUtilsOptions): RouterUtils<T>;
 

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { isPlainObject, resolveMaybeOptionalOptions, isAsyncIteratorObject, toArray, bindMethods, getOrBind, isTypescriptObject } from '@orpc/shared';
+import { isPlainObject, resolveMaybeOptionalOptions, isAsyncIteratorObject, toArray, bindMethods, isTypescriptObject } from '@orpc/shared';
 import { RECURSIVE_CLIENT_UNWRAP_KEYS } from '@orpc/client';
 
 function generateOperationKey(path, options = {}) {
@@ -23,7 +23,7 @@ class SharedUtils {
   /**
    * Generate a matcher function that returns `true` if the key matches the specified conditions.
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#manual-revalidation SWR Manual Revalidation Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#manual-revalidation | SWR Integration - Manual Revalidation}
    */
   matcher(...rest) {
     const { input, strategy = "partial" } = resolveMaybeOptionalOptions(rest);
@@ -46,7 +46,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Calling corresponding procedure client
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#calling-clients SWR Calling Procedure Client Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#calling-clients | SWR Integration - Calling Clients}
    */
   call;
   constructor(path, client, options = {}) {
@@ -56,7 +56,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a **full matching** key for SWR operations.
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Key Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
    */
   key(...rest) {
     const options = resolveMaybeOptionalOptions(rest);
@@ -65,7 +65,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a fetcher function for use with useSWR, useSWRInfinite, and other SWR hooks.
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching SWR Data Fetching Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#data-fetching | SWR Integration - Data Fetching}
    */
   fetcher(...rest) {
     const options = resolveMaybeOptionalOptions(rest);
@@ -82,7 +82,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a subscriber function that subscribes to an [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object) for use with useSWRSubscription, etc.
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions SWR Subscriptions Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions | SWR Integration - Subscriptions}
    */
   subscriber(...rest) {
     const { maxChunks, refetchMode = "reset", ...options } = resolveMaybeOptionalOptions(rest);
@@ -145,7 +145,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a live subscriber that subscribes to the latest events from an [AsyncIteratorObject](https://orpc.dev/docs/async-iterator-object) for use with useSWRSubscription, etc.
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions SWR Subscriptions Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#subscriptions | SWR Integration - Subscriptions}
    */
   liveSubscriber(...rest) {
     const options = resolveMaybeOptionalOptions(rest);
@@ -181,7 +181,7 @@ class ProcedureUtils extends SharedUtils {
   /**
    * Generate a mutator function for use with useSWRMutation, etc.
    *
-   * @see {@link https://orpc.dev/docs/integrations/swr#mutations SWR Mutations Docs}
+   * @see {@link https://orpc.dev/docs/integrations/swr#mutations | SWR Integration - Mutations}
    */
   mutator(...rest) {
     const options = resolveMaybeOptionalOptions(rest);
@@ -196,26 +196,29 @@ class ProcedureUtils extends SharedUtils {
 
 function createRouterUtils(client, options = {}) {
   const path = toArray(options.path);
-  const utils = typeof client === "function" ? bindMethods(new ProcedureUtils(path, client, { prefix: options.prefix })) : bindMethods(new SharedUtils(path, { prefix: options.prefix }));
+  const utils = typeof client === "function" ? bindMethods(new ProcedureUtils(path, client, { prefix: options.prefix }), { unbound: ["call"] }) : bindMethods(new SharedUtils(path, { prefix: options.prefix }));
+  const cache = /* @__PURE__ */ new Map();
   const recursive = new Proxy(utils, {
     get(target, prop) {
-      const value = getOrBind(target, prop);
-      const nextClient = client[prop];
+      const value = Reflect.get(target, prop);
+      const nextClient = Reflect.get(client, prop);
       if (typeof prop !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop) || !isTypescriptObject(nextClient)) {
         return value;
       }
-      const nextUtils = createRouterUtils(nextClient, { ...options, path: [...path, prop] });
-      if (typeof value !== "function") {
-        return nextUtils;
-      }
-      return new Proxy(value, {
-        get(target2, prop2) {
-          if (typeof prop2 !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop2)) {
-            return getOrBind(target2, prop2);
+      let result = cache.get(prop);
+      if (result === void 0) {
+        const nextUtils = createRouterUtils(nextClient, { ...options, path: [...path, prop] });
+        result = typeof value !== "function" ? nextUtils : new Proxy(value, {
+          get(target2, prop2) {
+            if (typeof prop2 !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop2)) {
+              return Reflect.get(target2, prop2);
+            }
+            return Reflect.get(nextUtils, prop2);
           }
-          return getOrBind(nextUtils, prop2);
-        }
-      });
+        });
+        cache.set(prop, result);
+      }
+      return result;
     }
   });
   return recursive;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/swr",
   "type": "module",
-  "version": "2.0.0-beta.23",
+  "version": "2.0.0-beta.25",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -30,8 +30,8 @@
     "swr": ">=2.4.2"
   },
   "dependencies": {
-    "@orpc/client": "2.0.0-beta.23",
-    "@orpc/shared": "2.0.0-beta.23"
+    "@orpc/client": "2.0.0-beta.25",
+    "@orpc/shared": "2.0.0-beta.25"
   },
   "devDependencies": {
     "swr": "^2.4.2",