Merge pull request #677 from Hexastack/feat/add-channelSchema-zod-validation

Feat: add channel schema zod validation
This commit is contained in:
Med Marrouchi 2025-02-03 18:53:30 +01:00 committed by GitHub
commit 427321859b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 17 additions and 9 deletions

View File

@ -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: * 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';
import { ChannelName } from '@/channel/types'; import { ChannelName } from '@/channel/types';
export type SubscriberChannelData<C extends ChannelName = 'unknown-channel'> = export type SubscriberChannelData<C extends ChannelName = 'unknown-channel'> =
@ -17,3 +19,11 @@ export type SubscriberChannelData<C extends ChannelName = 'unknown-channel'> =
// Channel's specific attributes // Channel's specific attributes
[P in keyof SubscriberChannelDict[C]]: SubscriberChannelDict[C][P]; [P in keyof SubscriberChannelDict[C]]: SubscriberChannelDict[C][P];
}; };
export const channelDataSchema = z
.object({
name: z.string().regex(/-channel$/) as z.ZodType<ChannelName>,
})
.passthrough();
export type Channel = z.infer<typeof channelDataSchema>;

View File

@ -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: * 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.
@ -13,17 +13,15 @@ import {
ValidatorConstraintInterface, ValidatorConstraintInterface,
} from 'class-validator'; } from 'class-validator';
export function isChannelData(channel: any) { import { Channel, channelDataSchema } from '../schemas/types/channel';
return (
typeof channel === 'object' && export function isChannelData(channel: Channel) {
channel.name && return channelDataSchema.safeParse(channel).success;
typeof channel.name === 'string'
);
} }
@ValidatorConstraint({ async: false }) @ValidatorConstraint({ async: false })
export class ChannelDataValidator implements ValidatorConstraintInterface { export class ChannelDataValidator implements ValidatorConstraintInterface {
validate(channel: any) { validate(channel: Channel) {
return isChannelData(channel); return isChannelData(channel);
} }
} }