Skip to content

list-programs.md

Latest commit

 

History

History
61 lines (48 loc) · 2.32 KB

list-programs.md

File metadata and controls

61 lines (48 loc) · 2.32 KB

ListProgramsUsecase

Purpose

Executes this business operation according to domain rules implemented in the use case.

Trigger / entry point

  • Internal invocation through dependency injection (Inversify).

Inputs

Name Required Type Description
dto Yes object Use case input DTO (see implementation file).

Preconditions

  • Input DTO must respect constraints enforced by the implementation.
  • Caller context/authorization must satisfy business checks implemented in the use case.

Main flow

  1. Validates input/access constraints defined in execute and helper guards.
  2. Uses bddService dependency to read/write required domain data.
  3. Applies role-specific visibility:
    • ADMIN: repository pagination result is returned as-is.
    • COACH: authorized set = public programs + own private templates + own private assigned programs with active coach-athlete link.
    • ATHLETE: authorized set = own private assigned programs + public programs.
  4. Computes total/page/limit from the authorized result set after business filtering.
  5. Uses resolveCoachAthleteVisibilityUsecase for coach checks on assigned private programs.
  6. Uses loggerService dependency to read/write required domain data.

Outputs / side effects

  • Returns the use case result (entity/model/list or boolean depending on implementation).
  • Logs execution errors through the logger service before normalization/rethrow.

Error cases / edge cases

  • Throws ERRORS.LIST_PROGRAMS_FORBIDDEN when the corresponding guard/validation fails.
  • Normalizes or references error code ERRORS.LIST_PROGRAMS_FORBIDDEN.
  • Normalizes or references error code ERRORS.LIST_PROGRAMS_USECASE.

Dependencies

  • bddService
  • loggerService
  • resolveCoachAthleteVisibilityUsecase

Related files

  • api/src/usecases/sport/program/list.programs.usecase.ts
  • api/src/usecases/sport/program/__tests__/list.programs.usecase.spec.ts

Example

{
  "dto": "see implementation DTO"
}

Notes / limitations

  • This document is generated from code and should be updated whenever behavior changes in implementation.
  • If helper modules define additional rules, they are authoritative over this summary.

Automated test reference

  • api/src/usecases/sport/program/__tests__/list.programs.usecase.spec.ts