evo360-types 1.3.409 → 1.3.413

package/dist/apps/evo-campaigns/zod-schemas.ts

@@ -0,0 +1,389 @@
+import { z } from "zod";
+import { zFireDocSchema } from "../shared/zod-schemas";
+
+// ======================================================
+// evo-campaigns (feat-081 — Hub Omni Campaigns) — zod schemas
+//
+// Doc schemas mirror the hand-written interfaces in
+// types/evo-campaigns/index.ts. Request schemas validate the admin HTTP surface
+// (evo_campaigns_admin). passthrough() everywhere additive fields may appear.
+// ======================================================
+
+// ----- Enums ----------------------------------------------------------------
+export const zCampaignStatusSchema = z.enum([
+  "draft",
+  "scheduled",
+  "running",
+  "paused",
+  "finished",
+  "canceled",
+  "finished_error",
+]);
+export type ICampaignStatus = z.infer<typeof zCampaignStatusSchema>;
+
+export const zCampaignTypeSchema = z.enum([
+  "conversion",
+  "informative",
+  "relationship",
+  "operational",
+  "promotional",
+]);
+
+export const zCampaignChannelSchema = z.enum(["whatsapp", "email"]);
+
+export const zCampaignVariableSourceSchema = z.enum([
+  "placeholder",
+  "fixed",
+  "csv_column",
+  "qr_link",
+]);
+
+export const zRecipientDispatchStateSchema = z.enum([
+  "pending",
+  "dispatched",
+  "done",
+  "excluded",
+]);
+
+export const zRecipientChannelStatusSchema = z.enum([
+  "pending",
+  "scheduled",
+  "sent",
+  "delivered",
+  "read",
+  "failed",
+  "clicked",
+  "replied",
+]);
+
+export const zRecipientInteractionStatusSchema = z.enum([
+  "pendente",
+  "inelegivel",
+  "agendado",
+  "enviado",
+  "entregue",
+  "lido",
+  "clicou",
+  "respondeu",
+  "convertido",
+  "falhou",
+  "optout",
+  "cancelado",
+]);
+
+// ----- Shared value objects -------------------------------------------------
+export const zCampaignCodeNameSchema = z
+  .object({
+    code: z.string(),
+    name: z.string(),
+  })
+  .passthrough();
+
+export const zCampaignVariableMappingSchema = z
+  .object({
+    variable: z.string(),
+    source: zCampaignVariableSourceSchema,
+    token: z.string().optional(),
+    value: z.string().optional(),
+    column: z.string().optional(),
+    cta_id: z.string().optional(),
+  })
+  .passthrough();
+
+export const zCampaignCtaSchema = z
+  .object({
+    cta_id: z.string(),
+    label: z.string(),
+    button_index: z.number().optional(),
+    target_url: z.string().optional(),
+  })
+  .passthrough();
+
+export const zCampaignPacingSchema = z
+  .object({
+    batch_size: z.number(),
+    batch_interval_minutes: z.number(),
+    daily_limit: z.number(),
+    allowed_window: z
+      .object({
+        start: z.string(),
+        end: z.string(),
+      })
+      .passthrough(),
+  })
+  .passthrough();
+
+export const zCampaignTicketPolicySchema = z
+  .object({
+    mode: z.enum(["close", "keep_open"]),
+    close_status: zCampaignCodeNameSchema.optional(),
+    note: z.string().optional(),
+  })
+  .passthrough();
+
+export const zCampaignMediaSchema = z
+  .object({
+    type: z.string(),
+    gcs_path: z.string().optional(),
+    url: z.string().optional(),
+  })
+  .passthrough();
+
+export const zCampaignChannelConfigSchema = z
+  .object({
+    channel_id: z.string(),
+    template_id: z.string(),
+    template_language: z.string().optional(),
+    template_category: z.string().optional(),
+    variable_mappings: z.array(zCampaignVariableMappingSchema),
+    media: zCampaignMediaSchema.optional(),
+    ctas: z.array(zCampaignCtaSchema),
+    department_id: z.string().optional(),
+    ticket_policy: zCampaignTicketPolicySchema,
+    pacing: zCampaignPacingSchema,
+    subject_override: z.string().optional(),
+    preheader: z.string().optional(),
+  })
+  .passthrough();
+
+export const zCampaignAttributionSchema = z
+  .object({
+    window_days: z.number(),
+    conversion_event: z.string(),
+    appointment_status_base_in: z.array(z.string()),
+    requires: z.enum(["delivery", "click", "reply"]),
+  })
+  .passthrough();
+
+export const zCampaignNewLeadConfigSchema = z
+  .object({
+    dist_channel: zCampaignCodeNameSchema,
+    qualification: z
+      .object({
+        code: z.string(),
+        name: z.string(),
+        funnelLevel: z.union([z.string(), z.number()]),
+      })
+      .passthrough()
+      .nullable()
+      .optional(),
+    tags: z.array(z.string()).optional(),
+  })
+  .passthrough();
+
+export const zCampaignFrequencySchema = z
+  .object({
+    min_days: z.number(),
+    override: z.boolean(),
+  })
+  .passthrough();
+
+export const zCampaignScheduleSchema = z
+  .object({
+    mode: z.enum(["immediate", "scheduled"]),
+    scheduled_at: z.coerce.date().nullable().optional(),
+  })
+  .passthrough();
+
+// ----- Campaign doc ---------------------------------------------------------
+export const zCampaignSchema = zFireDocSchema
+  .extend({
+    name: z.string(),
+    description: z.string().nullable().optional(),
+    purpose: zCampaignCodeNameSchema,
+    objective: zCampaignCodeNameSchema,
+    campaign_type: zCampaignTypeSchema,
+    tags: z.array(z.string()).optional(),
+    status: zCampaignStatusSchema,
+    attribution_open: z.boolean(),
+    attribution_deadline: z.coerce.date().nullable().optional(),
+    attribution: zCampaignAttributionSchema,
+    channels: z
+      .object({
+        whatsapp: zCampaignChannelConfigSchema.optional(),
+        email: zCampaignChannelConfigSchema.optional(),
+      })
+      .passthrough(),
+    new_lead_config: zCampaignNewLeadConfigSchema.optional(),
+    frequency: zCampaignFrequencySchema,
+    schedule: zCampaignScheduleSchema,
+    dispatch_state: z.record(z.unknown()).optional(),
+    prevalidation: z.record(z.unknown()).optional(),
+    cost_estimate: z.record(z.unknown()).optional(),
+    counters: z.record(z.unknown()).optional(),
+  })
+  .passthrough();
+
+// ----- Bucket doc -----------------------------------------------------------
+export const zCampaignBucketSourceTypeSchema = z.enum([
+  "leads",
+  "patients",
+  "appointments",
+  "csv",
+]);
+
+export const zCampaignBucketSchema = zFireDocSchema
+  .extend({
+    source_type: zCampaignBucketSourceTypeSchema,
+    label: z.string(),
+    filters: z.record(z.unknown()).optional(),
+    csv_file: z.record(z.unknown()).optional(),
+    counts: z.record(z.unknown()).optional(),
+  })
+  .passthrough();
+
+// ----- Recipient doc --------------------------------------------------------
+export const zCampaignRecipientSchema = zFireDocSchema
+  .extend({
+    lead_id: z.string().optional(),
+    patient_id: z.string().optional(),
+    is_new_lead: z.boolean(),
+    contact: z
+      .object({
+        display_name: z.string().optional(),
+        mobile: z.string().optional(),
+        email: z.string().optional(),
+        external_id: z.string().optional(),
+      })
+      .passthrough(),
+    bucket_ids: z.array(z.string()),
+    primary_bucket_id: z.string(),
+    csv_variables: z.record(z.string()).optional(),
+    dispatch_state: zRecipientDispatchStateSchema,
+    eligibility: z.record(z.unknown()),
+    channels: z.record(z.unknown()),
+    interaction_status: zRecipientInteractionStatusSchema,
+    converted_at: z.coerce.date().nullable().optional(),
+    conversion_id: z.string().nullable().optional(),
+  })
+  .passthrough();
+
+// ----- Conversion doc -------------------------------------------------------
+export const zCampaignConversionSchema = zFireDocSchema
+  .extend({
+    lead_id: z.string(),
+    recipient_id: z.string(),
+    conversion_event: z.string(),
+    source_entity_type: z.enum(["appointment", "qr_action", "ticket", "message"]),
+    source_entity_id: z.string(),
+    channel: zCampaignChannelSchema.optional(),
+    cta_id: z.string().optional(),
+    attributed_at: z.coerce.date(),
+    attribution_model: z.literal("last_campaign_in_window"),
+    window_days: z.number(),
+    metadata: z.record(z.unknown()).optional(),
+  })
+  .passthrough();
+
+// ----- Lead campaign-history entry ------------------------------------------
+export const zLeadCampaignHistoryEntrySchema = zFireDocSchema
+  .extend({
+    campaign_id: z.string(),
+    campaign_name: z.string(),
+    classification_level: z.string(),
+    channels_sent: z.array(zCampaignChannelSchema),
+    template_ids: z.record(z.string()).optional(),
+    bucket_ids: z.array(z.string()).optional(),
+    first_sent_at: z.coerce.date().nullable().optional(),
+    last_sent_at: z.coerce.date().nullable().optional(),
+    delivered_at: z.coerce.date().nullable().optional(),
+    read_at: z.coerce.date().nullable().optional(),
+    clicked_at: z.coerce.date().nullable().optional(),
+    replied_at: z.coerce.date().nullable().optional(),
+    converted_at: z.coerce.date().nullable().optional(),
+    interaction_status: zRecipientInteractionStatusSchema,
+  })
+  .passthrough();
+
+// ----- Tariff dic item ------------------------------------------------------
+export const zTariffItemSchema = z
+  .object({
+    code: z.string(),
+    name: z.string(),
+    description: z.string().optional(),
+    context: z.string(),
+    channel: z.string().optional(),
+    provider: z.string().optional(),
+    country: z.string().optional(),
+    category: z.string().optional(),
+    currency: z.string(),
+    calc_type: z.enum(["fixed", "percentage"]),
+    value: z.number(),
+    percent_base: z.string().optional(),
+    valid_from: z.coerce.date(),
+    valid_to: z.coerce.date().nullable().optional(),
+    active: z.boolean(),
+    metadata: z.record(z.unknown()).optional(),
+  })
+  .passthrough();
+
+// ======================================================
+// Request schemas (admin HTTP surface)
+// ======================================================
+
+/** POST /campaigns, PATCH /campaigns/:id — draft create/edit. */
+export const zCampaignUpsert = z
+  .object({
+    name: z.string().min(1),
+    description: z.string().nullable().optional(),
+    purpose: zCampaignCodeNameSchema,
+    objective: zCampaignCodeNameSchema,
+    campaign_type: zCampaignTypeSchema,
+    tags: z.array(z.string()).optional(),
+    attribution: zCampaignAttributionSchema.partial().optional(),
+    channels: z
+      .object({
+        whatsapp: zCampaignChannelConfigSchema.optional(),
+        email: zCampaignChannelConfigSchema.optional(),
+      })
+      .passthrough()
+      .optional(),
+    new_lead_config: zCampaignNewLeadConfigSchema.optional(),
+    frequency: zCampaignFrequencySchema.partial().optional(),
+    schedule: zCampaignScheduleSchema.optional(),
+  })
+  .passthrough();
+export type ICampaignUpsert = z.infer<typeof zCampaignUpsert>;
+
+/** POST /campaigns/:id/buckets — create a bucket with filters. */
+export const zBucketCreate = z
+  .object({
+    source_type: zCampaignBucketSourceTypeSchema,
+    label: z.string().min(1),
+    filters: z.record(z.unknown()).optional(),
+  })
+  .passthrough();
+export type IBucketCreate = z.infer<typeof zBucketCreate>;
+
+/** POST /campaigns/:id/buckets/csv — upload metadata (file itself is base64 in body). */
+export const zCsvUploadMeta = z
+  .object({
+    label: z.string().min(1),
+    filename: z.string().min(1),
+    file_base64: z.string(),
+    /** CSV column -> semantic field mapping (name/mobile/email/variables). */
+    mapping: z.record(z.string()),
+  })
+  .passthrough();
+export type ICsvUploadMeta = z.infer<typeof zCsvUploadMeta>;
+
+/** Prevalidation snapshot returned by GET /campaigns/:id/prevalidation. */
+export const zPrevalidationResult = z
+  .object({
+    status: z.enum(["approved", "warnings", "blocked"]),
+    errors: z.array(z.string()),
+    warnings: z.array(z.string()),
+    ran_at: z.coerce.date().optional(),
+  })
+  .passthrough();
+export type IPrevalidationResult = z.infer<typeof zPrevalidationResult>;
+
+/** POST /campaigns/:id/{schedule|start|pause|resume|cancel}. */
+export const zCampaignAction = z
+  .object({
+    action: z.enum(["schedule", "start", "pause", "resume", "cancel"]),
+    scheduled_at: z.coerce.date().nullable().optional(),
+    reason: z.string().optional(),
+  })
+  .passthrough();
+export type ICampaignAction = z.infer<typeof zCampaignAction>;