mirror of
https://github.com/codex-team/editor.js
synced 2024-05-07 00:46:45 +02:00
2d89105670
* Add internal wrappers for tools classes * FIx lint * Change tools collections to map * Apply some more refactoring * Make tool instance private field * Add some docs * Fix eslint * Basic implementation for Block Tunes * Small fix for demo * Review changes * Fix * Add common tunes and ToolsCollection class * Fixes after review * Rename tools collections * Readonly fix * Some fixes after review * Apply suggestions from code review Co-authored-by: Peter Savchenko <specc.dev@gmail.com> * Fixes after review * Add docs and changelog * Update docs/block-tunes.md Co-authored-by: Peter Savchenko <specc.dev@gmail.com> * Apply suggestions from code review Co-authored-by: Peter Savchenko <specc.dev@gmail.com> * Update src/components/block/index.ts Co-authored-by: Murod Khaydarov <murod.haydarov@gmail.com> * [Dev] Tools utils tests (#1602) * Add tests for tools utils and coverage report * Fix eslint * Adjust test * Add more tests * Update after code review * Fix test & bump version Co-authored-by: Peter Savchenko <specc.dev@gmail.com> Co-authored-by: Murod Khaydarov <murod.haydarov@gmail.com>
129 lines
3 KiB
TypeScript
129 lines
3 KiB
TypeScript
/**
|
|
* Editor.js Saver
|
|
*
|
|
* @module Saver
|
|
* @author Codex Team
|
|
* @version 2.0.0
|
|
*/
|
|
import Module from '../__module';
|
|
import { OutputData } from '../../../types';
|
|
import { ValidatedData } from '../../../types/data-formats';
|
|
import Block from '../block';
|
|
import * as _ from '../utils';
|
|
|
|
declare const VERSION: string;
|
|
|
|
/**
|
|
* @classdesc This method reduces all Blocks asyncronically and calls Block's save method to extract data
|
|
*
|
|
* @typedef {Saver} Saver
|
|
* @property {Element} html - Editor HTML content
|
|
* @property {string} json - Editor JSON output
|
|
*/
|
|
export default class Saver extends Module {
|
|
/**
|
|
* Composes new chain of Promises to fire them alternatelly
|
|
*
|
|
* @returns {OutputData}
|
|
*/
|
|
public async save(): Promise<OutputData> {
|
|
const { BlockManager, Sanitizer, ModificationsObserver } = this.Editor;
|
|
const blocks = BlockManager.blocks,
|
|
chainData = [];
|
|
|
|
/**
|
|
* Disable modifications observe while saving
|
|
*/
|
|
ModificationsObserver.disable();
|
|
|
|
try {
|
|
blocks.forEach((block: Block) => {
|
|
chainData.push(this.getSavedData(block));
|
|
});
|
|
|
|
const extractedData = await Promise.all(chainData);
|
|
const sanitizedData = await Sanitizer.sanitizeBlocks(extractedData);
|
|
|
|
return this.makeOutput(sanitizedData);
|
|
} finally {
|
|
ModificationsObserver.enable();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Saves and validates
|
|
*
|
|
* @param {Block} block - Editor's Tool
|
|
* @returns {ValidatedData} - Tool's validated data
|
|
*/
|
|
private async getSavedData(block: Block): Promise<ValidatedData> {
|
|
const blockData = await block.save();
|
|
const isValid = blockData && await block.validate(blockData.data);
|
|
|
|
return {
|
|
...blockData,
|
|
isValid,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Creates output object with saved data, time and version of editor
|
|
*
|
|
* @param {ValidatedData} allExtractedData - data extracted from Blocks
|
|
* @returns {OutputData}
|
|
*/
|
|
private makeOutput(allExtractedData): OutputData {
|
|
let totalTime = 0;
|
|
const blocks = [];
|
|
|
|
_.log('[Editor.js saving]:', 'groupCollapsed');
|
|
|
|
allExtractedData.forEach(({ tool, data, tunes, time, isValid }) => {
|
|
totalTime += time;
|
|
|
|
/**
|
|
* Capitalize Tool name
|
|
*/
|
|
_.log(`${tool.charAt(0).toUpperCase() + tool.slice(1)}`, 'group');
|
|
|
|
if (isValid) {
|
|
/** Group process info */
|
|
_.log(data);
|
|
_.log(undefined, 'groupEnd');
|
|
} else {
|
|
_.log(`Block «${tool}» skipped because saved data is invalid`);
|
|
_.log(undefined, 'groupEnd');
|
|
|
|
return;
|
|
}
|
|
|
|
/** If it was stub Block, get original data */
|
|
if (tool === this.Editor.Tools.stubTool) {
|
|
blocks.push(data);
|
|
|
|
return;
|
|
}
|
|
|
|
const output: any = {
|
|
type: tool,
|
|
data,
|
|
};
|
|
|
|
if (!_.isEmpty(tunes)) {
|
|
output.tunes = tunes;
|
|
}
|
|
|
|
blocks.push(output);
|
|
});
|
|
|
|
_.log('Total', 'log', totalTime);
|
|
_.log(undefined, 'groupEnd');
|
|
|
|
return {
|
|
time: +new Date(),
|
|
blocks,
|
|
version: VERSION,
|
|
};
|
|
}
|
|
}
|