@alitu/user-agents-v2-api 0.1.0

package/README.md

@@ -0,0 +1,3 @@
+# user-agents-v2-api
+
+API for identifying User-Agent strings using OPAWG's user-agents-v2 lists.

package/dist/index.js

@@ -0,0 +1,65 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseUserAgent;
+var user_agents_v2_1 = require("./user-agents-v2");
+// Files must be searched in this order to accurately identify User-Agent
+// https://github.com/the-podcast-host/user-agents-v2?tab=readme-ov-file#quick-start
+var files = [
+    { filename: 'bots', entries: user_agents_v2_1.default.bots },
+    { filename: 'apps', entries: user_agents_v2_1.default.apps },
+    { filename: 'libraries', entries: user_agents_v2_1.default.libraries },
+    { filename: 'browsers', entries: user_agents_v2_1.default.browsers },
+];
+/**
+ * Check if a string is URL encoded.
+ * @param {string} str string to check
+ * @returns {boolean} boolean
+ */
+function isUrlEncoded(str) {
+    try {
+        return str !== decodeURIComponent(str);
+    }
+    catch (error) {
+        return false;
+    }
+}
+/**
+ * Search OPAWG user-agent-v2 lists for User-Agent string.
+ * @param {string} userAgent User-Agent string
+ * @returns {OPAWGPatternEntry | undefined} OPAWG pattern entry, undefined if not found
+ */
+function parseUserAgent(userAgent) {
+    // Skip empty strings
+    if (!userAgent)
+        return undefined;
+    // Remove URL encoding
+    var sanitizedUserAgent = isUrlEncoded(userAgent)
+        ? decodeURIComponent(userAgent)
+        : userAgent;
+    // Remove newlines
+    sanitizedUserAgent = userAgent.replace(/(\r\n|\n|\r)/g, '');
+    // Iterate lists in order
+    for (var _i = 0, files_1 = files; _i < files_1.length; _i++) {
+        var _a = files_1[_i], filename = _a.filename, entries = _a.entries;
+        for (var _b = 0, entries_1 = entries; _b < entries_1.length; _b++) {
+            var entry = entries_1[_b];
+            // Return entry if match is found
+            if (sanitizedUserAgent.match(entry.regexp)) {
+                return __assign({ filename: filename }, entry);
+            }
+        }
+    }
+    // If no match is found, return undefined
+    return undefined;
+}

package/dist/index.test.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var _1 = require(".");
+test('identifies bots', function () {
+    var entry = (0, _1.default)('Mozilla/5.0 (compatible; HubSpot Crawler; +https://www.hubspot.com)');
+    expect(entry.name === 'HubSpot Crawler');
+});
+test('identifies apps', function () {
+    var entry = (0, _1.default)('Overcast/3.0 (+http://overcast.fm/; iOS podcast app)');
+    expect(entry.name).toBe('Overcast');
+});
+test('identifies libraries', function () {
+    var entry = (0, _1.default)('AppleCoreMedia/1.0.0.16G114 (iPod touch; U; CPU OS 12_4_2 like Mac OS X; en_us)');
+    expect(entry.name).toBe('AppleCoreMedia');
+});
+test('identifies bot libraries', function () {
+    var entry = (0, _1.default)('Apache-HttpClient/4.5.3-SNAPSHOT (Java/1.8.0_73)');
+    expect(entry.name).toBe('Apache HttpClient');
+    expect(entry.category).toBe('bot');
+});
+test('identifies browsers', function () {
+    var entry = (0, _1.default)('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/54.0.2840.71 Safari/537.36');
+    expect(entry.name).toBe('Chrome');
+});