Skip to content

fix: fix types for custom providers shadowing builtins #2016

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

Merged
danielroe merged 3 commits into from
Nov 18, 2025
Merged

fix: fix types for custom providers shadowing builtins #2016

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
5ba2526
fix-2015: correct type generation for custom providers with same name…
dreitzner Nov 6, 2025
b07a305
Merge remote-tracking branch 'origin/main' into fix-2015-custom-provi…
danielroe Nov 16, 2025
cad2396
refactor: detect built-ins by provider path
danielroe Nov 16, 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
4 changes: 2 additions & 2 deletions src/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import process from 'node:process'
import { hasProtocol, parseURL, withLeadingSlash } from 'ufo'
import { defineNuxtModule, addTemplate, addImports, addServerImports, createResolver, addComponent, addPlugin, addServerTemplate, addTypeTemplate } from '@nuxt/kit'
import { join, relative, resolve } from 'pathe'
import { resolveProviders, detectProvider, resolveProvider, BuiltInProviders } from './provider'
import { resolveProviders, detectProvider, resolveProvider, BuiltInProviders, isBuiltInProvider } from './provider'
import type { ImageOptions, InputProvider, CreateImageOptions, ImageModuleProvider, ImageProviders } from './types'
import { existsSync } from 'node:fs'

Expand Down Expand Up @@ -122,7 +122,7 @@ export default defineNuxtModule<ModuleOptions>({
provider: ${JSON.stringify(options.provider)}
}
interface ConfiguredImageProviders {
${providers.map(p => ` ${JSON.stringify(p.name)}: ${BuiltInProviders.includes(p.name as 'ipx') ? `ImageProviders[${JSON.stringify(p.name)}]` : `ReturnType<typeof import('${relative(file, p.runtime)}').default> extends ImageProvider<infer Options> ? Options : unknown `}`).join('\n')}
${providers.map(p => ` ${JSON.stringify(p.name)}: ${isBuiltInProvider(p) ? `ImageProviders[${JSON.stringify(p.name)}]` : `ReturnType<typeof import('${relative(file, p.runtime)}').default> extends ImageProvider<infer Options> ? Options : unknown `}`).join('\n')}
}
interface ImageProviders {
${BuiltInProviders.map(p => ` ${JSON.stringify(p)}: ReturnType<typeof import('${relative(file, resolver.resolve('./runtime/providers/' + p))}').default> extends ImageProvider<infer Options> ? Options : unknown `).join('\n')}
Expand Down
10 changes: 8 additions & 2 deletions src/provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,13 @@ export const BuiltInProviders = [
'sirv',
] as const

const resolver = createResolver(import.meta.url)
const providerRuntime = resolver.resolve('./runtime/providers/')

export function isBuiltInProvider(provider: ImageModuleProvider) {
return provider.provider?.startsWith(providerRuntime) ?? BuiltInProviders.includes(provider.name as 'ipx')
}

type ImageProviderName = typeof BuiltInProviders[number]

const providerSetup: Partial<Record<ImageProviderName, ProviderSetup>> = {
Expand Down Expand Up @@ -127,7 +134,7 @@ export async function resolveProviders(nuxt: any, options: ModuleOptions): Promi

export async function resolveProvider(_nuxt: any, key: string, input: InputProvider): Promise<ImageModuleProvider> {
if (typeof input === 'string') {
input = { name: input }
input = { name: key, provider: input }
}

if (!input.name) {
Expand All @@ -142,7 +149,6 @@ export async function resolveProvider(_nuxt: any, key: string, input: InputProvi
input.provider = normalizableProviders[input.provider]!()
}

const resolver = createResolver(import.meta.url)
input.provider = BuiltInProviders.includes(input.provider as ImageProviderName)
? resolver.resolve('./runtime/providers/' + input.provider)
: await resolvePath(input.provider)
Expand Down
Loading