@trycourier/courier-ui-inbox 1.0.5-beta → 1.0.7-beta

package/dist/components/courier-inbox-header-title.d.ts

@@ -1,7 +1,8 @@
 import { CourierInboxMenuOption } from './courier-inbox-option-menu';
 import { CourierInboxFeedType } from '../types/feed-type';
 import { CourierInboxThemeManager } from '../types/courier-inbox-theme-manager';
-export declare class CourierInboxHeaderTitle extends HTMLElement {
+import { BaseElement } from '@trycourier/courier-ui-core';
+export declare class CourierInboxHeaderTitle extends BaseElement {
     private _themeSubscription;
     private _option;
     private _feedType?;

package/dist/components/courier-inbox-list-item-menu.d.ts

@@ -1,16 +1,17 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxIcon, CourierInboxTheme } from '../types/courier-inbox-theme';
-export type CourierListItemActionMenuOption = {
+export type CourierInboxListItemActionMenuOption = {
     id: string;
     icon: CourierInboxIcon;
     onClick: () => void;
 };
-export declare class CourierListItemActionMenu extends HTMLElement {
+export declare class CourierInboxListItemMenu extends BaseElement {
     private _theme;
     private _options;
     private _style;
     constructor(theme: CourierInboxTheme);
     private getStyles;
-    setOptions(options: CourierListItemActionMenuOption[]): void;
+    setOptions(options: CourierInboxListItemActionMenuOption[]): void;
     private renderMenu;
     show(): void;
     hide(): void;

package/dist/components/courier-inbox-list-item.d.ts

@@ -1,7 +1,8 @@
 import { InboxAction, InboxMessage } from '@trycourier/courier-js';
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxFeedType } from '../types/feed-type';
 import { CourierInboxTheme } from '../types/courier-inbox-theme';
-export declare class CourierListItem extends HTMLElement {
+export declare class CourierListItem extends BaseElement {
     private _theme;
     private _message;
     private _feedType;

package/dist/components/courier-inbox-list.d.ts

@@ -1,9 +1,10 @@
 import { InboxAction, InboxMessage } from '@trycourier/courier-js';
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { InboxDataSet } from '../types/inbox-data-set';
 import { CourierInboxFeedType } from '../types/feed-type';
 import { CourierInboxStateErrorFactoryProps, CourierInboxStateEmptyFactoryProps, CourierInboxStateLoadingFactoryProps, CourierInboxListItemFactoryProps, CourierInboxPaginationItemFactoryProps } from '../types/factories';
 import { CourierInboxThemeManager } from '../types/courier-inbox-theme-manager';
-export declare class CourierInboxList extends HTMLElement {
+export declare class CourierInboxList extends BaseElement {
     private _themeSubscription;
     private _messages;
     private _feedType;

package/dist/components/courier-inbox-option-menu-item.d.ts

@@ -1,6 +1,7 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxThemeManager } from '../types/courier-inbox-theme-manager';
 import { CourierInboxMenuOption } from './courier-inbox-option-menu';
-export declare class CourierInboxOptionMenuItem extends HTMLElement {
+export declare class CourierInboxOptionMenuItem extends BaseElement {
     private _option;
     private _isSelected?;
     private _content;

package/dist/components/courier-inbox-option-menu.d.ts

@@ -1,3 +1,4 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxThemeManager } from '../types/courier-inbox-theme-manager';
 import { CourierInboxHeaderMenuItemId } from './courier-inbox-header';
 import { CourierInboxIcon } from '../types/courier-inbox-theme';
@@ -9,7 +10,7 @@ export type CourierInboxMenuOption = {
     selectionIcon?: CourierInboxIcon | null;
     onClick: (option: CourierInboxMenuOption) => void;
 };
-export declare class CourierInboxOptionMenu extends HTMLElement {
+export declare class CourierInboxOptionMenu extends BaseElement {
     private _themeSubscription;
     private _type;
     private _selectedIndex;

package/dist/components/courier-inbox-pagination-list-item.d.ts

@@ -1,5 +1,6 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxTheme } from '../types/courier-inbox-theme';
-export declare class CourierInboxPaginationListItem extends HTMLElement {
+export declare class CourierInboxPaginationListItem extends BaseElement {
     private skeletonLoadingList?;
     private observer;
     private customItem?;

package/dist/components/{courier-inbox-menu.d.ts → courier-inbox-popup-menu.d.ts}

@@ -2,8 +2,9 @@ import { CourierInboxDatastoreEvents } from '../datastore/datatore-events';
 import { CourierInboxHeaderFactoryProps, CourierInboxListItemActionFactoryProps, CourierInboxListItemFactoryProps, CourierInboxMenuButtonFactoryProps, CourierInboxPaginationItemFactoryProps, CourierInboxStateEmptyFactoryProps, CourierInboxStateErrorFactoryProps, CourierInboxStateLoadingFactoryProps } from '../types/factories';
 import { CourierInboxFeedType } from '../types/feed-type';
 import { CourierInboxTheme } from '../types/courier-inbox-theme';
+import { BaseElement } from '@trycourier/courier-ui-core';
 export type CourierInboxPopupAlignment = 'top-right' | 'top-left' | 'top-center' | 'bottom-right' | 'bottom-left' | 'bottom-center' | 'center-right' | 'center-left' | 'center-center';
-export declare class CourierInboxMenu extends HTMLElement implements CourierInboxDatastoreEvents {
+export declare class CourierInboxPopupMenu extends BaseElement implements CourierInboxDatastoreEvents {
     private _width;
     private _height;
     private _popupAlignment;

package/dist/components/courier-inbox-skeleton-list-item.d.ts

@@ -1,5 +1,6 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxTheme } from '../types/courier-inbox-theme';
-export declare class CourierInboxSkeletonListItem extends HTMLElement {
+export declare class CourierInboxSkeletonListItem extends BaseElement {
     private _shadow;
     constructor(theme: CourierInboxTheme, opacity: number);
     private getStyles;

package/dist/components/courier-inbox.d.ts

@@ -1,8 +1,9 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxFeedType } from '../types/feed-type';
 import { CourierInboxHeaderFactoryProps, CourierInboxListItemActionFactoryProps, CourierInboxListItemFactoryProps, CourierInboxPaginationItemFactoryProps, CourierInboxStateEmptyFactoryProps, CourierInboxStateErrorFactoryProps, CourierInboxStateLoadingFactoryProps } from '../types/factories';
 import { CourierInboxTheme } from '../types/courier-inbox-theme';
 import { CourierInboxThemeManager } from '../types/courier-inbox-theme-manager';
-export declare class CourierInbox extends HTMLElement {
+export declare class CourierInbox extends BaseElement {
     private _currentFeed;
     private _themeManager;
     get theme(): CourierInboxTheme;

package/dist/components/courier-unread-count-badge.d.ts

@@ -1,6 +1,7 @@
+import { BaseElement } from '@trycourier/courier-ui-core';
 import { CourierInboxThemeManager } from '../types/courier-inbox-theme-manager';
 export type CourierUnreadCountLocation = 'button' | 'header';
-export declare class CourierUnreadCountBadge extends HTMLElement {
+export declare class CourierUnreadCountBadge extends BaseElement {
     private _themeSubscription;
     private _location;
     private _count;

package/dist/datastore/__tests__/datastore.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/datastore/datastore.d.ts

@@ -22,12 +22,30 @@ export declare class CourierInboxDatastore {
         feedType: CourierInboxFeedType;
         canUseCache: boolean;
     }): Promise<void>;
+    /** Listen for inbox and archive dataset updates. */
+    listenForUpdates(): Promise<void>;
+    /** Fetch either/both datasets if they aren't already loaded. */
+    private ensureDataSetsLoaded;
     private connectSocket;
+    /**
+     * Get a message by messageId from the inbox or archive data set
+     * @param props - The message ID
+     * @returns The message or undefined if it is not found
+     */
     private getMessage;
+    /**
+     * Fetch the next page of messages
+     * @param props - The feed type
+     * @returns The next page of messages or null if there is no next page
+     */
     fetchNextPageOfMessages(props: {
         feedType: CourierInboxFeedType;
     }): Promise<InboxDataSet | null>;
-    private applyLocalMessageChange;
+    /**
+     * Check if the datastore is loaded and ready to perform mutations
+     * @returns True if the datastore is loaded and ready to perform mutations, false otherwise
+     */
+    private canMutate;
     readMessage({ message, canCallApi }: {
         message: InboxMessage;
         canCallApi?: boolean;
@@ -48,15 +66,52 @@ export declare class CourierInboxDatastore {
         message: InboxMessage;
         canCallApi?: boolean;
     }): Promise<void>;
+    unarchiveMessage({ message, canCallApi }: {
+        message: InboxMessage;
+        canCallApi?: boolean;
+    }): Promise<void>;
     archiveReadMessages({ canCallApi }?: {
         canCallApi?: boolean;
     }): Promise<void>;
+    archiveAllMessages({ canCallApi }?: {
+        canCallApi?: boolean;
+    }): Promise<void>;
     readAllMessages({ canCallApi }?: {
         canCallApi?: boolean;
     }): Promise<void>;
+    /**
+     * Find the insert index for a new message in a data set
+     * @param newMessage - The new message to insert
+     * @param dataSet - The data set to insert the message into
+     * @returns The index to insert the message at
+     */
     private findInsertIndex;
     private addPage;
     private addMessage;
     private removeMessage;
+    /**
+     * Apply a message snapshot to the data store
+     * @param snapshot - The message snapshot to apply
+     */
+    private applyMessageSnapshot;
+    private applyDatastoreSnapshot;
+    /**
+     * Update a message in the data store
+     * @param message - The message to update
+     * @param index - The index of the message
+     * @param feedType - The feed type of the message
+     */
     private updateMessage;
+    /**
+     * Copy an inbox data set
+     * @param dataSet - The inbox data set to copy
+     * @returns A copy of the inbox data set
+     */
+    private getDatastoreSnapshot;
+    /**
+     * Copy an inbox message with its archive and inbox indices
+     * @param message - The inbox message to copy
+     * @returns A copy of the inbox message with its archive and inbox indices
+     */
+    private getMessageSnapshot;
 }

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export * from './components/courier-inbox';
 export * from './components/courier-inbox-header';
 export * from './components/courier-inbox-list-item';
-export * from './components/courier-inbox-menu';
+export * from './components/courier-inbox-popup-menu';
 export * from './utils/extensions';
 export * from './types/factories';
 export * from './types/feed-type';