national-metadata 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Expatria, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,261 @@
+# 🌍 Jiang Hu
+
+The internet's most helpful npm package for comprehensive country data, including utility functions to help work with ISO codes, names, continents, and mercator coordinates.
+
+## Installation
+
+```bash
+npm install jiang-hu
+```
+
+## Quick Start
+
+```typescript
+import { helloWorld, getCountryNameFromCode, convertTwoToThree } from 'jiang-hu';
+
+// Hello World function
+console.log(helloWorld()); // "Mr World Wide is here"
+
+// Convert ISO codes
+console.log(getCountryNameFromCode('US')); // "United States"
+console.log(convertTwoToThree('US')); // "USA"
+```
+
+## API Reference
+
+### Hello World Function
+
+```typescript
+helloWorld(): string
+```
+Returns the signature greeting: "Mr World Wide is here"
+
+### Country Code Conversion
+
+#### `convertTwoToThree(twoDigitCode: string): string | undefined`
+Converts 2-digit ISO country codes to 3-digit codes.
+
+```typescript
+convertTwoToThree('US'); // "USA"
+convertTwoToThree('GB'); // "GBR"
+convertTwoToThree('DE'); // "DEU"
+```
+
+#### `convertThreeToTwo(threeDigitCode: string): string | undefined`
+Converts 3-digit ISO country codes to 2-digit codes.
+
+```typescript
+convertThreeToTwo('USA'); // "US"
+convertThreeToTwo('GBR'); // "GB"
+convertThreeToTwo('DEU'); // "DE"
+```
+
+### Country Name Functions
+
+#### `getCountryNameFromCode(code: string): string | undefined`
+Gets country name from 2-digit ISO code.
+
+```typescript
+getCountryNameFromCode('US'); // "United States"
+getCountryNameFromCode('FR'); // "France"
+getCountryNameFromCode('JP'); // "Japan"
+```
+
+#### `getCountryCodeFromName(countryName: string): string | undefined`
+Gets 2-digit ISO code from country name.
+
+```typescript
+getCountryCodeFromName('United States'); // "US"
+getCountryCodeFromName('France'); // "FR"
+getCountryCodeFromName('Japan'); // "JP"
+```
+
+### Geographic Data
+
+#### `getMercatorCoordinates(threeDigitCode: string): [number, number] | undefined`
+Gets mercator coordinates [longitude, latitude] for a country.
+
+```typescript
+getMercatorCoordinates('USA'); // [-95.71, 37.09]
+getMercatorCoordinates('GBR'); // [-3.48, 52.35]
+getMercatorCoordinates('JPN'); // [139.75, 35.68]
+```
+
+#### `getCountrySizeScale(threeDigitCode: string): number | undefined`
+Gets the size scale factor for map visualization.
+
+```typescript
+getCountrySizeScale('USA'); // 300
+getCountrySizeScale('GBR'); // 800
+getCountrySizeScale('MCO'); // 2500 (Monaco - smaller countries have higher scale)
+```
+
+## Data Exports
+
+### Raw Data Objects
+
+```typescript
+import { 
+  code_to_country,
+  country_to_code,
+  list_of_countries,
+  country_name_strings,
+  mercator_hash,
+  countrySizeScales,
+  twoToThree,
+  threeToTwo
+} from 'jiang-hu';
+```
+
+#### `code_to_country`
+Object mapping 2-digit ISO codes to country names.
+
+```typescript
+code_to_country['US']; // "United States"
+code_to_country['GB']; // "United Kingdom"
+```
+
+#### `country_to_code`
+Object mapping country names to 2-digit ISO codes.
+
+```typescript
+country_to_code['United States']; // "US"
+country_to_code['United Kingdom']; // "UK"
+```
+
+#### `list_of_countries`
+Array of country objects with ISO code, name, and continent.
+
+```typescript
+// Returns array of objects like:
+{
+  iso_two: "US",
+  name: "United States of America",
+  continent: "North America"
+}
+```
+
+#### `country_name_strings`
+Simple array of country names.
+
+```typescript
+// ["United States", "Afghanistan", "Albania", ...]
+```
+
+#### `mercator_hash`
+Object mapping 3-digit ISO codes to [longitude, latitude] coordinates.
+
+```typescript
+mercator_hash['USA']; // [-95.71, 37.09]
+```
+
+#### `countrySizeScales`
+Object mapping 3-digit ISO codes to size scale factors for visualization.
+
+```typescript
+countrySizeScales['USA']; // 300
+```
+
+## TypeScript Support
+
+Full TypeScript support with exported types:
+
+```typescript
+import type { 
+  Country,
+  CountryMapping,
+  MercatorCoordinate,
+  CountryCode,
+  CountryName,
+  ThreeDigitCode,
+  TwoDigitCode
+} from 'jiang-hu';
+
+// Country interface
+interface Country {
+  iso_two: string;
+  name: string;
+  continent: string;
+}
+
+// Type-safe country codes
+type CountryCode = keyof typeof code_to_country;
+type CountryName = keyof typeof country_to_code;
+```
+
+## Use Cases
+
+- **Geographic Applications**: Use mercator coordinates for map plotting
+- **Form Validation**: Validate country codes and names
+- **Data Normalization**: Convert between different ISO code formats
+- **Analytics**: Group data by continent using the country list
+- **Internationalization**: Display localized country names
+
+## Examples
+
+### Building a Country Selector
+
+```typescript
+import { list_of_countries, getCountryCodeFromName } from 'jiang-hu';
+
+// Create dropdown options
+const countryOptions = list_of_countries.map(country => ({
+  value: country.iso_two,
+  label: country.name,
+  continent: country.continent
+}));
+
+// Group by continent
+const continentGroups = countryOptions.reduce((groups, country) => {
+  const continent = country.continent;
+  if (!groups[continent]) groups[continent] = [];
+  groups[continent].push(country);
+  return groups;
+}, {} as Record<string, typeof countryOptions>);
+```
+
+### Map Visualization
+
+```typescript
+import { mercator_hash, countrySizeScales } from 'jiang-hu';
+
+// Plot countries on a map
+Object.entries(mercator_hash).forEach(([code, [lng, lat]]) => {
+  const scale = countrySizeScales[code] || 1000;
+  plotCountryOnMap(code, lng, lat, scale);
+});
+```
+
+### Data Validation
+
+```typescript
+import { convertTwoToThree, getCountryNameFromCode } from 'jiang-hu';
+
+function validateCountryCode(code: string): boolean {
+  return getCountryNameFromCode(code) !== undefined;
+}
+
+function normalizeCountryCode(code: string): string | null {
+  if (code.length === 2) {
+    return convertTwoToThree(code) || null;
+  }
+  return code.length === 3 ? code : null;
+}
+```
+
+## Contributing
+
+We welcome contributions! Please see our contributing guidelines for more details.
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Changelog
+
+### v1.0.0
+- Initial release with comprehensive country data
+- ISO code conversion utilities
+- Mercator coordinates for map visualization
+- Full TypeScript support
+- Hello World function: "Mr World Wide is here"

package/dist/code-to-country.d.ts

@@ -0,0 +1,225 @@
+export declare const code_to_country: {
+    AF: string;
+    AL: string;
+    DZ: string;
+    AD: string;
+    AO: string;
+    AQ: string;
+    AG: string;
+    AR: string;
+    AM: string;
+    AW: string;
+    AU: string;
+    AT: string;
+    AZ: string;
+    BS: string;
+    BH: string;
+    BD: string;
+    BB: string;
+    BY: string;
+    BE: string;
+    GD: string;
+    BJ: string;
+    BM: string;
+    BT: string;
+    BO: string;
+    BQ: string;
+    BA: string;
+    BW: string;
+    BR: string;
+    BN: string;
+    BG: string;
+    BI: string;
+    BF: string;
+    CV: string;
+    KH: string;
+    CM: string;
+    CA: string;
+    KY: string;
+    CF: string;
+    TD: string;
+    CL: string;
+    CN: string;
+    CO: string;
+    KM: string;
+    CK: string;
+    CG: string;
+    CD: string;
+    CR: string;
+    HR: string;
+    CU: string;
+    CW: string;
+    CY: string;
+    CZ: string;
+    DK: string;
+    DJ: string;
+    DM: string;
+    DO: string;
+    EC: string;
+    EG: string;
+    SV: string;
+    GW: string;
+    GQ: string;
+    ER: string;
+    SZ: string;
+    EE: string;
+    ET: string;
+    FK: string;
+    FM: string;
+    FJ: string;
+    FI: string;
+    FR: string;
+    GF: string;
+    GA: string;
+    GM: string;
+    GE: string;
+    DE: string;
+    GH: string;
+    GI: string;
+    GR: string;
+    GL: string;
+    GU: string;
+    GP: string;
+    GT: string;
+    GG: string;
+    GN: string;
+    GY: string;
+    HT: string;
+    HN: string;
+    HK: string;
+    HU: string;
+    IS: string;
+    IN: string;
+    ID: string;
+    IR: string;
+    IQ: string;
+    IE: string;
+    IM: string;
+    IL: string;
+    IT: string;
+    CI: string;
+    JM: string;
+    JP: string;
+    JE: string;
+    JO: string;
+    KZ: string;
+    KE: string;
+    KI: string;
+    KR: string;
+    KP: string;
+    XK: string;
+    KW: string;
+    KG: string;
+    LA: string;
+    LV: string;
+    LB: string;
+    LR: string;
+    LY: string;
+    LS: string;
+    LI: string;
+    LT: string;
+    LU: string;
+    MH: string;
+    MO: string;
+    MG: string;
+    MW: string;
+    MY: string;
+    MV: string;
+    ML: string;
+    MT: string;
+    MR: string;
+    MU: string;
+    MX: string;
+    MD: string;
+    MC: string;
+    MN: string;
+    ME: string;
+    MA: string;
+    MZ: string;
+    MM: string;
+    NA: string;
+    NR: string;
+    NL: string;
+    NP: string;
+    NC: string;
+    NZ: string;
+    NI: string;
+    NE: string;
+    NG: string;
+    MK: string;
+    NO: string;
+    OM: string;
+    PK: string;
+    PW: string;
+    PS: string;
+    PA: string;
+    PG: string;
+    PY: string;
+    PE: string;
+    PH: string;
+    PL: string;
+    PT: string;
+    PR: string;
+    QA: string;
+    RO: string;
+    RU: string;
+    RW: string;
+    SH: string;
+    KN: string;
+    LC: string;
+    VC: string;
+    WS: string;
+    SM: string;
+    ST: string;
+    SA: string;
+    SN: string;
+    RS: string;
+    SC: string;
+    SL: string;
+    SG: string;
+    SX: string;
+    SK: string;
+    SI: string;
+    SB: string;
+    SO: string;
+    ZA: string;
+    GS: string;
+    SS: string;
+    ES: string;
+    LK: string;
+    SD: string;
+    SR: string;
+    SE: string;
+    CH: string;
+    SY: string;
+    TW: string;
+    TJ: string;
+    TZ: string;
+    TH: string;
+    TL: string;
+    TG: string;
+    TO: string;
+    TT: string;
+    TN: string;
+    TR: string;
+    TM: string;
+    TV: string;
+    UG: string;
+    UA: string;
+    AE: string;
+    UK: string;
+    US: string;
+    UY: string;
+    UZ: string;
+    VU: string;
+    VA: string;
+    VE: string;
+    VN: string;
+    VI: string;
+    VG: string;
+    EH: string;
+    YE: string;
+    ZM: string;
+    ZW: string;
+};
+//# sourceMappingURL=code-to-country.d.ts.map

package/dist/code-to-country.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"code-to-country.d.ts","sourceRoot":"","sources":["../src/code-to-country.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA+NzB,CAAC"}