@inboxsdk/core 2.1.38 → 2.1.39

package/inboxsdk.js

@@ -890,7 +890,7 @@ function isNotNil(value) {
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- SDK_VERSION is injected by webpack
 ///@ts-ignore
-const BUILD_VERSION = "2.1.38-1712087227941-d4c8bfd8eba680c6";
+const BUILD_VERSION = "2.1.39-1712261377230-745de69ef3533e1a";
 if (false) {}
 
 /***/ }),
@@ -10629,7 +10629,7 @@ options.insert = htmlElement => {
               htmlElement.setAttribute('data-inboxsdk-version',
               // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- this is injected by webpack
               ///@ts-ignore
-              "2.1.38-1712087227941-d4c8bfd8eba680c6");
+              "2.1.39-1712261377230-745de69ef3533e1a");
               document.head.append(htmlElement);
             };
 options.domAPI = (styleDomAPI_default());
@@ -12852,6 +12852,14 @@ function _setupViewDriverWatcher(appId, stream, ViewClass, handlerRegistry, Conv
 
 
 
+/**
+ * Represents a visible message in the UI. There are properties to access data about the message itself as well as change the state of the UI. MessageViews have a view state as well as a loaded state. These 2 properties are orthogonal to each other.
+
+ * A messages' view state can be one of {@link MessageViewViewStates.EXPANDED}, {@link MessageViewViewStates.COLLAPSED} or {@link MessageViewViewStates.HIDDEN}. Gmail visually display messages in a thread in different ways depending on what they are trying to show a user. These values are described in the enum MessageViewViewStates. The load state of a message determines whether all of the data pertaining to a message has been loaded in the UI. In some case, not all the information (such as recipients or the body) may be loaded, typically when the the view state is COLLAPSED or HIDDEN.
+
+ * @note You should not depend on any relationship between the view state
+ * and load state. Instead, use the provided {MessageView#getViewState} and {MessageView#isLoaded} methods.
+ */
 class MessageView extends safe_event_emitter/* default */.Z {
   destroyed = false;
   #driver;
@@ -12931,6 +12939,10 @@ class MessageView extends safe_event_emitter/* default */.Z {
   isElementInQuotedArea(element) {
     return this.#messageViewImplementation.isElementInQuotedArea(element);
   }
+
+  /**
+   * Returns whether this message has been loaded yet. If the message has not been loaded, some of the data related methods on this object may return empty results. The message may be loaded once the user clicks on the message stub.
+   */
   isLoaded() {
     return this.#messageViewImplementation.isLoaded();
   }
@@ -12947,6 +12959,14 @@ class MessageView extends safe_event_emitter/* default */.Z {
     }
     return this.#linksInBody;
   }
+
+  /**
+   * Get the contact of the sender of this message.
+     * @returns {Contact} The contact of the sender of this message.
+    * @throws {Error} If the message has not been loaded yet.
+    *
+    * @note If you're using this method on an array of {MessageView}s returned by {@link ThreadRowView#getMessageViewsAll}, make sure to check {@link MessageView#isLoaded} before calling this method.
+   */
   getSender() {
     return this.#messageViewImplementation.getSender();
   }
@@ -15496,7 +15516,7 @@ options.insert = htmlElement => {
               htmlElement.setAttribute('data-inboxsdk-version',
               // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- this is injected by webpack
               ///@ts-ignore
-              "2.1.38-1712087227941-d4c8bfd8eba680c6");
+              "2.1.39-1712261377230-745de69ef3533e1a");
               document.head.append(htmlElement);
             };
 options.domAPI = (styleDomAPI_default());
@@ -19582,7 +19602,7 @@ mole_view_module_options.insert = htmlElement => {
               htmlElement.setAttribute('data-inboxsdk-version',
               // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- this is injected by webpack
               ///@ts-ignore
-              "2.1.38-1712087227941-d4c8bfd8eba680c6");
+              "2.1.39-1712261377230-745de69ef3533e1a");
               document.head.append(htmlElement);
             };
 mole_view_module_options.domAPI = (styleDomAPI_default());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inboxsdk/core",
-  "version": "2.1.38",
+  "version": "2.1.39",
   "description": "Library for building browser extensions for Gmail",
   "main": "inboxsdk.js",
   "author": "Streak",

package/src/inboxsdk.d.ts

@@ -15,10 +15,9 @@ import type GmailRowListView from './platform-implementation-js/dom-driver/gmail
 import type { AppLogger } from './platform-implementation-js/lib/logger';
 import type ThreadRowView from './platform-implementation-js/views/thread-row-view';
 import TypedEventEmitter from 'typed-emitter';
-import { MessageViewEvent } from './platform-implementation-js/views/conversations/message-view';
+import { default as MessageView } from './platform-implementation-js/views/conversations/message-view';
 import type { ThreadViewEvents } from './platform-implementation-js/views/conversations/thread-view';
 import type { ComposeViewEvent } from './platform-implementation-js/views/compose-view';
-import type AttachmentCardView from './platform-implementation-js/views/conversations/attachment-card-view';
 import type TopMessageBarView from './platform-implementation-js/widgets/top-message-bar-view';
 import type { IMoleView as MoleView } from './platform-implementation-js/widgets/mole-view';
 export * from './platform-implementation-js/dom-driver/gmail/views/gmail-nav-item-view';
@@ -586,56 +585,13 @@ export type AttachmentIcon = TypedEmitter<{
   tooltipShown: () => void;
 }>;
 
-export type MessageViewToolbarSectionNames = 'MORE';
-
-export interface MessageViewToolbarButtonDescriptor {
-  section: MessageViewToolbarSectionNames;
-  title: string;
-  iconUrl?: string;
-  iconClass?: string;
-  onClick: (e: MouseEvent) => void;
-  orderHint?: number;
-}
-
 export type { MessageViewViewStates } from './platform-implementation-js/namespaces/conversations';
 
-/**
- * Represents a visible message in the UI. There are properties to access data about the message itself as well as change the state of the UI. MessageViews have a view state as well as a loaded state. These 2 properties are orthogonal to each other.
-
- * A messages' view state can be one of {@link MessageViewViewStates.EXPANDED}, {@link MessageViewViewStates.COLLAPSED} or {@link MessageViewViewStates.HIDDEN}. Gmail visually display messages in a thread in different ways depending on what they are trying to show a user. These values are described in the enum MessageViewViewStates. The load state of a message determines whether all of the data pertaining to a message has been loaded in the UI. In some case, not all the information (such as recipients or the body) may be loaded, typically when the the view state is COLLAPSED or HIDDEN.
-
- * @note You should not depend on any relationship between the view state
- * and load state. Instead, use the provided {MessageView#getViewState} and {MessageView#isLoaded} methods.
- */
-export interface MessageView extends TypedEventEmitter<MessageViewEvent> {
-  addAttachmentIcon(
-    opts:
-      | MessageAttachmentIconDescriptor
-      | Kefir.Stream<MessageAttachmentIconDescriptor, never>,
-  ): AttachmentIcon;
-  addToolbarButton(opts: MessageViewToolbarButtonDescriptor): void;
-  getBodyElement(): HTMLElement;
-  isElementInQuotedArea(element: HTMLElement): boolean;
-  /**
-   * Returns whether this message has been loaded yet. If the message has not been loaded, some of the data related methods on this object may return empty results. The message may be loaded once the user clicks on the message stub.
-   */
-  isLoaded(): boolean;
-  getFileAttachmentCardViews(): AttachmentCardView[];
-  /**
-   * Get the contact of the sender of this message.
-
-    * @returns {Contact} The contact of the sender of this message.
-    * @throws {Error} If the message has not been loaded yet.
-    *
-    * @note If you're using this method on an array of {MessageView}s returned by {@link ThreadRowView#getMessageViewsAll}, make sure to check {@link MessageView#isLoaded} before calling this method.
-   */
-  getSender(): Contact;
-  getRecipients(): Array<Contact>;
-  getRecipientsFull(): Promise<Array<Contact>>;
-  getLinksInBody(): Array<MessageViewLinkDescriptor>;
-  getThreadView(): ThreadView;
-  getMessageIDAsync(): Promise<string>;
-}
+export {
+  default as MessageView,
+  MessageViewToolbarButtonDescriptor,
+  MessageViewToolbarSectionNames,
+} from './platform-implementation-js/views/conversations/message-view';
 
 export interface Contact {
   name: string;

package/src/platform-implementation-js/views/conversations/message-view.d.ts

@@ -1,11 +1,22 @@
 import type Membrane from '../../lib/Membrane';
 import type AttachmentCardView from './attachment-card-view';
 import type { Driver } from '../../driver-interfaces/driver';
-import type { Contact, MessageView as IMessageView } from '../../../inboxsdk';
+import type { Contact, MessageAttachmentIconDescriptor } from '../../../inboxsdk';
 import type { MessageViewDriverEventByName } from '../../dom-driver/gmail/views/gmail-message-view';
 import type TypedEventEmitter from 'typed-emitter';
 import type MessageViewDriver from '../../dom-driver/gmail/views/gmail-message-view';
+import ThreadView from './thread-view';
+import { Descriptor } from '../../../types/descriptor';
 export type VIEW_STATE = 'HIDDEN' | 'COLLAPSED' | 'EXPANDED';
+export type MessageViewToolbarSectionNames = 'MORE';
+export interface MessageViewToolbarButtonDescriptor {
+    section: MessageViewToolbarSectionNames;
+    title: string;
+    iconUrl?: string;
+    iconClass?: string;
+    onClick: (e: MouseEvent) => void;
+    orderHint?: number;
+}
 interface MessageViewLinkDescriptor {
     text: string;
     html: string;
@@ -26,29 +37,48 @@ export type MessageViewEvent = {
     }): void;
 };
 declare const MessageView_base: new () => TypedEventEmitter<MessageViewEvent>;
-export default class MessageView extends MessageView_base implements IMessageView {
+/**
+ * Represents a visible message in the UI. There are properties to access data about the message itself as well as change the state of the UI. MessageViews have a view state as well as a loaded state. These 2 properties are orthogonal to each other.
+
+ * A messages' view state can be one of {@link MessageViewViewStates.EXPANDED}, {@link MessageViewViewStates.COLLAPSED} or {@link MessageViewViewStates.HIDDEN}. Gmail visually display messages in a thread in different ways depending on what they are trying to show a user. These values are described in the enum MessageViewViewStates. The load state of a message determines whether all of the data pertaining to a message has been loaded in the UI. In some case, not all the information (such as recipients or the body) may be loaded, typically when the the view state is COLLAPSED or HIDDEN.
+
+ * @note You should not depend on any relationship between the view state
+ * and load state. Instead, use the provided {MessageView#getViewState} and {MessageView#isLoaded} methods.
+ */
+export default class MessageView extends MessageView_base {
     #private;
     destroyed: boolean;
     constructor(messageViewImplementation: MessageViewDriver, membrane: Membrane, driver: Driver);
     addAttachmentCardView(cardOptions: Record<string, any>): AttachmentCardView;
     addAttachmentCardViewNoPreview(cardOptions: Record<string, any>): AttachmentCardView;
     addAttachmentsToolbarButton(buttonOptions: Record<string, any>): void;
-    addToolbarButton(buttonOptions: Parameters<IMessageView['addToolbarButton']>[0]): void;
+    addToolbarButton(buttonOptions: MessageViewToolbarButtonDescriptor): void;
     getBodyElement(): HTMLElement;
     getMessageID(): string;
     getMessageIDAsync(): Promise<string>;
     getFileAttachmentCardViews(): Array<AttachmentCardView>;
     getAttachmentCardViews(): Array<AttachmentCardView>;
     isElementInQuotedArea(element: HTMLElement): boolean;
+    /**
+     * Returns whether this message has been loaded yet. If the message has not been loaded, some of the data related methods on this object may return empty results. The message may be loaded once the user clicks on the message stub.
+     */
     isLoaded(): boolean;
     getLinksInBody(): Array<MessageViewLinkDescriptor>;
+    /**
+     * Get the contact of the sender of this message.
+  
+      * @returns {Contact} The contact of the sender of this message.
+      * @throws {Error} If the message has not been loaded yet.
+      *
+      * @note If you're using this method on an array of {MessageView}s returned by {@link ThreadRowView#getMessageViewsAll}, make sure to check {@link MessageView#isLoaded} before calling this method.
+     */
     getSender(): Contact;
     getRecipients(): Array<Contact>;
     getRecipientEmailAddresses(): Array<string>;
     getRecipientsFull(): Promise<Array<Contact>>;
-    getThreadView(): ReturnType<IMessageView['getThreadView']>;
+    getThreadView(): ThreadView;
     getDateString(): string;
-    addAttachmentIcon(iconDescriptor: Parameters<IMessageView['addAttachmentIcon']>[0]): import("../../dom-driver/gmail/views/gmail-message-view/attachment-icon").default;
+    addAttachmentIcon(iconDescriptor: Descriptor<MessageAttachmentIconDescriptor, never>): import("../../dom-driver/gmail/views/gmail-message-view/attachment-icon").default;
     getViewState(): VIEW_STATE;
     hasOpenReply(): boolean;
 }

package/src/platform-implementation-js/views/conversations/message-view.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"message-view.d.ts","sourceRoot":"","sources":["../../../../../../src/platform-implementation-js/views/conversations/message-view.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,QAAQ,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,kBAAkB,MAAM,wBAAwB,CAAC;AAK7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAE9E,OAAO,KAAK,EAEV,4BAA4B,EAC7B,MAAM,iDAAiD,CAAC;AACzD,OAAO,KAAK,iBAAiB,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,iBAAiB,MAAM,iDAAiD,CAAC;AAErF,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;AAE7D,UAAU,yBAAyB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CACV,IAAI,EAAE,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,GACpE,IAAI,CAAC;IACR,OAAO,IAAI,IAAI,CAAC;IAChB,IAAI,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,WAAW,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/C,eAAe,CAAC,IAAI,EAAE;QACpB,YAAY,EAAE,UAAU,CAAC;QACzB,YAAY,EAAE,UAAU,CAAC;QACzB,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,IAAI,CAAC;CACV,CAAC;0CAGmC,kBAAkB,gBAAgB,CAAC;AADxE,MAAM,CAAC,OAAO,OAAO,WACnB,SAAQ,gBACR,YAAW,YAAY;;IAEvB,SAAS,EAAE,OAAO,CAAS;gBAQzB,yBAAyB,EAAE,iBAAiB,EAC5C,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM;IAWhB,qBAAqB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB;IAgB3E,8BAA8B,CAC5B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,kBAAkB;IAIrB,2BAA2B,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAe9D,gBAAgB,CACd,aAAa,EAAE,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAkBhE,cAAc,IAAI,WAAW;IAI7B,YAAY,IAAI,MAAM;IAUtB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAOpC,0BAA0B,IAAI,KAAK,CAAC,kBAAkB,CAAC;IAUvD,sBAAsB,IAAI,KAAK,CAAC,kBAAkB,CAAC;IAenD,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO;IAIpD,QAAQ,IAAI,OAAO;IAInB,cAAc,IAAI,KAAK,CAAC,yBAAyB,CAAC;IAiBlD,SAAS,IAAI,OAAO;IAIpB,aAAa,IAAI,KAAK,CAAC,OAAO,CAAC;IAa/B,0BAA0B,IAAI,KAAK,CAAC,MAAM,CAAC;IAI3C,iBAAiB,IAAI,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAI5C,aAAa,IAAI,UAAU,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IAM1D,aAAa,IAAI,MAAM;IAIvB,iBAAiB,CACf,cAAc,EAAE,UAAU,CAAC,YAAY,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;IAKlE,YAAY,IAAI,UAAU;IAM1B,YAAY,IAAI,OAAO;CA2DxB"}
+{"version":3,"file":"message-view.d.ts","sourceRoot":"","sources":["../../../../../../src/platform-implementation-js/views/conversations/message-view.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,QAAQ,MAAM,oBAAoB,CAAC;AAC/C,OAAO,KAAK,kBAAkB,MAAM,wBAAwB,CAAC;AAK7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EACV,OAAO,EACP,+BAA+B,EAChC,MAAM,mBAAmB,CAAC;AAE3B,OAAO,KAAK,EAEV,4BAA4B,EAC7B,MAAM,iDAAiD,CAAC;AACzD,OAAO,KAAK,iBAAiB,MAAM,eAAe,CAAC;AACnD,OAAO,KAAK,iBAAiB,MAAM,iDAAiD,CAAC;AACrF,OAAO,UAAU,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAC;AAE7D,MAAM,MAAM,8BAA8B,GAAG,MAAM,CAAC;AAEpD,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,8BAA8B,CAAC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,UAAU,yBAAyB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,YAAY,CACV,IAAI,EAAE,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,EAAE,WAAW,CAAC,GACpE,IAAI,CAAC;IACR,OAAO,IAAI,IAAI,CAAC;IAChB,IAAI,CAAC,IAAI,EAAE;QAAE,WAAW,EAAE,WAAW,CAAA;KAAE,GAAG,IAAI,CAAC;IAC/C,eAAe,CAAC,IAAI,EAAE;QACpB,YAAY,EAAE,UAAU,CAAC;QACzB,YAAY,EAAE,UAAU,CAAC;QACzB,WAAW,EAAE,WAAW,CAAC;KAC1B,GAAG,IAAI,CAAC;CACV,CAAC;0CAUkE,kBAAkB,gBAAgB,CAAC;AARvG;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,gBAA+D;;IACtG,SAAS,EAAE,OAAO,CAAS;gBAQzB,yBAAyB,EAAE,iBAAiB,EAC5C,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM;IAWhB,qBAAqB,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB;IAgB3E,8BAA8B,CAC5B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC/B,kBAAkB;IAIrB,2BAA2B,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAe9D,gBAAgB,CAAC,aAAa,EAAE,kCAAkC;IAiBlE,cAAc,IAAI,WAAW;IAI7B,YAAY,IAAI,MAAM;IAUtB,iBAAiB,IAAI,OAAO,CAAC,MAAM,CAAC;IAOpC,0BAA0B,IAAI,KAAK,CAAC,kBAAkB,CAAC;IAUvD,sBAAsB,IAAI,KAAK,CAAC,kBAAkB,CAAC;IAenD,qBAAqB,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO;IAIpD;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB,cAAc,IAAI,KAAK,CAAC,yBAAyB,CAAC;IAiBlD;;;;;;;OAOG;IACH,SAAS,IAAI,OAAO;IAIpB,aAAa,IAAI,KAAK,CAAC,OAAO,CAAC;IAa/B,0BAA0B,IAAI,KAAK,CAAC,MAAM,CAAC;IAI3C,iBAAiB,IAAI,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAI5C,aAAa,IAAI,UAAU;IAM3B,aAAa,IAAI,MAAM;IAIvB,iBAAiB,CACf,cAAc,EAAE,UAAU,CAAC,+BAA+B,EAAE,KAAK,CAAC;IAKpE,YAAY,IAAI,UAAU;IAM1B,YAAY,IAAI,OAAO;CA2DxB"}