@kingstinct/react-native-healthkit 7.0.4 → 7.0.6

package/src/types.ts

@@ -18,6 +18,12 @@ import type {
 
 export * from './native-types'
 
+/**
+ * Options for querying workouts.
+ * @template TEnergy The energy unit type.
+ * @template TDistance The distance unit type.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkout Apple Docs HKWorkout}
+ */
 export interface QueryWorkoutsOptions<
   TEnergy extends HKUnit,
   TDistance extends HKUnit
@@ -26,6 +32,11 @@ export interface QueryWorkoutsOptions<
   readonly distanceUnit?: TDistance;
 }
 
+/**
+ * Represents a category sample.
+ * @template T The category type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorysample Apple Docs HKCategorySample}
+ */
 export interface HKCategorySample<
   T extends HKCategoryTypeIdentifier = HKCategoryTypeIdentifier
 > extends Omit<HKCategorySampleRaw<T>, 'endDate' | 'startDate'> {
@@ -33,6 +44,9 @@ export interface HKCategorySample<
   readonly endDate: Date;
 }
 
+/**
+ * Generic options for querying.
+ */
 export type GenericQueryOptions = {
   readonly from?: Date;
   readonly to?: Date;
@@ -41,6 +55,12 @@ export type GenericQueryOptions = {
   readonly anchor?: string
 };
 
+/**
+ * Represents a workout.
+ * @template TEnergy The energy unit type.
+ * @template TDistance The distance unit type.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkout Apple Docs HKWorkout}
+ */
 export interface HKWorkout<
   TEnergy extends EnergyUnit = EnergyUnit,
   TDistance extends LengthUnit = LengthUnit
@@ -49,11 +69,21 @@ export interface HKWorkout<
   readonly endDate: Date;
 }
 
+/**
+ * Represents a heartbeat series sample.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkheartbeatseriessample Apple Docs HKHeartbeatSeriesSample}
+ */
 export interface HKHeartbeatSeriesSample extends Omit<HKHeartbeatSeriesSampleRaw, 'endDate' | 'startDate'> {
   readonly startDate: Date;
   readonly endDate: Date;
 }
 
+/**
+ * Represents a quantity sample.
+ * @template TIdentifier The quantity type identifier.
+ * @template TUnit The unit for the identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitysample Apple Docs HKQuantitySample}
+ */
 export interface HKQuantitySample<
   TIdentifier extends HKQuantityTypeIdentifier = HKQuantityTypeIdentifier,
   TUnit extends UnitForIdentifier<TIdentifier> = UnitForIdentifier<TIdentifier>
@@ -69,6 +99,12 @@ export interface HKQuantitySample<
   readonly endDate: Date;
 }
 
+/**
+ * Represents a response from a statistics query.
+ * @template TIdentifier The quantity type identifier.
+ * @template TUnit The unit for the identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstatisticsquery Apple Docs HKStatisticsQuery}
+ */
 export interface QueryStatisticsResponse<TIdentifier extends HKQuantityTypeIdentifier, TUnit extends UnitForIdentifier<TIdentifier> = UnitForIdentifier<TIdentifier>>
   extends Omit<
   QueryStatisticsResponseRaw<TIdentifier, TUnit>,
@@ -77,10 +113,23 @@ export interface QueryStatisticsResponse<TIdentifier extends HKQuantityTypeIdent
   readonly mostRecentQuantityDateInterval?: { readonly from: Date; readonly to: Date };
 }
 
-export type HKCategorySampleForSaving =Omit<HKCategorySample, 'device' | 'endDate' | 'startDate' | 'uuid'>
+/**
+ * Represents a category sample for saving.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategorysample Apple Docs HKCategorySample}
+ */
+export type HKCategorySampleForSaving = Omit<HKCategorySample, 'device' | 'endDate' | 'startDate' | 'uuid'>
 
-export type HKQuantitySampleForSaving =Omit<HKQuantitySample, 'device' | 'endDate' | 'startDate' | 'uuid'>
+/**
+ * Represents a quantity sample for saving.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitysample Apple Docs HKQuantitySample}
+ */
+export type HKQuantitySampleForSaving = Omit<HKQuantitySample, 'device' | 'endDate' | 'startDate' | 'uuid'>
 
+/**
+ * Represents a correlation.
+ * @template TIdentifier The correlation type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcorrelation Apple Docs HKCorrelation}
+ */
 export interface HKCorrelation<TIdentifier extends HKCorrelationTypeIdentifier>
   extends Omit<
   HKCorrelationRaw<TIdentifier>,

package/src/utils/getMostRecentCategorySample.ts

@@ -1,18 +1,19 @@
 import queryCategorySamples from './queryCategorySamples'
 
 import type { HKCategoryTypeIdentifier } from '../native-types'
+import type { HKCategorySample } from '../types'
 
 async function getMostRecentCategorySample<
   T extends HKCategoryTypeIdentifier
 >(
   identifier: T,
-) {
+): Promise<HKCategorySample<T> | null> {
   const samples = await queryCategorySamples(identifier, {
     limit: 1,
     ascending: false,
   })
 
-  return samples[0] || null
+  return samples[0] ?? null
 }
 
 export default getMostRecentCategorySample

package/src/utils/getMostRecentQuantitySample.ts

@@ -1,6 +1,7 @@
 import queryQuantitySamples from './queryQuantitySamples'
 
 import type { HKQuantityTypeIdentifier, UnitForIdentifier } from '../native-types'
+import type { HKQuantitySample } from '../types'
 
 async function getMostRecentQuantitySample<
   TIdentifier extends HKQuantityTypeIdentifier,
@@ -8,12 +9,18 @@ async function getMostRecentQuantitySample<
 >(
   identifier: TIdentifier,
   unit: TUnit,
-) {
+): Promise<HKQuantitySample<TIdentifier, TUnit> | null> {
   const samples = await queryQuantitySamples(identifier, {
     limit: 1,
     unit,
   })
-  return samples[0] || null
+
+  const lastSample = samples[0]
+
+  if (lastSample) {
+    return lastSample as HKQuantitySample<TIdentifier, TUnit>
+  }
+  return null
 }
 
 export default getMostRecentQuantitySample