@doist/typist 1.0.0

package/dist/extensions/shared/paste-singleline-text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paste-singleline-text.d.ts","sourceRoot":"","sources":["../../../src/extensions/shared/paste-singleline-text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAQxC;;;;;GAKG;AACH,QAAA,MAAM,mBAAmB,qBAiCvB,CAAA;AAEF,OAAO,EAAE,mBAAmB,EAAE,CAAA"}

package/dist/extensions/shared/paste-singleline-text.js

@@ -0,0 +1,43 @@
+import { Extension } from '@tiptap/core';
+import { escape } from 'lodash-es';
+import { Plugin, PluginKey } from 'prosemirror-state';
+import { REGEX_LINE_BREAKS } from '../../constants/regular-expressions';
+import { parseHtmlToElement } from '../../helpers/dom';
+import { isPlainTextDocument } from '../../helpers/schema';
+/**
+ * The `PasteSinglelineText` extension joins all paragraphs into a single fragment when
+ * copying-and-pasting text into the editor, adding spaces as block separators. This custom
+ * extension is required for an editor configured with `multiline: false`, so that multiline
+ * clipboard text is pasted into the singleline editor correctly.
+ */
+const PasteSinglelineText = Extension.create({
+    name: 'pasteSinglelineText',
+    addProseMirrorPlugins() {
+        return [
+            new Plugin({
+                key: new PluginKey('pasteSinglelineText'),
+                props: {
+                    transformPastedHTML(html, view) {
+                        const bodyElement = parseHtmlToElement(html);
+                        bodyElement.innerHTML = bodyElement.innerHTML
+                            // Join break lines with a space character in-between
+                            .replace(/<br>/g, ' ')
+                            // Join paragraphs with a space character in-between
+                            .replace(/<p[^>]+>(.*?)<\/p>/g, '$1 ');
+                        return isPlainTextDocument(view.state.schema)
+                            ? escape(bodyElement.innerText)
+                            : bodyElement.innerHTML;
+                    },
+                    transformPastedText(text) {
+                        return (text
+                            // Join new lines with a space character in-between
+                            .replace(REGEX_LINE_BREAKS, ' ')
+                            // Collapse multiple space characters into one
+                            .replace(/\s+/g, ' '));
+                    },
+                },
+            }),
+        ];
+    },
+});
+export { PasteSinglelineText };

package/dist/factories/create-suggestion-extension.d.ts

@@ -0,0 +1,121 @@
+import { Node } from '@tiptap/core';
+import type { SuggestionKeyDownProps as CoreSuggestionKeyDownProps, SuggestionOptions as CoreSuggestionOptions } from '@tiptap/suggestion';
+import type { ConditionalKeys, RequireAtLeastOne } from 'type-fest';
+/**
+ * The properties that describe the suggestion node attributes.
+ */
+declare type SuggestionAttributes = {
+    /**
+     * The suggestion node unique identifier to be rendered by the editor as a `data-id` attribute.
+     */
+    id: number;
+    /**
+     * The suggestion node label to be rendered by the editor as a `data-label` attribute and the
+     * display text itself.
+     */
+    label: string;
+};
+/**
+ * The properties that describe the minimal props that an autocomplete dropdown must receive.
+ */
+declare type SuggestionRendererProps<SuggestionItemType> = {
+    /**
+     * The function that must be invoked when a suggestion item is selected.
+     */
+    command: (item: SuggestionItemType) => void;
+    /**
+     * The list of suggestion items to be rendered by the autocomplete dropdown.
+     */
+    items: SuggestionItemType[];
+};
+/**
+ * A type that describes the forwarded ref that an autocomplete dropdown must implement with
+ * `useImperativeHandle` to receive `keyDown` events from the render function.
+ */
+declare type SuggestionRendererRef = {
+    onKeyDown: (props: CoreSuggestionKeyDownProps) => boolean;
+};
+/**
+ * The options available to customize the extension created by the factory function.
+ */
+declare type SuggestionOptions<SuggestionItemType> = {
+    /**
+     * The character that triggers the autocomplete dropdown.
+     */
+    triggerChar: '@' | '#' | '+';
+    /**
+     * Allows or disallows spaces in suggested items.
+     */
+    allowSpaces: CoreSuggestionOptions['allowSpaces'];
+    /**
+     * The prefix characters that are allowed to trigger a suggestion.
+     */
+    allowedPrefixes: CoreSuggestionOptions['allowedPrefixes'];
+    /**
+     * Trigger the autocomplete dropdown at the start of a line only.
+     */
+    startOfLine: CoreSuggestionOptions['startOfLine'];
+    /**
+     * Define how the suggestion item `aria-label` attribute should be rendered.
+     */
+    renderAriaLabel?: (attrs: SuggestionAttributes) => string;
+    /**
+     * A render function for the autocomplete dropdown.
+     */
+    dropdownRenderFn?: CoreSuggestionOptions<SuggestionItemType>['render'];
+    /**
+     * The event handler that is fired when the search string has changed.
+     */
+    onSearchChange?: (query: string, storage: SuggestionStorage<SuggestionItemType>) => SuggestionItemType[] | Promise<SuggestionItemType[]>;
+    /**
+     * The event handler that is fired when a suggestion item is selected.
+     */
+    onItemSelect?: (item: SuggestionItemType) => void;
+};
+/**
+ * The storage holding the suggestion items original array, and a collection indexed by the item id.
+ */
+declare type SuggestionStorage<SuggestionItemType> = Readonly<{
+    /**
+     * The original array of suggestion items.
+     */
+    items: SuggestionItemType[];
+    /**
+     * A collection of suggestion items indexed by the item id.
+     */
+    itemsById: {
+        readonly [id: number]: SuggestionItemType | undefined;
+    };
+}>;
+/**
+ * The return type for a suggestion extension created by the factory function.
+ */
+declare type SuggestionExtensionResult<SuggestionItemType> = Node<SuggestionOptions<SuggestionItemType>>;
+/**
+ * A factory function responsible for creating different types of suggestion extensions with
+ * flexibility and customizability in mind.
+ *
+ * Extensions created by this factory function render editor nodes with internal `data-id` and
+ * `data-label` attributes (as a way to save and restore the editor nodes data) based on properties
+ * of the same name (minus the `data-` prefix) from the source item type. However, in the event of
+ * unmatched properties between the internal attributes and the source item type, you should
+ * specify the source item type, and use the optional `attributesMapping` option to map the
+ * source properties to the internal `data-id` and `data-label` attributes.
+ *
+ * @param type A unique identifier for the suggestion extension type.
+ * @param attributesMapping An object to map the `data-id` and `data-label` attributes with the
+ * source item type properties.
+ *
+ * @returns A new suggestion extension tailored to a specific use case.
+ */
+declare function createSuggestionExtension<SuggestionItemType extends {
+    [id: string]: unknown;
+} = SuggestionAttributes>(type: string, items?: SuggestionItemType[], ...attributesMapping: SuggestionItemType extends SuggestionAttributes ? [] : [
+    RequireAtLeastOne<{
+        id: ConditionalKeys<SuggestionItemType, number>;
+        label: ConditionalKeys<SuggestionItemType, string>;
+    }>
+]): SuggestionExtensionResult<SuggestionItemType>;
+export { createSuggestionExtension };
+export type { SuggestionExtensionResult, SuggestionOptions, SuggestionRendererProps, SuggestionRendererRef, SuggestionStorage, };
+//# sourceMappingURL=create-suggestion-extension.d.ts.map

package/dist/factories/create-suggestion-extension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-suggestion-extension.d.ts","sourceRoot":"","sources":["../../src/factories/create-suggestion-extension.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,IAAI,EAAE,MAAM,cAAc,CAAA;AAOpD,OAAO,KAAK,EACR,sBAAsB,IAAI,0BAA0B,EACpD,iBAAiB,IAAI,qBAAqB,EAC7C,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEnE;;GAEG;AACH,aAAK,oBAAoB,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;GAEG;AACH,aAAK,uBAAuB,CAAC,kBAAkB,IAAI;IAC/C;;OAEG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAA;IAE3C;;OAEG;IACH,KAAK,EAAE,kBAAkB,EAAE,CAAA;CAC9B,CAAA;AAED;;;GAGG;AACH,aAAK,qBAAqB,GAAG;IACzB,SAAS,EAAE,CAAC,KAAK,EAAE,0BAA0B,KAAK,OAAO,CAAA;CAC5D,CAAA;AAED;;GAEG;AACH,aAAK,iBAAiB,CAAC,kBAAkB,IAAI;IACzC;;OAEG;IACH,WAAW,EAAE,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;IAE5B;;OAEG;IACH,WAAW,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEjD;;OAEG;IACH,eAAe,EAAE,qBAAqB,CAAC,iBAAiB,CAAC,CAAA;IAEzD;;OAEG;IACH,WAAW,EAAE,qBAAqB,CAAC,aAAa,CAAC,CAAA;IAEjD;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,MAAM,CAAA;IAEzD;;OAEG;IACH,gBAAgB,CAAC,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAA;IAEtE;;OAEG;IACH,cAAc,CAAC,EAAE,CACb,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,KAC7C,kBAAkB,EAAE,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAA;IAEzD;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,kBAAkB,KAAK,IAAI,CAAA;CACpD,CAAA;AAED;;GAEG;AACH,aAAK,iBAAiB,CAAC,kBAAkB,IAAI,QAAQ,CAAC;IAClD;;OAEG;IACH,KAAK,EAAE,kBAAkB,EAAE,CAAA;IAE3B;;OAEG;IACH,SAAS,EAAE;QAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAAA;KAAE,CAAA;CACvE,CAAC,CAAA;AAEF;;GAEG;AACH,aAAK,yBAAyB,CAAC,kBAAkB,IAAI,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,CAAC,CAAA;AAEhG;;;;;;;;;;;;;;;;GAgBG;AACH,iBAAS,yBAAyB,CAC9B,kBAAkB,SAAS;IAAE,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,GAAG,oBAAoB,EAE3E,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,kBAAkB,EAAO,EAKhC,GAAG,iBAAiB,EAAE,kBAAkB,SAAS,oBAAoB,GAC/D,EAAE,GACF;IACI,iBAAiB,CAAC;QACd,EAAE,EAAE,eAAe,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;QAC/C,KAAK,EAAE,eAAe,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAA;KACrD,CAAC;CACL,GACR,yBAAyB,CAAC,kBAAkB,CAAC,CAuJ/C;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAA;AAEpC,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GACpB,CAAA"}

package/dist/factories/create-suggestion-extension.js

@@ -0,0 +1,149 @@
+import { mergeAttributes, Node } from '@tiptap/core';
+import { Suggestion as TiptapSuggestion } from '@tiptap/suggestion';
+import { camelCase, kebabCase } from 'lodash-es';
+import { PluginKey } from 'prosemirror-state';
+import { SUGGESTION_EXTENSION_PRIORITY } from '../constants/extension-priorities';
+/**
+ * A factory function responsible for creating different types of suggestion extensions with
+ * flexibility and customizability in mind.
+ *
+ * Extensions created by this factory function render editor nodes with internal `data-id` and
+ * `data-label` attributes (as a way to save and restore the editor nodes data) based on properties
+ * of the same name (minus the `data-` prefix) from the source item type. However, in the event of
+ * unmatched properties between the internal attributes and the source item type, you should
+ * specify the source item type, and use the optional `attributesMapping` option to map the
+ * source properties to the internal `data-id` and `data-label` attributes.
+ *
+ * @param type A unique identifier for the suggestion extension type.
+ * @param attributesMapping An object to map the `data-id` and `data-label` attributes with the
+ * source item type properties.
+ *
+ * @returns A new suggestion extension tailored to a specific use case.
+ */
+function createSuggestionExtension(type, items = [], 
+// This type makes sure that if a generic type variable is specified, the `attributesMapping`
+// is also defined (and vice versa) along with making sure that at least one attribute is
+// specified, and that all constraints are satisfied.
+...attributesMapping) {
+    // Normalize the node type and add the `Suggestion` suffix so that it can be easily identified
+    // when parsing the editor schema programatically (useful for Markdown/HTML serialization)
+    const nodeType = `${camelCase(type)}Suggestion`;
+    // Normalize the node type to kebab-case to be used as a `data-*` HTML attribute
+    const attributeType = kebabCase(type);
+    // Get the specified attributes, if available, or use the defaults
+    const idAttribute = String(attributesMapping[0]?.id ?? 'id');
+    const labelAttribute = String(attributesMapping[0]?.label ?? 'label');
+    // Create a personalized suggestion extension
+    return Node.create({
+        name: nodeType,
+        priority: SUGGESTION_EXTENSION_PRIORITY,
+        inline: true,
+        group: 'inline',
+        selectable: false,
+        atom: true,
+        addOptions() {
+            return {
+                triggerChar: '@',
+                // Disable option by default until the following Tiptap issue is fixed:
+                // https://github.com/ueberdosis/tiptap/issues/2159
+                allowSpaces: false,
+                allowedPrefixes: [' '],
+                startOfLine: false,
+            };
+        },
+        addStorage() {
+            return {
+                items,
+                itemsById: items.reduce((acc, item) => ({ ...acc, [String(item[idAttribute])]: item }), {}),
+            };
+        },
+        addAttributes() {
+            return {
+                [idAttribute]: {
+                    default: null,
+                    parseHTML: (element) => element.getAttribute('data-id'),
+                    renderHTML: (attributes) => ({
+                        'data-id': Number(attributes[idAttribute]),
+                    }),
+                },
+                [labelAttribute]: {
+                    default: null,
+                    parseHTML: (element) => {
+                        const id = Number(element.getAttribute('data-id'));
+                        const item = this.storage.itemsById[id];
+                        // Read the latest item label from the storage, if available, otherwise
+                        // fallback to the item label in the `data-label` attribute
+                        return String(item?.[labelAttribute] ?? element.getAttribute('data-label'));
+                    },
+                    renderHTML: (attributes) => ({
+                        'data-label': String(attributes[labelAttribute]),
+                    }),
+                },
+            };
+        },
+        parseHTML() {
+            return [{ tag: `span[data-${attributeType}]` }];
+        },
+        renderHTML({ node, HTMLAttributes }) {
+            return [
+                'span',
+                mergeAttributes({
+                    [`data-${attributeType}`]: '',
+                    'aria-label': this.options.renderAriaLabel?.({
+                        id: Number(node.attrs[idAttribute]),
+                        label: String(node.attrs[labelAttribute]),
+                    }),
+                }, HTMLAttributes),
+                `${String(this.options.triggerChar)}${String(node.attrs[labelAttribute])}`,
+            ];
+        },
+        renderText({ node }) {
+            return `${String(this.options.triggerChar)}${String(node.attrs[labelAttribute])}`;
+        },
+        addProseMirrorPlugins() {
+            const { triggerChar, allowSpaces, allowedPrefixes, startOfLine, onSearchChange, onItemSelect, dropdownRenderFn, } = this.options;
+            return [
+                TiptapSuggestion({
+                    pluginKey: new PluginKey(nodeType),
+                    editor: this.editor,
+                    char: triggerChar,
+                    allowedPrefixes,
+                    allowSpaces,
+                    startOfLine,
+                    items({ query, editor }) {
+                        return (onSearchChange?.(query, editor.storage[nodeType]) || []);
+                    },
+                    allow({ editor, range }) {
+                        return editor.can().insertContentAt(range, {
+                            type: nodeType,
+                        });
+                    },
+                    command({ editor, range, props }) {
+                        const nodeAfter = editor.view.state.selection.$to.nodeAfter;
+                        const overrideSpace = nodeAfter?.text?.startsWith(' ');
+                        if (overrideSpace) {
+                            range.to += 1;
+                        }
+                        editor
+                            .chain()
+                            .focus()
+                            .insertContentAt(range, [
+                            {
+                                type: nodeType,
+                                attrs: props,
+                            },
+                            {
+                                type: 'text',
+                                text: ' ',
+                            },
+                        ])
+                            .run();
+                        onItemSelect?.(props);
+                    },
+                    render: dropdownRenderFn,
+                }),
+            ];
+        },
+    });
+}
+export { createSuggestionExtension };

package/dist/helpers/dom.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Parse a given HTML string and returns the `HTMLElement` for the document body.
+ *
+ * @param html The HTML string to parse.
+ */
+declare function parseHtmlToElement(html: string): HTMLElement;
+export { parseHtmlToElement };
+//# sourceMappingURL=dom.d.ts.map

package/dist/helpers/dom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dom.d.ts","sourceRoot":"","sources":["../../src/helpers/dom.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,iBAAS,kBAAkB,CAAC,IAAI,EAAE,MAAM,eAEvC;AAED,OAAO,EAAE,kBAAkB,EAAE,CAAA"}

package/dist/helpers/dom.js

@@ -0,0 +1,9 @@
+/**
+ * Parse a given HTML string and returns the `HTMLElement` for the document body.
+ *
+ * @param html The HTML string to parse.
+ */
+function parseHtmlToElement(html) {
+    return new DOMParser().parseFromString(html, 'text/html').body;
+}
+export { parseHtmlToElement };

package/dist/helpers/schema.d.ts

@@ -0,0 +1,19 @@
+import type { Schema } from 'prosemirror-model';
+/**
+ * Check if the document schema accepts multiple lines of input.
+ *
+ * @param schema The current editor document schema.
+ *
+ * @returns True if the schema accepts multiple lines of input, false otherwise.
+ */
+declare function isMultilineDocument(schema: Schema): boolean;
+/**
+ * Check if a document schema contains a plain-text document top node.
+ *
+ * @param schema The current editor document schema.
+ *
+ * @returns True if the schema contains a plain-text document, false otherwise.
+ */
+declare function isPlainTextDocument(schema: Schema): boolean;
+export { isMultilineDocument, isPlainTextDocument };
+//# sourceMappingURL=schema.d.ts.map

package/dist/helpers/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/helpers/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;;;;;GAMG;AACH,iBAAS,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED;;;;;;GAMG;AACH,iBAAS,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAEpD;AAED,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAA"}

package/dist/helpers/schema.js

@@ -0,0 +1,21 @@
+/**
+ * Check if the document schema accepts multiple lines of input.
+ *
+ * @param schema The current editor document schema.
+ *
+ * @returns True if the schema accepts multiple lines of input, false otherwise.
+ */
+function isMultilineDocument(schema) {
+    return /(?:\+|\*)$/.test(schema.topNodeType.spec.content || '');
+}
+/**
+ * Check if a document schema contains a plain-text document top node.
+ *
+ * @param schema The current editor document schema.
+ *
+ * @returns True if the schema contains a plain-text document, false otherwise.
+ */
+function isPlainTextDocument(schema) {
+    return Boolean(schema.topNodeType.spec.content?.startsWith('paragraph'));
+}
+export { isMultilineDocument, isPlainTextDocument };

package/dist/helpers/serializer.d.ts

@@ -0,0 +1,11 @@
+import type { ParseRule } from 'prosemirror-model';
+/**
+ * Extract all tags from the given parse rules argument, and returns an array of said tags.
+ *
+ * @param parseRules The parse rules for a DOM node or inline style.
+ *
+ * @returns An array of tags extracted from the parse rules.
+ */
+declare function extractTagsFromParseRules(parseRules?: readonly ParseRule[]): (keyof HTMLElementTagNameMap)[];
+export { extractTagsFromParseRules };
+//# sourceMappingURL=serializer.d.ts.map

package/dist/helpers/serializer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serializer.d.ts","sourceRoot":"","sources":["../../src/helpers/serializer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAElD;;;;;;GAMG;AACH,iBAAS,yBAAyB,CAC9B,UAAU,CAAC,EAAE,SAAS,SAAS,EAAE,GAClC,CAAC,MAAM,qBAAqB,CAAC,EAAE,CAQjC;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAA"}

package/dist/helpers/serializer.js

@@ -0,0 +1,16 @@
+/**
+ * Extract all tags from the given parse rules argument, and returns an array of said tags.
+ *
+ * @param parseRules The parse rules for a DOM node or inline style.
+ *
+ * @returns An array of tags extracted from the parse rules.
+ */
+function extractTagsFromParseRules(parseRules) {
+    if (!parseRules || parseRules.length === 0) {
+        return [];
+    }
+    return parseRules
+        .filter((rule) => rule.tag)
+        .map((rule) => rule.tag);
+}
+export { extractTagsFromParseRules };

package/dist/hooks/use-editor.d.ts

@@ -0,0 +1,19 @@
+import { DependencyList } from 'react';
+import { Editor } from '@tiptap/react';
+import type { EditorOptions } from '@tiptap/core';
+/**
+ * This is a fork of the official `useEditor` hook with one key difference, which is to prevent a
+ * `null` Editor object instance from being returned on the first render.
+ *
+ * This change was once fixed in the `@tiptap/react` package, but was reverted because it didn't
+ * have support for server-side rendering ([ref](https://github.com/ueberdosis/tiptap/pull/2282)),
+ * which is a problem we don't currently have.
+ *
+ * @param options The options to configure the editor component with.
+ * @param dependencies If present, re-create the editor instance if the values in the list change.
+ *
+ * @returns A new editor instance with the given options.
+ */
+declare function useEditor(options?: Partial<EditorOptions>, dependencies?: DependencyList): Editor;
+export { useEditor };
+//# sourceMappingURL=use-editor.d.ts.map

package/dist/hooks/use-editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-editor.d.ts","sourceRoot":"","sources":["../../src/hooks/use-editor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAuB,MAAM,OAAO,CAAA;AAG3D,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAEtC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AAEjD;;;;;;;;;;;;GAYG;AACH,iBAAS,SAAS,CACd,OAAO,GAAE,OAAO,CAAC,aAAa,CAAM,EACpC,YAAY,GAAE,cAAmB,GAClC,MAAM,CAmCR;AAED,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/hooks/use-editor.js

@@ -0,0 +1,46 @@
+import { useEffect, useState } from 'react';
+import { useRerender } from '@react-hookz/web';
+import { Editor } from '@tiptap/react';
+/**
+ * This is a fork of the official `useEditor` hook with one key difference, which is to prevent a
+ * `null` Editor object instance from being returned on the first render.
+ *
+ * This change was once fixed in the `@tiptap/react` package, but was reverted because it didn't
+ * have support for server-side rendering ([ref](https://github.com/ueberdosis/tiptap/pull/2282)),
+ * which is a problem we don't currently have.
+ *
+ * @param options The options to configure the editor component with.
+ * @param dependencies If present, re-create the editor instance if the values in the list change.
+ *
+ * @returns A new editor instance with the given options.
+ */
+function useEditor(options = {}, dependencies = []) {
+    const [editor, setEditor] = useState(() => new Editor(options));
+    const forceRerender = useRerender();
+    useEffect(function initializeEditorInstance() {
+        let instance;
+        if (editor.isDestroyed) {
+            instance = new Editor(options);
+            setEditor(instance);
+        }
+        else {
+            instance = editor;
+        }
+        instance.on('transaction', () => {
+            requestAnimationFrame(() => {
+                requestAnimationFrame(() => {
+                    if (!instance.isDestroyed) {
+                        forceRerender();
+                    }
+                });
+            });
+        });
+        return function destroyEditorInstance() {
+            instance.destroy();
+        };
+    }, 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    dependencies);
+    return editor;
+}
+export { useEditor };

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+export type { BeforeCreateProps, BlurProps, CreateProps, DestroyProps, FocusProps, SelectionUpdateProps, TransacationProps, TypistEditorProps, TypistEditorRef, UpdateProps, } from './components/typist-editor';
+export { TypistEditor } from './components/typist-editor';
+export { SUGGESTION_EXTENSION_PRIORITY } from './constants/extension-priorities';
+export * from './extensions/core/extra-editor-commands/commands/extend-word-range';
+export * from './extensions/core/extra-editor-commands/commands/insert-markdown-content';
+export { PlainTextKit } from './extensions/plain-text/plain-text-kit';
+export type { RichTextImageAttributes, RichTextImageOptions, } from './extensions/rich-text/rich-text-image';
+export { RichTextKit } from './extensions/rich-text/rich-text-kit';
+export type { SuggestionExtensionResult, SuggestionOptions, SuggestionRendererProps, SuggestionRendererRef, SuggestionStorage, } from './factories/create-suggestion-extension';
+export { createSuggestionExtension } from './factories/create-suggestion-extension';
+export { isMultilineDocument, isPlainTextDocument } from './helpers/schema';
+export { createHTMLSerializer } from './serializers/html/html';
+export { createMarkdownSerializer } from './serializers/markdown/markdown';
+export type { AnyConfig, Editor as CoreEditor, EditorEvents, MarkRange, Range } from '@tiptap/core';
+export { combineTransactionSteps, defaultBlockAt, findChildren, findChildrenInRange, findParentNode, findParentNodeClosestToPos, generateHTML, generateJSON, generateText, getAttributes, getChangedRanges, getDebugJSON, getExtensionField, getHTMLFromFragment, getMarkAttributes, getMarkRange, getMarksBetween, getMarkType, getNodeAttributes, getNodeType, getSchema, getText, getTextBetween, isActive, isList, isMarkActive, isNodeActive, isNodeEmpty, isNodeSelection, isTextSelection, mergeAttributes, posToDOMRect, } from '@tiptap/core';
+export { Extension, Mark } from '@tiptap/core';
+export * from '@tiptap/extension-character-count';
+export type { Editor, NodeViewProps, ReactRendererOptions } from '@tiptap/react';
+export { NodeViewWrapper, ReactRenderer } from '@tiptap/react';
+export type { SuggestionKeyDownProps, SuggestionOptions as TiptapSuggestionOptions, } from '@tiptap/suggestion';
+export { Suggestion } from '@tiptap/suggestion';
+export { DOMParser, Fragment, Node as ProseMirrorNode } from 'prosemirror-model';
+export type { Selection, Transaction } from 'prosemirror-state';
+export { EditorState, Plugin, PluginKey } from 'prosemirror-state';
+export type { EditorView } from 'prosemirror-view';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,EAAE,6BAA6B,EAAE,MAAM,kCAAkC,CAAA;AAChF,cAAc,oEAAoE,CAAA;AAClF,cAAc,0EAA0E,CAAA;AACxF,OAAO,EAAE,YAAY,EAAE,MAAM,wCAAwC,CAAA;AACrE,YAAY,EACR,uBAAuB,EACvB,oBAAoB,GACvB,MAAM,wCAAwC,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,sCAAsC,CAAA;AAClE,YAAY,EACR,yBAAyB,EACzB,iBAAiB,EACjB,uBAAuB,EACvB,qBAAqB,EACrB,iBAAiB,GACpB,MAAM,yCAAyC,CAAA;AAChD,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAA;AACnF,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAA;AAC3E,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAA;AAC1E,YAAY,EAAE,SAAS,EAAE,MAAM,IAAI,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,cAAc,CAAA;AACnG,OAAO,EACH,uBAAuB,EACvB,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,cAAc,EACd,0BAA0B,EAC1B,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,cAAc,EACd,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,eAAe,EACf,eAAe,EACf,eAAe,EACf,YAAY,GACf,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAC9C,cAAc,mCAAmC,CAAA;AACjD,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,eAAe,CAAA;AAChF,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC9D,YAAY,EACR,sBAAsB,EACtB,iBAAiB,IAAI,uBAAuB,GAC/C,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/C,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAChF,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC/D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA"}

package/dist/index.js

@@ -0,0 +1,17 @@
+export { TypistEditor } from './components/typist-editor';
+export { SUGGESTION_EXTENSION_PRIORITY } from './constants/extension-priorities';
+export * from './extensions/core/extra-editor-commands/commands/extend-word-range';
+export * from './extensions/core/extra-editor-commands/commands/insert-markdown-content';
+export { PlainTextKit } from './extensions/plain-text/plain-text-kit';
+export { RichTextKit } from './extensions/rich-text/rich-text-kit';
+export { createSuggestionExtension } from './factories/create-suggestion-extension';
+export { isMultilineDocument, isPlainTextDocument } from './helpers/schema';
+export { createHTMLSerializer } from './serializers/html/html';
+export { createMarkdownSerializer } from './serializers/markdown/markdown';
+export { combineTransactionSteps, defaultBlockAt, findChildren, findChildrenInRange, findParentNode, findParentNodeClosestToPos, generateHTML, generateJSON, generateText, getAttributes, getChangedRanges, getDebugJSON, getExtensionField, getHTMLFromFragment, getMarkAttributes, getMarkRange, getMarksBetween, getMarkType, getNodeAttributes, getNodeType, getSchema, getText, getTextBetween, isActive, isList, isMarkActive, isNodeActive, isNodeEmpty, isNodeSelection, isTextSelection, mergeAttributes, posToDOMRect, } from '@tiptap/core';
+export { Extension, Mark } from '@tiptap/core';
+export * from '@tiptap/extension-character-count';
+export { NodeViewWrapper, ReactRenderer } from '@tiptap/react';
+export { Suggestion } from '@tiptap/suggestion';
+export { DOMParser, Fragment, Node as ProseMirrorNode } from 'prosemirror-model';
+export { EditorState, Plugin, PluginKey } from 'prosemirror-state';

package/dist/serializers/html/extensions/checkbox.d.ts

@@ -0,0 +1,8 @@
+import { marked } from 'marked';
+/**
+ * A Marked extension which tweaks the `checkbox` renderer to prevent rendering of task lists with
+ * GitHub's Flavored Markdown syntax, which is unsupported by Tiptap.
+ */
+declare const checkbox: marked.MarkedExtension;
+export { checkbox };
+//# sourceMappingURL=checkbox.d.ts.map

package/dist/serializers/html/extensions/checkbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkbox.d.ts","sourceRoot":"","sources":["../../../../src/serializers/html/extensions/checkbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B;;;GAGG;AACH,QAAA,MAAM,QAAQ,EAAE,MAAM,CAAC,eAMtB,CAAA;AAED,OAAO,EAAE,QAAQ,EAAE,CAAA"}

package/dist/serializers/html/extensions/checkbox.js

@@ -0,0 +1,12 @@
+/**
+ * A Marked extension which tweaks the `checkbox` renderer to prevent rendering of task lists with
+ * GitHub's Flavored Markdown syntax, which is unsupported by Tiptap.
+ */
+const checkbox = {
+    renderer: {
+        checkbox(checked) {
+            return `[${checked ? 'x' : ' '}] `;
+        },
+    },
+};
+export { checkbox };

package/dist/serializers/html/extensions/code.d.ts

@@ -0,0 +1,9 @@
+import { marked } from 'marked';
+/**
+ * A Marked extension which tweaks the `code` renderer to remove the newline between the last code
+ * line and `</code></pre>`. Although that newline is part of the CommonMark spec, this custom rule
+ * is required to prevent Tiptap from rendering a blank line at the end of the code block.
+ */
+declare const code: marked.MarkedExtension;
+export { code };
+//# sourceMappingURL=code.d.ts.map

package/dist/serializers/html/extensions/code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code.d.ts","sourceRoot":"","sources":["../../../../src/serializers/html/extensions/code.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAO/B;;;;GAIG;AACH,QAAA,MAAM,IAAI,EAAE,MAAM,CAAC,eAQlB,CAAA;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}

package/dist/serializers/html/extensions/code.js

@@ -0,0 +1,20 @@
+import { marked } from 'marked';
+/**
+ * Initialize a new instance of the original renderer to be used by the extension.
+ */
+const markedRenderer = new marked.Renderer();
+/**
+ * A Marked extension which tweaks the `code` renderer to remove the newline between the last code
+ * line and `</code></pre>`. Although that newline is part of the CommonMark spec, this custom rule
+ * is required to prevent Tiptap from rendering a blank line at the end of the code block.
+ */
+const code = {
+    renderer: {
+        code(code, infostring, escaped) {
+            return markedRenderer.code
+                .apply(this, [code, infostring, escaped])
+                .replace(/\n(<\/code><\/pre>)$/m, '$1');
+        },
+    },
+};
+export { code };

package/dist/serializers/html/extensions/html.d.ts

@@ -0,0 +1,10 @@
+import { marked } from 'marked';
+/**
+ * A Marked extension which tweaks the `html` renderer to escape special characters (i.e. `&`, `<`,
+ * `>`, `"`, and `'`) for unsupported tokens. This custom rule is required because the escaping must
+ * be performed at the token level to avoid escaping the full input, which would result in unwanted
+ * escaped output (i.e. valid HTML would be escaped).
+ */
+declare const html: marked.MarkedExtension;
+export { html };
+//# sourceMappingURL=html.d.ts.map

package/dist/serializers/html/extensions/html.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../../../../src/serializers/html/extensions/html.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B;;;;;GAKG;AACH,QAAA,MAAM,IAAI,EAAE,MAAM,CAAC,eAMlB,CAAA;AAED,OAAO,EAAE,IAAI,EAAE,CAAA"}