- app version = 5.9.1 (#656)

- use applicant phone/email (if available) to fetch NR on app start - use applicant phone/email (if available) to validate NR on file and pay - save applicant phone/email to draft amalgamation, continuation in and restoration - added store getter - misc cleanup - fixed unit tests Co-authored-by: Severin Beauvais <severin.beauvais@gov.bc.ca>
bcgov · Feb 14, 2024 · 964251f · 964251f
1 parent 41efbd8
commit 964251f
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 37 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "business-create-ui",
-  "version": "5.8.15",
+  "version": "5.9.1",
   "private": true,
   "appName": "Create UI",
   "sbcName": "SBC Common Components",

diff --git a/src/App.vue b/src/App.vue
@@ -980,12 +980,17 @@ export default class App extends Mixins(CommonMixin, DateMixin, FilingTemplateMi
   private async processNameRequest (filing: any): Promise<void> {
     try {
       const nrNumber = filing[filing.header?.name].nameRequest.nrNumber
-
-      // fetch NR data
-      const nrResponse = await LegalServices.fetchValidContactNr(nrNumber).catch(error => {
-        console.log('NR error =', error) // eslint-disable-line no-console
-        this.nameRequestInvalidErrorDialog = true
-      })
+      const applicantPhone = filing[filing.header?.name].nameRequest.applicantPhone // may be undefined
+      const applicantEmail = filing[filing.header?.name].nameRequest.applicantEmail // may be undefined
+
+      // Fetch NR data using saved applicant phone or email (eg, restoration or amalgamation).
+      // NB - if NR is affiliated to the current account (eg, IA or registration) then phone and email
+      // don't matter.
+      const nrResponse = await LegalServices.fetchValidContactNr(nrNumber, applicantPhone, applicantEmail)
+        .catch(error => {
+          console.log('NR error =', error) // eslint-disable-line no-console
+          this.nameRequestInvalidErrorDialog = true
+        })
 
       //
       // The NR checks below are sort-of a duplicate of code in BusinessName.vue and

diff --git a/src/components/common/Actions.vue b/src/components/common/Actions.vue
@@ -115,6 +115,8 @@ export default class Actions extends Mixins(AmalgamationMixin, CommonMixin,
   @Getter(useStore) getEntityIdentifier!: string
   @Getter(useStore) getFilingType!: string
   @Getter(useStore) getMaxStep!: number
+  // @Getter(useStore) getNameRequestApplicant!: NrApplicantIF
+  // @Getter(useStore) getNameRequestNumber!: string
   @Getter(useStore) getSteps!: Array<any>
   @Getter(useStore) isBusySaving!: boolean
   @Getter(useStore) isEntityType!: boolean
@@ -250,13 +252,16 @@ export default class Actions extends Mixins(AmalgamationMixin, CommonMixin,
         return
       }
 
-      // If this is a named company IA, validate NR before filing submission. This method is different
-      // from the processNameRequest method in App.vue. This method shows a generic message if
-      // the Name Request is not valid and clicking ok in the pop up redirects to the Manage Businesses
-      // dashboard.
+      // If a NR was used, validate it before filing submission. This method is different from the
+      // processNameRequest method in App.vue -- this method shows a generic message if the NR is
+      // not valid and clicking OK in the pop up redirects to the Manage Businesses dashboard.
       if (this.getNameRequestNumber) {
         try {
-          await this._validateNameRequest(this.getNameRequestNumber)
+          await this._validateNameRequest(
+            this.getNameRequestNumber,
+            this.getNameRequestApplicant.phoneNumber,
+            this.getNameRequestApplicant.emailAddress
+          )
         } catch (error) {
           console.log('Error validating NR in onClickFilePay(): ', error) // eslint-disable-line no-console
           this.setIsFilingPaying(false)
@@ -328,11 +333,12 @@ export default class Actions extends Mixins(AmalgamationMixin, CommonMixin,
 
   // FUTURE: merge this with NameRequestMixin::validateNameRequest()
   /** Fetches NR and validates it. */
-  private async _validateNameRequest (nrNumber: string): Promise<void> {
-    const nameRequest = await LegalServices.fetchValidContactNr(nrNumber).catch(error => {
-      this.$root.$emit('name-request-retrieve-error')
-      throw new Error(error)
-    })
+  private async _validateNameRequest (nrNumber: string, phone = '', email = ''): Promise<void> {
+    const nameRequest = await LegalServices.fetchValidContactNr(nrNumber, phone, email)
+      .catch(error => {
+        this.$root.$emit('name-request-retrieve-error')
+        throw new Error(error)
+      })
 
     // ensure NR was found
     if (!nameRequest) {

diff --git a/src/interfaces/filing-interfaces/filing-interfaces.ts b/src/interfaces/filing-interfaces/filing-interfaces.ts
@@ -16,6 +16,8 @@ export interface NameRequestFilingIF {
   legalName?: string // only set when there is a name change (including NR)
   nrNumber?: string // only set when there is an NR
   correctNameOption?: CorrectNameOptions // only used by UI for save and resume
+  applicantPhone?: string // only used by UI for save and resume
+  applicantEmail?: string // only used by UI for save and resume
 }
 
 /** Interface for amalgamation filing data saved to the Legal API. */

diff --git a/src/mixins/filing-template-mixin.ts b/src/mixins/filing-template-mixin.ts
@@ -7,9 +7,9 @@ import {
   ContinuationInFilingIF, CourtOrderIF, CourtOrderStepIF, CreateMemorandumIF, CreateResolutionIF,
   CreateRulesIF, DefineCompanyIF, DissolutionFilingIF, DissolutionStatementIF, DocumentDeliveryIF,
   EffectiveDateTimeIF, EmptyContactPoint, EmptyNaics, IncorporationAgreementIF, IncorporationFilingIF,
-  NaicsIF, NameRequestFilingIF, NameTranslationIF, OfficeAddressIF, OrgPersonIF, PartyIF,
-  RegistrationFilingIF, RegistrationStateIF, RestorationFilingIF, RestorationStateIF, ShareStructureIF,
-  SpecialResolutionIF, StaffPaymentIF, StaffPaymentStepIF, UploadAffidavitIF
+  NaicsIF, NrApplicantIF, NameRequestFilingIF, NameTranslationIF, OfficeAddressIF, OrgPersonIF,
+  PartyIF, RegistrationFilingIF, RegistrationStateIF, RestorationFilingIF, RestorationStateIF,
+  ShareStructureIF, SpecialResolutionIF, StaffPaymentIF, StaffPaymentStepIF, UploadAffidavitIF
 } from '@/interfaces'
 import {
   AmalgamationTypes, ApprovalTypes, BusinessTypes, CoopTypes, CorrectNameOptions, DissolutionTypes,
@@ -55,6 +55,7 @@ export default class FilingTemplateMixin extends Mixins(AmalgamationMixin, DateM
   @Getter(useStore) getFolioNumber!: string
   @Getter(useStore) getIncorporationAgreementStep!: IncorporationAgreementIF
   @Getter(useStore) getMemorandum!: any
+  @Getter(useStore) getNameRequestApplicant!: NrApplicantIF
   @Getter(useStore) getNameRequestApprovedName!: string
   @Getter(useStore) getNameRequestNumber!: string
   @Getter(useStore) getNameTranslations!: NameTranslationIF[]
@@ -186,6 +187,8 @@ export default class FilingTemplateMixin extends Mixins(AmalgamationMixin, DateM
         filing.amalgamationApplication.nameRequest.correctNameOption = CorrectNameOptions.CORRECT_NEW_NR
         filing.amalgamationApplication.nameRequest.legalName = this.getNameRequestApprovedName
         filing.amalgamationApplication.nameRequest.nrNumber = this.getNameRequestNumber
+        filing.amalgamationApplication.nameRequest.applicantPhone = this.getNameRequestApplicant.phoneNumber
+        filing.amalgamationApplication.nameRequest.applicantEmail = this.getNameRequestApplicant.emailAddress
         break
       case CorrectNameOptions.CORRECT_AML_NUMBERED:
         filing.amalgamationApplication.nameRequest.correctNameOption = CorrectNameOptions.CORRECT_AML_NUMBERED
@@ -391,6 +394,8 @@ export default class FilingTemplateMixin extends Mixins(AmalgamationMixin, DateM
         filing.continuationIn.nameRequest.correctNameOption = CorrectNameOptions.CORRECT_NEW_NR
         filing.continuationIn.nameRequest.legalName = this.getNameRequestApprovedName
         filing.continuationIn.nameRequest.nrNumber = this.getNameRequestNumber
+        filing.continuationIn.nameRequest.applicantPhone = this.getNameRequestApplicant.phoneNumber
+        filing.continuationIn.nameRequest.applicantEmail = this.getNameRequestApplicant.emailAddress
         break
       case CorrectNameOptions.CORRECT_AML_NUMBERED:
         filing.continuationIn.nameRequest.correctNameOption = CorrectNameOptions.CORRECT_AML_NUMBERED
@@ -857,6 +862,8 @@ export default class FilingTemplateMixin extends Mixins(AmalgamationMixin, DateM
         filing.restoration.nameRequest.correctNameOption = CorrectNameOptions.CORRECT_NEW_NR
         filing.restoration.nameRequest.legalName = this.getNameRequestApprovedName
         filing.restoration.nameRequest.nrNumber = this.getNameRequestNumber
+        filing.restoration.nameRequest.applicantPhone = this.getNameRequestApplicant.phoneNumber
+        filing.restoration.nameRequest.applicantEmail = this.getNameRequestApplicant.emailAddress
         break
     }
 

diff --git a/src/services/legal-services.ts b/src/services/legal-services.ts
@@ -167,9 +167,9 @@ export default class LegalServices {
         if (error?.response?.status === StatusCodes.NOT_FOUND) {
           return null // NR not found (not an error)
         } else if (error?.response?.status === StatusCodes.BAD_REQUEST) {
-          throw new Error('Sent invalid email or phone number.') // Sent invalid email or phone
+          throw new Error('Invalid email or phone number.')
         } else if (error?.response?.status === StatusCodes.FORBIDDEN) {
-          throw new Error('Not sent email or phone number.') // Not sent the email or phone
+          throw new Error('Missing email or phone number.')
         }
         throw error
       })

diff --git a/src/store/store.ts b/src/store/store.ts
@@ -50,11 +50,13 @@ import {
   NaicsIF,
   NameRequestIF,
   NameTranslationIF,
+  NrApplicantIF,
   OfficeAddressIF,
   OrgInformationIF,
   OrgPersonIF,
   PartyIF,
   PeopleAndRoleIF,
+  PeopleAndRolesResourceIF,
   RegisteredRecordsAddressesIF,
   RegistrationStateIF,
   ResourceIF,
@@ -66,8 +68,7 @@ import {
   StateIF,
   StepIF,
   UploadAffidavitIF,
-  ValidationDetailIF,
-  PeopleAndRolesResourceIF
+  ValidationDetailIF
 } from '@/interfaces'
 
 // It's possible to move getters / actions into seperate files:
@@ -350,24 +351,29 @@ export const useStore = defineStore('store', {
       return this.stateModel.business.officeAddress
     },
 
+    /** The Correct Name Option. */
+    getCorrectNameOption (): CorrectNameOptions {
+      return this.stateModel.correctNameOption
+    },
+
     /** The Name Request object. */
     getNameRequest (): NameRequestIF {
       return this.stateModel.nameRequest
     },
 
+    /** The Name Request applicant (may be empty object). */
+    getNameRequestApplicant (): NrApplicantIF {
+      return this.getNameRequest.applicants // object not array
+    },
+
     /** The approved name (from NR or Correct Name component). */
     getNameRequestApprovedName (): string {
       return this.stateModel.nameRequestApprovedName
     },
 
-    /** The Correct Name Option. */
-    getCorrectNameOption (): CorrectNameOptions {
-      return this.stateModel.correctNameOption
-    },
-
     /** The Name Request number. */
     getNameRequestNumber (): string {
-      return this.getNameRequest?.nrNum
+      return this.getNameRequest.nrNum
     },
 
     /** The Company Step object. */

diff --git a/tests/unit/Actions.spec.ts b/tests/unit/Actions.spec.ts
@@ -11,7 +11,7 @@ import { AxiosInstance as axios } from '@/utils'
 import Actions from '@/components/common/Actions.vue'
 import mockRouter from './MockRouter'
 import LegalServices from '@/services/legal-services'
-import { FilingTypes } from '@/enums'
+import { FilingTypes, NameRequestStates } from '@/enums'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module'
 import { CourtOrderStepIF, DefineCompanyIF, EffectiveDateTimeIF, IncorporationAgreementIF, NameRequestIF,
   OrgPersonIF, PeopleAndRoleIF, ShareStructureIF, TombstoneIF } from '@/interfaces'
@@ -67,7 +67,7 @@ const nrData = {
   nrNum: 'NR 1234567',
   request_action_cd: 'NEW',
   requestTypeCd: 'BC',
-  state: 'APPROVED'
+  state: NameRequestStates.APPROVED
 }
 
 describe('Actions component', () => {
@@ -118,7 +118,7 @@ describe('Emits error event if NR validation fails in file and pay', () => {
 
     const expiredNR = { ...nrData }
     expiredNR.expirationDate = 'Thu, 31 Dec 2019 23:59:59 GMT'
-    expiredNR.state = 'EXPIRED'
+    expiredNR.state = NameRequestStates.EXPIRED
 
     // GET NR data
     sinon.stub(axios, 'get')
@@ -130,8 +130,10 @@ describe('Emits error event if NR validation fails in file and pay', () => {
     // init store
     store.stateModel.currentDate = '2020/01/29'
     store.stateModel.nameRequest = {
+      applicants: {},
       legalType: CorpTypeCd.BENEFIT_COMPANY,
-      nrNum: 'NR 1234567'
+      nrNum: 'NR 1234567',
+      state: NameRequestStates.APPROVED
     } as NameRequestIF
     store.stateModel.nameRequestApprovedName = 'My Name Request Inc.'
     store.stateModel.tombstone = {
@@ -386,8 +388,10 @@ describe('Actions component - Filing Functionality', () => {
     // init store
     store.stateModel.currentDate = '2020/01/29'
     store.stateModel.nameRequest = {
+      applicants: {},
       legalType: CorpTypeCd.BENEFIT_COMPANY,
-      nrNum: 'NR 1234567'
+      nrNum: 'NR 1234567',
+      state: NameRequestStates.APPROVED
     } as NameRequestIF
     store.stateModel.nameRequestApprovedName = 'My Name Request Inc.'
     store.stateModel.nameTranslations = []