@remarkablejames/editor 0.0.1

package/lib/utils/dom-dataset.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @param json
+ */
+export declare function jsonToStr(json: Record<string, unknown>): string;
+/**
+ * @param str
+ */
+export declare function strToJSON(str: string): any;
+/**
+ * @param element
+ * @param json
+ */
+export declare function jsonToDOMDataset(json: Record<string, unknown>): {
+    key: string;
+    value: string;
+}[];
+/**
+ * @param element
+ * @param attribute
+ * @param transformToJSON
+ */
+export declare function getDatasetAttribute(attribute: string, transformToJSON?: boolean): (element: HTMLElement) => any;
+/**
+ * 将节点属性转换为 dataset
+ * @param node
+ * @returns
+ */
+export declare function nodeAttrsToDataset(node: Node): any;

package/lib/utils/download.d.ts

@@ -0,0 +1 @@
+export declare function downloadFromBlob(blob: Blob, filename: string): Promise<void>;

package/lib/utils/dynamicCSS.d.ts

@@ -0,0 +1,25 @@
+export type ContainerType = Element | ShadowRoot;
+export type Prepend = boolean | 'queue';
+export type AppendType = 'prependQueue' | 'append' | 'prepend';
+export default function contains(root: Node | null | undefined, n?: Node): boolean;
+interface Options {
+    attachTo?: ContainerType;
+    csp?: {
+        nonce?: string;
+    };
+    prepend?: Prepend;
+    /**
+     * Config the `priority` of `prependQueue`. Default is `0`.
+     * It's useful if you need to insert style before other style.
+     */
+    priority?: number;
+    mark?: string;
+}
+export declare function injectCSS(css: string, option?: Options): HTMLStyleElement;
+export declare function removeCSS(key: string, option?: Options): void;
+/**
+ * manually clear container cache to avoid global cache in unit testes
+ */
+export declare function clearContainerCache(): void;
+export declare function updateCSS(css: string, key: string, option?: Options): HTMLStyleElement;
+export {};

package/lib/utils/editor-container-size.d.ts

@@ -0,0 +1,4 @@
+import { Editor } from '@tiptap/core';
+export declare function getEditorContainerDOMSize(editor: Editor): {
+    width: number;
+};

package/lib/utils/file.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 获取文件名
+ *
+ * @example
+ *   > extractFilename('https://gitlab.com/images/logo-full.png')
+ *   < 'logo-full'
+ *
+ * @param {string} src The URL to extract filename from
+ * @returns {string}
+ */
+export declare function extractFilename(src: any): any;
+/**
+ * extractFileExtension
+ * @param {string} fileName The file name to extract extension from
+ * @returns  {string}
+ */
+export declare function extractFileExtension(fileName: any): any;
+export declare function normalizeFileSize(size: any): string;
+export type FileType = 'image' | 'audio' | 'video' | 'pdf' | 'word' | 'excel' | 'ppt' | 'file';
+export declare function normalizeFileType(fileType: any): FileType;
+export declare function readImageAsBase64(file: File): Promise<{
+    alt: string;
+    src: string;
+}>;
+export declare function getImageWidthHeight(url: string): Promise<{
+    width: number | string;
+    height: number | string;
+}>;
+export declare const FILE_CHUNK_SIZE: number;
+export declare function dataURLtoFile(dataurl: string, filename: string): File;

package/lib/utils/getRenderContainer.d.ts

@@ -0,0 +1,3 @@
+import { Editor } from '@tiptap/react';
+export declare function getRenderContainer(editor: Editor, nodeType: string): any;
+export default getRenderContainer;

package/lib/utils/indent.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@tiptap/core';
+import { Transaction } from '@tiptap/pm/state';
+export declare const enum IndentProps {
+    max = 7,
+    min = 0,
+    more = 1,
+    less = -1
+}
+export declare function clamp(val: number, min: number, max: number): number;
+export declare function setNodeIndentMarkup(tr: Transaction, pos: number, delta: number): Transaction;
+export declare function createIndentCommand({ delta, types }: {
+    delta: number;
+    types: string[];
+}): Command;

package/lib/utils/is-mobile.d.ts

@@ -0,0 +1,19 @@
+interface HttpRequestHeadersInterfaceMock {
+    [id: string]: string | string[] | undefined;
+}
+interface HttpRequestInterfaceMock {
+    headers: HttpRequestHeadersInterfaceMock;
+    [id: string]: any;
+}
+export interface IsMobileOptions {
+    ua?: string | HttpRequestInterfaceMock;
+    tablet?: boolean;
+    featureDetect?: boolean;
+}
+/**
+ * Determines if the current device is a mobile or tablet device.
+ * @param opts - Options for the detection.
+ * @returns `true` if the device is mobile or tablet, `false` otherwise.
+ */
+export declare function isMobile(opts?: IsMobileOptions): boolean;
+export {};

package/lib/utils/json.d.ts

@@ -0,0 +1,2 @@
+export declare function safeJSONParse(str: any, defaultValue?: {}): any;
+export declare function safeJSONStringify(obj: any, defaultValue?: string): string;

package/lib/utils/lru-cache.d.ts

@@ -0,0 +1,31 @@
+declare class Node {
+    key: string;
+    value: string | number;
+    prev: Node | null;
+    next: Node | null;
+    constructor(key: any, value: any);
+}
+export declare class LRUCache {
+    private capacity;
+    private usedCapacity;
+    private head;
+    private tail;
+    private store;
+    constructor(capacity: any);
+    private removeNode;
+    private addToHead;
+    private moveToHead;
+    private removeTail;
+    get(key: any): string | number;
+    put(key: any, value: any): void;
+    keys(): any[];
+    values(): any[];
+    toJSON(): Record<string, Node>;
+}
+export declare function createKeysLocalStorageLRUCache(storageKey: any, capacity: any): {
+    syncFromStorage(): void;
+    syncToStorage(): void;
+    put(key: any): void;
+    get(key?: string): string | number | any[];
+};
+export {};

package/lib/utils/mitt.d.ts

@@ -0,0 +1,24 @@
+/**
+ * copy to https://github.com/developit/mitt
+ */
+export type EventType = string | symbol;
+export type Handler<T = unknown> = (event: T) => void;
+export type WildcardHandler<T = Record<string, unknown>> = (type: keyof T, event: T[keyof T]) => void;
+export type EventHandlerList<T = unknown> = Array<Handler<T>>;
+export type WildCardEventHandlerList<T = Record<string, unknown>> = Array<WildcardHandler<T>>;
+export type EventHandlerMap<Events extends Record<EventType, unknown>> = Map<keyof Events | '*', EventHandlerList<Events[keyof Events]> | WildCardEventHandlerList<Events>>;
+export interface Emitter<Events extends Record<EventType, unknown>> {
+    all: EventHandlerMap<Events>;
+    on<Key extends keyof Events>(type: Key, handler: Handler<Events[Key]>): void;
+    on(type: '*', handler: WildcardHandler<Events>): void;
+    off<Key extends keyof Events>(type: Key, handler?: Handler<Events[Key]>): void;
+    off(type: '*', handler: WildcardHandler<Events>): void;
+    emit<Key extends keyof Events>(type: Key, event: Events[Key]): void;
+    emit<Key extends keyof Events>(type: undefined extends Events[Key] ? Key : never): void;
+}
+/**
+ * Mitt: Tiny (~200b) functional event emitter / pubsub.
+ * @name mitt
+ * @returns {Mitt}
+ */
+export default function mitt<Events extends Record<EventType, unknown>>(all?: EventHandlerMap<Events>): Emitter<Events>;

package/lib/utils/node.d.ts

@@ -0,0 +1,15 @@
+import { Editor } from '@tiptap/core';
+import { Node } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare function isTitleNode(node: Node): boolean;
+export declare function isBulletListNode(node: Node): boolean;
+export declare function isOrderedListNode(node: Node): boolean;
+export declare function isTodoListNode(node: Node): boolean;
+export declare function isListNode(node: Node): boolean;
+export declare function getCurrentNode(state: EditorState): any;
+export declare function getNodeAtPos(state: EditorState, pos: number): any;
+export declare function isInCustomNode(state: EditorState, nodeName: string): boolean;
+export declare function isInCodeBlock(state: EditorState): boolean;
+export declare function isInTitle(state: EditorState): boolean;
+export declare function isInCallout(state: EditorState): boolean;
+export declare function findNode(editor: Editor, name: string): any[];

package/lib/utils/pdf.d.ts

@@ -0,0 +1,3 @@
+import { ExportPdfOptions } from '../extensions/ExportPdf';
+import { Editor } from '@tiptap/core';
+export declare function printEditorContent(editor: Editor, exportPdfOptions: ExportPdfOptions): boolean;

package/lib/utils/plateform.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Return true if the user is using a Mac (as opposed to Windows, etc.) device.
+ */
+export declare function isMac(): boolean;
+/**
+ * 根据 Mac 和非 Mac 平台，返回应该用于键盘快捷键的修饰键的可读版本。用于直观地指示应该按哪个键。
+ */
+export declare function getShortcutKey(key: string): string;
+export declare function getShortcutKeys(keys: string[]): string;
+/** Return true if the user is using a touch-based device. */
+export declare function isTouchDevice(): boolean;

package/lib/utils/renderNodeView.d.ts

@@ -0,0 +1,6 @@
+export declare function renderNodeViewClosure(node: any): () => {
+    onStart: (props: any) => void;
+    onUpdate(props: any): void;
+    onKeyDown(props: any): any;
+    onExit(): void;
+};

package/lib/utils/shortId.d.ts

@@ -0,0 +1 @@
+export declare function shortId(length?: number): string;

package/lib/utils/storage.d.ts

@@ -0,0 +1,2 @@
+export declare function getStorage(key: any, defaultValue?: null): any;
+export declare function setStorage(key: any, value: any): void;

package/lib/utils/updatePosition.d.ts

@@ -0,0 +1 @@
+export declare function updatePosition(editor: any, element: any): void;

package/lib/utils/utils.d.ts

@@ -0,0 +1,20 @@
+import { NameValueOption } from '../types';
+import { Editor } from '@tiptap/core';
+export declare function clamp(val: number, min: number, max: number): number;
+export declare const isNumber: (value: unknown) => value is number;
+export declare const isString: (value: unknown) => value is string;
+export declare const isBoolean: (value: unknown) => value is boolean;
+export declare const isFunction: (value: unknown) => boolean;
+export declare function getCssUnitWithDefault(value?: string | number, defaultUnit?: string): string | number | undefined;
+/**
+ * Checks if the editor has a specific extension method with the given name.
+ *
+ * @param {Editor} editor - An instance of the editor.
+ * @param {string} name - The name of the extension method.
+ * @returns {boolean} - Returns true if the specified extension method is present, otherwise returns false.
+ */
+export declare function hasExtension(editor: Editor, name: string): boolean;
+/**
+ * Normalizes an array of strings or objects to an array of objects with 'value' and 'name' properties.
+ */
+export declare function ensureNameValueOptions(arr: (string | NameValueOption)[]): NameValueOption<string>[];

package/lib/utils/validateFile.d.ts

@@ -0,0 +1,16 @@
+import { ToastProps } from '../components/ui/toast';
+interface ValidateFileOptions {
+    acceptMimes: string[];
+    maxSize: number;
+    t: any;
+    toast: (props: ToastProps) => void;
+    onError?: (error: {
+        type: "size" | "type" | "upload";
+        message: string;
+        file?: File;
+    }) => void;
+}
+export declare function validateFiles(files: File[] | {
+    [key: string]: File;
+}, options: ValidateFileOptions): File[];
+export {};