types.ts

/*
 * Copyright (c) 2024. Devtron Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { APIOptions } from '..'

export interface CoreAPIConstructorParamsType {
    handleLogout: () => void
    handleRedirectToLicenseActivation?: () => void
    /**
     * @default Host
     */
    host?: string
    /**
     * @default FALLBACK_REQUEST_TIMEOUT
     */
    timeout?: number
}

export interface FetchInTimeParamsType<Data = object> {
    url: string
    type: 'POST' | 'PUT' | 'PATCH' | 'GET' | 'DELETE'
    data: Data
    options?: APIOptions
    isMultipartRequest?: boolean
}

export interface FetchAPIParamsType<Data = object>
    extends
        Omit<FetchInTimeParamsType<Data>, 'options'>,
        Pick<
            APIOptions,
            'preventAutoLogout' | 'preventLicenseRedirect' | 'shouldParseServerErrorForUnauthorizedUser' | 'isProxyHost'
        > {
    signal: AbortSignal
}