@hedia/types 3.12.4-alpha.350 → 3.12.6-alpha.353

package/README.md

@@ -1,6 +1,108 @@
-# **Hedia types**
+# @hedia/types
 
-### **Auto-publishing to npm as an alpha-version package**
+Shared TypeScript enums, interfaces, and constants used across Hedia's software. Published to npm as [`@hedia/types`](https://www.npmjs.com/package/@hedia/types).
 
-In order to easily test our npm packages, auto-publishing of an alpha version to npm has been implemented.
-This will allow testers to easily install and test npm packages as they’ll be automatically published to npm at the moment of creating a Pull Request on GitHub.
+This package contains **types only**. It has no runtime dependencies and ships as CommonJS with TypeScript declarations.
+
+## Installation
+
+```sh
+npm install @hedia/types
+```
+
+Pin the exact version in consuming projects, as this repo does with its own dependencies.
+
+## Usage
+
+```ts
+import { BloodGlucoseUnit, DiabetesType, IUserSettings } from "@hedia/types";
+
+const settings: IUserSettings = {
+	// ...
+};
+
+if (unit === BloodGlucoseUnit.MMOL_L) {
+	// ...
+}
+```
+
+Everything is exported from the package root via [`src/index.ts`](src/index.ts).
+
+## What's included
+
+| Module                                                      | Contents                                                                                               |
+| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| [`activity`](src/activity/activity.ts)                      | Activity entries, intensity and reduction interval enums, activity settings                            |
+| [`boluscalculator`](src/boluscalculator/boluscalculator.ts) | Bolus calculator constants, error enums, recommendation params and result                              |
+| [`logbook`](src/logbook/logbook.ts)                         | Logbook entries, mood enum, client/backend sync objects                                                |
+| [`userdetails`](src/userdetails/userdetails.ts)             | User details                                                                                           |
+| [`usersettings`](src/usersettings/usersettings.ts)          | User settings, notifications, BGL targets, insulin, diabetes type, and related enums                   |
+| [`enums`](src/enums.ts)                                     | Cross-cutting enums: glucose and ketone units, insulin units, languages, HTTP status codes and methods |
+
+Types prefixed with `Legacy` describe older data shapes still present in stored data and should not be used for new code.
+
+## Development
+
+Requires Node `>=22.14.0` (see `engines` in `package.json`).
+
+```sh
+npm ci
+npm run validate
+```
+
+`validate` runs everything CI runs:
+
+| Script                              | What it does                                                    |
+| ----------------------------------- | --------------------------------------------------------------- |
+| `npm run tsc`                       | Type-check without emitting                                     |
+| `npm run eslint` / `eslint:fix`     | Lint with `@hedia/eslint-config`                                |
+| `npm run prettier` / `prettier:fix` | Check or fix formatting with `@hedia/prettier-config`           |
+| `npm run pkg-json-lint`             | Lint `package.json` (exact versions, alphabetical dependencies) |
+| `npm audit --audit-level=critical`  | Fail on critical vulnerabilities                                |
+
+### Conventions
+
+- Prefer `interface` over `type` for object shapes (enforced by ESLint).
+- Enum members must be literal values (enforced by ESLint).
+- Dependencies are pinned to exact versions, no `^` or `~`, and kept in alphabetical order (enforced by npm-package-json-lint).
+- Source lives in `src/`. The build output in `lib/` is generated and git-ignored.
+
+### Build
+
+The build runs automatically on `npm pack` / `npm publish` via the `prepack` hook. To build manually:
+
+```sh
+npx bob build
+```
+
+[react-native-builder-bob](https://github.com/callstack/react-native-builder-bob) emits `lib/commonjs` (JavaScript) and `lib/typescript` (declarations). Both `lib/` and `src/` are included in the published package so source maps resolve.
+
+## Releasing
+
+Publishing is fully automated by [`.github/workflows/ci.yaml`](.github/workflows/ci.yaml). **Do not bump the version manually.**
+
+### Pull requests
+
+1. Branch from `master` and open a PR. The title must reference a Jira ticket, e.g. `HDAM-1234 Add ketone thresholds`. An optional `[x.y.z] - ` or `[Anytime] - ` prefix is allowed. Draft PRs skip this check.
+2. Add a `major` or `minor` label to control the version bump. With no label the bump is `patch`.
+3. On every push CI runs `validate`, then:
+    - commits the bumped version to the PR branch as `chore: bump version to x.y.z [skip ci]`
+    - publishes `x.y.z-alpha.<run>` to npm under the `alpha` dist-tag
+    - comments the install command on the PR
+
+Pull the branch after CI runs so you pick up the version bump commit before pushing again.
+
+### Testing an alpha
+
+```sh
+npm install @hedia/types@3.12.5-alpha.352   # exact version from the PR comment
+npm install @hedia/types@alpha              # latest alpha
+```
+
+### Release
+
+Merging to `master` publishes the version in `package.json` as `latest`, creates a `vX.Y.Z` git tag, and creates a GitHub release. If that version is already on npm the publish is skipped.
+
+## License
+
+UNLICENSED. This package is published publicly for distribution convenience only. All rights reserved by Hedia.

package/lib/commonjs/boluscalculator/boluscalculator.js

@@ -31,12 +31,12 @@ const CONSTANTS = exports.CONSTANTS = {
   ACTIVITY_DURATION_MAX: 120,
   /** The minimum insulin sensitivity setting in mmol/L per unit. (0.277) */
   INSULIN_SENSITIVITY_MIN: 0.277,
-  /** The maximum insulin sensitivity setting in mmol/L per unit. (21.815, equal to 393 mg/dL per unit) */
-  INSULIN_SENSITIVITY_MAX: 21.815,
+  /** The maximum insulin sensitivity setting in mmol/L per unit. (10.935) */
+  INSULIN_SENSITIVITY_MAX: 10.935,
   /** The minimum insulin-to-carbs ratio. (1.4 g/U) */
   INSULIN_TO_CARBS_RATIO_MIN: 1.4,
-  /** The maximum insulin-to-carbs ratio. (100 g/U) */
-  INSULIN_TO_CARBS_RATIO_MAX: 100,
+  /** The maximum insulin-to-carbs ratio. (50 g/U) */
+  INSULIN_TO_CARBS_RATIO_MAX: 50,
   /** The minimum valid glucose target in mmol/L. (4.385 mmol/L) */
   TARGET_GLUCOSE_MIN: 4.385,
   /** The maximum valid glucose target in mmol/L. (10 mmol/L) */

package/lib/commonjs/boluscalculator/boluscalculator.js.map

@@ -1 +1 @@
-{"version":3,"names":["CONSTANTS","exports","GLUCOSE_INPUT_MIN_MMOLL","GLUCOSE_INPUT_MAX_MMOLL","CARBOHYDRATES_INPUT_MIN","CARBOHYDRATES_INPUT_MAX","INSULIN_DOSE_MIN","INSULIN_DOSE_MAX","BOLUS_SECONDS_MIN","BOLUS_SECONDS_MAX","ACTIVITY_REDUCTION_MAX","ACTIVITY_REDUCTION_MIN","ACTIVITY_DURATION_MIN","ACTIVITY_DURATION_MAX","INSULIN_SENSITIVITY_MIN","INSULIN_SENSITIVITY_MAX","INSULIN_TO_CARBS_RATIO_MIN","INSULIN_TO_CARBS_RATIO_MAX","TARGET_GLUCOSE_MIN","TARGET_GLUCOSE_MAX","ACTIVITY_TARGET_GLUCOSE_MIN","ACTIVITY_TARGET_GLUCOSE_MAX","MGDL_PER_MMOLL_BGL","MMOLL_PER_MGDL_BGL","SEVERE_HYPERGLYCEMIA_MAX","SEVERE_HYPOGLYCEMIA_MIN","LEVEL_ONE_HYPOGLYCEMIA_MAX","LEVEL_ONE_HYPOGLYCEMIA_MIN","LEVEL_TWO_HYPOGLYCEMIA_MAX","LEVEL_TWO_HYPOGLYCEMIA_MIN","LOW_GLUCOSE_MESSAGE_ACTIVITY_MIN","LOW_GLUCOSE_MESSAGE_ACTIVITY_MAX","HIGH_GLUCOSE_MESSAGE_ACTIVITY_MIN","HIGH_GLUCOSE_MESSAGE_ACTIVITY_MAX","ActivityErrors","GlucoseErrors"],"sourceRoot":"../../../src","sources":["boluscalculator/boluscalculator.ts"],"mappings":";;;;;;AAGO,MAAMA,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG;EACxB;EACAE,uBAAuB,EAAE,GAAG;EAE5B;EACAC,uBAAuB,EAAE,QAAQ;EAEjC;EACAC,uBAAuB,EAAE,CAAC;EAE1B;EACAC,uBAAuB,EAAE,GAAG;EAE5B;EACAC,gBAAgB,EAAE,CAAC;EAEnB;EACAC,gBAAgB,EAAE,EAAE;EAEpB;EACAC,iBAAiB,EAAE,CAAC;EAEpB;EACAC,iBAAiB,EAAE,KAAK;EAExB;EACAC,sBAAsB,EAAE,CAAC;EAEzB;EACAC,sBAAsB,EAAE,CAAC;EAEzB;EACAC,qBAAqB,EAAE,CAAC;EAExB;EACAC,qBAAqB,EAAE,GAAG;EAE1B;EACAC,uBAAuB,EAAE,KAAK;EAE9B;EACAC,uBAAuB,EAAE,MAAM;EAE/B;EACAC,0BAA0B,EAAE,GAAG;EAE/B;EACAC,0BAA0B,EAAE,GAAG;EAE/B;EACAC,kBAAkB,EAAE,KAAK;EAEzB;EACAC,kBAAkB,EAAE,EAAE;EAEtB;EACAC,2BAA2B,EAAE,KAAK;EAElC;EACAC,2BAA2B,EAAE,IAAI;EAEjC;EACAC,kBAAkB,EAAE,OAAO;EAE3B;EACAC,kBAAkB,EAAE,oBAAoB;EAExC;EACAC,wBAAwB,EAAE,QAAQ;EAElC;EACAC,uBAAuB,EAAE,EAAE;EAE3B;EACAC,0BAA0B,EAAE,KAAK;EAEjC;EACAC,0BAA0B,EAAE,KAAK;EAEjC;EACAC,0BAA0B,EAAE,KAAK;EAEjC;EACAC,0BAA0B,EAAE,GAAG;EAE/B;EACAC,gCAAgC,EAAE,GAAG;EAErC;EACAC,gCAAgC,EAAE,CAAC;EAEnC;EACAC,iCAAiC,EAAE,MAAM;EAEzC;EACAC,iCAAiC,EAAE;AACpC,CAAC;;AAED;AAAA,IACYC,cAAc,GAAAjC,OAAA,CAAAiC,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAO1B;AAAA,IACYC,aAAa,GAAAlC,OAAA,CAAAkC,aAAA,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAkDzB;AAUA;AAYA;AAkBA;AACA;AACA;AACA","ignoreList":[]}
+{"version":3,"names":["CONSTANTS","exports","GLUCOSE_INPUT_MIN_MMOLL","GLUCOSE_INPUT_MAX_MMOLL","CARBOHYDRATES_INPUT_MIN","CARBOHYDRATES_INPUT_MAX","INSULIN_DOSE_MIN","INSULIN_DOSE_MAX","BOLUS_SECONDS_MIN","BOLUS_SECONDS_MAX","ACTIVITY_REDUCTION_MAX","ACTIVITY_REDUCTION_MIN","ACTIVITY_DURATION_MIN","ACTIVITY_DURATION_MAX","INSULIN_SENSITIVITY_MIN","INSULIN_SENSITIVITY_MAX","INSULIN_TO_CARBS_RATIO_MIN","INSULIN_TO_CARBS_RATIO_MAX","TARGET_GLUCOSE_MIN","TARGET_GLUCOSE_MAX","ACTIVITY_TARGET_GLUCOSE_MIN","ACTIVITY_TARGET_GLUCOSE_MAX","MGDL_PER_MMOLL_BGL","MMOLL_PER_MGDL_BGL","SEVERE_HYPERGLYCEMIA_MAX","SEVERE_HYPOGLYCEMIA_MIN","LEVEL_ONE_HYPOGLYCEMIA_MAX","LEVEL_ONE_HYPOGLYCEMIA_MIN","LEVEL_TWO_HYPOGLYCEMIA_MAX","LEVEL_TWO_HYPOGLYCEMIA_MIN","LOW_GLUCOSE_MESSAGE_ACTIVITY_MIN","LOW_GLUCOSE_MESSAGE_ACTIVITY_MAX","HIGH_GLUCOSE_MESSAGE_ACTIVITY_MIN","HIGH_GLUCOSE_MESSAGE_ACTIVITY_MAX","ActivityErrors","GlucoseErrors"],"sourceRoot":"../../../src","sources":["boluscalculator/boluscalculator.ts"],"mappings":";;;;;;AAGO,MAAMA,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG;EACxB;EACAE,uBAAuB,EAAE,GAAG;EAE5B;EACAC,uBAAuB,EAAE,QAAQ;EAEjC;EACAC,uBAAuB,EAAE,CAAC;EAE1B;EACAC,uBAAuB,EAAE,GAAG;EAE5B;EACAC,gBAAgB,EAAE,CAAC;EAEnB;EACAC,gBAAgB,EAAE,EAAE;EAEpB;EACAC,iBAAiB,EAAE,CAAC;EAEpB;EACAC,iBAAiB,EAAE,KAAK;EAExB;EACAC,sBAAsB,EAAE,CAAC;EAEzB;EACAC,sBAAsB,EAAE,CAAC;EAEzB;EACAC,qBAAqB,EAAE,CAAC;EAExB;EACAC,qBAAqB,EAAE,GAAG;EAE1B;EACAC,uBAAuB,EAAE,KAAK;EAE9B;EACAC,uBAAuB,EAAE,MAAM;EAE/B;EACAC,0BAA0B,EAAE,GAAG;EAE/B;EACAC,0BAA0B,EAAE,EAAE;EAE9B;EACAC,kBAAkB,EAAE,KAAK;EAEzB;EACAC,kBAAkB,EAAE,EAAE;EAEtB;EACAC,2BAA2B,EAAE,KAAK;EAElC;EACAC,2BAA2B,EAAE,IAAI;EAEjC;EACAC,kBAAkB,EAAE,OAAO;EAE3B;EACAC,kBAAkB,EAAE,oBAAoB;EAExC;EACAC,wBAAwB,EAAE,QAAQ;EAElC;EACAC,uBAAuB,EAAE,EAAE;EAE3B;EACAC,0BAA0B,EAAE,KAAK;EAEjC;EACAC,0BAA0B,EAAE,KAAK;EAEjC;EACAC,0BAA0B,EAAE,KAAK;EAEjC;EACAC,0BAA0B,EAAE,GAAG;EAE/B;EACAC,gCAAgC,EAAE,GAAG;EAErC;EACAC,gCAAgC,EAAE,CAAC;EAEnC;EACAC,iCAAiC,EAAE,MAAM;EAEzC;EACAC,iCAAiC,EAAE;AACpC,CAAC;;AAED;AAAA,IACYC,cAAc,GAAAjC,OAAA,CAAAiC,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;AAO1B;AAAA,IACYC,aAAa,GAAAlC,OAAA,CAAAkC,aAAA,0BAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAbA,aAAa;EAAA,OAAbA,aAAa;AAAA;AAkDzB;AAUA;AAYA;AAkBA;AACA;AACA;AACA","ignoreList":[]}

package/lib/typescript/boluscalculator/boluscalculator.d.ts

@@ -27,11 +27,11 @@ export declare const CONSTANTS: {
     ACTIVITY_DURATION_MAX: number;
     /** The minimum insulin sensitivity setting in mmol/L per unit. (0.277) */
     INSULIN_SENSITIVITY_MIN: number;
-    /** The maximum insulin sensitivity setting in mmol/L per unit. (21.815, equal to 393 mg/dL per unit) */
+    /** The maximum insulin sensitivity setting in mmol/L per unit. (10.935) */
     INSULIN_SENSITIVITY_MAX: number;
     /** The minimum insulin-to-carbs ratio. (1.4 g/U) */
     INSULIN_TO_CARBS_RATIO_MIN: number;
-    /** The maximum insulin-to-carbs ratio. (100 g/U) */
+    /** The maximum insulin-to-carbs ratio. (50 g/U) */
     INSULIN_TO_CARBS_RATIO_MAX: number;
     /** The minimum valid glucose target in mmol/L. (4.385 mmol/L) */
     TARGET_GLUCOSE_MIN: number;

package/lib/typescript/boluscalculator/boluscalculator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"boluscalculator.d.ts","sourceRoot":"","sources":["../../../src/boluscalculator/boluscalculator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD,eAAO,MAAM,SAAS;IACrB,oFAAoF;;IAGpF,yFAAyF;;IAGzF,sEAAsE;;IAGtE,wEAAwE;;IAGxE,mDAAmD;;IAGnD,oDAAoD;;IAGpD,qDAAqD;;IAGrD,oEAAoE;;IAGpE,gEAAgE;;IAGhE,gEAAgE;;IAGhE,8DAA8D;;IAG9D,gEAAgE;;IAGhE,0EAA0E;;IAG1E,wGAAwG;;IAGxG,oDAAoD;;IAGpD,oDAAoD;;IAGpD,iEAAiE;;IAGjE,8DAA8D;;IAG9D,0EAA0E;;IAG1E,yEAAyE;;IAGzE,yGAAyG;;IAGzG,sHAAsH;;IAGtH,kHAAkH;;IAGlH,gHAAgH;;IAGhH,iHAAiH;;IAGjH,iHAAiH;;IAGjH,qHAAqH;;IAGrH,mHAAmH;;IAGnH,uIAAuI;;IAGvI,oIAAoI;;IAGpI,0IAA0I;;IAG1I,wIAAwI;;CAExI,CAAC;AAEF,iEAAiE;AACjE,oBAAY,cAAc;IACzB,kBAAkB,0BAA0B;IAC5C,eAAe,uCAAuC;IACtD,gBAAgB,+BAA+B;IAC/C,gBAAgB,+BAA+B;CAC/C;AAED,gEAAgE;AAChE,oBAAY,aAAa;IACxB,qBAAqB,4BAA4B;IACjD,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,oBAAoB,6BAA6B;CACjD;AAED,UAAU,kBAAkB;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,KAAK,oBAAoB,GAAG,kBAAkB,GAAG;IAChD,MAAM,EAAE,QAAQ,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,sBAAsB,GAAG,kBAAkB,GAAG;IAClD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,sBAAsB,GAAG,kBAAkB,GAAG;IAClD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,iBAAiB,GAAG,kBAAkB,GAAG;IAC7C,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,oBAAoB,GAAG,kBAAkB,GAAG;IAChD,MAAM,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,cAAc,GACvB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,CAAC;AAExB,2GAA2G;AAC3G,MAAM,WAAW,YAAY;IAC5B,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAC;IACtB,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,EAAE,EAAE,MAAM,CAAC;CACX;AAED,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC/B,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAC;IACzB,oCAAoC;IACpC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC5C,wDAAwD;IACxD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,2CAA2C;IAC3C,YAAY,EAAE,IAAI,CAAC;CACnB;AAED,sFAAsF;AACtF,MAAM,WAAW,qBAAqB;IACrC,uDAAuD;IACvD,cAAc,EAAE,cAAc,CAAC;IAC/B,uIAAuI;IACvI,SAAS,EAAE,MAAM,CAAC;IAClB,qGAAqG;IACrG,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iGAAiG;IACjG,aAAa,EAAE,MAAM,CAAC;IACtB,iGAAiG;IACjG,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sDAAsD;IACtD,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,8FAA8F;IAC9F,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,0DAA0D;IAC1D,aAAa,EAAE,MAAM,CAAC;IACtB,2GAA2G;IAC3G,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gEAAgE;IAChE,kBAAkB,EAAE,IAAI,CAAC;CACzB"}
+{"version":3,"file":"boluscalculator.d.ts","sourceRoot":"","sources":["../../../src/boluscalculator/boluscalculator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAChF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAEjD,eAAO,MAAM,SAAS;IACrB,oFAAoF;;IAGpF,yFAAyF;;IAGzF,sEAAsE;;IAGtE,wEAAwE;;IAGxE,mDAAmD;;IAGnD,oDAAoD;;IAGpD,qDAAqD;;IAGrD,oEAAoE;;IAGpE,gEAAgE;;IAGhE,gEAAgE;;IAGhE,8DAA8D;;IAG9D,gEAAgE;;IAGhE,0EAA0E;;IAG1E,2EAA2E;;IAG3E,oDAAoD;;IAGpD,mDAAmD;;IAGnD,iEAAiE;;IAGjE,8DAA8D;;IAG9D,0EAA0E;;IAG1E,yEAAyE;;IAGzE,yGAAyG;;IAGzG,sHAAsH;;IAGtH,kHAAkH;;IAGlH,gHAAgH;;IAGhH,iHAAiH;;IAGjH,iHAAiH;;IAGjH,qHAAqH;;IAGrH,mHAAmH;;IAGnH,uIAAuI;;IAGvI,oIAAoI;;IAGpI,0IAA0I;;IAG1I,wIAAwI;;CAExI,CAAC;AAEF,iEAAiE;AACjE,oBAAY,cAAc;IACzB,kBAAkB,0BAA0B;IAC5C,eAAe,uCAAuC;IACtD,gBAAgB,+BAA+B;IAC/C,gBAAgB,+BAA+B;CAC/C;AAED,gEAAgE;AAChE,oBAAY,aAAa;IACxB,qBAAqB,4BAA4B;IACjD,kBAAkB,yBAAyB;IAC3C,mBAAmB,0BAA0B;IAC7C,oBAAoB,6BAA6B;CACjD;AAED,UAAU,kBAAkB;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,KAAK,oBAAoB,GAAG,kBAAkB,GAAG;IAChD,MAAM,EAAE,QAAQ,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,sBAAsB,GAAG,kBAAkB,GAAG;IAClD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,sBAAsB,GAAG,kBAAkB,GAAG;IAClD,MAAM,EAAE,UAAU,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,iBAAiB,GAAG,kBAAkB,GAAG;IAC7C,MAAM,EAAE,KAAK,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,oBAAoB,GAAG,kBAAkB,GAAG;IAChD,MAAM,EAAE,QAAQ,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,cAAc,GACvB,oBAAoB,GACpB,sBAAsB,GACtB,sBAAsB,GACtB,iBAAiB,GACjB,oBAAoB,CAAC;AAExB,2GAA2G;AAC3G,MAAM,WAAW,YAAY;IAC5B,0FAA0F;IAC1F,aAAa,EAAE,MAAM,CAAC;IACtB,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,EAAE,EAAE,MAAM,CAAC;CACX;AAED,yCAAyC;AACzC,MAAM,WAAW,eAAe;IAC/B,wDAAwD;IACxD,gBAAgB,EAAE,MAAM,CAAC;IACzB,oCAAoC;IACpC,iBAAiB,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC5C,wDAAwD;IACxD,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,2CAA2C;IAC3C,YAAY,EAAE,IAAI,CAAC;CACnB;AAED,sFAAsF;AACtF,MAAM,WAAW,qBAAqB;IACrC,uDAAuD;IACvD,cAAc,EAAE,cAAc,CAAC;IAC/B,uIAAuI;IACvI,SAAS,EAAE,MAAM,CAAC;IAClB,qGAAqG;IACrG,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iGAAiG;IACjG,aAAa,EAAE,MAAM,CAAC;IACtB,iGAAiG;IACjG,iBAAiB,EAAE,MAAM,CAAC;IAC1B,sDAAsD;IACtD,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,8FAA8F;IAC9F,QAAQ,EAAE,eAAe,GAAG,IAAI,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACrC,2DAA2D;IAC3D,KAAK,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB,8DAA8D;IAC9D,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,0DAA0D;IAC1D,aAAa,EAAE,MAAM,CAAC;IACtB,2GAA2G;IAC3G,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,gEAAgE;IAChE,kBAAkB,EAAE,IAAI,CAAC;CACzB"}

package/package.json

@@ -1,19 +1,18 @@
 {
 	"name": "@hedia/types",
-	"version": "3.12.4-alpha.350",
+	"version": "3.12.6-alpha.353",
 	"description": "Enums, interfaces, and other common types for use in Hedia's software.",
 	"main": "lib/commonjs/index.js",
 	"types": "lib/typescript/index.d.ts",
 	"engines": {
 		"node": ">=22.14.0"
 	},
-	"repository": {
-		"type": "git",
-		"url": "git+ssh://git@github.com:hedia-team/hedia-types.git"
-	},
+	"repository": "github:hedia-team/hedia-types",
 	"files": [
-		"lib"
+		"lib",
+		"src"
 	],
+	"sideEffects": false,
 	"scripts": {
 		"tsc": "tsc --noEmit",
 		"eslint": "eslint .",
@@ -24,10 +23,8 @@
 		"validate": "npm run tsc && npm run eslint && npm run prettier && npm run pkg-json-lint && npm audit --audit-level=critical",
 		"prepack": "bob build"
 	},
-	"keywords": [],
 	"author": "Hedia",
-	"license": "ISC",
-	"homepage": "https://github.com/hedia-team/hedia-types#readme",
+	"license": "UNLICENSED",
 	"devDependencies": {
 		"@hedia/eslint-config": "6.0.7",
 		"@hedia/prettier-config": "1.2.9",

package/src/activity/activity.ts

@@ -0,0 +1,83 @@
+export interface IActivityEntry {
+	uuid: string;
+	type: ActivityEnum | null;
+	activityIntensity: ActivityIntensity | null;
+	durationSeconds: number;
+	startTimestamp: string | null;
+	deleted: boolean;
+	uuidOld?: IActivityEntry["uuid"];
+	overwrittenByUUID?: IActivityEntry["uuid"];
+}
+
+/** 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",
+	fromSixtyone = "fromSixtyone",
+}
+
+/** 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",
+	Cycling = "Cycling",
+	Swim = "Swim",
+	Other = "Other",
+	Sport = "Sport",
+	Workout = "Workout",
+}
+
+/**
+ * Represents whether the reduction fraction is a number or it is null.
+ * For the settings of hard physical activities over 45 minutes the value is null.
+ * For physical activities over 60 minutes the value is also null
+ * A null value represents that it is not supported by HDA but users can still set it.
+ */
+type ReductionValue<
+	Intensity extends ActivityIntensity,
+	Interval extends ActivityReductionIntervals,
+> = Interval extends ActivityReductionIntervals.fromSixtyone
+	? number | null
+	: Intensity extends ActivityIntensity.hard
+		? Interval extends ActivityReductionIntervals.fromFortysix
+			? number | null
+			: number
+		: number;
+
+type ActivityReductionMatrix = {
+	[I in ActivityIntensity]: {
+		[J in ActivityReductionIntervals]: ReductionValue<I, J>;
+	};
+};
+
+type PostReductionValue<Interval extends ActivityReductionIntervals> =
+	Interval extends ActivityReductionIntervals.fromSixtyone ? number | null : number;
+
+interface ActivityPostReduction {
+	post: { [Interval in ActivityReductionIntervals]: PostReductionValue<Interval> };
+}
+
+/** Type that represents the user’s settings related to physical activity. */
+export interface ActivitySettings extends ActivityPostReduction, ActivityReductionMatrix {
+	target: number;
+	updatedAt?: string; // ISO string
+}
+
+/**
+ * Legacy activity settings type that allows fromSixtyone to be undefined for types backward compatibility
+ * TODO: Can be removed when 3.5.0 is the minimum supported version.
+ */
+export type LegacyActivitySettings = Omit<ActivitySettings, "hard" | "moderate" | "light" | "post"> & {
+	hard: Omit<ActivitySettings["hard"], "fromSixtyone"> & { fromSixtyone?: number | null };
+	moderate: Omit<ActivitySettings["moderate"], "fromSixtyone"> & { fromSixtyone?: number | null };
+	light: Omit<ActivitySettings["light"], "fromSixtyone"> & { fromSixtyone?: number | null };
+	post: Omit<ActivitySettings["post"], "fromSixtyone"> & { fromSixtyone?: number | null };
+};

package/src/boluscalculator/boluscalculator.ts

@@ -0,0 +1,226 @@
+import type { ActivityIntensity, ActivitySettings } from "../activity/activity";
+import type { BloodGlucoseUnit } from "../enums";
+
+export const CONSTANTS = {
+	/** The minimum blood glucose level that may be entered by the user. (1.1 mmol/L) */
+	GLUCOSE_INPUT_MIN_MMOLL: 1.1,
+
+	/** The maximum blood glucose level that may be entered by the user. (33.30449 mmol/L) */
+	GLUCOSE_INPUT_MAX_MMOLL: 33.30449,
+
+	/** The lower limit for the amount of carbohydrates in grams. (0 g) */
+	CARBOHYDRATES_INPUT_MIN: 0,
+
+	/** The upper limit for the amount of carbohydrates in grams. (300 g) */
+	CARBOHYDRATES_INPUT_MAX: 300,
+
+	/** The minimum insulin dose in units. (0 units) */
+	INSULIN_DOSE_MIN: 0,
+
+	/** The maximum insulin dose in units. (60 units) */
+	INSULIN_DOSE_MAX: 60,
+
+	/** The minimum age of boluses in seconds. (0 sec) */
+	BOLUS_SECONDS_MIN: 0,
+
+	/** The maximum age of boluses in seconds. (14400 sec or 4 hours) */
+	BOLUS_SECONDS_MAX: 14400,
+
+	/** The maximum reduction factor for a physical activity. (1) */
+	ACTIVITY_REDUCTION_MAX: 1,
+
+	/** The minimum reduction factor for a physical activity. (0) */
+	ACTIVITY_REDUCTION_MIN: 0,
+
+	/** The minimum duration of an activity in minutes. (1 min) */
+	ACTIVITY_DURATION_MIN: 1,
+
+	/** The maximum duration of an activity in minutes. (120 min) */
+	ACTIVITY_DURATION_MAX: 120,
+
+	/** The minimum insulin sensitivity setting in mmol/L per unit. (0.277) */
+	INSULIN_SENSITIVITY_MIN: 0.277,
+
+	/** The maximum insulin sensitivity setting in mmol/L per unit. (10.935) */
+	INSULIN_SENSITIVITY_MAX: 10.935,
+
+	/** The minimum insulin-to-carbs ratio. (1.4 g/U) */
+	INSULIN_TO_CARBS_RATIO_MIN: 1.4,
+
+	/** The maximum insulin-to-carbs ratio. (50 g/U) */
+	INSULIN_TO_CARBS_RATIO_MAX: 50,
+
+	/** The minimum valid glucose target in mmol/L. (4.385 mmol/L) */
+	TARGET_GLUCOSE_MIN: 4.385,
+
+	/** The maximum valid glucose target in mmol/L. (10 mmol/L) */
+	TARGET_GLUCOSE_MAX: 10,
+
+	/** The minimum valid activity glucose target in mmol/L. (4.995 mmol/L) */
+	ACTIVITY_TARGET_GLUCOSE_MIN: 4.995,
+
+	/** The maximum valid activity glucose target in mmol/L. (13.9 mmol/L) */
+	ACTIVITY_TARGET_GLUCOSE_MAX: 13.9,
+
+	/** The conversion factor to multiply a blood glucose value with to go from mmol/L to mg/dL. (18.0156) */
+	MGDL_PER_MMOLL_BGL: 18.0156,
+
+	/** The conversion factor to multiply a blood glucose value with to go from mg/dL to mmol/L. (0.055507449099669176) */
+	MMOLL_PER_MGDL_BGL: 0.055507449099669176,
+
+	/** The maximum glucose value for providing the severe hyperglycemia attention message in mmol/L. (33.3 mmol/L) */
+	SEVERE_HYPERGLYCEMIA_MAX: 33.30449,
+
+	/** The minimum glucose value for providing the severe hyperglycemia attention message in mmol/L. (20 mmol/L) */
+	SEVERE_HYPOGLYCEMIA_MIN: 20,
+
+	/** The maximum glucose value for providing the mild hyperglycemia attention message in mmol/L. (3.831 mmol/L) */
+	LEVEL_ONE_HYPOGLYCEMIA_MAX: 3.831,
+
+	/** The minimum glucose value for providing the mild hyperglycemia attention message in mmol/L. (2.942 mmol/L) */
+	LEVEL_ONE_HYPOGLYCEMIA_MIN: 2.997,
+
+	/** The maximum glucose value for providing the moderate hyperglycemia attention message in mmol/L. (2.942 mmol/L) */
+	LEVEL_TWO_HYPOGLYCEMIA_MAX: 2.942,
+
+	/** The minimum glucose value for providing the moderate hyperglycemia attention message in mmol/L. (1.1 mmol/L) */
+	LEVEL_TWO_HYPOGLYCEMIA_MIN: 1.1,
+
+	/** The minimum glucose value in mmol/L for providing the low glucose message  when having an active physical activity. (1.1 mmol/L) */
+	LOW_GLUCOSE_MESSAGE_ACTIVITY_MIN: 1.1,
+
+	/** The maximum glucose value in mmol/L for providing the low glucose message when having an active physical activity. (5 mmol/L) */
+	LOW_GLUCOSE_MESSAGE_ACTIVITY_MAX: 5,
+
+	/** The minimum glucose value in mmol/L for providing the high glucose message when having an active physical activity. (13.932 mmol/L) */
+	HIGH_GLUCOSE_MESSAGE_ACTIVITY_MIN: 13.932,
+
+	/** The maximum glucose value in mmol/L for providing the high glucose message when having an active physical activity. (33.3 mmol/L) */
+	HIGH_GLUCOSE_MESSAGE_ACTIVITY_MAX: 33.30449,
+};
+
+/** Enum for differentiating between Activity types of errors. */
+export enum ActivityErrors {
+	OutOfRangeDuration = "Duration Out of range",
+	InvalidInterval = "Invalid activity settings interval",
+	InvalidReduction = "Invalid activity Reduction",
+	MissingIntensity = "Missing activity intensity",
+}
+
+/** Enum for differentiating between Glucose types of errors. */
+export enum GlucoseErrors {
+	MissingGlucoseReading = "Missing glucose reading",
+	InvalidGlucoseUnit = "Invalid glucose unit",
+	InvalidGlucoseValue = "Invalid glucose value",
+	OutOfRangeCurrentBGL = "Current BGL out of range",
+}
+
+interface BaseGlucoseReading {
+	id: string;
+	value: number;
+	unit: BloodGlucoseUnit;
+	timestamp: number;
+}
+
+type DeviceGlucoseReading = BaseGlucoseReading & {
+	source: "device";
+	deviceName: string;
+};
+
+type ExternalGlucoseReading = BaseGlucoseReading & {
+	source: "external";
+	sampleId: string;
+	sourceId: string;
+	sourceName: string;
+	deviceName: string;
+};
+
+type ForecastGlucoseReading = BaseGlucoseReading & {
+	source: "forecast";
+	sampleId: string;
+	sourceId: string;
+	sourceName: string;
+};
+
+type CgmGlucoseReading = BaseGlucoseReading & {
+	source: "cgm";
+	sourceName: string;
+};
+
+type ManualGlucoseReading = BaseGlucoseReading & {
+	source: "manual";
+};
+
+export type GlucoseReading =
+	| DeviceGlucoseReading
+	| ExternalGlucoseReading
+	| ForecastGlucoseReading
+	| CgmGlucoseReading
+	| ManualGlucoseReading;
+
+/** 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;
+	/** The unique identifier (UUID) of the bolus event. */
+	id: string;
+}
+
+/** Details about a physical activity. */
+export interface IActivityParams {
+	/** The duration of the physical activity in minutes. */
+	activityDuration: number;
+	/** The intensity of the activity */
+	activityIntensity: ActivityIntensity | null;
+	/** The user’s current settings for physical activity */
+	activitySettings: 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 */
+	glucoseReading: GlucoseReading;
+	/** 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: 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;
+	/** The unique identifiers (UUIDs) of the recent boluses that were used to calculate the active insulin. */
+	recentBolusesIds: string[];
+	/** The date and time when the recommendation was calculated. */
+	recommendationDate: Date;
+}