@commercetools-backend/loggers 0.0.0-CRAFT-1791-20251006162610

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) commercetools GmbH
+
+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/README.md

@@ -0,0 +1,94 @@
+# @commercetools-backend/loggers
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@commercetools-backend/loggers"><img src="https://badgen.net/npm/v/@commercetools-backend/loggers" alt="Latest release (latest dist-tag)" /></a> <a href="https://www.npmjs.com/package/@commercetools-backend/loggers"><img src="https://badgen.net/npm/v/@commercetools-backend/loggers/next" alt="Latest release (next dist-tag)" /></a> <a href="https://bundlephobia.com/result?p=@commercetools-backend/loggers"><img src="https://badgen.net/bundlephobia/minzip/@commercetools-backend/loggers" alt="Minified + GZipped size" /></a> <a href="https://github.com/commercetools/merchant-center-application-kit/blob/main/LICENSE"><img src="https://badgen.net/github/license/commercetools/merchant-center-application-kit" alt="GitHub license" /></a>
+</p>
+
+Opinionated JSON loggers for HTTP server applications.
+
+## Install
+
+```bash
+$ npm install --save @commercetools-backend/loggers
+```
+
+## Middlewares
+
+### Access logger
+
+Creates a logger to be used for HTTP requests access logs.
+
+```js
+const {
+  createAccessLoggerMiddleware,
+} = require('@commercetools-backend/loggers');
+
+app.use(createAccessLoggerMiddleware());
+```
+
+**Options**
+
+- `level` (_string_): The log level to be used. **Default: `info`**
+- `silent` (_boolean_): In case logs should be skipped. **Default: `false`**
+- `json` (_boolean_): To use the JSON formatter, otherwise falls back to CLI format. It's recommended to use the JSON formatter on production.
+- `formatters` (_Array of Winston formatters_): In case you want to pass additional Winston formatters.
+- `ignoreUrls` (_Array of string_): A list of URL paths to be ignored from being logged.
+
+## Application logger
+
+Creates a logger to be used programmatically in the application code.
+
+```js
+const { createApplicationLogger } = require('@commercetools-backend/loggers');
+
+const app = createApplicationLogger();
+
+app.info('Hey there', { meta: { name: 'Tom' } });
+```
+
+**Options**
+
+- `level` (_string_): The log level to be used. **Default: `info`**
+- `silent` (_boolean_): In case logs should be skipped. **Default: `false`**
+- `json` (_boolean_): To use the JSON formatter, otherwise falls back to CLI format. It's recommended to use the JSON formatter on production.
+- `formatters` (_Array of Winston formatters_): In case you want to pass additional Winston formatters.
+
+## Formatters
+
+The package provides some come Winston formatters that can be passed to the given loggers.
+
+### Rewrite fields
+
+This formatter allows to rewrite fields from the JSON logger. It can be useful for redacting insecure information, or to map certain fields to a specific format (for example for Kibana).
+
+```js
+const {
+  createAccessLoggerMiddleware,
+  rewriteFieldsFormatter,
+} = require('@commercetools-backend/loggers');
+
+app.use(
+  createAccessLoggerMiddleware({
+    formatters: [
+      rewriteFieldsFormatter({
+        fields: [
+          { from: 'level', to: 'logLevel' },
+          { from: 'meta.error.message', to: 'meta.errorMessage' },
+          {
+            from: 'meta.error',
+            to: 'meta.errorJsonString',
+            replaceValue: (value) => JSON.stringify(value),
+          },
+        ],
+      }),
+    ],
+  })
+);
+```
+
+**Options**
+
+- `fields` (_Array of RewriteField_): A `RewriteField` is an object with the following properties:
+  - `from` (_string_): A JSON path to one of the fields of the log information that needs to be rewritten. The field will be deleted.
+  - `to` (_string_): A JSON path to the new field that should be created.
+  - `replaceValue` (_function_): An optional function that takes the value from the original field and returns a new value for the field. It can be used for example to serialize the value with `JSON.stringify`.

package/dist/commercetools-backend-loggers.cjs.d.ts

@@ -0,0 +1,2 @@
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy1iYWNrZW5kLWxvZ2dlcnMuY2pzLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuL2RlY2xhcmF0aW9ucy9zcmMvaW5kZXguZC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSJ9

package/dist/commercetools-backend-loggers.cjs.dev.js

@@ -0,0 +1,156 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var expressWinston = require('express-winston');
+var winston = require('winston');
+var _defineProperty = require('@babel/runtime-corejs3/helpers/defineProperty');
+var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
+var _Array$isArray = require('@babel/runtime-corejs3/core-js-stable/array/is-array');
+var _someInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/some');
+var _Object$keys = require('@babel/runtime-corejs3/core-js-stable/object/keys');
+var _Object$getOwnPropertySymbols = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols');
+var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
+var _Object$getOwnPropertyDescriptor = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor');
+var _forEachInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/for-each');
+var _Object$getOwnPropertyDescriptors = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors');
+var _Object$defineProperties = require('@babel/runtime-corejs3/core-js-stable/object/define-properties');
+var _Object$defineProperty = require('@babel/runtime-corejs3/core-js-stable/object/define-property');
+var cloneDeep = require('lodash/cloneDeep');
+var getIn = require('lodash/get');
+var setIn = require('lodash/set');
+var unsetIn = require('lodash/unset');
+var logform = require('logform');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var expressWinston__default = /*#__PURE__*/_interopDefault(expressWinston);
+var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
+var _Array$isArray__default = /*#__PURE__*/_interopDefault(_Array$isArray);
+var _someInstanceProperty__default = /*#__PURE__*/_interopDefault(_someInstanceProperty);
+var _Object$keys__default = /*#__PURE__*/_interopDefault(_Object$keys);
+var _Object$getOwnPropertySymbols__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertySymbols);
+var _filterInstanceProperty__default = /*#__PURE__*/_interopDefault(_filterInstanceProperty);
+var _Object$getOwnPropertyDescriptor__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertyDescriptor);
+var _forEachInstanceProperty__default = /*#__PURE__*/_interopDefault(_forEachInstanceProperty);
+var _Object$getOwnPropertyDescriptors__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertyDescriptors);
+var _Object$defineProperties__default = /*#__PURE__*/_interopDefault(_Object$defineProperties);
+var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defineProperty);
+var cloneDeep__default = /*#__PURE__*/_interopDefault(cloneDeep);
+var getIn__default = /*#__PURE__*/_interopDefault(getIn);
+var setIn__default = /*#__PURE__*/_interopDefault(setIn);
+var unsetIn__default = /*#__PURE__*/_interopDefault(unsetIn);
+
+function ownKeys(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context2, _context3; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(t), !0)).call(_context2, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(t))).call(_context3, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
+const parseIps = request => {
+  const forwardedFor = request.headers['x-forwarded-for'];
+  if (!forwardedFor) {
+    return [];
+  }
+  const remoteAddresses = _Array$isArray__default["default"](forwardedFor) ? forwardedFor : forwardedFor.split(',');
+  return remoteAddresses;
+};
+const createAccessLogSkipper = options => request => {
+  var _context;
+  if (Boolean(options.silent)) {
+    return true;
+  }
+  const hasMatchingIgnoreUrl = _someInstanceProperty__default["default"](_context = options.ignoreUrls ?? []).call(_context, uriPathOrRegex => {
+    if (typeof uriPathOrRegex === 'string') {
+      return request.originalUrl === uriPathOrRegex;
+    }
+    return request.originalUrl.match(uriPathOrRegex);
+  });
+  return hasMatchingIgnoreUrl;
+};
+const mapRequestMetadata = request => {
+  try {
+    const remoteAddress = request.socket?.remoteAddress;
+    const proxyIps = parseIps(request);
+    const _proxyIps = _slicedToArray(proxyIps, 1),
+      clientIp = _proxyIps[0];
+    return _objectSpread({
+      clientIp: clientIp ?? remoteAddress,
+      proxyIps,
+      hostname: request.socket ? request.hostname : undefined
+    }, remoteAddress ? {
+      remoteAddress
+    } : {});
+  } catch (error) {
+    console.error(`Failed to parse request metadata`, error);
+    return {};
+  }
+};
+
+const createAccessLoggerMiddleware = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const formatters = winston__namespace["default"].format.combine(winston__namespace["default"].format.timestamp(), ...(options.formatters ?? []), options.json ? winston__namespace["default"].format.json() : winston__namespace["default"].format.cli());
+  const skip = createAccessLogSkipper(options);
+  return expressWinston__default["default"].logger({
+    level: options.level ?? 'info',
+    transports: [new winston__namespace["default"].transports.Console()],
+    format: formatters,
+    meta: true,
+    expressFormat: true,
+    // Use default morgan access log formatting
+    colorize: !options.json,
+    skip,
+    dynamicMeta: mapRequestMetadata
+  });
+};
+
+const createApplicationLogger = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const formatters = winston__namespace.format.combine(...(options.formatters ?? []), options.json ? winston__namespace.format.json() : winston__namespace.format.combine(winston__namespace.format.cli(), winston__namespace.format.simple()));
+  return winston__namespace.createLogger({
+    level: options.level ?? 'info',
+    format: formatters,
+    transports: [new winston__namespace.transports.Console({
+      silent: Boolean(options.silent)
+    })]
+  });
+};
+
+function rewriteField(info, field) {
+  const fromFieldValue = getIn__default["default"](info, field.from);
+  const preserveFromField = field.preserveFromField ?? false;
+  if (fromFieldValue) {
+    if (!preserveFromField) {
+      unsetIn__default["default"](info, field.from);
+    }
+    setIn__default["default"](info, field.to, field.replaceValue ? field.replaceValue(fromFieldValue) : fromFieldValue);
+  }
+}
+function rewriteFieldsFormatter(options) {
+  return logform.format(info => {
+    var _context;
+    const clone = cloneDeep__default["default"](info);
+    _forEachInstanceProperty__default["default"](_context = options.fields).call(_context, field => {
+      rewriteField(clone, field);
+    });
+    return clone;
+  })(options);
+}
+
+exports.createAccessLoggerMiddleware = createAccessLoggerMiddleware;
+exports.createApplicationLogger = createApplicationLogger;
+exports.rewriteFieldsFormatter = rewriteFieldsFormatter;

package/dist/commercetools-backend-loggers.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === "production") {
+  module.exports = require("./commercetools-backend-loggers.cjs.prod.js");
+} else {
+  module.exports = require("./commercetools-backend-loggers.cjs.dev.js");
+}

package/dist/commercetools-backend-loggers.cjs.prod.js

@@ -0,0 +1,156 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var expressWinston = require('express-winston');
+var winston = require('winston');
+var _defineProperty = require('@babel/runtime-corejs3/helpers/defineProperty');
+var _slicedToArray = require('@babel/runtime-corejs3/helpers/slicedToArray');
+var _Array$isArray = require('@babel/runtime-corejs3/core-js-stable/array/is-array');
+var _someInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/some');
+var _Object$keys = require('@babel/runtime-corejs3/core-js-stable/object/keys');
+var _Object$getOwnPropertySymbols = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols');
+var _filterInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/filter');
+var _Object$getOwnPropertyDescriptor = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor');
+var _forEachInstanceProperty = require('@babel/runtime-corejs3/core-js-stable/instance/for-each');
+var _Object$getOwnPropertyDescriptors = require('@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors');
+var _Object$defineProperties = require('@babel/runtime-corejs3/core-js-stable/object/define-properties');
+var _Object$defineProperty = require('@babel/runtime-corejs3/core-js-stable/object/define-property');
+var cloneDeep = require('lodash/cloneDeep');
+var getIn = require('lodash/get');
+var setIn = require('lodash/set');
+var unsetIn = require('lodash/unset');
+var logform = require('logform');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var expressWinston__default = /*#__PURE__*/_interopDefault(expressWinston);
+var winston__namespace = /*#__PURE__*/_interopNamespace(winston);
+var _Array$isArray__default = /*#__PURE__*/_interopDefault(_Array$isArray);
+var _someInstanceProperty__default = /*#__PURE__*/_interopDefault(_someInstanceProperty);
+var _Object$keys__default = /*#__PURE__*/_interopDefault(_Object$keys);
+var _Object$getOwnPropertySymbols__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertySymbols);
+var _filterInstanceProperty__default = /*#__PURE__*/_interopDefault(_filterInstanceProperty);
+var _Object$getOwnPropertyDescriptor__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertyDescriptor);
+var _forEachInstanceProperty__default = /*#__PURE__*/_interopDefault(_forEachInstanceProperty);
+var _Object$getOwnPropertyDescriptors__default = /*#__PURE__*/_interopDefault(_Object$getOwnPropertyDescriptors);
+var _Object$defineProperties__default = /*#__PURE__*/_interopDefault(_Object$defineProperties);
+var _Object$defineProperty__default = /*#__PURE__*/_interopDefault(_Object$defineProperty);
+var cloneDeep__default = /*#__PURE__*/_interopDefault(cloneDeep);
+var getIn__default = /*#__PURE__*/_interopDefault(getIn);
+var setIn__default = /*#__PURE__*/_interopDefault(setIn);
+var unsetIn__default = /*#__PURE__*/_interopDefault(unsetIn);
+
+function ownKeys(e, r) { var t = _Object$keys__default["default"](e); if (_Object$getOwnPropertySymbols__default["default"]) { var o = _Object$getOwnPropertySymbols__default["default"](e); r && (o = _filterInstanceProperty__default["default"](o).call(o, function (r) { return _Object$getOwnPropertyDescriptor__default["default"](e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context2, _context3; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty__default["default"](_context2 = ownKeys(Object(t), !0)).call(_context2, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors__default["default"] ? _Object$defineProperties__default["default"](e, _Object$getOwnPropertyDescriptors__default["default"](t)) : _forEachInstanceProperty__default["default"](_context3 = ownKeys(Object(t))).call(_context3, function (r) { _Object$defineProperty__default["default"](e, r, _Object$getOwnPropertyDescriptor__default["default"](t, r)); }); } return e; }
+const parseIps = request => {
+  const forwardedFor = request.headers['x-forwarded-for'];
+  if (!forwardedFor) {
+    return [];
+  }
+  const remoteAddresses = _Array$isArray__default["default"](forwardedFor) ? forwardedFor : forwardedFor.split(',');
+  return remoteAddresses;
+};
+const createAccessLogSkipper = options => request => {
+  var _context;
+  if (Boolean(options.silent)) {
+    return true;
+  }
+  const hasMatchingIgnoreUrl = _someInstanceProperty__default["default"](_context = options.ignoreUrls ?? []).call(_context, uriPathOrRegex => {
+    if (typeof uriPathOrRegex === 'string') {
+      return request.originalUrl === uriPathOrRegex;
+    }
+    return request.originalUrl.match(uriPathOrRegex);
+  });
+  return hasMatchingIgnoreUrl;
+};
+const mapRequestMetadata = request => {
+  try {
+    const remoteAddress = request.socket?.remoteAddress;
+    const proxyIps = parseIps(request);
+    const _proxyIps = _slicedToArray(proxyIps, 1),
+      clientIp = _proxyIps[0];
+    return _objectSpread({
+      clientIp: clientIp ?? remoteAddress,
+      proxyIps,
+      hostname: request.socket ? request.hostname : undefined
+    }, remoteAddress ? {
+      remoteAddress
+    } : {});
+  } catch (error) {
+    console.error(`Failed to parse request metadata`, error);
+    return {};
+  }
+};
+
+const createAccessLoggerMiddleware = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const formatters = winston__namespace["default"].format.combine(winston__namespace["default"].format.timestamp(), ...(options.formatters ?? []), options.json ? winston__namespace["default"].format.json() : winston__namespace["default"].format.cli());
+  const skip = createAccessLogSkipper(options);
+  return expressWinston__default["default"].logger({
+    level: options.level ?? 'info',
+    transports: [new winston__namespace["default"].transports.Console()],
+    format: formatters,
+    meta: true,
+    expressFormat: true,
+    // Use default morgan access log formatting
+    colorize: !options.json,
+    skip,
+    dynamicMeta: mapRequestMetadata
+  });
+};
+
+const createApplicationLogger = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const formatters = winston__namespace.format.combine(...(options.formatters ?? []), options.json ? winston__namespace.format.json() : winston__namespace.format.combine(winston__namespace.format.cli(), winston__namespace.format.simple()));
+  return winston__namespace.createLogger({
+    level: options.level ?? 'info',
+    format: formatters,
+    transports: [new winston__namespace.transports.Console({
+      silent: Boolean(options.silent)
+    })]
+  });
+};
+
+function rewriteField(info, field) {
+  const fromFieldValue = getIn__default["default"](info, field.from);
+  const preserveFromField = field.preserveFromField ?? false;
+  if (fromFieldValue) {
+    if (!preserveFromField) {
+      unsetIn__default["default"](info, field.from);
+    }
+    setIn__default["default"](info, field.to, field.replaceValue ? field.replaceValue(fromFieldValue) : fromFieldValue);
+  }
+}
+function rewriteFieldsFormatter(options) {
+  return logform.format(info => {
+    var _context;
+    const clone = cloneDeep__default["default"](info);
+    _forEachInstanceProperty__default["default"](_context = options.fields).call(_context, field => {
+      rewriteField(clone, field);
+    });
+    return clone;
+  })(options);
+}
+
+exports.createAccessLoggerMiddleware = createAccessLoggerMiddleware;
+exports.createApplicationLogger = createApplicationLogger;
+exports.rewriteFieldsFormatter = rewriteFieldsFormatter;

package/dist/commercetools-backend-loggers.esm.js

@@ -0,0 +1,114 @@
+import expressWinston from 'express-winston';
+import * as winston from 'winston';
+import winston__default from 'winston';
+import _defineProperty from '@babel/runtime-corejs3/helpers/esm/defineProperty';
+import _slicedToArray from '@babel/runtime-corejs3/helpers/esm/slicedToArray';
+import _Array$isArray from '@babel/runtime-corejs3/core-js-stable/array/is-array';
+import _someInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/some';
+import _Object$keys from '@babel/runtime-corejs3/core-js-stable/object/keys';
+import _Object$getOwnPropertySymbols from '@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols';
+import _filterInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/filter';
+import _Object$getOwnPropertyDescriptor from '@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor';
+import _forEachInstanceProperty from '@babel/runtime-corejs3/core-js-stable/instance/for-each';
+import _Object$getOwnPropertyDescriptors from '@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors';
+import _Object$defineProperties from '@babel/runtime-corejs3/core-js-stable/object/define-properties';
+import _Object$defineProperty from '@babel/runtime-corejs3/core-js-stable/object/define-property';
+import cloneDeep from 'lodash/cloneDeep';
+import getIn from 'lodash/get';
+import setIn from 'lodash/set';
+import unsetIn from 'lodash/unset';
+import { format } from 'logform';
+
+function ownKeys(e, r) { var t = _Object$keys(e); if (_Object$getOwnPropertySymbols) { var o = _Object$getOwnPropertySymbols(e); r && (o = _filterInstanceProperty(o).call(o, function (r) { return _Object$getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var _context2, _context3; var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? _forEachInstanceProperty(_context2 = ownKeys(Object(t), !0)).call(_context2, function (r) { _defineProperty(e, r, t[r]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : _forEachInstanceProperty(_context3 = ownKeys(Object(t))).call(_context3, function (r) { _Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r)); }); } return e; }
+const parseIps = request => {
+  const forwardedFor = request.headers['x-forwarded-for'];
+  if (!forwardedFor) {
+    return [];
+  }
+  const remoteAddresses = _Array$isArray(forwardedFor) ? forwardedFor : forwardedFor.split(',');
+  return remoteAddresses;
+};
+const createAccessLogSkipper = options => request => {
+  var _context;
+  if (Boolean(options.silent)) {
+    return true;
+  }
+  const hasMatchingIgnoreUrl = _someInstanceProperty(_context = options.ignoreUrls ?? []).call(_context, uriPathOrRegex => {
+    if (typeof uriPathOrRegex === 'string') {
+      return request.originalUrl === uriPathOrRegex;
+    }
+    return request.originalUrl.match(uriPathOrRegex);
+  });
+  return hasMatchingIgnoreUrl;
+};
+const mapRequestMetadata = request => {
+  try {
+    const remoteAddress = request.socket?.remoteAddress;
+    const proxyIps = parseIps(request);
+    const _proxyIps = _slicedToArray(proxyIps, 1),
+      clientIp = _proxyIps[0];
+    return _objectSpread({
+      clientIp: clientIp ?? remoteAddress,
+      proxyIps,
+      hostname: request.socket ? request.hostname : undefined
+    }, remoteAddress ? {
+      remoteAddress
+    } : {});
+  } catch (error) {
+    console.error(`Failed to parse request metadata`, error);
+    return {};
+  }
+};
+
+const createAccessLoggerMiddleware = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const formatters = winston__default.format.combine(winston__default.format.timestamp(), ...(options.formatters ?? []), options.json ? winston__default.format.json() : winston__default.format.cli());
+  const skip = createAccessLogSkipper(options);
+  return expressWinston.logger({
+    level: options.level ?? 'info',
+    transports: [new winston__default.transports.Console()],
+    format: formatters,
+    meta: true,
+    expressFormat: true,
+    // Use default morgan access log formatting
+    colorize: !options.json,
+    skip,
+    dynamicMeta: mapRequestMetadata
+  });
+};
+
+const createApplicationLogger = function () {
+  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const formatters = winston.format.combine(...(options.formatters ?? []), options.json ? winston.format.json() : winston.format.combine(winston.format.cli(), winston.format.simple()));
+  return winston.createLogger({
+    level: options.level ?? 'info',
+    format: formatters,
+    transports: [new winston.transports.Console({
+      silent: Boolean(options.silent)
+    })]
+  });
+};
+
+function rewriteField(info, field) {
+  const fromFieldValue = getIn(info, field.from);
+  const preserveFromField = field.preserveFromField ?? false;
+  if (fromFieldValue) {
+    if (!preserveFromField) {
+      unsetIn(info, field.from);
+    }
+    setIn(info, field.to, field.replaceValue ? field.replaceValue(fromFieldValue) : fromFieldValue);
+  }
+}
+function rewriteFieldsFormatter(options) {
+  return format(info => {
+    var _context;
+    const clone = cloneDeep(info);
+    _forEachInstanceProperty(_context = options.fields).call(_context, field => {
+      rewriteField(clone, field);
+    });
+    return clone;
+  })(options);
+}
+
+export { createAccessLoggerMiddleware, createApplicationLogger, rewriteFieldsFormatter };

package/dist/declarations/src/create-application-logger.d.ts

@@ -0,0 +1,4 @@
+import * as winston from 'winston';
+import type { TLoggerOptions } from "./types.js";
+declare const createApplicationLogger: (options?: TLoggerOptions) => winston.Logger;
+export default createApplicationLogger;

package/dist/declarations/src/formatters/rewrite-fields.d.ts

@@ -0,0 +1,11 @@
+type TRewriteField = {
+    from: string;
+    to: string;
+    replaceValue?: (value: unknown) => unknown;
+    preserveFromField?: boolean;
+};
+type TRewriteFieldsFormatterOption = {
+    fields: TRewriteField[];
+};
+declare function rewriteFieldsFormatter(options: TRewriteFieldsFormatterOption): import("logform").Format;
+export default rewriteFieldsFormatter;

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,3 @@
+export { default as createAccessLoggerMiddleware } from "./middlewares/create-access-logger.js";
+export { default as createApplicationLogger } from "./create-application-logger.js";
+export { default as rewriteFieldsFormatter } from "./formatters/rewrite-fields.js";

package/dist/declarations/src/middlewares/create-access-logger.d.ts

@@ -0,0 +1,5 @@
+import expressWinston from 'express-winston';
+import type { TAccessLoggerOptions } from "../types.js";
+type TAccessLoggerMiddleware = ReturnType<typeof expressWinston.logger>;
+declare const createAccessLoggerMiddleware: (options?: TAccessLoggerOptions) => TAccessLoggerMiddleware;
+export default createAccessLoggerMiddleware;

package/dist/declarations/src/types.d.ts

@@ -0,0 +1,10 @@
+import type { Format } from 'logform';
+export type TLoggerOptions = {
+    level?: string;
+    silent?: boolean;
+    json?: boolean;
+    formatters?: Format[];
+};
+export type TAccessLoggerOptions = TLoggerOptions & {
+    ignoreUrls?: (string | RegExp)[];
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@commercetools-backend/loggers",
+  "version": "0.0.0-CRAFT-1791-20251006162610",
+  "description": "Opinionated JSON loggers for HTTP server applications",
+  "bugs": "https://github.com/commercetools/merchant-center-application-kit/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/commercetools/merchant-center-application-kit.git",
+    "directory": "packages-backend/loggers"
+  },
+  "homepage": "https://docs.commercetools.com/merchant-center-customizations",
+  "keywords": [
+    "javascript",
+    "nodejs",
+    "express",
+    "logger",
+    "server",
+    "toolkit"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/commercetools-backend-loggers.cjs.js",
+  "module": "dist/commercetools-backend-loggers.esm.js",
+  "files": [
+    "dist",
+    "package.json",
+    "LICENSE",
+    "README.md"
+  ],
+  "dependencies": {
+    "@babel/runtime": "^7.22.15",
+    "@babel/runtime-corejs3": "^7.22.15",
+    "@types/lodash": "^4.14.198",
+    "@types/triple-beam": "1.3.5",
+    "express-winston": "4.2.0",
+    "fast-safe-stringify": "2.1.1",
+    "lodash": "4.17.21",
+    "logform": "2.7.0",
+    "triple-beam": "1.4.1",
+    "winston": "3.17.0"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.0",
+    "@types/express": "^4.17.17",
+    "express": "^4.21.2",
+    "typescript": "^5.2.2"
+  },
+  "engines": {
+    "node": "18.x || 20.x || >=22.0.0"
+  }
+}