@kingstinct/react-native-healthkit 4.3.0 → 4.4.2

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

@@ -1,30 +1,30 @@
-import type { HKAuthorizationRequestStatus, HKBiologicalSex, HKBloodType, HKCategorySampleRaw, HKCategoryTypeIdentifier, HKCategoryValueForIdentifier, HKCharacteristicTypeIdentifier, HKCorrelationRaw, HKCorrelationTypeIdentifier, HKFitzpatrickSkinType, HKQuantitySampleRaw, HKQuantityTypeIdentifier, HKSampleTypeIdentifier, HKStatisticsOptions, HKUnit, HKUnitSI, HKUnitSIPrefix, HKUpdateFrequency, HKWheelchairUse, HKWorkoutActivityType, HKWorkoutMetadata, HKWorkoutRaw, MetadataMapperForCategoryIdentifier, MetadataMapperForCorrelationIdentifier, MetadataMapperForQuantityIdentifier, QueryStatisticsResponseRaw, WorkoutRoute } from './native-types';
+import type { HealthkitReadAuthorization, HealthkitWriteAuthorization, HKAuthorizationRequestStatus, HKBiologicalSex, HKBloodType, HKCategorySampleRaw, HKCategoryTypeIdentifier, HKCategoryValueForIdentifier, HKCorrelationRaw, HKCorrelationTypeIdentifier, HKFitzpatrickSkinType, HKQuantitySampleRaw, HKQuantityTypeIdentifier, HKStatisticsOptions, HKUnit, HKUnitSI, HKUnitSIPrefix, HKUpdateFrequency, HKWheelchairUse, HKWorkoutActivityType, HKWorkoutMetadata, HKWorkoutRaw, MetadataMapperForCategoryIdentifier, MetadataMapperForCorrelationIdentifier, MetadataMapperForQuantityIdentifier, QueryStatisticsResponseRaw, SampleTypeIdentifier, WorkoutRoute } from './native-types';
 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;
+export interface HKCategorySample<T extends HKCategoryTypeIdentifier = HKCategoryTypeIdentifier> extends Omit<HKCategorySampleRaw<T>, 'endDate' | 'startDate'> {
+    readonly startDate: Date;
+    readonly endDate: Date;
 }
 export declare 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;
+export interface HKWorkout<TEnergy extends HKUnit = HKUnit, TDistance extends HKUnit = HKUnit> 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'> {
-    startDate: Date;
-    endDate: Date;
+export interface HKQuantitySample<TIdentifier extends HKQuantityTypeIdentifier = HKQuantityTypeIdentifier, TUnit extends HKUnit = HKUnit> extends Omit<HKQuantitySampleRaw<TIdentifier, TUnit>, 'endDate' | 'startDate'> {
+    readonly startDate: Date;
+    readonly endDate: Date;
 }
 export interface QueryStatisticsResponse<T extends HKUnit = HKUnit> extends Omit<QueryStatisticsResponseRaw<T>, 'mostRecentQuantityDateInterval'> {
-    mostRecentQuantityDateInterval?: {
-        from: Date;
-        to: Date;
+    readonly mostRecentQuantityDateInterval?: {
+        readonly from: Date;
+        readonly to: Date;
     };
 }
 declare type UnsubscribeFunction = () => Promise<boolean>;
@@ -34,85 +34,87 @@ export declare type GetDateOfBirthFn = () => Promise<Date>;
 export declare type GetBiologicalSexFn = () => Promise<HKBiologicalSex>;
 export declare type GetWheelchairUseFn = () => Promise<HKWheelchairUse>;
 export declare type GetFitzpatrickSkinTypeFn = () => Promise<HKFitzpatrickSkinType>;
-export declare type QueryStatisticsForQuantityFn = <TUnit extends HKUnit>(identifier: HKQuantityTypeIdentifier, options: HKStatisticsOptions[], from: Date, to?: Date, unit?: TUnit) => Promise<QueryStatisticsResponse<TUnit>>;
-export declare type QueryWorkoutsFn = <TEnergy extends HKUnit, TDistance extends HKUnit>(options: QueryWorkoutsOptions<TEnergy, TDistance>) => Promise<HKWorkout<TEnergy, TDistance>[]>;
-export declare type AuthorizationStatusForFn = (type: HKSampleTypeIdentifier | HKCharacteristicTypeIdentifier) => Promise<boolean>;
-export declare type QueryCategorySamplesFn = <T extends HKCategoryTypeIdentifier>(identifier: T, options: GenericQueryOptions) => Promise<HKCategorySample<T>[]>;
-export declare type GetRequestStatusForAuthorizationFn = (read: (HKCharacteristicTypeIdentifier | HKSampleTypeIdentifier)[], write?: HKSampleTypeIdentifier[]) => Promise<HKAuthorizationRequestStatus>;
-export declare type RequestAuthorizationFn = (read: (HKCharacteristicTypeIdentifier | HKSampleTypeIdentifier)[], write?: HKSampleTypeIdentifier[]) => Promise<boolean>;
+export declare type QueryStatisticsForQuantityFn = <TUnit extends HKUnit>(identifier: HKQuantityTypeIdentifier, options: readonly HKStatisticsOptions[], from: Date, to?: Date, unit?: TUnit) => Promise<QueryStatisticsResponse<TUnit>>;
+export declare type QueryWorkoutsFn = <TEnergy extends HKUnit, TDistance extends HKUnit>(options: QueryWorkoutsOptions<TEnergy, TDistance>) => Promise<readonly HKWorkout<TEnergy, TDistance>[]>;
+export declare type AuthorizationStatusForFn = (type: HealthkitReadAuthorization) => Promise<boolean>;
+export declare type QueryCategorySamplesFn = <T extends HKCategoryTypeIdentifier>(identifier: T, options: GenericQueryOptions) => Promise<readonly HKCategorySample<T>[]>;
+export declare type GetRequestStatusForAuthorizationFn = (read: readonly HealthkitReadAuthorization[], write?: readonly HealthkitWriteAuthorization[]) => Promise<HKAuthorizationRequestStatus>;
+export declare type RequestAuthorizationFn = (read: readonly HealthkitReadAuthorization[], write?: readonly HealthkitWriteAuthorization[]) => Promise<boolean>;
 export declare type SaveQuantitySampleFn = <TUnit extends HKQuantityTypeIdentifier>(identifier: TUnit, unit: HKUnit, value: number, options?: {
-    start?: Date;
-    end?: Date;
-    metadata?: MetadataMapperForQuantityIdentifier<TUnit>;
+    readonly start?: Date;
+    readonly end?: Date;
+    readonly metadata?: MetadataMapperForQuantityIdentifier<TUnit>;
 }) => Promise<boolean>;
 export declare type QueryQuantitySamplesFn = <TIdentifier extends HKQuantityTypeIdentifier, TUnit extends HKUnit = HKUnit>(identifier: TIdentifier, options: GenericQueryOptions & {
-    unit?: TUnit;
-}) => Promise<HKQuantitySample<TIdentifier, TUnit>[]>;
-export declare type SubscribeToChangesFn = (identifier: HKSampleTypeIdentifier, callback: () => void) => Promise<UnsubscribeFunction>;
+    readonly unit?: TUnit;
+}) => Promise<readonly HKQuantitySample<TIdentifier, TUnit>[]>;
+export declare type SubscribeToChangesFn = (identifier: SampleTypeIdentifier, callback: () => void) => Promise<UnsubscribeFunction>;
 export declare 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>;
 export declare type GetMostRecentCategorySampleFn = <T extends HKCategoryTypeIdentifier>(identifier: T) => Promise<HKCategorySample<T> | null>;
 export declare type MostRecentCategorySampleHook = <T extends HKCategoryTypeIdentifier>(identifier: T) => HKCategorySample<T> | null;
 export declare type MostRecentCorrelationSampleHook = <T extends HKCorrelationTypeIdentifier>(identifer: T) => HKCorrelation<T> | null;
-export declare type GetMostRecentQuantitySampleFn = <TIdentifier extends HKQuantityTypeIdentifier, TUnit extends HKUnit>(identifier: TIdentifier, unit?: TUnit) => Promise<HKQuantitySample<TIdentifier, TUnit>>;
+export declare type GetMostRecentQuantitySampleFn = <TIdentifier extends HKQuantityTypeIdentifier, TUnit extends HKUnit>(identifier: TIdentifier, unit?: TUnit) => Promise<HKQuantitySample<TIdentifier, TUnit> | null>;
 export declare type MostRecentQuantitySampleHook = <TIdentifier extends HKQuantityTypeIdentifier, TUnit extends HKUnit>(identifier: TIdentifier, unit?: TUnit) => HKQuantitySample<TIdentifier, TUnit> | null;
 export declare type GetMostRecentWorkoutFn = <TEnergy extends HKUnit, TDistance extends HKUnit>(options?: Pick<QueryWorkoutsOptions<TEnergy, TDistance>, 'distanceUnit' | 'energyUnit'>) => Promise<HKWorkout<TEnergy, TDistance> | null>;
 export declare type MostRecentWorkoutHook = <TEnergy extends HKUnit, TDistance extends HKUnit>(options?: Pick<QueryWorkoutsOptions<TEnergy, TDistance>, 'distanceUnit' | 'energyUnit'>) => HKWorkout<TEnergy, TDistance> | null;
-export declare type GetPreferredUnitsFn = (identifiers: HKQuantityTypeIdentifier[]) => Promise<HKUnit[]>;
+export declare type GetPreferredUnitsFn = (identifiers: readonly HKQuantityTypeIdentifier[]) => Promise<readonly HKUnit[]>;
 export declare type GetPreferredUnitFn = (identifier: HKQuantityTypeIdentifier) => Promise<HKUnit>;
-export declare type SaveCorrelationSampleFn = <TIdentifier extends HKCorrelationTypeIdentifier>(typeIdentifier: TIdentifier, samples: (Omit<HKCategorySample, 'startDate' | 'endDate' | 'uuid' | 'device'> | Omit<HKQuantitySample, 'startDate' | 'endDate' | 'uuid' | 'device'>)[], options?: {
-    start?: Date;
-    end?: Date;
-    metadata?: MetadataMapperForCorrelationIdentifier<TIdentifier>;
+export declare type SaveCorrelationSampleFn = <TIdentifier extends HKCorrelationTypeIdentifier>(typeIdentifier: TIdentifier, samples: readonly (Omit<HKCategorySample, 'device' | 'endDate' | 'startDate' | 'uuid'> | Omit<HKQuantitySample, 'device' | 'endDate' | 'startDate' | 'uuid'>)[], options?: {
+    readonly start?: Date;
+    readonly end?: Date;
+    readonly metadata?: MetadataMapperForCorrelationIdentifier<TIdentifier>;
 }) => Promise<boolean>;
-export declare type SaveWorkoutSampleFn = (typeIdentifier: HKWorkoutActivityType, quantities: Omit<HKQuantitySample, 'startDate' | 'endDate' | 'uuid' | 'device'>[], start: Date, options?: {
-    end?: Date;
-    metadata?: HKWorkoutMetadata;
+export declare type SaveWorkoutSampleFn = (typeIdentifier: HKWorkoutActivityType, quantities: readonly Omit<HKQuantitySample, 'device' | 'endDate' | 'startDate' | 'uuid'>[], start: Date, options?: {
+    readonly end?: Date;
+    readonly metadata?: HKWorkoutMetadata;
 }) => Promise<boolean>;
-export interface HKCorrelation<TIdentifier extends HKCorrelationTypeIdentifier> extends Omit<HKCorrelationRaw<TIdentifier>, 'startDate' | 'endDate' | 'objects'> {
-    objects: (HKQuantitySample | HKCategorySample)[];
-    startDate: Date;
-    endDate: Date;
+export interface HKCorrelation<TIdentifier extends HKCorrelationTypeIdentifier> extends Omit<HKCorrelationRaw<TIdentifier>, 'endDate' | 'objects' | 'startDate'> {
+    readonly objects: readonly (HKCategorySample | HKQuantitySample)[];
+    readonly startDate: Date;
+    readonly endDate: Date;
 }
-export declare type QueryCorrelationSamplesFn = <TIdentifier extends HKCorrelationTypeIdentifier>(typeIdentifier: TIdentifier, options: Omit<GenericQueryOptions, 'limit' | 'ascending'>) => Promise<HKCorrelation<TIdentifier>[]>;
-export declare type SubscribeToChangesHook = <TIdentifier extends HKSampleTypeIdentifier>(identifier: TIdentifier, onChange: () => void, runInitialUpdate?: boolean) => void;
-export declare type GetWorkoutRoutesFn = (workoutUUID: string) => Promise<WorkoutRoute[]>;
+export declare type QueryCorrelationSamplesFn = <TIdentifier extends HKCorrelationTypeIdentifier>(typeIdentifier: TIdentifier, options: Omit<GenericQueryOptions, 'ascending' | 'limit'>) => Promise<readonly HKCorrelation<TIdentifier>[]>;
+export declare type SubscribeToChangesHook = <TIdentifier extends SampleTypeIdentifier>(identifier: TIdentifier, onChange: () => void, runInitialUpdate?: boolean) => void;
+export declare type GetWorkoutRoutesFn = (workoutUUID: string) => Promise<readonly WorkoutRoute[]>;
 export declare 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;
-    getWorkoutRoutes: GetWorkoutRoutesFn;
-    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, updateFrequency: HKUpdateFrequency) => Promise<boolean>;
-    disableBackgroundDelivery: (typeIdentifier: HKSampleTypeIdentifier) => Promise<boolean>;
-    disableAllBackgroundDelivery: () => Promise<boolean>;
-    subscribeToChanges: SubscribeToChangesFn;
-    useMostRecentWorkout: MostRecentWorkoutHook;
-    useMostRecentCategorySample: MostRecentCategorySampleHook;
-    useMostRecentQuantitySample: MostRecentQuantitySampleHook;
-    useSubscribeToChanges: SubscribeToChangesHook;
+    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: SampleTypeIdentifier, updateFrequency: HKUpdateFrequency) => Promise<boolean>;
+    readonly disableBackgroundDelivery: (typeIdentifier: SampleTypeIdentifier) => Promise<boolean>;
+    readonly disableAllBackgroundDelivery: () => Promise<boolean>;
+    readonly subscribeToChanges: SubscribeToChangesFn;
+    readonly useMostRecentWorkout: MostRecentWorkoutHook;
+    readonly useMostRecentCategorySample: MostRecentCategorySampleHook;
+    readonly useMostRecentQuantitySample: MostRecentQuantitySampleHook;
+    readonly useSubscribeToChanges: SubscribeToChangesHook;
+    readonly useIsHealthDataAvailable: () => boolean | null;
+    readonly useHealthkitAuthorization: (read: readonly HealthkitReadAuthorization[], write?: readonly HealthkitWriteAuthorization[]) => readonly [authorizationStatus: HKAuthorizationRequestStatus | null, request: () => Promise<HKAuthorizationRequestStatus | null>];
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kingstinct/react-native-healthkit",
-  "version": "4.3.0",
+  "version": "4.4.2",
   "description": "React Native bindings for HealthKit",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -21,7 +21,7 @@
   ],
   "scripts": {
     "test": "jest",
-    "typescript": "tsc --noEmit",
+    "typecheck": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\"",
     "prepare": "bob build",
     "release": "release-it",
@@ -45,25 +45,36 @@
   "homepage": "https://github.com/kingstinct/react-native-healthkit#readme",
   "devDependencies": {
     "@commitlint/config-conventional": "12",
-    "@react-native-community/eslint-config": "^2.0.0",
+    "@graphql-eslint/eslint-plugin": ">=3",
     "@release-it/conventional-changelog": "2",
-    "@types/jest": "27",
+    "@types/jest": ">=26",
     "@types/react": "17",
     "@types/react-native": "0.67",
+    "@typescript-eslint/eslint-plugin": ">=5",
+    "@typescript-eslint/parser": ">=5",
     "commitlint": "12",
-    "eslint": "^7.2.0",
-    "eslint-config-prettier": "8",
-    "eslint-plugin-prettier": "^3.1.3",
+    "eslint": ">=8",
+    "eslint-config-airbnb-base": ">=15",
+    "eslint-config-kingstinct": "5.1.1",
+    "eslint-import-resolver-typescript": ">=3",
+    "eslint-plugin-comment-length": ">=0",
+    "eslint-plugin-functional": ">=4",
+    "eslint-plugin-import": ">=2",
+    "eslint-plugin-jest": ">=26",
+    "eslint-plugin-jsonc": ">=2",
+    "eslint-plugin-unicorn": ">=43",
+    "eslint-plugin-yml": ">=1",
+    "graphql": ">=16",
     "husky": "^4.2.5",
-    "jest": "28",
+    "jest": ">=26",
     "metro-react-native-babel-preset": "^0.70.3",
     "pod-install": "^0.1.0",
-    "prettier": "^2.0.5",
     "react": "17",
     "react-native": "0.68",
     "react-native-builder-bob": "^0.18.1",
     "release-it": "14",
-    "typescript": "4"
+    "type-fest": "^2.18.0",
+    "typescript": ">=4"
   },
   "peerDependencies": {
     "react": "*",
@@ -108,35 +119,10 @@
       }
     }
   },
-  "eslintConfig": {
-    "extends": [
-      "@react-native-community",
-      "prettier"
-    ],
-    "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
-        }
-      ]
-    }
-  },
   "eslintIgnore": [
     "node_modules/",
     "lib/"
   ],
-  "prettier": {
-    "quoteProps": "consistent",
-    "singleQuote": true,
-    "tabWidth": 2,
-    "trailingComma": "es5",
-    "useTabs": false
-  },
   "react-native-builder-bob": {
     "source": "src",
     "output": "lib",