14523 Cleanup before further development (#428)

* - renamed correction resources
- added resources for BC/CCC/ULC
- deleted obsolete AgreementTypeResource
- updated correction views
- updated unit tests
- enabled Hotjar (for future)
- app version = 3.9.5

* - set deleted legalName and nrNumber to undefined instead of null
- updated unit test

package.json

@@ -1,6 +1,6 @@
 {
   "name": "business-edit-ui",
-  "version": "3.9.4",
+  "version": "3.9.5",
   "private": true,
   "appName": "Edit UI",
   "sbcName": "SBC Common Components",
@@ -48,6 +48,7 @@
     "vue": "^2.7.10",
     "vue-affix": "^0.5.2",
     "vue-debounce-decorator": "^1.0.1",
+    "vue-hotjar": "^1.4.0",
     "vue-router": "^3.6.5",
     "vue-the-mask": "^0.11.1",
     "vue2-filters": "^0.14.0",

public/config/configuration.json

@@ -7,6 +7,7 @@
   "BUSINESSES_URL": "https://dev.bcregistry.ca/business/auth/",
   "BUSINESS_EDIT_LD_CLIENT_ID": "5f4d47179db2f40a33e88d32",
   "DASHBOARD_URL": "https://dev.bcregistry.ca/business/",
+  "HOTJAR_ID": "",
   "KEYCLOAK_CONFIG_PATH": "/local-keycloak-config-url/keycloak.json",
   "LEGAL_API_URL": "https://legal-api-dev.apps.silver.devops.gov.bc.ca",
   "LEGAL_API_VERSION_2": "/api/v2",

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

@@ -47,8 +47,8 @@ export default class CorrectNameToNumber extends Vue {
       // delete the current legal name and NR number
       this.setNameRequest({
         ...this.getNameRequest,
-        legalName: null,
-        nrNumber: null
+        legalName: undefined,
+        nrNumber: undefined
       })
       this.emitIsSaved(true)
     }

src/main.ts

@@ -8,6 +8,7 @@ import Vuetify from 'vuetify/lib'
 import Vuelidate from 'vuelidate'
 import Affix from 'vue-affix'
 import Vue2Filters from 'vue2-filters' // needed by SbcFeeSummary
+import Hotjar from 'vue-hotjar'
 import * as Sentry from '@sentry/browser'
 import * as Integrations from '@sentry/integrations'
 import { getVueRouter } from '@/router/'
@@ -53,8 +54,16 @@ async function start () {
     })
   }
 
+  // initialize Hotjar
+  const hotjarId: string = window['hotjarId']
+  if (hotjarId) {
+    console.info('Initializing Hotjar...') // eslint-disable-line no-console
+    Vue.use(Hotjar, { id: hotjarId })
+  }
+
   // initialize Launch Darkly
   if (window['ldClientId']) {
+    console.info('Initializing Launch Darkly...') // eslint-disable-line no-console
     await InitLdClient()
   }
 

src/resources/Correction/BenefitCompanyStatementResource.ts → src/resources/Correction/BenefitCompany.ts

@@ -2,7 +2,7 @@ import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const BenefitCompanyStatementResource: ResourceIF = {
+export const BenCorrectionResource: ResourceIF = {
   entityReference: 'Company',
   contactLabel: 'Registered Office',
   displayName: null, // not used

src/resources/Correction/CommunityContributionCompany.ts

@@ -0,0 +1,37 @@
+import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
+import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
+import { ResourceIF } from '@/interfaces/'
+
+export const CccCorrectionResource: ResourceIF = {
+  entityReference: 'Company',
+  contactLabel: 'Registered Office',
+  displayName: null, // not used
+  entityType: CorpTypeCd.BC_CCC,
+  addressLabel: 'Registered Office',
+  title: 'Benefit Company Statement',
+  description: 'This company is a benefit company and, as such, has purposes that include conducting its business in' +
+               ' a responsible and sustainable manner and promoting one or more public benefits.',
+  filingData: {
+    filingTypeCode: FilingCodes.CORRECTION,
+    entityType: CorpTypeCd.BC_CCC,
+    priority: false
+  },
+  changeData: {
+    nameChangeOptions: [
+      CorrectionTypes.CORRECT_NEW_NR,
+      CorrectionTypes.CORRECT_NAME_TO_NUMBER,
+      CorrectionTypes.CORRECT_NAME
+    ],
+    orgPersonInfo: {
+      orgPersonLabel: 'Directors',
+      subtitle: null // not used
+    },
+    nameRequestTypes: [
+      NameRequestTypes.CHANGE_OF_NAME,
+      NameRequestTypes.CONVERSION
+    ]
+  },
+  certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +
+    'of a material fact in a record submitted to the Corporate Registry for filing. ' +
+    'See section 427 of the Business Corporations Act.'
+}

src/resources/Correction/GeneralPartnershipResource.ts → src/resources/Correction/GeneralPartnership.ts

@@ -2,7 +2,7 @@ import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const GeneralPartnershipResource: ResourceIF = {
+export const GpCorrectionResource: ResourceIF = {
   entityReference: 'Business',
   contactLabel: 'Business',
   displayName: null, // not used

src/resources/Correction/LimitedCompany.ts

@@ -0,0 +1,37 @@
+import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
+import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
+import { ResourceIF } from '@/interfaces/'
+
+export const BcCorrectionResource: ResourceIF = {
+  entityReference: 'Company',
+  contactLabel: 'Registered Office',
+  displayName: null, // not used
+  entityType: CorpTypeCd.BC_COMPANY,
+  addressLabel: 'Registered Office',
+  title: 'Benefit Company Statement',
+  description: 'This company is a benefit company and, as such, has purposes that include conducting its business in' +
+               ' a responsible and sustainable manner and promoting one or more public benefits.',
+  filingData: {
+    filingTypeCode: FilingCodes.CORRECTION,
+    entityType: CorpTypeCd.BC_COMPANY,
+    priority: false
+  },
+  changeData: {
+    nameChangeOptions: [
+      CorrectionTypes.CORRECT_NEW_NR,
+      CorrectionTypes.CORRECT_NAME_TO_NUMBER,
+      CorrectionTypes.CORRECT_NAME
+    ],
+    orgPersonInfo: {
+      orgPersonLabel: 'Directors',
+      subtitle: null // not used
+    },
+    nameRequestTypes: [
+      NameRequestTypes.CHANGE_OF_NAME,
+      NameRequestTypes.CONVERSION
+    ]
+  },
+  certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +
+    'of a material fact in a record submitted to the Corporate Registry for filing. ' +
+    'See section 427 of the Business Corporations Act.'
+}

src/resources/Correction/SoleProprietorshipResource.ts → src/resources/Correction/SoleProprietorship.ts

@@ -2,7 +2,7 @@ import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
 import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
 import { ResourceIF } from '@/interfaces/'
 
-export const SoleProprietorshipResource: ResourceIF = {
+export const SpCorrectionResource: ResourceIF = {
   entityReference: 'Business',
   contactLabel: 'Business',
   displayName: null, // not used

src/resources/Correction/UnlimitedLiabilityCompany.ts

@@ -0,0 +1,37 @@
+import { CorrectionTypes, FilingCodes, NameRequestTypes } from '@/enums/'
+import { CorpTypeCd } from '@bcrs-shared-components/corp-type-module/'
+import { ResourceIF } from '@/interfaces/'
+
+export const UlcCorrectionResource: ResourceIF = {
+  entityReference: 'Company',
+  contactLabel: 'Registered Office',
+  displayName: null, // not used
+  entityType: CorpTypeCd.BC_ULC_COMPANY,
+  addressLabel: 'Registered Office',
+  title: 'Benefit Company Statement',
+  description: 'This company is a benefit company and, as such, has purposes that include conducting its business in' +
+               ' a responsible and sustainable manner and promoting one or more public benefits.',
+  filingData: {
+    filingTypeCode: FilingCodes.CORRECTION,
+    entityType: CorpTypeCd.BC_ULC_COMPANY,
+    priority: false
+  },
+  changeData: {
+    nameChangeOptions: [
+      CorrectionTypes.CORRECT_NEW_NR,
+      CorrectionTypes.CORRECT_NAME_TO_NUMBER,
+      CorrectionTypes.CORRECT_NAME
+    ],
+    orgPersonInfo: {
+      orgPersonLabel: 'Directors',
+      subtitle: null // not used
+    },
+    nameRequestTypes: [
+      NameRequestTypes.CHANGE_OF_NAME,
+      NameRequestTypes.CONVERSION
+    ]
+  },
+  certifyClause: 'Note: It is an offence to make a false or misleading statement in respect ' +
+    'of a material fact in a record submitted to the Corporate Registry for filing. ' +
+    'See section 427 of the Business Corporations Act.'
+}

src/resources/Correction/index.ts

@@ -1,4 +1,6 @@
-export * from './AgreementTypeResource'
-export * from './BenefitCompanyStatementResource'
-export * from './GeneralPartnershipResource'
-export * from './SoleProprietorshipResource'
+export * from './BenefitCompany'
+export * from './CommunityContributionCompany'
+export * from './GeneralPartnership'
+export * from './LimitedCompany'
+export * from './SoleProprietorship'
+export * from './UnlimitedLiabilityCompany'

src/resources/SpecialResolution/index.ts

@@ -1 +1 @@
-export * from './CooperativeResource'
+export * from './Cooperative'

src/utils/FetchConfig.ts

@@ -90,6 +90,12 @@ export async function FetchConfig (): Promise<any> {
     console.info('Set Siteminder Logout Url to: ' + siteminderLogoutUrl)
   }
 
+  const hotjarId: string = response.data['HOTJAR_ID']
+  if (hotjarId) {
+    (<any>window).hotjarId = hotjarId
+    console.info('Set Hotjar ID.')
+  }
+
   const addressCompleteKey: string = response.data['ADDRESS_COMPLETE_KEY']
   if (addressCompleteKey) {
     (<any>window).addressCompleteKey = addressCompleteKey

src/views/Correction.vue

@@ -1,7 +1,7 @@
 <template>
   <div>
     <BenCorrection
-      v-if="isEntityTypeBEN"
+      v-if="isBcBenCccUlc"
       :correctionFiling="correctionFiling"
       @fetchError="emitFetchError($event)"
       @haveData="emitHaveData($event)"
@@ -40,7 +40,10 @@ export default class Correction extends Mixins(CommonMixin) {
   // Global getters
   @Getter getBusinessId!: string
   @Getter isRoleStaff!: boolean
+  @Getter isEntityTypeBC!: boolean
   @Getter isEntityTypeBEN!: boolean
+  @Getter isEntityTypeCCC!: boolean
+  @Getter isEntityTypeULC!: boolean
   @Getter isEntityTypeFirm!: boolean
 
   // Global actions
@@ -49,6 +52,13 @@ export default class Correction extends Mixins(CommonMixin) {
 
   protected correctionFiling: CorrectionFilingIF = null
 
+  /** True is the entity type is BC/BEN/CCC/ULC. */
+  get isBcBenCccUlc (): boolean {
+    return (
+      this.isEntityTypeBC || this.isEntityTypeBEN || this.isEntityTypeCCC || this.isEntityTypeULC
+    )
+  }
+
   /** True if user is authenticated. */
   get isAuthenticated (): boolean {
     return Boolean(sessionStorage.getItem(SessionStorageKeys.KeyCloakToken))
@@ -116,7 +126,7 @@ export default class Correction extends Mixins(CommonMixin) {
       // set entity type for misc functionality to work
       // do not proceed if this isn't a BEN or SP/GP correction
       this.setEntityType(filing.business?.legalType)
-      if (!this.isEntityTypeBEN && !this.isEntityTypeFirm) {
+      if (!this.isBcBenCccUlc && !this.isEntityTypeFirm) {
         throw new Error('Invalid correction type')
       }
 

src/views/Correction/BenCorrection.vue

@@ -54,15 +54,16 @@
 
 <script lang="ts">
 import { Component, Emit, Mixins, Prop, Watch } from 'vue-property-decorator'
-import { Action } from 'vuex-class'
+import { Action, Getter } from 'vuex-class'
 import { Articles } from '@/components/Alteration/'
 import { CertifySection, Detail, PeopleAndRoles, ShareStructures, StaffPayment, YourCompany, CompletingParty }
   from '@/components/common/'
 import { CommonMixin, DateMixin, FeeMixin, FilingTemplateMixin } from '@/mixins/'
 import { AuthServices, LegalServices } from '@/services/'
 import { StaffPaymentOptions } from '@bcrs-shared-components/enums/'
-import { ActionBindingIF, CorrectionFilingIF, EntitySnapshotIF } from '@/interfaces/'
-import { BenefitCompanyStatementResource } from '@/resources/Correction/'
+import { ActionBindingIF, CorrectionFilingIF, EntitySnapshotIF, ResourceIF } from '@/interfaces/'
+import { BcCorrectionResource, BenCorrectionResource, CccCorrectionResource, UlcCorrectionResource }
+  from '@/resources/Correction/'
 
 @Component({
   components: {
@@ -77,6 +78,12 @@ import { BenefitCompanyStatementResource } from '@/resources/Correction/'
   }
 })
 export default class BenCorrection extends Mixins(CommonMixin, DateMixin, FeeMixin, FilingTemplateMixin) {
+  // Global getters
+  @Getter isEntityTypeBC!: boolean
+  @Getter isEntityTypeBEN!: boolean
+  @Getter isEntityTypeCCC!: boolean
+  @Getter isEntityTypeULC!: boolean
+
   // Global actions
   @Action setHaveUnsavedChanges!: ActionBindingIF
   @Action setCertifyStatementResource!: ActionBindingIF
@@ -91,8 +98,14 @@ export default class BenCorrection extends Mixins(CommonMixin, DateMixin, FeeMix
   }
 
   /** The resource object for a correction filing. */
-  get correctionResource (): any {
-    return BenefitCompanyStatementResource
+  get correctionResource (): ResourceIF {
+    switch (true) {
+      case this.isEntityTypeBC: return BcCorrectionResource
+      case this.isEntityTypeBEN: return BenCorrectionResource
+      case this.isEntityTypeCCC: return CccCorrectionResource
+      case this.isEntityTypeULC: return UlcCorrectionResource
+    }
+    throw new Error(`Invalid Correction Resource entity type = ${this.getEntityType}`)
   }
 
   /**