Type error when passing Astro object to APIRoute

[minht11]

Astro Info

Astro                    v3.0.12
Node                     v16.20.0
System                   Linux (x64)
Package Manager          unknown
Output                   server
Adapter                  @astrojs/node
Integrations             none

If this issue only occurs in one browser, which browser is a problem?

No response

Describe the Bug

Calling endpoint in the server and passing Astro object to APIRoute produces error

Argument of type 'Readonly<AstroGlobal<Record<string, any>, AstroComponentFactory, Record<string, string | undefined>>>' is not assignable to parameter of type 'APIContext<Record<string, any>, Record<string, string | undefined>>'.
  Property 'ResponseWithEncoding' is missing in type 'Readonly<AstroGlobal<Record<string, any>, AstroComponentFactory, Record<string, string | undefined>>>' but required in type 'APIContext<Record<string, any>, Record<string, string | undefined>>'.

whole example can be found in Astro [call-endpoints recipe](https://docs.astro.build/en/recipes/call-endpoints/

This is regression with Astro 3.0, 2.10 did not have this issue.

What's the expected result?

No type error.

Link to Minimal Reproducible Example

https://stackblitz.com/edit/github-huqjmk?file=src%2Fpages%2Findex.astro

Participation

• I am willing to submit a pull request for this issue.

[matthewp]

Is there a property that's missing or not expected? That TS error isn't the greatest to read.

[Princesseuh]

The type is hard to read because of the many generics that are unfortunately needed for editor tooling, but I think the error is simply that APIContext has a ResponseWithEncoding property that the Astro global doesn't have

[matthewp]

Ah ok, we can probably add that.

[ematipico]

Is it a correct usage of the route endpoints?

[matthewp]

Yeah, after discussing this with some others, I'm not sure that we want to make it a breaking change if the API endpoint context types are unaligned with the Astro global. We do want to make them aligned when possible, but it shouldn't be a breaking change when they are not.

[artemszelenov]

I have the same issue. How to fix it?

[antheath]

@matthewp Is there a workaround to this issue? Do we need to downgrade to use API endpoints? This appears to be a breaking change.

[EddyVinck]

I "fixed" it by doing this:

let response = await GET({
  ...Astro,
  ResponseWithEncoding: Response,
  params: {
    id: post.data.id,
  },
});

But I am still getting an error when trying to do response.json() like the docs show:

Property 'json' does not exist on type 'EndpointOutput | Response'.
  Property 'json' does not exist on type '{ body: string; encoding?: BufferEncoding; }'

So I also have to do this:

const data = (await (response as Response).json()) as MyDataType;

[lnoss]

Meh, the only answer is types-torturing-casting? This is one of the examples showed in the documentation and it does just not work out of the box...

[lnoss]

Should be fixed in 4.0. No more torturing-casting with the current beta!
https://docs.astro.build/en/guides/upgrade-to/v4/#removed-returning-simple-objects-from-endpoints

[matthewp]

It's working in 4.0 but note that we do not have tests that enforce that it doesn't break again. Since this is not an official feature yet, it's not guaranteed to work. But if someone wants to submit tests to check that it does, would likely accept!

[luiguild]

Still having this type problem.

The error message:

src/pages/[placeLang].astro:17:47 - error ts(2345): Argument of type 'Readonly<AstroGlobal<never, (_props: never) => any, Params>>' is not assignable to parameter of type 'APIContext<Record<string, any>, Record<string, string | undefined>>'.
  Types of property 'params' are incompatible.

The code:

const place: Place = await GET(Astro);

package.json

"dependencies": {
    "@astrojs/check": "^0.3.1",
    "@astrojs/vue": "^4.0.2",
    "astro": "^4.0.3",
    "typescript": "^5.3.2",
    "vue": "^3.2.30",
    "vue-i18n": "9"
  },