@instockng/api-client 1.0.6 → 1.0.8

package/dist/apps/backend/src/notifications/producers/meta-capi-producer.js

@@ -0,0 +1,180 @@
+/**
+ * Meta Conversions API Event Producer
+ *
+ * Queues Meta CAPI events for processing by the queue consumer.
+ */
+import { generateEventId } from '../../lib/meta-capi';
+/**
+ * Queue an AddToCart event
+ */
+export async function enqueueAddToCartEvent(env, data) {
+    if (!env.META_CAPI_QUEUE) {
+        console.warn('[Meta CAPI] Queue not configured, skipping AddToCart event');
+        return;
+    }
+    if (!data.pixelId) {
+        console.log('[Meta CAPI] No pixel ID, skipping AddToCart event');
+        return;
+    }
+    const message = {
+        pixelId: data.pixelId,
+        eventName: 'AddToCart',
+        eventId: generateEventId('cart', data.cartId, `item_${data.itemId}`),
+        eventTime: Math.floor(Date.now() / 1000),
+        eventSourceUrl: `${data.brandSiteUrl}/product/${data.productSlug}`,
+        userData: {
+            email: data.customerEmail || undefined,
+            phone: data.customerPhone || undefined,
+            clientIpAddress: data.clientIpAddress,
+            clientUserAgent: data.clientUserAgent,
+            fbc: data.fbc,
+            fbp: data.fbp,
+        },
+        customData: {
+            value: data.price * data.quantity, // Total value
+            currency: 'NGN',
+            contents: [{
+                    id: data.sku,
+                    quantity: data.quantity,
+                    item_price: data.price,
+                }],
+            contentName: data.productName,
+            contentType: 'product',
+            numItems: data.quantity,
+        },
+    };
+    await env.META_CAPI_QUEUE.send(message);
+    console.log(`[Meta CAPI] Queued AddToCart event: ${message.eventId}`);
+}
+/**
+ * Queue an InitiateCheckout event
+ */
+export async function enqueueInitiateCheckoutEvent(env, data) {
+    if (!env.META_CAPI_QUEUE) {
+        console.warn('[Meta CAPI] Queue not configured, skipping InitiateCheckout event');
+        return;
+    }
+    if (!data.pixelId) {
+        console.log('[Meta CAPI] No pixel ID, skipping InitiateCheckout event');
+        return;
+    }
+    const message = {
+        pixelId: data.pixelId,
+        eventName: 'InitiateCheckout',
+        eventId: generateEventId('cart', data.cartId, 'checkout'),
+        eventTime: Math.floor(Date.now() / 1000),
+        eventSourceUrl: `${data.brandSiteUrl}/checkout`,
+        userData: {
+            email: data.customerEmail || undefined,
+            phone: data.customerPhone || undefined,
+            clientIpAddress: data.clientIpAddress,
+            clientUserAgent: data.clientUserAgent,
+            fbc: data.fbc,
+            fbp: data.fbp,
+        },
+        customData: {
+            value: data.cartTotal,
+            currency: 'NGN',
+            numItems: data.itemCount,
+        },
+    };
+    await env.META_CAPI_QUEUE.send(message);
+    console.log(`[Meta CAPI] Queued InitiateCheckout event: ${message.eventId}`);
+}
+/**
+ * Queue a Purchase event from an order
+ *
+ * For orders with multiple products, uses the brand's homepage
+ * since there's no single product page to reference.
+ */
+export async function enqueuePurchaseEvent(env, order, options) {
+    if (!env.META_CAPI_QUEUE) {
+        console.warn('[Meta CAPI] Queue not configured, skipping Purchase event');
+        return;
+    }
+    const pixelId = order.brand.metaPixelId;
+    if (!pixelId) {
+        console.log('[Meta CAPI] No pixel ID for brand, skipping Purchase event');
+        return;
+    }
+    const message = {
+        pixelId,
+        eventName: 'Purchase',
+        eventId: generateEventId('order', order.id),
+        eventTime: Math.floor(Date.now() / 1000),
+        // Use brand homepage for multi-product orders
+        eventSourceUrl: order.brand.siteUrl,
+        userData: {
+            email: order.email || undefined,
+            phone: order.phone,
+            firstName: order.firstName,
+            lastName: order.lastName,
+            city: order.city,
+            state: order.deliveryZone.state.name,
+            country: 'ng', // Nigeria
+            clientIpAddress: options?.clientIpAddress,
+            clientUserAgent: options?.clientUserAgent,
+            fbc: options?.fbc,
+            fbp: options?.fbp,
+        },
+        customData: {
+            value: Number(order.totalPrice),
+            currency: 'NGN',
+            contents: order.items.map((item) => ({
+                id: item.variant.sku,
+                quantity: item.quantity,
+                item_price: Number(item.priceAtPurchase),
+            })),
+            contentType: 'product',
+            numItems: order.items.reduce((sum, item) => sum + item.quantity, 0),
+        },
+    };
+    await env.META_CAPI_QUEUE.send(message);
+    console.log(`[Meta CAPI] Queued Purchase event: ${message.eventId}`);
+}
+/**
+ * Queue a ConfirmedPurchase event when order is delivered & paid
+ *
+ * This event tracks successful order completion (delivered + paid),
+ * which is a higher value conversion signal than initial purchase.
+ */
+export async function enqueueConfirmedPurchaseEvent(env, order) {
+    if (!env.META_CAPI_QUEUE) {
+        console.warn('[Meta CAPI] Queue not configured, skipping ConfirmedPurchase event');
+        return;
+    }
+    const pixelId = order.brand.metaPixelId;
+    if (!pixelId) {
+        console.log('[Meta CAPI] No pixel ID for brand, skipping ConfirmedPurchase event');
+        return;
+    }
+    const message = {
+        pixelId,
+        eventName: 'ConfirmedPurchase',
+        eventId: generateEventId('order', order.id, 'confirmed'),
+        eventTime: Math.floor(Date.now() / 1000),
+        eventSourceUrl: order.brand.siteUrl,
+        userData: {
+            email: order.email || undefined,
+            phone: order.phone,
+            firstName: order.firstName,
+            lastName: order.lastName,
+            city: order.city,
+            state: order.deliveryZone.state.name,
+            country: 'ng', // Nigeria
+        },
+        customData: {
+            value: Number(order.totalPrice),
+            currency: 'NGN',
+            contents: order.items.map((item) => ({
+                id: item.variant.sku,
+                quantity: item.quantity,
+                item_price: Number(item.priceAtPurchase),
+            })),
+            contentType: 'product',
+            numItems: order.items.reduce((sum, item) => sum + item.quantity, 0),
+        },
+    };
+    await env.META_CAPI_QUEUE.send(message);
+    console.log(`[Meta CAPI] Queued ConfirmedPurchase event: ${message.eventId}`);
+}

package/dist/apps/backend/src/notifications/producers/order-notification.d.ts

@@ -0,0 +1,9 @@
+import type { Env } from '../../types';
+export type OrderNotificationType = 'order_confirmation' | 'order_shipped' | 'order_delivered' | 'order_cancelled';
+export type MessageType = {
+    messageType: 'order_notification';
+    type: OrderNotificationType;
+    orderId: string;
+    timestamp: string;
+};
+export declare function enqueueOrderNotification(env: Env, type: OrderNotificationType, orderId: string): Promise<void>;

package/dist/apps/backend/src/notifications/producers/order-notification.js

@@ -0,0 +1,18 @@
+export async function enqueueOrderNotification(env, type, orderId) {
+    if (env.WHATSAPP_QUEUE) {
+        await env.WHATSAPP_QUEUE.send({
+            messageType: 'order_notification',
+            type,
+            orderId,
+            timestamp: new Date().toISOString(),
+        });
+    }
+    if (env.EMAIL_QUEUE) {
+        await env.EMAIL_QUEUE.send({
+            messageType: 'order_notification',
+            type,
+            orderId,
+            timestamp: new Date().toISOString(),
+        });
+    }
+}

package/dist/apps/backend/src/notifications/producers/prospect-recovery-notification.d.ts

@@ -0,0 +1,10 @@
+import type { Env } from '../../types';
+export type ProspectRecoveryNotificationType = 'prospect_recovery_reminder' | 'prospect_recovery' | 'prospect_recovery_final';
+export type MessageType = {
+    messageType: 'prospect_recovery';
+    type: ProspectRecoveryNotificationType;
+    orderId: string;
+    attemptNumber: number;
+    timestamp: string;
+};
+export declare function enqueueProspectRecoveryNotification(env: Env, type: ProspectRecoveryNotificationType, orderId: string, attemptNumber: number): Promise<void>;

package/dist/apps/backend/src/notifications/producers/prospect-recovery-notification.js

@@ -0,0 +1,11 @@
+export async function enqueueProspectRecoveryNotification(env, type, orderId, attemptNumber) {
+    if (env.EMAIL_QUEUE) {
+        await env.EMAIL_QUEUE.send({
+            messageType: 'prospect_recovery',
+            type,
+            orderId,
+            attemptNumber,
+            timestamp: new Date().toISOString(),
+        });
+    }
+}