chore: deprecate emitESMImage function

[ematipico]

Changes

Due to some mistake we've made, the utility function emitESMImage - which is exposed as public API - is broken.

To remedy the mistake, we will expose a new function to userland, which has a different signature (we removed the things we don't need).

I updated @astrojs/mdx to use the new function.

Testing

CI should stay green

Docs

I will send a PR to update the docs.

/cc @withastro/maintainers-docs for feedback!

[changeset-bot]

🦋 Changeset detected

Latest commit: 1c237ff

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[codspeed-hq]

CodSpeed Performance Report

Merging #13589 will not alter performance

_{Comparing chore/deprecate-function (04cdb87) with main (7d251c1)}

Summary

✅ 6 untouched benchmarks

[sarah11918]

Just wanted to jump in here quickly since there's the potential for this change to affect users and break their stuff. 😄 In that case I always recommend providing a bit more information, so here's an example of what could be helpful, for your consideration!

[ascorbic]

In what way is it broken? This is the function we use internally in lots of others place, not just in the markdoc plugin. If we're deprecating it we should update those usages too.

[ematipico]

If we're deprecating it we should update those usages too.

The deprecation is for the users. We still need to use that function internally to block the memory leak, and unfortunately, we can't rename it or change the exporting strategy.

The memory leak is currently blocked by the experimental flag passed to emitESMImage. In fact, I think I will revert the change in @astrojs/mdx, until we fix the memory leak.

[ascorbic]

It'll show as deprecated for internal use too though, right? I think best is to re-export it from packages/astro/src/assets/utils/index.ts with the deprecation in a different JSDoc

[ematipico]

See if that's what you want: 5dda4da (#13589)

[ascorbic]

Yeah, that works. Might be worth adding a note saying to use emitImageMetadata instead

[ematipico]

@sarah11918 can you please revisit the changeset again? I changed the last sentence to address Matt's comment