(feat) return updated config in integration hooks

[nerdoza]

Changes

Summary of change in this discussion thread: withastro/roadmap#762

• In the astro:config:setup hook for integrations, calls to updateConfig now return a destructured instance of the updated configuration.
• Changes updateConfig property to be strongly typed deep partial of the AstroConfig type.

Testing

• Unit test was added to astro/test/units/integrations/api.test.js.
• Tested bundle against another package using AstroAdapter in a local environment.

Docs

• Corresponding doc changes in feat: update integration documentation docs#5306

[changeset-bot]

🦋 Changeset detected

Latest commit: 60fea6e

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

[florian-lefebvre]

Really cool! I know this is not the initial goal of this PR but it would great to type the newConfig argument (Partial<AstroConfig>?)

[nerdoza]

@florian-lefebvre, good point. Added.

[matthewp]

why is this a spread? Does it need to be cloned?

[nerdoza]

It's spread in the original declaration for updatedConfig, so I'm just maintaining consistency. The object is pretty deep so this feels like it should either be a true clone or a read-only object, but those both seem a bit outside the scope of this issue.

Ref:

astro/packages/astro/src/integrations/index.ts

Lines 72 to 77 in 06c51cc

	let updatedConfig: AstroConfig = { ...settings.config };
	let updatedSettings: AstroSettings = { ...settings, config: updatedConfig };
	let addedClientDirectives = new Map<string, Promise<string>>();
	let astroJSXRenderer: AstroRenderer | null = null;

[matthewp]

We're going to do a final patch for Astro 3.x, then once that is done this will be merged in and be part of Astro 4.0.

[lilnasy]

This certainly is a lot better than before, but it could maybe give a false sense of safety. {} is technically Partial<URL>, for example.

[lilnasy]

It would be an edge case admittedly, and the runtime logic might actually handle it too. I'll take a closer look when I can, but I'm not blocking a merge.

[bluwy]

Will be merging this for Astro 4 soon.