@tryvital/vital-health-react-native 3.0.10 → 3.1.0-beta.1

package/lib/module/index.js

@@ -18,6 +18,32 @@ export const VitalHealthEvents = {
 };
 export class VitalHealth {
   static status = new NativeEventEmitter(VitalHealthReactNative);
+  static get canEnableBackgroundSyncNoninteractively() {
+    return Platform.OS !== 'android';
+  }
+
+  /**
+   * Whether health data sync is paused at the moment.
+   */
+  static get pauseSynchronization() {
+    return VitalHealthReactNative.getPauseSynchronization();
+  }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this property always returns `true`. iOS HealthKit Background Delivery is
+   * an app-level entitlement, and does not require explicit user consent.
+   * 
+   * ## Overview
+   * 
+   * Whether Background Sync on Android is enabled at the moment.
+   */
+  static get isBackgroundSyncEnabled() {
+    if (Platform.OS !== 'android') {
+      return Promise.resolve(true);
+    }
+    return VitalHealthReactNative.isBackgroundSyncEnabled();
+  }
   static isAvailable() {
     if (Platform.OS === 'android') {
       return VitalHealthReactNative.isAvailable();
@@ -38,6 +64,100 @@ export class VitalHealth {
   static configureClient(apiKey, environment, region, enableLogs) {
     return VitalHealthReactNative.configureClient(apiKey, environment, region, enableLogs);
   }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this method is a no-op returning `true`. iOS HealthKit Background Delivery is an app-level
+   * entitlement, and does not require explicit user consent.
+   * 
+   * If you intend to pause or unpause synchronization, use `pauseSynchronization`
+   * and `setPauseSynchronization(_:)` instead.
+   * 
+   * ## Overview
+   * 
+   * Enable background sync on Android. This includes requesting permissions from the end user whenever necessary.
+   *
+   * Vital SDK achieves automatic data sync through Android [AlarmManager] exact alarms.
+   *
+   * Refer to the [Vital Health Connect guide for full context and setup instructions](https://docs.tryvital.io/wearables/guides/android_health_connect).
+   *
+   * ## Gist on Exact Alarms
+   *
+   * "Exact Alarm" here refers to the Android Exact Alarm mechanism. The Vital SDK would propose
+   * to the Android OS to fire the next data sync with a T+60min wall clock target. The Android OS
+   * may fulfill the request exactly as proposed, e.g., when the user happens to be actively using
+   * the device. However, it may also choose to defer it arbitrarily, under the influence of
+   * power-saving policies like [Doze mode](https://developer.android.com/training/monitoring-device-state/doze-standby#understand_doze).
+   *
+   * On Android 12 (API Level 31) or above, this contract would automatically initiate the OS-required
+   * user consent flow for Exact Alarm usage. If the permission has been granted prior, this activity
+   * contract shall return synchronously.
+   *
+   * On Android 13 (API Level 33) or above, you have the option to use (with platform policy caveats)
+   * the [android.Manifest.permission.USE_EXACT_ALARM] permission instead, which does not require an
+   * explicit consent flow. This contract would return synchronously in this scenario.
+   *
+   * Regardless of API Level, your App Manifest must declare [android.Manifest.permission.RECEIVE_BOOT_COMPLETED].
+   * Otherwise, background sync stops once the phone encounters a cold reboot or a quick restart.
+   *
+   * @return `true` if the background sync has been enabled successfully. `false` otherwise.
+   */
+  static async enableBackgroundSync() {
+    if (Platform.OS !== "android") {
+      // iOS background delivery does not require user explicit consent.
+      // It requires only the app-level HealthKit Bgnd. Delivery entitlement.
+      return true;
+    }
+    return await VitalHealthReactNative.enableBackgroundSync();
+  }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this method is a no-op. iOS HealthKit Background Delivery is an app-level
+   * entitlement, and does not require explicit user consent.
+   * 
+   * If you intend to pause or unpause synchronization, use `pauseSynchronization`
+   * and `setPauseSynchronization(_:)` instead.
+   * 
+   * ## Overview
+   *
+   * Disable background sync on Android.
+   */
+  static async disableBackgroundSync() {
+    if (Platform.OS !== "android") {
+      // iOS background delivery does not require user explicit consent.
+      // It requires only the app-level HealthKit Bgnd. Delivery entitlement.
+      return;
+    }
+    return await VitalHealthReactNative.disableBackgroundSync();
+  }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this method is a no-op. iOS does not require apps to show a user-visible
+   * notification when performing extended work in background.
+   * 
+   * ## Overview
+   * Set the text content related to the Sync Notification. The OS has full discretion to present
+   * this notification to the user, when any data sync work in background is taking longer than expected.
+   * 
+   * Refer to the [Vital Health Connect guide for full context and setup instructions](https://docs.tryvital.io/wearables/guides/android_health_connect).
+   */
+  static async setSyncNotificationContent(content) {
+    if (Platform.OS !== "android") {
+      // iOS background delivery does not require user explicit consent.
+      // It requires only the app-level HealthKit Bgnd. Delivery entitlement.
+      return;
+    }
+    return await VitalHealthReactNative.setSyncNotificationContent(JSON.stringify(content));
+  }
+
+  /**
+   * Pause or unpause health data sync.
+   */
+  static async setPauseSynchronization(paused) {
+    return await VitalHealthReactNative.setPauseSynchronization(paused);
+  }
   static askForResources(resources) {
     return VitalHealthReactNative.ask(resources, []);
   }

package/lib/module/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["NativeEventEmitter","NativeModules","Platform","VitalCore","LINKING_ERROR","select","ios","default","VitalHealthReactNative","Proxy","get","Error","VitalHealthReactNativeModule","VitalHealthEvents","statusEvent","VitalHealth","status","isAvailable","OS","Promise","resolve","configure","healthConfig","androidConfig","syncOnAppStart","numberOfDaysToBackFill","logsEnabled","iOSConfig","backgroundDeliveryEnabled","setUserId","userId","configureClient","apiKey","environment","region","enableLogs","askForResources","resources","ask","readResources","writeResources","writeHealthData","resource","value","startDate","endDate","getTime","hasAskedForPermission","syncData","cleanUp","signOut","VitalResource","VitalWriteResource"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":"AAAA,SAASA,kBAAkB,EAAEC,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAE1E,SAASC,SAAS,QAAQ,mCAAmC;;AAE7D;AACA,cAAc,iBAAiB;AAE/B,MAAMC,aAAa,GAChB,oFAAmF,GACpFF,QAAQ,CAACG,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,sBAAsB,GAAGP,aAAa,CAACO,sBAAsB,GAC/DP,aAAa,CAACO,sBAAsB,GACpC,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAEL,OAAO,MAAMQ,4BAA4B,GAAGJ,sBAAsB;AAElE,OAAO,MAAMK,iBAAiB,GAAG;EAC/BC,WAAW,EAAE;AACf,CAAC;AAED,OAAO,MAAMC,WAAW,CAAC;EACvB,OAAOC,MAAM,GAAG,IAAIhB,kBAAkB,CAACQ,sBAAsB,CAAC;EAE9D,OAAOS,WAAWA,CAAA,EAAqB;IACrC,IAAIf,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B,OAAOV,sBAAsB,CAACS,WAAW,CAAC,CAAC;IAC7C,CAAC,MAAM;MACL,OAAOE,OAAO,CAACC,OAAO,CAAC,IAAI,CAAC;IAC9B;EACF;EAEA,OAAOC,SAASA,CAACC,YAA0B,EAAiB;IAC1D,IAAIpB,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B,OAAOV,sBAAsB,CAACa,SAAS,CACrCC,YAAY,CAACC,aAAa,CAACC,cAAc,EACzCF,YAAY,CAACG,sBAAsB,EACnCH,YAAY,CAACI,WACf,CAAC;IACH,CAAC,MAAM;MACL,OAAOlB,sBAAsB,CAACa,SAAS,CACrCC,YAAY,CAACK,SAAS,CAACC,yBAAyB,EAChDN,YAAY,CAACG,sBAAsB,EACnCH,YAAY,CAACI,WACf,CAAC;IACH;EACF;EAEA,OAAOG,SAASA,CAACC,MAAc,EAAiB;IAC9C,OAAOtB,sBAAsB,CAACqB,SAAS,CAACC,MAAM,CAAC;EACjD;EAEA,OAAOC,eAAeA,CACpBC,MAAc,EACdC,WAAmB,EACnBC,MAAc,EACdC,UAAmB,EACJ;IACf,OAAO3B,sBAAsB,CAACuB,eAAe,CAC3CC,MAAM,EACNC,WAAW,EACXC,MAAM,EACNC,UACF,CAAC;EACH;EAEA,OAAOC,eAAeA,CAACC,SAA0B,EAAiB;IAChE,OAAO7B,sBAAsB,CAAC8B,GAAG,CAACD,SAAS,EAAE,EAAE,CAAC;EAClD;EAEA,OAAOC,GAAGA,CACRC,aAA8B,EAC9BC,cAAoC,EACrB;IACf,OAAOhC,sBAAsB,CAAC8B,GAAG,CAACC,aAAa,EAAEC,cAAc,CAAC;EAClE;EAEA,OAAOC,eAAeA,CACpBC,QAA4B,EAC5BC,KAAa,EACbC,SAAe,EACfC,OAAa,EACE;IACf,OAAOrC,sBAAsB,CAACiC,eAAe,CAC3CC,QAAQ,EACRC,KAAK,EACLC,SAAS,CAACE,OAAO,CAAC,CAAC,EACnBD,OAAO,CAACC,OAAO,CAAC,CAClB,CAAC;EACH;EAEA,OAAOC,qBAAqBA,CAACL,QAAuB,EAAoB;IACtE,OAAOlC,sBAAsB,CAACuC,qBAAqB,CAACL,QAAQ,CAAC;EAC/D;EAEA,OAAOM,QAAQA,CAACX,SAA0B,GAAG,EAAE,EAAiB;IAC9D,OAAO7B,sBAAsB,CAACwC,QAAQ,CAACX,SAAS,CAAC;EACnD;;EAEA;AACF;AACA;AACA;EACE,OAAOY,OAAOA,CAAA,EAAkB;IAC9B,OAAO9C,SAAS,CAAC+C,OAAO,CAAC,CAAC;EAC5B;AACF;;AAEA;AACA,WAAYC,aAAa,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAiBzB,WAAYC,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA,OAGO"}
+{"version":3,"names":["NativeEventEmitter","NativeModules","Platform","VitalCore","LINKING_ERROR","select","ios","default","VitalHealthReactNative","Proxy","get","Error","VitalHealthReactNativeModule","VitalHealthEvents","statusEvent","VitalHealth","status","canEnableBackgroundSyncNoninteractively","OS","pauseSynchronization","getPauseSynchronization","isBackgroundSyncEnabled","Promise","resolve","isAvailable","configure","healthConfig","androidConfig","syncOnAppStart","numberOfDaysToBackFill","logsEnabled","iOSConfig","backgroundDeliveryEnabled","setUserId","userId","configureClient","apiKey","environment","region","enableLogs","enableBackgroundSync","disableBackgroundSync","setSyncNotificationContent","content","JSON","stringify","setPauseSynchronization","paused","askForResources","resources","ask","readResources","writeResources","writeHealthData","resource","value","startDate","endDate","getTime","hasAskedForPermission","syncData","cleanUp","signOut","VitalResource","VitalWriteResource"],"sourceRoot":"../../src","sources":["index.tsx"],"mappings":"AAAA,SAASA,kBAAkB,EAAEC,aAAa,EAAEC,QAAQ,QAAQ,cAAc;AAE1E,SAASC,SAAS,QAAQ,mCAAmC;;AAE7D;AACA,cAAc,iBAAiB;AAE/B,MAAMC,aAAa,GAChB,oFAAmF,GACpFF,QAAQ,CAACG,MAAM,CAAC;EAAEC,GAAG,EAAE,gCAAgC;EAAEC,OAAO,EAAE;AAAG,CAAC,CAAC,GACvE,sDAAsD,GACtD,+BAA+B;AAEjC,MAAMC,sBAAsB,GAAGP,aAAa,CAACO,sBAAsB,GAC/DP,aAAa,CAACO,sBAAsB,GACpC,IAAIC,KAAK,CACP,CAAC,CAAC,EACF;EACEC,GAAGA,CAAA,EAAG;IACJ,MAAM,IAAIC,KAAK,CAACP,aAAa,CAAC;EAChC;AACF,CACF,CAAC;AAEL,OAAO,MAAMQ,4BAA4B,GAAGJ,sBAAsB;AAElE,OAAO,MAAMK,iBAAiB,GAAG;EAC/BC,WAAW,EAAE;AACf,CAAC;AASD,OAAO,MAAMC,WAAW,CAAC;EACvB,OAAOC,MAAM,GAAG,IAAIhB,kBAAkB,CAACQ,sBAAsB,CAAC;EAE9D,WAAWS,uCAAuCA,CAAA,EAAY;IAC5D,OAAOf,QAAQ,CAACgB,EAAE,KAAK,SAAS;EAClC;;EAEA;AACF;AACA;EACE,WAAWC,oBAAoBA,CAAA,EAAqB;IAClD,OAAOX,sBAAsB,CAACY,uBAAuB,CAAC,CAAC;EACzD;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,WAAWC,uBAAuBA,CAAA,EAAqB;IACrD,IAAInB,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B,OAAOI,OAAO,CAACC,OAAO,CAAC,IAAI,CAAC;IAC9B;IAEA,OAAOf,sBAAsB,CAACa,uBAAuB,CAAC,CAAC;EACzD;EAEA,OAAOG,WAAWA,CAAA,EAAqB;IACrC,IAAItB,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B,OAAOV,sBAAsB,CAACgB,WAAW,CAAC,CAAC;IAC7C,CAAC,MAAM;MACL,OAAOF,OAAO,CAACC,OAAO,CAAC,IAAI,CAAC;IAC9B;EACF;EAEA,OAAOE,SAASA,CAACC,YAA0B,EAAiB;IAC1D,IAAIxB,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B,OAAOV,sBAAsB,CAACiB,SAAS,CACrCC,YAAY,CAACC,aAAa,CAACC,cAAc,EACzCF,YAAY,CAACG,sBAAsB,EACnCH,YAAY,CAACI,WACf,CAAC;IACH,CAAC,MAAM;MACL,OAAOtB,sBAAsB,CAACiB,SAAS,CACrCC,YAAY,CAACK,SAAS,CAACC,yBAAyB,EAChDN,YAAY,CAACG,sBAAsB,EACnCH,YAAY,CAACI,WACf,CAAC;IACH;EACF;EAEA,OAAOG,SAASA,CAACC,MAAc,EAAiB;IAC9C,OAAO1B,sBAAsB,CAACyB,SAAS,CAACC,MAAM,CAAC;EACjD;EAEA,OAAOC,eAAeA,CACpBC,MAAc,EACdC,WAAmB,EACnBC,MAAc,EACdC,UAAmB,EACJ;IACf,OAAO/B,sBAAsB,CAAC2B,eAAe,CAC3CC,MAAM,EACNC,WAAW,EACXC,MAAM,EACNC,UACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,aAAaC,oBAAoBA,CAAA,EAAqB;IACpD,IAAItC,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B;MACA;MACA,OAAO,IAAI;IACb;IAEA,OAAO,MAAMV,sBAAsB,CAACgC,oBAAoB,CAAC,CAAC;EAC5D;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,aAAaC,qBAAqBA,CAAA,EAAkB;IAClD,IAAIvC,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B;MACA;MACA;IACF;IAEA,OAAO,MAAMV,sBAAsB,CAACiC,qBAAqB,CAAC,CAAC;EAC7D;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,aAAaC,0BAA0BA,CAACC,OAAgC,EAAiB;IACvF,IAAIzC,QAAQ,CAACgB,EAAE,KAAK,SAAS,EAAE;MAC7B;MACA;MACA;IACF;IAEA,OAAO,MAAMV,sBAAsB,CAACkC,0BAA0B,CAC5DE,IAAI,CAACC,SAAS,CAACF,OAAO,CACxB,CAAC;EACH;;EAEA;AACF;AACA;EACE,aAAaG,uBAAuBA,CAACC,MAAe,EAAE;IACpD,OAAO,MAAMvC,sBAAsB,CAACsC,uBAAuB,CAACC,MAAM,CAAC;EACrE;EAEA,OAAOC,eAAeA,CAACC,SAA0B,EAAiB;IAChE,OAAOzC,sBAAsB,CAAC0C,GAAG,CAACD,SAAS,EAAE,EAAE,CAAC;EAClD;EAEA,OAAOC,GAAGA,CACRC,aAA8B,EAC9BC,cAAoC,EACrB;IACf,OAAO5C,sBAAsB,CAAC0C,GAAG,CAACC,aAAa,EAAEC,cAAc,CAAC;EAClE;EAEA,OAAOC,eAAeA,CACpBC,QAA4B,EAC5BC,KAAa,EACbC,SAAe,EACfC,OAAa,EACE;IACf,OAAOjD,sBAAsB,CAAC6C,eAAe,CAC3CC,QAAQ,EACRC,KAAK,EACLC,SAAS,CAACE,OAAO,CAAC,CAAC,EACnBD,OAAO,CAACC,OAAO,CAAC,CAClB,CAAC;EACH;EAEA,OAAOC,qBAAqBA,CAACL,QAAuB,EAAoB;IACtE,OAAO9C,sBAAsB,CAACmD,qBAAqB,CAACL,QAAQ,CAAC;EAC/D;EAEA,OAAOM,QAAQA,CAACX,SAA0B,GAAG,EAAE,EAAiB;IAC9D,OAAOzC,sBAAsB,CAACoD,QAAQ,CAACX,SAAS,CAAC;EACnD;;EAEA;AACF;AACA;AACA;EACE,OAAOY,OAAOA,CAAA,EAAkB;IAC9B,OAAO1D,SAAS,CAAC2D,OAAO,CAAC,CAAC;EAC5B;AACF;;AAEA;AACA,WAAYC,aAAa,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAiBzB,WAAYC,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA,OAGO"}

package/lib/typescript/index.d.ts

@@ -5,12 +5,100 @@ export declare const VitalHealthReactNativeModule: any;
 export declare const VitalHealthEvents: {
     statusEvent: string;
 };
+export interface SyncNotificationContent {
+    notificationTitle: string;
+    notificationContent: string;
+    channelName: string;
+    channelDescription: string;
+}
 export declare class VitalHealth {
     static status: NativeEventEmitter;
+    static get canEnableBackgroundSyncNoninteractively(): boolean;
+    /**
+     * Whether health data sync is paused at the moment.
+     */
+    static get pauseSynchronization(): Promise<boolean>;
+    /**
+     * [Android ONLY][Experimental API]
+     * On iOS, this property always returns `true`. iOS HealthKit Background Delivery is
+     * an app-level entitlement, and does not require explicit user consent.
+     *
+     * ## Overview
+     *
+     * Whether Background Sync on Android is enabled at the moment.
+     */
+    static get isBackgroundSyncEnabled(): Promise<boolean>;
     static isAvailable(): Promise<boolean>;
     static configure(healthConfig: HealthConfig): Promise<void>;
     static setUserId(userId: string): Promise<void>;
     static configureClient(apiKey: string, environment: string, region: string, enableLogs: boolean): Promise<void>;
+    /**
+     * [Android ONLY][Experimental API]
+     * On iOS, this method is a no-op returning `true`. iOS HealthKit Background Delivery is an app-level
+     * entitlement, and does not require explicit user consent.
+     *
+     * If you intend to pause or unpause synchronization, use `pauseSynchronization`
+     * and `setPauseSynchronization(_:)` instead.
+     *
+     * ## Overview
+     *
+     * Enable background sync on Android. This includes requesting permissions from the end user whenever necessary.
+     *
+     * Vital SDK achieves automatic data sync through Android [AlarmManager] exact alarms.
+     *
+     * Refer to the [Vital Health Connect guide for full context and setup instructions](https://docs.tryvital.io/wearables/guides/android_health_connect).
+     *
+     * ## Gist on Exact Alarms
+     *
+     * "Exact Alarm" here refers to the Android Exact Alarm mechanism. The Vital SDK would propose
+     * to the Android OS to fire the next data sync with a T+60min wall clock target. The Android OS
+     * may fulfill the request exactly as proposed, e.g., when the user happens to be actively using
+     * the device. However, it may also choose to defer it arbitrarily, under the influence of
+     * power-saving policies like [Doze mode](https://developer.android.com/training/monitoring-device-state/doze-standby#understand_doze).
+     *
+     * On Android 12 (API Level 31) or above, this contract would automatically initiate the OS-required
+     * user consent flow for Exact Alarm usage. If the permission has been granted prior, this activity
+     * contract shall return synchronously.
+     *
+     * On Android 13 (API Level 33) or above, you have the option to use (with platform policy caveats)
+     * the [android.Manifest.permission.USE_EXACT_ALARM] permission instead, which does not require an
+     * explicit consent flow. This contract would return synchronously in this scenario.
+     *
+     * Regardless of API Level, your App Manifest must declare [android.Manifest.permission.RECEIVE_BOOT_COMPLETED].
+     * Otherwise, background sync stops once the phone encounters a cold reboot or a quick restart.
+     *
+     * @return `true` if the background sync has been enabled successfully. `false` otherwise.
+     */
+    static enableBackgroundSync(): Promise<boolean>;
+    /**
+     * [Android ONLY][Experimental API]
+     * On iOS, this method is a no-op. iOS HealthKit Background Delivery is an app-level
+     * entitlement, and does not require explicit user consent.
+     *
+     * If you intend to pause or unpause synchronization, use `pauseSynchronization`
+     * and `setPauseSynchronization(_:)` instead.
+     *
+     * ## Overview
+     *
+     * Disable background sync on Android.
+     */
+    static disableBackgroundSync(): Promise<void>;
+    /**
+     * [Android ONLY][Experimental API]
+     * On iOS, this method is a no-op. iOS does not require apps to show a user-visible
+     * notification when performing extended work in background.
+     *
+     * ## Overview
+     * Set the text content related to the Sync Notification. The OS has full discretion to present
+     * this notification to the user, when any data sync work in background is taking longer than expected.
+     *
+     * Refer to the [Vital Health Connect guide for full context and setup instructions](https://docs.tryvital.io/wearables/guides/android_health_connect).
+     */
+    static setSyncNotificationContent(content: SyncNotificationContent): Promise<void>;
+    /**
+     * Pause or unpause health data sync.
+     */
+    static setPauseSynchronization(paused: boolean): Promise<any>;
     static askForResources(resources: VitalResource[]): Promise<void>;
     static ask(readResources: VitalResource[], writeResources: VitalWriteResource[]): Promise<void>;
     static writeHealthData(resource: VitalWriteResource, value: number, startDate: Date, endDate: Date): Promise<void>;

package/lib/typescript/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAA2B,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAIpD,cAAc,iBAAiB,CAAC;AAmBhC,eAAO,MAAM,4BAA4B,KAAyB,CAAC;AAEnE,eAAO,MAAM,iBAAiB;;CAE7B,CAAC;AAEF,qBAAa,WAAW;IACtB,MAAM,CAAC,MAAM,qBAAkD;IAE/D,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQtC,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB3D,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,MAAM,CAAC,eAAe,CACpB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,OAAO,GAClB,OAAO,CAAC,IAAI,CAAC;IAShB,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,MAAM,CAAC,GAAG,CACR,aAAa,EAAE,aAAa,EAAE,EAC9B,cAAc,EAAE,kBAAkB,EAAE,GACnC,OAAO,CAAC,IAAI,CAAC;IAIhB,MAAM,CAAC,eAAe,CACpB,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,IAAI,EACf,OAAO,EAAE,IAAI,GACZ,OAAO,CAAC,IAAI,CAAC;IAShB,MAAM,CAAC,qBAAqB,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvE,MAAM,CAAC,QAAQ,CAAC,SAAS,GAAE,aAAa,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;OAGG;IACH,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAGhC;AAGD,oBAAY,aAAa;IACvB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,cAAc,mBAAmB;CAClC;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,cAAc,mBAAmB;CAClC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAA2B,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAIpD,cAAc,iBAAiB,CAAC;AAmBhC,eAAO,MAAM,4BAA4B,KAAyB,CAAC;AAEnE,eAAO,MAAM,iBAAiB;;CAE7B,CAAC;AAEF,MAAM,WAAW,uBAAuB;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,qBAAa,WAAW;IACtB,MAAM,CAAC,MAAM,qBAAkD;IAE/D,MAAM,KAAK,uCAAuC,IAAI,OAAO,CAE5D;IAED;;OAEG;IACH,MAAM,KAAK,oBAAoB,IAAI,OAAO,CAAC,OAAO,CAAC,CAElD;IAED;;;;;;;;OAQG;IACH,MAAM,KAAK,uBAAuB,IAAI,OAAO,CAAC,OAAO,CAAC,CAMrD;IAED,MAAM,CAAC,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC;IAQtC,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAgB3D,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/C,MAAM,CAAC,eAAe,CACpB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,OAAO,GAClB,OAAO,CAAC,IAAI,CAAC;IAShB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;WACU,oBAAoB,IAAI,OAAO,CAAC,OAAO,CAAC;IAUrD;;;;;;;;;;;OAWG;WACU,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAUnD;;;;;;;;;;OAUG;WACU,0BAA0B,CAAC,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAYxF;;OAEG;WACU,uBAAuB,CAAC,MAAM,EAAE,OAAO;IAIpD,MAAM,CAAC,eAAe,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjE,MAAM,CAAC,GAAG,CACR,aAAa,EAAE,aAAa,EAAE,EAC9B,cAAc,EAAE,kBAAkB,EAAE,GACnC,OAAO,CAAC,IAAI,CAAC;IAIhB,MAAM,CAAC,eAAe,CACpB,QAAQ,EAAE,kBAAkB,EAC5B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,IAAI,EACf,OAAO,EAAE,IAAI,GACZ,OAAO,CAAC,IAAI,CAAC;IAShB,MAAM,CAAC,qBAAqB,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAIvE,MAAM,CAAC,QAAQ,CAAC,SAAS,GAAE,aAAa,EAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/D;;;OAGG;IACH,MAAM,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAGhC;AAGD,oBAAY,aAAa;IACvB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,aAAa,kBAAkB;IAC/B,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,kBAAkB,uBAAuB;IACzC,iBAAiB,sBAAsB;IACvC,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,cAAc,mBAAmB;CAClC;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,cAAc,mBAAmB;CAClC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryvital/vital-health-react-native",
-  "version": "3.0.10",
+  "version": "3.1.0-beta.1",
   "description": "Client to access iOS's HealthKit and Android HealthConnect",
   "main": "lib/commonjs/index.js",
   "module": "lib/module/index.js",

package/src/index.tsx

@@ -28,9 +28,44 @@ export const VitalHealthEvents = {
   statusEvent: 'Status',
 };
 
+export interface SyncNotificationContent {
+  notificationTitle: string;
+  notificationContent: string;
+  channelName: string;
+  channelDescription: string;
+}
+
 export class VitalHealth {
   static status = new NativeEventEmitter(VitalHealthReactNative);
 
+  static get canEnableBackgroundSyncNoninteractively(): boolean {
+    return Platform.OS !== 'android';
+  }
+
+  /**
+   * Whether health data sync is paused at the moment.
+   */
+  static get pauseSynchronization(): Promise<boolean> {
+    return VitalHealthReactNative.getPauseSynchronization();
+  }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this property always returns `true`. iOS HealthKit Background Delivery is
+   * an app-level entitlement, and does not require explicit user consent.
+   * 
+   * ## Overview
+   * 
+   * Whether Background Sync on Android is enabled at the moment.
+   */
+  static get isBackgroundSyncEnabled(): Promise<boolean> {
+    if (Platform.OS !== 'android') {
+      return Promise.resolve(true);
+    }
+
+    return VitalHealthReactNative.isBackgroundSyncEnabled();
+  }
+
   static isAvailable(): Promise<boolean> {
     if (Platform.OS === 'android') {
       return VitalHealthReactNative.isAvailable();
@@ -73,6 +108,105 @@ export class VitalHealth {
     );
   }
 
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this method is a no-op returning `true`. iOS HealthKit Background Delivery is an app-level
+   * entitlement, and does not require explicit user consent.
+   * 
+   * If you intend to pause or unpause synchronization, use `pauseSynchronization`
+   * and `setPauseSynchronization(_:)` instead.
+   * 
+   * ## Overview
+   * 
+   * Enable background sync on Android. This includes requesting permissions from the end user whenever necessary.
+   *
+   * Vital SDK achieves automatic data sync through Android [AlarmManager] exact alarms.
+   *
+   * Refer to the [Vital Health Connect guide for full context and setup instructions](https://docs.tryvital.io/wearables/guides/android_health_connect).
+   *
+   * ## Gist on Exact Alarms
+   *
+   * "Exact Alarm" here refers to the Android Exact Alarm mechanism. The Vital SDK would propose
+   * to the Android OS to fire the next data sync with a T+60min wall clock target. The Android OS
+   * may fulfill the request exactly as proposed, e.g., when the user happens to be actively using
+   * the device. However, it may also choose to defer it arbitrarily, under the influence of
+   * power-saving policies like [Doze mode](https://developer.android.com/training/monitoring-device-state/doze-standby#understand_doze).
+   *
+   * On Android 12 (API Level 31) or above, this contract would automatically initiate the OS-required
+   * user consent flow for Exact Alarm usage. If the permission has been granted prior, this activity
+   * contract shall return synchronously.
+   *
+   * On Android 13 (API Level 33) or above, you have the option to use (with platform policy caveats)
+   * the [android.Manifest.permission.USE_EXACT_ALARM] permission instead, which does not require an
+   * explicit consent flow. This contract would return synchronously in this scenario.
+   *
+   * Regardless of API Level, your App Manifest must declare [android.Manifest.permission.RECEIVE_BOOT_COMPLETED].
+   * Otherwise, background sync stops once the phone encounters a cold reboot or a quick restart.
+   *
+   * @return `true` if the background sync has been enabled successfully. `false` otherwise.
+   */
+  static async enableBackgroundSync(): Promise<boolean> {
+    if (Platform.OS !== "android") {
+      // iOS background delivery does not require user explicit consent.
+      // It requires only the app-level HealthKit Bgnd. Delivery entitlement.
+      return true;
+    }
+    
+    return await VitalHealthReactNative.enableBackgroundSync();
+  }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this method is a no-op. iOS HealthKit Background Delivery is an app-level
+   * entitlement, and does not require explicit user consent.
+   * 
+   * If you intend to pause or unpause synchronization, use `pauseSynchronization`
+   * and `setPauseSynchronization(_:)` instead.
+   * 
+   * ## Overview
+   *
+   * Disable background sync on Android.
+   */
+  static async disableBackgroundSync(): Promise<void> {
+    if (Platform.OS !== "android") {
+      // iOS background delivery does not require user explicit consent.
+      // It requires only the app-level HealthKit Bgnd. Delivery entitlement.
+      return;
+    }
+
+    return await VitalHealthReactNative.disableBackgroundSync();
+  }
+
+  /**
+   * [Android ONLY][Experimental API]
+   * On iOS, this method is a no-op. iOS does not require apps to show a user-visible
+   * notification when performing extended work in background.
+   * 
+   * ## Overview
+   * Set the text content related to the Sync Notification. The OS has full discretion to present
+   * this notification to the user, when any data sync work in background is taking longer than expected.
+   * 
+   * Refer to the [Vital Health Connect guide for full context and setup instructions](https://docs.tryvital.io/wearables/guides/android_health_connect).
+   */
+  static async setSyncNotificationContent(content: SyncNotificationContent): Promise<void> {
+    if (Platform.OS !== "android") {
+      // iOS background delivery does not require user explicit consent.
+      // It requires only the app-level HealthKit Bgnd. Delivery entitlement.
+      return;
+    }
+
+    return await VitalHealthReactNative.setSyncNotificationContent(
+      JSON.stringify(content)
+    );
+  }
+
+  /**
+   * Pause or unpause health data sync.
+   */
+  static async setPauseSynchronization(paused: boolean) {
+    return await VitalHealthReactNative.setPauseSynchronization(paused);
+  }
+
   static askForResources(resources: VitalResource[]): Promise<void> {
     return VitalHealthReactNative.ask(resources, []);
   }