@shopify/flash-list 1.8.0 → 2.0.0-alpha.2

package/README.md

@@ -1,24 +1,16 @@
 ![FlashList Image](./FlashList.png)
 
-<div align="center">
-  <a href="https://shopify.github.io/flash-list/">Website</a> •
-  <a href="https://discord.gg/k2gzABTfav">Discord</a> •
-  <a href="https://shopify.github.io/flash-list/docs/">Getting started</a> •
-  <a href="https://shopify.github.io/flash-list/docs/usage">Usage</a> •
-  <a href="https://shopify.github.io/flash-list/docs/performance-troubleshooting">Performance</a> •
-  <a href="https://shopify.github.io/flash-list/docs/fundamentals/performant-components">Writing performant components</a> •
-  <a href="https://shopify.github.io/flash-list/docs/known-issues">Known Issues</a>
-<br><br>
+# FlashList v2
 
-**Fast & performant React Native list. No more blank cells.**
+FlashList v2 has been rebuilt from the ground up and delivers fast performance, higher precision, and better ease of use compared to v1. We've achieved all this while moving to a JS-only solution! One of the key advantages of FlashList v2 is that it doesn't require any estimates. It also introduces several new features compared to v1.
 
-Swap from FlatList in seconds. Get instant performance.
+> ⚠️ **IMPORTANT:** FlashList v2.x has been designed to fully leverage the new architecture. **Old architecture will only be supported while FlashList v2 is in alpha/beta and will be dropped once it's ready.** When run on old architecture, we just fall back to v1.x which doesn't have any of the new features.
 
-</div>
+> ⚠️ **IMPORTANT:** FlashList v2.x is in alpha and may have some issues. Please report any issues or edge cases you run into. We're actively working on testing and optimizing v2 so some things might change in the final version.
 
-## React Native's new architecture support
+### Web support
 
-FlashList is compatible with React Native's new architecture however, it's not fully optimized for it yet. You will still gain performance benefits from using FlashList over FlatList. Stayed tuned for more improvements.
+Web support might be added sometime in the future. We plan on shipping the RN version first.
 
 ## Installation
 
@@ -26,9 +18,7 @@ Add the package to your project via `yarn add @shopify/flash-list` and run `pod
 
 ## Usage
 
-We recommend reading the detailed documentation for using `FlashList` [here](https://shopify.github.io/flash-list/docs/usage).
-
-But if you are familiar with [FlatList](https://reactnative.dev/docs/flatlist), you already know how to use `FlashList`. You can try out `FlashList` by changing the component name and adding the `estimatedItemSize` prop or refer to the example below:
+But if you are familiar with [FlatList](https://reactnative.dev/docs/flatlist), you already know how to use `FlashList`. You can try out `FlashList` by changing the component name or refer to the example below:
 
 ```jsx
 import React from "react";
@@ -49,20 +39,151 @@ const MyList = () => {
     <FlashList
       data={DATA}
       renderItem={({ item }) => <Text>{item.title}</Text>}
-      estimatedItemSize={200}
     />
   );
 };
 ```
 
-To avoid common pitfalls, you can also follow these steps for migrating from `FlatList`, based on our own experiences:
-
-1. Switch from `FlatList` to `FlashList` and render the list once. You should see a warning about missing `estimatedItemSize` and a suggestion. Set this value as the prop directly.
-2. **Important**: Scan your [`renderItem`](https://shopify.github.io/flash-list/docs/usage/#renderitem) hierarchy for explicit `key` prop definitions and remove them. If you’re doing a `.map()` use indices as keys.
-3. Check your [`renderItem`](https://shopify.github.io/flash-list/docs/usage/#renderitem) hierarchy for components that make use of `useState` and verify whether that state would need to be reset if a different item is passed to that component (see [Recycling](https://shopify.github.io/flash-list/docs/recycling))
-4. If your list has heterogenous views, pass their types to `FlashList` using [`getItemType`](https://shopify.github.io/flash-list/docs/usage/#getitemtype) prop to improve performance.
-5. Do not test performance with JS dev mode on. Make sure you’re in release mode. `FlashList` can appear slower while in dev mode due to a small render buffer.
+## New props
+
+- `masonry`: Enable masonry layout for grid-like interfaces with varying item heights.
+
+  ```jsx
+  <FlashList
+    data={data}
+    masonry
+    numColumns={3}
+    renderItem={({ item }) => <MasonryItem item={item} />}
+  />
+  ```
+
+- `optimizeItemArrangement`: When enabled, masonry layout will try to reduce differences in column height by modifying item order.
+- `onStartReached`: Called when the scroll position gets within `onStartReachedThreshold` of the start of the content.
+
+  ```jsx
+  <FlashList
+    data={messageData}
+    onStartReached={() => loadOlderMessages()}
+    onStartReachedThreshold={0.1}
+    renderItem={({ item }) => <MessageItem message={item} />}
+  />
+  ```
+
+- `onStartReachedThreshold`: How far from the start the top edge of the list must be to trigger `onStartReached`.
+- `disableRecycling`: If true, the FlashList will not recycle items.
+- `style`: Style for the FlashList's parent container. We highly recommend not adding padding which can impact the size of the ScrollView inside. We operate on the assumption that the size of parent view and ScrollView is the same. In most cases, `contentContainerStyle` should be enough so avoid using this.
+- `maintainVisibleContentPosition`: Configuration for maintaining scroll position when content changes:
+  - `disabled`: Set to true to disable this feature (enabled by default).
+  - `autoscrollToTopThreshold`: Automatically scroll to maintain position when content is added at the top.
+  - `autoscrollToBottomThreshold`: Automatically scroll to maintain position when content is added at the bottom.
+  - `startRenderingFromBottom`: If true, initial render will start from the bottom, useful for chat interfaces.
+  ```jsx
+  <FlashList
+    data={chatMessages}
+    maintainVisibleContentPosition={{
+      autoscrollToBottomThreshold: 0.2,
+      startRenderingFromBottom: true,
+    }}
+    renderItem={({ item }) => <ChatMessage message={item} />}
+  />
+  ```
+- `onCommitLayoutEffect`: Called before layout is committed. Can be used to measure list and make changes before paint. Doing setState inside the callback can lead to infinite loops. Make sure FlashList's props are memoized.
+
+## Deprecated (will be removed after alpha/beta)
+
+- `estimatedItemSize`: No longer used.
+- `estimatedListSize`: No longer used.
+- `estimatedFirstItemOffset`: No longer used.
+- `inverted`: We have added `maintainVisibleContentPosition` support, so we don't want to maintain inverted mode.
+- `onBlankArea`: We don't have plans to add or continue supporting this prop.
+- `disableHorizontalListHeightMeasurement`: No longer needed.
+- `disableAutoLayout`: There's no auto layout in v2.
+- `MasonryFlashList` will be replaced by `masonry` prop.
+- `getColumnFlex` from `MasonryFlashList` will not be supported in FlashList v2 with `masonry` prop.
+
+## Changed props
+
+- `overrideItemLayout`: This used to allow a way to change the span of items and provide size estimates. In v2, span is supported, but we no longer read the size estimates.
+  ```jsx
+  <FlashList
+    data={gridData}
+    numColumns={2}
+    overrideItemLayout={(layout, item) => {
+      layout.span = item.span; // Set span
+    }}
+    renderItem={({ item }) => <GridItem item={item} />}
+  />
+  ```
+
+## New features
+
+- `masonry` is now a prop on FlashList. It's now also possible to use `overrideItemLayout` with `masonry`.
+- `maintainVisibleContentPosition` is available and now enabled by default. We use this to reduce visible glitches as much as possible. Chat apps without inverted will also be possible. Please note that if you plan on adding a large number of rows on top of the list, then you may want to increase the drawDistance on the list.
+- `onStartReached` callback is now available with a configurable threshold.
+- We've also added support for RTL layouts.
+
+## Improvements
+
+- `scrollToIndex` and `scrollToItem` are much more precise.
+- Scrolling upwards after orientation change doesn't cause layout glitches. The same is true for scrolling to items and scrolling upwards.
+- `stickyHeaders` use an Animated implementation, so minor gaps between them while scrolling aren't visible anymore.
+- FlashList does not ask for any estimates, which makes it much easier to use.
+- Horizontal Lists are much improved, and items can also resize within the lists. We no longer render an extra item to measure list height.
+- In Grid layout, if side-by-side items have different heights, then the shorter item will match the height of the tallest item. This wasn't possible in v1.
+- The ref of FlashList has many more useful methods like `getVisibleIndices` and `getLayout`.
+- `contentContainerStyle` prop is fully supported now.
+
+## Things to know
+
+- `keyExtractor` is important to prevent glitches due to item layout changes when going upwards. We highly recommend having a valid `keyExtractor` with v2.
+- Avoid adding keys directly to components which can break recycling. Same as v1. More info [here](https://shopify.github.io/flash-list/docs/fundamentals/performant-components/#remove-key-prop).
+- `useLayoutState`: This is similar to `useState` but communicates the change in state to FlashList. It's useful if you want to resize a child component based on a local state. Item layout changes will still be detected using `onLayout` callback in the absence of `useLayoutState`, which might not look as smooth on a case-by-case basis.
+
+  ```jsx
+  import { useLayoutState } from "@shopify/flash-list";
+
+  const MyItem = ({ item }) => {
+    const [isExpanded, setIsExpanded] = useLayoutState(false);
+    const height = isExpanded ? 150 : 80;
+
+    return (
+      <Pressable onPress={() => setIsExpanded(!isExpanded)}>
+        <View style={{ height, padding: 16 }}>
+          <Text>{item.title}</Text>
+        </View>
+      </Pressable>
+    );
+  };
+  ```
+
+- `useRecyclingState`: Similar to `useState` but accepts a dependency array. On change of deps, the state gets reset without an additional `setState` call. Useful for maintaining local item state if really necessary. It also has the functionality of `useLayoutState` built in.
+
+  ```jsx
+  import { useRecyclingState } from "@shopify/flash-list";
+
+  const GridItem = ({ item }) => {
+    const [isExpanded, setIsExpanded] = useRecyclingState(
+      false,
+      [item.id],
+      () => {
+        // runs on reset. Can be used to reset scroll positions of nested horizontal lists
+      }
+    );
+    const height = isExpanded ? 100 : 50;
+
+    return (
+      <Pressable onPress={() => setIsExpanded(!isExpanded)}>
+        <View style={{ height, backgroundColor: item.color }}>
+          <Text>{item.title}</Text>
+        </View>
+      </Pressable>
+    );
+  };
+  ```
+
+- If you're nesting horizontal FlashLists in vertical lists, we highly recommend the vertical list to be FlashList too. We have optimizations to wait for child layout to complete which can improve load times.
+- For chat apps, consider increasing drawDistance to 500 or higher if you're going to add a lot of items to the top. Higher drawDistance can remove some flickers. 500-1000 for chat can be okay. We would like to hear from you if you run into issues.
 
 ## App / Playground
 
-The [fixture](https://github.com/Shopify/flash-list/tree/main/fixture) is an example app showing how to use the library.
+The [fixture](https://github.com/Shopify/flash-list/tree/new-rlv-prototype/fixture) is an example app showing how to use the library.

package/dist/FlashListProps.d.ts

@@ -18,7 +18,7 @@ export declare type RenderTarget = "Cell" | "StickyHeader" | "Measurement";
 export declare const RenderTargetOptions: Record<string, RenderTarget>;
 export declare type ListRenderItem<TItem> = (info: ListRenderItemInfo<TItem>) => React.ReactElement | null;
 export declare type ContentStyle = Pick<ViewStyle, "backgroundColor" | "paddingTop" | "paddingLeft" | "paddingRight" | "paddingBottom" | "padding" | "paddingVertical" | "paddingHorizontal">;
-export interface FlashListProps<TItem> extends ScrollViewProps {
+export interface FlashListProps<TItem> extends Omit<ScrollViewProps, "maintainVisibleContentPosition"> {
     /**
      * Takes an item from `data` and renders it into the list. Typical usage:
      * ```ts
@@ -164,7 +164,7 @@ export interface FlashListProps<TItem> extends ScrollViewProps {
      * How far from the end (in units of visible length of the list) the bottom edge of the
      * list must be from the end of the content to trigger the `onEndReached` callback.
      * Thus a value of 0.5 will trigger `onEndReached` when the end of the content is
-     * within half the visible length of the list.
+     * within half the visible length of the list. Default value is 0.5.
      */
     onEndReachedThreshold?: number | null | undefined;
     /**
@@ -252,5 +252,68 @@ export interface FlashListProps<TItem> extends ScrollViewProps {
      * `false` again.
      */
     disableAutoLayout?: boolean;
+    /**
+     * New arch only
+     * Enable masonry layout.
+     */
+    masonry?: boolean;
+    /**
+     * New arch only
+     * If enabled, MasonryFlashList will try to reduce difference in column height by modifying item order.
+     */
+    optimizeItemArrangement?: boolean;
+    /**
+     * New arch only
+     * Called once when the scroll position gets within onStartReachedThreshold of the start of the content.
+     */
+    onStartReached?: FlashListProps<TItem>["onEndReached"];
+    /**
+     * New arch only
+     * How far from the start (in units of visible length of the list) the top edge of the
+     * list must be from the start of the content to trigger the `onStartReached` callback.
+     * Thus a value of 0.5 will trigger `onStartReached` when the start of the content is
+     * within half the visible length of the list. Default value is 0.2.
+     */
+    onStartReachedThreshold?: FlashListProps<TItem>["onEndReachedThreshold"];
+    /**
+     * New arch only
+     * If true, the RecyclerView will not recycle items.
+     */
+    disableRecycling?: boolean;
+    /**
+     * New arch only
+     * Style for the RecyclerView's parent container.
+     * Please avoid anything which can mess size of children in this view. For example, margin is okay but padding is not.
+     */
+    style?: ViewStyle;
+    /**
+     * New arch only
+     * Configuration for maintaining scroll position when content changes.
+     * Useful for chat-like interfaces where new messages can be added at the top or bottom.
+     */
+    maintainVisibleContentPosition?: {
+        /**
+         * maintainVisibleContentPosition is enabled by default.
+         */
+        disabled?: boolean;
+        /**
+         * When content is added at the top, automatically scroll to maintain position if the user is within this threshold of the top
+         */
+        autoscrollToTopThreshold?: number;
+        /**
+         * When content is added at the bottom, automatically scroll to maintain position if the user is within this threshold of the bottom
+         */
+        autoscrollToBottomThreshold?: number;
+        /**
+         * If true, initial render will start from the bottom of the list, useful for chat-like interfaces when there are only few messages
+         */
+        startRenderingFromBottom?: boolean;
+    };
+    /**
+     * New arch only
+     * Called when the layout is committed. Can be used to measure list.
+     * Doing set state inside the callback can lead to infinite loops. Make sure FlashList's props are memoized.
+     */
+    onCommitLayoutEffect?: () => void;
 }
 //# sourceMappingURL=FlashListProps.d.ts.map

package/dist/FlashListProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FlashListProps.d.ts","sourceRoot":"","sources":["../src/FlashListProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACL,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,8BAA8B,EAC9B,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,SAAS,MAAM,yBAAyB,CAAC;AAEhD,MAAM,WAAW,kBAAkB,CAAC,KAAK;IACvC,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB;AAED,oBAAY,YAAY,GAAG,MAAM,GAAG,cAAc,GAAG,aAAa,CAAC;AAEnE,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAI5D,CAAC;AAEF,oBAAY,cAAc,CAAC,KAAK,IAAI,CAClC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAC5B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;AAE/B,oBAAY,YAAY,GAAG,IAAI,CAC7B,SAAS,EACP,iBAAiB,GACjB,YAAY,GACZ,aAAa,GACb,cAAc,GACd,eAAe,GACf,SAAS,GACT,iBAAiB,GACjB,mBAAmB,CACtB,CAAC;AAEF,MAAM,WAAW,cAAc,CAAC,KAAK,CAAE,SAAQ,eAAe;IAC5D;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE7D;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAErE;;OAEG;IACH,kBAAkB,CAAC,EACf,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC,YAAY,GAClB,IAAI,GACJ,SAAS,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAChB,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC,YAAY,GAClB,IAAI,GACJ,SAAS,CAAC;IAEd;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,EAChB,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC,YAAY,GAClB,IAAI,GACJ,SAAS,CAAC;IAEd;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,qBAAqB,CAAC,EAClB,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,GACpC,KAAK,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;IAE9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAEtD;;;;OAIG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;IAEpE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,qBAAqB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAE/C;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAElD;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAErD;;;;;;;OAOG;IACH,sBAAsB,CAAC,EACnB,CAAC,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,SAAS,EAAE,CAAC;QAAC,OAAO,EAAE,SAAS,EAAE,CAAA;KAAE,KAAK,IAAI,CAAC,GACtE,IAAI,GACJ,SAAS,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAE5C;;;;;OAKG;IACH,WAAW,CAAC,EAAE,CACZ,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,GAAG,KACZ,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,CACnB,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EACxC,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,GAAG,KACZ,IAAI,CAAC;IAEV;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,CAAC;IAEzD;;;OAGG;IACH,8BAA8B,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAE5E;;;;OAIG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;IAEjD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B"}
+{"version":3,"file":"FlashListProps.d.ts","sourceRoot":"","sources":["../src/FlashListProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACL,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,8BAA8B,EAC9B,SAAS,EACV,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,SAAS,MAAM,yBAAyB,CAAC;AAEhD,MAAM,WAAW,kBAAkB,CAAC,KAAK;IACvC,IAAI,EAAE,KAAK,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,CAAC,EAAE,GAAG,CAAC;CACjB;AAED,oBAAY,YAAY,GAAG,MAAM,GAAG,cAAc,GAAG,aAAa,CAAC;AAEnE,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAI5D,CAAC;AAEF,oBAAY,cAAc,CAAC,KAAK,IAAI,CAClC,IAAI,EAAE,kBAAkB,CAAC,KAAK,CAAC,KAC5B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;AAE/B,oBAAY,YAAY,GAAG,IAAI,CAC7B,SAAS,EACP,iBAAiB,GACjB,YAAY,GACZ,aAAa,GACb,cAAc,GACd,eAAe,GACf,SAAS,GACT,iBAAiB,GACjB,mBAAmB,CACtB,CAAC;AAEF,MAAM,WAAW,cAAc,CAAC,KAAK,CACnC,SAAQ,IAAI,CAAC,eAAe,EAAE,gCAAgC,CAAC;IAC/D;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAErD;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAE9C;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;;;;;;;;;;;OAgBG;IACH,qBAAqB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAE7D;;OAEG;IACH,sBAAsB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAErE;;OAEG;IACH,kBAAkB,CAAC,EACf,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC,YAAY,GAClB,IAAI,GACJ,SAAS,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAChB,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC,YAAY,GAClB,IAAI,GACJ,SAAS,CAAC;IAEd;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,mBAAmB,CAAC,EAChB,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,GACxB,KAAK,CAAC,YAAY,GAClB,IAAI,GACJ,SAAS,CAAC;IAEd;;OAEG;IACH,wBAAwB,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAE5D;;OAEG;IACH,qBAAqB,CAAC,EAClB,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,GACpC,KAAK,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC;IAE9B;;;OAGG;IACH,qBAAqB,CAAC,EAAE,YAAY,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IAEtD;;;;OAIG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAEtC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;IAEpE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,qBAAqB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAE/C;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAElD;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IAErD;;;;;;;OAOG;IACH,sBAAsB,CAAC,EACnB,CAAC,CAAC,IAAI,EAAE;QAAE,aAAa,EAAE,SAAS,EAAE,CAAC;QAAC,OAAO,EAAE,SAAS,EAAE,CAAA;KAAE,KAAK,IAAI,CAAC,GACtE,IAAI,GACJ,SAAS,CAAC;IAEd;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,SAAS,CAAC;IAE5C;;;;;OAKG;IACH,WAAW,CAAC,EAAE,CACZ,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,MAAM,EACb,SAAS,CAAC,EAAE,GAAG,KACZ,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;IAEjC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,CACnB,MAAM,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EACxC,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,GAAG,KACZ,IAAI,CAAC;IAEV;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC;IAExC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,GAAG,IAAI,GAAG,SAAS,CAAC;IAEzD;;;OAGG;IACH,8BAA8B,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAE5E;;;;OAIG;IACH,sCAAsC,CAAC,EAAE,OAAO,CAAC;IAEjD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,uBAAuB,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAEzE;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,KAAK,CAAC,EAAE,SAAS,CAAC;IAElB;;;;OAIG;IACH,8BAA8B,CAAC,EAAE;QAC/B;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB;;WAEG;QACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC;;WAEG;QACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;QACrC;;WAEG;QACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC,CAAC;IAEF;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,IAAI,CAAC;CACnC"}

package/dist/__tests__/AverageWindow.test.js

@@ -66,4 +66,39 @@ describe("AverageWindow", function () {
         }
     });
 });
+describe("MultiTypeAverageWindow", function () {
+    it("should maintain separate averages for different types", function () {
+        var windowSize = 10;
+        var multiTypeAverageWindow = new AverageWindow_1.MultiTypeAverageWindow(windowSize);
+        multiTypeAverageWindow.addValue(10, "type1");
+        multiTypeAverageWindow.addValue(20, "type2");
+        expect(multiTypeAverageWindow.getCurrentValue("type1")).toBe(10);
+        expect(multiTypeAverageWindow.getCurrentValue("type2")).toBe(20);
+    });
+    it("should update averages correctly for each type", function () {
+        var windowSize = 5;
+        var multiTypeAverageWindow = new AverageWindow_1.MultiTypeAverageWindow(windowSize);
+        multiTypeAverageWindow.addValue(10, "type1");
+        multiTypeAverageWindow.addValue(20, "type1");
+        multiTypeAverageWindow.addValue(30, "type1");
+        multiTypeAverageWindow.addValue(5, "type2");
+        multiTypeAverageWindow.addValue(15, "type2");
+        expect(multiTypeAverageWindow.getCurrentValue("type1")).toBe(20);
+        expect(multiTypeAverageWindow.getCurrentValue("type2")).toBe(10);
+    });
+    it("should return 0 for non-existent types", function () {
+        var windowSize = 5;
+        var multiTypeAverageWindow = new AverageWindow_1.MultiTypeAverageWindow(windowSize);
+        expect(multiTypeAverageWindow.getCurrentValue("nonExistentType")).toBe(0);
+    });
+    it("should reset all averages", function () {
+        var windowSize = 5;
+        var multiTypeAverageWindow = new AverageWindow_1.MultiTypeAverageWindow(windowSize);
+        multiTypeAverageWindow.addValue(10, "type1");
+        multiTypeAverageWindow.addValue(20, "type2");
+        multiTypeAverageWindow.reset();
+        expect(multiTypeAverageWindow.getCurrentValue("type1")).toBe(0);
+        expect(multiTypeAverageWindow.getCurrentValue("type2")).toBe(0);
+    });
+});
 //# sourceMappingURL=AverageWindow.test.js.map

package/dist/__tests__/AverageWindow.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"AverageWindow.test.js","sourceRoot":"","sources":["../../src/__tests__/AverageWindow.test.ts"],"names":[],"mappings":";;AAAA,wDAAuD;AAEvD,QAAQ,CAAC,eAAe,EAAE;IACxB,IAAM,iBAAiB,GAAG,UACxB,aAA4B,EAC5B,IAAY,EACZ,EAAU;QAEV,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YAC9B,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC3B;IACH,CAAC,CAAC;IACF,EAAE,CAAC,8DAA8D,EAAE;QACjE,IAAM,WAAW,GAAG,EAAE,CAAC;QACvB,IAAM,IAAI,GAAG,GAAG,CAAC;QACjB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAM,WAAW,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;QAEjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE;YAC7B,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;SACrC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,KAAK,WAAW,EAAnB,CAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0BAA0B,EAAE;QAC7B,qFAAqF;QACrF,IAAM,IAAI,GAAG,GAAG,CAAC;QACjB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAM,WAAW,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;QACjD,iBAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAEzC,6BAA6B;QAC7B,IAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAClC,UAAC,GAAG,EAAE,GAAG;YACP,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC;gBACf,GAAG,CAAC,KAAK,EAAE,CAAC;aACb;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CACrB,CAAC;QAEF,gFAAgF;QAChF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CACjD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAC5C,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sCAAsC,EAAE;QACzC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,iBAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAEvD,iBAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE;QACtC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE;QACtC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClD,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iCAAiC,EAAE;QACpC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC5B,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SACxD;QACD,IAAM,cAAc,GAAG,IAAI,6BAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC5B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SACzD;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"AverageWindow.test.js","sourceRoot":"","sources":["../../src/__tests__/AverageWindow.test.ts"],"names":[],"mappings":";;AAAA,wDAA+E;AAE/E,QAAQ,CAAC,eAAe,EAAE;IACxB,IAAM,iBAAiB,GAAG,UACxB,aAA4B,EAC5B,IAAY,EACZ,EAAU;QAEV,KAAK,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YAC9B,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;SAC3B;IACH,CAAC,CAAC;IACF,EAAE,CAAC,8DAA8D,EAAE;QACjE,IAAM,WAAW,GAAG,EAAE,CAAC;QACvB,IAAM,IAAI,GAAG,GAAG,CAAC;QACjB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAM,WAAW,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;QAEjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE;YAC7B,aAAa,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;SACrC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACjE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,UAAC,GAAG,IAAK,OAAA,GAAG,KAAK,WAAW,EAAnB,CAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0BAA0B,EAAE;QAC7B,qFAAqF;QACrF,IAAM,IAAI,GAAG,GAAG,CAAC;QACjB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAM,WAAW,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;QACjD,iBAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QAEzC,6BAA6B;QAC7B,IAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAClC,UAAC,GAAG,EAAE,GAAG;YACP,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC;gBACf,GAAG,CAAC,KAAK,EAAE,CAAC;aACb;YACD,OAAO,GAAG,CAAC;QACb,CAAC,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CACrB,CAAC;QAEF,gFAAgF;QAChF,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CACjD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAC5C,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sCAAsC,EAAE;QACzC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,iBAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;QACzC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;QAEvD,iBAAiB,CAAC,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACxC,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE;QACtC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE;QACtC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAClD,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC3B,MAAM,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iCAAiC,EAAE;QACpC,IAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAM,aAAa,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;QAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC5B,MAAM,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SACxD;QACD,IAAM,cAAc,GAAG,IAAI,6BAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAClD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE;YAC5B,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;SACzD;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,wBAAwB,EAAE;IACjC,EAAE,CAAC,uDAAuD,EAAE;QAC1D,IAAM,UAAU,GAAG,EAAE,CAAC;QACtB,IAAM,sBAAsB,GAAG,IAAI,sCAAsB,CAAC,UAAU,CAAC,CAAC;QAEtE,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7C,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAE7C,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE;QACnD,IAAM,UAAU,GAAG,CAAC,CAAC;QACrB,IAAM,sBAAsB,GAAG,IAAI,sCAAsB,CAAC,UAAU,CAAC,CAAC;QAEtE,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7C,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7C,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAE7C,sBAAsB,CAAC,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5C,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAE7C,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE;QAC3C,IAAM,UAAU,GAAG,CAAC,CAAC;QACrB,IAAM,sBAAsB,GAAG,IAAI,sCAAsB,CAAC,UAAU,CAAC,CAAC;QAEtE,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE;QAC9B,IAAM,UAAU,GAAG,CAAC,CAAC;QACrB,IAAM,sBAAsB,GAAG,IAAI,sCAAsB,CAAC,UAAU,CAAC,CAAC;QAEtE,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7C,sBAAsB,CAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;QAE7C,sBAAsB,CAAC,KAAK,EAAE,CAAC;QAE/B,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChE,MAAM,CAAC,sBAAsB,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/enableNewCore.d.ts

@@ -0,0 +1,3 @@
+export declare function enableNewCore(enable: boolean): void;
+export declare function isNewCoreEnabled(): boolean;
+//# sourceMappingURL=enableNewCore.d.ts.map

package/dist/enableNewCore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enableNewCore.d.ts","sourceRoot":"","sources":["../src/enableNewCore.ts"],"names":[],"mappings":"AACA,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,QAE5C;AAED,wBAAgB,gBAAgB,YAE/B"}

package/dist/enableNewCore.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNewCoreEnabled = exports.enableNewCore = void 0;
+var useNewCore;
+function enableNewCore(enable) {
+    useNewCore = enable;
+}
+exports.enableNewCore = enableNewCore;
+function isNewCoreEnabled() {
+    return useNewCore !== null && useNewCore !== void 0 ? useNewCore : isReactNativeNewArchitecture();
+}
+exports.isNewCoreEnabled = isNewCoreEnabled;
+function isReactNativeNewArchitecture() {
+    try {
+        // Check for Fabric UI Manager
+        var hasFabricUIManager = Boolean(global === null || global === void 0 ? void 0 : global.nativeFabricUIManager);
+        // Check for TurboModule system
+        var hasTurboModule = Boolean(global === null || global === void 0 ? void 0 : global.__turboModuleProxy);
+        return hasFabricUIManager || hasTurboModule;
+    }
+    catch (_a) {
+        return false;
+    }
+}
+//# sourceMappingURL=enableNewCore.js.map

package/dist/enableNewCore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enableNewCore.js","sourceRoot":"","sources":["../src/enableNewCore.ts"],"names":[],"mappings":";;;AAAA,IAAI,UAA+B,CAAC;AACpC,SAAgB,aAAa,CAAC,MAAe;IAC3C,UAAU,GAAG,MAAM,CAAC;AACtB,CAAC;AAFD,sCAEC;AAED,SAAgB,gBAAgB;IAC9B,OAAO,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,4BAA4B,EAAE,CAAC;AACtD,CAAC;AAFD,4CAEC;AAED,SAAS,4BAA4B;IACnC,IAAI;QACF,8BAA8B;QAC9B,IAAM,kBAAkB,GAAG,OAAO,CAAE,MAAc,aAAd,MAAM,uBAAN,MAAM,CAAU,qBAAqB,CAAC,CAAC;QAE3E,+BAA+B;QAC/B,IAAM,cAAc,GAAG,OAAO,CAAE,MAAc,aAAd,MAAM,uBAAN,MAAM,CAAU,kBAAkB,CAAC,CAAC;QAEpE,OAAO,kBAAkB,IAAI,cAAc,CAAC;KAC7C;IAAC,WAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC"}

package/dist/index.d.ts

@@ -7,8 +7,13 @@ export { useDataMultiplier } from "./benchmark/useDataMultiplier";
 export { useFlatListBenchmark, FlatListBenchmarkParams, } from "./benchmark/useFlatListBenchmark";
 export { useBlankAreaTracker, BlankAreaTrackerResult, BlankAreaTrackerConfig, } from "./benchmark/useBlankAreaTracker";
 export { MasonryFlashList, MasonryFlashListProps, MasonryFlashListScrollEvent, MasonryFlashListRef, MasonryListItem, MasonryListRenderItem, MasonryListRenderItemInfo, } from "./MasonryFlashList";
+export { useLayoutState } from "./recyclerview/hooks/useLayoutState";
+export { useRecyclingState } from "./recyclerview/hooks/useRecyclingState";
 export { JSFPSMonitor, JSFPSResult } from "./benchmark/JSFPSMonitor";
 export { autoScroll, Cancellable } from "./benchmark/AutoScrollHelper";
 export { default as ViewToken } from "./viewability/ViewToken";
 export { default as CellContainer } from "./native/cell-container/CellContainer";
+export { RecyclerView } from "./recyclerview/RecyclerView";
+export { RecyclerViewProps } from "./recyclerview/RecyclerViewProps";
+export { useRecyclerViewContext } from "./recyclerview/RecyclerViewContextProvider";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,cAAc,GACf,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,eAAe,GAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EACL,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,uCAAuC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,aAAa,CAAC;AACnD,OAAO,EACL,cAAc,EACd,YAAY,EACZ,cAAc,EACd,kBAAkB,EAClB,YAAY,EACZ,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EACL,0BAA0B,EAC1B,qBAAqB,EACrB,cAAc,GACf,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,eAAe,EACf,eAAe,GAChB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EACL,oBAAoB,EACpB,uBAAuB,GACxB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,gBAAgB,EAChB,qBAAqB,EACrB,2BAA2B,EAC3B,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,yBAAyB,GAC1B,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAC;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAC3E,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACrE,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,aAAa,EAAE,MAAM,uCAAuC,CAAC;AACjF,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AACrE,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC"}

package/dist/index.js

@@ -1,15 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CellContainer = exports.Cancellable = exports.autoScroll = exports.JSFPSMonitor = exports.MasonryFlashList = exports.useBlankAreaTracker = exports.useFlatListBenchmark = exports.useDataMultiplier = exports.useBenchmark = exports.useOnNativeBlankAreaEvents = exports.AnimatedFlashList = exports.RenderTargetOptions = exports.FlashList = void 0;
-var FlashList_1 = require("./FlashList");
-Object.defineProperty(exports, "FlashList", { enumerable: true, get: function () { return __importDefault(FlashList_1).default; } });
+exports.useRecyclerViewContext = exports.RecyclerView = exports.CellContainer = exports.Cancellable = exports.autoScroll = exports.JSFPSMonitor = exports.useRecyclingState = exports.useLayoutState = exports.MasonryFlashList = exports.useBlankAreaTracker = exports.useFlatListBenchmark = exports.useDataMultiplier = exports.useBenchmark = exports.useOnNativeBlankAreaEvents = exports.AnimatedFlashList = exports.RenderTargetOptions = exports.FlashList = void 0;
+var tslib_1 = require("tslib");
+var FlashList_1 = tslib_1.__importDefault(require("./FlashList"));
+var enableNewCore_1 = require("./enableNewCore");
+var RecyclerView_1 = require("./recyclerview/RecyclerView");
+// Keep this unmodified for TS type checking
+var FlashList_2 = require("./FlashList");
+Object.defineProperty(exports, "FlashList", { enumerable: true, get: function () { return tslib_1.__importDefault(FlashList_2).default; } });
 var FlashListProps_1 = require("./FlashListProps");
 Object.defineProperty(exports, "RenderTargetOptions", { enumerable: true, get: function () { return FlashListProps_1.RenderTargetOptions; } });
 var AnimatedFlashList_1 = require("./AnimatedFlashList");
-Object.defineProperty(exports, "AnimatedFlashList", { enumerable: true, get: function () { return __importDefault(AnimatedFlashList_1).default; } });
+Object.defineProperty(exports, "AnimatedFlashList", { enumerable: true, get: function () { return tslib_1.__importDefault(AnimatedFlashList_1).default; } });
 var AutoLayoutView_1 = require("./native/auto-layout/AutoLayoutView");
 Object.defineProperty(exports, "useOnNativeBlankAreaEvents", { enumerable: true, get: function () { return AutoLayoutView_1.useOnNativeBlankAreaEvents; } });
 var useBenchmark_1 = require("./benchmark/useBenchmark");
@@ -22,11 +24,29 @@ var useBlankAreaTracker_1 = require("./benchmark/useBlankAreaTracker");
 Object.defineProperty(exports, "useBlankAreaTracker", { enumerable: true, get: function () { return useBlankAreaTracker_1.useBlankAreaTracker; } });
 var MasonryFlashList_1 = require("./MasonryFlashList");
 Object.defineProperty(exports, "MasonryFlashList", { enumerable: true, get: function () { return MasonryFlashList_1.MasonryFlashList; } });
+var useLayoutState_1 = require("./recyclerview/hooks/useLayoutState");
+Object.defineProperty(exports, "useLayoutState", { enumerable: true, get: function () { return useLayoutState_1.useLayoutState; } });
+var useRecyclingState_1 = require("./recyclerview/hooks/useRecyclingState");
+Object.defineProperty(exports, "useRecyclingState", { enumerable: true, get: function () { return useRecyclingState_1.useRecyclingState; } });
 var JSFPSMonitor_1 = require("./benchmark/JSFPSMonitor");
 Object.defineProperty(exports, "JSFPSMonitor", { enumerable: true, get: function () { return JSFPSMonitor_1.JSFPSMonitor; } });
 var AutoScrollHelper_1 = require("./benchmark/AutoScrollHelper");
 Object.defineProperty(exports, "autoScroll", { enumerable: true, get: function () { return AutoScrollHelper_1.autoScroll; } });
 Object.defineProperty(exports, "Cancellable", { enumerable: true, get: function () { return AutoScrollHelper_1.Cancellable; } });
 var CellContainer_1 = require("./native/cell-container/CellContainer");
-Object.defineProperty(exports, "CellContainer", { enumerable: true, get: function () { return __importDefault(CellContainer_1).default; } });
+Object.defineProperty(exports, "CellContainer", { enumerable: true, get: function () { return tslib_1.__importDefault(CellContainer_1).default; } });
+var RecyclerView_2 = require("./recyclerview/RecyclerView");
+Object.defineProperty(exports, "RecyclerView", { enumerable: true, get: function () { return RecyclerView_2.RecyclerView; } });
+var RecyclerViewContextProvider_1 = require("./recyclerview/RecyclerViewContextProvider");
+Object.defineProperty(exports, "useRecyclerViewContext", { enumerable: true, get: function () { return RecyclerViewContextProvider_1.useRecyclerViewContext; } });
+// @ts-ignore - This is ignored by TypeScript but will be present in the compiled JS
+// In the compiled JS, this will override the previous FlashList export with a conditional one
+if (typeof module !== "undefined" && module.exports) {
+    Object.defineProperty(module.exports, "FlashList", {
+        get: function () {
+            return (0, enableNewCore_1.isNewCoreEnabled)() ? RecyclerView_1.RecyclerView : FlashList_1.default;
+        },
+        configurable: true,
+    });
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,yCAAmD;AAA1C,uHAAA,OAAO,OAAa;AAC7B,mDAO0B;AADxB,qHAAA,mBAAmB,OAAA;AAErB,yDAAmE;AAA1D,uIAAA,OAAO,OAAqB;AACrC,sEAI6C;AAH3C,4HAAA,0BAA0B,OAAA;AAI5B,yDAIkC;AAHhC,4GAAA,YAAY,OAAA;AAId,mEAAkE;AAAzD,sHAAA,iBAAiB,OAAA;AAC1B,yEAG0C;AAFxC,4HAAA,oBAAoB,OAAA;AAGtB,uEAIyC;AAHvC,0HAAA,mBAAmB,OAAA;AAIrB,uDAQ4B;AAP1B,oHAAA,gBAAgB,OAAA;AAQlB,yDAAqE;AAA5D,4GAAA,YAAY,OAAA;AACrB,iEAAuE;AAA9D,8GAAA,UAAU,OAAA;AAAE,+GAAA,WAAW,OAAA;AAEhC,uEAAiF;AAAxE,+HAAA,OAAO,OAAiB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,kEAA2D;AAC3D,iDAAmD;AACnD,4DAA2D;AAE3D,4CAA4C;AAC5C,yCAAmD;AAA1C,+HAAA,OAAO,OAAa;AAC7B,mDAO0B;AADxB,qHAAA,mBAAmB,OAAA;AAErB,yDAAmE;AAA1D,+IAAA,OAAO,OAAqB;AACrC,sEAI6C;AAH3C,4HAAA,0BAA0B,OAAA;AAI5B,yDAIkC;AAHhC,4GAAA,YAAY,OAAA;AAId,mEAAkE;AAAzD,sHAAA,iBAAiB,OAAA;AAC1B,yEAG0C;AAFxC,4HAAA,oBAAoB,OAAA;AAGtB,uEAIyC;AAHvC,0HAAA,mBAAmB,OAAA;AAIrB,uDAQ4B;AAP1B,oHAAA,gBAAgB,OAAA;AAQlB,sEAAqE;AAA5D,gHAAA,cAAc,OAAA;AACvB,4EAA2E;AAAlE,sHAAA,iBAAiB,OAAA;AAC1B,yDAAqE;AAA5D,4GAAA,YAAY,OAAA;AACrB,iEAAuE;AAA9D,8GAAA,UAAU,OAAA;AAAE,+GAAA,WAAW,OAAA;AAEhC,uEAAiF;AAAxE,uIAAA,OAAO,OAAiB;AACjC,4DAA2D;AAAlD,4GAAA,YAAY,OAAA;AAErB,0FAAoF;AAA3E,qIAAA,sBAAsB,OAAA;AAE/B,oFAAoF;AACpF,8FAA8F;AAC9F,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,MAAM,CAAC,OAAO,EAAE;IACnD,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE;QACjD,GAAG,EAAE;YACH,OAAO,IAAA,gCAAgB,GAAE,CAAC,CAAC,CAAC,2BAAY,CAAC,CAAC,CAAC,mBAAiB,CAAC;QAC/D,CAAC;QACD,YAAY,EAAE,IAAI;KACnB,CAAC,CAAC;CACJ"}

package/dist/recyclerview/RecycleKeyManager.d.ts

@@ -0,0 +1,82 @@
+export interface RecycleKeyManager {
+    /**
+     * Retrieves a unique key for an item type, maintaining a separate pool for each type.
+     * If a stableId is provided and exists, returns the associated key.
+     * Otherwise, generates a new key or reuses one from the pool.
+     * @param itemType - The type/category of the item (e.g., 'header', 'product', 'footer')
+     * @param stableId - Optional unique identifier for stable item tracking
+     * @param currentKey - Optional current key to maintain if it exists in the pool
+     * @returns A unique key for the item
+     */
+    getKey: (itemType: string, stableId: string, currentKey?: string) => string;
+    /**
+     * Recycles a key back into its item type's pool when the associated view is no longer visible.
+     * This allows the key to be reused for new items of the same type.
+     * @param key - The key to be recycled back into the pool
+     */
+    recycleKey: (key: string) => void;
+    /**
+     * Checks if a key is currently available in the recycling pool (not in use).
+     * @param key - The key to check
+     * @returns True if the key is available in the pool, false otherwise
+     */
+    hasKeyInPool: (key: string) => boolean;
+    /**
+     * Clears all recycled keys from the pool, resetting the recycling system.
+     * This is useful when the list needs to be completely reset.
+     */
+    clearPool: () => void;
+}
+export declare class RecycleKeyManagerImpl implements RecycleKeyManager {
+    private maxItems;
+    private keyPools;
+    private keyMap;
+    private stableIdMap;
+    private keyCounter;
+    /**
+     * Creates a new RecycleKeyManager with a specified maximum number of items.
+     * @param maxItems - Maximum number of unique keys that can be active simultaneously.
+     *                   Defaults to Number.MAX_SAFE_INTEGER if not specified.
+     */
+    constructor(maxItems?: number);
+    /**
+     * Gets a key for the specified item type, prioritizing stable ID associations.
+     * If a stable ID exists, returns its associated key. Otherwise, either reuses
+     * a key from the pool or generates a new one.
+     * @param itemType - The type/category of the item
+     * @param stableId - Optional unique identifier for stable item tracking
+     * @param currentKey - Optional current key to maintain if it exists in the pool
+     * @returns A unique key for the item
+     */
+    getKey(itemType: string, stableId: string, currentKey?: string): string;
+    /**
+     * Recycles a key by adding it back to its item type's pool and cleaning up
+     * associated mappings. This should be called when a view is no longer visible.
+     * @param key - The key to be recycled
+     */
+    recycleKey(key: string): void;
+    /**
+     * Checks if a key is currently available in the recycling pool.
+     * @param key - The key to check
+     * @returns True if the key is available in the pool, false otherwise
+     */
+    hasKeyInPool(key: string): boolean;
+    /**
+     * Clears all recycled keys from the pool, effectively resetting the recycling system.
+     * This operation does not affect currently active keys.
+     */
+    clearPool(): void;
+    /**
+     * Generates a unique sequential key using an internal counter.
+     * @returns A unique key as a string
+     */
+    private generateKey;
+    /**
+     * Ensures the total number of active keys doesn't exceed the maximum limit.
+     * If the limit is exceeded, recycles the oldest keys until within bounds.
+     * Note: This operation may impact performance when dealing with large lists.
+     * TODO: Check performance impact of this
+     */
+    private ensurePoolSize;
+}
+//# sourceMappingURL=RecycleKeyManager.d.ts.map

package/dist/recyclerview/RecycleKeyManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecycleKeyManager.d.ts","sourceRoot":"","sources":["../../src/recyclerview/RecycleKeyManager.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC;;;;;;;;OAQG;IACH,MAAM,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,KAAK,MAAM,CAAC;IAE5E;;;;OAIG;IACH,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IAElC;;;;OAIG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;IAEvC;;;OAGG;IACH,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB;AAED,qBAAa,qBAAsB,YAAW,iBAAiB;IAE7D,OAAO,CAAC,QAAQ,CAAS;IAGzB,OAAO,CAAC,QAAQ,CAA2B;IAG3C,OAAO,CAAC,MAAM,CAAuD;IAGrE,OAAO,CAAC,WAAW,CAAsB;IAGzC,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;OAIG;gBACS,QAAQ,GAAE,MAAgC;IAQtD;;;;;;;;OAQG;IACI,MAAM,CACX,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,EAChB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM;IAsCT;;;;OAIG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAwBpC;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAIzC;;;OAGG;IACI,SAAS;IAIhB;;;OAGG;IACH,OAAO,CAAC,WAAW;IAInB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;CAWvB"}