@kingstinct/react-native-healthkit 4.2.0 → 4.4.1

package/src/types.ts

@@ -9,7 +9,6 @@ import type {
   HKCorrelationRaw,
   HKCorrelationTypeIdentifier,
   HKFitzpatrickSkinType,
-  MetadataMapperForCategoryIdentifier,
   HKQuantitySampleRaw,
   HKQuantityTypeIdentifier,
   HKSampleTypeIdentifier,
@@ -17,63 +16,67 @@ import type {
   HKUnit,
   HKUnitSI,
   HKUnitSIPrefix,
+  HKUpdateFrequency,
   HKWheelchairUse,
   HKWorkoutActivityType,
   HKWorkoutMetadata,
   HKWorkoutRaw,
+  MetadataMapperForCategoryIdentifier,
   MetadataMapperForCorrelationIdentifier,
   MetadataMapperForQuantityIdentifier,
   QueryStatisticsResponseRaw,
-  HKUpdateFrequency,
-} from './native-types';
+  WorkoutRoute,
+  HealthkitAuthorization,
+} from './native-types'
+import type { ValueOf } from 'type-fest'
 
 export interface QueryWorkoutsOptions<
   TEnergy extends HKUnit,
   TDistance extends HKUnit
 > extends GenericQueryOptions {
-  energyUnit?: TEnergy;
-  distanceUnit?: TDistance;
+  readonly energyUnit?: TEnergy;
+  readonly distanceUnit?: TDistance;
 }
 
 export interface HKCategorySample<
   T extends HKCategoryTypeIdentifier = HKCategoryTypeIdentifier
-> extends Omit<HKCategorySampleRaw<T>, 'startDate' | 'endDate'> {
-  startDate: Date;
-  endDate: Date;
+> extends Omit<HKCategorySampleRaw<T>, 'endDate' | 'startDate'> {
+  readonly startDate: Date;
+  readonly endDate: Date;
 }
 
 export type GenericQueryOptions = {
-  from?: Date;
-  to?: Date;
-  limit?: Number;
-  ascending?: boolean;
+  readonly from?: Date;
+  readonly to?: Date;
+  readonly limit?: number;
+  readonly ascending?: boolean;
 };
 
 export interface HKWorkout<
   TEnergy extends HKUnit = HKUnit,
   TDistance extends HKUnit = HKUnit
-> extends Omit<HKWorkoutRaw<TEnergy, TDistance>, 'startDate' | 'endDate'> {
-  startDate: Date;
-  endDate: Date;
+> extends Omit<HKWorkoutRaw<TEnergy, TDistance>, 'endDate' | 'startDate'> {
+  readonly startDate: Date;
+  readonly endDate: Date;
 }
 
 export interface HKQuantitySample<
   TIdentifier extends HKQuantityTypeIdentifier = HKQuantityTypeIdentifier,
   TUnit extends HKUnit = HKUnit
 > extends Omit<
-    HKQuantitySampleRaw<TIdentifier, TUnit>,
-    'startDate' | 'endDate'
+  HKQuantitySampleRaw<TIdentifier, TUnit>,
+  'endDate' | 'startDate'
   > {
-  startDate: Date;
-  endDate: Date;
+  readonly startDate: Date;
+  readonly endDate: Date;
 }
 
 export interface QueryStatisticsResponse<T extends HKUnit = HKUnit>
   extends Omit<
-    QueryStatisticsResponseRaw<T>,
-    'mostRecentQuantityDateInterval'
+  QueryStatisticsResponseRaw<T>,
+  'mostRecentQuantityDateInterval'
   > {
-  mostRecentQuantityDateInterval?: { from: Date; to: Date };
+  readonly mostRecentQuantityDateInterval?: { readonly from: Date; readonly to: Date };
 }
 
 type UnsubscribeFunction = () => Promise<boolean>;
@@ -89,7 +92,7 @@ export type GetFitzpatrickSkinTypeFn = () => Promise<HKFitzpatrickSkinType>;
 
 export type QueryStatisticsForQuantityFn = <TUnit extends HKUnit>(
   identifier: HKQuantityTypeIdentifier,
-  options: HKStatisticsOptions[],
+  options: readonly HKStatisticsOptions[],
   from: Date,
   to?: Date,
   unit?: TUnit
@@ -100,25 +103,27 @@ export type QueryWorkoutsFn = <
   TDistance extends HKUnit
 >(
   options: QueryWorkoutsOptions<TEnergy, TDistance>
-) => Promise<HKWorkout<TEnergy, TDistance>[]>;
+) => Promise<readonly HKWorkout<TEnergy, TDistance>[]>;
 
 export type AuthorizationStatusForFn = (
-  type: HKSampleTypeIdentifier | HKCharacteristicTypeIdentifier
+  type: HKCharacteristicTypeIdentifier | ValueOf<typeof HKSampleTypeIdentifier>
 ) => Promise<boolean>;
 
 export type QueryCategorySamplesFn = <T extends HKCategoryTypeIdentifier>(
   identifier: T,
   options: GenericQueryOptions
-) => Promise<HKCategorySample<T>[]>;
+) => Promise<readonly HKCategorySample<T>[]>;
+
+type ReadPermission = HKCharacteristicTypeIdentifier | ValueOf<typeof HKSampleTypeIdentifier>
 
 export type GetRequestStatusForAuthorizationFn = (
-  read: (HKCharacteristicTypeIdentifier | HKSampleTypeIdentifier)[],
-  write?: HKSampleTypeIdentifier[]
+  read: readonly ReadPermission[],
+  write?: readonly ValueOf<typeof HKSampleTypeIdentifier>[]
 ) => Promise<HKAuthorizationRequestStatus>;
 
 export type RequestAuthorizationFn = (
-  read: (HKCharacteristicTypeIdentifier | HKSampleTypeIdentifier)[],
-  write?: HKSampleTypeIdentifier[]
+  read: readonly (HKCharacteristicTypeIdentifier | ValueOf<typeof HKSampleTypeIdentifier>)[],
+  write?: readonly ValueOf<typeof HKSampleTypeIdentifier>[]
 ) => Promise<boolean>;
 
 export type SaveQuantitySampleFn = <TUnit extends HKQuantityTypeIdentifier>(
@@ -126,9 +131,9 @@ export type SaveQuantitySampleFn = <TUnit extends HKQuantityTypeIdentifier>(
   unit: HKUnit,
   value: number,
   options?: {
-    start?: Date;
-    end?: Date;
-    metadata?: MetadataMapperForQuantityIdentifier<TUnit>;
+    readonly start?: Date;
+    readonly end?: Date;
+    readonly metadata?: MetadataMapperForQuantityIdentifier<TUnit>;
   }
 ) => Promise<boolean>;
 
@@ -137,11 +142,11 @@ export type QueryQuantitySamplesFn = <
   TUnit extends HKUnit = HKUnit
 >(
   identifier: TIdentifier,
-  options: GenericQueryOptions & { unit?: TUnit }
-) => Promise<HKQuantitySample<TIdentifier, TUnit>[]>;
+  options: GenericQueryOptions & { readonly unit?: TUnit }
+) => Promise<readonly HKQuantitySample<TIdentifier, TUnit>[]>;
 
 export type SubscribeToChangesFn = (
-  identifier: HKSampleTypeIdentifier,
+  identifier: ValueOf<typeof HKSampleTypeIdentifier>,
   callback: () => void
 ) => Promise<UnsubscribeFunction>;
 
@@ -149,9 +154,9 @@ export type SaveCategorySampleFn = <T extends HKCategoryTypeIdentifier>(
   identifier: T,
   value: HKCategoryValueForIdentifier<T>,
   options?: {
-    start?: Date;
-    end?: Date;
-    metadata?: MetadataMapperForCategoryIdentifier<T>;
+    readonly start?: Date;
+    readonly end?: Date;
+    readonly metadata?: MetadataMapperForCategoryIdentifier<T>;
   }
 ) => Promise<boolean>;
 
@@ -177,7 +182,7 @@ export type GetMostRecentQuantitySampleFn = <
 >(
   identifier: TIdentifier,
   unit?: TUnit
-) => Promise<HKQuantitySample<TIdentifier, TUnit>>;
+) => Promise<HKQuantitySample<TIdentifier, TUnit> | null>;
 
 export type MostRecentQuantitySampleHook = <
   TIdentifier extends HKQuantityTypeIdentifier,
@@ -192,8 +197,8 @@ export type GetMostRecentWorkoutFn = <
   TDistance extends HKUnit
 >(
   options?: Pick<
-    QueryWorkoutsOptions<TEnergy, TDistance>,
-    'distanceUnit' | 'energyUnit'
+  QueryWorkoutsOptions<TEnergy, TDistance>,
+  'distanceUnit' | 'energyUnit'
   >
 ) => Promise<HKWorkout<TEnergy, TDistance> | null>;
 
@@ -202,14 +207,14 @@ export type MostRecentWorkoutHook = <
   TDistance extends HKUnit
 >(
   options?: Pick<
-    QueryWorkoutsOptions<TEnergy, TDistance>,
-    'distanceUnit' | 'energyUnit'
+  QueryWorkoutsOptions<TEnergy, TDistance>,
+  'distanceUnit' | 'energyUnit'
   >
 ) => HKWorkout<TEnergy, TDistance> | null;
 
 export type GetPreferredUnitsFn = (
-  identifiers: HKQuantityTypeIdentifier[]
-) => Promise<HKUnit[]>;
+  identifiers: readonly HKQuantityTypeIdentifier[]
+) => Promise<readonly HKUnit[]>;
 
 export type GetPreferredUnitFn = (
   identifier: HKQuantityTypeIdentifier
@@ -219,100 +224,110 @@ export type SaveCorrelationSampleFn = <
   TIdentifier extends HKCorrelationTypeIdentifier
 >(
   typeIdentifier: TIdentifier,
-  samples: (
-    | Omit<HKCategorySample, 'startDate' | 'endDate' | 'uuid' | 'device'>
-    | Omit<HKQuantitySample, 'startDate' | 'endDate' | 'uuid' | 'device'>
+  samples: readonly (
+    | Omit<HKCategorySample, 'device' | 'endDate' | 'startDate' | 'uuid'>
+    | Omit<HKQuantitySample, 'device' | 'endDate' | 'startDate' | 'uuid'>
   )[],
   options?: {
-    start?: Date;
-    end?: Date;
-    metadata?: MetadataMapperForCorrelationIdentifier<TIdentifier>;
+    readonly start?: Date;
+    readonly end?: Date;
+    readonly metadata?: MetadataMapperForCorrelationIdentifier<TIdentifier>;
   }
 ) => Promise<boolean>;
 
 export type SaveWorkoutSampleFn = (
   typeIdentifier: HKWorkoutActivityType,
-  quantities: Omit<
-    HKQuantitySample,
-    'startDate' | 'endDate' | 'uuid' | 'device'
+  quantities: readonly Omit<
+  HKQuantitySample,
+  'device' | 'endDate' | 'startDate' | 'uuid'
   >[],
   start: Date,
   options?: {
-    end?: Date;
-    metadata?: HKWorkoutMetadata;
+    readonly end?: Date;
+    readonly metadata?: HKWorkoutMetadata;
   }
 ) => Promise<boolean>;
 
 export interface HKCorrelation<TIdentifier extends HKCorrelationTypeIdentifier>
   extends Omit<
-    HKCorrelationRaw<TIdentifier>,
-    'startDate' | 'endDate' | 'objects'
+  HKCorrelationRaw<TIdentifier>,
+  'endDate' | 'objects' | 'startDate'
   > {
-  objects: (HKQuantitySample | HKCategorySample)[];
-  startDate: Date;
-  endDate: Date;
+  readonly objects: readonly (HKCategorySample | HKQuantitySample)[];
+  readonly startDate: Date;
+  readonly endDate: Date;
 }
 
 export type QueryCorrelationSamplesFn = <
   TIdentifier extends HKCorrelationTypeIdentifier
 >(
   typeIdentifier: TIdentifier,
-  options: Omit<GenericQueryOptions, 'limit' | 'ascending'>
-) => Promise<HKCorrelation<TIdentifier>[]>;
+  options: Omit<GenericQueryOptions, 'ascending' | 'limit'>
+) => Promise<readonly HKCorrelation<TIdentifier>[]>;
 
 export type SubscribeToChangesHook = <
-  TIdentifier extends HKSampleTypeIdentifier
+  TIdentifier extends ValueOf<typeof HKSampleTypeIdentifier>
 >(
   identifier: TIdentifier,
   onChange: () => void,
   runInitialUpdate?: boolean
 ) => void;
 
+export type GetWorkoutRoutesFn = (
+  workoutUUID: string
+) => Promise<readonly WorkoutRoute[]>;
+
 export type ReactNativeHealthkit = {
-  authorizationStatusFor: AuthorizationStatusForFn;
-
-  getBiologicalSex: GetBiologicalSexFn;
-  getBloodType: GetBloodTypeFn;
-  getDateOfBirth: GetDateOfBirthFn;
-  getFitzpatrickSkinType: GetFitzpatrickSkinTypeFn;
-  getMostRecentQuantitySample: GetMostRecentQuantitySampleFn;
-  getMostRecentCategorySample: GetMostRecentCategorySampleFn;
-  getMostRecentWorkout: GetMostRecentWorkoutFn;
-  getPreferredUnit: GetPreferredUnitFn;
-  getPreferredUnits: GetPreferredUnitsFn;
-  getRequestStatusForAuthorization: GetRequestStatusForAuthorizationFn;
-  getWheelchairUse: GetWheelchairUseFn;
-
-  buildUnitWithPrefix: (prefix: HKUnitSIPrefix, unit: HKUnitSI) => HKUnit;
-
-  isHealthDataAvailable: IsHealthDataAvailableFn;
-
-  queryCategorySamples: QueryCategorySamplesFn;
-  queryQuantitySamples: QueryQuantitySamplesFn;
-  queryStatisticsForQuantity: QueryStatisticsForQuantityFn;
-  queryWorkouts: QueryWorkoutsFn;
-  queryCorrelationSamples: QueryCorrelationSamplesFn;
-
-  requestAuthorization: RequestAuthorizationFn;
-
-  saveCategorySample: SaveCategorySampleFn;
-  saveQuantitySample: SaveQuantitySampleFn;
-  saveCorrelationSample: SaveCorrelationSampleFn;
-  saveWorkoutSample: SaveWorkoutSampleFn;
-  enableBackgroundDelivery: (
-    typeIdentifier: HKSampleTypeIdentifier,
+  readonly authorizationStatusFor: AuthorizationStatusForFn;
+
+  readonly getBiologicalSex: GetBiologicalSexFn;
+  readonly getBloodType: GetBloodTypeFn;
+  readonly getDateOfBirth: GetDateOfBirthFn;
+  readonly getFitzpatrickSkinType: GetFitzpatrickSkinTypeFn;
+  readonly getMostRecentQuantitySample: GetMostRecentQuantitySampleFn;
+  readonly getMostRecentCategorySample: GetMostRecentCategorySampleFn;
+  readonly getMostRecentWorkout: GetMostRecentWorkoutFn;
+  readonly getPreferredUnit: GetPreferredUnitFn;
+  readonly getPreferredUnits: GetPreferredUnitsFn;
+  readonly getRequestStatusForAuthorization: GetRequestStatusForAuthorizationFn;
+  readonly getWheelchairUse: GetWheelchairUseFn;
+  readonly getWorkoutRoutes: GetWorkoutRoutesFn;
+
+  readonly buildUnitWithPrefix: (prefix: HKUnitSIPrefix, unit: HKUnitSI) => HKUnit;
+
+  readonly isHealthDataAvailable: IsHealthDataAvailableFn;
+
+  readonly queryCategorySamples: QueryCategorySamplesFn;
+  readonly queryQuantitySamples: QueryQuantitySamplesFn;
+  readonly queryStatisticsForQuantity: QueryStatisticsForQuantityFn;
+  readonly queryWorkouts: QueryWorkoutsFn;
+  readonly queryCorrelationSamples: QueryCorrelationSamplesFn;
+
+  readonly requestAuthorization: RequestAuthorizationFn;
+
+  readonly saveCategorySample: SaveCategorySampleFn;
+  readonly saveQuantitySample: SaveQuantitySampleFn;
+  readonly saveCorrelationSample: SaveCorrelationSampleFn;
+  readonly saveWorkoutSample: SaveWorkoutSampleFn;
+  readonly enableBackgroundDelivery: (
+    typeIdentifier: ValueOf<typeof HKSampleTypeIdentifier>,
     updateFrequency: HKUpdateFrequency
   ) => Promise<boolean>;
-  disableBackgroundDelivery: (
-    typeIdentifier: HKSampleTypeIdentifier
+  readonly disableBackgroundDelivery: (
+    typeIdentifier: ValueOf<typeof HKSampleTypeIdentifier>
   ) => Promise<boolean>;
-  disableAllBackgroundDelivery: () => Promise<boolean>;
+  readonly disableAllBackgroundDelivery: () => Promise<boolean>;
 
-  subscribeToChanges: SubscribeToChangesFn;
+  readonly subscribeToChanges: SubscribeToChangesFn;
 
-  useMostRecentWorkout: MostRecentWorkoutHook;
-  useMostRecentCategorySample: MostRecentCategorySampleHook;
-  useMostRecentQuantitySample: MostRecentQuantitySampleHook;
+  readonly useMostRecentWorkout: MostRecentWorkoutHook;
+  readonly useMostRecentCategorySample: MostRecentCategorySampleHook;
+  readonly useMostRecentQuantitySample: MostRecentQuantitySampleHook;
 
-  useSubscribeToChanges: SubscribeToChangesHook;
+  readonly useSubscribeToChanges: SubscribeToChangesHook;
+  readonly useIsHealthDataAvailable: () => boolean | null;
+  readonly useHealthkitAuthorization: (
+    read: readonly ValueOf<typeof HealthkitAuthorization>[],
+    write?: readonly ValueOf<typeof HKSampleTypeIdentifier>[],
+  ) => readonly [authorizationStatus: HKAuthorizationRequestStatus | null, request: () => Promise<HKAuthorizationRequestStatus | null>];
 };

package/.circleci/config.yml

@@ -1,98 +0,0 @@
-version: 2.1
-
-executors:
-  default:
-    docker:
-      - image: circleci/node:10
-    working_directory: ~/project
-
-commands:
-  attach_project:
-    steps:
-      - attach_workspace:
-          at: ~/project
-
-jobs:
-  install-dependencies:
-    executor: default
-    steps:
-      - checkout
-      - attach_project
-      - restore_cache:
-          keys:
-            - dependencies-{{ checksum "package.json" }}
-            - dependencies-
-      - restore_cache:
-          keys:
-            - dependencies-example-{{ checksum "example/package.json" }}
-            - dependencies-example-
-      - run:
-          name: Install dependencies
-          command: |
-            yarn install --cwd example --frozen-lockfile
-            yarn install --frozen-lockfile
-      - save_cache:
-          key: dependencies-{{ checksum "package.json" }}
-          paths: node_modules
-      - save_cache:
-          key: dependencies-example-{{ checksum "example/package.json" }}
-          paths: example/node_modules
-      - persist_to_workspace:
-          root: .
-          paths: .
-
-  lint:
-    executor: default
-    steps:
-      - attach_project
-      - run:
-          name: Lint files
-          command: |
-            yarn lint
-
-  typescript:
-    executor: default
-    steps:
-      - attach_project
-      - run:
-          name: Typecheck files
-          command: |
-            yarn typescript
-
-  unit-tests:
-    executor: default
-    steps:
-      - attach_project
-      - run:
-          name: Run unit tests
-          command: |
-            yarn test --coverage
-      - store_artifacts:
-          path: coverage
-          destination: coverage
-
-  build-package:
-    executor: default
-    steps:
-      - attach_project
-      - run:
-          name: Build package
-          command: |
-            yarn prepare
-
-workflows:
-  build-and-test:
-    jobs:
-      - install-dependencies
-      - lint:
-          requires:
-            - install-dependencies
-      - typescript:
-          requires:
-            - install-dependencies
-      - unit-tests:
-          requires:
-            - install-dependencies
-      - build-package:
-          requires:
-            - install-dependencies

package/.editorconfig

@@ -1,15 +0,0 @@
-# EditorConfig helps developers define and maintain consistent
-# coding styles between different editors and IDEs
-# editorconfig.org
-
-root = true
-
-[*]
-
-indent_style = space
-indent_size = 2
-
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

package/.gitattributes

@@ -1,3 +0,0 @@
-*.pbxproj -text
-# specific for windows script files
-*.bat text eol=crlf

package/.github/workflows/main.yml

@@ -1,32 +0,0 @@
-# This is a basic workflow to help you get started with Actions
-
-name: Test
-
-# Controls when the action will run. 
-on:
-  push:
-    branches: [ '**' ]
-  pull_request:
-    branches: [ '**' ]
-  workflow_dispatch:
-
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
-jobs:
-  # This workflow contains a single job called "build"
-  build:
-    # The type of runner that the job will run on
-    runs-on: ubuntu-latest
-
-    # Steps represent a sequence of tasks that will be executed as part of the job
-    steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - name: "Checkout"
-        uses: actions/checkout@v2
-      - name: "Setup Node"
-        uses: actions/setup-node@v2.1.5
-      - name: "Install example deps"
-        run: cd example && yarn && cd ..
-      - name: "Install deps"
-        run: yarn
-      - name: "Lint and typecheck"
-        run: yarn typescript && yarn lint

package/.gitignore

@@ -1,60 +0,0 @@
-# OSX
-#
-.DS_Store
-
-# XDE
-.expo/
-
-# VSCode
-.vscode/
-jsconfig.json
-
-# Xcode
-#
-build/
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
-xcuserdata
-*.xccheckout
-*.moved-aside
-DerivedData
-*.hmap
-*.ipa
-*.xcuserstate
-project.xcworkspace
-
-# Android/IJ
-#
-.idea
-.gradle
-local.properties
-android.iml
-
-# Cocoapods
-#
-example/ios/Pods
-
-# node.js
-#
-node_modules/
-npm-debug.log
-yarn-debug.log
-yarn-error.log
-
-# BUCK
-buck-out/
-\.buckd/
-android/app/libs
-android/keystores/debug.keystore
-
-# Expo
-.expo/*
-
-# generated by bob
-lib/