@ckeditor/ckeditor5-word-count 37.0.0-alpha.0 → 37.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-word-count",
-  "version": "37.0.0-alpha.0",
+  "version": "37.0.0-alpha.1",
   "description": "Word and character count feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,23 +13,23 @@
   "main": "src/index.js",
   "dependencies": {
     "lodash-es": "^4.17.15",
-    "ckeditor5": "^37.0.0-alpha.0"
+    "ckeditor5": "^37.0.0-alpha.1"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-list": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-dev-utils": "^35.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-list": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.1",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.1",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -58,7 +58,7 @@
   ],
   "scripts": {
     "dll:build": "webpack",
-    "build": "tsc -p ./tsconfig.release.json",
+    "build": "tsc -p ./tsconfig.json",
     "postversion": "npm run build"
   },
   "types": "src/index.d.ts"

package/src/augmentation.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { WordCount, WordCountConfig } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the word count feature.
+         * It is introduced by the {@link module:word-count/wordcount~WordCount} feature.
+         *
+         * Read more in {@link module:word-count/wordcountconfig~WordCountConfig}.
+         */
+        wordCount?: WordCountConfig;
+    }
+    interface PluginsMap {
+        [WordCount.pluginName]: WordCount;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};

package/src/index.d.ts

@@ -6,3 +6,5 @@
  * @module word-count
  */
 export { default as WordCount, type WordCountUpdateEvent } from './wordcount';
+export { WordCountConfig } from './wordcountconfig';
+import './augmentation';

package/src/index.js

@@ -6,3 +6,4 @@
  * @module word-count
  */
 export { default as WordCount } from './wordcount';
+import './augmentation';

package/src/wordcount.d.ts

@@ -121,9 +121,9 @@ export default class WordCount extends Plugin {
     private _refreshStats;
 }
 /**
- * An event fired after {@link #words} and {@link #characters} are updated.
+ * An event fired after {@link ~WordCount#words} and {@link ~WordCount#characters} are updated.
  *
- * @eventName update
+ * @eventName ~WordCount#update
  */
 export type WordCountUpdateEvent = {
     name: 'update';
@@ -132,102 +132,3 @@ export type WordCountUpdateEvent = {
         characters: number;
     }];
 };
-/**
- * The configuration of the word count feature.
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		wordCount: ... // Word count feature configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface WordCountConfig {
-    /**
-     * This option allows for hiding the word counter. The element obtained through
-     * {@link module:word-count/wordcount~WordCount#wordCountContainer} will only preserve
-     * the characters part. Word counter is displayed by default when this configuration option is not defined.
-     *
-     * ```ts
-     * const wordCountConfig = {
-     * 	displayWords: false
-     * };
-     * ```
-     *
-     * The configuration above will result in the following container:
-     *
-     * ```html
-     * <div class="ck ck-word-count">
-     * 	<div class="ck-word-count__characters">Characters: 28</div>
-     * </div>
-     * ```
-     */
-    displayWords?: boolean;
-    /**
-     * This option allows for hiding the character counter. The element obtained through
-     * {@link module:word-count/wordcount~WordCount#wordCountContainer} will only preserve
-     * the words part. Character counter is displayed by default when this configuration option is not defined.
-     *
-     * ```ts
-     * const wordCountConfig = {
-     * 	displayCharacters: false
-     * };
-     * ```
-     *
-     * The configuration above will result in the following container:
-     *
-     * ```html
-     * <div class="ck ck-word-count">
-     * 	<div class="ck-word-count__words">Words: 4</div>
-     * </div>
-     * ```
-     */
-    displayCharacters?: boolean;
-    /**
-     * This configuration takes a function that is executed whenever the word count plugin updates its values.
-     * This function is called with one argument, which is an object with the `words` and `characters` keys containing
-     * the number of detected words and characters in the document.
-     *
-     * ```ts
-     * const wordCountConfig = {
-     * 	onUpdate: function( stats ) {
-     * 		doSthWithWordNumber( stats.words );
-     * 		doSthWithCharacterNumber( stats.characters );
-     * 	}
-     * };
-     * ```
-     */
-    onUpdate?: (data: {
-        words: number;
-        characters: number;
-    }) => void;
-    /**
-     * Allows for providing the HTML element that the
-     * {@link module:word-count/wordcount~WordCount#wordCountContainer word count container} will be appended to automatically.
-     *
-     * ```ts
-     * const wordCountConfig = {
-     * 	container: document.getElementById( 'container-for-word-count' );
-     * };
-     * ```
-     */
-    container?: HTMLElement;
-}
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [WordCount.pluginName]: WordCount;
-    }
-    interface EditorConfig {
-        /**
-         * The configuration of the word count feature.
-         * It is introduced by the {@link module:word-count/wordcount~WordCount} feature.
-         *
-         * Read more in {@link module:word-count/wordcount~WordCountConfig}.
-         */
-        wordCount?: WordCountConfig;
-    }
-}

package/src/wordcountconfig.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module word-count/wordcountconfig
+ */
+/**
+ * The configuration of the word count feature.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( {
+ * 		wordCount: ... // Word count feature configuration.
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface WordCountConfig {
+    /**
+     * This option allows for hiding the word counter. The element obtained through
+     * {@link module:word-count/wordcount~WordCount#wordCountContainer} will only preserve
+     * the characters part. Word counter is displayed by default when this configuration option is not defined.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	displayWords: false
+     * };
+     * ```
+     *
+     * The configuration above will result in the following container:
+     *
+     * ```html
+     * <div class="ck ck-word-count">
+     * 	<div class="ck-word-count__characters">Characters: 28</div>
+     * </div>
+     * ```
+     */
+    displayWords?: boolean;
+    /**
+     * This option allows for hiding the character counter. The element obtained through
+     * {@link module:word-count/wordcount~WordCount#wordCountContainer} will only preserve
+     * the words part. Character counter is displayed by default when this configuration option is not defined.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	displayCharacters: false
+     * };
+     * ```
+     *
+     * The configuration above will result in the following container:
+     *
+     * ```html
+     * <div class="ck ck-word-count">
+     * 	<div class="ck-word-count__words">Words: 4</div>
+     * </div>
+     * ```
+     */
+    displayCharacters?: boolean;
+    /**
+     * This configuration takes a function that is executed whenever the word count plugin updates its values.
+     * This function is called with one argument, which is an object with the `words` and `characters` keys containing
+     * the number of detected words and characters in the document.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	onUpdate: function( stats ) {
+     * 		doSthWithWordNumber( stats.words );
+     * 		doSthWithCharacterNumber( stats.characters );
+     * 	}
+     * };
+     * ```
+     */
+    onUpdate?: (data: {
+        words: number;
+        characters: number;
+    }) => void;
+    /**
+     * Allows for providing the HTML element that the
+     * {@link module:word-count/wordcount~WordCount#wordCountContainer word count container} will be appended to automatically.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	container: document.getElementById( 'container-for-word-count' );
+     * };
+     * ```
+     */
+    container?: HTMLElement;
+}

package/src/wordcountconfig.js

@@ -0,0 +1,5 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+export {};