@ckeditor/ckeditor5-utils 37.0.0-alpha.0 → 37.0.0-alpha.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "37.0.0-alpha.0",
+  "version": "37.0.0-alpha.2",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -14,10 +14,10 @@
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-build-classic": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
-    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-build-classic": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.2",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.2",
     "@types/lodash-es": "^4.17.6",
     "typescript": "^4.8.4"
   },
@@ -46,7 +46,7 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "build": "tsc -p ./tsconfig.release.json",
+    "build": "tsc -p ./tsconfig.json",
     "postversion": "npm run build"
   },
   "types": "src/index.d.ts"

package/src/collection.d.ts

@@ -356,7 +356,7 @@ export default class Collection<T extends Record<string, any>> extends Collectio
 /**
  * Fired when an item is added to the collection.
  *
- * @eventName add
+ * @eventName ~Collection#add
  * @param item The added item.
  * @param index An index where the addition occurred.
  */
@@ -367,7 +367,7 @@ export type CollectionAddEvent<T = any> = {
 /**
  * Fired when the collection was changed due to adding or removing items.
  *
- * @eventName change
+ * @eventName ~Collection#change
  * @param data Changed items.
  */
 export type CollectionChangeEvent<T = any> = {
@@ -394,7 +394,7 @@ export type CollectionChangeEventData<T = any> = {
 /**
  * Fired when an item is removed from the collection.
  *
- * @eventName remove
+ * @eventName ~Collection#remove
  * @param item The removed item.
  * @param index Index from which item was removed.
  */

package/src/dom/createelement.d.ts

@@ -28,6 +28,7 @@ type ChildrenElements = Node | string | Iterable<Node | string>;
  * createElement( document, 'p', null, [ createElement(...) ] ); // <p><...></p>
  * ```
  *
+ * @label HTML_ELEMENT
  * @param doc Document used to create the element.
  * @param name Name of the HTML element.
  * @param attributes Object where keys represent attribute keys and values represent attribute values.
@@ -45,6 +46,7 @@ export default function createElement<T extends keyof HTMLElementTagNameMap>(doc
  * createElement( document, 'mask', { xmlns: 'http://www.w3.org/2000/svg' }, [ createElement(...) ] ); // <mask><...></mask>
  * ```
  *
+ * @label SVG_ELEMENT
  * @param doc Document used to create the element.
  * @param name Name of the SVG element.
  * @param attributes Object where keys represent attribute keys and values represent attribute values.

package/src/dom/findclosestscrollableancestor.d.ts

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module utils/dom/findClosestScrollableAncestor
+ * @module utils/dom/findclosestscrollableancestor
  */
 /**
  * Returns the closest scrollable ancestor of a DOM element.

package/src/dom/findclosestscrollableancestor.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
 /**
- * @module utils/dom/findClosestScrollableAncestor
+ * @module utils/dom/findclosestscrollableancestor
  */
 /**
  * Returns the closest scrollable ancestor of a DOM element.

package/src/index.d.ts

@@ -8,11 +8,12 @@
 export { default as env } from './env';
 export { default as diff, type DiffResult } from './diff';
 export { default as fastDiff } from './fastdiff';
+export { default as diffToChanges } from './difftochanges';
 export { default as mix } from './mix';
-export { Constructor, Mixed } from './mix';
-export { default as EmitterMixin, Emitter, type BaseEvent, type CallbackOptions, type EmitterMixinDelegateChain, type GetCallback, type GetCallbackOptions, type GetEventInfo, type GetNameOrEventInfo } from './emittermixin';
+export type { Constructor, Mixed } from './mix';
+export { default as EmitterMixin, type Emitter, type BaseEvent, type CallbackOptions, type EmitterMixinDelegateChain, type GetCallback, type GetCallbackOptions, type GetEventInfo, type GetNameOrEventInfo } from './emittermixin';
 export { default as EventInfo } from './eventinfo';
-export { default as ObservableMixin, Observable, type DecoratedMethodEvent, type ObservableChangeEvent, type ObservableSetEvent } from './observablemixin';
+export { default as ObservableMixin, type Observable, type DecoratedMethodEvent, type ObservableChangeEvent, type ObservableSetEvent } from './observablemixin';
 export { default as CKEditorError, logError, logWarning } from './ckeditorerror';
 export { default as ElementReplacer } from './elementreplacer';
 export { default as count } from './count';
@@ -20,7 +21,7 @@ export { default as compareArrays } from './comparearrays';
 export { default as createElement } from './dom/createelement';
 export { default as Config } from './config';
 export { default as isIterable } from './isiterable';
-export { default as DomEmitterMixin, DomEmitter } from './dom/emittermixin';
+export { default as DomEmitterMixin, type DomEmitter } from './dom/emittermixin';
 export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor';
 export { default as global } from './dom/global';
 export { default as getAncestors } from './dom/getancestors';
@@ -41,7 +42,7 @@ export { default as remove } from './dom/remove';
 export * from './dom/scroll';
 export * from './keyboard';
 export * from './language';
-export { default as Locale, LocaleTranslate } from './locale';
+export { default as Locale, type LocaleTranslate } from './locale';
 export { default as Collection, type CollectionAddEvent, type CollectionChangeEvent, type CollectionRemoveEvent } from './collection';
 export { default as first } from './first';
 export { default as FocusTracker } from './focustracker';

package/src/index.js

@@ -8,6 +8,7 @@
 export { default as env } from './env';
 export { default as diff } from './diff';
 export { default as fastDiff } from './fastdiff';
+export { default as diffToChanges } from './difftochanges';
 export { default as mix } from './mix';
 export { default as EmitterMixin } from './emittermixin';
 export { default as EventInfo } from './eventinfo';

package/src/keyboard.d.ts

@@ -27,9 +27,9 @@ export declare const keyCodes: {
 /**
  * Converts a key name or {@link module:utils/keyboard~KeystrokeInfo keystroke info} into a key code.
  *
- * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
+ * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
  *
- * @param key A key name (see {@link module:utils/keyboard~keyCodes}) or a keystroke data object.
+ * @param key A key name (see {@link module:utils/keyboard#keyCodes}) or a keystroke data object.
  * @returns Key or keystroke code.
  */
 export declare function getCode(key: string | Readonly<KeystrokeInfo>): number;
@@ -44,7 +44,7 @@ export declare function getCode(key: string | Readonly<KeystrokeInfo>): number;
  *   * `[ 'ctrl', 32 ]` (ctrl + space),
  *   * `[ 'ctrl', 'a' ]` (ctrl + A).
  *
- * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
+ * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
  *
  * Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
  *

package/src/keyboard.js

@@ -33,9 +33,9 @@ const keyCodeNames = Object.fromEntries(Object.entries(keyCodes).map(([name, cod
 /**
  * Converts a key name or {@link module:utils/keyboard~KeystrokeInfo keystroke info} into a key code.
  *
- * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
+ * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
  *
- * @param key A key name (see {@link module:utils/keyboard~keyCodes}) or a keystroke data object.
+ * @param key A key name (see {@link module:utils/keyboard#keyCodes}) or a keystroke data object.
  * @returns Key or keystroke code.
  */
 export function getCode(key) {
@@ -44,7 +44,7 @@ export function getCode(key) {
         keyCode = keyCodes[key.toLowerCase()];
         if (!keyCode) {
             /**
-             * Unknown key name. Only key names included in the {@link module:utils/keyboard~keyCodes} can be used.
+             * Unknown key name. Only key names included in the {@link module:utils/keyboard#keyCodes} can be used.
              *
              * @error keyboard-unknown-key
              * @param {String} key
@@ -72,7 +72,7 @@ export function getCode(key) {
  *   * `[ 'ctrl', 32 ]` (ctrl + space),
  *   * `[ 'ctrl', 'a' ]` (ctrl + A).
  *
- * Note: Key names are matched with {@link module:utils/keyboard~keyCodes} in a case-insensitive way.
+ * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
  *
  * Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
  *
@@ -152,7 +152,7 @@ export function getLocalizedArrowKeyCodeDirection(keyCode, contentLanguageDirect
  *
  * See: {@link module:utils/keyboard~getCode}.
  *
- * @param key The key name (see {@link module:utils/keyboard~keyCodes}).
+ * @param key The key name (see {@link module:utils/keyboard#keyCodes}).
  * @returns Key code.
  */
 function getEnvKeyCode(key) {

package/src/observablemixin.d.ts

@@ -441,7 +441,7 @@ export interface Observable extends Emitter {
  * observable.prop = 2; // -> 'prop has changed from 1 to 2'
  * ```
  *
- * @eventName change:\{property\}
+ * @eventName ~Observable#change:\{property\}
  * @param {String} name The property name.
  * @param {*} value The new property value.
  * @param {*} oldValue The previous property value.
@@ -478,7 +478,7 @@ export type ObservableChangeEvent<TValue = any> = {
  *
  * **Note:** The event is fired even when the new value is the same as the old value.
  *
- * @eventName set:\{property\}
+ * @eventName ~Observable#set:\{property\}
  * @param {String} name The property name.
  * @param {*} value The new property value.
  * @param {*} oldValue The previous property value.

package/src/version.d.ts

@@ -2,7 +2,7 @@
  * @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
  */
-declare const version = "37.0.0-alpha.0";
+declare const version = "37.0.0-alpha.2";
 export default version;
 declare global {
     var CKEDITOR_VERSION: string;

package/src/version.js

@@ -7,7 +7,7 @@
  */
 /* globals window, global */
 import CKEditorError from './ckeditorerror';
-const version = '37.0.0-alpha.0';
+const version = '37.0.0-alpha.2';
 export default version;
 /* istanbul ignore next */
 const windowOrGlobal = typeof window === 'object' ? window : global;