@kcuf/sls-logger-base 0.0.2 → 0.0.4

package/dist/cjs/class/sls-logger.js

@@ -61,7 +61,7 @@ var SlsLogger = exports.default = /*#__PURE__*/function () {
         flatten = _options2.flatten;
       var finalTopic = prefix ? "".concat(prefix).concat(topic) : topic;
       var onceKey = (0, _util.getLogOnceKey)(finalTopic, once);
-      if (_this.shouldIgnore(sampling, onceKey)) {
+      if (_this.dontSend(sampling, onceKey)) {
         return;
       }
       if (onceKey) {
@@ -92,20 +92,20 @@ var SlsLogger = exports.default = /*#__PURE__*/function () {
     });
   }
   return (0, _createClass2.default)(SlsLogger, [{
-    key: "shouldIgnore",
+    key: "dontSend",
     value:
     /**
      * 检查是否需要忽略
      */
-    function shouldIgnore(sampling, onceKey) {
-      var _shouldIgnore;
-      var shouldIgnore = this.options.shouldIgnore;
+    function dontSend(sampling, onceKey) {
+      var _dontSend;
+      var dontSend = this.options.dontSend;
       if (onceKey && this.once[onceKey]) {
         // 只需发送一次，已发送过，忽略
         return true;
       }
-      if (((_shouldIgnore = shouldIgnore) === null || _shouldIgnore === void 0 ? void 0 : _shouldIgnore()) === true) {
-        // shouldIgnore 阻止发送
+      if (((_dontSend = dontSend) === null || _dontSend === void 0 ? void 0 : _dontSend()) === true) {
+        // dontSend 阻止发送
         return true;
       }
       if (typeof sampling === 'number' && sampling > 0 && sampling < 1) {

package/dist/cjs/factory/generate-create-logger.js

@@ -9,7 +9,7 @@ var _objectSpread2 = _interopRequireDefault(require("@babel/runtime/helpers/obje
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _util = require("../util");
 var _createLogger = _interopRequireDefault(require("./create-logger"));
-var _excluded = ["defaultParams", "shouldIgnore"];
+var _excluded = ["defaultParams", "dontSend"];
 /**
  * 创建 `createLogger` 方法的方法，对期望扩展默认参数的场景做了规范。
  *
@@ -17,14 +17,14 @@ var _excluded = ["defaultParams", "shouldIgnore"];
  */
 function generateCreateLogger(sender, _ref) {
   var factoryDefaultParams = _ref.defaultParams,
-    factoryShouldIgnore = _ref.shouldIgnore;
+    factoryDontSend = _ref.dontSend;
   return function (_ref2) {
     var defaultParams = _ref2.defaultParams,
-      shouldIgnore = _ref2.shouldIgnore,
+      dontSend = _ref2.dontSend,
       options = (0, _objectWithoutProperties2.default)(_ref2, _excluded);
     return (0, _createLogger.default)(sender, (0, _objectSpread2.default)({
       defaultParams: (0, _util.mergeDefaultParams)(factoryDefaultParams, defaultParams),
-      shouldIgnore: (0, _util.mergeShouldIgnore)(factoryShouldIgnore, shouldIgnore)
+      dontSend: (0, _util.mergeDontSend)(factoryDontSend, dontSend)
     }, options));
   };
 }

package/dist/cjs/util/flatten-object.js

@@ -11,7 +11,7 @@ var _isPlainObject2 = _interopRequireDefault(require("lodash/isPlainObject"));
 var _isError2 = _interopRequireDefault(require("lodash/isError"));
 var _forEach2 = _interopRequireDefault(require("lodash/forEach"));
 var _convertErrorToPlain = _interopRequireDefault(require("./convert-error-to-plain"));
-var _flattenShouldIgnore = _interopRequireDefault(require("./flatten-should-ignore"));
+var _flattenTestPath = _interopRequireDefault(require("./flatten-test-path"));
 /**
  * 有时候为了统计方便，需要把传入的对象展平，比如 error 对象，可能会展平成如下形状：
  *
@@ -30,7 +30,8 @@ function flattenObject(o, options) {
   var scope = resolvedOptions.scope,
     _resolvedOptions$dept = resolvedOptions.depth,
     depth = _resolvedOptions$dept === void 0 ? 5 : _resolvedOptions$dept,
-    ignore = resolvedOptions.ignore;
+    omit = resolvedOptions.omit,
+    pass = resolvedOptions.pass;
   var result = {};
   function makeSureErrorObject(errorOrObject) {
     return (0, _isError2.default)(errorOrObject) ? (0, _convertErrorToPlain.default)(errorOrObject) : errorOrObject;
@@ -38,18 +39,22 @@ function flattenObject(o, options) {
   function loop(currentObj, parentPaths) {
     var depthFull = depth > 0 && parentPaths.length + 1 >= depth;
     (0, _forEach2.default)(currentObj, function (v, k) {
-      var key = [].concat((0, _toConsumableArray2.default)(parentPaths), [k]).join('.');
-      var scopedKey = scope ? "".concat(scope, ".").concat(key) : key;
+      var pathKey = [].concat((0, _toConsumableArray2.default)(parentPaths), [k]).join('.');
+      var scopedPathKey = scope ? "".concat(scope, ".").concat(pathKey) : pathKey;
 
-      // 可以忽略不重要的信息
-      if ((0, _flattenShouldIgnore.default)(ignore, key, k, v)) {
+      // 可以忽略不重要的信息，默认不记录 `_` 打头的所有数据
+      if (/^_/.test(k) || omit && (0, _flattenTestPath.default)(pathKey, omit)) {
         return;
       }
       var vAsObject = makeSureErrorObject(v);
 
-      // 深度满了，或者不是对象或 Error，或者空对象（或数组），则不继续 loop
-      if (depthFull || !(0, _isPlainObject2.default)(vAsObject) || (0, _isEmpty2.default)(vAsObject)) {
-        result[scopedKey] = vAsObject;
+      // 不继续 loop：
+      // 1. 深度满了
+      // 2. 不是对象，不是 Error
+      // 3. 空对象，或空数组
+      // 4. 命中 `pass` 规则
+      if (depthFull || !(0, _isPlainObject2.default)(vAsObject) || (0, _isEmpty2.default)(vAsObject) || pass && (0, _flattenTestPath.default)(pathKey, pass)) {
+        result[scopedPathKey] = vAsObject;
         return;
       }
       loop(vAsObject, [].concat((0, _toConsumableArray2.default)(parentPaths), [k]));

package/dist/cjs/util/flatten-test-path.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = flattenTestPath;
+function flattenTestPath(path, tester) {
+  return (Array.isArray(tester) ? tester : [tester]).some(function (v) {
+    return typeof v === 'string' ? v === path : v.test(path);
+  });
+}

package/dist/cjs/util/index.js

@@ -46,10 +46,10 @@ Object.defineProperty(exports, "mergeDefaultParams", {
     return _mergeDefaultParams.default;
   }
 });
-Object.defineProperty(exports, "mergeShouldIgnore", {
+Object.defineProperty(exports, "mergeDontSend", {
   enumerable: true,
   get: function get() {
-    return _mergeShouldIgnore.default;
+    return _mergeDontSend.default;
   }
 });
 Object.defineProperty(exports, "resolveDefaultParams", {
@@ -66,4 +66,4 @@ var _convertErrorToPlain = _interopRequireDefault(require("./convert-error-to-pl
 var _resolveDefaultParams = _interopRequireDefault(require("./resolve-default-params"));
 var _createSlsLogQuick = _interopRequireDefault(require("./create-sls-log-quick"));
 var _mergeDefaultParams = _interopRequireDefault(require("./merge-default-params"));
-var _mergeShouldIgnore = _interopRequireDefault(require("./merge-should-ignore"));
+var _mergeDontSend = _interopRequireDefault(require("./merge-dont-send"));

package/dist/cjs/util/merge-dont-send.js

@@ -0,0 +1,14 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = mergeDontSend;
+function mergeDontSend(factoryDontSend, dontSend) {
+  if (!factoryDontSend || !dontSend) {
+    return dontSend || factoryDontSend;
+  }
+  return function () {
+    return factoryDontSend() || dontSend();
+  };
+}

package/dist/esm/class/sls-logger.js

@@ -55,7 +55,7 @@ var SlsLogger = /*#__PURE__*/function () {
         flatten = _options2.flatten;
       var finalTopic = prefix ? "".concat(prefix).concat(topic) : topic;
       var onceKey = getLogOnceKey(finalTopic, once);
-      if (_this.shouldIgnore(sampling, onceKey)) {
+      if (_this.dontSend(sampling, onceKey)) {
         return;
       }
       if (onceKey) {
@@ -86,20 +86,20 @@ var SlsLogger = /*#__PURE__*/function () {
     });
   }
   return _createClass(SlsLogger, [{
-    key: "shouldIgnore",
+    key: "dontSend",
     value:
     /**
      * 检查是否需要忽略
      */
-    function shouldIgnore(sampling, onceKey) {
-      var _shouldIgnore;
-      var shouldIgnore = this.options.shouldIgnore;
+    function dontSend(sampling, onceKey) {
+      var _dontSend;
+      var dontSend = this.options.dontSend;
       if (onceKey && this.once[onceKey]) {
         // 只需发送一次，已发送过，忽略
         return true;
       }
-      if (((_shouldIgnore = shouldIgnore) === null || _shouldIgnore === void 0 ? void 0 : _shouldIgnore()) === true) {
-        // shouldIgnore 阻止发送
+      if (((_dontSend = dontSend) === null || _dontSend === void 0 ? void 0 : _dontSend()) === true) {
+        // dontSend 阻止发送
         return true;
       }
       if (typeof sampling === 'number' && sampling > 0 && sampling < 1) {

package/dist/esm/class/sls-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"sls-logger.js","names":["_isError","API_VERSION","PIPE_SILENT_TIME","PIPE_WAIT_TIME","PIPE_MAX_CHUNK","getLogOnceKey","flattenObject","convertErrorToPlain","resolveDefaultParams","SlsPipe","SlsLogger","sender","options","_this","_options$silentTime","_options$waitTime","_options$maxChunk","_classCallCheck","_defineProperty","topic","payload","_len","arguments","length","args","Array","_key","_ref","_ref2","_slicedToArray","_ref3","_ref4","_this$options","factoryPrefix","prefix","factorySampling","sampling","defaultParams","_options2","_options2$group","group","_options2$prefix","_options2$sampling","instant","once","flatten","finalTopic","concat","onceKey","shouldIgnore","plainInfo","slsPipe","pipe","_objectSpread","__topic__","_GROUP","trackUrl","project","endpoint","logstore","apiVersion","silentTime","waitTime","maxChunk","_createClass","key","value","_shouldIgnore","Math","random","default"],"sources":["../../../src/class/sls-logger.ts"],"sourcesContent":["import _isError from 'lodash/isError';\n\nimport {\n  TLogArgs,\n  ICreateLoggerOptions,\n  ILogSender,\n  ISlsLogOptions,\n  ISlsLogFn\n} from '../types';\nimport {\n  API_VERSION,\n  PIPE_SILENT_TIME,\n  PIPE_WAIT_TIME,\n  PIPE_MAX_CHUNK\n} from '../const';\nimport {\n  getLogOnceKey,\n  flattenObject,\n  convertErrorToPlain,\n  resolveDefaultParams\n} from '../util';\n\nimport SlsPipe from './sls-pipe';\n\n/**\n * 创建 SLS 日志方法\n */\nexport default class SlsLogger {\n  private readonly options: ICreateLoggerOptions;\n  private readonly slsPipe: SlsPipe;\n  private once: Record<string, 1> = {};\n  \n  constructor(sender: ILogSender, options: ICreateLoggerOptions) {\n    this.options = options;\n    this.slsPipe = new SlsPipe(sender, {\n      trackUrl: `https://${options.project}.${options.endpoint}/logstores/${options.logstore}/track`,\n      apiVersion: options.apiVersion || API_VERSION,\n      silentTime: options.silentTime ?? PIPE_SILENT_TIME,\n      waitTime: options.waitTime ?? PIPE_WAIT_TIME,\n      maxChunk: options.maxChunk ?? PIPE_MAX_CHUNK\n    });\n  }\n  \n  log: ISlsLogFn = (...args: TLogArgs): void => {\n    let options: ISlsLogOptions = {};\n    let topic: string;\n    let payload: Record<string, unknown> | undefined;\n    \n    if (typeof args[0] === 'string') {\n      [topic, payload] = args as [string, Record<string, unknown>?];\n    } else {\n      [options, topic, payload] = args as [ISlsLogOptions, string, Record<string, unknown>?];\n    }\n    \n    const {\n      options: {\n        prefix: factoryPrefix,\n        sampling: factorySampling,\n        defaultParams\n      }\n    } = this;\n    const {\n      group = 'LOG',\n      prefix = factoryPrefix,\n      sampling = factorySampling,\n      instant,\n      once,\n      flatten\n    } = options;\n    const finalTopic = prefix ? `${prefix}${topic}` : topic;\n    const onceKey: string | undefined = getLogOnceKey(finalTopic, once);\n    \n    if (this.shouldIgnore(sampling, onceKey)) {\n      return;\n    }\n    \n    if (onceKey) {\n      this.once[onceKey] = 1;\n    }\n    \n    let plainInfo: object | undefined;\n    \n    if (payload) {\n      if (flatten) {\n        plainInfo = flattenObject(payload, flatten === true ? '' : flatten);\n      } else if (_isError(payload)) {\n        plainInfo = convertErrorToPlain(payload);\n      } else {\n        plainInfo = payload;\n      }\n    }\n    \n    this.slsPipe.pipe({\n      ...resolveDefaultParams(defaultParams),\n      ...plainInfo,\n      __topic__: finalTopic,\n      _GROUP: group\n    }, instant);\n  };\n  \n  /**\n   * 检查是否需要忽略\n   */\n  private shouldIgnore(sampling?: number, onceKey?: string): boolean {\n    const {\n      options: {\n        shouldIgnore\n      }\n    } = this;\n    \n    if (onceKey && this.once[onceKey]) { // 只需发送一次，已发送过，忽略\n      return true;\n    }\n    \n    if (shouldIgnore?.() === true) { // shouldIgnore 阻止发送\n      return true;\n    }\n    \n    if (typeof sampling === 'number' && sampling > 0 && sampling < 1) { // 采样，`(0, 1)` 开区间\n      return Math.random() > sampling;\n    }\n    \n    return false;\n  }\n}"],"mappings":";;;;;;AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AASrC,SACEC,WAAW,EACXC,gBAAgB,EAChBC,cAAc,EACdC,cAAc,QACT,UAAU;AACjB,SACEC,aAAa,EACbC,aAAa,EACbC,mBAAmB,EACnBC,oBAAoB,QACf,SAAS;AAEhB,OAAOC,OAAO,MAAM,YAAY;;AAEhC;AACA;AACA;AAFA,IAGqBC,SAAS;EAK5B,SAAAA,UAAYC,MAAkB,EAAEC,QAA6B,EAAE;IAAA,IAAAC,KAAA;MAAAC,mBAAA;MAAAC,iBAAA;MAAAC,iBAAA;IAAAC,eAAA,OAAAP,SAAA;IAAAQ,eAAA,eAF7B,CAAC,CAAC;IAAAA,eAAA,cAanB,YAA6B;MAC5C,IAAIN,OAAuB,GAAG,CAAC,CAAC;MAChC,IAAIO,KAAa;MACjB,IAAIC,OAA4C;MAAC,SAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,EAH9BC,IAAI,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;QAAJF,IAAI,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;MAAA;MAKvB,IAAI,OAAOF,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;QAAA,IAAAG,IAAA,GACZH,IAAI;QAAA,IAAAI,KAAA,GAAAC,cAAA,CAAAF,IAAA;QAAtBR,KAAK,GAAAS,KAAA;QAAER,OAAO,GAAAQ,KAAA;MACjB,CAAC,MAAM;QAAA,IAAAE,KAAA,GACuBN,IAAI;QAAA,IAAAO,KAAA,GAAAF,cAAA,CAAAC,KAAA;QAA/BlB,OAAO,GAAAmB,KAAA;QAAEZ,KAAK,GAAAY,KAAA;QAAEX,OAAO,GAAAW,KAAA;MAC1B;MAEA,IAAAC,aAAA,GAMInB,KAAI,CALND,OAAO;QACGqB,aAAa,GAAAD,aAAA,CAArBE,MAAM;QACIC,eAAe,GAAAH,aAAA,CAAzBI,QAAQ;QACRC,aAAa,GAAAL,aAAA,CAAbK,aAAa;MAGjB,IAAAC,SAAA,GAOI1B,OAAO;QAAA2B,eAAA,GAAAD,SAAA,CANTE,KAAK;QAALA,KAAK,GAAAD,eAAA,cAAG,KAAK,GAAAA,eAAA;QAAAE,gBAAA,GAAAH,SAAA,CACbJ,MAAM;QAANA,MAAM,GAAAO,gBAAA,cAAGR,aAAa,GAAAQ,gBAAA;QAAAC,kBAAA,GAAAJ,SAAA,CACtBF,QAAQ;QAARA,QAAQ,GAAAM,kBAAA,cAAGP,eAAe,GAAAO,kBAAA;QAC1BC,OAAO,GAAAL,SAAA,CAAPK,OAAO;QACPC,IAAI,GAAAN,SAAA,CAAJM,IAAI;QACJC,OAAO,GAAAP,SAAA,CAAPO,OAAO;MAET,IAAMC,UAAU,GAAGZ,MAAM,MAAAa,MAAA,CAAMb,MAAM,EAAAa,MAAA,CAAG5B,KAAK,IAAKA,KAAK;MACvD,IAAM6B,OAA2B,GAAG3C,aAAa,CAACyC,UAAU,EAAEF,IAAI,CAAC;MAEnE,IAAI/B,KAAI,CAACoC,YAAY,CAACb,QAAQ,EAAEY,OAAO,CAAC,EAAE;QACxC;MACF;MAEA,IAAIA,OAAO,EAAE;QACXnC,KAAI,CAAC+B,IAAI,CAACI,OAAO,CAAC,GAAG,CAAC;MACxB;MAEA,IAAIE,SAA6B;MAEjC,IAAI9B,OAAO,EAAE;QACX,IAAIyB,OAAO,EAAE;UACXK,SAAS,GAAG5C,aAAa,CAACc,OAAO,EAAEyB,OAAO,KAAK,IAAI,GAAG,EAAE,GAAGA,OAAO,CAAC;QACrE,CAAC,MAAM,IAAI7C,QAAQ,CAACoB,OAAO,CAAC,EAAE;UAC5B8B,SAAS,GAAG3C,mBAAmB,CAACa,OAAO,CAAC;QAC1C,CAAC,MAAM;UACL8B,SAAS,GAAG9B,OAAO;QACrB;MACF;MAEAP,KAAI,CAACsC,OAAO,CAACC,IAAI,CAAAC,aAAA,CAAAA,aAAA,CAAAA,aAAA,KACZ7C,oBAAoB,CAAC6B,aAAa,CAAC,GACnCa,SAAS;QACZI,SAAS,EAAER,UAAU;QACrBS,MAAM,EAAEf;MAAK,IACZG,OAAO,CAAC;IACb,CAAC;IAjEC,IAAI,CAAC/B,OAAO,GAAGA,QAAO;IACtB,IAAI,CAACuC,OAAO,GAAG,IAAI1C,OAAO,CAACE,MAAM,EAAE;MACjC6C,QAAQ,aAAAT,MAAA,CAAanC,QAAO,CAAC6C,OAAO,OAAAV,MAAA,CAAInC,QAAO,CAAC8C,QAAQ,iBAAAX,MAAA,CAAcnC,QAAO,CAAC+C,QAAQ,WAAQ;MAC9FC,UAAU,EAAEhD,QAAO,CAACgD,UAAU,IAAI3D,WAAW;MAC7C4D,UAAU,GAAA/C,mBAAA,GAAEF,QAAO,CAACiD,UAAU,cAAA/C,mBAAA,cAAAA,mBAAA,GAAIZ,gBAAgB;MAClD4D,QAAQ,GAAA/C,iBAAA,GAAEH,QAAO,CAACkD,QAAQ,cAAA/C,iBAAA,cAAAA,iBAAA,GAAIZ,cAAc;MAC5C4D,QAAQ,GAAA/C,iBAAA,GAAEJ,QAAO,CAACmD,QAAQ,cAAA/C,iBAAA,cAAAA,iBAAA,GAAIZ;IAChC,CAAC,CAAC;EACJ;EAAC,OAAA4D,YAAA,CAAAtD,SAAA;IAAAuD,GAAA;IAAAC,KAAA;IA2DD;AACF;AACA;IACE,SAAQjB,YAAYA,CAACb,QAAiB,EAAEY,OAAgB,EAAW;MAAA,IAAAmB,aAAA;MACjE,IAEIlB,YAAY,GAEZ,IAAI,CAHNrC,OAAO,CACLqC,YAAY;MAIhB,IAAID,OAAO,IAAI,IAAI,CAACJ,IAAI,CAACI,OAAO,CAAC,EAAE;QAAE;QACnC,OAAO,IAAI;MACb;MAEA,IAAI,EAAAmB,aAAA,GAAAlB,YAAY,cAAAkB,aAAA,uBAAZA,aAAA,CAAe,CAAC,MAAK,IAAI,EAAE;QAAE;QAC/B,OAAO,IAAI;MACb;MAEA,IAAI,OAAO/B,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,GAAG,CAAC,IAAIA,QAAQ,GAAG,CAAC,EAAE;QAAE;QAClE,OAAOgC,IAAI,CAACC,MAAM,CAAC,CAAC,GAAGjC,QAAQ;MACjC;MAEA,OAAO,KAAK;IACd;EAAC;AAAA;AAAA,SAhGkB1B,SAAS,IAAA4D,OAAA","ignoreList":[]}
+{"version":3,"file":"sls-logger.js","names":["_isError","API_VERSION","PIPE_SILENT_TIME","PIPE_WAIT_TIME","PIPE_MAX_CHUNK","getLogOnceKey","flattenObject","convertErrorToPlain","resolveDefaultParams","SlsPipe","SlsLogger","sender","options","_this","_options$silentTime","_options$waitTime","_options$maxChunk","_classCallCheck","_defineProperty","topic","payload","_len","arguments","length","args","Array","_key","_ref","_ref2","_slicedToArray","_ref3","_ref4","_this$options","factoryPrefix","prefix","factorySampling","sampling","defaultParams","_options2","_options2$group","group","_options2$prefix","_options2$sampling","instant","once","flatten","finalTopic","concat","onceKey","dontSend","plainInfo","slsPipe","pipe","_objectSpread","__topic__","_GROUP","trackUrl","project","endpoint","logstore","apiVersion","silentTime","waitTime","maxChunk","_createClass","key","value","_dontSend","Math","random","default"],"sources":["../../../src/class/sls-logger.ts"],"sourcesContent":["import _isError from 'lodash/isError';\n\nimport {\n  TLogArgs,\n  ICreateLoggerOptions,\n  ILogSender,\n  ISlsLogOptions,\n  ISlsLogFn\n} from '../types';\nimport {\n  API_VERSION,\n  PIPE_SILENT_TIME,\n  PIPE_WAIT_TIME,\n  PIPE_MAX_CHUNK\n} from '../const';\nimport {\n  getLogOnceKey,\n  flattenObject,\n  convertErrorToPlain,\n  resolveDefaultParams\n} from '../util';\n\nimport SlsPipe from './sls-pipe';\n\n/**\n * 创建 SLS 日志方法\n */\nexport default class SlsLogger {\n  private readonly options: ICreateLoggerOptions;\n  private readonly slsPipe: SlsPipe;\n  private once: Record<string, 1> = {};\n  \n  constructor(sender: ILogSender, options: ICreateLoggerOptions) {\n    this.options = options;\n    this.slsPipe = new SlsPipe(sender, {\n      trackUrl: `https://${options.project}.${options.endpoint}/logstores/${options.logstore}/track`,\n      apiVersion: options.apiVersion || API_VERSION,\n      silentTime: options.silentTime ?? PIPE_SILENT_TIME,\n      waitTime: options.waitTime ?? PIPE_WAIT_TIME,\n      maxChunk: options.maxChunk ?? PIPE_MAX_CHUNK\n    });\n  }\n  \n  log: ISlsLogFn = (...args: TLogArgs): void => {\n    let options: ISlsLogOptions = {};\n    let topic: string;\n    let payload: Record<string, unknown> | undefined;\n    \n    if (typeof args[0] === 'string') {\n      [topic, payload] = args as [string, Record<string, unknown>?];\n    } else {\n      [options, topic, payload] = args as [ISlsLogOptions, string, Record<string, unknown>?];\n    }\n    \n    const {\n      options: {\n        prefix: factoryPrefix,\n        sampling: factorySampling,\n        defaultParams\n      }\n    } = this;\n    const {\n      group = 'LOG',\n      prefix = factoryPrefix,\n      sampling = factorySampling,\n      instant,\n      once,\n      flatten\n    } = options;\n    const finalTopic = prefix ? `${prefix}${topic}` : topic;\n    const onceKey: string | undefined = getLogOnceKey(finalTopic, once);\n    \n    if (this.dontSend(sampling, onceKey)) {\n      return;\n    }\n    \n    if (onceKey) {\n      this.once[onceKey] = 1;\n    }\n    \n    let plainInfo: object | undefined;\n    \n    if (payload) {\n      if (flatten) {\n        plainInfo = flattenObject(payload, flatten === true ? '' : flatten);\n      } else if (_isError(payload)) {\n        plainInfo = convertErrorToPlain(payload);\n      } else {\n        plainInfo = payload;\n      }\n    }\n    \n    this.slsPipe.pipe({\n      ...resolveDefaultParams(defaultParams),\n      ...plainInfo,\n      __topic__: finalTopic,\n      _GROUP: group\n    }, instant);\n  };\n  \n  /**\n   * 检查是否需要忽略\n   */\n  private dontSend(sampling?: number, onceKey?: string): boolean {\n    const {\n      options: {\n        dontSend\n      }\n    } = this;\n    \n    if (onceKey && this.once[onceKey]) { // 只需发送一次，已发送过，忽略\n      return true;\n    }\n    \n    if (dontSend?.() === true) { // dontSend 阻止发送\n      return true;\n    }\n    \n    if (typeof sampling === 'number' && sampling > 0 && sampling < 1) { // 采样，`(0, 1)` 开区间\n      return Math.random() > sampling;\n    }\n    \n    return false;\n  }\n}"],"mappings":";;;;;;AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AASrC,SACEC,WAAW,EACXC,gBAAgB,EAChBC,cAAc,EACdC,cAAc,QACT,UAAU;AACjB,SACEC,aAAa,EACbC,aAAa,EACbC,mBAAmB,EACnBC,oBAAoB,QACf,SAAS;AAEhB,OAAOC,OAAO,MAAM,YAAY;;AAEhC;AACA;AACA;AAFA,IAGqBC,SAAS;EAK5B,SAAAA,UAAYC,MAAkB,EAAEC,QAA6B,EAAE;IAAA,IAAAC,KAAA;MAAAC,mBAAA;MAAAC,iBAAA;MAAAC,iBAAA;IAAAC,eAAA,OAAAP,SAAA;IAAAQ,eAAA,eAF7B,CAAC,CAAC;IAAAA,eAAA,cAanB,YAA6B;MAC5C,IAAIN,OAAuB,GAAG,CAAC,CAAC;MAChC,IAAIO,KAAa;MACjB,IAAIC,OAA4C;MAAC,SAAAC,IAAA,GAAAC,SAAA,CAAAC,MAAA,EAH9BC,IAAI,OAAAC,KAAA,CAAAJ,IAAA,GAAAK,IAAA,MAAAA,IAAA,GAAAL,IAAA,EAAAK,IAAA;QAAJF,IAAI,CAAAE,IAAA,IAAAJ,SAAA,CAAAI,IAAA;MAAA;MAKvB,IAAI,OAAOF,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE;QAAA,IAAAG,IAAA,GACZH,IAAI;QAAA,IAAAI,KAAA,GAAAC,cAAA,CAAAF,IAAA;QAAtBR,KAAK,GAAAS,KAAA;QAAER,OAAO,GAAAQ,KAAA;MACjB,CAAC,MAAM;QAAA,IAAAE,KAAA,GACuBN,IAAI;QAAA,IAAAO,KAAA,GAAAF,cAAA,CAAAC,KAAA;QAA/BlB,OAAO,GAAAmB,KAAA;QAAEZ,KAAK,GAAAY,KAAA;QAAEX,OAAO,GAAAW,KAAA;MAC1B;MAEA,IAAAC,aAAA,GAMInB,KAAI,CALND,OAAO;QACGqB,aAAa,GAAAD,aAAA,CAArBE,MAAM;QACIC,eAAe,GAAAH,aAAA,CAAzBI,QAAQ;QACRC,aAAa,GAAAL,aAAA,CAAbK,aAAa;MAGjB,IAAAC,SAAA,GAOI1B,OAAO;QAAA2B,eAAA,GAAAD,SAAA,CANTE,KAAK;QAALA,KAAK,GAAAD,eAAA,cAAG,KAAK,GAAAA,eAAA;QAAAE,gBAAA,GAAAH,SAAA,CACbJ,MAAM;QAANA,MAAM,GAAAO,gBAAA,cAAGR,aAAa,GAAAQ,gBAAA;QAAAC,kBAAA,GAAAJ,SAAA,CACtBF,QAAQ;QAARA,QAAQ,GAAAM,kBAAA,cAAGP,eAAe,GAAAO,kBAAA;QAC1BC,OAAO,GAAAL,SAAA,CAAPK,OAAO;QACPC,IAAI,GAAAN,SAAA,CAAJM,IAAI;QACJC,OAAO,GAAAP,SAAA,CAAPO,OAAO;MAET,IAAMC,UAAU,GAAGZ,MAAM,MAAAa,MAAA,CAAMb,MAAM,EAAAa,MAAA,CAAG5B,KAAK,IAAKA,KAAK;MACvD,IAAM6B,OAA2B,GAAG3C,aAAa,CAACyC,UAAU,EAAEF,IAAI,CAAC;MAEnE,IAAI/B,KAAI,CAACoC,QAAQ,CAACb,QAAQ,EAAEY,OAAO,CAAC,EAAE;QACpC;MACF;MAEA,IAAIA,OAAO,EAAE;QACXnC,KAAI,CAAC+B,IAAI,CAACI,OAAO,CAAC,GAAG,CAAC;MACxB;MAEA,IAAIE,SAA6B;MAEjC,IAAI9B,OAAO,EAAE;QACX,IAAIyB,OAAO,EAAE;UACXK,SAAS,GAAG5C,aAAa,CAACc,OAAO,EAAEyB,OAAO,KAAK,IAAI,GAAG,EAAE,GAAGA,OAAO,CAAC;QACrE,CAAC,MAAM,IAAI7C,QAAQ,CAACoB,OAAO,CAAC,EAAE;UAC5B8B,SAAS,GAAG3C,mBAAmB,CAACa,OAAO,CAAC;QAC1C,CAAC,MAAM;UACL8B,SAAS,GAAG9B,OAAO;QACrB;MACF;MAEAP,KAAI,CAACsC,OAAO,CAACC,IAAI,CAAAC,aAAA,CAAAA,aAAA,CAAAA,aAAA,KACZ7C,oBAAoB,CAAC6B,aAAa,CAAC,GACnCa,SAAS;QACZI,SAAS,EAAER,UAAU;QACrBS,MAAM,EAAEf;MAAK,IACZG,OAAO,CAAC;IACb,CAAC;IAjEC,IAAI,CAAC/B,OAAO,GAAGA,QAAO;IACtB,IAAI,CAACuC,OAAO,GAAG,IAAI1C,OAAO,CAACE,MAAM,EAAE;MACjC6C,QAAQ,aAAAT,MAAA,CAAanC,QAAO,CAAC6C,OAAO,OAAAV,MAAA,CAAInC,QAAO,CAAC8C,QAAQ,iBAAAX,MAAA,CAAcnC,QAAO,CAAC+C,QAAQ,WAAQ;MAC9FC,UAAU,EAAEhD,QAAO,CAACgD,UAAU,IAAI3D,WAAW;MAC7C4D,UAAU,GAAA/C,mBAAA,GAAEF,QAAO,CAACiD,UAAU,cAAA/C,mBAAA,cAAAA,mBAAA,GAAIZ,gBAAgB;MAClD4D,QAAQ,GAAA/C,iBAAA,GAAEH,QAAO,CAACkD,QAAQ,cAAA/C,iBAAA,cAAAA,iBAAA,GAAIZ,cAAc;MAC5C4D,QAAQ,GAAA/C,iBAAA,GAAEJ,QAAO,CAACmD,QAAQ,cAAA/C,iBAAA,cAAAA,iBAAA,GAAIZ;IAChC,CAAC,CAAC;EACJ;EAAC,OAAA4D,YAAA,CAAAtD,SAAA;IAAAuD,GAAA;IAAAC,KAAA;IA2DD;AACF;AACA;IACE,SAAQjB,QAAQA,CAACb,QAAiB,EAAEY,OAAgB,EAAW;MAAA,IAAAmB,SAAA;MAC7D,IAEIlB,QAAQ,GAER,IAAI,CAHNrC,OAAO,CACLqC,QAAQ;MAIZ,IAAID,OAAO,IAAI,IAAI,CAACJ,IAAI,CAACI,OAAO,CAAC,EAAE;QAAE;QACnC,OAAO,IAAI;MACb;MAEA,IAAI,EAAAmB,SAAA,GAAAlB,QAAQ,cAAAkB,SAAA,uBAARA,SAAA,CAAW,CAAC,MAAK,IAAI,EAAE;QAAE;QAC3B,OAAO,IAAI;MACb;MAEA,IAAI,OAAO/B,QAAQ,KAAK,QAAQ,IAAIA,QAAQ,GAAG,CAAC,IAAIA,QAAQ,GAAG,CAAC,EAAE;QAAE;QAClE,OAAOgC,IAAI,CAACC,MAAM,CAAC,CAAC,GAAGjC,QAAQ;MACjC;MAEA,OAAO,KAAK;IACd;EAAC;AAAA;AAAA,SAhGkB1B,SAAS,IAAA4D,OAAA","ignoreList":[]}

package/dist/esm/factory/generate-create-logger.js

@@ -1,7 +1,7 @@
 import _objectSpread from "@babel/runtime/helpers/objectSpread2";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["defaultParams", "shouldIgnore"];
-import { mergeDefaultParams, mergeShouldIgnore } from '../util';
+var _excluded = ["defaultParams", "dontSend"];
+import { mergeDefaultParams, mergeDontSend } from '../util';
 import createLogger from './create-logger';
 
 /**
@@ -11,14 +11,14 @@ import createLogger from './create-logger';
  */
 export default function generateCreateLogger(sender, _ref) {
   var factoryDefaultParams = _ref.defaultParams,
-    factoryShouldIgnore = _ref.shouldIgnore;
+    factoryDontSend = _ref.dontSend;
   return function (_ref2) {
     var defaultParams = _ref2.defaultParams,
-      shouldIgnore = _ref2.shouldIgnore,
+      dontSend = _ref2.dontSend,
       options = _objectWithoutProperties(_ref2, _excluded);
     return createLogger(sender, _objectSpread({
       defaultParams: mergeDefaultParams(factoryDefaultParams, defaultParams),
-      shouldIgnore: mergeShouldIgnore(factoryShouldIgnore, shouldIgnore)
+      dontSend: mergeDontSend(factoryDontSend, dontSend)
     }, options));
   };
 }

package/dist/esm/factory/generate-create-logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"generate-create-logger.js","names":["mergeDefaultParams","mergeShouldIgnore","createLogger","generateCreateLogger","sender","_ref","factoryDefaultParams","defaultParams","factoryShouldIgnore","shouldIgnore","_ref2","options","_objectWithoutProperties","_excluded","_objectSpread"],"sources":["../../../src/factory/generate-create-logger.ts"],"sourcesContent":["import {\n  ILogSender,\n  ICreateLogger,\n  ICreateLoggerOptions,\n  IGenerateCreateLoggerOptions\n} from '../types';\nimport {\n  mergeDefaultParams,\n  mergeShouldIgnore\n} from '../util';\n\nimport createLogger from './create-logger';\n\n/**\n * 创建 `createLogger` 方法的方法，对期望扩展默认参数的场景做了规范。\n *\n * 一般不会在项目中直接使用，而是用来写可复用 npm 包。\n */\nexport default function generateCreateLogger(sender: ILogSender, {\n  defaultParams: factoryDefaultParams,\n  shouldIgnore: factoryShouldIgnore\n}: IGenerateCreateLoggerOptions): ICreateLogger {\n  return ({\n    defaultParams,\n    shouldIgnore,\n    ...options\n  }: ICreateLoggerOptions) => createLogger(sender, {\n    defaultParams: mergeDefaultParams(factoryDefaultParams, defaultParams),\n    shouldIgnore: mergeShouldIgnore(factoryShouldIgnore, shouldIgnore),\n    ...options\n  });\n}"],"mappings":";;;AAMA,SACEA,kBAAkB,EAClBC,iBAAiB,QACZ,SAAS;AAEhB,OAAOC,YAAY,MAAM,iBAAiB;;AAE1C;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,oBAAoBA,CAACC,MAAkB,EAAAC,IAAA,EAGf;EAAA,IAF/BC,oBAAoB,GAAAD,IAAA,CAAnCE,aAAa;IACCC,mBAAmB,GAAAH,IAAA,CAAjCI,YAAY;EAEZ,OAAO,UAAAC,KAAA;IAAA,IACLH,aAAa,GAAAG,KAAA,CAAbH,aAAa;MACbE,YAAY,GAAAC,KAAA,CAAZD,YAAY;MACTE,OAAO,GAAAC,wBAAA,CAAAF,KAAA,EAAAG,SAAA;IAAA,OACgBX,YAAY,CAACE,MAAM,EAAAU,aAAA;MAC7CP,aAAa,EAAEP,kBAAkB,CAACM,oBAAoB,EAAEC,aAAa,CAAC;MACtEE,YAAY,EAAER,iBAAiB,CAACO,mBAAmB,EAAEC,YAAY;IAAC,GAC/DE,OAAO,CACX,CAAC;EAAA;AACJ","ignoreList":[]}
+{"version":3,"file":"generate-create-logger.js","names":["mergeDefaultParams","mergeDontSend","createLogger","generateCreateLogger","sender","_ref","factoryDefaultParams","defaultParams","factoryDontSend","dontSend","_ref2","options","_objectWithoutProperties","_excluded","_objectSpread"],"sources":["../../../src/factory/generate-create-logger.ts"],"sourcesContent":["import {\n  ILogSender,\n  ICreateLogger,\n  ICreateLoggerOptions,\n  IGenerateCreateLoggerOptions\n} from '../types';\nimport {\n  mergeDefaultParams,\n  mergeDontSend\n} from '../util';\n\nimport createLogger from './create-logger';\n\n/**\n * 创建 `createLogger` 方法的方法，对期望扩展默认参数的场景做了规范。\n *\n * 一般不会在项目中直接使用，而是用来写可复用 npm 包。\n */\nexport default function generateCreateLogger(sender: ILogSender, {\n  defaultParams: factoryDefaultParams,\n  dontSend: factoryDontSend\n}: IGenerateCreateLoggerOptions): ICreateLogger {\n  return ({\n    defaultParams,\n    dontSend,\n    ...options\n  }: ICreateLoggerOptions) => createLogger(sender, {\n    defaultParams: mergeDefaultParams(factoryDefaultParams, defaultParams),\n    dontSend: mergeDontSend(factoryDontSend, dontSend),\n    ...options\n  });\n}"],"mappings":";;;AAMA,SACEA,kBAAkB,EAClBC,aAAa,QACR,SAAS;AAEhB,OAAOC,YAAY,MAAM,iBAAiB;;AAE1C;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,oBAAoBA,CAACC,MAAkB,EAAAC,IAAA,EAGf;EAAA,IAF/BC,oBAAoB,GAAAD,IAAA,CAAnCE,aAAa;IACHC,eAAe,GAAAH,IAAA,CAAzBI,QAAQ;EAER,OAAO,UAAAC,KAAA;IAAA,IACLH,aAAa,GAAAG,KAAA,CAAbH,aAAa;MACbE,QAAQ,GAAAC,KAAA,CAARD,QAAQ;MACLE,OAAO,GAAAC,wBAAA,CAAAF,KAAA,EAAAG,SAAA;IAAA,OACgBX,YAAY,CAACE,MAAM,EAAAU,aAAA;MAC7CP,aAAa,EAAEP,kBAAkB,CAACM,oBAAoB,EAAEC,aAAa,CAAC;MACtEE,QAAQ,EAAER,aAAa,CAACO,eAAe,EAAEC,QAAQ;IAAC,GAC/CE,OAAO,CACX,CAAC;EAAA;AACJ","ignoreList":[]}

package/dist/esm/types/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","names":[],"sources":["../../../src/types/common.ts"],"sourcesContent":["export interface IDefaultParams {\n  (): Record<string, unknown>;\n}\n\nexport type TDefaultParams = Record<string, unknown> | IDefaultParams;\n\nexport interface IShouldIgnore {\n  (): void | boolean;\n}\n\n/**\n * 真正发送请求的实现逻辑（以支持多平台的需求），注意必需用 POST\n */\nexport interface ILogSender {\n  (trackUrl: string, body: string, headers: Record<string, string>): void;\n}\n\n/**\n * 用于在 flattenObject 的时候忽略部分属性\n *\n * - 默认忽略所有以 `_` 为前缀的属性\n * - `string` 等于 `key` 则忽略\n * - `string[]` 包含 `key` 则忽略\n * - 方法，可用 `path` 进行判断（注意这里的 `path` 和 `scope` 没有关系）\n */\nexport type TFlattenIgnore = string | string[] | {\n  (path: string, key: string, value: unknown): boolean;\n};\n\nexport interface ISlsLogPayload {\n  __topic__: string;\n  [k: string]: unknown;\n}\n\nexport interface ISlsPostBody {\n  __topic__: string;\n  __logs__: Record<string, string>[];\n  // __source__?: string;\n  // __tags__?: Record<string, string>;\n}"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"common.js","names":[],"sources":["../../../src/types/common.ts"],"sourcesContent":["export interface IDefaultParams {\n  (): Record<string, unknown>;\n}\n\nexport type TDefaultParams = Record<string, unknown> | IDefaultParams;\n\nexport interface IDontSend {\n  (): void | boolean;\n}\n\n/**\n * 真正发送请求的实现逻辑（以支持多平台的需求），注意必需用 POST\n */\nexport interface ILogSender {\n  (trackUrl: string, body: string, headers: Record<string, string>): void;\n}\n\nexport type TFlattenPathTester = string | RegExp | Array<string | RegExp>;\n\nexport interface ISlsLogPayload {\n  __topic__: string;\n  [k: string]: unknown;\n}\n\nexport interface ISlsPostBody {\n  __topic__: string;\n  __logs__: Record<string, string>[];\n  // __source__?: string;\n  // __tags__?: Record<string, string>;\n}"],"mappings":"","ignoreList":[]}

package/dist/esm/types/options.js.map

@@ -1 +1 @@
-{"version":3,"file":"options.js","names":[],"sources":["../../../src/types/options.ts"],"sourcesContent":["import {\n  TDefaultParams,\n  IShouldIgnore,\n  TFlattenIgnore\n} from './common';\n\nexport interface ISlsPipeOptions {\n  trackUrl: string;\n  /**\n   * 不知所谓的参数，但必需，说是保留字段，默认 `0.6.0`（文档中的版本号），请不要使用\n   */\n  apiVersion: string;\n  /**\n   * 应用初始化后，多少时间内对日志请求进行冷冻处理，以让行业务请求，提升业务性能\n   *\n   * 默认 5000ms\n   */\n  silentTime: number;\n  /**\n   * 调用方法到日志被真正发送的等待时间，这段时间内，若有新的日志进来，会被合并并重新计时\n   *\n   * 默认 200ms\n   */\n  waitTime: number;\n  /**\n   * 一次最多发送日志条数，若积累的日志数超过，将切成多个请求发送\n   *\n   * 默认 50\n   */\n  maxChunk: number;\n}\n\nexport interface ICreateLoggerOptions extends Partial<ISlsPipeOptions> {\n  /**\n   * logstore 所在的 SLS project\n   */\n  project: string;\n  /**\n   * project 的外网访问域名，在 SLS 控制台 project 概览页可以找到，\n   * 如 `cn-hangzhou.log.aliyuncs.com`（仅跟 project 所在地域有关）\n   */\n  endpoint: string;\n  /**\n   * SLS project 下的 logstore，必须开通 Web Tracking 功能，日志记录的存储点\n   */\n  logstore: string;\n  /**\n   * 当希望同一个模块的日志使用统一的前缀，又不想每次调用的时候写，可以用这个\n   */\n  prefix?: string;\n  /**\n   * 生产出的日志方法的整体采样率，可在调用时由方法参数覆盖，范围为 (0, 1]，默认 1\n   */\n  sampling?: number;\n  /**\n   * 默认参数，避免每次都要传，可以是静态数据或产生动态数据的方法，这些参数可以覆盖自动记录的参数，\n   * 但会被日志方法的第二个参数 `params` 中对应的字段覆盖\n   */\n  defaultParams?: TDefaultParams;\n  /**\n   * 上报之前进行判断是否继续，返回 false 以阻止上报\n   *\n   * 在某些场景下需要禁用日志上报功能，比如国外禁止将日志上报到国内的 logstore\n   */\n  shouldIgnore?: IShouldIgnore;\n}\n\n/**\n * 生成 `createLogger` 方法的工厂方法的 options，用于制定工厂级别的参数的忽略方法\n */\nexport interface IGenerateCreateLoggerOptions {\n  defaultParams?: TDefaultParams;\n  shouldIgnore?: IShouldIgnore;\n}\n\nexport interface ISlsFlattenOptions {\n  scope?: string;\n  depth?: number;\n  ignore?: TFlattenIgnore;\n}\n\n/**\n * SLS 日志方法 Options\n */\nexport interface ISlsLogOptions {\n  /**\n   * 覆盖 IFactoryOptions 的 prefix 设置，仅针对当前日志\n   */\n  prefix?: string;\n  /**\n   * 覆盖 IFactoryOptions 的 sampling 设置，仅针对当前日志\n   */\n  sampling?: number;\n  /**\n   * 有日志只需要在应用起来后记录一次，后续的将被丢弃\n   *\n   * - true 表示以该 topic 做判断，针对该 topic 只记录一次\n   * - 如果是字符串，则以「topic + 此字符串」做判断\n   */\n  once?: true | string;\n  /**\n   * 日志不是强需求，不能压过业务，要业务先行。网络请求一般在页面的一开始最密集，如果日志在这时上报会造成网络阻塞而产生性能问题。\n   *\n   * 办法是先积压着，等到时间到了，再把积压着的日志一起上报。\n   *\n   * 所以，为了提升性能，做了以下事情：\n   *\n   * 1. 应用起来后，有一定的静默时间，这段时间的日志会被积压，用于给应用的请求让路\n   * 2. 整体或单个日志的延时时间\n   * 3. 整体或单个日志的采样率\n   * 4. 有的日志只会发送一次\n   * 5. 日志发送前也有一个很短的等待时间，在这段时间内，如果有新的日志进来，也将被积压，并重新计时\n   * 6. 最后，积压的日志利用 POST 请求对日志进行合并发送\n   *\n   * 然而，总有例外，有的日志希望是即时的，比如需要拿它来算 PvUv，instant 就是为此而生。\n   * 注意：instant 会忽略延时，但不会忽略采样率\n   */\n  instant?: boolean;\n  /**\n   * 是否对 info 进行 flatten 操作\n   */\n  flatten?: boolean | string | ISlsFlattenOptions;\n  /**\n   * 为日志增加默认参数 `_GROUP`，可用于数据分析分组\n   */\n  group?: string;\n}\n\n/**\n * SLS 快捷方法 Options\n */\nexport interface ISlsLogOptionsQuick extends Omit<ISlsLogOptions, 'group'> {}"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"options.js","names":[],"sources":["../../../src/types/options.ts"],"sourcesContent":["import {\n  TDefaultParams,\n  TFlattenPathTester,\n  IDontSend\n} from './common';\n\nexport interface ISlsPipeOptions {\n  trackUrl: string;\n  /**\n   * 不知所谓的参数，但必需，说是保留字段，默认 `0.6.0`（文档中的版本号），请不要使用\n   */\n  apiVersion: string;\n  /**\n   * 应用初始化后，多少时间内对日志请求进行冷冻处理，以让行业务请求，提升业务性能\n   *\n   * 默认 5000ms\n   */\n  silentTime: number;\n  /**\n   * 调用方法到日志被真正发送的等待时间，这段时间内，若有新的日志进来，会被合并并重新计时\n   *\n   * 默认 200ms\n   */\n  waitTime: number;\n  /**\n   * 一次最多发送日志条数，若积累的日志数超过，将切成多个请求发送\n   *\n   * 默认 50\n   */\n  maxChunk: number;\n}\n\nexport interface ICreateLoggerOptions extends Partial<ISlsPipeOptions> {\n  /**\n   * logstore 所在的 SLS project\n   */\n  project: string;\n  /**\n   * project 的外网访问域名，在 SLS 控制台 project 概览页可以找到，\n   * 如 `cn-hangzhou.log.aliyuncs.com`（仅跟 project 所在地域有关）\n   */\n  endpoint: string;\n  /**\n   * SLS project 下的 logstore，必须开通 Web Tracking 功能，日志记录的存储点\n   */\n  logstore: string;\n  /**\n   * 当希望同一个模块的日志使用统一的前缀，又不想每次调用的时候写，可以用这个\n   */\n  prefix?: string;\n  /**\n   * 生产出的日志方法的整体采样率，可在调用时由方法参数覆盖，范围为 (0, 1]，默认 1\n   */\n  sampling?: number;\n  /**\n   * 默认参数，避免每次都要传，可以是静态数据或产生动态数据的方法，这些参数可以覆盖自动记录的参数，\n   * 但会被日志方法的第二个参数 `params` 中对应的字段覆盖\n   */\n  defaultParams?: TDefaultParams;\n  /**\n   * 上报之前进行判断是否继续，返回 true 以阻止上报\n   *\n   * 在某些场景下需要禁用日志上报功能，比如可能禁止日志跨境\n   */\n  dontSend?: IDontSend;\n}\n\n/**\n * 生成 `createLogger` 方法的工厂方法的 options，用于制定工厂级别的参数的忽略方法\n */\nexport interface IGenerateCreateLoggerOptions {\n  defaultParams?: TDefaultParams;\n  dontSend?: IDontSend;\n}\n\nexport interface IFlattenOptions {\n  scope?: string;\n  depth?: number;\n  /**\n   * 将属性从结果中剔除\n   */\n  omit?: TFlattenPathTester;\n  /**\n   * 将属性直接输出，提前结束该属性深度\n   */\n  pass?: TFlattenPathTester;\n}\n\n/**\n * SLS 日志方法 Options\n */\nexport interface ISlsLogOptions {\n  /**\n   * 覆盖 IFactoryOptions 的 prefix 设置，仅针对当前日志\n   */\n  prefix?: string;\n  /**\n   * 覆盖 IFactoryOptions 的 sampling 设置，仅针对当前日志\n   */\n  sampling?: number;\n  /**\n   * 有日志只需要在应用起来后记录一次，后续的将被丢弃\n   *\n   * - true 表示以该 topic 做判断，针对该 topic 只记录一次\n   * - 如果是字符串，则以「topic + 此字符串」做判断\n   */\n  once?: true | string;\n  /**\n   * 日志不是强需求，不能压过业务，要业务先行。网络请求一般在页面的一开始最密集，如果日志在这时上报会造成网络阻塞而产生性能问题。\n   *\n   * 办法是先积压着，等到时间到了，再把积压着的日志一起上报。\n   *\n   * 所以，为了提升性能，做了以下事情：\n   *\n   * 1. 应用起来后，有一定的静默时间，这段时间的日志会被积压，用于给应用的请求让路\n   * 2. 整体或单个日志的延时时间\n   * 3. 整体或单个日志的采样率\n   * 4. 有的日志只会发送一次\n   * 5. 日志发送前也有一个很短的等待时间，在这段时间内，如果有新的日志进来，也将被积压，并重新计时\n   * 6. 最后，积压的日志利用 POST 请求对日志进行合并发送\n   *\n   * 然而，总有例外，有的日志希望是即时的，比如需要拿它来算 PvUv，instant 就是为此而生。\n   * 注意：instant 会忽略延时，但不会忽略采样率\n   */\n  instant?: boolean;\n  /**\n   * 是否对 info 进行 flatten 操作\n   */\n  flatten?: boolean | string | IFlattenOptions;\n  /**\n   * 为日志增加默认参数 `_GROUP`，可用于数据分析分组\n   */\n  group?: string;\n}\n\n/**\n * SLS 快捷方法 Options\n */\nexport interface ISlsLogOptionsQuick extends Omit<ISlsLogOptions, 'group'> {}"],"mappings":"","ignoreList":[]}

package/dist/esm/util/flatten-object.js

@@ -4,7 +4,7 @@ import _isPlainObject from 'lodash/isPlainObject';
 import _isError from 'lodash/isError';
 import _forEach from 'lodash/forEach';
 import convertErrorToPlain from './convert-error-to-plain';
-import flattenShouldIgnore from './flatten-should-ignore';
+import flattenTestPath from './flatten-test-path';
 
 /**
  * 有时候为了统计方便，需要把传入的对象展平，比如 error 对象，可能会展平成如下形状：
@@ -24,7 +24,8 @@ export default function flattenObject(o, options) {
   var scope = resolvedOptions.scope,
     _resolvedOptions$dept = resolvedOptions.depth,
     depth = _resolvedOptions$dept === void 0 ? 5 : _resolvedOptions$dept,
-    ignore = resolvedOptions.ignore;
+    omit = resolvedOptions.omit,
+    pass = resolvedOptions.pass;
   var result = {};
   function makeSureErrorObject(errorOrObject) {
     return _isError(errorOrObject) ? convertErrorToPlain(errorOrObject) : errorOrObject;
@@ -32,18 +33,22 @@ export default function flattenObject(o, options) {
   function loop(currentObj, parentPaths) {
     var depthFull = depth > 0 && parentPaths.length + 1 >= depth;
     _forEach(currentObj, function (v, k) {
-      var key = [].concat(_toConsumableArray(parentPaths), [k]).join('.');
-      var scopedKey = scope ? "".concat(scope, ".").concat(key) : key;
+      var pathKey = [].concat(_toConsumableArray(parentPaths), [k]).join('.');
+      var scopedPathKey = scope ? "".concat(scope, ".").concat(pathKey) : pathKey;
 
-      // 可以忽略不重要的信息
-      if (flattenShouldIgnore(ignore, key, k, v)) {
+      // 可以忽略不重要的信息，默认不记录 `_` 打头的所有数据
+      if (/^_/.test(k) || omit && flattenTestPath(pathKey, omit)) {
         return;
       }
       var vAsObject = makeSureErrorObject(v);
 
-      // 深度满了，或者不是对象或 Error，或者空对象（或数组），则不继续 loop
-      if (depthFull || !_isPlainObject(vAsObject) || _isEmpty(vAsObject)) {
-        result[scopedKey] = vAsObject;
+      // 不继续 loop：
+      // 1. 深度满了
+      // 2. 不是对象，不是 Error
+      // 3. 空对象，或空数组
+      // 4. 命中 `pass` 规则
+      if (depthFull || !_isPlainObject(vAsObject) || _isEmpty(vAsObject) || pass && flattenTestPath(pathKey, pass)) {
+        result[scopedPathKey] = vAsObject;
         return;
       }
       loop(vAsObject, [].concat(_toConsumableArray(parentPaths), [k]));

package/dist/esm/util/flatten-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"flatten-object.js","names":["_isEmpty","_isPlainObject","_isError","_forEach","convertErrorToPlain","flattenShouldIgnore","flattenObject","o","options","resolvedOptions","scope","_resolvedOptions$dept","depth","ignore","result","makeSureErrorObject","errorOrObject","loop","currentObj","parentPaths","depthFull","length","v","k","key","concat","_toConsumableArray","join","scopedKey","vAsObject"],"sources":["../../../src/util/flatten-object.ts"],"sourcesContent":["import _isEmpty from 'lodash/isEmpty';\nimport _isPlainObject from 'lodash/isPlainObject';\nimport _isError from 'lodash/isError';\nimport _forEach from 'lodash/forEach';\n\nimport type {\n  ISlsFlattenOptions\n} from '../types';\n\nimport convertErrorToPlain from './convert-error-to-plain';\nimport flattenShouldIgnore from './flatten-should-ignore';\n\n/**\n * 有时候为了统计方便，需要把传入的对象展平，比如 error 对象，可能会展平成如下形状：\n *\n * ```\n * {\n *   \"error.name\": \"..\",\n *   \"error.message\": \"..\",\n *   \"error.stack\": \"..\"\n * }\n * ```\n */\nexport default function flattenObject<T extends object>(o: T, options: string | ISlsFlattenOptions): Record<string, unknown> {\n  const resolvedOptions = typeof options === 'string' ? {\n    scope: options\n  } : options;\n  const {\n    scope,\n    depth = 5,\n    ignore\n  } = resolvedOptions;\n  const result: Record<string, unknown> = {};\n  \n  function makeSureErrorObject(errorOrObject: object): object {\n    return _isError(errorOrObject) ? convertErrorToPlain(errorOrObject) : errorOrObject;\n  }\n  \n  function loop(currentObj: object, parentPaths: string[]): void {\n    const depthFull = depth > 0 && parentPaths.length + 1 >= depth;\n    \n    _forEach(currentObj, (v: unknown, k: string) => {\n      const key = [...parentPaths, k].join('.');\n      const scopedKey = scope ? `${scope}.${key}` : key;\n      \n      // 可以忽略不重要的信息\n      if (flattenShouldIgnore(ignore, key, k, v)) {\n        return;\n      }\n      \n      const vAsObject = makeSureErrorObject(v as object);\n      \n      // 深度满了，或者不是对象或 Error，或者空对象（或数组），则不继续 loop\n      if (depthFull || !_isPlainObject(vAsObject) || _isEmpty(vAsObject)) {\n        result[scopedKey] = vAsObject;\n        \n        return;\n      }\n      \n      loop(vAsObject, [...parentPaths, k]);\n    });\n  }\n  \n  loop(makeSureErrorObject(o), []);\n  \n  return result;\n}"],"mappings":";AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,cAAc,MAAM,sBAAsB;AACjD,OAAOC,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,QAAQ,MAAM,gBAAgB;AAMrC,OAAOC,mBAAmB,MAAM,0BAA0B;AAC1D,OAAOC,mBAAmB,MAAM,yBAAyB;;AAEzD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,aAAaA,CAAmBC,CAAI,EAAEC,OAAoC,EAA2B;EAC3H,IAAMC,eAAe,GAAG,OAAOD,OAAO,KAAK,QAAQ,GAAG;IACpDE,KAAK,EAAEF;EACT,CAAC,GAAGA,OAAO;EACX,IACEE,KAAK,GAGHD,eAAe,CAHjBC,KAAK;IAAAC,qBAAA,GAGHF,eAAe,CAFjBG,KAAK;IAALA,KAAK,GAAAD,qBAAA,cAAG,CAAC,GAAAA,qBAAA;IACTE,MAAM,GACJJ,eAAe,CADjBI,MAAM;EAER,IAAMC,MAA+B,GAAG,CAAC,CAAC;EAE1C,SAASC,mBAAmBA,CAACC,aAAqB,EAAU;IAC1D,OAAOd,QAAQ,CAACc,aAAa,CAAC,GAAGZ,mBAAmB,CAACY,aAAa,CAAC,GAAGA,aAAa;EACrF;EAEA,SAASC,IAAIA,CAACC,UAAkB,EAAEC,WAAqB,EAAQ;IAC7D,IAAMC,SAAS,GAAGR,KAAK,GAAG,CAAC,IAAIO,WAAW,CAACE,MAAM,GAAG,CAAC,IAAIT,KAAK;IAE9DT,QAAQ,CAACe,UAAU,EAAE,UAACI,CAAU,EAAEC,CAAS,EAAK;MAC9C,IAAMC,GAAG,GAAG,GAAAC,MAAA,CAAAC,kBAAA,CAAIP,WAAW,IAAEI,CAAC,GAAEI,IAAI,CAAC,GAAG,CAAC;MACzC,IAAMC,SAAS,GAAGlB,KAAK,MAAAe,MAAA,CAAMf,KAAK,OAAAe,MAAA,CAAID,GAAG,IAAKA,GAAG;;MAEjD;MACA,IAAInB,mBAAmB,CAACQ,MAAM,EAAEW,GAAG,EAAED,CAAC,EAAED,CAAC,CAAC,EAAE;QAC1C;MACF;MAEA,IAAMO,SAAS,GAAGd,mBAAmB,CAACO,CAAW,CAAC;;MAElD;MACA,IAAIF,SAAS,IAAI,CAACnB,cAAc,CAAC4B,SAAS,CAAC,IAAI7B,QAAQ,CAAC6B,SAAS,CAAC,EAAE;QAClEf,MAAM,CAACc,SAAS,CAAC,GAAGC,SAAS;QAE7B;MACF;MAEAZ,IAAI,CAACY,SAAS,KAAAJ,MAAA,CAAAC,kBAAA,CAAMP,WAAW,IAAEI,CAAC,EAAC,CAAC;IACtC,CAAC,CAAC;EACJ;EAEAN,IAAI,CAACF,mBAAmB,CAACR,CAAC,CAAC,EAAE,EAAE,CAAC;EAEhC,OAAOO,MAAM;AACf","ignoreList":[]}
+{"version":3,"file":"flatten-object.js","names":["_isEmpty","_isPlainObject","_isError","_forEach","convertErrorToPlain","flattenTestPath","flattenObject","o","options","resolvedOptions","scope","_resolvedOptions$dept","depth","omit","pass","result","makeSureErrorObject","errorOrObject","loop","currentObj","parentPaths","depthFull","length","v","k","pathKey","concat","_toConsumableArray","join","scopedPathKey","test","vAsObject"],"sources":["../../../src/util/flatten-object.ts"],"sourcesContent":["import _isEmpty from 'lodash/isEmpty';\nimport _isPlainObject from 'lodash/isPlainObject';\nimport _isError from 'lodash/isError';\nimport _forEach from 'lodash/forEach';\n\nimport type {\n  IFlattenOptions\n} from '../types';\n\nimport convertErrorToPlain from './convert-error-to-plain';\nimport flattenTestPath from './flatten-test-path';\n\n/**\n * 有时候为了统计方便，需要把传入的对象展平，比如 error 对象，可能会展平成如下形状：\n *\n * ```\n * {\n *   \"error.name\": \"..\",\n *   \"error.message\": \"..\",\n *   \"error.stack\": \"..\"\n * }\n * ```\n */\nexport default function flattenObject<T extends object>(o: T, options: string | IFlattenOptions): Record<string, unknown> {\n  const resolvedOptions = typeof options === 'string' ? {\n    scope: options\n  } : options;\n  const {\n    scope,\n    depth = 5,\n    omit,\n    pass\n  } = resolvedOptions;\n  const result: Record<string, unknown> = {};\n  \n  function makeSureErrorObject(errorOrObject: object): object {\n    return _isError(errorOrObject) ? convertErrorToPlain(errorOrObject) : errorOrObject;\n  }\n  \n  function loop(currentObj: object, parentPaths: string[]): void {\n    const depthFull = depth > 0 && parentPaths.length + 1 >= depth;\n    \n    _forEach(currentObj, (v: unknown, k: string) => {\n      const pathKey = [...parentPaths, k].join('.');\n      const scopedPathKey = scope ? `${scope}.${pathKey}` : pathKey;\n      \n      // 可以忽略不重要的信息，默认不记录 `_` 打头的所有数据\n      if (/^_/.test(k) || (omit && flattenTestPath(pathKey, omit))) {\n        return;\n      }\n      \n      const vAsObject = makeSureErrorObject(v as object);\n      \n      // 不继续 loop：\n      // 1. 深度满了\n      // 2. 不是对象，不是 Error\n      // 3. 空对象，或空数组\n      // 4. 命中 `pass` 规则\n      if (depthFull || !_isPlainObject(vAsObject) || _isEmpty(vAsObject) || (pass && flattenTestPath(pathKey, pass))) {\n        result[scopedPathKey] = vAsObject;\n        \n        return;\n      }\n      \n      loop(vAsObject, [...parentPaths, k]);\n    });\n  }\n  \n  loop(makeSureErrorObject(o), []);\n  \n  return result;\n}"],"mappings":";AAAA,OAAOA,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,cAAc,MAAM,sBAAsB;AACjD,OAAOC,QAAQ,MAAM,gBAAgB;AACrC,OAAOC,QAAQ,MAAM,gBAAgB;AAMrC,OAAOC,mBAAmB,MAAM,0BAA0B;AAC1D,OAAOC,eAAe,MAAM,qBAAqB;;AAEjD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,SAASC,aAAaA,CAAmBC,CAAI,EAAEC,OAAiC,EAA2B;EACxH,IAAMC,eAAe,GAAG,OAAOD,OAAO,KAAK,QAAQ,GAAG;IACpDE,KAAK,EAAEF;EACT,CAAC,GAAGA,OAAO;EACX,IACEE,KAAK,GAIHD,eAAe,CAJjBC,KAAK;IAAAC,qBAAA,GAIHF,eAAe,CAHjBG,KAAK;IAALA,KAAK,GAAAD,qBAAA,cAAG,CAAC,GAAAA,qBAAA;IACTE,IAAI,GAEFJ,eAAe,CAFjBI,IAAI;IACJC,IAAI,GACFL,eAAe,CADjBK,IAAI;EAEN,IAAMC,MAA+B,GAAG,CAAC,CAAC;EAE1C,SAASC,mBAAmBA,CAACC,aAAqB,EAAU;IAC1D,OAAOf,QAAQ,CAACe,aAAa,CAAC,GAAGb,mBAAmB,CAACa,aAAa,CAAC,GAAGA,aAAa;EACrF;EAEA,SAASC,IAAIA,CAACC,UAAkB,EAAEC,WAAqB,EAAQ;IAC7D,IAAMC,SAAS,GAAGT,KAAK,GAAG,CAAC,IAAIQ,WAAW,CAACE,MAAM,GAAG,CAAC,IAAIV,KAAK;IAE9DT,QAAQ,CAACgB,UAAU,EAAE,UAACI,CAAU,EAAEC,CAAS,EAAK;MAC9C,IAAMC,OAAO,GAAG,GAAAC,MAAA,CAAAC,kBAAA,CAAIP,WAAW,IAAEI,CAAC,GAAEI,IAAI,CAAC,GAAG,CAAC;MAC7C,IAAMC,aAAa,GAAGnB,KAAK,MAAAgB,MAAA,CAAMhB,KAAK,OAAAgB,MAAA,CAAID,OAAO,IAAKA,OAAO;;MAE7D;MACA,IAAI,IAAI,CAACK,IAAI,CAACN,CAAC,CAAC,IAAKX,IAAI,IAAIR,eAAe,CAACoB,OAAO,EAAEZ,IAAI,CAAE,EAAE;QAC5D;MACF;MAEA,IAAMkB,SAAS,GAAGf,mBAAmB,CAACO,CAAW,CAAC;;MAElD;MACA;MACA;MACA;MACA;MACA,IAAIF,SAAS,IAAI,CAACpB,cAAc,CAAC8B,SAAS,CAAC,IAAI/B,QAAQ,CAAC+B,SAAS,CAAC,IAAKjB,IAAI,IAAIT,eAAe,CAACoB,OAAO,EAAEX,IAAI,CAAE,EAAE;QAC9GC,MAAM,CAACc,aAAa,CAAC,GAAGE,SAAS;QAEjC;MACF;MAEAb,IAAI,CAACa,SAAS,KAAAL,MAAA,CAAAC,kBAAA,CAAMP,WAAW,IAAEI,CAAC,EAAC,CAAC;IACtC,CAAC,CAAC;EACJ;EAEAN,IAAI,CAACF,mBAAmB,CAACT,CAAC,CAAC,EAAE,EAAE,CAAC;EAEhC,OAAOQ,MAAM;AACf","ignoreList":[]}

package/dist/esm/util/flatten-test-path.js

@@ -0,0 +1,6 @@
+export default function flattenTestPath(path, tester) {
+  return (Array.isArray(tester) ? tester : [tester]).some(function (v) {
+    return typeof v === 'string' ? v === path : v.test(path);
+  });
+}
+//# sourceMappingURL=flatten-test-path.js.map

package/dist/esm/util/flatten-test-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flatten-test-path.js","names":["flattenTestPath","path","tester","Array","isArray","some","v","test"],"sources":["../../../src/util/flatten-test-path.ts"],"sourcesContent":["import type {\n  TFlattenPathTester\n} from '../types';\n\nexport default function flattenTestPath(path: string, tester: TFlattenPathTester): boolean {\n  return (Array.isArray(tester) ? tester : [tester]).some(v => {\n    return typeof v === 'string' ? v === path : v.test(path);\n  });\n}"],"mappings":"AAIA,eAAe,SAASA,eAAeA,CAACC,IAAY,EAAEC,MAA0B,EAAW;EACzF,OAAO,CAACC,KAAK,CAACC,OAAO,CAACF,MAAM,CAAC,GAAGA,MAAM,GAAG,CAACA,MAAM,CAAC,EAAEG,IAAI,CAAC,UAAAC,CAAC,EAAI;IAC3D,OAAO,OAAOA,CAAC,KAAK,QAAQ,GAAGA,CAAC,KAAKL,IAAI,GAAGK,CAAC,CAACC,IAAI,CAACN,IAAI,CAAC;EAC1D,CAAC,CAAC;AACJ","ignoreList":[]}

package/dist/esm/util/index.js

@@ -6,5 +6,5 @@ export { default as convertErrorToPlain } from './convert-error-to-plain';
 export { default as resolveDefaultParams } from './resolve-default-params';
 export { default as createSlsLogQuick } from './create-sls-log-quick';
 export { default as mergeDefaultParams } from './merge-default-params';
-export { default as mergeShouldIgnore } from './merge-should-ignore';
+export { default as mergeDontSend } from './merge-dont-send';
 //# sourceMappingURL=index.js.map

package/dist/esm/util/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["default","getSilentCountdown","getLogOnceKey","flattenObject","buildPostBody","convertErrorToPlain","resolveDefaultParams","createSlsLogQuick","mergeDefaultParams","mergeShouldIgnore"],"sources":["../../../src/util/index.ts"],"sourcesContent":["export { default as getSilentCountdown } from './get-silent-countdown';\nexport { default as getLogOnceKey } from './get-log-once-key';\nexport { default as flattenObject } from './flatten-object';\nexport { default as buildPostBody } from './build-post-body';\nexport { default as convertErrorToPlain } from './convert-error-to-plain';\nexport { default as resolveDefaultParams } from './resolve-default-params';\nexport { default as createSlsLogQuick } from './create-sls-log-quick';\nexport { default as mergeDefaultParams } from './merge-default-params';\nexport { default as mergeShouldIgnore } from './merge-should-ignore';\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,kBAAkB,QAAQ,wBAAwB;AACtE,SAASD,OAAO,IAAIE,aAAa,QAAQ,oBAAoB;AAC7D,SAASF,OAAO,IAAIG,aAAa,QAAQ,kBAAkB;AAC3D,SAASH,OAAO,IAAII,aAAa,QAAQ,mBAAmB;AAC5D,SAASJ,OAAO,IAAIK,mBAAmB,QAAQ,0BAA0B;AACzE,SAASL,OAAO,IAAIM,oBAAoB,QAAQ,0BAA0B;AAC1E,SAASN,OAAO,IAAIO,iBAAiB,QAAQ,wBAAwB;AACrE,SAASP,OAAO,IAAIQ,kBAAkB,QAAQ,wBAAwB;AACtE,SAASR,OAAO,IAAIS,iBAAiB,QAAQ,uBAAuB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["default","getSilentCountdown","getLogOnceKey","flattenObject","buildPostBody","convertErrorToPlain","resolveDefaultParams","createSlsLogQuick","mergeDefaultParams","mergeDontSend"],"sources":["../../../src/util/index.ts"],"sourcesContent":["export { default as getSilentCountdown } from './get-silent-countdown';\nexport { default as getLogOnceKey } from './get-log-once-key';\nexport { default as flattenObject } from './flatten-object';\nexport { default as buildPostBody } from './build-post-body';\nexport { default as convertErrorToPlain } from './convert-error-to-plain';\nexport { default as resolveDefaultParams } from './resolve-default-params';\nexport { default as createSlsLogQuick } from './create-sls-log-quick';\nexport { default as mergeDefaultParams } from './merge-default-params';\nexport { default as mergeDontSend } from './merge-dont-send';\n"],"mappings":"AAAA,SAASA,OAAO,IAAIC,kBAAkB,QAAQ,wBAAwB;AACtE,SAASD,OAAO,IAAIE,aAAa,QAAQ,oBAAoB;AAC7D,SAASF,OAAO,IAAIG,aAAa,QAAQ,kBAAkB;AAC3D,SAASH,OAAO,IAAII,aAAa,QAAQ,mBAAmB;AAC5D,SAASJ,OAAO,IAAIK,mBAAmB,QAAQ,0BAA0B;AACzE,SAASL,OAAO,IAAIM,oBAAoB,QAAQ,0BAA0B;AAC1E,SAASN,OAAO,IAAIO,iBAAiB,QAAQ,wBAAwB;AACrE,SAASP,OAAO,IAAIQ,kBAAkB,QAAQ,wBAAwB;AACtE,SAASR,OAAO,IAAIS,aAAa,QAAQ,mBAAmB","ignoreList":[]}

package/dist/esm/util/merge-dont-send.js

@@ -0,0 +1,9 @@
+export default function mergeDontSend(factoryDontSend, dontSend) {
+  if (!factoryDontSend || !dontSend) {
+    return dontSend || factoryDontSend;
+  }
+  return function () {
+    return factoryDontSend() || dontSend();
+  };
+}
+//# sourceMappingURL=merge-dont-send.js.map

package/dist/esm/util/merge-dont-send.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge-dont-send.js","names":["mergeDontSend","factoryDontSend","dontSend"],"sources":["../../../src/util/merge-dont-send.ts"],"sourcesContent":["import type {\n  IDontSend\n} from '../types';\n\nexport default function mergeDontSend(factoryDontSend?: IDontSend, dontSend?: IDontSend): IDontSend | undefined {\n  if (!factoryDontSend || !dontSend) {\n    return dontSend || factoryDontSend;\n  }\n  \n  return (): boolean | void => factoryDontSend() || dontSend();\n}"],"mappings":"AAIA,eAAe,SAASA,aAAaA,CAACC,eAA2B,EAAEC,QAAoB,EAAyB;EAC9G,IAAI,CAACD,eAAe,IAAI,CAACC,QAAQ,EAAE;IACjC,OAAOA,QAAQ,IAAID,eAAe;EACpC;EAEA,OAAO;IAAA,OAAsBA,eAAe,CAAC,CAAC,IAAIC,QAAQ,CAAC,CAAC;EAAA;AAC9D","ignoreList":[]}

package/dist/types/class/sls-logger.d.ts

@@ -11,5 +11,5 @@ export default class SlsLogger {
     /**
      * 检查是否需要忽略
      */
-    private shouldIgnore;
+    private dontSend;
 }

package/dist/types/factory/generate-create-logger.d.ts

@@ -4,4 +4,4 @@ import { ILogSender, ICreateLogger, IGenerateCreateLoggerOptions } from '../type
  *
  * 一般不会在项目中直接使用，而是用来写可复用 npm 包。
  */
-export default function generateCreateLogger(sender: ILogSender, { defaultParams: factoryDefaultParams, shouldIgnore: factoryShouldIgnore }: IGenerateCreateLoggerOptions): ICreateLogger;
+export default function generateCreateLogger(sender: ILogSender, { defaultParams: factoryDefaultParams, dontSend: factoryDontSend }: IGenerateCreateLoggerOptions): ICreateLogger;

package/dist/types/types/common.d.ts

@@ -2,7 +2,7 @@ export interface IDefaultParams {
     (): Record<string, unknown>;
 }
 export type TDefaultParams = Record<string, unknown> | IDefaultParams;
-export interface IShouldIgnore {
+export interface IDontSend {
     (): void | boolean;
 }
 /**
@@ -11,17 +11,7 @@ export interface IShouldIgnore {
 export interface ILogSender {
     (trackUrl: string, body: string, headers: Record<string, string>): void;
 }
-/**
- * 用于在 flattenObject 的时候忽略部分属性
- *
- * - 默认忽略所有以 `_` 为前缀的属性
- * - `string` 等于 `key` 则忽略
- * - `string[]` 包含 `key` 则忽略
- * - 方法，可用 `path` 进行判断（注意这里的 `path` 和 `scope` 没有关系）
- */
-export type TFlattenIgnore = string | string[] | {
-    (path: string, key: string, value: unknown): boolean;
-};
+export type TFlattenPathTester = string | RegExp | Array<string | RegExp>;
 export interface ISlsLogPayload {
     __topic__: string;
     [k: string]: unknown;

package/dist/types/types/options.d.ts

@@ -1,4 +1,4 @@
-import { TDefaultParams, IShouldIgnore, TFlattenIgnore } from './common';
+import { TDefaultParams, TFlattenPathTester, IDontSend } from './common';
 export interface ISlsPipeOptions {
     trackUrl: string;
     /**
@@ -52,23 +52,30 @@ export interface ICreateLoggerOptions extends Partial<ISlsPipeOptions> {
      */
     defaultParams?: TDefaultParams;
     /**
-     * 上报之前进行判断是否继续，返回 false 以阻止上报
+     * 上报之前进行判断是否继续，返回 true 以阻止上报
      *
-     * 在某些场景下需要禁用日志上报功能，比如国外禁止将日志上报到国内的 logstore
+     * 在某些场景下需要禁用日志上报功能，比如可能禁止日志跨境
      */
-    shouldIgnore?: IShouldIgnore;
+    dontSend?: IDontSend;
 }
 /**
  * 生成 `createLogger` 方法的工厂方法的 options，用于制定工厂级别的参数的忽略方法
  */
 export interface IGenerateCreateLoggerOptions {
     defaultParams?: TDefaultParams;
-    shouldIgnore?: IShouldIgnore;
+    dontSend?: IDontSend;
 }
-export interface ISlsFlattenOptions {
+export interface IFlattenOptions {
     scope?: string;
     depth?: number;
-    ignore?: TFlattenIgnore;
+    /**
+     * 将属性从结果中剔除
+     */
+    omit?: TFlattenPathTester;
+    /**
+     * 将属性直接输出，提前结束该属性深度
+     */
+    pass?: TFlattenPathTester;
 }
 /**
  * SLS 日志方法 Options
@@ -110,7 +117,7 @@ export interface ISlsLogOptions {
     /**
      * 是否对 info 进行 flatten 操作
      */
-    flatten?: boolean | string | ISlsFlattenOptions;
+    flatten?: boolean | string | IFlattenOptions;
     /**
      * 为日志增加默认参数 `_GROUP`，可用于数据分析分组
      */

package/dist/types/util/flatten-object.d.ts

@@ -1,4 +1,4 @@
-import type { ISlsFlattenOptions } from '../types';
+import type { IFlattenOptions } from '../types';
 /**
  * 有时候为了统计方便，需要把传入的对象展平，比如 error 对象，可能会展平成如下形状：
  *
@@ -10,4 +10,4 @@ import type { ISlsFlattenOptions } from '../types';
  * }
  * ```
  */
-export default function flattenObject<T extends object>(o: T, options: string | ISlsFlattenOptions): Record<string, unknown>;
+export default function flattenObject<T extends object>(o: T, options: string | IFlattenOptions): Record<string, unknown>;

package/dist/types/util/flatten-test-path.d.ts

@@ -0,0 +1,2 @@
+import type { TFlattenPathTester } from '../types';
+export default function flattenTestPath(path: string, tester: TFlattenPathTester): boolean;

package/dist/types/util/index.d.ts

@@ -6,4 +6,4 @@ export { default as convertErrorToPlain } from './convert-error-to-plain';
 export { default as resolveDefaultParams } from './resolve-default-params';
 export { default as createSlsLogQuick } from './create-sls-log-quick';
 export { default as mergeDefaultParams } from './merge-default-params';
-export { default as mergeShouldIgnore } from './merge-should-ignore';
+export { default as mergeDontSend } from './merge-dont-send';

package/dist/types/util/merge-dont-send.d.ts

@@ -0,0 +1,2 @@
+import type { IDontSend } from '../types';
+export default function mergeDontSend(factoryDontSend?: IDontSend, dontSend?: IDontSend): IDontSend | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kcuf/sls-logger-base",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Aliyun SLS logger without transport implementation.",
   "keywords": [],
   "license": "MIT",
@@ -30,7 +30,7 @@
     "@types/lodash": "^4.17.7",
     "@vitest/coverage-v8": "^2.1.1",
     "fetch-mock": "^11.1.4",
-    "jsdom": "^25.0.0",
+    "jsdom": "^25.0.1",
     "rimraf": "^6.0.1",
     "typescript": "^5.6.2",
     "vitest": "^2.1.1",