Merge pull request #505 from blazejkustra/ts/dev-tools-and-more

[TS migration] Migrate DevTools to TS, clean other files

lib/DevTools.ts

@@ -0,0 +1,104 @@
+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;
+};
+
+const ERROR_LABEL = 'Onyx DevTools - Error: ';
+
+type ReduxDevtools = {
+    connect(options?: DevtoolsOptions): DevtoolsConnection;
+};
+
+class DevTools {
+    private remoteDev?: DevtoolsConnection;
+
+    private state: Record<string, unknown>;
+
+    private defaultState: Record<string, unknown>;
+
+    constructor() {
+        this.remoteDev = this.connectViaExtension();
+        this.state = {};
+        this.defaultState = {};
+    }
+
+    connectViaExtension(options?: DevtoolsOptions): DevtoolsConnection | undefined {
+        try {
+            // 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: ReduxDevtools = (window as any).__REDUX_DEVTOOLS_EXTENSION__;
+
+            if ((options && options.remote) || typeof window === 'undefined' || !reduxDevtools) {
+                return;
+            }
+            // eslint-disable-next-line no-underscore-dangle, @typescript-eslint/no-explicit-any
+            return reduxDevtools.connect(options);
+        } catch (e) {
+            console.error(ERROR_LABEL, e);
+        }
+    }
+
+    /**
+     * Registers an action that updated the current state of the storage
+     *
+     * @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: unknown, stateChanges: Record<string, unknown> = {}) {
+        try {
+            if (!this.remoteDev) {
+                return;
+            }
+            const newState = {
+                ...this.state,
+                ...stateChanges,
+            };
+            this.remoteDev.send({type, payload}, newState);
+            this.state = newState;
+        } catch (e) {
+            console.error(ERROR_LABEL, e);
+        }
+    }
+
+    initState(initialState: Record<string, unknown> = {}) {
+        try {
+            if (!this.remoteDev) {
+                return;
+            }
+            this.remoteDev.init(initialState);
+            this.state = initialState;
+            this.defaultState = initialState;
+        } catch (e) {
+            console.error(ERROR_LABEL, e);
+        }
+    }
+
+    /**
+     * This clears the internal state of the DevTools, preserving the keys included in `keysToPreserve`
+     */
+    public clearState(keysToPreserve: string[] = []): void {
+        const newState = Object.entries(this.state).reduce((obj: Record<string, unknown>, [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);
+    }
+}
+
+export default new DevTools();

lib/index.ts

@@ -0,0 +1,9 @@
+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';
+
+export default Onyx;
+export {withOnyx, useOnyx};
+export type {CustomTypeOptions, OnyxCollection, OnyxEntry, OnyxUpdate, ConnectOptions, NullishDeep, KeyValueMapping, OnyxKey, Selector, WithOnyxInstanceState};