@orpc/shared 0.0.0-next.ea0903c → 0.0.0-next.eae6003
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -17
- package/dist/index.d.mts +58 -27
- package/dist/index.d.ts +58 -27
- package/dist/index.mjs +172 -14
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -26,28 +26,24 @@
|
|
|
26
26
|
|
|
27
27
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
28
28
|
|
|
29
|
-
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
|
29
|
+
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
|
30
30
|
|
|
31
31
|
---
|
|
32
32
|
|
|
33
33
|
## Highlights
|
|
34
34
|
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
44
|
-
-
|
|
45
|
-
-
|
|
46
|
-
-
|
|
47
|
-
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
|
48
|
-
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
|
49
|
-
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
|
50
|
-
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
|
35
|
+
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
36
|
+
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
37
|
+
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
|
38
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
|
39
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
40
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
41
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
42
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
|
43
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
44
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
45
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
46
|
+
- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
|
51
47
|
|
|
52
48
|
## Documentation
|
|
53
49
|
|
|
@@ -58,6 +54,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
58
54
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
59
55
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
60
56
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
57
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
|
|
58
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
61
59
|
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
|
62
60
|
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
63
61
|
- [@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
CHANGED
|
@@ -5,62 +5,77 @@ export { group, guard, mapEntries, mapValues, omit } from 'radash';
|
|
|
5
5
|
type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
|
|
6
6
|
declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>): T;
|
|
7
7
|
|
|
8
|
-
declare function toArray<T>(value: T
|
|
8
|
+
declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
|
|
9
|
+
declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
|
|
9
10
|
|
|
10
11
|
type AnyFunction = (...args: any[]) => any;
|
|
11
12
|
declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
|
|
13
|
+
declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
|
|
12
14
|
|
|
13
15
|
type OmitChainMethodDeep<T extends object, K extends keyof any> = {
|
|
14
16
|
[P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
|
|
15
17
|
};
|
|
16
18
|
|
|
17
|
-
declare
|
|
19
|
+
declare class SequentialIdGenerator {
|
|
20
|
+
private nextId;
|
|
21
|
+
generate(): number;
|
|
22
|
+
}
|
|
18
23
|
|
|
19
|
-
type
|
|
20
|
-
type
|
|
21
|
-
|
|
22
|
-
};
|
|
23
|
-
type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult>) => Promise<TResult> & {
|
|
24
|
+
type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
25
|
+
type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
|
|
26
|
+
type PromiseWithError<T, TError> = Promise<T> & {
|
|
24
27
|
__error?: {
|
|
25
28
|
type: TError;
|
|
26
29
|
};
|
|
27
30
|
};
|
|
31
|
+
/**
|
|
32
|
+
* The place where you can config the orpc types.
|
|
33
|
+
*
|
|
34
|
+
* - `throwableError` the error type that represent throwable errors should be `Error` or `null | undefined | {}` if you want more strict.
|
|
35
|
+
*/
|
|
36
|
+
interface Registry {
|
|
37
|
+
}
|
|
38
|
+
type ThrowableError = Registry extends {
|
|
39
|
+
throwableError: infer T;
|
|
40
|
+
} ? T : Error;
|
|
41
|
+
|
|
42
|
+
type InterceptableOptions = Record<string, any>;
|
|
43
|
+
type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
|
|
44
|
+
next(options?: TOptions): PromiseWithError<TResult, TError>;
|
|
45
|
+
};
|
|
46
|
+
type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => Promisable<TResult>;
|
|
28
47
|
/**
|
|
29
48
|
* Can used for interceptors or middlewares
|
|
30
49
|
*/
|
|
31
|
-
declare function onStart<TOptions extends {
|
|
50
|
+
declare function onStart<T, TOptions extends {
|
|
32
51
|
next(): any;
|
|
33
|
-
}, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
52
|
+
}, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
34
53
|
/**
|
|
35
54
|
* Can used for interceptors or middlewares
|
|
36
55
|
*/
|
|
37
|
-
declare function onSuccess<TOptions extends {
|
|
56
|
+
declare function onSuccess<T, TOptions extends {
|
|
38
57
|
next(): any;
|
|
39
|
-
}, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
58
|
+
}, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
40
59
|
/**
|
|
41
60
|
* Can used for interceptors or middlewares
|
|
42
61
|
*/
|
|
43
|
-
declare function onError<
|
|
62
|
+
declare function onError<T, TOptions extends {
|
|
44
63
|
next(): any;
|
|
45
|
-
}, TRest extends any[]>(callback: NoInfer<(error:
|
|
46
|
-
|
|
47
|
-
type: TError;
|
|
48
|
-
};
|
|
49
|
-
};
|
|
50
|
-
type OnFinishState<TResult, TError> = [TResult, null, 'success'] | [undefined, TError, 'error'];
|
|
64
|
+
}, 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) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
65
|
+
type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess: false] | [error: null, data: TResult, isSuccess: true];
|
|
51
66
|
/**
|
|
52
67
|
* Can used for interceptors or middlewares
|
|
53
68
|
*/
|
|
54
|
-
declare function onFinish<
|
|
69
|
+
declare function onFinish<T, TOptions extends {
|
|
55
70
|
next(): any;
|
|
56
|
-
}, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>,
|
|
57
|
-
__error?: {
|
|
58
|
-
type: TError;
|
|
59
|
-
};
|
|
60
|
-
};
|
|
71
|
+
}, 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']>>>;
|
|
61
72
|
declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
|
|
62
73
|
|
|
63
74
|
declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
|
|
75
|
+
interface CreateAsyncIteratorObjectCleanupFn {
|
|
76
|
+
(reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
|
|
77
|
+
}
|
|
78
|
+
declare function createAsyncIteratorObject<T, TReturn, TNext>(next: () => Promise<IteratorResult<T, TReturn>>, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>;
|
|
64
79
|
|
|
65
80
|
declare function parseEmptyableJSON(text: string | null | undefined): unknown;
|
|
66
81
|
declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
|
|
@@ -79,11 +94,27 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
79
94
|
*/
|
|
80
95
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
81
96
|
declare function clone<T>(value: T): T;
|
|
97
|
+
declare function get(object: object, path: readonly string[]): unknown;
|
|
82
98
|
|
|
83
|
-
|
|
84
|
-
|
|
99
|
+
interface AsyncIdQueueCloseOptions {
|
|
100
|
+
id?: number;
|
|
101
|
+
reason?: Error;
|
|
102
|
+
}
|
|
103
|
+
declare class AsyncIdQueue<T> {
|
|
104
|
+
private readonly openIds;
|
|
105
|
+
private readonly items;
|
|
106
|
+
private readonly pendingPulls;
|
|
107
|
+
get length(): number;
|
|
108
|
+
open(id: number): void;
|
|
109
|
+
isOpen(id: number): boolean;
|
|
110
|
+
push(id: number, item: T): void;
|
|
111
|
+
pull(id: number): Promise<T>;
|
|
112
|
+
close({ id, reason }?: AsyncIdQueueCloseOptions): void;
|
|
113
|
+
assertOpen(id: number): void;
|
|
114
|
+
}
|
|
85
115
|
|
|
86
116
|
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
|
|
87
117
|
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
|
|
88
118
|
|
|
89
|
-
export {
|
|
119
|
+
export { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
|
120
|
+
export type { AnyFunction, AsyncIdQueueCloseOptions, CreateAsyncIteratorObjectCleanupFn, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
package/dist/index.d.ts
CHANGED
|
@@ -5,62 +5,77 @@ export { group, guard, mapEntries, mapValues, omit } from 'radash';
|
|
|
5
5
|
type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
|
|
6
6
|
declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>): T;
|
|
7
7
|
|
|
8
|
-
declare function toArray<T>(value: T
|
|
8
|
+
declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
|
|
9
|
+
declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
|
|
9
10
|
|
|
10
11
|
type AnyFunction = (...args: any[]) => any;
|
|
11
12
|
declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
|
|
13
|
+
declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
|
|
12
14
|
|
|
13
15
|
type OmitChainMethodDeep<T extends object, K extends keyof any> = {
|
|
14
16
|
[P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
|
|
15
17
|
};
|
|
16
18
|
|
|
17
|
-
declare
|
|
19
|
+
declare class SequentialIdGenerator {
|
|
20
|
+
private nextId;
|
|
21
|
+
generate(): number;
|
|
22
|
+
}
|
|
18
23
|
|
|
19
|
-
type
|
|
20
|
-
type
|
|
21
|
-
|
|
22
|
-
};
|
|
23
|
-
type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult>) => Promise<TResult> & {
|
|
24
|
+
type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
25
|
+
type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
|
|
26
|
+
type PromiseWithError<T, TError> = Promise<T> & {
|
|
24
27
|
__error?: {
|
|
25
28
|
type: TError;
|
|
26
29
|
};
|
|
27
30
|
};
|
|
31
|
+
/**
|
|
32
|
+
* The place where you can config the orpc types.
|
|
33
|
+
*
|
|
34
|
+
* - `throwableError` the error type that represent throwable errors should be `Error` or `null | undefined | {}` if you want more strict.
|
|
35
|
+
*/
|
|
36
|
+
interface Registry {
|
|
37
|
+
}
|
|
38
|
+
type ThrowableError = Registry extends {
|
|
39
|
+
throwableError: infer T;
|
|
40
|
+
} ? T : Error;
|
|
41
|
+
|
|
42
|
+
type InterceptableOptions = Record<string, any>;
|
|
43
|
+
type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
|
|
44
|
+
next(options?: TOptions): PromiseWithError<TResult, TError>;
|
|
45
|
+
};
|
|
46
|
+
type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => Promisable<TResult>;
|
|
28
47
|
/**
|
|
29
48
|
* Can used for interceptors or middlewares
|
|
30
49
|
*/
|
|
31
|
-
declare function onStart<TOptions extends {
|
|
50
|
+
declare function onStart<T, TOptions extends {
|
|
32
51
|
next(): any;
|
|
33
|
-
}, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
52
|
+
}, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
34
53
|
/**
|
|
35
54
|
* Can used for interceptors or middlewares
|
|
36
55
|
*/
|
|
37
|
-
declare function onSuccess<TOptions extends {
|
|
56
|
+
declare function onSuccess<T, TOptions extends {
|
|
38
57
|
next(): any;
|
|
39
|
-
}, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
58
|
+
}, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
40
59
|
/**
|
|
41
60
|
* Can used for interceptors or middlewares
|
|
42
61
|
*/
|
|
43
|
-
declare function onError<
|
|
62
|
+
declare function onError<T, TOptions extends {
|
|
44
63
|
next(): any;
|
|
45
|
-
}, TRest extends any[]>(callback: NoInfer<(error:
|
|
46
|
-
|
|
47
|
-
type: TError;
|
|
48
|
-
};
|
|
49
|
-
};
|
|
50
|
-
type OnFinishState<TResult, TError> = [TResult, null, 'success'] | [undefined, TError, 'error'];
|
|
64
|
+
}, 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) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
|
|
65
|
+
type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess: false] | [error: null, data: TResult, isSuccess: true];
|
|
51
66
|
/**
|
|
52
67
|
* Can used for interceptors or middlewares
|
|
53
68
|
*/
|
|
54
|
-
declare function onFinish<
|
|
69
|
+
declare function onFinish<T, TOptions extends {
|
|
55
70
|
next(): any;
|
|
56
|
-
}, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>,
|
|
57
|
-
__error?: {
|
|
58
|
-
type: TError;
|
|
59
|
-
};
|
|
60
|
-
};
|
|
71
|
+
}, 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']>>>;
|
|
61
72
|
declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
|
|
62
73
|
|
|
63
74
|
declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
|
|
75
|
+
interface CreateAsyncIteratorObjectCleanupFn {
|
|
76
|
+
(reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
|
|
77
|
+
}
|
|
78
|
+
declare function createAsyncIteratorObject<T, TReturn, TNext>(next: () => Promise<IteratorResult<T, TReturn>>, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>;
|
|
64
79
|
|
|
65
80
|
declare function parseEmptyableJSON(text: string | null | undefined): unknown;
|
|
66
81
|
declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
|
|
@@ -79,11 +94,27 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
79
94
|
*/
|
|
80
95
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
81
96
|
declare function clone<T>(value: T): T;
|
|
97
|
+
declare function get(object: object, path: readonly string[]): unknown;
|
|
82
98
|
|
|
83
|
-
|
|
84
|
-
|
|
99
|
+
interface AsyncIdQueueCloseOptions {
|
|
100
|
+
id?: number;
|
|
101
|
+
reason?: Error;
|
|
102
|
+
}
|
|
103
|
+
declare class AsyncIdQueue<T> {
|
|
104
|
+
private readonly openIds;
|
|
105
|
+
private readonly items;
|
|
106
|
+
private readonly pendingPulls;
|
|
107
|
+
get length(): number;
|
|
108
|
+
open(id: number): void;
|
|
109
|
+
isOpen(id: number): boolean;
|
|
110
|
+
push(id: number, item: T): void;
|
|
111
|
+
pull(id: number): Promise<T>;
|
|
112
|
+
close({ id, reason }?: AsyncIdQueueCloseOptions): void;
|
|
113
|
+
assertOpen(id: number): void;
|
|
114
|
+
}
|
|
85
115
|
|
|
86
116
|
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
|
|
87
117
|
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
|
|
88
118
|
|
|
89
|
-
export {
|
|
119
|
+
export { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
|
120
|
+
export type { AnyFunction, AsyncIdQueueCloseOptions, CreateAsyncIteratorObjectCleanupFn, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
package/dist/index.mjs
CHANGED
|
@@ -7,12 +7,9 @@ function resolveMaybeOptionalOptions(rest) {
|
|
|
7
7
|
function toArray(value) {
|
|
8
8
|
return Array.isArray(value) ? value : value === void 0 || value === null ? [] : [value];
|
|
9
9
|
}
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
return error;
|
|
14
|
-
}
|
|
15
|
-
return new Error("Unknown error", { cause: error });
|
|
10
|
+
function splitInHalf(arr) {
|
|
11
|
+
const half = Math.ceil(arr.length / 2);
|
|
12
|
+
return [arr.slice(0, half), arr.slice(half)];
|
|
16
13
|
}
|
|
17
14
|
|
|
18
15
|
function once(fn) {
|
|
@@ -26,6 +23,26 @@ function once(fn) {
|
|
|
26
23
|
return result;
|
|
27
24
|
};
|
|
28
25
|
}
|
|
26
|
+
function sequential(fn) {
|
|
27
|
+
let lastOperationPromise = Promise.resolve();
|
|
28
|
+
return (...args) => {
|
|
29
|
+
return lastOperationPromise = lastOperationPromise.catch(() => {
|
|
30
|
+
}).then(() => {
|
|
31
|
+
return fn(...args);
|
|
32
|
+
});
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
class SequentialIdGenerator {
|
|
37
|
+
nextId = 0;
|
|
38
|
+
generate() {
|
|
39
|
+
if (this.nextId === Number.MAX_SAFE_INTEGER) {
|
|
40
|
+
this.nextId = 0;
|
|
41
|
+
return Number.MAX_SAFE_INTEGER;
|
|
42
|
+
}
|
|
43
|
+
return this.nextId++;
|
|
44
|
+
}
|
|
45
|
+
}
|
|
29
46
|
|
|
30
47
|
function onStart(callback) {
|
|
31
48
|
return async (options, ...rest) => {
|
|
@@ -55,10 +72,10 @@ function onFinish(callback) {
|
|
|
55
72
|
return async (options, ...rest) => {
|
|
56
73
|
try {
|
|
57
74
|
const result = await options.next();
|
|
58
|
-
state = [
|
|
75
|
+
state = [null, result, true];
|
|
59
76
|
return result;
|
|
60
77
|
} catch (error) {
|
|
61
|
-
state = [void 0,
|
|
78
|
+
state = [error, void 0, false];
|
|
62
79
|
throw error;
|
|
63
80
|
} finally {
|
|
64
81
|
await callback(state, options, ...rest);
|
|
@@ -66,18 +83,17 @@ function onFinish(callback) {
|
|
|
66
83
|
};
|
|
67
84
|
}
|
|
68
85
|
async function intercept(interceptors, options, main) {
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
const interceptor = interceptors[index++];
|
|
86
|
+
const next = async (options2, index) => {
|
|
87
|
+
const interceptor = interceptors[index];
|
|
72
88
|
if (!interceptor) {
|
|
73
89
|
return await main(options2);
|
|
74
90
|
}
|
|
75
91
|
return await interceptor({
|
|
76
92
|
...options2,
|
|
77
|
-
next: (newOptions = options2) => next(newOptions)
|
|
93
|
+
next: (newOptions = options2) => next(newOptions, index + 1)
|
|
78
94
|
});
|
|
79
95
|
};
|
|
80
|
-
return
|
|
96
|
+
return next(options, 0);
|
|
81
97
|
}
|
|
82
98
|
|
|
83
99
|
function isAsyncIteratorObject(maybe) {
|
|
@@ -86,6 +102,62 @@ function isAsyncIteratorObject(maybe) {
|
|
|
86
102
|
}
|
|
87
103
|
return Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
|
|
88
104
|
}
|
|
105
|
+
function createAsyncIteratorObject(next, cleanup) {
|
|
106
|
+
let isExecuteComplete = false;
|
|
107
|
+
let isDone = false;
|
|
108
|
+
const iterator = {
|
|
109
|
+
next: sequential(async () => {
|
|
110
|
+
if (isDone) {
|
|
111
|
+
return { done: true, value: void 0 };
|
|
112
|
+
}
|
|
113
|
+
try {
|
|
114
|
+
const result = await next();
|
|
115
|
+
if (result.done) {
|
|
116
|
+
isDone = true;
|
|
117
|
+
}
|
|
118
|
+
return result;
|
|
119
|
+
} catch (err) {
|
|
120
|
+
isDone = true;
|
|
121
|
+
throw err;
|
|
122
|
+
} finally {
|
|
123
|
+
if (isDone && !isExecuteComplete) {
|
|
124
|
+
isExecuteComplete = true;
|
|
125
|
+
await cleanup("next");
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
}),
|
|
129
|
+
async return(value) {
|
|
130
|
+
isDone = true;
|
|
131
|
+
if (!isExecuteComplete) {
|
|
132
|
+
isExecuteComplete = true;
|
|
133
|
+
await cleanup("return");
|
|
134
|
+
}
|
|
135
|
+
return { done: true, value };
|
|
136
|
+
},
|
|
137
|
+
async throw(err) {
|
|
138
|
+
isDone = true;
|
|
139
|
+
if (!isExecuteComplete) {
|
|
140
|
+
isExecuteComplete = true;
|
|
141
|
+
await cleanup("throw");
|
|
142
|
+
}
|
|
143
|
+
throw err;
|
|
144
|
+
},
|
|
145
|
+
/**
|
|
146
|
+
* asyncDispose symbol only available in esnext, we should fallback to Symbol.for('asyncDispose')
|
|
147
|
+
*/
|
|
148
|
+
async [Symbol.asyncDispose ?? Symbol.for("asyncDispose")]() {
|
|
149
|
+
isDone = true;
|
|
150
|
+
if (!isExecuteComplete) {
|
|
151
|
+
isExecuteComplete = true;
|
|
152
|
+
await cleanup("dispose");
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
[Symbol.asyncIterator]() {
|
|
156
|
+
return iterator;
|
|
157
|
+
}
|
|
158
|
+
};
|
|
159
|
+
return iterator;
|
|
160
|
+
}
|
|
89
161
|
|
|
90
162
|
function parseEmptyableJSON(text) {
|
|
91
163
|
if (!text) {
|
|
@@ -135,6 +207,92 @@ function clone(value) {
|
|
|
135
207
|
}
|
|
136
208
|
return value;
|
|
137
209
|
}
|
|
210
|
+
function get(object, path) {
|
|
211
|
+
let current = object;
|
|
212
|
+
for (const key of path) {
|
|
213
|
+
if (!isTypescriptObject(current)) {
|
|
214
|
+
return void 0;
|
|
215
|
+
}
|
|
216
|
+
current = current[key];
|
|
217
|
+
}
|
|
218
|
+
return current;
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
class AsyncIdQueue {
|
|
222
|
+
openIds = /* @__PURE__ */ new Set();
|
|
223
|
+
items = /* @__PURE__ */ new Map();
|
|
224
|
+
pendingPulls = /* @__PURE__ */ new Map();
|
|
225
|
+
get length() {
|
|
226
|
+
return this.openIds.size;
|
|
227
|
+
}
|
|
228
|
+
open(id) {
|
|
229
|
+
this.openIds.add(id);
|
|
230
|
+
}
|
|
231
|
+
isOpen(id) {
|
|
232
|
+
return this.openIds.has(id);
|
|
233
|
+
}
|
|
234
|
+
push(id, item) {
|
|
235
|
+
this.assertOpen(id);
|
|
236
|
+
const pending = this.pendingPulls.get(id);
|
|
237
|
+
if (pending?.length) {
|
|
238
|
+
pending.shift()[0](item);
|
|
239
|
+
if (pending.length === 0) {
|
|
240
|
+
this.pendingPulls.delete(id);
|
|
241
|
+
}
|
|
242
|
+
} else {
|
|
243
|
+
const items = this.items.get(id);
|
|
244
|
+
if (items) {
|
|
245
|
+
items.push(item);
|
|
246
|
+
} else {
|
|
247
|
+
this.items.set(id, [item]);
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
async pull(id) {
|
|
252
|
+
this.assertOpen(id);
|
|
253
|
+
const items = this.items.get(id);
|
|
254
|
+
if (items?.length) {
|
|
255
|
+
const item = items.shift();
|
|
256
|
+
if (items.length === 0) {
|
|
257
|
+
this.items.delete(id);
|
|
258
|
+
}
|
|
259
|
+
return item;
|
|
260
|
+
}
|
|
261
|
+
return new Promise((resolve, reject) => {
|
|
262
|
+
const waitingPulls = this.pendingPulls.get(id);
|
|
263
|
+
const pending = [resolve, reject];
|
|
264
|
+
if (waitingPulls) {
|
|
265
|
+
waitingPulls.push(pending);
|
|
266
|
+
} else {
|
|
267
|
+
this.pendingPulls.set(id, [pending]);
|
|
268
|
+
}
|
|
269
|
+
});
|
|
270
|
+
}
|
|
271
|
+
close({ id, reason } = {}) {
|
|
272
|
+
if (id === void 0) {
|
|
273
|
+
this.pendingPulls.forEach((pendingPulls, id2) => {
|
|
274
|
+
pendingPulls.forEach(([, reject]) => {
|
|
275
|
+
reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id2}] was closed or aborted while waiting for pulling.`));
|
|
276
|
+
});
|
|
277
|
+
});
|
|
278
|
+
this.pendingPulls.clear();
|
|
279
|
+
this.openIds.clear();
|
|
280
|
+
this.items.clear();
|
|
281
|
+
return;
|
|
282
|
+
}
|
|
283
|
+
this.pendingPulls.get(id)?.forEach(([, reject]) => {
|
|
284
|
+
reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`));
|
|
285
|
+
});
|
|
286
|
+
this.pendingPulls.delete(id);
|
|
287
|
+
this.openIds.delete(id);
|
|
288
|
+
this.items.delete(id);
|
|
289
|
+
}
|
|
290
|
+
assertOpen(id) {
|
|
291
|
+
if (!this.isOpen(id)) {
|
|
292
|
+
throw new Error(`[AsyncIdQueue] Cannot access queue[${id}] because it is not open or aborted.`);
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
}
|
|
138
296
|
|
|
139
297
|
function value(value2, ...args) {
|
|
140
298
|
if (typeof value2 === "function") {
|
|
@@ -143,4 +301,4 @@ function value(value2, ...args) {
|
|
|
143
301
|
return value2;
|
|
144
302
|
}
|
|
145
303
|
|
|
146
|
-
export { clone, findDeepMatches, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray,
|
|
304
|
+
export { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/shared",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.eae6003",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
],
|
|
26
26
|
"dependencies": {
|
|
27
27
|
"radash": "^12.1.0",
|
|
28
|
-
"type-fest": "^4.
|
|
28
|
+
"type-fest": "^4.39.1"
|
|
29
29
|
},
|
|
30
30
|
"scripts": {
|
|
31
31
|
"build": "unbuild",
|