@orpc/nest 1.11.3 → 1.12.1

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
+  <image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>
@@ -45,7 +45,7 @@
 
 ## Documentation
 
-You can find the full documentation [here](https://orpc.unnoq.com).
+You can find the full documentation [here](https://orpc.dev).
 
 ## Packages
 
@@ -66,11 +66,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 
 ## `@orpc/nest`
 
-Deeply integrate oRPC with [NestJS](https://nestjs.com/). Read the [documentation](https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest) for more information.
+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.unnoq.com/docs/contract-first/define-contract) in NestJS.
+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'

package/dist/index.d.mts

@@ -1,13 +1,36 @@
-import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
 import { AnySchema, ContractRouter, HTTPPath, AnyContractRouter, ContractProcedure } from '@orpc/contract';
-import { CreateProcedureClientOptions, Router } from '@orpc/server';
-export { ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ORPCError, ProcedureImplementer, RouterImplementer, RouterImplementerWithMiddlewares, implement, onError, onFinish, onStart, onSuccess } from '@orpc/server';
-import { Promisable } from '@orpc/shared';
-import { Observable } from 'rxjs';
+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 { 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 ORPCModuleConfig extends CreateProcedureClientOptions<object, AnySchema, object, object, object>, SendStandardResponseOptions {
+/**
+ * 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>[];
 }
 declare class ORPCModule {
     static forRoot(config: ORPCModuleConfig): DynamicModule;
@@ -21,11 +44,12 @@ declare class ORPCModule {
 /**
  * Decorator in controller handler to implement a oRPC contract.
  *
- * @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
+ * @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, Record<never, never>>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
+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;
     constructor(config: ORPCModuleConfig | undefined);
     intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
 }
@@ -43,9 +67,14 @@ interface PopulateContractRouterPathsOptions {
  * This utility automatically populates any missing paths
  * Using the router's keys + `/`.
  *
- * @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs}
+ * @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs}
  */
 declare function populateContractRouterPaths<T extends AnyContractRouter>(router: T, options?: PopulateContractRouterPathsOptions): PopulatedContractRouterPaths<T>;
 
-export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, populateContractRouterPaths, toNestPattern };
-export type { ORPCModuleConfig, PopulateContractRouterPathsOptions, PopulatedContractRouterPaths };
+/**
+ * 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, populateContractRouterPaths, toNestPattern };
+export type { ORPCGlobalContext, ORPCModuleConfig, PopulateContractRouterPathsOptions, PopulatedContractRouterPaths };

package/dist/index.d.ts

@@ -1,13 +1,36 @@
-import { DynamicModule, NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
 import { AnySchema, ContractRouter, HTTPPath, AnyContractRouter, ContractProcedure } from '@orpc/contract';
-import { CreateProcedureClientOptions, Router } from '@orpc/server';
-export { ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, ORPCError, ProcedureImplementer, RouterImplementer, RouterImplementerWithMiddlewares, implement, onError, onFinish, onStart, onSuccess } from '@orpc/server';
-import { Promisable } from '@orpc/shared';
-import { Observable } from 'rxjs';
+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 { 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 ORPCModuleConfig extends CreateProcedureClientOptions<object, AnySchema, object, object, object>, SendStandardResponseOptions {
+/**
+ * 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>[];
 }
 declare class ORPCModule {
     static forRoot(config: ORPCModuleConfig): DynamicModule;
@@ -21,11 +44,12 @@ declare class ORPCModule {
 /**
  * Decorator in controller handler to implement a oRPC contract.
  *
- * @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs}
+ * @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, Record<never, never>>>>(target: Record<PropertyKey, any>, propertyKey: string, descriptor: TypedPropertyDescriptor<(...args: any[]) => U>) => void;
+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;
     constructor(config: ORPCModuleConfig | undefined);
     intercept(ctx: ExecutionContext, next: CallHandler<any>): Observable<any>;
 }
@@ -43,9 +67,14 @@ interface PopulateContractRouterPathsOptions {
  * This utility automatically populates any missing paths
  * Using the router's keys + `/`.
  *
- * @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs}
+ * @see {@link https://orpc.dev/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs}
  */
 declare function populateContractRouterPaths<T extends AnyContractRouter>(router: T, options?: PopulateContractRouterPathsOptions): PopulatedContractRouterPaths<T>;
 
-export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, populateContractRouterPaths, toNestPattern };
-export type { ORPCModuleConfig, PopulateContractRouterPathsOptions, PopulatedContractRouterPaths };
+/**
+ * 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, populateContractRouterPaths, toNestPattern };
+export type { ORPCGlobalContext, ORPCModuleConfig, PopulateContractRouterPathsOptions, PopulatedContractRouterPaths };

package/dist/index.mjs

@@ -1,12 +1,11 @@
-import { Module, Injectable, Inject, Optional, applyDecorators, Delete, Patch, Put, Post, Get, Head, UseInterceptors } from '@nestjs/common';
-import { toORPCError } from '@orpc/client';
+import { getRouter, unlazy, isProcedure, implement as implement$1 } from '@orpc/server';
+export { ORPCError, onError, onFinish, onStart, onSuccess } from '@orpc/server';
+import { Module, Injectable, Inject, Optional, applyDecorators, Delete, Patch, Put, Post, Get, Head, HttpCode, UseInterceptors } from '@nestjs/common';
 import { isContractProcedure, ContractProcedure, fallbackContractConfig } from '@orpc/contract';
 import { standardizeHTTPPath, StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
 import { StandardOpenAPICodec } from '@orpc/openapi/standard';
-import { getRouter, unlazy, isProcedure, createProcedureClient, ORPCError } from '@orpc/server';
-export { ORPCError, implement, onError, onFinish, onStart, onSuccess } from '@orpc/server';
-import { toArray, get } from '@orpc/shared';
-import { flattenHeader } from '@orpc/standard-server';
+import { StandardHandler } from '@orpc/server/standard';
+import { toArray, get, intercept } from '@orpc/shared';
 import * as StandardServerFastify from '@orpc/standard-server-fastify';
 import * as StandardServerNode from '@orpc/standard-server-node';
 import { mergeMap } from 'rxjs';
@@ -112,6 +111,7 @@ function Implement(contract) {
     return (target, propertyKey, descriptor) => {
       applyDecorators(
         MethodDecoratorMap[method](toNestPattern(path)),
+        HttpCode(fallbackContractConfig("defaultSuccessStatus", contract["~orpc"].route.successStatus)),
         UseInterceptors(ImplementInterceptor)
       )(target, propertyKey, descriptor);
     };
@@ -137,15 +137,18 @@ function Implement(contract) {
     }
   };
 }
-const codec = new StandardOpenAPICodec(
-  new StandardOpenAPISerializer(
-    new StandardOpenAPIJsonSerializer(),
-    new StandardBracketNotationSerializer()
-  )
-);
 let ImplementInterceptor = class {
+  config;
+  codec;
   constructor(config) {
-    this.config = config;
+    this.config = config ?? {};
+    this.codec = new StandardOpenAPICodec(
+      new StandardOpenAPISerializer(
+        new StandardOpenAPIJsonSerializer(this.config),
+        new StandardBracketNotationSerializer(this.config)
+      ),
+      this.config
+    );
   }
   intercept(ctx, next) {
     return next.handle().pipe(
@@ -159,30 +162,31 @@ let ImplementInterceptor = class {
         const req = ctx.switchToHttp().getRequest();
         const res = ctx.switchToHttp().getResponse();
         const standardRequest = "raw" in req ? StandardServerFastify.toStandardLazyRequest(req, res) : StandardServerNode.toStandardLazyRequest(req, res);
-        const standardResponse = await (async () => {
-          let isDecoding = false;
-          try {
-            const client = createProcedureClient(procedure, this.config);
-            isDecoding = true;
-            const input = await codec.decode(standardRequest, flattenParams(req.params), procedure);
-            isDecoding = false;
-            const output = await client(input, {
-              signal: standardRequest.signal,
-              lastEventId: flattenHeader(standardRequest.headers["last-event-id"])
-            });
-            return codec.encode(output, procedure);
-          } catch (e) {
-            const error = isDecoding && !(e instanceof ORPCError) ? new ORPCError("BAD_REQUEST", {
-              message: `Malformed request. Ensure the request body is properly formatted and the 'Content-Type' header is set correctly.`,
-              cause: e
-            }) : toORPCError(e);
-            return codec.encodeError(error);
-          }
-        })();
-        if ("raw" in res) {
-          await StandardServerFastify.sendStandardResponse(res, standardResponse, this.config);
-        } else {
-          await StandardServerNode.sendStandardResponse(res, standardResponse, this.config);
+        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: this.config.context
+        });
+        if (result.matched) {
+          return intercept(
+            toArray(this.config.sendResponseInterceptors),
+            { request: req, response: res, standardResponse: result.response },
+            async ({ response, standardResponse }) => {
+              if ("raw" in response) {
+                await StandardServerFastify.sendStandardResponse(response, standardResponse, this.config);
+              } else {
+                await StandardServerNode.sendStandardResponse(response, standardResponse, this.config);
+              }
+            }
+          );
         }
       })
     );
@@ -205,4 +209,8 @@ function flattenParams(params) {
   return flatten;
 }
 
-export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, populateContractRouterPaths, toNestPattern };
+function implement(contract, config = {}) {
+  return implement$1(contract, config);
+}
+
+export { Implement as Impl, Implement, ImplementInterceptor, ORPCModule, ORPC_MODULE_CONFIG_SYMBOL, implement, populateContractRouterPaths, toNestPattern };

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@orpc/nest",
   "type": "module",
-  "version": "1.11.3",
+  "version": "1.12.1",
   "license": "MIT",
-  "homepage": "https://orpc.unnoq.com",
+  "homepage": "https://orpc.dev",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/unnoq/orpc.git",
@@ -39,23 +39,23 @@
     }
   },
   "dependencies": {
-    "@orpc/client": "1.11.3",
-    "@orpc/contract": "1.11.3",
-    "@orpc/openapi": "1.11.3",
-    "@orpc/openapi-client": "1.11.3",
-    "@orpc/server": "1.11.3",
-    "@orpc/shared": "1.11.3",
-    "@orpc/standard-server": "1.11.3",
-    "@orpc/standard-server-fastify": "1.11.3",
-    "@orpc/standard-server-node": "1.11.3"
+    "@orpc/contract": "1.12.1",
+    "@orpc/client": "1.12.1",
+    "@orpc/openapi": "1.12.1",
+    "@orpc/openapi-client": "1.12.1",
+    "@orpc/shared": "1.12.1",
+    "@orpc/standard-server": "1.12.1",
+    "@orpc/standard-server-fastify": "1.12.1",
+    "@orpc/server": "1.12.1",
+    "@orpc/standard-server-node": "1.12.1"
   },
   "devDependencies": {
     "@fastify/cookie": "^11.0.2",
-    "@nestjs/common": "^11.1.8",
-    "@nestjs/core": "^11.1.8",
-    "@nestjs/platform-express": "^11.1.8",
-    "@nestjs/platform-fastify": "^11.1.8",
-    "@nestjs/testing": "^11.1.8",
+    "@nestjs/common": "^11.1.9",
+    "@nestjs/core": "^11.1.9",
+    "@nestjs/platform-express": "^11.1.9",
+    "@nestjs/platform-fastify": "^11.1.9",
+    "@nestjs/testing": "^11.1.9",
     "@ts-rest/core": "^3.52.1",
     "@types/express": "^5.0.5",
     "express": "^5.0.0",