Orientation properties

src/mraid.ts

@@ -22,6 +22,12 @@ import {
 } from "./sdkfeature";
 import { initialPosition, Position } from "./position";
 import { ResizeProperties, ResizePropertiesValidator } from "./resize";
+import {
+  defaultOrientationProperties,
+  Orientation,
+  OrientationProperties,
+  validateOrientationProperties,
+} from "./orientationproperties";
 
 export class MRAIDImplementation implements MRAIDApi, SDKApi {
   private eventsCoordinator: EventsCoordinator;
@@ -57,6 +63,8 @@ export class MRAIDImplementation implements MRAIDApi, SDKApi {
 
   private currentResizeProperties?: ResizeProperties = undefined;
 
+  private currentOrientationProperties = defaultOrientationProperties.clone();
+
   constructor(
     eventsCoordinator: EventsCoordinator,
     sdkInteractor: SdkInteractor,
@@ -362,6 +370,31 @@ export class MRAIDImplementation implements MRAIDApi, SDKApi {
     }
   }
 
+  getOrientationProperties(): OrientationProperties {
+    return this.currentOrientationProperties.clone();
+  }
+
+  setOrientationProperties(
+    orientationProperties: OrientationProperties | Anything
+  ): void {
+    const errorMessage = validateOrientationProperties(orientationProperties);
+    if (errorMessage) {
+      this.logger.log(LogLevel.Error, "setOrientationProperties", errorMessage);
+    } else {
+      this.currentOrientationProperties.forceOrientation =
+        orientationProperties.forceOrientation ??
+        defaultOrientationProperties.forceOrientation;
+      this.currentOrientationProperties.allowOrientationChange =
+        orientationProperties.allowOrientationChange ??
+        defaultOrientationProperties.allowOrientationChange;
+
+      this.sdkInteractor.setOrientationProperties(
+        this.currentOrientationProperties.allowOrientationChange,
+        this.currentOrientationProperties.forceOrientation
+      );
+    }
+  }
+
   // #endregion
 
   // #region SDKApi

src/mraidapi.ts

@@ -6,6 +6,7 @@ import { Size } from "./size";
 import { SdkFeature } from "./sdkfeature";
 import { Position } from "./position";
 import { ResizeProperties } from "./resize";
+import { OrientationProperties } from "./orientationproperties";
 
 export interface MRAIDApi {
   /**
@@ -201,4 +202,19 @@ export interface MRAIDApi {
    * @param resizeProperties
    */
   setResizeProperties(resizeProperties: ResizeProperties | Anything): void;
+
+  /**
+   * @returns current OrientationProperties object
+   * If {@link setOrientationProperties} is never called then this method
+   * returns default values for properties
+   */
+  getOrientationProperties(): OrientationProperties;
+
+  /**
+   * Sets OrientationProperties object
+   * @param orientationProperties
+   */
+  setOrientationProperties(
+    orientationProperties: OrientationProperties | Anything
+  ): void;
 }

src/mraidbridge/androidmraidbridge.ts

@@ -1,6 +1,7 @@
 import { MraidBridge } from "./mraidbridge";
 import { LogLevel } from "../log/loglevel";
 import { ClosePosition } from "../resize";
+import { Orientation } from "../orientationproperties";
 
 /**
  * Interaction object is defined in global scope (window) so we are using
@@ -37,6 +38,10 @@ export declare interface CriteoInterface {
     customClosePosition: string,
     allowOffscreen: boolean
   ): void;
+  setOrientationProperties(
+    allowOrientationChange: boolean,
+    forceOrientation: string
+  ): void;
 }
 
 export class AndroidMraidBridge implements MraidBridge {
@@ -78,6 +83,16 @@ export class AndroidMraidBridge implements MraidBridge {
     );
   }
 
+  setOrientationProperties(
+    allowOrientationChange: boolean,
+    forceOrientation: Orientation
+  ): void {
+    this.getMraidBridge()?.setOrientationProperties(
+      allowOrientationChange,
+      forceOrientation
+    );
+  }
+
   private getMraidBridge(): CriteoInterface | undefined | null {
     // criteoMraidBridge object is not injected into iframe on Android
     // but doc says it should be. It is always available on topmost window

src/mraidbridge/iosmraidbridge.ts

@@ -1,6 +1,7 @@
 import { MraidBridge } from "./mraidbridge";
 import { LogLevel } from "../log/loglevel";
 import { ClosePosition } from "../resize";
+import { Orientation } from "../orientationproperties";
 
 // #region MessageHandler
 
@@ -60,6 +61,11 @@ export declare interface ResizeIosMessage extends IosMessage {
   allowOffscreen: boolean;
 }
 
+export declare interface SetOrientationPropertiesMessage extends IosMessage {
+  allowOrientationChange: boolean;
+  forceOrientation: string;
+}
+
 // #endregion
 
 export class IosMraidBridge implements MraidBridge {
@@ -125,6 +131,18 @@ export class IosMraidBridge implements MraidBridge {
     this.postMessage(resizeMessage);
   }
 
+  setOrientationProperties(
+    allowOrientationChange: boolean,
+    forceOrientation: Orientation
+  ): void {
+    const orientationPropertiesMessage: SetOrientationPropertiesMessage = {
+      action: "set_orientation_properties",
+      allowOrientationChange,
+      forceOrientation,
+    };
+    this.postMessage(orientationPropertiesMessage);
+  }
+
   private postMessage(message: IosMessage) {
     window?.webkit?.messageHandlers?.criteoMraidBridge?.postMessage(message);
   }

src/mraidbridge/mraidbridge.ts

@@ -1,5 +1,6 @@
 import { LogLevel } from "../log/loglevel";
 import { ClosePosition } from "../resize";
+import { Orientation } from "../orientationproperties";
 
 /**
  * Defines API for interaction with native platforms (iOS and Android)
@@ -19,4 +20,8 @@ export interface MraidBridge {
     customClosePosition: ClosePosition,
     allowOffscreen: boolean
   ): void;
+  setOrientationProperties(
+    allowOrientationChange: boolean,
+    forceOrientation: Orientation
+  ): void;
 }

src/mraidbridge/sdkinteractor.ts

@@ -2,6 +2,7 @@ import { MraidBridge } from "./mraidbridge";
 import { LogLevel } from "../log/loglevel";
 import { Anything } from "../utils";
 import { ClosePosition } from "../resize";
+import { Orientation } from "../orientationproperties";
 
 /**
  * Composite which delegates calls to native platforms handlers
@@ -63,6 +64,15 @@ export class SdkInteractor {
     });
   }
 
+  setOrientationProperties(
+    allowOrientationChange: boolean,
+    forceOrientation: Orientation
+  ) {
+    this.callForAll((bridge) => {
+      bridge.setOrientationProperties(allowOrientationChange, forceOrientation);
+    });
+  }
+
   private callForAll(lambda: (mraidBridge: MraidBridge) => void) {
     this.bridges.forEach((bridge) => {
       lambda(bridge);

src/orientationproperties.ts

@@ -0,0 +1,71 @@
+import { Anything } from "./utils";
+import { ExpandProperties } from "./expand";
+
+export enum Orientation {
+  Portrait = "portrait",
+  Landscape = "landscape",
+  None = "none",
+}
+
+export class OrientationProperties {
+  allowOrientationChange: boolean | Anything;
+
+  forceOrientation: Orientation | Anything;
+
+  constructor(allowOrientationChange: boolean, forceOrientation: Orientation) {
+    this.allowOrientationChange = allowOrientationChange;
+    this.forceOrientation = forceOrientation;
+  }
+
+  clone(): OrientationProperties {
+    return new OrientationProperties(
+      this.allowOrientationChange,
+      this.forceOrientation
+    );
+  }
+}
+
+export const defaultOrientationProperties = new OrientationProperties(
+  true,
+  Orientation.None
+);
+
+export function joinedOrientations(): string {
+  return `[${Object.values(Orientation).join(", ")}]`;
+}
+
+export function validateOrientationProperties(
+  orientationProperties: OrientationProperties | Anything
+): string | null {
+  if (!orientationProperties) {
+    return "Orientation properties object is not passed";
+  }
+  if (Object.keys(orientationProperties).length === 0) {
+    return "Orientation properties object is empty";
+  }
+  let hasAnyProperty = false;
+  Object.keys(defaultOrientationProperties).forEach((property) => {
+    if (Object.prototype.hasOwnProperty.call(orientationProperties, property)) {
+      hasAnyProperty = true;
+    }
+  });
+  if (!hasAnyProperty) {
+    return "The orientation properties object does not contain the 'allowOrientationChange' or 'forceOrientation' properties";
+  }
+
+  const { allowOrientationChange, forceOrientation } = orientationProperties;
+
+  if (allowOrientationChange) {
+    if (typeof allowOrientationChange !== "boolean") {
+      return "'allowOrientationChange' should be boolean";
+    }
+  }
+
+  if (forceOrientation) {
+    if (Object.values(Orientation).includes(forceOrientation)) {
+      return null;
+    }
+    return `'forceOrientation' should be one of ${joinedOrientations()}`;
+  }
+  return null;
+}