@ckeditor/ckeditor5-utils 45.0.0 → 45.1.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "45.0.0",
+  "version": "45.1.0-alpha.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,7 +12,7 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-ui": "45.0.0",
+    "@ckeditor/ckeditor5-ui": "45.1.0-alpha.0",
     "es-toolkit": "1.32.0"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/dom/getvisualviewportoffset.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+ */
+/**
+ * Returns the visual viewport offsets to adjust elements with `position: fixed` style.
+ */
+export default function getVisualViewportOffset(): {
+    left: number;
+    top: number;
+};

package/src/dom/getvisualviewportoffset.js

@@ -0,0 +1,21 @@
+/**
+ * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+ */
+/**
+ * @module utils/dom/getvisualviewportoffset
+ */
+import global from './global.js';
+import env from '../env.js';
+/**
+ * Returns the visual viewport offsets to adjust elements with `position: fixed` style.
+ */
+export default function getVisualViewportOffset() {
+    const visualViewport = global.window.visualViewport;
+    if (!visualViewport || !(env.isiOS || env.isSafari)) {
+        return { left: 0, top: 0 };
+    }
+    const left = Math.max(Math.round(visualViewport.offsetLeft), 0);
+    const top = Math.max(Math.round(visualViewport.offsetTop), 0);
+    return { left, top };
+}

package/src/index.d.ts

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 /**
- * @module utils
+ * @module utils/index
  */
 export { default as env } from './env.js';
 export { default as diff, type DiffResult } from './diff.js';
@@ -43,6 +43,7 @@ export { default as isValidAttributeName } from './dom/isvalidattributename.js';
 export { default as isVisible } from './dom/isvisible.js';
 export { getOptimalPosition, type Options as PositionOptions, type PositioningFunction, type DomPoint } from './dom/position.js';
 export { default as remove } from './dom/remove.js';
+export { default as getVisualViewportOffset } from './dom/getvisualviewportoffset.js';
 export * from './dom/scroll.js';
 export * from './keyboard.js';
 export * from './language.js';

package/src/index.js

@@ -3,7 +3,7 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 /**
- * @module utils
+ * @module utils/index
  */
 export { default as env } from './env.js';
 export { default as diff } from './diff.js';
@@ -42,6 +42,7 @@ export { default as isValidAttributeName } from './dom/isvalidattributename.js';
 export { default as isVisible } from './dom/isvisible.js';
 export { getOptimalPosition } from './dom/position.js';
 export { default as remove } from './dom/remove.js';
+export { default as getVisualViewportOffset } from './dom/getvisualviewportoffset.js';
 export * from './dom/scroll.js';
 export * from './keyboard.js';
 export * from './language.js';

package/src/keyboard.js

@@ -66,7 +66,7 @@ export function getCode(key) {
              * Unknown key name. Only key names included in the {@link module:utils/keyboard#keyCodes} can be used.
              *
              * @error keyboard-unknown-key
-             * @param {String} key
+             * @param {string} key Ths specified key name.
              */
             throw new CKEditorError('keyboard-unknown-key', null, { key });
         }

package/src/language.js

@@ -8,7 +8,8 @@ const RTL_LANGUAGE_CODES = [
     'fa', 'per', 'fas',
     'he', 'heb',
     'ku', 'kur',
-    'ug', 'uig' // Uighur, Uyghur
+    'ug', 'uig',
+    'ur', 'urd' // Urdu
 ];
 /**
  * Helps determine whether a language text direction is LTR or RTL.

package/src/locale.d.ts

@@ -101,7 +101,7 @@ export default class Locale {
      * @param options.contentLanguage The editor content language code in the
      * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. If not specified, the same as `options.language`.
      * See {@link #contentLanguage}.
-     * @param translations Translations passed as a editor config parameter.
+     * @param options.translations Translations passed as a editor config parameter.
      */
     constructor({ uiLanguage, contentLanguage, translations }?: {
         readonly uiLanguage?: string;

package/src/locale.js

@@ -102,7 +102,7 @@ export default class Locale {
      * @param options.contentLanguage The editor content language code in the
      * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. If not specified, the same as `options.language`.
      * See {@link #contentLanguage}.
-     * @param translations Translations passed as a editor config parameter.
+     * @param options.translations Translations passed as a editor config parameter.
      */
     constructor({ uiLanguage = 'en', contentLanguage, translations } = {}) {
         this.uiLanguage = uiLanguage;

package/src/observablemixin.js

@@ -172,8 +172,8 @@ export default function ObservableMixin(base) {
                  * Cannot decorate an undefined method.
                  *
                  * @error observablemixin-cannot-decorate-undefined
-                 * @param {Object} object The object which method should be decorated.
-                 * @param {String} methodName Name of the method which does not exist.
+                 * @param {object} object The object which method should be decorated.
+                 * @param {string} methodName Name of the method which does not exist.
                  */
                 throw new CKEditorError('observablemixin-cannot-decorate-undefined', this, { object: this, methodName });
             }

package/src/retry.d.ts

@@ -5,11 +5,12 @@
 /**
  * Tries calling the given callback until it sucessfully resolves.
  *
- * If the callback fails `maxRetries` times, the returned promise is rejected with the last error.
+ * If the callback fails `maxAttempts` times, the returned promise is rejected with the last error.
  *
  * @typeParam TResult The result of a successful callback invocation.
  * @param callback The function to call until it succeeds.
- * @param options.maxRetries Maximum number of retries.
+ * @param options Configuration options.
+ * @param options.maxAttempts Maximum number of attempts.
  * @param options.retryDelay The time in milliseconds between attempts. By default it implements exponential back-off policy.
  * @param options.signal The signal to abort further retries. The callback itself is not aborted automatically.
  */

package/src/retry.js

@@ -9,11 +9,12 @@ import wait from './wait.js';
 /**
  * Tries calling the given callback until it sucessfully resolves.
  *
- * If the callback fails `maxRetries` times, the returned promise is rejected with the last error.
+ * If the callback fails `maxAttempts` times, the returned promise is rejected with the last error.
  *
  * @typeParam TResult The result of a successful callback invocation.
  * @param callback The function to call until it succeeds.
- * @param options.maxRetries Maximum number of retries.
+ * @param options Configuration options.
+ * @param options.maxAttempts Maximum number of attempts.
  * @param options.retryDelay The time in milliseconds between attempts. By default it implements exponential back-off policy.
  * @param options.signal The signal to abort further retries. The callback itself is not aborted automatically.
  */

package/src/splicearray.d.ts

@@ -17,10 +17,9 @@
  * spliceArray( [ 1, 2 ], [],       0 );	// [ 1, 2 ]
  * ```
  *
- * @param target Array to be spliced.
- * @param source Array of elements to be inserted to target.
- * @param start Index at which nodes should be inserted/removed.
- * @param count Number of items.
+ * @param targetArray Array to be spliced.
+ * @param insertArray Array of elements to be inserted to target.
+ * @param index Index at which nodes should be inserted.
  *
  * @returns New spliced array.
  */

package/src/splicearray.js

@@ -17,10 +17,9 @@
  * spliceArray( [ 1, 2 ], [],       0 );	// [ 1, 2 ]
  * ```
  *
- * @param target Array to be spliced.
- * @param source Array of elements to be inserted to target.
- * @param start Index at which nodes should be inserted/removed.
- * @param count Number of items.
+ * @param targetArray Array to be spliced.
+ * @param insertArray Array of elements to be inserted to target.
+ * @param index Index at which nodes should be inserted.
  *
  * @returns New spliced array.
  */

package/src/version.d.ts

@@ -2,7 +2,7 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
-declare const version = "45.0.0";
+declare const version = "45.1.0-alpha.0";
 export default version;
 export declare const releaseDate: Date;
 declare global {

package/src/version.js

@@ -6,10 +6,10 @@
  * @module utils/version
  */
 import CKEditorError from './ckeditorerror.js';
-const version = '45.0.0';
+const version = '45.1.0-alpha.0';
 export default version;
 // The second argument is not a month. It is `monthIndex` and starts from `0`.
-export const releaseDate = new Date(2025, 3, 7);
+export const releaseDate = new Date(2025, 4, 7);
 /* istanbul ignore next -- @preserve */
 if (globalThis.CKEDITOR_VERSION) {
     /**