zs_library 0.3.13 → 0.3.15

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

@@ -1,146 +0,0 @@
-import { TunesMenuConfig } from '@editorjs/editorjs/types/tools';
-import { ToolboxConfig, PasteConfig, BlockToolConstructorOptions, BlockTool, PasteEvent } from '@editorjs/editorjs';
-import { ActionConfig, ImageToolData, ImageConfig } from './types/types';
-type ImageToolConstructorOptions = BlockToolConstructorOptions<ImageToolData, ImageConfig>;
-/**
- * Implementation of ImageTool class
- */
-export default class ImageTool implements BlockTool {
-    /**
-     * Editor.js API instance
-     */
-    private api;
-    /**
-     * Flag indicating read-only mode
-     */
-    private readOnly;
-    /**
-     * Current Block API instance
-     */
-    private block;
-    /**
-     * Configuration for the ImageTool
-     */
-    private config;
-    /**
-     * Uploader module instance
-     */
-    private uploader;
-    /**
-     * UI module instance
-     */
-    private ui;
-    /**
-     * Stores current block data internally
-     */
-    private _data;
-    /**
-     * @param tool - tool properties got from editor.js
-     * @param tool.data - previously saved data
-     * @param tool.config - user config for Tool
-     * @param tool.api - Editor.js API
-     * @param tool.readOnly - read-only mode flag
-     * @param tool.block - current Block API
-     */
-    constructor({ data, config, api, readOnly, block, }: ImageToolConstructorOptions);
-    /**
-     * Notify core that read-only mode is supported
-     */
-    static get isReadOnlySupported(): boolean;
-    /**
-     * Get Tool toolbox settings
-     * icon - Tool icon's SVG
-     * title - title to show in toolbox
-     */
-    static get toolbox(): ToolboxConfig;
-    /**
-     * Available image tools
-     */
-    static get tunes(): Array<ActionConfig>;
-    /**
-     * Renders Block content
-     */
-    render(): HTMLDivElement;
-    /**
-     * Validate data: check if Image exists
-     * @param savedData — data received after saving
-     * @returns false if saved data is not correct, otherwise true
-     */
-    validate(savedData: ImageToolData): boolean;
-    /**
-     * Return Block data
-     */
-    save(): ImageToolData;
-    /**
-     * Returns configuration for block tunes: add background, add border, stretch image
-     * @returns TunesMenuConfig
-     */
-    renderSettings(): TunesMenuConfig;
-    /**
-     * Fires after clicks on the Toolbox Image Icon
-     * Initiates click on the Select File button
-     */
-    appendCallback(): void;
-    /**
-     * Specify paste substitutes
-     * @see {@link https://github.com/codex-team/editor.js/blob/master/docs/tools.md#paste-handling}
-     */
-    static get pasteConfig(): PasteConfig;
-    /**
-     * Specify paste handlers
-     * @see {@link https://github.com/codex-team/editor.js/blob/master/docs/tools.md#paste-handling}
-     * @param event - editor.js custom paste event
-     *                              {@link https://github.com/codex-team/editor.js/blob/master/types/tools/paste-events.d.ts}
-     */
-    onPaste(event: PasteEvent): Promise<void>;
-    /**
-     * Private methods
-     * ̿̿ ̿̿ ̿̿ ̿'̿'\̵͇̿̿\з= ( ▀ ͜͞ʖ▀) =ε/̵͇̿̿/’̿’̿ ̿ ̿̿ ̿̿ ̿̿
-     */
-    /**
-     * Stores all Tool's data
-     * @param data - data in Image Tool format
-     */
-    private set data(value);
-    /**
-     * Return Tool data
-     */
-    private get data();
-    /**
-     * Set new image file
-     * @param file - uploaded file data
-     */
-    private set image(value);
-    /**
-     * File uploading callback
-     * @param response - uploading server response
-     */
-    private onUpload;
-    /**
-     * Handle uploader errors
-     * @param errorText - uploading error info
-     */
-    private uploadingFailed;
-    /**
-     * Callback fired when Block Tune is activated
-     * @param tuneName - tune that has been clicked
-     */
-    private tuneToggled;
-    /**
-     * Set one tune
-     * @param tuneName - {@link Tunes.tunes}
-     * @param value - tune state
-     */
-    private setTune;
-    /**
-     * Show preloader and upload image file
-     * @param file - file that is currently uploading (from paste)
-     */
-    private uploadFile;
-    /**
-     * Show preloader and upload image by target url
-     * @param url - url pasted
-     */
-    private uploadUrl;
-}
-export {};

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

@@ -1,172 +0,0 @@
-import { HTMLPasteEventDetail } from '@editorjs/editorjs';
-/**
- * Represents options for uploading, including a function to handle previewing.
- */
-export interface UploadOptions {
-    /**
-     * Callback function to be called when the preview is ready.
-     * @param src - The source of the preview as a string.
-     * @returns void
-     */
-    onPreview: (src: string) => void;
-}
-/**
- * User configuration of Image block tunes. Allows to add custom tunes through the config
- */
-export interface ActionConfig {
-    /**
-     * The name of the tune.
-     */
-    name: string;
-    /**
-     * The icon for the tune. Should be an SVG string.
-     */
-    icon: string;
-    /**
-     * The title of the tune. This will be displayed in the UI.
-     */
-    title: string;
-    /**
-     * An optional flag indicating whether the tune is a toggle (true) or not (false).
-     */
-    toggle?: boolean;
-    /**
-     * An optional action function to be executed when the tune is activated.
-     */
-    action?: Function;
-}
-/**
- * UploadResponseFormat interface representing the response format expected from the backend on file uploading.
- */
-export interface UploadResponseFormat<AdditionalFileData = {}> {
-    /**
-     * success - 1 for successful uploading, 0 for failure
-     */
-    success: number;
-    /**
-     * Object with file data.
-     *             'url' is required,
-     *             also can contain any additional data that will be saved and passed back
-     */
-    file: {
-        /**
-         * The URL of the uploaded image.
-         */
-        url: string;
-    } & AdditionalFileData;
-}
-/**
- * ImageToolData type representing the input and output data format for the image tool, including optional custome actions.
- */
-export type ImageToolData<Actions = {}, AdditionalFileData = {}> = {
-    /**
-     * Caption for the image.
-     */
-    caption: string;
-    /**
-     * Flag indicating whether the image has a border.
-     */
-    withBorder: boolean;
-    /**
-     * Flag indicating whether the image has a background.
-     */
-    withBackground: boolean;
-    /**
-     * Flag indicating whether the image is stretched.
-     */
-    stretched: boolean;
-    /**
-     * Object containing the URL of the image file.
-     * Also can contain any additional data.
-     */
-    file: {
-        /**
-         * The URL of the image.
-         */
-        url: string;
-    } & AdditionalFileData;
-} & (Actions extends Record<string, boolean> ? Actions : {});
-/**
- *
- * @description Config supported by Tool
- */
-export interface ImageConfig {
-    /**
-     * Endpoints for upload, whether using file or URL.
-     */
-    endpoints: {
-        /**
-         * Endpoint for file upload.
-         */
-        byFile?: string;
-        /**
-         * Endpoints for URL upload.
-         */
-        byUrl?: string;
-    };
-    /**
-     * Field name for the uploaded image.
-     */
-    field?: string;
-    /**
-     * Allowed mime-types for the uploaded image.
-     */
-    types?: string;
-    /**
-     * Placeholder text for the caption field.
-     */
-    captionPlaceholder?: string;
-    /**
-     * Additional data to send with requests.
-     */
-    additionalRequestData?: object;
-    /**
-     * Additional headers to send with requests.
-     */
-    additionalRequestHeaders?: object;
-    /**
-     * Custom content for the select file button.
-     */
-    buttonContent?: string;
-    /**
-     * Optional custom uploader.
-     */
-    uploader?: {
-        /**
-         * Method to upload an image by file.
-         */
-        uploadByFile?: (file: Blob) => Promise<UploadResponseFormat>;
-        /**
-         * Method to upload an image by URL.
-         */
-        uploadByUrl?: (url: string) => Promise<UploadResponseFormat>;
-    };
-    /**
-     * Additional actions for the tool.
-     */
-    actions?: ActionConfig[];
-}
-/**
- * Interface representing the details of a paste event for HTML elements.
- * Extends the `HTMLPasteEventDetail` interface to include additional data properties.
- */
-export interface HTMLPasteEventDetailExtended extends HTMLPasteEventDetail {
-    /**
-     * The data property containing the source of the image and HTML element details.
-     */
-    data: {
-        /**
-         * The source URL of the pasted image.
-         */
-        src: string;
-    } & HTMLElement;
-}
-/**
- * Parameter type of Image setter function in ImageTool
- */
-export type ImageSetterParam = {
-    /**
-     * url path of the image
-     */
-    url: string;
-};

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

@@ -1,132 +0,0 @@
-import { API } from '@editorjs/editorjs';
-import { ImageToolData, ImageConfig } from './types/types';
-/**
- * Nodes interface representing various elements in the UI.
- */
-interface Nodes {
-    /**
-     * Wrapper element in the UI.
-     */
-    wrapper: HTMLElement;
-    /**
-     * Container for the image element in the UI.
-     */
-    imageContainer: HTMLElement;
-    /**
-     * Button for selecting files.
-     */
-    fileButton: HTMLElement;
-    /**
-     * Represents the image element in the UI, if one is present; otherwise, it's undefined.
-     */
-    imageEl?: HTMLElement;
-    /**
-     * Preloader element for the image.
-     */
-    imagePreloader: HTMLElement;
-    /**
-     * Caption element for the image.
-     */
-    caption: HTMLElement;
-}
-/**
- * ConstructorParams interface representing parameters for the Ui class constructor.
- */
-interface ConstructorParams {
-    /**
-     * Editor.js API.
-     */
-    api: API;
-    /**
-     * Configuration for the image.
-     */
-    config: ImageConfig;
-    /**
-     * Callback function for selecting a file.
-     */
-    onSelectFile: () => void;
-    /**
-     * Flag indicating if the UI is in read-only mode.
-     */
-    readOnly: boolean;
-}
-/**
- * Class for working with UI:
- *  - rendering base structure
- *  - show/hide preview
- *  - apply tune view
- */
-export default class Ui {
-    /**
-     * Nodes representing various elements in the UI.
-     */
-    nodes: Nodes;
-    /**
-     * API instance for Editor.js.
-     */
-    private api;
-    /**
-     * Configuration for the image tool.
-     */
-    private config;
-    /**
-     * Callback function for selecting a file.
-     */
-    private onSelectFile;
-    /**
-     * Flag indicating if the UI is in read-only mode.
-     */
-    private readOnly;
-    /**
-     * @param ui - image tool Ui module
-     * @param ui.api - Editor.js API
-     * @param ui.config - user config
-     * @param ui.onSelectFile - callback for clicks on Select file button
-     * @param ui.readOnly - read-only mode flag
-     */
-    constructor({ api, config, onSelectFile, readOnly }: ConstructorParams);
-    /**
-     * Apply visual representation of activated tune
-     * @param tuneName - one of available tunes {@link Tunes.tunes}
-     * @param status - true for enable, false for disable
-     */
-    applyTune(tuneName: string, status: boolean): void;
-    /**
-     * Renders tool UI
-     * @param toolData - saved tool data
-     */
-    render(toolData: ImageToolData): HTMLElement;
-    /**
-     * Shows uploading preloader
-     * @param src - preview source
-     */
-    showPreloader(src: string): void;
-    /**
-     * Hide uploading preloader
-     */
-    hidePreloader(): void;
-    /**
-     * Shows an image
-     * @param url - image source
-     */
-    fillImage(url: string): void;
-    /**
-     * Shows caption input
-     * @param text - caption content text
-     */
-    fillCaption(text: string): void;
-    /**
-     * CSS classes
-     */
-    private get CSS();
-    /**
-     * Creates upload-file button
-     */
-    private createFileButton;
-    /**
-     * Changes UI status
-     * @param status - see {@link Ui.status} constants
-     */
-    private toggleStatus;
-}
-export {};

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

@@ -1,60 +0,0 @@
-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

@@ -1,10 +0,0 @@
-/**
- * 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

@@ -1,7 +0,0 @@
-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>;