@etsoo/shared 1.2.22 → 1.2.24

package/__tests__/DomUtils.ts

@@ -326,3 +326,15 @@ test('Tests for getInputValue', () => {
         expect(result.getDate()).toBe(21);
     }
 });
+
+test('Tests for setupLogging', () => {
+    // Arrange
+    const action = jest.fn();
+    DomUtils.setupLogging(action, true);
+
+    // Act
+    console.error('Test');
+
+    // Assert
+    expect(action).toHaveBeenCalledTimes(1);
+});

package/lib/cjs/DomUtils.d.ts

@@ -1,5 +1,6 @@
 /// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
+import { ErrorData, ErrorType } from './types/ErrorData';
 import { FormDataFieldValue, IFormData } from './types/FormData';
 /**
  * Dom Utilities
@@ -149,6 +150,12 @@ export declare namespace DomUtils {
      * @param container Container, limits the element range
      */
     function setFocus(name: string | object, container?: HTMLElement): void;
+    /**
+     * Setup logging
+     * @param action Logging action
+     * @param preventDefault Is prevent default action
+     */
+    function setupLogging(action: (data: ErrorData) => void | Promise<void>, preventDefault?: ((type: ErrorType) => boolean) | boolean): void;
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/lib/cjs/DomUtils.js

@@ -4,6 +4,7 @@ exports.DomUtils = void 0;
 /// <reference lib="dom" />
 const DataTypes_1 = require("./DataTypes");
 const DateUtils_1 = require("./DateUtils");
+const Utils_1 = require("./Utils");
 if (typeof navigator === 'undefined') {
     // Test mock only
     global.navigator = { language: 'en-US' };
@@ -498,6 +499,93 @@ var DomUtils;
             element.focus();
     }
     DomUtils.setFocus = setFocus;
+    /**
+     * Setup logging
+     * @param action Logging action
+     * @param preventDefault Is prevent default action
+     */
+    function setupLogging(action, preventDefault) {
+        var _a, _b;
+        // Avoid multiple setup, if there is already a handler, please set "globalThis.onunhandledrejection = null" first
+        if (globalThis.onunhandledrejection)
+            return;
+        const errorPD = (_a = Utils_1.Utils.getResult(preventDefault, 'error')) !== null && _a !== void 0 ? _a : true;
+        globalThis.onerror = (message, source, lineNo, colNo, error) => {
+            var _a;
+            // Default source
+            source || (source = globalThis.location.href);
+            let data;
+            if (typeof message === 'string') {
+                data = {
+                    type: 'error',
+                    message, // Share the same message with error
+                    source,
+                    lineNo,
+                    colNo,
+                    stack: error === null || error === void 0 ? void 0 : error.stack
+                };
+            }
+            else {
+                data = {
+                    type: 'error',
+                    eventType: message.type,
+                    message: (_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : `${message.currentTarget} event error`,
+                    source,
+                    lineNo,
+                    colNo,
+                    stack: error === null || error === void 0 ? void 0 : error.stack
+                };
+            }
+            action(data);
+            // Return true to suppress error alert
+            return errorPD;
+        };
+        const rejectionPD = (_b = Utils_1.Utils.getResult(preventDefault, 'error')) !== null && _b !== void 0 ? _b : true;
+        globalThis.onunhandledrejection = (event) => {
+            if (rejectionPD)
+                event.preventDefault();
+            const reason = event.reason;
+            const data = {
+                type: 'unhandledrejection',
+                eventType: event.type,
+                message: typeof reason === 'string'
+                    ? reason
+                    : JSON.stringify(reason),
+                source: globalThis.location.href
+            };
+            action(data);
+        };
+        const localConsole = (type, orgin) => {
+            var _a;
+            const consolePD = (_a = Utils_1.Utils.getResult(preventDefault, type)) !== null && _a !== void 0 ? _a : false;
+            return (...args) => {
+                // Keep original action
+                if (!consolePD)
+                    orgin(...args);
+                const [first, ...rest] = args;
+                let message;
+                if (typeof first === 'string') {
+                    message = first;
+                }
+                else {
+                    message = JSON.stringify(first);
+                }
+                const stack = rest.length > 0
+                    ? rest.map((item) => JSON.stringify(item)).join(', ')
+                    : undefined;
+                const data = {
+                    type,
+                    message,
+                    source: globalThis.location.href,
+                    stack
+                };
+                action(data);
+            };
+        };
+        globalThis.console.warn = localConsole('consoleWarn', globalThis.console.warn);
+        globalThis.console.error = localConsole('consoleError', globalThis.console.error);
+    }
+    DomUtils.setupLogging = setupLogging;
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/lib/cjs/types/ErrorData.d.ts

@@ -0,0 +1,10 @@
+export type ErrorType = 'error' | 'unhandledrejection' | 'consoleWarn' | 'consoleError';
+export type ErrorData = {
+    type: ErrorType;
+    eventType?: string;
+    message: string;
+    source?: string;
+    lineNo?: number;
+    colNo?: number;
+    stack?: string;
+};

package/lib/cjs/types/ErrorData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/mjs/DomUtils.d.ts

@@ -1,5 +1,6 @@
 /// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
+import { ErrorData, ErrorType } from './types/ErrorData';
 import { FormDataFieldValue, IFormData } from './types/FormData';
 /**
  * Dom Utilities
@@ -149,6 +150,12 @@ export declare namespace DomUtils {
      * @param container Container, limits the element range
      */
     function setFocus(name: string | object, container?: HTMLElement): void;
+    /**
+     * Setup logging
+     * @param action Logging action
+     * @param preventDefault Is prevent default action
+     */
+    function setupLogging(action: (data: ErrorData) => void | Promise<void>, preventDefault?: ((type: ErrorType) => boolean) | boolean): void;
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/lib/mjs/DomUtils.js

@@ -1,6 +1,7 @@
 /// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
 import { DateUtils } from './DateUtils';
+import { Utils } from './Utils';
 if (typeof navigator === 'undefined') {
     // Test mock only
     global.navigator = { language: 'en-US' };
@@ -495,6 +496,93 @@ export var DomUtils;
             element.focus();
     }
     DomUtils.setFocus = setFocus;
+    /**
+     * Setup logging
+     * @param action Logging action
+     * @param preventDefault Is prevent default action
+     */
+    function setupLogging(action, preventDefault) {
+        var _a, _b;
+        // Avoid multiple setup, if there is already a handler, please set "globalThis.onunhandledrejection = null" first
+        if (globalThis.onunhandledrejection)
+            return;
+        const errorPD = (_a = Utils.getResult(preventDefault, 'error')) !== null && _a !== void 0 ? _a : true;
+        globalThis.onerror = (message, source, lineNo, colNo, error) => {
+            var _a;
+            // Default source
+            source || (source = globalThis.location.href);
+            let data;
+            if (typeof message === 'string') {
+                data = {
+                    type: 'error',
+                    message, // Share the same message with error
+                    source,
+                    lineNo,
+                    colNo,
+                    stack: error === null || error === void 0 ? void 0 : error.stack
+                };
+            }
+            else {
+                data = {
+                    type: 'error',
+                    eventType: message.type,
+                    message: (_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : `${message.currentTarget} event error`,
+                    source,
+                    lineNo,
+                    colNo,
+                    stack: error === null || error === void 0 ? void 0 : error.stack
+                };
+            }
+            action(data);
+            // Return true to suppress error alert
+            return errorPD;
+        };
+        const rejectionPD = (_b = Utils.getResult(preventDefault, 'error')) !== null && _b !== void 0 ? _b : true;
+        globalThis.onunhandledrejection = (event) => {
+            if (rejectionPD)
+                event.preventDefault();
+            const reason = event.reason;
+            const data = {
+                type: 'unhandledrejection',
+                eventType: event.type,
+                message: typeof reason === 'string'
+                    ? reason
+                    : JSON.stringify(reason),
+                source: globalThis.location.href
+            };
+            action(data);
+        };
+        const localConsole = (type, orgin) => {
+            var _a;
+            const consolePD = (_a = Utils.getResult(preventDefault, type)) !== null && _a !== void 0 ? _a : false;
+            return (...args) => {
+                // Keep original action
+                if (!consolePD)
+                    orgin(...args);
+                const [first, ...rest] = args;
+                let message;
+                if (typeof first === 'string') {
+                    message = first;
+                }
+                else {
+                    message = JSON.stringify(first);
+                }
+                const stack = rest.length > 0
+                    ? rest.map((item) => JSON.stringify(item)).join(', ')
+                    : undefined;
+                const data = {
+                    type,
+                    message,
+                    source: globalThis.location.href,
+                    stack
+                };
+                action(data);
+            };
+        };
+        globalThis.console.warn = localConsole('consoleWarn', globalThis.console.warn);
+        globalThis.console.error = localConsole('consoleError', globalThis.console.error);
+    }
+    DomUtils.setupLogging = setupLogging;
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/lib/mjs/types/ErrorData.d.ts

@@ -0,0 +1,10 @@
+export type ErrorType = 'error' | 'unhandledrejection' | 'consoleWarn' | 'consoleError';
+export type ErrorData = {
+    type: ErrorType;
+    eventType?: string;
+    message: string;
+    source?: string;
+    lineNo?: number;
+    colNo?: number;
+    stack?: string;
+};

package/lib/mjs/types/ErrorData.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.2.22",
+    "version": "1.2.24",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,12 +54,12 @@
     },
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "devDependencies": {
-        "@types/jest": "^29.5.8",
+        "@types/jest": "^29.5.12",
         "@types/lodash.isequal": "^4.5.8",
         "jest": "^29.7.0",
         "jest-environment-jsdom": "^29.7.0",
-        "ts-jest": "^29.1.1",
-        "typescript": "^5.2.2"
+        "ts-jest": "^29.1.2",
+        "typescript": "^5.3.3"
     },
     "dependencies": {
         "lodash.isequal": "^4.5.0"

package/src/DomUtils.ts

@@ -1,6 +1,8 @@
 /// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
 import { DateUtils } from './DateUtils';
+import { Utils } from './Utils';
+import { ErrorData, ErrorType } from './types/ErrorData';
 import { FormDataFieldValue, IFormData } from './types/FormData';
 
 if (typeof navigator === 'undefined') {
@@ -599,6 +601,114 @@ export namespace DomUtils {
         if (element != null) element.focus();
     }
 
+    /**
+     * Setup logging
+     * @param action Logging action
+     * @param preventDefault Is prevent default action
+     */
+    export function setupLogging(
+        action: (data: ErrorData) => void | Promise<void>,
+        preventDefault?: ((type: ErrorType) => boolean) | boolean
+    ) {
+        // Avoid multiple setup, if there is already a handler, please set "globalThis.onunhandledrejection = null" first
+        if (globalThis.onunhandledrejection) return;
+
+        const errorPD = Utils.getResult(preventDefault, 'error') ?? true;
+        globalThis.onerror = (message, source, lineNo, colNo, error) => {
+            // Default source
+            source ||= globalThis.location.href;
+            let data: ErrorData;
+            if (typeof message === 'string') {
+                data = {
+                    type: 'error',
+                    message, // Share the same message with error
+                    source,
+                    lineNo,
+                    colNo,
+                    stack: error?.stack
+                };
+            } else {
+                data = {
+                    type: 'error',
+                    eventType: message.type,
+                    message:
+                        error?.message ??
+                        `${message.currentTarget} event error`,
+                    source,
+                    lineNo,
+                    colNo,
+                    stack: error?.stack
+                };
+            }
+
+            action(data);
+
+            // Return true to suppress error alert
+            return errorPD;
+        };
+
+        const rejectionPD = Utils.getResult(preventDefault, 'error') ?? true;
+        globalThis.onunhandledrejection = (event) => {
+            if (rejectionPD) event.preventDefault();
+
+            const reason = event.reason;
+            const data: ErrorData = {
+                type: 'unhandledrejection',
+                eventType: event.type,
+                message:
+                    typeof reason === 'string'
+                        ? reason
+                        : JSON.stringify(reason),
+                source: globalThis.location.href
+            };
+
+            action(data);
+        };
+
+        const localConsole = (
+            type: 'consoleWarn' | 'consoleError',
+            orgin: (...args: any[]) => void
+        ) => {
+            const consolePD = Utils.getResult(preventDefault, type) ?? false;
+            return (...args: any[]) => {
+                // Keep original action
+                if (!consolePD) orgin(...args);
+
+                const [first, ...rest] = args;
+                let message: string;
+                if (typeof first === 'string') {
+                    message = first;
+                } else {
+                    message = JSON.stringify(first);
+                }
+
+                const stack =
+                    rest.length > 0
+                        ? rest.map((item) => JSON.stringify(item)).join(', ')
+                        : undefined;
+
+                const data: ErrorData = {
+                    type,
+                    message,
+                    source: globalThis.location.href,
+                    stack
+                };
+
+                action(data);
+            };
+        };
+
+        globalThis.console.warn = localConsole(
+            'consoleWarn',
+            globalThis.console.warn
+        );
+
+        globalThis.console.error = localConsole(
+            'consoleError',
+            globalThis.console.error
+        );
+    }
+
     /**
      * Verify file system permission
      * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission

package/src/types/ErrorData.ts

@@ -0,0 +1,15 @@
+export type ErrorType =
+    | 'error'
+    | 'unhandledrejection'
+    | 'consoleWarn'
+    | 'consoleError';
+
+export type ErrorData = {
+    type: ErrorType;
+    eventType?: string;
+    message: string;
+    source?: string;
+    lineNo?: number;
+    colNo?: number;
+    stack?: string;
+};