Update electron-store and make the config strongly-typed

sindresorhus · Sep 9, 2019 · 7965b36 · 7965b36
1 parent a39b236
commit 7965b36
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 44 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
 	},
 	"main": "dist-js",
 	"engines": {
-		"node": ">=10"
+		"node": ">=12"
 	},
 	"scripts": {
 		"postinstall": "electron-builder install-app-deps",
@@ -30,7 +30,7 @@
 		"electron-dl": "^1.14.0",
 		"electron-localshortcut": "^3.1.0",
 		"electron-log": "^3.0.7",
-		"electron-store": "4.0.0",
+		"electron-store": "^5.0.0",
 		"electron-updater": "^4.0.14",
 		"electron-util": "^0.11.0",
 		"element-ready": "^4.1.0",

diff --git a/source/browser.ts b/source/browser.ts
@@ -339,7 +339,7 @@ ipc.on('zoom-reset', () => {
 });
 
 ipc.on('zoom-in', () => {
-	const zoomFactor = (config.get('zoomFactor') as number) + 0.1;
+	const zoomFactor = config.get('zoomFactor') + 0.1;
 
 	if (zoomFactor < 1.6) {
 		setZoom(zoomFactor);

diff --git a/source/config.ts b/source/config.ts
@@ -1,8 +1,46 @@
 import Store = require('electron-store');
 import {is} from 'electron-util';
-import {JSONSchema} from 'json-schema-typed';
 
-const schema: {[key: string]: JSONSchema} = {
+type StoreType = {
+	followSystemAppearance: boolean;
+	darkMode: boolean;
+	privateMode: boolean;
+	vibrancy: 'none' | 'sidebar' | 'full';
+	zoomFactor: number;
+	lastWindowState: {
+		x: number;
+		y: number;
+		width: number;
+		height: number;
+	};
+	menuBarMode: boolean;
+	showDockIcon: boolean;
+	showTrayIcon: boolean;
+	alwaysOnTop?: boolean;
+	bounceDockOnMessage: boolean;
+	showUnreadBadge: boolean;
+	showMessageButtons: boolean;
+	launchMinimized: boolean;
+	flashWindowOnMessage: boolean;
+	notificationMessagePreview: boolean;
+	block: {
+		chatSeen: boolean;
+		typingIndicator: boolean;
+		deliveryReceipt: boolean;
+	};
+	emojiStyle: 'native' | 'facebook-3-0' | 'messenger-1-0' | 'facebook-2-2';
+	confirmImagePaste: boolean;
+	useWorkChat: boolean;
+	sidebarHidden: boolean;
+	autoHideMenuBar: boolean;
+	notificationsMuted: boolean;
+	hardwareAcceleration: boolean;
+	quitOnWindowClose: boolean;
+	keepMeSignedIn: boolean;
+	autoplayVideos: boolean;
+};
+
+const schema: {[Key in keyof StoreType]: Store.Schema} = {
 	followSystemAppearance: {
 		type: 'boolean',
 		default: true
@@ -29,24 +67,24 @@ const schema: {[key: string]: JSONSchema} = {
 	lastWindowState: {
 		type: 'object',
 		properties: {
-			width: {
+			x: {
 				type: 'number'
 			},
-			height: {
+			y: {
 				type: 'number'
 			},
-			x: {
+			width: {
 				type: 'number'
 			},
-			y: {
+			height: {
 				type: 'number'
 			}
 		},
 		default: {
-			width: 800,
-			height: 600,
 			x: undefined,
-			y: undefined
+			y: undefined,
+			width: 800,
+			height: 600
 		}
 	},
 	menuBarMode: {
@@ -150,7 +188,7 @@ const schema: {[key: string]: JSONSchema} = {
 	}
 };
 
-function updateVibrancySetting(store: Store<any>): void {
+function updateVibrancySetting(store: Store): void {
 	const vibrancy = store.get('vibrancy');
 
 	if (!is.macos) {
@@ -162,11 +200,11 @@ function updateVibrancySetting(store: Store<any>): void {
 	}
 }
 
-function migrate(store: Store<any>): void {
+function migrate(store: Store): void {
 	updateVibrancySetting(store);
 }
 
-const store: Store<any> = new Store({schema});
+const store = new Store<StoreType>({schema});
 migrate(store);
 
 export default store;
diff --git a/source/emoji.ts b/source/emoji.ts
@@ -315,7 +315,8 @@ with this: https://static.xx.fbcdn.net/images/emoji.php/v9/z27/2/32/1f600.png
                                                  (see here) ^
 */
 export async function process(url: string): Promise<Response> {
-	const emojiStyle = config.get('emojiStyle');
+	// TODO: Remove the `any` here.
+	const emojiStyle = config.get('emojiStyle') as any;
 	const emojiSetCode = codeForEmojiStyle(emojiStyle);
 
 	// The character code is the filename without the extension.

diff --git a/source/index.ts b/source/index.ts
@@ -201,11 +201,11 @@ function initRequestsFiltering(): void {
 		if (url.includes('emoji.php')) {
 			callback(await processEmojiUrl(url));
 		} else if (url.includes('typ.php')) {
-			callback({cancel: config.get('block.typingIndicator')});
+			callback({cancel: config.get('block.typingIndicator' as any)});
 		} else if (url.includes('change_read_status.php')) {
-			callback({cancel: config.get('block.chatSeen')});
+			callback({cancel: config.get('block.chatSeen' as any)});
 		} else if (url.includes('delivery_receipts') || url.includes('unread_threads')) {
-			callback({cancel: config.get('block.deliveryReceipt')});
+			callback({cancel: config.get('block.deliveryReceipt' as any)});
 		}
 	});
 }

diff --git a/source/menu.ts b/source/menu.ts
@@ -89,25 +89,25 @@ export default async function updateMenu(): Promise<Menu> {
 		{
 			label: 'Block Seen Indicator',
 			type: 'checkbox',
-			checked: config.get('block.chatSeen'),
+			checked: config.get('block.chatSeen' as any),
 			click(menuItem) {
-				config.set('block.chatSeen', menuItem.checked);
+				config.set('block.chatSeen' as any, menuItem.checked);
 			}
 		},
 		{
 			label: 'Block Typing Indicator',
 			type: 'checkbox',
-			checked: config.get('block.typingIndicator'),
+			checked: config.get('block.typingIndicator' as any),
 			click(menuItem) {
-				config.set('block.typingIndicator', menuItem.checked);
+				config.set('block.typingIndicator' as any, menuItem.checked);
 			}
 		},
 		{
 			label: 'Block Delivery Receipts',
 			type: 'checkbox',
-			checked: config.get('block.deliveryReceipt'),
+			checked: config.get('block.deliveryReceipt' as any),
 			click(menuItem) {
-				config.set('block.deliveryReceipt', menuItem.checked);
+				config.set('block.deliveryReceipt' as any, menuItem.checked);
 			}
 		}
 	];