fix(Map): Refactored routes widget. Add loader for routes. Prepared for custom hubs

2025-12-12 02:35:42 +00:00 · 2025-04-24 12:46:08 +03:00
parent c9b366f3e2
commit 99d68dfc0e
27 changed files with 375 additions and 234 deletions
--- a/assets/js/hooks/Mapper/mapRootProvider/MapRootProvider.tsx
+++ b/assets/js/hooks/Mapper/mapRootProvider/MapRootProvider.tsx
@@ -1,5 +1,5 @@
 import { ContextStoreDataUpdate, useContextStore } from '@/hooks/Mapper/utils';
-import { createContext, Dispatch, ForwardedRef, forwardRef, SetStateAction, useContext, useEffect } from 'react';
+import { createContext, Dispatch, ForwardedRef, forwardRef, SetStateAction, useContext } from 'react';
 import {
  ActivitySummary,
  CommandLinkSignatureToSystem,
@@ -12,7 +12,6 @@ import {
 } from '@/hooks/Mapper/types';
 import { useCharactersCache, useComments, useMapRootHandlers } from '@/hooks/Mapper/mapRootProvider/hooks';
 import { WithChildren } from '@/hooks/Mapper/types/common.ts';
-import useLocalStorageState from 'use-local-storage-state';
 import {
  ToggleWidgetVisibility,
  useStoreWidgets,
@@ -20,6 +19,9 @@ import {
 } from '@/hooks/Mapper/mapRootProvider/hooks/useStoreWidgets.ts';
 import { WindowsManagerOnChange } from '@/hooks/Mapper/components/ui-kit/WindowManager';
 import { DetailedKill } from '../types/kills';
+import { InterfaceStoredSettings, RoutesType } from '@/hooks/Mapper/mapRootProvider/types.ts';
+import { DEFAULT_ROUTES_SETTINGS, STORED_INTERFACE_DEFAULT_VALUES } from '@/hooks/Mapper/mapRootProvider/constants.ts';
+import { useMapUserSettings } from '@/hooks/Mapper/mapRootProvider/hooks/useMapUserSettings.ts';

 export type MapRootData = MapUnionTypes & {
  selectedSystems: string[];
@@ -64,11 +66,6 @@ const INITIAL_DATA: MapRootData = {
  followingCharacterEveId: null,
 };

-export enum AvailableThemes {
-  default = 'default',
-  pathfinder = 'pathfinder',
-}
-
 export enum InterfaceStoredSettingsProps {
  isShowMenu = 'isShowMenu',
  isShowMinimap = 'isShowMinimap',
@@ -80,40 +77,28 @@ export enum InterfaceStoredSettingsProps {
  theme = 'theme',
 }

-export type InterfaceStoredSettings = {
-  isShowMenu: boolean;
-  isShowMinimap: boolean;
-  isShowKSpace: boolean;
-  isThickConnections: boolean;
-  isShowUnsplashedSignatures: boolean;
-  isShowBackgroundPattern: boolean;
-  isSoftBackground: boolean;
-  theme: AvailableThemes;
-};
-
-export const STORED_INTERFACE_DEFAULT_VALUES: InterfaceStoredSettings = {
-  isShowMenu: false,
-  isShowMinimap: true,
-  isShowKSpace: false,
-  isThickConnections: false,
-  isShowUnsplashedSignatures: false,
-  isShowBackgroundPattern: true,
-  isSoftBackground: false,
-  theme: AvailableThemes.default,
-};
-
 export interface MapRootContextProps {
  update: ContextStoreDataUpdate<MapRootData>;
  data: MapRootData;
  outCommand: OutCommandHandler;
-  interfaceSettings: InterfaceStoredSettings;
-  setInterfaceSettings: Dispatch<SetStateAction<InterfaceStoredSettings>>;
  windowsSettings: WindowStoreInfo;
  toggleWidgetVisibility: ToggleWidgetVisibility;
  updateWidgetSettings: WindowsManagerOnChange;
  resetWidgets: () => void;
  comments: UseCommentsData;
  charactersCache: UseCharactersCacheData;
+
+  /**
+   * !!!
+   * DO NOT PASS THIS PROP INTO COMPONENT
+   * !!!
+   * */
+  storedSettings: {
+    interfaceSettings: InterfaceStoredSettings;
+    setInterfaceSettings: Dispatch<SetStateAction<InterfaceStoredSettings>>;
+    settingsRoutes: RoutesType;
+    settingsRoutesUpdate: Dispatch<SetStateAction<RoutesType>>;
+  };
 }

 const MapRootContext = createContext<MapRootContextProps>({
@@ -121,8 +106,6 @@ const MapRootContext = createContext<MapRootContextProps>({
  data: { ...INITIAL_DATA },
  // @ts-ignore
  outCommand: async () => void 0,
-  interfaceSettings: STORED_INTERFACE_DEFAULT_VALUES,
-  setInterfaceSettings: () => null,
  comments: {
    loadComments: async () => {},
    comments: new Map(),
@@ -141,6 +124,12 @@ const MapRootContext = createContext<MapRootContextProps>({
    characters: new Map(),
    lastUpdateKey: 0,
  },
+  storedSettings: {
+    interfaceSettings: STORED_INTERFACE_DEFAULT_VALUES,
+    setInterfaceSettings: () => null,
+    settingsRoutes: DEFAULT_ROUTES_SETTINGS,
+    settingsRoutesUpdate: () => null,
+  },
 });

 type MapRootProviderProps = {
@@ -159,49 +148,25 @@ const MapRootHandlers = forwardRef(({ children }: WithChildren, fwdRef: Forwarde
 export const MapRootProvider = ({ children, fwdRef, outCommand }: MapRootProviderProps) => {
  const { update, ref } = useContextStore<MapRootData>({ ...INITIAL_DATA });

-  const [interfaceSettings, setInterfaceSettings] = useLocalStorageState<InterfaceStoredSettings>(
-    'window:interface:settings',
-    {
-      defaultValue: STORED_INTERFACE_DEFAULT_VALUES,
-    },
-  );
+  const storedSettings = useMapUserSettings();
+
  const { windowsSettings, toggleWidgetVisibility, updateWidgetSettings, resetWidgets } = useStoreWidgets();
  const comments = useComments({ outCommand });
  const charactersCache = useCharactersCache({ outCommand });

-  useEffect(() => {
-    let foundNew = false;
-    const newVals = Object.keys(STORED_INTERFACE_DEFAULT_VALUES).reduce((acc, x) => {
-      if (Object.keys(acc).includes(x)) {
-        return acc;
-      }
-
-      foundNew = true;
-
-      // @ts-ignore
-      return { ...acc, [x]: STORED_INTERFACE_DEFAULT_VALUES[x] };
-    }, interfaceSettings);
-
-    if (foundNew) {
-      setInterfaceSettings(newVals);
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, []);
-
  return (
    <MapRootContext.Provider
      value={{
        update,
        data: ref,
        outCommand,
-        setInterfaceSettings,
-        interfaceSettings,
        windowsSettings,
        updateWidgetSettings,
        toggleWidgetVisibility,
        resetWidgets,
        comments,
        charactersCache,
+        storedSettings,
      }}
    >
      <MapRootHandlers ref={fwdRef}>{children}</MapRootHandlers>
--- a/assets/js/hooks/Mapper/mapRootProvider/constants.ts
+++ b/assets/js/hooks/Mapper/mapRootProvider/constants.ts
@@ -0,0 +1,26 @@
+import { AvailableThemes, InterfaceStoredSettings, RoutesType } from '@/hooks/Mapper/mapRootProvider/types.ts';
+
+export const STORED_INTERFACE_DEFAULT_VALUES: InterfaceStoredSettings = {
+  isShowMenu: false,
+  isShowMinimap: true,
+  isShowKSpace: false,
+  isThickConnections: false,
+  isShowUnsplashedSignatures: false,
+  isShowBackgroundPattern: true,
+  isSoftBackground: false,
+  theme: AvailableThemes.default,
+};
+
+export const DEFAULT_ROUTES_SETTINGS: RoutesType = {
+  path_type: 'shortest',
+  include_mass_crit: true,
+  include_eol: true,
+  include_frig: true,
+  include_cruise: true,
+  include_thera: true,
+  avoid_wormholes: false,
+  avoid_pochven: false,
+  avoid_edencom: false,
+  avoid_triglavian: false,
+  avoid: [],
+};
--- a/assets/js/hooks/Mapper/mapRootProvider/hooks/useMapUserSettings.ts
+++ b/assets/js/hooks/Mapper/mapRootProvider/hooks/useMapUserSettings.ts
@@ -0,0 +1,39 @@
+import useLocalStorageState from 'use-local-storage-state';
+import { InterfaceStoredSettings, RoutesType } from '@/hooks/Mapper/mapRootProvider/types.ts';
+import { DEFAULT_ROUTES_SETTINGS, STORED_INTERFACE_DEFAULT_VALUES } from '@/hooks/Mapper/mapRootProvider/constants.ts';
+import { useActualizeSettings } from '@/hooks/Mapper/hooks';
+import { useEffect } from 'react';
+import { SESSION_KEY } from '@/hooks/Mapper/constants.ts';
+
+export const useMigrationRoutesSettingsV1 = (update: (upd: RoutesType) => void) => {
+  //TODO if current Date is more than 01.01.2026 - remove this hook.
+
+  useEffect(() => {
+    const items = localStorage.getItem(SESSION_KEY.routes);
+    if (items) {
+      update(JSON.parse(items));
+      localStorage.removeItem(SESSION_KEY.routes);
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+};
+
+export const useMapUserSettings = () => {
+  const [interfaceSettings, setInterfaceSettings] = useLocalStorageState<InterfaceStoredSettings>(
+    'window:interface:settings',
+    {
+      defaultValue: STORED_INTERFACE_DEFAULT_VALUES,
+    },
+  );
+
+  const [settingsRoutes, settingsRoutesUpdate] = useLocalStorageState<RoutesType>('window:interface:routes', {
+    defaultValue: DEFAULT_ROUTES_SETTINGS,
+  });
+
+  useActualizeSettings(STORED_INTERFACE_DEFAULT_VALUES, interfaceSettings, setInterfaceSettings);
+  useActualizeSettings(DEFAULT_ROUTES_SETTINGS, settingsRoutes, settingsRoutesUpdate);
+
+  useMigrationRoutesSettingsV1(settingsRoutesUpdate);
+
+  return { interfaceSettings, setInterfaceSettings, settingsRoutes, settingsRoutesUpdate };
+};
--- a/assets/js/hooks/Mapper/mapRootProvider/types.ts
+++ b/assets/js/hooks/Mapper/mapRootProvider/types.ts
@@ -0,0 +1,29 @@
+export enum AvailableThemes {
+  default = 'default',
+  pathfinder = 'pathfinder',
+}
+
+export type InterfaceStoredSettings = {
+  isShowMenu: boolean;
+  isShowMinimap: boolean;
+  isShowKSpace: boolean;
+  isThickConnections: boolean;
+  isShowUnsplashedSignatures: boolean;
+  isShowBackgroundPattern: boolean;
+  isSoftBackground: boolean;
+  theme: AvailableThemes;
+};
+
+export type RoutesType = {
+  path_type: 'shortest' | 'secure' | 'insecure';
+  include_mass_crit: boolean;
+  include_eol: boolean;
+  include_frig: boolean;
+  include_cruise: boolean;
+  include_thera: boolean;
+  avoid_wormholes: boolean;
+  avoid_pochven: boolean;
+  avoid_edencom: boolean;
+  avoid_triglavian: boolean;
+  avoid: number[];
+};