wysimark-lite 0.9.7 → 0.9.8

package/dist/wysimark.d.ts

@@ -1,10 +1,8 @@
 import * as slate from 'slate';
 import { Element as Element$1, BaseEditor, NodeEntry, BaseRange, Location, Editor, Descendant, Path, BaseText } from 'slate';
-import { Client } from '@portive/client';
-import { SetReturnType, SetOptional, UnionToIntersection, Simplify, RequireExactlyOne } from 'type-fest';
-import * as zustand from 'zustand';
 import { HistoryEditor } from 'slate-history';
 import { ReactEditor, Editable } from 'slate-react';
+import { SetReturnType, SetOptional, UnionToIntersection, Simplify } from 'type-fest';
 import react from 'react';
 import { RenderElementProps, RenderLeafProps, RenderPlaceholderProps, EditableProps } from 'slate-react/dist/components/editable';
 
@@ -423,79 +421,146 @@ type ImageSizePreset = {
     scale: number;
 };
 
-declare function createAnchorMethods(editor: Editor): {
-    insertLink: (args_0: string, args_1?: string | undefined, args_2?: {
-        select?: boolean | undefined;
-    } | undefined) => void;
-    removeLink: (args_0: {
-        at?: BetterAt | undefined;
-    }) => boolean;
-    editLink: (args_0: {
-        href: string;
-        title?: string | undefined;
-    }, args_1: {
-        at?: BetterAt | undefined;
-    }) => boolean;
+type ToolbarEditor = {
+    toolbar: {
+        height?: string | number;
+        minHeight?: string | number;
+        maxHeight?: string | number;
+        showUploadButtons?: boolean;
+    };
+};
+type ToolbarOptions = {
+    toolbar: {
+        height?: string | number;
+        minHeight?: string | number;
+        maxHeight?: string | number;
+        showUploadButtons?: boolean;
+    };
+};
+type ToolbarPluginCustomTypes = {
+    Name: "toolbar";
+    Editor: ToolbarEditor;
+    Options: ToolbarOptions;
 };
 
-type AnchorMethods = ReturnType<typeof createAnchorMethods>;
-type AnchorEditor = {
-    anchor: AnchorMethods;
+type ThemeEditor = {
+    theme: true;
 };
-type AnchorElement = {
-    type: "anchor";
-    href: string;
-    target?: string;
-    title?: string;
+type ThemePluginCustomTypes = {
+    Name: "theme";
+    Editor: ThemeEditor;
+};
+
+type CollapsibleParagraphEditor = {
+    collapsibleParagraph: {
+        convertParagraph: () => void;
+    };
+};
+type ParagraphElement = {
+    type: "paragraph";
+    __collapsible?: true;
     children: Descendant[];
 };
-type AnchorPluginCustomTypes = {
-    Name: "anchor";
-    Editor: AnchorEditor;
-    Element: AnchorElement;
+type CollapsibleParagraphPluginCustomTypes = {
+    Name: "collapsible-paragraph";
+    Editor: CollapsibleParagraphEditor;
+    Element: ParagraphElement;
 };
 
-declare function createHeadingMethods(editor: Editor): {
-    convertHeading: (level: 1 | 2 | 3 | 4 | 5 | 6, allowToggle: boolean) => void;
-    isHeadingActive: (level: 1 | 2 | 3 | 4 | 5 | 6) => boolean;
+type NormalizeAfterDeleteEditor = {
+    normalizeAfterDelete: true;
+};
+type NormalizeAfterDeletePluginCustomTypes = {
+    Name: "normalize-after-delete";
+    Editor: NormalizeAfterDeleteEditor;
 };
 
-type HeadingEditor = {
-    heading: ReturnType<typeof createHeadingMethods>;
+type AtomicDeleteEditor = {
+    atomicDelete: true;
 };
-type HeadingElement = {
-    type: "heading";
-    /**
-     * NOTE:
-     *
-     * Don't extract these into a new type. It's easier to just repeat this and
-     * there's less indirection.
-     */
-    level: 1 | 2 | 3 | 4 | 5 | 6;
-    children: Descendant[];
+type AtomicDeletePluginCustomTypes = {
+    Name: "atomic-delete";
+    Editor: AtomicDeleteEditor;
 };
-type HeadingPluginCustomTypes = {
-    Name: "heading";
-    Editor: HeadingEditor;
-    Element: HeadingElement;
+
+declare function createListMethods(editor: Editor): {
+    indent: () => boolean;
+    outdent: () => boolean;
+    convertUnorderedList: (allowToggle: boolean) => void;
+    convertOrderedList: (allowToggle: boolean) => void;
+    convertTaskList: (allowToggle: boolean) => void;
+    insertBreak: () => boolean;
+    toggleTaskListItem: (args_0?: {
+        at?: BetterAt | undefined;
+    } | undefined) => false | undefined;
+    getListDepth: () => number;
+    canIncreaseDepth: () => boolean;
+    canDecreaseDepth: () => boolean;
+    increaseDepth: () => void;
+    decreaseDepth: () => void;
 };
 
-type BlockQuoteEditor = {
-    supportsBlockQuote: true;
-    blockQuotePlugin: {
-        indent: () => void;
-        outdent: () => void;
-        isActive: () => boolean;
-    };
+/**
+ * List Editor
+ */
+type ListEditor = {
+    list: ReturnType<typeof createListMethods>;
 };
-type BlockQuoteElement = {
-    type: "block-quote";
+/**
+ * Ordered List Item Element
+ */
+type OrderedListItemElement = {
+    type: "ordered-list-item";
+    depth: number;
+    __firstAtDepth?: boolean;
     children: Descendant[];
 };
-type BlockQuotePluginCustomTypes = {
-    Name: "block-quote";
-    Editor: BlockQuoteEditor;
-    Element: BlockQuoteElement;
+/**
+ * Unordered List Item Element
+ */
+type UnorderedListItemElement = {
+    type: "unordered-list-item";
+    depth: number;
+    __firstAtDepth?: boolean;
+    children: Descendant[];
+};
+/**
+ * Checkable Task List Item Element
+ */
+type TaskListItemElement = {
+    type: "task-list-item";
+    depth: number;
+    __firstAtDepth?: boolean;
+    checked: boolean;
+    children: Descendant[];
+};
+/**
+ * List Plugins Custom Types
+ */
+type ListPluginCustomTypes = {
+    Name: "list";
+    Editor: ListEditor;
+    Element: OrderedListItemElement | UnorderedListItemElement | TaskListItemElement;
+};
+
+declare function createHorizontalRuleMethods(editor: Editor): {
+    insertHorizontalRule: () => boolean;
+};
+
+type HorizontalRuleMethods = ReturnType<typeof createHorizontalRuleMethods>;
+type HorizontalRuleEditor = {
+    horizontalRule: HorizontalRuleMethods;
+};
+type HorizontalRuleElement = {
+    type: "horizontal-rule";
+    children: [{
+        text: "";
+    }];
+};
+type HorizontalRulePluginCustomTypes = {
+    Name: "horizontal-rule";
+    Editor: HorizontalRuleEditor;
+    Element: HorizontalRuleElement;
 };
 
 /**
@@ -574,100 +639,79 @@ type TableInfo = {
     cellCount: number;
 };
 
-declare function createHorizontalRuleMethods(editor: Editor): {
-    insertHorizontalRule: () => boolean;
+declare function createAnchorMethods(editor: Editor): {
+    insertLink: (args_0: string, args_1?: string | undefined, args_2?: {
+        select?: boolean | undefined;
+    } | undefined) => void;
+    removeLink: (args_0: {
+        at?: BetterAt | undefined;
+    }) => boolean;
+    editLink: (args_0: {
+        href: string;
+        title?: string | undefined;
+    }, args_1: {
+        at?: BetterAt | undefined;
+    }) => boolean;
 };
 
-type HorizontalRuleMethods = ReturnType<typeof createHorizontalRuleMethods>;
-type HorizontalRuleEditor = {
-    horizontalRule: HorizontalRuleMethods;
+type AnchorMethods = ReturnType<typeof createAnchorMethods>;
+type AnchorEditor = {
+    anchor: AnchorMethods;
 };
-type HorizontalRuleElement = {
-    type: "horizontal-rule";
-    children: [{
-        text: "";
-    }];
+type AnchorElement = {
+    type: "anchor";
+    href: string;
+    target?: string;
+    title?: string;
+    children: Descendant[];
 };
-type HorizontalRulePluginCustomTypes = {
-    Name: "horizontal-rule";
-    Editor: HorizontalRuleEditor;
-    Element: HorizontalRuleElement;
+type AnchorPluginCustomTypes = {
+    Name: "anchor";
+    Editor: AnchorEditor;
+    Element: AnchorElement;
 };
 
-declare function createListMethods(editor: Editor): {
-    indent: () => boolean;
-    outdent: () => boolean;
-    convertUnorderedList: (allowToggle: boolean) => void;
-    convertOrderedList: (allowToggle: boolean) => void;
-    convertTaskList: (allowToggle: boolean) => void;
-    insertBreak: () => boolean;
-    toggleTaskListItem: (args_0?: {
-        at?: BetterAt | undefined;
-    } | undefined) => false | undefined;
-    getListDepth: () => number;
-    canIncreaseDepth: () => boolean;
-    canDecreaseDepth: () => boolean;
-    increaseDepth: () => void;
-    decreaseDepth: () => void;
+declare function createHeadingMethods(editor: Editor): {
+    convertHeading: (level: 1 | 2 | 3 | 4 | 5 | 6, allowToggle: boolean) => void;
+    isHeadingActive: (level: 1 | 2 | 3 | 4 | 5 | 6) => boolean;
 };
 
-/**
- * List Editor
- */
-type ListEditor = {
-    list: ReturnType<typeof createListMethods>;
-};
-/**
- * Ordered List Item Element
- */
-type OrderedListItemElement = {
-    type: "ordered-list-item";
-    depth: number;
-    __firstAtDepth?: boolean;
-    children: Descendant[];
-};
-/**
- * Unordered List Item Element
- */
-type UnorderedListItemElement = {
-    type: "unordered-list-item";
-    depth: number;
-    __firstAtDepth?: boolean;
-    children: Descendant[];
+type HeadingEditor = {
+    heading: ReturnType<typeof createHeadingMethods>;
 };
-/**
- * Checkable Task List Item Element
- */
-type TaskListItemElement = {
-    type: "task-list-item";
-    depth: number;
-    __firstAtDepth?: boolean;
-    checked: boolean;
+type HeadingElement = {
+    type: "heading";
+    /**
+     * NOTE:
+     *
+     * Don't extract these into a new type. It's easier to just repeat this and
+     * there's less indirection.
+     */
+    level: 1 | 2 | 3 | 4 | 5 | 6;
     children: Descendant[];
 };
-/**
- * List Plugins Custom Types
- */
-type ListPluginCustomTypes = {
-    Name: "list";
-    Editor: ListEditor;
-    Element: OrderedListItemElement | UnorderedListItemElement | TaskListItemElement;
+type HeadingPluginCustomTypes = {
+    Name: "heading";
+    Editor: HeadingEditor;
+    Element: HeadingElement;
 };
 
-type CollapsibleParagraphEditor = {
-    collapsibleParagraph: {
-        convertParagraph: () => void;
+type BlockQuoteEditor = {
+    supportsBlockQuote: true;
+    blockQuotePlugin: {
+        indent: () => void;
+        outdent: () => void;
+        isActive: () => boolean;
     };
 };
-type ParagraphElement = {
-    type: "paragraph";
-    __collapsible?: true;
+type BlockQuoteElement = {
+    type: "block-quote";
     children: Descendant[];
 };
-type CollapsibleParagraphPluginCustomTypes = {
-    Name: "collapsible-paragraph";
-    Editor: CollapsibleParagraphEditor;
-    Element: ParagraphElement;
+type BlockQuotePluginCustomTypes = {
+    Name: "block-quote";
+    Editor: BlockQuoteEditor;
+    Element: BlockQuoteElement;
 };
 
 declare function createTableMethods(editor: Editor): {
@@ -714,161 +758,6 @@ type TablePluginCustomTypes = {
     Element: TableElement | TableRowElement | TableCellElement | TableContentElement;
 };
 
-declare function createUploadMethods(editor: Editor): {
-    upload: (file: File) => boolean;
-    setElementTimeTraveling: <T extends ImageBlockElement | ImageInlineElement | ParagraphElement | OrderedListItemElement | UnorderedListItemElement | TaskListItemElement | HorizontalRuleElement | TableElement | TableRowElement | TableCellElement | TableContentElement | BlockQuoteElement | HeadingElement | AnchorElement, K extends keyof T = keyof T>(prev: RequireExactlyOne<T, K>, next: RequireExactlyOne<T, K>) => void;
-};
-
-/**
- * Indicates an `Origin` that is uploading and the state of the Upload
- */
-type UploadProgress = {
-    /**
-     * This is a URL but not the final upload URL. This is a URL that represents
-     * a secure value in the form of a string that represents a location on the
-     * user's computer.
-     */
-    url: string;
-    status: "progress";
-    sentBytes: number;
-    totalBytes: number;
-};
-/**
- * Indicates an `Origin` that has completed uploading
- */
-type UploadComplete = {
-    status: "success";
-    /**
-     * This is a URL to the final place of the file
-     */
-    url: string;
-};
-/**
- * Indicates an `Origin` that has an error during uploading and the Error
- * message
- */
-type UploadError = {
-    status: "error";
-    url: string;
-    message: string;
-};
-type Upload = UploadProgress | UploadComplete | UploadError;
-
-/**
- * Creates an origin store using `zustand`.
- *
- * The purpose of this is to keep track of uploads and their progress but only
- * storing the key to the lookup in the Element itself.
- *
- * This is necessary so that the Element value stays the same even as the image
- * progress is updating during the upload.
- *
- * We want this because we don't want the progress updates to be part of the
- * document's edit history. Consider that a user executes an undo and it undoes
- * the progress of the upload.
- *
- * Te return value of `createUploadStore` is a React hook.
- *
- * The hook should be referenced as `useUploadStore`
- */
-declare const createUploadStore: ({ uploads }?: {
-    uploads: Record<string, Upload>;
-}) => zustand.UseBoundStore<zustand.StoreApi<UploadStore>>;
-
-/**
- * Types related to the `zustand` state-management library which we use to
- * store the state of uploads.
- */
-type GetUpload = (id: string) => Upload;
-type SetUpload = (id: string, upload: Upload) => void;
-type UploadStore = {
-    uploads: Record<string, Upload>;
-    getUpload: GetUpload;
-    setUpload: SetUpload;
-};
-
-type UploadMethods = ReturnType<typeof createUploadMethods>;
-type UploadFileEvent = {
-    hashUrl: string;
-    file: File;
-};
-type UploadImageFileEvent = UploadFileEvent & {
-    width: number;
-    height: number;
-};
-type UploadFileSuccessEvent = UploadFileEvent & {
-    url: string;
-};
-type UploadImageFileSuccessEvent = UploadImageFileEvent & {
-    url: string;
-};
-type UploadEditor = {
-    upload: UploadMethods & {
-        client?: Client;
-        onUploadImageFile: (e: UploadImageFileEvent) => boolean;
-        onUploadFile: (e: UploadFileEvent) => boolean;
-        onUploadImageFileSuccess: (e: UploadImageFileSuccessEvent) => boolean;
-        onUploadFileSuccess: (e: UploadFileSuccessEvent) => boolean;
-        useUploadStore: ReturnType<typeof createUploadStore>;
-    };
-};
-type UploadOptions = {
-    upload?: {
-        authToken?: string;
-    };
-};
-type UploadPluginCustomTypes = {
-    Name: "upload";
-    Editor: UploadEditor;
-    Options: UploadOptions;
-};
-
-type ToolbarEditor = {
-    toolbar: {
-        height?: string | number;
-        minHeight?: string | number;
-        maxHeight?: string | number;
-        showUploadButtons?: boolean;
-    };
-};
-type ToolbarOptions = {
-    toolbar: {
-        height?: string | number;
-        minHeight?: string | number;
-        maxHeight?: string | number;
-        showUploadButtons?: boolean;
-    };
-};
-type ToolbarPluginCustomTypes = {
-    Name: "toolbar";
-    Editor: ToolbarEditor;
-    Options: ToolbarOptions;
-};
-
-type ThemeEditor = {
-    theme: true;
-};
-type ThemePluginCustomTypes = {
-    Name: "theme";
-    Editor: ThemeEditor;
-};
-
-type NormalizeAfterDeleteEditor = {
-    normalizeAfterDelete: true;
-};
-type NormalizeAfterDeletePluginCustomTypes = {
-    Name: "normalize-after-delete";
-    Editor: NormalizeAfterDeleteEditor;
-};
-
-type AtomicDeleteEditor = {
-    atomicDelete: true;
-};
-type AtomicDeletePluginCustomTypes = {
-    Name: "atomic-delete";
-    Editor: AtomicDeleteEditor;
-};
-
 type InlineCodeEditor = {
     inlineCode: {
         toggleInlineCode: () => void;
@@ -982,7 +871,7 @@ declare const plugins: (TypedPlugin<PasteMarkdownPluginCustomTypes> | TypedPlugi
     Editor: {
         allowTrailingBlock: true;
     };
-}> | TypedPlugin<ListPluginCustomTypes> | TypedPlugin<AtomicDeletePluginCustomTypes> | TypedPlugin<NormalizeAfterDeletePluginCustomTypes> | TypedPlugin<CollapsibleParagraphPluginCustomTypes> | TypedPlugin<ThemePluginCustomTypes> | TypedPlugin<ToolbarPluginCustomTypes> | TypedPlugin<UploadPluginCustomTypes> | TypedPlugin<ImagePluginCustomTypes> | TypedPlugin<PlaceholderPluginCustomTypes>)[];
+}> | TypedPlugin<ListPluginCustomTypes> | TypedPlugin<AtomicDeletePluginCustomTypes> | TypedPlugin<NormalizeAfterDeletePluginCustomTypes> | TypedPlugin<CollapsibleParagraphPluginCustomTypes> | TypedPlugin<ThemePluginCustomTypes> | TypedPlugin<ToolbarPluginCustomTypes> | TypedPlugin<ImagePluginCustomTypes> | TypedPlugin<PlaceholderPluginCustomTypes>)[];
 type PluginTypes = ExtractCustomTypes<typeof plugins>;
 type CustomEditor = PluginTypes["Editor"];
 type CustomElement = PluginTypes["Element"];