Enhance typing of channels and sync-box

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>

Signed-off-by: Janne Savolainen <janne.savolainen@live.fi>

src/common/application-update/discovered-update-version/discovered-update-version.injectable.ts

@@ -4,6 +4,7 @@
  */
 import { getInjectable } from "@ogre-tools/injectable";
 import createSyncBoxInjectable from "../../sync-box/create-sync-box.injectable";
+import type { UpdateChannel } from "../../../main/update-app/update-channels";
 
 const discoveredUpdateVersionInjectable = getInjectable({
   id: "discovered-update-version",
@@ -11,7 +12,9 @@ const discoveredUpdateVersionInjectable = getInjectable({
   instantiate: (di) => {
     const createSyncBox = di.inject(createSyncBoxInjectable);
 
-    return createSyncBox("discovered-update-version");
+    return createSyncBox<{ version: string; updateChannel: UpdateChannel }>(
+      "discovered-update-version",
+    );
   },
 });
 

src/common/application-update/progress-of-update-download/progress-of-update-download.injectable.ts

@@ -11,7 +11,7 @@ const progressOfUpdateDownloadInjectable = getInjectable({
   instantiate: (di) => {
     const createSyncBox = di.inject(createSyncBoxInjectable);
 
-    return createSyncBox("progress-of-update-download");
+    return createSyncBox<number>("progress-of-update-download");
   },
 });
 

src/common/application-update/update-is-being-downloaded/update-is-being-downloaded.injectable.ts

@@ -11,7 +11,7 @@ const updateIsBeingDownloadedInjectable = getInjectable({
   instantiate: (di) => {
     const createSyncBox = di.inject(createSyncBoxInjectable);
 
-    return createSyncBox("update-is-being-downloaded");
+    return createSyncBox<boolean>("update-is-being-downloaded");
   },
 });
 

src/common/application-update/updates-are-being-discovered/updates-are-being-discovered.injectable.ts

@@ -11,7 +11,7 @@ const updatesAreBeingDiscoveredInjectable = getInjectable({
   instantiate: (di) => {
     const createSyncBox = di.inject(createSyncBoxInjectable);
 
-    return createSyncBox("updates-are-being-discovered");
+    return createSyncBox<boolean>("updates-are-being-discovered");
   },
 });
 

src/common/channel/channel-injection-token.ts

@@ -4,10 +4,11 @@
  */
 import { getInjectionToken } from "@ogre-tools/injectable";
 
-export interface Channel {
+export interface Channel<TInstance> {
   id: string;
+  _template?: TInstance;
 }
 
-export const channelInjectionToken = getInjectionToken<Channel>({
+export const channelInjectionToken = getInjectionToken<Channel<unknown>>({
   id: "channel",
 });

src/common/channel/channel-listener-injection-token.ts

@@ -3,13 +3,14 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectionToken } from "@ogre-tools/injectable";
+import type { Channel } from "./channel-injection-token";
 
-export interface ChannelListener {
+export interface ChannelListener<TChannel extends Channel<unknown>> {
-  channel: any;
+  channel: TChannel;
-  handler: (value: any) => void;
+  handler: (value: TChannel["_template"]) => void;
 }
 
-export const channelListenerInjectionToken = getInjectionToken<ChannelListener>(
+export const channelListenerInjectionToken = getInjectionToken<ChannelListener<Channel<unknown>>>(
   {
     id: "channel-listener",
   },

src/common/channel/channel.test.ts

@@ -6,6 +6,7 @@ import type { DiContainer } from "@ogre-tools/injectable";
 import { getInjectable } from "@ogre-tools/injectable";
 import type { LensWindow } from "../../main/start-main-application/lens-window/application-window/lens-window-injection-token";
 import { lensWindowInjectionToken } from "../../main/start-main-application/lens-window/application-window/lens-window-injection-token";
+import type { SendToAgnosticChannel } from "./send-to-agnostic-channel-injection-token";
 import { sendToAgnosticChannelInjectionToken } from "./send-to-agnostic-channel-injection-token";
 import { getApplicationBuilder } from "../../renderer/components/test-utils/get-application-builder";
 import { channelListenerInjectionToken } from "./channel-listener-injection-token";
@@ -13,12 +14,14 @@ import createLensWindowInjectable from "../../main/start-main-application/lens-w
 import type { Channel } from "./channel-injection-token";
 import { channelInjectionToken } from "./channel-injection-token";
 
+type TestChannel = Channel<string>;
+
 describe("channel", () => {
   describe("messaging from main to renderer, given listener for channel in a window and application has started", () => {
-    let testChannel: Channel;
+    let testChannel: TestChannel;
     let testListenerInWindowMock: jest.Mock;
     let mainDi: DiContainer;
-    let sendToAgnosticChannel: (channel: Channel, message: any) => void;
+    let sendToAgnosticChannel: SendToAgnosticChannel;
 
     beforeEach(async () => {
       const applicationBuilder = getApplicationBuilder();
@@ -96,11 +99,11 @@ describe("channel", () => {
   });
 
   describe("messaging from renderer to main, given listener for channel in a main and application has started", () => {
-    let testChannel: Channel;
+    let testChannel: TestChannel;
     let testListenerInMainMock: jest.Mock;
     let rendererDi: DiContainer;
     let mainDi: DiContainer;
-    let sendToAgnosticChannel: (channel: Channel, message: any) => void;
+    let sendToAgnosticChannel: SendToAgnosticChannel;
 
     beforeEach(async () => {
       const applicationBuilder = getApplicationBuilder();

src/common/channel/enlist-channel-listener-injection-token.ts

@@ -3,9 +3,14 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectionToken } from "@ogre-tools/injectable";
+import type { Channel } from "./channel-injection-token";
 
-export const enlistChannelListenerInjectionToken = getInjectionToken<
+export type EnlistChannelListener = <TChannel extends Channel<unknown>>(
-  (channel: any, handler: any) => () => void
+  channel: TChannel,
-    >({
+  handler: (value: TChannel["_template"]) => void
-      id: "enlist-channel-listener",
+) => () => void;
-    });
+
+export const enlistChannelListenerInjectionToken =
+  getInjectionToken<EnlistChannelListener>({
+    id: "enlist-channel-listener",
+  });

src/common/channel/send-to-agnostic-channel-injection-token.ts

@@ -5,6 +5,12 @@
 import { getInjectionToken } from "@ogre-tools/injectable";
 import type { Channel } from "./channel-injection-token";
 
-export const sendToAgnosticChannelInjectionToken = getInjectionToken<(channel: Channel, message: any) => void>({
+export type SendToAgnosticChannel = <TChannel extends Channel<unknown>>(
-  id: "send-to-agnostic-channel",
+  channel: TChannel,
-});
+  message: TChannel["_template"]
+) => void;
+
+export const sendToAgnosticChannelInjectionToken =
+  getInjectionToken<SendToAgnosticChannel>({
+    id: "send-to-agnostic-channel",
+  });

src/common/sync-box/create-sync-box.injectable.ts

@@ -17,7 +17,7 @@ const createSyncBoxInjectable = getInjectable({
     const sendToAgnosticChannel = di.inject(sendToAgnosticChannelInjectionToken);
     const getSyncBoxState = (id: string) => di.inject(syncBoxStateInjectable, id);
 
-    return (id: string): SyncBox<any> => {
+    return <TData>(id: string): SyncBox<TData> => {
       const state = getSyncBoxState(id);
 
       return {
@@ -37,7 +37,6 @@ const createSyncBoxInjectable = getInjectable({
 
 export default createSyncBoxInjectable;
 
-
 export interface SyncBox<TValue> {
   id: string;
   value: IComputedValue<TValue>;

src/common/sync-box/sync-box-channel-listener.injectable.ts

@@ -3,14 +3,16 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
+import type { SyncBoxChannel } from "./sync-box-channel.injectable";
 import syncBoxChannelInjectable from "./sync-box-channel.injectable";
+import type { ChannelListener } from "../channel/channel-listener-injection-token";
 import { channelListenerInjectionToken } from "../channel/channel-listener-injection-token";
 import syncBoxStateInjectable from "./sync-box-state.injectable";
 
 const syncBoxChannelListenerInjectable = getInjectable({
   id: "sync-box-channel-listener",
 
-  instantiate: (di) => {
+  instantiate: (di): ChannelListener<SyncBoxChannel> => {
     const getSyncBoxState = (id: string) => di.inject(syncBoxStateInjectable, id);
 
     return {

src/common/sync-box/sync-box-channel.injectable.ts

@@ -3,12 +3,15 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable } from "@ogre-tools/injectable";
+import type { Channel } from "../channel/channel-injection-token";
 import { channelInjectionToken } from "../channel/channel-injection-token";
 
+export type SyncBoxChannel = Channel<{ id: string; value: unknown }>;
+
 const syncBoxChannelInjectable = getInjectable({
   id: "sync-box-channel",
 
-  instantiate: () => ({
+  instantiate: (): SyncBoxChannel => ({
     id: "sync-box-channel",
   }),
 

src/common/sync-box/sync-box.test.ts

@@ -24,7 +24,7 @@ describe("sync-box", () => {
       instantiate: (di) => {
         const createSyncBox = di.inject(createSyncBoxInjectable);
 
-        return createSyncBox("some-state");
+        return createSyncBox<string>("some-state");
       },
     });
 

src/main/channel/channel-listeners/enlist-channel-listener.injectable.ts

@@ -13,7 +13,7 @@ const enlistChannelListenerInjectable = getInjectable({
   instantiate: (di) => {
     const ipcMain = di.inject(ipcMainInjectable);
 
-    return (channel: any, handler: any) => {
+    return (channel, handler) => {
       const nativeCallback = (_: IpcMainEvent, message: unknown) =>
         handler(message);
 

src/renderer/channel/channel-listeners/enlist-channel-listener.injectable.ts

@@ -13,7 +13,7 @@ const enlistChannelListenerInjectable = getInjectable({
   instantiate: (di) => {
     const ipcRenderer = di.inject(ipcRendererInjectable);
 
-    return (channel: any, handler: any) => {
+    return (channel, handler) => {
       const nativeCallback = (_: IpcRendererEvent, message: unknown) =>
         handler(message);