app-tracker 2.2.2 → 3.1.0

package/index.js

@@ -1,8 +1,9 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./main"));
-__export(require("./app-tracker.service"));
-__export(require("./log"));
+"use strict";
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./main"));
+__export(require("./app-tracker.service"));
+__export(require("./log"));
+__export(require("./version"));

package/log-privacy.d.ts

@@ -0,0 +1,2 @@
+export declare function sanitizeLogText(value: string): string;
+export declare function sanitizeLogValue(value: any, depth?: number, seen?: WeakSet<object>): any;

package/log-privacy.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const REDACTED = '[REDACTED]';
+const SENSITIVE_KEYS = new Set(['authorization', 'cookie', 'password', 'passwd', 'secret', 'token', 'apikey', 'email', 'emailaddress', 'phone', 'mobile', 'firstname', 'lastname', 'fullname', 'address', 'street', 'postcode', 'postalcode', 'ip', 'ipaddress', 'hostname', 'ident', 'userid', 'customerid', 'paymentid', 'sessionid', 'refreshtoken', 'accesstoken', 'recipient', 'recipients', 'username', 'displayname', 'birthdate', 'dateofbirth', 'dob', 'iban', 'bic', 'accountnumber', 'creditcard', 'cardnumber', 'coordinates', 'latitude', 'longitude']);
+const SECRET_KEY_PARTS = ['authorization', 'cookie', 'password', 'passwd', 'secret', 'token', 'apikey', 'credential', 'privatekey'];
+function isSensitiveKey(key) {
+    const normalizedKey = key.replace(/[^a-z0-9]/gi, '').toLowerCase();
+    return SENSITIVE_KEYS.has(normalizedKey) || SECRET_KEY_PARTS.some(part => normalizedKey.indexOf(part) >= 0);
+}
+function sanitizeLogUrl(value) {
+    let sanitizedUrl = '[REDACTED URL]';
+    try {
+        const url = new URL(value);
+        const identityRoutes = new Set(['users', 'customers', 'accounts', 'sessions', 'payments']);
+        const segments = url.pathname.split('/').map((segment, index, allSegments) => {
+            const followsIdentityRoute = index > 0 && identityRoutes.has(allSegments[index - 1].toLowerCase());
+            const isIdentifier = /^[0-9a-f]{24}$/i.test(segment) || /^[0-9a-f]{8}-[0-9a-f-]{27}$/i.test(segment) || /^(?:cus|pi|pm|seti|sub|cs|price|in|ch)_[A-Za-z0-9_]+$/.test(segment) || /^\d{6,}$/.test(segment);
+            return followsIdentityRoute || isIdentifier ? ':id' : segment;
+        });
+        sanitizedUrl = `${url.protocol}//${url.host}${segments.join('/')}`;
+    }
+    catch (_error) {
+        // Keep the privacy-safe fallback.
+    }
+    return sanitizedUrl;
+}
+function sanitizeLogText(value) {
+    return value
+        .replace(/https?:\/\/[^\s"'<>]+/gi, (url) => sanitizeLogUrl(url))
+        .replace(/\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,}\b/gi, REDACTED)
+        .replace(/\b(?:\d{1,3}\.){3}\d{1,3}\b/g, REDACTED)
+        .replace(/\b[A-Z]{2}\d{2}[A-Z0-9]{11,30}\b/g, REDACTED)
+        .replace(/\+\d[\d\s().-]{7,}\d/g, REDACTED)
+        .replace(/[A-Z]:\\Users\\[^\\\s]+/gi, REDACTED)
+        .replace(/\/home\/[^/\s]+/g, REDACTED)
+        .replace(/\b(?:Bearer|Basic)\s+[A-Za-z0-9._~+\/-]+=*/gi, REDACTED)
+        .replace(/\beyJ[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\b/g, REDACTED);
+}
+exports.sanitizeLogText = sanitizeLogText;
+function sanitizeLogValue(value, depth = 0, seen = new WeakSet()) {
+    if (typeof value === 'string')
+        return sanitizeLogText(value);
+    if (value === null || typeof value === 'undefined' || typeof value === 'number' || typeof value === 'boolean' || typeof value === 'bigint')
+        return value;
+    if (depth >= 6)
+        return '[TRUNCATED]';
+    if (value instanceof Date)
+        return value.toISOString();
+    if (value instanceof Error)
+        return Object.assign({ name: sanitizeLogText(value.name), message: sanitizeLogText(value.message) }, (typeof value.stack === 'string' ? { stack: sanitizeLogText(value.stack) } : {}));
+    if (typeof value === 'object') {
+        if (seen.has(value))
+            return '[Circular]';
+        seen.add(value);
+        if (Array.isArray(value))
+            return value.map(item => sanitizeLogValue(item, depth + 1, seen));
+        const result = {};
+        Object.keys(value).forEach(key => result[key] = isSensitiveKey(key) ? REDACTED : sanitizeLogValue(value[key], depth + 1, seen));
+        return result;
+    }
+    return `[${typeof value}]`;
+}
+exports.sanitizeLogValue = sanitizeLogValue;

package/log.d.ts

@@ -1,32 +1,31 @@
-export declare class AppTrackerConfig {
-    /** Should logs in the development environment be sent to the server. For Node enviroment process.env.NODE_ENV must be set to 'development' */
-    sendLogsInDevelopment?: boolean;
-    logInConsole?: boolean;
-    endpointUrl?: string;
-    maxSendTries?: number;
-    maxLogsCount?: number;
-    /** Defines which log types should be sent to the server */
-    logLevel?: LogType[];
-    sendLogsByTypesImmediately?: LogType[];
-    /**
-     * Please pass:
-     * Web -> navigator.userAgent,
-     * Node -> os (from require('os'))
-     */
-    userAgentOrOs: any;
-}
-export declare class Log {
-    logType: LogType;
-    message: any;
-    optionalParams: any[];
-    createdAt: Date;
-    ident: string;
-}
-export declare enum LogType {
-    debug = 0,
-    info = 1,
-    log = 2,
-    warn = 3,
-    error = 4,
-    critical = 5
-}
+export declare class AppTrackerConfig {
+    /** Should logs in the development environment be sent to the server. For Node enviroment process.env.NODE_ENV must be set to 'development' */
+    sendLogsInDevelopment?: boolean;
+    logInConsole?: boolean;
+    endpointUrl?: string;
+    maxSendTries?: number;
+    /** Delay between send attempts. */
+    retryDelayMs?: number;
+    /** Maximum duration of a single request before it is aborted. */
+    requestTimeoutMs?: number;
+    maxLogsCount?: number;
+    /** Defines which log types should be sent to the server */
+    logLevel?: LogType[];
+    sendLogsByTypesImmediately?: LogType[];
+    /** Used only to derive coarse browser/OS categories; raw values are not transmitted. */
+    userAgentOrOs?: any;
+}
+export declare class Log {
+    logType: LogType;
+    message: any;
+    optionalParams: any[];
+    createdAt: Date;
+}
+export declare enum LogType {
+    debug = 0,
+    info = 1,
+    log = 2,
+    warn = 3,
+    error = 4,
+    critical = 5
+}

package/log.js

@@ -1,27 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class AppTrackerConfig {
-    constructor() {
-        this.maxLogsCount = 5;
-        this.sendLogsByTypesImmediately = [LogType.error];
-    }
-}
-exports.AppTrackerConfig = AppTrackerConfig;
-class Log {
-    constructor() {
-        this.logType = LogType.log;
-        this.optionalParams = [];
-        this.createdAt = new Date();
-        this.ident = '';
-    }
-}
-exports.Log = Log;
-var LogType;
-(function (LogType) {
-    LogType[LogType["debug"] = 0] = "debug";
-    LogType[LogType["info"] = 1] = "info";
-    LogType[LogType["log"] = 2] = "log";
-    LogType[LogType["warn"] = 3] = "warn";
-    LogType[LogType["error"] = 4] = "error";
-    LogType[LogType["critical"] = 5] = "critical";
-})(LogType = exports.LogType || (exports.LogType = {}));
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class AppTrackerConfig {
+    constructor() {
+        /** Delay between send attempts. */
+        this.retryDelayMs = 10000;
+        /** Maximum duration of a single request before it is aborted. */
+        this.requestTimeoutMs = 10000;
+        this.maxLogsCount = 5;
+        this.sendLogsByTypesImmediately = [LogType.error];
+    }
+}
+exports.AppTrackerConfig = AppTrackerConfig;
+class Log {
+    constructor() {
+        this.logType = LogType.log;
+        this.optionalParams = [];
+        this.createdAt = new Date();
+    }
+}
+exports.Log = Log;
+var LogType;
+(function (LogType) {
+    LogType[LogType["debug"] = 0] = "debug";
+    LogType[LogType["info"] = 1] = "info";
+    LogType[LogType["log"] = 2] = "log";
+    LogType[LogType["warn"] = 3] = "warn";
+    LogType[LogType["error"] = 4] = "error";
+    LogType[LogType["critical"] = 5] = "critical";
+})(LogType = exports.LogType || (exports.LogType = {}));

package/main.d.ts

@@ -1,8 +1,8 @@
-import { AppTrackerService } from './app-tracker.service';
-import { AppTrackerConfig } from './log';
-export declare class AppTracker {
-    private static _service;
-    private static get service();
-    static init(apiKey: string, config?: AppTrackerConfig): AppTrackerService;
-    static getService(): AppTrackerService;
-}
+import { AppTrackerService } from './app-tracker.service';
+import { AppTrackerConfig } from './log';
+export declare class AppTracker {
+    private static _service;
+    private static get service();
+    static init(apiKey: string, config?: AppTrackerConfig): AppTrackerService;
+    static getService(): AppTrackerService;
+}

package/main.js

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const app_tracker_service_1 = require("./app-tracker.service");
-class AppTracker {
-    static get service() {
-        if (!this._service)
-            this._service = new app_tracker_service_1.AppTrackerService();
-        return this._service;
-    }
-    static init(apiKey, config) {
-        AppTracker.service.init(apiKey, config);
-        return AppTracker.service;
-    }
-    static getService() {
-        return AppTracker.service;
-    }
-}
-exports.AppTracker = AppTracker;
-AppTracker._service = null;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_tracker_service_1 = require("./app-tracker.service");
+class AppTracker {
+    static get service() {
+        if (!this._service)
+            this._service = new app_tracker_service_1.AppTrackerService();
+        return this._service;
+    }
+    static init(apiKey, config) {
+        AppTracker.service.init(apiKey, config);
+        return AppTracker.service;
+    }
+    static getService() {
+        return AppTracker.service;
+    }
+}
+exports.AppTracker = AppTracker;
+AppTracker._service = null;

package/package.json

@@ -1,46 +1,54 @@
-{
-    "name": "app-tracker",
-    "version": "2.2.2",
-    "description": "App Tracker for Web-Applications",
-    "main": "index.js",
-    "scripts": {
-        "build": "tsc && npm run copyFile",
-        "copyFile": "xcopy package.json lib && xcopy README.md lib",
-        "terser": "terser lib/main.js -c -m -o lib/main.js && terser lib/log.js -c -m -o lib/log.js && terser lib/app-tracker.service.js -c -m -o lib/app-tracker.service.js",
-        "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-        "lint": "tslint -p tsconfig.json"
-    },
-    "keywords": [
-        "logging",
-        "protocol",
-        "event logging",
-        "monitoring",
-        "tracking",
-        "recording",
-        "debugging",
-        "iroubleshooting",
-        "user activity",
-        "data analysis",
-        "system events",
-        "performance monitoring",
-        "processing",
-        "archiving",
-        "alerting",
-        "notification",
-        "integration",
-        "interfaces"
-    ],
-    "author": "Wigtertainment Ltd",
-    "license": "ISC",
-    "devDependencies": {
-        "@types/node": "^17.0.10",
-        "parcel": "^2.7.0",
-        "prettier": "^1.19.1",
-        "tslint": "^5.20.1",
-        "tslint-config-prettier": "^1.18.0",
-        "typescript": "^3.7.3"
-    },
-    "dependencies": {
-        "cross-fetch": "^3.1.5"
-    }
-}
+{
+    "name": "app-tracker",
+    "version": "3.1.0",
+    "description": "App Tracker for Web-Applications",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Wigtertainment-Ltd/App-Tracker-PKG.git"
+    },
+    "scripts": {
+        "build": "tsc && npm run copyFile",
+        "copyFile": "node scripts/copy-package-files.js",
+        "terser": "terser lib/main.js -c -m -o lib/main.js && terser lib/log.js -c -m -o lib/log.js && terser lib/app-tracker.service.js -c -m -o lib/app-tracker.service.js",
+        "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+        "lint": "tslint -p tsconfig.json",
+        "test": "npm run build && node test/logging.integration.js && node test/browser-build.js"
+    },
+    "keywords": [
+        "logging",
+        "protocol",
+        "event logging",
+        "monitoring",
+        "tracking",
+        "recording",
+        "debugging",
+        "iroubleshooting",
+        "user activity",
+        "data analysis",
+        "system events",
+        "performance monitoring",
+        "processing",
+        "archiving",
+        "alerting",
+        "notification",
+        "integration",
+        "interfaces"
+    ],
+    "author": "Wigtertainment Ltd",
+    "license": "ISC",
+    "engines": {
+        "node": ">=16"
+    },
+    "devDependencies": {
+        "@types/node": "^17.0.10",
+        "parcel": "^2.7.0",
+        "prettier": "^1.19.1",
+        "tslint": "^5.20.1",
+        "tslint-config-prettier": "^1.18.0",
+        "typescript": "^3.7.3"
+    },
+    "dependencies": {
+        "cross-fetch": "^3.1.5"
+    }
+}

package/version.d.ts

@@ -0,0 +1,2 @@
+/** Replaced with the package.json version by the build script. */
+export declare const APP_TRACKER_VERSION: string;

package/version.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** Replaced with the package.json version by the build script. */
+exports.APP_TRACKER_VERSION = '3.1.0';