@tbs-fitness/contract 0.10.0 → 0.12.0

package/README.md

@@ -6,16 +6,18 @@ It is published as `@tbs-fitness/contract`. The package holds definitions only:
 
 ## What is in it
 
-| Import                                | Contents                                                                                                                                                                            |
-| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `@tbs-fitness/contract/enums`         | `ROLES`, `PERMISSIONS`, `CSRF_COOKIE_NAMES`, `CSRF_HEADER`, `ACCOUNT_STATUSES`, `TOKEN_TRANSPORTS`, `AUDIT_OUTCOMES`, `APP_ENVIRONMENTS`, `FEATURE_FLAG_RULE_TYPES` and their types |
-| `@tbs-fitness/contract/common`        | Pagination, response envelopes (`{ data }`, `{ data, meta }`, `{ error }`), `emailSchema`, `phoneSchema`, `safeTextSchema`                                                          |
-| `@tbs-fitness/contract/auth`          | Login, sessions, password changes and resets, account administration                                                                                                                |
-| `@tbs-fitness/contract/client`        | Client sign-up, one-time code verification and resend, client sign-in and profile, password recovery                                                                                |
-| `@tbs-fitness/contract/coach`         | Coach sign-up, one-time code verification and resend, coach sign-in and profile, password recovery                                                                                  |
-| `@tbs-fitness/contract/audit`         | The audit log query and response                                                                                                                                                    |
-| `@tbs-fitness/contract/feature-flags` | Feature flag requests and responses                                                                                                                                                 |
-| `@tbs-fitness/contract/food`          | Food library, metadata, CSV/XLSX import, client food suggestions and their review, and the shared nutrition helpers                                                                 |
+| Import                                  | Contents                                                                                                                                                                            |
+| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `@tbs-fitness/contract/enums`           | `ROLES`, `PERMISSIONS`, `CSRF_COOKIE_NAMES`, `CSRF_HEADER`, `ACCOUNT_STATUSES`, `TOKEN_TRANSPORTS`, `AUDIT_OUTCOMES`, `APP_ENVIRONMENTS`, `FEATURE_FLAG_RULE_TYPES` and their types |
+| `@tbs-fitness/contract/common`          | Pagination, response envelopes (`{ data }`, `{ data, meta }`, `{ error }`), `emailSchema`, `phoneSchema`, `safeTextSchema`                                                          |
+| `@tbs-fitness/contract/auth`            | Login, sessions, password changes and resets, account administration                                                                                                                |
+| `@tbs-fitness/contract/client`          | Client sign-up, one-time code verification and resend, client sign-in and profile, password recovery                                                                                |
+| `@tbs-fitness/contract/coach`           | Coach sign-up, one-time code verification and resend, coach sign-in and profile, password recovery                                                                                  |
+| `@tbs-fitness/contract/audit`           | The audit log query and response                                                                                                                                                    |
+| `@tbs-fitness/contract/feature-flags`   | Feature flag requests and responses                                                                                                                                                 |
+| `@tbs-fitness/contract/food`            | Food library, metadata, CSV/XLSX import, client food suggestions and their review, and the shared nutrition helpers                                                                 |
+| `@tbs-fitness/contract/meals`           | The meal library: meals of library foods with servings, and their totals                                                                                                            |
+| `@tbs-fitness/contract/nutrition-plans` | Nutrition plans: drafts, publishing, a client's active plan, the Snapshot step, and the builder's shared sums and publish rules                                                     |
 
 Each domain has its own entry point, so names only need to be unique within a domain. `auditLogResponseSchema`, for example, exists in both `/audit` and `/feature-flags`.
 
@@ -43,6 +45,30 @@ 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.12.0
+
+The meal library and nutrition plans for the Nutrition Plan Builder. Additive; consumers install `^0.12.0` explicitly.
+
+- New `/meals`: `createMealSchema`, `updateMealSchema` (with `version`), `mealListQuerySchema`, `mealResponseSchema` (items with per-serving values and totals), `foodPortionSchema`, `servingsSchema` (0.5 to 10 in half steps), `macroTotalsSchema`, `normalizeMealName`.
+- New `/nutrition-plans`:
+  - Requests: `createNutritionPlanSchema` (optional `fromPlanId`), `saveNutritionPlanSchema` (the whole plan with `version`; a half-built plan is valid), `publishNutritionPlanSchema` (`version`, optional `startsOn`), `nutritionPlanListQuerySchema`, `NUTRITION_PLAN_LIMITS`.
+  - Responses: `nutritionPlanResponseSchema` (with `dailyCalories`, `targets`, `dayTotals` and `publishIssues`), `currentNutritionPlansResponseSchema`, `nutritionPlanSummarySchema`, `clientNutritionPlanResponseSchema`, `nutritionPlanSnapshotResponseSchema`.
+  - Sums and rules shared with the builder: `NUTRITION_GUIDELINES`, `guidelineForGoalIcon`, `dailyCalories`, `macroTargets`, `recommendedWaterMl`, `defaultSlots`, `macroKcal`, `slotTargetKcal`, `addTotals`, `scaleTotals`, and `nutritionPlanPublishIssues` with `PUBLISH_ISSUE_CODES`.
+- `/enums`: `MEAL_SORT_FIELDS`, `NUTRITION_PLAN_STATUSES`, `PLAN_SLOT_KINDS`, `PLAN_PHASES`, `PLAN_BLOCK_WEEKS`, `CHEAT_MEAL_PERIODS`, `NUTRITION_GUIDELINE_IDS`, and the permissions `meals:read`, `meals:create`, `meals:update`, `meals:delete`, `nutrition_plans:read`, `nutrition_plans:write`, `nutrition_plans:publish` and `nutrition_plans:read:self`.
+
+## Version 0.11.0
+
+Client onboarding and generic documents. Additive; consumers install `^0.11.0` explicitly.
+
+- New `/documents`: `documentUploadRequestSchema` (checked against `DOCUMENT_LIMITS` per type), `documentUploadResponseSchema` (the document and a signed PUT), `documentResponseSchema` (never a link to the file), `documentViewUrlResponseSchema` (a short-lived link per view).
+- New `/onboarding`:
+  - Steps: `ONBOARDING_STEP_SCHEMAS` (one per step), `ONBOARDING_FLOW` (order, section, optional), `ONBOARDING_LIMITS`, `localTimeSchema`.
+  - Library picks: `goalChoiceSchema`, `supplementChoiceSchema` and `foodChoiceSchema`; an id of `null` means a typed entry.
+  - Helpers: `nextOnboardingStep`, `missingOnboardingSteps`, `onboardingProgress`, `onboardingSections`, `normalizeItemName`, and the cm/ft-in and kg/lb conversions.
+  - Requests: `saveOnboardingStepSchema` (an answer or a skip, with `version` and `mode`), `onboardingVersionSchema`, `updatePlanDueSchema`.
+  - Responses: `onboardingDraftSchema`, `onboardingStateResponseSchema`, `onboardingSubmissionResponseSchema`, `coachOnboardingResponseSchema`.
+- `/enums`: `DOCUMENT_TYPES`, `DOCUMENT_STATUSES`, `ONBOARDING_STATUSES`, `ONBOARDING_STEPS`, `ONBOARDING_SECTIONS`, the answer enums (`GENDERS`, `EXPERIENCE_LEVELS`, `TRAINING_TIMES`, `WEEKDAYS`, `SESSION_LENGTHS`, `ACTIVITY_LEVELS`, `DIET_TYPES`, `ALLERGENS`, `WATER_INTAKES`, `ANABOLIC_USE`, `BODY_AREAS`, `SLEEP_DURATIONS`, `DIGESTION_QUALITIES`, `REFLUX_FREQUENCIES`, `DIGESTIVE_SYMPTOMS`, `KIDNEY_TEST_ANSWERS`, `HEIGHT_UNITS`, `WEIGHT_UNITS`), and the permissions `documents:write:self`, `documents:read:self`, `documents:read:assigned` and `documents:read:any`.
+
 ## Version 0.10.0
 
 The supplement library. Additive; consumers install `^0.10.0` explicitly.

package/dist/cjs/documents/document.dto.d.ts

@@ -0,0 +1,105 @@
+import { z } from 'zod';
+/** What each document type may be, so the upload screen can say it up front. */
+export declare const DOCUMENT_LIMITS: {
+    readonly PROGRESS_PHOTO_FRONT: {
+        readonly contentTypes: readonly ["image/jpeg", "image/png", "image/webp"];
+        readonly maxBytes: number;
+    };
+    readonly PROGRESS_PHOTO_BACK: {
+        readonly contentTypes: readonly ["image/jpeg", "image/png", "image/webp"];
+        readonly maxBytes: number;
+    };
+    readonly PROGRESS_PHOTO_SIDE: {
+        readonly contentTypes: readonly ["image/jpeg", "image/png", "image/webp"];
+        readonly maxBytes: number;
+    };
+    readonly BLOODWORK_REPORT: {
+        readonly contentTypes: readonly ["application/pdf", "image/jpeg", "image/png"];
+        readonly maxBytes: number;
+    };
+    readonly OTHER: {
+        readonly contentTypes: readonly ["application/pdf", "image/jpeg", "image/png"];
+        readonly maxBytes: number;
+    };
+};
+export declare const documentIdParamSchema: z.ZodUUID;
+/** Asks for an upload link. The content type and size are signed into it. */
+export declare const documentUploadRequestSchema: z.ZodObject<{
+    documentType: z.ZodEnum<{
+        PROGRESS_PHOTO_FRONT: "PROGRESS_PHOTO_FRONT";
+        PROGRESS_PHOTO_BACK: "PROGRESS_PHOTO_BACK";
+        PROGRESS_PHOTO_SIDE: "PROGRESS_PHOTO_SIDE";
+        BLOODWORK_REPORT: "BLOODWORK_REPORT";
+        OTHER: "OTHER";
+    }>;
+    contentType: z.ZodString;
+    sizeBytes: z.ZodNumber;
+}, z.core.$strict>;
+export type DocumentUploadInput = z.input<typeof documentUploadRequestSchema>;
+export type DocumentUploadBody = z.output<typeof documentUploadRequestSchema>;
+/** A stored document. Never carries a link to the file. */
+export declare const documentResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    userId: z.ZodUUID;
+    userRole: z.ZodEnum<{
+        ADMIN: "ADMIN";
+        COACH: "COACH";
+        CLIENT: "CLIENT";
+    }>;
+    documentType: z.ZodEnum<{
+        PROGRESS_PHOTO_FRONT: "PROGRESS_PHOTO_FRONT";
+        PROGRESS_PHOTO_BACK: "PROGRESS_PHOTO_BACK";
+        PROGRESS_PHOTO_SIDE: "PROGRESS_PHOTO_SIDE";
+        BLOODWORK_REPORT: "BLOODWORK_REPORT";
+        OTHER: "OTHER";
+    }>;
+    contentType: z.ZodString;
+    sizeBytes: z.ZodNumber;
+    status: z.ZodEnum<{
+        PENDING: "PENDING";
+        UPLOADED: "UPLOADED";
+    }>;
+    createdAt: z.ZodISODateTime;
+    confirmedAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type DocumentResponse = z.output<typeof documentResponseSchema>;
+/** Where to PUT the file. Send exactly these headers, before `expiresAt`. */
+export declare const documentUploadResponseSchema: z.ZodObject<{
+    document: z.ZodObject<{
+        id: z.ZodUUID;
+        userId: z.ZodUUID;
+        userRole: z.ZodEnum<{
+            ADMIN: "ADMIN";
+            COACH: "COACH";
+            CLIENT: "CLIENT";
+        }>;
+        documentType: z.ZodEnum<{
+            PROGRESS_PHOTO_FRONT: "PROGRESS_PHOTO_FRONT";
+            PROGRESS_PHOTO_BACK: "PROGRESS_PHOTO_BACK";
+            PROGRESS_PHOTO_SIDE: "PROGRESS_PHOTO_SIDE";
+            BLOODWORK_REPORT: "BLOODWORK_REPORT";
+            OTHER: "OTHER";
+        }>;
+        contentType: z.ZodString;
+        sizeBytes: z.ZodNumber;
+        status: z.ZodEnum<{
+            PENDING: "PENDING";
+            UPLOADED: "UPLOADED";
+        }>;
+        createdAt: z.ZodISODateTime;
+        confirmedAt: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>;
+    upload: z.ZodObject<{
+        url: z.ZodURL;
+        method: z.ZodLiteral<"PUT">;
+        headers: z.ZodRecord<z.ZodString, z.ZodString>;
+        expiresAt: z.ZodISODateTime;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type DocumentUploadResponse = z.output<typeof documentUploadResponseSchema>;
+/** A short-lived link to view or download a document. Ask again after it expires. */
+export declare const documentViewUrlResponseSchema: z.ZodObject<{
+    url: z.ZodURL;
+    expiresAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type DocumentViewUrlResponse = z.output<typeof documentViewUrlResponseSchema>;

package/dist/cjs/documents/document.dto.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.documentViewUrlResponseSchema = exports.documentUploadResponseSchema = exports.documentResponseSchema = exports.documentUploadRequestSchema = exports.documentIdParamSchema = exports.DOCUMENT_LIMITS = void 0;
+const zod_1 = require("zod");
+const date_time_schema_js_1 = require("../common/date-time.schema.js");
+const index_js_1 = require("../enums/index.js");
+// A document is any file the app keeps for a user: progress photos, reports and
+// more. The file itself lives in private storage. The API never stores or
+// returns a lasting link: each view asks for a fresh one that expires quickly.
+const MB = 1024 * 1024;
+const PHOTO_TYPES = ['image/jpeg', 'image/png', 'image/webp'];
+const REPORT_TYPES = ['application/pdf', 'image/jpeg', 'image/png'];
+/** What each document type may be, so the upload screen can say it up front. */
+exports.DOCUMENT_LIMITS = {
+    PROGRESS_PHOTO_FRONT: { contentTypes: PHOTO_TYPES, maxBytes: 10 * MB },
+    PROGRESS_PHOTO_BACK: { contentTypes: PHOTO_TYPES, maxBytes: 10 * MB },
+    PROGRESS_PHOTO_SIDE: { contentTypes: PHOTO_TYPES, maxBytes: 10 * MB },
+    BLOODWORK_REPORT: { contentTypes: REPORT_TYPES, maxBytes: 10 * MB },
+    OTHER: { contentTypes: REPORT_TYPES, maxBytes: 10 * MB },
+};
+exports.documentIdParamSchema = zod_1.z.uuid();
+/** Asks for an upload link. The content type and size are signed into it. */
+exports.documentUploadRequestSchema = zod_1.z
+    .strictObject({
+    documentType: zod_1.z.enum(index_js_1.DOCUMENT_TYPES),
+    contentType: zod_1.z.string().trim().toLowerCase(),
+    sizeBytes: zod_1.z.number().int().positive(),
+})
+    .superRefine((body, ctx) => {
+    const limits = exports.DOCUMENT_LIMITS[body.documentType];
+    if (!limits.contentTypes.includes(body.contentType)) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['contentType'],
+            message: `Upload one of: ${limits.contentTypes.join(', ')}`,
+        });
+    }
+    if (body.sizeBytes > limits.maxBytes) {
+        ctx.addIssue({
+            code: 'custom',
+            path: ['sizeBytes'],
+            message: `The file is larger than ${String(limits.maxBytes / MB)} MB`,
+        });
+    }
+});
+// Responses
+/** A stored document. Never carries a link to the file. */
+exports.documentResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    userId: zod_1.z.uuid(),
+    userRole: zod_1.z.enum(index_js_1.ROLES),
+    documentType: zod_1.z.enum(index_js_1.DOCUMENT_TYPES),
+    contentType: zod_1.z.string(),
+    sizeBytes: zod_1.z.number().int(),
+    status: zod_1.z.enum(index_js_1.DOCUMENT_STATUSES),
+    createdAt: date_time_schema_js_1.utcTimestampSchema,
+    confirmedAt: date_time_schema_js_1.utcTimestampSchema.nullable(),
+});
+/** Where to PUT the file. Send exactly these headers, before `expiresAt`. */
+exports.documentUploadResponseSchema = zod_1.z.object({
+    document: exports.documentResponseSchema,
+    upload: zod_1.z.object({
+        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,
+    }),
+});
+/** A short-lived link to view or download a document. Ask again after it expires. */
+exports.documentViewUrlResponseSchema = zod_1.z.object({
+    url: zod_1.z.url(),
+    expiresAt: date_time_schema_js_1.utcTimestampSchema,
+});

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

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

package/dist/cjs/documents/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("./document.dto.js"), exports);

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

@@ -44,6 +44,18 @@ export declare const PERMISSIONS: {
     readonly supplementsImport: "supplements:import";
     readonly supplementMetadataManage: "supplement_metadata:manage";
     readonly supplementsSearchSelf: "supplements:search:self";
+    readonly documentsWriteSelf: "documents:write:self";
+    readonly documentsReadSelf: "documents:read:self";
+    readonly documentsReadAssigned: "documents:read:assigned";
+    readonly documentsReadAny: "documents:read:any";
+    readonly mealsRead: "meals:read";
+    readonly mealsCreate: "meals:create";
+    readonly mealsUpdate: "meals:update";
+    readonly mealsDelete: "meals:delete";
+    readonly nutritionPlansRead: "nutrition_plans:read";
+    readonly nutritionPlansWrite: "nutrition_plans:write";
+    readonly nutritionPlansPublish: "nutrition_plans:publish";
+    readonly nutritionPlansReadSelf: "nutrition_plans:read:self";
 };
 export type Permission = (typeof PERMISSIONS)[keyof typeof PERMISSIONS];
 /**
@@ -147,3 +159,76 @@ 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];
+/** What a stored file is. Each feature that keeps files adds its own types here. */
+export declare const DOCUMENT_TYPES: readonly ["PROGRESS_PHOTO_FRONT", "PROGRESS_PHOTO_BACK", "PROGRESS_PHOTO_SIDE", "BLOODWORK_REPORT", "OTHER"];
+export type DocumentType = (typeof DOCUMENT_TYPES)[number];
+/** A document is `PENDING` until its upload is confirmed. */
+export declare const DOCUMENT_STATUSES: readonly ["PENDING", "UPLOADED"];
+export type DocumentStatus = (typeof DOCUMENT_STATUSES)[number];
+export declare const ONBOARDING_STATUSES: readonly ["NOT_STARTED", "IN_PROGRESS", "LOCKED", "PLEDGED"];
+export type OnboardingStatus = (typeof ONBOARDING_STATUSES)[number];
+/** Every question step, in the order the client answers them. */
+export declare const ONBOARDING_STEPS: readonly ["name", "age", "gender", "height", "weight", "goal", "level", "schedule", "day", "working_hours", "diet", "fuel", "eating_routine", "supplements", "body", "sleep", "digestion", "photos", "bloodwork", "notes"];
+export type OnboardingStep = (typeof ONBOARDING_STEPS)[number];
+/** The sections of The File, in the order it lists them. */
+export declare const ONBOARDING_SECTIONS: readonly ["basics", "goal_level", "training", "your_day", "sleep", "food_fuel", "body_health", "photos_bloodwork"];
+export type OnboardingSection = (typeof ONBOARDING_SECTIONS)[number];
+export declare const GENDERS: readonly ["MALE", "FEMALE"];
+export type Gender = (typeof GENDERS)[number];
+export declare const EXPERIENCE_LEVELS: readonly ["BEGINNER", "INTERMEDIATE", "ADVANCED"];
+export type ExperienceLevel = (typeof EXPERIENCE_LEVELS)[number];
+export declare const TRAINING_TIMES: readonly ["MORNING", "MIDDAY", "EVENING", "NIGHT"];
+export type TrainingTime = (typeof TRAINING_TIMES)[number];
+export declare const WEEKDAYS: readonly ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"];
+export type Weekday = (typeof WEEKDAYS)[number];
+export declare const SESSION_LENGTHS: readonly ["MIN_30", "MIN_45", "MIN_60", "MIN_90_PLUS"];
+export type SessionLength = (typeof SESSION_LENGTHS)[number];
+export declare const ACTIVITY_LEVELS: readonly ["SEDENTARY", "LIGHTLY_ACTIVE", "MODERATELY_ACTIVE", "VERY_ACTIVE", "PHYSICALLY_DEMANDING"];
+export type ActivityLevel = (typeof ACTIVITY_LEVELS)[number];
+export declare const DIET_TYPES: readonly ["VEGETARIAN", "NON_VEGETARIAN", "EGGETARIAN", "VEGAN"];
+export type DietType = (typeof DIET_TYPES)[number];
+export declare const ALLERGENS: readonly ["PEANUT", "DAIRY", "GLUTEN", "SHELLFISH", "SOY", "EGGS"];
+export type Allergen = (typeof ALLERGENS)[number];
+export declare const WATER_INTAKES: readonly ["UNDER_1L", "L1_TO_2", "L2_TO_3", "OVER_3L"];
+export type WaterIntake = (typeof WATER_INTAKES)[number];
+export declare const ANABOLIC_USE: readonly ["NONE", "PAST", "CURRENT"];
+export type AnabolicUse = (typeof ANABOLIC_USE)[number];
+export declare const BODY_AREAS: readonly ["SHOULDER", "LOWER_BACK", "KNEE", "WRIST_ELBOW", "NECK", "HIP"];
+export type BodyArea = (typeof BODY_AREAS)[number];
+export declare const SLEEP_DURATIONS: readonly ["UNDER_5H", "H5_TO_6", "H6_TO_7", "H7_TO_8", "OVER_8H"];
+export type SleepDuration = (typeof SLEEP_DURATIONS)[number];
+export declare const DIGESTION_QUALITIES: readonly ["GOOD", "AVERAGE", "POOR"];
+export type DigestionQuality = (typeof DIGESTION_QUALITIES)[number];
+export declare const REFLUX_FREQUENCIES: readonly ["NEVER", "OCCASIONALLY", "FREQUENTLY", "DAILY"];
+export type RefluxFrequency = (typeof REFLUX_FREQUENCIES)[number];
+export declare const DIGESTIVE_SYMPTOMS: readonly ["BLOATING", "CONSTIPATION", "GAS", "STOMACH_PAIN", "LOOSE_MOTIONS"];
+export type DigestiveSymptom = (typeof DIGESTIVE_SYMPTOMS)[number];
+export declare const KIDNEY_TEST_ANSWERS: readonly ["YES", "NO", "NOT_SURE"];
+export type KidneyTestAnswer = (typeof KIDNEY_TEST_ANSWERS)[number];
+export declare const HEIGHT_UNITS: readonly ["CM", "FT"];
+export type HeightUnit = (typeof HEIGHT_UNITS)[number];
+export declare const WEIGHT_UNITS: readonly ["KG", "LB"];
+export type WeightUnit = (typeof WEIGHT_UNITS)[number];
+export declare const MEAL_SORT_FIELDS: readonly ["name", "updatedAt"];
+export type MealSortField = (typeof MEAL_SORT_FIELDS)[number];
+/**
+ * A plan is built as a `DRAFT`, becomes `ACTIVE` when published, and is
+ * `ARCHIVED` when a newer plan replaces it. A client has at most one of each
+ * of the first two.
+ */
+export declare const NUTRITION_PLAN_STATUSES: readonly ["DRAFT", "ACTIVE", "ARCHIVED"];
+export type NutritionPlanStatus = (typeof NUTRITION_PLAN_STATUSES)[number];
+export declare const PLAN_SLOT_KINDS: readonly ["MEAL", "SHAKE"];
+export type PlanSlotKind = (typeof PLAN_SLOT_KINDS)[number];
+/** The stretch of the training block the calorie base is set for. */
+export declare const PLAN_PHASES: readonly ["WEEKS_1_2", "WEEKS_3_4", "WEEKS_5_6", "WEEKS_7_8"];
+export type PlanPhase = (typeof PLAN_PHASES)[number];
+/** How long a published plan runs, in weeks. */
+export declare const PLAN_BLOCK_WEEKS: readonly [8, 12, 16];
+export type PlanBlockWeeks = (typeof PLAN_BLOCK_WEEKS)[number];
+/** The period a cheat-meal allowance resets over. Unused cheat meals do not carry over. */
+export declare const CHEAT_MEAL_PERIODS: readonly ["WEEK", "TWO_WEEKS", "MONTH"];
+export type CheatMealPeriod = (typeof CHEAT_MEAL_PERIODS)[number];
+/** Starting points for the calorie base: calories per pound and a macro split. */
+export declare const NUTRITION_GUIDELINE_IDS: readonly ["AGGRESSIVE_CUT", "MODERATE_CUT", "MAINTENANCE", "MUSCLE_GAIN", "AGGRESSIVE_BULK"];
+export type NutritionGuidelineId = (typeof NUTRITION_GUIDELINE_IDS)[number];

package/dist/cjs/enums/index.js

@@ -2,7 +2,8 @@
 // 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.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.SLEEP_DURATIONS = exports.BODY_AREAS = exports.ANABOLIC_USE = exports.WATER_INTAKES = exports.ALLERGENS = exports.DIET_TYPES = exports.ACTIVITY_LEVELS = exports.SESSION_LENGTHS = exports.WEEKDAYS = exports.TRAINING_TIMES = exports.EXPERIENCE_LEVELS = exports.GENDERS = exports.ONBOARDING_SECTIONS = exports.ONBOARDING_STEPS = exports.ONBOARDING_STATUSES = exports.DOCUMENT_STATUSES = exports.DOCUMENT_TYPES = 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.NUTRITION_GUIDELINE_IDS = exports.CHEAT_MEAL_PERIODS = exports.PLAN_BLOCK_WEEKS = exports.PLAN_PHASES = exports.PLAN_SLOT_KINDS = exports.NUTRITION_PLAN_STATUSES = exports.MEAL_SORT_FIELDS = exports.WEIGHT_UNITS = exports.HEIGHT_UNITS = exports.KIDNEY_TEST_ANSWERS = exports.DIGESTIVE_SYMPTOMS = exports.REFLUX_FREQUENCIES = exports.DIGESTION_QUALITIES = void 0;
 exports.APP_ENVIRONMENTS = [
     'development',
     'staging',
@@ -51,6 +52,18 @@ exports.PERMISSIONS = {
     supplementsImport: 'supplements:import',
     supplementMetadataManage: 'supplement_metadata:manage',
     supplementsSearchSelf: 'supplements:search:self',
+    documentsWriteSelf: 'documents:write:self',
+    documentsReadSelf: 'documents:read:self',
+    documentsReadAssigned: 'documents:read:assigned',
+    documentsReadAny: 'documents:read:any',
+    mealsRead: 'meals:read',
+    mealsCreate: 'meals:create',
+    mealsUpdate: 'meals:update',
+    mealsDelete: 'meals:delete',
+    nutritionPlansRead: 'nutrition_plans:read',
+    nutritionPlansWrite: 'nutrition_plans:write',
+    nutritionPlansPublish: 'nutrition_plans:publish',
+    nutritionPlansReadSelf: 'nutrition_plans:read:self',
 };
 /**
  * `pending_verification` is a self-registered user who has not yet proved they
@@ -186,3 +199,169 @@ 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'];
+/** What a stored file is. Each feature that keeps files adds its own types here. */
+exports.DOCUMENT_TYPES = [
+    'PROGRESS_PHOTO_FRONT',
+    'PROGRESS_PHOTO_BACK',
+    'PROGRESS_PHOTO_SIDE',
+    'BLOODWORK_REPORT',
+    'OTHER',
+];
+/** A document is `PENDING` until its upload is confirmed. */
+exports.DOCUMENT_STATUSES = ['PENDING', 'UPLOADED'];
+// Client onboarding
+exports.ONBOARDING_STATUSES = [
+    'NOT_STARTED',
+    'IN_PROGRESS',
+    'LOCKED',
+    'PLEDGED',
+];
+/** Every question step, in the order the client answers them. */
+exports.ONBOARDING_STEPS = [
+    'name',
+    'age',
+    'gender',
+    'height',
+    'weight',
+    'goal',
+    'level',
+    'schedule',
+    'day',
+    'working_hours',
+    'diet',
+    'fuel',
+    'eating_routine',
+    'supplements',
+    'body',
+    'sleep',
+    'digestion',
+    'photos',
+    'bloodwork',
+    'notes',
+];
+/** The sections of The File, in the order it lists them. */
+exports.ONBOARDING_SECTIONS = [
+    'basics',
+    'goal_level',
+    'training',
+    'your_day',
+    'sleep',
+    'food_fuel',
+    'body_health',
+    'photos_bloodwork',
+];
+exports.GENDERS = ['MALE', 'FEMALE'];
+exports.EXPERIENCE_LEVELS = [
+    'BEGINNER',
+    'INTERMEDIATE',
+    'ADVANCED',
+];
+exports.TRAINING_TIMES = [
+    'MORNING',
+    'MIDDAY',
+    'EVENING',
+    'NIGHT',
+];
+exports.WEEKDAYS = [
+    'MON',
+    'TUE',
+    'WED',
+    'THU',
+    'FRI',
+    'SAT',
+    'SUN',
+];
+exports.SESSION_LENGTHS = [
+    'MIN_30',
+    'MIN_45',
+    'MIN_60',
+    'MIN_90_PLUS',
+];
+exports.ACTIVITY_LEVELS = [
+    'SEDENTARY',
+    'LIGHTLY_ACTIVE',
+    'MODERATELY_ACTIVE',
+    'VERY_ACTIVE',
+    'PHYSICALLY_DEMANDING',
+];
+exports.DIET_TYPES = [
+    'VEGETARIAN',
+    'NON_VEGETARIAN',
+    'EGGETARIAN',
+    'VEGAN',
+];
+exports.ALLERGENS = [
+    'PEANUT',
+    'DAIRY',
+    'GLUTEN',
+    'SHELLFISH',
+    'SOY',
+    'EGGS',
+];
+exports.WATER_INTAKES = [
+    'UNDER_1L',
+    'L1_TO_2',
+    'L2_TO_3',
+    'OVER_3L',
+];
+exports.ANABOLIC_USE = ['NONE', 'PAST', 'CURRENT'];
+exports.BODY_AREAS = [
+    'SHOULDER',
+    'LOWER_BACK',
+    'KNEE',
+    'WRIST_ELBOW',
+    'NECK',
+    'HIP',
+];
+exports.SLEEP_DURATIONS = [
+    'UNDER_5H',
+    'H5_TO_6',
+    'H6_TO_7',
+    'H7_TO_8',
+    'OVER_8H',
+];
+exports.DIGESTION_QUALITIES = ['GOOD', 'AVERAGE', 'POOR'];
+exports.REFLUX_FREQUENCIES = [
+    'NEVER',
+    'OCCASIONALLY',
+    'FREQUENTLY',
+    'DAILY',
+];
+exports.DIGESTIVE_SYMPTOMS = [
+    'BLOATING',
+    'CONSTIPATION',
+    'GAS',
+    'STOMACH_PAIN',
+    'LOOSE_MOTIONS',
+];
+exports.KIDNEY_TEST_ANSWERS = ['YES', 'NO', 'NOT_SURE'];
+exports.HEIGHT_UNITS = ['CM', 'FT'];
+exports.WEIGHT_UNITS = ['KG', 'LB'];
+// Meal library and nutrition plans
+exports.MEAL_SORT_FIELDS = ['name', 'updatedAt'];
+/**
+ * A plan is built as a `DRAFT`, becomes `ACTIVE` when published, and is
+ * `ARCHIVED` when a newer plan replaces it. A client has at most one of each
+ * of the first two.
+ */
+exports.NUTRITION_PLAN_STATUSES = ['DRAFT', 'ACTIVE', 'ARCHIVED'];
+exports.PLAN_SLOT_KINDS = ['MEAL', 'SHAKE'];
+/** The stretch of the training block the calorie base is set for. */
+exports.PLAN_PHASES = [
+    'WEEKS_1_2',
+    'WEEKS_3_4',
+    'WEEKS_5_6',
+    'WEEKS_7_8',
+];
+/** How long a published plan runs, in weeks. */
+exports.PLAN_BLOCK_WEEKS = [8, 12, 16];
+/** The period a cheat-meal allowance resets over. Unused cheat meals do not carry over. */
+exports.CHEAT_MEAL_PERIODS = ['WEEK', 'TWO_WEEKS', 'MONTH'];
+/** Starting points for the calorie base: calories per pound and a macro split. */
+exports.NUTRITION_GUIDELINE_IDS = [
+    'AGGRESSIVE_CUT',
+    'MODERATE_CUT',
+    'MAINTENANCE',
+    'MUSCLE_GAIN',
+    'AGGRESSIVE_BULK',
+];

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

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

package/dist/cjs/meals/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("./meal.dto.js"), exports);