@eclipse-scout/core/src/ajax/AjaxError.ts

Eclipse Scout runtime

/*
 * Copyright (c) 2010, 2025 BSI Business Systems Integration AG
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 */
import $ from 'jquery';
import {AjaxSettings, ErrorDo, InitModelOf, objects} from '../index';

export interface AjaxErrorModel {
  jqXHR: JQuery.jqXHR;
  textStatus: JQuery.Ajax.ErrorTextStatus;
  errorThrown: string;
  requestOptions: AjaxSettings;
}

export class AjaxError implements AjaxErrorModel {
  declare model: AjaxErrorModel;

  jqXHR: JQuery.jqXHR;
  textStatus: JQuery.Ajax.ErrorTextStatus;
  errorDo: ErrorDo;
  errorThrown: string;
  requestOptions: AjaxSettings;

  constructor(model: InitModelOf<AjaxError>) {
    this.jqXHR = null;
    this.textStatus = null;
    this.errorThrown = null;
    this.requestOptions = null;
    $.extend(this, model);

    const errorDo = this.jqXHR?.responseJSON?.error;
    if (AjaxError.isErrorDo(errorDo)) {
      this.errorDo = errorDo;
    }
  }

  static isErrorDo(errorDo: any): errorDo is ErrorDo {
    return errorDo?._type === 'scout.Error'
      || objects.isNumber(errorDo?.severityAsInt); // if rt.rest.jackson dependency is missing no _type is part of the response. But instead the severityAsInt property.
  }

  static extractErrorDo(error: any): ErrorDo {
    if (error instanceof AjaxError) {
      return error.errorDo;
    }
    return null;
  }
}