@hedia/recommendation-screen 2.1.15 → 2.1.16

package/coverage/lcov-report/src/components/mood/MoodIcon.tsx.html

@@ -117,7 +117,32 @@
 <a name='L58'></a><a href='#L58'>58</a>
 <a name='L59'></a><a href='#L59'>59</a>
 <a name='L60'></a><a href='#L60'>60</a>
-<a name='L61'></a><a href='#L61'>61</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a>
+<a name='L69'></a><a href='#L69'>69</a>
+<a name='L70'></a><a href='#L70'>70</a>
+<a name='L71'></a><a href='#L71'>71</a>
+<a name='L72'></a><a href='#L72'>72</a>
+<a name='L73'></a><a href='#L73'>73</a>
+<a name='L74'></a><a href='#L74'>74</a>
+<a name='L75'></a><a href='#L75'>75</a>
+<a name='L76'></a><a href='#L76'>76</a>
+<a name='L77'></a><a href='#L77'>77</a>
+<a name='L78'></a><a href='#L78'>78</a>
+<a name='L79'></a><a href='#L79'>79</a>
+<a name='L80'></a><a href='#L80'>80</a>
+<a name='L81'></a><a href='#L81'>81</a>
+<a name='L82'></a><a href='#L82'>82</a>
+<a name='L83'></a><a href='#L83'>83</a>
+<a name='L84'></a><a href='#L84'>84</a>
+<a name='L85'></a><a href='#L85'>85</a>
+<a name='L86'></a><a href='#L86'>86</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -129,6 +154,14 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">3x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -137,6 +170,7 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">3x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -146,6 +180,15 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">350x</span>
 <span class="cline-any cline-yes">730x</span>
 <span class="cline-any cline-yes">19x</span>
@@ -153,11 +196,18 @@
 <span class="cline-any cline-yes">711x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">350x</span>
 <span class="cline-any cline-yes">13x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">730x</span>
 <span class="cline-any cline-yes">730x</span>
 <span class="cline-any cline-yes">730x</span>
@@ -183,13 +233,21 @@ import { Dimensions, Image, ImageURISource, StyleSheet, TouchableOpacity } from
 &nbsp;
 const MoodEnum = Logbook.Enums.MoodEnum;
 &nbsp;
-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;
 }
 &nbsp;
-const MOODS_INACTIVE: Record&lt;number, ImageURISource&gt; = {
+/** Mapping from {@link Logbook.Enums.MoodEnum} to corresponding image resources */
+export const MOODS_INACTIVE: Record&lt;number, ImageURISource&gt; = {
 	1: require(`../../assets/mood/sad.png`),
 	2: require(`../../assets/mood/semi_sad.png`),
 	3: require(`../../assets/mood/neutral.png`),
@@ -197,7 +255,8 @@ const MOODS_INACTIVE: Record&lt;number, ImageURISource&gt; = {
 	5: require(`../../assets/mood/happy.png`),
 };
 &nbsp;
-const MOODS_ACTIVE: Record&lt;number, ImageURISource&gt; = {
+/** Mapping from {@link Logbook.Enums.MoodEnum} to corresponding image resources */
+export const MOODS_ACTIVE: Record&lt;number, ImageURISource&gt; = {
 	1: require(`../../assets/mood/sad_active.png`),
 	2: require(`../../assets/mood/semi_sad_active.png`),
 	3: require(`../../assets/mood/neutral_active.png`),
@@ -205,7 +264,16 @@ const MOODS_ACTIVE: Record&lt;number, ImageURISource&gt; = {
 	5: require(`../../assets/mood/happy_active.png`),
 };
 &nbsp;
+/** Component to display a mood icon base on its props. */
 export default class MoodIcon extends React.Component&lt;IProps&gt; {
+	/**
+	 * 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.
+	 */
 	public getMoodIcon = (): ImageURISource =&gt; {
 		if (this.props.active) {
 			return MOODS_ACTIVE[this.props.mood];
@@ -213,10 +281,17 @@ export default class MoodIcon extends React.Component&lt;IProps&gt; {
 		return MOODS_INACTIVE[this.props.mood];
 	};
 &nbsp;
+	/**
+	 * 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.
+	 */
 	public handleOnPress = (): void =&gt; {
 		this.props.onPress(!this.props.active);
 	};
 &nbsp;
+	/** JSX element to display the mood icon retrieved using the getMoodIcon() method. */
 	public render(): JSX.Element {
 		const { mood, active } = this.props;
 		const label = `${MoodEnum[mood]}_${active}`;
@@ -244,7 +319,7 @@ const moodIconStyles = StyleSheet.create({
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Thu Jul 29 2021 07:55:43 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>

package/coverage/lcov-report/src/components/mood/index.html

@@ -110,7 +110,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Thu Jul 29 2021 07:55:43 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>

package/coverage/lcov-report/src/index.html

@@ -95,7 +95,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Thu Jul 29 2021 07:55:43 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../prettify.js"></script>

package/coverage/lcov-report/src/locale/i18nUtils.ts.html

@@ -86,7 +86,20 @@
 <a name='L27'></a><a href='#L27'>27</a>
 <a name='L28'></a><a href='#L28'>28</a>
 <a name='L29'></a><a href='#L29'>29</a>
-<a name='L30'></a><a href='#L30'>30</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L30'></a><a href='#L30'>30</a>
+<a name='L31'></a><a href='#L31'>31</a>
+<a name='L32'></a><a href='#L32'>32</a>
+<a name='L33'></a><a href='#L33'>33</a>
+<a name='L34'></a><a href='#L34'>34</a>
+<a name='L35'></a><a href='#L35'>35</a>
+<a name='L36'></a><a href='#L36'>36</a>
+<a name='L37'></a><a href='#L37'>37</a>
+<a name='L38'></a><a href='#L38'>38</a>
+<a name='L39'></a><a href='#L39'>39</a>
+<a name='L40'></a><a href='#L40'>40</a>
+<a name='L41'></a><a href='#L41'>41</a>
+<a name='L42'></a><a href='#L42'>42</a>
+<a name='L43'></a><a href='#L43'>43</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -101,12 +114,25 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">15x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">72x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">72x</span>
@@ -130,11 +156,24 @@ const languageMap: Record&lt;Languages, Catalog&gt; = {
 	[Languages.it]: require(`./it/messages.js`),
 };
 &nbsp;
+/** Internalisation object containing the translations. Call changeLanguage in order to change the language. */
 export const i18n = setupI18n({
 	language: Languages.en,
 	catalogs: languageMap,
 });
 &nbsp;
+/**
+ * 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: Languages): I18n {
 	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".
@@ -151,7 +190,7 @@ export function changeLanguage(language: Languages): I18n {
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Thu Jul 29 2021 07:55:43 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../prettify.js"></script>

package/coverage/lcov-report/src/locale/index.html

@@ -95,7 +95,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Thu Jul 29 2021 07:55:43 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../prettify.js"></script>