20148 Updated to accommodate alternate name changes (#566)

* Updated to accommodate alternate name changes

* updated package version

* fixed comment and tests

* changed to use nameTypes shared enum

package.json

@@ -1,6 +1,6 @@
 {
   "name": "business-edit-ui",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "private": true,
   "appName": "Edit UI",
   "sbcName": "SBC Common Components",
@@ -27,7 +27,7 @@
     "@bcrs-shared-components/court-order-poa": "2.1.3",
     "@bcrs-shared-components/date-picker": "1.2.5",
     "@bcrs-shared-components/detail-comment": "1.1.3",
-    "@bcrs-shared-components/enums": "1.0.46",
+    "@bcrs-shared-components/enums": "1.1.9",
     "@bcrs-shared-components/fee-summary": "1.2.5",
     "@bcrs-shared-components/folio-number": "1.1.1",
     "@bcrs-shared-components/help-business-number": "1.1.1",

src/enums/index.ts

@@ -18,4 +18,4 @@ export * from './routeNames'
 // external enum
 export { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 export { ActionTypes, ApprovalTypes, CorrectNameOptions, EntityStates, FilingCodes, FilingNames, FilingTypes,
-  RestorationTypes, RelationshipTypes } from '@bcrs-shared-components/enums'
+  NameTypes, RestorationTypes, RelationshipTypes } from '@bcrs-shared-components/enums'

src/interfaces/store-interfaces/state-interfaces/business-information-interface.ts

@@ -1,14 +1,15 @@
-import { CoopTypes } from '@/enums'
+import { CoopTypes, NameTypes } from '@/enums'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 import { IsoDatePacific, ApiDateTimeUtc } from '@bcrs-shared-components/interfaces'
 
-/** The Alternate Name (aka operating name) object. */
+/** The Alternate Name object. */
 export interface AlternateNameIF {
   entityType: CorpTypeCd
   identifier: string
+  name: string
   nameRegisteredDate: ApiDateTimeUtc
   nameStartDate: IsoDatePacific
-  operatingName: string
+  nameType: NameTypes
 }
 
 /**

src/store/store.ts

@@ -318,13 +318,13 @@ export const useStore = defineStore('store', {
       return this.stateModel.tombstone.businessId
     },
 
-    /** The original legal name (or operating name if this is a firm). */
+    /** The original legal name (or alternate name if this is a firm). */
     getOriginalLegalName (): string {
       if (this.isFirm) {
-        // return the operating name, if it exists
+        // return the alternate name, if it exists
         const alternateNames = this.getOriginalBusinessInfo?.alternateNames || []
         const alternateName = alternateNames.find(x => x.identifier === this.getBusinessId)
-        return alternateName?.operatingName || 'Unknown'
+        return alternateName?.name || 'Unknown'
       }
       return this.getOriginalBusinessInfo?.legalName || ''
     },

tests/unit/EntityInfo.spec.ts

@@ -161,15 +161,15 @@ describe('Entity Info component in a Correction as a numbered Benefit Company',
 })
 
 describe('Entity Info component for a firm', () => {
-  it('displays operating name correctly for a SP Change filing', () => {
+  it('displays alternate name correctly for a SP Change filing', () => {
     const wrapper = shallowWrapperFactory(
       EntityInfo,
       null,
       {
         entitySnapshot: {
           businessInfo: {
             alternateNames: [
-              { identifier: 'FM1234567', operatingName: 'My Operating Name' }
+              { identifier: 'FM1234567', name: 'My Alternate Name' }
             ],
             legalName: 'My Legal Name'
           }
@@ -182,7 +182,7 @@ describe('Entity Info component for a firm', () => {
       }
     )
 
-    expect(wrapper.find('#entity-legal-name').text()).toBe('My Operating Name')
+    expect(wrapper.find('#entity-legal-name').text()).toBe('My Alternate Name')
 
     wrapper.destroy()
   })

tests/unit/filing-template-mixin.spec.ts

@@ -162,7 +162,7 @@ describe('Change of Registration Filing', () => {
         addressCountry: 'CA'
       }
     }
-    store.stateModel.nameRequest.legalName = 'My Operating Name'
+    store.stateModel.nameRequest.legalName = 'My Alternate Name'
     store.stateModel.entitySnapshot = {
       businessInfo: {
         foundingDate: 'Jan 01, 2000',
@@ -174,7 +174,7 @@ describe('Change of Registration Filing', () => {
         alternateNames: [
           {
             identifier: 'FM1234567',
-            operatingName: 'My Operating Name'
+            name: 'My Alternate Name'
           }
         ]
       },

tests/unit/state-getters.spec.ts

@@ -425,7 +425,7 @@ describe('SP/GP correction getters', () => {
     store.stateModel.tombstone.entityType = CorpTypeCd.SOLE_PROP
     store.stateModel.tombstone.filingType = FilingTypes.CORRECTION
     store.stateModel.tombstone.businessId = 'FM1234567'
-    store.stateModel.nameRequest.legalName = 'My Operating Name'
+    store.stateModel.nameRequest.legalName = 'My Alternate Name'
     store.stateModel.entitySnapshot = {
       businessInfo: {
         identifier: 'FM1234567',
@@ -436,7 +436,7 @@ describe('SP/GP correction getters', () => {
         alternateNames: [
           {
             identifier: 'FM1234567',
-            operatingName: 'My Operating Name'
+            name: 'My Alternate Name'
           }
         ]
       },
@@ -468,7 +468,7 @@ describe('SP/GP correction getters', () => {
     // verify that business name changes are detected
     store.stateModel.nameRequest.legalName = 'MyLegalName2'
     expect(vm.hasBusinessNameChanged).toBe(true)
-    store.stateModel.nameRequest.legalName = 'My Operating Name'
+    store.stateModel.nameRequest.legalName = 'My Alternate Name'
     expect(vm.hasBusinessNameChanged).toBe(false)
 
     // verify that business type changes are detected