@orion-js/logger 3.1.0-alpha.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Orionjs Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  roots: ['./src'],
+  testMatch: ['**/__tests__/**/*.+(ts|tsx|js)', '**/?(*.)+(spec|test).+(ts|tsx|js)'],
+  transform: {
+    '^.+\\.(ts|tsx)$': 'ts-jest'
+  },
+  verbose: true
+}

package/lib/formats.d.ts

@@ -0,0 +1,6 @@
+import { transports } from 'winston';
+export declare const sentryFormat: import("logform").FormatWrap;
+export declare const textConsoleFormat: import("logform").Format;
+export declare const textConsoleTransport: transports.ConsoleTransportInstance;
+export declare const jsonConsoleFormat: import("logform").Format;
+export declare const jsonConsoleTransport: transports.ConsoleTransportInstance;

package/lib/formats.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonConsoleTransport = exports.jsonConsoleFormat = exports.textConsoleTransport = exports.textConsoleFormat = exports.sentryFormat = void 0;
+const winston_1 = require("winston");
+const util_1 = __importDefault(require("util"));
+const { metadata, timestamp, json, colorize, combine, printf } = winston_1.format;
+const metaError = (0, winston_1.format)(info => {
+    if (info.metadata && info.metadata.error && info.metadata.error instanceof Error) {
+        info.stack = info.metadata.error.stack;
+        info.metadata.error = info.metadata.error.message;
+    }
+    return info;
+});
+exports.sentryFormat = (0, winston_1.format)(info => {
+    const { path, label, ...extra } = info;
+    return {
+        ...extra,
+        tags: {
+            path: path || '',
+            request_id: label
+        }
+    };
+});
+exports.textConsoleFormat = combine(colorize(), metadata({ fillExcept: ['fileName', 'level', 'message', 'stack'] }), metaError(), timestamp(), printf(info => {
+    return `[${info.level}] [${info.timestamp}] ${info.fileName ? `[${info.fileName}]` : ''} ${info.message} ${info.stack ? `\n${info.stack}` : ''} ${util_1.default.inspect(info.metadata)}`;
+}));
+exports.textConsoleTransport = new winston_1.transports.Console({
+    handleExceptions: true,
+    format: exports.textConsoleFormat
+});
+exports.jsonConsoleFormat = combine(metadata({ fillExcept: ['fileName', 'level', 'message'] }), metaError(), timestamp(), json({ replacer: null, space: 2 }));
+exports.jsonConsoleTransport = new winston_1.transports.Console({
+    handleExceptions: true,
+    format: exports.jsonConsoleFormat
+});

package/lib/helpers/getFileName.d.ts

@@ -0,0 +1,3 @@
+export declare const getFileName: () => string;
+export declare const improveFileName: (path: string) => string;
+export declare const setFileName: (metadata: any) => void;

package/lib/helpers/getFileName.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFileName = exports.improveFileName = exports.getFileName = void 0;
+const getFileName = () => {
+    const stack = new Error().stack;
+    const lines = stack.split('\n');
+    const filePath = lines[4].split('(')[1].split(')')[0];
+    return (0, exports.improveFileName)(filePath);
+};
+exports.getFileName = getFileName;
+const improveFileName = (path) => {
+    if (path.includes('orionjs/packages')) {
+        return path.replace(/^.+\/orionjs\/packages\//, '@orion-js/');
+    }
+    return path;
+};
+exports.improveFileName = improveFileName;
+const setFileName = (metadata) => {
+    if (metadata.fileName)
+        return;
+    metadata.fileName = (0, exports.getFileName)();
+};
+exports.setFileName = setFileName;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './formats';
+export * from './logger';

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./formats"), exports);
+__exportStar(require("./logger"), exports);

package/lib/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.test.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
+(0, logger_1.setLogLevel)('debug');
+describe('Log', () => {
+    test('Test logs', () => {
+        logger_1.logger.debug('debug');
+        logger_1.logger.info('info');
+        logger_1.logger.warn('warn');
+    });
+});

package/lib/logger.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import winston from 'winston';
+export declare const winstonLogger: winston.Logger;
+export declare const configureLogger: (options: winston.LoggerOptions) => void;
+export declare const setLogLevel: (level: string) => string;
+export declare const addTransport: (transport: winston.transport) => winston.Logger;
+export declare const getLogger: (context: string) => winston.Logger;
+export declare const logger: {
+    debug: (message: string, metadata?: any) => winston.Logger;
+    info: (message: string, metadata?: any) => winston.Logger;
+    warn: (message: string, metadata?: any) => winston.Logger;
+    error: (message: string, error: Error, metadata?: any) => winston.Logger;
+    addContext: (module: NodeJS.Module) => any;
+    addMetadata: (metadata: any) => any;
+};
+export declare const addModuleContext: (moduleName: string, metadata: any) => void;

package/lib/logger.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addModuleContext = exports.logger = exports.getLogger = exports.addTransport = exports.setLogLevel = exports.configureLogger = exports.winstonLogger = void 0;
+const winston_1 = require("winston");
+const formats_1 = require("./formats");
+const getFileName_1 = require("./helpers/getFileName");
+const transports = [
+    process.env.ORION_DEV ? formats_1.textConsoleTransport : formats_1.jsonConsoleTransport
+];
+exports.winstonLogger = (0, winston_1.createLogger)({
+    levels: winston_1.config.npm.levels,
+    handleExceptions: true,
+    format: winston_1.format.errors({ stack: true }),
+    transports: transports
+});
+const configureLogger = (options) => {
+    return exports.winstonLogger.configure(options);
+};
+exports.configureLogger = configureLogger;
+const setLogLevel = (level) => {
+    return (exports.winstonLogger.level = level);
+};
+exports.setLogLevel = setLogLevel;
+const addTransport = (transport) => {
+    return exports.winstonLogger.add(transport);
+};
+exports.addTransport = addTransport;
+const getLogger = (context) => {
+    return exports.winstonLogger.child({ context });
+};
+exports.getLogger = getLogger;
+const createLogger = (logger) => {
+    return {
+        debug: (message, metadata = {}) => {
+            (0, getFileName_1.setFileName)(metadata);
+            return logger.debug(message, metadata);
+        },
+        info: (message, metadata = {}) => {
+            (0, getFileName_1.setFileName)(metadata);
+            return logger.info(message, metadata);
+        },
+        warn: (message, metadata = {}) => {
+            (0, getFileName_1.setFileName)(metadata);
+            return logger.warn(message, metadata);
+        },
+        error: (message, error, metadata = {}) => {
+            (0, getFileName_1.setFileName)(metadata);
+            return logger.error(message, { error, ...metadata });
+        },
+        addContext: (module) => {
+            if (module.id) {
+                const split = String(module.id).split('.orion/build/');
+                const fileName = split.length > 1 ? split[1] : split[0];
+                return createLogger(logger.child({ fileName }));
+            }
+            return createLogger(logger.child({}));
+        },
+        addMetadata: (metadata) => {
+            return createLogger(logger.child(metadata));
+        }
+    };
+};
+exports.logger = createLogger(exports.winstonLogger);
+const addModuleContext = (moduleName, metadata) => { };
+exports.addModuleContext = addModuleContext;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@orion-js/logger",
+  "version": "3.1.0-alpha.9",
+  "main": "lib/index.js",
+  "author": "nicolaslopezj",
+  "license": "MIT",
+  "scripts": {
+    "test": "ORION_DEV=1 jest",
+    "prepare": "yarn run build",
+    "clean": "rm -rf ./lib",
+    "build": "yarn run clean && tsc",
+    "watch": "tsc -w",
+    "upgrade-interactive": "yarn upgrade-interactive"
+  },
+  "dependencies": {
+    "object-hash": "^2.2.0",
+    "winston": "^3.6.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^27.0.2",
+    "jest": "27.3.1",
+    "ts-jest": "27.0.7",
+    "typescript": "^4.4.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "65ebf7047a46aa5e93e9066d82ca70f81d69f10c"
+}

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "strict": false,
+    "outDir": "./lib",
+    "rootDir": "./src",
+    "module": "commonjs",
+    "target": "es2020",
+    "moduleResolution": "node",
+    "lib": ["es2020"],
+    "declaration": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  }
+}