@antha/gamepad-type 0.1.0

package/dist/find-matches.d.ts

@@ -0,0 +1,42 @@
+import { type GamepadDevice, type InputDevice } from 'input-device-handler';
+import { type GamepadLayout } from './gamepad-layout.js';
+import { type GamepadBrandMap, type GamepadModelMap } from './gamepad-model.js';
+import { type SystemVersions } from './system-versions.js';
+/**
+ * Given a gamepad name, tries to find the best matching predefined or custom gamepad layout based
+ * on system versions. Returns undefined if no possible matches are found.
+ *
+ * @category Main
+ */
+export declare function findMatchingGamepadLayout({ gamepad, layouts, gamepadModelMap, systemVersions, }: {
+    /** The gamepad to match for. */
+    gamepad: Readonly<Pick<GamepadDevice, 'deviceName'>> | string | undefined;
+    /** Provide custom layouts. Defaults to this package's predefined layouts. */
+    layouts?: ReadonlyArray<Readonly<GamepadLayout>>;
+    /** Provide custom gamepad model maps. Defaults to this package's predefined model map. */
+    gamepadModelMap?: Readonly<GamepadModelMap>;
+    /** Provide custom system versions. Defaults to the current system's system versions. */
+    systemVersions?: Readonly<SystemVersions>;
+}): GamepadLayout | undefined;
+/**
+ * Find matching gamepad model, brand, and description. Will return PredefinedGamepadModel.Unknown,
+ * PredefinedGamepadBrand.Unknown, and an empty string respectively if the given gamepad name is not
+ * known.
+ *
+ * @category Main
+ */
+export declare function findMatchingGamepadModel({ gamepad: gamepadNameOrDevice, gamepadModelMap, gamepadBrandMap, }: {
+    /**
+     * Either the gamepad's id / name or a gamepad object returned from the input-device-handler
+     * package.
+     */
+    gamepad: string | Readonly<Pick<InputDevice, 'deviceName'>> | undefined;
+    /** Defaults to the predefined internal model map. */
+    gamepadModelMap?: Readonly<GamepadModelMap> | undefined;
+    /** Defaults to the predefined internal brand map. */
+    gamepadBrandMap?: Readonly<GamepadBrandMap> | undefined;
+}): {
+    gamepadModel: string | undefined;
+    gamepadBrand: string | undefined;
+    gamepadModelDescription: string | undefined;
+};

package/dist/find-matches.js

@@ -0,0 +1,77 @@
+import { check } from '@augment-vir/assert';
+import { mapObjectValues } from '@augment-vir/common';
+import { defaultGamepadLayouts } from './default-layouts.js';
+import { defaultGamepadBrandMap, defaultGamepadModelMap } from './default-models.js';
+import { predefinedGamepadModelDescriptions, } from './gamepad-model.js';
+import { getSystemVersions } from './system-versions.js';
+import { makeObjectKeysLowercase } from './util/lowercase-keys.js';
+/**
+ * Given a gamepad name, tries to find the best matching predefined or custom gamepad layout based
+ * on system versions. Returns undefined if no possible matches are found.
+ *
+ * @category Main
+ */
+export function findMatchingGamepadLayout({ gamepad, layouts = defaultGamepadLayouts, gamepadModelMap = defaultGamepadModelMap, systemVersions = getSystemVersions(), }) {
+    const gamepadName = (check.isString(gamepad) ? gamepad : gamepad?.deviceName) || '';
+    const { gamepadModel } = findMatchingGamepadModel({
+        gamepad: gamepadName,
+        gamepadModelMap,
+    });
+    // filter by gamepad model
+    const byGamepadModel = gamepadModel
+        ? layouts.filter((layout) => {
+            return layout.gamepadModels.includes(gamepadModel);
+        })
+        : [];
+    if (byGamepadModel.length <= 1) {
+        return byGamepadModel[0];
+    }
+    // filter by highest scoring system version match
+    const byLayoutScore = byGamepadModel.reduce((highestScoring, currentLayout) => {
+        const score = scoreLayoutSystemVersions(systemVersions, currentLayout);
+        if (score > highestScoring.score) {
+            return {
+                score,
+                layout: currentLayout,
+            };
+        }
+        else {
+            return highestScoring;
+        }
+    }, {
+        layout: undefined,
+        score: -1,
+    });
+    return byLayoutScore.layout;
+}
+/** Gives a score to the layout based on how closely it matches the current system. */
+function scoreLayoutSystemVersions(systemVersions, layout) {
+    const scores = layout.systemVersions.map((layoutSystemVersions) => {
+        const matches = Object.values(mapObjectValues(systemVersions, (key, value) => {
+            return layoutSystemVersions[key].toLowerCase() === value.toLowerCase();
+        }));
+        return matches.reduce((sum, match) => {
+            return sum + (match ? 1 : 0);
+        }, 0);
+    });
+    return Math.max(...scores);
+}
+/**
+ * Find matching gamepad model, brand, and description. Will return PredefinedGamepadModel.Unknown,
+ * PredefinedGamepadBrand.Unknown, and an empty string respectively if the given gamepad name is not
+ * known.
+ *
+ * @category Main
+ */
+export function findMatchingGamepadModel({ gamepad: gamepadNameOrDevice, gamepadModelMap = defaultGamepadModelMap, gamepadBrandMap = defaultGamepadBrandMap, }) {
+    const gamepadName = (typeof gamepadNameOrDevice === 'string'
+        ? gamepadNameOrDevice
+        : gamepadNameOrDevice?.deviceName) || undefined;
+    const gamepadModel = (gamepadName && makeObjectKeysLowercase(gamepadModelMap)[gamepadName.toLowerCase()]) ||
+        undefined;
+    return {
+        gamepadModel,
+        gamepadBrand: (gamepadModel && makeObjectKeysLowercase(gamepadBrandMap)[gamepadModel]) || undefined,
+        gamepadModelDescription: (gamepadModel && predefinedGamepadModelDescriptions[gamepadModel]) || undefined,
+    };
+}

package/dist/gamepad-layout.d.ts

@@ -0,0 +1,29 @@
+import { type PartialWithUndefined } from '@augment-vir/common';
+import { type SystemVersions } from './system-versions.js';
+/**
+ * A mapping of gamepad button and axe numbers to their names. Mappings depend on the current system
+ * and gamepad model (so those are included as well).
+ *
+ * @category Types
+ */
+export type GamepadLayout = {
+    /**
+     * The list of supported gamepad models for this layout. These are _mapped_ model names, not the
+     * raw device names or gamepad ids directly from the browser.
+     */
+    gamepadModels: string[];
+    systemVersions: SystemVersions[];
+    inputMappings: Record<string, string>;
+    notes?: PartialWithUndefined<{
+        /**
+         * A simple note with an explanation that does not significantly impact the gamepad's
+         * performance.
+         */
+        info: string;
+        /**
+         * An important note that explains why the gamepad does not work or why it has has
+         * major issues.
+         */
+        warning: string;
+    }> | undefined;
+};

package/dist/gamepad-layout.js

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

package/dist/gamepad-model.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Mapping from Gamepad ids or names to model strings.
+ *
+ * @category Types
+ */
+export type GamepadModelMap = Readonly<{
+    [GamepadId in string]: string | PredefinedGamepadModel;
+}>;
+/**
+ * Mapping from Gamepad ids or names to brand strings.
+ *
+ * @category Types
+ */
+export type GamepadBrandMap = Readonly<{
+    [GamepadId in string]: string | PredefinedGamepadBrand;
+}>;
+/**
+ * All gamepad models known and defined by the
+ * [gamepad-type](https://www.npmjs.com/package/gamepad-type) package. It contains a new entry for
+ * each gamepad generation that features different button layouts.
+ *
+ * Note that any consumer of the [gamepad-type](https://www.npmjs.com/package/gamepad-type) package
+ * is able to freely define their own models as well, this is merely the _pre_ defined set of
+ * models.
+ *
+ * See {@link predefinedGamepadModelDescriptions} for comments on what each model is.
+ *
+ * @category Defaults
+ */
+export declare enum PredefinedGamepadModel {
+    SwitchPro = "switch-pro",
+    PlaystationDualShock = "playstation-dual-shock",
+    PlaystationDualShock4 = "playstation-dual-shock-4",
+    PlaystationDualSense = "playstation-dual-sense",
+    SteamDeck = "steam-deck",
+    Xbox360 = "xbox-360",
+    XboxWireless = "xbox-wireless"
+}
+/**
+ * A map of {@link PredefinedGamepadModel} to pretty user facing names.
+ *
+ * @category Defaults
+ */
+export declare const fancyGamepadModelName: Record<PredefinedGamepadModel, string>;
+/**
+ * Gamepad brands known and defined by the
+ * [gamepad-type](https://www.npmjs.com/package/gamepad-type) package.
+ *
+ * Note that any consumer of the [gamepad-type](https://www.npmjs.com/package/gamepad-type) package
+ * is able to freely define their own brands as well, this is merely the _pre_ defined set of
+ * brands.
+ *
+ * @category Defaults
+ */
+export declare enum PredefinedGamepadBrand {
+    Microsoft = "microsoft",
+    Nintendo = "nintendo",
+    Sony = "sony",
+    Valve = "valve"
+}
+/**
+ * Description of each gamepad model predefined by the
+ * [gamepad-type](https://www.npmjs.com/package/gamepad-type) package.
+ *
+ * @category Defaults
+ */
+export declare const predefinedGamepadModelDescriptions: Readonly<Record<string, string>>;

package/dist/gamepad-model.js

@@ -0,0 +1,69 @@
+/**
+ * All gamepad models known and defined by the
+ * [gamepad-type](https://www.npmjs.com/package/gamepad-type) package. It contains a new entry for
+ * each gamepad generation that features different button layouts.
+ *
+ * Note that any consumer of the [gamepad-type](https://www.npmjs.com/package/gamepad-type) package
+ * is able to freely define their own models as well, this is merely the _pre_ defined set of
+ * models.
+ *
+ * See {@link predefinedGamepadModelDescriptions} for comments on what each model is.
+ *
+ * @category Defaults
+ */
+export var PredefinedGamepadModel;
+(function (PredefinedGamepadModel) {
+    PredefinedGamepadModel["SwitchPro"] = "switch-pro";
+    PredefinedGamepadModel["PlaystationDualShock"] = "playstation-dual-shock";
+    PredefinedGamepadModel["PlaystationDualShock4"] = "playstation-dual-shock-4";
+    PredefinedGamepadModel["PlaystationDualSense"] = "playstation-dual-sense";
+    PredefinedGamepadModel["SteamDeck"] = "steam-deck";
+    PredefinedGamepadModel["Xbox360"] = "xbox-360";
+    PredefinedGamepadModel["XboxWireless"] = "xbox-wireless";
+})(PredefinedGamepadModel || (PredefinedGamepadModel = {}));
+/**
+ * A map of {@link PredefinedGamepadModel} to pretty user facing names.
+ *
+ * @category Defaults
+ */
+export const fancyGamepadModelName = {
+    [PredefinedGamepadModel.SwitchPro]: 'Switch Pro Controller',
+    [PredefinedGamepadModel.PlaystationDualShock]: 'PlayStation DualShock',
+    [PredefinedGamepadModel.PlaystationDualShock4]: 'PlayStation DualShock 4',
+    [PredefinedGamepadModel.PlaystationDualSense]: 'PlayStation DualSense',
+    [PredefinedGamepadModel.SteamDeck]: 'Steam Deck',
+    [PredefinedGamepadModel.Xbox360]: 'Xbox 360',
+    [PredefinedGamepadModel.XboxWireless]: 'Xbox Wireless',
+};
+/**
+ * Gamepad brands known and defined by the
+ * [gamepad-type](https://www.npmjs.com/package/gamepad-type) package.
+ *
+ * Note that any consumer of the [gamepad-type](https://www.npmjs.com/package/gamepad-type) package
+ * is able to freely define their own brands as well, this is merely the _pre_ defined set of
+ * brands.
+ *
+ * @category Defaults
+ */
+export var PredefinedGamepadBrand;
+(function (PredefinedGamepadBrand) {
+    PredefinedGamepadBrand["Microsoft"] = "microsoft";
+    PredefinedGamepadBrand["Nintendo"] = "nintendo";
+    PredefinedGamepadBrand["Sony"] = "sony";
+    PredefinedGamepadBrand["Valve"] = "valve";
+})(PredefinedGamepadBrand || (PredefinedGamepadBrand = {}));
+/**
+ * Description of each gamepad model predefined by the
+ * [gamepad-type](https://www.npmjs.com/package/gamepad-type) package.
+ *
+ * @category Defaults
+ */
+export const predefinedGamepadModelDescriptions = {
+    [PredefinedGamepadModel.SwitchPro]: 'Nintendo Switch Pro gamepad for the Nintendo Switch console.',
+    [PredefinedGamepadModel.PlaystationDualSense]: 'Sony PlayStation DualSense gamepad for the Sony PlayStation 5 console.',
+    [PredefinedGamepadModel.PlaystationDualShock]: 'Sony PlayStation DualShock gamepad for the Sony PlayStation 1 through Sony PlayStation 3 consoles.',
+    [PredefinedGamepadModel.PlaystationDualShock4]: 'Sony PlayStation DualShock 4 gamepad for the Sony PlayStation 4 console.',
+    [PredefinedGamepadModel.SteamDeck]: 'Gamepad for the Valve Steam Deck handheld console.',
+    [PredefinedGamepadModel.Xbox360]: 'Microsoft Xbox 360 gamepad for the Microsoft Xbox 360 console. Can be wired or wireless.',
+    [PredefinedGamepadModel.XboxWireless]: 'Microsoft Xbox Wireless gamepad for Microsoft Xbox One through Xbox Series X/S consoles.',
+};

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export * from './create.js';
+export * from './default-layouts.js';
+export * from './default-models.js';
+export * from './find-matches.js';
+export * from './gamepad-layout.js';
+export * from './gamepad-model.js';
+export * from './known-input.js';
+export * from './system-versions.js';

package/dist/index.js

@@ -0,0 +1,8 @@
+export * from './create.js';
+export * from './default-layouts.js';
+export * from './default-models.js';
+export * from './find-matches.js';
+export * from './gamepad-layout.js';
+export * from './gamepad-model.js';
+export * from './known-input.js';
+export * from './system-versions.js';

package/dist/known-input.d.ts

@@ -0,0 +1,126 @@
+/**
+ * Consolidated (as much as possible across each brand ) known inputs.
+ *
+ * @category Util
+ */
+export declare enum KnownInput {
+    /** A on Xbox and Nintendo, X on Playstation. */
+    FaceAccept = "face-accept",
+    /** B on Xbox and Nintendo, Circle on Playstation. */
+    FaceCancel = "face-cancel",
+    /** X on Xbox and Nintendo, Square on Playstation. */
+    FaceAlt1 = "face-alt-1",
+    /** Y on Xbox and Nintendo, Triangle on Playstation. */
+    FaceAlt2 = "face-alt-2",
+    /** The top left trigger area button. */
+    L1 = "L1",
+    /** The bottom left trigger area button. */
+    L2 = "L2",
+    /** Left stick click. */
+    L3 = "L3",
+    /** The top right trigger area button. */
+    R1 = "R1",
+    /** The bottom right trigger area button. */
+    R2 = "R2",
+    /** Right stick click. */
+    R3 = "R3",
+    LeftStickX = "left-stick-x",
+    LeftStickY = "left-stick-y",
+    RightStickX = "right-stick-x",
+    RightStickY = "right-stick-y",
+    DPad = "d-pad",
+    DPadDown = "d-pad-down",
+    DPadLeft = "d-pad-left",
+    DPadRight = "d-pad-right",
+    DPadUp = "d-pad-up",
+    /** The primary center button to the left of the controller logo. */
+    Select = "select",
+    /** The button which is also the controller brand's logo. */
+    Logo = "logo",
+    /** The primary center button to the right of the controller logo. */
+    Start = "start",
+    /** Only exists on Nintendo controllers. */
+    Capture = "capture",
+    /** Only exists on Nintendo controllers. */
+    Home = "home",
+    /** Only exists on Playstation controllers. */
+    Mute = "mute",
+    /**
+     * Exists on Xbox controllers. Note that on Dualshock 4 controllers, which has a "Share" button,
+     * their share button is mapped to Select instead of Share.
+     */
+    Share = "share",
+    /** Only exists on Playstation controllers. */
+    TouchPad = "touch-pad"
+}
+/**
+ * Name overrides for each brand for consolidated input names from {@link KnownInput}.
+ *
+ * @category Util
+ */
+export declare const modelInputNameOverrides: {
+    readonly "switch-pro": {
+        readonly L1: "L";
+        readonly R1: "R";
+        readonly L2: "ZL";
+        readonly R2: "ZR";
+        readonly "face-accept": "A";
+        readonly "face-cancel": "B";
+        readonly "face-alt-1": "X";
+        readonly "face-alt-2": "Y";
+        readonly select: "minus";
+        readonly start: "plus";
+    };
+    readonly "playstation-dual-shock": {
+        readonly "face-accept": "X";
+        readonly "face-cancel": "O";
+        readonly "face-alt-1": "square";
+        readonly "face-alt-2": "triangle";
+    };
+    readonly "playstation-dual-shock-4": {
+        readonly "face-accept": "X";
+        readonly "face-cancel": "O";
+        readonly "face-alt-1": "square";
+        readonly "face-alt-2": "triangle";
+        readonly select: "share";
+    };
+    readonly "playstation-dual-sense": {
+        readonly "face-accept": "X";
+        readonly "face-cancel": "O";
+        readonly "face-alt-1": "square";
+        readonly "face-alt-2": "triangle";
+        readonly select: "create";
+        readonly start: "options";
+    };
+    readonly "steam-deck": {
+        readonly "face-accept": "A";
+        readonly "face-cancel": "B";
+        readonly "face-alt-1": "X";
+        readonly "face-alt-2": "Y";
+        readonly select: "view";
+        readonly start: "menu";
+    };
+    readonly "xbox-360": {
+        readonly L1: "LB";
+        readonly R1: "RB";
+        readonly L2: "LT";
+        readonly R2: "RT";
+        readonly "face-accept": "A";
+        readonly "face-cancel": "B";
+        readonly "face-alt-1": "X";
+        readonly "face-alt-2": "Y";
+        readonly select: "back";
+    };
+    readonly "xbox-wireless": {
+        readonly L1: "LB";
+        readonly R1: "RB";
+        readonly L2: "LT";
+        readonly R2: "RT";
+        readonly "face-accept": "A";
+        readonly "face-cancel": "B";
+        readonly "face-alt-1": "X";
+        readonly "face-alt-2": "Y";
+        readonly select: "view";
+        readonly start: "menu";
+    };
+};

package/dist/known-input.js

@@ -0,0 +1,128 @@
+import { PredefinedGamepadModel } from './gamepad-model.js';
+/**
+ * Consolidated (as much as possible across each brand ) known inputs.
+ *
+ * @category Util
+ */
+export var KnownInput;
+(function (KnownInput) {
+    /** A on Xbox and Nintendo, X on Playstation. */
+    KnownInput["FaceAccept"] = "face-accept";
+    /** B on Xbox and Nintendo, Circle on Playstation. */
+    KnownInput["FaceCancel"] = "face-cancel";
+    /** X on Xbox and Nintendo, Square on Playstation. */
+    KnownInput["FaceAlt1"] = "face-alt-1";
+    /** Y on Xbox and Nintendo, Triangle on Playstation. */
+    KnownInput["FaceAlt2"] = "face-alt-2";
+    /** The top left trigger area button. */
+    KnownInput["L1"] = "L1";
+    /** The bottom left trigger area button. */
+    KnownInput["L2"] = "L2";
+    /** Left stick click. */
+    KnownInput["L3"] = "L3";
+    /** The top right trigger area button. */
+    KnownInput["R1"] = "R1";
+    /** The bottom right trigger area button. */
+    KnownInput["R2"] = "R2";
+    /** Right stick click. */
+    KnownInput["R3"] = "R3";
+    KnownInput["LeftStickX"] = "left-stick-x";
+    KnownInput["LeftStickY"] = "left-stick-y";
+    KnownInput["RightStickX"] = "right-stick-x";
+    KnownInput["RightStickY"] = "right-stick-y";
+    KnownInput["DPad"] = "d-pad";
+    KnownInput["DPadDown"] = "d-pad-down";
+    KnownInput["DPadLeft"] = "d-pad-left";
+    KnownInput["DPadRight"] = "d-pad-right";
+    KnownInput["DPadUp"] = "d-pad-up";
+    /** The primary center button to the left of the controller logo. */
+    KnownInput["Select"] = "select";
+    /** The button which is also the controller brand's logo. */
+    KnownInput["Logo"] = "logo";
+    /** The primary center button to the right of the controller logo. */
+    KnownInput["Start"] = "start";
+    /** Only exists on Nintendo controllers. */
+    KnownInput["Capture"] = "capture";
+    /** Only exists on Nintendo controllers. */
+    KnownInput["Home"] = "home";
+    /** Only exists on Playstation controllers. */
+    KnownInput["Mute"] = "mute";
+    /**
+     * Exists on Xbox controllers. Note that on Dualshock 4 controllers, which has a "Share" button,
+     * their share button is mapped to Select instead of Share.
+     */
+    KnownInput["Share"] = "share";
+    /** Only exists on Playstation controllers. */
+    KnownInput["TouchPad"] = "touch-pad";
+})(KnownInput || (KnownInput = {}));
+/**
+ * Name overrides for each brand for consolidated input names from {@link KnownInput}.
+ *
+ * @category Util
+ */
+export const modelInputNameOverrides = {
+    [PredefinedGamepadModel.SwitchPro]: {
+        [KnownInput.L1]: 'L',
+        [KnownInput.R1]: 'R',
+        [KnownInput.L2]: 'ZL',
+        [KnownInput.R2]: 'ZR',
+        [KnownInput.FaceAccept]: 'A',
+        [KnownInput.FaceCancel]: 'B',
+        [KnownInput.FaceAlt1]: 'X',
+        [KnownInput.FaceAlt2]: 'Y',
+        [KnownInput.Select]: 'minus',
+        [KnownInput.Start]: 'plus',
+    },
+    [PredefinedGamepadModel.PlaystationDualShock]: {
+        [KnownInput.FaceAccept]: 'X',
+        [KnownInput.FaceCancel]: 'O',
+        [KnownInput.FaceAlt1]: 'square',
+        [KnownInput.FaceAlt2]: 'triangle',
+    },
+    [PredefinedGamepadModel.PlaystationDualShock4]: {
+        [KnownInput.FaceAccept]: 'X',
+        [KnownInput.FaceCancel]: 'O',
+        [KnownInput.FaceAlt1]: 'square',
+        [KnownInput.FaceAlt2]: 'triangle',
+        [KnownInput.Select]: 'share',
+    },
+    [PredefinedGamepadModel.PlaystationDualSense]: {
+        [KnownInput.FaceAccept]: 'X',
+        [KnownInput.FaceCancel]: 'O',
+        [KnownInput.FaceAlt1]: 'square',
+        [KnownInput.FaceAlt2]: 'triangle',
+        [KnownInput.Select]: 'create',
+        [KnownInput.Start]: 'options',
+    },
+    [PredefinedGamepadModel.SteamDeck]: {
+        [KnownInput.FaceAccept]: 'A',
+        [KnownInput.FaceCancel]: 'B',
+        [KnownInput.FaceAlt1]: 'X',
+        [KnownInput.FaceAlt2]: 'Y',
+        [KnownInput.Select]: 'view',
+        [KnownInput.Start]: 'menu',
+    },
+    [PredefinedGamepadModel.Xbox360]: {
+        [KnownInput.L1]: 'LB',
+        [KnownInput.R1]: 'RB',
+        [KnownInput.L2]: 'LT',
+        [KnownInput.R2]: 'RT',
+        [KnownInput.FaceAccept]: 'A',
+        [KnownInput.FaceCancel]: 'B',
+        [KnownInput.FaceAlt1]: 'X',
+        [KnownInput.FaceAlt2]: 'Y',
+        [KnownInput.Select]: 'back',
+    },
+    [PredefinedGamepadModel.XboxWireless]: {
+        [KnownInput.L1]: 'LB',
+        [KnownInput.R1]: 'RB',
+        [KnownInput.L2]: 'LT',
+        [KnownInput.R2]: 'RT',
+        [KnownInput.FaceAccept]: 'A',
+        [KnownInput.FaceCancel]: 'B',
+        [KnownInput.FaceAlt1]: 'X',
+        [KnownInput.FaceAlt2]: 'Y',
+        [KnownInput.Select]: 'view',
+        [KnownInput.Start]: 'menu',
+    },
+};

package/dist/system-versions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * System versions that are used to differentiate gamepad layouts, since layouts may differ
+ * dramatically between different browsers, operating systems, and versions of each.
+ *
+ * @category Types
+ */
+export type SystemVersions = Readonly<{
+    osName: string;
+    osVersion: string;
+    browserName: string;
+    browserVersion: string;
+}>;
+/**
+ * Get the current system's versions. This is determined by parsing the user agent string using the
+ * [bowser](https://www.npmjs.com/package/bowser) package.
+ *
+ * @category Util
+ */
+export declare function getSystemVersions(): SystemVersions;
+/**
+ * Check if a system version is in an array of system versions.
+ *
+ * @category Util
+ */
+export declare function includesSystemVersion(systemVersions: ReadonlyArray<Readonly<SystemVersions>>, systemVersion: Readonly<SystemVersions>): boolean;

package/dist/system-versions.js

@@ -0,0 +1,26 @@
+import { check } from '@augment-vir/assert';
+import Bowser from 'bowser';
+const bowser = Bowser.getParser(navigator.userAgent);
+/**
+ * Get the current system's versions. This is determined by parsing the user agent string using the
+ * [bowser](https://www.npmjs.com/package/bowser) package.
+ *
+ * @category Util
+ */
+export function getSystemVersions() {
+    return {
+        /* node:coverage ignore next: supported browser user agents include a browser version. */
+        browserVersion: bowser.getBrowserVersion() || 'unknown',
+        browserName: bowser.getBrowserName(),
+        osName: bowser.getOSName(),
+        osVersion: bowser.getOSVersion(),
+    };
+}
+/**
+ * Check if a system version is in an array of system versions.
+ *
+ * @category Util
+ */
+export function includesSystemVersion(systemVersions, systemVersion) {
+    return systemVersions.some((matchThis) => check.jsonEquals(matchThis, systemVersion));
+}

package/dist/util/lowercase-keys.d.ts

@@ -0,0 +1,2 @@
+import { type Values } from '@augment-vir/common';
+export declare function makeObjectKeysLowercase<Generic extends Readonly<Record<PropertyKey, unknown>>>(input: Generic): Record<PropertyKey, Values<Generic>>;

package/dist/util/lowercase-keys.js

@@ -0,0 +1,10 @@
+import { check } from '@augment-vir/assert';
+import { mapObject } from '@augment-vir/common';
+export function makeObjectKeysLowercase(input) {
+    return mapObject(input, (key, value) => {
+        return {
+            key: check.isString(key) ? key.toLowerCase() : key,
+            value,
+        };
+    });
+}