18640 Incremental amalgamating businesses validations, etc

package.json

@@ -1,13 +1,13 @@
 {
   "name": "business-create-ui",
-  "version": "5.6.9",
+  "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"

src/components/Amalgamation/AmalgamatingBusinesses.vue

@@ -106,7 +106,7 @@
       <ul>
         Amalgamating Businesses: <br><br>
         <li
-          v-for="(business, index) in amalgamatingBusinesses"
+          v-for="(business, index) in getAmalgamatingBusinesses"
           :key="index"
         >
           <template v-if="business.foundingDate">
@@ -127,8 +127,6 @@
       </ul>
     </v-row> -->
 
-    <!-- FOR DEBUGGING -->
-    <!-- <pre>getAmalgamatingBusinesses={{ getAmalgamatingBusinesses }}</pre> -->
     <BusinessTable
       class="mt-8"
       :class="{ 'invalid-section': getShowErrors && !businessTableValid }"
@@ -138,7 +136,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'
@@ -161,12 +159,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
 
@@ -176,11 +172,6 @@ export default class AmalgamatingBusinesses extends Mixins(CommonMixin) {
 
   readonly BusinessLookupServices = BusinessLookupServices
 
-  // If continuing a draft, initialize the amalgamatingBusinesses array as the previously saved one.
-  mounted (): void {
-    if (this.getAmalgamatingBusinesses) this.amalgamatingBusinesses = this.getAmalgamatingBusinesses
-  }
-
   // Cancel button in "Add an Amalgamating Business" is pressed.
   addAmalgamatingBusinessCancel (): void {
     this.isAddingAmalgamatingBusiness = false
@@ -224,6 +215,8 @@ export default class AmalgamatingBusinesses extends Mixins(CommonMixin) {
     // If the amalgamating businesses array is not empty, check if identifier already exists.
     // If identifier already exists, don't add the business to the array.
     if (business) {
+      const amalgamatingBusinesses = this.getAmalgamatingBusinesses
+
       const tingBusiness = {
         type: 'lear',
         role: AmlRoles.AMALGAMATING,
@@ -235,18 +228,30 @@ export default class AmalgamatingBusinesses extends Mixins(CommonMixin) {
         goodStanding: business.goodStanding
       } as AmalgamatingBusinessIF
 
-      if (!this.amalgamatingBusinesses.find(b => b.identifier === business.identifier)) {
-        this.amalgamatingBusinesses.push(tingBusiness)
+      if (!amalgamatingBusinesses.find((b: any) => b.identifier === business.identifier)) {
+        amalgamatingBusinesses.push(tingBusiness)
+
+        // Set the new amalgamated businesses array in the store.
+        this.setAmalgamatingBusinesses(amalgamatingBusinesses)
       }
     }
 
-    // Set the amalgamated businesses array in the store.
-    this.setAmalgamatingBusinesses(this.amalgamatingBusinesses)
-
     // Close the "Add an Amalgamating Business" Panel.
     this.isAddingAmalgamatingBusiness = false
     this.setAmalgamatingBusinessesValid(true)
   }
+
+  /** Sets validity according to various flags. */
+  @Watch('businessTableValid')
+  @Watch('isAddingAmalgamatingBusiness')
+  @Watch('isAddingAmalgamatingForeignBusiness')
+  private onBusinessTableValid (): void {
+    this.setAmalgamatingBusinessesValid(
+      this.businessTableValid &&
+      !this.isAddingAmalgamatingBusiness &&
+      !this.isAddingAmalgamatingForeignBusiness
+    )
+  }
 }
 </script>
 
@@ -256,5 +261,4 @@ export default class AmalgamatingBusinesses extends Mixins(CommonMixin) {
 .v-btn:not(.v-btn--round).v-size--default {
   height: 44px;
 }
-
 </style>

src/components/Amalgamation/BusinessTable.vue

@@ -69,91 +69,49 @@
 </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: {
     BaseAddress,
     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
     })
   }

src/interfaces/store-interfaces/state-interfaces/amalgamation-state-interface.ts

@@ -42,7 +42,7 @@ export type AmalgamatingBusinessIF = AmalgamatingLearIF | AmalgamatingForeignIF
 /** State interface for amalgamation-specific data. */
 export interface AmalgamationStateIF {
   amalgamatingBusinesses: Array<AmalgamatingBusinessIF>
-  courtApproval: boolean
   amalgamatingBusinessesValid: boolean
+  courtApproval: boolean
   type: AmalgamationTypes
 }

src/mixins/amalgamation-mixin.ts

@@ -0,0 +1,114 @@
+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
+
+  // *** TODO: finish this, maybe name them something recognizable...
+  /** 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
+}

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'

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. */