@cloudcommerce/app-correios 0.30.0 → 0.31.0

package/lib-mjs/correios-v2.mjs

@@ -0,0 +1,84 @@
+import logger from 'firebase-functions/logger';
+import { newCorreios } from './utils/correios-axios.mjs';
+
+const calculate = async ({
+  correiosParams,
+  serviceCodes = ['03220', '03298'],
+  correios,
+  timeout = 20000,
+}) => {
+  if (!correios) {
+    correios = await newCorreios();
+  }
+  const { nuContrato, nuDR } = correios.$contract;
+  if (!(Number(correiosParams.psObjeto) >= 200)) {
+    correiosParams.psObjeto = '200';
+  }
+  if (!(Number(correiosParams.comprimento) >= 15)) {
+    correiosParams.comprimento = '15';
+  }
+  if (!(Number(correiosParams.altura) >= 2)) {
+    correiosParams.altura = '2';
+  }
+  if (!(Number(correiosParams.largura) >= 11)) {
+    correiosParams.largura = '11';
+  }
+  [
+    'psObjeto',
+    'comprimento',
+    'altura',
+    'largura',
+  ].forEach((param) => {
+    if (typeof correiosParams[param] === 'number') {
+      correiosParams[param] = String(Math.round(correiosParams[param]));
+    }
+  });
+  const debugError = (err) => {
+    if (err.response) {
+      logger.warn('[calculate] failed for', {
+        body: err.config.data,
+        response: err.response.data,
+        status: err.response.status,
+      });
+    } else {
+      logger.error(err);
+    }
+    throw err;
+  };
+  const params = serviceCodes
+    .filter((coProduto) => typeof coProduto === 'string' && coProduto)
+    .map((coProduto, nuRequisicao) => {
+      const _params = {
+        ...correiosParams,
+        coProduto,
+        nuContrato,
+        nuDR,
+        nuRequisicao,
+        tpObjeto: '2',
+      };
+
+      return _params;
+    });
+  return Promise.all([
+    correios.post('/preco/v1/nacional', {
+      idLote: '1',
+      parametrosProduto: params,
+    }, { timeout })
+      .catch(debugError),
+    correios.post('/prazo/v1/nacional', {
+      idLote: '1',
+      parametrosPrazo: params,
+    }, { timeout })
+      .catch(debugError),
+  ]).then((responses) => {
+    responses[1].data.forEach(({ coProduto, ...value }) => {
+      const result = responses[0].data.find((resultFind) => resultFind.coProduto === coProduto);
+      if (result) {
+        Object.assign(result, value);
+      }
+    });
+    return responses[0];
+  });
+};
+
+export default calculate;

package/lib-mjs/utils/constants-parsers.mjs

@@ -0,0 +1,135 @@
+import logger from 'firebase-functions/logger';
+
+const zipRangeStep = 5000;
+
+const weightsKg = [0.5];
+let weight = 0;
+
+do {
+  // representation in kg
+  const lastWeight = weightsKg[weightsKg.length - 1];
+  weight = lastWeight + Math.ceil(lastWeight / 10);
+
+  if (lastWeight < 1) {
+    weight = 1;
+  } else if (lastWeight >= 40) {
+    weight = 50;
+  }
+  weightsKg.push(weight);
+} while (weight < 50);
+
+const weights = weightsKg.map((weightKg) => weightKg * 1000);
+
+const parseZipCode = (zipCode) => {
+  return (Number(zipCode) - (Number(zipCode) % zipRangeStep) + 1)
+    .toString().padStart(8, '0');
+};
+
+const findBaseWeight = (findWeight) => {
+  for (let i = 0; i < weights.length; i++) {
+    if (findWeight <= weights[i]) return weights[i];
+  }
+  return weights[weights.length - 1];
+};
+
+const getDocId = ({
+  cepOrigem,
+  cepDestino,
+  psObjeto,
+  nuContrato,
+  serviceCodes,
+}) => {
+  let id = `${nuContrato}_${cepOrigem}_${cepDestino}_${psObjeto}`;
+
+  if (serviceCodes && serviceCodes.length) {
+    id += serviceCodes.reduce((accumulator, code) => {
+      return `${accumulator}_${code}`;
+    }, '');
+  }
+
+  return `correiosResults/1_${id}`;
+};
+
+const setCredentials = (appData) => {
+  if (!process.env.CORREIOS_POSTCARD) {
+    const correiosPostCard = appData.correios_contract?.post_card_number;
+    if (correiosPostCard && typeof correiosPostCard === 'string') {
+      process.env.CORREIOS_POSTCARD = correiosPostCard;
+    } else {
+      logger.warn('Missing Correios Postcard number');
+    }
+  }
+
+  if (!process.env.CORREIOS_USER) {
+    const correiosUser = appData.correios_contract?.username;
+    if (correiosUser && typeof correiosUser === 'string') {
+      process.env.CORREIOS_USER = correiosUser;
+    } else {
+      logger.warn('Missing Correios Username');
+    }
+  }
+
+  if (!process.env.CORREIOS_ACCESS_CODE) {
+    const correiosAccessCode = appData.correios_contract?.access_code;
+    if (correiosAccessCode && typeof correiosAccessCode === 'string') {
+      process.env.CORREIOS_ACCESS_CODE = correiosAccessCode;
+    } else {
+      logger.warn('Missing Correios Access code');
+    }
+  }
+};
+
+const dataToDoc = (data) => {
+  const d = data.map(({
+    coProduto,
+    pcProduto,
+    prazoEntrega,
+    txErro,
+  }) => {
+    const obj = {
+      c: coProduto,
+      p: pcProduto,
+      e: prazoEntrega,
+      m: txErro,
+    };
+    // TODO:
+    // set ignoreUndefinedProperties in Firestore
+    // no need to delete undefined fields
+
+    Object.keys(obj).forEach((key) => {
+      if (obj[key] === undefined) delete obj[key];
+    });
+
+    return obj;
+  });
+
+  return { d };
+};
+
+const docToData = ({ d }) => {
+  const data = d.map(({
+    c,
+    p,
+    e,
+    m,
+  }) => {
+    return {
+      coProduto: c,
+      pcProduto: p,
+      prazoEntrega: e,
+      txErro: m,
+    };
+  });
+  return data;
+};
+
+export {
+  zipRangeStep,
+  weights,
+  parseZipCode,
+  findBaseWeight,
+  getDocId,
+  setCredentials,
+  dataToDoc,
+  docToData,
+};

package/lib-mjs/utils/correios-axios.mjs

@@ -0,0 +1,93 @@
+import { getFirestore, Timestamp } from 'firebase-admin/firestore';
+import axios from 'axios';
+
+const baseURL = 'https://api.correios.com.br/';
+
+const newCorreiosAuth = async () => {
+  const username = process.env.CORREIOS_USER;
+  const accessCode = process.env.CORREIOS_ACCESS_CODE;
+  if (!username || !accessCode) {
+    throw new Error('No Correios contract credentials');
+  }
+
+  return axios.create({
+    baseURL,
+    timeout: 6000,
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: 'Basic '
+        + Buffer.from(`${username}:${accessCode}`, 'utf8').toString('base64'),
+    },
+  });
+};
+
+const newCorreios = async () => {
+  let token;
+  let correiosContract;
+  const docRef = getFirestore().doc('correios/contract');
+  let correiosAuth;
+
+  const postCardNumber = process.env.CORREIOS_POSTCARD;
+
+  if (postCardNumber) {
+    correiosAuth = await newCorreiosAuth();
+  } else {
+    throw Error('Correios postCard number not found');
+  }
+
+  const docSnapshot = await docRef.get();
+  if (docSnapshot.exists) {
+    const { expiredAt, ...docData } = docSnapshot.data();
+    const now = Timestamp.now().toMillis();
+    if (now + 9000 < expiredAt.toMillis()) {
+      token = docData.token;
+    } else {
+      correiosAuth = await newCorreiosAuth();
+    }
+    correiosContract = docData;
+  }
+
+  if (correiosAuth && !token) {
+    const { data } = await correiosAuth.post('/token/v1/autentica/cartaopostagem', {
+      numero: postCardNumber,
+    });
+    token = data.token;
+    const { cartaoPostagem, cnpj } = data;
+    const nuContrato = cartaoPostagem.contrato;
+    const nuDR = cartaoPostagem.dr;
+    if (!correiosContract) {
+      correiosContract = {
+        postCardNumber,
+        nuContrato,
+        nuDR,
+        cnpj,
+        token,
+        cartaoPostagem,
+      };
+    } else {
+      Object.assign(correiosContract, {
+        nuContrato,
+        nuDR,
+        cnpj,
+        token,
+        cartaoPostagem,
+      });
+    }
+    docRef.set({
+      ...correiosContract,
+      expiredAt: Timestamp.fromDate(new Date(data.expiraEm)),
+    }, { merge: true });
+  }
+  const correios = axios.create({
+    baseURL,
+    timeout: 20000,
+    headers: {
+      'Content-Type': 'application/json',
+      Authorization: `Bearer ${token}`,
+    },
+  });
+  correios.$contract = correiosContract;
+  return correios;
+};
+
+export { newCorreiosAuth, newCorreios };

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@cloudcommerce/app-correios",
   "type": "module",
-  "version": "0.30.0",
+  "version": "0.31.0",
   "description": "E-Com Plus Cloud Commerce app for Correios shipping calculation",
-  "main": "lib/correios.js",
+  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./fill-database": "./lib-mjs/correios-db.mjs"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ecomplus/cloud-commerce.git",
@@ -16,15 +20,19 @@
   },
   "homepage": "https://github.com/ecomplus/cloud-commerce/tree/main/packages/apps/correios#readme",
   "dependencies": {
-    "axios": "^1.6.0",
-    "xml2js": "0.6.2",
-    "@cloudcommerce/api": "0.30.0"
+    "@google-cloud/pubsub": "^4.0.6",
+    "axios": "^1.5.1",
+    "firebase-admin": "^11.11.0",
+    "firebase-functions": "^4.4.1",
+    "@cloudcommerce/api": "0.31.0",
+    "@cloudcommerce/firebase": "0.31.0"
   },
   "devDependencies": {
-    "@cloudcommerce/test-base": "0.30.0",
-    "@cloudcommerce/types": "0.30.0"
+    "@cloudcommerce/test-base": "0.31.0",
+    "@cloudcommerce/types": "0.31.0"
   },
   "scripts": {
-    "build": "bash ../../../scripts/build-lib.sh"
+    "build": "bash ../../../scripts/build-lib.sh",
+    "test": "bash scripts/tests.sh"
   }
 }

package/scripts/tests.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+if [ -z "$CORREIOS_POSTCARD" ]; then
+  echo -e "CORREIOS_POSTCARD not set\n"
+elif [ -z "$CORREIOS_USER" ]; then
+  echo -e "CORREIOS_USER not set\n"
+elif [ -z "$CORREIOS_ACCESS_CODE" ]; then
+  echo -e "CORREIOS_ACCESS_CODE not set\n"
+else
+  node --test tests/
+fi

package/src/correios.ts

@@ -1,6 +1,7 @@
 /* eslint-disable import/prefer-default-export */
 import type { AppModuleBody } from '@cloudcommerce/types';
-import handleCalculateShipping from '../lib-mjs/calculate-correios.mjs';
+import '@cloudcommerce/firebase/lib/init';
+import handleCalculateShipping from '../lib-mjs/calculate-shipping.mjs';
 
 export const calculateShipping = async (modBody: AppModuleBody) => {
   return handleCalculateShipping(modBody);

package/tests/calculate-shipping.test.mjs

@@ -9,7 +9,7 @@ import {
 describe('Test Shipping Calculation in the Correios App', async () => {
   let req;
   let data;
-  const appId = 1248;
+  const appId = 126334;
 
   before(async () => {
     req = await fetch(`${modulesUrl}/calculate_shipping?app_id=${appId}`, {