Error: [@vue/compiler-sfc] Failed to resolve index type into finite keys #8286

dimatakoy · 2023-05-11T17:16:19Z

Vue version

3.3.1

Link to minimal reproduction

https://github.com/dimatakoy/vue-ts-bug

Steps to reproduce

Just use a common pattern that allows for convenient autocomplete code in SFC components

interface MyButtonProps extends ButtonHTMLAttributes {
    variant: 'blue' | 'white'
}

// or

type MyButtonTypeProps = {
  variant: 'blue | 'white'
} & ButtonHTMLAttributes

// or 
interface MyButtonProps extends ButtonHTMLAttributes {
}

# Or just build repro example, you will see error in terminal.
npm run build

What is expected?

works

What is actually happening?

[vite:vue] [@vue/compiler-sfc] Failed to resolve index type into finite keys

__masked__/vue-ts-bug/node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts
1258|  }
1259|  type EventHandlers<E> = {
1260|      [K in keyof E]?: E[K] extends (...args: any) => any ? E[K] : (payload: E[K]) => void;
   |            ^^^^^^^
1261|  };
1262|  
file: __masked__/vue-ts-bug/src/MyButton.vue
error during build:
Error: [@vue/compiler-sfc] Failed to resolve index type into finite keys

__masked__/vue-ts-bug/node_modules/@vue/runtime-dom/dist/runtime-dom.d.ts
1258|  }
1259|  type EventHandlers<E> = {
1260|      [K in keyof E]?: E[K] extends (...args: any) => any ? E[K] : (payload: E[K]) => void;
   |            ^^^^^^^
1261|  };
1262|  
    at ScriptCompileContext.error (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:15839:11)
    at resolveStringType (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:18187:14)
    at resolveMappedType (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:18080:16)
    at innerResolveTypeElements (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:17926:14)
    at resolveTypeElements (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:17900:35)
    at innerResolveTypeElements (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:17945:16)
    at resolveTypeElements (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:17900:35)
    at resolveInterfaceMembers (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:18068:25)
    at innerResolveTypeElements (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:17912:14)
    at resolveTypeElements (__masked__/vue-ts-bug/node_modules/@vue/compiler-sfc/dist/compiler-sfc.cjs.js:17900:35)

System Info

System:
    OS: macOS 13.3.1
    CPU: (8) arm64 Apple M1
    Memory: 103.86 MB / 8.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 18.16.0 - ~/.n/bin/node
    Yarn: 1.22.19 - ~/.n/bin/yarn
    npm: 9.6.6 - ~/.n/bin/npm
  Browsers:
    Chrome: 113.0.5672.92
    Safari: 16.4
  npmPackages:
    vue: ^3.3.1 => 3.3.1

Any additional comments?

looks like it works on 3.2.* and breaks after 3.3.*

The text was updated successfully, but these errors were encountered:

dimatakoy · 2023-05-11T18:18:55Z

@yyx990803 , can you check this issue? Looks like code was broken after refactoring.

dimatakoy · 2023-05-11T18:45:31Z

The documents say that the syntax I use is possible

Update:
hmm, since EventHandlers uses generic, then extending from HTMLAttributes is impossible? But how it works in previous versions?

ahnpnl · 2023-05-11T20:03:38Z

I ran into same issue if I do

type ButtonProps = Pick<ButtonHTMLAttributes, 'type' | 'id' | 'name'>;

defineProps<ButtonProps>();

yendyr · 2023-05-12T08:14:30Z

downgrade to exact version: 3.2.47 will resolve this issue.. i've been faced same issue

LeoFeng23 · 2023-05-12T08:55:38Z

same problem

…w ignoring extends ref #8286

yyx990803 · 2023-05-12T12:22:18Z

The original repro (and any usage that used a Props interface that extends external types) seemed to work in 3.2, but the 3.2 behavior was actually silently ignoring the extends. So it allowed those props to be passed at the type / IDE level, but at runtime they are not treated as actual props, but fallthrough attrs.

It was an oversight in 3.2 - technically we should've just thrown errors in this case. But somehow many users considered this a "workaround" or accidentally relied on it without realizing it's being ignored for runtime codegen. However, this may be exactly what the user wants in certain scenarios, e.g. they just want a component to allow all HTML attrs at the type level, but treat them as fallthrough attrs.

In 3.3, the compiler will now actually attempt to resolve the base type, and in this case the base type involves a complex type that is not supported, so it fails with an error.

I've made this case to produce a more specific error message in 8235072 - the commit also allows you to explicitly ignore the extend (i.e. the 3.2 behavior) with an inline /* @vue-ignore */ comment. This should allow 3.2 code that used to work to retain the same behavior.

ahnpnl · 2023-05-12T12:28:19Z

Hi @yyx990803, complex type includes also all the types which are created from type utility like Pick, Omit etc?

dimatakoy · 2023-05-12T12:33:27Z

Hi @yyx990803, complex type includes also all the types which are created from type utility like Pick, Omit etc?

It ANY type that have underline type-computations (even &, |, and generics(any utility types too)). HTMLAttributes extends EventHandlers, so for now we cannot use this trick without @vue-ignore comment.

seahindeniz · 2023-05-15T13:50:50Z

The magical comment is not a good DX friendly solution, IMHO

marsidev · 2023-05-19T21:46:54Z

There is a safe way (without /* @vue-ignore */) to extends Props with HTMLAttributes?

dimatakoy · 2023-05-21T17:37:31Z

This is a rather strange situation, it turns out that if you want to use basic html attributes on a component, you have to specify them all explicitly or use a hack with ignore comment.

Given that we have attribute passing down, and we don't need to validate them, vue-tsc could suggest valid attributes for html elements by itself.

This seems like a more elegant solution for a situation where we don't need to validate attributes in runtime.

@yyx990803, сan you share your thoughts?

ref: vuejs/core#8286

gorankarlic · 2023-06-08T16:57:09Z

If understand correctly this issue (which I also ran into) basically means that Vue 3 only supports "trivial" TypeScript types for props.

In my opinion this in fact means that "Vue does not actually support TypeScript (but just a small subset of it)" - while the documentation misstates that it "provides first-class TypeScript support".

Please either fix the issue or at least change the documentation to state that the TypeScript support is "limited" at best and not "first class" at all.

dimatakoy · 2023-06-08T23:12:56Z

In my personal view its so painfully. We have limited typescript and usual typescript together, in one place. This feels strange, unpredictable and boilerplaty, since we must declare app types and special types for half of components.

Generating runtime checks from declarations was a bad idea, since its so limited. Its job that can be done on another side(api layer/business logic layer), even for simple cases.

Also, its pretty useless, since (as i know) we cannot catch this runtime validation error and then change app behavior.

DeVoresyah · 2023-06-09T19:33:44Z

If understand correctly this issue (which I also ran into) basically means that Vue 3 only supports "trivial" TypeScript types for props.

In my opinion this in fact means that "Vue does not actually support TypeScript (but just a small subset of it)" - while the documentation misstates that it "provides first-class TypeScript support".

Please either fix the issue or at least change the documentation to state that the TypeScript support is "limited" at best and not "first class" at all.

agree, hope vue will fully support typescript in the future

Disservin · 2023-06-16T14:47:02Z

I agree with the comments above me. I recently ran into this issue when trying to extend from a global interface.

You can find the code here:
https://github.com/Disservin/vue-ts-error

I personally think this case is rather common, where you have a global interface but a component needs to extend it because has additional properties that the base does not have. Adding /* @vue-ignore */ is a bit cumbersome

fabon-f · 2023-06-18T04:07:43Z

As a workaround, component definition with defineComponent in vue 3.3 (doc) works well with complex types. I think it works on both SFC and TSX.

<script lang="ts">
import { h } from 'vue';

export default defineComponent((props: ComplexType, context) => {
  return () => h('div')
}, { props: ['prop1', 'prop2'] })
</script>

<!-- or -->

<script lang="tsx">
export default defineComponent((props: ComplexType, context) => {
  return () => <div></div>
}, { props: ['prop1', 'prop2'] })
</script>

brunoalod · 2023-07-24T23:47:18Z

Any news about this?

wokalek · 2023-08-13T17:11:02Z

Still need to be fixed...

so1ve · 2023-08-20T17:15:55Z

Vue doesn't aim to be a fully functional typescript resolver, so this issue will never be resolved since vue doesn't use typescript api, but a custom resolver based on babel AST. It only tries to resolve basic types we use (because creating a working type resolver requires a lot of work - see checker.ts!). If you rely on these complex types, I've created a new project: https://github.com/so1ve/unplugin-vue-complex-types which uses the typescript compiler's API to resolve these types. It's not finished yet, but stay tuned! :)

Update: It has basic functionality now, but pretty slow! :(

binochoi · 2023-09-03T07:29:11Z

@vue-ignore is even pretty weird.
when i use complex type of the other lib, i should to use interface. type is unavailabled.

interface Props extends /** @vue-ignore */ Extended { }

its forced use case.
cannot using type. only recommended interface with complex type..
and if u developing with eslint, no-empty-interface rule ignoring is forced too.

I think there should be any other solution except vue-ignore.

yyx990803 added a commit that referenced this issue May 12, 2023

fix(compiler-sfc): raise specific warning for failed extends and allo…

8235072

…w ignoring extends ref #8286

yyx990803 closed this as completed May 12, 2023

becem-gharbi mentioned this issue May 13, 2023

Failed to resolve extends base type after 1.1.0 becem-gharbi/nuxt-naiveui#5

Closed

Shinigami92 mentioned this issue May 15, 2023

Extending Props results in build error because of custom ExtractPublicPropTypes tusen-ai/naive-ui#4810

Closed

ras0q added a commit to traPtitech/traQ_S-UI that referenced this issue May 31, 2023

🐛 add @vue-ignore

d9ab227

ref: vuejs/core#8286

MaxPostema mentioned this issue Aug 23, 2023

fix(settings): Have a better email input in member settings molgenis/molgenis-emx2#2684

Merged

sxzz mentioned this issue Sep 1, 2023

[@vue/compiler-sfc] Failed to resolve index type into finite keys #9111

Closed

github-actions bot locked and limited conversation to collaborators Sep 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Error: [@vue/compiler-sfc] Failed to resolve index type into finite keys #8286

Error: [@vue/compiler-sfc] Failed to resolve index type into finite keys #8286

dimatakoy commented May 11, 2023 •

edited

Loading

dimatakoy commented May 11, 2023

dimatakoy commented May 11, 2023 •

edited

Loading

ahnpnl commented May 11, 2023

yendyr commented May 12, 2023

LeoFeng23 commented May 12, 2023

yyx990803 commented May 12, 2023 •

edited

Loading

ahnpnl commented May 12, 2023

dimatakoy commented May 12, 2023

seahindeniz commented May 15, 2023

marsidev commented May 19, 2023

dimatakoy commented May 21, 2023

gorankarlic commented Jun 8, 2023 •

edited

Loading

dimatakoy commented Jun 8, 2023

DeVoresyah commented Jun 9, 2023

Disservin commented Jun 16, 2023 •

edited

Loading

fabon-f commented Jun 18, 2023 •

edited

Loading

brunoalod commented Jul 24, 2023

wokalek commented Aug 13, 2023

so1ve commented Aug 20, 2023 •

edited

Loading

binochoi commented Sep 3, 2023

Error: [@vue/compiler-sfc] Failed to resolve index type into finite keys #8286

Error: [@vue/compiler-sfc] Failed to resolve index type into finite keys #8286

Comments

dimatakoy commented May 11, 2023 • edited Loading

Vue version

Link to minimal reproduction

Steps to reproduce

What is expected?

What is actually happening?

System Info

Any additional comments?

dimatakoy commented May 11, 2023

dimatakoy commented May 11, 2023 • edited Loading

ahnpnl commented May 11, 2023

yendyr commented May 12, 2023

LeoFeng23 commented May 12, 2023

yyx990803 commented May 12, 2023 • edited Loading

ahnpnl commented May 12, 2023

dimatakoy commented May 12, 2023

seahindeniz commented May 15, 2023

marsidev commented May 19, 2023

dimatakoy commented May 21, 2023

gorankarlic commented Jun 8, 2023 • edited Loading

dimatakoy commented Jun 8, 2023

DeVoresyah commented Jun 9, 2023

Disservin commented Jun 16, 2023 • edited Loading

fabon-f commented Jun 18, 2023 • edited Loading

brunoalod commented Jul 24, 2023

wokalek commented Aug 13, 2023

so1ve commented Aug 20, 2023 • edited Loading

binochoi commented Sep 3, 2023

dimatakoy commented May 11, 2023 •

edited

Loading

dimatakoy commented May 11, 2023 •

edited

Loading

yyx990803 commented May 12, 2023 •

edited

Loading

gorankarlic commented Jun 8, 2023 •

edited

Loading

Disservin commented Jun 16, 2023 •

edited

Loading

fabon-f commented Jun 18, 2023 •

edited

Loading

so1ve commented Aug 20, 2023 •

edited

Loading