@squiz/formatted-text-editor 1.21.1-alpha.2 → 1.21.1-alpha.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. package/demo/App.tsx +45 -10
  2. package/demo/index.scss +11 -10
  3. package/lib/Editor/Editor.js +45 -7
  4. package/lib/Editor/EditorContext.d.ts +10 -0
  5. package/lib/Editor/EditorContext.js +15 -0
  6. package/lib/EditorToolbar/FloatingToolbar.js +11 -5
  7. package/lib/EditorToolbar/Toolbar.js +3 -1
  8. package/lib/EditorToolbar/Tools/Bold/BoldButton.js +2 -2
  9. package/lib/EditorToolbar/Tools/Image/Form/ImageForm.d.ts +17 -0
  10. package/lib/EditorToolbar/Tools/Image/Form/ImageForm.js +82 -0
  11. package/lib/EditorToolbar/Tools/Image/ImageButton.d.ts +5 -0
  12. package/lib/EditorToolbar/Tools/Image/ImageButton.js +77 -0
  13. package/lib/EditorToolbar/Tools/Image/ImageModal.d.ts +8 -0
  14. package/lib/EditorToolbar/Tools/Image/ImageModal.js +16 -0
  15. package/lib/EditorToolbar/Tools/Italic/ItalicButton.js +2 -2
  16. package/lib/EditorToolbar/Tools/Link/Form/LinkForm.d.ts +14 -5
  17. package/lib/EditorToolbar/Tools/Link/Form/LinkForm.js +67 -15
  18. package/lib/EditorToolbar/Tools/Link/LinkButton.js +22 -14
  19. package/lib/EditorToolbar/Tools/Link/LinkModal.js +12 -5
  20. package/lib/EditorToolbar/Tools/Link/RemoveLinkButton.js +2 -9
  21. package/lib/EditorToolbar/Tools/Redo/RedoButton.js +2 -2
  22. package/lib/EditorToolbar/Tools/TextAlign/CenterAlign/CenterAlignButton.js +2 -2
  23. package/lib/EditorToolbar/Tools/TextAlign/JustifyAlign/JustifyAlignButton.js +2 -2
  24. package/lib/EditorToolbar/Tools/TextAlign/LeftAlign/LeftAlignButton.js +2 -2
  25. package/lib/EditorToolbar/Tools/TextAlign/RightAlign/RightAlignButton.js +2 -2
  26. package/lib/EditorToolbar/Tools/Underline/UnderlineButton.js +2 -2
  27. package/lib/EditorToolbar/Tools/Undo/UndoButton.js +2 -2
  28. package/lib/Extensions/CommandsExtension/CommandsExtension.d.ts +20 -0
  29. package/lib/Extensions/CommandsExtension/CommandsExtension.js +52 -0
  30. package/lib/Extensions/Extensions.d.ts +7 -4
  31. package/lib/Extensions/Extensions.js +32 -19
  32. package/lib/Extensions/ImageExtension/ImageExtension.d.ts +10 -0
  33. package/lib/Extensions/ImageExtension/ImageExtension.js +92 -0
  34. package/lib/Extensions/LinkExtension/AssetLinkExtension.d.ts +26 -0
  35. package/lib/Extensions/LinkExtension/AssetLinkExtension.js +102 -0
  36. package/lib/Extensions/LinkExtension/LinkExtension.d.ts +21 -12
  37. package/lib/Extensions/LinkExtension/LinkExtension.js +63 -65
  38. package/lib/Extensions/LinkExtension/common.d.ts +7 -0
  39. package/lib/Extensions/LinkExtension/common.js +14 -0
  40. package/lib/Extensions/PreformattedExtension/PreformattedExtension.d.ts +1 -1
  41. package/lib/hooks/index.d.ts +1 -0
  42. package/lib/hooks/index.js +1 -0
  43. package/lib/hooks/useExpandedSelection.d.ts +23 -0
  44. package/lib/hooks/useExpandedSelection.js +37 -0
  45. package/lib/index.css +159 -74
  46. package/lib/index.d.ts +5 -2
  47. package/lib/index.js +9 -3
  48. package/lib/types.d.ts +3 -0
  49. package/lib/types.js +2 -0
  50. package/lib/ui/Button/Button.d.ts +11 -0
  51. package/lib/ui/{ToolbarButton/ToolbarButton.js → Button/Button.js} +6 -3
  52. package/lib/ui/Fields/Input/Input.d.ts +5 -0
  53. package/lib/ui/{Inputs/Text/TextInput.js → Fields/Input/Input.js} +10 -5
  54. package/lib/ui/Modal/Modal.js +2 -1
  55. package/lib/utils/converters/remirrorNodeToSquizNode/remirrorNodeToSquizNode.d.ts +9 -0
  56. package/lib/utils/converters/remirrorNodeToSquizNode/remirrorNodeToSquizNode.js +165 -0
  57. package/lib/utils/converters/squizNodeToRemirrorNode/squizNodeToRemirrorNode.d.ts +9 -0
  58. package/lib/utils/converters/squizNodeToRemirrorNode/squizNodeToRemirrorNode.js +129 -0
  59. package/lib/utils/undefinedIfEmpty.d.ts +1 -0
  60. package/lib/utils/undefinedIfEmpty.js +7 -0
  61. package/package.json +9 -4
  62. package/src/Editor/Editor.spec.tsx +78 -18
  63. package/src/Editor/Editor.tsx +28 -9
  64. package/src/Editor/EditorContext.spec.tsx +26 -0
  65. package/src/Editor/EditorContext.ts +19 -0
  66. package/src/Editor/_editor.scss +20 -51
  67. package/src/EditorToolbar/FloatingToolbar.spec.tsx +2 -3
  68. package/src/EditorToolbar/FloatingToolbar.tsx +15 -6
  69. package/src/EditorToolbar/Toolbar.tsx +2 -0
  70. package/src/EditorToolbar/Tools/Bold/BoldButton.spec.tsx +1 -1
  71. package/src/EditorToolbar/Tools/Bold/BoldButton.tsx +2 -2
  72. package/src/EditorToolbar/Tools/Image/Form/ImageForm.spec.tsx +77 -0
  73. package/src/EditorToolbar/Tools/Image/Form/ImageForm.tsx +90 -0
  74. package/src/EditorToolbar/Tools/Image/ImageButton.spec.tsx +135 -0
  75. package/src/EditorToolbar/Tools/Image/ImageButton.tsx +72 -0
  76. package/src/EditorToolbar/Tools/Image/ImageModal.spec.tsx +83 -0
  77. package/src/EditorToolbar/Tools/Image/ImageModal.tsx +24 -0
  78. package/src/EditorToolbar/Tools/Italic/ItalicButton.spec.tsx +1 -1
  79. package/src/EditorToolbar/Tools/Italic/ItalicButton.tsx +2 -2
  80. package/src/EditorToolbar/Tools/Link/Form/LinkForm.spec.tsx +37 -9
  81. package/src/EditorToolbar/Tools/Link/Form/LinkForm.tsx +97 -27
  82. package/src/EditorToolbar/Tools/Link/LinkButton.spec.tsx +104 -26
  83. package/src/EditorToolbar/Tools/Link/LinkButton.tsx +30 -21
  84. package/src/EditorToolbar/Tools/Link/LinkModal.tsx +13 -6
  85. package/src/EditorToolbar/Tools/Link/RemoveLinkButton.spec.tsx +26 -26
  86. package/src/EditorToolbar/Tools/Link/RemoveLinkButton.tsx +4 -12
  87. package/src/EditorToolbar/Tools/Redo/RedoButton.tsx +2 -2
  88. package/src/EditorToolbar/Tools/TextAlign/CenterAlign/CenterAlignButton.tsx +2 -2
  89. package/src/EditorToolbar/Tools/TextAlign/JustifyAlign/JustifyAlignButton.tsx +2 -2
  90. package/src/EditorToolbar/Tools/TextAlign/LeftAlign/LeftAlignButton.tsx +2 -2
  91. package/src/EditorToolbar/Tools/TextAlign/RightAlign/RightAlignButton.tsx +2 -2
  92. package/src/EditorToolbar/Tools/Underline/Underline.spec.tsx +1 -1
  93. package/src/EditorToolbar/Tools/Underline/UnderlineButton.tsx +2 -2
  94. package/src/EditorToolbar/Tools/Undo/UndoButton.spec.tsx +22 -1
  95. package/src/EditorToolbar/Tools/Undo/UndoButton.tsx +2 -2
  96. package/src/EditorToolbar/_floating-toolbar.scss +5 -0
  97. package/src/EditorToolbar/_toolbar.scss +11 -5
  98. package/src/Extensions/CommandsExtension/CommandsExtension.ts +54 -0
  99. package/src/Extensions/Extensions.ts +32 -17
  100. package/src/Extensions/ImageExtension/ImageExtension.ts +112 -0
  101. package/src/Extensions/LinkExtension/AssetLinkExtension.spec.ts +104 -0
  102. package/src/Extensions/LinkExtension/AssetLinkExtension.ts +128 -0
  103. package/src/Extensions/LinkExtension/LinkExtension.spec.ts +68 -0
  104. package/src/Extensions/LinkExtension/LinkExtension.ts +88 -82
  105. package/src/Extensions/LinkExtension/common.ts +10 -0
  106. package/src/hooks/index.ts +1 -0
  107. package/src/hooks/useExpandedSelection.ts +44 -0
  108. package/src/index.scss +2 -2
  109. package/src/index.ts +5 -2
  110. package/src/types.ts +5 -0
  111. package/src/ui/Button/Button.spec.tsx +44 -0
  112. package/src/ui/Button/Button.tsx +29 -0
  113. package/src/ui/{_buttons.scss → Button/_button.scss} +19 -1
  114. package/src/ui/{Inputs/Text/TextInput.spec.tsx → Fields/Input/Input.spec.tsx} +8 -8
  115. package/src/ui/Fields/Input/Input.tsx +34 -0
  116. package/src/ui/Modal/Modal.tsx +2 -1
  117. package/src/ui/ToolbarDropdown/_toolbar-dropdown.scss +1 -1
  118. package/src/ui/_forms.scss +14 -0
  119. package/src/ui/_typography.scss +46 -0
  120. package/src/utils/converters/mocks/squizNodeJson.mock.ts +252 -0
  121. package/src/utils/converters/remirrorNodeToSquizNode/remirrorNodeToSquizNode.spec.ts +480 -0
  122. package/src/utils/converters/remirrorNodeToSquizNode/remirrorNodeToSquizNode.ts +202 -0
  123. package/src/utils/converters/squizNodeToRemirrorNode/squizNodeToRemirrorNode.spec.ts +329 -0
  124. package/src/utils/converters/squizNodeToRemirrorNode/squizNodeToRemirrorNode.ts +151 -0
  125. package/src/utils/undefinedIfEmpty.spec.ts +12 -0
  126. package/src/utils/undefinedIfEmpty.ts +3 -0
  127. package/tailwind.config.cjs +3 -0
  128. package/tests/renderWithEditor.tsx +28 -15
  129. package/lib/FormattedTextEditor.d.ts +0 -2
  130. package/lib/FormattedTextEditor.js +0 -7
  131. package/lib/ui/Inputs/Text/TextInput.d.ts +0 -4
  132. package/lib/ui/ToolbarButton/ToolbarButton.d.ts +0 -10
  133. package/src/Editor/Editor.mock.tsx +0 -43
  134. package/src/FormattedTextEditor.spec.tsx +0 -10
  135. package/src/FormattedTextEditor.tsx +0 -3
  136. package/src/ui/Inputs/Text/TextInput.tsx +0 -20
  137. package/src/ui/ToolbarButton/ToolbarButton.tsx +0 -26
  138. package/src/ui/ToolbarButton/_toolbar-button.scss +0 -17
  139. /package/lib/ui/{Inputs → Fields}/Select/Select.d.ts +0 -0
  140. /package/lib/ui/{Inputs → Fields}/Select/Select.js +0 -0
  141. /package/src/ui/{Inputs → Fields}/Select/Select.spec.tsx +0 -0
  142. /package/src/ui/{Inputs → Fields}/Select/Select.tsx +0 -0
package/lib/index.js CHANGED
@@ -3,6 +3,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.FormattedTextEditor = void 0;
7
- const FormattedTextEditor_1 = __importDefault(require("./FormattedTextEditor"));
8
- exports.FormattedTextEditor = FormattedTextEditor_1.default;
6
+ exports.squizNodeToRemirrorNode = exports.remirrorNodeToSquizNode = exports.EditorContext = exports.Editor = void 0;
7
+ const Editor_1 = __importDefault(require("./Editor/Editor"));
8
+ exports.Editor = Editor_1.default;
9
+ const EditorContext_1 = require("./Editor/EditorContext");
10
+ Object.defineProperty(exports, "EditorContext", { enumerable: true, get: function () { return EditorContext_1.EditorContext; } });
11
+ const remirrorNodeToSquizNode_1 = require("./utils/converters/remirrorNodeToSquizNode/remirrorNodeToSquizNode");
12
+ Object.defineProperty(exports, "remirrorNodeToSquizNode", { enumerable: true, get: function () { return remirrorNodeToSquizNode_1.remirrorNodeToSquizNode; } });
13
+ const squizNodeToRemirrorNode_1 = require("./utils/converters/squizNodeToRemirrorNode/squizNodeToRemirrorNode");
14
+ Object.defineProperty(exports, "squizNodeToRemirrorNode", { enumerable: true, get: function () { return squizNodeToRemirrorNode_1.squizNodeToRemirrorNode; } });
package/lib/types.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ export type DeepPartial<T> = T extends Record<string, unknown> ? {
2
+ [P in keyof T]?: DeepPartial<T[P]>;
3
+ } : T;
package/lib/types.js ADDED
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ import { ReactElement } from 'react';
2
+ type ButtonProps = {
3
+ handleOnClick: () => void;
4
+ isDisabled?: boolean;
5
+ isActive: boolean;
6
+ label: string;
7
+ text?: string;
8
+ icon?: ReactElement;
9
+ };
10
+ declare const Button: ({ handleOnClick, isDisabled, isActive, label, text, icon }: ButtonProps) => JSX.Element;
11
+ export default Button;
@@ -4,7 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
6
  const react_1 = __importDefault(require("react"));
7
- const ToolbarButton = ({ handleOnClick, isDisabled, isActive, icon, label }) => {
8
- return (react_1.default.createElement("button", { "aria-label": label, title: label, type: "button", onClick: handleOnClick, disabled: isDisabled, className: `squiz-fte-btn toolbar-button ${isActive ? 'is-active' : ''}` }, icon));
7
+ const clsx_1 = __importDefault(require("clsx"));
8
+ const Button = ({ handleOnClick, isDisabled, isActive, label, text, icon }) => {
9
+ return (react_1.default.createElement("button", { "aria-label": label, title: label, type: "button", onClick: handleOnClick, disabled: isDisabled, className: (0, clsx_1.default)('squiz-fte-btn', isActive && 'squiz-fte-btn--is-active', icon && ' squiz-fte-btn--is-icon') },
10
+ text && react_1.default.createElement("span", null, text),
11
+ icon && icon));
9
12
  };
10
- exports.default = ToolbarButton;
13
+ exports.default = Button;
@@ -0,0 +1,5 @@
1
+ import React from 'react';
2
+ export declare const Input: React.ForwardRefExoticComponent<React.InputHTMLAttributes<HTMLInputElement> & {
3
+ label?: string | undefined;
4
+ error?: string | undefined;
5
+ } & React.RefAttributes<HTMLInputElement>>;
@@ -22,12 +22,17 @@ var __importStar = (this && this.__importStar) || function (mod) {
22
22
  __setModuleDefault(result, mod);
23
23
  return result;
24
24
  };
25
+ var __importDefault = (this && this.__importDefault) || function (mod) {
26
+ return (mod && mod.__esModule) ? mod : { "default": mod };
27
+ };
25
28
  Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.TextInput = void 0;
29
+ exports.Input = void 0;
27
30
  const react_1 = __importStar(require("react"));
28
- const TextInputInternal = ({ name, label, ...rest }, ref) => {
29
- return (react_1.default.createElement(react_1.default.Fragment, null,
31
+ const clsx_1 = __importDefault(require("clsx"));
32
+ const InputInternal = ({ name, label, type = 'text', error, ...rest }, ref) => {
33
+ return (react_1.default.createElement("div", { className: (0, clsx_1.default)(error && 'squiz-fte-invalid-form-field') },
30
34
  label && (react_1.default.createElement("label", { htmlFor: name, className: "squiz-fte-form-label" }, label)),
31
- react_1.default.createElement("input", { ref: ref, id: name, name: name, type: "text", className: "squiz-fte-form-control", ...rest })));
35
+ react_1.default.createElement("input", { ref: ref, id: name, name: name, type: type, "aria-invalid": !!error, className: "squiz-fte-form-control", ...rest }),
36
+ error && react_1.default.createElement("div", { className: "squiz-fte-form-error" }, error)));
32
37
  };
33
- exports.TextInput = (0, react_1.forwardRef)(TextInputInternal);
38
+ exports.Input = (0, react_1.forwardRef)(InputInternal);
@@ -30,6 +30,7 @@ const react_1 = __importStar(require("react"));
30
30
  const react_dom_1 = require("react-dom");
31
31
  const CloseRounded_1 = __importDefault(require("@mui/icons-material/CloseRounded"));
32
32
  const base_1 = require("@mui/base");
33
+ const clsx_1 = __importDefault(require("clsx"));
33
34
  const Modal = ({ children, title, onCancel, onSubmit, className }, ref) => {
34
35
  const container = (0, react_1.useMemo)(() => {
35
36
  const element = document.createElement('div');
@@ -60,7 +61,7 @@ const Modal = ({ children, title, onCancel, onSubmit, className }, ref) => {
60
61
  }, [container]);
61
62
  return (0, react_dom_1.createPortal)(react_1.default.createElement(react_1.default.Fragment, null,
62
63
  react_1.default.createElement(base_1.FocusTrap, { open: true },
63
- react_1.default.createElement("div", { ref: ref, className: `squiz-fte-modal-wrapper ${className ? className : ''}`, tabIndex: -1 },
64
+ react_1.default.createElement("div", { ref: ref, className: (0, clsx_1.default)('squiz-fte-modal-wrapper', className), tabIndex: -1 },
64
65
  react_1.default.createElement("div", { className: "w-modal-sm my-6 mx-auto" },
65
66
  react_1.default.createElement("div", { className: "squiz-fte-modal" },
66
67
  react_1.default.createElement("div", { className: "squiz-fte-modal-header p-6 pb-2" },
@@ -0,0 +1,9 @@
1
+ import { ProsemirrorNode } from 'remirror';
2
+ import { FORMATTED_TEXT_MODELS as FormattedTextModels } from '@squiz/dx-json-schema-lib';
3
+ export declare const resolveNodeTag: (node: ProsemirrorNode) => string;
4
+ /**
5
+ * Converts Remirror node JSON structure to Squiz component JSON structure.
6
+ * @param {ProsemirrorNode} node Remirror node to convert to component.
7
+ * @returns {FormattedText} The converted Squiz component JSON.
8
+ */
9
+ export declare const remirrorNodeToSquizNode: (node: ProsemirrorNode) => FormattedTextModels.v1.FormattedText;
@@ -0,0 +1,165 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.remirrorNodeToSquizNode = exports.resolveNodeTag = void 0;
4
+ const undefinedIfEmpty_1 = require("../../undefinedIfEmpty");
5
+ const resolveNodeTag = (node) => {
6
+ if (node.type.name === 'text') {
7
+ return 'span';
8
+ }
9
+ if (node.type.spec?.toDOM) {
10
+ const domNode = node.type.spec.toDOM(node);
11
+ if (domNode instanceof window.Node) {
12
+ return domNode.nodeName.toLowerCase();
13
+ }
14
+ if (typeof domNode === 'object' && 'dom' in domNode && domNode.dom instanceof window.Node) {
15
+ return domNode.dom.nodeName.toLowerCase();
16
+ }
17
+ if (domNode instanceof Array) {
18
+ // [ tag, attributes, ...children ]
19
+ return domNode[0].toLowerCase();
20
+ }
21
+ }
22
+ throw new Error('Unexpected Remirror node encountered, cannot resolve tag.');
23
+ };
24
+ exports.resolveNodeTag = resolveNodeTag;
25
+ const resolveFormattingOptions = (node) => {
26
+ const formattingOptions = {};
27
+ if (node.attrs.nodeTextAlignment) {
28
+ formattingOptions.alignment = node.attrs.nodeTextAlignment;
29
+ }
30
+ return formattingOptions;
31
+ };
32
+ const resolveFontOptions = (node) => {
33
+ const fontOptions = {};
34
+ node.marks.forEach((mark) => {
35
+ switch (mark.type.name) {
36
+ case 'bold':
37
+ fontOptions.bold = true;
38
+ break;
39
+ case 'italic':
40
+ fontOptions.italics = true;
41
+ break;
42
+ case 'underline':
43
+ fontOptions.underline = true;
44
+ break;
45
+ }
46
+ });
47
+ return fontOptions;
48
+ };
49
+ const transformAttributes = (attributes) => {
50
+ const transformed = {};
51
+ Object.keys(attributes).forEach((key) => {
52
+ // Component service requires attributes to be a string, cast as needed.
53
+ if (typeof attributes[key] === 'string' || typeof attributes[key] === 'number') {
54
+ transformed[key] = String(attributes[key]);
55
+ }
56
+ });
57
+ return transformed;
58
+ };
59
+ const transformFragment = (fragment) => {
60
+ const transformed = [];
61
+ fragment.forEach((child) => transformed.push(transformNode(child)));
62
+ return transformed;
63
+ };
64
+ const transformNode = (node) => {
65
+ const attributes = node.type.name === 'image' ? transformAttributes(node.attrs) : undefined;
66
+ const formattingOptions = (0, undefinedIfEmpty_1.undefinedIfEmpty)(resolveFormattingOptions(node));
67
+ const font = (0, undefinedIfEmpty_1.undefinedIfEmpty)(resolveFontOptions(node));
68
+ let transformedNode = { type: 'text', value: node.text || '' };
69
+ // Squiz "text" nodes can't have formatting/font options but Remirror "text" nodes can.
70
+ // If the node has formatting options wrap in a tag.
71
+ // If the node isn't a text type assume it is a tag type and wrap in a tag.
72
+ // If we pick the wrong tag here it will be corrected later as part of looping through the
73
+ // non-font marks.
74
+ if (node.type.name !== 'text' || attributes || formattingOptions || font) {
75
+ transformedNode = {
76
+ type: 'tag',
77
+ tag: (0, exports.resolveNodeTag)(node),
78
+ children: node.type.name === 'text' ? [transformedNode] : transformFragment(node.content),
79
+ attributes,
80
+ formattingOptions,
81
+ font,
82
+ };
83
+ }
84
+ node.marks.forEach((mark) => {
85
+ switch (mark.type.name) {
86
+ case 'bold':
87
+ case 'italic':
88
+ case 'underline':
89
+ break;
90
+ default:
91
+ transformedNode = transformMark(mark, transformedNode);
92
+ }
93
+ });
94
+ return transformedNode;
95
+ };
96
+ /**
97
+ * Merges 2 nodes together if they are compatible without losing any important details.
98
+ * Otherwise will wrap the node.
99
+ *
100
+ * @param {FormattedNode} node
101
+ * @param {FormattedNodeWithChildren} wrappingNode
102
+ *
103
+ * @return {FormattedNode}
104
+ */
105
+ const wrapNodeIfNeeded = (node, wrappingNode) => {
106
+ if (node.type === 'tag' && wrappingNode.type === 'tag' && (node.tag === 'span' || node.tag === wrappingNode.tag)) {
107
+ // if the node we are wrapping with is a DOM node, and the node being wrapped is
108
+ // a plain looking DOM node merge the 2 nodes.
109
+ return {
110
+ ...node,
111
+ ...wrappingNode,
112
+ formattingOptions: (0, undefinedIfEmpty_1.undefinedIfEmpty)({
113
+ ...node.formattingOptions,
114
+ ...wrappingNode.formattingOptions,
115
+ }),
116
+ attributes: (0, undefinedIfEmpty_1.undefinedIfEmpty)({
117
+ ...node.attributes,
118
+ ...wrappingNode.attributes,
119
+ }),
120
+ font: (0, undefinedIfEmpty_1.undefinedIfEmpty)({
121
+ ...node.font,
122
+ ...wrappingNode.font,
123
+ }),
124
+ children: [...node.children, ...wrappingNode.children],
125
+ };
126
+ }
127
+ // if the node we are wrapping or the wrapping nodes are not compatible merge them.
128
+ return {
129
+ ...wrappingNode,
130
+ children: [node, ...wrappingNode.children],
131
+ };
132
+ };
133
+ const transformMark = (mark, node) => {
134
+ switch (mark.type.name) {
135
+ case 'link':
136
+ return wrapNodeIfNeeded(node, {
137
+ type: 'tag',
138
+ tag: 'a',
139
+ attributes: transformAttributes(mark.attrs),
140
+ children: [],
141
+ });
142
+ case 'assetLink':
143
+ return wrapNodeIfNeeded(node, {
144
+ type: 'link-to-matrix-asset',
145
+ target: mark.attrs.target,
146
+ matrixIdentifier: mark.attrs.matrixIdentifier,
147
+ matrixDomain: mark.attrs.matrixDomain,
148
+ matrixAssetId: mark.attrs.matrixAssetId,
149
+ children: [],
150
+ });
151
+ }
152
+ throw new Error(`Unsupported mark "${mark.type.name}" was applied to node.`);
153
+ };
154
+ /**
155
+ * Converts Remirror node JSON structure to Squiz component JSON structure.
156
+ * @param {ProsemirrorNode} node Remirror node to convert to component.
157
+ * @returns {FormattedText} The converted Squiz component JSON.
158
+ */
159
+ const remirrorNodeToSquizNode = (node) => {
160
+ if (node?.type?.name !== 'doc') {
161
+ throw new Error('Unable to convert from Remirror to Node data structure, unexpected node provided.');
162
+ }
163
+ return transformFragment(node.content);
164
+ };
165
+ exports.remirrorNodeToSquizNode = remirrorNodeToSquizNode;
@@ -0,0 +1,9 @@
1
+ import { RemirrorJSON } from '@remirror/core';
2
+ import { FORMATTED_TEXT_MODELS as FormattedTextModels } from '@squiz/dx-json-schema-lib';
3
+ /**
4
+ * Converts Squiz component JSON structure to Remirror node JSON structure.
5
+ * @param {FormattedText} nodes Squiz nodes to convert to Remirror.
6
+ * @export
7
+ * @returns {RemirrorJSON} The converted Remirror JSON.
8
+ */
9
+ export declare const squizNodeToRemirrorNode: (nodes: FormattedTextModels.v1.FormattedText) => RemirrorJSON;
@@ -0,0 +1,129 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.squizNodeToRemirrorNode = void 0;
4
+ const undefinedIfEmpty_1 = require("../../undefinedIfEmpty");
5
+ const getNodeType = (node) => {
6
+ const typeMap = {
7
+ 'link-to-matrix-asset': 'text',
8
+ text: 'text',
9
+ };
10
+ const tagMap = {
11
+ h1: 'heading',
12
+ h2: 'heading',
13
+ h3: 'heading',
14
+ h4: 'heading',
15
+ h5: 'heading',
16
+ h6: 'heading',
17
+ img: 'image',
18
+ pre: 'preformatted',
19
+ p: 'paragraph',
20
+ a: 'text',
21
+ span: 'text',
22
+ };
23
+ if (typeMap[node.type]) {
24
+ return typeMap[node.type];
25
+ }
26
+ if (node.type === 'tag' && tagMap[node.tag]) {
27
+ return tagMap[node.tag];
28
+ }
29
+ // Unsupported node type
30
+ throw new Error(node.type === 'tag'
31
+ ? `Unsupported node type provided: ${node.type} (tag: ${node.tag})`
32
+ : `Unsupported node type provided: ${node.type}`);
33
+ };
34
+ const getNodeAttributes = (node) => {
35
+ if (node.type === 'tag' && node.tag === 'img') {
36
+ return {
37
+ alt: node.attributes?.alt,
38
+ height: node.attributes?.height,
39
+ width: node.attributes?.width,
40
+ src: node.attributes?.src,
41
+ title: node.attributes?.title,
42
+ };
43
+ }
44
+ else if (node.type === 'tag') {
45
+ return {
46
+ nodeIndent: null,
47
+ nodeTextAlignment: node.formattingOptions?.alignment || null,
48
+ nodeLineHeight: null,
49
+ style: '',
50
+ level: node.tag?.startsWith('h') ? parseInt(node.tag.substring(1)) : undefined,
51
+ };
52
+ }
53
+ return {};
54
+ };
55
+ const getNodeMarks = (node) => {
56
+ const marks = [];
57
+ if (node.type === 'tag' && node.tag === 'a') {
58
+ marks.push({
59
+ type: 'link',
60
+ attrs: {
61
+ href: node.attributes?.href,
62
+ target: node.attributes?.target ?? null,
63
+ auto: false,
64
+ title: node.attributes?.title ?? null,
65
+ },
66
+ });
67
+ }
68
+ else if (node.type === 'link-to-matrix-asset') {
69
+ marks.push({
70
+ type: 'assetLink',
71
+ attrs: {
72
+ matrixAssetId: node.matrixAssetId,
73
+ matrixDomain: node.matrixDomain,
74
+ matrixIdentifier: node.matrixIdentifier,
75
+ target: node.target,
76
+ },
77
+ });
78
+ }
79
+ // Handle font formatting
80
+ if ('font' in node) {
81
+ node.font?.bold && marks.push({ type: 'bold' });
82
+ node.font?.italics && marks.push({ type: 'italic' });
83
+ node.font?.underline && marks.push({ type: 'underline' });
84
+ }
85
+ return marks;
86
+ };
87
+ const unwrapNodeIfNeeded = (node) => {
88
+ if (node.type === 'text' && node.content?.length) {
89
+ return node.content.map((child) => {
90
+ return {
91
+ ...child,
92
+ marks: [...(child.marks || []), ...(node.marks || [])],
93
+ };
94
+ });
95
+ }
96
+ return [node];
97
+ };
98
+ const formatNode = (node) => {
99
+ const children = [];
100
+ if ('children' in node) {
101
+ node.children.forEach((child) => {
102
+ children.push(...formatNode(child));
103
+ });
104
+ }
105
+ return unwrapNodeIfNeeded({
106
+ type: getNodeType(node),
107
+ attrs: (0, undefinedIfEmpty_1.undefinedIfEmpty)(getNodeAttributes(node)),
108
+ marks: (0, undefinedIfEmpty_1.undefinedIfEmpty)(getNodeMarks(node)),
109
+ text: node.type === 'text' ? node.value : undefined,
110
+ content: (0, undefinedIfEmpty_1.undefinedIfEmpty)(children),
111
+ });
112
+ };
113
+ /**
114
+ * Converts Squiz component JSON structure to Remirror node JSON structure.
115
+ * @param {FormattedText} nodes Squiz nodes to convert to Remirror.
116
+ * @export
117
+ * @returns {RemirrorJSON} The converted Remirror JSON.
118
+ */
119
+ const squizNodeToRemirrorNode = (nodes) => {
120
+ let children = [];
121
+ nodes.forEach((node) => {
122
+ children.push(...formatNode(node));
123
+ });
124
+ if (children.find((child) => child.type === 'text')) {
125
+ children = [{ type: 'paragraph', content: children }];
126
+ }
127
+ return { type: 'doc', content: children };
128
+ };
129
+ exports.squizNodeToRemirrorNode = squizNodeToRemirrorNode;
@@ -0,0 +1 @@
1
+ export declare const undefinedIfEmpty: <T extends object>(object: T) => T | undefined;
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.undefinedIfEmpty = void 0;
4
+ const undefinedIfEmpty = (object) => {
5
+ return Object.keys(object).length > 0 ? object : undefined;
6
+ };
7
+ exports.undefinedIfEmpty = undefinedIfEmpty;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squiz/formatted-text-editor",
3
- "version": "1.21.1-alpha.2",
3
+ "version": "1.21.1-alpha.21",
4
4
  "main": "lib/index.js",
5
5
  "types": "lib/index.d.ts",
6
6
  "scripts": {
@@ -20,19 +20,23 @@
20
20
  "@headlessui/react": "1.7.11",
21
21
  "@mui/icons-material": "5.11.0",
22
22
  "@remirror/react": "2.0.25",
23
+ "@squiz/dx-json-schema-lib": "1.21.1-alpha.2",
23
24
  "clsx": "1.2.1",
24
- "react-hook-form": "7.43.2"
25
+ "react-hook-form": "7.43.2",
26
+ "react-image-size": "2.0.0"
25
27
  },
26
28
  "devDependencies": {
27
29
  "@testing-library/cypress": "9.0.0",
28
30
  "@testing-library/jest-dom": "5.16.5",
29
31
  "@testing-library/react": "14.0.0",
30
32
  "@testing-library/user-event": "14.4.3",
33
+ "@types/node": "18.15.2",
31
34
  "@types/react": "18.0.26",
32
35
  "@types/react-dom": "18.0.9",
33
36
  "@vitejs/plugin-react": "3.0.0",
34
37
  "autoprefixer": "10.4.13",
35
38
  "cypress": "12.5.1",
39
+ "deepmerge": "^4.3.0",
36
40
  "eslint-plugin-cypress": "2.12.1",
37
41
  "eslint-plugin-jsx-a11y": "6.7.1",
38
42
  "eslint-plugin-react": "7.32.2",
@@ -43,6 +47,7 @@
43
47
  "postcss-nested": "6.0.0",
44
48
  "postcss-prefix-selector": "1.16.0",
45
49
  "react": "18.2.0",
50
+ "react-diff-viewer-continued": "3.2.6",
46
51
  "react-dom": "18.2.0",
47
52
  "rimraf": "4.1.2",
48
53
  "tailwindcss": "3.2.6",
@@ -65,7 +70,7 @@
65
70
  }
66
71
  },
67
72
  "volta": {
68
- "node": "16.19.0"
73
+ "node": "18.15.0"
69
74
  },
70
- "gitHead": "094356f01a017174820505681d5dfc4a2ee9428b"
75
+ "gitHead": "b6a0d4e2501e58cb3c3ecd26741c447e2c3bc1db"
71
76
  }
@@ -1,11 +1,9 @@
1
- import { jest } from '@jest/globals';
2
1
  import React from 'react';
3
2
  import { act, fireEvent, render, screen } from '@testing-library/react';
4
- import { MockEditor } from './Editor.mock';
5
3
  import Editor from './Editor';
6
4
  import '@testing-library/jest-dom';
7
-
8
- const setContent: any = jest.fn();
5
+ import { renderWithEditor } from '../../tests/renderWithEditor';
6
+ import ImageButton from '../EditorToolbar/Tools/Image/ImageButton';
9
7
 
10
8
  describe('Formatted text editor', () => {
11
9
  it('Renders the text editor', () => {
@@ -230,25 +228,87 @@ describe('Formatted text editor', () => {
230
228
  expect(baseElement.querySelectorAll('div.remirror-editor p')).toHaveLength(1);
231
229
  });
232
230
 
233
- it('Should allow text input & undo input upon clicking undo button', () => {
234
- const { baseElement, getByLabelText } = render(<MockEditor setContent={setContent} />);
231
+ it('should allow text to be pasted into the editor', async () => {
232
+ const { editor, getJsonContent } = await renderWithEditor(<ImageButton />, {
233
+ content: 'Some nonsense content here',
234
+ });
235
+
236
+ // paste something
237
+ await act(() => editor.paste('I pasted this! '));
238
+
239
+ expect(getJsonContent()).toEqual({
240
+ type: 'paragraph',
241
+ attrs: expect.any(Object),
242
+ content: [
243
+ {
244
+ text: 'I pasted this! Some nonsense content here',
245
+ type: 'text',
246
+ },
247
+ ],
248
+ });
249
+ });
250
+
251
+ it('should not allow images to be pasted into the editor', async () => {
252
+ const { elements, getJsonContent } = await renderWithEditor(<ImageButton />, {
253
+ content: 'Some nonsense content here',
254
+ });
255
+ const imageClipboardData = {
256
+ dropEffect: 'none',
257
+ effectAllowed: 'uninitialized',
258
+ items: {
259
+ '0': {
260
+ kind: 'file',
261
+ type: 'image/png',
262
+ },
263
+ },
264
+ files: {
265
+ '0': {
266
+ lastModified: 1678233857792,
267
+ lastModifiedDate: {},
268
+ name: 'Screen Shot 2023-03-08 at 10.04.12 am.png',
269
+ size: 58517,
270
+ type: 'image/png',
271
+ webkitRelativePath: '',
272
+ },
273
+ },
274
+ types: [],
275
+ };
276
+
277
+ // paste something
278
+ await act(() => fireEvent.paste(elements.editor, imageClipboardData));
279
+
280
+ expect(getJsonContent()).toEqual({
281
+ type: 'paragraph',
282
+ attrs: expect.any(Object),
283
+ content: [
284
+ {
285
+ text: 'Some nonsense content here',
286
+ type: 'text',
287
+ },
288
+ ],
289
+ });
290
+ });
235
291
 
236
- const textContent = `This is a string with a random number: ${Math.random() * 9999}`;
292
+ it('Should not display the toolbar if is not editable', () => {
293
+ render(<Editor editable={false} />);
294
+ expect(screen.queryByRole('button', { name: 'Bold (cmd+B)' })).not.toBeInTheDocument();
295
+ expect(screen.queryByRole('button', { name: 'Italic (cmd+I)' })).not.toBeInTheDocument();
296
+ expect(screen.queryByRole('button', { name: 'Underline (cmd+U)' })).not.toBeInTheDocument();
297
+ });
237
298
 
238
- // This sets the content of the text editor
239
- act(() => {
240
- setContent(`<p>${textContent}</p>`, { triggerChange: true });
299
+ it('Should not display the floating toolbar if is not editable', async () => {
300
+ const from = 3 as number;
301
+ const to = 17 as number;
302
+ const { editor } = await renderWithEditor(null, {
303
+ content: 'My awesome <a href="https://example.org">example</a> content.',
304
+ editable: false,
241
305
  });
242
306
 
243
- const editorNode = getByLabelText(`Text editor`);
244
- expect(editorNode).toBeTruthy();
245
- expect(editorNode.textContent).toBe(textContent);
307
+ await act(() => editor.selectText({ from, to }));
246
308
 
247
- // Testing if clicking undo button removes text from editor
248
- const undoButton = baseElement.querySelector('button[title="Undo (cmd+Z)"]') as HTMLButtonElement;
249
- expect(undoButton).toBeTruthy();
250
- fireEvent.click(undoButton);
309
+ const buttons = screen.queryAllByRole('button');
310
+ const buttonLabels = buttons.map((button) => button.getAttribute('title'));
251
311
 
252
- expect(editorNode.textContent).toBe('');
312
+ expect(buttonLabels).toEqual([]);
253
313
  });
254
314
  });
@@ -1,8 +1,11 @@
1
- import React from 'react';
2
- import { EditorComponent, Remirror, useRemirror } from '@remirror/react';
1
+ import React, { useContext, useCallback } from 'react';
2
+ import { EditorComponent, Remirror, useRemirror, useEditorEvent } from '@remirror/react';
3
3
  import { RemirrorContentType, RemirrorEventListener, Extension } from '@remirror/core';
4
4
  import { Toolbar, FloatingToolbar } from '../EditorToolbar';
5
- import { Extensions } from '../Extensions/Extensions';
5
+ import { EditorContext } from './EditorContext';
6
+ import { createExtensions } from '../Extensions/Extensions';
7
+ import clsx from 'clsx';
8
+ import { ClipboardEventHandler } from '@remirror/extension-events/dist-types/events-extension';
6
9
 
7
10
  type EditorProps = {
8
11
  content?: RemirrorContentType;
@@ -10,9 +13,25 @@ type EditorProps = {
10
13
  editable?: boolean;
11
14
  };
12
15
 
13
- const Editor = ({ content, editable, onChange }: EditorProps) => {
16
+ const WrappedEditor = () => {
17
+ const preventImagePaste = useCallback((event) => {
18
+ const { clipboardData } = event;
19
+ const pastedData = clipboardData?.files[0];
20
+ if (pastedData?.type && pastedData?.type.startsWith('image/')) {
21
+ event.preventDefault();
22
+ }
23
+
24
+ // Allow other paste event handlers to be run.
25
+ return false;
26
+ }, []) as ClipboardEventHandler;
27
+
28
+ useEditorEvent('paste', preventImagePaste);
29
+ return <EditorComponent />;
30
+ };
31
+
32
+ const Editor = ({ content, editable = true, onChange }: EditorProps) => {
14
33
  const { manager, state, setState } = useRemirror({
15
- extensions: Extensions,
34
+ extensions: createExtensions(useContext(EditorContext)),
16
35
  content,
17
36
  selection: 'start',
18
37
  stringHandler: 'html',
@@ -25,7 +44,7 @@ const Editor = ({ content, editable, onChange }: EditorProps) => {
25
44
 
26
45
  return (
27
46
  <div className="squiz-fte-scope">
28
- <div className="remirror-theme formatted-text-editor editor-wrapper">
47
+ <div className={clsx('remirror-theme formatted-text-editor', !editable && 'formatted-text-editor--is-disabled')}>
29
48
  <Remirror
30
49
  manager={manager}
31
50
  state={state}
@@ -34,9 +53,9 @@ const Editor = ({ content, editable, onChange }: EditorProps) => {
34
53
  placeholder="Write something"
35
54
  label="Text editor"
36
55
  >
37
- <Toolbar />
38
- <EditorComponent />
39
- <FloatingToolbar />
56
+ {editable && <Toolbar />}
57
+ <WrappedEditor />
58
+ {editable && <FloatingToolbar />}
40
59
  </Remirror>
41
60
  </div>
42
61
  </div>