@hedia/types 2.4.0-alpha.0 → 2.4.1-alpha.0

package/dist/v1/logbook/logbook.d.ts

@@ -1,140 +1,134 @@
-export declare namespace Logbook {
-    namespace Enums {
-        /** Used to differentiate the different moods that users can select. */
-        enum MoodEnum {
-            Sad = 1,
-            SemiSad = 2,
-            Neutral = 3,
-            SemiHappy = 4,
-            Happy = 5
-        }
-    }
-    namespace Types {
-        interface IEditedUUID {
-            oldUUID: string;
-            newUUID: string;
-        }
-        interface IClientSyncObject {
-            last_sync_timestamp: string;
-            created: Array<ILogbookEntry>;
-            edited: Array<IEditedUUID>;
-            deleted: Array<string>;
-        }
-        interface IBackendSyncObject {
-            last_sync_timestamp: string;
-            created: Array<ILogbookEntry>;
-            deleted: Array<string>;
-        }
-        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: Date;
-            /**
-             * 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: Date;
-            /**
-             * 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;
-            timezone: string;
-            activity_reduction: number | null;
-            active_insulin: number | null;
-            blood_glucose_millimolar_sample_id: string | null;
-            smart_pen_sync_timestamp?: string;
-        }
-    }
+/** Used to differentiate the different moods that users can select. */
+export declare enum MoodEnum {
+    Sad = 1,
+    SemiSad = 2,
+    Neutral = 3,
+    SemiHappy = 4,
+    Happy = 5
+}
+export interface IEditedUUID {
+    oldUUID: string;
+    newUUID: string;
+}
+export interface IClientSyncObject {
+    last_sync_timestamp: string;
+    created: ILogbookEntry[];
+    edited: IEditedUUID[];
+    deleted: string[];
+}
+export interface IBackendSyncObject {
+    last_sync_timestamp: string;
+    created: ILogbookEntry[];
+    deleted: string[];
+}
+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: Date;
+    /**
+     * 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: Date;
+    /**
+     * 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: 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;
+    timezone: string;
+    activity_reduction: number | null;
+    active_insulin: number | null;
+    blood_glucose_millimolar_sample_id: string | null;
+    smart_pen_sync_timestamp?: string;
 }

package/dist/v1/logbook/logbook.js

@@ -1,19 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logbook = void 0;
-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";
-            MoodEnum[MoodEnum["SemiSad"] = 2] = "SemiSad";
-            MoodEnum[MoodEnum["Neutral"] = 3] = "Neutral";
-            MoodEnum[MoodEnum["SemiHappy"] = 4] = "SemiHappy";
-            MoodEnum[MoodEnum["Happy"] = 5] = "Happy";
-        })(MoodEnum = Enums.MoodEnum || (Enums.MoodEnum = {}));
-    })(Enums = Logbook.Enums || (Logbook.Enums = {}));
-})(Logbook = exports.Logbook || (exports.Logbook = {}));
+exports.MoodEnum = void 0;
+/** Used to differentiate the different moods that users can select. */
+var MoodEnum;
+(function (MoodEnum) {
+    MoodEnum[MoodEnum["Sad"] = 1] = "Sad";
+    MoodEnum[MoodEnum["SemiSad"] = 2] = "SemiSad";
+    MoodEnum[MoodEnum["Neutral"] = 3] = "Neutral";
+    MoodEnum[MoodEnum["SemiHappy"] = 4] = "SemiHappy";
+    MoodEnum[MoodEnum["Happy"] = 5] = "Happy";
+})(MoodEnum || (exports.MoodEnum = MoodEnum = {}));
 //# sourceMappingURL=logbook.js.map

package/dist/v1/logbook/logbook.js.map

@@ -1 +1 @@
-{"version":3,"file":"logbook.js","sourceRoot":"","sources":["../../../v1/logbook/logbook.ts"],"names":[],"mappings":";;;AAAA,IAAiB,OAAO,CAmJvB;AAnJD,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;AAyIF,CAAC,EAnJgB,OAAO,GAAP,eAAO,KAAP,eAAO,QAmJvB"}
+{"version":3,"file":"logbook.js","sourceRoot":"","sources":["../../../v1/logbook/logbook.ts"],"names":[],"mappings":";;;AAAA,uEAAuE;AACvE,IAAY,QAMX;AAND,WAAY,QAAQ;IACnB,qCAAO,CAAA;IACP,6CAAW,CAAA;IACX,6CAAW,CAAA;IACX,iDAAa,CAAA;IACb,yCAAS,CAAA;AACV,CAAC,EANW,QAAQ,wBAAR,QAAQ,QAMnB"}

package/dist/v1/userdetails/userdetails.d.ts

@@ -1,13 +1,9 @@
 import { Languages } from "../enums";
-export declare namespace UserDetails {
-    namespace Types {
-        interface IUserDetails {
-            name?: string;
-            email: string;
-            research_consent: Date | null;
-            newsletter_consent: Date | null;
-            country?: string;
-            language?: keyof typeof Languages;
-        }
-    }
+export interface IUserDetails {
+    name?: string;
+    email: string;
+    research_consent: Date | null;
+    newsletter_consent: Date | null;
+    country?: string;
+    language?: keyof typeof Languages;
 }

package/dist/v1/usersettings/usersettings.d.ts

@@ -1,130 +1,124 @@
-import { Activity } from "../activity/activity";
+import { ActivitySettings } from "../activity/activity";
 import { BloodGlucoseUnit, BloodKetonesUnit } from "../enums";
-export declare namespace UserSettings {
-    namespace Types {
-        interface IUserSettings {
-            diabetesType?: Enums.DiabetesType;
-            insulinDependent?: boolean;
-            gender?: Enums.Gender;
-            height?: number;
-            email?: string;
-            weight?: number;
-            birthday?: string;
-            treatmentType?: Enums.InjectionMethod;
-            bloodGlucoseUnits?: BloodGlucoseUnit;
-            bloodKetonesUnit?: BloodKetonesUnit;
-            parameters?: IParameters;
-            glucoseLevelTargets?: IBGLTargets;
-            fastActingInsulin?: Enums.FastActingInsulin;
-            longActingInsulin?: Enums.LongActingInsulin;
-            uuidOld?: string;
-            uuid?: string;
-            created?: string;
-            activity?: Activity.Types.ActivitySettings;
-            notifications?: IUSerSettingsNotifications;
-        }
-        interface IUserSettingsPostgresRaw {
-            id: number;
-            uuid: string;
-            user_id: number;
-            created_date: string;
-            client_created_date: string;
-            diabetes_type: Enums.DiabetesType;
-            insulin_dependent: boolean;
-            gender: Enums.Gender;
-            height: number;
-            weight: number;
-            date_of_birth: string;
-            injection_method: Enums.InjectionMethod;
-            bgl_units: BloodGlucoseUnit;
-            blood_ketones_unit: BloodKetonesUnit;
-            fast_acting_insulin: string;
-            long_acting_insulin: string;
-            treatment_parameters: IUserSettings["parameters"];
-            bgl_targets: IUserSettings["glucoseLevelTargets"];
-            activity: IUserSettings["activity"];
-            notifications: IUserSettings["notifications"];
-        }
-        interface IUSerSettingsNotifications {
-            medicineNotification: IMedicineNotification;
-            remeasurementNotification: IRemeasurementNotification;
-            deviceIdentifiers?: Array<INotificationDeviceIdentifier>;
-        }
-        interface INotifications {
-            toggle: boolean;
-        }
-        interface IMedicineNotification extends INotifications {
-            dailyReminderTime: string;
-        }
-        interface IRemeasurementNotification extends INotifications {
-            remeasurement: number;
-        }
-        interface IInterval {
-            startTime: string;
-        }
-        interface IParameters {
-            parameterIntervals: Array<IParameterInterval>;
-            overallParameters: IParameterInterval;
-            use?: Enums.Usage;
-        }
-        interface IParameterInterval extends IInterval {
-            insulinSensitivity: number;
-            carbohydrateRatio: number;
-        }
-        interface IBGLTargets {
-            targetBGLIntervals?: Array<IBGLInterval>;
-            overallTargetBGL?: IBGLInterval;
-            use?: Enums.Usage;
-        }
-        interface IBGLInterval extends IInterval {
-            low: number;
-            target: number;
-            high: number;
-        }
-        interface INotificationDeviceIdentifier {
-            token: string;
-            timestamp: number;
-        }
-    }
-    namespace Enums {
-        enum Usage {
-            Overall = "overall",
-            Intervals = "intervals"
-        }
-        enum FastActingInsulin {
-            Novorapid = "Novorapid",
-            Fiasp = "Fiasp",
-            Humalog = "Humalog",
-            Apidra = "Apidra",
-            Other = "Other",
-            None = "None"
-        }
-        enum LongActingInsulin {
-            Lantus = "Lantus",
-            Basaglar = "Basaglar",
-            Tuojeo = "Tuojeo",
-            Levemir = "Levemir",
-            Tresiba = "Tresiba",
-            Other = "Other",
-            None = "None"
-        }
-        enum DiabetesType {
-            Type1 = 1,
-            Type2 = 2
-        }
-        enum Gender {
-            Male = "Male",
-            Female = "Female",
-            Unspecified = "Unspecified"
-        }
-        /**
-         * 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",
-            Pump = "Pump"
-        }
-    }
+export interface IUserSettings {
+    diabetesType?: DiabetesType;
+    insulinDependent?: boolean;
+    gender?: Gender;
+    height?: number;
+    email?: string;
+    weight?: number;
+    birthday?: string;
+    treatmentType?: InjectionMethod;
+    bloodGlucoseUnits?: BloodGlucoseUnit;
+    bloodKetonesUnit?: BloodKetonesUnit;
+    parameters?: IParameters;
+    glucoseLevelTargets?: IBGLTargets;
+    fastActingInsulin?: FastActingInsulin;
+    longActingInsulin?: LongActingInsulin;
+    uuidOld?: string;
+    uuid?: string;
+    created?: string;
+    activity?: ActivitySettings;
+    notifications?: IUSerSettingsNotifications;
+}
+export interface IUserSettingsPostgresRaw {
+    id: number;
+    uuid: string;
+    user_id: number;
+    created_date: string;
+    client_created_date: string;
+    diabetes_type: DiabetesType;
+    insulin_dependent: boolean;
+    gender: Gender;
+    height: number;
+    weight: number;
+    date_of_birth: string;
+    injection_method: InjectionMethod;
+    bgl_units: BloodGlucoseUnit;
+    blood_ketones_unit: BloodKetonesUnit;
+    fast_acting_insulin: string;
+    long_acting_insulin: string;
+    treatment_parameters: IUserSettings["parameters"];
+    bgl_targets: IUserSettings["glucoseLevelTargets"];
+    activity: IUserSettings["activity"];
+    notifications: IUserSettings["notifications"];
+}
+export interface IUSerSettingsNotifications {
+    medicineNotification: IMedicineNotification;
+    remeasurementNotification: IRemeasurementNotification;
+    deviceIdentifiers?: INotificationDeviceIdentifier[];
+}
+export interface INotifications {
+    toggle: boolean;
+}
+export interface IMedicineNotification extends INotifications {
+    dailyReminderTime: string;
+}
+export interface IRemeasurementNotification extends INotifications {
+    remeasurement: number;
+}
+export interface IInterval {
+    startTime: string;
+}
+export interface IParameters {
+    parameterIntervals: IParameterInterval[];
+    overallParameters: IParameterInterval;
+    use?: Usage;
+}
+export interface IParameterInterval extends IInterval {
+    insulinSensitivity: number;
+    carbohydrateRatio: number;
+}
+export interface IBGLTargets {
+    targetBGLIntervals?: IBGLInterval[];
+    overallTargetBGL?: IBGLInterval;
+    use?: Usage;
+}
+export interface IBGLInterval extends IInterval {
+    low: number;
+    target: number;
+    high: number;
+}
+export interface INotificationDeviceIdentifier {
+    token: string;
+    timestamp: number;
+}
+export declare enum Usage {
+    Overall = "overall",
+    Intervals = "intervals"
+}
+export declare enum FastActingInsulin {
+    Novorapid = "Novorapid",
+    Fiasp = "Fiasp",
+    Humalog = "Humalog",
+    Apidra = "Apidra",
+    Other = "Other",
+    None = "None"
+}
+export declare enum LongActingInsulin {
+    Lantus = "Lantus",
+    Basaglar = "Basaglar",
+    Tuojeo = "Tuojeo",
+    Levemir = "Levemir",
+    Tresiba = "Tresiba",
+    Other = "Other",
+    None = "None"
+}
+export declare enum DiabetesType {
+    Type1 = 1,
+    Type2 = 2
+}
+export declare enum Gender {
+    Male = "Male",
+    Female = "Female",
+    Unspecified = "Unspecified"
+}
+/**
+ * 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 declare enum InjectionMethod {
+    PenHalf = "Pen-half",
+    PenWhole = "Pen-whole",
+    Pump = "Pump"
 }