@orpc/shared 1.2.0 → 1.4.0

package/README.md

@@ -54,6 +54,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
 - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).

package/dist/index.d.mts

@@ -11,6 +11,10 @@ declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
 type AnyFunction = (...args: any[]) => any;
 declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
 declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
+/**
+ * Executes the callback function after the current call stack has been cleared.
+ */
+declare function defer(callback: () => void): void;
 
 type OmitChainMethodDeep<T extends object, K extends keyof any> = {
     [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
@@ -40,10 +44,10 @@ type ThrowableError = Registry extends {
 } ? T : Error;
 
 type InterceptableOptions = Record<string, any>;
-type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
-    next(options?: TOptions): PromiseWithError<TResult, TError>;
+type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
+    next(options?: TOptions): TResult;
 };
-type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => Promisable<TResult>;
+type Interceptor<TOptions extends InterceptableOptions, TResult> = (options: InterceptorOptions<TOptions, TResult>) => TResult;
 /**
  * Can used for interceptors or middlewares
  */
@@ -69,13 +73,14 @@ type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess
 declare function onFinish<T, TOptions extends {
     next(): any;
 }, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>, ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
-declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
+declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
 
 declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
 interface CreateAsyncIteratorObjectCleanupFn {
     (reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
 }
 declare function createAsyncIteratorObject<T, TReturn, TNext>(next: () => Promise<IteratorResult<T, TReturn>>, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>;
+declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>)[];
 
 declare function parseEmptyableJSON(text: string | null | undefined): unknown;
 declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
@@ -95,10 +100,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
 declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
 declare function clone<T>(value: T): T;
 declare function get(object: object, path: readonly string[]): unknown;
+declare function isPropertyKey(value: unknown): value is PropertyKey;
+declare const NullProtoObj: ({
+    new <T extends Record<PropertyKey, unknown>>(): T;
+});
 
 interface AsyncIdQueueCloseOptions {
     id?: number;
-    reason?: Error;
+    reason?: unknown;
 }
 declare class AsyncIdQueue<T> {
     private readonly openIds;
@@ -113,8 +122,8 @@ declare class AsyncIdQueue<T> {
     assertOpen(id: number): void;
 }
 
-type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
-declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
+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 { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
+export { AsyncIdQueue, NullProtoObj, SequentialIdGenerator, clone, createAsyncIteratorObject, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
 export type { AnyFunction, AsyncIdQueueCloseOptions, CreateAsyncIteratorObjectCleanupFn, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };

package/dist/index.d.ts

@@ -11,6 +11,10 @@ declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
 type AnyFunction = (...args: any[]) => any;
 declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
 declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
+/**
+ * Executes the callback function after the current call stack has been cleared.
+ */
+declare function defer(callback: () => void): void;
 
 type OmitChainMethodDeep<T extends object, K extends keyof any> = {
     [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
@@ -40,10 +44,10 @@ type ThrowableError = Registry extends {
 } ? T : Error;
 
 type InterceptableOptions = Record<string, any>;
-type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
-    next(options?: TOptions): PromiseWithError<TResult, TError>;
+type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
+    next(options?: TOptions): TResult;
 };
-type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => Promisable<TResult>;
+type Interceptor<TOptions extends InterceptableOptions, TResult> = (options: InterceptorOptions<TOptions, TResult>) => TResult;
 /**
  * Can used for interceptors or middlewares
  */
@@ -69,13 +73,14 @@ type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess
 declare function onFinish<T, TOptions extends {
     next(): any;
 }, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>, ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
-declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
+declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
 
 declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
 interface CreateAsyncIteratorObjectCleanupFn {
     (reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
 }
 declare function createAsyncIteratorObject<T, TReturn, TNext>(next: () => Promise<IteratorResult<T, TReturn>>, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>;
+declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>)[];
 
 declare function parseEmptyableJSON(text: string | null | undefined): unknown;
 declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
@@ -95,10 +100,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
 declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
 declare function clone<T>(value: T): T;
 declare function get(object: object, path: readonly string[]): unknown;
+declare function isPropertyKey(value: unknown): value is PropertyKey;
+declare const NullProtoObj: ({
+    new <T extends Record<PropertyKey, unknown>>(): T;
+});
 
 interface AsyncIdQueueCloseOptions {
     id?: number;
-    reason?: Error;
+    reason?: unknown;
 }
 declare class AsyncIdQueue<T> {
     private readonly openIds;
@@ -113,8 +122,8 @@ declare class AsyncIdQueue<T> {
     assertOpen(id: number): void;
 }
 
-type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
-declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
+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 { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
+export { AsyncIdQueue, NullProtoObj, SequentialIdGenerator, clone, createAsyncIteratorObject, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
 export type { AnyFunction, AsyncIdQueueCloseOptions, CreateAsyncIteratorObjectCleanupFn, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };

package/dist/index.mjs

@@ -32,6 +32,13 @@ function sequential(fn) {
     });
   };
 }
+function defer(callback) {
+  if ("setTimeout" in globalThis && typeof globalThis.setTimeout === "function") {
+    globalThis.setTimeout(callback, 0);
+  } else {
+    Promise.resolve().then(() => Promise.resolve().then(() => Promise.resolve().then(callback)));
+  }
+}
 
 class SequentialIdGenerator {
   nextId = 0;
@@ -82,13 +89,13 @@ function onFinish(callback) {
     }
   };
 }
-async function intercept(interceptors, options, main) {
-  const next = async (options2, index) => {
+function intercept(interceptors, options, main) {
+  const next = (options2, index) => {
     const interceptor = interceptors[index];
     if (!interceptor) {
-      return await main(options2);
+      return main(options2);
     }
-    return await interceptor({
+    return interceptor({
       ...options2,
       next: (newOptions = options2) => next(newOptions, index + 1)
     });
@@ -96,6 +103,82 @@ async function intercept(interceptors, options, main) {
   return next(options, 0);
 }
 
+class AsyncIdQueue {
+  openIds = /* @__PURE__ */ new Set();
+  items = /* @__PURE__ */ new Map();
+  pendingPulls = /* @__PURE__ */ new Map();
+  get length() {
+    return this.openIds.size;
+  }
+  open(id) {
+    this.openIds.add(id);
+  }
+  isOpen(id) {
+    return this.openIds.has(id);
+  }
+  push(id, item) {
+    this.assertOpen(id);
+    const pending = this.pendingPulls.get(id);
+    if (pending?.length) {
+      pending.shift()[0](item);
+      if (pending.length === 0) {
+        this.pendingPulls.delete(id);
+      }
+    } else {
+      const items = this.items.get(id);
+      if (items) {
+        items.push(item);
+      } else {
+        this.items.set(id, [item]);
+      }
+    }
+  }
+  async pull(id) {
+    this.assertOpen(id);
+    const items = this.items.get(id);
+    if (items?.length) {
+      const item = items.shift();
+      if (items.length === 0) {
+        this.items.delete(id);
+      }
+      return item;
+    }
+    return new Promise((resolve, reject) => {
+      const waitingPulls = this.pendingPulls.get(id);
+      const pending = [resolve, reject];
+      if (waitingPulls) {
+        waitingPulls.push(pending);
+      } else {
+        this.pendingPulls.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.pendingPulls.clear();
+      this.openIds.clear();
+      this.items.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);
+    this.openIds.delete(id);
+    this.items.delete(id);
+  }
+  assertOpen(id) {
+    if (!this.isOpen(id)) {
+      throw new Error(`[AsyncIdQueue] Cannot access queue[${id}] because it is not open or aborted.`);
+    }
+  }
+}
+
 function isAsyncIteratorObject(maybe) {
   if (!maybe || typeof maybe !== "object") {
     return false;
@@ -158,6 +241,53 @@ function createAsyncIteratorObject(next, cleanup) {
   };
   return iterator;
 }
+function replicateAsyncIterator(source, count) {
+  const queue = new AsyncIdQueue();
+  const replicated = [];
+  let error;
+  const start = once(async () => {
+    try {
+      while (true) {
+        const item = await source.next();
+        for (let id = 0; id < count; id++) {
+          if (queue.isOpen(id)) {
+            queue.push(id, item);
+          }
+        }
+        if (item.done) {
+          break;
+        }
+      }
+    } catch (e) {
+      error = { value: e };
+    }
+  });
+  for (let id = 0; id < count; id++) {
+    queue.open(id);
+    replicated.push(createAsyncIteratorObject(
+      () => {
+        start();
+        return new Promise((resolve, reject) => {
+          queue.pull(id).then(resolve).catch(reject);
+          defer(() => {
+            if (error) {
+              reject(error.value);
+            }
+          });
+        });
+      },
+      async (reason) => {
+        queue.close({ id });
+        if (reason !== "next") {
+          if (replicated.every((_, id2) => !queue.isOpen(id2))) {
+            await source?.return?.();
+          }
+        }
+      }
+    ));
+  }
+  return replicated;
+}
 
 function parseEmptyableJSON(text) {
   if (!text) {
@@ -217,82 +347,17 @@ function get(object, path) {
   }
   return current;
 }
-
-class AsyncIdQueue {
-  openIds = /* @__PURE__ */ new Set();
-  items = /* @__PURE__ */ new Map();
-  pendingPulls = /* @__PURE__ */ new Map();
-  get length() {
-    return this.openIds.size;
-  }
-  open(id) {
-    this.openIds.add(id);
-  }
-  isOpen(id) {
-    return this.openIds.has(id);
-  }
-  push(id, item) {
-    this.assertOpen(id);
-    const pending = this.pendingPulls.get(id);
-    if (pending?.length) {
-      pending.shift()[0](item);
-      if (pending.length === 0) {
-        this.pendingPulls.delete(id);
-      }
-    } else {
-      const items = this.items.get(id);
-      if (items) {
-        items.push(item);
-      } else {
-        this.items.set(id, [item]);
-      }
-    }
-  }
-  async pull(id) {
-    this.assertOpen(id);
-    const items = this.items.get(id);
-    if (items?.length) {
-      const item = items.shift();
-      if (items.length === 0) {
-        this.items.delete(id);
-      }
-      return item;
-    }
-    return new Promise((resolve, reject) => {
-      const waitingPulls = this.pendingPulls.get(id);
-      const pending = [resolve, reject];
-      if (waitingPulls) {
-        waitingPulls.push(pending);
-      } else {
-        this.pendingPulls.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.pendingPulls.clear();
-      this.openIds.clear();
-      this.items.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);
-    this.openIds.delete(id);
-    this.items.delete(id);
-  }
-  assertOpen(id) {
-    if (!this.isOpen(id)) {
-      throw new Error(`[AsyncIdQueue] Cannot access queue[${id}] because it is not open or aborted.`);
-    }
-  }
+function isPropertyKey(value) {
+  const type = typeof value;
+  return type === "string" || type === "number" || type === "symbol";
 }
+const NullProtoObj = /* @__PURE__ */ (() => {
+  const e = function() {
+  };
+  e.prototype = /* @__PURE__ */ Object.create(null);
+  Object.freeze(e.prototype);
+  return e;
+})();
 
 function value(value2, ...args) {
   if (typeof value2 === "function") {
@@ -301,4 +366,4 @@ function value(value2, ...args) {
   return value2;
 }
 
-export { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
+export { AsyncIdQueue, NullProtoObj, SequentialIdGenerator, clone, createAsyncIteratorObject, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/shared",
   "type": "module",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -27,6 +27,11 @@
     "radash": "^12.1.0",
     "type-fest": "^4.39.1"
   },
+  "devDependencies": {
+    "arktype": "2.1.20",
+    "valibot": "^1.1.0",
+    "zod": "^3.25.49"
+  },
   "scripts": {
     "build": "unbuild",
     "build:watch": "pnpm run build --watch",