@skyux/core 6.0.0-beta.5 → 6.0.0-beta.6

package/fesm2020/skyux-core.mjs

@@ -1,5 +1,5 @@
 import * as i0 from '@angular/core';
-import { NgModule, Injectable, EventEmitter, Directive, Input, Output, Injector, ViewContainerRef, Component, ChangeDetectionStrategy, ViewChild, Pipe, ElementRef, Optional } from '@angular/core';
+import { NgModule, Injectable, EventEmitter, Directive, Input, Output, Injector, ViewContainerRef, Component, ChangeDetectionStrategy, ViewChild, InjectionToken, Optional, Inject, Pipe, ElementRef } from '@angular/core';
 import * as i4 from '@angular/common';
 import { CommonModule } from '@angular/common';
 import { Subject, fromEvent, BehaviorSubject, ReplaySubject, Observable, of } from 'rxjs';
@@ -1389,25 +1389,136 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.2", ngImpor
         }] });
 
 /**
- * @deprecated The `SkyLogService` will be removed in the next major version of `@skyux/core`.
+ * @internal
+ */
+const SKY_LOG_LEVEL = new InjectionToken('SkyLogLevel');
+
+/**
+ * Logs information to the console based on the application's log level as provided by the `SKY_LOG_LEVEL` injection token. If no token is provided, only `error` logs will be shown.
+ * @internal
  */
 class SkyLogService {
-    warn(message, ...optionalParams) {
-        /*istanbul ignore else */
-        if (window.console) {
-            // eslint-disable-next-line prefer-spread,prefer-rest-params
-            window.console.warn.apply(window.console, arguments);
+    constructor(formatter, applicationLogLevel) {
+        this.formatter = formatter;
+        this.applicationLogLevel = applicationLogLevel;
+        if (!this.applicationLogLevel) {
+            this.applicationLogLevel = 3 /* Error */;
+        }
+    }
+    /**
+     * Logs a deprecation warning for a class, property, function, etc. This will be logged as a console warning unless a different log level is given in the the `args` parameter.
+     * @param name The name of the deprecated class, property, function, etc.
+     * @param args Information about the deprecation and replacement recommendations.
+     * @returns
+     */
+    async deprecated(name, args) {
+        const logLevel = args?.logLevel ?? 2 /* Warn */;
+        name = this.convertStringToCode(name);
+        if (this.canLog(logLevel)) {
+            const localizedStrings = [];
+            if (args?.deprecationMajorVersion) {
+                localizedStrings.push(this.formatter.formatText('{0} is deprecated starting in SKY UX {1}.', name, args.deprecationMajorVersion.toLocaleString()));
+            }
+            else {
+                localizedStrings.push(this.formatter.formatText('{0} is deprecated.', name));
+            }
+            if (args?.removalMajorVersion) {
+                localizedStrings.push(this.formatter.formatText('We will remove it in version {0}.', args.removalMajorVersion.toLocaleString()));
+            }
+            else {
+                localizedStrings.push('We will remove it in a future major version.');
+            }
+            if (args?.replacementRecommendation) {
+                localizedStrings.push(args.replacementRecommendation);
+            }
+            if (args?.moreInfoUrl) {
+                localizedStrings.push(this.formatter.formatText('For more information, see {0}.', args.moreInfoUrl));
+            }
+            this.logBasedOnLevel(logLevel, localizedStrings.join(' '));
+        }
+        return Promise.resolve();
+    }
+    /**
+     * Logs a console error if the application's log level is `SkyLogLevel.Error`.
+     * @param message The error message
+     * @param params Optional parameters for the error message.
+     */
+    error(message, params) {
+        if (this.canLog(3 /* Error */)) {
+            if (params) {
+                console.error(message, ...params);
+            }
+            else {
+                console.error(message);
+            }
+        }
+    }
+    /**
+     * Logs console information if the application's log level is `SkyLogLevel.Info` or above.
+     * @param message The infomational message
+     * @param params Optional parameters for the informational message.
+     */
+    info(message, params) {
+        if (this.canLog(1 /* Info */)) {
+            if (params) {
+                console.log(message, ...params);
+            }
+            else {
+                console.log(message);
+            }
+        }
+    }
+    /**
+     * Logs a console warning if the application's log level is `SkyLogLevel.Warn` or above.
+     * @param message The warning message
+     * @param params Optional parameters for the warning message.
+     */
+    warn(message, params) {
+        if (this.canLog(2 /* Warn */)) {
+            if (params) {
+                console.warn(message, ...params);
+            }
+            else {
+                console.warn(message);
+            }
+        }
+    }
+    convertStringToCode(typeString) {
+        if (typeString.charAt(0) !== '`' && typeString.charAt(-1) !== '`') {
+            typeString = '`' + typeString + '`';
+        }
+        return typeString;
+    }
+    canLog(intendedLogLevel) {
+        return intendedLogLevel >= this.applicationLogLevel;
+    }
+    logBasedOnLevel(logLevel, message, params) {
+        switch (logLevel) {
+            case 1 /* Info */:
+                this.info(message, params);
+                break;
+            case 2 /* Warn */:
+                this.warn(message, params);
+                break;
+            case 3 /* Error */:
+                this.error(message, params);
+                break;
         }
     }
 }
-SkyLogService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.2", ngImport: i0, type: SkyLogService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+SkyLogService.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.2", ngImport: i0, type: SkyLogService, deps: [{ token: SkyAppFormat }, { token: SKY_LOG_LEVEL, optional: true }], target: i0.ɵɵFactoryTarget.Injectable });
 SkyLogService.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "13.3.2", ngImport: i0, type: SkyLogService, providedIn: 'root' });
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.2", ngImport: i0, type: SkyLogService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: 'root',
                 }]
-        }] });
+        }], ctorParameters: function () { return [{ type: SkyAppFormat }, { type: undefined, decorators: [{
+                    type: Optional
+                }, {
+                    type: Inject,
+                    args: [SKY_LOG_LEVEL]
+                }] }]; } });
 
 /**
  * @deprecated The `SkyMediaQueryService` no longer needs the `SkyMediaQueryModule`.
@@ -3201,5 +3312,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.2", ngImpor
  * Generated bundle index. Do not edit.
  */
 
-export { MutationObserverService, NumericOptions, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyIdModule, SkyLogModule, SkyLogService, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyScrollableHostService, SkyUIConfigService, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, getWindow, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3 };
+export { MutationObserverService, NumericOptions, SKY_LOG_LEVEL, SkyAffixAutoFitContext, SkyAffixModule, SkyAffixService, SkyAffixer, SkyAppFormat, SkyAppTitleService, SkyAppWindowRef, SkyCoreAdapterModule, SkyCoreAdapterService, SkyDockItem, SkyDockLocation, SkyDockModule, SkyDockService, SkyDynamicComponentLocation, SkyDynamicComponentModule, SkyDynamicComponentService, SkyIdModule, SkyLogModule, SkyLogService, SkyMediaBreakpoints, SkyMediaQueryModule, SkyMediaQueryService, SkyNumericModule, SkyNumericPipe, SkyNumericService, SkyOverlayInstance, SkyOverlayModule, SkyOverlayService, SkyPercentPipe, SkyPercentPipeModule, SkyResizeObserverMediaQueryService, SkyResizeObserverService, SkyScrollableHostService, SkyUIConfigService, SkyViewkeeperHostOptions, SkyViewkeeperModule, SkyViewkeeperService, getWindow, SkyAffixDirective as λ1, SkyIdDirective as λ2, SkyViewkeeperDirective as λ3 };
 //# sourceMappingURL=skyux-core.mjs.map