@kingstinct/react-native-healthkit 8.7.2 → 9.0.0

package/src/specs/HeartbeatSeriesModule.nitro.ts

@@ -0,0 +1,19 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+import type {
+  HeartbeatSeriesSample,
+  HeartbeatSeriesSamplesWithAnchorResponse,
+} from '../types/HeartbeatSeries'
+import type {
+  QueryOptionsWithAnchor,
+  QueryOptionsWithSortOrder,
+} from '../types/QueryOptions'
+
+export interface HeartbeatSeriesModule extends HybridObject<{ ios: 'swift' }> {
+  queryHeartbeatSeriesSamples(
+    options?: QueryOptionsWithSortOrder,
+  ): Promise<readonly HeartbeatSeriesSample[]>
+
+  queryHeartbeatSeriesSamplesWithAnchor(
+    options: QueryOptionsWithAnchor,
+  ): Promise<HeartbeatSeriesSamplesWithAnchorResponse>
+}

package/src/specs/QuantityTypeModule.nitro.ts

@@ -0,0 +1,60 @@
+import type { AnyMap, HybridObject } from 'react-native-nitro-modules'
+import type { QuantitySample } from '../types/QuantitySample'
+import type {
+  IntervalComponents,
+  QuantitySamplesWithAnchorResponse,
+  QueryStatisticsResponse,
+  StatisticsOptions,
+  StatisticsQueryOptions,
+} from '../types/QuantityType'
+import type { QuantityTypeIdentifier } from '../types/QuantityTypeIdentifier'
+import type {
+  FilterForSamples,
+  QueryOptionsWithAnchorAndUnit,
+  QueryOptionsWithSortOrderAndUnit,
+} from '../types/QueryOptions'
+
+export interface QuantityTypeModule extends HybridObject<{ ios: 'swift' }> {
+  isQuantityCompatibleWithUnit(
+    identifier: QuantityTypeIdentifier,
+    unit: string,
+  ): boolean
+
+  saveQuantitySample(
+    identifier: QuantityTypeIdentifier,
+    unit: string,
+    value: number,
+    start: Date,
+    end: Date,
+    metadata: AnyMap,
+  ): Promise<boolean>
+
+  deleteQuantitySamples(
+    identifier: QuantityTypeIdentifier,
+    filter: FilterForSamples,
+  ): Promise<boolean>
+
+  queryQuantitySamples(
+    identifier: QuantityTypeIdentifier,
+    options?: QueryOptionsWithSortOrderAndUnit,
+  ): Promise<readonly QuantitySample[]>
+
+  queryStatisticsForQuantity(
+    identifier: QuantityTypeIdentifier,
+    statistics: readonly StatisticsOptions[],
+    options?: StatisticsQueryOptions,
+  ): Promise<QueryStatisticsResponse>
+
+  queryStatisticsCollectionForQuantity(
+    identifier: QuantityTypeIdentifier,
+    statistics: readonly StatisticsOptions[],
+    anchorDate: string,
+    intervalComponents: IntervalComponents,
+    options?: StatisticsQueryOptions,
+  ): Promise<readonly QueryStatisticsResponse[]>
+
+  queryQuantitySamplesWithAnchor(
+    identifier: QuantityTypeIdentifier,
+    options: QueryOptionsWithAnchorAndUnit,
+  ): Promise<QuantitySamplesWithAnchorResponse>
+}

package/src/specs/SourceProxy.nitro.ts

@@ -0,0 +1,13 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+
+interface Source {
+  readonly name: string
+  readonly bundleIdentifier: string
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkobject/1615781-source Apple Docs }
+ */
+export interface SourceProxy extends HybridObject<{ ios: 'swift' }>, Source {
+  toJSON(key?: string): Source
+}

package/src/specs/StateOfMindModule.nitro.ts

@@ -0,0 +1,23 @@
+import type { AnyMap, HybridObject } from 'react-native-nitro-modules'
+import type { QueryOptionsWithSortOrder } from '../types/QueryOptions'
+import type {
+  StateOfMindAssociation,
+  StateOfMindKind,
+  StateOfMindLabel,
+  StateOfMindSample,
+} from '../types/StateOfMind'
+
+export interface StateOfMindModule extends HybridObject<{ ios: 'swift' }> {
+  queryStateOfMindSamples(
+    options?: QueryOptionsWithSortOrder,
+  ): Promise<readonly StateOfMindSample[]>
+
+  saveStateOfMindSample(
+    date: Date,
+    kind: StateOfMindKind,
+    valence: number,
+    labels: readonly StateOfMindLabel[],
+    associations: readonly StateOfMindAssociation[],
+    metadata?: AnyMap,
+  ): Promise<boolean>
+}

package/src/specs/WorkoutProxy.nitro.ts

@@ -0,0 +1,18 @@
+import type { HybridObject } from 'react-native-nitro-modules'
+import type {
+  LocationForSaving,
+  WorkoutPlan,
+  WorkoutRoute,
+  WorkoutSample,
+} from '../types/Workouts'
+
+export interface WorkoutProxy
+  extends HybridObject<{ ios: 'swift' }>,
+    WorkoutSample {
+  toJSON(key?: string): WorkoutSample
+  saveWorkoutRoute(locations: readonly LocationForSaving[]): Promise<boolean>
+  getWorkoutPlan(): Promise<WorkoutPlan | null>
+  getWorkoutRoutes(): Promise<readonly WorkoutRoute[]>
+
+  // nice to have here: getAllStatistics and getStatisticsForQuantityType
+}

package/src/specs/WorkoutSessionModule.nitro.ts

@@ -0,0 +1,71 @@
+import type { AnyMap, HybridObject } from 'react-native-nitro-modules'
+import type { WorkoutConfiguration } from '../types/WorkoutKit'
+import type { WorkoutEventType } from '../types/Workouts'
+
+export interface WorkoutSessionMirroringStartHandlerOptions {
+  onError(errorMessage: string): void
+  onStateChange(
+    toState: WorkoutSessionState,
+    fromState: WorkoutSessionState,
+    date: Date,
+  ): void
+  onDataReceived(data: RemoteSessionSharableData[]): void
+  onEventReceived(type: WorkoutEventType): void
+}
+
+export interface WorkoutSessionModule extends HybridObject<{ ios: 'swift' }> {
+  /**
+   * @see {@link https://developer.apple.com/documentation/healthkit/hkhealthstore/1648358-startwatchapp Apple Docs }
+   */
+  startWatchAppWithWorkoutConfiguration(
+    workoutConfiguration: WorkoutConfiguration,
+  ): Promise<boolean>
+
+  workoutSessionMirroringStartHandler(
+    /*onError: (event: WorkoutErrorEvent) => void,
+		onStateChange: (event: WorkoutStateChangeEvent) => void,
+		onDataReceived: (event: WorkoutDataReceivedEvent) => void,
+		onEventReceived: (event: WorkoutEventReceivedEvent) => void,*/
+    options: WorkoutSessionMirroringStartHandlerOptions,
+  ): boolean
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkworkoutsessionstate Apple Docs }
+ */
+export enum WorkoutSessionState {
+  NotStarted = 1,
+  Running = 2,
+  Ended = 3,
+  Paused = 4,
+  Prepared = 5,
+  Stopped = 6,
+}
+
+export interface WorkoutStateChangeEvent {
+  readonly toState: WorkoutSessionState
+  readonly fromState: WorkoutSessionState
+  readonly date: Date
+}
+
+export interface WorkoutErrorEvent {
+  readonly error: string
+}
+
+export interface RemoteSessionSharableData {
+  readonly type: string
+  readonly payload: AnyMap
+}
+
+export interface WorkoutDataReceivedEvent {
+  readonly data: readonly RemoteSessionSharableData[]
+}
+
+export interface WorkoutEventReceivedEvent {
+  readonly type: WorkoutEventType
+}
+
+/*type OnRemoteWorkoutStateChangeCallback = ;
+type OnRemoteWorkoutErrorCallback = (event: WorkoutErrorEvent) => void;
+type OnRemoteWorkoutDataCallback = (event: WorkoutDataReceivedEvent) => void;
+type OnRemoteWorkoutEventReceivedCallback = (event: WorkoutEventReceivedEvent) => void;*/

package/src/specs/WorkoutsModule.nitro.ts

@@ -0,0 +1,32 @@
+import type { AnyMap, HybridObject } from 'react-native-nitro-modules'
+import type { QuantitySampleForSaving } from '../types/QuantitySample'
+import type { WorkoutConfiguration } from '../types/WorkoutKit'
+import type {
+  QueryWorkoutSamplesWithAnchorResponse,
+  WorkoutActivityType,
+  WorkoutQueryOptions,
+  WorkoutQueryOptionsWithAnchor,
+  WorkoutTotals,
+} from '../types/Workouts'
+import type { WorkoutProxy } from './WorkoutProxy.nitro'
+
+export interface WorkoutsModule extends HybridObject<{ ios: 'swift' }> {
+  saveWorkoutSample(
+    workoutActivityType: WorkoutActivityType,
+    quantities: readonly QuantitySampleForSaving[],
+    startDate: Date,
+    endDate: Date,
+    totals: WorkoutTotals,
+    metadata: AnyMap,
+  ): Promise<string>
+
+  queryWorkoutSamplesWithAnchor(
+    options: WorkoutQueryOptionsWithAnchor,
+  ): Promise<QueryWorkoutSamplesWithAnchorResponse>
+
+  queryWorkoutSamples(options: WorkoutQueryOptions): Promise<WorkoutProxy[]>
+
+  startWatchAppWithWorkoutConfiguration(
+    workoutConfiguration: WorkoutConfiguration,
+  ): Promise<boolean>
+}

package/src/test-setup.ts

@@ -1,57 +1,71 @@
-// eslint-disable-next-line import/no-unresolved
-import { mock, jest, beforeAll } from 'bun:test'
+import { jest, mock } from 'bun:test'
+import { deleteObjects } from '.'
 
-import type Native from './native-types'
+const mockModule = {
+  queryWorkoutSamplesWithAnchor: jest.fn(),
+  isHealthDataAvailable: jest.fn(),
+  isHealthDataAvailableAsync: jest.fn(),
+  isProtectedDataAvailable: jest.fn(),
+  authorizationStatusFor: jest.fn(),
+  requestAuthorization: jest.fn(),
+  saveQuantitySample: jest.fn(),
+  deleteQuantitySample: jest.fn(),
+  deleteSamples: jest.fn(),
+  deleteWorkoutSample: jest.fn(),
+  disableAllBackgroundDelivery: jest.fn(),
+  disableBackgroundDelivery: jest.fn(),
+  enableBackgroundDelivery: jest.fn(),
+  queryCategorySamplesWithAnchor: jest.fn(),
+  queryQuantitySamplesWithAnchor: jest.fn(),
+  getBiologicalSex: jest.fn(),
+  getBloodType: jest.fn(),
+  getDateOfBirth: jest.fn(),
+  getFitzpatrickSkinType: jest.fn(),
+  getPreferredUnits: jest.fn(),
+  getRequestStatusForAuthorization: jest.fn(),
+  getWheelchairUse: jest.fn(),
+  getWorkoutRoutes: jest.fn(),
+  queryCategorySamples: jest.fn(),
+  queryCorrelationSamples: jest.fn(),
+  queryHeartbeatSeriesSamples: jest.fn(),
+  queryHeartbeatSeriesSamplesWithAnchor: jest.fn(),
+  queryQuantitySamples: jest.fn(),
+  querySources: jest.fn(),
+  queryStatisticsForQuantity: jest.fn(),
+  queryStatisticsCollectionForQuantity: jest.fn(),
+  queryWorkoutSamples: jest.fn(),
+  saveStateOfMindSample: jest.fn(),
+  saveCategorySample: jest.fn(),
+  saveCorrelationSample: jest.fn(),
+  saveWorkoutSample: jest.fn(),
+  subscribeToObserverQuery: jest.fn(),
+  unsubscribeQuery: jest.fn(),
+  saveWorkoutRoute: jest.fn(),
+  getWorkoutPlanById: jest.fn(),
+  startWatchAppWithWorkoutConfiguration: jest.fn(),
+  deleteObjects: jest.fn(),
+  isQuantityCompatibleWithUnit: jest.fn(),
+  isObjectTypeAvailable: jest.fn(),
+  isObjectTypeAvailableAsync: jest.fn(),
+  areObjectTypesAvailable: jest.fn(),
+  areObjectTypesAvailableAsync: jest.fn(),
+  queryStateOfMindSamples: jest.fn(),
+  workoutSessionMirroringStartHandler: jest.fn(),
+}
 
-beforeAll(async () => {
-  const mockModule: typeof Native = {
-    queryWorkoutSamplesWithAnchor: jest.fn(),
-    isHealthDataAvailable: jest.fn(),
-    isProtectedDataAvailable: jest.fn(),
-    authorizationStatusFor: jest.fn(),
-    requestAuthorization: jest.fn(),
-    saveQuantitySample: jest.fn(),
-    deleteQuantitySample: jest.fn(),
-    deleteSamples: jest.fn(),
-    deleteWorkoutSample: jest.fn(),
-    disableAllBackgroundDelivery: jest.fn(),
-    disableBackgroundDelivery: jest.fn(),
-    enableBackgroundDelivery: jest.fn(),
-    queryCategorySamplesWithAnchor: jest.fn(),
-    queryQuantitySamplesWithAnchor: jest.fn(),
-    getBiologicalSex: jest.fn(),
-    getBloodType: jest.fn(),
-    getDateOfBirth: jest.fn(),
-    getFitzpatrickSkinType: jest.fn(),
-    getPreferredUnits: jest.fn(),
-    getRequestStatusForAuthorization: jest.fn(),
-    getWheelchairUse: jest.fn(),
-    getWorkoutRoutes: jest.fn(),
-    queryCategorySamples: jest.fn(),
-    queryCorrelationSamples: jest.fn(),
-    queryHeartbeatSeriesSamples: jest.fn(),
-    queryHeartbeatSeriesSamplesWithAnchor: jest.fn(),
-    queryQuantitySamples: jest.fn(),
-    querySources: jest.fn(),
-    queryStatisticsForQuantity: jest.fn(),
-    queryStatisticsCollectionForQuantity: jest.fn(),
-    queryWorkoutSamples: jest.fn(),
-    saveStateOfMindSample: jest.fn(),
-    saveCategorySample: jest.fn(),
-    saveCorrelationSample: jest.fn(),
-    saveWorkoutSample: jest.fn(),
-    subscribeToObserverQuery: jest.fn(),
-    unsubscribeQuery: jest.fn(),
-    saveWorkoutRoute: jest.fn(),
-    getWorkoutPlanById: jest.fn(),
-    startWatchAppWithWorkoutConfiguration: jest.fn(),
-    queryStateOfMindSamples: jest.fn(),
-  }
+await mock.module('react-native-nitro-modules', () => ({
+  NitroModules: {
+    createHybridObject: jest.fn((moduleName: string) => {
+      if (moduleName === 'CoreModule') {
+        return mockModule
+      }
+      return mockModule
+    }),
+  },
+}))
 
-  await mock.module('react-native', () => ({
-    NativeModules: {
-      ReactNativeHealthkit: mockModule,
-    },
-    NativeEventEmitter: jest.fn(),
-  }))
-})
+await mock.module('react-native', () => ({
+  Platform: {
+    OS: 'ios',
+  },
+}))

package/src/test-utils.ts

@@ -1,9 +1,10 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
 import { act } from '@testing-library/react-native'
 
 const waitForNextUpdate = async () => {
   await act(async () => {
-    await new Promise((resolve) => { setTimeout(resolve, 0) })
+    await new Promise((resolve) => {
+      setTimeout(resolve, 0)
+    })
   })
 }
 

package/src/types/Auth.ts

@@ -0,0 +1,17 @@
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkauthorizationrequeststatus Apple Docs }
+ */
+export enum AuthorizationRequestStatus {
+  unknown = 0,
+  shouldRequest = 1,
+  unnecessary = 2,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkauthorizationstatus Apple Docs }
+ */
+export enum AuthorizationStatus {
+  notDetermined = 0,
+  sharingDenied = 1,
+  sharingAuthorized = 2,
+}

package/src/types/Background.ts

@@ -0,0 +1,9 @@
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkupdatefrequency Apple Docs }
+ */
+export enum UpdateFrequency {
+  immediate = 1,
+  hourly = 2,
+  daily = 3,
+  weekly = 4,
+}

package/src/types/CategoryType.ts

@@ -0,0 +1,249 @@
+import type { AnyMap } from 'react-native-nitro-modules'
+import type { CategoryTypeIdentifier } from './CategoryTypeIdentifier'
+import type { Device } from './Device'
+import type { DeletedSample, GenericMetadata } from './Shared'
+import type { SourceRevision } from './Source'
+
+export type CategoryTypePresenceIdentifier =
+  | 'HKCategoryTypeIdentifierAppetiteChanges'
+  | 'HKCategoryTypeIdentifierSleepChanges'
+
+export type CategoryTypeValueNotApplicableIdentifier =
+  | 'HKCategoryTypeIdentifierHighHeartRateEvent'
+  | 'HKCategoryTypeIdentifierIntermenstrualBleeding'
+  | 'HKCategoryTypeIdentifierMindfulSession'
+  | 'HKCategoryTypeIdentifierSexualActivity'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluepregnancytestresult Apple Docs }
+ */
+enum CategoryValuePregnancyTestResult {
+  positive = 2,
+  negative = 1,
+  indeterminate = 3,
+}
+
+export type CategoryTypeSeverityIdentifier =
+  | 'HKCategoryTypeIdentifierAbdominalCramps'
+  | 'HKCategoryTypeIdentifierAcne'
+  | 'HKCategoryTypeIdentifierBladderIncontinence'
+  | 'HKCategoryTypeIdentifierBloating'
+  | 'HKCategoryTypeIdentifierBreastPain'
+  | 'HKCategoryTypeIdentifierChestTightnessOrPain'
+  | 'HKCategoryTypeIdentifierChills'
+  | 'HKCategoryTypeIdentifierConstipation'
+  | 'HKCategoryTypeIdentifierCoughing'
+  | 'HKCategoryTypeIdentifierDiarrhea'
+  | 'HKCategoryTypeIdentifierDizziness'
+  | 'HKCategoryTypeIdentifierDrySkin'
+  | 'HKCategoryTypeIdentifierFainting'
+  | 'HKCategoryTypeIdentifierFatigue'
+  | 'HKCategoryTypeIdentifierFever'
+  | 'HKCategoryTypeIdentifierGeneralizedBodyAche'
+  | 'HKCategoryTypeIdentifierHairLoss'
+  | 'HKCategoryTypeIdentifierHeadache'
+  | 'HKCategoryTypeIdentifierHeartburn'
+  | 'HKCategoryTypeIdentifierHotFlashes'
+  | 'HKCategoryTypeIdentifierLossOfSmell'
+  | 'HKCategoryTypeIdentifierLossOfTaste'
+  | 'HKCategoryTypeIdentifierLowerBackPain'
+  | 'HKCategoryTypeIdentifierMemoryLapse'
+  | 'HKCategoryTypeIdentifierMoodChanges'
+  | 'HKCategoryTypeIdentifierNausea'
+  | 'HKCategoryTypeIdentifierNightSweats'
+  | 'HKCategoryTypeIdentifierPelvicPain'
+  | 'HKCategoryTypeIdentifierRapidPoundingOrFlutteringHeartbeat'
+  | 'HKCategoryTypeIdentifierRunnyNose'
+  | 'HKCategoryTypeIdentifierShortnessOfBreath'
+  | 'HKCategoryTypeIdentifierSinusCongestion'
+  | 'HKCategoryTypeIdentifierSkippedHeartbeat'
+  | 'HKCategoryTypeIdentifierSoreThroat'
+  | 'HKCategoryTypeIdentifierVaginalDryness'
+  | 'HKCategoryTypeIdentifierVomiting'
+  | 'HKCategoryTypeIdentifierWheezing'
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluecervicalmucusquality Apple Docs }
+ */
+export enum CategoryValueCervicalMucusQuality {
+  dry = 1,
+  sticky = 2,
+  creamy = 3,
+  watery = 4,
+  eggWhite = 5,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluemenstrualflow Apple Docs }
+ */
+export enum CategoryValueMenstrualFlow {
+  unspecified = 1,
+  none = 5,
+  light = 2,
+  medium = 3,
+  heavy = 4,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalueovulationtestresult Apple Docs }
+ */
+export enum CategoryValueOvulationTestResult {
+  negative = 1,
+  luteinizingHormoneSurge = 2,
+  indeterminate = 3,
+  estrogenSurge = 4,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluesleepanalysis Apple Docs }
+ */
+export enum CategoryValueSleepAnalysis {
+  inBed = 0,
+  asleepUnspecified = 1,
+  awake = 2,
+  asleepCore = 3,
+  asleepDeep = 4,
+  asleepREM = 5,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalueappetitechanges Apple Docs}
+ */
+export enum CategoryValueAppetiteChanges {
+  decreased = 2,
+  increased = 3,
+  noChange = 1,
+  unspecified = 0,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvaluepresence Apple Docs}
+ */
+export enum CategoryValuePresence {
+  notPresent = 1,
+  present = 0,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalueseverity Apple Docs }
+ */
+export enum CategoryValueSeverity {
+  notPresent = 1,
+  mild = 2,
+  moderate = 3,
+  severe = 4,
+  unspecified = 0,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalue/notapplicable Apple Docs }
+ */
+export enum CategoryValueNotApplicable {
+  notApplicable = 0,
+}
+
+export enum CategoryValueLowCardioFitnessEvent {
+  lowFitness = 1,
+}
+
+/**
+ * @see {@link https://developer.apple.com/documentation/healthkit/hkcategoryvalue Apple Docs }
+ */
+export type CategoryValue =
+  | CategoryValueAppetiteChanges
+  | CategoryValueCervicalMucusQuality
+  | CategoryValueLowCardioFitnessEvent
+  | CategoryValueMenstrualFlow
+  | CategoryValueOvulationTestResult
+  | CategoryValuePresence
+  | CategoryValueSeverity
+  | CategoryValueSleepAnalysis
+  | number
+
+export enum CategoryValueAppleStandHour {
+  stood = 0,
+  idle = 1,
+}
+
+export interface CategorySampleForSaving {
+  readonly start: Date
+  readonly end: Date
+  readonly categoryType: CategoryTypeIdentifier
+  readonly value: CategoryValueForIdentifier
+  readonly metadata: AnyMap
+  readonly sourceRevision?: SourceRevision
+}
+
+export interface CategorySamplesWithAnchorResponse {
+  readonly samples: readonly CategorySample[]
+  readonly deletedSamples: readonly DeletedSample[]
+  readonly newAnchor: string
+}
+
+export interface CategorySample {
+  readonly uuid: string
+  readonly device?: Device
+  readonly categoryType: CategoryTypeIdentifier
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly value: CategoryValueForIdentifier
+  readonly metadata: AnyMap
+  readonly sourceRevision?: SourceRevision
+}
+
+export interface CategorySamplesWithAnchorResponseTyped<
+  T extends CategoryTypeIdentifier,
+> {
+  readonly samples: readonly CategorySampleTyped<T>[]
+  readonly deletedSamples: readonly DeletedSample[]
+  readonly newAnchor: string
+}
+
+export interface CategorySampleTyped<T extends CategoryTypeIdentifier> {
+  readonly uuid: string
+  readonly device?: Device
+  readonly categoryType: T
+  readonly startDate: Date
+  readonly endDate: Date
+  readonly value: CategoryValueForIdentifier<T>
+  readonly metadata: MetadataForCategoryIdentifier<T>
+  readonly sourceRevision?: SourceRevision
+}
+
+export type MetadataForCategoryIdentifier<
+  T extends CategoryTypeIdentifier = CategoryTypeIdentifier,
+> = T extends 'HKCategoryTypeIdentifierSexualActivity'
+  ? GenericMetadata & {
+      readonly HKSexualActivityProtectionUsed: boolean
+    }
+  : T extends 'HKCategoryTypeIdentifierMenstrualFlow'
+    ? GenericMetadata & {
+        readonly HKMenstrualCycleStart: boolean
+      }
+    : GenericMetadata
+
+export type CategoryValueForIdentifier<
+  T extends CategoryTypeIdentifier = CategoryTypeIdentifier,
+> = T extends 'HKCategoryTypeIdentifierCervicalMucusQuality'
+  ? CategoryValueCervicalMucusQuality
+  : T extends 'CategoryTypeIdentifierMenstrualFlow'
+    ? CategoryValueMenstrualFlow
+    : T extends 'HKCategoryTypeIdentifierOvulationTestResult'
+      ? CategoryValueOvulationTestResult
+      : T extends 'HKCategoryTypeIdentifierSleepAnalysis'
+        ? CategoryValueSleepAnalysis
+        : T extends CategoryTypeValueNotApplicableIdentifier
+          ? CategoryValueNotApplicable
+          : T extends CategoryTypeSeverityIdentifier
+            ? CategoryValueSeverity
+            : T extends CategoryTypePresenceIdentifier
+              ? CategoryValuePresence
+              : T extends 'HKCategoryTypeIdentifierLowCardioFitnessEvent'
+                ? CategoryValueLowCardioFitnessEvent
+                : T extends 'HKCategoryTypeIdentifierPregnancyTestResult'
+                  ? CategoryValuePregnancyTestResult
+                  : T extends 'HKCategoryTypeIdentifierPregnancyTestResult'
+                    ? CategoryValuePregnancyTestResult
+                    : T extends 'HKCategoryTypeIdentifierAppleStandHour'
+                      ? CategoryValueAppleStandHour
+                      : number