@orpc/shared 0.0.0-next.3e05997 → 0.0.0-next.3e5b49d
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 +1 -1
- package/dist/index.d.mts +21 -11
- package/dist/index.d.ts +21 -11
- package/dist/index.mjs +46 -14
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
36
36
|
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
37
37
|
- **📝 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.
|
|
38
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
|
|
39
39
|
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
40
40
|
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
41
41
|
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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
3
|
export { group, guard, mapEntries, mapValues, omit } from 'radash';
|
|
4
4
|
|
|
5
5
|
type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
|
|
@@ -8,6 +8,13 @@ declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>):
|
|
|
8
8
|
declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
|
|
9
9
|
declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* Converts Request/Response/Blob/File/.. to a buffer (ArrayBuffer or Uint8Array).
|
|
13
|
+
*
|
|
14
|
+
* Prefers the newer `.bytes` method when available as it more efficient but not widely supported yet.
|
|
15
|
+
*/
|
|
16
|
+
declare function readAsBuffer(source: Pick<Blob, 'arrayBuffer' | 'bytes'>): Promise<ArrayBuffer | Uint8Array>;
|
|
17
|
+
|
|
11
18
|
type AnyFunction = (...args: any[]) => any;
|
|
12
19
|
declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
|
|
13
20
|
declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
|
|
@@ -80,8 +87,8 @@ declare class EventPublisher<T extends Record<PropertyKey, any>> {
|
|
|
80
87
|
}
|
|
81
88
|
|
|
82
89
|
declare class SequentialIdGenerator {
|
|
83
|
-
private
|
|
84
|
-
generate():
|
|
90
|
+
private index;
|
|
91
|
+
generate(): string;
|
|
85
92
|
}
|
|
86
93
|
|
|
87
94
|
type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
@@ -178,14 +185,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
178
185
|
*/
|
|
179
186
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
180
187
|
declare function clone<T>(value: T): T;
|
|
181
|
-
declare function get(object:
|
|
188
|
+
declare function get(object: unknown, path: readonly string[]): unknown;
|
|
182
189
|
declare function isPropertyKey(value: unknown): value is PropertyKey;
|
|
183
190
|
declare const NullProtoObj: ({
|
|
184
191
|
new <T extends Record<PropertyKey, unknown>>(): T;
|
|
185
192
|
});
|
|
186
193
|
|
|
187
194
|
interface AsyncIdQueueCloseOptions {
|
|
188
|
-
id?:
|
|
195
|
+
id?: string;
|
|
189
196
|
reason?: unknown;
|
|
190
197
|
}
|
|
191
198
|
declare class AsyncIdQueue<T> {
|
|
@@ -193,16 +200,19 @@ declare class AsyncIdQueue<T> {
|
|
|
193
200
|
private readonly items;
|
|
194
201
|
private readonly pendingPulls;
|
|
195
202
|
get length(): number;
|
|
196
|
-
open(id:
|
|
197
|
-
isOpen(id:
|
|
198
|
-
push(id:
|
|
199
|
-
pull(id:
|
|
203
|
+
open(id: string): void;
|
|
204
|
+
isOpen(id: string): boolean;
|
|
205
|
+
push(id: string, item: T): void;
|
|
206
|
+
pull(id: string): Promise<T>;
|
|
200
207
|
close({ id, reason }?: AsyncIdQueueCloseOptions): void;
|
|
201
|
-
assertOpen(id:
|
|
208
|
+
assertOpen(id: string): void;
|
|
202
209
|
}
|
|
203
210
|
|
|
211
|
+
declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
|
|
212
|
+
declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
|
|
213
|
+
|
|
204
214
|
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
|
|
205
215
|
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
|
|
206
216
|
|
|
207
|
-
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 };
|
|
217
|
+
export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, asyncIteratorToStream, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, streamToAsyncIteratorClass, stringifyJSON, toArray, value };
|
|
208
218
|
export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
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
3
|
export { group, guard, mapEntries, mapValues, omit } from 'radash';
|
|
4
4
|
|
|
5
5
|
type MaybeOptionalOptions<TOptions> = Record<never, never> extends TOptions ? [options?: TOptions] : [options: TOptions];
|
|
@@ -8,6 +8,13 @@ declare function resolveMaybeOptionalOptions<T>(rest: MaybeOptionalOptions<T>):
|
|
|
8
8
|
declare function toArray<T>(value: T): T extends readonly any[] ? T : Exclude<T, undefined | null>[];
|
|
9
9
|
declare function splitInHalf<T>(arr: readonly T[]): [T[], T[]];
|
|
10
10
|
|
|
11
|
+
/**
|
|
12
|
+
* Converts Request/Response/Blob/File/.. to a buffer (ArrayBuffer or Uint8Array).
|
|
13
|
+
*
|
|
14
|
+
* Prefers the newer `.bytes` method when available as it more efficient but not widely supported yet.
|
|
15
|
+
*/
|
|
16
|
+
declare function readAsBuffer(source: Pick<Blob, 'arrayBuffer' | 'bytes'>): Promise<ArrayBuffer | Uint8Array>;
|
|
17
|
+
|
|
11
18
|
type AnyFunction = (...args: any[]) => any;
|
|
12
19
|
declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
|
|
13
20
|
declare function sequential<A extends any[], R>(fn: (...args: A) => Promise<R>): (...args: A) => Promise<R>;
|
|
@@ -80,8 +87,8 @@ declare class EventPublisher<T extends Record<PropertyKey, any>> {
|
|
|
80
87
|
}
|
|
81
88
|
|
|
82
89
|
declare class SequentialIdGenerator {
|
|
83
|
-
private
|
|
84
|
-
generate():
|
|
90
|
+
private index;
|
|
91
|
+
generate(): string;
|
|
85
92
|
}
|
|
86
93
|
|
|
87
94
|
type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
@@ -178,14 +185,14 @@ declare function isObject(value: unknown): value is Record<PropertyKey, unknown>
|
|
|
178
185
|
*/
|
|
179
186
|
declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
|
|
180
187
|
declare function clone<T>(value: T): T;
|
|
181
|
-
declare function get(object:
|
|
188
|
+
declare function get(object: unknown, path: readonly string[]): unknown;
|
|
182
189
|
declare function isPropertyKey(value: unknown): value is PropertyKey;
|
|
183
190
|
declare const NullProtoObj: ({
|
|
184
191
|
new <T extends Record<PropertyKey, unknown>>(): T;
|
|
185
192
|
});
|
|
186
193
|
|
|
187
194
|
interface AsyncIdQueueCloseOptions {
|
|
188
|
-
id?:
|
|
195
|
+
id?: string;
|
|
189
196
|
reason?: unknown;
|
|
190
197
|
}
|
|
191
198
|
declare class AsyncIdQueue<T> {
|
|
@@ -193,16 +200,19 @@ declare class AsyncIdQueue<T> {
|
|
|
193
200
|
private readonly items;
|
|
194
201
|
private readonly pendingPulls;
|
|
195
202
|
get length(): number;
|
|
196
|
-
open(id:
|
|
197
|
-
isOpen(id:
|
|
198
|
-
push(id:
|
|
199
|
-
pull(id:
|
|
203
|
+
open(id: string): void;
|
|
204
|
+
isOpen(id: string): boolean;
|
|
205
|
+
push(id: string, item: T): void;
|
|
206
|
+
pull(id: string): Promise<T>;
|
|
200
207
|
close({ id, reason }?: AsyncIdQueueCloseOptions): void;
|
|
201
|
-
assertOpen(id:
|
|
208
|
+
assertOpen(id: string): void;
|
|
202
209
|
}
|
|
203
210
|
|
|
211
|
+
declare function streamToAsyncIteratorClass<T>(stream: ReadableStream<T>): AsyncIteratorClass<T>;
|
|
212
|
+
declare function asyncIteratorToStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
|
|
213
|
+
|
|
204
214
|
type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => T);
|
|
205
215
|
declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): T extends Value<infer U, any> ? U : never;
|
|
206
216
|
|
|
207
|
-
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 };
|
|
217
|
+
export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, asyncIteratorToStream, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, streamToAsyncIteratorClass, stringifyJSON, toArray, value };
|
|
208
218
|
export type { AnyFunction, AsyncIdQueueCloseOptions, AsyncIteratorClassCleanupFn, AsyncIteratorClassNextFn, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, InterceptableOptions, Interceptor, InterceptorOptions, IntersectPick, MaybeOptionalOptions, OmitChainMethodDeep, OnFinishState, PromiseWithError, Registry, Segment, SetOptional, ThrowableError, Value };
|
package/dist/index.mjs
CHANGED
|
@@ -12,6 +12,13 @@ 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
|
+
|
|
15
22
|
function once(fn) {
|
|
16
23
|
let cached;
|
|
17
24
|
return () => {
|
|
@@ -120,7 +127,7 @@ function isAsyncIteratorObject(maybe) {
|
|
|
120
127
|
if (!maybe || typeof maybe !== "object") {
|
|
121
128
|
return false;
|
|
122
129
|
}
|
|
123
|
-
return Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
|
|
130
|
+
return "next" in maybe && typeof maybe.next === "function" && Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
|
|
124
131
|
}
|
|
125
132
|
const fallbackAsyncDisposeSymbol = Symbol.for("asyncDispose");
|
|
126
133
|
const asyncDisposeSymbol = Symbol.asyncDispose ?? fallbackAsyncDisposeSymbol;
|
|
@@ -194,8 +201,8 @@ function replicateAsyncIterator(source, count) {
|
|
|
194
201
|
while (true) {
|
|
195
202
|
const item = await source.next();
|
|
196
203
|
for (let id = 0; id < count; id++) {
|
|
197
|
-
if (queue.isOpen(id)) {
|
|
198
|
-
queue.push(id, item);
|
|
204
|
+
if (queue.isOpen(id.toString())) {
|
|
205
|
+
queue.push(id.toString(), item);
|
|
199
206
|
}
|
|
200
207
|
}
|
|
201
208
|
if (item.done) {
|
|
@@ -207,12 +214,12 @@ function replicateAsyncIterator(source, count) {
|
|
|
207
214
|
}
|
|
208
215
|
});
|
|
209
216
|
for (let id = 0; id < count; id++) {
|
|
210
|
-
queue.open(id);
|
|
217
|
+
queue.open(id.toString());
|
|
211
218
|
replicated.push(new AsyncIteratorClass(
|
|
212
219
|
() => {
|
|
213
220
|
start();
|
|
214
221
|
return new Promise((resolve, reject) => {
|
|
215
|
-
queue.pull(id).then(resolve).catch(reject);
|
|
222
|
+
queue.pull(id.toString()).then(resolve).catch(reject);
|
|
216
223
|
defer(() => {
|
|
217
224
|
if (error) {
|
|
218
225
|
reject(error.value);
|
|
@@ -221,9 +228,9 @@ function replicateAsyncIterator(source, count) {
|
|
|
221
228
|
});
|
|
222
229
|
},
|
|
223
230
|
async (reason) => {
|
|
224
|
-
queue.close({ id });
|
|
231
|
+
queue.close({ id: id.toString() });
|
|
225
232
|
if (reason !== "next") {
|
|
226
|
-
if (replicated.every((_, id2) => !queue.isOpen(id2))) {
|
|
233
|
+
if (replicated.every((_, id2) => !queue.isOpen(id2.toString()))) {
|
|
227
234
|
await source?.return?.();
|
|
228
235
|
}
|
|
229
236
|
}
|
|
@@ -312,13 +319,11 @@ class EventPublisher {
|
|
|
312
319
|
}
|
|
313
320
|
|
|
314
321
|
class SequentialIdGenerator {
|
|
315
|
-
|
|
322
|
+
index = BigInt(0);
|
|
316
323
|
generate() {
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
}
|
|
321
|
-
return this.nextId++;
|
|
324
|
+
const id = this.index.toString(32);
|
|
325
|
+
this.index++;
|
|
326
|
+
return id;
|
|
322
327
|
}
|
|
323
328
|
}
|
|
324
329
|
|
|
@@ -444,6 +449,33 @@ const NullProtoObj = /* @__PURE__ */ (() => {
|
|
|
444
449
|
return e;
|
|
445
450
|
})();
|
|
446
451
|
|
|
452
|
+
function streamToAsyncIteratorClass(stream) {
|
|
453
|
+
const reader = stream.getReader();
|
|
454
|
+
return new AsyncIteratorClass(
|
|
455
|
+
async () => {
|
|
456
|
+
return reader.read();
|
|
457
|
+
},
|
|
458
|
+
async () => {
|
|
459
|
+
await reader.cancel();
|
|
460
|
+
}
|
|
461
|
+
);
|
|
462
|
+
}
|
|
463
|
+
function asyncIteratorToStream(iterator) {
|
|
464
|
+
return new ReadableStream({
|
|
465
|
+
async pull(controller) {
|
|
466
|
+
const { done, value } = await iterator.next();
|
|
467
|
+
if (done) {
|
|
468
|
+
controller.close();
|
|
469
|
+
} else {
|
|
470
|
+
controller.enqueue(value);
|
|
471
|
+
}
|
|
472
|
+
},
|
|
473
|
+
async cancel() {
|
|
474
|
+
await iterator.return?.();
|
|
475
|
+
}
|
|
476
|
+
});
|
|
477
|
+
}
|
|
478
|
+
|
|
447
479
|
function value(value2, ...args) {
|
|
448
480
|
if (typeof value2 === "function") {
|
|
449
481
|
return value2(...args);
|
|
@@ -451,4 +483,4 @@ function value(value2, ...args) {
|
|
|
451
483
|
return value2;
|
|
452
484
|
}
|
|
453
485
|
|
|
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 };
|
|
486
|
+
export { AsyncIdQueue, AsyncIteratorClass, EventPublisher, NullProtoObj, SequentialIdGenerator, asyncIteratorToStream, clone, defer, findDeepMatches, get, intercept, isAsyncIteratorObject, isObject, isPropertyKey, isTypescriptObject, onError, onFinish, onStart, onSuccess, once, parseEmptyableJSON, readAsBuffer, replicateAsyncIterator, resolveMaybeOptionalOptions, sequential, splitInHalf, streamToAsyncIteratorClass, stringifyJSON, toArray, value };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/shared",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.3e5b49d",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -24,13 +24,13 @@
|
|
|
24
24
|
"dist"
|
|
25
25
|
],
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"radash": "^12.1.
|
|
27
|
+
"radash": "^12.1.1",
|
|
28
28
|
"type-fest": "^4.39.1"
|
|
29
29
|
},
|
|
30
30
|
"devDependencies": {
|
|
31
31
|
"arktype": "2.1.20",
|
|
32
32
|
"valibot": "^1.1.0",
|
|
33
|
-
"zod": "^
|
|
33
|
+
"zod": "^4.0.5"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
36
|
"build": "unbuild",
|