@orpc/server 1.8.0 → 1.8.1

package/dist/adapters/fetch/index.d.mts

@@ -57,6 +57,51 @@ declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T
     initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
 }
 
+/**
+ * This plugin is heavily inspired by the [Hono Compression Plugin](https://github.com/honojs/hono/blob/main/src/middleware/compress/index.ts)
+ */
+
+declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
+interface CompressionPluginOptions {
+    /**
+     * The compression schemes to use for response compression.
+     * Schemes are prioritized by their order in this array and
+     * only applied if the client supports them.
+     *
+     * @default ['gzip', 'deflate']
+     */
+    encodings?: readonly (typeof ORDERED_SUPPORTED_ENCODINGS)[number][];
+    /**
+     * The minimum response size in bytes required to trigger compression.
+     * Responses smaller than this threshold will not be compressed to avoid overhead.
+     * If the response size cannot be determined, compression will still be applied.
+     *
+     * @default 1024 (1KB)
+     */
+    threshold?: number;
+    /**
+     * Override the default content-type filter used to determine which responses should be compressed.
+     *
+     * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
+     * @default only responses with compressible content types are compressed.
+     */
+    filter?: (request: Request, response: Response) => boolean;
+}
+/**
+ * The Compression Plugin adds response compression to the Fetch Server.
+ * Build on top of [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
+ * You might need to polyfill it if your environment does not support it.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
+ */
+declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
+    private readonly encodings;
+    private readonly threshold;
+    private readonly filter;
+    constructor(options?: CompressionPluginOptions);
+    initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
+}
+
 type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
     /**
      * Enables or disables the StrictGetMethodPlugin.
@@ -75,5 +120,5 @@ declare class RPCHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
 }
 
-export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
-export type { BodyLimitPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
+export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };
+export type { BodyLimitPluginOptions, CompressionPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };

package/dist/adapters/fetch/index.d.ts

@@ -57,6 +57,51 @@ declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T
     initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
 }
 
+/**
+ * This plugin is heavily inspired by the [Hono Compression Plugin](https://github.com/honojs/hono/blob/main/src/middleware/compress/index.ts)
+ */
+
+declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
+interface CompressionPluginOptions {
+    /**
+     * The compression schemes to use for response compression.
+     * Schemes are prioritized by their order in this array and
+     * only applied if the client supports them.
+     *
+     * @default ['gzip', 'deflate']
+     */
+    encodings?: readonly (typeof ORDERED_SUPPORTED_ENCODINGS)[number][];
+    /**
+     * The minimum response size in bytes required to trigger compression.
+     * Responses smaller than this threshold will not be compressed to avoid overhead.
+     * If the response size cannot be determined, compression will still be applied.
+     *
+     * @default 1024 (1KB)
+     */
+    threshold?: number;
+    /**
+     * Override the default content-type filter used to determine which responses should be compressed.
+     *
+     * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
+     * @default only responses with compressible content types are compressed.
+     */
+    filter?: (request: Request, response: Response) => boolean;
+}
+/**
+ * The Compression Plugin adds response compression to the Fetch Server.
+ * Build on top of [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
+ * You might need to polyfill it if your environment does not support it.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
+ */
+declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
+    private readonly encodings;
+    private readonly threshold;
+    private readonly filter;
+    constructor(options?: CompressionPluginOptions);
+    initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
+}
+
 type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
     /**
      * Enables or disables the StrictGetMethodPlugin.
@@ -75,5 +120,5 @@ declare class RPCHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
 }
 
-export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
-export type { BodyLimitPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
+export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };
+export type { BodyLimitPluginOptions, CompressionPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };

package/dist/adapters/fetch/index.mjs

@@ -56,6 +56,75 @@ class BodyLimitPlugin {
   }
 }
 
+const ORDERED_SUPPORTED_ENCODINGS = ["gzip", "deflate"];
+class CompressionPlugin {
+  encodings;
+  threshold;
+  filter;
+  constructor(options = {}) {
+    this.encodings = options.encodings ?? ORDERED_SUPPORTED_ENCODINGS;
+    this.threshold = options.threshold ?? 1024;
+    this.filter = (request, response) => {
+      const hasContentDisposition = response.headers.has("content-disposition");
+      const contentType = response.headers.get("content-type");
+      if (!hasContentDisposition && contentType?.startsWith("text/event-stream")) {
+        return false;
+      }
+      return options.filter ? options.filter(request, response) : isCompressibleContentType(contentType);
+    };
+  }
+  initRuntimeAdapter(options) {
+    options.adapterInterceptors ??= [];
+    options.adapterInterceptors.unshift(async (options2) => {
+      const result = await options2.next();
+      if (!result.matched) {
+        return result;
+      }
+      const response = result.response;
+      if (response.headers.has("content-encoding") || response.headers.has("transfer-encoding") || isNoTransformCacheControl(response.headers.get("cache-control"))) {
+        return result;
+      }
+      const contentLength = response.headers.get("content-length");
+      if (contentLength && Number(contentLength) < this.threshold) {
+        return result;
+      }
+      const acceptEncoding = options2.request.headers.get("accept-encoding")?.split(",").map((enc) => enc.trim().split(";")[0]);
+      const encoding = this.encodings.find((enc) => acceptEncoding?.includes(enc));
+      if (!response.body || encoding === void 0) {
+        return result;
+      }
+      if (!this.filter(options2.request, response)) {
+        return result;
+      }
+      const compressedBody = response.body.pipeThrough(new CompressionStream(encoding));
+      const compressedHeaders = new Headers(response.headers);
+      compressedHeaders.delete("content-length");
+      compressedHeaders.set("content-encoding", encoding);
+      return {
+        ...result,
+        response: new Response(compressedBody, {
+          ...response,
+          headers: compressedHeaders
+        })
+      };
+    });
+  }
+}
+const COMPRESSIBLE_CONTENT_TYPE_REGEX = /^\s*(?:text\/(?!event-stream(?:[;\s]|$))[^;\s]+|application\/(?:javascript|json|xml|xml-dtd|ecmascript|dart|postscript|rtf|tar|toml|vnd\.dart|vnd\.ms-fontobject|vnd\.ms-opentype|wasm|x-httpd-php|x-javascript|x-ns-proxy-autoconfig|x-sh|x-tar|x-virtualbox-hdd|x-virtualbox-ova|x-virtualbox-ovf|x-virtualbox-vbox|x-virtualbox-vdi|x-virtualbox-vhd|x-virtualbox-vmdk|x-www-form-urlencoded)|font\/(?:otf|ttf)|image\/(?:bmp|vnd\.adobe\.photoshop|vnd\.microsoft\.icon|vnd\.ms-dds|x-icon|x-ms-bmp)|message\/rfc822|model\/gltf-binary|x-shader\/x-fragment|x-shader\/x-vertex|[^;\s]+?\+(?:json|text|xml|yaml))(?:[;\s]|$)/i;
+function isCompressibleContentType(contentType) {
+  if (contentType === null) {
+    return false;
+  }
+  return COMPRESSIBLE_CONTENT_TYPE_REGEX.test(contentType);
+}
+const CACHE_CONTROL_NO_TRANSFORM_REGEX = /(?:^|,)\s*no-transform\s*(?:,|$)/i;
+function isNoTransformCacheControl(cacheControl) {
+  if (cacheControl === null) {
+    return false;
+  }
+  return CACHE_CONTROL_NO_TRANSFORM_REGEX.test(cacheControl);
+}
+
 class CompositeFetchHandlerPlugin extends CompositeStandardHandlerPlugin {
   initRuntimeAdapter(options) {
     for (const plugin of this.plugins) {
@@ -107,4 +176,4 @@ class RPCHandler extends FetchHandler {
   }
 }
 
-export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
+export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };

package/dist/adapters/node/index.d.mts

@@ -3,6 +3,7 @@ import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
 import { SendStandardResponseOptions, NodeHttpRequest, NodeHttpResponse } from '@orpc/standard-server-node';
 import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.gqRxT-yN.mjs';
 import { F as FriendlyStandardHandleOptions } from '../../shared/server.BEFBl-Cb.mjs';
+import compression from '@orpc/interop/compression';
 import { S as StandardRPCHandlerOptions } from '../../shared/server.BU4WI18A.mjs';
 import '@orpc/client';
 import '@orpc/contract';
@@ -56,6 +57,26 @@ declare class BodyLimitPlugin<T extends Context> implements NodeHttpHandlerPlugi
     initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
 }
 
+interface CompressionPluginOptions extends compression.CompressionOptions {
+    /**
+     * Override the default content-type filter used to determine which responses should be compressed.
+     *
+     * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
+     * @default only responses with compressible content types are compressed.
+     */
+    filter?: (req: NodeHttpRequest, res: NodeHttpResponse) => boolean;
+}
+/**
+ * The Compression Plugin adds response compression to the Node.js HTTP Server.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
+ */
+declare class CompressionPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
+    private readonly compressionHandler;
+    constructor(options?: CompressionPluginOptions);
+    initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
+}
+
 type RPCHandlerOptions<T extends Context> = NodeHttpHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
     /**
      * Enables or disables the StrictGetMethodPlugin.
@@ -74,5 +95,5 @@ declare class RPCHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
 }
 
-export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, NodeHttpHandler, RPCHandler };
-export type { BodyLimitPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };
+export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, CompressionPlugin, NodeHttpHandler, RPCHandler };
+export type { BodyLimitPluginOptions, CompressionPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };

package/dist/adapters/node/index.d.ts

@@ -3,6 +3,7 @@ import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
 import { SendStandardResponseOptions, NodeHttpRequest, NodeHttpResponse } from '@orpc/standard-server-node';
 import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.Bmh5xd4n.js';
 import { F as FriendlyStandardHandleOptions } from '../../shared/server.B7b2w3_i.js';
+import compression from '@orpc/interop/compression';
 import { S as StandardRPCHandlerOptions } from '../../shared/server.D0H-iaY3.js';
 import '@orpc/client';
 import '@orpc/contract';
@@ -56,6 +57,26 @@ declare class BodyLimitPlugin<T extends Context> implements NodeHttpHandlerPlugi
     initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
 }
 
+interface CompressionPluginOptions extends compression.CompressionOptions {
+    /**
+     * Override the default content-type filter used to determine which responses should be compressed.
+     *
+     * @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
+     * @default only responses with compressible content types are compressed.
+     */
+    filter?: (req: NodeHttpRequest, res: NodeHttpResponse) => boolean;
+}
+/**
+ * The Compression Plugin adds response compression to the Node.js HTTP Server.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
+ */
+declare class CompressionPlugin<T extends Context> implements NodeHttpHandlerPlugin<T> {
+    private readonly compressionHandler;
+    constructor(options?: CompressionPluginOptions);
+    initRuntimeAdapter(options: NodeHttpHandlerOptions<T>): void;
+}
+
 type RPCHandlerOptions<T extends Context> = NodeHttpHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
     /**
      * Enables or disables the StrictGetMethodPlugin.
@@ -74,5 +95,5 @@ declare class RPCHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
 }
 
-export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, NodeHttpHandler, RPCHandler };
-export type { BodyLimitPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };
+export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, CompressionPlugin, NodeHttpHandler, RPCHandler };
+export type { BodyLimitPluginOptions, CompressionPluginOptions, NodeHttpHandleResult, NodeHttpHandlerInterceptorOptions, NodeHttpHandlerOptions, NodeHttpHandlerPlugin, RPCHandlerOptions };

package/dist/adapters/node/index.mjs

@@ -1,5 +1,6 @@
 import { ORPCError } from '@orpc/client';
-import { toArray, intercept, resolveMaybeOptionalOptions } from '@orpc/shared';
+import { once, toArray, intercept, resolveMaybeOptionalOptions } from '@orpc/shared';
+import compression from '@orpc/interop/compression';
 import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
 import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
 import '@orpc/standard-server';
@@ -19,14 +20,12 @@ class BodyLimitPlugin {
   initRuntimeAdapter(options) {
     options.adapterInterceptors ??= [];
     options.adapterInterceptors.push(async (options2) => {
-      let isHeaderChecked = false;
-      const checkHeader = () => {
-        if (!isHeaderChecked && Number(options2.request.headers["content-length"]) > this.maxBodySize) {
+      const checkHeader = once(() => {
+        if (Number(options2.request.headers["content-length"]) > this.maxBodySize) {
           throw new ORPCError("PAYLOAD_TOO_LARGE");
         }
-        isHeaderChecked = true;
-      };
-      const originalEmit = options2.request.emit.bind(options2.request);
+      });
+      const originalEmit = options2.request.emit;
       let currentBodySize = 0;
       options2.request.emit = (event, ...args) => {
         if (event === "data") {
@@ -36,9 +35,66 @@ class BodyLimitPlugin {
             throw new ORPCError("PAYLOAD_TOO_LARGE");
           }
         }
-        return originalEmit(event, ...args);
+        return originalEmit.call(options2.request, event, ...args);
       };
-      return options2.next();
+      try {
+        return await options2.next(options2);
+      } finally {
+        options2.request.emit = originalEmit;
+      }
+    });
+  }
+}
+
+class CompressionPlugin {
+  compressionHandler;
+  constructor(options = {}) {
+    this.compressionHandler = compression({
+      ...options,
+      filter: (req, res) => {
+        const hasContentDisposition = res.hasHeader("content-disposition");
+        const contentType = res.getHeader("content-type")?.toString();
+        if (!hasContentDisposition && contentType?.startsWith("text/event-stream")) {
+          return false;
+        }
+        return options.filter ? options.filter(req, res) : compression.filter(req, res);
+      }
+    });
+  }
+  initRuntimeAdapter(options) {
+    options.adapterInterceptors ??= [];
+    options.adapterInterceptors.unshift(async (options2) => {
+      let resolve;
+      let reject;
+      const promise = new Promise((res, rej) => {
+        resolve = res;
+        reject = rej;
+      });
+      const originalWrite = options2.response.write;
+      const originalEnd = options2.response.end;
+      const originalOn = options2.response.on;
+      this.compressionHandler(
+        options2.request,
+        options2.response,
+        async (err) => {
+          if (err) {
+            reject(err);
+          } else {
+            try {
+              resolve(await options2.next());
+            } catch (error) {
+              reject(error);
+            }
+          }
+        }
+      );
+      try {
+        return await promise;
+      } finally {
+        options2.response.write = originalWrite;
+        options2.response.end = originalEnd;
+        options2.response.on = originalOn;
+      }
     });
   }
 }
@@ -93,4 +149,4 @@ class RPCHandler extends NodeHttpHandler {
   }
 }
 
-export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, NodeHttpHandler, RPCHandler };
+export { BodyLimitPlugin, CompositeNodeHttpHandlerPlugin, CompressionPlugin, NodeHttpHandler, RPCHandler };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/server",
   "type": "module",
-  "version": "1.8.0",
+  "version": "1.8.1",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -102,14 +102,15 @@
   },
   "dependencies": {
     "cookie": "^1.0.2",
-    "@orpc/client": "1.8.0",
-    "@orpc/shared": "1.8.0",
-    "@orpc/standard-server": "1.8.0",
-    "@orpc/contract": "1.8.0",
-    "@orpc/standard-server-aws-lambda": "1.8.0",
-    "@orpc/standard-server-fetch": "1.8.0",
-    "@orpc/standard-server-node": "1.8.0",
-    "@orpc/standard-server-peer": "1.8.0"
+    "@orpc/client": "1.8.1",
+    "@orpc/contract": "1.8.1",
+    "@orpc/interop": "1.8.1",
+    "@orpc/shared": "1.8.1",
+    "@orpc/standard-server": "1.8.1",
+    "@orpc/standard-server-aws-lambda": "1.8.1",
+    "@orpc/standard-server-fetch": "1.8.1",
+    "@orpc/standard-server-peer": "1.8.1",
+    "@orpc/standard-server-node": "1.8.1"
   },
   "devDependencies": {
     "@types/ws": "^8.18.1",