Merge pull request #678 from Hexastack/feat/button-schema-validation-zod
Some checks failed
Build and Push Docker API Image / build-and-push (push) Has been cancelled
Build and Push Docker Base Image / build-and-push (push) Has been cancelled
Build and Push Docker UI Image / build-and-push (push) Has been cancelled

Feat: button schema validation zod
This commit is contained in:
Med Marrouchi 2025-02-03 18:59:26 +01:00 committed by GitHub
commit 8d52d4efb7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,28 +1,36 @@
/* /*
* Copyright © 2024 Hexastack. All rights reserved. * Copyright © 2025 Hexastack. All rights reserved.
* *
* Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms: * Licensed under the GNU Affero General Public License v3.0 (AGPLv3) with the following additional terms:
* 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission. * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission.
* 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). * 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';
export enum ButtonType { export enum ButtonType {
postback = 'postback', postback = 'postback',
web_url = 'web_url', web_url = 'web_url',
} }
export type PostBackButton = { const postBackButtonSchema = z.object({
type: ButtonType.postback; type: z.literal(ButtonType.postback),
title: string; title: z.string(),
payload: string; payload: z.string(),
}; });
export type WebUrlButton = { const webUrlButtonSchema = z.object({
type: ButtonType.web_url; type: z.literal(ButtonType.web_url),
title: string; title: z.string(),
url: string; url: z.string().url(),
messenger_extensions?: boolean; messenger_extensions: z.boolean().optional(),
webview_height_ratio?: 'compact' | 'tall' | 'full'; webview_height_ratio: z.enum(['compact', 'tall', 'full']).optional(),
}; });
export type Button = PostBackButton | WebUrlButton; export const buttonSchema = z.union([postBackButtonSchema, webUrlButtonSchema]);
export type PostBackButton = z.infer<typeof postBackButtonSchema>;
export type WebUrlButton = z.infer<typeof webUrlButtonSchema>;
export type Button = z.infer<typeof buttonSchema>;