@theia/core/lib/node/request/backend-request-facade.d.ts

Theia is a cloud & desktop IDE framework implemented in TypeScript.

/********************************************************************************
 * Copyright (C) 2022 TypeFox and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
 ********************************************************************************/
import { RequestConfiguration, RequestContext, RequestOptions, RequestService } from '@theia/request';
import { ContributionProvider, MaybePromise } from '../../common';
export declare const BackendRequestAllowedContribution: unique symbol;
export interface BackendRequestAllowedContribution {
    /**
     * Returns URL patterns that should be allowed through the backend request facade.
     * Patterns are matched against request URLs.
     *
     * Supports:
     * - Exact base URLs: `https://open-vsx.org` (allows any path under this origin)
     * - Wildcard subdomains: `https://*.github.com` (allows any subdomain)
     *
     * Only `http:` and `https:` schemes are permitted.
     */
    getAllowedUrlPatterns(): MaybePromise<string[]>;
}
export declare function isUrlAllowed(url: string, allowedPatterns: string[]): boolean;
export declare class BackendRequestFacade implements RequestService {
    protected readonly requestService: RequestService;
    protected readonly allowedContributions?: ContributionProvider<BackendRequestAllowedContribution>;
    protected cachedAllowedPatterns: string[] | undefined;
    configure(config: RequestConfiguration): Promise<void>;
    request(options: RequestOptions): Promise<RequestContext>;
    resolveProxy(url: string): Promise<string | undefined>;
    protected getAllowedPatterns(): Promise<string[]>;
}
//# sourceMappingURL=backend-request-facade.d.ts.map