refactor: Shared model type factories

Allows customization of stores both in the renderer and in the main
process. Instead of exposing a basic model type from the shared module
(which was be overwritted with more specific props in the main package),
we expose factory function that can create specific model types in
both the renderer and the main process.

Using these package-specific customization to stores, the renderer
package can attach IPC calls directly to store objects, which the main
package can attach the handlers for IPC calls and other internal
actions.

Signed-off-by: Kristóf Marussy <kristof@marussy.com>

8 files changed, 13 insertions, 131 deletions

diff --git a/packages/main/src/stores/GlobalSettings.ts b/packages/main/src/stores/GlobalSettings.ts
index 2af9da2..31b7e12 100644
--- a/packages/main/src/stores/GlobalSettings.ts
+++ b/packages/main/src/stores/GlobalSettings.ts
@@ -18,22 +18,16 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import {
-  GlobalSettings as GlobalSettingsBase,
-  ThemeSource,
-} from '@sophie/shared';
-import { Instance, resolveIdentifier, types } from 'mobx-state-tree';
+import { defineGlobalSettingsModel, ThemeSource } from '@sophie/shared';
+import { Instance, resolveIdentifier } from 'mobx-state-tree';
 
 import { getLogger } from '../utils/log';
-import overrideProps from '../utils/overrideProps';
 
 import Service from './Service';
 
 const log = getLogger('sharedStore');
 
-const GlobalSettings = overrideProps(GlobalSettingsBase, {
-  selectedService: types.safeReference(Service),
-}).actions((self) => ({
+const GlobalSettings = defineGlobalSettingsModel(Service).actions((self) => ({
   setThemeSource(mode: ThemeSource): void {
     self.themeSource = mode;
   },
diff --git a/packages/main/src/stores/Profile.ts b/packages/main/src/stores/Profile.ts
index 0fd486e..836f4a8 100644
--- a/packages/main/src/stores/Profile.ts
+++ b/packages/main/src/stores/Profile.ts
@@ -21,14 +21,9 @@
 import { Profile as ProfileBase } from '@sophie/shared';
 import { getSnapshot, Instance } from 'mobx-state-tree';
 
-import overrideProps from '../utils/overrideProps';
-
-import ProfileSettings from './ProfileSettings';
 import type ProfileConfig from './config/ProfileConfig';
 
-const Profile = overrideProps(ProfileBase, {
-  settings: ProfileSettings,
-}).views((self) => ({
+const Profile = ProfileBase.views((self) => ({
   get config(): ProfileConfig {
     const { id, settings } = self;
     return { ...getSnapshot(settings), id };
diff --git a/packages/main/src/stores/ProfileSettings.ts b/packages/main/src/stores/ProfileSettings.ts
deleted file mode 100644
index eed51e3..0000000
--- a/packages/main/src/stores/ProfileSettings.ts
+++ /dev/null
@@ -1,30 +0,0 @@
-/*
- * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
- *
- * This file is part of Sophie.
- *
- * Sophie is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-import { ProfileSettings } from '@sophie/shared';
-
-// TODO Export a modified ProfileSettings once we need to add actions to it.
-// eslint-disable-next-line unicorn/prefer-export-from -- Can't export from default.
-export default ProfileSettings;
-
-export type {
-  ProfileSettingsSnapshotIn,
-  ProfileSettingsSnapshotOut,
-} from '@sophie/shared';
diff --git a/packages/main/src/stores/Service.ts b/packages/main/src/stores/Service.ts
index 5302dd4..abef7c2 100644
--- a/packages/main/src/stores/Service.ts
+++ b/packages/main/src/stores/Service.ts
@@ -19,18 +19,15 @@
  */
 
 import type { UnreadCount } from '@sophie/service-shared';
-import { Service as ServiceBase } from '@sophie/shared';
+import { defineServiceModel } from '@sophie/shared';
 import { Instance, getSnapshot } from 'mobx-state-tree';
 
 import type { ServiceView } from '../infrastructure/electron/types';
-import overrideProps from '../utils/overrideProps';
 
 import ServiceSettings from './ServiceSettings';
 import type ServiceConfig from './config/ServiceConfig';
 
-const Service = overrideProps(ServiceBase, {
-  settings: ServiceSettings,
-})
+const Service = defineServiceModel(ServiceSettings)
   .views((self) => ({
     get config(): ServiceConfig {
       const { id, settings } = self;
diff --git a/packages/main/src/stores/ServiceSettings.ts b/packages/main/src/stores/ServiceSettings.ts
index e6f48c6..5d37347 100644
--- a/packages/main/src/stores/ServiceSettings.ts
+++ b/packages/main/src/stores/ServiceSettings.ts
@@ -18,16 +18,12 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { ServiceSettings as ServiceSettingsBase } from '@sophie/shared';
-import { Instance, types } from 'mobx-state-tree';
-
-import overrideProps from '../utils/overrideProps';
+import { defineServiceSettingsModel } from '@sophie/shared';
+import { Instance } from 'mobx-state-tree';
 
 import Profile from './Profile';
 
-const ServiceSettings = overrideProps(ServiceSettingsBase, {
-  profile: types.reference(Profile),
-});
+const ServiceSettings = defineServiceSettingsModel(Profile);
 
 /*
   eslint-disable-next-line @typescript-eslint/no-redeclare --
diff --git a/packages/main/src/stores/SharedStore.ts b/packages/main/src/stores/SharedStore.ts
index 182b693..d72c532 100644
--- a/packages/main/src/stores/SharedStore.ts
+++ b/packages/main/src/stores/SharedStore.ts
@@ -18,10 +18,8 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { SharedStore as SharedStoreBase } from '@sophie/shared';
-import { getSnapshot, Instance, types } from 'mobx-state-tree';
-
-import overrideProps from '../utils/overrideProps';
+import { defineSharedStoreModel } from '@sophie/shared';
+import { getSnapshot, Instance } from 'mobx-state-tree';
 
 import GlobalSettings from './GlobalSettings';
 import Profile from './Profile';
@@ -33,13 +31,7 @@ function getConfigs<T>(models: { config: T }[]): T[] | undefined {
   return models.length === 0 ? undefined : models.map((model) => model.config);
 }
 
-const SharedStore = overrideProps(SharedStoreBase, {
-  settings: types.optional(GlobalSettings, {}),
-  profilesById: types.map(Profile),
-  profiles: types.array(types.reference(Profile)),
-  servicesById: types.map(Service),
-  services: types.array(types.reference(Service)),
-})
+const SharedStore = defineSharedStoreModel(GlobalSettings, Profile, Service)
   .views((self) => ({
     get config(): Config {
       const { settings, profiles, services } = self;
diff --git a/packages/main/src/stores/config/loadConfig.ts b/packages/main/src/stores/config/loadConfig.ts
index 55d15c8..2463084 100644
--- a/packages/main/src/stores/config/loadConfig.ts
+++ b/packages/main/src/stores/config/loadConfig.ts
@@ -18,6 +18,7 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
+import { ProfileSettingsSnapshotIn } from '@sophie/shared';
 import {
   applySnapshot,
   IMSTArray,
@@ -31,7 +32,6 @@ import slug from 'slug';
 
 import GlobalSettings from '../GlobalSettings';
 import type Profile from '../Profile';
-import type { ProfileSettingsSnapshotIn } from '../ProfileSettings';
 import type Service from '../Service';
 import type { ServiceSettingsSnapshotIn } from '../ServiceSettings';
 
diff --git a/packages/main/src/utils/overrideProps.ts b/packages/main/src/utils/overrideProps.ts
deleted file mode 100644
index c626408..0000000
--- a/packages/main/src/utils/overrideProps.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-/*
- * Copyright (C)  2022 Kristóf Marussy <kristof@marussy.com>
- *
- * This file is part of Sophie.
- *
- * Sophie is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, version 3.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program.  If not, see <https://www.gnu.org/licenses/>.
- *
- * SPDX-License-Identifier: AGPL-3.0-only
- */
-
-/**
- * @file This file implements a technique to force-override properties of a model.
- *
- * The overridden properties must conform to the SnapshotIt and SnapshotOut format
- * of the original model. Essentially, this means that only views and actions can
- * be added safely.
- *
- * @see https://github.com/mobxjs/mobx-state-tree/issues/1403#issuecomment-940843087
- */
-
-import {
-  IAnyModelType,
-  IModelType,
-  ModelProperties,
-  SnapshotIn,
-  SnapshotOut,
-} from 'mobx-state-tree';
-
-export type IUnsafeOverriddenModelType<
-  BASE extends IAnyModelType,
-  PROPS extends ModelProperties,
-> = BASE extends IModelType<infer P, infer O, infer CC, infer CS>
-  ? IModelType<Omit<P, keyof PROPS> & PROPS, O, CC, CS>
-  : never;
-
-export type IOverriddenModelType<
-  BASE extends IAnyModelType,
-  PROPS extends ModelProperties,
-> = SnapshotIn<BASE> extends SnapshotIn<IUnsafeOverriddenModelType<BASE, PROPS>>
-  ? SnapshotOut<
-      IUnsafeOverriddenModelType<BASE, PROPS>
-    > extends SnapshotOut<BASE>
-    ? IUnsafeOverriddenModelType<BASE, PROPS>
-    : never
-  : never;
-
-export default function overrideProps<
-  BASE extends IAnyModelType,
-  PROPS extends ModelProperties,
->(base: BASE, props: PROPS): IOverriddenModelType<BASE, PROPS> {
-  return base.props(props) as IOverriddenModelType<BASE, PROPS>;
-}