refactor: move ipc method and types to data-center folder

client-app/scripts/generateTsTypingsFromJsonSchema.mjs

@@ -10,16 +10,24 @@ import path from 'path';
 import { compileFromFile } from 'json-schema-to-typescript';
 import { cd } from 'zx/core';
 
+const projectRoot = path.join(__dirname, '..', '..');
+const tsTypingsFolder = path.join(
+  projectRoot,
+  'packages/data-center/src/provider/tauri-ipc/ipc/types'
+);
+
 /**
  * 1. generate JSONSchema using rs crate `schemars`, this happened on rs side script `src-tauri/examples/generate-jsonschema.rs`
  */
 cd('./src-tauri');
+try {
+  fs.mkdirSync(tsTypingsFolder);
+} catch {}
 await $`cargo run --example generate-jsonschema`;
 
 /**
  * 2. generate TS from JSON schema, this is efficient on NodeJS side.
  */
-const tsTypingsFolder = path.join(__dirname, '..', 'src', 'types', 'ipc');
 const fileNames = fs.readdirSync(tsTypingsFolder);
 const jsonSchemaFilePaths = fileNames
   .filter(fileName => fileName.endsWith('.json'))
@@ -37,6 +45,7 @@ await Promise.all(
 /**
  * 3. fix eslint error on generated ts files
  */
+cd(path.join(projectRoot, 'packages/data-center'));
 await $`eslint ${tsTypingsFolder} --ext ts --fix`;
 
 /**

client-app/src-tauri/examples/generate-jsonschema.rs

@@ -1,6 +1,4 @@
-use ipc_types::{
-  blob::IBlobParameters, document::YDocumentUpdate, workspace::CreateWorkspace,
-};
+use ipc_types::{blob::IBlobParameters, document::YDocumentUpdate, workspace::CreateWorkspace};
 /**
  * convert serde to jsonschema: https://imfeld.dev/writing/generating_typescript_types_from_rust
  *  with way to optimize
@@ -24,7 +22,12 @@ where
 
 fn main() {
   let project_root = &get_project_root().unwrap();
-  generate::<YDocumentUpdate>(Path::join(project_root, "../src/types/ipc/document.json"));
-  generate::<CreateWorkspace>(Path::join(project_root, "../src/types/ipc/workspace.json"));
-  generate::<IBlobParameters>(Path::join(project_root, "../src/types/ipc/blob.json"));
+  let mono_repo_root = Path::join(project_root, "../..");
+  let data_center_ipc_type_folder = Path::join(
+    &mono_repo_root,
+    "packages/data-center/src/provider/tauri-ipc/ipc/types",
+  );
+  generate::<YDocumentUpdate>(Path::join(&data_center_ipc_type_folder, "document.json"));
+  generate::<CreateWorkspace>(Path::join(&data_center_ipc_type_folder, "workspace.json"));
+  generate::<IBlobParameters>(Path::join(&data_center_ipc_type_folder, "blob.json"));
 }

client-app/src/ipc/TauriIPCProvider.ts

@@ -1,54 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-/* eslint-disable @typescript-eslint/no-unused-vars */
-/* eslint-disable @typescript-eslint/no-empty-function */
-import * as Y from 'yjs';
-import { Observable } from 'lib0/observable';
-import { DocProvider } from '@blocksuite/store';
-import type { Awareness } from 'y-protocols/awareness';
-import { invoke } from '@tauri-apps/api';
-import { updateYDocument } from './methods';
-
-export class TauriIPCProvider
-  extends Observable<string>
-  implements DocProvider
-{
-  #yDocument: Y.Doc;
-  constructor(
-    room: string,
-    yDocument: Y.Doc,
-    options?: { awareness?: Awareness }
-  ) {
-    super();
-    this.#yDocument = yDocument;
-    this.#yDocument.on(
-      'updateV2',
-      async (
-        update: Uint8Array,
-        origin: any,
-        _yDocument: Y.Doc,
-        _transaction: Y.Transaction
-      ) => {
-        try {
-          // TODO: need handle potential data race when update is frequent?
-          // TODO: update seems too frequent upon each keydown, why no batching?
-          const success = await updateYDocument({
-            update: Array.from(update),
-            room,
-          });
-        } catch (error) {
-          // TODO: write error log to disk, and add button to open them in settings panel
-          console.error("#yDocument.on('updateV2'", error);
-        }
-      }
-    );
-  }
-
-  connect() {}
-
-  destroy() {}
-  disconnect() {
-    // do nothing
-  }
-
-  async clearData() {}
-}

client-app/src/ipc/methods.ts

@@ -1,24 +0,0 @@
-import { invoke } from '@tauri-apps/api';
-import { YDocumentUpdate } from '../types/ipc/document';
-import { CreateWorkspace } from '../types/ipc/workspace';
-import { GetBlob, PutBlob } from '../types/ipc/blob';
-
-export const updateYDocument = async (parameters: YDocumentUpdate) =>
-  await invoke<boolean>('update_y_document', {
-    parameters,
-  });
-
-export const createWorkspace = async (parameters: CreateWorkspace) =>
-  await invoke<boolean>('create_workspace', {
-    parameters,
-  });
-
-export const putBlob = async (parameters: PutBlob) =>
-  await invoke<string>('put_blob', {
-    parameters,
-  });
-
-export const getBlob = async (parameters: GetBlob) =>
-  await invoke<number[]>('get_blob', {
-    parameters,
-  });

client-app/src/types/ipc/blob.ts

@@ -14,12 +14,12 @@ export type IBlobParameters =
     };
 
 export interface PutBlob {
-  [k: string]: unknown;
   blob: number[];
   workspace_id: number;
+  [k: string]: unknown;
 }
 export interface GetBlob {
-  [k: string]: unknown;
   id: string;
   workspace_id: number;
+  [k: string]: unknown;
 }

client-app/src/types/ipc/document.ts

@@ -6,7 +6,7 @@
  */
 
 export interface YDocumentUpdate {
-  [k: string]: unknown;
   room: string;
   update: number[];
+  [k: string]: unknown;
 }

client-app/src/types/ipc/workspace.ts

@@ -6,8 +6,8 @@
  */
 
 export interface CreateWorkspace {
-  [k: string]: unknown;
   avatar: string;
   id: number;
   name: string;
+  [k: string]: unknown;
 }