cloudcommerce 0.2.2 → 0.3.0

package/packages/apps/fb-conversions/src/fb-conversions-events.ts

@@ -1,5 +1,5 @@
 /* eslint-disable import/prefer-default-export */
-import type { Orders } from '@cloudcommerce/types';
+import type { Carts, Customers, Orders } from '@cloudcommerce/types';
 import {
   createAppEventsFunction,
   ApiEventHandler,
@@ -7,13 +7,17 @@ import {
 import logger from 'firebase-functions/logger';
 import {
   Content,
-  CustomData,
-  DeliveryCategory,
   EventRequest,
-  UserData,
-  ServerEvent,
   FacebookAdsApi,
+  UserData,
 } from 'facebook-nodejs-business-sdk';
+import api from '@cloudcommerce/api';
+import {
+  createContent,
+  createCustonData,
+  createServeEvent,
+  createUserData,
+} from './functions-lib/create-fb-objects';
 
 const handleApiEvent: ApiEventHandler = async ({
   evName,
@@ -34,140 +38,184 @@ const handleApiEvent: ApiEventHandler = async ({
   }
   logger.info(`> Webhook ${resourceId} [${evName}]`);
 
-  const order = apiDoc as Orders;
-  if (order.status === 'cancelled') {
-    return null;
-  }
-  const orderId = order._id;
-
-  let eventID: undefined | string;
-  let clientUserAgent: undefined | string;
-  if (order.metafields) {
-    const metafield = order.metafields.find(({ namespace, field }) => {
-      return namespace === 'fb' && field === 'pixel';
-    });
-    if (metafield) {
-      const { value } = metafield;
-      eventID = value.eventID as string;
-      clientUserAgent = value.userAgent as string;
-    }
-  }
-  if (!clientUserAgent) {
-    clientUserAgent = order.client_user_agent;
-  }
+  const fbPixelId = appData.fb_pixel_id;
+  const fbGraphToken = appData.fb_graph_token;
 
-  try {
-    const buyer = order.buyers && order.buyers[0];
-    const clientIp = order.client_ip;
-    if (orderId && buyer && clientIp) {
-      // https://developers.facebook.com/docs/marketing-api/conversions-api/using-the-api#send
-      const fbPixelId = appData.fb_pixel_id;
-      const fbGraphToken = appData.fb_graph_token;
-
-      if (fbPixelId && fbGraphToken) {
-        FacebookAdsApi.init(fbGraphToken);
-
-        const userData = new UserData();
-        userData.setExternalId(buyer._id);
-        const emails: string[] = [];
-        buyer.emails?.forEach((email) => {
-          emails.push(email.address);
-        });
+  if (fbPixelId && fbGraphToken) {
+    FacebookAdsApi.init(fbGraphToken);
 
-        if (buyer.main_email) {
-          emails.push(buyer.main_email);
-        }
-        if (emails.length) {
-          userData.setEmails(emails);
-        }
-        if (buyer.phones && buyer.phones.length) {
-          userData.setPhones(buyer.phones.map(({ number }) => String(number)));
-        }
-        if (buyer.name && buyer.name.given_name) {
-          userData.setFirstName(buyer.name.given_name);
-          if (buyer.name.family_name) {
-            userData.setLastName(buyer.name.family_name);
-          }
-        }
-        if (buyer.pronoun === 'she' || buyer.pronoun === 'he') {
-          userData.setGender(buyer.pronoun === 'she' ? 'f' : 'm');
-        }
-        userData.setClientIpAddress(clientIp);
-        if (clientUserAgent) {
-          userData.setClientUserAgent(clientUserAgent);
+    if (evName === 'orders-new') {
+      const order = apiDoc as Orders;
+      if (order.status === 'cancelled') {
+        return null;
+      }
+      const orderId = order._id;
+
+      let eventID: undefined | string;
+      let clientUserAgent: undefined | string;
+      if (order.metafields) {
+        const metafield = order.metafields.find(({ namespace, field }) => {
+          return namespace === 'fb' && field === 'pixel';
+        });
+        if (metafield) {
+          const { value } = metafield;
+          eventID = value.eventID as string;
+          clientUserAgent = value.userAgent as string;
         }
-        const shippingLine = order.shipping_lines && order.shipping_lines[0];
-        if (shippingLine && shippingLine.to.zip) {
-          userData.setZip(shippingLine.to.zip.replace(/\D/g, ''));
-          if (shippingLine.to.province_code) {
-            userData.setState(shippingLine.to.province_code.toLowerCase());
-            userData.setCountry((shippingLine.to.country_code || 'BR').toLowerCase());
+      }
+      if (!clientUserAgent) {
+        clientUserAgent = order.client_user_agent;
+      }
+
+      try {
+        const buyer = order.buyers && order.buyers[0];
+        const clientIp = order.client_ip;
+        if (orderId && buyer && clientIp) {
+          // https://developers.facebook.com/docs/marketing-api/conversions-api/using-the-api#send
+
+          const userData = createUserData(buyer, clientIp);
+
+          const shippingLine = order.shipping_lines && order.shipping_lines[0];
+          if (shippingLine && shippingLine.to.zip) {
+            userData.setZip(shippingLine.to.zip.replace(/\D/g, ''));
+            if (shippingLine.to.province_code) {
+              userData.setState(shippingLine.to.province_code.toLowerCase());
+              userData.setCountry((shippingLine.to.country_code || 'BR').toLowerCase());
+            }
           }
-        }
 
-        const contents: any[] = [];
-        const { items } = order;
-        if (items && items.length) {
-          items.forEach((item) => {
-            if (item.quantity > 0) {
-              const content = (new Content())
-                .setId(item.sku || item.product_id)
-                .setQuantity(item.quantity)
-                .setDeliveryCategory(DeliveryCategory.HOME_DELIVERY);
-              if (item.name) {
-                content.setTitle(item.name);
+          const contents: Content[] = [];
+          const { items } = order;
+          if (items && items.length) {
+            items.forEach((item) => {
+              if (item.quantity > 0) {
+                const content = createContent(item);
+                contents.push(content);
               }
-              contents.push(content);
-            }
-          });
-        }
-        const customData = (new CustomData())
-          .setContents(contents)
-          .setCurrency((order.currency_id && order.currency_id.toLowerCase()) || 'brl')
-          .setValue(Math.round(order.amount.total * 100) / 100);
-
-        const eventMs = Math.min(
-          new Date(order.created_at || apiEvent.timestamp).getTime(),
-          Date.now() - 3000,
-        );
-        logger.log(`>> (App fb-conversions): #${orderId} (${eventID}) at ${eventMs}ms`);
-
-        const serverEvent = (new ServerEvent())
-          .setEventName('Purchase')
-          .setEventTime(Math.round(eventMs / 1000))
-          .setUserData(userData)
-          .setCustomData(customData)
-          .setActionSource('website');
-
-        if (order.checkout_link) {
-          serverEvent.setEventSourceUrl(order.checkout_link);
-        } else if (order.domain) {
-          serverEvent.setEventSourceUrl(`https://${order.domain}`);
+            });
+          }
+          const customData = createCustonData(contents, order.amount.total, order.currency_id);
+
+          const eventMs = Math.min(
+            new Date(order.created_at || apiEvent.timestamp).getTime(),
+            Date.now() - 3000,
+          );
+          logger.log(`>> #${orderId} (${eventID}) at ${eventMs}ms`);
+
+          let eventSourceUrl: string | undefined;
+          if (order.checkout_link) {
+            eventSourceUrl = order.checkout_link;
+          } else if (order.domain) {
+            eventSourceUrl = `https://${order.domain}`;
+          }
+
+          const serverEvent = createServeEvent(
+            'Purchase',
+            eventMs,
+            userData,
+            customData,
+            eventID || orderId,
+            eventSourceUrl,
+          );
+
+          const eventsData = [serverEvent];
+          const eventRequest = (new EventRequest(fbGraphToken, fbPixelId))
+            .setEvents(eventsData);
+
+          try {
+            const response = await eventRequest.execute();
+            logger.info('>>Event sent: ', response);
+            return null;
+          } catch (err: any) {
+            logger.error(`Event request error: ${err.message} =>`, err);
+            return null;
+          }
         }
-        serverEvent.setEventId(eventID || orderId);
+        logger.warn('>> OrderId , buyer or clientIp not found');
+        return null;
+      } catch (err: any) {
+        logger.error(`>>Error ${err.message} =>`, err);
+        throw err;
+      }
+    } else {
+      const cart = apiDoc as Carts;
 
-        const eventsData = [serverEvent];
-        const eventRequest = (new EventRequest(fbGraphToken, fbPixelId))
-          .setEvents(eventsData);
+      if (cart.completed) {
+        return null;
+      }
 
+      const eventMs = Math.min(
+        new Date(cart.created_at || apiEvent.timestamp).getTime(),
+        Date.now() - 3000,
+      );
+      logger.log(`#${cart._id} at ${eventMs}ms`);
+      let customer: Customers | undefined;
+      if (cart.customers && cart.customers.length > 0) {
         try {
-          const response = await eventRequest.execute();
-          logger.info('>> (App fb-conversions): ', response);
-          return null;
-        } catch (err: any) {
-          logger.error(`(App fb-conversions): event request error: ${err.message} =>`, err);
-          return null;
+          customer = (await api.get(`customers/${cart.customers[0]}`)).data;
+        } catch (err) {
+          logger.error('>> Error getting customer => ', err);
+        }
+      }
+
+      let userData: UserData | undefined;
+      let address: Exclude<Customers['addresses'], undefined>[number] | undefined;
+      if (customer) {
+        userData = createUserData(customer);
+        if (customer.addresses && customer.addresses.length > 0) {
+          [address] = customer.addresses;
         }
       }
-      logger.warn('>> (App fb-conversions): PixelId or fbToken not found');
-      return null;
+
+      if (address && address.zip && userData) {
+        userData.setZip(address.zip.replace(/\D/g, ''));
+        if (address.province_code) {
+          userData.setState(address.province_code.toLowerCase());
+          userData.setCountry((address.country_code || 'BR').toLowerCase());
+        }
+      }
+
+      const contents: Content[] = [];
+      const { items } = cart;
+      if (items && items.length) {
+        items.forEach((item) => {
+          if (item.quantity > 0) {
+            const content = createContent(item);
+            contents.push(content);
+          }
+        });
+      }
+      const customData = createCustonData(contents, cart.subtotal || 0);
+
+      let eventSourceUrl: string | undefined;
+      if (cart.permalink) {
+        eventSourceUrl = cart.permalink;
+      }
+      const serverEvent = createServeEvent(
+        'InitiateCheckout',
+        eventMs,
+        userData,
+        customData,
+        cart._id,
+        eventSourceUrl,
+      );
+
+      const eventsData = [serverEvent];
+      const eventRequest = (new EventRequest(fbGraphToken, fbPixelId))
+        .setEvents(eventsData);
+
+      try {
+        const response = await eventRequest.execute();
+        logger.info('>> Event sent: ', response);
+        return null;
+      } catch (err: any) {
+        logger.error(`Event request error: ${err.message} =>`, err);
+        return null;
+      }
     }
-    logger.warn('>> (App fb-conversions): orderId , buyer or clientIp not found');
-    return null;
-  } catch (err: any) {
-    logger.error(`>> (App fb-conversions) Error ${err.message} =>`, err);
-    throw err;
   }
+  logger.warn('>> PixelId or fbToken not found');
+  return null;
 };
 
 export const fbconversions = {

package/packages/apps/fb-conversions/src/functions-lib/create-fb-objects.ts

@@ -0,0 +1,104 @@
+/* eslint-disable import/no-import-module-exports */
+import type { Orders, Carts } from '@cloudcommerce/types';
+import {
+  Content,
+  CustomData,
+  DeliveryCategory,
+  UserData,
+  ServerEvent,
+} from 'facebook-nodejs-business-sdk';
+
+type Item = Exclude<Orders['items'], undefined>[number] |
+  Exclude<Carts['items'], undefined>[number]
+
+const createContent = (item: Item) => {
+  const content = (new Content())
+    .setId(item.sku || item.product_id)
+    .setQuantity(item.quantity)
+    .setDeliveryCategory(DeliveryCategory.HOME_DELIVERY);
+  if (item.name) {
+    content.setTitle(item.name);
+  }
+
+  return content;
+};
+
+const createCustonData = (
+  contents: Content[],
+  total: number,
+  currencyId?: string,
+) => {
+  const customData = (new CustomData())
+    .setContents(contents)
+    .setCurrency((currencyId && currencyId.toLowerCase()) || 'brl')
+    .setValue(Math.round(total * 100) / 100)
+    .setNumItems(contents.length);
+
+  return customData;
+};
+
+const createUserData = (
+  customer,
+  clientIp?: string,
+) => {
+  const userData = new UserData();
+  userData.setExternalId(customer._id);
+  const emails = customer.emails || [];
+  if (customer.main_email) {
+    emails.push({ address: customer.main_email });
+  }
+  if (emails.length) {
+    userData.setEmails(emails.map(({ address }) => address));
+  }
+  if (customer.phones && customer.phones.length) {
+    userData.setPhones(customer.phones.map(({ number }) => String(number)));
+  }
+  if (customer.name && customer.name.given_name) {
+    userData.setFirstName(customer.name.given_name);
+    if (customer.name.family_name) {
+      userData.setLastName(customer.name.family_name);
+    }
+  }
+  if (customer.gender === 'f' || customer.gender === 'm') {
+    userData.setGender(customer.gender);
+  }
+
+  if (clientIp) {
+    userData.setClientIpAddress(clientIp);
+  }
+
+  return userData;
+};
+
+const createServeEvent = (
+  eventName: string,
+  eventTimeMs: number,
+  userData: UserData | undefined,
+  customData: CustomData,
+  eventId: string,
+  eventSourceUrl?: string,
+) => {
+  const serverEvent = (new ServerEvent())
+    .setEventName(eventName)
+    .setEventTime(Math.round(eventTimeMs / 1000))
+    .setCustomData(customData)
+    .setActionSource('website');
+
+  if (userData) {
+    serverEvent.setUserData(userData);
+  }
+
+  if (eventSourceUrl) {
+    serverEvent.setEventSourceUrl(eventSourceUrl);
+  }
+  serverEvent.setEventId(eventId);
+
+  return serverEvent;
+};
+
+export {
+  createContent,
+  createCustonData,
+  createServeEvent,
+  createUserData,
+};

package/packages/apps/frenet/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/app-frenet",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "E-Com Plus Cloud Commerce app for Frenet shipping calculation",
   "main": "lib/frenet.js",
   "exports": {
@@ -25,7 +25,7 @@
   "dependencies": {
     "@cloudcommerce/api": "workspace:*",
     "@cloudcommerce/firebase": "workspace:*",
-    "axios": "^1.2.3",
+    "axios": "^1.2.6",
     "firebase-admin": "^11.5.0",
     "firebase-functions": "^4.2.0"
   },

package/packages/apps/galaxpay/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/app-galaxpay",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "E-Com Plus Cloud Commerce app to integrate Galax Pay for recurring payments",
   "main": "lib/galaxpay.js",
   "exports": {
@@ -25,7 +25,7 @@
   "dependencies": {
     "@cloudcommerce/api": "workspace:*",
     "@cloudcommerce/firebase": "workspace:*",
-    "axios": "^1.2.3",
+    "axios": "^1.2.6",
     "firebase-admin": "^11.5.0",
     "firebase-functions": "^4.2.0"
   },

package/packages/apps/google-analytics/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/app-google-analytics",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "E-Com Plus Cloud Commerce app to send carts/orders events to GA Measurement Protocol",
   "main": "lib/index.js",
   "repository": {
@@ -21,7 +21,7 @@
   "dependencies": {
     "@cloudcommerce/api": "workspace:*",
     "@cloudcommerce/firebase": "workspace:*",
-    "axios": "^1.2.3",
+    "axios": "^1.2.6",
     "firebase-admin": "^11.5.0",
     "firebase-functions": "^4.2.0"
   },

package/packages/apps/infinitepay/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/app-infinitepay",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "E-Com Plus Cloud Commerce app to integrate InfinitePay",
   "main": "lib/infinitepay.js",
   "exports": {
@@ -25,7 +25,7 @@
   "dependencies": {
     "@cloudcommerce/api": "workspace:*",
     "@cloudcommerce/firebase": "workspace:*",
-    "axios": "^1.2.3",
+    "axios": "^1.2.6",
     "crypto-js": "^4.1.1",
     "firebase-admin": "^11.5.0",
     "firebase-functions": "^4.2.0"

package/packages/apps/jadlog/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/app-jadlog",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "E-Com Plus Cloud Commerce  app for Jadlog shipping calculation",
   "main": "lib/index.js",
   "repository": {
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@cloudcommerce/api": "workspace:*",
-    "axios": "^1.2.3"
+    "axios": "^1.2.6"
   },
   "devDependencies": {
     "@cloudcommerce/types": "workspace:*"

package/packages/apps/loyalty-points/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cloudcommerce/app-loyalty-points",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "E-Com Plus Cloud Commerce app to handle simple loyalty points programs",
   "main": "lib/loyalty-points.js",
   "exports": {

package/packages/apps/melhor-envio/CHANGELOG.md

@@ -0,0 +1 @@
+Please refer to GitHub [repository releases](https://github.com/ecomplus/cloud-commerce/releases) or monorepo unified [CHANGELOG.md](https://github.com/ecomplus/cloud-commerce/blob/main/CHANGELOG.md).

package/packages/apps/melhor-envio/README.md

@@ -0,0 +1 @@
+# `@cloudcommerce/app-melhor-envio`

package/packages/apps/melhor-envio/events.js

@@ -0,0 +1 @@
+export * from './lib/melhor-envio-events';

package/packages/apps/melhor-envio/lib/functions-lib/database.d.ts

@@ -0,0 +1,18 @@
+import { Timestamp } from 'firebase-admin/firestore';
+export type Lable = {
+    id: string;
+    labelId: string;
+    status: string;
+    resourceId: string;
+    createdAt: Timestamp;
+    updateAt?: string;
+};
+declare const db: {
+    searchLabel: (resourceId: string) => Promise<Lable | null>;
+    saveLabel: (labelId: string, status: string, resourceId: string) => Promise<unknown>;
+    getAllLabels: () => Promise<Lable[]>;
+    updateLabel: (status: string, labelId: string) => Promise<boolean>;
+    deleteLabel: (id: string) => Promise<boolean>;
+    clearLabels: () => Promise<boolean>;
+};
+export default db;