@vaadin/component-base 24.2.0-beta3 → 24.2.0-beta4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/component-base",
-  "version": "24.2.0-beta3",
+  "version": "24.2.0-beta4",
   "publishConfig": {
     "access": "public"
   },
@@ -42,5 +42,5 @@
     "@vaadin/testing-helpers": "^0.5.0",
     "sinon": "^13.0.2"
   },
-  "gitHead": "91ea11e7ad706065340acdb93b92316919ce5e69"
+  "gitHead": "04da1e1e5c5713ea45e4b7d659dc6ac6b4604f4c"
 }

package/src/define.js

@@ -3,16 +3,9 @@
  * Copyright (c) 2021 - 2023 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-
 export function defineCustomElement(CustomElement) {
   const defined = customElements.get(CustomElement.is);
   if (!defined) {
-    Object.defineProperty(CustomElement, 'version', {
-      get() {
-        return '24.2.0-beta3';
-      },
-    });
-
     customElements.define(CustomElement.is, CustomElement);
   } else {
     const definedVersion = defined.version;

package/src/element-mixin.js

@@ -44,6 +44,10 @@ const registered = new Set();
  */
 export const ElementMixin = (superClass) =>
   class VaadinElementMixin extends DirMixin(superClass) {
+    static get version() {
+      return '24.2.0-beta4';
+    }
+
     /** @protected */
     static finalize() {
       super.finalize();

package/src/virtualizer-iron-list-adapter.js

@@ -82,24 +82,10 @@ export class IronListAdapter {
     return this.lastVisibleIndex + this._vidxOffset;
   }
 
-  __hasPlaceholders() {
-    return this.__getVisibleElements().some((el) => el.__virtualizerPlaceholder);
-  }
-
   scrollToIndex(index) {
     if (typeof index !== 'number' || isNaN(index) || this.size === 0 || !this.scrollTarget.offsetHeight) {
       return;
     }
-    delete this.__pendingScrollToIndex;
-
-    if (this._physicalCount <= 3 /* iron-list-core.DEFAULT_PHYSICAL_COUNT */) {
-      // The condition here is a performance improvement to avoid an unnecessary
-      // re-render when the physical item pool is already covered.
-
-      // Finish rendering at the current scroll position before scrolling
-      this.flush();
-    }
-
     index = this._clamp(index, 0, this.size - 1);
 
     const visibleElementCount = this.__getVisibleElements().length;
@@ -127,12 +113,6 @@ export class IronListAdapter {
       this._scrollTop -= this.__getIndexScrollOffset(index) || 0;
     }
     this._scrollHandler();
-
-    if (this.__hasPlaceholders()) {
-      // After rendering synchronously, there are still placeholders in the DOM.
-      // Try again after the next elements update.
-      this.__pendingScrollToIndex = index;
-    }
   }
 
   flush() {
@@ -219,9 +199,8 @@ export class IronListAdapter {
 
   __updateElement(el, index, forceSameIndexUpdates) {
     // Clean up temporary placeholder sizing
-    if (el.__virtualizerPlaceholder) {
+    if (el.style.paddingTop) {
       el.style.paddingTop = '';
-      el.__virtualizerPlaceholder = false;
     }
 
     if (!this.__preventElementUpdates && (el.__lastUpdatedIndex !== index || forceSameIndexUpdates)) {
@@ -245,7 +224,6 @@ export class IronListAdapter {
         // Assign a temporary placeholder sizing to elements that would otherwise end up having
         // no height.
         el.style.paddingTop = `${this.__placeholderHeight}px`;
-        el.__virtualizerPlaceholder = true;
 
         // Manually schedule the resize handler to make sure the placeholder padding is
         // cleared in case the resize observer never triggers.
@@ -263,10 +241,6 @@ export class IronListAdapter {
         this.__placeholderHeight = Math.round(filteredHeights.reduce((a, b) => a + b, 0) / filteredHeights.length);
       }
     });
-
-    if (this.__pendingScrollToIndex !== undefined && !this.__hasPlaceholders()) {
-      this.scrollToIndex(this.__pendingScrollToIndex);
-    }
   }
 
   __getIndexScrollOffset(index) {

package/src/data-provider-controller/cache.d.ts

@@ -1,146 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 - 2023 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import type { DataProviderCallback } from './data-provider-controller.js';
-
-export type CacheContext<TItem> = { isExpanded(item: TItem): boolean };
-
-/**
- * A class that stores items with their associated sub-caches.
- */
-export class Cache<TItem> {
-  /**
-   * A context object.
-   */
-  context: CacheContext<TItem>;
-
-  /**
-   * The number of items.
-   */
-  size: number;
-
-  /**
-   * The number of items to display per page.
-   */
-  pageSize: number;
-
-  /**
-   * An array of cached items.
-   */
-  items: TItem[];
-
-  /**
-   * A map where the key is a requested page and the value is a callback
-   * that will be called with data once the request is complete.
-   */
-  pendingRequests: Record<number, DataProviderCallback<TItem>>;
-
-  /**
-   * An item in the parent cache that the current cache is associated with.
-   */
-  get parentItem(): TItem | undefined;
-
-  /**
-   * An array of sub-caches sorted in the same order as their associated items
-   * appear in the `items` array.
-   */
-  get subCaches(): Array<Cache<TItem>>;
-
-  /**
-   * Whether the cache or any of its descendant caches have pending requests.
-   */
-  get isLoading(): boolean;
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   */
-  get flatSize(): number;
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   *
-   * @protected
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  get effectiveSize(): number;
-
-  constructor(
-    context: CacheContext<TItem>,
-    pageSize: number,
-    size: number,
-    parentCache?: Cache<TItem>,
-    parentCacheIndex?: number,
-  );
-
-  /**
-   * Recalculates the flattened size for the cache and its descendant caches recursively.
-   */
-  recalculateFlatSize(): void;
-
-  /**
-   * Adds an array of items corresponding to the given page
-   * to the `items` array.
-   */
-  setPage(page: number, items: unknown[]): void;
-
-  /**
-   * Retrieves the sub-cache associated with the item at the given index
-   * in the `items` array.
-   */
-  getSubCache(index: number): Cache<TItem> | undefined;
-
-  /**
-   * Removes the sub-cache associated with the item at the given index
-   * in the `items` array.
-   */
-  removeSubCache(index: number): void;
-
-  /**
-   * Removes all sub-caches.
-   */
-  removeSubCaches(): void;
-
-  /**
-   * Creates and associates a sub-cache for the item at the given index
-   * in the `items` array.
-   */
-  createSubCache(index: number): Cache<TItem>;
-
-  /**
-   * Retrieves the flattened index corresponding to the given index
-   * of an item in the `items` array.
-   */
-  getFlatIndex(index: number): number;
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  getItemForIndex(index: number): TItem | undefined;
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  getCacheAndIndex(index: number): { cache: Cache<TItem>; scaledIndex: number };
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  updateSize(): void;
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  ensureSubCacheForScaledIndex(scaledIndex: number): void;
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  get grid(): HTMLElement;
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  get itemCaches(): object;
-}

package/src/data-provider-controller/cache.js

@@ -1,285 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 - 2023 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { getFlatIndexContext } from './helpers.js';
-
-/**
- * A class that stores items with their associated sub-caches.
- */
-export class Cache {
-  /**
-   * A context object.
-   *
-   * @type {{ isExpanded: (item: unknown) => boolean }}
-   */
-  context;
-
-  /**
-   * The number of items.
-   *
-   * @type {number}
-   */
-  size = 0;
-
-  /**
-   * The number of items to display per page.
-   *
-   * @type {number}
-   */
-  pageSize;
-
-  /**
-   * An array of cached items.
-   *
-   * @type {object[]}
-   */
-  items = [];
-
-  /**
-   * A map where the key is a requested page and the value is a callback
-   * that will be called with data once the request is complete.
-   *
-   * @type {Record<number, Function>}
-   */
-  pendingRequests = {};
-
-  /**
-   * A map where the key is the index of an item in the `items` array
-   * and the value is a sub-cache associated with that item.
-   *
-   * Note, it's intentionally defined as an object instead of a Map
-   * to ensure that Object.entries() returns an array with keys sorted
-   * in alphabetical order, rather than the order they were added.
-   *
-   * @type {Record<number, Cache>}
-   * @private
-   */
-  __subCacheByIndex = {};
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   *
-   * @type {number}
-   * @private
-   */
-  __flatSize = 0;
-
-  /**
-   * @param {Cache['context']} context
-   * @param {number} pageSize
-   * @param {number | undefined} size
-   * @param {Cache | undefined} parentCache
-   * @param {number | undefined} parentCacheIndex
-   */
-  constructor(context, pageSize, size, parentCache, parentCacheIndex) {
-    this.context = context;
-    this.pageSize = pageSize;
-    this.size = size || 0;
-    this.parentCache = parentCache;
-    this.parentCacheIndex = parentCacheIndex;
-    this.__flatSize = size || 0;
-  }
-
-  /**
-   * An item in the parent cache that the current cache is associated with.
-   *
-   * @return {object | undefined}
-   */
-  get parentItem() {
-    return this.parentCache && this.parentCache.items[this.parentCacheIndex];
-  }
-
-  /**
-   * An array of sub-caches sorted in the same order as their associated items
-   * appear in the `items` array.
-   *
-   * @return {Cache[]}
-   */
-  get subCaches() {
-    return Object.values(this.__subCacheByIndex);
-  }
-
-  /**
-   * Whether the cache or any of its descendant caches have pending requests.
-   *
-   * @return {boolean}
-   */
-  get isLoading() {
-    if (Object.keys(this.pendingRequests).length > 0) {
-      return true;
-    }
-
-    return this.subCaches.some((subCache) => subCache.isLoading);
-  }
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   *
-   * @return {number}
-   */
-  get flatSize() {
-    return this.__flatSize;
-  }
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   *
-   * @protected
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  get effectiveSize() {
-    console.warn(
-      '<vaadin-grid> The `effectiveSize` property of ItemCache is deprecated and will be removed in Vaadin 25.',
-    );
-    return this.flatSize;
-  }
-
-  /**
-   * Recalculates the flattened size for the cache and its descendant caches recursively.
-   */
-  recalculateFlatSize() {
-    this.__flatSize =
-      !this.parentItem || this.context.isExpanded(this.parentItem)
-        ? this.size +
-          this.subCaches.reduce((total, subCache) => {
-            subCache.recalculateFlatSize();
-            return total + subCache.flatSize;
-          }, 0)
-        : 0;
-  }
-
-  /**
-   * Adds an array of items corresponding to the given page
-   * to the `items` array.
-   *
-   * @param {number} page
-   * @param {object[]} items
-   */
-  setPage(page, items) {
-    const startIndex = page * this.pageSize;
-    items.forEach((item, i) => {
-      this.items[startIndex + i] = item;
-    });
-  }
-
-  /**
-   * Retrieves the sub-cache associated with the item at the given index
-   * in the `items` array.
-   *
-   * @param {number} index
-   * @return {Cache | undefined}
-   */
-  getSubCache(index) {
-    return this.__subCacheByIndex[index];
-  }
-
-  /**
-   * Removes the sub-cache associated with the item at the given index
-   * in the `items` array.
-   *
-   * @param {number} index
-   */
-  removeSubCache(index) {
-    delete this.__subCacheByIndex[index];
-  }
-
-  /**
-   * Removes all sub-caches.
-   */
-  removeSubCaches() {
-    this.__subCacheByIndex = {};
-  }
-
-  /**
-   * Creates and associates a sub-cache for the item at the given index
-   * in the `items` array.
-   *
-   * @param {number} index
-   * @return {Cache}
-   */
-  createSubCache(index) {
-    const subCache = new Cache(this.context, this.pageSize, 0, this, index);
-    this.__subCacheByIndex[index] = subCache;
-    return subCache;
-  }
-
-  /**
-   * Retrieves the flattened index corresponding to the given index
-   * of an item in the `items` array.
-   *
-   * @param {number} index
-   * @return {number}
-   */
-  getFlatIndex(index) {
-    const clampedIndex = Math.max(0, Math.min(this.size - 1, index));
-
-    return this.subCaches.reduce((prev, subCache) => {
-      const index = subCache.parentCacheIndex;
-      return clampedIndex > index ? prev + subCache.flatSize : prev;
-    }, clampedIndex);
-  }
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  getItemForIndex(index) {
-    console.warn(
-      '<vaadin-grid> The `getItemForIndex` method of ItemCache is deprecated and will be removed in Vaadin 25.',
-    );
-    const { item } = getFlatIndexContext(this, index);
-    return item;
-  }
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  getCacheAndIndex(index) {
-    console.warn(
-      '<vaadin-grid> The `getCacheAndIndex` method of ItemCache is deprecated and will be removed in Vaadin 25.',
-    );
-    const { cache, index: scaledIndex } = getFlatIndexContext(this, index);
-    return { cache, scaledIndex };
-  }
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  updateSize() {
-    console.warn('<vaadin-grid> The `updateSize` method of ItemCache is deprecated and will be removed in Vaadin 25.');
-    this.recalculateFlatSize();
-  }
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  ensureSubCacheForScaledIndex(scaledIndex) {
-    console.warn(
-      '<vaadin-grid> The `ensureSubCacheForScaledIndex` method of ItemCache is deprecated and will be removed in Vaadin 25.',
-    );
-
-    if (!this.getSubCache(scaledIndex)) {
-      const subCache = this.createSubCache(scaledIndex);
-      this.context.__controller.__loadCachePage(subCache, 0);
-    }
-  }
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  get grid() {
-    console.warn('<vaadin-grid> The `grid` property of ItemCache is deprecated and will be removed in Vaadin 25.');
-    return this.context.__controller.host;
-  }
-
-  /**
-   * @deprecated since 24.3 and will be removed in Vaadin 25.
-   */
-  get itemCaches() {
-    console.warn(
-      '<vaadin-grid> The `itemCaches` property of ItemCache is deprecated and will be removed in Vaadin 25.',
-    );
-    return this.__subCacheByIndex;
-  }
-}

package/src/data-provider-controller/data-provider-controller.d.ts

@@ -1,156 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 - 2023 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import type { ReactiveController } from 'lit';
-import type { Cache } from './cache.js';
-
-type DataProviderDefaultParams = {
-  page: number;
-  pageSize: number;
-  parentItem?: unknown;
-};
-
-export type DataProviderCallback<TItem> = (items: TItem[], size?: number) => void;
-
-export type DataProvider<TItem, TDataProviderParams extends Record<string, unknown>> = (
-  params: DataProviderDefaultParams & TDataProviderParams,
-  callback: DataProviderCallback<TItem>,
-) => void;
-
-/**
- * A controller that stores and manages items loaded with a data provider.
- */
-export class DataProviderController<TItem, TDataProviderParams extends Record<string, unknown>>
-  implements ReactiveController
-{
-  /**
-   * The controller host element.
-   */
-  host: HTMLElement;
-
-  /**
-   * A callback that returns data based on the passed params such as
-   * `page`, `pageSize`, `parentItem`, etc.
-   */
-  dataProvider: DataProvider<TItem, TDataProviderParams>;
-
-  /**
-   * A callback that returns additional params that need to be passed
-   * to the data provider callback with every request.
-   */
-  dataProviderParams: () => TDataProviderParams;
-
-  /**
-   * A number of items in the root cache.
-   */
-  size?: number;
-
-  /**
-   * A number of items to display per page.
-   */
-  pageSize: number;
-
-  /**
-   * A callback that returns whether the given item is expanded.
-   */
-  isExpanded: (item: TItem) => boolean;
-
-  /**
-   * A reference to the root cache instance.
-   */
-  rootCache: Cache<TItem>;
-
-  constructor(
-    host: HTMLElement,
-    config: {
-      size?: number;
-      pageSize: number;
-      isExpanded(item: TItem): boolean;
-      dataProvider: DataProvider<TItem, TDataProviderParams>;
-      dataProviderParams(): TDataProviderParams;
-    },
-  );
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   */
-  get flatSize(): number;
-
-  hostConnected(): void;
-
-  hostDisconnected(): void;
-
-  /**
-   * Whether the root cache or any of its decendant caches have pending requests.
-   */
-  isLoading(): boolean;
-
-  /**
-   * Sets the size for the root cache and recalculates the flattened size.
-   */
-  setSize(size: number): void;
-
-  /**
-   * Sets the page size and clears the cache.
-   */
-  setPageSize(pageSize: number): void;
-
-  /**
-   * Sets the data provider callback and clears the cache.
-   */
-  setDataProvider(dataProvider: DataProvider<TItem, TDataProviderParams>): void;
-
-  /**
-   * Recalculates the flattened size.
-   */
-  recalculateFlatSize(): void;
-
-  /**
-   * Clears the cache.
-   */
-  clearCache(): void;
-
-  /**
-   * Returns context for the given flattened index, including:
-   * - the corresponding cache
-   * - the associated item (if loaded)
-   * - the corresponding index in the cache's items array.
-   * - the page containing the index.
-   * - the cache level
-   */
-  getFlatIndexContext(flatIndex: number): {
-    cache: Cache<TItem>;
-    item: TItem | undefined;
-    index: number;
-    page: number;
-    level: number;
-  };
-
-  /**
-   * Returns the flattened index for the item that the given indexes point to.
-   * Each index in the path array points to a sub-item of the previous index.
-   * Using `Infinity` as an index will point to the last item on the level.
-   */
-  getFlatIndexByPath(path: number[]): number;
-
-  /**
-   * Requests the data provider to load the page with the item corresponding
-   * to the given flattened index. If the item is already loaded, the method
-   * returns immediatelly.
-   */
-  ensureFlatIndexLoaded(flatIndex: number): void;
-
-  /**
-   * Creates a sub-cache for the item corresponding to the given flattened index and
-   * requests the data provider to load the first page into the created sub-cache.
-   * If the sub-cache already exists, the method returns immediatelly.
-   */
-  ensureFlatIndexHierarchy(flatIndex: number): void;
-
-  /**
-   * Loads the first page into the root cache.
-   */
-  loadFirstPage(): void;
-}

package/src/data-provider-controller/data-provider-controller.js

@@ -1,248 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 - 2023 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { Cache } from './cache.js';
-import { getFlatIndexByPath, getFlatIndexContext } from './helpers.js';
-
-/**
- * A controller that stores and manages items loaded with a data provider.
- */
-export class DataProviderController extends EventTarget {
-  /**
-   * The controller host element.
-   *
-   * @param {HTMLElement}
-   */
-  host;
-
-  /**
-   * A callback that returns data based on the passed params such as
-   * `page`, `pageSize`, `parentItem`, etc.
-   */
-  dataProvider;
-
-  /**
-   * A callback that returns additional params that need to be passed
-   * to the data provider callback with every request.
-   */
-  dataProviderParams;
-
-  /**
-   * A number of items in the root cache.
-   *
-   * @type {number}
-   */
-  size;
-
-  /**
-   * A number of items to display per page.
-   *
-   * @type {number}
-   */
-  pageSize;
-
-  /**
-   * A callback that returns whether the given item is expanded.
-   *
-   * @type {(item: unknown) => boolean}
-   */
-  isExpanded;
-
-  /**
-   * A reference to the root cache instance.
-   *
-   * @param {Cache}
-   */
-  rootCache;
-
-  constructor(host, { size, pageSize, isExpanded, dataProvider, dataProviderParams }) {
-    super();
-    this.host = host;
-    this.size = size;
-    this.pageSize = pageSize;
-    this.isExpanded = isExpanded;
-    this.dataProvider = dataProvider;
-    this.dataProviderParams = dataProviderParams;
-    this.rootCache = this.__createRootCache();
-  }
-
-  /**
-   * The total number of items, including items from expanded sub-caches.
-   */
-  get flatSize() {
-    return this.rootCache.flatSize;
-  }
-
-  /** @private */
-  get __cacheContext() {
-    return {
-      isExpanded: this.isExpanded,
-      // The controller instance is needed to ensure deprecated cache methods work.
-      __controller: this,
-    };
-  }
-
-  /**
-   * Whether the root cache or any of its decendant caches have pending requests.
-   *
-   * @return {boolean}
-   */
-  isLoading() {
-    return this.rootCache.isLoading;
-  }
-
-  /**
-   * Sets the size for the root cache and recalculates the flattened size.
-   *
-   * @param {number} size
-   */
-  setSize(size) {
-    this.size = size;
-    this.rootCache.size = size;
-    this.recalculateFlatSize();
-  }
-
-  /**
-   * Sets the page size and clears the cache.
-   *
-   * @param {number} pageSize
-   */
-  setPageSize(pageSize) {
-    this.pageSize = pageSize;
-    this.clearCache();
-  }
-
-  /**
-   * Sets the data provider callback and clears the cache.
-   *
-   * @type {Function}
-   */
-  setDataProvider(dataProvider) {
-    this.dataProvider = dataProvider;
-    this.clearCache();
-  }
-
-  /**
-   * Recalculates the flattened size.
-   */
-  recalculateFlatSize() {
-    this.rootCache.recalculateFlatSize();
-  }
-
-  /**
-   * Clears the cache.
-   */
-  clearCache() {
-    this.rootCache = this.__createRootCache();
-  }
-
-  /**
-   * Returns context for the given flattened index, including:
-   * - the corresponding cache
-   * - the associated item (if loaded)
-   * - the corresponding index in the cache's items array.
-   * - the page containing the index.
-   * - the cache level
-   */
-  getFlatIndexContext(flatIndex) {
-    return getFlatIndexContext(this.rootCache, flatIndex);
-  }
-
-  /**
-   * Returns the flattened index for the item that the given indexes point to.
-   * Each index in the path array points to a sub-item of the previous index.
-   * Using `Infinity` as an index will point to the last item on the level.
-   *
-   * @param {number[]} path
-   * @return {number}
-   */
-  getFlatIndexByPath(path) {
-    return getFlatIndexByPath(this.rootCache, path);
-  }
-
-  /**
-   * Requests the data provider to load the page with the item corresponding
-   * to the given flattened index. If the item is already loaded, the method
-   * returns immediatelly.
-   *
-   * @param {number} flatIndex
-   */
-  ensureFlatIndexLoaded(flatIndex) {
-    const { cache, page, item } = this.getFlatIndexContext(flatIndex);
-
-    if (!item) {
-      this.__loadCachePage(cache, page);
-    }
-  }
-
-  /**
-   * Creates a sub-cache for the item corresponding to the given flattened index and
-   * requests the data provider to load the first page into the created sub-cache.
-   * If the sub-cache already exists, the method returns immediatelly.
-   *
-   * @param {number} flatIndex
-   */
-  ensureFlatIndexHierarchy(flatIndex) {
-    const { cache, item, index } = this.getFlatIndexContext(flatIndex);
-
-    if (item && this.isExpanded(item) && !cache.getSubCache(index)) {
-      const subCache = cache.createSubCache(index);
-      this.__loadCachePage(subCache, 0);
-    }
-  }
-
-  /**
-   * Loads the first page into the root cache.
-   */
-  loadFirstPage() {
-    this.__loadCachePage(this.rootCache, 0);
-  }
-
-  /** @private */
-  __createRootCache() {
-    return new Cache(this.__cacheContext, this.pageSize, this.size);
-  }
-
-  /** @private */
-  __loadCachePage(cache, page) {
-    if (!this.dataProvider || cache.pendingRequests[page]) {
-      return;
-    }
-
-    let params = {
-      page,
-      pageSize: this.pageSize,
-      parentItem: cache.parentItem,
-    };
-
-    if (this.dataProviderParams) {
-      params = { ...params, ...this.dataProviderParams() };
-    }
-
-    const callback = (items, size) => {
-      if (size !== undefined) {
-        cache.size = size;
-      } else if (params.parentItem) {
-        cache.size = items.length;
-      }
-
-      cache.setPage(page, items);
-
-      this.recalculateFlatSize();
-
-      this.dispatchEvent(new CustomEvent('page-received'));
-
-      delete cache.pendingRequests[page];
-
-      this.dispatchEvent(new CustomEvent('page-loaded'));
-    };
-
-    cache.pendingRequests[page] = callback;
-
-    this.dispatchEvent(new CustomEvent('page-requested'));
-
-    this.dataProvider(params, callback);
-  }
-}

package/src/data-provider-controller/helpers.d.ts

@@ -1,32 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 - 2023 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-
-/**
- * Returns context for the given flattened index, including:
- * - the corresponding cache
- * - the associated item (if loaded)
- * - the corresponding index in the cache's items array.
- * - the page containing the index.
- * - the cache level
- */
-export function getFlatIndexContext(
-  cache: Cache,
-  flatIndex: number,
-  level: number,
-): {
-  cache: Cache;
-  item: unknown | undefined;
-  index: number;
-  page: number;
-  level: number;
-};
-
-/**
- * Recursively returns the globally flat index of the item the given indexes point to.
- * Each index in the array points to a sub-item of the previous index.
- * Using `Infinity` as an index will point to the last item on the level.
- */
-export function getFlatIndexByPath(cache: Cache, path: number[], flatIndex: number): number;

package/src/data-provider-controller/helpers.js

@@ -1,63 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 - 2023 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-
-/**
- * Returns context for the given flattened index, including:
- * - the corresponding cache
- * - the associated item (if loaded)
- * - the corresponding index in the cache's items array.
- * - the page containing the index.
- * - the cache level
- *
- * @param {import('./cache.js').Cache} cache
- * @param {number} flatIndex
- * @return {{ cache: Cache, item: object | undefined, index: number, page: number, level: number }}
- */
-export function getFlatIndexContext(cache, flatIndex, level = 0) {
-  let levelIndex = flatIndex;
-
-  for (const subCache of cache.subCaches) {
-    const index = subCache.parentCacheIndex;
-    if (levelIndex <= index) {
-      break;
-    } else if (levelIndex <= index + subCache.flatSize) {
-      return getFlatIndexContext(subCache, levelIndex - index - 1, level + 1);
-    }
-    levelIndex -= subCache.flatSize;
-  }
-
-  return {
-    cache,
-    item: cache.items[levelIndex],
-    index: levelIndex,
-    page: Math.floor(levelIndex / cache.pageSize),
-    level,
-  };
-}
-
-/**
- * Recursively returns the globally flat index of the item the given indexes point to.
- * Each index in the array points to a sub-item of the previous index.
- * Using `Infinity` as an index will point to the last item on the level.
- *
- * @param {Cache} cache
- * @param {number[]} path
- * @param {number} flatIndex
- * @return {number}
- */
-export function getFlatIndexByPath(cache, [levelIndex, ...subIndexes], flatIndex = 0) {
-  if (levelIndex === Infinity) {
-    // Treat Infinity as the last index on the level
-    levelIndex = cache.size - 1;
-  }
-
-  const flatIndexOnLevel = cache.getFlatIndex(levelIndex);
-  const subCache = cache.getSubCache(levelIndex);
-  if (subCache && subCache.flatSize > 0 && subIndexes.length) {
-    return getFlatIndexByPath(subCache, subIndexes, flatIndex + flatIndexOnLevel + 1);
-  }
-  return flatIndex + flatIndexOnLevel;
-}