@orpc/shared 0.0.0-next.fe39bf3 → 0.0.0-next.fea68c1

package/README.md

@@ -0,0 +1,68 @@
+<div align="center">
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+</div>
+
+<h1></h1>
+
+<div align="center">
+  <a href="https://codecov.io/gh/unnoq/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
+  </a>
+  <a href="https://www.npmjs.com/package/@orpc/shared">
+    <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fshared?logo=npm" />
+  </a>
+  <a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
+  </a>
+  <a href="https://discord.gg/TXEbwRBvQn">
+    <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
+  </a>
+</div>
+
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
+
+**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.
+
+---
+
+## Highlights
+
+- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
+- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
+- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
+- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
+- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
+- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
+- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
+- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
+- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
+- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
+- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
+- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
+- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
+- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
+- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
+- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+
+## Documentation
+
+You can find the full documentation [here](https://orpc.unnoq.com).
+
+## Packages
+
+- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
+- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
+- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
+- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+
+## `@orpc/shared`
+
+Provides shared utilities for oRPC packages.
+
+## License
+
+Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.

package/dist/index.js

@@ -48,6 +48,9 @@ function isObject(value2) {
   const proto = Object.getPrototypeOf(value2);
   return proto === Object.prototype || !proto || !proto.constructor;
 }
+function isTypescriptObject(value2) {
+  return !!value2 && (typeof value2 === "object" || typeof value2 === "function");
+}
 
 // src/error.ts
 function toError(error) {
@@ -68,6 +71,19 @@ function toError(error) {
   return new Error("Unknown error", { cause: error });
 }
 
+// src/function.ts
+function once(fn) {
+  let cached;
+  return () => {
+    if (cached) {
+      return cached.result;
+    }
+    const result = fn();
+    cached = { result };
+    return result;
+  };
+}
+
 // src/interceptor.ts
 function onStart(callback) {
   return async (options, ...rest) => {
@@ -122,6 +138,25 @@ async function intercept(interceptors, options, main) {
   return await next(options);
 }
 
+// src/iterator.ts
+function isAsyncIteratorObject(maybe) {
+  if (!maybe || typeof maybe !== "object") {
+    return false;
+  }
+  return Symbol.asyncIterator in maybe && typeof maybe[Symbol.asyncIterator] === "function";
+}
+
+// src/json.ts
+function parseEmptyableJSON(text) {
+  if (!text) {
+    return void 0;
+  }
+  return JSON.parse(text);
+}
+function stringifyJSON(value2) {
+  return JSON.stringify(value2);
+}
+
 // src/value.ts
 function value(value2, ...args) {
   if (typeof value2 === "function") {
@@ -138,7 +173,9 @@ export {
   group,
   guard,
   intercept,
+  isAsyncIteratorObject,
   isObject,
+  isTypescriptObject,
   mapEntries,
   mapValues,
   omit,
@@ -146,8 +183,11 @@ export {
   onFinish,
   onStart,
   onSuccess,
+  once,
+  parseEmptyableJSON,
   retry,
   set,
+  stringifyJSON,
   toError,
   trim,
   value

package/dist/src/function.d.ts

@@ -1,2 +1,3 @@
 export type AnyFunction = (...args: any[]) => any;
+export declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
 //# sourceMappingURL=function.d.ts.map

package/dist/src/index.d.ts

@@ -2,6 +2,8 @@ export * from './chain';
 export * from './error';
 export * from './function';
 export * from './interceptor';
+export * from './iterator';
+export * from './json';
 export * from './object';
 export * from './types';
 export * from './value';

package/dist/src/iterator.d.ts

@@ -0,0 +1,2 @@
+export declare function isAsyncIteratorObject(maybe: unknown): maybe is AsyncIteratorObject<any, any, any>;
+//# sourceMappingURL=iterator.d.ts.map

package/dist/src/json.d.ts

@@ -0,0 +1,3 @@
+export declare function parseEmptyableJSON(text: string | null | undefined): unknown;
+export declare function stringifyJSON<T>(value: T): undefined extends T ? undefined | string : string;
+//# sourceMappingURL=json.d.ts.map

package/dist/src/object.d.ts

@@ -9,4 +9,8 @@ export declare function findDeepMatches(check: (value: unknown) => boolean, payl
  * Check if the value is an object even it created by `Object.create(null)` or more tricky way.
  */
 export declare function isObject(value: unknown): value is Record<PropertyKey, unknown>;
+/**
+ * Check if the value satisfy a `object` type in typescript
+ */
+export declare function isTypescriptObject(value: unknown): value is object & Record<PropertyKey, unknown>;
 //# sourceMappingURL=object.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/shared",
   "type": "module",
-  "version": "0.0.0-next.fe39bf3",
+  "version": "0.0.0-next.fea68c1",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {