@plyaz/types 1.13.17 → 1.14.1

package/dist/notifications/webhooks.schemas.d.ts

@@ -0,0 +1,278 @@
+/**
+ * Webhook Validation Schemas
+ *
+ * Zod schemas for validating webhook payloads from notification providers
+ * Provider-specific webhook event structures
+ *
+ * @module notifications/webhooks.schemas
+ */
+import { z } from 'zod';
+/**
+ * Infobip Email Status schema
+ */
+export declare const InfobipEmailStatusSchema: z.ZodObject<{
+    groupId: z.ZodOptional<z.ZodNumber>;
+    groupName: z.ZodOptional<z.ZodString>;
+    id: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    action: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Infobip Error Info schema
+ */
+export declare const InfobipErrorInfoSchema: z.ZodObject<{
+    groupId: z.ZodOptional<z.ZodNumber>;
+    groupName: z.ZodOptional<z.ZodString>;
+    id: z.ZodOptional<z.ZodNumber>;
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    permanent: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+/**
+ * Infobip Price Info schema
+ */
+export declare const InfobipPriceInfoSchema: z.ZodObject<{
+    pricePerMessage: z.ZodOptional<z.ZodNumber>;
+    currency: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Infobip Delivery Result schema
+ */
+export declare const InfobipDeliveryResultSchema: z.ZodObject<{
+    messageId: z.ZodOptional<z.ZodString>;
+    to: z.ZodOptional<z.ZodString>;
+    bulkId: z.ZodOptional<z.ZodString>;
+    sentAt: z.ZodOptional<z.ZodString>;
+    doneAt: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodObject<{
+        groupId: z.ZodOptional<z.ZodNumber>;
+        groupName: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodNumber>;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        action: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    error: z.ZodOptional<z.ZodObject<{
+        groupId: z.ZodOptional<z.ZodNumber>;
+        groupName: z.ZodOptional<z.ZodString>;
+        id: z.ZodOptional<z.ZodNumber>;
+        name: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        permanent: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    attemptCount: z.ZodOptional<z.ZodNumber>;
+    timeToFirstAttempt: z.ZodOptional<z.ZodNumber>;
+    sendingIp: z.ZodOptional<z.ZodString>;
+    price: z.ZodOptional<z.ZodObject<{
+        pricePerMessage: z.ZodOptional<z.ZodNumber>;
+        currency: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    smsCount: z.ZodOptional<z.ZodNumber>;
+    browserLink: z.ZodOptional<z.ZodString>;
+    applicationId: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    campaignReferenceId: z.ZodOptional<z.ZodString>;
+    callbackData: z.ZodOptional<z.ZodString>;
+}, z.core.$loose>;
+/**
+ * Infobip Delivery Webhook Payload schema
+ */
+export declare const InfobipDeliveryWebhookSchema: z.ZodObject<{
+    results: z.ZodArray<z.ZodObject<{
+        messageId: z.ZodOptional<z.ZodString>;
+        to: z.ZodOptional<z.ZodString>;
+        bulkId: z.ZodOptional<z.ZodString>;
+        sentAt: z.ZodOptional<z.ZodString>;
+        doneAt: z.ZodOptional<z.ZodString>;
+        status: z.ZodOptional<z.ZodObject<{
+            groupId: z.ZodOptional<z.ZodNumber>;
+            groupName: z.ZodOptional<z.ZodString>;
+            id: z.ZodOptional<z.ZodNumber>;
+            name: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            action: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        error: z.ZodOptional<z.ZodObject<{
+            groupId: z.ZodOptional<z.ZodNumber>;
+            groupName: z.ZodOptional<z.ZodString>;
+            id: z.ZodOptional<z.ZodNumber>;
+            name: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            permanent: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+        attemptCount: z.ZodOptional<z.ZodNumber>;
+        timeToFirstAttempt: z.ZodOptional<z.ZodNumber>;
+        sendingIp: z.ZodOptional<z.ZodString>;
+        price: z.ZodOptional<z.ZodObject<{
+            pricePerMessage: z.ZodOptional<z.ZodNumber>;
+            currency: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        smsCount: z.ZodOptional<z.ZodNumber>;
+        browserLink: z.ZodOptional<z.ZodString>;
+        applicationId: z.ZodOptional<z.ZodString>;
+        entityId: z.ZodOptional<z.ZodString>;
+        campaignReferenceId: z.ZodOptional<z.ZodString>;
+        callbackData: z.ZodOptional<z.ZodString>;
+    }, z.core.$loose>>;
+}, z.core.$strip>;
+/**
+ * Infobip Geo Location schema
+ */
+export declare const InfobipGeoLocationSchema: z.ZodObject<{
+    countryName: z.ZodOptional<z.ZodString>;
+    countryCode: z.ZodOptional<z.ZodString>;
+    regionName: z.ZodOptional<z.ZodString>;
+    city: z.ZodOptional<z.ZodString>;
+    latitude: z.ZodOptional<z.ZodNumber>;
+    longitude: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+/**
+ * Infobip Recipient Info schema
+ */
+export declare const InfobipRecipientInfoSchema: z.ZodObject<{
+    messageId: z.ZodOptional<z.ZodNumber>;
+    to: z.ZodOptional<z.ZodString>;
+    requestId: z.ZodOptional<z.ZodString>;
+    sentDateTime: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+/**
+ * Infobip Tracking Event schema
+ */
+export declare const InfobipTrackingEventSchema: z.ZodObject<{
+    messageId: z.ZodOptional<z.ZodNumber>;
+    bulkId: z.ZodOptional<z.ZodString>;
+    recipient: z.ZodOptional<z.ZodString>;
+    sender: z.ZodOptional<z.ZodString>;
+    domain: z.ZodOptional<z.ZodString>;
+    notificationType: z.ZodOptional<z.ZodString>;
+    eventId: z.ZodOptional<z.ZodString>;
+    sendDateTime: z.ZodOptional<z.ZodNumber>;
+    url: z.ZodOptional<z.ZodString>;
+    applicationId: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    campaignReferenceId: z.ZodOptional<z.ZodString>;
+    callbackData: z.ZodOptional<z.ZodString>;
+    geoLocation: z.ZodOptional<z.ZodObject<{
+        countryName: z.ZodOptional<z.ZodString>;
+        countryCode: z.ZodOptional<z.ZodString>;
+        regionName: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        latitude: z.ZodOptional<z.ZodNumber>;
+        longitude: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+    recipientInfo: z.ZodOptional<z.ZodObject<{
+        messageId: z.ZodOptional<z.ZodNumber>;
+        to: z.ZodOptional<z.ZodString>;
+        requestId: z.ZodOptional<z.ZodString>;
+        sentDateTime: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/**
+ * Infobip Tracking Webhook Payload schema
+ * Note: Tracking webhooks send a single event object, not an array
+ */
+export declare const InfobipTrackingWebhookSchema: z.ZodObject<{
+    messageId: z.ZodOptional<z.ZodNumber>;
+    bulkId: z.ZodOptional<z.ZodString>;
+    recipient: z.ZodOptional<z.ZodString>;
+    sender: z.ZodOptional<z.ZodString>;
+    domain: z.ZodOptional<z.ZodString>;
+    notificationType: z.ZodOptional<z.ZodString>;
+    eventId: z.ZodOptional<z.ZodString>;
+    sendDateTime: z.ZodOptional<z.ZodNumber>;
+    url: z.ZodOptional<z.ZodString>;
+    applicationId: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodString>;
+    campaignReferenceId: z.ZodOptional<z.ZodString>;
+    callbackData: z.ZodOptional<z.ZodString>;
+    geoLocation: z.ZodOptional<z.ZodObject<{
+        countryName: z.ZodOptional<z.ZodString>;
+        countryCode: z.ZodOptional<z.ZodString>;
+        regionName: z.ZodOptional<z.ZodString>;
+        city: z.ZodOptional<z.ZodString>;
+        latitude: z.ZodOptional<z.ZodNumber>;
+        longitude: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+    recipientInfo: z.ZodOptional<z.ZodObject<{
+        messageId: z.ZodOptional<z.ZodNumber>;
+        to: z.ZodOptional<z.ZodString>;
+        requestId: z.ZodOptional<z.ZodString>;
+        sentDateTime: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/**
+ * SendGrid Event schema
+ */
+export declare const SendGridEventSchema: z.ZodObject<{
+    email: z.ZodString;
+    timestamp: z.ZodNumber;
+    event: z.ZodEnum<{
+        open: "open";
+        click: "click";
+        delivered: "delivered";
+        deferred: "deferred";
+        dropped: "dropped";
+        spam_report: "spam_report";
+        processed: "processed";
+        bounce: "bounce";
+        unsubscribe: "unsubscribe";
+        group_unsubscribe: "group_unsubscribe";
+        group_resubscribe: "group_resubscribe";
+    }>;
+    sg_event_id: z.ZodString;
+    sg_message_id: z.ZodString;
+    notification_id: z.ZodOptional<z.ZodString>;
+    recipient_id: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    response: z.ZodOptional<z.ZodString>;
+    useragent: z.ZodOptional<z.ZodString>;
+    ip: z.ZodOptional<z.ZodString>;
+    asm_group_id: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>;
+/**
+ * SendGrid Webhook Payload schema (array of events)
+ */
+export declare const SendGridWebhookSchema: z.ZodArray<z.ZodObject<{
+    email: z.ZodString;
+    timestamp: z.ZodNumber;
+    event: z.ZodEnum<{
+        open: "open";
+        click: "click";
+        delivered: "delivered";
+        deferred: "deferred";
+        dropped: "dropped";
+        spam_report: "spam_report";
+        processed: "processed";
+        bounce: "bounce";
+        unsubscribe: "unsubscribe";
+        group_unsubscribe: "group_unsubscribe";
+        group_resubscribe: "group_resubscribe";
+    }>;
+    sg_event_id: z.ZodString;
+    sg_message_id: z.ZodString;
+    notification_id: z.ZodOptional<z.ZodString>;
+    recipient_id: z.ZodOptional<z.ZodString>;
+    category: z.ZodOptional<z.ZodString>;
+    url: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodString>;
+    response: z.ZodOptional<z.ZodString>;
+    useragent: z.ZodOptional<z.ZodString>;
+    ip: z.ZodOptional<z.ZodString>;
+    asm_group_id: z.ZodOptional<z.ZodNumber>;
+}, z.core.$loose>>;
+export type InfobipWebhookEmailStatus = z.infer<typeof InfobipEmailStatusSchema>;
+export type InfobipWebhookErrorInfo = z.infer<typeof InfobipErrorInfoSchema>;
+export type InfobipWebhookPriceInfo = z.infer<typeof InfobipPriceInfoSchema>;
+export type InfobipWebhookDeliveryResult = z.infer<typeof InfobipDeliveryResultSchema>;
+export type InfobipWebhookDeliveryPayload = z.infer<typeof InfobipDeliveryWebhookSchema>;
+export type InfobipWebhookGeoLocation = z.infer<typeof InfobipGeoLocationSchema>;
+export type InfobipWebhookRecipientInfo = z.infer<typeof InfobipRecipientInfoSchema>;
+export type InfobipWebhookTrackingEvent = z.infer<typeof InfobipTrackingEventSchema>;
+export type InfobipWebhookTrackingPayload = z.infer<typeof InfobipTrackingWebhookSchema>;
+export type SendGridWebhookEvent = z.infer<typeof SendGridEventSchema>;
+export type SendGridWebhookPayload = z.infer<typeof SendGridWebhookSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.13.17",
+  "version": "1.14.1",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",
@@ -194,7 +194,8 @@
   "dependencies": {
     "pino": "^10.0.0",
     "type-fest": "^4.41.0",
-    "zustand": "^5.0.0"
+    "zustand": "^5.0.0",
+    "zod": "^4.1.5"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.5",
@@ -255,8 +256,7 @@
     "tsup": "8.5.0",
     "typescript": "^5",
     "typescript-eslint": "^8.34.0",
-    "vitest": "3.2.4",
-    "zod": "^3.25.64"
+    "vitest": "3.2.4"
   },
   "peerDependenciesMeta": {
     "react": {