AG-15846 Added missing UI and customUi components to google-ima3-dai and convert redirect resources with .ts extension to .js

Squashed commit of the following:

commit b1564ee
Author: slvvko <v.leleka@adguard.com>
Date:   Tue Apr 28 09:03:39 2026 -0400

    add tests for convertTsFileNameToJs

commit d83c876
Author: Adam Wróblewski <adam@adguard.com>
Date:   Tue Apr 28 13:44:18 2026 +0200

    Remove test

commit e348060
Author: Adam Wróblewski <adam@adguard.com>
Date:   Tue Apr 28 13:32:51 2026 +0200

    Fix changelog

commit ee91e05
Author: Adam Wróblewski <adam@adguard.com>
Date:   Tue Apr 28 13:24:07 2026 +0200

    Attempt to fix build

commit 3a03df9
Author: Adam Wróblewski <adam@adguard.com>
Date:   Tue Apr 28 12:47:35 2026 +0200

    Convert TypeScript redirect resources to JavaScript files

commit a54f248
Author: Adam Wróblewski <adam@adguard.com>
Date:   Tue Apr 28 12:02:49 2026 +0200

    Add missing `UI` and `customUi` components to `google-ima3-dai`

Author: AdamWr

CHANGELOG.md

@@ -12,8 +12,14 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 
 ## [Unreleased]
 
+### Changed
+
+- Redirect resources with a `.ts` extension are now converted to `.js`.
+
 ### Fixed
 
+- Added the missing `google.ima.dai.api.ui`, `google.ima.dai.api.customUi` surfaces and the
+  default `StreamRequest.ui` container in the `google-ima3-dai` redirect.
 - Added the missing `google.ima.dai.api.StreamRequest.StreamFormat` object to the `google-ima3-dai` redirect.
 
 [Unreleased]: https://github.com/AdguardTeam/Scriptlets/compare/v2.4.2...HEAD
@@ -32,7 +38,7 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
 
 - `google-ima3-dai` redirect resource and scriptlet [#239].
 
-## Changed
+### Changed
 
 - Updated [@adguard/agtree] to 4.1.1
 

scripts/build-redirects.js

@@ -10,7 +10,7 @@ import { fileURLToPath } from 'node:url';
 import * as redirectsNamesLists from '../src/redirects/redirects-names-list';
 import { version } from '../package.json';
 import { rollupStandard } from './rollup-runners';
-import { writeFile, getDataFromFiles } from './helpers';
+import { writeFile, getDataFromFiles, convertTsFileNameToJs } from './helpers';
 import {
     redirectsFilenames,
     REDIRECTS_SRC_RELATIVE_DIR_PATH,
@@ -210,7 +210,7 @@ const getJsRedirects = async (options = {}) => {
                 aliases: complement.aliases,
                 contentType: 'application/javascript',
                 content: complement.redirect,
-                file: fileName,
+                file: convertTsFileNameToJs(fileName),
             };
         }
         throw new Error(`Couldn't find source for non-static redirect: ${fileName}`);

scripts/helpers.js

@@ -150,12 +150,22 @@ const generateHtmlTestFilename = (type, name) => {
     return `${type}-${name}.html`;
 };
 
+/**
+ * Converts a redirect source filename from ".ts" to ".js" extension.
+ * Filenames that already use ".js" or any other extension are returned unchanged.
+ *
+ * @param {string} fileName redirect source filename
+ * @returns {string} filename with ".ts" replaced by ".js"
+ */
+const convertTsFileNameToJs = (fileName) => fileName.replace(/\.ts$/, '.js');
+
 export {
     writeFile,
     getFilesList,
     getDataFromFiles,
     runTasks,
     generateHtmlTestFilename,
+    convertTsFileNameToJs,
     SCRIPTLET_TYPE,
     TRUSTED_SCRIPTLET_TYPE,
     REDIRECT_TYPE,

src/redirects/google-ima3-dai.ts

@@ -38,6 +38,11 @@ interface StreamRequestInstance extends PlainRecord {
     networkCode: string | null;
     omidAccessModeRules: PlainRecord | null;
     streamActivityMonitorId: string | null;
+    ui: StreamRequestUiInstance;
+}
+
+interface StreamRequestUiInstance extends PlainRecord {
+    custom: PlainRecord | null;
 }
 
 interface LiveStreamRequestInstance extends StreamRequestInstance {
@@ -102,6 +107,46 @@ interface UiSettingsInstance {
     setLocale(locale: string): void;
 }
 
+interface UiImageInstance {
+    altText: string;
+    height: number;
+    url: string;
+    width: number;
+}
+
+interface UiDataInstance extends PlainRecord {
+    altText?: string;
+    clickable: boolean;
+    clickUrl?: string;
+    imageUrl?: string;
+    imageVariants?: UiImageInstance[];
+    required: boolean;
+    text?: string;
+}
+
+interface UiOptionsInstance {
+    aboutThisAdSupport: boolean;
+    clickThroughNavigation: string;
+    skippableSupport: boolean;
+}
+
+interface CustomUiOptionsInstance {
+    aboutThisAdSupport: boolean;
+    skippableSupport: boolean;
+}
+
+interface UiDelegateInstance extends PlainRecord {
+    getConfig?: () => Map<string, UiDataInstance>;
+    onClick?: (uiKey: string, eventData?: unknown) => void;
+    setVisibleElements?: (uiElements: unknown) => void;
+}
+
+interface UiInstance {
+    getConfig(): Map<string, UiDataInstance>;
+    onClick(uiKey: string, eventData?: unknown): void;
+    setVisibleElements(uiElements: unknown): void;
+}
+
 interface DaiSdkSettingsInstance {
     getFeatureFlags(): PlainRecord;
     setFeatureFlags(featureFlags: PlainRecord): void;
@@ -189,6 +234,39 @@ type UiSettingsConstructor = {
     prototype: UiSettingsInstance;
 };
 
+type UiImageConstructor = {
+    new (uiImage?: PlainRecord | null): UiImageInstance;
+    prototype: UiImageInstance;
+};
+
+type UiDataConstructor = {
+    new (uiData?: PlainRecord | null): UiDataInstance;
+    prototype: UiDataInstance;
+    UiImage: UiImageConstructor;
+};
+
+type UiOptionsConstructor = {
+    new (uiOptions?: PlainRecord | null): UiOptionsInstance;
+    prototype: UiOptionsInstance;
+    ClickThroughNavigation: {
+        EXTERNAL: 'external';
+        NOT_SUPPORTED: 'notSupported';
+    };
+};
+
+type CustomUiOptionsConstructor = {
+    new (uiOptions?: PlainRecord | null): CustomUiOptionsInstance;
+    prototype: CustomUiOptionsInstance;
+};
+
+type UiConstructor = {
+    new (uiDelegate?: PlainRecord | null): UiInstance;
+    prototype: UiInstance;
+    UiData: UiDataConstructor;
+    UiKey: PlainRecord;
+    UiOptions: UiOptionsConstructor;
+};
+
 type DaiSdkSettingsConstructor = {
     new (): DaiSdkSettingsInstance;
     prototype: DaiSdkSettingsInstance;
@@ -279,6 +357,22 @@ export function GoogleIma3Dai(source: Source) {
         return typeof value === 'string' && value.length > 0 ? value : null;
     };
 
+    /**
+     * Normalizes the stream request UI container.
+     *
+     * @param value - The candidate UI container to normalize.
+     */
+    const normalizeStreamRequestUi = (value: unknown): StreamRequestUiInstance => {
+        if (!isRecord(value)) {
+            return { custom: null };
+        }
+
+        const normalizedUi = Object.assign({ custom: null }, value);
+        normalizedUi.custom = isRecord(normalizedUi.custom) ? normalizedUi.custom : null;
+
+        return normalizedUi as StreamRequestUiInstance;
+    };
+
     /**
      * Initializes the listener registry for an event handler instance.
      *
@@ -331,11 +425,13 @@ export function GoogleIma3Dai(source: Source) {
         instance.networkCode = null;
         instance.omidAccessModeRules = null;
         instance.streamActivityMonitorId = null;
+        instance.ui = { custom: null };
 
         if (isRecord(streamRequest)) {
             Object.assign(instance, streamRequest);
         }
         instance.adTagParameters = toStringRecord(instance.adTagParameters);
+        instance.ui = normalizeStreamRequestUi(instance.ui);
 
         if (typeof instance.format !== 'string' || instance.format.length === 0) {
             instance.format = 'hls';
@@ -598,7 +694,7 @@ export function GoogleIma3Dai(source: Source) {
      * Creates a UI settings container.
      */
     const UiSettings = function (this: UiSettingsInstance) {
-        this.locale = '';
+        this.locale = 'en';
     } as unknown as UiSettingsConstructor;
     /**
      * Returns the configured locale.
@@ -612,8 +708,151 @@ export function GoogleIma3Dai(source: Source) {
      * @param locale - The locale string to store.
      */
     UiSettings.prototype.setLocale = function (this: UiSettingsInstance, locale: string): void {
-        this.locale = locale;
+        if (typeof locale === 'string' && locale.length > 0) {
+            this.locale = locale;
+        }
+    };
+
+    const uiKeys = {
+        ABOUT_THIS_AD_FALLBACK_IMAGE: 'aboutThisAdFallbackImage',
+        ABOUT_THIS_AD_ICON: 'aboutThisAdIcon',
+        AD_TITLE: 'adTitle',
+        ATTRIBUTION: 'attribution',
+        AUTHOR_ICON: 'authorIcon',
+        AUTHOR_TITLE: 'authorTitle',
+        CALL_TO_ACTION: 'callToAction',
+        PRE_SKIP: 'preSkip',
+        SKIP_BUTTON: 'skipButton',
+        VIDEO_OVERLAY: 'videoOverlay',
+    } as const;
+
+    const clickThroughNavigation = {
+        EXTERNAL: 'external',
+        NOT_SUPPORTED: 'notSupported',
+    } as const;
+
+    /**
+     * Creates a UI image description.
+     *
+     * @param uiImage - Optional image fields to copy onto the instance.
+     */
+    const UiImage = function (this: UiImageInstance, uiImage?: PlainRecord | null) {
+        this.altText = '';
+        this.height = 0;
+        this.url = '';
+        this.width = 0;
+
+        if (isRecord(uiImage)) {
+            Object.assign(this, uiImage);
+        }
+
+        this.altText = getStringValue(this.altText) || '';
+        this.height = typeof this.height === 'number' ? this.height : 0;
+        this.url = getStringValue(this.url) || '';
+        this.width = typeof this.width === 'number' ? this.width : 0;
+    } as unknown as UiImageConstructor;
+
+    /**
+     * Creates a UI element configuration record.
+     *
+     * @param uiData - Optional UI data fields to copy onto the instance.
+     */
+    const UiData = function (this: UiDataInstance, uiData?: PlainRecord | null) {
+        this.clickable = false;
+        this.required = false;
+
+        if (isRecord(uiData)) {
+            Object.assign(this, uiData);
+        }
+
+        this.clickable = Boolean(this.clickable);
+        this.required = Boolean(this.required);
+
+        if (Array.isArray(this.imageVariants)) {
+            const imageVariants: UiImageInstance[] = [];
+
+            for (let imageVariantIndex = 0; imageVariantIndex < this.imageVariants.length; imageVariantIndex += 1) {
+                imageVariants.push(new UiImage(this.imageVariants[imageVariantIndex] as unknown as PlainRecord | null));
+            }
+
+            this.imageVariants = imageVariants;
+        }
+    } as unknown as UiDataConstructor;
+    UiData.UiImage = UiImage;
+
+    /**
+     * Creates public DAI UI options.
+     *
+     * @param uiOptions - Optional UI option fields to copy onto the instance.
+     */
+    const UiOptions = function (this: UiOptionsInstance, uiOptions?: PlainRecord | null) {
+        this.aboutThisAdSupport = false;
+        this.clickThroughNavigation = clickThroughNavigation.NOT_SUPPORTED;
+        this.skippableSupport = false;
+
+        if (isRecord(uiOptions)) {
+            Object.assign(this, uiOptions);
+        }
+
+        this.aboutThisAdSupport = Boolean(this.aboutThisAdSupport);
+        this.clickThroughNavigation = this.clickThroughNavigation === clickThroughNavigation.EXTERNAL
+            ? clickThroughNavigation.EXTERNAL
+            : clickThroughNavigation.NOT_SUPPORTED;
+        this.skippableSupport = Boolean(this.skippableSupport);
+    } as unknown as UiOptionsConstructor;
+    UiOptions.ClickThroughNavigation = clickThroughNavigation;
+
+    /**
+     * Creates custom UI options stored on stream requests.
+     *
+     * @param uiOptions - Optional UI option fields to copy onto the instance.
+     */
+    const CustomUiOptions = function (this: CustomUiOptionsInstance, uiOptions?: PlainRecord | null) {
+        this.aboutThisAdSupport = false;
+        this.skippableSupport = false;
+
+        if (isRecord(uiOptions)) {
+            Object.assign(this, uiOptions);
+        }
+
+        this.aboutThisAdSupport = Boolean(this.aboutThisAdSupport);
+        this.skippableSupport = Boolean(this.skippableSupport);
+    } as unknown as CustomUiOptionsConstructor;
+
+    const uiDelegates = new WeakMap<UiInstance, UiDelegateInstance>();
+    /**
+     * Creates the public `google.ima.dai.api.ui` wrapper.
+     *
+     * @param uiDelegate - Optional delegate used to back the wrapper methods.
+     */
+    const Ui = function (this: UiInstance, uiDelegate?: PlainRecord | null) {
+        uiDelegates.set(this, isRecord(uiDelegate) ? uiDelegate as UiDelegateInstance : {});
+    } as unknown as UiConstructor;
+    Ui.prototype.onClick = function (this: UiInstance, uiKey: string, eventData?: unknown): void {
+        const uiDelegate = uiDelegates.get(this);
+        if (uiDelegate && typeof uiDelegate.onClick === 'function') {
+            uiDelegate.onClick(uiKey, eventData);
+        }
+    };
+    Ui.prototype.setVisibleElements = function (this: UiInstance, uiElements: unknown): void {
+        const uiDelegate = uiDelegates.get(this);
+        if (uiDelegate && typeof uiDelegate.setVisibleElements === 'function') {
+            uiDelegate.setVisibleElements(uiElements);
+        }
+    };
+    Ui.prototype.getConfig = function (this: UiInstance): Map<string, UiDataInstance> {
+        const uiDelegate = uiDelegates.get(this);
+        if (!uiDelegate || typeof uiDelegate.getConfig !== 'function') {
+            return new Map();
+        }
+
+        const uiConfig = uiDelegate.getConfig();
+
+        return uiConfig instanceof Map ? uiConfig : new Map();
     };
+    Ui.UiData = UiData;
+    Ui.UiKey = uiKeys;
+    Ui.UiOptions = UiOptions;
 
     const daiSdkFeatureFlagsStorage = new WeakMap<DaiSdkSettingsInstance, PlainRecord>();
     /**
@@ -1429,13 +1668,17 @@ export function GoogleIma3Dai(source: Source) {
     } as unknown as StreamManagerInstance['streamTimeForContentTime'];
 
     const api: PlainRecord = {
+        customUi: {
+            UiOptions: CustomUiOptions,
+        },
         DaiSdkSettings: new DaiSdkSettingsContainer(),
         LiveStreamRequest,
         PodStreamRequest,
         StreamData,
         StreamEvent,
         StreamManager,
         StreamRequest,
+        ui: Ui,
         UiSettings,
         VideoStitcherLiveStreamRequest,
         VideoStitcherVodStreamRequest,

tests/api/redirects-build.spec.ts

@@ -0,0 +1,17 @@
+import { describe, expect, it } from 'vitest';
+
+import { convertTsFileNameToJs } from '../../scripts/helpers';
+
+describe('redirect build', () => {
+    it('converts TypeScript redirect source filename to .js extension', () => {
+        expect(convertTsFileNameToJs('google-ima3-dai.ts')).toBe('google-ima3-dai.js');
+    });
+
+    it('leaves JavaScript redirect filenames unchanged', () => {
+        expect(convertTsFileNameToJs('google-ima3.js')).toBe('google-ima3.js');
+    });
+
+    it('leaves filenames without a recognized extension unchanged', () => {
+        expect(convertTsFileNameToJs('nooptext.txt')).toBe('nooptext.txt');
+    });
+});