Skip to content

Infer HttpApi's groups and HttpApiGroup's endpoints correctly. #5280

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
wants to merge 3 commits into
base: next-minor
Choose a base branch
from
Open

Infer HttpApi's groups and HttpApiGroup's endpoints correctly. #5280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3537394
made sure the groups and endpoints of api are type safe
MrGeniusProgrammer Jul 24, 2025
8a16282
added readonly
MrGeniusProgrammer Jul 24, 2025
84ddae2
added changeset
MrGeniusProgrammer Jul 25, 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
5 changes: 5 additions & 0 deletions .changeset/warm-hoops-allow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/platform": minor
---

The type of the HttpApi groups and endpoints are correctly inferred.
4 changes: 3 additions & 1 deletion packages/platform/src/HttpApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,9 @@ export interface HttpApi<
new(_: never): {}
readonly [TypeId]: TypeId
readonly identifier: Id
readonly groups: Record.ReadonlyRecord<string, Groups>
readonly groups: {
readonly [K in HttpApiGroup.HttpApiGroup.Name<Groups>]: HttpApiGroup.HttpApiGroup.WithName<Groups, K>
}
readonly annotations: Context.Context<never>
readonly errorSchema: Schema.Schema<E, unknown, R>
readonly middlewares: ReadonlySet<HttpApiMiddleware.TagClassAny>
Expand Down
4 changes: 3 additions & 1 deletion packages/platform/src/HttpApiGroup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,9 @@ export interface HttpApiGroup<
readonly [TypeId]: TypeId
readonly identifier: Id
readonly topLevel: TopLevel
readonly endpoints: Record.ReadonlyRecord<string, Endpoints>
readonly endpoints: {
readonly [K in HttpApiEndpoint.HttpApiEndpoint.Name<Endpoints>]: HttpApiEndpoint.HttpApiEndpoint.WithName<Endpoints, K>
}
readonly errorSchema: Schema.Schema<Error, unknown, R>
readonly annotations: Context.Context<never>
readonly middlewares: ReadonlySet<HttpApiMiddleware.TagClassAny>
Expand Down