Skip to content

refactor: improve ExtractRoutesFromAPI for Route Conversions #36246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 10 commits into from
Jun 24, 2025
Merged

refactor: improve ExtractRoutesFromAPI for Route Conversions #36246

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b9f3d11
refactor: enhance type definitions in APIClass for better clarity
ahmed-n-abdeltwab Jun 19, 2025
d60334d
refactor: add Prettify in APIClass for route handling
ahmed-n-abdeltwab Jun 19, 2025
09b1d55
refactor: improve ExtractValidation in the ConvertToRoute type.
ahmed-n-abdeltwab Jun 19, 2025
6d96029
refactor: enhance the ConvertToRoute type for improved response valid…
ahmed-n-abdeltwab Jun 19, 2025
1336c20
refactor: extend APIClass to support additional POST route options
ahmed-n-abdeltwab Jun 19, 2025
9ece239
refactor: improve type extraction in ConvertToRoute for POST response…
ahmed-n-abdeltwab Jun 19, 2025
77684ca
Merge branch 'develop' into fix/extract-routes-from-api
ahmed-n-abdeltwab Jun 21, 2025
877ca34
Merge branch 'develop' into fix/extract-routes-from-api
cardoso Jun 22, 2025
4d6e421
Merge branch 'develop' into fix/extract-routes-from-api
cardoso Jun 23, 2025
f2951bb
Merge branch 'develop' into fix/extract-routes-from-api
kodiakhq[bot] Jun 24, 2025
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
34 changes: 27 additions & 7 deletions apps/meteor/app/api/server/ApiClass.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,21 @@ export type ExtractRoutesFromAPI<T> =

type ConvertToRoute<TRoute extends MinimalRoute> = {
[K in TRoute['path']]: {
[K2 in TRoute['method']]: K2 extends 'GET'
? (params: ExtractValidation<TRoute['query']>) => ExtractValidation<TRoute['response'][200]>
: (params: ExtractValidation<TRoute['body']>) => ExtractValidation<TRoute['response'][200 | 201]>;
[K2 in Extract<TRoute, { path: K }>['method']]: K2 extends 'GET'
? (
params: ExtractValidation<Extract<TRoute, { path: K; method: K2 }>['query']>,
) => ExtractValidation<Extract<TRoute, { path: K; method: K2 }>['response'][200]>
: K2 extends 'POST'
? (
params: ExtractValidation<Extract<TRoute, { path: K; method: K2 }>['body']>,
) => ExtractValidation<
200 extends keyof Extract<TRoute, { path: K; method: K2 }>['response']
? Extract<TRoute, { path: K; method: K2 }>['response'][200]
: 201 extends keyof Extract<TRoute, { path: K; method: K2 }>['response']
? Extract<TRoute, { path: K; method: K2 }>['response'][201]
: never
>
: never;
};
};

Expand Down Expand Up @@ -622,10 +634,12 @@ export class APIClass<
): APIClass<
TBasePath,
| TOperations
| ({
method: Method;
path: TPathPattern;
} & Omit<TOptions, 'response'>)
| Prettify<
{
method: Method;
path: TPathPattern;
} & Omit<TOptions, 'response'>
>
> {
this.addRoute([subpath], { tags: [], ...options, typed: true }, { [method.toLowerCase()]: { action } } as any);
this.registerTypedRoutes(method, subpath, options);
Expand Down Expand Up @@ -660,6 +674,12 @@ export class APIClass<
method: 'POST';
path: TPathPattern;
} & Omit<TOptions, 'response'>)
| Prettify<
{
method: 'POST';
path: TPathPattern;
} & TOptions
>
> {
return this.method('POST', subpath, options, action);
}
Expand Down
Loading