@orpc/shared 0.0.0-next.d8301f4 → 0.0.0-next.d929a5e
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 +4 -6
- package/dist/index.d.mts +77 -9
- package/dist/index.d.ts +77 -9
- package/dist/index.mjs +273 -131
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -54,14 +54,12 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
54
54
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
55
55
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
56
56
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
57
|
-
- [@orpc/
|
|
57
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
58
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
58
59
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
59
|
-
- [@orpc/
|
|
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).
|
|
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).
|
|
62
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
60
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
63
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
64
|
-
- [@orpc/
|
|
62
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
65
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
66
64
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
67
65
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
package/dist/index.d.mts
CHANGED
|
@@ -11,11 +11,74 @@ declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
|
|
|
11
11
|
type AnyFunction = (...args: any[]) => any;
|
|
12
12
|
declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
|
|
13
13
|
declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
|
|
14
|
+
/**
|
|
15
|
+
* Executes the callback function after the current call stack has been cleared.
|
|
16
|
+
*/
|
|
17
|
+
declare function defer(callback: () => void): void;
|
|
14
18
|
|
|
15
19
|
type OmitChainMethodDeep<T extends object, K extends keyof any> = {
|
|
16
20
|
[P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
|
|
17
21
|
};
|
|
18
22
|
|
|
23
|
+
interface EventPublisherOptions {
|
|
24
|
+
/**
|
|
25
|
+
* Maximum number of events to buffer for async iterator subscribers.
|
|
26
|
+
*
|
|
27
|
+
* If the buffer exceeds this limit, the oldest event is dropped.
|
|
28
|
+
* This prevents unbounded memory growth if consumers process events slowly.
|
|
29
|
+
*
|
|
30
|
+
* Set to:
|
|
31
|
+
* - `0`: Disable buffering. Events must be consumed before the next one arrives.
|
|
32
|
+
* - `1`: Only keep the latest event. Useful for real-time updates where only the most recent value matters.
|
|
33
|
+
* - `Infinity`: Keep all events. Ensures no data loss, but may lead to high memory usage.
|
|
34
|
+
*
|
|
35
|
+
* @default 100
|
|
36
|
+
*/
|
|
37
|
+
maxBufferedEvents?: number;
|
|
38
|
+
}
|
|
39
|
+
interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
|
|
40
|
+
/**
|
|
41
|
+
* Aborts the async iterator. Throws if aborted before or during pulling.
|
|
42
|
+
*/
|
|
43
|
+
signal?: AbortSignal;
|
|
44
|
+
}
|
|
45
|
+
declare class EventPublisher<T extends Record<PropertyKey, any>> {
|
|
46
|
+
#private;
|
|
47
|
+
constructor(options?: EventPublisherOptions);
|
|
48
|
+
get size(): number;
|
|
49
|
+
/**
|
|
50
|
+
* Emits an event and delivers the payload to all subscribed listeners.
|
|
51
|
+
*/
|
|
52
|
+
publish<K extends keyof T>(event: K, payload: T[K]): void;
|
|
53
|
+
/**
|
|
54
|
+
* Subscribes to a specific event using a callback function.
|
|
55
|
+
* Returns an unsubscribe function to remove the listener.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const unsubscribe = publisher.subscribe('event', (payload) => {
|
|
60
|
+
* console.log(payload)
|
|
61
|
+
* })
|
|
62
|
+
*
|
|
63
|
+
* // Later
|
|
64
|
+
* unsubscribe()
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
subscribe<K extends keyof T>(event: K, listener: (payload: T[K]) => void): () => void;
|
|
68
|
+
/**
|
|
69
|
+
* Subscribes to a specific event using an async iterator.
|
|
70
|
+
* Useful for `for await...of` loops with optional buffering and abort support.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* for await (const payload of publisher.subscribe('event', { signal })) {
|
|
75
|
+
* console.log(payload)
|
|
76
|
+
* }
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
subscribe<K extends keyof T>(event: K, options?: EventPublisherSubscribeIteratorOptions): AsyncGenerator<T[K]> & AsyncIteratorObject<T[K]>;
|
|
80
|
+
}
|
|
81
|
+
|
|
19
82
|
declare class SequentialIdGenerator {
|
|
20
83
|
private nextId;
|
|
21
84
|
generate(): number;
|
|
@@ -40,10 +103,10 @@ type ThrowableError = Registry extends {
|
|
|
40
103
|
} ? T : Error;
|
|
41
104
|
|
|
42
105
|
type InterceptableOptions = Record<string, any>;
|
|
43
|
-
type InterceptorOptions<TOptions extends InterceptableOptions, TResult
|
|
44
|
-
next(options?: TOptions):
|
|
106
|
+
type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
|
|
107
|
+
next(options?: TOptions): TResult;
|
|
45
108
|
};
|
|
46
|
-
type Interceptor<TOptions extends InterceptableOptions, TResult
|
|
109
|
+
type Interceptor<TOptions extends InterceptableOptions, TResult> = (options: InterceptorOptions<TOptions, TResult>) => TResult;
|
|
47
110
|
/**
|
|
48
111
|
* Can used for interceptors or middlewares
|
|
49
112
|
*/
|
|
@@ -69,13 +132,14 @@ type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess
|
|
|
69
132
|
declare function onFinish<T, TOptions extends {
|
|
70
133
|
next(): any;
|
|
71
134
|
}, 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']>>>;
|
|
72
|
-
declare function intercept<TOptions extends InterceptableOptions, TResult
|
|
135
|
+
declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
|
|
73
136
|
|
|
74
137
|
declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
|
|
75
138
|
interface CreateAsyncIteratorObjectCleanupFn {
|
|
76
139
|
(reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
|
|
77
140
|
}
|
|
78
141
|
declare function createAsyncIteratorObject<T, TReturn, TNext>(next: () => Promise<IteratorResult<T, TReturn>>, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>;
|
|
142
|
+
declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>)[];
|
|
79
143
|
|
|
80
144
|
declare function parseEmptyableJSON(text: string | null | undefined): unknown;
|
|
81
145
|
declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
|
|
@@ -95,10 +159,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
95
159
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
96
160
|
declare function clone<T>(value: T): T;
|
|
97
161
|
declare function get(object: object, path: readonly string[]): unknown;
|
|
162
|
+
declare function isPropertyKey(value: unknown): value is PropertyKey;
|
|
163
|
+
declare const NullProtoObj: ({
|
|
164
|
+
new <T extends Record<PropertyKey, unknown>>(): T;
|
|
165
|
+
});
|
|
98
166
|
|
|
99
167
|
interface AsyncIdQueueCloseOptions {
|
|
100
168
|
id?: number;
|
|
101
|
-
reason?:
|
|
169
|
+
reason?: unknown;
|
|
102
170
|
}
|
|
103
171
|
declare class AsyncIdQueue<T> {
|
|
104
172
|
private readonly openIds;
|
|
@@ -113,8 +181,8 @@ declare class AsyncIdQueue<T> {
|
|
|
113
181
|
assertOpen(id: number): void;
|
|
114
182
|
}
|
|
115
183
|
|
|
116
|
-
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) =>
|
|
117
|
-
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>):
|
|
184
|
+
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
|
|
185
|
+
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
|
|
118
186
|
|
|
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 };
|
|
187
|
+
export { AsyncIdQueue, EventPublisher, 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 };
|
|
188
|
+
export type { AnyFunction, AsyncIdQueueCloseOptions, CreateAsyncIteratorObjectCleanupFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
package/dist/index.d.ts
CHANGED
|
@@ -11,11 +11,74 @@ declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
|
|
|
11
11
|
type AnyFunction = (...args: any[]) => any;
|
|
12
12
|
declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
|
|
13
13
|
declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
|
|
14
|
+
/**
|
|
15
|
+
* Executes the callback function after the current call stack has been cleared.
|
|
16
|
+
*/
|
|
17
|
+
declare function defer(callback: () => void): void;
|
|
14
18
|
|
|
15
19
|
type OmitChainMethodDeep<T extends object, K extends keyof any> = {
|
|
16
20
|
[P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
|
|
17
21
|
};
|
|
18
22
|
|
|
23
|
+
interface EventPublisherOptions {
|
|
24
|
+
/**
|
|
25
|
+
* Maximum number of events to buffer for async iterator subscribers.
|
|
26
|
+
*
|
|
27
|
+
* If the buffer exceeds this limit, the oldest event is dropped.
|
|
28
|
+
* This prevents unbounded memory growth if consumers process events slowly.
|
|
29
|
+
*
|
|
30
|
+
* Set to:
|
|
31
|
+
* - `0`: Disable buffering. Events must be consumed before the next one arrives.
|
|
32
|
+
* - `1`: Only keep the latest event. Useful for real-time updates where only the most recent value matters.
|
|
33
|
+
* - `Infinity`: Keep all events. Ensures no data loss, but may lead to high memory usage.
|
|
34
|
+
*
|
|
35
|
+
* @default 100
|
|
36
|
+
*/
|
|
37
|
+
maxBufferedEvents?: number;
|
|
38
|
+
}
|
|
39
|
+
interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
|
|
40
|
+
/**
|
|
41
|
+
* Aborts the async iterator. Throws if aborted before or during pulling.
|
|
42
|
+
*/
|
|
43
|
+
signal?: AbortSignal;
|
|
44
|
+
}
|
|
45
|
+
declare class EventPublisher<T extends Record<PropertyKey, any>> {
|
|
46
|
+
#private;
|
|
47
|
+
constructor(options?: EventPublisherOptions);
|
|
48
|
+
get size(): number;
|
|
49
|
+
/**
|
|
50
|
+
* Emits an event and delivers the payload to all subscribed listeners.
|
|
51
|
+
*/
|
|
52
|
+
publish<K extends keyof T>(event: K, payload: T[K]): void;
|
|
53
|
+
/**
|
|
54
|
+
* Subscribes to a specific event using a callback function.
|
|
55
|
+
* Returns an unsubscribe function to remove the listener.
|
|
56
|
+
*
|
|
57
|
+
* @example
|
|
58
|
+
* ```ts
|
|
59
|
+
* const unsubscribe = publisher.subscribe('event', (payload) => {
|
|
60
|
+
* console.log(payload)
|
|
61
|
+
* })
|
|
62
|
+
*
|
|
63
|
+
* // Later
|
|
64
|
+
* unsubscribe()
|
|
65
|
+
* ```
|
|
66
|
+
*/
|
|
67
|
+
subscribe<K extends keyof T>(event: K, listener: (payload: T[K]) => void): () => void;
|
|
68
|
+
/**
|
|
69
|
+
* Subscribes to a specific event using an async iterator.
|
|
70
|
+
* Useful for `for await...of` loops with optional buffering and abort support.
|
|
71
|
+
*
|
|
72
|
+
* @example
|
|
73
|
+
* ```ts
|
|
74
|
+
* for await (const payload of publisher.subscribe('event', { signal })) {
|
|
75
|
+
* console.log(payload)
|
|
76
|
+
* }
|
|
77
|
+
* ```
|
|
78
|
+
*/
|
|
79
|
+
subscribe<K extends keyof T>(event: K, options?: EventPublisherSubscribeIteratorOptions): AsyncGenerator<T[K]> & AsyncIteratorObject<T[K]>;
|
|
80
|
+
}
|
|
81
|
+
|
|
19
82
|
declare class SequentialIdGenerator {
|
|
20
83
|
private nextId;
|
|
21
84
|
generate(): number;
|
|
@@ -40,10 +103,10 @@ type ThrowableError = Registry extends {
|
|
|
40
103
|
} ? T : Error;
|
|
41
104
|
|
|
42
105
|
type InterceptableOptions = Record<string, any>;
|
|
43
|
-
type InterceptorOptions<TOptions extends InterceptableOptions, TResult
|
|
44
|
-
next(options?: TOptions):
|
|
106
|
+
type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
|
|
107
|
+
next(options?: TOptions): TResult;
|
|
45
108
|
};
|
|
46
|
-
type Interceptor<TOptions extends InterceptableOptions, TResult
|
|
109
|
+
type Interceptor<TOptions extends InterceptableOptions, TResult> = (options: InterceptorOptions<TOptions, TResult>) => TResult;
|
|
47
110
|
/**
|
|
48
111
|
* Can used for interceptors or middlewares
|
|
49
112
|
*/
|
|
@@ -69,13 +132,14 @@ type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess
|
|
|
69
132
|
declare function onFinish<T, TOptions extends {
|
|
70
133
|
next(): any;
|
|
71
134
|
}, 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']>>>;
|
|
72
|
-
declare function intercept<TOptions extends InterceptableOptions, TResult
|
|
135
|
+
declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
|
|
73
136
|
|
|
74
137
|
declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
|
|
75
138
|
interface CreateAsyncIteratorObjectCleanupFn {
|
|
76
139
|
(reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
|
|
77
140
|
}
|
|
78
141
|
declare function createAsyncIteratorObject<T, TReturn, TNext>(next: () => Promise<IteratorResult<T, TReturn>>, cleanup: CreateAsyncIteratorObjectCleanupFn): AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>;
|
|
142
|
+
declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorObject<T, TReturn, TNext> & AsyncGenerator<T, TReturn, TNext>)[];
|
|
79
143
|
|
|
80
144
|
declare function parseEmptyableJSON(text: string | null | undefined): unknown;
|
|
81
145
|
declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
|
|
@@ -95,10 +159,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
95
159
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
96
160
|
declare function clone<T>(value: T): T;
|
|
97
161
|
declare function get(object: object, path: readonly string[]): unknown;
|
|
162
|
+
declare function isPropertyKey(value: unknown): value is PropertyKey;
|
|
163
|
+
declare const NullProtoObj: ({
|
|
164
|
+
new <T extends Record<PropertyKey, unknown>>(): T;
|
|
165
|
+
});
|
|
98
166
|
|
|
99
167
|
interface AsyncIdQueueCloseOptions {
|
|
100
168
|
id?: number;
|
|
101
|
-
reason?:
|
|
169
|
+
reason?: unknown;
|
|
102
170
|
}
|
|
103
171
|
declare class AsyncIdQueue<T> {
|
|
104
172
|
private readonly openIds;
|
|
@@ -113,8 +181,8 @@ declare class AsyncIdQueue<T> {
|
|
|
113
181
|
assertOpen(id: number): void;
|
|
114
182
|
}
|
|
115
183
|
|
|
116
|
-
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) =>
|
|
117
|
-
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>):
|
|
184
|
+
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
|
|
185
|
+
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
|
|
118
186
|
|
|
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 };
|
|
187
|
+
export { AsyncIdQueue, EventPublisher, 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 };
|
|
188
|
+
export type { AnyFunction, AsyncIdQueueCloseOptions, CreateAsyncIteratorObjectCleanupFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
package/dist/index.mjs
CHANGED
|
@@ -32,68 +32,88 @@ function sequential(fn) {
|
|
|
32
32
|
});
|
|
33
33
|
};
|
|
34
34
|
}
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
this.nextId = 0;
|
|
41
|
-
return Number.MAX_SAFE_INTEGER;
|
|
42
|
-
}
|
|
43
|
-
return this.nextId++;
|
|
35
|
+
function defer(callback) {
|
|
36
|
+
if (typeof setTimeout === "function") {
|
|
37
|
+
setTimeout(callback, 0);
|
|
38
|
+
} else {
|
|
39
|
+
Promise.resolve().then(() => Promise.resolve().then(() => Promise.resolve().then(callback)));
|
|
44
40
|
}
|
|
45
41
|
}
|
|
46
42
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
43
|
+
class AsyncIdQueue {
|
|
44
|
+
openIds = /* @__PURE__ */ new Set();
|
|
45
|
+
items = /* @__PURE__ */ new Map();
|
|
46
|
+
pendingPulls = /* @__PURE__ */ new Map();
|
|
47
|
+
get length() {
|
|
48
|
+
return this.openIds.size;
|
|
49
|
+
}
|
|
50
|
+
open(id) {
|
|
51
|
+
this.openIds.add(id);
|
|
52
|
+
}
|
|
53
|
+
isOpen(id) {
|
|
54
|
+
return this.openIds.has(id);
|
|
55
|
+
}
|
|
56
|
+
push(id, item) {
|
|
57
|
+
this.assertOpen(id);
|
|
58
|
+
const pending = this.pendingPulls.get(id);
|
|
59
|
+
if (pending?.length) {
|
|
60
|
+
pending.shift()[0](item);
|
|
61
|
+
if (pending.length === 0) {
|
|
62
|
+
this.pendingPulls.delete(id);
|
|
63
|
+
}
|
|
64
|
+
} else {
|
|
65
|
+
const items = this.items.get(id);
|
|
66
|
+
if (items) {
|
|
67
|
+
items.push(item);
|
|
68
|
+
} else {
|
|
69
|
+
this.items.set(id, [item]);
|
|
70
|
+
}
|
|
67
71
|
}
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
state = [error, void 0, false];
|
|
79
|
-
throw error;
|
|
80
|
-
} finally {
|
|
81
|
-
await callback(state, options, ...rest);
|
|
72
|
+
}
|
|
73
|
+
async pull(id) {
|
|
74
|
+
this.assertOpen(id);
|
|
75
|
+
const items = this.items.get(id);
|
|
76
|
+
if (items?.length) {
|
|
77
|
+
const item = items.shift();
|
|
78
|
+
if (items.length === 0) {
|
|
79
|
+
this.items.delete(id);
|
|
80
|
+
}
|
|
81
|
+
return item;
|
|
82
82
|
}
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
83
|
+
return new Promise((resolve, reject) => {
|
|
84
|
+
const waitingPulls = this.pendingPulls.get(id);
|
|
85
|
+
const pending = [resolve, reject];
|
|
86
|
+
if (waitingPulls) {
|
|
87
|
+
waitingPulls.push(pending);
|
|
88
|
+
} else {
|
|
89
|
+
this.pendingPulls.set(id, [pending]);
|
|
90
|
+
}
|
|
91
|
+
});
|
|
92
|
+
}
|
|
93
|
+
close({ id, reason } = {}) {
|
|
94
|
+
if (id === void 0) {
|
|
95
|
+
this.pendingPulls.forEach((pendingPulls, id2) => {
|
|
96
|
+
pendingPulls.forEach(([, reject]) => {
|
|
97
|
+
reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id2}] was closed or aborted while waiting for pulling.`));
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
this.pendingPulls.clear();
|
|
101
|
+
this.openIds.clear();
|
|
102
|
+
this.items.clear();
|
|
103
|
+
return;
|
|
90
104
|
}
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
next: (newOptions = options2) => next(newOptions, index + 1)
|
|
105
|
+
this.pendingPulls.get(id)?.forEach(([, reject]) => {
|
|
106
|
+
reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`));
|
|
94
107
|
});
|
|
95
|
-
|
|
96
|
-
|
|
108
|
+
this.pendingPulls.delete(id);
|
|
109
|
+
this.openIds.delete(id);
|
|
110
|
+
this.items.delete(id);
|
|
111
|
+
}
|
|
112
|
+
assertOpen(id) {
|
|
113
|
+
if (!this.isOpen(id)) {
|
|
114
|
+
throw new Error(`[AsyncIdQueue] Cannot access queue[${id}] because it is not open or aborted.`);
|
|
115
|
+
}
|
|
116
|
+
}
|
|
97
117
|
}
|
|
98
118
|
|
|
99
119
|
function isAsyncIteratorObject(maybe) {
|
|
@@ -158,6 +178,193 @@ function createAsyncIteratorObject(next, cleanup) {
|
|
|
158
178
|
};
|
|
159
179
|
return iterator;
|
|
160
180
|
}
|
|
181
|
+
function replicateAsyncIterator(source, count) {
|
|
182
|
+
const queue = new AsyncIdQueue();
|
|
183
|
+
const replicated = [];
|
|
184
|
+
let error;
|
|
185
|
+
const start = once(async () => {
|
|
186
|
+
try {
|
|
187
|
+
while (true) {
|
|
188
|
+
const item = await source.next();
|
|
189
|
+
for (let id = 0; id < count; id++) {
|
|
190
|
+
if (queue.isOpen(id)) {
|
|
191
|
+
queue.push(id, item);
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
if (item.done) {
|
|
195
|
+
break;
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
} catch (e) {
|
|
199
|
+
error = { value: e };
|
|
200
|
+
}
|
|
201
|
+
});
|
|
202
|
+
for (let id = 0; id < count; id++) {
|
|
203
|
+
queue.open(id);
|
|
204
|
+
replicated.push(createAsyncIteratorObject(
|
|
205
|
+
() => {
|
|
206
|
+
start();
|
|
207
|
+
return new Promise((resolve, reject) => {
|
|
208
|
+
queue.pull(id).then(resolve).catch(reject);
|
|
209
|
+
defer(() => {
|
|
210
|
+
if (error) {
|
|
211
|
+
reject(error.value);
|
|
212
|
+
}
|
|
213
|
+
});
|
|
214
|
+
});
|
|
215
|
+
},
|
|
216
|
+
async (reason) => {
|
|
217
|
+
queue.close({ id });
|
|
218
|
+
if (reason !== "next") {
|
|
219
|
+
if (replicated.every((_, id2) => !queue.isOpen(id2))) {
|
|
220
|
+
await source?.return?.();
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
));
|
|
225
|
+
}
|
|
226
|
+
return replicated;
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
class EventPublisher {
|
|
230
|
+
#listenersMap = /* @__PURE__ */ new Map();
|
|
231
|
+
#maxBufferedEvents;
|
|
232
|
+
constructor(options = {}) {
|
|
233
|
+
this.#maxBufferedEvents = options.maxBufferedEvents ?? 100;
|
|
234
|
+
}
|
|
235
|
+
get size() {
|
|
236
|
+
return this.#listenersMap.size;
|
|
237
|
+
}
|
|
238
|
+
/**
|
|
239
|
+
* Emits an event and delivers the payload to all subscribed listeners.
|
|
240
|
+
*/
|
|
241
|
+
publish(event, payload) {
|
|
242
|
+
const listeners = this.#listenersMap.get(event);
|
|
243
|
+
if (!listeners) {
|
|
244
|
+
return;
|
|
245
|
+
}
|
|
246
|
+
for (const listener of listeners) {
|
|
247
|
+
listener(payload);
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
subscribe(event, listenerOrOptions) {
|
|
251
|
+
if (typeof listenerOrOptions === "function") {
|
|
252
|
+
let listeners = this.#listenersMap.get(event);
|
|
253
|
+
if (!listeners) {
|
|
254
|
+
this.#listenersMap.set(event, listeners = /* @__PURE__ */ new Set());
|
|
255
|
+
}
|
|
256
|
+
listeners.add(listenerOrOptions);
|
|
257
|
+
return () => {
|
|
258
|
+
listeners.delete(listenerOrOptions);
|
|
259
|
+
if (listeners.size === 0) {
|
|
260
|
+
this.#listenersMap.delete(event);
|
|
261
|
+
}
|
|
262
|
+
};
|
|
263
|
+
}
|
|
264
|
+
const signal = listenerOrOptions?.signal;
|
|
265
|
+
const maxBufferedEvents = listenerOrOptions?.maxBufferedEvents ?? this.#maxBufferedEvents;
|
|
266
|
+
const bufferedEvents = [];
|
|
267
|
+
const pullResolvers = [];
|
|
268
|
+
const unsubscribe = this.subscribe(event, (payload) => {
|
|
269
|
+
const resolver = pullResolvers.shift();
|
|
270
|
+
if (resolver) {
|
|
271
|
+
resolver[0]({ done: false, value: payload });
|
|
272
|
+
} else {
|
|
273
|
+
bufferedEvents.push(payload);
|
|
274
|
+
if (bufferedEvents.length > maxBufferedEvents) {
|
|
275
|
+
bufferedEvents.shift();
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
});
|
|
279
|
+
const abortListener = (event2) => {
|
|
280
|
+
unsubscribe();
|
|
281
|
+
pullResolvers.forEach((resolver) => resolver[1](event2.target.reason));
|
|
282
|
+
pullResolvers.length = 0;
|
|
283
|
+
bufferedEvents.length = 0;
|
|
284
|
+
};
|
|
285
|
+
signal?.addEventListener("abort", abortListener, { once: true });
|
|
286
|
+
return createAsyncIteratorObject(async () => {
|
|
287
|
+
if (signal?.aborted) {
|
|
288
|
+
throw signal.reason;
|
|
289
|
+
}
|
|
290
|
+
if (bufferedEvents.length > 0) {
|
|
291
|
+
return { done: false, value: bufferedEvents.shift() };
|
|
292
|
+
}
|
|
293
|
+
return new Promise((resolve, reject) => {
|
|
294
|
+
pullResolvers.push([resolve, reject]);
|
|
295
|
+
});
|
|
296
|
+
}, async () => {
|
|
297
|
+
unsubscribe();
|
|
298
|
+
signal?.removeEventListener("abort", abortListener);
|
|
299
|
+
pullResolvers.forEach((resolver) => resolver[0]({ done: true, value: void 0 }));
|
|
300
|
+
pullResolvers.length = 0;
|
|
301
|
+
bufferedEvents.length = 0;
|
|
302
|
+
});
|
|
303
|
+
}
|
|
304
|
+
}
|
|
305
|
+
|
|
306
|
+
class SequentialIdGenerator {
|
|
307
|
+
nextId = 0;
|
|
308
|
+
generate() {
|
|
309
|
+
if (this.nextId === Number.MAX_SAFE_INTEGER) {
|
|
310
|
+
this.nextId = 0;
|
|
311
|
+
return Number.MAX_SAFE_INTEGER;
|
|
312
|
+
}
|
|
313
|
+
return this.nextId++;
|
|
314
|
+
}
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
function onStart(callback) {
|
|
318
|
+
return async (options, ...rest) => {
|
|
319
|
+
await callback(options, ...rest);
|
|
320
|
+
return await options.next();
|
|
321
|
+
};
|
|
322
|
+
}
|
|
323
|
+
function onSuccess(callback) {
|
|
324
|
+
return async (options, ...rest) => {
|
|
325
|
+
const result = await options.next();
|
|
326
|
+
await callback(result, options, ...rest);
|
|
327
|
+
return result;
|
|
328
|
+
};
|
|
329
|
+
}
|
|
330
|
+
function onError(callback) {
|
|
331
|
+
return async (options, ...rest) => {
|
|
332
|
+
try {
|
|
333
|
+
return await options.next();
|
|
334
|
+
} catch (error) {
|
|
335
|
+
await callback(error, options, ...rest);
|
|
336
|
+
throw error;
|
|
337
|
+
}
|
|
338
|
+
};
|
|
339
|
+
}
|
|
340
|
+
function onFinish(callback) {
|
|
341
|
+
let state;
|
|
342
|
+
return async (options, ...rest) => {
|
|
343
|
+
try {
|
|
344
|
+
const result = await options.next();
|
|
345
|
+
state = [null, result, true];
|
|
346
|
+
return result;
|
|
347
|
+
} catch (error) {
|
|
348
|
+
state = [error, void 0, false];
|
|
349
|
+
throw error;
|
|
350
|
+
} finally {
|
|
351
|
+
await callback(state, options, ...rest);
|
|
352
|
+
}
|
|
353
|
+
};
|
|
354
|
+
}
|
|
355
|
+
function intercept(interceptors, options, main) {
|
|
356
|
+
const next = (options2, index) => {
|
|
357
|
+
const interceptor = interceptors[index];
|
|
358
|
+
if (!interceptor) {
|
|
359
|
+
return main(options2);
|
|
360
|
+
}
|
|
361
|
+
return interceptor({
|
|
362
|
+
...options2,
|
|
363
|
+
next: (newOptions = options2) => next(newOptions, index + 1)
|
|
364
|
+
});
|
|
365
|
+
};
|
|
366
|
+
return next(options, 0);
|
|
367
|
+
}
|
|
161
368
|
|
|
162
369
|
function parseEmptyableJSON(text) {
|
|
163
370
|
if (!text) {
|
|
@@ -217,82 +424,17 @@ function get(object, path) {
|
|
|
217
424
|
}
|
|
218
425
|
return current;
|
|
219
426
|
}
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
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
|
-
}
|
|
427
|
+
function isPropertyKey(value) {
|
|
428
|
+
const type = typeof value;
|
|
429
|
+
return type === "string" || type === "number" || type === "symbol";
|
|
295
430
|
}
|
|
431
|
+
const NullProtoObj = /* @__PURE__ */ (() => {
|
|
432
|
+
const e = function() {
|
|
433
|
+
};
|
|
434
|
+
e.prototype = /* @__PURE__ */ Object.create(null);
|
|
435
|
+
Object.freeze(e.prototype);
|
|
436
|
+
return e;
|
|
437
|
+
})();
|
|
296
438
|
|
|
297
439
|
function value(value2, ...args) {
|
|
298
440
|
if (typeof value2 === "function") {
|
|
@@ -301,4 +443,4 @@ function value(value2, ...args) {
|
|
|
301
443
|
return value2;
|
|
302
444
|
}
|
|
303
445
|
|
|
304
|
-
export { AsyncIdQueue, SequentialIdGenerator, clone, createAsyncIteratorObject, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
|
446
|
+
export { AsyncIdQueue, EventPublisher, 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
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.d929a5e",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -27,6 +27,11 @@
|
|
|
27
27
|
"radash": "^12.1.0",
|
|
28
28
|
"type-fest": "^4.39.1"
|
|
29
29
|
},
|
|
30
|
+
"devDependencies": {
|
|
31
|
+
"arktype": "2.1.20",
|
|
32
|
+
"valibot": "^1.1.0",
|
|
33
|
+
"zod": "^3.25.49"
|
|
34
|
+
},
|
|
30
35
|
"scripts": {
|
|
31
36
|
"build": "unbuild",
|
|
32
37
|
"build:watch": "pnpm run build --watch",
|