@zipify/wysiwyg 1.0.0-dev.3 → 1.0.0-dev.32

package/lib/extensions/core/__tests__/TextProcessor.test.js

@@ -1,26 +1,120 @@
-import { Editor, Mark } from '@tiptap/vue-2';
+import { Editor, Mark, Extension } from '@tiptap/vue-2';
 import { NodeFactory } from '../../../__tests__/utils';
-import { CORE_EXTENSIONS } from '../index';
+import { ContentNormalizer } from '../../../services';
+import { NodeTypes, TextSettings } from '../../../enums';
+import { buildCoreExtensions } from '../index';
+
+const MockFontSize = Mark.create({
+    name: TextSettings.FONT_SIZE,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
+
+    renderHTML: () => ['span', {}, 0]
+});
 
 const MockFontWeight = Mark.create({
-    name: 'font_weight',
+    name: TextSettings.FONT_WEIGHT,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
+
+    renderHTML: () => ['span', {}, 0]
+});
+
+const MockAlignment = Extension.create({
+    name: TextSettings.ALIGNMENT,
+
+    addGlobalAttributes: () => [
+        {
+            types: [NodeTypes.PARAGRAPH, NodeTypes.HEADING],
+            attributes: {
+                [TextSettings.ALIGNMENT]: {
+                    default: null,
+                    renderHTML: () => ({})
+                }
+            }
+        }
+    ]
+});
+
+const MockBackgroundColor = Mark.create({
+    name: TextSettings.BACKGROUND_COLOR,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
+
+    renderHTML: () => ['span', {}, 0]
+});
+
+const MockFontColor = Mark.create({
+    name: TextSettings.FONT_COLOR,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
+
+    renderHTML: () => ['span', {}, 0]
+});
+
+const MockFontFamily = Mark.create({
+    name: TextSettings.FONT_FAMILY,
 
     addAttributes: () => ({
-        value: { required: true }
+        value: { default: null }
     }),
 
-    renderHTML(context) {
-        const { value } = context.HTMLAttributes;
+    renderHTML: () => ['span', {}, 0]
+});
+
+const MockFontStyle = Mark.create({
+    name: TextSettings.FONT_STYLE,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
 
-        return ['span', { style: `font-weight: ${value}` }, 0];
-    }
+    renderHTML: () => ['span', {}, 0]
+});
+
+const MockTextDecoration = Mark.create({
+    name: TextSettings.TEXT_DECORATION,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
+
+    renderHTML: () => ['span', {}, 0]
+});
+
+const MockSuperscript = Mark.create({
+    name: TextSettings.SUPERSCRIPT,
+
+    addAttributes: () => ({
+        value: { default: null }
+    }),
+
+    renderHTML: () => ['span', {}, 0]
 });
 
 function createEditor({ content }) {
     return new Editor({
-        content,
+        content: ContentNormalizer.normalize(content),
         element: document.createElement('div'),
-        extensions: CORE_EXTENSIONS.concat(MockFontWeight)
+        extensions: buildCoreExtensions().concat(
+            MockFontSize,
+            MockFontWeight,
+            MockAlignment,
+            MockBackgroundColor,
+            MockFontColor,
+            MockFontFamily,
+            MockFontStyle,
+            MockTextDecoration,
+            MockSuperscript
+        )
     });
 }
 
@@ -59,3 +153,38 @@ describe('transform text', () => {
         expect(editor.getJSON()).toMatchSnapshot();
     });
 });
+
+describe('selected text', () => {
+    test('should return selected text', () => {
+        const editor = createEditor({
+            content: NodeFactory.doc([
+                NodeFactory.paragraph('hello world')
+            ])
+        });
+
+        editor.commands.setTextSelection({ from: 5, to: 11 });
+
+        expect(editor.commands.getSelectedText()).toEqual('o worl');
+    });
+});
+
+describe('unset marks', () => {
+    test('should reset all marks', () => {
+        const editor = createEditor({
+            content: NodeFactory.doc([
+                NodeFactory.paragraph([
+                    NodeFactory.text('hello world', [
+                        NodeFactory.mark('font_weight', { value: '700' })
+                    ])
+                ])
+            ])
+        });
+
+        editor.chain()
+            .selectAll()
+            .unsetMarks(TextSettings.marks)
+            .run();
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+});

package/lib/extensions/core/__tests__/__snapshots__/TextProcessor.test.js.snap

@@ -4,6 +4,9 @@ exports[`transform text should keep text marks 1`] = `
 Object {
   "content": Array [
     Object {
+      "attrs": Object {
+        "alignment": null,
+      },
       "content": Array [
         Object {
           "marks": Array [
@@ -29,6 +32,9 @@ exports[`transform text should transform selected text 1`] = `
 Object {
   "content": Array [
     Object {
+      "attrs": Object {
+        "alignment": null,
+      },
       "content": Array [
         Object {
           "text": "hELLO world",
@@ -41,3 +47,23 @@ Object {
   "type": "doc",
 }
 `;
+
+exports[`unset marks should reset all marks 1`] = `
+Object {
+  "content": Array [
+    Object {
+      "attrs": Object {
+        "alignment": null,
+      },
+      "content": Array [
+        Object {
+          "text": "hello world",
+          "type": "text",
+        },
+      ],
+      "type": "paragraph",
+    },
+  ],
+  "type": "doc",
+}
+`;

package/lib/extensions/core/index.js

@@ -1,17 +1,26 @@
 import Document from '@tiptap/extension-document';
 import Paragraph from '@tiptap/extension-paragraph';
 import Text from '@tiptap/extension-text';
+import Placeholder from '@tiptap/extension-placeholder';
+import History from '@tiptap/extension-history';
 import { NodeProcessor } from './NodeProcessor';
 import { TextProcessor } from './TextProcessor';
 import { SelectionProcessor } from './SelectionProcessor';
+import { CopyPasteProcessor } from './CopyPasteProcessor';
 
-export const CORE_EXTENSIONS = [
+export const buildCoreExtensions = () => [
     Document,
     Paragraph.configure({
         HTMLAttributes: { class: 'zw-style' }
     }),
     Text,
+    Placeholder.configure({
+        placeholder: 'Type your text here...',
+        emptyNodeClass: 'zw-wysiwyg__placeholder'
+    }),
+    History,
     NodeProcessor,
     TextProcessor,
-    SelectionProcessor
+    SelectionProcessor,
+    CopyPasteProcessor
 ];

package/lib/extensions/core/plugins/PastePlugin.js

@@ -0,0 +1,48 @@
+import { ContentNormalizer } from '../../../services';
+import { ProseMirrorPlugin } from './ProseMirrorPlugin';
+
+export class PastePlugin extends ProseMirrorPlugin {
+    buildProps() {
+        return {
+            transformPastedHTML: ContentNormalizer.normalize,
+            handlePaste: this._handlePaste.bind(this)
+        };
+    }
+
+    _handlePaste(view, _, slice) {
+        const transaction = this._insertPastedContent(view, slice)
+            .scrollIntoView()
+            .setMeta('paste', true)
+            .setMeta('uiEvent', 'paste');
+
+        view.dispatch(transaction);
+
+        return true;
+    }
+
+    _insertPastedContent({ state, input }, slice) {
+        if (!this._isSingleNode(slice)) {
+            return state.tr.replaceSelection(slice);
+        }
+
+        const { $from, $to } = state.selection;
+        const isSingleNodeReplacing = $from.sharedDepth($to.pos) === $from.depth;
+
+        if (!isSingleNodeReplacing) {
+            return state.tr.replaceSelection(slice);
+        }
+
+        const selectionSize = Math.abs($from.pos - $to.pos);
+        const { nodeSize } = $to.path.reverse().find((step) => typeof step === 'object');
+
+        if (nodeSize - selectionSize > 5) {
+            return state.tr.replaceSelection(slice);
+        }
+
+        return state.tr.replaceSelectionWith(slice.content.firstChild, input.shiftKey);
+    }
+
+    _isSingleNode({ openStart, openEnd, content }) {
+        return openStart === 1 && openEnd === 1 && content.childCount === 1;
+    }
+}

package/lib/extensions/core/plugins/ProseMirrorPlugin.js

@@ -0,0 +1,20 @@
+import { Plugin, PluginKey } from 'prosemirror-state';
+
+export class ProseMirrorPlugin {
+    static create(options) {
+        const plugin = new this(options || {});
+
+        return new Plugin({
+            key: new PluginKey(this.name),
+            props: plugin.buildProps()
+        });
+    }
+
+    constructor(options) {
+        this.options = options;
+    }
+
+    buildProps() {
+        return {};
+    }
+}

package/lib/extensions/core/plugins/index.js

@@ -0,0 +1 @@
+export { PastePlugin } from './PastePlugin';

package/lib/extensions/index.js

@@ -1,5 +1,3 @@
-import History from '@tiptap/extension-history';
-import { CORE_EXTENSIONS } from './core';
 import { FontFamily } from './FontFamily';
 import { StylePreset } from './StylePreset';
 import { FontWeight } from './FontWeight';
@@ -13,37 +11,47 @@ import { CaseStyle } from './CaseStyle';
 import { Alignment } from './Alignment';
 import { LineHeight } from './LineHeight';
 import { List } from './list';
+import { Link } from './Link';
 import { Superscript } from './Superscript';
+import { buildCoreExtensions } from './core';
 
-export { CORE_EXTENSIONS };
+export function buildExtensions(options) {
+    const getPresetById = (id) => options.presetsRef.value.find((preset) => preset.id === id);
+    const defaultPreset = getPresetById(options.defaultPresetId);
 
-export const getExtensions = (options) => CORE_EXTENSIONS.concat([
-    History,
-    StylePreset.configure({
-        presetsRef: options.presetsRef,
-        defaultId: options.defaultPresetId,
-        makeVariable: options.makePresetVariable
-    }),
-    List.configure({
-        baseClass: options.baseListClass
-    }),
-    DeviceManager.configure({
-        deviceRef: options.deviceRef
-    }),
-    FontFamily.configure({
-        fonts: options.fonts
-    }),
-    FontWeight,
-    FontSize.configure({
-        minSize: options.minFontSize,
-        maxSize: options.maxFontSize
-    }),
-    FontColor,
-    BackgroundColor,
-    FontStyle,
-    TextDecoration,
-    CaseStyle,
-    Superscript,
-    Alignment,
-    LineHeight
-]);
+    return buildCoreExtensions(options).concat([
+        StylePreset.configure({
+            presetsRef: options.presetsRef,
+            defaultId: options.defaultPresetId,
+            baseClass: options.basePresetClass,
+            makeVariable: options.makePresetVariable
+        }),
+        List.configure({
+            baseClass: options.baseListClass
+        }),
+        DeviceManager.configure({
+            deviceRef: options.deviceRef
+        }),
+        FontFamily.configure({
+            fonts: options.fonts,
+            defaultFont: defaultPreset.common.font_family
+        }),
+        FontWeight,
+        FontSize.configure({
+            minSize: options.minFontSize,
+            maxSize: options.maxFontSize
+        }),
+        FontColor,
+        BackgroundColor,
+        FontStyle,
+        TextDecoration,
+        CaseStyle,
+        Superscript,
+        Alignment,
+        LineHeight,
+        Link.configure({
+            preset: options.linkPreset,
+            basePresetClass: options.basePresetClass,
+            pageBlocks: options.pageBlocks
+        })]);
+}

package/lib/extensions/list/List.js

@@ -21,6 +21,40 @@ export const List = Node.create({
         bullet: { isRequired: true }
     }),
 
+    parseHTML() {
+        const HTML_TYPES = {
+            a: ListTypes.ROMAN,
+            i: ListTypes.LATIN,
+            '1': ListTypes.DECIMAL
+        };
+
+        const getBulletType = (element) => {
+            for (const type of ListTypes.values) {
+                const bulletClass = `.${this.options.baseClass}${type}`;
+
+                if (element.matches(bulletClass)) return type;
+                if (HTML_TYPES[element.type.toLowerCase()] === type) return type;
+            }
+        };
+
+        return [
+            {
+                tag: 'ol',
+
+                getAttrs: (element) => ({
+                    bullet: { type: getBulletType(element) || ListTypes.DECIMAL }
+                })
+            },
+            {
+                tag: 'ul',
+
+                getAttrs: (element) => ({
+                    bullet: { type: getBulletType(element) || ListTypes.DISC }
+                })
+            }
+        ];
+    },
+
     renderHTML({ HTMLAttributes: attrs }) {
         const isOrdered = ListTypes.ordered.includes(attrs.bullet.type);
         const tag = isOrdered ? 'ol' : 'ul';

package/lib/extensions/list/__tests__/List.test.js

@@ -2,16 +2,19 @@ import { Editor } from '@tiptap/vue-2';
 import { ref } from '@vue/composition-api';
 import { NodeFactory } from '../../../__tests__/utils';
 import { ListTypes } from '../../../enums';
-import { CORE_EXTENSIONS } from '../../core';
 import { StylePreset } from '../../StylePreset';
 import { List } from '../List';
+import { ContentNormalizer } from '../../../services';
+import { buildCoreExtensions } from '../../core';
 
 function createEditor({ content }) {
     return new Editor({
-        content,
+        content: ContentNormalizer.normalize(content),
         element: document.createElement('div'),
-        extensions: CORE_EXTENSIONS.concat(
-            List,
+        extensions: buildCoreExtensions().concat(
+            List.configure({
+                baseClass: 'zw-list--'
+            }),
             StylePreset.configure({
                 presetsRef: ref([
                     {
@@ -22,7 +25,8 @@ function createEditor({ content }) {
                         desktop: {}
                     }
                 ]),
-                defaultId: 'regular-1'
+                defaultId: 'regular-1',
+                baseClass: 'zw ts-'
             })
         )
     });
@@ -128,3 +132,109 @@ describe('apply list', () => {
         expect(editor.getJSON()).toMatchSnapshot();
     });
 });
+
+describe('parsing html', () => {
+    test('should parse disc type by class', () => {
+        const editor = createEditor({
+            content: '<ul class="zw-list--disc"><li>lorem ipsum</li></ul>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse disc as default', () => {
+        const editor = createEditor({
+            content: '<ul><li>lorem ipsum</li></ul>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse circle type by class', () => {
+        const editor = createEditor({
+            content: '<ul class="zw-list--circle"><li>lorem ipsum</li></ul>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse square type by class', () => {
+        const editor = createEditor({
+            content: '<ul class="zw-list--square"><li>lorem ipsum</li></ul>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse decimal type by class', () => {
+        const editor = createEditor({
+            content: '<ol class="zw-list--decimal"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse decimal as default', () => {
+        const editor = createEditor({
+            content: '<ol><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse decimal type by attribute', () => {
+        const editor = createEditor({
+            content: '<ol type="1"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse roman type by class', () => {
+        const editor = createEditor({
+            content: '<ol class="zw-list--roman"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse roman type by lower attribute', () => {
+        const editor = createEditor({
+            content: '<ol type="a"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse roman type by upper attribute', () => {
+        const editor = createEditor({
+            content: '<ol type="A"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse latin type by class', () => {
+        const editor = createEditor({
+            content: '<ol class="zw-list--latin"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse latin type by lower attribute', () => {
+        const editor = createEditor({
+            content: '<ol type="i"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+
+    test('should parse latin type by upper attribute', () => {
+        const editor = createEditor({
+            content: '<ol type="I"><li>lorem ipsum</li></ol>'
+        });
+
+        expect(editor.getJSON()).toMatchSnapshot();
+    });
+});