feat: add scroll method to messaging store

README.md

@@ -73,16 +73,17 @@ The messaging view can be included from path: `./dist/messaging.html`
 The messaging view exposes a programmatic API that lets applications manipulate its internal store:
 
 - Check if a message exists: `MessagingStore.exists(messageId<string>)<boolean>`
-- Resolve a message from the store: `MessagingStore.resolve(messageId<string>)<object>`
+- Resolve a message from the store: `MessagingStore.resolve(messageId<string>)<null | object>`
 - Restore one or multiple past messages in the store (ie. prepend): `MessagingStore.restore(...messages<object>)<boolean>`
 - Insert one or multiple messages in the store (ie. append): `MessagingStore.insert(...messages<object>)<boolean>`
 - Update a message in the store: `MessagingStore.update(messageId<string>, messageDiff<object>)<boolean>`
 - Pull out a message from the store: `MessagingStore.retract(messageId<string>)<boolean>`
 - Flush all content from the store: `MessagingStore.flush()<boolean>`
 - Highlight a message in the store: `MessagingStore.highlight(messageId<string>)<boolean>`
 - Interact with a message action: `MessagingStore.interact(messageId<string>, action<string>, isActive<boolean>)<boolean>`
+- Scroll to a message: `MessagingStore.scroll(messageId<string>)<boolean>`
 - Toggle `backwards` or `forwards` loader in the store: `MessagingStore.loader(type<string>, isVisible<boolean>)<boolean>`
-- Identify a JID with its `name` and `avatar`: `MessagingStore.identify(jid<string>, identity<object>)<boolean>`
+- Identify a JID with its `name` and `avatar`: `MessagingStore.identify(jid<string>, identity<null | object>)<boolean>`
 
 All inserted message objects are required to hold the following keys: `id`, `type`, `date`, `content` and `from`. When updating an existing message, only modified keys need to be passed.
 

src/messaging/stores/feed.js

@@ -425,6 +425,23 @@ function FeedStore() {
       return false;
     },
 
+    /**
+     * Scrolls to a message
+     * @public
+     * @param  {string}  messageId
+     * @return {boolean} Message scroll status
+     */
+    scroll(messageId) {
+      // Scroll to existing message? (immediate and forced)
+      if (this._resolveEntry(messageId) !== null) {
+        MessageHelper.scheduleScrollToMessage(messageId, true, true);
+
+        return true;
+      }
+
+      return false;
+    },
+
     /**
      * Toggles the visibility of a loader
      * @public

types/messaging.ts

@@ -99,6 +99,7 @@ export declare interface MessagingStore {
   flush: () => boolean;
   highlight: (messageId: null | string) => boolean;
   interact: (messageId: string, action: string, isActive: boolean) => boolean;
+  scroll: (messageId: string) => boolean;
   loader: (type: string, isVisible: null | boolean) => boolean;
   identify: (
     jid: string,