#4043 - Update Institution Programs List View

[tiago-graf]

Summary

Updated Institution programs list view to include new status filter, SABC and CIP search.
Moved create program button location.
Added new SABC column.
Allow multiple columns sort

[Copilot]

Pull request overview

This PR updates the Institution programs list view to enhance filtering, searching, and sorting capabilities. The changes include a new status filter with toggle buttons (All, Approved, Pending, Declined, Inactive), expanded search to cover program name/SABC code/CIP, a new SABC program code column in the table, and support for multi-column sorting. The create program button has also been relocated from the header to a more prominent position.

Changes:

• Enhanced the programs list view with status filter toggles and multi-field search (program name, SABC code, CIP)
• Added SABC program code as a new sortable column in the programs table
• Changed default sorting from status-based priority to alphabetical by program name, with all columns now sortable
• Refactored search and filter implementation in both frontend (Vue) and backend (NestJS) to support the new filtering options

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
sources/packages/web/src/views/institution/locations/programs/LocationPrograms.vue	Updated UI with new status filter buttons, moved search box, added search button, implemented filter watcher logic, and added default sort configuration
sources/packages/web/src/types/contracts/DataTableContract.ts	Added SabcCode to ProgramSummaryFields enum, reordered and updated headers with new SABC column, made all columns sortable
sources/packages/web/src/services/http/dto/EducationProgram.dto.ts	Added optional sabcCode field to EducationProgramsSummaryAPIOutDTO
sources/packages/backend/apps/api/src/services/education-program/education-program.service.ts	Enhanced search to query name/CIP/SABC with OR logic, added status and inactive filtering, changed default sort from status priority to name ascending, added sabcCode to query selection
sources/packages/backend/apps/api/src/services/education-program/education-program.service.models.ts	Added optional sabcCode field to EducationProgramsSummary interface
sources/packages/backend/apps/api/src/route-controllers/models/pagination.dto.ts	Added cipCode, sabcCode, and totalOfferings to allowed sort fields
sources/packages/backend/apps/api/src/route-controllers/education-program/models/education-program.dto.ts	Added optional sabcCode field to EducationProgramsSummaryAPIOutDTO
sources/packages/backend/apps/api/src/route-controllers/education-program/education-program.controller.service.ts	Added sabcCode mapping in getProgramsSummary result transformation
sources/packages/backend/apps/api/src/utilities/datatable-database-mapping-utils.ts	Added column mappings for cipCode, sabcCode, and totalOfferings to support sorting
sources/packages/backend/apps/api/src/utilities/datatable-config.ts	Changed ProgramPaginationOptions to extend PaginationOptions instead of BasePaginationOptions

[dheepak-aot]

Please add some screenshots to PR description as it is a considerable UI update.

[dheepak-aot]

From the moment that DTOs are start to deviate, We can have DTO specific to the API and also stop using the same controller service method.

We split the existing methods in education-program.controller.service.ts this way just by centralizing the transformation and allowing to use the new InDTO(LocationProgramsPaginationOptionsAPIInDTO is just a suggested name).

  async getProgramsSummary(
    institutionId: number,
    paginationOptions: ProgramsPaginationOptionsAPIInDTO,
  ): Promise<PaginatedResultsAPIOutDTO<EducationProgramsSummaryAPIOutDTO>> {
    const programs = await this.programService.getProgramsSummary(
      institutionId,
      [OfferingTypes.Public, OfferingTypes.Private],
      paginationOptions,
    );
    return this.mapEductionProgramPaginatedResults(programs);
  }

  async getProgramsSummaryForLocation(
    institutionId: number,
    paginationOptions: LocationProgramsPaginationOptionsAPIInDTO,
    locationId: number,
  ): Promise<PaginatedResultsAPIOutDTO<EducationProgramsSummaryAPIOutDTO>> {
    const programs = await this.programService.getProgramsSummaryForLocation(
      institutionId,
      [OfferingTypes.Public, OfferingTypes.Private],
      paginationOptions,
      locationId,
    );
    return this.mapEductionProgramPaginatedResults(programs);
  }

  private mapEductionProgramPaginatedResults(
    programs: PaginatedResults<EducationProgramsSummary>,
  ): PaginatedResultsAPIOutDTO<EducationProgramsSummaryAPIOutDTO> {
    return {
      results: programs.results.map((program) => ({
        programId: program.programId,
        programName: program.programName,
        cipCode: program.cipCode,
        sabcCode: program.sabcCode,
        credentialType: program.credentialType,
        totalOfferings: program.totalOfferings,
        submittedDate: program.submittedDate,
        locationId: program.locationId,
        locationName: program.locationName,
        programStatus: program.programStatus,
        isActive: program.isActive,
        isExpired: program.isExpired,
        credentialTypeToDisplay: credentialTypeToDisplay(
          program.credentialType,
        ),
      })),
      count: programs.count,
    };
  }

[dheepak-aot]

CIP is all numbers and just like should be good enough.

For the SABC code we had a discussion during the grooming that DB is expected to have the SABC code only upper case. Hence like can be used after paginationOptions.searchCriteria.toUpperCase()

@andrewsignori-aot that was the grooming discussion right?

[andrewsignori-aot]

@dheepak-aot, yes, the uppercase was discussed, and we can have it as uppercase to avoid creating a DB index for case-insensitive search.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[github-actions]

Backend Unit Tests Coverage Report

Totals
Statements:	20.33% ( 4502 / 22149 )
Methods:	9.74% ( 262 / 2689 )
Lines:	24.56% ( 3854 / 15692 )
Branches:	10.24% ( 386 / 3768 )

[github-actions]

E2E Workflow Workers Coverage Report

Totals
Statements:	75.53% ( 1062 / 1406 )
Methods:	79.45% ( 116 / 146 )
Lines:	78.88% ( 773 / 980 )
Branches:	61.79% ( 173 / 280 )

[github-actions]

E2E Queue Consumers Coverage Report

Totals
Statements:	85.68% ( 1616 / 1886 )
Methods:	85% ( 187 / 220 )
Lines:	88.64% ( 1287 / 1452 )
Branches:	66.36% ( 142 / 214 )

[github-actions]

E2E SIMS API Coverage Report

Totals
Statements:	77.26% ( 9344 / 12094 )
Methods:	75.72% ( 1079 / 1425 )
Lines:	81.57% ( 6766 / 8295 )
Branches:	63.14% ( 1499 / 2374 )

[dheepak-aot]

Thanks for making the changes. Looks good 👍