@orpc/shared 0.0.0-next.f779f69 → 0.0.0-next.f7af1c4

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 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>
@@ -35,7 +30,8 @@
35
30
  - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
36
31
  - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
37
32
  - **📝 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.
33
+ - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
34
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
39
35
  - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
40
36
  - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
41
37
  - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -43,7 +39,6 @@
43
39
  - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
44
40
  - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
45
41
  - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
46
- - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
47
42
 
48
43
  ## Documentation
49
44
 
@@ -54,14 +49,14 @@ You can find the full documentation [here](https://orpc.unnoq.com).
54
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
55
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
56
51
  - [@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.
52
+ - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
53
+ - [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
54
+ - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
58
55
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
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).
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).
56
+ - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
57
+ - [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
63
58
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
64
- - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
59
+ - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
65
60
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
66
61
  - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
67
62
  - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
package/dist/index.d.mts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { Promisable } from 'type-fest';
2
- export { IsEqual, IsNever, PartialDeep, Promisable } from 'type-fest';
3
- export { group, guard, mapEntries, mapValues, omit } from 'radash';
2
+ export { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
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;
@@ -8,6 +9,13 @@ declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>):
8
9
  declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
9
10
  declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
10
11
 
12
+ /**
13
+ * Converts Request/Response/Blob/File/.. to a buffer (ArrayBuffer or Uint8Array).
14
+ *
15
+ * Prefers the newer `.bytes` method when available as it more efficient but not widely supported yet.
16
+ */
17
+ declare function readAsBuffer(source: Pick<Blob, 'arrayBuffer' | 'bytes'>): Promise<ArrayBuffer | Uint8Array>;
18
+
11
19
  type AnyFunction = (...args: any[]) => any;
12
20
  declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
13
21
  declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
@@ -20,6 +28,18 @@ type OmitChainMethodDeep<T extends object, K extends keyof any> = {
20
28
  [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
21
29
  };
22
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.f7af1c4";
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
+
23
43
  interface EventPublisherOptions {
24
44
  /**
25
45
  * Maximum number of events to buffer for async iterator subscribers.
@@ -40,7 +60,7 @@ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
40
60
  /**
41
61
  * Aborts the async iterator. Throws if aborted before or during pulling.
42
62
  */
43
- signal?: AbortSignal;
63
+ signal?: AbortSignal | undefined;
44
64
  }
45
65
  declare class EventPublisher<T extends Record<PropertyKey, any>> {
46
66
  #private;
@@ -80,8 +100,8 @@ declare class EventPublisher<T extends Record<PropertyKey, any>> {
80
100
  }
81
101
 
82
102
  declare class SequentialIdGenerator {
83
- private nextId;
84
- generate(): number;
103
+ private index;
104
+ generate(): string;
85
105
  }
86
106
 
87
107
  type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
@@ -101,6 +121,7 @@ interface Registry {
101
121
  type ThrowableError = Registry extends {
102
122
  throwableError: infer T;
103
123
  } ? T : Error;
124
+ type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
104
125
 
105
126
  type InterceptableOptions = Record<string, any>;
106
127
  type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
@@ -134,21 +155,119 @@ declare function onFinish<T, TOptions extends {
134
155
  }, 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']>>>;
135
156
  declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
136
157
 
158
+ /**
159
+ * Only import types from @opentelemetry/api to avoid runtime dependencies.
160
+ */
161
+
162
+ interface OtelConfig {
163
+ tracer: Tracer;
164
+ trace: TraceAPI;
165
+ context: ContextAPI;
166
+ propagation: PropagationAPI;
167
+ }
168
+ /**
169
+ * Sets the global OpenTelemetry config.
170
+ * Call this once at app startup. Use `undefined` to disable tracing.
171
+ */
172
+ declare function setGlobalOtelConfig(config: OtelConfig | undefined): void;
173
+ /**
174
+ * Gets the global OpenTelemetry config.
175
+ * Returns `undefined` if OpenTelemetry is not configured, initialized, or enabled.
176
+ */
177
+ declare function getGlobalOtelConfig(): OtelConfig | undefined;
178
+ /**
179
+ * Starts a new OpenTelemetry span with the given name and options.
180
+ *
181
+ * @returns The new span, or `undefined` if no tracer is set.
182
+ */
183
+ declare function startSpan(name: string, options?: SpanOptions, context?: Context): Span | undefined;
184
+ interface SetSpanErrorOptions {
185
+ /**
186
+ * Span error status is not set if error is due to cancellation by the signal.
187
+ */
188
+ signal?: AbortSignal;
189
+ }
190
+ /**
191
+ * Records and sets the error status on the given span.
192
+ * If the span is `undefined`, it does nothing.
193
+ */
194
+ declare function setSpanError(span: Span | undefined, error: unknown, options?: SetSpanErrorOptions): void;
195
+ declare function setSpanAttribute(span: Span | undefined, key: string, value: AttributeValue | undefined): void;
196
+ /**
197
+ * Converts an error to an OpenTelemetry Exception.
198
+ */
199
+ declare function toOtelException(error: unknown): Exclude<Exception, string>;
200
+ /**
201
+ * Converts a value to a string suitable for OpenTelemetry span attributes.
202
+ */
203
+ declare function toSpanAttributeValue(data: unknown): string;
204
+ interface RunWithSpanOptions extends SpanOptions, SetSpanErrorOptions {
205
+ /**
206
+ * The name of the span to create.
207
+ */
208
+ name: string;
209
+ /**
210
+ * Context to use for the span.
211
+ */
212
+ context?: Context;
213
+ }
214
+ /**
215
+ * Runs a function within the context of a new OpenTelemetry span.
216
+ * The span is ended automatically, and errors are recorded to the span.
217
+ */
218
+ declare function runWithSpan<T>({ name, context, ...options }: RunWithSpanOptions, fn: (span?: Span) => Promisable<T>): Promise<T>;
219
+ /**
220
+ * Runs a function within the context of an existing OpenTelemetry span.
221
+ */
222
+ declare function runInSpanContext<T>(span: Span | undefined, fn: () => Promisable<T>): Promise<T>;
223
+
137
224
  declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
138
- interface CreateAsyncIteratorObjectCleanupFn {
225
+ interface AsyncIteratorClassNextFn<T, TReturn> {
226
+ (): Promise<IteratorResult<T, TReturn>>;
227
+ }
228
+ interface AsyncIteratorClassCleanupFn {
139
229
  (reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
140
230
  }
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>)[];
231
+ declare const fallbackAsyncDisposeSymbol: unique symbol;
232
+ declare const asyncDisposeSymbol: typeof Symbol extends {
233
+ asyncDispose: infer T;
234
+ } ? T : typeof fallbackAsyncDisposeSymbol;
235
+ declare class AsyncIteratorClass<T, TReturn = unknown, TNext = unknown> implements AsyncIteratorObject<T, TReturn, TNext>, AsyncGenerator<T, TReturn, TNext> {
236
+ #private;
237
+ constructor(next: AsyncIteratorClassNextFn<T, TReturn>, cleanup: AsyncIteratorClassCleanupFn);
238
+ next(): Promise<IteratorResult<T, TReturn>>;
239
+ return(value?: any): Promise<IteratorResult<T, TReturn>>;
240
+ throw(err: any): Promise<IteratorResult<T, TReturn>>;
241
+ /**
242
+ * asyncDispose symbol only available in esnext, we should fallback to Symbol.for('asyncDispose')
243
+ */
244
+ [asyncDisposeSymbol](): Promise<void>;
245
+ [Symbol.asyncIterator](): this;
246
+ }
247
+ declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorClass<T, TReturn, TNext>)[];
248
+ interface AsyncIteratorWithSpanOptions extends SetSpanErrorOptions {
249
+ /**
250
+ * The name of the span to create.
251
+ */
252
+ name: string;
253
+ }
254
+ declare function asyncIteratorWithSpan<T, TReturn, TNext>({ name, ...options }: AsyncIteratorWithSpanOptions, iterator: AsyncIterator<T, TReturn, TNext>): AsyncIteratorClass<T, TReturn, TNext>;
143
255
 
144
256
  declare function parseEmptyableJSON(text: string | null | undefined): unknown;
145
- declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
257
+ declare function stringifyJSON<T>(value: T | {
258
+ toJSON(): T;
259
+ }): undefined extends T ? undefined | string : string;
146
260
 
147
261
  type Segment = string | number;
148
262
  declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
149
263
  maps: Segment[][];
150
264
  values: unknown[];
151
265
  };
266
+ /**
267
+ * Get constructor of the value
268
+ *
269
+ */
270
+ declare function getConstructor(value: unknown): Function | null | undefined;
152
271
  /**
153
272
  * Check if the value is an object even it created by `Object.create(null)` or more tricky way.
154
273
  */
@@ -158,31 +277,59 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
158
277
  */
159
278
  declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
160
279
  declare function clone<T>(value: T): T;
161
- declare function get(object: object, path: readonly string[]): unknown;
280
+ declare function get(object: unknown, path: readonly string[]): unknown;
162
281
  declare function isPropertyKey(value: unknown): value is PropertyKey;
163
282
  declare const NullProtoObj: ({
164
283
  new <T extends Record<PropertyKey, unknown>>(): T;
165
284
  });
166
285
 
286
+ type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
287
+ declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
288
+ /**
289
+ * Returns the value if it is defined, otherwise returns the fallback
290
+ */
291
+ declare function fallback<T>(value: T | undefined, fallback: T): T;
292
+
293
+ /**
294
+ * Prevents objects from being awaitable by intercepting the `then` method
295
+ * when called by the native await mechanism. This is useful for preventing
296
+ * accidental awaiting of objects that aren't meant to be promises.
297
+ */
298
+ declare function preventNativeAwait<T extends object>(target: T): T;
299
+ /**
300
+ * Create a proxy that overlays one object (`overlay`) on top of another (`target`).
301
+ *
302
+ * - Properties from `overlay` take precedence.
303
+ * - Properties not in `overlay` fall back to `target`.
304
+ * - Methods from either object are bound to `overlay` so `this` is consistent.
305
+ *
306
+ * Useful when you want to override or extend behavior without fully copying/merging objects.
307
+ */
308
+ declare function overlayProxy<T extends object, U extends object>(target: Value<T>, partial: U): U & Omit<T, keyof U>;
309
+
167
310
  interface AsyncIdQueueCloseOptions {
168
- id?: number;
311
+ id?: string;
169
312
  reason?: unknown;
170
313
  }
171
314
  declare class AsyncIdQueue<T> {
172
315
  private readonly openIds;
173
- private readonly items;
174
- private readonly pendingPulls;
316
+ private readonly queues;
317
+ private readonly waiters;
175
318
  get length(): number;
176
- open(id: number): void;
177
- isOpen(id: number): boolean;
178
- push(id: number, item: T): void;
179
- pull(id: number): Promise<T>;
319
+ get waiterIds(): string[];
320
+ hasBufferedItems(id: string): boolean;
321
+ open(id: string): void;
322
+ isOpen(id: string): boolean;
323
+ push(id: string, item: T): void;
324
+ pull(id: string): Promise<T>;
180
325
  close({ id, reason }?: AsyncIdQueueCloseOptions): void;
181
- assertOpen(id: number): void;
326
+ assertOpen(id: string): void;
182
327
  }
183
328
 
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;
329
+ declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
330
+ declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
331
+
332
+ declare function tryDecodeURIComponent(value: string): string;
186
333
 
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 };
334
+ export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, 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 };
335
+ 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
- export { IsEqual, IsNever, PartialDeep, Promisable } from 'type-fest';
3
- export { group, guard, mapEntries, mapValues, omit } from 'radash';
2
+ export { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
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;
@@ -8,6 +9,13 @@ declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>):
8
9
  declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
9
10
  declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
10
11
 
12
+ /**
13
+ * Converts Request/Response/Blob/File/.. to a buffer (ArrayBuffer or Uint8Array).
14
+ *
15
+ * Prefers the newer `.bytes` method when available as it more efficient but not widely supported yet.
16
+ */
17
+ declare function readAsBuffer(source: Pick<Blob, 'arrayBuffer' | 'bytes'>): Promise<ArrayBuffer | Uint8Array>;
18
+
11
19
  type AnyFunction = (...args: any[]) => any;
12
20
  declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
13
21
  declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
@@ -20,6 +28,18 @@ type OmitChainMethodDeep<T extends object, K extends keyof any> = {
20
28
  [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
21
29
  };
22
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.f7af1c4";
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
+
23
43
  interface EventPublisherOptions {
24
44
  /**
25
45
  * Maximum number of events to buffer for async iterator subscribers.
@@ -40,7 +60,7 @@ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
40
60
  /**
41
61
  * Aborts the async iterator. Throws if aborted before or during pulling.
42
62
  */
43
- signal?: AbortSignal;
63
+ signal?: AbortSignal | undefined;
44
64
  }
45
65
  declare class EventPublisher<T extends Record<PropertyKey, any>> {
46
66
  #private;
@@ -80,8 +100,8 @@ declare class EventPublisher<T extends Record<PropertyKey, any>> {
80
100
  }
81
101
 
82
102
  declare class SequentialIdGenerator {
83
- private nextId;
84
- generate(): number;
103
+ private index;
104
+ generate(): string;
85
105
  }
86
106
 
87
107
  type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
@@ -101,6 +121,7 @@ interface Registry {
101
121
  type ThrowableError = Registry extends {
102
122
  throwableError: infer T;
103
123
  } ? T : Error;
124
+ type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
104
125
 
105
126
  type InterceptableOptions = Record<string, any>;
106
127
  type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
@@ -134,21 +155,119 @@ declare function onFinish<T, TOptions extends {
134
155
  }, 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']>>>;
135
156
  declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
136
157
 
158
+ /**
159
+ * Only import types from @opentelemetry/api to avoid runtime dependencies.
160
+ */
161
+
162
+ interface OtelConfig {
163
+ tracer: Tracer;
164
+ trace: TraceAPI;
165
+ context: ContextAPI;
166
+ propagation: PropagationAPI;
167
+ }
168
+ /**
169
+ * Sets the global OpenTelemetry config.
170
+ * Call this once at app startup. Use `undefined` to disable tracing.
171
+ */
172
+ declare function setGlobalOtelConfig(config: OtelConfig | undefined): void;
173
+ /**
174
+ * Gets the global OpenTelemetry config.
175
+ * Returns `undefined` if OpenTelemetry is not configured, initialized, or enabled.
176
+ */
177
+ declare function getGlobalOtelConfig(): OtelConfig | undefined;
178
+ /**
179
+ * Starts a new OpenTelemetry span with the given name and options.
180
+ *
181
+ * @returns The new span, or `undefined` if no tracer is set.
182
+ */
183
+ declare function startSpan(name: string, options?: SpanOptions, context?: Context): Span | undefined;
184
+ interface SetSpanErrorOptions {
185
+ /**
186
+ * Span error status is not set if error is due to cancellation by the signal.
187
+ */
188
+ signal?: AbortSignal;
189
+ }
190
+ /**
191
+ * Records and sets the error status on the given span.
192
+ * If the span is `undefined`, it does nothing.
193
+ */
194
+ declare function setSpanError(span: Span | undefined, error: unknown, options?: SetSpanErrorOptions): void;
195
+ declare function setSpanAttribute(span: Span | undefined, key: string, value: AttributeValue | undefined): void;
196
+ /**
197
+ * Converts an error to an OpenTelemetry Exception.
198
+ */
199
+ declare function toOtelException(error: unknown): Exclude<Exception, string>;
200
+ /**
201
+ * Converts a value to a string suitable for OpenTelemetry span attributes.
202
+ */
203
+ declare function toSpanAttributeValue(data: unknown): string;
204
+ interface RunWithSpanOptions extends SpanOptions, SetSpanErrorOptions {
205
+ /**
206
+ * The name of the span to create.
207
+ */
208
+ name: string;
209
+ /**
210
+ * Context to use for the span.
211
+ */
212
+ context?: Context;
213
+ }
214
+ /**
215
+ * Runs a function within the context of a new OpenTelemetry span.
216
+ * The span is ended automatically, and errors are recorded to the span.
217
+ */
218
+ declare function runWithSpan<T>({ name, context, ...options }: RunWithSpanOptions, fn: (span?: Span) => Promisable<T>): Promise<T>;
219
+ /**
220
+ * Runs a function within the context of an existing OpenTelemetry span.
221
+ */
222
+ declare function runInSpanContext<T>(span: Span | undefined, fn: () => Promisable<T>): Promise<T>;
223
+
137
224
  declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
138
- interface CreateAsyncIteratorObjectCleanupFn {
225
+ interface AsyncIteratorClassNextFn<T, TReturn> {
226
+ (): Promise<IteratorResult<T, TReturn>>;
227
+ }
228
+ interface AsyncIteratorClassCleanupFn {
139
229
  (reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
140
230
  }
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>)[];
231
+ declare const fallbackAsyncDisposeSymbol: unique symbol;
232
+ declare const asyncDisposeSymbol: typeof Symbol extends {
233
+ asyncDispose: infer T;
234
+ } ? T : typeof fallbackAsyncDisposeSymbol;
235
+ declare class AsyncIteratorClass<T, TReturn = unknown, TNext = unknown> implements AsyncIteratorObject<T, TReturn, TNext>, AsyncGenerator<T, TReturn, TNext> {
236
+ #private;
237
+ constructor(next: AsyncIteratorClassNextFn<T, TReturn>, cleanup: AsyncIteratorClassCleanupFn);
238
+ next(): Promise<IteratorResult<T, TReturn>>;
239
+ return(value?: any): Promise<IteratorResult<T, TReturn>>;
240
+ throw(err: any): Promise<IteratorResult<T, TReturn>>;
241
+ /**
242
+ * asyncDispose symbol only available in esnext, we should fallback to Symbol.for('asyncDispose')
243
+ */
244
+ [asyncDisposeSymbol](): Promise<void>;
245
+ [Symbol.asyncIterator](): this;
246
+ }
247
+ declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorClass<T, TReturn, TNext>)[];
248
+ interface AsyncIteratorWithSpanOptions extends SetSpanErrorOptions {
249
+ /**
250
+ * The name of the span to create.
251
+ */
252
+ name: string;
253
+ }
254
+ declare function asyncIteratorWithSpan<T, TReturn, TNext>({ name, ...options }: AsyncIteratorWithSpanOptions, iterator: AsyncIterator<T, TReturn, TNext>): AsyncIteratorClass<T, TReturn, TNext>;
143
255
 
144
256
  declare function parseEmptyableJSON(text: string | null | undefined): unknown;
145
- declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
257
+ declare function stringifyJSON<T>(value: T | {
258
+ toJSON(): T;
259
+ }): undefined extends T ? undefined | string : string;
146
260
 
147
261
  type Segment = string | number;
148
262
  declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
149
263
  maps: Segment[][];
150
264
  values: unknown[];
151
265
  };
266
+ /**
267
+ * Get constructor of the value
268
+ *
269
+ */
270
+ declare function getConstructor(value: unknown): Function | null | undefined;
152
271
  /**
153
272
  * Check if the value is an object even it created by `Object.create(null)` or more tricky way.
154
273
  */
@@ -158,31 +277,59 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
158
277
  */
159
278
  declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
160
279
  declare function clone<T>(value: T): T;
161
- declare function get(object: object, path: readonly string[]): unknown;
280
+ declare function get(object: unknown, path: readonly string[]): unknown;
162
281
  declare function isPropertyKey(value: unknown): value is PropertyKey;
163
282
  declare const NullProtoObj: ({
164
283
  new <T extends Record<PropertyKey, unknown>>(): T;
165
284
  });
166
285
 
286
+ type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
287
+ declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
288
+ /**
289
+ * Returns the value if it is defined, otherwise returns the fallback
290
+ */
291
+ declare function fallback<T>(value: T | undefined, fallback: T): T;
292
+
293
+ /**
294
+ * Prevents objects from being awaitable by intercepting the `then` method
295
+ * when called by the native await mechanism. This is useful for preventing
296
+ * accidental awaiting of objects that aren't meant to be promises.
297
+ */
298
+ declare function preventNativeAwait<T extends object>(target: T): T;
299
+ /**
300
+ * Create a proxy that overlays one object (`overlay`) on top of another (`target`).
301
+ *
302
+ * - Properties from `overlay` take precedence.
303
+ * - Properties not in `overlay` fall back to `target`.
304
+ * - Methods from either object are bound to `overlay` so `this` is consistent.
305
+ *
306
+ * Useful when you want to override or extend behavior without fully copying/merging objects.
307
+ */
308
+ declare function overlayProxy<T extends object, U extends object>(target: Value<T>, partial: U): U & Omit<T, keyof U>;
309
+
167
310
  interface AsyncIdQueueCloseOptions {
168
- id?: number;
311
+ id?: string;
169
312
  reason?: unknown;
170
313
  }
171
314
  declare class AsyncIdQueue<T> {
172
315
  private readonly openIds;
173
- private readonly items;
174
- private readonly pendingPulls;
316
+ private readonly queues;
317
+ private readonly waiters;
175
318
  get length(): number;
176
- open(id: number): void;
177
- isOpen(id: number): boolean;
178
- push(id: number, item: T): void;
179
- pull(id: number): Promise<T>;
319
+ get waiterIds(): string[];
320
+ hasBufferedItems(id: string): boolean;
321
+ open(id: string): void;
322
+ isOpen(id: string): boolean;
323
+ push(id: string, item: T): void;
324
+ pull(id: string): Promise<T>;
180
325
  close({ id, reason }?: AsyncIdQueueCloseOptions): void;
181
- assertOpen(id: number): void;
326
+ assertOpen(id: string): void;
182
327
  }
183
328
 
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;
329
+ declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
330
+ declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
331
+
332
+ declare function tryDecodeURIComponent(value: string): string;
186
333
 
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 };
334
+ export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, 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 };
335
+ 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] ?? {};
@@ -12,6 +12,24 @@ function splitInHalf(arr) {
12
12
  return [arr.slice(0, half), arr.slice(half)];
13
13
  }
14
14
 
15
+ function readAsBuffer(source) {
16
+ if (typeof source.bytes === "function") {
17
+ return source.bytes();
18
+ }
19
+ return source.arrayBuffer();
20
+ }
21
+
22
+ const ORPC_NAME = "orpc";
23
+ const ORPC_SHARED_PACKAGE_NAME = "@orpc/shared";
24
+ const ORPC_SHARED_PACKAGE_VERSION = "0.0.0-next.f7af1c4";
25
+
26
+ class AbortError extends Error {
27
+ constructor(...rest) {
28
+ super(...rest);
29
+ this.name = "AbortError";
30
+ }
31
+ }
32
+
15
33
  function once(fn) {
16
34
  let cached;
17
35
  return () => {
@@ -40,13 +58,112 @@ function defer(callback) {
40
58
  }
41
59
  }
42
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
+
43
154
  class AsyncIdQueue {
44
155
  openIds = /* @__PURE__ */ new Set();
45
- items = /* @__PURE__ */ new Map();
46
- pendingPulls = /* @__PURE__ */ new Map();
156
+ queues = /* @__PURE__ */ new Map();
157
+ waiters = /* @__PURE__ */ new Map();
47
158
  get length() {
48
159
  return this.openIds.size;
49
160
  }
161
+ get waiterIds() {
162
+ return Array.from(this.waiters.keys());
163
+ }
164
+ hasBufferedItems(id) {
165
+ return Boolean(this.queues.get(id)?.length);
166
+ }
50
167
  open(id) {
51
168
  this.openIds.add(id);
52
169
  }
@@ -55,59 +172,57 @@ class AsyncIdQueue {
55
172
  }
56
173
  push(id, item) {
57
174
  this.assertOpen(id);
58
- const pending = this.pendingPulls.get(id);
175
+ const pending = this.waiters.get(id);
59
176
  if (pending?.length) {
60
177
  pending.shift()[0](item);
61
178
  if (pending.length === 0) {
62
- this.pendingPulls.delete(id);
179
+ this.waiters.delete(id);
63
180
  }
64
181
  } else {
65
- const items = this.items.get(id);
182
+ const items = this.queues.get(id);
66
183
  if (items) {
67
184
  items.push(item);
68
185
  } else {
69
- this.items.set(id, [item]);
186
+ this.queues.set(id, [item]);
70
187
  }
71
188
  }
72
189
  }
73
190
  async pull(id) {
74
191
  this.assertOpen(id);
75
- const items = this.items.get(id);
192
+ const items = this.queues.get(id);
76
193
  if (items?.length) {
77
194
  const item = items.shift();
78
195
  if (items.length === 0) {
79
- this.items.delete(id);
196
+ this.queues.delete(id);
80
197
  }
81
198
  return item;
82
199
  }
83
200
  return new Promise((resolve, reject) => {
84
- const waitingPulls = this.pendingPulls.get(id);
201
+ const waitingPulls = this.waiters.get(id);
85
202
  const pending = [resolve, reject];
86
203
  if (waitingPulls) {
87
204
  waitingPulls.push(pending);
88
205
  } else {
89
- this.pendingPulls.set(id, [pending]);
206
+ this.waiters.set(id, [pending]);
90
207
  }
91
208
  });
92
209
  }
93
210
  close({ id, reason } = {}) {
94
211
  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
- });
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));
99
215
  });
100
- this.pendingPulls.clear();
216
+ this.waiters.clear();
101
217
  this.openIds.clear();
102
- this.items.clear();
218
+ this.queues.clear();
103
219
  return;
104
220
  }
105
- this.pendingPulls.get(id)?.forEach(([, reject]) => {
106
- reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`));
107
- });
108
- 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);
109
224
  this.openIds.delete(id);
110
- this.items.delete(id);
225
+ this.queues.delete(id);
111
226
  }
112
227
  assertOpen(id) {
113
228
  if (!this.isOpen(id)) {
@@ -120,111 +235,148 @@ function isAsyncIteratorObject(maybe) {
120
235
  if (!maybe || typeof maybe !== "object") {
121
236
  return false;
122
237
  }
123
- return Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
238
+ return "next" in maybe && typeof maybe.next === "function" && Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
124
239
  }
125
- function createAsyncIteratorObject(next, cleanup) {
126
- let isExecuteComplete = false;
127
- let isDone = false;
128
- const iterator = {
129
- next: sequential(async () => {
130
- if (isDone) {
240
+ const fallbackAsyncDisposeSymbol = Symbol.for("asyncDispose");
241
+ const asyncDisposeSymbol = Symbol.asyncDispose ?? fallbackAsyncDisposeSymbol;
242
+ class AsyncIteratorClass {
243
+ #isDone = false;
244
+ #isExecuteComplete = false;
245
+ #cleanup;
246
+ #next;
247
+ constructor(next, cleanup) {
248
+ this.#cleanup = cleanup;
249
+ this.#next = sequential(async () => {
250
+ if (this.#isDone) {
131
251
  return { done: true, value: void 0 };
132
252
  }
133
253
  try {
134
254
  const result = await next();
135
255
  if (result.done) {
136
- isDone = true;
256
+ this.#isDone = true;
137
257
  }
138
258
  return result;
139
259
  } catch (err) {
140
- isDone = true;
260
+ this.#isDone = true;
141
261
  throw err;
142
262
  } finally {
143
- if (isDone && !isExecuteComplete) {
144
- isExecuteComplete = true;
145
- await cleanup("next");
263
+ if (this.#isDone && !this.#isExecuteComplete) {
264
+ this.#isExecuteComplete = true;
265
+ await this.#cleanup("next");
146
266
  }
147
267
  }
148
- }),
149
- async return(value) {
150
- isDone = true;
151
- if (!isExecuteComplete) {
152
- isExecuteComplete = true;
153
- await cleanup("return");
154
- }
155
- return { done: true, value };
156
- },
157
- async throw(err) {
158
- isDone = true;
159
- if (!isExecuteComplete) {
160
- isExecuteComplete = true;
161
- await cleanup("throw");
162
- }
163
- throw err;
164
- },
165
- /**
166
- * asyncDispose symbol only available in esnext, we should fallback to Symbol.for('asyncDispose')
167
- */
168
- async [Symbol.asyncDispose ?? Symbol.for("asyncDispose")]() {
169
- isDone = true;
170
- if (!isExecuteComplete) {
171
- isExecuteComplete = true;
172
- await cleanup("dispose");
173
- }
174
- },
175
- [Symbol.asyncIterator]() {
176
- return iterator;
268
+ });
269
+ }
270
+ next() {
271
+ return this.#next();
272
+ }
273
+ async return(value) {
274
+ this.#isDone = true;
275
+ if (!this.#isExecuteComplete) {
276
+ this.#isExecuteComplete = true;
277
+ await this.#cleanup("return");
177
278
  }
178
- };
179
- return iterator;
279
+ return { done: true, value };
280
+ }
281
+ async throw(err) {
282
+ this.#isDone = true;
283
+ if (!this.#isExecuteComplete) {
284
+ this.#isExecuteComplete = true;
285
+ await this.#cleanup("throw");
286
+ }
287
+ throw err;
288
+ }
289
+ /**
290
+ * asyncDispose symbol only available in esnext, we should fallback to Symbol.for('asyncDispose')
291
+ */
292
+ async [asyncDisposeSymbol]() {
293
+ this.#isDone = true;
294
+ if (!this.#isExecuteComplete) {
295
+ this.#isExecuteComplete = true;
296
+ await this.#cleanup("dispose");
297
+ }
298
+ }
299
+ [Symbol.asyncIterator]() {
300
+ return this;
301
+ }
180
302
  }
181
303
  function replicateAsyncIterator(source, count) {
182
304
  const queue = new AsyncIdQueue();
183
- const replicated = [];
184
- let error;
305
+ const ids = Array.from({ length: count }, (_, i) => i.toString());
306
+ let isSourceFinished = false;
185
307
  const start = once(async () => {
186
308
  try {
187
309
  while (true) {
188
310
  const item = await source.next();
189
- for (let id = 0; id < count; id++) {
311
+ ids.forEach((id) => {
190
312
  if (queue.isOpen(id)) {
191
- queue.push(id, item);
313
+ queue.push(id, { next: item });
192
314
  }
193
- }
315
+ });
194
316
  if (item.done) {
195
317
  break;
196
318
  }
197
319
  }
198
- } catch (e) {
199
- error = { value: e };
320
+ } catch (error) {
321
+ ids.forEach((id) => {
322
+ if (queue.isOpen(id)) {
323
+ queue.push(id, { error });
324
+ }
325
+ });
326
+ } finally {
327
+ isSourceFinished = true;
200
328
  }
201
329
  });
202
- for (let id = 0; id < count; id++) {
330
+ const replicated = ids.map((id) => {
203
331
  queue.open(id);
204
- replicated.push(createAsyncIteratorObject(
205
- () => {
332
+ return new AsyncIteratorClass(
333
+ async () => {
206
334
  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
- });
335
+ const item = await queue.pull(id);
336
+ if (item.next) {
337
+ return item.next;
338
+ }
339
+ throw item.error;
215
340
  },
216
341
  async (reason) => {
217
342
  queue.close({ id });
218
- if (reason !== "next") {
219
- if (replicated.every((_, id2) => !queue.isOpen(id2))) {
220
- await source?.return?.();
221
- }
343
+ if (reason !== "next" && !queue.length && !isSourceFinished) {
344
+ isSourceFinished = true;
345
+ await source?.return?.();
222
346
  }
223
347
  }
224
- ));
225
- }
348
+ );
349
+ });
226
350
  return replicated;
227
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
+ }
228
380
 
229
381
  class EventPublisher {
230
382
  #listenersMap = /* @__PURE__ */ new Map();
@@ -263,6 +415,7 @@ class EventPublisher {
263
415
  }
264
416
  const signal = listenerOrOptions?.signal;
265
417
  const maxBufferedEvents = listenerOrOptions?.maxBufferedEvents ?? this.#maxBufferedEvents;
418
+ signal?.throwIfAborted();
266
419
  const bufferedEvents = [];
267
420
  const pullResolvers = [];
268
421
  const unsubscribe = this.subscribe(event, (payload) => {
@@ -283,7 +436,7 @@ class EventPublisher {
283
436
  bufferedEvents.length = 0;
284
437
  };
285
438
  signal?.addEventListener("abort", abortListener, { once: true });
286
- return createAsyncIteratorObject(async () => {
439
+ return new AsyncIteratorClass(async () => {
287
440
  if (signal?.aborted) {
288
441
  throw signal.reason;
289
442
  }
@@ -304,13 +457,11 @@ class EventPublisher {
304
457
  }
305
458
 
306
459
  class SequentialIdGenerator {
307
- nextId = 0;
460
+ index = BigInt(0);
308
461
  generate() {
309
- if (this.nextId === Number.MAX_SAFE_INTEGER) {
310
- this.nextId = 0;
311
- return Number.MAX_SAFE_INTEGER;
312
- }
313
- return this.nextId++;
462
+ const id = this.index.toString(32);
463
+ this.index++;
464
+ return id;
314
465
  }
315
466
  }
316
467
 
@@ -391,6 +542,12 @@ function findDeepMatches(check, payload, segments = [], maps = [], values = [])
391
542
  }
392
543
  return { maps, values };
393
544
  }
545
+ function getConstructor(value) {
546
+ if (!isTypescriptObject(value)) {
547
+ return null;
548
+ }
549
+ return Object.getPrototypeOf(value)?.constructor;
550
+ }
394
551
  function isObject(value) {
395
552
  if (!value || typeof value !== "object") {
396
553
  return false;
@@ -442,5 +599,88 @@ function value(value2, ...args) {
442
599
  }
443
600
  return value2;
444
601
  }
602
+ function fallback(value2, fallback2) {
603
+ return value2 === void 0 ? fallback2 : value2;
604
+ }
605
+
606
+ function preventNativeAwait(target) {
607
+ return new Proxy(target, {
608
+ get(target2, prop, receiver) {
609
+ const value2 = Reflect.get(target2, prop, receiver);
610
+ if (prop !== "then" || typeof value2 !== "function") {
611
+ return value2;
612
+ }
613
+ return new Proxy(value2, {
614
+ apply(targetFn, thisArg, args) {
615
+ if (args.length !== 2 || args.some((arg) => !isNativeFunction(arg))) {
616
+ return Reflect.apply(targetFn, thisArg, args);
617
+ }
618
+ let shouldOmit = true;
619
+ args[0].call(thisArg, preventNativeAwait(new Proxy(target2, {
620
+ get: (target3, prop2, receiver2) => {
621
+ if (shouldOmit && prop2 === "then") {
622
+ shouldOmit = false;
623
+ return void 0;
624
+ }
625
+ return Reflect.get(target3, prop2, receiver2);
626
+ }
627
+ })));
628
+ }
629
+ });
630
+ }
631
+ });
632
+ }
633
+ const NATIVE_FUNCTION_REGEX = /^\s*function\s*\(\)\s*\{\s*\[native code\]\s*\}\s*$/;
634
+ function isNativeFunction(fn) {
635
+ return typeof fn === "function" && NATIVE_FUNCTION_REGEX.test(fn.toString());
636
+ }
637
+ function overlayProxy(target, partial) {
638
+ const proxy = new Proxy(typeof target === "function" ? partial : target, {
639
+ get(_, prop) {
640
+ const targetValue = prop in partial ? partial : value(target);
641
+ const v = Reflect.get(targetValue, prop);
642
+ return typeof v === "function" ? v.bind(targetValue) : v;
643
+ },
644
+ has(_, prop) {
645
+ return Reflect.has(partial, prop) || Reflect.has(value(target), prop);
646
+ }
647
+ });
648
+ return proxy;
649
+ }
650
+
651
+ function streamToAsyncIteratorClass(stream) {
652
+ const reader = stream.getReader();
653
+ return new AsyncIteratorClass(
654
+ async () => {
655
+ return reader.read();
656
+ },
657
+ async () => {
658
+ await reader.cancel();
659
+ }
660
+ );
661
+ }
662
+ function asyncIteratorToStream(iterator) {
663
+ return new ReadableStream({
664
+ async pull(controller) {
665
+ const { done, value } = await iterator.next();
666
+ if (done) {
667
+ controller.close();
668
+ } else {
669
+ controller.enqueue(value);
670
+ }
671
+ },
672
+ async cancel() {
673
+ await iterator.return?.();
674
+ }
675
+ });
676
+ }
677
+
678
+ function tryDecodeURIComponent(value) {
679
+ try {
680
+ return decodeURIComponent(value);
681
+ } catch {
682
+ return value;
683
+ }
684
+ }
445
685
 
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 };
686
+ export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, 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.f779f69",
4
+ "version": "0.0.0-next.f7af1c4",
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
- "radash": "^12.1.0",
28
- "type-fest": "^4.39.1"
35
+ "radash": "^12.1.1",
36
+ "type-fest": "^5.0.1"
29
37
  },
30
38
  "devDependencies": {
31
- "arktype": "2.1.20",
39
+ "@opentelemetry/api": "^1.9.0",
40
+ "arktype": "2.1.22",
32
41
  "valibot": "^1.1.0",
33
- "zod": "^3.25.49"
42
+ "zod": "^4.1.11"
34
43
  },
35
44
  "scripts": {
36
45
  "build": "unbuild",