PaperlessUiSettings data object

src-ui/src/app/services/document-list-view.service.ts

@@ -8,9 +8,10 @@ import {
 } from '../data/filter-rule'
 import { PaperlessDocument } from '../data/paperless-document'
 import { PaperlessSavedView } from '../data/paperless-saved-view'
+import { SETTINGS_KEYS } from '../data/paperless-uisettings'
 import { DOCUMENT_LIST_SERVICE } from '../data/storage-keys'
 import { DocumentService, DOCUMENT_SORT_FIELDS } from './rest/document.service'
-import { SettingsService, SETTINGS_KEYS } from './settings.service'
+import { SettingsService } from './settings.service'
 
 /**
  * Captures the current state of the list view.

src-ui/src/app/services/settings.service.ts

@@ -17,15 +17,13 @@ import {
   hexToHsl,
 } from 'src/app/utils/color'
 import { environment } from 'src/environments/environment'
-import { Results } from '../data/results'
+import {
+  PaperlessUiSettings,
+  SETTINGS,
+  SETTINGS_KEYS,
+} from '../data/paperless-uisettings'
 import { ToastService } from './toast.service'
 
-export interface PaperlessSettings {
-  key: string
-  type: string
-  default: any
-}
-
 export interface LanguageOption {
   code: string
   name: string
@@ -37,108 +35,6 @@ export interface LanguageOption {
   dateInputFormat?: string
 }
 
-export const SETTINGS_KEYS = {
-  LANGUAGE: 'language',
-  // maintain old general-settings: for backwards compatibility
-  BULK_EDIT_CONFIRMATION_DIALOGS:
-    'general-settings:bulk-edit:confirmation-dialogs',
-  BULK_EDIT_APPLY_ON_CLOSE: 'general-settings:bulk-edit:apply-on-close',
-  DOCUMENT_LIST_SIZE: 'general-settings:documentListSize',
-  DARK_MODE_USE_SYSTEM: 'general-settings:dark-mode:use-system',
-  DARK_MODE_ENABLED: 'general-settings:dark-mode:enabled',
-  DARK_MODE_THUMB_INVERTED: 'general-settings:dark-mode:thumb-inverted',
-  THEME_COLOR: 'general-settings:theme:color',
-  USE_NATIVE_PDF_VIEWER: 'general-settings:document-details:native-pdf-viewer',
-  DATE_LOCALE: 'general-settings:date-display:date-locale',
-  DATE_FORMAT: 'general-settings:date-display:date-format',
-  NOTIFICATIONS_CONSUMER_NEW_DOCUMENT:
-    'general-settings:notifications:consumer-new-documents',
-  NOTIFICATIONS_CONSUMER_SUCCESS:
-    'general-settings:notifications:consumer-success',
-  NOTIFICATIONS_CONSUMER_FAILED:
-    'general-settings:notifications:consumer-failed',
-  NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD:
-    'general-settings:notifications:consumer-suppress-on-dashboard',
-}
-
-const SETTINGS: PaperlessSettings[] = [
-  {
-    key: SETTINGS_KEYS.LANGUAGE,
-    type: 'string',
-    default: '',
-  },
-  {
-    key: SETTINGS_KEYS.BULK_EDIT_CONFIRMATION_DIALOGS,
-    type: 'boolean',
-    default: true,
-  },
-  {
-    key: SETTINGS_KEYS.BULK_EDIT_APPLY_ON_CLOSE,
-    type: 'boolean',
-    default: false,
-  },
-  {
-    key: SETTINGS_KEYS.DOCUMENT_LIST_SIZE,
-    type: 'number',
-    default: 50,
-  },
-  {
-    key: SETTINGS_KEYS.DARK_MODE_USE_SYSTEM,
-    type: 'boolean',
-    default: true,
-  },
-  {
-    key: SETTINGS_KEYS.DARK_MODE_ENABLED,
-    type: 'boolean',
-    default: false,
-  },
-  {
-    key: SETTINGS_KEYS.DARK_MODE_THUMB_INVERTED,
-    type: 'boolean',
-    default: true,
-  },
-  {
-    key: SETTINGS_KEYS.THEME_COLOR,
-    type: 'string',
-    default: '',
-  },
-  {
-    key: SETTINGS_KEYS.USE_NATIVE_PDF_VIEWER,
-    type: 'boolean',
-    default: false,
-  },
-  {
-    key: SETTINGS_KEYS.DATE_LOCALE,
-    type: 'string',
-    default: '',
-  },
-  {
-    key: SETTINGS_KEYS.DATE_FORMAT,
-    type: 'string',
-    default: 'mediumDate',
-  },
-  {
-    key: SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_NEW_DOCUMENT,
-    type: 'boolean',
-    default: true,
-  },
-  {
-    key: SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUCCESS,
-    type: 'boolean',
-    default: true,
-  },
-  {
-    key: SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_FAILED,
-    type: 'boolean',
-    default: true,
-  },
-  {
-    key: SETTINGS_KEYS.NOTIFICATIONS_CONSUMER_SUPPRESS_ON_DASHBOARD,
-    type: 'boolean',
-    default: true,
-  },
-]
-
 @Injectable({
   providedIn: 'root',
 })
@@ -161,10 +57,10 @@ export class SettingsService {
   }
 
   // this is called by the app initializer in app.module
-  public initializeSettings(): Observable<Results<any>> {
-    let settings$ = this.http.get<Results<any>>(this.baseUrl)
-    settings$.pipe(first()).subscribe((response) => {
-      Object.assign(this.settings, response['settings'])
+  public initializeSettings(): Observable<PaperlessUiSettings> {
+    let settings$ = this.http.get<PaperlessUiSettings>(this.baseUrl)
+    settings$.pipe(first()).subscribe((uisettings) => {
+      Object.assign(this.settings, uisettings.settings)
       this.maybeMigrateSettings()
     })
     return settings$