@tbs-fitness/contract 0.9.0 → 0.10.0

package/README.md

@@ -43,6 +43,17 @@ const result = createFlagSchema.safeParse(input); // The same rules as the API.
 
 Requests have two types. Clients use `*Input`, where fields with a default are optional. The backend uses `*Body`, which is the result after validation. List queries come from the URL as strings, so they have no `*Input`: use `Partial<PaginationQuery>` or `Partial<AuditLogQuery>`.
 
+## Version 0.10.0
+
+The supplement library. Additive; consumers install `^0.10.0` explicitly.
+
+- New `/supplements`. It keeps the food library's spreadsheet format, nutrition rules and labels, so most schemas are the food library's own under supplement names:
+  - Library: `createSupplementSchema`, `updateSupplementSchema` (with `version`), `supplementListQuerySchema`, `supplementResponseSchema` (no suggestion link; `source` is `ADMIN`, `COACH` or `IMPORT`), `similarSupplementResponseSchema`, `supplementStatsResponseSchema`.
+  - Labels: the metadata type and value schemas, re-exported from `/food`.
+  - Import: `supplementImportRowSchema`, `commitSupplementImportSchema`, `supplementImportBatchResponseSchema`, `supplementImportRowResponseSchema` (`matchedSupplementId`, `resultSupplementId`), `SUPPLEMENT_IMPORT_LIMITS`.
+  - Client: `clientSupplementSearchQuerySchema`, `clientSupplementResponseSchema`.
+- `/enums`: `SUPPLEMENT_SOURCES`, and the permissions `supplements:read`, `supplements:create`, `supplements:update`, `supplements:delete`, `supplements:import`, `supplement_metadata:manage` and `supplements:search:self`.
+
 ## Version 0.9.0
 
 The goal library. Additive; consumers install `^0.9.0` explicitly.

package/dist/cjs/enums/index.d.ts

@@ -37,6 +37,13 @@ export declare const PERMISSIONS: {
     readonly goalsUpdate: "goals:update";
     readonly goalsDelete: "goals:delete";
     readonly goalsReadSelf: "goals:read:self";
+    readonly supplementsRead: "supplements:read";
+    readonly supplementsCreate: "supplements:create";
+    readonly supplementsUpdate: "supplements:update";
+    readonly supplementsDelete: "supplements:delete";
+    readonly supplementsImport: "supplements:import";
+    readonly supplementMetadataManage: "supplement_metadata:manage";
+    readonly supplementsSearchSelf: "supplements:search:self";
 };
 export type Permission = (typeof PERMISSIONS)[keyof typeof PERMISSIONS];
 /**
@@ -137,3 +144,6 @@ export declare const GOAL_STATUSES: readonly ["active", "inactive"];
 export type GoalStatus = (typeof GOAL_STATUSES)[number];
 export declare const GOAL_SORT_FIELDS: readonly ["sortOrder", "name", "updatedAt"];
 export type GoalSortField = (typeof GOAL_SORT_FIELDS)[number];
+/** Where a supplement came from. Clients cannot suggest supplements, unlike foods. */
+export declare const SUPPLEMENT_SOURCES: readonly ["ADMIN", "COACH", "IMPORT"];
+export type SupplementSource = (typeof SUPPLEMENT_SOURCES)[number];

package/dist/cjs/enums/index.js

@@ -2,7 +2,7 @@
 // These values are stored in the database and sent over the API. Renaming or
 // removing one is a breaking change, so it needs a major version.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GOAL_SORT_FIELDS = exports.GOAL_STATUSES = exports.GOAL_ICONS = exports.SORT_ORDERS = exports.FOOD_SORT_FIELDS = exports.FOOD_METADATA_SELECTIONS = exports.FOOD_IMPORT_ISSUE_SEVERITIES = exports.FOOD_IMPORT_FILE_TYPES = exports.FOOD_IMPORT_ROW_STATUSES = exports.FOOD_IMPORT_STATUSES = exports.FOOD_IMPORT_MODES = exports.FOOD_SUGGESTION_RESOLUTIONS = exports.FOOD_SUGGESTION_STATUSES = exports.NUTRITION_BASES = exports.PORTION_UNITS = exports.SERVING_UNITS = exports.FOOD_SOURCES = exports.TEMPLATE_STATUSES = exports.DELIVERY_STATUSES = exports.MESSAGE_TYPES = exports.COMMUNICATION_CHANNELS = exports.FEATURE_FLAG_RULE_TYPES = exports.AUDIT_OUTCOMES = exports.CSRF_HEADER = exports.CSRF_COOKIE_NAMES = exports.TOKEN_TRANSPORTS = exports.TIMEZONE_SOURCES = exports.ADMIN_SETTABLE_ACCOUNT_STATUSES = exports.ACCOUNT_STATUSES = exports.PERMISSIONS = exports.ROLES = exports.APP_ENVIRONMENTS = void 0;
+exports.SUPPLEMENT_SOURCES = exports.GOAL_SORT_FIELDS = exports.GOAL_STATUSES = exports.GOAL_ICONS = exports.SORT_ORDERS = exports.FOOD_SORT_FIELDS = exports.FOOD_METADATA_SELECTIONS = exports.FOOD_IMPORT_ISSUE_SEVERITIES = exports.FOOD_IMPORT_FILE_TYPES = exports.FOOD_IMPORT_ROW_STATUSES = exports.FOOD_IMPORT_STATUSES = exports.FOOD_IMPORT_MODES = exports.FOOD_SUGGESTION_RESOLUTIONS = exports.FOOD_SUGGESTION_STATUSES = exports.NUTRITION_BASES = exports.PORTION_UNITS = exports.SERVING_UNITS = exports.FOOD_SOURCES = exports.TEMPLATE_STATUSES = exports.DELIVERY_STATUSES = exports.MESSAGE_TYPES = exports.COMMUNICATION_CHANNELS = exports.FEATURE_FLAG_RULE_TYPES = exports.AUDIT_OUTCOMES = exports.CSRF_HEADER = exports.CSRF_COOKIE_NAMES = exports.TOKEN_TRANSPORTS = exports.TIMEZONE_SOURCES = exports.ADMIN_SETTABLE_ACCOUNT_STATUSES = exports.ACCOUNT_STATUSES = exports.PERMISSIONS = exports.ROLES = exports.APP_ENVIRONMENTS = void 0;
 exports.APP_ENVIRONMENTS = [
     'development',
     'staging',
@@ -44,6 +44,13 @@ exports.PERMISSIONS = {
     goalsUpdate: 'goals:update',
     goalsDelete: 'goals:delete',
     goalsReadSelf: 'goals:read:self',
+    supplementsRead: 'supplements:read',
+    supplementsCreate: 'supplements:create',
+    supplementsUpdate: 'supplements:update',
+    supplementsDelete: 'supplements:delete',
+    supplementsImport: 'supplements:import',
+    supplementMetadataManage: 'supplement_metadata:manage',
+    supplementsSearchSelf: 'supplements:search:self',
 };
 /**
  * `pending_verification` is a self-registered user who has not yet proved they
@@ -177,3 +184,5 @@ exports.GOAL_ICONS = [
 /** Whether clients can pick a goal: live goals are either shown or hidden. */
 exports.GOAL_STATUSES = ['active', 'inactive'];
 exports.GOAL_SORT_FIELDS = ['sortOrder', 'name', 'updatedAt'];
+/** Where a supplement came from. Clients cannot suggest supplements, unlike foods. */
+exports.SUPPLEMENT_SOURCES = ['ADMIN', 'COACH', 'IMPORT'];

package/dist/cjs/supplements/index.d.ts

@@ -0,0 +1 @@
+export * from './supplement.dto.js';

package/dist/cjs/supplements/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./supplement.dto.js"), exports);

package/dist/cjs/supplements/supplement.dto.d.ts

@@ -0,0 +1,386 @@
+import { z } from 'zod';
+export declare const supplementIdParamSchema: z.ZodUUID;
+export declare const createSupplementSchema: 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>;
+export type CreateSupplementInput = z.input<typeof createSupplementSchema>;
+export type CreateSupplementBody = z.output<typeof createSupplementSchema>;
+export declare const updateSupplementSchema: z.ZodObject<{
+    version: z.ZodNumber;
+    name: z.ZodOptional<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.ZodOptional<z.ZodObject<{
+        label: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            g: "g";
+            ml: "ml";
+        }>;
+    }, z.core.$strict>>;
+    nutrition: z.ZodOptional<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.ZodOptional<z.ZodArray<z.ZodUUID>>;
+    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export type UpdateSupplementInput = z.input<typeof updateSupplementSchema>;
+export type UpdateSupplementBody = z.output<typeof updateSupplementSchema>;
+/**
+ * `metadata` filters by value ids: a supplement matches when it has at least
+ * one of the listed values of each type that appears in the list.
+ */
+export declare const supplementListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    search: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodPreprocess<z.ZodOptional<z.ZodArray<z.ZodUUID>>, unknown>;
+    source: z.ZodOptional<z.ZodEnum<{
+        ADMIN: "ADMIN";
+        COACH: "COACH";
+        IMPORT: "IMPORT";
+    }>>;
+    sort: z.ZodDefault<z.ZodEnum<{
+        name: "name";
+        updatedAt: "updatedAt";
+        calories: "calories";
+        protein: "protein";
+    }>>;
+    order: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strip>;
+export type SupplementListQuery = z.output<typeof supplementListQuerySchema>;
+export declare const similarSupplementQuerySchema: z.ZodObject<{
+    name: z.ZodString;
+}, z.core.$strip>;
+export type SimilarSupplementQuery = z.output<typeof similarSupplementQuerySchema>;
+export declare const supplementResponseSchema: z.ZodObject<{
+    metadata: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        typeKey: z.ZodString;
+        key: z.ZodString;
+        label: z.ZodString;
+        isActive: z.ZodBoolean;
+    }, z.core.$strip>>;
+    name: z.ZodString;
+    updatedAt: z.ZodISODateTime;
+    id: z.ZodUUID;
+    version: z.ZodNumber;
+    createdAt: z.ZodISODateTime;
+    createdBy: z.ZodObject<{
+        id: z.ZodUUID;
+        fullName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    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>;
+    notes: z.ZodNullable<z.ZodString>;
+    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>;
+    formulaCalories: z.ZodNumber;
+    importBatchId: z.ZodNullable<z.ZodUUID>;
+    source: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        COACH: "COACH";
+        IMPORT: "IMPORT";
+    }>;
+}, z.core.$strip>;
+export type SupplementResponse = z.output<typeof supplementResponseSchema>;
+export declare const similarSupplementResponseSchema: 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>;
+export type SimilarSupplementResponse = z.output<typeof similarSupplementResponseSchema>;
+export declare const supplementStatsResponseSchema: z.ZodObject<{
+    totalSupplements: z.ZodNumber;
+    categories: z.ZodArray<z.ZodObject<{
+        valueId: z.ZodUUID;
+        key: z.ZodString;
+        label: z.ZodString;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SupplementStatsResponse = z.output<typeof supplementStatsResponseSchema>;
+export { type CreateMetadataValueBody, type CreateMetadataValueInput, createMetadataValueSchema, MAX_METADATA_LABEL_LENGTH, metadataTypeIdParamSchema, metadataTypeListResponseSchema, type MetadataTypeResponse, metadataTypeResponseSchema, metadataValueIdParamSchema, type MetadataValueListQuery, metadataValueListQuerySchema, metadataValueListResponseSchema, type MetadataValueResponse, metadataValueResponseSchema, type UpdateMetadataValueBody, type UpdateMetadataValueInput, updateMetadataValueSchema, } from '../food/food.dto.js';
+export { type NutrientValuesResponse, nutrientValuesResponseSchema, type ServingResponse, servingResponseSchema, type FoodMetadataRef as SupplementMetadataRef, foodMetadataRefSchema as supplementMetadataRefSchema, type UserRef, userRefSchema, } from '../food/food.dto.js';
+export { importIdParamSchema, foodImportListQuerySchema as supplementImportListQuerySchema, } from '../food/food-import.dto.js';
+export declare const SUPPLEMENT_IMPORT_LIMITS: {
+    readonly maxFileBytes: number;
+    readonly maxRows: 5000;
+    readonly extensions: readonly [".csv", ".xlsx"];
+};
+export declare const supplementImportRowSchema: 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 SupplementImportRow = z.output<typeof supplementImportRowSchema>;
+export declare const supplementImportIssueSchema: 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 SupplementImportIssue = z.output<typeof supplementImportIssueSchema>;
+export declare const commitSupplementImportSchema: 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 CommitSupplementImportInput = z.input<typeof commitSupplementImportSchema>;
+export type CommitSupplementImportBody = z.output<typeof commitSupplementImportSchema>;
+export declare const supplementImportRowsQuerySchema: 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 SupplementImportRowsQuery = z.output<typeof supplementImportRowsQuerySchema>;
+export declare const supplementImportBatchResponseSchema: 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 SupplementImportBatchResponse = z.output<typeof supplementImportBatchResponseSchema>;
+export declare const supplementImportRowResponseSchema: 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>>;
+    matchedSupplementId: z.ZodNullable<z.ZodUUID>;
+    resultSupplementId: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+export type SupplementImportRowResponse = z.output<typeof supplementImportRowResponseSchema>;
+export declare const clientSupplementSearchQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    search: z.ZodString;
+}, z.core.$strip>;
+export type ClientSupplementSearchQuery = z.output<typeof clientSupplementSearchQuerySchema>;
+/** A library supplement as a client sees it: what they need to log it, and nothing about who added it. */
+export declare const clientSupplementResponseSchema: 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 ClientSupplementResponse = z.output<typeof clientSupplementResponseSchema>;

package/dist/cjs/supplements/supplement.dto.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientSupplementResponseSchema = exports.clientSupplementSearchQuerySchema = exports.supplementImportRowResponseSchema = exports.supplementImportBatchResponseSchema = exports.supplementImportRowsQuerySchema = exports.commitSupplementImportSchema = exports.supplementImportIssueSchema = exports.supplementImportRowSchema = exports.SUPPLEMENT_IMPORT_LIMITS = exports.supplementImportListQuerySchema = exports.importIdParamSchema = exports.userRefSchema = exports.supplementMetadataRefSchema = exports.servingResponseSchema = exports.nutrientValuesResponseSchema = exports.updateMetadataValueSchema = exports.metadataValueResponseSchema = exports.metadataValueListResponseSchema = exports.metadataValueListQuerySchema = exports.metadataValueIdParamSchema = exports.metadataTypeResponseSchema = exports.metadataTypeListResponseSchema = exports.metadataTypeIdParamSchema = exports.MAX_METADATA_LABEL_LENGTH = exports.createMetadataValueSchema = exports.supplementStatsResponseSchema = exports.similarSupplementResponseSchema = exports.supplementResponseSchema = exports.similarSupplementQuerySchema = exports.supplementListQuerySchema = exports.updateSupplementSchema = exports.createSupplementSchema = exports.supplementIdParamSchema = void 0;
+const zod_1 = require("zod");
+const pagination_schema_js_1 = require("../common/pagination.schema.js");
+const index_js_1 = require("../enums/index.js");
+const client_food_dto_js_1 = require("../food/client-food.dto.js");
+const food_dto_js_1 = require("../food/food.dto.js");
+const food_import_dto_js_1 = require("../food/food-import.dto.js");
+// The supplement library keeps the food library's spreadsheet format, nutrition
+// rules and labels (category, subcategory, tags, meal timing), so its requests
+// and most of its responses are the food library's own shapes. What differs:
+// supplements come from an admin, a coach or an import (clients cannot suggest
+// them), and responses name supplements rather than foods.
+exports.supplementIdParamSchema = zod_1.z.uuid();
+// Requests: the same fields and nutrition rules as a food.
+exports.createSupplementSchema = food_dto_js_1.createFoodSchema;
+exports.updateSupplementSchema = food_dto_js_1.updateFoodSchema;
+/** Accepts `a,b` or a repeated parameter, as query strings carry either. */
+const idListQuerySchema = zod_1.z.preprocess((value) => {
+    if (typeof value === 'string') {
+        return value === ''
+            ? undefined
+            : value
+                .split(',')
+                .map((part) => part.trim())
+                .filter(Boolean);
+    }
+    return value;
+}, zod_1.z.array(zod_1.z.uuid()).max(50).optional());
+/**
+ * `metadata` filters by value ids: a supplement matches when it has at least
+ * one of the listed values of each type that appears in the list.
+ */
+exports.supplementListQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({
+    search: zod_1.z.string().trim().min(1).max(food_dto_js_1.MAX_FOOD_SEARCH_LENGTH).optional(),
+    metadata: idListQuerySchema,
+    source: zod_1.z.enum(index_js_1.SUPPLEMENT_SOURCES).optional(),
+    sort: zod_1.z.enum(index_js_1.FOOD_SORT_FIELDS).default('name'),
+    order: zod_1.z.enum(index_js_1.SORT_ORDERS).default('asc'),
+});
+exports.similarSupplementQuerySchema = zod_1.z.object({
+    name: food_dto_js_1.createFoodSchema.shape.name,
+});
+// Responses
+exports.supplementResponseSchema = food_dto_js_1.foodResponseSchema
+    .omit({ suggestionId: true })
+    .extend({ source: zod_1.z.enum(index_js_1.SUPPLEMENT_SOURCES) });
+exports.similarSupplementResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    name: zod_1.z.string(),
+    serving: food_dto_js_1.servingResponseSchema,
+    per100: food_dto_js_1.nutrientValuesResponseSchema,
+    /** 0 to 1; 1 is the same name. */
+    similarity: zod_1.z.number(),
+});
+exports.supplementStatsResponseSchema = zod_1.z.object({
+    totalSupplements: zod_1.z.number().int(),
+    categories: zod_1.z.array(zod_1.z.object({
+        valueId: zod_1.z.uuid(),
+        key: zod_1.z.string(),
+        label: zod_1.z.string(),
+        count: zod_1.z.number().int(),
+    })),
+});
+// Labels: the same metadata shapes as the food library, kept in their own tables.
+var food_dto_js_2 = require("../food/food.dto.js");
+Object.defineProperty(exports, "createMetadataValueSchema", { enumerable: true, get: function () { return food_dto_js_2.createMetadataValueSchema; } });
+Object.defineProperty(exports, "MAX_METADATA_LABEL_LENGTH", { enumerable: true, get: function () { return food_dto_js_2.MAX_METADATA_LABEL_LENGTH; } });
+Object.defineProperty(exports, "metadataTypeIdParamSchema", { enumerable: true, get: function () { return food_dto_js_2.metadataTypeIdParamSchema; } });
+Object.defineProperty(exports, "metadataTypeListResponseSchema", { enumerable: true, get: function () { return food_dto_js_2.metadataTypeListResponseSchema; } });
+Object.defineProperty(exports, "metadataTypeResponseSchema", { enumerable: true, get: function () { return food_dto_js_2.metadataTypeResponseSchema; } });
+Object.defineProperty(exports, "metadataValueIdParamSchema", { enumerable: true, get: function () { return food_dto_js_2.metadataValueIdParamSchema; } });
+Object.defineProperty(exports, "metadataValueListQuerySchema", { enumerable: true, get: function () { return food_dto_js_2.metadataValueListQuerySchema; } });
+Object.defineProperty(exports, "metadataValueListResponseSchema", { enumerable: true, get: function () { return food_dto_js_2.metadataValueListResponseSchema; } });
+Object.defineProperty(exports, "metadataValueResponseSchema", { enumerable: true, get: function () { return food_dto_js_2.metadataValueResponseSchema; } });
+Object.defineProperty(exports, "updateMetadataValueSchema", { enumerable: true, get: function () { return food_dto_js_2.updateMetadataValueSchema; } });
+// Shapes inside a supplement response, shared with the food library.
+var food_dto_js_3 = require("../food/food.dto.js");
+Object.defineProperty(exports, "nutrientValuesResponseSchema", { enumerable: true, get: function () { return food_dto_js_3.nutrientValuesResponseSchema; } });
+Object.defineProperty(exports, "servingResponseSchema", { enumerable: true, get: function () { return food_dto_js_3.servingResponseSchema; } });
+Object.defineProperty(exports, "supplementMetadataRefSchema", { enumerable: true, get: function () { return food_dto_js_3.foodMetadataRefSchema; } });
+Object.defineProperty(exports, "userRefSchema", { enumerable: true, get: function () { return food_dto_js_3.userRefSchema; } });
+// Import: the food library's spreadsheet format and limits.
+var food_import_dto_js_2 = require("../food/food-import.dto.js");
+Object.defineProperty(exports, "importIdParamSchema", { enumerable: true, get: function () { return food_import_dto_js_2.importIdParamSchema; } });
+Object.defineProperty(exports, "supplementImportListQuerySchema", { enumerable: true, get: function () { return food_import_dto_js_2.foodImportListQuerySchema; } });
+exports.SUPPLEMENT_IMPORT_LIMITS = food_import_dto_js_1.FOOD_IMPORT_LIMITS;
+exports.supplementImportRowSchema = food_import_dto_js_1.foodImportRowSchema;
+exports.supplementImportIssueSchema = food_import_dto_js_1.foodImportIssueSchema;
+exports.commitSupplementImportSchema = food_import_dto_js_1.commitFoodImportSchema;
+exports.supplementImportRowsQuerySchema = food_import_dto_js_1.foodImportRowsQuerySchema;
+exports.supplementImportBatchResponseSchema = food_import_dto_js_1.foodImportBatchResponseSchema;
+exports.supplementImportRowResponseSchema = 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.supplementImportRowSchema.nullable(),
+    issues: zod_1.z.array(exports.supplementImportIssueSchema),
+    matchedSupplementId: zod_1.z.uuid().nullable(),
+    resultSupplementId: zod_1.z.uuid().nullable(),
+});
+// Client: search only.
+exports.clientSupplementSearchQuerySchema = client_food_dto_js_1.clientFoodSearchQuerySchema;
+/** A library supplement as a client sees it: what they need to log it, and nothing about who added it. */
+exports.clientSupplementResponseSchema = client_food_dto_js_1.clientFoodResponseSchema;

package/dist/esm/enums/index.d.ts

@@ -37,6 +37,13 @@ export declare const PERMISSIONS: {
     readonly goalsUpdate: "goals:update";
     readonly goalsDelete: "goals:delete";
     readonly goalsReadSelf: "goals:read:self";
+    readonly supplementsRead: "supplements:read";
+    readonly supplementsCreate: "supplements:create";
+    readonly supplementsUpdate: "supplements:update";
+    readonly supplementsDelete: "supplements:delete";
+    readonly supplementsImport: "supplements:import";
+    readonly supplementMetadataManage: "supplement_metadata:manage";
+    readonly supplementsSearchSelf: "supplements:search:self";
 };
 export type Permission = (typeof PERMISSIONS)[keyof typeof PERMISSIONS];
 /**
@@ -137,3 +144,6 @@ export declare const GOAL_STATUSES: readonly ["active", "inactive"];
 export type GoalStatus = (typeof GOAL_STATUSES)[number];
 export declare const GOAL_SORT_FIELDS: readonly ["sortOrder", "name", "updatedAt"];
 export type GoalSortField = (typeof GOAL_SORT_FIELDS)[number];
+/** Where a supplement came from. Clients cannot suggest supplements, unlike foods. */
+export declare const SUPPLEMENT_SOURCES: readonly ["ADMIN", "COACH", "IMPORT"];
+export type SupplementSource = (typeof SUPPLEMENT_SOURCES)[number];

package/dist/esm/enums/index.js

@@ -41,6 +41,13 @@ export const PERMISSIONS = {
     goalsUpdate: 'goals:update',
     goalsDelete: 'goals:delete',
     goalsReadSelf: 'goals:read:self',
+    supplementsRead: 'supplements:read',
+    supplementsCreate: 'supplements:create',
+    supplementsUpdate: 'supplements:update',
+    supplementsDelete: 'supplements:delete',
+    supplementsImport: 'supplements:import',
+    supplementMetadataManage: 'supplement_metadata:manage',
+    supplementsSearchSelf: 'supplements:search:self',
 };
 /**
  * `pending_verification` is a self-registered user who has not yet proved they
@@ -174,3 +181,5 @@ export const GOAL_ICONS = [
 /** Whether clients can pick a goal: live goals are either shown or hidden. */
 export const GOAL_STATUSES = ['active', 'inactive'];
 export const GOAL_SORT_FIELDS = ['sortOrder', 'name', 'updatedAt'];
+/** Where a supplement came from. Clients cannot suggest supplements, unlike foods. */
+export const SUPPLEMENT_SOURCES = ['ADMIN', 'COACH', 'IMPORT'];

package/dist/esm/supplements/index.d.ts

@@ -0,0 +1 @@
+export * from './supplement.dto.js';

package/dist/esm/supplements/index.js

@@ -0,0 +1 @@
+export * from './supplement.dto.js';

package/dist/esm/supplements/supplement.dto.d.ts

@@ -0,0 +1,386 @@
+import { z } from 'zod';
+export declare const supplementIdParamSchema: z.ZodUUID;
+export declare const createSupplementSchema: 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>;
+export type CreateSupplementInput = z.input<typeof createSupplementSchema>;
+export type CreateSupplementBody = z.output<typeof createSupplementSchema>;
+export declare const updateSupplementSchema: z.ZodObject<{
+    version: z.ZodNumber;
+    name: z.ZodOptional<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.ZodOptional<z.ZodObject<{
+        label: z.ZodString;
+        quantity: z.ZodNumber;
+        unit: z.ZodEnum<{
+            g: "g";
+            ml: "ml";
+        }>;
+    }, z.core.$strict>>;
+    nutrition: z.ZodOptional<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.ZodOptional<z.ZodArray<z.ZodUUID>>;
+    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strict>;
+export type UpdateSupplementInput = z.input<typeof updateSupplementSchema>;
+export type UpdateSupplementBody = z.output<typeof updateSupplementSchema>;
+/**
+ * `metadata` filters by value ids: a supplement matches when it has at least
+ * one of the listed values of each type that appears in the list.
+ */
+export declare const supplementListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    search: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodPreprocess<z.ZodOptional<z.ZodArray<z.ZodUUID>>, unknown>;
+    source: z.ZodOptional<z.ZodEnum<{
+        ADMIN: "ADMIN";
+        COACH: "COACH";
+        IMPORT: "IMPORT";
+    }>>;
+    sort: z.ZodDefault<z.ZodEnum<{
+        name: "name";
+        updatedAt: "updatedAt";
+        calories: "calories";
+        protein: "protein";
+    }>>;
+    order: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strip>;
+export type SupplementListQuery = z.output<typeof supplementListQuerySchema>;
+export declare const similarSupplementQuerySchema: z.ZodObject<{
+    name: z.ZodString;
+}, z.core.$strip>;
+export type SimilarSupplementQuery = z.output<typeof similarSupplementQuerySchema>;
+export declare const supplementResponseSchema: z.ZodObject<{
+    metadata: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        typeKey: z.ZodString;
+        key: z.ZodString;
+        label: z.ZodString;
+        isActive: z.ZodBoolean;
+    }, z.core.$strip>>;
+    name: z.ZodString;
+    updatedAt: z.ZodISODateTime;
+    id: z.ZodUUID;
+    version: z.ZodNumber;
+    createdAt: z.ZodISODateTime;
+    createdBy: z.ZodObject<{
+        id: z.ZodUUID;
+        fullName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    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>;
+    notes: z.ZodNullable<z.ZodString>;
+    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>;
+    formulaCalories: z.ZodNumber;
+    importBatchId: z.ZodNullable<z.ZodUUID>;
+    source: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        COACH: "COACH";
+        IMPORT: "IMPORT";
+    }>;
+}, z.core.$strip>;
+export type SupplementResponse = z.output<typeof supplementResponseSchema>;
+export declare const similarSupplementResponseSchema: 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>;
+export type SimilarSupplementResponse = z.output<typeof similarSupplementResponseSchema>;
+export declare const supplementStatsResponseSchema: z.ZodObject<{
+    totalSupplements: z.ZodNumber;
+    categories: z.ZodArray<z.ZodObject<{
+        valueId: z.ZodUUID;
+        key: z.ZodString;
+        label: z.ZodString;
+        count: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type SupplementStatsResponse = z.output<typeof supplementStatsResponseSchema>;
+export { type CreateMetadataValueBody, type CreateMetadataValueInput, createMetadataValueSchema, MAX_METADATA_LABEL_LENGTH, metadataTypeIdParamSchema, metadataTypeListResponseSchema, type MetadataTypeResponse, metadataTypeResponseSchema, metadataValueIdParamSchema, type MetadataValueListQuery, metadataValueListQuerySchema, metadataValueListResponseSchema, type MetadataValueResponse, metadataValueResponseSchema, type UpdateMetadataValueBody, type UpdateMetadataValueInput, updateMetadataValueSchema, } from '../food/food.dto.js';
+export { type NutrientValuesResponse, nutrientValuesResponseSchema, type ServingResponse, servingResponseSchema, type FoodMetadataRef as SupplementMetadataRef, foodMetadataRefSchema as supplementMetadataRefSchema, type UserRef, userRefSchema, } from '../food/food.dto.js';
+export { importIdParamSchema, foodImportListQuerySchema as supplementImportListQuerySchema, } from '../food/food-import.dto.js';
+export declare const SUPPLEMENT_IMPORT_LIMITS: {
+    readonly maxFileBytes: number;
+    readonly maxRows: 5000;
+    readonly extensions: readonly [".csv", ".xlsx"];
+};
+export declare const supplementImportRowSchema: 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 SupplementImportRow = z.output<typeof supplementImportRowSchema>;
+export declare const supplementImportIssueSchema: 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 SupplementImportIssue = z.output<typeof supplementImportIssueSchema>;
+export declare const commitSupplementImportSchema: 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 CommitSupplementImportInput = z.input<typeof commitSupplementImportSchema>;
+export type CommitSupplementImportBody = z.output<typeof commitSupplementImportSchema>;
+export declare const supplementImportRowsQuerySchema: 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 SupplementImportRowsQuery = z.output<typeof supplementImportRowsQuerySchema>;
+export declare const supplementImportBatchResponseSchema: 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 SupplementImportBatchResponse = z.output<typeof supplementImportBatchResponseSchema>;
+export declare const supplementImportRowResponseSchema: 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>>;
+    matchedSupplementId: z.ZodNullable<z.ZodUUID>;
+    resultSupplementId: z.ZodNullable<z.ZodUUID>;
+}, z.core.$strip>;
+export type SupplementImportRowResponse = z.output<typeof supplementImportRowResponseSchema>;
+export declare const clientSupplementSearchQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    search: z.ZodString;
+}, z.core.$strip>;
+export type ClientSupplementSearchQuery = z.output<typeof clientSupplementSearchQuerySchema>;
+/** A library supplement as a client sees it: what they need to log it, and nothing about who added it. */
+export declare const clientSupplementResponseSchema: 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 ClientSupplementResponse = z.output<typeof clientSupplementResponseSchema>;

package/dist/esm/supplements/supplement.dto.js

@@ -0,0 +1,90 @@
+import { z } from 'zod';
+import { paginationQuerySchema } from '../common/pagination.schema.js';
+import { FOOD_IMPORT_ROW_STATUSES, FOOD_SORT_FIELDS, SORT_ORDERS, SUPPLEMENT_SOURCES, } from '../enums/index.js';
+import { clientFoodResponseSchema, clientFoodSearchQuerySchema, } from '../food/client-food.dto.js';
+import { createFoodSchema, foodResponseSchema, MAX_FOOD_SEARCH_LENGTH, nutrientValuesResponseSchema, servingResponseSchema, updateFoodSchema, } from '../food/food.dto.js';
+import { commitFoodImportSchema, FOOD_IMPORT_LIMITS, foodImportBatchResponseSchema, foodImportIssueSchema, foodImportRowSchema, foodImportRowsQuerySchema, } from '../food/food-import.dto.js';
+// The supplement library keeps the food library's spreadsheet format, nutrition
+// rules and labels (category, subcategory, tags, meal timing), so its requests
+// and most of its responses are the food library's own shapes. What differs:
+// supplements come from an admin, a coach or an import (clients cannot suggest
+// them), and responses name supplements rather than foods.
+export const supplementIdParamSchema = z.uuid();
+// Requests: the same fields and nutrition rules as a food.
+export const createSupplementSchema = createFoodSchema;
+export const updateSupplementSchema = updateFoodSchema;
+/** Accepts `a,b` or a repeated parameter, as query strings carry either. */
+const idListQuerySchema = z.preprocess((value) => {
+    if (typeof value === 'string') {
+        return value === ''
+            ? undefined
+            : value
+                .split(',')
+                .map((part) => part.trim())
+                .filter(Boolean);
+    }
+    return value;
+}, z.array(z.uuid()).max(50).optional());
+/**
+ * `metadata` filters by value ids: a supplement matches when it has at least
+ * one of the listed values of each type that appears in the list.
+ */
+export const supplementListQuerySchema = paginationQuerySchema.extend({
+    search: z.string().trim().min(1).max(MAX_FOOD_SEARCH_LENGTH).optional(),
+    metadata: idListQuerySchema,
+    source: z.enum(SUPPLEMENT_SOURCES).optional(),
+    sort: z.enum(FOOD_SORT_FIELDS).default('name'),
+    order: z.enum(SORT_ORDERS).default('asc'),
+});
+export const similarSupplementQuerySchema = z.object({
+    name: createFoodSchema.shape.name,
+});
+// Responses
+export const supplementResponseSchema = foodResponseSchema
+    .omit({ suggestionId: true })
+    .extend({ source: z.enum(SUPPLEMENT_SOURCES) });
+export const similarSupplementResponseSchema = z.object({
+    id: z.uuid(),
+    name: z.string(),
+    serving: servingResponseSchema,
+    per100: nutrientValuesResponseSchema,
+    /** 0 to 1; 1 is the same name. */
+    similarity: z.number(),
+});
+export const supplementStatsResponseSchema = z.object({
+    totalSupplements: z.number().int(),
+    categories: z.array(z.object({
+        valueId: z.uuid(),
+        key: z.string(),
+        label: z.string(),
+        count: z.number().int(),
+    })),
+});
+// Labels: the same metadata shapes as the food library, kept in their own tables.
+export { createMetadataValueSchema, MAX_METADATA_LABEL_LENGTH, metadataTypeIdParamSchema, metadataTypeListResponseSchema, metadataTypeResponseSchema, metadataValueIdParamSchema, metadataValueListQuerySchema, metadataValueListResponseSchema, metadataValueResponseSchema, updateMetadataValueSchema, } from '../food/food.dto.js';
+// Shapes inside a supplement response, shared with the food library.
+export { nutrientValuesResponseSchema, servingResponseSchema, foodMetadataRefSchema as supplementMetadataRefSchema, userRefSchema, } from '../food/food.dto.js';
+// Import: the food library's spreadsheet format and limits.
+export { importIdParamSchema, foodImportListQuerySchema as supplementImportListQuerySchema, } from '../food/food-import.dto.js';
+export const SUPPLEMENT_IMPORT_LIMITS = FOOD_IMPORT_LIMITS;
+export const supplementImportRowSchema = foodImportRowSchema;
+export const supplementImportIssueSchema = foodImportIssueSchema;
+export const commitSupplementImportSchema = commitFoodImportSchema;
+export const supplementImportRowsQuerySchema = foodImportRowsQuerySchema;
+export const supplementImportBatchResponseSchema = foodImportBatchResponseSchema;
+export const supplementImportRowResponseSchema = z.object({
+    id: z.uuid(),
+    /** The row number as the spreadsheet shows it, counting the header as row 1. */
+    rowNumber: z.number().int(),
+    status: z.enum(FOOD_IMPORT_ROW_STATUSES),
+    /** The cells as read, by header. */
+    raw: z.record(z.string(), z.string()),
+    parsed: supplementImportRowSchema.nullable(),
+    issues: z.array(supplementImportIssueSchema),
+    matchedSupplementId: z.uuid().nullable(),
+    resultSupplementId: z.uuid().nullable(),
+});
+// Client: search only.
+export const clientSupplementSearchQuerySchema = clientFoodSearchQuerySchema;
+/** A library supplement as a client sees it: what they need to log it, and nothing about who added it. */
+export const clientSupplementResponseSchema = clientFoodResponseSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tbs-fitness/contract",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "TBS API contract: Zod schemas, DTO types and enums shared by the backend, web and mobile apps",
   "license": "UNLICENSED",
   "type": "module",
@@ -123,6 +123,16 @@
         "default": "./dist/cjs/goals/index.js"
       }
     },
+    "./supplements": {
+      "import": {
+        "types": "./dist/esm/supplements/index.d.ts",
+        "default": "./dist/esm/supplements/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/supplements/index.d.ts",
+        "default": "./dist/cjs/supplements/index.js"
+      }
+    },
     "./package.json": "./package.json"
   },
   "scripts": {