@orpc/shared 0.51.0 → 0.52.0

package/README.md

@@ -58,6 +58,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/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).
 - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).

package/dist/index.d.mts

@@ -14,17 +14,29 @@ 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];
 };
 
-declare function toError(error: unknown): Error;
-
-type InterceptableOptions = Record<string, any>;
-type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
-    next(options?: TOptions): Promise<TResult>;
-};
-type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult>) => Promise<TResult> & {
+type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
+type PromiseWithError<T, TError> = Promise<T> & {
     __error?: {
         type: TError;
     };
 };
+/**
+ * The place where you can config the orpc types.
+ *
+ * - `throwableError` the error type that represent throwable errors should be `Error` or `null | undefined | {}` if you want more strict.
+ */
+interface Registry {
+}
+type ThrowableError = Registry extends {
+    throwableError: infer T;
+} ? T : Error;
+
+type InterceptableOptions = Record<string, any>;
+type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
+    next(options?: TOptions): PromiseWithError<TResult, TError>;
+};
+type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => PromiseWithError<TResult, TError>;
 /**
  * Can used for interceptors or middlewares
  */
@@ -40,24 +52,16 @@ declare function onSuccess<TOptions extends {
 /**
  * Can used for interceptors or middlewares
  */
-declare function onError<TError, TOptions extends {
+declare function onError<TOptions extends {
     next(): any;
-}, TRest extends any[]>(callback: NoInfer<(error: TError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>> & {
-    __error?: {
-        type: TError;
-    };
-};
+}, TRest extends any[]>(callback: NoInfer<(error: ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
 type OnFinishState<TResult, TError> = [TResult, null, 'success'] | [undefined, TError, 'error'];
 /**
  * Can used for interceptors or middlewares
  */
-declare function onFinish<TError, TOptions extends {
+declare function onFinish<TOptions extends {
     next(): any;
-}, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>, TError>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>> & {
-    __error?: {
-        type: TError;
-    };
-};
+}, 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) => 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 isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
@@ -79,11 +83,9 @@ 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;
-
-type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
+declare function get(object: object, path: readonly string[]): unknown;
 
 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>;
 
-export { type AnyFunction, type InterceptableOptions, type Interceptor, type InterceptorOptions, type IntersectPick, type MaybeOptionalOptions, type OmitChainMethodDeep, type OnFinishState, type Segment, type SetOptional, type Value, clone, findDeepMatches, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, toError, value };
+export { type AnyFunction, type InterceptableOptions, type Interceptor, type InterceptorOptions, type IntersectPick, type MaybeOptionalOptions, type OmitChainMethodDeep, type OnFinishState, type PromiseWithError, type Registry, type Segment, type SetOptional, type ThrowableError, type Value, clone, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, value };

package/dist/index.d.ts

@@ -14,17 +14,29 @@ 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];
 };
 
-declare function toError(error: unknown): Error;
-
-type InterceptableOptions = Record<string, any>;
-type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
-    next(options?: TOptions): Promise<TResult>;
-};
-type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult>) => Promise<TResult> & {
+type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
+type PromiseWithError<T, TError> = Promise<T> & {
     __error?: {
         type: TError;
     };
 };
+/**
+ * The place where you can config the orpc types.
+ *
+ * - `throwableError` the error type that represent throwable errors should be `Error` or `null | undefined | {}` if you want more strict.
+ */
+interface Registry {
+}
+type ThrowableError = Registry extends {
+    throwableError: infer T;
+} ? T : Error;
+
+type InterceptableOptions = Record<string, any>;
+type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
+    next(options?: TOptions): PromiseWithError<TResult, TError>;
+};
+type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => PromiseWithError<TResult, TError>;
 /**
  * Can used for interceptors or middlewares
  */
@@ -40,24 +52,16 @@ declare function onSuccess<TOptions extends {
 /**
  * Can used for interceptors or middlewares
  */
-declare function onError<TError, TOptions extends {
+declare function onError<TOptions extends {
     next(): any;
-}, TRest extends any[]>(callback: NoInfer<(error: TError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>> & {
-    __error?: {
-        type: TError;
-    };
-};
+}, TRest extends any[]>(callback: NoInfer<(error: ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
 type OnFinishState<TResult, TError> = [TResult, null, 'success'] | [undefined, TError, 'error'];
 /**
  * Can used for interceptors or middlewares
  */
-declare function onFinish<TError, TOptions extends {
+declare function onFinish<TOptions extends {
     next(): any;
-}, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>, TError>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>> & {
-    __error?: {
-        type: TError;
-    };
-};
+}, 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) => 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 isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
@@ -79,11 +83,9 @@ 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;
-
-type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
+declare function get(object: object, path: readonly string[]): unknown;
 
 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>;
 
-export { type AnyFunction, type InterceptableOptions, type Interceptor, type InterceptorOptions, type IntersectPick, type MaybeOptionalOptions, type OmitChainMethodDeep, type OnFinishState, type Segment, type SetOptional, type Value, clone, findDeepMatches, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, toError, value };
+export { type AnyFunction, type InterceptableOptions, type Interceptor, type InterceptorOptions, type IntersectPick, type MaybeOptionalOptions, type OmitChainMethodDeep, type OnFinishState, type PromiseWithError, type Registry, type Segment, type SetOptional, type ThrowableError, type Value, clone, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, value };

package/dist/index.mjs

@@ -8,13 +8,6 @@ function toArray(value) {
   return Array.isArray(value) ? value : value === void 0 || value === null ? [] : [value];
 }
 
-function toError(error) {
-  if (error instanceof Error) {
-    return error;
-  }
-  return new Error("Unknown error", { cause: error });
-}
-
 function once(fn) {
   let cached;
   return () => {
@@ -135,6 +128,16 @@ function clone(value) {
   }
   return value;
 }
+function get(object, path) {
+  let current = object;
+  for (const key of path) {
+    if (!isTypescriptObject(current)) {
+      return void 0;
+    }
+    current = current[key];
+  }
+  return current;
+}
 
 function value(value2, ...args) {
   if (typeof value2 === "function") {
@@ -143,4 +146,4 @@ function value(value2, ...args) {
   return value2;
 }
 
-export { clone, findDeepMatches, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, toError, value };
+export { clone, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, value };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/shared",
   "type": "module",
-  "version": "0.51.0",
+  "version": "0.52.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {