Files
AFFiNE-Mirror/blocksuite/playground/apps/starter/utils/collection.ts
Saul-Mirone d859c4252b refactor(editor): move history from doc to store (#12131)
<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit

- **New Features**
  - Undo/redo history management is now centralized in the workspace, providing more consistent and robust undo/redo behavior.
  - History update events are emitted at the workspace level, enabling better tracking of changes.

- **Bug Fixes**
  - Improved reliability of undo/redo actions by shifting history management from documents to the workspace.

- **Documentation**
  - Updated and clarified documentation for history-related APIs, including improved examples and clearer descriptions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-05-05 09:24:09 +00:00

100 lines
3.1 KiB
TypeScript

import type { StoreExtensionManager } from '@blocksuite/affine/ext-loader';
import { AffineSchemas } from '@blocksuite/affine/schemas';
import { nanoid, Schema, Transformer } from '@blocksuite/affine/store';
import {
createAutoIncrementIdGenerator,
type DocCollectionOptions,
TestWorkspace,
} from '@blocksuite/affine/store/test';
import {
type BlobSource,
BroadcastChannelAwarenessSource,
BroadcastChannelDocSource,
IndexedDBBlobSource,
MemoryBlobSource,
} from '@blocksuite/affine/sync';
import * as Y from 'yjs';
import { MockServerBlobSource } from '../../_common/sync/blob/mock-server.js';
import type { InitFn } from '../data/utils.js';
const params = new URLSearchParams(location.search);
const room = params.get('room');
const isE2E = room?.startsWith('playwright');
const blobSourceArgs = (params.get('blobSource') ?? '').split(',');
export function createStarterDocCollection(
storeExtensionManager: StoreExtensionManager
) {
const collectionId = room ?? 'starter';
const schema = new Schema();
schema.register(AffineSchemas);
const idGenerator = isE2E ? createAutoIncrementIdGenerator() : nanoid;
let docSources: DocCollectionOptions['docSources'];
if (room) {
docSources = {
main: new BroadcastChannelDocSource(`broadcast-channel-${room}`),
};
}
const id = room ?? `starter-${Math.random().toString(16).slice(2, 8)}`;
const blobSources = {
main: new MemoryBlobSource(),
shadows: [] as BlobSource[],
} satisfies DocCollectionOptions['blobSources'];
if (blobSourceArgs.includes('mock')) {
blobSources.shadows.push(new MockServerBlobSource(collectionId));
}
if (blobSourceArgs.includes('idb')) {
blobSources.shadows.push(new IndexedDBBlobSource(collectionId));
}
const options: DocCollectionOptions = {
id: collectionId,
idGenerator,
awarenessSources: [new BroadcastChannelAwarenessSource(id)],
docSources,
blobSources,
};
const collection = new TestWorkspace(options);
collection.storeExtensions = storeExtensionManager.get('store');
collection.start();
// debug info
window.collection = collection;
window.blockSchemas = AffineSchemas;
window.job = new Transformer({
schema,
blobCRUD: collection.blobSync,
docCRUD: {
create: (id: string) => collection.createDoc(id).getStore({ id }),
get: (id: string) => collection.getDoc(id)?.getStore({ id }) ?? null,
delete: (id: string) => collection.removeDoc(id),
},
});
window.Y = Y;
return collection;
}
export async function initStarterDocCollection(collection: TestWorkspace) {
// use built-in init function
const functionMap = new Map<
string,
(collection: TestWorkspace, id: string) => Promise<void> | void
>();
Object.values(
(await import('../data/index.js')) as Record<string, InitFn>
).forEach(fn => functionMap.set(fn.id, fn));
const init = params.get('init') || 'preset';
if (functionMap.has(init)) {
collection.meta.initialize();
await functionMap.get(init)?.(collection, 'doc:home');
const doc = collection.getDoc('doc:home');
if (!doc?.loaded) {
doc?.load();
}
}
}