user-settings-context.tsx 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. import {
  2. createContext,
  3. useContext,
  4. useMemo,
  5. Dispatch,
  6. SetStateAction,
  7. FC,
  8. useState,
  9. useEffect,
  10. } from 'react'
  11. import { UserSettings } from '../../../../types/user-settings'
  12. import getMeta from '@/utils/meta'
  13. import customLocalStorage from '@/infrastructure/local-storage'
  14. import { getLegacyWriteAndCiteMigration } from '../utils/write-and-cite-settings-migration'
  15. import { saveUserSettings } from '@/features/editor-left-menu/utils/api'
  16. export const defaultSettings: UserSettings = {
  17. pdfViewer: 'pdfjs',
  18. autoComplete: true,
  19. autoPairDelimiters: true,
  20. syntaxValidation: false,
  21. editorTheme: 'textmate',
  22. editorDarkTheme: 'overleaf_dark',
  23. editorLightTheme: 'textmate',
  24. overallTheme: '',
  25. mode: 'default',
  26. fontSize: 12,
  27. fontFamily: 'monaco',
  28. lineHeight: 'normal',
  29. mathPreview: true,
  30. referencesSearchMode: 'advanced',
  31. breadcrumbs: true,
  32. darkModePdf: false,
  33. zotero: {
  34. enabled: true,
  35. groups: [],
  36. disablePersonalLibrary: false,
  37. },
  38. mendeley: {
  39. enabled: true,
  40. groups: [],
  41. disablePersonalLibrary: false,
  42. },
  43. papers: {
  44. enabled: true,
  45. groups: [],
  46. disablePersonalLibrary: false,
  47. },
  48. }
  49. type UserSettingsContextValue = {
  50. userSettings: UserSettings
  51. setUserSettings: Dispatch<
  52. SetStateAction<UserSettingsContextValue['userSettings']>
  53. >
  54. }
  55. export const UserSettingsContext = createContext<
  56. UserSettingsContextValue | undefined
  57. >(undefined)
  58. export const UserSettingsProvider: FC<React.PropsWithChildren> = ({
  59. children,
  60. }) => {
  61. const [userSettings, setUserSettings] = useState<UserSettings>(
  62. () => getMeta('ol-userSettings') || defaultSettings
  63. )
  64. useEffect(() => {
  65. const { patch, keysToRemove } = getLegacyWriteAndCiteMigration(userSettings)
  66. if (keysToRemove.length === 0) {
  67. return
  68. }
  69. if (Object.keys(patch).length === 0) {
  70. keysToRemove.forEach(customLocalStorage.removeItem)
  71. return
  72. }
  73. Promise.all(
  74. Object.entries(patch).map(([key, value]) =>
  75. saveUserSettings(
  76. key as keyof Pick<UserSettings, 'mendeley' | 'zotero' | 'papers'>,
  77. value
  78. )
  79. )
  80. ).then(() => {
  81. setUserSettings(currentSettings => ({
  82. ...currentSettings,
  83. ...patch,
  84. }))
  85. keysToRemove.forEach(customLocalStorage.removeItem)
  86. })
  87. // Only run once when the provider mounts
  88. // eslint-disable-next-line react-hooks/exhaustive-deps
  89. }, [])
  90. const value = useMemo<UserSettingsContextValue>(
  91. () => ({
  92. userSettings,
  93. setUserSettings,
  94. }),
  95. [userSettings, setUserSettings]
  96. )
  97. return (
  98. <UserSettingsContext.Provider value={value}>
  99. {children}
  100. </UserSettingsContext.Provider>
  101. )
  102. }
  103. export function useUserSettingsContext() {
  104. const context = useContext(UserSettingsContext)
  105. if (!context) {
  106. throw new Error(
  107. 'useUserSettingsContext is only available inside UserSettingsProvider'
  108. )
  109. }
  110. return context
  111. }