refactor: init package @affine/workspace (#1661)

apps/web/src/components/__debug__/client/Editor.tsx

@@ -1,11 +1,11 @@
 'use client';
+import { createEmptyBlockSuiteWorkspace } from '@affine/workspace/utils';
 import type { EditorContainer } from '@blocksuite/editor';
 import type { Page } from '@blocksuite/store';
 import { Generator } from '@blocksuite/store';
 import type React from 'react';
 import { useCallback, useRef } from 'react';
 
-import { createEmptyBlockSuiteWorkspace } from '../../../utils';
 import { BlockSuiteEditor } from '../../blocksuite/block-suite-editor';
 
 const blockSuiteWorkspace = createEmptyBlockSuiteWorkspace(

apps/web/src/components/__tests__/WorkSpaceSliderBar.spec.tsx

@@ -3,6 +3,7 @@
  */
 import 'fake-indexeddb/auto';
 
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import { assertExists } from '@blocksuite/store';
 import { render, renderHook } from '@testing-library/react';
 import { createStore, getDefaultStore, Provider } from 'jotai';
@@ -20,7 +21,7 @@ import {
 import { useBlockSuiteWorkspaceHelper } from '../../hooks/use-blocksuite-workspace-helper';
 import { useWorkspacesHelper } from '../../hooks/use-workspaces';
 import { ThemeProvider } from '../../providers/ThemeProvider';
-import { pathGenerator, RemWorkspaceFlavour } from '../../shared';
+import { pathGenerator } from '../../shared';
 import { WorkSpaceSliderBar } from '../pure/workspace-slider-bar';
 
 vi.mock('../blocksuite/header/editor-mode-switch/CustomLottie', () => ({
@@ -92,7 +93,7 @@ describe('WorkSpaceSliderBar', () => {
     currentWorkspaceHook.result.current[1](id);
     const currentWorkspace = await store.get(currentWorkspaceAtom);
     expect(currentWorkspace).toBeDefined();
-    expect(currentWorkspace?.flavour).toBe(RemWorkspaceFlavour.LOCAL);
+    expect(currentWorkspace?.flavour).toBe(WorkspaceFlavour.LOCAL);
     expect(currentWorkspace?.id).toBe(id);
     const app = render(<App />);
     const card = await app.findByTestId('current-workspace');

apps/web/src/components/affine/workspace-setting-detail/index.tsx

@@ -1,4 +1,6 @@
 import { useTranslation } from '@affine/i18n';
+import type { SettingPanel, WorkspaceRegistry } from '@affine/workspace/type';
+import { settingPanel, WorkspaceFlavour } from '@affine/workspace/type';
 import type { MouseEvent } from 'react';
 import type React from 'react';
 import { Suspense, useCallback, useEffect, useMemo, useRef } from 'react';
@@ -6,12 +8,7 @@ import { preload } from 'swr';
 
 import { useIsWorkspaceOwner } from '../../../hooks/affine/use-is-workspace-owner';
 import { fetcher, QueryKey } from '../../../plugins/affine/fetcher';
-import type {
-  AffineOfficialWorkspace,
-  FlavourToWorkspace,
-  SettingPanel,
-} from '../../../shared';
-import { RemWorkspaceFlavour, settingPanel } from '../../../shared';
+import type { AffineOfficialWorkspace } from '../../../shared';
 import { CollaborationPanel } from './panel/collaboration';
 import { ExportPanel } from './panel/export';
 import { GeneralPanel } from './panel/general';
@@ -31,12 +28,12 @@ export type WorkspaceSettingDetailProps = {
   onChangeTab: (tab: SettingPanel) => void;
   onDeleteWorkspace: () => void;
   onTransferWorkspace: <
-    From extends RemWorkspaceFlavour,
-    To extends RemWorkspaceFlavour
+    From extends WorkspaceFlavour,
+    To extends WorkspaceFlavour
   >(
     from: From,
     to: To,
-    workspace: FlavourToWorkspace[From]
+    workspace: WorkspaceRegistry[From]
   ) => void;
 };
 
@@ -49,8 +46,7 @@ const panelMap = {
   },
   [settingPanel.Sync]: {
     name: 'Sync',
-    enable: (flavour: RemWorkspaceFlavour) =>
-      flavour === RemWorkspaceFlavour.AFFINE,
+    enable: (flavour: WorkspaceFlavour) => flavour === WorkspaceFlavour.AFFINE,
     ui: SyncPanel,
   },
   [settingPanel.Collaboration]: {
@@ -68,7 +64,7 @@ const panelMap = {
 } satisfies {
   [Key in SettingPanel]: {
     name: string;
-    enable?: (flavour: RemWorkspaceFlavour) => boolean;
+    enable?: (flavour: WorkspaceFlavour) => boolean;
     ui: React.FC<PanelProps>;
   };
 };

apps/web/src/components/affine/workspace-setting-detail/panel/collaboration/index.tsx

@@ -8,6 +8,7 @@ import {
 } from '@affine/component';
 import { PermissionType } from '@affine/datacenter';
 import { useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import {
   DeleteTemporarilyIcon,
   EmailIcon,
@@ -18,7 +19,6 @@ import { useCallback, useState } from 'react';
 
 import { useMembers } from '../../../../../hooks/affine/use-members';
 import type { AffineWorkspace, LocalWorkspace } from '../../../../../shared';
-import { RemWorkspaceFlavour } from '../../../../../shared';
 import { Unreachable } from '../../../affine-error-eoundary';
 import { TransformWorkspaceToAffineModal } from '../../../transform-workspace-to-affine-modal';
 import type { PanelProps } from '../../index';
@@ -194,8 +194,8 @@ const LocalCollaborationPanel: React.FC<
         }}
         onConform={() => {
           onTransferWorkspace(
-            RemWorkspaceFlavour.LOCAL,
-            RemWorkspaceFlavour.AFFINE,
+            WorkspaceFlavour.LOCAL,
+            WorkspaceFlavour.AFFINE,
             workspace
           );
           setOpen(false);
@@ -207,13 +207,13 @@ const LocalCollaborationPanel: React.FC<
 
 export const CollaborationPanel: React.FC<PanelProps> = props => {
   switch (props.workspace.flavour) {
-    case RemWorkspaceFlavour.AFFINE: {
+    case WorkspaceFlavour.AFFINE: {
       const workspace = props.workspace as AffineWorkspace;
       return (
         <AffineRemoteCollaborationPanel {...props} workspace={workspace} />
       );
     }
-    case RemWorkspaceFlavour.LOCAL: {
+    case WorkspaceFlavour.LOCAL: {
       const workspace = props.workspace as LocalWorkspace;
       return <LocalCollaborationPanel {...props} workspace={workspace} />;
     }

apps/web/src/components/affine/workspace-setting-detail/panel/general/delete/index.tsx

@@ -1,10 +1,10 @@
 import { Button, Input, Modal, ModalCloseButton } from '@affine/component';
 import { Trans, useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import { useCallback, useState } from 'react';
 
 import { useBlockSuiteWorkspaceName } from '../../../../../../hooks/use-blocksuite-workspace-name';
 import type { AffineOfficialWorkspace } from '../../../../../../shared';
-import { RemWorkspaceFlavour } from '../../../../../../shared';
 import {
   StyledButtonContent,
   StyledInputContent,
@@ -43,7 +43,7 @@ export const WorkspaceDeleteModal = ({
       <StyledModalWrapper>
         <ModalCloseButton onClick={onClose} />
         <StyledModalHeader>{t('Delete Workspace')}?</StyledModalHeader>
-        {workspace.flavour === RemWorkspaceFlavour.LOCAL ? (
+        {workspace.flavour === WorkspaceFlavour.LOCAL ? (
           <StyledTextContent>
             <Trans i18nKey="Delete Workspace Description">
               Deleting (

apps/web/src/components/affine/workspace-setting-detail/panel/general/index.tsx

@@ -1,12 +1,12 @@
 import { Button, FlexWrapper, MuiFade } from '@affine/component';
 import { useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import type React from 'react';
 import { useState } from 'react';
 
 import { useIsWorkspaceOwner } from '../../../../../hooks/affine/use-is-workspace-owner';
 import { useBlockSuiteWorkspaceAvatarUrl } from '../../../../../hooks/use-blocksuite-workspace-avatar-url';
 import { useBlockSuiteWorkspaceName } from '../../../../../hooks/use-blocksuite-workspace-name';
-import { RemWorkspaceFlavour } from '../../../../../shared';
 import { Upload } from '../../../../pure/file-upload';
 import {
   CloudWorkspaceIcon,
@@ -161,7 +161,7 @@ export const GeneralPanel: React.FC<PanelProps> = ({
       <StyledRow>
         <StyledSettingKey>{t('Workspace Type')}</StyledSettingKey>
         {isOwner ? (
-          workspace.flavour === RemWorkspaceFlavour.LOCAL ? (
+          workspace.flavour === WorkspaceFlavour.LOCAL ? (
             <StyledWorkspaceInfo>
               <LocalWorkspaceIcon />
               <span>{t('Local Workspace')}</span>

apps/web/src/components/affine/workspace-setting-detail/panel/publish/index.tsx

@@ -7,6 +7,7 @@ import {
   Wrapper,
 } from '@affine/component';
 import { useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import { Box } from '@mui/material';
 import type React from 'react';
 import { useCallback, useEffect, useState } from 'react';
@@ -17,7 +18,6 @@ import type {
   AffineWorkspace,
   LocalWorkspace,
 } from '../../../../../shared';
-import { RemWorkspaceFlavour } from '../../../../../shared';
 import { Unreachable } from '../../../affine-error-eoundary';
 import { EnableAffineCloudModal } from '../../../enable-affine-cloud-modal';
 import type { WorkspaceSettingDetailProps } from '../../index';
@@ -133,8 +133,8 @@ const PublishPanelLocal: React.FC<PublishPanelLocalProps> = ({
         }}
         onConfirm={() => {
           onTransferWorkspace(
-            RemWorkspaceFlavour.LOCAL,
-            RemWorkspaceFlavour.AFFINE,
+            WorkspaceFlavour.LOCAL,
+            WorkspaceFlavour.AFFINE,
             workspace
           );
           setOpen(false);
@@ -145,9 +145,9 @@ const PublishPanelLocal: React.FC<PublishPanelLocalProps> = ({
 };
 
 export const PublishPanel: React.FC<PublishPanelProps> = props => {
-  if (props.workspace.flavour === RemWorkspaceFlavour.AFFINE) {
+  if (props.workspace.flavour === WorkspaceFlavour.AFFINE) {
     return <PublishPanelAffine {...props} workspace={props.workspace} />;
-  } else if (props.workspace.flavour === RemWorkspaceFlavour.LOCAL) {
+  } else if (props.workspace.flavour === WorkspaceFlavour.LOCAL) {
     return <PublishPanelLocal {...props} workspace={props.workspace} />;
   }
   throw new Unreachable();

apps/web/src/components/affine/workspace-setting-detail/panel/sync/index.tsx

@@ -1,11 +1,11 @@
 import { Content, FlexWrapper, styled } from '@affine/component';
 import { Trans, useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import type React from 'react';
 
 import { useCurrentUser } from '../../../../../hooks/current/use-current-user';
 import { useBlockSuiteWorkspaceAvatarUrl } from '../../../../../hooks/use-blocksuite-workspace-avatar-url';
 import { useBlockSuiteWorkspaceName } from '../../../../../hooks/use-blocksuite-workspace-name';
-import { RemWorkspaceFlavour } from '../../../../../shared';
 import { WorkspaceAvatar } from '../../../../pure/footer';
 import type { PanelProps } from '../../index';
 
@@ -17,7 +17,7 @@ export const StyledWorkspaceName = styled('span')(({ theme }) => {
 });
 
 export const SyncPanel: React.FC<PanelProps> = ({ workspace }) => {
-  if (workspace.flavour !== RemWorkspaceFlavour.AFFINE) {
+  if (workspace.flavour !== WorkspaceFlavour.AFFINE) {
     throw new TypeError('SyncPanel can only be used with Affine workspace');
   }
   const [name] = useBlockSuiteWorkspaceName(workspace.blockSuiteWorkspace);

apps/web/src/components/blocksuite/header/header-right-items/SyncUser.tsx

@@ -1,5 +1,6 @@
 import { displayFlex, IconButton, styled, Tooltip } from '@affine/component';
 import { useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import {
   CloudWorkspaceIcon,
   LocalWorkspaceIcon,
@@ -15,7 +16,6 @@ import type {
   AffineOfficialWorkspace,
   LocalWorkspace,
 } from '../../../../shared';
-import { RemWorkspaceFlavour } from '../../../../shared';
 import { apis } from '../../../../shared/apis';
 import { TransformWorkspaceToAffineModal } from '../../../affine/transform-workspace-to-affine-modal';
 
@@ -117,10 +117,10 @@ export const SyncUser = () => {
               router.reload();
               return;
             }
-            assertEquals(workspace.flavour, RemWorkspaceFlavour.LOCAL);
+            assertEquals(workspace.flavour, WorkspaceFlavour.LOCAL);
             const id = await transformWorkspace(
-              RemWorkspaceFlavour.LOCAL,
-              RemWorkspaceFlavour.AFFINE,
+              WorkspaceFlavour.LOCAL,
+              WorkspaceFlavour.AFFINE,
               workspace as LocalWorkspace
             );
             // fixme(himself65): refactor this

apps/web/src/components/pure/workspace-card/index.tsx

@@ -1,12 +1,12 @@
 import { PermissionType } from '@affine/datacenter';
 import { useTranslation } from '@affine/i18n';
+import { WorkspaceFlavour } from '@affine/workspace/type';
 import { SettingsIcon } from '@blocksuite/icons';
 import type React from 'react';
 import { useCallback } from 'react';
 
 import { useBlockSuiteWorkspaceName } from '../../../hooks/use-blocksuite-workspace-name';
 import type { RemWorkspace } from '../../../shared';
-import { RemWorkspaceFlavour } from '../../../shared';
 import {
   CloudWorkspaceIcon,
   JoinedWorkspaceIcon,
@@ -28,13 +28,13 @@ export type WorkspaceTypeProps = {
 const WorkspaceType: React.FC<WorkspaceTypeProps> = ({ workspace }) => {
   const { t } = useTranslation();
   let isOwner = true;
-  if (workspace.flavour === RemWorkspaceFlavour.AFFINE) {
+  if (workspace.flavour === WorkspaceFlavour.AFFINE) {
     isOwner = workspace.permission === PermissionType.Owner;
-  } else if (workspace.flavour === RemWorkspaceFlavour.LOCAL) {
+  } else if (workspace.flavour === WorkspaceFlavour.LOCAL) {
     isOwner = true;
   }
 
-  if (workspace.flavour === RemWorkspaceFlavour.LOCAL) {
+  if (workspace.flavour === WorkspaceFlavour.LOCAL) {
     return (
       <p title={t('Local Workspace')}>
         <LocalWorkspaceIcon />
@@ -85,19 +85,18 @@ export const WorkspaceCard: React.FC<WorkspaceCardProps> = ({
       <StyleWorkspaceInfo>
         <StyleWorkspaceTitle>{name}</StyleWorkspaceTitle>
         <WorkspaceType workspace={workspace} />
-        {workspace.flavour === RemWorkspaceFlavour.LOCAL && (
+        {workspace.flavour === WorkspaceFlavour.LOCAL && (
           <p title={t('Available Offline')}>
             <LocalDataIcon />
             <span>{t('Available Offline')}</span>
           </p>
         )}
-        {workspace.flavour === RemWorkspaceFlavour.AFFINE &&
-          workspace.public && (
-            <p title={t('Published to Web')}>
-              <PublishIcon />
-              <span>{t('Published to Web')}</span>
-            </p>
-          )}
+        {workspace.flavour === WorkspaceFlavour.AFFINE && workspace.public && (
+          <p title={t('Published to Web')}>
+            <PublishIcon />
+            <span>{t('Published to Web')}</span>
+          </p>
+        )}
       </StyleWorkspaceInfo>
       <StyledSettingLink
         className="setting-entry"