@warp-drive-mirror/build-config 5.6.0-beta.0 → 5.6.0-beta.1

package/dist/{debugging-BtpYr1v0.js → debugging-VdsvkNjX.js}

@@ -1,8 +1,5 @@
 /**
-  @module @warp-drive-mirror/build-config
- */
-/**
- * ## Debug Logging
+ * # Log Instrumentation <Badge type="tip" text="debug only" />
  *
  * Many portions of the internals are helpfully instrumented with logging.
  * This instrumentation is always removed from production builds.
@@ -14,19 +11,11 @@
  * either in your build config or via the runtime helper.
  *
  *
- * ### Activation Via Runtime Helper
+ * ## Runtime Activation
  *
- * A runtime helper is attached to `globalThis` to enable activation of the logs
- * from anywhere in your application including from the devtools panel.
- *
- * The runtime helper overrides any build config settings for the given flag
- * for the current browser tab. It stores the configuration you give it in
- * `sessionStorage` so that it persists across page reloads of the current tab,
- * but not across browser tabs or windows. Thus if you need to deactivate the
- * logging, you can call the helper again with the same flag set to `false` or
- * just open a new tab/window.
- *
- * Example Usage:
+ * ::: tip 💡 Just Works in browser Dev Tools!
+ * No import is needed, and the logging config is preserved when the page is refreshed
+ * :::
  *
  * ```ts
  * setWarpDriveLogging({
@@ -35,26 +24,34 @@
  * })
  * ```
  *
- * ### Activation Via Build Config
+ * A runtime helper is attached to `globalThis` to enable activation of the logs
+ * from anywhere in your application including from the devtools panel.
+ *
+ * The runtime helper overrides any build config settings for the given flag
+ * for the current browser tab. It stores the configuration you give it in
+ * `sessionStorage` so that it persists across page reloads of the current tab,
+ * but not across browser tabs or windows.
+ *
+ * If you need to deactivate the logging, you can call the helper again with the
+ * same flag set to `false` or just open a new tab/window.
+ *
+ * ## Buildtime Activation
  *
  * ```ts
  * setConfig(__dirname, app, {
  *   debug: {
- *     LOG_CACHE: false, // data store received to update cache with
- *     LOG_NOTIFICATIONS: false,
+ *     LOG_CACHE: true,
  *     LOG_REQUESTS: false,
- *     LOG_REQUEST_STATUS: false,
- *     LOG_IDENTIFIERS: false,
- *     LOG_GRAPH: false,
- *     LOG_INSTANCE_CACHE: false,
- *     LOG_METRIC_COUNTS: false,
- *     DEBUG_RELATIONSHIP_NOTIFICATIONS: false,
+ *     LOG_NOTIFICATIONS: true,
  *   }
  * });
  * ```
  *
- * @class DebugLogging
- * @public
+ * The build config settings are used to set the default values for the
+ * logging flags. Any logging flag that is not set in the build config
+ * will default to `false`.
+ *
+ * @module
  */
 /**
  * log cache updates for both local
@@ -65,16 +62,50 @@
  *
  * The others were `LOG_OPERATIONS` and `LOG_MUTATIONS`.
  *
- * @property LOG_CACHE
- * @type {Boolean}
  * @public
+ * @since 5.5
  */
 const LOG_CACHE = false;
+
+/**
+ * <Badge type="danger" text="removed" />
+ *
+ * This flag no longer has any effect.
+ *
+ * Use {@link LOG_CACHE} instead.
+ *
+ * @deprecated removed in version 5.5
+ * @public
+ */
+const LOG_PAYLOADS = false;
+
+/**
+ * <Badge type="danger" text="removed" />
+ *
+ * This flag no longer has any effect.
+ *
+ * Use {@link LOG_CACHE} instead.
+ *
+ * @deprecated removed in version 5.5
+ * @public
+ */
+const LOG_OPERATIONS = false;
+
+/**
+ * <Badge type="danger" text="removed" />
+ *
+ * This flag no longer has any effect.
+ *
+ * Use {@link LOG_CACHE} instead.
+ *
+ * @deprecated removed in version 5.5
+ * @public
+ */
+const LOG_MUTATIONS = false;
+
 /**
  * Log decisions made by the Basic CachePolicy
  *
- * @property LOG_CACHE_POLICY
- * @type {Boolean}
  * @public
  */
 const LOG_CACHE_POLICY = false;
@@ -82,16 +113,12 @@ const LOG_CACHE_POLICY = false;
 /**
  * log notifications received by the NotificationManager
  *
- * @property LOG_NOTIFICATIONS
- * @type {Boolean}
  * @public
  */
 const LOG_NOTIFICATIONS = false;
 /**
  * log requests issued by the RequestManager
  *
- * @property LOG_REQUESTS
- * @type {Boolean}
  * @public
  */
 const LOG_REQUESTS = false;
@@ -99,8 +126,6 @@ const LOG_REQUESTS = false;
  * log updates to requests the store has issued to
  * the network (adapter) to fulfill.
  *
- * @property LOG_REQUEST_STATUS
- * @type {Boolean}
  * @public
  */
 const LOG_REQUEST_STATUS = false;
@@ -108,8 +133,6 @@ const LOG_REQUEST_STATUS = false;
  * log peek, generation and updates to
  * Record Identifiers.
  *
- * @property LOG_IDENTIFIERS
- * @type {Boolean}
 
  * @public
  */
@@ -117,8 +140,6 @@ const LOG_IDENTIFIERS = false;
 /**
  * log updates received by the graph (relationship pointer storage)
  *
- * @property LOG_GRAPH
- * @type {Boolean}
  * @public
  */
 const LOG_GRAPH = false;
@@ -126,8 +147,6 @@ const LOG_GRAPH = false;
  * log creation/removal of RecordData and Record
  * instances.
  *
- * @property LOG_INSTANCE_CACHE
- * @type {Boolean}
  * @public
  */
 const LOG_INSTANCE_CACHE = false;
@@ -135,8 +154,6 @@ const LOG_INSTANCE_CACHE = false;
  * Log key count metrics, useful for performance
  * debugging.
  *
- * @property LOG_METRIC_COUNTS
- * @type {Boolean}
  * @public
  */
 const LOG_METRIC_COUNTS = false;
@@ -144,8 +161,6 @@ const LOG_METRIC_COUNTS = false;
  * Helps when debugging causes of a change notification
  * when processing an update to a hasMany relationship.
  *
- * @property DEBUG_RELATIONSHIP_NOTIFICATIONS
- * @type {Boolean}
  * @public
  */
 const DEBUG_RELATIONSHIP_NOTIFICATIONS = false;
@@ -158,24 +173,26 @@ const DEBUG_RELATIONSHIP_NOTIFICATIONS = false;
  *
  * LOG_METRIC_COUNTS must also be enabled.
  *
- * @typedoc
+ * @internal
  */
 const __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS = false;
 
 const LOGGING = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
-  __proto__: null,
-  DEBUG_RELATIONSHIP_NOTIFICATIONS,
-  LOG_CACHE,
-  LOG_CACHE_POLICY,
-  LOG_GRAPH,
-  LOG_IDENTIFIERS,
-  LOG_INSTANCE_CACHE,
-  LOG_METRIC_COUNTS,
-  LOG_NOTIFICATIONS,
-  LOG_REQUESTS,
-  LOG_REQUEST_STATUS,
-  __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS
+	__proto__: null,
+	DEBUG_RELATIONSHIP_NOTIFICATIONS,
+	LOG_CACHE,
+	LOG_CACHE_POLICY,
+	LOG_GRAPH,
+	LOG_IDENTIFIERS,
+	LOG_INSTANCE_CACHE,
+	LOG_METRIC_COUNTS,
+	LOG_MUTATIONS,
+	LOG_NOTIFICATIONS,
+	LOG_OPERATIONS,
+	LOG_PAYLOADS,
+	LOG_REQUESTS,
+	LOG_REQUEST_STATUS,
+	__INTERNAL_LOG_NATIVE_MAP_SET_COUNTS
 }, Symbol.toStringTag, { value: 'Module' }));
 
-export { DEBUG_RELATIONSHIP_NOTIFICATIONS as D, LOGGING as L, __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS as _, LOG_CACHE as a, LOG_CACHE_POLICY as b, LOG_NOTIFICATIONS as c, LOG_REQUESTS as d, LOG_REQUEST_STATUS as e, LOG_IDENTIFIERS as f, LOG_GRAPH as g, LOG_INSTANCE_CACHE as h, LOG_METRIC_COUNTS as i };
-//# sourceMappingURL=debugging-BtpYr1v0.js.map
+export { DEBUG_RELATIONSHIP_NOTIFICATIONS as D, LOGGING as L, __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS as _, LOG_CACHE as a, LOG_PAYLOADS as b, LOG_OPERATIONS as c, LOG_MUTATIONS as d, LOG_CACHE_POLICY as e, LOG_NOTIFICATIONS as f, LOG_REQUESTS as g, LOG_REQUEST_STATUS as h, LOG_IDENTIFIERS as i, LOG_GRAPH as j, LOG_INSTANCE_CACHE as k, LOG_METRIC_COUNTS as l };

package/dist/debugging.js

@@ -1,2 +1 @@
-export { D as DEBUG_RELATIONSHIP_NOTIFICATIONS, a as LOG_CACHE, b as LOG_CACHE_POLICY, g as LOG_GRAPH, f as LOG_IDENTIFIERS, h as LOG_INSTANCE_CACHE, i as LOG_METRIC_COUNTS, c as LOG_NOTIFICATIONS, d as LOG_REQUESTS, e as LOG_REQUEST_STATUS, _ as __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS } from './debugging-BtpYr1v0.js';
-//# sourceMappingURL=debugging.js.map
+export { D as DEBUG_RELATIONSHIP_NOTIFICATIONS, a as LOG_CACHE, e as LOG_CACHE_POLICY, j as LOG_GRAPH, i as LOG_IDENTIFIERS, k as LOG_INSTANCE_CACHE, l as LOG_METRIC_COUNTS, d as LOG_MUTATIONS, f as LOG_NOTIFICATIONS, c as LOG_OPERATIONS, b as LOG_PAYLOADS, g as LOG_REQUESTS, h as LOG_REQUEST_STATUS, _ as __INTERNAL_LOG_NATIVE_MAP_SET_COUNTS } from './debugging-VdsvkNjX.js';