refactor(api)!: replace callbacks with promises

README.md

@@ -47,7 +47,7 @@ Options:
 
 ## API
 
-### `track(numbers [, options], callback)`
+### `track(numbers, options?): Promise<[items, failures]>`
 
 Tracks a collection of tracking numbers.
 
@@ -57,9 +57,15 @@ Tracks a collection of tracking numbers.
 - `options` (Object) - Optional tracking options:
   - `checkDigit` (Boolean) - Whether to validate the tracking number check digit
   - `onProgress(progress, item)` (Function) - Callback function called for each number once its data has been retrieved. `progress` is a float number between 0 and 1. `item` is the item object. Invalid tracking numbers are filtered before any requests are made, so they will not be passed here.
-- `callback(err, items, failures)` (Function) - Callback function called once all tracking numbers have been processed, or when an error occurs. `items` is an array of item objects. `failures` is an array of objects containing the tracking numbers that did not pass validation.
 
-### `validate(number [, options], callback)`
+#### Return
+
+`[items, failures]` (Array)
+
+- `items` (Array) - Item objects.
+- `failures` (Array) - Objects containing the tracking numbers that did not pass validation.
+
+### `validate(number, options?): [passes, failures]`
 
 Validates a collection of tracking numbers.
 
@@ -68,8 +74,10 @@ Validates a collection of tracking numbers.
 - `numbers` (String|Array) - Tracking number or array of tracking numbers to be validated
 - `options` (Object) - Optional tracking options:
   - `checkDigit` (Boolean) - Whether to validate the tracking number check digit
-- `callback(err, passes, failures)` (Function) - Callback function called once all numbers have been processed, or when an error occurs. `passes` is an array of objects containing the tracking numbers that passed validation. `failures` is an array of objects containing the tracking numbers that did not pass validation.
 
 #### Return
 
-True if all tracking numbers are valid, false otherwise.
+`[passes, failures]` (Array)
+
+- `passes` (Array) - Objects containing the tracking numbers that passed validation.
+- `failures` (Array) - Objects containing the tracking numbers that did not pass validation.

bin/sro.js

@@ -23,15 +23,12 @@ const formatter =
   formatters[program.opts().output.trim().toLowerCase()] || formatters.table
 const options = {
   checkDigit: program.opts().check,
-  onProgress: (progress, item) => console.log(formatter.format([item]))
-}
-const callback = (err, items, failures) => {
-  if (err) throw err
-  console.log(formatter.format(undefined, failures))
+  onProgress: (_progress, item) => console.log(formatter([item]))
 }
 
 if (numbers.length) {
-  track(numbers, options, callback)
+  const [, failures] = await track(numbers, options)
+  console.log(formatter(undefined, failures))
 } else {
   program.help()
 }

index.js

@@ -1 +1,3 @@
-export * from './src/sro.js'
+export { default as track } from './src/track.js'
+export { default as validate } from './src/validate.js'
+export * as formatters from './src/formatters/index.js'

src/formatters/index.js

@@ -1,3 +1,3 @@
-export { default as table } from './table.js'
 export { default as json } from './json.js'
 export { default as pretty } from './pretty.js'
+export { default as table } from './table.js'

src/formatters/json.js

@@ -1,16 +1,12 @@
-const JSONFormatter = {
-  format: (items = [], failures = []) => {
-    const formattedItems = items.reduce(
-      (result, item) => result + JSON.stringify(item),
-      ''
-    )
-    const formattedFailures = failures.reduce(
-      (result, failure) => result + JSON.stringify(failure),
-      ''
-    )
+export default (items = [], failures = []) => {
+  const formattedItems = items.reduce(
+    (result, item) => result + JSON.stringify(item),
+    ''
+  )
+  const formattedFailures = failures.reduce(
+    (result, failure) => result + JSON.stringify(failure),
+    ''
+  )
 
-    return formattedItems + formattedFailures
-  }
+  return formattedItems + formattedFailures
 }
-
-export default JSONFormatter

src/formatters/pretty.js

@@ -1,16 +1,12 @@
-const PrettyFormatter = {
-  format: (items = [], failures = []) => {
-    const formattedItems = items.reduce(
-      (result, item) => result + JSON.stringify(item, null, 2),
-      ''
-    )
-    const formattedFailures = failures.reduce(
-      (result, failure) => result + JSON.stringify(failure, null, 2),
-      ''
-    )
+export default (items = [], failures = []) => {
+  const formattedItems = items.reduce(
+    (result, item) => result + JSON.stringify(item, null, 2),
+    ''
+  )
+  const formattedFailures = failures.reduce(
+    (result, failure) => result + JSON.stringify(failure, null, 2),
+    ''
+  )
 
-    return formattedItems + formattedFailures
-  }
+  return formattedItems + formattedFailures
 }
-
-export default PrettyFormatter

src/formatters/table.js

@@ -3,47 +3,38 @@ import Table from 'cli-table'
 
 const SYMBOLS = { pass: '✓', fail: '✖' }
 
-const TableFormatter = {
-  format: (items = [], failures = []) => {
-    const formattedItems = items.reduce((result, item) => {
-      const header =
-        '\n ' +
-        chalk.bold(item.numero) +
-        '\n ' +
-        item.pais +
-        ' via ' +
-        item.nome
-      const table = new Table({
-        head: ['Data', 'Local', 'Situação']
-      })
-
-      item.eventos.forEach(event => {
-        const data = new Date(event.data).toLocaleString()
-        const city = [event.cidade, event.uf].filter(Boolean).join('/')
-        let local = [event.local, city].filter(Boolean).join(' - ')
-        const descricao = event.descricao
-        const destino = event.destino
-
-        if (destino) {
-          local += `\nEm trânsito para ${destino.local} - ${destino.cidade}/${destino.uf}`
-        }
-
-        table.push([data, local, descricao])
-      })
-
-      return `${result}${header}\n${table.toString()}\n`
-    }, '')
-
-    const formattedFailures = failures.reduce(
-      (result, failure) =>
-        `${result}\n ${chalk.bold(failure.numero)}\n ${chalk.red(
-          `${SYMBOLS.fail} ${failure.error}\n`
-        )}`,
-      ''
-    )
-
-    return formattedItems + formattedFailures
-  }
+export default (items = [], failures = []) => {
+  const formattedItems = items.reduce((result, item) => {
+    const header =
+      '\n ' + chalk.bold(item.numero) + '\n ' + item.pais + ' via ' + item.nome
+    const table = new Table({
+      head: ['Data', 'Local', 'Situação']
+    })
+
+    item.eventos.forEach(event => {
+      const data = new Date(event.data).toLocaleString()
+      const city = [event.cidade, event.uf].filter(Boolean).join('/')
+      let local = [event.local, city].filter(Boolean).join(' - ')
+      const descricao = event.descricao
+      const destino = event.destino
+
+      if (destino) {
+        local += `\nEm trânsito para ${destino.local} - ${destino.cidade}/${destino.uf}`
+      }
+
+      table.push([data, local, descricao])
+    })
+
+    return `${result}${header}\n${table.toString()}\n`
+  }, '')
+
+  const formattedFailures = failures.reduce(
+    (result, failure) =>
+      `${result}\n ${chalk.bold(failure.numero)}\n ${chalk.red(
+        `${SYMBOLS.fail} ${failure.error}\n`
+      )}`,
+    ''
+  )
+
+  return formattedItems + formattedFailures
 }
-
-export default TableFormatter

src/utils/track.js → src/track.js

@@ -1,29 +1,23 @@
-import normalizeItem from './normalizeItem.js'
-import normalizeNumber from './normalizeNumber.js'
+import apiRequest from './utils/apiRequest.js'
+import normalizeItem from './utils/normalizeItem.js'
+import normalizeNumber from './utils/normalizeNumber.js'
 import validate from './validate.js'
-import apiRequest from './apiRequest.js'
-
-const track = (numbers, options = {}, callback = () => {}) => {
-  if (typeof options === 'function') {
-    callback = options
-    options = {}
-  }
 
+export default async (numbers, options = {}) => {
   if (!Array.isArray(numbers)) {
     numbers = [numbers]
   }
 
   const items = []
   const failures = []
 
-  numbers = numbers
-    .filter(number =>
-      validate(number, options, (err, pass, failure) => {
-        if (err) throw err
-        if (!pass.length) failures.push(failure[0])
-      })
-    )
-    .map(normalizeNumber)
+  numbers = await numbers.reduce(async (acc, number) => {
+    const [, failure] = await validate(number, options)
+    const hasFailure = failure.length !== 0
+
+    if (hasFailure) return failures.push(failure[0]) && acc
+    return (await acc).concat(normalizeNumber(number))
+  }, [])
 
   let tracked = 0
   const count = numbers.length
@@ -32,7 +26,7 @@ const track = (numbers, options = {}, callback = () => {}) => {
     return acc[acc.length - 1].push(number) && acc
   }, [])
 
-  Promise.all(
+  await Promise.all(
     chunks.map(async chunk => {
       const response = await apiRequest({ objetos: chunk })
       const objetos = [response.objeto].flat().filter(Boolean)
@@ -47,8 +41,6 @@ const track = (numbers, options = {}, callback = () => {}) => {
         })
     })
   )
-    .then(() => callback(null, items, failures))
-    .catch(err => callback(err))
-}
 
-export default track
+  return [items, failures]
+}

src/utils/apiRequest.js

@@ -24,15 +24,12 @@ const buildEnvelope = ({ usuario, senha, tipo, resultado, lingua, objetos }) =>
         <tipo>${tipo}</tipo>
         <resultado>${resultado}</resultado>
         <lingua>${lingua}</lingua>
-        ${objetos.reduce(
-          (result, objeto) => `${result}<objetos>${objeto}</objetos>`,
-          ''
-        )}
+        ${objetos.map(objeto => `<objetos>${objeto}</objetos>`).join('')}
       </res:buscaEventosLista>
     </soap:Body>
   </soap:Envelope>`
 
-const apiRequest = async options => {
+export default async options => {
   const response = await fetch([REQUEST_HOST, REQUEST_PATH].join(''), {
     method: 'POST',
     headers: REQUEST_HEADERS,
@@ -53,5 +50,3 @@ const apiRequest = async options => {
 
   return json.body.buscaeventoslistaresponse.return
 }
-
-export default apiRequest

src/utils/checkDigit.js

@@ -1,6 +1,6 @@
 const WEIGHTS = [8, 6, 4, 2, 3, 5, 9, 7]
 
-const checkDigit = number => {
+export default number => {
   const sum = WEIGHTS.reduce(
     (sum, weight, i) => sum + number.charCodeAt(i + 2) * weight,
     0
@@ -11,5 +11,3 @@ const checkDigit = number => {
 
   return dv === +number.charAt(10)
 }
-
-export default checkDigit

src/utils/normalizeEvent.js

@@ -1,4 +1,4 @@
-const normalizeEvent = ({ data, descricao, hora, ...restEvent }) => {
+export default ({ data, descricao, hora, ...restEvent }) => {
   const [day, month, year] = data.split('/')
   const [hour, minute] = hora.split(':')
 
@@ -10,5 +10,3 @@ const normalizeEvent = ({ data, descricao, hora, ...restEvent }) => {
     ...restEvent
   }
 }
-
-export default normalizeEvent

src/utils/normalizeItem.js

@@ -2,7 +2,7 @@ import normalizeEvent from './normalizeEvent.js'
 
 const regionNames = new Intl.DisplayNames(['pt-BR'], { type: 'region' })
 
-const normalizeItem = ({ evento, numero, ...restItem }) => {
+export default ({ evento, numero, ...restItem }) => {
   const countryCode = numero.slice(-2)
 
   return {
@@ -12,5 +12,3 @@ const normalizeItem = ({ evento, numero, ...restItem }) => {
     ...restItem
   }
 }
-
-export default normalizeItem

src/utils/normalizeNumber.js

@@ -1,3 +1 @@
-const normalizeNumber = number => number.trim().toUpperCase()
-
-export default normalizeNumber
+export default number => number.trim().toUpperCase()

src/utils/validate.js → src/validate.js

@@ -1,12 +1,7 @@
-import normalizeNumber from './normalizeNumber.js'
-import checkDigit from './checkDigit.js'
-
-const validate = (numbers, options = {}, callback = () => {}) => {
-  if (typeof options === 'function') {
-    callback = options
-    options = {}
-  }
+import checkDigit from './utils/checkDigit.js'
+import normalizeNumber from './utils/normalizeNumber.js'
 
+export default (numbers, options = {}) => {
   if (!Array.isArray(numbers)) {
     numbers = [numbers]
   }
@@ -52,8 +47,5 @@ const validate = (numbers, options = {}, callback = () => {}) => {
     passes.push(result)
   })
 
-  callback(null, passes, failures)
-  return failures.length === 0
+  return [passes, failures]
 }
-
-export default validate