@opra/client 0.27.2 → 0.28.1

package/esm/impl/http-request-observable.js

@@ -1,252 +0,0 @@
-import { lastValueFrom, Observable } from 'rxjs';
-import { isReadableStreamLike } from 'rxjs/internal/util/isReadableStreamLike';
-import typeIs from '@browsery/type-is';
-import { isBlob, OpraURL } from '@opra/common';
-import { ClientError } from '../client-error.js';
-import { kClient, kContext } from '../constants.js';
-import { HttpObserveType } from '../enums/index.js';
-import { HttpEventType } from '../interfaces/index.js';
-import { HttpRequest } from './http-request.js';
-const directCopyProperties = ['cache', 'credentials', 'destination', 'headers', 'integrity',
-    'keepalive', 'mode', 'redirect', 'referrer', 'referrerPolicy'];
-const kIntlObservable = Symbol.for('kIntlObservable');
-/**
- * @class HttpRequestObservable
- */
-export class HttpRequestObservable extends Observable {
-    constructor(client, init) {
-        super((subscriber) => {
-            this[kIntlObservable].subscribe((event) => {
-                if (event.event === HttpEventType.Response) {
-                    subscriber.next(event.response.body);
-                    subscriber.complete();
-                }
-            }, (error) => subscriber.error(error), () => subscriber.complete());
-        });
-        const url = new OpraURL(init?.url);
-        Object.defineProperty(this, kContext, {
-            enumerable: false,
-            value: {
-                headers: new Headers(init?.headers),
-                params: url.searchParams,
-                requestInit: { ...init }
-            }
-        });
-        Object.defineProperty(this, kClient, {
-            enumerable: false,
-            value: client
-        });
-        this.request = new HttpRequest(init);
-        if (init?.headers)
-            this.header(init.headers);
-        this[kIntlObservable] = this._send();
-    }
-    httpOptions(options) {
-        directCopyProperties.forEach(k => {
-            if (options[k] !== undefined)
-                this.request[k] = options[k];
-        });
-        return this;
-    }
-    header(arg0, value) {
-        const headers = this.request.headers;
-        if (typeof arg0 === 'object') {
-            const h = arg0 instanceof Headers
-                ? arg0
-                : new Headers(arg0);
-            h.forEach((v, k) => {
-                if (k.toLowerCase() === 'set-cookie') {
-                    headers.append(k, v);
-                }
-                else
-                    headers.set(k, v);
-            });
-            return this;
-        }
-        if (value == null)
-            headers.delete(arg0);
-        else
-            headers.append(arg0, String(value));
-        return this;
-    }
-    param(arg0, value) {
-        const params = this.request.url.searchParams;
-        if (typeof arg0 === 'object') {
-            const h = arg0 instanceof URLSearchParams
-                ? arg0
-                : new URLSearchParams(arg0);
-            h.forEach((v, k) => params.set(k, v));
-            return this;
-        }
-        if (value == null)
-            params.delete(arg0);
-        else
-            params.set(arg0, String(value));
-        return this;
-    }
-    observe(observe) {
-        observe = observe || HttpObserveType.Body;
-        return new Observable((subscriber) => {
-            this[kIntlObservable].subscribe((event) => {
-                if (observe === HttpObserveType.Events) {
-                    subscriber.next(event);
-                    return;
-                }
-                if (observe === HttpObserveType.ResponseHeader && event.event === HttpEventType.ResponseHeader) {
-                    subscriber.next(event.response);
-                    subscriber.complete();
-                    return;
-                }
-                if (event.event === HttpEventType.Response) {
-                    const { response } = event;
-                    const isOpraResponse = typeIs.is(event.response.contentType || '', ['application/opra+json']);
-                    if (observe === HttpObserveType.Response) {
-                        subscriber.next(response);
-                        subscriber.complete();
-                        return;
-                    }
-                    if (response.status >= 400 && response.status < 600) {
-                        subscriber.error(new ClientError({
-                            message: response.status + ' ' + response.statusText,
-                            status: response.status,
-                            issues: isOpraResponse ? response.body.errors : undefined
-                        }));
-                        subscriber.complete();
-                        return;
-                    }
-                    subscriber.next(event.response.body);
-                    subscriber.complete();
-                }
-            }, (error) => subscriber.error(error), () => subscriber.complete());
-        });
-    }
-    toPromise() {
-        return this.getBody();
-    }
-    getBody() {
-        return lastValueFrom(this.observe(HttpObserveType.Body));
-    }
-    getResponse() {
-        return lastValueFrom(this.observe(HttpObserveType.Response));
-    }
-    _send() {
-        const request = this.request;
-        const clientContext = this[kClient][kContext];
-        return new Observable(subscriber => {
-            (async () => {
-                // Prepare request
-                this._prepareRequest();
-                // Call request Interceptors
-                for (const interceptor of clientContext.requestInterceptors) {
-                    await interceptor(request);
-                }
-                // Emit 'sent' event
-                subscriber.next({
-                    request,
-                    event: HttpEventType.Sent,
-                });
-                // Send request
-                const url = new OpraURL(request.url, clientContext.serviceUrl);
-                const fetchResponse = await clientContext.fetch(url.toString(), request);
-                const contentType = (fetchResponse.headers.get('content-type') || '').split(';')[0];
-                // Emit 'response-header' event
-                const headersResponse = clientContext.createResponse({
-                    url: fetchResponse.url,
-                    headers: fetchResponse.headers,
-                    status: fetchResponse.status,
-                    statusText: fetchResponse.statusText,
-                    hasBody: !!fetchResponse.body,
-                    contentType
-                });
-                subscriber.next({
-                    request,
-                    event: HttpEventType.ResponseHeader,
-                    response: headersResponse
-                });
-                // Parse body
-                const body = fetchResponse.body
-                    ? await this._parseBody(fetchResponse)
-                    : undefined;
-                // Create response
-                const responseInit = {
-                    url: fetchResponse.url,
-                    headers: fetchResponse.headers,
-                    status: fetchResponse.status,
-                    statusText: fetchResponse.statusText,
-                    contentType,
-                    body,
-                };
-                const response = clientContext.createResponse(responseInit);
-                // Call response Interceptors
-                for (const interceptor of clientContext.responseInterceptors) {
-                    await interceptor(response, request);
-                }
-                // Emit 'response' event
-                subscriber.next({
-                    request,
-                    event: HttpEventType.Response,
-                    response
-                });
-                subscriber.complete();
-            })().catch(error => subscriber.error(error));
-        });
-    }
-    _prepareRequest() {
-        const request = this.request;
-        if (request.body) {
-            let body;
-            let contentType;
-            if (typeof request.body === 'string' || typeof request.body === 'number' || typeof request.body === 'boolean') {
-                contentType = 'text/plain;charset=UTF-8"';
-                body = String(request.body);
-                request.headers.delete('Content-Size');
-                delete request.duplex;
-            }
-            else if (isReadableStreamLike(request.body)) {
-                contentType = 'application/octet-stream';
-                body = request.body;
-                request.duplex = 'half';
-            }
-            else if (Buffer.isBuffer(request.body)) {
-                contentType = 'application/octet-stream';
-                body = request.body;
-                request.headers.set('Content-Size', String(request.body.length));
-                delete request.duplex;
-            }
-            else if (isBlob(request.body)) {
-                contentType = request.body.type || 'application/octet-stream';
-                body = request.body;
-                request.headers.set('Content-Size', String(request.body.size));
-                delete request.duplex;
-            }
-            else {
-                contentType = 'application/json';
-                body = JSON.stringify(request.body);
-                request.headers.delete('Content-Size');
-                delete request.duplex;
-            }
-            if (!request.headers.has('Content-Type') && contentType)
-                request.headers.set('Content-Type', contentType);
-            request.body = body;
-        }
-    }
-    async _parseBody(fetchResponse) {
-        let body;
-        const contentType = (fetchResponse.headers.get('Content-Type') || '');
-        if (typeIs.is(contentType, ['json', 'application/*+json'])) {
-            body = await fetchResponse.json();
-            if (typeof body === 'string')
-                body = JSON.parse(body);
-        }
-        else if (typeIs.is(contentType, ['text']))
-            body = await fetchResponse.text();
-        else if (typeIs.is(contentType, ['multipart']))
-            body = await fetchResponse.formData();
-        else {
-            const buf = await fetchResponse.arrayBuffer();
-            if (buf.byteLength)
-                body = buf;
-        }
-        return body;
-    }
-}

package/esm/impl/http-request.js

@@ -1,23 +0,0 @@
-/// <reference lib="dom" />
-import { OpraURL } from '@opra/common';
-/**
- * @class HttpRequest
- */
-export class HttpRequest {
-    constructor(init) {
-        this.cache = init?.cache || 'default';
-        this.credentials = init?.credentials || 'same-origin';
-        this.destination = init?.destination || '';
-        this.integrity = init?.integrity || '';
-        this.keepalive = init?.keepalive ?? false;
-        this.method = (init?.method || 'GET').toUpperCase();
-        this.mode = init?.mode || 'cors';
-        this.redirect = init?.redirect || 'follow';
-        this.referrer = init?.referrer || '';
-        this.referrerPolicy = init?.referrerPolicy || '';
-        this.signal = init?.signal || new AbortController().signal;
-        this.body = init?.body;
-        this.url = init?.url instanceof OpraURL ? init.url : new OpraURL(init?.url);
-        this.headers = init?.headers instanceof Headers ? init.headers : new Headers(init?.headers);
-    }
-}

package/esm/interfaces/index.js

@@ -1,2 +0,0 @@
-export * from './http-event.interface.js';
-export * from './http-request-defaults.interface.js';

package/types/client.d.ts

@@ -1,33 +0,0 @@
-import { StrictOmit } from 'ts-gems';
-import { ApiDocument } from '@opra/common';
-import { kContext } from './constants.js';
-import { HttpCollectionNode } from './impl/collection-node.js';
-import { HttpRequestObservable } from './impl/http-request-observable.js';
-import { HttpSingletonNode } from './impl/singleton-node.js';
-import { OpraHttpClientContext } from './interfaces/client-context.interface.js';
-import { HttpRequestDefaults } from './interfaces/index.js';
-import { RequestInterceptor, ResponseInterceptor } from './types.js';
-export declare namespace OpraHttpClient {
-    interface Options {
-        api?: ApiDocument;
-        requestInterceptors?: RequestInterceptor[];
-        responseInterceptors?: ResponseInterceptor[];
-        defaults?: HttpRequestDefaults;
-    }
-    type Defaults = StrictOmit<HttpRequestDefaults, 'headers' | 'params'> & {
-        headers: Headers;
-        params: URLSearchParams;
-    };
-}
-export declare class OpraHttpClient<TResponseExt = {}> {
-    protected _metadataPromise?: Promise<any>;
-    [kContext]: OpraHttpClientContext;
-    constructor(serviceUrl: string, options?: OpraHttpClient.Options);
-    get serviceUrl(): string;
-    get api(): ApiDocument | undefined;
-    get defaults(): OpraHttpClient.Defaults;
-    getMetadata(): Promise<ApiDocument>;
-    collection<TType = any>(path: string): HttpCollectionNode<TType, TResponseExt>;
-    singleton<TType = any>(path: string): HttpSingletonNode<TType, TResponseExt>;
-    action<T = any>(path: string, params?: Record<string, any>): HttpRequestObservable<T, TResponseExt>;
-}

package/types/enums/index.d.ts

@@ -1 +0,0 @@
-export * from './http-observable-type.enum.js';

package/types/impl/http-request-observable.d.ts

@@ -1,47 +0,0 @@
-import { Observable } from 'rxjs';
-import type { OpraHttpClient } from '../client.js';
-import { kClient, kContext } from '../constants.js';
-import { HttpObserveType } from '../enums/index.js';
-import { HttpEvent } from '../interfaces/index.js';
-import { URLSearchParamsInit } from '../types.js';
-import { HttpRequest } from './http-request.js';
-import { HttpResponse } from './http-response.js';
-/**
- * @namespace HttpRequestObservable
- */
-export declare namespace HttpRequestObservable {
-    interface HttpOptions extends Partial<Pick<HttpRequest, 'cache' | 'credentials' | 'destination' | 'integrity' | 'keepalive' | 'mode' | 'redirect' | 'referrer' | 'referrerPolicy'>> {
-    }
-}
-declare const kIntlObservable: unique symbol;
-/**
- * @class HttpRequestObservable
- */
-export declare class HttpRequestObservable<TPayload = any, TResponseExt = {}> extends Observable<TPayload> {
-    [kClient]: OpraHttpClient;
-    [kContext]: {
-        headers: Headers;
-        params: URLSearchParams;
-        requestInit: any;
-    };
-    [kIntlObservable]: Observable<HttpEvent>;
-    request: HttpRequest;
-    constructor(client: OpraHttpClient<any>, init?: HttpRequest.Initiator);
-    httpOptions(options: HttpRequestObservable.HttpOptions): this;
-    header(headers: HeadersInit): this;
-    header(name: string, value?: string | number | boolean | null): this;
-    param(params: URLSearchParamsInit): this;
-    param(name: string, value: any): this;
-    observe(): Observable<TPayload>;
-    observe(observe: HttpObserveType.Body): Observable<any>;
-    observe(observe: HttpObserveType.ResponseHeader): Observable<HttpResponse<void> & TResponseExt>;
-    observe(observe: HttpObserveType.Response): Observable<HttpResponse<any> & TResponseExt>;
-    observe(observe: HttpObserveType.Events): Observable<HttpEvent>;
-    toPromise(): Promise<TPayload>;
-    getBody(): Promise<TPayload>;
-    getResponse(): Promise<HttpResponse<TPayload> & TResponseExt>;
-    protected _send(): Observable<HttpEvent>;
-    protected _prepareRequest(): void;
-    protected _parseBody(fetchResponse: Response): Promise<TPayload>;
-}
-export {};

package/types/impl/http-request.d.ts

@@ -1,71 +0,0 @@
-/// <reference lib="dom" />
-import { OpraURL } from '@opra/common';
-/**
- * @namespace HttpRequest
- */
-export declare namespace HttpRequest {
-    interface Initiator {
-        cache?: RequestCache;
-        credentials?: RequestCredentials;
-        destination?: RequestDestination;
-        headers?: HeadersInit;
-        integrity?: string;
-        keepalive?: boolean;
-        method?: string;
-        mode?: RequestMode;
-        redirect?: RequestRedirect;
-        referrer?: string;
-        referrerPolicy?: ReferrerPolicy;
-        signal?: AbortSignal;
-        url: string | URL | OpraURL;
-        body?: any;
-    }
-}
-/**
- * @class HttpRequest
- */
-export declare class HttpRequest {
-    /** The url for request */
-    url: OpraURL;
-    /** Body of the http request */
-    body?: any;
-    /** The cache mode associated with request, which is a string indicating
-     * how the request will interact with the browser's cache when fetching. */
-    cache: RequestCache;
-    /** The credentials mode associated with request, which is a string indicating
-     * whether credentials will be sent with the request always, never,
-     * or only when sent to a same-origin URL. */
-    credentials: RequestCredentials;
-    /** The kind of resource requested by request, e.g., "document" or "script". */
-    destination: RequestDestination;
-    /** Headers object consisting of the headers associated with request.
-     * Note that headers added in the network layer by the user agent will not be accounted for in this object,
-     * e.g., the "Host" header. */
-    headers: Headers;
-    /** Request's subresource integrity metadata, which is a cryptographic
-     * hash of the resource being fetched.
-     * Its value consists of multiple hashes separated by whitespace. [SRI] */
-    integrity: string;
-    /** A boolean indicating whether or not request can outlive the global in which it was created. */
-    keepalive: boolean;
-    /** Request's HTTP method, which is "GET" by default. */
-    method: string;
-    /** The mode associated with request, which is a string indicating whether the request will use CORS,
-     *  or will be restricted to same-origin URLs. */
-    mode: RequestMode;
-    /** The redirect mode associated with request, which is a string indicating
-     * how redirects for the request will be handled during fetching. A request will follow redirects by default. */
-    redirect: RequestRedirect;
-    /** The referrer of request. Its value can be a same-origin URL if explicitly set in init,
-     *  the empty string to indicate no referrer, and "about:client" when defaulting to the global's default.
-     *  This is used during fetching to determine the value of the `Referer` header of the request being made. */
-    referrer: string;
-    /** The referrer policy associated with request. This is used during fetching
-     * to compute the value of the request's referrer. */
-    referrerPolicy: ReferrerPolicy;
-    /** The signal associated with request, which is an AbortSignal object indicating
-     *  whether or not request has been aborted, and its abort event handler. */
-    signal?: AbortSignal;
-    duplex?: 'half';
-    constructor(init?: HttpRequest.Initiator);
-}

package/types/interfaces/client-context.interface.d.ts

@@ -1,13 +0,0 @@
-import type { ApiDocument } from '@opra/common';
-import type { OpraHttpClient } from '../client.js';
-import type { HttpResponse } from '../impl/http-response.js';
-import type { RequestInterceptor, ResponseInterceptor } from '../types.js';
-export interface OpraHttpClientContext {
-    serviceUrl: string;
-    requestInterceptors: RequestInterceptor[];
-    responseInterceptors: ResponseInterceptor[];
-    createResponse: (init?: HttpResponse.Initiator) => HttpResponse<any>;
-    fetch: (url: string, init?: RequestInit) => Promise<Response>;
-    api?: ApiDocument;
-    defaults: OpraHttpClient.Defaults;
-}

package/types/interfaces/http-event.interface.d.ts

@@ -1,88 +0,0 @@
-import type { HttpRequest } from '../impl/http-request.js';
-import type { HttpResponse } from '../impl/http-response.js';
-export type HttpEvent = HttpSentEvent | HttpDownloadProgressEvent | HttpUploadProgressEvent | HttpResponseHeaderEvent | HttpResponseEvent | HttpUserEvent;
-/**
- * Type enumeration for the different kinds of `HttpEvent`.
- */
-export declare enum HttpEventType {
-    /**
-     * The request was sent out over the wire.
-     */
-    Sent = "sent",
-    /**
-     * An upload progress event was received.
-     *
-     * Note: The `FetchBackend` doesn't support progress report on uploads.
-     */
-    UploadProgress = "upload-progress",
-    /**
-     * The response status code and headers were received.
-     */
-    ResponseHeader = "response-header",
-    /**
-     * A download progress event was received.
-     */
-    DownloadProgress = "download-progress",
-    /**
-     * The full response including the body was received.
-     */
-    Response = "response",
-    /**
-     * A custom event from an interceptor or a backend.
-     */
-    Custom = "custom"
-}
-interface HttpEventBase {
-    request: HttpRequest;
-    event: HttpEventType;
-}
-export interface HttpSentEvent extends HttpEventBase {
-    event: HttpEventType.Sent;
-}
-export interface HttpDownloadProgressEvent extends HttpEventBase {
-    event: HttpEventType.DownloadProgress;
-    /**
-     * Number of bytes uploaded
-     */
-    loaded: number;
-    /**
-     * Total number of bytes to upload.
-     * Depending on the request, this may not be computable and thus may not be present.
-     */
-    total?: number;
-}
-export interface HttpUploadProgressEvent extends HttpEventBase {
-    event: HttpEventType.UploadProgress;
-    /**
-     * Response object
-     */
-    response: HttpResponse;
-    /**
-     * Number of bytes uploaded
-     */
-    loaded: number;
-    /**
-     * Total number of bytes to upload.
-     * Depending on the request, this may not be computable and thus may not be present.
-     */
-    total?: number;
-}
-export interface HttpResponseHeaderEvent extends HttpEventBase {
-    event: HttpEventType.ResponseHeader;
-    /**
-     * Response object
-     */
-    response: HttpResponse;
-}
-export interface HttpResponseEvent extends HttpEventBase {
-    event: HttpEventType.Response;
-    /**
-     * Response object
-     */
-    response: HttpResponse;
-}
-export interface HttpUserEvent extends HttpEventBase {
-    event: HttpEventType.Custom;
-    [key: string | number | symbol]: any;
-}
-export {};

package/types/interfaces/http-request-defaults.interface.d.ts

@@ -1,6 +0,0 @@
-import type { HttpRequest } from '../impl/http-request.js';
-import type { URLSearchParamsInit } from '../types.js';
-export interface HttpRequestDefaults extends Partial<Pick<HttpRequest, 'cache' | 'credentials' | 'destination' | 'integrity' | 'keepalive' | 'mode' | 'redirect' | 'referrer' | 'referrerPolicy'>> {
-    headers?: HeadersInit;
-    params?: URLSearchParamsInit;
-}

package/types/interfaces/index.d.ts

@@ -1,2 +0,0 @@
-export * from './http-event.interface.js';
-export * from './http-request-defaults.interface.js';