{"_id":"vietnam-address-database","name":"vietnam-address-database","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"vietnam-address-database","version":"1.0.0","description":"Raw JSON database for Vietnamese administrative addresses according to Resolution 202/2025/QH15","main":"index.js","types":"index.d.ts","scripts":{"test":"node test.js","build":"node build-js.js","prepublishOnly":"npm run build"},"keywords":["vietnam","address","database","provinces","districts","wards","administrative","vietnamese","json","data"],"author":{"name":"Quang Tam"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/quangtam/vietnam-address-database.git"},"engines":{"node":">=12.0.0"},"_id":"vietnam-address-database@1.0.0","gitHead":"cf9aa6d3fd38661dcb0c6248adeb003384b8e2ea","bugs":{"url":"https://github.com/quangtam/vietnam-address-database/issues"},"homepage":"https://github.com/quangtam/vietnam-address-database#readme","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-v1P3H/0tQv8zypy2QvH4dbbCoCRzXdOSr6d7EfaDhJkUU2kK9KBrXIqnqEA4WKBOou5snIgGa1JDxlqcCeB0cw==","shasum":"8aed9ca167a353a09901d93ebe7c4553f9277b3b","tarball":"https://registry.npmjs.org/vietnam-address-database/-/vietnam-address-database-1.0.0.tgz","fileCount":5,"unpackedSize":3955822,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCmDOJ7gkeRBt0Uen3MwQ6CbWVhMRzyY9MF7a6RRlBE7AIhAPHAZfw9IYjJdLSVWIyioZnPfGvgRcJW0k0Q1vVOYi4J"}]},"_npmUser":{"name":"quangtamvu","email":"quangtamvu@gmail.com"},"directories":{},"maintainers":[{"name":"quangtamvu","email":"quangtamvu@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/vietnam-address-database_1.0.0_1752598184147_0.11000211723105213"},"_hasShrinkwrap":false}},"time":{"created":"2025-07-15T16:49:44.146Z","1.0.0":"2025-07-15T16:49:44.389Z","modified":"2025-07-15T16:49:44.621Z"},"maintainers":[{"name":"quangtamvu","email":"quangtamvu@gmail.com"}],"description":"Raw JSON database for Vietnamese administrative addresses according to Resolution 202/2025/QH15","homepage":"https://github.com/quangtam/vietnam-address-database#readme","keywords":["vietnam","address","database","provinces","districts","wards","administrative","vietnamese","json","data"],"repository":{"type":"git","url":"git+https://github.com/quangtam/vietnam-address-database.git"},"author":{"name":"Quang Tam"},"bugs":{"url":"https://github.com/quangtam/vietnam-address-database/issues"},"license":"MIT","readme":"# Vietnam Address Database (JavaScript/TypeScript)\n\nRaw JSON database for Vietnamese administrative addresses according to Resolution 202/2025/QH15.\n\nThis package contains only the raw database and is designed to be used as a dependency in other JavaScript/TypeScript libraries.\n\n## Installation\n\n```bash\nnpm install vietnam-address-database\n```\n\n## Usage\n\n### CommonJS\n\n```javascript\nconst addressData = require('vietnam-address-database');\nconsole.log(addressData[0].version); // \"1.1\"\n```\n\n### ES Modules\n\n```javascript\nimport addressData from 'vietnam-address-database';\nconsole.log(addressData[0].version); // \"1.1\"\n```\n\n### Usage in other libraries\n\nThis package is designed to be required/imported in other libraries:\n\n```javascript\n// In your address processing library\nconst vietnamAddressDB = require('vietnam-address-database');\n\n// Parse the data structure\nlet provinces = [];\nlet wards = [];\nlet wardMappings = [];\n\nvietnamAddressDB.forEach(item => {\n  if (item.type === 'table') {\n    if (item.name === 'provinces') {\n      provinces = item.data;\n    } else if (item.name === 'wards') {\n      wards = item.data;\n    } else if (item.name === 'ward_mappings') {\n      wardMappings = item.data;\n    }\n  }\n});\n\n// Now you can implement your own functions\nfunction getProvinces() {\n  return provinces;\n}\n\nfunction getProvinceByCode(code) {\n  return provinces.find(p => p.province_code === code);\n}\n\nfunction getWardMappings() {\n  return wardMappings;\n}\n```\n\n## Data Structure\n\nThe exported data is an array with the following structure:\n\n### Header\n```javascript\n{\n  \"type\": \"header\",\n  \"version\": \"1.1\",\n  \"comment\": \"JSON database for JavaScript/ TypeScript library...\"\n}\n```\n\n### Database Info\n```javascript\n{\n  \"type\": \"database\",\n  \"name\": \"address\"\n}\n```\n\n### Provinces Table\n```javascript\n{\n  \"type\": \"table\",\n  \"name\": \"provinces\",\n  \"database\": \"address\",\n  \"data\": [\n    {\n      \"id\": \"1\",\n      \"province_code\": \"01\",\n      \"name\": \"Thành phố Hà Nội\",\n      \"short_name\": \"Thành phố Hà Nội\",\n      \"code\": \"HNI\",\n      \"place_type\": \"Thành phố Trung Ương\",\n      \"country\": \"VN\",\n      \"created_at\": null,\n      \"updated_at\": null\n    }\n    // ... more provinces\n  ]\n}\n```\n\n### Wards Table\n```javascript\n{\n  \"type\": \"table\",\n  \"name\": \"wards\", \n  \"database\": \"address\",\n  \"data\": [\n    {\n      \"id\": \"1\",\n      \"ward_code\": \"00004\",\n      \"name\": \"Phường Ba Đình\",\n      \"province_code\": \"01\",\n      \"created_at\": null,\n      \"updated_at\": null\n    }\n    // ... more wards\n  ]\n}\n```\n\n### Ward Mappings Table\n```javascript\n{\n  \"type\": \"table\",\n  \"name\": \"ward_mappings\",\n  \"database\": \"address\", \n  \"data\": [\n    {\n      \"id\": \"1\",\n      \"old_ward_code\": \"26881\",\n      \"old_ward_name\": \"Phường 12\",\n      \"old_district_name\": \"Quận Gò Vấp\",\n      \"old_province_name\": \"Thành phố Hồ Chí Minh\",\n      \"new_ward_code\": \"26882\",\n      \"new_ward_name\": \"Phường An Hội Tây\",\n      \"new_province_name\": \"Thành phố Hồ Chí Minh\",\n      \"created_at\": \"2025-07-02 14:28:29\",\n      \"updated_at\": \"2025-07-02 14:28:29\"\n    }\n    // ... more mappings\n  ]\n}\n```\n\n## TypeScript Support\n\nThis package includes TypeScript type definitions:\n\n```typescript\nimport addressData, { Province, Ward, WardMapping, DatabaseItem } from 'vietnam-address-database';\n\nconst data: DatabaseItem[] = addressData;\n```\n\n## Testing\n\n```bash\nnpm test\n```\n\n## Data Source\n\nThis database is based on Resolution 202/2025/QH15 and contains the most up-to-date Vietnamese administrative addresses.\n\n- **34 provinces** (tỉnh/thành phố)\n- **3,321 wards** (phường/xã)\n- **10,977 ward mappings** (ánh xạ mã cũ sang mới)\n\n## License\n\nMIT\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n","readmeFilename":"README.md","_rev":"1-a6ec104e654f348cef2bde8f779fb096"}