snapshot of https://github.com/jitsi/jitsi-meet.git @ fd1749dd28f4138aa80234fc7f311b19aaffa0e7 (2026-09-15)

react/features/dynamic-branding/reducer.ts

@@ -0,0 +1,290 @@
+import ReducerRegistry from '../base/redux/ReducerRegistry';
+import { type Image } from '../virtual-background/constants';
+
+import {
+    SET_DYNAMIC_BRANDING_DATA,
+    SET_DYNAMIC_BRANDING_FAILED,
+    SET_DYNAMIC_BRANDING_READY,
+    UNSET_DYNAMIC_BRANDING
+} from './actionTypes';
+
+
+/**
+ * The name of the redux store/state property which is the root of the redux
+ * state of the feature {@code dynamic-branding}.
+ */
+const STORE_NAME = 'features/dynamic-branding';
+
+const DEFAULT_STATE = {
+
+    /**
+     * The pool of avatar backgrounds.
+     *
+     * @public
+     * @type {Array<string>}
+     */
+    avatarBackgrounds: [],
+
+    /**
+     * The custom background color for the LargeVideo.
+     *
+     * @public
+     * @type {string}
+     */
+    backgroundColor: '',
+
+    /**
+     * The custom background image used on the LargeVideo.
+     *
+     * @public
+     * @type {string}
+     */
+    backgroundImageUrl: '',
+
+    /**
+     * Flag indicating that the branding data can be displayed.
+     * This is used in order to avoid image flickering / text changing(blipping).
+     *
+     * @public
+     * @type {boolean}
+     */
+    customizationReady: false,
+
+    /**
+     * Flag indicating that the dynamic branding data request has failed.
+     * When the request fails there is no logo (JitsiWatermark) displayed.
+     *
+     * @public
+     * @type {boolean}
+     */
+    customizationFailed: false,
+
+    /**
+     * Flag indicating that the dynamic branding has not been modified and should use
+     * the default options.
+     *
+     * @public
+     * @type {boolean}
+     */
+    defaultBranding: true,
+
+    /**
+     * Url for a custom page for DID numbers list.
+     *
+     * @public
+     * @type {string}
+     */
+    didPageUrl: '',
+
+    /**
+     * Whether participant can only send group chat message if `send-groupchat`
+     * feature is enabled in jwt.
+     *
+     * @public
+     * @type {boolean}
+     */
+    groupChatRequiresPermission: false,
+
+    /**
+     * The custom invite domain.
+     *
+     * @public
+     * @type {string}
+     */
+    inviteDomain: '',
+
+    /**
+     * An object containing the mapping between the language and url where the translation
+     * bundle is hosted.
+     *
+     * @public
+     * @type {Object}
+     */
+    labels: null,
+
+    /**
+     * The custom url used when the user clicks the logo.
+     *
+     * @public
+     * @type {string}
+     */
+    logoClickUrl: '',
+
+    /**
+     * The custom logo (JitisWatermark).
+     *
+     * @public
+     * @type {string}
+     */
+    logoImageUrl: '',
+
+    /**
+     * The generated MUI branded theme based on the custom theme json.
+     *
+     * @public
+     * @type {boolean}
+     */
+    muiBrandedTheme: undefined,
+
+    /**
+     * Whether participant can only create polls if `create-polls` feature is enabled in jwt.
+     *
+     * @public
+     * @type {boolean}
+     */
+    pollCreationRequiresPermission: false,
+
+    /**
+     * The lobby/prejoin background.
+     *
+     * @public
+     * @type {string}
+     */
+    premeetingBackground: '',
+
+    /**
+     * Flag used to signal if the app should use a custom logo or not.
+     *
+     * @public
+     * @type {boolean}
+     */
+    useDynamicBrandingData: false,
+
+    /**
+     * An array of images to be used as virtual backgrounds instead of the default ones.
+     *
+     * @public
+     * @type {Array<Object>}
+     */
+    virtualBackgrounds: []
+};
+
+export interface IDynamicBrandingState {
+    avatarBackgrounds: string[];
+    backgroundColor: string;
+    backgroundImageUrl: string;
+    brandedIcons?: Record<string, string>;
+    customizationFailed: boolean;
+    customizationReady: boolean;
+    defaultBranding: boolean;
+    defaultTranscriptionLanguage?: boolean;
+    didPageUrl: string;
+    groupChatRequiresPermission: boolean;
+    inviteDomain: string;
+    labels: Object | null;
+    logoClickUrl: string;
+    logoImageUrl: string;
+    muiBrandedTheme?: boolean;
+    pollCreationRequiresPermission: boolean;
+    premeetingBackground: string;
+    requireRecordingConsent?: boolean;
+    sharedVideoAllowedURLDomains?: Array<string>;
+    showGiphyIntegration?: boolean;
+    skipRecordingConsentInMeeting?: boolean;
+    supportUrl?: string;
+    useDynamicBrandingData: boolean;
+    virtualBackgrounds: Array<Image>;
+}
+
+/**
+ * Reduces redux actions for the purposes of the feature {@code dynamic-branding}.
+ */
+ReducerRegistry.register<IDynamicBrandingState>(STORE_NAME, (state = DEFAULT_STATE, action): IDynamicBrandingState => {
+    switch (action.type) {
+    case SET_DYNAMIC_BRANDING_DATA: {
+        const {
+            avatarBackgrounds,
+            backgroundColor,
+            backgroundImageUrl,
+            brandedIcons,
+            defaultBranding,
+            didPageUrl,
+            groupChatRequiresPermission,
+            inviteDomain,
+            labels,
+            logoClickUrl,
+            logoImageUrl,
+            muiBrandedTheme,
+            pollCreationRequiresPermission,
+            premeetingBackground,
+            requireRecordingConsent,
+            sharedVideoAllowedURLDomains,
+            showGiphyIntegration,
+            skipRecordingConsentInMeeting,
+            supportUrl,
+            virtualBackgrounds
+        } = action.value;
+
+        return {
+            avatarBackgrounds,
+            backgroundColor,
+            backgroundImageUrl,
+            brandedIcons,
+            defaultBranding,
+            didPageUrl,
+            groupChatRequiresPermission,
+            inviteDomain,
+            labels,
+            logoClickUrl,
+            logoImageUrl,
+            muiBrandedTheme,
+            pollCreationRequiresPermission,
+            premeetingBackground,
+            requireRecordingConsent,
+            sharedVideoAllowedURLDomains,
+            showGiphyIntegration,
+            skipRecordingConsentInMeeting,
+            supportUrl,
+            customizationFailed: false,
+            customizationReady: true,
+            useDynamicBrandingData: true,
+            virtualBackgrounds: formatImages(virtualBackgrounds || [])
+        };
+    }
+    case SET_DYNAMIC_BRANDING_FAILED: {
+        return {
+            ...state,
+            customizationReady: true,
+            customizationFailed: true,
+            useDynamicBrandingData: true
+        };
+    }
+    case SET_DYNAMIC_BRANDING_READY:
+        return {
+            ...state,
+            customizationReady: true
+        };
+
+    case UNSET_DYNAMIC_BRANDING:
+        return DEFAULT_STATE;
+    }
+
+    return state;
+});
+
+/**
+ * Transforms the branding images into an array of Images objects ready
+ * to be used as virtual backgrounds.
+ *
+ * @param {Array<string>} images - The branding images.
+ * @private
+ * @returns {{Props}}
+ */
+function formatImages(images: Array<string> | Array<{ src: string; tooltip?: string; }>): Array<Image> {
+    return images.map((img, i) => {
+        let src;
+        let tooltip;
+
+        if (typeof img === 'object') {
+            ({ src, tooltip } = img);
+        } else {
+            src = img;
+        }
+
+        return {
+            id: `branding-${i}`,
+            src,
+            tooltip
+        };
+    });
+}