@tbs-fitness/contract 0.5.0 → 0.7.0

package/dist/cjs/food/food-import.dto.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.foodImportRowResponseSchema = exports.foodImportBatchResponseSchema = exports.foodImportIssueSchema = exports.foodImportRowsQuerySchema = exports.foodImportListQuerySchema = exports.commitFoodImportSchema = exports.foodImportRowSchema = exports.importIdParamSchema = exports.FOOD_IMPORT_LIMITS = void 0;
+const zod_1 = require("zod");
+const date_time_schema_js_1 = require("../common/date-time.schema.js");
+const pagination_schema_js_1 = require("../common/pagination.schema.js");
+const safe_text_schema_js_1 = require("../common/safe-text.schema.js");
+const index_js_1 = require("../enums/index.js");
+const food_dto_js_1 = require("./food.dto.js");
+const nutrition_js_1 = require("./nutrition.js");
+/** The file limits the API enforces, shared so the upload screen can say them up front. */
+exports.FOOD_IMPORT_LIMITS = {
+    maxFileBytes: 2 * 1024 * 1024,
+    maxRows: 5000,
+    extensions: ['.csv', '.xlsx'],
+};
+exports.importIdParamSchema = zod_1.z.uuid();
+const metadataKeyListSchema = zod_1.z.array(zod_1.z.string().min(1).max(60)).max(50);
+/**
+ * One spreadsheet row after its cells are read. Values per 100 g (or per 100 ml
+ * for a serving in ml). Metadata are keys such as `protein` or `high-protein`,
+ * matched to the library's values. Has no defaults, so it also serves as the
+ * preview response.
+ */
+exports.foodImportRowSchema = zod_1.z
+    .strictObject({
+    name: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NAME_LENGTH),
+    nameHi: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NAME_LENGTH).nullable(),
+    namePa: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NAME_LENGTH).nullable(),
+    englishAlias: (0, safe_text_schema_js_1.safeTextSchema)(200).nullable(),
+    category: zod_1.z.string().min(1).max(60),
+    subcategory: zod_1.z.string().min(1).max(60).nullable(),
+    servingLabel: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NAME_LENGTH),
+    servingQuantity: (0, nutrition_js_1.quantitySchema)(),
+    servingUnit: zod_1.z.enum(index_js_1.SERVING_UNITS),
+    calories: (0, nutrition_js_1.nutrientAmountSchema)(),
+    protein: (0, nutrition_js_1.nutrientAmountSchema)(),
+    carbs: (0, nutrition_js_1.nutrientAmountSchema)(),
+    fat: (0, nutrition_js_1.nutrientAmountSchema)(),
+    sugar: (0, nutrition_js_1.nutrientAmountSchema)().nullable(),
+    fiber: (0, nutrition_js_1.nutrientAmountSchema)().nullable(),
+    solubleFiber: (0, nutrition_js_1.nutrientAmountSchema)().nullable(),
+    insolubleFiber: (0, nutrition_js_1.nutrientAmountSchema)().nullable(),
+    tags: metadataKeyListSchema,
+    mealTimings: metadataKeyListSchema,
+    notes: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NOTES_LENGTH).nullable(),
+})
+    .superRefine((row, ctx) => {
+    for (const issue of (0, nutrition_js_1.nutritionIssues)(row)) {
+        ctx.addIssue({
+            code: 'custom',
+            message: issue.message,
+            path: [issue.path],
+        });
+    }
+});
+exports.commitFoodImportSchema = zod_1.z.strictObject({
+    mode: zod_1.z.enum(index_js_1.FOOD_IMPORT_MODES).default('SKIP_DUPLICATES'),
+    /** Create categories, tags and other values the file uses but the library lacks. */
+    createMissingMetadata: zod_1.z.boolean().default(false),
+});
+exports.foodImportListQuerySchema = pagination_schema_js_1.paginationQuerySchema;
+exports.foodImportRowsQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({
+    status: zod_1.z.enum(index_js_1.FOOD_IMPORT_ROW_STATUSES).optional(),
+});
+// Responses
+exports.foodImportIssueSchema = zod_1.z.object({
+    /** The spreadsheet column, or null for a problem with the whole row. */
+    column: zod_1.z.string().nullable(),
+    code: zod_1.z.string(),
+    message: zod_1.z.string(),
+    severity: zod_1.z.enum(index_js_1.FOOD_IMPORT_ISSUE_SEVERITIES),
+});
+exports.foodImportBatchResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    fileName: zod_1.z.string(),
+    fileType: zod_1.z.enum(index_js_1.FOOD_IMPORT_FILE_TYPES),
+    sheetName: zod_1.z.string().nullable(),
+    status: zod_1.z.enum(index_js_1.FOOD_IMPORT_STATUSES),
+    mode: zod_1.z.enum(index_js_1.FOOD_IMPORT_MODES).nullable(),
+    createMissingMetadata: zod_1.z.boolean(),
+    totalRows: zod_1.z.number().int(),
+    validRows: zod_1.z.number().int(),
+    invalidRows: zod_1.z.number().int(),
+    duplicateRows: zod_1.z.number().int(),
+    emptyRows: zod_1.z.number().int(),
+    createdCount: zod_1.z.number().int(),
+    updatedCount: zod_1.z.number().int(),
+    skippedCount: zod_1.z.number().int(),
+    /** Values the file uses that the library does not have yet, by type key. */
+    unknownMetadata: zod_1.z.array(zod_1.z.object({ typeKey: zod_1.z.string(), values: zod_1.z.array(zod_1.z.string()) })),
+    ignoredColumns: zod_1.z.array(zod_1.z.string()),
+    ignoredSheets: zod_1.z.array(zod_1.z.string()),
+    uploadedBy: zod_1.z.uuid(),
+    expiresAt: date_time_schema_js_1.utcTimestampSchema,
+    committedAt: date_time_schema_js_1.utcTimestampSchema.nullable(),
+    createdAt: date_time_schema_js_1.utcTimestampSchema,
+});
+exports.foodImportRowResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    /** The row number as the spreadsheet shows it, counting the header as row 1. */
+    rowNumber: zod_1.z.number().int(),
+    status: zod_1.z.enum(index_js_1.FOOD_IMPORT_ROW_STATUSES),
+    /** The cells as read, by header. */
+    raw: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
+    parsed: exports.foodImportRowSchema.nullable(),
+    issues: zod_1.z.array(exports.foodImportIssueSchema),
+    matchedFoodId: zod_1.z.uuid().nullable(),
+    resultFoodId: zod_1.z.uuid().nullable(),
+});

package/dist/cjs/food/food-suggestion.dto.d.ts

@@ -0,0 +1,374 @@
+import { z } from 'zod';
+/** Limits on what a client sends, shared so the app can check them before sending. */
+export declare const FOOD_SUGGESTION_LIMITS: {
+    readonly maxPortionQuantity: 10000;
+    readonly maxCalories: 5000;
+    readonly maxMacroGrams: 1000;
+    readonly maxNoteLength: 300;
+    readonly maxPhotoBytes: number;
+    readonly photoContentTypes: readonly ["image/jpeg", "image/png", "image/webp"];
+};
+export declare const MAX_REVIEW_NOTE_LENGTH = 300;
+export declare const MAX_REJECTION_REASON_LENGTH = 500;
+export declare const suggestionIdParamSchema: z.ZodUUID;
+/**
+ * A food a client could not find in the library. Values are the client's best
+ * guess for the portion they ate, not per 100 g.
+ */
+export declare const submitFoodSuggestionSchema: z.ZodObject<{
+    name: z.ZodString;
+    quantity: z.ZodNumber;
+    unit: z.ZodEnum<{
+        BOWL: "BOWL";
+        GRAM: "GRAM";
+        PIECE: "PIECE";
+        CUP: "CUP";
+    }>;
+    calories: z.ZodNumber;
+    protein: z.ZodOptional<z.ZodNumber>;
+    carbs: z.ZodOptional<z.ZodNumber>;
+    fat: z.ZodOptional<z.ZodNumber>;
+    note: z.ZodOptional<z.ZodString>;
+    photoKey: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type SubmitFoodSuggestionInput = z.input<typeof submitFoodSuggestionSchema>;
+export type SubmitFoodSuggestionBody = z.output<typeof submitFoodSuggestionSchema>;
+export declare const suggestionPhotoUploadSchema: z.ZodObject<{
+    contentType: z.ZodEnum<{
+        "image/jpeg": "image/jpeg";
+        "image/png": "image/png";
+        "image/webp": "image/webp";
+    }>;
+    sizeBytes: z.ZodNumber;
+}, z.core.$strict>;
+export type SuggestionPhotoUploadInput = z.input<typeof suggestionPhotoUploadSchema>;
+export type SuggestionPhotoUploadBody = z.output<typeof suggestionPhotoUploadSchema>;
+/** Where to upload the photo. The headers are signed and must be sent exactly. */
+export declare const presignedUploadResponseSchema: z.ZodObject<{
+    key: z.ZodString;
+    url: z.ZodURL;
+    method: z.ZodLiteral<"PUT">;
+    headers: z.ZodRecord<z.ZodString, z.ZodString>;
+    expiresAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type PresignedUploadResponse = z.output<typeof presignedUploadResponseSchema>;
+/** The coach's corrected values for the portion the client logged. */
+export declare const reviewedPortionSchema: z.ZodObject<{
+    name: z.ZodString;
+    quantity: z.ZodNumber;
+    unit: z.ZodEnum<{
+        BOWL: "BOWL";
+        GRAM: "GRAM";
+        PIECE: "PIECE";
+        CUP: "CUP";
+    }>;
+    grams: z.ZodNullable<z.ZodNumber>;
+    calories: z.ZodNumber;
+    protein: z.ZodNullable<z.ZodNumber>;
+    carbs: z.ZodNullable<z.ZodNumber>;
+    fat: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strict>;
+export type ReviewedPortion = z.output<typeof reviewedPortionSchema>;
+/**
+ * Approves a pending suggestion in one of three ways: add a new library food,
+ * link it to a food already in the library, or approve the portion without
+ * adding anything to the library.
+ */
+export declare const approveFoodSuggestionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    resolution: z.ZodLiteral<"ADDED_TO_LIBRARY">;
+    version: z.ZodNumber;
+    reviewed: z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        grams: z.ZodNullable<z.ZodNumber>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    food: z.ZodObject<{
+        name: z.ZodString;
+        nameHi: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        namePa: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        englishAlias: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        serving: z.ZodObject<{
+            label: z.ZodString;
+            quantity: z.ZodNumber;
+            unit: z.ZodEnum<{
+                g: "g";
+                ml: "ml";
+            }>;
+        }, z.core.$strict>;
+        nutrition: z.ZodObject<{
+            basis: z.ZodDefault<z.ZodEnum<{
+                PER_100: "PER_100";
+                PER_SERVING: "PER_SERVING";
+            }>>;
+            calories: z.ZodNumber;
+            protein: z.ZodNumber;
+            carbs: z.ZodNumber;
+            fat: z.ZodNumber;
+            sugar: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            fiber: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            solubleFiber: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+            insolubleFiber: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        }, z.core.$strict>;
+        metadataValueIds: z.ZodDefault<z.ZodArray<z.ZodUUID>>;
+        notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    }, z.core.$strict>;
+    reviewNote: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    resolution: z.ZodLiteral<"LINKED_TO_EXISTING">;
+    version: z.ZodNumber;
+    foodId: z.ZodUUID;
+    reviewed: z.ZodOptional<z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        grams: z.ZodNullable<z.ZodNumber>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>>;
+    reviewNote: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    resolution: z.ZodLiteral<"APPROVED_WITHOUT_LIBRARY">;
+    version: z.ZodNumber;
+    reviewed: z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        grams: z.ZodNullable<z.ZodNumber>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strict>;
+    reviewNote: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>], "resolution">;
+export type ApproveFoodSuggestionInput = z.input<typeof approveFoodSuggestionSchema>;
+export type ApproveFoodSuggestionBody = z.output<typeof approveFoodSuggestionSchema>;
+/** The reason is shown to the client. */
+export declare const rejectFoodSuggestionSchema: z.ZodObject<{
+    version: z.ZodNumber;
+    reason: z.ZodString;
+}, z.core.$strict>;
+export type RejectFoodSuggestionInput = z.input<typeof rejectFoodSuggestionSchema>;
+export type RejectFoodSuggestionBody = z.output<typeof rejectFoodSuggestionSchema>;
+export declare const foodSuggestionListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        pending: "pending";
+        approved: "approved";
+        rejected: "rejected";
+        withdrawn: "withdrawn";
+    }>>;
+    search: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type FoodSuggestionListQuery = z.output<typeof foodSuggestionListQuerySchema>;
+export declare const clientFoodSuggestionListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        pending: "pending";
+        approved: "approved";
+        rejected: "rejected";
+        withdrawn: "withdrawn";
+    }>>;
+}, z.core.$strip>;
+export type ClientFoodSuggestionListQuery = z.output<typeof clientFoodSuggestionListQuerySchema>;
+/** What the client sent. Never changes after submission. */
+export declare const submittedFoodSchema: z.ZodObject<{
+    name: z.ZodString;
+    quantity: z.ZodNumber;
+    unit: z.ZodEnum<{
+        BOWL: "BOWL";
+        GRAM: "GRAM";
+        PIECE: "PIECE";
+        CUP: "CUP";
+    }>;
+    calories: z.ZodNumber;
+    protein: z.ZodNullable<z.ZodNumber>;
+    carbs: z.ZodNullable<z.ZodNumber>;
+    fat: z.ZodNullable<z.ZodNumber>;
+    note: z.ZodNullable<z.ZodString>;
+    hasPhoto: z.ZodBoolean;
+}, z.core.$strip>;
+export type SubmittedFood = z.output<typeof submittedFoodSchema>;
+export declare const reviewedPortionResponseSchema: z.ZodObject<{
+    name: z.ZodString;
+    quantity: z.ZodNumber;
+    unit: z.ZodEnum<{
+        BOWL: "BOWL";
+        GRAM: "GRAM";
+        PIECE: "PIECE";
+        CUP: "CUP";
+    }>;
+    grams: z.ZodNullable<z.ZodNumber>;
+    calories: z.ZodNumber;
+    protein: z.ZodNullable<z.ZodNumber>;
+    carbs: z.ZodNullable<z.ZodNumber>;
+    fat: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/** A suggestion as a coach reviews it. */
+export declare const foodSuggestionResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    status: z.ZodEnum<{
+        pending: "pending";
+        approved: "approved";
+        rejected: "rejected";
+        withdrawn: "withdrawn";
+    }>;
+    client: z.ZodObject<{
+        id: z.ZodUUID;
+        fullName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    submitted: z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+        note: z.ZodNullable<z.ZodString>;
+        hasPhoto: z.ZodBoolean;
+    }, z.core.$strip>;
+    submittedAt: z.ZodISODateTime;
+    photoUrl: z.ZodNullable<z.ZodURL>;
+    resolution: z.ZodNullable<z.ZodEnum<{
+        ADDED_TO_LIBRARY: "ADDED_TO_LIBRARY";
+        LINKED_TO_EXISTING: "LINKED_TO_EXISTING";
+        APPROVED_WITHOUT_LIBRARY: "APPROVED_WITHOUT_LIBRARY";
+    }>>;
+    food: z.ZodNullable<z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+        deleted: z.ZodBoolean;
+    }, z.core.$strip>>;
+    reviewed: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        grams: z.ZodNullable<z.ZodNumber>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    reviewNote: z.ZodNullable<z.ZodString>;
+    reviewedBy: z.ZodNullable<z.ZodObject<{
+        id: z.ZodUUID;
+        fullName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    reviewedAt: z.ZodNullable<z.ZodISODateTime>;
+    matchesLibraryFoodId: z.ZodNullable<z.ZodUUID>;
+    similarPendingCount: z.ZodNumber;
+    similarFoods: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+        serving: z.ZodObject<{
+            label: z.ZodString;
+            quantity: z.ZodNumber;
+            unit: z.ZodEnum<{
+                g: "g";
+                ml: "ml";
+            }>;
+        }, z.core.$strip>;
+        per100: z.ZodObject<{
+            calories: z.ZodNumber;
+            protein: z.ZodNumber;
+            carbs: z.ZodNumber;
+            fat: z.ZodNumber;
+            sugar: z.ZodNullable<z.ZodNumber>;
+            fiber: z.ZodNullable<z.ZodNumber>;
+            solubleFiber: z.ZodNullable<z.ZodNumber>;
+            insolubleFiber: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>;
+        similarity: z.ZodNumber;
+    }, z.core.$strip>>;
+    version: z.ZodNumber;
+}, z.core.$strip>;
+export type FoodSuggestionResponse = z.output<typeof foodSuggestionResponseSchema>;
+/** A suggestion as the client who sent it sees it. */
+export declare const clientFoodSuggestionResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    status: z.ZodEnum<{
+        pending: "pending";
+        approved: "approved";
+        rejected: "rejected";
+        withdrawn: "withdrawn";
+    }>;
+    submitted: z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+        note: z.ZodNullable<z.ZodString>;
+        hasPhoto: z.ZodBoolean;
+    }, z.core.$strip>;
+    submittedAt: z.ZodISODateTime;
+    resolution: z.ZodNullable<z.ZodEnum<{
+        ADDED_TO_LIBRARY: "ADDED_TO_LIBRARY";
+        LINKED_TO_EXISTING: "LINKED_TO_EXISTING";
+        APPROVED_WITHOUT_LIBRARY: "APPROVED_WITHOUT_LIBRARY";
+    }>>;
+    reviewed: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            BOWL: "BOWL";
+            GRAM: "GRAM";
+            PIECE: "PIECE";
+            CUP: "CUP";
+        }>;
+        grams: z.ZodNullable<z.ZodNumber>;
+        calories: z.ZodNumber;
+        protein: z.ZodNullable<z.ZodNumber>;
+        carbs: z.ZodNullable<z.ZodNumber>;
+        fat: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    reviewNote: z.ZodNullable<z.ZodString>;
+    reviewedAt: z.ZodNullable<z.ZodISODateTime>;
+    food: z.ZodNullable<z.ZodObject<{
+        id: z.ZodUUID;
+        name: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ClientFoodSuggestionResponse = z.output<typeof clientFoodSuggestionResponseSchema>;

package/dist/cjs/food/food-suggestion.dto.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientFoodSuggestionResponseSchema = exports.foodSuggestionResponseSchema = exports.reviewedPortionResponseSchema = exports.submittedFoodSchema = exports.clientFoodSuggestionListQuerySchema = exports.foodSuggestionListQuerySchema = exports.rejectFoodSuggestionSchema = exports.approveFoodSuggestionSchema = exports.reviewedPortionSchema = exports.presignedUploadResponseSchema = exports.suggestionPhotoUploadSchema = exports.submitFoodSuggestionSchema = exports.suggestionIdParamSchema = exports.MAX_REJECTION_REASON_LENGTH = exports.MAX_REVIEW_NOTE_LENGTH = exports.FOOD_SUGGESTION_LIMITS = void 0;
+const zod_1 = require("zod");
+const date_time_schema_js_1 = require("../common/date-time.schema.js");
+const pagination_schema_js_1 = require("../common/pagination.schema.js");
+const safe_text_schema_js_1 = require("../common/safe-text.schema.js");
+const index_js_1 = require("../enums/index.js");
+const food_dto_js_1 = require("./food.dto.js");
+const nutrition_js_1 = require("./nutrition.js");
+/** Limits on what a client sends, shared so the app can check them before sending. */
+exports.FOOD_SUGGESTION_LIMITS = {
+    maxPortionQuantity: 10000,
+    maxCalories: 5000,
+    maxMacroGrams: 1000,
+    maxNoteLength: 300,
+    maxPhotoBytes: 5 * 1024 * 1024,
+    photoContentTypes: ['image/jpeg', 'image/png', 'image/webp'],
+};
+exports.MAX_REVIEW_NOTE_LENGTH = 300;
+exports.MAX_REJECTION_REASON_LENGTH = 500;
+const MAX_PHOTO_KEY_LENGTH = 1024;
+exports.suggestionIdParamSchema = zod_1.z.uuid();
+const caloriesSchema = (0, nutrition_js_1.nutrientAmountSchema)(exports.FOOD_SUGGESTION_LIMITS.maxCalories);
+const macroSchema = (0, nutrition_js_1.nutrientAmountSchema)(exports.FOOD_SUGGESTION_LIMITS.maxMacroGrams);
+const portionQuantitySchema = (0, nutrition_js_1.quantitySchema)(exports.FOOD_SUGGESTION_LIMITS.maxPortionQuantity);
+/**
+ * A food a client could not find in the library. Values are the client's best
+ * guess for the portion they ate, not per 100 g.
+ */
+exports.submitFoodSuggestionSchema = zod_1.z.strictObject({
+    name: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NAME_LENGTH),
+    quantity: portionQuantitySchema,
+    unit: zod_1.z.enum(index_js_1.PORTION_UNITS),
+    calories: caloriesSchema,
+    protein: macroSchema.optional(),
+    carbs: macroSchema.optional(),
+    fat: macroSchema.optional(),
+    note: (0, safe_text_schema_js_1.safeTextSchema)(exports.FOOD_SUGGESTION_LIMITS.maxNoteLength).optional(),
+    /** The key returned by the photo upload request, after the upload succeeded. */
+    photoKey: zod_1.z.string().min(1).max(MAX_PHOTO_KEY_LENGTH).optional(),
+});
+exports.suggestionPhotoUploadSchema = zod_1.z.strictObject({
+    contentType: zod_1.z.enum(exports.FOOD_SUGGESTION_LIMITS.photoContentTypes),
+    sizeBytes: zod_1.z.number().int().min(1).max(exports.FOOD_SUGGESTION_LIMITS.maxPhotoBytes),
+});
+/** Where to upload the photo. The headers are signed and must be sent exactly. */
+exports.presignedUploadResponseSchema = zod_1.z.object({
+    key: zod_1.z.string(),
+    url: zod_1.z.url(),
+    method: zod_1.z.literal('PUT'),
+    headers: zod_1.z.record(zod_1.z.string(), zod_1.z.string()),
+    expiresAt: date_time_schema_js_1.utcTimestampSchema,
+});
+/** The coach's corrected values for the portion the client logged. */
+exports.reviewedPortionSchema = zod_1.z.strictObject({
+    name: (0, safe_text_schema_js_1.safeTextSchema)(food_dto_js_1.MAX_FOOD_NAME_LENGTH),
+    quantity: portionQuantitySchema,
+    unit: zod_1.z.enum(index_js_1.PORTION_UNITS),
+    /** The portion's weight in grams, when known: "1 bowl · 120 g". */
+    grams: portionQuantitySchema.nullable(),
+    calories: caloriesSchema,
+    protein: macroSchema.nullable(),
+    carbs: macroSchema.nullable(),
+    fat: macroSchema.nullable(),
+});
+const versionSchema = zod_1.z.number().int().min(1);
+const reviewNoteSchema = (0, safe_text_schema_js_1.safeTextSchema)(exports.MAX_REVIEW_NOTE_LENGTH).optional();
+/**
+ * Approves a pending suggestion in one of three ways: add a new library food,
+ * link it to a food already in the library, or approve the portion without
+ * adding anything to the library.
+ */
+exports.approveFoodSuggestionSchema = zod_1.z.discriminatedUnion('resolution', [
+    zod_1.z.strictObject({
+        resolution: zod_1.z.literal('ADDED_TO_LIBRARY'),
+        version: versionSchema,
+        reviewed: exports.reviewedPortionSchema,
+        food: food_dto_js_1.createFoodSchema,
+        reviewNote: reviewNoteSchema,
+    }),
+    zod_1.z.strictObject({
+        resolution: zod_1.z.literal('LINKED_TO_EXISTING'),
+        version: versionSchema,
+        foodId: zod_1.z.uuid(),
+        reviewed: exports.reviewedPortionSchema.optional(),
+        reviewNote: reviewNoteSchema,
+    }),
+    zod_1.z.strictObject({
+        resolution: zod_1.z.literal('APPROVED_WITHOUT_LIBRARY'),
+        version: versionSchema,
+        reviewed: exports.reviewedPortionSchema,
+        reviewNote: reviewNoteSchema,
+    }),
+]);
+/** The reason is shown to the client. */
+exports.rejectFoodSuggestionSchema = zod_1.z.strictObject({
+    version: versionSchema,
+    reason: (0, safe_text_schema_js_1.safeTextSchema)(exports.MAX_REJECTION_REASON_LENGTH),
+});
+exports.foodSuggestionListQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({
+    status: zod_1.z.enum(index_js_1.FOOD_SUGGESTION_STATUSES).optional(),
+    search: zod_1.z.string().trim().min(1).max(food_dto_js_1.MAX_FOOD_SEARCH_LENGTH).optional(),
+});
+exports.clientFoodSuggestionListQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({ status: zod_1.z.enum(index_js_1.FOOD_SUGGESTION_STATUSES).optional() });
+// Responses
+/** What the client sent. Never changes after submission. */
+exports.submittedFoodSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    quantity: zod_1.z.number(),
+    unit: zod_1.z.enum(index_js_1.PORTION_UNITS),
+    calories: zod_1.z.number(),
+    protein: zod_1.z.number().nullable(),
+    carbs: zod_1.z.number().nullable(),
+    fat: zod_1.z.number().nullable(),
+    note: zod_1.z.string().nullable(),
+    hasPhoto: zod_1.z.boolean(),
+});
+exports.reviewedPortionResponseSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    quantity: zod_1.z.number(),
+    unit: zod_1.z.enum(index_js_1.PORTION_UNITS),
+    grams: zod_1.z.number().nullable(),
+    calories: zod_1.z.number(),
+    protein: zod_1.z.number().nullable(),
+    carbs: zod_1.z.number().nullable(),
+    fat: zod_1.z.number().nullable(),
+});
+const linkedFoodSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    name: zod_1.z.string(),
+    /** True when the food was removed from the library after approval. */
+    deleted: zod_1.z.boolean(),
+});
+/** A suggestion as a coach reviews it. */
+exports.foodSuggestionResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    status: zod_1.z.enum(index_js_1.FOOD_SUGGESTION_STATUSES),
+    client: food_dto_js_1.userRefSchema,
+    submitted: exports.submittedFoodSchema,
+    submittedAt: date_time_schema_js_1.utcTimestampSchema,
+    /** A short-lived download link; only in the single-suggestion response. */
+    photoUrl: zod_1.z.url().nullable(),
+    resolution: zod_1.z.enum(index_js_1.FOOD_SUGGESTION_RESOLUTIONS).nullable(),
+    food: linkedFoodSchema.nullable(),
+    reviewed: exports.reviewedPortionResponseSchema.nullable(),
+    reviewNote: zod_1.z.string().nullable(),
+    reviewedBy: food_dto_js_1.userRefSchema.nullable(),
+    reviewedAt: date_time_schema_js_1.utcTimestampSchema.nullable(),
+    /** A library food with exactly the same name, if any. */
+    matchesLibraryFoodId: zod_1.z.uuid().nullable(),
+    /** Other clients' pending suggestions with the same name. */
+    similarPendingCount: zod_1.z.number().int(),
+    /** Library foods with similar names; only in the single-suggestion response. */
+    similarFoods: zod_1.z.array(food_dto_js_1.similarFoodResponseSchema),
+    version: zod_1.z.number().int(),
+});
+/** A suggestion as the client who sent it sees it. */
+exports.clientFoodSuggestionResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    status: zod_1.z.enum(index_js_1.FOOD_SUGGESTION_STATUSES),
+    submitted: exports.submittedFoodSchema,
+    submittedAt: date_time_schema_js_1.utcTimestampSchema,
+    resolution: zod_1.z.enum(index_js_1.FOOD_SUGGESTION_RESOLUTIONS).nullable(),
+    reviewed: exports.reviewedPortionResponseSchema.nullable(),
+    /** The coach's note, or the reason for a rejection. */
+    reviewNote: zod_1.z.string().nullable(),
+    reviewedAt: date_time_schema_js_1.utcTimestampSchema.nullable(),
+    food: zod_1.z.object({ id: zod_1.z.uuid(), name: zod_1.z.string() }).nullable(),
+});