types(defineComponent): Support for GlobalComponents, typed Directives and respect expose on defineComponent

packages/runtime-core/src/apiDefineComponent.ts

@@ -11,7 +11,10 @@ import {
 import {
   SetupContext,
   AllowedComponentProps,
-  ComponentCustomProps
+  ComponentCustomProps,
+  Component,
+  GlobalDirectives,
+  GlobalComponents
 } from './component'
 import {
   ExtractPropTypes,
@@ -25,6 +28,7 @@ import {
   CreateComponentPublicInstance,
   ComponentPublicInstanceConstructor
 } from './componentPublicInstance'
+import { Directive } from './directives'
 
 export type PublicProps = VNodeProps &
   AllowedComponentProps &
@@ -40,6 +44,9 @@ export type DefineComponent<
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = {},
   EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string,
   PP = PublicProps,
   Props = Readonly<
     PropsOrPropOptions extends ComponentPropsOptions
@@ -60,7 +67,10 @@ export type DefineComponent<
     E,
     PP & Props,
     Defaults,
-    true
+    true,
+    LC & GlobalComponents,
+    Directives & GlobalDirectives,
+    Exposed
   > &
     Props
 > &
@@ -74,6 +84,9 @@ export type DefineComponent<
     Extends,
     E,
     EE,
+    LC & GlobalComponents,
+    Directives & GlobalDirectives,
+    Exposed,
     Defaults
   > &
   PP
@@ -104,7 +117,10 @@ export function defineComponent<
   Mixin extends ComponentOptionsMixin = ComponentOptionsMixin,
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = EmitsOptions,
-  EE extends string = string
+  EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string
 >(
   options: ComponentOptionsWithoutProps<
     Props,
@@ -115,9 +131,25 @@ export function defineComponent<
     Mixin,
     Extends,
     E,
-    EE
+    EE,
+    LC,
+    Directives,
+    Exposed
   >
-): DefineComponent<Props, RawBindings, D, C, M, Mixin, Extends, E, EE>
+): DefineComponent<
+  Props,
+  RawBindings,
+  D,
+  C,
+  M,
+  Mixin,
+  Extends,
+  E,
+  EE,
+  LC,
+  Directives,
+  Exposed
+>
 
 // overload 3: object format with array props declaration
 // props inferred as { [key in PropNames]?: any }
@@ -131,7 +163,10 @@ export function defineComponent<
   Mixin extends ComponentOptionsMixin = ComponentOptionsMixin,
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = Record<string, any>,
-  EE extends string = string
+  EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string
 >(
   options: ComponentOptionsWithArrayProps<
     PropNames,
@@ -142,7 +177,10 @@ export function defineComponent<
     Mixin,
     Extends,
     E,
-    EE
+    EE,
+    LC,
+    Directives,
+    Exposed
   >
 ): DefineComponent<
   Readonly<{ [key in PropNames]?: any }>,
@@ -153,7 +191,10 @@ export function defineComponent<
   Mixin,
   Extends,
   E,
-  EE
+  EE,
+  LC,
+  Directives,
+  Exposed
 >
 
 // overload 4: object format with object props declaration
@@ -169,7 +210,10 @@ export function defineComponent<
   Mixin extends ComponentOptionsMixin = ComponentOptionsMixin,
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = Record<string, any>,
-  EE extends string = string
+  EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string
 >(
   options: ComponentOptionsWithObjectProps<
     PropsOptions,
@@ -180,9 +224,25 @@ export function defineComponent<
     Mixin,
     Extends,
     E,
-    EE
+    EE,
+    LC,
+    Directives,
+    Exposed
   >
-): DefineComponent<PropsOptions, RawBindings, D, C, M, Mixin, Extends, E, EE>
+): DefineComponent<
+  PropsOptions,
+  RawBindings,
+  D,
+  C,
+  M,
+  Mixin,
+  Extends,
+  E,
+  EE,
+  LC,
+  Directives,
+  Exposed
+>
 
 // implementation, close to no-op
 export function defineComponent(options: unknown) {

packages/runtime-core/src/component.ts

@@ -75,6 +75,40 @@ export type Data = Record<string, unknown>
  */
 export interface ComponentCustomProps {}
 
+/**
+ * For globally defined Directives
+ * Here is an example of adding a directive `VTooltip` as global directive:
+ *
+ * @example
+ * ```ts
+ * import VTooltip from 'v-tooltip'
+ *
+ * declare module '@vue/runtime-core' {
+ *   interface GlobalDirectives {
+ *     VTooltip
+ *   }
+ * }
+ * ```
+ */
+export interface GlobalDirectives extends Record<string, Directive> {}
+
+/**
+ * For globally defined Components
+ * Here is an example of adding a component `RouterView` as global component:
+ *
+ * @example
+ * ```ts
+ * import { RouterView } from 'vue-router'
+ *
+ * declare module '@vue/runtime-core' {
+ *   interface GlobalComponents {
+ *     RouterView
+ *   }
+ * }
+ * ```
+ */
+export interface GlobalComponents extends Record<string, Component> {}
+
 /**
  * Default allowed non-declared props on component in TSX
  */

packages/runtime-core/src/componentOptions.ts

@@ -117,6 +117,9 @@ export interface ComponentOptionsBase<
   Extends extends ComponentOptionsMixin,
   E extends EmitsOptions,
   EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string,
   Defaults = {}
 > extends LegacyOptions<Props, D, C, M, Mixin, Extends>,
     ComponentInternalOptions,
@@ -140,12 +143,17 @@ export interface ComponentOptionsBase<
   // Luckily `render()` doesn't need any arguments nor does it care about return
   // type.
   render?: Function
-  components?: Record<string, Component>
-  directives?: Record<string, Directive>
+
+  // NOTE: extending both LC and Record<string, Component> allows objects to be forced
+  // to be of type Component, while still inferring LC generic
+  components?: LC & Record<string, Component>
+  // NOTE: extending both Directives and Record<string, Directive> allows objects to be forced
+  // to be of type Directive, while still inferring Directives generic
+  directives?: Directives & Record<string, Directive>
+
   inheritAttrs?: boolean
   emits?: (E | EE[]) & ThisType<void>
-  // TODO infer public instance type based on exposed keys
-  expose?: string[]
+  expose?: Exposed[]
   serverPrefetch?(): Promise<any>
 
   // Runtime compiler only -----------------------------------------------------
@@ -224,6 +232,9 @@ export type ComponentOptionsWithoutProps<
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = EmitsOptions,
   EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string,
   PE = Props & EmitsToProps<E>
 > = ComponentOptionsBase<
   PE,
@@ -235,11 +246,29 @@ export type ComponentOptionsWithoutProps<
   Extends,
   E,
   EE,
+  LC,
+  Directives,
+  Exposed,
   {}
 > & {
   props?: undefined
 } & ThisType<
-    CreateComponentPublicInstance<PE, RawBindings, D, C, M, Mixin, Extends, E>
+    CreateComponentPublicInstance<
+      PE,
+      RawBindings,
+      D,
+      C,
+      M,
+      Mixin,
+      Extends,
+      E,
+      Props,
+      {},
+      false,
+      LC,
+      Directives,
+      Exposed
+    >
   >
 
 export type ComponentOptionsWithArrayProps<
@@ -252,6 +281,9 @@ export type ComponentOptionsWithArrayProps<
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = EmitsOptions,
   EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string,
   Props = Readonly<{ [key in PropNames]?: any }> & EmitsToProps<E>
 > = ComponentOptionsBase<
   Props,
@@ -263,6 +295,9 @@ export type ComponentOptionsWithArrayProps<
   Extends,
   E,
   EE,
+  LC,
+  Directives,
+  Exposed,
   {}
 > & {
   props: PropNames[]
@@ -275,7 +310,13 @@ export type ComponentOptionsWithArrayProps<
       M,
       Mixin,
       Extends,
-      E
+      E,
+      Props,
+      {},
+      false,
+      LC,
+      Directives,
+      Exposed
     >
   >
 
@@ -289,6 +330,9 @@ export type ComponentOptionsWithObjectProps<
   Extends extends ComponentOptionsMixin = ComponentOptionsMixin,
   E extends EmitsOptions = EmitsOptions,
   EE extends string = string,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string,
   Props = Readonly<ExtractPropTypes<PropsOptions>> & EmitsToProps<E>,
   Defaults = ExtractDefaultPropTypes<PropsOptions>
 > = ComponentOptionsBase<
@@ -301,6 +345,9 @@ export type ComponentOptionsWithObjectProps<
   Extends,
   E,
   EE,
+  LC,
+  Directives,
+  Exposed,
   Defaults
 > & {
   props: PropsOptions & ThisType<void>
@@ -316,7 +363,9 @@ export type ComponentOptionsWithObjectProps<
       E,
       Props,
       Defaults,
-      false
+      false,
+      LC,
+      Directives
     >
   >
 
@@ -328,8 +377,24 @@ export type ComponentOptions<
   M extends MethodOptions = any,
   Mixin extends ComponentOptionsMixin = any,
   Extends extends ComponentOptionsMixin = any,
-  E extends EmitsOptions = any
-> = ComponentOptionsBase<Props, RawBindings, D, C, M, Mixin, Extends, E> &
+  E extends EmitsOptions = any,
+  LC extends Record<string, Component> = {},
+  Directives extends Record<string, Directive> = {},
+  Exposed extends string = string
+> = ComponentOptionsBase<
+  Props,
+  RawBindings,
+  D,
+  C,
+  M,
+  Mixin,
+  Extends,
+  E,
+  string,
+  LC,
+  Directives,
+  Exposed
+> &
   ThisType<
     CreateComponentPublicInstance<
       {},
@@ -340,7 +405,11 @@ export type ComponentOptions<
       Mixin,
       Extends,
       E,
-      Readonly<Props>
+      Readonly<Props>,
+      {},
+      false,
+      LC,
+      Directives
     >
   >