@appium/base-driver 10.1.2 → 10.2.1

package/lib/basedriver/{device-settings.js → device-settings.ts}

@@ -1,45 +1,41 @@
 import _ from 'lodash';
-import log from './logger';
+import {log} from './logger';
 import {node, util} from '@appium/support';
 import {errors} from '../protocol/errors';
+import type {StringRecord, IDeviceSettings, SettingsUpdateListener} from '@appium/types';
 
 /**
- * Maximum size (in bytes) of a given driver's settings object (which is internal to {@linkcode DriverSettings}).
+ * Maximum size (in bytes) of a given driver's settings object (which is internal to {@linkcode DeviceSettings}).
  */
 export const MAX_SETTINGS_SIZE = 20 * 1024 * 1024; // 20 MB
 
 /**
- * @template {StringRecord} T
- * @implements {IDeviceSettings<T>}
+ * @template T - Settings object shape (string-keyed record)
  */
-export class DeviceSettings {
-  /**
-   * @protected
-   * @type {T}
-   */
-  _settings;
-
-  /**
-   * @protected
-   * @type {import('@appium/types').SettingsUpdateListener<T>}
-   */
-  _onSettingsUpdate;
+export class DeviceSettings<T extends StringRecord = StringRecord> implements IDeviceSettings<T> {
+  protected _settings: T;
+  protected _onSettingsUpdate: SettingsUpdateListener<T>;
 
   /**
    * Creates a _shallow copy_ of the `defaultSettings` parameter!
-   * @param {T} [defaultSettings]
-   * @param {import('@appium/types').SettingsUpdateListener<T>} [onSettingsUpdate]
+   *
+   * @param defaultSettings - Initial settings (shallow-copied).
+   * @param onSettingsUpdate - Called when a setting is changed; receives (prop, newValue, curValue).
    */
-  constructor(defaultSettings = /** @type {T} */ ({}), onSettingsUpdate = async () => {}) {
+  constructor(
+    defaultSettings: T = {} as T,
+    onSettingsUpdate: SettingsUpdateListener<T> = async () => {}
+  ) {
     this._settings = {...defaultSettings};
     this._onSettingsUpdate = onSettingsUpdate;
   }
 
   /**
-   * calls updateSettings from implementing driver every time a setting is changed.
-   * @param {T} newSettings
+   * Calls updateSettings from implementing driver every time a setting is changed.
+   *
+   * @param newSettings - New settings to merge (must be plain object; total size remains bounded).
    */
-  async update(newSettings) {
+  async update(newSettings: T): Promise<void> {
     if (!_.isPlainObject(newSettings)) {
       throw new errors.InvalidArgumentError(
         `Settings update should be called with valid JSON. Got ` +
@@ -61,23 +57,16 @@ export class DeviceSettings {
           continue;
         }
       }
-      await this._onSettingsUpdate(prop, newSettings[prop], this._settings[prop]);
+      await this._onSettingsUpdate(
+        prop as keyof T,
+        newSettings[prop],
+        this._settings[prop]
+      );
       this._settings[prop] = newSettings[prop];
     }
   }
 
-  getSettings() {
+  getSettings(): T {
     return this._settings;
   }
 }
-
-export default DeviceSettings;
-
-/**
- * @typedef {import('@appium/types').StringRecord} StringRecord
- */
-
-/**
- * @template {StringRecord} [T=StringRecord]
- * @typedef {import('@appium/types').IDeviceSettings<T>} IDeviceSettings
- */