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

package/index.d.ts

@@ -27,6 +27,8 @@ export * from './lib/modules/format/app-format';
 export * from './lib/modules/id/id.module';
 export * from './lib/modules/log/log.module';
 export * from './lib/modules/log/log.service';
+export * from './lib/modules/log/types/log-level';
+export * from './lib/modules/log/types/log-level-token';
 export * from './lib/modules/media-query/media-breakpoints';
 export * from './lib/modules/media-query/media-query-listener';
 export * from './lib/modules/media-query/media-query.module';

package/lib/modules/log/log.service.d.ts

@@ -1,9 +1,43 @@
+import { SkyAppFormat } from '../format/app-format';
+import { SkyLogDeprecatedArgs } from './types/log-deprecation-args';
+import { SkyLogLevel } from './types/log-level';
 import * as i0 from "@angular/core";
 /**
- * @deprecated The `SkyLogService` will be removed in the next major version of `@skyux/core`.
+ * 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
  */
 export declare class SkyLogService {
-    warn(message?: any, ...optionalParams: any[]): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SkyLogService, never>;
+    private formatter;
+    private applicationLogLevel;
+    constructor(formatter: SkyAppFormat, applicationLogLevel: SkyLogLevel);
+    /**
+     * 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
+     */
+    deprecated(name: string, args?: SkyLogDeprecatedArgs): Promise<void>;
+    /**
+     * 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: string, params?: unknown[]): void;
+    /**
+     * 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: string, params?: unknown[]): void;
+    /**
+     * 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: string, params?: unknown[]): void;
+    private convertStringToCode;
+    private canLog;
+    private logBasedOnLevel;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyLogService, [null, { optional: true; }]>;
     static ɵprov: i0.ɵɵInjectableDeclaration<SkyLogService>;
 }

package/lib/modules/log/types/log-deprecation-args.d.ts

@@ -0,0 +1,27 @@
+import { SkyLogLevel } from './log-level';
+/**
+ * @internal
+ * Arguments used when logging that a class, property, function, etc. is depcrecated.
+ */
+export interface SkyLogDeprecatedArgs {
+    /**
+     * The major version which deprecated the feature.
+     */
+    deprecationMajorVersion?: number;
+    /**
+     * The log level for the console logging. The `SkyLogService` will assume `SkyLogLevel.Warn` if this is not provided.
+     */
+    logLevel?: SkyLogLevel;
+    /**
+     * A URL which gives more information about the deprecation or the replacement recommendation.
+     */
+    moreInfoUrl?: string;
+    /**
+     * The major version which will remove the deprecated feature.
+     */
+    removalMajorVersion?: number;
+    /**
+     * The recommendation for how to replace the deprecated feature.
+     */
+    replacementRecommendation?: string;
+}

package/lib/modules/log/types/log-level-token.d.ts

@@ -0,0 +1,6 @@
+import { InjectionToken } from '@angular/core';
+import { SkyLogLevel } from './log-level';
+/**
+ * @internal
+ */
+export declare const SKY_LOG_LEVEL: InjectionToken<SkyLogLevel>;

package/lib/modules/log/types/log-level.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @internal
+ */
+export declare const enum SkyLogLevel {
+    Info = 1,
+    Warn = 2,
+    Error = 3
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/core",
-  "version": "6.0.0-beta.5",
+  "version": "6.0.0-beta.8",
   "author": "Blackbaud, Inc.",
   "keywords": [
     "blackbaud",
@@ -44,7 +44,7 @@
     "@angular/core": "^13.3.2",
     "@angular/platform-browser": "^13.3.2",
     "@angular/router": "^13.3.2",
-    "@skyux/i18n": "6.0.0-beta.5"
+    "@skyux/i18n": "6.0.0-beta.8"
   },
   "dependencies": {
     "tslib": "^2.3.1"