@hedia/recommendation-screen 2.2.0-alpha.45 → 2.2.0-alpha.6

package/dist/index.js

@@ -3,4 +3,3 @@ import * as Errors from "./src/utils/RecommendationError";
 export default RecommendationScreen;
 export { Errors };
 export * from "./src/types/enum";
-//# sourceMappingURL=index.js.map

package/dist/src/RecommendationScreen.d.ts

@@ -1,9 +1,8 @@
 import React from "react";
 import { AppStateStatus } from "react-native";
 import { BloodGlucoseUnit, BloodKetonesUnit, BolusCalculator, Languages, Logbook, UserSettings } from "@hedia/types";
-import { ExitModalActions, TimeoutModalActions } from "./types/enum";
-import { IActivityDisplayProps } from "./types/types";
 import { RecommendationError } from "./utils/RecommendationError";
+import { IActivityDisplayProps } from "./types/types";
 /** Represents both a suggestion by HDA and an actual amount of either insulin or carbohydrates. */
 export interface IResult {
     /** The suggested amount (of insulin in units or carbohydrates in grams) */
@@ -15,7 +14,7 @@ export interface IRecommendationProps {
     /** The blood glucose measurement unit that the user prefers. */
     bloodGlucoseUnit: BloodGlucoseUnit;
     /** The user’s preferred language. */
-    language: keyof typeof Languages;
+    language: Languages;
     /** The user’s preferred default reminder time in hours when they enter carbohydrates or an activity. */
     userReminder: number;
     /** The values needed to make an insulin recommendation calculation. */
@@ -30,8 +29,10 @@ export interface IRecommendationProps {
     latestLogbookFrom6Hours: Logbook.Types.ILogbookEntry | null;
     /** 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;
-    /** Should the exit modal be displayed or not */
-    showExitModal: boolean;
+    /** The forecasted glucose value to display. */
+    forecastedGlucose: string | null;
+    /** Forecasted time value to display. */
+    forecastedTime: string;
     /**
      * Callback function taking a single boolean argument and returning nothing.
      * To be called when the user decides on a presented carbohydrate recommendation.
@@ -55,12 +56,6 @@ export interface IRecommendationProps {
      * Should allow the user to enter when they injected insulin and how much.
      */
     onRecentInsulinYes(): void;
-    /**
-     * Callback function without arguments or return values.
-     * To be called if the user taps “No” when asked if they have taken insulin recently, making the recommendation visible.
-     * Or if they have recently taken insulin and the recommendation is visible.
-     */
-    onRecommendationDisplayed(): void;
     /**
      * To be called when the “Transfer to Logbook” button is pressed.
      * @param carbs The suggested and entered amount of carbohydrates.
@@ -75,16 +70,18 @@ export interface IRecommendationProps {
      * To be called in case a serious issue with the validity of input data is detected.
      * @param error The detected error.
      */
-    onError(error: RecommendationError | Error): void;
+    onError(error: RecommendationError): void;
+    /**
+     * Callback function taking a single argument of type boolean.
+     * To be called to hide the bottom navigation bar while displaying modal dialogs.
+     * @param toggle Showing (true) or hiding (false) the bottom navigation bar on the calculation flow screens.
+     */
+    showBolusBar(toggle: boolean): void;
     /**
      * Callback function taking no arguments.
      * To be called if the user chooses to restart the calculation.
      */
     restartCalculation(): void;
-    /**
-     * Callback function taking a single argument of type boolean.
-     */
-    hideExitModal(): void;
 }
 interface IState {
     /** The time in hours in hours until a reminder notification will be sent to the user. If 0 then no notification will be sent. */
@@ -117,14 +114,10 @@ interface IState {
      * The exit modal prompts the user to consider saving the calculation to a logbook entry before closing the recommendation screen.
      */
     showExitModal: boolean;
-    /** Keeps track of action taken in the exit modal. */
-    exitModalAction: ExitModalActions | null;
-    /**  Keeps track of whether or not only the limitation page of the recommendation modal should be visible. */
-    onlyShowLimitationMessage: boolean;
+    /** Keeps track of whether or not a message about insulin limitation should be displayed. */
+    showLimitationMessage: boolean;
     /** Keeps track of whether or not a message about the recommendation being too old should be displayed. */
     showTimeoutModal: boolean;
-    /** Keeps track of action taken in the timout modal. */
-    timeoutModalAction: TimeoutModalActions | null;
 }
 /**
  * The RecommendationScreen is the React component that passes relevant inputs to the recommendation calculation module and presents
@@ -158,6 +151,11 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      * It'll allow us to later remove the subscription.
      */
     private appStateSubscription?;
+    /**
+     * A reference to the eventSubscription that'll be returned by BackHandler.addEventListener().
+     * It'll allow us to later remove the subscription.
+     */
+    private backHandlerSubscription?;
     /**
      * Steps:
      * 1. Call the super() method with the props.
@@ -167,7 +165,6 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      * 	- Set the language by using the language prop as argument for calling changeLanguage()
      * 	- Unpack recentBoluses from the calculatorParams prop.
      * 	- Use the calculatorParams prop as argument for calling calculateRecommendation() and unpack all of the resulting values.
-     * 	- Call the onRecommendationDisplayed() callback prop if the recommendation is visible
      * 	- Copy the carbRecommendation to the suggestedCarbs member variable.
      * 	- Set the following state variables:
      * 		- Set remeasureTime to the return value from calling the getBGLevelRemeasurementReminder() method.
@@ -179,8 +176,7 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      * 		- Set activeInsulin to the estimation returned from the calculation result.
      * 		- Set enteredCarbs, enteredInsulin, selectedMood to null.
      * 		- Set recommendationModal to be true if wasLimited is true or if carbRecommendation after being rounded is truthy or if the return value from calling the getBGLevelAttentionMessage() method is truthy.
-     * 		- Set onlyShowLimitationMessage, showTimeoutModal to be false.
-     *		- Set showExitModal with the value of the showExitModal prop.
+     * 		- Set showExitModal, showLimitationMessage, showTimeoutModal to be false.
      * 3. Start a 15 minute timer assigned to the timer member variable using the setTimeout() function. When the timer expires, call the showTimeoutModal() method.
      * @param props The data required to initialise the Recommendation Screen
      */
@@ -203,14 +199,6 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      * 2. Remove the listener for app state changes that was set by the componentDidMount() method.
      */
     componentWillUnmount(): void;
-    /**
-     * Called immediately after updating occurs. This method is not called for the initial render.
-     * Use this as an opportunity to operate on the DOM when the component has been updated.
-     * Steps:
-     * 1. If the showExitModal prop is true and it was false before, call the onExit() method.
-     * @param showExitModal The previous showExitModal props of the component.
-     */
-    componentDidUpdate({ showExitModal }: IRecommendationProps): void;
     /**
      * Steps:
      * 1. Evaluate a boolean called isOlderThan15Minutes to indicate whether the recommendationDate member variable represents a time more than 15 minutes ago.
@@ -220,7 +208,7 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
     handleAppStateChange: (nextAppState: AppStateStatus) => void;
     /**
      * Steps:
-     * 1. Set the showTimeoutModal state variable to be true.
+     * 1. Set the showTimeoutModal state variable to be true. Use a callback function to call the showBolusBar prop callback function with false as argument when the state has been updated.
      * */
     showTimeoutModal: () => void;
     /**
@@ -242,11 +230,19 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      *
      * Steps:
      * 1. If the insulin recommendation is being displayed (the isRecommendationDisplayed state variable is true):
-     *  	- Set the showExitModal state variable to true.
+     *  	- Set the showExitModal state variable to true. When the state has been updated, call the showBolusBar prop callback function with the inverse value of the showExitModal state variable as argument.
      * 2. Else:
      *  	- Call the exitCallback prop callback function.
      */
     onExit: () => void;
+    /**
+     * Callback to be executed by the back handler listener.
+     *
+     * Steps:
+     * 1. Call the onExist method
+     * 2. Return true so that the default behaviour is overwritten.
+     */
+    onBackHandlerPress: () => boolean;
     /**
      * Hide the modal that shows attention messages.
      *
@@ -255,37 +251,28 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      */
     hideAttentionModal: () => void;
     /**
-     * Handle presses on the transfer button in the exit modal.
-     */
-    onPressTransferExitModal: () => void;
-    /**
-     * Handle presses on the close calculation button in the exit modal.
-     */
-    onPressCloseExitModal: () => void;
-    /**
-     * Handle presses on the hide button in the exit modal.
-     */
-    onPressHideExitModal: () => void;
-    /**
-     * Call the chosen modal action on the didHide modal callback .
-     */
-    onExitModalDidHide: () => void;
-    /**
-     * Handle presses on the close calculation button in the timeout modal.
-     */
-    onPressCloseCalculationTimeoutModal: () => void;
-    /**
-     * Handle presses on the restart calculation button in the timeout modal.
+     * Hide the modal that shows attention messages.
+     *
+     * Steps:
+     * 1. Set the showLimitationMessage state variable to false.
      */
-    onPressRestartCalculationTimeoutModal: () => void;
+    hideLimitationMessage: () => void;
     /**
-     * Handle presses on the transfer button in the timeout modal.
+     * Hide the exit modal. To be used when the user closes the modal directly or in some way exits the recommendation screen.
+     *
+     * Steps:
+     * 1. Set the showExitModal state variable to false.
+     *    When the state has been updated, call the showBolusBar prop callback function with the inverse value of the showExitModal state variable as argument.
      */
-    onPressTransferTimeoutModal: () => void;
+    hideExitModal: () => void;
     /**
-     * Call the chosen modal action on the didHide modal callback .
+     * Hide the modal that warns the user that their recommendation is old.
+     *
+     * Steps:
+     * 1. Set the showTimeoutModal state variable to false.
+     * 	  When the state has been updated, call the showBolusBar prop callback function with the inverse value of the showTimeoutModal state variable as argument.
      */
-    onTimeoutModalDidHide: () => void;
+    hideTimeoutModal: () => void;
     /**
      * Used as a callback function for the Remeasure component to update the state when the remeasure time slider’s value changes.
      *
@@ -301,8 +288,7 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      *
      * Steps:
      * 1. Set the isRecommendationDisplayed state variable to be true.
-     * 2. Call the onRecommendationDisplayed prop callback function.
-     * 3. As a callback to the setState() method, define a new anonymous function that calls setTimeout() with a duration of 0 milliseconds.
+     * 2. As a callback to the setState() method, define a new anonymous function that calls setTimeout() with a duration of 0 milliseconds.
      *    When the time expires, call the scrollToEnd() method of the scrollView member, with the animated argument set to true.
      *    This ensures that the scroll event happens after all other events that get queued to happen at the same time,
      *    so all relevant elements are visible on the screen and the scroll happens reliably.
@@ -344,6 +330,22 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      * 2. Call the carbRecommendationAnswer() prop callback function with true as argument.
      */
     acceptCarbRecommendation: () => void;
+    /**
+     * Handles what happens when the user hits the “close calculation”-button on the exit modal.
+     *
+     * Steps:
+     * 1. If the showExitModal state variable is true then call the hideExitModal() method. Otherwise, call the hideTimeoutModal() method
+     * 2. Call the closeCalculationCallback prop callback function.
+     */
+    closeCalculation: () => void;
+    /**
+     * Close the current recommendation and start a new bolus calculation.
+     *
+     * Steps:
+     * 1. Call the hideTimeoutModal() method.
+     * 2. Call the restartCalculation prop callback function.
+     */
+    restartCalculation: () => void;
     /**
      * Used as a callback function for the Emotion component to update the state when a mood icon is tapped.
      *
@@ -368,7 +370,8 @@ export default class RecommendationScreen extends React.Component<IRecommendatio
      * 1. Unpack the enteredCarbs, enteredInsulin, insulinRecommendation, remeasureTime, and showExitModal state variables
      * 2. Create an IResult object called carbs consisting of suggestedCarbs and enteredCarbs.
      * 3. Create an IResult object called Insulin consisting of insulinRecommendation and enteredInsulin.
-     * 4. Call the transferToLogbook prop callback function with the following arguments:
+     * 4. If showExitModal is true then call the hideExitModal() method. otherwise call the hideTimeoutModal() method.
+     * 5. Call the transferToLogbook prop callback function with the following arguments:
      * 	- Set the carbs argument to the carbs IResult object.
      * 	- Set the insulin argument to the insulin IResult object.
      * 	- Set the reminder argument to the remeasureTime state variable.