@plyaz/types 1.13.3 → 1.13.4

package/dist/notifications/enums.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Notification Constants and Enums
+ *
+ * Type-level constants and enum values for the notifications system.
+ * Configuration defaults have been moved to @plyaz/config/notifications.
+ *
+ * @module notifications/enums
+ */
+/**
+ * Notification Providers
+ * Standard provider names to ensure consistency across the package
+ */
+export declare const NOTIFICATION_PROVIDERS: {
+    /** Infobip omnichannel provider (Email, SMS, WhatsApp) - PRIMARY */
+    readonly INFOBIP: "Infobip";
+    /** SendGrid email provider - FALLBACK */
+    readonly SENDGRID: "SendGrid";
+    /** Mock email provider for testing */
+    readonly MOCK_EMAIL: "MockEmail";
+    /** Mock SMS provider for testing */
+    readonly MOCK_SMS: "MockSMS";
+    /** Mock push provider for testing */
+    readonly MOCK_PUSH: "MockPush";
+};
+/**
+ * Notification Channels
+ * Available notification delivery channels
+ */
+export declare const NOTIFICATION_CHANNELS: {
+    readonly EMAIL: "email";
+    readonly SMS: "sms";
+    readonly PUSH: "push";
+};
+/**
+ * Notification Categories (FR-4.3)
+ * Determines opt-out behavior for compliance
+ */
+export declare const NOTIFICATION_CATEGORIES: {
+    /** Cannot be opted out - compliance requirement (password resets, order confirmations) */
+    readonly TRANSACTIONAL: "transactional";
+    /** User can opt-out (newsletters, promotions) */
+    readonly MARKETING: "marketing";
+    /** User can opt-out (likes, comments, follows) */
+    readonly SOCIAL: "social";
+    /** System alerts and notifications (security alerts, system status) */
+    readonly SYSTEM: "system";
+    /** Promotional offers and campaigns */
+    readonly PROMOTIONAL: "promotional";
+};
+/**
+ * Signature verification method for webhooks
+ */
+export declare enum SIGNATURE_METHOD {
+    HmacSha256 = "hmac-sha256",
+    HmacSha1 = "hmac-sha1",
+    HmacSha512 = "hmac-sha512",
+    Custom = "custom"
+}
+/**
+ * Webhook event types mapped to internal notification events
+ */
+export declare enum WEBHOOK_EVENT_TYPE {
+    Delivered = "delivered",
+    Bounced = "bounced",
+    Deferred = "deferred",
+    Dropped = "dropped",
+    Opened = "opened",
+    Clicked = "clicked",
+    SpamReport = "spam_report",
+    Unsubscribed = "unsubscribed",
+    SmsDelivered = "sms_delivered",
+    SmsFailed = "sms_failed",
+    PushDelivered = "push_delivered",
+    PushFailed = "push_failed",
+    Unknown = "unknown"
+}
+/**
+ * Webhook encryption method for PII-safe IDs
+ */
+export declare enum WEBHOOK_ENCRYPTION_METHOD {
+    /** HMAC-SHA256 hashing (recommended for IDs) */
+    HmacSha256 = "hmac-sha256",
+    /** HMAC-SHA512 hashing (stronger) */
+    HmacSha512 = "hmac-sha512",
+    /** No encryption (not recommended) */
+    None = "none"
+}
+/**
+ * Common MIME types for attachments
+ */
+export declare const MIME_TYPES: {
+    readonly PDF: "application/pdf";
+    readonly DOC: "application/msword";
+    readonly DOCX: "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
+    readonly XLS: "application/vnd.ms-excel";
+    readonly XLSX: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
+    readonly PPT: "application/vnd.ms-powerpoint";
+    readonly PPTX: "application/vnd.openxmlformats-officedocument.presentationml.presentation";
+    readonly TXT: "text/plain";
+    readonly CSV: "text/csv";
+    readonly PNG: "image/png";
+    readonly JPG: "image/jpeg";
+    readonly JPEG: "image/jpeg";
+    readonly GIF: "image/gif";
+    readonly SVG: "image/svg+xml";
+    readonly WEBP: "image/webp";
+    readonly ZIP: "application/zip";
+    readonly RAR: "application/x-rar-compressed";
+    readonly TAR: "application/x-tar";
+    readonly GZIP: "application/gzip";
+    readonly JSON: "application/json";
+    readonly XML: "application/xml";
+};
+/**
+ * Common file extensions for attachments
+ */
+export declare const FILE_EXTENSIONS: {
+    readonly PDF: ".pdf";
+    readonly DOC: ".doc";
+    readonly DOCX: ".docx";
+    readonly XLS: ".xls";
+    readonly XLSX: ".xlsx";
+    readonly PPT: ".ppt";
+    readonly PPTX: ".pptx";
+    readonly TXT: ".txt";
+    readonly CSV: ".csv";
+    readonly PNG: ".png";
+    readonly JPG: ".jpg";
+    readonly JPEG: ".jpeg";
+    readonly GIF: ".gif";
+    readonly SVG: ".svg";
+    readonly WEBP: ".webp";
+    readonly ZIP: ".zip";
+    readonly RAR: ".rar";
+    readonly TAR: ".tar";
+    readonly GZ: ".gz";
+    readonly GZIP: ".gzip";
+    readonly JSON: ".json";
+    readonly XML: ".xml";
+};