@tbs-fitness/contract 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,124 @@
-# Temporary Holding Version
+# TBS_contract
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The contract between the TBS platforms. The backend, web and mobile apps all import their API schemas, DTO types and enums from this package, so a request or response has one definition and a breaking change shows up as a compile error.
+
+It is published as `@tbs-fitness/contract`. The package holds definitions only: no database code, no framework code and no secrets, because it ends up in client bundles.
+
+## What is in it
+
+| Import                                | Contents                                                                                                                         |
+| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| `@tbs-fitness/contract/enums`         | `ROLES`, `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/audit`         | The audit log query and response                                                                                                 |
+| `@tbs-fitness/contract/feature-flags` | Feature flag requests and responses                                                                                              |
+
+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`.
+
+## Using it
+
+The package needs `zod` 4 from the app, so that every app has a single copy of it.
+
+```ts
+import type { PaginatedResponse } from '@tbs-fitness/contract/common';
+import {
+  type CreateFlagInput,
+  createFlagSchema,
+  type FlagResponse,
+  flagResponseSchema,
+} from '@tbs-fitness/contract/feature-flags';
+
+const input: CreateFlagInput = {
+  key: 'new-checkout',
+  name: 'New checkout',
+  environment: 'staging',
+};
+
+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>`.
+
+## Installing it
+
+The package is public on npm, so installing it needs no token:
+
+```bash
+npm install @tbs-fitness/contract
+```
+
+## Adding to it
+
+1. Put a domain's schemas in a `.dto.ts` file in `src/<domain>`, and export its types with `z.input` and `z.output`.
+2. Put values shared by several domains in `src/enums` or `src/common`.
+3. For a new domain, add `src/<domain>/index.ts` and an entry to `exports` in `package.json`.
+4. Add tests next to the schema.
+
+Keep validation that needs a server, such as a uniqueness check, in the backend.
+
+The package is public, so anyone can read everything in it, permanently. Add only what clients can already see in API traffic: never secrets, internal hostnames or customer data.
+
+## Development
+
+You need Node 24.
+
+```bash
+nvm install
+```
+
+```bash
+npm install
+```
+
+| Command          | What it does                                  |
+| ---------------- | --------------------------------------------- |
+| `npm run build`  | Builds ESM and CommonJS into `dist`           |
+| `npm test`       | Runs the unit tests                           |
+| `npm run check`  | Runs the typecheck, lint, format check, tests |
+| `npm run format` | Formats the code                              |
+
+### Trying a change in the backend
+
+The backend installs this package from a sibling checkout until the first version is published. After changing it, run this in `TBS_backend`, which rebuilds the package and installs it as a published copy would be. `npm install ../TBS_contract` alone keeps the old copy while the version is unchanged.
+
+```bash
+rm -rf node_modules/@tbs-fitness/contract && npm install
+```
+
+## Versioning
+
+Versions follow semver, and every app pins the version it was tested with.
+
+| Change                                                              | Version |
+| ------------------------------------------------------------------- | ------- |
+| Removing or renaming anything exported, or a field in a response    | Major   |
+| A stricter rule, a new required request field, a removed enum value | Major   |
+| A new schema, a new optional request field, a new response field    | Minor   |
+| A fix that accepts and returns the same data                        | Patch   |
+
+A new enum value can break a client with an exhaustive `switch`, so treat it as a major version unless the clients are known to handle it.
+
+## Publishing
+
+Log in to npm as a user who can publish to the `tbs-fitness` organisation:
+
+```bash
+npm login
+```
+
+Then, from an up-to-date `main`, set the new version and publish it. The first release is already `0.1.0`, so skip `npm version` for that one.
+
+```bash
+npm version minor
+```
+
+```bash
+npm publish
+```
+
+```bash
+git push --follow-tags
+```
+
+`npm publish` runs all the checks and a fresh build first. `publishConfig` in `package.json` sets `access` to `public`, because npm otherwise treats a scoped package as private, which needs a paid plan.

package/dist/cjs/audit/audit-log.dto.d.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+export declare const auditLogQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    actorId: z.ZodOptional<z.ZodUUID>;
+    action: z.ZodOptional<z.ZodString>;
+    resourceType: z.ZodOptional<z.ZodString>;
+    resourceId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type AuditLogQuery = z.output<typeof auditLogQuerySchema>;
+export declare const auditLogResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    actorId: z.ZodNullable<z.ZodUUID>;
+    action: z.ZodString;
+    outcome: z.ZodEnum<{
+        success: "success";
+        failure: "failure";
+    }>;
+    resourceType: z.ZodString;
+    resourceId: z.ZodNullable<z.ZodString>;
+    requestId: z.ZodNullable<z.ZodString>;
+    correlationId: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type AuditLogResponse = z.output<typeof auditLogResponseSchema>;

package/dist/cjs/audit/audit-log.dto.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.auditLogResponseSchema = exports.auditLogQuerySchema = 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");
+exports.auditLogQuerySchema = pagination_schema_js_1.paginationQuerySchema.extend({
+    actorId: zod_1.z.uuid().optional(),
+    action: zod_1.z.string().max(100).optional(),
+    resourceType: zod_1.z.string().max(100).optional(),
+    resourceId: zod_1.z.string().max(100).optional(),
+});
+exports.auditLogResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    actorId: zod_1.z.uuid().nullable(),
+    action: zod_1.z.string(),
+    outcome: zod_1.z.enum(index_js_1.AUDIT_OUTCOMES),
+    resourceType: zod_1.z.string(),
+    resourceId: zod_1.z.string().nullable(),
+    requestId: zod_1.z.string().nullable(),
+    correlationId: zod_1.z.string().nullable(),
+    metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).nullable(),
+    createdAt: zod_1.z.iso.datetime(),
+});

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

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

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

package/dist/cjs/auth/auth.dto.d.ts

@@ -0,0 +1,121 @@
+import { z } from 'zod';
+export declare const MIN_PASSWORD_LENGTH = 12;
+export declare const MAX_PASSWORD_LENGTH = 128;
+export declare const newPasswordSchema: z.ZodString;
+export declare const loginSchema: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodEmail>;
+    password: z.ZodString;
+    deviceName: z.ZodOptional<z.ZodString>;
+    tokenTransport: z.ZodDefault<z.ZodEnum<{
+        body: "body";
+        cookie: "cookie";
+    }>>;
+}, z.core.$strict>;
+export type LoginInput = z.input<typeof loginSchema>;
+export type LoginBody = z.output<typeof loginSchema>;
+export declare const refreshSchema: z.ZodDefault<z.ZodObject<{
+    refreshToken: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>>;
+export type RefreshInput = z.input<typeof refreshSchema>;
+export type RefreshBody = z.output<typeof refreshSchema>;
+export declare const changePasswordSchema: z.ZodObject<{
+    currentPassword: z.ZodString;
+    newPassword: z.ZodString;
+}, z.core.$strict>;
+export type ChangePasswordInput = z.input<typeof changePasswordSchema>;
+export type ChangePasswordBody = z.output<typeof changePasswordSchema>;
+export declare const passwordResetRequestSchema: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodEmail>;
+}, z.core.$strict>;
+export type PasswordResetRequestInput = z.input<typeof passwordResetRequestSchema>;
+export type PasswordResetRequestBody = z.output<typeof passwordResetRequestSchema>;
+export declare const passwordResetConfirmSchema: z.ZodObject<{
+    token: z.ZodString;
+    newPassword: z.ZodString;
+}, z.core.$strict>;
+export type PasswordResetConfirmInput = z.input<typeof passwordResetConfirmSchema>;
+export type PasswordResetConfirmBody = z.output<typeof passwordResetConfirmSchema>;
+export declare const setRolesSchema: z.ZodObject<{
+    roles: z.ZodArray<z.ZodEnum<{
+        admin: "admin";
+        trainer: "trainer";
+        customer: "customer";
+    }>>;
+}, z.core.$strict>;
+export type SetRolesInput = z.input<typeof setRolesSchema>;
+export type SetRolesBody = z.output<typeof setRolesSchema>;
+export declare const setStatusSchema: z.ZodObject<{
+    status: z.ZodEnum<{
+        active: "active";
+        disabled: "disabled";
+    }>;
+}, z.core.$strict>;
+export type SetStatusInput = z.input<typeof setStatusSchema>;
+export type SetStatusBody = z.output<typeof setStatusSchema>;
+export declare const idParamSchema: z.ZodUUID;
+export declare const tokenResponseSchema: z.ZodObject<{
+    accessToken: z.ZodString;
+    tokenType: z.ZodLiteral<"Bearer">;
+    expiresInSeconds: z.ZodNumber;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    csrfToken: z.ZodOptional<z.ZodString>;
+    sessionId: z.ZodUUID;
+}, z.core.$strip>;
+export type TokenResponse = z.output<typeof tokenResponseSchema>;
+export declare const accountResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    email: z.ZodString;
+    roles: z.ZodArray<z.ZodString>;
+    permissions: z.ZodArray<z.ZodString>;
+    lastLoginAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type AccountResponse = z.output<typeof accountResponseSchema>;
+export declare const loginResponseSchema: z.ZodObject<{
+    accessToken: z.ZodString;
+    tokenType: z.ZodLiteral<"Bearer">;
+    expiresInSeconds: z.ZodNumber;
+    refreshToken: z.ZodOptional<z.ZodString>;
+    csrfToken: z.ZodOptional<z.ZodString>;
+    sessionId: z.ZodUUID;
+    account: z.ZodObject<{
+        id: z.ZodUUID;
+        email: z.ZodString;
+        roles: z.ZodArray<z.ZodString>;
+        permissions: z.ZodArray<z.ZodString>;
+        lastLoginAt: z.ZodNullable<z.ZodISODateTime>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type LoginResponse = z.output<typeof loginResponseSchema>;
+export declare const sessionResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    deviceName: z.ZodNullable<z.ZodString>;
+    userAgent: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodISODateTime;
+    lastUsedAt: z.ZodISODateTime;
+    expiresAt: z.ZodISODateTime;
+    current: z.ZodBoolean;
+}, z.core.$strip>;
+export type SessionResponse = z.output<typeof sessionResponseSchema>;
+export declare const logoutAllResponseSchema: z.ZodObject<{
+    revokedSessions: z.ZodNumber;
+}, z.core.$strip>;
+export type LogoutAllResponse = z.output<typeof logoutAllResponseSchema>;
+export declare const passwordResetRequestedResponseSchema: z.ZodObject<{
+    message: z.ZodString;
+}, z.core.$strip>;
+export type PasswordResetRequestedResponse = z.output<typeof passwordResetRequestedResponseSchema>;
+export declare const adminAccountResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    email: z.ZodString;
+    roles: z.ZodArray<z.ZodString>;
+    status: z.ZodEnum<{
+        active: "active";
+        disabled: "disabled";
+    }>;
+    lastLoginAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type AdminAccountResponse = z.output<typeof adminAccountResponseSchema>;
+export declare const revokedSessionsResponseSchema: z.ZodObject<{
+    revokedSessions: z.ZodNumber;
+}, z.core.$strip>;
+export type RevokedSessionsResponse = z.output<typeof revokedSessionsResponseSchema>;

package/dist/cjs/auth/auth.dto.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.revokedSessionsResponseSchema = exports.adminAccountResponseSchema = exports.passwordResetRequestedResponseSchema = exports.logoutAllResponseSchema = exports.sessionResponseSchema = exports.loginResponseSchema = exports.accountResponseSchema = exports.tokenResponseSchema = exports.idParamSchema = exports.setStatusSchema = exports.setRolesSchema = exports.passwordResetConfirmSchema = exports.passwordResetRequestSchema = exports.changePasswordSchema = exports.refreshSchema = exports.loginSchema = exports.newPasswordSchema = exports.MAX_PASSWORD_LENGTH = exports.MIN_PASSWORD_LENGTH = void 0;
+const zod_1 = require("zod");
+const contact_schema_js_1 = require("../common/contact.schema.js");
+const safe_text_schema_js_1 = require("../common/safe-text.schema.js");
+const index_js_1 = require("../enums/index.js");
+// Per OWASP: length is what matters, with no composition rules. The upper limit
+// stops very long inputs from being used to exhaust the hashing function.
+exports.MIN_PASSWORD_LENGTH = 12;
+exports.MAX_PASSWORD_LENGTH = 128;
+const MAX_OPAQUE_TOKEN_LENGTH = 512;
+exports.newPasswordSchema = zod_1.z
+    .string()
+    .min(exports.MIN_PASSWORD_LENGTH)
+    .max(exports.MAX_PASSWORD_LENGTH);
+/** No minimum at login, so an old short password fails like any wrong password. */
+const submittedPasswordSchema = zod_1.z.string().min(1).max(exports.MAX_PASSWORD_LENGTH);
+const opaqueTokenSchema = zod_1.z.string().min(1).max(MAX_OPAQUE_TOKEN_LENGTH);
+// Strict objects reject unknown fields, so an attempt to send `roles` or
+// `status` fails loudly rather than being silently ignored.
+exports.loginSchema = zod_1.z.strictObject({
+    email: contact_schema_js_1.emailSchema,
+    password: submittedPasswordSchema,
+    deviceName: (0, safe_text_schema_js_1.safeTextSchema)(100).optional(),
+    tokenTransport: zod_1.z.enum(index_js_1.TOKEN_TRANSPORTS).default('body'),
+});
+exports.refreshSchema = zod_1.z
+    .strictObject({ refreshToken: opaqueTokenSchema.optional() })
+    .default({});
+exports.changePasswordSchema = zod_1.z.strictObject({
+    currentPassword: submittedPasswordSchema,
+    newPassword: exports.newPasswordSchema,
+});
+exports.passwordResetRequestSchema = zod_1.z.strictObject({
+    email: contact_schema_js_1.emailSchema,
+});
+exports.passwordResetConfirmSchema = zod_1.z.strictObject({
+    token: opaqueTokenSchema,
+    newPassword: exports.newPasswordSchema,
+});
+exports.setRolesSchema = zod_1.z.strictObject({
+    roles: zod_1.z.array(zod_1.z.enum(index_js_1.ROLES)).max(index_js_1.ROLES.length),
+});
+exports.setStatusSchema = zod_1.z.strictObject({
+    status: zod_1.z.enum(index_js_1.ACCOUNT_STATUSES),
+});
+exports.idParamSchema = zod_1.z.uuid();
+exports.tokenResponseSchema = zod_1.z.object({
+    accessToken: zod_1.z.string(),
+    tokenType: zod_1.z.literal('Bearer'),
+    expiresInSeconds: zod_1.z.number().int(),
+    refreshToken: zod_1.z.string().optional(),
+    csrfToken: zod_1.z.string().optional(),
+    sessionId: zod_1.z.uuid(),
+});
+exports.accountResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    email: zod_1.z.string(),
+    roles: zod_1.z.array(zod_1.z.string()),
+    permissions: zod_1.z.array(zod_1.z.string()),
+    lastLoginAt: zod_1.z.iso.datetime().nullable(),
+});
+exports.loginResponseSchema = exports.tokenResponseSchema.extend({
+    account: exports.accountResponseSchema,
+});
+exports.sessionResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    deviceName: zod_1.z.string().nullable(),
+    userAgent: zod_1.z.string().nullable(),
+    createdAt: zod_1.z.iso.datetime(),
+    lastUsedAt: zod_1.z.iso.datetime(),
+    expiresAt: zod_1.z.iso.datetime(),
+    current: zod_1.z.boolean(),
+});
+exports.logoutAllResponseSchema = zod_1.z.object({
+    revokedSessions: zod_1.z.number().int(),
+});
+exports.passwordResetRequestedResponseSchema = zod_1.z.object({
+    message: zod_1.z.string(),
+});
+exports.adminAccountResponseSchema = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    email: zod_1.z.string(),
+    roles: zod_1.z.array(zod_1.z.string()),
+    status: zod_1.z.enum(index_js_1.ACCOUNT_STATUSES),
+    lastLoginAt: zod_1.z.iso.datetime().nullable(),
+});
+exports.revokedSessionsResponseSchema = zod_1.z.object({
+    revokedSessions: zod_1.z.number().int(),
+});

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

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

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

package/dist/cjs/common/api-response.schema.d.ts

@@ -0,0 +1,37 @@
+import { z } from 'zod';
+import { type PaginationMeta } from './pagination.schema.js';
+export declare const apiErrorResponseSchema: z.ZodObject<{
+    error: z.ZodObject<{
+        statusCode: z.ZodNumber;
+        code: z.ZodString;
+        message: z.ZodString;
+        details: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            location: z.ZodString;
+            path: z.ZodString;
+            message: z.ZodString;
+        }, z.core.$strip>>>;
+        requestId: z.ZodString;
+        timestamp: z.ZodISODateTime;
+        path: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type ApiErrorResponse = z.output<typeof apiErrorResponseSchema>;
+export declare const dataResponseSchema: <T extends z.ZodType>(data: T) => z.ZodObject<{
+    data: T;
+}, z.core.$strip>;
+export interface DataResponse<T> {
+    data: T;
+}
+export declare const paginatedResponseSchema: <T extends z.ZodType>(item: T) => z.ZodObject<{
+    data: z.ZodArray<T>;
+    meta: z.ZodObject<{
+        page: z.ZodNumber;
+        pageSize: z.ZodNumber;
+        totalItems: z.ZodNumber;
+        totalPages: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export interface PaginatedResponse<T> {
+    data: T[];
+    meta: PaginationMeta;
+}

package/dist/cjs/common/api-response.schema.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginatedResponseSchema = exports.dataResponseSchema = exports.apiErrorResponseSchema = void 0;
+const zod_1 = require("zod");
+const pagination_schema_js_1 = require("./pagination.schema.js");
+exports.apiErrorResponseSchema = zod_1.z.object({
+    error: zod_1.z.object({
+        statusCode: zod_1.z.number().int(),
+        code: zod_1.z.string(),
+        message: zod_1.z.string(),
+        details: zod_1.z
+            .array(zod_1.z.object({
+            location: zod_1.z.string(),
+            path: zod_1.z.string(),
+            message: zod_1.z.string(),
+        }))
+            .optional(),
+        requestId: zod_1.z.string(),
+        timestamp: zod_1.z.iso.datetime(),
+        path: zod_1.z.string(),
+    }),
+});
+const dataResponseSchema = (data) => zod_1.z.object({ data });
+exports.dataResponseSchema = dataResponseSchema;
+const paginatedResponseSchema = (item) => zod_1.z.object({ data: zod_1.z.array(item), meta: pagination_schema_js_1.paginationMetaSchema });
+exports.paginatedResponseSchema = paginatedResponseSchema;

package/dist/cjs/common/contact.schema.d.ts

@@ -0,0 +1,5 @@
+import { z } from 'zod';
+/** Trimmed and lower-cased, so that one address cannot map to two accounts. */
+export declare const emailSchema: z.ZodPipe<z.ZodString, z.ZodEmail>;
+/** Normalized to E.164 by dropping common formatting characters. */
+export declare const phoneSchema: z.ZodString;

package/dist/cjs/common/contact.schema.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.phoneSchema = exports.emailSchema = void 0;
+const zod_1 = require("zod");
+// RFC 5321 limits a usable address to 254 characters.
+const MAX_EMAIL_LENGTH = 254;
+/** Trimmed and lower-cased, so that one address cannot map to two accounts. */
+exports.emailSchema = zod_1.z
+    .string()
+    .trim()
+    .toLowerCase()
+    .max(MAX_EMAIL_LENGTH)
+    .pipe(zod_1.z.email());
+/** Normalized to E.164 by dropping common formatting characters. */
+exports.phoneSchema = zod_1.z
+    .string()
+    .overwrite((value) => value.replace(/[\s().-]/g, ''))
+    .regex(/^\+[1-9]\d{7,14}$/, {
+    error: 'Must be an international number such as +919876543210',
+});

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

@@ -0,0 +1,4 @@
+export * from './api-response.schema.js';
+export * from './contact.schema.js';
+export * from './pagination.schema.js';
+export * from './safe-text.schema.js';

package/dist/cjs/common/index.js

@@ -0,0 +1,20 @@
+"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("./api-response.schema.js"), exports);
+__exportStar(require("./contact.schema.js"), exports);
+__exportStar(require("./pagination.schema.js"), exports);
+__exportStar(require("./safe-text.schema.js"), exports);

package/dist/cjs/common/pagination.schema.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const MAX_PAGE_SIZE = 100;
+export declare const paginationQuerySchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    pageSize: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+}, z.core.$strip>;
+export type PaginationQuery = z.output<typeof paginationQuerySchema>;
+export declare const paginationMetaSchema: z.ZodObject<{
+    page: z.ZodNumber;
+    pageSize: z.ZodNumber;
+    totalItems: z.ZodNumber;
+    totalPages: z.ZodNumber;
+}, z.core.$strip>;
+export type PaginationMeta = z.output<typeof paginationMetaSchema>;

package/dist/cjs/common/pagination.schema.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginationMetaSchema = exports.paginationQuerySchema = exports.MAX_PAGE_SIZE = void 0;
+const zod_1 = require("zod");
+exports.MAX_PAGE_SIZE = 100;
+exports.paginationQuerySchema = zod_1.z.object({
+    page: zod_1.z.coerce.number().int().min(1).default(1),
+    pageSize: zod_1.z.coerce.number().int().min(1).max(exports.MAX_PAGE_SIZE).default(20),
+});
+exports.paginationMetaSchema = zod_1.z.object({
+    page: zod_1.z.number().int(),
+    pageSize: zod_1.z.number().int(),
+    totalItems: zod_1.z.number().int(),
+    totalPages: zod_1.z.number().int(),
+});

package/dist/cjs/common/safe-text.schema.d.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+/**
+ * Short plain-text input such as a device name. Output encoding remains the
+ * renderer's job; rejecting markup here keeps stored values harmless even if a
+ * future client forgets. Use a real sanitizer for fields meant to hold HTML.
+ */
+export declare const safeTextSchema: (maxLength: number) => z.ZodString;

package/dist/cjs/common/safe-text.schema.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeTextSchema = void 0;
+const zod_1 = require("zod");
+// eslint-disable-next-line no-control-regex
+const CONTROL_CHARACTERS = /[\u0000-\u001f\u007f]/g;
+const HTML_LIKE = /<[a-zA-Z!/?]/;
+/**
+ * Short plain-text input such as a device name. Output encoding remains the
+ * renderer's job; rejecting markup here keeps stored values harmless even if a
+ * future client forgets. Use a real sanitizer for fields meant to hold HTML.
+ */
+const safeTextSchema = (maxLength) => zod_1.z
+    .string()
+    .overwrite((value) => value.replace(CONTROL_CHARACTERS, '').trim())
+    .min(1)
+    .max(maxLength)
+    .refine((value) => !HTML_LIKE.test(value), {
+    error: 'Must not contain markup',
+});
+exports.safeTextSchema = safeTextSchema;

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

@@ -0,0 +1,12 @@
+export declare const APP_ENVIRONMENTS: readonly ["development", "staging", "production"];
+export type AppEnvironment = (typeof APP_ENVIRONMENTS)[number];
+export declare const ROLES: readonly ["admin", "trainer", "customer"];
+export type Role = (typeof ROLES)[number];
+export declare const ACCOUNT_STATUSES: readonly ["active", "disabled"];
+export type AccountStatus = (typeof ACCOUNT_STATUSES)[number];
+export declare const TOKEN_TRANSPORTS: readonly ["body", "cookie"];
+export type TokenTransport = (typeof TOKEN_TRANSPORTS)[number];
+export declare const AUDIT_OUTCOMES: readonly ["success", "failure"];
+export type AuditOutcome = (typeof AUDIT_OUTCOMES)[number];
+export declare const FEATURE_FLAG_RULE_TYPES: readonly ["user", "customer", "trainer", "role"];
+export type FeatureFlagRuleType = (typeof FEATURE_FLAG_RULE_TYPES)[number];

package/dist/cjs/enums/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// 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.FEATURE_FLAG_RULE_TYPES = exports.AUDIT_OUTCOMES = exports.TOKEN_TRANSPORTS = exports.ACCOUNT_STATUSES = exports.ROLES = exports.APP_ENVIRONMENTS = void 0;
+exports.APP_ENVIRONMENTS = [
+    'development',
+    'staging',
+    'production',
+];
+exports.ROLES = ['admin', 'trainer', 'customer'];
+exports.ACCOUNT_STATUSES = ['active', 'disabled'];
+exports.TOKEN_TRANSPORTS = ['body', 'cookie'];
+exports.AUDIT_OUTCOMES = ['success', 'failure'];
+exports.FEATURE_FLAG_RULE_TYPES = [
+    'user',
+    'customer',
+    'trainer',
+    'role',
+];