hono-openapi 1.0.3 → 1.0.5

package/dist/index.cjs

@@ -32,7 +32,7 @@ const toOpenAPIPath = (path) => path.split("/").map((x) => {
 }).join("/");
 const capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 const generateOperationId = (route) => {
-  let operationId = route.method;
+  let operationId = route.method.toLowerCase();
   if (route.path === "/") return `${operationId}Index`;
   for (const segment of route.path.split("/")) {
     if (segment.charCodeAt(0) === 123) {
@@ -141,6 +141,7 @@ function removeExcludedPaths(paths, ctx) {
     if (isPathExcluded && !(key.includes("*") && !key.includes("{")) && isStaticFileExcluded && value != null) {
       for (const method of Object.keys(value)) {
         const schema = value[method];
+        if (schema == null) continue;
         if (key.includes("{")) {
           if (!schema.parameters) schema.parameters = [];
           const pathParameters = key.split("/").filter(
@@ -319,10 +320,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
             const result2 = await raw.schema.toOpenAPISchema();
             raw.schema = result2.schema;
             if (result2.components) {
-              components = {
-                ...components,
-                ...result2.components
-              };
+              components = mergeComponentsObjects(components, result2.components);
             }
           }
         }
@@ -381,9 +379,12 @@ function generateParameters(target, schema) {
       in: target === "param" ? "path" : target,
       name: key,
       // @ts-expect-error
-      schema: value,
-      required: schema.required?.includes(key)
+      schema: value
     };
+    const isRequired = schema.required?.includes(key);
+    if (isRequired) {
+      def.required = true;
+    }
     if (def.schema && "description" in def.schema && def.schema.description) {
       def.description = def.schema.description;
       def.schema.description = void 0;
@@ -395,7 +396,7 @@ function generateParameters(target, schema) {
 function mergeComponentsObjects(...components) {
   return components.reduce(
     (prev, component, index) => {
-      if (!component || index === 0) return prev;
+      if (component == null || index === 0) return prev;
       if (prev.schemas && Object.keys(prev.schemas).length > 0 || component.schemas && Object.keys(component.schemas).length > 0) {
         prev.schemas = {
           ...prev.schemas,
@@ -414,6 +415,14 @@ function mergeComponentsObjects(...components) {
   );
 }
 
+function loadVendor(vendor, fn) {
+  if (fn.toJSONSchema) {
+    standardJson.loadVendor(vendor, fn.toJSONSchema);
+  }
+  if (fn.toOpenAPISchema) {
+    standardOpenapi.loadVendor(vendor, fn.toOpenAPISchema);
+  }
+}
 function resolver(schema, options) {
   return {
     vendor: schema["~standard"].vendor,
@@ -480,6 +489,7 @@ exports.ALLOWED_METHODS = ALLOWED_METHODS;
 exports.describeResponse = describeResponse;
 exports.describeRoute = describeRoute;
 exports.generateSpecs = generateSpecs;
+exports.loadVendor = loadVendor;
 exports.openAPIRouteHandler = openAPIRouteHandler;
 exports.registerSchemaPath = registerSchemaPath;
 exports.removeExcludedPaths = removeExcludedPaths;

package/dist/index.d.cts

@@ -2,9 +2,11 @@ import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
 import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
 import { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
-import * as json_schema from 'json-schema';
 import { Hook } from '@hono/standard-validator';
+import { loadVendor as loadVendor$1 } from '@standard-community/standard-json';
+import { loadVendor as loadVendor$2 } from '@standard-community/standard-openapi';
 import { StatusCode } from 'hono/utils/http-status';
+import { JSONSchema7 } from 'json-schema';
 
 /** The Standard Schema interface. */
 interface StandardSchemaV1<Input = unknown, Output = Input> {
@@ -63,6 +65,10 @@ declare namespace StandardSchemaV1 {
     export {  };
 }
 
+declare function loadVendor(vendor: string, fn: {
+    toJSONSchema?: Parameters<typeof loadVendor$1>[1];
+    toOpenAPISchema?: Parameters<typeof loadVendor$2>[1];
+}): void;
 /**
  * Generate a resolver for a validation schema
  * @param schema Validation schema
@@ -71,7 +77,7 @@ declare namespace StandardSchemaV1 {
 declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, options?: Record<string, unknown>): {
     vendor: string;
     validate: (value: unknown) => StandardSchemaV1.Result<unknown> | Promise<StandardSchemaV1.Result<unknown>>;
-    toJSONSchema: () => Promise<json_schema.JSONSchema7>;
+    toJSONSchema: () => JSONSchema7 | Promise<JSONSchema7>;
     toOpenAPISchema: () => Promise<{
         schema: OpenAPIV3_1.SchemaObject;
         components: OpenAPIV3_1.ComponentsObject | undefined;
@@ -272,4 +278,4 @@ declare function generateSpecs<E extends Env = BlankEnv, P extends string = stri
     jsonSchemaDialect?: string;
 }>;
 
-export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SpecContext, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SpecContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.d.ts

@@ -2,9 +2,11 @@ import * as openapi_types from 'openapi-types';
 import { OpenAPIV3_1 } from 'openapi-types';
 import { Env, Input, Context, Next, MiddlewareHandler, ValidationTargets, Hono } from 'hono';
 import { TypedResponse, RouterRoute, ValidationTargets as ValidationTargets$1, BlankEnv, Input as Input$1, BlankInput, Schema, BlankSchema, MiddlewareHandler as MiddlewareHandler$1 } from 'hono/types';
-import * as json_schema from 'json-schema';
 import { Hook } from '@hono/standard-validator';
+import { loadVendor as loadVendor$1 } from '@standard-community/standard-json';
+import { loadVendor as loadVendor$2 } from '@standard-community/standard-openapi';
 import { StatusCode } from 'hono/utils/http-status';
+import { JSONSchema7 } from 'json-schema';
 
 /** The Standard Schema interface. */
 interface StandardSchemaV1<Input = unknown, Output = Input> {
@@ -63,6 +65,10 @@ declare namespace StandardSchemaV1 {
     export {  };
 }
 
+declare function loadVendor(vendor: string, fn: {
+    toJSONSchema?: Parameters<typeof loadVendor$1>[1];
+    toOpenAPISchema?: Parameters<typeof loadVendor$2>[1];
+}): void;
 /**
  * Generate a resolver for a validation schema
  * @param schema Validation schema
@@ -71,7 +77,7 @@ declare namespace StandardSchemaV1 {
 declare function resolver<Schema extends StandardSchemaV1>(schema: Schema, options?: Record<string, unknown>): {
     vendor: string;
     validate: (value: unknown) => StandardSchemaV1.Result<unknown> | Promise<StandardSchemaV1.Result<unknown>>;
-    toJSONSchema: () => Promise<json_schema.JSONSchema7>;
+    toJSONSchema: () => JSONSchema7 | Promise<JSONSchema7>;
     toOpenAPISchema: () => Promise<{
         schema: OpenAPIV3_1.SchemaObject;
         components: OpenAPIV3_1.ComponentsObject | undefined;
@@ -272,4 +278,4 @@ declare function generateSpecs<E extends Env = BlankEnv, P extends string = stri
     jsonSchemaDialect?: string;
 }>;
 
-export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SpecContext, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, type AllowedMethods, type DescribeRouteOptions, type GenerateSpecOptions, type HandlerUniqueProperty, type PromiseOr, type RegisterSchemaPathOptions, type ResolverReturnType, type SpecContext, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { sValidator } from '@hono/standard-validator';
-import { toJsonSchema } from '@standard-community/standard-json';
-import { toOpenAPISchema } from '@standard-community/standard-openapi';
+import { loadVendor as loadVendor$1, toJsonSchema } from '@standard-community/standard-json';
+import { loadVendor as loadVendor$2, toOpenAPISchema } from '@standard-community/standard-openapi';
 
 const uniqueSymbol = Symbol("openapi");
 const ALLOWED_METHODS = [
@@ -30,7 +30,7 @@ const toOpenAPIPath = (path) => path.split("/").map((x) => {
 }).join("/");
 const capitalize = (word) => word.charAt(0).toUpperCase() + word.slice(1);
 const generateOperationId = (route) => {
-  let operationId = route.method;
+  let operationId = route.method.toLowerCase();
   if (route.path === "/") return `${operationId}Index`;
   for (const segment of route.path.split("/")) {
     if (segment.charCodeAt(0) === 123) {
@@ -139,6 +139,7 @@ function removeExcludedPaths(paths, ctx) {
     if (isPathExcluded && !(key.includes("*") && !key.includes("{")) && isStaticFileExcluded && value != null) {
       for (const method of Object.keys(value)) {
         const schema = value[method];
+        if (schema == null) continue;
         if (key.includes("{")) {
           if (!schema.parameters) schema.parameters = [];
           const pathParameters = key.split("/").filter(
@@ -317,10 +318,7 @@ async function getSpec(middlewareHandler, defaultOptions) {
             const result2 = await raw.schema.toOpenAPISchema();
             raw.schema = result2.schema;
             if (result2.components) {
-              components = {
-                ...components,
-                ...result2.components
-              };
+              components = mergeComponentsObjects(components, result2.components);
             }
           }
         }
@@ -379,9 +377,12 @@ function generateParameters(target, schema) {
       in: target === "param" ? "path" : target,
       name: key,
       // @ts-expect-error
-      schema: value,
-      required: schema.required?.includes(key)
+      schema: value
     };
+    const isRequired = schema.required?.includes(key);
+    if (isRequired) {
+      def.required = true;
+    }
     if (def.schema && "description" in def.schema && def.schema.description) {
       def.description = def.schema.description;
       def.schema.description = void 0;
@@ -393,7 +394,7 @@ function generateParameters(target, schema) {
 function mergeComponentsObjects(...components) {
   return components.reduce(
     (prev, component, index) => {
-      if (!component || index === 0) return prev;
+      if (component == null || index === 0) return prev;
       if (prev.schemas && Object.keys(prev.schemas).length > 0 || component.schemas && Object.keys(component.schemas).length > 0) {
         prev.schemas = {
           ...prev.schemas,
@@ -412,6 +413,14 @@ function mergeComponentsObjects(...components) {
   );
 }
 
+function loadVendor(vendor, fn) {
+  if (fn.toJSONSchema) {
+    loadVendor$1(vendor, fn.toJSONSchema);
+  }
+  if (fn.toOpenAPISchema) {
+    loadVendor$2(vendor, fn.toOpenAPISchema);
+  }
+}
 function resolver(schema, options) {
   return {
     vendor: schema["~standard"].vendor,
@@ -474,4 +483,4 @@ function describeResponse(handler, responses, options) {
   });
 }
 
-export { ALLOWED_METHODS, describeResponse, describeRoute, generateSpecs, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };
+export { ALLOWED_METHODS, describeResponse, describeRoute, generateSpecs, loadVendor, openAPIRouteHandler, registerSchemaPath, removeExcludedPaths, resolver, uniqueSymbol, validator };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-openapi",
   "description": "OpenAPI schema generator for Hono",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -43,8 +43,8 @@
   },
   "peerDependencies": {
     "@hono/standard-validator": "^0.1.2",
-    "@standard-community/standard-json": "^0.3.0-rc.4",
-    "@standard-community/standard-openapi": "^0.2.0-rc.1",
+    "@standard-community/standard-json": "^0.3.1",
+    "@standard-community/standard-openapi": "^0.2.3",
     "@types/json-schema": "^7.0.15",
     "hono": "^4.8.3",
     "openapi-types": "^12.1.3"