@arcgis/toolkit 5.0.0-next.87 → 5.0.0-next.89

package/dist/log/index.cjs

@@ -26,8 +26,29 @@ const log = (level, context, message, options) => {
     }
     loggedMessages.add(key);
   }
-  esriConfig?.log.interceptors?.forEach((interceptor) => interceptor(level, contextString, message));
-  console[level](`[${contextString}]`, message);
+  let memorySafeDetail;
+  if (options?.detail) {
+    memorySafeDetail = {};
+    for (const [key, value] of Object.entries(options.detail)) {
+      if ((typeof value === "object" || typeof value === "function") && value !== null) {
+        const weakRefValue = new WeakRef(value);
+        Object.defineProperty(memorySafeDetail, key, {
+          get() {
+            return weakRefValue.deref();
+          }
+        });
+      } else {
+        memorySafeDetail[key] = value;
+      }
+    }
+    esriConfig?.log.interceptors?.forEach(
+      (interceptor) => interceptor(level, contextString, message, memorySafeDetail)
+    );
+    console[level](`[${contextString}]`, message, memorySafeDetail);
+  } else {
+    esriConfig?.log.interceptors?.forEach((interceptor) => interceptor(level, contextString, message));
+    console[level](`[${contextString}]`, message);
+  }
 };
 const composeMissingPropertyMessage = (property) => (
   //#endregion composeMissingPropertyMessage

package/dist/log/index.d.cts

@@ -11,8 +11,10 @@ type AccessorLike = {
 };
 export type LogContext = AccessorLike | CustomElementLike | string;
 type LogOptions = {
-    /** Whether the message should only be logged once */
+    /** Whether the message should only be logged once. */
     once?: boolean;
+    /** Additional objects to log after `message`. Use this to avoid memory leaks when logging objects to the console. Each object value will be automatically wrapped in a `WeakRef` before logging so it can be garbage-collected. */
+    detail?: Record<string, unknown>;
 };
 type EsriConfig = {
     log: {
@@ -47,14 +49,19 @@ export declare const setEsriConfig: (config: EsriConfig) => void;
  *
  * @example
  * ```ts
- * log("error", this, "message to log",
- *   {
- *     once: true, // only log this message once
- *   }
- * );
+ * // Basic usage
+ * log("error", this, "message to log");
  * ```
+ *
+ * @example
+ * ```ts
+ * // Optional usage
+ * log("warn", this, "message to log", {
+ *   once: true,
+ *   detail: { object1, object2 }
+ * });
  */
-export declare const log: (level: LogLevel, context: LogContext, message: unknown, options?: LogOptions) => void;
+export declare const log: (level: LogLevel, context: LogContext, message: string, options?: LogOptions) => void;
 type LogContextOrObject = Exclude<LogContext, string> | object;
 type InferPropertyType<T extends LogContextOrObject> = [object] extends [T] ? string : keyof T;
 /**

package/dist/log/index.d.ts

@@ -11,8 +11,10 @@ type AccessorLike = {
 };
 export type LogContext = AccessorLike | CustomElementLike | string;
 type LogOptions = {
-    /** Whether the message should only be logged once */
+    /** Whether the message should only be logged once. */
     once?: boolean;
+    /** Additional objects to log after `message`. Use this to avoid memory leaks when logging objects to the console. Each object value will be automatically wrapped in a `WeakRef` before logging so it can be garbage-collected. */
+    detail?: Record<string, unknown>;
 };
 type EsriConfig = {
     log: {
@@ -47,14 +49,19 @@ export declare const setEsriConfig: (config: EsriConfig) => void;
  *
  * @example
  * ```ts
- * log("error", this, "message to log",
- *   {
- *     once: true, // only log this message once
- *   }
- * );
+ * // Basic usage
+ * log("error", this, "message to log");
  * ```
+ *
+ * @example
+ * ```ts
+ * // Optional usage
+ * log("warn", this, "message to log", {
+ *   once: true,
+ *   detail: { object1, object2 }
+ * });
  */
-export declare const log: (level: LogLevel, context: LogContext, message: unknown, options?: LogOptions) => void;
+export declare const log: (level: LogLevel, context: LogContext, message: string, options?: LogOptions) => void;
 type LogContextOrObject = Exclude<LogContext, string> | object;
 type InferPropertyType<T extends LogContextOrObject> = [object] extends [T] ? string : keyof T;
 /**

package/dist/log/index.js

@@ -24,8 +24,29 @@ const log = (level, context, message, options) => {
     }
     loggedMessages.add(key);
   }
-  esriConfig?.log.interceptors?.forEach((interceptor) => interceptor(level, contextString, message));
-  console[level](`[${contextString}]`, message);
+  let memorySafeDetail;
+  if (options?.detail) {
+    memorySafeDetail = {};
+    for (const [key, value] of Object.entries(options.detail)) {
+      if ((typeof value === "object" || typeof value === "function") && value !== null) {
+        const weakRefValue = new WeakRef(value);
+        Object.defineProperty(memorySafeDetail, key, {
+          get() {
+            return weakRefValue.deref();
+          }
+        });
+      } else {
+        memorySafeDetail[key] = value;
+      }
+    }
+    esriConfig?.log.interceptors?.forEach(
+      (interceptor) => interceptor(level, contextString, message, memorySafeDetail)
+    );
+    console[level](`[${contextString}]`, message, memorySafeDetail);
+  } else {
+    esriConfig?.log.interceptors?.forEach((interceptor) => interceptor(level, contextString, message));
+    console[level](`[${contextString}]`, message);
+  }
 };
 const composeMissingPropertyMessage = (property) => (
   //#endregion composeMissingPropertyMessage

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arcgis/toolkit",
-  "version": "5.0.0-next.87",
+  "version": "5.0.0-next.89",
   "description": "Collection of common internal patterns and utilities for ArcGIS Maps SDK for JavaScript components.",
   "homepage": "https://developers.arcgis.com/javascript/latest/",
   "sideEffects": false,