19005 Implemented historical - amalgamation reason text (bcgov#604)

- app version = 7.0.30
- updated some code comments
- added AmalgamatedInto interface object
- added enum mixin and utility functions
- added some business store getters
- refactored getReasonText() and added case for amalgamation
- cast some parameters to pre-empt code errors
- added/updated unit tests

Co-authored-by: Severin Beauvais <severin.beauvais@gov.bc.ca>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "business-filings-ui",
-  "version": "7.0.29",
+  "version": "7.0.30",
   "private": true,
   "appName": "Filings UI",
   "sbcName": "SBC Common Components",

src/components/Dashboard/TodoList.vue

@@ -528,7 +528,7 @@
             </div>
           </template>
 
-          <!-- is this a draft IA or Registration? -->
+          <!-- is this a draft Amalgamation or IA or Registration? -->
           <template
             v-else-if="isStatusDraft(item) && (isTypeAmalgamation(item) || isTypeIncorporationApplication(item) ||
               isTypeRegistration(item))"

src/interfaces/business-state-interfaces.ts

@@ -1,4 +1,5 @@
 import { EntityState, CorpTypeCd, FilingSubTypes, FilingTypes } from '@/enums'
+import { AmalgamationTypes } from '@bcrs-shared-components/enums'
 import { IsoDatePacific, ApiDateTimeUtc } from '@bcrs-shared-components/interfaces'
 
 export interface FilingTypeIF {
@@ -25,6 +26,13 @@ export interface AlternateNameIF {
   operatingName: string
 }
 
+export interface AmalgamatedIntoIF {
+  amalgamationDate: ApiDateTimeUtc
+  amalgamationType: AmalgamationTypes
+  identifier: string // eg, BC7654321
+  legalName: string
+}
+
 export interface BusinessWarningIF {
   code: string // FUTURE: use an enum
   filing?: string // not used
@@ -38,6 +46,7 @@ export interface ApiBusinessIF {
   adminFreeze: boolean
   allowedActions: AllowedActionsIF
   alternateNames?: Array<AlternateNameIF>
+  amalgamatedInto?: AmalgamatedIntoIF
   arMaxDate?: IsoDatePacific // not used
   arMinDate?: IsoDatePacific // not used
   associationType: string // COOP only

src/mixins/enum-mixin.ts

@@ -70,6 +70,11 @@ export default class EnumMixin extends Vue {
     return (item.name === FilingTypes.CORRECTION)
   }
 
+  /** DEPRECATED Returns True if filing is a Dissolution. */
+  isTypeDissolution (item: any): boolean {
+    return (item.name === FilingTypes.DISSOLUTION)
+  }
+
   /** DEPRECATED Returns True if filing is an Incorporation Application. */
   isTypeIncorporationApplication (item: any): boolean {
     return (item.name === FilingTypes.INCORPORATION_APPLICATION)

src/services/enum-utilities.ts

@@ -127,6 +127,11 @@ export default class EnumUtilities {
     return (item.name === FilingTypes.CORRECTION)
   }
 
+  /** Returns True if filing is a Dissolution. */
+  static isTypeDissolution (item: any): boolean {
+    return (item.name === FilingTypes.DISSOLUTION)
+  }
+
   /** Returns True if filing is an Amalgamation. */
   static isTypeAmalgamation (item: any): boolean {
     return (item.name === FilingTypes.AMALGAMATION_APPLICATION)

src/stores/businessStore.ts

@@ -1,4 +1,5 @@
-import { AllowedActionsIF, ApiBusinessIF, ApiDateTimeUtc, BusinessStateIF, BusinessWarningIF } from '@/interfaces'
+import { AllowedActionsIF, AmalgamatedIntoIF, ApiBusinessIF, ApiDateTimeUtc, BusinessStateIF, BusinessWarningIF }
+  from '@/interfaces'
 import { defineStore } from 'pinia'
 import { CorpTypeCd, EntityState } from '@/enums'
 import { DateUtilities, LegalServices } from '@/services/'
@@ -34,11 +35,16 @@ export const useBusinessStore = defineStore('business', {
   }),
 
   getters: {
-    /** The allowed actions object. */
+    /** The Allowed Actions object. */
     getAllowedActions (state: BusinessStateIF): AllowedActionsIF {
       return state.businessInfo.allowedActions
     },
 
+    /** The Amalgamated Info object. */
+    getAmalgamatedInto (state: BusinessStateIF): AmalgamatedIntoIF {
+      return state.businessInfo.amalgamatedInto
+    },
+
     /** The business number (aka Tax ID). */
     getBusinessNumber (state: BusinessStateIF): string {
       return state.businessInfo.taxId
@@ -49,7 +55,7 @@ export const useBusinessStore = defineStore('business', {
       return state.businessInfo.warnings
     },
 
-    /** The business state.businessInfo. */
+    /** The business state. */
     getBusinessState (state: BusinessStateIF): EntityState {
       return state.businessInfo.state
     },

src/stores/filingHistoryListStore.ts

@@ -38,7 +38,7 @@ export const useFilingHistoryListStore = defineStore('filingHistoryList', {
       })
     },
 
-    /** Returns the total AGM extension duration requires argument for year */
+    /** The function to compute total AGM extension duration. Requires argument for AGM Year. */
     getTotalAgmExtensionDuration (state: FilingHistoryListStateIF): (year: number) => number {
       return (year: number) => {
         return state.filings.reduce((totalMonths, filing) => {
@@ -47,11 +47,11 @@ export const useFilingHistoryListStore = defineStore('filingHistoryList', {
             return totalMonths
           }
           const filingExtension = filing.data?.agmExtension
-          // Cast year as number
           // Skip if extension data is missing
           if (!filingExtension) {
             return totalMonths
           }
+          // Cast year as number
           // Skip if years don't match
           if (Number(filingExtension.year) !== year) {
             return totalMonths

src/stores/rootStore.ts

@@ -1,7 +1,7 @@
 import { defineStore } from 'pinia'
 import { CorpTypeCd, EntityStatus, FilingSubTypes, FilingTypes } from '@/enums'
-import { ApiTaskIF, DissolutionConfirmationResourceIF, FilingDataIF, OfficeAddressIF, PartyIF, RootStateIF,
-  TodoListResourceIF, IsoDatePacific, StateFilingIF } from '@/interfaces'
+import { ApiTaskIF, DissolutionConfirmationResourceIF, FilingDataIF, OfficeAddressIF, PartyIF,
+  RootStateIF, TodoListResourceIF, IsoDatePacific, StateFilingIF } from '@/interfaces'
 import { DateUtilities, EnumUtilities, LegalServices } from '@/services'
 import { useBusinessStore } from './businessStore'
 import { useFilingHistoryListStore } from './filingHistoryListStore'
@@ -225,40 +225,74 @@ export const useRootStore = defineStore('root', {
       return state.stateFiling
     },
 
-    /**
-     * A formatted concatenation of the name and the effective date of the filing.
-     * Only used when entity is historical.
-     */
+    /** The historical reason text to display in the info header. */
     getReasonText (): string {
+      const enDash = '–' // ALT + 0150
       const businessStore = useBusinessStore()
-      const stateFiling = this.getStateFiling as StateFilingIF // may be null
 
+      if (!businessStore.isHistorical) return null // safety check
+
+      // check if historical reason is amalgamation
+      const amalgamatedInto = businessStore.getAmalgamatedInto
+      if (amalgamatedInto) return reasonTextAmalgamation()
+
+      // get state filing (may be null)
+      const stateFiling = this.getStateFiling as StateFilingIF
       const filingType = stateFiling?.header?.name
       if (!filingType) return null // safety check
 
-      // create reason text to display in the info header
-      let name: string
-      let date: string
+      // check if historical reason is dissolution
+      if (filingType === FilingTypes.DISSOLUTION) return reasonTextDissolution()
+
+      // check if historical reason is continuation out
+      if (filingType === FilingTypes.CONTINUATION_OUT) return reasonTextContinuationOut()
+
+      // fallback reason text
+      return reasonTextOther()
 
-      if (filingType === FilingTypes.DISSOLUTION) {
-        name = EnumUtilities.dissolutionTypeToName(
+      //
+      // helper functions
+      //
+
+      /** The reason text for a business made historical by an amalgamation. */
+      function reasonTextAmalgamation (): string {
+        const name = 'Amalgamation'
+        const amalgamationDate = DateUtilities.apiToDate(amalgamatedInto.amalgamationDate)
+        if (!amalgamationDate) throw new Error('Invalid amalgamation date')
+        const date = DateUtilities.dateToPacificDate(amalgamationDate, true)
+        const identifier = amalgamatedInto.identifier || 'Unknown Company'
+        return `${name} ${enDash} ${date} ${enDash} ${identifier}`
+      }
+
+      /** The reason text for a business made historical by a dissolution. */
+      function reasonTextDissolution (): string {
+        const name = EnumUtilities.dissolutionTypeToName(
           businessStore.isFirm,
-          (stateFiling?.dissolution?.dissolutionType as FilingSubTypes)
+          (stateFiling.dissolution?.dissolutionType as FilingSubTypes)
         )
         const dissolutionDate = DateUtilities.yyyyMmDdToDate(stateFiling.dissolution?.dissolutionDate)
         if (!dissolutionDate) throw new Error('Invalid dissolution date')
-        date = DateUtilities.dateToPacificDate(dissolutionDate, true)
-      } else {
-        name = (filingType === FilingTypes.CONTINUATION_OUT)
-          ? 'Continued Out'
-          : EnumUtilities.filingTypeToName(filingType)
-        const effectiveDate = DateUtilities.apiToDate(stateFiling.header.effectiveDate)
+        const date = DateUtilities.dateToPacificDate(dissolutionDate, true)
+        return `${name} ${enDash} ${date}`
+      }
+
+      /** The reason text for a business made historical by a continuation out. */
+      function reasonTextContinuationOut (): string {
+        const name = 'Continued Out'
+        const effectiveDate = DateUtilities.apiToDate(stateFiling.header?.effectiveDate)
         if (!effectiveDate) throw new Error('Invalid effective date')
-        date = DateUtilities.dateToPacificDateTime(effectiveDate)
+        const dateTime = DateUtilities.dateToPacificDateTime(effectiveDate)
+        return `${name} ${enDash} ${dateTime}`
       }
 
-      const enDash = '–' // ALT + 0150
-      return `${name} ${enDash} ${date}`
+      /** The reason text for a business made historical by some other state filing. */
+      function reasonTextOther (): string {
+        const name = EnumUtilities.filingTypeToName(filingType)
+        const effectiveDate = DateUtilities.apiToDate(stateFiling.header?.effectiveDate)
+        if (!effectiveDate) throw new Error('Invalid effective date')
+        const dateTime = DateUtilities.dateToPacificDateTime(effectiveDate)
+        return `${name} ${enDash} ${dateTime}`
+      }
     },
 
     /** The limited restoration active-until date, if it exists, otherwise null. */

src/views/AgmExtension.vue

@@ -454,7 +454,7 @@ export default class AgmExtension extends Mixins(CommonMixin, DateMixin,
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/AgmLocationChg.vue

@@ -561,7 +561,7 @@ export default class AgmLocationChg extends Mixins(CommonMixin, DateMixin,
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/AnnualReport.vue

@@ -1134,7 +1134,7 @@ export default class AnnualReport extends Mixins(CommonMixin, DateMixin, FilingM
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/ConsentContinuationOut.vue

@@ -847,7 +847,7 @@ export default class ConsentContinuationOut extends Mixins(CommonMixin, DateMixi
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/ContinuationOut.vue

@@ -838,7 +838,7 @@ export default class ContinuationOut extends Mixins(CommonMixin, DateMixin,
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/Correction.vue

@@ -755,7 +755,7 @@ export default class Correction extends Mixins(CommonMixin, DateMixin, EnumMixin
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/StandaloneDirectorsFiling.vue

@@ -879,7 +879,7 @@ export default class StandaloneDirectorsFiling extends Mixins(CommonMixin, DateM
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []

src/views/StandaloneOfficeAddressFiling.vue

@@ -755,7 +755,7 @@ export default class StandaloneOfficeAddressFiling extends Mixins(CommonMixin, D
         ret = await LegalServices.createFiling(this.getIdentifier, filing, isDraft)
       }
       return ret
-    } catch (error) {
+    } catch (error: any) {
       // save errors or warnings, if any
       this.saveErrors = error?.response?.data?.errors || []
       this.saveWarnings = error?.response?.data?.warnings || []