diff --git a/packages/dts-test/defineComponent.test-d.tsx b/packages/dts-test/defineComponent.test-d.tsx index 838f73992d8..077f1abc075 100644 --- a/packages/dts-test/defineComponent.test-d.tsx +++ b/packages/dts-test/defineComponent.test-d.tsx @@ -15,7 +15,7 @@ import { withKeys, withModifiers, } from 'vue' -import { type IsUnion, describe, expectType } from './utils' +import { type IsAny, type IsUnion, describe, expectType } from './utils' describe('with object props', () => { interface ExpectedProps { @@ -1651,6 +1651,7 @@ describe('__typeProps backdoor for union type for conditional props', () => { ; const c = new Comp() + // @ts-expect-error c.$props = { color: 'white' } // @ts-expect-error @@ -1755,3 +1756,13 @@ describe('__typeEmits backdoor, call signature syntax', () => { // @ts-expect-error c.$emit('update', 123) }) + +defineComponent({ + props: { + foo: [String, null], + }, + setup(props) { + expectType>(false) + expectType(props.foo) + }, +}) diff --git a/packages/runtime-core/src/apiDefineComponent.ts b/packages/runtime-core/src/apiDefineComponent.ts index 459b97debb3..70b9d727c64 100644 --- a/packages/runtime-core/src/apiDefineComponent.ts +++ b/packages/runtime-core/src/apiDefineComponent.ts @@ -3,9 +3,6 @@ import type { ComponentOptions, ComponentOptionsBase, ComponentOptionsMixin, - ComponentOptionsWithArrayProps, - ComponentOptionsWithObjectProps, - ComponentOptionsWithoutProps, ComponentProvideOptions, ComputedOptions, MethodOptions, @@ -26,7 +23,7 @@ import type { ExtractPropTypes, } from './componentProps' import type { - EmitsOptions, + ComponentEmitsOptions, EmitsToProps, TypeEmitsToOptions, } from './componentEmits' @@ -38,13 +35,16 @@ import type { } from './componentPublicInstance' import type { SlotsType } from './componentSlots' import type { Directive } from './directives' -import type { TypeEmits } from './apiSetupHelpers' +import type { ComponentTypeEmits } from './apiSetupHelpers' export type PublicProps = VNodeProps & AllowedComponentProps & ComponentCustomProps -type ResolveProps = Readonly< +type ResolveProps< + PropsOrPropOptions, + E extends ComponentEmitsOptions, +> = Readonly< PropsOrPropOptions extends ComponentPropsOptions ? ExtractPropTypes : PropsOrPropOptions @@ -59,7 +59,7 @@ export type DefineComponent< M extends MethodOptions = MethodOptions, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, EE extends string = string, PP = PublicProps, Props = ResolveProps, @@ -113,7 +113,7 @@ export type DefineComponent< export type DefineSetupFnComponent< P extends Record, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, S extends SlotsType = SlotsType, Props = P & EmitsToProps, PP = PublicProps, @@ -144,7 +144,7 @@ export type DefineSetupFnComponent< // (uses user defined props interface) export function defineComponent< Props extends Record, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, EE extends string = string, S extends SlotsType = {}, >( @@ -160,7 +160,7 @@ export function defineComponent< ): DefineSetupFnComponent export function defineComponent< Props extends Record, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, EE extends string = string, S extends SlotsType = {}, >( @@ -175,189 +175,114 @@ export function defineComponent< }, ): DefineSetupFnComponent -// overload 2: object format no props or internal type props -// backdoor for Vue Language Service +// overload 2: defineComponent with options object, infer props from options export function defineComponent< - Props = {}, - RawBindings = {}, - D = {}, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, + // props + TypeProps, + PropsOptions extends + ComponentObjectPropsOptions = ComponentObjectPropsOptions, + PropsKeys extends string = string, + // emits + TypeEmits extends ComponentTypeEmits = {}, + EmitsOptions extends ComponentEmitsOptions = {}, + EmitsKeys extends string = string, + // other options + Data = {}, + SetupBindings = {}, + Computed extends ComputedOptions = {}, + Methods extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = {}, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, - LC extends Record = {}, + InjectOptions extends ComponentInjectOptions = {}, + InjectKeys extends string = string, + Slots extends SlotsType = {}, + LocalComponents extends Record = {}, Directives extends Record = {}, Exposed extends string = string, Provide extends ComponentProvideOptions = ComponentProvideOptions, - TE extends TypeEmits = {}, - ResolvedEmits extends EmitsOptions = {} extends E - ? TypeEmitsToOptions - : E, + // resolved types + ResolvedEmits extends ComponentEmitsOptions = {} extends EmitsOptions + ? TypeEmitsToOptions + : EmitsOptions, + InferredProps = unknown extends TypeProps + ? string extends PropsKeys + ? ComponentObjectPropsOptions extends PropsOptions + ? {} + : ExtractPropTypes + : { [key in PropsKeys]?: any } + : TypeProps, + ResolvedProps = Readonly>, >( - options: ComponentOptionsWithoutProps< - Props, - RawBindings, - D, - C, - M, + options: { + props?: (PropsOptions & ThisType) | PropsKeys[] + /** + * @private for language-tools use only + */ + __typeProps?: TypeProps + /** + * @private for language-tools use only + */ + __typeEmits?: TypeEmits + } & ComponentOptionsBase< + ResolvedProps, + SetupBindings, + Data, + Computed, + Methods, Mixin, Extends, - E, - EE, - I, - II, - S, - LC, - Directives, - Exposed, - Provide, - TE, - ResolvedEmits - >, -): DefineComponent< - Props, - RawBindings, - D, - C, - M, - Mixin, - Extends, - ResolvedEmits, - EE, - PublicProps, - ResolveProps, - ExtractDefaultPropTypes, - S, - LC, - Directives, - Exposed, - Provide, - false -> - -// overload 3: object format with array props declaration -// props inferred as { [key in PropNames]?: any } -// return type is for language-tools and TSX support -export function defineComponent< - PropNames extends string, - RawBindings, - D, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = {}, - EE extends string = string, - S extends SlotsType = {}, - I extends ComponentInjectOptions = {}, - II extends string = string, - LC extends Record = {}, - Directives extends Record = {}, - Exposed extends string = string, - Provide extends ComponentProvideOptions = ComponentProvideOptions, - Props = Readonly<{ [key in PropNames]?: any }>, ->( - options: ComponentOptionsWithArrayProps< - PropNames, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - I, - II, - S, - LC, - Directives, - Exposed, - Provide - >, -): DefineComponent< - Props, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - PublicProps, - ResolveProps, - ExtractDefaultPropTypes, - S, - LC, - Directives, - Exposed, - Provide -> - -// overload 4: object format with object props declaration -// see `ExtractPropTypes` in ./componentProps.ts -export function defineComponent< - // the Readonly constraint allows TS to treat the type of { required: true } - // as constant instead of boolean. - PropsOptions extends Readonly, - RawBindings, - D, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = {}, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, - LC extends Record = {}, - Directives extends Record = {}, - Exposed extends string = string, - Provide extends ComponentProvideOptions = ComponentProvideOptions, ->( - options: ComponentOptionsWithObjectProps< - PropsOptions, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - I, - II, - S, - LC, + EmitsOptions, + EmitsKeys, + {}, // Defaults + InjectOptions, + InjectKeys, + Slots, + LocalComponents, Directives, Exposed, Provide - >, + > & + ThisType< + CreateComponentPublicInstance< + ResolvedProps, + SetupBindings, + Data, + Computed, + Methods, + Mixin, + Extends, + ResolvedEmits, + EmitsKeys, + {}, + false, + InjectOptions, + Slots, + LocalComponents, + Directives, + Exposed + > + >, ): DefineComponent< - PropsOptions, - RawBindings, - D, - C, - M, + InferredProps, + SetupBindings, + Data, + Computed, + Methods, Mixin, Extends, - E, - EE, + ResolvedEmits, + EmitsKeys, PublicProps, - ResolveProps, + ResolvedProps, ExtractDefaultPropTypes, - S, - LC, + Slots, + LocalComponents, Directives, Exposed, - Provide + Provide, + // MakeDefaultsOptional - if TypeProps is provided, set to false to use + // user props types verbatim + unknown extends TypeProps ? true : false > // implementation, close to no-op diff --git a/packages/runtime-core/src/apiSetupHelpers.ts b/packages/runtime-core/src/apiSetupHelpers.ts index 34718622000..da092babcf5 100644 --- a/packages/runtime-core/src/apiSetupHelpers.ts +++ b/packages/runtime-core/src/apiSetupHelpers.ts @@ -14,7 +14,11 @@ import { setCurrentInstance, unsetCurrentInstance, } from './component' -import type { EmitFn, EmitsOptions, ObjectEmitsOptions } from './componentEmits' +import type { + ComponentEmitsOptions, + EmitFn, + ObjectEmitsOptions, +} from './componentEmits' import type { ComponentOptionsBase, ComponentOptionsMixin, @@ -132,10 +136,10 @@ type BooleanKey = K extends any export function defineEmits( emitOptions: EE[], ): EmitFn -export function defineEmits( - emitOptions: E, -): EmitFn -export function defineEmits(): T extends ( +export function defineEmits< + E extends ComponentEmitsOptions = ComponentEmitsOptions, +>(emitOptions: E): EmitFn +export function defineEmits(): T extends ( ...args: any[] ) => any ? T @@ -148,7 +152,9 @@ export function defineEmits() { return null as any } -export type TypeEmits = ((...args: any[]) => any) | Record +export type ComponentTypeEmits = + | ((...args: any[]) => any) + | Record type RecordToUnion> = T[keyof T] @@ -392,7 +398,7 @@ function getContext(): SetupContext { * @internal */ export function normalizePropsOrEmits( - props: ComponentPropsOptions | EmitsOptions, + props: ComponentPropsOptions | ComponentEmitsOptions, ) { return isArray(props) ? props.reduce( @@ -439,8 +445,8 @@ export function mergeDefaults( * @internal */ export function mergeModels( - a: ComponentPropsOptions | EmitsOptions, - b: ComponentPropsOptions | EmitsOptions, + a: ComponentPropsOptions | ComponentEmitsOptions, + b: ComponentPropsOptions | ComponentEmitsOptions, ) { if (!a || !b) return a || b if (isArray(a) && isArray(b)) return a.concat(b) diff --git a/packages/runtime-core/src/component.ts b/packages/runtime-core/src/component.ts index 68d908310d4..10317e5aff9 100644 --- a/packages/runtime-core/src/component.ts +++ b/packages/runtime-core/src/component.ts @@ -51,8 +51,8 @@ import { resolveMergedOptions, } from './componentOptions' import { + type ComponentEmitsOptions, type EmitFn, - type EmitsOptions, type EmitsToProps, type ObjectEmitsOptions, type ShortEmitsToObject, @@ -211,9 +211,9 @@ export interface ComponentInternalOptions { export interface FunctionalComponent< P = {}, - E extends EmitsOptions | Record = {}, + E extends ComponentEmitsOptions | Record = {}, S extends Record = any, - EE extends EmitsOptions = ShortEmitsToObject, + EE extends ComponentEmitsOptions = ShortEmitsToObject, > extends ComponentInternalOptions { // use of any here is intentional so it can be a valid JSX Element constructor ( @@ -245,7 +245,7 @@ export type ConcreteComponent< D = any, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions, - E extends EmitsOptions | Record = {}, + E extends ComponentEmitsOptions | Record = {}, S extends Record = any, > = | ComponentOptions @@ -261,7 +261,7 @@ export type Component< D = any, C extends ComputedOptions = ComputedOptions, M extends MethodOptions = MethodOptions, - E extends EmitsOptions | Record = {}, + E extends ComponentEmitsOptions | Record = {}, S extends Record = any, > = | ConcreteComponent @@ -273,7 +273,7 @@ type LifecycleHook = TFn[] | null // use `E extends any` to force evaluating type to fix #2362 export type SetupContext< - E = EmitsOptions, + E = ComponentEmitsOptions, S extends SlotsType = {}, > = E extends any ? { diff --git a/packages/runtime-core/src/componentEmits.ts b/packages/runtime-core/src/componentEmits.ts index ef264252dba..fae4f6c9333 100644 --- a/packages/runtime-core/src/componentEmits.ts +++ b/packages/runtime-core/src/componentEmits.ts @@ -29,16 +29,16 @@ import { compatModelEmit, compatModelEventPrefix, } from './compat/componentVModel' -import type { TypeEmits } from './apiSetupHelpers' +import type { ComponentTypeEmits } from './apiSetupHelpers' export type ObjectEmitsOptions = Record< string, ((...args: any[]) => any) | null > -export type EmitsOptions = ObjectEmitsOptions | string[] +export type ComponentEmitsOptions = ObjectEmitsOptions | string[] -export type EmitsToProps = +export type EmitsToProps = T extends string[] ? { [K in `on${Capitalize}`]?: (...args: any[]) => any @@ -57,7 +57,7 @@ export type EmitsToProps = } : {} -export type TypeEmitsToOptions = +export type TypeEmitsToOptions = T extends Record ? { [K in keyof T]: T[K] extends [...args: infer Args] diff --git a/packages/runtime-core/src/componentOptions.ts b/packages/runtime-core/src/componentOptions.ts index d10d2a850b3..1246a2aa6ba 100644 --- a/packages/runtime-core/src/componentOptions.ts +++ b/packages/runtime-core/src/componentOptions.ts @@ -55,7 +55,7 @@ import type { ExtractPropTypes, } from './componentProps' import type { - EmitsOptions, + ComponentEmitsOptions, EmitsToProps, TypeEmitsToOptions, } from './componentEmits' @@ -80,7 +80,10 @@ import { import type { OptionMergeFunction } from './apiCreateApp' import { LifecycleHooks } from './enums' import type { SlotsType } from './componentSlots' -import { type TypeEmits, normalizePropsOrEmits } from './apiSetupHelpers' +import { + type ComponentTypeEmits, + normalizePropsOrEmits, +} from './apiSetupHelpers' /** * Interface for declaring custom options. @@ -110,7 +113,7 @@ export interface ComponentOptionsBase< M extends MethodOptions, Mixin extends ComponentOptionsMixin, Extends extends ComponentOptionsMixin, - E extends EmitsOptions, + E extends ComponentEmitsOptions, EE extends string = string, Defaults = {}, I extends ComponentInjectOptions = {}, @@ -222,199 +225,6 @@ export interface RuntimeCompilerOptions { delimiters?: [string, string] } -/** - * This is named "without props" but also handles the case of direct type - * inference using internal __typeProps and __typeEmits options. - */ -export type ComponentOptionsWithoutProps< - Props = {}, - RawBindings = {}, - D = {}, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = {}, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, - LC extends Record = {}, - Directives extends Record = {}, - Exposed extends string = string, - Provide extends ComponentProvideOptions = ComponentProvideOptions, - TE extends TypeEmits = {}, - ResolvedEmits extends EmitsOptions = {} extends E - ? TypeEmitsToOptions - : E, - PE = Props & EmitsToProps, -> = ComponentOptionsBase< - PE, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - {}, - I, - II, - S, - LC, - Directives, - Exposed, - Provide -> & { - props?: never - /** - * @private for language-tools use only - */ - __typeProps?: Props - /** - * @private for language-tools use only - */ - __typeEmits?: TE -} & ThisType< - CreateComponentPublicInstance< - PE, - RawBindings, - D, - C, - M, - Mixin, - Extends, - ResolvedEmits, - EE, - {}, - false, - I, - S, - LC, - Directives, - Exposed - > - > - -export type ComponentOptionsWithArrayProps< - PropNames extends string = string, - RawBindings = {}, - D = {}, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = EmitsOptions, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, - LC extends Record = {}, - Directives extends Record = {}, - Exposed extends string = string, - Provide extends ComponentProvideOptions = ComponentProvideOptions, - Props = Prettify>>, -> = ComponentOptionsBase< - Props, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - {}, - I, - II, - S, - LC, - Directives, - Exposed, - Provide -> & { - props: PropNames[] -} & ThisType< - CreateComponentPublicInstance< - Props, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - Props, - {}, - false, - I, - S, - LC, - Directives, - Exposed - > - > - -export type ComponentOptionsWithObjectProps< - PropsOptions = ComponentObjectPropsOptions, - RawBindings = {}, - D = {}, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = EmitsOptions, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, - LC extends Record = {}, - Directives extends Record = {}, - Exposed extends string = string, - Provide extends ComponentProvideOptions = ComponentProvideOptions, - Props = Prettify & EmitsToProps>>, - Defaults = ExtractDefaultPropTypes, -> = ComponentOptionsBase< - Props, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - Defaults, - I, - II, - S, - LC, - Directives, - Exposed, - Provide -> & { - props: PropsOptions & ThisType -} & ThisType< - CreateComponentPublicInstance< - Props, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - Props, - Defaults, - false, - I, - S, - LC, - Directives - > - > - export type ComponentOptions< Props = {}, RawBindings = any, @@ -423,7 +233,7 @@ export type ComponentOptions< M extends MethodOptions = any, Mixin extends ComponentOptionsMixin = any, Extends extends ComponentOptionsMixin = any, - E extends EmitsOptions = any, + E extends ComponentEmitsOptions = any, EE extends string = string, Defaults = {}, I extends ComponentInjectOptions = {}, @@ -1221,16 +1031,16 @@ function mergeObjectOptions(to: Object | undefined, from: Object | undefined) { } function mergeEmitsOrPropsOptions( - to: EmitsOptions | undefined, - from: EmitsOptions | undefined, -): EmitsOptions | undefined + to: ComponentEmitsOptions | undefined, + from: ComponentEmitsOptions | undefined, +): ComponentEmitsOptions | undefined function mergeEmitsOrPropsOptions( to: ComponentPropsOptions | undefined, from: ComponentPropsOptions | undefined, ): ComponentPropsOptions | undefined function mergeEmitsOrPropsOptions( - to: ComponentPropsOptions | EmitsOptions | undefined, - from: ComponentPropsOptions | EmitsOptions | undefined, + to: ComponentPropsOptions | ComponentEmitsOptions | undefined, + from: ComponentPropsOptions | ComponentEmitsOptions | undefined, ) { if (to) { if (isArray(to) && isArray(from)) { @@ -1258,3 +1068,203 @@ function mergeWatchOptions( } return merged } + +// Deprecated legacy types, kept because they were previously exported --------- + +/** + * @deprecated + */ +export type ComponentOptionsWithoutProps< + Props = {}, + RawBindings = {}, + D = {}, + C extends ComputedOptions = {}, + M extends MethodOptions = {}, + Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, + Extends extends ComponentOptionsMixin = ComponentOptionsMixin, + E extends ComponentEmitsOptions = {}, + EE extends string = string, + I extends ComponentInjectOptions = {}, + II extends string = string, + S extends SlotsType = {}, + LC extends Record = {}, + Directives extends Record = {}, + Exposed extends string = string, + Provide extends ComponentProvideOptions = ComponentProvideOptions, + TE extends ComponentTypeEmits = {}, + ResolvedEmits extends ComponentEmitsOptions = {} extends E + ? TypeEmitsToOptions + : E, + PE = Props & EmitsToProps, +> = ComponentOptionsBase< + PE, + RawBindings, + D, + C, + M, + Mixin, + Extends, + E, + EE, + {}, + I, + II, + S, + LC, + Directives, + Exposed, + Provide +> & { + props?: never + /** + * @private for language-tools use only + */ + __typeProps?: Props + /** + * @private for language-tools use only + */ + __typeEmits?: TE +} & ThisType< + CreateComponentPublicInstance< + PE, + RawBindings, + D, + C, + M, + Mixin, + Extends, + ResolvedEmits, + EE, + {}, + false, + I, + S, + LC, + Directives, + Exposed + > + > + +/** + * @deprecated + */ +export type ComponentOptionsWithArrayProps< + PropNames extends string = string, + RawBindings = {}, + D = {}, + C extends ComputedOptions = {}, + M extends MethodOptions = {}, + Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, + Extends extends ComponentOptionsMixin = ComponentOptionsMixin, + E extends ComponentEmitsOptions = ComponentEmitsOptions, + EE extends string = string, + I extends ComponentInjectOptions = {}, + II extends string = string, + S extends SlotsType = {}, + LC extends Record = {}, + Directives extends Record = {}, + Exposed extends string = string, + Provide extends ComponentProvideOptions = ComponentProvideOptions, + Props = Prettify>>, +> = ComponentOptionsBase< + Props, + RawBindings, + D, + C, + M, + Mixin, + Extends, + E, + EE, + {}, + I, + II, + S, + LC, + Directives, + Exposed, + Provide +> & { + props: PropNames[] +} & ThisType< + CreateComponentPublicInstance< + Props, + RawBindings, + D, + C, + M, + Mixin, + Extends, + E, + Props, + {}, + false, + I, + S, + LC, + Directives, + Exposed + > + > + +/** + * @deprecated + */ +export type ComponentOptionsWithObjectProps< + PropsOptions = ComponentObjectPropsOptions, + RawBindings = {}, + D = {}, + C extends ComputedOptions = {}, + M extends MethodOptions = {}, + Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, + Extends extends ComponentOptionsMixin = ComponentOptionsMixin, + E extends ComponentEmitsOptions = ComponentEmitsOptions, + EE extends string = string, + I extends ComponentInjectOptions = {}, + II extends string = string, + S extends SlotsType = {}, + LC extends Record = {}, + Directives extends Record = {}, + Exposed extends string = string, + Provide extends ComponentProvideOptions = ComponentProvideOptions, + Props = Prettify & EmitsToProps>>, + Defaults = ExtractDefaultPropTypes, +> = ComponentOptionsBase< + Props, + RawBindings, + D, + C, + M, + Mixin, + Extends, + E, + EE, + Defaults, + I, + II, + S, + LC, + Directives, + Exposed, + Provide +> & { + props: PropsOptions & ThisType +} & ThisType< + CreateComponentPublicInstance< + Props, + RawBindings, + D, + C, + M, + Mixin, + Extends, + E, + Props, + Defaults, + false, + I, + S, + LC, + Directives + > + > diff --git a/packages/runtime-core/src/componentProps.ts b/packages/runtime-core/src/componentProps.ts index 5a4292b6f36..597a1f1f285 100644 --- a/packages/runtime-core/src/componentProps.ts +++ b/packages/runtime-core/src/componentProps.ts @@ -67,7 +67,7 @@ export interface PropOptions { skipFactory?: boolean } -export type PropType = PropConstructor | PropConstructor[] +export type PropType = PropConstructor | (PropConstructor | null)[] type PropConstructor = | { new (...args: any[]): T & {} } @@ -107,8 +107,10 @@ type DefaultKeys = { : never }[keyof T] -type InferPropType = [T] extends [null] - ? any // null & true would fail to infer +type InferPropType = [T] extends [null] + ? NullAsAny extends true + ? any + : null : [T] extends [{ type: null | true }] ? any // As TS issue https://github.com/Microsoft/TypeScript/issues/14829 // somehow `ObjectConstructor` when inferred from { (): T } becomes `any` // `BooleanConstructor` when inferred from PropConstructor(with PropMethod) becomes `Boolean` : [T] extends [ObjectConstructor | { type: ObjectConstructor }] @@ -119,8 +121,8 @@ type InferPropType = [T] extends [null] ? Date : [T] extends [(infer U)[] | { type: (infer U)[] }] ? U extends DateConstructor - ? Date | InferPropType - : InferPropType + ? Date | InferPropType + : InferPropType : [T] extends [Prop] ? unknown extends V ? IfAny @@ -594,7 +596,7 @@ function validatePropName(key: string) { // use function string name to check type constructors // so that it works across vms / iframes. -function getType(ctor: Prop): string { +function getType(ctor: Prop | null): string { // Early return for null to avoid unnecessary computations if (ctor === null) { return 'null' @@ -614,7 +616,7 @@ function getType(ctor: Prop): string { return '' } -function isSameType(a: Prop, b: Prop): boolean { +function isSameType(a: Prop | null, b: Prop | null): boolean { return getType(a) === getType(b) } @@ -707,24 +709,27 @@ type AssertionResult = { /** * dev only */ -function assertType(value: unknown, type: PropConstructor): AssertionResult { +function assertType( + value: unknown, + type: PropConstructor | null, +): AssertionResult { let valid const expectedType = getType(type) - if (isSimpleType(expectedType)) { + if (expectedType === 'null') { + valid = value === null + } else if (isSimpleType(expectedType)) { const t = typeof value valid = t === expectedType.toLowerCase() // for primitive wrapper objects if (!valid && t === 'object') { - valid = value instanceof type + valid = value instanceof (type as PropConstructor) } } else if (expectedType === 'Object') { valid = isObject(value) } else if (expectedType === 'Array') { valid = isArray(value) - } else if (expectedType === 'null') { - valid = value === null } else { - valid = value instanceof type + valid = value instanceof (type as PropConstructor) } return { valid, diff --git a/packages/runtime-core/src/componentPublicInstance.ts b/packages/runtime-core/src/componentPublicInstance.ts index 864b9786efe..9018f7a55b5 100644 --- a/packages/runtime-core/src/componentPublicInstance.ts +++ b/packages/runtime-core/src/componentPublicInstance.ts @@ -47,7 +47,7 @@ import { resolveMergedOptions, shouldCacheAccess, } from './componentOptions' -import type { EmitFn, EmitsOptions } from './componentEmits' +import type { ComponentEmitsOptions, EmitFn } from './componentEmits' import type { SlotsType, UnwrapSlotsType } from './componentSlots' import { markAttrsAccessed } from './componentRenderUtils' import { currentRenderingInstance } from './componentRenderContext' @@ -158,7 +158,7 @@ export type CreateComponentPublicInstance< M extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, PublicProps = P, Defaults = {}, MakeDefaultsOptional extends boolean = false, @@ -225,7 +225,7 @@ export type ComponentPublicInstance< D = {}, // return from data() C extends ComputedOptions = {}, M extends MethodOptions = {}, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, PublicProps = P, Defaults = {}, MakeDefaultsOptional extends boolean = false, diff --git a/packages/runtime-core/src/h.ts b/packages/runtime-core/src/h.ts index 93e7fd9bc88..644620275fd 100644 --- a/packages/runtime-core/src/h.ts +++ b/packages/runtime-core/src/h.ts @@ -18,7 +18,7 @@ import type { ConcreteComponent, FunctionalComponent, } from './component' -import type { EmitsOptions } from './componentEmits' +import type { ComponentEmitsOptions } from './componentEmits' import type { DefineComponent } from './apiDefineComponent' // `h` is a more user-friendly version of `createVNode` that allows omitting the @@ -139,7 +139,7 @@ export function h( // functional component export function h< P, - E extends EmitsOptions = {}, + E extends ComponentEmitsOptions = {}, S extends Record = any, >( type: FunctionalComponent, diff --git a/packages/runtime-core/src/index.ts b/packages/runtime-core/src/index.ts index 5d36407ba6a..478ae6bbb56 100644 --- a/packages/runtime-core/src/index.ts +++ b/packages/runtime-core/src/index.ts @@ -76,6 +76,7 @@ export { withDefaults, type DefineProps, type ModelRef, + type ComponentTypeEmits, } from './apiSetupHelpers' /** @@ -260,9 +261,6 @@ export type { export type { ComponentOptions, ComponentOptionsMixin, - ComponentOptionsWithoutProps, - ComponentOptionsWithObjectProps, - ComponentOptionsWithArrayProps, ComponentCustomOptions, ComponentOptionsBase, ComponentProvideOptions, @@ -272,7 +270,11 @@ export type { RuntimeCompilerOptions, ComponentInjectOptions, } from './componentOptions' -export type { EmitsOptions, ObjectEmitsOptions } from './componentEmits' +export type { + ComponentEmitsOptions as EmitsOptions, + ObjectEmitsOptions, + EmitsToProps, +} from './componentEmits' export type { ComponentPublicInstance, ComponentCustomProperties, diff --git a/packages/runtime-dom/__tests__/customElement.spec.ts b/packages/runtime-dom/__tests__/customElement.spec.ts index fb746f72c4a..cc56de2d685 100644 --- a/packages/runtime-dom/__tests__/customElement.spec.ts +++ b/packages/runtime-dom/__tests__/customElement.spec.ts @@ -88,10 +88,14 @@ describe('defineCustomElement', () => { describe('props', () => { const E = defineCustomElement({ - props: ['foo', 'bar', 'bazQux'], + props: { + foo: [String, null], + bar: Object, + bazQux: null, + }, render() { return [ - h('div', null, this.foo), + h('div', null, this.foo || ''), h('div', null, this.bazQux || (this.bar && this.bar.x)), ] }, diff --git a/packages/runtime-dom/src/apiCustomElement.ts b/packages/runtime-dom/src/apiCustomElement.ts index 01ce2bad464..b8adc761b37 100644 --- a/packages/runtime-dom/src/apiCustomElement.ts +++ b/packages/runtime-dom/src/apiCustomElement.ts @@ -1,16 +1,19 @@ import { + type Component, + type EmitsOptions as ComponentEmitsOptions, type ComponentInjectOptions, type ComponentInternalInstance, + type ComponentObjectPropsOptions, type ComponentOptions, + type ComponentOptionsBase, type ComponentOptionsMixin, - type ComponentOptionsWithArrayProps, - type ComponentOptionsWithObjectProps, - type ComponentOptionsWithoutProps, - type ComponentPropsOptions, + type ComponentProvideOptions, type ComputedOptions, type ConcreteComponent, + type CreateComponentPublicInstance, type DefineComponent, - type EmitsOptions, + type Directive, + type EmitsToProps, type ExtractPropTypes, type MethodOptions, type RenderFunction, @@ -41,98 +44,79 @@ export function defineCustomElement( ) => RawBindings | RenderFunction, ): VueElementConstructor -// overload 2: object format with no props +// overload 2: defineCustomElement with options object, infer props from options export function defineCustomElement< - Props = {}, - RawBindings = {}, - D = {}, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, + // props + PropsOptions extends + ComponentObjectPropsOptions = ComponentObjectPropsOptions, + PropsKeys extends string = string, + // emits + EmitsOptions extends ComponentEmitsOptions = {}, + EmitsKeys extends string = string, + // other options + Data = {}, + SetupBindings = {}, + Computed extends ComputedOptions = {}, + Methods extends MethodOptions = {}, Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = EmitsOptions, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, + InjectOptions extends ComponentInjectOptions = {}, + InjectKeys extends string = string, + Slots extends SlotsType = {}, + LocalComponents extends Record = {}, + Directives extends Record = {}, + Exposed extends string = string, + Provide extends ComponentProvideOptions = ComponentProvideOptions, + // resolved types + InferredProps = string extends PropsKeys + ? ComponentObjectPropsOptions extends PropsOptions + ? {} + : ExtractPropTypes + : { [key in PropsKeys]?: any }, + ResolvedProps = InferredProps & EmitsToProps, >( - options: ComponentOptionsWithoutProps< - Props, - RawBindings, - D, - C, - M, + options: { + props?: (PropsOptions & ThisType) | PropsKeys[] + } & ComponentOptionsBase< + ResolvedProps, + SetupBindings, + Data, + Computed, + Methods, Mixin, Extends, - E, - EE, - I, - II, - S - > & { styles?: string[] }, -): VueElementConstructor - -// overload 3: object format with array props declaration -export function defineCustomElement< - PropNames extends string, - RawBindings, - D, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = Record, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, ->( - options: ComponentOptionsWithArrayProps< - PropNames, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - I, - II, - S - > & { styles?: string[] }, -): VueElementConstructor<{ [K in PropNames]: any }> - -// overload 4: object format with object props declaration -export function defineCustomElement< - PropsOptions extends Readonly, - RawBindings, - D, - C extends ComputedOptions = {}, - M extends MethodOptions = {}, - Mixin extends ComponentOptionsMixin = ComponentOptionsMixin, - Extends extends ComponentOptionsMixin = ComponentOptionsMixin, - E extends EmitsOptions = Record, - EE extends string = string, - I extends ComponentInjectOptions = {}, - II extends string = string, - S extends SlotsType = {}, ->( - options: ComponentOptionsWithObjectProps< - PropsOptions, - RawBindings, - D, - C, - M, - Mixin, - Extends, - E, - EE, - I, - II, - S - > & { styles?: string[] }, -): VueElementConstructor> + EmitsOptions, + EmitsKeys, + {}, // Defaults + InjectOptions, + InjectKeys, + Slots, + LocalComponents, + Directives, + Exposed, + Provide + > & + ThisType< + CreateComponentPublicInstance< + Readonly, + SetupBindings, + Data, + Computed, + Methods, + Mixin, + Extends, + EmitsOptions, + EmitsKeys, + {}, + false, + InjectOptions, + Slots, + LocalComponents, + Directives, + Exposed + > + >, +): VueElementConstructor // overload 5: defining a custom element from the returned value of // `defineComponent`