actions/conditional.ts

import {Action} from "../internal/Action.js";
import {expression} from "../qualifiers/expression.js";
import {Transformation} from "../transformation/Transformation.js";
import {IConditionalActionModel} from "../internal/models/IConditionalActionModel.js";
import {IActionModel} from "../internal/models/IActionModel.js";

/**
 * Sets up a conditional transformation.
 * @memberOf Actions
 * @namespace Conditional
 * @example
 * import {Cloudinary} from "@cloudinary/url-gen";
 *
 * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
 * const image = yourCldInstance.image('woman');
 * image.conditional(
 *  Conditional.ifCondition('ar >= 1.0', new Transformation().addAction('w_100'))
 * );
 * image.toString()
 * // Transformation will contain `if_ar_gte_1.0/w_100/if_end`
 */


/**
 * @memberOf Actions.Conditional
 * @see Actions.Conditional
 * @example
 * // To be used through a builder and not to be created as an instance!
 * import {Cloudinary} from "@cloudinary/url-gen";
 *
 * const yourCldInstance = new Cloudinary({cloud:{cloudName:'demo'}});
 * const image = yourCldInstance.image('woman');
 * image.conditional(
 *  Conditional.ifCondition('ar >= 1.0', new Transformation().addAction('w_100'))
 * );
 * image.toString()
 * // Transformation will contain `if_ar_gte_1.0/w_100/if_end`
 */
class ConditionalAction extends Action{
  protected _actionModel: IConditionalActionModel = {actionType: "ifCondition"};
  private ifTx: Transformation;
  private elseTx: Transformation;
  private exp: string;

  /**
   * @description Specifies a condition to be met before applying a transformation.
   * @param {string} exp The condition to meet in order to apply the transformation.
   * @param {SDK.Transformation} ifTx The transformation to conditionally apply
   */
  constructor(exp: string, ifTx: Transformation) {
    super();
    this.exp = exp;
    this.ifTx = ifTx;
    this._actionModel.expression = exp;
    this._actionModel.transformation = ifTx;
  }

  /**
   * @description An alternate transformation in case the initial condition is false
   * Alias to `else` in many programming languages
   * @param {SDK.Transformation} elseTx
   */
  otherwise(elseTx: Transformation): this {
    this.elseTx = elseTx;
    this._actionModel.otherwise = elseTx;
    return this;
  }

  toString(): string {
    return [
      `if_${expression(this.exp)}`,
      `${this.ifTx}`,
      this.elseTx && `if_else/${this.elseTx}`,
      `if_end`
    ].filter((a) => a).join('/');
  }

  static fromJson(actionModel: IActionModel): ConditionalAction {
    const {expression, transformation, otherwise} = (actionModel as IConditionalActionModel);

    // We are using this() to allow inheriting classes to use super.fromJson.apply(this, [actionModel])
    // This allows the inheriting classes to determine the class to be created
    const result = new this(expression, transformation);
    otherwise && result.otherwise(otherwise);

    return result;
  }
}




/**
 * @summary action
 * @memberOf Actions.Conditional
 * @description Sets up a conditional transformation with expression.
 * Learn more: {@link https://cloudinary.com/documentation/conditional_transformations|Conditional transformations}
 *
 * @param {string} expression The condition to meet in order to apply the transformation.
 * @param {SDK.Transformation} tx The transformation to conditionally apply
 * @return {Actions.Conditional.ConditionalAction}
 */
function ifCondition(expression: string, tx: Transformation): ConditionalAction {
  return new ConditionalAction(expression, tx);
}

const Conditional = {ifCondition, ConditionalAction};

export {Conditional, ifCondition, ConditionalAction};