Merge pull request #193 from buggregator/improve/polish-settings-store

polish names of functions to sync with localstorage

Author: Kreezag

src/shared/stores/events/events-store.ts

@@ -2,7 +2,7 @@ import { defineStore } from "pinia";
 import {PAGE_TYPES} from "../../constants";
 import type { EventId, EventType , ServerEvent, TEventsGroup} from '../../types';
 import {EVENT_TYPES} from "../../types";
-import { getLockedIds, syncCachedIdsLocalStorage, syncLockedIdsLocalStorage, getCachedIds } from "./local-storage-actions";
+import { getStoredLockedIds, setStoredCachedIds, setStoredLockedIds, getStoredCachedIds } from "./local-storage-actions";
 import type {TEventsCachedIdsMap} from "./types";
 
 const MAX_EVENTS_COUNT = 500;
@@ -22,8 +22,8 @@ const initialCachedIds: TEventsCachedIdsMap = {
 export const useEventsStore = defineStore("eventsStore", {
   state: () => ({
     events: [] as ServerEvent<unknown>[],
-    cachedIds: getCachedIds() || initialCachedIds,
-    lockedIds: getLockedIds() || [],
+    cachedIds: getStoredCachedIds() || initialCachedIds,
+    lockedIds: getStoredLockedIds() || [],
   }),
   getters: {
     eventsCounts: ({events}) => (eventType: EVENT_TYPES | undefined): number => {
@@ -118,11 +118,11 @@ export const useEventsStore = defineStore("eventsStore", {
           this.cachedIds[cachedType].push(event.uuid);
         });
 
-      syncCachedIdsLocalStorage(this.cachedIds);
+      setStoredCachedIds(this.cachedIds);
     },
     removeCachedByType(type: TEventsGroup) {
       this.cachedIds[type].length = 0;
-      syncCachedIdsLocalStorage(this.cachedIds);
+      setStoredCachedIds(this.cachedIds);
     },
     removeCachedByIds(uuids: EventId[]) {
       this.cachedIdsTypesList.forEach((type) => {
@@ -131,14 +131,14 @@ export const useEventsStore = defineStore("eventsStore", {
         );
       });
 
-      syncCachedIdsLocalStorage(this.cachedIds);
+      setStoredCachedIds(this.cachedIds);
     },
     removeCachedById(eventUuid: EventId) {
       this.removeCachedByIds([eventUuid]);
     },
     removeCachedAll() {
       this.cachedIds = initialCachedIds;
-      syncCachedIdsLocalStorage(this.cachedIds);
+      setStoredCachedIds(this.cachedIds);
     },
     syncCachedWithActive(activeIds: EventId[]) {
       if (!activeIds.length) {
@@ -153,18 +153,18 @@ export const useEventsStore = defineStore("eventsStore", {
         );
       });
 
-      syncCachedIdsLocalStorage(this.cachedIds);
+      setStoredCachedIds(this.cachedIds);
     },
     // locked ids
     removeLockedIds(eventUuid: EventId) {
       this.lockedIds = this.lockedIds.filter((id) => id !== eventUuid);
 
-      syncLockedIdsLocalStorage(this.lockedIds);
+      setStoredLockedIds(this.lockedIds);
     },
     addLockedIds(eventUuid: EventId) {
       this.lockedIds.push(eventUuid);
 
-      syncLockedIdsLocalStorage(this.lockedIds);
+      setStoredLockedIds(this.lockedIds);
     }
   },
 });

src/shared/stores/events/local-storage-actions.ts

@@ -3,7 +3,7 @@ import type {TEventsCachedIdsMap} from "./types";
 
 const { localStorage } = window;
 
-export const getCachedIds = (): TEventsCachedIdsMap | null => {
+export const getStoredCachedIds = (): TEventsCachedIdsMap | null => {
   const storageValue = localStorage?.getItem(LOCAL_STORAGE_KEYS.CACHED_EVENTS);
 
   if (storageValue) {
@@ -13,12 +13,12 @@ export const getCachedIds = (): TEventsCachedIdsMap | null => {
   return null;
 };
 
-export const syncCachedIdsLocalStorage = (cachedEventMap: TEventsCachedIdsMap) => {
+export const setStoredCachedIds = (cachedEventMap: TEventsCachedIdsMap) => {
   localStorage?.setItem(LOCAL_STORAGE_KEYS.CACHED_EVENTS, JSON.stringify(cachedEventMap));
 }
 
 
-export const getLockedIds = (): EventId[] | null => {
+export const getStoredLockedIds = (): EventId[] | null => {
   const storageValue = localStorage?.getItem(LOCAL_STORAGE_KEYS.LOCKED_EVENTS);
 
   if (storageValue) {
@@ -28,6 +28,6 @@ export const getLockedIds = (): EventId[] | null => {
   return null;
 };
 
-export const syncLockedIdsLocalStorage = (lockedIds: EventId[]) => {
+export const setStoredLockedIds = (lockedIds: EventId[]) => {
   localStorage?.setItem(LOCAL_STORAGE_KEYS.LOCKED_EVENTS, JSON.stringify(lockedIds));
 }

src/shared/stores/settings/local-storage-actions.ts

@@ -1,7 +1,7 @@
 import {LOCAL_STORAGE_KEYS} from "../../types";
 import {THEME_MODES} from "./constants";
 
-export const checkIfThemeActive = () => {
+export const getStoredActiveTheme = () => {
   if (!process.client) {
     return THEME_MODES.LIGHT;
   }
@@ -20,7 +20,7 @@ export const checkIfThemeActive = () => {
   return THEME_MODES.LIGHT
 };
 
-export const syncThemeLocalStorage = (themeName: string) => {
+export const setStoredActiveTheme = (themeName: string) => {
   window?.localStorage.setItem(LOCAL_STORAGE_KEYS.THEME, themeName);
 
   if (themeName === THEME_MODES.LIGHT) {
@@ -30,7 +30,7 @@ export const syncThemeLocalStorage = (themeName: string) => {
   }
 }
 
-export const getFixedHeaderState = () => {
+export const getStoredFixedHeader = () => {
   if (!process.client) {
     return  false;
   }
@@ -48,7 +48,7 @@ export const getFixedHeaderState = () => {
   return isFixed;
 }
 
-export const syncFixedHeaderLocalStorage = (state: boolean) => {
+export const setStoredFixedHeader = (state: boolean) => {
   window?.localStorage.setItem(LOCAL_STORAGE_KEYS.NAVBAR, String(state));
 
   if (state) {
@@ -58,23 +58,23 @@ export const syncFixedHeaderLocalStorage = (state: boolean) => {
   }
 }
 
-export const getEventsCountVisibleState = (): boolean => {
+export const getStoredEventsCountVisibility = (): boolean => {
   const storageValue = window?.localStorage?.getItem(LOCAL_STORAGE_KEYS.EVENT_COUNTS) || "true";
 
   return storageValue === "true";
 };
 
-export const syncEventsCountVisibleLocalStorage = (state: boolean) => {
+export const setStoredEventsCountVisibility = (state: boolean) => {
   window?.localStorage?.setItem(LOCAL_STORAGE_KEYS.EVENT_COUNTS, String(state));
 }
 
 
-export const getActiveCodeEditorState = (): string => {
+export const getStoredPrimaryCodeEditor = (): string => {
   const storedCodeEditor = window?.localStorage?.getItem(LOCAL_STORAGE_KEYS.CODE_EDITOR);
 
   return storedCodeEditor || '';
 };
 
-export const setActiveCodeEditorState = (editor: string) => {
+export const setStoredPrimaryCodeEditor = (editor: string) => {
   window?.localStorage?.setItem(LOCAL_STORAGE_KEYS.CODE_EDITOR, editor);
 }

src/shared/stores/settings/settings-store.ts

@@ -3,12 +3,12 @@ import {useSettings} from "../../lib/use-settings";
 import type { TSettings } from "../../types";
 import {THEME_MODES} from "./constants";
 import {
-  getEventsCountVisibleState,
-  getFixedHeaderState,
-  checkIfThemeActive,
-  syncEventsCountVisibleLocalStorage,
-  syncFixedHeaderLocalStorage,
-  syncThemeLocalStorage, getActiveCodeEditorState, setActiveCodeEditorState,
+  getStoredEventsCountVisibility,
+  getStoredFixedHeader,
+  getStoredActiveTheme,
+  setStoredEventsCountVisibility,
+  setStoredFixedHeader,
+  setStoredActiveTheme, getStoredPrimaryCodeEditor, setStoredPrimaryCodeEditor,
 } from "./local-storage-actions";
 
 export const useSettingsStore = defineStore("settingsStore", {
@@ -18,10 +18,10 @@ export const useSettingsStore = defineStore("settingsStore", {
       isEnabled: false,
       loginUrl: '/login',
     },
-    codeEditor: getActiveCodeEditorState() || 'phpstorm',
-    themeType: checkIfThemeActive(),
-    isFixedHeader: getFixedHeaderState(),
-    isVisibleEventCounts: getEventsCountVisibleState(),
+    codeEditor: getStoredPrimaryCodeEditor() || 'phpstorm',
+    themeType: getStoredActiveTheme(),
+    isFixedHeader: getStoredFixedHeader(),
+    isVisibleEventCounts: getStoredEventsCountVisibility(),
   }),
   actions: {
     initialize() {
@@ -43,22 +43,22 @@ export const useSettingsStore = defineStore("settingsStore", {
         ? THEME_MODES.LIGHT
         : THEME_MODES.DARK;
 
-      syncThemeLocalStorage(this.themeType)
+      setStoredActiveTheme(this.themeType)
     },
     changeNavbar() {
       this.isFixedHeader = !this.isFixedHeader;
 
-      syncFixedHeaderLocalStorage(this.isFixedHeader)
+      setStoredFixedHeader(this.isFixedHeader)
     },
     changeEventCountsVisibility() {
       this.isVisibleEventCounts = !this.isVisibleEventCounts;
 
-      syncEventsCountVisibleLocalStorage(this.isVisibleEventCounts)
+      setStoredEventsCountVisibility(this.isVisibleEventCounts)
     },
     changeActiveCodeEditor(editor: string) {
       this.codeEditor = editor;
 
-      setActiveCodeEditorState(editor);
+      setStoredPrimaryCodeEditor(editor);
     }
   },
 });