From 011bc69db917f200c5d3e0531407508c07c47458 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 3 Feb 2025 14:58:57 +0100 Subject: [PATCH 1/4] feat: channelSchema validation with zod --- .../chat/validation-rules/is-channel-data.ts | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/api/src/chat/validation-rules/is-channel-data.ts b/api/src/chat/validation-rules/is-channel-data.ts index 3dbd4c2d..57f67128 100644 --- a/api/src/chat/validation-rules/is-channel-data.ts +++ b/api/src/chat/validation-rules/is-channel-data.ts @@ -1,5 +1,5 @@ /* - * 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: * 1. The name "Hexabot" is a trademark of Hexastack. You may not use this name in derivative works without express written permission. @@ -12,18 +12,21 @@ import { ValidatorConstraint, ValidatorConstraintInterface, } from 'class-validator'; +import { z } from 'zod'; -export function isChannelData(channel: any) { - return ( - typeof channel === 'object' && - channel.name && - typeof channel.name === 'string' - ); +export const channelSchema = z.object({ + name: z.string(), +}); + +export type Channel = z.infer; + +export function isChannelData(channel: Channel) { + return channelSchema.safeParse(channel).success; } @ValidatorConstraint({ async: false }) export class ChannelDataValidator implements ValidatorConstraintInterface { - validate(channel: any) { + validate(channel: Channel) { return isChannelData(channel); } } From 768feb70e258372f761f6594eed503f78209f822 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 3 Feb 2025 17:44:55 +0100 Subject: [PATCH 2/4] fix: apply feedback --- api/src/chat/schemas/types/channel.ts | 10 +++++++++- api/src/chat/validation-rules/is-channel-data.ts | 7 +------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/api/src/chat/schemas/types/channel.ts b/api/src/chat/schemas/types/channel.ts index 06359493..bdb1ffdb 100644 --- a/api/src/chat/schemas/types/channel.ts +++ b/api/src/chat/schemas/types/channel.ts @@ -1,11 +1,13 @@ /* - * 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: * 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). */ +import { z } from 'zod'; + import { ChannelName } from '@/channel/types'; export type SubscriberChannelData = @@ -17,3 +19,9 @@ export type SubscriberChannelData = // Channel's specific attributes [P in keyof SubscriberChannelDict[C]]: SubscriberChannelDict[C][P]; }; + +export const channelSchema = z.object({ + name: z.string().regex(/-channel$/) as z.ZodType, +}); + +export type Channel = z.infer; diff --git a/api/src/chat/validation-rules/is-channel-data.ts b/api/src/chat/validation-rules/is-channel-data.ts index 57f67128..ef1590ff 100644 --- a/api/src/chat/validation-rules/is-channel-data.ts +++ b/api/src/chat/validation-rules/is-channel-data.ts @@ -12,13 +12,8 @@ import { ValidatorConstraint, ValidatorConstraintInterface, } from 'class-validator'; -import { z } from 'zod'; -export const channelSchema = z.object({ - name: z.string(), -}); - -export type Channel = z.infer; +import { Channel, channelSchema } from '../schemas/types/channel'; export function isChannelData(channel: Channel) { return channelSchema.safeParse(channel).success; From ac01cc72697a6bef8115609036b0a45b814f84aa Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 3 Feb 2025 18:02:42 +0100 Subject: [PATCH 3/4] fix: apply feedback naming --- api/src/chat/schemas/types/channel.ts | 4 ++-- api/src/chat/validation-rules/is-channel-data.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/api/src/chat/schemas/types/channel.ts b/api/src/chat/schemas/types/channel.ts index bdb1ffdb..13de7204 100644 --- a/api/src/chat/schemas/types/channel.ts +++ b/api/src/chat/schemas/types/channel.ts @@ -20,8 +20,8 @@ export type SubscriberChannelData = [P in keyof SubscriberChannelDict[C]]: SubscriberChannelDict[C][P]; }; -export const channelSchema = z.object({ +export const channelDataSchema = z.object({ name: z.string().regex(/-channel$/) as z.ZodType, }); -export type Channel = z.infer; +export type Channel = z.infer; diff --git a/api/src/chat/validation-rules/is-channel-data.ts b/api/src/chat/validation-rules/is-channel-data.ts index ef1590ff..5bb6082e 100644 --- a/api/src/chat/validation-rules/is-channel-data.ts +++ b/api/src/chat/validation-rules/is-channel-data.ts @@ -13,10 +13,10 @@ import { ValidatorConstraintInterface, } from 'class-validator'; -import { Channel, channelSchema } from '../schemas/types/channel'; +import { Channel, channelDataSchema } from '../schemas/types/channel'; export function isChannelData(channel: Channel) { - return channelSchema.safeParse(channel).success; + return channelDataSchema.safeParse(channel).success; } @ValidatorConstraint({ async: false }) From a648fec828960d20c909f2e496c9a70916b5f946 Mon Sep 17 00:00:00 2001 From: abdou6666 Date: Mon, 3 Feb 2025 18:30:14 +0100 Subject: [PATCH 4/4] fix: accept other key,values in channelDataSchema --- api/src/chat/schemas/types/channel.ts | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/api/src/chat/schemas/types/channel.ts b/api/src/chat/schemas/types/channel.ts index 13de7204..dee41f1c 100644 --- a/api/src/chat/schemas/types/channel.ts +++ b/api/src/chat/schemas/types/channel.ts @@ -20,8 +20,10 @@ export type SubscriberChannelData = [P in keyof SubscriberChannelDict[C]]: SubscriberChannelDict[C][P]; }; -export const channelDataSchema = z.object({ - name: z.string().regex(/-channel$/) as z.ZodType, -}); +export const channelDataSchema = z + .object({ + name: z.string().regex(/-channel$/) as z.ZodType, + }) + .passthrough(); export type Channel = z.infer;