convert webhooks

src/backend/common/infrastructure/config/health/webhooks.ts

@@ -1,3 +1,5 @@
+import * as z from "zod";
+
 export interface WebhookPayload {
     title?: string
     identifier: string
@@ -7,22 +9,30 @@ export interface WebhookPayload {
 
 export type Priority = 'info' | 'warn' | 'error';
 
-export interface PrioritiesConfig {
+export const prioritiesConfigSchema = z.object({
     /**
      * @examples [5]
      * */
-    info: number
+    info: z.number().meta({
+        examples: [5]
+    }),
     /**
      * @examples [7]
      * */
-    warn: number
+    warn: z.number().meta({
+        examples: [7]
+    }),
     /**
      * @examples [10]
      * */
-    error: number
-}
+    error: z.number().meta({
+        examples: [10]
+    }),
+});
 
-export interface CommonWebhookConfig {
+export type PrioritiesConfig = z.infer<typeof prioritiesConfigSchema>;
+
+export const commonWebhookConfigSchema = z.object({
     /**
      * Webhook type. Valid values are:
      *
@@ -31,26 +41,40 @@ export interface CommonWebhookConfig {
      *
      * @examples ["gotify"]
      * */
-    type: 'gotify' | 'ntfy' | 'apprise'
+    type: z.union([z.literal('gotify'), z.literal('ntfy'), z.literal('apprise')]).meta({
+        description: "Webhook type. Valid values are:",
+        examples: ["gotify"]
+    }),
     /**
      * A friendly name used to identify webhook config in logs
      * */
-    name?: string
-}
+    name: z.string().optional().meta({
+        description: "A friendly name used to identify webhook config in logs"
+    }),
+});
 
-export interface GotifyConfig extends CommonWebhookConfig {
+export type CommonWebhookConfig = z.infer<typeof commonWebhookConfigSchema>;
+
+export const gotifyConfigSchema = z.object({
+    ...commonWebhookConfigSchema.shape,
     /**
      * The URL of the Gotify server. Same URL that would be used to reach the Gotify UI
      *
      * @examples ["http://192.168.0.100:8078"]
      * */
-    url: string
+    url: z.string().meta({
+        description: "The URL of the Gotify server.",
+        examples: ["http://192.168.0.100:8078"]
+    }),
     /**
      * The token created for this Application in Gotify
      *
      * @examples ["AQZI58fA.rfSZbm"]
      * */
-    token: string
+    token: z.string().meta({
+        description: "The token created for this Application in Gotify",
+        examples: ["AQZI58fA.rfSZbm"]
+    }),
     /**
      * Priority of messages
      *
@@ -58,35 +82,51 @@ export interface GotifyConfig extends CommonWebhookConfig {
      * * Warn -> 7
      * * Error -> 10
      * */
-    priorities?: PrioritiesConfig
-}
+    priorities: prioritiesConfigSchema.optional().meta({
+        description: "Priority of messages"
+    }),
+});
 
-export interface NtfyConfig extends CommonWebhookConfig {
+export type GotifyConfig = z.infer<typeof gotifyConfigSchema>;
+
+export const ntfyConfigSchema = z.object({
+    ...commonWebhookConfigSchema.shape,
     /**
      * The URL of the Ntfy server
      *
      * @examples ["http://192.168.0.100:8078"]
      * */
-    url: string
+    url: z.string().meta({
+        description: "The URL of the Ntfy server",
+        examples: ["http://192.168.0.100:8078"]
+    }),
 
     /**
      * The topic mutli-scrobbler should POST to
      * */
-    topic: string
+    topic: z.string().meta({
+        description: "The topic mutli-scrobbler should POST to"
+    }),
 
     /**
      * Required if topic is protected
      * */
-    username?: string
+    username: z.string().optional().meta({
+        description: "Required if topic is protected"
+    }),
     /**
      * Required if topic is protected
      * */
-    password?: string
+    password: z.string().optional().meta({
+        description: "Required if topic is protected"
+    }),
 
     /**
      * Use instead of username/password, required if topic is protected
      */
-    token?: string
+    token: z.string().optional().meta({
+        description: "Use instead of username/password, required if topic is protected"
+    }),
 
     /**
      * Priority of messages
@@ -95,33 +135,51 @@ export interface NtfyConfig extends CommonWebhookConfig {
      * * Warn -> 4
      * * Error -> 5
      * */
-    priorities?: PrioritiesConfig
-}
+    priorities: prioritiesConfigSchema.optional().meta({
+        description: "Priority of messages"
+    }),
+});
 
-export interface AppriseConfig extends CommonWebhookConfig {
+export type NtfyConfig = z.infer<typeof ntfyConfigSchema>;
+
+export const appriseConfigSchema = z.object({
+    ...commonWebhookConfigSchema.shape,
     /**
      * The URL of the apprise-api server
      *
      * @examples ["http://192.168.0.100:8078"]
      * */
-    host: string
+    host: z.string().meta({
+        description: "The URL of the apprise-api server",
+        examples: ["http://192.168.0.100:8078"]
+    }),
 
     /**
      * If using [Stateless Endpoints](https://github.com/caronc/apprise-api?tab=readme-ov-file#stateless-solution) the Apprise config URL(s) to send
      * */
-    urls?: string | string[]
+    urls: z.union([z.string(), z.array(z.string())]).optional().meta({
+        description: "If using [Stateless Endpoints](https://github.com/caronc/apprise-api?tab=readme-ov-file#stateless-solution) the Apprise config URL(s) to send"
+    }),
 
     /**
      * If using [Persistent Store Endpoints](https://github.com/caronc/apprise-api?tab=readme-ov-file#persistent-storage-solution) the Configuration ID(s) to send to
      *
      * Note: If multiple keys are defined then MS will attempt to POST to each one individually
      * */
-    keys?: string | string[]
+    keys: z.union([z.string(), z.array(z.string())]).optional().meta({
+        description: "If using [Persistent Store Endpoints](https://github.com/caronc/apprise-api?tab=readme-ov-file#persistent-storage-solution) the Configuration ID(s) to send to"
+    }),
 
     /**
      * Optional [tag(s)](https://github.com/caronc/apprise-api?tab=readme-ov-file#tagging) to send in the notification payload
      * */
-    tags?: string | string[]
-}
+    tags: z.union([z.string(), z.array(z.string())]).optional().meta({
+        description: "Optional [tag(s)](https://github.com/caronc/apprise-api?tab=readme-ov-file#tagging) to send in the notification payload"
+    }),
+});
 
-export type WebhookConfig = GotifyConfig | NtfyConfig | AppriseConfig;
+export type AppriseConfig = z.infer<typeof appriseConfigSchema>;
+
+export const webhookConfigSchema = z.union([gotifyConfigSchema, ntfyConfigSchema, appriseConfigSchema]);
+
+export type WebhookConfig = z.infer<typeof webhookConfigSchema>;