country-codes-list 2.0.0 → 2.1.0

package/src/index.ts

@@ -1,95 +0,0 @@
-import groupBy from "./utils/groupBy";
-import supplant from "./utils/supplant";
-import countriesData, { CountryData, CountryProperty } from "./countriesData";
-
-export type { CountryData, CountryProperty };
-
-export const utils = {
-  groupBy,
-};
-
-export function all(): CountryData[] {
-  return countriesData;
-}
-
-export function filter(
-  countryProperty: CountryProperty,
-  value: string
-): CountryData[] {
-  return countriesData.filter(
-    (countryData: CountryData) => countryData[countryProperty] === value
-  );
-}
-
-export function findOne(
-  countryProperty: CountryProperty,
-  value: string
-): CountryData | undefined {
-  return countriesData.find(
-    (countryData: CountryData) => countryData[countryProperty] === value
-  );
-}
-
-export function customArray(
-  fields: Record<string, string> = {
-    name: "{countryNameEn} ({countryCode})",
-    value: "{countryCode}",
-  },
-  {
-    sortBy,
-    sortDataBy,
-    filter: filterFunc,
-  }: {
-    sortBy?: CountryProperty;
-    sortDataBy?: CountryProperty;
-    filter?: (cd: CountryData) => boolean;
-  } = {}
-) {
-  const finalCollection: Record<string, string>[] = [];
-  let data: CountryData[] = countriesData;
-  if (typeof filterFunc === "function") {
-    data = data.filter(filterFunc);
-  }
-
-  if (sortDataBy) {
-    const collator = new Intl.Collator([], { sensitivity: "accent" });
-    data.sort((a: CountryData, b: CountryData) =>
-      collator.compare(a[sortDataBy] as string, b[sortDataBy] as string)
-    );
-  }
-
-  data.forEach((countryData: CountryData) => {
-    const collectionObject: Record<string, string> = {};
-    for (const field in fields) {
-      collectionObject[field] = supplant(fields[field], countryData);
-    }
-    finalCollection.push(collectionObject);
-  });
-
-  if (sortBy && fields[sortBy as string]) {
-    const collator = new Intl.Collator([], { sensitivity: "accent" });
-    finalCollection.sort((a, b) =>
-      collator.compare(a[sortBy as string], b[sortBy as string])
-    );
-  }
-
-  return finalCollection;
-}
-
-export function customList(
-  key: keyof CountryData = "countryCode",
-  label: string = "{countryNameEn} ({countryCode})",
-  { filter: filterFunc }: { filter?: (cd: CountryData) => boolean } = {}
-) {
-  const finalObject: Record<string, string> = {};
-  let data: CountryData[] = countriesData;
-  if (typeof filterFunc === "function") {
-    data = data.filter(filterFunc);
-  }
-  data.forEach((countryData: CountryData) => {
-    const value = supplant(label, countryData);
-    finalObject[String(countryData[key])] = value;
-  });
-
-  return finalObject;
-}

package/src/utils/groupBy.ts

@@ -1,19 +0,0 @@
-/**
- * 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[]> {
-  return array.reduce((result, item) => {
-    const groupKey = String(item[key]);
-    if (!result[groupKey]) {
-      result[groupKey] = [];
-    }
-    result[groupKey].push(item);
-    return result;
-  }, {} as Record<string, T[]>);
-}

package/src/utils/supplant.ts

@@ -1,17 +0,0 @@
-/**
- * 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 {
-  return template.replace(
-    /{([^{}]*)}/g,
-    (match: string, key: string): string => {
-      const value = data[key];
-      return typeof value === "string" || typeof value === "number"
-        ? value.toString()
-        : match;
-    }
-  );
-}

package/tests/index.test.ts

@@ -1,62 +0,0 @@
-import * as countryCodes from "../src/index";
-
-describe("country-codes-list", () => {
-  test("all returns a non-empty array", () => {
-    const data = countryCodes.all();
-    expect(Array.isArray(data)).toBe(true);
-    expect(data.length).toBeGreaterThan(0);
-  });
-
-  test("filter returns correct countries", () => {
-    const result = countryCodes.filter("countryCode", "AD");
-    expect(result.length).toBeGreaterThan(0);
-    expect(result[0].countryNameEn).toBe("Andorra");
-  });
-
-  test("findOne returns a country", () => {
-    const result = countryCodes.findOne("countryCode", "AF");
-    expect(result).toBeDefined();
-    if (result) {
-      expect(result.countryNameEn).toBe("Afghanistan");
-    }
-  });
-
-  test("customArray returns mapped array with correct placeholders", () => {
-    const fields = {
-      customName: "{countryNameEn}",
-      customCode: "{countryCode}",
-    };
-    const result = countryCodes.customArray(fields);
-    expect(result.length).toBeGreaterThan(0);
-    expect(result[0]).toHaveProperty("customName");
-    expect(result[0]).toHaveProperty("customCode");
-  });
-
-  test("customList returns object with countryCode as key", () => {
-    const list = countryCodes.customList("countryCode", "{countryNameEn}");
-    expect(Object.keys(list).length).toBeGreaterThan(0);
-    expect(list["AD"]).toBeDefined();
-  });
-
-  test("all countriesData are valid", () => {
-    const data = countryCodes.all();
-    const shape = {
-      countryNameEn: expect.any(String),
-      countryNameLocal: expect.any(String),
-      countryCode: expect.any(String),
-      currencyCode: expect.any(String),
-      currencyNameEn: expect.any(String),
-      tinType: expect.any(String),
-      tinName: expect.any(String),
-      officialLanguageCode: expect.any(String),
-      officialLanguageNameEn: expect.any(String),
-      officialLanguageNameLocal: expect.any(String),
-      countryCallingCode: expect.any(String),
-      region: expect.any(String),
-      flag: expect.any(String),
-    };
-    data.forEach((country) => {
-      expect(country).toMatchObject(shape);
-    });
-  });
-});

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "target": "ES6",
-    "module": "CommonJS",
-    "declaration": true,
-    "strict": true,
-    "esModuleInterop": true
-  },
-  "include": ["src/**/*"]
-}