hono-takibi 0.6.2 → 0.6.4

package/README.md

@@ -33,37 +33,6 @@ If you have OpenAPI specifications, Hono Takibi automates the conversion process
 npx hono-takibi path/to/openapi.yaml -o path/to/output_hono.ts
 ```
 
-## CLI
-
-### Options
-
-basic
-
-```bash
-Options:
-  --export-schema      exports all schema definitions
-  --export-type        exports all type definitions
-  --naming-case-type   PascalCase or camelCase
-  --naming-case-schema PascalCase or camelCase
-```
-
-template
-
-> **⚠️** When using the `-template` option, you must specify a valid directory path. Ensure the directory exists before executing the 
-
-```bash
-Options:
-  -template            generation of application and handler files
-  -test                automatic generation of test files
-  --base-path          base URL path for your API endpoints
-```
-
-### Example
-
-```bash
-npx hono-takibi openapi.yaml -o project/routes.ts -template -test --basePath 'api'
-```
-
 ## Demo 
 
 ![](https://raw.githubusercontent.com/nakita628/hono-takibi/refs/heads/main/assets/demo/hono-takibi.gif)
@@ -75,7 +44,11 @@ openapi: 3.1.0
 info:
   title: Hono API
   version: v1
-
+tags:
+  - name: Hono
+    description: Endpoints related to general Hono operations
+  - name: Post
+    description: Endpoints for creating, retrieving, updating, and deleting posts
 components:
   schemas:
     Error:
@@ -91,32 +64,21 @@ components:
         id:
           type: string
           format: uuid
-          description: Unique identifier of the post
         post:
           type: string
-          description: Content of the post
           minLength: 1
           maxLength: 140
         createdAt:
           type: string
           format: date-time
-          description: Timestamp when the post was created
         updatedAt:
           type: string
           format: date-time
-          description: Timestamp when the post was last updated
       required:
         - id
         - post
         - createdAt
         - updatedAt
-
-tags:
-  - name: Hono
-    description: Endpoints related to general Hono operations
-  - name: Post
-    description: Endpoints for creating, retrieving, updating, and deleting posts
-
 paths:
   /:
     get:
@@ -137,7 +99,6 @@ paths:
                     example: Hono🔥
                 required:
                   - message
-
   /posts:
     post:
       tags:
@@ -153,63 +114,52 @@ paths:
               properties:
                 post:
                   type: string
-                  description: Content of the post
                   minLength: 1
                   maxLength: 140
               required:
                 - post
-            example:
-              post: "This is my first post!"
       responses:
         '201':
           description: Post successfully created.
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Error'
-              example:
-                message: Created
+                type: object
+                properties:
+                  message:
+                    type: string
+                required:
+                  - message
         '400':
           description: Invalid request due to bad input.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: Post content is required and must be between 1 and 140 characters.
         '500':
           description: Internal server error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: An unexpected error occurred. Please try again later.
-
     get:
       tags:
         - Post
       summary: Retrieve a list of posts
-      description: Retrieve a paginated list of posts. Specify the page number and the number of posts per page.
+      description: >-
+        Retrieve a paginated list of posts. Specify the page number and the
+        number of posts per page.
       parameters:
-        - in: query
+        - schema:
+            type: string
+          required: true
           name: page
+          in: query
+        - schema:
+            type: string
           required: true
-          schema:
-            type: integer
-            minimum: 0
-            default: 1
-            example: 1
-          description: The page number to retrieve. Must be a positive integer. Defaults to 1.
-        - in: query
           name: rows
-          required: true
-          schema:
-            type: integer
-            minimum: 0
-            default: 10
-            example: 10
-          description: The number of posts per page. Must be a positive integer. Defaults to 10.
+          in: query
       responses:
         '200':
           description: Successfully retrieved a list of posts.
@@ -219,28 +169,18 @@ paths:
                 type: array
                 items:
                   $ref: '#/components/schemas/Post'
-              example:
-                - id: "123e4567-e89b-12d3-a456-426614174000"
-                  post: "Hello world!"
-                  createdAt: "2024-12-01T12:34:56Z"
-                  updatedAt: "2024-12-02T14:20:00Z"
         '400':
           description: Invalid request due to bad input.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: Invalid page or rows parameter. Both must be positive integers.
         '500':
           description: Internal server error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: An unexpected error occurred. Please try again later.
-
   /posts/{id}:
     put:
       tags:
@@ -248,13 +188,12 @@ paths:
       summary: Update an existing post
       description: Update the content of an existing post identified by its unique ID.
       parameters:
-        - in: path
-          name: id
-          required: true
-          schema:
+        - schema:
             type: string
             format: uuid
-          description: Unique identifier of the post.
+          required: true
+          name: id
+          in: path
       requestBody:
         required: true
         content:
@@ -264,13 +203,10 @@ paths:
               properties:
                 post:
                   type: string
-                  description: Updated content for the post
                   minLength: 1
                   maxLength: 140
               required:
                 - post
-            example:
-              post: "Updated post content."
       responses:
         '204':
           description: Post successfully updated.
@@ -280,31 +216,25 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: Post content is required and must be between 1 and 140 characters.
         '500':
           description: Internal server error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: An unexpected error occurred. Please try again later.
-
     delete:
       tags:
         - Post
       summary: Delete a post
       description: Delete an existing post identified by its unique ID.
       parameters:
-        - in: path
-          name: id
-          required: true
-          schema:
+        - schema:
             type: string
             format: uuid
             example: 123e4567-e89b-12d3-a456-426614174000
-          description: Unique identifier of the post.
+          required: true
+          name: id
+          in: path
       responses:
         '204':
           description: Post successfully deleted.
@@ -314,16 +244,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: Invalid post ID.
         '500':
           description: Internal server error.
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-              example:
-                message: An unexpected error occurred. Please try again later.
 ```
 
 output:
@@ -331,9 +257,9 @@ output:
 ```ts
 import { createRoute, z } from '@hono/zod-openapi'
 
-const ErrorSchema = z.object({ message: z.string() }).openapi('Error')
+const errorSchema = z.object({ message: z.string() }).openapi('Error')
 
-const PostSchema = z
+const postSchema = z
   .object({
     id: z.string().uuid(),
     post: z.string().min(1).max(140),
@@ -375,15 +301,15 @@ export const postPostsRoute = createRoute({
   responses: {
     201: {
       description: 'Post successfully created.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: z.object({ message: z.string() }) } },
     },
     400: {
       description: 'Invalid request due to bad input.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
     500: {
       description: 'Internal server error.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
   },
 })
@@ -395,24 +321,19 @@ export const getPostsRoute = createRoute({
   summary: 'Retrieve a list of posts',
   description:
     'Retrieve a paginated list of posts. Specify the page number and the number of posts per page.',
-  request: {
-    query: z.object({
-      page: z.string().pipe(z.coerce.number().int().min(0).default(1).openapi({ example: 1 })),
-      rows: z.string().pipe(z.coerce.number().int().min(0).default(10).openapi({ example: 10 })),
-    }),
-  },
+  request: { query: z.object({ page: z.string(), rows: z.string() }) },
   responses: {
     200: {
       description: 'Successfully retrieved a list of posts.',
-      content: { 'application/json': { schema: z.array(PostSchema) } },
+      content: { 'application/json': { schema: z.array(postSchema) } },
     },
     400: {
       description: 'Invalid request due to bad input.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
     500: {
       description: 'Internal server error.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
   },
 })
@@ -434,11 +355,11 @@ export const putPostsIdRoute = createRoute({
     204: { description: 'Post successfully updated.' },
     400: {
       description: 'Invalid input.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
     500: {
       description: 'Internal server error.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
   },
 })
@@ -464,16 +385,47 @@ export const deletePostsIdRoute = createRoute({
     204: { description: 'Post successfully deleted.' },
     400: {
       description: 'Invalid input.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
     500: {
       description: 'Internal server error.',
-      content: { 'application/json': { schema: ErrorSchema } },
+      content: { 'application/json': { schema: errorSchema } },
     },
   },
 })
 ```
 
+## CLI
+
+### Options
+
+basic
+
+```bash
+Options:
+  --export-schema      exports all schema definitions
+  --export-type        exports all type definitions
+  --naming-case-type   PascalCase or camelCase
+  --naming-case-schema PascalCase or camelCase
+```
+
+template
+
+> **⚠️** When using the `-template` option, you must specify a valid directory path. Ensure the directory exists before executing the 
+
+```bash
+Options:
+  -template            generation of application and handler files
+  -test                automatic generation of test files
+  --base-path          base URL path for your API endpoints
+```
+
+### Example
+
+```bash
+npx hono-takibi openapi.yaml -o project/routes.ts -template -test --basePath 'api'
+```
+
 ## Configuration
 
 You can customize the code generation behavior by creating a `hono-takibi.json` file in your project root.

package/dist/core/helper/get-to-safe-identifier-helper.d.ts

@@ -0,0 +1,6 @@
+/**
+ * getToSafeIdentifierHelper
+ * @param {string} str - The string to be converted to a safe identifier
+ * @returns {string} - A normalized, safe identifier
+ */
+export declare function getToSafeIdentifierHelper(str: string): string;

package/dist/core/helper/get-to-safe-identifier-helper.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getToSafeIdentifierHelper = getToSafeIdentifierHelper;
+/**
+ * getToSafeIdentifierHelper
+ * @param {string} str - The string to be converted to a safe identifier
+ * @returns {string} - A normalized, safe identifier
+ */
+function getToSafeIdentifierHelper(str) {
+    const trimmed = str.trim();
+    if (trimmed.includes('-')) {
+        return trimmed.replace(/\s*-\s*/g, '_');
+    }
+    return trimmed;
+}

package/dist/generator/zod/generate-zod-enum.js

@@ -20,13 +20,48 @@ function generateZodEnum(schema) {
     if (schema.type === 'number' && schema.enum) {
         return `z.literal(${schema.enum})`;
     }
+    // integer
+    if (schema.type === 'integer' && schema.enum) {
+        if (schema.enum.length > 1) {
+            const literals = schema.enum.map((value) => `z.literal(${value})`);
+            return `z.union([${literals}])`;
+        }
+        return `z.literal(${schema.enum[0]})`;
+    }
     // bigint
     if (schema.type === 'bigint' && schema.enum) {
-        return `z.literal(${schema.enum}n)`;
+        return `z.literal(${schema.enum})`;
+    }
+    // array
+    if (schema.type === 'array' && Array.isArray(schema.enum)) {
+        if (schema.enum.length === 1 && Array.isArray(schema.enum[0])) {
+            const tupleItems = schema.enum[0].map((item) => `z.literal(${item})`).join(', ');
+            return `z.tuple([${tupleItems}])`;
+        }
+        // union
+        const unionParts = schema.enum.map((value) => {
+            if (Array.isArray(value)) {
+                const tupleItems = value.map((item) => `z.literal(${item})`);
+                return `z.tuple([${tupleItems}])`;
+            }
+            return `z.literal(${value})`;
+        });
+        return `z.union([${unionParts}])`;
     }
     // boolean
     if (schema.type === 'boolean' && schema.enum) {
         return `z.literal(${schema.enum})`;
     }
-    return `z.enum(${JSON.stringify(schema.enum)})`;
+    // enum.length > 1
+    if (schema.enum.length > 1) {
+        const allStrings = schema.enum.every((v) => typeof v === 'string');
+        if (allStrings) {
+            return `z.enum(${JSON.stringify(schema.enum)})`;
+        }
+        const unionLiterals = schema.enum.map((value) => value === null
+            ? 'z.null()'
+            : `z.literal(${typeof value === 'string' ? `'${value}'` : value})`);
+        return `z.union([${unionLiterals}])`;
+    }
+    return `z.literal(${typeof schema.enum[0] === 'string' ? `'${schema.enum[0]}'` : schema.enum[0]})`;
 }

package/dist/generator/zod/generate-zod-number.js

@@ -51,11 +51,15 @@ function generateZodNumber(args) {
     }
     // nonpositive
     if (args.minimum === 0 && !args.exclusiveMinimum) {
-        validations.push('.nonpositive()');
+        if (!args.default) {
+            validations.push('.nonpositive()');
+        }
     }
     // negative
     if (args.maximum === 0 && args.exclusiveMaximum) {
-        validations.push('.negative()');
+        if (!args.default) {
+            validations.push('.negative()');
+        }
     }
     // gt
     if (args.minimum) {

package/dist/generator/zod/generate-zod.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateZod = generateZod;
-const generate_zod_array_1 = require("./generate-zod-array");
-const generate_zod_string_1 = require("./generate-zod-string");
 const is_format_string_1 = require("../../core/validator/is-format-string");
-const generate_zod_number_1 = require("./generate-zod-number");
-const generate_zod_integer_schema_1 = require("./generate-zod-integer-schema");
 const get_variable_schema_name_helper_1 = require("../../core/helper/get-variable-schema-name-helper");
 const generate_zod_object_1 = require("./generate-zod-object");
 const generate_zod_enum_1 = require("./generate-zod-enum");
 const generate_zod_max_1 = require("./generate-zod-max");
 const generate_zod_min_1 = require("./generate-zod-min");
+const generate_zod_number_1 = require("./generate-zod-number");
+const generate_zod_integer_schema_1 = require("./generate-zod-integer-schema");
+const generate_zod_length_1 = require("./generate-zod-length");
+const generate_zod_array_1 = require("./generate-zod-array");
+const generate_zod_string_1 = require("./generate-zod-string");
 const strip_min_if_gt_exist_helper_1 = require("./helper/strip-min-if-gt-exist-helper");
 const strip_max_if_lt_exist_helper_1 = require("./helper/strip-max-if-lt-exist-helper");
-const generate_zod_length_1 = require("./generate-zod-length");
 const strip_min_max_exist_helper_1 = require("./helper/strip-min-max-exist-helper");
 const generate_oneof_code_1 = require("../zod-openapi-hono/openapi/component/oneof/generate-oneof-code");
 const generate_anyof_code_1 = require("../zod-openapi-hono/openapi/component/anyof/generate-anyof-code");

package/dist/generator/zod/openapi/generate-zod-to-openapi-schema-definition.js

@@ -23,13 +23,20 @@ const generate_zod_infer_1 = require("../generate-zod-infer");
  */
 function generateZodToOpenAPISchemaDefinition(schemaName, zodSchema, config) {
     const variableName = (0, get_variable_schema_name_helper_1.getVariableSchemaNameHelper)(schemaName, config);
+    // "-" → "_"
+    const safeVariableName = variableName.replace(/[^a-zA-Z0-9_$]/g, '_');
+    // "-" → "_"
+    const safeSchemaName = schemaName.replace(/[^a-zA-Z0-9_$]/g, '_');
     // schema code
     const schemaCode = config.schema.export
-        ? `export const ${variableName} = ${zodSchema}.openapi('${schemaName}')`
-        : `const ${variableName} = ${zodSchema}.openapi('${schemaName}')`;
+        ? `export const ${safeVariableName} = ${zodSchema}.openapi('${safeSchemaName}')`
+        : `const ${safeVariableName} = ${zodSchema}.openapi('${safeSchemaName}')`;
     // zod infer code
     const typeVariableName = (0, get_variable_name_helper_1.getVariableNameHelper)(schemaName, config);
-    const zodInferCode = config.type.export ? (0, generate_zod_infer_1.generateZodInfer)(typeVariableName, variableName) : '';
+    const safeTypeVariableName = typeVariableName.replace(/[^a-zA-Z0-9_$]/g, '_');
+    const zodInferCode = config.type.export
+        ? (0, generate_zod_infer_1.generateZodInfer)(safeTypeVariableName, safeVariableName)
+        : '';
     // return code
     return `${schemaCode}\n\n${zodInferCode}`;
 }

package/dist/generator/zod/property/generate-zod-properties-schema.js

@@ -4,6 +4,7 @@ exports.generateZodPropertiesSchema = generateZodPropertiesSchema;
 const is_all_optional_1 = require("../../../core/validator/is-all-optional");
 const generate_zod_partial_schema_1 = require("../generate-zod-partial-schema");
 const generate_zod_property_schema_1 = require("./generate-zod-property-schema");
+const get_to_safe_identifier_helper_1 = require("../../../core/helper/get-to-safe-identifier-helper");
 /**
  * Generates a Zod object schema with properties and their requirements
  * @param { Record<string, Schema> } properties - Record of property names to their schema definitions
@@ -50,7 +51,9 @@ function generateZodPropertiesSchema(properties, required, config) {
     const objectProperties = Object.entries(properties).map(([key, schema]) => {
         const isRequired = required.includes(key);
         const propertySchema = (0, generate_zod_property_schema_1.generatePropertySchema)(schema, config);
-        return `${key}:${propertySchema}${isRequired ? '' : '.optional()'}`;
+        const safePropertySchema = (0, get_to_safe_identifier_helper_1.getToSafeIdentifierHelper)(propertySchema);
+        const safeKey = (0, get_to_safe_identifier_helper_1.getToSafeIdentifierHelper)(key);
+        return `${safeKey}:${safePropertySchema}${isRequired ? '' : '.optional()'}`;
     });
     // Check if all properties are optional
     const allOptional = (0, is_all_optional_1.isAllOptional)(objectProperties);

package/dist/generator/zod/reference/generate-array-reference-schema.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateArrayReferenceSchema = generateArrayReferenceSchema;
+const get_to_safe_identifier_helper_1 = require("../../../core/helper/get-to-safe-identifier-helper");
 const get_variable_schema_name_helper_1 = require("../../../core/helper/get-variable-schema-name-helper");
 const get_ref_name_1 = require("../../../core/schema/references/get-ref-name");
 const generate_zod_array_1 = require("../generate-zod-array");
@@ -19,5 +20,6 @@ function generateArrayReferenceSchema(schema, config) {
         return 'z.array(z.any())';
     }
     const variableName = (0, get_variable_schema_name_helper_1.getVariableSchemaNameHelper)(refName, config);
-    return (0, generate_zod_array_1.generateZodArray)(variableName);
+    const safeVariableName = (0, get_to_safe_identifier_helper_1.getToSafeIdentifierHelper)(variableName);
+    return (0, generate_zod_array_1.generateZodArray)(safeVariableName);
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-takibi",
   "description": "Hono Takibi is a CLI tool that generates Hono routes from OpenAPI specifications.",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "license": "MIT",
   "keywords": [
     "hono",