@sap-ux/fiori-generator-shared 0.7.28 → 0.8.0

package/dist/logging/logWrapper.d.ts

@@ -1,4 +1,5 @@
-import type { IVSCodeExtLogger, LogLevel, IChildLogger as ILogWrapper } from '@vscode-logging/logger';
+import type { Log, Logger as SapUxLogger, Transport } from '@sap-ux/logger';
+import type { IChildLogger as ILogWrapper, IVSCodeExtLogger, LogLevel } from '@vscode-logging/logger';
 import type { Logger } from 'yeoman-environment';
 export type { ILogWrapper };
 export declare const LOGGING_LEVEL_CONFIG_PROP = "ApplicationWizard.loggingLevel";
@@ -19,9 +20,9 @@ export declare function createCLILogger(logName: string, logLevel?: LogLevel): I
 /**
  * Log to vscode extension logger and yeoman logger simultaneously.
  * This allows use of Application Wizard log config and log file use but still have a single output channel for
- * App Gen logging.
+ * generator logging.
  */
-export declare class LogWrapper implements ILogWrapper {
+export declare class LogWrapper implements ILogWrapper, SapUxLogger {
     private static _vscodeLogger;
     private static _yoLogger;
     private static _logLevel;
@@ -36,7 +37,7 @@ export declare class LogWrapper implements ILogWrapper {
      * @param vscode - vscode instance
      */
     constructor(logName: string, yoLogger?: Logger, logLevel?: LogLevel, extLogger?: IVSCodeExtLogger, vscode?: any);
-    static readonly logAtLevel: (level: LogLevel, message: string, ...args: any[]) => void;
+    static readonly logAtLevel: (level: LogLevel, message: string | object, ...args: any[]) => void;
     /**
      * Log a message at the fatal level.
      *
@@ -50,28 +51,28 @@ export declare class LogWrapper implements ILogWrapper {
      * @param msg - message to log
      * @param {...any} args - additional arguments
      */
-    error(msg: string, ...args: any[]): void;
+    error(msg: string | object, ...args: any[]): void;
     /**
      * Log a message at the warn level.
      *
      * @param msg - message to log
      * @param {...any} args - additional arguments
      */
-    warn(msg: string, ...args: any[]): void;
+    warn(msg: string | object, ...args: any[]): void;
     /**
      * Log a message at the info level.
      *
      * @param msg - message to log
      * @param {...any} args - additional arguments
      */
-    info(msg: string, ...args: any[]): void;
+    info(msg: string | object, ...args: any[]): void;
     /**
      * Log a message at the debug level.
      *
      * @param msg - message to log
      * @param {...any} args - additional arguments
      */
-    debug(msg: string, ...args: any[]): void;
+    debug(msg: string | object, ...args: any[]): void;
     /**
      * Log a message at the trace level.
      *
@@ -84,13 +85,48 @@ export declare class LogWrapper implements ILogWrapper {
      *
      * @param msg - message to log
      */
-    static log(msg: string): void;
+    static log(msg: string | object): void;
     /**
      * Get the currently configured log level.
      *
      * @returns {LogLevel} The current log level.
      */
     getLogLevel(): LogLevel;
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
     getChildLogger(): ILogWrapper;
+    /**
+     * Limited compatibility with `@sap-ux/logger` to use log() method.
+     *
+     * @param data
+     */
+    log(data: string | Log): void;
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
+    add(): SapUxLogger;
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
+    remove(): SapUxLogger;
+    /**
+     * Added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger transports
+     */
+    transports(): Transport[];
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
+    child(): SapUxLogger;
 }
 //# sourceMappingURL=logWrapper.d.ts.map

package/dist/logging/logWrapper.js

@@ -30,7 +30,31 @@ exports.DefaultLogger = {
         console.trace(msg);
     },
     getChildLogger: () => exports.DefaultLogger,
-    getLogLevel: () => 'off'
+    getLogLevel: () => 'off',
+    /**
+     * Limited compatibility with `@sap-ux/logger`
+     *
+     * @param data
+     */
+    log: function (data) {
+        console.log(data instanceof Object ? data.message : data);
+    },
+    add: function () {
+        console.warn('Log method `add(transport)` not implemented.');
+        return this;
+    },
+    remove: function () {
+        console.warn('Log method `remove(transport)` not implemented.');
+        return this;
+    },
+    transports: function () {
+        console.warn('Logger method `transports()` not implemented.');
+        return [];
+    },
+    child: function () {
+        console.warn('Log method `remove(transport)` not implemented. Returning current logger.');
+        return this;
+    }
 };
 const LOG_LEVEL_KEYS = {
     off: -1,
@@ -60,7 +84,7 @@ function createCLILogger(logName, logLevel = 'off') {
 /**
  * Log to vscode extension logger and yeoman logger simultaneously.
  * This allows use of Application Wizard log config and log file use but still have a single output channel for
- * App Gen logging.
+ * generator logging.
  */
 class LogWrapper {
     static _vscodeLogger;
@@ -95,6 +119,9 @@ class LogWrapper {
         LogWrapper._vscodeLogger?.debug((0, i18n_1.t)('debug.loggingConfigured', { logLevel: LogWrapper._logLevel }));
     }
     static logAtLevel = (level, message, ...args) => {
+        if (typeof message === 'object') {
+            message = JSON.stringify(message);
+        }
         if (LogWrapper._vscodeLogger && level !== 'off') {
             LogWrapper._vscodeLogger[level](message, ...args);
         }
@@ -180,8 +207,59 @@ class LogWrapper {
     getLogLevel() {
         return LogWrapper._logLevel;
     }
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
     getChildLogger( /* opts: { label: string } */) {
-        throw new Error((0, i18n_1.t)('error.methodNotImplemented'));
+        LogWrapper.logAtLevel(`trace`, 'Log method `getChildLogger()` not implemented. Returning current logger.');
+        return this;
+    }
+    /**
+     * Limited compatibility with `@sap-ux/logger` to use log() method.
+     *
+     * @param data
+     */
+    log(data) {
+        // LogLevel is not supported in this implementation
+        LogWrapper.logAtLevel('info', data.message ?? data);
+    }
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
+    add() {
+        LogWrapper.logAtLevel(`warn`, 'Log method `add(transport)` not implemented.');
+        return this;
+    }
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
+    remove() {
+        LogWrapper.logAtLevel(`warn`, 'Log method `remove(transport)` not implemented.');
+        return this;
+    }
+    /**
+     * Added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger transports
+     */
+    transports() {
+        LogWrapper.logAtLevel(`warn`, 'Log method `transports()` not implemented.');
+        return [];
+    }
+    /**
+     * Not implemented method, added to support limited interoperability with @sap-ux/logger.
+     *
+     * @returns {ILogWrapper} - the current logger
+     */
+    child() {
+        LogWrapper.logAtLevel(`warn`, 'Log method `child(options)` not implemented. Returning current logger.');
+        return this;
     }
 }
 exports.LogWrapper = LogWrapper;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fiori-generator-shared",
   "description": "Commonly used shared functionality and types to support the fiori generator.",
-  "version": "0.7.28",
+  "version": "0.8.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -25,15 +25,16 @@
     "os-name": "4.0.1",
     "semver": "7.5.4",
     "@sap-ux/btp-utils": "1.0.1",
-    "@sap-ux/project-access": "1.29.6",
-    "@sap-ux/telemetry": "0.5.60"
+    "@sap-ux/project-access": "1.29.7",
+    "@sap-ux/telemetry": "0.5.61"
   },
   "devDependencies": {
     "@types/mem-fs-editor": "7.0.1",
     "@types/mem-fs": "1.1.2",
     "@types/semver": "7.5.2",
     "@types/vscode": "1.73.1",
-    "@types/yeoman-environment": "2.10.11"
+    "@types/yeoman-environment": "2.10.11",
+    "@sap-ux/logger": "0.6.0"
   },
   "engines": {
     "node": ">=18.x"