@cloudcommerce/app-loyalty-points 0.1.1

package/lib/loyalty-create-transaction.js

@@ -0,0 +1,210 @@
+import api from '@cloudcommerce/api';
+import { getFirestore } from 'firebase-admin/firestore';
+import logger from 'firebase-functions/logger';
+import getProgramId from './functions-lib/get-program-id.js';
+
+const collectionRef = getFirestore().collection('billedPoints');
+const updateTransactionStatus = (orderId) => {
+  setTimeout(async () => {
+    const order = (await api.get(`orders/${orderId}`)).data;
+    // appSdk.apiRequest(storeId, `/orders/${orderId}.json`).then(({ response }) => {
+    const { transactions } = order;
+    if (transactions) {
+      const transaction = transactions.find((transactionFound) => {
+        return transactionFound.payment_method.code === 'loyalty_points';
+      });
+      if (transaction) {
+        const bodyPaymentHistory = {
+          transaction_id: transaction._id,
+          date_time: new Date().toISOString(),
+          status: 'paid',
+          customer_notified: true,
+        }; // TODO: incompatible type=> amount and status;
+        await api.post(`orders/${orderId}/payments_history`, bodyPaymentHistory);
+      }
+    }
+  }, 500);
+};
+const handleUpdatedPoints = (
+  endpoint, // TODO: endpoint type not string compatible
+  body,
+  orderId,
+  usedPointsEntries,
+  timeout = 400,
+  isLastRequest = false,
+) => {
+  setTimeout(async () => {
+    await api.patch(endpoint, body);
+    // appSdk.apiRequest(storeId, endpoint, 'PATCH', data).then(() => {
+    logger.log(`#(App Loyalty Points): ${orderId} ${endpoint} => ${JSON.stringify(body)}`);
+    if (isLastRequest) {
+      updateTransactionStatus(orderId);
+      collectionRef.doc(orderId).set({ usedPointsEntries });
+    }
+    // });
+  }, timeout);
+};
+
+export default async (appData) => {
+  const { application, storeId } = appData;
+  const { params } = appData;
+  // app configured options
+  const appConfig = { ...application.data, ...application.hidden_data };
+  const { lang, amount } = params;
+  // setup required `transaction` response object
+  const transaction = {
+    amount: amount.total,
+  };
+  if (params.payment_method.code === 'loyalty_points') {
+    const pointsApplied = params.loyalty_points_applied;
+    const programsRules = appConfig.programs_rules;
+    if (pointsApplied && Array.isArray(programsRules) && programsRules.length) {
+      // for (const programId in pointsApplied) {
+      Object.keys(pointsApplied).forEach((programId) => {
+        const pointsValue = pointsApplied[programId];
+        if (pointsValue > 0) {
+          const programRule = programsRules.find((programRuleFound, index) => {
+            if (programRuleFound) {
+              programRuleFound.program_id = getProgramId(programRuleFound, index);
+              return programId === programRuleFound.program_id;
+            }
+            return false;
+          });
+          if (programRule) {
+            const ratio = programRule.ratio || 1;
+            transaction.loyalty_points = {
+              name: programRule.name,
+              program_id: programRule.program_id,
+              ratio,
+              points_value: programRule.max_points < pointsValue
+                ? programRule.max_points
+                : pointsValue,
+            };
+            transaction.amount = pointsValue * ratio;
+          }
+        }
+      });
+    }
+  }
+  if (transaction.amount) {
+    const loyaltyPoints = transaction.loyalty_points;
+    const customerId = params.buyer.customer_id;
+    const orderId = params.order_id;
+    const usedPointsEntries = [];
+    try {
+      const customer = (await api.get(`customers/${customerId}`)).data;
+      // return appSdk.apiRequest(storeId, `/customers/${customerId}.json`)
+      //   .then(({ response }) => {
+      const pointsEntries = customer.loyalty_points_entries;
+      let pointsToConsume = loyaltyPoints?.points_value;
+      if (pointsEntries && pointsToConsume) {
+        pointsEntries.sort((a, b) => {
+          let value = 0;
+          if (a.valid_thru && b.valid_thru) {
+            if (a.valid_thru < b.valid_thru) {
+              value = -1;
+            } else if (a.valid_thru > b.valid_thru) {
+              value = 1;
+            }
+          }
+          return value;
+        });
+        for (let i = 0; i < pointsEntries.length; i++) {
+          if (pointsToConsume <= 0) {
+            break;
+          }
+          const pointsEntry = pointsEntries[i];
+          if (pointsEntry.program_id === loyaltyPoints?.program_id) {
+            const validThru = pointsEntry.valid_thru;
+            const activePoints = pointsEntry.active_points;
+            if (activePoints > 0 && (!validThru || new Date(validThru).getTime() >= Date.now())) {
+              const pointsDiff = activePoints - pointsToConsume;
+              if (pointsDiff > 0 && pointsDiff < 0.01) {
+                pointsToConsume = activePoints;
+              }
+              if (pointsToConsume >= activePoints) {
+                pointsToConsume -= activePoints;
+                pointsEntry.active_points = 0;
+                if (pointsToConsume < 0.02) {
+                  pointsToConsume = 0;
+                }
+              } else {
+                pointsEntry.active_points -= pointsToConsume;
+                pointsToConsume = 0;
+              }
+              usedPointsEntries.push({
+                ...pointsEntry,
+                original_active_points: activePoints,
+              });
+            }
+          }
+        }
+        if (pointsToConsume <= 0) {
+          if (usedPointsEntries.length <= 3) {
+            usedPointsEntries.forEach((pointsEntry, i) => {
+              /* Obs:
+                              Store api v2 => loyalty_points_entries do not have id,
+                              but change can be done by index
+                            */
+              const endpoint = `customers/${customerId}/loyalty_points_entries/${i}`;
+              const body = {
+                active_points: pointsEntry.active_points,
+              };
+              handleUpdatedPoints(endpoint, body, orderId, usedPointsEntries, (i + 1) * 400, i + 1 === usedPointsEntries.length);
+            });
+          } else {
+            const endpoint = `customers/${customerId}`;
+            const body = {
+              loyalty_points_entries: pointsEntries,
+            };
+            handleUpdatedPoints(endpoint, body, orderId, usedPointsEntries, 400, true);
+          }
+        }
+      }
+      transaction.status = {
+        current: pointsToConsume && pointsToConsume <= 0 ? 'authorized' : 'unauthorized',
+      };
+      return {
+        status: 200,
+        redirect_to_payment: false,
+        transaction,
+      };
+    } catch (error) {
+      // try to debug request error
+      const errCode = 'POINTS_TRANSACTION_ERR';
+      let { message } = error;
+      const err = {
+        message: `CREATE_TRANSACTION_ERR #${storeId} - ${orderId} => ${message}`,
+        payment: '',
+        status: 0,
+        response: '',
+        usedPointsEntries,
+      };
+      if (error.response) {
+        const { status, data } = error.response;
+        err.status = status;
+        if (status !== 401 && status !== 403) {
+          if (typeof data === 'object' && data) {
+            err.response = JSON.stringify(data);
+          } else {
+            err.response = data;
+          }
+        }
+        if (data && data.user_message) {
+          message = lang ? data.user_message[lang] : data.user_message.en_us;
+        }
+      }
+      logger.error(err);
+      return {
+        error: errCode,
+        message,
+      };
+    }
+  }
+  return {
+    status: 200,
+    redirect_to_payment: false,
+    transaction,
+  };
+};
+// # sourceMappingURL=loyalty-create-transaction.js.map

package/lib/loyalty-create-transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-create-transaction.js","sourceRoot":"","sources":["../src/loyalty-create-transaction.ts"],"names":[],"mappings":"AAMA,OAAO,GAAG,MAAM,oBAAoB,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,YAAY,MAAM,gCAAgC,CAAC;AAK1D,MAAM,aAAa,GAAG,YAAY,EAAE,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;AAEhE,MAAM,uBAAuB,GAAG,CAAC,OAAe,EAAE,EAAE;IAClD,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAExD,iFAAiF;QACjF,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;QAC/B,IAAI,YAAY,EAAE;YAChB,MAAM,WAAW,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,EAAE;gBACzD,OAAO,gBAAgB,CAAC,cAAc,CAAC,IAAI,KAAK,gBAAgB,CAAC;YACnE,CAAC,CAAC,CAAC;YACH,IAAI,WAAW,EAAE;gBACf,MAAM,kBAAkB,GAAG;oBACzB,cAAc,EAAE,WAAW,CAAC,GAAG;oBAC/B,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;oBACnC,MAAM,EAAE,MAAM;oBACd,iBAAiB,EAAE,IAAI;iBACjB,CAAC,CAAC,+CAA+C;gBACzD,MAAM,GAAG,CAAC,IAAI,CAAC,UAAU,OAAO,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;aAC1E;SACF;IACH,CAAC,EAAE,GAAG,CAAC,CAAC;AACV,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAC1B,QAAa,EAAE,4CAA4C;AAC3D,IAA0B,EAC1B,OAAe,EACf,iBAAuC,EACvC,OAAO,GAAG,GAAG,EACb,aAAa,GAAG,KAAK,EACrB,EAAE;IACF,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAChC,mEAAmE;QACnE,MAAM,CAAC,GAAG,CAAC,0BAA0B,OAAO,IAAI,QAAQ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvF,IAAI,aAAa,EAAE;YACjB,uBAAuB,CAAC,OAAO,CAAC,CAAC;YACjC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC;SACvD;QACD,MAAM;IACR,CAAC,EAAE,OAAO,CAAC,CAAC;AACd,CAAC,CAAC;AAEF,eAAe,KAAK,EAAE,OAAsB,EAAE,EAAE;IAC9C,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IACzC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAiC,CAAC;IACzD,yBAAyB;IACzB,MAAM,SAAS,GAAG,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;IACtE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;IAEhC,+CAA+C;IAC/C,MAAM,WAAW,GAA6C;QAC5D,MAAM,EAAE,MAAM,CAAC,KAAK;KACrB,CAAC;IAEF,IAAI,MAAM,CAAC,cAAc,CAAC,IAAI,KAAK,gBAAgB,EAAE;QACnD,MAAM,aAAa,GAAG,MAAM,CAAC,sBAAsB,CAAC;QACpD,MAAM,aAAa,GAAG,SAAS,CAAC,cAAc,CAAC;QAC/C,IAAI,aAAa,IAAI,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE;YACzE,2CAA2C;YAC3C,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC/C,MAAM,WAAW,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;gBAC7C,IAAI,WAAW,GAAG,CAAC,EAAE;oBACnB,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC,gBAAgB,EAAE,KAAK,EAAE,EAAE;wBACjE,IAAI,gBAAgB,EAAE;4BACpB,gBAAgB,CAAC,UAAU,GAAG,YAAY,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;4BACpE,OAAO,SAAS,KAAK,gBAAgB,CAAC,UAAU,CAAC;yBAClD;wBACD,OAAO,KAAK,CAAC;oBACf,CAAC,CAAC,CAAC;oBAEH,IAAI,WAAW,EAAE;wBACf,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC;wBACrC,WAAW,CAAC,cAAc,GAAG;4BAC3B,IAAI,EAAE,WAAW,CAAC,IAAI;4BACtB,UAAU,EAAE,WAAW,CAAC,UAAU;4BAClC,KAAK;4BACL,YAAY,EAAE,WAAW,CAAC,UAAU,GAAG,WAAW;gCAChD,CAAC,CAAC,WAAW,CAAC,UAAU;gCACxB,CAAC,CAAC,WAAW;yBAChB,CAAC;wBACF,WAAW,CAAC,MAAM,GAAG,WAAW,GAAG,KAAK,CAAC;qBAC1C;iBACF;YACH,CAAC,CAAC,CAAC;SACJ;KACF;IAED,IAAI,WAAW,CAAC,MAAM,EAAE;QACtB,MAAM,aAAa,GAAG,WAAW,CAAC,cAAc,CAAC;QACjD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC;QAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,QAAkB,CAAC;QAC1C,MAAM,iBAAiB,GAAwB,EAAE,CAAC;QAClD,IAAI;YACF,MAAM,QAAQ,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,aAAa,UAAU,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;YACjE,qEAAqE;YACrE,8BAA8B;YAC9B,MAAM,aAAa,GAAG,QAAQ,CAAC,sBAAsB,CAAC;YACtD,IAAI,eAAe,GAAG,aAAa,EAAE,YAAY,CAAC;YAElD,IAAI,aAAa,IAAI,eAAe,EAAE;gBACpC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;oBAC1B,IAAI,KAAK,GAAG,CAAC,CAAC;oBACd,IAAI,CAAC,CAAC,UAAU,IAAI,CAAC,CAAC,UAAU,EAAE;wBAChC,IAAI,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,EAAE;4BAC/B,KAAK,GAAG,CAAC,CAAC,CAAC;yBACZ;6BAAM,IAAI,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,EAAE;4BACtC,KAAK,GAAG,CAAC,CAAC;yBACX;qBACF;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBAEH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;oBAC7C,IAAI,eAAe,IAAI,CAAC,EAAE;wBACxB,MAAM;qBACP;oBACD,MAAM,WAAW,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;oBACrC,IAAI,WAAW,CAAC,UAAU,KAAK,aAAa,EAAE,UAAU,EAAE;wBACxD,MAAM,SAAS,GAAG,WAAW,CAAC,UAAU,CAAC;wBACzC,MAAM,YAAY,GAAG,WAAW,CAAC,aAAa,CAAC;wBAC/C,IAAI,YAAY,GAAG,CAAC,IAAI,CAAC,CAAC,SAAS,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE;4BACnF,MAAM,UAAU,GAAG,YAAY,GAAG,eAAe,CAAC;4BAClD,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,IAAI,EAAE;gCACvC,eAAe,GAAG,YAAY,CAAC;6BAChC;4BACD,IAAI,eAAe,IAAI,YAAY,EAAE;gCACnC,eAAe,IAAI,YAAY,CAAC;gCAChC,WAAW,CAAC,aAAa,GAAG,CAAC,CAAC;gCAC9B,IAAI,eAAe,GAAG,IAAI,EAAE;oCAC1B,eAAe,GAAG,CAAC,CAAC;iCACrB;6BACF;iCAAM;gCACL,WAAW,CAAC,aAAa,IAAI,eAAe,CAAC;gCAC7C,eAAe,GAAG,CAAC,CAAC;6BACrB;4BACD,iBAAiB,CAAC,IAAI,CAAC;gCACrB,GAAG,WAAW;gCACd,sBAAsB,EAAE,YAAY;6BACrC,CAAC,CAAC;yBACJ;qBACF;iBACF;gBAED,IAAI,eAAe,IAAI,CAAC,EAAE;oBACxB,IAAI,iBAAiB,CAAC,MAAM,IAAI,CAAC,EAAE;wBACjC,iBAAiB,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE,EAAE;4BAC3C;;;8BAGE;4BACF,MAAM,QAAQ,GAAG,aAAa,UAAU,2BAA2B,CAAC,EAAE,CAAC;4BACvE,MAAM,IAAI,GAAG;gCACX,aAAa,EAAE,WAAW,CAAC,aAAa;6BACzC,CAAC;4BACF,mBAAmB,CACjB,QAAQ,EACR,IAAI,EACJ,OAAO,EACP,iBAAiB,EACjB,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,EACb,CAAC,GAAG,CAAC,KAAK,iBAAiB,CAAC,MAAM,CACnC,CAAC;wBACJ,CAAC,CAAC,CAAC;qBACJ;yBAAM;wBACL,MAAM,QAAQ,GAAG,aAAa,UAAU,EAAE,CAAC;wBAC3C,MAAM,IAAI,GAAG;4BACX,sBAAsB,EAAE,aAAa;yBACtC,CAAC;wBACF,mBAAmB,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,iBAAiB,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;qBAC5E;iBACF;aACF;YAED,WAAW,CAAC,MAAM,GAAG;gBACnB,OAAO,EAAE,eAAe,IAAI,eAAe,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,cAAc;aACjF,CAAC;YAEF,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,mBAAmB,EAAE,KAAK;gBAC1B,WAAW;aACZ,CAAC;SACH;QAAC,OAAO,KAAU,EAAE;YACnB,6BAA6B;YAC7B,MAAM,OAAO,GAAG,wBAAwB,CAAC;YACzC,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;YACxB,MAAM,GAAG,GAAG;gBACV,OAAO,EAAE,2BAA2B,OAAO,MAAM,OAAO,OAAO,OAAO,EAAE;gBACxE,OAAO,EAAE,EAAE;gBACX,MAAM,EAAE,CAAC;gBACT,QAAQ,EAAE,EAAE;gBACZ,iBAAiB;aAClB,CAAC;YAEF,IAAI,KAAK,CAAC,QAAQ,EAAE;gBAClB,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC;gBACxC,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;gBACpB,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE;oBACpC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,EAAE;wBACpC,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;qBACrC;yBAAM;wBACL,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC;qBACrB;iBACF;gBACD,IAAI,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE;oBAC7B,OAAO,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;iBACpE;aACF;YAED,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAElB,OAAO;gBACL,KAAK,EAAE,OAAO;gBACd,OAAO;aACR,CAAC;SACH;KACF;IAED,OAAO;QACL,MAAM,EAAE,GAAG;QACX,mBAAmB,EAAE,KAAK;QAC1B,WAAW;KACZ,CAAC;AACJ,CAAC,CAAC"}

package/lib/loyalty-list-payments.d.ts

@@ -0,0 +1,3 @@
+import type { AppModuleBody, ListPaymentsResponse } from '@cloudcommerce/types';
+declare const _default: (data: AppModuleBody) => ListPaymentsResponse;
+export default _default;

package/lib/loyalty-list-payments.js

@@ -0,0 +1,44 @@
+import getProgramId from './functions-lib/get-program-id.js';
+
+export default (data) => {
+  const { application } = data;
+  const { params } = data;
+  const appData = {
+    ...application.data,
+    ...application.hidden_data,
+  };
+    // const { storeId } = req
+    // setup basic required response object
+  const response = {
+    payment_gateways: [],
+  };
+  const label = params.lang === 'pt_br' || !params.lang
+    ? 'Pontos de fidelidade'
+    : 'Loyalty points';
+  response.payment_gateways.push({
+    type: 'payment',
+    payment_method: {
+      code: 'loyalty_points',
+      name: label,
+    },
+    label,
+  });
+  if (Array.isArray(appData.programs_rules)) {
+    const pointsPrograms = {};
+    appData.programs_rules.forEach((programRule, index) => {
+      const programId = getProgramId(programRule, index);
+      pointsPrograms[programId] = {
+        name: programRule.name,
+        ratio: programRule.ratio || 1,
+        max_points: programRule.max_points,
+        min_subtotal_to_earn: programRule.min_subtotal_to_earn,
+        earn_percentage: programRule.earn_percentage,
+      };
+    });
+    if (Object.keys(pointsPrograms).length) {
+      response.loyalty_points_programs = pointsPrograms;
+    }
+  }
+  return response;
+};
+// # sourceMappingURL=loyalty-list-payments.js.map

package/lib/loyalty-list-payments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-list-payments.js","sourceRoot":"","sources":["../src/loyalty-list-payments.ts"],"names":[],"mappings":"AAKA,OAAO,YAAY,MAAM,gCAAgC,CAAC;AAE1D,eAAe,CAAC,IAAmB,EAAE,EAAE;IACrC,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,MAA4B,CAAC;IAEjD,MAAM,OAAO,GAAG;QACd,GAAG,WAAW,CAAC,IAAI;QACnB,GAAG,WAAW,CAAC,WAAW;KAC3B,CAAC;IAEF,0BAA0B;IAC1B,uCAAuC;IACvC,MAAM,QAAQ,GAAyB;QACrC,gBAAgB,EAAE,EAAE;KACrB,CAAC;IAEF,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI;QACnD,CAAC,CAAC,sBAAsB;QACxB,CAAC,CAAC,gBAAgB,CAAC;IAErB,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAC7B,IAAI,EAAE,SAAS;QACf,cAAc,EAAE;YACd,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,KAAK;SACZ;QACD,KAAK;KACN,CAAC,CAAC;IAEH,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE;QACzC,MAAM,cAAc,GAAG,EAAE,CAAC;QAC1B,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,KAAK,EAAE,EAAE;YACpD,MAAM,SAAS,GAAG,YAAY,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;YACnD,cAAc,CAAC,SAAS,CAAC,GAAG;gBAC1B,IAAI,EAAE,WAAW,CAAC,IAAI;gBACtB,KAAK,EAAE,WAAW,CAAC,KAAK,IAAI,CAAC;gBAC7B,UAAU,EAAE,WAAW,CAAC,UAAU;gBAClC,oBAAoB,EAAE,WAAW,CAAC,oBAAoB;gBACtD,eAAe,EAAE,WAAW,CAAC,eAAe;aAC7C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE;YACtC,QAAQ,CAAC,uBAAuB,GAAG,cAAc,CAAC;SACnD;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}

package/lib/loyalty-points-events.d.ts

@@ -0,0 +1,4 @@
+import '@cloudcommerce/firebase/lib/init';
+export declare const loyaltypoints: {
+    onStoreEvent: any;
+};

package/lib/loyalty-points-events.js

@@ -0,0 +1,28 @@
+/* eslint-disable import/prefer-default-export */
+import '@cloudcommerce/firebase/lib/init';
+import { createAppEventsFunction } from '@cloudcommerce/firebase/lib/helpers/pubsub';
+import logger from 'firebase-functions/logger';
+import handleLoyaltyPointsEvent from './functions-lib/handle-loyalty-points-event.js';
+
+const handleApiEvent = async ({
+  evName, apiEvent, apiDoc, app,
+}) => {
+  const resourceId = apiEvent.resource_id;
+  logger.info('>> ', resourceId, ' - Action: ', apiEvent.action);
+  const key = `${evName}_${resourceId}`;
+  const appData = { ...app.data, ...app.hidden_data };
+  const programRules = appData.programs_rules;
+  if ((Array.isArray(appData.ignore_events)
+        && appData.ignore_events.includes(evName))
+        || (!Array.isArray(programRules) || !programRules.length)) {
+    logger.info('>> ', key, ' - Ignored event');
+    return null;
+  }
+  logger.info(`> Webhook ${resourceId} [${evName}]`);
+  return handleLoyaltyPointsEvent(apiDoc, programRules);
+};
+
+export const loyaltypoints = {
+  onStoreEvent: createAppEventsFunction('loyaltyPoints', handleApiEvent),
+};
+// # sourceMappingURL=loyalty-points-events.js.map

package/lib/loyalty-points-events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-points-events.js","sourceRoot":"","sources":["../src/loyalty-points-events.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,OAAO,kCAAkC,CAAC;AAE1C,OAAO,EACL,uBAAuB,GAExB,MAAM,4CAA4C,CAAC;AACpD,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,wBAAwB,MAAM,6CAA6C,CAAC;AAEnF,MAAM,cAAc,GAAoB,KAAK,EAAE,EAC7C,MAAM,EACN,QAAQ,EACR,MAAM,EACN,GAAG,GACJ,EAAE,EAAE;IACH,MAAM,UAAU,GAAG,QAAQ,CAAC,WAAW,CAAC;IACxC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,aAAa,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/D,MAAM,GAAG,GAAG,GAAG,MAAM,IAAI,UAAU,EAAE,CAAC;IACtC,MAAM,OAAO,GAAG,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;IACpD,MAAM,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;IAE5C,IACE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC;WAChC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;WACzC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EACzD;QACA,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,kBAAkB,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;KACb;IACD,MAAM,CAAC,IAAI,CAAC,aAAa,UAAU,KAAK,MAAM,GAAG,CAAC,CAAC;IAEnD,OAAO,wBAAwB,CAAC,MAAgB,EAAE,YAAY,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,YAAY,EAAE,uBAAuB,CACnC,eAAe,EACf,cAAc,CACR;CACT,CAAC"}

package/lib/loyalty-points.d.ts

@@ -0,0 +1,77 @@
+import '@cloudcommerce/firebase/lib/init';
+import type { AppModuleBody } from '@cloudcommerce/types';
+export declare const listPayments: (modBody: AppModuleBody) => Promise<import("@cloudcommerce/types").ListPaymentsResponse>;
+export declare const createTransaction: (modBody: AppModuleBody) => Promise<{
+    status: number;
+    redirect_to_payment: boolean;
+    transaction: {
+        payment_link?: string | undefined;
+        payment_instructions?: string | undefined;
+        intermediator?: {
+            transaction_id?: string | undefined;
+            transaction_code?: string | undefined;
+            transaction_reference?: string | undefined;
+            payment_method?: {
+                code: string;
+                name?: string | undefined;
+            } | undefined;
+            buyer_id?: string | undefined;
+        } | undefined;
+        credit_card?: {
+            holder_name?: string | undefined;
+            avs_result_code?: string | null | undefined;
+            cvv_result_code?: string | null | undefined;
+            bin?: number | undefined;
+            company?: string | undefined;
+            last_digits?: string | undefined;
+            token?: string | undefined;
+            error_code?: "incorrect_number" | "invalid_number" | "invalid_expiry_date" | "invalid_cvc" | "expired_card" | "incorrect_cvc" | "incorrect_zip" | "incorrect_address" | "card_declined" | "processing_error" | "call_issuer" | "pick_up_card" | undefined;
+        } | undefined;
+        banking_billet?: {
+            code?: string | undefined;
+            valid_thru?: string | undefined;
+            text_lines?: string[] | undefined;
+            link?: string | undefined;
+        } | undefined;
+        loyalty_points?: {
+            name?: string | undefined;
+            program_id: string;
+            points_value: number;
+            ratio?: number | undefined;
+        } | undefined;
+        currency_id?: string | undefined;
+        currency_symbol?: string | undefined;
+        discount?: number | undefined;
+        amount: number;
+        installments?: {
+            number: number;
+            value?: number | undefined;
+            tax?: boolean | undefined;
+            total?: number | undefined;
+        } | undefined;
+        creditor_fees?: {
+            installment?: number | undefined;
+            operational?: number | undefined;
+            intermediation?: number | undefined;
+            other?: number | undefined;
+        } | undefined;
+        status?: {
+            updated_at?: string | undefined;
+            current: "authorized" | "unauthorized" | "pending" | "under_analysis" | "paid" | "in_dispute" | "refunded" | "voided" | "unknown";
+        } | undefined;
+        flags?: string[] | undefined;
+        custom_fields?: {
+            field: string;
+            value: string;
+        }[] | undefined;
+        notes?: string | undefined;
+    };
+    error?: undefined;
+    message?: undefined;
+} | {
+    error: string;
+    message: any;
+    status?: undefined;
+    redirect_to_payment?: undefined;
+    transaction?: undefined;
+}>;

package/lib/loyalty-points.js

@@ -0,0 +1,12 @@
+import '@cloudcommerce/firebase/lib/init';
+import handleListPayments from './loyalty-list-payments.js';
+import handleCreateTransaction from './loyalty-create-transaction.js';
+
+export const listPayments = async (modBody) => {
+  return handleListPayments(modBody);
+};
+
+export const createTransaction = async (modBody) => {
+  return handleCreateTransaction(modBody);
+};
+// # sourceMappingURL=loyalty-points.js.map

package/lib/loyalty-points.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loyalty-points.js","sourceRoot":"","sources":["../src/loyalty-points.ts"],"names":[],"mappings":"AAAA,OAAO,kCAAkC,CAAC;AAE1C,OAAO,kBAAkB,MAAM,yBAAyB,CAAC;AACzD,OAAO,uBAAuB,MAAM,8BAA8B,CAAC;AAEnE,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;IAC3D,OAAO,kBAAkB,CAAC,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;IAChE,OAAO,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAC1C,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@cloudcommerce/app-loyalty-points",
+  "type": "module",
+  "version": "0.1.1",
+  "description": "E-Com Plus Cloud Commerce app to handle simple loyalty points programs",
+  "main": "lib/loyalty-points.js",
+  "exports": {
+    ".": "./lib/loyalty-points.js",
+    "./events": "./lib/loyalty-points-events.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ecomplus/cloud-commerce.git",
+    "directory": "packages/loyalty-points"
+  },
+  "author": "E-Com Club Softwares para E-commerce <ti@e-com.club>",
+  "license": "Apache 2.0 with Commons Clause",
+  "bugs": {
+    "url": "https://github.com/ecomplus/cloud-commerce/issues"
+  },
+  "homepage": "https://github.com/ecomplus/cloud-commerce/tree/main/packages/apps/loyalty-points#readme",
+  "dependencies": {
+    "@cloudcommerce/api": "0.1.1",
+    "@cloudcommerce/firebase": "0.1.1"
+  },
+  "devDependencies": {
+    "@cloudcommerce/types": "0.1.1"
+  },
+  "scripts": {
+    "build": "sh ../../../scripts/build-lib.sh"
+  }
+}

package/src/functions-lib/get-program-id.ts

@@ -0,0 +1,23 @@
+export default (
+  programRule: { program_id: string; name: string; },
+  index: number,
+) => {
+  let programId = `lpt__${index}`;
+  if (programRule.program_id) {
+    programId = programRule.program_id;
+  } else if (programRule.name && typeof programRule.name === 'string') {
+    programId = (`p0_${programRule.name.toLowerCase()}`)
+      .replace(/\n\s/g, '_')
+      .replace(/__/g, '_')
+      .replace(/áàãâ/g, 'a')
+      .replace(/éê/g, 'e')
+      .replace(/óõô/g, 'o')
+      .replace(/í/g, 'e')
+      .replace(/ú/g, 'u')
+      .replace(/ç/g, 'c')
+      .replace(/[^a-z0-9_]/g, '')
+      .substring(0, 30);
+  }
+
+  return programId;
+};

package/src/functions-lib/handle-loyalty-points-event.ts

@@ -0,0 +1,207 @@
+import type { Orders, Customers } from '@cloudcommerce/types';
+import api from '@cloudcommerce/api';
+import { getFirestore } from 'firebase-admin/firestore';
+import logger from 'firebase-functions/logger';
+import getProgramId from './get-program-id';
+
+const ECHO_SUCCESS = 'SUCCESS';
+const ECHO_SKIP = 'SKIP';
+
+type UsedPointsEntries = Exclude<Customers['loyalty_points_entries'], undefined>[number]
+  & { original_active_points: number }
+
+const responsePubSub = (response: string) => {
+  logger.log('(App: Loyalty Points): ', response);
+  return null;
+};
+
+const haveEarnedPoints = (pointsList: Customers['loyalty_points_entries'], orderId: string) => {
+  if (pointsList) {
+    let hasEarned = false;
+    for (let i = 0; i < pointsList.length; i++) {
+      const point = pointsList[i];
+      if (point.order_id === orderId) {
+        hasEarned = true;
+        break;
+      }
+    }
+    return hasEarned;
+  }
+  return false;
+};
+
+const findPointIndex = (pointsList: Customers['loyalty_points_entries'], pointEntry: UsedPointsEntries) => {
+  if (pointsList) {
+    for (let i = 0; i < pointsList.length; i++) {
+      const point = pointsList[i];
+      if (point.name === pointEntry.name) {
+        return i;
+      }
+    }
+  }
+  return null;
+};
+
+const handleLoyaltyPointsEvent = async (
+  order: Orders,
+  programRules: any[],
+) => {
+  const orderId = order._id;
+  const currentStatus = order.financial_status && order.financial_status.current;
+  let isPaid: boolean = false;
+  let isCancelled: boolean = false;
+
+  switch (currentStatus) {
+    case 'paid':
+      isPaid = true;
+      break;
+    case 'unauthorized':
+    case 'partially_refunded':
+    case 'refunded':
+    case 'voided':
+      isCancelled = true;
+      break;
+    case 'partially_paid':
+      if (order.transactions) {
+        order.transactions.forEach((transaction) => {
+          if (transaction.payment_method.code !== 'loyalty_points' && transaction.status) {
+            switch (transaction.status.current) {
+              case 'unauthorized':
+              case 'refunded':
+              case 'voided':
+                isCancelled = true;
+                break;
+              default:
+                break;
+            }
+          }
+        });
+      }
+      break;
+    default:
+      break;
+  }
+
+  try {
+    if (isPaid || isCancelled) {
+      // get app configured options
+      const { amount, buyers } = order;
+      const customerId = buyers && buyers[0] && buyers[0]._id;
+      if (customerId) {
+        const pointsList: Customers['loyalty_points_entries'] = (await api.get(
+          `customers/${customerId}/loyalty_points_entries`,
+        )
+        ).data;
+
+        if (pointsList) {
+          const hasEarnedPoints = haveEarnedPoints(pointsList, orderId);
+
+          if (isPaid && !hasEarnedPoints) {
+            for (let i = 0; i < programRules.length; i++) {
+              const rule = programRules[i];
+              if (amount.subtotal) {
+                if (!rule.min_subtotal_to_earn || rule.min_subtotal_to_earn <= amount.subtotal) {
+                  const pointsValue = ((rule.earn_percentage || 1) / 100)
+                    * (amount.subtotal - (amount.discount || 0));
+
+                  let validThru: string | undefined;
+                  if (rule.expiration_days > 0) {
+                    const d = new Date();
+                    d.setDate(d.getDate() + rule.expiration_days);
+                    validThru = d.toISOString();
+                  }
+
+                  const data = {
+                    name: rule.name,
+                    program_id: getProgramId(rule, i),
+                    earned_points: pointsValue,
+                    active_points: pointsValue,
+                    ratio: rule.ratio || 1,
+                    valid_thru: validThru,
+                    order_id: orderId,
+                  } as any; // TODO: set the correct type
+
+                  // eslint-disable-next-line no-await-in-loop
+                  await api.post(`customers/${customerId}/loyalty_points_entries`, data);
+
+                  return responsePubSub(ECHO_SUCCESS);
+                }
+              }
+            }
+          }
+
+          if (isCancelled && hasEarnedPoints) {
+            for (let i = 0; i < pointsList.length; i++) {
+              if (pointsList[i].order_id === orderId) {
+                // eslint-disable-next-line no-await-in-loop
+                await api.delete(`customers/${customerId}/loyalty_points_entries/${i}`);
+              }
+            }
+
+            return responsePubSub(ECHO_SUCCESS);
+          }
+        }
+
+        if (isCancelled) {
+          const documentRef = getFirestore().doc(`billedPoints/${orderId}`);
+          const documentSnapshot = await documentRef.get();
+
+          if (documentSnapshot.exists) {
+            const usedPointsEntries = documentSnapshot.get('usedPointsEntries') as UsedPointsEntries[];
+            documentRef.delete();
+
+            if (Array.isArray(usedPointsEntries)) {
+              for (let i = 0; i < usedPointsEntries.length; i++) {
+                const pointsEntry = usedPointsEntries[i];
+                const pointsToRefund = pointsEntry.original_active_points
+                  - pointsEntry.active_points;
+                if (pointsToRefund > 0) {
+                  const pointIndex = findPointIndex(pointsList, pointsEntry);
+
+                  if (pointIndex && pointsList) {
+                    const activePoints = pointsList[pointIndex].active_points;
+                    const body = {
+                      active_points: activePoints + pointsToRefund,
+                    };
+
+                    // eslint-disable-next-line no-await-in-loop
+                    await api.patch(
+                      `customers/${customerId}/loyalty_points_entries/${pointIndex}`,
+                      body,
+                    );
+
+                    return responsePubSub(ECHO_SUCCESS);
+                  }
+                }
+              }
+
+              const transaction = order.transactions
+                && order.transactions.find((transactionFound) => {
+                  return transactionFound.payment_method.code === 'loyalty_points';
+                });
+
+              if (transaction) {
+                const bodyPaymentHistory = {
+                  transaction_id: transaction._id,
+                  date_time: new Date().toISOString(),
+                  status: currentStatus?.startsWith('partially') ? 'refunded' : currentStatus,
+                  customer_notified: true,
+                } as any; // TODO: incompatible type=> amount and status
+
+                await api.post(`orders/${orderId}/payments_history`, bodyPaymentHistory);
+              }
+            }
+          }
+        }
+      }
+      return responsePubSub('');
+    }
+    // not paid nor cancelled
+    return responsePubSub(ECHO_SKIP);
+  } catch (err) {
+    logger.error('(App Loyalty Points) Error =>', err);
+    throw err;
+  }
+};
+
+export default handleLoyaltyPointsEvent;