15538 Don't set initial restoration type + misc cleanup (#693)

* - app version = 7.3.24
- misc package updates
- refactored restoration filing init (to support null type)
- refactored restoration filing resume
- deleted unneeded application types

* wip

* - set initial route for Create UI
- updated unit tests

---------

Co-authored-by: Severin Beauvais <severin.beauvais@gov.bc.ca>

package.json

@@ -1,6 +1,6 @@
 {
  "name": "business-filings-ui",
- "version": "7.3.23",
+ "version": "7.3.24",
  "private": true,
  "appName": "Filings UI",
  "sbcName": "SBC Common Components",
@@ -38,7 +38,6 @@
  "http-status-codes": "^2.2.0",
  "launchdarkly-js-client-sdk": "^2.24.2",
  "lodash": "^4.17.21",
- "lodash.omit": "^4.5.0",
  "pdfjs-dist": "3.9.179",
  "pinia": "^2.0.35",
  "pinia-class": "^0.0.3",
@@ -48,7 +47,7 @@
  "register-service-worker": "^1.7.2",
  "rxjs": "^7.8.1",
  "sbc-common-components": "3.0.13",
- "vue": "2.7.14",
+ "vue": "2.7.16",
  "vue-affix": "^0.5.2",
  "vue-auto-resize": "^1.0.1",
  "vue-hotjar": "^1.4.0",
@@ -60,7 +59,7 @@
  },
  "devDependencies": {
  "@pinia/testing": "^0.0.16",
- "@types/lodash": "^4.14.194",
+ "@types/lodash": "^4.17.7",
  "@types/sinon": "^10.0.14",
  "@types/vue-the-mask": "^0.11.1",
  "@types/vuelidate": "^0.7.16",
@@ -82,7 +81,7 @@
  "vite": "4.5.2",
  "vite-plugin-environment": "^1.1.3",
  "vitest": "0.33.0",
- "volar-service-vetur": "^0.0.54",
+ "volar-service-vetur": "^0.0.62",
  "vue-class-component": "^7.2.6",
  "vue-debounce-decorator": "^1.0.1",
  "vue-property-decorator": "^9.1.2",

src/components/Dashboard/StaffNotation.vue

@@ -138,7 +138,7 @@
  v-if="isHistorical"
  data-type="restoration"
  :disabled="!isAllowed(AllowableActions.RESTORATION)"
- @click="goToRestorationFiling(ApplicationTypes.CREATE_UI, FilingSubTypes.FULL_RESTORATION)"
+ @click="goToRestorationFiling()"
  >
  <v-list-item-title>
  <span class="app-blue">Restore Company</span>
@@ -212,7 +212,7 @@
  <v-list-item
  v-if="isAllowed(AllowableActions.LIMITED_RESTORATION_EXTENSION)"
  data-type="extend-limited-restoration"
- @click="goToRestorationFiling(ApplicationTypes.EDIT_UI, FilingSubTypes.LIMITED_RESTORATION_EXTENSION)"
+ @click="goToRestorationFiling(FilingSubTypes.LIMITED_RESTORATION_EXTENSION)"
  >
  <v-list-item-title>
  <span class="app-blue">Extend Limited Restoration</span>
@@ -222,7 +222,7 @@
  <v-list-item
  v-if="isAllowed(AllowableActions.LIMITED_RESTORATION_TO_FULL)"
  data-type="convert-full-restoration"
- @click="goToRestorationFiling(ApplicationTypes.EDIT_UI, FilingSubTypes.LIMITED_RESTORATION_TO_FULL)"
+ @click="goToRestorationFiling(FilingSubTypes.LIMITED_RESTORATION_TO_FULL)"
  >
  <v-list-item-title>
  <span class="app-blue">Convert to Full Restoration</span>
@@ -239,12 +239,7 @@
 import { Component, Emit, Mixins, Prop } from 'vue-property-decorator'
 import { Action, Getter } from 'pinia-class'
 import { GetFeatureFlag, navigate } from '@/utils'
-import {
- AllowableActions,
- ApplicationTypes,
- FilingSubTypes,
- Routes
-} from '@/enums'
+import { AllowableActions, FilingSubTypes, Routes } from '@/enums'
 import { FilingNames, FilingTypes } from '@bcrs-shared-components/enums'
 import { AddStaffNotationDialog } from '@/components/dialogs'
 import { AllowableActionsMixin, FilingMixin } from '@/mixins'
@@ -265,7 +260,6 @@ export default class StaffNotation extends Mixins(AllowableActionsMixin, FilingM
 
  // enums for template
  readonly AllowableActions = AllowableActions
- readonly ApplicationTypes = ApplicationTypes
  readonly FilingNames = FilingNames
  readonly FilingSubTypes = FilingSubTypes
  readonly FilingTypes = FilingTypes
@@ -373,9 +367,10 @@ export default class StaffNotation extends Mixins(AllowableActionsMixin, FilingM
  this.$router.push({ name: Routes.CONTINUATION_OUT, query: { filingId: '0' } })
  }
 
- async goToRestorationFiling (applicationName: ApplicationTypes, restorationType: FilingSubTypes): Promise<void> {
- let url: string
+ async goToRestorationFiling (restorationType: FilingSubTypes = null): Promise<void> {
  try {
+ let url: string
+
  // show spinner since the network calls below can take a few seconds
  this.setFetchingDataSpinner(true)
 
@@ -386,13 +381,15 @@ export default class StaffNotation extends Mixins(AllowableActionsMixin, FilingM
 
  if (isNaN(id)) throw new Error('Invalid API response')
 
- // navigate to Create UI if Full/Limited restoration
- // navigate to Edit UI if Limited extension/Full to Limited conversion
- if (applicationName === ApplicationTypes.CREATE_UI) {
- url = `${this.getCreateUrl}?id=${this.getIdentifier}`
- }
- if (applicationName === ApplicationTypes.EDIT_UI) {
- url = `${this.getEditUrl}${this.getIdentifier}/` + restorationType + `?restoration-id=${id}`
+ // navigate to Edit UI for limited restoration extension filing
+ // navigate to Edit UI for limited restoration to full filing
+ // navigate to Create UI for full or limited restoration filing
+ if (restorationType === FilingSubTypes.LIMITED_RESTORATION_EXTENSION) {
+ url = `${this.getEditUrl}${this.getIdentifier}/limitedRestorationExtension?restoration-id=${id}`
+ } else if (restorationType === FilingSubTypes.LIMITED_RESTORATION_TO_FULL) {
+ url = `${this.getEditUrl}${this.getIdentifier}/limitedRestorationToFull?restoration-id=${id}`
+ } else {
+ url = `${this.getCreateUrl}restoration-business-name?id=${this.getIdentifier}`
  }
 
  navigate(url)

src/components/Dashboard/TodoList.vue

@@ -2086,54 +2086,25 @@ export default class TodoList extends Mixins(AllowableActionsMixin, DateMixin) {
  console.log('doResumeFiling(), invalid filing type =', item)
  }
 
- /* Handles the restoration flow inside of doResumeFiling */
- navigateForResumeRestoration (item: TodoItemIF): void {
- let restorationType: FilingSubTypes
- /**
- * Type assertion is done to fix TypeScript error.
- * "This condition will always return 'false' since the types
- * 'FilingSubTypes' and 'RestorationTypes' have no overlap."
- */
- if (item.filingSubType === FilingSubTypes.FULL_RESTORATION) {
- restorationType = FilingSubTypes.FULL_RESTORATION
- }
-
- if (item.filingSubType === FilingSubTypes.LIMITED_RESTORATION) {
- restorationType = FilingSubTypes.LIMITED_RESTORATION
- }
-
- if (item.filingSubType === FilingSubTypes.LIMITED_RESTORATION_EXTENSION) {
- restorationType = FilingSubTypes.LIMITED_RESTORATION_EXTENSION
- }
-
- if (item.filingSubType === FilingSubTypes.LIMITED_RESTORATION_TO_FULL) {
- restorationType = FilingSubTypes.LIMITED_RESTORATION_TO_FULL
- }
-
- navigate(this.buildRestorationUrl(item, restorationType))
- }
-
- // navigate to Create UI if Full/Limited restoration or to Edit UI if Limited extension/Full to Limited conversion
- buildRestorationUrl (item: TodoItemIF, restorationType: FilingSubTypes): string {
+ /* Called to resume draft restoration filing. */
+ private navigateForResumeRestoration (item: TodoItemIF): void {
  let url: string
 
- switch (restorationType) {
- case FilingSubTypes.FULL_RESTORATION:
- case FilingSubTypes.LIMITED_RESTORATION: {
- url = `${this.getCreateUrl}?id=${this.getIdentifier}`
- break
- }
- case FilingSubTypes.LIMITED_RESTORATION_EXTENSION:
- case FilingSubTypes.LIMITED_RESTORATION_TO_FULL: {
- url = `${this.getEditUrl}${this.getIdentifier}/` + restorationType + `?restoration-id=${item.filingId}`
- break
- }
+ // navigate to Edit UI to resume limited restoration extension filing
+ // navigate to Edit UI to resume limited restoration to full filing
+ // navigate to Create UI to resume full or limited restoration filing
+ if (item.filingSubType === FilingSubTypes.LIMITED_RESTORATION_EXTENSION) {
+ url = `${this.getEditUrl}${this.getIdentifier}/limitedRestorationExtension?restoration-id=${item.filingId}`
+ } else if (item.filingSubType === FilingSubTypes.LIMITED_RESTORATION_TO_FULL) {
+ url = `${this.getEditUrl}${this.getIdentifier}/limitedRestorationToFull?restoration-id=${item.filingId}`
+ } else {
+ url = `${this.getCreateUrl}restoration-business-name?id=${this.getIdentifier}`
  }
 
- return url
+ navigate(url)
  }
 
- // this is called for both Resume Payment and Retry Payment
+ /** Called to change payment type, resume payment or retry payment. */
  doResumePayment (item: TodoItemIF): boolean {
  const paymentToken = item.paymentToken
 

src/enums/index.ts

@@ -2,7 +2,6 @@ export * from './actions'
 export * from './affiliationInvitation'
 export * from './allowableActions'
 export * from './amalgamationEnums'
-export * from './applicationTypes'
 export * from './correctionTypes'
 export * from './digitalCredentialTypes'
 export * from './effectOfOrderTypes'

src/mixins/common-mixin.ts

@@ -1,6 +1,5 @@
 import { Component, Vue } from 'vue-property-decorator'
-import { isEqual } from 'lodash'
-import omit from 'lodash.omit'
+import { isEqual, omit } from 'lodash'
 import { Getter } from 'pinia-class'
 import { useConfigurationStore } from '@/stores'
 import { GetFeatureFlag, navigate } from '@/utils'

src/mixins/filing-mixin.ts

@@ -155,9 +155,10 @@ export default class FilingMixin extends DateMixin {
 
  /**
  * Builds a Restoration filing body.
+ * @param restorationType The type of restoration. May be null.
  * @returns the filing body
  */
- buildRestorationFiling (restorationType = FilingSubTypes.FULL_RESTORATION): RestorationFilingIF {
+ buildRestorationFiling (restorationType: FilingSubTypes): RestorationFilingIF {
  const restoration: RestorationFilingIF = {
  header: {
  date: this.getCurrentDate,

tests/unit/StaffNotation.spec.ts

@@ -668,7 +668,7 @@ describe('StaffNotation', () => {
  await Vue.nextTick()
 
  // verify redirection
- expect(window.location.assign).toHaveBeenCalledWith('https://create.url/?id=BC1234567')
+ expect(window.location.assign).toHaveBeenCalledWith('https://create.url/restoration-business-name?id=BC1234567')
 
  wrapper.destroy()
  sinon.restore()

tests/unit/TodoList1.spec.ts

@@ -3315,7 +3315,7 @@ describe('TodoList - Click Tests - Full and Limited Restoration', () => {
 
  // verify redirection
  const accountId = JSON.parse(sessionStorage.getItem('CURRENT_ACCOUNT'))?.id
- const createUrl = `https://create.url/?id=${test.businessId}`
+ const createUrl = `https://create.url/restoration-business-name?id=${test.businessId}`
  expect(window.location.assign).toHaveBeenCalledWith(createUrl + '&accountid=' + accountId)
 
  wrapper.destroy()