actions/effect/BackgroundRemoval.ts

import { Action } from "../../internal/Action.js";
import { QualifierValue } from "../../internal/qualifier/QualifierValue.js";
import { Qualifier } from "../../internal/qualifier/Qualifier.js";
import { ForegroundObjectValue } from "../../qualifiers/foregroundObject.js";
import { IActionModel } from "../../internal/models/IActionModel.js";
import { IBackgroundRemovalModel } from "../../internal/models/IEffectActionModel.js";

/**
 * @description A class that defines how to remove the background of an asset
 * @extends SDK.Action
 * @memberOf Actions.Effect
 * @see Visit {@link Actions.Effect|Effect} for an example
 */
class BackgroundRemoval extends Action {
  private _fineEdges: boolean;
  private _hints: Array<ForegroundObjectValue>;

  constructor() {
    super();
    this._actionModel.actionType = "backgroundRemoval";
  }

  fineEdges(value = true) {
    this._fineEdges = value;
    this._actionModel.fineEdges = this._fineEdges;
    return this;
  }

  hints(...values: ForegroundObjectValue[] | [ForegroundObjectValue[]]) {
    if (values.length === 1 && Array.isArray(values[0])) {
      // Handle the case of a single array argument
      this._hints = values[0];
    } else if (values.length) {
      this._hints = values as ForegroundObjectValue[];
    }

    if (this._hints) {
      this._actionModel.hints = this._hints;
    }
    return this;
  }

  protected prepareQualifiers(): void {
    let str = "background_removal";

    const params: string[] = [];

    if (this._fineEdges !== undefined) {
      params.push(
        new QualifierValue(
          `fineedges_${this._fineEdges ? "y" : "n"}`
        ).toString()
      );
    }

    if (this._hints?.length) {
      params.push(
        new QualifierValue(`hints_(${this._hints.join(";")})`).toString()
      );
    }

    if (params.length > 0) {
      str += `:${params.join(";")}`;
    }

    this.addQualifier(new Qualifier("e", str));
  }

  static fromJson(actionModel: IActionModel): BackgroundRemoval {
    const { fineEdges, hints } = actionModel as IBackgroundRemovalModel;
    const result = new this();

    if (fineEdges !== undefined) {
      result.fineEdges(fineEdges);
    }
    if (hints?.length) {
      result.hints(hints);
    }

    return result;
  }
}

export { BackgroundRemoval };