npm - @orpc/nest - Versions diffs - 1.14.11 → 1.14.13 - Mend

@orpc/nest 1.14.11 → 1.14.13

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.

Files changed (5) hide show

package/README.md CHANGED Viewed

@@ -1,16 +1,17 @@
-<h1 align="center">oRPC - Typesafe APIs Made Simple 🪄</h1>
+<div align="center">
+  <image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
+</div>
+<h1></h1>
 <div align="center">
   <a href="https://codecov.io/gh/middleapi/orpc">
-    <img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
+    <img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/1.x/graph/badge.svg">
   </a>
   <a href="https://www.npmjs.com/package/@orpc/nest">
     <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fnest?logo=npm" />
   </a>
-  <a href="https://app.codspeed.io/middleapi/orpc?utm_source=badge">
-    <img alt="CodSpeed" src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" />
-  </a>
-  <a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
+  <a href="https://github.com/middleapi/orpc/blob/1.x/LICENSE">
     <img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
   </a>
   <a href="https://discord.gg/TXEbwRBvQn">
@@ -21,53 +22,109 @@
   </a>
 </div>
-## Documentation
-You can read the documentation [here](https://orpc.dev).
-## Packages
-**Core**
+<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
-- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Define API contract as the single source of truth.
-- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
-- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
-- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
+**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
-**Schema validation**
+---
-- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): Integrate with [Zod](https://zod.dev/).
-- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
-- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
+## Highlights
-**Built-in features**
+- **🔗 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.
+- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, 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.
-- [@orpc/publisher](https://www.npmjs.com/package/@orpc/publisher): Pub/Sub with memory, Redis, and Upstash adapters.
-- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
-- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
-**Framework & ecosystem integrations**
+## Documentation
-- [@orpc/next](https://www.npmjs.com/package/@orpc/next): Integrate with [Next.js Server Functions](https://nextjs.org/docs/app/getting-started/mutating-data).
-- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
-- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
-- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
-- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
-- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
-- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
-- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
-- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
-- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
+You can find the full documentation [here](https://orpc.dev).
-**Observability**
+## Packages
-- [@orpc/opentelemetry](https://www.npmjs.com/package/@orpc/opentelemetry): Integrate with [OpenTelemetry](https://opentelemetry.io/) for distributed tracing.
-- [@orpc/pino](https://www.npmjs.com/package/@orpc/pino): Integrate with [Pino](https://getpino.io/) for logging.
-- [@orpc/evlog](https://www.npmjs.com/package/@orpc/evlog): Integrate with [Evlog](https://evlog.dev/) for logging.
+- [@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/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
+- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
+- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
+- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
+- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
+- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
+- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
+- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
+- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
+- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
+## `@orpc/nest`
+Deeply integrate oRPC with [NestJS](https://nestjs.com/). Read the [documentation](https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest) for more information.
+### Implement Contract
+An overview of how to implement an [oRPC contract](https://orpc.dev/docs/contract-first/define-contract) in NestJS.
+```ts
+import { Implement, implement, ORPCError } from '@orpc/nest'
+@Controller()
+export class PlanetController {
+  /**
+   * Implement a standalone procedure
+   */
+  @Implement(contract.planet.list)
+  list() {
+    return implement(contract.planet.list).handler(({ input }) => {
+      // Implement logic here
+      return []
+    })
+  }
+  /**
+   * Implement entire contract
+   */
+  @Implement(contract.planet)
+  planet() {
+    return {
+      list: implement(contract.planet.list).handler(({ input }) => {
+        // Implement logic here
+        return []
+      }),
+      find: implement(contract.planet.find).handler(({ input }) => {
+        // Implement logic here
+        return {
+          id: 1,
+          name: 'Earth',
+          description: 'The planet Earth',
+        }
+      }),
+      create: implement(contract.planet.create).handler(({ input }) => {
+        // Implement logic here
+        return {
+          id: 1,
+          name: 'Earth',
+          description: 'The planet Earth',
+        }
+      }),
+    }
+  }
+  // other handlers...
+}
+```
 ## Sponsors
-Like what we build over at [middleapi](https://github.com/middleapi)? You can help keep it going here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh). Every bit helps! 🚀
+If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
 ### 🏆 Platinum Sponsor
@@ -109,10 +166,11 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
    <td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&amp;v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
    <td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&amp;v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
    <td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&amp;v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
+   <td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&amp;v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
    <td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
-   <td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&amp;v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&amp;v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
    <td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&amp;v=4" width="139" alt="shota"/><br />shota</a></td>
   </tr>
 </table>
@@ -172,7 +230,6 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&amp;v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
   <a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&amp;v=4" width="32" height="32" alt="Robert Soriano" /></a>
   <a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="32" height="32" alt="Andrew Peters" /></a>
-  <a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&amp;v=4" width="32" height="32" alt="Ryan Vogel" /></a>
   <a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
   <a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&amp;v=4" width="32" height="32" alt="Peter Adam" /></a>
   <a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
@@ -187,13 +244,6 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
 </p>
-## References
-oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
-- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
-- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
 ## License
-Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENSE) for more information.
+Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/1.x/LICENSE) for more information.

package/dist/index.d.mts CHANGED Viewed

@@ -1,41 +1,38 @@
-import { ExecutionContext, DynamicModule, NestInterceptor, CallHandler } from '@nestjs/common';
-import { RouterContract } from '@orpc/contract';
-import { DefaultInitialContext, ContractedRouter } from '@orpc/server';
-import { Value, Promisable } from '@orpc/shared';
-import { Observable } from 'rxjs';
-import { OpenAPIHandlerCodecCoreOptions } from '@orpc/openapi/standard';
+import { AnySchema, ContractRouter, HTTPPath, AnyContractRouter } from '@orpc/contract';
+export { PopulateContractRouterPathsOptions, PopulatedContractRouterPaths, populateContractRouterPaths } from '@orpc/contract';
+import { CreateProcedureClientOptions, Router, Context, BuilderConfig, Implementer } from '@orpc/server';
+export { ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ORPCError, ProcedureImplementer, RouterImplementer, RouterImplementerWithMiddlewares, onError, onFinish, onStart, onSuccess } from '@orpc/server';
+import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
+import { StandardOpenAPICodecOptions } from '@orpc/openapi/standard';
 import { StandardHandlerOptions } from '@orpc/server/standard';
-import { StandardLazyRequest } from '@standardserver/core';
-import { ToEventStreamOptions } from '@standardserver/node';
-import { HttpAdapterHost } from '@nestjs/core';
+import { Interceptor, Promisable } from '@orpc/shared';
+import { StandardResponse } from '@orpc/standard-server';
+import { SendStandardResponseOptions } from '@orpc/standard-server-node';
+import { Observable } from 'rxjs';
 declare const ORPC_MODULE_CONFIG_SYMBOL: unique symbol;
-interface NestStandardLazyRequest extends StandardLazyRequest {
-    /**
-     * Route parameters extracted from the request path.
-     */
-    params?: undefined | Record<string, string | string[]>;
+/**
+ * You can extend this interface to add global context properties.
+ * @example
+ * ```ts
+ * declare module '@orpc/nest' {
+ *   interface ORPCGlobalContext {
+ *     user: { id: string; name: string }
+ *   }
+ * }
+ * ```
+ */
+interface ORPCGlobalContext {
+}
+interface ORPCModuleConfig extends CreateProcedureClientOptions<ORPCGlobalContext, AnySchema, object, object, object>, SendStandardResponseOptions, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPICodecOptions {
+    plugins?: StandardHandlerOptions<ORPCGlobalContext>['plugins'];
+    sendResponseInterceptors?: Interceptor<{
+        request: any;
+        response: any;
+        standardResponse: StandardResponse;
+    }, unknown>[];
 }
-type ORPCModuleConfig = OpenAPIHandlerCodecCoreOptions<DefaultInitialContext> & StandardHandlerOptions<DefaultInitialContext> & (object extends DefaultInitialContext ? {
-    context?: Value<Promisable<DefaultInitialContext>, [ctx: ExecutionContext]>;
-} : {
-    context: Value<Promisable<DefaultInitialContext>, [ctx: ExecutionContext]>;
-}) & {
-    /**
-     * Customize how to convert NestJS `req` and `res` to {@link NestStandardLazyRequest}.
-     * You might need to define this if you are not using express or fastify adapters.
-     */
-    toNestStandardLazyRequest?: undefined | ((req: any, res: any) => NestStandardLazyRequest);
-    /**
-     * Options for how to convert the Standard Response to a Nest Response (returning value), like event stream options, etc.
-     */
-    toNestResponse?: undefined | {
-        /**
-         * Options for the event stream, like keep-alive settings, initial comment, etc.
-         */
-        eventStream?: undefined | ToEventStreamOptions;
-    };
-};
 declare class ORPCModule {
     static forRoot(config: ORPCModuleConfig): DynamicModule;
     static forRootAsync(options: {
@@ -45,15 +42,25 @@ declare class ORPCModule {
     }): DynamicModule;
 }
-declare function Implement<T extends RouterContract>(contract: T): <U extends Promisable<ContractedRouter<T, DefaultInitialContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
+/**
+ * Decorator in controller handler to implement a oRPC contract.
+ *
+ * @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
+ */
+declare function Implement<T extends ContractRouter<any>>(contract: T): <U extends Promisable<Router<T, ORPCGlobalContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
 declare class ImplementInterceptor implements NestInterceptor {
     private readonly config;
     private readonly codec;
-    private readonly toNestStandardLazyRequest;
-    private readonly httpAdapterHost;
-    constructor(config: ORPCModuleConfig | undefined, httpAdapterHost: HttpAdapterHost);
+    constructor(config: ORPCModuleConfig | undefined);
     intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
 }
-export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL };
-export type { NestStandardLazyRequest, ORPCModuleConfig };
+declare function toNestPattern(path: HTTPPath): string;
+/**
+ * Alias for `implement` from `@orpc/server` with default context set to `ORPCGlobalContext`
+ */
+declare function implement<T extends AnyContractRouter, TContext extends Context = ORPCGlobalContext>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
+export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
+export type { ORPCGlobalContext, ORPCModuleConfig };

package/dist/index.d.ts CHANGED Viewed

@@ -1,41 +1,38 @@
-import { ExecutionContext, DynamicModule, NestInterceptor, CallHandler } from '@nestjs/common';
-import { RouterContract } from '@orpc/contract';
-import { DefaultInitialContext, ContractedRouter } from '@orpc/server';
-import { Value, Promisable } from '@orpc/shared';
-import { Observable } from 'rxjs';
-import { OpenAPIHandlerCodecCoreOptions } from '@orpc/openapi/standard';
+import { AnySchema, ContractRouter, HTTPPath, AnyContractRouter } from '@orpc/contract';
+export { PopulateContractRouterPathsOptions, PopulatedContractRouterPaths, populateContractRouterPaths } from '@orpc/contract';
+import { CreateProcedureClientOptions, Router, Context, BuilderConfig, Implementer } from '@orpc/server';
+export { ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ORPCError, ProcedureImplementer, RouterImplementer, RouterImplementerWithMiddlewares, onError, onFinish, onStart, onSuccess } from '@orpc/server';
+import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions } from '@orpc/openapi-client/standard';
+import { StandardOpenAPICodecOptions } from '@orpc/openapi/standard';
 import { StandardHandlerOptions } from '@orpc/server/standard';
-import { StandardLazyRequest } from '@standardserver/core';
-import { ToEventStreamOptions } from '@standardserver/node';
-import { HttpAdapterHost } from '@nestjs/core';
+import { Interceptor, Promisable } from '@orpc/shared';
+import { StandardResponse } from '@orpc/standard-server';
+import { SendStandardResponseOptions } from '@orpc/standard-server-node';
+import { Observable } from 'rxjs';
 declare const ORPC_MODULE_CONFIG_SYMBOL: unique symbol;
-interface NestStandardLazyRequest extends StandardLazyRequest {
-    /**
-     * Route parameters extracted from the request path.
-     */
-    params?: undefined | Record<string, string | string[]>;
+/**
+ * You can extend this interface to add global context properties.
+ * @example
+ * ```ts
+ * declare module '@orpc/nest' {
+ *   interface ORPCGlobalContext {
+ *     user: { id: string; name: string }
+ *   }
+ * }
+ * ```
+ */
+interface ORPCGlobalContext {
+}
+interface ORPCModuleConfig extends CreateProcedureClientOptions<ORPCGlobalContext, AnySchema, object, object, object>, SendStandardResponseOptions, StandardOpenAPIJsonSerializerOptions, StandardBracketNotationSerializerOptions, StandardOpenAPICodecOptions {
+    plugins?: StandardHandlerOptions<ORPCGlobalContext>['plugins'];
+    sendResponseInterceptors?: Interceptor<{
+        request: any;
+        response: any;
+        standardResponse: StandardResponse;
+    }, unknown>[];
 }
-type ORPCModuleConfig = OpenAPIHandlerCodecCoreOptions<DefaultInitialContext> & StandardHandlerOptions<DefaultInitialContext> & (object extends DefaultInitialContext ? {
-    context?: Value<Promisable<DefaultInitialContext>, [ctx: ExecutionContext]>;
-} : {
-    context: Value<Promisable<DefaultInitialContext>, [ctx: ExecutionContext]>;
-}) & {
-    /**
-     * Customize how to convert NestJS `req` and `res` to {@link NestStandardLazyRequest}.
-     * You might need to define this if you are not using express or fastify adapters.
-     */
-    toNestStandardLazyRequest?: undefined | ((req: any, res: any) => NestStandardLazyRequest);
-    /**
-     * Options for how to convert the Standard Response to a Nest Response (returning value), like event stream options, etc.
-     */
-    toNestResponse?: undefined | {
-        /**
-         * Options for the event stream, like keep-alive settings, initial comment, etc.
-         */
-        eventStream?: undefined | ToEventStreamOptions;
-    };
-};
 declare class ORPCModule {
     static forRoot(config: ORPCModuleConfig): DynamicModule;
     static forRootAsync(options: {
@@ -45,15 +42,25 @@ declare class ORPCModule {
     }): DynamicModule;
 }
-declare function Implement<T extends RouterContract>(contract: T): <U extends Promisable<ContractedRouter<T, DefaultInitialContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
+/**
+ * Decorator in controller handler to implement a oRPC contract.
+ *
+ * @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
+ */
+declare function Implement<T extends ContractRouter<any>>(contract: T): <U extends Promisable<Router<T, ORPCGlobalContext>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
 declare class ImplementInterceptor implements NestInterceptor {
     private readonly config;
     private readonly codec;
-    private readonly toNestStandardLazyRequest;
-    private readonly httpAdapterHost;
-    constructor(config: ORPCModuleConfig | undefined, httpAdapterHost: HttpAdapterHost);
+    constructor(config: ORPCModuleConfig | undefined);
     intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
 }
-export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL };
-export type { NestStandardLazyRequest, ORPCModuleConfig };
+declare function toNestPattern(path: HTTPPath): string;
+/**
+ * Alias for `implement` from `@orpc/server` with default context set to `ORPCGlobalContext`
+ */
+declare function implement<T extends AnyContractRouter, TContext extends Context = ORPCGlobalContext>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
+export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };
+export type { ORPCGlobalContext, ORPCModuleConfig };

package/dist/index.mjs CHANGED Viewed

@@ -1,14 +1,15 @@
-import { Readable } from 'node:stream';
-import { Module, applyDecorators, Options, Delete, Patch, Put, Post, Get, Head, HttpCode, UseInterceptors, StreamableFile, HttpException, Injectable, Inject, Optional } from '@nestjs/common';
-import { HttpAdapterHost } from '@nestjs/core';
-import { ProcedureContract, getPathMeta } from '@orpc/contract';
-import { getOpenAPIMeta, DEFAULT_OPENAPI_METHOD, getDynamicPathParams } from '@orpc/openapi';
-import { OpenAPIHandlerCodecCore } from '@orpc/openapi/standard';
-import { DEFAULT_SUCCESS_STATUS, getRouter, unlazy, Procedure } from '@orpc/server';
+import { getRouter, unlazy, isProcedure, implement as implement$1 } from '@orpc/server';
+export { ORPCError, onError, onFinish, onStart, onSuccess } from '@orpc/server';
+import { Module, applyDecorators, Options, Delete, Patch, Put, Post, Get, Head, HttpCode, UseInterceptors, Injectable, Inject, Optional } from '@nestjs/common';
+import { isContractProcedure, fallbackContractConfig } from '@orpc/contract';
+export { populateContractRouterPaths } from '@orpc/contract';
+import { standardizeHTTPPath, StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
+import { StandardOpenAPICodec } from '@orpc/openapi/standard';
 import { StandardHandler } from '@orpc/server/standard';
-import { mergeHttpPath, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
-import { flattenStandardHeader, generateContentDisposition } from '@standardserver/core';
-import { toStandardLazyRequest, toEventStream } from '@standardserver/node';
+import { get, toArray, intercept } from '@orpc/shared';
+import * as StandardServerFastify from '@orpc/standard-server-fastify';
+import * as StandardServerFetch from '@orpc/standard-server-fetch';
+import * as StandardServerNode from '@orpc/standard-server-node';
 import { mergeMap } from 'rxjs';
 var __getOwnPropDesc$1 = Object.getOwnPropertyDescriptor;
@@ -19,7 +20,7 @@ var __decorateClass$1 = (decorators, target, key, kind) => {
       result = (decorator(result)) || result;
   return result;
 };
-const ORPC_MODULE_CONFIG_SYMBOL = Symbol.for("ORPC_NEST_MODULE_CONFIG");
+const ORPC_MODULE_CONFIG_SYMBOL = Symbol("ORPC_MODULE_CONFIG");
 let ORPCModule = class {
   static forRoot(config) {
     return {
@@ -56,6 +57,10 @@ ORPCModule = __decorateClass$1([
   Module({})
 ], ORPCModule);
+function toNestPattern(path) {
+  return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/*$1").replace(/\/\{([^}]+)\}/g, "/:$1");
+}
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __decorateClass = (decorators, target, key, kind) => {
   var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
@@ -75,22 +80,20 @@ const MethodDecoratorMap = {
   OPTIONS: Options
 };
 function Implement(contract) {
-  if (contract instanceof ProcedureContract) {
-    const meta = getOpenAPIMeta(contract);
-    if (meta?.path === void 0) {
-      throw new TypeError(`
-        @Implement decorator requires contract to have a 'openapi.path' meta.
-        Please define one using '.meta(openapi({ path: '/example' }))'.
-        Or use "populateRouterContractOpenAPIPaths" from "@orpc/openapi" utility to automatically fill in any missing paths.
+  if (isContractProcedure(contract)) {
+    const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
+    const path = contract["~orpc"].route.path;
+    if (path === void 0) {
+      throw new Error(`
+        @Implement decorator requires contract to have a 'path'.
+        Please define one using 'path' property on the '.route' method.
+        Or use "populateContractRouterPaths" from "@orpc/contract" utility to automatically fill in any missing paths.
       `);
     }
-    const method = meta.method ?? DEFAULT_OPENAPI_METHOD;
-    const path = toNestPattern(meta.prefix ? mergeHttpPath(meta.prefix, meta.path) : meta.path);
-    const successStatus = meta.successStatus ?? DEFAULT_SUCCESS_STATUS;
     return (target, propertyKey, descriptor) => {
       applyDecorators(
-        MethodDecoratorMap[method](path),
-        HttpCode(successStatus),
+        MethodDecoratorMap[method](toNestPattern(path)),
+        HttpCode(fallbackContractConfig("defaultSuccessStatus", contract["~orpc"].route.successStatus)),
         UseInterceptors(ImplementInterceptor)
       )(target, propertyKey, descriptor);
     };
@@ -112,118 +115,74 @@ function Implement(contract) {
       for (const p of Reflect.getOwnMetadataKeys(target.constructor, propertyKey)) {
         Reflect.defineMetadata(p, Reflect.getOwnMetadata(p, target.constructor, propertyKey), target.constructor, methodName);
       }
-      Implement(contract[key])(target, methodName, Object.getOwnPropertyDescriptor(target, methodName));
+      Implement(get(contract, [key]))(target, methodName, Object.getOwnPropertyDescriptor(target, methodName));
     }
   };
 }
 let ImplementInterceptor = class {
   config;
   codec;
-  toNestStandardLazyRequest;
-  httpAdapterHost;
-  constructor(config, httpAdapterHost) {
+  constructor(config) {
     this.config = config ?? {};
-    this.httpAdapterHost = httpAdapterHost;
-    this.codec = new OpenAPIHandlerCodecCore(this.config);
-    this.toNestStandardLazyRequest = this.config.toNestStandardLazyRequest ?? ((req, res) => {
-      const standardRequest = toStandardLazyRequest(
-        "raw" in req ? req.raw : req,
-        "raw" in res ? res.raw : res
-      );
-      if (req.body !== void 0) {
-        standardRequest.resolveBody = () => Promise.resolve(req.body);
-      }
-      standardRequest.params = req.params;
-      return standardRequest;
-    });
+    this.codec = new StandardOpenAPICodec(
+      new StandardOpenAPISerializer(
+        new StandardOpenAPIJsonSerializer(this.config),
+        new StandardBracketNotationSerializer(this.config)
+      ),
+      this.config
+    );
   }
   intercept(ctx, next) {
     return next.handle().pipe(
       mergeMap(async (impl) => {
         const { default: procedure } = await unlazy(impl);
-        if (!(procedure instanceof Procedure)) {
-          throw new TypeError(`
+        if (!isProcedure(procedure)) {
+          throw new Error(`
             The return value of the @Implement controller handler must be a corresponding implemented router or procedure.
           `);
         }
         const req = ctx.switchToHttp().getRequest();
         const res = ctx.switchToHttp().getResponse();
-        const standardRequest = this.toNestStandardLazyRequest(req, res);
-        const handler = new StandardHandler({
-          resolveProcedure: () => Promise.resolve({
-            path: getPathMeta(procedure) ?? [],
-            procedure,
-            decodeInput: () => this.codec.decodeInput({
-              procedure,
-              params: toORPCOpenAPIParams(procedure, standardRequest.params)
-            }, standardRequest)
-          }),
-          encodeError: this.codec.encodeError.bind(this.codec),
-          encodeOutput: this.codec.encodeOutput.bind(this.codec)
-        }, this.config);
+        const isHono = "finalized" in res && typeof res.newResponse === "function";
+        const isFastify = "raw" in req && !isHono;
+        const standardRequest = (() => {
+          if (isHono) {
+            return StandardServerFetch.toStandardLazyRequest(req.raw);
+          }
+          if (isFastify) {
+            return StandardServerFastify.toStandardLazyRequest(req, res);
+          }
+          return StandardServerNode.toStandardLazyRequest(req, res);
+        })();
+        const handler = new StandardHandler(procedure, {
+          init: () => {
+          },
+          match: () => Promise.resolve({ path: toArray(this.config.path), procedure, params: flattenParams(req.params) })
+        }, this.codec, {
+          // Since plugins can modify options directly, so we need to clone to avoid affecting other handlers/requests
+          // TODO: improve plugins system to avoid this cloning
+          clientInterceptors: [...toArray(this.config.interceptors)],
+          plugins: [...toArray(this.config.plugins)]
+        });
         const result = await handler.handle(standardRequest, {
-          context: await value(this.config.context ?? {}, ctx)
+          context: this.config.context
         });
-        if (!result.matched) {
-          throw new TypeError(
-            "oRPC NestJS handler returned an unmatched result, which should never happen. Please check your plugins/interceptors or report a bug."
-          );
-        }
-        const httpAdapter = this.httpAdapterHost.httpAdapter;
-        httpAdapter.status(res, result.response.status);
-        for (const key in result.response.headers) {
-          const value2 = result.response.headers[key];
-          if (typeof value2 === "string") {
-            httpAdapter.setHeader(res, key, value2);
-          } else {
-            value2?.forEach((value3, index) => {
-              if (index === 0) {
-                httpAdapter.setHeader(res, key, value3);
+        if (result.matched) {
+          return intercept(
+            toArray(this.config.sendResponseInterceptors),
+            { request: req, response: res, standardResponse: result.response },
+            async ({ response, standardResponse }) => {
+              if (isHono) {
+                const fetchResponse = StandardServerFetch.toFetchResponse(standardResponse, this.config);
+                return response.newResponse(fetchResponse.body, fetchResponse);
+              } else if (isFastify) {
+                await StandardServerFastify.sendStandardResponse(response, standardResponse, this.config);
               } else {
-                httpAdapter.appendHeader(res, key, value3);
+                await StandardServerNode.sendStandardResponse(response, standardResponse, this.config);
               }
-            });
-          }
-        }
-        const body = result.response.body;
-        if (body instanceof ReadableStream) {
-          httpAdapter.setHeader(res, "standard-server", "octet-stream");
-          return new StreamableFile(Readable.fromWeb(body), {
-            type: flattenStandardHeader(result.response.headers["content-type"]) ?? "application/octet-stream"
-          });
-        }
-        if (isAsyncIteratorObject(body)) {
-          return new StreamableFile(toEventStream(body, this.config.toNestResponse?.eventStream), {
-            type: "text/event-stream"
-          });
-        }
-        if (body instanceof Blob) {
-          httpAdapter.setHeader(res, "standard-server", "file");
-          return new StreamableFile(Readable.fromWeb(body.stream()), {
-            type: body.type,
-            disposition: flattenStandardHeader(result.response.headers["content-disposition"]) ?? generateContentDisposition(body instanceof File ? body.name : "blob"),
-            // BunS3 can use NaN for the size
-            length: Number.isFinite(body.size) ? body.size : void 0
-          });
-        }
-        if (body instanceof FormData) {
-          const response = new Response(body);
-          return new StreamableFile(Readable.fromWeb(response.body), {
-            type: response.headers.get("content-type")
-          });
-        }
-        if (body instanceof URLSearchParams) {
-          httpAdapter.setHeader(res, "content-type", "application/x-www-form-urlencoded");
-          return body.toString();
-        }
-        if (body === void 0) {
-          return body;
-        }
-        if (result.response.status >= 300 && typeof body === "object" && body !== null && !Array.isArray(body)) {
-          throw new HttpException(body, result.response.status);
+            }
+          );
         }
-        httpAdapter.setHeader(res, "content-type", "application/json");
-        return typeof body === "string" || body === null ? stringifyJSON(body) : body;
       })
     );
   }
@@ -231,41 +190,22 @@ let ImplementInterceptor = class {
 ImplementInterceptor = __decorateClass([
   Injectable(),
   __decorateParam(0, Inject(ORPC_MODULE_CONFIG_SYMBOL)),
-  __decorateParam(0, Optional()),
-  __decorateParam(1, Inject(HttpAdapterHost))
+  __decorateParam(0, Optional())
 ], ImplementInterceptor);
-function flattenParamValue(value2) {
-  return Array.isArray(value2) ? value2.join("/") : value2;
-}
-function toORPCOpenAPIParams(contract, params) {
-  const meta = getOpenAPIMeta(contract);
-  if (!params || meta?.path === void 0) {
-    return void 0;
-  }
-  const dynamicParams = getDynamicPathParams(meta.prefix ? mergeHttpPath(meta.prefix, meta.path) : meta.path);
-  if (!dynamicParams) {
-    return void 0;
-  }
-  return dynamicParams.reduce((acc, config) => {
-    const value2 = config.allowsSlash ? flattenParamValue(params?.["*"] ?? params?.path) : flattenParamValue(params?.[config.parameterName]);
-    if (value2 === void 0) {
-      return acc;
+function flattenParams(params) {
+  const flatten = {};
+  for (const [key, value] of Object.entries(params ?? {})) {
+    if (Array.isArray(value)) {
+      flatten[key] = value.join("/");
+    } else {
+      flatten[key] = value;
     }
-    acc[config.parameterName] = value2;
-    return acc;
-  }, {});
-}
-function toNestPattern(path) {
-  const params = getDynamicPathParams(path);
-  if (!params?.length) {
-    return path;
   }
-  for (let i = params.length - 1; i >= 0; i--) {
-    const param = params[i];
-    const pattern = param.allowsSlash ? `*` : `:${param.parameterName}`;
-    path = path.slice(0, param.startIndex) + pattern + path.slice(param.startIndex + param.segment.length);
-  }
-  return path;
+  return flatten;
+}
+function implement(contract, config = {}) {
+  return implement$1(contract, config);
 }
-export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL };
+export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, toNestPattern };

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/nest",
   "type": "module",
-  "version": "1.14.11",
+  "version": "1.14.13",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -9,9 +9,11 @@
     "url": "git+https://github.com/middleapi/orpc.git",
     "directory": "packages/nest"
   },
+  "keywords": [
+    "orpc"
+  ],
   "sideEffects": false,
   "exports": {
-    "./package.json": "./package.json",
     ".": {
       "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs",
@@ -22,11 +24,11 @@
     "dist"
   ],
   "peerDependencies": {
-    "@nestjs/common": ">=11.1.27",
-    "@nestjs/core": ">=11.1.27",
-    "express": ">=5.2.1",
-    "fastify": ">=5.8.5",
-    "rxjs": ">=7.8.2"
+    "@nestjs/common": ">=11.0.0",
+    "@nestjs/core": ">=11.0.0",
+    "express": ">=5.0.0",
+    "fastify": ">=5.0.0",
+    "rxjs": ">=7.0.0"
   },
   "peerDependenciesMeta": {
     "express": {
@@ -37,28 +39,39 @@
     }
   },
   "dependencies": {
-    "@standardserver/core": "^0.5.0",
-    "@standardserver/node": "^0.5.0",
-    "@orpc/client": "1.14.11",
-    "@orpc/openapi": "1.14.11",
-    "@orpc/contract": "1.14.11",
-    "@orpc/server": "1.14.11",
-    "@orpc/shared": "1.14.11"
+    "@orpc/client": "1.14.13",
+    "@orpc/contract": "1.14.13",
+    "@orpc/openapi-client": "1.14.13",
+    "@orpc/shared": "1.14.13",
+    "@orpc/server": "1.14.13",
+    "@orpc/openapi": "1.14.13",
+    "@orpc/standard-server-fastify": "1.14.13",
+    "@orpc/standard-server-fetch": "1.14.13",
+    "@orpc/standard-server": "1.14.13",
+    "@orpc/standard-server-node": "1.14.13"
   },
   "devDependencies": {
     "@fastify/cookie": "^11.0.2",
-    "@nestjs/common": "^11.1.27",
-    "@nestjs/core": "^11.1.27",
-    "@nestjs/platform-express": "^11.1.27",
-    "@nestjs/platform-fastify": "^11.1.27",
-    "@nestjs/testing": "^11.1.27",
+    "@hono/node-server": "^1.19.11",
+    "@mnigos/platform-hono": "^0.1.3",
+    "@nestjs/common": "^11.1.16",
+    "@nestjs/core": "^11.1.16",
+    "@nestjs/platform-express": "^11.1.16",
+    "@nestjs/platform-fastify": "^11.1.16",
+    "@nestjs/testing": "^11.1.16",
+    "@ts-rest/core": "^3.52.1",
     "@types/express": "^5.0.6",
     "express": "^5.2.1",
-    "fastify": "^5.8.5",
-    "rxjs": "^7.8.2"
+    "fastify": "^5.8.3",
+    "hono": "^4.10.7",
+    "rxjs": "^7.8.2",
+    "supertest": "^7.1.4",
+    "zod": "^4.3.6"
   },
   "scripts": {
     "build": "unbuild",
-    "type:check": "tsc -b"
+    "build:watch": "pnpm run build --watch",
+    "type:check": "tsc -b",
+    "type:check:test": "tsc -p tsconfig.test.json --noEmit"
   }
 }