@orpc/shared 0.0.0-next.0021fba → 0.0.0-next.006cb10

package/README.md

@@ -31,7 +31,7 @@
 - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
 - **📝 Contract-First Development**: Optionally define your API contract before implementation.
 - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
-- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
 - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
 - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
 - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -54,6 +54,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
 - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
 - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
 - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.

package/dist/index.d.mts

@@ -30,7 +30,7 @@ type OmitChainMethodDeep<T extends object, K extends keyof any> = {
 
 declare const ORPC_NAME = "orpc";
 declare const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
-declare const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.0021fba";
+declare const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.006cb10";
 
 /**
  * Error thrown when an operation is aborted.
@@ -60,7 +60,7 @@ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
     /**
      * Aborts the async iterator. Throws if aborted before or during pulling.
      */
-    signal?: AbortSignal;
+    signal?: AbortSignal | undefined;
 }
 declare class EventPublisher<T extends Record<PropertyKey, any>> {
     #private;
@@ -121,6 +121,7 @@ interface Registry {
 type ThrowableError = Registry extends {
     throwableError: infer T;
 } ? T : Error;
+type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
 
 type InterceptableOptions = Record<string, any>;
 type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
@@ -262,6 +263,11 @@ declare function findDeepMatches(check: (value: unknown) => boolean, payload: un
     maps: Segment[][];
     values: unknown[];
 };
+/**
+ * Get constructor of the value
+ *
+ */
+declare function getConstructor(value: unknown): Function | null | undefined;
 /**
  * Check if the value is an object even it created by `Object.create(null)` or more tricky way.
  */
@@ -277,15 +283,24 @@ declare const NullProtoObj: ({
     new <T extends Record<PropertyKey, unknown>>(): T;
 });
 
+/**
+ * Prevents objects from being awaitable by intercepting the `then` method
+ * when called by the native await mechanism. This is useful for preventing
+ * accidental awaiting of objects that aren't meant to be promises.
+ */
+declare function preventNativeAwait<T extends object>(target: T): T;
+
 interface AsyncIdQueueCloseOptions {
     id?: string;
     reason?: unknown;
 }
 declare class AsyncIdQueue<T> {
     private readonly openIds;
-    private readonly items;
-    private readonly pendingPulls;
+    private readonly queues;
+    private readonly waiters;
     get length(): number;
+    get waiterIds(): string[];
+    hasBufferedItems(id: string): boolean;
     open(id: string): void;
     isOpen(id: string): boolean;
     push(id: string, item: T): void;
@@ -302,5 +317,5 @@ declare function tryDecodeURIComponent(value: string): string;
 type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
 declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
 
-export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
-export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };
+export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getConstructor, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
+export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InferAsyncIterableYield, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };

package/dist/index.d.ts

@@ -30,7 +30,7 @@ type OmitChainMethodDeep<T extends object, K extends keyof any> = {
 
 declare const ORPC_NAME = "orpc";
 declare const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
-declare const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.0021fba";
+declare const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.006cb10";
 
 /**
  * Error thrown when an operation is aborted.
@@ -60,7 +60,7 @@ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
     /**
      * Aborts the async iterator. Throws if aborted before or during pulling.
      */
-    signal?: AbortSignal;
+    signal?: AbortSignal | undefined;
 }
 declare class EventPublisher<T extends Record<PropertyKey, any>> {
     #private;
@@ -121,6 +121,7 @@ interface Registry {
 type ThrowableError = Registry extends {
     throwableError: infer T;
 } ? T : Error;
+type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
 
 type InterceptableOptions = Record<string, any>;
 type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
@@ -262,6 +263,11 @@ declare function findDeepMatches(check: (value: unknown) => boolean, payload: un
     maps: Segment[][];
     values: unknown[];
 };
+/**
+ * Get constructor of the value
+ *
+ */
+declare function getConstructor(value: unknown): Function | null | undefined;
 /**
  * Check if the value is an object even it created by `Object.create(null)` or more tricky way.
  */
@@ -277,15 +283,24 @@ declare const NullProtoObj: ({
     new <T extends Record<PropertyKey, unknown>>(): T;
 });
 
+/**
+ * Prevents objects from being awaitable by intercepting the `then` method
+ * when called by the native await mechanism. This is useful for preventing
+ * accidental awaiting of objects that aren't meant to be promises.
+ */
+declare function preventNativeAwait<T extends object>(target: T): T;
+
 interface AsyncIdQueueCloseOptions {
     id?: string;
     reason?: unknown;
 }
 declare class AsyncIdQueue<T> {
     private readonly openIds;
-    private readonly items;
-    private readonly pendingPulls;
+    private readonly queues;
+    private readonly waiters;
     get length(): number;
+    get waiterIds(): string[];
+    hasBufferedItems(id: string): boolean;
     open(id: string): void;
     isOpen(id: string): boolean;
     push(id: string, item: T): void;
@@ -302,5 +317,5 @@ declare function tryDecodeURIComponent(value: string): string;
 type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
 declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
 
-export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
-export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };
+export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getConstructor, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
+export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InferAsyncIterableYield, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };

package/dist/index.mjs

@@ -21,7 +21,7 @@ function readAsBuffer(source) {
 
 const ORPC_NAME = "orpc";
 const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
-const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.0021fba";
+const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.006cb10";
 
 class AbortError extends Error {
   constructor(...rest) {
@@ -153,11 +153,17 @@ async function runInSpanContext(span, fn) {
 
 class AsyncIdQueue {
   openIds = /* @__PURE__ */ new Set();
-  items = /* @__PURE__ */ new Map();
-  pendingPulls = /* @__PURE__ */ new Map();
+  queues = /* @__PURE__ */ new Map();
+  waiters = /* @__PURE__ */ new Map();
   get length() {
     return this.openIds.size;
   }
+  get waiterIds() {
+    return Array.from(this.waiters.keys());
+  }
+  hasBufferedItems(id) {
+    return Boolean(this.queues.get(id)?.length);
+  }
   open(id) {
     this.openIds.add(id);
   }
@@ -166,59 +172,57 @@ class AsyncIdQueue {
   }
   push(id, item) {
     this.assertOpen(id);
-    const pending = this.pendingPulls.get(id);
+    const pending = this.waiters.get(id);
     if (pending?.length) {
       pending.shift()[0](item);
       if (pending.length === 0) {
-        this.pendingPulls.delete(id);
+        this.waiters.delete(id);
       }
     } else {
-      const items = this.items.get(id);
+      const items = this.queues.get(id);
       if (items) {
         items.push(item);
       } else {
-        this.items.set(id, [item]);
+        this.queues.set(id, [item]);
       }
     }
   }
   async pull(id) {
     this.assertOpen(id);
-    const items = this.items.get(id);
+    const items = this.queues.get(id);
     if (items?.length) {
       const item = items.shift();
       if (items.length === 0) {
-        this.items.delete(id);
+        this.queues.delete(id);
       }
       return item;
     }
     return new Promise((resolve, reject) => {
-      const waitingPulls = this.pendingPulls.get(id);
+      const waitingPulls = this.waiters.get(id);
       const pending = [resolve, reject];
       if (waitingPulls) {
         waitingPulls.push(pending);
       } else {
-        this.pendingPulls.set(id, [pending]);
+        this.waiters.set(id, [pending]);
       }
     });
   }
   close({ id, reason } = {}) {
     if (id === void 0) {
-      this.pendingPulls.forEach((pendingPulls, id2) => {
-        pendingPulls.forEach(([, reject]) => {
-          reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id2}] was closed or aborted while waiting for pulling.`));
-        });
+      this.waiters.forEach((pendingPulls, id2) => {
+        const error2 = reason ?? new AbortError(`[AsyncIdQueue] Queue[${id2}] was closed or aborted while waiting for pulling.`);
+        pendingPulls.forEach(([, reject]) => reject(error2));
       });
-      this.pendingPulls.clear();
+      this.waiters.clear();
       this.openIds.clear();
-      this.items.clear();
+      this.queues.clear();
       return;
     }
-    this.pendingPulls.get(id)?.forEach(([, reject]) => {
-      reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`));
-    });
-    this.pendingPulls.delete(id);
+    const error = reason ?? new AbortError(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`);
+    this.waiters.get(id)?.forEach(([, reject]) => reject(error));
+    this.waiters.delete(id);
     this.openIds.delete(id);
-    this.items.delete(id);
+    this.queues.delete(id);
   }
   assertOpen(id) {
     if (!this.isOpen(id)) {
@@ -298,49 +302,51 @@ class AsyncIteratorClass {
 }
 function replicateAsyncIterator(source, count) {
   const queue = new AsyncIdQueue();
-  const replicated = [];
-  let error;
+  const ids = Array.from({ length: count }, (_, i) => i.toString());
+  let isSourceFinished = false;
   const start = once(async () => {
     try {
       while (true) {
         const item = await source.next();
-        for (let id = 0; id < count; id++) {
-          if (queue.isOpen(id.toString())) {
-            queue.push(id.toString(), item);
+        ids.forEach((id) => {
+          if (queue.isOpen(id)) {
+            queue.push(id, { next: item });
           }
-        }
+        });
         if (item.done) {
           break;
         }
       }
-    } catch (e) {
-      error = { value: e };
+    } catch (error) {
+      ids.forEach((id) => {
+        if (queue.isOpen(id)) {
+          queue.push(id, { error });
+        }
+      });
+    } finally {
+      isSourceFinished = true;
     }
   });
-  for (let id = 0; id < count; id++) {
-    queue.open(id.toString());
-    replicated.push(new AsyncIteratorClass(
-      () => {
+  const replicated = ids.map((id) => {
+    queue.open(id);
+    return new AsyncIteratorClass(
+      async () => {
         start();
-        return new Promise((resolve, reject) => {
-          queue.pull(id.toString()).then(resolve).catch(reject);
-          defer(() => {
-            if (error) {
-              reject(error.value);
-            }
-          });
-        });
+        const item = await queue.pull(id);
+        if (item.next) {
+          return item.next;
+        }
+        throw item.error;
       },
       async (reason) => {
-        queue.close({ id: id.toString() });
-        if (reason !== "next") {
-          if (replicated.every((_, id2) => !queue.isOpen(id2.toString()))) {
-            await source?.return?.();
-          }
+        queue.close({ id });
+        if (reason !== "next" && !queue.length && !isSourceFinished) {
+          isSourceFinished = true;
+          await source?.return?.();
         }
       }
-    ));
-  }
+    );
+  });
   return replicated;
 }
 function asyncIteratorWithSpan({ name, ...options }, iterator) {
@@ -536,6 +542,12 @@ function findDeepMatches(check, payload, segments = [], maps = [], values = [])
   }
   return { maps, values };
 }
+function getConstructor(value) {
+  if (!isTypescriptObject(value)) {
+    return null;
+  }
+  return Object.getPrototypeOf(value)?.constructor;
+}
 function isObject(value) {
   if (!value || typeof value !== "object") {
     return false;
@@ -581,6 +593,38 @@ const NullProtoObj = /* @__PURE__ */ (() => {
   return e;
 })();
 
+function preventNativeAwait(target) {
+  return new Proxy(target, {
+    get(target2, prop, receiver) {
+      const value = Reflect.get(target2, prop, receiver);
+      if (prop !== "then" || typeof value !== "function") {
+        return value;
+      }
+      return new Proxy(value, {
+        apply(targetFn, thisArg, args) {
+          if (args.length !== 2 || args.some((arg) => !isNativeFunction(arg))) {
+            return Reflect.apply(targetFn, thisArg, args);
+          }
+          let shouldOmit = true;
+          args[0].call(thisArg, preventNativeAwait(new Proxy(target2, {
+            get: (target3, prop2, receiver2) => {
+              if (shouldOmit && prop2 === "then") {
+                shouldOmit = false;
+                return void 0;
+              }
+              return Reflect.get(target3, prop2, receiver2);
+            }
+          })));
+        }
+      });
+    }
+  });
+}
+const NATIVE_FUNCTION_REGEX = /^\s*function\s*\(\)\s*\{\s*\[native code\]\s*\}\s*$/;
+function isNativeFunction(fn) {
+  return typeof fn === "function" && NATIVE_FUNCTION_REGEX.test(fn.toString());
+}
+
 function streamToAsyncIteratorClass(stream) {
   const reader = stream.getReader();
   return new AsyncIteratorClass(
@@ -623,4 +667,4 @@ function value(value2, ...args) {
   return value2;
 }
 
-export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
+export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getConstructor, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/shared",
   "type": "module",
-  "version": "0.0.0-next.0021fba",
+  "version": "0.0.0-next.006cb10",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -37,9 +37,9 @@
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.0",
-    "arktype": "2.1.20",
+    "arktype": "2.1.21",
     "valibot": "^1.1.0",
-    "zod": "^4.0.17"
+    "zod": "^4.1.5"
   },
   "scripts": {
     "build": "unbuild",