feat: replace joi by zod

Author: marrouchi

api/package-lock.json

@@ -71,7 +71,6 @@
     "dotenv": "^16.3.1",
     "ejs": "^3.1.9",
     "express-session": "^1.17.3",
-    "joi": "^17.11.0",
     "module-alias": "^2.2.3",
     "mongoose": "^8.0.0",
     "mongoose-lean-defaults": "^2.2.1",
@@ -92,7 +91,8 @@
     "sanitize-filename": "^1.6.3",
     "slug": "^8.2.2",
     "ts-migrate-mongoose": "^3.8.4",
-    "uuid": "^9.0.1"
+    "uuid": "^9.0.1",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@compodoc/compodoc": "^1.1.24",

api/package.json

@@ -102,14 +102,14 @@ export class Attachment extends BaseSchema {
    * @returns The attachment type ('image', 'audio', 'video' or 'file')
    */
   static getTypeByMime(mimeType: string): FileType {
-    if (mimeType.startsWith(FileType.image)) {
-      return FileType.image;
-    } else if (mimeType.startsWith(FileType.audio)) {
-      return FileType.audio;
-    } else if (mimeType.startsWith(FileType.video)) {
-      return FileType.video;
+    if (mimeType.startsWith('image')) {
+      return 'image';
+    } else if (mimeType.startsWith('audio')) {
+      return 'audio';
+    } else if (mimeType.startsWith('video')) {
+      return 'video';
     } else {
-      return FileType.file;
+      return 'file';
     }
   }
 }

api/src/attachment/schemas/attachment.schema.ts

@@ -10,7 +10,6 @@ import { Attachment } from '@/attachment/schemas/attachment.schema';
 import { WithUrl } from '@/chat/schemas/types/attachment';
 import { ButtonType } from '@/chat/schemas/types/button';
 import {
-  FileType,
   OutgoingMessageFormat,
   StdOutgoingAttachmentMessage,
   StdOutgoingButtonsMessage,
@@ -160,7 +159,7 @@ export const attachmentMessage: StdOutgoingAttachmentMessage<
   WithUrl<Attachment>
 > = {
   attachment: {
-    type: FileType.image,
+    type: 'image',
     payload: attachmentWithUrl,
   },
   quickReplies: [

api/src/channel/lib/__test__/common.mock.ts

@@ -6,33 +6,47 @@
  * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
  */
 
+import { z } from 'zod';
+
 import { Attachment } from '@/attachment/schemas/attachment.schema';
 
-export enum FileType {
-  image = 'image',
-  video = 'video',
-  audio = 'audio',
-  file = 'file',
-  unknown = 'unknown',
-}
+// Enum for FileType
+export const fileTypeSchema = z.enum([
+  'image',
+  'video',
+  'audio',
+  'file',
+  'unknown',
+]);
+
+export type FileType = z.infer<typeof fileTypeSchema>;
+
+// AttachmentForeignKey type schema
+export const attachmentForeignKeySchema = z.object({
+  url: z.string().url().optional(),
+  attachment_id: z.string().nullable(),
+});
 
-export type AttachmentForeignKey = {
-  url?: string;
-  attachment_id: string;
-};
+export type AttachmentForeignKey = z.infer<typeof attachmentForeignKeySchema>;
 
+// WithUrl helper type
 export type WithUrl<A> = A & { url?: string };
 
-export interface AttachmentPayload<
+// Generic AttachmentPayload type schema
+export const attachmentPayloadSchema = <
   A extends WithUrl<Attachment> | AttachmentForeignKey,
-> {
-  type: FileType;
-  payload: A;
-}
-
-export interface IncomingAttachmentPayload {
-  type: FileType;
-  payload: {
-    url: string;
-  };
-}
+>(
+  payloadSchema: z.ZodType<A>,
+) =>
+  z.object({
+    type: fileTypeSchema,
+    payload: payloadSchema,
+  });
+
+export type AttachmentPayload<
+  A extends WithUrl<Attachment> | AttachmentForeignKey,
+> = z.infer<ReturnType<typeof attachmentPayloadSchema<A>>>;
+
+export type IncomingAttachmentPayload = z.infer<
+  ReturnType<typeof attachmentPayloadSchema<AttachmentForeignKey>>
+>;

api/src/chat/schemas/types/attachment.ts

@@ -6,23 +6,50 @@
  * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
  */
 
+import { z } from 'zod';
+
+// Enum for ButtonType
 export enum ButtonType {
   postback = 'postback',
   web_url = 'web_url',
 }
 
-export type PostBackButton = {
-  type: ButtonType.postback;
-  title: string;
-  payload: string;
-};
-
-export type WebUrlButton = {
-  type: ButtonType.web_url;
-  title: string;
-  url: string;
-  messenger_extensions?: boolean;
-  webview_height_ratio?: 'compact' | 'tall' | 'full';
-};
-
-export type Button = PostBackButton | WebUrlButton;
+// Zod schema for ButtonType
+export const buttonTypeSchema = z.enum([
+  ButtonType.postback,
+  ButtonType.web_url,
+]);
+
+// Base schema for shared fields
+export const baseButtonSchema = z.object({
+  type: buttonTypeSchema,
+  title: z.string().max(20),
+});
+
+// Conditional schemas
+export const postBackButtonSchema = baseButtonSchema.extend({
+  type: z.literal(ButtonType.postback),
+  payload: z.string().max(1000),
+  // No `url`, `messenger_extensions`, or `webview_height_ratio` fields here
+});
+
+export const webUrlButtonSchema = baseButtonSchema.extend({
+  type: z.literal(ButtonType.web_url),
+  url: z.string().url(),
+  messenger_extensions: z.boolean().optional(),
+  webview_height_ratio: z.enum(['compact', 'tall', 'full']).optional(),
+  // No `payload` field here
+});
+
+// Union schema for Button
+export const buttonSchema = z.union([postBackButtonSchema, webUrlButtonSchema]);
+
+// Array schema for buttons
+export const buttonsSchema = z.array(buttonSchema).max(3);
+
+// Infer types
+export type PostBackButton = z.infer<typeof postBackButtonSchema>;
+
+export type WebUrlButton = z.infer<typeof webUrlButtonSchema>;
+
+export type Button = z.infer<typeof buttonSchema>;

api/src/chat/schemas/types/button.ts

@@ -6,10 +6,27 @@
  * 2. All derivative works must include clear attribution to the original creator and software, Hexastack and Hexabot, in a prominent location (e.g., in the software's "About" section, documentation, and README file).
  */
 
-export interface CaptureVar {
-  // entity=`-1` to match text message
-  // entity=`-2` for postback payload
-  // entity is `String` for NLP entities
-  entity: number | string;
-  context_var: string;
-}
+import { z } from 'zod';
+
+// Zod schema for CaptureVar
+const captureVarSchema = z.object({
+  entity: z.union([
+    // entity=`-1` to match text message
+    // entity=`-2` for postback payload
+    // entity is `String` for NLP entities
+    z
+      .number()
+      .int()
+      .refine((val) => val === -1 || val === -2, {
+        message: "entity must be -1 or -2 when it's a number",
+      }),
+    z.string(), // entity is a string for NLP entities
+  ]),
+  context_var: z.string(),
+});
+
+// Infer the TypeScript type
+type CaptureVar = z.infer<typeof captureVarSchema>;
+
+// Export the schema and type
+export { CaptureVar, captureVarSchema };

api/src/chat/schemas/types/capture-var.ts

@@ -56,22 +56,6 @@ export enum OutgoingMessageFormat {
   carousel = 'carousel',
 }
 
-/**
- * FileType enum is declared, and currently not used
- **/
-export enum FileType {
-  image = 'image',
-  video = 'video',
-  audio = 'audio',
-  file = 'file',
-  unknown = 'unknown',
-}
-
-export enum PayloadType {
-  location = 'location',
-  attachments = 'attachments',
-}
-
 export type StdOutgoingTextMessage = { text: string };
 
 export type StdOutgoingQuickRepliesMessage = {
@@ -130,15 +114,15 @@ export type StdIncomingPostBackMessage = StdIncomingTextMessage & {
 };
 
 export type StdIncomingLocationMessage = {
-  type: PayloadType.location;
+  type: 'location';
   coordinates: {
     lat: number;
     lon: number;
   };
 };
 
 export type StdIncomingAttachmentMessage = {
-  type: PayloadType.attachments;
+  type: 'attachments';
   serialized_text: string;
   attachment: IncomingAttachmentPayload | IncomingAttachmentPayload[];
 };