@tbs-fitness/contract 0.3.0 → 0.4.0

package/dist/esm/communication/template.dto.d.ts

@@ -0,0 +1,240 @@
+import { z } from 'zod';
+import { type CommunicationChannel, type MessageType } from '../enums/index.js';
+/** The variable names used as `{{name}}` in a piece of template text, in order, without repeats. */
+export declare function templatePlaceholders(text: string): string[];
+/** True when the text has a `{{` or `}}` that is not part of a valid placeholder. */
+export declare function hasMalformedPlaceholder(text: string): boolean;
+/** A variable a template declares. Its value is supplied when the message is sent. */
+export declare const templateVariableSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    example: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type TemplateVariable = z.output<typeof templateVariableSchema>;
+interface TemplateShape {
+    messageType: MessageType;
+    channel: CommunicationChannel;
+    subject?: string | null | undefined;
+    bodyText: string;
+    bodyHtml?: string | null | undefined;
+    variables: {
+        name: string;
+    }[];
+}
+/**
+ * The rules every template must meet before it is saved: the declared
+ * variables match the placeholders exactly, every one is supplied by the
+ * message type, and the type's required variables are used. Shared by the
+ * server and the admin editor, so both report the same problems.
+ */
+export declare function templateProblems(template: TemplateShape): {
+    path: string;
+    message: string;
+}[];
+/** A new draft. Saved templates are never edited; a change is a new version. */
+export declare const createTemplateSchema: z.ZodObject<{
+    messageType: z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>;
+    channel: z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>;
+    name: z.ZodPipe<z.ZodString, z.ZodString>;
+    subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bodyText: z.ZodString;
+    bodyHtml: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    variables: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        example: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type CreateTemplateInput = z.input<typeof createTemplateSchema>;
+export type CreateTemplateBody = z.output<typeof createTemplateSchema>;
+export declare const templateListQuerySchema: z.ZodObject<{
+    messageType: z.ZodOptional<z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>>;
+    channel: z.ZodOptional<z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>>;
+}, z.core.$strict>;
+export type TemplateListQuery = z.output<typeof templateListQuerySchema>;
+export declare const templateResponseSchema: z.ZodObject<{
+    id: z.ZodUUID;
+    messageType: z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>;
+    channel: z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>;
+    version: z.ZodNumber;
+    name: z.ZodString;
+    subject: z.ZodNullable<z.ZodString>;
+    bodyText: z.ZodString;
+    bodyHtml: z.ZodNullable<z.ZodString>;
+    variables: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        example: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    status: z.ZodEnum<{
+        active: "active";
+        draft: "draft";
+        archived: "archived";
+    }>;
+    createdBy: z.ZodNullable<z.ZodUUID>;
+    createdAt: z.ZodISODateTime;
+    activatedBy: z.ZodNullable<z.ZodUUID>;
+    activatedAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>;
+export type TemplateResponse = z.output<typeof templateResponseSchema>;
+export declare const templateListResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodUUID;
+    messageType: z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>;
+    channel: z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>;
+    version: z.ZodNumber;
+    name: z.ZodString;
+    subject: z.ZodNullable<z.ZodString>;
+    bodyText: z.ZodString;
+    bodyHtml: z.ZodNullable<z.ZodString>;
+    variables: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        example: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    status: z.ZodEnum<{
+        active: "active";
+        draft: "draft";
+        archived: "archived";
+    }>;
+    createdBy: z.ZodNullable<z.ZodUUID>;
+    createdAt: z.ZodISODateTime;
+    activatedBy: z.ZodNullable<z.ZodUUID>;
+    activatedAt: z.ZodNullable<z.ZodISODateTime>;
+}, z.core.$strip>>;
+/** Renders unsaved text, or a saved version, with the catalogue's sample values. */
+export declare const previewTemplateSchema: z.ZodUnion<readonly [z.ZodObject<{
+    templateId: z.ZodUUID;
+}, z.core.$strict>, z.ZodObject<{
+    messageType: z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>;
+    channel: z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>;
+    name: z.ZodPipe<z.ZodString, z.ZodString>;
+    subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    bodyText: z.ZodString;
+    bodyHtml: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    variables: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        example: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+}, z.core.$strict>]>;
+export type PreviewTemplateInput = z.input<typeof previewTemplateSchema>;
+export type PreviewTemplateBody = z.output<typeof previewTemplateSchema>;
+export declare const renderedMessageSchema: z.ZodObject<{
+    channel: z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>;
+    subject: z.ZodNullable<z.ZodString>;
+    bodyText: z.ZodString;
+    bodyHtml: z.ZodNullable<z.ZodString>;
+    smsSegments: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+export type RenderedMessage = z.output<typeof renderedMessageSchema>;
+export declare const testSendResponseSchema: z.ZodObject<{
+    channel: z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>;
+    sentTo: z.ZodString;
+}, z.core.$strip>;
+export type TestSendResponse = z.output<typeof testSendResponseSchema>;
+/** A catalogue entry, with the built-in default template for each channel. */
+export declare const messageTypeResponseSchema: z.ZodObject<{
+    type: z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>;
+    label: z.ZodString;
+    description: z.ZodString;
+    channels: z.ZodArray<z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>>;
+    variables: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        example: z.ZodString;
+    }, z.core.$strip>>;
+    requiredVariables: z.ZodArray<z.ZodString>;
+    defaults: z.ZodArray<z.ZodObject<{
+        channel: z.ZodEnum<{
+            EMAIL: "EMAIL";
+            SMS: "SMS";
+        }>;
+        subject: z.ZodNullable<z.ZodString>;
+        bodyText: z.ZodString;
+        bodyHtml: z.ZodNullable<z.ZodString>;
+        variables: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type MessageTypeResponse = z.output<typeof messageTypeResponseSchema>;
+export declare const messageTypeListResponseSchema: z.ZodArray<z.ZodObject<{
+    type: z.ZodEnum<{
+        "auth.otp.signup_verification": "auth.otp.signup_verification";
+        "auth.otp.password_reset": "auth.otp.password_reset";
+        "auth.password_reset_link": "auth.password_reset_link";
+    }>;
+    label: z.ZodString;
+    description: z.ZodString;
+    channels: z.ZodArray<z.ZodEnum<{
+        EMAIL: "EMAIL";
+        SMS: "SMS";
+    }>>;
+    variables: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        description: z.ZodString;
+        example: z.ZodString;
+    }, z.core.$strip>>;
+    requiredVariables: z.ZodArray<z.ZodString>;
+    defaults: z.ZodArray<z.ZodObject<{
+        channel: z.ZodEnum<{
+            EMAIL: "EMAIL";
+            SMS: "SMS";
+        }>;
+        subject: z.ZodNullable<z.ZodString>;
+        bodyText: z.ZodString;
+        bodyHtml: z.ZodNullable<z.ZodString>;
+        variables: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>>;
+export {};

package/dist/esm/communication/template.dto.js

@@ -0,0 +1,200 @@
+import { z } from 'zod';
+import { utcTimestampSchema } from '../common/date-time.schema.js';
+import { safeTextSchema } from '../common/safe-text.schema.js';
+import { COMMUNICATION_CHANNELS, MESSAGE_TYPES, TEMPLATE_STATUSES, } from '../enums/index.js';
+import { MAX_SMS_LENGTH, MESSAGE_CATALOGUE } from './message-catalogue.js';
+const PLACEHOLDER = /\{\{\s*([A-Za-z][A-Za-z0-9_]*)\s*\}\}/g;
+/** The variable names used as `{{name}}` in a piece of template text, in order, without repeats. */
+export function templatePlaceholders(text) {
+    const names = new Set();
+    for (const match of text.matchAll(PLACEHOLDER)) {
+        names.add(match[1]);
+    }
+    return [...names];
+}
+/** True when the text has a `{{` or `}}` that is not part of a valid placeholder. */
+export function hasMalformedPlaceholder(text) {
+    const rest = text.replace(PLACEHOLDER, '');
+    return rest.includes('{{') || rest.includes('}}');
+}
+const MAX_SUBJECT_LENGTH = 200;
+const MAX_BODY_LENGTH = 20000;
+/** A variable a template declares. Its value is supplied when the message is sent. */
+export const templateVariableSchema = z.strictObject({
+    name: z
+        .string()
+        .regex(/^[A-Za-z][A-Za-z0-9_]*$/, {
+        error: 'Use letters, digits and underscores, starting with a letter',
+    })
+        .max(64),
+    description: safeTextSchema(200).optional(),
+    example: z.string().max(500).optional(),
+});
+const templateFields = {
+    messageType: z.enum(MESSAGE_TYPES),
+    channel: z.enum(COMMUNICATION_CHANNELS),
+    name: safeTextSchema(100).pipe(z.string().min(1, { error: 'Name it' })),
+    subject: z.string().max(MAX_SUBJECT_LENGTH).nullish(),
+    bodyText: z
+        .string()
+        .min(1, { error: 'Write the message' })
+        .max(MAX_BODY_LENGTH),
+    bodyHtml: z.string().max(MAX_BODY_LENGTH).nullish(),
+    variables: z.array(templateVariableSchema).max(20),
+};
+/**
+ * The rules every template must meet before it is saved: the declared
+ * variables match the placeholders exactly, every one is supplied by the
+ * message type, and the type's required variables are used. Shared by the
+ * server and the admin editor, so both report the same problems.
+ */
+export function templateProblems(template) {
+    const problems = [];
+    const definition = MESSAGE_CATALOGUE[template.messageType];
+    const isEmail = template.channel === 'EMAIL';
+    if (!definition.channels.includes(template.channel)) {
+        problems.push({
+            path: 'channel',
+            message: `${definition.label} cannot be sent by ${template.channel}`,
+        });
+    }
+    if (isEmail && !template.subject?.trim()) {
+        problems.push({ path: 'subject', message: 'An email needs a subject' });
+    }
+    if (!isEmail && (template.subject || template.bodyHtml)) {
+        problems.push({
+            path: 'bodyHtml',
+            message: 'Only email templates have a subject or HTML',
+        });
+    }
+    if (template.channel === 'SMS' && template.bodyText.length > MAX_SMS_LENGTH) {
+        problems.push({
+            path: 'bodyText',
+            message: `An SMS can be at most ${String(MAX_SMS_LENGTH)} characters`,
+        });
+    }
+    const texts = [
+        template.subject ?? '',
+        template.bodyText,
+        template.bodyHtml ?? '',
+    ];
+    if (texts.some(hasMalformedPlaceholder)) {
+        problems.push({
+            path: 'bodyText',
+            message: 'Write placeholders as {{name}}, with matching braces',
+        });
+    }
+    const used = new Set(texts.flatMap(templatePlaceholders));
+    const declared = template.variables.map((variable) => variable.name);
+    const declaredSet = new Set(declared);
+    if (declaredSet.size !== declared.length) {
+        problems.push({ path: 'variables', message: 'Declare each variable once' });
+    }
+    for (const name of used) {
+        if (!declaredSet.has(name)) {
+            problems.push({
+                path: 'variables',
+                message: `{{${name}}} is used but not declared`,
+            });
+        }
+    }
+    for (const name of declaredSet) {
+        if (!used.has(name)) {
+            problems.push({
+                path: 'variables',
+                message: `${name} is declared but not used`,
+            });
+        }
+        if (!(name in definition.variables)) {
+            problems.push({
+                path: 'variables',
+                message: `${definition.label} does not supply ${name}`,
+            });
+        }
+    }
+    for (const name of definition.requiredVariables) {
+        if (!declaredSet.has(name)) {
+            problems.push({
+                path: 'variables',
+                message: `${definition.label} must include {{${name}}}`,
+            });
+        }
+    }
+    return problems;
+}
+/** A new draft. Saved templates are never edited; a change is a new version. */
+export const createTemplateSchema = z
+    .strictObject(templateFields)
+    .superRefine((template, ctx) => {
+    for (const problem of templateProblems(template)) {
+        ctx.addIssue({
+            code: 'custom',
+            path: [problem.path],
+            message: problem.message,
+        });
+    }
+});
+export const templateListQuerySchema = z.strictObject({
+    messageType: z.enum(MESSAGE_TYPES).optional(),
+    channel: z.enum(COMMUNICATION_CHANNELS).optional(),
+});
+export const templateResponseSchema = z.object({
+    id: z.uuid(),
+    messageType: z.enum(MESSAGE_TYPES),
+    channel: z.enum(COMMUNICATION_CHANNELS),
+    version: z.number().int(),
+    name: z.string(),
+    subject: z.string().nullable(),
+    bodyText: z.string(),
+    bodyHtml: z.string().nullable(),
+    variables: z.array(z.object({
+        name: z.string(),
+        description: z.string().optional(),
+        example: z.string().optional(),
+    })),
+    status: z.enum(TEMPLATE_STATUSES),
+    createdBy: z.uuid().nullable(),
+    createdAt: utcTimestampSchema,
+    activatedBy: z.uuid().nullable(),
+    activatedAt: utcTimestampSchema.nullable(),
+});
+export const templateListResponseSchema = z.array(templateResponseSchema);
+/** Renders unsaved text, or a saved version, with the catalogue's sample values. */
+export const previewTemplateSchema = z.union([
+    z.strictObject({ templateId: z.uuid() }),
+    z.strictObject(templateFields),
+]);
+export const renderedMessageSchema = z.object({
+    channel: z.enum(COMMUNICATION_CHANNELS),
+    subject: z.string().nullable(),
+    bodyText: z.string(),
+    bodyHtml: z.string().nullable(),
+    /** SMS only: how many 160-character segments it takes. */
+    smsSegments: z.number().int().nullable(),
+});
+export const testSendResponseSchema = z.object({
+    channel: z.enum(COMMUNICATION_CHANNELS),
+    /** The signed-in admin's own address, masked, such as `b***@tbs.coach`. */
+    sentTo: z.string(),
+});
+/** A catalogue entry, with the built-in default template for each channel. */
+export const messageTypeResponseSchema = z.object({
+    type: z.enum(MESSAGE_TYPES),
+    label: z.string(),
+    description: z.string(),
+    channels: z.array(z.enum(COMMUNICATION_CHANNELS)),
+    variables: z.array(z.object({
+        name: z.string(),
+        description: z.string(),
+        example: z.string(),
+    })),
+    requiredVariables: z.array(z.string()),
+    defaults: z.array(z.object({
+        channel: z.enum(COMMUNICATION_CHANNELS),
+        subject: z.string().nullable(),
+        bodyText: z.string(),
+        bodyHtml: z.string().nullable(),
+        variables: z.array(z.object({ name: z.string() })),
+    })),
+});
+export const messageTypeListResponseSchema = z.array(messageTypeResponseSchema);

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

@@ -25,3 +25,22 @@ 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];
+/**
+ * The ways a message can reach someone. WhatsApp and push are added here when
+ * their channel modules are built.
+ */
+export declare const COMMUNICATION_CHANNELS: readonly ["EMAIL", "SMS"];
+export type CommunicationChannel = (typeof COMMUNICATION_CHANNELS)[number];
+/**
+ * Every message the platform sends. Each has a catalogue entry in
+ * `@tbs-fitness/contract/communication` saying which channels may carry it and
+ * which variables its sender supplies.
+ */
+export declare const MESSAGE_TYPES: readonly ["auth.otp.signup_verification", "auth.otp.password_reset", "auth.password_reset_link"];
+export type MessageType = (typeof MESSAGE_TYPES)[number];
+/** What happened to one message on one channel. */
+export declare const DELIVERY_STATUSES: readonly ["sent", "skipped_disabled", "skipped_unreachable", "failed", "failed_missing_variables"];
+export type DeliveryStatus = (typeof DELIVERY_STATUSES)[number];
+/** Only one version of a template per message type and channel is active. */
+export declare const TEMPLATE_STATUSES: readonly ["draft", "active", "archived"];
+export type TemplateStatus = (typeof TEMPLATE_STATUSES)[number];

package/dist/esm/enums/index.js

@@ -32,3 +32,28 @@ export const FEATURE_FLAG_RULE_TYPES = [
     'trainer',
     'role',
 ];
+/**
+ * The ways a message can reach someone. WhatsApp and push are added here when
+ * their channel modules are built.
+ */
+export const COMMUNICATION_CHANNELS = ['EMAIL', 'SMS'];
+/**
+ * Every message the platform sends. Each has a catalogue entry in
+ * `@tbs-fitness/contract/communication` saying which channels may carry it and
+ * which variables its sender supplies.
+ */
+export const MESSAGE_TYPES = [
+    'auth.otp.signup_verification',
+    'auth.otp.password_reset',
+    'auth.password_reset_link',
+];
+/** What happened to one message on one channel. */
+export const DELIVERY_STATUSES = [
+    'sent',
+    'skipped_disabled',
+    'skipped_unreachable',
+    'failed',
+    'failed_missing_variables',
+];
+/** Only one version of a template per message type and channel is active. */
+export const TEMPLATE_STATUSES = ['draft', 'active', 'archived'];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tbs-fitness/contract",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "TBS API contract: Zod schemas, DTO types and enums shared by the backend, web and mobile apps",
   "license": "UNLICENSED",
   "type": "module",
@@ -13,6 +13,16 @@
     "dist"
   ],
   "exports": {
+    "./app-settings": {
+      "import": {
+        "types": "./dist/esm/app-settings/index.d.ts",
+        "default": "./dist/esm/app-settings/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/app-settings/index.d.ts",
+        "default": "./dist/cjs/app-settings/index.js"
+      }
+    },
     "./audit": {
       "import": {
         "types": "./dist/esm/audit/index.d.ts",
@@ -53,6 +63,16 @@
         "default": "./dist/cjs/common/index.js"
       }
     },
+    "./communication": {
+      "import": {
+        "types": "./dist/esm/communication/index.d.ts",
+        "default": "./dist/esm/communication/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/communication/index.d.ts",
+        "default": "./dist/cjs/communication/index.js"
+      }
+    },
     "./enums": {
       "import": {
         "types": "./dist/esm/enums/index.d.ts",