mirror of
https://github.com/codex-team/editor.js
synced 2024-05-08 01:16:46 +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>
42 lines
774 B
TypeScript
42 lines
774 B
TypeScript
import {BlockToolData} from '../tools';
|
|
import {BlockTuneData} from "../block-tunes/block-tune-data";
|
|
|
|
/**
|
|
* Output of one Tool
|
|
*
|
|
* @template Type - the string literal describing a tool type
|
|
* @template Data - the structure describing a data object supported by the tool
|
|
*/
|
|
export interface OutputBlockData<Type extends string = string, Data extends object = any> {
|
|
/**
|
|
* Tool type
|
|
*/
|
|
type: Type;
|
|
/**
|
|
* Saved Block data
|
|
*/
|
|
data: BlockToolData<Data>;
|
|
|
|
/**
|
|
* Block Tunes data
|
|
*/
|
|
tunes?: {[name: string]: BlockTuneData};
|
|
}
|
|
|
|
export interface OutputData {
|
|
/**
|
|
* Editor's version
|
|
*/
|
|
version?: string;
|
|
|
|
/**
|
|
* Timestamp of saving in milliseconds
|
|
*/
|
|
time?: number;
|
|
|
|
/**
|
|
* Saved Blocks
|
|
*/
|
|
blocks: OutputBlockData[];
|
|
}
|