@orpc/shared 0.0.0-next.f356b86 → 0.0.0-next.f397ca2
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 +7 -7
- package/dist/index.d.mts +148 -9
- package/dist/index.d.ts +148 -9
- package/dist/index.mjs +307 -58
- package/package.json +13 -4
package/README.md
CHANGED
|
@@ -1,8 +1,3 @@
|
|
|
1
|
-
> [!WARNING]
|
|
2
|
-
>
|
|
3
|
-
> `@orpc/shared` is an internal dependency of oRPC packages. It does not follow semver and may change at any time without notice.
|
|
4
|
-
> Please do not use it in your project.
|
|
5
|
-
|
|
6
1
|
<div align="center">
|
|
7
2
|
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
|
|
8
3
|
</div>
|
|
@@ -22,6 +17,9 @@
|
|
|
22
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
23
18
|
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
24
19
|
</a>
|
|
20
|
+
<a href="https://deepwiki.com/unnoq/orpc">
|
|
21
|
+
<img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
|
|
22
|
+
</a>
|
|
25
23
|
</div>
|
|
26
24
|
|
|
27
25
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
@@ -35,7 +33,8 @@
|
|
|
35
33
|
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
36
34
|
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
37
35
|
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
|
38
|
-
-
|
|
36
|
+
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
37
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
|
|
39
38
|
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
40
39
|
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
41
40
|
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
@@ -43,7 +42,6 @@
|
|
|
43
42
|
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
44
43
|
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
45
44
|
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
46
|
-
- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
|
47
45
|
|
|
48
46
|
## Documentation
|
|
49
47
|
|
|
@@ -55,9 +53,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
55
53
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
56
54
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
57
55
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
56
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
|
58
57
|
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
59
58
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
60
59
|
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
60
|
+
- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
|
|
61
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
62
|
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Promisable } from 'type-fest';
|
|
2
2
|
export { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
|
|
3
|
-
|
|
3
|
+
import { Tracer, TraceAPI, ContextAPI, PropagationAPI, SpanOptions, Context, Span, AttributeValue, Exception } from '@opentelemetry/api';
|
|
4
|
+
export { group, guard, mapEntries, mapValues, omit, retry, sleep } from 'radash';
|
|
4
5
|
|
|
5
6
|
type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
|
|
6
7
|
declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>): T;
|
|
@@ -27,6 +28,18 @@ type OmitChainMethodDeep<T extends object, K extends keyof any> = {
|
|
|
27
28
|
[P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
|
|
28
29
|
};
|
|
29
30
|
|
|
31
|
+
declare const ORPC_NAME = "orpc";
|
|
32
|
+
declare const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
|
|
33
|
+
declare const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.f397ca2";
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Error thrown when an operation is aborted.
|
|
37
|
+
* Uses the standardized 'AbortError' name for consistency with JavaScript APIs.
|
|
38
|
+
*/
|
|
39
|
+
declare class AbortError extends Error {
|
|
40
|
+
constructor(...rest: ConstructorParameters<typeof Error>);
|
|
41
|
+
}
|
|
42
|
+
|
|
30
43
|
interface EventPublisherOptions {
|
|
31
44
|
/**
|
|
32
45
|
* Maximum number of events to buffer for async iterator subscribers.
|
|
@@ -47,7 +60,7 @@ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
|
|
|
47
60
|
/**
|
|
48
61
|
* Aborts the async iterator. Throws if aborted before or during pulling.
|
|
49
62
|
*/
|
|
50
|
-
signal?: AbortSignal;
|
|
63
|
+
signal?: AbortSignal | undefined;
|
|
51
64
|
}
|
|
52
65
|
declare class EventPublisher<T extends Record<PropertyKey, any>> {
|
|
53
66
|
#private;
|
|
@@ -90,6 +103,14 @@ declare class SequentialIdGenerator {
|
|
|
90
103
|
private index;
|
|
91
104
|
generate(): string;
|
|
92
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Compares two sequential IDs.
|
|
108
|
+
* Returns:
|
|
109
|
+
* - negative if `a` < `b`
|
|
110
|
+
* - positive if `a` > `b`
|
|
111
|
+
* - 0 if equal
|
|
112
|
+
*/
|
|
113
|
+
declare function compareSequentialIds(a: string, b: string): number;
|
|
93
114
|
|
|
94
115
|
type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
95
116
|
type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
|
|
@@ -108,6 +129,7 @@ interface Registry {
|
|
|
108
129
|
type ThrowableError = Registry extends {
|
|
109
130
|
throwableError: infer T;
|
|
110
131
|
} ? T : Error;
|
|
132
|
+
type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
|
|
111
133
|
|
|
112
134
|
type InterceptableOptions = Record<string, any>;
|
|
113
135
|
type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
|
|
@@ -141,6 +163,72 @@ declare function onFinish<T, TOptions extends {
|
|
|
141
163
|
}, 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']>>>;
|
|
142
164
|
declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
|
|
143
165
|
|
|
166
|
+
/**
|
|
167
|
+
* Only import types from @opentelemetry/api to avoid runtime dependencies.
|
|
168
|
+
*/
|
|
169
|
+
|
|
170
|
+
interface OtelConfig {
|
|
171
|
+
tracer: Tracer;
|
|
172
|
+
trace: TraceAPI;
|
|
173
|
+
context: ContextAPI;
|
|
174
|
+
propagation: PropagationAPI;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Sets the global OpenTelemetry config.
|
|
178
|
+
* Call this once at app startup. Use `undefined` to disable tracing.
|
|
179
|
+
*/
|
|
180
|
+
declare function setGlobalOtelConfig(config: OtelConfig | undefined): void;
|
|
181
|
+
/**
|
|
182
|
+
* Gets the global OpenTelemetry config.
|
|
183
|
+
* Returns `undefined` if OpenTelemetry is not configured, initialized, or enabled.
|
|
184
|
+
*/
|
|
185
|
+
declare function getGlobalOtelConfig(): OtelConfig | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* Starts a new OpenTelemetry span with the given name and options.
|
|
188
|
+
*
|
|
189
|
+
* @returns The new span, or `undefined` if no tracer is set.
|
|
190
|
+
*/
|
|
191
|
+
declare function startSpan(name: string, options?: SpanOptions, context?: Context): Span | undefined;
|
|
192
|
+
interface SetSpanErrorOptions {
|
|
193
|
+
/**
|
|
194
|
+
* Span error status is not set if error is due to cancellation by the signal.
|
|
195
|
+
*/
|
|
196
|
+
signal?: AbortSignal;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Records and sets the error status on the given span.
|
|
200
|
+
* If the span is `undefined`, it does nothing.
|
|
201
|
+
*/
|
|
202
|
+
declare function setSpanError(span: Span | undefined, error: unknown, options?: SetSpanErrorOptions): void;
|
|
203
|
+
declare function setSpanAttribute(span: Span | undefined, key: string, value: AttributeValue | undefined): void;
|
|
204
|
+
/**
|
|
205
|
+
* Converts an error to an OpenTelemetry Exception.
|
|
206
|
+
*/
|
|
207
|
+
declare function toOtelException(error: unknown): Exclude<Exception, string>;
|
|
208
|
+
/**
|
|
209
|
+
* Converts a value to a string suitable for OpenTelemetry span attributes.
|
|
210
|
+
*/
|
|
211
|
+
declare function toSpanAttributeValue(data: unknown): string;
|
|
212
|
+
interface RunWithSpanOptions extends SpanOptions, SetSpanErrorOptions {
|
|
213
|
+
/**
|
|
214
|
+
* The name of the span to create.
|
|
215
|
+
*/
|
|
216
|
+
name: string;
|
|
217
|
+
/**
|
|
218
|
+
* Context to use for the span.
|
|
219
|
+
*/
|
|
220
|
+
context?: Context;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Runs a function within the context of a new OpenTelemetry span.
|
|
224
|
+
* The span is ended automatically, and errors are recorded to the span.
|
|
225
|
+
*/
|
|
226
|
+
declare function runWithSpan<T>({ name, context, ...options }: RunWithSpanOptions, fn: (span?: Span) => Promisable<T>): Promise<T>;
|
|
227
|
+
/**
|
|
228
|
+
* Runs a function within the context of an existing OpenTelemetry span.
|
|
229
|
+
*/
|
|
230
|
+
declare function runInSpanContext<T>(span: Span | undefined, fn: () => Promisable<T>): Promise<T>;
|
|
231
|
+
|
|
144
232
|
declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
|
|
145
233
|
interface AsyncIteratorClassNextFn<T, TReturn> {
|
|
146
234
|
(): Promise<IteratorResult<T, TReturn>>;
|
|
@@ -165,6 +253,13 @@ declare class AsyncIteratorClass<T, TReturn = unknown, TNext = unknown> implemen
|
|
|
165
253
|
[Symbol.asyncIterator](): this;
|
|
166
254
|
}
|
|
167
255
|
declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorClass<T, TReturn, TNext>)[];
|
|
256
|
+
interface AsyncIteratorWithSpanOptions extends SetSpanErrorOptions {
|
|
257
|
+
/**
|
|
258
|
+
* The name of the span to create.
|
|
259
|
+
*/
|
|
260
|
+
name: string;
|
|
261
|
+
}
|
|
262
|
+
declare function asyncIteratorWithSpan<T, TReturn, TNext>({ name, ...options }: AsyncIteratorWithSpanOptions, iterator: AsyncIterator<T, TReturn, TNext>): AsyncIteratorClass<T, TReturn, TNext>;
|
|
168
263
|
|
|
169
264
|
declare function parseEmptyableJSON(text: string | null | undefined): unknown;
|
|
170
265
|
declare function stringifyJSON<T>(value: T | {
|
|
@@ -176,6 +271,11 @@ declare function findDeepMatches(check: (value: unknown) => boolean, payload: un
|
|
|
176
271
|
maps: Segment[][];
|
|
177
272
|
values: unknown[];
|
|
178
273
|
};
|
|
274
|
+
/**
|
|
275
|
+
* Get constructor of the value
|
|
276
|
+
*
|
|
277
|
+
*/
|
|
278
|
+
declare function getConstructor(value: unknown): Function | null | undefined;
|
|
179
279
|
/**
|
|
180
280
|
* Check if the value is an object even it created by `Object.create(null)` or more tricky way.
|
|
181
281
|
*/
|
|
@@ -185,21 +285,47 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
185
285
|
*/
|
|
186
286
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
187
287
|
declare function clone<T>(value: T): T;
|
|
188
|
-
declare function get(object:
|
|
288
|
+
declare function get(object: unknown, path: readonly PropertyKey[]): unknown;
|
|
189
289
|
declare function isPropertyKey(value: unknown): value is PropertyKey;
|
|
190
290
|
declare const NullProtoObj: ({
|
|
191
291
|
new <T extends Record<PropertyKey, unknown>>(): T;
|
|
192
292
|
});
|
|
193
293
|
|
|
294
|
+
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
|
|
295
|
+
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
|
|
296
|
+
/**
|
|
297
|
+
* Returns the value if it is defined, otherwise returns the fallback
|
|
298
|
+
*/
|
|
299
|
+
declare function fallback<T>(value: T | undefined, fallback: T): T;
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Prevents objects from being awaitable by intercepting the `then` method
|
|
303
|
+
* when called by the native await mechanism. This is useful for preventing
|
|
304
|
+
* accidental awaiting of objects that aren't meant to be promises.
|
|
305
|
+
*/
|
|
306
|
+
declare function preventNativeAwait<T extends object>(target: T): T;
|
|
307
|
+
/**
|
|
308
|
+
* Create a proxy that overlays one object (`overlay`) on top of another (`target`).
|
|
309
|
+
*
|
|
310
|
+
* - Properties from `overlay` take precedence.
|
|
311
|
+
* - Properties not in `overlay` fall back to `target`.
|
|
312
|
+
* - Methods from either object are bound to `overlay` so `this` is consistent.
|
|
313
|
+
*
|
|
314
|
+
* Useful when you want to override or extend behavior without fully copying/merging objects.
|
|
315
|
+
*/
|
|
316
|
+
declare function overlayProxy<T extends object, U extends object>(target: Value<T>, partial: U): U & Omit<T, keyof U>;
|
|
317
|
+
|
|
194
318
|
interface AsyncIdQueueCloseOptions {
|
|
195
319
|
id?: string;
|
|
196
320
|
reason?: unknown;
|
|
197
321
|
}
|
|
198
322
|
declare class AsyncIdQueue<T> {
|
|
199
323
|
private readonly openIds;
|
|
200
|
-
private readonly
|
|
201
|
-
private readonly
|
|
324
|
+
private readonly queues;
|
|
325
|
+
private readonly waiters;
|
|
202
326
|
get length(): number;
|
|
327
|
+
get waiterIds(): string[];
|
|
328
|
+
hasBufferedItems(id: string): boolean;
|
|
203
329
|
open(id: string): void;
|
|
204
330
|
isOpen(id: string): boolean;
|
|
205
331
|
push(id: string, item: T): void;
|
|
@@ -208,8 +334,21 @@ declare class AsyncIdQueue<T> {
|
|
|
208
334
|
assertOpen(id: string): void;
|
|
209
335
|
}
|
|
210
336
|
|
|
211
|
-
|
|
212
|
-
|
|
337
|
+
/**
|
|
338
|
+
* Converts a `ReadableStream` into an `AsyncIteratorClass`.
|
|
339
|
+
*/
|
|
340
|
+
declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
|
|
341
|
+
/**
|
|
342
|
+
* Converts an `AsyncIterator` into a `ReadableStream`.
|
|
343
|
+
*/
|
|
344
|
+
declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
|
|
345
|
+
/**
|
|
346
|
+
* Converts an `AsyncIterator` into a `ReadableStream`, ensuring that
|
|
347
|
+
* all emitted object values are *unproxied* before enqueuing.
|
|
348
|
+
*/
|
|
349
|
+
declare function asyncIteratorToUnproxiedDataStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
|
|
350
|
+
|
|
351
|
+
declare function tryDecodeURIComponent(value: string): string;
|
|
213
352
|
|
|
214
|
-
export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
|
215
|
-
export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
|
353
|
+
export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, asyncIteratorWithSpan, clone, compareSequentialIds, defer, fallback, findDeepMatches, get, getConstructor, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, overlayProxy, parseEmptyableJSON, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
|
|
354
|
+
export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InferAsyncIterableYield, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Promisable } from 'type-fest';
|
|
2
2
|
export { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
|
|
3
|
-
|
|
3
|
+
import { Tracer, TraceAPI, ContextAPI, PropagationAPI, SpanOptions, Context, Span, AttributeValue, Exception } from '@opentelemetry/api';
|
|
4
|
+
export { group, guard, mapEntries, mapValues, omit, retry, sleep } from 'radash';
|
|
4
5
|
|
|
5
6
|
type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
|
|
6
7
|
declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>): T;
|
|
@@ -27,6 +28,18 @@ type OmitChainMethodDeep<T extends object, K extends keyof any> = {
|
|
|
27
28
|
[P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
|
|
28
29
|
};
|
|
29
30
|
|
|
31
|
+
declare const ORPC_NAME = "orpc";
|
|
32
|
+
declare const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
|
|
33
|
+
declare const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.f397ca2";
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Error thrown when an operation is aborted.
|
|
37
|
+
* Uses the standardized 'AbortError' name for consistency with JavaScript APIs.
|
|
38
|
+
*/
|
|
39
|
+
declare class AbortError extends Error {
|
|
40
|
+
constructor(...rest: ConstructorParameters<typeof Error>);
|
|
41
|
+
}
|
|
42
|
+
|
|
30
43
|
interface EventPublisherOptions {
|
|
31
44
|
/**
|
|
32
45
|
* Maximum number of events to buffer for async iterator subscribers.
|
|
@@ -47,7 +60,7 @@ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
|
|
|
47
60
|
/**
|
|
48
61
|
* Aborts the async iterator. Throws if aborted before or during pulling.
|
|
49
62
|
*/
|
|
50
|
-
signal?: AbortSignal;
|
|
63
|
+
signal?: AbortSignal | undefined;
|
|
51
64
|
}
|
|
52
65
|
declare class EventPublisher<T extends Record<PropertyKey, any>> {
|
|
53
66
|
#private;
|
|
@@ -90,6 +103,14 @@ declare class SequentialIdGenerator {
|
|
|
90
103
|
private index;
|
|
91
104
|
generate(): string;
|
|
92
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Compares two sequential IDs.
|
|
108
|
+
* Returns:
|
|
109
|
+
* - negative if `a` < `b`
|
|
110
|
+
* - positive if `a` > `b`
|
|
111
|
+
* - 0 if equal
|
|
112
|
+
*/
|
|
113
|
+
declare function compareSequentialIds(a: string, b: string): number;
|
|
93
114
|
|
|
94
115
|
type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
95
116
|
type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
|
|
@@ -108,6 +129,7 @@ interface Registry {
|
|
|
108
129
|
type ThrowableError = Registry extends {
|
|
109
130
|
throwableError: infer T;
|
|
110
131
|
} ? T : Error;
|
|
132
|
+
type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
|
|
111
133
|
|
|
112
134
|
type InterceptableOptions = Record<string, any>;
|
|
113
135
|
type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
|
|
@@ -141,6 +163,72 @@ declare function onFinish<T, TOptions extends {
|
|
|
141
163
|
}, 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']>>>;
|
|
142
164
|
declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
|
|
143
165
|
|
|
166
|
+
/**
|
|
167
|
+
* Only import types from @opentelemetry/api to avoid runtime dependencies.
|
|
168
|
+
*/
|
|
169
|
+
|
|
170
|
+
interface OtelConfig {
|
|
171
|
+
tracer: Tracer;
|
|
172
|
+
trace: TraceAPI;
|
|
173
|
+
context: ContextAPI;
|
|
174
|
+
propagation: PropagationAPI;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Sets the global OpenTelemetry config.
|
|
178
|
+
* Call this once at app startup. Use `undefined` to disable tracing.
|
|
179
|
+
*/
|
|
180
|
+
declare function setGlobalOtelConfig(config: OtelConfig | undefined): void;
|
|
181
|
+
/**
|
|
182
|
+
* Gets the global OpenTelemetry config.
|
|
183
|
+
* Returns `undefined` if OpenTelemetry is not configured, initialized, or enabled.
|
|
184
|
+
*/
|
|
185
|
+
declare function getGlobalOtelConfig(): OtelConfig | undefined;
|
|
186
|
+
/**
|
|
187
|
+
* Starts a new OpenTelemetry span with the given name and options.
|
|
188
|
+
*
|
|
189
|
+
* @returns The new span, or `undefined` if no tracer is set.
|
|
190
|
+
*/
|
|
191
|
+
declare function startSpan(name: string, options?: SpanOptions, context?: Context): Span | undefined;
|
|
192
|
+
interface SetSpanErrorOptions {
|
|
193
|
+
/**
|
|
194
|
+
* Span error status is not set if error is due to cancellation by the signal.
|
|
195
|
+
*/
|
|
196
|
+
signal?: AbortSignal;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Records and sets the error status on the given span.
|
|
200
|
+
* If the span is `undefined`, it does nothing.
|
|
201
|
+
*/
|
|
202
|
+
declare function setSpanError(span: Span | undefined, error: unknown, options?: SetSpanErrorOptions): void;
|
|
203
|
+
declare function setSpanAttribute(span: Span | undefined, key: string, value: AttributeValue | undefined): void;
|
|
204
|
+
/**
|
|
205
|
+
* Converts an error to an OpenTelemetry Exception.
|
|
206
|
+
*/
|
|
207
|
+
declare function toOtelException(error: unknown): Exclude<Exception, string>;
|
|
208
|
+
/**
|
|
209
|
+
* Converts a value to a string suitable for OpenTelemetry span attributes.
|
|
210
|
+
*/
|
|
211
|
+
declare function toSpanAttributeValue(data: unknown): string;
|
|
212
|
+
interface RunWithSpanOptions extends SpanOptions, SetSpanErrorOptions {
|
|
213
|
+
/**
|
|
214
|
+
* The name of the span to create.
|
|
215
|
+
*/
|
|
216
|
+
name: string;
|
|
217
|
+
/**
|
|
218
|
+
* Context to use for the span.
|
|
219
|
+
*/
|
|
220
|
+
context?: Context;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* Runs a function within the context of a new OpenTelemetry span.
|
|
224
|
+
* The span is ended automatically, and errors are recorded to the span.
|
|
225
|
+
*/
|
|
226
|
+
declare function runWithSpan<T>({ name, context, ...options }: RunWithSpanOptions, fn: (span?: Span) => Promisable<T>): Promise<T>;
|
|
227
|
+
/**
|
|
228
|
+
* Runs a function within the context of an existing OpenTelemetry span.
|
|
229
|
+
*/
|
|
230
|
+
declare function runInSpanContext<T>(span: Span | undefined, fn: () => Promisable<T>): Promise<T>;
|
|
231
|
+
|
|
144
232
|
declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
|
|
145
233
|
interface AsyncIteratorClassNextFn<T, TReturn> {
|
|
146
234
|
(): Promise<IteratorResult<T, TReturn>>;
|
|
@@ -165,6 +253,13 @@ declare class AsyncIteratorClass<T, TReturn = unknown, TNext = unknown> implemen
|
|
|
165
253
|
[Symbol.asyncIterator](): this;
|
|
166
254
|
}
|
|
167
255
|
declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorClass<T, TReturn, TNext>)[];
|
|
256
|
+
interface AsyncIteratorWithSpanOptions extends SetSpanErrorOptions {
|
|
257
|
+
/**
|
|
258
|
+
* The name of the span to create.
|
|
259
|
+
*/
|
|
260
|
+
name: string;
|
|
261
|
+
}
|
|
262
|
+
declare function asyncIteratorWithSpan<T, TReturn, TNext>({ name, ...options }: AsyncIteratorWithSpanOptions, iterator: AsyncIterator<T, TReturn, TNext>): AsyncIteratorClass<T, TReturn, TNext>;
|
|
168
263
|
|
|
169
264
|
declare function parseEmptyableJSON(text: string | null | undefined): unknown;
|
|
170
265
|
declare function stringifyJSON<T>(value: T | {
|
|
@@ -176,6 +271,11 @@ declare function findDeepMatches(check: (value: unknown) => boolean, payload: un
|
|
|
176
271
|
maps: Segment[][];
|
|
177
272
|
values: unknown[];
|
|
178
273
|
};
|
|
274
|
+
/**
|
|
275
|
+
* Get constructor of the value
|
|
276
|
+
*
|
|
277
|
+
*/
|
|
278
|
+
declare function getConstructor(value: unknown): Function | null | undefined;
|
|
179
279
|
/**
|
|
180
280
|
* Check if the value is an object even it created by `Object.create(null)` or more tricky way.
|
|
181
281
|
*/
|
|
@@ -185,21 +285,47 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
185
285
|
*/
|
|
186
286
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
187
287
|
declare function clone<T>(value: T): T;
|
|
188
|
-
declare function get(object:
|
|
288
|
+
declare function get(object: unknown, path: readonly PropertyKey[]): unknown;
|
|
189
289
|
declare function isPropertyKey(value: unknown): value is PropertyKey;
|
|
190
290
|
declare const NullProtoObj: ({
|
|
191
291
|
new <T extends Record<PropertyKey, unknown>>(): T;
|
|
192
292
|
});
|
|
193
293
|
|
|
294
|
+
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
|
|
295
|
+
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
|
|
296
|
+
/**
|
|
297
|
+
* Returns the value if it is defined, otherwise returns the fallback
|
|
298
|
+
*/
|
|
299
|
+
declare function fallback<T>(value: T | undefined, fallback: T): T;
|
|
300
|
+
|
|
301
|
+
/**
|
|
302
|
+
* Prevents objects from being awaitable by intercepting the `then` method
|
|
303
|
+
* when called by the native await mechanism. This is useful for preventing
|
|
304
|
+
* accidental awaiting of objects that aren't meant to be promises.
|
|
305
|
+
*/
|
|
306
|
+
declare function preventNativeAwait<T extends object>(target: T): T;
|
|
307
|
+
/**
|
|
308
|
+
* Create a proxy that overlays one object (`overlay`) on top of another (`target`).
|
|
309
|
+
*
|
|
310
|
+
* - Properties from `overlay` take precedence.
|
|
311
|
+
* - Properties not in `overlay` fall back to `target`.
|
|
312
|
+
* - Methods from either object are bound to `overlay` so `this` is consistent.
|
|
313
|
+
*
|
|
314
|
+
* Useful when you want to override or extend behavior without fully copying/merging objects.
|
|
315
|
+
*/
|
|
316
|
+
declare function overlayProxy<T extends object, U extends object>(target: Value<T>, partial: U): U & Omit<T, keyof U>;
|
|
317
|
+
|
|
194
318
|
interface AsyncIdQueueCloseOptions {
|
|
195
319
|
id?: string;
|
|
196
320
|
reason?: unknown;
|
|
197
321
|
}
|
|
198
322
|
declare class AsyncIdQueue<T> {
|
|
199
323
|
private readonly openIds;
|
|
200
|
-
private readonly
|
|
201
|
-
private readonly
|
|
324
|
+
private readonly queues;
|
|
325
|
+
private readonly waiters;
|
|
202
326
|
get length(): number;
|
|
327
|
+
get waiterIds(): string[];
|
|
328
|
+
hasBufferedItems(id: string): boolean;
|
|
203
329
|
open(id: string): void;
|
|
204
330
|
isOpen(id: string): boolean;
|
|
205
331
|
push(id: string, item: T): void;
|
|
@@ -208,8 +334,21 @@ declare class AsyncIdQueue<T> {
|
|
|
208
334
|
assertOpen(id: string): void;
|
|
209
335
|
}
|
|
210
336
|
|
|
211
|
-
|
|
212
|
-
|
|
337
|
+
/**
|
|
338
|
+
* Converts a `ReadableStream` into an `AsyncIteratorClass`.
|
|
339
|
+
*/
|
|
340
|
+
declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
|
|
341
|
+
/**
|
|
342
|
+
* Converts an `AsyncIterator` into a `ReadableStream`.
|
|
343
|
+
*/
|
|
344
|
+
declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
|
|
345
|
+
/**
|
|
346
|
+
* Converts an `AsyncIterator` into a `ReadableStream`, ensuring that
|
|
347
|
+
* all emitted object values are *unproxied* before enqueuing.
|
|
348
|
+
*/
|
|
349
|
+
declare function asyncIteratorToUnproxiedDataStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
|
|
350
|
+
|
|
351
|
+
declare function tryDecodeURIComponent(value: string): string;
|
|
213
352
|
|
|
214
|
-
export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
|
215
|
-
export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
|
353
|
+
export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, asyncIteratorWithSpan, clone, compareSequentialIds, defer, fallback, findDeepMatches, get, getConstructor, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, overlayProxy, parseEmptyableJSON, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
|
|
354
|
+
export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InferAsyncIterableYield, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { group, guard, mapEntries, mapValues, omit } from 'radash';
|
|
1
|
+
export { group, guard, mapEntries, mapValues, omit, retry, sleep } from 'radash';
|
|
2
2
|
|
|
3
3
|
function resolveMaybeOptionalOptions(rest) {
|
|
4
4
|
return rest[0] ?? {};
|
|
@@ -19,6 +19,17 @@ function readAsBuffer(source) {
|
|
|
19
19
|
return source.arrayBuffer();
|
|
20
20
|
}
|
|
21
21
|
|
|
22
|
+
const ORPC_NAME = "orpc";
|
|
23
|
+
const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
|
|
24
|
+
const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.f397ca2";
|
|
25
|
+
|
|
26
|
+
class AbortError extends Error {
|
|
27
|
+
constructor(...rest) {
|
|
28
|
+
super(...rest);
|
|
29
|
+
this.name = "AbortError";
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
|
|
22
33
|
function once(fn) {
|
|
23
34
|
let cached;
|
|
24
35
|
return () => {
|
|
@@ -47,13 +58,112 @@ function defer(callback) {
|
|
|
47
58
|
}
|
|
48
59
|
}
|
|
49
60
|
|
|
61
|
+
const SPAN_ERROR_STATUS = 2;
|
|
62
|
+
const GLOBAL_OTEL_CONFIG_KEY = `__${ORPC_SHARED_PACKAGE_NAME}@${ORPC_SHARED_PACKAGE_VERSION}/otel/config__`;
|
|
63
|
+
function setGlobalOtelConfig(config) {
|
|
64
|
+
globalThis[GLOBAL_OTEL_CONFIG_KEY] = config;
|
|
65
|
+
}
|
|
66
|
+
function getGlobalOtelConfig() {
|
|
67
|
+
return globalThis[GLOBAL_OTEL_CONFIG_KEY];
|
|
68
|
+
}
|
|
69
|
+
function startSpan(name, options = {}, context) {
|
|
70
|
+
const tracer = getGlobalOtelConfig()?.tracer;
|
|
71
|
+
return tracer?.startSpan(name, options, context);
|
|
72
|
+
}
|
|
73
|
+
function setSpanError(span, error, options = {}) {
|
|
74
|
+
if (!span) {
|
|
75
|
+
return;
|
|
76
|
+
}
|
|
77
|
+
const exception = toOtelException(error);
|
|
78
|
+
span.recordException(exception);
|
|
79
|
+
if (!options.signal?.aborted || options.signal.reason !== error) {
|
|
80
|
+
span.setStatus({
|
|
81
|
+
code: SPAN_ERROR_STATUS,
|
|
82
|
+
message: exception.message
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
function setSpanAttribute(span, key, value) {
|
|
87
|
+
if (!span || value === void 0) {
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
span.setAttribute(key, value);
|
|
91
|
+
}
|
|
92
|
+
function toOtelException(error) {
|
|
93
|
+
if (error instanceof Error) {
|
|
94
|
+
const exception = {
|
|
95
|
+
message: error.message,
|
|
96
|
+
name: error.name,
|
|
97
|
+
stack: error.stack
|
|
98
|
+
};
|
|
99
|
+
if ("code" in error && (typeof error.code === "string" || typeof error.code === "number")) {
|
|
100
|
+
exception.code = error.code;
|
|
101
|
+
}
|
|
102
|
+
return exception;
|
|
103
|
+
}
|
|
104
|
+
return { message: String(error) };
|
|
105
|
+
}
|
|
106
|
+
function toSpanAttributeValue(data) {
|
|
107
|
+
if (data === void 0) {
|
|
108
|
+
return "undefined";
|
|
109
|
+
}
|
|
110
|
+
try {
|
|
111
|
+
return JSON.stringify(data, (_, value) => {
|
|
112
|
+
if (typeof value === "bigint") {
|
|
113
|
+
return value.toString();
|
|
114
|
+
}
|
|
115
|
+
if (value instanceof Map || value instanceof Set) {
|
|
116
|
+
return Array.from(value);
|
|
117
|
+
}
|
|
118
|
+
return value;
|
|
119
|
+
});
|
|
120
|
+
} catch {
|
|
121
|
+
return String(data);
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
async function runWithSpan({ name, context, ...options }, fn) {
|
|
125
|
+
const tracer = getGlobalOtelConfig()?.tracer;
|
|
126
|
+
if (!tracer) {
|
|
127
|
+
return fn();
|
|
128
|
+
}
|
|
129
|
+
const callback = async (span) => {
|
|
130
|
+
try {
|
|
131
|
+
return await fn(span);
|
|
132
|
+
} catch (e) {
|
|
133
|
+
setSpanError(span, e, options);
|
|
134
|
+
throw e;
|
|
135
|
+
} finally {
|
|
136
|
+
span.end();
|
|
137
|
+
}
|
|
138
|
+
};
|
|
139
|
+
if (context) {
|
|
140
|
+
return tracer.startActiveSpan(name, options, context, callback);
|
|
141
|
+
} else {
|
|
142
|
+
return tracer.startActiveSpan(name, options, callback);
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
async function runInSpanContext(span, fn) {
|
|
146
|
+
const otelConfig = getGlobalOtelConfig();
|
|
147
|
+
if (!span || !otelConfig) {
|
|
148
|
+
return fn();
|
|
149
|
+
}
|
|
150
|
+
const ctx = otelConfig.trace.setSpan(otelConfig.context.active(), span);
|
|
151
|
+
return otelConfig.context.with(ctx, fn);
|
|
152
|
+
}
|
|
153
|
+
|
|
50
154
|
class AsyncIdQueue {
|
|
51
155
|
openIds = /* @__PURE__ */ new Set();
|
|
52
|
-
|
|
53
|
-
|
|
156
|
+
queues = /* @__PURE__ */ new Map();
|
|
157
|
+
waiters = /* @__PURE__ */ new Map();
|
|
54
158
|
get length() {
|
|
55
159
|
return this.openIds.size;
|
|
56
160
|
}
|
|
161
|
+
get waiterIds() {
|
|
162
|
+
return Array.from(this.waiters.keys());
|
|
163
|
+
}
|
|
164
|
+
hasBufferedItems(id) {
|
|
165
|
+
return Boolean(this.queues.get(id)?.length);
|
|
166
|
+
}
|
|
57
167
|
open(id) {
|
|
58
168
|
this.openIds.add(id);
|
|
59
169
|
}
|
|
@@ -62,59 +172,57 @@ class AsyncIdQueue {
|
|
|
62
172
|
}
|
|
63
173
|
push(id, item) {
|
|
64
174
|
this.assertOpen(id);
|
|
65
|
-
const pending = this.
|
|
175
|
+
const pending = this.waiters.get(id);
|
|
66
176
|
if (pending?.length) {
|
|
67
177
|
pending.shift()[0](item);
|
|
68
178
|
if (pending.length === 0) {
|
|
69
|
-
this.
|
|
179
|
+
this.waiters.delete(id);
|
|
70
180
|
}
|
|
71
181
|
} else {
|
|
72
|
-
const items = this.
|
|
182
|
+
const items = this.queues.get(id);
|
|
73
183
|
if (items) {
|
|
74
184
|
items.push(item);
|
|
75
185
|
} else {
|
|
76
|
-
this.
|
|
186
|
+
this.queues.set(id, [item]);
|
|
77
187
|
}
|
|
78
188
|
}
|
|
79
189
|
}
|
|
80
190
|
async pull(id) {
|
|
81
191
|
this.assertOpen(id);
|
|
82
|
-
const items = this.
|
|
192
|
+
const items = this.queues.get(id);
|
|
83
193
|
if (items?.length) {
|
|
84
194
|
const item = items.shift();
|
|
85
195
|
if (items.length === 0) {
|
|
86
|
-
this.
|
|
196
|
+
this.queues.delete(id);
|
|
87
197
|
}
|
|
88
198
|
return item;
|
|
89
199
|
}
|
|
90
200
|
return new Promise((resolve, reject) => {
|
|
91
|
-
const waitingPulls = this.
|
|
201
|
+
const waitingPulls = this.waiters.get(id);
|
|
92
202
|
const pending = [resolve, reject];
|
|
93
203
|
if (waitingPulls) {
|
|
94
204
|
waitingPulls.push(pending);
|
|
95
205
|
} else {
|
|
96
|
-
this.
|
|
206
|
+
this.waiters.set(id, [pending]);
|
|
97
207
|
}
|
|
98
208
|
});
|
|
99
209
|
}
|
|
100
210
|
close({ id, reason } = {}) {
|
|
101
211
|
if (id === void 0) {
|
|
102
|
-
this.
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
});
|
|
212
|
+
this.waiters.forEach((pendingPulls, id2) => {
|
|
213
|
+
const error2 = reason ?? new AbortError(`[AsyncIdQueue] Queue[${id2}] was closed or aborted while waiting for pulling.`);
|
|
214
|
+
pendingPulls.forEach(([, reject]) => reject(error2));
|
|
106
215
|
});
|
|
107
|
-
this.
|
|
216
|
+
this.waiters.clear();
|
|
108
217
|
this.openIds.clear();
|
|
109
|
-
this.
|
|
218
|
+
this.queues.clear();
|
|
110
219
|
return;
|
|
111
220
|
}
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
this.pendingPulls.delete(id);
|
|
221
|
+
const error = reason ?? new AbortError(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`);
|
|
222
|
+
this.waiters.get(id)?.forEach(([, reject]) => reject(error));
|
|
223
|
+
this.waiters.delete(id);
|
|
116
224
|
this.openIds.delete(id);
|
|
117
|
-
this.
|
|
225
|
+
this.queues.delete(id);
|
|
118
226
|
}
|
|
119
227
|
assertOpen(id) {
|
|
120
228
|
if (!this.isOpen(id)) {
|
|
@@ -194,51 +302,81 @@ class AsyncIteratorClass {
|
|
|
194
302
|
}
|
|
195
303
|
function replicateAsyncIterator(source, count) {
|
|
196
304
|
const queue = new AsyncIdQueue();
|
|
197
|
-
const
|
|
198
|
-
let
|
|
305
|
+
const ids = Array.from({ length: count }, (_, i) => i.toString());
|
|
306
|
+
let isSourceFinished = false;
|
|
199
307
|
const start = once(async () => {
|
|
200
308
|
try {
|
|
201
309
|
while (true) {
|
|
202
310
|
const item = await source.next();
|
|
203
|
-
|
|
204
|
-
if (queue.isOpen(id
|
|
205
|
-
queue.push(id
|
|
311
|
+
ids.forEach((id) => {
|
|
312
|
+
if (queue.isOpen(id)) {
|
|
313
|
+
queue.push(id, { next: item });
|
|
206
314
|
}
|
|
207
|
-
}
|
|
315
|
+
});
|
|
208
316
|
if (item.done) {
|
|
209
317
|
break;
|
|
210
318
|
}
|
|
211
319
|
}
|
|
212
|
-
} catch (
|
|
213
|
-
|
|
320
|
+
} catch (error) {
|
|
321
|
+
ids.forEach((id) => {
|
|
322
|
+
if (queue.isOpen(id)) {
|
|
323
|
+
queue.push(id, { error });
|
|
324
|
+
}
|
|
325
|
+
});
|
|
326
|
+
} finally {
|
|
327
|
+
isSourceFinished = true;
|
|
214
328
|
}
|
|
215
329
|
});
|
|
216
|
-
|
|
217
|
-
queue.open(id
|
|
218
|
-
|
|
219
|
-
() => {
|
|
330
|
+
const replicated = ids.map((id) => {
|
|
331
|
+
queue.open(id);
|
|
332
|
+
return new AsyncIteratorClass(
|
|
333
|
+
async () => {
|
|
220
334
|
start();
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
}
|
|
227
|
-
});
|
|
228
|
-
});
|
|
335
|
+
const item = await queue.pull(id);
|
|
336
|
+
if (item.next) {
|
|
337
|
+
return item.next;
|
|
338
|
+
}
|
|
339
|
+
throw item.error;
|
|
229
340
|
},
|
|
230
341
|
async (reason) => {
|
|
231
|
-
queue.close({ id
|
|
232
|
-
if (reason !== "next") {
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
}
|
|
342
|
+
queue.close({ id });
|
|
343
|
+
if (reason !== "next" && !queue.length && !isSourceFinished) {
|
|
344
|
+
isSourceFinished = true;
|
|
345
|
+
await source?.return?.();
|
|
236
346
|
}
|
|
237
347
|
}
|
|
238
|
-
)
|
|
239
|
-
}
|
|
348
|
+
);
|
|
349
|
+
});
|
|
240
350
|
return replicated;
|
|
241
351
|
}
|
|
352
|
+
function asyncIteratorWithSpan({ name, ...options }, iterator) {
|
|
353
|
+
let span;
|
|
354
|
+
return new AsyncIteratorClass(
|
|
355
|
+
async () => {
|
|
356
|
+
span ??= startSpan(name);
|
|
357
|
+
try {
|
|
358
|
+
const result = await runInSpanContext(span, () => iterator.next());
|
|
359
|
+
span?.addEvent(result.done ? "completed" : "yielded");
|
|
360
|
+
return result;
|
|
361
|
+
} catch (err) {
|
|
362
|
+
setSpanError(span, err, options);
|
|
363
|
+
throw err;
|
|
364
|
+
}
|
|
365
|
+
},
|
|
366
|
+
async (reason) => {
|
|
367
|
+
try {
|
|
368
|
+
if (reason !== "next") {
|
|
369
|
+
await runInSpanContext(span, () => iterator.return?.());
|
|
370
|
+
}
|
|
371
|
+
} catch (err) {
|
|
372
|
+
setSpanError(span, err, options);
|
|
373
|
+
throw err;
|
|
374
|
+
} finally {
|
|
375
|
+
span?.end();
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
);
|
|
379
|
+
}
|
|
242
380
|
|
|
243
381
|
class EventPublisher {
|
|
244
382
|
#listenersMap = /* @__PURE__ */ new Map();
|
|
@@ -265,15 +403,15 @@ class EventPublisher {
|
|
|
265
403
|
if (typeof listenerOrOptions === "function") {
|
|
266
404
|
let listeners = this.#listenersMap.get(event);
|
|
267
405
|
if (!listeners) {
|
|
268
|
-
this.#listenersMap.set(event, listeners =
|
|
406
|
+
this.#listenersMap.set(event, listeners = []);
|
|
269
407
|
}
|
|
270
|
-
listeners.
|
|
271
|
-
return () => {
|
|
272
|
-
listeners.
|
|
273
|
-
if (listeners.
|
|
408
|
+
listeners.push(listenerOrOptions);
|
|
409
|
+
return once(() => {
|
|
410
|
+
listeners.splice(listeners.indexOf(listenerOrOptions), 1);
|
|
411
|
+
if (listeners.length === 0) {
|
|
274
412
|
this.#listenersMap.delete(event);
|
|
275
413
|
}
|
|
276
|
-
};
|
|
414
|
+
});
|
|
277
415
|
}
|
|
278
416
|
const signal = listenerOrOptions?.signal;
|
|
279
417
|
const maxBufferedEvents = listenerOrOptions?.maxBufferedEvents ?? this.#maxBufferedEvents;
|
|
@@ -319,13 +457,19 @@ class EventPublisher {
|
|
|
319
457
|
}
|
|
320
458
|
|
|
321
459
|
class SequentialIdGenerator {
|
|
322
|
-
index = BigInt(
|
|
460
|
+
index = BigInt(1);
|
|
323
461
|
generate() {
|
|
324
|
-
const id = this.index.toString(
|
|
462
|
+
const id = this.index.toString(36);
|
|
325
463
|
this.index++;
|
|
326
464
|
return id;
|
|
327
465
|
}
|
|
328
466
|
}
|
|
467
|
+
function compareSequentialIds(a, b) {
|
|
468
|
+
if (a.length !== b.length) {
|
|
469
|
+
return a.length - b.length;
|
|
470
|
+
}
|
|
471
|
+
return a < b ? -1 : a > b ? 1 : 0;
|
|
472
|
+
}
|
|
329
473
|
|
|
330
474
|
function onStart(callback) {
|
|
331
475
|
return async (options, ...rest) => {
|
|
@@ -404,6 +548,12 @@ function findDeepMatches(check, payload, segments = [], maps = [], values = [])
|
|
|
404
548
|
}
|
|
405
549
|
return { maps, values };
|
|
406
550
|
}
|
|
551
|
+
function getConstructor(value) {
|
|
552
|
+
if (!isTypescriptObject(value)) {
|
|
553
|
+
return null;
|
|
554
|
+
}
|
|
555
|
+
return Object.getPrototypeOf(value)?.constructor;
|
|
556
|
+
}
|
|
407
557
|
function isObject(value) {
|
|
408
558
|
if (!value || typeof value !== "object") {
|
|
409
559
|
return false;
|
|
@@ -455,5 +605,104 @@ function value(value2, ...args) {
|
|
|
455
605
|
}
|
|
456
606
|
return value2;
|
|
457
607
|
}
|
|
608
|
+
function fallback(value2, fallback2) {
|
|
609
|
+
return value2 === void 0 ? fallback2 : value2;
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
function preventNativeAwait(target) {
|
|
613
|
+
return new Proxy(target, {
|
|
614
|
+
get(target2, prop, receiver) {
|
|
615
|
+
const value2 = Reflect.get(target2, prop, receiver);
|
|
616
|
+
if (prop !== "then" || typeof value2 !== "function") {
|
|
617
|
+
return value2;
|
|
618
|
+
}
|
|
619
|
+
return new Proxy(value2, {
|
|
620
|
+
apply(targetFn, thisArg, args) {
|
|
621
|
+
if (args.length !== 2 || args.some((arg) => !isNativeFunction(arg))) {
|
|
622
|
+
return Reflect.apply(targetFn, thisArg, args);
|
|
623
|
+
}
|
|
624
|
+
let shouldOmit = true;
|
|
625
|
+
args[0].call(thisArg, preventNativeAwait(new Proxy(target2, {
|
|
626
|
+
get: (target3, prop2, receiver2) => {
|
|
627
|
+
if (shouldOmit && prop2 === "then") {
|
|
628
|
+
shouldOmit = false;
|
|
629
|
+
return void 0;
|
|
630
|
+
}
|
|
631
|
+
return Reflect.get(target3, prop2, receiver2);
|
|
632
|
+
}
|
|
633
|
+
})));
|
|
634
|
+
}
|
|
635
|
+
});
|
|
636
|
+
}
|
|
637
|
+
});
|
|
638
|
+
}
|
|
639
|
+
const NATIVE_FUNCTION_REGEX = /^\s*function\s*\(\)\s*\{\s*\[native code\]\s*\}\s*$/;
|
|
640
|
+
function isNativeFunction(fn) {
|
|
641
|
+
return typeof fn === "function" && NATIVE_FUNCTION_REGEX.test(fn.toString());
|
|
642
|
+
}
|
|
643
|
+
function overlayProxy(target, partial) {
|
|
644
|
+
const proxy = new Proxy(typeof target === "function" ? partial : target, {
|
|
645
|
+
get(_, prop) {
|
|
646
|
+
const targetValue = prop in partial ? partial : value(target);
|
|
647
|
+
const v = Reflect.get(targetValue, prop);
|
|
648
|
+
return typeof v === "function" ? v.bind(targetValue) : v;
|
|
649
|
+
},
|
|
650
|
+
has(_, prop) {
|
|
651
|
+
return Reflect.has(partial, prop) || Reflect.has(value(target), prop);
|
|
652
|
+
}
|
|
653
|
+
});
|
|
654
|
+
return proxy;
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
function streamToAsyncIteratorClass(stream) {
|
|
658
|
+
const reader = stream.getReader();
|
|
659
|
+
return new AsyncIteratorClass(
|
|
660
|
+
async () => {
|
|
661
|
+
return reader.read();
|
|
662
|
+
},
|
|
663
|
+
async () => {
|
|
664
|
+
await reader.cancel();
|
|
665
|
+
}
|
|
666
|
+
);
|
|
667
|
+
}
|
|
668
|
+
function asyncIteratorToStream(iterator) {
|
|
669
|
+
return new ReadableStream({
|
|
670
|
+
async pull(controller) {
|
|
671
|
+
const { done, value } = await iterator.next();
|
|
672
|
+
if (done) {
|
|
673
|
+
controller.close();
|
|
674
|
+
} else {
|
|
675
|
+
controller.enqueue(value);
|
|
676
|
+
}
|
|
677
|
+
},
|
|
678
|
+
async cancel() {
|
|
679
|
+
await iterator.return?.();
|
|
680
|
+
}
|
|
681
|
+
});
|
|
682
|
+
}
|
|
683
|
+
function asyncIteratorToUnproxiedDataStream(iterator) {
|
|
684
|
+
return new ReadableStream({
|
|
685
|
+
async pull(controller) {
|
|
686
|
+
const { done, value } = await iterator.next();
|
|
687
|
+
if (done) {
|
|
688
|
+
controller.close();
|
|
689
|
+
} else {
|
|
690
|
+
const unproxied = isObject(value) ? { ...value } : Array.isArray(value) ? value.map((i) => i) : value;
|
|
691
|
+
controller.enqueue(unproxied);
|
|
692
|
+
}
|
|
693
|
+
},
|
|
694
|
+
async cancel() {
|
|
695
|
+
await iterator.return?.();
|
|
696
|
+
}
|
|
697
|
+
});
|
|
698
|
+
}
|
|
699
|
+
|
|
700
|
+
function tryDecodeURIComponent(value) {
|
|
701
|
+
try {
|
|
702
|
+
return decodeURIComponent(value);
|
|
703
|
+
} catch {
|
|
704
|
+
return value;
|
|
705
|
+
}
|
|
706
|
+
}
|
|
458
707
|
|
|
459
|
-
export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
|
|
708
|
+
export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, asyncIteratorWithSpan, clone, compareSequentialIds, defer, fallback, findDeepMatches, get, getConstructor, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, overlayProxy, parseEmptyableJSON, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, 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.f397ca2",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -23,14 +23,23 @@
|
|
|
23
23
|
"files": [
|
|
24
24
|
"dist"
|
|
25
25
|
],
|
|
26
|
+
"peerDependencies": {
|
|
27
|
+
"@opentelemetry/api": ">=1.9.0"
|
|
28
|
+
},
|
|
29
|
+
"peerDependenciesMeta": {
|
|
30
|
+
"@opentelemetry/api": {
|
|
31
|
+
"optional": true
|
|
32
|
+
}
|
|
33
|
+
},
|
|
26
34
|
"dependencies": {
|
|
27
35
|
"radash": "^12.1.1",
|
|
28
|
-
"type-fest": "^
|
|
36
|
+
"type-fest": "^5.2.0"
|
|
29
37
|
},
|
|
30
38
|
"devDependencies": {
|
|
31
|
-
"
|
|
39
|
+
"@opentelemetry/api": "^1.9.0",
|
|
40
|
+
"arktype": "2.1.25",
|
|
32
41
|
"valibot": "^1.1.0",
|
|
33
|
-
"zod": "^
|
|
42
|
+
"zod": "^4.1.12"
|
|
34
43
|
},
|
|
35
44
|
"scripts": {
|
|
36
45
|
"build": "unbuild",
|