Skip to content

EspoCRM – Open Source CRM Application

8.8 KB
Raw Blame
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM – Open Source CRM application.
 * Copyright (C) 2014-2026 EspoCRM, Inc.
 * Website: https://www.espocrm.com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

/** @module ajax */

import $ from 'jquery';
import Utils from 'utils';
import {AjaxPromise, Xhr} from 'util/ajax';

let isConfigured: boolean = false;
let defaultTimeout: number;
let apiUrl: string;
let beforeSend: Handler;
let onSuccess: Handler;
let onError: Handler;
let onTimeout: Handler;
let onOffline: (() => void) | undefined;

type Handler = (xhr?: XMLHttpRequest, options?: Record<string, any>) => void;

/**
 * Options.
 */
interface Options {
    timeout?: number,
    headers?: Record<string, string>,
    dataType?: 'json' | 'text',
    contentType?: string,
    resolveWithXhr?: boolean,
}

const baseUrl = Utils.obtainBaseUrl();

// noinspection JSUnusedGlobalSymbols
/**
 * Functions for API HTTP requests.
 */
const Ajax = {

    /**
     * Request.
     *
     * @param url An URL.
     * @param method An HTTP method.
     * @param {*} [data] Data.
     * @param [options] Options.
     * @returns {AjaxPromise<any>}
     */
    request: function (
        url: string,
        method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS',
        data: any = undefined,
        options: Options & Record<string, any> = {}
    ): AjaxPromise {

        const timeout = 'timeout' in options ? options.timeout : defaultTimeout;
        const contentType = options.contentType || 'application/json';

        let body: any;

        if (options.data && !data) {
            data = options.data;
        }

        if (apiUrl) {
            url = Utils.trimSlash(apiUrl) + '/' + url;
        }

        if (!['GET', 'OPTIONS'].includes(method) && data) {
            body = data;

            if (contentType === 'application/json' && typeof data !== 'string') {
                body = JSON.stringify(data);
            }
        }

        if (method === 'GET' && data) {
            const part = $.param(data);

            url.includes('?') ?
                url += '&' :
                url += '?';

            url += part;
        }

        const urlObj = new URL(baseUrl + url);

        const xhr = new Xhr();

        if (timeout != null) {
            xhr.timeout = timeout;
        }

        xhr.open(method, urlObj);

        const headers = options.headers ?? {}

        const hasContentType = Object.keys(headers).find(it => it.toLowerCase() === 'content-type');

        if (!hasContentType) {
            xhr.setRequestHeader('Content-Type', contentType);
        }

        for (const key in headers) {
            xhr.setRequestHeader(key, headers[key]);
        }

        if (beforeSend) {
            beforeSend(xhr, options);
        }

        const promiseWrapper: {
            promise?: AjaxPromise,
            xhr?: Xhr,
        } = {};

        const promise = new AjaxPromise<any>((resolve, reject) => {
            const onErrorGeneral = (isTimeout: boolean = false) => {
                if (options.error) {
                    options.error(xhr, options);
                }

                // @ts-ignore
                reject(xhr, options);

                if (isTimeout) {
                    if (onTimeout) {
                        onTimeout(xhr, options);
                    }

                    return;
                }

                if (xhr.status === 0 && !navigator.onLine && onOffline) {
                    onOffline();

                    return;
                }

                if (onError) {
                    onError(xhr, options);
                }
            };

            xhr.ontimeout = () => onErrorGeneral(true);
            xhr.onerror = () => onErrorGeneral();

            xhr.onload = () => {
                if (xhr.status >= 400) {
                    onErrorGeneral();

                    return;
                }

                let response: string | Xhr = xhr.responseText;

                if ((options.dataType || 'json') === 'json') {
                    try {
                        response = JSON.parse(xhr.responseText);
                    } catch (e) {
                        console.error('Could not parse API response.');

                        onErrorGeneral();
                    }
                }

                if (options.success) {
                    options.success(response);
                }

                onSuccess(xhr, options);

                if (options.resolveWithXhr) {
                    response = xhr;
                }

                resolve(response)
            }

            xhr.send(body);

            if (promiseWrapper.promise) {
                promiseWrapper.promise.xhr = xhr;

                return;
            }

            promiseWrapper.xhr = xhr;
        });

        promiseWrapper.promise = promise;
        promise.xhr = promise.xhr ?? promiseWrapper.xhr ?? null;

        return promise;
    },

    /**
     * POST request.
     *
     * @param {string} url An URL.
     * @param [data] Data.
     * @param [options] Options.
     */
    postRequest: function (
        url: string,
        data?: any,
        options?: Options & Record<string, any>,
    ): Promise<any> & AjaxPromise {

        if (data) {
            data = JSON.stringify(data);
        }

        return Ajax.request(url, 'POST', data, options);
    },

    /**
     * PATCH request.
     *
     * @param url An URL.
     * @param [data] Data.
     * @param [options] Options.
     */
    patchRequest: function (
        url: string,
        data: any = undefined,
        options?: Options & Record<string, any>,
    ): Promise<any> & AjaxPromise {

        if (data) {
            data = JSON.stringify(data);
        }

        return Ajax.request(url, 'PATCH', data, options);
    },

    /**
     * PUT request.
     *
     * @param url An URL.
     * @param [data] Data.
     * @param [options] Options.
     */
    putRequest: function (
        url: string,
        data: any = undefined,
        options?: Options & Record<string, any>,
    ): Promise<any> & AjaxPromise {

        if (data) {
            data = JSON.stringify(data);
        }

        return Ajax.request(url, 'PUT', data, options);
    },

    /**
     * DELETE request.
     *
     * @param url An URL.
     * @param [data] Data.
     * @param [options] Options.
     */
    deleteRequest: function (
        url: string,
        data?: any,
        options?: Options & Record<string, any>,
    ): Promise<any> & AjaxPromise {

        if (data) {
            data = JSON.stringify(data);
        }

        return Ajax.request(url, 'DELETE', data, options);
    },

    /**
     * GET request.
     *
     * @param url An URL.
     * @param [data] Data.
     * @param [options] Options.
     */
    getRequest: function (
        url: string,
        data: any = undefined,
        options?: Options & Record<string, any>,
    ): Promise<any> & AjaxPromise {

        return Ajax.request(url, 'GET', data, options);
    },

    /**
     * @internal
     * @param options Options.
     */
    configure: function (
        options: {
            apiUrl: string,
            timeout: number,
            beforeSend: Handler,
            onSuccess: Handler,
            onError: Handler,
            onTimeout: Handler,
            onOffline?: () => void,
        }
    ) {

        if (isConfigured) {
            throw new Error("Ajax is already configured.");
        }

        apiUrl = options.apiUrl;
        defaultTimeout = options.timeout;
        beforeSend = options.beforeSend;
        onSuccess = options.onSuccess;
        onError = options.onError;
        onTimeout = options.onTimeout;
        onOffline = options.onOffline;

        isConfigured = true;
    },
};


// @ts-ignore
Espo.Ajax = Ajax;

export default Ajax;