@hedia/recommendation-screen 2.1.33 → 2.1.34-alpha.0

package/src/utils/AttentionMessages.js

@@ -1,118 +0,0 @@
-import { BolusCalculator } from "@hedia/types";
-import { t } from "@lingui/macro";
-import moment from "moment";
-import { i18n } from "../locale/i18nUtils";
-/** Provides methods for getting variants of attention messages */
-export const AttentionMessage = {
-    /**
-     * @return  Concatenation of:
-     * {@link Messages.VeryLowBGL} +
-     * {@link Messages.Reminder15Minutes}
-     */
-    SevereHypoglycemia: () => `${Messages.VeryLowBGL()}${`\n`}${Messages.Reminder15Minutes()}`,
-    /**
-     * @return Concatenation of:
-     * {@link Messages.LowBGL} +
-     * {@link Messages.Reminder15Minutes}
-     */
-    Hypoglycemia: () => `${Messages.LowBGL()}${`\n`}${Messages.Reminder15Minutes()}`,
-    /** @return The value of: {@link Messages.Reminder15Minutes}  */
-    MildHypoglycemia: () => Messages.Reminder15Minutes(),
-    /** @return  The value of: {@link Messages.PostponePhysicalActivityUnder5MMOL} */
-    NormoglycemiaActivityUnder5MMOL: () => Messages.PostponePhysicalActivityUnder5MMOL(),
-    /**
-     * @return Concatenation of:
-     * {@link Messages.HighBGL} +
-     * {@link Messages.InsulinKetones} +
-     * {@link Messages.Reminder15Minutes} +
-     * {@link Messages.PostponePhysicalActivity}
-     */
-    HyperglycemiaActivity: () => `${Messages.HighBGL()}${`\n`}${Messages.InsulinKetones()}${`\n`}${Messages.Reminder15Minutes()}${`\n`}${Messages.PostponePhysicalActivity()}`,
-    /**
-     * @return Concatenation of:
-     * {@link Messages.HighBGL} +
-     * {@link Messages.InsulinKetones}
-     */
-    SevereHyperglycemia: () => `${Messages.HighBGL()}${`\n`}${Messages.InsulinKetones()}${`\n`}`,
-    /**
-     * @return Concatenation of:
-     * {@link Messages.HighBGL} +
-     * {@link Messages.InsulinKetones} +
-     * {@link Messages.Reminder15Minutes} +
-     * {@link Messages.PostponePhysicalActivity}
-     */
-    SevereHyperglycemiaActivity: () => `${Messages.HighBGL()}${`\n`}${Messages.InsulinKetones()}${`\n`}${Messages.Reminder15Minutes()}${`\n`}${Messages.PostponePhysicalActivity()}`,
-    /** no message provided for this level */
-    BGLevelNotProvided: null,
-    /** no message provided for this level*/
-    Hyperglycemia: null,
-    /** no message provided for this level */
-    MildHyperglycemia: null,
-    /** no message provided for this level */
-    Normoglycemia: null,
-    /** no message provided for this level */
-    NormoglycemiaUnder5MMOL: null,
-    /** no message provided for this level */
-    UnsupportedBGLevel: null,
-};
-/**
- * @param message The message to append the {@link Messages.PostponePhysicalActivityUnder5MMOL} to
- * @returns The initial messaged concatenated with the {@link Messages.PostponePhysicalActivityUnder5MMOL}
- */
-export function addPostponeActivityMessageUnder5MMOL(message) {
-    return `${message}${`\n`}${Messages.PostponePhysicalActivityUnder5MMOL()}`;
-}
-const SAFETY_INSULIN_LIMIT = BolusCalculator.Constants.SAFETY_INSULIN_LIMIT;
-/**
- * Calculate the limited insulin value based on the physical activity reduction value
- * @param reduction The reduction percentage an activity reduce the total insulin intake
- * @returns The limited insulin value.
- */
-export function getLimitedValue(reduction) {
-    return SAFETY_INSULIN_LIMIT - SAFETY_INSULIN_LIMIT * reduction;
-}
-/** Provides methods for getting strings for composing attention messages and other important communications to the user. */
-export class Messages {
-}
-/** Inform the user that their BGL is very low and what they should do about it. */
-Messages.VeryLowBGL = () => i18n._(t `Your blood glucose level is very low. Take glucagon or eat carbohydrates if possible. Seek medical attention.`);
-/**  Inform the user that their BGL is very low. */
-Messages.LowBGL = () => i18n._(t `Your blood glucose level is very low.`);
-/** Inform the user that they will be reminded to remeasure their BGL soon. */
-Messages.Reminder15Minutes = () => i18n._(t `You will be reminded to measure your blood glucose level in 15 min.`);
-/** Encourages the user to postpone exercise. Specifically when their BGL is high. */
-Messages.PostponePhysicalActivity = () => i18n._(t `If it is possible, postpone your planned exercise.`);
-/** Encourages the user to postpone exercise. Specifically when their BGL is low. */
-Messages.PostponePhysicalActivityUnder5MMOL = () => i18n._(t `Consider not to initiate physical activity before your blood glucose level is within the recommended ranges prior to physical activity.`);
-/** Inform about high BGL. */
-Messages.HighBGL = () => i18n._(t `You have a high blood glucose level.`);
-/** Encourage user to measure ketones. */
-Messages.InsulinKetones = () => i18n._(t `You should take rapid-acting insulin and measure ketones.`);
-/** Inform the user that their insulin recommendation was limited for safety. */
-Messages.RecommendationWasLimited = () => i18n._(t `Your recommendation would have been higher than ${SAFETY_INSULIN_LIMIT} units of insulin, but it has been limited for safety reasons.
-			Hedia never recommends more than ${SAFETY_INSULIN_LIMIT} units of insulin per calculation.`);
-/** Inform the user that their insulin recommendation was limited for safety in combination with an activity. */
-Messages.RecommendationWasLimitedActivity = (activityReduction) => i18n._(t `Your recommendation would have been higher than ${getLimitedValue(activityReduction)}
-			units of insulin, but it has been limited for safety reasons.${`\n\n`}
-			Hedia never recommends more than ${SAFETY_INSULIN_LIMIT}
-			units of insulin per calculation, but because of the physical activity
-			you entered it has been further reduced by ${(activityReduction * 100).toFixed(0)}% to
-			${getLimitedValue(activityReduction)}.`);
-/** Inform the user that the insulin amount they entered is above HDA’s safety limit. */
-Messages.InsulinInputWasLimited = (activityReduction) => activityReduction
-    ? i18n._(t `Hedia doesn't support more than ${SAFETY_INSULIN_LIMIT} units of insulin per calculation, but because of the physical activity you entered it has been further reduced by
-			${(activityReduction * 100).toFixed(0)}% to ${getLimitedValue(activityReduction)} units for this calculation.`)
-    : i18n._(t `Hedia does not support more than ${SAFETY_INSULIN_LIMIT} units of insulin per calculation.`);
-/** Title for the modal that informs the user that their calculation is too old. */
-Messages.TimeoutPrompTitle = () => i18n._(t `More than 15 minutes has passed since this calculation was started.`);
-/**
- * Inform the user that their recommendation calculation is too old.
- * Variant to show when they didn’t see the actual insulin recommendation because they didn’t tell whether they injected insulin recently.
- */
-Messages.TimeoutRecommendationNotVisible = () => i18n._(t `Please go through the calculation steps with new measurements to ensure a safe recommendation.`);
-/** Inform the user that their recommendation calculation is too old.  */
-Messages.TimeoutRecommendationVisible = (date) => {
-    const day = moment(date).format(`LL`);
-    const time = moment(date).format(`HH:mm`);
-    return i18n._(t `Recommendation from ${day} at ${time} was not transfered to your logbook.${`\n`}Did you use the recommendation?`);
-};

package/src/utils/Constants.d.ts

@@ -1,47 +0,0 @@
-import { IInterval } from "../types/types";
-/** Reusable color definition. */
-export declare const BACKGROUND_COLOUR_PURPLE = "rgba(27, 31, 72, 1)";
-/** Reusable color definition. */
-export declare const BORDER_COLOUR_GREY = "rgba(74, 91, 134, 1)";
-/** Reusable color definition. */
-export declare const BORDER_COLOUR_TEAL = "rgba(1, 255, 252, 0.8)";
-/** The threshold above which hyperglycemia is considered to be severe in mmol/L */
-export declare const SEVERE_HYPERGLYCEMIA_START_MMOL = 15;
-/** The number of seconds in four hours. */
-export declare const FOUR_HOURS_SECONDS = 14400;
-/** The number of minutes in one hour. */
-export declare const ONE_HOUR_MINUTES = 60;
-/** Extra time before an activity starts or stops. */
-export declare const ACTIVITY_BUFFER_MINUTES = 10;
-/** The lower and upper limits for the amount of carbohydrates in grams. */
-export declare const CARBOHYDRATES_LIMTS: IInterval;
-/** The lower and upper limits for the insulin dose in units. The upper limit is represented by the SAFETY_INSULIN_LIMIT constant while the lower limit is 0. */
-export declare const INSULIN_DOSE_LIMITS: IInterval;
-/** The lower and upper limits for the age of boluses that gets taken into account for calculating insulin on board. */
-export declare const BOLUS_SECONDS_PASSED_LIMITS: IInterval;
-/** The lower and upper limits for the duration of an activity in minutes. */
-export declare const ACTIVITY_DURATION_MINUTES_LIMITS: IInterval;
-/** The lower and upper limits of insulin sensitivity settings. */
-export declare const INSULIN_SENSITIVITY_MMOL_LIMITS: IInterval;
-/** The lower and upper limits of insulin-to-carbs ratio settings. */
-export declare const INSULIN_TO_CARBS_RATIO_LIMITS: IInterval;
-/** The lower and upper limits of the entered blood glucose level value in mmol/L. */
-export declare const CURRENT_BGL_MMOL_LIMITS: IInterval;
-/** The conversion factor to multiply a blood glucose value with to go from mmol/L to mg/dL. */
-export declare const MMOLL_PER_MGDL_BGL: number;
-/** The conversion factor to multiply a blood glucose value with to go from mg/dL to mmol/L. */
-export declare const MGDL_PER_MMOLL_BGL: number;
-/** The lower and upper limits of the entered blood ketones value in mmol/L. */
-export declare const CURRENT_BKL_MMOL_LIMITS: IInterval;
-/** The conversion factor to multiply a blood ketones value with to go from mmol/L to mg/dL. */
-export declare const MMOLL_PER_MGDL_BKL: number;
-/** The conversion factor to multiply a blood ketones value with to go from mg/dL to mmol/L. */
-export declare const MGDL_PER_MMOLL_BKL: number;
-/** The lower and upper limits for a valid BGL target in mmol/L. */
-export declare const TARGET_BGL_MMOL_LIMITS: IInterval;
-/** The lower and upper limits for a valid activity BGL target in mmol/L. */
-export declare const ACTIVITY_TARGET_BGL_MMOL_LIMITS: IInterval;
-/** The lower and upper limits for how long the reminder notification timer may be. */
-export declare const REMINDER_HOURS_LIMITS: IInterval;
-/** The lower and upper limits for activity reduction. */
-export declare const ACTIVITY_SETTINGS_INTERVAL_LIMITS: IInterval;

package/src/utils/Constants.js

@@ -1,47 +0,0 @@
-import { BolusCalculator } from "@hedia/types";
-/** Reusable color definition. */
-export const BACKGROUND_COLOUR_PURPLE = `rgba(27, 31, 72, 1)`;
-/** Reusable color definition. */
-export const BORDER_COLOUR_GREY = `rgba(74, 91, 134, 1)`;
-/** Reusable color definition. */
-export const BORDER_COLOUR_TEAL = `rgba(1, 255, 252, 0.8)`;
-/** The threshold above which hyperglycemia is considered to be severe in mmol/L */
-export const SEVERE_HYPERGLYCEMIA_START_MMOL = 15;
-/** The number of seconds in four hours. */
-export const FOUR_HOURS_SECONDS = 14400;
-/** The number of minutes in one hour. */
-export const ONE_HOUR_MINUTES = 60;
-/** Extra time before an activity starts or stops. */
-export const ACTIVITY_BUFFER_MINUTES = 10;
-/** The lower and upper limits for the amount of carbohydrates in grams. */
-export const CARBOHYDRATES_LIMTS = { min: 0, max: 300 };
-/** The lower and upper limits for the insulin dose in units. The upper limit is represented by the SAFETY_INSULIN_LIMIT constant while the lower limit is 0. */
-export const INSULIN_DOSE_LIMITS = { min: 0, max: BolusCalculator.Constants.SAFETY_INSULIN_LIMIT };
-/** The lower and upper limits for the age of boluses that gets taken into account for calculating insulin on board. */
-export const BOLUS_SECONDS_PASSED_LIMITS = { min: 0, max: FOUR_HOURS_SECONDS };
-/** The lower and upper limits for the duration of an activity in minutes. */
-export const ACTIVITY_DURATION_MINUTES_LIMITS = { min: 1, max: ONE_HOUR_MINUTES };
-/** The lower and upper limits of insulin sensitivity settings. */
-export const INSULIN_SENSITIVITY_MMOL_LIMITS = { min: 0.3, max: 10 };
-/** The lower and upper limits of insulin-to-carbs ratio settings. */
-export const INSULIN_TO_CARBS_RATIO_LIMITS = { min: 1, max: 50 };
-/** The lower and upper limits of the entered blood glucose level value in mmol/L. */
-export const CURRENT_BGL_MMOL_LIMITS = { min: 1.1, max: 33.3 };
-/** The conversion factor to multiply a blood glucose value with to go from mmol/L to mg/dL. */
-export const MMOLL_PER_MGDL_BGL = 0.0555;
-/** The conversion factor to multiply a blood glucose value with to go from mg/dL to mmol/L. */
-export const MGDL_PER_MMOLL_BGL = 1 / MMOLL_PER_MGDL_BGL;
-/** The lower and upper limits of the entered blood ketones value in mmol/L. */
-export const CURRENT_BKL_MMOL_LIMITS = { min: 0, max: 8 };
-/** The conversion factor to multiply a blood ketones value with to go from mmol/L to mg/dL. */
-export const MMOLL_PER_MGDL_BKL = 0.096;
-/** The conversion factor to multiply a blood ketones value with to go from mg/dL to mmol/L. */
-export const MGDL_PER_MMOLL_BKL = 1 / MMOLL_PER_MGDL_BKL;
-/** The lower and upper limits for a valid BGL target in mmol/L. */
-export const TARGET_BGL_MMOL_LIMITS = { min: 5, max: 13.9 };
-/** The lower and upper limits for a valid activity BGL target in mmol/L. */
-export const ACTIVITY_TARGET_BGL_MMOL_LIMITS = { min: 5, max: 13.9 };
-/** The lower and upper limits for how long the reminder notification timer may be. */
-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 };

package/src/utils/RecommendationError.d.ts

@@ -1,56 +0,0 @@
-import { RecommendationErrorEnum } from "../types/enum";
-/**
- * Defines a set of human readable error messages.
- * Each of them is defined as a function that returns the required translatable error message.
- * The app should generally prevent the user from entering invalid values at the time of entry, so in almost all of these cases,
- * the use of any of these errors indicate that something might have gone really wrong, and the user will be prevented
- * from getting a recommendation until the problem is solved.
- */
-export declare class RecommendationError extends Error {
-    readonly type: RecommendationErrorEnum;
-    constructor(message: string, type: RecommendationErrorEnum);
-}
-/** The given activity settings are corrupt. */
-export declare const ActivitySettingsError: () => RecommendationError;
-/** The duration of the given activity is invalid. */
-export declare const ActivityDurationError: () => RecommendationError;
-/** The start date of the given activity is invalid. */
-export declare const ActivityDateError: () => RecommendationError;
-/** The intensity of the given activity is invalid. */
-export declare const ActivityIntensityError: () => RecommendationError;
-/** Type of the given activity is invalid. */
-export declare const ActivityTypeError: () => RecommendationError;
-/** The user’s activity target BGL setting is invalid. */
-export declare const ActivityTargetBGLError: () => RecommendationError;
-/** More than 300 g carbohydrates entered. */
-export declare const CarbohydrateLimitError: () => RecommendationError;
-/** The user’s insulin sensitivity setting is outside of the valid range. */
-export declare const InsulinSensitivityError: () => RecommendationError;
-/** The user’s insulin-to-carbs ratio setting is outside of the valid range. */
-export declare const InsulinToCarbsRatioError: () => RecommendationError;
-/** The entered current blood glucose level is outside of the valid range. */
-export declare const CurrentBGLError: () => RecommendationError;
-/** The blood glucose level of the latest logbook entry from the last 6 hours is outside of the valid range. */
-export declare const LatestLogbook6HoursBGLError: () => RecommendationError;
-/** The entered current blood ketones concentration is outside of the valid range. */
-export declare const CurrentBKLError: () => RecommendationError;
-/** The user’s target BGL setting is outside of the valid range. */
-export declare const TargetBGLError: () => RecommendationError;
-/** At least one of the recent (within the previous 4 hours) logbook entries has an insulin amount that exceeds the safety insulin threshold. */
-export declare const BolusInsulinDoseError: () => RecommendationError;
-/** At least one entry from the list of recent logbook entries is older than 4 hours. */
-export declare const BolusInsulinSecondsPassedError: () => RecommendationError;
-/** The user’s recent boluses entries are not in the allowed format. */
-export declare const RecentBolusError: () => RecommendationError;
-/** The user’s setting for initial reminder time is outside of the valid range. */
-export declare const UserReminderError: () => RecommendationError;
-/** The user’s insulin injection method setting is invalid. */
-export declare const InjectionMethodError: () => RecommendationError;
-/**The user’s language setting is not supported by the bolus calculator or it is in the wrong format */
-export declare const LanguageError: () => RecommendationError;
-/** The user’s blood ketones unit setting is invalid. */
-export declare const BloodKetoneUnitError: () => RecommendationError;
-/** The user’s blood glucose level measuring unit setting is invalid. */
-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;

package/src/utils/RecommendationError.js

@@ -1,62 +0,0 @@
-import { BolusCalculator } from "@hedia/types";
-import { t } from "@lingui/macro";
-import { i18n } from "../locale/i18nUtils";
-import { RecommendationErrorEnum } from "../types/enum";
-const SAFETY_INSULIN_LIMIT = BolusCalculator.Constants.SAFETY_INSULIN_LIMIT;
-/**
- * Defines a set of human readable error messages.
- * Each of them is defined as a function that returns the required translatable error message.
- * The app should generally prevent the user from entering invalid values at the time of entry, so in almost all of these cases,
- * the use of any of these errors indicate that something might have gone really wrong, and the user will be prevented
- * from getting a recommendation until the problem is solved.
- */
-export class RecommendationError extends Error {
-    constructor(message, type) {
-        super(message);
-        this.type = type;
-    }
-}
-/** The given activity settings are corrupt. */
-export const ActivitySettingsError = () => new RecommendationError(i18n._(t `Error. Please verify that your activity settings are set up correctly.`), RecommendationErrorEnum.ActivitySettings);
-/** The duration of the given activity is invalid. */
-export const ActivityDurationError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator only supports activities with a duration of maximum 60 minutes.`), RecommendationErrorEnum.ActivityDuration);
-/** The start date of the given activity is invalid. */
-export const ActivityDateError = () => new RecommendationError(i18n._(t `Hedia Calculator does not support activities that finished more than 4 hours ago.`), RecommendationErrorEnum.ActivityDate);
-/** The intensity of the given activity is invalid. */
-export const ActivityIntensityError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your activity intensity value`), RecommendationErrorEnum.ActivityIntensity);
-/** Type of the given activity is invalid. */
-export const ActivityTypeError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your activity type value`), RecommendationErrorEnum.ActivityType);
-/** The user’s activity target BGL setting is invalid. */
-export const ActivityTargetBGLError = () => new RecommendationError(i18n._(t `Error. Please verify that your activity target blood glucose value is correct.`), RecommendationErrorEnum.ActivityTargetBGL);
-/** More than 300 g carbohydrates entered. */
-export const CarbohydrateLimitError = () => new RecommendationError(i18n._(t `Hedia Calculator does not support insulin recommendations with more than 300 grams of carbohydrates present.`), RecommendationErrorEnum.CarbohydrateLimit);
-/** The user’s insulin sensitivity setting is outside of the valid range. */
-export const InsulinSensitivityError = () => new RecommendationError(i18n._(t `Error. Please verify that your insulin sensitivity value is correct.`), RecommendationErrorEnum.InsulinSensitivity);
-/** The user’s insulin-to-carbs ratio setting is outside of the valid range. */
-export const InsulinToCarbsRatioError = () => new RecommendationError(i18n._(t `Error. Please verify that your insulin to carb ratio value is correct.`), RecommendationErrorEnum.InsulinToCarbsRatio);
-/** The entered current blood glucose level is outside of the valid range. */
-export const CurrentBGLError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your current blood glucose level.`), RecommendationErrorEnum.CurrentBGL);
-/** The blood glucose level of the latest logbook entry from the last 6 hours is outside of the valid range. */
-export const LatestLogbook6HoursBGLError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support the blood glucose level of your latest logbook entry from the last 6 hours.`), RecommendationErrorEnum.LatestLogbook6HoursBGL);
-/** The entered current blood ketones concentration is outside of the valid range. */
-export const CurrentBKLError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your current blood ketone level.`), RecommendationErrorEnum.CurrentBKL);
-/** The user’s target BGL setting is outside of the valid range. */
-export const TargetBGLError = () => new RecommendationError(i18n._(t `Error. Please verify that your target blood glucose value is correct.`), RecommendationErrorEnum.TargetBGL);
-/** At least one of the recent (within the previous 4 hours) logbook entries has an insulin amount that exceeds the safety insulin threshold. */
-export const BolusInsulinDoseError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support an insulin dose greater than ${SAFETY_INSULIN_LIMIT} units`), RecommendationErrorEnum.BolusInsulinDose);
-/** At least one entry from the list of recent logbook entries is older than 4 hours. */
-export const BolusInsulinSecondsPassedError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support insulin recommendations with boluses older than 4 hours`), RecommendationErrorEnum.BolusInsulinSecondsPassed);
-/** The user’s recent boluses entries are not in the allowed format. */
-export const RecentBolusError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator could not find your recent boluses`), RecommendationErrorEnum.RecentBolus);
-/** The user’s setting for initial reminder time is outside of the valid range. */
-export const UserReminderError = () => new RecommendationError(i18n._(t `Error. Please verify your notifications settings.`), RecommendationErrorEnum.UserReminder);
-/** The user’s insulin injection method setting is invalid. */
-export const InjectionMethodError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your injection method.`), RecommendationErrorEnum.InjectionMethod);
-/**The user’s language setting is not supported by the bolus calculator or it is in the wrong format */
-export const LanguageError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your current language.`), RecommendationErrorEnum.Language);
-/** The user’s blood ketones unit setting is invalid. */
-export const BloodKetoneUnitError = () => new RecommendationError(i18n._(t `Error. Hedia Calculator does not support your current blood ketone unit.`), RecommendationErrorEnum.BloodKetoneUnit);
-/** The user’s blood glucose level measuring unit setting is invalid. */
-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);

package/src/utils/RecommendationUtils.d.ts

@@ -1,100 +0,0 @@
-/**
- * Helper functions for processing and categorising user inputs for determining which warnings and messages to display.
- * @module
- */
-import { BolusCalculator, Logbook } from "@hedia/types";
-import { BgLevel } from "../types/enum";
-/**
- * Determine the category of the blood glucose level based on the numerical value of the BGL itself and potentially the most recent previously entered BGL.
- *
- * Steps:
- * 1. If currentBGL is null return BgLevel.BGLevelNotProvided.
- * 2. If currentBGL is in the interval [1.1; 2] return BgLevel.SevereHypoglycemia.
- * 3. If currentBGL is in the interval ]2; 3.5] return BgLevel.Hypoglycemia.
- * 4. If currentBGL is in the interval ]3.5; 4] return BgLevel.MildHypoglycemia.
- * 5. If currentBGL is in the interval ]4; 5[ return BgLevel.NormoglycemiaUnder5MMOL.
- * 6. If currentBGL is in the interval [5; 7] return BgLevel.Normoglycemia.
- * 7. If currentBGL is in the interval ]7; 15[ return BgLevel.MildHyperglycemia.
- * 8. If currentBGL is in the interval ]15; 33.3] and calling isSevereHyperglycemia() with latestLogbookFrom6Hours returns true then return BgLevel.SevereHyperglycemia.
- * 9. If currentBGL is in the interval [15; 33.3] return BgLevel.Hyperglycemia.
- * @param currentBGL The blood glucose level entered by the user or null if they didn’t enter it.
- * @param latestLogbookFrom6Hours The latest saved logbook entry if one was logged within the last 6 hours. Otherwise null.
- * @returns Indication of the category that the blood glucose level belongs to {@link BgLevel}.
- */
-export declare function getBGLevel(currentBGL: number | null, latestLogbookFrom6Hours: Logbook.Types.ILogbookEntry | null): BgLevel;
-/**
- * Calculate the initial value for the calibration reminder time slider.
- *
- * Steps:
- * 1. Set reminder to be the user’s preferred reminder time if it is defined or to the default reminder time of 1.5 (hours) otherwise.
- * 2. Use a switch statement on {@link BgLevel} to determine the appropriate reminder value to return:
- * 	- If it is SevereHypoglycemia, Hypoglycemia, or MildHypoglycemia then return Reminder15Minutes.
- * 	- If it is NormoglycemiaUnder5MMOL, Normoglycemia, MildHyperglycemia, or BGLevelNotProvided then return the value of reminder
- *    if the user entered carbohydrates or an activity, or ReminderOff otherwise.
- * 	- If it is Hyperglycemia, or SevereHyperglycemia then return Reminder15Minutes if isActivityWithin15Minutes() given the activity
- *    is true and return Reminder60Minutes otherwise.
- * 	- If none of the above conditions were triggered, throw a CurrentBGLError().
- * @param bgLevel The severity category that the user’s current BGL belongs to.
- * @param carbohydrates The amount of carbohydrates that the user is ingesting.
- * @param userReminder The user’s preferred initial reminder time interval in hours.
- * @param activity The activity that the user entered.
- * @returns The initial value of the remeasurement reminder timer slider in hours {@link RecommendationReminders}.
- */
-export declare function getReminder(bgLevel: BgLevel, carbohydrates: number, userReminder: number, activity: BolusCalculator.Types.IActivityParams | null): number;
-/**
- * Get the attention message that fits with the user’s entered blood glucose level and activity.
- *
- * Steps:
- * 1. Use at switch statement on bgLevel to determine the appropriate action to take:
- * 	- If it is BGLevelNotProvided, Normoglycemia, or MildHyperglycemia then return null.
- * 	- If it is NormoglycemiaUnder5MMOL then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then return AttentionMessage.NormoglycemiaActivityUnder5MMOL().
- *        Otherwise return null.
- * 	- If it is SevereHypoglycemia, Hypoglycemia, or MildHypoglycemia then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then
- *        return the AttentionMessage that corresponds to the bgLevel and append a message about postponing the activity using addPostponeActivityMessage().
- *        Otherwise return the AttentionMessage that corresponds to the {@link BgLevel} without further modification.
- * 	- If it is Hyperglycemia then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then return AttentionMessage.HyperglycemiaActivity().
- *        Otherwise return null.
- * 	- If it is SevereHyperglycemia then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then return AttentionMessage.SevereHyperglycemiaActivity().
- *        Otherwise return AttentionMessage.SevereHyperglycemia().
- * 	- If none of the above conditions were triggered, throw a CurrentBGLError() {@link RecommendationError}.
- * @param bgLevel  The category of the user’s blood glucose level.
- * @param activity The activity that the user entered
- * @returns The appropriate attention message {@link AttentionMessage} to display to the user or null if there is no message to be displayed.
- */
-export declare function getAttentionMessage(bgLevel: BgLevel, activity: BolusCalculator.Types.IActivityParams | null): string | null;
-/**
- * Determine based on on the previously measured BGL if the hyperglycemia should be categorized as severe.
- *
- * Steps:
- * 1. If the logbook is not null or undefined, return the result of comparing if the blood_glucose_millimolar property of latestLogbookFrom6Hours
- *    is strictly larger than the threshold for severe hyperglycemia (15) {@link Constants}.
- * @param logbook The latest previous logbook entry - if any - from the past 6 hours.
- * @returns True if the BGL from the previous logbook entry is above the threshold for severe hyperglycemia. False otherwise.
- */
-export declare function isSevereHyperglycemia(logbook?: Logbook.Types.ILogbookEntry | null): boolean;
-/**
- * Determine whether an activity is either ongoing or is starting within 15 minutes from now.
- *
- * Steps:
- * 1. Extract the duration from the activity.
- * 2. Check if the start date of the activity was between duration minutes in the past or 15 minutes in the future and return the result.
- * @param activity The activity whose start time should be checked.
- * @returns Indication of whether the activity is ongoing or imminent.
- */
-export declare function isActivityWithin15Minutes(activity: BolusCalculator.Types.IActivityParams | null): boolean;
-/**
- * The appropriate message for informing the user if the insulin recommendation was limited.
- *
- * Steps:
- * 1. Set message to the return value of RecommendationWasLimitedActivity() if activityReduction is truthy or to the return value of RecommendationWasLimited() otherwise.
- * 2. Return message if wasLimited is true or undefined otherwise.
- * @param wasLimited Indicator of whether or not the user’s insulin recommendation was limited.
- * @param activityReduction The fraction by which the insulin recommendation and the safety insulin limit has been reduced due to physical activity.
- * @returns Callable that returns the appropriate message {@link Messages} for informing the user about the limitation.
- * If no limitation message should be displayed to the user then null is returned.
- */
-export declare function getLimitationMessage(wasLimited: boolean, activityReduction: number | null): string | null;

package/src/utils/RecommendationUtils.js

@@ -1,199 +0,0 @@
-/**
- * Helper functions for processing and categorising user inputs for determining which warnings and messages to display.
- * @module
- */
-import moment from "moment";
-import { BgLevel, RecommendationReminders } from "../types/enum";
-import { addPostponeActivityMessageUnder5MMOL, AttentionMessage, Messages } from "./AttentionMessages";
-import { SEVERE_HYPERGLYCEMIA_START_MMOL } from "./Constants";
-import { CurrentBGLError } from "./RecommendationError";
-import { Utils } from "./Utils";
-/**
- * Determine the category of the blood glucose level based on the numerical value of the BGL itself and potentially the most recent previously entered BGL.
- *
- * Steps:
- * 1. If currentBGL is null return BgLevel.BGLevelNotProvided.
- * 2. If currentBGL is in the interval [1.1; 2] return BgLevel.SevereHypoglycemia.
- * 3. If currentBGL is in the interval ]2; 3.5] return BgLevel.Hypoglycemia.
- * 4. If currentBGL is in the interval ]3.5; 4] return BgLevel.MildHypoglycemia.
- * 5. If currentBGL is in the interval ]4; 5[ return BgLevel.NormoglycemiaUnder5MMOL.
- * 6. If currentBGL is in the interval [5; 7] return BgLevel.Normoglycemia.
- * 7. If currentBGL is in the interval ]7; 15[ return BgLevel.MildHyperglycemia.
- * 8. If currentBGL is in the interval ]15; 33.3] and calling isSevereHyperglycemia() with latestLogbookFrom6Hours returns true then return BgLevel.SevereHyperglycemia.
- * 9. If currentBGL is in the interval [15; 33.3] return BgLevel.Hyperglycemia.
- * @param currentBGL The blood glucose level entered by the user or null if they didn’t enter it.
- * @param latestLogbookFrom6Hours The latest saved logbook entry if one was logged within the last 6 hours. Otherwise null.
- * @returns Indication of the category that the blood glucose level belongs to {@link BgLevel}.
- */
-export function getBGLevel(currentBGL, latestLogbookFrom6Hours) {
-    if (currentBGL === null) {
-        return BgLevel.BGLevelNotProvided;
-    }
-    if (currentBGL >= 1.1 && currentBGL <= 2) {
-        return BgLevel.SevereHypoglycemia;
-    }
-    if (currentBGL > 2 && currentBGL <= 3.5) {
-        return BgLevel.Hypoglycemia;
-    }
-    if (currentBGL > 3.5 && currentBGL <= 4) {
-        return BgLevel.MildHypoglycemia;
-    }
-    if (currentBGL > 4 && currentBGL < 5) {
-        return BgLevel.NormoglycemiaUnder5MMOL;
-    }
-    if (currentBGL >= 5 && currentBGL <= 7) {
-        return BgLevel.Normoglycemia;
-    }
-    if (currentBGL > 7 && currentBGL < 15) {
-        return BgLevel.MildHyperglycemia;
-    }
-    if (currentBGL > 15 && currentBGL <= 33.3 && latestLogbookFrom6Hours
-        ? isSevereHyperglycemia(latestLogbookFrom6Hours)
-        : false) {
-        return BgLevel.SevereHyperglycemia;
-    }
-    if (currentBGL >= 15 && currentBGL <= 33.3) {
-        return BgLevel.Hyperglycemia;
-    }
-    return BgLevel.UnsupportedBGLevel;
-}
-/**
- * Calculate the initial value for the calibration reminder time slider.
- *
- * Steps:
- * 1. Set reminder to be the user’s preferred reminder time if it is defined or to the default reminder time of 1.5 (hours) otherwise.
- * 2. Use a switch statement on {@link BgLevel} to determine the appropriate reminder value to return:
- * 	- If it is SevereHypoglycemia, Hypoglycemia, or MildHypoglycemia then return Reminder15Minutes.
- * 	- If it is NormoglycemiaUnder5MMOL, Normoglycemia, MildHyperglycemia, or BGLevelNotProvided then return the value of reminder
- *    if the user entered carbohydrates or an activity, or ReminderOff otherwise.
- * 	- If it is Hyperglycemia, or SevereHyperglycemia then return Reminder15Minutes if isActivityWithin15Minutes() given the activity
- *    is true and return Reminder60Minutes otherwise.
- * 	- If none of the above conditions were triggered, throw a CurrentBGLError().
- * @param bgLevel The severity category that the user’s current BGL belongs to.
- * @param carbohydrates The amount of carbohydrates that the user is ingesting.
- * @param userReminder The user’s preferred initial reminder time interval in hours.
- * @param activity The activity that the user entered.
- * @returns The initial value of the remeasurement reminder timer slider in hours {@link RecommendationReminders}.
- */
-export function getReminder(bgLevel, carbohydrates, userReminder, activity) {
-    const reminder = userReminder === undefined ? RecommendationReminders.HediaReminderDefault : userReminder;
-    switch (bgLevel) {
-        case BgLevel.SevereHypoglycemia:
-        case BgLevel.Hypoglycemia:
-        case BgLevel.MildHypoglycemia:
-            return RecommendationReminders.Reminder15Minutes;
-        case BgLevel.NormoglycemiaUnder5MMOL:
-        case BgLevel.Normoglycemia:
-        case BgLevel.MildHyperglycemia:
-        case BgLevel.BGLevelNotProvided:
-            return carbohydrates || activity ? reminder : RecommendationReminders.ReminderOff;
-        case BgLevel.Hyperglycemia:
-        case BgLevel.SevereHyperglycemia:
-            return isActivityWithin15Minutes(activity)
-                ? RecommendationReminders.Reminder15Minutes
-                : RecommendationReminders.Reminder60Minutes;
-        default:
-            throw CurrentBGLError();
-    }
-}
-/**
- * Get the attention message that fits with the user’s entered blood glucose level and activity.
- *
- * Steps:
- * 1. Use at switch statement on bgLevel to determine the appropriate action to take:
- * 	- If it is BGLevelNotProvided, Normoglycemia, or MildHyperglycemia then return null.
- * 	- If it is NormoglycemiaUnder5MMOL then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then return AttentionMessage.NormoglycemiaActivityUnder5MMOL().
- *        Otherwise return null.
- * 	- If it is SevereHypoglycemia, Hypoglycemia, or MildHypoglycemia then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then
- *        return the AttentionMessage that corresponds to the bgLevel and append a message about postponing the activity using addPostponeActivityMessage().
- *        Otherwise return the AttentionMessage that corresponds to the {@link BgLevel} without further modification.
- * 	- If it is Hyperglycemia then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then return AttentionMessage.HyperglycemiaActivity().
- *        Otherwise return null.
- * 	- If it is SevereHyperglycemia then do the following:
- * 		- If an activity is going to start within 15 minuts as determined by isActivityWithin15Minutes() then return AttentionMessage.SevereHyperglycemiaActivity().
- *        Otherwise return AttentionMessage.SevereHyperglycemia().
- * 	- If none of the above conditions were triggered, throw a CurrentBGLError() {@link RecommendationError}.
- * @param bgLevel  The category of the user’s blood glucose level.
- * @param activity The activity that the user entered
- * @returns The appropriate attention message {@link AttentionMessage} to display to the user or null if there is no message to be displayed.
- */
-export function getAttentionMessage(bgLevel, activity) {
-    const key = Utils.getKeyFromValue(BgLevel, bgLevel);
-    const isAttentionMessageNull = AttentionMessage[key] === null;
-    const isWithin15Minutes = isActivityWithin15Minutes(activity);
-    switch (bgLevel) {
-        case BgLevel.BGLevelNotProvided:
-        case BgLevel.Normoglycemia:
-        case BgLevel.MildHyperglycemia:
-            return null;
-        case BgLevel.NormoglycemiaUnder5MMOL:
-            return isWithin15Minutes ? AttentionMessage.NormoglycemiaActivityUnder5MMOL() : null;
-        case BgLevel.SevereHypoglycemia:
-        case BgLevel.Hypoglycemia:
-        case BgLevel.MildHypoglycemia:
-            return isWithin15Minutes && !isAttentionMessageNull
-                ? addPostponeActivityMessageUnder5MMOL(AttentionMessage[key]())
-                : AttentionMessage[key]();
-        case BgLevel.Hyperglycemia:
-            return isWithin15Minutes ? AttentionMessage.HyperglycemiaActivity() : null;
-        case BgLevel.SevereHyperglycemia:
-            return isWithin15Minutes
-                ? AttentionMessage.SevereHyperglycemiaActivity()
-                : AttentionMessage.SevereHyperglycemia();
-        default:
-            throw CurrentBGLError();
-    }
-}
-/**
- * Determine based on on the previously measured BGL if the hyperglycemia should be categorized as severe.
- *
- * Steps:
- * 1. If the logbook is not null or undefined, return the result of comparing if the blood_glucose_millimolar property of latestLogbookFrom6Hours
- *    is strictly larger than the threshold for severe hyperglycemia (15) {@link Constants}.
- * @param logbook The latest previous logbook entry - if any - from the past 6 hours.
- * @returns True if the BGL from the previous logbook entry is above the threshold for severe hyperglycemia. False otherwise.
- */
-export function isSevereHyperglycemia(logbook) {
-    if (logbook !== null && logbook !== undefined) {
-        const { blood_glucose_millimolar } = logbook;
-        if (blood_glucose_millimolar !== null) {
-            return blood_glucose_millimolar > SEVERE_HYPERGLYCEMIA_START_MMOL;
-        }
-    }
-    return false;
-}
-/**
- * Determine whether an activity is either ongoing or is starting within 15 minutes from now.
- *
- * Steps:
- * 1. Extract the duration from the activity.
- * 2. Check if the start date of the activity was between duration minutes in the past or 15 minutes in the future and return the result.
- * @param activity The activity whose start time should be checked.
- * @returns Indication of whether the activity is ongoing or imminent.
- */
-export function isActivityWithin15Minutes(activity) {
-    const minutes = activity?.activityDuration;
-    return moment
-        .utc(activity?.activityDate)
-        .isBetween(moment.utc().subtract(minutes, `minutes`), moment.utc().add(15, `minutes`));
-}
-/**
- * The appropriate message for informing the user if the insulin recommendation was limited.
- *
- * Steps:
- * 1. Set message to the return value of RecommendationWasLimitedActivity() if activityReduction is truthy or to the return value of RecommendationWasLimited() otherwise.
- * 2. Return message if wasLimited is true or undefined otherwise.
- * @param wasLimited Indicator of whether or not the user’s insulin recommendation was limited.
- * @param activityReduction The fraction by which the insulin recommendation and the safety insulin limit has been reduced due to physical activity.
- * @returns Callable that returns the appropriate message {@link Messages} for informing the user about the limitation.
- * If no limitation message should be displayed to the user then null is returned.
- */
-export function getLimitationMessage(wasLimited, activityReduction) {
-    const message = activityReduction
-        ? Messages.RecommendationWasLimitedActivity(activityReduction)
-        : Messages.RecommendationWasLimited();
-    return wasLimited ? message : null;
-}