@byyuurin/nitro-openapi 0.0.7 → 0.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) Yuurin<https://github.com/byyuurin>
-
-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.
+MIT License
+
+Copyright (c) Yuurin<https://github.com/byyuurin>
+
+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/README.md

@@ -25,8 +25,8 @@ Create nitor plugin:
 
 ```ts
 // plugins/swagger.ts
+import type { OpenAPI3 } from '@byyuurin/nitro-openapi'
 import { createOpenApiRegister } from '@byyuurin/nitro-openapi'
-import type { OpenAPI3 } from 'openapi-typescript'
 
 export const { register, merge, configExtends } = createOpenApiRegister({
   // ...
@@ -64,7 +64,7 @@ type RouteMeta = OperationType<typeof configExtends> & {
   method?: keyof PathOperation
 }
 
-export function defineApiRouteMeta(
+export function defineApiResponse(
   route: keyof InternalApi,
   meta: RouteMeta,
 ) {
@@ -78,7 +78,7 @@ Then use the register
 ```ts
 // route/**/*.ts
 
-defineApiRouteMeta('/api/...', {
+defineApiResponse('/api/...', {
   /* ... */
 })
 

package/dist/index.cjs

@@ -10,11 +10,11 @@ function createOpenApiRegister(options) {
   const { paths = {}, components = {}, security = [], servers = [], info, tags = [] } = options;
   const defineOperation = (operation) => operation;
   function register(route, routeOperation, method = "get") {
-    const _route = normalizeRoute(route);
-    paths[_route] = defu__default(
-      { [method]: routeOperation },
-      paths[_route]
-    );
+    const path = normalizeRoute(route);
+    paths[path] = {
+      ...paths[path],
+      [method]: routeOperation
+    };
   }
   function merge(config) {
     return mergeConfig(
@@ -49,33 +49,31 @@ function normalizeRoute(_route) {
   return route;
 }
 function mergeConfig(defaults, appends) {
-  const methods = /* @__PURE__ */ new Set(["delete", "get", "head", "options", "patch", "post", "put", "trace"]);
   const { info } = appends;
-  const { paths = {} } = defaults;
+  const { openapi, servers, security, tags, paths = {} } = defaults;
   for (const path in paths) {
     const operations = paths[path];
+    const operationsAppend = appends.paths?.[path] ?? {};
+    if ("$ref" in operationsAppend) {
+      paths[path] = operationsAppend;
+      continue;
+    }
     if ("$ref" in operations)
       continue;
-    paths[path] = Object.fromEntries(Object.entries(operations).map(([key, obj]) => {
-      if (methods.has(key))
-        return [key, normalizeSchema(obj)];
-      return [key, obj];
+    paths[path] = Object.fromEntries(Object.entries(operations).map(([method, operation]) => {
+      const extendOperation = operationsAppend[method] ?? {};
+      return [method, defu__default(operation, extendOperation)];
     }));
   }
-  return defu__default({ info }, defaults, appends);
-}
-function normalizeSchema(obj) {
-  if ("$ref" in obj)
-    return obj;
-  const { parameters = [] } = obj;
-  obj.parameters = parameters.map((p) => {
-    if ("$ref" in p)
-      return p;
-    return defu__default(p, {
-      schema: { type: "string" }
-    });
-  });
-  return obj;
+  return {
+    openapi,
+    info,
+    servers,
+    security,
+    tags,
+    ...defu__default(defaults, appends),
+    paths
+  };
 }
 
 function toExampleSchema(example, description, options = {}) {