Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

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

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

Templates.ClassApiClient.generator;
Templates.FunctionalApiClient.generator;
Expand Down Expand Up @@ -273,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/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

const main = () => {
const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
Expand Down Expand Up @@ -310,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/dist/types";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

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

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

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

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

interface Option {}

Expand Down Expand Up @@ -442,8 +442,8 @@ 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";
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
import * as Types from "@himenon/openapi-typescript-code-generator/types";
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";

interface Option {}

Expand Down Expand Up @@ -504,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/dist/api";
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
```

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

```ts
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/dist/api";
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/api";
```

#### Parser
Expand Down
24 changes: 12 additions & 12 deletions docs/ja/README-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

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

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

Templates.ClassApiClient.generator;
Templates.FunctionalApiClient.generator;
Expand Down Expand Up @@ -269,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/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

const main = () => {
const codeGenerator = new CodeGenerator("your/openapi/spec.yml");
Expand Down Expand Up @@ -306,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/dist/types";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

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

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

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

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

interface Option {}

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

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

interface Option {}

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

```ts
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
```

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

```ts
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/dist/api";
import { OpenApiTools } from "@himenon/openapi-typescript-code-generator/api";
```

#### Parser
Expand Down
4 changes: 2 additions & 2 deletions examples/apis/codegen.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
import * as fs from "fs";

const main = () => {
Expand Down
4 changes: 2 additions & 2 deletions examples/readme-sample/ast-code-template.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/dist/api";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import { TsGenerator } from "@himenon/openapi-typescript-code-generator/api";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

type Option = {};

Expand Down
2 changes: 1 addition & 1 deletion examples/readme-sample/generator-template.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
import * as fs from "fs";

/** ここにCode Templateの定義を記述してください */
Expand Down
4 changes: 2 additions & 2 deletions examples/readme-sample/split-typedef-and-api-client.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
import * as fs from "fs";

const main = () => {
Expand Down
2 changes: 1 addition & 1 deletion examples/readme-sample/text-base-code-template.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

interface Option {
showLog?: boolean;
Expand Down
4 changes: 2 additions & 2 deletions examples/readme-sample/typedef-and-api-client.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { CodeGenerator } from "@himenon/openapi-typescript-code-generator";
import * as Templates from "@himenon/openapi-typescript-code-generator/dist/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import * as Templates from "@himenon/openapi-typescript-code-generator/templates";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";
import * as fs from "fs";

const main = () => {
Expand Down
2 changes: 1 addition & 1 deletion examples/readme-sample/use-extract-schema-params.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type * as Types from "@himenon/openapi-typescript-code-generator/dist/types";
import type * as Types from "@himenon/openapi-typescript-code-generator/types";

type Option = {};

Expand Down
13 changes: 9 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,22 +27,27 @@
"type": "module",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.js",
"require": "./dist/index.cjs"
},
"./dist/api": {
"./api": {
"types": "./dist/api.d.ts",
"import": "./dist/api.js",
"require": "./dist/api.cjs"
},
"./dist/templates": {
"./templates": {
"types": "./dist/templates.d.ts",
"import": "./dist/templates.js",
"require": "./dist/templates.cjs"
},
"./dist/types": {
"./types": {
"types": "./dist/types.d.ts",
"import": "./dist/types.js",
"require": "./dist/types.cjs"
},
"./dist/meta": {
"./meta": {
"types": "./dist/meta.d.ts",
"import": "./dist/meta.js",
"require": "./dist/meta.cjs"
}
Expand Down
Loading