@innovayse/geo-atlas 2.1.0 → 2.2.0

package/dist/esm/helpers/CountriesData.js

@@ -0,0 +1,150 @@
+import countriesData from '../data/atlas.json';
+/**
+ * Lightweight country-list helper.
+ *
+ * Loads ONLY the bundled `atlas.json` (the country list plus per-country
+ * metadata: names, translations, phone, currency, timezones). It deliberately
+ * does NOT import the per-country state/city loaders (`countryLoaders`), so
+ * importing this class never drags the ~171 MB of per-country state/city JSON
+ * into a consumer's bundle.
+ *
+ * Use this when you only need countries, phone codes, currencies or timezones
+ * — e.g. on a server-rendered path. When you need states/cities, use
+ * `CountriesAtlas` (which extends this) or the `@touchestate/geo-atlas/cities`
+ * entry point.
+ */
+export class CountriesData {
+    /** Initializes the atlas by loading the bundled country data. */
+    constructor() {
+        this.countries = countriesData;
+    }
+    /**
+     * Retrieve all countries with specified properties, or all countries if no properties are specified.
+     *
+     * @param {string[]} properties - Array of properties to retrieve.
+     * @return {Country[]} - Array of country objects with specified properties or all countries.
+     */
+    getCountries(properties) {
+        if (properties) {
+            return this.countries.map(country => {
+                const newCountry = {};
+                properties.forEach(property => {
+                    newCountry[property] = country[property];
+                });
+                return newCountry;
+            });
+        }
+        return this.countries;
+    }
+    /**
+     * Find a country by its ISO2 code.
+     *
+     * @param {string} iso2 - ISO2 code of the country to find.
+     * @return {Country | undefined} - Country object or undefined if not found.
+     */
+    find(iso2) {
+        return this.countries.find(country => { var _a; return ((_a = country.iso2) === null || _a === void 0 ? void 0 : _a.toUpperCase()) === iso2.toUpperCase(); });
+    }
+    /**
+     * Find a country by its ISO3 code.
+     *
+     * @param {string} iso3 - ISO3 code of the country to find.
+     * @return {Country | undefined} - Country object or undefined if not found.
+     */
+    findByIso3(iso3) {
+        return this.countries.find(country => { var _a; return ((_a = country.iso3) === null || _a === void 0 ? void 0 : _a.toUpperCase()) === iso3.toUpperCase(); });
+    }
+    /**
+     * Retrieve all timezones of all available countries.
+     *
+     * @returns {Timezone[]} - Array of timezone objects.
+     */
+    getTimezones() {
+        const timezoneSet = new Set();
+        this.countries.forEach(country => {
+            var _a;
+            (_a = country.timezones) === null || _a === void 0 ? void 0 : _a.forEach(timezone => {
+                timezoneSet.add(timezone);
+            });
+        });
+        return Array.from(timezoneSet);
+    }
+    /**
+     * Retrieve all timezones of a country by its ISO2 code.
+     *
+     * @param {string} iso2 - ISO2 code of the country.
+     * @returns {Timezone[] | undefined} - Array of timezone objects or undefined if not found.
+     */
+    timezone(iso2) {
+        const country = this.find(iso2);
+        if (country) {
+            return country.timezones;
+        }
+        return undefined;
+    }
+    /**
+     * Retrieve all calling codes of all available countries.
+     *
+     * @returns {PhoneCode[]} - Array of phone code objects.
+     */
+    getCallingCodes() {
+        return this.getCountries(['name', 'phone', 'iso2', 'phone_format']).map(country => {
+            var _a;
+            return Object.assign(Object.assign({}, country), { phone_code: `+${country.phone}`, flag: `flag flag-${(_a = country.iso2) === null || _a === void 0 ? void 0 : _a.toLowerCase()}` });
+        });
+    }
+    /**
+     * Retrieve calling codes of a country by its ISO2 code.
+     *
+     * @param {string} iso2 - ISO2 code of the country.
+     * @returns {PhoneCode | undefined} - Phone code object or undefined if not found.
+     */
+    callingCode(iso2) {
+        var _a;
+        const country = this.find(iso2);
+        if (country) {
+            return {
+                name: country.name,
+                phone: country.phone,
+                iso2: country.iso2,
+                phone_code: `+${country.phone}`,
+                flag: `flag flag-${(_a = country.iso2) === null || _a === void 0 ? void 0 : _a.toLowerCase()}`,
+                phone_format: country.phone_format
+            };
+        }
+        return undefined;
+    }
+    /**
+     * Retrieve all currencies of all available countries.
+     *
+     * @returns {Currency[]} - Array of currency objects.
+     */
+    getCurrencies() {
+        return this.getCountries(['name', 'iso2', 'currency', 'currency_symbol', 'currency_name']).map(country => {
+            var _a;
+            return Object.assign(Object.assign({}, country), { flag: `flag flag-${(_a = country.iso2) === null || _a === void 0 ? void 0 : _a.toLowerCase()}` });
+        });
+    }
+    /**
+     * Retrieve currency of a country by its ISO2 code.
+     *
+     * @param {string} iso2 - ISO2 code of the country.
+     * @returns {Currency | undefined} - Currency object or undefined if not found.
+     */
+    currency(iso2) {
+        var _a;
+        const country = this.find(iso2);
+        if (country) {
+            return {
+                name: country.name,
+                iso2: country.iso2,
+                currency: country.currency,
+                currency_symbol: country.currency_symbol,
+                currency_name: country.currency_name,
+                flag: `flag flag-${(_a = country.iso2) === null || _a === void 0 ? void 0 : _a.toLowerCase()}`
+            };
+        }
+        return undefined;
+    }
+}
+export default new CountriesData();

package/dist/esm/index.d.ts

@@ -13,6 +13,7 @@
  * const country = CountriesAtlas.find('US');
  */
 export { default as CountriesAtlas } from './helpers/CountriesAtlas';
+export { default as CountriesData, CountriesData as CountriesDataClass } from './helpers/CountriesData';
 export { default as ValidatorAtlas } from './helpers/ValidatorAtlas';
 export type { Country } from './types/country.interface';
 export type { State } from './types/state.interface';

package/dist/esm/index.js

@@ -13,4 +13,8 @@
  * const country = CountriesAtlas.find('US');
  */
 export { default as CountriesAtlas } from './helpers/CountriesAtlas';
+// Lightweight country-list helper (no per-country state/city dataset). Prefer
+// importing this — or the `@touchestate/geo-atlas/lite` entry — on paths that
+// only need the country list, to avoid bundling the ~171 MB per-country data.
+export { default as CountriesData, CountriesData as CountriesDataClass } from './helpers/CountriesData';
 export { default as ValidatorAtlas } from './helpers/ValidatorAtlas';

package/dist/esm/lite.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @packageDocumentation
+ * @module touchestate/geo-atlas/lite
+ *
+ * @description Lightweight entry point exposing only the country list and its
+ * metadata (names, translations, phone codes, currencies, timezones). Importing
+ * from here loads just the small bundled `atlas.json` — it never references the
+ * per-country state/city dataset (~171 MB), so it is safe to use on
+ * server-rendered / memory-constrained bundling paths.
+ *
+ * For states/cities, import from `@touchestate/geo-atlas/cities` (loaded on
+ * demand, browser/client side) or use the full `CountriesAtlas` from the root
+ * entry point.
+ *
+ * @license MIT
+ *
+ * @example
+ * import CountriesData from '@touchestate/geo-atlas/lite';
+ * const countries = CountriesData.getCountries();
+ * const country = CountriesData.find('US');
+ */
+export { CountriesData, default } from './helpers/CountriesData';
+export type { Country } from './types/country.interface';
+export type { Timezone } from './types/timezone.type';
+export type { Translations } from './types/translation.type';
+export type { Currency } from './types/currency.type';
+export type { PhoneCode } from './types/phone-code.interface';

package/dist/esm/lite.js

@@ -0,0 +1,22 @@
+/**
+ * @packageDocumentation
+ * @module touchestate/geo-atlas/lite
+ *
+ * @description Lightweight entry point exposing only the country list and its
+ * metadata (names, translations, phone codes, currencies, timezones). Importing
+ * from here loads just the small bundled `atlas.json` — it never references the
+ * per-country state/city dataset (~171 MB), so it is safe to use on
+ * server-rendered / memory-constrained bundling paths.
+ *
+ * For states/cities, import from `@touchestate/geo-atlas/cities` (loaded on
+ * demand, browser/client side) or use the full `CountriesAtlas` from the root
+ * entry point.
+ *
+ * @license MIT
+ *
+ * @example
+ * import CountriesData from '@touchestate/geo-atlas/lite';
+ * const countries = CountriesData.getCountries();
+ * const country = CountriesData.find('US');
+ */
+export { CountriesData, default } from './helpers/CountriesData';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@innovayse/geo-atlas",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Offline countries, states and cities with multilingual support (EN/RU/HY + 15 languages).",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -11,6 +11,16 @@
       "require": "./dist/cjs/index.js",
       "types": "./dist/cjs/index.d.ts"
     },
+    "./lite": {
+      "import": "./dist/esm/lite.js",
+      "require": "./dist/cjs/lite.js",
+      "types": "./dist/cjs/lite.d.ts"
+    },
+    "./cities": {
+      "import": "./dist/esm/cities.js",
+      "require": "./dist/cjs/cities.js",
+      "types": "./dist/cjs/cities.d.ts"
+    },
     "./country": {
       "import": "./dist/esm/types/country.interface.js",
       "require": "./dist/cjs/types/country.interface.js",
@@ -49,6 +59,8 @@
   },
   "typesVersions": {
     "*": {
+      "lite": ["./dist/cjs/lite.d.ts"],
+      "cities": ["./dist/cjs/cities.d.ts"],
       "country": ["./dist/cjs/types/country.interface.d.ts"],
       "state": ["./dist/cjs/types/state.interface.d.ts"],
       "city": ["./dist/cjs/types/city.type.d.ts"],