react-native-onyx 2.0.18 → 2.0.20

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

@@ -180,7 +180,7 @@ function getAllKeys() {
     }
     // Otherwise retrieve the keys from storage and capture a promise to aid concurrent usages
     const promise = storage_1.default.getAllKeys().then((keys) => {
-        underscore_1.default.each(keys, (key) => OnyxCache_1.default.addKey(key));
+        OnyxCache_1.default.setAllKeys(keys);
         return keys;
     });
     return OnyxCache_1.default.captureTask(taskName, promise);

package/dist/OnyxCache.d.ts

@@ -44,6 +44,18 @@ declare class OnyxCache {
      * @param data - a map of (cache) key - values
      */
     merge(data: StorageMap): void;
+    /**
+     * Allows to set all the keys at once.
+     * This is useful when we are getting
+     * all the keys from the storage provider
+     * and we want to keep the cache in sync.
+     *
+     * Previously, we had to call `addKey` in a loop
+     * to achieve the same result.
+     *
+     * @param keys - an array of keys
+     */
+    setAllKeys(keys: Key[]): void;
     /**
      * Check whether the given task is already running
      * @param taskName - unique name given for the task

package/dist/OnyxCache.js

@@ -19,7 +19,7 @@ class OnyxCache {
         this.storageMap = {};
         this.pendingPromises = new Map();
         // bind all public methods to prevent problems with `this`
-        (0, bindAll_1.default)(this, 'getAllKeys', 'getValue', 'hasCacheForKey', 'addKey', 'set', 'drop', 'merge', 'hasPendingTask', 'getTaskPromise', 'captureTask', 'removeLeastRecentlyUsedKeys', 'setRecentKeysLimit');
+        (0, bindAll_1.default)(this, 'getAllKeys', 'getValue', 'hasCacheForKey', 'addKey', 'set', 'drop', 'merge', 'hasPendingTask', 'getTaskPromise', 'captureTask', 'removeLeastRecentlyUsedKeys', 'setRecentKeysLimit', 'setAllKeys');
     }
     /** Get all the storage keys */
     getAllKeys() {
@@ -75,6 +75,20 @@ class OnyxCache {
         this.storageKeys = new Set([...storageKeys, ...mergedKeys]);
         mergedKeys.forEach((key) => this.addToAccessedKeys(key));
     }
+    /**
+     * Allows to set all the keys at once.
+     * This is useful when we are getting
+     * all the keys from the storage provider
+     * and we want to keep the cache in sync.
+     *
+     * Previously, we had to call `addKey` in a loop
+     * to achieve the same result.
+     *
+     * @param keys - an array of keys
+     */
+    setAllKeys(keys) {
+        this.storageKeys = new Set(keys);
+    }
     /**
      * Check whether the given task is already running
      * @param taskName - unique name given for the task

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.18",
+  "version": "2.0.20",
   "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;