@kingstinct/react-native-healthkit 7.2.0 → 7.3.0

package/lib/typescript/src/native-types.d.ts

@@ -9,7 +9,7 @@ export declare const HKWorkoutTypeIdentifier: "HKWorkoutTypeIdentifier";
  * Represents a type that identifies activity summary objects.
  * @see {@link https://developer.apple.com/documentation/healthkit/hkactivitysummarytype Apple Docs HKActivitySummaryType}
  */
-export declare const HKActivitySummaryType: "HKActivitySummaryType";
+export declare const HKActivitySummaryTypeIdentifier: "HKActivitySummaryTypeIdentifier";
 /**
  * Represents an audiogram type identifier.
  * @see {@link https://developer.apple.com/documentation/healthkit/HKAudiogramSampleType Apple Docs HKAudiogramSampleType}
@@ -36,24 +36,24 @@ export declare enum HKQuantityTypeIdentifier {
      */
     bodyMassIndex = "HKQuantityTypeIdentifierBodyMassIndex",
     /**
-       * Body Fat Percentage
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodyfatpercentage Apple Docs HKQuantityTypeIdentifierBodyFatPercentage}
-       */
+     * Body Fat Percentage
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodyfatpercentage Apple Docs HKQuantityTypeIdentifierBodyFatPercentage}
+     */
     bodyFatPercentage = "HKQuantityTypeIdentifierBodyFatPercentage",
     /**
-       * Height
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheight Apple Docs HKQuantityTypeIdentifierHeight}
-       */
+     * Height
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheight Apple Docs HKQuantityTypeIdentifierHeight}
+     */
     height = "HKQuantityTypeIdentifierHeight",
     /**
-       * Body Mass
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodymass Apple Docs HKQuantityTypeIdentifierBodyMass}
-       */
+     * Body Mass
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierbodymass Apple Docs HKQuantityTypeIdentifierBodyMass}
+     */
     bodyMass = "HKQuantityTypeIdentifierBodyMass",
     /**
-       * Lean Body Mass
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierleanbodymass Apple Docs HKQuantityTypeIdentifierLeanBodyMass}
-       */
+     * Lean Body Mass
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierleanbodymass Apple Docs HKQuantityTypeIdentifierLeanBodyMass}
+     */
     leanBodyMass = "HKQuantityTypeIdentifierLeanBodyMass",
     /**
      * Waist Circumference
@@ -180,7 +180,7 @@ export declare enum HKQuantityTypeIdentifier {
      * Heart Rate Variability SDNN
      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierheartratevariabilitysdnn Apple Docs HKQuantityTypeIdentifierHeartRateVariabilitySDNN}
      * @since iOS 11.0
-    */
+     */
     heartRateVariabilitySDNN = "HKQuantityTypeIdentifierHeartRateVariabilitySDNN",
     /**
      * Oxygen Saturation
@@ -257,20 +257,20 @@ export declare enum HKQuantityTypeIdentifier {
      */
     headphoneAudioExposure = "HKQuantityTypeIdentifierHeadphoneAudioExposure",
     /**
-       * Dietary Fat Total
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfattotal Apple Docs HKQuantityTypeIdentifierDietaryFatTotal}
-       * @since iOS 8
-       */
+     * Dietary Fat Total
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfattotal Apple Docs HKQuantityTypeIdentifierDietaryFatTotal}
+     * @since iOS 8
+     */
     dietaryFatTotal = "HKQuantityTypeIdentifierDietaryFatTotal",
     /**
-       * Dietary Fat Polyunsaturated
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatpolyunsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatPolyunsaturated}
-       */
+     * Dietary Fat Polyunsaturated
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatpolyunsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatPolyunsaturated}
+     */
     dietaryFatPolyunsaturated = "HKQuantityTypeIdentifierDietaryFatPolyunsaturated",
     /**
-       * Dietary Fat Monounsaturated
-       * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatmonounsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatMonounsaturated}
-       */
+     * Dietary Fat Monounsaturated
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfatmonounsaturated Apple Docs HKQuantityTypeIdentifierDietaryFatMonounsaturated}
+     */
     dietaryFatMonounsaturated = "HKQuantityTypeIdentifierDietaryFatMonounsaturated",
     /**
      * Dietary Fat Saturated
@@ -278,24 +278,24 @@ export declare enum HKQuantityTypeIdentifier {
      */
     dietaryFatSaturated = "HKQuantityTypeIdentifierDietaryFatSaturated",
     /**
-      * Dietary Cholesterol
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycholesterol Apple Docs HKQuantityTypeIdentifierDietaryCholesterol}
-      */
+     * Dietary Cholesterol
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycholesterol Apple Docs HKQuantityTypeIdentifierDietaryCholesterol}
+     */
     dietaryCholesterol = "HKQuantityTypeIdentifierDietaryCholesterol",
     /**
-      * Dietary Sodium
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarysodium Apple Docs HKQuantityTypeIdentifierDietarySodium}
-      */
+     * Dietary Sodium
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarysodium Apple Docs HKQuantityTypeIdentifierDietarySodium}
+     */
     dietarySodium = "HKQuantityTypeIdentifierDietarySodium",
     /**
-      * Dietary Carbohydrates
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycarbohydrates Apple Docs HKQuantityTypeIdentifierDietaryCarbohydrates}
-      */
+     * Dietary Carbohydrates
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarycarbohydrates Apple Docs HKQuantityTypeIdentifierDietaryCarbohydrates}
+     */
     dietaryCarbohydrates = "HKQuantityTypeIdentifierDietaryCarbohydrates",
     /**
-      * Dietary Fiber
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfiber Apple Docs HKQuantityTypeIdentifierDietaryFiber}
-      */
+     * Dietary Fiber
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfiber Apple Docs HKQuantityTypeIdentifierDietaryFiber}
+     */
     dietaryFiber = "HKQuantityTypeIdentifierDietaryFiber",
     /**
      * Dietary Sugar
@@ -353,49 +353,49 @@ export declare enum HKQuantityTypeIdentifier {
      */
     dietaryCalcium = "HKQuantityTypeIdentifierDietaryCalcium",
     /**
-      * Dietary Iron
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryiron Apple Docs HKQuantityTypeIdentifierDietaryIron}
-      */
+     * Dietary Iron
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryiron Apple Docs HKQuantityTypeIdentifierDietaryIron}
+     */
     dietaryIron = "HKQuantityTypeIdentifierDietaryIron",
     /**
-      * Dietary Thiamin
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarythiamin Apple Docs HKQuantityTypeIdentifierDietaryThiamin}
-      */
+     * Dietary Thiamin
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarythiamin Apple Docs HKQuantityTypeIdentifierDietaryThiamin}
+     */
     dietaryThiamin = "HKQuantityTypeIdentifierDietaryThiamin",
     /**
-      * Dietary Riboflavin
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryriboflavin Apple Docs HKQuantityTypeIdentifierDietaryRiboflavin}
-      */
+     * Dietary Riboflavin
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryriboflavin Apple Docs HKQuantityTypeIdentifierDietaryRiboflavin}
+     */
     dietaryRiboflavin = "HKQuantityTypeIdentifierDietaryRiboflavin",
     /**
-      * Dietary Niacin
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryniacin Apple Docs HKQuantityTypeIdentifierDietaryNiacin}
-      */
+     * Dietary Niacin
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryniacin Apple Docs HKQuantityTypeIdentifierDietaryNiacin}
+     */
     dietaryNiacin = "HKQuantityTypeIdentifierDietaryNiacin",
     /**
-      * Dietary Folate
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfolate Apple Docs HKQuantityTypeIdentifierDietaryFolate}
-      */
+     * Dietary Folate
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryfolate Apple Docs HKQuantityTypeIdentifierDietaryFolate}
+     */
     dietaryFolate = "HKQuantityTypeIdentifierDietaryFolate",
     /**
-      * Dietary Biotin
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarybiotin Apple Docs HKQuantityTypeIdentifierDietaryBiotin}
-      */
+     * Dietary Biotin
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarybiotin Apple Docs HKQuantityTypeIdentifierDietaryBiotin}
+     */
     dietaryBiotin = "HKQuantityTypeIdentifierDietaryBiotin",
     /**
-      * Dietary Pantothenic Acid
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarypantothenicacid Apple Docs HKQuantityTypeIdentifierDietaryPantothenicAcid}
-      */
+     * Dietary Pantothenic Acid
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietarypantothenicacid Apple Docs HKQuantityTypeIdentifierDietaryPantothenicAcid}
+     */
     dietaryPantothenicAcid = "HKQuantityTypeIdentifierDietaryPantothenicAcid",
     /**
-      * Dietary Phosphorus
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryphosphorus Apple Docs HKQuantityTypeIdentifierDietaryPhosphorus}
-      */
+     * Dietary Phosphorus
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryphosphorus Apple Docs HKQuantityTypeIdentifierDietaryPhosphorus}
+     */
     dietaryPhosphorus = "HKQuantityTypeIdentifierDietaryPhosphorus",
     /**
-      * Dietary Iodine
-      * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryiodine Apple Docs HKQuantityTypeIdentifierDietaryIodine}
-      */
+     * Dietary Iodine
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitytypeidentifierdietaryiodine Apple Docs HKQuantityTypeIdentifierDietaryIodine}
+     */
     dietaryIodine = "HKQuantityTypeIdentifierDietaryIodine",
     /**
      * Dietary Magnesium
@@ -713,7 +713,7 @@ export declare enum HKCategoryTypeIdentifier {
     vomiting = "HKCategoryTypeIdentifierVomiting",
     wheezing = "HKCategoryTypeIdentifierWheezing"
 }
-export type HKSampleTypeIdentifier = HKCategoryTypeIdentifier | HKCorrelationTypeIdentifier | HKQuantityTypeIdentifier | typeof HKActivitySummaryType | typeof HKAudiogramTypeIdentifier | typeof HKDataTypeIdentifierHeartbeatSeries | typeof HKWorkoutRouteTypeIdentifier | typeof HKWorkoutTypeIdentifier | `${HKCategoryTypeIdentifier}` | `${HKCorrelationTypeIdentifier}` | `${HKQuantityTypeIdentifier}`;
+export type HKSampleTypeIdentifier = HKCategoryTypeIdentifier | HKCorrelationTypeIdentifier | HKQuantityTypeIdentifier | typeof HKActivitySummaryTypeIdentifier | typeof HKAudiogramTypeIdentifier | typeof HKDataTypeIdentifierHeartbeatSeries | typeof HKWorkoutRouteTypeIdentifier | typeof HKWorkoutTypeIdentifier | `${HKCategoryTypeIdentifier}` | `${HKCorrelationTypeIdentifier}` | `${HKQuantityTypeIdentifier}`;
 export type HealthkitReadAuthorization = HKCharacteristicTypeIdentifier | HKSampleTypeIdentifier | `${HKCharacteristicTypeIdentifier}` | `${HKSampleTypeIdentifier}`;
 export type HealthkitWriteAuthorization = HKSampleTypeIdentifier;
 export declare enum HKCategoryValueAppleStandHour {
@@ -1392,8 +1392,8 @@ export type HKCorrelationRaw<TIdentifier extends HKCorrelationTypeIdentifier> =
 };
 type QueryId = string;
 /**
-* @see {@link https://developer.apple.com/documentation/healthkit/hkupdatefrequency Apple Docs }
-*/
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkupdatefrequency Apple Docs }
+ */
 export declare enum HKUpdateFrequency {
     immediate = 1,
     hourly = 2,
@@ -1428,33 +1428,36 @@ type ReactNativeHealthkitTypeNative = {
     getFitzpatrickSkinType(): Promise<HKFitzpatrickSkinType>;
     readonly getWheelchairUse: () => Promise<HKWheelchairUse>;
     /**
-    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614175-enablebackgrounddelivery Apple Docs }
-    */
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614175-enablebackgrounddelivery Apple Docs }
+     */
     readonly enableBackgroundDelivery: (typeIdentifier: HKSampleTypeIdentifier, updateFrequency: HKUpdateFrequency) => Promise<boolean>;
     /**
      * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614177-disablebackgrounddelivery Apple Docs }
      */
     readonly disableBackgroundDelivery: (typeIdentifier: HKSampleTypeIdentifier) => Promise<boolean>;
     /**
-    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614158-disableallbackgrounddelivery Apple Docs }
-    */
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614158-disableallbackgrounddelivery Apple Docs }
+     */
     readonly disableAllBackgroundDelivery: () => Promise<boolean>;
     readonly saveCorrelationSample: <TIdentifier extends HKCorrelationTypeIdentifier, TSamples extends readonly (HKCategorySampleRawForSaving | HKQuantitySampleRawForSaving)[]>(typeIdentifier: TIdentifier, samples: TSamples, start: string, end: string, metadata: MetadataMapperForCorrelationIdentifier<TIdentifier>) => Promise<boolean>;
-    readonly saveWorkoutSample: (typeIdentifier: HKWorkoutActivityType, quantities: readonly HKQuantitySampleRawForSaving[], start: string, end: string, metadata: HKWorkoutMetadata) => Promise<string | null>;
+    readonly saveWorkoutSample: (typeIdentifier: HKWorkoutActivityType, quantities: readonly HKQuantitySampleRawForSaving[], start: string, end: string, totals: {
+        readonly distance?: number;
+        readonly energyBurned?: number;
+    }, metadata: HKWorkoutMetadata) => Promise<string | null>;
     readonly saveWorkoutRoute: (workoutUUID: string, locations: readonly CLLocationRawForSaving[]) => Promise<boolean>;
     readonly queryCorrelationSamples: <TIdentifier extends HKCorrelationTypeIdentifier>(typeIdentifier: TIdentifier, from: string, to: string) => Promise<readonly HKCorrelationRaw<TIdentifier>[]>;
     subscribeToObserverQuery(identifier: HKSampleTypeIdentifier): Promise<QueryId>;
     unsubscribeQuery(queryId: QueryId): Promise<boolean>;
     /**
-    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614154-authorizationstatus Apple Docs }
-    */
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614154-authorizationstatus Apple Docs }
+     */
     authorizationStatusFor(type: HealthkitReadAuthorization): Promise<HKAuthorizationStatus>;
     /**
-    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/2994346-getrequeststatusforauthorization Apple Docs }
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/2994346-getrequeststatusforauthorization Apple Docs }
      */
     getRequestStatusForAuthorization(write: WritePermissions, read: ReadPermissions): Promise<HKAuthorizationRequestStatus>;
     /**
-    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization Apple Docs }
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization Apple Docs }
      */
     requestAuthorization(write: WritePermissions, read: ReadPermissions): Promise<boolean>;
     readonly saveQuantitySample: <TType extends HKQuantityTypeIdentifier, TUnit extends UnitForIdentifier<TType> = UnitForIdentifier<TType>>(identifier: TType, unit: TUnit, value: number, start: string, end: string, metadata: unknown) => Promise<boolean>;
@@ -1472,6 +1475,10 @@ type ReactNativeHealthkitTypeNative = {
     readonly queryStatisticsForQuantity: <TIdentifier extends HKQuantityTypeIdentifier, TUnit extends UnitForIdentifier<TIdentifier>>(identifier: HKQuantityTypeIdentifier, unit: TUnit, from: string, to: string, options: readonly HKStatisticsOptions[]) => Promise<QueryStatisticsResponseRaw<TIdentifier, TUnit>>;
     readonly getPreferredUnits: (identifiers: readonly HKQuantityTypeIdentifier[]) => Promise<TypeToUnitMapping>;
     readonly getWorkoutRoutes: (workoutUUID: string) => Promise<readonly WorkoutRoute[]>;
+    readonly getWorkoutPlanById: (workoutUUID: string) => Promise<{
+        readonly id: string;
+        readonly activityType: HKWorkoutActivityType;
+    } | null>;
 };
 declare const Native: ReactNativeHealthkitTypeNative;
 type OnChangeCallback = ({ typeIdentifier, }: {

package/lib/typescript/src/utils/ensureTotals.d.ts

@@ -0,0 +1,2 @@
+declare function ensureTotals<TTotals>(totals?: TTotals): TTotals;
+export default ensureTotals;

package/lib/typescript/src/utils/getWorkoutPlanById.d.ts

@@ -0,0 +1,5 @@
+declare function getWorkoutPlanById(workoutUUID: string): Promise<{
+    readonly id: string;
+    readonly activityType: import("../native-types").HKWorkoutActivityType;
+} | null>;
+export default getWorkoutPlanById;

package/lib/typescript/src/utils/saveWorkoutSample.d.ts

@@ -2,6 +2,10 @@ import type { HKWorkoutActivityType, HKWorkoutMetadata } from '../native-types';
 import type { HKQuantitySampleForSaving } from '../types';
 declare function saveWorkoutSample<TIdentifier extends HKWorkoutActivityType>(typeIdentifier: TIdentifier, quantities: readonly HKQuantitySampleForSaving[], _start: Date, options?: {
     readonly end?: Date;
+    readonly totals?: {
+        readonly distance?: number;
+        readonly energyBurned?: number;
+    };
     readonly metadata?: HKWorkoutMetadata;
 }): Promise<string | null>;
 export default saveWorkoutSample;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kingstinct/react-native-healthkit",
-  "version": "7.2.0",
+  "version": "7.3.0",
   "description": "React Native bindings for HealthKit",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/index.ios.tsx

@@ -16,6 +16,7 @@ import getMostRecentWorkout from './utils/getMostRecentWorkout'
 import getPreferredUnit from './utils/getPreferredUnit'
 import getPreferredUnits from './utils/getPreferredUnits'
 import getRequestStatusForAuthorization from './utils/getRequestStatusForAuthorization'
+import getWorkoutPlanById from './utils/getWorkoutPlanById'
 import queryCategorySamples from './utils/queryCategorySamples'
 import queryCategorySamplesWithAnchor from './utils/queryCategorySamplesWithAnchor'
 import queryCorrelationSamples from './utils/queryCorrelationSamples'
@@ -150,6 +151,7 @@ export default {
   * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutroutequery HKWorkoutRouteQuery (Apple Docs)}
    */
   getWorkoutRoutes,
+  getWorkoutPlanById,
 
   getPreferredUnit,
   getPreferredUnits,

package/src/index.tsx

@@ -77,6 +77,7 @@ const Healthkit = {
   requestAuthorization: UnavailableFn(Promise.resolve(false)),
   deleteQuantitySample: UnavailableFn(Promise.resolve(false)),
   deleteSamples: UnavailableFn(Promise.resolve(false)),
+  getWorkoutPlanById: UnavailableFn(Promise.resolve(null)),
   saveCategorySample: UnavailableFn(Promise.resolve(false)),
   saveCorrelationSample: UnavailableFn(Promise.resolve(false)),
   saveQuantitySample: UnavailableFn(Promise.resolve(false)),

package/src/jest.setup.ts

@@ -2,7 +2,7 @@ import { NativeModule, NativeModules } from 'react-native'
 
 import type Native from './native-types'
 
-const mockModule: (NativeModule & typeof Native) = {
+const mockModule: NativeModule & typeof Native = {
   isHealthDataAvailable: jest.fn(),
   addListener: jest.fn(),
   removeListeners: jest.fn(),
@@ -40,6 +40,7 @@ const mockModule: (NativeModule & typeof Native) = {
   // Todo [>8]: Remove to align with Apple function name (isProtectedDataAvailable)
   canAccessProtectedData: jest.fn(),
   saveWorkoutRoute: jest.fn(),
+  getWorkoutPlanById: jest.fn(),
 }
 
 NativeModules.ReactNativeHealthkit = mockModule