@thoughtspot/visual-embed-sdk 1.44.2 → 1.44.4-HE-beta.1

package/src/utils.ts

@@ -15,8 +15,10 @@ import {
     DOMSelector,
     RuntimeParameter,
     AllEmbedViewConfig,
+    BaseViewConfig,
 } from './types';
 import { logger } from './utils/logger';
+import { ERROR_MESSAGE } from './errors';
 
 /**
  * Construct a runtime filters query string from the given filters.
@@ -146,7 +148,8 @@ export const isValidCssMargin = (value: string): boolean => {
         return false;
     }
 
-    // This pattern allows for an optional negative sign, and numbers that can be integers or decimals (including leading dot).
+    // This pattern allows for an optional negative sign, and numbers
+    // that can be integers or decimals (including leading dot).
     const cssUnitPattern = /^-?(\d+(\.\d*)?|\.\d+)(px|em|rem|%|vh|vw)$/i;
     const parts = value.trim().split(/\s+/);
 
@@ -393,6 +396,7 @@ export function storeValueInWindow<T>(
     value: T,
     options: { ignoreIfAlreadyExists?: boolean } = {},
 ): T {
+    if (isWindowUndefined()) return value;
     if (!window[sdkWindowKey]) {
         (window as any)[sdkWindowKey] = {};
     }
@@ -406,13 +410,14 @@ export function storeValueInWindow<T>(
 }
 
 /**
- * Retrieves a stored value from the global `window` object under the `_tsEmbedSDK` namespace.
- * @param key - The key whose value needs to be retrieved.
- * @returns The stored value or `undefined` if the key is not found.
+ * Retrieves a stored value from the global 
+ * `window` object under the `_tsEmbedSDK` namespace.
+ * Returns undefined in SSR environment.
  */
-export const getValueFromWindow = <T = any>
-    (key: string): T => (window as any)?.[sdkWindowKey]?.[key];
-
+export const getValueFromWindow = <T = any>(key: string): T | undefined => {
+    if (isWindowUndefined()) return undefined;
+    return (window as any)?.[sdkWindowKey]?.[key];
+};
 /**
  * Check if an array includes a string value
  * @param arr - The array to check
@@ -430,6 +435,7 @@ export const arrayIncludesString = (arr: readonly unknown[], key: string): boole
  * @returns - boolean indicating if the key was reset
  */
 export function resetValueFromWindow(key: string): boolean {
+    if (isWindowUndefined()) return false;
     if (key in window[sdkWindowKey]) {
         delete (window as any)[sdkWindowKey][key];
         return true;
@@ -553,4 +559,25 @@ export const formatTemplate = (template: string, values: Record<string, any>): s
     return template.replace(/\{(\w+)\}/g, (match, key) => {
         return values[key] !== undefined ? String(values[key]) : match;
     });
-};
+};
+
+export const getHostEventsConfig = (viewConfig: BaseViewConfig) => {
+    return {
+        shouldBypassPayloadValidation: viewConfig.shouldBypassPayloadValidation,
+        useHostEventsV2: viewConfig.useHostEventsV2,
+    };
+}
+
+/**
+ * Check if the window is undefined
+ * If the window is undefined, it means the code is running in a SSR environment.
+ * @returns true if the window is undefined, false otherwise
+ * 
+ */
+export const isWindowUndefined = (): boolean => {
+    if(typeof window === 'undefined') {
+        logger.error(ERROR_MESSAGE.SSR_ENVIRONMENT_ERROR);
+        return true;
+    }
+    return false;
+}