slate-angular 17.1.3 → 17.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "slate-angular",
-  "version": "17.1.3",
+  "version": "17.2.1",
   "description": "Angular view layer for Slate",
   "author": "pubuzhixing <pubuzhixing@gmail.com>",
   "homepage": "https://github.com/worktile/slate-angular#readme",

package/plugins/angular-editor.d.ts

@@ -4,14 +4,15 @@ import { Injector } from '@angular/core';
 import { NodeEntry } from 'slate';
 import { SlateError } from '../types/error';
 import { Key } from '../utils/key';
+import { OriginEvent } from '../types/clipboard';
 /**
  * An Angular and DOM-specific version of the `Editor` interface.
  */
 export interface AngularEditor extends BaseEditor {
     insertData: (data: DataTransfer) => void;
-    insertFragmentData: (data: DataTransfer) => boolean;
-    insertTextData: (data: DataTransfer) => boolean;
-    setFragmentData: (data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut') => void;
+    insertFragmentData: (data: DataTransfer) => Promise<boolean>;
+    insertTextData: (data: DataTransfer) => Promise<boolean>;
+    setFragmentData: (data: DataTransfer, originEvent?: OriginEvent) => void;
     deleteCutData: () => void;
     onKeydown: (event: KeyboardEvent) => void;
     onClick: (event: MouseEvent) => void;
@@ -80,11 +81,11 @@ export declare const AngularEditor: {
     /**
      * Insert fragment data from a `DataTransfer` into the editor.
      */
-    insertFragmentData(editor: AngularEditor, data: DataTransfer): boolean;
+    insertFragmentData(editor: AngularEditor, data: DataTransfer): Promise<boolean>;
     /**
      * Insert text data from a `DataTransfer` into the editor.
      */
-    insertTextData(editor: AngularEditor, data: DataTransfer): boolean;
+    insertTextData(editor: AngularEditor, data: DataTransfer): Promise<boolean>;
     /**
      * onKeydown hook.
      */
@@ -96,7 +97,7 @@ export declare const AngularEditor: {
     /**
      * Sets data from the currently selected fragment on a `DataTransfer`.
      */
-    setFragmentData(editor: AngularEditor, data: DataTransfer, originEvent?: 'drag' | 'copy' | 'cut'): void;
+    setFragmentData(editor: AngularEditor, data: DataTransfer, originEvent?: OriginEvent): void;
     deleteCutData(editor: AngularEditor): void;
     /**
      * Find the native DOM element from a Slate node.

package/types/clipboard.d.ts

@@ -0,0 +1,8 @@
+import { Element } from 'slate';
+export interface ClipboardData {
+    files?: File[];
+    elements?: Element[];
+    text?: string;
+    html?: string;
+}
+export type OriginEvent = 'drag' | 'copy' | 'cut';

package/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './error';
 export * from './view';
 export * from './feature';
+export * from './clipboard';
 export type SafeAny = any;

package/utils/clipboard/clipboard.d.ts

@@ -0,0 +1,12 @@
+import { Element } from 'slate';
+import { ClipboardData } from '../../types/clipboard';
+export declare const buildHTMLText: (wrapper: HTMLElement, attach: HTMLElement, data: Element[]) => string;
+export declare const getClipboardFromHTMLText: (html: string) => ClipboardData;
+export declare const createClipboardData: (html: string, elements: Element[], text: string, files: File[]) => ClipboardData;
+export declare const getClipboardData: (dataTransfer?: DataTransfer) => Promise<ClipboardData>;
+/**
+ * @param wrapper get wrapper.innerHTML string which will be written in clipboard
+ * @param attach attach must be child element of wrapper which will be attached json data
+ * @returns void
+ */
+export declare const setClipboardData: (clipboardData: ClipboardData, wrapper: HTMLElement, attach: HTMLElement, dataTransfer?: Pick<DataTransfer, 'getData' | 'setData'>) => Promise<void>;

package/utils/clipboard/common.d.ts

@@ -0,0 +1,6 @@
+export declare const isClipboardReadSupported: () => boolean;
+export declare const isClipboardWriteSupported: () => boolean;
+export declare const isClipboardWriteTextSupported: () => boolean;
+export declare const isClipboardFile: (item: ClipboardItem) => string;
+export declare const stripHtml: (html: string) => string;
+export declare const blobAsString: (blob: Blob) => Promise<string>;

package/utils/clipboard/data-transfer.d.ts

@@ -0,0 +1,5 @@
+import { ClipboardData } from '../../types/clipboard';
+export declare const setDataTransferClipboard: (dataTransfer: Pick<DataTransfer, 'getData' | 'setData'> | null, htmlText: string) => void;
+export declare const setDataTransferClipboardText: (data: Pick<DataTransfer, 'getData' | 'setData'> | null, text: string) => void;
+export declare const getDataTransferClipboard: (data: Pick<DataTransfer, 'getData' | 'setData'> | null) => ClipboardData;
+export declare const getDataTransferClipboardText: (data: Pick<DataTransfer, 'getData' | 'setData'> | null) => ClipboardData;

package/utils/clipboard/index.d.ts

@@ -0,0 +1,4 @@
+export * from './clipboard';
+export * from './data-transfer';
+export * from './navigator-clipboard';
+export * from './common';

package/utils/clipboard/navigator-clipboard.d.ts

@@ -0,0 +1,4 @@
+import { Element } from 'slate';
+import { ClipboardData } from '../../types/clipboard';
+export declare const setNavigatorClipboard: (htmlText: string, data: Element[], text?: string) => Promise<void>;
+export declare const getNavigatorClipboard: () => Promise<ClipboardData>;

package/utils/dom.d.ts

@@ -70,9 +70,5 @@ export declare const getEditableChild: (parent: DOMElement, index: number, direc
  * The domNode must be attached to the DOM.
  */
 export declare const getPlainText: (domNode: DOMNode) => string;
-export declare const getSlateFragmentAttribute: (dataTransfer: DataTransfer) => string | void;
-/**
- * Get the x-slate-fragment attribute that exist in text/html data
- * and append it to the DataTransfer object
- */
-export declare const getClipboardData: (dataTransfer: DataTransfer, clipboardFormatKey?: string) => DataTransfer;
+export declare const SlateFragmentAttributeKey = "data-slate-angular-fragment";
+export declare const getSlateFragmentAttribute: (htmlData: string) => string | void;

package/utils/index.d.ts

@@ -8,3 +8,4 @@ export * from './range-list';
 export * from './block-card';
 export * from './global-normalize';
 export * from './throttle';
+export * from './clipboard';