@cloudcommerce/app-paghiper 0.2.2

package/src/functions-lib/handle-webhook.ts

@@ -0,0 +1,176 @@
+import type { Orders } from '@cloudcommerce/types';
+import type { Request, Response } from 'firebase-functions';
+import api from '@cloudcommerce/api';
+import logger from 'firebase-functions/logger';
+import { Endpoint } from '@cloudcommerce/api/lib/types';
+import config from '@cloudcommerce/firebase/lib/config';
+import Axios from './create-axios';
+
+const { apps } = config.get();
+
+const CLIENT_ERR = 'invalidClient';
+
+const listOrdersByTransaction = async (transactionCode: string) => {
+  let filters = `?transactions.intermediator.transaction_id=${transactionCode}`;
+  filters += '&fields=_id,transactions._id,';
+  filters += 'transactions.app,transactions.intermediator,transactions.status';
+
+  // send and return authenticated Store API request
+  const { result } = (await api.get(`/orders${filters}` as Endpoint)).data;
+  return result as Orders[];
+};
+
+const readNotification = async (readNotificationBody: { [x: string]: any }, isPix?: boolean) => {
+  // read full notification body from PagHiper API
+  // https://dev.paghiper.com/reference#qq
+  // returns request promise
+  const endpoint = `/${(isPix ? 'invoice' : 'transaction')}/notification/`;
+  const { data } = await Axios(isPix).post(endpoint, readNotificationBody);
+  return data;
+};
+
+export default async (req: Request, res: Response) => {
+  const { body } = req;
+  const isPix = Boolean(req.params.pix);
+  // handle PagHiper notification request
+  // https://dev.paghiper.com/reference#qq
+  const transactionCode = (body && body.transaction_id);
+  if (!transactionCode) {
+    return res.sendStatus(400);
+  }
+
+  logger.log(`> Paghiper notification for ${transactionCode}`);
+  // const docRef = (await collectionSubscription.doc(transactionCode).get()).data();
+  const Apps = (await api.get(
+    `applications?app_id=${apps.pagHiper.appId}&fields=hidden_data`,
+  )).data.result;
+  const configApp = Apps[0].hidden_data?.paghiper_api_key;
+  try {
+    if (configApp.paghiper_token && configApp.paghiper_api_key === body.apiKey) {
+      // list order IDs for respective transaction code
+      const orders = await listOrdersByTransaction(transactionCode);
+      const paghiperResponse = await readNotification(
+        { ...body, token: configApp.paghiper_token },
+        isPix,
+      );
+
+      const handleNotification = async (isRetry?: boolean) => {
+        let { status } = paghiperResponse.status_request;
+        logger.log(`PagHiper ${transactionCode} -> '${status}'`);
+        switch (status) {
+          case 'pending':
+          case 'paid':
+          case 'refunded':
+            // is the same
+            break;
+          case 'canceled':
+            status = 'voided';
+            break;
+          case 'processing':
+            status = 'under_analysis';
+            break;
+          case 'reserved':
+            // https://atendimento.paghiper.com/hc/pt-br/articles/360016177713
+            status = 'authorized';
+            break;
+          default:
+            // ignore unknow status
+            return true;
+        }
+
+        try {
+          // change transaction status on E-Com Plus API
+          const notificationCode = body.notification_id;
+          orders.forEach(async ({ _id, transactions }) => {
+            let transactionId: string | undefined;
+            if (transactions) {
+              transactions.forEach((transaction) => {
+                const { app, intermediator } = transaction;
+                if (intermediator && intermediator.transaction_id === String(transactionCode)) {
+                  if (transaction.status) {
+                    if (
+                      transaction.status.current === status
+                      || (status === 'pending' && transaction.status.current === 'paid')
+                    ) {
+                      // ignore old/duplicated notification
+                      return;
+                    }
+                  }
+                  if (app && app.intermediator && app.intermediator.code !== 'paghiper') {
+                    return;
+                  }
+                  transactionId = transaction._id;
+                }
+              });
+            }
+
+            let bodyPaymentHistory: { [x: string]: any };
+
+            if (typeof status === 'object' && status !== null) {
+              // request body object sent as 'status' function param
+              bodyPaymentHistory = status;
+            } else {
+              bodyPaymentHistory = {
+                date_time: new Date().toISOString(),
+                status,
+              };
+              if (notificationCode) {
+                bodyPaymentHistory.notification_code = notificationCode;
+              }
+              if (typeof transactionId === 'string' && /^[a-f0-9]{24}$/.test(transactionId)) {
+                bodyPaymentHistory.transaction_id = transactionId;
+              }
+            }
+            await api.post(`orders/${_id}/payments_history`, bodyPaymentHistory as any); // TODO: incompatible type
+          });
+
+          return res.status(204).send('SUCCESS');
+        } catch (err: any) {
+          //
+          const { message, response } = err;
+          let statusCode: number;
+          if (!err.request && err.name !== CLIENT_ERR && err.code !== 'EMPTY') {
+            // not Axios error ?
+            logger.error(err);
+            statusCode = 500;
+          } else {
+            const resStatus = response && response.status;
+            let debugMsg = `[#${transactionCode}] Unhandled notification: `;
+            if (err.config) {
+              debugMsg += `${err.config.url} `;
+            }
+            debugMsg += (resStatus || message);
+
+            if (!isRetry
+              && ((resStatus === 401 && response.data && response.data.error_code === 132)
+                || resStatus >= 500)
+            ) {
+              // delay and retry once
+              await new Promise((resolve) => {
+                setTimeout(() => {
+                  resolve(true);
+                }, 700);
+              });
+              return handleNotification(true);
+              // statusCode = 503;
+            }
+            logger.error(debugMsg);
+            statusCode = 409;
+          }
+          // return response with error
+          return res.status(statusCode)
+            .send({
+              error: 'paghiper_notification_error',
+              message,
+            });
+        }
+      };
+      await handleNotification();
+    }
+
+    return res.status(400).send('API key does not match');
+  } catch (err: any) {
+    logger.error(err);
+    return res.sendStatus(500);
+  }
+};

package/src/index.ts

@@ -0,0 +1 @@
+export * from './paghiper';

package/src/paghiper-create-transaction.ts

@@ -0,0 +1,242 @@
+import type {
+  AppModuleBody,
+  CreateTransactionParams,
+  CreateTransactionResponse,
+} from '@cloudcommerce/types';
+import type { PagHiperApp } from '../types/config-app';
+import logger from 'firebase-functions/logger';
+import config from '@cloudcommerce/firebase/lib/config';
+import axios from './functions-lib/create-axios';
+
+type ItemsPagHiper = {
+  description: string,
+  item_id: string,
+  quantity: number,
+  price_cents: number,
+}
+
+const responseError = (status: number | null, error: string, message: string) => {
+  return {
+    status: status || 409,
+    error,
+    message,
+  };
+};
+
+const createTransactionPagHiper = async (
+  body: { [x: string]: any },
+  isPix?: boolean,
+): Promise<any> => {
+  // create new transaction to PagHiper API
+  // https://dev.paghiper.com/reference#gerar-boleto
+  if (!isPix && process.env.PAGHIPER_PARTNER_ID) {
+    body.partners_id = process.env.PAGHIPER_PARTNER_ID;
+  } else if (isPix && process.env.PAGHIPER_PIX_PARTNER_ID) {
+    body.partners_id = process.env.PAGHIPER_PIX_PARTNER_ID;
+  }
+
+  // returns request promise
+  const endpoint = `/${(isPix ? 'invoice' : 'transaction')}/create/`;
+  return new Promise((resolve, reject) => {
+    axios(isPix).post(endpoint, body)
+      .then(({ data }) => {
+        // save transaction ID on database first
+        let createRequest: any;
+        if (isPix) {
+          createRequest = data.pix_create_request;
+        }
+        if (!createRequest) {
+          createRequest = data.create_request;
+        }
+
+        resolve(createRequest);
+      })
+      .catch(reject);
+  });
+};
+
+export default async (appData: AppModuleBody) => {
+  const locationId = config.get().httpsFunctionOptions.region;
+  const baseUri = `https://${locationId}-${process.env.GCLOUD_PROJECT}.cloudfunctions.net`;
+
+  const webhookUrl = `${baseUri}/paghiper-webhook`;
+
+  // treat module request body
+  const { application } = appData;
+  const params = appData.params as CreateTransactionParams;
+
+  // app configured options
+  const configApp = {
+    ...application.data,
+    ...application.hidden_data,
+  } as PagHiperApp;
+
+  const orderId = params.order_id;
+  const orderNumber = params.order_number;
+  const {
+    amount,
+    items,
+    buyer,
+    to,
+  } = params;
+
+  const billingAddress = params.billing_address;
+
+  logger.log(`> (App PagHiper): Create transaction for #${orderId}`);
+  let transaction: CreateTransactionResponse['transaction'] = {
+    amount: amount.total,
+  };
+
+  // params object follows create transaction request schema:
+  // https://apx-mods.e-com.plus/api/v1/create_transaction/schema.json?store_id=100
+  //   const orderId = params.order_id;
+  //   logger.log(`> Create transaction for #${storeId} ${orderId}`);
+  // setup transaction body to PagHiper reference
+
+  // https://dev.paghiper.com/reference#gerar-boleto
+  const address = billingAddress || to;
+
+  const paghiperTransaction: { [x: string]: any } = {
+    order_id: orderId || orderNumber || new Date().getTime().toString(),
+    payer_email: buyer.email,
+    payer_name: buyer.fullname,
+    payer_cpf_cnpj: buyer.doc_number,
+    payer_phone: buyer.phone.number,
+    payer_street: address?.street || '',
+    payer_number: address?.number || '',
+    payer_complement: address?.complement || '',
+    payer_district: address?.borough || '',
+    payer_city: address?.city || '',
+    payer_state: address?.province_code || '',
+    payer_zip_code: address?.zip ? address.zip.replace(/\D/g, '') : '',
+    notification_url: webhookUrl,
+    discount_cents: amount.discount ? Math.round(amount.discount * 100) : '',
+    shipping_price_cents: amount.freight ? Math.round(amount.freight * 100) : '',
+    fixed_description: true,
+    type_bank_slip: 'boletoA4',
+    days_due_date: 5,
+    per_day_interest: true,
+    items: [] as ItemsPagHiper[],
+  };
+
+  // parse transaction items list
+  items.forEach((item) => {
+    paghiperTransaction.items.push({
+      description: item.name || item.product_id,
+      item_id: item.sku || item.product_id,
+      quantity: item.quantity,
+      price_cents: Math.round((item.final_price || item.price) * 100),
+    });
+  });
+
+  const isPix = params.payment_method.code === 'account_deposit';
+  if (isPix) {
+    paghiperTransaction.notification_url += '/pix';
+  }
+
+  // use configured PagHiper API key
+  paghiperTransaction.apiKey = configApp.paghiper_api_key;
+  // merge configured banking billet options
+  const options = configApp.banking_billet_options;
+  if (typeof options === 'object' && options !== null) {
+    // options must have only valid properties for PagHiper transaction object
+    Object.keys(options).forEach((prop) => {
+      if (options[prop]) {
+        paghiperTransaction[prop] = options[prop];
+      }
+    });
+  }
+
+  try {
+    // send request to PagHiper API
+    const createRequest = await createTransactionPagHiper(paghiperTransaction, isPix);
+
+    // transaction created successfully
+    // https://dev.paghiper.com/reference#exemplos
+    // mount response body
+    // https://apx-mods.e-com.plus/api/v1/create_transaction/response_schema.json?store_id=100
+    transaction = {
+      intermediator: {
+        transaction_id: createRequest.transaction_id,
+        transaction_code: createRequest.transaction_id,
+        transaction_reference: createRequest.order_id,
+      },
+      amount: createRequest.value_cents
+        ? parseInt(createRequest.value_cents, 10) / 100
+        // use amount from create transaction request body
+        : params.amount.total,
+    };
+
+    if (isPix) {
+      // https://dev.paghiper.com/reference#exemplos-pix
+      const pixCode = createRequest.pix_code;
+      if (transaction.intermediator) {
+        transaction.intermediator.transaction_code = pixCode.emv;
+      }
+      const pixCodeUrls = ['pix_url', 'qrcode_image_url', 'bacen_url'];
+      for (let i = 0; i < pixCodeUrls.length; i++) {
+        const pixUrl = pixCode[pixCodeUrls[i]];
+        if (pixUrl && pixUrl.startsWith('http')) {
+          transaction.payment_link = pixUrl;
+          break;
+        }
+      }
+      transaction.notes = `<img src="${pixCode.qrcode_image_url}" `
+        + 'style="display:block;max-width:100%;margin:0 auto" />';
+    } else {
+      const bankSlip = createRequest.bank_slip;
+      transaction.payment_link = bankSlip.url_slip;
+      transaction.banking_billet = {
+        code: bankSlip.digitable_line,
+        link: bankSlip.url_slip_pdf,
+      };
+      if (createRequest.due_date) {
+        transaction.banking_billet.valid_thru = new Date(createRequest.due_date).toISOString();
+      }
+    }
+
+    return {
+      redirect_to_payment: false,
+      transaction,
+    };
+  } catch (err: any) {
+    let { message } = err;
+    let statusCode: number | null;
+    if (!err.request) {
+      // not Axios error ?
+      logger.error('> (App PagHiper) =>', err);
+      statusCode = 500;
+    } else {
+      let debugMsg = 'Can\'t create transaction: ';
+      if (err.config) {
+        debugMsg += `${err.config.url} `;
+      }
+      if (err.response) {
+        debugMsg += err.response.status;
+
+        // https://dev.paghiper.com/reference#mensagens-de-retorno-2
+        if (err.response.status === 200) {
+          const { data } = err.response;
+          if (data) {
+            debugMsg += ` ${typeof data === 'object' ? JSON.stringify(data) : data}`;
+            debugMsg += ` ${JSON.stringify(paghiperTransaction)}`;
+            if (data.create_request && data.create_request.response_message) {
+              message = data.create_request.response_message;
+            }
+          }
+        }
+      } else {
+        debugMsg += message;
+      }
+      logger.error('> (App PagHiper) =>', debugMsg);
+      statusCode = 409;
+    }
+
+    // return error status code
+    return responseError(
+      statusCode,
+      'CREATE_TRANSACTION_ERR',
+      message,
+    );
+  }
+};

package/src/paghiper-list-payments.ts

@@ -0,0 +1,127 @@
+import type {
+  AppModuleBody,
+  ListPaymentsParams,
+  ListPaymentsResponse,
+} from '@cloudcommerce/types';
+import type { PagHiperApp } from '../types/config-app';
+// import logger from 'firebase-functions/logger';
+
+const responseError = (status: number | null, error: string, message: string) => {
+  return {
+    status: status || 409,
+    error,
+    message,
+  };
+};
+
+type Gateway = ListPaymentsResponse['payment_gateways'][number]
+type CodePaymentMethod = Gateway['payment_method']['code']
+
+export default async (data: AppModuleBody) => {
+  const { application } = data;
+  const params = data.params as ListPaymentsParams;
+  // https://apx-mods.e-com.plus/api/v1/list_payments/schema.json?store_id=100
+  const amount = params.amount || { total: undefined, discount: undefined };
+  // const initialTotalAmount = amount.total;
+
+  const configApp = {
+    ...application.data,
+    ...application.hidden_data,
+  } as PagHiperApp;
+
+  // setup basic required response object
+  const response: ListPaymentsResponse = {
+    payment_gateways: [],
+  };
+
+  if (!configApp.paghiper_api_key) {
+    // must have configured PagHiper API key and token
+    return responseError(
+      400,
+      'LIST_PAYMENTS_ERR',
+      'PagHiper API key is unset on app hidden data (merchant must configure the app)',
+    );
+  }
+
+  const intermediator = {
+    name: 'PagHiper',
+    link: 'https://www.paghiper.com/',
+    code: 'paghiper',
+  };
+
+  const listPaymentMethods = ['banking_billet', 'account_deposit'];
+
+  listPaymentMethods.forEach((paymentMethod) => {
+    const isPix = paymentMethod === 'account_deposit';
+    const minAmount = configApp.min_amount || isPix ? 3 : 0;
+    const methodConfig = isPix ? configApp.pix : configApp;
+
+    const methodEnable = isPix ? configApp?.pix?.enable : configApp?.pix?.disable_billet;
+
+    // Workaround for showcase
+    const validateAmount = amount.total ? (amount.total >= minAmount) : true;
+
+    if (methodEnable && validateAmount) {
+      let label = methodConfig?.label;
+      if (!label) {
+        if (isPix) {
+          label = 'Pagar com Pix';
+        } else {
+          label = (!params.lang || params.lang === 'pt_br') ? 'Boleto bancário' : 'Banking billet';
+        }
+      }
+
+      const gateway: Gateway = {
+        label,
+        icon: methodConfig?.icon,
+        text: methodConfig?.text,
+        payment_method: {
+          code: paymentMethod as CodePaymentMethod,
+          name: `${label} - ${intermediator.name}`,
+        },
+        intermediator,
+      };
+
+      if (!gateway.icon && isPix) {
+        gateway.icon = 'https://us-central1-ecom-pix.cloudfunctions.net/app/pix.png';
+      }
+
+      const discount = methodConfig?.discount;
+      gateway.discount = discount;
+
+      if (discount) {
+        if (discount.value > 0) {
+          if (amount.discount && (configApp.cumulative_discount === false)) {
+            // can't offer cumulative discount
+            delete gateway.discount;
+            return;
+          }
+
+          if (discount.apply_at !== 'freight') {
+            response.discount_option = {
+              apply_at: discount.apply_at,
+              type: discount.type,
+              value: discount.value,
+              label: `${label}`,
+            };
+          }
+
+          if (discount.min_amount) {
+            // check amount value to apply discount
+            if (amount.total && amount.total < discount.min_amount) {
+              delete gateway.discount;
+            } else {
+              delete discount.min_amount;
+            }
+          }
+        } else if (typeof discount.value !== 'number' || Number.isNaN(discount.value)) {
+          delete gateway.discount;
+        }
+      }
+
+      response.payment_gateways.push(gateway);
+    }
+  });
+
+  return response;
+};

package/src/paghiper-webhook.ts

@@ -0,0 +1,17 @@
+/* eslint-disable import/prefer-default-export */
+import '@cloudcommerce/firebase/lib/init';
+import * as functions from 'firebase-functions/v1';
+import config from '@cloudcommerce/firebase/lib/config';
+import handleWebhook from './functions-lib/handle-webhook';
+
+export const paghiper = {
+  webhook: functions
+    .region(config.get().httpsFunctionOptions.region)
+    .https.onRequest((req, res) => {
+      if (req.method !== 'POST') {
+        res.sendStatus(405);
+      } else {
+        handleWebhook(req, res);
+      }
+    }),
+};

package/src/paghiper.ts

@@ -0,0 +1,12 @@
+import type { AppModuleBody } from '@cloudcommerce/types';
+import '@cloudcommerce/firebase/lib/init';
+import handleListPayments from './paghiper-list-payments';
+import handleCreateTransaction from './paghiper-create-transaction';
+
+export const listPayments = async (modBody: AppModuleBody) => {
+  return handleListPayments(modBody);
+};
+
+export const createTransaction = async (modBody: AppModuleBody) => {
+  return handleCreateTransaction(modBody);
+};

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true
+  }
+}

package/types/config-app.d.ts

@@ -0,0 +1,34 @@
+type DiscountConfig = {
+  apply_at?: 'total' | 'subtotal' | 'freight'
+  min_amount?: integer,
+  type?: 'percentage' | 'fixed'
+  value: number
+}
+
+export type PagHiperApp = {
+  paghiper_api_key?: string,
+  paghiper_token?: string
+  label?: string,
+  text?: string,
+  icon?: string,
+  discount?: DiscountConfig
+  cumulative_discount?: boolean
+  min_amount?: integer,
+  banking_billet_options?: {
+    days_due_date?: integer
+    fixed_description?: boolean,
+    late_payment_fine?: integer,
+    per_day_interest?: boolean
+    early_payment_discounts_cents?: integer,
+    early_payment_discounts_days?: integer,
+    open_after_day_due?: integer,
+  },
+  pix?: {
+    enable?: boolean,
+    disable_billet?: boolean,
+    label?: string,
+    text?: string,
+    icon?: string,
+    discount?: DiscountConfig,
+  },
+}

package/webhook.js

@@ -0,0 +1 @@
+export * from './lib/paghiper-webhook';