@epigraph/epigraph-std-lib 1.0.0 → 2.0.0

package/dist/EpigraphLogger/epigraph-logger.d.ts

@@ -1,19 +1,130 @@
-type ILoggerDetails = string | boolean | object | Array<string> | Array<boolean> | HTMLElement;
+interface LoggerMode {
+    name: string;
+    allows: Array<string>;
+}
+interface LoggerModes {
+    release: LoggerMode;
+    staging: LoggerMode;
+    dev: LoggerMode;
+}
+export declare enum LoggerModeNames {
+    Release = "release",
+    Staging = "staging",
+    Dev = "dev"
+}
+export declare enum LogTypes {
+    Info = "info",
+    Warn = "warn",
+    Error = "error"
+}
 /**
- * Temporary class to use instead of console.log so it's
- * easy to migrate int he future.
+ * Epigraph's Logger class that provides various modes and functionalities to easily
+ * manage logging within our solutions in a consistent manner.
+ *
+ * Some common terminologies are:
+ * Mode: A logger's mode defines what log types would be automatically executed and
+ *       what would be ignored.
  */
 declare class EpigraphLogger {
     context: string;
+    private _allModes;
+    private _currentMode;
     /**
      * @param {string} [context="EPIGRAPH-LOGGER"] Used to categorise each message within
      *                the console.
      * @example,CORE, UI
      */
     constructor(context: string);
-    log(title?: string, details?: ILoggerDetails): void;
-    warn(title?: string, details?: ILoggerDetails): void;
-    error(title?: string, details?: ILoggerDetails): void;
-    table(title?: string, details?: ILoggerDetails): void;
+    get modes(): LoggerModes;
+    /**
+     *
+     * @param {LoggerModeNames} newValue Sets the logger mode of the current instance.
+     */
+    setCurrentMode(newValue: LoggerModeNames): void;
+    private _isLogTypeAllowedInCurrentMode;
+    /**
+     * A log type that doesn't necessarily need to be looked at by the end user.
+     * This can be any generic log that would be ignored in most logger modes except verbose.
+     *
+     * @param {string} title A short title for this log.
+     * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+     * @param {string | undefined} contextOverride Allows the user to specify where this log
+     * was recorded from. For eg. Core and Ui can pass in different values for this
+     * paramater to make it easy to debug. If not provided, the default context would be used
+     * that was provided at the time of initialisation of this class.
+     */
+    info(title?: string, details?: any, contextOverride?: string | undefined): void;
+    /**
+     * A warning log type that let's the user know that some action that could be dangerous was just
+     * performed and might need attention.
+     *
+     * @param {string} title A short title for this log.
+     * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+     * @param {string | undefined} contextOverride Allows the user to specify where this log
+     * was recorded from. For eg. Core and Ui can pass in different values for this
+     * paramater to make it easy to debug. If not provided, the default context would be used
+     * that was provided at the time of initialisation of this class.
+     */
+    warn(title?: string, details?: any, contextOverride?: string | undefined): void;
+    /**
+     * A critical error log type that let's the user know that some action that was unexpected and required immediate attention.
+     *
+     * @param {string} title A short title for this log.
+     * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+     * @param {string | undefined} contextOverride Allows the user to specify where this log
+     * was recorded from. For eg. Core and Ui can pass in different values for this
+     * paramater to make it easy to debug. If not provided, the default context would be used
+     * that was provided at the time of initialisation of this class.
+     */
+    error(title?: string, details?: any, contextOverride?: string | undefined): void;
+    /**
+     * A table log type that can show an object in an organised manner within the console.
+     * This is primarily for the visual purposes and doesn't provide any additional functionality
+     * that other log types cannot provide.
+     *
+     * @param {string} title A short title for this log.
+     * @param {any} details Any optional detail that would be shown if this log was expanded in the console.
+     * @param {string | undefined} contextOverride Allows the user to specify where this log
+     * was recorded from. For eg. Core and Ui can pass in different values for this
+     * paramater to make it easy to debug. If not provided, the default context would be used
+     * that was provided at the time of initialisation of this class.
+     * @param {LogTypes} logType A
+     */
+    table(title?: string, details?: any, contextOverride?: string | undefined, logType?: LogTypes): void;
+    /**
+     * Begins an expanded group with the browser's console window.
+     * NOTE: Please remember to close this group once done using EpigraphLogger.groupEnd();
+     *
+     * @param {string} title A short title for this group.
+     * @param {string | undefined} contextOverride Allows the user to specify where this log
+     * was recorded from. For eg. Core and Ui can pass in different values for this
+     * paramater to make it easy to debug. If not provided, the default context would be used
+     * that was provided at the time of initialisation of this class.
+     * @param {LogTypes} logType A group can implictly of any log type, by default it is of type
+     * info but this parameter allows the user to override this.
+     * @returns {void}
+     */
+    group(title: string, contextOverride?: string | undefined, logType?: LogTypes): void;
+    /**
+     * Begins a collapsed group with the browser's console window.
+     * NOTE: Please remember to close this group once done using EpigraphLogger.groupEnd();
+     *
+     * @param {string} title A short title for this group.
+     * @param {string | undefined} contextOverride Allows the user to specify where this log
+     * was recorded from. For eg. Core and Ui can pass in different values for this
+     * paramater to make it easy to debug. If not provided, the default context would be used
+     * that was provided at the time of initialisation of this class.
+     * @param {LogTypes} logType A group can implictly of any log type, by default it is of type
+     * info but this parameter allows the user to override this.
+     * @returns {void}
+     */
+    groupCollapsed(title: string, contextOverride?: string | undefined, logType?: LogTypes): void;
+    /**
+     * Similar to the console.groupEnd(). Useful for ending either a group or
+     * groupCollapse that was initialised by this logger.
+     *
+     * @returns {void}
+     */
+    groupEnd(): void;
 }
 export { EpigraphLogger };