@orpc/openapi 1.13.14 → 1.14.0

package/README.md

@@ -125,22 +125,21 @@ If you find oRPC valuable and would like to support its development, you can do
 <table>
   <tr>
    <td align="center"><a href="https://github.com/hrmcdonald?ref=orpc" target="_blank" rel="noopener" title="Reece McDonald"><img src="https://avatars.githubusercontent.com/u/39349270?v=4" width="139" alt="Reece McDonald"/><br />Reece McDonald</a></td>
-   <td align="center"><a href="https://github.com/u1-liquid?ref=orpc" target="_blank" rel="noopener" title="あわわわとーにゅ"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&amp;v=4" width="139" alt="あわわわとーにゅ"/><br />あわわわとーにゅ</a></td>
    <td align="center"><a href="https://github.com/nicognaW?ref=orpc" target="_blank" rel="noopener" title="nk"><img src="https://avatars.githubusercontent.com/u/66731869?u=4699bda3a9092d3ec34fbd959450767bcc8b8b6d&amp;v=4" width="139" alt="nk"/><br />nk</a></td>
    <td align="center"><a href="https://github.com/supastarter?ref=orpc" target="_blank" rel="noopener" title="supastarter"><img src="https://avatars.githubusercontent.com/u/110960143?v=4" width="139" alt="supastarter"/><br />supastarter</a></td>
    <td align="center"><a href="https://github.com/divmgl?ref=orpc" target="_blank" rel="noopener" title="Dexter Miguel"><img src="https://avatars.githubusercontent.com/u/5452298?u=645993204be8696c085ecf0d228c3062efe2ed65&amp;v=4" width="139" alt="Dexter Miguel"/><br />Dexter Miguel</a></td>
    <td align="center"><a href="https://github.com/herrfugbaum?ref=orpc" target="_blank" rel="noopener" title="herrfugbaum"><img src="https://avatars.githubusercontent.com/u/12859776?u=644dc1666d0220bc0468eb0de3c56b919f635b16&amp;v=4" width="139" alt="herrfugbaum"/><br />herrfugbaum</a></td>
+   <td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&amp;v=4" width="139" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
   </tr>
   <tr>
-   <td align="center"><a href="https://github.com/ryota-murakami?ref=orpc" target="_blank" rel="noopener" title="Ryota Murakami"><img src="https://avatars.githubusercontent.com/u/5501268?u=599389e03340734325726ca3f8f423c021d47d7f&amp;v=4" width="139" alt="Ryota Murakami"/><br />Ryota Murakami</a></td>
    <td align="center"><a href="https://github.com/dcramer?ref=orpc" target="_blank" rel="noopener" title="David Cramer"><img src="https://avatars.githubusercontent.com/u/23610?v=4" width="139" alt="David Cramer"/><br />David Cramer</a></td>
    <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/happyboy2022?ref=orpc" target="_blank" rel="noopener" title="happyboy"><img src="https://avatars.githubusercontent.com/u/103669586?u=65b49c4b893ed3703909fbb3a7a22313f3f9c121&amp;v=4" width="139" alt="happyboy"/><br />happyboy</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/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="139" alt="Andrew Peters"/><br />Andrew Peters</a></td>
   </tr>
   <tr>
-   <td align="center"><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="139" alt="Andrew Peters"/><br />Andrew Peters</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/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="139" alt="Peter Adam"/><br />Peter Adam</a></td>
    <td align="center"><a href="https://github.com/yukimotochern?ref=orpc" target="_blank" rel="noopener" title="Chen, Zhi-Yuan"><img src="https://avatars.githubusercontent.com/u/20896173?u=945c33fc21725e4d566a0d02afc54b136ca1d67a&amp;v=4" width="139" alt="Chen, Zhi-Yuan"/><br />Chen, Zhi-Yuan</a></td>
@@ -176,6 +175,7 @@ If you find oRPC valuable and would like to support its development, you can do
 <p>
   <a href="https://github.com/MrMaxie?ref=orpc" target="_blank" rel="noopener" title="Maxie"><img src="https://avatars.githubusercontent.com/u/3857836?u=5e6b57973d4385d655663ffdd836e487856f2984&amp;v=4" width="32" height="32" alt="Maxie" /></a>
   <a href="https://github.com/Stijn-Timmer?ref=orpc" target="_blank" rel="noopener" title="Stijn Timmer"><img src="https://avatars.githubusercontent.com/u/100147665?u=106b2c18e9c98a61861b4ee7fc100f5b9906a6c9&amp;v=4" width="32" height="32" alt="Stijn Timmer" /></a>
+  <a href="https://github.com/u1-liquid?ref=orpc" target="_blank" rel="noopener" title="あわわわとーにゅ"><img src="https://avatars.githubusercontent.com/u/17376330?u=de3353804be889f009f7e0a1582daf04d0ab292d&amp;v=4" width="32" height="32" alt="あわわわとーにゅ" /></a>
   <a href="https://github.com/zuplo?ref=orpc" target="_blank" rel="noopener" title="Zuplo"><img src="https://avatars.githubusercontent.com/u/85497839?v=4" width="32" height="32" alt="Zuplo" /></a>
   <a href="https://github.com/motopods?ref=orpc" target="_blank" rel="noopener" title="motopods"><img src="https://avatars.githubusercontent.com/u/58200641?u=18833983d65b481ae90a4adec2373064ec58bcf3&amp;v=4" width="32" height="32" alt="motopods" /></a>
   <a href="https://github.com/franciscohermida?ref=orpc" target="_blank" rel="noopener" title="Francisco Hermida"><img src="https://avatars.githubusercontent.com/u/483242?u=bbcbc80eb9d8781ff401f7dafc3b59cd7bea0561&amp;v=4" width="32" height="32" alt="Francisco Hermida" /></a>

package/dist/adapters/aws-lambda/index.mjs

@@ -2,7 +2,7 @@ import { AwsLambdaHandler } from '@orpc/server/aws-lambda';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
-import { a as StandardOpenAPIHandler } from '../../shared/openapi.DIt-Z9W1.mjs';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.BB-W-NKv.mjs';
 import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';

package/dist/adapters/fastify/index.mjs

@@ -2,7 +2,7 @@ import { FastifyHandler } from '@orpc/server/fastify';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
-import { a as StandardOpenAPIHandler } from '../../shared/openapi.DIt-Z9W1.mjs';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.BB-W-NKv.mjs';
 import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';

package/dist/adapters/fetch/index.mjs

@@ -2,7 +2,7 @@ import { FetchHandler } from '@orpc/server/fetch';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
-import { a as StandardOpenAPIHandler } from '../../shared/openapi.DIt-Z9W1.mjs';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.BB-W-NKv.mjs';
 import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';

package/dist/adapters/node/index.mjs

@@ -2,7 +2,7 @@ import { NodeHttpHandler } from '@orpc/server/node';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
-import { a as StandardOpenAPIHandler } from '../../shared/openapi.DIt-Z9W1.mjs';
+import { a as StandardOpenAPIHandler } from '../../shared/openapi.BB-W-NKv.mjs';
 import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';

package/dist/adapters/standard/index.mjs

@@ -1,4 +1,4 @@
-export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.DIt-Z9W1.mjs';
+export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.BB-W-NKv.mjs';
 import '@orpc/openapi-client/standard';
 import '@orpc/server/standard';
 import '@orpc/client';

package/dist/index.d.mts

@@ -87,6 +87,7 @@ declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
  * @internal
  */
 declare function isAnySchema(schema: JSONSchema): boolean;
+declare function isNeverSchema(schema: JSONSchema): boolean;
 /**
  * @internal
  */
@@ -112,5 +113,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isNeverSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.d.ts

@@ -87,6 +87,7 @@ declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
  * @internal
  */
 declare function isAnySchema(schema: JSONSchema): boolean;
+declare function isNeverSchema(schema: JSONSchema): boolean;
 /**
  * @internal
  */
@@ -112,5 +113,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isNeverSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
 export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { c as customOpenAPIOperation } from './shared/openapi.CoREqFh3.mjs';
-export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, o as applySchemaOptionality, h as checkParamsSchema, q as expandArrayableSchema, p as expandUnionSchema, n as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, u as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, m as separateObjectSchema, s as simplifyComposedObjectJsonSchemasAndRefs, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.CoREqFh3.mjs';
+import { c as customOpenAPIOperation } from './shared/openapi.BwdtJjDu.mjs';
+export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, p as applySchemaOptionality, h as checkParamsSchema, u as expandArrayableSchema, q as expandUnionSchema, o as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, m as isNeverSchema, k as isObjectSchema, v as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, n as separateObjectSchema, s as simplifyComposedObjectJsonSchemasAndRefs, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.BwdtJjDu.mjs';
 import { createORPCErrorFromJson } from '@orpc/client';
 import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
 import { ORPCError, createRouterClient } from '@orpc/server';

package/dist/plugins/index.mjs

@@ -1,5 +1,5 @@
 import { stringifyJSON, once, value } from '@orpc/shared';
-import { O as OpenAPIGenerator } from '../shared/openapi.CoREqFh3.mjs';
+import { O as OpenAPIGenerator } from '../shared/openapi.BwdtJjDu.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';

package/dist/shared/{openapi.DIt-Z9W1.mjs → openapi.BB-W-NKv.mjs}

@@ -49,6 +49,13 @@ class StandardOpenAPICodec {
     const successStatus = fallbackContractConfig("defaultSuccessStatus", procedure["~orpc"].route.successStatus);
     const outputStructure = fallbackContractConfig("defaultOutputStructure", procedure["~orpc"].route.outputStructure);
     if (outputStructure === "compact") {
+      if (output instanceof ReadableStream) {
+        return {
+          status: successStatus,
+          headers: {},
+          body: output
+        };
+      }
       return {
         status: successStatus,
         headers: {},
@@ -68,6 +75,13 @@ class StandardOpenAPICodec {
           ${stringifyJSON(output)}
       `);
     }
+    if (output.body instanceof ReadableStream) {
+      return {
+        status: output.status ?? successStatus,
+        headers: output.headers ?? {},
+        body: output.body
+      };
+    }
     return {
       status: output.status ?? successStatus,
       headers: output.headers ?? {},

package/dist/shared/{openapi.CoREqFh3.mjs → openapi.BwdtJjDu.mjs}

@@ -108,11 +108,25 @@ function isAnySchema(schema) {
   if (schema === true) {
     return true;
   }
-  if (Object.keys(schema).every((k) => !LOGIC_KEYWORDS.includes(k))) {
+  if (Object.keys(schema).filter((v) => schema[v] !== void 0).every((k) => !LOGIC_KEYWORDS.includes(k))) {
     return true;
   }
   return false;
 }
+function isNeverSchema(schema) {
+  if (schema === false) {
+    return true;
+  }
+  if (typeof schema === "object" && schema.not !== void 0) {
+    if (schema.not === true) {
+      return true;
+    }
+    if (typeof schema.not === "object" && Object.keys(schema.not).length === 0) {
+      return true;
+    }
+  }
+  return false;
+}
 function separateObjectSchema(schema, separatedProperties) {
   if (Object.keys(schema).some(
     (k) => !["type", "properties", "required", "additionalProperties"].includes(k) && LOGIC_KEYWORDS.includes(k) && schema[k] !== void 0
@@ -128,7 +142,13 @@ function separateObjectSchema(schema, separatedProperties) {
     }
     return acc;
   }, {});
+  if (Object.keys(matched.properties).length === 0) {
+    matched.properties = void 0;
+  }
   matched.required = schema.required?.filter((key) => separatedProperties.includes(key));
+  if (matched.required?.length === 0) {
+    matched.required = void 0;
+  }
   matched.examples = schema.examples?.map((example) => {
     if (!isObject(example)) {
       return example;
@@ -140,11 +160,14 @@ function separateObjectSchema(schema, separatedProperties) {
       return acc;
     }, {});
   });
-  rest.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => !separatedProperties.includes(key)).reduce((acc, [key, value]) => {
+  rest.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => !separatedProperties.includes(key)).reduce((acc = {}, [key, value]) => {
     acc[key] = value;
     return acc;
-  }, {});
+  }, void 0);
   rest.required = schema.required?.filter((key) => !separatedProperties.includes(key));
+  if (rest.required?.length === 0) {
+    rest.required = void 0;
+  }
   rest.examples = schema.examples?.map((example) => {
     if (!isObject(example)) {
       return example;
@@ -255,7 +278,7 @@ function toOpenAPIContent(schema) {
       schema: toOpenAPISchema(file)
     };
   }
-  if (restSchema !== void 0) {
+  if (restSchema !== void 0 && !isAnySchema(restSchema) && !isNeverSchema(restSchema)) {
     content["application/json"] = {
       schema: toOpenAPISchema(restSchema)
     };
@@ -643,6 +666,7 @@ ${errors.join("\n\n")}`
         strategy: "input"
       }
     );
+    let omitResponseBody = false;
     if (isAnySchema(schema) && !dynamicParams?.length) {
       return;
     }
@@ -660,6 +684,7 @@ ${errors.join("\n\n")}`
         const [paramsSchema, rest] = separateObjectSchema(schema, dynamicParams);
         schema = rest;
         required = rest.required ? rest.required.length !== 0 : false;
+        omitResponseBody = !required && !rest.properties;
         if (!checkParamsSchema(paramsSchema, dynamicParams)) {
           throw error2;
         }
@@ -674,7 +699,7 @@ ${errors.join("\n\n")}`
         }
         ref.parameters ??= [];
         ref.parameters.push(...toOpenAPIParameters(schema, "query"));
-      } else {
+      } else if (!omitResponseBody) {
         ref.requestBody = {
           required,
           content: toOpenAPIContent(schema)
@@ -850,4 +875,4 @@ ${errors.join("\n\n")}`
   }
 }
 
-export { CompositeSchemaConverter as C, LOGIC_KEYWORDS as L, OpenAPIGenerator as O, applyCustomOpenAPIOperation as a, toOpenAPIMethod as b, customOpenAPIOperation as c, toOpenAPIContent as d, toOpenAPIEventIteratorContent as e, toOpenAPIParameters as f, getCustomOpenAPIOperation as g, checkParamsSchema as h, toOpenAPISchema as i, isFileSchema as j, isObjectSchema as k, isAnySchema as l, separateObjectSchema as m, filterSchemaBranches as n, applySchemaOptionality as o, expandUnionSchema as p, expandArrayableSchema as q, resolveOpenAPIJsonSchemaRef as r, simplifyComposedObjectJsonSchemasAndRefs as s, toOpenAPIPath as t, isPrimitiveSchema as u };
+export { CompositeSchemaConverter as C, LOGIC_KEYWORDS as L, OpenAPIGenerator as O, applyCustomOpenAPIOperation as a, toOpenAPIMethod as b, customOpenAPIOperation as c, toOpenAPIContent as d, toOpenAPIEventIteratorContent as e, toOpenAPIParameters as f, getCustomOpenAPIOperation as g, checkParamsSchema as h, toOpenAPISchema as i, isFileSchema as j, isObjectSchema as k, isAnySchema as l, isNeverSchema as m, separateObjectSchema as n, filterSchemaBranches as o, applySchemaOptionality as p, expandUnionSchema as q, resolveOpenAPIJsonSchemaRef as r, simplifyComposedObjectJsonSchemasAndRefs as s, toOpenAPIPath as t, expandArrayableSchema as u, isPrimitiveSchema as v };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "1.13.14",
+  "version": "1.14.0",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
@@ -55,13 +55,13 @@
   "dependencies": {
     "json-schema-typed": "^8.0.2",
     "rou3": "^0.7.12",
-    "@orpc/client": "1.13.14",
-    "@orpc/contract": "1.13.14",
-    "@orpc/interop": "1.13.14",
-    "@orpc/openapi-client": "1.13.14",
-    "@orpc/server": "1.13.14",
-    "@orpc/shared": "1.13.14",
-    "@orpc/standard-server": "1.13.14"
+    "@orpc/client": "1.14.0",
+    "@orpc/contract": "1.14.0",
+    "@orpc/server": "1.14.0",
+    "@orpc/shared": "1.14.0",
+    "@orpc/interop": "1.14.0",
+    "@orpc/openapi-client": "1.14.0",
+    "@orpc/standard-server": "1.14.0"
   },
   "devDependencies": {
     "fastify": "^5.8.3",