ORV2-2846: CV Client and Staff Applying for Motive-Fuel Permits (#1791)

Author: zgong-gov

frontend/src/common/constants/bannerMessages.ts

@@ -39,6 +39,8 @@ export const BANNER_MESSAGES = {
     EXAMPLE:
       "e.g. If the origin is Victoria, BC and the destination is Hope, BC, the sequence of highways travelled in order will be 17 1 3.",
   },
+  TOTAL_DISTANCE:
+    "The total distance, in km, is the distance that will be travelled within BC (or from/to BC border). This is to include the return trip distance.",
   BRIDGE_FORMULA_CALCULATION_TOOL:
     "This tool only calculates Bridge Formula, which is a mathematical equation that is used to calculate the maximum allowable weight allowed by permit for various axle groups in a combination. This tool is not confirming compliance with the CTR or CTPM.\n\nThe image on the right is for illustration purposes only.",
 };

frontend/src/common/constants/validation_messages.json

@@ -10,6 +10,9 @@
   "NaN": {
     "defaultMessage": "Must be a number"
   },
+  "invalid": {
+    "defaultMessage": "Invalid input"
+  },
   "greaterThan": {
     "messageTemplate": "Must be greater than :val.",
     "placeholders": [":val"]

frontend/src/common/helpers/validationMessages.ts

@@ -16,6 +16,9 @@ export const requiredMessage = () => validationMessages.required.defaultMessage;
 export const selectionRequired = () =>
   validationMessages.selectionRequired.defaultMessage;
 export const invalidNumber = () => validationMessages.NaN.defaultMessage;
+
+export const invalidInput = () => validationMessages.invalid.defaultMessage;
+
 export const mustBeGreaterThan = (val: number) => {
   const { messageTemplate, placeholders } = validationMessages.greaterThan;
   return replacePlaceholders(messageTemplate, placeholders, val);

frontend/src/features/permits/components/dashboard/ApplicationStepPage.tsx

@@ -63,6 +63,7 @@ export const ApplicationStepPage = ({
 
   const { data: featureFlags } = useFeatureFlagsQuery();
   const enableSTOS = featureFlags?.["STOS"] === "ENABLED";
+  const enableMFP = featureFlags?.["MFP"] === "ENABLED";
 
   // Query for the application data whenever this page is rendered
   const {
@@ -99,11 +100,15 @@ export const ApplicationStepPage = ({
     applicationData?.permitType,
   );
 
-  // Currently onRouteBC only handles TROS and TROW permits, and STOS only if feature flag is enabled
+  // Currently onRouteBC only handles TROS and TROW permits, and STOS and MFP only if feature flag is enabled
   const isPermitTypeAllowed = () => {
-    const allowedPermitTypes: string[] = enableSTOS
-      ? [PERMIT_TYPES.TROS, PERMIT_TYPES.TROW, PERMIT_TYPES.STOS]
-      : [PERMIT_TYPES.TROS, PERMIT_TYPES.TROW];
+    const allowedPermitTypes: string[] = [
+      PERMIT_TYPES.TROS,
+      PERMIT_TYPES.TROW,
+      PERMIT_TYPES.STOS,
+      PERMIT_TYPES.MFP,
+    ].filter(pType => enableSTOS ? true : pType !== PERMIT_TYPES.STOS)
+      .filter(pType => enableMFP ? true : pType !== PERMIT_TYPES.MFP);
 
     return allowedPermitTypes.includes(applicationPermitType);
   };

frontend/src/features/permits/components/feeSummary/FeeSummary.tsx

@@ -1,23 +1,26 @@
+import "./FeeSummary.scss";
 import { Nullable } from "../../../../common/types/common";
 import { feeSummaryDisplayText } from "../../helpers/feeSummary";
 import { getPermitTypeName, PermitType } from "../../types/PermitType";
-import "./FeeSummary.scss";
 
 export const FeeSummary = ({
   permitType,
   feeSummary,
   permitDuration,
   hideDescriptions,
+  permittedRouteTotalDistance,
 }: {
   permitType?: Nullable<PermitType>;
   feeSummary?: Nullable<string>;
   permitDuration?: number;
   hideDescriptions?: boolean;
+  permittedRouteTotalDistance?: Nullable<number>;
 }) => {
   const feeDisplayText = feeSummaryDisplayText(
     feeSummary,
     permitDuration,
     permitType,
+    permittedRouteTotalDistance,
   );
 
   return (

frontend/src/features/permits/constants/constants.ts

@@ -62,10 +62,10 @@ export const ALL_PERMIT_TYPE_CHOOSE_FROM_OPTIONS: PermitTypeChooseFromItem[] = [
   //     label: getPermitTypeShortName(permitType),
   //   })),
   // },
-  // {
-  //   value: PERMIT_TYPES.MFP,
-  //   label: getPermitTypeShortName(PERMIT_TYPES.MFP),
-  // },
+  {
+    value: PERMIT_TYPES.MFP,
+    label: getPermitTypeShortName(PERMIT_TYPES.MFP),
+  },
 ];
 
 export interface PermitTypeChooseFromItem {

frontend/src/features/permits/constants/mfp.ts

@@ -0,0 +1,27 @@
+import { PermitCondition } from "../types/PermitCondition";
+
+export const MFP_CONDITIONS: PermitCondition[] = [
+  {
+    description: "Motive Fuel Tax Act",
+    condition: "MV4001",
+    conditionLink: "https://www.th.gov.bc.ca/forms/getForm.aspx?formId=1539",
+    checked: true,
+    disabled: true
+  },
+];
+
+export const MANDATORY_MFP_CONDITIONS: PermitCondition[] = [...MFP_CONDITIONS];
+
+export const MIN_MFP_DURATION = 1;
+export const MAX_MFP_DURATION = 7;
+export const MFP_DURATION_OPTIONS = [
+  { value: MIN_MFP_DURATION, label: "1 Day" },
+  { value: 2, label: "2 Days" },
+  { value: 3, label: "3 Days" },
+  { value: 4, label: "4 Days" },
+  { value: 5, label: "5 Days" },
+  { value: 6, label: "6 Days" },
+  { value: MAX_MFP_DURATION, label: "7 Days" },
+];
+
+export const MFP_DURATION_INTERVAL_DAYS = 1;

frontend/src/features/permits/helpers/conditions.ts

@@ -1,5 +1,6 @@
 import { isVehicleSubtypeLCV } from "../../manageVehicles/helpers/vehicleSubtypes";
 import { LCV_CONDITION } from "../constants/constants";
+import { MANDATORY_MFP_CONDITIONS, MFP_CONDITIONS } from "../constants/mfp";
 import { MANDATORY_STOS_CONDITIONS, STOS_CONDITIONS } from "../constants/stos";
 import { MANDATORY_TROS_CONDITIONS, TROS_CONDITIONS } from "../constants/tros";
 import { MANDATORY_TROW_CONDITIONS, TROW_CONDITIONS } from "../constants/trow";
@@ -18,6 +19,8 @@ export const getMandatoryConditions = (
 ) => {
   const additionalConditions = includeLcvCondition ? [LCV_CONDITION] : [];
   switch (permitType) {
+    case PERMIT_TYPES.MFP:
+      return MANDATORY_MFP_CONDITIONS.concat(additionalConditions);
     case PERMIT_TYPES.STOS:
       return MANDATORY_STOS_CONDITIONS.concat(additionalConditions);
     case PERMIT_TYPES.TROW:
@@ -35,6 +38,8 @@ const getConditionsByPermitType = (
 ) => {
   const additionalConditions = includeLcvCondition ? [LCV_CONDITION] : [];
   switch (permitType) {
+    case PERMIT_TYPES.MFP:
+      return MFP_CONDITIONS.concat(additionalConditions);
     case PERMIT_TYPES.STOS:
       return STOS_CONDITIONS.concat(additionalConditions);
     case PERMIT_TYPES.TROW:

frontend/src/features/permits/helpers/dateSelection.ts

@@ -29,13 +29,22 @@ import {
   STOS_DURATION_OPTIONS,
 } from "../constants/stos";
 
+import {
+  MAX_MFP_DURATION,
+  MFP_DURATION_INTERVAL_DAYS,
+  MFP_DURATION_OPTIONS,
+  MIN_MFP_DURATION,
+} from "../constants/mfp";
+
 /**
  * Get list of selectable duration options for a given permit type.
  * @param permitType Permit type to get duration options for
  * @returns List of selectable duration options for the given permit type
  */
 export const durationOptionsForPermitType = (permitType: PermitType) => {
   switch (permitType) {
+    case PERMIT_TYPES.MFP:
+      return MFP_DURATION_OPTIONS;
     case PERMIT_TYPES.STOS:
       return STOS_DURATION_OPTIONS;
     case PERMIT_TYPES.TROW:
@@ -54,6 +63,8 @@ export const durationOptionsForPermitType = (permitType: PermitType) => {
  */
 export const minDurationForPermitType = (permitType: PermitType) => {
   switch (permitType) {
+    case PERMIT_TYPES.MFP:
+      return MIN_MFP_DURATION;
     case PERMIT_TYPES.STOS:
       return MIN_STOS_DURATION;
     case PERMIT_TYPES.TROW:
@@ -72,6 +83,8 @@ export const minDurationForPermitType = (permitType: PermitType) => {
  */
 export const maxDurationForPermitType = (permitType: PermitType) => {
   switch (permitType) {
+    case PERMIT_TYPES.MFP:
+      return MAX_MFP_DURATION;
     case PERMIT_TYPES.STOS:
       return MAX_STOS_DURATION;
     case PERMIT_TYPES.TROW:
@@ -90,6 +103,8 @@ export const maxDurationForPermitType = (permitType: PermitType) => {
  */
 export const getDurationIntervalDays = (permitType: PermitType) => {
   switch (permitType) {
+    case PERMIT_TYPES.MFP:
+      return MFP_DURATION_INTERVAL_DAYS;
     case PERMIT_TYPES.STOS:
       return STOS_DURATION_INTERVAL_DAYS;
     case PERMIT_TYPES.TROW:

frontend/src/features/permits/helpers/equality.ts

@@ -9,7 +9,7 @@ import { arePermitLOADetailsEqual, PermitLOA } from "../types/PermitLOA";
 import { areOrderedSequencesEqual, doUniqueArraysHaveSameObjects } from "../../../common/helpers/equality";
 import { ReplaceDayjsWithString } from "../types/utility";
 import { PermittedCommodity } from "../types/PermittedCommodity";
-import { PermittedRoute } from "../types/PermittedRoute";
+import { ManualRoute, PermittedRoute } from "../types/PermittedRoute";
 import { PermitVehicleConfiguration } from "../types/PermitVehicleConfiguration";
 
 /**
@@ -191,6 +191,35 @@ export const areVehicleConfigurationsEqual = (
   );
 };
 
+/**
+ * Compare whether or not the manual route details for two permits are equal.
+ * @param manualRoute1 Manual route details belonging to the first permit
+ * @param manualRoute2 Manual route details belonging to the second permit
+ * @returns true when the manual route details are considered equivalent, false otherwise
+ */
+export const areManualRoutesEqual = (
+  manualRoute1?: Nullable<ManualRoute>,
+  manualRoute2?: Nullable<ManualRoute>,
+) => {
+  return (
+    getDefaultRequiredVal("", manualRoute1?.origin)
+      === getDefaultRequiredVal("", manualRoute2?.origin)
+  ) && (
+    getDefaultRequiredVal("", manualRoute1?.destination)
+      === getDefaultRequiredVal("", manualRoute2?.destination)
+  ) && (
+    getDefaultRequiredVal("", manualRoute1?.exitPoint)
+      === getDefaultRequiredVal("", manualRoute2?.exitPoint)
+  ) && (
+    getDefaultRequiredVal(0, manualRoute1?.totalDistance)
+      === getDefaultRequiredVal(0, manualRoute2?.totalDistance)
+  ) && areOrderedSequencesEqual(
+    manualRoute1?.highwaySequence,
+    manualRoute2?.highwaySequence,
+    (seqNumber1, seqNumber2) => seqNumber1 === seqNumber2,
+  );
+};
+
 /**
  * Compare whether or not the permitted route details for two permits are equal.
  * @param permittedRoute1 Permitted route details belonging to the first permit
@@ -201,25 +230,12 @@ export const arePermittedRoutesEqual = (
   permittedRoute1?: Nullable<PermittedRoute>,
   permittedRoute2?: Nullable<PermittedRoute>,
 ) => {
-  return (
-    getDefaultRequiredVal("", permittedRoute1?.manualRoute?.origin)
-      === getDefaultRequiredVal("", permittedRoute2?.manualRoute?.origin)
-  ) && (
-    getDefaultRequiredVal("", permittedRoute1?.manualRoute?.destination)
-      === getDefaultRequiredVal("", permittedRoute2?.manualRoute?.destination)
-  ) && (
-    getDefaultRequiredVal("", permittedRoute1?.manualRoute?.exitPoint)
-      === getDefaultRequiredVal("", permittedRoute2?.manualRoute?.exitPoint)
-  ) && (
-    getDefaultRequiredVal(0, permittedRoute1?.manualRoute?.totalDistance)
-      === getDefaultRequiredVal(0, permittedRoute2?.manualRoute?.totalDistance)
+  return areManualRoutesEqual(
+    permittedRoute1?.manualRoute,
+    permittedRoute2?.manualRoute,
   ) && (
     getDefaultRequiredVal("", permittedRoute1?.routeDetails)
       === getDefaultRequiredVal("", permittedRoute2?.routeDetails)
-  ) && areOrderedSequencesEqual(
-    permittedRoute1?.manualRoute?.highwaySequence,
-    permittedRoute2?.manualRoute?.highwaySequence,
-    (seqNumber1, seqNumber2) => seqNumber1 === seqNumber2,
   );
 };
 

frontend/src/features/permits/helpers/feeSummary.ts

@@ -9,20 +9,23 @@ import {
   getDurationIntervalDays,
   maxDurationForPermitType,
 } from "./dateSelection";
+
 import {
   applyWhenNotNullable,
   getDefaultRequiredVal,
 } from "../../../common/helpers/util";
 
 /**
- * Calculates the fee for a permit only by its duration.
+ * Calculates the fee for a permit.
  * @param permitType Type of permit
  * @param duration Number of days for duration of permit
- * @returns Fee to be paid for the permit duration
+ * @param totalDistance Total distance to travel for the route trip of the permit, if applicable
+ * @returns Fee to be paid for the permit
  */
-export const calculateFeeByDuration = (
+export const calculatePermitFee = (
   permitType: PermitType,
   duration: number,
+  totalDistance?: Nullable<number>,
 ) => {
   const maxAllowableDuration = maxDurationForPermitType(permitType);
 
@@ -43,6 +46,10 @@ export const calculateFeeByDuration = (
 
   switch (permitType) {
     // Add more conditions for other permit types if needed
+    case PERMIT_TYPES.MFP:
+      // MFP only calculate fee based on totalDistance
+      // minimum $20 no matter what, $0.11 per km
+      return Math.max(20, 0.11 * getDefaultRequiredVal(0, totalDistance));
     case PERMIT_TYPES.STOS:
       // STOS have constant fee of $15 (regardless of duration)
       return 15;
@@ -61,20 +68,22 @@ export const calculateFeeByDuration = (
  * @param feeSummary fee summary field for a permit (if exists)
  * @param duration duration field for a permit (if exists)
  * @param permitType type of permit (if exists)
+ * @param totalDistance total distance to travel for the route trip of a permit (if applicable)
  * @returns display text for the fee summary (currency amount to 2 decimal places)
  */
 export const feeSummaryDisplayText = (
   feeSummary?: Nullable<string>,
   duration?: Nullable<number>,
   permitType?: Nullable<PermitType>,
+  totalDistance?: Nullable<number>,
 ) => {
   const feeFromSummary = applyWhenNotNullable(
     (numericStr) => Number(numericStr).toFixed(2),
     feeSummary,
   );
   const feeFromDuration =
     duration && permitType
-      ? calculateFeeByDuration(permitType, duration).toFixed(2)
+      ? calculatePermitFee(permitType, duration, totalDistance).toFixed(2)
       : null;
 
   const fee = getDefaultRequiredVal("0.00", feeFromSummary, feeFromDuration);
@@ -113,25 +122,29 @@ export const calculateNetAmount = (permitHistory: PermitHistory[]) => {
 };
 
 /**
- * Calculates the amount that needs to be refunded (or paid if amount is negative) for a permit given a new duration period.
+ * Calculates the amount that needs to be refunded (or paid if amount is negative) for a permit.
  * @param permitHistory List of history objects that make up the history of a permit and its transactions
  * @param currDuration Current (updated) duration of the permit
- * @param currPermitType Permit type of current permit to refund
+ * @param currPermitType Permit type of current permit to refund for
+ * @param updatedTotalDistance Updated total distance of the route trip for the permit (if applicable)
  * @returns Amount that needs to be refunded, or if negative then the amount that still needs to be paid
  */
 export const calculateAmountToRefund = (
   permitHistory: PermitHistory[],
   currDuration: number,
   currPermitType: PermitType,
+  updatedTotalDistance?: Nullable<number>,
 ) => {
   const netPaid = calculateNetAmount(permitHistory);
   if (isZeroAmount(netPaid)) return 0; // If total paid is $0 (eg. no-fee permits), then refund nothing
 
-  const feeForCurrDuration = calculateFeeByDuration(
+  const updatedFee = calculatePermitFee(
     currPermitType,
     currDuration,
+    updatedTotalDistance,
   );
-  return netPaid - feeForCurrDuration;
+
+  return netPaid - updatedFee;
 };
 
 /**