refactor(editor): rename job to transformer (#9639)

blocksuite/blocks/src/__tests__/adapters/html.unit.spec.ts

@@ -4,7 +4,7 @@ import { Container } from '@blocksuite/global/di';
 import type {
   BlockSnapshot,
   DocSnapshot,
-  JobMiddleware,
+  TransformerMiddleware,
 } from '@blocksuite/store';
 import { AssetsManager, MemoryBlobCRUD } from '@blocksuite/store';
 import { describe, expect, test } from 'vitest';
@@ -1514,7 +1514,7 @@ describe('snapshot to html', () => {
       ],
     };
 
-    const middleware: JobMiddleware = ({ adapterConfigs }) => {
+    const middleware: TransformerMiddleware = ({ adapterConfigs }) => {
       adapterConfigs.set('title:4T5ObMgEIMII-4Bexyta1', 'Test Doc');
       adapterConfigs.set('docLinkBaseUrl', 'https://example.com');
     };

blocksuite/blocks/src/__tests__/adapters/markdown.unit.spec.ts

@@ -4,8 +4,8 @@ import { Container } from '@blocksuite/global/di';
 import type {
   BlockSnapshot,
   DocSnapshot,
-  JobMiddleware,
   SliceSnapshot,
+  TransformerMiddleware,
 } from '@blocksuite/store';
 import { AssetsManager, MemoryBlobCRUD } from '@blocksuite/store';
 import { describe, expect, test } from 'vitest';
@@ -1931,7 +1931,7 @@ hhh
 
 hhh
 `;
-    const middleware: JobMiddleware = ({ adapterConfigs }) => {
+    const middleware: TransformerMiddleware = ({ adapterConfigs }) => {
       adapterConfigs.set('title:deadbeef', 'test');
       adapterConfigs.set('docLinkBaseUrl', 'https://example.com');
     };
@@ -3847,7 +3847,7 @@ hhh
         },
       ],
     };
-    const middleware: JobMiddleware = ({ adapterConfigs }) => {
+    const middleware: TransformerMiddleware = ({ adapterConfigs }) => {
       adapterConfigs.set('docLinkBaseUrl', 'https://example.com');
     };
     const mdAdapter = new MarkdownAdapter(createJob([middleware]), provider);

blocksuite/blocks/src/__tests__/adapters/plain-text.unit.spec.ts

@@ -4,7 +4,7 @@ import { Container } from '@blocksuite/global/di';
 import type {
   BlockSnapshot,
   DocSnapshot,
-  JobMiddleware,
+  TransformerMiddleware,
 } from '@blocksuite/store';
 import { describe, expect, test } from 'vitest';
 
@@ -573,7 +573,7 @@ describe('snapshot to plain text', () => {
         },
       ],
     };
-    const middleware: JobMiddleware = ({ adapterConfigs }) => {
+    const middleware: TransformerMiddleware = ({ adapterConfigs }) => {
       adapterConfigs.set('title:deadbeef', 'test');
       adapterConfigs.set('docLinkBaseUrl', 'https://example.com');
     };
@@ -756,7 +756,7 @@ describe('snapshot to plain text', () => {
         ],
       };
 
-      const middleware: JobMiddleware = ({ adapterConfigs }) => {
+      const middleware: TransformerMiddleware = ({ adapterConfigs }) => {
         adapterConfigs.set('title:4T5ObMgEIMII-4Bexyta1', 'test');
         adapterConfigs.set('docLinkBaseUrl', 'https://example.com');
       };

blocksuite/blocks/src/__tests__/utils/create-job.ts

@@ -1,5 +1,9 @@
 import { FeatureFlagService } from '@blocksuite/affine-shared/services';
-import { Job, type JobMiddleware, Schema } from '@blocksuite/store';
+import {
+  Schema,
+  Transformer,
+  type TransformerMiddleware,
+} from '@blocksuite/store';
 import { TestWorkspace } from '@blocksuite/store/test';
 
 import { defaultImageProxyMiddleware } from '../../_common/transformers/middlewares.js';
@@ -17,7 +21,7 @@ declare global {
   }
 }
 
-export function createJob(middlewares?: JobMiddleware[]) {
+export function createJob(middlewares?: TransformerMiddleware[]) {
   window.happyDOM.settings.fetch.disableSameOriginPolicy = true;
   const testMiddlewares = middlewares ?? [];
   testMiddlewares.push(defaultImageProxyMiddleware);
@@ -25,7 +29,7 @@ export function createJob(middlewares?: JobMiddleware[]) {
   const docCollection = new TestWorkspace({ schema });
   docCollection.storeExtensions = [FeatureFlagService];
   docCollection.meta.initialize();
-  return new Job({
+  return new Transformer({
     schema,
     blobCRUD: docCollection.blobSync,
     middlewares: testMiddlewares,

blocksuite/blocks/src/_common/transformers/html.ts

@@ -2,7 +2,7 @@ import { HtmlAdapter } from '@blocksuite/affine-shared/adapters';
 import { Container } from '@blocksuite/global/di';
 import { sha } from '@blocksuite/global/utils';
 import type { Store, Workspace } from '@blocksuite/store';
-import { extMimeMap, Job } from '@blocksuite/store';
+import { extMimeMap, Transformer } from '@blocksuite/store';
 
 import { defaultBlockHtmlAdapterMatchers } from '../adapters/html/block-matcher.js';
 import { htmlInlineToDeltaMatchers } from '../adapters/html/delta-converter/html-inline.js';
@@ -44,7 +44,7 @@ const provider = container.provider();
  * @returns A Promise that resolves when the export is complete.
  */
 async function exportDoc(doc: Store) {
-  const job = new Job({
+  const job = new Transformer({
     schema: doc.schema,
     blobCRUD: doc.blobSync,
     docCRUD: {
@@ -99,7 +99,7 @@ async function importHTMLToDoc({
   html,
   fileName,
 }: ImportHTMLToDocOptions) {
-  const job = new Job({
+  const job = new Transformer({
     schema: collection.schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
@@ -161,7 +161,7 @@ async function importHTMLZip({ collection, imported }: ImportHTMLZipOptions) {
   await Promise.all(
     htmlBlobs.map(async ([fileName, blob]) => {
       const fileNameWithoutExt = fileName.replace(/\.[^/.]+$/, '');
-      const job = new Job({
+      const job = new Transformer({
         schema: collection.schema,
         blobCRUD: collection.blobSync,
         docCRUD: {

blocksuite/blocks/src/_common/transformers/markdown.ts

@@ -3,7 +3,7 @@ import { Container } from '@blocksuite/global/di';
 import { BlockSuiteError, ErrorCode } from '@blocksuite/global/exceptions';
 import { assertExists, sha } from '@blocksuite/global/utils';
 import type { Store, Workspace } from '@blocksuite/store';
-import { extMimeMap, Job } from '@blocksuite/store';
+import { extMimeMap, Transformer } from '@blocksuite/store';
 
 import { defaultBlockMarkdownAdapterMatchers } from '../adapters/index.js';
 import { inlineDeltaToMarkdownAdapterMatchers } from '../adapters/markdown/delta-converter/inline-delta.js';
@@ -50,7 +50,7 @@ type ImportMarkdownZipOptions = {
  * @returns A Promise that resolves when the export is complete
  */
 async function exportDoc(doc: Store) {
-  const job = new Job({
+  const job = new Transformer({
     schema: doc.schema,
     blobCRUD: doc.blobSync,
     docCRUD: {
@@ -109,7 +109,7 @@ async function importMarkdownToBlock({
   markdown,
   blockId,
 }: ImportMarkdownToBlockOptions) {
-  const job = new Job({
+  const job = new Transformer({
     schema: doc.schema,
     blobCRUD: doc.blobSync,
     docCRUD: {
@@ -154,7 +154,7 @@ async function importMarkdownToDoc({
   markdown,
   fileName,
 }: ImportMarkdownToDocOptions) {
-  const job = new Job({
+  const job = new Transformer({
     schema: collection.schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
@@ -218,7 +218,7 @@ async function importMarkdownZip({
   await Promise.all(
     markdownBlobs.map(async ([fileName, blob]) => {
       const fileNameWithoutExt = fileName.replace(/\.[^/.]+$/, '');
-      const job = new Job({
+      const job = new Transformer({
         schema: collection.schema,
         blobCRUD: collection.blobSync,
         docCRUD: {

blocksuite/blocks/src/_common/transformers/middlewares.ts

@@ -8,10 +8,14 @@ import type {
 } from '@blocksuite/affine-model';
 import { DEFAULT_IMAGE_PROXY_ENDPOINT } from '@blocksuite/affine-shared/consts';
 import { assertExists } from '@blocksuite/global/utils';
-import type { DeltaOperation, DocMeta, JobMiddleware } from '@blocksuite/store';
+import type {
+  DeltaOperation,
+  DocMeta,
+  TransformerMiddleware,
+} from '@blocksuite/store';
 
 export const replaceIdMiddleware =
-  (idGenerator: () => string): JobMiddleware =>
+  (idGenerator: () => string): TransformerMiddleware =>
   ({ slots, docCRUD }) => {
     const idMap = new Map<string, string>();
     slots.afterImport.on(payload => {
@@ -202,7 +206,7 @@ export const replaceIdMiddleware =
 
 export const customImageProxyMiddleware = (
   imageProxyURL: string
-): JobMiddleware => {
+): TransformerMiddleware => {
   return ({ adapterConfigs }) => {
     adapterConfigs.set('imageProxy', imageProxyURL);
   };
@@ -211,7 +215,7 @@ export const customImageProxyMiddleware = (
 const customDocLinkBaseUrlMiddleware = (
   baseUrl: string,
   collectionId: string
-): JobMiddleware => {
+): TransformerMiddleware => {
   return ({ adapterConfigs }) => {
     const docLinkBaseUrl = baseUrl
       ? `${baseUrl}/workspace/${collectionId}`
@@ -221,7 +225,7 @@ const customDocLinkBaseUrlMiddleware = (
 };
 
 export const titleMiddleware =
-  (metas: DocMeta[]): JobMiddleware =>
+  (metas: DocMeta[]): TransformerMiddleware =>
   ({ slots, adapterConfigs }) => {
     slots.beforeExport.on(() => {
       for (const meta of metas) {
@@ -273,13 +277,13 @@ export const defaultImageProxyMiddleware =
   defaultImageProxyMiddlewarBuilder.get();
 
 export const embedSyncedDocMiddleware =
-  (type: 'content'): JobMiddleware =>
+  (type: 'content'): TransformerMiddleware =>
   ({ adapterConfigs }) => {
     adapterConfigs.set('embedSyncedDocExportType', type);
   };
 
 export const fileNameMiddleware =
-  (fileName?: string): JobMiddleware =>
+  (fileName?: string): TransformerMiddleware =>
   ({ slots }) => {
     slots.beforeImport.on(payload => {
       if (payload.type !== 'page') {

blocksuite/blocks/src/_common/transformers/notion-html.ts

@@ -1,7 +1,7 @@
 import { NotionHtmlAdapter } from '@blocksuite/affine-shared/adapters';
 import { Container } from '@blocksuite/global/di';
 import { sha } from '@blocksuite/global/utils';
-import { extMimeMap, Job, type Workspace } from '@blocksuite/store';
+import { extMimeMap, Transformer, type Workspace } from '@blocksuite/store';
 
 import { defaultBlockNotionHtmlAdapterMatchers } from '../adapters/notion-html/block-matcher.js';
 import { notionHtmlInlineToDeltaMatchers } from '../adapters/notion-html/delta-converter/html-inline.js';
@@ -117,7 +117,7 @@ async function importNotionZip({
       pendingAssets.set(key, new File([blob], fileName, { type: mime }));
     }
     const pagePromises = Array.from(pagePaths).map(async path => {
-      const job = new Job({
+      const job = new Transformer({
         schema: collection.schema,
         blobCRUD: collection.blobSync,
         docCRUD: {

blocksuite/blocks/src/_common/transformers/zip.ts

@@ -1,13 +1,13 @@
 import { sha } from '@blocksuite/global/utils';
 import type { DocSnapshot, Store, Workspace } from '@blocksuite/store';
-import { extMimeMap, getAssetName, Job } from '@blocksuite/store';
+import { extMimeMap, getAssetName, Transformer } from '@blocksuite/store';
 
 import { download, Unzip, Zip } from '../transformers/utils.js';
 import { replaceIdMiddleware, titleMiddleware } from './middlewares.js';
 
 async function exportDocs(collection: Workspace, docs: Store[]) {
   const zip = new Zip();
-  const job = new Job({
+  const job = new Transformer({
     schema: collection.schema,
     blobCRUD: collection.blobSync,
     docCRUD: {
@@ -77,7 +77,7 @@ async function importDocs(collection: Workspace, imported: Blob) {
     }
   }
 
-  const job = new Job({
+  const job = new Transformer({
     schema: collection.schema,
     blobCRUD: collection.blobSync,
     docCRUD: {

blocksuite/blocks/src/root-block/edgeless/clipboard/clipboard.ts

@@ -58,8 +58,8 @@ import {
   type BlockSnapshot,
   BlockSnapshotSchema,
   fromJSON,
-  Job,
   type SliceSnapshot,
+  Transformer,
 } from '@blocksuite/store';
 import DOMPurify from 'dompurify';
 import * as Y from 'yjs';
@@ -369,7 +369,7 @@ export class EdgelessClipboardController extends PageClipboard {
       if (mayBeSurfaceDataJson !== undefined) {
         const elementsRawData = JSON.parse(mayBeSurfaceDataJson);
         const { snapshot, blobs } = elementsRawData;
-        const job = new Job({
+        const job = new Transformer({
           schema: this.std.workspace.schema,
           blobCRUD: this.std.workspace.blobSync,
           docCRUD: {
@@ -1373,7 +1373,7 @@ export async function prepareClipboardData(
   selectedAll: BlockSuite.EdgelessModel[],
   std: BlockStdScope
 ) {
-  const job = new Job({
+  const job = new Transformer({
     schema: std.workspace.schema,
     blobCRUD: std.workspace.blobSync,
     docCRUD: {

blocksuite/blocks/src/root-block/edgeless/services/template.ts

@@ -15,8 +15,8 @@ import {
   type BlockSnapshot,
   type DocSnapshot,
   DocSnapshotSchema,
-  Job,
   type SnapshotNode,
+  Transformer,
 } from '@blocksuite/store';
 import type * as Y from 'yjs';
 /**
@@ -72,7 +72,7 @@ export class TemplateJob {
 
   private _template: DocSnapshot | null = null;
 
-  job: Job;
+  job: Transformer;
 
   model: SurfaceBlockModel;
 
@@ -90,7 +90,7 @@ export class TemplateJob {
   type: TemplateType;
 
   constructor({ model, type, middlewares }: TemplateJobConfig) {
-    this.job = new Job({
+    this.job = new Transformer({
       schema: model.doc.workspace.schema,
       blobCRUD: model.doc.workspace.blobSync,
       docCRUD: {

blocksuite/blocks/src/root-block/edgeless/utils/clone-utils.ts

@@ -18,7 +18,7 @@ import {
   isGfxGroupCompatibleModel,
   type SerializedElement,
 } from '@blocksuite/block-std/gfx';
-import { type BlockSnapshot, Job } from '@blocksuite/store';
+import { type BlockSnapshot, Transformer } from '@blocksuite/store';
 
 /**
  * return all elements in the tree of the elements
@@ -39,7 +39,7 @@ export function getSortedCloneElements(elements: GfxModel[]) {
 
 export function prepareCloneData(elements: GfxModel[], std: BlockStdScope) {
   elements = sortEdgelessElements(elements);
-  const job = new Job({
+  const job = new Transformer({
     schema: std.workspace.schema,
     blobCRUD: std.workspace.blobSync,
     docCRUD: {
@@ -58,7 +58,7 @@ export function prepareCloneData(elements: GfxModel[], std: BlockStdScope) {
 export function serializeElement(
   element: GfxModel,
   elements: GfxModel[],
-  job: Job
+  job: Transformer
 ) {
   if (element instanceof GfxBlockElementModel) {
     const snapshot = job.blockToSnapshot(element);