@atlaskit/editor-plugin-autocomplete 3.4.1 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-autocomplete
 
+## 3.5.0
+
+### Minor Changes
+
+- [`52c7f5f973025`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/52c7f5f973025) -
+  Switch the CTC autocomplete debug toggle off `localStorage` and onto a storage-free mechanism.
+  Debug logging is now enabled via the `__atlCtcDebug__.enable()` / `.disable()` console API for the
+  current session, or by appending `?atlCtcDebug=1` to the URL to have it active from initial load
+  (and survive reloads). This avoids browser-storage consent controls (BSC) that can block
+  uncategorized `localStorage` writes in some products. The `isAutocompleteDebugEnabled()` API is
+  unchanged for callers.
+
 ## 3.4.1
 
 ### Patch Changes

package/dist/cjs/pm-plugins/debug-mode.js

@@ -7,18 +7,59 @@ exports.isAutocompleteDebugEnabled = void 0;
 /**
  * Contextual Typeahead Completions (CTC) debug logging utility.
  *
- * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ * Logs are silent by default. Enable in any environment (dev, staging, prod):
  *
- *   localStorage.setItem('atl-ctc-dbg', '1')
+ *   // Live, for the current session (no reload required):
+ *   __atlCtcDebug__.enable()
  *
- * Then reload the page. To disable:
+ *   // To disable:
+ *   __atlCtcDebug__.disable()
  *
- *   localStorage.removeItem('atl-ctc-dbg')
+ *   // From initial page load (survives reload) — append to the URL:
+ *   ?atlCtcDebug=1
+ *
+ * Storage-free by design: avoids browser-storage consent controls (BSC), which can
+ * block uncategorized localStorage/sessionStorage/cookie writes in some products.
  */
-var isAutocompleteDebugEnabled = exports.isAutocompleteDebugEnabled = function isAutocompleteDebugEnabled() {
+
+var hasUrlDebugFlag = function hasUrlDebugFlag() {
+  if (typeof window === 'undefined') {
+    return false;
+  }
   try {
-    return typeof localStorage !== 'undefined' && localStorage.getItem('atl-ctc-dbg') === '1';
+    return new URLSearchParams(window.location.search).get('atlCtcDebug') === '1';
   } catch (_unused) {
     return false;
   }
-};
+};
+
+// State lives on the window object (not a module closure) so duplicate copies of this
+// module across separate bundles/realms share one source of truth and the console API
+// controls them all. In-memory only; persisted across reload via the URL flag.
+var getDebugApi = function getDebugApi() {
+  if (typeof window === 'undefined') {
+    return undefined;
+  }
+  if (!window.__atlCtcDebug__) {
+    var debugEnabled = hasUrlDebugFlag();
+    window.__atlCtcDebug__ = {
+      enable: function enable() {
+        debugEnabled = true;
+      },
+      disable: function disable() {
+        debugEnabled = false;
+      },
+      isEnabled: function isEnabled() {
+        return debugEnabled;
+      }
+    };
+  }
+  return window.__atlCtcDebug__;
+};
+var isAutocompleteDebugEnabled = exports.isAutocompleteDebugEnabled = function isAutocompleteDebugEnabled() {
+  var _getDebugApi$isEnable, _getDebugApi;
+  return (_getDebugApi$isEnable = (_getDebugApi = getDebugApi()) === null || _getDebugApi === void 0 ? void 0 : _getDebugApi.isEnabled()) !== null && _getDebugApi$isEnable !== void 0 ? _getDebugApi$isEnable : false;
+};
+
+// Eagerly install so the console API is available on load, regardless of call order.
+getDebugApi();

package/dist/es2019/pm-plugins/debug-mode.js

@@ -1,18 +1,57 @@
 /**
  * Contextual Typeahead Completions (CTC) debug logging utility.
  *
- * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ * Logs are silent by default. Enable in any environment (dev, staging, prod):
  *
- *   localStorage.setItem('atl-ctc-dbg', '1')
+ *   // Live, for the current session (no reload required):
+ *   __atlCtcDebug__.enable()
  *
- * Then reload the page. To disable:
+ *   // To disable:
+ *   __atlCtcDebug__.disable()
  *
- *   localStorage.removeItem('atl-ctc-dbg')
+ *   // From initial page load (survives reload) — append to the URL:
+ *   ?atlCtcDebug=1
+ *
+ * Storage-free by design: avoids browser-storage consent controls (BSC), which can
+ * block uncategorized localStorage/sessionStorage/cookie writes in some products.
  */
-export const isAutocompleteDebugEnabled = () => {
+
+const hasUrlDebugFlag = () => {
+  if (typeof window === 'undefined') {
+    return false;
+  }
   try {
-    return typeof localStorage !== 'undefined' && localStorage.getItem('atl-ctc-dbg') === '1';
+    return new URLSearchParams(window.location.search).get('atlCtcDebug') === '1';
   } catch {
     return false;
   }
-};
+};
+
+// State lives on the window object (not a module closure) so duplicate copies of this
+// module across separate bundles/realms share one source of truth and the console API
+// controls them all. In-memory only; persisted across reload via the URL flag.
+const getDebugApi = () => {
+  if (typeof window === 'undefined') {
+    return undefined;
+  }
+  if (!window.__atlCtcDebug__) {
+    let debugEnabled = hasUrlDebugFlag();
+    window.__atlCtcDebug__ = {
+      enable: () => {
+        debugEnabled = true;
+      },
+      disable: () => {
+        debugEnabled = false;
+      },
+      isEnabled: () => debugEnabled
+    };
+  }
+  return window.__atlCtcDebug__;
+};
+export const isAutocompleteDebugEnabled = () => {
+  var _getDebugApi$isEnable, _getDebugApi;
+  return (_getDebugApi$isEnable = (_getDebugApi = getDebugApi()) === null || _getDebugApi === void 0 ? void 0 : _getDebugApi.isEnabled()) !== null && _getDebugApi$isEnable !== void 0 ? _getDebugApi$isEnable : false;
+};
+
+// Eagerly install so the console API is available on load, regardless of call order.
+getDebugApi();

package/dist/esm/pm-plugins/debug-mode.js

@@ -1,18 +1,59 @@
 /**
  * Contextual Typeahead Completions (CTC) debug logging utility.
  *
- * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ * Logs are silent by default. Enable in any environment (dev, staging, prod):
  *
- *   localStorage.setItem('atl-ctc-dbg', '1')
+ *   // Live, for the current session (no reload required):
+ *   __atlCtcDebug__.enable()
  *
- * Then reload the page. To disable:
+ *   // To disable:
+ *   __atlCtcDebug__.disable()
  *
- *   localStorage.removeItem('atl-ctc-dbg')
+ *   // From initial page load (survives reload) — append to the URL:
+ *   ?atlCtcDebug=1
+ *
+ * Storage-free by design: avoids browser-storage consent controls (BSC), which can
+ * block uncategorized localStorage/sessionStorage/cookie writes in some products.
  */
-export var isAutocompleteDebugEnabled = function isAutocompleteDebugEnabled() {
+
+var hasUrlDebugFlag = function hasUrlDebugFlag() {
+  if (typeof window === 'undefined') {
+    return false;
+  }
   try {
-    return typeof localStorage !== 'undefined' && localStorage.getItem('atl-ctc-dbg') === '1';
+    return new URLSearchParams(window.location.search).get('atlCtcDebug') === '1';
   } catch (_unused) {
     return false;
   }
-};
+};
+
+// State lives on the window object (not a module closure) so duplicate copies of this
+// module across separate bundles/realms share one source of truth and the console API
+// controls them all. In-memory only; persisted across reload via the URL flag.
+var getDebugApi = function getDebugApi() {
+  if (typeof window === 'undefined') {
+    return undefined;
+  }
+  if (!window.__atlCtcDebug__) {
+    var debugEnabled = hasUrlDebugFlag();
+    window.__atlCtcDebug__ = {
+      enable: function enable() {
+        debugEnabled = true;
+      },
+      disable: function disable() {
+        debugEnabled = false;
+      },
+      isEnabled: function isEnabled() {
+        return debugEnabled;
+      }
+    };
+  }
+  return window.__atlCtcDebug__;
+};
+export var isAutocompleteDebugEnabled = function isAutocompleteDebugEnabled() {
+  var _getDebugApi$isEnable, _getDebugApi;
+  return (_getDebugApi$isEnable = (_getDebugApi = getDebugApi()) === null || _getDebugApi === void 0 ? void 0 : _getDebugApi.isEnabled()) !== null && _getDebugApi$isEnable !== void 0 ? _getDebugApi$isEnable : false;
+};
+
+// Eagerly install so the console API is available on load, regardless of call order.
+getDebugApi();

package/dist/types/pm-plugins/debug-mode.d.ts

@@ -1,12 +1,27 @@
 /**
  * Contextual Typeahead Completions (CTC) debug logging utility.
  *
- * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ * Logs are silent by default. Enable in any environment (dev, staging, prod):
  *
- *   localStorage.setItem('atl-ctc-dbg', '1')
+ *   // Live, for the current session (no reload required):
+ *   __atlCtcDebug__.enable()
  *
- * Then reload the page. To disable:
+ *   // To disable:
+ *   __atlCtcDebug__.disable()
  *
- *   localStorage.removeItem('atl-ctc-dbg')
+ *   // From initial page load (survives reload) — append to the URL:
+ *   ?atlCtcDebug=1
+ *
+ * Storage-free by design: avoids browser-storage consent controls (BSC), which can
+ * block uncategorized localStorage/sessionStorage/cookie writes in some products.
  */
+declare global {
+    interface Window {
+        __atlCtcDebug__?: {
+            enable: () => void;
+            disable: () => void;
+            isEnabled: () => boolean;
+        };
+    }
+}
 export declare const isAutocompleteDebugEnabled: () => boolean;

package/dist/types-ts4.5/pm-plugins/debug-mode.d.ts

@@ -1,12 +1,27 @@
 /**
  * Contextual Typeahead Completions (CTC) debug logging utility.
  *
- * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ * Logs are silent by default. Enable in any environment (dev, staging, prod):
  *
- *   localStorage.setItem('atl-ctc-dbg', '1')
+ *   // Live, for the current session (no reload required):
+ *   __atlCtcDebug__.enable()
  *
- * Then reload the page. To disable:
+ *   // To disable:
+ *   __atlCtcDebug__.disable()
  *
- *   localStorage.removeItem('atl-ctc-dbg')
+ *   // From initial page load (survives reload) — append to the URL:
+ *   ?atlCtcDebug=1
+ *
+ * Storage-free by design: avoids browser-storage consent controls (BSC), which can
+ * block uncategorized localStorage/sessionStorage/cookie writes in some products.
  */
+declare global {
+    interface Window {
+        __atlCtcDebug__?: {
+            enable: () => void;
+            disable: () => void;
+            isEnabled: () => boolean;
+        };
+    }
+}
 export declare const isAutocompleteDebugEnabled: () => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-autocomplete",
-	"version": "3.4.1",
+	"version": "3.5.0",
 	"description": "Client-side text autocomplete plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/src/pm-plugins/debug-mode.ts

@@ -1,18 +1,65 @@
 /**
  * Contextual Typeahead Completions (CTC) debug logging utility.
  *
- * Logs are silent by default. To enable in any environment (dev, staging, prod):
+ * Logs are silent by default. Enable in any environment (dev, staging, prod):
  *
- *   localStorage.setItem('atl-ctc-dbg', '1')
+ *   // Live, for the current session (no reload required):
+ *   __atlCtcDebug__.enable()
  *
- * Then reload the page. To disable:
+ *   // To disable:
+ *   __atlCtcDebug__.disable()
  *
- *   localStorage.removeItem('atl-ctc-dbg')
+ *   // From initial page load (survives reload) — append to the URL:
+ *   ?atlCtcDebug=1
+ *
+ * Storage-free by design: avoids browser-storage consent controls (BSC), which can
+ * block uncategorized localStorage/sessionStorage/cookie writes in some products.
  */
-export const isAutocompleteDebugEnabled = (): boolean => {
+
+declare global {
+	interface Window {
+		__atlCtcDebug__?: {
+			enable: () => void;
+			disable: () => void;
+			isEnabled: () => boolean;
+		};
+	}
+}
+
+const hasUrlDebugFlag = (): boolean => {
+	if (typeof window === 'undefined') {
+		return false;
+	}
 	try {
-		return typeof localStorage !== 'undefined' && localStorage.getItem('atl-ctc-dbg') === '1';
+		return new URLSearchParams(window.location.search).get('atlCtcDebug') === '1';
 	} catch {
 		return false;
 	}
 };
+
+// State lives on the window object (not a module closure) so duplicate copies of this
+// module across separate bundles/realms share one source of truth and the console API
+// controls them all. In-memory only; persisted across reload via the URL flag.
+const getDebugApi = (): Window['__atlCtcDebug__'] => {
+	if (typeof window === 'undefined') {
+		return undefined;
+	}
+	if (!window.__atlCtcDebug__) {
+		let debugEnabled = hasUrlDebugFlag();
+		window.__atlCtcDebug__ = {
+			enable: () => {
+				debugEnabled = true;
+			},
+			disable: () => {
+				debugEnabled = false;
+			},
+			isEnabled: () => debugEnabled,
+		};
+	}
+	return window.__atlCtcDebug__;
+};
+
+export const isAutocompleteDebugEnabled = (): boolean => getDebugApi()?.isEnabled() ?? false;
+
+// Eagerly install so the console API is available on load, regardless of call order.
+getDebugApi();