feat(in-app-purchase-2): add missing classic store API surface

Fills gaps against the last classic-API release of cordova-plugin-purchase (v11.0.0) that this wrapper targets: new error codes, APPLICATION product type, developerName property, product group/discount/countryCode/deferred fields, and the getGroup() method and error(code, callback) overload.
2026-08-04 00:00:08 +08:00 · 2026-07-27 22:22:54 +02:00
2 changed files with 141 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;
-  }
 }
@@ -5,6 +5,12 @@ export interface IAPProductOptions {
  id: string;
  alias?: string;
  type: string;
+  /**
+   * Name of the group your subscription product is a member of (default to "default").
+   *
+   * If you don't set anything, all subscription will be members of the same group.
+   */
+  group?: string;
 }

 export interface IRefeshResult {
@@ -31,6 +37,29 @@ export type IAPProducts = IAPProduct[] & {

 export type IAPQueryCallback = ((product: IAPProduct) => void) | ((error: IAPError) => void);

+export interface IAPProductDiscount {
+  /** The discount identifier */
+  id: string;
+
+  /** Localized price, with currency symbol */
+  price: string;
+
+  /** Price in micro-units (divide by 1000000 to get numeric price) */
+  priceMicros: number;
+
+  /** Number of subscription periods */
+  period: number;
+
+  /** Unit of the subcription period ("Day", "Week", "Month" or "Year") */
+  periodUnit: string;
+
+  /** "PayAsYouGo", "UpFront", or "FreeTrial" */
+  paymentMode: string;
+
+  /** True if the user is deemed eligible for this discount by the platform */
+  eligible: boolean;
+}
+
 export interface IAPProduct {
  id: string;

@@ -38,6 +67,11 @@ export interface IAPProduct {

  type: string;

+  /**
+   * Name of the group your subscription product is a member of (default to "default").
+   */
+  group?: string;
+
  state: string;

  title: string;
@@ -50,6 +84,9 @@ export interface IAPProduct {

  currency: string;

+  /** Country code. Available only on iOS */
+  countryCode?: string;
+
  loaded: boolean;

  valid: boolean;
@@ -58,6 +95,9 @@ export interface IAPProduct {

  owned: boolean;

+  /** Purchase has been initiated but is waiting for external action (for example, Ask to Buy on iOS) */
+  deferred?: boolean;
+
  downloading?: boolean;

  downloaded?: boolean;
@@ -74,10 +114,19 @@ export interface IAPProduct {

  introPriceSubscriptionPeriod?: string;

+  /** Duration the introductory price is available (in period-unit) */
+  introPricePeriod?: string;
+
+  /** Period for the introductory price ("Day", "Week", "Month" or "Year") */
+  introPricePeriodUnit?: string;
+
  introPricePaymentMode?: string;

  ineligibleForIntroPrice?: boolean;

+  /** Array of discounts available for the product. */
+  discounts?: IAPProductDiscount[];
+
  billingPeriod?: number;

  billingPeriodUnit?: string;
@@ -563,6 +612,7 @@ export class IAPError {
 * IAPProduct
 * IAPProductOptions
 * IAPProductEvents
+ * IAPProductDiscount
 * ```
 */
@Plugin({
@@ -594,7 +644,7 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin {
   * Debug level. Use QUIET, ERROR, WARNING, INFO or DEBUG constants
   */
  @CordovaProperty()
-  verbosity: number;
+  verbosity: number | boolean;

  /**
   * Set to true to clear the transaction queue. Not recommended for production.
@@ -616,6 +666,14 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin {
  @CordovaProperty()
  disableHostedContent: boolean;

+  /**
+   * An optional string of developer profile name. This value can be used for payment risk evaluation.
+   *
+   * Do not use the user account ID for this field.
+   */
+  @CordovaProperty()
+  developerName: string;
+
  @CordovaProperty()
  FREE_SUBSCRIPTION: string;

@@ -631,6 +689,10 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin {
  @CordovaProperty()
  NON_CONSUMABLE: string;

+  /** Type: The application bundle */
+  @CordovaProperty()
+  APPLICATION: string;
+
  @CordovaProperty()
  ERR_SETUP: number;

@@ -694,6 +756,46 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin {
  @CordovaProperty()
  ERR_SUBSCRIPTION_UPDATE_NOT_AVAILABLE: number;

+  /** Error: The requested product is not available in the store. */
+  @CordovaProperty()
+  ERR_PRODUCT_NOT_AVAILABLE: number;
+
+  /** Error: The user has not allowed access to Cloud service information */
+  @CordovaProperty()
+  ERR_CLOUD_SERVICE_PERMISSION_DENIED: number;
+
+  /** Error: The device could not connect to the network. */
+  @CordovaProperty()
+  ERR_CLOUD_SERVICE_NETWORK_CONNECTION_FAILED: number;
+
+  /** Error: The user has revoked permission to use this cloud service. */
+  @CordovaProperty()
+  ERR_CLOUD_SERVICE_REVOKED: number;
+
+  /** Error: The user has not yet acknowledged Apple's privacy policy */
+  @CordovaProperty()
+  ERR_PRIVACY_ACKNOWLEDGEMENT_REQUIRED: number;
+
+  /** Error: The app is attempting to use a property for which it does not have the required entitlement. */
+  @CordovaProperty()
+  ERR_UNAUTHORIZED_REQUEST_DATA: number;
+
+  /** Error: The offer identifier is invalid. */
+  @CordovaProperty()
+  ERR_INVALID_OFFER_IDENTIFIER: number;
+
+  /** Error: The price you specified in App Store Connect is no longer valid. */
+  @CordovaProperty()
+  ERR_INVALID_OFFER_PRICE: number;
+
+  /** Error: The signature in a payment discount is not valid. */
+  @CordovaProperty()
+  ERR_INVALID_SIGNATURE: number;
+
+  /** Error: Parameters are missing in a payment discount. */
+  @CordovaProperty()
+  ERR_MISSING_OFFER_PARAMS: number;
+
  @CordovaProperty()
  REGISTERED: string;

@@ -783,12 +885,25 @@ export class InAppPurchase2 extends AwesomeCordovaNativePlugin {
  }

  /**
-   * Register error handler
+   * Register error handler.
   *
-   * @param onError {Function} function to call on error
+   * Can also be called with an error code as the first argument to only listen to a specific error code.
+   *
+   * @param onErrorOrErrorCode {Function | number} function to call on error, or an error code to filter on
+   * @param [onError] {Function} function to call on error, when the first argument is an error code
   */
  @Cordova({ sync: true })
-  error(onError: Function): void {}
+  error(onErrorOrErrorCode: Function | number, onError?: (err: IAPError) => void): void {}
+
+  /**
+   * Return all products member of a given subscription group.
+   *
+   * @param groupId
+   */
+  @Cordova({ sync: true })
+  getGroup(groupId: string): IAPProduct[] {
+    return;
+  }

  /**
   * Add or register a product