country-codes-list 1.6.12 → 2.0.0

package/index.d.ts

@@ -1,54 +0,0 @@
-// Types for https://www.npmjs.com/package/country-codes-list
-// by jakeisnt, Feb. 2022
-
-declare module 'country-codes-list' {
-
-  export type CountryData = {
-    countryNameEn: string
-    countryNameLocal: string
-    countryCode: string
-    currencyCode: string
-    currencyNameEn: string
-    tinType: string
-    tinName: string
-    officialLanguageCode: string
-    officialLanguageNameEn: string
-    officialLanguageNameLocal: string
-    countryCallingCode: string
-    region: string
-    flag: string
-  }
-
-  export type CountryProperty = keyof CountryData
-
-  type Filter<T> = (element: T, index: number, array: T[]) => T[]
-
-  type CustomArraySettings = {
-    sortDataBy?: CountryProperty
-    sortBy?: any
-    filter?: Filter<CountryData>
-  }
-
-  export function all(): CountryData[]
-
-  export function filter(
-    countryProperty: CountryProperty,
-    value: string,
-  ): CountryData[]
-
-  export function findOne(
-    countryProperty: CountryProperty,
-    value: string,
-  ): CountryData
-
-  export function customArray(
-    fields?: Record<string, string>,
-    settings?: CustomArraySettings,
-  ): Record<string, string>[]
-
-  export function customList(
-    key?: CountryProperty,
-    label?: string,
-    settings?: CustomArraySettings,
-  ): { [key in CountryProperty]: string }
-}

package/index.js

@@ -1,88 +0,0 @@
-const groupBy = require('./utils/groupBy')
-const supplant = require('./utils/supplant')
-const countriesData = require('./countriesData')
-
-module.exports = {  
-  /**
-   * Returns some module utils
-   */
-  utils: {
-    groupBy: groupBy
-  },
-
-  /**
-   * Returns the list with all the countries data
-   */
-  all: function () {
-    return countriesData
-  },
-  /**
-   * Filters the list of countries and returns those matching with the filter criteria
-   * @param {String} countryProperty - The property to use in the filter. Must be any of the country properties (countryCode, currencyCode, etc)
-   * @param {String} value - The value to use in the filter
-   */
-  filter: function (countryProperty, value) {
-    return countriesData.filter(countryData => countryData[countryProperty] === value)
-  },
-  /**
-   * Find a country by a property and return the first match
-   * @param {String} countryProperty - The property to use in the search. Must be any of the country properties (countryCode, currencyCode, etc)
-   * @param {String} value - The value to use in the filter
-   */
-  findOne: function (countryProperty, value) {
-    return countriesData.find(countryData => countryData[countryProperty] === value)
-  },
-  /**
-   * Returns a collection with fields mapped as requested
-   * @param {*} fields - Map of fields and placeholders 
-   */
-  customArray: function (fields = { name: '{countryNameEn} ({countryCode})', value: '{countryCode}'}, { sortBy, sortDataBy, filter } = {}) {
-    const finalCollection = []
-
-    let data = countriesData
-    if (typeof filter === 'function') {
-      data = data.filter(filter)
-    }
-
-    if (sortDataBy) {
-      // ignore upper and lowercase
-      const collator = new Intl.Collator([], { sensitivity:'accent' })
-      data.sort((a, b) => collator.compare(a[sortDataBy], b[sortDataBy]))
-    }
-
-    data.forEach(countryData => {
-      let collectionObject = {}
-      for (const field in fields) {
-        collectionObject[field] = supplant(fields[field], countryData)
-      }
-      finalCollection.push(collectionObject)
-    })
-
-    if (sortBy && fields[sortBy]) {
-      // ignore upper and lowercase
-      const collator = new Intl.Collator([], {sensitivity:'accent'})
-      finalCollection.sort((a, b) => collator.compare(a[sortBy], b[sortBy]))
-    }
-
-    return finalCollection
-  },
-  /**
-   * Returns a custom object with the passed key as object key and a value made up with
-   * values set in the placeholders of the label variable
-   * @param {*} key - Key used to construct the object to return
-   * @param {*} label - Placeholder like string, with all the fields that you want to use
-   */
-  customList: function (key = 'countryCode', label = '{countryNameEn} ({countryCode})', { filter } = {}) {
-    const finalObject = {}
-    let data = countriesData
-    if (typeof filter === 'function') {
-      data = data.filter(filter)
-    }
-    data.forEach(countryData => {
-      const value = supplant(label, countryData)
-      finalObject[countryData[key]] = value
-    })
-
-    return finalObject
-  }
-}

package/test.js

@@ -1,24 +0,0 @@
-function groupBy (key, array, transformValue) { 
-    return array.reduce((objectsByKeyValue, obj) => {
-      const value = obj[key];
-      let val = obj
-      if (typeof transformValue === 'function') {
-          val = transformValue(val)
-      }
-      objectsByKeyValue[value] = (objectsByKeyValue[value] || []).concat(val);
-      return objectsByKeyValue;
-    }, {})
-  };
-
-const countryCodes = require('./index')
-const tinTypes = countryCodes.customArray(
-    { value: '{tinType}', name: '{countryNameEn}' },
-    {
-      filter: (countryData) => countryData.tinType !== '',
-    },
-  )
-
-const finalTinTypes = {}
-
-
-  console.log('tinTypes', JSON.stringify(countryCodes.utils.groupBy('value', tinTypes, tinType => tinType.name), null, 2))

package/utils/groupBy.js

@@ -1,20 +0,0 @@
-'use strict'
-
-/**
- * groupBy() groups an array by the given key. A transformation may be passed to be applied when each value is concatenated
- * to the grouped component.
- * @param {string} key - The key to use to group the array
- * @param {array} array - The array to group
- * @param {function} transform - A transformation to apply to the grouped value
- */
-module.exports = function groupBy (key, array, transform) { 
-  return array.reduce((objectsByKeyValue, obj) => {
-    const value = obj[key];
-    let val = obj
-    if (typeof transform === 'function') {
-        val = transform(val)
-    }
-    objectsByKeyValue[value] = (objectsByKeyValue[value] || []).concat(val);
-    return objectsByKeyValue;
-  }, {})
-};

package/utils/supplant.js

@@ -1,16 +0,0 @@
-'use strict'
-
-/**
- * supplant() does variable substitution on the string. It scans through the string looking for
- * expressions enclosed in { } braces. If an expression is found, use it as a key on the object,
- * and if the key has a string value or number value, it is substituted for the bracket expression
- * and it repeats.
- * @param {string} stringVal - The string that needs supplanting
- * @param {object} replacements - key/value object with the keys to be replaced by the corresponding values
- */
-module.exports = function (stringVal, replacements) {
-  return stringVal.replace(/{([^{}]*)}/g, function (a, b) {
-    let r = replacements[b]
-    return typeof r === 'string' || typeof r === 'number' ? r : a
-  })
-}