fix: move workspace to top level (#2717)

(cherry picked from commit 4958d096b0)

packages/workspace/src/affine/__tests__/api.spec.ts

@@ -6,6 +6,11 @@ import 'fake-indexeddb/auto';
 import { readFile } from 'node:fs/promises';
 
 import { MessageCode } from '@affine/env/constant';
+import { WorkspaceFlavour } from '@affine/env/workspace';
+import {
+  createWorkspaceResponseSchema,
+  usageResponseSchema,
+} from '@affine/env/workspace/legacy-cloud';
 import user1 from '@affine-test/fixtures/built-in-user1.json';
 import user2 from '@affine-test/fixtures/built-in-user2.json';
 import { __unstableSchemas, AffineSchemas } from '@blocksuite/blocks/models';
@@ -17,15 +22,8 @@ import { beforeEach, describe, expect, test, vi } from 'vitest';
 import { WebSocket } from 'ws';
 import { applyUpdate } from 'yjs';
 
-import { WorkspaceFlavour } from '../../type';
 import { createEmptyBlockSuiteWorkspace } from '../../utils';
-import {
-  createUserApis,
-  createWorkspaceApis,
-  createWorkspaceResponseSchema,
-  RequestError,
-  usageResponseSchema,
-} from '../api';
+import { createUserApis, createWorkspaceApis, RequestError } from '../api';
 import { createStatusApis } from '../api/status';
 import { KeckProvider } from '../keck';
 import {

packages/workspace/src/affine/__tests__/sync.spec.ts

@@ -3,6 +3,9 @@
  */
 import 'fake-indexeddb/auto';
 
+import { WorkspaceFlavour } from '@affine/env/workspace';
+import type { Workspace } from '@affine/env/workspace/legacy-cloud';
+import { PermissionType } from '@affine/env/workspace/legacy-cloud';
 import user1 from '@affine-test/fixtures/built-in-user1.json';
 import user2 from '@affine-test/fixtures/built-in-user2.json';
 import type { ParagraphBlockModel } from '@blocksuite/blocks/models';
@@ -13,10 +16,8 @@ import { WebSocket } from 'ws';
 
 import type { LoginResponse } from '../../affine/login';
 import { loginResponseSchema } from '../../affine/login';
-import { WorkspaceFlavour } from '../../type';
 import { createEmptyBlockSuiteWorkspace } from '../../utils';
-import type { Workspace } from '../api';
-import { createWorkspaceApis, PermissionType } from '../api';
+import { createWorkspaceApis } from '../api';
 import { KeckProvider } from '../keck';
 
 declare module '@blocksuite/store' {

packages/workspace/src/affine/api/index.ts

@@ -1,5 +1,20 @@
 import { MessageCode, Messages } from '@affine/env';
-import { z } from 'zod';
+import type {
+  AcceptInvitingParams,
+  DeleteWorkspaceParams,
+  GetUserByEmailParams,
+  GetWorkspaceDetailParams,
+  InviteMemberParams,
+  LeaveWorkspaceParams,
+  Member,
+  Permission,
+  RemoveMemberParams,
+  UpdateWorkspaceParams,
+  UsageResponse,
+  User,
+  Workspace,
+  WorkspaceDetail,
+} from '@affine/env/workspace/legacy-cloud';
 
 import { checkLoginStorage } from '../login';
 
@@ -28,28 +43,6 @@ function sendMessage(code: (typeof MessageCode)[keyof typeof MessageCode]) {
   );
 }
 
-export interface User {
-  id: string;
-  name: string;
-  email: string;
-  avatar_url: string;
-  create_at: string;
-}
-
-export interface GetUserByEmailParams {
-  email: string;
-  workspace_id: string;
-}
-
-export const usageResponseSchema = z.object({
-  blob_usage: z.object({
-    usage: z.number(),
-    max_usage: z.number(),
-  }),
-});
-
-export type UsageResponse = z.infer<typeof usageResponseSchema>;
-
 export function createUserApis(prefixUrl = '/') {
   return {
     getUsage: async (): Promise<UsageResponse> => {
@@ -78,112 +71,6 @@ export function createUserApis(prefixUrl = '/') {
   } as const;
 }
 
-export interface GetWorkspaceDetailParams {
-  id: string;
-}
-
-export enum WorkspaceType {
-  Private = 0,
-  Normal = 1,
-}
-
-export enum PermissionType {
-  Read = 0,
-  Write = 1,
-  Admin = 10,
-  Owner = 99,
-}
-
-export const userSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  email: z.string(),
-  avatar_url: z.string(),
-  created_at: z.number(),
-});
-
-export const workspaceSchema = z.object({
-  id: z.string(),
-  type: z.nativeEnum(WorkspaceType),
-  public: z.boolean(),
-  permission: z.nativeEnum(PermissionType),
-});
-
-export type Workspace = z.infer<typeof workspaceSchema>;
-
-export const workspaceDetailSchema = z.object({
-  ...workspaceSchema.shape,
-  permission: z.undefined(),
-  owner: userSchema,
-  member_count: z.number(),
-});
-
-export type WorkspaceDetail = z.infer<typeof workspaceDetailSchema>;
-
-export interface Permission {
-  id: string;
-  type: PermissionType;
-  workspace_id: string;
-  user_id: string;
-  user_email: string;
-  accepted: boolean;
-  create_at: number;
-}
-
-export interface RegisteredUser extends User {
-  type: 'Registered';
-}
-
-export interface UnregisteredUser {
-  type: 'Unregistered';
-  email: string;
-}
-
-export interface Member extends Permission {
-  user: RegisteredUser | UnregisteredUser;
-}
-
-export interface GetWorkspaceMembersParams {
-  id: string;
-}
-
-export interface CreateWorkspaceParams {
-  name: string;
-}
-
-export interface UpdateWorkspaceParams {
-  id: string;
-  public: boolean;
-}
-
-export interface DeleteWorkspaceParams {
-  id: string;
-}
-
-export interface InviteMemberParams {
-  id: string;
-  email: string;
-}
-
-export interface RemoveMemberParams {
-  permissionId: number;
-}
-
-export interface AcceptInvitingParams {
-  invitingCode: string;
-}
-
-export interface LeaveWorkspaceParams {
-  id: number | string;
-}
-
-export const createWorkspaceResponseSchema = z.object({
-  id: z.string(),
-  public: z.boolean(),
-  type: z.nativeEnum(WorkspaceType),
-  created_at: z.number(),
-});
-
 export function createWorkspaceApis(prefixUrl = '/') {
   return {
     getWorkspaces: async (): Promise<Workspace[]> => {

packages/workspace/src/affine/channel.ts

@@ -1,10 +1,10 @@
 import { DebugLogger } from '@affine/debug';
+import { WorkspaceFlavour } from '@affine/env/workspace';
 import { assertExists } from '@blocksuite/global/utils';
 import * as url from 'lib0/url';
 import * as websocket from 'lib0/websocket';
 
 import { getLoginStorage, isExpired, parseIdToken } from '../affine/login';
-import { WorkspaceFlavour } from '../type';
 import { cleanupWorkspace } from '../utils';
 
 const RECONNECT_INTERVAL_TIME = 500;

packages/workspace/src/affine/sync.ts

@@ -1,15 +1,18 @@
 import { DebugLogger } from '@affine/debug';
 import { websocketPrefixUrl } from '@affine/env/api';
+import type { WorkspaceCRUD } from '@affine/env/workspace';
+import type { WorkspaceFlavour } from '@affine/env/workspace';
+import {
+  workspaceDetailSchema,
+  workspaceSchema,
+} from '@affine/env/workspace/legacy-cloud';
 import { assertExists } from '@blocksuite/global/utils';
 import type { Disposable } from '@blocksuite/store';
 import { z } from 'zod';
 
-import { workspaceDetailSchema, workspaceSchema } from '../affine/api';
 import { WebsocketClient } from '../affine/channel';
 import { storageChangeSlot } from '../affine/login';
 import { rootStore, rootWorkspacesMetadataAtom } from '../atom';
-import type { WorkspaceCRUD } from '../type';
-import type { WorkspaceFlavour } from '../type';
 
 const logger = new DebugLogger('affine-sync');
 

packages/workspace/src/atom.ts

@@ -1,10 +1,9 @@
+import type { WorkspaceFlavour } from '@affine/env/workspace';
 import type { EditorContainer } from '@blocksuite/editor';
 import { atom, createStore } from 'jotai';
 import { atomWithStorage, createJSONStorage } from 'jotai/utils';
 import Router from 'next/router';
 
-import type { WorkspaceFlavour } from './type';
-
 export type RootWorkspaceMetadata = {
   id: string;
   flavour: WorkspaceFlavour;

packages/workspace/src/local/__tests__/crud.spec.ts

@@ -3,12 +3,12 @@
  */
 import 'fake-indexeddb/auto';
 
+import type { LocalWorkspace, WorkspaceCRUD } from '@affine/env/workspace';
+import { WorkspaceFlavour } from '@affine/env/workspace';
 import { __unstableSchemas, AffineSchemas } from '@blocksuite/blocks/models';
 import { Workspace } from '@blocksuite/store';
 import { afterEach, assertType, describe, expect, test } from 'vitest';
 
-import type { LocalWorkspace, WorkspaceCRUD } from '../../type';
-import { WorkspaceFlavour } from '../../type';
 import { CRUD } from '../crud';
 
 afterEach(() => {

packages/workspace/src/local/crud.ts

@@ -1,12 +1,12 @@
 import { DebugLogger } from '@affine/debug';
+import type { LocalWorkspace, WorkspaceCRUD } from '@affine/env/workspace';
+import { WorkspaceFlavour } from '@affine/env/workspace';
 import { nanoid, Workspace as BlockSuiteWorkspace } from '@blocksuite/store';
 import { createIndexedDBProvider } from '@toeverything/y-indexeddb';
 import { createJSONStorage } from 'jotai/utils';
 import { z } from 'zod';
 
 import { createLocalProviders } from '../providers';
-import type { LocalWorkspace, WorkspaceCRUD } from '../type';
-import { WorkspaceFlavour } from '../type';
 import { createEmptyBlockSuiteWorkspace } from '../utils';
 
 const getStorage = () => createJSONStorage(() => localStorage);

packages/workspace/src/providers/__tests__/sqlite-provider.spec.ts

@@ -1,9 +1,12 @@
+import type {
+  SQLiteDBDownloadProvider,
+  SQLiteProvider,
+} from '@affine/env/workspace';
 import { __unstableSchemas, AffineSchemas } from '@blocksuite/blocks/models';
 import type { Y as YType } from '@blocksuite/store';
 import { uuidv4, Workspace } from '@blocksuite/store';
 import { beforeEach, describe, expect, test, vi } from 'vitest';
 
-import type { SQLiteDBDownloadProvider, SQLiteProvider } from '../../type';
 import { createSQLiteDBDownloadProvider, createSQLiteProvider } from '../index';
 
 const Y = Workspace.Y;

packages/workspace/src/providers/affine-download.ts

@@ -1,8 +1,8 @@
 import { DebugLogger } from '@affine/debug';
+import type { AffineDownloadProvider } from '@affine/env/workspace';
 import { assertExists, Workspace } from '@blocksuite/store';
 
 import { affineApis } from '../affine/shared';
-import type { AffineDownloadProvider } from '../type';
 
 const hashMap = new Map<string, ArrayBuffer>();
 

packages/workspace/src/providers/broad-cast-channel/index.ts

@@ -1,3 +1,4 @@
+import type { BroadCastChannelProvider } from '@affine/env/workspace';
 import { Workspace as BlockSuiteWorkspace } from '@blocksuite/store';
 import { assertExists } from '@blocksuite/store';
 import type { Awareness } from 'y-protocols/awareness';
@@ -6,7 +7,6 @@ import {
   encodeAwarenessUpdate,
 } from 'y-protocols/awareness';
 
-import type { BroadCastChannelProvider } from '../../type';
 import { CallbackSet } from '../../utils';
 import { localProviderLogger } from '../logger';
 import type {

packages/workspace/src/providers/index.ts

@@ -1,4 +1,12 @@
 import { config, websocketPrefixUrl } from '@affine/env';
+import type {
+  AffineWebSocketProvider,
+  LocalIndexedDBBackgroundProvider,
+  LocalIndexedDBDownloadProvider,
+  Provider,
+  SQLiteDBDownloadProvider,
+  SQLiteProvider,
+} from '@affine/env/workspace';
 import type { BlobManager, Disposable } from '@blocksuite/store';
 import {
   assertExists,
@@ -12,14 +20,6 @@ import {
 
 import { KeckProvider } from '../affine/keck';
 import { getLoginStorage, storageChangeSlot } from '../affine/login';
-import type {
-  AffineWebSocketProvider,
-  LocalIndexedDBBackgroundProvider,
-  LocalIndexedDBDownloadProvider,
-  Provider,
-  SQLiteDBDownloadProvider,
-  SQLiteProvider,
-} from '../type';
 import { CallbackSet } from '../utils';
 import { createAffineDownloadProvider } from './affine-download';
 import { createBroadCastChannelProvider } from './broad-cast-channel';

packages/workspace/src/type.ts

@@ -1,232 +0,0 @@
-import type { View } from '@affine/component/page-list/filter/shared-types';
-import type { EditorContainer } from '@blocksuite/editor';
-import type { Page } from '@blocksuite/store';
-import type { Workspace as BlockSuiteWorkspace } from '@blocksuite/store';
-import type { FC, PropsWithChildren } from 'react';
-
-import type { Workspace as RemoteWorkspace } from './affine/api';
-
-export enum WorkspaceSubPath {
-  ALL = 'all',
-  SETTING = 'setting',
-  TRASH = 'trash',
-  SHARED = 'shared',
-}
-
-export type BaseProvider = {
-  flavour: string;
-
-  // cleanup data when workspace is removed
-  cleanup: () => void;
-};
-
-/**
- * @description
- * If a provider is marked as a background provider,
- *  we will connect it in the `useEffect` in React.js.
- *
- * This means that the data might be stale when you use it.
- */
-export interface BackgroundProvider extends BaseProvider {
-  // if this is true,
-  //  we will connect the provider on the background
-  background: true;
-  get connected(): boolean;
-  connect(): void;
-  disconnect(): void;
-  callbacks: Set<() => void>;
-}
-
-/**
- * @description
- * If a provider is marked as a necessary provider,
- *  we will connect it once you read the workspace.
- *
- * This means that the data will be fresh when you use it.
- *
- * Currently, there is only on necessary provider: `local-indexeddb`.
- */
-export interface NecessaryProvider extends Omit<BaseProvider, 'disconnect'> {
-  // if this is true,
-  //  we will ensure that the provider is connected before you can use it
-  necessary: true;
-  sync(): void;
-  get whenReady(): Promise<void>;
-}
-
-export interface AffineDownloadProvider extends BackgroundProvider {
-  flavour: 'affine-download';
-}
-
-/**
- * Download the first binary from local indexeddb
- */
-export interface BroadCastChannelProvider extends BackgroundProvider {
-  flavour: 'broadcast-channel';
-}
-
-/**
- * Long polling provider with local indexeddb
- */
-export interface LocalIndexedDBBackgroundProvider extends BackgroundProvider {
-  flavour: 'local-indexeddb-background';
-}
-
-export interface LocalIndexedDBDownloadProvider extends NecessaryProvider {
-  flavour: 'local-indexeddb';
-}
-
-export interface SQLiteProvider extends BackgroundProvider {
-  flavour: 'sqlite';
-}
-
-export interface SQLiteDBDownloadProvider extends NecessaryProvider {
-  flavour: 'sqlite-download';
-}
-
-export interface AffineWebSocketProvider extends BackgroundProvider {
-  flavour: 'affine-websocket';
-}
-
-export type Provider = BackgroundProvider | NecessaryProvider;
-
-export interface AffineLegacyCloudWorkspace extends RemoteWorkspace {
-  flavour: WorkspaceFlavour.AFFINE;
-  // empty
-  blockSuiteWorkspace: BlockSuiteWorkspace;
-  providers: Provider[];
-}
-
-// todo: update type with nest.js
-export type AffineCloudWorkspace = LocalWorkspace;
-
-export interface LocalWorkspace {
-  flavour: WorkspaceFlavour.LOCAL;
-  id: string;
-  blockSuiteWorkspace: BlockSuiteWorkspace;
-  providers: Provider[];
-}
-
-export interface AffinePublicWorkspace {
-  flavour: WorkspaceFlavour.PUBLIC;
-  id: string;
-  blockSuiteWorkspace: BlockSuiteWorkspace;
-  providers: Provider[];
-}
-
-export enum ReleaseType {
-  // if workspace is not released yet, we will not show it in the workspace list
-  UNRELEASED = 'unreleased',
-  STABLE = 'stable',
-}
-
-export enum LoadPriority {
-  HIGH = 1,
-  MEDIUM = 2,
-  LOW = 3,
-}
-
-export enum WorkspaceFlavour {
-  /**
-   * AFFiNE Workspace is the workspace
-   * that hosted on the Legacy AFFiNE Cloud Server.
-   *
-   * @deprecated
-   *  We no longer maintain this kind of workspace, please use AFFiNE-Cloud instead.
-   */
-  AFFINE = 'affine',
-  /**
-   * New AFFiNE Cloud Workspace using Nest.js Server.
-   */
-  AFFINE_CLOUD = 'affine-cloud',
-  LOCAL = 'local',
-  PUBLIC = 'affine-public',
-}
-
-export const settingPanel = {
-  General: 'general',
-  Collaboration: 'collaboration',
-  Publish: 'publish',
-  Export: 'export',
-  Sync: 'sync',
-} as const;
-export const settingPanelValues = [...Object.values(settingPanel)] as const;
-export type SettingPanel = (typeof settingPanel)[keyof typeof settingPanel];
-
-// built-in workspaces
-export interface WorkspaceRegistry {
-  [WorkspaceFlavour.AFFINE]: AffineLegacyCloudWorkspace;
-  [WorkspaceFlavour.LOCAL]: LocalWorkspace;
-  [WorkspaceFlavour.PUBLIC]: AffinePublicWorkspace;
-  // todo: update workspace type to new
-  [WorkspaceFlavour.AFFINE_CLOUD]: AffineCloudWorkspace;
-}
-
-export interface WorkspaceCRUD<Flavour extends keyof WorkspaceRegistry> {
-  create: (blockSuiteWorkspace: BlockSuiteWorkspace) => Promise<string>;
-  delete: (workspace: WorkspaceRegistry[Flavour]) => Promise<void>;
-  get: (workspaceId: string) => Promise<WorkspaceRegistry[Flavour] | null>;
-  // not supported yet
-  // update: (workspace: FlavourToWorkspace[Flavour]) => Promise<void>;
-  list: () => Promise<WorkspaceRegistry[Flavour][]>;
-}
-
-type UIBaseProps<Flavour extends keyof WorkspaceRegistry> = {
-  currentWorkspace: WorkspaceRegistry[Flavour];
-};
-
-export type WorkspaceHeaderProps<Flavour extends keyof WorkspaceRegistry> =
-  UIBaseProps<Flavour> & {
-    currentEntry:
-      | {
-          subPath: WorkspaceSubPath;
-        }
-      | {
-          pageId: string;
-        };
-  };
-
-type SettingProps<Flavour extends keyof WorkspaceRegistry> =
-  UIBaseProps<Flavour> & {
-    currentTab: SettingPanel;
-    onChangeTab: (tab: SettingPanel) => void;
-    onDeleteWorkspace: () => Promise<void>;
-    onTransformWorkspace: <
-      From extends keyof WorkspaceRegistry,
-      To extends keyof WorkspaceRegistry
-    >(
-      from: From,
-      to: To,
-      workspace: WorkspaceRegistry[From]
-    ) => void;
-  };
-
-type PageDetailProps<Flavour extends keyof WorkspaceRegistry> =
-  UIBaseProps<Flavour> & {
-    currentPageId: string;
-    onLoadEditor: (page: Page, editor: EditorContainer) => () => void;
-  };
-
-type PageListProps<_Flavour extends keyof WorkspaceRegistry> = {
-  blockSuiteWorkspace: BlockSuiteWorkspace;
-  onOpenPage: (pageId: string, newTab?: boolean) => void;
-  view: View;
-};
-
-export interface WorkspaceUISchema<Flavour extends keyof WorkspaceRegistry> {
-  Header: FC<WorkspaceHeaderProps<Flavour>>;
-  PageDetail: FC<PageDetailProps<Flavour>>;
-  PageList: FC<PageListProps<Flavour>>;
-  SettingsDetail: FC<SettingProps<Flavour>>;
-  Provider: FC<PropsWithChildren>;
-}
-
-export interface AppEvents {
-  // event there is no workspace
-  // usually used to initialize workspace plugin
-  'app:init': () => string[];
-  // request to gain access to workspace plugin
-  'workspace:access': () => Promise<void>;
-  // request to revoke access to workspace plugin
-  'workspace:revoke': () => Promise<void>;
-}

packages/workspace/src/utils.ts

@@ -1,3 +1,4 @@
+import { WorkspaceFlavour } from '@affine/env/workspace';
 import { __unstableSchemas, AffineSchemas } from '@blocksuite/blocks/models';
 import type { Generator, StoreOptions } from '@blocksuite/store';
 import { createIndexeddbStorage, Workspace } from '@blocksuite/store';
@@ -6,7 +7,6 @@ import type { createWorkspaceApis } from './affine/api';
 import { rootStore, rootWorkspacesMetadataAtom } from './atom';
 import { createAffineBlobStorage } from './blob';
 import { createSQLiteStorage } from './blob/sqlite-blob-storage';
-import { WorkspaceFlavour } from './type';
 
 export function cleanupWorkspace(flavour: WorkspaceFlavour) {
   rootStore.set(rootWorkspacesMetadataAtom, metas =>

packages/workspace/tsconfig.json

@@ -12,7 +12,6 @@
     { "path": "../env" },
     { "path": "../debug" },
     { "path": "../hooks" },
-    { "path": "../component/tsconfig.workspace.json" },
     { "path": "../../apps/electron" }
   ]
 }