@cloudflare/realtimekit-ui 1.1.0-staging.3 → 1.1.0-staging.5

package/dist/collection/components/rtk-paginated-list/rtk-paginated-list.js

@@ -1,3 +1,31 @@
+/**
+ * HOW INFINITE SCROLL WORKS:
+ *
+ * We use intersectionObserver to scroll up.
+ * We use scrollEnd listener to scroll down.
+ *
+ * Why?
+ * intersectionObserver doesn't work reliably for 2 way scrolling but has great ux,
+ * so we use it to smoothly scroll up.
+ *
+ * We have empty divs at the top and bottom ($topRef, $bottomRef)
+ * which act as triggers to tell that we have reached the top or end of our messages and need to fetch new messages,
+ *
+ * When scrolling up, we can't remove pages as intersectionObserver relies on
+ * the index of dom elements to work properly.
+ * So instead, we fetch older messages and push them to the end of the 2d array
+ * if length exceeds pagesAllowed, we free up the pages and keep the first empty index in memory (firstEmptyIndex).
+ *
+ * For scrolling down, when scroll ends we see if the bottomRef is in view.
+ * If yes, we fetch the new page and insert it at the firstEmptyIndex.
+ * We update timestamps & firstEmptyIndex, then we rerender.
+ *
+ * If we have exceeded our page allowance we delete old pages.
+ *
+ * In this case deleting pages is okay as we are not relying on the index of dom elements to detect page end.
+ *
+ * This also simplifies the code because when a user scrolls up we do not need to manage a lastEmptyIndex.
+ */
 var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
     var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
     if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
@@ -9,277 +37,262 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { Host, h, writeTask } from "@stencil/core";
-import { debounce } from "lodash-es";
 import { defaultIconPack } from "../../lib/icons";
 import { useLanguage } from "../../lib/lang";
 import { SyncWithStore } from "../../utils/sync-with-store";
-import { smoothScrollToBottom } from "../../utils/scroll";
+import { debounce } from "lodash-es";
 export class RtkPaginatedList {
     constructor() {
+        /**
+         * when scrolling up, we can't remove pages as intersectionObserver relies on
+         * the index of dom elements to stay stable.
+         * So, instead we free up the pages and keep the last empty index in memory.
+         */
+        this.firstEmptyIndex = -1;
+        this.maxTS = 0;
+        // the length of pages will always be pageSize + 2
+        this.pages = [];
+        /** label to show when empty */
+        this.emptyListLabel = null;
+        this.rerenderBoolean = false;
+        this.showEmptyListLabel = false;
         /** Icon pack */
         this.iconPack = defaultIconPack;
         /** Language */
         this.t = useLanguage();
-        /** label to show when empty */
-        this.emptyListLabel = null;
         this.isLoading = false;
         this.isLoadingTop = false;
         this.isLoadingBottom = false;
-        this.hasMoreDataAtTop = false;
-        this.rerenderBoolean = false;
         /**
-         * This gets disabled when the user scrolls up and the bottom node
-         * is not visible anymore.
-         */
-        this.shouldRenderNewNodes = true;
-        /**
-         * This gets disabled when the user scrolls up and the bottom node
-         * is not visible anymore.
-         */
-        this.hasNewNodesToRender = false;
-        this.showEmptyListLabel = false;
-        /**
-         * This is a private variable not a state
-         * since we want to debounce rerenders
-         *
-         * A list of pages where each page contains a number of Nodes
-         * [
-         *  [Node 1, Node 2, Node 3.... Node N],
-         *  [Node 1, Node 2, Node 3.... Node N],
-         * ]
-         */
-        this.pagesToRender = [[]];
-        this.currentTime = () => {
-            return new Date().getTime();
-        };
+         * Even when auto scroll is enabled, we only want to scroll if a new realtime message has arrived.
+         * This variable tells us if we should respect auto scroll after a new page has been loaded.
+         * It is also used by the scroll to bottom button.
+         *  */
+        this.shouldScrollToBottom = false;
+        /** UI Indicator for the "scroll to bottom" button.
+         * Toggles on when a new node is added and autoscroll is disabled.
+         * Toggles off when all nodes are loaded */
+        this.showNewMessagesCTR = false;
         this.observe = (el) => {
             if (!el)
                 return;
             this.intersectionObserver.observe(el);
         };
+        this.isAtBottom = () => {
+            const rect = this.$bottomRef.getBoundingClientRect();
+            return rect.top >= 0 && rect.bottom <= window.innerHeight;
+        };
     }
     /**
-     * On a new node created
+     * Adds a new node to the beginning of the paginated list
+     * @param {DataNode} node - The data node to add to the beginning of the list
      */
     async onNewNode(node) {
-        if (!this.shouldRenderNewNodes) {
-            this.hasNewNodesToRender = true;
-            return;
+        // Always update the maxTS. New messages will load on scroll till the end cursor (newTS) reaches this value.
+        this.maxTS = Math.max(this.maxTS, node.timeMs);
+        // if we are at the bottom of the page
+        if (this.firstEmptyIndex === -1) {
+            // append messages to the page if page has not reached full capacity
+            if (this.pages[0].length < this.pageSize) {
+                this.pages[0].unshift(node);
+                this.newTS = node.timeMs;
+                this.rerender();
+            }
+            else {
+                // if page is at full capacity, load next page
+                this.loadNextPage();
+            }
         }
-        this.addNodeToRender(node, false);
-        this.rerender();
-    }
-    /**
-     * On node deleted
-     */
-    async onNodeDelete(key) {
-        const oldLength = this.pagesToRender.flat().length;
-        this.pagesToRender = this.pagesToRender.map((page) => page.filter((item) => item.id !== key));
-        if (oldLength !== this.pagesToRender.flat().length) {
-            this.rerender();
+        // If autoscroll is enabled, this method will scroll to the bottom
+        if (this.autoScroll) {
+            this.shouldScrollToBottom = true;
+            this.scrollToBottom();
         }
+        else {
+            this.showNewMessagesCTR = true;
+        }
+    }
+    // this method is called recursively based on shouldScrollToBottom (see scrollEnd listener)
+    scrollToBottom() {
+        this.$bottomRef.scrollIntoView({ behavior: 'smooth' });
     }
     /**
-     * On node updated
-     */
-    async onNodeUpdate(key, newItem) {
-        let shouldRerender = false;
-        this.pagesToRender = this.pagesToRender.map((page) => page.map((item) => {
-            if (item.id === key) {
-                shouldRerender = true;
-                return newItem;
+     * Deletes a node anywhere from the list
+     * @param {string} id - The id of the node to delete
+     * */
+    async onNodeDelete(id) {
+        // Iterate only over pages that have content (not empty)
+        for (let i = this.pages.length - 1; i > this.firstEmptyIndex; i--) {
+            const index = this.pages[i].findIndex((node) => node.id === id);
+            // message in view
+            if (index !== -1) {
+                // delete message
+                this.pages[i].splice(index, 1);
+                if (i === this.firstEmptyIndex + 1) {
+                    //  if newest page is empty, update first empty index
+                    if (this.pages[i].length === 0)
+                        this.firstEmptyIndex++;
+                    // update timestamp, first empty index could be -1, so we need to cap it at 0
+                    this.newTS = this.pages[Math.max(this.firstEmptyIndex, 0)][0].timeMs;
+                }
+                else if (i === this.firstEmptyIndex + this.pagesAllowed) {
+                    //  if oldest page is empty, remove it
+                    if (this.pages[i].length === 0)
+                        this.pages.pop();
+                    // update timestamp
+                    const lastPage = this.pages[this.firstEmptyIndex + this.pagesAllowed];
+                    this.oldTS = lastPage[lastPage.length - 1].timeMs;
+                }
+                this.rerender();
             }
-            return item;
-        }));
-        if (shouldRerender)
-            this.rerender();
-    }
-    onItemChanged(newItemId, oldItemId) {
-        if (newItemId !== oldItemId) {
-            this.pagesToRender = [[]];
-            this.loadFirstPage().then(() => this.rerender());
         }
     }
+    /**
+     * Updates a new node anywhere in the list
+     * @param {string} _id - The id of the node to update
+     * @param {DataNode} _node - The updated data node
+     * */
+    async onNodeUpdate(_id, _node) { }
+    rerender() {
+        this.rerenderBoolean = !this.rerenderBoolean;
+    }
     connectedCallback() {
         this.rerender = debounce(this.rerender.bind(this), 50, { maxWait: 200 });
-        this.autoScroll = true;
         this.intersectionObserver = new IntersectionObserver((entries) => {
-            writeTask(() => {
+            writeTask(async () => {
                 for (const entry of entries) {
-                    if (entry.target.id === 'bottom-scroll') {
-                        if (entry.isIntersecting)
-                            this.loadBottom();
-                        else
-                            this.shouldRenderNewNodes = false;
-                    }
                     if (entry.target.id === 'top-scroll' && entry.isIntersecting) {
-                        this.loadTop();
+                        this.isLoadingTop = true;
+                        await this.loadPrevPage();
+                        this.isLoadingTop = false;
                     }
                 }
             });
         });
     }
-    disconnectedCallback() {
-        this.intersectionObserver.disconnect();
-    }
     componentDidLoad() {
-        /**
-         * Adding observes here so that on the first render we scroll down
-         * and shouldRenderNewNodes remains true
-         */
-        this.loadFirstPage();
         this.observe(this.$topRef);
-        this.observe(this.$bottomRef);
-    }
-    componentDidRender() {
-        if (this.shouldRenderNewNodes && this.autoScroll)
-            smoothScrollToBottom(this.$paginatedList);
-    }
-    loadFirstPage() {
-        return this.loadPage(this.currentTime(), this.pageSize, true, (data) => {
-            if (data.length === 0) {
-                this.showEmptyListLabel = true;
-            }
-        });
+        if (this.$containerRef) {
+            this.$containerRef.onscrollend = async () => {
+                /**
+                 * Load new page if:
+                 * if there are nodes to load at the bottom (maxTS > newTS)
+                 * or if there are pages to fill at the bottom (firstEmptyIndex > -1)
+                 */
+                if (this.isAtBottom() && (this.maxTS > this.newTS || this.firstEmptyIndex > -1)) {
+                    this.isLoadingBottom = true;
+                    await this.loadNextPage();
+                    this.isLoadingBottom = false;
+                    if (this.shouldScrollToBottom)
+                        this.scrollToBottom();
+                }
+            };
+        }
     }
-    loadTop() {
-        /**
-         * If there is only one unfilled page or no page, no need to check
-         * for top since it will be empty
-         */
-        if (this.pagesToRender.length === 0)
-            return;
-        if (this.pagesToRender.length === 1 && this.pagesToRender[0].length < this.pageSize)
+    async loadPrevPage() {
+        if (this.isLoading)
             return;
         /**
-         * TODO: Make this more flexible currently this only works with chat
+         * NOTE(ikabra): this case also runs on initial load
+         * if scrolling up ->
+         * fetch older messages and push to the end of the array
+         * cleanup 1st non empty page from the array if length exceeds pagesAllowed
          */
-        const oldestVNode = this.pagesToRender[0][0];
-        const oldestTimestamp = oldestVNode.timeMs;
-        // TODO: scrollIntoView
-        const onPageRendered = () => { }; // oldestVNode.$elm$?.scrollIntoView();
-        this.isLoadingTop = true;
-        this.loadPage(oldestTimestamp - 1, this.pageSize, true, onPageRendered, 'top');
+        // if no old timestamp, it means we are at initial state
+        if (!this.oldTS)
+            this.oldTS = new Date().getTime();
+        // load data
+        this.isLoading = true;
+        const data = await this.fetchData(this.oldTS - 1, this.pageSize, true);
+        this.isLoading = false;
+        // no more old messages to show, we are at the top of the page
+        if (!data.length)
+            return;
+        // add old data to the end of the array
+        this.pages.push(data);
+        // clear old pages when we reach the limit
+        if (this.pages.length > this.pagesAllowed) {
+            this.pages[this.pages.length - this.pagesAllowed - 1] = [];
+            /**
+             * find last non empty page in range (this.pages.length, this.firstEmptyIndex)
+             * we are doing this because any of the middle pages in the currently rendered pages
+             * could be empty as we allow deleting messages.
+             * This helps us set the first empty index correctly.
+             */
+            for (let i = this.firstEmptyIndex + 1; i < this.pages.length; i++) {
+                if (this.pages[i].length > 0)
+                    break;
+                this.firstEmptyIndex = i;
+            }
+        }
+        // update the old timestamp
+        const lastPage = this.pages[this.pages.length - 1];
+        this.oldTS = lastPage[lastPage.length - 1].timeMs;
+        // update the new timestamp
+        this.newTS = this.pages[this.firstEmptyIndex + 1][0].timeMs;
+        this.rerender();
     }
-    loadBottom() {
-        /**
-         * If there is only one unfilled page or no page, no need to check
-         * for top since it will be empty
-         */
-        if (this.pagesToRender.length === 0) {
-            this.shouldRenderNewNodes = true;
+    async loadNextPage() {
+        if (this.isLoading)
+            return;
+        // new timestamp needs to be assigned by loadPrevPage method
+        if (!this.newTS) {
+            this.showNewMessagesCTR = false;
+            this.shouldScrollToBottom = false;
             return;
         }
-        if (this.pagesToRender.length === 1 && this.pagesToRender[0].length < this.pageSize) {
-            this.shouldRenderNewNodes = true;
+        // load data
+        this.isLoading = true;
+        const data = await this.fetchData(this.newTS + 1, this.pageSize, false);
+        this.isLoading = false;
+        // no more new messages to load
+        if (!data.length) {
+            this.showNewMessagesCTR = false;
+            this.shouldScrollToBottom = false;
+            // remove extra pages from the start if any (could be due to users deleting messages)
+            this.pages = this.pages.filter((page) => page.length > 0);
+            this.firstEmptyIndex = -1;
             return;
         }
-        const newestVNode = this.pagesToRender.at(-1).at(-1);
-        const newestTimestamp = newestVNode.timeMs;
-        // TODO: scrollIntoView
-        const onPageRendered = () => smoothScrollToBottom(this.$paginatedList);
-        this.isLoadingBottom = true;
-        this.loadPage(newestTimestamp + 1, this.pageSize, false, onPageRendered, 'bottom');
-    }
-    addNodeToRender(node, addToStart) {
-        if (addToStart) {
-            const firstPage = this.pagesToRender[0];
-            if (firstPage && (firstPage === null || firstPage === void 0 ? void 0 : firstPage.length) < this.pageSize) {
-                /**
-                 * If first page is not full then just add to that page
-                 */
-                firstPage.unshift(node);
-            }
-            else {
-                /**
-                 * If first page is full then add a new page to the start
-                 */
-                const newPage = [node];
-                this.pagesToRender.unshift(newPage);
-                this.removeLastPageIfNeeded(false);
-            }
+        // when filling empty pages
+        if (this.firstEmptyIndex > -1) {
+            this.pages[this.firstEmptyIndex] = data.reverse();
         }
         else {
-            const [lastPage] = this.pagesToRender.slice(-1);
-            if (lastPage && (lastPage === null || lastPage === void 0 ? void 0 : lastPage.length) < this.pageSize) {
-                /**
-                 * If last page is not full then just add it
-                 */
-                lastPage.push(node);
-            }
-            else {
-                /**
-                 * If last page is full add a new page with just
-                 * this node
-                 */
-                const newPage = [node];
-                this.pagesToRender.push(newPage);
-                this.removeLastPageIfNeeded(true);
-            }
+            // when already at the bottom and loading messages in realtime
+            this.pages.unshift(data.reverse());
         }
-    }
-    /**
-     * @param start
-     * @param end
-     * @param reversed Defines whether to add the page at the beginning or the end
-     * @param onPageLoaded Callback for when all new nodes are rendered
-     * @param direction Indicates if loading from 'top' or 'bottom'
-     */
-    async loadPage(timestamp, size, reversed, onPageRendered = () => { }, direction) {
-        this.isLoading = true;
-        const data = (await this.fetchData(timestamp, size, reversed));
-        this.isLoading = false;
-        if (direction === 'top') {
-            this.isLoadingTop = false;
-            this.hasMoreDataAtTop = (data === null || data === void 0 ? void 0 : data.length) > 0;
+        if (this.pages.length > this.pagesAllowed) {
+            this.pages.pop();
         }
-        if (direction === 'bottom') {
-            this.isLoadingBottom = false;
-        }
-        if (!(data === null || data === void 0 ? void 0 : data.length)) {
-            /**
-             * While scrolling down if there were no new items found
-             * then start rendering new nodes;
-             */
-            if (!reversed) {
-                this.hasNewNodesToRender = false;
-                this.shouldRenderNewNodes = true;
-            }
-            onPageRendered([]);
-            return;
+        // smallest value for firstEmptyIndex can be -1, so we cap the index at 0
+        this.newTS = this.pages[Math.max(0, this.firstEmptyIndex)][0].timeMs;
+        // remove all empty pages from the end
+        for (let i = this.pages.length - 1; i > this.firstEmptyIndex; i--) {
+            if (this.pages[i].length > 0)
+                break;
+            // if page is empty, remove it
+            this.pages.pop();
         }
-        data.forEach((node) => this.addNodeToRender(node, reversed));
+        // update the old timestamp
+        const lastPage = this.pages[this.pages.length - 1];
+        this.oldTS = lastPage[lastPage.length - 1].timeMs;
+        // when scrolling too fast scroll a bit to the top to be able to load new messages when you scroll down
+        if (this.$containerRef.scrollTop === 0)
+            this.$containerRef.scrollTop = -60;
+        // smallest value for this index can be -1 (indicates we are at the bottom of the page).
+        this.firstEmptyIndex = Math.max(-1, this.firstEmptyIndex - 1);
         this.rerender();
-        onPageRendered(data);
-    }
-    rerender() {
-        this.rerenderBoolean = !this.rerenderBoolean;
-    }
-    removeLastPageIfNeeded(removeFromStart) {
-        if (this.pagesToRender.length > this.pagesAllowed) {
-            if (removeFromStart)
-                this.pagesToRender.shift();
-            else
-                this.pagesToRender.pop();
-        }
-    }
-    onDownArrowClicked() {
-        /**
-         * Load the freshest pages
-         */
-        this.loadBottom();
-    }
-    onLoadMoreOnTopClicked() {
-        this.loadTop();
     }
     render() {
-        var _a;
         /**
          * div.container is flex=column-reverse
          * which is why div#bottom-scroll comes before div#top-scroll
-         * div.page-wrapper prevents reversal of messages
          */
-        return (h(Host, { key: '23e10f12b079213650cf9c947d30650ba8c95a4d' }, h("div", { key: 'b5406069fd69ff117b19d437184c38b3c7d2fc28', class: "scrollbar container", part: "container", ref: (el) => (this.$paginatedList = el) }, h("div", { key: '7be947f2409ff810e0d10beea53ace8fdec334ce', class: { 'show-new-messages-ctr': true, active: !this.shouldRenderNewNodes } }, h("rtk-button", { key: '45c43d6ca1cc39376334dffa10f3f2c137d65add', class: "show-new-messages", kind: "icon", variant: "secondary", part: "show-new-messages", onClick: () => this.onDownArrowClicked() }, h("rtk-icon", { key: '519b0db80f7d16cc4d03983e227d4897a5868ec9', icon: this.iconPack.chevron_down }))), h("div", { key: '53691e3943b90ef9e422c8da8f5facaa23f01920', class: "smallest-dom-element", id: "bottom-scroll", ref: (el) => (this.$bottomRef = el) }), this.isLoadingBottom && h("rtk-spinner", { key: '2a393cb0bbb07c356144464dcc7c597f5cc9771b', size: "sm" }), this.isLoading && this.pagesToRender.flat().length === 0 && h("rtk-spinner", { key: '4ce03be69368db0d6d0d4ad079b14f2c7d93f26d', size: "lg" }), this.pagesToRender.flat().length === 0 && this.showEmptyListLabel ? (h("div", { class: "empty-list" }, (_a = this.emptyListLabel) !== null && _a !== void 0 ? _a : this.t('list.empty'))) : (h("div", { class: "page-wrapper" }, this.pagesToRender.map((page) => this.createNodes(page)))), this.hasMoreDataAtTop && !this.isLoadingTop && (h("div", { key: '5c85806854687efe098e4bd6d06d109060445378', class: "load-more-on-top-container" }, h("rtk-button", { key: '6d73a030fad5ba133aa2841b2feb196646592ada', class: "load-more-icon", kind: "icon", variant: "secondary", part: "load-more-icon", onClick: () => this.onLoadMoreOnTopClicked() }, h("rtk-icon", { key: '61a4f376749938df280e5c734dd3fa8a9b0b7201', icon: this.iconPack.chevron_up })))), this.isLoadingTop && h("rtk-spinner", { key: '3e55b99c60ed7bc2cd937091a33663dd19c9ca68', size: "sm" }), h("div", { key: 'a69e0a3a26d295783f4f729b33770b206ab5d46b', class: "smallest-dom-element", id: "top-scroll", ref: (el) => (this.$topRef = el) }))));
+        return (h(Host, { key: '91ac7d0ca3fb720259945ffaa97f465b34c694fa' }, h("div", { key: '33896c19ecc4359ae163c65b5c71b9f17673e765', class: "scrollbar container", part: "container", ref: (el) => (this.$containerRef = el) }, h("div", { key: 'e26a5ef3979ec132277b9598afc17ea65683f6c8', class: { 'show-new-messages-ctr': true, active: this.showNewMessagesCTR } }, h("rtk-button", { key: 'e769a8f54a298af456552733dc9de27d059e5138', class: "show-new-messages", kind: "icon", variant: "secondary", part: "show-new-messages", onClick: () => {
+                this.shouldScrollToBottom = true;
+                this.scrollToBottom();
+            } }, h("rtk-icon", { key: '6fb4cbc2247eb971004a94926b95ebd0f90ab0fd', icon: this.iconPack.chevron_down }))), h("div", { key: 'e91dd8f25012e4509e0ff3cb4d6b65aa9467d427', class: "smallest-dom-element", id: "bottom-scroll", ref: (el) => (this.$bottomRef = el) }), this.isLoadingBottom && this.pages.length > 0 && h("rtk-spinner", { key: '199c0ccffd57716bd5a05dcef8610113d3c58d3d', size: "sm" }), this.isLoading && this.pages.length < 1 && h("rtk-spinner", { key: 'b8a3e08a25b2bc1d50b5a9b1b2deda802ae5eb28', size: "lg" }), !this.isLoading && this.pages.flat().length === 0 ? (h("div", { class: "empty-list" }, this.t('list.empty'))) : (h("div", { class: "page-wrapper" }, this.pages.map((page, pageIndex) => (h("div", { class: "page", "data-page-index": pageIndex }, this.createNodes([...page].reverse())))))), this.isLoadingTop && this.pages.length > 0 && h("rtk-spinner", { key: '2cb56b4f70d37548fd9aa71b961559b43c54a922', size: "sm" }), h("div", { key: '4b183c49bfe60fd63af40e02b9b46215c08bb484', class: "smallest-dom-element", id: "top-scroll", ref: (el) => (this.$topRef = el) }))));
     }
     static get is() { return "rtk-paginated-list"; }
     static get encapsulation() { return "shadow"; }
@@ -333,6 +346,26 @@ export class RtkPaginatedList {
                 "attribute": "pages-allowed",
                 "reflect": false
             },
+            "emptyListLabel": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "label to show when empty"
+                },
+                "getter": false,
+                "setter": false,
+                "attribute": "empty-list-label",
+                "reflect": false,
+                "defaultValue": "null"
+            },
             "fetchData": {
                 "type": "unknown",
                 "mutable": false,
@@ -463,39 +496,16 @@ export class RtkPaginatedList {
                 "getter": false,
                 "setter": false,
                 "defaultValue": "useLanguage()"
-            },
-            "emptyListLabel": {
-                "type": "string",
-                "mutable": false,
-                "complexType": {
-                    "original": "string",
-                    "resolved": "string",
-                    "references": {}
-                },
-                "required": false,
-                "optional": false,
-                "docs": {
-                    "tags": [],
-                    "text": "label to show when empty"
-                },
-                "getter": false,
-                "setter": false,
-                "attribute": "empty-list-label",
-                "reflect": false,
-                "defaultValue": "null"
             }
         };
     }
     static get states() {
         return {
+            "rerenderBoolean": {},
+            "showEmptyListLabel": {},
             "isLoading": {},
             "isLoadingTop": {},
-            "isLoadingBottom": {},
-            "hasMoreDataAtTop": {},
-            "rerenderBoolean": {},
-            "shouldRenderNewNodes": {},
-            "hasNewNodesToRender": {},
-            "showEmptyListLabel": {}
+            "isLoadingBottom": {}
         };
     }
     static get methods() {
@@ -506,7 +516,7 @@ export class RtkPaginatedList {
                     "parameters": [{
                             "name": "node",
                             "type": "DataNode",
-                            "docs": ""
+                            "docs": "- The data node to add to the beginning of the list"
                         }],
                     "references": {
                         "Promise": {
@@ -522,17 +532,20 @@ export class RtkPaginatedList {
                     "return": "Promise<void>"
                 },
                 "docs": {
-                    "text": "On a new node created",
-                    "tags": []
+                    "text": "Adds a new node to the beginning of the paginated list",
+                    "tags": [{
+                            "name": "param",
+                            "text": "node - The data node to add to the beginning of the list"
+                        }]
                 }
             },
             "onNodeDelete": {
                 "complexType": {
-                    "signature": "(key: string) => Promise<void>",
+                    "signature": "(id: string) => Promise<void>",
                     "parameters": [{
-                            "name": "key",
+                            "name": "id",
                             "type": "string",
-                            "docs": ""
+                            "docs": "- The id of the node to delete"
                         }],
                     "references": {
                         "Promise": {
@@ -543,21 +556,24 @@ export class RtkPaginatedList {
                     "return": "Promise<void>"
                 },
                 "docs": {
-                    "text": "On node deleted",
-                    "tags": []
+                    "text": "Deletes a node anywhere from the list",
+                    "tags": [{
+                            "name": "param",
+                            "text": "id - The id of the node to delete"
+                        }]
                 }
             },
             "onNodeUpdate": {
                 "complexType": {
-                    "signature": "(key: string, newItem: DataNode) => Promise<void>",
+                    "signature": "(_id: string, _node: DataNode) => Promise<void>",
                     "parameters": [{
-                            "name": "key",
+                            "name": "_id",
                             "type": "string",
-                            "docs": ""
+                            "docs": "- The id of the node to update"
                         }, {
-                            "name": "newItem",
+                            "name": "_node",
                             "type": "DataNode",
-                            "docs": ""
+                            "docs": "- The updated data node"
                         }],
                     "references": {
                         "Promise": {
@@ -573,18 +589,18 @@ export class RtkPaginatedList {
                     "return": "Promise<void>"
                 },
                 "docs": {
-                    "text": "On node updated",
-                    "tags": []
+                    "text": "Updates a new node anywhere in the list",
+                    "tags": [{
+                            "name": "param",
+                            "text": "_id - The id of the node to update"
+                        }, {
+                            "name": "param",
+                            "text": "_node - The updated data node"
+                        }]
                 }
             }
         };
     }
-    static get watchers() {
-        return [{
-                "propName": "selectedItemId",
-                "methodName": "onItemChanged"
-            }];
-    }
 }
 __decorate([
     SyncWithStore()