@amazon/vinyl-util 1.0.0

package/dist/types/current/client/userAgent/defaultUserAgentRules.js

@@ -0,0 +1,251 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { regexRule, uaDeviceRule as device, uaPlatformOrSystemRule as platformOrSystem, uaPlatformRule as platform, uaSystemLike, uaSystemRule as system, } from './userAgentRuleHelpers';
+/**
+ * An enumeration of operating systems that can be detected from the user agent.
+ */
+export var Os;
+(function (Os) {
+    Os["ANDROID"] = "Android";
+    Os["ANDROID_OSP"] = "Android OSP";
+    Os["CHROME_OS"] = "chromeOS";
+    Os["CHROMECAST"] = "Chromecast";
+    Os["FEDORA"] = "Fedora";
+    Os["FIREFOX_OS"] = "Firefox OS";
+    Os["FIRE_OS"] = "Fire OS";
+    Os["FREE_BSD"] = "FreeBSD";
+    Os["HARMONY_OS"] = "HarmonyOS";
+    Os["I_OS"] = "iOS";
+    Os["KAIOS"] = "KaiOS";
+    Os["LINUX"] = "Linux";
+    Os["MAC_OS"] = "macOS";
+    Os["MIUI"] = "MIUI";
+    Os["ORBIS"] = "Orbis OS";
+    Os["SMART_CAST"] = "SmartCast";
+    Os["SYMBIAN"] = "Symbian";
+    Os["TIZEN"] = "Tizen";
+    Os["UBUNTU"] = "Ubuntu";
+    Os["VEGA"] = "Vega";
+    Os["WEB_OS"] = "webOS";
+    Os["WINDOWS"] = "Windows";
+    Os["WINDOWS_PHONE"] = "Windows Phone";
+})(Os || (Os = {}));
+/**
+ * An enumeration of browsers that can be detected from the user agent.
+ */
+export var Browser;
+(function (Browser) {
+    Browser["BRAVE"] = "Brave";
+    Browser["CHROME"] = "Chrome";
+    Browser["CHROME_HEADLESS"] = "Chrome Headless";
+    Browser["CHROMIUM"] = "Chromium";
+    Browser["DUCK_DUCK_GO"] = "DuckDuckGo";
+    Browser["EDGE_CHROMIUM"] = "Edge Chromium";
+    Browser["EDGE_LEGACY"] = "Edge Legacy";
+    Browser["ELECTRON"] = "Electron";
+    Browser["FIREFOX"] = "Firefox";
+    Browser["HUAWEI"] = "Huawei";
+    Browser["IE"] = "IE";
+    Browser["IE_MOBILE"] = "IE Mobile";
+    Browser["OCULUS"] = "Oculus Browser";
+    Browser["OPENWAVE"] = "Openwave";
+    Browser["OPERA"] = "Opera";
+    Browser["OPERA_TOUCH"] = "Opera Touch";
+    Browser["QUARK"] = "Quark";
+    Browser["SILK"] = "Silk";
+    Browser["SAFARI"] = "Safari";
+    Browser["SAMSUNG_BROWSER"] = "Samsung Browser";
+    Browser["UC_BROWSER"] = "UC Browser";
+    Browser["WPE"] = "WPE WebKit";
+    Browser["YANDEX"] = "Yandex";
+    Browser["WEBKIT"] = "WebKit";
+})(Browser || (Browser = {}));
+export var DeviceVendor;
+(function (DeviceVendor) {
+    DeviceVendor["AMAZON"] = "Amazon";
+    DeviceVendor["APPLE"] = "Apple";
+    DeviceVendor["FACEBOOK"] = "Facebook";
+    DeviceVendor["GOOGLE"] = "Google";
+    DeviceVendor["HISENSE"] = "Hisense";
+    DeviceVendor["HTC"] = "HTC";
+    DeviceVendor["HUAWEI"] = "Huawei";
+    DeviceVendor["K"] = "K";
+    DeviceVendor["LG"] = "LG";
+    DeviceVendor["MEIZU"] = "Meizu";
+    DeviceVendor["MICROSOFT"] = "Microsoft";
+    DeviceVendor["MOTOROLA"] = "Motorola";
+    DeviceVendor["NINTENDO"] = "Nintendo";
+    DeviceVendor["NOKIA"] = "Nokia";
+    DeviceVendor["NVIDIA"] = "Nvidia";
+    DeviceVendor["ONE_PLUS"] = "OnePlus";
+    DeviceVendor["OPPO"] = "OPPO";
+    DeviceVendor["ROKU"] = "Roku";
+    DeviceVendor["SAMSUNG"] = "Samsung";
+    DeviceVendor["SKY"] = "Sky";
+    DeviceVendor["SKY_DEVICES"] = "SKY Devices";
+    DeviceVendor["SONY"] = "Sony";
+    DeviceVendor["TESLA"] = "Tesla";
+    DeviceVendor["VIZIO"] = "VIZIO";
+})(DeviceVendor || (DeviceVendor = {}));
+export var DeviceType;
+(function (DeviceType) {
+    DeviceType["AUTOMOTIVE"] = "automotive";
+    DeviceType["CONSOLE"] = "console";
+    DeviceType["DESKTOP"] = "desktop";
+    DeviceType["SMART_TV"] = "smarttv";
+    DeviceType["MOBILE"] = "mobile";
+    DeviceType["WEARABLE"] = "wearable";
+})(DeviceType || (DeviceType = {}));
+export const defaultUserAgentRules = {
+    browserRules: [
+        // IE based:
+        platform(Browser.EDGE_LEGACY, 'edge'),
+        platformOrSystem(Browser.IE, 'msie|trident'),
+        platformOrSystem(Browser.IE_MOBILE, 'iemobile'),
+        // Firefox based:
+        platform(Browser.FIREFOX, 'firefox|fxios'),
+        // Chromium based:
+        platformOrSystem(Browser.BRAVE, 'brave'),
+        platform(Browser.DUCK_DUCK_GO, 'duckduckgo'),
+        platform(Browser.EDGE_CHROMIUM, 'edg|edgios|edga'),
+        platform(Browser.ELECTRON, 'electron'),
+        platform(Browser.OCULUS, 'oculusbrowser'),
+        platform(Browser.OPENWAVE, 'up.link|up.browser'),
+        platform(Browser.OPERA, 'opr|opera'),
+        platform(Browser.OPERA_TOUCH, 'opt'),
+        platform(Browser.QUARK, 'quark'),
+        platform(Browser.HUAWEI, 'huaweibrowser'),
+        platform(Browser.SAMSUNG_BROWSER, 'samsungbrowser'),
+        platform(Browser.SILK, 'silk'),
+        platform(Browser.UC_BROWSER, 'ucbrowser'),
+        platform(Browser.YANDEX, 'yasearchbrowser|yabrowser'),
+        platform(Browser.CHROME_HEADLESS, 'headlesschrome'),
+        platform(Browser.CHROMIUM, 'chromium'),
+        platform(Browser.CHROME, 'chrome|crios'),
+        // WebKit based:
+        platform(Browser.WPE, 'wpe'),
+        platform(Browser.SAFARI, 'safari&version'),
+        platformOrSystem(Browser.SAFARI, 'like safari&version'),
+    ],
+    browserLikeRules: [
+        uaSystemLike(Browser.WEBKIT, [Browser.SAFARI]),
+        (t) => 
+        // All iOS devices use WebKit
+        t.system.query('iphone|ipad|ipod') &&
+            t.platform.get('applewebkit') && {
+            name: Browser.WEBKIT,
+            version: null,
+        },
+        platformOrSystem(Browser.FIREFOX, 'firefox'),
+        (t) => {
+            const systemInfo = t.platform.query('chrome|headlesschrome|crios|chromium');
+            if (systemInfo == null || t.platform.query('edge'))
+                // Edge legacy
+                return null;
+            return {
+                name: Browser.CHROMIUM,
+                version: systemInfo.version,
+            };
+        },
+    ],
+    osRules: [
+        system(Os.WINDOWS_PHONE, 'windows phone', true),
+        system(Os.WINDOWS, 'windows', true),
+        system(Os.TIZEN, 'tizen', true),
+        system(Os.I_OS, 'cpu os|iphone os', true),
+        system(Os.MAC_OS, 'os x', true),
+        system(Os.CHROME_OS, 'cros', true),
+        platform(Os.SMART_CAST, 'smartcast'), // VIZIO SmartCast has built-in chromecast (CrKey)
+        platformOrSystem(Os.CHROMECAST, 'crkey'),
+        system(Os.WEB_OS, 'webos', true),
+        system(Os.SYMBIAN, 'symbian', false),
+        system(Os.HARMONY_OS, 'harmonyos', false),
+        platformOrSystem(Os.MIUI, 'linux&xiaomi'),
+        platformOrSystem(Os.FIRE_OS, 'fireos'),
+        system(Os.ANDROID, 'android', true),
+        system(Os.FREE_BSD, 'freebsd', false),
+        system(Os.FEDORA, 'fedora', false),
+        system(Os.ORBIS, 'orbis|playstation', false),
+        system(Os.UBUNTU, 'ubuntu', false),
+        system(Os.VEGA, 'kepler', false),
+        system(Os.LINUX, 'linux', false),
+        platform(Os.KAIOS, 'kaios'), // [sic] KAIOS is in platform section
+    ],
+    osLikeRules: [
+        system(Os.ANDROID_OSP, 'android', true),
+        uaSystemLike(Os.ANDROID_OSP, [
+            Os.ANDROID,
+            Os.HARMONY_OS,
+            Os.FIRE_OS,
+            Os.MIUI,
+        ]),
+        uaSystemLike(Os.FIREFOX_OS, [Os.KAIOS]),
+        uaSystemLike(Os.LINUX, [
+            Os.FREE_BSD,
+            Os.FEDORA,
+            Os.ORBIS,
+            Os.UBUNTU,
+            Os.LINUX,
+        ]),
+    ],
+    deviceRules: [
+        // Desktop
+        device(DeviceVendor.APPLE, DeviceType.DESKTOP, 'macintosh'),
+        // Mobile
+        device(DeviceVendor.APPLE, DeviceType.MOBILE, 'iphone|ipod|ipad'),
+        device(DeviceVendor.SAMSUNG, DeviceType.MOBILE, 'sm|samsung'),
+        device(DeviceVendor.GOOGLE, DeviceType.MOBILE, 'pixel|nexus'),
+        device(DeviceVendor.HUAWEI, DeviceType.MOBILE, 'ine'),
+        device(DeviceVendor.HTC, DeviceType.MOBILE, 'htc'),
+        device(DeviceVendor.MEIZU, DeviceType.MOBILE, 'meizu'),
+        device(DeviceVendor.ONE_PLUS, DeviceType.MOBILE, 'oneplus'),
+        device(DeviceVendor.MOTOROLA, DeviceType.MOBILE, 'mot|motorola|motorizr'),
+        device(DeviceVendor.NOKIA, DeviceType.MOBILE, 'nokia'),
+        device(DeviceVendor.OPPO, DeviceType.MOBILE, 'oppo'),
+        device(DeviceVendor.AMAZON, DeviceType.MOBILE, 'kindle'),
+        device(DeviceVendor.NVIDIA, DeviceType.MOBILE, 'shield tablet'),
+        device(DeviceVendor.K, DeviceType.MOBILE, 'android&k'),
+        device(DeviceVendor.LG, DeviceType.MOBILE, 'android&mobile&lg'),
+        device(DeviceVendor.SKY_DEVICES, DeviceType.MOBILE, 'android&sky'),
+        // Consoles
+        device(DeviceVendor.SONY, DeviceType.CONSOLE, 'playstation'),
+        device(DeviceVendor.MICROSOFT, DeviceType.CONSOLE, 'xbox one|xbox'),
+        device(DeviceVendor.NINTENDO, DeviceType.CONSOLE, 'switch|nintendo'),
+        // Wearables
+        device(DeviceVendor.APPLE, DeviceType.WEARABLE, 'airwatch'),
+        device(DeviceVendor.FACEBOOK, DeviceType.WEARABLE, 'quest'),
+        // Smart TVs:
+        device(DeviceVendor.AMAZON, DeviceType.SMART_TV, 'afts|aftwmst'),
+        device(DeviceVendor.APPLE, DeviceType.SMART_TV, 'appletv'),
+        device(DeviceVendor.GOOGLE, DeviceType.SMART_TV, 'nexus player'),
+        device(DeviceVendor.HISENSE, DeviceType.SMART_TV, 'hisense'),
+        device(DeviceVendor.LG, DeviceType.SMART_TV, 'lg'),
+        device(DeviceVendor.ROKU, DeviceType.SMART_TV, 'roku'),
+        device(DeviceVendor.AMAZON, DeviceType.SMART_TV, 'kepler'),
+        regexRule(/linux.*\(sky,\s*(\w+)/i, (match) => {
+            return {
+                vendor: DeviceVendor.SKY,
+                model: match[1],
+                type: DeviceType.SMART_TV,
+            };
+        }),
+        regexRule(/vizio smartcast.+model\/([\w-]+)/i, (match) => {
+            return {
+                vendor: DeviceVendor.VIZIO,
+                model: match[1],
+                type: DeviceType.SMART_TV,
+            };
+        }),
+        device(DeviceVendor.VIZIO, DeviceType.SMART_TV, 'vizio'),
+        device(DeviceVendor.GOOGLE, DeviceType.SMART_TV, 'crkey', 'Chromecast'),
+        // Automotive:
+        device(DeviceVendor.TESLA, DeviceType.AUTOMOTIVE, 'tesla'),
+        // Generic
+        // WPE is a WebKit browser designed for embedded systems:
+        device(null, DeviceType.SMART_TV, 'wpe', null),
+        device(null, DeviceType.MOBILE, 'mobile|android', null),
+        device(null, DeviceType.DESKTOP, 'windows|linux|cros', null),
+    ],
+};

package/dist/types/current/client/userAgent/hasBrowser.d.ts

@@ -0,0 +1,26 @@
+import type { Browser } from './defaultUserAgentRules';
+import type { UserAgentInfo } from './UserAgentInfo';
+import type { Maybe } from '../../util/type';
+export interface HasBrowserOptions {
+    /**
+     * If true (default), checks both {@link UserAgentInfo.browserLike} (first) and
+     * {@link UserAgentInfo.browser} for a name match.
+     */
+    readonly checkBrowserLike?: boolean;
+    /**
+     * The parsed user agent to query. Default is the browser's parsed user agent.
+     */
+    readonly userAgentInfo?: UserAgentInfo;
+}
+/**
+ * Returns true if the current user agent matches the given browser.
+ *
+ * @param browser
+ * @param minVersionStr If provided, only returns true if the browser version is at least this version.
+ * Must be parsable by {@link parseVersion}.
+ * @param maxVersionStr If provided, only returns true if the browser version is at most this version.
+ * Must be parsable by {@link parseVersion}.
+ * @param options Additional optional configuration.
+ */
+export declare function hasBrowser(browser: Browser, minVersionStr?: Maybe<string>, maxVersionStr?: Maybe<string>, options?: HasBrowserOptions): boolean;
+//# sourceMappingURL=hasBrowser.d.ts.map

package/dist/types/current/client/userAgent/hasBrowser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasBrowser.d.ts","sourceRoot":"","sources":["../../../../../src/client/userAgent/hasBrowser.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AAEtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAGpD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAExC,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,aAAa,CAAA;CACzC;AAED;;;;;;;;;GASG;AACH,wBAAgB,UAAU,CACtB,OAAO,EAAE,OAAO,EAChB,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAC7B,aAAa,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAC7B,OAAO,CAAC,EAAE,iBAAiB,GAC5B,OAAO,CAmCT"}

package/dist/types/current/client/userAgent/hasBrowser.js

@@ -0,0 +1,49 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { getUserAgentInfo } from './parseUserAgent';
+import { compareVersions, parseVersion } from '../../client/Version';
+/**
+ * Returns true if the current user agent matches the given browser.
+ *
+ * @param browser
+ * @param minVersionStr If provided, only returns true if the browser version is at least this version.
+ * Must be parsable by {@link parseVersion}.
+ * @param maxVersionStr If provided, only returns true if the browser version is at most this version.
+ * Must be parsable by {@link parseVersion}.
+ * @param options Additional optional configuration.
+ */
+export function hasBrowser(browser, minVersionStr, maxVersionStr, options) {
+    const userAgent = options?.userAgentInfo ?? getUserAgentInfo();
+    const systemInfo = (options?.checkBrowserLike ?? true) &&
+        userAgent.browserLike?.name === browser
+        ? userAgent.browserLike
+        : userAgent.browser?.name === browser
+            ? userAgent.browser
+            : null;
+    if (systemInfo == null)
+        return false;
+    let atMostMaxVersion = false;
+    if (!maxVersionStr)
+        atMostMaxVersion = true;
+    else {
+        // When a maxVersionStr has been provided, consider null sub-versions to always match.
+        // For example maxVersionStr 53 will match the version 53.1.234, but 53.0 would not.
+        const maxInt = Number.MAX_SAFE_INTEGER;
+        const maxVersion = parseVersion(maxVersionStr);
+        const finalMaxVersion = {
+            major: maxVersion.major,
+            minor: maxVersion.minor ?? maxInt,
+            patch: maxVersion.patch ?? maxInt,
+            build: maxVersion.build ?? maxInt,
+            str: '',
+        };
+        atMostMaxVersion =
+            compareVersions(systemInfo.version, finalMaxVersion) <= 0;
+    }
+    return ((minVersionStr == null ||
+        compareVersions(systemInfo.version, parseVersion(minVersionStr)) >=
+            0) &&
+        atMostMaxVersion);
+}

package/dist/types/current/client/userAgent/parseUserAgent.d.ts

@@ -0,0 +1,14 @@
+import type { Maybe } from '../../util/type';
+import type { UserAgentRules } from './tokenizeUserAgent';
+import type { UserAgentInfo } from './UserAgentInfo';
+/**
+ * Parses the user agent into a {@link UserAgentInfo} object.
+ *
+ * @param userAgent The User Agent. Default: `navigator.userAgent`.
+ * @param rules The user agent rules.
+ */
+export declare function parseUserAgent(userAgent?: Maybe<string>, rules?: UserAgentRules): UserAgentInfo;
+export declare const userAgentInfoRef: import("../../global/globalRegistry").GlobalRef<UserAgentInfo>;
+export declare function getUserAgentInfo(): UserAgentInfo;
+export declare function setUserAgent(value: string): void;
+//# sourceMappingURL=parseUserAgent.d.ts.map

package/dist/types/current/client/userAgent/parseUserAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseUserAgent.d.ts","sourceRoot":"","sources":["../../../../../src/client/userAgent/parseUserAgent.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAExC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEzD,OAAO,KAAK,EAA8B,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAIhF;;;;;GAKG;AACH,wBAAgB,cAAc,CAC1B,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACzB,KAAK,GAAE,cAAsC,GAC9C,aAAa,CA4Cf;AAED,eAAO,MAAM,gBAAgB,4DAAoC,CAAA;AAEjE,wBAAgB,gBAAgB,IAAI,aAAa,CAEhD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,QAGzC"}

package/dist/types/current/client/userAgent/parseUserAgent.js

@@ -0,0 +1,67 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { defaultUserAgentRules } from './defaultUserAgentRules';
+import { tokenizeUserAgent } from './tokenizeUserAgent';
+import { emptyUserAgentInfo } from './UserAgentInfo';
+import { globalRef } from '../../global/globalRegistry';
+/**
+ * Parses the user agent into a {@link UserAgentInfo} object.
+ *
+ * @param userAgent The User Agent. Default: `navigator.userAgent`.
+ * @param rules The user agent rules.
+ */
+export function parseUserAgent(userAgent, rules = defaultUserAgentRules) {
+    if (userAgent === undefined && typeof navigator === 'object')
+        userAgent = navigator.userAgent;
+    if (!userAgent)
+        return emptyUserAgentInfo;
+    const tokenizedUa = tokenizeUserAgent(userAgent);
+    let browserInfo = null;
+    for (const rule of rules.browserRules) {
+        browserInfo = rule(tokenizedUa);
+        if (browserInfo)
+            break;
+    }
+    let browserLikeInfo = null;
+    for (const rule of rules.browserLikeRules) {
+        browserLikeInfo = rule(tokenizedUa, browserInfo);
+        if (browserLikeInfo)
+            break;
+    }
+    let osInfo = null;
+    for (const rule of rules.osRules) {
+        osInfo = rule(tokenizedUa);
+        if (osInfo)
+            break;
+    }
+    let osLikeInfo = null;
+    for (const rule of rules.osLikeRules) {
+        osLikeInfo = rule(tokenizedUa, osInfo);
+        if (osLikeInfo)
+            break;
+    }
+    let deviceInfo = null;
+    for (const rule of rules.deviceRules) {
+        deviceInfo = rule(tokenizedUa);
+        if (deviceInfo)
+            break;
+    }
+    return {
+        userAgent,
+        browser: browserInfo,
+        browserLike: browserLikeInfo,
+        os: osInfo,
+        osLike: osLikeInfo,
+        device: deviceInfo,
+    };
+}
+export const userAgentInfoRef = globalRef(() => parseUserAgent());
+export function getUserAgentInfo() {
+    return userAgentInfoRef.value;
+}
+export function setUserAgent(value) {
+    userAgentInfoRef.reset();
+    userAgentInfoRef.set(() => parseUserAgent(value));
+}

package/dist/types/current/client/userAgent/tokenizeUserAgent.d.ts

@@ -0,0 +1,104 @@
+import type { Maybe } from '../../util/type';
+import type { Version } from '../../client/Version';
+import type { UaDeviceInfo, UaSystemInfo } from './UserAgentInfo';
+/**
+ * Builds a tokenized user agent for faster queries.
+ *
+ * @param userAgent
+ */
+export declare function tokenizeUserAgent(userAgent: string): TokenizedUserAgent;
+/**
+ * A User Agent rule takes a tokenized user agent, and if the rule matches, returns the Browser
+ * or Platform
+ * information. Otherwise, returns null.
+ */
+export type SystemInfoRule = (tokenizedUa: TokenizedUserAgent) => UaSystemInfo | null;
+/**
+ * A User Agent rule takes a tokenized user agent, and if the rule matches, returns the Device
+ * information. Otherwise, returns null.
+ */
+export type DeviceInfoRule = (tokenizedUa: TokenizedUserAgent) => UaDeviceInfo | null;
+/**
+ * A User Agent rule takes a tokenized user agent, and if the rule matches, returns the Browser
+ * or Platform
+ * information. Otherwise, returns null.
+ */
+export type SystemInfoLikeRule = (tokenizedUa: TokenizedUserAgent, systemInfo: UaSystemInfo | null) => UaSystemInfo | null;
+/**
+ * The ruleset to use when parsing a user agent.
+ * Rules are expected to be from most specific to least.
+ */
+export interface UserAgentRules {
+    readonly browserRules: readonly SystemInfoRule[];
+    readonly browserLikeRules: readonly SystemInfoLikeRule[];
+    readonly osRules: readonly SystemInfoRule[];
+    readonly osLikeRules: readonly SystemInfoLikeRule[];
+    readonly deviceRules: readonly DeviceInfoRule[];
+}
+/**
+ * A tokenized user agent.
+ * A common format for user agents:
+ * `Mozilla/5.0 (<system-information>) <platform> (<platform-details>) [extensions]`
+ *
+ */
+export interface TokenizedUserAgent {
+    /**
+     * The original user agent.
+     */
+    readonly userAgent: string;
+    /**
+     * The tokenized system and platform details or extensions (parts within parenthetical sections
+     * separated by semicolons.)
+     */
+    readonly system: TokenizedInfo;
+    /**
+     * The tokenized platform info (parts outside parenthetical sections, separated by
+     * whitespace.)
+     */
+    readonly platform: TokenizedInfo;
+}
+/**
+ * A parsed system or extension part of the user agent. (A section within a parenthetical)
+ */
+export interface UserAgentPart extends UaSystemInfo {
+    readonly name: string;
+    readonly version: Version | null;
+    readonly tokens: readonly string[];
+}
+export declare class TokenizedInfo {
+    readonly parts: UserAgentPart[];
+    /**
+     * A token map of lowercase token strings to name/version pairs.
+     */
+    private readonly tokenMap;
+    constructor(parts: UserAgentPart[]);
+    /**
+     * Given lowercase tokens of only alpha characters, returns the mapped token part if all tokens
+     * are contained in the section.
+     */
+    get(...tokens: readonly string[]): UaSystemInfo | null;
+    /**
+     * Given an expression of logical operators, returns the name and version of the part
+     * that matches the expression.
+     *
+     * Logical operators currently supported: | for OR and & for AND.
+     * Operands between operators will be tokenized via {@link tokenizeWords}.
+     *
+     * @param expr The expression of tokens and operators. Example: 'windows phone|windows&mobile'
+     * will match when one part has both 'windows' and 'phone' or there are two parts, one with
+     * 'windows' and another part with 'mobile'
+     * (Case insensitive)
+     */
+    query(expr: string): UaSystemInfo | null;
+}
+/**
+ * Executes a logical expression mapping tokens with a predicate, using the result as operands.
+ *
+ * Logical operators currently supported: | for OR and & for AND.
+ * Operands between operators will be tokenized via {@link tokenizeWords}.
+ *
+ * @param expr The expression of tokens and operators.
+ * @param predicate Each token set operand will be mapped using this function.
+ */
+export declare function tokenQuery<T>(expr: string, predicate: (tokens: readonly string[]) => Maybe<T>): T | null;
+//# sourceMappingURL=tokenizeUserAgent.d.ts.map

package/dist/types/current/client/userAgent/tokenizeUserAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenizeUserAgent.d.ts","sourceRoot":"","sources":["../../../../../src/client/userAgent/tokenizeUserAgent.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE/C,OAAO,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AA4BjE;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,kBAAkB,CA+CvE;AAOD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,CACzB,WAAW,EAAE,kBAAkB,KAC9B,YAAY,GAAG,IAAI,CAAA;AAExB;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,CACzB,WAAW,EAAE,kBAAkB,KAC9B,YAAY,GAAG,IAAI,CAAA;AAExB;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAC7B,WAAW,EAAE,kBAAkB,EAC/B,UAAU,EAAE,YAAY,GAAG,IAAI,KAC9B,YAAY,GAAG,IAAI,CAAA;AAExB;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B,QAAQ,CAAC,YAAY,EAAE,SAAS,cAAc,EAAE,CAAA;IAChD,QAAQ,CAAC,gBAAgB,EAAE,SAAS,kBAAkB,EAAE,CAAA;IACxD,QAAQ,CAAC,OAAO,EAAE,SAAS,cAAc,EAAE,CAAA;IAC3C,QAAQ,CAAC,WAAW,EAAE,SAAS,kBAAkB,EAAE,CAAA;IACnD,QAAQ,CAAC,WAAW,EAAE,SAAS,cAAc,EAAE,CAAA;CAClD;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAA;IAE9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,YAAY;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAA;IAChC,QAAQ,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAA;CACrC;AAED,qBAAa,aAAa;IAMV,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE;IAL3C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoC;gBAExC,KAAK,EAAE,aAAa,EAAE;IAiB3C;;;OAGG;IACH,GAAG,CAAC,GAAG,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,YAAY,GAAG,IAAI;IAWtD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,GAAG,IAAI;CAG3C;AAED;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,CAAC,EACxB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,GACnD,CAAC,GAAG,IAAI,CAWV"}