@tbs-fitness/contract 0.8.0 → 0.10.0

package/README.md

@@ -43,6 +43,24 @@ 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.
+
+- `/goals`: `createGoalSchema`, `updateGoalSchema` (with `version`), `goalListQuerySchema`, `goalResponseSchema`, `goalStatsResponseSchema`, and the client's `clientGoalResponseSchema` and `clientGoalListResponseSchema`. `normalizeGoalName` is what duplicate name checks compare.
+- `/enums`: `GOAL_ICONS` (icon names each app maps to its own icon), `GOAL_STATUSES` (`active`, `inactive`), `GOAL_SORT_FIELDS`, and the permissions `goals:read`, `goals:create`, `goals:update`, `goals:delete` and `goals:read:self`.
+
 ## Version 0.8.0 (breaking)
 
 - `newPasswordSchema` now matches the new-password screens: at least 8 characters (was 12) and at least one number. `MIN_PASSWORD_LENGTH` is `8`, and the new `PASSWORD_DIGIT_PATTERN` lets apps show the number rule as it is typed. Sign-up, password change and reset all use it; login does not, so existing passwords keep working.

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

@@ -32,6 +32,18 @@ export declare const PERMISSIONS: {
     readonly foodsSearchSelf: "foods:search:self";
     readonly foodSuggestionsSubmitSelf: "food_suggestions:submit:self";
     readonly foodSuggestionsReadSelf: "food_suggestions:read:self";
+    readonly goalsRead: "goals:read";
+    readonly goalsCreate: "goals:create";
+    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];
 /**
@@ -124,3 +136,14 @@ export declare const FOOD_SORT_FIELDS: readonly ["name", "updatedAt", "calories"
 export type FoodSortField = (typeof FOOD_SORT_FIELDS)[number];
 export declare const SORT_ORDERS: readonly ["asc", "desc"];
 export type SortOrder = (typeof SORT_ORDERS)[number];
+/** The icons a goal can show, by name. Each app maps a name to its own icon. */
+export declare const GOAL_ICONS: readonly ["target", "trending-down", "trending-up", "dumbbell", "refresh", "activity", "trophy", "heart", "flame", "scale"];
+export type GoalIcon = (typeof GOAL_ICONS)[number];
+/** Whether clients can pick a goal: live goals are either shown or hidden. */
+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.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',
@@ -39,6 +39,18 @@ exports.PERMISSIONS = {
     foodsSearchSelf: 'foods:search:self',
     foodSuggestionsSubmitSelf: 'food_suggestions:submit:self',
     foodSuggestionsReadSelf: 'food_suggestions:read:self',
+    goalsRead: 'goals:read',
+    goalsCreate: 'goals:create',
+    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
@@ -156,3 +168,21 @@ exports.FOOD_SORT_FIELDS = [
     'protein',
 ];
 exports.SORT_ORDERS = ['asc', 'desc'];
+/** The icons a goal can show, by name. Each app maps a name to its own icon. */
+exports.GOAL_ICONS = [
+    'target',
+    'trending-down',
+    'trending-up',
+    'dumbbell',
+    'refresh',
+    'activity',
+    'trophy',
+    'heart',
+    'flame',
+    'scale',
+];
+/** 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/goals/goal.dto.d.ts

@@ -0,0 +1,137 @@
+import { z } from 'zod';
+export declare const MAX_GOAL_NAME_LENGTH = 60;
+export declare const MAX_GOAL_DESCRIPTION_LENGTH = 200;
+export declare const MAX_GOAL_SEARCH_LENGTH = 60;
+export declare const MAX_GOAL_SORT_ORDER = 9999;
+export declare const goalIdParamSchema: z.ZodUUID;
+/** Lower case with spaces collapsed: what duplicate name checks compare. */
+export declare const normalizeGoalName: (name: string) => string;
+export declare const createGoalSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    icon: z.ZodDefault<z.ZodEnum<{
+        target: "target";
+        "trending-down": "trending-down";
+        "trending-up": "trending-up";
+        dumbbell: "dumbbell";
+        refresh: "refresh";
+        activity: "activity";
+        trophy: "trophy";
+        heart: "heart";
+        flame: "flame";
+        scale: "scale";
+    }>>;
+    isActive: z.ZodDefault<z.ZodBoolean>;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type CreateGoalInput = z.input<typeof createGoalSchema>;
+export type CreateGoalBody = z.output<typeof createGoalSchema>;
+export declare const updateGoalSchema: z.ZodObject<{
+    version: z.ZodNumber;
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    icon: z.ZodOptional<z.ZodEnum<{
+        target: "target";
+        "trending-down": "trending-down";
+        "trending-up": "trending-up";
+        dumbbell: "dumbbell";
+        refresh: "refresh";
+        activity: "activity";
+        trophy: "trophy";
+        heart: "heart";
+        flame: "flame";
+        scale: "scale";
+    }>>;
+    isActive: z.ZodOptional<z.ZodBoolean>;
+    sortOrder: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type UpdateGoalInput = z.input<typeof updateGoalSchema>;
+export type UpdateGoalBody = z.output<typeof updateGoalSchema>;
+export declare const goalListQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    search: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodEnum<{
+        active: "active";
+        inactive: "inactive";
+    }>>;
+    sort: z.ZodDefault<z.ZodEnum<{
+        name: "name";
+        updatedAt: "updatedAt";
+        sortOrder: "sortOrder";
+    }>>;
+    order: z.ZodDefault<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+}, z.core.$strip>;
+export type GoalListQuery = z.output<typeof goalListQuerySchema>;
+export declare const goalResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    icon: z.ZodEnum<{
+        target: "target";
+        "trending-down": "trending-down";
+        "trending-up": "trending-up";
+        dumbbell: "dumbbell";
+        refresh: "refresh";
+        activity: "activity";
+        trophy: "trophy";
+        heart: "heart";
+        flame: "flame";
+        scale: "scale";
+    }>;
+    isActive: z.ZodBoolean;
+    sortOrder: z.ZodNumber;
+    createdBy: z.ZodObject<{
+        id: z.ZodUUID;
+        fullName: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    version: z.ZodNumber;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type GoalResponse = z.output<typeof goalResponseSchema>;
+export declare const goalStatsResponseSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    active: z.ZodNumber;
+    inactive: z.ZodNumber;
+}, z.core.$strip>;
+export type GoalStatsResponse = z.output<typeof goalStatsResponseSchema>;
+/** What a client sees: active goals only, without who edited them. */
+export declare const clientGoalResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    icon: z.ZodEnum<{
+        target: "target";
+        "trending-down": "trending-down";
+        "trending-up": "trending-up";
+        dumbbell: "dumbbell";
+        refresh: "refresh";
+        activity: "activity";
+        trophy: "trophy";
+        heart: "heart";
+        flame: "flame";
+        scale: "scale";
+    }>;
+}, z.core.$strip>;
+export type ClientGoalResponse = z.output<typeof clientGoalResponseSchema>;
+export declare const clientGoalListResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodUUID;
+    name: z.ZodString;
+    description: z.ZodNullable<z.ZodString>;
+    icon: z.ZodEnum<{
+        target: "target";
+        "trending-down": "trending-down";
+        "trending-up": "trending-up";
+        dumbbell: "dumbbell";
+        refresh: "refresh";
+        activity: "activity";
+        trophy: "trophy";
+        heart: "heart";
+        flame: "flame";
+        scale: "scale";
+    }>;
+}, z.core.$strip>>;

package/dist/cjs/goals/goal.dto.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.clientGoalListResponseSchema = exports.clientGoalResponseSchema = exports.goalStatsResponseSchema = exports.goalResponseSchema = exports.goalListQuerySchema = exports.updateGoalSchema = exports.createGoalSchema = exports.normalizeGoalName = exports.goalIdParamSchema = exports.MAX_GOAL_SORT_ORDER = exports.MAX_GOAL_SEARCH_LENGTH = exports.MAX_GOAL_DESCRIPTION_LENGTH = exports.MAX_GOAL_NAME_LENGTH = 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/food.dto.js");
+// A goal is what a client works towards, such as "Build muscle". Coaches keep
+// the list; clients pick one from the goals that are active.
+//
+// Each request has two types. `*Input` is what a client sends, where fields with
+// a default are optional. `*Body` is what the API receives after validation.
+exports.MAX_GOAL_NAME_LENGTH = 60;
+exports.MAX_GOAL_DESCRIPTION_LENGTH = 200;
+exports.MAX_GOAL_SEARCH_LENGTH = 60;
+exports.MAX_GOAL_SORT_ORDER = 9999;
+exports.goalIdParamSchema = zod_1.z.uuid();
+/** Lower case with spaces collapsed: what duplicate name checks compare. */
+const normalizeGoalName = (name) => name.trim().replace(/\s+/g, ' ').toLowerCase();
+exports.normalizeGoalName = normalizeGoalName;
+const goalNameSchema = (0, safe_text_schema_js_1.safeTextSchema)(exports.MAX_GOAL_NAME_LENGTH);
+const goalDescriptionSchema = (0, safe_text_schema_js_1.safeTextSchema)(exports.MAX_GOAL_DESCRIPTION_LENGTH);
+const sortOrderSchema = zod_1.z.number().int().min(0).max(exports.MAX_GOAL_SORT_ORDER);
+// Strict objects reject unknown fields, so an attempt to set `createdBy`
+// through the API fails loudly.
+exports.createGoalSchema = zod_1.z.strictObject({
+    name: goalNameSchema,
+    /** One line under the name, such as "Focus on hypertrophy and progressive overload." */
+    description: goalDescriptionSchema.nullable().optional(),
+    icon: zod_1.z.enum(index_js_1.GOAL_ICONS).default('target'),
+    /** Inactive goals stay in the list but are not offered to clients. */
+    isActive: zod_1.z.boolean().default(true),
+    /** Lower comes first. Left out, the goal goes after the others. */
+    sortOrder: sortOrderSchema.optional(),
+});
+exports.updateGoalSchema = zod_1.z
+    .strictObject({
+    // The version last read, so that a stale edit is refused rather than lost.
+    version: zod_1.z.number().int().min(1),
+    name: goalNameSchema.optional(),
+    description: goalDescriptionSchema.nullable().optional(),
+    icon: zod_1.z.enum(index_js_1.GOAL_ICONS).optional(),
+    isActive: zod_1.z.boolean().optional(),
+    sortOrder: sortOrderSchema.optional(),
+})
+    .refine(({ version: _version, ...changes }) => Object.values(changes).some((value) => value !== undefined), { error: 'Provide at least one field to change' });
+exports.goalListQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({
+    search: zod_1.z.string().trim().min(1).max(exports.MAX_GOAL_SEARCH_LENGTH).optional(),
+    status: zod_1.z.enum(index_js_1.GOAL_STATUSES).optional(),
+    sort: zod_1.z.enum(index_js_1.GOAL_SORT_FIELDS).default('sortOrder'),
+    order: zod_1.z.enum(index_js_1.SORT_ORDERS).default('asc'),
+});
+// Responses
+exports.goalResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    name: zod_1.z.string(),
+    description: zod_1.z.string().nullable(),
+    icon: zod_1.z.enum(index_js_1.GOAL_ICONS),
+    isActive: zod_1.z.boolean(),
+    sortOrder: zod_1.z.number().int(),
+    createdBy: food_dto_js_1.userRefSchema,
+    version: zod_1.z.number().int(),
+    createdAt: date_time_schema_js_1.utcTimestampSchema,
+    updatedAt: date_time_schema_js_1.utcTimestampSchema,
+});
+exports.goalStatsResponseSchema = zod_1.z.object({
+    total: zod_1.z.number().int(),
+    active: zod_1.z.number().int(),
+    inactive: zod_1.z.number().int(),
+});
+/** What a client sees: active goals only, without who edited them. */
+exports.clientGoalResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    name: zod_1.z.string(),
+    description: zod_1.z.string().nullable(),
+    icon: zod_1.z.enum(index_js_1.GOAL_ICONS),
+});
+exports.clientGoalListResponseSchema = zod_1.z.array(exports.clientGoalResponseSchema);

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

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

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

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);