@hedia/recommendation-screen 2.2.0-alpha.31 → 2.2.0-alpha.33

package/dist/src/RecommendationScreen.d.ts

@@ -30,9 +30,9 @@ export interface IRecommendationProps {
     /** The properties of the entered activity that are not used for making the calculation itself, but will be used on the recommendation screen. */
     activityDisplayProps: IActivityDisplayProps | null;
     /** Forecast data received from the app */
-    forecast?: Logbook.Types.ILogbookEntry[`forecast_glucose`];
+    forecast: Logbook.Types.ILogbookEntry[`forecast_glucose`];
     /** CGM data received from the app */
-    cgm?: Logbook.Types.ILogbookEntry[`cgm_reading`];
+    cgm: Logbook.Types.ILogbookEntry[`cgm_reading`];
     /**
      * Callback function taking a single boolean argument and returning nothing.
      * To be called when the user decides on a presented carbohydrate recommendation.

package/dist/src/components/ForecastInfoBar.d.ts

@@ -10,7 +10,7 @@ export interface IProps {
     cgm: Logbook.Types.ILogbookEntry[`cgm_reading`];
     /** Unit label to print after the value. */
     unit: BloodGlucoseUnit;
-    /**  optional object that contains as properties a valueID and a unitID */
+    /** optional object that contains as properties a valueID and a unitID */
     testID?: {
         valueID: Testing.Id.InfoBarTestIds.Value;
         unitID: Testing.Id.InfoBarTestIds.Unit;

package/dist/src/components/ForecastInfoBar.js

@@ -46,7 +46,7 @@ const ForecastInfoBar = (props) => {
 						<View style={forecastSubtitle}>
 							<LinearGradient colors={colors.gradientMain} useAngle={true} angle={135} style={forecastDot}/>
 							<TextRegular style={forecastText}>{i18n._(t `Forecast time:`)}</TextRegular>
-							<TextRegular style={forecastTime}>{String(forecast?.forecastTimestamp)}</TextRegular>
+							<TextRegular style={forecastTime}>{`${forecast?.forecastTimestamp}`}</TextRegular>
 						</View>
 					</View>
 

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,3 +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 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,3 +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 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,3 +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’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,3 +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’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,3 +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 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 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, 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, 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,6 +42,12 @@ export function validateParams(props) {
     if (props?.calculatorParams?.activity && props?.activityDisplayProps) {
         checkActivityType(props.activityDisplayProps.activityType);
     }
+    if (props?.forecast) {
+        checkForecast(props.forecast);
+    }
+    if (props?.cgm) {
+        checkCGM(props.cgm);
+    }
 }
 /**
  * In case the users is providing a blood ketone current level, check if the blood ketone unit is defined.
@@ -407,3 +413,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 value is in range. If it isn’t then throw a ForecastOutsideRangeError().
+ * @param forecast The forecast data, that includes `forecastGlucoseMmoll` and `forecastTimestamp`
+ */
+export function checkForecast(forecast) {
+    if (forecast?.forecastGlucoseMmoll) {
+        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.31",
+  "version": "2.2.0-alpha.33",
   "description": "Hedia Recommendation Screen for Bolus and Carbohydrates",
   "main": "dist/index.js",
   "files": [