Merge branch 'development'

Author: Bohdan-Chui

CHANGELOG.md

@@ -1,5 +1,11 @@
 # WProofreader plugin for CKEditor 5 Changelog
 
+# 3.1.0 - 2024-07-19
+
+* Add basic TypeScript support. [#76](https://github.com/WebSpellChecker/wproofreader-ckeditor5/issues/76).
+* Enable 'Proofread in dialog' for multi-root and real-time collaboration modes. [#78](https://github.com/WebSpellChecker/wproofreader-ckeditor5/issues/78).
+* Internal changes (updated dependencies, documentation, etc.).
+
 ## 3.0.0 – 2024-06-26
 
 Provide support of the new [CKEditor 5 installation methods](https://github.com/ckeditor/ckeditor5/releases/tag/v42.0.0).

README.md

@@ -5,6 +5,8 @@ The multilingual spelling and grammar checking solution for CKEditor 5. It provi
 
 ![WProofreader plugin for CKEditor 5 View](https://webspellchecker.com/app/images/wproofreader_plugin_for_ckeditor5_v3.png)
 
+Starting with version 3.1.0, the WProofreader plugin for CKEditor 5 offers basic TypeScript support. The package contains a [type definition file](https://github.com/WebSpellChecker/wproofreader-ckeditor5/blob/master/src/wproofreader.d.ts) (.d.ts), enabling integration and customization of the functionality using [WProofreader options](https://webspellchecker.com/docs/api/wscbundle/Options.html) in TypeScript projects.
+
 WProofreader plugin for CKEditor 5 inherits all functionality of the WProofreader component with slight adaptation to the view and features of the editor. For more details, visit the [WProofreader repo](https://github.com/WebSpellChecker/wproofreader) or [official web page](https://webspellchecker.com/wsc-proofreader/).
 
 ## Table of contents

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@webspellchecker/wproofreader-ckeditor5",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Multilingual spelling and grammar checking plugin for CKEditor 5",
   "repository": {
     "type": "git",
@@ -23,7 +23,10 @@
   "main": "dist/index.js",
   "module": "dist/index.js",
   "exports": {
-    ".": "./dist/index.js",
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./dist/index.js"
+    },
     "./*.css": "./dist/*.css",
     "./src/*": "./src/*",
     "./theme/*": "./theme/*",
@@ -61,5 +64,6 @@
   },
   "peerDependencies": {
     "ckeditor5": ">=42.0.0"
-  }
+  },
+  "types": "./src/index.d.ts"
 }

package.json

@@ -1,16 +1,14 @@
-import {
-	ClassicEditor as ClassicEditorBase,
-	Essentials,
-	Paragraph,
-	Heading,
-	List,
-	Bold,
-	Italic
-} from 'ckeditor5';
+import { ClassicEditor as ClassicEditorBase } from '@ckeditor/ckeditor5-editor-classic';
+import { Essentials } from '@ckeditor/ckeditor5-essentials';
+import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
+import { Heading } from '@ckeditor/ckeditor5-heading';
+import { List } from '@ckeditor/ckeditor5-list';
+import { Bold } from '@ckeditor/ckeditor5-basic-styles';
+import { Italic } from '@ckeditor/ckeditor5-basic-styles';
 
 import 'ckeditor5/ckeditor5.css'
 
-import { WProofreader } from '../dist/index.js';
+import { WProofreader } from '../src/index.js';
 
 export default class ClassicEditor extends ClassicEditorBase {}
 

samples/app.js

@@ -1,17 +1,15 @@
-import {
-	MultiRootEditor,
-	Essentials,
-	Paragraph,
-	Heading,
-	List,
-	Bold,
-	Italic,
-	Image
-} from 'ckeditor5';
+import { MultiRootEditor } from '@ckeditor/ckeditor5-editor-multi-root';
+import { Essentials } from '@ckeditor/ckeditor5-essentials';
+import { Paragraph } from '@ckeditor/ckeditor5-paragraph';
+import { Heading } from '@ckeditor/ckeditor5-heading';
+import { List } from '@ckeditor/ckeditor5-list';
+import { Bold } from '@ckeditor/ckeditor5-basic-styles';
+import { Italic } from '@ckeditor/ckeditor5-basic-styles';
+import { Image } from '@ckeditor/ckeditor5-image';
 
 import 'ckeditor5/ckeditor5.css'
 
-import { WProofreader } from '../../dist/index.js';
+import { WProofreader } from '../../src/index.js';
 
 export default class MultirootEditor extends MultiRootEditor {}
 

samples/multi-root-editor/app.js

@@ -0,0 +1,9 @@
+import { Plugin } from '@ckeditor/ckeditor5-core';
+
+export class WProofreader extends Plugin {}
+
+declare module '@ckeditor/ckeditor5-core' {
+	interface EditorConfig {
+		wproofreader?: Object;
+	}
+}

src/index.d.ts

@@ -41,13 +41,6 @@ export default class WProofreader extends Plugin {
 
 		this._instances = [];
 
-		this._collaborationPluginNames = [
-			'RealTimeCollaborativeEditing',
-			'RealTimeCollaborativeTrackChanges',
-			'RealTimeCollaborativeComments',
-			'RealTimeCollaborationClient'
-		];
-
 		this._restrictedEditingName = 'RestrictedEditingMode';
 	}
 
@@ -191,34 +184,10 @@ export default class WProofreader extends Plugin {
 	 * @private
 	 */
 	_setFields() {
-		this._isMultiRoot = this._checkMultiRoot();
-		this._isCollaborationMode = this._checkCollaborationMode();
 		this._isRestrictedEditingMode = this._checkRestrictedEditingMode();
 		this._options = this._createOptions();
 	}
 
-	/**
-	 * Checks if the current editor has several roots.
-	 * @private
-	 */
-	_checkMultiRoot() {
-		return this.editor.editing.view.domRoots.size > 1 ? true : false;
-	}
-
-	/**
-	 * Checks if the current editor in the real-time collaboration mode.
-	 * @private
-	 */
-	_checkCollaborationMode() {
-		for (let i = 0; i <= this._collaborationPluginNames.length; i++) {
-			if (this.editor.plugins.has(this._collaborationPluginNames[i])) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
 	/**
 	 * Checks if the current editor in the restricted editing mode.
 	 * @private
@@ -234,7 +203,6 @@ export default class WProofreader extends Plugin {
 	_createOptions() {
 		return {
 			appType: 'proofreader_ck5',
-			disableDialog: this._isMultiRoot || this._isCollaborationMode,
 			restrictedEditingMode: this._isRestrictedEditingMode,
 			disableBadgePulsing: true,
 			onCommitOptions: this._onCommitOptions.bind(this),

src/wproofreader.js

@@ -2,10 +2,6 @@ import { ClassicEditor } from '@ckeditor/ckeditor5-editor-classic';
 import WProofreader from '../src/wproofreader.js';
 import WProofreaderEditing from '../src/wproofreaderediting.js';
 import WProofreaderUI from '../src/wproofreaderui.js';
-import { RealTimeCollaborativeEditing } from './mocks/mock-collaboration-editing.js';
-import { RealTimeCollaborativeTrackChanges } from './mocks/mock-collaboration-editing.js';
-import { RealTimeCollaborativeComments } from './mocks/mock-collaboration-editing.js';
-import { RealTimeCollaborationClient } from './mocks/mock-collaboration-editing.js';
 import { RestrictedEditingMode } from './mocks/mock-restricted-editing-mode.js';
 
 describe('WProofreader', () => {
@@ -77,10 +73,6 @@ describe('WProofreader', () => {
 			expect(wproofreader._options.appType).to.be.equal('proofreader_ck5');
 		});
 
-		it('should not disable dialog option', () => {
-			expect(wproofreader._options.disableDialog).to.be.false;
-		});
-
 		it('should contain restrictedEditingMode option', () => {
 			expect(wproofreader._options.restrictedEditingMode).to.be.false;
 		});
@@ -462,87 +454,6 @@ describe('WProofreader', () => {
 		});
 	});
 
-	describe('in CKEditor 5 collaboration mode', () => {
-		it('should disable the dialog option of the WEBSPELLCHECKER because of RealTimeCollaborativeEditing plugin', () => {
-			return ClassicEditor
-				.create(element, {
-					plugins: [WProofreader, RealTimeCollaborativeEditing],
-					wproofreader: WPROOFREADER_CONFIG
-				})
-				.then((editor) => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(editor.plugins.has('RealTimeCollaborativeEditing')).to.be.true;
-					expect(wproofreader._options.disableDialog).to.be.true;
-				});
-		});
-
-		it('should disable the dialog option of the WEBSPELLCHECKER because of RealTimeCollaborativeTrackChanges plugin', () => {
-			return ClassicEditor
-				.create(element, {
-					plugins: [WProofreader, RealTimeCollaborativeTrackChanges],
-					wproofreader: WPROOFREADER_CONFIG
-				})
-				.then((editor) => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(editor.plugins.has('RealTimeCollaborativeTrackChanges')).to.be.true;
-					expect(wproofreader._options.disableDialog).to.be.true;
-				});
-		});
-
-		it('should disable the dialog option of the WEBSPELLCHECKER because of RealTimeCollaborativeComments plugin', () => {
-			return ClassicEditor
-				.create(element, {
-					plugins: [WProofreader, RealTimeCollaborativeComments],
-					wproofreader: WPROOFREADER_CONFIG
-				})
-				.then((editor) => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(editor.plugins.has('RealTimeCollaborativeComments')).to.be.true;
-					expect(wproofreader._options.disableDialog).to.be.true;
-				});
-		});
-
-		it('should disable the dialog option of the WEBSPELLCHECKER because of RealTimeCollaborationClient plugin', () => {
-			return ClassicEditor
-				.create(element, {
-					plugins: [WProofreader, RealTimeCollaborationClient],
-					wproofreader: WPROOFREADER_CONFIG
-				})
-				.then((editor) => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(editor.plugins.has('RealTimeCollaborationClient')).to.be.true;
-					expect(wproofreader._options.disableDialog).to.be.true;
-				});
-		});
-
-		it('should disable the dialog option of the WEBSPELLCHECKER because of collaboration plugins', () => {
-			return ClassicEditor
-				.create(element, {
-					plugins: [
-						WProofreader,
-						RealTimeCollaborativeEditing,
-						RealTimeCollaborativeTrackChanges,
-						RealTimeCollaborativeComments,
-						RealTimeCollaborationClient
-					],
-					wproofreader: WPROOFREADER_CONFIG
-				})
-				.then((editor) => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(editor.plugins.has('RealTimeCollaborativeEditing')).to.be.true;
-					expect(editor.plugins.has('RealTimeCollaborativeTrackChanges')).to.be.true;
-					expect(editor.plugins.has('RealTimeCollaborativeComments')).to.be.true;
-					expect(editor.plugins.has('RealTimeCollaborationClient')).to.be.true;
-					expect(wproofreader._options.disableDialog).to.be.true;
-				});
-		});
-	});
-
 	describe('in CKEditor 5 restricted editing mode', () => {
 		it('should enable the restrictedEditingMode option of the WEBSPELLCHECKER because of RestrictedEditingMode plugin', () => {
 			return ClassicEditor
@@ -560,44 +471,6 @@ describe('WProofreader', () => {
 	});
 
 	describe('for multi root environment', () => {
-		it('should disable the dialog option of the WEBSPELLCHECKER', () => {
-			const editor = new ClassicEditor(element, {
-				plugins: [WProofreader],
-				wproofreader: WPROOFREADER_CONFIG
-			});
-
-			editor.editing.view.domRoots.set('main', element);
-			editor.editing.view.domRoots.set('second', element);
-
-			return editor.initPlugins()
-				.then(() => {
-					editor.ui.init(element);
-					editor.data.init(element);
-
-					editor.fire('ready');
-
-					return editor;
-				})
-				.then(() => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(wproofreader._options.disableDialog).to.be.true;
-				});
-		});
-
-		it('should not disable the dialog option of the WEBSPELLCHECKER', () => {
-			return ClassicEditor
-				.create(element, {
-					plugins: [WProofreader],
-					wproofreader: WPROOFREADER_CONFIG
-				})
-				.then((editor) => {
-					const wproofreader = editor.plugins.get('WProofreader');
-
-					expect(wproofreader._options.disableDialog).to.be.false;
-				});
-		});
-
 		describe('should synchronize WEBSPELLCHECKER options in the editor with', () => {
 			let editor;