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>

6 files changed, 102 insertions, 52 deletions

diff --git a/packages/shared/src/contextBridge/SophieRenderer.ts b/packages/shared/src/contextBridge/SophieRenderer.ts
index 28dc0b7..9e087da 100644
--- a/packages/shared/src/contextBridge/SophieRenderer.ts
+++ b/packages/shared/src/contextBridge/SophieRenderer.ts
@@ -19,7 +19,7 @@
  */
 
 import { Action } from '../schemas';
-import { SharedStoreListener } from '../stores/SharedStore';
+import { SharedStoreListener } from '../stores/SharedStoreBase';
 
 export default interface SophieRenderer {
   onSharedStoreChange(this: void, listener: SharedStoreListener): Promise<void>;
diff --git a/packages/shared/src/index.ts b/packages/shared/src/index.ts
index 3d30488..66debf7 100644
--- a/packages/shared/src/index.ts
+++ b/packages/shared/src/index.ts
@@ -27,8 +27,11 @@ export { Action, BrowserViewBounds, ThemeSource } from './schemas';
 export type {
   GlobalSettingsSnapshotIn,
   GlobalSettingsSnapshotOut,
-} from './stores/GlobalSettings';
-export { default as GlobalSettings } from './stores/GlobalSettings';
+} from './stores/GlobalSettingsBase';
+export {
+  default as GlobalSettingsBase,
+  defineGlobalSettingsModel,
+} from './stores/GlobalSettingsBase';
 
 export { default as Profile } from './stores/Profile';
 
@@ -38,17 +41,26 @@ export type {
 } from './stores/ProfileSettings';
 export { default as ProfileSettings } from './stores/ProfileSettings';
 
-export { default as Service } from './stores/Service';
+export {
+  default as ServiceBase,
+  defineServiceModel,
+} from './stores/ServiceBase';
 
 export type {
   ServiceSettingsSnapshotIn,
   ServiceSettingsSnapshotOut,
-} from './stores/ServiceSettings';
-export { default as ServiceSettings } from './stores/ServiceSettings';
+} from './stores/ServiceSettingsBase';
+export {
+  default as ServiceSettingsBase,
+  defineServiceSettingsModel,
+} from './stores/ServiceSettingsBase';
 
 export type {
   SharedStoreListener,
   SharedStoreSnapshotIn,
   SharedStoreSnapshotOut,
-} from './stores/SharedStore';
-export { default as SharedStore } from './stores/SharedStore';
+} from './stores/SharedStoreBase';
+export {
+  default as SharedStoreBase,
+  defineSharedStoreModel,
+} from './stores/SharedStoreBase';
diff --git a/packages/shared/src/stores/GlobalSettings.ts b/packages/shared/src/stores/GlobalSettingsBase.ts
index f316af9..48092fd 100644
--- a/packages/shared/src/stores/GlobalSettings.ts
+++ b/packages/shared/src/stores/GlobalSettingsBase.ts
@@ -18,32 +18,44 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
+import {
+  Instance,
+  types,
+  SnapshotIn,
+  SnapshotOut,
+  IAnyModelType,
+} from 'mobx-state-tree';
 
 import { ThemeSource } from '../schemas';
 
-import Service from './Service';
+import ServiceBase from './ServiceBase';
 
-const GlobalSettings = /* @__PURE__ */ (() =>
-  types.model('GlobalSettings', {
+export function defineGlobalSettingsModel<TS extends IAnyModelType>(
+  service: TS,
+) {
+  return types.model('GlobalSettings', {
     themeSource: types.optional(
       types.enumeration(ThemeSource.options),
       'system',
     ),
     showLocationBar: false,
-    selectedService: types.safeReference(Service),
-  }))();
+    selectedService: types.safeReference(service),
+  });
+}
+
+const GlobalSettingsBase = /* @__PURE__ */ (() =>
+  defineGlobalSettingsModel(ServiceBase))();
 
 /*
   eslint-disable-next-line @typescript-eslint/no-redeclare --
   Intentionally naming the type the same as the store definition.
 */
-interface GlobalSettings extends Instance<typeof GlobalSettings> {}
+interface GlobalSettingsBase extends Instance<typeof GlobalSettingsBase> {}
 
-export default GlobalSettings;
+export default GlobalSettingsBase;
 
 export interface GlobalSettingsSnapshotIn
-  extends SnapshotIn<typeof GlobalSettings> {}
+  extends SnapshotIn<typeof GlobalSettingsBase> {}
 
 export interface GlobalSettingsSnapshotOut
-  extends SnapshotOut<typeof GlobalSettings> {}
+  extends SnapshotOut<typeof GlobalSettingsBase> {}
diff --git a/packages/shared/src/stores/Service.ts b/packages/shared/src/stores/ServiceBase.ts
index a4e3c92..cde403b 100644
--- a/packages/shared/src/stores/Service.ts
+++ b/packages/shared/src/stores/ServiceBase.ts
@@ -18,14 +18,14 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { Instance, types } from 'mobx-state-tree';
+import { IAnyModelType, Instance, types } from 'mobx-state-tree';
 
-import ServiceSettings from './ServiceSettings';
+import ServiceSettingsBase from './ServiceSettingsBase';
 
-const Service = /* @__PURE__ */ (() =>
-  types.model('Service', {
+export function defineServiceModel<TS extends IAnyModelType>(settings: TS) {
+  return types.model('Service', {
     id: types.identifier,
-    settings: ServiceSettings,
+    settings,
     currentUrl: types.maybe(types.string),
     canGoBack: false,
     canGoForward: false,
@@ -36,12 +36,16 @@ const Service = /* @__PURE__ */ (() =>
     ),
     directMessageCount: 0,
     indirectMessageCount: 0,
-  }))();
+  });
+}
+
+const ServiceBase = /* @__PURE__ */ (() =>
+  defineServiceModel(ServiceSettingsBase))();
 
 /*
   eslint-disable-next-line @typescript-eslint/no-redeclare --
   Intentionally naming the type the same as the store definition.
 */
-interface Service extends Instance<typeof Service> {}
+interface ServiceBase extends Instance<typeof ServiceBase> {}
 
-export default Service;
+export default ServiceBase;
diff --git a/packages/shared/src/stores/ServiceSettings.ts b/packages/shared/src/stores/ServiceSettingsBase.ts
index a5811f5..45eb15d 100644
--- a/packages/shared/src/stores/ServiceSettings.ts
+++ b/packages/shared/src/stores/ServiceSettingsBase.ts
@@ -18,28 +18,40 @@
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-import { Instance, types, SnapshotIn, SnapshotOut } from 'mobx-state-tree';
+import {
+  Instance,
+  types,
+  SnapshotIn,
+  SnapshotOut,
+  IAnyModelType,
+} from 'mobx-state-tree';
 
-import Profile from './Profile';
+import ProfileBase from './Profile';
 
-const ServiceSettings = /* @__PURE__ */ (() =>
-  types.model('ServiceSettings', {
+export function defineServiceSettingsModel<TP extends IAnyModelType>(
+  profile: TP,
+) {
+  return types.model('ServiceSettings', {
     name: types.string,
-    profile: types.reference(Profile),
+    profile: types.reference(profile),
     // TODO: Remove this once recipes are added.
     url: types.string,
-  }))();
+  });
+}
+
+const ServiceSettingsBase = /* @__PURE__ */ (() =>
+  defineServiceSettingsModel(ProfileBase))();
 
 /*
   eslint-disable-next-line @typescript-eslint/no-redeclare --
   Intentionally naming the type the same as the store definition.
 */
-interface ServiceSettings extends Instance<typeof ServiceSettings> {}
+interface ServiceSettingsBase extends Instance<typeof ServiceSettingsBase> {}
 
-export default ServiceSettings;
+export default ServiceSettingsBase;
 
 export interface ServiceSettingsSnapshotIn
-  extends SnapshotIn<typeof ServiceSettings> {}
+  extends SnapshotIn<typeof ServiceSettingsBase> {}
 
 export interface ServiceSettingsSnapshotOut
-  extends SnapshotOut<typeof ServiceSettings> {}
+  extends SnapshotOut<typeof ServiceSettingsBase> {}
diff --git a/packages/shared/src/stores/SharedStore.ts b/packages/shared/src/stores/SharedStoreBase.ts
index d81a3d3..8d6624b 100644
--- a/packages/shared/src/stores/SharedStore.ts
+++ b/packages/shared/src/stores/SharedStoreBase.ts
@@ -24,34 +24,44 @@ import {
   types,
   SnapshotIn,
   SnapshotOut,
+  IAnyModelType,
 } from 'mobx-state-tree';
 
-import GlobalSettings from './GlobalSettings';
-import Profile from './Profile';
-import Service from './Service';
-
-const SharedStore = /* @__PURE__ */ (() =>
-  types.model('SharedStore', {
-    settings: types.optional(GlobalSettings, {}),
-    profilesById: types.map(Profile),
-    profiles: types.array(types.reference(Profile)),
-    servicesById: types.map(Service),
-    services: types.array(types.reference(Service)),
+import GlobalSettingsBase from './GlobalSettingsBase';
+import ProfileBase from './Profile';
+import ServiceBase from './ServiceBase';
+
+export function defineSharedStoreModel<
+  TG extends IAnyModelType,
+  TP extends IAnyModelType,
+  TS extends IAnyModelType,
+>(globalSettings: TG, profile: TP, service: TS) {
+  return types.model('SharedStore', {
+    settings: types.optional(globalSettings, {}),
+    profilesById: types.map(profile),
+    profiles: types.array(types.reference(profile)),
+    servicesById: types.map(service),
+    services: types.array(types.reference(service)),
     shouldUseDarkColors: false,
-  }))();
+  });
+}
+
+const SharedStoreBase = /* @__PURE__ */ (() =>
+  defineSharedStoreModel(GlobalSettingsBase, ProfileBase, ServiceBase))();
 
 /*
   eslint-disable-next-line @typescript-eslint/no-redeclare --
   Intentionally naming the type the same as the store definition.
 */
-interface SharedStore extends Instance<typeof SharedStore> {}
+interface SharedStoreBase extends Instance<typeof SharedStoreBase> {}
 
-export default SharedStore;
+export default SharedStoreBase;
 
-export interface SharedStoreSnapshotIn extends SnapshotIn<typeof SharedStore> {}
+export interface SharedStoreSnapshotIn
+  extends SnapshotIn<typeof SharedStoreBase> {}
 
 export interface SharedStoreSnapshotOut
-  extends SnapshotOut<typeof SharedStore> {}
+  extends SnapshotOut<typeof SharedStoreBase> {}
 
 export interface SharedStoreListener {
   onSnapshot(snapshot: SharedStoreSnapshotIn): void;