@temboplus/frontend-core 0.2.4 → 0.2.6

package/README.md

@@ -1,4 +1,3 @@
-```markdown
 # @temboplus/frontend-core
 
 A robust and versatile JavaScript/TypeScript library designed to streamline the development of TemboPlus front-end applications. This library provides a comprehensive suite of utilities, standardized data models, and services to ensure consistency, efficiency, and maintainability across all TemboPlus projects.
@@ -18,7 +17,7 @@ This library offers a set of meticulously crafted data models, each designed to
 * **TZPhoneNumber:** Specialized phone number handling for Tanzania, including network operator identification.
 * **Amount:** Precise currency value management, with support for formatting and conversion.
 * **Currency:** Detailed currency information, including symbols, formatting rules, and validation.
-* **Country:** Standardized country data with ISO codes and comprehensive validation.
+* **Country:** Enhanced country data handling with ISO-2 and ISO-3 codes, official names, flag emojis, and strongly-typed geographical categorization.
 * **Bank:** Consistent bank account information management.
 
 ## Report Management with `ReportManager`
@@ -70,7 +69,7 @@ import { ConfigService } from '@temboplus/frontend-core';
 
 // Initialize configuration at application startup
 ConfigService.instance.initialize({
-    pdfMakerBaseUrl: 'https://api.temboplus.com/pdf-maker' // Optional: Override default PDF maker base URL.
+    pdfMakerBaseUrl: 'http://localhost:3000' // Optional: Override default PDF maker base URL.
 });
 ```
 
@@ -102,40 +101,81 @@ if (phoneNumber.validate()) {
 }
 ```
 
+## Type-Safe String Literals
+
+This library provides strongly-typed string literals for standardized codes:
+
+* **Country Codes:**
+  * `ISO2CountryCode`: Two-letter country codes (e.g., "US", "GB", "DE")
+  * `ISO3CountryCode`: Three-letter country codes (e.g., "USA", "GBR", "DEU")
+  * `CountryCode`: A union type that accepts either ISO-2 or ISO-3 formats
+
+* **Currency Codes:**
+  * `CurrencyCode`: Three-letter currency codes (e.g., "USD", "EUR", "JPY")
+
+These types provide compile-time validation and auto-completion while having zero runtime overhead:
+
+```typescript
+import { 
+  ISO2CountryCode, 
+  ISO3CountryCode, 
+  CountryCode, 
+  CurrencyCode 
+} from '@temboplus/frontend-core';
+
+// Type-safe function parameters
+function processTransaction(
+  amount: number,
+  currency: CurrencyCode,
+  country: CountryCode
+) {
+  // Implementation
+}
+
+// Valid calls - compile-time checking ensures only valid codes are accepted
+processTransaction(100, "USD", "US");   // ISO-2 country code
+processTransaction(200, "EUR", "DEU");  // ISO-3 country code
+
+// Invalid calls - caught by TypeScript at compile time
+processTransaction(300, "XYZ", "US");   // Error: "XYZ" is not a valid CurrencyCode
+processTransaction(400, "USD", "ZZZ");  // Error: "ZZZ" is not a valid CountryCode
+```
+
 ## Static Data Access
 
 Convenient static properties are available for accessing common data:
 
 ```typescript
-import { Country, Currency, Bank } from '@temboplus/frontend-core';
+import { Country, Currency, Bank, CONTINENT, SUB_REGION } from '@temboplus/frontend-core';
 
-// Country access
+// Country access with enhanced features
 const tanzania = Country.TZ;
-const usa = Country.UNITED_STATES;
+console.log(tanzania.flagEmoji); // 🇹🇿
+console.log(tanzania.continent); // CONTINENT.AFRICA
+console.log(tanzania.region); // SUB_REGION.EASTERN_AFRICA
+
+// Regional country grouping with type-safe enums
+const africanCountries = Country.getByContinent(CONTINENT.AFRICA);
+const caribbeanCountries = Country.getByRegion(SUB_REGION.CARIBBEAN);
 
 // Currency access
 const usd = Currency.USD;
 const tzs = Currency.TANZANIAN_SHILLING;
 
+// Access country's currency
+const japan = Country.JP;
+const yen = japan.getCurrency();
+console.log(yen?.code); // "JPY"
+
+// Find countries using a specific currency
+const euroCountries = Country.getByCurrencyCode("EUR");
+console.log(`${euroCountries.length} countries use the Euro`);
+
 // Bank access
 const crdb = Bank.CRDB;
 const nmb = Bank.NMB;
 ```
 
-## Detailed Model Documentation
-
-* [PhoneNumber](./docs/phone_number.md)
-* [Amount](./docs/amount.md)
-* [Bank](./docs/bank.md)
-* [Currency](./docs/currency.md)
-* [Country](./docs/country.md)
-
-## Installation
-
-```bash
-npm install @temboplus/frontend-core
-```
-
 ## Phone Number Usage
 
 ```typescript
@@ -150,3 +190,17 @@ const tanzaniaPhone = TZPhoneNumber.from("0712345678");
 console.log(tanzaniaPhone.getWithFormat(PhoneNumberFormat.INTERNATIONAL)); // +255 712 345 678
 console.log(tanzaniaPhone.networkOperator.name); // "Yas"
 ```
+
+## Detailed Model Documentation
+
+* [PhoneNumber](./docs/phone_number.md)
+* [Amount](./docs/amount.md)
+* [Bank](./docs/bank.md)
+* [Currency](./docs/currency.md)
+* [Country](./docs/country.md)
+
+## Installation
+
+```bash
+npm install @temboplus/frontend-core
+```

package/esm/src/data/countries.d.ts

@@ -1,6 +1,39 @@
 declare const _default: {
-    name: string;
-    code: string;
-}[];
+    dataset_name: string;
+    version: string;
+    description: string;
+    "source(s)": ({
+        name: string;
+        url: string;
+    } | {
+        name: string;
+        url: null;
+    })[];
+    last_updated: string;
+    creation_date: string;
+    license: string;
+    coverage: string;
+    contact_info: string;
+    notes: string;
+    countries: ({
+        name: string;
+        name_official: string;
+        iso_2: string;
+        iso_3: string;
+        flag_emoji: string;
+        continent: string;
+        region: string;
+        currency_iso_code: string;
+    } | {
+        name: string;
+        name_official: string;
+        iso_2: string;
+        iso_3: string;
+        flag_emoji: string;
+        continent: string;
+        region: string;
+        currency_iso_code: null;
+    })[];
+};
 export default _default;
 //# sourceMappingURL=countries.d.ts.map