react-native-applovin-max 9.0.0 → 9.2.0

package/lib/typescript/src/types/AdProps.d.ts

@@ -1,57 +1,56 @@
 import type { AdDisplayFailedInfo, AdInfo, AdLoadFailedInfo } from './AdInfo';
 /**
- * Local extra parameters can be of type: string, number, boolean, array, map, and null.
+ * Represents the allowed value types for local extra parameters passed to the ad adapter.
+ * Can be a primitive, object, or null.
  */
 export type LocalExtraParameterValue = string | number | boolean | object | null;
 /**
- * Defines the base properties for the UI component ads i.e {@link AdView} and {@link NativeAdView}.
+ * Defines the base props shared by ad UI components like {@link AdView} and {@link NativeAdView}.
  */
 export type AdProps = {
     /**
-     * A string value representing the ad unit ID to load ads for.
+     * The ad unit ID used to load ads.
      */
     adUnitId: string;
     /**
-     * A string value representing the placement name that you assign when you integrate each ad
-     * format, for granular reporting in ad events.
+     * The placement name defined in your integration, used for granular reporting.
      */
     placement?: string | null;
     /**
-     * The custom data to tie the showing ad to.
+     * Optional custom data to attach to the ad, used for analytics or targeting.
      */
     customData?: string | null;
     /**
-     * A dictionary value representing the extra parameters to set a list of key-value string pairs
-     * for the ad.
+     * Extra parameters to be sent as key-value string pairs.
      */
     extraParameters?: {
         [key: string]: string;
     };
     /**
-     * A dictionary value representing the local extra parameters to set a list of key-value pairs
-     * to pass to the adapter instances.
+     * Local extra parameters sent to the adapter instance.
+     * Supports string and boolean values only.
      */
     localExtraParameters?: {
         [key: string]: string | boolean;
     };
     /**
-     * A callback fuction that {@link AdView} or {@link NativeAdView} fires when it loads a new ad.
+     * Called when a new ad is successfully loaded.
      */
     onAdLoaded?: (adInfo: AdInfo) => void;
     /**
-     * A callback fuction that {@link AdView} or {@link NativeAdView} fires when it could not load a new ad.
+     * Called when the SDK fails to load a new ad.
      */
     onAdLoadFailed?: (error: AdLoadFailedInfo) => void;
     /**
-     * A callback fuction that {@link AdView} or {@link NativeAdView} fires when it fails to display the ad.
+     * Called when the ad fails to display after being loaded.
      */
     onAdDisplayFailed?: (error: AdDisplayFailedInfo) => void;
     /**
-     * A callback fuction that {@link AdView} or {@link NativeAdView} fires when the user clicks the ad.
+     * Called when the ad is clicked by the user.
      */
     onAdClicked?: (adInfo: AdInfo) => void;
     /**
-     * A callback fuction that {@link AdView} or {@link NativeAdView} fires when it pays ad revenue to the publisher.
+     * Called when ad revenue is paid to the publisher.
      */
     onAdRevenuePaid?: (adInfo: AdInfo) => void;
 };

package/lib/typescript/src/types/AdProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AdProps.d.ts","sourceRoot":"","sources":["../../../../src/types/AdProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE5C;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3D;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAEnD;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEzD;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAEvC;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9C,CAAC"}
+{"version":3,"file":"AdProps.d.ts","sourceRoot":"","sources":["../../../../src/types/AdProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE9E;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAE5C;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAE3D;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAEtC;;OAEG;IACH,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,IAAI,CAAC;IAEnD;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAEzD;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAEvC;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC9C,CAAC"}

package/lib/typescript/src/types/AdViewProps.d.ts

@@ -2,85 +2,88 @@ import type { AdProps, LocalExtraParameterValue } from './AdProps';
 import type { AdInfo } from './AdInfo';
 import type { AdFormat } from '../AdView';
 /**
- * A handler of {@link AdView}.
+ * A reference to the {@link AdView} instance, allowing imperative control.
  */
 export type AdViewHandler = {
     /**
-     * If the {@link loadOnMount} attribute is set to false, you can call this API to start loading ads in this AdView.
+     * Triggers a manual ad load starting.
+     * This is only needed if {@link loadOnMount} is set to `false`.
      */
     loadAd(): void;
 };
 /**
- * A unique identifier for referencing a specific AdView instance.
+ * A unique identifier for referencing a specific {@link AdView} instance.
  *
- * - If the value is a number, it represents the ID of a preloaded or assigned AdView.
- * - A value of `undefined` indicates that the AdView has not been preloaded or assigned an ID yet.
+ * - A number represents the ID of a preloaded or managed AdView.
+ * - `undefined` means the AdView is not preloaded or assigned an ID.
  */
 export type AdViewId = number | undefined;
 /**
- * Represents an {@link AdView} - Banner / MREC.
+ * Props used to configure and render an {@link AdView} (i.e. Banner or MREC).
  */
 export type AdViewProps = AdProps & {
     /**
-     * An enum value representing the ad format to load ads for. Must be either
-     * {@link AdFormat.BANNER} or {@link AdFormat.MREC}.
+     * The ad format to load for this view.
+     * Must be {@link AdFormat.BANNER} or {@link AdFormat.MREC}.
      */
     adFormat: AdFormat;
     /**
-     * A unique identifier representing the AdView instance.
-     * Used to manage and track the specific AdView.
+     * A unique identifier for the AdView instance.
+     * Used for tracking and preloading specific ad views.
      */
     adViewId?: AdViewId;
     /**
-     * A boolean indicating whether adaptive banners are enabled.
+     * Enables adaptive banner sizing if `true`.
+     * Ignored for MREC ads.
      */
     adaptiveBannerEnabled?: boolean;
     /**
-     * A boolean indicating whether auto-refresh is enabled.
-     * Auto-refresh is enabled by default.
+     * Enables or disables automatic ad refresh.
+     * Defaults to `true`.
      */
     autoRefresh?: boolean;
     /**
-     * A boolean indicating whether an ad should load automatically
-     * when the {@link AdView} is mounted. Defaults to `true`.
+     * If `true`, the ad will be loaded automatically when the component mounts.
+     * Set to `false` for ads to be loaded manually using the ref after the component mounts.
+     *
+     * @default true
      */
     loadOnMount?: boolean;
     /**
-     * A callback function triggered when the {@link AdView} expands the ad.
-     *
-     * @param adInfo - Information about the ad that was expanded.
+     * Called when the ad is expanded.
      */
     onAdExpanded?: (adInfo: AdInfo) => void;
     /**
-     * A callback function triggered when the {@link AdView} collapses the ad.
-     *
-     * @param adInfo - Information about the ad that was collapsed.
+     * Called when the ad collapses back to its original state.
      */
     onAdCollapsed?: (adInfo: AdInfo) => void;
 };
 /**
- * A list of options to create a native UI component for preloading {@link AdView}.
+ * Options used when preloading a native UI {@link AdView} component.
  */
 export type NativeUIComponentAdViewOptions = {
     /**
-     * A string value representing the placement name that you assign when you integrate each ad
-     * format, for granular reporting in ad events.
+     * Whether adaptive banner sizing is enabled. Defaults to `true`.
+     */
+    isAdaptive?: boolean;
+    /**
+     * The placement name used for analytics and reporting.
      */
     placement?: string | null;
     /**
-     * The custom data to tie the showing ad to.
+     * Custom data to associate with the ad for postbacks or targeting.
      */
     customData?: string | null;
     /**
-     * A dictionary value representing the extra parameters to set a list of key-value string pairs
-     * for the ad.
+     * A dictionary of key-value pairs used to pass extra parameters
+     * to the SDK (string-only values).
      */
     extraParameters?: {
         [key: string]: string | null;
     };
     /**
-     * A dictionary value representing the local extra parameters to set a list of key-value pairs
-     * to pass to the adapter instances.
+     * A dictionary of key-value pairs used to pass local extra parameters
+     * to the mediation adapter (string, boolean, number, etc.).
      */
     localExtraParameters?: {
         [key: string]: LocalExtraParameterValue;

package/lib/typescript/src/types/AdViewProps.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AdViewProps.d.ts","sourceRoot":"","sources":["../../../../src/types/AdViewProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB;;OAEG;IACH,MAAM,IAAI,IAAI,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG;IAChC;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;OAIG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAExC;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAEnD;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,CAAC;CACtE,CAAC"}
+{"version":3,"file":"AdViewProps.d.ts","sourceRoot":"","sources":["../../../../src/types/AdViewProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAC;AACnE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB;;;OAGG;IACH,MAAM,IAAI,IAAI,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;AAE1C;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG;IAChC;;;OAGG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAExC;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,8BAA8B,GAAG;IACzC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAEnD;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,CAAC;CACtE,CAAC"}

package/lib/typescript/src/types/AppLovinMAX.d.ts

@@ -2,135 +2,132 @@ import type { Configuration } from './Configuration';
 import type { CMPError } from './CMPError';
 import type { ConsentFlowUserGeography } from '../AppLovinMAX';
 /**
- * Represents the AppLovinMAX module.
+ * Defines the AppLovin MAX module interface exposed to JavaScript.
  */
 export type AppLovinMAXType = {
     /**
-     * Indicates whether or not the AppLovinMAX SDK has fully initialized without errors and
-     * {@link AppLovinMAX.initialize()} has called the completion callback.
+     * Checks whether the AppLovin MAX SDK has finished initializing.
+     *
+     * @returns A promise that resolves to `true` if the SDK is initialized, or `false` otherwise.
      */
     isInitialized(): Promise<boolean>;
     /**
-     * Initializes the AppLovinMAX SDK, and returns {@link Configuration} when it finishes initializing.
+     * Initializes the AppLovin MAX SDK.
      *
-     * @param sdkKey SDK key to use for the instance of the AppLovinMAX SDK.
+     * @param sdkKey - Your AppLovin SDK key.
+     * @returns A promise that resolves with the initialization configuration.
      */
     initialize(sdkKey: string): Promise<Configuration>;
     /**
-     * Sets a list of the ad units for the SDK to initialize only those networks.
+     * Restricts initialization to the specified ad unit IDs only.
      *
-     * @param adUnitIds Ad units to be initialized with the SDK.
+     * @param adUnitIds - An array of ad unit IDs to initialize.
      */
     setInitializationAdUnitIds(adUnitIds: string[]): void;
     /**
-     * Presents the mediation debugger UI.
+     * Displays the AppLovin Mediation Debugger UI.
      */
     showMediationDebugger(): void;
     /**
-     * Whether this device is a tablet.
+     * Checks whether the current device is a tablet.
+     *
+     * @returns A promise that resolves to `true` if the device is a tablet.
      */
     isTablet(): Promise<boolean>;
     /**
-     * Sets an ID for the current user. AppLovin ties this identifier to SDK events and AppLovin’s
-     * optional S2S postbacks.
+     * Sets a user ID for use in SDK events and S2S postbacks.
      *
-     * @param userId User id.
+     * @param userId - The custom user ID to associate with this device.
      */
     setUserId(userId: string): void;
     /**
-     * Sets a muted state (or not) as the initial state for video ads.
+     * Sets whether video ads should start in a muted state.
      *
-     * @param muted If ads should begin in a muted state.
+     * @param muted - `true` to mute ads by default.
      */
     setMuted(muted: boolean): void;
     /**
-     * Whether to begin video ads in a muted state or not.
+     * Gets whether video ads will start muted.
+     *
+     * @returns A promise that resolves to `true` if ads will begin muted.
      */
     isMuted(): Promise<boolean>;
     /**
-     * A toggle for verbose logging for the AppLovinMAX SDK.
+     * Enables or disables verbose logging in the AppLovin MAX SDK.
      *
-     * @param verboseLoggingEnabled true if the AppLovinMAX SDK should output log messages.
+     * @param verboseLoggingEnabled - `true` to enable verbose logs.
      */
     setVerboseLogging(verboseLoggingEnabled: boolean): void;
     /**
-     * Enables devices to receive test ads by passing in the advertising identifier (IDFA or IDFV) of
-     * each test device. Refer to AppLovin logs for the IDFA or IDFV of your current device.
+     * Registers test devices using their advertising IDs (IDFA/IDFV).
      *
-     * @param advertisingIds A list of the advertising ids.
+     * @param advertisingIds - An array of advertising IDs to register.
      */
     setTestDeviceAdvertisingIds(advertisingIds: string[]): void;
     /**
-     * Whether the Creative Debugger displays after you flip the device screen down twice.
+     * Enables or disables the Creative Debugger gesture (flip screen down twice).
      *
-     * @param enabled Default to true.
+     * @param enabled - `true` to enable the Creative Debugger (default: true).
      */
     setCreativeDebuggerEnabled(enabled: boolean): void;
     /**
-     * Sets an extra parameter to pass to the AppLovin server.
+     * Sets an extra parameter to send with SDK requests.
      *
-     * @param key Parameter key.
-     * @param value Parameter value.
+     * @param key - The name of the parameter.
+     * @param value - The value of the parameter, or `null` to clear it.
      */
     setExtraParameter(key: string, value: string | null): void;
     /**
-     * Enables the MAX Terms and Privacy Policy Flow.
+     * Enables the AppLovin MAX Terms and Privacy Policy flow.
      *
-     * @param enabled true to enable the MAX Terms and Privacy Policy Flow.
+     * @param enabled - `true` to enable the flow.
      */
     setTermsAndPrivacyPolicyFlowEnabled(enabled: boolean): void;
     /**
-     * The URL of your company’s privacy policy, as a string. This is required in order to enable
-     * the Terms Flow.
+     * Sets the URL for your company’s privacy policy (required to enable the terms flow).
      *
-     * @param urlString The URL string to point your company’s privacy policy.
+     * @param urlString - A valid URL string to your privacy policy.
      */
     setPrivacyPolicyUrl(urlString: string): void;
     /**
-     * The URL of your company’s terms of service, as a string. This is optional; you can enable
-     * the Terms Flow with or without it.
+     * Sets the URL for your company’s terms of service (optional).
      *
-     * @param urlString The URL string to point your company’s terms of service.
+     * @param urlString - A valid URL string to your terms of service.
      */
     setTermsOfServiceUrl(urlString: string): void;
     /**
-     * Set debug user geography. You may use this to test CMP flow by setting this to {@link ConsentFlowUserGeography.GDPR}.
+     * Sets a mock geography for testing the CMP flow (e.g., GDPR).
      *
-     * @note The debug geography is used only when the app is in debug mode.
+     * @note This only applies when running the app in debug mode.
+     *
+     * @param userGeography - The mock user geography to simulate.
      */
     setConsentFlowDebugUserGeography(userGeography: ConsentFlowUserGeography): void;
     /**
-     * Shows the CMP flow to an existing user.
-     * Note that this resets the user’s existing consent information.
-     *
-     * The function returns when the flow finishes showing. On success, returns null. On failure,
-     * returns one of the {@link CMPError} codes.
+     * Displays the CMP flow for an existing user and resets their consent status.
      *
-     * @return {Promise<CMPError|null>}
+     * @returns A promise that resolves to `null` on success, or a {@link CMPError} on failure.
      */
     showCmpForExistingUser(): Promise<CMPError | null>;
     /**
-     * Returns true if a supported CMP SDK is detected.
+     * Checks if a supported CMP SDK is available.
      *
-     * @return {boolean}
+     * @returns A promise that resolves to `true` if a CMP is detected.
      */
     hasSupportedCmp(): Promise<boolean>;
     /**
-     * Adds a segment. Both the key and the values must be integers.
+     * Adds a new user segment.
      *
-     * @param key An integer key.
-     * @param values An array of integers.
-     * @returns A promise that resolves upon the successful addition. The resolved object contains
-     * void.
-     * @throws Throws an error if the segments can not be added.
+     * @param key - An integer key identifying the segment.
+     * @param values - An array of integer values for the segment.
+     * @returns A promise that resolves on success, or rejects if the operation fails.
      */
     addSegment(key: number, values: number[]): Promise<void>;
     /**
-     * Returns a list of segments.
+     * Retrieves the list of user segments.
      *
-     * @returns A promise that resolves upon a successful inquiry. The resolved object contains a
-     * Map object that holds a list of segments, each represented by a key and an array of integers.
-     * @throws Throws an error if the segments can not be gotten.
+     * @returns A promise that resolves to a map of segment keys to arrays of values,
+     * or `null` if no segments are available.
      */
     getSegments(): Promise<Map<number, number[]> | null>;
 };

package/lib/typescript/src/types/AppLovinMAX.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AppLovinMAX.d.ts","sourceRoot":"","sources":["../../../../src/types/AppLovinMAX.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B;;;OAGG;IACH,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAElC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEnD;;;;OAIG;IACH,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;OAEG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;;;OAIG;IACH,iBAAiB,CAAC,qBAAqB,EAAE,OAAO,GAAG,IAAI,CAAC;IAExD;;;;;OAKG;IACH,2BAA2B,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnD;;;;;OAKG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAE3D;;;;OAIG;IACH,mCAAmC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;;;;OAKG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7C;;;;;OAKG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,gCAAgC,CAAC,aAAa,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEhF;;;;;;;;OAQG;IACH,sBAAsB,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpC;;;;;;;;OAQG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;;OAMG;IACH,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;CACxD,CAAC"}
+{"version":3,"file":"AppLovinMAX.d.ts","sourceRoot":"","sources":["../../../../src/types/AppLovinMAX.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC1B;;;;OAIG;IACH,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAElC;;;;;OAKG;IACH,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IAEnD;;;;OAIG;IACH,0BAA0B,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEtD;;OAEG;IACH,qBAAqB,IAAI,IAAI,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B;;;;OAIG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE5B;;;;OAIG;IACH,iBAAiB,CAAC,qBAAqB,EAAE,OAAO,GAAG,IAAI,CAAC;IAExD;;;;OAIG;IACH,2BAA2B,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,0BAA0B,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAEnD;;;;;OAKG;IACH,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IAE3D;;;;OAIG;IACH,mCAAmC,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IAE5D;;;;OAIG;IACH,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7C;;;;OAIG;IACH,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9C;;;;;;OAMG;IACH,gCAAgC,CAAC,aAAa,EAAE,wBAAwB,GAAG,IAAI,CAAC;IAEhF;;;;OAIG;IACH,sBAAsB,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAEnD;;;;OAIG;IACH,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEpC;;;;;;OAMG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD;;;;;OAKG;IACH,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;CACxD,CAAC"}

package/lib/typescript/src/types/BannerAd.d.ts

@@ -1,41 +1,47 @@
 import type { ViewAdType } from './ViewAd';
 import type { AdViewPosition } from '../AdView';
+/**
+ * Defines the interface for managing banner ads.
+ * Extends {@link ViewAdType} with banner-specific layout and customization methods.
+ */
 export type BannerAdType = ViewAdType & {
     /**
-     * Creates a banner at the specified position and offsets.
+     * Creates a banner ad at the specified position and optional pixel offsets.
      *
-     * @param adUnitId The Ad Unit ID to load ads for.
-     * @param position {@ AdViewPosition} position.
-     * @param xOffset Horizontal offset from the left position.
-     * @param yOffset Vertical offset from the top position.
+     * @param adUnitId - The ad unit ID to load ads for.
+     * @param position - The position of the banner on screen.
+     * @param xOffset - Optional horizontal offset from the left (default: 0).
+     * @param yOffset - Optional vertical offset from the top (default: 0).
+     * @param isAdaptive - Optional flag to enable adaptive banners (default: true).
      */
-    createAd(adUnitId: string, position: AdViewPosition, xOffset?: number, yOffset?: number): void;
+    createAd(adUnitId: string, position: AdViewPosition, xOffset?: number, yOffset?: number, isAdaptive?: boolean): void;
     /**
-     * Sets a background color for the banner.
+     * Sets the background color of the banner.
      *
-     * @param adUnitId The Ad Unit ID to load ads for.
-     * @param hexColorCode Hexadecimal color (#rrggbb).
+     * @param adUnitId - The ad unit ID of the banner.
+     * @param hexColorCode - A hex color string (e.g. "#FFFFFF").
      */
     setBackgroundColor(adUnitId: string, hexColorCode: string): void;
     /**
-     * Sets the banner width.
+     * Sets the width of the banner.
      *
-     * @param adUnitId The Ad Unit ID to load ads for.
-     * @param width The desired banner width.
+     * @param adUnitId - The ad unit ID of the banner.
+     * @param width - Desired width in pixels.
      */
     setWidth(adUnitId: string, width: number): void;
     /**
-     * Updates the banner position offsets.
+     * Updates the position offsets of the banner after creation.
      *
-     * @param adUnitId The Ad Unit ID to load ads for.
-     * @param xOffset Horizontal offset from the left position.
-     * @param yOffset Vertical offset from the top position.
+     * @param adUnitId - The ad unit ID of the banner.
+     * @param xOffset - Horizontal offset from the left.
+     * @param yOffset - Vertical offset from the top.
      */
     updateOffsets(adUnitId: string, xOffset: number, yOffset: number): void;
     /**
-     * Gets the adaptive banner size for the provided width at the current orientation.
+     * Calculates the adaptive banner height for the given width and current screen orientation.
      *
-     * @param width The banner width.
+     * @param width - The banner width in pixels.
+     * @returns A promise that resolves with the appropriate height.
      */
     getAdaptiveHeightForWidth(width: number): Promise<number>;
 };

package/lib/typescript/src/types/BannerAd.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BannerAd.d.ts","sourceRoot":"","sources":["../../../../src/types/BannerAd.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/F;;;;;OAKG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjE;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhD;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAExE;;;;OAIG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7D,CAAC"}
+{"version":3,"file":"BannerAd.d.ts","sourceRoot":"","sources":["../../../../src/types/BannerAd.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEhD;;;GAGG;AACH,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG;IACpC;;;;;;;;OAQG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAErH;;;;;OAKG;IACH,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjE;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhD;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAExE;;;;;OAKG;IACH,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7D,CAAC"}

package/lib/typescript/src/types/CMPError.d.ts

@@ -1,19 +1,22 @@
 import type { CMPErrorCode } from '../AppLovinMAX';
+/**
+ * Represents an error returned from the Consent Management Platform (CMP) flow.
+ */
 export type CMPError = {
     /**
-     * The error code for this error.
+     * The AppLovin-defined CMP error code.
      */
     code: CMPErrorCode;
     /**
-     * The error message for this error.
+     * A descriptive error message from the AppLovin SDK.
      */
     message: string;
     /**
-     * The error code returned by the CMP.
+     * The raw error code returned by the CMP.
      */
     cmpCode: number;
     /**
-     * The error message returned by the CMP.
+     * The raw error message returned by the CMP.
      */
     cmpMessage: string;
 };

package/lib/typescript/src/types/CMPError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CMPError.d.ts","sourceRoot":"","sources":["../../../../src/types/CMPError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,QAAQ,GAAG;IACnB;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC"}
+{"version":3,"file":"CMPError.d.ts","sourceRoot":"","sources":["../../../../src/types/CMPError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACnB;;OAEG;IACH,IAAI,EAAE,YAAY,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC"}

package/lib/typescript/src/types/Configuration.d.ts

@@ -1,32 +1,30 @@
 import type { ConsentFlowUserGeography, AppTrackingStatus } from '../AppLovinMAX';
 /**
- * Encapsulates data for the AppLovinMAX SDK configuration.
+ * Represents the AppLovin MAX SDK configuration returned after initialization.
  */
 export type Configuration = {
     /**
-     * The country code of this user.
+     * The user's country code.
      */
     countryCode: string;
     /**
-     * The user's geography used to determine the type of consent flow shown to the user.  If no
-     * such determination could be made, {@link ConsentFlowUserGeography.UNKNOWN} will be returned.
+     * The user's geographic region used to determine which consent flow to display.
+     * Returns {@link ConsentFlowUserGeography.UNKNOWN} if the geography cannot be determined.
      */
     consentFlowUserGeography: ConsentFlowUserGeography;
     /**
-     * Indicates whether or not the user authorizes access to app-related data that can be used for
-     * tracking the user or the device.
-     *
-     * Note: available only on iOS
+     * The user's app tracking transparency status on iOS.
+     * Only available on iOS 14+; undefined on Android.
      */
     appTrackingStatus?: AppTrackingStatus;
     /**
-     * Whether or not test mode is enabled for this session.
+     * Indicates whether test mode is enabled for this session.
      *
-     * @return {boolean} true in one of the following cases:
-     * 1. {@link AppLovinMAX.setTestDeviceAdvertisingIds()} was called with current device's GAID prior to SDK initialization.
-     * 2. Current device was registered as a test device through MAX dashboard -> MAX Test Devices prior to SDK initialization.
-     * 3. Test mode was manually enabled for this session through the Mediation Debugger during the last session.
-     * 4. Current device is an emulator.
+     * Returns `true` if any of the following conditions are met:
+     * - {@link AppLovinMAX.setTestDeviceAdvertisingIds()} was called with the current device's GAID before SDK initialization.
+     * - The current device was registered via the MAX dashboard under "Test Devices".
+     * - Test mode was manually enabled in the Mediation Debugger in a previous session.
+     * - The app is running on an emulator.
      */
     isTestModeEnabled: boolean;
 };

package/lib/typescript/src/types/Configuration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Configuration.d.ts","sourceRoot":"","sources":["../../../../src/types/Configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,wBAAwB,EAAE,wBAAwB,CAAC;IAEnD;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAEtC;;;;;;;;OAQG;IACH,iBAAiB,EAAE,OAAO,CAAC;CAC9B,CAAC"}
+{"version":3,"file":"Configuration.d.ts","sourceRoot":"","sources":["../../../../src/types/Configuration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAElF;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,wBAAwB,EAAE,wBAAwB,CAAC;IAEnD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IAEtC;;;;;;;;OAQG;IACH,iBAAiB,EAAE,OAAO,CAAC;CAC9B,CAAC"}