Skip to content

refactor(food): add explicit return types to repository helpers #1456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcuscastelo merged 2 commits into from
Dec 6, 2025
Merged

refactor(food): add explicit return types to repository helpers #1456

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
19368ea
Initial plan
Copilot Dec 6, 2025
eeb9f0b
refactor(food): encapsulate infrastructure exports - only export fact…
Copilot Dec 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/modules/diet/food/infrastructure/api/infrastructure/supabase/supabaseFoodRepository.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ async function upsertFood(newFood: NewFood): Promise<Food> {
async function fetchFoodsByName(
name: Required<Food>['name'],
params: FoodSearchParams = {},
) {
): Promise<readonly Food[]> {
Comment on lines 133 to +136
Copy link

Copilot AI Dec 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fetchFoodsByName function lacks JSDoc documentation, creating inconsistency with other repository helper functions like fetchFoodById, fetchFoodByEan, and fetchFoodsByIds which all have comprehensive JSDoc. Consider adding documentation following the same pattern:

/**
 * Fetches Foods by name using enhanced search with scoring.
 * Supports both regular search and favorites-only search.
 * @param name - The food name to search for
 * @param params - Optional search parameters (userId, isFavoritesSearch, limit)
 * @returns Array of matching Foods
 * @throws Error on API/validation error
 */
async function fetchFoodsByName(
  name: Required<Food>['name'],
  params: FoodSearchParams = {},
): Promise<readonly Food[]> {

Copilot uses AI. Check for mistakes.
const { userId, isFavoritesSearch, limit = 50 } = params

try {
Expand Down Expand Up @@ -172,7 +172,9 @@ async function fetchFoodsByName(
}
}

Copy link

Copilot AI Dec 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fetchFoods function lacks JSDoc documentation, creating inconsistency with other repository helper functions. Consider adding documentation following the pattern used elsewhere in this file:

/**
 * Fetches all Foods with optional filtering.
 * @param params - Optional search parameters (limit, allowedFoods, etc.)
 * @returns Array of Foods
 * @throws Error on API/validation error
 */
async function fetchFoods(
  params: FoodSearchParams = {},
): Promise<readonly Food[]> {
Suggested change
/**
* Fetches all Foods with optional filtering.
* @param params - Optional search parameters (limit, allowedFoods, etc.)
* @returns Array of Foods
* @throws Error on API/validation error
*/

Copilot uses AI. Check for mistakes.
async function fetchFoods(params: FoodSearchParams = {}) {
async function fetchFoods(
params: FoodSearchParams = {},
): Promise<readonly Food[]> {
return await internalCachedSearchFoods({ field: '', value: '' }, params)
}

Expand Down