@squiz/formatted-text-editor 1.21.1-alpha.9 → 1.22.1-alpha.0

package/src/Extensions/CommandsExtension/CommandsExtension.ts

@@ -0,0 +1,54 @@
+import { PlainExtension } from '@remirror/core';
+import { command, CommandFunction, FromToProps, getTextSelection, MarkType } from 'remirror';
+import { Attrs } from 'prosemirror-model';
+
+export class CommandsExtension extends PlainExtension {
+  get name(): string {
+    return 'squizCommands' as const;
+  }
+
+  /**
+   * Updates the attributes of a specific mark for the current selection.
+   * Optionally, if text is provided it will replace the current selection.
+   * The cursor will be place at the end of the selection after changes.
+   *
+   * @param {object} options
+   */
+  @command()
+  updateMark(options: {
+    mark: MarkType;
+    attrs?: Attrs;
+    text?: string;
+    removeMark?: boolean;
+    range: FromToProps;
+  }): CommandFunction {
+    return (props) => {
+      const { tr, dispatch, view } = props;
+      const { mark, attrs, text, removeMark, range } = options;
+
+      const selectedText = tr.doc.textBetween(range.from, range.to);
+
+      if (text !== undefined && text !== selectedText) {
+        // update the text in the editor if it was updated, update the range to cover the length of the new text.
+        tr.insertText(text, range.from, range.to);
+        range.to = range.from + text.length;
+      }
+
+      // apply the link, or remove it if no URL was provided.
+      if (removeMark) {
+        tr.removeMark(range.from, range.to, mark);
+      } else {
+        tr.addMark(range.from, range.to, mark.create(attrs));
+      }
+
+      // move the cursor to the end of the link and re-focus the editor.
+      tr.setSelection(getTextSelection({ from: range.to, to: range.to }, tr.doc));
+
+      // apply the transaction.
+      dispatch?.(tr);
+      view?.focus();
+
+      return true;
+    };
+  }
+}

package/src/Extensions/Extensions.ts

@@ -7,26 +7,49 @@ import {
   UnderlineExtension,
   HistoryExtension,
 } from 'remirror/extensions';
+import { Extension } from '@remirror/core';
 import { PreformattedExtension } from './PreformattedExtension/PreformattedExtension';
+import { AssetLinkExtension } from './LinkExtension/AssetLinkExtension';
 import { LinkExtension } from './LinkExtension/LinkExtension';
 import { ImageExtension } from './ImageExtension/ImageExtension';
-import { Extension } from '@remirror/core';
+import { CommandsExtension } from './CommandsExtension/CommandsExtension';
+import { EditorContextOptions } from '../Editor/EditorContext';
+import { AssetImageExtension } from './ImageExtension/AssetImageExtension';
+
+export enum NodeName {
+  Image = 'image',
+  AssetImage = 'assetImage',
+  Text = 'text',
+}
+
+export enum MarkName {
+  Link = 'link',
+  AssetLink = 'assetLink',
+}
 
-export const Extensions = (): Extension[] => [
-  new BoldExtension(),
-  new HeadingExtension(),
-  new ItalicExtension(),
-  new NodeFormattingExtension({ indents: [] }),
-  new ParagraphExtension(),
-  new PreformattedExtension(),
-  new UnderlineExtension(),
-  new HistoryExtension(),
-  new ImageExtension(),
-  new LinkExtension({
-    supportedTargets: [
-      // '_self' is the browser default and will be used when encountering a link with a
-      // different target is encountered.
-      '_blank',
-    ],
-  }),
-];
+export const createExtensions = (context: EditorContextOptions) => {
+  return (): Extension[] => {
+    return [
+      new CommandsExtension(),
+      new BoldExtension(),
+      new HeadingExtension(),
+      new ItalicExtension(),
+      new NodeFormattingExtension({ indents: [] }),
+      new ParagraphExtension(),
+      new PreformattedExtension(),
+      new UnderlineExtension(),
+      new HistoryExtension(),
+      new ImageExtension(),
+      new ImageExtension({ preferPastedTextContent: false }),
+      new AssetImageExtension({
+        matrixIdentifier: context.matrix.matrixIdentifier,
+        matrixDomain: context.matrix.matrixDomain,
+      }),
+      new LinkExtension(),
+      new AssetLinkExtension({
+        matrixIdentifier: context.matrix.matrixIdentifier,
+        matrixDomain: context.matrix.matrixDomain,
+      }),
+    ];
+  };
+};

package/src/Extensions/ImageExtension/AssetImageExtension.spec.ts

@@ -0,0 +1,76 @@
+import { renderWithEditor } from '../../../tests';
+
+describe('AssetImageExtension', () => {
+  it('Parses HTML content representing an asset image', async () => {
+    const { getJsonContent } = await renderWithEditor(null, {
+      content: `<img
+                  src="https://my-matrix.squiz.net/?a=this-is-actually-ignored"
+                  data-matrix-asset-id="123"
+                  data-matrix-identifier="matrix-api-identifier"
+                  data-matrix-domain="https://matrix-domain.squiz.net" />`,
+    });
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'assetImage',
+          attrs: {
+            matrixAssetId: '123',
+            matrixDomain: 'https://matrix-domain.squiz.net',
+            matrixIdentifier: 'matrix-api-identifier',
+          },
+        },
+      ],
+    });
+  });
+
+  it('Resolves to a regular image if HTML content is missing some of the expected attributes', async () => {
+    const { getJsonContent } = await renderWithEditor(null, {
+      content: '<img src="https://my-matrix.squiz.net/?a=123" data-matrix-asset-id="123" />',
+    });
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'image',
+          attrs: expect.objectContaining({
+            src: 'https://my-matrix.squiz.net/?a=123',
+          }),
+        },
+      ],
+    });
+  });
+
+  it('Outputs expected HTML', async () => {
+    const { getHtmlContent } = await renderWithEditor(null, {
+      content: {
+        type: 'paragraph',
+        content: [
+          {
+            type: 'assetImage',
+            attrs: {
+              matrixAssetId: '123',
+              matrixDomain: 'https://matrix-domain.squiz.net',
+              matrixIdentifier: 'matrix-api-identifier',
+            },
+          },
+        ],
+      },
+    });
+
+    expect(getHtmlContent()).toEqual(
+      '<img ' +
+        'src="https://matrix-domain.squiz.net/_nocache?a=123" ' +
+        'data-matrix-asset-id="123" ' +
+        'data-matrix-identifier="matrix-api-identifier" ' +
+        'data-matrix-domain="https://matrix-domain.squiz.net" ' +
+        'draggable="true">' +
+        '<img class="ProseMirror-separator" alt="">' +
+        '<br class="ProseMirror-trailingBreak">',
+    );
+  });
+});

package/src/Extensions/ImageExtension/AssetImageExtension.ts

@@ -0,0 +1,111 @@
+import {
+  ApplySchemaAttributes,
+  command,
+  extension,
+  ExtensionPriority,
+  ExtensionTag,
+  isElementDomNode,
+  NodeExtension,
+  NodeExtensionSpec,
+  NodeSpecOverride,
+  omitExtraAttributes,
+  CommandFunction,
+} from '@remirror/core';
+import { getTextSelection } from 'remirror';
+import { resolveMatrixAssetUrl } from '../../utils/resolveMatrixAssetUrl';
+import { NodeName } from '../Extensions';
+
+export type AssetImageOptions = {
+  matrixIdentifier?: string;
+  matrixDomain?: string;
+};
+
+export type AssetImageAttributes = {
+  matrixAssetId: string;
+  matrixIdentifier: string;
+  matrixDomain: string;
+};
+
+@extension<AssetImageOptions>({
+  defaultOptions: {
+    matrixIdentifier: '',
+    matrixDomain: '',
+  },
+  defaultPriority: ExtensionPriority.High,
+})
+export class AssetImageExtension extends NodeExtension<AssetImageOptions> {
+  get name() {
+    return NodeName.AssetImage as const;
+  }
+
+  createTags() {
+    return [ExtensionTag.InlineNode, ExtensionTag.Media];
+  }
+
+  createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): NodeExtensionSpec {
+    return {
+      inline: true,
+      draggable: true,
+      selectable: true,
+      ...override,
+      attrs: {
+        ...extra.defaults(),
+        matrixAssetId: {},
+        matrixIdentifier: { default: this.options.matrixIdentifier },
+        matrixDomain: { default: this.options.matrixDomain },
+      },
+      parseDOM: [
+        {
+          tag: 'img[data-matrix-asset-id]',
+          getAttrs: (node) => {
+            if (!isElementDomNode(node)) {
+              return false;
+            }
+
+            const matrixAssetId = node.getAttribute('data-matrix-asset-id');
+            const matrixIdentifier = node.getAttribute('data-matrix-identifier');
+            const matrixDomain = node.getAttribute('data-matrix-domain');
+
+            if (!matrixAssetId || !matrixIdentifier || !matrixDomain) {
+              return false;
+            }
+
+            return {
+              ...extra.parse(node),
+              matrixAssetId,
+              matrixIdentifier,
+              matrixDomain,
+            };
+          },
+        },
+      ],
+      toDOM: (node) => {
+        const { matrixAssetId, matrixIdentifier, matrixDomain, ...rest } = omitExtraAttributes(node.attrs, extra);
+
+        return [
+          'img',
+          {
+            ...extra.dom(node),
+            ...rest,
+            src: resolveMatrixAssetUrl(String(matrixAssetId), String(matrixDomain)),
+            'data-matrix-asset-id': matrixAssetId,
+            'data-matrix-identifier': matrixIdentifier,
+            'data-matrix-domain': matrixDomain,
+          },
+        ];
+      },
+    };
+  }
+
+  @command()
+  insertAssetImage(attrs: AssetImageAttributes): CommandFunction {
+    return ({ tr, dispatch }) => {
+      const { from, to } = getTextSelection(tr.selection, tr.doc);
+      const node = this.type.create(attrs);
+
+      dispatch?.(tr.replaceRangeWith(from, to, node));
+
+      return true;
+    };
+  }
+}

package/src/Extensions/ImageExtension/ImageExtension.ts

@@ -1,3 +1,19 @@
 import { ImageExtension as RemirrorImageExtension } from 'remirror/extensions';
+import { PasteRule } from 'prosemirror-paste-rules';
+import { ApplySchemaAttributes, NodeSpecOverride, NodeExtensionSpec } from '@remirror/core';
 
-export class ImageExtension extends RemirrorImageExtension {}
+export class ImageExtension extends RemirrorImageExtension {
+  createPasteRules(): PasteRule[] {
+    // override super behaviour of handling file uploads.
+    return [];
+  }
+
+  createNodeSpec(extra: ApplySchemaAttributes, override: NodeSpecOverride): NodeExtensionSpec {
+    const spec = super.createNodeSpec(extra, override);
+
+    return {
+      ...spec,
+      selectable: true,
+    };
+  }
+}

package/src/Extensions/LinkExtension/AssetLinkExtension.spec.ts

@@ -0,0 +1,104 @@
+import { renderWithEditor } from '../../../tests';
+
+describe('AssetLinkExtension', () => {
+  it('Parses HTML content representing an asset link', async () => {
+    const { getJsonContent } = await renderWithEditor(null, {
+      content: `<a href="https://my-matrix.squiz.net/?a=this-is-actually-ignored"
+                  target="_self"
+                  data-matrix-asset-id="123"
+                  data-matrix-identifier="matrix-api-identifier"
+                  data-matrix-domain="https://matrix-domain.squiz.net">
+                  Hello!
+                </a>`,
+    });
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'text',
+          text: 'Hello!',
+          marks: [
+            {
+              type: 'assetLink',
+              attrs: {
+                matrixAssetId: '123',
+                matrixDomain: 'https://matrix-domain.squiz.net',
+                matrixIdentifier: 'matrix-api-identifier',
+                target: '_self',
+              },
+            },
+          ],
+        },
+      ],
+    });
+  });
+
+  it('Resolves to a regular link if HTML content is missing some of the expected attributes', async () => {
+    const { getJsonContent } = await renderWithEditor(null, {
+      content: `<a href="https://my-matrix.squiz.net/?a=123"
+                  target="_self"
+                  data-matrix-asset-id="123">
+                  Hello!
+                </a>`,
+    });
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'text',
+          text: 'Hello!',
+          marks: [
+            {
+              type: 'link',
+              attrs: {
+                href: 'https://my-matrix.squiz.net/?a=123',
+                target: '_self',
+                title: null,
+              },
+            },
+          ],
+        },
+      ],
+    });
+  });
+
+  it('Outputs expected HTML', async () => {
+    const { getHtmlContent } = await renderWithEditor(null, {
+      content: {
+        type: 'paragraph',
+        content: [
+          {
+            type: 'text',
+            text: 'Hello!',
+            marks: [
+              {
+                type: 'assetLink',
+                attrs: {
+                  matrixAssetId: '123',
+                  matrixDomain: 'https://matrix-domain.squiz.net',
+                  matrixIdentifier: 'matrix-api-identifier',
+                  target: '_blank',
+                },
+              },
+            ],
+          },
+        ],
+      },
+    });
+
+    expect(getHtmlContent()).toEqual(
+      '<a rel="noopener noreferrer nofollow" ' +
+        'href="https://matrix-domain.squiz.net/_nocache?a=123" ' +
+        'target="_blank" ' +
+        'data-matrix-asset-id="123" ' +
+        'data-matrix-identifier="matrix-api-identifier" ' +
+        'data-matrix-domain="https://matrix-domain.squiz.net">' +
+        'Hello!' +
+        '</a>',
+    );
+  });
+});

package/src/Extensions/LinkExtension/AssetLinkExtension.ts

@@ -0,0 +1,128 @@
+import {
+  ApplySchemaAttributes,
+  ExtensionPriority,
+  FromToProps,
+  isElementDomNode,
+  MarkExtensionSpec,
+  MarkSpecOverride,
+} from 'remirror';
+import { command, CommandFunction, extension, MarkExtension, omitExtraAttributes, removeMark } from '@remirror/core';
+import { LinkTarget, validateTarget } from './common';
+import { CommandsExtension } from '../CommandsExtension/CommandsExtension';
+import { MarkName } from '../Extensions';
+import { resolveMatrixAssetUrl } from '../../utils/resolveMatrixAssetUrl';
+
+export type AssetLinkAttributes = {
+  matrixAssetId: string;
+  matrixIdentifier: string;
+  matrixDomain: string;
+  target: LinkTarget;
+};
+
+export type AssetLinkOptions = {
+  matrixIdentifier?: string;
+  matrixDomain?: string;
+  defaultTarget?: LinkTarget;
+  supportedTargets?: LinkTarget[];
+};
+
+export type UpdateAssetLinkProps = {
+  text: string;
+  attrs: Partial<AssetLinkAttributes>;
+  range: FromToProps;
+};
+
+@extension<AssetLinkOptions>({
+  defaultOptions: {
+    matrixIdentifier: '',
+    matrixDomain: '',
+    defaultTarget: LinkTarget.Self,
+    supportedTargets: [LinkTarget.Self, LinkTarget.Blank],
+  },
+  defaultPriority: ExtensionPriority.High,
+})
+export class AssetLinkExtension extends MarkExtension<AssetLinkOptions> {
+  get name(): string {
+    return MarkName.AssetLink;
+  }
+
+  createMarkSpec(extra: ApplySchemaAttributes, override: MarkSpecOverride): MarkExtensionSpec {
+    return {
+      inclusive: false,
+      excludes: MarkName.Link,
+      ...override,
+      attrs: {
+        ...extra.defaults(),
+        matrixAssetId: {},
+        matrixIdentifier: { default: this.options.matrixIdentifier },
+        matrixDomain: { default: this.options.matrixDomain },
+        target: { default: this.options.defaultTarget },
+      },
+      parseDOM: [
+        {
+          tag: 'a[data-matrix-asset-id]',
+          getAttrs: (node) => {
+            if (!isElementDomNode(node)) {
+              return false;
+            }
+
+            const matrixAssetId = node.getAttribute('data-matrix-asset-id');
+            const matrixIdentifier = node.getAttribute('data-matrix-identifier');
+            const matrixDomain = node.getAttribute('data-matrix-domain');
+
+            if (!matrixAssetId || !matrixIdentifier || !matrixDomain) {
+              return false;
+            }
+
+            return {
+              ...extra.parse(node),
+              matrixAssetId,
+              matrixIdentifier,
+              matrixDomain,
+              target: validateTarget(
+                node.getAttribute('target'),
+                this.options.supportedTargets,
+                this.options.defaultTarget,
+              ),
+            };
+          },
+        },
+      ],
+      toDOM: (node) => {
+        const { matrixAssetId, matrixIdentifier, matrixDomain, target, ...rest } = omitExtraAttributes(
+          node.attrs,
+          extra,
+        );
+        const rel = 'noopener noreferrer nofollow';
+        const attrs = {
+          ...extra.dom(node),
+          ...rest,
+          rel,
+          href: resolveMatrixAssetUrl(String(matrixAssetId), String(matrixDomain)),
+          target: validateTarget(target, this.options.supportedTargets, this.options.defaultTarget),
+          'data-matrix-asset-id': matrixAssetId,
+          'data-matrix-identifier': matrixIdentifier,
+          'data-matrix-domain': matrixDomain,
+        };
+
+        return ['a', attrs, 0];
+      },
+    };
+  }
+
+  @command()
+  updateAssetLink({ text, attrs, range }: UpdateAssetLinkProps): CommandFunction {
+    return this.store.getExtension(CommandsExtension).updateMark({
+      attrs,
+      text,
+      range,
+      mark: this.type,
+      removeMark: !attrs.matrixAssetId,
+    });
+  }
+
+  @command()
+  removeAssetLink(): CommandFunction {
+    return removeMark({ type: this.type });
+  }
+}

package/src/Extensions/LinkExtension/LinkExtension.spec.ts

@@ -0,0 +1,68 @@
+import { renderWithEditor } from '../../../tests';
+
+describe('AssetLinkExtension', () => {
+  it('Parses HTML content representing an asset link', async () => {
+    const { getJsonContent } = await renderWithEditor(null, {
+      content: `<a href="https://example.org/some-page"
+                  title="Link title"
+                  target="_blank"
+                  rel="this is ignored">
+                  Hello!
+                </a>`,
+    });
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'text',
+          text: 'Hello!',
+          marks: [
+            {
+              type: 'link',
+              attrs: {
+                href: 'https://example.org/some-page',
+                title: 'Link title',
+                target: '_blank',
+              },
+            },
+          ],
+        },
+      ],
+    });
+  });
+
+  it('Outputs expected HTML', async () => {
+    const { getHtmlContent } = await renderWithEditor(null, {
+      content: {
+        type: 'paragraph',
+        content: [
+          {
+            type: 'text',
+            text: 'Hello!',
+            marks: [
+              {
+                type: 'link',
+                attrs: {
+                  href: 'https://example.org/some-page',
+                  title: 'Link title',
+                  target: '_blank',
+                },
+              },
+            ],
+          },
+        ],
+      },
+    });
+
+    expect(getHtmlContent()).toEqual(
+      '<a href="https://example.org/some-page" ' +
+        'title="Link title" ' +
+        'rel="noopener noreferrer nofollow" ' +
+        'target="_blank">' +
+        'Hello!' +
+        '</a>',
+    );
+  });
+});