zs_library 0.2.2 → 0.3.4

package/dist/components/Editor/components/BlockTools/MediaAndEmbed/Image/uploader.d.ts

@@ -0,0 +1,60 @@
+import { UploadOptions, UploadResponseFormat, ImageConfig } from './types/types';
+/**
+ * Params interface for Uploader constructor
+ */
+interface UploaderParams {
+    /**
+     * Configuration for the uploader
+     */
+    config: ImageConfig;
+    /**
+     * Handles the upload response.
+     * @param {UploadResponseFormat} response - Response format expected from the backend on file uploading.
+     * @returns {void}
+     */
+    onUpload: (response: UploadResponseFormat) => void;
+    /**
+     *
+     * @param error : error type
+     * @returns void
+     */
+    onError: (error: string) => void;
+}
+/**
+ * Module for file uploading. Handle 3 scenarios:
+ *  1. Select file from device and upload
+ *  2. Upload by pasting URL
+ *  3. Upload by pasting file from Clipboard or by Drag'n'Drop
+ */
+export default class Uploader {
+    private config;
+    private onUpload;
+    private onError;
+    /**
+     * @param params - uploader module params
+     * @param params.config - image tool config
+     * @param params.onUpload - one callback for all uploading (file, url, d-n-d, pasting)
+     * @param params.onError - callback for uploading errors
+     */
+    constructor({ config, onUpload, onError }: UploaderParams);
+    /**
+     * Handle clicks on the upload file button
+     * Fires ajax.transport()
+     * @param onPreview - callback fired when preview is ready
+     */
+    uploadSelectedFile({ onPreview }: UploadOptions): void;
+    /**
+     * Handle clicks on the upload file button
+     * Fires ajax.post()
+     * @param url - image source url
+     */
+    uploadByUrl(url: string): void;
+    /**
+     * Handle clicks on the upload file button
+     * Fires ajax.post()
+     * @param file - file pasted by drag-n-drop
+     * @param onPreview - file pasted by drag-n-drop
+     */
+    uploadByFile(file: Blob, { onPreview }: UploadOptions): void;
+}
+export {};

package/dist/components/Editor/components/BlockTools/MediaAndEmbed/Image/utils/dom.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Helper for making Elements with attributes
+ * @param tagName           - new Element tag name
+ * @param classNames  - list or name of CSS class
+ * @param attributes        - any attributes
+ * @returns
+ */
+export declare function make(tagName: string, classNames?: string[] | string | null, attributes?: {
+    [key: string]: string | boolean;
+}): HTMLElement;

package/dist/components/Editor/components/BlockTools/MediaAndEmbed/Image/utils/isPromise.d.ts

@@ -0,0 +1,7 @@
+import { UploadResponseFormat } from '../types/types';
+/**
+ * Check if passed object is a Promise
+ * @param  object - object to check
+ * @returns
+ */
+export default function isPromise(object: Promise<UploadResponseFormat>): object is Promise<UploadResponseFormat>;

package/dist/components/Editor/components/BlockTools/TextAndTypography/Alert/index.d.ts

@@ -0,0 +1,238 @@
+import { API, PasteEvent } from '@editorjs/editorjs';
+/**
+ * @description Tool's input and output data format
+ */
+export interface AlertData {
+    align?: string;
+    type: string;
+    message: string;
+}
+export interface ConstructorArgs {
+    data: AlertData;
+    config: {
+        alertTypes: string[];
+        defaultType: string;
+        defaultAlign: string;
+        messagePlaceholder: string;
+    };
+    api: API;
+    readOnly: boolean;
+}
+export interface AlertCSS {
+    wrapper: string;
+    wrapperForType: (type: string) => string;
+    wrapperForAlignType: (alignType: string) => string;
+    message: string;
+}
+/**
+ * @class Alert
+ * @classdesc Alert Tool for Editor.js
+ * @property {AlertData} data - Alert Tool`s input and output data
+ * @property {object} api - Editor.js API instance
+ *
+ * @typedef {object} AlertData
+ * @description Alert Tool`s input and output data
+ * @property {string} type - Alert type
+ * @property {string} alignType - Alert align type
+ * @property {string} message - Alert message
+ *
+ * @typedef {object} AlertConfig
+ * @description Alert Tool`s initial configuration
+ * @property {string} defaultType - default Alert type
+ * @property {string} defaultAlignType - default align Alert type
+ * @property {string} messagePlaceholder - placeholder to show in Alert`s message input
+ */
+export default class Alert {
+    /**
+     * Editor.js API
+     * @private
+     */
+    private api;
+    /**
+     * Read-only mode flag
+     * @private
+     */
+    private readOnly;
+    /**
+     * Block's data
+     * @private
+     */
+    private _data;
+    /**
+     * Alert Tool's CSS classes
+     */
+    private _CSS;
+    private container;
+    private alertTypes;
+    private defaultType;
+    private defaultAlign;
+    private messagePlaceholder;
+    /**
+     * Get Toolbox settings
+     *
+     * @public
+     * @returns {string}
+     */
+    static get toolbox(): {
+        icon: string;
+        title: string;
+    };
+    /**
+     * Allow to press Enter inside the Alert block
+     * @public
+     * @returns {boolean}
+     */
+    static get enableLineBreaks(): boolean;
+    /**
+     * Default Alert type
+     *
+     * @public
+     * @returns {string}
+     */
+    static get DEFAULT_TYPE(): string;
+    /**
+     * Default Alert align type
+     *
+     * @public
+     * @returns {string}
+     */
+    static get DEFAULT_ALIGN_TYPE(): string;
+    /**
+     * Default placeholder for Alert message
+     *
+     * @public
+     * @returns {string}
+     */
+    static get DEFAULT_MESSAGE_PLACEHOLDER(): string;
+    /**
+     * Supported Alert types
+     *
+     * @public
+     * @returns {array}
+     */
+    static get ALERT_TYPES(): string[];
+    /**
+     * Supported Align types
+     *
+     * @public
+     * @returns {array}
+     */
+    static get ALIGN_TYPES(): string[];
+    /**
+     * Alert Tool`s styles
+     *
+     * @returns {Object}
+     */
+    get CSS(): {
+        wrapper: string;
+        wrapperForType: (type: string) => string;
+        wrapperForAlignType: (alignType: string) => string;
+        message: string;
+    };
+    /**
+     * Render plugin`s main Element and fill it with saved data
+     *
+     * @param {AlertData} data — previously saved data
+     * @param {AlertConfig} config — user config for Tool
+     * @param {Object} api - Editor.js API
+     * @param {boolean} readOnly - read only mode flag
+     */
+    constructor({ data, config, api, readOnly }: ConstructorArgs);
+    /**
+     * Returns true to notify the core that read-only mode is supported
+     *
+     * @return {boolean}
+     */
+    static get isReadOnlySupported(): boolean;
+    /**
+     * Create Alert Tool container
+     *
+     * @returns {Element}
+     */
+    render(): HTMLElement;
+    /**
+     * Create Block's settings block
+     *
+     * @returns {array}
+     */
+    renderSettings(): {
+        icon: string;
+        name: string;
+        label: string;
+        toggle: string;
+        isActive: boolean;
+        onActivate: () => void;
+    }[];
+    /**
+     * Helper for formatting Alert Type / Align Type
+     *
+     * @param {string} type - Alert type or Align type
+     * @returns {string}
+     */
+    _getFormattedName(name: string): string;
+    /**
+     * Helper for changing style of Alert block with the selected Alert type
+     *
+     * @param {string} newType - new Alert type to be applied to the block
+     * @private
+     */
+    _changeAlertType(newType: string): void;
+    /**
+     * Helper for changing align of Alert block with the selected Align type
+     *
+     * @param {string} newAlign - new align type to be applied to the block
+     * @private
+     */
+    _changeAlignType(newAlign: string): void;
+    /**
+     * Extract Alert data from Alert Tool element
+     *
+     * @param {HTMLDivElement} alertElement - element to save
+     * @returns {AlertData}
+     */
+    save(alertElement: HTMLElement): {
+        message: string | undefined;
+        align?: string;
+        type: string;
+    };
+    /**
+     * Helper for making Elements with attributes
+     *
+     * @param  {string} tagName           - new Element tag name
+     * @param  {array|string} classNames  - list or name of CSS classname(s)
+     * @param  {Object} attributes        - any attributes
+     * @returns {Element}
+     * @private
+     */
+    _make(tagName: string, classNames?: string[] | string | null, attributes?: {
+        [x: string]: string;
+    }): HTMLElement;
+    /**
+     * Fill Alert's message with the pasted content
+     *
+     * @param {PasteEvent} event - event with pasted content
+     */
+    onPaste(event: PasteEvent): void;
+    /**
+     * Allow Alert to be converted to/from other blocks
+     */
+    static get conversionConfig(): {
+        export: (data: {
+            message: string;
+        }) => string;
+        import: (string: string) => {
+            message: string;
+            type: string;
+            alignType: string;
+        };
+    };
+    /**
+     * Sanitizer config for Alert Tool saved data
+     * @returns {Object}
+     */
+    static get sanitize(): {
+        message: boolean;
+        type: boolean;
+        alignType: boolean;
+    };
+}

package/dist/components/Editor/components/BlockTools/TextAndTypography/Delimiter/index.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Delimiter plugin for Editor.js
+ * Supported config:
+ *     * defaultStyle {string} (Default: 'star')
+ *     * styleOptions {string[]} (Default: Delimiter.DELIMITER_STYLES)
+ *     * defaultLineWidth {number} (Default: 25)
+ *     * lineWidthOptions {number[]} (Default: Delimiter.SUPPORTED_LINE_WIDTHS)
+ *     * defaultLineThickness {number} (Default: 2)
+ *     * lineThicknessOptions {number[]} (Default: Delimiter.LINE_THICKNESS)
+ *
+ * @class Delimiter
+ * @typedef {Delimiter}
+ */
+export default class Delimiter {
+    /**
+     * Editor.js Toolbox settings
+     *
+     * @static
+     * @readonly
+     * @type {{ icon: any; title: string; }}
+     */
+    static get toolbox(): {
+        icon: string;
+        title: string;
+    };
+    /**
+     * To notify Editor.js core that read-only is supported
+     *
+     * @static
+     * @readonly
+     * @type {boolean}
+     */
+    static get isReadOnlySupported(): boolean;
+    /**
+     * All supported delimiter styles
+     *
+     * @static
+     * @readonly
+     * @type {string[]}
+     */
+    static get DELIMITER_STYLES(): string[];
+    /**
+     * Default delimiter style
+     *
+     * @static
+     * @readonly
+     * @type {string}
+     */
+    static get DEFAULT_DELIMITER_STYLE(): string;
+    /**
+     * All supported widths for delimiter line style
+     *
+     * @static
+     * @readonly
+     * @type {number[]}
+     */
+    static get SUPPORTED_LINE_WIDTHS(): number[];
+    /**
+     * Default width for delimiter line style
+     *
+     * @static
+     * @readonly
+     * @type {number}
+     */
+    static get DEFAULT_LINE_WIDTH(): number;
+    /**
+     * All supported thickness options for delimiter line style
+     *
+     * @static
+     * @readonly
+     * @type {number[]}
+     */
+    static get LINE_THICKNESS(): number[];
+    /**
+     * Default thickness for delimiter line style
+     *
+     * @static
+     * @readonly
+     * @type {number}
+     */
+    static get DEFAULT_LINE_THICKNESS(): number;
+    /**
+     * Automatic sanitize config for Editor.js
+     *
+     * @static
+     * @readonly
+     * @type {{ style: boolean; lineWidth: boolean; lineThickness: boolean; }}
+     */
+    static get sanitize(): {
+        style: boolean;
+        lineWidth: boolean;
+        lineThickness: boolean;
+    };
+    /**
+     * Creates an instance of Delimiter.
+     *
+     * @constructor
+     * @param {{ api: {}; config: {}; data: {}; }} props
+     */
+    constructor({ api, config, data }: {
+        api: any;
+        config: any;
+        data: any;
+    });
+    /**
+     * All available delimiter styles
+     * - Finds intersection between supported and user selected delimiter styles
+     *
+     * @readonly
+     * @type {string[]}
+     */
+    get availableDelimiterStyles(): string[];
+    /**
+     * User's default delimiter style
+     * - Finds union of user choice and the actual default
+     *
+     * @readonly
+     * @type {string}
+     */
+    get userDefaultDelimiterStyle(): string;
+    /**
+     * All available widths for delimiter line style
+     * - Finds all valid user selected line widths (falls back to default when empty)
+     *
+     * @readonly
+     * @type {number[]}
+     */
+    get availableLineWidths(): number[];
+    /**
+     * User's default line width
+     * - Finds union of user choice and the actual default
+     *
+     * @readonly
+     * @type {number}
+     */
+    get userDefaultLineWidth(): number;
+    /**
+     * All available line thickness options
+     * - Finds intersection between supported and user selected line thickness options
+     *
+     * @readonly
+     * @type {number[]}
+     */
+    get availableLineThickness(): number[];
+    /**
+     * User's default line thickness
+     * - Finds union of user choice and the actual default
+     *
+     * @readonly
+     * @type {number}
+     */
+    get userDefaultLineThickness(): number;
+    /**
+     * To normalize input data
+     *
+     * @param {*} data
+     * @returns {{ style: string; lineWidth: number; lineThickness: number; }}
+     */
+    _normalizeData(data: any): {};
+    /**
+     * Current delimiter style
+     *
+     * @readonly
+     * @type {string}
+     */
+    get currentDelimiterStyle(): string;
+    /**
+     * Current width for delimiter line style
+     *
+     * @readonly
+     * @type {number}
+     */
+    get currentLineWidth(): number;
+    /**
+     * Current thickness for delimiter line style
+     *
+     * @readonly
+     * @type {number}
+     */
+    get currentLineThickness(): number;
+    /**
+     * Create a child element of the block parent
+     *
+     * @returns {*}
+     */
+    _createChildElement(): HTMLSpanElement;
+    /**
+     * Create and return block element
+     *
+     * @returns {*}
+     */
+    _getElement(): HTMLElement;
+    /**
+     * Replace the current element with a new one
+     */
+    _replaceElement(): void;
+    /**
+     * Callback for Delimiter style change to star
+     */
+    _setStar(): void;
+    /**
+     * Callback for Delimiter style change to dash
+     */
+    _setDash(): void;
+    /**
+     * Callback for Delimiter style change (to line) or line width change
+     *
+     * @param {number} newWidth
+     */
+    _setLine(newWidth: any): void;
+    /**
+     * Callback for line thickness change
+     *
+     * @param {number} newThickness
+     */
+    _setLineThickness(newThickness: any): void;
+    /**
+     * HTML element to render on the UI by Editor.js
+     *
+     * @returns {*}
+     */
+    render(): any;
+    /**
+     * Editor.js save method to extract block data from the UI
+     *
+     * @param {*} blockContent
+     * @returns {{ style: string; lineWidth: number; lineThickness: number; }}
+     */
+    save(): {
+        style: string;
+        lineWidth: number;
+        lineThickness: number;
+    } | {
+        style: string;
+        lineWidth?: undefined;
+        lineThickness?: undefined;
+    };
+    /**
+     * Get formatted label for Block settings menu
+     *
+     * @param {string} name
+     * @param {string} prefix
+     * @returns {string}
+     */
+    _getFormattedLabel(name: any, prefix: any, suffix: any): any;
+    /**
+     * Create a Block menu setting
+     *
+     * @param {string} icon
+     * @param {string} label
+     * @param {*} onActivate
+     * @param {boolean} isActive
+     * @param {string} group
+     * @returns {{ icon: string; label: string; onActivate: any; isActive: boolean; closeOnActivate: boolean; toggle: string; }}
+     */
+    _createSetting: (icon: any, label: any, onActivate: any, isActive: any, group: any) => {
+        icon: any;
+        label: any;
+        onActivate: any;
+        isActive: any;
+        closeOnActivate: boolean;
+        toggle: any;
+    };
+    /**
+     * Block settings menu items
+     *
+     * @returns {[{*}]}
+     */
+    renderSettings(): any[];
+}