feat(FSADT1-861): adding bcsc form

.github/pull_request_template.md

@@ -8,7 +8,7 @@ Fixes # (issue)
 
 ## Type of change
 
-Please delete options that are not relevant.
+<!-- Please delete options that are not relevant. -->
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
@@ -17,10 +17,17 @@ Please delete options that are not relevant.
 
 # How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+<!-- Please describe the tests you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration -->
 
-- [ ] Test A
-- [ ] Test B
+<!-- Please delete options that are not relevant. -->
+
+- [ ] New unit tests
+- [ ] New integrated tests
+- [ ] New component tests
+- [ ] New end-to-end tests
+- [ ] New user flow tests
+- [ ] No new tests are required
+- [ ] Manual tests (description below)
 
 
 ## Checklist

.github/workflows/pr-open.yml

@@ -171,7 +171,7 @@ jobs:
             -p COGNITO_DOMAIN=${{ secrets.COGNITO_DOMAIN }}
             -p COGNITO_ENVIRONMENT=DEV
             -p COGNITO_REDIRECT_URI=https://${{ env.PREFIX }}-frontend.${{ env.DOMAIN }}/dashboard
-            -p COGNITO_LOGOUT_URI=https://${{ env.PREFIX }}-frontend.${{ env.DOMAIN }}/
+            -p COGNITO_LOGOUT_URI=https://${{ env.PREFIX }}-frontend.${{ env.DOMAIN }}
 
       - name: Deploy Database
         uses: bcgov-nr/[email protected]

.github/workflows/unit-tests.yml

@@ -146,7 +146,7 @@ jobs:
         uses: actions/checkout@v3
 
       - name: Run Trivy vulnerability scanner in repo mode
-        uses: aquasecurity/trivy-action@0.10.0
+        uses: aquasecurity/trivy-action@0.12.0
         with:
           scan-type: "fs"
           format: "sarif"

.gitignore

@@ -570,4 +570,5 @@ frontend/cypress/videos/*
 reports/
 frontend/reports/
 
-**/sonar-report.xml
+**/sonar-report.xml
+**/config/*.jks

backend/src/main/java/ca/bc/gov/app/configuration/GlobalServiceConfiguration.java

@@ -34,9 +34,9 @@
 import ca.bc.gov.app.dto.client.ClientContactDto;
 import ca.bc.gov.app.dto.client.ClientLocationDto;
 import ca.bc.gov.app.dto.client.ClientLookUpDto;
-import ca.bc.gov.app.dto.client.ClientNameCodeDto;
 import ca.bc.gov.app.dto.client.ClientSubmissionDto;
 import ca.bc.gov.app.dto.client.ClientValueTextDto;
+import ca.bc.gov.app.dto.client.CodeNameDto;
 import ca.bc.gov.app.dto.cognito.AuthResponse;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.aot.hint.annotation.RegisterReflectionForBinding;
@@ -64,9 +64,9 @@
     ClientContactDto.class,
     ClientLocationDto.class,
     ClientLookUpDto.class,
-    ClientNameCodeDto.class,
     ClientSubmissionDto.class,
     ClientValueTextDto.class,
+    CodeNameDto.class,
     BcRegistryAddressDto.class,
     BcRegistryBusinessAdressesDto.class,
     BcRegistryBusinessDto.class,

backend/src/main/java/ca/bc/gov/app/controller/client/ClientAddressController.java

@@ -1,7 +1,7 @@
 package ca.bc.gov.app.controller.client;
 
 import ca.bc.gov.app.dto.client.ClientAddressDto;
-import ca.bc.gov.app.dto.client.ClientNameCodeDto;
+import ca.bc.gov.app.dto.client.CodeNameDto;
 import ca.bc.gov.app.service.client.ClientAddressService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
@@ -45,14 +45,14 @@ public class ClientAddressController {
                   array = @ArraySchema(
                       schema = @Schema(
                           name = "NameCode",
-                          implementation = ClientNameCodeDto.class
+                          implementation = CodeNameDto.class
                       )
                   )
               )
           )
       }
   )
-  public Flux<ClientNameCodeDto> findPossibleAddresses(
+  public Flux<CodeNameDto> findPossibleAddresses(
       @Parameter(description =
           "The name or ISO 2 or 3 character code for the country to search in, defaults to CA",
           example = "UK")

backend/src/main/java/ca/bc/gov/app/controller/client/ClientController.java

@@ -2,13 +2,14 @@
 
 import ca.bc.gov.app.dto.bcregistry.ClientDetailsDto;
 import ca.bc.gov.app.dto.client.ClientLookUpDto;
-import ca.bc.gov.app.dto.client.ClientNameCodeDto;
+import ca.bc.gov.app.dto.client.CodeNameDto;
 import ca.bc.gov.app.dto.client.EmailRequestDto;
 import ca.bc.gov.app.exception.NoClientDataFound;
 import ca.bc.gov.app.service.client.ClientService;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import java.time.LocalDate;
 import lombok.RequiredArgsConstructor;
+import org.apache.commons.text.WordUtils;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -39,17 +40,23 @@ public Mono<ClientDetailsDto> getClientDetails(@PathVariable String clientNumber
   }
 
   @GetMapping("/activeCountryCodes")
-  public Flux<ClientNameCodeDto> listCountries(
+  public Flux<CodeNameDto> listCountries(
       @RequestParam(value = "page", required = false, defaultValue = "0")
       Integer page,
       @RequestParam(value = "size", required = false, defaultValue = "10")
       Integer size) {
     return clientService
         .listCountries(page, size);
   }
+
+  @GetMapping("/getCountryByCode/{countryCode}")
+  public Mono<Object> getCountryByCode(
+      @PathVariable String countryCode) {
+    return clientService.getCountryByCode(countryCode);
+  }
 
   @GetMapping("/activeCountryCodes/{countryCode}")
-  public Flux<ClientNameCodeDto> listProvinces(
+  public Flux<CodeNameDto> listProvinces(
       @PathVariable String countryCode,
       @RequestParam(value = "page", required = false, defaultValue = "0")
       Integer page,
@@ -60,13 +67,13 @@ public Flux<ClientNameCodeDto> listProvinces(
   }
 
   @GetMapping("/activeClientTypeCodes")
-  public Flux<ClientNameCodeDto> findActiveClientTypeCodes() {
+  public Flux<CodeNameDto> findActiveClientTypeCodes() {
     return clientService
         .findActiveClientTypeCodes(LocalDate.now());
   }
 
   @GetMapping("/activeContactTypeCodes")
-  public Flux<ClientNameCodeDto> listClientContactTypeCodes(
+  public Flux<CodeNameDto> listClientContactTypeCodes(
       @RequestParam(value = "page", required = false, defaultValue = "0")
       Integer page,
       @RequestParam(value = "size", required = false, defaultValue = "10")
@@ -76,12 +83,19 @@ public Flux<ClientNameCodeDto> listClientContactTypeCodes(
         .listClientContactTypeCodes(page, size);
   }
 
+  /**
+   * Retrieve a Flux of ClientLookUpDto objects by searching for clients with a specific name.
+   *
+   * @param name The name to search for.
+   * @return A Flux of ClientLookUpDto objects that match the given name.
+   */
   @GetMapping(value = "/name/{name}")
   public Flux<ClientLookUpDto> findByClientName(
       @PathVariable String name
   ) {
     return clientService
-        .findByClientNameOrIncorporation(name);
+        .findByClientNameOrIncorporation(name)
+        .map(client -> client.withName(WordUtils.capitalize(client.name())));
   }
 
   @GetMapping(value = "/incorporation/{incorporationId}")

backend/src/main/java/ca/bc/gov/app/dto/client/ClientLookUpDto.java

@@ -1,6 +1,7 @@
 package ca.bc.gov.app.dto.client;
 
 import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.With;
 
 
 @Schema(
@@ -14,6 +15,7 @@
         "legalType": "SP"
         }"""
 )
+@With
 public record ClientLookUpDto(
     @Schema(description = "The code for that specific object", example = "00000002")
     String code,

backend/src/main/java/ca/bc/gov/app/dto/client/CodeNameDto.java

@@ -0,0 +1,40 @@
+package ca.bc.gov.app.dto.client;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+
+/**
+ * The {@code CodeNameDto} class represents a simple data transfer object (DTO) that encapsulates
+ * a name and code for a specific object. It is used to transfer this information between different
+ * parts of an application.
+ * This class is annotated with Swagger annotations for generating API documentation. It provides
+ * a description and example JSON representation for the object it represents.
+ *
+ * <p>
+ * Example JSON representation:
+ * <pre>{@code
+ * {
+ *   "code": "00000002",
+ *   "name": "BAXTER"
+ * }
+ * }</pre>
+ * </p>
+ *
+ * @see Schema
+ */
+@Schema(
+    description = "A simple name and code object",
+    title = "NameCode",
+    example = """
+        {
+          "code": "00000002",
+          "name": "BAXTER"
+        }"""
+)
+public record CodeNameDto(
+    @Schema(description = "The code for that specific object", example = "00000002")
+    String code,
+
+    @Schema(description = "The name information for that specific object", example = "BAXTER")
+    String name
+) {
+}

backend/src/main/java/ca/bc/gov/app/entity/client/CountryCodeEntity.java

@@ -33,4 +33,9 @@ public class CountryCodeEntity extends ExpirableBaseEntity {
   @NotNull
   private Integer order;
 
+  public CountryCodeEntity(@NotNull @Size(min = 2, max = 2) String countryCode, @NotNull String description) {
+    this.countryCode = countryCode;
+    this.description = description;
+  }
+
 }

backend/src/main/java/ca/bc/gov/app/service/client/ClientAddressService.java

@@ -5,8 +5,8 @@
 import ca.bc.gov.app.dto.client.AddressCompleteRetrieveListDto;
 import ca.bc.gov.app.dto.client.AddressError;
 import ca.bc.gov.app.dto.client.ClientAddressDto;
-import ca.bc.gov.app.dto.client.ClientNameCodeDto;
 import ca.bc.gov.app.dto.client.ClientValueTextDto;
+import ca.bc.gov.app.dto.client.CodeNameDto;
 import ca.bc.gov.app.exception.AddressLookupException;
 import java.util.List;
 import java.util.Map;
@@ -34,7 +34,7 @@ public ClientAddressService(
     this.addressCompleteApi = addressCompleteApi;
   }
 
-  public Flux<ClientNameCodeDto> findPossibleAddresses(
+  public Flux<CodeNameDto> findPossibleAddresses(
       String country, Integer maxSuggestions, String searchTerm) {
     log.info("Searching for address {} for country {}", searchTerm, country);
     return
@@ -95,9 +95,9 @@ public Flux<ClientNameCodeDto> findPossibleAddresses(
             })
             .flatMapMany(Flux::fromIterable)
             .filter(address -> "Retrieve" .equalsIgnoreCase(address.next()))
-            .map(address -> new ClientNameCodeDto(
+            .map(address -> new CodeNameDto(
                     address.id(),
-                    String.format("%s %s", address.text(), address.description())
+                    String.format("%s %s", address.text().trim(), address.description().trim())
                 )
             );
   }
@@ -137,7 +137,7 @@ public Mono<ClientAddressDto> getAddress(String addressId) {
                 new ClientAddressDto(
                     String.format("%s %s %s %s %s", address.line1(), address.line2(),
                         address.line3(), address.line4(), address.line5()
-                    ),
+                    ).trim(),
                     new ClientValueTextDto(address.countryIso2(), address.countryName()),
                     new ClientValueTextDto(address.province(), address.provinceName()),
                     address.city(),