Skip to content

Commit b5eb255

Browse files
Himenonkarupanerura
Himenon
and
karupanerura
authored
feat: supports fragment in remote reference (#87)
Co-authored-by: karupanerura <karupa@cpan.org>
1 parent 05d981d commit b5eb255

17 files changed

+426
-38
lines changed

‎scripts/testCodeGen.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ const main = () => {
2424
Writer.generateTypedefWithTemplateCode("test/ref.access/index.yml", "test/code/typedef-with-template/ref-access.ts", false, {
2525
sync: false,
2626
});
27+
Writer.generateTypedefWithTemplateCode("test/remote.ref.access/v1.yml", "test/code/typedef-with-template/remote-ref-access.ts", false, {
28+
sync: false,
29+
});
2730
Writer.generateTypedefWithTemplateCode("test/kubernetes/openapi-v1.18.5.json", "test/code/kubernetes/client-v1.18.5.ts", false, {
2831
sync: false,
2932
});

‎src/internal/FileSystem/index.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,17 @@ export class FileSystem {
2828
}
2929

3030
public static existSync(entryPoint: string): boolean {
31+
const fragmentIndex = entryPoint.indexOf(this.FRAGMENT);
32+
const hasFragment = fragmentIndex !== -1;
33+
if (hasFragment) {
34+
const filename = entryPoint.substring(0, fragmentIndex);
35+
return !!(fs.existsSync(filename) && fs.statSync(filename).isFile());
36+
}
3137
return !!(fs.existsSync(entryPoint) && fs.statSync(entryPoint).isFile());
3238
}
3339

3440
public static loadJsonOrYaml(entryPoint: string): any {
35-
const hasFragment: boolean = new RegExp(this.FRAGMENT).test(entryPoint);
41+
const hasFragment = entryPoint.indexOf(this.FRAGMENT) !== -1;
3642
if (hasFragment) {
3743
const [filename, fragment] = entryPoint.split(this.FRAGMENT);
3844
const data = this.internalLoadJsonOrYaml(filename);

‎src/internal/OpenApiTools/components/Reference.ts

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import * as path from "path";
1+
import { posix as path } from "path";
22

33
import type { OpenApi } from "../../../types";
44
import { DevelopmentError, FeatureDevelopmentError, NotFoundFileError } from "../../Exception";
@@ -136,22 +136,29 @@ export const generate = <T>(entryPoint: string, currentPoint: string, reference:
136136
throw new NotFoundFileError(`Not found reference point from current point. \n Path: ${referencePoint}`);
137137
}
138138

139-
const relativePathFromEntryPoint = path.relative(path.dirname(entryPoint), referencePoint); // components/hoge/fuga.yml
140-
const ext = path.extname(relativePathFromEntryPoint); // .yml
141-
const pathArray: string[] = relativePathFromEntryPoint.replace(ext, "").split(path.sep); // ["components", "hoge", "fuga"]
142-
const targetPath: string = pathArray.join("/"); // components/hoge/fuga
139+
const fragmentIndex = referencePoint.indexOf("#/");
140+
let targetPath: string;
141+
if (fragmentIndex !== -1) {
142+
targetPath = referencePoint.substring(fragmentIndex + 2);
143+
} else {
144+
const relativePathFromEntryPoint = path.relative(path.dirname(entryPoint), referencePoint); // components/hoge/fuga.yml
145+
const pathArray: string[] = relativePathFromEntryPoint.split(path.sep); // ["components", "hoge", "fuga"]
146+
if (pathArray[0] != "components") {
147+
throw new DevelopmentError(`targetPath is not start "components":\n${relativePathFromEntryPoint}`);
148+
}
149+
150+
const ext = path.extname(relativePathFromEntryPoint); // .yml
151+
targetPath = pathArray.join("/").substring(0, relativePathFromEntryPoint.length - ext.length); // components/hoge/fuga
152+
}
153+
const pathArray: string[] = targetPath.split("/"); // ["components", "hoge", "fuga"]
143154
const schemaName = pathArray[pathArray.length - 1]; // fuga
144155
const componentName = pathArray[0] === "components" ? pathArray[1] : "";
145-
const data = FileSystem.loadJsonOrYaml(referencePoint);
146156

157+
const data = FileSystem.loadJsonOrYaml(referencePoint);
147158
if (Guard.isReference(data)) {
148159
return generate<T>(entryPoint, referencePoint, data);
149160
}
150161

151-
if (!targetPath.startsWith("components")) {
152-
throw new DevelopmentError(`targetPath is not start "components":\n${targetPath}`);
153-
}
154-
155162
return {
156163
type: "remote",
157164
referencePoint,

‎test/__tests__/__snapshots__/typedef-with-template-test.ts.snap

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1216,3 +1216,148 @@ export class Client<RequestOption> {
12161216
}
12171217
"
12181218
`;
1219+
1220+
exports[`Typedef with template remote-ref-access 1`] = `
1221+
"//
1222+
// Generated by @himenon/openapi-typescript-code-generator
1223+
//
1224+
// OpenApi : 3.1.0
1225+
//
1226+
// License : MIT
1227+
//
1228+
1229+
1230+
export namespace Schemas {
1231+
export interface Book {
1232+
author?: {
1233+
name?: string;
1234+
age?: string;
1235+
};
1236+
publisher?: {
1237+
name?: any;
1238+
address?: string;
1239+
};
1240+
metadata: {
1241+
description: string;
1242+
};
1243+
}
1244+
export namespace Book {
1245+
export namespace properties {
1246+
export interface author {
1247+
name?: string;
1248+
age?: string;
1249+
}
1250+
export interface publisher {
1251+
name?: any;
1252+
address?: string;
1253+
}
1254+
export namespace metadata {
1255+
export namespace properties {
1256+
export type description = string;
1257+
}
1258+
}
1259+
}
1260+
}
1261+
export type Author = Schemas.Book.properties.author;
1262+
export type Publisher = Schemas.Book.properties.publisher;
1263+
}
1264+
export interface Parameter$getBook {
1265+
/** Book ID */
1266+
id: string;
1267+
}
1268+
export interface Response$getBook$Status$200 {
1269+
\\"application/json\\": Schemas.Book;
1270+
}
1271+
export interface Parameter$getDescription {
1272+
/** Book ID */
1273+
id: string;
1274+
}
1275+
export interface Response$getDescription$Status$200 {
1276+
\\"application/json\\": Schemas.Book.properties.metadata.properties.description;
1277+
}
1278+
export interface Parameter$getAuthor {
1279+
/** Author Id */
1280+
id: string;
1281+
}
1282+
export interface Response$getAuthor$Status$200 {
1283+
\\"application/json\\": Schemas.Author;
1284+
}
1285+
export interface Parameter$getPublisher {
1286+
/** Publisher ID */
1287+
id: string;
1288+
}
1289+
export interface Response$getPublisher$Status$200 {
1290+
\\"application/json\\": Schemas.Publisher;
1291+
}
1292+
export type ResponseContentType$getBook = keyof Response$getBook$Status$200;
1293+
export interface Params$getBook {
1294+
parameter: Parameter$getBook;
1295+
}
1296+
export type ResponseContentType$getDescription = keyof Response$getDescription$Status$200;
1297+
export interface Params$getDescription {
1298+
parameter: Parameter$getDescription;
1299+
}
1300+
export type ResponseContentType$getAuthor = keyof Response$getAuthor$Status$200;
1301+
export interface Params$getAuthor {
1302+
parameter: Parameter$getAuthor;
1303+
}
1304+
export type ResponseContentType$getPublisher = keyof Response$getPublisher$Status$200;
1305+
export interface Params$getPublisher {
1306+
parameter: Parameter$getPublisher;
1307+
}
1308+
export type HttpMethod = \\"GET\\" | \\"PUT\\" | \\"POST\\" | \\"DELETE\\" | \\"OPTIONS\\" | \\"HEAD\\" | \\"PATCH\\" | \\"TRACE\\";
1309+
export interface ObjectLike {
1310+
[key: string]: any;
1311+
}
1312+
export interface QueryParameter {
1313+
value: any;
1314+
style?: \\"form\\" | \\"spaceDelimited\\" | \\"pipeDelimited\\" | \\"deepObject\\";
1315+
explode: boolean;
1316+
}
1317+
export interface QueryParameters {
1318+
[key: string]: QueryParameter;
1319+
}
1320+
export type SuccessResponses = Response$getBook$Status$200 | Response$getDescription$Status$200 | Response$getAuthor$Status$200 | Response$getPublisher$Status$200;
1321+
export namespace ErrorResponse {
1322+
export type getBook = void;
1323+
export type getDescription = void;
1324+
export type getAuthor = void;
1325+
export type getPublisher = void;
1326+
}
1327+
export interface ApiClient<RequestOption> {
1328+
request: <T = SuccessResponses>(httpMethod: HttpMethod, url: string, headers: ObjectLike | any, requestBody: ObjectLike | any, queryParameters: QueryParameters | undefined, options?: RequestOption) => Promise<T>;
1329+
}
1330+
export class Client<RequestOption> {
1331+
private baseUrl: string;
1332+
constructor(private apiClient: ApiClient<RequestOption>, baseUrl: string) { this.baseUrl = baseUrl.replace(/\\\\/$/, \\"\\"); }
1333+
public async getBook(params: Params$getBook, option?: RequestOption): Promise<Response$getBook$Status$200[\\"application/json\\"]> {
1334+
const url = this.baseUrl + \`/get/book/\${params.parameter.id}\`;
1335+
const headers = {
1336+
Accept: \\"application/json\\"
1337+
};
1338+
return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option);
1339+
}
1340+
public async getDescription(params: Params$getDescription, option?: RequestOption): Promise<Response$getDescription$Status$200[\\"application/json\\"]> {
1341+
const url = this.baseUrl + \`/get/book/\${params.parameter.id}/description\`;
1342+
const headers = {
1343+
Accept: \\"application/json\\"
1344+
};
1345+
return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option);
1346+
}
1347+
public async getAuthor(params: Params$getAuthor, option?: RequestOption): Promise<Response$getAuthor$Status$200[\\"application/json\\"]> {
1348+
const url = this.baseUrl + \`/get/author/\${params.parameter.id}\`;
1349+
const headers = {
1350+
Accept: \\"application/json\\"
1351+
};
1352+
return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option);
1353+
}
1354+
public async getPublisher(params: Params$getPublisher, option?: RequestOption): Promise<Response$getPublisher$Status$200[\\"application/json\\"]> {
1355+
const url = this.baseUrl + \`/get/publisher/\${params.parameter.id}\`;
1356+
const headers = {
1357+
Accept: \\"application/json\\"
1358+
};
1359+
return this.apiClient.request(\\"GET\\", url, headers, undefined, undefined, option);
1360+
}
1361+
}
1362+
"
1363+
`;

‎test/__tests__/argo-rollout-test.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import * as fs from "fs";
2-
import * as path from "path";
32

43
import * as Utils from "../utils";
54

65
describe("Argo Rollout", () => {
76
test("client.ts", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/argo-rollout/client.ts"), { encoding: "utf-8" });
7+
const generateCode = fs.readFileSync("test/code/argo-rollout/client.ts", { encoding: "utf-8" });
98
const text = Utils.replaceVersionInfo(generateCode);
109
expect(text).toMatchSnapshot();
1110
});

‎test/__tests__/client-generate-test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ import type * as Types from "../../src/types";
77

88
describe("raw-json-generate", () => {
99
test("the raw json input result and the json file path result are same", () => {
10-
const generateCode = JSON.parse(fs.readFileSync(path.join(__dirname, "../kubernetes/openapi-v1.18.5.json"), { encoding: "utf-8" }));
10+
const generateCode = JSON.parse(fs.readFileSync("test/kubernetes/openapi-v1.18.5.json", { encoding: "utf-8" }));
1111

1212
const codeGenerator1 = new CodeGenerator(generateCode);
13-
const codeGenerator2 = new CodeGenerator(path.join(__dirname, "../kubernetes/openapi-v1.18.5.json"));
13+
const codeGenerator2 = new CodeGenerator("test/kubernetes/openapi-v1.18.5.json");
1414

1515
const apiClientGeneratorTemplate: Types.CodeGenerator.CustomGenerator<Templates.ApiClient.Option> = {
1616
generator: Templates.ApiClient.generator,
@@ -30,7 +30,7 @@ describe("raw-json-generate", () => {
3030
expect(code1).toBe(code2);
3131
});
3232
test("yaml file path loadable", () => {
33-
const codeGenerator = new CodeGenerator(path.join(__dirname, "../api.test.domain/index.yml"));
33+
const codeGenerator = new CodeGenerator("test/api.test.domain/index.yml");
3434

3535
const apiClientGeneratorTemplate: Types.CodeGenerator.CustomGenerator<Templates.ApiClient.Option> = {
3636
generator: Templates.ApiClient.generator,

‎test/__tests__/format.domain.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import * as fs from "fs";
2-
import * as path from "path";
32

43
import * as Utils from "../utils";
54

65
describe("Format Types", () => {
76
test("format.domain", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/format.domain/code.ts"), { encoding: "utf-8" });
7+
const generateCode = fs.readFileSync("test/code/format.domain/code.ts", { encoding: "utf-8" });
98
const text = Utils.replaceVersionInfo(generateCode);
109
expect(text).toMatchSnapshot();
1110
});

‎test/__tests__/kubernetes-test.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
import * as fs from "fs";
2-
import * as path from "path";
32

43
import * as Utils from "../utils";
54

65
describe("Kubernetes", () => {
76
test("client-v1.18.5.ts", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/kubernetes/client-v1.18.5.ts"), { encoding: "utf-8" });
7+
const generateCode = fs.readFileSync("test/code/kubernetes/client-v1.18.5.ts", { encoding: "utf-8" });
98
const text = Utils.replaceVersionInfo(generateCode);
109
expect(text).toMatchSnapshot();
1110
});

‎test/__tests__/multi-type.test.domain.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ import * as Utils from "../utils";
55

66
describe("Multi Type", () => {
77
test("types", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/mulit-type-test.domain/types.ts"), { encoding: "utf-8" });
8+
const generateCode = fs.readFileSync("test/code/mulit-type-test.domain/types.ts", { encoding: "utf-8" });
99
const text = Utils.replaceVersionInfo(generateCode);
1010
expect(text).toMatchSnapshot();
1111
});
1212

1313
test("apiClient", () => {
14-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/mulit-type-test.domain/apiClient.ts"), { encoding: "utf-8" });
14+
const generateCode = fs.readFileSync("test/code/mulit-type-test.domain/apiClient.ts", { encoding: "utf-8" });
1515
const text = Utils.replaceVersionInfo(generateCode);
1616
expect(text).toMatchSnapshot();
1717
});

‎test/__tests__/parameter-test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import * as Utils from "../utils";
55

66
describe("Parameter", () => {
77
test("api.test.domain", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/parameter/api.test.domain.json"), { encoding: "utf-8" });
8+
const generateCode = fs.readFileSync("test/code/parameter/api.test.domain.json", { encoding: "utf-8" });
99
const text = Utils.replaceVersionInfo(generateCode);
1010
expect(text).toMatchSnapshot();
1111
});
1212
test("infer.domain", () => {
13-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/parameter/infer.domain.json"), { encoding: "utf-8" });
13+
const generateCode = fs.readFileSync("test/code/parameter/infer.domain.json", { encoding: "utf-8" });
1414
const text = Utils.replaceVersionInfo(generateCode);
1515
expect(text).toMatchSnapshot();
1616
});

‎test/__tests__/spit-code-test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ import * as Utils from "../utils";
55

66
describe("Split Code", () => {
77
test("types", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/split/types.ts"), { encoding: "utf-8" });
8+
const generateCode = fs.readFileSync("test/code/split/types.ts", { encoding: "utf-8" });
99
const text = Utils.replaceVersionInfo(generateCode);
1010
expect(text).toMatchSnapshot();
1111
});
1212

1313
test("apiClient", () => {
14-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/split/apiClient.ts"), { encoding: "utf-8" });
14+
const generateCode = fs.readFileSync("test/code/split/apiClient.ts", { encoding: "utf-8" });
1515
const text = Utils.replaceVersionInfo(generateCode);
1616
expect(text).toMatchSnapshot();
1717
});

‎test/__tests__/template-only-test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ import * as Utils from "../utils";
55

66
describe("Template Only", () => {
77
test("api.test.domain", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/template-only/api.test.domain.ts"), { encoding: "utf-8" });
8+
const generateCode = fs.readFileSync("test/code/template-only/api.test.domain.ts", { encoding: "utf-8" });
99
const text = Utils.replaceVersionInfo(generateCode);
1010
expect(text).toMatchSnapshot();
1111
});
1212
test("async-api.test.domain", () => {
13-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/template-only/sync-api.test.domain.ts"), { encoding: "utf-8" });
13+
const generateCode = fs.readFileSync("test/code/template-only/sync-api.test.domain.ts", { encoding: "utf-8" });
1414
const text = Utils.replaceVersionInfo(generateCode);
1515
expect(text).toMatchSnapshot();
1616
});
1717
test("infer.domain", () => {
18-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/template-only/infer.domain.ts"), { encoding: "utf-8" });
18+
const generateCode = fs.readFileSync("test/code/template-only/infer.domain.ts", { encoding: "utf-8" });
1919
const text = Utils.replaceVersionInfo(generateCode);
2020
expect(text).toMatchSnapshot();
2121
});

‎test/__tests__/typedef-only-test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ import * as Utils from "../utils";
55

66
describe("Typedef only", () => {
77
test("typedef-api.test.domain", () => {
8-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/typedef-only/api.test.domain.ts"), { encoding: "utf-8" });
8+
const generateCode = fs.readFileSync("test/code/typedef-only/api.test.domain.ts", { encoding: "utf-8" });
99
const text = Utils.replaceVersionInfo(generateCode);
1010
expect(text).toMatchSnapshot();
1111
});
1212
test("typedef-infer.domain", () => {
13-
const generateCode = fs.readFileSync(path.join(__dirname, "../code/typedef-only/infer.domain.ts"), { encoding: "utf-8" });
13+
const generateCode = fs.readFileSync("test/code/typedef-only/infer.domain.ts", { encoding: "utf-8" });
1414
const text = Utils.replaceVersionInfo(generateCode);
1515
expect(text).toMatchSnapshot();
1616
});

0 commit comments

Comments
 (0)