Merge pull request #126 from cexbrayat/chore/strict-ts-plugin

chore(config): proper typings for plugins

Author: lmiller1990

src/config.ts

@@ -1,4 +1,6 @@
 import { GlobalMountOptions } from './types'
+import { VueWrapper } from './vue-wrapper'
+import { ComponentPublicInstance } from 'vue'
 
 interface GlobalConfigOptions {
   global: GlobalMountOptions
@@ -9,27 +11,36 @@ interface GlobalConfigOptions {
   renderStubDefaultSlot: boolean
 }
 
+interface Plugin {
+  handler: (
+    instance: VueWrapper<ComponentPublicInstance>
+  ) => Record<string, any>
+  options: Record<string, any>
+}
+
 class Pluggable {
-  installedPlugins: any
-  constructor() {
-    this.installedPlugins = []
-  }
+  installedPlugins = [] as Array<Plugin>
 
-  install(handler, options = {}) {
+  install(
+    handler: (
+      instance: VueWrapper<ComponentPublicInstance>
+    ) => Record<string, any>,
+    options: Record<string, any> = {}
+  ) {
     if (typeof handler !== 'function') {
       console.error('plugin.install must receive a function')
       handler = () => ({})
     }
     this.installedPlugins.push({ handler, options })
   }
 
-  extend(instance) {
-    const invokeSetup = (plugin) => plugin.handler(instance) // invoke the setup method passed to install
+  extend(instance: VueWrapper<ComponentPublicInstance>) {
+    const invokeSetup = (plugin: Plugin) => plugin.handler(instance) // invoke the setup method passed to install
     const bindProperty = ([property, value]: [string, any]) => {
-      instance[property] =
+      ;(instance as any)[property] =
         typeof value === 'function' ? value.bind(instance) : value
     }
-    const addAllPropertiesFromSetup = (setupResult) => {
+    const addAllPropertiesFromSetup = (setupResult: Record<string, any>) => {
       setupResult = typeof setupResult === 'object' ? setupResult : {}
       Object.entries(setupResult).forEach(bindProperty)
     }

tests/features/plugins.spec.ts

@@ -69,7 +69,7 @@ describe('Plugin', () => {
       it.each(plugins)(
         'Calling install with %p is handled gracefully',
         (plugin) => {
-          config.plugins.VueWrapper.install(plugin)
+          config.plugins.VueWrapper.install(plugin as any)
           expect(() => mountComponent()).not.toThrow()
         }
       )