countrynormalizer 0.0.1 → 0.1.1

package/dist/src/findCountryByUnqiue.d.ts

@@ -10,6 +10,7 @@ import type { AllCountryFields } from "../types/core";
  * - `formal_order` — naturally spoken order of the formal country name
  * - `flag_emoji` — Unicode flag emoji for the country
  * - `common_reference` — casual/colloquial country name
+ * - `tld (top-level domain)` - Searches for the countries top-level domain match.
  *
  * This will **not** search non-unique fields like calling codes, continents, or demonyms.
  * Use {@link findAllMatchedCountries} for those lookups.

package/dist/src/getCountriesByContinent.d.ts

@@ -0,0 +1,16 @@
+import type { ContinentNames, ContinentTrimmedFields } from "../types/core";
+/**
+ * Returns a trimmed set of country data for every country on the specified continent.
+ *
+ * The returned fields include the guaranteed unique identifier and display fields,
+ * with calling codes, demonyms, and other contact fields omitted.
+ * Use {@link findAllMatchedCountries} with a continent name if you need full country data for each entry.
+ *
+ * @param searchContinent - A continent name from the {@link ContinentNames} enum.
+ * @returns An array of trimmed country data for all countries on the given continent.
+ *
+ * @example
+ * getCountriesByContinent(ContinentNames.Antarctica); // Returns trimmed data for all Antarctic territories
+ * getCountriesByContinent(ContinentNames.Asia);       // Returns trimmed data for all Asian countries
+ */
+export declare const getCountriesByContinent: (searchContinent: ContinentNames) => ContinentTrimmedFields[];

package/dist/src/getCountryContactData.d.ts

@@ -0,0 +1,16 @@
+import type { ContactCountryFields } from "../types/core";
+/**
+ * Returns the contact fields — calling code(s), flag emoji, and top-level domain — for a country
+ * identified by its ISO 3166-1 alpha-2 code.
+ *
+ * Since contact field lookups are commonly performed on open-ended user input, the input
+ * is matched case-insensitively. If the input is not exactly 2 characters, `null` is returned.
+ *
+ * @param inputAlpha2 - A 2-character ISO 3166-1 alpha-2 country code (e.g. `"US"`, `"GB"`).
+ * @returns The contact fields for the matching country, or `null` if no match is found.
+ *
+ * @example
+ * getContactFieldsByAlpha2("GN"); // Returns { tld: ".gn", flag_emoji: "🇬🇳", calling_code: ["224"] }
+ * getContactFieldsByAlpha2("XX"); // Returns null
+ */
+export declare const getContactFieldsByAlpha2: (inputAlpha2: string) => ContactCountryFields | null;

package/dist/types/core.d.ts

@@ -14,4 +14,14 @@ export interface AllCountryFields {
     continent: string;
 }
 export type ContactCountryFields = Pick<AllCountryFields, "tld" | "flag_emoji" | "calling_code">;
-export type UniqueCountryFields = Pick<AllCountryFields, "english_clean" | "formal_order" | "alpha_2" | "alpha_3" | "num_code">;
+export declare enum ContinentNames {
+    NorthAmerica = "north_america",
+    Asia = "asia",
+    Africa = "africa",
+    Europe = "europe",
+    SouthAmerica = "south_america",
+    Oceania = "oceania",
+    Antarctica = "antarctica"
+}
+export type ContinentTrimmedFields = Pick<AllCountryFields, "english_clean" | "formal_order" | "alpha_2" | "alpha_3" | "num_code" | "tld" | "flag_emoji">;
+export type CountriesByContinent = Record<ContinentNames, ContinentTrimmedFields[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "countrynormalizer",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",