feat: add default agent

README.md

@@ -80,11 +80,32 @@ Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)
     * **< Windows 7**
     * **< iOS Unknown**
 
+
 ```js
 import getAgent from "@egjs/agent";
 
 const agent = getAgent();
 
+// Check iOS
+agent.os.name === "ios"
+agent.os.majorVersion === 9
+// Check Android
+agent.os.name === "android"
+agent.os.majorVersion === 4
+parseFloat(agent.os.version) <= 4.4
+// Check browser name
+agent.browser.name === "safari"
+// Check webkit
+agent.browser.webkit
+// Check chromium
+agent.browser.chromium
+```
+
+### If you want to use only the method using navigator.userAgent
+```js
+import { getLegacyAgent } from "@egjs/agent";
+
+const agent = getLegacyAgent();
 // Check iOS
 agent.os.name === "ios"
 agent.os.majorVersion === 9
@@ -100,7 +121,7 @@ agent.browser.webkit
 agent.browser.chromium
 ```
 ### Not Possible (If synchronous)
-* Check OS (Mac with browsers except Safari, Windows, Linux), OS version
+* Check OS version.
 * Check Browser full version.
 
 ```js

src/agent.ts

@@ -1,7 +1,8 @@
 import { AgentInfo } from "./types";
 import { hasUserAgentData } from "./utils";
-import { parseUserAgentData } from "./userAgentData";
-import { parseUserAgent } from "./userAgent";
+import { getClientHintsAgent } from "./userAgentData";
+import { getLegacyAgent } from "./userAgent";
+
 /**
  * @namespace eg.agent
  */
@@ -31,7 +32,7 @@ export function getAccurateAgent(callback?: (result: AgentInfo) => void): Promis
             "platformVersion",
             "uaFullVersion",
         ]).then(info => {
-            const agentInfo = parseUserAgentData(info);
+            const agentInfo = getClientHintsAgent(info);
 
             callback && callback(agentInfo);
             return agentInfo;
@@ -45,6 +46,7 @@ export function getAccurateAgent(callback?: (result: AgentInfo) => void): Promis
 }
 
 
+
 /**
  * Extracts browser and operating system information from the user agent string.
  * @ko 유저 에이전트 문자열에서 브라우저와 운영체제 정보를 추출한다.
@@ -58,10 +60,11 @@ const { os, browser, isMobile } = agent();
  */
 function agent(userAgent?: string): AgentInfo {
     if (typeof userAgent === "undefined" && hasUserAgentData()) {
-        return parseUserAgentData();
+        return getClientHintsAgent();
     } else {
-        return parseUserAgent(userAgent);
+        return getLegacyAgent(userAgent);
     }
 }
+export { getLegacyAgent };
 
 export default agent;

src/userAgent.ts

@@ -1,9 +1,9 @@
 import { AgentInfo } from "./types";
-import { getUserAgent, findPreset } from "./utils";
+import { getUserAgentString, findPreset } from "./utils";
 import { WEBVIEW_PRESETS, CHROMIUM_PRESETS, BROWSER_PRESETS, OS_PRESETS, WEBKIT_PRESETS } from "./presets";
 
-export function parseUserAgent(userAgent?: string): AgentInfo {
-    const nextAgent = getUserAgent(userAgent);
+export function getLegacyAgent(userAgent?: string): AgentInfo {
+    const nextAgent = getUserAgentString(userAgent);
     const isMobile = !!/mobi/g.exec(nextAgent);
     const browser = {
         name: "unknown",

src/userAgentData.ts

@@ -2,7 +2,7 @@ import { UADataValues, AgentInfo, AgentBrowserInfo, AgentOSInfo } from "./types"
 import { some, find, findBrand, convertVersion, findPresetBrand } from "./utils";
 import { BROWSER_PRESETS, OS_PRESETS, CHROMIUM_PRESETS, WEBKIT_PRESETS, WEBVIEW_PRESETS } from "./presets";
 
-export function parseUserAgentData(osData?: UADataValues): AgentInfo {
+export function getClientHintsAgent(osData?: UADataValues): AgentInfo {
     const userAgentData = navigator.userAgentData;
     const brands = [...(userAgentData.uaList || userAgentData.brands)!];
     const isMobile = userAgentData.mobile || false;

src/utils.ts

@@ -21,7 +21,7 @@ export function find<T>(arr: T[], callback: (value: T, index: number) => any): T
     }
     return null;
 }
-export function getUserAgent(agent?: string): string {
+export function getUserAgentString(agent?: string): string {
     let userAgent = agent;
     if (typeof userAgent === "undefined") {
         if (typeof navigator === "undefined" || !navigator) {

test/unit/userAgent.spec.ts

@@ -1,10 +1,10 @@
 import AGENT_LIST from "./userAgentConsts";
-import getAgent, { getAccurateAgent } from "../../src/agent";
+import getAgent, { getAccurateAgent, getLegacyAgent } from "../../src/agent";
 
 describe("test userAgent", () => {
     describe("test getAgent function with custom userAgent", () => {
         AGENT_LIST.forEach(uaInfo => {
-            it(`test ${uaInfo.name} - ${uaInfo.ua}`, () => {
+            it(`test getAgent ${uaInfo.name} - ${uaInfo.ua}`, () => {
                 // Given, When
                 const agent = getAgent(uaInfo.ua);
 
@@ -27,6 +27,31 @@ describe("test userAgent", () => {
                 expect(agent.os.majorVersion).toBe(parseInt(uaInfo.os.version, 10));
                 expect(agent.browser.majorVersion).toBe(parseInt(uaInfo.browser.version, 10));
 
+                expect(agent.isMobile).toBe(uaInfo.isMobile);
+            });
+            it(`test getLegacyAgent ${uaInfo.name} - ${uaInfo.ua}`, () => {
+                // Given, When
+                const agent = getLegacyAgent(uaInfo.ua);
+
+                // Then
+                // name
+                expect(agent.os.name).toBe(uaInfo.os.name);
+                expect(agent.browser.name).toBe(uaInfo.browser.name);
+
+                // engine
+                expect(agent.browser.webview).toBe(uaInfo.browser.webview);
+                expect(agent.browser.webkit).toBe(uaInfo.browser.webkit);
+                expect(agent.browser.webkitVersion).toBe(uaInfo.browser.webkitVersion);
+                expect(agent.browser.chromium).toBe(uaInfo.browser.chromium);
+                expect(agent.browser.chromiumVersion).toBe(uaInfo.browser.chromiumVersion);
+
+                // version
+                expect(agent.browser.version).toBe(uaInfo.browser.version);
+                expect(agent.os.version).toBe(uaInfo.os.version);
+
+                expect(agent.os.majorVersion).toBe(parseInt(uaInfo.os.version, 10));
+                expect(agent.browser.majorVersion).toBe(parseInt(uaInfo.browser.version, 10));
+
                 expect(agent.isMobile).toBe(uaInfo.isMobile);
             });
         });