refactor: models -> schemas (toeverything#6312)

donteatfriedrice · Feb 28, 2024 · 8ebbb44 · 8ebbb44
1 parent 6d3a709
commit 8ebbb44
Show file tree

Hide file tree

Showing 51 changed files with 101 additions and 153 deletions.
diff --git a/packages/blocks/models.js b/packages/blocks/models.js
diff --git a/packages/blocks/package.json b/packages/blocks/package.json
@@ -58,7 +58,7 @@
   "exports": {
     "./dist/*": "./dist/*",
     ".": "./src/index.ts",
-    "./models": "./src/models.ts"
+    "./schemas": "./src/schemas.ts"
   },
   "publishConfig": {
     "access": "public",
@@ -71,9 +71,9 @@
         "module": "./dist/index.js",
         "import": "./dist/index.js"
       },
-      "./models": {
-        "types": "./dist/models.d.ts",
-        "default": "./dist/models.js"
+      "./schemas": {
+        "types": "./dist/schemas.d.ts",
+        "default": "./dist/schemas.js"
       }
     }
   },
@@ -82,7 +82,7 @@
     "dist",
     "!src/__tests__",
     "!dist/__tests__",
-    "models.d.ts",
-    "models.js"
+    "schemas.d.ts",
+    "schemas.js"
   ]
 }
diff --git a/packages/blocks/models.d.ts → packages/blocks/schemas.d.ts b/packages/blocks/models.d.ts → packages/blocks/schemas.d.ts
@@ -1,3 +1,3 @@
 /* eslint-disable */
 // @ts-ignore
-export * from './dist/models';
+export * from './dist/schemas';
diff --git a/packages/blocks/schemas.js b/packages/blocks/schemas.js
@@ -0,0 +1,3 @@
+/* eslint-disable */
+/// <reference types="./dist/schemas.d.ts" />
+export * from './dist/schemas.js';
diff --git a/packages/blocks/src/__tests__/database/database.unit.spec.ts b/packages/blocks/src/__tests__/database/database.unit.spec.ts
@@ -66,7 +66,7 @@ describe('DatabaseManager', () => {
     noteBlockId = doc.addBlock('affine:note', {}, rootId);
 
     databaseBlockId = doc.addBlock(
-      'affine:database' as BlockSuite.ModelKeys,
+      'affine:database' as BlockSuite.Flavour,
       {
         columns: [],
         titleColumn: 'Title',

diff --git a/packages/blocks/src/_common/components/embed-card/embed-card-more-menu-popper.ts b/packages/blocks/src/_common/components/embed-card/embed-card-more-menu-popper.ts
@@ -105,7 +105,7 @@ export class EmbedCardMoreMenu extends WithDisposable(LitElement) {
     const parent = doc.getParent(model);
     const index = parent?.children.indexOf(model);
     doc.addBlock(
-      model.flavour as BlockSuite.ModelKeys,
+      model.flavour as BlockSuite.Flavour,
       duplicateProps,
       parent,
       index

diff --git a/packages/blocks/src/_common/components/rich-text/rich-text-operations.ts b/packages/blocks/src/_common/components/rich-text/rich-text-operations.ts
@@ -22,7 +22,6 @@ import {
   focusTitle,
 } from '../../../_common/utils/selection.js';
 import type { ListBlockModel } from '../../../list-block/index.js';
-import type { Flavour } from '../../../models.js';
 import type { RootBlockModel } from '../../../root-block/index.js';
 import type { ExtendedModel } from '../../types.js';
 
@@ -862,7 +861,7 @@ function handleParagraphBlockForwardDelete(
     // TODO
     return false;
   } else {
-    const ignoreForwardDeleteFlavourList: Flavour[] = [
+    const ignoreForwardDeleteFlavourList: BlockSuite.Flavour[] = [
       'affine:database',
       'affine:image',
       'affine:code',

diff --git a/packages/blocks/src/_common/configs/text-conversion.ts b/packages/blocks/src/_common/configs/text-conversion.ts
@@ -1,6 +1,5 @@
 import type { TemplateResult } from 'lit';
 
-import type { BlockSchemas } from '../../models.js';
 import {
   BulletedListIcon,
   CheckBoxIcon,
@@ -22,7 +21,7 @@ import {
  * which are also used for registering hotkeys for converting block flavours.
  */
 interface TextConversionConfig {
-  flavour: keyof BlockSchemas;
+  flavour: BlockSuite.Flavour;
   type?: string;
   name: string;
   hotkey: string[] | null;

diff --git a/packages/blocks/src/_common/configs/text-format/consts.ts b/packages/blocks/src/_common/configs/text-format/consts.ts
@@ -1,14 +1,14 @@
-import type { Flavour } from '../../../models.js';
-
 // corresponding to `formatText` command
-export const FORMAT_TEXT_SUPPORT_FLAVOURS: Flavour[] = [
+export const FORMAT_TEXT_SUPPORT_FLAVOURS: BlockSuite.Flavour[] = [
   'affine:paragraph',
   'affine:list',
 ];
 // corresponding to `formatBlock` command
-export const FORMAT_BLOCK_SUPPORT_FLAVOURS: Flavour[] = [
+export const FORMAT_BLOCK_SUPPORT_FLAVOURS: BlockSuite.Flavour[] = [
   'affine:paragraph',
   'affine:list',
 ];
 // corresponding to `formatNative` command
-export const FORMAT_NATIVE_SUPPORT_FLAVOURS: Flavour[] = ['affine:database'];
+export const FORMAT_NATIVE_SUPPORT_FLAVOURS: BlockSuite.Flavour[] = [
+  'affine:database',
+];
diff --git a/packages/blocks/src/_common/configs/text-format/utils.ts b/packages/blocks/src/_common/configs/text-format/utils.ts
@@ -6,7 +6,6 @@ import {
 } from '@blocksuite/inline';
 import type { BlockElement, EditorHost } from '@blocksuite/lit';
 
-import type { Flavour } from '../../../models.js';
 import { BLOCK_ID_ATTR } from '../../consts.js';
 import type {
   AffineInlineEditor,
@@ -59,7 +58,9 @@ function getCombinedFormat(host: EditorHost): AffineTextAttributes {
         .getSelectedBlocks({
           types: ['text'],
           filter: el =>
-            FORMAT_TEXT_SUPPORT_FLAVOURS.includes(el.model.flavour as Flavour),
+            FORMAT_TEXT_SUPPORT_FLAVOURS.includes(
+              el.model.flavour as BlockSuite.Flavour
+            ),
         })
         .inline((ctx, next) => {
           const { selectedBlocks } = ctx;
@@ -89,7 +90,9 @@ function getCombinedFormat(host: EditorHost): AffineTextAttributes {
         .getSelectedBlocks({
           types: ['block'],
           filter: el =>
-            FORMAT_BLOCK_SUPPORT_FLAVOURS.includes(el.model.flavour as Flavour),
+            FORMAT_BLOCK_SUPPORT_FLAVOURS.includes(
+              el.model.flavour as BlockSuite.Flavour
+            ),
         })
         .inline((ctx, next) => {
           const { selectedBlocks } = ctx;
@@ -133,7 +136,7 @@ function getCombinedFormat(host: EditorHost): AffineTextAttributes {
             const blockElement = el.closest<BlockElement>(`[${BLOCK_ID_ATTR}]`);
             if (blockElement) {
               return FORMAT_NATIVE_SUPPORT_FLAVOURS.includes(
-                blockElement.model.flavour as Flavour
+                blockElement.model.flavour as BlockSuite.Flavour
               );
             }
             return false;
@@ -195,7 +198,9 @@ export function isFormatSupported(host: EditorHost) {
         .getSelectedBlocks({
           types: ['text'],
           filter: el =>
-            FORMAT_TEXT_SUPPORT_FLAVOURS.includes(el.model.flavour as Flavour),
+            FORMAT_TEXT_SUPPORT_FLAVOURS.includes(
+              el.model.flavour as BlockSuite.Flavour
+            ),
         })
         .inline((ctx, next) => {
           const { currentTextSelection, selectedBlocks } = ctx;
@@ -223,7 +228,9 @@ export function isFormatSupported(host: EditorHost) {
         .getSelectedBlocks({
           types: ['block'],
           filter: el =>
-            FORMAT_BLOCK_SUPPORT_FLAVOURS.includes(el.model.flavour as Flavour),
+            FORMAT_BLOCK_SUPPORT_FLAVOURS.includes(
+              el.model.flavour as BlockSuite.Flavour
+            ),
         })
         .inline((ctx, next) => {
           const { selectedBlocks } = ctx;
@@ -258,7 +265,7 @@ export function isFormatSupported(host: EditorHost) {
             const blockElement = el.closest<BlockElement>(`[${BLOCK_ID_ATTR}]`);
             if (blockElement) {
               return FORMAT_NATIVE_SUPPORT_FLAVOURS.includes(
-                blockElement.model.flavour as Flavour
+                blockElement.model.flavour as BlockSuite.Flavour
               );
             }
             return false;

diff --git a/packages/blocks/src/_common/export-manager/export-manager.ts b/packages/blocks/src/_common/export-manager/export-manager.ts
@@ -10,12 +10,12 @@ import {
   isInsidePageEditor,
   matchFlavours,
 } from '../../_common/utils/index.js';
-import type { RootBlockModel } from '../../models.js';
 import type { EdgelessRootBlockComponent } from '../../root-block/edgeless/edgeless-root-block.js';
 import { getBlocksInFrame } from '../../root-block/edgeless/frame-manager.js';
 import type { EdgelessBlockModel } from '../../root-block/edgeless/type.js';
 import { xywhArrayToObject } from '../../root-block/edgeless/utils/convert.js';
 import { getBackgroundGrid } from '../../root-block/edgeless/utils/query.js';
+import type { RootBlockModel } from '../../root-block/index.js';
 import type { IBound } from '../../surface-block/consts.js';
 import type { ElementModel } from '../../surface-block/element-model/index.js';
 import type { Renderer } from '../../surface-block/index.js';

diff --git a/packages/blocks/src/_common/transformers/middlewares.ts b/packages/blocks/src/_common/transformers/middlewares.ts
@@ -2,7 +2,8 @@ import { assertExists } from '@blocksuite/global/utils';
 import type { DeltaOperation, JobMiddleware } from '@blocksuite/store';
 
 import type { DatabaseBlockModel } from '../../database-block/index.js';
-import type { ListBlockModel, ParagraphBlockModel } from '../../models.js';
+import type { ListBlockModel } from '../../list-block/index.js';
+import type { ParagraphBlockModel } from '../../paragraph-block/index.js';
 import { DEFAULT_IMAGE_PROXY_ENDPOINT } from '../consts.js';
 
 export const replaceIdMiddleware: JobMiddleware = ({ slots, workspace }) => {

diff --git a/packages/blocks/src/_common/utils/render-linked-doc.ts b/packages/blocks/src/_common/utils/render-linked-doc.ts
@@ -5,7 +5,8 @@ import { render, type TemplateResult } from 'lit';
 
 import type { EmbedLinkedDocBlockComponent } from '../../embed-linked-doc-block/embed-linked-doc-block.js';
 import type { EmbedSyncedDocCard } from '../../embed-synced-doc-block/components/embed-synced-doc-card.js';
-import type { ImageBlockModel, NoteBlockModel } from '../../models.js';
+import type { ImageBlockModel } from '../../image-block/index.js';
+import type { NoteBlockModel } from '../../note-block/index.js';
 import { Bound, getCommonBound } from '../../surface-block/utils/bound.js';
 import { deserializeXYWH } from '../../surface-block/utils/xywh.js';
 import type { SurfaceRefBlockModel } from '../../surface-ref-block/surface-ref-model.js';

diff --git a/packages/blocks/src/index.ts b/packages/blocks/src/index.ts
@@ -81,7 +81,6 @@ export * from './embed-youtube-block/index.js';
 export * from './frame-block/index.js';
 export * from './image-block/index.js';
 export * from './list-block/index.js';
-export * from './models.js';
 export * from './note-block/index.js';
 export * from './paragraph-block/index.js';
 export { EdgelessComponentToolbar } from './root-block/edgeless/components/component-toolbar/component-toolbar.js';
@@ -92,6 +91,7 @@ export type {
   TemplateManager,
 } from './root-block/edgeless/components/toolbar/template/template-type.js';
 export * from './root-block/index.js';
+export * from './schemas.js';
 export {
   Bound,
   BrushElementModel,
@@ -107,6 +107,7 @@ export {
   ShapeElementModel,
   ShapeStyle,
   StrokeStyle,
+  SurfaceBlockModel,
   TextElementModel,
 } from './surface-block/index.js';
 export { SurfaceBlockComponent } from './surface-block/surface-block.js';

diff --git a/packages/blocks/src/root-block/clipboard/middlewares/paste.ts b/packages/blocks/src/root-block/clipboard/middlewares/paste.ts
@@ -13,7 +13,7 @@ import {
 } from '@blocksuite/store';
 
 import { matchFlavours } from '../../../_common/utils/index.js';
-import type { CodeBlockModel } from '../../../models.js';
+import type { CodeBlockModel } from '../../../code-block/index.js';
 import type { ParagraphBlockModel } from '../../../paragraph-block/index.js';
 
 const findLast = (snapshot: BlockSnapshot): BlockSnapshot => {

diff --git a/packages/blocks/src/root-block/commands/text-crud/format-block.ts b/packages/blocks/src/root-block/commands/text-crud/format-block.ts
@@ -4,7 +4,6 @@ import { INLINE_ROOT_ATTR, type InlineRootElement } from '@blocksuite/inline';
 
 import { FORMAT_BLOCK_SUPPORT_FLAVOURS } from '../../../_common/configs/text-format/consts.js';
 import type { AffineTextAttributes } from '../../../_common/inline/presets/affine-inline-specs.js';
-import type { Flavour } from '../../../models.js';
 
 // for block selection
 export const formatBlockCommand: Command<
@@ -39,7 +38,9 @@ export const formatBlockCommand: Command<
     .getSelectedBlocks({
       blockSelections,
       filter: el =>
-        FORMAT_BLOCK_SUPPORT_FLAVOURS.includes(el.model.flavour as Flavour),
+        FORMAT_BLOCK_SUPPORT_FLAVOURS.includes(
+          el.model.flavour as BlockSuite.Flavour
+        ),
       types: ['block'],
     })
     .inline((ctx, next) => {

diff --git a/packages/blocks/src/root-block/commands/text-crud/format-native.ts b/packages/blocks/src/root-block/commands/text-crud/format-native.ts
@@ -6,7 +6,6 @@ import type { BlockElement } from '@blocksuite/lit';
 import { FORMAT_NATIVE_SUPPORT_FLAVOURS } from '../../../_common/configs/text-format/consts.js';
 import { BLOCK_ID_ATTR } from '../../../_common/consts.js';
 import type { AffineTextAttributes } from '../../../_common/inline/presets/affine-inline-specs.js';
-import type { Flavour } from '../../../models.js';
 
 // for native range
 export const formatNativeCommand: Command<
@@ -40,7 +39,7 @@ export const formatNativeCommand: Command<
       const blockElement = el.closest<BlockElement>(`[${BLOCK_ID_ATTR}]`);
       if (blockElement) {
         return FORMAT_NATIVE_SUPPORT_FLAVOURS.includes(
-          blockElement.model.flavour as Flavour
+          blockElement.model.flavour as BlockSuite.Flavour
         );
       }
       return false;

diff --git a/packages/blocks/src/root-block/commands/text-crud/format-text.ts b/packages/blocks/src/root-block/commands/text-crud/format-text.ts
@@ -5,7 +5,6 @@ import { INLINE_ROOT_ATTR, type InlineRootElement } from '@blocksuite/inline';
 import { FORMAT_TEXT_SUPPORT_FLAVOURS } from '../../../_common/configs/text-format/consts.js';
 import type { AffineTextAttributes } from '../../../_common/inline/presets/affine-inline-specs.js';
 import { clearMarksOnDiscontinuousInput } from '../../../_common/utils/inline-editor.js';
-import type { Flavour } from '../../../models.js';
 
 // for text selection
 export const formatTextCommand: Command<
@@ -35,7 +34,9 @@ export const formatTextCommand: Command<
     .getSelectedBlocks({
       textSelection,
       filter: el =>
-        FORMAT_TEXT_SUPPORT_FLAVOURS.includes(el.model.flavour as Flavour),
+        FORMAT_TEXT_SUPPORT_FLAVOURS.includes(
+          el.model.flavour as BlockSuite.Flavour
+        ),
       types: ['text'],
     })
     .inline((ctx, next) => {

diff --git a/packages/blocks/src/root-block/edgeless/components/auto-complete/utils.ts b/packages/blocks/src/root-block/edgeless/components/auto-complete/utils.ts
@@ -1,7 +1,7 @@
 import { assertExists } from '@blocksuite/global/utils';
 import { Workspace } from '@blocksuite/store';
 
-import type { NoteBlockModel } from '../../../../models.js';
+import type { NoteBlockModel } from '../../../../note-block/index.js';
 import {
   CanvasTextFontFamily,
   CanvasTextFontStyle,

diff --git a/packages/blocks/src/root-block/edgeless/components/auto-connect/edgeless-index-label.ts b/packages/blocks/src/root-block/edgeless/components/auto-connect/edgeless-index-label.ts
@@ -11,7 +11,7 @@ import {
 } from '../../../../_common/icons/edgeless.js';
 import { SmallDocIcon } from '../../../../_common/icons/text.js';
 import { requestConnectedFrame } from '../../../../_common/utils/event.js';
-import type { NoteBlockModel } from '../../../../models.js';
+import type { NoteBlockModel } from '../../../../note-block/index.js';
 import { Bound } from '../../../../surface-block/index.js';
 import type { SurfaceBlockComponent } from '../../../../surface-block/surface-block.js';
 import type { EdgelessRootBlockComponent } from '../../edgeless-root-block.js';

diff --git a/...ages/blocks/src/root-block/edgeless/components/block-portal/bookmark/edgeless-bookmark.ts b/...ages/blocks/src/root-block/edgeless/components/block-portal/bookmark/edgeless-bookmark.ts
@@ -2,7 +2,7 @@ import { customElement } from 'lit/decorators.js';
 import { styleMap } from 'lit/directives/style-map.js';
 import { html } from 'lit/static-html.js';
 
-import type { BookmarkBlockModel } from '../../../../../models.js';
+import type { BookmarkBlockModel } from '../../../../../bookmark-block/index.js';
 import { Bound } from '../../../../../surface-block/index.js';
 import { EdgelessPortalBase } from '../edgeless-portal-base.js';
 

diff --git a/packages/blocks/src/root-block/edgeless/components/block-portal/edgeless-block-portal.ts b/packages/blocks/src/root-block/edgeless/components/block-portal/edgeless-block-portal.ts
@@ -28,8 +28,10 @@ import {
   NoteDisplayMode,
   type TopLevelBlockModel,
 } from '../../../../_common/utils/index.js';
-import type { SurfaceBlockComponent } from '../../../../index.js';
-import type { FrameBlockModel } from '../../../../models.js';
+import type {
+  FrameBlockModel,
+  SurfaceBlockComponent,
+} from '../../../../index.js';
 import type { NoteBlockModel } from '../../../../note-block/index.js';
 import type { GroupElementModel } from '../../../../surface-block/index.js';
 import { type EdgelessBlockType } from '../../../../surface-block/index.js';

diff --git a/packages/blocks/src/root-block/edgeless/components/rects/edgeless-selected-rect.ts b/packages/blocks/src/root-block/edgeless/components/rects/edgeless-selected-rect.ts
@@ -28,8 +28,11 @@ import {
   SYNCED_MIN_HEIGHT,
   SYNCED_MIN_WIDTH,
 } from '../../../../embed-synced-doc-block/styles.js';
-import type { EmbedHtmlModel, EmbedSyncedDocModel } from '../../../../index.js';
-import type { BookmarkBlockModel } from '../../../../models.js';
+import type {
+  BookmarkBlockModel,
+  EmbedHtmlModel,
+  EmbedSyncedDocModel,
+} from '../../../../index.js';
 import { NoteBlockModel } from '../../../../note-block/note-model.js';
 import { normalizeTextBound } from '../../../../surface-block/canvas-renderer/element-renderer/text/utils.js';
 import { TextElementModel } from '../../../../surface-block/element-model/text.js';

diff --git a/packages/blocks/src/root-block/edgeless/controllers/clipboard.ts b/packages/blocks/src/root-block/edgeless/controllers/clipboard.ts
@@ -30,6 +30,7 @@ import {
   isInsidePageEditor,
 } from '../../../_common/utils/query.js';
 import { isUrlInClipboard } from '../../../_common/utils/url.js';
+import type { AttachmentBlockModel } from '../../../attachment-block/index.js';
 import {
   type BookmarkBlockModel,
   BookmarkStyles,
@@ -43,7 +44,6 @@ import type { EmbedSyncedDocModel } from '../../../embed-synced-doc-block/embed-
 import type { EmbedYoutubeModel } from '../../../embed-youtube-block/embed-youtube-model.js';
 import type { FrameBlockModel } from '../../../frame-block/frame-model.js';
 import type { ImageBlockModel } from '../../../image-block/image-model.js';
-import type { AttachmentBlockModel } from '../../../models.js';
 import type { NoteBlockModel } from '../../../note-block/note-model.js';
 import type { IBound } from '../../../surface-block/consts.js';
 import type { EdgelessElementType } from '../../../surface-block/edgeless-types.js';

diff --git a/packages/blocks/src/root-block/edgeless/edgeless-root-block.ts b/packages/blocks/src/root-block/edgeless/edgeless-root-block.ts
@@ -38,9 +38,11 @@ import {
   SURFACE_IMAGE_CARD_HEIGHT,
   SURFACE_IMAGE_CARD_WIDTH,
 } from '../../image-block/components/image-card.js';
-import type { ImageBlockProps } from '../../image-block/image-model.js';
+import type {
+  ImageBlockModel,
+  ImageBlockProps,
+} from '../../image-block/image-model.js';
 import type { AttachmentBlockProps } from '../../index.js';
-import type { ImageBlockModel } from '../../models.js';
 import {
   Bound,
   type IBound,