refactor: 💡 simplify Trigger interface

src/legacy/core_plugins/visualizations/public/embeddable/visualize_embeddable.ts

@@ -304,12 +304,12 @@ export class VisualizeEmbeddable extends Embeddable<VisualizeInput, VisualizeOut
         if (!this.input.disableTriggers) {
           const triggerId: 'SELECT_RANGE_TRIGGER' | 'VALUE_CLICK_TRIGGER' =
             event.name === 'brush' ? selectRangeTrigger.id : valueClickTrigger.id;
-          const params: EmbeddableVisTriggerContext = {
+          const context: EmbeddableVisTriggerContext = {
             embeddable: this,
             timeFieldName: this.vis.indexPattern.timeFieldName,
             data: event.data,
           };
-          npStart.plugins.uiActions.getTrigger(triggerId).exec(params);
+          npStart.plugins.uiActions.getTrigger(triggerId).exec(context);
         }
       })
     );

src/plugins/embeddable/public/bootstrap.ts

@@ -18,24 +18,23 @@
  */
 
 import { UiActionsSetup } from 'src/plugins/ui_actions/public';
-import { Trigger } from '../../ui_actions/public';
 import {
   applyFilterTrigger,
   contextMenuTrigger,
   createFilterAction,
   panelBadgeTrigger,
   selectRangeTrigger,
   valueClickTrigger,
-  EmbeddableVisTrigger,
+  EmbeddableVisTriggerContext,
 } from './lib';
 
 declare module '../../ui_actions/public' {
   export interface TriggerContextMapping {
-    SELECT_RANGE_TRIGGER: EmbeddableVisTrigger<'SELECT_RANGE_TRIGGER'>;
-    VALUE_CLICK_TRIGGER: EmbeddableVisTrigger<'VALUE_CLICK_TRIGGER'>;
-    CONTEXT_MENU_TRIGGER: Trigger;
-    APPLY_FILTER_TRIGGER: Trigger;
-    PANEL_BADGE_TRIGGER: Trigger;
+    SELECT_RANGE_TRIGGER: EmbeddableVisTriggerContext;
+    VALUE_CLICK_TRIGGER: EmbeddableVisTriggerContext;
+    CONTEXT_MENU_TRIGGER: object;
+    APPLY_FILTER_TRIGGER: object;
+    PANEL_BADGE_TRIGGER: object;
   }
 }
 

src/plugins/embeddable/public/index.ts

@@ -47,7 +47,6 @@ export {
   EmbeddableOutput,
   EmbeddablePanel,
   EmbeddableRoot,
-  EmbeddableVisTrigger,
   EmbeddableVisTriggerContext,
   ErrorEmbeddable,
   GetEmbeddableFactories,

src/plugins/embeddable/public/lib/triggers/triggers.ts

@@ -29,42 +29,36 @@ export interface EmbeddableVisTriggerContext {
   };
 }
 
-export type EmbeddableVisTrigger<ID extends string> = Trigger<
-  ID,
-  EmbeddableVisTriggerContext,
-  EmbeddableVisTriggerContext
->;
-
 export const SELECT_RANGE_TRIGGER = 'SELECT_RANGE_TRIGGER';
-export const selectRangeTrigger: EmbeddableVisTrigger<'SELECT_RANGE_TRIGGER'> = {
+export const selectRangeTrigger: Trigger<'SELECT_RANGE_TRIGGER'> = {
   id: SELECT_RANGE_TRIGGER,
   title: 'Select range',
   description: 'Applies a range filter',
 };
 
 export const VALUE_CLICK_TRIGGER = 'VALUE_CLICK_TRIGGER';
-export const valueClickTrigger: EmbeddableVisTrigger<'VALUE_CLICK_TRIGGER'> = {
+export const valueClickTrigger: Trigger<'VALUE_CLICK_TRIGGER'> = {
   id: VALUE_CLICK_TRIGGER,
   title: 'Value clicked',
   description: 'Value was clicked',
 };
 
 export const CONTEXT_MENU_TRIGGER = 'CONTEXT_MENU_TRIGGER';
-export const contextMenuTrigger: Trigger = {
+export const contextMenuTrigger: Trigger<'CONTEXT_MENU_TRIGGER'> = {
   id: CONTEXT_MENU_TRIGGER,
   title: 'Context menu',
   description: 'Triggered on top-right corner context-menu select.',
 };
 
 export const APPLY_FILTER_TRIGGER = 'FILTER_TRIGGER';
-export const applyFilterTrigger: Trigger = {
+export const applyFilterTrigger: Trigger<'FILTER_TRIGGER'> = {
   id: APPLY_FILTER_TRIGGER,
   title: 'Filter click',
   description: 'Triggered when user applies filter to an embeddable.',
 };
 
 export const PANEL_BADGE_TRIGGER = 'PANEL_BADGE_TRIGGER';
-export const panelBadgeTrigger: Trigger = {
+export const panelBadgeTrigger: Trigger<'PANEL_BADGE_TRIGGER'> = {
   id: PANEL_BADGE_TRIGGER,
   title: 'Panel badges',
   description: 'Actions appear in title bar when an embeddable loads in a panel',

src/plugins/ui_actions/public/index.ts

@@ -29,7 +29,7 @@ export { UiActionsSetup, UiActionsStart } from './plugin';
 export { UiActionsServiceParams, UiActionsService } from './service';
 export { Action, createAction, IncompatibleActionError } from './actions';
 export { buildContextMenuForActions } from './context_menu';
-export { Trigger, AnyTrigger, TriggerContext, TriggerContextParams } from './triggers';
+export { Trigger, AnyTrigger, TriggerContext } from './triggers';
 export { TriggerContextMapping } from './types';
 
 /**

src/plugins/ui_actions/public/service/ui_actions_service.ts

@@ -24,7 +24,7 @@ import {
   TriggerContextMapping,
 } from '../types';
 import { Action } from '../actions';
-import { TriggerContextParams, AnyTrigger } from '../triggers/trigger';
+import { AnyTrigger, Trigger } from '../triggers/trigger';
 import { TriggerInternal } from '../triggers/trigger_internal';
 import { TriggerContract } from '../triggers/trigger_contract';
 
@@ -66,7 +66,7 @@ export class UiActionsService {
 
   public readonly getTrigger = <T extends keyof TriggerContextMapping>(
     triggerId: T
-  ): TriggerContract<TriggerContextMapping[T]> => {
+  ): TriggerContract<Trigger<T extends string ? T : never>> => {
     const trigger = this.triggers.get(triggerId as string);
 
     if (!trigger) {
@@ -145,10 +145,10 @@ export class UiActionsService {
    */
   public readonly executeTriggerActions = async <T extends AnyTrigger>(
     triggerId: string,
-    params: TriggerContextParams<T>
+    context: TriggerContextMapping[T['id']]
   ) => {
     const trigger = this.getTrigger<any>(triggerId);
-    await trigger.exec(params);
+    await trigger.exec(context);
   };
 
   /**

src/plugins/ui_actions/public/triggers/trigger.ts

@@ -17,6 +17,8 @@
  * under the License.
  */
 
+import { TriggerContextMapping } from '../types';
+
 /**
  * This is a convenience interface used to register a *trigger*.
  *
@@ -28,11 +30,7 @@
  * trigger is *called* it first displays a context menu for user to pick a
  * single action to execute.
  */
-export interface Trigger<
-  ID extends string = string,
-  Context extends object = object,
-  CreateContextParams extends object = object
-> {
+export interface Trigger<ID extends string = string> {
   /**
    * Unique name of the trigger as identified in `ui_actions` plugin trigger
    * registry, such as "SELECT_RANGE_TRIGGER" or "VALUE_CLICK_TRIGGER".
@@ -48,17 +46,8 @@ export interface Trigger<
    * A longer user friendly description of the trigger.
    */
   description?: string;
-
-  /**
-   * Method called to create trigger `Context`, which is passed to `Action`.
-   * If omitted, an identity function is used.
-   */
-  createContext?: (params: CreateContextParams) => Context;
 }
 
-export type AnyTrigger = Trigger<any, any, any>;
+export type AnyTrigger = Trigger<any>;
 
-export type TriggerContext<T> = T extends Trigger<any, infer Context, any> ? Context : never;
-export type TriggerContextParams<T> = T extends Trigger<any, any, infer ContextParams>
-  ? ContextParams
-  : never;
+export type TriggerContext<T> = T extends Trigger<infer ID> ? TriggerContextMapping[ID] : never;

src/plugins/ui_actions/public/triggers/trigger_contract.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { AnyTrigger, TriggerContextParams } from './trigger';
+import { AnyTrigger, TriggerContext } from './trigger';
 import { TriggerInternal } from './trigger_internal';
 
 /**
@@ -49,7 +49,7 @@ export class TriggerContract<T extends AnyTrigger> {
   /**
    * Use this method to execute action attached to this trigger.
    */
-  public readonly exec = async (params: TriggerContextParams<T>) => {
-    await this.internal.execute(params);
+  public readonly exec = async (context: TriggerContext<T>) => {
+    await this.internal.execute(context);
   };
 }

src/plugins/ui_actions/public/triggers/trigger_internal.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { AnyTrigger, TriggerContext, TriggerContextParams } from './trigger';
+import { AnyTrigger, TriggerContext } from './trigger';
 import { TriggerContract } from './trigger_contract';
 import { UiActionsService } from '../service';
 import { Action } from '../actions';
@@ -32,13 +32,7 @@ export class TriggerInternal<T extends AnyTrigger> {
 
   constructor(public readonly service: UiActionsService, public readonly trigger: T) {}
 
-  public createContext(params: TriggerContextParams<T>): TriggerContext<T> {
-    if (!this.trigger.createContext) return (params as unknown) as TriggerContext<T>;
-    return this.trigger.createContext(params);
-  }
-
-  public async execute(params: TriggerContextParams<T>) {
-    const context = this.createContext(params);
+  public async execute(context: TriggerContext<T>) {
     const triggerId = this.trigger.id;
     const actions = await this.service.getTriggerCompatibleActions!(triggerId, context);
 

src/plugins/ui_actions/public/types.ts

@@ -19,12 +19,11 @@
 
 import { Action } from './actions/action';
 import { TriggerInternal } from './triggers/trigger_internal';
-import { AnyTrigger } from './triggers';
 
 export type TriggerRegistry = Map<string, TriggerInternal<any>>;
 export type ActionRegistry = Map<string, Action>;
 export type TriggerToActionsRegistry = Map<string, string[]>;
 
 export interface TriggerContextMapping {
-  [key: string]: AnyTrigger;
+  [key: string]: object;
 }