@adaptabletools/adaptable 15.0.2 → 15.1.0-canary.0

package/src/agGrid/AdaptableLogger.d.ts

@@ -0,0 +1,26 @@
+import { AdaptableMessageType } from '../PredefinedConfig/Common/AdaptableMessageType';
+export declare class AdaptableLogger {
+    private adaptableId;
+    private debugger;
+    private infoLogger;
+    private successLogger;
+    private warnLogger;
+    private errorLogger;
+    private perfLogger;
+    static consoleErrorBase(message: string, ...optionalParams: any[]): void;
+    static consoleWarnBase(message: string, ...optionalParams: any[]): void;
+    static consoleLogBase(message: string, ...optionalParams: any[]): void;
+    constructor(adaptableId: string);
+    beginPerf(sectionName: string): {
+        end: (additionalComment?: string) => void;
+    };
+    info(message: string, ...optionalParams: any[]): void;
+    success(message: string, ...optionalParams: any[]): void;
+    warn(message: string, ...optionalParams: any[]): void;
+    error(message: string, ...optionalParams: any[]): void;
+    consoleLogByMessageType(message: string, messageType: AdaptableMessageType, ...optionalParams: any[]): void;
+    consoleInfo(message: string, ...optionalParams: any[]): void;
+    consoleLog(message: string, ...optionalParams: any[]): void;
+    consoleWarn(message: string, ...optionalParams: any[]): void;
+    consoleError(message: string, ...optionalParams: any[]): void;
+}

package/src/agGrid/AdaptableLogger.js

@@ -0,0 +1,148 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdaptableLogger = void 0;
+const debugFactory = require('debug');
+function humanize(ms) {
+    return `${ms}ms`;
+}
+debugFactory.humanize = humanize;
+const performanceTime = (previousTime) => {
+    const now = performance.now();
+    return previousTime ? now - previousTime : now;
+};
+class AdaptableLogger {
+    constructor(adaptableId) {
+        this.adaptableId = adaptableId;
+        this.debugger = debugFactory(`Adaptable:${adaptableId}`);
+        this.infoLogger = this.debugger.extend(`info`);
+        this.infoLogger.log = console.info.bind(console);
+        this.successLogger = this.debugger.extend(`success`);
+        this.successLogger.log = console.log.bind(console);
+        this.warnLogger = this.debugger.extend(`warn`);
+        this.warnLogger.log = console.warn.bind(console);
+        this.errorLogger = this.debugger.extend(`error`);
+        this.errorLogger.log = console.error.bind(console);
+        this.perfLogger = this.debugger.extend(`perf`);
+        this.perfLogger.log = console.debug.bind(console);
+    }
+    // use static loggers whenever access to AdaptableLogger instance is not feasible
+    static consoleErrorBase(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.error(message, optionalParams);
+        }
+        else {
+            console.error(message);
+        }
+    }
+    static consoleWarnBase(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.warn(message, optionalParams);
+        }
+        else {
+            console.warn(message);
+        }
+    }
+    static consoleLogBase(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.log(message, optionalParams);
+        }
+        else {
+            console.log(message);
+        }
+    }
+    beginPerf(sectionName) {
+        this.perfLogger(`[BEGIN] - ${sectionName}`);
+        const startTime = performanceTime();
+        return {
+            end: (additionalComment) => {
+                this.perfLogger(`[END]   - ${sectionName} ${additionalComment ? `(${additionalComment})` : ''} :: delta +${performanceTime(startTime)}ms`);
+            },
+        };
+    }
+    info(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            this.infoLogger(message, ...optionalParams);
+        }
+        else {
+            this.infoLogger(message);
+        }
+    }
+    success(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            this.successLogger(message, ...optionalParams);
+        }
+        else {
+            this.successLogger(message);
+        }
+    }
+    warn(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            this.warnLogger(message, ...optionalParams);
+        }
+        else {
+            this.warnLogger(message);
+        }
+    }
+    error(message, ...optionalParams) {
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            this.errorLogger(message, ...optionalParams);
+        }
+        else {
+            this.errorLogger(message);
+        }
+    }
+    consoleLogByMessageType(message, messageType, ...optionalParams) {
+        message = `AdapTable:${this.adaptableId} ${messageType}: ${message}`;
+        switch (messageType) {
+            case 'Info':
+                console.info(message, optionalParams);
+                break;
+            case 'Success':
+                console.log(message, optionalParams);
+                break;
+            case 'Warning':
+                console.warn(message, optionalParams);
+                break;
+            case 'Error':
+                console.error(message, optionalParams);
+                break;
+        }
+    }
+    consoleInfo(message, ...optionalParams) {
+        message = `AdapTable:${this.adaptableId}: ${message}`;
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.info(message, optionalParams);
+        }
+        else {
+            console.info(message);
+        }
+    }
+    consoleLog(message, ...optionalParams) {
+        message = `AdapTable:${this.adaptableId}: ${message}`;
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.log(message, optionalParams);
+        }
+        else {
+            console.log(message);
+        }
+    }
+    consoleWarn(message, ...optionalParams) {
+        message = `AdapTable:${this.adaptableId}: ${message}`;
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.warn(message, optionalParams);
+        }
+        else {
+            console.warn(message);
+        }
+    }
+    consoleError(message, ...optionalParams) {
+        message = `AdapTable:${this.adaptableId}: ${message}`;
+        if (optionalParams === null || optionalParams === void 0 ? void 0 : optionalParams.length) {
+            console.error(message, optionalParams);
+        }
+        else {
+            console.error(message);
+        }
+    }
+}
+exports.AdaptableLogger = AdaptableLogger;

package/src/agGrid/agGridHelper.js

@@ -30,7 +30,6 @@ const ToolPanelModule_1 = require("../Strategy/ToolPanelModule");
 const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
 const ArrayExtensions_1 = require("../Utilities/Extensions/ArrayExtensions");
 const StringExtensions_1 = require("../Utilities/Extensions/StringExtensions");
-const LoggingHelper_1 = require("../Utilities/Helpers/LoggingHelper");
 const CheckboxRenderer_1 = require("./CheckboxRenderer");
 const DataChangeHistoryModule_1 = require("../Strategy/DataChangeHistoryModule");
 const FlashingCellModule_1 = require("../Strategy/FlashingCellModule");
@@ -401,7 +400,7 @@ class agGridHelper {
     getColumnDataType(column, logWarning = true) {
         // Some columns can have no ID or Title. we return string as a consequence but it needs testing
         if (!column) {
-            (0, LoggingHelper_1.LogAdaptableWarning)('column is undefined returning String for Type');
+            this.adaptable.logger.warn('column is undefined returning String for Type');
             return 'String';
         }
         let dataType = 'Unknown';
@@ -429,20 +428,20 @@ class agGridHelper {
         }
         const model = this.gridOptions.api.getModel();
         if (model == null) {
-            (0, LoggingHelper_1.LogAdaptableWarning)(`No model so returning type "Unknown" for Column: "${column.getColId()}"`);
+            this.adaptable.logger.warn(`No model so returning type "Unknown" for Column: "${column.getColId()}"`);
             return 'Unknown';
         }
         let row = model.getRow(0);
         if (row == null) {
             // possible that there will be no data.
-            (0, LoggingHelper_1.LogAdaptableWarning)(`No data in grid so returning type "Unknown" for Column: "${column.getColId()}"`);
+            this.adaptable.logger.warn(`No data in grid so returning type "Unknown" for Column: "${column.getColId()}"`);
             return 'Unknown';
         }
         // if it's a group we need the content of the group
         if (row.group) {
             const childNodes = row.childrenAfterGroup;
             if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(childNodes)) {
-                (0, LoggingHelper_1.LogAdaptableWarning)(`No data in grid so returning type "Unknown" for Column: "${column.getColId()}"`);
+                this.adaptable.logger.warn(`No data in grid so returning type "Unknown" for Column: "${column.getColId()}"`);
                 return 'Unknown';
             }
             row = childNodes[0];
@@ -472,7 +471,7 @@ class agGridHelper {
                     break;
             }
         }
-        (0, LoggingHelper_1.LogAdaptableWarning)(`No defined type for column '${column.getColId()}'. Defaulting to type of first value: ${dataType}`);
+        this.adaptable.logger.warn(`No defined type for column '${column.getColId()}'. Defaulting to type of first value: ${dataType}`);
         return dataType;
     }
     getAbColDefValue(colType) {
@@ -533,7 +532,7 @@ class agGridHelper {
         // if they have selected to clear column filters on startup then do it
         if (this.adaptable.adaptableOptions.filterOptions.clearFiltersOnStartUp) {
             if (ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.filterApi.getColumnFilters())) {
-                (0, LoggingHelper_1.LogAdaptableWarning)('Clearing existing Column Filters as "clearFiltersOnStartUp" is true');
+                this.adaptable.logger.warn('Clearing existing Column Filters as "clearFiltersOnStartUp" is true');
                 this.adaptable.api.filterApi.clearColumnFilters();
             }
         }
@@ -542,7 +541,7 @@ class agGridHelper {
             if (StringExtensions_1.StringExtensions.IsNotNullOrEmpty(this.adaptable.api.quickSearchApi.getQuickSearchState().QuickSearchText) ||
                 StringExtensions_1.StringExtensions.IsNotNullOrEmpty(this.adaptable.api.queryApi.getCurrentQuery()) ||
                 ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.dataSetApi.getDataSets())) {
-                (0, LoggingHelper_1.LogAdaptableWarning)('Clearing existing Searches as "clearSearchesOnStartUp" is true');
+                this.adaptable.logger.warn('Clearing existing Searches as "clearSearchesOnStartUp" is true');
                 this.adaptable.api.quickSearchApi.clearQuickSearch();
                 this.adaptable.api.queryApi.clearCurrentQuery();
                 this.adaptable.api.dataSetApi.clearCurrentDataSet();

package/src/components/ExpressionEditor/BaseEditorInput.js

@@ -16,7 +16,6 @@ const react_1 = require("react");
 const ExpressionEvaluationError_1 = require("../../parser/src/ExpressionEvaluationError");
 const ButtonInfo_1 = require("../../View/Components/Buttons/ButtonInfo");
 const DocumentationLinkConstants_1 = require("../../Utilities/Constants/DocumentationLinkConstants");
-const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const icons_1 = require("../icons");
 const AdaptableContext_1 = require("../../View/AdaptableContext");
 const join_1 = tslib_1.__importDefault(require("../utils/join"));
@@ -219,7 +218,7 @@ function BaseEditorInput(props) {
             expressionError = buildParserExceptionMessage(e);
         }
         else {
-            (0, LoggingHelper_1.LogAdaptableError)(`Unexpected error while evaluating '${props.value}':
+            props.api.logWarn(`Unexpected error while evaluating '${props.value}':
       ${e}`);
         }
     }

package/src/components/OverlayTrigger/index.js

@@ -11,7 +11,6 @@ const Overlay_1 = tslib_1.__importDefault(require("./Overlay"));
 const join_1 = tslib_1.__importDefault(require("../utils/join"));
 const usePrevious_1 = tslib_1.__importDefault(require("../utils/usePrevious"));
 const utils_1 = require("./utils");
-const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const useAgGridClassName_1 = tslib_1.__importDefault(require("./useAgGridClassName"));
 const contains_1 = tslib_1.__importDefault(require("../utils/contains"));
 const UIHelper_1 = require("../../View/UIHelper");
@@ -124,7 +123,7 @@ const OverlayTrigger = React.forwardRef((props, ref) => {
             target = targetProp(target);
         }
         if (!target) {
-            (0, LoggingHelper_1.LogAdaptableWarning)('No OverlayTrigger target - make sure you render a child inside the OverlayTrigger, which will be the overlay target');
+            adaptable.logger.warn('No OverlayTrigger target - make sure you render a child inside the OverlayTrigger, which will be the overlay target');
             return;
         }
         targetRef.current = target;

package/src/components/SelectableList/index.js

@@ -5,7 +5,6 @@ const tslib_1 = require("tslib");
 const React = tslib_1.__importStar(require("react"));
 const react_1 = require("react");
 const useProperty_1 = tslib_1.__importDefault(require("../utils/useProperty"));
-const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const SelectableListContext = React.createContext({
     clickInfoRef: null,
     selected: {},
@@ -17,7 +16,6 @@ const useSelectionEvent = () => {
     const { selected, setSelected, toggleOnSimpleClick, clickInfoRef, getItemId } = (0, react_1.useContext)(SelectableListContext);
     return (event, { index }) => {
         if (index === undefined) {
-            (0, LoggingHelper_1.LogAdaptableWarning)('No "index" was passed to the list item');
             return;
         }
         const { lastClickIndexWithoutShift, lastShiftSelectionRange } = clickInfoRef.current;

package/src/components/icons/index.js

@@ -133,7 +133,6 @@ const menu_1 = tslib_1.__importDefault(require("./menu"));
 const statusbar_1 = tslib_1.__importDefault(require("./statusbar"));
 const add_row_1 = tslib_1.__importDefault(require("./add-row"));
 const brush_1 = tslib_1.__importDefault(require("./brush"));
-const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const quote_1 = tslib_1.__importDefault(require("./quote"));
 const news_1 = tslib_1.__importDefault(require("./news"));
 const instrument_1 = tslib_1.__importDefault(require("./instrument"));
@@ -141,6 +140,7 @@ const analysis_1 = tslib_1.__importDefault(require("./analysis"));
 const visibility_1 = tslib_1.__importDefault(require("./visibility"));
 const visibility_off_1 = tslib_1.__importDefault(require("./visibility-off"));
 const AdaptableIconComponent_1 = require("../AdaptableIconComponent");
+const AdaptableLogger_1 = require("../../agGrid/AdaptableLogger");
 const allIcons = {
     // toolbars
     application: application_1.default,
@@ -293,7 +293,7 @@ const Icon = (_a) => {
     var { name, style, className, tabIndex } = _a, props = tslib_1.__rest(_a, ["name", "style", "className", "tabIndex"]);
     const IconCmp = (allIcons[name] || null);
     if (!IconCmp) {
-        (0, LoggingHelper_1.LogAdaptableWarning)('NO icon found for ' + name);
+        AdaptableLogger_1.AdaptableLogger.consoleWarnBase('NO icon found for ' + name);
         return React.createElement("svg", { height: "17", width: "17" });
     }
     return React.createElement(IconCmp, Object.assign({ tabIndex: tabIndex }, props, { style: style, name: name, className: className }));