Merge pull request #7 from ConsumerDataStandardsAustralia/feature/mandatory-string-energy-account-balances

Energy account balance - mandatory string

Author: vadkor

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cds-au/testdata",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "Tools for the creation of manufactured test data for the Australian Consumer Data Right regime",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/commands/factory.ts

@@ -59,7 +59,6 @@ export const handler = (argv: Arguments<Options>): void => {
       if (factory.canCreateEnergyConcessions()) output +='    create a set of energy concessions\n';
       if (factory.canCreateEnergyAccount()) output +='    create an energy account\n';
       if (factory.canCreateEnergyAccounts()) output +='    create a set of energy accounts\n';
-      if (factory.canCreateEnergyBalance()) output +='    create an energy account balance\n';
       if (factory.canCreateEnergyInvoice()) output +='    create an energy invoice\n';
       if (factory.canCreateEnergyInvoices()) output +='    create a set of energy invoices\n';
       if (factory.canCreateEnergyTransaction()) output +='    create an energy transaction\n';

src/factories/energy/createEnergyAccountData.ts

@@ -101,7 +101,8 @@ Key values randomly allocated:
             energyAccount.plans.push(plan);
         }
         let result: EnergyAccountWrapper = {
-            account: energyAccount
+            account: energyAccount,
+            balance: Helper.generateRandomDecimalInRange(-500, 5000)
         };
         return result;
     }

src/factories/energy/createEnergyTransactions.ts

@@ -1,5 +1,5 @@
 import { EnergyBillingDemandTransaction, EnergyBillingOnceOffTransaction, EnergyBillingOtherTransaction, EnergyBillingPaymentTransaction, EnergyBillingTransaction, EnergyBillingUsageTransaction, EnergyPlan, EnergyPlanDetailV2} from "consumer-data-standards/energy";
-import { EnergyAccountBalance, EnergyAccountWrapper, EnergyServicePointWrapper } from "../../logic/schema/cdr-test-data-schema";
+import { EnergyAccountWrapper, EnergyServicePointWrapper } from "../../logic/schema/cdr-test-data-schema";
 import { TransactionUType } from "../../random-generators";
 import { Factory, FactoryOptions, Helper } from "../../logic/factoryService";
 import { RandomEnergy } from '../../random-generators';
@@ -39,15 +39,6 @@ Key values randomly allocated:
         return st;
     } 
 
-    public canCreateEnergyBalance(): boolean { return true};
-
-    public generateEnergyBalance(account: EnergyAccountWrapper): EnergyAccountBalance | undefined {
-        let accBalance: EnergyAccountBalance = {
-            balance: Helper.generateRandomDecimalInRange(-500, 5000, 2)
-        }
-        return account.balance = accBalance;
-    }
-
     public canCreateEnergyTransaction(): boolean { return true; };
     public generateEnergyTransaction(account: EnergyAccountWrapper, servicePoints: EnergyServicePointWrapper[]): EnergyBillingTransaction | undefined 
     { 

src/factories/invalid-factories/createInvalidEnergyAccountData.ts

@@ -29,7 +29,8 @@ export class CreateInvalidEnergyAccountData extends Factory {
             invoiceAmount: Helper.generateRandomDecimalInRange(10, 500)
          } 
          let wrapper: EnergyAccountWrapper = {
-            account : energyAccount
+            account : energyAccount,
+            balance : Helper.generateRandomDecimalInRange(-500, 5000)
          }; 
 
        return wrapper;

src/factories/static-factories/simpleFull.ts

@@ -1084,7 +1084,8 @@ This factory supports the follow option fields:
             ]
           }
         ]
-      }
+      },
+      balance: Helper.generateRandomDecimalInRange(-500, 5000)
     }
   }
 
@@ -1100,14 +1101,6 @@ This factory supports the follow option fields:
     return ret;
   }
 
-  // public canCreateEnergyBalance(): boolean { return true; };
-  // public generateEnergyBalance(account: EnergyAccountWrapper): EnergyBalanceResponse | undefined {
-  //   return {
-  //     accountId: account.account.accountId,
-  //     balance: "10.00"
-  //   }
-  // }
-
   public canCreateEnergyPaymentSchedules(): boolean { return true; };
   public generateEnergyPaymentSchedules(account: EnergyAccountWrapper): any[] | undefined {
     let count = Helper.isPositiveInteger(this.options.options?.count) ? (this.options.options?.count as number) : 1;

src/logic/factoryService/factory.ts

@@ -1,6 +1,6 @@
 
 import { OptionsGeneral } from '../options';
-import { AdminOutage, AdminStatus, BankAccountWrapper, Client, ConsumerDataRightTestDataJSONSchema, CustomerWrapper, EnergyAccountBalance, EnergyAccountWrapper, EnergyServicePointWrapper, Holders, HolderWrapper } from '../schema/cdr-test-data-schema';
+import { AdminOutage, AdminStatus, BankAccountWrapper, Client, ConsumerDataRightTestDataJSONSchema, CustomerWrapper, EnergyAccountWrapper, EnergyServicePointWrapper, Holders, HolderWrapper } from '../schema/cdr-test-data-schema';
 
 export interface FactoryOptions {
   general?: OptionsGeneral,
@@ -115,9 +115,6 @@ export abstract class Factory {
   public canCreateEnergyAccounts(): boolean { return false; };
   public generateEnergyAccounts(customer: CustomerWrapper): EnergyAccountWrapper[] | undefined { return }
 
-  public canCreateEnergyBalance(): boolean { return false; };
-  public generateEnergyBalance(account: EnergyAccountWrapper): EnergyAccountBalance | undefined { return }
-
   public canCreateEnergyPaymentSchedules(): boolean { return false; };
   public generateEnergyPaymentSchedules(account: EnergyAccountWrapper): any[] | undefined { return }
 

src/logic/factoryService/generateData.ts

@@ -889,20 +889,6 @@ function generateDetailedEnergyAccounts(options: Options, accountOptions: any, c
         if (account && account.account) {
           result.push(account);
 
-          // Create the detail inside the created account
-          if (accountOptions.balanceFactory) {
-            Helper.log(`Executing balance factories for energy account`, 1);
-            account.balance = generateSingleItem(options, accountOptions.balanceFactory,
-              (factory) => {
-                return factory.canCreateEnergyBalance();
-              },
-              (factory) => {
-                return factory.generateEnergyBalance(account);
-              })
-          } else {
-            Helper.log(`No energy account balance factories configured`, 1)
-          }
-
           if (accountOptions.invoicesFactory) {
             Helper.log(`Executing invoices factories for energy account`, 1);
             account.invoices = generateArrayOfItems(options, accountOptions.invoicesFactory,

src/logic/schema/cdr-test-data-schema.ts

@@ -53,7 +53,7 @@ export interface EnergyServicePointWrapper {
  */
 export interface EnergyAccountWrapper {
   account: EnergyAccountDetailV3;
-  balance?: EnergyAccountBalance;
+  balance: string;
   /**
    * An array of agreed payment schedules
    */
@@ -217,6 +217,3 @@ export interface Customer {
 /**
  * An energy account balance structure aligned to the current version of the data standards
  */
-export interface EnergyAccountBalance {
-  [k: string]: unknown;
-}