@hedia/recommendation-screen 2.1.15 → 2.1.16

package/src/components/activity/ActivityIntensity.js

@@ -3,9 +3,16 @@ import React from "react";
 import { Dimensions, StyleSheet, Text, View } from "react-native";
 import { ActivityIntensityTranslations } from "../../utils/Translations";
 import { infoStyles } from "../InfoBars";
+/** Component used to display the users's physical activity intensity on its corresponding background color */
 export default class ActivityIntensity extends React.Component {
     constructor() {
         super(...arguments);
+        /**
+         * Steps:
+         * 1. Set intensity to the activityIntensity prop.
+         * 2. Set the style variable to the style that correspond to the intensity.
+         * @returns JSX element that displays the intensity of the user’s activity along with the associated color coding
+         */
         this.render = () => {
             const intensity = this.props.activityIntensity;
             const style = activityIntensityStyles[intensity];

package/src/components/mood/Emotion.d.ts

@@ -1,13 +1,38 @@
 import { Logbook } from "@hedia/types";
 import React from "react";
 declare const MoodEnum: typeof Logbook.Enums.MoodEnum;
-interface IProps {
+export interface IProps {
+    /** Indicates which mood if any that is currently selected. */
     currentMood: Logbook.Enums.MoodEnum | null;
+    /**
+     * Callback function to call when the selected icon changes. Takes a single optional argument, mood, which is a {@link Logbook.Enums.MoodEnum} | null.
+     * Doesn’t have a return value.
+     * */
     moodSelected(mood: Logbook.Enums.MoodEnum | null): void;
 }
+/** The Emotion component displays a horizontally arranged set of icons representing various moods and allows the user to select one. */
 export default class Emotion extends React.Component<IProps> {
+    /**
+     * Handle what should happen when the user picks taps on one of the mood icons.
+     *
+     * Steps:
+     * 1. Call the moodSelected prop callback function with selected as argument if toggle is true and null as argument otherwise.
+     * @param selected Integer number that represents the icon that was tapped.
+     * @param toggle Boolean indicating whether the icon should be deselected.
+     */
     handleIconPress: (selected: Logbook.Enums.MoodEnum, toggle: boolean) => void;
+    /**
+     * Compose a sequence of MoodIcons
+     *
+     * Steps:
+     * 1. Make a sequence of MoodEnum values from the properties of the MoodEnum object and save the sequence as a variable named values.
+     * 2. Map each of the elements of the values sequence to a MoodIcon.
+     * @returns JSX Element consisting of an array of MoodIcon components.
+     */
     mappedMoods: () => Array<JSX.Element>;
+    /**
+     * @returns JSX element to display the mood icons from mappedMoods() in a horizontal arrangement.
+     */
     render(): JSX.Element;
 }
 export {};

package/src/components/mood/Emotion.js

@@ -5,12 +5,29 @@ import { Dimensions, StyleSheet, Text, View } from "react-native";
 import { i18n } from "../../locale/i18nUtils";
 import MoodIcon from "./MoodIcon";
 const MoodEnum = Logbook.Enums.MoodEnum;
+/** The Emotion component displays a horizontally arranged set of icons representing various moods and allows the user to select one. */
 export default class Emotion extends React.Component {
     constructor() {
         super(...arguments);
+        /**
+         * Handle what should happen when the user picks taps on one of the mood icons.
+         *
+         * Steps:
+         * 1. Call the moodSelected prop callback function with selected as argument if toggle is true and null as argument otherwise.
+         * @param selected Integer number that represents the icon that was tapped.
+         * @param toggle Boolean indicating whether the icon should be deselected.
+         */
         this.handleIconPress = (selected, toggle) => {
             this.props.moodSelected(toggle ? selected : null);
         };
+        /**
+         * Compose a sequence of MoodIcons
+         *
+         * Steps:
+         * 1. Make a sequence of MoodEnum values from the properties of the MoodEnum object and save the sequence as a variable named values.
+         * 2. Map each of the elements of the values sequence to a MoodIcon.
+         * @returns JSX Element consisting of an array of MoodIcon components.
+         */
         this.mappedMoods = () => {
             const values = Object.values(MoodEnum).filter((val) => isNaN(Number(val)));
             return values.map((key) => {
@@ -19,6 +36,9 @@ export default class Emotion extends React.Component {
             });
         };
     }
+    /**
+     * @returns JSX element to display the mood icons from mappedMoods() in a horizontal arrangement.
+     */
     render() {
         return (<View style={emotionStyles.container}>
 				<View style={emotionStyles.feelingContainer}>

package/src/components/mood/MoodIcon.d.ts

@@ -1,14 +1,40 @@
 import { Logbook } from "@hedia/types";
 import React from "react";
 import { ImageURISource } from "react-native";
-interface IProps {
+export interface IProps {
+    /** Which mood the mood component should represent. */
     mood: Logbook.Enums.MoodEnum;
+    /** Boolean indicating whether the mood component represents the currently active mood. */
     active: boolean;
+    /**
+     * Callback function to be called when the mood icon is pressed.
+     * The function has no return value.
+     * @param toggle  Boolean value to indicate whether the icon should be turned on (if true) or off (if false).
+     */
     onPress(toggle: boolean): void;
 }
+/** Mapping from {@link Logbook.Enums.MoodEnum} to corresponding image resources */
+export declare const MOODS_INACTIVE: Record<number, ImageURISource>;
+/** Mapping from {@link Logbook.Enums.MoodEnum} to corresponding image resources */
+export declare const MOODS_ACTIVE: Record<number, ImageURISource>;
+/** Component to display a mood icon base on its props. */
 export default class MoodIcon extends React.Component<IProps> {
+    /**
+     * Get the icon image resource that should be displayed for the mood icon.
+     *
+     * Steps:
+     * 1. If the active prop is true, return the value from the MOODS_ACTIVE constant that corresponds to the value of the mood prop.
+     * 2. (Only reached if the active prop is false) Return the value from the MOODS_INACTIVE constant that corresponds to the value of the mood prop.
+     * @returns Image resource that should be displayed for the mood icon.
+     */
     getMoodIcon: () => ImageURISource;
+    /**
+     * Handle what happens when the mood icon is pressed.
+     *
+     * Steps:
+     * 1. Call the onPress prop callback function with the toggle argument set to the inverse value of the active prop.
+     */
     handleOnPress: () => void;
+    /** JSX element to display the mood icon retrieved using the getMoodIcon() method. */
     render(): JSX.Element;
 }
-export {};

package/src/components/mood/MoodIcon.js

@@ -2,33 +2,51 @@ import { Logbook } from "@hedia/types";
 import React from "react";
 import { Dimensions, Image, StyleSheet, TouchableOpacity } from "react-native";
 const MoodEnum = Logbook.Enums.MoodEnum;
-const MOODS_INACTIVE = {
+/** Mapping from {@link Logbook.Enums.MoodEnum} to corresponding image resources */
+export const MOODS_INACTIVE = {
     1: require(`../../assets/mood/sad.png`),
     2: require(`../../assets/mood/semi_sad.png`),
     3: require(`../../assets/mood/neutral.png`),
     4: require(`../../assets/mood/semi_happy.png`),
     5: require(`../../assets/mood/happy.png`),
 };
-const MOODS_ACTIVE = {
+/** Mapping from {@link Logbook.Enums.MoodEnum} to corresponding image resources */
+export const MOODS_ACTIVE = {
     1: require(`../../assets/mood/sad_active.png`),
     2: require(`../../assets/mood/semi_sad_active.png`),
     3: require(`../../assets/mood/neutral_active.png`),
     4: require(`../../assets/mood/semi_happy_active.png`),
     5: require(`../../assets/mood/happy_active.png`),
 };
+/** Component to display a mood icon base on its props. */
 export default class MoodIcon extends React.Component {
     constructor() {
         super(...arguments);
+        /**
+         * Get the icon image resource that should be displayed for the mood icon.
+         *
+         * Steps:
+         * 1. If the active prop is true, return the value from the MOODS_ACTIVE constant that corresponds to the value of the mood prop.
+         * 2. (Only reached if the active prop is false) Return the value from the MOODS_INACTIVE constant that corresponds to the value of the mood prop.
+         * @returns Image resource that should be displayed for the mood icon.
+         */
         this.getMoodIcon = () => {
             if (this.props.active) {
                 return MOODS_ACTIVE[this.props.mood];
             }
             return MOODS_INACTIVE[this.props.mood];
         };
+        /**
+         * Handle what happens when the mood icon is pressed.
+         *
+         * Steps:
+         * 1. Call the onPress prop callback function with the toggle argument set to the inverse value of the active prop.
+         */
         this.handleOnPress = () => {
             this.props.onPress(!this.props.active);
         };
     }
+    /** JSX element to display the mood icon retrieved using the getMoodIcon() method. */
     render() {
         const { mood, active } = this.props;
         const label = `${MoodEnum[mood]}_${active}`;

package/src/locale/i18nUtils.d.ts

@@ -1,5 +1,18 @@
 import { Languages } from "@hedia/types";
 import { I18n } from "@lingui/core";
 import "moment/min/locales";
+/** Internalisation object containing the translations. Call changeLanguage in order to change the language. */
 export declare const i18n: I18n;
+/**
+ * Change the language that is used to display text on the recommendation screen.
+ *
+ * Steps:
+ * 1. If the given language is in the language catalog:
+ * 	- Call the i18n package’s activate function with language as argument.
+ * 2. Else:
+ * 	- Call the i18n activate function with "English" as argument.
+ * 3. Return the i18n object.
+ * @param language The language to switch to.
+ * @returns Object that represents a i18n configuration for the given language.
+ */
 export declare function changeLanguage(language: Languages): I18n;

package/src/locale/i18nUtils.js

@@ -11,10 +11,23 @@ const languageMap = {
     [Languages.fr]: require(`./fr/messages.js`),
     [Languages.it]: require(`./it/messages.js`),
 };
+/** Internalisation object containing the translations. Call changeLanguage in order to change the language. */
 export const i18n = setupI18n({
     language: Languages.en,
     catalogs: languageMap,
 });
+/**
+ * Change the language that is used to display text on the recommendation screen.
+ *
+ * Steps:
+ * 1. If the given language is in the language catalog:
+ * 	- Call the i18n package’s activate function with language as argument.
+ * 2. Else:
+ * 	- Call the i18n activate function with "English" as argument.
+ * 3. Return the i18n object.
+ * @param language The language to switch to.
+ * @returns Object that represents a i18n configuration for the given language.
+ */
 export function changeLanguage(language) {
     languageMap[language] ? i18n.activate(language) : i18n.activate(Languages.en);
     // Temporary way of setting the moment locale to en-gb since we currently identify GB English with "en".

package/src/types/enum.d.ts

@@ -1,4 +1,6 @@
+/** Namespace containing data required by component testing */
 export declare namespace Testing {
+    /** Namespace containing data about the testing ids for certain components in order to test their expected behaviour */
     namespace Id {
         enum RecommendationScreenTestIds {
             RecommendationScrollView = "recommendation-screen-scroll-view"
@@ -46,6 +48,7 @@ export declare namespace Testing {
             FirstOption = "first-option-button",
             SecondOption = "second-option-button"
         }
+        /** Namespace containing ids for the InfoBars component value, lavel and unit fields */
         namespace InfoBarTestIds {
             enum Value {
                 BloodGlucose = "BloodGlucoseValue",
@@ -64,10 +67,15 @@ export declare namespace Testing {
             }
         }
     }
+    /** Namespace containing all the TestIdEnum keys */
     namespace Types {
         type TestIdEnum = Id.ActivityTestIds | Id.HeaderTestIds | Id.LimitationMessageTestIds | Id.RecentInsulinTestIds | Id.RecommendedCarbsTestIds | Id.RecommendedInsulinTestIds | Id.RecommendationModalTestIds | Id.RemeasureTestIds | Id.TransferToLogbookTestIds | Id.TwoOptionModalTestIds | Id.InfoBarTestIds.Unit | Id.InfoBarTestIds.Value | Id.InfoBarTestIds.Label;
     }
 }
+/**
+ * Indicator of which error has happened.
+ * See the corresponding RecommendationError {@link RecommendationError} for details.
+ */
 export declare enum RecommendationErrorEnum {
     ActivityDuration = 0,
     ActivityTargetBGL = 1,
@@ -92,6 +100,7 @@ export declare enum RecommendationErrorEnum {
     BloodGlucoseUnit = 20,
     BloodKetoneProps = 21
 }
+/** Indicates the category of the user’s blood glucose level. */
 export declare enum BgLevel {
     SevereHypoglycemia = 0,
     Hypoglycemia = 1,
@@ -104,6 +113,7 @@ export declare enum BgLevel {
     UnsupportedBGLevel = 8,
     BGLevelNotProvided = 9
 }
+/** The possible initial recommendation times with values in hours. */
 export declare enum RecommendationReminders {
     ReminderOff = 0,
     Reminder15Minutes = 0.25,

package/src/types/enum.js

@@ -1,5 +1,7 @@
+/** Namespace containing data required by component testing */
 export var Testing;
 (function (Testing) {
+    /** Namespace containing data about the testing ids for certain components in order to test their expected behaviour */
     let Id;
     (function (Id) {
         let RecommendationScreenTestIds;
@@ -59,6 +61,7 @@ export var Testing;
             TwoOptionModalTestIds["FirstOption"] = "first-option-button";
             TwoOptionModalTestIds["SecondOption"] = "second-option-button";
         })(TwoOptionModalTestIds = Id.TwoOptionModalTestIds || (Id.TwoOptionModalTestIds = {}));
+        /** Namespace containing ids for the InfoBars component value, lavel and unit fields */
         let InfoBarTestIds;
         (function (InfoBarTestIds) {
             let Value;
@@ -82,6 +85,10 @@ export var Testing;
         })(InfoBarTestIds = Id.InfoBarTestIds || (Id.InfoBarTestIds = {}));
     })(Id = Testing.Id || (Testing.Id = {}));
 })(Testing || (Testing = {}));
+/**
+ * Indicator of which error has happened.
+ * See the corresponding RecommendationError {@link RecommendationError} for details.
+ */
 export var RecommendationErrorEnum;
 (function (RecommendationErrorEnum) {
     RecommendationErrorEnum[RecommendationErrorEnum["ActivityDuration"] = 0] = "ActivityDuration";
@@ -107,6 +114,7 @@ export var RecommendationErrorEnum;
     RecommendationErrorEnum[RecommendationErrorEnum["BloodGlucoseUnit"] = 20] = "BloodGlucoseUnit";
     RecommendationErrorEnum[RecommendationErrorEnum["BloodKetoneProps"] = 21] = "BloodKetoneProps";
 })(RecommendationErrorEnum || (RecommendationErrorEnum = {}));
+/** Indicates the category of the user’s blood glucose level. */
 export var BgLevel;
 (function (BgLevel) {
     BgLevel[BgLevel["SevereHypoglycemia"] = 0] = "SevereHypoglycemia";
@@ -120,6 +128,7 @@ export var BgLevel;
     BgLevel[BgLevel["UnsupportedBGLevel"] = 8] = "UnsupportedBGLevel";
     BgLevel[BgLevel["BGLevelNotProvided"] = 9] = "BGLevelNotProvided";
 })(BgLevel || (BgLevel = {}));
+/** The possible initial recommendation times with values in hours. */
 export var RecommendationReminders;
 (function (RecommendationReminders) {
     RecommendationReminders[RecommendationReminders["ReminderOff"] = 0] = "ReminderOff";

package/src/types/types.d.ts

@@ -1,15 +1,17 @@
-import { Activity, BolusCalculator, Logbook } from "@hedia/types";
+import { Activity } from "@hedia/types";
+/** Interface used to describe a numerical interval. It is assumed that min < max. */
 export interface IInterval {
+    /** The lower bound of the interval. */
     min: number;
+    /** The upper bound of the interval. */
     max: number;
 }
+/**
+ * Represents the properties needed to show the user visual information about the physical activity.
+ */
 export interface IActivityDisplayProps {
+    /** Title of the physical activity */
     activityTitle: string | null;
+    /** Type of the physical activity */
     activityType: Activity.Enums.ActivityEnum | null;
 }
-export declare type IActivityParams = BolusCalculator.Types.IActivityParams;
-export declare type logbookEntry = Logbook.Types.ILogbookEntry;
-export declare type IRecommendationParams = BolusCalculator.Types.IRecommendationParams;
-export declare type ReductionType = Activity.Types.ReductionType;
-export declare type ActivitySettings = Activity.Types.ActivitySettings;
-export declare type IRecentBolus = BolusCalculator.Types.IRecentBolus;

package/src/utils/AttentionMessages.d.ts

@@ -1,31 +1,96 @@
+/** Provides methods for getting variants of attention messages */
 export declare const AttentionMessage: {
+    /**
+     * @return  Concatenation of:
+     * {@link Messages.VeryLowBGL} +
+     * {@link Messages.Reminder15Minutes}
+     */
     SevereHypoglycemia: () => string;
+    /**
+     * @return Concatenation of:
+     * {@link Messages.LowBGL} +
+     * {@link Messages.Reminder15Minutes}
+     */
     Hypoglycemia: () => string;
+    /** @return The value of: {@link Messages.Reminder15Minutes}  */
     MildHypoglycemia: () => string;
+    /** @return  The value of: {@link Messages.PostponePhysicalActivityUnder5MMOL} */
     NormoglycemiaActivityUnder5MMOL: () => string;
+    /**
+     * @return Concatenation of:
+     * {@link Messages.HighBGL} +
+     * {@link Messages.InsulinKetones} +
+     * {@link Messages.Reminder15Minutes} +
+     * {@link Messages.PostponePhysicalActivity}
+     */
     HyperglycemiaActivity: () => string;
+    /**
+     * @return Concatenation of:
+     * {@link Messages.HighBGL} +
+     * {@link Messages.InsulinKetones}
+     */
     SevereHyperglycemia: () => string;
+    /**
+     * @return Concatenation of:
+     * {@link Messages.HighBGL} +
+     * {@link Messages.InsulinKetones} +
+     * {@link Messages.Reminder15Minutes} +
+     * {@link Messages.PostponePhysicalActivity}
+     */
     SevereHyperglycemiaActivity: () => string;
+    /** 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 declare function addPostponeActivityMessageUnder5MMOL(message: string): string;
+/**
+ * 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 declare function getLimitedValue(reduction: number): number;
+/** Provides methods for getting strings for composing attention messages and other important communications to the user. */
 export declare class Messages {
+    /** Inform the user that their BGL is very low and what they should do about it. */
     static VeryLowBGL: () => string;
+    /**  Inform the user that their BGL is very low. */
     static LowBGL: () => string;
+    /** Inform the user that they will be reminded to remeasure their BGL soon. */
     static Reminder15Minutes: () => string;
+    /** Encourages the user to postpone exercise. Specifically when their BGL is high. */
     static PostponePhysicalActivity: () => string;
+    /** Encourages the user to postpone exercise. Specifically when their BGL is low. */
     static PostponePhysicalActivityUnder5MMOL: () => string;
+    /** Inform about high BGL. */
     static HighBGL: () => string;
+    /** Encourage user to measure ketones. */
     static InsulinKetones: () => string;
+    /** Inform the user that their insulin recommendation was limited for safety. */
     static RecommendationWasLimited: () => string;
+    /** Inform the user that their insulin recommendation was limited for safety in combination with an activity. */
     static RecommendationWasLimitedActivity: (activityReduction: number) => string;
+    /** Inform the user that the insulin amount they entered is above HDA’s safety limit. */
     static InsulinInputWasLimited: (activityReduction: number | null) => string;
+    /** Title for the modal that informs the user that their calculation is too old. */
     static TimeoutPrompTitle: () => string;
+    /**
+     * 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.
+     */
     static TimeoutRecommendationNotVisible: () => string;
+    /** Inform the user that their recommendation calculation is too old.  */
     static TimeoutRecommendationVisible: (date: Date) => string;
 }

package/src/utils/AttentionMessages.js

@@ -2,51 +2,115 @@ 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;
-function getLimitedValue(reduction) {
+/**
+ * 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`);

package/src/utils/Constants.d.ts

@@ -1,24 +1,47 @@
 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;