country-codes-list 1.6.12 → 2.0.0

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+import groupBy from "./utils/groupBy";
+import { CountryData, CountryProperty } from "./countriesData";
+export type { CountryData, CountryProperty };
+export declare const utils: {
+    groupBy: typeof groupBy;
+};
+export declare function all(): CountryData[];
+export declare function filter(countryProperty: CountryProperty, value: string): CountryData[];
+export declare function findOne(countryProperty: CountryProperty, value: string): CountryData | undefined;
+export declare function customArray(fields?: Record<string, string>, { sortBy, sortDataBy, filter: filterFunc, }?: {
+    sortBy?: CountryProperty;
+    sortDataBy?: CountryProperty;
+    filter?: (cd: CountryData) => boolean;
+}): Record<string, string>[];
+export declare function customList(key?: keyof CountryData, label?: string, { filter: filterFunc }?: {
+    filter?: (cd: CountryData) => boolean;
+}): Record<string, string>;

package/dist/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customList = exports.customArray = exports.findOne = exports.filter = exports.all = exports.utils = void 0;
+const groupBy_1 = __importDefault(require("./utils/groupBy"));
+const supplant_1 = __importDefault(require("./utils/supplant"));
+const countriesData_1 = __importDefault(require("./countriesData"));
+exports.utils = {
+    groupBy: groupBy_1.default,
+};
+function all() {
+    return countriesData_1.default;
+}
+exports.all = all;
+function filter(countryProperty, value) {
+    return countriesData_1.default.filter((countryData) => countryData[countryProperty] === value);
+}
+exports.filter = filter;
+function findOne(countryProperty, value) {
+    return countriesData_1.default.find((countryData) => countryData[countryProperty] === value);
+}
+exports.findOne = findOne;
+function customArray(fields = {
+    name: "{countryNameEn} ({countryCode})",
+    value: "{countryCode}",
+}, { sortBy, sortDataBy, filter: filterFunc, } = {}) {
+    const finalCollection = [];
+    let data = countriesData_1.default;
+    if (typeof filterFunc === "function") {
+        data = data.filter(filterFunc);
+    }
+    if (sortDataBy) {
+        const collator = new Intl.Collator([], { sensitivity: "accent" });
+        data.sort((a, b) => collator.compare(a[sortDataBy], b[sortDataBy]));
+    }
+    data.forEach((countryData) => {
+        const collectionObject = {};
+        for (const field in fields) {
+            collectionObject[field] = (0, supplant_1.default)(fields[field], countryData);
+        }
+        finalCollection.push(collectionObject);
+    });
+    if (sortBy && fields[sortBy]) {
+        const collator = new Intl.Collator([], { sensitivity: "accent" });
+        finalCollection.sort((a, b) => collator.compare(a[sortBy], b[sortBy]));
+    }
+    return finalCollection;
+}
+exports.customArray = customArray;
+function customList(key = "countryCode", label = "{countryNameEn} ({countryCode})", { filter: filterFunc } = {}) {
+    const finalObject = {};
+    let data = countriesData_1.default;
+    if (typeof filterFunc === "function") {
+        data = data.filter(filterFunc);
+    }
+    data.forEach((countryData) => {
+        const value = (0, supplant_1.default)(label, countryData);
+        finalObject[String(countryData[key])] = value;
+    });
+    return finalObject;
+}
+exports.customList = customList;

package/dist/utils/groupBy.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Groups an array by a specified key.
+ * @param array - The array to group.
+ * @param key - The key to group the array by.
+ * @returns An object where each key is a unique value from the array, and each value is an array of items from the original array that match the key.
+ */
+export default function groupBy<T>(array: T[], key: keyof T): Record<string, T[]>;

package/dist/utils/groupBy.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Groups an array by a specified key.
+ * @param array - The array to group.
+ * @param key - The key to group the array by.
+ * @returns An object where each key is a unique value from the array, and each value is an array of items from the original array that match the key.
+ */
+function groupBy(array, key) {
+    return array.reduce((result, item) => {
+        const groupKey = String(item[key]);
+        if (!result[groupKey]) {
+            result[groupKey] = [];
+        }
+        result[groupKey].push(item);
+        return result;
+    }, {});
+}
+exports.default = groupBy;

package/dist/utils/supplant.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Replaces placeholders in a string with values from an object.
+ * @param template - The string containing placeholders.
+ * @param data - The object containing key-value pairs for replacement.
+ * @returns The string with placeholders replaced by values.
+ */
+export default function supplant(template: string, data: any): string;

package/dist/utils/supplant.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Replaces placeholders in a string with values from an object.
+ * @param template - The string containing placeholders.
+ * @param data - The object containing key-value pairs for replacement.
+ * @returns The string with placeholders replaced by values.
+ */
+function supplant(template, data) {
+    return template.replace(/{([^{}]*)}/g, (match, key) => {
+        const value = data[key];
+        return typeof value === "string" || typeof value === "number"
+            ? value.toString()
+            : match;
+    });
+}
+exports.default = supplant;

package/package.json

@@ -1,37 +1,51 @@
 {
   "name": "country-codes-list",
-  "version": "1.6.12",
-  "description": "List of codes per country (languages, calling codes, currency codes, etc)",
-  "main": "index.js",
-  "types": "./index.d.ts",
+  "version": "2.0.0",
+  "description": "List of codes per country (languages, calling codes, currency codes, etc) with full TypeScript support.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\""
+    "build": "tsc",
+    "test": "jest",
+    "prepublishOnly": "npm run build"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/LucianoGanga/country-codes.git"
+    "url": "git+https://github.com/Synergy-Shock/country-codes-list.git"
   },
   "keywords": [
     "country",
     "code",
     "currency",
-    "code",
-    "country",
     "list",
     "language",
-    "per",
-    "country",
-    "languages",
-    "list",
     "calling",
     "codes",
+    "countries",
+    "iso",
     "phone",
-    "codes"
+    "international",
+    "i18n",
+    "typescript",
+    "tin"
   ],
   "author": "Luciano Andrés Ganga Carabante",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/LucianoGanga/country-codes/issues"
+    "url": "https://github.com/Synergy-Shock/country-codes-list/issues"
+  },
+  "homepage": "https://github.com/Synergy-Shock/country-codes-list#readme",
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "^4.9.0"
   },
-  "homepage": "https://github.com/LucianoGanga/country-codes#readme"
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "testMatch": [
+      "**/tests/**/*.test.ts"
+    ]
+  }
 }