dhl-packstation-validation/node-packstation.js

This package validates addresses of a DHL Packstation or lists the nearby DHL Packstation close to an zip code.

import fetch from "node-fetch"

/**
 * Checks if a given string is numerical
 * @param { string } str - the string to be checked
 * @returns { boolean }
 */
const isAllNum = (str) => {
  return (
    typeof str === 'string' &&
    /^\d+$/.test(str)
  )
}

/**
 * Checks if a given string is a valid number for a Packstation
 * @param { string } packstationNumber
 * @returns { boolean }
 */
export const isValidPackstationNumber = (packstationNumber) => {
  return (
    isAllNum(packstationNumber) &&
    packstationNumber.length === 3
  )
}

/**
 * Checks if a given string is a german zip code
 * @param { string } zipCode
 * @returns { boolean }
 */

export const isValidZipCode = (zipCode) => {
  return (
    isAllNum(zipCode) &&
    zipCode.length === 5
  )
}

/**
 * Retrieve the json with addresses of Packstationen in the range of the zipCode
 * @param { string } zipCode - german zip code
 * @returns { Promise < object > } returns the javascript representation of the json returned from the api
 */
const getAddressList = async (zipCode) => {

  if ( ! isValidZipCode(zipCode) ) {
    throw new Error("ZIPCODE ERROR: invalid input zipcode")
  }

  const url = `https://www.dhl.de/int-postfinder/postfinder_webservice/rest/v1/nearbySearch?address=${zipCode}&locationType=PACKSTATION`

  try {
    const response = await fetch(url)
    const addressList = await response.json()
    return addressList    
  } catch (error) {
    throw new Error(`API-ERROR: couldn't gather the list of Packstation\nActual Error: ${error}`)
  }
}

/**
 * Checks if a pair of PackstationNumber and zipCode match to a valid address.
 * @param { string } zipCode - german zip code of the Packstation
 * @param { string } packstationNumber - number of the Packstation
 * @returns { Promise < boolean > }
 */
const isValidAddress = async (zipCode, packstationNumber) => {
  if (
    ! isValidZipCode(zipCode) ||
    ! isValidPackstationNumber(packstationNumber)
  ) {
    return false
  }
  try {
    const addressList = await getAddressList(zipCode)
    for (let ps of addressList.pfLocations) {
      if (ps.primaryKeyZipRegion 
        && ps.primaryKeyZipRegion === packstationNumber
        && ps.zipCode
        && ps.zipCode === zipCode
        ) {
          return true
        }
    }
    return false  
  } catch (error) {
    console.log(error)
  }
}

export default {
  listAddresses: getAddressList,
  isValidAddress
}