Skip to content

Commit 897cffa

Browse files
mrlubosmrlubos
authored
Merge pull request #2277 from hey-api/fix/client-serializer-return-type
fix(clients): annotate serializer return types
2 parents 63645d0 + 25fc54c commit 897cffa

File tree

161 files changed

+1437
-796
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

161 files changed

+1437
-796
lines changed

‎.changeset/tall-ears-listen.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@hey-api/openapi-ts': patch
3+
---
4+
5+
fix(clients): annotate serializer return types

‎packages/custom-client/src/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/body-response-text-plain/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/form-data/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/instance/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/throwOnError/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-valibot/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

‎packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/transformers/type-format-zod/core/bodySerializer.ts

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ export interface QuerySerializerOptions {
1414
object?: SerializerOptions<ObjectStyle>;
1515
}
1616

17-
const serializeFormDataPair = (data: FormData, key: string, value: unknown) => {
17+
const serializeFormDataPair = (
18+
data: FormData,
19+
key: string,
20+
value: unknown,
21+
): void => {
1822
if (typeof value === 'string' || value instanceof Blob) {
1923
data.append(key, value);
2024
} else {
@@ -26,7 +30,7 @@ const serializeUrlSearchParamsPair = (
2630
data: URLSearchParams,
2731
key: string,
2832
value: unknown,
29-
) => {
33+
): void => {
3034
if (typeof value === 'string') {
3135
data.append(key, value);
3236
} else {
@@ -37,7 +41,7 @@ const serializeUrlSearchParamsPair = (
3741
export const formDataBodySerializer = {
3842
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
3943
body: T,
40-
) => {
44+
): FormData => {
4145
const data = new FormData();
4246

4347
Object.entries(body).forEach(([key, value]) => {
@@ -56,7 +60,7 @@ export const formDataBodySerializer = {
5660
};
5761

5862
export const jsonBodySerializer = {
59-
bodySerializer: <T>(body: T) =>
63+
bodySerializer: <T>(body: T): string =>
6064
JSON.stringify(body, (_key, value) =>
6165
typeof value === 'bigint' ? value.toString() : value,
6266
),
@@ -65,7 +69,7 @@ export const jsonBodySerializer = {
6569
export const urlSearchParamsBodySerializer = {
6670
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(
6771
body: T,
68-
) => {
72+
): string => {
6973
const data = new URLSearchParams();
7074

7175
Object.entries(body).forEach(([key, value]) => {

0 commit comments

Comments
 (0)