@orpc/shared 0.0.0-next.ee46dab → 0.0.0-next.ee89076

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>
@@ -26,28 +21,24 @@
26
21
 
27
22
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
28
23
 
29
- **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
24
+ **oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
30
25
 
31
26
  ---
32
27
 
33
28
  ## Highlights
34
29
 
35
- - **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
36
- - **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
37
- - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
38
- - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
39
- - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
40
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
41
- - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
42
- - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
43
- - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
44
- - **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
45
- - **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
46
- - **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
47
- - **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
48
- - **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
49
- - **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
50
- - **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
30
+ - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
+ - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
+ - **📝 Contract-First Development**: Optionally define your API contract before implementation.
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.
35
+ - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
36
+ - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
37
+ - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
38
+ - **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
39
+ - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
40
+ - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
41
+ - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
51
42
 
52
43
  ## Documentation
53
44
 
@@ -58,13 +49,14 @@ You can find the full documentation [here](https://orpc.unnoq.com).
58
49
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
59
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
60
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
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/).
61
55
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
62
- - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
63
- - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
64
- - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
65
- - [@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.
66
58
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
67
- - [@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.
68
60
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
69
61
  - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
70
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,19 +1,109 @@
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];
6
7
  declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>): T;
7
8
 
8
- declare function toArray<T>(value: T | T[] | null | undefined): T[];
9
+ declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
10
+ declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
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>;
9
18
 
10
19
  type AnyFunction = (...args: any[]) => any;
11
20
  declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
21
+ declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
22
+ /**
23
+ * Executes the callback function after the current call stack has been cleared.
24
+ */
25
+ declare function defer(callback: () => void): void;
12
26
 
13
27
  type OmitChainMethodDeep<T extends object, K extends keyof any> = {
14
28
  [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
15
29
  };
16
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.ee89076";
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
+
43
+ interface EventPublisherOptions {
44
+ /**
45
+ * Maximum number of events to buffer for async iterator subscribers.
46
+ *
47
+ * If the buffer exceeds this limit, the oldest event is dropped.
48
+ * This prevents unbounded memory growth if consumers process events slowly.
49
+ *
50
+ * Set to:
51
+ * - `0`: Disable buffering. Events must be consumed before the next one arrives.
52
+ * - `1`: Only keep the latest event. Useful for real-time updates where only the most recent value matters.
53
+ * - `Infinity`: Keep all events. Ensures no data loss, but may lead to high memory usage.
54
+ *
55
+ * @default 100
56
+ */
57
+ maxBufferedEvents?: number;
58
+ }
59
+ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
60
+ /**
61
+ * Aborts the async iterator. Throws if aborted before or during pulling.
62
+ */
63
+ signal?: AbortSignal | undefined;
64
+ }
65
+ declare class EventPublisher<T extends Record<PropertyKey, any>> {
66
+ #private;
67
+ constructor(options?: EventPublisherOptions);
68
+ get size(): number;
69
+ /**
70
+ * Emits an event and delivers the payload to all subscribed listeners.
71
+ */
72
+ publish<K extends keyof T>(event: K, payload: T[K]): void;
73
+ /**
74
+ * Subscribes to a specific event using a callback function.
75
+ * Returns an unsubscribe function to remove the listener.
76
+ *
77
+ * @example
78
+ * ```ts
79
+ * const unsubscribe = publisher.subscribe('event', (payload) => {
80
+ * console.log(payload)
81
+ * })
82
+ *
83
+ * // Later
84
+ * unsubscribe()
85
+ * ```
86
+ */
87
+ subscribe<K extends keyof T>(event: K, listener: (payload: T[K]) => void): () => void;
88
+ /**
89
+ * Subscribes to a specific event using an async iterator.
90
+ * Useful for `for await...of` loops with optional buffering and abort support.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * for await (const payload of publisher.subscribe('event', { signal })) {
95
+ * console.log(payload)
96
+ * }
97
+ * ```
98
+ */
99
+ subscribe<K extends keyof T>(event: K, options?: EventPublisherSubscribeIteratorOptions): AsyncGenerator<T[K]> & AsyncIteratorObject<T[K]>;
100
+ }
101
+
102
+ declare class SequentialIdGenerator {
103
+ private index;
104
+ generate(): string;
105
+ }
106
+
17
107
  type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
18
108
  type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
19
109
  type PromiseWithError<T, TError> = Promise<T> & {
@@ -31,43 +121,142 @@ interface Registry {
31
121
  type ThrowableError = Registry extends {
32
122
  throwableError: infer T;
33
123
  } ? T : Error;
124
+ type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
34
125
 
35
126
  type InterceptableOptions = Record<string, any>;
36
- type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
37
- next(options?: TOptions): PromiseWithError<TResult, TError>;
127
+ type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
128
+ next(options?: TOptions): TResult;
38
129
  };
39
- type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => PromiseWithError<TResult, TError>;
130
+ type Interceptor<TOptions extends InterceptableOptions, TResult> = (options: InterceptorOptions<TOptions, TResult>) => TResult;
40
131
  /**
41
132
  * Can used for interceptors or middlewares
42
133
  */
43
- declare function onStart<TOptions extends {
134
+ declare function onStart<T, TOptions extends {
44
135
  next(): any;
45
- }, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
136
+ }, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
46
137
  /**
47
138
  * Can used for interceptors or middlewares
48
139
  */
49
- declare function onSuccess<TOptions extends {
140
+ declare function onSuccess<T, TOptions extends {
50
141
  next(): any;
51
- }, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
142
+ }, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
52
143
  /**
53
144
  * Can used for interceptors or middlewares
54
145
  */
55
- declare function onError<TOptions extends {
146
+ declare function onError<T, TOptions extends {
56
147
  next(): any;
57
- }, TRest extends any[]>(callback: NoInfer<(error: ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
58
- type OnFinishState<TResult, TError> = [TResult, null, 'success'] | [undefined, TError, 'error'];
148
+ }, TRest extends any[]>(callback: NoInfer<(error: ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
149
+ type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess: false] | [error: null, data: TResult, isSuccess: true];
59
150
  /**
60
151
  * Can used for interceptors or middlewares
61
152
  */
62
- declare function onFinish<TOptions extends {
153
+ declare function onFinish<T, TOptions extends {
63
154
  next(): any;
64
- }, 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) => Promise<Awaited<ReturnType<TOptions['next']>>>;
65
- declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
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']>>>;
156
+ declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
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>;
66
223
 
67
224
  declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
225
+ interface AsyncIteratorClassNextFn<T, TReturn> {
226
+ (): Promise<IteratorResult<T, TReturn>>;
227
+ }
228
+ interface AsyncIteratorClassCleanupFn {
229
+ (reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
230
+ }
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>;
68
255
 
69
256
  declare function parseEmptyableJSON(text: string | null | undefined): unknown;
70
- 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;
71
260
 
72
261
  type Segment = string | number;
73
262
  declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
@@ -83,9 +272,45 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
83
272
  */
84
273
  declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
85
274
  declare function clone<T>(value: T): T;
86
- declare function get(object: object, path: readonly string[]): unknown;
275
+ declare function get(object: unknown, path: readonly string[]): unknown;
276
+ declare function isPropertyKey(value: unknown): value is PropertyKey;
277
+ declare const NullProtoObj: ({
278
+ new <T extends Record<PropertyKey, unknown>>(): T;
279
+ });
280
+
281
+ /**
282
+ * Prevents objects from being awaitable by intercepting the `then` method
283
+ * when called by the native await mechanism. This is useful for preventing
284
+ * accidental awaiting of objects that aren't meant to be promises.
285
+ */
286
+ declare function preventNativeAwait<T extends object>(target: T): T;
287
+
288
+ interface AsyncIdQueueCloseOptions {
289
+ id?: string;
290
+ reason?: unknown;
291
+ }
292
+ declare class AsyncIdQueue<T> {
293
+ private readonly openIds;
294
+ private readonly queues;
295
+ private readonly waiters;
296
+ get length(): number;
297
+ get waiterIds(): string[];
298
+ hasBufferedItems(id: string): boolean;
299
+ open(id: string): void;
300
+ isOpen(id: string): boolean;
301
+ push(id: string, item: T): void;
302
+ pull(id: string): Promise<T>;
303
+ close({ id, reason }?: AsyncIdQueueCloseOptions): void;
304
+ assertOpen(id: string): void;
305
+ }
306
+
307
+ declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
308
+ declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
309
+
310
+ declare function tryDecodeURIComponent(value: string): string;
87
311
 
88
- type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
89
- declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
312
+ type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
313
+ declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
90
314
 
91
- export { type AnyFunction, type InterceptableOptions, type Interceptor, type InterceptorOptions, type IntersectPick, type MaybeOptionalOptions, type OmitChainMethodDeep, type OnFinishState, type PromiseWithError, type Registry, type Segment, type SetOptional, type ThrowableError, type Value, clone, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, value };
315
+ 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, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
316
+ 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,19 +1,109 @@
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];
6
7
  declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>): T;
7
8
 
8
- declare function toArray<T>(value: T | T[] | null | undefined): T[];
9
+ declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
10
+ declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
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>;
9
18
 
10
19
  type AnyFunction = (...args: any[]) => any;
11
20
  declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
21
+ declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
22
+ /**
23
+ * Executes the callback function after the current call stack has been cleared.
24
+ */
25
+ declare function defer(callback: () => void): void;
12
26
 
13
27
  type OmitChainMethodDeep<T extends object, K extends keyof any> = {
14
28
  [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
15
29
  };
16
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.ee89076";
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
+
43
+ interface EventPublisherOptions {
44
+ /**
45
+ * Maximum number of events to buffer for async iterator subscribers.
46
+ *
47
+ * If the buffer exceeds this limit, the oldest event is dropped.
48
+ * This prevents unbounded memory growth if consumers process events slowly.
49
+ *
50
+ * Set to:
51
+ * - `0`: Disable buffering. Events must be consumed before the next one arrives.
52
+ * - `1`: Only keep the latest event. Useful for real-time updates where only the most recent value matters.
53
+ * - `Infinity`: Keep all events. Ensures no data loss, but may lead to high memory usage.
54
+ *
55
+ * @default 100
56
+ */
57
+ maxBufferedEvents?: number;
58
+ }
59
+ interface EventPublisherSubscribeIteratorOptions extends EventPublisherOptions {
60
+ /**
61
+ * Aborts the async iterator. Throws if aborted before or during pulling.
62
+ */
63
+ signal?: AbortSignal | undefined;
64
+ }
65
+ declare class EventPublisher<T extends Record<PropertyKey, any>> {
66
+ #private;
67
+ constructor(options?: EventPublisherOptions);
68
+ get size(): number;
69
+ /**
70
+ * Emits an event and delivers the payload to all subscribed listeners.
71
+ */
72
+ publish<K extends keyof T>(event: K, payload: T[K]): void;
73
+ /**
74
+ * Subscribes to a specific event using a callback function.
75
+ * Returns an unsubscribe function to remove the listener.
76
+ *
77
+ * @example
78
+ * ```ts
79
+ * const unsubscribe = publisher.subscribe('event', (payload) => {
80
+ * console.log(payload)
81
+ * })
82
+ *
83
+ * // Later
84
+ * unsubscribe()
85
+ * ```
86
+ */
87
+ subscribe<K extends keyof T>(event: K, listener: (payload: T[K]) => void): () => void;
88
+ /**
89
+ * Subscribes to a specific event using an async iterator.
90
+ * Useful for `for await...of` loops with optional buffering and abort support.
91
+ *
92
+ * @example
93
+ * ```ts
94
+ * for await (const payload of publisher.subscribe('event', { signal })) {
95
+ * console.log(payload)
96
+ * }
97
+ * ```
98
+ */
99
+ subscribe<K extends keyof T>(event: K, options?: EventPublisherSubscribeIteratorOptions): AsyncGenerator<T[K]> & AsyncIteratorObject<T[K]>;
100
+ }
101
+
102
+ declare class SequentialIdGenerator {
103
+ private index;
104
+ generate(): string;
105
+ }
106
+
17
107
  type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
18
108
  type IntersectPick<T, U> = Pick<T, keyof T & keyof U>;
19
109
  type PromiseWithError<T, TError> = Promise<T> & {
@@ -31,43 +121,142 @@ interface Registry {
31
121
  type ThrowableError = Registry extends {
32
122
  throwableError: infer T;
33
123
  } ? T : Error;
124
+ type InferAsyncIterableYield<T> = T extends AsyncIterable<infer U> ? U : never;
34
125
 
35
126
  type InterceptableOptions = Record<string, any>;
36
- type InterceptorOptions<TOptions extends InterceptableOptions, TResult, TError> = Omit<TOptions, 'next'> & {
37
- next(options?: TOptions): PromiseWithError<TResult, TError>;
127
+ type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
128
+ next(options?: TOptions): TResult;
38
129
  };
39
- type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult, TError>) => PromiseWithError<TResult, TError>;
130
+ type Interceptor<TOptions extends InterceptableOptions, TResult> = (options: InterceptorOptions<TOptions, TResult>) => TResult;
40
131
  /**
41
132
  * Can used for interceptors or middlewares
42
133
  */
43
- declare function onStart<TOptions extends {
134
+ declare function onStart<T, TOptions extends {
44
135
  next(): any;
45
- }, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
136
+ }, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
46
137
  /**
47
138
  * Can used for interceptors or middlewares
48
139
  */
49
- declare function onSuccess<TOptions extends {
140
+ declare function onSuccess<T, TOptions extends {
50
141
  next(): any;
51
- }, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
142
+ }, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
52
143
  /**
53
144
  * Can used for interceptors or middlewares
54
145
  */
55
- declare function onError<TOptions extends {
146
+ declare function onError<T, TOptions extends {
56
147
  next(): any;
57
- }, TRest extends any[]>(callback: NoInfer<(error: ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
58
- type OnFinishState<TResult, TError> = [TResult, null, 'success'] | [undefined, TError, 'error'];
148
+ }, TRest extends any[]>(callback: NoInfer<(error: ReturnType<TOptions['next']> extends PromiseWithError<any, infer E> ? E : ThrowableError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => T | Promise<Awaited<ReturnType<TOptions['next']>>>;
149
+ type OnFinishState<TResult, TError> = [error: TError, data: undefined, isSuccess: false] | [error: null, data: TResult, isSuccess: true];
59
150
  /**
60
151
  * Can used for interceptors or middlewares
61
152
  */
62
- declare function onFinish<TOptions extends {
153
+ declare function onFinish<T, TOptions extends {
63
154
  next(): any;
64
- }, 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) => Promise<Awaited<ReturnType<TOptions['next']>>>;
65
- declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
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']>>>;
156
+ declare function intercept<TOptions extends InterceptableOptions, TResult>(interceptors: Interceptor<TOptions, TResult>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => TResult>): TResult;
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>;
66
223
 
67
224
  declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
225
+ interface AsyncIteratorClassNextFn<T, TReturn> {
226
+ (): Promise<IteratorResult<T, TReturn>>;
227
+ }
228
+ interface AsyncIteratorClassCleanupFn {
229
+ (reason: 'return' | 'throw' | 'next' | 'dispose'): Promise<void>;
230
+ }
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>;
68
255
 
69
256
  declare function parseEmptyableJSON(text: string | null | undefined): unknown;
70
- 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;
71
260
 
72
261
  type Segment = string | number;
73
262
  declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
@@ -83,9 +272,45 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
83
272
  */
84
273
  declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
85
274
  declare function clone<T>(value: T): T;
86
- declare function get(object: object, path: readonly string[]): unknown;
275
+ declare function get(object: unknown, path: readonly string[]): unknown;
276
+ declare function isPropertyKey(value: unknown): value is PropertyKey;
277
+ declare const NullProtoObj: ({
278
+ new <T extends Record<PropertyKey, unknown>>(): T;
279
+ });
280
+
281
+ /**
282
+ * Prevents objects from being awaitable by intercepting the `then` method
283
+ * when called by the native await mechanism. This is useful for preventing
284
+ * accidental awaiting of objects that aren't meant to be promises.
285
+ */
286
+ declare function preventNativeAwait<T extends object>(target: T): T;
287
+
288
+ interface AsyncIdQueueCloseOptions {
289
+ id?: string;
290
+ reason?: unknown;
291
+ }
292
+ declare class AsyncIdQueue<T> {
293
+ private readonly openIds;
294
+ private readonly queues;
295
+ private readonly waiters;
296
+ get length(): number;
297
+ get waiterIds(): string[];
298
+ hasBufferedItems(id: string): boolean;
299
+ open(id: string): void;
300
+ isOpen(id: string): boolean;
301
+ push(id: string, item: T): void;
302
+ pull(id: string): Promise<T>;
303
+ close({ id, reason }?: AsyncIdQueueCloseOptions): void;
304
+ assertOpen(id: string): void;
305
+ }
306
+
307
+ declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
308
+ declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
309
+
310
+ declare function tryDecodeURIComponent(value: string): string;
87
311
 
88
- type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
89
- declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
312
+ type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
313
+ declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
90
314
 
91
- export { type AnyFunction, type InterceptableOptions, type Interceptor, type InterceptorOptions, type IntersectPick, type MaybeOptionalOptions, type OmitChainMethodDeep, type OnFinishState, type PromiseWithError, type Registry, type Segment, type SetOptional, type ThrowableError, type Value, clone, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, value };
315
+ 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, preventNativeAwait, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, runInSpanContext, runWithSpan, sequential, setGlobalOtelConfig, setSpanAttribute, setSpanError, splitInHalf, startSpan, streamToAsyncIteratorClass, stringifyJSON, toArray, toOtelException, toSpanAttributeValue, tryDecodeURIComponent, value };
316
+ 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
@@ -7,6 +7,28 @@ function resolveMaybeOptionalOptions(rest) {
7
7
  function toArray(value) {
8
8
  return Array.isArray(value) ? value : value === void 0 || value === null ? [] : [value];
9
9
  }
10
+ function splitInHalf(arr) {
11
+ const half = Math.ceil(arr.length / 2);
12
+ return [arr.slice(0, half), arr.slice(half)];
13
+ }
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.ee89076";
25
+
26
+ class AbortError extends Error {
27
+ constructor(...rest) {
28
+ super(...rest);
29
+ this.name = "AbortError";
30
+ }
31
+ }
10
32
 
11
33
  function once(fn) {
12
34
  let cached;
@@ -19,6 +41,431 @@ function once(fn) {
19
41
  return result;
20
42
  };
21
43
  }
44
+ function sequential(fn) {
45
+ let lastOperationPromise = Promise.resolve();
46
+ return (...args) => {
47
+ return lastOperationPromise = lastOperationPromise.catch(() => {
48
+ }).then(() => {
49
+ return fn(...args);
50
+ });
51
+ };
52
+ }
53
+ function defer(callback) {
54
+ if (typeof setTimeout === "function") {
55
+ setTimeout(callback, 0);
56
+ } else {
57
+ Promise.resolve().then(() => Promise.resolve().then(() => Promise.resolve().then(callback)));
58
+ }
59
+ }
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
+
154
+ class AsyncIdQueue {
155
+ openIds = /* @__PURE__ */ new Set();
156
+ queues = /* @__PURE__ */ new Map();
157
+ waiters = /* @__PURE__ */ new Map();
158
+ get length() {
159
+ return this.openIds.size;
160
+ }
161
+ get waiterIds() {
162
+ return Array.from(this.waiters.keys());
163
+ }
164
+ hasBufferedItems(id) {
165
+ return Boolean(this.queues.get(id)?.length);
166
+ }
167
+ open(id) {
168
+ this.openIds.add(id);
169
+ }
170
+ isOpen(id) {
171
+ return this.openIds.has(id);
172
+ }
173
+ push(id, item) {
174
+ this.assertOpen(id);
175
+ const pending = this.waiters.get(id);
176
+ if (pending?.length) {
177
+ pending.shift()[0](item);
178
+ if (pending.length === 0) {
179
+ this.waiters.delete(id);
180
+ }
181
+ } else {
182
+ const items = this.queues.get(id);
183
+ if (items) {
184
+ items.push(item);
185
+ } else {
186
+ this.queues.set(id, [item]);
187
+ }
188
+ }
189
+ }
190
+ async pull(id) {
191
+ this.assertOpen(id);
192
+ const items = this.queues.get(id);
193
+ if (items?.length) {
194
+ const item = items.shift();
195
+ if (items.length === 0) {
196
+ this.queues.delete(id);
197
+ }
198
+ return item;
199
+ }
200
+ return new Promise((resolve, reject) => {
201
+ const waitingPulls = this.waiters.get(id);
202
+ const pending = [resolve, reject];
203
+ if (waitingPulls) {
204
+ waitingPulls.push(pending);
205
+ } else {
206
+ this.waiters.set(id, [pending]);
207
+ }
208
+ });
209
+ }
210
+ close({ id, reason } = {}) {
211
+ if (id === void 0) {
212
+ this.waiters.forEach((pendingPulls, id2) => {
213
+ pendingPulls.forEach(([, reject]) => {
214
+ reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id2}] was closed or aborted while waiting for pulling.`));
215
+ });
216
+ });
217
+ this.waiters.clear();
218
+ this.openIds.clear();
219
+ this.queues.clear();
220
+ return;
221
+ }
222
+ this.waiters.get(id)?.forEach(([, reject]) => {
223
+ reject(reason ?? new Error(`[AsyncIdQueue] Queue[${id}] was closed or aborted while waiting for pulling.`));
224
+ });
225
+ this.waiters.delete(id);
226
+ this.openIds.delete(id);
227
+ this.queues.delete(id);
228
+ }
229
+ assertOpen(id) {
230
+ if (!this.isOpen(id)) {
231
+ throw new Error(`[AsyncIdQueue] Cannot access queue[${id}] because it is not open or aborted.`);
232
+ }
233
+ }
234
+ }
235
+
236
+ function isAsyncIteratorObject(maybe) {
237
+ if (!maybe || typeof maybe !== "object") {
238
+ return false;
239
+ }
240
+ return "next" in maybe && typeof maybe.next === "function" && Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
241
+ }
242
+ const fallbackAsyncDisposeSymbol = Symbol.for("asyncDispose");
243
+ const asyncDisposeSymbol = Symbol.asyncDispose ?? fallbackAsyncDisposeSymbol;
244
+ class AsyncIteratorClass {
245
+ #isDone = false;
246
+ #isExecuteComplete = false;
247
+ #cleanup;
248
+ #next;
249
+ constructor(next, cleanup) {
250
+ this.#cleanup = cleanup;
251
+ this.#next = sequential(async () => {
252
+ if (this.#isDone) {
253
+ return { done: true, value: void 0 };
254
+ }
255
+ try {
256
+ const result = await next();
257
+ if (result.done) {
258
+ this.#isDone = true;
259
+ }
260
+ return result;
261
+ } catch (err) {
262
+ this.#isDone = true;
263
+ throw err;
264
+ } finally {
265
+ if (this.#isDone && !this.#isExecuteComplete) {
266
+ this.#isExecuteComplete = true;
267
+ await this.#cleanup("next");
268
+ }
269
+ }
270
+ });
271
+ }
272
+ next() {
273
+ return this.#next();
274
+ }
275
+ async return(value) {
276
+ this.#isDone = true;
277
+ if (!this.#isExecuteComplete) {
278
+ this.#isExecuteComplete = true;
279
+ await this.#cleanup("return");
280
+ }
281
+ return { done: true, value };
282
+ }
283
+ async throw(err) {
284
+ this.#isDone = true;
285
+ if (!this.#isExecuteComplete) {
286
+ this.#isExecuteComplete = true;
287
+ await this.#cleanup("throw");
288
+ }
289
+ throw err;
290
+ }
291
+ /**
292
+ * asyncDispose symbol only available in esnext, we should fallback to Symbol.for('asyncDispose')
293
+ */
294
+ async [asyncDisposeSymbol]() {
295
+ this.#isDone = true;
296
+ if (!this.#isExecuteComplete) {
297
+ this.#isExecuteComplete = true;
298
+ await this.#cleanup("dispose");
299
+ }
300
+ }
301
+ [Symbol.asyncIterator]() {
302
+ return this;
303
+ }
304
+ }
305
+ function replicateAsyncIterator(source, count) {
306
+ const queue = new AsyncIdQueue();
307
+ const ids = Array.from({ length: count }, (_, i) => i.toString());
308
+ let isSourceFinished = false;
309
+ const start = once(async () => {
310
+ try {
311
+ while (true) {
312
+ const item = await source.next();
313
+ ids.forEach((id) => {
314
+ if (queue.isOpen(id)) {
315
+ queue.push(id, { next: item });
316
+ }
317
+ });
318
+ if (item.done) {
319
+ break;
320
+ }
321
+ }
322
+ } catch (error) {
323
+ ids.forEach((id) => {
324
+ if (queue.isOpen(id)) {
325
+ queue.push(id, { error });
326
+ }
327
+ });
328
+ } finally {
329
+ isSourceFinished = true;
330
+ }
331
+ });
332
+ const replicated = ids.map((id) => {
333
+ queue.open(id);
334
+ return new AsyncIteratorClass(
335
+ async () => {
336
+ start();
337
+ const item = await queue.pull(id);
338
+ if (item.next) {
339
+ return item.next;
340
+ }
341
+ throw item.error;
342
+ },
343
+ async (reason) => {
344
+ queue.close({ id });
345
+ if (reason !== "next" && !queue.length && !isSourceFinished) {
346
+ isSourceFinished = true;
347
+ await source?.return?.();
348
+ }
349
+ }
350
+ );
351
+ });
352
+ return replicated;
353
+ }
354
+ function asyncIteratorWithSpan({ name, ...options }, iterator) {
355
+ let span;
356
+ return new AsyncIteratorClass(
357
+ async () => {
358
+ span ??= startSpan(name);
359
+ try {
360
+ const result = await runInSpanContext(span, () => iterator.next());
361
+ span?.addEvent(result.done ? "completed" : "yielded");
362
+ return result;
363
+ } catch (err) {
364
+ setSpanError(span, err, options);
365
+ throw err;
366
+ }
367
+ },
368
+ async (reason) => {
369
+ try {
370
+ if (reason !== "next") {
371
+ await runInSpanContext(span, () => iterator.return?.());
372
+ }
373
+ } catch (err) {
374
+ setSpanError(span, err, options);
375
+ throw err;
376
+ } finally {
377
+ span?.end();
378
+ }
379
+ }
380
+ );
381
+ }
382
+
383
+ class EventPublisher {
384
+ #listenersMap = /* @__PURE__ */ new Map();
385
+ #maxBufferedEvents;
386
+ constructor(options = {}) {
387
+ this.#maxBufferedEvents = options.maxBufferedEvents ?? 100;
388
+ }
389
+ get size() {
390
+ return this.#listenersMap.size;
391
+ }
392
+ /**
393
+ * Emits an event and delivers the payload to all subscribed listeners.
394
+ */
395
+ publish(event, payload) {
396
+ const listeners = this.#listenersMap.get(event);
397
+ if (!listeners) {
398
+ return;
399
+ }
400
+ for (const listener of listeners) {
401
+ listener(payload);
402
+ }
403
+ }
404
+ subscribe(event, listenerOrOptions) {
405
+ if (typeof listenerOrOptions === "function") {
406
+ let listeners = this.#listenersMap.get(event);
407
+ if (!listeners) {
408
+ this.#listenersMap.set(event, listeners = /* @__PURE__ */ new Set());
409
+ }
410
+ listeners.add(listenerOrOptions);
411
+ return () => {
412
+ listeners.delete(listenerOrOptions);
413
+ if (listeners.size === 0) {
414
+ this.#listenersMap.delete(event);
415
+ }
416
+ };
417
+ }
418
+ const signal = listenerOrOptions?.signal;
419
+ const maxBufferedEvents = listenerOrOptions?.maxBufferedEvents ?? this.#maxBufferedEvents;
420
+ signal?.throwIfAborted();
421
+ const bufferedEvents = [];
422
+ const pullResolvers = [];
423
+ const unsubscribe = this.subscribe(event, (payload) => {
424
+ const resolver = pullResolvers.shift();
425
+ if (resolver) {
426
+ resolver[0]({ done: false, value: payload });
427
+ } else {
428
+ bufferedEvents.push(payload);
429
+ if (bufferedEvents.length > maxBufferedEvents) {
430
+ bufferedEvents.shift();
431
+ }
432
+ }
433
+ });
434
+ const abortListener = (event2) => {
435
+ unsubscribe();
436
+ pullResolvers.forEach((resolver) => resolver[1](event2.target.reason));
437
+ pullResolvers.length = 0;
438
+ bufferedEvents.length = 0;
439
+ };
440
+ signal?.addEventListener("abort", abortListener, { once: true });
441
+ return new AsyncIteratorClass(async () => {
442
+ if (signal?.aborted) {
443
+ throw signal.reason;
444
+ }
445
+ if (bufferedEvents.length > 0) {
446
+ return { done: false, value: bufferedEvents.shift() };
447
+ }
448
+ return new Promise((resolve, reject) => {
449
+ pullResolvers.push([resolve, reject]);
450
+ });
451
+ }, async () => {
452
+ unsubscribe();
453
+ signal?.removeEventListener("abort", abortListener);
454
+ pullResolvers.forEach((resolver) => resolver[0]({ done: true, value: void 0 }));
455
+ pullResolvers.length = 0;
456
+ bufferedEvents.length = 0;
457
+ });
458
+ }
459
+ }
460
+
461
+ class SequentialIdGenerator {
462
+ index = BigInt(0);
463
+ generate() {
464
+ const id = this.index.toString(32);
465
+ this.index++;
466
+ return id;
467
+ }
468
+ }
22
469
 
23
470
  function onStart(callback) {
24
471
  return async (options, ...rest) => {
@@ -48,36 +495,28 @@ function onFinish(callback) {
48
495
  return async (options, ...rest) => {
49
496
  try {
50
497
  const result = await options.next();
51
- state = [result, null, "success"];
498
+ state = [null, result, true];
52
499
  return result;
53
500
  } catch (error) {
54
- state = [void 0, error, "error"];
501
+ state = [error, void 0, false];
55
502
  throw error;
56
503
  } finally {
57
504
  await callback(state, options, ...rest);
58
505
  }
59
506
  };
60
507
  }
61
- async function intercept(interceptors, options, main) {
62
- let index = 0;
63
- const next = async (options2) => {
64
- const interceptor = interceptors[index++];
508
+ function intercept(interceptors, options, main) {
509
+ const next = (options2, index) => {
510
+ const interceptor = interceptors[index];
65
511
  if (!interceptor) {
66
- return await main(options2);
512
+ return main(options2);
67
513
  }
68
- return await interceptor({
514
+ return interceptor({
69
515
  ...options2,
70
- next: (newOptions = options2) => next(newOptions)
516
+ next: (newOptions = options2) => next(newOptions, index + 1)
71
517
  });
72
518
  };
73
- return await next(options);
74
- }
75
-
76
- function isAsyncIteratorObject(maybe) {
77
- if (!maybe || typeof maybe !== "object") {
78
- return false;
79
- }
80
- return Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
519
+ return next(options, 0);
81
520
  }
82
521
 
83
522
  function parseEmptyableJSON(text) {
@@ -138,6 +577,84 @@ function get(object, path) {
138
577
  }
139
578
  return current;
140
579
  }
580
+ function isPropertyKey(value) {
581
+ const type = typeof value;
582
+ return type === "string" || type === "number" || type === "symbol";
583
+ }
584
+ const NullProtoObj = /* @__PURE__ */ (() => {
585
+ const e = function() {
586
+ };
587
+ e.prototype = /* @__PURE__ */ Object.create(null);
588
+ Object.freeze(e.prototype);
589
+ return e;
590
+ })();
591
+
592
+ function preventNativeAwait(target) {
593
+ return new Proxy(target, {
594
+ get(target2, prop, receiver) {
595
+ const value = Reflect.get(target2, prop, receiver);
596
+ if (prop !== "then" || typeof value !== "function") {
597
+ return value;
598
+ }
599
+ return new Proxy(value, {
600
+ apply(targetFn, thisArg, args) {
601
+ if (args.length !== 2 || args.some((arg) => !isNativeFunction(arg))) {
602
+ return Reflect.apply(targetFn, thisArg, args);
603
+ }
604
+ let shouldOmit = true;
605
+ args[0].call(thisArg, preventNativeAwait(new Proxy(target2, {
606
+ get: (target3, prop2, receiver2) => {
607
+ if (shouldOmit && prop2 === "then") {
608
+ shouldOmit = false;
609
+ return void 0;
610
+ }
611
+ return Reflect.get(target3, prop2, receiver2);
612
+ }
613
+ })));
614
+ }
615
+ });
616
+ }
617
+ });
618
+ }
619
+ const NATIVE_FUNCTION_REGEX = /^\s*function\s*\(\)\s*\{\s*\[native code\]\s*\}\s*$/;
620
+ function isNativeFunction(fn) {
621
+ return typeof fn === "function" && NATIVE_FUNCTION_REGEX.test(fn.toString());
622
+ }
623
+
624
+ function streamToAsyncIteratorClass(stream) {
625
+ const reader = stream.getReader();
626
+ return new AsyncIteratorClass(
627
+ async () => {
628
+ return reader.read();
629
+ },
630
+ async () => {
631
+ await reader.cancel();
632
+ }
633
+ );
634
+ }
635
+ function asyncIteratorToStream(iterator) {
636
+ return new ReadableStream({
637
+ async pull(controller) {
638
+ const { done, value } = await iterator.next();
639
+ if (done) {
640
+ controller.close();
641
+ } else {
642
+ controller.enqueue(value);
643
+ }
644
+ },
645
+ async cancel() {
646
+ await iterator.return?.();
647
+ }
648
+ });
649
+ }
650
+
651
+ function tryDecodeURIComponent(value) {
652
+ try {
653
+ return decodeURIComponent(value);
654
+ } catch {
655
+ return value;
656
+ }
657
+ }
141
658
 
142
659
  function value(value2, ...args) {
143
660
  if (typeof value2 === "function") {
@@ -146,4 +663,4 @@ function value(value2, ...args) {
146
663
  return value2;
147
664
  }
148
665
 
149
- export { clone, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, resolveMaybeOptionalOptions, stringifyJSON, toArray, value };
666
+ 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, 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.ee46dab",
4
+ "version": "0.0.0-next.ee89076",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -23,9 +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.26.1"
35
+ "radash": "^12.1.1",
36
+ "type-fest": "^4.39.1"
37
+ },
38
+ "devDependencies": {
39
+ "@opentelemetry/api": "^1.9.0",
40
+ "arktype": "2.1.21",
41
+ "valibot": "^1.1.0",
42
+ "zod": "^4.1.5"
29
43
  },
30
44
  "scripts": {
31
45
  "build": "unbuild",