@kingstinct/react-native-healthkit 9.0.0 → 9.0.2

package/lib/typescript/types/Characteristics.d.ts

@@ -0,0 +1,41 @@
+export type CharacteristicTypeIdentifier = 'HKCharacteristicTypeIdentifierFitzpatrickSkinType' | 'HKCharacteristicTypeIdentifierBiologicalSex' | 'HKCharacteristicTypeIdentifierBloodType' | 'HKCharacteristicTypeIdentifierDateOfBirth' | 'HKCharacteristicTypeIdentifierWheelchairUse' | 'HKCharacteristicTypeIdentifierActivityMoveMode';
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkbloodtype Apple Docs }
+ */
+export declare enum BloodType {
+    notSet = 0,
+    aPositive = 1,
+    aNegative = 2,
+    bPositive = 3,
+    bNegative = 4,
+    abPositive = 5,
+    abNegative = 6,
+    oPositive = 7,
+    oNegative = 8
+}
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkbiologicalsex Apple Docs }
+ */
+export declare enum BiologicalSex {
+    notSet = 0,
+    female = 1,
+    male = 2,
+    other = 3
+}
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkfitzpatrickskintype Apple Docs }
+ */
+export declare enum FitzpatrickSkinType {
+    notSet = 0,
+    I = 1,
+    II = 2,
+    III = 3,
+    IV = 4,
+    V = 5,
+    VI = 6
+}
+export declare enum WheelchairUse {
+    notSet = 0,
+    notUsingWheelchair = 1,
+    usingWheelchair = 2
+}

package/lib/typescript/types/Constants.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Represents a workout type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkouttypeidentifier Apple Docs HKWorkoutTypeIdentifier}
+ */
+export declare const WorkoutTypeIdentifier: "HKWorkoutTypeIdentifier";
+/**
+ * Represents a workout route type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/HKWorkoutRouteTypeIdentifier Apple Docs WorkoutRouteTypeIdentifier}
+ */
+export declare const WorkoutRouteTypeIdentifier: "HKWorkoutRouteTypeIdentifier";
+/**
+ * Represents a state of mind type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmindtype Apple Docs HKStateOfMindType}
+ */
+export declare const StateOfMindTypeIdentifier: "HKStateOfMindTypeIdentifier";
+/**
+ * Represents a series sample containing heartbeat data..
+ * @see {@link https://developer.apple.com/documentation/healthkit/HKDataTypeIdentifierHeartbeatSeries Apple Docs DataTypeIdentifierHeartbeatSeries}
+ */
+export declare const HeartbeatSeriesTypeIdentifier: "HKDataTypeIdentifierHeartbeatSeries";

package/lib/typescript/types/CorrelationType.d.ts

@@ -0,0 +1,21 @@
+import type { AnyMap } from 'react-native-nitro-modules';
+import type { CategorySample, CategorySampleForSaving } from './CategoryType';
+import type { QuantitySample, QuantitySampleForSaving } from './QuantitySample';
+import type { GenericMetadata } from './Shared';
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcorrelationtypeidentifier Apple Docs }
+ */
+export type CorrelationTypeIdentifier = 'HKCorrelationTypeIdentifierBloodPressure' | 'HKCorrelationTypeIdentifierFood';
+type CorrelationObject = CategorySample | QuantitySample;
+export interface CorrelationSample {
+    readonly correlationType: CorrelationTypeIdentifier;
+    readonly objects: readonly CorrelationObject[];
+    readonly metadata: AnyMap;
+    readonly startDate: Date;
+    readonly endDate: Date;
+}
+export type MetadataMapperForCorrelationIdentifier<TCorrelationTypeIdentifier = CorrelationTypeIdentifier> = TCorrelationTypeIdentifier extends 'CorrelationTypeIdentifierFood' ? GenericMetadata & {
+    readonly HKFoodType?: string;
+} : GenericMetadata;
+export type SampleForSaving = CategorySampleForSaving | QuantitySampleForSaving;
+export {};

package/lib/typescript/types/Device.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkdevice Apple Docs }
+ */
+export interface Device {
+    readonly name: string | null;
+    readonly firmwareVersion: string | null;
+    readonly hardwareVersion: string | null;
+    readonly localIdentifier: string | null;
+    readonly manufacturer: string | null;
+    readonly model: string | null;
+    readonly softwareVersion: string | null;
+    readonly udiDeviceIdentifier: string | null;
+}

package/lib/typescript/types/HeartbeatSeries.d.ts

@@ -0,0 +1,25 @@
+import type { AnyMap } from 'react-native-nitro-modules';
+import type { Device } from './Device';
+import type { DeletedSample, GenericMetadata } from './Shared';
+import type { SourceRevision } from './Source';
+export interface HeartbeatSeriesSampleMetadata extends GenericMetadata {
+    readonly HKMetadataKeyAlgorithmVersion: string;
+}
+export interface Heartbeat {
+    readonly timeSinceSeriesStart: number;
+    readonly precededByGap: boolean;
+}
+export interface HeartbeatSeriesSample {
+    readonly uuid: string;
+    readonly device?: Device;
+    readonly startDate: Date;
+    readonly endDate: Date;
+    readonly heartbeats: readonly Heartbeat[];
+    readonly metadata?: AnyMap;
+    readonly sourceRevision?: SourceRevision;
+}
+export interface HeartbeatSeriesSamplesWithAnchorResponse {
+    readonly samples: readonly HeartbeatSeriesSample[];
+    readonly deletedSamples: readonly DeletedSample[];
+    readonly newAnchor: string;
+}

package/lib/typescript/types/InterfaceVerification.d.ts

@@ -0,0 +1,73 @@
+/**
+ * TypeScript utility types for verifying that two interfaces have matching method signatures.
+ *
+ * This is particularly useful for ensuring that typed and untyped versions of interfaces
+ * stay in sync when one has generics and the other doesn't.
+ *
+ * @example
+ * ```typescript
+ * import type { InterfaceAssertion } from "./InterfaceVerification";
+ *
+ * interface BaseModule extends HybridObject<{ ios: "swift" }> {
+ *   getData(id: string): Promise<string>;
+ * }
+ *
+ * interface BaseModuleTyped {
+ *   getData<T extends string>(id: T): Promise<string>;
+ * }
+ *
+ * // This will cause a TypeScript error if the interfaces don't match
+ * const _verification: InterfaceAssertion<BaseModule, BaseModuleTyped, keyof HybridObject> = true;
+ * ```
+ */
+/**
+ * Extracts method names from an interface, excluding specified keys
+ */
+export type ExtractMethodNames<T, ExcludeKeys extends keyof T = never> = Exclude<keyof T, ExcludeKeys>;
+/**
+ * Gets the parameter count of a function type
+ */
+export type GetParameterCount<T> = T extends (...args: infer P) => unknown ? P['length'] : never;
+/**
+ * Checks if two interfaces have the same method names
+ */
+export type CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase extends keyof BaseInterface = never> = {
+    BaseMethodNames: ExtractMethodNames<BaseInterface, ExcludeFromBase>;
+    TypedMethodNames: ExtractMethodNames<TypedInterface>;
+    MissingInBase: Exclude<ExtractMethodNames<TypedInterface>, ExtractMethodNames<BaseInterface, ExcludeFromBase>>;
+    MissingInTyped: Exclude<ExtractMethodNames<BaseInterface, ExcludeFromBase>, ExtractMethodNames<TypedInterface>>;
+    InterfaceMismatch: Exclude<ExtractMethodNames<TypedInterface>, ExtractMethodNames<BaseInterface, ExcludeFromBase>> | Exclude<ExtractMethodNames<BaseInterface, ExcludeFromBase>, ExtractMethodNames<TypedInterface>>;
+};
+/**
+ * Checks parameter counts for shared methods between two interfaces
+ */
+export type CheckParameterCounts<BaseInterface, TypedInterface, ExcludeFromBase extends keyof BaseInterface = never> = {
+    SharedMethodNames: ExtractMethodNames<BaseInterface, ExcludeFromBase> & ExtractMethodNames<TypedInterface>;
+    ParameterCountMismatches: {
+        [K in ExtractMethodNames<BaseInterface, ExcludeFromBase> & ExtractMethodNames<TypedInterface>]: GetParameterCount<BaseInterface[K]> extends GetParameterCount<TypedInterface[K]> ? GetParameterCount<TypedInterface[K]> extends GetParameterCount<BaseInterface[K]> ? never : K : K;
+    }[ExtractMethodNames<BaseInterface, ExcludeFromBase> & ExtractMethodNames<TypedInterface>];
+};
+/**
+ * Complete interface verification that checks both method names and parameter counts
+ */
+export type VerifyInterfaceSync<BaseInterface, TypedInterface, ExcludeFromBase extends keyof BaseInterface = never> = {
+    MethodCheck: CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase>;
+    ParameterCheck: CheckParameterCounts<BaseInterface, TypedInterface, ExcludeFromBase>;
+    Result: CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase>['InterfaceMismatch'] extends never ? CheckParameterCounts<BaseInterface, TypedInterface, ExcludeFromBase>['ParameterCountMismatches'] extends never ? true : {
+        ERROR: 'Parameter count mismatch detected';
+        MethodsWithParameterCountMismatch: CheckParameterCounts<BaseInterface, TypedInterface, ExcludeFromBase>['ParameterCountMismatches'];
+    } : {
+        ERROR: 'Interface mismatch detected';
+        MissingInBase: CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase>['MissingInBase'];
+        MissingInTyped: CheckMethodNames<BaseInterface, TypedInterface, ExcludeFromBase>['MissingInTyped'];
+    };
+};
+/**
+ * Simplified interface verification for common use cases
+ */
+export type AssertInterfacesMatch<BaseInterface, TypedInterface, ExcludeFromBase extends keyof BaseInterface = never> = VerifyInterfaceSync<BaseInterface, TypedInterface, ExcludeFromBase>['Result'];
+/**
+ * Creates a compile-time assertion that two interfaces match
+ * Usage: const _check: InterfaceAssertion<BaseInterface, TypedInterface> = true;
+ */
+export type InterfaceAssertion<BaseInterface, TypedInterface, ExcludeFromBase extends keyof BaseInterface = never> = AssertInterfacesMatch<BaseInterface, TypedInterface, ExcludeFromBase>;

package/lib/typescript/types/InterfaceVerificationExample.d.ts

@@ -0,0 +1,58 @@
+/**
+ * Example usage of the InterfaceVerification utility
+ *
+ * This file demonstrates how to use the reusable interface verification utility
+ * to ensure that typed and untyped versions of interfaces stay in sync.
+ */
+import type { HybridObject } from 'react-native-nitro-modules';
+export interface ExampleModule extends HybridObject<{
+    ios: 'swift';
+}> {
+    getData(id: string): Promise<string>;
+    saveData(id: string, data: string): Promise<boolean>;
+    deleteData(id: string): Promise<void>;
+}
+export interface ExampleModuleTyped {
+    getData<T extends string>(id: T): Promise<string>;
+    saveData<T extends string>(id: T, data: string): Promise<boolean>;
+    deleteData<T extends string>(id: T): Promise<void>;
+}
+export interface ConfigModule extends HybridObject<{
+    ios: 'swift';
+}> {
+    getConfig(key: string, defaultValue?: string): Promise<string>;
+    setConfig(key: string, value: string, persistent?: boolean): Promise<void>;
+}
+export interface ConfigModuleTyped {
+    getConfig<T extends string>(key: T, defaultValue?: string): Promise<string>;
+    setConfig<T extends string>(key: T, value: string, persistent?: boolean): Promise<void>;
+}
+export interface BadModule extends HybridObject<{
+    ios: 'swift';
+}> {
+    method1(): void;
+    method2(param: string): void;
+    extraMethod(): void;
+}
+export interface BadModuleTyped {
+    method1(): void;
+    method2(param: string): void;
+}
+/**
+ * Usage Instructions:
+ *
+ * 1. Import the InterfaceAssertion type from InterfaceVerification
+ * 2. Create your base interface (extending HybridObject)
+ * 3. Create your typed interface (with generics)
+ * 4. Add a verification line:
+ *    const _verification: InterfaceAssertion<BaseInterface, TypedInterface, keyof HybridObject> = true;
+ *
+ * The verification will:
+ * - Check that both interfaces have the same method names
+ * - Check that corresponding methods have the same number of parameters
+ * - Show descriptive TypeScript errors if there are mismatches
+ *
+ * Error Types:
+ * - "Interface mismatch detected" - method names don't match
+ * - "Parameter count mismatch detected" - parameter counts don't match
+ */

package/lib/typescript/types/QuantitySample.d.ts

@@ -0,0 +1,27 @@
+import type { AnyMap } from 'react-native-nitro-modules';
+import type { Device } from './Device';
+import type { QuantityTypeIdentifier } from './QuantityTypeIdentifier';
+import type { SourceRevision } from './Source';
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkquantitysample Apple Docs }
+ */
+export interface QuantitySample {
+    readonly uuid: string;
+    readonly device?: Device;
+    readonly quantityType: QuantityTypeIdentifier;
+    readonly startDate: Date;
+    readonly endDate: Date;
+    readonly quantity: number;
+    readonly unit: string;
+    readonly metadata: AnyMap;
+    readonly sourceRevision?: SourceRevision;
+}
+export interface QuantitySampleForSaving {
+    readonly startDate: Date;
+    readonly endDate: Date;
+    readonly quantityType: QuantityTypeIdentifier;
+    readonly quantity: number;
+    readonly unit: string;
+    readonly metadata: AnyMap;
+    readonly sourceRevision?: SourceRevision;
+}

package/lib/typescript/types/QuantityType.d.ts

@@ -0,0 +1,63 @@
+import type { QuantitySample } from './QuantitySample';
+import type { QuantityTypeIdentifier } from './QuantityTypeIdentifier';
+import type { PredicateForSamples } from './QueryOptions';
+import type { DeletedSample, GenericMetadata } from './Shared';
+import type { BloodGlucoseUnit, CountPerTime, EnergyUnit, LengthUnit, MassUnit, SpeedUnit, TemperatureUnit, TimeUnit, Unit, VolumeUnit } from './Units';
+interface QuantityDateInterval {
+    readonly from: Date;
+    readonly to: Date;
+}
+export interface QueryStatisticsResponse {
+    readonly averageQuantity?: Quantity;
+    readonly maximumQuantity?: Quantity;
+    readonly minimumQuantity?: Quantity;
+    readonly sumQuantity?: Quantity;
+    readonly mostRecentQuantity?: Quantity;
+    readonly mostRecentQuantityDateInterval?: QuantityDateInterval;
+    readonly duration?: Quantity;
+}
+export interface QuantitySamplesWithAnchorResponse {
+    readonly samples: readonly QuantitySample[];
+    readonly deletedSamples: readonly DeletedSample[];
+    readonly newAnchor: string;
+}
+export interface Quantity {
+    readonly unit: string;
+    readonly quantity: number;
+}
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkinsulindeliveryreason Apple Docs }
+ */
+export declare enum InsulinDeliveryReason {
+    basal = 1,
+    bolus = 2
+}
+export declare enum HeartRateMotionContext {
+    active = 2,
+    notSet = 0,
+    sedentary = 1
+}
+export interface IntervalComponents {
+    readonly minute?: number;
+    readonly hour?: number;
+    readonly day?: number;
+    readonly month?: number;
+    readonly year?: number;
+}
+export interface StatisticsQueryOptions {
+    filter?: PredicateForSamples;
+    unit?: string;
+}
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstatisticsoptions Apple Docs }
+ */
+export type StatisticsOptions = 'cumulativeSum' | 'discreteAverage' | 'discreteMax' | 'discreteMin' | 'duration' | 'mostRecent' | 'separateBySource';
+export type MetadataMapperForQuantityIdentifier<TQuantityTypeIdentifier = QuantityTypeIdentifier> = TQuantityTypeIdentifier extends 'QuantityTypeIdentifierInsulinDelivery' ? GenericMetadata & {
+    readonly HKInsulinDeliveryReason: InsulinDeliveryReason;
+} : TQuantityTypeIdentifier extends 'QuantityTypeIdentifierBloodGlucose' ? GenericMetadata & {
+    readonly HKBloodGlucoseMealTime?: number;
+} : TQuantityTypeIdentifier extends 'QuantityTypeIdentifierHeartRate' ? GenericMetadata & {
+    readonly HKHeartRateMotionContext?: HeartRateMotionContext;
+} : GenericMetadata;
+export type UnitForIdentifier<T extends QuantityTypeIdentifier = QuantityTypeIdentifier> = T extends 'QuantityTypeIdentifierBloodGlucose' ? BloodGlucoseUnit : T extends 'QuantityTypeIdentifierAppleExerciseTime' | 'QuantityTypeIdentifierAppleMoveTime' | 'QuantityTypeIdentifierAppleStandTime' ? TimeUnit : T extends 'QuantityTypeIdentifierActiveEnergyBurned' | 'QuantityTypeIdentifierBasalEnergyBurned' | 'QuantityTypeIdentifierDietaryEnergyConsumed' ? EnergyUnit : T extends 'QuantityTypeIdentifierDistanceCycling' | 'QuantityTypeIdentifierDistanceDownhillSnowSports' | 'QuantityTypeIdentifierDistanceSwimming' | 'QuantityTypeIdentifierDistanceWalkingRunning' | 'QuantityTypeIdentifierDistanceWheelchair' | 'QuantityTypeIdentifierSixMinuteWalkTestDistance' | 'QuantityTypeIdentifierWaistCircumference' ? LengthUnit : T extends 'QuantityTypeIdentifierBodyFatPercentage' | 'QuantityTypeIdentifierOxygenSaturation' | 'QuantityTypeIdentifierWalkingAsymmetryPercentage' | 'QuantityTypeIdentifierWalkingDoubleSupportPercentage' ? '%' : T extends 'QuantityTypeIdentifierBasalBodyTemperature' ? TemperatureUnit : T extends 'QuantityTypeIdentifierRunningSpeed' | 'QuantityTypeIdentifierStairAscentSpeed' | 'QuantityTypeIdentifierStairDescentSpeed' | 'QuantityTypeIdentifierWalkingSpeed' ? SpeedUnit<LengthUnit, TimeUnit> : T extends 'QuantityTypeIdentifierFlightsClimbed' | 'QuantityTypeIdentifierNumberOfAlcoholicBeverages' | 'QuantityTypeIdentifierNumberOfTimesFallen' | 'QuantityTypeIdentifierPushCount' | 'QuantityTypeIdentifierStepCount' | 'QuantityTypeIdentifierSwimmingStrokeCount' ? 'count' : T extends 'QuantityTypeIdentifierDietaryBiotin' | 'QuantityTypeIdentifierDietaryCaffeine' | 'QuantityTypeIdentifierDietaryCalcium' | 'QuantityTypeIdentifierDietaryCarbohydrates' | 'QuantityTypeIdentifierDietaryChloride' | 'QuantityTypeIdentifierDietaryCholesterol' | 'QuantityTypeIdentifierDietaryChromium' | 'QuantityTypeIdentifierDietaryCopper' | 'QuantityTypeIdentifierDietaryFatMonounsaturated' | 'QuantityTypeIdentifierDietaryFatPolyunsaturated' | 'QuantityTypeIdentifierDietaryFatSaturated' | 'QuantityTypeIdentifierDietaryFatTotal' | 'QuantityTypeIdentifierDietaryFiber' | 'QuantityTypeIdentifierDietaryFolate' | 'QuantityTypeIdentifierDietaryIodine' | 'QuantityTypeIdentifierDietaryIron' | 'QuantityTypeIdentifierDietaryMagnesium' | 'QuantityTypeIdentifierDietaryManganese' | 'QuantityTypeIdentifierDietaryMolybdenum' | 'QuantityTypeIdentifierDietaryNiacin' | 'QuantityTypeIdentifierDietaryPantothenicAcid' | 'QuantityTypeIdentifierDietaryPhosphorus' | 'QuantityTypeIdentifierDietaryPotassium' | 'QuantityTypeIdentifierDietaryProtein' | 'QuantityTypeIdentifierDietaryRiboflavin' | 'QuantityTypeIdentifierDietarySelenium' | 'QuantityTypeIdentifierDietarySodium' | 'QuantityTypeIdentifierDietarySugar' | 'QuantityTypeIdentifierDietaryThiamin' | 'QuantityTypeIdentifierDietaryVitaminA' | 'QuantityTypeIdentifierDietaryVitaminB6' | 'QuantityTypeIdentifierDietaryVitaminB12' | 'QuantityTypeIdentifierDietaryVitaminC' | 'QuantityTypeIdentifierDietaryVitaminD' | 'QuantityTypeIdentifierDietaryVitaminE' | 'QuantityTypeIdentifierDietaryVitaminK' | 'QuantityTypeIdentifierDietaryZinc' ? MassUnit : T extends 'QuantityTypeIdentifierDietaryWater' ? VolumeUnit : T extends 'QuantityTypeIdentifierInsulinDelivery' ? 'IU' : T extends 'QuantityTypeIdentifierHeartRate' | 'QuantityTypeIdentifierRestingHeartRate' | 'QuantityTypeIdentifierWalkingHeartRateAverage' ? CountPerTime<TimeUnit> : Unit;
+export {};