14529 Don't allow editing numbered company name (#429)

* - filtered out Correct Name option for numbered company
- renamed CorrectionTypes -> NameChangeOptions
- app version = 3.9.6

* - added unit tests

* - renamed resource files to resolve name conflicts
- added Name Change Options test suite

* - moved duplicate test logic into a single function

package.json

@@ -1,6 +1,6 @@
 {
   "name": "business-edit-ui",
-  "version": "3.9.5",
+  "version": "3.9.6",
   "private": true,
   "appName": "Edit UI",
   "sbcName": "SBC Common Components",

src/components/common/YourCompany/CompanyName/CorrectCompanyName.vue

@@ -19,12 +19,12 @@ import { Component, Prop, Watch, Emit, Mixins } from 'vue-property-decorator'
 import { Action, Getter } from 'vuex-class'
 import { CommonMixin } from '@/mixins/'
 import { ActionBindingIF, NameRequestIF } from '@/interfaces/'
-import { CorrectionTypes } from '@/enums/'
+import { NameChangeOptions } from '@/enums/'
 
 @Component({})
 export default class CorrectCompanyName extends Mixins(CommonMixin) {
   /** Form Submission Prop */
-  @Prop({ default: null }) readonly formType!: CorrectionTypes
+  @Prop({ default: null }) readonly formType!: NameChangeOptions
 
   @Action setNameRequest!: ActionBindingIF
 
@@ -54,7 +54,8 @@ export default class CorrectCompanyName extends Mixins(CommonMixin) {
   /** Watch for form submission and emit results. */
   @Watch('formType')
   private onSubmit (): void {
-    if (this.formType === CorrectionTypes.CORRECT_NAME) {
+    // this component should only see correct-name form type
+    if (this.formType === NameChangeOptions.CORRECT_NAME) {
       // set the new company name
       this.setNameRequest({
         ...this.getNameRequest,

src/components/common/YourCompany/CompanyName/CorrectNameOptions.vue

@@ -58,7 +58,7 @@
 import Vue from 'vue'
 import { Component, Emit, Prop } from 'vue-property-decorator'
 import { CorrectNameOptionIF } from '@/interfaces/'
-import { CorrectionTypes } from '@/enums/'
+import { NameChangeOptions } from '@/enums/'
 
 // for some reason, CorrectXXX cannot be imported from ./
 // (it breaks a bunch of unit tests)
@@ -85,27 +85,27 @@ export default class CorrectNameOptions extends Vue {
   // local properties
   protected displayedOptions: Array<CorrectNameOptionIF> = []
   protected panel: number = null
-  protected formType: CorrectionTypes = null
-  protected currentFormType: CorrectionTypes = null
+  protected formType: NameChangeOptions = null
+  protected currentFormType: NameChangeOptions = null
   protected isLoading = false
   protected isFormValid = false
   protected validateNameChange = false
 
   readonly correctionNameOptions: Array<CorrectNameOptionIF> = [
     {
-      id: CorrectionTypes.CORRECT_NAME,
+      id: NameChangeOptions.CORRECT_NAME,
       title: 'Edit the company name',
       description: 'Correct typographical errors in the existing company name.',
       component: CorrectCompanyName
     },
     {
-      id: CorrectionTypes.CORRECT_NAME_TO_NUMBER,
+      id: NameChangeOptions.CORRECT_NAME_TO_NUMBER,
       title: 'Use the incorporation number as the name',
       description: null,
       component: CorrectNameToNumber
     },
     {
-      id: CorrectionTypes.CORRECT_NEW_NR,
+      id: NameChangeOptions.CORRECT_NEW_NR,
       title: 'Use a new name request number',
       description: 'Enter the new Name Request Number (e.g., NR 1234567) and either the applicant phone number ' +
         'OR the applicant email that was used when the name was requested.',
@@ -139,7 +139,7 @@ export default class CorrectNameOptions extends Vue {
   }
 
   /** Identify the current form */
-  protected identifyForm (type: CorrectionTypes) {
+  protected identifyForm (type: NameChangeOptions) {
     this.currentFormType = type
     this.isFormValid = false
   }

src/components/common/YourCompany/CompanyName/CorrectNameRequest.vue

@@ -66,7 +66,7 @@ import { Action, Getter } from 'vuex-class'
 import { ConfirmDialog as ConfirmDialogShared } from '@bcrs-shared-components/confirm-dialog/'
 import { CommonMixin, NameRequestMixin } from '@/mixins/'
 import { ActionBindingIF, ConfirmDialogType, NameRequestIF, NrCorrectionIF, NrResponseIF } from '@/interfaces/'
-import { CorrectionTypes } from '@/enums/'
+import { NameChangeOptions } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 
 @Component({
@@ -82,7 +82,7 @@ export default class CorrectNameRequest extends Mixins(CommonMixin, NameRequestM
   }
 
   /** The form type. */
-  @Prop({ default: null }) readonly formType!: CorrectionTypes
+  @Prop({ default: null }) readonly formType!: NameChangeOptions
 
   /** Whether to perform validation. */
   @Prop({ default: false }) readonly validate!: boolean
@@ -147,7 +147,8 @@ export default class CorrectNameRequest extends Mixins(CommonMixin, NameRequestM
   /** Watch for form submission and emit results. */
   @Watch('formType')
   private async onSubmit (): Promise<any> {
-    if (this.formType === CorrectionTypes.CORRECT_NEW_NR) {
+    // this component should only see correct-new-nr form type
+    if (this.formType === NameChangeOptions.CORRECT_NEW_NR) {
       try {
         // Validate and return the name request data
         const nr: NrResponseIF = await this.validateNameRequest(

src/components/common/YourCompany/CompanyName/CorrectNameToNumber.vue

@@ -21,12 +21,12 @@ import { Action, Getter } from 'vuex-class'
 
 // Interfaces && enums
 import { ActionBindingIF, NameRequestIF } from '@/interfaces/'
-import { CorrectionTypes } from '@/enums/'
+import { NameChangeOptions } from '@/enums/'
 
 @Component({})
 export default class CorrectNameToNumber extends Vue {
   /** Form Submission Prop */
-  @Prop({ default: null }) readonly formType!: CorrectionTypes
+  @Prop({ default: null }) readonly formType!: NameChangeOptions
 
   @Action setNameRequest!: ActionBindingIF
 
@@ -43,7 +43,8 @@ export default class CorrectNameToNumber extends Vue {
   /** Watch for form submission and emit results. */
   @Watch('formType')
   private async onSubmit (): Promise<any> {
-    if (this.formType === CorrectionTypes.CORRECT_NAME_TO_NUMBER) {
+    // this component should only see correct-name-to-number form type
+    if (this.formType === NameChangeOptions.CORRECT_NAME_TO_NUMBER) {
       // delete the current legal name and NR number
       this.setNameRequest({
         ...this.getNameRequest,

src/components/common/YourCompany/YourCompany.vue

@@ -314,7 +314,7 @@ import { ContactPointIF } from '@bcrs-shared-components/interfaces/'
 import { AssociationType, BusinessContactInfo, ChangeBusinessType, FolioInformation, CorrectNameOptions,
   NameTranslation, NatureOfBusiness, OfficeAddresses, BusinessStartDate } from './'
 import { CommonMixin, DateMixin, NameRequestMixin } from '@/mixins/'
-import { CoopTypes, CorrectionTypes } from '@/enums/'
+import { CoopTypes, NameChangeOptions } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ConversionNOB } from '@/components/Conversion'
 
@@ -488,11 +488,13 @@ export default class YourCompany extends Mixins(
   }
 
   /** The current options for change of name correction or edit. */
-  get nameChangeOptions (): Array<CorrectionTypes> {
-    // remove name-to-numbered-company option when already a numbered company
+  get nameChangeOptions (): Array<NameChangeOptions> {
+    // if this is a numbered company, remove correct-name and name-to-number options
     if (this.isNumberedCompany) {
-      return this.getResource.changeData.nameChangeOptions
-        .filter(option => option !== CorrectionTypes.CORRECT_NAME_TO_NUMBER)
+      return this.getResource.changeData.nameChangeOptions.filter(option => (
+        option !== NameChangeOptions.CORRECT_NAME &&
+        option !== NameChangeOptions.CORRECT_NAME_TO_NUMBER
+      ))
     }
     return this.getResource.changeData.nameChangeOptions
   }

src/enums/correctionTypes.ts → src/enums/NameChangeOptions.ts

@@ -1,4 +1,4 @@
-export enum CorrectionTypes {
+export enum NameChangeOptions {
   CORRECT_NAME = 'correct-name',
   CORRECT_NAME_TO_NUMBER = 'correct-name-to-number',
   CORRECT_NEW_NR = 'correct-new-nr'

src/enums/index.ts

@@ -4,7 +4,6 @@ export * from './compareModes'
 export * from './componentsCompanyInfo'
 export * from './componentsReviewCertify'
 export * from './correctionErrorTypes'
-export * from './correctionTypes'
 export * from './effectiveDateTypes'
 export * from './effectOfOrders'
 export * from './entitySubtypes'
@@ -13,6 +12,7 @@ export * from './filingNames'
 export * from './filingStatus'
 export * from './filingTypes'
 export * from './partyTypes'
+export * from './NameChangeOptions'
 export * from './nameRequestStates'
 export * from './nameRequestTypes'
 export * from './roleTypes'

src/interfaces/correction-interfaces/correct-name-interface.ts

@@ -1,9 +1,9 @@
 import { NameRequestApplicantIF } from '@/interfaces/'
-import { CorrectionTypes, NameRequestStates, NameRequestTypes } from '@/enums/'
+import { NameChangeOptions, NameRequestStates, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 
 export interface CorrectNameOptionIF {
-  id: CorrectionTypes,
+  id: NameChangeOptions,
   title: string,
   description?: string,
   component: any

src/interfaces/resource-interfaces/resource-interface.ts

@@ -1,4 +1,4 @@
-import { CorrectionTypes, NameRequestTypes } from '@/enums/'
+import { NameChangeOptions, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 import { HelpSectionIF, FilingDataIF, SpecialResolutionSampleFormIF } from '@/interfaces/'
 
@@ -13,7 +13,7 @@ export interface ResourceIF {
   description?: string // BEN corrections only
   filingData: FilingDataIF
   changeData?: {
-    nameChangeOptions?: Array<CorrectionTypes>
+    nameChangeOptions?: Array<NameChangeOptions>
     typeChangeInfo?: string
     orgPersonInfo?: {
       orgPersonLabel: string

src/resources/Alteration/LimitedCompanyResource.ts → src/resources/Alteration/BC.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes } from '@/enums/'
+import { NameChangeOptions, FilingCodes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const LimitedCompanyResource: ResourceIF = {
+export const BcAlterationResource: ResourceIF = {
   entityReference: 'Company',
   contactLabel: 'Registered Office',
   displayName: GetCorpFullDescription(CorpTypeCd.BC_COMPANY),
@@ -14,8 +14,8 @@ export const LimitedCompanyResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR,
-      CorrectionTypes.CORRECT_NAME_TO_NUMBER
+      NameChangeOptions.CORRECT_NEW_NR,
+      NameChangeOptions.CORRECT_NAME_TO_NUMBER
     ]
   },
   certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +

src/resources/Alteration/BenefitCompanyResource.ts → src/resources/Alteration/BEN.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes } from '@/enums/'
+import { NameChangeOptions, FilingCodes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const BenefitCompanyResource: ResourceIF = {
+export const BenAlterationResource: ResourceIF = {
   entityReference: 'Company',
   contactLabel: 'Registered Office',
   displayName: GetCorpFullDescription(CorpTypeCd.BENEFIT_COMPANY),
@@ -14,8 +14,8 @@ export const BenefitCompanyResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR,
-      CorrectionTypes.CORRECT_NAME_TO_NUMBER
+      NameChangeOptions.CORRECT_NEW_NR,
+      NameChangeOptions.CORRECT_NAME_TO_NUMBER
     ]
   },
   certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +

src/resources/Alteration/CommunityContributionCompanyResource.ts → src/resources/Alteration/CCC.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes } from '@/enums/'
+import { NameChangeOptions, FilingCodes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const CommunityContributionCompanyResource: ResourceIF = {
+export const CccAlterationResource: ResourceIF = {
   entityReference: 'Company',
   contactLabel: 'Registered Office',
   displayName: GetCorpFullDescription(CorpTypeCd.BC_CCC),
@@ -14,8 +14,8 @@ export const CommunityContributionCompanyResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR,
-      CorrectionTypes.CORRECT_NAME_TO_NUMBER
+      NameChangeOptions.CORRECT_NEW_NR,
+      NameChangeOptions.CORRECT_NAME_TO_NUMBER
     ]
   },
   certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +

src/resources/Alteration/UnlimitedLiabilityCompanyResource.ts → src/resources/Alteration/ULC.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes } from '@/enums/'
+import { NameChangeOptions, FilingCodes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const UnlimitedLiabilityCompanyResource: ResourceIF = {
+export const UlcAlterationResource: ResourceIF = {
   entityReference: 'Company',
   contactLabel: 'Registered Office',
   displayName: GetCorpFullDescription(CorpTypeCd.BC_ULC_COMPANY),
@@ -14,8 +14,8 @@ export const UnlimitedLiabilityCompanyResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR,
-      CorrectionTypes.CORRECT_NAME_TO_NUMBER
+      NameChangeOptions.CORRECT_NEW_NR,
+      NameChangeOptions.CORRECT_NAME_TO_NUMBER
     ]
   },
   certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +

src/resources/Alteration/index.ts

@@ -1,4 +1,4 @@
-export * from './BenefitCompanyResource'
-export * from './LimitedCompanyResource'
-export * from './CommunityContributionCompanyResource'
-export * from './UnlimitedLiabilityCompanyResource'
+export * from './BC'
+export * from './BEN'
+export * from './CCC'
+export * from './ULC'

src/resources/Change/GeneralPartnershipResource.ts → src/resources/Change/GP.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
+import { NameChangeOptions, FilingCodes, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const GeneralPartnershipResource: ResourceIF = {
+export const GpChangeResource: ResourceIF = {
   entityReference: 'Business',
   contactLabel: 'Business',
   displayName: GetCorpFullDescription(CorpTypeCd.PARTNERSHIP),
@@ -14,7 +14,7 @@ export const GeneralPartnershipResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR
+      NameChangeOptions.CORRECT_NEW_NR
     ],
     typeChangeInfo: 'General Partnership cannot be changed into a Sole Proprietorship. If this is necessary, a new ' +
       'Name Request Number and Statement of Registration (along with associated fees) will be required.',

src/resources/Change/SoleProprietorshipResource.ts → src/resources/Change/SP.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
+import { NameChangeOptions, FilingCodes, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const SoleProprietorshipResource: ResourceIF = {
+export const SpChangeResource: ResourceIF = {
   entityReference: 'Business',
   contactLabel: 'Business',
   displayName: GetCorpFullDescription(CorpTypeCd.SOLE_PROP),
@@ -14,7 +14,7 @@ export const SoleProprietorshipResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR
+      NameChangeOptions.CORRECT_NEW_NR
     ],
     typeChangeInfo: 'You cannot change the business type of a Sole Proprietorship / DBA. You must form a new ' +
       'business and dissolve this business once the new business is registered.',

src/resources/Change/index.ts

@@ -1,2 +1,2 @@
-export * from './GeneralPartnershipResource'
-export * from './SoleProprietorshipResource'
+export * from './GP'
+export * from './SP'

src/resources/Conversion/GeneralPartnershipResource.ts → src/resources/Conversion/GP.ts

@@ -1,8 +1,8 @@
-import { CorrectionTypes, FilingCodes } from '@/enums/'
+import { NameChangeOptions, FilingCodes } from '@/enums/'
 import { CorpTypeCd, GetCorpFullDescription } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const GeneralPartnershipResource: ResourceIF = {
+export const GpConversionResource: ResourceIF = {
   entityReference: 'Business',
   contactLabel: 'Business',
   displayName: GetCorpFullDescription(CorpTypeCd.PARTNERSHIP),
@@ -15,7 +15,7 @@ export const GeneralPartnershipResource: ResourceIF = {
   },
   changeData: {
     nameChangeOptions: [
-      CorrectionTypes.CORRECT_NEW_NR
+      NameChangeOptions.CORRECT_NEW_NR
     ],
     typeChangeInfo: 'General Partnership cannot be changed into a Sole Proprietorship. If this is necessary, a new ' +
       'Name Request Number and Statement of Registration (along with associated fees) will be required.',