From 1d31cd0c6371445c85c3cace968a0feaea7d13cb Mon Sep 17 00:00:00 2001
From: Severin Beauvais <severin.beauvais@gmail.com>
Date: Tue, 5 Dec 2023 16:33:12 -0800
Subject: [PATCH] - app version = 5.6.10 - updated some validity calculations -
 moved ting validations to a mixin - generalized status computation - updated
 regular amalgation validity

---
 package-lock.json                             |   4 +-
 package.json                                  |   4 +-
 .../Amalgamation/AmalgamatingBusinesses.vue   |  20 +++-
 src/components/Amalgamation/BusinessTable.vue |  80 +++----------
 .../amalgamation-state-interface.ts           |   1 +
 src/mixins/amalgamation-mixin.ts              | 113 ++++++++++++++++++
 src/mixins/index.ts                           |   1 +
 src/store/state/state-model.ts                |   1 +
 src/store/store.ts                            |  17 ++-
 src/views/AmalgamationRegular/Information.vue |  12 +-
 .../AmalgamationRegular/ReviewConfirm.vue     |   6 +-
 .../IncorporationDefineCompany.vue            |   2 +-
 12 files changed, 180 insertions(+), 81 deletions(-)
 create mode 100644 src/mixins/amalgamation-mixin.ts

diff --git a/package-lock.json b/package-lock.json
index 5d95d7b8d..8c1b3bd2d 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "business-create-ui",
-  "version": "5.6.7",
+  "version": "5.6.10",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "business-create-ui",
-      "version": "5.6.7",
+      "version": "5.6.10",
       "dependencies": {
         "@babel/compat-data": "^7.21.5",
         "@bcrs-shared-components/approval-type": "1.0.19",
diff --git a/package.json b/package.json
index 44100f14b..0c2594b8a 100644
--- a/package.json
+++ b/package.json
@@ -1,13 +1,13 @@
 {
   "name": "business-create-ui",
-  "version": "5.6.7",
+  "version": "5.6.10",
   "private": true,
   "appName": "Create UI",
   "sbcName": "SBC Common Components",
   "scripts": {
     "dev": "vite",
     "build": "vite build",
-    "serve": "vite preview",
+    "serve": "vite preview --port 8080",
     "lint": "eslint . --ext .js,.ts,.vue",
     "test:unit": "vitest run",
     "test:coverage": "vitest run --coverage"
diff --git a/src/components/Amalgamation/AmalgamatingBusinesses.vue b/src/components/Amalgamation/AmalgamatingBusinesses.vue
index 8a6742f59..e35a815fc 100644
--- a/src/components/Amalgamation/AmalgamatingBusinesses.vue
+++ b/src/components/Amalgamation/AmalgamatingBusinesses.vue
@@ -125,8 +125,6 @@
       </ul>
     </v-row> -->
 
-    <!-- FOR DEBUGGING -->
-    <!-- <pre>getAmalgamatingBusinesses={{ getAmalgamatingBusinesses }}</pre> -->
     <BusinessTable
       class="mt-8"
       :class="{ 'invalid-section': getShowErrors && !businessTableValid }"
@@ -136,7 +134,7 @@
 </template>
 
 <script lang="ts">
-import { Component, Mixins } from 'vue-property-decorator'
+import { Component, Mixins, Watch } from 'vue-property-decorator'
 import { Action, Getter } from 'pinia-class'
 import { useStore } from '@/store/store'
 import { CommonMixin } from '@/mixins'
@@ -157,10 +155,10 @@ export default class AmalgamatingBusinesses extends Mixins(CommonMixin) {
   @Getter(useStore) isAmalgamationFilingHorizontal!: boolean
   @Getter(useStore) isRoleStaff!: boolean
 
-  @Action(useStore) setAmalgamatingBusinesses!: (x: Array<any>) => void
+  @Action(useStore) setAmalgamatingBusinesses!: (x: Array<AmalgamatingBusinessIF>) => void
+  @Action(useStore) setAmalgamatingBusinessesValid!: (x: boolean) => void
 
   // Local properties
-  amalgamatingBusinessesValid = false
   amalgamatingBusinesses = []
   initialBusinessLookupObject = EmptyBusinessLookup
   businessTableValid = false
@@ -229,6 +227,18 @@ export default class AmalgamatingBusinesses extends Mixins(CommonMixin) {
     // Close the "Add an Amalgamating Business" Panel.
     this.isAddingAmalgamatingBusiness = false
   }
+
+  /** Sets validity according to various flags. */
+  @Watch('businessTableValid')
+  @Watch('isAddingAmalgamatingBusiness')
+  @Watch('isAddingAmalgamatingForeignBusiness')
+  private onBusinessTableValid (): void {
+    this.setAmalgamatingBusinessesValid(
+      this.businessTableValid &&
+      !this.isAddingAmalgamatingBusiness &&
+      !this.isAddingAmalgamatingForeignBusiness
+    )
+  }
 }
 </script>
 
diff --git a/src/components/Amalgamation/BusinessTable.vue b/src/components/Amalgamation/BusinessTable.vue
index ca49141ba..071320ae5 100644
--- a/src/components/Amalgamation/BusinessTable.vue
+++ b/src/components/Amalgamation/BusinessTable.vue
@@ -69,15 +69,16 @@
 </template>
 
 <script lang="ts">
-import { Component, Emit, Vue, Watch } from 'vue-property-decorator'
-import { Getter, Action } from 'pinia-class'
+import { Component, Emit, Mixins, Watch } from 'vue-property-decorator'
+import { Action } from 'pinia-class'
 import { getName } from 'country-list'
 import { useStore } from '@/store/store'
 import { AmalgamatingStatuses, AmlRoles } from '@/enums'
 import { AmalgamatingBusinessIF } from '@/interfaces'
 import { BaseAddress } from '@bcrs-shared-components/base-address'
 import BusinessStatus from './BusinessStatus.vue'
-import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module'
+import { GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module'
+import { AmalgamationMixin } from '@/mixins'
 
 @Component({
   components: {
@@ -85,75 +86,32 @@ import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp
     BusinessStatus
   }
 })
-export default class BusinessTable extends Vue {
+export default class BusinessTable extends Mixins(AmalgamationMixin) {
   readonly AmlRoles = AmlRoles
   readonly GetCorpFullDescription = GetCorpFullDescription
 
-  @Getter(useStore) getAmalgamatingBusinesses!: AmalgamatingBusinessIF[]
-  @Getter(useStore) isRoleStaff!: boolean
-  @Getter(useStore) isTypeBcCcc!: boolean
-  @Getter(useStore) isTypeBcUlcCompany!: boolean
-
   @Action(useStore) setAmalgamatingBusinesses!: (x: AmalgamatingBusinessIF[]) => void
   @Action(useStore) setDefineCompanyStepValidity!: (x: boolean) => void
 
-  // *** I'M STILL WONDERING IF I WANT TO USE THESE
-  // readonly isLear = (item: AmalgamatingBusinessIF): boolean => (item?.type === 'lear')
-  // readonly isForeign = (item: AmalgamatingBusinessIF): boolean => (item?.type === 'foreign')
-
-  /** True if there a limited company in the table. */
-  get isAnyLimited (): boolean {
-    return this.businesses.some(business =>
-      (business.type === 'lear' && business.legalType === CorpTypeCd.BC_COMPANY)
-    )
-  }
-
   /**
    * This is the list of amalgamating businesses with computed statuses.
-   * In other words, these are the business rules.
+   * In other words, this is where the business rules are evaluated.
    */
   get businesses (): AmalgamatingBusinessIF[] {
     return this.getAmalgamatingBusinesses.map(business => {
-      /* eslint-disable brace-style */
-
-      // disallow foreign altogether if not staff
-      // (could happen if staff added it and regular user resumes draft)
-      if (business.type === 'foreign' && !this.isRoleStaff) {
-        business.status = AmalgamatingStatuses.ERROR_FOREIGN
-      }
-
-      // disallow foreign into ULC if there is also a limited
-      else if (business.type === 'foreign' && this.isTypeBcUlcCompany && this.isAnyLimited) {
-        business.status = AmalgamatingStatuses.ERROR_FOREIGN
-      }
-
-      // assume business is not affiliated if we don't have address (non-staff only)
-      else if (business.type === 'lear' && !business.address && !this.isRoleStaff) {
-        business.status = AmalgamatingStatuses.ERROR_AFFILIATION
-      }
-
-      // identify CCC mismatch
-      else if (business.type === 'lear' && business.legalType === CorpTypeCd.BC_CCC && !this.isTypeBcCcc) {
-        business.status = AmalgamatingStatuses.ERROR_CCC_MISMATCH
-      }
-
-      // disallow NIGS if not staff
-      else if (business.type === 'lear' && !business.goodStanding && !this.isRoleStaff) {
-        business.status = AmalgamatingStatuses.ERROR_NIGS
-      }
-
-      // check if limited restoration
-      // *** TODO
-
-      // check for future effective filing
-      // *** TODO
-
-      // otherwise, status is OK
-      else {
-        business.status = AmalgamatingStatuses.OK
-      }
-      /* eslint-enable brace-style */
-
+      // evaluate the rules for the current business
+      // assign the value of the first failed rule (if any) else OK
+      business.status = this.rules.reduce(
+        (status: AmalgamatingStatuses, rule: (business: AmalgamatingBusinessIF) => AmalgamatingStatuses) => {
+          // if we already failed a rule, don't check the rest of the rules
+          if (status) return status
+          // return the value of the current rule (may be null)
+          return rule(business)
+        },
+        null
+      ) || AmalgamatingStatuses.OK
+
+      // return updated business object
       return business
     })
   }
diff --git a/src/interfaces/store-interfaces/state-interfaces/amalgamation-state-interface.ts b/src/interfaces/store-interfaces/state-interfaces/amalgamation-state-interface.ts
index 4f9ddde57..cd8bec43c 100644
--- a/src/interfaces/store-interfaces/state-interfaces/amalgamation-state-interface.ts
+++ b/src/interfaces/store-interfaces/state-interfaces/amalgamation-state-interface.ts
@@ -42,6 +42,7 @@ export type AmalgamatingBusinessIF = AmalgamatingLearIF | AmalgamatingForeignIF
 /** State interface for amalgamation-specific data. */
 export interface AmalgamationStateIF {
   amalgamatingBusinesses: Array<AmalgamatingBusinessIF>
+  amalgamatingBusinessesValid: boolean
   courtApproval: boolean
   type: AmalgamationTypes
 }
diff --git a/src/mixins/amalgamation-mixin.ts b/src/mixins/amalgamation-mixin.ts
new file mode 100644
index 000000000..347ca1f94
--- /dev/null
+++ b/src/mixins/amalgamation-mixin.ts
@@ -0,0 +1,113 @@
+import { Component, Vue } from 'vue-property-decorator'
+import { Getter } from 'pinia-class'
+import { useStore } from '@/store/store'
+import { AmalgamatingStatuses } from '@/enums'
+import { AmalgamatingBusinessIF } from '@/interfaces'
+import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module'
+
+/**
+ * Mixin that provides amalgamation rules, etc.
+ */
+@Component({})
+export default class AmalgamationMixin extends Vue {
+  @Getter(useStore) getAmalgamatingBusinesses!: AmalgamatingBusinessIF[]
+  @Getter(useStore) isRoleStaff!: boolean
+  @Getter(useStore) isTypeBcCcc!: boolean
+  @Getter(useStore) isTypeBcUlcCompany!: boolean
+
+  /** Iterable array of rule functions, sorted by importance. */
+  readonly rules = [
+    this.rule1,
+    this.rule2,
+    this.rule3,
+    this.rule4,
+    this.rule5,
+    this.rule6
+  ]
+
+  // *** I'M STILL WONDERING IF I WANT TO USE THESE
+  // readonly isLear = (item: AmalgamatingBusinessIF): boolean => (item?.type === 'lear')
+  // readonly isForeign = (item: AmalgamatingBusinessIF): boolean => (item?.type === 'foreign')
+
+  /** True if there a limited company in the table. */
+  get isAnyLimited (): boolean {
+    return this.getAmalgamatingBusinesses.some(business =>
+      (business.type === 'lear' && business.legalType === CorpTypeCd.BC_COMPANY)
+    )
+  }
+
+  /** True if there an unlimited company in the table in Alberta, Nova Scotia or USA. */
+  get isAnyUnlimitedAbNsUsa (): boolean {
+    return this.getAmalgamatingBusinesses.some(business =>
+      (business.type === 'lear' && business.legalType === CorpTypeCd.BC_COMPANY)
+    )
+  }
+
+  // readonly amalgamationRules = [
+  //   {
+  //     id: 0,
+  //     rule: (v: any) => !!v || 'Required',
+  //     status: AmalgamatingStatuses.ERROR_FOREIGN
+  //   }
+  // ]
+
+  // A BC Company cannot amalgamate with an existing Unlimited Liability Company from Alberta,
+  // Nova Scotia, or the USA to form a BC Unlimited Liability Company.
+
+  // disallow foreign into ULC if there is also a limited
+  rule1 (business: AmalgamatingBusinessIF): AmalgamatingStatuses {
+    if (business.type === 'foreign' && this.isTypeBcUlcCompany && this.isAnyLimited) {
+      return AmalgamatingStatuses.ERROR_FOREIGN
+    }
+    return null
+  }
+
+  // disallow foreign altogether if not staff
+  // (could happen if staff added it and regular user resumes draft)
+  rule2 (business: AmalgamatingBusinessIF): AmalgamatingStatuses {
+    if (business.type === 'foreign' && !this.isRoleStaff) {
+      return AmalgamatingStatuses.ERROR_FOREIGN
+    }
+    return null
+  }
+
+  // disallow foreign into ULC if there is also a limited
+  rule3 (business: AmalgamatingBusinessIF): AmalgamatingStatuses {
+    if (business.type === 'foreign' && this.isTypeBcUlcCompany && this.isAnyLimited) {
+      return AmalgamatingStatuses.ERROR_FOREIGN
+    }
+    return null
+  }
+
+  // assume business is not affiliated if we don't have address (non-staff only)
+  rule4 (business: AmalgamatingBusinessIF): AmalgamatingStatuses {
+    // *** TODO: revert staff check
+    if (business.type === 'lear' && !business.address /* && !this.isRoleStaff */) {
+      return AmalgamatingStatuses.ERROR_AFFILIATION
+    }
+    return null
+  }
+
+  // identify CCC mismatch
+  rule5 (business: AmalgamatingBusinessIF): AmalgamatingStatuses {
+    if (business.type === 'lear' && business.legalType === CorpTypeCd.BC_CCC && !this.isTypeBcCcc) {
+      return AmalgamatingStatuses.ERROR_CCC_MISMATCH
+    }
+    return null
+  }
+
+  // disallow NIGS if not staff
+  rule6 (business: AmalgamatingBusinessIF): AmalgamatingStatuses {
+    // *** TODO: revert staff check
+    if (business.type === 'lear' && !business.goodStanding /* && !this.isRoleStaff */) {
+      return AmalgamatingStatuses.ERROR_NIGS
+    }
+    return null
+  }
+
+  // check if limited restoration
+  // *** TODO
+
+  // check for future effective filing
+  // *** TODO
+}
diff --git a/src/mixins/index.ts b/src/mixins/index.ts
index 145b51cdb..0026789fc 100644
--- a/src/mixins/index.ts
+++ b/src/mixins/index.ts
@@ -1,4 +1,5 @@
 export { default as AddEditOrgPersonMixin } from './add-edit-org-person-mixin'
+export { default as AmalgamationMixin } from './amalgamation-mixin'
 export { default as CommonMixin } from './common-mixin'
 export { default as CurrencyLookupMixin } from '@/mixins/currency-lookup-mixin'
 export { default as DateMixin } from './date-mixin'
diff --git a/src/store/state/state-model.ts b/src/store/state/state-model.ts
index c1f111e95..e286012d1 100644
--- a/src/store/state/state-model.ts
+++ b/src/store/state/state-model.ts
@@ -323,6 +323,7 @@ export const stateModel: StateModelIF = {
   },
   amalgamation: {
     amalgamatingBusinesses: cloneDeep(AMALGAMATING_BUSINESSES),
+    amalgamatingBusinessesValid: false,
     courtApproval: null,
     type: null
   },
diff --git a/src/store/store.ts b/src/store/store.ts
index 005ae8adb..7941e3b55 100644
--- a/src/store/store.ts
+++ b/src/store/store.ts
@@ -574,8 +574,13 @@ export const useStore = defineStore('store', {
 
     /** Whether all the amalgamation (regular) steps are valid. */
     isAmalgamationRegularValid (): boolean {
-      // *** TODO: implement this
-      return false
+      // *** TODO: add checks for review page components
+      return (
+        this.getAmalgamatingBusinessesValid &&
+        this.getDefineCompanyStep.valid &&
+        this.getAddPeopleAndRoleStep.valid &&
+        this.getCreateShareStructureStep.valid
+      )
     },
 
     /** Whether all the incorporation steps are valid. */
@@ -746,6 +751,11 @@ export const useStore = defineStore('store', {
       return this.stateModel.amalgamation.amalgamatingBusinesses
     },
 
+    /** The amalgamating businesses validity. */
+    getAmalgamatingBusinessesValid (): boolean {
+      return this.stateModel.amalgamation.amalgamatingBusinessesValid
+    },
+
     //
     // Dissolution getters
     //
@@ -1224,6 +1234,9 @@ export const useStore = defineStore('store', {
     setAmalgamatingBusinesses (amalgamatingBusinesses: Array<AmalgamatingBusinessIF>) {
       this.stateModel.amalgamation.amalgamatingBusinesses = amalgamatingBusinesses
     },
+    setAmalgamatingBusinessesValid (valid: boolean) {
+      this.stateModel.amalgamation.amalgamatingBusinessesValid = valid
+    },
     setAmalgamationType (type: AmalgamationTypes) {
       this.stateModel.amalgamation.type = type
     },
diff --git a/src/views/AmalgamationRegular/Information.vue b/src/views/AmalgamationRegular/Information.vue
index d10e25208..bfe706dbc 100644
--- a/src/views/AmalgamationRegular/Information.vue
+++ b/src/views/AmalgamationRegular/Information.vue
@@ -46,7 +46,6 @@
 import { Component, Mixins, Watch } from 'vue-property-decorator'
 import { Getter, Action } from 'pinia-class'
 import { useStore } from '@/store/store'
-import { DefineCompanyIF } from '@/interfaces'
 import { CommonMixin } from '@/mixins'
 import { RouteNames } from '@/enums'
 import { ExpandableHelp } from '@bcrs-shared-components/expandable-help'
@@ -63,10 +62,9 @@ import AmalgamatingBusinesses from '@/components/Amalgamation/AmalgamatingBusine
   }
 })
 export default class AmalgamationRegularInformation extends Mixins(CommonMixin) {
-  @Getter(useStore) getDefineCompanyStep!: DefineCompanyIF
+  @Getter(useStore) getAmalgamatingBusinessesValid!: boolean
   @Getter(useStore) getNameTranslationsValid!: boolean
   @Getter(useStore) getShowErrors!: boolean
-  @Getter(useStore) isBaseCompany!: boolean
 
   @Action(useStore) setDefineCompanyStepValidity!: (x: boolean) => void
   @Action(useStore) setIgnoreChanges!: (x: boolean) => void
@@ -83,8 +81,8 @@ export default class AmalgamationRegularInformation extends Mixins(CommonMixin)
   /** Object of valid flags. Must match validComponents above. */
   get validFlags (): object {
     return {
-      validAmalgamatingBusinesses: this.amalgamatingBusinessesValid,
-      validNameTranslation: this.getNameTranslationsValid
+      validAmalgamatingBusinesses: this.getAmalgamatingBusinessesValid,
+      validNameTranslations: this.getNameTranslationsValid
     }
   }
 
@@ -99,8 +97,8 @@ export default class AmalgamationRegularInformation extends Mixins(CommonMixin)
     })
   }
 
-  onAmalgamatingBusinessesValid (valid: boolean): void {
-    this.amalgamatingBusinessesValid = valid
+  @Watch('getAmalgamatingBusinessesValid')
+  private onAmalgamatingBusinessesValid (): void {
     this.setDefineCompanyStepValidity(
       this.amalgamatingBusinessesValid &&
       this.getNameTranslationsValid
diff --git a/src/views/AmalgamationRegular/ReviewConfirm.vue b/src/views/AmalgamationRegular/ReviewConfirm.vue
index 157d21771..7b195bd55 100644
--- a/src/views/AmalgamationRegular/ReviewConfirm.vue
+++ b/src/views/AmalgamationRegular/ReviewConfirm.vue
@@ -33,7 +33,10 @@
           icon="mdi-domain"
           label="Amalgamating Businesses Information"
         />
-        <div class="pa-4">
+        <div
+          class="pa-4"
+          :class="{ 'invalid-section': !getAmalgamatingBusinessesValid }"
+        >
           <BusinessTableSummary />
         </div>
       </v-card>
@@ -277,6 +280,7 @@ import { FilingNames } from '@bcrs-shared-components/enums'
   }
 })
 export default class AmalgamationRegularReviewConfirm extends Vue {
+  @Getter(useStore) getAmalgamatingBusinessesValid!: boolean
   @Getter(useStore) getBusinessContact!: ContactPointIF
   @Getter(useStore) getCertifyState!: CertifyIF
   @Getter(useStore) getCourtOrderStep!: CourtOrderStepIF
diff --git a/src/views/Incorporation/IncorporationDefineCompany.vue b/src/views/Incorporation/IncorporationDefineCompany.vue
index 8725d7335..341c66520 100644
--- a/src/views/Incorporation/IncorporationDefineCompany.vue
+++ b/src/views/Incorporation/IncorporationDefineCompany.vue
@@ -237,7 +237,7 @@ export default class IncorporationDefineCompany extends Mixins(CommonMixin) {
   /** Object of valid flags. Must match validComponents. */
   get validFlags (): object {
     return {
-      validNameTranslation: this.isTypeCoop ? true : this.getNameTranslationsValid,
+      validNameTranslations: this.isTypeCoop ? true : this.getNameTranslationsValid,
       validCooperativeType: this.isTypeCoop ? this.hasValidCooperativeType : true,
       validAddressForm: this.addressFormValid,
       validBusinessContactForm: this.businessContactFormValid