Merge pull request #38 from jy95/quantityImprovements

feat: improving rendering of quantity objects

__tests__/corner_cases.test.tsx

@@ -68,7 +68,7 @@ describe("Corner cases", () => {
     };
 
     let result = dosageUtils.fromDosageToText(dosage);
-    expect(result).toBe("42 ");
+    expect(result).toBe("42");
   });
 
   test("rateRatio - no denominator", () => {

src/locales/de/common.json

@@ -28,12 +28,15 @@
         "denominator_other": ":{{count}}"
       }
     },
-    "quantity": "{{quantity}} {{unit}}"
+    "quantity": {
+      "withUnit": "{{quantity}} {{unit}}",
+      "withoutUnit": "{{quantity}}"
+    }
   },
   "fields": {
-    "doseQuantity": "{{quantity}} {{unit}}",
+    "doseQuantity": "{{quantityText}}",
     "doseRange": "{{rangeText}}",
-    "rateQuantity": "mit einem Verhältnis von {{quantity}} {{unit}}",
+    "rateQuantity": "mit einem Verhältnis von {{quantityText}}",
     "rateRange": "mit einem Verhältnis von {{rangeText}}",
     "rateRatio": "mit einem Verhältnis von {{ratioText}}",
     "duration": "für {{durationText}}",
@@ -83,8 +86,8 @@
       "event_one": "{{event}}",
       "event_other": "{{event}}"
     },
-    "maxDosePerLifetime": "bis zu einer maximalen Menge von {{count}} {{unit}} über die Lebenszeit des Patienten",
-    "maxDosePerAdministration": "bis zu einer maximalen Menge von {{count}} {{unit}} pro Dosis",
+    "maxDosePerLifetime": "bis zu einer maximalen Menge von {{quantityText}} über die Lebenszeit des Patienten",
+    "maxDosePerAdministration": "bis zu einer maximalen Menge von {{quantityText}} pro Dosis",
     "maxDosePerPeriod": "bis zu einer maximalen Menge von {{maxDosePerPeriodText}}"
   }
 }

src/locales/en/common.json

@@ -28,12 +28,15 @@
         "denominator_other": ":{{count}}"
       }
     },
-    "quantity": "{{quantity}} {{unit}}"
+    "quantity": {
+      "withUnit": "{{quantity}} {{unit}}",
+      "withoutUnit": "{{quantity}}"
+    }
   },
   "fields": {
-    "doseQuantity": "{{quantity}} {{unit}}",
+    "doseQuantity": "{{quantityText}}",
     "doseRange": "{{rangeText}}",
-    "rateQuantity": "at a rate of {{quantity}} {{unit}}",
+    "rateQuantity": "at a rate of {{quantityText}}",
     "rateRange": "at a rate of {{rangeText}}",
     "rateRatio": "at a rate of {{ratioText}}",
     "duration": "over {{durationText}}",
@@ -83,8 +86,8 @@
       "event_one": "on {{event}}",
       "event_other": "on {{event}}"
     },
-    "maxDosePerLifetime": "up to a maximum of {{count}} {{unit}} for the lifetime of patient",
-    "maxDosePerAdministration": "up to a maximum of {{count}} {{unit}} per dose",
+    "maxDosePerLifetime": "up to a maximum of {{quantityText}} for the lifetime of patient",
+    "maxDosePerAdministration": "up to a maximum of {{quantityText}} per dose",
     "maxDosePerPeriod": "up to a maximum of {{maxDosePerPeriodText}}"
   }
 }

src/locales/fr/common.json

@@ -28,12 +28,15 @@
         "denominator_other": ":{{count}}"
       }
     },
-    "quantity": "{{quantity}} {{unit}}"
+    "quantity": {
+      "withUnit": "{{quantity}} {{unit}}",
+      "withoutUnit": "{{quantity}}"
+    }
   },
   "fields": {
-    "doseQuantity": "{{quantity}} {{unit}}",
+    "doseQuantity": "{{quantityText}}",
     "doseRange": "{{rangeText}}",
-    "rateQuantity": "au taux de {{quantity}} {{unit}}",
+    "rateQuantity": "au taux de {{quantityText}}",
     "rateRange": "au taux de {{rangeText}}",
     "rateRatio": "au taux de {{ratioText}}",
     "duration": "durant {{durationText}}",
@@ -83,8 +86,8 @@
       "event_one": "{{event}}",
       "event_other": "{{event}}"
     },
-    "maxDosePerLifetime": "jusqu'à un maximum de {{count}} {{unit}} pour la durée de vie du patient",
-    "maxDosePerAdministration": "jusqu'à un maximum de {{count}} {{unit}} par dose",
+    "maxDosePerLifetime": "jusqu'à un maximum de {{quantityText}} pour la durée de vie du patient",
+    "maxDosePerAdministration": "jusqu'à un maximum de {{quantityText}} par dose",
     "maxDosePerPeriod": "jusqu'à un maximum de {{maxDosePerPeriodText}}"
   }
 }

src/locales/nl/common.json

@@ -28,12 +28,15 @@
         "denominator_other": ":{{count}}"
       }
     },
-    "quantity": "{{quantity}} {{unit}}"
+    "quantity": {
+      "withUnit": "{{quantity}} {{unit}}",
+      "withoutUnit": "{{quantity}}"
+    }
   },
   "fields": {
-    "doseQuantity": "{{quantity}} {{unit}}",
+    "doseQuantity": "{{quantityText}}",
     "doseRange": "{{rangeText}}",
-    "rateQuantity": "met een verhouding van {{quantity}} {{unit}}",
+    "rateQuantity": "met een verhouding van {{quantityText}}",
     "rateRange": "met een verhouding van {{rangeText}}",
     "rateRatio": "met een verhouding van {{ratioText}}",
     "duration": "gedurende {{durationText}}",
@@ -83,8 +86,8 @@
       "event_one": "{{event}}",
       "event_other": "{{event}}"
     },
-    "maxDosePerLifetime": "tot een maximum van {{count}} {{unit}} gedurende de levensduur van de patiënt",
-    "maxDosePerAdministration": "tot een maximum van {{count}} {{unit}} per dosis",
+    "maxDosePerLifetime": "tot een maximum van {{quantityText}} gedurende de levensduur van de patiënt",
+    "maxDosePerAdministration": "tot een maximum van {{quantityText}} per dosis",
     "maxDosePerPeriod": "tot een maximum van {{maxDosePerPeriodText}}"
   }
 }

src/translators/doseQuantity.ts

@@ -1,4 +1,6 @@
+// Functions
 import { extractMatchingDoseAndRateFirstEntry } from "../internal/extractMatchingDoseAndRateFirstEntry";
+import { fromQuantityToString } from "../utils/fromQuantityToString";
 
 // types
 import type { DisplayOrderParams } from "../types";
@@ -15,14 +17,12 @@ export function transformDoseQuantityToText({
     return undefined;
   }
 
-  let quantity = doseQuantity.value || 1;
-  let unit = config.fromFHIRQuantityUnitToString({
-    language: config.language,
-    quantity: doseQuantity,
-  });
-
+  // Otherwise rendering it
   return i18next.t("fields.doseQuantity", {
-    quantity: quantity,
-    unit: unit,
+    quantityText: fromQuantityToString({
+      quantity: doseQuantity,
+      config,
+      i18next,
+    }),
   });
 }

src/translators/maxDosePerAdministration.ts

@@ -1,3 +1,6 @@
+// Functions
+import { fromQuantityToString } from "../utils/fromQuantityToString";
+
 // types
 import type { DisplayOrderParams } from "../types";
 
@@ -12,13 +15,12 @@ export function transformMaxDosePerAdministrationToText({
   }
 
   const maxDosePerAdministration = dos.maxDosePerAdministration;
-  let unit = config.fromFHIRQuantityUnitToString({
-    language: config.language,
-    quantity: maxDosePerAdministration,
-  });
 
   return i18next.t("fields.maxDosePerAdministration", {
-    count: maxDosePerAdministration.value || 1,
-    unit: unit,
+    quantityText: fromQuantityToString({
+      quantity: maxDosePerAdministration,
+      config,
+      i18next,
+    }),
   });
 }

src/translators/maxDosePerLifetime.ts

@@ -1,3 +1,6 @@
+// Functions
+import { fromQuantityToString } from "../utils/fromQuantityToString";
+
 // types
 import type { DisplayOrderParams } from "../types";
 
@@ -12,13 +15,12 @@ export function transformMaxDosePerLifetimeToText({
   }
 
   const maxDosePerLifetime = dos.maxDosePerLifetime;
-  let unit = config.fromFHIRQuantityUnitToString({
-    language: config.language,
-    quantity: maxDosePerLifetime,
-  });
 
   return i18next.t("fields.maxDosePerLifetime", {
-    count: maxDosePerLifetime.value || 1,
-    unit: unit,
+    quantityText: fromQuantityToString({
+      quantity: maxDosePerLifetime,
+      config,
+      i18next,
+    }),
   });
 }

src/translators/rateQuantity.ts

@@ -1,4 +1,6 @@
+// Functions
 import { extractMatchingDoseAndRateFirstEntry } from "../internal/extractMatchingDoseAndRateFirstEntry";
+import { fromQuantityToString } from "../utils/fromQuantityToString";
 
 // types
 import type { DisplayOrderParams } from "../types";
@@ -15,17 +17,11 @@ export function transformRateQuantityToText({
     return undefined;
   }
 
-  // information from rate
-  let value = rateQuantity.value || 1;
-
-  // quantity unit
-  let unit = config.fromFHIRQuantityUnitToString({
-    language: config.language,
-    quantity: rateQuantity,
-  });
-
   return i18next.t("fields.rateQuantity", {
-    quantity: value,
-    unit: unit,
+    quantityText: fromQuantityToString({
+      quantity: rateQuantity,
+      config,
+      i18next,
+    }),
   });
 }

src/types.ts

@@ -258,7 +258,7 @@ export type { I18N, InitOptions };
  */
 export type I18InitOptions = Exclude<InitOptions, "lng" | "ns" | "defaultNS">;
 
-// Types for amount functions
+// Types for translation functions
 export type RangeParams = {
   range: Range;
   config: Config;
@@ -270,3 +270,9 @@ export type RatioParams = {
   config: Config;
   i18next: I18N;
 };
+
+export type QuantityParams = {
+  quantity: Quantity;
+  config: Config;
+  i18next: I18N;
+};

src/utils/fromQuantityToString.ts

@@ -0,0 +1,31 @@
+// Function
+
+// Type
+import type { QuantityParams } from "../types";
+
+// To cover all nasty cases of Quantity, only once
+// https://build.fhir.org/datatypes.html#Quantity
+export function fromQuantityToString({
+  quantity,
+  config,
+  i18next,
+}: QuantityParams): string | undefined {
+  // extract function for the unit display from config
+  const { fromFHIRQuantityUnitToString, language } = config;
+
+  // Compute the result
+  let unit = fromFHIRQuantityUnitToString({ language, quantity });
+  let value = quantity.value || 1;
+
+  // If no unit is present (in other words ""), we don't put it
+  if (unit.length === 0) {
+    return i18next.t("amount.quantity.withoutUnit", {
+      quantity: value,
+    });
+  } else {
+    return i18next.t("amount.quantity.withUnit", {
+      quantity: value,
+      unit: unit,
+    });
+  }
+}