@theia/request 1.45.0 → 1.46.0-next.72

package/README.md

@@ -1,29 +1,29 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - REQUEST</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/request` package is used to send proxy-aware http requests to other services.
-
-## Additional Information
-
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - REQUEST</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/request` package is used to send proxy-aware http requests to other services.
+
+## Additional Information
+
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

package/lib/common-request-service.d.ts

@@ -1,76 +1,76 @@
-/********************************************************************************
- * 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
- ********************************************************************************/
-export interface Headers {
-    [header: string]: string;
-}
-export interface RequestOptions {
-    type?: string;
-    url: string;
-    user?: string;
-    password?: string;
-    headers?: Headers;
-    timeout?: number;
-    data?: string;
-    followRedirects?: number;
-    proxyAuthorization?: string;
-}
-export interface RequestContext {
-    url: string;
-    res: {
-        headers: Headers;
-        statusCode?: number;
-    };
-    /**
-     * Contains the data returned by the request.
-     *
-     * If the request was transferred from the backend to the frontend, the buffer has been compressed into a string. In every case the buffer is an {@link Uint8Array}.
-     */
-    buffer: Uint8Array | string;
-}
-export declare namespace RequestContext {
-    function isSuccess(context: RequestContext): boolean;
-    function asText(context: RequestContext): string;
-    function asJson<T = {}>(context: RequestContext): T;
-    /**
-     * Convert the buffer to base64 before sending it to the frontend.
-     * This reduces the amount of JSON data transferred massively.
-     * Does nothing if the buffer is already compressed.
-     */
-    function compress(context: RequestContext): RequestContext;
-    /**
-     * Decompresses a base64 buffer into a normal array buffer
-     * Does nothing if the buffer is not compressed.
-     */
-    function decompress(context: RequestContext): RequestContext;
-}
-export interface RequestConfiguration {
-    proxyUrl?: string;
-    proxyAuthorization?: string;
-    strictSSL?: boolean;
-}
-export interface RequestService {
-    configure(config: RequestConfiguration): Promise<void>;
-    request(options: RequestOptions, token?: CancellationToken): Promise<RequestContext>;
-    resolveProxy(url: string): Promise<string | undefined>;
-}
-export declare const RequestService: unique symbol;
-export declare const BackendRequestService: unique symbol;
-export declare const REQUEST_SERVICE_PATH = "/services/request-service";
-export interface CancellationToken {
-    readonly isCancellationRequested: boolean;
-    readonly onCancellationRequested: (listener: () => void) => void;
-}
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+export interface Headers {
+    [header: string]: string;
+}
+export interface RequestOptions {
+    type?: string;
+    url: string;
+    user?: string;
+    password?: string;
+    headers?: Headers;
+    timeout?: number;
+    data?: string;
+    followRedirects?: number;
+    proxyAuthorization?: string;
+}
+export interface RequestContext {
+    url: string;
+    res: {
+        headers: Headers;
+        statusCode?: number;
+    };
+    /**
+     * Contains the data returned by the request.
+     *
+     * If the request was transferred from the backend to the frontend, the buffer has been compressed into a string. In every case the buffer is an {@link Uint8Array}.
+     */
+    buffer: Uint8Array | string;
+}
+export declare namespace RequestContext {
+    function isSuccess(context: RequestContext): boolean;
+    function asText(context: RequestContext): string;
+    function asJson<T = {}>(context: RequestContext): T;
+    /**
+     * Convert the buffer to base64 before sending it to the frontend.
+     * This reduces the amount of JSON data transferred massively.
+     * Does nothing if the buffer is already compressed.
+     */
+    function compress(context: RequestContext): RequestContext;
+    /**
+     * Decompresses a base64 buffer into a normal array buffer
+     * Does nothing if the buffer is not compressed.
+     */
+    function decompress(context: RequestContext): RequestContext;
+}
+export interface RequestConfiguration {
+    proxyUrl?: string;
+    proxyAuthorization?: string;
+    strictSSL?: boolean;
+}
+export interface RequestService {
+    configure(config: RequestConfiguration): Promise<void>;
+    request(options: RequestOptions, token?: CancellationToken): Promise<RequestContext>;
+    resolveProxy(url: string): Promise<string | undefined>;
+}
+export declare const RequestService: unique symbol;
+export declare const BackendRequestService: unique symbol;
+export declare const REQUEST_SERVICE_PATH = "/services/request-service";
+export interface CancellationToken {
+    readonly isCancellationRequested: boolean;
+    readonly onCancellationRequested: (listener: () => void) => void;
+}
 //# sourceMappingURL=common-request-service.d.ts.map

package/lib/common-request-service.js

@@ -1,85 +1,85 @@
-"use strict";
-/********************************************************************************
- * 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
- ********************************************************************************/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.REQUEST_SERVICE_PATH = exports.BackendRequestService = exports.RequestService = exports.RequestContext = void 0;
-const textDecoder = typeof TextDecoder !== 'undefined' ? new TextDecoder() : undefined;
-var RequestContext;
-(function (RequestContext) {
-    function isSuccess(context) {
-        return (context.res.statusCode && context.res.statusCode >= 200 && context.res.statusCode < 300) || context.res.statusCode === 1223;
-    }
-    RequestContext.isSuccess = isSuccess;
-    function hasNoContent(context) {
-        return context.res.statusCode === 204;
-    }
-    function asText(context) {
-        if (!isSuccess(context)) {
-            throw new Error(`Server returned code ${context.res.statusCode}.`);
-        }
-        if (hasNoContent(context)) {
-            return '';
-        }
-        // Ensures that the buffer is an Uint8Array
-        context = decompress(context);
-        if (textDecoder) {
-            return textDecoder.decode(context.buffer);
-        }
-        else {
-            return context.buffer.toString();
-        }
-    }
-    RequestContext.asText = asText;
-    function asJson(context) {
-        const str = asText(context);
-        try {
-            return JSON.parse(str);
-        }
-        catch (err) {
-            err.message += ':\n' + str;
-            throw err;
-        }
-    }
-    RequestContext.asJson = asJson;
-    /**
-     * Convert the buffer to base64 before sending it to the frontend.
-     * This reduces the amount of JSON data transferred massively.
-     * Does nothing if the buffer is already compressed.
-     */
-    function compress(context) {
-        if (context.buffer instanceof Uint8Array && Buffer !== undefined) {
-            context.buffer = Buffer.from(context.buffer).toString('base64');
-        }
-        return context;
-    }
-    RequestContext.compress = compress;
-    /**
-     * Decompresses a base64 buffer into a normal array buffer
-     * Does nothing if the buffer is not compressed.
-     */
-    function decompress(context) {
-        const buffer = context.buffer;
-        if (typeof buffer === 'string' && typeof atob === 'function') {
-            context.buffer = Uint8Array.from(atob(buffer), c => c.charCodeAt(0));
-        }
-        return context;
-    }
-    RequestContext.decompress = decompress;
-})(RequestContext = exports.RequestContext || (exports.RequestContext = {}));
-exports.RequestService = Symbol('RequestService');
-exports.BackendRequestService = Symbol('BackendRequestService');
-exports.REQUEST_SERVICE_PATH = '/services/request-service';
+"use strict";
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.REQUEST_SERVICE_PATH = exports.BackendRequestService = exports.RequestService = exports.RequestContext = void 0;
+const textDecoder = typeof TextDecoder !== 'undefined' ? new TextDecoder() : undefined;
+var RequestContext;
+(function (RequestContext) {
+    function isSuccess(context) {
+        return (context.res.statusCode && context.res.statusCode >= 200 && context.res.statusCode < 300) || context.res.statusCode === 1223;
+    }
+    RequestContext.isSuccess = isSuccess;
+    function hasNoContent(context) {
+        return context.res.statusCode === 204;
+    }
+    function asText(context) {
+        if (!isSuccess(context)) {
+            throw new Error(`Server returned code ${context.res.statusCode}.`);
+        }
+        if (hasNoContent(context)) {
+            return '';
+        }
+        // Ensures that the buffer is an Uint8Array
+        context = decompress(context);
+        if (textDecoder) {
+            return textDecoder.decode(context.buffer);
+        }
+        else {
+            return context.buffer.toString();
+        }
+    }
+    RequestContext.asText = asText;
+    function asJson(context) {
+        const str = asText(context);
+        try {
+            return JSON.parse(str);
+        }
+        catch (err) {
+            err.message += ':\n' + str;
+            throw err;
+        }
+    }
+    RequestContext.asJson = asJson;
+    /**
+     * Convert the buffer to base64 before sending it to the frontend.
+     * This reduces the amount of JSON data transferred massively.
+     * Does nothing if the buffer is already compressed.
+     */
+    function compress(context) {
+        if (context.buffer instanceof Uint8Array && Buffer !== undefined) {
+            context.buffer = Buffer.from(context.buffer).toString('base64');
+        }
+        return context;
+    }
+    RequestContext.compress = compress;
+    /**
+     * Decompresses a base64 buffer into a normal array buffer
+     * Does nothing if the buffer is not compressed.
+     */
+    function decompress(context) {
+        const buffer = context.buffer;
+        if (typeof buffer === 'string' && typeof atob === 'function') {
+            context.buffer = Uint8Array.from(atob(buffer), c => c.charCodeAt(0));
+        }
+        return context;
+    }
+    RequestContext.decompress = decompress;
+})(RequestContext = exports.RequestContext || (exports.RequestContext = {}));
+exports.RequestService = Symbol('RequestService');
+exports.BackendRequestService = Symbol('BackendRequestService');
+exports.REQUEST_SERVICE_PATH = '/services/request-service';
 //# sourceMappingURL=common-request-service.js.map

package/lib/index.d.ts

@@ -1,17 +1,17 @@
-/********************************************************************************
- * 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
- ********************************************************************************/
-export * from './common-request-service';
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+export * from './common-request-service';
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,29 +1,29 @@
-"use strict";
-/********************************************************************************
- * 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
- ********************************************************************************/
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./common-request-service"), exports);
+"use strict";
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common-request-service"), exports);
 //# sourceMappingURL=index.js.map

package/lib/node-request-service.d.ts

@@ -1,39 +1,39 @@
-/********************************************************************************
- * 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
- ********************************************************************************/
-/// <reference types="node" />
-import * as http from 'http';
-import { ProxyAgent } from './proxy';
-import { RequestConfiguration, RequestContext, RequestOptions, RequestService, CancellationToken } from './common-request-service';
-export interface RawRequestFunction {
-    (options: http.RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
-}
-export interface NodeRequestOptions extends RequestOptions {
-    agent?: ProxyAgent;
-    strictSSL?: boolean;
-    getRawRequest?(options: NodeRequestOptions): RawRequestFunction;
-}
-export declare class NodeRequestService implements RequestService {
-    protected proxyUrl?: string;
-    protected strictSSL?: boolean;
-    protected authorization?: string;
-    protected getNodeRequest(options: RequestOptions): RawRequestFunction;
-    protected getProxyUrl(url: string): Promise<string | undefined>;
-    configure(config: RequestConfiguration): Promise<void>;
-    protected processOptions(options: NodeRequestOptions): Promise<NodeRequestOptions>;
-    request(options: NodeRequestOptions, token?: CancellationToken): Promise<RequestContext>;
-    resolveProxy(url: string): Promise<string | undefined>;
-}
+/********************************************************************************
+ * 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
+ ********************************************************************************/
+/// <reference types="node" />
+import * as http from 'http';
+import { ProxyAgent } from './proxy';
+import { RequestConfiguration, RequestContext, RequestOptions, RequestService, CancellationToken } from './common-request-service';
+export interface RawRequestFunction {
+    (options: http.RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest;
+}
+export interface NodeRequestOptions extends RequestOptions {
+    agent?: ProxyAgent;
+    strictSSL?: boolean;
+    getRawRequest?(options: NodeRequestOptions): RawRequestFunction;
+}
+export declare class NodeRequestService implements RequestService {
+    protected proxyUrl?: string;
+    protected strictSSL?: boolean;
+    protected authorization?: string;
+    protected getNodeRequest(options: RequestOptions): RawRequestFunction;
+    protected getProxyUrl(url: string): Promise<string | undefined>;
+    configure(config: RequestConfiguration): Promise<void>;
+    protected processOptions(options: NodeRequestOptions): Promise<NodeRequestOptions>;
+    request(options: NodeRequestOptions, token?: CancellationToken): Promise<RequestContext>;
+    resolveProxy(url: string): Promise<string | undefined>;
+}
 //# sourceMappingURL=node-request-service.d.ts.map