Skip to content

Commit 19e8077

Browse files
committed
feat: support subpath exports
BREAKING CHANGE: Import paths for templates, types, api, and meta have been changed to remove the 'dist/' prefix. - Old: @himenon/openapi-typescript-code-generator/dist/templates - New: @himenon/openapi-typescript-code-generator/templates
1 parent bf64931 commit 19e8077

10 files changed

Lines changed: 44 additions & 39 deletions

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ main();
5252
import * as fs from "fs";
5353

5454
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
55-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
56-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
55+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
56+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
5757

5858
const main = () => {
5959
const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -79,7 +79,7 @@ main();
7979
This library provides three types of templates
8080

8181
```ts
82-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
82+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
8383

8484
Templates.ClassApiClient.generator;
8585
Templates.FunctionalApiClient.generator;
@@ -273,8 +273,8 @@ export const createPublisherV2 =
273273
import * as fs from "fs";
274274

275275
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
276-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
277-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
276+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
277+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
278278

279279
const main = () => {
280280
const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -310,7 +310,7 @@ The examples in this section can be used in the following ways
310310
import * as fs from "fs";
311311

312312
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
313-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
313+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
314314

315315
/** Write the definition of the Code Template here. */
316316
const customGenerator: Types.CodeGenerator.CustomGenerator<{}> = {
@@ -329,7 +329,7 @@ fs.writeFileSync("output/file/name", code, { encoding: "utf-8" });
329329
A self-defined code generator can return an array of `string`.
330330

331331
```ts
332-
import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
332+
import * as Types from "@himenon/openapi-typescript-code-generator/types";
333333

334334
interface Option {
335335
showLog?: boolean;
@@ -354,7 +354,7 @@ The self-defined code generator can accept parameters extracted from OpenAPI Sch
354354
See Type definitions for available parameters.
355355

356356
```ts
357-
import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
357+
import * as Types from "@himenon/openapi-typescript-code-generator/types";
358358

359359
interface Option {}
360360

@@ -442,8 +442,8 @@ You can extend your code using the API for generating code.
442442
You can directly use the Template literals or use the wrapper API provided by this library.
443443

444444
```ts
445-
import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
446-
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
445+
import * as Types from "@himenon/openapi-typescript-code-generator/types";
446+
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
447447

448448
interface Option {}
449449

@@ -504,7 +504,7 @@ This is a type definition file for `Templates.FunctionalApiClient`. The reason i
504504
### TsGenerator
505505

506506
```ts
507-
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
507+
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
508508
```
509509

510510
This is an API for generating code using Template literals.
@@ -513,7 +513,7 @@ It is subject to change without notice.
513513
### OpenApiTools
514514

515515
```ts
516-
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/dist/api";
516+
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/api";
517517
```
518518

519519
#### Parser

docs/ja/README-ja.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ main();
4646
import * as fs from "fs";
4747

4848
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
49-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
50-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
49+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
50+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
5151

5252
const main = () => {
5353
const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -73,7 +73,7 @@ main();
7373
本ライブラリからは 3 種類提供しています。
7474

7575
```ts
76-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
76+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
7777

7878
Templates.ClassApiClient.generator;
7979
Templates.FunctionalApiClient.generator;
@@ -269,8 +269,8 @@ export const createPublisherV2 =
269269
import * as fs from "fs";
270270

271271
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
272-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
273-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
272+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
273+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
274274

275275
const main = () => {
276276
const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
@@ -306,7 +306,7 @@ main();
306306
import * as fs from "fs";
307307

308308
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
309-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
309+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
310310

311311
/** ここにCode Templateの定義を記述してください */
312312
const customGenerator: Types.CodeGenerator.CustomGenerator<{}> = {
@@ -325,7 +325,7 @@ fs.writeFileSync("output/file/name", code, { encoding: "utf-8" });
325325
独自定義のコードジェネレーターは`string`の配列を返すことができます。
326326

327327
```ts
328-
import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
328+
import * as Types from "@himenon/openapi-typescript-code-generator/types";
329329

330330
interface Option {
331331
showLog?: boolean;
@@ -350,7 +350,7 @@ const customGenerator: Types.CodeGenerator.CustomGenerator<Option> = {
350350
利用可能なパラメーターは型定義を参照してください。
351351

352352
```ts
353-
import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
353+
import * as Types from "@himenon/openapi-typescript-code-generator/types";
354354

355355
interface Option {}
356356

@@ -438,8 +438,8 @@ export namespace Schemas {
438438
直接テンプレートリテラルを利用したり、本ライブラリが提供するコード生成用 API を利用できます。
439439

440440
```ts
441-
import * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
442-
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
441+
import * as Types from "@himenon/openapi-typescript-code-generator/types";
442+
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
443443

444444
interface Option {}
445445

@@ -500,7 +500,7 @@ OpenAPI Schema から抽出したパラメーターを取得できます。
500500
### TsGenerator
501501

502502
```ts
503-
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
503+
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
504504
```
505505

506506
内部で利用している、テンプレートリテラルを用いてコードを生成するための API です。
@@ -509,7 +509,7 @@ import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api
509509
### OpenApiTools
510510

511511
```ts
512-
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/dist/api";
512+
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/api";
513513
```
514514

515515
#### Parser

examples/apis/codegen.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
2-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
3-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
2+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
3+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
44
import * as fs from "fs";
55

66
const main = () => {

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
2-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
1+
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
2+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
33

44
type Option = {};
55

examples/readme-sample/generator-template.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
2-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
2+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
33
import * as fs from "fs";
44

55
/** ここにCode Templateの定義を記述してください */

examples/readme-sample/split-typedef-and-api-client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
2-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
3-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
2+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
3+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
44
import * as fs from "fs";
55

66
const main = () => {

examples/readme-sample/text-base-code-template.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
1+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
22

33
interface Option {
44
showLog?: boolean;

examples/readme-sample/typedef-and-api-client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
2-
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
3-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
2+
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
3+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
44
import * as fs from "fs";
55

66
const main = () => {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
1+
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
22

33
type Option = {};
44

package.json

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,22 +27,27 @@
2727
"type": "module",
2828
"exports": {
2929
".": {
30+
"types": "./dist/index.d.ts",
3031
"import": "./dist/index.js",
3132
"require": "./dist/index.cjs"
3233
},
33-
"./dist/api": {
34+
"./api": {
35+
"types": "./dist/api.d.ts",
3436
"import": "./dist/api.js",
3537
"require": "./dist/api.cjs"
3638
},
37-
"./dist/templates": {
39+
"./templates": {
40+
"types": "./dist/templates.d.ts",
3841
"import": "./dist/templates.js",
3942
"require": "./dist/templates.cjs"
4043
},
41-
"./dist/types": {
44+
"./types": {
45+
"types": "./dist/types.d.ts",
4246
"import": "./dist/types.js",
4347
"require": "./dist/types.cjs"
4448
},
45-
"./dist/meta": {
49+
"./meta": {
50+
"types": "./dist/meta.d.ts",
4651
"import": "./dist/meta.js",
4752
"require": "./dist/meta.cjs"
4853
}

0 commit comments

Comments
 (0)