@orpc/shared 0.0.0-next.0787cc6 → 0.0.0-next.0c0619f
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 +68 -0
- package/dist/index.js +3 -63
- package/dist/src/function.d.ts +0 -1
- package/dist/src/index.d.ts +2 -5
- package/dist/src/interceptor.d.ts +0 -2
- package/dist/src/object.d.ts +1 -2
- package/dist/src/value.d.ts +1 -1
- package/package.json +1 -1
- package/dist/src/constants.d.ts +0 -3
- package/dist/src/json.d.ts +0 -2
- package/dist/src/proxy.d.ts +0 -3
package/README.md
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
|
|
3
|
+
</div>
|
|
4
|
+
|
|
5
|
+
<h1></h1>
|
|
6
|
+
|
|
7
|
+
<div align="center">
|
|
8
|
+
<a href="https://codecov.io/gh/unnoq/orpc">
|
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
|
|
10
|
+
</a>
|
|
11
|
+
<a href="https://www.npmjs.com/package/@orpc/shared">
|
|
12
|
+
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fshared?logo=npm" />
|
|
13
|
+
</a>
|
|
14
|
+
<a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
|
|
15
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
|
|
16
|
+
</a>
|
|
17
|
+
<a href="https://discord.gg/TXEbwRBvQn">
|
|
18
|
+
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
|
19
|
+
</a>
|
|
20
|
+
</div>
|
|
21
|
+
|
|
22
|
+
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
23
|
+
|
|
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, ensuring a smooth and enjoyable developer experience.
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Highlights
|
|
29
|
+
|
|
30
|
+
- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
|
|
31
|
+
- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
|
|
32
|
+
- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
|
|
33
|
+
- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
|
|
34
|
+
- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
|
|
35
|
+
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
|
|
36
|
+
- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
|
|
37
|
+
- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
|
|
38
|
+
- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
|
|
39
|
+
- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
|
|
40
|
+
- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
|
|
41
|
+
- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
|
|
42
|
+
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
|
43
|
+
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
|
44
|
+
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
|
45
|
+
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
|
46
|
+
|
|
47
|
+
## Documentation
|
|
48
|
+
|
|
49
|
+
You can find the full documentation [here](https://orpc.unnoq.com).
|
|
50
|
+
|
|
51
|
+
## Packages
|
|
52
|
+
|
|
53
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
54
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
55
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
56
|
+
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
|
57
|
+
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
58
|
+
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
59
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
60
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
61
|
+
|
|
62
|
+
## `@orpc/shared`
|
|
63
|
+
|
|
64
|
+
Provides shared utilities for oRPC packages.
|
|
65
|
+
|
|
66
|
+
## License
|
|
67
|
+
|
|
68
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,3 @@
|
|
|
1
|
-
// src/constants.ts
|
|
2
|
-
var ORPC_HANDLER_HEADER = "x-orpc-handler";
|
|
3
|
-
var ORPC_HANDLER_VALUE = "orpc";
|
|
4
|
-
|
|
5
1
|
// src/object.ts
|
|
6
2
|
function set(root, segments, value2) {
|
|
7
3
|
const ref = { root };
|
|
@@ -50,7 +46,7 @@ function isObject(value2) {
|
|
|
50
46
|
return false;
|
|
51
47
|
}
|
|
52
48
|
const proto = Object.getPrototypeOf(value2);
|
|
53
|
-
return proto === Object.prototype || proto
|
|
49
|
+
return proto === Object.prototype || !proto || !proto.constructor;
|
|
54
50
|
}
|
|
55
51
|
|
|
56
52
|
// src/error.ts
|
|
@@ -72,19 +68,6 @@ function toError(error) {
|
|
|
72
68
|
return new Error("Unknown error", { cause: error });
|
|
73
69
|
}
|
|
74
70
|
|
|
75
|
-
// src/function.ts
|
|
76
|
-
function once(fn) {
|
|
77
|
-
let cached;
|
|
78
|
-
return () => {
|
|
79
|
-
if (cached) {
|
|
80
|
-
return cached.result;
|
|
81
|
-
}
|
|
82
|
-
const result = fn();
|
|
83
|
-
cached = { result };
|
|
84
|
-
return result;
|
|
85
|
-
};
|
|
86
|
-
}
|
|
87
|
-
|
|
88
71
|
// src/interceptor.ts
|
|
89
72
|
function onStart(callback) {
|
|
90
73
|
return async (options, ...rest) => {
|
|
@@ -139,45 +122,6 @@ async function intercept(interceptors, options, main) {
|
|
|
139
122
|
return await next(options);
|
|
140
123
|
}
|
|
141
124
|
|
|
142
|
-
// src/json.ts
|
|
143
|
-
function parseJSONSafely(text) {
|
|
144
|
-
if (text === "")
|
|
145
|
-
return void 0;
|
|
146
|
-
try {
|
|
147
|
-
return JSON.parse(text);
|
|
148
|
-
} catch {
|
|
149
|
-
return text;
|
|
150
|
-
}
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
// src/proxy.ts
|
|
154
|
-
function createCallableObject(obj, handler) {
|
|
155
|
-
const proxy = new Proxy(handler, {
|
|
156
|
-
has(target, key) {
|
|
157
|
-
return Reflect.has(obj, key) || Reflect.has(target, key);
|
|
158
|
-
},
|
|
159
|
-
ownKeys(target) {
|
|
160
|
-
return Array.from(new Set(Reflect.ownKeys(obj).concat(...Reflect.ownKeys(target))));
|
|
161
|
-
},
|
|
162
|
-
get(target, key) {
|
|
163
|
-
if (!Reflect.has(target, key) || Reflect.has(obj, key)) {
|
|
164
|
-
return Reflect.get(obj, key);
|
|
165
|
-
}
|
|
166
|
-
return Reflect.get(target, key);
|
|
167
|
-
},
|
|
168
|
-
defineProperty(_, key, descriptor) {
|
|
169
|
-
return Reflect.defineProperty(obj, key, descriptor);
|
|
170
|
-
},
|
|
171
|
-
set(_, key, value2) {
|
|
172
|
-
return Reflect.set(obj, key, value2);
|
|
173
|
-
},
|
|
174
|
-
deleteProperty(target, key) {
|
|
175
|
-
return Reflect.deleteProperty(target, key) && Reflect.deleteProperty(obj, key);
|
|
176
|
-
}
|
|
177
|
-
});
|
|
178
|
-
return proxy;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
125
|
// src/value.ts
|
|
182
126
|
function value(value2, ...args) {
|
|
183
127
|
if (typeof value2 === "function") {
|
|
@@ -187,11 +131,8 @@ function value(value2, ...args) {
|
|
|
187
131
|
}
|
|
188
132
|
|
|
189
133
|
// src/index.ts
|
|
190
|
-
import { group, guard, mapEntries, mapValues, omit, trim } from "radash";
|
|
134
|
+
import { group, guard, mapEntries, mapValues, omit, retry, trim } from "radash";
|
|
191
135
|
export {
|
|
192
|
-
ORPC_HANDLER_HEADER,
|
|
193
|
-
ORPC_HANDLER_VALUE,
|
|
194
|
-
createCallableObject,
|
|
195
136
|
findDeepMatches,
|
|
196
137
|
get,
|
|
197
138
|
group,
|
|
@@ -205,8 +146,7 @@ export {
|
|
|
205
146
|
onFinish,
|
|
206
147
|
onStart,
|
|
207
148
|
onSuccess,
|
|
208
|
-
|
|
209
|
-
parseJSONSafely,
|
|
149
|
+
retry,
|
|
210
150
|
set,
|
|
211
151
|
toError,
|
|
212
152
|
trim,
|
package/dist/src/function.d.ts
CHANGED
package/dist/src/index.d.ts
CHANGED
|
@@ -1,13 +1,10 @@
|
|
|
1
1
|
export * from './chain';
|
|
2
|
-
export * from './constants';
|
|
3
2
|
export * from './error';
|
|
4
3
|
export * from './function';
|
|
5
4
|
export * from './interceptor';
|
|
6
|
-
export * from './json';
|
|
7
5
|
export * from './object';
|
|
8
|
-
export * from './proxy';
|
|
9
6
|
export * from './types';
|
|
10
7
|
export * from './value';
|
|
11
|
-
export { group, guard, mapEntries, mapValues, omit, trim } from 'radash';
|
|
12
|
-
export type { IsEqual, IsNever,
|
|
8
|
+
export { group, guard, mapEntries, mapValues, omit, retry, trim } from 'radash';
|
|
9
|
+
export type { IsEqual, IsNever, PartialDeep, Promisable } from 'type-fest';
|
|
13
10
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
|
-
import type { AnyFunction } from './function';
|
|
3
2
|
export type InterceptableOptions = Record<string, any>;
|
|
4
3
|
export type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
|
|
5
4
|
next(options?: TOptions): Promise<TResult>;
|
|
@@ -21,7 +20,6 @@ export declare function onStart<TOptions extends {
|
|
|
21
20
|
export declare function onSuccess<TOptions extends {
|
|
22
21
|
next(): any;
|
|
23
22
|
}, 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']>>>;
|
|
24
|
-
export type InferError<T extends AnyFunction> = T extends Interceptor<any, any, infer TError> ? TError : unknown;
|
|
25
23
|
/**
|
|
26
24
|
* Can used for interceptors or middlewares
|
|
27
25
|
*/
|
package/dist/src/object.d.ts
CHANGED
|
@@ -6,8 +6,7 @@ export declare function findDeepMatches(check: (value: unknown) => boolean, payl
|
|
|
6
6
|
values: unknown[];
|
|
7
7
|
};
|
|
8
8
|
/**
|
|
9
|
-
* Check if the value is an object.
|
|
10
|
-
* Even object created by Object.create(null) is considered an object.
|
|
9
|
+
* Check if the value is an object even it created by `Object.create(null)` or more tricky way.
|
|
11
10
|
*/
|
|
12
11
|
export declare function isObject(value: unknown): value is Record<PropertyKey, unknown>;
|
|
13
12
|
//# sourceMappingURL=object.d.ts.map
|
package/dist/src/value.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import type { Promisable } from 'type-fest';
|
|
2
2
|
export type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
|
|
3
|
-
export declare function value<T
|
|
3
|
+
export declare function value<T, TArgs extends any[]>(value: Value<T, TArgs>, ...args: NoInfer<TArgs>): Promise<T extends Value<infer U, any> ? U : never>;
|
|
4
4
|
//# sourceMappingURL=value.d.ts.map
|
package/package.json
CHANGED
package/dist/src/constants.d.ts
DELETED
package/dist/src/json.d.ts
DELETED
package/dist/src/proxy.d.ts
DELETED