@thoughtspot/visual-embed-sdk 1.50.0 → 1.51.0-test

package/src/embed/hostEventClient/utils.ts

@@ -1,27 +1,40 @@
+import isNil from 'lodash/isNil';
+import isPlainObject from 'lodash/isPlainObject';
+import isString from 'lodash/isString';
+import isUndefined from 'lodash/isUndefined';
 import { EmbedErrorCodes, EmbedEvent, ErrorDetailsTypes, HostEvent } from '../../types';
 import { ERROR_MESSAGE } from '../../errors';
-import { HostEventRequest } from './contracts';
+import { ApplicabilityLevel, HostEventRequest } from './contracts';
 import { embedEventStatus } from '../../utils';
 
+const isValidApplicability = (a?: { level?: string; targetId?: string }) => {
+  if (isUndefined(a)) return true;
+  // targetId is not required at LIVEBOARD level, since the filter applies to the whole Liveboard
+  return isPlainObject(a)
+      && Object.values(ApplicabilityLevel).includes(a.level as ApplicabilityLevel)
+      && (a.level === ApplicabilityLevel.Liveboard || (isString(a.targetId) && a.targetId.trim().length > 0));
+};
+
 export function isValidUpdateFiltersPayload(
   payload: HostEventRequest<HostEvent.UpdateFilters> | undefined,
 ): boolean {
   if (!payload) return false;
 
-  const isValidFilter = (f: { 
-    column?: string; 
-    oper?: string; 
-    values?: unknown[]; 
-    type?: string; 
-    columnName?: string; 
-    operator?: string 
+  const isValidFilter = (f: {
+    column?: string;
+    oper?: string;
+    values?: unknown[];
+    type?: string;
+    columnName?: string;
+    operator?: string;
+    applicability?: { level?: string; targetId?: string };
   }) => {
     const hasColumn = typeof f.column === 'string' || typeof f.columnName === 'string';
     const hasOperator = typeof f.oper === 'string' || typeof f.operator === 'string';
     const hasValues = Array.isArray(f.values);
     const validType = !f.type || typeof f.type === 'string';
-  
-    return hasColumn && hasOperator && hasValues && validType;
+
+    return hasColumn && hasOperator && hasValues && validType && isValidApplicability(f.applicability);
   };
 
   const hasValidFilter = payload.filter && isValidFilter(payload.filter);
@@ -30,6 +43,16 @@ export function isValidUpdateFiltersPayload(
   return !!(hasValidFilter || hasValidFilters);
 }
 
+export function isValidUpdateParametersPayload(payload: unknown): boolean {
+  // Only validates the applicability of each parameter (null treated as absent); the rest is forwarded as-is for backward compatibility.
+  if (!Array.isArray(payload)) return true;
+  return payload.every((p) => {
+      if (!isPlainObject(p)) return true;
+      const { applicability } = p as { applicability?: { level?: string; targetId?: string } };
+      return isNil(applicability) || isValidApplicability(applicability);
+  });
+}
+
 export function isValidDrillDownPayload(
   payload: HostEventRequest<HostEvent.DrillDown> | undefined,
 ): boolean {
@@ -72,3 +95,7 @@ export function throwUpdateFiltersValidationError(): never {
 export function throwDrillDownValidationError(): never {
   createValidationError(ERROR_MESSAGE.DRILLDOWN_INVALID_PAYLOAD);
 }
+
+export function throwUpdateParametersValidationError(): never {
+  createValidationError(ERROR_MESSAGE.UPDATEPARAMETERS_INVALID_PAYLOAD);
+}