@cloudcommerce/app-galaxpay 0.1.0

package/src/galaxpay-list-payments.ts

@@ -0,0 +1,130 @@
+import type {
+  AppModuleBody,
+  ListPaymentsParams,
+  ListPaymentsResponse,
+} from '@cloudcommerce/types';
+import type { GalaxpayApp } from '../types/config-app';
+import logger from 'firebase-functions/logger';
+import { readFile, responseError, isSandbox } from './functions-lib/utils';
+import { handleGateway, discountPlan } from './functions-lib/galaxpay/handle-plans';
+import { parsePeriodicityToEcom } from './functions-lib/all-parses';
+
+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 GalaxpayApp;
+
+  // setup basic required response object
+  const response: ListPaymentsResponse = {
+    payment_gateways: [],
+  };
+
+  if (!configApp.galaxpay_id || !configApp.galaxpay_hash) {
+    return responseError(
+      409,
+      'NO_GALAXPAY_KEYS',
+      'GalaxPay ID e/ou GalaxPay Hash da API indefinido(s) (lojista deve configurar o aplicativo)',
+    );
+  }
+
+  // common payment methods data
+  const intermediator = {
+    name: 'GalaxPay',
+    link: `https://api.${isSandbox ? 'sandbox.cloud.' : ''}galaxpay.com.br/v2`,
+    code: 'galaxpay_app',
+  };
+
+  const paymentTypes: Gateway['type'][] = [];
+  if (configApp.plans) {
+    paymentTypes.push('recurrence');
+  }
+
+  // setup payment gateway objects
+  const plans = handleGateway(configApp);
+
+  plans.forEach((plan) => {
+    ['credit_card', 'banking_billet', 'pix'].forEach((paymentMethod) => {
+      paymentTypes.forEach((type) => {
+        const methodConfig = configApp[paymentMethod] || {};
+        const methodMinAmount = methodConfig.min_amount || 0;
+        if (!methodConfig.disable && (amount.total && methodMinAmount <= amount.total)) {
+          logger.log('> Plan ', plan.periodicity);
+
+          const isCreditCard = paymentMethod === 'credit_card';
+          const isPix = paymentMethod === 'pix';
+          let { label } = methodConfig;
+          if (!label) {
+            if (isCreditCard) {
+              label = 'Cartão de crédito';
+            } else {
+              label = isPix ? 'PIX' : 'Boleto bancário';
+            }
+          }
+
+          const periodicity = parsePeriodicityToEcom(plan.periodicity);
+          const planName = plan.label ? plan.label : 'Plano';
+
+          if (type === 'recurrence' && planName) {
+            label = `${planName} ${periodicity} ${label}`;
+          }
+          const gateway: Gateway = {
+            label,
+            icon: methodConfig.icon,
+            text: methodConfig.text,
+            payment_method: {
+              code: isPix ? 'account_deposit' : paymentMethod as CodePaymentMethod, // pix is defined payment method outher
+              name: `${label} - ${intermediator.name}`,
+            },
+            type,
+            intermediator,
+          };
+
+          if (isCreditCard) {
+            if (!gateway.icon) {
+              // Alternative solution
+              gateway.icon = 'https://ecom-galaxpay.web.app/credit-card.png';
+              // TODO:
+            }
+            // https://docs.galaxpay.com.br/tokenizacao-cartao-js
+            gateway.js_client = {
+              script_uri: 'https://js.galaxpay.com.br/checkout.min.js',
+              onload_expression: `window._galaxPayPublicToken="${configApp.galaxpay_public_token}";
+              window._galaxPaySandbox=${isSandbox};
+              ${readFile('../../assets/onload-expression.min.js')}`,
+              cc_hash: {
+                function: '_galaxyHashcard',
+                is_promise: true,
+              },
+            };
+          }
+
+          const planDiscount = discountPlan(plan.discount, amount);
+          if (planDiscount) {
+            if (gateway && gateway.discount) {
+              gateway.discount = planDiscount;
+            }
+
+            response.discount_option = {
+              label,
+              ...planDiscount,
+              apply_at: planDiscount?.apply_at !== 'freight'
+                ? planDiscount?.apply_at : undefined,
+            };
+          }
+          response.payment_gateways.push(gateway);
+        }
+      });
+    });
+  });
+  return response;
+};

package/src/galaxpay.ts

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

package/src/index.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/prefer-default-export
+export * from './galaxpay';

package/tsconfig.json

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

package/types/config-app.d.ts

@@ -0,0 +1,99 @@
+
+export type GalaxpayApp = {
+  galaxpay_id: string,
+  galaxpay_hash: string,
+  galaxpay_sandbox?: boolean,
+  galaxpay_public_token?: string,
+  credit_card?: {
+    disable?: boolean,
+    label?: string,
+    min_amount: number,
+    text?: string,
+    icon?: string,
+  }
+  banking_billet?: {
+    disable?: boolean,
+    label?: string,
+    min_amount: number,
+    text?: string,
+    icon?: string,
+    add_days: integer,
+  };
+  pix?: {
+    disable?: boolean,
+    label?: string,
+    min_amount: number,
+    instructions?: string,
+    add_days: integer
+  };
+  plans?: {
+    label: string,
+    periodicity: 'Semanal' | 'Quinzenal' | 'Mensal' | 'Bimestral' | 'Trimestral' | 'Semestral' | 'Anual'
+    quantity: integer | 0,
+    discount: {
+      percentage: boolean,
+      value: number,
+      apply_at: 'total' | 'subtotal' | 'frete',
+      min_amount?: number
+    }
+  }[];
+}
+
+export type GalaxPaySubscriptions = {
+  myId: string,
+  value: integer,
+  quantity: integer,
+  periodicity: string,
+  firstPayDayDate: string,
+  additionalInfo?: string,
+  mainPaymentMethodId: string,
+  Customer: {
+    myId?: string,
+    name: string,
+    document: string,
+    emails: string[],
+    phones?: integer[],
+    Address?: {
+      zipCode: number,
+      street: string,
+      number: string,
+      complement?: string,
+      neighborhood: string,
+      city: string,
+      state: string
+    }
+  },
+  Transactions?: {
+    myId: string,
+    installment: integer,
+    value?: integer,
+    payday?: string,
+    payedOutsideGalaxPay?: boolean,
+    additionalInfo?: string,
+  }[],
+  PaymentMethodCreditCard?: {
+    Card?: {
+      hash?: string,
+    },
+    preAuthorize: boolean
+  },
+  PaymentMethodBoleto?: {
+    fine?: integer,
+    interest?: integer,
+    instructions?: string,
+    deadlineDays?: integer
+  },
+  PaymentMethodPix?: {
+    fine?: integer,
+    interest?: integer,
+    instructions?: string,
+    Deadline?: {
+      type?: string,
+      value?: integer
+    }
+  }
+  ExtraFields?: {
+    tagName: string
+    tagValue: string
+  }[]
+}