feat: support __typeEl

Author: zhiyuanzmj

packages-private/dts-test/defineVaporComponent.test-d.tsx

@@ -1041,6 +1041,7 @@ declare const MyButton: DefineVaporComponent<
   {},
   {},
   {},
+  Block,
   true,
   Readonly<ExtractPropTypes<{}>>,
   VaporPublicProps & AllowedComponentProps & ComponentCustomProps,
@@ -1196,6 +1197,24 @@ describe('__typeRefs backdoor, object syntax', () => {
   expectType<number>(refs.child.refs.foo)
 })
 
+describe('__typeEl backdoor', () => {
+  const Comp = defineVaporComponent({
+    __typeEl: {} as HTMLAnchorElement,
+  })
+  const c = new Comp()
+  expectType<HTMLAnchorElement>(c.block)
+
+  const Comp1 = defineVaporComponent({
+    render: () => document.createElement('a'),
+  })
+  const c1 = new Comp1()
+  expectType<HTMLAnchorElement>(c1.block)
+
+  const Comp2 = defineVaporComponent(() => document.createElement('a'))
+  const c2 = new Comp2()
+  expectType<HTMLAnchorElement>(c2.block)
+})
+
 defineVaporComponent({
   props: {
     foo: [String, null],

packages/runtime-vapor/src/apiDefineComponent.ts

@@ -32,7 +32,10 @@ export type VaporPublicProps = ReservedProps &
   AllowedComponentProps &
   ComponentCustomProps
 
-export type RenderReturn = VNode | Block | RenderReturn[]
+export type RenderReturn<T extends Block = Block> =
+  | VNode
+  | T
+  | RenderReturn<T>[]
 
 export type DefineVaporComponent<
   RuntimePropsOptions = {},
@@ -42,6 +45,7 @@ export type DefineVaporComponent<
   Slots extends StaticSlots = StaticSlots,
   Exposed extends Record<string, any> = Record<string, any>,
   TypeRefs extends Record<string, unknown> = {},
+  TypeEl extends Block = Block,
   MakeDefaultsOptional extends boolean = true,
   InferredProps = string extends RuntimePropsKeys
     ? ComponentObjectPropsOptions extends RuntimePropsOptions
@@ -62,6 +66,7 @@ export type DefineVaporComponent<
     Emits,
     Slots,
     Exposed,
+    TypeEl,
     TypeRefs
   >
 > &
@@ -78,12 +83,13 @@ export type DefineVaporSetupFnComponent<
   Emits extends EmitsOptions = {},
   Slots extends SlotsType = SlotsType,
   Exposed extends Record<string, any> = Record<string, any>,
+  TypeEl extends Block = Block,
   ResolvedProps extends Record<string, any> = Props &
     EmitsToProps<Emits> &
     VaporPublicProps,
 > = new (
   props?: ResolvedProps,
-) => VaporComponentInstance<ResolvedProps, Emits, Slots, Exposed>
+) => VaporComponentInstance<ResolvedProps, Emits, Slots, Exposed, TypeEl>
 
 // overload 1: direct setup function
 // (uses user defined props interface)
@@ -93,6 +99,7 @@ export function defineVaporComponent<
   RuntimeEmitsKeys extends string = string,
   Slots extends StaticSlots = StaticSlots,
   Exposed extends Record<string, any> = Record<string, any>,
+  TypeEl extends Block = Block,
 >(
   setup: (
     props: Props,
@@ -102,7 +109,7 @@ export function defineVaporComponent<
       attrs: Record<string, any>
       expose: (exposed: Exposed) => void
     },
-  ) => RenderReturn,
+  ) => RenderReturn<TypeEl>,
   extraOptions?: ObjectVaporComponent<
     (keyof Props)[],
     Emits,
@@ -111,13 +118,14 @@ export function defineVaporComponent<
     Exposed
   > &
     ThisType<void>,
-): DefineVaporSetupFnComponent<Props, Emits, Slots, Exposed>
+): DefineVaporSetupFnComponent<Props, Emits, Slots, Exposed, TypeEl>
 export function defineVaporComponent<
   Props extends Record<string, any>,
   Emits extends EmitsOptions = {},
   RuntimeEmitsKeys extends string = string,
   Slots extends StaticSlots = StaticSlots,
   Exposed extends Record<string, any> = Record<string, any>,
+  TypeEl extends Block = Block,
 >(
   setup: (
     props: Props,
@@ -127,7 +135,7 @@ export function defineVaporComponent<
       attrs: Record<string, any>
       expose: (exposed: Exposed) => void
     },
-  ) => RenderReturn,
+  ) => RenderReturn<TypeEl>,
   extraOptions?: ObjectVaporComponent<
     ComponentObjectPropsOptions<Props>,
     Emits,
@@ -136,7 +144,7 @@ export function defineVaporComponent<
     Exposed
   > &
     ThisType<void>,
-): DefineVaporSetupFnComponent<Props, Emits, Slots, Exposed>
+): DefineVaporSetupFnComponent<Props, Emits, Slots, Exposed, TypeEl>
 
 // overload 2: defineVaporComponent with options object, infer props from options
 export function defineVaporComponent<
@@ -163,13 +171,15 @@ export function defineVaporComponent<
         : ExtractPropTypes<RuntimePropsOptions>
       : { [key in RuntimePropsKeys]?: any },
   TypeRefs extends Record<string, unknown> = {},
+  TypeEl extends Block = Block,
 >(
   options: ObjectVaporComponent<
     RuntimePropsOptions | RuntimePropsKeys[],
     ResolvedEmits,
     RuntimeEmitsKeys,
     Slots,
     Exposed,
+    TypeEl,
     InferredProps
   > & {
     /**
@@ -184,6 +194,10 @@ export function defineVaporComponent<
      * @private for language-tools use only
      */
     __typeRefs?: TypeRefs
+    /**
+     * @private for language-tools use only
+     */
+    __typeEl?: TypeEl
   } & ThisType<void>,
 ): DefineVaporComponent<
   RuntimePropsOptions,
@@ -193,6 +207,7 @@ export function defineVaporComponent<
   Slots,
   Exposed extends Block ? Record<string, any> : Exposed,
   TypeRefs,
+  TypeEl,
   // MakeDefaultsOptional - if TypeProps is provided, set to false to use
   // user props types verbatim
   unknown extends TypeProps ? true : false,

packages/runtime-vapor/src/component.ts

@@ -101,6 +101,7 @@ export interface ObjectVaporComponent<
   RuntimeEmitsKeys extends string = string,
   Slots extends StaticSlots = StaticSlots,
   Exposed extends Record<string, any> = Record<string, any>,
+  TypeEl extends Block = Block,
   InferredProps = ComponentObjectPropsOptions extends Props
     ? {}
     : ExtractPropTypes<Props>,
@@ -117,7 +118,7 @@ export interface ObjectVaporComponent<
     emit: EmitFn<Emits>,
     attrs: any,
     slots: StaticSlots,
-  ): RenderReturn
+  ): RenderReturn<TypeEl>
 
   name?: string
   vapor?: boolean
@@ -362,6 +363,7 @@ export class VaporComponentInstance<
   Emits extends EmitsOptions = {},
   Slots extends StaticSlots = StaticSlots,
   Exposed extends Record<string, any> = Record<string, any>,
+  TypeEl extends Block = Block,
   Refs extends Record<string, any> = Record<string, any>,
 > implements GenericComponentInstance
 {
@@ -372,7 +374,7 @@ export class VaporComponentInstance<
   parent: GenericComponentInstance | null
   appContext: GenericAppContext
 
-  block: Block
+  block: TypeEl
   scope: EffectScope
 
   rawProps: RawProps