@thoughtspot/visual-embed-sdk 1.40.1-alpha.3 → 1.40.2

package/lib/src/utils/custom-actions.js

@@ -0,0 +1,186 @@
+import { CustomActionsPosition, CustomActionTarget } from '../types';
+import { arrayIncludesString } from '../utils';
+import sortBy from 'lodash/sortBy';
+import { CUSTOM_ACTIONS_ERROR_MESSAGE } from '../errors';
+/**
+ * Configuration for custom action validation rules.
+ * Defines allowed positions, metadata IDs, data model IDs, and fields for each target
+ * type.
+ *
+ */
+const customActionValidationConfig = {
+    [CustomActionTarget.LIVEBOARD]: {
+        positions: [CustomActionsPosition.PRIMARY, CustomActionsPosition.MENU],
+        allowedMetadataIds: ['liveboardIds'],
+        allowedDataModelIds: [],
+        allowedFields: ['name', 'id', 'position', 'target', 'metadataIds', 'orgIds', 'groupIds'],
+    },
+    [CustomActionTarget.VIZ]: {
+        positions: [CustomActionsPosition.MENU, CustomActionsPosition.PRIMARY, CustomActionsPosition.CONTEXTMENU],
+        allowedMetadataIds: ['liveboardIds', 'vizIds', 'answerIds'],
+        allowedDataModelIds: ['modelIds', 'modelColumnNames'],
+        allowedFields: ['name', 'id', 'position', 'target', 'metadataIds', 'orgIds', 'groupIds', 'dataModelIds'],
+    },
+    [CustomActionTarget.ANSWER]: {
+        positions: [CustomActionsPosition.MENU, CustomActionsPosition.PRIMARY, CustomActionsPosition.CONTEXTMENU],
+        allowedMetadataIds: ['answerIds'],
+        allowedDataModelIds: ['modelIds', 'modelColumnNames'],
+        allowedFields: ['name', 'id', 'position', 'target', 'metadataIds', 'orgIds', 'groupIds', 'dataModelIds'],
+    },
+    [CustomActionTarget.SPOTTER]: {
+        positions: [CustomActionsPosition.MENU, CustomActionsPosition.CONTEXTMENU],
+        allowedMetadataIds: [],
+        allowedDataModelIds: ['modelIds'],
+        allowedFields: ['name', 'id', 'position', 'target', 'orgIds', 'groupIds', 'dataModelIds'],
+    },
+};
+/**
+ * Validates a single custom action based on its target type
+ * @param action - The custom action to validate
+ * @param primaryActionsPerTarget - Map to track primary actions per target
+ * @returns CustomActionValidation with isValid flag and reason string
+ *
+ * @hidden
+ */
+const validateCustomAction = (action, primaryActionsPerTarget) => {
+    const { id: actionId, target: targetType, position, metadataIds, dataModelIds } = action;
+    // Check if target type is supported
+    if (!customActionValidationConfig[targetType]) {
+        const errorMessage = CUSTOM_ACTIONS_ERROR_MESSAGE.UNSUPPORTED_TARGET(actionId, targetType);
+        return { isValid: false, errors: [errorMessage] };
+    }
+    const config = customActionValidationConfig[targetType];
+    const errors = [];
+    // Validate position
+    if (!arrayIncludesString(config.positions, position)) {
+        const supportedPositions = config.positions.join(', ');
+        errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.INVALID_POSITION(position, targetType, supportedPositions));
+    }
+    // Check for primary action conflicts (this is a warning, not a validation
+    // failure)
+    if (position === CustomActionsPosition.PRIMARY) {
+        const existingPrimaryAction = primaryActionsPerTarget.get(targetType);
+        if (existingPrimaryAction) {
+            errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.MULTIPLE_PRIMARY_ACTIONS(targetType, existingPrimaryAction.name, action.name));
+        }
+        else {
+            primaryActionsPerTarget.set(targetType, action);
+        }
+    }
+    // Validate metadata IDs
+    if (metadataIds) {
+        const invalidMetadataIds = Object.keys(metadataIds).filter((key) => !arrayIncludesString(config.allowedMetadataIds, key));
+        if (invalidMetadataIds.length > 0) {
+            const supportedMetadataIds = config.allowedMetadataIds.length > 0 ? config.allowedMetadataIds.join(', ') : 'none';
+            errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.INVALID_METADATA_IDS(targetType, invalidMetadataIds, supportedMetadataIds));
+        }
+    }
+    // Validate data model IDs
+    if (dataModelIds) {
+        const invalidDataModelIds = Object.keys(dataModelIds).filter((key) => !arrayIncludesString(config.allowedDataModelIds, key));
+        if (invalidDataModelIds.length > 0) {
+            const supportedDataModelIds = config.allowedDataModelIds.length > 0 ? config.allowedDataModelIds.join(', ') : 'none';
+            errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.INVALID_DATA_MODEL_IDS(targetType, invalidDataModelIds, supportedDataModelIds));
+        }
+    }
+    // Validate allowed fields
+    const actionKeys = Object.keys(action);
+    const invalidFields = actionKeys.filter((key) => !arrayIncludesString(config.allowedFields, key));
+    if (invalidFields.length > 0) {
+        const supportedFields = config.allowedFields.join(', ');
+        errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.INVALID_FIELDS(targetType, invalidFields, supportedFields));
+    }
+    return {
+        isValid: errors.length === 0,
+        errors,
+    };
+};
+/**
+ * Validates basic action structure and required fields
+ * @param action - The action to validate
+ * @returns Object containing validation result and missing fields
+ *
+ * @hidden
+ */
+const validateActionStructure = (action) => {
+    if (!action || typeof action !== 'object') {
+        return { isValid: false, missingFields: [] };
+    }
+    // Check for all missing required fields
+    const missingFields = ['id', 'name', 'target', 'position'].filter(field => !action[field]);
+    return { isValid: missingFields.length === 0, missingFields };
+};
+/**
+ * Checks for duplicate IDs among actions
+ * @param actions - Array of actions to check
+ * @returns Object containing filtered actions and duplicate errors
+ *
+ * @hidden
+ */
+const filterDuplicateIds = (actions) => {
+    const idMap = actions.reduce((map, action) => {
+        const list = map.get(action.id) || [];
+        list.push(action);
+        map.set(action.id, list);
+        return map;
+    }, new Map());
+    const { actions: actionsWithUniqueIds, errors } = Array.from(idMap.entries()).reduce((acc, [id, actionsWithSameId]) => {
+        if (actionsWithSameId.length === 1) {
+            acc.actions.push(actionsWithSameId[0]);
+        }
+        else {
+            // Keep the first action and add error for duplicates
+            acc.actions.push(actionsWithSameId[0]);
+            const duplicateNames = actionsWithSameId.slice(1).map(action => action.name);
+            acc.errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.DUPLICATE_IDS(id, duplicateNames, actionsWithSameId[0].name));
+        }
+        return acc;
+    }, { actions: [], errors: [] });
+    return { actions: actionsWithUniqueIds, errors };
+};
+/**
+ * Validates and processes custom actions
+ * @param customActions - Array of custom actions to validate
+ * @returns Object containing valid actions and any validation errors
+ */
+export const getCustomActions = (customActions) => {
+    const errors = [];
+    const primaryActionsPerTarget = new Map();
+    if (!customActions || !Array.isArray(customActions)) {
+        return { actions: [], errors: [] };
+    }
+    // Step 1: Handle invalid actions first (null, undefined, missing required
+    // fields)
+    const validActions = customActions.filter(action => {
+        const validation = validateActionStructure(action);
+        if (!validation.isValid) {
+            if (!action || typeof action !== 'object') {
+                errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.INVALID_ACTION_OBJECT);
+            }
+            else {
+                errors.push(CUSTOM_ACTIONS_ERROR_MESSAGE.MISSING_REQUIRED_FIELDS(action.id, validation.missingFields));
+            }
+            return false;
+        }
+        return true;
+    });
+    // Step 2: Check for duplicate IDs among valid actions
+    const { actions: actionsWithUniqueIds, errors: duplicateErrors } = filterDuplicateIds(validActions);
+    // Add duplicate errors to the errors array
+    duplicateErrors.forEach(error => errors.push(error));
+    // Step 3: Validate actions with unique IDs
+    const finalValidActions = [];
+    actionsWithUniqueIds.forEach((action) => {
+        const { isValid, errors: validationErrors } = validateCustomAction(action, primaryActionsPerTarget);
+        validationErrors.forEach(error => errors.push(error));
+        if (isValid) {
+            finalValidActions.push(action);
+        }
+    });
+    const sortedActions = sortBy(finalValidActions, (a) => a.name.toLocaleLowerCase());
+    return {
+        actions: sortedActions,
+        errors: errors,
+    };
+};
+//# sourceMappingURL=custom-actions.js.map

package/lib/src/utils/custom-actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-actions.js","sourceRoot":"","sources":["../../../src/utils/custom-actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,MAAM,MAAM,eAAe,CAAC;AACnC,OAAO,EAAE,4BAA4B,EAAE,MAAM,WAAW,CAAC;AAYzD;;;;;GAKG;AACH,MAAM,4BAA4B,GAK7B;IACD,CAAC,kBAAkB,CAAC,SAAS,CAAC,EAAE;QAC5B,SAAS,EAAE,CAAC,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,CAAC,IAAI,CAAC;QACtE,kBAAkB,EAAE,CAAC,cAAc,CAAC;QACpC,mBAAmB,EAAE,EAAE;QACvB,aAAa,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,CAAC;KAC3F;IACD,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE;QACtB,SAAS,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,CAAC,WAAW,CAAC;QACzG,kBAAkB,EAAE,CAAC,cAAc,EAAE,QAAQ,EAAE,WAAW,CAAC;QAC3D,mBAAmB,EAAE,CAAC,UAAU,EAAE,kBAAkB,CAAC;QACrD,aAAa,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,CAAC;KAC3G;IACD,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE;QACzB,SAAS,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,CAAC,WAAW,CAAC;QACzG,kBAAkB,EAAE,CAAC,WAAW,CAAC;QACjC,mBAAmB,EAAE,CAAC,UAAU,EAAE,kBAAkB,CAAC;QACrD,aAAa,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,CAAC;KAC3G;IACD,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE;QAC1B,SAAS,EAAE,CAAC,qBAAqB,CAAC,IAAI,EAAE,qBAAqB,CAAC,WAAW,CAAC;QAC1E,kBAAkB,EAAE,EAAE;QACtB,mBAAmB,EAAE,CAAC,UAAU,CAAC;QACjC,aAAa,EAAE,CAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,CAAC;KAC5F;CACJ,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,oBAAoB,GAAG,CAAC,MAAoB,EAAE,uBAA8D,EAA0B,EAAE;IAC1I,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC;IAEzF,oCAAoC;IACpC,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,EAAE;QAC3C,MAAM,YAAY,GAAG,4BAA4B,CAAC,kBAAkB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAC3F,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC;KACrD;IAED,MAAM,MAAM,GAAG,4BAA4B,CAAC,UAAU,CAAC,CAAC;IACxD,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,oBAAoB;IACpB,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;QAClD,MAAM,kBAAkB,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,gBAAgB,CAAC,QAAQ,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC,CAAC;KACxG;IAED,0EAA0E;IAC1E,WAAW;IACX,IAAI,QAAQ,KAAK,qBAAqB,CAAC,OAAO,EAAE;QAC5C,MAAM,qBAAqB,GAAG,uBAAuB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACtE,IAAI,qBAAqB,EAAE;YACvB,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,wBAAwB,CAAC,UAAU,EAAE,qBAAqB,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3H;aAAM;YACH,uBAAuB,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;SACnD;KACJ;IAED,wBAAwB;IACxB,IAAI,WAAW,EAAE;QACb,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CACtD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAChE,CAAC;QACF,IAAI,kBAAkB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,oBAAoB,GAAG,MAAM,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YAClH,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,oBAAoB,CAAC,UAAU,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,CAAC,CAAC;SACxH;KACJ;IAED,0BAA0B;IAC1B,IAAI,YAAY,EAAE;QACd,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CACxD,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,mBAAmB,EAAE,GAAG,CAAC,CACjE,CAAC;QACF,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,MAAM,qBAAqB,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;YACrH,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,sBAAsB,CAAC,UAAU,EAAE,mBAAmB,EAAE,qBAAqB,CAAC,CAAC,CAAC;SAC5H;KACJ;IAED,0BAA0B;IAC1B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,mBAAmB,CAAC,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC;IAClG,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE;QAC1B,MAAM,eAAe,GAAG,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,cAAc,CAAC,UAAU,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC,CAAC;KACxG;IAED,OAAO;QACH,OAAO,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM;KACT,CAAC;AACN,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,uBAAuB,GAAG,CAAC,MAAW,EAAiD,EAAE;IAC3F,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;QACvC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC;KAChD;IAED,wCAAwC;IACxC,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;IAC3F,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,aAAa,EAAE,CAAC;AAClE,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,kBAAkB,GAAG,CAAC,OAAuB,EAAiD,EAAE;IAClG,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;QACzC,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;QACtC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClB,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;QACzB,OAAO,GAAG,CAAC;IACf,CAAC,EAAE,IAAI,GAAG,EAA0B,CAAC,CAAC;IAEtC,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAChF,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,iBAAiB,CAAC,EAAE,EAAE;QAC7B,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;SAC1C;aAAM;YACH,qDAAqD;YACrD,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC7E,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,aAAa,CAAC,EAAE,EAAE,cAAc,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;SAC9G;QACD,OAAO,GAAG,CAAC;IACf,CAAC,EACD,EAAE,OAAO,EAAE,EAAoB,EAAE,MAAM,EAAE,EAAc,EAAE,CAC5D,CAAC;IAEF,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,CAAC;AACrD,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,aAA6B,EAAiC,EAAE;IAC7F,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,uBAAuB,GAAG,IAAI,GAAG,EAAoC,CAAC;IAE5E,IAAI,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;QACjD,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;KACtC;IAED,0EAA0E;IAC1E,UAAU;IACV,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE;QAC/C,MAAM,UAAU,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE;YACrB,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE;gBACvC,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,qBAAqB,CAAC,CAAC;aACnE;iBAAM;gBACH,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,uBAAuB,CAAE,MAAc,CAAC,EAAE,EAAE,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;aACnH;YACD,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,sDAAsD;IACtD,MAAM,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC,YAAY,CAAC,CAAC;IAEpG,2CAA2C;IAC3C,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAErD,2CAA2C;IAC3C,MAAM,iBAAiB,GAAmB,EAAE,CAAC;IAC7C,oBAAoB,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACpC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAG,oBAAoB,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAC;QACpG,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QAEtD,IAAI,OAAO,EAAE;YACT,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAEnF,OAAO;QACH,OAAO,EAAE,aAAa;QACtB,MAAM,EAAE,MAAM;KACjB,CAAC;AACN,CAAC,CAAC"}

package/lib/src/utils/custom-actions.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=custom-actions.spec.d.ts.map

package/lib/src/utils/custom-actions.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-actions.spec.d.ts","sourceRoot":"","sources":["../../../src/utils/custom-actions.spec.ts"],"names":[],"mappings":""}

package/lib/src/utils/custom-actions.spec.js

@@ -0,0 +1,435 @@
+import { getCustomActions } from './custom-actions';
+import { CustomActionsPosition, CustomActionTarget } from '../types';
+// Mock logger
+jest.mock('./logger', () => ({
+    logger: {
+        warn: jest.fn(),
+        error: jest.fn(),
+    },
+}));
+describe('getCustomActions function', () => {
+    describe('Static getCustomActions method', () => {
+        test('should return empty result for empty array', () => {
+            const result = getCustomActions([]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toEqual([]);
+        });
+        test('should return empty result for null/undefined input', () => {
+            const result1 = getCustomActions(null);
+            expect(result1.actions).toEqual([]);
+            expect(result1.errors).toEqual([]);
+            const result2 = getCustomActions(undefined);
+            expect(result2.actions).toEqual([]);
+            expect(result2.errors).toEqual([]);
+        });
+        test('should validate and return valid actions', () => {
+            const actions = [
+                {
+                    name: 'Test Action',
+                    id: 'test-id',
+                    target: CustomActionTarget.LIVEBOARD,
+                    position: CustomActionsPosition.PRIMARY,
+                },
+            ];
+            const result = getCustomActions(actions);
+            expect(result.actions).toEqual(actions);
+            expect(result.errors).toEqual([]);
+        });
+        test('should reject invalid actions and collect errors', () => {
+            const actions = [
+                {
+                    name: 'Valid Action',
+                    id: 'valid-id',
+                    target: CustomActionTarget.LIVEBOARD,
+                    position: CustomActionsPosition.PRIMARY,
+                },
+                {
+                    name: 'Invalid Action',
+                    id: 'invalid-id',
+                    target: CustomActionTarget.SPOTTER,
+                    position: CustomActionsPosition.PRIMARY, // Invalid for SPOTTER
+                },
+            ];
+            const result = getCustomActions(actions);
+            expect(result.actions).toEqual([actions[0]]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Position 'PRIMARY' is not supported for spotter-level custom actions. Supported positions: MENU, CONTEXTMENU");
+        });
+        test('should sort actions by name', () => {
+            const actions = [
+                {
+                    name: 'Zebra Action',
+                    id: 'zebra-id',
+                    target: CustomActionTarget.LIVEBOARD,
+                    position: CustomActionsPosition.PRIMARY,
+                },
+                {
+                    name: 'Alpha Action',
+                    id: 'alpha-id',
+                    target: CustomActionTarget.LIVEBOARD,
+                    position: CustomActionsPosition.MENU,
+                },
+            ];
+            const result = getCustomActions(actions);
+            expect(result.actions).toHaveLength(2);
+            expect(result.actions[0].name).toBe('Alpha Action');
+            expect(result.actions[1].name).toBe('Zebra Action');
+        });
+    });
+    describe('Input Validation', () => {
+        test('should return false for null action', () => {
+            const result = getCustomActions([null]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain('Custom Action Validation Error: Invalid action object provided');
+        });
+        test('should return false for undefined action', () => {
+            const result = getCustomActions([undefined]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain('Custom Action Validation Error: Invalid action object provided');
+        });
+        test('should return false for non-object action', () => {
+            const result = getCustomActions(['string']);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain('Custom Action Validation Error: Invalid action object provided');
+        });
+        test('should return false for action missing id', () => {
+            const action = {
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Missing required fields: id");
+        });
+        test('should return false for action missing name', () => {
+            const action = {
+                id: 'test-id',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Missing required fields: name");
+        });
+        test('should return false for action missing target', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Missing required fields: target");
+        });
+        test('should return false for action missing position', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Missing required fields: position");
+        });
+    });
+    describe('Target Type Validation', () => {
+        test('should reject unsupported target type', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: 'UNSUPPORTED',
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Target type 'UNSUPPORTED' is not supported");
+        });
+        test('should accept LIVEBOARD target type', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+        test('should accept VIZ target type', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.VIZ,
+                position: CustomActionsPosition.MENU,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+        test('should accept ANSWER target type', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.ANSWER,
+                position: CustomActionsPosition.MENU,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+        test('should accept SPOTTER target type', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.SPOTTER,
+                position: CustomActionsPosition.MENU,
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+    });
+    describe('Position Validation', () => {
+        test('should reject invalid position for LIVEBOARD', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.CONTEXTMENU, // Invalid for LIVEBOARD
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors).toContain("Position 'CONTEXTMENU' is not supported for liveboard-level custom actions. Supported positions: PRIMARY, MENU");
+        });
+        test('should reject invalid position for SPOTTER', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.SPOTTER,
+                position: CustomActionsPosition.PRIMARY, // Invalid for SPOTTER
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Position 'PRIMARY' is not supported for spotter-level custom actions. Supported positions: MENU, CONTEXTMENU");
+        });
+        test('should accept valid positions for LIVEBOARD', () => {
+            const primaryAction = {
+                id: 'primary-id',
+                name: 'Primary Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const menuAction = {
+                id: 'menu-id',
+                name: 'Menu Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.MENU,
+            };
+            const result = getCustomActions([primaryAction, menuAction]);
+            expect(result.actions).toHaveLength(2);
+            expect(result.errors).toEqual([]);
+        });
+    });
+    describe('Primary Action Conflicts', () => {
+        test('should warn about multiple primary actions for same target', () => {
+            const firstAction = {
+                id: 'first-id',
+                name: 'First Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const secondAction = {
+                id: 'second-id',
+                name: 'Second Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([firstAction, secondAction]);
+            expect(result.actions).toHaveLength(1);
+            expect(result.actions[0]).toEqual(firstAction);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Multiple primary actions found for liveboard-level custom actions");
+        });
+        test('should allow multiple primary actions for different targets', () => {
+            const liveboardAction = {
+                id: 'lb-id',
+                name: 'Liveboard Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const vizAction = {
+                id: 'viz-id',
+                name: 'Viz Action',
+                target: CustomActionTarget.VIZ,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const result = getCustomActions([liveboardAction, vizAction]);
+            expect(result.actions).toHaveLength(2);
+            expect(result.errors).toEqual([]);
+        });
+    });
+    describe('Metadata IDs Validation', () => {
+        test('should reject invalid metadata IDs for LIVEBOARD', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+                metadataIds: {
+                    invalidId: 'some-value',
+                },
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Invalid metadata IDs for liveboard-level custom actions: invalidId. Supported metadata IDs: liveboardIds");
+        });
+        test('should accept valid metadata IDs for LIVEBOARD', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+                metadataIds: {
+                    liveboardIds: ['lb-1', 'lb-2'],
+                },
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+    });
+    describe('Data Model IDs Validation', () => {
+        test('should reject invalid data model IDs for VIZ', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.VIZ,
+                position: CustomActionsPosition.MENU,
+                dataModelIds: {
+                    invalidId: 'some-value',
+                },
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Invalid data model IDs for viz-level custom actions: invalidId. Supported data model IDs: modelIds, modelColumnNames");
+        });
+        test('should accept valid data model IDs for VIZ', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.VIZ,
+                position: CustomActionsPosition.MENU,
+                dataModelIds: {
+                    modelIds: ['model-1'],
+                    modelColumnNames: ['col-1'],
+                },
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+    });
+    describe('Field Validation', () => {
+        test('should reject invalid fields for LIVEBOARD', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+                invalidField: 'some-value',
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Invalid fields for liveboard-level custom actions: invalidField. Supported fields: name, id, position, target, metadataIds, orgIds, groupIds");
+        });
+        test('should accept valid fields for LIVEBOARD', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+                orgIds: ['org-1'],
+                groupIds: ['group-1'],
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([action]);
+            expect(result.errors).toEqual([]);
+        });
+    });
+    describe('Duplicate ID Handling', () => {
+        test('should keep only the first action when duplicate IDs are found and report duplicate errors', () => {
+            const action1 = {
+                id: 'duplicate-id',
+                name: 'First Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const action2 = {
+                id: 'duplicate-id',
+                name: 'Second Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.MENU,
+            };
+            const result = getCustomActions([action1, action2]);
+            expect(result.actions).toHaveLength(1);
+            expect(result.actions[0]).toEqual(action1);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Duplicate custom action ID 'duplicate-id' found");
+            expect(result.errors[0]).toContain("Actions with names 'Second Action' will be ignored");
+            expect(result.errors[0]).toContain("Keeping 'First Action'");
+        });
+    });
+    describe('Complex Validation Scenarios', () => {
+        test('should handle multiple validation errors for a single action', () => {
+            const action = {
+                id: 'test-id',
+                name: 'Test Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.CONTEXTMENU,
+                metadataIds: {
+                    invalidId: 'some-value', // Invalid metadata ID
+                },
+                invalidField: 'some-value', // Invalid field
+            };
+            const result = getCustomActions([action]);
+            expect(result.actions).toEqual([]);
+            expect(result.errors).toHaveLength(3);
+            expect(result.errors).toContain("Position 'CONTEXTMENU' is not supported for liveboard-level custom actions. Supported positions: PRIMARY, MENU");
+            expect(result.errors).toContain("Invalid metadata IDs for liveboard-level custom actions: invalidId. Supported metadata IDs: liveboardIds");
+            expect(result.errors).toContain("Invalid fields for liveboard-level custom actions: invalidField. Supported fields: name, id, position, target, metadataIds, orgIds, groupIds");
+        });
+        test('should handle mix of valid and invalid actions', () => {
+            const validAction = {
+                id: 'valid-id',
+                name: 'Valid Action',
+                target: CustomActionTarget.LIVEBOARD,
+                position: CustomActionsPosition.PRIMARY,
+            };
+            const invalidAction = {
+                id: 'invalid-id',
+                name: 'Invalid Action',
+                target: CustomActionTarget.SPOTTER,
+                position: CustomActionsPosition.PRIMARY, // Invalid for SPOTTER
+            };
+            const result = getCustomActions([validAction, invalidAction]);
+            expect(result.actions).toEqual([validAction]);
+            expect(result.errors).toHaveLength(1);
+            expect(result.errors[0]).toContain("Position 'PRIMARY' is not supported for spotter-level custom actions. Supported positions: MENU, CONTEXTMENU");
+        });
+    });
+});
+//# sourceMappingURL=custom-actions.spec.js.map