@naverpay/device-info 1.0.22 → 1.0.24

package/CHANGELOG.md

@@ -0,0 +1,174 @@
+# @naverpay/device-info
+
+## 1.0.24
+
+### Patch Changes
+
+- 5715051: Fixed typo in package.json
+
+  PR: [Fixed typo in package.json](https://github.com/NaverPayDev/device-info/pull/89)
+
+## 1.0.23
+
+### Patch Changes
+
+- 3d14975: Weekly Device Info Update
+- 3b01b39: 📝 update README
+
+## 1.0.22
+
+### Patch Changes
+
+- fcc007b: Weekly Device Info Update
+
+## 1.0.21
+
+### Patch Changes
+
+- 7508c40: Weekly Device Info Update
+- 658f4eb: Weekly Device Info Update
+
+## 1.0.20
+
+### Patch Changes
+
+- 154ec79: Weekly Device Info Update
+
+## 1.0.19
+
+### Patch Changes
+
+- a7ac24f: Weekly Device Info Update
+- 6b33fbd: Weekly Device Info Update
+
+## 1.0.18
+
+### Patch Changes
+
+- d129699: Weekly Device Info Update
+- e7c528b: Weekly Device Info Update
+
+## 1.0.17
+
+### Patch Changes
+
+- 72fde71: Weekly Device Info Update
+- 8bb1998: Weekly Device Info Update
+- 120ff43: Weekly Device Info Update
+
+## 1.0.16
+
+### Patch Changes
+
+- 9a12c14: Weekly Device Info Update
+- 631bbf2: Weekly Device Info Update
+
+## 1.0.15
+
+### Patch Changes
+
+- 11e647b: Weekly Device Info Update
+- a3aef5b: Weekly Device Info Update
+- 1755616: Weekly Device Info Update
+
+## 1.0.14
+
+### Patch Changes
+
+- 70030bb: Weekly Device Info Update
+
+## 1.0.13
+
+### Patch Changes
+
+- d45199e: Weekly Device Info Update
+- 001e9a1: Weekly Device Info Update
+- 524c8b0: - 키값을 확인할 수 있는 타입 단언 유틸을 추가합니다.
+  - `minify`를 끕니다.
+
+## 1.0.12
+
+### Patch Changes
+
+- feb9045: Weekly Update
+- 7edd726: Weekly Update
+- d325ed8: Weekly Update
+- e87e4fc: Weekly Update
+
+## 1.0.11
+
+### Patch Changes
+
+- 57709f8: ♻️ typescript로 재작성
+
+## 1.0.10
+
+### Patch Changes
+
+- 54bc80c: [#20] 버그 수정
+
+## 1.0.9
+
+### Patch Changes
+
+- 19b1830: 🐛 누락된 타입정보를 추가합니다.
+
+## 1.0.8
+
+### Patch Changes
+
+- b5252e3: [#20] :sparkles: date 변수 추가로 내보내기
+
+## 1.0.7
+
+### Patch Changes
+
+- 59b6927: :bug: 잘못된 의존성을 수정합니다.
+
+## 1.0.6
+
+### Patch Changes
+
+- b34606b: Weekly Update
+
+## 1.0.5
+
+### Patch Changes
+
+- 0e301f6: Weekly Update
+
+## 1.0.4
+
+### Patch Changes
+
+- 7ef0250: Weekly Update
+
+## 1.0.3
+
+### Patch Changes
+
+- 140824e: Weekly Update
+
+## 1.0.2
+
+### Patch Changes
+
+- 8b76f93: 4/15 Weekly Update
+
+## 1.0.1
+
+### Patch Changes
+
+- dcef07e: 2024-04-04 기기정보 업데이트
+
+## 1.0.0
+
+### Major Changes
+
+- 97fa2fd: README.md 작성
+
+## 0.0.2
+
+### Patch Changes
+
+- 01962ef: Weekly Update

package/README.ko.md

@@ -0,0 +1,83 @@
+# @naverpay/device-info
+
+> 기기 ID를 사용자 친화적인 모델명으로 변환하는 라이브러리
+
+## 설치
+
+```bash
+npm install @naverpay/device-info
+# or
+yarn add @naverpay/device-info
+# or
+pnpm add @naverpay/device-info
+```
+
+## 빠른 시작
+
+```javascript
+import { ios, aos } from "@naverpay/device-info";
+
+console.log(ios["iPhone15,4"]); // 'iPhone 15'
+console.log(aos["SM-S901B"]); // 'Galaxy S22'
+```
+
+## API
+
+### `ios`
+
+iOS 기기 식별자와 모델명 매핑을 담은 객체입니다.
+
+- **타입**: `Record<string, string>`
+- **예시**: `iPhone14,2` → `iPhone 13 Pro`
+
+### `aos`
+
+Android 기기 모델과 마케팅명 매핑을 담은 객체입니다.
+
+- **타입**: `Record<string, string>`
+- **예시**: `SM-G991B` → `Galaxy S21 5G`
+
+## 예제
+
+### 기본 사용법
+
+```javascript
+import { ios, aos } from "@naverpay/device-info";
+
+// iOS
+const iosModel = ios["iPhone14,2"] || "알 수 없는 iPhone";
+
+// Android
+const androidModel = aos["SM-G991B"] || "알 수 없는 Android";
+```
+
+### 대체값 사용
+
+```javascript
+function getDeviceName(deviceId, platform) {
+  if (platform === "ios") {
+    return ios[deviceId] || `알 수 없는 iOS (${deviceId})`;
+  } else if (platform === "android") {
+    return aos[deviceId] || `알 수 없는 Android (${deviceId})`;
+  }
+  return "알 수 없는 기기";
+}
+```
+
+## 자주 묻는 질문
+
+**Q: 데이터는 얼마나 자주 업데이트되나요?**  
+A: 공식 소스에서 매주(월요일마다) 기기 데이터를 업데이트합니다.
+
+**Q: 기기 ID를 찾을 수 없으면 어떻게 되나요?**  
+A: 라이브러리는 `undefined`를 반환합니다. 항상 대체값을 제공하세요.
+
+**Q: 데이터는 어디서 가져오나요?**  
+A:
+
+- iOS: [The Apple Wiki](https://theapplewiki.com/wiki/Models)
+- Android: [Google Play 지원 기기](https://storage.googleapis.com/play_public/supported_devices.html)
+
+## 라이선스
+
+MIT

package/README.md

@@ -1,26 +1,83 @@
 # @naverpay/device-info
 
-A library for converting device IDs to user-friendly model names.
+> A library for converting device IDs to user-friendly model names
 
-- For iOS, it maps `Identifier` to `Generation`.
-- For Android, it maps `Model` to Marketing `Name`.
+## Installation
 
-These data are collected based on the following documents and updated every Monday:
+```bash
+npm install @naverpay/device-info
+# or
+yarn add @naverpay/device-info
+# or
+pnpm add @naverpay/device-info
+```
 
-- <https://storage.googleapis.com/play_public/supported_devices.html>
-- <https://theapplewiki.com/wiki/Models>
+## Quick Start
 
-## Installation
+```javascript
+import { ios, aos } from "@naverpay/device-info";
 
-```bash
-npm install --save @naverpay/device-info
+console.log(ios["iPhone15,4"]); // 'iPhone 15'
+console.log(aos["SM-S901B"]); // 'Galaxy S22'
 ```
 
-## Usage
+## API
+
+### `ios`
+
+Object containing iOS device identifier to model name mappings.
+
+- **Type**: `Record<string, string>`
+- **Example**: `iPhone14,2` → `iPhone 13 Pro`
+
+### `aos`
+
+Object containing Android device model to marketing name mappings.
+
+- **Type**: `Record<string, string>`
+- **Example**: `SM-G991B` → `Galaxy S21 5G`
+
+## Examples
+
+### Basic Usage
 
 ```javascript
 import { ios, aos } from "@naverpay/device-info";
 
-console.log(ios["iPhone15,4"]); // "iPhone 15"
-console.log(aos["SM-S901B"]); // "Galaxy S22"
+// iOS
+const iosModel = ios["iPhone14,2"] || "Unknown iPhone";
+
+// Android
+const androidModel = aos["SM-G991B"] || "Unknown Android";
 ```
+
+### With Fallback
+
+```javascript
+function getDeviceName(deviceId, platform) {
+  if (platform === "ios") {
+    return ios[deviceId] || `Unknown iOS (${deviceId})`;
+  } else if (platform === "android") {
+    return aos[deviceId] || `Unknown Android (${deviceId})`;
+  }
+  return "Unknown Device";
+}
+```
+
+## FAQ
+
+**Q: How often is the data updated?**  
+A: Device data is updated weekly (every Monday) from official sources.
+
+**Q: What if a device ID is not found?**  
+A: The library returns `undefined`. Always provide a fallback value.
+
+**Q: Where does the data come from?**  
+A:
+
+- iOS: [The Apple Wiki](https://theapplewiki.com/wiki/Models)
+- Android: [Google Play Supported Devices](https://storage.googleapis.com/play_public/supported_devices.html)
+
+## License
+
+MIT