Preset ipxStatic does not inherit ipx's providerOptions

[IO-Fire]

When static sites are generated, the configuration of the ipx provider is not used when building the site with SSG. This can cause different results and confusion between development and production using a nitro preset of static e.g. cloudflare_pages_static.

Using a static preset sets the provider to ipxStatic:

image/src/module.ts

Lines 138 to 139 in 5e90a19

	const resolvedProvider = nitro.options.static || options.provider === 'ipxStatic'
	? 'ipxStatic'

Therefore, the preset configuration of ipx is not applied here:

image/src/ipx.ts

Lines 39 to 54 in cef2f82

	const ipxOptions: IPXRuntimeConfig = {
	...providerOptions.options,
	baseURL: ipxBaseURL,
	alias: {
	...moduleOptions.alias,
	...providerOptions.options?.alias,
	},
	fs: (providerOptions.options?.fs !== false) && {
	dir: nuxt.options.dev ? publicDirs : relativeDir,
	...providerOptions.options?.fs,
	},
	http: (providerOptions.options?.http !== false) && {
	domains: moduleOptions.domains,
	...providerOptions.options?.http,
	},
	}

Example

Using the Nuxt config of:

// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
  
  image: {
    domains: ['https://blog.domain.tld'],
    ipx: {
      http: {
        fetchOptions: {
          headers: { "X-API-KEY": process.env.BLOG_IMG_API_KEY! },
        },
      },
    },
  },
  
});

Using SSG at build time results in providerOptions.options = {} as no ipxStatic preset options exist in the above nuxt.config.ts for:

image/src/ipx.ts

Line 52 in cef2f82

...providerOptions.options?.http,

While this can be resolved by using duplicating the Nuxt configuration for the ipx provider into an ipxStatic provider, this may not be obvious to users.

// https://nuxt.com/docs/api/configuration/nuxt-config
export default defineNuxtConfig({
  
  image: {
    domains: ['https://blog.domain.tld'],
    ipx: {
      http: {
        fetchOptions: {
          headers: { "X-API-KEY": process.env.BLOG_IMG_API_KEY! },
        },
      },
    },
    ipxStatic: {
      http: {
        fetchOptions: {
          headers: { "X-API-KEY": process.env.BLOG_IMG_API_KEY! },
        },
      },
    },
  },
  
});

Suggested Solutions

One

Remove the ipxStatic preset and update the logic to signal that the build is static another way.

Two

Update the preset logic on ipxStatic to first import the ipx preset options and runtime options then override with any ipxStatic options.

Three

Update https://image.nuxt.com/advanced/static-images to warn that the ipxStatic preset is not the same as ipx and that the ipxStatic preset options should be set to mirror ipx.

Four

Warn at build time that the ipxStatic preset is being used instead of ipx and that the ipxStatic preset options should be set to mirror ipx.

[IO-Fire]

Possibly related to:

• IPX Static Render Skipped with Custom BaseURL #1394
• IPX images not found when setting nitro.static to true in development #1397

[danielroe]

I think ipxStatic provider options should inherit from ipx.