@unchainedshop/logger 1.1.0

package/README.md

@@ -0,0 +1,5 @@
+# Logger (Unchained Engine)
+
+This package handles logging for all modules.
+
+It exports two actions _log_ and _createLogger_ to log information based on the initial logger configuration.

package/babel.config.js

@@ -0,0 +1,3 @@
+export default {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+};

package/lib/createLogger.d.ts

@@ -0,0 +1,4 @@
+import { format, transports } from 'winston';
+import TransportStream from 'winston-transport';
+export { transports, format };
+export declare const createLogger: (moduleName: string, moreTransports?: Array<TransportStream>) => import("winston").Logger;

package/lib/createLogger.js

@@ -0,0 +1,51 @@
+import { createLogger as createWinstonLogger, format, transports } from 'winston';
+import stringify from 'safe-stable-stringify';
+import { LogLevel } from './logger.types';
+const { DEBUG = '', LOG_LEVEL = LogLevel.Info, UNCHAINED_LOG_FORMAT = 'unchained' } = process.env;
+const { combine, label, timestamp, colorize, printf, json } = format;
+const debugStringContainsModule = (debugString, moduleName) => {
+    if (!debugString)
+        return false;
+    const loggingMatched = debugString.split(',').reduce((accumulator, name) => {
+        if (accumulator === false)
+            return accumulator;
+        const nameRegex = name.replace(/-/i, '\\-?').replace(/:\*/i, '\\:?*').replace(/\*/i, '.*');
+        const regExp = new RegExp(`^${nameRegex}$`, 'm');
+        if (regExp.test(moduleName)) {
+            if (name.slice(0, 1) === '-') {
+                // explicitly disable
+                return false;
+            }
+            return true;
+        }
+        return accumulator;
+    }, undefined);
+    return loggingMatched || false;
+};
+const myFormat = printf(({ level, message, label: _label, timestamp: _timestamp, ...rest }) => {
+    const otherPropsString = stringify(rest);
+    return `[${_label}] ${level}: ${message} ${otherPropsString}`;
+});
+const UnchainedLogFormats = {
+    unchained: (moduleName) => combine(timestamp(), label({ label: moduleName }), colorize(), myFormat),
+    json,
+};
+if (!UnchainedLogFormats[UNCHAINED_LOG_FORMAT.toLowerCase()]) {
+    throw new Error(`UNCHAINED_LOG_FORMAT is invalid, use one of ${Object.keys(UnchainedLogFormats).join(',')}`);
+}
+export { transports, format };
+export const createLogger = (moduleName, moreTransports = []) => {
+    const loggingMatched = debugStringContainsModule(DEBUG, moduleName);
+    return createWinstonLogger({
+        transports: [
+            new transports.Console({
+                format: UnchainedLogFormats[UNCHAINED_LOG_FORMAT](moduleName),
+                stderrLevels: [LogLevel.Error],
+                consoleWarnLevels: [LogLevel.Warning],
+                level: loggingMatched ? LogLevel.Debug : LOG_LEVEL,
+            }),
+            ...moreTransports,
+        ],
+    });
+};
+//# sourceMappingURL=createLogger.js.map

package/lib/createLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createLogger.js","sourceRoot":"","sources":["../src/createLogger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,IAAI,mBAAmB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAClF,OAAO,SAAS,MAAM,uBAAuB,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,MAAM,EAAE,KAAK,GAAG,EAAE,EAAE,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,oBAAoB,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC;AAElG,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;AAErE,MAAM,yBAAyB,GAAG,CAAC,WAAmB,EAAE,UAAkB,EAAE,EAAE;IAC5E,IAAI,CAAC,WAAW;QAAE,OAAO,KAAK,CAAC;IAC/B,MAAM,cAAc,GAAG,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,WAAgB,EAAE,IAAY,EAAE,EAAE;QACtF,IAAI,WAAW,KAAK,KAAK;YAAE,OAAO,WAAW,CAAC;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC3F,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,SAAS,GAAG,EAAE,GAAG,CAAC,CAAC;QACjD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;YAC3B,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC5B,qBAAqB;gBACrB,OAAO,KAAK,CAAC;aACd;YACD,OAAO,IAAI,CAAC;SACb;QACD,OAAO,WAAW,CAAC;IACrB,CAAC,EAAE,SAAS,CAAC,CAAC;IACd,OAAO,cAAc,IAAI,KAAK,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,MAAM,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,EAAE,EAAE;IAC5F,MAAM,gBAAgB,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,IAAI,MAAM,KAAK,KAAK,KAAK,OAAO,IAAI,gBAAgB,EAAE,CAAC;AAChE,CAAC,CAAC,CAAC;AAEH,MAAM,mBAAmB,GAAG;IAC1B,SAAS,EAAE,CAAC,UAAkB,EAAE,EAAE,CAChC,OAAO,CAAC,SAAS,EAAE,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,QAAQ,CAAC;IAC1E,IAAI;CACL,CAAC;AAEF,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,WAAW,EAAE,CAAC,EAAE;IAC5D,MAAM,IAAI,KAAK,CACb,+CAA+C,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAC5F,CAAC;CACH;AAED,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,CAAC;AAE9B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,UAAkB,EAAE,iBAAyC,EAAE,EAAE,EAAE;IAC9F,MAAM,cAAc,GAAG,yBAAyB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACpE,OAAO,mBAAmB,CAAC;QACzB,UAAU,EAAE;YACV,IAAI,UAAU,CAAC,OAAO,CAAC;gBACrB,MAAM,EAAE,mBAAmB,CAAC,oBAAoB,CAAC,CAAC,UAAU,CAAC;gBAC7D,YAAY,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAC9B,iBAAiB,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACrC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;aACnD,CAAC;YACF,GAAG,cAAc;SAClB;KACF,CAAC,CAAC;AACL,CAAC,CAAC"}

package/lib/log.d.ts

@@ -0,0 +1,3 @@
+import winston from 'winston';
+import { LogOptions } from './logger.types';
+export declare const log: (message: string, options?: LogOptions) => winston.Logger;

package/lib/log.js

@@ -0,0 +1,8 @@
+import { LogLevel } from './logger.types';
+import { createLogger } from './createLogger';
+const logger = createLogger('unchained');
+export const log = (message, options) => {
+    const { level = LogLevel.Info, ...meta } = options || {};
+    return logger.log(level, message, meta);
+};
+//# sourceMappingURL=log.js.map

package/lib/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../src/log.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAc,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;AAEzC,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,OAAoB,EAAkB,EAAE;IAC3E,MAAM,EAAE,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACzD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAC1C,CAAC,CAAC"}

package/lib/logger-index.d.ts

@@ -0,0 +1,4 @@
+import { createLogger, format, transports } from './createLogger';
+import { LogLevel } from './logger.types';
+import { log } from './log';
+export { log, createLogger, format, transports, LogLevel };

package/lib/logger-index.js

@@ -0,0 +1,5 @@
+import { createLogger, format, transports } from './createLogger';
+import { LogLevel } from './logger.types';
+import { log } from './log';
+export { log, createLogger, format, transports, LogLevel };
+//# sourceMappingURL=logger-index.js.map

package/lib/logger-index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger-index.js","sourceRoot":"","sources":["../src/logger-index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAE5B,OAAO,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC"}

package/lib/logger.types.d.ts

@@ -0,0 +1,11 @@
+import { LoggerOptions } from 'winston';
+export declare enum LogLevel {
+    Verbose = "verbose",
+    Info = "info",
+    Debug = "debug",
+    Error = "error",
+    Warning = "warn"
+}
+export interface LogOptions extends LoggerOptions {
+    level: LogLevel;
+}

package/lib/logger.types.js

@@ -0,0 +1,9 @@
+export var LogLevel;
+(function (LogLevel) {
+    LogLevel["Verbose"] = "verbose";
+    LogLevel["Info"] = "info";
+    LogLevel["Debug"] = "debug";
+    LogLevel["Error"] = "error";
+    LogLevel["Warning"] = "warn";
+})(LogLevel || (LogLevel = {}));
+//# sourceMappingURL=logger.types.js.map

package/lib/logger.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.types.js","sourceRoot":"","sources":["../src/logger.types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,QAMX;AAND,WAAY,QAAQ;IAClB,+BAAmB,CAAA;IACnB,yBAAa,CAAA;IACb,2BAAe,CAAA;IACf,2BAAe,CAAA;IACf,4BAAgB,CAAA;AAClB,CAAC,EANW,QAAQ,KAAR,QAAQ,QAMnB"}

package/package.js

@@ -0,0 +1,21 @@
+Package.describe({
+  name: 'unchained:logger',
+  version: '1.1.0',
+  summary: 'Unchained Engine: Logger',
+  git: 'https://github.com/unchainedshop/unchained',
+  documentation: 'README.md',
+});
+
+Npm.depends({
+  'safe-stable-stringify': '2.3.1',
+  winston: '3.7.2',
+  'winston-transport': '4.5.0',
+});
+
+Package.onUse((api) => {
+  api.versionsFrom('2.7.3');
+  api.use('ecmascript');
+  api.use('typescript');
+
+  api.mainModule('src/logger-index.ts', 'server');
+});

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@unchainedshop/logger",
+  "version": "1.1.0",
+  "main": "lib/logger-index.js",
+  "types": "lib/logger-index.d.ts",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf lib",
+    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "watch": "tsc --watch",
+    "link:core": "npm link @unchainedshop/types",
+    "test": "jest --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/unchainedshop/unchained.git"
+  },
+  "keywords": [
+    "unchained",
+    "ecommerce",
+    "core"
+  ],
+  "author": "Joël Meiller",
+  "license": "EUPL-1.2",
+  "bugs": {
+    "url": "https://github.com/unchainedshop/unchained/issues"
+  },
+  "homepage": "https://github.com/unchainedshop/unchained#readme",
+  "dependencies": {
+    "safe-stable-stringify": "^2.3.1",
+    "winston": "^3.7.2",
+    "winston-transport": "^4.5.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.18.5",
+    "@babel/preset-env": "^7.18.2",
+    "@babel/preset-typescript": "^7.17.12",
+    "@types/chai": "^4.3.1",
+    "@types/jest": "^28.1.1",
+    "@types/mocha": "^9.1.1",
+    "@types/winston": "^2.4.4",
+    "@unchainedshop/types": "../@unchainedshop/types",
+    "babel-jest": "^28.1.1",
+    "chai": "^4.3.6",
+    "cross-env": "^7.0.3",
+    "jest": "^28.1.1",
+    "ts-jest": "^28.0.5",
+    "ts-node": "^10.8.1",
+    "typescript": "^4.7.3"
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "experimentalDecorators": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["esnext"],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noImplicitReturns": true,
+    "noUnusedLocals": false,
+    "outDir": "lib",
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "sourceMap": true,
+    "target": "esnext",
+    "types": ["node"]
+  },
+  "include": ["src"]
+}
+