@hedia/types 2.1.20 → 2.1.22

package/.github/workflows/publish-alpha.yaml

@@ -0,0 +1,24 @@
+name: Publish alpha
+
+on:
+  pull_request:
+    branches:
+      - master
+   
+env:
+  SSH_PRIVATE_KEY: ${{ secrets.HEDIA_BOT_PRIVATE_SSH_KEY }}
+  NPM_TOKEN: ${{ secrets.HEDIA_BOT_NPM_TOKEN }}
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 10
+      - run: npm install
+      - run: npm test
+      - uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ env.NPM_TOKEN }}

package/dist/types/activity/activity.d.ts

@@ -11,8 +11,15 @@ export declare namespace Activity {
             uuidOld?: IActivityEntry["uuid"];
             overwrittenByUUID?: IActivityEntry["uuid"];
         }
+        /** Type that represents the user’s settings related to physical activity. */
         export type ActivitySettings = ActivityReductionSettings & ActivityTarget;
+        /** Represents a set of insulin reduction fraction settings that can vary by the duration of the activity. */
         export type ActivityReductionIntervals = ActivityReductionSettings[keyof ActivityReductionSettings];
+        /**
+         * Represents whether the reduction fraction is a number or it is null.
+         * Only for the settings of hard physical activities over 45 minutes the value is null.
+         * A null value represents that it is not supported by HDA.
+         */
         export type ReductionType = ActivityReductionIntervals[keyof ActivityReductionIntervals];
         type ActivityIntensityKeys = keyof typeof Enums.ActivityIntensity;
         type ActivityReductionKeys = keyof typeof Enums.ActivityReductionIntervals;
@@ -33,16 +40,19 @@ export declare namespace Activity {
         export {};
     }
     namespace Enums {
+        /** Enum that represents a set of insulin reduction fraction settings that can vary by the duration of the activity */
         enum ActivityReductionIntervals {
             fromZero = "fromZero",
             fromThirty = "fromThirty",
             fromFortysix = "fromFortysix"
         }
+        /** Enum used to indicate the category or intensity of a physical activity. */
         enum ActivityIntensity {
             light = "light",
             moderate = "moderate",
             hard = "hard"
         }
+        /** Enum used to indicate the type of physical activity performed by the user. */
         enum ActivityEnum {
             Run = "Run",
             Walk = "Walk",

package/dist/types/activity/activity.js

@@ -5,18 +5,21 @@ var Activity;
 (function (Activity) {
     let Enums;
     (function (Enums) {
+        /** Enum that represents a set of insulin reduction fraction settings that can vary by the duration of the activity */
         let ActivityReductionIntervals;
         (function (ActivityReductionIntervals) {
             ActivityReductionIntervals["fromZero"] = "fromZero";
             ActivityReductionIntervals["fromThirty"] = "fromThirty";
             ActivityReductionIntervals["fromFortysix"] = "fromFortysix";
         })(ActivityReductionIntervals = Enums.ActivityReductionIntervals || (Enums.ActivityReductionIntervals = {}));
+        /** Enum used to indicate the category or intensity of a physical activity. */
         let ActivityIntensity;
         (function (ActivityIntensity) {
             ActivityIntensity["light"] = "light";
             ActivityIntensity["moderate"] = "moderate";
             ActivityIntensity["hard"] = "hard";
         })(ActivityIntensity = Enums.ActivityIntensity || (Enums.ActivityIntensity = {}));
+        /** Enum used to indicate the type of physical activity performed by the user. */
         let ActivityEnum;
         (function (ActivityEnum) {
             ActivityEnum["Run"] = "Run";

package/dist/types/activity/activity.js.map

@@ -1 +1 @@
-{"version":3,"file":"activity.js","sourceRoot":"","sources":["../../../types/activity/activity.ts"],"names":[],"mappings":";;;AAAA,IAAiB,QAAQ,CA+DxB;AA/DD,WAAiB,QAAQ;IA0CxB,IAAiB,KAAK,CAoBrB;IApBD,WAAiB,KAAK;QACrB,IAAY,0BAIX;QAJD,WAAY,0BAA0B;YACrC,mDAAqB,CAAA;YACrB,uDAAyB,CAAA;YACzB,2DAA6B,CAAA;QAC9B,CAAC,EAJW,0BAA0B,GAA1B,gCAA0B,KAA1B,gCAA0B,QAIrC;QAED,IAAY,iBAIX;QAJD,WAAY,iBAAiB;YAC5B,oCAAe,CAAA;YACf,0CAAqB,CAAA;YACrB,kCAAa,CAAA;QACd,CAAC,EAJW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAI5B;QAED,IAAY,YAMX;QAND,WAAY,YAAY;YACvB,2BAAW,CAAA;YACX,6BAAa,CAAA;YACb,mCAAmB,CAAA;YACnB,6BAAa,CAAA;YACb,+BAAe,CAAA;QAChB,CAAC,EANW,YAAY,GAAZ,kBAAY,KAAZ,kBAAY,QAMvB;IACF,CAAC,EApBgB,KAAK,GAAL,cAAK,KAAL,cAAK,QAoBrB;AACF,CAAC,EA/DgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QA+DxB"}
+{"version":3,"file":"activity.js","sourceRoot":"","sources":["../../../types/activity/activity.ts"],"names":[],"mappings":";;;AAAA,IAAiB,QAAQ,CAyExB;AAzED,WAAiB,QAAQ;IAiDxB,IAAiB,KAAK,CAuBrB;IAvBD,WAAiB,KAAK;QACrB,sHAAsH;QACtH,IAAY,0BAIX;QAJD,WAAY,0BAA0B;YACrC,mDAAqB,CAAA;YACrB,uDAAyB,CAAA;YACzB,2DAA6B,CAAA;QAC9B,CAAC,EAJW,0BAA0B,GAA1B,gCAA0B,KAA1B,gCAA0B,QAIrC;QAED,8EAA8E;QAC9E,IAAY,iBAIX;QAJD,WAAY,iBAAiB;YAC5B,oCAAe,CAAA;YACf,0CAAqB,CAAA;YACrB,kCAAa,CAAA;QACd,CAAC,EAJW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAI5B;QAED,iFAAiF;QACjF,IAAY,YAMX;QAND,WAAY,YAAY;YACvB,2BAAW,CAAA;YACX,6BAAa,CAAA;YACb,mCAAmB,CAAA;YACnB,6BAAa,CAAA;YACb,+BAAe,CAAA;QAChB,CAAC,EANW,YAAY,GAAZ,kBAAY,KAAZ,kBAAY,QAMvB;IACF,CAAC,EAvBgB,KAAK,GAAL,cAAK,KAAL,cAAK,QAuBrB;AACF,CAAC,EAzEgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAyExB"}

package/dist/types/boluscalculator/boluscalculator.d.ts

@@ -1,12 +1,17 @@
 import { Activity } from "../activity/activity";
 export declare namespace BolusCalculator {
     namespace Constants {
+        /** The maximum amount of insulin that may be recommended to the user. */
         const SAFETY_INSULIN_LIMIT = 50;
+        /** The maximum duration in minutes of a physical activity. */
         const SAFETY_ACTIVITY_LIMIT = 60;
+        /** The maximum reduction factor for a physical activity */
         const REDUCTION_MAX = 1;
+        /** The minimum reduction factor for a physical activity */
         const REDUCTION_MIN = 0;
     }
     namespace Enums {
+        /** Enum for differentiating between types of errors. */
         enum ActivityErrors {
             OutOfRange = "Out of range",
             InvalidInterval = "Invalid activity settings interval",
@@ -14,30 +19,61 @@ export declare namespace BolusCalculator {
         }
     }
     namespace Types {
+        /** Represents a single bolus of fast-acting insulin that has been administered within the past 4 hours. */
         interface IRecentBolus {
+            /** The number of seconds that has passed since the bolus in question was administered. */
             secondsPassed: number;
+            /** The amount of insulin that was administered with the bolus in question. */
             insulinDose: number;
         }
+        /** Details about a physical activity. */
         interface IActivityParams {
+            /** The duration of the physical activity in minutes. */
             activityDuration: number;
+            /** The intensity of the activity */
             activityIntensity: Activity.Enums.ActivityIntensity;
+            /** The user’s current settings for physical activity */
             activitySettings: Activity.Types.ActivitySettings;
+            /** Start date and time for the activity */
             activityDate: Date;
         }
+        /** IRecommendationParams contains data that is used to calculate a recommendation. */
         interface IRecommendationParams {
+            /** The user’s current blood glucose level in mmol/L */
             currentBGL: number | null;
+            /** The blood glucose level in mmol/L that the user should ideally have at this time of day according to their settings/preferences. */
             targetBGL: number;
+            /** The user’s current insulin sensitivity in (mmol/L)/IU according to their settings/preferences. */
             insulinSensitivity: number;
+            /** The amount of carbohydrates in grams that the user has entered that they are going to eat. */
             carbohydrates: number;
+            /** The user’s current insulin-to-carbs ratio in g/IU according to their settings/preferences. */
             carbohydrateRatio: number;
+            /** A possibly empty array of IRecentBolus objects. */
             recentBoluses: Array<IRecentBolus>;
+            /** Information about the activity that the user is doing including their activity settings */
             activity: IActivityParams | null;
         }
+        /**
+         * The result of a recommendation calculation is returned by the calculateRecommendation() function as an object that implements this interface.
+         * Note that only one of bolus and carbRecommendation may be positive. If one is non-zero then the other must be zero.
+         */
         interface IRecommendationResult {
+            /** The recommended amount of insulin measured in units. */
             bolus: number;
+            /**
+             * Indicates whether or not the insulin recommendation (given in the bolus property) was capped because the underlying recommendation exceeded the safety limit.
+             * If it is true then we know that the recommendation would have been higher and can show and appropriate message to the user.
+             */
             wasLimited: boolean;
+            /** The number of carbs that the user is recommended to eat */
             carbRecommendation: number;
+            /**
+             * Indicates how much the insulin recommendation was reduced due to physical activity.
+             * A value of 0.75 would indicate that the recommended insulin was reduced by 25%.
+             */
             activityReduction: number | null;
+            /** The estimated amount of active insulin (IOB) in IU. */
             activeInsulin: number;
         }
     }

package/dist/types/boluscalculator/boluscalculator.js

@@ -5,13 +5,18 @@ var BolusCalculator;
 (function (BolusCalculator) {
     let Constants;
     (function (Constants) {
+        /** The maximum amount of insulin that may be recommended to the user. */
         Constants.SAFETY_INSULIN_LIMIT = 50;
+        /** The maximum duration in minutes of a physical activity. */
         Constants.SAFETY_ACTIVITY_LIMIT = 60;
+        /** The maximum reduction factor for a physical activity */
         Constants.REDUCTION_MAX = 1;
+        /** The minimum reduction factor for a physical activity */
         Constants.REDUCTION_MIN = 0;
     })(Constants = BolusCalculator.Constants || (BolusCalculator.Constants = {}));
     let Enums;
     (function (Enums) {
+        /** Enum for differentiating between types of errors. */
         let ActivityErrors;
         (function (ActivityErrors) {
             ActivityErrors["OutOfRange"] = "Out of range";

package/dist/types/boluscalculator/boluscalculator.js.map

@@ -1 +1 @@
-{"version":3,"file":"boluscalculator.js","sourceRoot":"","sources":["../../../types/boluscalculator/boluscalculator.ts"],"names":[],"mappings":";;;AAEA,IAAiB,eAAe,CA8C/B;AA9CD,WAAiB,eAAe;IAC/B,IAAiB,SAAS,CAKzB;IALD,WAAiB,SAAS;QACZ,8BAAoB,GAAG,EAAE,CAAC;QAC1B,+BAAqB,GAAG,EAAE,CAAC;QAC3B,uBAAa,GAAG,CAAC,CAAC;QAClB,uBAAa,GAAG,CAAC,CAAC;IAChC,CAAC,EALgB,SAAS,GAAT,yBAAS,KAAT,yBAAS,QAKzB;IAED,IAAiB,KAAK,CAMrB;IAND,WAAiB,KAAK;QACrB,IAAY,cAIX;QAJD,WAAY,cAAc;YACzB,6CAA2B,CAAA;YAC3B,wEAAsD,CAAA;YACtD,iEAA+C,CAAA;QAChD,CAAC,EAJW,cAAc,GAAd,oBAAc,KAAd,oBAAc,QAIzB;IACF,CAAC,EANgB,KAAK,GAAL,qBAAK,KAAL,qBAAK,QAMrB;AAgCF,CAAC,EA9CgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QA8C/B"}
+{"version":3,"file":"boluscalculator.js","sourceRoot":"","sources":["../../../types/boluscalculator/boluscalculator.ts"],"names":[],"mappings":";;;AAEA,IAAiB,eAAe,CAmF/B;AAnFD,WAAiB,eAAe;IAC/B,IAAiB,SAAS,CASzB;IATD,WAAiB,SAAS;QACzB,yEAAyE;QAC5D,8BAAoB,GAAG,EAAE,CAAC;QACvC,8DAA8D;QACjD,+BAAqB,GAAG,EAAE,CAAC;QACxC,2DAA2D;QAC9C,uBAAa,GAAG,CAAC,CAAC;QAC/B,2DAA2D;QAC9C,uBAAa,GAAG,CAAC,CAAC;IAChC,CAAC,EATgB,SAAS,GAAT,yBAAS,KAAT,yBAAS,QASzB;IAED,IAAiB,KAAK,CAOrB;IAPD,WAAiB,KAAK;QACrB,wDAAwD;QACxD,IAAY,cAIX;QAJD,WAAY,cAAc;YACzB,6CAA2B,CAAA;YAC3B,wEAAsD,CAAA;YACtD,iEAA+C,CAAA;QAChD,CAAC,EAJW,cAAc,GAAd,oBAAc,KAAd,oBAAc,QAIzB;IACF,CAAC,EAPgB,KAAK,GAAL,qBAAK,KAAL,qBAAK,QAOrB;AAgEF,CAAC,EAnFgB,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAmF/B"}

package/dist/types/enums.d.ts

@@ -1,14 +1,18 @@
+/** Represents a unit for measuring blood glucose levels. */
 export declare enum BloodGlucoseUnit {
     MMOL_L = "mmol/l",
     MG_DL = "mg/dl"
 }
+/** Represents a unit for measuring blood ketone levels. */
 export declare enum BloodKetonesUnit {
     MMOL_L = "mmol/l",
     MG_DL = "mg/dl"
 }
+/** Represents a unit for measuring insulin intake */
 export declare enum InsulinUnit {
     IU = "IU"
 }
+/** Represents a language that the app can be displayed in. */
 export declare enum Languages {
     da = "Dansk",
     en = "English",
@@ -17,12 +21,14 @@ export declare enum Languages {
     fr = "Fran\u00E7ais",
     it = "Italiano"
 }
+/** Enum containing constants for seconds, minutes, hours, or days in milliseconds */
 export declare enum Milliseconds {
     Second = 1000,
     Minute = 60000,
     Hour = 3600000,
     Day = 86400000
 }
+/** Enum containing the possible ketone levels of the user */
 export declare enum KetoneLevels {
     Negative = 0,
     Normal = 1,
@@ -30,6 +36,11 @@ export declare enum KetoneLevels {
     Moderate = 3,
     High = 4
 }
+/**
+ * Enum containing constants for displaying colour indicators regarding the blood ketone levels of the user.
+ * Blood ketones ranges and the color scheme can be found at:
+ * https://hedia.atlassian.net/wiki/spaces/QMS/pages/827785277/QF-73-3-1+Ketones+and+current+functions+in+HDA#4.0-Ketone-procedure-in-HDA
+ */
 export declare enum KetoneColours {
     None = "rgb(15,18,49)",
     Negative = "rgb(222,194,145)",

package/dist/types/enums.js

@@ -6,20 +6,24 @@ var Units;
     Units["MMOL_L"] = "mmol/l";
     Units["MG_DL"] = "mg/dl";
 })(Units || (Units = {}));
+/** Represents a unit for measuring blood glucose levels. */
 var BloodGlucoseUnit;
 (function (BloodGlucoseUnit) {
     BloodGlucoseUnit["MMOL_L"] = "mmol/l";
     BloodGlucoseUnit["MG_DL"] = "mg/dl";
 })(BloodGlucoseUnit = exports.BloodGlucoseUnit || (exports.BloodGlucoseUnit = {}));
+/** Represents a unit for measuring blood ketone levels. */
 var BloodKetonesUnit;
 (function (BloodKetonesUnit) {
     BloodKetonesUnit["MMOL_L"] = "mmol/l";
     BloodKetonesUnit["MG_DL"] = "mg/dl";
 })(BloodKetonesUnit = exports.BloodKetonesUnit || (exports.BloodKetonesUnit = {}));
+/** Represents a unit for measuring insulin intake */
 var InsulinUnit;
 (function (InsulinUnit) {
     InsulinUnit["IU"] = "IU";
 })(InsulinUnit = exports.InsulinUnit || (exports.InsulinUnit = {}));
+/** Represents a language that the app can be displayed in. */
 var Languages;
 (function (Languages) {
     Languages["da"] = "Dansk";
@@ -29,6 +33,7 @@ var Languages;
     Languages["fr"] = "Fran\u00E7ais";
     Languages["it"] = "Italiano";
 })(Languages = exports.Languages || (exports.Languages = {}));
+/** Enum containing constants for seconds, minutes, hours, or days in milliseconds */
 var Milliseconds;
 (function (Milliseconds) {
     Milliseconds[Milliseconds["Second"] = 1000] = "Second";
@@ -36,6 +41,7 @@ var Milliseconds;
     Milliseconds[Milliseconds["Hour"] = 3600000] = "Hour";
     Milliseconds[Milliseconds["Day"] = 86400000] = "Day";
 })(Milliseconds = exports.Milliseconds || (exports.Milliseconds = {}));
+/** Enum containing the possible ketone levels of the user */
 var KetoneLevels;
 (function (KetoneLevels) {
     KetoneLevels[KetoneLevels["Negative"] = 0] = "Negative";
@@ -44,6 +50,11 @@ var KetoneLevels;
     KetoneLevels[KetoneLevels["Moderate"] = 3] = "Moderate";
     KetoneLevels[KetoneLevels["High"] = 4] = "High";
 })(KetoneLevels = exports.KetoneLevels || (exports.KetoneLevels = {}));
+/**
+ * Enum containing constants for displaying colour indicators regarding the blood ketone levels of the user.
+ * Blood ketones ranges and the color scheme can be found at:
+ * https://hedia.atlassian.net/wiki/spaces/QMS/pages/827785277/QF-73-3-1+Ketones+and+current+functions+in+HDA#4.0-Ketone-procedure-in-HDA
+ */
 var KetoneColours;
 (function (KetoneColours) {
     KetoneColours["None"] = "rgb(15,18,49)";

package/dist/types/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../types/enums.ts"],"names":[],"mappings":";;;AAAA,IAAK,KAGJ;AAHD,WAAK,KAAK;IACT,0BAAiB,CAAA;IACjB,wBAAe,CAAA;AAChB,CAAC,EAHI,KAAK,KAAL,KAAK,QAGT;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC3B,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;AACpB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC3B,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;AACpB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED,IAAY,WAEX;AAFD,WAAY,WAAW;IACtB,wBAAS,CAAA;AACV,CAAC,EAFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAEtB;AAED,IAAY,SAOX;AAPD,WAAY,SAAS;IACpB,yBAAY,CAAA;IACZ,2BAAc,CAAA;IACd,2BAAc,CAAA;IACd,gCAAc,CAAA;IACd,iCAAe,CAAA;IACf,4BAAe,CAAA;AAChB,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB;AAED,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,sDAAa,CAAA;IACb,uDAAc,CAAA;IACd,qDAAc,CAAA;IACd,oDAAc,CAAA;AACf,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED,IAAY,YAMX;AAND,WAAY,YAAY;IACvB,uDAAQ,CAAA;IACR,mDAAM,CAAA;IACN,yEAAiB,CAAA;IACjB,uDAAQ,CAAA;IACR,+CAAI,CAAA;AACL,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB;AAED,IAAY,aAOX;AAPD,WAAY,aAAa;IACxB,uCAAsB,CAAA;IACtB,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,yDAAwC,CAAA;IACxC,+CAA8B,CAAA;IAC9B,wCAAuB,CAAA;AACxB,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AAED,IAAY,UAiYX;AAjYD,WAAY,UAAU;IACrB;;;;;;;;;OASG;IACH,qDAAc,CAAA;IAEd;;OAEG;IACH,2EAAyB,CAAA;IAEzB;;;;;OAKG;IACH,yDAAgB,CAAA;IAEhB;;;;;OAKG;IACH,yCAAQ,CAAA;IAER;;OAEG;IACH,mDAAa,CAAA;IAEb;;;OAGG;IACH,qDAAc,CAAA;IAEd;;;;OAIG;IACH,+FAAmC,CAAA;IAEnC;;OAEG;IACH,yDAAgB,CAAA;IAEhB;;;OAGG;IACH,+DAAmB,CAAA;IAEnB;;;;OAIG;IACH,mEAAqB,CAAA;IAErB;;;OAGG;IACH,6DAAkB,CAAA;IAElB;;;OAGG;IACH,qEAAsB,CAAA;IAEtB;;;;OAIG;IACH,mDAAa,CAAA;IAEb;;;;;OAKG;IACH,qEAAsB,CAAA;IAEtB;;OAEG;IACH,uEAAuB,CAAA;IAEvB;;;;;;;OAOG;IACH,+CAAW,CAAA;IAEX;;;;;OAKG;IACH,uDAAe,CAAA;IAEf;;;;;OAKG;IACH,6DAAkB,CAAA;IAElB;;;;;OAKG;IACH,uDAAe,CAAA;IAEf;;OAEG;IACH,6DAAkB,CAAA;IAElB;;;;;;;OAOG;IACH,yEAAwB,CAAA;IAExB;;;;OAIG;IACH,yEAAwB,CAAA;IAExB;;;OAGG;IACH,2DAAiB,CAAA;IAEjB;;;;;OAKG;IACH,6DAAkB,CAAA;IAElB;;;;OAIG;IACH,qEAAsB,CAAA;IAEtB;;;OAGG;IACH,uDAAe,CAAA;IAEf;;;OAGG;IACH,uDAAe,CAAA;IAEf;;;;OAIG;IACH,yEAAwB,CAAA;IAExB;;;OAGG;IACH,iEAAoB,CAAA;IAEpB;;OAEG;IACH,+FAAmC,CAAA;IAEnC;;;;;OAKG;IACH,mEAAqB,CAAA;IAErB;;;OAGG;IACH,qDAAc,CAAA;IAEd;;;;;;;OAOG;IACH,6CAAU,CAAA;IAEV;;OAEG;IACH,mEAAqB,CAAA;IAErB;;OAEG;IACH,2EAAyB,CAAA;IAEzB;;;OAGG;IACH,uEAAuB,CAAA;IAEvB;;;;;OAKG;IACH,6DAAkB,CAAA;IAElB;;;;OAIG;IACH,iFAA4B,CAAA;IAE5B;;;;OAIG;IACH,+EAA2B,CAAA;IAE3B;;OAEG;IACH,yEAAwB,CAAA;IACxB;;;OAGG;IACH,2EAAyB,CAAA;IAEzB;;OAEG;IACH,6EAA0B,CAAA;IAE1B;;OAEG;IACH,iDAAY,CAAA;IAEZ;;OAEG;IACH,uEAAuB,CAAA;IAEvB;;OAEG;IACH,qEAAsB,CAAA;IAEtB;;;;;OAKG;IACH,+EAA2B,CAAA;IAE3B;;OAEG;IACH,uEAAuB,CAAA;IAEvB;;;OAGG;IACH,mGAAqC,CAAA;IAErC;;;OAGG;IACH,+FAAmC,CAAA;IAEnC;;;OAGG;IACH,+EAA2B,CAAA;IAE3B;;;OAGG;IACH,mEAAqB,CAAA;IAErB;;OAEG;IACH,2DAAiB,CAAA;IAEjB;;;OAGG;IACH,2EAAyB,CAAA;IAEzB;;OAEG;IACH,mEAAqB,CAAA;IAErB;;OAEG;IACH,yFAAgC,CAAA;IAEhC;;OAEG;IACH,mFAA6B,CAAA;IAE7B;;OAEG;IACH,6EAA0B,CAAA;IAE1B;;OAEG;IACH,6DAAkB,CAAA;IAElB;;;;OAIG;IACH,mGAAqC,CAAA;IAErC;;OAEG;IACH,+DAAmB,CAAA;AACpB,CAAC,EAjYW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAiYrB;AAED,IAAY,iBAoDX;AApDD,WAAY,iBAAiB;IAC5B;;;OAGG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,sCAAiB,CAAA;IAEjB;;;OAGG;IACH,gCAAW,CAAA;IAEX;;;OAGG;IACH,kCAAa,CAAA;IAEb;;;OAGG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAe,CAAA;IAEf;;;OAGG;IACH,kCAAa,CAAA;IAEb;;;OAGG;IACH,gCAAW,CAAA;IAEX;;;OAGG;IACH,oCAAe,CAAA;AAChB,CAAC,EApDW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAoD5B"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../types/enums.ts"],"names":[],"mappings":";;;AAAA,IAAK,KAGJ;AAHD,WAAK,KAAK;IACT,0BAAiB,CAAA;IACjB,wBAAe,CAAA;AAChB,CAAC,EAHI,KAAK,KAAL,KAAK,QAGT;AAED,4DAA4D;AAC5D,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC3B,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;AACpB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED,2DAA2D;AAC3D,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC3B,qCAAqB,CAAA;IACrB,mCAAmB,CAAA;AACpB,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B;AAED,qDAAqD;AACrD,IAAY,WAEX;AAFD,WAAY,WAAW;IACtB,wBAAS,CAAA;AACV,CAAC,EAFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAEtB;AAED,8DAA8D;AAC9D,IAAY,SAOX;AAPD,WAAY,SAAS;IACpB,yBAAY,CAAA;IACZ,2BAAc,CAAA;IACd,2BAAc,CAAA;IACd,gCAAc,CAAA;IACd,iCAAe,CAAA;IACf,4BAAe,CAAA;AAChB,CAAC,EAPW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAOpB;AAED,qFAAqF;AACrF,IAAY,YAKX;AALD,WAAY,YAAY;IACvB,sDAAa,CAAA;IACb,uDAAc,CAAA;IACd,qDAAc,CAAA;IACd,oDAAc,CAAA;AACf,CAAC,EALW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAKvB;AAED,6DAA6D;AAC7D,IAAY,YAMX;AAND,WAAY,YAAY;IACvB,uDAAQ,CAAA;IACR,mDAAM,CAAA;IACN,yEAAiB,CAAA;IACjB,uDAAQ,CAAA;IACR,+CAAI,CAAA;AACL,CAAC,EANW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAMvB;AAED;;;;GAIG;AACH,IAAY,aAOX;AAPD,WAAY,aAAa;IACxB,uCAAsB,CAAA;IACtB,8CAA6B,CAAA;IAC7B,4CAA2B,CAAA;IAC3B,yDAAwC,CAAA;IACxC,+CAA8B,CAAA;IAC9B,wCAAuB,CAAA;AACxB,CAAC,EAPW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAOxB;AAED,IAAY,UAiYX;AAjYD,WAAY,UAAU;IACrB;;;;;;;;;OASG;IACH,qDAAc,CAAA;IAEd;;OAEG;IACH,2EAAyB,CAAA;IAEzB;;;;;OAKG;IACH,yDAAgB,CAAA;IAEhB;;;;;OAKG;IACH,yCAAQ,CAAA;IAER;;OAEG;IACH,mDAAa,CAAA;IAEb;;;OAGG;IACH,qDAAc,CAAA;IAEd;;;;OAIG;IACH,+FAAmC,CAAA;IAEnC;;OAEG;IACH,yDAAgB,CAAA;IAEhB;;;OAGG;IACH,+DAAmB,CAAA;IAEnB;;;;OAIG;IACH,mEAAqB,CAAA;IAErB;;;OAGG;IACH,6DAAkB,CAAA;IAElB;;;OAGG;IACH,qEAAsB,CAAA;IAEtB;;;;OAIG;IACH,mDAAa,CAAA;IAEb;;;;;OAKG;IACH,qEAAsB,CAAA;IAEtB;;OAEG;IACH,uEAAuB,CAAA;IAEvB;;;;;;;OAOG;IACH,+CAAW,CAAA;IAEX;;;;;OAKG;IACH,uDAAe,CAAA;IAEf;;;;;OAKG;IACH,6DAAkB,CAAA;IAElB;;;;;OAKG;IACH,uDAAe,CAAA;IAEf;;OAEG;IACH,6DAAkB,CAAA;IAElB;;;;;;;OAOG;IACH,yEAAwB,CAAA;IAExB;;;;OAIG;IACH,yEAAwB,CAAA;IAExB;;;OAGG;IACH,2DAAiB,CAAA;IAEjB;;;;;OAKG;IACH,6DAAkB,CAAA;IAElB;;;;OAIG;IACH,qEAAsB,CAAA;IAEtB;;;OAGG;IACH,uDAAe,CAAA;IAEf;;;OAGG;IACH,uDAAe,CAAA;IAEf;;;;OAIG;IACH,yEAAwB,CAAA;IAExB;;;OAGG;IACH,iEAAoB,CAAA;IAEpB;;OAEG;IACH,+FAAmC,CAAA;IAEnC;;;;;OAKG;IACH,mEAAqB,CAAA;IAErB;;;OAGG;IACH,qDAAc,CAAA;IAEd;;;;;;;OAOG;IACH,6CAAU,CAAA;IAEV;;OAEG;IACH,mEAAqB,CAAA;IAErB;;OAEG;IACH,2EAAyB,CAAA;IAEzB;;;OAGG;IACH,uEAAuB,CAAA;IAEvB;;;;;OAKG;IACH,6DAAkB,CAAA;IAElB;;;;OAIG;IACH,iFAA4B,CAAA;IAE5B;;;;OAIG;IACH,+EAA2B,CAAA;IAE3B;;OAEG;IACH,yEAAwB,CAAA;IACxB;;;OAGG;IACH,2EAAyB,CAAA;IAEzB;;OAEG;IACH,6EAA0B,CAAA;IAE1B;;OAEG;IACH,iDAAY,CAAA;IAEZ;;OAEG;IACH,uEAAuB,CAAA;IAEvB;;OAEG;IACH,qEAAsB,CAAA;IAEtB;;;;;OAKG;IACH,+EAA2B,CAAA;IAE3B;;OAEG;IACH,uEAAuB,CAAA;IAEvB;;;OAGG;IACH,mGAAqC,CAAA;IAErC;;;OAGG;IACH,+FAAmC,CAAA;IAEnC;;;OAGG;IACH,+EAA2B,CAAA;IAE3B;;;OAGG;IACH,mEAAqB,CAAA;IAErB;;OAEG;IACH,2DAAiB,CAAA;IAEjB;;;OAGG;IACH,2EAAyB,CAAA;IAEzB;;OAEG;IACH,mEAAqB,CAAA;IAErB;;OAEG;IACH,yFAAgC,CAAA;IAEhC;;OAEG;IACH,mFAA6B,CAAA;IAE7B;;OAEG;IACH,6EAA0B,CAAA;IAE1B;;OAEG;IACH,6DAAkB,CAAA;IAElB;;;;OAIG;IACH,mGAAqC,CAAA;IAErC;;OAEG;IACH,+DAAmB,CAAA;AACpB,CAAC,EAjYW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAiYrB;AAED,IAAY,iBAoDX;AApDD,WAAY,iBAAiB;IAC5B;;;OAGG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,sCAAiB,CAAA;IAEjB;;;OAGG;IACH,gCAAW,CAAA;IAEX;;;OAGG;IACH,kCAAa,CAAA;IAEb;;;OAGG;IACH,wCAAmB,CAAA;IAEnB;;OAEG;IACH,oCAAe,CAAA;IAEf;;;OAGG;IACH,kCAAa,CAAA;IAEb;;;OAGG;IACH,gCAAW,CAAA;IAEX;;;OAGG;IACH,oCAAe,CAAA;AAChB,CAAC,EApDW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAoD5B"}

package/dist/types/logbook/logbook.d.ts

@@ -1,5 +1,6 @@
 export declare namespace Logbook {
     namespace Enums {
+        /** Used to differentiate the different moods that users can select. */
         enum MoodEnum {
             Sad = 1,
             SemiSad = 2,
@@ -10,25 +11,109 @@ export declare namespace Logbook {
     }
     namespace Types {
         interface ILogbookEntry {
+            /** Unique id for each logbook*/
             uuid: string;
+            /**
+             * The timestamp at which this logbook entry should be displayed in to the user.
+             * This may differ from client_timestamp if the user created the logbook entry manually after the fact
+             * or they edited the entry timestamp of the logbook entry after it was first created.
+             */
             entry_timestamp: string;
+            /**
+             * The timestamp at which this logbook entry was saved in the server's database.
+             * This can be expected to be the time of the first syncrhonization after the logbook entry was created on the client.
+             */
             server_timestamp: Date | null;
+            /**
+             * The timestamp at which the logbook entry was created on the client.
+             * This may differ from entry_timestamp if the user created the logbook entry manually after the fact
+             * or they edited the entry timestamp of the logbook entry after it was first created.
+             */
             client_timestamp: string;
+            /**
+             * When the user makes changes to an existing logbook entry, the changes will be saved as a completely new logbook entry.
+             * For the old entry, this field will then be updated with the uuid of the new version of the logbook entry.
+             * The value is null by default (that is if the entry hasn't been replaced with a newer version).
+             * Logbook entries that don't contain null in this field are considered outdated and should gerenerally be excluded when computing statistics and the like.
+             */
             overwritten_by_id: string | null;
+            /**
+             * The uuid of the settings object that was used on the client when the logbook entry was created.
+             * Note that if the user updates their settings later this field will not be updated.
+             * This allows us to exactly which settings were used to make an old insulin calculation
+             */
             settings_uuid: string;
+            /** The version of the app that was used to create the logbook entry. e.g. "2.7.3" */
             client_version: string;
+            /** For keeping track of which version of the server that was used when the logbook entry was synchronized and saved to the database. */
             server_version: number | null;
+            /**
+             * For keeping track of which os and os version the app was running on when the logbook entry was created.
+             * For android this is the API level, e.g. "android 28" or "android 24".
+             * For iOS this is the version of the os, e.g. "ios 13.3.1" or "ios 13.5.1"
+             */
             device_and_os: string;
+            /**
+             * The exact result of the insulin recommendation calculation without rounding.
+             * Should be 0 if the user made a calculation and didn't get a recommendation
+             * (because it was recommended that they should eat additional carbohydrates instead).
+             */
             insulin_suggested_units: number | null;
+            /**
+             * The value in the insulin field when the logbook entry was saved.
+             * By default the value in the insulin field is the suggested amount of insulin that has been rounded based on the user's injection method,
+             * so most often that is the value that will be saved in this field.
+             * If the user has changed the value of the field, then that is of course the value that will be saved here.
+             */
             insulin_entered_units: number | null;
+            /**
+             * The amount of extra carbohydrates that was recommended to the user if they made a calculation.
+             * If they were recommended to take insulin instead this should be 0.
+             * Should be <null> if they did not get a recommendation at all (e.g. because they made a manual entry instead
+             */
             carbohydrates_suggested_grams: number | null;
+            /**
+             * The total amount (sum) of carbohydrates that the user ingested for this logbook entry including from the food database,
+             * manual entry of carbohydrates, and additional carbohdyrates that they are eating.
+             */
             carbohydrates_entered_grams: number | null;
+            /**
+             * The amount of carbohydrates that was entered in the “additional carbohydrates” field on the recommendation screen if the user got a carbohydrate recommendation.
+             * The field defaults to the carbohydrates_suggested_grams, so those should be identical unless the user modified the value.
+             */
             carbohydrates_modified_suggested_grams: number | null;
+            /**
+             * The user's blood glucose level in mmol/L (millimolar) for the logbook entry.
+             * Should be <null> if the user didn't actually enter their BGL for the logbook entry.
+             */
             blood_glucose_millimolar: number | null;
+            /**
+             * The user's blood ketones level in mmol/L (millimolar) for the logbook entry.
+             * Should be <null> if the user didn't actually enter their BGL for the logbook entry.
+             */
             blood_ketones_millimolar: number | null;
+            /**
+             * The mood the the user selected with the logbook entry from 1 (sad) to 5 (happy).
+             * Should be <null> if the user didn't select a mood.
+             */
             mood: Enums.MoodEnum | null;
+            /**
+             * The uuid of the event (physical activity) that was associated with the logbook entry.
+             * Should be <null> if no event is associated with the logbook entry.
+             */
             event_uuid: string | null;
+            /**
+             * We never actually delete logbook entries, but this field indicates if a logbook entry shoulb be considered removed by the user.
+             * The value is <null> by default.
+             * If an entry is removed then this field is updated with the timestamp when it was removed.
+             */
             is_deleted: Date | null;
+            /**
+             * Indicates the timezone of the client device at the time when the logbook entry was created as an offset from UTC.
+             * Example values: "+01:00", "-05:00", "+05:30", "+08:00".
+             * Can be used in combination with entry_timestamp and client_timestamp (which are both in UTC)
+             * to determine what time those timestamps represented in the users local time.
+             */
             utc_timezone_offset: string | null;
             smart_pen_sync_timestamp?: string;
         }

package/dist/types/logbook/logbook.js

@@ -5,6 +5,7 @@ var Logbook;
 (function (Logbook) {
     let Enums;
     (function (Enums) {
+        /** Used to differentiate the different moods that users can select. */
         let MoodEnum;
         (function (MoodEnum) {
             MoodEnum[MoodEnum["Sad"] = 1] = "Sad";

package/dist/types/logbook/logbook.js.map

@@ -1 +1 @@
-{"version":3,"file":"logbook.js","sourceRoot":"","sources":["../../../types/logbook/logbook.ts"],"names":[],"mappings":";;;AAAA,IAAiB,OAAO,CAsDvB;AAtDD,WAAiB,OAAO;IACvB,IAAiB,KAAK,CAQrB;IARD,WAAiB,KAAK;QACrB,IAAY,QAMX;QAND,WAAY,QAAQ;YACnB,qCAAO,CAAA;YACP,6CAAW,CAAA;YACX,6CAAW,CAAA;YACX,iDAAa,CAAA;YACb,yCAAS,CAAA;QACV,CAAC,EANW,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAMnB;IACF,CAAC,EARgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAQrB;AA6CF,CAAC,EAtDgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAsDvB"}
+{"version":3,"file":"logbook.js","sourceRoot":"","sources":["../../../types/logbook/logbook.ts"],"names":[],"mappings":";;;AAAA,IAAiB,OAAO,CA2IvB;AA3ID,WAAiB,OAAO;IACvB,IAAiB,KAAK,CASrB;IATD,WAAiB,KAAK;QACrB,uEAAuE;QACvE,IAAY,QAMX;QAND,WAAY,QAAQ;YACnB,qCAAO,CAAA;YACP,6CAAW,CAAA;YACX,6CAAW,CAAA;YACX,iDAAa,CAAA;YACb,yCAAS,CAAA;QACV,CAAC,EANW,QAAQ,GAAR,cAAQ,KAAR,cAAQ,QAMnB;IACF,CAAC,EATgB,KAAK,GAAL,aAAK,KAAL,aAAK,QASrB;AAiIF,CAAC,EA3IgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA2IvB"}

package/dist/types/usersettings/usersettings.d.ts

@@ -89,6 +89,10 @@ export declare namespace UserSettings {
             Male = "Male",
             Female = "Female"
         }
+        /**
+         * String enum for differentiating between different methods by which someone can inject insulin into the body.
+         * Mainly used to determine how insulin amounts should be rounded.
+         */
         enum InjectionMethod {
             PenHalf = "Pen-half",
             PenWhole = "Pen-whole",

package/dist/types/usersettings/usersettings.js

@@ -39,6 +39,10 @@ var UserSettings;
             Gender["Male"] = "Male";
             Gender["Female"] = "Female";
         })(Gender = Enums.Gender || (Enums.Gender = {}));
+        /**
+         * String enum for differentiating between different methods by which someone can inject insulin into the body.
+         * Mainly used to determine how insulin amounts should be rounded.
+         */
         let InjectionMethod;
         (function (InjectionMethod) {
             InjectionMethod["PenHalf"] = "Pen-half";

package/dist/types/usersettings/usersettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"usersettings.js","sourceRoot":"","sources":["../../../types/usersettings/usersettings.ts"],"names":[],"mappings":";;;AAGA,IAAiB,YAAY,CA2G5B;AA3GD,WAAiB,YAAY;IAmE5B,IAAiB,KAAK,CAuCrB;IAvCD,WAAiB,KAAK;QACrB,IAAY,KAGX;QAHD,WAAY,KAAK;YAChB,4BAAmB,CAAA;YACnB,gCAAuB,CAAA;QACxB,CAAC,EAHW,KAAK,GAAL,WAAK,KAAL,WAAK,QAGhB;QAED,IAAY,iBAOX;QAPD,WAAY,iBAAiB;YAC5B,4CAAuB,CAAA;YACvB,oCAAe,CAAA;YACf,wCAAmB,CAAA;YACnB,sCAAiB,CAAA;YACjB,oCAAe,CAAA;YACf,kCAAa,CAAA;QACd,CAAC,EAPW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAO5B;QACD,IAAY,iBAQX;QARD,WAAY,iBAAiB;YAC5B,sCAAiB,CAAA;YACjB,0CAAqB,CAAA;YACrB,sCAAiB,CAAA;YACjB,wCAAmB,CAAA;YACnB,wCAAmB,CAAA;YACnB,oCAAe,CAAA;YACf,kCAAa,CAAA;QACd,CAAC,EARW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAQ5B;QAED,IAAY,YAGX;QAHD,WAAY,YAAY;YACvB,iDAAS,CAAA;YACT,iDAAS,CAAA;QACV,CAAC,EAHW,YAAY,GAAZ,kBAAY,KAAZ,kBAAY,QAGvB;QAED,IAAY,MAGX;QAHD,WAAY,MAAM;YACjB,uBAAa,CAAA;YACb,2BAAiB,CAAA;QAClB,CAAC,EAHW,MAAM,GAAN,YAAM,KAAN,YAAM,QAGjB;QAED,IAAY,eAIX;QAJD,WAAY,eAAe;YAC1B,uCAAoB,CAAA;YACpB,yCAAsB,CAAA;YACtB,gCAAa,CAAA;QACd,CAAC,EAJW,eAAe,GAAf,qBAAe,KAAf,qBAAe,QAI1B;IACF,CAAC,EAvCgB,KAAK,GAAL,kBAAK,KAAL,kBAAK,QAuCrB;AACF,CAAC,EA3GgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA2G5B"}
+{"version":3,"file":"usersettings.js","sourceRoot":"","sources":["../../../types/usersettings/usersettings.ts"],"names":[],"mappings":";;;AAGA,IAAiB,YAAY,CA+G5B;AA/GD,WAAiB,YAAY;IAmE5B,IAAiB,KAAK,CA2CrB;IA3CD,WAAiB,KAAK;QACrB,IAAY,KAGX;QAHD,WAAY,KAAK;YAChB,4BAAmB,CAAA;YACnB,gCAAuB,CAAA;QACxB,CAAC,EAHW,KAAK,GAAL,WAAK,KAAL,WAAK,QAGhB;QAED,IAAY,iBAOX;QAPD,WAAY,iBAAiB;YAC5B,4CAAuB,CAAA;YACvB,oCAAe,CAAA;YACf,wCAAmB,CAAA;YACnB,sCAAiB,CAAA;YACjB,oCAAe,CAAA;YACf,kCAAa,CAAA;QACd,CAAC,EAPW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAO5B;QACD,IAAY,iBAQX;QARD,WAAY,iBAAiB;YAC5B,sCAAiB,CAAA;YACjB,0CAAqB,CAAA;YACrB,sCAAiB,CAAA;YACjB,wCAAmB,CAAA;YACnB,wCAAmB,CAAA;YACnB,oCAAe,CAAA;YACf,kCAAa,CAAA;QACd,CAAC,EARW,iBAAiB,GAAjB,uBAAiB,KAAjB,uBAAiB,QAQ5B;QAED,IAAY,YAGX;QAHD,WAAY,YAAY;YACvB,iDAAS,CAAA;YACT,iDAAS,CAAA;QACV,CAAC,EAHW,YAAY,GAAZ,kBAAY,KAAZ,kBAAY,QAGvB;QAED,IAAY,MAGX;QAHD,WAAY,MAAM;YACjB,uBAAa,CAAA;YACb,2BAAiB,CAAA;QAClB,CAAC,EAHW,MAAM,GAAN,YAAM,KAAN,YAAM,QAGjB;QAED;;;WAGG;QACH,IAAY,eAIX;QAJD,WAAY,eAAe;YAC1B,uCAAoB,CAAA;YACpB,yCAAsB,CAAA;YACtB,gCAAa,CAAA;QACd,CAAC,EAJW,eAAe,GAAf,qBAAe,KAAf,qBAAe,QAI1B;IACF,CAAC,EA3CgB,KAAK,GAAL,kBAAK,KAAL,kBAAK,QA2CrB;AACF,CAAC,EA/GgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QA+G5B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hedia/types",
-  "version": "2.1.20",
+  "version": "2.1.22",
   "description": "Enums, interfaces, and other common types for use in Hedia's software.",
   "main": "dist/index.js",
   "repository": {

package/types/activity/activity.ts

@@ -12,8 +12,15 @@ export namespace Activity {
 			overwrittenByUUID?: IActivityEntry["uuid"];
 		}
 
+		/** Type that represents the user’s settings related to physical activity. */
 		export type ActivitySettings = ActivityReductionSettings & ActivityTarget;
+		/** Represents a set of insulin reduction fraction settings that can vary by the duration of the activity. */
 		export type ActivityReductionIntervals = ActivityReductionSettings[keyof ActivityReductionSettings];
+		/**
+		 * Represents whether the reduction fraction is a number or it is null.
+		 * Only for the settings of hard physical activities over 45 minutes the value is null.
+		 * A null value represents that it is not supported by HDA.
+		 */
 		export type ReductionType = ActivityReductionIntervals[keyof ActivityReductionIntervals];
 
 		type ActivityIntensityKeys = keyof typeof Enums.ActivityIntensity;
@@ -34,25 +41,28 @@ export namespace Activity {
 		type ActivityReductionSettingsIntervals<
 			K extends ActivityIntensityKeys,
 			T extends ActivityIntensityKeys,
-			U extends ActivityReductionKeys
+			U extends ActivityReductionKeys,
 		> = {
 			[key in ActivityReductionKeys]: K extends T ? (key extends U ? null | number : number) : number;
 		};
 	}
 
 	export namespace Enums {
+		/** Enum that represents a set of insulin reduction fraction settings that can vary by the duration of the activity */
 		export enum ActivityReductionIntervals {
 			fromZero = `fromZero`,
 			fromThirty = `fromThirty`,
 			fromFortysix = `fromFortysix`,
 		}
 
+		/** Enum used to indicate the category or intensity of a physical activity. */
 		export enum ActivityIntensity {
 			light = `light`,
 			moderate = `moderate`,
 			hard = `hard`,
 		}
 
+		/** Enum used to indicate the type of physical activity performed by the user. */
 		export enum ActivityEnum {
 			Run = `Run`,
 			Walk = `Walk`,

package/types/boluscalculator/boluscalculator.ts

@@ -2,13 +2,18 @@ import { Activity } from "../activity/activity";
 
 export namespace BolusCalculator {
 	export namespace Constants {
+		/** The maximum amount of insulin that may be recommended to the user. */
 		export const SAFETY_INSULIN_LIMIT = 50;
+		/** The maximum duration in minutes of a physical activity. */
 		export const SAFETY_ACTIVITY_LIMIT = 60;
+		/** The maximum reduction factor for a physical activity */
 		export const REDUCTION_MAX = 1;
+		/** The minimum reduction factor for a physical activity */
 		export const REDUCTION_MIN = 0;
 	}
 
 	export namespace Enums {
+		/** Enum for differentiating between types of errors. */
 		export enum ActivityErrors {
 			OutOfRange = `Out of range`,
 			InvalidInterval = `Invalid activity settings interval`,
@@ -17,32 +22,64 @@ export namespace BolusCalculator {
 	}
 
 	export namespace Types {
+		/** Represents a single bolus of fast-acting insulin that has been administered within the past 4 hours. */
 		export interface IRecentBolus {
+			/** The number of seconds that has passed since the bolus in question was administered. */
 			secondsPassed: number;
+			/** The amount of insulin that was administered with the bolus in question. */
 			insulinDose: number;
 		}
+
+		/** Details about a physical activity. */
 		export interface IActivityParams {
+			/** The duration of the physical activity in minutes. */
 			activityDuration: number;
+			/** The intensity of the activity */
 			activityIntensity: Activity.Enums.ActivityIntensity;
+			/** The user’s current settings for physical activity */
 			activitySettings: Activity.Types.ActivitySettings;
+			/** Start date and time for the activity */
 			activityDate: Date;
 		}
 
+		/** IRecommendationParams contains data that is used to calculate a recommendation. */
 		export interface IRecommendationParams {
+			/** The user’s current blood glucose level in mmol/L */
 			currentBGL: number | null;
+			/** The blood glucose level in mmol/L that the user should ideally have at this time of day according to their settings/preferences. */
 			targetBGL: number;
+			/** The user’s current insulin sensitivity in (mmol/L)/IU according to their settings/preferences. */
 			insulinSensitivity: number;
+			/** The amount of carbohydrates in grams that the user has entered that they are going to eat. */
 			carbohydrates: number;
+			/** The user’s current insulin-to-carbs ratio in g/IU according to their settings/preferences. */
 			carbohydrateRatio: number;
+			/** A possibly empty array of IRecentBolus objects. */
 			recentBoluses: Array<IRecentBolus>;
+			/** Information about the activity that the user is doing including their activity settings */
 			activity: IActivityParams | null;
 		}
 
+		/**
+		 * The result of a recommendation calculation is returned by the calculateRecommendation() function as an object that implements this interface.
+		 * Note that only one of bolus and carbRecommendation may be positive. If one is non-zero then the other must be zero.
+		 */
 		export interface IRecommendationResult {
+			/** The recommended amount of insulin measured in units. */
 			bolus: number;
+			/**
+			 * Indicates whether or not the insulin recommendation (given in the bolus property) was capped because the underlying recommendation exceeded the safety limit.
+			 * If it is true then we know that the recommendation would have been higher and can show and appropriate message to the user.
+			 */
 			wasLimited: boolean;
+			/** The number of carbs that the user is recommended to eat */
 			carbRecommendation: number;
+			/**
+			 * Indicates how much the insulin recommendation was reduced due to physical activity.
+			 * A value of 0.75 would indicate that the recommended insulin was reduced by 25%.
+			 */
 			activityReduction: number | null;
+			/** The estimated amount of active insulin (IOB) in IU. */
 			activeInsulin: number;
 		}
 	}

package/types/enums.ts

@@ -3,20 +3,24 @@ enum Units {
 	MG_DL = "mg/dl",
 }
 
+/** Represents a unit for measuring blood glucose levels. */
 export enum BloodGlucoseUnit {
 	MMOL_L = Units.MMOL_L,
 	MG_DL = Units.MG_DL,
 }
 
+/** Represents a unit for measuring blood ketone levels. */
 export enum BloodKetonesUnit {
 	MMOL_L = Units.MMOL_L,
 	MG_DL = Units.MG_DL,
 }
 
+/** Represents a unit for measuring insulin intake */
 export enum InsulinUnit {
 	IU = `IU`,
 }
 
+/** Represents a language that the app can be displayed in. */
 export enum Languages {
 	da = `Dansk`,
 	en = `English`,
@@ -26,6 +30,7 @@ export enum Languages {
 	it = `Italiano`,
 }
 
+/** Enum containing constants for seconds, minutes, hours, or days in milliseconds */
 export enum Milliseconds {
 	Second = 1000,
 	Minute = 60000,
@@ -33,6 +38,7 @@ export enum Milliseconds {
 	Day = 86400000,
 }
 
+/** Enum containing the possible ketone levels of the user */
 export enum KetoneLevels {
 	Negative,
 	Normal,
@@ -41,6 +47,11 @@ export enum KetoneLevels {
 	High,
 }
 
+/**
+ * Enum containing constants for displaying colour indicators regarding the blood ketone levels of the user.
+ * Blood ketones ranges and the color scheme can be found at:
+ * https://hedia.atlassian.net/wiki/spaces/QMS/pages/827785277/QF-73-3-1+Ketones+and+current+functions+in+HDA#4.0-Ketone-procedure-in-HDA
+ */
 export enum KetoneColours {
 	None = `rgb(15,18,49)`,
 	Negative = `rgb(222,194,145)`,

package/types/logbook/logbook.ts

@@ -1,5 +1,6 @@
 export namespace Logbook {
 	export namespace Enums {
+		/** Used to differentiate the different moods that users can select. */
 		export enum MoodEnum {
 			Sad = 1,
 			SemiSad = 2,
@@ -11,25 +12,109 @@ export namespace Logbook {
 
 	export namespace Types {
 		export interface ILogbookEntry {
+			/** Unique id for each logbook*/
 			uuid: string;
+			/**
+			 * The timestamp at which this logbook entry should be displayed in to the user.
+			 * This may differ from client_timestamp if the user created the logbook entry manually after the fact
+			 * or they edited the entry timestamp of the logbook entry after it was first created.
+			 */
 			entry_timestamp: string; // The date where the entry appears when the user look at their logbook in the app
+			/**
+			 * The timestamp at which this logbook entry was saved in the server's database.
+			 * This can be expected to be the time of the first syncrhonization after the logbook entry was created on the client.
+			 */
 			server_timestamp: Date | null;
-			client_timestamp: string; // The time when the entry was created by the user on their phone
+			/**
+			 * The timestamp at which the logbook entry was created on the client.
+			 * This may differ from entry_timestamp if the user created the logbook entry manually after the fact
+			 * or they edited the entry timestamp of the logbook entry after it was first created.
+			 */
+			client_timestamp: string;
+			/**
+			 * When the user makes changes to an existing logbook entry, the changes will be saved as a completely new logbook entry.
+			 * For the old entry, this field will then be updated with the uuid of the new version of the logbook entry.
+			 * The value is null by default (that is if the entry hasn't been replaced with a newer version).
+			 * Logbook entries that don't contain null in this field are considered outdated and should gerenerally be excluded when computing statistics and the like.
+			 */
 			overwritten_by_id: string | null;
+			/**
+			 * The uuid of the settings object that was used on the client when the logbook entry was created.
+			 * Note that if the user updates their settings later this field will not be updated.
+			 * This allows us to exactly which settings were used to make an old insulin calculation
+			 */
 			settings_uuid: string;
+			/** The version of the app that was used to create the logbook entry. e.g. "2.7.3" */
 			client_version: string;
+			/** For keeping track of which version of the server that was used when the logbook entry was synchronized and saved to the database. */
 			server_version: number | null;
+			/**
+			 * For keeping track of which os and os version the app was running on when the logbook entry was created.
+			 * For android this is the API level, e.g. "android 28" or "android 24".
+			 * For iOS this is the version of the os, e.g. "ios 13.3.1" or "ios 13.5.1"
+			 */
 			device_and_os: string;
+			/**
+			 * The exact result of the insulin recommendation calculation without rounding.
+			 * Should be 0 if the user made a calculation and didn't get a recommendation
+			 * (because it was recommended that they should eat additional carbohydrates instead).
+			 */
 			insulin_suggested_units: number | null;
+			/**
+			 * The value in the insulin field when the logbook entry was saved.
+			 * By default the value in the insulin field is the suggested amount of insulin that has been rounded based on the user's injection method,
+			 * so most often that is the value that will be saved in this field.
+			 * If the user has changed the value of the field, then that is of course the value that will be saved here.
+			 */
 			insulin_entered_units: number | null;
+			/**
+			 * The amount of extra carbohydrates that was recommended to the user if they made a calculation.
+			 * If they were recommended to take insulin instead this should be 0.
+			 * Should be <null> if they did not get a recommendation at all (e.g. because they made a manual entry instead
+			 */
 			carbohydrates_suggested_grams: number | null;
+			/**
+			 * The total amount (sum) of carbohydrates that the user ingested for this logbook entry including from the food database,
+			 * manual entry of carbohydrates, and additional carbohdyrates that they are eating.
+			 */
 			carbohydrates_entered_grams: number | null;
+			/**
+			 * The amount of carbohydrates that was entered in the “additional carbohydrates” field on the recommendation screen if the user got a carbohydrate recommendation.
+			 * The field defaults to the carbohydrates_suggested_grams, so those should be identical unless the user modified the value.
+			 */
 			carbohydrates_modified_suggested_grams: number | null;
+			/**
+			 * The user's blood glucose level in mmol/L (millimolar) for the logbook entry.
+			 * Should be <null> if the user didn't actually enter their BGL for the logbook entry.
+			 */
 			blood_glucose_millimolar: number | null;
+			/**
+			 * The user's blood ketones level in mmol/L (millimolar) for the logbook entry.
+			 * Should be <null> if the user didn't actually enter their BGL for the logbook entry.
+			 */
 			blood_ketones_millimolar: number | null;
+			/**
+			 * The mood the the user selected with the logbook entry from 1 (sad) to 5 (happy).
+			 * Should be <null> if the user didn't select a mood.
+			 */
 			mood: Enums.MoodEnum | null;
+			/**
+			 * The uuid of the event (physical activity) that was associated with the logbook entry.
+			 * Should be <null> if no event is associated with the logbook entry.
+			 */
 			event_uuid: string | null;
+			/**
+			 * We never actually delete logbook entries, but this field indicates if a logbook entry shoulb be considered removed by the user.
+			 * The value is <null> by default.
+			 * If an entry is removed then this field is updated with the timestamp when it was removed.
+			 */
 			is_deleted: Date | null;
+			/**
+			 * Indicates the timezone of the client device at the time when the logbook entry was created as an offset from UTC.
+			 * Example values: "+01:00", "-05:00", "+05:30", "+08:00".
+			 * Can be used in combination with entry_timestamp and client_timestamp (which are both in UTC)
+			 * to determine what time those timestamps represented in the users local time.
+			 */
 			utc_timezone_offset: string | null;
 			smart_pen_sync_timestamp?: string;
 		}

package/types/usersettings/usersettings.ts

@@ -102,6 +102,10 @@ export namespace UserSettings {
 			Female = `Female`,
 		}
 
+		/**
+		 * String enum for differentiating between different methods by which someone can inject insulin into the body.
+		 * Mainly used to determine how insulin amounts should be rounded.
+		 */
 		export enum InjectionMethod {
 			PenHalf = `Pen-half`,
 			PenWhole = `Pen-whole`,