@zimi/remote 0.2.1 → 0.2.3

package/src/adaptors/dao3/server.ts

@@ -1,136 +1,136 @@
-import EventEmitter from 'eventemitter3'
-import { isRemoteAdaptorData } from '../../remote'
-import { isRemoteValueEvent } from '../../remoteValue/exposeToRemote'
-import { type AdaptorPackageData } from '../../adaptor'
-
-interface GamePlayerEntityLike {
-  player: {
-    userKey: string
-  }
-}
-
-interface RemoteChannel<T extends GamePlayerEntityLike> {
-  onServerEvent(fn: (e: { args: unknown; entity: T }) => void): void
-}
-
-/**
- * 这是 [dao3 游戏](https://dao3.fun/) 代码服务端适配器。
- * ```ts
- * const remoteManager = new ServerSideRemoteChannelEventManager(remoteChannel)
- *
- * world.onPlayerLeave(
- *   remoteManager.onPlayerLeave.bind(remoteManager)
- * )
- *
- * export const remoteAdaptor = {
- *   every: remoteManager.onEvery.bind(remoteManager),
- *   off: remoteManager.off.bind(remoteManager),
- *   on: remoteManager.on.bind(remoteManager),
- *   once: remoteManager.once.bind(remoteManager),
- *   emit: (e) => {
- *     const entity = remoteManager.getEntity(e.targetDeviceId)
- *     if (!entity) {
- *       console.error('entity not found')
- *       return
- *     }
- *     remoteChannel.sendClientEvent(entity, e as unknown as JSONValue)
- *   },
- * } satisfies Adaptor
- *
- * export const remote = new Remote<RemoteFuncsFromServer, RemoteFuncsFromClient>(
- *   remoteAdaptor,
- *   {
- *     deviceId: 'server',
- *   }
- * )
- *
- * remote.register('initConnection', async () => {
- *   // 什么也不干，单纯的让客户端在服务端“备案”
- * })
- *
- * export const getEntity = remoteManager.getEntity.bind(remoteManager)
- * export const getIdByEntity = remoteManager.getIdByEntity.bind(remoteManager)
- * export const waitForRegister = remoteManager.waitForRegister.bind(remoteManager)
- * export const remoteTo = remoteManager.remoteTo.bind(remoteManager)
- * ```
- */
-export class ServerSideRemoteChannelEventManager<
-  T extends GamePlayerEntityLike,
-> extends EventEmitter<{
-  [key: string]: [AdaptorPackageData]
-}> {
-  entityMap: [string, T][] = []
-
-  constructor(remoteChannel: RemoteChannel<T>) {
-    super()
-    remoteChannel.onServerEvent((e) => {
-      const { args } = e
-      if (!isRemoteAdaptorData(args)) {
-        return
-      }
-      const prevItem = this.entityMap.find(
-        (item) => item[1].player.userKey === e.entity.player.userKey
-      )
-      if (prevItem) {
-        prevItem[0] = args.deviceId
-        prevItem[1] = e.entity
-      } else {
-        this.entityMap.push([args.deviceId, e.entity])
-      }
-      if (!isRemoteValueEvent(args.name)) {
-        this.emit('__remote_every__', args)
-      }
-      this.emit(args.name, args)
-    })
-  }
-
-  onPlayerLeave(e: { entity: T }) {
-    this.entityMap = this.entityMap.filter(
-      (item) => item[1].player.userKey !== e.entity.player.userKey
-    )
-  }
-
-  onEvery(fn: (args: AdaptorPackageData) => void): void {
-    this.on('__remote_every__', fn)
-  }
-
-  waitForRegister(entity: T) {
-    return new Promise<void>((resolve) => {
-      if (
-        this.entityMap.some(
-          ([_, en]) => en.player.userKey === entity.player.userKey
-        )
-      ) {
-        resolve()
-        return
-      }
-      this.once('__remote_every__', () => {
-        resolve()
-      })
-    })
-  }
-
-  getEntity(deviceId: string): T | undefined {
-    return this.entityMap.find((item) => item[0] === deviceId)?.[1]
-  }
-
-  getIdByEntity(entity: T): string | undefined {
-    return this.entityMap.find(
-      (item) => item[1].player.userKey === entity.player.userKey
-    )?.[0]
-  }
-
-  remoteTo(config: { target: T }): {
-    targetDeviceId: string
-  }
-  remoteTo(config: { target: T; timeoutMs: number }): {
-    targetDeviceId: string
-    timeoutMs: number
-  }
-  remoteTo({ target, ...rest }: { target: T; timeoutMs?: number }) {
-    return {
-      targetDeviceId: this.getIdByEntity(target),
-      ...rest,
-    }
-  }
-}
+import EventEmitter from 'eventemitter3'
+import { isRemoteAdaptorData } from '../../remote'
+import { isRemoteValueEvent } from '../../remoteValue/exposeToRemote'
+import { type AdaptorPackageData } from '../../adaptor'
+
+interface GamePlayerEntityLike {
+  player: {
+    userKey: string
+  }
+}
+
+interface RemoteChannel<T extends GamePlayerEntityLike> {
+  onServerEvent(fn: (e: { args: unknown; entity: T }) => void): void
+}
+
+/**
+ * 这是 [dao3 游戏](https://dao3.fun/) 代码服务端适配器。
+ * ```ts
+ * const remoteManager = new ServerSideRemoteChannelEventManager(remoteChannel)
+ *
+ * world.onPlayerLeave(
+ *   remoteManager.onPlayerLeave.bind(remoteManager)
+ * )
+ *
+ * export const remoteAdaptor = {
+ *   every: remoteManager.onEvery.bind(remoteManager),
+ *   off: remoteManager.off.bind(remoteManager),
+ *   on: remoteManager.on.bind(remoteManager),
+ *   once: remoteManager.once.bind(remoteManager),
+ *   emit: (e) => {
+ *     const entity = remoteManager.getEntity(e.targetDeviceId)
+ *     if (!entity) {
+ *       console.error('entity not found')
+ *       return
+ *     }
+ *     remoteChannel.sendClientEvent(entity, e as unknown as JSONValue)
+ *   },
+ * } satisfies Adaptor
+ *
+ * export const remote = new Remote<RemoteFuncsFromServer, RemoteFuncsFromClient>(
+ *   remoteAdaptor,
+ *   {
+ *     deviceId: 'server',
+ *   }
+ * )
+ *
+ * remote.register('initConnection', async () => {
+ *   // 什么也不干，单纯的让客户端在服务端“备案”
+ * })
+ *
+ * export const getEntity = remoteManager.getEntity.bind(remoteManager)
+ * export const getIdByEntity = remoteManager.getIdByEntity.bind(remoteManager)
+ * export const waitForRegister = remoteManager.waitForRegister.bind(remoteManager)
+ * export const remoteTo = remoteManager.remoteTo.bind(remoteManager)
+ * ```
+ */
+export class ServerSideRemoteChannelEventManager<
+  T extends GamePlayerEntityLike,
+> extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  entityMap: [string, T][] = []
+
+  constructor(remoteChannel: RemoteChannel<T>) {
+    super()
+    remoteChannel.onServerEvent((e) => {
+      const { args } = e
+      if (!isRemoteAdaptorData(args)) {
+        return
+      }
+      const prevItem = this.entityMap.find(
+        (item) => item[1].player.userKey === e.entity.player.userKey
+      )
+      if (prevItem) {
+        prevItem[0] = args.deviceId
+        prevItem[1] = e.entity
+      } else {
+        this.entityMap.push([args.deviceId, e.entity])
+      }
+      if (!isRemoteValueEvent(args.name)) {
+        this.emit('__remote_every__', args)
+      }
+      this.emit(args.name, args)
+    })
+  }
+
+  onPlayerLeave(e: { entity: T }) {
+    this.entityMap = this.entityMap.filter(
+      (item) => item[1].player.userKey !== e.entity.player.userKey
+    )
+  }
+
+  onEvery(fn: (args: AdaptorPackageData) => void): void {
+    this.on('__remote_every__', fn)
+  }
+
+  waitForRegister(entity: T) {
+    return new Promise<void>((resolve) => {
+      if (
+        this.entityMap.some(
+          ([_, en]) => en.player.userKey === entity.player.userKey
+        )
+      ) {
+        resolve()
+        return
+      }
+      this.once('__remote_every__', () => {
+        resolve()
+      })
+    })
+  }
+
+  getEntity(deviceId: string): T | undefined {
+    return this.entityMap.find((item) => item[0] === deviceId)?.[1]
+  }
+
+  getIdByEntity(entity: T): string | undefined {
+    return this.entityMap.find(
+      (item) => item[1].player.userKey === entity.player.userKey
+    )?.[0]
+  }
+
+  remoteTo(config: { target: T }): {
+    targetDeviceId: string
+  }
+  remoteTo(config: { target: T; timeoutMs: number }): {
+    targetDeviceId: string
+    timeoutMs: number
+  }
+  remoteTo({ target, ...rest }: { target: T; timeoutMs?: number }) {
+    return {
+      targetDeviceId: this.getIdByEntity(target),
+      ...rest,
+    }
+  }
+}

package/src/adaptors/electron/constants.ts

@@ -0,0 +1,3 @@
+export const MESSENGER_EVENT_NAME = '__remote-messenger-event__'
+export const MESSENGER_KEY = '__remote_messenger__'
+export const KEYOF_GET_ID = '__get-webcontents-id__'

package/src/adaptors/electron/main.ts

@@ -0,0 +1,59 @@
+import EventEmitter from 'eventemitter3'
+
+import { BrowserWindow, ipcMain } from 'electron'
+import { Adaptor, AdaptorPackageData } from '../../adaptor'
+import { isRemoteAdaptorData } from '../../remote'
+import { KEYOF_GET_ID, MESSENGER_EVENT_NAME } from './constants'
+
+class RemoteEventManager extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  EVERY_EVENT_NAME = '__remote_every__'
+
+  constructor() {
+    super()
+    ipcMain.on(MESSENGER_EVENT_NAME, (_, data) => {
+      if (isRemoteAdaptorData(data)) {
+        this.emit(data.name, data)
+        // 一定要抛出 every 事件，remote 包基于此处理远端的响应
+        this.emit(this.EVERY_EVENT_NAME, data)
+      }
+    })
+  }
+
+  onEvery(fn: (data: AdaptorPackageData) => void) {
+    this.on(this.EVERY_EVENT_NAME, fn)
+  }
+}
+
+export function onElectronMainEmit(data: AdaptorPackageData) {
+  // 主进程通过 webContents 发送消息到渲染进程
+  const allWindows = BrowserWindow.getAllWindows()
+  const win = allWindows.find(
+    (w) => w.webContents.id.toString() === data.targetDeviceId
+  )
+  win?.webContents.send(MESSENGER_EVENT_NAME, data)
+}
+
+interface Options {
+  onEmit?: (data: AdaptorPackageData) => void
+}
+
+export function createElectronMainAdaptor(options?: Options) {
+  const onEmit = options?.onEmit ?? onElectronMainEmit
+  const remoteEventManager = new RemoteEventManager()
+
+  const adaptor: Adaptor = {
+    every: remoteEventManager.onEvery.bind(remoteEventManager),
+    on: remoteEventManager.on.bind(remoteEventManager),
+    once: remoteEventManager.once.bind(remoteEventManager),
+    off: remoteEventManager.off.bind(remoteEventManager),
+    emit: onEmit,
+  }
+
+  return adaptor
+}
+
+export function initMessengerInMain() {
+  ipcMain.handle(KEYOF_GET_ID, (event) => event.sender.id.toString())
+}

package/src/adaptors/electron/messenger.ts

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { MESSENGER_KEY } from './constants'
+
+interface Messenger {
+  postMessage: (data: any) => void
+  getId: () => Promise<string>
+  on: (channel: string, listener: (...args: any[]) => void) => void
+}
+
+export function getMessenger() {
+  return window[MESSENGER_KEY as keyof Window] as Messenger
+}

package/src/adaptors/electron/preload.ts

@@ -0,0 +1,21 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import { KEYOF_GET_ID, MESSENGER_EVENT_NAME, MESSENGER_KEY } from './constants'
+
+/**
+ * 在 preload 进程中初始化 messenger 对象
+ */
+export function initMessengerInPreload(
+  contextBridge: Electron.ContextBridge,
+  ipcRenderer: Electron.IpcRenderer
+) {
+  contextBridge.exposeInMainWorld(MESSENGER_KEY, {
+    postMessage: (data: any) => {
+      ipcRenderer.postMessage(MESSENGER_EVENT_NAME, data)
+    },
+    getId: () => ipcRenderer.invoke(KEYOF_GET_ID),
+    on: (channel: string, listener: (...args: any[]) => void) => {
+      ipcRenderer.on(channel, (_, ...args) => listener(...args))
+    },
+  })
+}

package/src/adaptors/electron/renderer.ts

@@ -0,0 +1,52 @@
+import EventEmitter from 'eventemitter3'
+import { Adaptor, AdaptorPackageData } from '../../adaptor'
+import { isRemoteAdaptorData } from '../../remote'
+import { getMessenger } from './messenger'
+import { MESSENGER_EVENT_NAME } from './constants'
+
+class RemoteEventManager extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  EVERY_EVENT_NAME = '__remote_every__'
+
+  constructor() {
+    super()
+    if (typeof window === 'undefined') {
+      return
+    }
+    getMessenger().on(MESSENGER_EVENT_NAME, (data) => {
+      if (isRemoteAdaptorData(data)) {
+        this.emit(data.name, data)
+        // 一定要抛出 every 事件，remote 包基于此处理远端的响应
+        this.emit(this.EVERY_EVENT_NAME, data)
+      }
+    })
+  }
+
+  onEvery(fn: (data: AdaptorPackageData) => void) {
+    this.on(this.EVERY_EVENT_NAME, fn)
+  }
+}
+
+export function onElectronRendererEmit(data: AdaptorPackageData) {
+  getMessenger().postMessage(data)
+}
+
+interface Options {
+  onEmit?: (data: AdaptorPackageData) => void
+}
+
+export function createElectronRendererAdaptor(options?: Options) {
+  const onEmit = options?.onEmit ?? onElectronRendererEmit
+  const remoteEventManager = new RemoteEventManager()
+
+  const adaptor: Adaptor = {
+    every: remoteEventManager.onEvery.bind(remoteEventManager),
+    on: remoteEventManager.on.bind(remoteEventManager),
+    once: remoteEventManager.once.bind(remoteEventManager),
+    off: remoteEventManager.off.bind(remoteEventManager),
+    emit: onEmit,
+  }
+
+  return adaptor
+}

package/src/adaptors/http.ts

@@ -1,31 +1,31 @@
-import EventEmitter from 'eventemitter3'
-
-import type { Adaptor, AdaptorPackageData } from '../adaptor'
-
-class RemoteEventManager extends EventEmitter<{
-  [key: string]: [AdaptorPackageData]
-}> {
-  EVERY_EVENT_NAME = '__remote_every__'
-
-  onEvery(fn: (data: AdaptorPackageData) => void) {
-    this.on(this.EVERY_EVENT_NAME, fn)
-  }
-}
-
-export const remoteEventManager = new RemoteEventManager()
-
-export function createHttpAdaptor({
-  onEmit,
-}: {
-  onEmit: (data: AdaptorPackageData) => void
-}) {
-  const adaptor: Adaptor = {
-    every: remoteEventManager.onEvery.bind(remoteEventManager),
-    on: remoteEventManager.on.bind(remoteEventManager),
-    once: remoteEventManager.once.bind(remoteEventManager),
-    off: remoteEventManager.off.bind(remoteEventManager),
-    emit: onEmit,
-  }
-
-  return adaptor
-}
+import EventEmitter from 'eventemitter3'
+
+import type { Adaptor, AdaptorPackageData } from '../adaptor'
+
+class RemoteEventManager extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  EVERY_EVENT_NAME = '__remote_every__'
+
+  onEvery(fn: (data: AdaptorPackageData) => void) {
+    this.on(this.EVERY_EVENT_NAME, fn)
+  }
+}
+
+export const remoteEventManager = new RemoteEventManager()
+
+export function createHttpAdaptor({
+  onEmit,
+}: {
+  onEmit: (data: AdaptorPackageData) => void
+}) {
+  const adaptor: Adaptor = {
+    every: remoteEventManager.onEvery.bind(remoteEventManager),
+    on: remoteEventManager.on.bind(remoteEventManager),
+    once: remoteEventManager.once.bind(remoteEventManager),
+    off: remoteEventManager.off.bind(remoteEventManager),
+    emit: onEmit,
+  }
+
+  return adaptor
+}

package/src/adaptors/iframe.ts

@@ -1,47 +1,47 @@
-import EventEmitter from 'eventemitter3'
-import { isRemoteAdaptorData } from '../remote'
-
-import type { Adaptor, AdaptorPackageData } from '../adaptor'
-
-class RemoteEventManager extends EventEmitter<{
-  [key: string]: [AdaptorPackageData]
-}> {
-  EVERY_EVENT_NAME = '__remote_every__'
-
-  constructor() {
-    super()
-    if (typeof window === 'undefined') {
-      return
-    }
-    window.addEventListener('message', (event) => {
-      const { data } = event
-      if (isRemoteAdaptorData(data)) {
-        this.emit(data.name, data)
-        // 一定要抛出 every 事件，remote 包基于此处理远端的响应
-        this.emit(this.EVERY_EVENT_NAME, data)
-      }
-    })
-  }
-
-  onEvery(fn: (data: AdaptorPackageData) => void) {
-    this.on(this.EVERY_EVENT_NAME, fn)
-  }
-}
-
-export function createIframeAdaptor({
-  onEmit,
-}: {
-  onEmit: (data: AdaptorPackageData) => void
-}) {
-  const remoteEventManager = new RemoteEventManager()
-
-  const adaptor: Adaptor = {
-    every: remoteEventManager.onEvery.bind(remoteEventManager),
-    on: remoteEventManager.on.bind(remoteEventManager),
-    once: remoteEventManager.once.bind(remoteEventManager),
-    off: remoteEventManager.off.bind(remoteEventManager),
-    emit: onEmit,
-  }
-
-  return adaptor
-}
+import EventEmitter from 'eventemitter3'
+import { isRemoteAdaptorData } from '../remote'
+
+import type { Adaptor, AdaptorPackageData } from '../adaptor'
+
+class RemoteEventManager extends EventEmitter<{
+  [key: string]: [AdaptorPackageData]
+}> {
+  EVERY_EVENT_NAME = '__remote_every__'
+
+  constructor() {
+    super()
+    if (typeof window === 'undefined') {
+      return
+    }
+    window.addEventListener('message', (event) => {
+      const { data } = event
+      if (isRemoteAdaptorData(data)) {
+        this.emit(data.name, data)
+        // 一定要抛出 every 事件，remote 包基于此处理远端的响应
+        this.emit(this.EVERY_EVENT_NAME, data)
+      }
+    })
+  }
+
+  onEvery(fn: (data: AdaptorPackageData) => void) {
+    this.on(this.EVERY_EVENT_NAME, fn)
+  }
+}
+
+export function createIframeAdaptor({
+  onEmit,
+}: {
+  onEmit: (data: AdaptorPackageData) => void
+}) {
+  const remoteEventManager = new RemoteEventManager()
+
+  const adaptor: Adaptor = {
+    every: remoteEventManager.onEvery.bind(remoteEventManager),
+    on: remoteEventManager.on.bind(remoteEventManager),
+    once: remoteEventManager.once.bind(remoteEventManager),
+    off: remoteEventManager.off.bind(remoteEventManager),
+    emit: onEmit,
+  }
+
+  return adaptor
+}

package/src/index.ts

@@ -10,3 +10,8 @@ export * from './adaptors/iframe'
 export * from './adaptors/http'
 export * from './adaptors/dao3/client'
 export * from './adaptors/dao3/server'
+export * from './adaptors/electron/constants'
+export * from './adaptors/electron/messenger'
+export * from './adaptors/electron/main'
+export * from './adaptors/electron/preload'
+export * from './adaptors/electron/renderer'