@hedia/recommendation-screen 2.2.0-alpha.30 → 2.2.0-alpha.32

package/dist/src/types/enum.d.ts

@@ -106,7 +106,8 @@ export declare enum RecommendationErrorEnum {
     BloodKetoneUnit = 19,
     BloodGlucoseUnit = 20,
     BloodKetoneProps = 21,
-    VeryLowForecastedGlucose = 22
+    CGMOutsideRange = 22,
+    ForecastOutsideRange = 23
 }
 /** Indicates the category of the user’s blood glucose level. */
 export declare enum BgLevel {

package/dist/src/types/enum.js

@@ -120,7 +120,8 @@ export var RecommendationErrorEnum;
     RecommendationErrorEnum[RecommendationErrorEnum["BloodKetoneUnit"] = 19] = "BloodKetoneUnit";
     RecommendationErrorEnum[RecommendationErrorEnum["BloodGlucoseUnit"] = 20] = "BloodGlucoseUnit";
     RecommendationErrorEnum[RecommendationErrorEnum["BloodKetoneProps"] = 21] = "BloodKetoneProps";
-    RecommendationErrorEnum[RecommendationErrorEnum["VeryLowForecastedGlucose"] = 22] = "VeryLowForecastedGlucose";
+    RecommendationErrorEnum[RecommendationErrorEnum["CGMOutsideRange"] = 22] = "CGMOutsideRange";
+    RecommendationErrorEnum[RecommendationErrorEnum["ForecastOutsideRange"] = 23] = "ForecastOutsideRange";
 })(RecommendationErrorEnum || (RecommendationErrorEnum = {}));
 /** Indicates the category of the user’s blood glucose level. */
 export var BgLevel;

package/dist/src/utils/Constants.d.ts

@@ -54,5 +54,7 @@ export declare const ACTIVITY_TARGET_BGL_MMOL_LIMITS: IInterval;
 export declare const REMINDER_HOURS_LIMITS: IInterval;
 /** The lower and upper limits for activity reduction. */
 export declare const ACTIVITY_SETTINGS_INTERVAL_LIMITS: IInterval;
-/** The number of CGM forecasted glucose units, that's considered to be very low. */
-export declare const FORECASTED_CGM_VERY_LOW_LIMIT_MMOLL: number;
+/** The lower and upper limits of the cgm reading value in mmol/L. */
+export declare const CGM_LIMITS: IInterval;
+/** The lower and upper limits of the forecast predicted value in mmol/L. */
+export declare const FORECAST_LIMITS: IInterval;

package/dist/src/utils/Constants.js

@@ -54,5 +54,7 @@ export const ACTIVITY_TARGET_BGL_MMOL_LIMITS = { min: 5, max: 13.9 };
 export const REMINDER_HOURS_LIMITS = { min: 0, max: 6 };
 /** The lower and upper limits for activity reduction. */
 export const ACTIVITY_SETTINGS_INTERVAL_LIMITS = { min: 0, max: 1 };
-/** The number of CGM forecasted glucose units, that's considered to be very low. */
-export const FORECASTED_CGM_VERY_LOW_LIMIT_MMOLL = 3.5;
+/** The lower and upper limits of the cgm reading value in mmol/L. */
+export const CGM_LIMITS = { min: 2.2, max: 22.2 };
+/** The lower and upper limits of the forecast predicted value in mmol/L. */
+export const FORECAST_LIMITS = { min: 1.1, max: 25 };

package/dist/src/utils/RecommendationError.d.ts

@@ -54,5 +54,7 @@ export declare const BloodKetoneUnitError: () => RecommendationError;
 export declare const BloodGlucoseUnitError: () => RecommendationError;
 /** The user has provided a blood ketone level but the blood ketone measuring  unit is not defined. */
 export declare const BloodKetonePropsError: () => RecommendationError;
-/** The user has provided a forecast cgm glucose value is very low. */
-export declare const ForecastedGlucoseIsVeryLowError: () => RecommendationError;
+/** The user’s cgm reading value is outside of the valid range. */
+export declare const CGMOutsideRangeError: () => RecommendationError;
+/** The user’s forecasted value is outside of the valid range. */
+export declare const ForecastOutsideRangeError: () => RecommendationError;

package/dist/src/utils/RecommendationError.js

@@ -61,5 +61,7 @@ export const BloodKetoneUnitError = () => new RecommendationError(i18n._(t `Erro
 export const BloodGlucoseUnitError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your current blood glucose unit.`), RecommendationErrorEnum.BloodGlucoseUnit);
 /** The user has provided a blood ketone level but the blood ketone measuring  unit is not defined. */
 export const BloodKetonePropsError = () => new RecommendationError(i18n._(t `Error. Your blood ketone settings are invalid.`), RecommendationErrorEnum.BloodKetoneProps);
-/** The user has provided a forecast cgm glucose value is very low. */
-export const ForecastedGlucoseIsVeryLowError = () => new RecommendationError(i18n._(t `Error. Your forecasted cgm glucose is very low.`), RecommendationErrorEnum.VeryLowForecastedGlucose);
+/** The user’s cgm reading value is outside of the valid range. */
+export const CGMOutsideRangeError = () => new RecommendationError(i18n._(t `Error. Your cgm reading value is outside range.`), RecommendationErrorEnum.CGMOutsideRange);
+/** The user’s forecasted value is outside of the valid range. */
+export const ForecastOutsideRangeError = () => new RecommendationError(i18n._(t `Error. Your forecasted value is outside range.`), RecommendationErrorEnum.ForecastOutsideRange);

package/dist/src/utils/Validations.d.ts

@@ -248,11 +248,20 @@ export declare function checkInsulinToCarbRatio(insulinToCarbRatio: number): voi
  * @param carbohydrates The amount of carbohydrates that the user is eating in grams.
  */
 export declare function checkCarbohydrates(carbohydrates: number): void;
+/**
+ * Check if the cgm reading value is in range.
+ *
+ * Steps:
+ * 1. Check if cgm reading value is in range. If it isn’t then throw a CGMOutsideRangeError().
+ * @param cgm The cgm data, that includes `latestCGMReadingMmoll` and `cgmTimestamp`
+ *
+ */
+export declare function checkCGM(cgm: Logbook.Types.ILogbookEntry[`cgm_reading`]): void;
 /**
  * Check if the forecasted glucose is not very low.
  *
  * Steps:
- * 1. Check if forecasted glucose is above very low limit. If it isn’t then throw a ForecastedGlucoseIsVeryLowError().
+ * 1. Check if forecasted glucose value is in range. If it isn’t then throw a ForecastOutsideRangeError().
  * @param forecast The forecast data, that includes `forecastGlucoseMmoll` and `forecastTimestamp`
  */
-export declare function checkVeryLowForecastedGlucose(forecast: Logbook.Types.ILogbookEntry[`forecast_glucose`] | undefined): void;
+export declare function checkForecast(forecast: Logbook.Types.ILogbookEntry[`forecast_glucose`] | undefined): void;

package/dist/src/utils/Validations.js

@@ -6,8 +6,8 @@
  */
 import { Activity, BloodGlucoseUnit, BloodKetonesUnit, Languages, UserSettings, } from "@hedia/types";
 import moment from "moment";
-import { ACTIVITY_BUFFER_MINUTES, ACTIVITY_DURATION_MINUTES_LIMITS, ACTIVITY_SETTINGS_INTERVAL_LIMITS, ACTIVITY_TARGET_BGL_MMOL_LIMITS, BOLUS_SECONDS_PASSED_LIMITS, CARBOHYDRATES_LIMTS, CURRENT_BGL_MMOL_LIMITS, CURRENT_BKL_MMOL_LIMITS, FORECASTED_CGM_VERY_LOW_LIMIT_MMOLL, INSULIN_DOSE_LIMITS, INSULIN_SENSITIVITY_MMOL_LIMITS, INSULIN_TO_CARBS_RATIO_LIMITS, ONE_HOUR_MINUTES, REMINDER_HOURS_LIMITS, TARGET_BGL_MMOL_LIMITS, } from "./Constants";
-import { ActivityDateError, ActivityDurationError, ActivityIntensityError, ActivitySettingsError, ActivityTargetBGLError, ActivityTypeError, BloodGlucoseUnitError, BloodKetonePropsError, BloodKetoneUnitError, BolusInsulinDoseError, BolusInsulinSecondsPassedError, CarbohydrateLimitError, CurrentBGLError, CurrentBKLError, ForecastedGlucoseIsVeryLowError, InjectionMethodError, InsulinSensitivityError, InsulinToCarbsRatioError, LanguageError, LatestLogbook6HoursBGLError, RecentBolusError, TargetBGLError, UserReminderError, } from "./RecommendationError";
+import { ACTIVITY_BUFFER_MINUTES, ACTIVITY_DURATION_MINUTES_LIMITS, ACTIVITY_SETTINGS_INTERVAL_LIMITS, ACTIVITY_TARGET_BGL_MMOL_LIMITS, BOLUS_SECONDS_PASSED_LIMITS, CARBOHYDRATES_LIMTS, CGM_LIMITS, CURRENT_BGL_MMOL_LIMITS, CURRENT_BKL_MMOL_LIMITS, FORECAST_LIMITS, INSULIN_DOSE_LIMITS, INSULIN_SENSITIVITY_MMOL_LIMITS, INSULIN_TO_CARBS_RATIO_LIMITS, ONE_HOUR_MINUTES, REMINDER_HOURS_LIMITS, TARGET_BGL_MMOL_LIMITS, } from "./Constants";
+import { ActivityDateError, ActivityDurationError, ActivityIntensityError, ActivitySettingsError, ActivityTargetBGLError, ActivityTypeError, BloodGlucoseUnitError, BloodKetonePropsError, BloodKetoneUnitError, BolusInsulinDoseError, BolusInsulinSecondsPassedError, CarbohydrateLimitError, CGMOutsideRangeError, CurrentBGLError, CurrentBKLError, ForecastOutsideRangeError, InjectionMethodError, InsulinSensitivityError, InsulinToCarbsRatioError, LanguageError, LatestLogbook6HoursBGLError, RecentBolusError, TargetBGLError, UserReminderError, } from "./RecommendationError";
 import { Utils } from "./Utils";
 const { hard } = Activity.Enums.ActivityIntensity;
 const { fromFortysix } = Activity.Enums.ActivityReductionIntervals;
@@ -42,7 +42,8 @@ export function validateParams(props) {
     if (props?.calculatorParams?.activity && props?.activityDisplayProps) {
         checkActivityType(props.activityDisplayProps.activityType);
     }
-    checkVeryLowForecastedGlucose(props.forecast);
+    checkForecast(props.forecast);
+    checkCGM(props.cgm);
 }
 /**
  * In case the users is providing a blood ketone current level, check if the blood ketone unit is defined.
@@ -408,17 +409,32 @@ export function checkCarbohydrates(carbohydrates) {
         throw CarbohydrateLimitError();
     }
 }
+/**
+ * Check if the cgm reading value is in range.
+ *
+ * Steps:
+ * 1. Check if cgm reading value is in range. If it isn’t then throw a CGMOutsideRangeError().
+ * @param cgm The cgm data, that includes `latestCGMReadingMmoll` and `cgmTimestamp`
+ *
+ */
+export function checkCGM(cgm) {
+    if (cgm?.latestCGMReadingMmoll) {
+        if (!Utils.isInRange(cgm.latestCGMReadingMmoll, CGM_LIMITS)) {
+            throw CGMOutsideRangeError();
+        }
+    }
+}
 /**
  * Check if the forecasted glucose is not very low.
  *
  * Steps:
- * 1. Check if forecasted glucose is above very low limit. If it isn’t then throw a ForecastedGlucoseIsVeryLowError().
+ * 1. Check if forecasted glucose value is in range. If it isn’t then throw a ForecastOutsideRangeError().
  * @param forecast The forecast data, that includes `forecastGlucoseMmoll` and `forecastTimestamp`
  */
-export function checkVeryLowForecastedGlucose(forecast) {
+export function checkForecast(forecast) {
     if (forecast?.forecastGlucoseMmoll) {
-        if (forecast.forecastGlucoseMmoll < FORECASTED_CGM_VERY_LOW_LIMIT_MMOLL) {
-            throw ForecastedGlucoseIsVeryLowError();
+        if (!Utils.isInRange(forecast.forecastGlucoseMmoll, FORECAST_LIMITS)) {
+            throw ForecastOutsideRangeError();
         }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hedia/recommendation-screen",
-  "version": "2.2.0-alpha.30",
+  "version": "2.2.0-alpha.32",
   "description": "Hedia Recommendation Screen for Bolus and Carbohydrates",
   "main": "dist/index.js",
   "files": [