@alitu/user-agents-v2-api 0.1.2 → 0.1.3

package/dist/index.d.ts

@@ -1,11 +1,8 @@
 import type { OPAWGPatternEntry } from './user-agents-v2';
-type ParseUserAgentResult = (OPAWGPatternEntry & {
-    filename: string;
-}) | undefined;
 /**
  * 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
  */
-export default function parseUserAgent(userAgent: string): ParseUserAgentResult;
-export {};
+export default function parseUserAgent(userAgent: string): OPAWGPatternEntry | undefined;
+export { OPAWGFileType } from './user-agents-v2';

package/dist/index.js

@@ -1,25 +1,15 @@
 "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.OPAWGFileType = void 0;
 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 },
+    user_agents_v2_1.default.bots,
+    user_agents_v2_1.default.apps,
+    user_agents_v2_1.default.libraries,
+    user_agents_v2_1.default.browsers,
 ];
 /**
  * Check if a string is URL encoded.
@@ -48,18 +38,20 @@ function parseUserAgent(userAgent) {
         ? decodeURIComponent(userAgent)
         : userAgent;
     // Remove newlines
-    sanitizedUserAgent = userAgent.replace(/(\r\n|\n|\r)/g, '');
+    sanitizedUserAgent = sanitizedUserAgent.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];
+        var entries = files_1[_i];
+        for (var _a = 0, entries_1 = entries; _a < entries_1.length; _a++) {
+            var entry = entries_1[_a];
             // Return entry if match is found
             if (sanitizedUserAgent.match(entry.regexp)) {
-                return __assign({ filename: filename }, entry);
+                return entry;
             }
         }
     }
     // If no match is found, return undefined
     return undefined;
 }
+var user_agents_v2_2 = require("./user-agents-v2");
+Object.defineProperty(exports, "OPAWGFileType", { enumerable: true, get: function () { return user_agents_v2_2.OPAWGFileType; } });

package/dist/user-agents-v2/index.d.ts

@@ -1,74 +1,17 @@
 import type { OPAWGPatternsFile } from './patterns';
+export declare const OPAWGFileType: {
+    readonly Apps: "apps";
+    readonly Bots: "bots";
+    readonly Browsers: "browsers";
+    readonly Devices: "devices";
+    readonly Libraries: "libraries";
+    readonly Referrers: "referrers";
+};
+type OPAWGFileType = (typeof OPAWGFileType)[keyof typeof OPAWGFileType];
 type Entry = NonNullable<OPAWGPatternsFile['entries']>[number];
-export interface OPAWGPatternEntry extends Entry {
+export type OPAWGPatternEntry = Entry & {
+    type: OPAWGFileType;
     regexp: RegExp;
-}
-declare const _default: {
-    apps: {
-        regexp: RegExp;
-        name: string;
-        pattern: string;
-        description?: string;
-        svg?: string;
-        comments?: string;
-        examples?: string[];
-        urls?: string[];
-        category?: string;
-    }[];
-    bots: {
-        regexp: RegExp;
-        name: string;
-        pattern: string;
-        description?: string;
-        svg?: string;
-        comments?: string;
-        examples?: string[];
-        urls?: string[];
-        category?: string;
-    }[];
-    browsers: {
-        regexp: RegExp;
-        name: string;
-        pattern: string;
-        description?: string;
-        svg?: string;
-        comments?: string;
-        examples?: string[];
-        urls?: string[];
-        category?: string;
-    }[];
-    devices: {
-        regexp: RegExp;
-        name: string;
-        pattern: string;
-        description?: string;
-        svg?: string;
-        comments?: string;
-        examples?: string[];
-        urls?: string[];
-        category?: string;
-    }[];
-    libraries: {
-        regexp: RegExp;
-        name: string;
-        pattern: string;
-        description?: string;
-        svg?: string;
-        comments?: string;
-        examples?: string[];
-        urls?: string[];
-        category?: string;
-    }[];
-    referrers: {
-        regexp: RegExp;
-        name: string;
-        pattern: string;
-        description?: string;
-        svg?: string;
-        comments?: string;
-        examples?: string[];
-        urls?: string[];
-        category?: string;
-    }[];
 };
-export default _default;
+declare const UserAgentsV2: Record<OPAWGFileType, OPAWGPatternEntry[]>;
+export default UserAgentsV2;

package/dist/user-agents-v2/index.js

@@ -11,28 +11,38 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPAWGFileType = void 0;
 var apps = require("./apps.json");
 var bots = require("./bots.json");
 var browsers = require("./browsers.json");
 var devices = require("./devices.json");
 var libraries = require("./libraries.json");
 var referrers = require("./referrers.json");
+exports.OPAWGFileType = {
+    Apps: 'apps',
+    Bots: 'bots',
+    Browsers: 'browsers',
+    Devices: 'devices',
+    Libraries: 'libraries',
+    Referrers: 'referrers',
+};
 /**
  * Extract entries from User-Agent lists and create RegExp for patterns.
  * @param {OPAWGPatternsFile} file patterns file
  * @returns {OPAWGPatternEntry[]} array of entries with RegExps
  */
-function initializePatternFile(_a) {
+function initializePatternFile(type, _a) {
     var entries = _a.entries;
     return entries.map(function (entry) {
-        return __assign(__assign({}, entry), { regexp: new RegExp(entry.pattern) });
+        return __assign(__assign({}, entry), { type: type, regexp: new RegExp(entry.pattern) });
     });
 }
-exports.default = {
-    apps: initializePatternFile(apps),
-    bots: initializePatternFile(bots),
-    browsers: initializePatternFile(browsers),
-    devices: initializePatternFile(devices),
-    libraries: initializePatternFile(libraries),
-    referrers: initializePatternFile(referrers),
+var UserAgentsV2 = {
+    apps: initializePatternFile(exports.OPAWGFileType.Apps, apps),
+    bots: initializePatternFile(exports.OPAWGFileType.Bots, bots),
+    browsers: initializePatternFile(exports.OPAWGFileType.Browsers, browsers),
+    devices: initializePatternFile(exports.OPAWGFileType.Devices, devices),
+    libraries: initializePatternFile(exports.OPAWGFileType.Libraries, libraries),
+    referrers: initializePatternFile(exports.OPAWGFileType.Referrers, referrers),
 };
+exports.default = UserAgentsV2;

package/dist/user-agents-v2/patterns.d.ts

@@ -0,0 +1,53 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * Top-level file, containing a list of named entries, their associated regular expression patterns, and other properties
+ */
+export interface OPAWGPatternsFile {
+    /**
+     * Usage notes about this file.
+     */
+    comments?: string[];
+    /**
+     * Ordered list of named entries, their associated regular expression patterns, and other properties.
+     */
+    entries?: {
+        /**
+         * Name of this entry, must be unique within the file.
+         */
+        name: string;
+        /**
+         * Regular expression pattern identifying this entry. For max compatibility: avoid lookaheads or programming-language-specific character classes. Example: "^MyThing/"
+         */
+        pattern: string;
+        /**
+         * Optional summary description of this entry.
+         */
+        description?: string;
+        /**
+         * Optional associated icon filename as found in the svg directory. Example: "my-thing.svg"
+         */
+        svg?: string;
+        /**
+         * Optional notes about this entry.
+         */
+        comments?: string;
+        /**
+         * Optional examples found in the wild that this entry is intended to match against, useful for pattern development and automated testing.
+         */
+        examples?: string[];
+        /**
+         * One or more optional informational urls about this entry. Example: "https://my-thing.example.com"
+         */
+        urls?: string[];
+        /**
+         * Optional category for this entry, depends on the type of the containing entry file (e.g. "mobile" in the 'devices' file, or "app" in the 'referrers' file).
+         */
+        category?: string;
+        [k: string]: unknown;
+    }[];
+    [k: string]: unknown;
+}

package/dist/user-agents-v2/patterns.js

@@ -0,0 +1,8 @@
+"use strict";
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alitu/user-agents-v2-api",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "API for identifying User-Agent strings using OPAWG's user-agents-v2 lists.",
   "main": "dist/index.js",
   "repository": {