refactor: Rename RootStore to RendererStore

4 files changed, 48 insertions, 26 deletions

diff --git a/packages/renderer/src/components/StoreProvider.tsx b/packages/renderer/src/components/StoreProvider.tsx
index 0d9a36c..da1e699 100644
--- a/packages/renderer/src/components/StoreProvider.tsx
+++ b/packages/renderer/src/components/StoreProvider.tsx
@@ -20,11 +20,11 @@
 
 import React, { createContext, useContext } from 'react';
 
-import type { RootStore } from '../stores/RootStore';
+import type { RendererStore } from '../stores/RendererStore';
 
-const StoreContext = createContext<RootStore | null>(null);
+const StoreContext = createContext<RendererStore | null>(null);
 
-export function useStore(): RootStore {
+export function useStore(): RendererStore {
   const store = useContext(StoreContext);
   if (store === null) {
     throw new Error('useStore can only be called inside of StoreProvider');
@@ -34,7 +34,7 @@ export function useStore(): RootStore {
 
 export function StoreProvider({ children, store }: {
   children: JSX.Element | JSX.Element[],
-  store: RootStore,
+  store: RendererStore,
 }): JSX.Element {
   return (
     <StoreContext.Provider value={store}>
diff --git a/packages/renderer/src/index.tsx b/packages/renderer/src/index.tsx
index 0919b93..befb823 100644
--- a/packages/renderer/src/index.tsx
+++ b/packages/renderer/src/index.tsx
@@ -30,7 +30,7 @@ import { App } from './components/App';
 import { StoreProvider } from './components/StoreProvider';
 import { ThemeProvider } from './components/ThemeProvider';
 import { exposeToReduxDevtools, hotReloadServices } from './devTools';
-import { createAndConnectRootStore } from './stores/RootStore';
+import { createAndConnectRendererStore } from './stores/RendererStore';
 
 const isDevelopment = import.meta.env.MODE === 'development';
 
@@ -38,7 +38,7 @@ if (isDevelopment) {
   hotReloadServices();
 }
 
-const store = createAndConnectRootStore(window.sophieRenderer);
+const store = createAndConnectRendererStore(window.sophieRenderer);
 
 if (isDevelopment) {
   exposeToReduxDevtools(store);
diff --git a/packages/renderer/src/stores/RendererEnv.ts b/packages/renderer/src/stores/RendererEnv.ts
new file mode 100644
index 0000000..f2ec519
--- /dev/null
+++ b/packages/renderer/src/stores/RendererEnv.ts
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C)  2021-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 { getEnv as getAnyEnv, IAnyStateTreeNode } from 'mobx-state-tree';
+import type { SophieRenderer } from '@sophie/shared';
+
+export interface RendererEnv {
+  ipc: Omit<SophieRenderer, 'setSharedStoreListener'>;
+}
+
+/**
+ * Gets a well-typed environment from `model`.
+ *
+ * Only useable inside state trees created by `createAndConnectRootStore`.
+ *
+ * @param model The state tree node.
+ */
+export function getEnv(model: IAnyStateTreeNode): RendererEnv {
+  return getAnyEnv<RendererEnv>(model);
+}
diff --git a/packages/renderer/src/stores/RootStore.ts b/packages/renderer/src/stores/RendererStore.ts
index f7f37f0..001f23a 100644
--- a/packages/renderer/src/stores/RootStore.ts
+++ b/packages/renderer/src/stores/RendererStore.ts
@@ -21,8 +21,6 @@
 import {
   applySnapshot,
   applyPatch,
-  getEnv as getAnyEnv,
-  IAnyStateTreeNode,
   Instance,
   types
 } from 'mobx-state-tree';
@@ -33,22 +31,9 @@ import {
   ThemeSource,
 } from '@sophie/shared';
 
-export interface RootEnv {
-  ipc: Omit<SophieRenderer, 'setSharedStoreListener'>;
-}
-
-/**
- * Gets a well-typed environment from `model`.
- *
- * Only useable inside state trees created by `createAndConnectRootStore`.
- *
- * @param model The state tree node.
- */
-export function getEnv(model: IAnyStateTreeNode): RootEnv {
-  return getAnyEnv<RootEnv>(model);
-}
+import { getEnv } from './RendererEnv';
 
-export const rootStore = types.model('RootStore', {
+export const rendererStore = types.model('RendererStore', {
   shared: types.optional(sharedStore, {}),
 }).actions((self) => ({
   setBrowserViewBounds(bounds: BrowserViewBounds) {
@@ -66,7 +51,7 @@ export const rootStore = types.model('RootStore', {
   },
 }));
 
-export interface RootStore extends Instance<typeof rootStore> {}
+export interface RendererStore extends Instance<typeof rendererStore> {}
 
 /**
  * Creates a new `RootStore` with a new environment and connects it to `ipc`.
@@ -76,8 +61,8 @@ export interface RootStore extends Instance<typeof rootStore> {}
  *
  * @param ipc The `sophieRenderer` context bridge.
  */
-export function createAndConnectRootStore(ipc: SophieRenderer): RootStore {
-  const store = rootStore.create({}, {
+export function createAndConnectRendererStore(ipc: SophieRenderer): RendererStore {
+  const store = rendererStore.create({}, {
     ipc,
   });