feat: create workspace from loading existing exported file (#2122)

Co-authored-by: Himself65 <himself65@outlook.com>

apps/electron/layers/preload/src/affine-apis.ts

@@ -1,88 +1,88 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
 // NOTE: we will generate preload types from this file
 
 import { ipcRenderer } from 'electron';
 
-import type { MainEventMap } from '../../main-events';
+import type { MainIPCEventMap, MainIPCHandlerMap } from '../../constraints';
 
-// main -> renderer
-function onMainEvent<T extends keyof MainEventMap>(
-  eventName: T,
-  callback: MainEventMap[T]
-): () => void {
-  // @ts-expect-error fix me later
-  const fn = (_, ...args) => callback(...args);
-  ipcRenderer.on(eventName, fn);
-  return () => ipcRenderer.off(eventName, fn);
-}
+type WithoutFirstParameter<T> = T extends (_: any, ...args: infer P) => infer R
+  ? (...args: P) => R
+  : T;
 
-const apis = {
-  db: {
-    // workspace providers
-    getDoc: (id: string): Promise<Uint8Array | null> =>
-      ipcRenderer.invoke('db:get-doc', id),
-    applyDocUpdate: (id: string, update: Uint8Array) =>
-      ipcRenderer.invoke('db:apply-doc-update', id, update),
-    addBlob: (workspaceId: string, key: string, data: Uint8Array) =>
-      ipcRenderer.invoke('db:add-blob', workspaceId, key, data),
-    getBlob: (workspaceId: string, key: string): Promise<Uint8Array | null> =>
-      ipcRenderer.invoke('db:get-blob', workspaceId, key),
-    deleteBlob: (workspaceId: string, key: string) =>
-      ipcRenderer.invoke('db:delete-blob', workspaceId, key),
-    getPersistedBlobs: (workspaceId: string): Promise<string[]> =>
-      ipcRenderer.invoke('db:get-persisted-blobs', workspaceId),
-
-    // listeners
-    onDBUpdate: (callback: (workspaceId: string) => void) => {
-      return onMainEvent('main:on-db-update', callback);
-    },
-  },
-
-  workspace: {
-    list: (): Promise<string[]> => ipcRenderer.invoke('workspace:list'),
-    delete: (id: string): Promise<void> =>
-      ipcRenderer.invoke('workspace:delete', id),
-    // create will be implicitly called by db functions
-  },
-
-  openLoadDBFileDialog: () => ipcRenderer.invoke('ui:open-load-db-file-dialog'),
-  openSaveDBFileDialog: () => ipcRenderer.invoke('ui:open-save-db-file-dialog'),
-
-  // ui
-  onThemeChange: (theme: string) =>
-    ipcRenderer.invoke('ui:theme-change', theme),
-
-  onSidebarVisibilityChange: (visible: boolean) =>
-    ipcRenderer.invoke('ui:sidebar-visibility-change', visible),
-
-  onWorkspaceChange: (workspaceId: string) =>
-    ipcRenderer.invoke('ui:workspace-change', workspaceId),
-
-  openDBFolder: () => ipcRenderer.invoke('ui:open-db-folder'),
-
-  /**
-   * Try sign in using Google and return a request object to exchange the code for a token
-   * Not exchange in Node side because it is easier to do it in the renderer with VPN
-   */
-  getGoogleOauthCode: (): Promise<{ requestInit: RequestInit; url: string }> =>
-    ipcRenderer.invoke('ui:get-google-oauth-code'),
-
-  /**
-   * Secret backdoor to update environment variables in main process
-   */
-  updateEnv: (env: string, value: string) => {
-    ipcRenderer.invoke('main:env-update', env, value);
-  },
-  onClientUpdateInstall: () => {
-    ipcRenderer.invoke('ui:client-update-install');
-  },
-
-  onClientUpdateAvailable: (callback: (version: string) => void) => {
-    return onMainEvent('main:client-update-available', callback);
-  },
+type HandlersMap<N extends keyof MainIPCHandlerMap> = {
+  [K in keyof MainIPCHandlerMap[N]]: WithoutFirstParameter<
+    MainIPCHandlerMap[N][K]
+  >;
 };
 
+type PreloadHandlers = {
+  [N in keyof MainIPCHandlerMap]: HandlersMap<N>;
+};
+
+type MainExposedMeta = {
+  handlers: [namespace: string, handlerNames: string[]][];
+  events: [namespace: string, eventNames: string[]][];
+};
+
+// main handlers that can be invoked from the renderer process
+const apis: PreloadHandlers = (() => {
+  // the following were generated by the build script
+  // 1. bundle extra main/src/expose.ts entry
+  // 2. use generate-main-exposed-meta.mjs to generate exposed-meta.js in dist
+  //
+  // we cannot directly import main/src/handlers.ts because it will be bundled into the preload bundle
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const {
+    handlers: handlersMeta,
+  }: MainExposedMeta = require('../main/exposed-meta');
+
+  const all = handlersMeta.map(([namespace, functionNames]) => {
+    const namespaceApis = functionNames.map(name => {
+      const channel = `${namespace}:${name}`;
+      return [
+        name,
+        (...args: any[]) => {
+          return ipcRenderer.invoke(channel, ...args);
+        },
+      ];
+    });
+    return [namespace, Object.fromEntries(namespaceApis)];
+  });
+
+  return Object.fromEntries(all);
+})();
+
+// main events that can be listened to from the renderer process
+const events: MainIPCEventMap = (() => {
+  const {
+    events: eventsMeta,
+  }: MainExposedMeta = require('../main/exposed-meta');
+  const all = eventsMeta.map(([namespace, eventNames]) => {
+    const namespaceEvents = eventNames.map(name => {
+      const channel = `${namespace}:${name}`;
+      return [
+        name,
+        (callback: (...args: any[]) => void) => {
+          const fn: (
+            event: Electron.IpcRendererEvent,
+            ...args: any[]
+          ) => void = (_, ...args) => {
+            callback(...args);
+          };
+          ipcRenderer.on(channel, fn);
+          return () => {
+            ipcRenderer.off(channel, fn);
+          };
+        },
+      ];
+    });
+    return [namespace, Object.fromEntries(namespaceEvents)];
+  });
+  return Object.fromEntries(all);
+})();
+
 const appInfo = {
   electron: true,
 };
 
-export { apis, appInfo };
+export { apis, appInfo, events };

apps/electron/layers/preload/src/index.ts

@@ -14,4 +14,5 @@ import * as affineApis from './affine-apis';
  */
 
 contextBridge.exposeInMainWorld('apis', affineApis.apis);
+contextBridge.exposeInMainWorld('events', affineApis.events);
 contextBridge.exposeInMainWorld('appInfo', affineApis.appInfo);