Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/global-messages/index.ts
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export {createGlobalMessageSchema, GenericGlobalMessageType} from './types';
export {GlobalMessageSchema, GlobalMessageType} from './types';
56 changes: 19 additions & 37 deletions src/global-messages/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,23 @@ import {LanguageAndTextSchema} from '../common/language-and-text';
import {Rule} from '../rules/types';
import {AppPlatform} from '../common/app-platform';

/**
* Create a global message schema with a consumer specific context enum.
*
* @example
* export enum GlobalMessageContextEnum {
* webOverview = 'web-overview',
* }
* const GlobalMessageContextSchema = z.enum(GlobalMessageContextEnum);
* export const GlobalMessageSchema = createGlobalMessageSchema(
* GlobalMessageContextSchema,
* );
*/
export function createGlobalMessageSchema<ContextEnum extends z.ZodType>(
contextEnum: ContextEnum,
) {
return z.object({
id: z.string(),
active: z.boolean(),
title: z.array(LanguageAndTextSchema).optional(),
body: z.array(LanguageAndTextSchema),
link: z.array(LanguageAndTextSchema).optional(),
linkText: z.array(LanguageAndTextSchema).optional(),
type: z.enum(['error', 'valid', 'info', 'warning']),
subtle: z.boolean().optional(),
context: z.array(contextEnum),
isDismissable: z.boolean().optional(),
appPlatforms: z.array(AppPlatform).optional(),
appVersionMin: z.string().optional(),
appVersionMax: z.string().optional(),
startDate: z.coerce.date().optional(),
endDate: z.coerce.date().optional(),
rules: z.array(Rule).optional(),
});
}
export const GlobalMessageSchema = z.object({
id: z.string(),
active: z.boolean(),
title: z.array(LanguageAndTextSchema).optional(),
body: z.array(LanguageAndTextSchema),
link: z.array(LanguageAndTextSchema).optional(),
linkText: z.array(LanguageAndTextSchema).optional(),
type: z.enum(['error', 'valid', 'info', 'warning']),
subtle: z.boolean().optional(),
context: z.array(z.string()).nonempty(),
isDismissable: z.boolean().optional(),
appPlatforms: z.array(AppPlatform).optional(),
appVersionMin: z.string().optional(),
appVersionMax: z.string().optional(),
startDate: z.coerce.date().optional(),
endDate: z.coerce.date().optional(),
rules: z.array(Rule).optional(),
});

export type GenericGlobalMessageType<ContextEnum extends z.ZodType> = z.infer<
ReturnType<typeof createGlobalMessageSchema<ContextEnum>>
>;
export type GlobalMessageType = z.infer<typeof GlobalMessageSchema>;
Loading