feat: Completely remove TypeScript AST dependency and migrate to string-based code generation (#141)

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>

Author: Himenon

README.md

@@ -3,7 +3,7 @@
 [日本語](./docs/ja/README-ja.md)
 
 This library provides TypeScript type definitions and extracted parameters from OpenAPI v3.0.x compliant specifications.
-TypeScript AST is used to generate the code, which is accurately converted to TypeScript code.
+Template literals are used to generate the code, which is accurately converted to TypeScript code.
 Since the parameters extracted from OpenAPI can be used freely, it can be used for automatic generation of API Client and Server Side code, load balancer configuration files, etc.
 
 ## Playground
@@ -436,10 +436,10 @@ export namespace Schemas {
 }
 ```
 
-### Define a code template with TypeScript AST
+### Define a code template with Template literals
 
-You can extend your code using the API of TypeScript AST.
-You can directly use the API of TypeScript AST or use the wrapper API of TypeScript AST provided by this library.
+You can extend your code using the API for generating code.
+You can directly use the Template literals or use the wrapper API provided by this library.
 
 ```ts
 import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
@@ -456,7 +456,7 @@ const generator: Types.CodeGenerator.GenerateFunction<Option> = (
   return payload.map(params => {
     return factory.InterfaceDeclaration.create({
       export: true,
-      name: params.functionName,
+      name: params.convertedParams.functionName,
       members: [],
     });
   });
@@ -487,7 +487,7 @@ Generates code that converts OpenAPI Schema to TypeScript type definitions.
 #### generateCode
 
 You can specify several of your own code generators, and the generators can use parameters extracted from OpenAPI Schema.
-It internally performs the conversion of an array of `string` or `ts.Statement` as a string.
+It internally performs the conversion of an array of `string` as a string.
 
 For example, creating a generator in units of file divisions increases the reusability of the generator.
 
@@ -507,7 +507,7 @@ This is a type definition file for `Templates.FunctionalApiClient`. The reason i
 import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
 ```
 
-This is a wrapper API for the TypeScript AST used internally.
+This is an API for generating code using Template literals.
 It is subject to change without notice.
 
 ### OpenApiTools
@@ -561,7 +561,7 @@ If your changes are in line with the design concept, please submit a pull reques
 - Typedefs should not contain any entities (file size should be 0 when typedefs are converted to `.js`)
 - The directory structure should be mapped to the typedef structure.
 - No dependency on any API client library.
-- Can be extended by TypeScript AST.
+- Can be extended by Template literals.
 - Conform to the OpenAPI specification.
 - It should be a single file to maintain portability.
 
@@ -580,9 +580,9 @@ pnpm run test
 
 ## Useful development tools
 
-TypeScript AST
+Prettier (or other formatters)
 
-- https://ts-ast-viewer.com
+- https://prettier.io/
 
 ## LICENCE
 

docs/ja/README-ja.md

@@ -1,7 +1,7 @@
 # @himenon/openapi-typescript-code-generator
 
 このライブラリは OpenAPI v3.0.x 系に準拠した仕様書から TypeScript の型定義と抽出したパラメーターを提供します。
-コードの生成には TypeScript AST を利用し、正確に TypeScript のコードへ変換します。
+コードの生成にはテンプレートリテラルを利用し、正確に TypeScript のコードへ変換します。
 OpenAPI から抽出したパラメーターは自由に使うことができるため、API Client や Server Side 用のコード、ロードバランサーの設定ファイルなどの自動生成に役立てることができます。
 
 ## Playground
@@ -432,10 +432,10 @@ export namespace Schemas {
 }
 ```
 
-### TypeScript AST によるコードテンプレートを定義する
+### テンプレートリテラルによるコードテンプレートを定義する
 
-TypeScript AST の API を利用したコードの拡張が可能です。
-直接 TypeScript の AST の API を利用したり、本ライブラリが提供する TypeScript AST のラッパー API を利用できます。
+テンプレートリテラルを利用したコードの拡張が可能です。
+直接テンプレートリテラルを利用したり、本ライブラリが提供するコード生成用 API を利用できます。
 
 ```ts
 import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
@@ -452,7 +452,7 @@ const generator: Types.CodeGenerator.GenerateFunction<Option> = (
   return payload.map(params => {
     return factory.InterfaceDeclaration.create({
       export: true,
-      name: params.functionName,
+      name: params.convertedParams.functionName,
       members: [],
     });
   });
@@ -483,7 +483,7 @@ OpenAPI Schema を TypeScript の型定義に変換したコードを生成し
 #### generateCode
 
 独自のコードジェネレーターを複数指定することができ、ジェネレーターは OpenAPI Schema から抽出したパラメーターを利用できます。
-内部で`string`または`ts.Statement`の配列を文字列として変換を行います。
+内部で`string`の配列を文字列として変換を行います。
 
 たとえばファイルの分割の単位でジェネレーターを作成するとジェネレーターの再利用性が高まります。
 
@@ -503,7 +503,7 @@ OpenAPI Schema から抽出したパラメーターを取得できます。
 import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
 ```
 
-内部で利用している TypeScript AST のラッパー API です。
+内部で利用している、テンプレートリテラルを用いてコードを生成するための API です。
 告知なく変更する可能性があります。
 
 ### OpenApiTools
@@ -557,7 +557,7 @@ API 仕様書から TypeScript のコードへ変換するとき、参照関係
 - 型定義に実体が含まれないこと（型定義部分を`.js`に変換したとき、ファイルサイズが 0 になること）
 - ディレクトリ構造が型定義の構造に写像されること
 - どの API クライアントライブラリにも依存しないこと
-- TypeScript AST による拡張ができること
+- テンプレートリテラルによる拡張ができること
 - OpenAPI の仕様に準拠すること
 - 1 ファイル化することにより、ポータビリティを保つこと
 
@@ -576,9 +576,9 @@ pnpm run test
 
 ### 便利な開発ツール
 
-TypeScript AST
+Prettier (or other formatters)
 
-- https://ts-ast-viewer.com
+- https://prettier.io/
 
 ## LICENCE
 

examples/readme-sample/ast-code-template.ts

@@ -12,7 +12,7 @@ const generator: Types.CodeGenerator.GenerateFunction<Option> = (
   return payload.map(params => {
     return factory.InterfaceDeclaration.create({
       export: true,
-      name: params.functionName,
+      name: params.convertedParams.functionName,
       members: [],
     });
   });

examples/readme-sample/generator-template.ts

@@ -3,6 +3,7 @@ import type * as Types from "@himenon/openapi-typescript-code-generator/dist/typ
 import * as fs from "fs";
 
 /** ここにCode Templateの定義を記述してください  */
+// @ts-ignore -- placeholder example, generator is intentionally omitted
 const customGenerator: Types.CodeGenerator.CustomGenerator<{}> = {
   /** .... */
 };

examples/readme-sample/use-extract-schema-params.ts

@@ -4,7 +4,7 @@ type Option = {};
 
 const generator: Types.CodeGenerator.GenerateFunction<Option> = (payload: Types.CodeGenerator.Params[]): string[] => {
   return payload.map(params => {
-    return `function ${params.operationId}() { console.log("${params.comment}") }`;
+    return `function ${params.operationId}() { console.log("${params.operationParams.comment}") }`;
   });
 };
 

package.json

@@ -1,14 +1,13 @@
 {
   "name": "@himenon/openapi-typescript-code-generator",
   "version": "1.1.3",
-  "description": "OpenAPI Code Generator using TypeScript AST.",
+  "description": "OpenAPI Code Generator using Template literals.",
   "keywords": [
     "openapi",
     "openapi3",
     "openapi-codegen",
     "openapi-generator",
-    "typescript",
-    "typescript-ast"
+    "typescript"
   ],
   "homepage": "https://github.com/Himenon/openapi-typescript-code-generator#readme",
   "bugs": {
@@ -119,9 +118,6 @@
     "typescript": "6.0.3",
     "vitest": "^4.1.5"
   },
-  "peerDependencies": {
-    "typescript": ">=5"
-  },
   "packageManager": "pnpm@10.33.2",
   "engines": {
     "node": ">=22.0.0"

src/code-templates/_shared/ApiClientArgument.ts

@@ -1,5 +1,3 @@
-import type ts from "typescript";
-
 import type { TsGenerator } from "../../api";
 import type { CodeGenerator } from "../../types";
 
@@ -52,7 +50,7 @@ export const createResponseContentTypeReference = (factory: TsGenerator.Factory.
 };
 
 const createHeaders = (factory: TsGenerator.Factory.Type, { convertedParams }: CodeGenerator.Params) => {
-  const members = [];
+  const members: string[] = [];
 
   if (convertedParams.has2OrMoreRequestContentTypes) {
     members.push(
@@ -90,10 +88,10 @@ const createHeaders = (factory: TsGenerator.Factory.Type, { convertedParams }: C
  *   requestBody: {requestBodyName}[T];
  * }
  */
-export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.Params): ts.InterfaceDeclaration | undefined => {
+export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.Params): string | undefined => {
   const { convertedParams } = params;
-  const typeParameters: ts.TypeParameterDeclaration[] = [];
-  const members: ts.TypeElement[] = [];
+  const typeParameters: string[] = [];
+  const members: string[] = [];
   if (convertedParams.hasRequestBody && convertedParams.has2OrMoreRequestContentTypes) {
     typeParameters.push(
       factory.TypeParameterDeclaration.create({

src/code-templates/_shared/ApiClientInterface.ts

@@ -1,5 +1,3 @@
-import ts from "typescript";
-
 import type { TsGenerator } from "../../api";
 import type { CodeGenerator } from "../../types";
 import type { MethodType } from "./MethodBody/types";
@@ -12,7 +10,7 @@ const createErrorResponsesTypeAlias = (typeName: string, factory: TsGenerator.Fa
     return factory.TypeAliasDeclaration.create({
       export: true,
       name: typeName,
-      type: ts.factory.createToken(ts.SyntaxKind.VoidKeyword),
+      type: "void",
     });
   }
   return factory.TypeAliasDeclaration.create({
@@ -33,7 +31,7 @@ const createSuccessResponseTypeAlias = (typeName: string, factory: TsGenerator.F
     return factory.TypeAliasDeclaration.create({
       export: true,
       name: typeName,
-      type: ts.factory.createToken(ts.SyntaxKind.VoidKeyword),
+      type: "void",
     });
   }
   return factory.TypeAliasDeclaration.create({
@@ -156,12 +154,7 @@ const createEncodingInterface = (factory: TsGenerator.Factory.Type) => {
   });
 };
 
-export const create = (
-  factory: TsGenerator.Factory.Type,
-  list: CodeGenerator.Params[],
-  methodType: MethodType,
-  option: Option,
-): ts.Statement[] => {
+export const create = (factory: TsGenerator.Factory.Type, list: CodeGenerator.Params[], methodType: MethodType, option: Option): string[] => {
   const objectLikeOrAnyType = factory.UnionTypeNode.create({
     typeNodes: [
       factory.TypeReferenceNode.create({

src/code-templates/_shared/MethodBody/CallRequest.ts

@@ -1,5 +1,3 @@
-import type ts from "typescript";
-
 import type { TsGenerator } from "../../../api";
 import type { CodeGenerator } from "../../../types";
 import * as Utils from "../utils";
@@ -18,7 +16,7 @@ export interface Params {
  *   "application/x-www-form-urlencoded": {},
  * }
  */
-const createEncodingParams = (factory: TsGenerator.Factory.Type, params: CodeGenerator.Params): ts.Expression | undefined => {
+const createEncodingParams = (factory: TsGenerator.Factory.Type, params: CodeGenerator.Params): string | undefined => {
   const content = params.operationParams.requestBody?.content;
   if (!content) {
     return;
@@ -36,7 +34,7 @@ const createEncodingParams = (factory: TsGenerator.Factory.Type, params: CodeGen
 /**
  * this.apiClient.request("GET", url, requestBody, headers, queryParameters);
  */
-export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.Params, methodType: MethodType): ts.CallExpression => {
+export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.Params, methodType: MethodType): string => {
   const { convertedParams } = params;
   const apiClientVariableIdentifier: Record<MethodType, string> = {
     class: "this.apiClient.request",

src/code-templates/_shared/MethodBody/HeaderParameter.ts

@@ -1,5 +1,3 @@
-import type ts from "typescript";
-
 import type { TsGenerator } from "../../../api";
 import * as Utils from "../utils";
 
@@ -8,7 +6,7 @@ export interface Params {
   object: Utils.LiteralExpressionObject;
 }
 
-export const create = (factory: TsGenerator.Factory.Type, params: Params): ts.VariableStatement => {
+export const create = (factory: TsGenerator.Factory.Type, params: Params): string => {
   return factory.VariableStatement.create({
     declarationList: factory.VariableDeclarationList.create({
       flag: "const",