@wtasnorg/node-lib 0.0.6 → 0.0.8

package/src/find.ts

@@ -1,15 +1,15 @@
 import { resolve, join } from "node:path";
 
 interface FileSystemDependencies {
-    readdir: (path: string, opts: { withFileTypes: true }) => Promise<{ name: string; isDirectory(): boolean; }[]>;
-    stat: (path: string) => Promise<{ isDirectory(): boolean }>;
+    readdir: (_path: string, _opts: { withFileTypes: true }) => Promise<{ name: string; isDirectory(): boolean; }[]>;
+    stat: (_path: string) => Promise<{ isDirectory(): boolean }>;
 }
 
 interface FindDirectoriesOptions {
     maxDepth?: number;
     followSymlinks?: boolean;
-    allowlist?: string[] | ((absPath: string, name: string) => boolean);
-    blocklist?: string[] | ((absPath: string, name: string) => boolean);
+    allowlist?: string[] | ((_absPath: string, _name: string) => boolean);
+    blocklist?: string[] | ((_absPath: string, _name: string) => boolean);
 }
 
 /**
@@ -38,7 +38,7 @@ function createFindDirectories(deps: FileSystemDependencies) {
         function isAllowed(absPath: string, name: string): boolean {
             if (allowlist) {
                 if (Array.isArray(allowlist)) {
-                    if (!allowlist.includes(name)) return false;
+                    if (!allowlist.includes(name)) { return false; }
                 } else if (!allowlist(absPath, name)) {
                     return false;
                 }
@@ -49,7 +49,7 @@ function createFindDirectories(deps: FileSystemDependencies) {
         function isBlocked(absPath: string, name: string): boolean {
             if (blocklist) {
                 if (Array.isArray(blocklist)) {
-                    if (blocklist.includes(name)) return true;
+                    if (blocklist.includes(name)) { return true; }
                 } else if (blocklist(absPath, name)) {
                     return true;
                 }
@@ -58,19 +58,19 @@ function createFindDirectories(deps: FileSystemDependencies) {
         }
 
         async function walk(currentPath: string, depth: number): Promise<void> {
-            if (depth > maxDepth) return;
+            if (depth > maxDepth) { return; }
 
             const entries = await readdir(currentPath, { withFileTypes: true });
 
             for (const entry of entries) {
                 const childPath = resolve(join(currentPath, entry.name));
 
-                let isDirectory = entry.isDirectory();
+                const isDirectory = entry.isDirectory();
 
-                if (!isDirectory) continue;
+                if (!isDirectory) { continue; }
 
-                if (isBlocked(childPath, entry.name)) continue;
-                if (!isAllowed(childPath, entry.name)) continue;
+                if (isBlocked(childPath, entry.name)) { continue; }
+                if (!isAllowed(childPath, entry.name)) { continue; }
 
                 results.push(childPath);
 
@@ -91,9 +91,9 @@ function createFindDirectories(deps: FileSystemDependencies) {
 
 export {
     createFindDirectories,
-}
+};
 
 export type {
     FileSystemDependencies,
     FindDirectoriesOptions,
-}
+};

package/src/index.d.ts

@@ -2,6 +2,8 @@ import { hello } from "./hello.js";
 import { pojo } from "./pojo.js";
 import type { FindDirectoriesOptions, FileSystemDependencies } from "./find.js";
 import { createFindDirectories } from "./find.js";
-export { hello, pojo, createFindDirectories };
-export type { FindDirectoriesOptions, FileSystemDependencies, };
+import type { UserAgentInfo } from "./user-agent.js";
+import { parseUserAgent } from "./user-agent.js";
+export { hello, pojo, createFindDirectories, parseUserAgent };
+export type { FindDirectoriesOptions, FileSystemDependencies, UserAgentInfo, };
 //# sourceMappingURL=index.d.ts.map

package/src/index.js

@@ -1,5 +1,6 @@
 import { hello } from "./hello.js";
 import { pojo } from "./pojo.js";
 import { createFindDirectories } from "./find.js";
-export { hello, pojo, createFindDirectories };
+import { parseUserAgent } from "./user-agent.js";
+export { hello, pojo, createFindDirectories, parseUserAgent };
 //# sourceMappingURL=index.js.map

package/src/index.ts

@@ -2,14 +2,18 @@ import { hello } from "./hello.js";
 import { pojo } from "./pojo.js";
 import type { FindDirectoriesOptions, FileSystemDependencies } from "./find.js";
 import { createFindDirectories } from "./find.js";
+import type { UserAgentInfo } from "./user-agent.js";
+import { parseUserAgent } from "./user-agent.js";
 
 export {
     hello,
     pojo,
-    createFindDirectories
+    createFindDirectories,
+    parseUserAgent
 };
 
 export type {
     FindDirectoriesOptions,
     FileSystemDependencies,
-}
+    UserAgentInfo,
+};

package/src/pojo.d.ts

@@ -5,8 +5,8 @@
  *
  * @template T
  * @param {T} instance - A class instance to convert.
- * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ * @returns {Object<string, unknown>} A plain JavaScript object containing only data fields.
  */
-declare function pojo<T extends object>(instance: T): Record<string, any>;
+declare function pojo<T extends object>(instance: T): Record<string, unknown>;
 export { pojo };
 //# sourceMappingURL=pojo.d.ts.map

package/src/pojo.js

@@ -5,10 +5,10 @@
  *
  * @template T
  * @param {T} instance - A class instance to convert.
- * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ * @returns {Object<string, unknown>} A plain JavaScript object containing only data fields.
  */
 function pojo(instance) {
-    return Object.fromEntries(Object.entries(instance).filter(([_, value]) => typeof value !== "function"));
+    return Object.fromEntries(Object.entries(instance).filter((entry) => typeof entry[1] !== "function"));
 }
 export { pojo };
 //# sourceMappingURL=pojo.js.map

package/src/pojo.test.js

@@ -28,9 +28,7 @@ test("pojo() should exclude methods", () => {
 test("pojo() should exclude prototype properties", () => {
     class Product {
         id;
-        constructor(id) {
-            this.id = id;
-        }
+        constructor(id) { this.id = id; }
         get info() {
             return `Product:${this.id}`;
         }

package/src/pojo.test.ts

@@ -35,7 +35,8 @@ test("pojo() should exclude methods", () => {
 
 test("pojo() should exclude prototype properties", () => {
     class Product {
-        constructor(public id: number) { }
+        id: number;
+        constructor(id: number) { this.id = id; }
 
         get info() {
             return `Product:${this.id}`;

package/src/pojo.ts

@@ -5,11 +5,11 @@
  *
  * @template T
  * @param {T} instance - A class instance to convert.
- * @returns {Object<string, any>} A plain JavaScript object containing only data fields.
+ * @returns {Object<string, unknown>} A plain JavaScript object containing only data fields.
  */
-function pojo<T extends object>(instance: T): Record<string, any> {
+function pojo<T extends object>(instance: T): Record<string, unknown> {
     return Object.fromEntries(
-        Object.entries(instance).filter(([_, value]) => typeof value !== "function")
+        Object.entries(instance).filter((entry) => typeof entry[1] !== "function")
     );
 }
 

package/src/user-agent.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Information extracted from a user-agent string.
+ */
+export interface UserAgentInfo {
+    /**
+     * Browser name (e.g., Chrome, Firefox, Safari, Edge, Opera, Other).
+     */
+    browser: string;
+    /**
+     * Browser version (e.g., 120.0.0.0).
+     */
+    version: string;
+    /**
+     * Operating system (e.g., Windows, macOS, Linux, iOS, Android, Other).
+     */
+    os: string;
+    /**
+     * Device type (e.g., Mobile, Tablet, Desktop, Other).
+     */
+    device: string;
+    /**
+     * Rendering engine (e.g., Blink, WebKit, Gecko, Presto, Other).
+     */
+    engine: string;
+}
+/**
+ * Parses a user-agent string into a UserAgentInfo object.
+ *
+ * @param ua - The user-agent string to parse.
+ * @returns An object containing the extracted information.
+ *
+ * @example
+ * ```typescript
+ * // Success Example (Chrome on Windows)
+ * const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
+ * const info = parseUserAgent(ua);
+ * // { browser: "Chrome", version: "120.0.0.0", os: "Windows", device: "Desktop", engine: "Blink" }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Error/Fallback Example (Empty string)
+ * const info = parseUserAgent("");
+ * // { browser: "Other", version: "0", os: "Other", device: "Desktop", engine: "Other" }
+ * ```
+ */
+export declare function parseUserAgent(ua: string): UserAgentInfo;
+//# sourceMappingURL=user-agent.d.ts.map

package/src/user-agent.js

@@ -0,0 +1,189 @@
+/**
+ * Parses a user-agent string into a UserAgentInfo object.
+ *
+ * @param ua - The user-agent string to parse.
+ * @returns An object containing the extracted information.
+ *
+ * @example
+ * ```typescript
+ * // Success Example (Chrome on Windows)
+ * const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
+ * const info = parseUserAgent(ua);
+ * // { browser: "Chrome", version: "120.0.0.0", os: "Windows", device: "Desktop", engine: "Blink" }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Error/Fallback Example (Empty string)
+ * const info = parseUserAgent("");
+ * // { browser: "Other", version: "0", os: "Other", device: "Desktop", engine: "Other" }
+ * ```
+ */
+export function parseUserAgent(ua) {
+    if (!ua) {
+        return {
+            browser: "Other",
+            version: "0",
+            os: "Other",
+            device: "Desktop",
+            engine: "Other",
+        };
+    }
+    const browserInfo = detectBrowser(ua);
+    return {
+        browser: browserInfo.name,
+        version: browserInfo.version,
+        os: detectOS(ua),
+        device: detectDeviceType(ua),
+        engine: detectEngine(ua),
+    };
+}
+/**
+ * Detects the browser name and version from a user-agent string.
+ *
+ * @param ua - The user-agent string.
+ * @returns An object with name and version.
+ *
+ * @example
+ * ```typescript
+ * // Success Example
+ * detectBrowser("Mozilla/5.0 ... Firefox/121.0");
+ * // { name: "Firefox", version: "121.0" }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Error/Fallback Example
+ * detectBrowser("UnknownBot/1.0");
+ * // { name: "Other", version: "0" }
+ * ```
+ */
+function detectBrowser(ua) {
+    let name = "Other";
+    let version = "0";
+    if (ua.includes("Edg/")) {
+        name = "Edge";
+        version = ua.split("Edg/")[1]?.split(" ")[0] || "0";
+    }
+    else if (ua.includes("Chrome/") && !ua.includes("Chromium/")) {
+        name = "Chrome";
+        version = ua.split("Chrome/")[1]?.split(" ")[0] || "0";
+    }
+    else if (ua.includes("Safari/") && !ua.includes("Chrome/")) {
+        name = "Safari";
+        version = ua.split("Version/")[1]?.split(" ")[0] || ua.split("Safari/")[1]?.split(" ")[0] || "0";
+    }
+    else if (ua.includes("Firefox/")) {
+        name = "Firefox";
+        version = ua.split("Firefox/")[1]?.split(" ")[0] || "0";
+    }
+    else if (ua.includes("OPR/") || ua.includes("Opera/")) {
+        name = "Opera";
+        version = (ua.split("OPR/")[1] || ua.split("Opera/")[1])?.split(" ")[0] || "0";
+    }
+    return { name, version };
+}
+/**
+ * Detects the operating system from a user-agent string.
+ *
+ * @param ua - The user-agent string.
+ * @returns The operating system name.
+ *
+ * @example
+ * ```typescript
+ * // Success Example
+ * detectOS("Mozilla/5.0 (iPhone; ...)");
+ * // "iOS"
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Error/Fallback Example
+ * detectOS("Custom OS");
+ * // "Other"
+ * ```
+ */
+function detectOS(ua) {
+    if (ua.includes("iPhone") || ua.includes("iPad") || ua.includes("iPod")) {
+        return "iOS";
+    }
+    if (ua.includes("Windows")) {
+        return "Windows";
+    }
+    if (ua.includes("Mac OS X")) {
+        return "macOS";
+    }
+    if (ua.includes("Android")) {
+        return "Android";
+    }
+    if (ua.includes("Linux")) {
+        return "Linux";
+    }
+    return "Other";
+}
+/**
+ * Detects the device type (Desktop, Mobile, Tablet) from a user-agent string.
+ *
+ * @param ua - The user-agent string.
+ * @returns The device type.
+ *
+ * @example
+ * ```typescript
+ * // Success Example
+ * detectDeviceType("Mozilla/5.0 (iPad; ...)");
+ * // "Tablet"
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Error/Fallback Example
+ * detectDeviceType("Generic Browser");
+ * // "Desktop"
+ * ```
+ */
+function detectDeviceType(ua) {
+    if (ua.includes("iPad") || (ua.includes("Android") && !ua.includes("Mobile"))) {
+        return "Tablet";
+    }
+    if (ua.includes("Mobi")) {
+        return "Mobile";
+    }
+    return "Desktop";
+}
+/**
+ * Detects the rendering engine from a user-agent string.
+ *
+ * @param ua - The user-agent string.
+ * @returns The engine name.
+ *
+ * @example
+ * ```typescript
+ * // Success Example
+ * detectEngine("Mozilla/5.0 ... AppleWebKit/537.36 ...");
+ * // "Blink"
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Error/Fallback Example
+ * detectEngine("Unknown Engine");
+ * // "Other"
+ * ```
+ */
+function detectEngine(ua) {
+    // Blink check must come first: Chrome/Chromium browsers use AppleWebKit but are Blink-based
+    if (ua.includes("Chrome/") && ua.includes("AppleWebKit/")) {
+        return "Blink";
+    }
+    if (ua.includes("AppleWebKit")) {
+        return "WebKit";
+    }
+    if (ua.includes("Gecko/")) {
+        return "Gecko";
+    }
+    if (ua.includes("Presto/")) {
+        return "Presto";
+    }
+    return "Other";
+}
+//# sourceMappingURL=user-agent.js.map

package/src/user-agent.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-agent.test.d.ts.map

package/src/user-agent.test.js

@@ -0,0 +1,54 @@
+import { test } from "node:test";
+import assert from "node:assert";
+import { parseUserAgent } from "./user-agent.js";
+test("parseUserAgent - Chrome on Windows", () => {
+    const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Chrome");
+    assert.strictEqual(info.os, "Windows");
+    assert.strictEqual(info.device, "Desktop");
+    assert.strictEqual(info.version, "120.0.0.0");
+});
+test("parseUserAgent - Firefox on macOS", () => {
+    const ua = "Mozilla/5.0 (Macintosh; Intel Mac OS X 14.2; rv:121.0) Gecko/20100101 Firefox/121.0";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Firefox");
+    assert.strictEqual(info.os, "macOS");
+    assert.strictEqual(info.version, "121.0");
+    assert.strictEqual(info.engine, "Gecko");
+});
+test("parseUserAgent - Safari on iPhone", () => {
+    const ua = "Mozilla/5.0 (iPhone; CPU iPhone OS 17_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Mobile/15E148 Safari/604.1";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Safari");
+    assert.strictEqual(info.os, "iOS");
+    assert.strictEqual(info.device, "Mobile");
+    assert.strictEqual(info.version, "17.2");
+});
+test("parseUserAgent - Edge on Windows", () => {
+    const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 Edg/120.0.0.0";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Edge");
+    assert.strictEqual(info.os, "Windows");
+    assert.strictEqual(info.version, "120.0.0.0");
+});
+test("parseUserAgent - Chrome on Android (Mobile)", () => {
+    const ua = "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Mobile Safari/537.36";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Chrome");
+    assert.strictEqual(info.os, "Android");
+    assert.strictEqual(info.device, "Mobile");
+});
+test("parseUserAgent - Android Tablet", () => {
+    const ua = "Mozilla/5.0 (Linux; Android 10; SM-T510) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Chrome");
+    assert.strictEqual(info.os, "Android");
+    assert.strictEqual(info.device, "Tablet");
+});
+test("parseUserAgent - Empty/Null UA", () => {
+    const info = parseUserAgent("");
+    assert.strictEqual(info.browser, "Other");
+    assert.strictEqual(info.device, "Desktop");
+});
+//# sourceMappingURL=user-agent.test.js.map

package/src/user-agent.test.ts

@@ -0,0 +1,60 @@
+import { test } from "node:test";
+import assert from "node:assert";
+import { parseUserAgent } from "./user-agent.js";
+
+test("parseUserAgent - Chrome on Windows", () => {
+    const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Chrome");
+    assert.strictEqual(info.os, "Windows");
+    assert.strictEqual(info.device, "Desktop");
+    assert.strictEqual(info.version, "120.0.0.0");
+});
+
+test("parseUserAgent - Firefox on macOS", () => {
+    const ua = "Mozilla/5.0 (Macintosh; Intel Mac OS X 14.2; rv:121.0) Gecko/20100101 Firefox/121.0";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Firefox");
+    assert.strictEqual(info.os, "macOS");
+    assert.strictEqual(info.version, "121.0");
+    assert.strictEqual(info.engine, "Gecko");
+});
+
+test("parseUserAgent - Safari on iPhone", () => {
+    const ua = "Mozilla/5.0 (iPhone; CPU iPhone OS 17_2 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/17.2 Mobile/15E148 Safari/604.1";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Safari");
+    assert.strictEqual(info.os, "iOS");
+    assert.strictEqual(info.device, "Mobile");
+    assert.strictEqual(info.version, "17.2");
+});
+
+test("parseUserAgent - Edge on Windows", () => {
+    const ua = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36 Edg/120.0.0.0";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Edge");
+    assert.strictEqual(info.os, "Windows");
+    assert.strictEqual(info.version, "120.0.0.0");
+});
+
+test("parseUserAgent - Chrome on Android (Mobile)", () => {
+    const ua = "Mozilla/5.0 (Linux; Android 10; K) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Mobile Safari/537.36";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Chrome");
+    assert.strictEqual(info.os, "Android");
+    assert.strictEqual(info.device, "Mobile");
+});
+
+test("parseUserAgent - Android Tablet", () => {
+    const ua = "Mozilla/5.0 (Linux; Android 10; SM-T510) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36";
+    const info = parseUserAgent(ua);
+    assert.strictEqual(info.browser, "Chrome");
+    assert.strictEqual(info.os, "Android");
+    assert.strictEqual(info.device, "Tablet");
+});
+
+test("parseUserAgent - Empty/Null UA", () => {
+    const info = parseUserAgent("");
+    assert.strictEqual(info.browser, "Other");
+    assert.strictEqual(info.device, "Desktop");
+});