feat(modal): added global modal to render in web-dir from client apps…

… includes api and message code

src/client.ts

@@ -50,6 +50,10 @@ export interface ClientConfigOptions {
   hostOrigin?: string;
 }
 
+export const modalTypes = {
+  WEM_COACHING_UI: 'wemCoachingUi'
+};
+
 /**
  * This class is the primary interface that an embedded iframe client should use to communicate with
  * the host application.
@@ -420,6 +424,22 @@ bad input into one of the iframe-coordinator client methods.
     });
   }
 
+  /**
+   * Asks the host application to launch an instance of a global modal
+   *
+   * Currently the only available one is WEM Coaching UI
+   *
+   * @param modalType the type of modal to be used.
+   * @param modalData any data you wish to be sent to the modal, Conversation IDs etc.
+   *
+   */
+  public requestModal(modalType: any, modalData: any) {
+    this._sendToHost({
+      msgType: 'modalRequest',
+      msg: { modalType, modalData }
+    });
+  }
+
   /**
    * Asks the host application to display a user notification.
    *

src/messages/ClientToHost.ts

@@ -1,6 +1,7 @@
 import { dispatch, guard } from 'decoders';
 import { decoder as keyDownDecoder, LabeledKeyDown } from './KeyDown';
 import { LabeledStarted, startedDecoder } from './Lifecycle';
+import { decoder as modalDecoder, LabeledModal } from './Modal';
 import { decoder as navRequestDecoder, LabeledNavRequest } from './NavRequest';
 import { decoder as notifyDecoder, LabeledNotification } from './Notification';
 import {
@@ -17,7 +18,8 @@ export type ClientToHost =
   | LabeledNotification
   | LabeledNavRequest
   | LabeledStarted
-  | LabeledKeyDown;
+  | LabeledKeyDown
+  | LabeledModal;
 
 /**
  * Validates correctness of messages being sent from
@@ -32,7 +34,8 @@ export function validate(msg: any): ClientToHost {
       client_started: startedDecoder,
       navRequest: navRequestDecoder,
       notifyRequest: notifyDecoder,
-      toastRequest: notifyDecoder
+      toastRequest: notifyDecoder,
+      modalRequest: modalDecoder
     })
   )(msg);
 }

src/messages/Modal.ts

@@ -0,0 +1,18 @@
+import { constant, Decoder, mixed } from 'decoders';
+import { labeledDecoder, LabeledMsg } from './LabeledMsg';
+
+/**
+ * A message used to publish a generic messages
+ * between the clients and the host application.
+ */
+export interface LabeledModal extends LabeledMsg<'modalRequest', any> {
+  /** Message identifier */
+  msgType: 'modalRequest';
+}
+
+const decoder: Decoder<LabeledModal> = labeledDecoder(
+  constant<'modalRequest'>('modalRequest'),
+  mixed
+);
+
+export { decoder };