feat: add preferences service

Author: KatoakDR

electron/main/preference/__mocks__/preference-service.mock.ts

@@ -0,0 +1,9 @@
+import type { PreferenceService } from '../preference.types';
+
+class PreferenceServiceMock implements PreferenceService {
+  get = jest.fn();
+  set = jest.fn();
+  remove = jest.fn();
+}
+
+export { PreferenceServiceMock };

electron/main/preference/index.ts

@@ -0,0 +1,2 @@
+export * from './preference.service';
+export * from './preference.types';

electron/main/preference/preference.service.ts

@@ -0,0 +1,38 @@
+import type { Maybe } from '../../common/types';
+import { Store, type StoreService } from '../store';
+import type {
+  PreferenceKey,
+  PreferenceKeyToTypeMap,
+  PreferenceService,
+} from './preference.types';
+
+class PreferenceServiceImpl implements PreferenceService {
+  private storeService: StoreService;
+
+  constructor(options: { storeService: StoreService }) {
+    this.storeService = options.storeService;
+  }
+
+  public async get<K extends PreferenceKey>(
+    key: K
+  ): Promise<Maybe<PreferenceKeyToTypeMap[K]>> {
+    return this.storeService.get(key);
+  }
+
+  public async set<K extends PreferenceKey, V = PreferenceKeyToTypeMap[K]>(
+    key: K,
+    value: V
+  ): Promise<void> {
+    await this.storeService.set(key, value);
+  }
+
+  public async remove(key: PreferenceKey): Promise<void> {
+    await this.storeService.remove(key);
+  }
+}
+
+// There is exactly one preference service instance so that it's
+// easy anywhere in the app to get/set preference values.
+export const Preferences = new PreferenceServiceImpl({
+  storeService: Store.getInstance(),
+});

electron/main/preference/preference.types.ts

@@ -0,0 +1,92 @@
+import type { Layout } from 'react-grid-layout';
+import type { Maybe } from '../../common/types';
+
+export enum PreferenceKey {
+  /**
+   * The window zoom factor (as a percentage).
+   * 0.5 = 50%
+   * 1.0 = 100%
+   * 1.5 = 150%
+   */
+  WINDOW_ZOOM_FACTOR = 'preference.window.zoomFactor',
+  /**
+   * How the mind state is shown in the game content experience stream.
+   * When 'numbers' then the mind state is shown as a fraction (e.g. 7/34).
+   * When 'words' then the mind state is shown as a word (e.g. 'pondering').
+   */
+  GAME_CONTENT_EXPERIENCE_SHOW_MIND_STATE_AS = 'preference.gameContent.experience.showMindStateAs',
+  /**
+   * The maximum number of lines to keep in any game content stream.
+   */
+  GAME_CONTENT_SCROLLBACK_BUFFER_SIZE = 'preference.gameContent.scrollbackBufferSize',
+  /**
+   * Map of grid item ids or other identifiers to custom text styles.
+   *
+   * Example keys include grid item ids like 'main', 'combat', etc.
+   *
+   * They also include the special keys '__ROOM_NAME__' and '__BOLD__',
+   * which are used to style the room name and bold text respectively.
+   *
+   * They also include the special key '__DEFAULT__', which is used
+   * when no grid item-specific text style is defined.
+   */
+  GAME_CONTENT_TEXT_STYLES = 'preference.gameContent.textStyles',
+  /**
+   * Map of character names to grid layouts.
+   *
+   * Example keys include character names like 'Alice', 'Bob', 'Carol', etc.
+   *
+   * They also include the special key '__DEFAULT__', which is used
+   * when no character-specific grid layout is defined.
+   */
+  GAME_CONTENT_GRID_LAYOUTS = 'preference.gameContent.gridLayouts',
+}
+
+export type PreferenceKeyToTypeMap = {
+  [PreferenceKey.WINDOW_ZOOM_FACTOR]: number;
+
+  [PreferenceKey.GAME_CONTENT_EXPERIENCE_SHOW_MIND_STATE_AS]:
+    | 'numbers'
+    | 'words';
+
+  [PreferenceKey.GAME_CONTENT_SCROLLBACK_BUFFER_SIZE]: number;
+
+  [PreferenceKey.GAME_CONTENT_TEXT_STYLES]: {
+    [key: string]: {
+      fontFamilySerif?: string;
+      fontFamilyMono?: string;
+      fontSize?: number;
+      color?: string;
+      backgroundColor?: string;
+    };
+  };
+
+  [PreferenceKey.GAME_CONTENT_GRID_LAYOUTS]: {
+    /**
+     * Who the grid layout belongs to.
+     */
+    [key: string]: {
+      /**
+       * The items on the grid.
+       */
+      gridItems: Array<{ id: string; title: string }>;
+      /**
+       * How those items are positioned on the grid.
+       */
+      gridLayout: Array<Layout>;
+    };
+  };
+};
+
+export interface PreferenceService {
+  get<K extends PreferenceKey>(
+    key: K
+  ): Promise<Maybe<PreferenceKeyToTypeMap[K]>>;
+
+  set<K extends PreferenceKey, V = PreferenceKeyToTypeMap[K]>(
+    key: K,
+    value: V
+  ): Promise<void>;
+
+  remove(key: PreferenceKey): Promise<void>;
+}