@kingstinct/react-native-healthkit 8.2.0 → 8.4.0

package/src/native-types.ts

@@ -26,6 +26,12 @@ export const HKAudiogramTypeIdentifier = 'HKAudiogramSampleType' as const
  */
 export const HKWorkoutRouteTypeIdentifier = 'HKWorkoutRouteTypeIdentifier' as const
 
+/**
+ * Represents a state of mind type identifier.
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmindtype Apple Docs HKStateOfMindType}
+ */
+export const HKStateOfMindTypeIdentifier = 'HKStateOfMindTypeIdentifier' as const
+
 /**
  * Represents a series sample containing heartbeat data..
  * @see {@link https://developer.apple.com/documentation/healthkit/HKDataTypeIdentifierHeartbeatSeries Apple Docs HKDataTypeIdentifierHeartbeatSeries}
@@ -899,6 +905,7 @@ export type HKSampleTypeIdentifier =
   | HKCategoryTypeIdentifier
   | HKCorrelationTypeIdentifier
   | HKQuantityTypeIdentifier
+  | typeof HKStateOfMindTypeIdentifier
   | typeof HKActivitySummaryTypeIdentifier
   | typeof HKAudiogramTypeIdentifier
   | typeof HKDataTypeIdentifierHeartbeatSeries
@@ -1172,6 +1179,14 @@ export type QueryStatisticsResponseRaw<
   readonly duration?: HKQuantity<HKQuantityTypeIdentifier, TimeUnit>;
 };
 
+export interface IntervalComponents {
+  readonly minute?: number;
+  readonly hour?: number;
+  readonly day?: number;
+  readonly month?: number;
+  readonly year?: number;
+}
+
 /**
  * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluecervicalmucusquality Apple Docs }
  */
@@ -1545,10 +1560,10 @@ export enum HKUnitMetric {
 export enum HKUnits {
   DecibelHearingLevel = 'dBHL',
   DecibelSoundPressureLevel = 'dBASPL',
-
   Percent = '%',
   Count = 'count',
   InternationalUnit = 'IU',
+  AppleEffortScore = 'appleEffortScore'
 }
 
 export type MeterUnit<Prefix extends HKMetricPrefix = HKMetricPrefix.None> =
@@ -2008,6 +2023,23 @@ type QueryWorkoutSamplesWithAnchorResponseRaw<
   readonly newAnchor: string
 }
 
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutconfiguration Apple Docs }
+ */
+export type HKWorkoutConfiguration = {
+  readonly activityType: HKWorkoutActivityType;
+  readonly locationType?: HKWorkoutSessionLocationType;
+};
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutsessionlocationtype Apple Docs }
+ */
+export enum HKWorkoutSessionLocationType {
+  unknown = 1,
+  indoor = 2,
+  outdoor = 3
+}
+
 type ReactNativeHealthkitTypeNative = {
   /**
    *  @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1614180-ishealthdataavailable Apple Docs }
@@ -2212,6 +2244,18 @@ type ReactNativeHealthkitTypeNative = {
     to: string,
     options: readonly HKStatisticsOptions[]
   ) => Promise<QueryStatisticsResponseRaw<TIdentifier, TUnit>>;
+  readonly queryStatisticsCollectionForQuantity: <
+    TIdentifier extends HKQuantityTypeIdentifier,
+    TUnit extends UnitForIdentifier<TIdentifier>
+  >(
+    identifier: TIdentifier,
+    unit: TUnit,
+    options: readonly HKStatisticsOptions[],
+    anchorDate: string,
+    intervalComponents: IntervalComponents,
+    startDate: string,
+    endDate: string
+  ) => Promise<readonly QueryStatisticsResponseRaw<TIdentifier, TUnit>[]>;
   readonly getPreferredUnits: (
     identifiers: readonly HKQuantityTypeIdentifier[]
   ) => Promise<TypeToUnitMapping>;
@@ -2219,8 +2263,61 @@ type ReactNativeHealthkitTypeNative = {
     workoutUUID: string
   ) => Promise<readonly WorkoutRoute[]>;
   readonly getWorkoutPlanById: (workoutUUID: string) => Promise<{readonly id: string, readonly activityType: HKWorkoutActivityType} | null>;
+
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1648358-startwatchapp Apple Docs }
+   */
+  readonly startWatchAppWithWorkoutConfiguration: (
+    workoutConfiguration: HKWorkoutConfiguration
+  ) => Promise<boolean>;
+
+  /**
+   * Query state of mind samples from HealthKit
+   * @param from Start date to query from
+   * @param to End date to query to
+   * @param limit Maximum number of samples to return
+   * @param ascending Sort order of samples
+   * @returns Promise resolving to array of state of mind samples
+   * @platform ios
+   * @requires iOS 17.0+
+   */
+  readonly queryStateOfMindSamples: (
+    from: string | null,
+    to: string | null,
+    limit: number,
+    ascending: boolean
+  ) => Promise<readonly HKStateOfMindSampleRaw[]>;
 };
 
+export enum HKStateOfMindValenceClassification {
+  veryUnpleasant = 1,
+  unpleasant = 2,
+  slightlyUnpleasant = 3,
+  neutral = 4,
+  slightlyPleasant = 5,
+  pleasant = 6,
+  veryPleasant = 7,
+}
+
+export type HKStateOfMindSampleRaw = {
+  readonly uuid: string;
+  readonly device?: HKDevice;
+  readonly startDate: string;
+  readonly endDate: string;
+  readonly metadata?: HKHeartbeatSeriesSampleMetadata;
+  readonly sourceRevision?: HKSourceRevision;
+  // State of mind sample properties
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/4337998-valence Apple Docs }
+   * Value between -1 and 1
+   */
+  readonly valence: number;
+  readonly kind: HKStateOfMindKind;
+  readonly valenceClassification: HKStateOfMindValenceClassification;
+  readonly associations: readonly HKStateOfMindAssociation[];
+  readonly labels: readonly HKStateOfMindLabel[];
+}
+
 const Native = NativeModules.ReactNativeHealthkit as ReactNativeHealthkitTypeNative
 
 type OnChangeCallback = ({
@@ -2241,3 +2338,81 @@ export const EventEmitter = new NativeEventEmitter(
 ) as HealthkitEventEmitter
 
 export default Native
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/label Apple Docs}
+ */
+export enum HKStateOfMindLabel {
+  amazed = 1,
+  amused = 2,
+  angry = 3,
+  anxious = 4,
+  ashamed = 5,
+  brave = 6,
+  calm = 7,
+  content = 8,
+  disappointed = 9,
+  discouraged = 10,
+  disgusted = 11,
+  embarrassed = 12,
+  excited = 13,
+  frustrated = 14,
+  grateful = 15,
+  guilty = 16,
+  happy = 17,
+  hopeless = 18,
+  irritated = 19,
+  jealous = 20,
+  joyful = 21,
+  lonely = 22,
+  passionate = 23,
+  peaceful = 24,
+  proud = 25,
+  relieved = 26,
+  sad = 27,
+  scared = 28,
+  stressed = 29,
+  surprised = 30,
+  worried = 31,
+
+  annoyed = 32,
+  confident = 33,
+  drained = 34,
+  hopeful = 35,
+  indifferent = 36,
+  overwhelmed = 37,
+  satisfied = 38,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/kind Apple Docs}
+ */
+export enum HKStateOfMindKind {
+  dailyMood = 2,
+  momentaryEmotion = 1
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkstateofmind/association Apple Docs}
+ * @since iOS 17.0+
+ */
+export enum HKStateOfMindAssociation {
+  community = 1,
+  currentEvents = 2,
+  dating = 3,
+  education = 4,
+  family = 5,
+  fitness = 6,
+  friends = 7,
+  health = 8,
+  hobbies = 9,
+  identity = 10,
+  money = 11,
+  partner = 12,
+  selfCare = 13,
+  spirituality = 14,
+  tasks = 15,
+  travel = 16,
+  work = 17,
+  weather = 18,
+}

package/src/test-setup.ts

@@ -33,6 +33,7 @@ beforeAll(async () => {
     queryQuantitySamples: jest.fn(),
     querySources: jest.fn(),
     queryStatisticsForQuantity: jest.fn(),
+    queryStatisticsCollectionForQuantity: jest.fn(),
     queryWorkoutSamples: jest.fn(),
     saveCategorySample: jest.fn(),
     saveCorrelationSample: jest.fn(),
@@ -41,6 +42,8 @@ beforeAll(async () => {
     unsubscribeQuery: jest.fn(),
     saveWorkoutRoute: jest.fn(),
     getWorkoutPlanById: jest.fn(),
+    startWatchAppWithWorkoutConfiguration: jest.fn(),
+    queryStateOfMindSamples: jest.fn(),
   }
 
   await mock.module('react-native', () => ({

package/src/utils/queryStateOfMindSamples.ts

@@ -0,0 +1,14 @@
+import Native from '../native-types'
+
+export const queryStateOfMindSamples = async ({
+  from, to, limit, ascending,
+}: { readonly from?: Date; readonly to?: Date; readonly limit?: number; readonly ascending?: boolean } = {}) => {
+  const fromString = (from || new Date(0)).toISOString()
+  const toString = (to || new Date(0)).toISOString()
+
+  const res = await Native.queryStateOfMindSamples(fromString, toString, limit ?? 0, ascending ?? false)
+
+  return res
+}
+
+export default queryStateOfMindSamples

package/src/utils/queryStatisticsCollectionForQuantity.ts

@@ -0,0 +1,38 @@
+import ensureUnit from './ensureUnit'
+import Native from '../native-types'
+
+import type {
+  HKQuantityTypeIdentifier,
+  HKStatisticsOptions,
+  UnitForIdentifier,
+  IntervalComponents,
+} from '../native-types'
+
+async function queryStatisticsCollectionForQuantity<
+  TIdentifier extends HKQuantityTypeIdentifier,
+  TUnit extends UnitForIdentifier<TIdentifier> = UnitForIdentifier<TIdentifier>
+>(
+  identifier: TIdentifier,
+  options: readonly HKStatisticsOptions[],
+  anchorDate: Date,
+  intervalComponents: IntervalComponents,
+  startDate: Date,
+  endDate: Date,
+  unit?: TUnit,
+) {
+  const actualUnit = await ensureUnit(identifier, unit)
+
+  const rawResponse = await Native.queryStatisticsCollectionForQuantity(
+    identifier,
+    actualUnit,
+    options,
+    anchorDate.toISOString(),
+    intervalComponents,
+    startDate.toISOString(),
+    endDate.toISOString(),
+  )
+
+  return rawResponse
+}
+
+export default queryStatisticsCollectionForQuantity

package/src/utils/startWatchApp.ts

@@ -0,0 +1,7 @@
+import Native from '../native-types'
+
+import type { HKWorkoutConfiguration } from '..'
+
+const startWatchApp = (configuration: HKWorkoutConfiguration) => async () => Native.startWatchAppWithWorkoutConfiguration(configuration)
+
+export default startWatchApp

package/ios/ReactNativeHealthkit.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-   <FileRef
-      location = "self:">
-   </FileRef>
-</Workspace>

package/ios/ReactNativeHealthkit.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>IDEDidComputeMac32BitWarning</key>
-	<true/>
-</dict>
-</plist>

package/ios/ReactNativeHealthkit.xcodeproj/xcuserdata/robertherber.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>SchemeUserState</key>
-	<dict>
-		<key>ReactNativeHealthkit.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>0</integer>
-		</dict>
-	</dict>
-</dict>
-</plist>