refactor(editor): rename doc to blocks (#9510)

This commit is contained in:
Saul-Mirone
2025-01-03 12:49:33 +00:00
parent 2074bda8ff
commit 4457cb7266
99 changed files with 271 additions and 256 deletions

View File

@@ -17,7 +17,7 @@ import {
RootBlockSchema,
} from '@blocksuite/affine-model';
import { propertyModelPresets } from '@blocksuite/data-view/property-pure-presets';
import type { BlockModel, Doc } from '@blocksuite/store';
import type { BlockModel, Blocks } from '@blocksuite/store';
import { Schema } from '@blocksuite/store';
import {
createAutoIncrementIdGenerator,
@@ -49,7 +49,7 @@ function createTestDoc(docId = 'doc0') {
}
describe('DatabaseManager', () => {
let doc: Doc;
let doc: Blocks;
let db: DatabaseBlockModel;
let rootId: BlockModel['id'];

View File

@@ -25,7 +25,7 @@ import type { GfxBlockElementModel } from '@blocksuite/block-std/gfx';
import { BlockSuiteError, ErrorCode } from '@blocksuite/global/exceptions';
import type { IBound } from '@blocksuite/global/utils';
import { Bound } from '@blocksuite/global/utils';
import type { Doc } from '@blocksuite/store';
import type { Blocks } from '@blocksuite/store';
import {
getBlockComponentByModel,
@@ -110,7 +110,7 @@ export class ExportManager {
await Promise.all(promises);
};
get doc(): Doc {
get doc(): Blocks {
return this.std.doc;
}

View File

@@ -1,7 +1,7 @@
import { HtmlAdapter } from '@blocksuite/affine-shared/adapters';
import { Container } from '@blocksuite/global/di';
import { sha } from '@blocksuite/global/utils';
import type { Doc, Workspace } from '@blocksuite/store';
import type { Blocks, Workspace } from '@blocksuite/store';
import { extMimeMap, Job } from '@blocksuite/store';
import { defaultBlockHtmlAdapterMatchers } from '../adapters/html/block-matcher.js';
@@ -43,7 +43,7 @@ const provider = container.provider();
* @param doc - The doc to be exported.
* @returns A Promise that resolves when the export is complete.
*/
async function exportDoc(doc: Doc) {
async function exportDoc(doc: Blocks) {
const job = new Job({
schema: doc.schema,
blobCRUD: doc.blobSync,

View File

@@ -2,7 +2,7 @@ import { MarkdownAdapter } from '@blocksuite/affine-shared/adapters';
import { Container } from '@blocksuite/global/di';
import { BlockSuiteError, ErrorCode } from '@blocksuite/global/exceptions';
import { assertExists, sha } from '@blocksuite/global/utils';
import type { Doc, Workspace } from '@blocksuite/store';
import type { Blocks, Workspace } from '@blocksuite/store';
import { extMimeMap, Job } from '@blocksuite/store';
import { defaultBlockMarkdownAdapterMatchers } from '../adapters/index.js';
@@ -28,7 +28,7 @@ const container = new Container();
const provider = container.provider();
type ImportMarkdownToBlockOptions = {
doc: Doc;
doc: Blocks;
markdown: string;
blockId: string;
};
@@ -49,7 +49,7 @@ type ImportMarkdownZipOptions = {
* @param doc The doc to export
* @returns A Promise that resolves when the export is complete
*/
async function exportDoc(doc: Doc) {
async function exportDoc(doc: Blocks) {
const job = new Job({
schema: doc.schema,
blobCRUD: doc.blobSync,

View File

@@ -1,11 +1,11 @@
import { sha } from '@blocksuite/global/utils';
import type { Doc, DocSnapshot, Workspace } from '@blocksuite/store';
import type { Blocks, DocSnapshot, Workspace } from '@blocksuite/store';
import { extMimeMap, getAssetName, Job } from '@blocksuite/store';
import { download, Unzip, Zip } from '../transformers/utils.js';
import { replaceIdMiddleware, titleMiddleware } from './middlewares.js';
async function exportDocs(collection: Workspace, docs: Doc[]) {
async function exportDocs(collection: Workspace, docs: Blocks[]) {
const zip = new Zip();
const job = new Job({
schema: collection.schema,

View File

@@ -5,7 +5,7 @@ import type {
GroupElementModel,
} from '@blocksuite/affine-model';
import type { Slot } from '@blocksuite/global/utils';
import type { Doc } from '@blocksuite/store';
import type { Blocks } from '@blocksuite/store';
/** Common context interface definition for block models. */
@@ -14,7 +14,7 @@ type EditorSlots = {
};
export type AbstractEditor = {
doc: Doc;
doc: Blocks;
mode: DocMode;
readonly slots: EditorSlots;
} & HTMLElement;

View File

@@ -8,7 +8,7 @@ import {
} from '@blocksuite/affine-shared/adapters';
import type { BlockComponent, UIEventHandler } from '@blocksuite/block-std';
import { DisposableGroup } from '@blocksuite/global/utils';
import type { BlockSnapshot, Doc } from '@blocksuite/store';
import type { Blocks, BlockSnapshot } from '@blocksuite/store';
import { MixTextAdapter } from '../../_common/adapters/index.js';
import {
@@ -99,7 +99,7 @@ export class PageClipboard {
onBlockSnapshotPaste = async (
snapshot: BlockSnapshot,
doc: Doc,
doc: Blocks,
parent?: string,
index?: number
) => {

View File

@@ -10,7 +10,7 @@ import {
} from '@blocksuite/block-std';
import { GfxControllerIdentifier } from '@blocksuite/block-std/gfx';
import { DisposableGroup, Vec, WithDisposable } from '@blocksuite/global/utils';
import type { Doc } from '@blocksuite/store';
import type { Blocks } from '@blocksuite/store';
import { consume } from '@lit/context';
import { css, html, LitElement } from 'lit';
import { property, query } from 'lit/decorators.js';
@@ -150,7 +150,7 @@ export class EdgelessConnectorHandle extends WithDisposable(LitElement) {
@consume({
context: docContext,
})
accessor doc!: Doc;
accessor doc!: Blocks;
@property({ attribute: false })
accessor edgeless!: EdgelessRootBlockComponent;

View File

@@ -12,7 +12,7 @@ import {
DisposableGroup,
WithDisposable,
} from '@blocksuite/global/utils';
import { BlockViewType, type Doc, type Query } from '@blocksuite/store';
import { type Blocks, BlockViewType, type Query } from '@blocksuite/store';
import { css, html, nothing, type PropertyValues } from 'lit';
import { property, query, state } from 'lit/decorators.js';
import { styleMap } from 'lit/directives/style-map.js';
@@ -78,7 +78,7 @@ export class FramePreview extends WithDisposable(ShadowlessElement) {
private _frameDisposables: DisposableGroup | null = null;
private _previewDoc: Doc | null = null;
private _previewDoc: Blocks | null = null;
private readonly _previewSpec =
SpecProvider.getInstance().getSpec('edgeless:preview');

View File

@@ -19,7 +19,7 @@ import {
type IVec,
type SerializedXYWH,
} from '@blocksuite/global/utils';
import type { Doc } from '@blocksuite/store';
import type { Blocks } from '@blocksuite/store';
import { Text } from '@blocksuite/store';
import * as Y from 'yjs';
@@ -463,7 +463,7 @@ export class EdgelessFrameManager extends GfxExtension {
}
export function getNotesInFrameBound(
doc: Doc,
doc: Blocks,
frame: FrameBlockModel,
fullyContained: boolean = true
) {
@@ -481,7 +481,7 @@ export function getNotesInFrameBound(
}
export function getBlocksInFrameBound(
doc: Doc,
doc: Blocks,
model: FrameBlockModel,
fullyContained: boolean = true
) {

View File

@@ -5,7 +5,7 @@ import { DocModeProvider } from '@blocksuite/affine-shared/services';
import { getBlockProps } from '@blocksuite/affine-shared/utils';
import type { EditorHost } from '@blocksuite/block-std';
import { GfxBlockElementModel } from '@blocksuite/block-std/gfx';
import { type BlockModel, type Doc } from '@blocksuite/store';
import { type BlockModel, type Blocks } from '@blocksuite/store';
import {
getElementProps,
@@ -14,7 +14,11 @@ import {
} from '../../../edgeless/utils/clone-utils.js';
import { isFrameBlock, isNoteBlock } from '../../../edgeless/utils/query.js';
function addBlocksToDoc(targetDoc: Doc, model: BlockModel, parentId: string) {
function addBlocksToDoc(
targetDoc: Blocks,
model: BlockModel,
parentId: string
) {
// Add current block to linked doc
const blockProps = getBlockProps(model);
const newModelId = targetDoc.addBlock(
@@ -32,7 +36,7 @@ function addBlocksToDoc(targetDoc: Doc, model: BlockModel, parentId: string) {
}
export function createLinkedDocFromNote(
doc: Doc,
doc: Blocks,
note: NoteBlockModel,
docTitle?: string
) {