@tbs-fitness/contract 0.4.0 → 0.6.0

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

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+export declare const MIN_CLIENT_FOOD_SEARCH_LENGTH = 2;
+export declare const clientFoodSearchQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    search: z.ZodString;
+}, z.core.$strip>;
+export type ClientFoodSearchQuery = z.output<typeof clientFoodSearchQuerySchema>;
+/** A library food as a client sees it: what they need to log it, and nothing about who added it. */
+export declare const clientFoodResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    name: z.ZodString;
+    nameHi: z.ZodNullable<z.ZodString>;
+    namePa: z.ZodNullable<z.ZodString>;
+    englishAlias: z.ZodNullable<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>;
+    perServing: 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>;
+    tags: z.ZodArray<z.ZodObject<{
+        typeKey: z.ZodString;
+        label: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ClientFoodResponse = z.output<typeof clientFoodResponseSchema>;

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientFoodResponseSchema = exports.clientFoodSearchQuerySchema = exports.MIN_CLIENT_FOOD_SEARCH_LENGTH = void 0;
+const zod_1 = require("zod");
+const pagination_schema_js_1 = require("../common/pagination.schema.js");
+const food_dto_js_1 = require("./food.dto.js");
+exports.MIN_CLIENT_FOOD_SEARCH_LENGTH = 2;
+exports.clientFoodSearchQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({
+    search: zod_1.z
+        .string()
+        .trim()
+        .min(exports.MIN_CLIENT_FOOD_SEARCH_LENGTH)
+        .max(food_dto_js_1.MAX_FOOD_SEARCH_LENGTH),
+});
+/** A library food as a client sees it: what they need to log it, and nothing about who added it. */
+exports.clientFoodResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    name: zod_1.z.string(),
+    nameHi: zod_1.z.string().nullable(),
+    namePa: zod_1.z.string().nullable(),
+    englishAlias: zod_1.z.string().nullable(),
+    serving: food_dto_js_1.servingResponseSchema,
+    per100: food_dto_js_1.nutrientValuesResponseSchema,
+    perServing: food_dto_js_1.nutrientValuesResponseSchema,
+    tags: zod_1.z.array(zod_1.z.object({ typeKey: zod_1.z.string(), label: zod_1.z.string() })),
+});

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

@@ -0,0 +1,160 @@
+import { z } from 'zod';
+/** The file limits the API enforces, shared so the upload screen can say them up front. */
+export declare const FOOD_IMPORT_LIMITS: {
+    readonly maxFileBytes: number;
+    readonly maxRows: 5000;
+    readonly extensions: readonly [".csv", ".xlsx"];
+};
+export declare const importIdParamSchema: z.ZodUUID;
+/**
+ * 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.
+ */
+export declare const foodImportRowSchema: z.ZodObject<{
+    name: z.ZodString;
+    nameHi: z.ZodNullable<z.ZodString>;
+    namePa: z.ZodNullable<z.ZodString>;
+    englishAlias: z.ZodNullable<z.ZodString>;
+    category: z.ZodString;
+    subcategory: z.ZodNullable<z.ZodString>;
+    servingLabel: z.ZodString;
+    servingQuantity: z.ZodNumber;
+    servingUnit: z.ZodEnum<{
+        g: "g";
+        ml: "ml";
+    }>;
+    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>;
+    tags: z.ZodArray<z.ZodString>;
+    mealTimings: z.ZodArray<z.ZodString>;
+    notes: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type FoodImportRow = z.output<typeof foodImportRowSchema>;
+export declare const commitFoodImportSchema: z.ZodObject<{
+    mode: z.ZodDefault<z.ZodEnum<{
+        SKIP_DUPLICATES: "SKIP_DUPLICATES";
+        UPDATE_EXISTING: "UPDATE_EXISTING";
+    }>>;
+    createMissingMetadata: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export type CommitFoodImportInput = z.input<typeof commitFoodImportSchema>;
+export type CommitFoodImportBody = z.output<typeof commitFoodImportSchema>;
+export declare const foodImportListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+export declare const foodImportRowsQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    status: z.ZodOptional<z.ZodEnum<{
+        valid: "valid";
+        invalid: "invalid";
+        duplicate_in_file: "duplicate_in_file";
+        duplicate_existing: "duplicate_existing";
+    }>>;
+}, z.core.$strip>;
+export type FoodImportRowsQuery = z.output<typeof foodImportRowsQuerySchema>;
+export declare const foodImportIssueSchema: z.ZodObject<{
+    column: z.ZodNullable<z.ZodString>;
+    code: z.ZodString;
+    message: z.ZodString;
+    severity: z.ZodEnum<{
+        error: "error";
+        warning: "warning";
+    }>;
+}, z.core.$strip>;
+export type FoodImportIssue = z.output<typeof foodImportIssueSchema>;
+export declare const foodImportBatchResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    fileName: z.ZodString;
+    fileType: z.ZodEnum<{
+        csv: "csv";
+        xlsx: "xlsx";
+    }>;
+    sheetName: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        previewed: "previewed";
+        completed: "completed";
+        expired: "expired";
+    }>;
+    mode: z.ZodNullable<z.ZodEnum<{
+        SKIP_DUPLICATES: "SKIP_DUPLICATES";
+        UPDATE_EXISTING: "UPDATE_EXISTING";
+    }>>;
+    createMissingMetadata: z.ZodBoolean;
+    totalRows: z.ZodNumber;
+    validRows: z.ZodNumber;
+    invalidRows: z.ZodNumber;
+    duplicateRows: z.ZodNumber;
+    emptyRows: z.ZodNumber;
+    createdCount: z.ZodNumber;
+    updatedCount: z.ZodNumber;
+    skippedCount: z.ZodNumber;
+    unknownMetadata: z.ZodArray<z.ZodObject<{
+        typeKey: z.ZodString;
+        values: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>;
+    ignoredColumns: z.ZodArray<z.ZodString>;
+    ignoredSheets: z.ZodArray<z.ZodString>;
+    uploadedBy: z.ZodUUID;
+    expiresAt: z.ZodISODateTime;
+    committedAt: z.ZodNullable<z.ZodISODateTime>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type FoodImportBatchResponse = z.output<typeof foodImportBatchResponseSchema>;
+export declare const foodImportRowResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    rowNumber: z.ZodNumber;
+    status: z.ZodEnum<{
+        valid: "valid";
+        invalid: "invalid";
+        duplicate_in_file: "duplicate_in_file";
+        duplicate_existing: "duplicate_existing";
+    }>;
+    raw: z.ZodRecord<z.ZodString, z.ZodString>;
+    parsed: z.ZodNullable<z.ZodObject<{
+        name: z.ZodString;
+        nameHi: z.ZodNullable<z.ZodString>;
+        namePa: z.ZodNullable<z.ZodString>;
+        englishAlias: z.ZodNullable<z.ZodString>;
+        category: z.ZodString;
+        subcategory: z.ZodNullable<z.ZodString>;
+        servingLabel: z.ZodString;
+        servingQuantity: z.ZodNumber;
+        servingUnit: z.ZodEnum<{
+            g: "g";
+            ml: "ml";
+        }>;
+        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>;
+        tags: z.ZodArray<z.ZodString>;
+        mealTimings: z.ZodArray<z.ZodString>;
+        notes: z.ZodNullable<z.ZodString>;
+    }, z.core.$strict>>;
+    issues: z.ZodArray<z.ZodObject<{
+        column: z.ZodNullable<z.ZodString>;
+        code: z.ZodString;
+        message: z.ZodString;
+        severity: z.ZodEnum<{
+            error: "error";
+            warning: "warning";
+        }>;
+    }, z.core.$strip>>;
+    matchedFoodId: z.ZodNullable<z.ZodUUID>;
+    resultFoodId: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+export type FoodImportRowResponse = z.output<typeof foodImportRowResponseSchema>;

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(),
+});