@atproto/common 0.7.5 → 0.7.6

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atproto/common
 
+## 0.7.6
+
+### Patch Changes
+
+- [#4805](https://github.com/bluesky-social/atproto/pull/4805) [`b66870d`](https://github.com/bluesky-social/atproto/commit/b66870d5a1efbcfa0cc07498c7cfcf3f0f243e86) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Export new `createLogger` helper
+
+- [#4805](https://github.com/bluesky-social/atproto/pull/4805) [`b66870d`](https://github.com/bluesky-social/atproto/commit/b66870d5a1efbcfa0cc07498c7cfcf3f0f243e86) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Deprecate `subsystemLogger` in favor of `createLogger`
+
 ## 0.7.5
 
 ### Patch Changes

package/dist/logger.d.ts

@@ -1,3 +1,16 @@
-import { type Logger } from 'pino';
-export declare const subsystemLogger: (name: string) => Logger;
+import { type Logger, type SerializerFn } from 'pino';
+export declare function createLogger(name: string, options?: {
+    serializers?: {
+        [key: string]: SerializerFn;
+    };
+    msgPrefix?: string;
+}): Logger;
+/**
+ * @deprecated The use of singleton loggers is deprecated as they don't allow
+ * for proper configuration of serializers, and are not really used across the
+ * "atproto" mono repo. Indeed, whenever used, loggers are created and
+ * re-exported from a central place, achieving the same effect as a singleton
+ * logger, but with more flexibility. Use {@link createLogger} instead.
+ */
+export declare function subsystemLogger(name: string): Logger;
 //# sourceMappingURL=logger.d.ts.map

package/dist/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAqB,MAAM,MAAM,CAAA;AAgBrD,eAAO,MAAM,eAAe,SAAU,MAAM,KAAG,MAY9C,CAAA"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAqB,MAAM,MAAM,CAAA;AAcxE,wBAAgB,YAAY,CAC1B,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;IACR,WAAW,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,CAAA;KAAE,CAAA;IAC7C,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,GACA,MAAM,CAOR;AAID;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKpD"}

package/dist/logger.js

@@ -5,17 +5,27 @@ const level = process.env.LOG_LEVEL || 'info';
 const systems = process.env.LOG_SYSTEMS?.trim()
     ? process.env.LOG_SYSTEMS.replace(',', ' ').split(/\s+/).filter(Boolean)
     : null;
-const rootLogger = pino({ enabled, level }, dest ? destination(dest) : undefined);
-const subsystems = new Map();
-export const subsystemLogger = (name) => {
-    if (subsystems.has(name))
-        return subsystems.get(name);
+const rootLogger = /*#__PURE__*/ pino({ enabled, level }, dest ? destination(dest) : undefined);
+export function createLogger(name, options) {
     // can't disable child loggers, so we just set their level to "silent"
     // to effectively turn them off
     const subsystemEnabled = !systems || systems.includes(name);
     const subsystemLevel = enabled && subsystemEnabled ? level : 'silent';
-    const logger = rootLogger.child({ name }, { level: subsystemLevel });
+    return rootLogger.child({ name }, { ...options, level: subsystemLevel });
+}
+const subsystems = new Map();
+/**
+ * @deprecated The use of singleton loggers is deprecated as they don't allow
+ * for proper configuration of serializers, and are not really used across the
+ * "atproto" mono repo. Indeed, whenever used, loggers are created and
+ * re-exported from a central place, achieving the same effect as a singleton
+ * logger, but with more flexibility. Use {@link createLogger} instead.
+ */
+export function subsystemLogger(name) {
+    if (subsystems.has(name))
+        return subsystems.get(name);
+    const logger = createLogger(name);
     subsystems.set(name, logger);
     return logger;
-};
+}
 //# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,WAAW,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAErD,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,CAAA;AACpE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;AACxC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,CAAA;AAC7C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE;IAC7C,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACxE,CAAC,CAAC,IAAI,CAAA;AAER,MAAM,UAAU,GAAG,IAAI,CACrB,EAAE,OAAO,EAAE,KAAK,EAAE,EAClB,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CACrC,CAAA;AAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAA;AAE5C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAY,EAAU,EAAE;IACtD,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAE,CAAA;IAEtD,sEAAsE;IACtE,+BAA+B;IAC/B,MAAM,gBAAgB,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC3D,MAAM,cAAc,GAAG,OAAO,IAAI,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAA;IAErE,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAA;IAEpE,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC5B,OAAO,MAAM,CAAA;AACf,CAAC,CAAA","sourcesContent":["import { type Logger, destination, pino } from 'pino'\n\nconst enabled = /^(true|t|1)$/i.test(process.env.LOG_ENABLED ?? '0')\nconst dest = process.env.LOG_DESTINATION\nconst level = process.env.LOG_LEVEL || 'info'\nconst systems = process.env.LOG_SYSTEMS?.trim()\n  ? process.env.LOG_SYSTEMS.replace(',', ' ').split(/\\s+/).filter(Boolean)\n  : null\n\nconst rootLogger = pino(\n  { enabled, level },\n  dest ? destination(dest) : undefined,\n)\n\nconst subsystems = new Map<string, Logger>()\n\nexport const subsystemLogger = (name: string): Logger => {\n  if (subsystems.has(name)) return subsystems.get(name)!\n\n  // can't disable child loggers, so we just set their level to \"silent\"\n  // to effectively turn them off\n  const subsystemEnabled = !systems || systems.includes(name)\n  const subsystemLevel = enabled && subsystemEnabled ? level : 'silent'\n\n  const logger = rootLogger.child({ name }, { level: subsystemLevel })\n\n  subsystems.set(name, logger)\n  return logger\n}\n"]}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkC,WAAW,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAExE,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,CAAA;AACpE,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;AACxC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,MAAM,CAAA;AAC7C,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE;IAC7C,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;IACxE,CAAC,CAAC,IAAI,CAAA;AAER,MAAM,UAAU,GAAG,aAAa,CAAC,IAAI,CACnC,EAAE,OAAO,EAAE,KAAK,EAAE,EAClB,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CACrC,CAAA;AAED,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,OAGC;IAED,sEAAsE;IACtE,+BAA+B;IAC/B,MAAM,gBAAgB,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;IAC3D,MAAM,cAAc,GAAG,OAAO,IAAI,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAA;IAErE,OAAO,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAA;AAC1E,CAAC;AAED,MAAM,UAAU,GAAG,IAAI,GAAG,EAAkB,CAAA;AAE5C;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC;QAAE,OAAO,UAAU,CAAC,GAAG,CAAC,IAAI,CAAE,CAAA;IACtD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAA;IACjC,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC5B,OAAO,MAAM,CAAA;AACf,CAAC","sourcesContent":["import { type Logger, type SerializerFn, destination, pino } from 'pino'\n\nconst enabled = /^(true|t|1)$/i.test(process.env.LOG_ENABLED ?? '0')\nconst dest = process.env.LOG_DESTINATION\nconst level = process.env.LOG_LEVEL || 'info'\nconst systems = process.env.LOG_SYSTEMS?.trim()\n  ? process.env.LOG_SYSTEMS.replace(',', ' ').split(/\\s+/).filter(Boolean)\n  : null\n\nconst rootLogger = /*#__PURE__*/ pino(\n  { enabled, level },\n  dest ? destination(dest) : undefined,\n)\n\nexport function createLogger(\n  name: string,\n  options?: {\n    serializers?: { [key: string]: SerializerFn }\n    msgPrefix?: string\n  },\n): Logger {\n  // can't disable child loggers, so we just set their level to \"silent\"\n  // to effectively turn them off\n  const subsystemEnabled = !systems || systems.includes(name)\n  const subsystemLevel = enabled && subsystemEnabled ? level : 'silent'\n\n  return rootLogger.child({ name }, { ...options, level: subsystemLevel })\n}\n\nconst subsystems = new Map<string, Logger>()\n\n/**\n * @deprecated The use of singleton loggers is deprecated as they don't allow\n * for proper configuration of serializers, and are not really used across the\n * \"atproto\" mono repo. Indeed, whenever used, loggers are created and\n * re-exported from a central place, achieving the same effect as a singleton\n * logger, but with more flexibility. Use {@link createLogger} instead.\n */\nexport function subsystemLogger(name: string): Logger {\n  if (subsystems.has(name)) return subsystems.get(name)!\n  const logger = createLogger(name)\n  subsystems.set(name, logger)\n  return logger\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/common",
-  "version": "0.7.5",
+  "version": "0.7.6",
   "license": "MIT",
   "description": "Shared web-platform-friendly code for atproto libraries",
   "keywords": [
@@ -30,8 +30,8 @@
   "dependencies": {
     "multiformats": "^13.0.0",
     "pino": "^10.3.1",
-    "@atproto/common-web": "^0.5.9",
     "@atproto/lex-cbor": "^0.1.6",
+    "@atproto/common-web": "^0.5.9",
     "@atproto/lex-data": "^0.1.7"
   },
   "devDependencies": {