fvtt-types/src/foundry/common/prosemirror/image-plugin.d.mts

TypeScript type definitions for Foundry VTT

import type { Schema, Slice } from "prosemirror-model";
import type { Plugin } from "prosemirror-state";
import type { EditorView } from "prosemirror-view";
import type ProseMirrorPlugin from "./plugin.d.mts";
import type Document from "#common/abstract/document.mjs";

/**
 * A class responsible for handle drag-and-drop and pasting of image content. Ensuring no base64 data is injected
 * directly into the journal content and it is instead uploaded to the user's data directory.
 */
declare class ProseMirrorImagePlugin<Doc extends Document.Any> extends ProseMirrorPlugin {
  /**
   * @param schema   - The ProseMirror schema.
   * @param options  - Additional options to configure the plugin's behaviour.
   */
  constructor(schema: Schema, options: ProseMirrorImagePlugin.ConstructionOptions<Doc>);

  /**
   * The related Document to store extracted base64 images for.
   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
   */
  readonly document: Doc;

  static override build(schema: Schema, options: ProseMirrorImagePlugin.ConstructionOptions<Document.Any>): Plugin;

  /**
   * Handle a drop onto the editor.
   * @param view  - The ProseMirror editor view.
   * @param event - The drop event.
   * @param slice - A slice of editor content.
   * @param moved - Whether the slice has been moved from a different part of the editor.
   */
  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): boolean | void;

  /**
   * Handle a paste into the editor.
   * @param view  - The ProseMirror editor view.
   * @param event - The paste event.
   */
  protected _onPaste(view: EditorView, event: ClipboardEvent): boolean | void;

  /**
   * Upload any image files encountered in the drop.
   * @param view  - The ProseMirror editor view.
   * @param files - The files to upload.
   * @param pos   - The position in the document to insert at. If not provided,
   * the current selection will be replaced instead.
   */
  protected _uploadImages(view: EditorView, files: FileList, pos?: number): Promise<void>;

  /**
   * Capture any base64-encoded images embedded in the rich text paste and upload them.
   * @param view   - The ProseMirror editor view.
   * @param html   - The HTML data as a string.
   * @param images - An array of extracted base64 image data.
   */
  protected _replaceBase64Images(
    view: EditorView,
    html: string,
    images: ProseMirrorImagePlugin.ImageData[],
  ): Promise<void>;

  /**
   * Detect base64 image data embedded in an HTML string and extract it.
   * @param html - The HTML data as a string.
   */
  protected _extractBase64Images(html: string): ProseMirrorImagePlugin.ImageData[];

  /**
   * Convert a base64 string into a File object.
   * @param data     - Base64 encoded data.
   * @param filename - The filename.
   * @param mimetype - The file's mimetype.
   */
  static base64ToFile(data: string, filename: string, mimetype: string): File;
}

declare namespace ProseMirrorImagePlugin {
  interface ConstructionOptions<Doc extends Document.Any> {
    /** A related Document to store extract base64 images for. */
    document: Doc;
  }

  type ImageData = [full: string, mime: string, data: string];
}

export default ProseMirrorImagePlugin;