✨ bump FR EnergyBillV1 to V1.2 & US HealthcareCardV1 to V1.1 (#338)

Author: sebastianMindee

docs/energy_bill_fra_v1.md

@@ -151,11 +151,19 @@ Details of energy consumption.
 
 A `EnergyBillV1EnergyUsage` implements the following attributes:
 
+* `consumption` (number): The price per unit of energy consumed.
 * `description` (string): Description or details of the energy usage.
 * `endDate` (string): The end date of the energy usage.
 * `startDate` (string): The start date of the energy usage.
 * `taxRate` (number): The rate of tax applied to the total cost.
 * `total` (number): The total cost of energy consumed.
+* `unit` (string): The unit of measurement for energy consumption.
+
+#### Possible values include:
+ - kWh
+ - m3
+ - L
+
 * `unitPrice` (number): The price per unit of energy consumed.
 Fields which are specific to this product; they are not used in any other product.
 
@@ -173,7 +181,7 @@ A `EnergyBillV1MeterDetail` implements the following attributes:
  - water
  - `null`
 
-* `unit` (string): The unit of measurement for energy consumption, which can be kW, m³, or L.
+* `unit` (string): The unit of power for energy consumption.
 Fields which are specific to this product; they are not used in any other product.
 
 ### Subscription Field

src/cliProducts.ts

@@ -310,5 +310,3 @@ export const CLI_COMMAND_CONFIG = new Map<string, ProductConfig>([
     },
   ],
 ]);
-
-

src/product/fr/energyBill/energyBillV1Document.ts

@@ -16,7 +16,7 @@ import {
 } from "../../../parsing/standard";
 
 /**
- * Energy Bill API version 1.0 document data.
+ * Energy Bill API version 1.2 document data.
  */
 export class EnergyBillV1Document implements Prediction {
   /** The unique identifier associated with a specific contract. */
@@ -150,13 +150,15 @@ export class EnergyBillV1Document implements Prediction {
     }
     let energyUsageSummary:string = "";
     if (this.energyUsage && this.energyUsage.length > 0) {
-      const energyUsageColSizes:number[] = [38, 12, 12, 10, 11, 12];
+      const energyUsageColSizes:number[] = [13, 38, 12, 12, 10, 11, 17, 12];
       energyUsageSummary += "\n" + lineSeparator(energyUsageColSizes, "-") + "\n  ";
+      energyUsageSummary += "| Consumption ";
       energyUsageSummary += "| Description                          ";
       energyUsageSummary += "| End Date   ";
       energyUsageSummary += "| Start Date ";
       energyUsageSummary += "| Tax Rate ";
       energyUsageSummary += "| Total     ";
+      energyUsageSummary += "| Unit of Measure ";
       energyUsageSummary += "| Unit Price ";
       energyUsageSummary += "|\n" + lineSeparator(energyUsageColSizes, "=");
       energyUsageSummary += this.energyUsage.map(

src/product/fr/energyBill/energyBillV1EnergyUsage.ts

@@ -6,6 +6,8 @@ import { Polygon } from "../../../geometry";
  * Details of energy consumption.
  */
 export class EnergyBillV1EnergyUsage {
+  /** The price per unit of energy consumed. */
+  consumption: number | null;
   /** Description or details of the energy usage. */
   description: string | null;
   /** The end date of the energy usage. */
@@ -16,6 +18,8 @@ export class EnergyBillV1EnergyUsage {
   taxRate: number | null;
   /** The total cost of energy consumed. */
   total: number | null;
+  /** The unit of measurement for energy consumption. */
+  unit: string | null;
   /** The price per unit of energy consumed. */
   unitPrice: number | null;
   /** Confidence score */
@@ -29,6 +33,15 @@ export class EnergyBillV1EnergyUsage {
   polygon: Polygon = [];
 
   constructor({ prediction = {} }: StringDict) {
+    if (
+      prediction["consumption"] !== undefined &&
+      prediction["consumption"] !== null &&
+      !isNaN(prediction["consumption"])
+    ) {
+      this.consumption = +parseFloat(prediction["consumption"]);
+    } else {
+      this.consumption = null;
+    }
     this.description = prediction["description"];
     this.endDate = prediction["end_date"];
     this.startDate = prediction["start_date"];
@@ -50,6 +63,7 @@ export class EnergyBillV1EnergyUsage {
     } else {
       this.total = null;
     }
+    this.unit = prediction["unit"];
     if (
       prediction["unit_price"] !== undefined &&
       prediction["unit_price"] !== null &&
@@ -71,6 +85,8 @@ export class EnergyBillV1EnergyUsage {
    */
   #printableValues() {
     return {
+      consumption:
+        this.consumption !== undefined ? floatToString(this.consumption) : "",
       description: this.description ?
         this.description.length <= 36 ?
           cleanSpecialChars(this.description) :
@@ -88,6 +104,11 @@ export class EnergyBillV1EnergyUsage {
         "",
       taxRate: this.taxRate !== undefined ? floatToString(this.taxRate) : "",
       total: this.total !== undefined ? floatToString(this.total) : "",
+      unit: this.unit ?
+        this.unit.length <= 15 ?
+          cleanSpecialChars(this.unit) :
+          cleanSpecialChars(this.unit).slice(0, 12) + "..." :
+        "",
       unitPrice: this.unitPrice !== undefined ? floatToString(this.unitPrice) : "",
     };
   }
@@ -98,7 +119,9 @@ export class EnergyBillV1EnergyUsage {
   toString(): string {
     const printable = this.#printableValues();
     return (
-      "Description: " +
+      "Consumption: " +
+      printable.consumption +
+      ", Description: " +
       printable.description +
       ", End Date: " +
       printable.endDate +
@@ -108,6 +131,8 @@ export class EnergyBillV1EnergyUsage {
       printable.taxRate +
       ", Total: " +
       printable.total +
+      ", Unit of Measure: " +
+      printable.unit +
       ", Unit Price: " +
       printable.unitPrice
     );
@@ -120,6 +145,8 @@ export class EnergyBillV1EnergyUsage {
     const printable = this.#printableValues();
     return (
       "| " +
+      printable.consumption.padEnd(11) +
+      " | " +
       printable.description.padEnd(36) +
       " | " +
       printable.endDate.padEnd(10) +
@@ -130,6 +157,8 @@ export class EnergyBillV1EnergyUsage {
       " | " +
       printable.total.padEnd(9) +
       " | " +
+      printable.unit.padEnd(15) +
+      " | " +
       printable.unitPrice.padEnd(10) +
       " |"
     );

src/product/fr/energyBill/energyBillV1MeterDetail.ts

@@ -9,7 +9,7 @@ export class EnergyBillV1MeterDetail {
   meterNumber: string | null;
   /** The type of energy meter. */
   meterType: string | null;
-  /** The unit of measurement for energy consumption, which can be kW, m³, or L. */
+  /** The unit of power for energy consumption. */
   unit: string | null;
   /** Confidence score */
   confidence: number = 0.0;
@@ -53,7 +53,7 @@ export class EnergyBillV1MeterDetail {
       printable.meterNumber +
       ", Meter Type: " +
       printable.meterType +
-      ", Unit of Measure: " +
+      ", Unit of Power: " +
       printable.unit
     );
   }
@@ -66,6 +66,6 @@ export class EnergyBillV1MeterDetail {
     return `
   :Meter Number: ${printable.meterNumber}
   :Meter Type: ${printable.meterType}
-  :Unit of Measure: ${printable.unit}`.trimEnd();
+  :Unit of Power: ${printable.unit}`.trimEnd();
   }
 }

src/product/us/healthcareCard/healthcareCardV1Document.ts

@@ -7,7 +7,7 @@ import { HealthcareCardV1Copay } from "./healthcareCardV1Copay";
 import { DateField, StringField } from "../../../parsing/standard";
 
 /**
- * Healthcare Card API version 1.0 document data.
+ * Healthcare Card API version 1.1 document data.
  */
 export class HealthcareCardV1Document implements Prediction {
   /** The name of the company that provides the healthcare plan. */