feat: support ES Modules

.eslintrc.js → .eslintrc.cjs

@@ -42,7 +42,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ["example/**"],
+      files: ["examples/**"],
       rules: {
         "@typescript-eslint/no-unused-vars": "off",
         "@typescript-eslint/no-empty-interface": "off",

.github/workflows/build.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16]
+        node-version: [20.x]
         os: [windows-latest, ubuntu-latest]
 
     steps:
@@ -22,10 +22,10 @@ jobs:
       - uses: actions/checkout@v3
       - uses: pnpm/[email protected]
         with:
-          version: 7.0.0
+          version: 8.15.1
       - uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "20.x"
           cache: "pnpm"
       - run: pnpm i --frozen-lockfile
       - name: Use Node.js ${{ matrix.node-version }}

.github/workflows/release.yml

@@ -19,10 +19,10 @@ jobs:
           ref: main
       - uses: pnpm/[email protected]
         with:
-          version: 7.0.0
+          version: 8.15.1
       - uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "20.x"
           registry-url: https://npm.pkg.github.com
           scope: "@Himenon"
           cache: "pnpm"
@@ -46,10 +46,10 @@ jobs:
           ref: main
       - uses: pnpm/[email protected]
         with:
-          version: 7.0.0
+          version: 8.15.1
       - uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "20.x"
           registry-url: https://npm.pkg.github.com
           scope: "@Himenon"
           cache: "pnpm"
@@ -69,10 +69,10 @@ jobs:
           ref: main
       - uses: pnpm/[email protected]
         with:
-          version: 7.0.0
+          version: 8.15.1
       - uses: actions/setup-node@v2
         with:
-          node-version: "16.x"
+          node-version: "20.x"
           registry-url: "https://registry.npmjs.org"
           cache: "pnpm"
       - run: pnpm install

.github/workflows/versionUp.yml

@@ -20,10 +20,10 @@ jobs:
           ref: main
       - uses: pnpm/[email protected]
         with:
-          version: 7.0.0
+          version: 8.15.1
       - uses: actions/setup-node@v2
         with:
-          node-version: "16.x"
+          node-version: "20.x"
           cache: "pnpm"
       - run: pnpm i --frozen-lockfile
       - name: Auto version update

.gitignore

@@ -11,3 +11,6 @@ debug
 test/kubernetes
 test/argo-rollout
 CHANGELOG.md
+esm/
+dist/
+output/

README.md

@@ -52,8 +52,8 @@ main();
 import * as fs from "fs";
 
 import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
-import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
-import type * as Types from "@himenon/openapi-typescript-code-generator/types";
+import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
+import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
 
 const main = () => {
   const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -79,7 +79,7 @@ main();
 This library provides three types of templates
 
 ```ts
-import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
+import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
 
 Templates.ClassApiClient.generator;
 Templates.FunctionalApiClient.generator;
@@ -106,7 +106,10 @@ export interface ApiClient<RequestOption> {
 
 export class Client<RequestOption> {
   private baseUrl: string;
-  constructor(private apiClient: ApiClient<RequestOption>, baseUrl: string) {
+  constructor(
+    private apiClient: ApiClient<RequestOption>,
+    baseUrl: string,
+  ) {
     this.baseUrl = baseUrl.replace(/\/$/, "");
   }
 
@@ -270,8 +273,8 @@ export const createPublisherV2 =
 import * as fs from "fs";
 
 import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
-import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
-import type * as Types from "@himenon/openapi-typescript-code-generator/types";
+import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
+import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
 
 const main = () => {
   const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -307,7 +310,7 @@ The examples in this section can be used in the following ways
 import * as fs from "fs";
 
 import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
-import type * as Types from "@himenon/openapi-typescript-code-generator/types";
+import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
 
 /** Write the definition of the Code Template here. */
 const customGenerator: Types.CodeGenerator.CustomGenerator<{}> = {
@@ -440,7 +443,7 @@ You can directly use the API of TypeScript AST or use the wrapper API of TypeScr
 
 ```ts
 import * as Types from "@himenon/openapi-typescript-code-generator/types";
-import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
+import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
 
 interface Option {}
 
@@ -501,7 +504,7 @@ This is a type definition file for `Templates.FunctionalApiClient`. The reason i
 ### TsGenerator
 
 ```ts
-import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
+import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
 ```
 
 This is a wrapper API for the TypeScript AST used internally.
@@ -510,7 +513,7 @@ It is subject to change without notice.
 ### OpenApiTools
 
 ```ts
-import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/api";
+import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/dist/api";
 ```
 
 #### Parser

docs/ja/README-ja.md

@@ -46,8 +46,8 @@ main();
 import * as fs from "fs";
 
 import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
-import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
-import type * as Types from "@himenon/openapi-typescript-code-generator/types";
+import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
+import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
 
 const main = () => {
   const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -73,7 +73,7 @@ main();
 本ライブラリからは 3 種類提供しています。
 
 ```ts
-import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
+import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
 
 Templates.ClassApiClient.generator;
 Templates.FunctionalApiClient.generator;
@@ -100,7 +100,10 @@ export interface ApiClient<RequestOption> {
 
 export class Client<RequestOption> {
   private baseUrl: string;
-  constructor(private apiClient: ApiClient<RequestOption>, baseUrl: string) {
+  constructor(
+    private apiClient: ApiClient<RequestOption>,
+    baseUrl: string,
+  ) {
     this.baseUrl = baseUrl.replace(/\/$/, "");
   }
 
@@ -266,8 +269,8 @@ export const createPublisherV2 =
 import * as fs from "fs";
 
 import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
-import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
-import type * as Types from "@himenon/openapi-typescript-code-generator/types";
+import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
+import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
 
 const main = () => {
   const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -303,7 +306,7 @@ main();
 import * as fs from "fs";
 
 import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
-import type * as Types from "@himenon/openapi-typescript-code-generator/types";
+import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
 
 /** ここにCode Templateの定義を記述してください  */
 const customGenerator: Types.CodeGenerator.CustomGenerator<{}> = {
@@ -436,7 +439,7 @@ TypeScript AST の API を利用したコードの拡張が可能です。
 
 ```ts
 import * as Types from "@himenon/openapi-typescript-code-generator/types";
-import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
+import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
 
 interface Option {}
 
@@ -497,7 +500,7 @@ OpenAPI Schema から抽出したパラメーターを取得できます。
 ### TsGenerator
 
 ```ts
-import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
+import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
 ```
 
 内部で利用している TypeScript AST のラッパー API です。
@@ -506,7 +509,7 @@ import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
 ### OpenApiTools
 
 ```ts
-import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/api";
+import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/dist/api";
 ```
 
 #### Parser

example/client.ts → examples/apis/client.ts

@@ -80,7 +80,10 @@ export interface ApiClient<RequestOption> {
   ) => Promise<T>;
 }
 export class Client<RequestOption> {
-  constructor(private apiClient: ApiClient<RequestOption>, private baseUrl: string) {}
+  constructor(
+    private apiClient: ApiClient<RequestOption>,
+    private baseUrl: string,
+  ) {}
   public async getBooks(option?: RequestOption): Promise<Response$getBooks$Status$200["application/json"]> {
     const url = this.baseUrl + `/get/books`;
     const headers = {