update: better type naming and support.

Author: ItzNotABug

src/lib/stores/preferences.ts

@@ -8,27 +8,30 @@ import { page } from '$app/state';
 import { user } from '$lib/stores/user';
 import deepEqual from 'deep-equal';
 
-type Preferences = {
+type ConsolePreferences = {
     limit?: number;
     view?: View;
     columns?: string[];
-};
+} /* support a strict + flexible preference type for TS compatibility */ & Record<
+    string,
+    string | number | boolean | object | null | unknown
+>;
 
 type TeamPreferences = {
     names?: string[];
 };
 
-type PreferencesStore = {
-    [key: string]: Preferences;
+type ConsolePreferencesStore = {
+    [key: string]: ConsolePreferences;
     collections?: {
-        [key: string]: Preferences['columns'];
+        [key: string]: ConsolePreferences['columns'];
     };
     displayNames?: {
         [key: string]: TeamPreferences['names'];
     };
 } & { hideAiDisclaimer?: boolean };
 
-async function updateConsolePreferences(store: PreferencesStore): Promise<void> {
+async function updateConsolePreferences(store: ConsolePreferencesStore): Promise<void> {
     const currentPreferences = get(user)?.prefs ?? (await sdk.forConsole.account.getPrefs());
     if (!currentPreferences?.console || Array.isArray(currentPreferences.console)) {
         currentPreferences.console = {};
@@ -43,8 +46,8 @@ async function updateConsolePreferences(store: PreferencesStore): Promise<void>
 }
 
 function createPreferences() {
-    const { subscribe, set, update } = writable<PreferencesStore>({});
-    let preferences: PreferencesStore = {};
+    const { subscribe, set, update } = writable<ConsolePreferencesStore>({});
+    let preferences: ConsolePreferencesStore = {};
 
     if (browser) {
         // fresh fetch.
@@ -73,9 +76,9 @@ function createPreferences() {
     /**
      * Update the local store and then synchronizes them on user prefs.
      */
-    function updateAndSync(callback: (prefs: PreferencesStore) => void): Promise<void> {
-        let oldPrefsSnapshot: PreferencesStore;
-        let newPrefsSnapshot: PreferencesStore;
+    function updateAndSync(callback: (prefs: ConsolePreferencesStore) => void): Promise<void> {
+        let oldPrefsSnapshot: ConsolePreferencesStore;
+        let newPrefsSnapshot: ConsolePreferencesStore;
 
         update((currentPrefs) => {
             oldPrefsSnapshot = structuredClone(currentPrefs);
@@ -96,7 +99,7 @@ function createPreferences() {
         subscribe,
         set,
         update,
-        get: (route?: Page['route']): Preferences => {
+        get: (route?: Page['route']): ConsolePreferences => {
             const parsedRoute = route ?? page.route;
             return (
                 preferences?.[parsedRoute.id] ?? {
@@ -106,10 +109,10 @@ function createPreferences() {
                 }
             );
         },
-        getCustomCollectionColumns: (collectionId: string): Preferences['columns'] => {
+        getCustomCollectionColumns: (collectionId: string): ConsolePreferences['columns'] => {
             return preferences?.collections?.[collectionId] ?? [];
         },
-        setLimit: (limit: Preferences['limit']) =>
+        setLimit: (limit: ConsolePreferences['limit']) =>
             updateAndSync((n) => {
                 const path = page.route.id;
 
@@ -122,7 +125,7 @@ function createPreferences() {
 
                 return n;
             }),
-        setView: (view: Preferences['view']) =>
+        setView: (view: ConsolePreferences['view']) =>
             updateAndSync((n) => {
                 const path = page.route.id;
 
@@ -135,7 +138,7 @@ function createPreferences() {
 
                 return n;
             }),
-        setColumns: (columns: Preferences['columns']) =>
+        setColumns: (columns: ConsolePreferences['columns']) =>
             updateAndSync((n) => {
                 const path = page.route.id;
 
@@ -148,7 +151,10 @@ function createPreferences() {
 
                 return n;
             }),
-        setCustomCollectionColumns: (collectionId: string, columns: Preferences['columns']) =>
+        setCustomCollectionColumns: (
+            collectionId: string,
+            columns: ConsolePreferences['columns']
+        ) =>
             updateAndSync((n) => {
                 if (!n?.collections?.[collectionId]) {
                     n ??= {};
@@ -159,7 +165,7 @@ function createPreferences() {
                 return n;
             }),
         loadTeamPrefs: async (id: string) => {
-            const teamPrefs: Preferences = await sdk.forConsole.teams.getPrefs(id);
+            const teamPrefs = await sdk.forConsole.teams.getPrefs(id);
             update((n) => {
                 n[id] = teamPrefs;
                 return n;