chore: Transform AppStore.js into Typescript (#329)

* turn actions into typescript
* correct tsconfig
* added TypedStore

5 files changed, 100 insertions, 26 deletions

diff --git a/src/stores/AppStore.js b/src/stores/AppStore.ts
index a8e1ce247..5659460c6 100644
--- a/src/stores/AppStore.js
+++ b/src/stores/AppStore.ts
@@ -14,12 +14,19 @@ import ms from 'ms';
 import { URL } from 'url';
 import { readJsonSync } from 'fs-extra';
 
-import Store from './lib/Store';
+import { Stores } from 'src/stores.types';
+import { ApiInterface } from 'src/api';
+import { Actions } from 'src/actions/lib/actions';
+import TypedStore from './lib/TypedStore';
 import Request from './lib/Request';
 import { CHECK_INTERVAL, DEFAULT_APP_SETTINGS } from '../config';
 import { cleanseJSObject } from '../jsUtils';
 import { isMac, isWindows, electronVersion, osRelease } from '../environment';
-import { ferdiumVersion, userDataPath, ferdiumLocale } from '../environment-remote';
+import {
+  ferdiumVersion,
+  userDataPath,
+  ferdiumLocale,
+} from '../environment-remote';
 import { generatedTranslations } from '../i18n/translations';
 import { getLocale } from '../helpers/i18n-helpers';
 
@@ -45,7 +52,7 @@ const CATALINA_NOTIFICATION_HACK_KEY =
 
 const locales = generatedTranslations();
 
-export default class AppStore extends Store {
+export default class AppStore extends TypedStore {
   updateStatusTypes = {
     CHECKING: 'CHECKING',
     AVAILABLE: 'AVAILABLE',
@@ -89,10 +96,10 @@ export default class AppStore extends Store {
 
   dictionaries = [];
 
-  fetchDataInterval = null;
+  fetchDataInterval: null | NodeJS.Timer = null;
 
-  constructor(...args) {
-    super(...args);
+  constructor(stores: Stores, api: ApiInterface, actions: Actions) {
+    super(stores, api, actions);
 
     // Register action handlers
     this.actions.app.notify.listen(this._notify.bind(this));
@@ -118,7 +125,7 @@ export default class AppStore extends Store {
     ]);
   }
 
-  async setup() {
+  async setup(): Promise<void> {
     this._appStartsCounter();
     // Focus the active service
     window.addEventListener('focus', this.actions.service.focusActiveService);
@@ -162,7 +169,7 @@ export default class AppStore extends Store {
     setInterval(() => this._checkForUpdates(), CHECK_INTERVAL);
     // Check for an update in 30s (need a delay to prevent Squirrel Installer lock file issues)
     setTimeout(() => this._checkForUpdates(), ms('30s'));
-    ipcRenderer.on('autoUpdate', (event, data) => {
+    ipcRenderer.on('autoUpdate', (_, data) => {
       if (this.updateStatus !== this.updateStatusTypes.FAILED) {
         if (data.available) {
           this.updateStatus = this.updateStatusTypes.AVAILABLE;
@@ -185,7 +192,10 @@ export default class AppStore extends Store {
         if (data.error) {
           if (data.error.message && data.error.message.startsWith('404')) {
             this.updateStatus = this.updateStatusTypes.NOT_AVAILABLE;
-            console.warn('Updater warning: there seems to be unpublished pre-release(s) available on GitHub', data.error);
+            console.warn(
+              'Updater warning: there seems to be unpublished pre-release(s) available on GitHub',
+              data.error,
+            );
           } else {
             console.error('Updater error:', data.error);
             this.updateStatus = this.updateStatusTypes.FAILED;
@@ -195,7 +205,7 @@ export default class AppStore extends Store {
     });
 
     // Handle deep linking (ferdium://)
-    ipcRenderer.on('navigateFromDeepLink', (event, data) => {
+    ipcRenderer.on('navigateFromDeepLink', (_, data) => {
       debug('Navigate from deep link', data);
       let { url } = data;
       if (!url) return;
@@ -217,7 +227,7 @@ export default class AppStore extends Store {
 
     this.isSystemDarkModeEnabled = nativeTheme.shouldUseDarkColors;
 
-    ipcRenderer.on('isWindowFocused', (event, isFocused) => {
+    ipcRenderer.on('isWindowFocused', (_, isFocused) => {
       debug('Setting is focused to', isFocused);
       this.isFocused = isFocused;
     });
@@ -391,7 +401,11 @@ export default class AppStore extends Store {
   }
 
   @action _checkForUpdates() {
-    if (this.isOnline && this.stores.settings.app.automaticUpdates && (isMac || isWindows || process.env.APPIMAGE)) {
+    if (
+      this.isOnline &&
+      this.stores.settings.app.automaticUpdates &&
+      (isMac || isWindows || process.env.APPIMAGE)
+    ) {
       debug('_checkForUpdates: sending event to autoUpdate:check');
       this.updateStatus = this.updateStatusTypes.CHECKING;
       ipcRenderer.send('autoUpdate', {
@@ -526,7 +540,7 @@ export default class AppStore extends Store {
   }
 
   _handleLogout() {
-    if (!this.stores.user.isLoggedIn) {
+    if (!this.stores.user.isLoggedIn && this.fetchDataInterval !== null) {
       clearInterval(this.fetchDataInterval);
     }
   }
diff --git a/src/stores/index.ts b/src/stores/index.ts
index 6ad898d85..a5b1a7452 100644
--- a/src/stores/index.ts
+++ b/src/stores/index.ts
@@ -1,3 +1,7 @@
+import { Stores } from 'src/stores.types';
+import { RouterStore } from 'mobx-react-router';
+import { ApiInterface } from 'src/api';
+import { Actions } from 'src/actions/lib/actions';
 import AppStore from './AppStore';
 import UserStore from './UserStore';
 import FeaturesStore from './FeaturesStore';
@@ -12,8 +16,12 @@ import { workspaceStore } from '../features/workspaces';
 import { communityRecipesStore } from '../features/communityRecipes';
 import { todosStore } from '../features/todos';
 
-export default (api, actions, router) => {
-  const stores = {};
+export default (
+  api: ApiInterface,
+  actions: Actions,
+  router: RouterStore,
+): Stores => {
+  const stores: Stores | any = {};
   Object.assign(stores, {
     router,
     app: new AppStore(stores, api, actions),
@@ -37,5 +45,6 @@ export default (api, actions, router) => {
       stores[name].initialize();
     }
   }
+
   return stores;
 };
diff --git a/src/stores/lib/Reaction.ts b/src/stores/lib/Reaction.ts
index 0ca24a6fa..3966c8073 100644
--- a/src/stores/lib/Reaction.ts
+++ b/src/stores/lib/Reaction.ts
@@ -1,24 +1,24 @@
-import { autorun } from 'mobx';
+import { autorun, IReactionDisposer, IReactionPublic } from 'mobx';
 
 export default class Reaction {
-  reaction;
+  public reaction: (r: IReactionPublic) => any;
 
-  isRunning = false;
+  private isRunning: boolean = false;
 
-  dispose;
+  public dispose?: IReactionDisposer;
 
-  constructor(reaction) {
+  constructor(reaction: any) {
     this.reaction = reaction;
   }
 
-  start() {
+  start(): void {
     if (!this.isRunning) {
       this.dispose = autorun(this.reaction);
       this.isRunning = true;
     }
   }
 
-  stop() {
+  stop(): void {
     if (this.isRunning) {
       this.dispose?.();
       this.isRunning = false;
diff --git a/src/stores/lib/Store.js b/src/stores/lib/Store.js
index a867c3a46..739a47729 100644
--- a/src/stores/lib/Store.js
+++ b/src/stores/lib/Store.js
@@ -2,12 +2,16 @@ import { computed, observable } from 'mobx';
 import Reaction from './Reaction';
 
 export default class Store {
-  stores = {};
+  /** @type Stores */
+  stores;
 
-  api = {};
+  /** @type ApiInterface */
+  api;
 
-  actions = {};
+  /** @type Actions */
+  actions;
 
+  /** @type Reaction[] */
   _reactions = [];
 
   // status implementation
@@ -28,8 +32,9 @@ export default class Store {
   }
 
   registerReactions(reactions) {
-    for (const reaction of reactions)
+    for (const reaction of reactions) {
       this._reactions.push(new Reaction(reaction));
+    }
   }
 
   setup() {}
diff --git a/src/stores/lib/TypedStore.ts b/src/stores/lib/TypedStore.ts
new file mode 100644
index 000000000..5d8bf3bbd
--- /dev/null
+++ b/src/stores/lib/TypedStore.ts
@@ -0,0 +1,46 @@
+import { computed, IReactionPublic, observable } from 'mobx';
+import { Actions } from 'src/actions/lib/actions';
+import { ApiInterface } from 'src/api';
+import { Stores } from 'src/stores.types';
+import Reaction from './Reaction';
+
+export default abstract class TypedStore {
+  _reactions: Reaction[] = [];
+
+  @observable _status: any = null;
+
+  @computed get actionStatus() {
+    return this._status || [];
+  }
+
+  set actionStatus(status) {
+    this._status = status;
+  }
+
+  constructor(
+    public stores: Stores,
+    public api: ApiInterface,
+    public actions: Actions,
+  ) {}
+
+  registerReactions(reactions: { (r: IReactionPublic): void }[]): void {
+    for (const reaction of reactions) {
+      this._reactions.push(new Reaction(reaction));
+    }
+  }
+
+  public abstract setup(): void;
+
+  initialize(): void {
+    this.setup();
+    for (const reaction of this._reactions) reaction.start();
+  }
+
+  teardown(): void {
+    for (const reaction of this._reactions) reaction.stop();
+  }
+
+  resetStatus(): void {
+    this._status = null;
+  }
+}