#2741 - Ministry Filter Search Programs and Offerings [Location Search]

sources/packages/backend/apps/api/src/route-controllers/models/pagination.dto.ts

@@ -1,6 +1,7 @@
 import { IsEnum, IsIn, IsOptional, Max, MaxLength, Min } from "class-validator";
 import { PAGINATION_SEARCH_MAX_LENGTH } from "../../constants";
 import { FieldSortOrder } from "@sims/utilities";
+import { ProgramStatus } from "@sims/sims-db";
 
 /**
  * Common parameters used when an API result
@@ -77,6 +78,15 @@ export class ProgramsPaginationOptionsAPIInDTO extends PaginationOptionsAPIInDTO
   @IsOptional()
   @IsIn(["submittedDate", "programName", "credentialType"])
   sortField?: string;
+  @IsOptional()
+  @MaxLength(PAGINATION_SEARCH_MAX_LENGTH)
+  programNameSearch?: string;
+  @IsOptional()
+  @MaxLength(PAGINATION_SEARCH_MAX_LENGTH)
+  locationNameSearch?: string;
+  @IsOptional()
+  @IsIn([ProgramStatus.Approved, ProgramStatus.Declined, ProgramStatus.Pending])
+  status?: string;
 }
 
 export class OfferingsPaginationOptionsAPIInDTO extends PaginationOptionsAPIInDTO {

sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts

@@ -33,9 +33,9 @@ import {
 } from "./education-program.service.models";
 import {
   sortProgramsColumnMap,
-  PaginationOptions,
   PaginatedResults,
   SortPriority,
+  ProgramPaginationOptions,
 } from "../../utilities";
 import {
   CustomNamedError,
@@ -271,14 +271,14 @@ export class EducationProgramService extends RecordDataModelService<EducationPro
    * Gets all the programs that are associated with an institution
    * alongside with the total of offerings on locations.
    * @param institutionId id of the institution.
-   * @param paginationOptions pagination options.
+   * @param paginationOptions program related pagination options.
    * @param locationId optional location id to filter.
    * @returns paginated summary for the institution or location.
    */
   async getProgramsSummary(
     institutionId: number,
     offeringTypes: OfferingTypes[],
-    paginationOptions: PaginationOptions,
+    paginationOptions: ProgramPaginationOptions,
     locationId?: number,
   ): Promise<PaginatedResults<EducationProgramsSummary>> {
     const paginatedProgramQuery = this.repo
@@ -331,6 +331,33 @@ export class EducationProgramService extends RecordDataModelService<EducationPro
       });
       queryParams.push(`%${paginationOptions.searchCriteria}%`);
     }
+    if (paginationOptions.programNameSearch) {
+      paginatedProgramQuery.andWhere(
+        "programs.name Ilike :programNameSearchCriteria",
+        {
+          programNameSearchCriteria: `%${paginationOptions.programNameSearch}%`,
+        },
+      );
+      queryParams.push(`%${paginationOptions.programNameSearch}%`);
+    }
+    if (paginationOptions.locationNameSearch) {
+      paginatedProgramQuery.andWhere(
+        "location.name Ilike :locationNameSearchCriteria",
+        {
+          locationNameSearchCriteria: `%${paginationOptions.locationNameSearch}%`,
+        },
+      );
+      queryParams.push(`%${paginationOptions.locationNameSearch}%`);
+    }
+    if (paginationOptions.status) {
+      paginatedProgramQuery.andWhere(
+        "programs.programStatus Ilike :programStatusSearchCriteria",
+        {
+          programStatusSearchCriteria: `%${paginationOptions.status}%`,
+        },
+      );
+      queryParams.push(`%${paginationOptions.status}%`);
+    }
 
     // For getting total raw count before pagination.
     const sqlQuery = paginatedProgramQuery.getSql();

sources/packages/backend/apps/api/src/utilities/datatable-config.ts

@@ -11,6 +11,12 @@ export interface PaginationOptions {
   pageLimit: number;
 }
 
+export interface ProgramPaginationOptions extends PaginationOptions {
+  programNameSearch?: string;
+  locationNameSearch?: string;
+  status?: string;
+}
+
 export enum SortPriority {
   Priority1 = 1,
   Priority2 = 2,

sources/packages/web/src/helpers/helpers/uri.ts

@@ -88,10 +88,22 @@ export const getPaginationQueryString = (
   }
 
   // Search criteria.
-  if (paginationOptions.searchCriteria) {
+  if (
+    paginationOptions.searchCriteria &&
+    typeof paginationOptions.searchCriteria === "string"
+  ) {
     parameters.push(
       `${PaginationParams.SearchCriteria}=${paginationOptions.searchCriteria}`,
     );
   }
+  if (
+    paginationOptions.searchCriteria &&
+    typeof paginationOptions.searchCriteria === "object"
+  ) {
+    const searchCriteria = paginationOptions.searchCriteria;
+    for (const searchCriterion in searchCriteria) {
+      parameters.push(`${searchCriterion}=${searchCriteria[searchCriterion]}`);
+    }
+  }
   return parameters.join("&");
 };

sources/packages/web/src/types/contracts/DataTableContract.ts

@@ -123,7 +123,7 @@ export enum PaginationParams {
  * todo: remove sortOrder: DataTableSortOrder when all primevue datatables are removed.
  */
 export interface PaginationOptions {
-  searchCriteria?: string;
+  searchCriteria?: string | Record<string, string>;
   sortField?: string;
   sortOrder?: DataTableSortOrder | DataTableSortByOrder;
   page: number;

sources/packages/web/src/views/aest/institution/Programs.vue

@@ -7,15 +7,26 @@
           :recordsCount="institutionProgramsSummary.count"
         >
           <template #actions>
-            <v-text-field
-              density="compact"
-              v-model="searchProgramName"
-              label="Search Program Name"
-              variant="outlined"
-              @keyup.enter="goToSearchProgramName()"
-              prepend-inner-icon="mdi-magnify"
-              hide-details="auto"
-            />
+            <v-row>
+              <v-col>
+                <v-text-field
+                  density="compact"
+                  v-model="searchProgramName"
+                  label="Search Program Name"
+                  variant="outlined"
+                  @keyup.enter="goToSearch()"
+                  prepend-inner-icon="mdi-magnify"
+                  hide-details="auto" /></v-col
+              ><v-col>
+                <v-text-field
+                  density="compact"
+                  v-model="searchLocationName"
+                  label="Search Location Name"
+                  variant="outlined"
+                  @keyup.enter="goToSearch()"
+                  prepend-inner-icon="mdi-magnify"
+                  hide-details="auto" /></v-col
+            ></v-row>
           </template>
         </body-header>
       </template>
@@ -98,6 +109,7 @@ export default defineComponent({
       {} as PaginatedResults<EducationProgramsSummary>,
     );
     const searchProgramName = ref("");
+    const searchLocationName = ref("");
     const currentPage = ref();
     const currentPageLimit = ref();
     const loading = ref(true);
@@ -106,18 +118,19 @@ export default defineComponent({
       institutionId: number,
       rowsPerPage: number,
       page: number,
-      programName: string,
       sortColumn?: ProgramSummaryFields,
       sortOrder?: DataTableSortByOrder,
     ) => {
       try {
         loading.value = true;
-        searchProgramName.value = programName;
         institutionProgramsSummary.value =
           await EducationProgramService.shared.getProgramsSummaryByInstitutionId(
             institutionId,
             {
-              searchCriteria: programName,
+              searchCriteria: {
+                programNameSearch: searchProgramName.value,
+                locationNameSearch: searchLocationName.value,
+              },
               pageLimit: rowsPerPage,
               page,
               sortField: sortColumn,
@@ -133,7 +146,6 @@ export default defineComponent({
         props.institutionId,
         DEFAULT_PAGE_LIMIT,
         DEFAULT_DATATABLE_PAGE_NUMBER,
-        searchProgramName.value,
       );
     });
     const goToViewProgramDetail = (programId: number, locationId: number) => {
@@ -154,26 +166,25 @@ export default defineComponent({
         props.institutionId,
         event.itemsPerPage,
         event.page,
-        searchProgramName.value,
         sortByOptions?.key as ProgramSummaryFields,
         sortByOptions?.order,
       );
     };
-    const goToSearchProgramName = async () => {
+    const goToSearch = async () => {
       await getProgramsSummaryList(
         props.institutionId,
         currentPageLimit.value ?? DEFAULT_PAGE_LIMIT,
         currentPage.value ?? DEFAULT_DATATABLE_PAGE_NUMBER,
-        searchProgramName.value,
       );
     };
     return {
       institutionProgramsSummary,
       goToViewProgramDetail,
       DEFAULT_PAGE_LIMIT,
       pageSortEvent,
-      goToSearchProgramName,
+      goToSearch,
       searchProgramName,
+      searchLocationName,
       loading,
       ProgramSummaryFields,
       ProgramHeaders,