@objectstack/spec 0.7.1 → 0.8.0

package/dist/system/notification.zod.d.ts

@@ -23,61 +23,20 @@ import { z } from 'zod';
  * ```
  */
 export declare const EmailTemplateSchema: z.ZodObject<{
-    /**
-     * Unique identifier for the email template
-     */
     id: z.ZodString;
-    /**
-     * Email subject line (supports variable interpolation)
-     */
     subject: z.ZodString;
-    /**
-     * Email body content
-     */
     body: z.ZodString;
-    /**
-     * Content type of the email body
-     * @default 'html'
-     */
-    bodyType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["text", "html", "markdown"]>>>;
-    /**
-     * List of template variables for dynamic content
-     */
-    variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    /**
-     * File attachments to include with the email
-     */
+    bodyType: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+        text: "text";
+        markdown: "markdown";
+        html: "html";
+    }>>>;
+    variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
     attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         url: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        name: string;
-    }, {
-        url: string;
-        name: string;
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    body: string;
-    subject: string;
-    bodyType: "text" | "markdown" | "html";
-    variables?: string[] | undefined;
-    attachments?: {
-        url: string;
-        name: string;
-    }[] | undefined;
-}, {
-    id: string;
-    body: string;
-    subject: string;
-    bodyType?: "text" | "markdown" | "html" | undefined;
-    variables?: string[] | undefined;
-    attachments?: {
-        url: string;
-        name: string;
-    }[] | undefined;
-}>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 /**
  * SMS Template Schema
  *
@@ -95,34 +54,11 @@ export declare const EmailTemplateSchema: z.ZodObject<{
  * ```
  */
 export declare const SMSTemplateSchema: z.ZodObject<{
-    /**
-     * Unique identifier for the SMS template
-     */
     id: z.ZodString;
-    /**
-     * SMS message content (supports variable interpolation)
-     */
     message: z.ZodString;
-    /**
-     * Maximum character length for the SMS
-     * @default 160
-     */
     maxLength: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
-    /**
-     * List of template variables for dynamic content
-     */
-    variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    maxLength: number;
-    id: string;
-    variables?: string[] | undefined;
-}, {
-    message: string;
-    id: string;
-    maxLength?: number | undefined;
-    variables?: string[] | undefined;
-}>;
+    variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strip>;
 /**
  * Push Notification Schema
  *
@@ -145,60 +81,16 @@ export declare const SMSTemplateSchema: z.ZodObject<{
  * ```
  */
 export declare const PushNotificationSchema: z.ZodObject<{
-    /**
-     * Notification title
-     */
     title: z.ZodString;
-    /**
-     * Notification body text
-     */
     body: z.ZodString;
-    /**
-     * Icon URL to display with notification
-     */
     icon: z.ZodOptional<z.ZodString>;
-    /**
-     * Badge count to display on app icon
-     */
     badge: z.ZodOptional<z.ZodNumber>;
-    /**
-     * Custom data payload
-     */
     data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    /**
-     * Action buttons for the notification
-     */
     actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
         action: z.ZodString;
         title: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        title: string;
-        action: string;
-    }, {
-        title: string;
-        action: string;
-    }>, "many">>;
-}, "strip", z.ZodTypeAny, {
-    title: string;
-    body: string;
-    icon?: string | undefined;
-    data?: Record<string, any> | undefined;
-    actions?: {
-        title: string;
-        action: string;
-    }[] | undefined;
-    badge?: number | undefined;
-}, {
-    title: string;
-    body: string;
-    icon?: string | undefined;
-    data?: Record<string, any> | undefined;
-    actions?: {
-        title: string;
-        action: string;
-    }[] | undefined;
-    badge?: number | undefined;
-}>;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
 /**
  * In-App Notification Schema
  *
@@ -218,52 +110,32 @@ export declare const PushNotificationSchema: z.ZodObject<{
  * ```
  */
 export declare const InAppNotificationSchema: z.ZodObject<{
-    /**
-     * Notification title
-     */
     title: z.ZodString;
-    /**
-     * Notification message content
-     */
     message: z.ZodString;
-    /**
-     * Notification severity type
-     */
-    type: z.ZodEnum<["info", "success", "warning", "error"]>;
-    /**
-     * Optional URL to navigate to when clicked
-     */
+    type: z.ZodEnum<{
+        error: "error";
+        success: "success";
+        warning: "warning";
+        info: "info";
+    }>;
     actionUrl: z.ZodOptional<z.ZodString>;
-    /**
-     * Whether the notification can be dismissed by the user
-     * @default true
-     */
     dismissible: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    /**
-     * Timestamp when notification expires (Unix milliseconds)
-     */
     expiresAt: z.ZodOptional<z.ZodNumber>;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    type: "error" | "warning" | "info" | "success";
-    title: string;
-    dismissible: boolean;
-    expiresAt?: number | undefined;
-    actionUrl?: string | undefined;
-}, {
-    message: string;
-    type: "error" | "warning" | "info" | "success";
-    title: string;
-    expiresAt?: number | undefined;
-    actionUrl?: string | undefined;
-    dismissible?: boolean | undefined;
-}>;
+}, z.core.$strip>;
 /**
  * Notification Channel Enum
  *
  * Supported notification delivery channels.
  */
-export declare const NotificationChannelSchema: z.ZodEnum<["email", "sms", "push", "in-app", "slack", "teams", "webhook"]>;
+export declare const NotificationChannelSchema: z.ZodEnum<{
+    push: "push";
+    email: "email";
+    webhook: "webhook";
+    slack: "slack";
+    sms: "sms";
+    "in-app": "in-app";
+    teams: "teams";
+}>;
 /**
  * Notification Configuration Schema
  *
@@ -303,419 +175,88 @@ export declare const NotificationChannelSchema: z.ZodEnum<["email", "sms", "push
  * ```
  */
 export declare const NotificationConfigSchema: z.ZodObject<{
-    /**
-     * Unique identifier for this notification configuration
-     */
     id: z.ZodString;
-    /**
-     * Human-readable name for this notification
-     */
     name: z.ZodString;
-    /**
-     * Delivery channel for the notification
-     */
-    channel: z.ZodEnum<["email", "sms", "push", "in-app", "slack", "teams", "webhook"]>;
-    /**
-     * Notification template based on channel type
-     */
-    template: z.ZodUnion<[z.ZodObject<{
-        /**
-         * Unique identifier for the email template
-         */
+    channel: z.ZodEnum<{
+        push: "push";
+        email: "email";
+        webhook: "webhook";
+        slack: "slack";
+        sms: "sms";
+        "in-app": "in-app";
+        teams: "teams";
+    }>;
+    template: z.ZodUnion<readonly [z.ZodObject<{
         id: z.ZodString;
-        /**
-         * Email subject line (supports variable interpolation)
-         */
         subject: z.ZodString;
-        /**
-         * Email body content
-         */
         body: z.ZodString;
-        /**
-         * Content type of the email body
-         * @default 'html'
-         */
-        bodyType: z.ZodDefault<z.ZodOptional<z.ZodEnum<["text", "html", "markdown"]>>>;
-        /**
-         * List of template variables for dynamic content
-         */
-        variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        /**
-         * File attachments to include with the email
-         */
+        bodyType: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            text: "text";
+            markdown: "markdown";
+            html: "html";
+        }>>>;
+        variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
         attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             url: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            url: string;
-            name: string;
-        }, {
-            url: string;
-            name: string;
-        }>, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        id: string;
-        body: string;
-        subject: string;
-        bodyType: "text" | "markdown" | "html";
-        variables?: string[] | undefined;
-        attachments?: {
-            url: string;
-            name: string;
-        }[] | undefined;
-    }, {
-        id: string;
-        body: string;
-        subject: string;
-        bodyType?: "text" | "markdown" | "html" | undefined;
-        variables?: string[] | undefined;
-        attachments?: {
-            url: string;
-            name: string;
-        }[] | undefined;
-    }>, z.ZodObject<{
-        /**
-         * Unique identifier for the SMS template
-         */
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
         id: z.ZodString;
-        /**
-         * SMS message content (supports variable interpolation)
-         */
         message: z.ZodString;
-        /**
-         * Maximum character length for the SMS
-         * @default 160
-         */
         maxLength: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
-        /**
-         * List of template variables for dynamic content
-         */
-        variables: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        maxLength: number;
-        id: string;
-        variables?: string[] | undefined;
-    }, {
-        message: string;
-        id: string;
-        maxLength?: number | undefined;
-        variables?: string[] | undefined;
-    }>, z.ZodObject<{
-        /**
-         * Notification title
-         */
+        variables: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>, z.ZodObject<{
         title: z.ZodString;
-        /**
-         * Notification body text
-         */
         body: z.ZodString;
-        /**
-         * Icon URL to display with notification
-         */
         icon: z.ZodOptional<z.ZodString>;
-        /**
-         * Badge count to display on app icon
-         */
         badge: z.ZodOptional<z.ZodNumber>;
-        /**
-         * Custom data payload
-         */
         data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        /**
-         * Action buttons for the notification
-         */
         actions: z.ZodOptional<z.ZodArray<z.ZodObject<{
             action: z.ZodString;
             title: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            title: string;
-            action: string;
-        }, {
-            title: string;
-            action: string;
-        }>, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        title: string;
-        body: string;
-        icon?: string | undefined;
-        data?: Record<string, any> | undefined;
-        actions?: {
-            title: string;
-            action: string;
-        }[] | undefined;
-        badge?: number | undefined;
-    }, {
-        title: string;
-        body: string;
-        icon?: string | undefined;
-        data?: Record<string, any> | undefined;
-        actions?: {
-            title: string;
-            action: string;
-        }[] | undefined;
-        badge?: number | undefined;
-    }>, z.ZodObject<{
-        /**
-         * Notification title
-         */
+        }, z.core.$strip>>>;
+    }, z.core.$strip>, z.ZodObject<{
         title: z.ZodString;
-        /**
-         * Notification message content
-         */
         message: z.ZodString;
-        /**
-         * Notification severity type
-         */
-        type: z.ZodEnum<["info", "success", "warning", "error"]>;
-        /**
-         * Optional URL to navigate to when clicked
-         */
+        type: z.ZodEnum<{
+            error: "error";
+            success: "success";
+            warning: "warning";
+            info: "info";
+        }>;
         actionUrl: z.ZodOptional<z.ZodString>;
-        /**
-         * Whether the notification can be dismissed by the user
-         * @default true
-         */
         dismissible: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        /**
-         * Timestamp when notification expires (Unix milliseconds)
-         */
         expiresAt: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        message: string;
-        type: "error" | "warning" | "info" | "success";
-        title: string;
-        dismissible: boolean;
-        expiresAt?: number | undefined;
-        actionUrl?: string | undefined;
-    }, {
-        message: string;
-        type: "error" | "warning" | "info" | "success";
-        title: string;
-        expiresAt?: number | undefined;
-        actionUrl?: string | undefined;
-        dismissible?: boolean | undefined;
-    }>]>;
-    /**
-     * Recipient configuration
-     */
+    }, z.core.$strip>]>;
     recipients: z.ZodObject<{
-        /**
-         * Primary recipients
-         */
-        to: z.ZodArray<z.ZodString, "many">;
-        /**
-         * CC recipients (email only)
-         */
-        cc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-        /**
-         * BCC recipients (email only)
-         */
-        bcc: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        to: string[];
-        cc?: string[] | undefined;
-        bcc?: string[] | undefined;
-    }, {
-        to: string[];
-        cc?: string[] | undefined;
-        bcc?: string[] | undefined;
-    }>;
-    /**
-     * Scheduling configuration
-     */
+        to: z.ZodArray<z.ZodString>;
+        cc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strip>;
     schedule: z.ZodOptional<z.ZodObject<{
-        /**
-         * Scheduling type
-         */
-        type: z.ZodEnum<["immediate", "delayed", "scheduled"]>;
-        /**
-         * Delay in milliseconds (for delayed type)
-         */
+        type: z.ZodEnum<{
+            immediate: "immediate";
+            delayed: "delayed";
+            scheduled: "scheduled";
+        }>;
         delay: z.ZodOptional<z.ZodNumber>;
-        /**
-         * Scheduled send time (Unix timestamp in milliseconds)
-         */
         scheduledAt: z.ZodOptional<z.ZodNumber>;
-    }, "strip", z.ZodTypeAny, {
-        type: "immediate" | "delayed" | "scheduled";
-        delay?: number | undefined;
-        scheduledAt?: number | undefined;
-    }, {
-        type: "immediate" | "delayed" | "scheduled";
-        delay?: number | undefined;
-        scheduledAt?: number | undefined;
-    }>>;
-    /**
-     * Retry policy for failed deliveries
-     */
+    }, z.core.$strip>>;
     retryPolicy: z.ZodOptional<z.ZodObject<{
-        /**
-         * Enable automatic retries
-         * @default true
-         */
         enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        /**
-         * Maximum number of retry attempts
-         * @default 3
-         */
         maxRetries: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
-        /**
-         * Backoff strategy for retries
-         */
-        backoffStrategy: z.ZodEnum<["exponential", "linear", "fixed"]>;
-    }, "strip", z.ZodTypeAny, {
-        enabled: boolean;
-        maxRetries: number;
-        backoffStrategy: "fixed" | "linear" | "exponential";
-    }, {
-        backoffStrategy: "fixed" | "linear" | "exponential";
-        enabled?: boolean | undefined;
-        maxRetries?: number | undefined;
-    }>>;
-    /**
-     * Delivery tracking configuration
-     */
+        backoffStrategy: z.ZodEnum<{
+            fixed: "fixed";
+            linear: "linear";
+            exponential: "exponential";
+        }>;
+    }, z.core.$strip>>;
     tracking: z.ZodOptional<z.ZodObject<{
-        /**
-         * Track when emails are opened
-         * @default false
-         */
         trackOpens: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        /**
-         * Track when links are clicked
-         * @default false
-         */
         trackClicks: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-        /**
-         * Track delivery status
-         * @default true
-         */
         trackDelivery: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    }, "strip", z.ZodTypeAny, {
-        trackOpens: boolean;
-        trackClicks: boolean;
-        trackDelivery: boolean;
-    }, {
-        trackOpens?: boolean | undefined;
-        trackClicks?: boolean | undefined;
-        trackDelivery?: boolean | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    name: string;
-    id: string;
-    template: {
-        id: string;
-        body: string;
-        subject: string;
-        bodyType: "text" | "markdown" | "html";
-        variables?: string[] | undefined;
-        attachments?: {
-            url: string;
-            name: string;
-        }[] | undefined;
-    } | {
-        message: string;
-        maxLength: number;
-        id: string;
-        variables?: string[] | undefined;
-    } | {
-        title: string;
-        body: string;
-        icon?: string | undefined;
-        data?: Record<string, any> | undefined;
-        actions?: {
-            title: string;
-            action: string;
-        }[] | undefined;
-        badge?: number | undefined;
-    } | {
-        message: string;
-        type: "error" | "warning" | "info" | "success";
-        title: string;
-        dismissible: boolean;
-        expiresAt?: number | undefined;
-        actionUrl?: string | undefined;
-    };
-    channel: "push" | "email" | "webhook" | "slack" | "sms" | "in-app" | "teams";
-    recipients: {
-        to: string[];
-        cc?: string[] | undefined;
-        bcc?: string[] | undefined;
-    };
-    schedule?: {
-        type: "immediate" | "delayed" | "scheduled";
-        delay?: number | undefined;
-        scheduledAt?: number | undefined;
-    } | undefined;
-    retryPolicy?: {
-        enabled: boolean;
-        maxRetries: number;
-        backoffStrategy: "fixed" | "linear" | "exponential";
-    } | undefined;
-    tracking?: {
-        trackOpens: boolean;
-        trackClicks: boolean;
-        trackDelivery: boolean;
-    } | undefined;
-}, {
-    name: string;
-    id: string;
-    template: {
-        id: string;
-        body: string;
-        subject: string;
-        bodyType?: "text" | "markdown" | "html" | undefined;
-        variables?: string[] | undefined;
-        attachments?: {
-            url: string;
-            name: string;
-        }[] | undefined;
-    } | {
-        message: string;
-        id: string;
-        maxLength?: number | undefined;
-        variables?: string[] | undefined;
-    } | {
-        title: string;
-        body: string;
-        icon?: string | undefined;
-        data?: Record<string, any> | undefined;
-        actions?: {
-            title: string;
-            action: string;
-        }[] | undefined;
-        badge?: number | undefined;
-    } | {
-        message: string;
-        type: "error" | "warning" | "info" | "success";
-        title: string;
-        expiresAt?: number | undefined;
-        actionUrl?: string | undefined;
-        dismissible?: boolean | undefined;
-    };
-    channel: "push" | "email" | "webhook" | "slack" | "sms" | "in-app" | "teams";
-    recipients: {
-        to: string[];
-        cc?: string[] | undefined;
-        bcc?: string[] | undefined;
-    };
-    schedule?: {
-        type: "immediate" | "delayed" | "scheduled";
-        delay?: number | undefined;
-        scheduledAt?: number | undefined;
-    } | undefined;
-    retryPolicy?: {
-        backoffStrategy: "fixed" | "linear" | "exponential";
-        enabled?: boolean | undefined;
-        maxRetries?: number | undefined;
-    } | undefined;
-    tracking?: {
-        trackOpens?: boolean | undefined;
-        trackClicks?: boolean | undefined;
-        trackDelivery?: boolean | undefined;
-    } | undefined;
-}>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
 export type NotificationConfig = z.infer<typeof NotificationConfigSchema>;
 export type NotificationChannel = z.infer<typeof NotificationChannelSchema>;
 export type EmailTemplate = z.infer<typeof EmailTemplateSchema>;