Skip to content

test: POST with extract routes from API type definition #36309

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

Open
ahmed-n-abdeltwab wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

test: POST with extract routes from API type definition #36309

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
92 changes: 64 additions & 28 deletions apps/meteor/app/api/server/ApiClass.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,72 @@ import type { APIClass, ExtractRoutesFromAPI } from './ApiClass';
type Expect<T extends true> = T;
type ShallowEqual<X, Y> = X extends Y ? (Y extends X ? true : false) : false;

type API = APIClass<
'/v1',
{
method: 'GET';
path: '/v1/endpoint.test';
response: {
200: ValidateFunction<
PaginatedResult<{
describe('ExtractRoutesFromAPI type utility', () => {
it('Should return the expected type for GET', () => {
type API = APIClass<
'/v1',
{
method: 'GET';
path: '/v1/endpoint.test';
response: {
200: ValidateFunction<
PaginatedResult<{
sounds: string[];
}>
>;
};
query: ValidateFunction<{
query: string;
}>;
authRequired: true;
}
>;
type test = Expect<
ShallowEqual<
ReturnType<ExtractRoutesFromAPI<API>['/v1/endpoint.test']['GET']>,
{
count: number;
offset: number;
total: number;
sounds: string[];
}>
>;
};
query: ValidateFunction<{
query: string;
}>;
authRequired: true;
}
>;
}
>
>;

true as test;
});

it('Should return the expected type', () => {
type test = Expect<
ShallowEqual<
ReturnType<ExtractRoutesFromAPI<API>['/v1/endpoint.test']['GET']>,
it('Should return the expected type for POST', () => {
type API = APIClass<
'/v1',
{
count: number;
offset: number;
total: number;
sounds: string[];
method: 'POST';
path: '/v1/endpoint.test';
response: {
200: ValidateFunction<
PaginatedResult<{
sounds: string[];
}>
>;
};
body: ValidateFunction<{
query: string;
}>;
authRequired: true;
}
>
>;
true as test;
>;
type test = Expect<
ShallowEqual<
ReturnType<ExtractRoutesFromAPI<API>['/v1/endpoint.test']['POST']>,
{
count: number;
offset: number;
total: number;
sounds: string[];
}
>
>;

true as test;
});
Comment on lines +9 to +76
Copy link
Contributor Author

@ahmed-n-abdeltwab ahmed-n-abdeltwab Jun 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, I wrap the two tests together with describe and add the expected return type from the POST API.

});
Loading