@doist/typist 1.1.2 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [1.2.0](https://github.com/Doist/typist/compare/v1.1.2...v1.2.0) (2023-03-17)
+
+### Features
+
+-   **serializers:** Add `get*` functions for reusable singular instances ([#88](https://github.com/Doist/typist/issues/88)) ([b2c77c3](https://github.com/Doist/typist/commit/b2c77c30b15cd3dd676fc01531ecbeb5a6f7b952))
+
 ## [1.1.2](https://github.com/Doist/typist/compare/v1.1.1...v1.1.2) (2023-03-06)
 
 ### Bug Fixes

package/dist/components/typist-editor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typist-editor.d.ts","sourceRoot":"","sources":["../../src/components/typist-editor.tsx"],"names":[],"mappings":";AAOA,OAAO,EAAqB,wBAAwB,EAAE,MAAM,wCAAwC,CAAA;AAMpG,OAAO,EAAE,2BAA2B,EAA2B,MAAM,wBAAwB,CAAA;AAE7F,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAClF,OAAO,KAAK,EAAU,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE1D;;;GAGG;AACH,KAAK,eAAe,GAAG;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,UAAU,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,MAAM,CAAA;IAEzB;;OAEG;IACH,2BAA2B,EAAE,CACzB,QAAQ,EAAE,MAAM,KACf,UAAU,CAAC,OAAO,2BAA2B,CAAC,CAAA;CACtD,CAAA;AAED;;GAEG;AACH,KAAK,iBAAiB,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AAErD;;GAEG;AACH,KAAK,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AAEzC;;GAEG;AACH,KAAK,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;AAEhF;;GAEG;AACH,KAAK,oBAAoB,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAA;AAE3D;;GAEG;AACH,KAAK,iBAAiB,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;AAEpD;;GAEG;AACH,KAAK,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;AAEvC;;GAEG;AACH,KAAK,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;AAErC;;GAEG;AACH,KAAK,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAA;AAE3C;;;GAGG;AACH,KAAK,iBAAiB,GAAG;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,SAAS,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,UAAU,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAEnD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAElD;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAA;IAErC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAA;IAEnC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAA;IAEzC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAA;IAE7D;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;IAEjD;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAA;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC,WAAW,CAAC,CAAA;CACpD,CAAA;AAED;;;GAGG;AACH,QAAA,MAAM,YAAY,+GAiNhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA;AAEvB,YAAY,EACR,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,CAAA"}
+{"version":3,"file":"typist-editor.d.ts","sourceRoot":"","sources":["../../src/components/typist-editor.tsx"],"names":[],"mappings":";AAOA,OAAO,EAAqB,wBAAwB,EAAE,MAAM,wCAAwC,CAAA;AAMpG,OAAO,EAAE,2BAA2B,EAA2B,MAAM,wBAAwB,CAAA;AAE7F,OAAO,KAAK,EAAE,MAAM,IAAI,UAAU,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAClF,OAAO,KAAK,EAAU,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAE1D;;;GAGG;AACH,KAAK,eAAe,GAAG;IACnB;;OAEG;IACH,SAAS,EAAE,MAAM,UAAU,CAAA;IAE3B;;OAEG;IACH,WAAW,EAAE,MAAM,MAAM,CAAA;IAEzB;;OAEG;IACH,2BAA2B,EAAE,CACzB,QAAQ,EAAE,MAAM,KACf,UAAU,CAAC,OAAO,2BAA2B,CAAC,CAAA;CACtD,CAAA;AAED;;GAEG;AACH,KAAK,iBAAiB,GAAG,YAAY,CAAC,cAAc,CAAC,CAAA;AAErD;;GAEG;AACH,KAAK,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;AAEzC;;GAEG;AACH,KAAK,WAAW,GAAG,YAAY,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;AAEhF;;GAEG;AACH,KAAK,oBAAoB,GAAG,YAAY,CAAC,iBAAiB,CAAC,CAAA;AAE3D;;GAEG;AACH,KAAK,iBAAiB,GAAG,YAAY,CAAC,aAAa,CAAC,CAAA;AAEpD;;GAEG;AACH,KAAK,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,CAAA;AAEvC;;GAEG;AACH,KAAK,SAAS,GAAG,YAAY,CAAC,MAAM,CAAC,CAAA;AAErC;;GAEG;AACH,KAAK,YAAY,GAAG,YAAY,CAAC,SAAS,CAAC,CAAA;AAE3C;;;GAGG;AACH,KAAK,iBAAiB,GAAG;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,gBAAgB,CAAC,EAAE,SAAS,CAAA;IAE5B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;;;OAIG;IACH,UAAU,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAEnD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAA;IAEvC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAEzD;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAElD;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAA;IAErC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAA;IAEnC;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,IAAI,CAAA;IAEzC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAA;IAE7D;;;;OAIG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,CAAA;IAEjD;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,iBAAiB,CAAC,CAAA;IAE3D;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC,CAAA;IAE7C;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,CAAC,WAAW,CAAC,CAAA;CACpD,CAAA;AAED;;;GAGG;AACH,QAAA,MAAM,YAAY,+GAgNhB,CAAA;AAEF,OAAO,EAAE,YAAY,EAAE,CAAA;AAEvB,YAAY,EACR,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,WAAW,GACd,CAAA"}

package/dist/components/typist-editor.js

@@ -7,8 +7,8 @@ import { ExtraEditorCommands } from '../extensions/core/extra-editor-commands/ex
 import { ViewEventHandlers } from '../extensions/core/view-event-handlers';
 import { isMultilineDocument, isPlainTextDocument } from '../helpers/schema';
 import { useEditor } from '../hooks/use-editor';
-import { createHTMLSerializer } from '../serializers/html/html';
-import { createMarkdownSerializer } from '../serializers/markdown/markdown';
+import { getHTMLSerializerInstance } from '../serializers/html/html';
+import { getMarkdownSerializerInstance } from '../serializers/markdown/markdown';
 import { getAllNodesAttributesByType, resolveContentSelection } from './typist-editor.helper';
 /**
  * The `TypistEditor` component represents a plain-text or a rich-text editing control, built on
@@ -17,7 +17,6 @@ import { getAllNodesAttributesByType, resolveContentSelection } from './typist-e
 const TypistEditor = forwardRef(function TypistEditor({ autoFocus, className, content = '', contentSelection, editable = true, extensions, placeholder, onBeforeCreate, onCreate, onUpdate, onSelectionUpdate, onTransaction, onFocus, onBlur, onDestroy, 'aria-describedby': ariaDescribedBy, 'aria-label': ariaLabel, 'aria-labelledby': ariaLabelledBy, onClick, onKeyDown, }, ref) {
     const allExtensions = useMemo(function initializeExtensions() {
         return [
-            // Custom core extensions
             ...(placeholder
                 ? [
                     Placeholder.configure({
@@ -39,10 +38,10 @@ const TypistEditor = forwardRef(function TypistEditor({ autoFocus, className, co
         return getSchema(allExtensions);
     }, [allExtensions]);
     const htmlSerializer = useMemo(function initializeHTMLSerializer() {
-        return createHTMLSerializer(schema);
+        return getHTMLSerializerInstance(schema);
     }, [schema]);
     const markdownSerializer = useMemo(function initializeMarkdownSerializer() {
-        return createMarkdownSerializer(schema);
+        return getMarkdownSerializerInstance(schema);
     }, [schema]);
     const htmlContent = useMemo(function generateHTMLContent() {
         return htmlSerializer.serialize(content);

package/dist/extensions/core/extra-editor-commands/commands/insert-markdown-content.js

@@ -1,6 +1,6 @@
 import { DOMParser } from 'prosemirror-model';
 import { parseHtmlToElement } from '../../../../helpers/dom';
-import { createHTMLSerializer } from '../../../../serializers/html/html';
+import { getHTMLSerializerInstance } from '../../../../serializers/html/html';
 /**
  * Inserts the provided Markdown as HTML into the editor.
  *
@@ -12,7 +12,7 @@ function insertMarkdownContent(markdown, parseOptions) {
         // Check if the transaction should be dispatched
         // ref: https://tiptap.dev/api/commands#dry-run-for-commands
         if (dispatch) {
-            const htmlContent = createHTMLSerializer(editor.schema).serialize(markdown);
+            const htmlContent = getHTMLSerializerInstance(editor.schema).serialize(markdown);
             // Inserts the HTML content into the editor while preserving the current selection
             tr.replaceSelection(DOMParser.fromSchema(editor.schema).parseSlice(parseHtmlToElement(htmlContent), parseOptions));
         }

package/dist/extensions/shared/copy-markdown-source.js

@@ -1,5 +1,5 @@
 import { Extension, getHTMLFromFragment } from '@tiptap/core';
-import { createMarkdownSerializer } from '../../serializers/markdown/markdown';
+import { getMarkdownSerializerInstance } from '../../serializers/markdown/markdown';
 /**
  * The `CopyMarkdownSource` extension adds the ability to copy the editor underlying Markdown
  * source, and write it to the system clipboard. This extension has full support for both the
@@ -18,7 +18,7 @@ const CopyMarkdownSource = Extension.create({
                 // Get a fragment of the editor's content based on the selection
                 const nodeSelection = editor.state.doc.cut(editor.state.selection.from, editor.state.selection.to);
                 // Serialize the selected content HTML to Markdown
-                const markdownContent = createMarkdownSerializer(editor.schema).serialize(getHTMLFromFragment(nodeSelection.content, editor.schema));
+                const markdownContent = getMarkdownSerializerInstance(editor.schema).serialize(getHTMLFromFragment(nodeSelection.content, editor.schema));
                 // Writes the selected Markdown content to the system clipboard
                 navigator?.clipboard
                     ?.writeText(markdownContent)

package/dist/helpers/schema.d.ts

@@ -15,5 +15,13 @@ declare function isMultilineDocument(schema: Schema): boolean;
  * @returns True if the schema contains a plain-text document, false otherwise.
  */
 declare function isPlainTextDocument(schema: Schema): boolean;
-export { isMultilineDocument, isPlainTextDocument };
+/**
+ * Computes a string ID that identifies a given editor schema which can be used for object mapping.
+ *
+ * @param schema The current editor document schema.
+ *
+ * @returns A string ID matching the editor schema.
+ */
+declare function computeSchemaId(schema: Schema): string;
+export { computeSchemaId, isMultilineDocument, isPlainTextDocument };
 //# sourceMappingURL=schema.d.ts.map

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

@@ -1 +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"}
+{"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;;;;;;GAMG;AACH,iBAAS,eAAe,CAAC,MAAM,EAAE,MAAM,UAEtC;AAED,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,CAAA"}

package/dist/helpers/schema.js

@@ -18,4 +18,14 @@ function isMultilineDocument(schema) {
 function isPlainTextDocument(schema) {
     return Boolean(schema.topNodeType.spec.content?.startsWith('paragraph'));
 }
-export { isMultilineDocument, isPlainTextDocument };
+/**
+ * Computes a string ID that identifies a given editor schema which can be used for object mapping.
+ *
+ * @param schema The current editor document schema.
+ *
+ * @returns A string ID matching the editor schema.
+ */
+function computeSchemaId(schema) {
+    return [...Object.keys(schema.marks), ...Object.keys(schema.nodes)].join();
+}
+export { computeSchemaId, isMultilineDocument, isPlainTextDocument };

package/dist/index.d.ts

@@ -9,8 +9,8 @@ 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 { createHTMLSerializer, getHTMLSerializerInstance } from './serializers/html/html';
+export { createMarkdownSerializer, getMarkdownSerializerInstance, } from './serializers/markdown/markdown';
 export { canInsertNodeAt } from './utilities/can-insert-node-at';
 export { canInsertSuggestion } from './utilities/can-insert-suggestion';
 export type { AnyConfig, Editor as CoreEditor, EditorEvents, MarkRange, Range } from '@tiptap/core';

package/dist/index.d.ts.map

@@ -1 +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,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AACvE,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,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC/E,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,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"}
+{"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,yBAAyB,EAAE,MAAM,yBAAyB,CAAA;AACzF,OAAO,EACH,wBAAwB,EACxB,6BAA6B,GAChC,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAA;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAA;AACvE,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,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,IAAI,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAC/E,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9D,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACjE,YAAY,EAAE,UAAU,EAAE,MAAM,iBAAiB,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"}

package/dist/index.js

@@ -6,8 +6,8 @@ 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 { createHTMLSerializer, getHTMLSerializerInstance } from './serializers/html/html';
+export { createMarkdownSerializer, getMarkdownSerializerInstance, } from './serializers/markdown/markdown';
 export { canInsertNodeAt } from './utilities/can-insert-node-at';
 export { canInsertSuggestion } from './utilities/can-insert-suggestion';
 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';

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

@@ -29,6 +29,14 @@ declare const INITIAL_MARKED_OPTIONS: marked.MarkedOptions;
  * @returns A normalized object for the HTML serializer.
  */
 declare function createHTMLSerializer(schema: Schema): HTMLSerializerReturnType;
-export { createHTMLSerializer, INITIAL_MARKED_OPTIONS };
+/**
+ * Returns a singleton instance of a HTML serializer based on the provided editor schema.
+ *
+ * @param schema The editor schema connected to the HTML serializer instance.
+ *
+ * @returns The HTML serializer instance for the given editor schema.
+ */
+declare function getHTMLSerializerInstance(schema: Schema): HTMLSerializerReturnType;
+export { createHTMLSerializer, getHTMLSerializerInstance, INITIAL_MARKED_OPTIONS };
 export type { HTMLSerializerReturnType };
 //# sourceMappingURL=html.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../../../src/serializers/html/html.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAc/B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;GAEG;AACH,KAAK,wBAAwB,GAAG;IAC5B;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;CAC1C,CAAA;AAED;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,EAAE,MAAM,CAAC,aAMpC,CAAA;AAmCD;;;;;;;;GAQG;AACH,iBAAS,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,wBAAwB,CAiDtE;AAED,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,CAAA;AAEvD,YAAY,EAAE,wBAAwB,EAAE,CAAA"}
+{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../../../src/serializers/html/html.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAc/B,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;GAEG;AACH,KAAK,wBAAwB,GAAG;IAC5B;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAA;CAC1C,CAAA;AASD;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,EAAE,MAAM,CAAC,aAMpC,CAAA;AAmCD;;;;;;;;GAQG;AACH,iBAAS,oBAAoB,CAAC,MAAM,EAAE,MAAM,GAAG,wBAAwB,CAiDtE;AAOD;;;;;;GAMG;AACH,iBAAS,yBAAyB,CAAC,MAAM,EAAE,MAAM,4BAQhD;AAED,OAAO,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,CAAA;AAElF,YAAY,EAAE,wBAAwB,EAAE,CAAA"}

package/dist/serializers/html/html.js

@@ -1,7 +1,7 @@
 import { escape, kebabCase } from 'lodash-es';
 import { marked } from 'marked';
 import { REGEX_LINE_BREAKS } from '../../constants/regular-expressions';
-import { isPlainTextDocument } from '../../helpers/schema';
+import { computeSchemaId, isPlainTextDocument } from '../../helpers/schema';
 import { buildSuggestionSchemaPartialRegex } from '../../helpers/serializer';
 import { checkbox } from './extensions/checkbox';
 import { code } from './extensions/code';
@@ -94,4 +94,22 @@ function createHTMLSerializer(schema) {
         },
     };
 }
-export { createHTMLSerializer, INITIAL_MARKED_OPTIONS };
+/**
+ * Object that holds multiple HTML serializer instances based on a given ID.
+ */
+const htmlSerializerInstanceById = {};
+/**
+ * Returns a singleton instance of a HTML serializer based on the provided editor schema.
+ *
+ * @param schema The editor schema connected to the HTML serializer instance.
+ *
+ * @returns The HTML serializer instance for the given editor schema.
+ */
+function getHTMLSerializerInstance(schema) {
+    const id = computeSchemaId(schema);
+    if (!htmlSerializerInstanceById[id]) {
+        htmlSerializerInstanceById[id] = createHTMLSerializer(schema);
+    }
+    return htmlSerializerInstanceById[id];
+}
+export { createHTMLSerializer, getHTMLSerializerInstance, INITIAL_MARKED_OPTIONS };

package/dist/serializers/markdown/markdown.d.ts

@@ -30,6 +30,14 @@ declare const BULLET_LIST_MARKER = "-";
  * @returns A normalized object for the Markdown serializer.
  */
 declare function createMarkdownSerializer(schema: Schema): MarkdownSerializerReturnType;
-export { BULLET_LIST_MARKER, createMarkdownSerializer };
+/**
+ * Returns a singleton instance of a Markdown serializer based on the provided editor schema.
+ *
+ * @param schema The editor schema connected to the Markdown serializer instance.
+ *
+ * @returns The Markdown serializer instance for the given editor schema.
+ */
+declare function getMarkdownSerializerInstance(schema: Schema): MarkdownSerializerReturnType;
+export { BULLET_LIST_MARKER, createMarkdownSerializer, getMarkdownSerializerInstance };
 export type { MarkdownSerializerReturnType };
 //# sourceMappingURL=markdown.d.ts.map

package/dist/serializers/markdown/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/serializers/markdown/markdown.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;GAEG;AACH,KAAK,4BAA4B,GAAG;IAChC;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC,CAAA;AAED;;GAEG;AACH,QAAA,MAAM,kBAAkB,MAAM,CAAA;AA8C9B;;;;;;;;;;;;GAYG;AACH,iBAAS,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,4BAA4B,CAiG9E;AAED,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,CAAA;AAEvD,YAAY,EAAE,4BAA4B,EAAE,CAAA"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/serializers/markdown/markdown.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE/C;;GAEG;AACH,KAAK,4BAA4B,GAAG;IAChC;;;;;;OAMG;IACH,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC,CAAA;AASD;;GAEG;AACH,QAAA,MAAM,kBAAkB,MAAM,CAAA;AA8C9B;;;;;;;;;;;;GAYG;AACH,iBAAS,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,4BAA4B,CAiG9E;AAOD;;;;;;GAMG;AACH,iBAAS,6BAA6B,CAAC,MAAM,EAAE,MAAM,gCAQpD;AAED,OAAO,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,6BAA6B,EAAE,CAAA;AAEtF,YAAY,EAAE,4BAA4B,EAAE,CAAA"}

package/dist/serializers/markdown/markdown.js

@@ -1,6 +1,6 @@
 import Turndown from 'turndown';
 import { REGEX_PUNCTUATION } from '../../constants/regular-expressions';
-import { isPlainTextDocument } from '../../helpers/schema';
+import { computeSchemaId, isPlainTextDocument } from '../../helpers/schema';
 import { image } from './plugins/image';
 import { listItem } from './plugins/list-item';
 import { paragraph } from './plugins/paragraph';
@@ -145,4 +145,22 @@ function createMarkdownSerializer(schema) {
         },
     };
 }
-export { BULLET_LIST_MARKER, createMarkdownSerializer };
+/**
+ * Object that holds multiple Markdown serializer instances based on a given ID.
+ */
+const markdownSerializerInstanceById = {};
+/**
+ * Returns a singleton instance of a Markdown serializer based on the provided editor schema.
+ *
+ * @param schema The editor schema connected to the Markdown serializer instance.
+ *
+ * @returns The Markdown serializer instance for the given editor schema.
+ */
+function getMarkdownSerializerInstance(schema) {
+    const id = computeSchemaId(schema);
+    if (!markdownSerializerInstanceById[id]) {
+        markdownSerializerInstanceById[id] = createMarkdownSerializer(schema);
+    }
+    return markdownSerializerInstanceById[id];
+}
+export { BULLET_LIST_MARKER, createMarkdownSerializer, getMarkdownSerializerInstance };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@doist/typist",
     "description": "The mighty Tiptap-based rich-text editor React component that powers Doist products.",
-    "version": "1.1.2",
+    "version": "1.2.0",
     "license": "MIT",
     "homepage": "https://typist.doist.dev/",
     "repository": "https://github.com/Doist/typist",
@@ -105,7 +105,7 @@
         "classnames": "2.3.2",
         "conventional-changelog-conventionalcommits": "5.0.0",
         "emoji-regex": "10.2.1",
-        "eslint": "8.35.0",
+        "eslint": "8.36.0",
         "eslint-formatter-codeframe": "7.32.1",
         "eslint-import-resolver-typescript": "3.5.3",
         "eslint-plugin-jest": "27.2.1",
@@ -115,12 +115,12 @@
         "husky": "8.0.3",
         "ignore-sync": "6.0.2",
         "is-ci": "3.0.1",
-        "jest": "29.4.3",
-        "jest-environment-jsdom": "29.4.3",
-        "lint-staged": "13.1.2",
+        "jest": "29.5.0",
+        "jest-environment-jsdom": "29.5.0",
+        "lint-staged": "13.2.0",
         "npm-run-all": "4.1.5",
         "prettier": "2.8.4",
-        "react-icons": "4.7.1",
+        "react-icons": "4.8.0",
         "react-markdown": "8.0.5",
         "react-syntax-highlighter": "15.5.0",
         "rehype-raw": "6.1.1",
@@ -132,7 +132,7 @@
         "ts-node": "10.9.1",
         "type-fest": "3.6.1",
         "typescript": "4.9.5",
-        "typescript-plugin-css-modules": "4.2.2"
+        "typescript-plugin-css-modules": "4.2.3"
     },
     "peerDependencies": {
         "@react-hookz/web": "^14.2.3 || >=15.x",