@goldstack/utils-cli 0.3.9 → 0.3.11

package/dist/src/utilsCli.d.ts

@@ -1,4 +1,30 @@
 declare type AsyncFunction<O> = () => Promise<O>;
+/**
+ * Interface defining the required logger instance methods
+ */
+export interface LoggerInstance {
+    debug: (obj: object | null | undefined, msg?: string) => void;
+    info: (obj: object | null | undefined, msg?: string) => void;
+    warn: (obj: object | null | undefined, msg?: string) => void;
+    error: (msg: string) => void;
+}
+/**
+ * Configuration options for the logger
+ */
+export interface LoggerConfig {
+    /** Custom logger instance implementing LoggerInstance interface */
+    instance?: LoggerInstance;
+}
+/**
+ * Configure the logger instance
+ * @param config - Configuration options for the logger
+ */
+export declare function configureLogger(config: LoggerConfig): void;
+/**
+ * Get the current logger instance
+ * @returns The configured logger instance or the default pino logger
+ */
+export declare function logger(): LoggerInstance;
 export declare const wrapCli: (func: AsyncFunction<any>) => Promise<void>;
 export {};
 //# sourceMappingURL=utilsCli.d.ts.map

package/dist/src/utilsCli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utilsCli.d.ts","sourceRoot":"","sources":["../../src/utilsCli.ts"],"names":[],"mappings":"AAAA,aAAK,aAAa,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AAKzC,eAAO,MAAM,OAAO,SAAgB,cAAc,GAAG,CAAC,KAAG,QAAQ,IAAI,CAYpE,CAAC"}
+{"version":3,"file":"utilsCli.d.ts","sourceRoot":"","sources":["../../src/utilsCli.ts"],"names":[],"mappings":"AAGA,aAAK,aAAa,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;AAKzC;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9D,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7D,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7D,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,mEAAmE;IACnE,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AA8CD;;;GAGG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAE1D;AAED;;;GAGG;AACH,wBAAgB,MAAM,IAAI,cAAc,CAEvC;AAGD,eAAO,MAAM,OAAO,SAAgB,cAAc,GAAG,CAAC,KAAG,QAAQ,IAAI,CAYpE,CAAC"}

package/dist/src/utilsCli.js

@@ -1,7 +1,68 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.wrapCli = void 0;
+exports.wrapCli = exports.logger = exports.configureLogger = void 0;
+const pino_1 = __importDefault(require("pino"));
+const pino_pretty_1 = __importDefault(require("pino-pretty"));
 const isDebug = process.env.GOLDSTACK_DEBUG || process.env.DEBUG;
+const isLambda = !!process.env.AWS_LAMBDA_FUNCTION_NAME;
+let loggerInstance;
+const defaultLogger = (0, pino_1.default)({
+    level: isDebug ? 'debug' : 'info',
+    ...(isLambda && {
+        timestamp: () => `,"time":"${new Date(Date.now()).toISOString()}"`,
+        formatters: {
+            level: (label) => ({ level: label }),
+            log: (obj) => {
+                if (obj.err) {
+                    const err = obj.err;
+                    return {
+                        ...obj,
+                        error: {
+                            type: err.name,
+                            stack: err.stack,
+                            message: err.message,
+                        },
+                    };
+                }
+                return obj;
+            },
+        },
+        base: {
+            aws_request_id: process.env.AWS_LAMBDA_REQUEST_ID || undefined,
+            function_name: process.env.AWS_LAMBDA_FUNCTION_NAME,
+            function_version: process.env.AWS_LAMBDA_FUNCTION_VERSION,
+        },
+    }),
+}, isLambda
+    ? undefined // Use default JSON transport for Lambda
+    : (0, pino_pretty_1.default)({
+        colorize: true,
+        hideObject: false,
+        colorizeObjects: true,
+        translateTime: 'HH:MM:ss',
+        ignore: 'pid,hostname',
+        singleLine: false,
+        sync: true, // required for work in Jest see https://github.com/pinojs/pino-pretty?tab=readme-ov-file#usage-with-jest
+    }));
+/**
+ * Configure the logger instance
+ * @param config - Configuration options for the logger
+ */
+function configureLogger(config) {
+    loggerInstance = config.instance;
+}
+exports.configureLogger = configureLogger;
+/**
+ * Get the current logger instance
+ * @returns The configured logger instance or the default pino logger
+ */
+function logger() {
+    return loggerInstance || defaultLogger;
+}
+exports.logger = logger;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrapCli = async (func) => {
     try {

package/dist/src/utilsCli.js.map

@@ -1 +1 @@
-{"version":3,"file":"utilsCli.js","sourceRoot":"","sources":["../../src/utilsCli.ts"],"names":[],"mappings":";;;AAEA,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;AAEjE,8DAA8D;AACvD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAwB,EAAiB,EAAE;IACvE,IAAI;QACF,MAAM,IAAI,EAAE,CAAC;QACb,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,CAAC;SACT;aAAM;YACL,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC,CAAC;AAZW,QAAA,OAAO,WAYlB;AAEF,8DAA8D;AAC9D,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,CAAM,EAAE,EAAE;IAC1C,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAChB;IACD,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"utilsCli.js","sourceRoot":"","sources":["../../src/utilsCli.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,8DAAqC;AAIrC,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;AACjE,MAAM,QAAQ,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;AAoBxD,IAAI,cAA0C,CAAC;AAE/C,MAAM,aAAa,GAAG,IAAA,cAAI,EACxB;IACE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;IACjC,GAAG,CAAC,QAAQ,IAAI;QACd,SAAS,EAAE,GAAG,EAAE,CAAC,YAAY,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE,GAAG;QAClE,UAAU,EAAE;YACV,KAAK,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC5C,GAAG,EAAE,CAAC,GAA4B,EAAE,EAAE;gBACpC,IAAI,GAAG,CAAC,GAAG,EAAE;oBACX,MAAM,GAAG,GAAG,GAAG,CAAC,GAAY,CAAC;oBAC7B,OAAO;wBACL,GAAG,GAAG;wBACN,KAAK,EAAE;4BACL,IAAI,EAAE,GAAG,CAAC,IAAI;4BACd,KAAK,EAAE,GAAG,CAAC,KAAK;4BAChB,OAAO,EAAE,GAAG,CAAC,OAAO;yBACrB;qBACF,CAAC;iBACH;gBACD,OAAO,GAAG,CAAC;YACb,CAAC;SACF;QACD,IAAI,EAAE;YACJ,cAAc,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,IAAI,SAAS;YAC9D,aAAa,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB;YACnD,gBAAgB,EAAE,OAAO,CAAC,GAAG,CAAC,2BAA2B;SAC1D;KACF,CAAC;CACH,EACD,QAAQ;IACN,CAAC,CAAC,SAAS,CAAC,wCAAwC;IACpD,CAAC,CAAC,IAAA,qBAAU,EAAC;QACT,QAAQ,EAAE,IAAI;QACd,UAAU,EAAE,KAAK;QACjB,eAAe,EAAE,IAAI;QACrB,aAAa,EAAE,UAAU;QACzB,MAAM,EAAE,cAAc;QACtB,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE,IAAI,EAAE,yGAAyG;KACtH,CAAC,CACP,CAAC;AAEF;;;GAGG;AACH,SAAgB,eAAe,CAAC,MAAoB;IAClD,cAAc,GAAG,MAAM,CAAC,QAAQ,CAAC;AACnC,CAAC;AAFD,0CAEC;AAED;;;GAGG;AACH,SAAgB,MAAM;IACpB,OAAO,cAAc,IAAI,aAAa,CAAC;AACzC,CAAC;AAFD,wBAEC;AAED,8DAA8D;AACvD,MAAM,OAAO,GAAG,KAAK,EAAE,IAAwB,EAAiB,EAAE;IACvE,IAAI;QACF,MAAM,IAAI,EAAE,CAAC;QACb,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAAC,OAAO,CAAC,EAAE;QACV,IAAI,OAAO,EAAE;YACX,MAAM,CAAC,CAAC;SACT;aAAM;YACL,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YAC9B,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;KACF;AACH,CAAC,CAAC;AAZW,QAAA,OAAO,WAYlB;AAEF,8DAA8D;AAC9D,OAAO,CAAC,EAAE,CAAC,oBAAoB,EAAE,CAAC,CAAM,EAAE,EAAE;IAC1C,IAAI,OAAO,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KAChB;IACD,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC;IACpE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@goldstack/utils-cli",
-  "version": "0.3.9",
+  "version": "0.3.11",
   "description": "Utilities for building command line interfaces.",
   "keywords": [
     "goldstack",
@@ -34,10 +34,14 @@
     "version:apply": "utils-git changed --exec \"yarn version $@ && yarn version apply\"",
     "version:apply:force": "yarn version $@ && yarn version apply"
   },
+  "dependencies": {
+    "pino": "^9.4.0",
+    "pino-pretty": "^11.2.2"
+  },
   "devDependencies": {
     "@goldstack/utils-git": "0.2.9",
-    "@swc/core": "^1.3.55",
-    "@swc/jest": "^0.2.26",
+    "@swc/core": "^1.3.74",
+    "@swc/jest": "^0.2.27",
     "@types/jest": "^29.0.1",
     "@types/node": "^18.7.13",
     "jest": "^29.3.1",