Files
FlockPal/backend/src/schemas.ts
T
blaisadmin 8205fee420
Deploy / deploy-dev (push) Skipped
Deploy / deploy-prod (push) Successful in 3m4s
Merge branch 'dev'
2026-10-07 19:40:24 -04:00

210 lines
8.4 KiB
TypeScript

import { z } from 'zod';
// Shared runtime validation and API documentation schemas.
export const dateStringSchema = z.string().regex(/^\d{4}-\d{2}-\d{2}$/);
export const chartColorSchema = z.string().regex(/^#[0-9a-fA-F]{6}$/);
export const photoDataUrlSchema = z
.string()
.regex(/^data:image\/(?:png|jpeg|jpg|webp|gif);base64,[A-Za-z0-9+/=]+$/)
.max(1_500_000);
export const photoUrlSchema = z.string().trim().url().max(2000);
export const magicLinkRequestSchema = z.object({
name: z.string().trim().max(160).optional().or(z.literal('')),
email: z.string().trim().email().max(255),
redirectTo: z.string().trim().url().max(2000).optional().or(z.literal('')),
});
export const switchWorkspaceSchema = z.object({
workspaceId: z.coerce.number().int().positive(),
});
export const workspaceTypeSchema = z.enum(['standard', 'rescue']);
export const workspaceRoleSchema = z.enum(['owner', 'assistant', 'caregiver', 'viewer']);
export const billingPlanSchema = z.enum(['household_basic', 'household_plus', 'household_macaw', 'household_hyacinth_macaw']);
export const billingIntervalSchema = z.enum(['monthly', 'yearly']);
export const integrationTokenScopeSchema = z.enum(['read_only', 'read_write']);
export const birdGenderSchema = z.enum(['unknown', 'male', 'female', 'male_dna', 'female_dna']);
export const rescueVerificationStatusSchema = z.enum(['pending', 'approved', 'rejected']);
export const rescueOnboardingSchema = z.object({
name: z.string().trim().max(160).optional().or(z.literal('')),
city: z.string().trim().max(120).optional().or(z.literal('')),
state: z.string().trim().max(80).optional().or(z.literal('')),
ein: z.string().trim().max(32).optional().or(z.literal('')),
website: z.string().trim().url().max(2000).optional().or(z.literal('')),
});
export const workspaceSchema = z.object({
name: z.string().trim().min(1).max(160),
workspaceType: workspaceTypeSchema,
billingEmail: z.string().trim().email().max(255).optional().or(z.literal('')),
billingPlan: billingPlanSchema.optional(),
billingInterval: billingIntervalSchema.optional(),
rescueOnboarding: rescueOnboardingSchema.optional(),
});
export const createWorkspaceSchema = z.object({
name: z.string().trim().min(1).max(160),
workspaceType: workspaceTypeSchema,
billingEmail: z.string().trim().email().max(255).optional().or(z.literal('')),
billingPlan: billingPlanSchema.optional(),
billingInterval: billingIntervalSchema.optional(),
rescueOnboarding: rescueOnboardingSchema.optional(),
});
export const workspaceMemberSchema = z.object({
name: z.string().trim().min(1).max(160),
email: z.string().trim().email().max(255),
role: workspaceRoleSchema,
});
export const flockTransferSchema = z.object({
destinationOwnerEmail: z.string().trim().email().max(255),
});
export const lostBirdReportSchema = z.object({
tagId: z.string().trim().min(1).max(80),
finderName: z.string().trim().max(160).optional().or(z.literal('')),
finderEmail: z.string().trim().email().max(255).optional().or(z.literal('')),
foundLocation: z.string().trim().max(255).optional().or(z.literal('')),
message: z.string().trim().max(1000).optional().or(z.literal('')),
});
export const publicProfileCodeSchema = z.string().trim().regex(/^[A-Za-z0-9_-]{8,32}$/);
export const birdTransferCodeSchema = z.string().trim().regex(/^[A-Za-z0-9_-]{12,32}$/);
export const birdProfileListSchema = z
.string()
.trim()
.max(1000)
.refine(
(value) => value.split(/\r?\n/).map((item) => item.trim()).filter(Boolean).length <= 3,
'Use no more than three list items.',
)
.optional()
.or(z.literal(''));
export const verifiedLocationDetailsSchema = z
.object({
label: z.string().trim().max(220).optional().or(z.literal('')),
city: z.string().trim().max(120).optional().or(z.literal('')),
region: z.string().trim().max(120).optional().or(z.literal('')),
country: z.string().trim().max(120).optional().or(z.literal('')),
countryCode: z.string().trim().max(2).optional().or(z.literal('')),
latitude: z.coerce.number().min(-90).max(90).optional().nullable().or(z.literal('')),
longitude: z.coerce.number().min(-180).max(180).optional().nullable().or(z.literal('')),
precision: z.enum(['city', 'region', 'country']).optional(),
provider: z.literal('mapbox').optional().nullable(),
providerPlaceId: z.string().trim().max(220).optional().or(z.literal('')),
})
.optional()
.nullable();
export const locationSearchSchema = z.object({
q: z.string().trim().min(3).max(120),
});
export const birdSchema = z.object({
name: z.string().trim().min(1).max(120),
tagId: z.string().trim().max(80).optional().or(z.literal('')),
species: z.string().trim().min(1).max(120),
motivators: birdProfileListSchema,
demotivators: birdProfileListSchema,
favoriteSnack: z.string().trim().max(160).optional().or(z.literal('')),
locationLabel: z.string().trim().max(160).optional().or(z.literal('')),
locationDetails: verifiedLocationDetailsSchema,
vetClinicName: z.string().trim().max(160).optional().or(z.literal('')),
vetClinicAddress: z.string().trim().max(500).optional().or(z.literal('')),
vetAccountNumber: z.string().trim().max(120).optional().or(z.literal('')),
vetDoctorName: z.string().trim().max(160).optional().or(z.literal('')),
gender: birdGenderSchema.optional(),
hatchDay: dateStringSchema.optional().or(z.literal('')),
dateOfBirth: dateStringSchema.optional().or(z.literal('')),
gotchaDay: dateStringSchema.optional().or(z.literal('')),
chartColor: chartColorSchema.optional(),
photoDataUrl: z.union([photoDataUrlSchema, photoUrlSchema, z.literal('')]).optional(),
notifyOnDob: z.boolean().optional(),
notifyOnGotchaDay: z.boolean().optional(),
publicProfileEnabled: z.boolean().optional(),
});
export const memorializeBirdSchema = z.object({
memorializedOn: dateStringSchema,
notifyOnMemorialDay: z.boolean().optional(),
});
export const memorialReminderPreferenceSchema = z.object({
notifyOnMemorialDay: z.boolean(),
});
export const birdTimelineEventSchema = z
.object({
eventType: z.enum(['location_updated', 'owner_changed', 'manual_note']),
eventDate: dateStringSchema.optional().or(z.literal('')),
locationLabel: z.string().trim().max(160).optional().or(z.literal('')),
locationDetails: verifiedLocationDetailsSchema,
note: z.string().trim().max(500).optional().or(z.literal('')),
})
.refine(
(value) =>
value.eventType === 'owner_changed' ||
Boolean(
value.locationLabel?.trim() ||
value.note?.trim() ||
value.locationDetails?.city?.trim() ||
value.locationDetails?.region?.trim() ||
value.locationDetails?.country?.trim(),
),
'Add a location or note for this timeline item.',
);
export const weightSchema = z.object({
weightGrams: z.coerce.number().positive().max(10000),
recordedOn: dateStringSchema,
notes: z.string().trim().max(280).optional().or(z.literal('')),
});
export const vetVisitSchema = z.object({
visitedOn: dateStringSchema,
clinicName: z.string().trim().min(1).max(160),
reason: z.string().trim().min(1).max(160),
notes: z.string().trim().max(1000).optional().or(z.literal('')),
});
export const medicationSchema = z
.object({
name: z.string().trim().min(1).max(160),
dosage: z.string().trim().min(1).max(160),
frequency: z.enum(['once_daily', 'twice_daily', 'every_8_hours', 'every_6_hours', 'as_needed']),
doseSchedule: z
.array(
z.object({
key: z.string().trim().min(1).max(80),
label: z.string().trim().min(1).max(80),
time: z.string().trim().regex(/^$|^\d{2}:\d{2}$/),
}),
)
.min(1)
.max(8),
route: z.string().trim().max(80).optional().or(z.literal('')),
startDate: dateStringSchema,
endDate: dateStringSchema.optional().or(z.literal('')),
notes: z.string().trim().max(1000).optional().or(z.literal('')),
remindersEnabled: z.boolean().optional(),
})
.refine((value) => !value.endDate || value.endDate >= value.startDate, {
message: 'End date must be on or after start date.',
path: ['endDate'],
});
export const medicationAdministrationSchema = z.object({
administeredOn: dateStringSchema,
administrationSlot: z.string().trim().min(1).max(80).default('dose-1'),
status: z.enum(['administered', 'missed']),
notes: z.string().trim().max(500).optional().or(z.literal('')),
});
export const flockNoteSchema = z.object({
birdId: z.string().uuid().optional().nullable().or(z.literal('')),
body: z.string().trim().min(1).max(5000),
});