@kingstinct/react-native-healthkit 7.2.0 → 7.3.1

package/lib/typescript/src/hooks/useMostRecentCategorySample.d.ts

@@ -1,4 +1,7 @@
 import type { HKCategoryTypeIdentifier } from '../native-types';
 import type { HKCategorySample } from '../types';
+/**
+   * @returns the most recent sample for the given category type.
+   */
 declare function useMostRecentCategorySample<TCategory extends HKCategoryTypeIdentifier>(identifier: TCategory): HKCategorySample<TCategory> | null;
 export default useMostRecentCategorySample;

package/lib/typescript/src/hooks/useMostRecentQuantitySample.d.ts

@@ -1,4 +1,7 @@
 import type { HKQuantityTypeIdentifier, UnitForIdentifier } from '../native-types';
 import type { HKQuantitySample } from '../types';
+/**
+   * @returns the most recent sample for the given quantity type.
+   */
 declare function useMostRecentQuantitySample<TIdentifier extends HKQuantityTypeIdentifier, TUnit extends UnitForIdentifier<TIdentifier>>(identifier: TIdentifier, unit?: TUnit): HKQuantitySample<TIdentifier, UnitForIdentifier<TIdentifier>> | null;
 export default useMostRecentQuantitySample;

package/lib/typescript/src/hooks/useMostRecentWorkout.d.ts

@@ -1,5 +1,8 @@
 import type { EnergyUnit, LengthUnit } from '../native-types';
 import type { HKWorkout } from '../types';
+/**
+   * @returns the most recent workout sample.
+   */
 declare function useMostRecentWorkout<TEnergy extends EnergyUnit, TDistance extends LengthUnit>(options?: {
     readonly energyUnit?: TEnergy;
     readonly distanceUnit?: TDistance;

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

@@ -1,52 +1,180 @@
-import { HKAuthorizationRequestStatus, HKAuthorizationStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKWheelchairUse } from './native-types';
-import type { QueryCategorySamplesFn } from './utils/queryCategorySamples';
-import type { QueryQuantitySamplesFn } from './utils/queryQuantitySamples';
-export * from './types';
+import useHealthkitAuthorization from './hooks/useHealthkitAuthorization';
+import useIsHealthDataAvailable from './hooks/useIsHealthDataAvailable';
+import useMostRecentCategorySample from './hooks/useMostRecentCategorySample';
+import useMostRecentQuantitySample from './hooks/useMostRecentQuantitySample';
+import useMostRecentWorkout from './hooks/useMostRecentWorkout';
+import useSources from './hooks/useSources';
+import useStatisticsForQuantity from './hooks/useStatisticsForQuantity';
+import useSubscribeToChanges from './hooks/useSubscribeToChanges';
+import { HKQuantityTypeIdentifier } from './native-types';
+import deleteQuantitySample from './utils/deleteQuantitySample';
+import deleteSamples from './utils/deleteSamples';
+import getDateOfBirth from './utils/getDateOfBirth';
+import getMostRecentCategorySample from './utils/getMostRecentCategorySample';
+import getMostRecentQuantitySample from './utils/getMostRecentQuantitySample';
+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';
+import queryHeartbeatSeriesSamples from './utils/queryHeartbeatSeriesSamples';
+import queryHeartbeatSeriesSamplesWithAnchor from './utils/queryHeartbeatSeriesSamplesWithAnchor';
+import queryQuantitySamples from './utils/queryQuantitySamples';
+import queryQuantitySamplesWithAnchor from './utils/queryQuantitySamplesWithAnchor';
+import querySources from './utils/querySources';
+import queryStatisticsForQuantity from './utils/queryStatisticsForQuantity';
+import queryWorkouts from './utils/queryWorkouts';
+import requestAuthorization from './utils/requestAuthorization';
+import saveCategorySample from './utils/saveCategorySample';
+import saveCorrelationSample from './utils/saveCorrelationSample';
+import saveQuantitySample from './utils/saveQuantitySample';
+import saveWorkoutRoute from './utils/saveWorkoutRoute';
+import saveWorkoutSample from './utils/saveWorkoutSample';
+import subscribeToChanges from './utils/subscribeToChanges';
+declare const availableQuantityTypes: (majorVersionIOS?: number) => HKQuantityTypeIdentifier[];
+declare const authorizationStatusFor: (type: import("./native-types").HealthkitReadAuthorization) => Promise<import("./native-types").HKAuthorizationStatus>;
+declare const isHealthDataAvailable: () => Promise<boolean>;
+declare const canAccessProtectedData: () => Promise<boolean>;
+declare const disableBackgroundDelivery: (typeIdentifier: import("./native-types").HKSampleTypeIdentifier) => Promise<boolean>;
+declare const disableAllBackgroundDelivery: () => Promise<boolean>;
+declare const enableBackgroundDelivery: (typeIdentifier: import("./native-types").HKSampleTypeIdentifier, updateFrequency: import("./native-types").HKUpdateFrequency) => Promise<boolean>;
+declare const getBiologicalSex: () => Promise<import("./native-types").HKBiologicalSex>;
+declare const getFitzpatrickSkinType: () => Promise<import("./native-types").HKFitzpatrickSkinType>;
+declare const getWheelchairUse: () => Promise<import("./native-types").HKWheelchairUse>;
+declare const getBloodType: () => Promise<import("./native-types").HKBloodType>;
+declare const getWorkoutRoutes: (workoutUUID: string) => Promise<readonly import("./native-types").WorkoutRoute[]>;
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/about_the_healthkit_framework About the HealthKit Framework (Apple Docs)}
+ */
 declare const _default: {
-    authorizationStatusFor: (type: import("./native-types").HealthkitReadAuthorization) => Promise<HKAuthorizationStatus>;
-    availableQuantityTypes: (majorVersionIOS?: number) => import("./native-types").HKQuantityTypeIdentifier[];
+    /**
+    * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614154-authorizationstatus authorizationStatus(for:) (Apple Docs) }
+    * @see {@link https://developer.apple.com/documentation/healthkit/authorizing_access_to_health_data Authorizing access to health data (Apple Docs) }
+    */
+    authorizationStatusFor: (type: import("./native-types").HealthkitReadAuthorization) => Promise<import("./native-types").HKAuthorizationStatus>;
+    /**
+     *
+     * @returns All available quantity types for the current iOS version (currently excluding types that are not available before iOS 17)
+     */
+    availableQuantityTypes: (majorVersionIOS?: number) => HKQuantityTypeIdentifier[];
+    /**
+      * @description By default, HealthKit data is available on iOS and watchOS. HealthKit data is also available on iPadOS 17 or later. However, devices running in an enterprise environment may restrict access to HealthKit data.
+      * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable isHealthDataAvailable() (Apple Docs)}
+      * @returns {boolean} true if HealthKit is available; otherwise, false.
+      */
     isHealthDataAvailable: () => Promise<boolean>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614181-isprotecteddataavailable isProtectedDataAvailable() (Apple Docs)}
+     * @see {@link https://developer.apple.com/documentation/healthkit/protecting_user_privacy#3705074 Protecting User Privacy - Access encrypted data (Apple Docs)}
+     * @returns {boolean} A Boolean value that indicates whether content protection is active.
+     */
     isProtectedDataAvailable: () => Promise<boolean>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614181-isprotecteddataavailable isProtectedDataAvailable() (Apple Docs)}
+     * @see {@link https://developer.apple.com/documentation/healthkit/protecting_user_privacy#3705074 Protecting User Privacy - Access encrypted data (Apple Docs)}
+     * @deprecated Use {@link isProtectedDataAvailable} instead. Will be removed in next major version.
+     * @returns {boolean} A Boolean value that indicates whether content protection is active.
+     */
     canAccessProtectedData: () => Promise<boolean>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614158-disableallbackgrounddelivery disableAllBackgroundDelivery(completion:) (Apple Docs)}
+     */
     disableAllBackgroundDelivery: () => Promise<boolean>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614177-disablebackgrounddelivery disableBackgroundDelivery(for:withCompletion:) (Apple Docs)}
+     */
     disableBackgroundDelivery: (typeIdentifier: import("./native-types").HKSampleTypeIdentifier) => Promise<boolean>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614175-enablebackgrounddelivery enableBackgroundDelivery(for:frequency:withCompletion:) (Apple Docs)}
+     */
     enableBackgroundDelivery: (typeIdentifier: import("./native-types").HKSampleTypeIdentifier, updateFrequency: import("./native-types").HKUpdateFrequency) => Promise<boolean>;
-    getBiologicalSex: () => Promise<HKBiologicalSex>;
-    getFitzpatrickSkinType: () => Promise<HKFitzpatrickSkinType>;
-    getWheelchairUse: () => Promise<HKWheelchairUse>;
-    getBloodType: () => Promise<HKBloodType>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614171-biologicalsex biologicalSex() (Apple Docs)}
+     */
+    getBiologicalSex: () => Promise<import("./native-types").HKBiologicalSex>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614161-fitzpatrickskintype fitzpatrickSkinType() (Apple Docs)}
+     */
+    getFitzpatrickSkinType: () => Promise<import("./native-types").HKFitzpatrickSkinType>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1648356-wheelchairuse wheelchairUse() (Apple Docs)}
+     */
+    getWheelchairUse: () => Promise<import("./native-types").HKWheelchairUse>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614164-bloodtype bloodType() (Apple Docs)}
+     */
+    getBloodType: () => Promise<import("./native-types").HKBloodType>;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1648357-dateofbirthcomponents dateOfBirthComponents() (Apple Docs)}
+     */
     getDateOfBirth: () => Promise<Date>;
-    getMostRecentQuantitySample: typeof import("./utils/getMostRecentQuantitySample").default;
-    getMostRecentCategorySample: typeof import("./utils/getMostRecentCategorySample").default;
+    getMostRecentQuantitySample: typeof getMostRecentQuantitySample;
+    getMostRecentCategorySample: typeof getMostRecentCategorySample;
     getMostRecentWorkout: import("./utils/getMostRecentWorkout").GetMostRecentWorkoutFn;
+    /**
+    * @see {@link https://developer.apple.com/documentation/healthkit/workouts_and_activity_rings/reading_route_data Reading route data (Apple Docs)}
+    * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutroutequery HKWorkoutRouteQuery (Apple Docs)}
+     */
     getWorkoutRoutes: (workoutUUID: string) => Promise<readonly import("./native-types").WorkoutRoute[]>;
+    getWorkoutPlanById: typeof getWorkoutPlanById;
     getPreferredUnit: import("./utils/getPreferredUnit").GetPreferredUnitFn;
     getPreferredUnits: import("./utils/getPreferredUnits").GetPreferredUnitsFn;
-    getRequestStatusForAuthorization: (read: readonly import("./native-types").HealthkitReadAuthorization[], write?: readonly import("./native-types").HKSampleTypeIdentifier[]) => Promise<HKAuthorizationRequestStatus>;
-    queryCategorySamples: QueryCategorySamplesFn;
+    getRequestStatusForAuthorization: (read: readonly import("./native-types").HealthkitReadAuthorization[], write?: readonly import("./native-types").HKSampleTypeIdentifier[]) => Promise<import("./native-types").HKAuthorizationRequestStatus>;
+    queryCategorySamples: import("./utils/queryCategorySamples").QueryCategorySamplesFn;
     queryCategorySamplesWithAnchor: import("./utils/queryCategorySamplesWithAnchor").QueryCategorySamplesWithAnchorFn;
     queryCorrelationSamples: import("./utils/queryCorrelationSamples").QueryCorrelationSamplesFn;
     queryHeartbeatSeriesSamples: import("./utils/queryHeartbeatSeriesSamples").QueryHeartbeatSeriesSamplesFn;
     queryHeartbeatSeriesSamplesWithAnchor: import("./utils/queryHeartbeatSeriesSamplesWithAnchor").QueryHeartbeatSeriesSamplesFn;
-    queryQuantitySamples: QueryQuantitySamplesFn;
+    queryQuantitySamples: import("./utils/queryQuantitySamples").QueryQuantitySamplesFn;
     queryQuantitySamplesWithAnchor: import("./utils/queryQuantitySamplesWithAnchor").QueryQuantitySamplesWithAnchorFn;
-    queryStatisticsForQuantity: typeof import("./utils/queryStatisticsForQuantity").default;
-    queryWorkouts: typeof import("./utils/queryWorkouts").default;
+    queryStatisticsForQuantity: typeof queryStatisticsForQuantity;
+    queryWorkouts: typeof queryWorkouts;
     querySources: import("./utils/querySources").QuerySourcesFn;
     requestAuthorization: (read: readonly import("./native-types").HealthkitReadAuthorization[], write?: readonly import("./native-types").HKSampleTypeIdentifier[]) => Promise<boolean>;
     deleteQuantitySample: import("./utils/deleteQuantitySample").DeleteQuantitySampleFn;
     deleteSamples: import("./utils/deleteSamples").DeleteSamplesFn;
-    saveCategorySample: typeof import("./utils/saveCategorySample").default;
-    saveCorrelationSample: typeof import("./utils/saveCorrelationSample").default;
-    saveQuantitySample: typeof import("./utils/saveQuantitySample").default;
-    saveWorkoutSample: typeof import("./utils/saveWorkoutSample").default;
-    saveWorkoutRoute: typeof import("./utils/saveWorkoutRoute").default;
+    /**
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614168-savecategorysample save(_:withCompletion:) (Apple Docs)}
+     * @see {@link https://developer.apple.com/documentation/healthkit/saving_data_to_healthkit Saving data to HealthKit (Apple Docs)}
+     */
+    saveCategorySample: typeof saveCategorySample;
+    saveCorrelationSample: typeof saveCorrelationSample;
+    saveQuantitySample: typeof saveQuantitySample;
+    saveWorkoutSample: typeof saveWorkoutSample;
+    saveWorkoutRoute: typeof saveWorkoutRoute;
     subscribeToChanges: (identifier: import("./native-types").HKSampleTypeIdentifier, callback: () => void) => Promise<() => Promise<boolean>>;
-    useMostRecentCategorySample: typeof import("./hooks/useMostRecentCategorySample").default;
-    useMostRecentQuantitySample: typeof import("./hooks/useMostRecentQuantitySample").default;
-    useMostRecentWorkout: typeof import("./hooks/useMostRecentWorkout").default;
-    useSubscribeToChanges: typeof import("./hooks/useSubscribeToChanges").default;
+    /**
+     * @returns the most recent sample for the given category type.
+     */
+    useMostRecentCategorySample: typeof useMostRecentCategorySample;
+    /**
+     * @returns the most recent sample for the given quantity type.
+     */
+    useMostRecentQuantitySample: typeof useMostRecentQuantitySample;
+    /**
+     * @returns the most recent workout sample.
+     */
+    useMostRecentWorkout: typeof useMostRecentWorkout;
+    useSubscribeToChanges: typeof useSubscribeToChanges;
+    /**
+       * @description By default, HealthKit data is available on iOS and watchOS. HealthKit data is also available on iPadOS 17 or later. However, devices running in an enterprise environment may restrict access to HealthKit data.
+      * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable Apple Docs}
+      * @returns {boolean | null} true if HealthKit is available; otherwise, false. null while initializing.
+      */
     useIsHealthDataAvailable: () => boolean | null;
-    useHealthkitAuthorization: (read: readonly import("./native-types").HealthkitReadAuthorization[], write?: readonly import("./native-types").HKSampleTypeIdentifier[] | undefined) => readonly [HKAuthorizationRequestStatus | null, () => Promise<HKAuthorizationRequestStatus>];
+    /**
+     * @description Hook to retrieve the current authorization status for the given types, and request authorization if needed.
+     * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization Apple Docs - requestAuthorization}
+     * @see {@link https://developer.apple.com/documentation/healthkit/authorizing_access_to_health_data Apple Docs - Authorizing access to health data}
+     */
+    useHealthkitAuthorization: (read: readonly import("./native-types").HealthkitReadAuthorization[], write?: readonly import("./native-types").HKSampleTypeIdentifier[] | undefined) => readonly [import("./native-types").HKAuthorizationRequestStatus | null, () => Promise<import("./native-types").HKAuthorizationRequestStatus>];
+    useSources: typeof useSources;
+    useStatisticsForQuantity: typeof useStatisticsForQuantity;
 };
 export default _default;
+declare const isProtectedDataAvailable: () => Promise<boolean>;
+export { authorizationStatusFor, availableQuantityTypes, disableAllBackgroundDelivery, disableBackgroundDelivery, enableBackgroundDelivery, getBiologicalSex, getBloodType, getDateOfBirth, getFitzpatrickSkinType, getMostRecentCategorySample, getMostRecentQuantitySample, getMostRecentWorkout, getPreferredUnit, getPreferredUnits, getRequestStatusForAuthorization, getWheelchairUse, getWorkoutRoutes, isHealthDataAvailable, queryCategorySamples, queryCategorySamplesWithAnchor, queryCorrelationSamples, queryHeartbeatSeriesSamples, queryHeartbeatSeriesSamplesWithAnchor, queryQuantitySamples, queryQuantitySamplesWithAnchor, queryStatisticsForQuantity, queryWorkouts, querySources, requestAuthorization, deleteQuantitySample, deleteSamples, getWorkoutPlanById, saveCategorySample, saveCorrelationSample, saveQuantitySample, saveWorkoutSample, saveWorkoutRoute, subscribeToChanges, useMostRecentCategorySample, useMostRecentQuantitySample, useMostRecentWorkout, useSubscribeToChanges, useHealthkitAuthorization, useIsHealthDataAvailable, useSources, useStatisticsForQuantity, canAccessProtectedData, isProtectedDataAvailable, };
+export * from './types';

package/lib/typescript/src/index.native.d.ts

@@ -0,0 +1,29 @@
+import { HKAuthorizationRequestStatus, HKAuthorizationStatus, HKBiologicalSex, HKBloodType, HKFitzpatrickSkinType, HKUnits, HKWheelchairUse } from './native-types';
+import type ReactNativeHealthkit from '.';
+import type { QueryCategorySamplesFn } from './utils/queryCategorySamples';
+import type { QueryQuantitySamplesFn } from './utils/queryQuantitySamples';
+declare const authorizationStatusFor: () => Promise<HKAuthorizationStatus>, availableQuantityTypes: () => never[], disableAllBackgroundDelivery: () => Promise<boolean>, disableBackgroundDelivery: () => Promise<boolean>, enableBackgroundDelivery: () => Promise<boolean>, getBiologicalSex: () => Promise<HKBiologicalSex>, getBloodType: () => Promise<HKBloodType>, getDateOfBirth: () => Promise<Date>, getFitzpatrickSkinType: () => Promise<HKFitzpatrickSkinType>, getMostRecentCategorySample: () => Promise<null>, getMostRecentQuantitySample: () => Promise<null>, getMostRecentWorkout: () => Promise<null>, getPreferredUnit: () => Promise<HKUnits>, getPreferredUnits: () => Promise<never[]>, getRequestStatusForAuthorization: () => Promise<HKAuthorizationRequestStatus>, getWheelchairUse: () => Promise<HKWheelchairUse>, getWorkoutRoutes: () => Promise<never[]>, isHealthDataAvailable: () => Promise<boolean>, useSources: () => null, useStatisticsForQuantity: () => null, queryCategorySamples: QueryCategorySamplesFn, queryCategorySamplesWithAnchor: () => Promise<{
+    samples: never[];
+    deletedSamples: never[];
+    newAnchor: string;
+}>, queryCorrelationSamples: () => Promise<never[]>, queryHeartbeatSeriesSamples: () => Promise<never[]>, queryHeartbeatSeriesSamplesWithAnchor: () => Promise<{
+    samples: never[];
+    deletedSamples: never[];
+    newAnchor: string;
+}>, queryQuantitySamples: QueryQuantitySamplesFn, queryQuantitySamplesWithAnchor: () => Promise<{
+    samples: never[];
+    deletedSamples: never[];
+    newAnchor: string;
+}>, queryStatisticsForQuantity: () => Promise<{
+    averageQuantity: undefined;
+    maximumQuantity: undefined;
+    minimumQuantity: undefined;
+    sumQuantity: undefined;
+    mostRecentQuantity: undefined;
+    mostRecentQuantityDateInterval: undefined;
+    duration: undefined;
+}>, queryWorkouts: () => Promise<never[]>, querySources: () => Promise<never[]>, requestAuthorization: () => Promise<boolean>, deleteQuantitySample: () => Promise<boolean>, deleteSamples: () => Promise<boolean>, getWorkoutPlanById: () => Promise<null>, saveCategorySample: () => Promise<boolean>, saveCorrelationSample: () => Promise<boolean>, saveQuantitySample: () => Promise<boolean>, saveWorkoutSample: () => Promise<null>, saveWorkoutRoute: () => Promise<boolean>, subscribeToChanges: () => Promise<() => Promise<boolean>>, useMostRecentCategorySample: () => null, useMostRecentQuantitySample: () => null, useMostRecentWorkout: () => null, useSubscribeToChanges: () => ((() => null) | null)[], useHealthkitAuthorization: () => readonly [null, () => Promise<HKAuthorizationRequestStatus>], useIsHealthDataAvailable: () => boolean, canAccessProtectedData: () => Promise<boolean>, isProtectedDataAvailable: () => Promise<boolean>;
+declare const Healthkit: typeof ReactNativeHealthkit;
+export { authorizationStatusFor, availableQuantityTypes, disableAllBackgroundDelivery, disableBackgroundDelivery, enableBackgroundDelivery, useSources, useStatisticsForQuantity, getBiologicalSex, getBloodType, getDateOfBirth, getFitzpatrickSkinType, getMostRecentCategorySample, getMostRecentQuantitySample, getMostRecentWorkout, getPreferredUnit, getPreferredUnits, getRequestStatusForAuthorization, getWheelchairUse, getWorkoutRoutes, isHealthDataAvailable, queryCategorySamples, queryCategorySamplesWithAnchor, queryCorrelationSamples, queryHeartbeatSeriesSamples, queryHeartbeatSeriesSamplesWithAnchor, queryQuantitySamples, queryQuantitySamplesWithAnchor, queryStatisticsForQuantity, queryWorkouts, querySources, requestAuthorization, deleteQuantitySample, deleteSamples, getWorkoutPlanById, saveCategorySample, saveCorrelationSample, saveQuantitySample, saveWorkoutSample, saveWorkoutRoute, subscribeToChanges, useMostRecentCategorySample, useMostRecentQuantitySample, useMostRecentWorkout, useSubscribeToChanges, useHealthkitAuthorization, useIsHealthDataAvailable, canAccessProtectedData, isProtectedDataAvailable, };
+export * from './types';
+export default Healthkit;

package/lib/typescript/src/index.web.d.ts

@@ -0,0 +1 @@
+export * from './index.native';

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/saveCategorySample.d.ts

@@ -1,4 +1,8 @@
 import type { HKCategoryTypeIdentifier, HKCategoryValueForIdentifier, MetadataMapperForCategoryIdentifier } from '../native-types';
+/**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614168-savecategorysample save(_:withCompletion:) (Apple Docs)}
+   * @see {@link https://developer.apple.com/documentation/healthkit/saving_data_to_healthkit Saving data to HealthKit (Apple Docs)}
+   */
 declare function saveCategorySample<T extends HKCategoryTypeIdentifier>(identifier: T, value: HKCategoryValueForIdentifier<T>, options?: {
     readonly start?: Date;
     readonly end?: Date;

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.1",
   "description": "React Native bindings for HealthKit",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/src/hooks/useHealthkitAuthorization.ts

@@ -7,6 +7,11 @@ import requestAuthorization from '../utils/requestAuthorization'
 
 import type { HealthkitReadAuthorization, HealthkitWriteAuthorization, HKAuthorizationRequestStatus } from '../native-types'
 
+/**
+   * @description Hook to retrieve the current authorization status for the given types, and request authorization if needed.
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614152-requestauthorization Apple Docs - requestAuthorization}
+   * @see {@link https://developer.apple.com/documentation/healthkit/authorizing_access_to_health_data Apple Docs - Authorizing access to health data}
+   */
 const useHealthkitAuthorization = (read: readonly HealthkitReadAuthorization[], write?: readonly HealthkitWriteAuthorization[]) => {
   const [status, setStatus] = useState<HKAuthorizationRequestStatus | null>(null)