@orpc/openapi 0.0.3 → 0.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 oRPC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.js

@@ -1,7 +1,7 @@
 // src/generator.ts
 import { eachContractRouterLeaf } from "@orpc/contract";
 import { toContractRouter } from "@orpc/server";
-import { findDeepMatches, omit } from "@orpc/shared";
+import { findDeepMatches, isPlainObject, omit } from "@orpc/shared";
 import { preSerialize } from "@orpc/transformer";
 import {
   OpenApiBuilder
@@ -3949,20 +3949,16 @@ function zodToJsonSchema(schema, options) {
       return json;
     }
     case ZodFirstPartyTypeKind.ZodNaN: {
-      const schema_ = schema;
       return { const: "NaN" };
     }
     case ZodFirstPartyTypeKind.ZodBigInt: {
-      const schema_ = schema;
       const json = { type: "string", pattern: "^-?[0-9]+$" };
       return json;
     }
     case ZodFirstPartyTypeKind.ZodBoolean: {
-      const schema_ = schema;
       return { type: "boolean" };
     }
     case ZodFirstPartyTypeKind.ZodDate: {
-      const schema_ = schema;
       const jsonSchema = { type: "string", format: Format.Date };
       return jsonSchema;
     }
@@ -4230,10 +4226,10 @@ function generateOpenAPI(opts, options) {
     }
     const path = internal.path ?? `/${path_.map(encodeURIComponent).join("/")}`;
     const method = internal.method ?? "POST";
-    const inputSchema = internal.InputSchema ? zodToJsonSchema(internal.InputSchema, { mode: "input" }) : {};
+    let inputSchema = internal.InputSchema ? zodToJsonSchema(internal.InputSchema, { mode: "input" }) : {};
     const outputSchema = internal.OutputSchema ? zodToJsonSchema(internal.OutputSchema, { mode: "output" }) : {};
     const params = (() => {
-      const names = path.match(/{([^}]+)}/g);
+      const names = path.match(/\{([^}]+)\}/g);
       if (!names || !names.length) {
         return void 0;
       }
@@ -4243,9 +4239,9 @@ function generateOpenAPI(opts, options) {
         );
       }
       return names.map((raw) => raw.slice(1, -1)).map((name) => {
-        const schema = inputSchema.properties?.[name];
+        let schema = inputSchema.properties?.[name];
         const required = inputSchema.required?.includes(name);
-        if (!schema) {
+        if (schema === void 0) {
           throw new Error(
             `Parameter ${name} is missing in input schema [${path_.join(".")}]`
           );
@@ -4255,6 +4251,41 @@ function generateOpenAPI(opts, options) {
             `Parameter ${name} must be required in input schema [${path_.join(".")}]`
           );
         }
+        const examples = inputSchema.examples?.filter((example) => {
+          return isPlainObject(example) && name in example;
+        }).map((example) => {
+          return example[name];
+        });
+        schema = {
+          examples: examples?.length ? examples : void 0,
+          ...schema === true ? {} : schema === false ? UNSUPPORTED_JSON_SCHEMA : schema
+        };
+        inputSchema = {
+          ...inputSchema,
+          properties: inputSchema.properties ? Object.entries(inputSchema.properties).reduce(
+            (acc, [key, value]) => {
+              if (key !== name) {
+                acc[key] = value;
+              }
+              return acc;
+            },
+            {}
+          ) : void 0,
+          required: inputSchema.required?.filter((v) => v !== name),
+          examples: inputSchema.examples?.map((example) => {
+            if (!isPlainObject(example))
+              return example;
+            return Object.entries(example).reduce(
+              (acc, [key, value]) => {
+                if (key !== name) {
+                  acc[key] = value;
+                }
+                return acc;
+              },
+              {}
+            );
+          })
+        };
         return {
           name,
           in: "path",
@@ -4273,16 +4304,27 @@ function generateOpenAPI(opts, options) {
           `When method is GET, input schema must be an object [${path_.join(".")}]`
         );
       }
-      return Object.entries(inputSchema.properties ?? {}).filter(([name]) => !params?.find((param) => param.name === name)).map(([name, schema]) => {
-        return {
-          name,
-          in: "query",
-          style: "deepObject",
-          required: true,
-          schema,
-          example: internal.inputExample?.[name]
-        };
-      });
+      return Object.entries(inputSchema.properties ?? {}).map(
+        ([name, schema]) => {
+          const examples = inputSchema.examples?.filter((example) => {
+            return isPlainObject(example) && name in example;
+          }).map((example) => {
+            return example[name];
+          });
+          const schema_ = {
+            examples: examples?.length ? examples : void 0,
+            ...schema === true ? {} : schema === false ? UNSUPPORTED_JSON_SCHEMA : schema
+          };
+          return {
+            name,
+            in: "query",
+            style: "deepObject",
+            required: inputSchema?.required?.includes(name) ?? false,
+            schema: schema_,
+            example: internal.inputExample?.[name]
+          };
+        }
+      );
     })();
     const parameters = [...params ?? [], ...query ?? []];
     const requestBody = (() => {
@@ -4360,7 +4402,7 @@ function generateOpenAPI(opts, options) {
       parameters: parameters.length ? parameters : void 0,
       requestBody,
       responses: {
-        "200": successResponse
+        200: successResponse
       }
     };
     builder.addPath(path, {
@@ -4370,7 +4412,8 @@ function generateOpenAPI(opts, options) {
   return preSerialize(builder.getSpec());
 }
 function isFileSchema(schema) {
-  if (typeof schema !== "object" || schema === null) return false;
+  if (typeof schema !== "object" || schema === null)
+    return false;
   return "type" in schema && "contentMediaType" in schema && typeof schema.type === "string" && typeof schema.contentMediaType === "string";
 }
 export {