@wangeditor-next/editor 6.4.1 → 6.4.3

package/dist/upload.d.ts

@@ -0,0 +1,450 @@
+import ee from "event-emitter";
+import { Ancestor, Descendant, Editor, Element as Element$1, Location, Node as Node$1, NodeEntry, Range } from "slate";
+
+//#region ../core/src/utils/dom.d.ts
+
+//#endregion
+//#region ../core/src/menus/interface.d.ts
+interface IPositionStyle {
+  top: string;
+  left: string;
+  right: string;
+  bottom: string;
+}
+//#endregion
+//#region ../core/src/upload/interface.d.ts
+type IUploadHeaders = Record<string, string | number>;
+interface IUploadResultFile {
+  name: string;
+  type?: string;
+  size?: number;
+  [key: string]: any;
+}
+interface IUploadFile {
+  name: string;
+  type: string;
+  size: number;
+  data: Blob | File;
+  source?: string;
+}
+interface IUploader {
+  addFiles: (files: IUploadFile[]) => void;
+  upload: () => Promise<unknown>;
+  destroy?: () => void;
+}
+type FilesType = Record<string, any>;
+type InsertFn = (src: string, poster?: string, alt?: string, href?: string) => void | Promise<void>;
+interface IUploadAdapterContext {
+  config: IUploadConfig;
+  editor?: IDomEditor;
+}
+type IUploadAdapter = (context: IUploadAdapterContext) => IUploader;
+interface IBaseUploadConfig {
+  fieldName?: string;
+  maxFileSize?: number;
+  maxNumberOfFiles?: number;
+  meta?: Record<string, unknown>;
+  metaWithUrl: boolean;
+  headers?: IUploadHeaders | ((file: IUploadResultFile) => IUploadHeaders) | undefined;
+  withCredentials?: boolean;
+  timeout?: number;
+  onBeforeUpload?: (files: FilesType) => boolean | FilesType;
+  onSuccess: (file: IUploadResultFile, response: any) => void;
+  onProgress?: (progress: number) => void;
+  onFailed: (file: IUploadResultFile, response: any) => void;
+  onError: (file: IUploadResultFile, error: any, res: any) => void;
+  allowedFileTypes?: string[];
+  customInsert?: (res: any, insertFn: InsertFn) => void;
+  customUpload?: (files: File, insertFn: InsertFn, editor: IDomEditor) => void;
+  customBrowseAndUpload?: (insertFn: InsertFn) => void;
+  uploadAdapter?: IUploadAdapter;
+  uppyConfig?: Record<string, any>;
+  xhrConfig?: Record<string, any>;
+}
+interface IUploadConfigWithCustomUpload extends IBaseUploadConfig {
+  server?: string;
+  customUpload: (files: File, insertFn: InsertFn, editor: IDomEditor) => void;
+}
+interface IUploadConfigWithUploadAdapter extends IBaseUploadConfig {
+  server?: string;
+  uploadAdapter: IUploadAdapter;
+  customUpload?: (files: File, insertFn: InsertFn, editor: IDomEditor) => void;
+}
+interface IUploadConfigWithoutCustomUpload extends IBaseUploadConfig {
+  server: string;
+  customUpload?: never;
+  uploadAdapter?: never;
+}
+/**
+ * 配置参考 https://uppy.io/docs/uppy/
+ */
+type IUploadConfig = IUploadConfigWithCustomUpload | IUploadConfigWithUploadAdapter | IUploadConfigWithoutCustomUpload;
+//#endregion
+//#region ../core/src/config/interface.d.ts
+type EmptyText = {
+  text: '';
+};
+type ImageElement = {
+  type: 'image';
+  src: string;
+  alt?: string;
+  href?: string;
+  width?: string;
+  height?: string;
+  style?: {
+    width?: string;
+    height?: string;
+  };
+  children: EmptyText[];
+};
+type VideoElement = {
+  type: 'video';
+  key?: string;
+  src: string;
+  poster?: string;
+  align?: 'left' | 'center' | 'right';
+  width?: string;
+  height?: string;
+  style?: {
+    width?: string;
+    height?: string;
+  };
+  children: EmptyText[];
+};
+interface IHoverbarConf {
+  [key: string]: {
+    match?: (editor: IDomEditor, n: Node$1) => boolean;
+    menuKeys: string[];
+  };
+}
+type AlertType = 'success' | 'info' | 'warning' | 'error';
+type TextStyleMode = 'inline' | 'class';
+type ClassStylePolicy = 'preserve-data' | 'fallback-inline' | 'strict';
+type TableWidthExportMode = 'adaptive' | 'explicit';
+type StyleClassTokenType = 'color' | 'bgColor' | 'fontSize' | 'fontFamily' | 'textAlign' | 'lineHeight' | 'indent';
+interface IClassStyleUnsupportedPayload {
+  type: string;
+  value: string;
+  scene: 'render' | 'toHtml';
+  fallback: 'preserve-data' | 'inline' | 'throw';
+  message: string;
+}
+interface ISingleMenuConfig {
+  [key: string]: any;
+  iconSvg?: string;
+}
+interface IColorConfig {
+  colors: string[];
+}
+interface IFontSizeItem {
+  name: string;
+  value: string;
+}
+interface IFontSizeConfig {
+  fontSizeList: (string | IFontSizeItem)[];
+}
+interface IFontFamilyItem {
+  name: string;
+  value: string;
+}
+interface IFontFamilyConfig {
+  fontFamilyList: (string | IFontFamilyItem)[];
+}
+interface ILineHeightConfig {
+  lineHeightList: string[];
+}
+interface IImageMenuBaseConfig {
+  checkImage?: (src: string, alt: string, url: string) => boolean | undefined | string;
+  parseImageSrc?: (src: string) => string;
+}
+interface IInsertImageConfig extends IImageMenuBaseConfig {
+  onInsertedImage?: (imageNode: ImageElement | null) => void;
+}
+interface IEditImageConfig extends IImageMenuBaseConfig {
+  onUpdatedImage?: (imageNode: ImageElement | null) => void;
+}
+type ImageResizeUnit = 'px' | '%';
+type ImageResizeSource = 'modal' | 'preset' | 'drag';
+interface IImageResizeCheckPayload {
+  width: string;
+  height: string;
+  rawWidth: string;
+  rawHeight: string;
+  source: ImageResizeSource;
+}
+interface IImageResizeOption {
+  label: string;
+  value: string;
+}
+interface IImageResizeConfig {
+  /** Resize unit for editor-owned image resize actions. Omit to preserve legacy behavior. */
+  resizeUnit?: ImageResizeUnit;
+  /** Values for the built-in 30%/50%/100% preset buttons, in their existing order. */
+  resizeOptions?: IImageResizeOption[];
+  /** Validate normalized image dimensions before they are written to the document. */
+  checkImageSize?: (payload: IImageResizeCheckPayload) => boolean | undefined | string;
+}
+interface IEmotionConfig {
+  emotions: string[];
+}
+interface IInsertTableConfig {
+  minWidth: number;
+  minRowHeight: number;
+  tableHeader: {
+    selected: boolean;
+  };
+  tableFullWidth: {
+    selected: boolean;
+  };
+  widthExportMode: TableWidthExportMode;
+}
+interface IInsertTableColConfig {
+  insertPosition: 'before' | 'after';
+}
+interface ILinkConfig {
+  checkLink: (text: string, url: string) => string | boolean | undefined;
+  parseLinkUrl: (url: string) => string;
+}
+interface IInsertVideoConfig {
+  onInsertedVideo: (videoNode: VideoElement) => NodeEntry | Range;
+  checkVideo: (src: string, poster: string) => string | boolean | undefined;
+  parseVideoSrc: (url: string) => string;
+}
+type IUploadVideoConfig = IUploadConfig;
+type IUploadImageConfig = IUploadConfig & {
+  base64LimitSize: number;
+};
+interface ICodeLangConfig {
+  codeLangs: {
+    text: string;
+    value: string;
+    selected?: boolean;
+  }[];
+}
+interface ICodeBlockConfig {
+  showCopyButton?: boolean;
+}
+interface IMenuConfig {
+  bold: ISingleMenuConfig;
+  underline: ISingleMenuConfig;
+  wavyUnderline: ISingleMenuConfig;
+  emphasisDot: ISingleMenuConfig;
+  italic: ISingleMenuConfig;
+  through: ISingleMenuConfig;
+  code: ISingleMenuConfig;
+  sub: ISingleMenuConfig;
+  sup: ISingleMenuConfig;
+  clearStyle: ISingleMenuConfig;
+  color: IColorConfig;
+  bgColor: IColorConfig;
+  fontSize: IFontSizeConfig;
+  fontFamily: IFontFamilyConfig;
+  indent: ISingleMenuConfig;
+  delIndent: ISingleMenuConfig;
+  justifyLeft: ISingleMenuConfig;
+  justifyRight: ISingleMenuConfig;
+  justifyCenter: ISingleMenuConfig;
+  justifyJustify: ISingleMenuConfig;
+  lineHeight: ILineHeightConfig;
+  insertImage: IInsertImageConfig;
+  deleteImage: ISingleMenuConfig;
+  editImage: IEditImageConfig;
+  previewImage: ISingleMenuConfig;
+  viewImageLink: ISingleMenuConfig;
+  imageWidth30: ISingleMenuConfig;
+  imageWidth50: ISingleMenuConfig;
+  imageWidth100: ISingleMenuConfig;
+  editorImageSizeMenu: ISingleMenuConfig;
+  divider: ISingleMenuConfig;
+  emotion: IEmotionConfig;
+  insertLink: ILinkConfig;
+  editLink: ILinkConfig;
+  unLink: ISingleMenuConfig;
+  viewLink: ISingleMenuConfig;
+  codeBlock: ICodeBlockConfig;
+  blockquote: ISingleMenuConfig;
+  headerSelect: ISingleMenuConfig;
+  header1: ISingleMenuConfig;
+  header2: ISingleMenuConfig;
+  header3: ISingleMenuConfig;
+  header4: ISingleMenuConfig;
+  header5: ISingleMenuConfig;
+  header6: ISingleMenuConfig;
+  todo: ISingleMenuConfig;
+  formatPainter: ISingleMenuConfig;
+  redo: ISingleMenuConfig;
+  undo: ISingleMenuConfig;
+  fullScreen: ISingleMenuConfig;
+  enter: ISingleMenuConfig;
+  bulletedList: ISingleMenuConfig;
+  numberedList: ISingleMenuConfig;
+  numberedListLowerAlpha: ISingleMenuConfig;
+  insertTable: ISingleMenuConfig;
+  deleteTable: ISingleMenuConfig;
+  insertTableRow: IInsertTableConfig;
+  deleteTableRow: ISingleMenuConfig;
+  insertTableCol: IInsertTableColConfig;
+  deleteTableCol: ISingleMenuConfig;
+  tableHeader: ISingleMenuConfig;
+  tableFullWidth: ISingleMenuConfig;
+  mergeTableCell: ISingleMenuConfig;
+  splitTableCell: ISingleMenuConfig;
+  setTableProperty: ISingleMenuConfig;
+  setTableCellProperty: ISingleMenuConfig;
+  insertVideo: IInsertVideoConfig;
+  uploadVideo: IUploadVideoConfig;
+  editVideoSize: ISingleMenuConfig;
+  editVideoSrc: ISingleMenuConfig;
+  uploadImage: IUploadImageConfig;
+  codeSelectLang: ICodeLangConfig;
+}
+type IMenuConfigUpdate = { [K in keyof IMenuConfig]?: Partial<IMenuConfig[K]> };
+/**
+ * editor config
+ */
+interface IEditorConfig {
+  customAlert: (info: string, type: AlertType) => void;
+  onCreated?: (editor: IDomEditor) => void;
+  onChange?: (editor: IDomEditor) => void;
+  onDestroyed?: (editor: IDomEditor) => void;
+  onMaxLength?: (editor: IDomEditor) => void;
+  onFocus?: (editor: IDomEditor) => void;
+  onBlur?: (editor: IDomEditor) => void;
+  /**
+   * 自定义粘贴。返回 true 则继续粘贴，返回 false 则自行实现粘贴，阻止默认粘贴
+   */
+  customPaste?: (editor: IDomEditor, e: ClipboardEvent) => boolean;
+  /**
+  * 自定义复制。拦截 event 添加或修改 clipboardData 数据
+  */
+  customCopy?: (editor: IDomEditor, e: ClipboardEvent) => void;
+  /**
+   * 自定义 HTML 清洗逻辑。在 setHtml / 初始化 html / 默认粘贴 HTML 前执行。
+   * 返回值会继续进入编辑器的 HTML 解析流程。
+   */
+  sanitizeHtml?: (html: string) => string;
+  /**
+   * 文本/段落样式（color/bgColor/fontSize/fontFamily/textAlign/lineHeight/indent）导出模式。
+   * - `inline`: 输出 style 属性（默认）
+   * - `class`: 输出 class + data-w-e-*，便于严格 CSP 场景使用
+   */
+  textStyleMode?: TextStyleMode;
+  /**
+   * class 模式遇到“不在受支持样式 token 集合中”的值时的处理策略。
+   * - `preserve-data`（默认）：保留 data-w-e-*，不输出 class/inline，确保可回读但可能不展示
+   * - `fallback-inline`：回退为 inline style，优先保证展示
+   * - `strict`：直接抛错，阻止静默降级
+   */
+  classStylePolicy?: ClassStylePolicy;
+  /**
+   * class 模式遇到未知值时的通知回调。
+   */
+  onClassStyleUnsupported?: (payload: IClassStyleUnsupportedPayload) => void;
+  /**
+   * class 模式下允许输出 class 的样式 token 注册表。
+   * 用于扩展默认 token（需配合业务方自行提供对应 CSS）。
+   */
+  styleClassTokens?: Partial<Record<StyleClassTokenType, string[]>>;
+  scroll: boolean;
+  placeholder?: string;
+  readOnly: boolean;
+  autoFocus: boolean;
+  decorate?: (nodeEntry: NodeEntry) => Range[];
+  maxLength?: number;
+  imageResize?: IImageResizeConfig;
+  MENU_CONF?: IMenuConfigUpdate;
+  hoverbarKeys?: IHoverbarConf;
+  EXTEND_CONF?: any;
+  skipCacheTypes?: string[];
+}
+//#endregion
+//#region ../core/src/editor/interface.d.ts
+type ElementWithId = Element$1 & {
+  id: string;
+};
+type TableSelectionEntry = [NodeEntry<Element$1 & {
+  type: unknown;
+  rowSpan?: number;
+  colSpan?: number;
+  hidden?: boolean;
+}>, {
+  rtl: number;
+  ltr: number;
+  ttb: number;
+  btt: number;
+}];
+type MoveOptions = Parameters<Editor['move']>[0];
+type getMenuConfigReturnType<K$1> = K$1 extends keyof IMenuConfig ? IMenuConfig[K$1] : ISingleMenuConfig;
+/**
+ * 扩展 slate Editor 接口
+ */
+interface IDomEditor extends Editor {
+  insertData: (data: DataTransfer) => void;
+  setFragmentData: (data: Pick<DataTransfer, 'getData' | 'setData'>) => void;
+  getConfig: () => IEditorConfig;
+  getMenuConfig: <K$1 extends string>(menuKey: K$1) => getMenuConfigReturnType<K$1>;
+  getAllMenuKeys: () => string[];
+  alert: (info: string, type: AlertType) => void;
+  handleTab: () => void;
+  getHtml: () => string;
+  getHtmlWithId?: (idKey?: string) => string;
+  getText: () => string;
+  getSelectionText: () => string;
+  getElemsByTypePrefix: (typePrefix: string) => ElementWithId[];
+  getElemsByType: (type: string, isPrefix?: boolean) => ElementWithId[];
+  getParentNode: (node: Node$1) => Ancestor | null;
+  isEmpty: () => boolean;
+  clear: () => void;
+  /** Transform loaded content before Core binds node paths and renders the editor. */
+  transformInitialContent?: (content: Descendant[]) => Descendant[];
+  dangerouslyInsertHtml: (html: string, isRecursive?: boolean) => void;
+  setHtml: (html: string) => void;
+  id: string;
+  isDestroyed: boolean;
+  isFullScreen: boolean;
+  focus: (isEnd?: boolean) => void;
+  isFocused: () => boolean;
+  blur: () => void;
+  updateView: () => void;
+  destroy: () => void;
+  scrollToElem: (id: string) => void;
+  showProgressBar: (progress: number) => void;
+  hidePanelOrModal: () => void;
+  enable: () => void;
+  disable: () => void;
+  isDisabled: () => boolean;
+  toDOMNode: (node: Node$1) => HTMLElement;
+  fullScreen: () => void;
+  unFullScreen: () => void;
+  getEditableContainer: () => DOMElement;
+  select: (at: Location) => void;
+  deselect: () => void;
+  move(options?: MoveOptions): void;
+  move(distance: number, reverse?: boolean): void;
+  moveReverse: (distance: number) => void;
+  restoreSelection: () => void;
+  getTableSelection?: () => TableSelectionEntry[][] | null;
+  getSelectionPosition: () => Partial<IPositionStyle>;
+  getNodePosition: (node: Node$1) => Partial<IPositionStyle>;
+  isSelectedAll: () => boolean;
+  selectAll: () => void;
+  on: (type: string, listener: ee.EventListener) => void;
+  off: (type: string, listener: ee.EventListener) => void;
+  once: (type: string, listener: ee.EventListener) => void;
+  emit: (type: string, ...args: any[]) => void;
+  undo?: () => void;
+  redo?: () => void;
+  clearHistory?: () => void;
+}
+//#endregion
+//#region ../core/src/upload/createUploader.d.ts
+type IUploadConfigWithAdapter = IUploadConfig & {
+  uploadAdapter: IUploadAdapter;
+};
+type IDefaultUploader = IUploader & {
+  [key: string]: any;
+};
+declare function createUploader<T extends IUploadConfig>(config: T, editor?: IDomEditor): T extends IUploadConfigWithAdapter ? IUploader : IDefaultUploader;
+//#endregion
+export { type IUploadConfig, createUploader };
+//# sourceMappingURL=upload.d.ts.map