feat(tealium): add missing v2.5.0 APIs and remote command params

Add gatherTrackData, handleDeepLink, resetVisitorId, clearStoredVisitorIds, setVisitorIdListener, extend addRemoteCommand with path/url, add RemoteCommand interface, and add missing TealiumConfig fields (overrideCollectProfile, remoteCommands, sessionCountingEnabled, batchingEnabled).
2026-08-04 00:00:08 +08:00 · 2026-07-27 22:12:59 +02:00
2 changed files with 103 additions and 200 deletions
@@ -32,13 +32,6 @@ import { Cordova, CordovaProperty, AwesomeCordovaNativePlugin, Plugin } from '@a
 *
 * ```
 */
-export interface DiagnosticLocalNetworkAuthorizationOptions {
-  /**
-   * Override the default fallback timeout (2000ms) before treating a slow response as indeterminate (`UNKNOWN`).
-   */
-  timeoutMs?: number;
-}
-
@Plugin({
  pluginName: 'Diagnostic',
  plugin: 'cordova.plugins.diagnostic',
@@ -53,7 +46,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    ACCESS_BACKGROUND_LOCATION: 'ACCESS_BACKGROUND_LOCATION',
    ACCESS_COARSE_LOCATION: 'ACCESS_COARSE_LOCATION',
    ACCESS_FINE_LOCATION: 'ACCESS_FINE_LOCATION',
-    ACCESS_LOCAL_NETWORK: 'ACCESS_LOCAL_NETWORK',
    ACCESS_MEDIA_LOCATION: 'ACCESS_MEDIA_LOCATION',
    ACTIVITY_RECOGNITION: 'ACTIVITY_RECOGNITION',
    ADD_VOICEMAIL: 'ADD_VOICEMAIL',
@@ -69,7 +61,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    NEARBY_WIFI_DEVICES: 'NEARBY_WIFI_DEVICES',
    POST_NOTIFICATIONS: 'POST_NOTIFICATIONS',
    PROCESS_OUTGOING_CALLS: 'PROCESS_OUTGOING_CALLS',
-    RANGING: 'RANGING',
    READ_CALENDAR: 'READ_CALENDAR',
    READ_CALL_LOG: 'READ_CALL_LOG',
    READ_CONTACTS: 'READ_CONTACTS',
@@ -77,7 +68,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    READ_MEDIA_AUDIO: 'READ_MEDIA_AUDIO',
    READ_MEDIA_IMAGES: 'READ_MEDIA_IMAGES',
    READ_MEDIA_VIDEO: 'READ_MEDIA_VIDEO',
-    READ_MEDIA_VISUAL_USER_SELECTED: 'READ_MEDIA_VISUAL_USER_SELECTED',
    READ_PHONE_NUMBERS: 'READ_PHONE_NUMBERS',
    READ_PHONE_STATE: 'READ_PHONE_STATE',
    READ_SMS: 'READ_SMS',
@@ -109,11 +99,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    EPHEMERAL: string;
    PROVISIONAL: string;
    LIMITED: string;
-    /**
-     * Returned when the underlying OS has not yet provided a concrete status (for example, if an iOS
-     * Local Network probe timed out). Treat this as a transient state and retry before surfacing a denial to the user.
-     */
-    UNKNOWN: string;
  };

  locationAuthorizationMode = {
@@ -125,22 +110,8 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
   * Location accuracy authorization
   */
  locationAccuracyAuthorization = {
-    /** Alias for BEST. On iOS, sets `kCLLocationAccuracyBest`. */
    FULL: 'full',
-    /** On iOS, sets `kCLLocationAccuracyReduced` - approximate location, no GPS. */
    REDUCED: 'reduced',
-    /** On iOS, sets `kCLLocationAccuracyBest`. May engage GPS hardware. */
-    BEST: 'best',
-    /** On iOS, sets `kCLLocationAccuracyBestForNavigation`. Highest accuracy using additional sensor data. */
-    BEST_FOR_NAVIGATION: 'bestForNavigation',
-    /** On iOS, sets `kCLLocationAccuracyNearestTenMeters`. */
-    NEAREST_TEN_METERS: 'nearestTenMeters',
-    /** On iOS, sets `kCLLocationAccuracyHundredMeters`. */
-    HUNDRED_METERS: 'hundredMeters',
-    /** On iOS, sets `kCLLocationAccuracyKilometer`. */
-    KILOMETER: 'kilometer',
-    /** On iOS, sets `kCLLocationAccuracyThreeKilometers`. */
-    THREE_KILOMETERS: 'threeKilometers',
  };

  permissionGroups = {
@@ -161,7 +132,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    SENSORS: ['BODY_SENSORS'],
    SMS: ['SEND_SMS', 'RECEIVE_SMS', 'READ_SMS', 'RECEIVE_WAP_PUSH', 'RECEIVE_MMS'],
    STORAGE: ['READ_EXTERNAL_STORAGE', 'WRITE_EXTERNAL_STORAGE'],
-    NEARBY_DEVICES: ['BLUETOOTH_ADVERTISE', 'BLUETOOTH_SCAN', 'BLUETOOTH_CONNECT'],
+    NEARBY_DEVICES: ["BLUETOOTH_ADVERTISE", "BLUETOOTH_SCAN", "BLUETOOTH_CONNECT"],
  };

  locationMode = {
@@ -193,21 +164,21 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {

  @CordovaProperty()
  cpuArchitecture: {
-    MIPS: string;
-    MIPS_64: string;
-    UNKNOWN: string;
-    ARMv6: string;
-    ARMv7: string;
-    ARMv8: string;
-    X86: string;
-    X86_64: string;
+      MIPS: string;
+      MIPS_64: string;
+      UNKNOWN: string;
+      ARMv6: string;
+      ARMv7: string;
+      ARMv8: string;
+      X86: string;
+      X86_64: string;
  };

  @CordovaProperty()
  remoteNotificationType: {
-    ALERT: string;
-    SOUND: string;
-    BADGE: string;
+      ALERT: string;
+      SOUND: string;
+      BADGE: string;
  };

  @CordovaProperty()
@@ -336,6 +307,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

+
  // ANDROID AND IOS ONLY

  /**
@@ -388,6 +360,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

+
  /**
   * Returns the location authorization status for the application.
   * Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
@@ -605,7 +578,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
  @Cordova({ platforms: ['Android', 'iOS'] })
  getArchitecture(): Promise<any> {
    return;
-  }
+  }  

  /**
   * Returns the current battery level of the device as a percentage.
@@ -615,62 +588,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
  @Cordova({ platforms: ['Android', 'iOS'] })
  getCurrentBatteryLevel(): Promise<any> {
    return;
-  }
-
-  /**
-   * Checks if low power mode is currently enabled on the device.
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['Android', 'iOS'] })
-  isLowPowerModeEnabled(): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Registers a function to be called whenever the device low power mode status changes.
-   *
-   * @param {Function} handler
-   */
-  @Cordova({ platforms: ['Android', 'iOS'], sync: true })
-  onLowPowerModeChange(handler: Function): void {}
-
-  /**
-   * Checks if currently running app build is a debug build.
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['Android', 'iOS'] })
-  isDebugBuild(): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Checks if Accessibility Mode (Talkback on Android, VoiceOver on iOS) is currently enabled on the device.
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['Android', 'iOS'] })
-  isAccessibilityModeEnabled(): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Checks if app is able to access device heading.
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['Android', 'iOS'] })
-  isCompassAvailable(): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Opens notification settings for your app.
-   * On Android versions lower than O and on iOS versions lower than 15.4, this will open the same page as `switchToSettings()`.
-   */
-  @Cordova({ platforms: ['Android', 'iOS'], sync: true })
-  switchToNotificationSettings(): void {}
+  }  

  // ANDROID ONLY

@@ -687,6 +605,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

+
  /**
   * Checks if high-accuracy locations are available to the app from GPS hardware.
   * Returns true if Location mode is enabled and is set to "Device only" or "High accuracy" AND if the app is authorized to use location.
@@ -745,7 +664,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

-  /**
+  /** 
   * Checks if mobile data is enabled on device.
   *
   * @returns {Promise<any>}
@@ -755,37 +674,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

-  /**
-   * Checks if the app is currently ignoring battery optimizations.
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['Android'] })
-  isIgnoringBatteryOptimizations(): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Prompts the user to allow the app to ignore battery optimizations.
-   * Requires permission `<uses-permission android:name="android.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS" />`
-   *
-   * @returns {Promise<any>}
-   */
-  @Cordova({ platforms: ['Android'] })
-  requestIgnoreBatteryOptimizations(): Promise<any> {
-    return;
-  }
-
-  /**
-   * Checks if touch exploration (in accessibility mode) is currently enabled on the device.
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['Android'] })
-  isTouchExplorationEnabled(): Promise<boolean> {
-    return;
-  }
-
  /**
   * Returns the current location mode setting for the device.
   *
@@ -801,7 +689,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
   *
   * @returns {Promise<any>}
   */
-  @Cordova({ platforms: ['Android', 'iOS'] })
+  @Cordova({ platforms: ['Android'] })
  getDeviceOSVersion(): Promise<any> {
    return;
  }
@@ -811,7 +699,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
   *
   * @returns {Promise<any>}
   */
-  @Cordova({ platforms: ['Android', 'iOS'] })
+  @Cordova({ platforms: ['Android'] })
  getBuildOSVersion(): Promise<any> {
    return;
  }
@@ -938,7 +826,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
  getBluetoothAuthorizationStatus(): Promise<any> {
    return;
  }
-
+  
  /**
   * Returns the individual authorization status for each Bluetooth run-time permission on Android 12+ / API 31+
   * On Android 11 / API 30 and below, all will be returned as GRANTED if the manifest has BLUETOOTH since they are implicitly granted at build-time.
@@ -950,19 +838,6 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

-  /**
-   * Returns the individual camera authorization statuses for each of the relevant permissions.
-   * Note for Android: this is intended for Android 6 / API 23 and above. Calling on Android 5.1 / API 22 and below will always return GRANTED status as permissions are already granted at installation time.
-   *
-   * @param {boolean} [storage] Android only: If true, requests storage permissions in addition to CAMERA run-time permission.
-   *  cordova-plugin-camera@2.2+ requires both of these permissions. Defaults to true.
-   * @returns {Promise<any>}
-   */
-  @Cordova({ platforms: ['Android'], callbackOrder: 'reverse' })
-  getCameraAuthorizationStatuses(storage?: boolean): Promise<any> {
-    return;
-  }
-
  /**
   * Checks if the application is authorized to use external storage.
   *
@@ -1156,7 +1031,7 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
    return;
  }

-  /**
+ /**
   * Presents limited library picker UI on iOS 14+
   *
   * @returns {Promise<any>}
@@ -1362,53 +1237,4 @@ export class Diagnostic extends AwesomeCordovaNativePlugin {
   */
  @Cordova({ platforms: ['iOS'], sync: true })
  registerLocationAccuracyAuthorizationChangeHandler(handler: Function): void {}
-
-  /**
-   * Checks if mobile data is authorized for this app.
-   * Returns true if the per-app Mobile Data setting is set to enabled (regardless of whether the device is currently connected to a cellular network)
-   *
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['iOS'] })
-  isMobileDataAuthorized(): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Checks if the app is authorised to access devices on the local network (iOS 14+).
-   * On iOS versions prior to 14 this will always return TRUE as no local network authorization is required.
-   *
-   * @param {DiagnosticLocalNetworkAuthorizationOptions} [options] Optional timeout control - provide `timeoutMs` to override the default 2000ms timeout.
-   * @returns {Promise<boolean>}
-   */
-  @Cordova({ platforms: ['iOS'], callbackOrder: 'reverse' })
-  isLocalNetworkAuthorized(options?: DiagnosticLocalNetworkAuthorizationOptions): Promise<boolean> {
-    return;
-  }
-
-  /**
-   * Returns the app's Local Network authorization status (iOS 14+).
-   * On iOS 14+ this returns one of: NOT_REQUESTED, GRANTED, DENIED_ALWAYS, UNKNOWN (this.permissionStatus).
-   * `UNKNOWN` indicates that iOS did not return a definitive answer before the timeout elapsed, so the app can retry before warning the user.
-   * On iOS versions prior to 14 this will always return GRANTED as no authorization is required.
-   *
-   * @param {DiagnosticLocalNetworkAuthorizationOptions} [options] Optional timeout override (defaults to 2000ms).
-   * @returns {Promise<string>}
-   */
-  @Cordova({ platforms: ['iOS'], callbackOrder: 'reverse' })
-  getLocalNetworkAuthorizationStatus(options?: DiagnosticLocalNetworkAuthorizationOptions): Promise<string> {
-    return;
-  }
-
-  /**
-   * Requests the user to authorise the app to access devices on the local network (iOS 14+).
-   * On iOS versions prior to 14 this does nothing and will return success as no authorization is required.
-   * May return UNKNOWN if iOS does not respond before the native APIs time out, allowing the app to retry.
-   *
-   * @returns {Promise<string>}
-   */
-  @Cordova({ platforms: ['iOS'] })
-  requestLocalNetworkAuthorization(): Promise<string> {
-    return;
-  }
 }
@@ -41,7 +41,10 @@ export interface TealiumDispatch {

 export class TealiumView implements TealiumDispatch {
  public type = 'view';
-  constructor(public viewName: string, public dataLayer: Map<string, any>) {}
+  constructor(
+    public viewName: string,
+    public dataLayer: Map<string, any>
+  ) {}
  toJson() {
    const dictionary: any = {};
    dictionary['type'] = this.type;
@@ -57,7 +60,10 @@ export class TealiumView implements TealiumDispatch {

 export class TealiumEvent implements TealiumDispatch {
  public type = 'event';
-  constructor(public eventName: string, public dataLayer: Map<string, any>) {}
+  constructor(
+    public eventName: string,
+    public dataLayer: Map<string, any>
+  ) {}
  toJson() {
    const dictionary: any = {};
    dictionary['type'] = this.type;
@@ -72,7 +78,21 @@ export class TealiumEvent implements TealiumDispatch {
 }

 export class ConsentExpiry {
-  constructor(public time: number, public unit: TimeUnit) {}
+  constructor(
+    public time: number,
+    public unit: TimeUnit
+  ) {}
+}
+
+export interface RemoteCommand {
+  /** The ID used to invoke the remote command */
+  id: string;
+  /** Path to a local JSON file mapping, relative to the app bundle */
+  path?: string;
+  /** URL to a remote JSON file mapping */
+  url?: string;
+  /** Callback invoked when the remote command is triggered */
+  callback?: Function;
 }

 export enum TimeUnit {
@@ -130,6 +150,7 @@ export interface TealiumConfig {
  memoryReportingEnabled?: boolean;
  overrideCollectURL?: string;
  overrideCollectBatchURL?: string;
+  overrideCollectProfile?: string;
  overrideCollectDomain?: string;
  overrideLibrarySettingsURL?: string;
  overrideTagManagementURL?: string;
@@ -143,6 +164,12 @@ export interface TealiumConfig {
  useRemoteLibrarySettings?: boolean;
  visitorServiceEnabled?: boolean;
  visitorServiceRefreshInterval?: string;
+  /** Remote commands to register automatically on initialize */
+  remoteCommands?: RemoteCommand[];
+  /** Whether session counting is enabled */
+  sessionCountingEnabled?: boolean;
+  /** Whether dispatch batching is enabled */
+  batchingEnabled?: boolean;
 }

 /**
@@ -251,6 +278,16 @@ export class Tealium extends AwesomeCordovaNativePlugin {
    return;
  }

+  /**
+   * Gathers the current track data (data layer merged with library data) without dispatching a track call
+   * @param callback
+   * @return {Promise<any>} Returns a promise that resolves when something happens
+   */
+  @Cordova()
+  gatherTrackData(callback?: Function): Promise<any> {
+    return;
+  }
+
  /**
   * Retrieves the user's consent status
   * @param callback
@@ -310,6 +347,16 @@ export class Tealium extends AwesomeCordovaNativePlugin {
    return;
  }

+  /**
+   * Passes a deep link URI to the Tealium library for tracking
+   * @param uri The deep link URI
+   * @return {Promise<any>} Returns a promise that resolves when something happens
+   */
+  @Cordova()
+  handleDeepLink(uri: string): Promise<any> {
+    return;
+  }
+
  /**
   * Retrieves the Tealium Visitor ID
   * @param callback
@@ -320,6 +367,24 @@ export class Tealium extends AwesomeCordovaNativePlugin {
    return;
  }

+  /**
+   * Resets the Tealium Visitor ID, generating a new one
+   * @return {Promise<any>} Returns a promise that resolves when something happens
+   */
+  @Cordova()
+  resetVisitorId(): Promise<any> {
+    return;
+  }
+
+  /**
+   * Clears all previously-stored visitor IDs
+   * @return {Promise<any>} Returns a promise that resolves when something happens
+   */
+  @Cordova()
+  clearStoredVisitorIds(): Promise<any> {
+    return;
+  }
+
  /**
   * Sets a listener to be called when the AudienceStream visitor profile is updated
   * @param callback
@@ -330,6 +395,16 @@ export class Tealium extends AwesomeCordovaNativePlugin {
    return;
  }

+  /**
+   * Sets a listener to be called when the Visitor ID changes
+   * @param callback
+   * @return {Promise<any>} Returns a promise that resolves when something happens
+   */
+  @Cordova()
+  setVisitorIdListener(callback?: Function): Promise<any> {
+    return;
+  }
+
  /**
   * Sets a listener to be called when the consent has expired
   * @param callback
@@ -344,10 +419,12 @@ export class Tealium extends AwesomeCordovaNativePlugin {
   * Adds a remote command for later execution
   * @param id The ID used to invoke the remote command
   * @param callback
+   * @param path Path to a local JSON file mapping, relative to the app bundle
+   * @param url URL to a remote JSON file mapping
   * @return {Promise<any>} Returns a promise that resolves when something happens
   */
  @Cordova()
-  addRemoteCommand(id: string, callback?: Function): Promise<any> {
+  addRemoteCommand(id: string, callback?: Function, path?: string, url?: string): Promise<any> {
    return;
  }