refactor!: next generation AFFiNE code structure (#1176)

apps/web/src/shared/index.ts

@@ -0,0 +1,167 @@
+import { Workspace as RemoteWorkspace } from '@affine/datacenter';
+import { Workspace as BlockSuiteWorkspace } from '@blocksuite/store';
+import { NextPage } from 'next';
+import { ReactElement, ReactNode } from 'react';
+
+import { createAffineProviders } from '../blocksuite';
+import { createEmptyBlockSuiteWorkspace } from '../utils';
+import { apis } from './apis';
+
+export { BlockSuiteWorkspace };
+
+declare global {
+  interface Window {
+    CLIENT_APP?: boolean;
+  }
+}
+
+export const enum RemWorkspaceFlavour {
+  AFFINE = 'affine',
+  LOCAL = 'local',
+}
+
+export interface FlavourToWorkspace {
+  [RemWorkspaceFlavour.AFFINE]:
+    | AffineRemoteUnSyncedWorkspace
+    | AffineRemoteSyncedWorkspace;
+  [RemWorkspaceFlavour.LOCAL]: LocalWorkspace;
+}
+
+export interface WorkspaceHandler {
+  syncBinary: () => Promise<RemWorkspace | null>;
+}
+
+export interface AffineRemoteSyncedWorkspace
+  extends RemoteWorkspace,
+    WorkspaceHandler {
+  flavour: RemWorkspaceFlavour.AFFINE;
+  firstBinarySynced: true;
+  blockSuiteWorkspace: BlockSuiteWorkspace;
+  providers: Provider[];
+}
+
+export interface AffineRemoteUnSyncedWorkspace
+  extends RemoteWorkspace,
+    WorkspaceHandler {
+  flavour: RemWorkspaceFlavour.AFFINE;
+  firstBinarySynced: false;
+  // empty
+  blockSuiteWorkspace: BlockSuiteWorkspace;
+}
+
+export interface LocalWorkspace extends WorkspaceHandler {
+  flavour: RemWorkspaceFlavour.LOCAL;
+  id: string;
+  blockSuiteWorkspace: BlockSuiteWorkspace;
+  providers: Provider[];
+}
+
+export const transformToAffineSyncedWorkspace = async (
+  unSyncedWorkspace: AffineRemoteUnSyncedWorkspace,
+  binary: ArrayBuffer
+): Promise<AffineRemoteSyncedWorkspace> => {
+  const blockSuiteWorkspace = createEmptyBlockSuiteWorkspace(
+    unSyncedWorkspace.id,
+    (k: string) =>
+      // fixme: token could be expired
+      ({ api: '/api/workspace', token: apis.auth.token }[k])
+  );
+  BlockSuiteWorkspace.Y.applyUpdate(
+    blockSuiteWorkspace.doc,
+    new Uint8Array(binary)
+  );
+  return new Promise(resolve => {
+    // Fixme: https://github.com/toeverything/blocksuite/issues/1350
+    setTimeout(() => {
+      resolve({
+        ...unSyncedWorkspace,
+        blockSuiteWorkspace,
+        firstBinarySynced: true,
+        providers: [...createAffineProviders(blockSuiteWorkspace)],
+      });
+    }, 0);
+  });
+};
+
+export type BaseProvider = {
+  flavour: string;
+  connect: () => void;
+  disconnect: () => void;
+  // cleanup data when workspace is removed
+  cleanup: () => void;
+};
+
+export interface LocalIndexedDBProvider extends BaseProvider {
+  flavour: 'local-indexeddb';
+}
+
+export interface AffineWebSocketProvider extends BaseProvider {
+  flavour: 'affine-websocket';
+}
+
+export type Provider = LocalIndexedDBProvider | AffineWebSocketProvider;
+
+export type AffineRemoteWorkspace =
+  | AffineRemoteSyncedWorkspace
+  | AffineRemoteUnSyncedWorkspace;
+export type AffineOfficialWorkspace = AffineRemoteWorkspace | LocalWorkspace;
+
+export type RemWorkspace = AffineOfficialWorkspace;
+
+export type NextPageWithLayout<P = Record<string, unknown>, IP = P> = NextPage<
+  P,
+  IP
+> & {
+  getLayout?: (page: ReactElement) => ReactNode;
+};
+
+export const enum WorkspaceSubPath {
+  ALL = 'all',
+  FAVORITE = 'favorite',
+  SETTING = 'setting',
+  TRASH = 'trash',
+}
+
+export const settingPanel = {
+  General: 'general',
+  Collaboration: 'collaboration',
+  Publish: 'publish',
+  Export: 'export',
+  // TODO: add it back for desktop version
+  // Sync = 'sync'
+} as const;
+export const settingPanelValues = [...Object.values(settingPanel)] as const;
+export type SettingPanel = (typeof settingPanel)[keyof typeof settingPanel];
+
+export const WorkspaceSubPathName = {
+  [WorkspaceSubPath.ALL]: 'All Pages',
+  [WorkspaceSubPath.FAVORITE]: 'Favorites',
+  [WorkspaceSubPath.SETTING]: 'Settings',
+  [WorkspaceSubPath.TRASH]: 'Trash',
+} satisfies {
+  [Path in WorkspaceSubPath]: string;
+};
+
+export const pathGenerator = {
+  all: workspaceId => `/workspace/${workspaceId}/all`,
+  favorite: workspaceId => `/workspace/${workspaceId}/favorite`,
+  trash: workspaceId => `/workspace/${workspaceId}/trash`,
+  setting: workspaceId => `/workspace/${workspaceId}/setting`,
+} satisfies {
+  [Path in WorkspaceSubPath]: (workspaceId: string) => string;
+};
+
+export const publicPathGenerator = {
+  all: workspaceId => `/public-workspace/${workspaceId}/all`,
+  favorite: workspaceId => `/public-workspace/${workspaceId}/favorite`,
+  trash: workspaceId => `/public-workspace/${workspaceId}/trash`,
+  setting: workspaceId => `/public-workspace/${workspaceId}/setting`,
+} satisfies {
+  [Path in WorkspaceSubPath]: (workspaceId: string) => string;
+};
+
+export const enum LoadPriority {
+  HIGH = 1,
+  MEDIUM = 2,
+  LOW = 3,
+}