@innovayse/geo-atlas 2.0.2 → 2.2.0

package/dist/esm/helpers/CountriesAtlas.d.ts

@@ -1,38 +1,17 @@
-import { Country } from '../types/country.interface';
-import { Currency } from '../types/currency.type';
-import { PhoneCode } from '../types/phone-code.interface';
+import { CountriesData } from './CountriesData';
 import { State } from '../types/state.interface';
-import { Timezone } from '../types/timezone.type';
 /**
- * Main helper class for querying countries, states, cities, timezones,
- * calling codes and currencies from the offline geo-atlas dataset.
+ * Full offline geo-atlas helper.
+ *
+ * Extends {@link CountriesData} (country list / phone / currency / timezone —
+ * all from the small bundled `atlas.json`) and adds per-country state & city
+ * access. The state/city methods pull data through `countryLoaders`, which
+ * references every per-country JSON file (~171 MB total). Because that import
+ * lives here and NOT in `CountriesData`, consumers that only need the country
+ * list can import `CountriesData` (or the `/lite` entry) and avoid bundling the
+ * per-country dataset entirely.
  */
-export declare class CountriesAtlas {
-    /** Internal countries array loaded from the bundled atlas.json. */
-    private countries;
-    /** Initializes the atlas by loading the bundled country data. */
-    constructor();
-    /**
-     * 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?: string[]): Country[];
-    /**
-     * 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: string): Country | undefined;
-    /**
-     * 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: string): Country | undefined;
+export declare class CountriesAtlas extends CountriesData {
     /**
      * Retrieve all states of a country by its ISO2 code.
      *
@@ -41,7 +20,11 @@ export declare class CountriesAtlas {
      */
     getStates(iso2: string): State[] | undefined;
     /**
-     * Retrieve all states of a country by its ISO2 code using dynamic import (browser-compatible).
+     * Retrieve all states of a country by its ISO2 code using a static loader registry.
+     *
+     * Uses explicit string-literal dynamic imports (via countryLoaders) so bundlers
+     * such as Vite, webpack, and rollup can statically analyze paths and code-split
+     * country data. Works in both Node.js (CJS/ESM) and browser environments.
      *
      * @param {string} iso2 - ISO2 code of the country.
      * @returns {Promise<State[]>} - Promise resolving to array of state objects.
@@ -55,45 +38,6 @@ export declare class CountriesAtlas {
      * @returns {State | undefined} - State object or undefined if not found.
      */
     state(iso2: string, stateCode: string): State | undefined;
-    /**
-     * Retrieve all timezones of all available countries.
-     *
-     * @returns {Timezone[]} - Array of timezone objects.
-     */
-    getTimezones(): Timezone[];
-    /**
-     * 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: string): Timezone[] | undefined;
-    /**
-     * Retrieve all calling codes of all available countries.
-     *
-     * @returns {PhoneCode[]} - Array of phone code objects.
-     */
-    getCallingCodes(): PhoneCode[];
-    /**
-     * 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: string): PhoneCode | undefined;
-    /**
-     * Retrieve all currencies of all available countries.
-     *
-     * @returns {Currency[]} - Array of currency objects.
-     */
-    getCurrencies(): Currency[];
-    /**
-     * 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: string): Currency | undefined;
 }
 declare const _default: CountriesAtlas;
 export default _default;

package/dist/esm/helpers/CountriesAtlas.js

@@ -7,65 +7,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import countriesData from '../data/atlas.json';
+import { CountriesData } from './CountriesData';
+import countryLoaders from './countryLoaders';
 /**
- * Main helper class for querying countries, states, cities, timezones,
- * calling codes and currencies from the offline geo-atlas dataset.
+ * Full offline geo-atlas helper.
+ *
+ * Extends {@link CountriesData} (country list / phone / currency / timezone —
+ * all from the small bundled `atlas.json`) and adds per-country state & city
+ * access. The state/city methods pull data through `countryLoaders`, which
+ * references every per-country JSON file (~171 MB total). Because that import
+ * lives here and NOT in `CountriesData`, consumers that only need the country
+ * list can import `CountriesData` (or the `/lite` entry) and avoid bundling the
+ * per-country dataset entirely.
  */
-export class CountriesAtlas {
-    /** 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(); });
-    }
-    // getStates(iso2: string): Promise<State[]> | undefined {
-    //     const country = this.find(iso2)
-    //     if (country) {
-    //         return import(`../data/countries/${country.iso2?.toLowerCase()}.json`)
-    //             .then(statesData => {
-    //                 return statesData.states
-    //             })
-    //             .catch(() => {
-    //                 return undefined
-    //             })
-    //     }
-    //     return undefined
-    // }
+export class CountriesAtlas extends CountriesData {
     /**
      * Retrieve all states of a country by its ISO2 code.
      *
@@ -87,7 +42,11 @@ export class CountriesAtlas {
         return undefined;
     }
     /**
-     * Retrieve all states of a country by its ISO2 code using dynamic import (browser-compatible).
+     * Retrieve all states of a country by its ISO2 code using a static loader registry.
+     *
+     * Uses explicit string-literal dynamic imports (via countryLoaders) so bundlers
+     * such as Vite, webpack, and rollup can statically analyze paths and code-split
+     * country data. Works in both Node.js (CJS/ESM) and browser environments.
      *
      * @param {string} iso2 - ISO2 code of the country.
      * @returns {Promise<State[]>} - Promise resolving to array of state objects.
@@ -96,10 +55,13 @@ export class CountriesAtlas {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             const country = this.find(iso2);
-            if (!country || !country.iso2)
+            if (!(country === null || country === void 0 ? void 0 : country.iso2))
+                return [];
+            const loader = countryLoaders[country.iso2.toLowerCase()];
+            if (!loader)
                 return [];
             try {
-                const mod = yield import(`../data/countries/${country.iso2.toLowerCase()}.json`);
+                const mod = yield loader();
                 const data = (_a = mod.default) !== null && _a !== void 0 ? _a : mod;
                 return (_b = data.states) !== null && _b !== void 0 ? _b : [];
             }
@@ -108,18 +70,6 @@ export class CountriesAtlas {
             }
         });
     }
-    // state(iso2: string, stateCode: string): Promise<State | undefined> | undefined {
-    //     const country = this.find(iso2);
-    //     if (country) {
-    //         return import(`../data/countries/${country.iso2?.toLowerCase()}.json`)
-    //             .then((statesData: StateData) => {
-    //                 const state = statesData.states.find((s: State) => s.state_code?.toUpperCase() === stateCode);
-    //                 return state ? state : undefined;
-    //             })
-    //             .catch(() => undefined);
-    //     }
-    //     return undefined;
-    // }
     /**
      * Find a state by its state code and country ISO2 code.
      *
@@ -142,96 +92,5 @@ export class CountriesAtlas {
         }
         return undefined;
     }
-    /**
-     * 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']).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()}`
-            };
-        }
-        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 CountriesAtlas();

package/dist/esm/helpers/CountriesData.d.ts

@@ -0,0 +1,86 @@
+import { Country } from '../types/country.interface';
+import { Currency } from '../types/currency.type';
+import { PhoneCode } from '../types/phone-code.interface';
+import { Timezone } from '../types/timezone.type';
+/**
+ * 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 declare class CountriesData {
+    /** Internal countries array loaded from the bundled atlas.json. */
+    protected countries: Country[];
+    /** Initializes the atlas by loading the bundled country data. */
+    constructor();
+    /**
+     * 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?: string[]): Country[];
+    /**
+     * 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: string): Country | undefined;
+    /**
+     * 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: string): Country | undefined;
+    /**
+     * Retrieve all timezones of all available countries.
+     *
+     * @returns {Timezone[]} - Array of timezone objects.
+     */
+    getTimezones(): Timezone[];
+    /**
+     * 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: string): Timezone[] | undefined;
+    /**
+     * Retrieve all calling codes of all available countries.
+     *
+     * @returns {PhoneCode[]} - Array of phone code objects.
+     */
+    getCallingCodes(): PhoneCode[];
+    /**
+     * 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: string): PhoneCode | undefined;
+    /**
+     * Retrieve all currencies of all available countries.
+     *
+     * @returns {Currency[]} - Array of currency objects.
+     */
+    getCurrencies(): Currency[];
+    /**
+     * 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: string): Currency | undefined;
+}
+declare const _default: CountriesData;
+export default _default;

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/helpers/countryLoaders.d.ts

@@ -0,0 +1,17 @@
+import type { State } from '../types/state.interface';
+/**
+ * Auto-generated static loader registry for per-country state/city data.
+ *
+ * Each entry uses an explicit string-literal dynamic import path, allowing
+ * bundlers (Vite, webpack, rollup) to statically analyze, bundle, and
+ * code-split country data. DO NOT EDIT MANUALLY.
+ *
+ * Regenerate with: npm run generate:loaders
+ */
+declare const countryLoaders: Record<string, () => Promise<{
+    default?: {
+        states: State[];
+    };
+    states?: State[];
+}>>;
+export default countryLoaders;