@dev.smartpricing/message-composer-utils 4.2.14-stage-fix.2 → 4.3.0

package/src/schemas/dynamic-values.ts

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import { DynamicValuesResponse } from "../types/index.js";
+
+export const dynamicValuesQuerySchema = z.object({
+  product: z.string({ error: "product query parameter is required" }),
+  context: z.string().optional(),
+  language: z.string().default("en"),
+});
+
+export const dynamicValuesResponseSchema = z.record(
+  z.string(),
+  z.object({
+    description: z.string(),
+    fields: z.array(
+      z.object({
+        value: z.string(),
+        label: z.string(),
+        description: z.string(),
+        default: z.string().optional(),
+      }),
+    ),
+  }),
+) satisfies z.ZodType<DynamicValuesResponse>;

package/src/schemas/index.ts

@@ -0,0 +1,14 @@
+export * from "./common.js";
+export * from "./ai-integration.js";
+export * from "./brand.js";
+export * from "./dynamic-values.js";
+export * from "./language.js";
+export * from "./media.js";
+export * from "./organization.js";
+export * from "./property.js";
+export * from "./message.js";
+export * from "./message-group.js";
+export * from "./message-compilation.js";
+export * from "./meta-integration.js";
+export * from "./onboarding.js";
+export * from "./tracking.js";

package/src/schemas/language.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import { Language, WithDbTimestamps } from "../types/index.js";
+import { dbTimestampSchema } from "./common.js";
+
+/** Mirrors Language rows; id is a TEXT primary key (e.g. "en"), not a UUID. */
+export const languageResponseSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  flag: z.string(),
+  meta_language_code: z.string().nullable(),
+  created_at: dbTimestampSchema,
+  updated_at: dbTimestampSchema,
+}) satisfies z.ZodType<unknown, WithDbTimestamps<Language>>;
+
+export const languageListResponseSchema = z.array(languageResponseSchema);

package/src/schemas/media.ts

@@ -0,0 +1,37 @@
+import { z } from "zod";
+import { MediaFromDb } from "../types/index.js";
+import { dbTimestampSchema } from "./common.js";
+
+const DEFAULT_LIMIT = 50;
+const MAX_LIMIT = 200;
+
+export const listMediaQuerySchema = z.object({
+  userId: z.string().optional(),
+  organizationId: z.string().optional(),
+  smartnessEventId: z.uuid().optional(),
+  fileType: z.string().optional(),
+  limit: z.coerce.number().int().min(1).max(MAX_LIMIT).default(DEFAULT_LIMIT),
+  offset: z.coerce.number().int().min(0).default(0),
+});
+
+/**
+ * Mirrors MediaFromDb rows as returned today. Optional columns are also
+ * nullable: the shared type says `field?: string` but SELECT * returns
+ * explicit nulls (why response schemas carry no `satisfies` pin yet).
+ */
+export const mediaResponseSchema = z.object({
+  id: z.uuid(),
+  remote_url: z.string(),
+  remote_name: z.string(),
+  file_name: z.string(),
+  file_type: z.string(),
+  meta_handle_id: z.string().nullable().optional(),
+  smartchat_media_id: z.string().nullable().optional(),
+  smartness_event_id: z.string().nullable().optional(),
+  organization_id: z.string().nullable().optional(),
+  user_id: z.string(),
+  created_at: dbTimestampSchema,
+  updated_at: dbTimestampSchema,
+}) satisfies z.ZodType<unknown, MediaFromDb>;
+
+export const mediaListResponseSchema = z.array(mediaResponseSchema);

package/src/schemas/message-compilation.ts

@@ -0,0 +1,38 @@
+import { z } from "zod";
+import {
+  CompileMessageRequest,
+  CompileAndSendRequest,
+  previewMessageRequestSchema,
+} from "../types/index.js";
+
+export const messageLanguageQuerySchema = z.object({
+  language: z.string(),
+  fallbackLanguage: z.string().optional(),
+  strict_language: z.coerce.boolean().optional(),
+});
+
+export const compileMessageBodySchema = z.object({
+  language: z.string(),
+  fallbackLanguage: z.string().optional(),
+  parameters: z.record(z.string(), z.unknown()),
+  strict: z.boolean().optional(),
+  brand_id: z.string().optional(),
+  strict_language: z.boolean().optional(),
+}) satisfies z.ZodType<CompileMessageRequest>;
+
+export const compileAndSendBodySchema = compileMessageBodySchema.extend({
+  from: z.string().min(1, "Missing required parameters"),
+  to: z.string().min(1, "Missing required parameters"),
+  automationEngineMessageId: z.string().optional(),
+  additionalInfo: z.record(z.string(), z.unknown()).optional(),
+  provider: z.enum(["SendGrid", "AmazonSES"]).optional(),
+  kind: z.string().optional(),
+}) satisfies z.ZodType<CompileAndSendRequest>;
+
+export const testEmailBodySchema = z.object({
+  message: previewMessageRequestSchema.shape.message,
+  to: z.string().min(1, "Missing required parameters: message, to"),
+  brand_id: z.string().nullable().optional(),
+  sender_name: z.string().nullable().optional(),
+  from: z.string().optional(),
+});

package/src/schemas/message-group.ts

@@ -0,0 +1,100 @@
+import { z } from "zod";
+import {
+  DuplicateMessageGroupBody,
+  MessageGroupFromDb,
+  MessageGroupWithMessageSummary,
+  MESSAGE_GROUP_CATEGORIES,
+  MESSAGE_GROUP_VISIBILITY,
+  MESSAGE_STATUS,
+  MESSAGE_RENDER_TYPES,
+} from "../types/index.js";
+import { dbTimestampSchema } from "./common.js";
+import { messageResponseSchema } from "./message.js";
+
+export const listMessageGroupsQuerySchema = z.object({
+  render_type: z.string().optional(),
+  tags: z.union([z.string(), z.array(z.string())]).optional(),
+  tags_mode: z.enum(["and", "or"]).default("and"),
+});
+
+export const updateMessageGroupBodySchema = z.object({
+  name: z
+    .string()
+    .refine(
+      (name) => name.trim() !== "",
+      "Name is required and cannot be empty",
+    ),
+  brand_id: z.string().nullable().optional(),
+});
+
+export const createMessageGroupBodySchema = z.object({
+  name: z.string(),
+  category: z.enum(MESSAGE_GROUP_CATEGORIES),
+  visibility: z.enum(MESSAGE_GROUP_VISIBILITY).optional(),
+  brand_id: z.string().nullable().optional(),
+});
+
+export const duplicateMessageGroupBodySchema = z
+  .object({
+    name: z.string().optional(),
+    visibility: z.enum(MESSAGE_GROUP_VISIBILITY).optional(),
+    brand_id: z.string().nullable().optional(),
+  })
+  .optional() satisfies z.ZodType<DuplicateMessageGroupBody | undefined>;
+
+/** Mirrors MessageGroupFromDb rows as returned today. */
+export const messageGroupResponseSchema = z.object({
+  id: z.uuid(),
+  name: z.string(),
+  category: z.enum(MESSAGE_GROUP_CATEGORIES),
+  visibility: z.enum(MESSAGE_GROUP_VISIBILITY).nullable().optional(),
+  brand_id: z.string().nullable().optional(),
+  organization_id: z.string().nullable().optional(),
+  user_id: z.string(),
+  created_at: dbTimestampSchema,
+  updated_at: dbTimestampSchema,
+}) satisfies z.ZodType<unknown, MessageGroupFromDb>;
+
+export const messageGroupWithMessagesResponseSchema =
+  messageGroupResponseSchema.extend({
+    messages: z.array(messageResponseSchema),
+    tags: z.array(z.string()),
+  });
+
+export const messageGroupWithTagsResponseSchema =
+  messageGroupResponseSchema.extend({
+    tags: z.array(z.string()),
+  });
+
+/** List item for GET /message-groups: per-message summaries, no bodies. */
+export const messageGroupWithMessageSummaryResponseSchema =
+  messageGroupWithTagsResponseSchema.extend({
+    messages: z.array(
+      z.object({
+        id: z.uuid(),
+        language: z.string(),
+        status: z.enum(MESSAGE_STATUS),
+        preview: z.string(),
+        render_type: z.enum(MESSAGE_RENDER_TYPES),
+      }),
+    ),
+  }) satisfies z.ZodType<unknown, MessageGroupWithMessageSummary>;
+
+export const messageGroupSummaryListResponseSchema = z.array(
+  messageGroupWithMessageSummaryResponseSchema,
+);
+
+export const messageGroupValidationResponseSchema = z.object({
+  valid: z.boolean(),
+  errors: z.object({
+    status: z.array(z.string()),
+    languages: z.array(z.string()),
+    content: z.record(
+      z.string(),
+      z.object({
+        type: z.string(),
+        errors: z.array(z.string()),
+      }),
+    ),
+  }),
+});

package/src/schemas/message.ts

@@ -0,0 +1,36 @@
+import { z } from "zod";
+import { MESSAGE_STATUS, MESSAGE_RENDER_TYPES } from "../types/index.js";
+import { dbTimestampSchema } from "./common.js";
+
+export const messageBodySchema = z.object({
+  message_group_id: z.uuid(),
+  language_id: z.string(),
+  status: z.enum(MESSAGE_STATUS),
+  render_type: z.enum(MESSAGE_RENDER_TYPES),
+  body: z.record(z.string(), z.unknown()),
+  metadata: z.record(z.string(), z.unknown()),
+});
+
+/**
+ * Mirrors MessageFromDb rows as returned today. body/metadata stay loose
+ * records — no full Zod schema exists for the deep block unions (ADR 0004 §5).
+ */
+export const messageResponseSchema = z.object({
+  id: z.uuid(),
+  message_group_id: z.uuid(),
+  language_id: z.string(),
+  status: z.enum(MESSAGE_STATUS),
+  render_type: z.enum(MESSAGE_RENDER_TYPES),
+  body: z.record(z.string(), z.unknown()),
+  metadata: z.record(z.string(), z.unknown()).nullable(),
+  organization_id: z.string().nullable().optional(),
+  user_id: z.string(),
+  created_at: dbTimestampSchema,
+  updated_at: dbTimestampSchema,
+});
+
+export const messageListResponseSchema = z.array(messageResponseSchema);
+
+export const messageDeletedResponseSchema = z.object({
+  message: z.string(),
+});

package/src/schemas/meta-integration.ts

@@ -0,0 +1,47 @@
+import { z } from "zod";
+import { SubmissionJob, SubmissionJobResponse } from "../types/index.js";
+import { dbTimestampSchema } from "./common.js";
+
+export const messageIdParamsSchema = z.object({
+  messageId: z.uuid(),
+});
+
+export const submitGroupBodySchema = z.object({
+  wabaId: z.string().min(1, "Meta WABA ID required in body"),
+});
+
+/**
+ * Mirrors submission_jobs rows as returned today. Note: meta_config is echoed
+ * back as stored; accessToken is optional here because the current insert
+ * never writes it (the shared SubmissionJob type still claims it required —
+ * candidate for a type fix + curation pass).
+ */
+export const submissionJobResponseSchema = z.object({
+  id: z.uuid(),
+  message_group_id: z.uuid(),
+  status: z.enum(["queued", "processing", "completed", "failed"]),
+  submitted_count: z.number(),
+  failed_count: z.number(),
+  errors: z
+    .array(z.object({ messageId: z.string().optional(), error: z.string() }))
+    .nullable(),
+  meta_config: z.object({
+    wabaId: z.string(),
+    accessToken: z.string().optional(),
+    apiVersion: z.string().optional(),
+  }),
+  created_at: dbTimestampSchema,
+  updated_at: dbTimestampSchema,
+}) satisfies z.ZodType<unknown, SubmissionJob>;
+
+/** Sync single-message submission result; templateId is finalized via webhook. */
+export const submitMessageResponseSchema = z.object({
+  success: z.boolean(),
+  templateId: z.string(),
+});
+
+export const submitGroupAcceptedResponseSchema = z.object({
+  jobId: z.uuid(),
+  status: z.literal("queued"),
+  message: z.string(),
+}) satisfies z.ZodType<SubmissionJobResponse>;

package/src/schemas/onboarding.ts

@@ -0,0 +1,44 @@
+import { z } from "zod";
+import {
+  brandDefaultEmailSettingsSchema,
+  brandDefaultButtonSettingsSchema,
+  brandSocialsSchema,
+} from "../types/index.js";
+import { messageGroupWithMessagesResponseSchema } from "./message-group.js";
+
+export const onboardingResponseSchema = z.object({
+  messageGroups: z.array(messageGroupWithMessagesResponseSchema),
+  summary: z.object({
+    totalGroups: z.number(),
+    totalMessages: z.number(),
+  }),
+});
+
+export const onboardingBodySchema = z.object({
+  organizationId: z
+    .string({ error: "Both organizationId and userId are required" })
+    .min(1, "Both organizationId and userId are required"),
+  userId: z
+    .string({ error: "Both organizationId and userId are required" })
+    .min(1, "Both organizationId and userId are required"),
+  tags: z.array(z.string()).optional(),
+});
+
+export const createDefaultBrandBodySchema = z.object({
+  organizationId: z
+    .string({ error: "organizationId, userId, name, and logoUrl are required" })
+    .min(1, "organizationId, userId, name, and logoUrl are required"),
+  userId: z
+    .string({ error: "organizationId, userId, name, and logoUrl are required" })
+    .min(1, "organizationId, userId, name, and logoUrl are required"),
+  name: z
+    .string({ error: "organizationId, userId, name, and logoUrl are required" })
+    .min(1, "organizationId, userId, name, and logoUrl are required"),
+  logoUrl: z
+    .string({ error: "organizationId, userId, name, and logoUrl are required" })
+    .min(1, "organizationId, userId, name, and logoUrl are required"),
+  colors: z.array(z.string()).optional(),
+  defaultEmailSettings: brandDefaultEmailSettingsSchema.optional(),
+  defaultButtonSettings: brandDefaultButtonSettingsSchema.optional(),
+  defaultSocials: brandSocialsSchema,
+});

package/src/schemas/organization.ts

@@ -0,0 +1,7 @@
+import { z } from "zod";
+
+/**
+ * GET /organization/data passes through OrganizationData from Smartconnect —
+ * a flat string map by contract, deliberately loose.
+ */
+export const organizationDataResponseSchema = z.record(z.string(), z.string());

package/src/schemas/property.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+import { Property } from "../types/index.js";
+
+export const propertyResponseSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  hasAccess: z.boolean(),
+}) satisfies z.ZodType<Property>;
+
+export const propertyListResponseSchema = z.array(propertyResponseSchema);

package/src/schemas/tracking.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+
+export const trackingBodySchema = z.object({
+  eventName: z.string().min(1, "eventName is required"),
+  properties: z.record(z.string(), z.unknown()).optional(),
+});

package/src/types/api/aiIntegration.ts

@@ -47,7 +47,7 @@ export type GenerateTextWidgetType = "heading" | "paragraph" | "whatsapp_body";
 export interface GenerateTextRequest {
   prompt: string;
   widgetType: GenerateTextWidgetType;
-  language: string;
+  language?: string;
   context?: string;
 }
 

package/src/types/brand.ts

@@ -88,7 +88,7 @@ export interface Brand extends DbEntity {
   default_email_settings: BrandDefaultEmailSettings;
   default_button_settings: BrandDefaultButtonSettings;
   default_socials: BrandSocials | null;
-  data: BrandData;
+  data: BrandData | null;
 }
 
 export type BrandFromDb = WithDbTimestamps<Brand> & {

package/src/types/dynamic-values.ts

@@ -19,7 +19,7 @@ export interface DynamicValuesContextConfig {
   /**
    * Fields only offered when the organization has the Internal PMS capability
    * (Core `product-access` → `smartpms.subscribed`). Merged into `fields` in
-   * the API response for entitled organizations; hidden otherwise (see ADR 0004).
+   * the API response for entitled organizations; hidden otherwise (see ADR 0009).
    */
   pmsFields?: DynamicValueFieldConfig[];
 }

package/src/types/kafka-events.ts

@@ -5,7 +5,7 @@ export interface KafkaEventBase {
   event_type: string;
   timestamp: string;
   message_group_id: string;
-  organization_id?: string;
+  organization_id?: string | null;
   user_id: string;
 }
 

package/src/types/media.ts

@@ -17,10 +17,10 @@ export interface Media extends DbEntity {
   remote_name: string; // Sanitized filename stored in GCS (includes UUID prefix)
   file_name: string; // Original filename from user
   file_type: string;
-  meta_handle_id?: string;
-  smartchat_media_id?: string;
-  smartness_event_id?: string;
-  organization_id?: string;
+  meta_handle_id?: string | null;
+  smartchat_media_id?: string | null;
+  smartness_event_id?: string | null;
+  organization_id?: string | null;
   user_id: string;
 }
 

package/src/types/message.ts

@@ -31,7 +31,7 @@ interface BaseMessage extends DbEntity {
   language_id: string;
   status: MessageStatus;
   render_type: RenderType;
-  organization_id?: string;
+  organization_id?: string | null;
   user_id: string;
 }
 export interface WhatsappMessage extends BaseMessage {
@@ -83,9 +83,9 @@ export interface MessageGroup extends DbEntity {
   id: string;
   name: string;
   category: MessageGroupCategory;
-  visibility?: MessageGroupVisibility;
+  visibility?: MessageGroupVisibility | null;
   brand_id?: string | null;
-  organization_id?: string;
+  organization_id?: string | null;
   user_id: string;
 }
 

package/src/types/submission-job.ts

@@ -14,10 +14,10 @@ export interface SubmissionJob {
     /** Absent for job-level failures (e.g. credentials resolution) */
     messageId?: string;
     error: string;
-  }>;
+  }> | null;
   meta_config: {
     wabaId: string;
-    accessToken: string;
+    accessToken?: string;
     apiVersion?: string;
   };
   created_at: string;

package/src/utils/templates/brand-cascade.ts

@@ -22,7 +22,7 @@ export interface BrandCascadeData {
   default_button_settings: BrandDefaultButtonSettings;
   default_socials: BrandSocials | null;
   logo_url: string | null;
-  data: BrandData;
+  data: BrandData | null;
 }
 
 /**

package/src/utils/templates/email-mjml.ts

@@ -32,7 +32,7 @@ import { generateText } from "./messages.js";
 /**
  * Converts TipTap JSONContent to HTML for email rendering.
  * `linkColor`, when given, is baked as a literal inline style onto `<a>`
- * tags (not a CSS var) — see docs/adr/0004 for why this compile path can't
+ * tags (not a CSS var) — see docs/adr/0008 for why this compile path can't
  * reuse the live-editor CSS custom property approach.
  */
 function generateEmailHtml(

package/src/utils/templates/email.test.ts

@@ -1,10 +1,6 @@
 import { describe, it, expect } from "vitest";
 import { syncLayoutFromBase } from "./email.js";
-import type {
-  ButtonBlock,
-  GridBlock,
-  ImageBlock,
-} from "../../types/index.js";
+import type { ButtonBlock, GridBlock, ImageBlock } from "../../types/index.js";
 import {
   emptyButtonBlock,
   emptyGridBlock,

package/src/utils/templates/tiptap.ts

@@ -21,7 +21,7 @@ import { generateHtml, generateText } from "./messages.js";
  *   instance. Used for the canvas preview and settings-panel editor.
  * - "compile": a literal hex is baked into the inline style. Required for
  *   the final email HTML — Outlook and other strict clients don't support
- *   CSS custom properties. See docs/adr/0004.
+ *   CSS custom properties. See docs/adr/0008.
  */
 export type LinkColorOption =
   | { mode: "live" }