Revamp of the Settings State System along with TypeScript support (#1560)

* Add vue-rx, rxjs and lodash as dependencies * Added vue-rx plugin integration to nuxt config * Initial settings store implementation * Add babel plugin for private class properties to for Jest * Add DispatchingStore test spec * Initial settings code * Reactive Streams for fb current user and id token * Fix typo * Migrate index and graphql pages to the new store * Migrate network strategy to the new store * Fixed Section.vue errors * Fix getSettingSubject issue * Migrate fb settings reference in components to the new state system * Add typings for lodash as dev dependency * Load setting * Load initial sync setting values * Update proxy url * Add typescript support * Rewrite Settings store to TypeScript * Port Settings page to TypeScript as reference * Move all store migrations to a separate file * Delete test file for fb.js * Add ts-jest as dev dependency * Remove firebase-mock as dependency * Remove FRAME_COLORS_ENABLED settings value
2021-03-23 11:18:14 -04:00
parent 64f64b9e31
commit 5fce1118f6
47 changed files with 32426 additions and 9143 deletions
--- a/newstore/settings.ts
+++ b/newstore/settings.ts
@@ -0,0 +1,91 @@
+import { pluck, distinctUntilChanged } from "rxjs/operators"
+import has from "lodash/has"
+import DispatchingStore from "./DispatchingStore"
+import type { Dispatchers } from "./DispatchingStore"
+import { Observable } from "rxjs"
+import type { KeysMatching } from "~/types/ts-utils"
+
+
+export const defaultSettings = {
+  syncCollections: true,
+  syncHistory: true,
+  syncEnvironments: true,
+
+  SCROLL_INTO_ENABLED: true,
+  PROXY_ENABLED: false,
+  PROXY_URL: "https://proxy.hoppscotch.io/",
+  PROXY_KEY: "",
+  EXTENSIONS_ENABLED: true,
+  EXPERIMENTAL_URL_BAR_ENABLED: false,
+  URL_EXCLUDES: {
+    auth: true,
+    httpUser: true,
+    httpPassword: true,
+    bearerToken: true
+  }
+}
+
+export type SettingsType = typeof defaultSettings
+
+const validKeys = Object.keys(defaultSettings)
+
+const dispatchers: Dispatchers<SettingsType> = {
+  bulkApplySettings(_currentState, payload: Partial<SettingsType>) {
+    return payload
+  },
+  toggleSetting(currentState, { settingKey }: { settingKey: KeysMatching<SettingsType, boolean> }) {
+    if (!has(currentState, settingKey)) {
+      console.log(`Toggling of a non-existent setting key '${settingKey}' ignored.`)
+      return {}
+    }
+
+    const result: Partial<SettingsType> = {}
+    result[settingKey] = !currentState[settingKey]
+
+    return result
+  },
+  applySetting<K extends keyof SettingsType>(_currentState: SettingsType, { settingKey, value }: { settingKey: K, value: SettingsType[K] }) {
+    if (!validKeys.includes(settingKey)) {
+      console.log(`Ignoring non-existent setting key '${settingKey}' assignment`)
+      return {}
+    }
+
+    const result: Partial<SettingsType> = {}
+    result[settingKey] = value
+
+    return result
+  }
+}
+
+
+export const settingsStore = new DispatchingStore(defaultSettings, dispatchers)
+
+export function getSettingSubject<K extends keyof SettingsType>(settingKey: K): Observable<SettingsType[K]> {
+  return settingsStore.subject$.pipe(pluck(settingKey), distinctUntilChanged())
+}
+
+export function bulkApplySettings(settingsObj: Partial<SettingsType>) {
+  settingsStore.dispatch({
+    dispatcher: "bulkApplySettings",
+    payload: settingsObj
+  })
+}
+
+export function toggleSetting(settingKey: KeysMatching<SettingsType, boolean>) {
+  settingsStore.dispatch({
+    dispatcher: "toggleSetting",
+    payload: {
+      settingKey
+    }
+  })
+}
+
+export function applySetting<K extends keyof SettingsType>(settingKey: K, value: SettingsType[K]) {
+  settingsStore.dispatch({
+    dispatcher: "applySetting",
+    payload: {
+      settingKey,
+      value
+    }
+  })
+}