@orpc/react 1.0.0-beta.6 → 1.0.3

package/README.md

@@ -21,28 +21,24 @@
 
 <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.
+**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
 
 ---
 
 ## 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, Solid, Svelte), 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.
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
+- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 

package/dist/hooks/index.d.mts

@@ -58,6 +58,12 @@ interface UseServerActionErrorResult<TInput, TOutput, TError> extends UseServerA
     status: 'error';
     executedAt: Date;
 }
+/**
+ * Use a Server Action Hook
+ *
+ * @see {@link https://orpc.unnoq.com/docs/server-action#useserveraction-hook Server Action Hook Docs}
+ */
 declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: NoInfer<UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>>): UseServerActionIdleResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionSuccessResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionErrorResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionPendingResult<TInput, TOutput, UnactionableError<TError>>;
 
-export { type UseServerActionErrorResult, type UseServerActionExecuteOptions, type UseServerActionExecuteRest, type UseServerActionIdleResult, type UseServerActionOptions, type UseServerActionPendingResult, type UseServerActionResultBase, type UseServerActionSuccessResult, useServerAction };
+export { useServerAction };
+export type { UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResultBase, UseServerActionSuccessResult };

package/dist/hooks/index.d.ts

@@ -58,6 +58,12 @@ interface UseServerActionErrorResult<TInput, TOutput, TError> extends UseServerA
     status: 'error';
     executedAt: Date;
 }
+/**
+ * Use a Server Action Hook
+ *
+ * @see {@link https://orpc.unnoq.com/docs/server-action#useserveraction-hook Server Action Hook Docs}
+ */
 declare function useServerAction<TInput, TOutput, TError extends ORPCErrorJSON<any, any>>(action: ActionableClient<TInput, TOutput, TError>, options?: NoInfer<UseServerActionOptions<TInput, TOutput, UnactionableError<TError>>>): UseServerActionIdleResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionSuccessResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionErrorResult<TInput, TOutput, UnactionableError<TError>> | UseServerActionPendingResult<TInput, TOutput, UnactionableError<TError>>;
 
-export { type UseServerActionErrorResult, type UseServerActionExecuteOptions, type UseServerActionExecuteRest, type UseServerActionIdleResult, type UseServerActionOptions, type UseServerActionPendingResult, type UseServerActionResultBase, type UseServerActionSuccessResult, useServerAction };
+export { useServerAction };
+export type { UseServerActionErrorResult, UseServerActionExecuteOptions, UseServerActionExecuteRest, UseServerActionIdleResult, UseServerActionOptions, UseServerActionPendingResult, UseServerActionResultBase, UseServerActionSuccessResult };

package/dist/index.d.mts

@@ -6,6 +6,13 @@ interface FormAction {
     (form: FormData): Promise<void>;
 }
 declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, any, any>;
+/**
+ * Create a server action accept a form data and deserialize with bracket notation.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/server-action#createformaction-utility Create Form Action Utility Docs}
+ * @see {@link https://orpc.unnoq.com/docs/openapi/bracket-notation Bracket Notation Docs}
+ */
 declare function createFormAction<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): FormAction;
 
-export { type FormAction, createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+export { createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+export type { FormAction };

package/dist/index.d.ts

@@ -6,6 +6,13 @@ interface FormAction {
     (form: FormData): Promise<void>;
 }
 declare const orpcErrorToNextHttpFallbackInterceptor: Interceptor<any, any, any>;
+/**
+ * Create a server action accept a form data and deserialize with bracket notation.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/server-action#createformaction-utility Create Form Action Utility Docs}
+ * @see {@link https://orpc.unnoq.com/docs/openapi/bracket-notation Bracket Notation Docs}
+ */
 declare function createFormAction<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): FormAction;
 
-export { type FormAction, createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+export { createFormAction, orpcErrorToNextHttpFallbackInterceptor };
+export type { FormAction };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/react",
   "type": "module",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.3",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -34,11 +34,11 @@
     "react": ">=18.0.0"
   },
   "dependencies": {
-    "@orpc/client": "1.0.0-beta.6",
-    "@orpc/contract": "1.0.0-beta.6",
-    "@orpc/openapi-client": "1.0.0-beta.6",
-    "@orpc/server": "1.0.0-beta.6",
-    "@orpc/shared": "1.0.0-beta.6"
+    "@orpc/client": "1.0.3",
+    "@orpc/contract": "1.0.3",
+    "@orpc/openapi-client": "1.0.3",
+    "@orpc/shared": "1.0.3",
+    "@orpc/server": "1.0.3"
   },
   "devDependencies": {
     "react": "^19.1.0",