@inboxsdk/core 0.2.27 → 0.2.28-alpha.1

package/src/platform-implementation-js/driver-common/sidebar/ContentPanelViewDriver.js

@@ -0,0 +1,197 @@
+/* @flow */
+
+import { defn } from 'ud';
+import autoHtml from 'auto-html';
+import Kefir from 'kefir';
+import kefirBus from 'kefir-bus';
+import kefirStopper from 'kefir-stopper';
+import delayAsap from '../../lib/delay-asap';
+import type { Driver } from '../../driver-interfaces/driver';
+import idMap from '../../lib/idMap';
+import querySelector from '../../lib/dom/querySelectorOrFail';
+
+class ContentPanelViewDriver {
+  _driver: Driver;
+  _stopper: Kefir.Observable<null>;
+  _eventStream = kefirBus();
+  _isActive: boolean = false;
+
+  // This is not the `id` property passed by the application, but a random
+  // unique identifier used to manage a specific instance.
+  _instanceId: string = `${Date.now()}-${Math.random()}`;
+  _sidebarId: string;
+  _isGlobal: boolean;
+
+  constructor(
+    driver: Driver,
+    descriptor: Kefir.Observable<Object>,
+    sidebarId: string,
+    isGlobal?: boolean
+  ) {
+    this._driver = driver;
+    this._sidebarId = sidebarId;
+    this._isGlobal = Boolean(isGlobal);
+    this._stopper = this._eventStream
+      .ignoreValues()
+      .beforeEnd(() => null)
+      .toProperty();
+
+    const document = global.document; //fix for unit test
+
+    this._eventStream.plug(
+      Kefir.fromEvents((document.body: any), 'inboxsdkSidebarPanelActivated')
+        .filter((e) => e.detail.instanceId === this._instanceId)
+        .map(() => {
+          this._isActive = true;
+          return { eventName: 'activate' };
+        })
+    );
+    this._eventStream.plug(
+      Kefir.fromEvents((document.body: any), 'inboxsdkSidebarPanelDeactivated')
+        .filter((e) => e.detail.instanceId === this._instanceId)
+        .map(() => {
+          this._isActive = false;
+          return { eventName: 'deactivate' };
+        })
+    );
+
+    // Attach a value-listener so that it immediately subscribes and the
+    // property retains its value.
+    const afterAsap = delayAsap()
+      .toProperty()
+      .onValue(() => {});
+
+    let hasPlacedAlready = false;
+    let appName;
+    const waitingPlatform = querySelector(
+      (document.body: any),
+      '.' + idMap('app_sidebar_waiting_platform')
+    );
+
+    descriptor
+      .flatMap((x) => afterAsap.map(() => x))
+      .takeUntilBy(this._stopper)
+      .onValue((descriptor) => {
+        const {
+          el,
+          iconUrl,
+          iconClass,
+          title,
+          orderHint,
+          id,
+          hideTitleBar,
+          appIconUrl,
+          primaryColor,
+          secondaryColor,
+        } = descriptor;
+        appName =
+          descriptor.appName || driver.getOpts().appName || descriptor.title;
+        if (!((document.body: any): HTMLElement).contains(el)) {
+          waitingPlatform.appendChild(el);
+        }
+        const eventName = hasPlacedAlready
+          ? 'inboxsdkUpdateSidebarPanel'
+          : 'inboxsdkNewSidebarPanel';
+        hasPlacedAlready = true;
+
+        el.dispatchEvent(
+          new CustomEvent(eventName, {
+            bubbles: true,
+            cancelable: false,
+            detail: {
+              appIconUrl:
+                appIconUrl || this._driver.getOpts().appIconUrl || iconUrl,
+              appId: this._driver.getAppId(),
+              appName,
+              hideTitleBar: Boolean(hideTitleBar),
+              iconClass,
+              iconUrl,
+              id: String(id || title),
+              instanceId: this._instanceId,
+              isGlobal,
+              orderHint: typeof orderHint === 'number' ? orderHint : 0,
+              primaryColor: primaryColor || this._driver.getOpts().primaryColor,
+              secondaryColor:
+                secondaryColor || this._driver.getOpts().secondaryColor,
+              sidebarId: this._sidebarId,
+              title,
+            },
+          })
+        );
+      });
+
+    this._stopper.onValue(() => {
+      if (!hasPlacedAlready) return;
+      ((document.body: any): HTMLElement).dispatchEvent(
+        new CustomEvent('inboxsdkRemoveSidebarPanel', {
+          bubbles: true,
+          cancelable: false,
+          detail: {
+            appName,
+            sidebarId: this._sidebarId,
+            instanceId: this._instanceId,
+          },
+        })
+      );
+    });
+  }
+
+  getStopper(): Kefir.Observable<null> {
+    return this._stopper;
+  }
+
+  getEventStream(): Kefir.Observable<*> {
+    return this._eventStream;
+  }
+
+  scrollIntoView() {
+    ((document.body: any): HTMLElement).dispatchEvent(
+      new CustomEvent('inboxsdkSidebarPanelScrollIntoView', {
+        bubbles: true,
+        cancelable: false,
+        detail: {
+          instanceId: this._instanceId,
+          sidebarId: this._sidebarId,
+        },
+      })
+    );
+  }
+
+  close() {
+    ((document.body: any): HTMLElement).dispatchEvent(
+      new CustomEvent('inboxsdkSidebarPanelClose', {
+        bubbles: true,
+        cancelable: false,
+        detail: {
+          instanceId: this._instanceId,
+          isGlobal: this._isGlobal,
+          sidebarId: this._sidebarId,
+        },
+      })
+    );
+  }
+
+  open() {
+    ((document.body: any): HTMLElement).dispatchEvent(
+      new CustomEvent('inboxsdkSidebarPanelOpen', {
+        bubbles: true,
+        cancelable: false,
+        detail: {
+          instanceId: this._instanceId,
+          isGlobal: this._isGlobal,
+          sidebarId: this._sidebarId,
+        },
+      })
+    );
+  }
+
+  isActive(): boolean {
+    return this._isActive;
+  }
+
+  remove() {
+    this._eventStream.end();
+  }
+}
+
+export default defn(module, ContentPanelViewDriver);

package/src/platform-implementation-js/driver-common/update-icon.d.ts

@@ -0,0 +1,8 @@
+export interface IconSettings {
+    iconElement?: HTMLElement | null;
+    iconHtmlElement?: HTMLElement | null;
+    iconImgElement?: HTMLElement | null;
+}
+export default function updateIcon(iconSettings: IconSettings, containerElement: HTMLElement, append: boolean, newIconClass: string | null | undefined, newIconUrl: string | null | undefined, insertBeforeEl?: HTMLElement | null | undefined, // Should not be used with append: true — the append flag will override
+newIconHtml?: string): void;
+//# sourceMappingURL=update-icon.d.ts.map

package/src/platform-implementation-js/driver-common/update-icon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-icon.d.ts","sourceRoot":"","sources":["../../../../../src/platform-implementation-js/driver-common/update-icon.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,WAAW,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IACjC,eAAe,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IACrC,cAAc,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;CACrC;AA6CD,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,YAAY,EAAE,YAAY,EAC1B,gBAAgB,EAAE,WAAW,EAC7B,MAAM,EAAE,OAAO,EACf,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACvC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACrC,cAAc,CAAC,EAAE,WAAW,GAAG,IAAI,GAAG,SAAS,EAAE,uEAAuE;AACxH,WAAW,CAAC,EAAE,MAAM,QAmGrB"}

package/src/platform-implementation-js/driver-interfaces/compose-view-driver.d.ts

@@ -0,0 +1,133 @@
+import * as Kefir from 'kefir';
+import EventEmitter from 'events';
+
+export interface Contact {
+  emailAddress: string;
+  name: null | undefined | string;
+}
+
+export interface TooltipDescriptor {
+  el?: null | undefined | HTMLElement;
+  title?: null | undefined | string;
+  subtitle?: null | undefined | string;
+  imageUrl?: null | undefined | string;
+  button?: null | undefined | { onClick?: Function; title: string };
+}
+
+export interface ComposeNotice extends EventEmitter {
+  destroy(): void;
+  destroyed: boolean;
+  el: HTMLElement;
+}
+
+export interface StatusBar extends EventEmitter {
+  destroy(): void;
+  destroyed: boolean;
+  el: HTMLElement;
+  setHeight(height: number): void;
+}
+
+export interface ComposeButtonDescriptor {
+  title: string;
+  iconUrl?: null | undefined | string;
+  iconClass?: null | undefined | string;
+  onClick: (event: object) => void;
+  hasDropdown?: null | undefined | boolean;
+  type?: null | undefined | string;
+  orderHint?: null | undefined | number;
+  enabled?: null | undefined | boolean;
+}
+
+export interface ComposeViewDriver {
+  getEventStream(): Kefir.Observable<any, any>;
+  getStopper(): Kefir.Observable<any, never>;
+  getElement(): HTMLElement;
+  insertBodyTextAtCursor(text: string): null | undefined | HTMLElement;
+  insertBodyHTMLAtCursor(html: string): null | undefined | HTMLElement;
+  insertLinkIntoBody(
+    text: string,
+    href: string
+  ): null | undefined | HTMLElement;
+  insertLinkChipIntoBody(options: {
+    iconUrl?: string;
+    url: string;
+    text: string;
+  }): HTMLElement;
+  setSubject(text: string): void;
+  setBodyHTML(html: string): void;
+  setBodyText(text: string): void;
+  setToRecipients(emails: ReadonlyArray<string>): void;
+  setCcRecipients(emails: ReadonlyArray<string>): void;
+  setBccRecipients(emails: ReadonlyArray<string>): void;
+  getFromContact(): Contact;
+  getFromContactChoices(): ReadonlyArray<Contact>;
+  setFromEmail(email: string): void;
+  focus(): void;
+  close(): void;
+  send(options: { sendAndArchive: boolean }): void;
+  discard(): void;
+  popOut(): void;
+  replaceSendButton(el: HTMLElement): () => void;
+  hideDiscardButton(): () => void;
+  registerRequestModifier(modifier: object): void;
+  attachFiles(files: Blob[]): Promise<void>;
+  attachInlineFiles(files: Blob[]): Promise<void>;
+  isFullscreen(): boolean;
+  setFullscreen(fullscreen: boolean): void;
+  isMinimized(): boolean;
+  setMinimized(minimized: boolean): void;
+  setTitleBarColor(color: string): () => void;
+  setTitleBarText(text: string): () => void;
+  addButton(
+    buttonDescriptor: Kefir.Observable<
+      null | undefined | ComposeButtonDescriptor,
+      any
+    >,
+    groupOrderHint: string,
+    extraOnClickOptions: object
+  ): Promise<null | undefined | object>;
+  addRecipientRow(
+    options: Kefir.Observable<null | undefined | object, any>
+  ): () => void;
+  forceRecipientRowsOpen(): () => void;
+  hideNativeRecipientRows(): () => void;
+  hideRecipientArea(): () => void;
+  ensureFormattingToolbarIsHidden(): void;
+  ensureAppButtonToolbarsAreClosed(): void;
+  // addOuterSidebar(options: {title: string, el: HTMLElement}): void;
+  // addInnerSidebar(options: {el: HTMLElement}): void;
+  addComposeNotice(options?: { orderHint?: number }): ComposeNotice;
+  addStatusBar(options?: {
+    height?: number;
+    orderHint?: number;
+    addAboveNativeStatusBar?: boolean;
+  }): StatusBar;
+  hideNativeStatusBar(): () => void;
+  isForward(): boolean;
+  isReply(): boolean;
+  isInlineReplyForm(): boolean;
+  getBodyElement(): HTMLElement;
+  getMetadataFormElement(): HTMLElement;
+  getSubjectInput(): null | undefined | HTMLInputElement;
+  getHTMLContent(): string;
+  getTextContent(): string;
+  getSelectedBodyHTML(): null | undefined | string;
+  getSelectedBodyText(): null | undefined | string;
+  getSubject(): string;
+  getToRecipients(): ReadonlyArray<Contact>;
+  getCcRecipients(): ReadonlyArray<Contact>;
+  getBccRecipients(): ReadonlyArray<Contact>;
+  getComposeID(): string;
+  getInitialMessageID(): null | undefined | string;
+  getMessageID(): null | undefined | string;
+  getThreadID(): null | undefined | string;
+  getCurrentDraftID(): Promise<null | string>;
+  getDraftID(): Promise<null | string>;
+  addTooltipToButton(
+    buttonViewController: object,
+    buttonDescriptor: object,
+    tooltipDescriptor: TooltipDescriptor
+  ): void;
+  closeButtonTooltip(buttonViewController: object): void;
+  setupLinkPopOvers(): void;
+}

package/src/platform-implementation-js/driver-interfaces/compose-view-driver.js

@@ -0,0 +1,114 @@
+/* @flow */
+
+import type Kefir from 'kefir';
+import type EventEmitter from 'events';
+import type { TooltipDescriptor } from '../views/compose-button-view';
+
+export type ComposeNotice = EventEmitter & {
+  destroy(): void,
+  destroyed: boolean,
+  el: HTMLElement,
+};
+
+export type StatusBar = EventEmitter & {
+  destroy(): void,
+  destroyed: boolean,
+  el: HTMLElement,
+  setHeight(height: number): void,
+};
+
+export type ComposeButtonDescriptor = {
+  title: string,
+  iconUrl?: ?string,
+  iconClass?: ?string,
+  onClick: (event: Object) => void,
+  hasDropdown?: ?boolean,
+  type?: ?string,
+  orderHint?: ?number,
+  enabled?: ?boolean,
+};
+
+export type ComposeViewDriver = {
+  getEventStream(): Kefir.Observable<Object>,
+  getStopper(): Kefir.Observable<any>,
+  getElement(): HTMLElement,
+  insertBodyTextAtCursor(text: string): ?HTMLElement,
+  insertBodyHTMLAtCursor(html: string): ?HTMLElement,
+  insertLinkIntoBody(text: string, href: string): ?HTMLElement,
+  insertLinkChipIntoBody(options: {
+    iconUrl?: string,
+    url: string,
+    text: string,
+  }): HTMLElement,
+  setSubject(text: string): void,
+  setBodyHTML(html: string): void,
+  setBodyText(text: string): void,
+  setToRecipients(emails: string[]): void,
+  setCcRecipients(emails: string[]): void,
+  setBccRecipients(emails: string[]): void,
+  getFromContact(): Contact,
+  getFromContactChoices(): Contact[],
+  setFromEmail(email: string): void,
+  focus(): void,
+  close(): void,
+  send({ sendAndArchive: boolean }): void,
+  discard(): void,
+  popOut(): void,
+  replaceSendButton(el: HTMLElement): () => void,
+  hideDiscardButton(): () => void,
+  registerRequestModifier(modifier: Object): void,
+  attachFiles(files: Blob[]): Promise<void>,
+  attachInlineFiles(files: Blob[]): Promise<void>,
+  isFullscreen(): boolean,
+  setFullscreen(fullscreen: boolean): void,
+  isMinimized(): boolean,
+  setMinimized(minimized: boolean): void,
+  setTitleBarColor(color: string): () => void,
+  setTitleBarText(text: string): () => void,
+  addButton(
+    buttonDescriptor: Kefir.Observable<?ComposeButtonDescriptor>,
+    groupOrderHint: string,
+    extraOnClickOptions: Object
+  ): Promise<?Object>,
+  addRecipientRow(options: Kefir.Observable<?Object>): () => void,
+  forceRecipientRowsOpen(): () => void,
+  hideNativeRecipientRows(): () => void,
+  hideRecipientArea(): () => void,
+  ensureFormattingToolbarIsHidden(): void,
+  ensureAppButtonToolbarsAreClosed(): void,
+  // addOuterSidebar(options: {title: string, el: HTMLElement}): void;
+  // addInnerSidebar(options: {el: HTMLElement}): void;
+  addComposeNotice(options?: { orderHint?: number }): ComposeNotice,
+  addStatusBar(options?: {
+    height?: number,
+    orderHint?: number,
+    addAboveNativeStatusBar?: boolean,
+  }): StatusBar,
+  hideNativeStatusBar(): () => void,
+  isForward(): boolean,
+  isReply(): boolean,
+  isInlineReplyForm(): boolean,
+  getBodyElement(): HTMLElement,
+  getMetadataFormElement(): HTMLElement,
+  getSubjectInput(): ?HTMLInputElement,
+  getHTMLContent(): string,
+  getTextContent(): string,
+  getSelectedBodyHTML(): ?string,
+  getSelectedBodyText(): ?string,
+  getSubject(): string,
+  getToRecipients(): Contact[],
+  getCcRecipients(): Contact[],
+  getBccRecipients(): Contact[],
+  getComposeID(): string,
+  getInitialMessageID(): ?string,
+  getMessageID(): ?string,
+  getThreadID(): ?string,
+  getCurrentDraftID(): Promise<?string>,
+  getDraftID(): Promise<?string>,
+  addTooltipToButton(
+    buttonViewController: Object,
+    buttonDescriptor: Object,
+    tooltipDescriptor: TooltipDescriptor
+  ): void,
+  closeButtonTooltip(buttonViewController: Object): void,
+};

package/src/platform-implementation-js/driver-interfaces/driver.d.ts

@@ -0,0 +1,142 @@
+import * as Kefir from 'kefir';
+import KeyboardShortcutHandle from '../views/keyboard-shortcut-handle';
+import Logger from '../lib/logger';
+import { ComposeViewDriver, Contact } from './compose-view-driver';
+// import ComposeView from '../views/compose-view';
+type ComposeView = any;
+// import { RouteViewDriver } from './route-view-driver';
+type RouteViewDriver = any;
+import CommonPageCommunicator from '../lib/common-page-communicator';
+import GmailSupportItemView, {
+  SupportItemDescriptor,
+} from '../dom-driver/gmail/views/gmail-support-item-view';
+import { AppMenuItemDescriptor } from '../namespaces/app-menu';
+import { GmailAppMenuItemView } from '../dom-driver/gmail/views/gmail-app-menu-item-view';
+
+// import GmailBackdrop from '../dom-driver/gmail/views/gmail-backdrop';
+// import InboxBackdrop from '../dom-driver/inbox/views/inbox-backdrop';
+// export type Backdrop = GmailBackdrop | InboxBackdrop;
+export type Backdrop = any;
+
+// import GmailThreadView from '../dom-driver/gmail/views/gmail-thread-view';
+// import InboxThreadView from '../dom-driver/inbox/views/inbox-thread-view';
+// export type ThreadViewDriver = GmailThreadView | InboxThreadView;
+export type ThreadViewDriver = any;
+
+// import { ThreadRowViewDriver } from './thread-row-view-driver';
+type ThreadRowViewDriver = any;
+
+// import { MoleViewDriver } from './mole-view-driver';
+type MoleViewDriver = any;
+
+// import { MessageViewDriver } from './message-view-driver';
+type MessageViewDriver = any;
+// import ContentPanelViewDriver from '../driver-common/sidebar/ContentPanelViewDriver';
+type ContentPanelViewDriver = any;
+
+// import GmailAttachmentCardView from '../dom-driver/gmail/views/gmail-attachment-card-view';
+// import InboxAttachmentCardView from '../dom-driver/inbox/views/inbox-attachment-card-view';
+// export type AttachmentCardViewDriver =
+//   | GmailAttachmentCardView
+//   | InboxAttachmentCardView;
+export type AttachmentCardViewDriver = any;
+
+export interface DrawerViewOptions {
+  el: HTMLElement;
+  title?: string;
+  chrome?: boolean;
+  composeView?: ComposeView;
+  closeWithCompose?: boolean;
+  matchSidebarContentPanelWidth?: boolean;
+}
+// import InboxDrawerView from '../dom-driver/inbox/views/inbox-drawer-view';
+// export type DrawerViewDriver = InboxDrawerView;
+export type DrawerViewDriver = any;
+
+// import { PiOpts } from '../platform-implementation';
+type PiOpts = any;
+
+// TODO fill in some of these any types
+export interface Driver {
+  onready: Promise<void>;
+  getLogger(): Logger;
+  getAppId(): string;
+  getOpts(): PiOpts;
+  getRouteViewDriverStream(): Kefir.Observable<RouteViewDriver, any>; // should be a property
+  getRowListViewDriverStream(): Kefir.Observable<any, any>;
+  openNewComposeViewDriver(): Promise<ComposeViewDriver>;
+  getNextComposeViewDriver(): Promise<ComposeViewDriver>;
+  getComposeViewDriverStream(): Kefir.Observable<ComposeViewDriver, any>;
+  openDraftByMessageID(messageID: string): Promise<void>;
+  getThreadViewDriverStream(): Kefir.Observable<ThreadViewDriver, any>;
+  getMessageViewDriverStream(): Kefir.Observable<MessageViewDriver, any>;
+  getAttachmentCardViewDriverStream(): Kefir.Observable<
+    AttachmentCardViewDriver,
+    any
+  >;
+  activateShortcut(
+    keyboardShortcutHandle: KeyboardShortcutHandle,
+    appName?: string,
+    appIconUrl?: string
+  ): void;
+  getPageCommunicator(): CommonPageCommunicator;
+  getGmailActionToken(): Promise<string>;
+  getUserEmailAddress(): string;
+  isConversationViewDisabled(): Promise<boolean>;
+  getUserLanguage(): string;
+  getUserContact(): Contact;
+  getAccountSwitcherContactList(): Contact[];
+  getThreadRowViewDriverStream(): Kefir.Observable<ThreadRowViewDriver, any>;
+  registerThreadButton(options: any): () => void;
+  addNavItem(appId: string, navItemDescriptor: any): any;
+  addSupportItem(
+    supportItemDescriptor: SupportItemDescriptor
+  ): GmailSupportItemView;
+  addAppMenuItem(
+    menuItemDescriptor: AppMenuItemDescriptor
+  ): Promise<GmailAppMenuItemView>;
+  getSentMailNativeNavItem(): Promise<any>;
+  createLink(a: any, b: any): any;
+  goto(routeID: string, params: any): Promise<void>;
+  addCustomRouteID(routeID: string): () => void;
+  addCustomListRouteID(routeID: string, handler: Function): () => void;
+  showCustomRouteView(el: HTMLElement): void;
+  setShowNativeNavMarker(isNative: boolean): any;
+  setShowNativeAddonSidebar(isNative: boolean): any;
+  registerSearchSuggestionsProvider(handler: Function): void;
+  registerSearchQueryRewriter(obj: any): void;
+  addToolbarButtonForApp(
+    buttonDescriptor: Kefir.Observable<any, any>
+  ): Promise<any>;
+  addGlobalSidebarContentPanel(
+    buttonDescriptor: Kefir.Observable<any, any>
+  ): Promise<ContentPanelViewDriver | null | undefined>;
+  getButterBarDriver(): ButterBarDriver;
+  setButterBar(butterBar: any): void;
+  isRunningInPageContext(): boolean;
+  showAppIdWarning(): void;
+  createModalViewDriver(options: any): any;
+  createMoleViewDriver(options: any): MoleViewDriver;
+  createTopMessageBarDriver(options: any): any;
+  createDrawerViewDriver(options: DrawerViewOptions): DrawerViewDriver;
+  createBackdrop(zIndex?: number, target?: HTMLElement): Backdrop;
+  getStopper(): Kefir.Observable<null, never>;
+  destroy(): void;
+
+  getSelectedThreadRowViewDrivers(): ReadonlyArray<ThreadRowViewDriver>;
+  registerThreadRowViewSelectionHandler(handler: () => any): () => void;
+
+  getLoadEventDetails(): any;
+}
+
+export interface ButterBarDriver {
+  getNoticeAvailableStream(): Kefir.Observable<any, any>;
+  getSharedMessageQueue(): any[];
+  setSharedMessageQueue(queue: any[]): void;
+  showMessage(rawOptions: any): ButterBarMessage;
+  hideGmailMessage(): void;
+}
+
+export interface ButterBarMessage {
+  destroy(): void;
+}