mirror of
https://github.com/wukko/cobalt.git
synced 2025-03-14 21:28:51 +01:00
web/settings: types for preparation for future migrations
This commit is contained in:
parent
66bac03e30
commit
4e4f7af437
3 changed files with 21 additions and 12 deletions
|
@ -1,15 +1,15 @@
|
|||
import { derived, readable, type Updater } from 'svelte/store';
|
||||
import { merge } from 'ts-deepmerge';
|
||||
|
||||
import type { RecursivePartial } from '../types/generic';
|
||||
import type { CobaltSettings } from '../types/settings';
|
||||
import type {
|
||||
CobaltSettings,
|
||||
PartialSettings,
|
||||
AllPartialSettingsWithSchema
|
||||
} from '../types/settings';
|
||||
|
||||
import { migrateOldSettings } from '../settings/migrate';
|
||||
import defaultSettings from '../settings/defaults';
|
||||
|
||||
type PartialSettings = RecursivePartial<CobaltSettings>;
|
||||
type PartialSettingsWithSchema = RecursivePartial<CobaltSettings> & { schemaVersion: number };
|
||||
|
||||
const updatePlausiblePreference = (settings: PartialSettings) => {
|
||||
if (settings.privacy?.disableAnalytics) {
|
||||
localStorage.setItem('plausible_ignore', 'true');
|
||||
|
@ -27,18 +27,18 @@ const writeToStorage = (settings: PartialSettings) => {
|
|||
return settings;
|
||||
}
|
||||
|
||||
type Migrator = (s: PartialSettings) => PartialSettings;
|
||||
type Migrator = (s: AllPartialSettingsWithSchema) => AllPartialSettingsWithSchema;
|
||||
const migrations: Record<number, Migrator> = {
|
||||
|
||||
}
|
||||
|
||||
const migrate = (settings: PartialSettingsWithSchema) => {
|
||||
const migrate = (settings: AllPartialSettingsWithSchema): PartialSettings => {
|
||||
return Object.keys(migrations)
|
||||
.map(Number)
|
||||
.filter(version => version > settings.schemaVersion)
|
||||
.reduce((settings, migrationVersion) => {
|
||||
return migrations[migrationVersion](settings);
|
||||
}, settings as PartialSettings);
|
||||
}, settings as AllPartialSettingsWithSchema);
|
||||
}
|
||||
|
||||
const loadFromStorage = () => {
|
||||
|
@ -52,7 +52,7 @@ const loadFromStorage = () => {
|
|||
return {};
|
||||
}
|
||||
|
||||
const parsed = JSON.parse(settings) as PartialSettingsWithSchema;
|
||||
const parsed = JSON.parse(settings) as AllPartialSettingsWithSchema;
|
||||
if (parsed.schemaVersion < defaultSettings.schemaVersion) {
|
||||
return migrate(parsed);
|
||||
}
|
||||
|
|
|
@ -8,4 +8,4 @@ export type RecursivePartial<Type> = {
|
|||
};
|
||||
|
||||
export type DefaultImport<T> = () => Promise<{ default: T }>;
|
||||
export type Optional<T> = T | undefined;
|
||||
export type Optional<T> = T | undefined;
|
||||
|
|
|
@ -1,4 +1,5 @@
|
|||
import languages from '$i18n/languages.json';
|
||||
import type { RecursivePartial } from './generic';
|
||||
|
||||
export const themeOptions = ["auto", "light", "dark"] as const;
|
||||
export const audioFormatOptions = ["best", "mp3", "ogg", "wav", "opus"] as const;
|
||||
|
@ -37,12 +38,20 @@ type CobaltSettingsSave = {
|
|||
youtubeDubBrowserLang: boolean,
|
||||
};
|
||||
|
||||
export type CobaltSettings = {
|
||||
schemaVersion: number,
|
||||
export type CurrentCobaltSettings = {
|
||||
schemaVersion: 2,
|
||||
advanced: CobaltSettingsAdvanced,
|
||||
appearance: CobaltSettingsAppearance,
|
||||
save: CobaltSettingsSave,
|
||||
privacy: CobaltSettingsPrivacy
|
||||
};
|
||||
|
||||
export type CobaltSettings = CurrentCobaltSettings;
|
||||
|
||||
export type PartialSettings = RecursivePartial<CobaltSettings>;
|
||||
export type PartialSettingsWithSchema = RecursivePartial<CobaltSettings> & { schemaVersion: number };
|
||||
|
||||
export type AllSchemaVersions = CurrentCobaltSettings;
|
||||
export type AllPartialSettingsWithSchema = RecursivePartial<CobaltSettings> & { schemaVersion: number };
|
||||
|
||||
export type DownloadModeOption = CobaltSettings['save']['downloadMode'];
|
||||
|
|
Loading…
Reference in a new issue