@orpc/shared 0.0.0-next.de766b3 → 0.0.0-next.dea79a3

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), 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
 
@@ -55,6 +50,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
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
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.
58
54
  - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
59
55
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
60
56
  - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
package/dist/index.d.mts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { Promisable } from 'type-fest';
2
- export { IsEqual, IsNever, PartialDeep, Promisable } from 'type-fest';
2
+ export { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
3
+ import { Tracer, TraceAPI, ContextAPI, PropagationAPI, SpanOptions, Context, Span, AttributeValue, Exception } from '@opentelemetry/api';
3
4
  export { group, guard, mapEntries, mapValues, omit } from 'radash';
4
5
 
5
6
  type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
@@ -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.dea79a3";
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.
@@ -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>>;
@@ -134,6 +154,72 @@ declare function onFinish<T, TOptions extends {
134
154
  }, 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
155
  declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
136
156
 
157
+ /**
158
+ * Only import types from @opentelemetry/api to avoid runtime dependencies.
159
+ */
160
+
161
+ interface OtelConfig {
162
+ tracer: Tracer;
163
+ trace: TraceAPI;
164
+ context: ContextAPI;
165
+ propagation: PropagationAPI;
166
+ }
167
+ /**
168
+ * Sets the global OpenTelemetry config.
169
+ * Call this once at app startup. Use `undefined` to disable tracing.
170
+ */
171
+ declare function setGlobalOtelConfig(config: OtelConfig | undefined): void;
172
+ /**
173
+ * Gets the global OpenTelemetry config.
174
+ * Returns `undefined` if OpenTelemetry is not configured, initialized, or enabled.
175
+ */
176
+ declare function getGlobalOtelConfig(): OtelConfig | undefined;
177
+ /**
178
+ * Starts a new OpenTelemetry span with the given name and options.
179
+ *
180
+ * @returns The new span, or `undefined` if no tracer is set.
181
+ */
182
+ declare function startSpan(name: string, options?: SpanOptions, context?: Context): Span | undefined;
183
+ interface SetSpanErrorOptions {
184
+ /**
185
+ * Span error status is not set if error is due to cancellation by the signal.
186
+ */
187
+ signal?: AbortSignal;
188
+ }
189
+ /**
190
+ * Records and sets the error status on the given span.
191
+ * If the span is `undefined`, it does nothing.
192
+ */
193
+ declare function setSpanError(span: Span | undefined, error: unknown, options?: SetSpanErrorOptions): void;
194
+ declare function setSpanAttribute(span: Span | undefined, key: string, value: AttributeValue | undefined): void;
195
+ /**
196
+ * Converts an error to an OpenTelemetry Exception.
197
+ */
198
+ declare function toOtelException(error: unknown): Exclude<Exception, string>;
199
+ /**
200
+ * Converts a value to a string suitable for OpenTelemetry span attributes.
201
+ */
202
+ declare function toSpanAttributeValue(data: unknown): string;
203
+ interface RunWithSpanOptions extends SpanOptions, SetSpanErrorOptions {
204
+ /**
205
+ * The name of the span to create.
206
+ */
207
+ name: string;
208
+ /**
209
+ * Context to use for the span.
210
+ */
211
+ context?: Context;
212
+ }
213
+ /**
214
+ * Runs a function within the context of a new OpenTelemetry span.
215
+ * The span is ended automatically, and errors are recorded to the span.
216
+ */
217
+ declare function runWithSpan<T>({ name, context, ...options }: RunWithSpanOptions, fn: (span?: Span) => Promisable<T>): Promise<T>;
218
+ /**
219
+ * Runs a function within the context of an existing OpenTelemetry span.
220
+ */
221
+ declare function runInSpanContext<T>(span: Span | undefined, fn: () => Promisable<T>): Promise<T>;
222
+
137
223
  declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
138
224
  interface AsyncIteratorClassNextFn<T, TReturn> {
139
225
  (): Promise<IteratorResult<T, TReturn>>;
@@ -158,9 +244,18 @@ declare class AsyncIteratorClass<T, TReturn = unknown, TNext = unknown> implemen
158
244
  [Symbol.asyncIterator](): this;
159
245
  }
160
246
  declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorClass<T, TReturn, TNext>)[];
247
+ interface AsyncIteratorWithSpanOptions extends SetSpanErrorOptions {
248
+ /**
249
+ * The name of the span to create.
250
+ */
251
+ name: string;
252
+ }
253
+ declare function asyncIteratorWithSpan<T, TReturn, TNext>({ name, ...options }: AsyncIteratorWithSpanOptions, iterator: AsyncIterator<T, TReturn, TNext>): AsyncIteratorClass<T, TReturn, TNext>;
161
254
 
162
255
  declare function parseEmptyableJSON(text: string | null | undefined): unknown;
163
- declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
256
+ declare function stringifyJSON<T>(value: T | {
257
+ toJSON(): T;
258
+ }): undefined extends T ? undefined | string : string;
164
259
 
165
260
  type Segment = string | number;
166
261
  declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
@@ -176,14 +271,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
176
271
  */
177
272
  declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
178
273
  declare function clone<T>(value: T): T;
179
- declare function get(object: object, path: readonly string[]): unknown;
274
+ declare function get(object: unknown, path: readonly string[]): unknown;
180
275
  declare function isPropertyKey(value: unknown): value is PropertyKey;
181
276
  declare const NullProtoObj: ({
182
277
  new <T extends Record<PropertyKey, unknown>>(): T;
183
278
  });
184
279
 
185
280
  interface AsyncIdQueueCloseOptions {
186
- id?: number;
281
+ id?: string;
187
282
  reason?: unknown;
188
283
  }
189
284
  declare class AsyncIdQueue<T> {
@@ -191,16 +286,21 @@ declare class AsyncIdQueue<T> {
191
286
  private readonly items;
192
287
  private readonly pendingPulls;
193
288
  get length(): number;
194
- open(id: number): void;
195
- isOpen(id: number): boolean;
196
- push(id: number, item: T): void;
197
- pull(id: number): Promise<T>;
289
+ open(id: string): void;
290
+ isOpen(id: string): boolean;
291
+ push(id: string, item: T): void;
292
+ pull(id: string): Promise<T>;
198
293
  close({ id, reason }?: AsyncIdQueueCloseOptions): void;
199
- assertOpen(id: number): void;
294
+ assertOpen(id: string): void;
200
295
  }
201
296
 
297
+ declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
298
+ declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
299
+
300
+ declare function tryDecodeURIComponent(value: string): string;
301
+
202
302
  type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
203
303
  declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
204
304
 
205
- export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
206
- export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
305
+ export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
306
+ export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import { Promisable } from 'type-fest';
2
- export { IsEqual, IsNever, PartialDeep, Promisable } from 'type-fest';
2
+ export { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
3
+ import { Tracer, TraceAPI, ContextAPI, PropagationAPI, SpanOptions, Context, Span, AttributeValue, Exception } from '@opentelemetry/api';
3
4
  export { group, guard, mapEntries, mapValues, omit } from 'radash';
4
5
 
5
6
  type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
@@ -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.dea79a3";
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.
@@ -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>>;
@@ -134,6 +154,72 @@ declare function onFinish<T, TOptions extends {
134
154
  }, 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
155
  declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
136
156
 
157
+ /**
158
+ * Only import types from @opentelemetry/api to avoid runtime dependencies.
159
+ */
160
+
161
+ interface OtelConfig {
162
+ tracer: Tracer;
163
+ trace: TraceAPI;
164
+ context: ContextAPI;
165
+ propagation: PropagationAPI;
166
+ }
167
+ /**
168
+ * Sets the global OpenTelemetry config.
169
+ * Call this once at app startup. Use `undefined` to disable tracing.
170
+ */
171
+ declare function setGlobalOtelConfig(config: OtelConfig | undefined): void;
172
+ /**
173
+ * Gets the global OpenTelemetry config.
174
+ * Returns `undefined` if OpenTelemetry is not configured, initialized, or enabled.
175
+ */
176
+ declare function getGlobalOtelConfig(): OtelConfig | undefined;
177
+ /**
178
+ * Starts a new OpenTelemetry span with the given name and options.
179
+ *
180
+ * @returns The new span, or `undefined` if no tracer is set.
181
+ */
182
+ declare function startSpan(name: string, options?: SpanOptions, context?: Context): Span | undefined;
183
+ interface SetSpanErrorOptions {
184
+ /**
185
+ * Span error status is not set if error is due to cancellation by the signal.
186
+ */
187
+ signal?: AbortSignal;
188
+ }
189
+ /**
190
+ * Records and sets the error status on the given span.
191
+ * If the span is `undefined`, it does nothing.
192
+ */
193
+ declare function setSpanError(span: Span | undefined, error: unknown, options?: SetSpanErrorOptions): void;
194
+ declare function setSpanAttribute(span: Span | undefined, key: string, value: AttributeValue | undefined): void;
195
+ /**
196
+ * Converts an error to an OpenTelemetry Exception.
197
+ */
198
+ declare function toOtelException(error: unknown): Exclude<Exception, string>;
199
+ /**
200
+ * Converts a value to a string suitable for OpenTelemetry span attributes.
201
+ */
202
+ declare function toSpanAttributeValue(data: unknown): string;
203
+ interface RunWithSpanOptions extends SpanOptions, SetSpanErrorOptions {
204
+ /**
205
+ * The name of the span to create.
206
+ */
207
+ name: string;
208
+ /**
209
+ * Context to use for the span.
210
+ */
211
+ context?: Context;
212
+ }
213
+ /**
214
+ * Runs a function within the context of a new OpenTelemetry span.
215
+ * The span is ended automatically, and errors are recorded to the span.
216
+ */
217
+ declare function runWithSpan<T>({ name, context, ...options }: RunWithSpanOptions, fn: (span?: Span) => Promisable<T>): Promise<T>;
218
+ /**
219
+ * Runs a function within the context of an existing OpenTelemetry span.
220
+ */
221
+ declare function runInSpanContext<T>(span: Span | undefined, fn: () => Promisable<T>): Promise<T>;
222
+
137
223
  declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
138
224
  interface AsyncIteratorClassNextFn<T, TReturn> {
139
225
  (): Promise<IteratorResult<T, TReturn>>;
@@ -158,9 +244,18 @@ declare class AsyncIteratorClass<T, TReturn = unknown, TNext = unknown> implemen
158
244
  [Symbol.asyncIterator](): this;
159
245
  }
160
246
  declare function replicateAsyncIterator<T, TReturn, TNext>(source: AsyncIterator<T, TReturn, TNext>, count: number): (AsyncIteratorClass<T, TReturn, TNext>)[];
247
+ interface AsyncIteratorWithSpanOptions extends SetSpanErrorOptions {
248
+ /**
249
+ * The name of the span to create.
250
+ */
251
+ name: string;
252
+ }
253
+ declare function asyncIteratorWithSpan<T, TReturn, TNext>({ name, ...options }: AsyncIteratorWithSpanOptions, iterator: AsyncIterator<T, TReturn, TNext>): AsyncIteratorClass<T, TReturn, TNext>;
161
254
 
162
255
  declare function parseEmptyableJSON(text: string | null | undefined): unknown;
163
- declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
256
+ declare function stringifyJSON<T>(value: T | {
257
+ toJSON(): T;
258
+ }): undefined extends T ? undefined | string : string;
164
259
 
165
260
  type Segment = string | number;
166
261
  declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
@@ -176,14 +271,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
176
271
  */
177
272
  declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
178
273
  declare function clone<T>(value: T): T;
179
- declare function get(object: object, path: readonly string[]): unknown;
274
+ declare function get(object: unknown, path: readonly string[]): unknown;
180
275
  declare function isPropertyKey(value: unknown): value is PropertyKey;
181
276
  declare const NullProtoObj: ({
182
277
  new <T extends Record<PropertyKey, unknown>>(): T;
183
278
  });
184
279
 
185
280
  interface AsyncIdQueueCloseOptions {
186
- id?: number;
281
+ id?: string;
187
282
  reason?: unknown;
188
283
  }
189
284
  declare class AsyncIdQueue<T> {
@@ -191,16 +286,21 @@ declare class AsyncIdQueue<T> {
191
286
  private readonly items;
192
287
  private readonly pendingPulls;
193
288
  get length(): number;
194
- open(id: number): void;
195
- isOpen(id: number): boolean;
196
- push(id: number, item: T): void;
197
- pull(id: number): Promise<T>;
289
+ open(id: string): void;
290
+ isOpen(id: string): boolean;
291
+ push(id: string, item: T): void;
292
+ pull(id: string): Promise<T>;
198
293
  close({ id, reason }?: AsyncIdQueueCloseOptions): void;
199
- assertOpen(id: number): void;
294
+ assertOpen(id: string): void;
200
295
  }
201
296
 
297
+ declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
298
+ declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
299
+
300
+ declare function tryDecodeURIComponent(value: string): string;
301
+
202
302
  type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
203
303
  declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
204
304
 
205
- export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
206
- export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
305
+ export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
306
+ export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, AsyncIteratorWithSpanOptions, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, OtelConfig, PromiseWithError, Registry, RunWithSpanOptions, Segment, SetOptional, SetSpanErrorOptions, ThrowableError, Value };
package/dist/index.mjs CHANGED
@@ -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.dea79a3";
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,6 +58,99 @@ 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
156
  items = /* @__PURE__ */ new Map();
@@ -120,7 +231,7 @@ function isAsyncIteratorObject(maybe) {
120
231
  if (!maybe || typeof maybe !== "object") {
121
232
  return false;
122
233
  }
123
- return Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
234
+ return "next" in maybe && typeof maybe.next === "function" && Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
124
235
  }
125
236
  const fallbackAsyncDisposeSymbol = Symbol.for("asyncDispose");
126
237
  const asyncDisposeSymbol = Symbol.asyncDispose ?? fallbackAsyncDisposeSymbol;
@@ -194,8 +305,8 @@ function replicateAsyncIterator(source, count) {
194
305
  while (true) {
195
306
  const item = await source.next();
196
307
  for (let id = 0; id < count; id++) {
197
- if (queue.isOpen(id)) {
198
- queue.push(id, item);
308
+ if (queue.isOpen(id.toString())) {
309
+ queue.push(id.toString(), item);
199
310
  }
200
311
  }
201
312
  if (item.done) {
@@ -207,12 +318,12 @@ function replicateAsyncIterator(source, count) {
207
318
  }
208
319
  });
209
320
  for (let id = 0; id < count; id++) {
210
- queue.open(id);
321
+ queue.open(id.toString());
211
322
  replicated.push(new AsyncIteratorClass(
212
323
  () => {
213
324
  start();
214
325
  return new Promise((resolve, reject) => {
215
- queue.pull(id).then(resolve).catch(reject);
326
+ queue.pull(id.toString()).then(resolve).catch(reject);
216
327
  defer(() => {
217
328
  if (error) {
218
329
  reject(error.value);
@@ -221,9 +332,9 @@ function replicateAsyncIterator(source, count) {
221
332
  });
222
333
  },
223
334
  async (reason) => {
224
- queue.close({ id });
335
+ queue.close({ id: id.toString() });
225
336
  if (reason !== "next") {
226
- if (replicated.every((_, id2) => !queue.isOpen(id2))) {
337
+ if (replicated.every((_, id2) => !queue.isOpen(id2.toString()))) {
227
338
  await source?.return?.();
228
339
  }
229
340
  }
@@ -232,6 +343,34 @@ function replicateAsyncIterator(source, count) {
232
343
  }
233
344
  return replicated;
234
345
  }
346
+ function asyncIteratorWithSpan({ name, ...options }, iterator) {
347
+ let span;
348
+ return new AsyncIteratorClass(
349
+ async () => {
350
+ span ??= startSpan(name);
351
+ try {
352
+ const result = await runInSpanContext(span, () => iterator.next());
353
+ span?.addEvent(result.done ? "completed" : "yielded");
354
+ return result;
355
+ } catch (err) {
356
+ setSpanError(span, err, options);
357
+ throw err;
358
+ }
359
+ },
360
+ async (reason) => {
361
+ try {
362
+ if (reason !== "next") {
363
+ await runInSpanContext(span, () => iterator.return?.());
364
+ }
365
+ } catch (err) {
366
+ setSpanError(span, err, options);
367
+ throw err;
368
+ } finally {
369
+ span?.end();
370
+ }
371
+ }
372
+ );
373
+ }
235
374
 
236
375
  class EventPublisher {
237
376
  #listenersMap = /* @__PURE__ */ new Map();
@@ -312,13 +451,11 @@ class EventPublisher {
312
451
  }
313
452
 
314
453
  class SequentialIdGenerator {
315
- nextId = 0;
454
+ index = BigInt(0);
316
455
  generate() {
317
- if (this.nextId === Number.MAX_SAFE_INTEGER) {
318
- this.nextId = 0;
319
- return Number.MAX_SAFE_INTEGER;
320
- }
321
- return this.nextId++;
456
+ const id = this.index.toString(32);
457
+ this.index++;
458
+ return id;
322
459
  }
323
460
  }
324
461
 
@@ -444,6 +581,41 @@ const NullProtoObj = /* @__PURE__ */ (() => {
444
581
  return e;
445
582
  })();
446
583
 
584
+ function streamToAsyncIteratorClass(stream) {
585
+ const reader = stream.getReader();
586
+ return new AsyncIteratorClass(
587
+ async () => {
588
+ return reader.read();
589
+ },
590
+ async () => {
591
+ await reader.cancel();
592
+ }
593
+ );
594
+ }
595
+ function asyncIteratorToStream(iterator) {
596
+ return new ReadableStream({
597
+ async pull(controller) {
598
+ const { done, value } = await iterator.next();
599
+ if (done) {
600
+ controller.close();
601
+ } else {
602
+ controller.enqueue(value);
603
+ }
604
+ },
605
+ async cancel() {
606
+ await iterator.return?.();
607
+ }
608
+ });
609
+ }
610
+
611
+ function tryDecodeURIComponent(value) {
612
+ try {
613
+ return decodeURIComponent(value);
614
+ } catch {
615
+ return value;
616
+ }
617
+ }
618
+
447
619
  function value(value2, ...args) {
448
620
  if (typeof value2 === "function") {
449
621
  return value2(...args);
@@ -451,4 +623,4 @@ function value(value2, ...args) {
451
623
  return value2;
452
624
  }
453
625
 
454
- export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, stringifyJSON, toArray, value };
626
+ export { AbortError, AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, ORPC_NAME, ORPC_SHARED_PACKAGE_NAME, ORPC_SHARED_PACKAGE_VERSION, SequentialIdGenerator, asyncIteratorToStream, asyncIteratorWithSpan, clone, defer, findDeepMatches, get, getGlobalOtelConfig, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, 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.de766b3",
4
+ "version": "0.0.0-next.dea79a3",
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",
35
+ "radash": "^12.1.1",
28
36
  "type-fest": "^4.39.1"
29
37
  },
30
38
  "devDependencies": {
39
+ "@opentelemetry/api": "^1.9.0",
31
40
  "arktype": "2.1.20",
32
41
  "valibot": "^1.1.0",
33
- "zod": "^3.25.49"
42
+ "zod": "^4.0.17"
34
43
  },
35
44
  "scripts": {
36
45
  "build": "unbuild",