require object context, which seems to fix the partial requirement in…

… type and thus the type issue
elastic · Mar 2, 2020 · 5e50447 · 5e50447
1 parent f97c9c3
commit 5e50447
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 11 deletions.
diff --git a/examples/ui_action_examples/public/plugin.ts b/examples/ui_action_examples/public/plugin.ts
@@ -28,11 +28,11 @@ interface UiActionExamplesSetupDependencies {
 
 declare module '../../../src/plugins/ui_actions/public' {
  export interface TriggerContextMapping {
- [HELLO_WORLD_TRIGGER_ID]: undefined;
+ [HELLO_WORLD_TRIGGER_ID]: {};
  }
 
  export interface ActionContextMapping {
- [ACTION_HELLO_WORLD]: undefined;
+ [ACTION_HELLO_WORLD]: {};
  }
 }
 

diff --git a/examples/ui_actions_explorer/public/app.tsx b/examples/ui_actions_explorer/public/app.tsx
@@ -60,7 +60,7 @@ const ActionsExplorer = ({ uiActionsApi, openModal }: Props) => {
  </EuiText>
  <EuiButton
  data-test-subj="emitHelloWorldTrigger"
- onClick={() => uiActionsApi.executeTriggerActions(HELLO_WORLD_TRIGGER_ID, undefined)}
+ onClick={() => uiActionsApi.executeTriggerActions(HELLO_WORLD_TRIGGER_ID, {})}
  >
  Say hello world!
  </EuiButton>
@@ -99,7 +99,7 @@ const ActionsExplorer = ({ uiActionsApi, openModal }: Props) => {
  uiActionsApi.attachAction(HELLO_WORLD_TRIGGER_ID, dynamicAction);
  setConfirmationText(
  `You've successfully added a new action: ${dynamicAction.getDisplayName(
- undefined
+ {}
  )}. Refresh the page to reset state. It's up to the user of the system to persist state like this.`
  );
  }}

diff --git a/examples/ui_actions_explorer/public/plugin.tsx b/examples/ui_actions_explorer/public/plugin.tsx
@@ -57,7 +57,7 @@ declare module '../../../src/plugins/ui_actions/public' {
 
  export interface ActionContextMapping {
  [ACTION_EDIT_USER]: UserContext;
- [ACTION_SHOWCASE_PLUGGABILITY]: undefined;
+ [ACTION_SHOWCASE_PLUGGABILITY]: {};
  [ACTION_CALL_PHONE_NUMBER]: PhoneContext;
  [ACTION_TRAVEL_GUIDE]: CountryContext;
  [ACTION_VIEW_IN_MAPS]: CountryContext;

diff --git a/src/plugins/ui_actions/public/actions/action.ts b/src/plugins/ui_actions/public/actions/action.ts
@@ -22,7 +22,7 @@ import { ActionType, ActionContextMapping } from '../types';
 
 export type ActionByType<T extends ActionType> = Action<ActionContextMapping[T], T>;
 
-export interface Action<Context = undefined, T = ActionType> {
+export interface Action<Context = {}, T = ActionType> {
  /**
  * Determined the order when there is more than one action matched to a trigger.
  * Higher numbers are displayed first.

diff --git a/src/plugins/ui_actions/public/service/ui_actions_service.test.ts b/src/plugins/ui_actions/public/service/ui_actions_service.test.ts
@@ -105,7 +105,7 @@ describe('UiActionsService', () => {
  });
 
  describe('.getTriggerActions()', () => {
- const action1: Action<undefined, ActionType> = {
+ const action1: Action = {
  id: 'action1',
  order: 1,
  type: 'type1' as ActionType,
@@ -114,7 +114,7 @@ describe('UiActionsService', () => {
  getIconType: () => '',
  isCompatible: async () => true,
  };
- const action2: Action<undefined, ActionType> = {
+ const action2: Action = {
  id: 'action2',
  order: 2,
  type: 'type2' as ActionType,

diff --git a/src/plugins/ui_actions/public/service/ui_actions_service.ts b/src/plugins/ui_actions/public/service/ui_actions_service.ts
@@ -96,7 +96,7 @@ export class UiActionsService {
  triggerId: TType,
  // The action can accept partial or no context, but if it needs context not provided
  // by this type of trigger, typescript will complain. yay!
- action: Action<Partial<TriggerContextMapping[TType]> | undefined> & ActionByType<AType>
+ action: ActionByType<AType> & Action<TriggerContextMapping[TType]>
  ): void => {
  if (!this.actions.has(action.id)) {
  this.registerAction(action);
@@ -157,7 +157,7 @@ export class UiActionsService {
  public readonly getTriggerCompatibleActions = async <T extends TriggerId>(
  triggerId: T,
  context: TriggerContextMapping[T]
- ): Promise<Array<Action<TriggerContextMapping[T] | undefined>>> => {
+ ): Promise<Array<Action<TriggerContextMapping[T]>>> => {
  const actions = this.getTriggerActions!(triggerId);
  const isCompatibles = await Promise.all(actions.map(action => action.isCompatible(context)));
  return actions.reduce(

diff --git a/src/plugins/ui_actions/public/types.ts b/src/plugins/ui_actions/public/types.ts
@@ -28,8 +28,8 @@ const DEFAULT_TRIGGER = '';
 
 export type TriggerId = keyof TriggerContextMapping;
 
+export type BaseContext = object;
 export type TriggerContext = BaseContext;
-export type BaseContext = object | undefined | string | number;
 
 export interface TriggerContextMapping {
  [DEFAULT_TRIGGER]: TriggerContext;