Skip to content

refactor: Enhance API type definitions for route extraction #36388

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
ggazzo merged 2 commits into from
Jul 11, 2025
Merged

refactor: Enhance API type definitions for route extraction #36388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1faf70d
refactor: Enhance API type definitions for route extraction and metho…
ggazzo Jun 6, 2025
c518dc1
Merge branch 'develop' into chore/improve-route-typings
cardoso Jul 11, 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
13 changes: 9 additions & 4 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 @@ -66,8 +66,13 @@ export type Prettify<T> = {

type ExtractValidation<T> = T extends ValidateFunction<infer TSchema> ? TSchema : never;

export type ExtractRoutesFromAPI<T> =
T extends APIClass<any, infer TOperations> ? (TOperations extends MinimalRoute ? Prettify<ConvertToRoute<TOperations>> : never) : never;
type UnionToIntersection<U> = (U extends any ? (x: U) => any : never) extends (x: infer I) => any ? I : never;

export type ExtractRoutesFromAPI<T> = Prettify<
UnionToIntersection<
T extends APIClass<any, infer TOperations> ? (TOperations extends MinimalRoute ? Prettify<ConvertToRoute<TOperations>> : never) : never
>
>;

type ConvertToRoute<TRoute extends MinimalRoute> = {
[K in TRoute['path']]: {
Expand Down Expand Up @@ -578,7 +583,7 @@ export class APIClass<
TSubPathPattern extends string,
TOptions extends TypedOptions,
TPathPattern extends `${TBasePath}/${TSubPathPattern}`,
>(method: Method, subpath: TSubPathPattern, options: TOptions): void {
>(method: MinimalRoute['method'], subpath: TSubPathPattern, options: TOptions): void {
const path = `/${this.apiPath}/${subpath}`.replaceAll('//', '/') as TPathPattern;
this.typedRoutes = this.typedRoutes || {};
this.typedRoutes[path] = this.typedRoutes[subpath] || {};
Expand Down Expand Up @@ -629,7 +634,7 @@ export class APIClass<
}

private method<TSubPathPattern extends string, TOptions extends TypedOptions, TPathPattern extends `${TBasePath}/${TSubPathPattern}`>(
method: Method,
method: MinimalRoute['method'],
subpath: TSubPathPattern,
options: TOptions,
action: TypedAction<TOptions, TSubPathPattern>,
Expand Down
2 changes: 1 addition & 1 deletion apps/meteor/app/api/server/definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ export type NonEnterpriseTwoFactorOptions = {
twoFactorOptions: ITwoFactorOptions;
};

export type Options = SharedOptions<Method>;
export type Options = SharedOptions<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH'>;

export type SharedOptions<TMethod extends string> = (
| {
Expand Down
Loading