Narrow type of PluginDeps to an object (#40846)

* Narrow type of PluginDeps to an object * re-generate docs
elastic · Jul 23, 2019 · 4e73b18 · 4e73b18
1 parent 3467c45
commit 4e73b18
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 30 deletions.
diff --git a/docs/development/core/public/kibana-plugin-public.plugin.md b/docs/development/core/public/kibana-plugin-public.plugin.md
@@ -9,7 +9,7 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} = {}, TPluginsStart extends {} = {}> 
+export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> 
 ```
 
 ## Methods

diff --git a/docs/development/core/public/kibana-plugin-public.plugininitializer.md b/docs/development/core/public/kibana-plugin-public.plugininitializer.md
@@ -9,5 +9,5 @@ The `plugin` export at the root of a plugin's `public` directory should conform
 <b>Signature:</b>
 
 ```typescript
-export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<string, any> = {}, TPluginsStart extends Record<string, any> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
+export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 ```
diff --git a/docs/development/core/server/kibana-plugin-server.plugin.md b/docs/development/core/server/kibana-plugin-server.plugin.md
@@ -9,7 +9,7 @@ The interface that should be returned by a `PluginInitializer`<!-- -->.
 <b>Signature:</b>
 
 ```typescript
-export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} = {}, TPluginsStart extends {} = {}> 
+export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> 
 ```
 
 ## Methods

diff --git a/docs/development/core/server/kibana-plugin-server.plugininitializer.md b/docs/development/core/server/kibana-plugin-server.plugininitializer.md
@@ -9,5 +9,5 @@ The `plugin` export at the root of a plugin's `server` directory should conform
 <b>Signature:</b>
 
 ```typescript
-export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<PluginName, unknown> = {}, TPluginsStart extends Record<PluginName, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
+export declare type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 ```
diff --git a/src/core/public/plugins/plugin.ts b/src/core/public/plugins/plugin.ts
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { DiscoveredPlugin, PluginName } from '../../server';
+import { DiscoveredPlugin } from '../../server';
 import { PluginInitializerContext } from './plugin_context';
 import { loadPluginBundle } from './plugin_loader';
 import { CoreStart, CoreSetup } from '..';
@@ -30,8 +30,8 @@ import { CoreStart, CoreSetup } from '..';
 export interface Plugin<
   TSetup = void,
   TStart = void,
-  TPluginsSetup extends {} = {},
-  TPluginsStart extends {} = {}
+  TPluginsSetup extends object = object,
+  TPluginsStart extends object = object
 > {
   setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
   start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
@@ -47,8 +47,8 @@ export interface Plugin<
 export type PluginInitializer<
   TSetup,
   TStart,
-  TPluginsSetup extends Record<string, any> = {},
-  TPluginsStart extends Record<string, any> = {}
+  TPluginsSetup extends object = object,
+  TPluginsStart extends object = object
 > = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 
 /**
@@ -60,8 +60,8 @@ export type PluginInitializer<
 export class PluginWrapper<
   TSetup = unknown,
   TStart = unknown,
-  TPluginsSetup extends Record<PluginName, any> = Record<PluginName, unknown>,
-  TPluginsStart extends Record<PluginName, any> = Record<PluginName, unknown>
+  TPluginsSetup extends object = object,
+  TPluginsStart extends object = object
 > {
   public readonly name: DiscoveredPlugin['id'];
   public readonly configPath: DiscoveredPlugin['configPath'];

diff --git a/src/core/public/plugins/plugin_context.ts b/src/core/public/plugins/plugin_context.ts
@@ -19,7 +19,7 @@
 
 import { omit } from 'lodash';
 
-import { DiscoveredPlugin, PluginName } from '../../server';
+import { DiscoveredPlugin } from '../../server';
 import { CoreContext } from '../core_system';
 import { PluginWrapper } from './plugin';
 import { PluginsServiceSetupDeps, PluginsServiceStartDeps } from './plugins_service';
@@ -61,8 +61,8 @@ export function createPluginInitializerContext(
 export function createPluginSetupContext<
   TSetup,
   TStart,
-  TPluginsSetup extends Record<PluginName, unknown>,
-  TPluginsStart extends Record<PluginName, unknown>
+  TPluginsSetup extends object,
+  TPluginsStart extends object
 >(
   coreContext: CoreContext,
   deps: PluginsServiceSetupDeps,
@@ -89,8 +89,8 @@ export function createPluginSetupContext<
 export function createPluginStartContext<
   TSetup,
   TStart,
-  TPluginsSetup extends Record<PluginName, unknown>,
-  TPluginsStart extends Record<PluginName, unknown>
+  TPluginsSetup extends object,
+  TPluginsStart extends object
 >(
   coreContext: CoreContext,
   deps: PluginsServiceStartDeps,

diff --git a/src/core/public/plugins/plugin_loader.ts b/src/core/public/plugins/plugin_loader.ts
@@ -62,8 +62,8 @@ export const LOAD_TIMEOUT = 120 * 1000; // 2 minutes
 export const loadPluginBundle: LoadPluginBundle = <
   TSetup,
   TStart,
-  TPluginsSetup extends Record<string, unknown>,
-  TPluginsStart extends Record<string, unknown>
+  TPluginsSetup extends object,
+  TPluginsStart extends object
 >(
   addBasePath: (path: string) => string,
   pluginName: PluginName,
@@ -125,8 +125,8 @@ export const loadPluginBundle: LoadPluginBundle = <
 export type LoadPluginBundle = <
   TSetup,
   TStart,
-  TPluginsSetup extends Record<string, unknown>,
-  TPluginsStart extends Record<string, unknown>
+  TPluginsSetup extends object,
+  TPluginsStart extends object
 >(
   addBasePath: (path: string) => string,
   pluginName: PluginName,

diff --git a/src/core/public/public.api.md b/src/core/public/public.api.md
@@ -475,7 +475,7 @@ export interface OverlayStart {
 }
 
 // @public
-export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} = {}, TPluginsStart extends {} = {}> {
+export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> {
     // (undocumented)
     setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
     // (undocumented)
@@ -485,7 +485,7 @@ export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} =
 }
 
 // @public
-export type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<string, any> = {}, TPluginsStart extends Record<string, any> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
+export type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 
 // @public
 export interface PluginInitializerContext {

diff --git a/src/core/server/plugins/plugin.ts b/src/core/server/plugins/plugin.ts
@@ -138,8 +138,8 @@ export interface DiscoveredPluginInternal extends DiscoveredPlugin {
 export interface Plugin<
   TSetup = void,
   TStart = void,
-  TPluginsSetup extends {} = {},
-  TPluginsStart extends {} = {}
+  TPluginsSetup extends object = object,
+  TPluginsStart extends object = object
 > {
   setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
   start(core: CoreStart, plugins: TPluginsStart): TStart | Promise<TStart>;
@@ -155,8 +155,8 @@ export interface Plugin<
 export type PluginInitializer<
   TSetup,
   TStart,
-  TPluginsSetup extends Record<PluginName, unknown> = {},
-  TPluginsStart extends Record<PluginName, unknown> = {}
+  TPluginsSetup extends object = object,
+  TPluginsStart extends object = object
 > = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 
 /**
@@ -168,8 +168,8 @@ export type PluginInitializer<
 export class PluginWrapper<
   TSetup = unknown,
   TStart = unknown,
-  TPluginsSetup extends Record<PluginName, unknown> = Record<PluginName, unknown>,
-  TPluginsStart extends Record<PluginName, unknown> = Record<PluginName, unknown>
+  TPluginsSetup extends object = object,
+  TPluginsStart extends object = object
 > {
   public readonly name: PluginManifest['id'];
   public readonly configPath: PluginManifest['configPath'];

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -331,7 +331,7 @@ export interface OnPreAuthToolkit {
 }
 
 // @public
-export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} = {}, TPluginsStart extends {} = {}> {
+export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> {
     // (undocumented)
     setup(core: CoreSetup, plugins: TPluginsSetup): TSetup | Promise<TSetup>;
     // (undocumented)
@@ -341,7 +341,7 @@ export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends {} =
 }
 
 // @public
-export type PluginInitializer<TSetup, TStart, TPluginsSetup extends Record<PluginName, unknown> = {}, TPluginsStart extends Record<PluginName, unknown> = {}> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
+export type PluginInitializer<TSetup, TStart, TPluginsSetup extends object = object, TPluginsStart extends object = object> = (core: PluginInitializerContext) => Plugin<TSetup, TStart, TPluginsSetup, TPluginsStart>;
 
 // @public
 export interface PluginInitializerContext<ConfigSchema = unknown> {