react-native-onyx 2.0.19 → 2.0.21

package/dist/DevTools.d.ts

@@ -1,23 +1,41 @@
-declare const _default: DevTools;
-export default _default;
+type DevtoolsOptions = {
+    maxAge?: number;
+    name?: string;
+    postTimelineUpdate?: () => void;
+    preAction?: () => void;
+    logTrace?: boolean;
+    remote?: boolean;
+};
+type DevtoolsSubscriber = (message: {
+    type: string;
+    payload: unknown;
+    state: string;
+}) => void;
+type DevtoolsConnection = {
+    send(data: Record<string, unknown>, state: Record<string, unknown>): void;
+    init(state: Record<string, unknown>): void;
+    unsubscribe(): void;
+    subscribe(cb: DevtoolsSubscriber): () => void;
+};
 declare class DevTools {
-    remoteDev: any;
-    state: {};
-    defaultState: {};
-    connectViaExtension(options: any): any;
+    private remoteDev?;
+    private state;
+    private defaultState;
+    constructor();
+    connectViaExtension(options?: DevtoolsOptions): DevtoolsConnection | undefined;
     /**
      * Registers an action that updated the current state of the storage
      *
-     * @param {string} type - name of the action
-     * @param {any} payload - data written to the storage
-     * @param {object} stateChanges - partial state that got updated after the changes
+     * @param type - name of the action
+     * @param payload - data written to the storage
+     * @param stateChanges - partial state that got updated after the changes
      */
-    registerAction(type: string, payload?: any, stateChanges?: object): void;
-    initState(initialState?: {}): void;
+    registerAction(type: string, payload: unknown, stateChanges?: Record<string, unknown>): void;
+    initState(initialState?: Record<string, unknown>): void;
     /**
      * This clears the internal state of the DevTools, preserving the keys included in `keysToPreserve`
-     *
-     * @param {string[]} keysToPreserve
      */
     clearState(keysToPreserve?: string[]): void;
 }
+declare const _default: DevTools;
+export default _default;

package/dist/DevTools.js

@@ -1,11 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const underscore_1 = __importDefault(require("underscore"));
 const ERROR_LABEL = 'Onyx DevTools - Error: ';
-/* eslint-disable no-underscore-dangle */
 class DevTools {
     constructor() {
         this.remoteDev = this.connectViaExtension();
@@ -14,10 +9,14 @@ class DevTools {
     }
     connectViaExtension(options) {
         try {
-            if ((options && options.remote) || typeof window === 'undefined' || !window.__REDUX_DEVTOOLS_EXTENSION__) {
+            // We don't want to augment the window type in a library code, so we use type assertion instead
+            // eslint-disable-next-line no-underscore-dangle, @typescript-eslint/no-explicit-any
+            const reduxDevtools = window.__REDUX_DEVTOOLS_EXTENSION__;
+            if ((options && options.remote) || typeof window === 'undefined' || !reduxDevtools) {
                 return;
             }
-            return window.__REDUX_DEVTOOLS_EXTENSION__.connect(options);
+            // eslint-disable-next-line no-underscore-dangle, @typescript-eslint/no-explicit-any
+            return reduxDevtools.connect(options);
         }
         catch (e) {
             console.error(ERROR_LABEL, e);
@@ -26,11 +25,11 @@ class DevTools {
     /**
      * Registers an action that updated the current state of the storage
      *
-     * @param {string} type - name of the action
-     * @param {any} payload - data written to the storage
-     * @param {object} stateChanges - partial state that got updated after the changes
+     * @param type - name of the action
+     * @param payload - data written to the storage
+     * @param stateChanges - partial state that got updated after the changes
      */
-    registerAction(type, payload = undefined, stateChanges = {}) {
+    registerAction(type, payload, stateChanges = {}) {
         try {
             if (!this.remoteDev) {
                 return;
@@ -58,11 +57,13 @@ class DevTools {
     }
     /**
      * This clears the internal state of the DevTools, preserving the keys included in `keysToPreserve`
-     *
-     * @param {string[]} keysToPreserve
      */
     clearState(keysToPreserve = []) {
-        const newState = underscore_1.default.mapObject(this.state, (value, key) => (keysToPreserve.includes(key) ? value : this.defaultState[key]));
+        const newState = Object.entries(this.state).reduce((obj, [key, value]) => {
+            // eslint-disable-next-line no-param-reassign
+            obj[key] = keysToPreserve.includes(key) ? value : this.defaultState[key];
+            return obj;
+        }, {});
         this.registerAction('CLEAR', undefined, newState);
     }
 }

package/dist/Onyx.js

@@ -165,12 +165,12 @@ function get(key) {
 /**
  * Returns current key names stored in persisted storage
  * @private
- * @returns {Promise<string[]>}
+ * @returns {Promise<Set<Key>>}
  */
 function getAllKeys() {
     // When we've already read stored keys, resolve right away
     const storedKeys = OnyxCache_1.default.getAllKeys();
-    if (storedKeys.length > 0) {
+    if (storedKeys.size > 0) {
         return Promise.resolve(storedKeys);
     }
     const taskName = 'getAllKeys';
@@ -181,7 +181,8 @@ function getAllKeys() {
     // Otherwise retrieve the keys from storage and capture a promise to aid concurrent usages
     const promise = storage_1.default.getAllKeys().then((keys) => {
         OnyxCache_1.default.setAllKeys(keys);
-        return keys;
+        // return the updated set of keys
+        return OnyxCache_1.default.getAllKeys();
     });
     return OnyxCache_1.default.captureTask(taskName, promise);
 }
@@ -252,10 +253,16 @@ function tryGetCachedValue(key, mapping = {}) {
         const allCacheKeys = OnyxCache_1.default.getAllKeys();
         // It is possible we haven't loaded all keys yet so we do not know if the
         // collection actually exists.
-        if (allCacheKeys.length === 0) {
+        if (allCacheKeys.size === 0) {
             return;
         }
-        const matchingKeys = underscore_1.default.filter(allCacheKeys, (k) => k.startsWith(key));
+        const matchingKeys = [];
+        allCacheKeys.forEach((k) => {
+            if (!k.startsWith(key)) {
+                return;
+            }
+            matchingKeys.push(k);
+        });
         const values = underscore_1.default.reduce(matchingKeys, (finalObject, matchedKey) => {
             const cachedValue = OnyxCache_1.default.getValue(matchedKey);
             if (cachedValue) {
@@ -342,7 +349,7 @@ function addToEvictionBlockList(key, connectionID) {
 function addAllSafeEvictionKeysToRecentlyAccessedList() {
     return getAllKeys().then((keys) => {
         underscore_1.default.each(evictionAllowList, (safeEvictionKey) => {
-            underscore_1.default.each(keys, (key) => {
+            keys.forEach((key) => {
                 if (!isKeyMatch(safeEvictionKey, key)) {
                     return;
                 }
@@ -357,7 +364,13 @@ function addAllSafeEvictionKeysToRecentlyAccessedList() {
  * @returns {Object}
  */
 function getCachedCollection(collectionKey) {
-    const collectionMemberKeys = underscore_1.default.filter(OnyxCache_1.default.getAllKeys(), (storedKey) => isCollectionMemberKey(collectionKey, storedKey));
+    const collectionMemberKeys = [];
+    OnyxCache_1.default.getAllKeys().forEach((storedKey) => {
+        if (!isCollectionMemberKey(collectionKey, storedKey)) {
+            return;
+        }
+        collectionMemberKeys.push(storedKey);
+    });
     return underscore_1.default.reduce(collectionMemberKeys, (prev, curr) => {
         const cachedValue = OnyxCache_1.default.getValue(curr);
         if (!cachedValue) {
@@ -821,7 +834,13 @@ function connect(mapping) {
         // We search all the keys in storage to see if any are a "match" for the subscriber we are connecting so that we
         // can send data back to the subscriber. Note that multiple keys can match as a subscriber could either be
         // subscribed to a "collection key" or a single key.
-        const matchingKeys = underscore_1.default.filter(keys, (key) => isKeyMatch(mapping.key, key));
+        const matchingKeys = [];
+        keys.forEach((key) => {
+            if (!isKeyMatch(mapping.key, key)) {
+                return;
+            }
+            matchingKeys.push(key);
+        });
         // If the key being connected to does not exist we initialize the value with null. For subscribers that connected
         // directly via connect() they will simply get a null value sent to them without any information about which key matched
         // since there are none matched. In withOnyx() we wait for all connected keys to return a value before rendering the child
@@ -1241,7 +1260,7 @@ function clear(keysToPreserve = []) {
         //      status, or activeClients need to remain in Onyx even when signed out)
         // 2. Any keys with a default state (because they need to remain in Onyx as their default, and setting them
         //      to null would cause unknown behavior)
-        underscore_1.default.each(keys, (key) => {
+        keys.forEach((key) => {
             const isKeyToPreserve = underscore_1.default.contains(keysToPreserve, key);
             const isDefaultKey = underscore_1.default.has(defaultKeyStates, key);
             // If the key is being removed or reset to default:
@@ -1336,7 +1355,7 @@ function mergeCollection(collectionKey, collection) {
             return true;
         })
             .keys()
-            .partition((key) => persistedKeys.includes(key))
+            .partition((key) => persistedKeys.has(key))
             .value();
         const existingKeyCollection = underscore_1.default.pick(collection, existingKeys);
         const newCollection = underscore_1.default.pick(collection, newKeys);

package/dist/OnyxCache.d.ts

@@ -20,7 +20,7 @@ declare class OnyxCache {
     private maxRecentKeysSize;
     constructor();
     /** Get all the storage keys */
-    getAllKeys(): Key[];
+    getAllKeys(): Set<Key>;
     /**
      * Get a cached value from storage
      * @param [shouldReindexCache] – This is an LRU cache, and by default accessing a value will make it become last in line to be evicted. This flag can be used to skip that and just access the value directly without side-effects.

package/dist/OnyxCache.js

@@ -23,7 +23,7 @@ class OnyxCache {
     }
     /** Get all the storage keys */
     getAllKeys() {
-        return Array.from(this.storageKeys);
+        return this.storageKeys;
     }
     /**
      * Get a cached value from storage

package/dist/index.d.ts

@@ -1,23 +1,8 @@
-import Onyx, {OnyxUpdate, ConnectOptions} from './Onyx';
-import {CustomTypeOptions, OnyxCollection, OnyxEntry, NullishDeep, KeyValueMapping, OnyxKey, Selector, WithOnyxInstanceState, OnyxValue} from './types';
+import Onyx from './Onyx';
+import type { OnyxUpdate, ConnectOptions } from './Onyx';
+import type { CustomTypeOptions, OnyxCollection, OnyxEntry, NullishDeep, KeyValueMapping, OnyxKey, Selector, WithOnyxInstanceState } from './types';
+import useOnyx from './useOnyx';
 import withOnyx from './withOnyx';
-import useOnyx, {UseOnyxResult, FetchStatus} from './useOnyx';
-
 export default Onyx;
-export {
-    CustomTypeOptions,
-    OnyxCollection,
-    OnyxEntry,
-    OnyxUpdate,
-    withOnyx,
-    ConnectOptions,
-    NullishDeep,
-    KeyValueMapping,
-    OnyxKey,
-    Selector,
-    WithOnyxInstanceState,
-    useOnyx,
-    UseOnyxResult,
-    OnyxValue,
-    FetchStatus,
-};
+export { withOnyx, useOnyx };
+export type { CustomTypeOptions, OnyxCollection, OnyxEntry, OnyxUpdate, ConnectOptions, NullishDeep, KeyValueMapping, OnyxKey, Selector, WithOnyxInstanceState };

package/dist/index.js

@@ -5,8 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useOnyx = exports.withOnyx = void 0;
 const Onyx_1 = __importDefault(require("./Onyx"));
-const withOnyx_1 = __importDefault(require("./withOnyx"));
-exports.withOnyx = withOnyx_1.default;
 const useOnyx_1 = __importDefault(require("./useOnyx"));
 exports.useOnyx = useOnyx_1.default;
+const withOnyx_1 = __importDefault(require("./withOnyx"));
+exports.withOnyx = withOnyx_1.default;
 exports.default = Onyx_1.default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "2.0.19",
+  "version": "2.0.21",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",

package/dist/MDTable.d.ts

@@ -1,36 +0,0 @@
-export default MDTable;
-declare class MDTable {
-    /**
-     * Create a CSV string from the table data
-     * @returns {string}
-     */
-    toCSV(): string;
-    /**
-     * Create a JSON string from the table data
-     * @returns {string}
-     */
-    toJSON(): string;
-    /**
-     * Create a MD string from the table data
-     * @returns {string}
-     */
-    toString(): string;
-}
-declare namespace MDTable {
-    /**
-     * Table Factory helper
-     * @param {Object} options
-     * @param {string} [options.title] - optional title center above the table
-     * @param {string[]} options.heading - table column names
-     * @param {number[]} [options.leftAlignedCols=[]] - indexes of columns that should be left aligned
-     * Pass the columns that are non numeric here - the rest will be aligned to the right
-     * @param {Array} [options.rows] The table can be initialized with row. Rows can also be added by `addRow`
-     * @returns {MDTable}
-     */
-    function factory({ title, heading, leftAlignedCols, rows }: {
-        title?: string | undefined;
-        heading: string[];
-        leftAlignedCols?: number[] | undefined;
-        rows?: any[] | undefined;
-    }): MDTable;
-}

package/dist/MDTable.js

@@ -1,61 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ascii_table_1 = __importDefault(require("ascii-table"));
-class MDTable extends ascii_table_1.default {
-    /**
-     * Create a CSV string from the table data
-     * @returns {string}
-     */
-    toCSV() {
-        return [this.getTitle(), this.getHeading(), ...this.getRows()].join('\n');
-    }
-    /**
-     * Create a JSON string from the table data
-     * @returns {string}
-     */
-    toJSON() {
-        return JSON.stringify(super.toJSON());
-    }
-    /**
-     * Create a MD string from the table data
-     * @returns {string}
-     */
-    toString() {
-        // Ignore modifying the first |---| for titled tables
-        let idx = this.getTitle() ? -2 : -1;
-        const ascii = super.toString().replace(/-\|/g, () => {
-            /* we replace "----|" with "---:|" to align the data to the right in MD */
-            idx++;
-            if (idx < 0 || this.leftAlignedCols.includes(idx)) {
-                return '-|';
-            }
-            return ':|';
-        });
-        // strip the top and the bottom row (----) to make an MD table
-        const md = ascii.split('\n').slice(1, -1).join('\n');
-        return md;
-    }
-}
-/**
- * Table Factory helper
- * @param {Object} options
- * @param {string} [options.title] - optional title center above the table
- * @param {string[]} options.heading - table column names
- * @param {number[]} [options.leftAlignedCols=[]] - indexes of columns that should be left aligned
- * Pass the columns that are non numeric here - the rest will be aligned to the right
- * @param {Array} [options.rows] The table can be initialized with row. Rows can also be added by `addRow`
- * @returns {MDTable}
- */
-MDTable.factory = ({ title, heading, leftAlignedCols = [], rows = [] }) => {
-    const table = new MDTable({ title, heading, rows });
-    table.leftAlignedCols = leftAlignedCols;
-    /* By default we want everything aligned to the right as most values are numbers
-     * we just override the columns that are not right aligned */
-    heading.forEach((name, idx) => table.setAlign(idx, ascii_table_1.default.RIGHT));
-    leftAlignedCols.forEach((idx) => table.setAlign(idx, ascii_table_1.default.LEFT));
-    return table;
-};
-exports.default = MDTable;