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

package/src/EditorToolbar/Tools/Link/Form/LinkForm.tsx

@@ -1,48 +1,118 @@
-import React, { ReactElement } from 'react';
+import React, { ReactElement, useContext } from 'react';
+import clsx from 'clsx';
+import { SubmitHandler, useForm } from 'react-hook-form';
+import { FromToProps } from 'remirror';
 import { Input } from '../../../../ui/Fields/Input/Input';
 import { Select, SelectOptions } from '../../../../ui/Fields/Select/Select';
-import { SubmitHandler, useForm } from 'react-hook-form';
-import { UpdateLinkOptions } from '../../../../Extensions/LinkExtension/LinkExtension';
+import { UpdateLinkProps } from '../../../../Extensions/LinkExtension/LinkExtension';
+import { UpdateAssetLinkProps } from '../../../../Extensions/LinkExtension/AssetLinkExtension';
+import { LinkTarget } from '../../../../Extensions/LinkExtension/common';
+import { EditorContext } from '../../../../Editor/EditorContext';
+import { MarkName } from '../../../../Extensions/Extensions';
+import { DeepPartial } from '../../../../types';
 
-export type LinkFormData = Pick<UpdateLinkOptions, 'href' | 'target' | 'title' | 'text'>;
+export type LinkFormData = {
+  linkType: MarkName;
+  text: string;
+  link: UpdateLinkProps['attrs'];
+  assetLink: UpdateAssetLinkProps['attrs'];
+  range: FromToProps;
+};
 
 export type FormProps = {
-  data: Partial<LinkFormData>;
+  data?: DeepPartial<LinkFormData>;
   onSubmit: SubmitHandler<LinkFormData>;
 };
 
-const selectOptions: SelectOptions = {
-  _self: { label: 'Current window' },
-  _blank: { label: 'New window' },
+const linkTypeOptions: SelectOptions = {
+  [MarkName.Link]: { label: 'Link to URL' },
+  [MarkName.AssetLink]: { label: 'Link to asset' },
 };
 
-const LinkForm = ({ data, onSubmit }: FormProps): ReactElement => {
-  const { register, handleSubmit, setValue } = useForm<LinkFormData>({
+const targetOptions: SelectOptions = {
+  [LinkTarget.Self]: { label: 'Current window' },
+  [LinkTarget.Blank]: { label: 'New window' },
+};
+
+export const LinkForm = ({ data, onSubmit }: FormProps): ReactElement => {
+  const context = useContext(EditorContext);
+  const {
+    register,
+    handleSubmit,
+    setValue,
+    watch,
+    formState: { errors },
+  } = useForm<LinkFormData>({
     defaultValues: data,
   });
+  const linkType = watch('linkType') || MarkName.Link;
 
   return (
     <form className="squiz-fte-form" onSubmit={handleSubmit(onSubmit)}>
       <div className="squiz-fte-form-group mb-2">
-        <Input label="URL" {...register('href')} />
-      </div>
-      <div className="squiz-fte-form-group mb-2">
-        <Input label="Text" {...register('text')} />
-      </div>
-      <div className="squiz-fte-form-group mb-2">
-        <Input label="Title" {...register('title')} />
-      </div>
-      <div className="squiz-fte-form-group mb-0">
         <Select
-          name="target"
-          label="Target"
-          value={data.target || '_self'}
-          options={selectOptions}
-          onChange={(value) => setValue('target', value)}
+          name="linkType"
+          label="Type"
+          value={linkType}
+          options={linkTypeOptions}
+          onChange={(value) => setValue('linkType', value as MarkName)}
         />
       </div>
+      {/* Arbitrary link form fields */}
+      {linkType === MarkName.Link && (
+        <>
+          <div className={clsx('squiz-fte-form-group mb-2')}>
+            <Input label="URL" {...register('link.href')} />
+          </div>
+          <div className={clsx('squiz-fte-form-group mb-2')}>
+            <Input label="Text" {...register('text')} />
+          </div>
+          <div className={clsx('squiz-fte-form-group mb-2')}>
+            <Input label="Title" {...register('link.title')} />
+          </div>
+          <div className={clsx('squiz-fte-form-group mb-0')}>
+            <Select
+              name="link.target"
+              label="Target"
+              value={data?.link?.target || '_self'}
+              options={targetOptions}
+              onChange={(value) => setValue('link.target', value as LinkTarget)}
+            />
+          </div>
+        </>
+      )}
+      {/* Asset link form fields */}
+      {linkType === MarkName.AssetLink && (
+        <>
+          <div className={clsx('squiz-fte-form-group mb-2')}>
+            <Input
+              label="Asset ID"
+              error={errors?.assetLink?.matrixAssetId?.message}
+              {...register('assetLink.matrixAssetId', {
+                validate: {
+                  isValidAsset: async (assetId: string | undefined) => {
+                    if (assetId && !(await context.matrix.resolveMatrixAsset(assetId))) {
+                      return 'Invalid asset ID';
+                    }
+                  },
+                },
+              })}
+            />
+          </div>
+          <div className={clsx('squiz-fte-form-group mb-2')}>
+            <Input label="Text" {...register('text')} />
+          </div>
+          <div className={clsx('squiz-fte-form-group mb-0')}>
+            <Select
+              name="assetLink.target"
+              label="Target"
+              value={data?.link?.target || '_self'}
+              options={targetOptions}
+              onChange={(value) => setValue('assetLink.target', value as LinkTarget)}
+            />
+          </div>
+        </>
+      )}
     </form>
   );
 };
-
-export default LinkForm;

package/src/EditorToolbar/Tools/Link/LinkButton.spec.tsx

@@ -37,7 +37,7 @@ describe('LinkButton', () => {
           marks: [
             {
               type: 'link',
-              attrs: { auto: false, href: 'https://www.squiz.net/link-button', target: '_blank', title: 'Link title' },
+              attrs: { href: 'https://www.squiz.net/link-button', target: '_blank', title: 'Link title' },
             },
           ],
         },
@@ -58,6 +58,27 @@ describe('LinkButton', () => {
     await openModal();
     fireEvent.change(screen.getByLabelText('URL'), { target: { value: 'https://www.example.org/updated-link' } });
     fireEvent.change(screen.getByLabelText('Text'), { target: { value: 'Updated sample link' } });
+
+    // verify the content matches what was initially set prior to applying.
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'text',
+          text: 'Sample link',
+          marks: [
+            {
+              type: 'link',
+              attrs: { href: 'https://www.example.org/my-link', target: '_self', title: null },
+            },
+          ],
+        },
+        { type: 'text', text: ' with some other content.' },
+      ],
+    });
+
+    // apply the changes.
     fireEvent.click(screen.getByRole('button', { name: 'Apply' }));
 
     await waitForElementToBeRemoved(() => screen.getByRole('button', { name: 'Apply' }));
@@ -75,7 +96,7 @@ describe('LinkButton', () => {
           marks: [
             {
               type: 'link',
-              attrs: { auto: false, href: 'https://www.example.org/updated-link', target: null, title: null },
+              attrs: { href: 'https://www.example.org/updated-link', target: '_self', title: null },
             },
           ],
         },
@@ -134,25 +155,7 @@ describe('LinkButton', () => {
     });
   });
 
-  it.each([
-    ['Link fully selected', 1, 12, 'Sample link'],
-    ['Link partially selected', 2, 4, 'Sample link'],
-    ['Link partially selected along with other content', 8, 15, 'Sample link wi'],
-  ])(
-    'Expands selection when a link is partially selected - %s',
-    async (description: string, from: number, to: number, expectedSelection: string) => {
-      const { editor, getSelectedText } = await renderWithEditor(<LinkButton />, {
-        content: '<a href="https://www.example.org/my-link">Sample link</a> <strong>with</strong> some other content.',
-      });
-
-      await act(() => editor.selectText({ from, to }));
-      await openModal();
-
-      expect(getSelectedText()).toBe(expectedSelection);
-    },
-  );
-
-  it('Updates full selection when it is expanded from what was initially selected', async () => {
+  it('Updates unselected part of link when link is partially selected', async () => {
     const { editor, getJsonContent } = await renderWithEditor(<LinkButton />, {
       content: '<a href="https://www.example.org/my-link">Sample link</a> <strong>with</strong> some other content.',
     });
@@ -179,7 +182,7 @@ describe('LinkButton', () => {
           marks: [
             {
               type: 'link',
-              attrs: { auto: false, href: 'https://www.example.org/my-link', target: null, title: null },
+              attrs: { href: 'https://www.example.org/my-link', target: '_self', title: null },
             },
           ],
         },
@@ -189,7 +192,7 @@ describe('LinkButton', () => {
           marks: [
             {
               type: 'link',
-              attrs: { auto: false, href: 'https://www.example.org/my-link', target: null, title: null },
+              attrs: { href: 'https://www.example.org/my-link', target: '_self', title: null },
             },
             { type: 'bold' },
           ],
@@ -200,7 +203,7 @@ describe('LinkButton', () => {
           marks: [
             {
               type: 'link',
-              attrs: { auto: false, href: 'https://www.example.org/my-link', target: null, title: null },
+              attrs: { href: 'https://www.example.org/my-link', target: '_self', title: null },
             },
           ],
         },
@@ -237,7 +240,7 @@ describe('LinkButton', () => {
           marks: [
             {
               type: 'link',
-              attrs: { auto: false, href: 'https://www.example.org/my-link', target: null, title: null },
+              attrs: { href: 'https://www.example.org/my-link', target: '_self', title: null },
             },
           ],
         },
@@ -252,7 +255,7 @@ describe('LinkButton', () => {
     });
 
     // jump to the middle of the link.
-    await act(() => editor.selectText(5));
+    await act(() => editor.selectText({ from: 1, to: 12 }));
 
     // press the keyboard shortcut.
     fireEvent.keyDown(elements.editor, { key: 'k', ctrlKey: true });
@@ -274,4 +277,112 @@ describe('LinkButton', () => {
     fireEvent.click(screen.getByRole('button', { name: 'Cancel' }));
     expect(modalHeading).not.toBeInTheDocument();
   });
+
+  it('Add a new asset link', async () => {
+    const matrixIdentifier = 'matrix-api-identifier';
+    const matrixDomain = 'https://my-matrix.squiz.net';
+    const { getJsonContent } = await renderWithEditor(<LinkButton />, {
+      context: {
+        matrix: {
+          matrixIdentifier,
+          matrixDomain,
+          resolveMatrixAsset: () => Promise.resolve({ id: '100', type: 'physical_file' }),
+        },
+      },
+    });
+
+    await openModal();
+    select(screen.getByLabelText('Type'), 'Link to asset');
+    fireEvent.change(screen.getByLabelText('Asset ID'), { target: { value: '123' } });
+    fireEvent.change(screen.getByLabelText('Text'), { target: { value: 'Link text' } });
+    fireEvent.click(screen.getByRole('button', { name: 'Apply' }));
+
+    await waitForElementToBeRemoved(() => screen.getByRole('button', { name: 'Apply' }));
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'text',
+          text: 'Link text',
+          marks: [
+            {
+              type: 'assetLink',
+              attrs: { matrixAssetId: '123', target: '_self', matrixDomain, matrixIdentifier },
+            },
+          ],
+        },
+      ],
+    });
+  });
+
+  it('Updates an existing link to be an asset link', async () => {
+    const matrixIdentifier = 'matrix-api-identifier';
+    const matrixDomain = 'https://my-matrix.squiz.net';
+    const { editor, getJsonContent } = await renderWithEditor(<LinkButton />, {
+      content:
+        '<a href="https://www.example.org/my-link">Sample link</a> with ' +
+        '<a href="https://www.example.org/another-link">another link</a>',
+      context: {
+        matrix: {
+          matrixIdentifier,
+          matrixDomain,
+          resolveMatrixAsset: () => Promise.resolve({ id: '100', type: 'physical_file' }),
+        },
+      },
+    });
+
+    await act(() => editor.selectText(5));
+
+    await openModal();
+    select(screen.getByLabelText('Type'), 'Link to asset');
+    fireEvent.change(screen.getByLabelText('Asset ID'), { target: { value: '123' } });
+    select(screen.getByLabelText('Target'), 'New window');
+    fireEvent.click(screen.getByRole('button', { name: 'Apply' }));
+
+    await waitForElementToBeRemoved(() => screen.getByRole('button', { name: 'Apply' }));
+
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [
+        {
+          type: 'text',
+          text: 'Sample link',
+          marks: [
+            {
+              type: 'assetLink',
+              attrs: { matrixAssetId: '123', target: '_blank', matrixDomain, matrixIdentifier },
+            },
+          ],
+        },
+        { type: 'text', text: ' with ' },
+        {
+          type: 'text',
+          text: 'another link',
+          marks: [
+            {
+              type: 'link',
+              attrs: { href: 'https://www.example.org/another-link', target: '_self', title: null },
+            },
+          ],
+        },
+      ],
+    });
+  });
+
+  it('Shows an error if an invalid asset ID is provided', async () => {
+    const resolveMatrixAsset = jest.fn(() => Promise.resolve(null));
+
+    await renderWithEditor(<LinkButton />, { context: { matrix: { resolveMatrixAsset } } });
+
+    await openModal();
+    select(screen.getByLabelText('Type'), 'Link to asset');
+    fireEvent.change(screen.getByLabelText('Asset ID'), { target: { value: 'invalid-asset-id' } });
+    await act(() => fireEvent.click(screen.getByRole('button', { name: 'Apply' })));
+
+    expect(screen.getByText('Invalid asset ID')).toBeInTheDocument();
+    expect(resolveMatrixAsset).toHaveBeenCalledWith('invalid-asset-id');
+  });
 });

package/src/EditorToolbar/Tools/Link/LinkButton.tsx

@@ -3,8 +3,12 @@ import InsertLinkRoundedIcon from '@mui/icons-material/InsertLinkRounded';
 import LinkModal from './LinkModal';
 import { LinkFormData } from './Form/LinkForm';
 import Button from '../../../ui/Button/Button';
-import { useActive, useCommands, useExtensionEvent } from '@remirror/react';
+import { useActive, useCommands, useKeymap } from '@remirror/react';
 import { LinkExtension } from '../../../Extensions/LinkExtension/LinkExtension';
+import { CommandsExtension } from '../../../Extensions/CommandsExtension/CommandsExtension';
+import { AssetLinkExtension } from '../../../Extensions/LinkExtension/AssetLinkExtension';
+import { MarkName } from '../../../Extensions/Extensions';
+import { ImageExtension } from '../../../Extensions/ImageExtension/ImageExtension';
 
 type LinkButtonProps = {
   inPopover?: boolean;
@@ -12,41 +16,46 @@ type LinkButtonProps = {
 
 const LinkButton = ({ inPopover = false }: LinkButtonProps) => {
   const [showModal, setShowModal] = useState(false);
-  const { selectLink, updateLink } = useCommands<LinkExtension>();
-  const active = useActive<LinkExtension>();
+  const { updateLink, updateAssetLink } = useCommands<AssetLinkExtension | LinkExtension | CommandsExtension>();
+  const active = useActive<LinkExtension | AssetLinkExtension | ImageExtension>();
+  // If the image tool is active, disable the link tool as they shouldn't work at the same time
+  const disabled = active.image();
   const handleClick = () => {
     if (!showModal) {
-      selectLink();
-
-      // form element are uncontrolled, let the event loop run to
-      // update the selected text in state before showing the modal.
-      requestAnimationFrame(() => {
-        setShowModal(true);
-      });
+      setShowModal(true);
     }
   };
+  const handleShortcut = useCallback(() => {
+    handleClick();
+    // Prevent other key handlers being run
+    return true;
+  }, []);
+
   const handleSubmit = (data: LinkFormData) => {
-    updateLink(data);
+    if (data.linkType === MarkName.AssetLink) {
+      updateAssetLink({ text: data.text, attrs: data.assetLink, range: data.range });
+    } else {
+      updateLink({ text: data.text, attrs: data.link, range: data.range });
+    }
+
     setShowModal(false);
   };
 
+  // when Ctrl+K is pressed show the modal, only registered in the toolbar button instance to avoid the key press
+  // being double handled.
   if (!inPopover) {
-    // when Ctrl+K is pressed show the modal, only registered in the toolbar button instance to avoid the key press
-    // being double handled.
-    useExtensionEvent(
-      LinkExtension,
-      'onShortcut',
-      useCallback(() => handleClick(), []),
-    );
+    // disable the shortcut if the button is disabled
+    useKeymap('Mod-k', disabled ? () => true : handleShortcut);
   }
 
   return (
     <>
       <Button
         handleOnClick={handleClick}
-        isActive={active.link()}
+        isActive={active.link() || active.assetLink()}
         icon={<InsertLinkRoundedIcon />}
         label="Link (cmd+K)"
+        isDisabled={disabled}
       />
       {showModal && <LinkModal onCancel={() => setShowModal(false)} onSubmit={handleSubmit} />}
     </>

package/src/EditorToolbar/Tools/Link/LinkModal.tsx

@@ -1,9 +1,10 @@
-import { getMarkRanges } from 'remirror';
-import LinkForm, { LinkFormData } from './Form/LinkForm';
+import { LinkForm, LinkFormData } from './Form/LinkForm';
 import React from 'react';
-import { useRemirrorContext, useCurrentSelection } from '@remirror/react';
+import { useRemirrorContext } from '@remirror/react';
 import FormModal from '../../../ui/Modal/FormModal';
 import { SubmitHandler } from 'react-hook-form';
+import { useExpandedSelection } from '../../../hooks';
+import { MarkName } from '../../../Extensions/Extensions';
 
 type LinkModalProps = {
   onCancel: () => void;
@@ -15,13 +16,19 @@ const LinkModal = ({ onCancel, onSubmit }: LinkModalProps) => {
     helpers,
     view: { state },
   } = useRemirrorContext();
-  const selection = useCurrentSelection();
-  const currentLink = getMarkRanges(selection, 'link')[0];
+  const { selection, marks } = useExpandedSelection([MarkName.Link, MarkName.AssetLink]);
   const selectedText = helpers.getTextBetween(selection.from, selection.to, state.doc);
+  const data = {
+    linkType: marks[0]?.type?.name === MarkName.AssetLink ? MarkName.AssetLink : MarkName.Link,
+    text: selectedText,
+    link: { ...marks.find((mark) => mark.type.name === 'link')?.attrs },
+    assetLink: { ...marks.find((mark) => mark.type.name === MarkName.AssetLink)?.attrs },
+    range: { from: selection.from, to: selection.to },
+  };
 
   return (
     <FormModal title="Link" onCancel={onCancel}>
-      <LinkForm data={{ ...currentLink?.mark.attrs, text: selectedText }} onSubmit={onSubmit} />
+      <LinkForm data={data} onSubmit={onSubmit} />
     </FormModal>
   );
 };

package/src/EditorToolbar/Tools/Link/RemoveLinkButton.spec.tsx

@@ -7,40 +7,41 @@ import RemoveLinkButton from './RemoveLinkButton';
 describe('RemoveLinkButton', () => {
   it('Removes a link', async () => {
     const { editor, getJsonContent } = await renderWithEditor(<RemoveLinkButton />, {
-      content:
-        '<a href="https://www.example.org/my-link">Sample link</a> with some other content and ' +
-        '<a href="https://www.example.org/another-link">another link</a>.',
+      context: { matrix: { matrixDomain: 'my-matrix.squiz.net' } },
+      content: {
+        type: 'doc',
+        content: [
+          {
+            type: 'paragraph',
+            content: [
+              {
+                type: 'text',
+                text: 'Sample link',
+                marks: [{ type: 'assetLink', attrs: { matrixAssetId: '123', target: '_blank' } }],
+              },
+              { type: 'text', text: ' with ' },
+              {
+                type: 'text',
+                text: 'another link',
+                marks: [{ type: 'link', attrs: { href: 'https://www.example.org/another-link', target: '_self' } }],
+              },
+            ],
+          },
+        ],
+      },
     });
 
-    // move the cursor to inside of the link.
-    await act(() => editor.selectText(5));
+    // select all of the text.
+    await act(() => editor.selectText('all'));
 
-    // remove the link.
+    // remove the links.
     fireEvent.click(screen.getByRole('button', { name: 'Remove link' }));
 
-    // make sure the link has been removed.
+    // make sure both types of link have been removed.
     expect(getJsonContent()).toEqual({
       type: 'paragraph',
       attrs: expect.any(Object),
-      content: [
-        { type: 'text', text: 'Sample link with some other content and ' },
-        {
-          type: 'text',
-          text: 'another link',
-          marks: [
-            {
-              type: 'link',
-              attrs: {
-                auto: false,
-                href: 'https://www.example.org/another-link',
-                target: null,
-                title: null,
-              },
-            },
-          ],
-        },
-        { type: 'text', text: '.' },
-      ],
+      content: [{ type: 'text', text: 'Sample link with another link' }],
     });
   });
 });

package/src/EditorToolbar/Tools/Link/RemoveLinkButton.tsx

@@ -1,23 +1,15 @@
 import React from 'react';
-import { useRemirrorContext, useChainedCommands } from '@remirror/react';
+import { useChainedCommands } from '@remirror/react';
 import Button from '../../../ui/Button/Button';
 import LinkOffIcon from '@mui/icons-material/LinkOff';
 
 const RemoveLinkButton = () => {
-  const { commands } = useRemirrorContext({ autoUpdate: true });
   const chain = useChainedCommands();
-  const enabled = commands.removeLink.enabled();
-  const handleClick = () => {
-    if (enabled) {
-      chain.removeLink().focus().run();
-    }
-  };
 
   return (
     <Button
-      handleOnClick={handleClick}
+      handleOnClick={() => chain.removeLink().removeAssetLink().focus().run()}
       isActive={false}
-      isDisabled={!enabled}
       icon={<LinkOffIcon />}
       label="Remove link"
     />

package/src/EditorToolbar/Tools/Undo/UndoButton.spec.tsx

@@ -1,7 +1,9 @@
 import '@testing-library/jest-dom';
-import { render, screen, fireEvent } from '@testing-library/react';
+import { render, screen, fireEvent, act } from '@testing-library/react';
 import Editor from '../../../Editor/Editor';
 import React from 'react';
+import { renderWithEditor } from '../../../../tests';
+import UndoButton from './UndoButton';
 
 describe('Undo button', () => {
   it('Renders the undo button', () => {
@@ -46,4 +48,23 @@ describe('Undo button', () => {
     fireEvent.click(undo);
     expect(baseElement.querySelector('p[data-node-text-align="left"]')).toBeFalsy();
   });
+
+  it('Reverts text content changes', async () => {
+    const { editor, getJsonContent } = await renderWithEditor(<UndoButton />, { content: 'Initial content...' });
+
+    await act(() => editor.jumpTo('end'));
+    await act(() => editor.paste(' with some updated content.'));
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [{ type: 'text', text: 'Initial content... with some updated content.' }],
+    });
+
+    fireEvent.click(screen.getByRole('button', { name: 'Undo (cmd+Z)' }));
+    expect(getJsonContent()).toEqual({
+      type: 'paragraph',
+      attrs: expect.any(Object),
+      content: [{ type: 'text', text: 'Initial content...' }],
+    });
+  });
 });

package/src/EditorToolbar/_floating-toolbar.scss

@@ -1,10 +1,9 @@
 /// This class is excluded from the scope of squiz-fte-scope as it is outside of the scoped element
 .squiz-fte-scope__floating-popover {
+  @extend .editor-toolbar;
   @apply bg-white border-gray-200 p-1 shadow rounded-md border flex;
-  .squiz-fte-btn {
-    @apply p-1;
-    ~ .squiz-fte-btn {
-      margin-left: 2px;
-    }
+
+  .editor-divider {
+    @apply my-0;
   }
 }

package/src/EditorToolbar/_toolbar.scss

@@ -14,7 +14,7 @@
     height: auto;
   }
   .squiz-fte-btn {
-    @apply p-1;
+    @apply p-1 font-bold;
     ~ .squiz-fte-btn {
       margin-left: 2px;
     }