@tinkoff/user-agent 0.4.76 → 0.4.78

package/README.md

@@ -1,3 +1,5 @@
 # User agent
 
-Library for parsing and executing check to userAgent string. Based on [ua-parser-js](https://github.com/faisalman/ua-parser-js)
+Library for parsing and executing checks by:
+- userAgent string. Based on [ua-parser-js](https://github.com/faisalman/ua-parser-js)
+- [Client Hints](https://developer.mozilla.org/en-US/docs/Web/HTTP/Client_hints) headers

package/lib/client-hints.d.ts

@@ -0,0 +1,17 @@
+import type { UserAgent } from './types';
+/**
+ *
+ * @description
+ *
+ * Some of the data are available only when additional headers for client-hints were sent from server:
+ * - full browser version (only major version is available by default)
+ * - OS version
+ * - CPU architecture
+ * - device model
+ *
+ * To able to use data you should first provide header `Accept-CH` with the list of headers that client should send.
+ *
+ * @param headers
+ * @returns
+ */
+export declare const parseClientHintsHeaders: (headers: Record<string, string | string[]>) => UserAgent;

package/lib/index.d.ts

@@ -1,3 +1,5 @@
-export { parse } from './userAgent';
+export { parseUserAgentHeader } from './userAgent';
+export { parseUserAgentHeader as parse } from './userAgent';
 export { satisfies } from './satisfies';
+export { parseClientHintsHeaders as parseClientHints } from './client-hints';
 export * from './types';

package/lib/index.es.js

@@ -51,6 +51,31 @@ const isSameSiteNoneCompatible = (userAgent) => {
     }
 };
 
+const getMobileOs = (osName) => {
+    switch (osName) {
+        case 'Windows Phone':
+            return 'winphone';
+        case 'Android':
+            return 'android';
+        case 'iOS':
+            return 'ios';
+        case 'BlackBerry':
+        case 'RIM Tablet OS':
+            return 'blackberry';
+    }
+};
+const getBrowserEngine = (browserName, engineName) => {
+    switch (true) {
+        case browserName === 'firefox':
+            return 'firefox';
+        case browserName === 'safari':
+            return 'safari';
+        case engineName === 'webkit' || engineName === 'blink' || engineName === 'chromium':
+            return 'chrome';
+    }
+    return 'other';
+};
+
 const toLowerName = compose(toLower, propOr('name', ''));
 const uaParserExtensions = [
     // добавляем отдельные регекспы для ботов гугла и т.п.
@@ -68,46 +93,18 @@ const uaParserExtensions = [
     [/fxios\/([\w\\.-]+)/i],
     [[UAParser.BROWSER.NAME, 'Firefox Focus'], UAParser.BROWSER.VERSION],
 ];
-const parse = (userAgent) => {
+const parseUserAgentHeader = (userAgent) => {
     const uaParser = new UAParser('', { browser: uaParserExtensions });
     const { ua, ...result } = uaParser.setUA(userAgent).getResult();
     const { browser, os, engine } = result;
     const browserName = toLowerName(browser);
     const engineName = toLowerName(engine);
     const sameSiteNoneCompatible = isSameSiteNoneCompatible(result);
-    let mobileOS;
+    const mobileOS = getMobileOs(os.name);
     if (browserName === 'opera mobi') {
         result.device.type = 'mobile';
     }
-    switch (os.name) {
-        case 'Windows Phone':
-            mobileOS = 'winphone';
-            break;
-        case 'Android':
-            mobileOS = 'android';
-            break;
-        case 'iOS':
-            mobileOS = 'ios';
-            break;
-        case 'BlackBerry':
-        case 'RIM Tablet OS':
-            mobileOS = 'blackberry';
-            break;
-    }
-    let browserEngine;
-    switch (true) {
-        case browserName === 'firefox':
-            browserEngine = 'firefox';
-            break;
-        case browserName === 'safari':
-            browserEngine = 'safari';
-            break;
-        case engineName === 'webkit' || engineName === 'blink':
-            browserEngine = 'chrome';
-            break;
-        default:
-            browserEngine = 'other';
-    }
+    const browserEngine = getBrowserEngine(browserName, engineName);
     return {
         ...result,
         mobileOS,
@@ -216,14 +213,15 @@ const normalizedBrowserslist = (query) => {
 };
 const satisfies = (userAgent, browserslistConfig, { env = 'defaults' } = {}) => {
     var _a, _b;
-    const ua = isString(userAgent) ? parse(userAgent) : userAgent;
+    const ua = isString(userAgent) ? parseUserAgentHeader(userAgent) : userAgent;
     const { engine: { name: engineName = '', version: engineVersion }, device: { type = '' } = {}, } = ua;
     let { browser: { name: browserName = '', version: browserVersion = '' } = {} } = ua;
     // Chromium based браузеры (yandex, samsung, opera, vivaldi, edge) указывают версию движка как `Chrome/*`.
     // А версия движка (blink) матчится в версию chromium один к одному
     // https://github.com/faisalman/ua-parser-js/pull/390
     // https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent#Rendering_engine
-    if (engineName.toLowerCase() === 'blink' && CHROMIUM_BASED_BROWSERS.indexOf(browserName) !== -1) {
+    if (engineName === 'chromium' ||
+        (engineName.toLowerCase() === 'blink' && CHROMIUM_BASED_BROWSERS.indexOf(browserName) !== -1)) {
         browserName = 'chrome';
         browserVersion = engineVersion || '';
     }
@@ -247,4 +245,89 @@ const satisfies = (userAgent, browserslistConfig, { env = 'defaults' } = {}) =>
     return hasEntry ? false : null; // null означает что не нашли соответствия браузеру в списке browserslist
 };
 
-export { parse, satisfies };
+const KNOWN_VENDORS = new Set(['Opera', 'Google Chrome', 'Microsoft Edge', 'Firefox', 'Safari']);
+const KNOWN_ENGINES = new Set(['Chromium']);
+const parseQuotedString = (str) => {
+    var _a;
+    if (!str) {
+        return str;
+    }
+    try {
+        return (_a = JSON.parse(str)) === null || _a === void 0 ? void 0 : _a.trim();
+    }
+    catch (err) {
+        return str;
+    }
+};
+const parseBrowser = (brandsList) => {
+    const browser = {
+        name: undefined,
+        version: undefined,
+        major: undefined,
+        browserEngine: '',
+    };
+    const engine = {
+        name: undefined,
+        version: undefined,
+    };
+    brandsList.split(',').forEach((entry) => {
+        const [name, version] = entry.split(/;\s*v=/).map(parseQuotedString);
+        if (name && KNOWN_VENDORS.has(name)) {
+            browser.name = name.toLowerCase();
+            browser.version = version;
+            browser.major = version;
+        }
+        if (name && KNOWN_ENGINES.has(name)) {
+            engine.name = name.toLowerCase();
+            engine.version = version;
+        }
+    });
+    if (!browser.name && engine.name) {
+        browser.name = engine.name;
+        browser.version = engine.version;
+    }
+    browser.browserEngine = getBrowserEngine(browser.name, engine.name);
+    return { browser, engine };
+};
+/**
+ *
+ * @description
+ *
+ * Some of the data are available only when additional headers for client-hints were sent from server:
+ * - full browser version (only major version is available by default)
+ * - OS version
+ * - CPU architecture
+ * - device model
+ *
+ * To able to use data you should first provide header `Accept-CH` with the list of headers that client should send.
+ *
+ * @param headers
+ * @returns
+ */
+const parseClientHintsHeaders = (headers) => {
+    const { browser, engine } = parseBrowser(headers['sec-ch-ua-full-version-list'] || headers['sec-ch-ua']);
+    const osName = parseQuotedString(headers['sec-ch-ua-platform']);
+    const mobileOS = getMobileOs(osName);
+    return {
+        browser,
+        engine,
+        os: {
+            name: osName,
+            version: parseQuotedString(headers['sec-ch-ua-platform-version']),
+        },
+        cpu: {
+            architecture: parseQuotedString(headers['sec-ch-ua-arch']),
+        },
+        mobileOS,
+        device: {
+            model: parseQuotedString(headers['sec-ch-ua-model']),
+            type: headers['sec-ch-ua-mobile'] === '?1' ? 'mobile' : 'desktop',
+            vendor: undefined,
+        },
+        // basically all of the browsers with client-hints support
+        // also compatible with SameSite=None
+        sameSiteNoneCompatible: true,
+    };
+};
+
+export { parseUserAgentHeader as parse, parseClientHintsHeaders as parseClientHints, parseUserAgentHeader, satisfies };

package/lib/index.js

@@ -65,6 +65,31 @@ const isSameSiteNoneCompatible = (userAgent) => {
     }
 };
 
+const getMobileOs = (osName) => {
+    switch (osName) {
+        case 'Windows Phone':
+            return 'winphone';
+        case 'Android':
+            return 'android';
+        case 'iOS':
+            return 'ios';
+        case 'BlackBerry':
+        case 'RIM Tablet OS':
+            return 'blackberry';
+    }
+};
+const getBrowserEngine = (browserName, engineName) => {
+    switch (true) {
+        case browserName === 'firefox':
+            return 'firefox';
+        case browserName === 'safari':
+            return 'safari';
+        case engineName === 'webkit' || engineName === 'blink' || engineName === 'chromium':
+            return 'chrome';
+    }
+    return 'other';
+};
+
 const toLowerName = compose__default["default"](toLower__default["default"], propOr__default["default"]('name', ''));
 const uaParserExtensions = [
     // добавляем отдельные регекспы для ботов гугла и т.п.
@@ -82,46 +107,18 @@ const uaParserExtensions = [
     [/fxios\/([\w\\.-]+)/i],
     [[uaParserJs.UAParser.BROWSER.NAME, 'Firefox Focus'], uaParserJs.UAParser.BROWSER.VERSION],
 ];
-const parse = (userAgent) => {
+const parseUserAgentHeader = (userAgent) => {
     const uaParser = new uaParserJs.UAParser('', { browser: uaParserExtensions });
     const { ua, ...result } = uaParser.setUA(userAgent).getResult();
     const { browser, os, engine } = result;
     const browserName = toLowerName(browser);
     const engineName = toLowerName(engine);
     const sameSiteNoneCompatible = isSameSiteNoneCompatible(result);
-    let mobileOS;
+    const mobileOS = getMobileOs(os.name);
     if (browserName === 'opera mobi') {
         result.device.type = 'mobile';
     }
-    switch (os.name) {
-        case 'Windows Phone':
-            mobileOS = 'winphone';
-            break;
-        case 'Android':
-            mobileOS = 'android';
-            break;
-        case 'iOS':
-            mobileOS = 'ios';
-            break;
-        case 'BlackBerry':
-        case 'RIM Tablet OS':
-            mobileOS = 'blackberry';
-            break;
-    }
-    let browserEngine;
-    switch (true) {
-        case browserName === 'firefox':
-            browserEngine = 'firefox';
-            break;
-        case browserName === 'safari':
-            browserEngine = 'safari';
-            break;
-        case engineName === 'webkit' || engineName === 'blink':
-            browserEngine = 'chrome';
-            break;
-        default:
-            browserEngine = 'other';
-    }
+    const browserEngine = getBrowserEngine(browserName, engineName);
     return {
         ...result,
         mobileOS,
@@ -230,14 +227,15 @@ const normalizedBrowserslist = (query) => {
 };
 const satisfies = (userAgent, browserslistConfig, { env = 'defaults' } = {}) => {
     var _a, _b;
-    const ua = isString__default["default"](userAgent) ? parse(userAgent) : userAgent;
+    const ua = isString__default["default"](userAgent) ? parseUserAgentHeader(userAgent) : userAgent;
     const { engine: { name: engineName = '', version: engineVersion }, device: { type = '' } = {}, } = ua;
     let { browser: { name: browserName = '', version: browserVersion = '' } = {} } = ua;
     // Chromium based браузеры (yandex, samsung, opera, vivaldi, edge) указывают версию движка как `Chrome/*`.
     // А версия движка (blink) матчится в версию chromium один к одному
     // https://github.com/faisalman/ua-parser-js/pull/390
     // https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent#Rendering_engine
-    if (engineName.toLowerCase() === 'blink' && CHROMIUM_BASED_BROWSERS.indexOf(browserName) !== -1) {
+    if (engineName === 'chromium' ||
+        (engineName.toLowerCase() === 'blink' && CHROMIUM_BASED_BROWSERS.indexOf(browserName) !== -1)) {
         browserName = 'chrome';
         browserVersion = engineVersion || '';
     }
@@ -261,5 +259,92 @@ const satisfies = (userAgent, browserslistConfig, { env = 'defaults' } = {}) =>
     return hasEntry ? false : null; // null означает что не нашли соответствия браузеру в списке browserslist
 };
 
-exports.parse = parse;
+const KNOWN_VENDORS = new Set(['Opera', 'Google Chrome', 'Microsoft Edge', 'Firefox', 'Safari']);
+const KNOWN_ENGINES = new Set(['Chromium']);
+const parseQuotedString = (str) => {
+    var _a;
+    if (!str) {
+        return str;
+    }
+    try {
+        return (_a = JSON.parse(str)) === null || _a === void 0 ? void 0 : _a.trim();
+    }
+    catch (err) {
+        return str;
+    }
+};
+const parseBrowser = (brandsList) => {
+    const browser = {
+        name: undefined,
+        version: undefined,
+        major: undefined,
+        browserEngine: '',
+    };
+    const engine = {
+        name: undefined,
+        version: undefined,
+    };
+    brandsList.split(',').forEach((entry) => {
+        const [name, version] = entry.split(/;\s*v=/).map(parseQuotedString);
+        if (name && KNOWN_VENDORS.has(name)) {
+            browser.name = name.toLowerCase();
+            browser.version = version;
+            browser.major = version;
+        }
+        if (name && KNOWN_ENGINES.has(name)) {
+            engine.name = name.toLowerCase();
+            engine.version = version;
+        }
+    });
+    if (!browser.name && engine.name) {
+        browser.name = engine.name;
+        browser.version = engine.version;
+    }
+    browser.browserEngine = getBrowserEngine(browser.name, engine.name);
+    return { browser, engine };
+};
+/**
+ *
+ * @description
+ *
+ * Some of the data are available only when additional headers for client-hints were sent from server:
+ * - full browser version (only major version is available by default)
+ * - OS version
+ * - CPU architecture
+ * - device model
+ *
+ * To able to use data you should first provide header `Accept-CH` with the list of headers that client should send.
+ *
+ * @param headers
+ * @returns
+ */
+const parseClientHintsHeaders = (headers) => {
+    const { browser, engine } = parseBrowser(headers['sec-ch-ua-full-version-list'] || headers['sec-ch-ua']);
+    const osName = parseQuotedString(headers['sec-ch-ua-platform']);
+    const mobileOS = getMobileOs(osName);
+    return {
+        browser,
+        engine,
+        os: {
+            name: osName,
+            version: parseQuotedString(headers['sec-ch-ua-platform-version']),
+        },
+        cpu: {
+            architecture: parseQuotedString(headers['sec-ch-ua-arch']),
+        },
+        mobileOS,
+        device: {
+            model: parseQuotedString(headers['sec-ch-ua-model']),
+            type: headers['sec-ch-ua-mobile'] === '?1' ? 'mobile' : 'desktop',
+            vendor: undefined,
+        },
+        // basically all of the browsers with client-hints support
+        // also compatible with SameSite=None
+        sameSiteNoneCompatible: true,
+    };
+};
+
+exports.parse = parseUserAgentHeader;
+exports.parseClientHints = parseClientHintsHeaders;
+exports.parseUserAgentHeader = parseUserAgentHeader;
 exports.satisfies = satisfies;

package/lib/types.d.ts

@@ -1,10 +1,46 @@
-import type { UAParser } from 'ua-parser-js';
-declare type ParserResult = ReturnType<UAParser['getResult']>;
-export interface UserAgent extends Omit<ParserResult, 'ua'> {
-    browser: ParserResult['browser'] & {
-        browserEngine: string;
-    };
+export interface Browser {
+    name: string | undefined;
+    /**
+     * With client-hints there will be only major version
+     */
+    version: string | undefined;
+    /**
+     * @deprecated use version
+     */
+    major: string | undefined;
+    browserEngine: string;
+}
+export interface Engine {
+    name: string | undefined;
+    version: string | undefined;
+}
+export interface Device {
+    type: string | undefined;
+    model: string | undefined;
+    /**
+     * @deprecated This info is not provided by client-hints
+     */
+    vendor: string | undefined;
+}
+export interface OS {
+    name: string | undefined;
+    version: string | undefined;
+}
+export interface Cpu {
+    /**
+     * @deprecated This is not provided by default with client-hints
+     */
+    architecture: string | undefined;
+}
+export interface UserAgent {
+    browser: Browser;
+    engine: Engine;
+    device: Device;
+    os: OS;
+    /**
+     * @deprecated This is not provided by default with client-hints
+     */
+    cpu: Cpu;
     mobileOS?: string;
     sameSiteNoneCompatible: boolean;
 }
-export type { UAParser };

package/lib/types.test-types.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/userAgent.d.ts

@@ -1,2 +1,2 @@
 import type { UserAgent } from './types';
-export declare const parse: (userAgent: string) => UserAgent;
+export declare const parseUserAgentHeader: (userAgent: string) => UserAgent;

package/lib/utils.d.ts

@@ -0,0 +1,2 @@
+export declare const getMobileOs: (osName?: string) => string | undefined;
+export declare const getBrowserEngine: (browserName?: string, engineName?: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tinkoff/user-agent",
-  "version": "0.4.76",
+  "version": "0.4.78",
   "description": "",
   "main": "lib/index.js",
   "module": "lib/index.es.js",
@@ -29,7 +29,7 @@
     "@types/ua-parser-js": "^0.7.33"
   },
   "peerDependencies": {
-    "@tramvai/cli": "2.33.3",
+    "@tramvai/cli": "2.35.0",
     "@types/ua-parser-js": "^0.7.33"
   },
   "license": "Apache-2.0"