Skip to content

Commit a9e0a14

Browse files
HimenonHimenon
authored
feat(breaking change): update apiClient arguments interface (#106)
1 parent afcb023 commit a9e0a14

24 files changed

+14987
-2178
lines changed

‎jest.snapshot.config.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ module.exports = {
1212
"@swc/jest",
1313
{
1414
jsc: {
15-
parser :{
16-
syntax: "typescript"
17-
}
18-
}
15+
parser: {
16+
syntax: "typescript",
17+
},
18+
},
1919
},
2020
],
2121
},

‎src/code-templates/_shared/ApiClientInterface.ts

+45-27
Original file line numberDiff line numberDiff line change
@@ -117,33 +117,10 @@ export const create = (factory: TsGenerator.Factory.Type, list: CodeGenerator.Pa
117117
],
118118
});
119119

120-
const httpMethod = factory.ParameterDeclaration.create({
121-
name: "httpMethod",
120+
const requestArgs = factory.ParameterDeclaration.create({
121+
name: "requestArgs",
122122
type: factory.TypeReferenceNode.create({
123-
name: "HttpMethod",
124-
}),
125-
});
126-
const url = factory.ParameterDeclaration.create({
127-
name: "url",
128-
type: factory.TypeNode.create({ type: "string" }),
129-
});
130-
const headers = factory.ParameterDeclaration.create({
131-
name: "headers",
132-
type: objectLikeOrAnyType,
133-
});
134-
const requestBody = factory.ParameterDeclaration.create({
135-
name: "requestBody",
136-
type: objectLikeOrAnyType,
137-
});
138-
const queryParameters = factory.ParameterDeclaration.create({
139-
name: "queryParameters",
140-
type: factory.UnionTypeNode.create({
141-
typeNodes: [
142-
factory.TypeReferenceNode.create({
143-
name: "QueryParameters",
144-
}),
145-
factory.TypeNode.create({ type: "undefined" }),
146-
],
123+
name: "RequestArgs",
147124
}),
148125
});
149126
const options = factory.ParameterDeclaration.create({
@@ -186,7 +163,7 @@ export const create = (factory: TsGenerator.Factory.Type, list: CodeGenerator.Pa
186163
}),
187164
}),
188165
],
189-
parameters: [httpMethod, url, headers, requestBody, queryParameters, options],
166+
parameters: [requestArgs, options],
190167
type: returnType,
191168
});
192169

@@ -196,12 +173,53 @@ export const create = (factory: TsGenerator.Factory.Type, list: CodeGenerator.Pa
196173
type: functionType,
197174
});
198175

176+
const requestArgsInterfaceDeclaration = factory.InterfaceDeclaration.create({
177+
export: true,
178+
name: "RequestArgs",
179+
members: [
180+
factory.PropertySignature.create({
181+
name: `httpMethod`,
182+
optional: false,
183+
type: factory.TypeReferenceNode.create({ name: "HttpMethod" }),
184+
}),
185+
factory.PropertySignature.create({
186+
name: `url`,
187+
optional: false,
188+
type: factory.TypeReferenceNode.create({ name: "string" }),
189+
}),
190+
factory.PropertySignature.create({
191+
name: `headers`,
192+
optional: false,
193+
type: objectLikeOrAnyType,
194+
}),
195+
factory.PropertySignature.create({
196+
name: `requestBody`,
197+
optional: false,
198+
type: objectLikeOrAnyType,
199+
}),
200+
factory.PropertySignature.create({
201+
name: `queryParameters`,
202+
optional: false,
203+
type: factory.UnionTypeNode.create({
204+
typeNodes: [
205+
factory.TypeReferenceNode.create({
206+
name: "QueryParameters",
207+
}),
208+
factory.TypeNode.create({ type: "undefined" }),
209+
],
210+
}),
211+
}),
212+
],
213+
typeParameters: [],
214+
});
215+
199216
return [
200217
createHttpMethod(factory),
201218
createObjectLikeInterface(factory),
202219
...createQueryParamsDeclarations(factory),
203220
createSuccessResponseTypeAlias("SuccessResponses", factory, successResponseNames),
204221
errorResponseNamespace,
222+
requestArgsInterfaceDeclaration,
205223
factory.InterfaceDeclaration.create({
206224
export: true,
207225
name: "ApiClient",

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

+32-12
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,38 @@ export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.
2020
function: "apiClient.request",
2121
};
2222
const expression = Utils.generateVariableIdentifier(factory, apiClientVariableIdentifier[methodType]);
23-
const argumentsArray = [
24-
factory.StringLiteral.create({ text: params.operationParams.httpMethod.toUpperCase() }),
25-
factory.Identifier.create({ name: "url" }),
26-
factory.Identifier.create({ name: "headers" }),
27-
convertedParams.hasRequestBody
28-
? Utils.generateVariableIdentifier(factory, "params.requestBody")
29-
: factory.Identifier.create({ name: "undefined" }),
30-
convertedParams.hasQueryParameters
31-
? factory.Identifier.create({ name: "queryParameters" })
32-
: factory.Identifier.create({ name: "undefined" }),
33-
factory.Identifier.create({ name: "option" }),
34-
];
23+
24+
const requestArgs = factory.ObjectLiteralExpression.create({
25+
properties: [
26+
factory.PropertyAssignment.create({
27+
name: "httpMethod",
28+
initializer: factory.StringLiteral.create({ text: params.operationParams.httpMethod.toUpperCase() }),
29+
}),
30+
factory.PropertyAssignment.create({
31+
name: "url",
32+
initializer: factory.Identifier.create({ name: "url" }),
33+
}),
34+
factory.PropertyAssignment.create({
35+
name: "headers",
36+
initializer: factory.Identifier.create({ name: "headers" }),
37+
}),
38+
factory.PropertyAssignment.create({
39+
name: "requestBody",
40+
initializer: convertedParams.hasRequestBody
41+
? Utils.generateVariableIdentifier(factory, "params.requestBody")
42+
: factory.Identifier.create({ name: "undefined" }),
43+
}),
44+
factory.PropertyAssignment.create({
45+
name: "queryParameters",
46+
initializer: convertedParams.hasQueryParameters
47+
? factory.Identifier.create({ name: "queryParameters" })
48+
: factory.Identifier.create({ name: "undefined" }),
49+
}),
50+
],
51+
multiLine: true,
52+
});
53+
54+
const argumentsArray = [requestArgs, factory.Identifier.create({ name: "option" })];
3555

3656
return factory.CallExpression.create({
3757
expression: expression,

‎src/code-templates/_shared/MethodBody/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,10 @@ export const create = (factory: TsGenerator.Factory.Type, params: CodeGenerator.
6464
const queryParameter = pickedParameters.filter(item => item.in === "query");
6565
const queryObject = Object.values(queryParameter).reduce<{ [key: string]: QueryParameter.Item }>((previous, current) => {
6666
const { text, escaped } = escapeText(current.name);
67-
const variableDeclaraText = escaped ? `params.parameter[${text}]` : `params.parameter.${text}`;
67+
const variableDeclareText = escaped ? `params.parameter[${text}]` : `params.parameter.${text}`;
6868
return {
6969
...previous,
70-
[current.name]: { type: "variable", value: variableDeclaraText, style: current.style, explode: !!current.explode },
70+
[current.name]: { type: "variable", value: variableDeclareText, style: current.style, explode: !!current.explode },
7171
};
7272
}, {});
7373
statements.push(QueryParameter.create(factory, { variableName: "queryParameters", object: queryObject }));

‎src/code-templates/functional-api-client/FunctionalApiClient/ClientTypeDefinition.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ export const create = (factory: TsGenerator.Factory.Type): ts.TypeAliasDeclarati
77
name: "ClientFunction<RequestOption>",
88
type: factory.TypeReferenceNode.create({
99
name: `typeof createClient<RequestOption>`,
10-
})
10+
}),
1111
}),
1212
factory.TypeAliasDeclaration.create({
1313
export: true,
1414
name: "Client<RequestOption>",
1515
type: factory.TypeReferenceNode.create({
1616
name: `ReturnType<ClientFunction<RequestOption>>`,
17-
})
18-
})
19-
]
17+
}),
18+
}),
19+
];
2020
};

‎src/code-templates/functional-api-client/index.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export const generator: CodeGenerator.GenerateFunction<Option> = (
3939
statements.push(apiClientStatement);
4040
ClientTypeDefinition.create(factory).forEach(statement => {
4141
statements.push(statement);
42-
})
43-
42+
});
43+
4444
return statements;
4545
};

‎src/internal/TsGenerator/factory/VariableDeclaration.ts

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import ts from "typescript";
2-
import { generateComment } from "./utils";
32

43
export interface Params {
54
name: string | ts.BindingName;

‎src/internal/TsGenerator/factory/VariableDeclarationList.ts

-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import ts from "typescript";
2-
import { generateComment } from "./utils";
32

43
const flags = {
54
const: ts.NodeFlags.Const,
@@ -8,7 +7,6 @@ const flags = {
87
export interface Params {
98
declarations: readonly ts.VariableDeclaration[];
109
flag: keyof typeof flags;
11-
1210
}
1311

1412
export interface Factory {

0 commit comments

Comments
 (0)