feat(editor): add provider for base adapter (#11169)

This commit is contained in:
Saul-Mirone
2025-03-25 12:09:23 +00:00
parent df057b4c12
commit e84c60f53d
18 changed files with 50 additions and 55 deletions
@@ -1,96 +0,0 @@
import { BlockSuiteError, ErrorCode } from '@blocksuite/global/exceptions';
import type {
BlockSnapshot,
DocSnapshot,
FromBlockSnapshotPayload,
FromBlockSnapshotResult,
FromDocSnapshotPayload,
FromDocSnapshotResult,
FromSliceSnapshotPayload,
FromSliceSnapshotResult,
SliceSnapshot,
ToBlockSnapshotPayload,
ToDocSnapshotPayload,
ToSliceSnapshotPayload,
} from '@blocksuite/store';
import { BaseAdapter } from '@blocksuite/store';
import { decodeClipboardBlobs, encodeClipboardBlobs } from './utils.js';
export type FileSnapshot = {
name: string;
type: string;
content: string;
};
export class ClipboardAdapter extends BaseAdapter<string> {
static MIME = 'BLOCKSUITE/SNAPSHOT';
override fromBlockSnapshot(
_payload: FromBlockSnapshotPayload
): Promise<FromBlockSnapshotResult<string>> {
throw new BlockSuiteError(
ErrorCode.TransformerNotImplementedError,
'ClipboardAdapter.fromBlockSnapshot is not implemented'
);
}
override fromDocSnapshot(
_payload: FromDocSnapshotPayload
): Promise<FromDocSnapshotResult<string>> {
throw new BlockSuiteError(
ErrorCode.TransformerNotImplementedError,
'ClipboardAdapter.fromDocSnapshot is not implemented'
);
}
override async fromSliceSnapshot(
payload: FromSliceSnapshotPayload
): Promise<FromSliceSnapshotResult<string>> {
const snapshot = payload.snapshot;
const assets = payload.assets;
if (!assets) {
throw new BlockSuiteError(
ErrorCode.ValueNotExists,
'ClipboardAdapter.fromSliceSnapshot: assets is not found'
);
}
const map = assets.getAssets();
const blobs: Record<string, FileSnapshot> = await encodeClipboardBlobs(map);
return {
file: JSON.stringify({
snapshot,
blobs,
}),
assetsIds: [],
};
}
override toBlockSnapshot(
_payload: ToBlockSnapshotPayload<string>
): Promise<BlockSnapshot> {
throw new BlockSuiteError(
ErrorCode.TransformerNotImplementedError,
'ClipboardAdapter.toBlockSnapshot is not implemented'
);
}
override toDocSnapshot(
_payload: ToDocSnapshotPayload<string>
): Promise<DocSnapshot> {
throw new BlockSuiteError(
ErrorCode.TransformerNotImplementedError,
'ClipboardAdapter.toDocSnapshot is not implemented'
);
}
override toSliceSnapshot(
payload: ToSliceSnapshotPayload<string>
): Promise<SliceSnapshot> {
const json = JSON.parse(payload.file);
const { blobs, snapshot } = json;
const map = payload.assets?.getAssets();
decodeClipboardBlobs(blobs, map);
return Promise.resolve(snapshot);
}
}
@@ -165,5 +165,3 @@ export class PageClipboard extends ReadOnlyClipboard {
}
}
}
export { pasteMiddleware };
@@ -1,6 +1,7 @@
import { defaultImageProxyMiddleware } from '@blocksuite/affine-block-image';
import {
AttachmentAdapter,
ClipboardAdapter,
copyMiddleware,
HtmlAdapter,
ImageAdapter,
@@ -16,8 +17,6 @@ import {
import type { BlockComponent, UIEventHandler } from '@blocksuite/block-std';
import { DisposableGroup } from '@blocksuite/global/disposable';
import { ClipboardAdapter } from './adapter.js';
/**
* ReadOnlyClipboard is a class that provides a read-only clipboard for the root block.
* It is supported to copy models in the root block.
@@ -1,128 +0,0 @@
import { toast } from '@blocksuite/affine-components/toast';
import type { FileSnapshot } from './adapter.js';
const chars =
'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
// Use a lookup table to find the index.
const lookup = typeof Uint8Array === 'undefined' ? [] : new Uint8Array(256);
for (let i = 0; i < chars.length; i++) {
lookup[chars.charCodeAt(i)] = i;
}
export const encode = (arraybuffer: ArrayBuffer): string => {
const bytes = new Uint8Array(arraybuffer);
const len = bytes.length;
let i,
base64 = '';
for (i = 0; i < len; i += 3) {
base64 += chars[bytes[i] >> 2];
base64 += chars[((bytes[i] & 3) << 4) | (bytes[i + 1] >> 4)];
base64 += chars[((bytes[i + 1] & 15) << 2) | (bytes[i + 2] >> 6)];
base64 += chars[bytes[i + 2] & 63];
}
if (len % 3 === 2) {
base64 = base64.substring(0, base64.length - 1) + '=';
} else if (len % 3 === 1) {
base64 = base64.substring(0, base64.length - 2) + '==';
}
return base64;
};
export const decode = (base64: string): ArrayBuffer => {
const len = base64.length;
let bufferLength = base64.length * 0.75,
i,
p = 0,
encoded1,
encoded2,
encoded3,
encoded4;
if (base64[base64.length - 1] === '=') {
bufferLength--;
if (base64[base64.length - 2] === '=') {
bufferLength--;
}
}
const arraybuffer = new ArrayBuffer(bufferLength),
bytes = new Uint8Array(arraybuffer);
for (i = 0; i < len; i += 4) {
encoded1 = lookup[base64.charCodeAt(i)];
encoded2 = lookup[base64.charCodeAt(i + 1)];
encoded3 = lookup[base64.charCodeAt(i + 2)];
encoded4 = lookup[base64.charCodeAt(i + 3)];
bytes[p++] = (encoded1 << 2) | (encoded2 >> 4);
bytes[p++] = ((encoded2 & 15) << 4) | (encoded3 >> 2);
bytes[p++] = ((encoded3 & 3) << 6) | (encoded4 & 63);
}
return arraybuffer;
};
export async function encodeClipboardBlobs(map: Map<string, Blob>) {
const blobs: Record<string, FileSnapshot> = {};
let sumSize = 0;
await Promise.all(
Array.from(map.entries()).map(async ([id, blob]) => {
if (blob.size > 4 * 1024 * 1024) {
const host = document.querySelector('editor-host');
if (!host) {
return;
}
toast(
host,
(blob as File).name ?? 'File' + ' is too large to be copied'
);
return;
}
sumSize += blob.size;
if (sumSize > 6 * 1024 * 1024) {
const host = document.querySelector('editor-host');
if (!host) {
return;
}
toast(
host,
(blob as File).name ??
'File' + ' cannot be copied due to the clipboard size limit'
);
return;
}
const content = encode(await blob.arrayBuffer());
const file: FileSnapshot = {
name: (blob as File).name,
type: blob.type,
content,
};
blobs[id] = file;
})
);
return blobs;
}
export function decodeClipboardBlobs(
blobs: Record<string, FileSnapshot>,
map: Map<string, Blob> | undefined
) {
if (!map) {
console.error(
`Trying to decode clipboard blobs, but the map is not found.`
);
return;
}
Object.entries<FileSnapshot>(blobs).forEach(([sourceId, file]) => {
const blob = new Blob([decode(file.content)]);
const f = new File([blob], file.name, {
type: file.type,
});
map.set(sourceId, f);
});
}
@@ -19,6 +19,11 @@ import {
FrameBlockModel,
MAX_IMAGE_WIDTH,
} from '@blocksuite/affine-model';
import {
ClipboardAdapter,
decodeClipboardBlobs,
encodeClipboardBlobs,
} from '@blocksuite/affine-shared/adapters';
import {
CANVAS_EXPORT_IGNORE_TAGS,
EMBED_CARD_HEIGHT,
@@ -72,12 +77,7 @@ import {
import DOMPurify from 'dompurify';
import * as Y from 'yjs';
import { ClipboardAdapter } from '../../clipboard/adapter.js';
import { PageClipboard } from '../../clipboard/index.js';
import {
decodeClipboardBlobs,
encodeClipboardBlobs,
} from '../../clipboard/utils.js';
import { edgelessElementsBoundFromRawData } from '../utils/bound-utils.js';
import { createNewPresentationIndexes } from '../utils/clipboard-utils.js';
import {