@opra/client 0.25.4 → 0.26.0

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

@@ -0,0 +1,246 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpRequestObservable = void 0;
+const rxjs_1 = require("rxjs");
+const isReadableStreamLike_1 = require("rxjs/internal/util/isReadableStreamLike");
+const common_1 = require("@opra/common");
+const client_error_js_1 = require("../client-error.js");
+const constants_js_1 = require("../constants.js");
+const index_js_1 = require("../enums/index.js");
+const index_js_2 = require("../interfaces/index.js");
+const http_request_js_1 = require("./http-request.js");
+const directCopyProperties = ['cache', 'credentials', 'destination', 'headers', 'integrity',
+    'keepalive', 'mode', 'redirect', 'referrer', 'referrerPolicy'];
+const kIntlObservable = Symbol.for('kIntlObservable');
+/**
+ * @class HttpRequestObservable
+ */
+class HttpRequestObservable extends rxjs_1.Observable {
+    constructor(client, init) {
+        super((subscriber) => {
+            this[kIntlObservable].subscribe((event) => {
+                if (event.event === index_js_2.HttpEventType.Response) {
+                    subscriber.next(event.response.body);
+                    subscriber.complete();
+                }
+            }, (error) => subscriber.error(error), () => subscriber.complete());
+        });
+        Object.defineProperty(this, constants_js_1.kClient, {
+            enumerable: false,
+            value: client
+        });
+        this.request = new http_request_js_1.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) {
+        return new rxjs_1.Observable((subscriber) => {
+            this[kIntlObservable].subscribe((event) => {
+                if (observe === index_js_1.HttpObserveType.Events) {
+                    subscriber.next(event);
+                    return;
+                }
+                if (observe === index_js_1.HttpObserveType.ResponseHeader && event.event === index_js_2.HttpEventType.ResponseHeader) {
+                    subscriber.next(event.response);
+                    subscriber.complete();
+                    return;
+                }
+                if (observe === index_js_1.HttpObserveType.Body && event.event === index_js_2.HttpEventType.Response) {
+                    subscriber.next(event.response.body);
+                    subscriber.complete();
+                    return;
+                }
+                if (event.event === index_js_2.HttpEventType.Response) {
+                    subscriber.next(event.response);
+                    subscriber.complete();
+                }
+            }, (error) => subscriber.error(error), () => subscriber.complete());
+        });
+    }
+    toPromise() {
+        return this.getData();
+    }
+    getData() {
+        return (0, rxjs_1.lastValueFrom)(this.observe(index_js_1.HttpObserveType.Body));
+    }
+    getResponse() {
+        return (0, rxjs_1.lastValueFrom)(this.observe(index_js_1.HttpObserveType.Response));
+    }
+    _send() {
+        const request = this.request;
+        const clientContext = this[constants_js_1.kClient][constants_js_1.kContext];
+        return new rxjs_1.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: index_js_2.HttpEventType.Sent,
+                });
+                // Send request
+                const url = new common_1.OpraURL(request.url, clientContext.serviceUrl);
+                const fetchResponse = await clientContext.fetch(url.toString(), request);
+                // Emit 'response-header' event
+                const headersResponse = clientContext.createResponse({
+                    url: fetchResponse.url,
+                    headers: fetchResponse.headers,
+                    status: fetchResponse.status,
+                    statusText: fetchResponse.statusText,
+                    hasBody: !!fetchResponse.body
+                });
+                subscriber.next({
+                    request,
+                    event: index_js_2.HttpEventType.ResponseHeader,
+                    response: headersResponse
+                });
+                // Parse body
+                const body = fetchResponse.body
+                    ? await this._parseBody(fetchResponse)
+                    : undefined;
+                // Handle errors
+                if (fetchResponse.status >= 400 && fetchResponse.status <= 599) {
+                    subscriber.error(new client_error_js_1.ClientError({
+                        message: fetchResponse.status + ' ' + fetchResponse.statusText,
+                        status: fetchResponse.status,
+                        issues: body.errors
+                    }));
+                    subscriber.complete();
+                    return;
+                }
+                // Create response
+                const contentType = fetchResponse.headers.get('Content-Type') || '';
+                const responseInit = {
+                    url: fetchResponse.url,
+                    headers: fetchResponse.headers,
+                    status: fetchResponse.status,
+                    statusText: fetchResponse.statusText,
+                    body,
+                };
+                if (constants_js_1.OPRA_JSON_CONTENT_TYPE_PATTERN.test(contentType)) {
+                    responseInit.totalCount = body?.totalCount;
+                    responseInit.affected = body?.affected;
+                }
+                const response = clientContext.createResponse(responseInit);
+                // Call response Interceptors
+                for (const interceptor of clientContext.responseInterceptors) {
+                    await interceptor(response);
+                }
+                // Emit 'response' event
+                subscriber.next({
+                    request,
+                    event: index_js_2.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 ((0, isReadableStreamLike_1.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 ((0, common_1.isBlob)(request.body)) {
+                contentType = request.body.type || 'application/octet-stream';
+                body = request.body;
+                request.headers.set('Content-Size', String(request.body.length));
+                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 (constants_js_1.JSON_CONTENT_TYPE_PATTERN.test(contentType)) {
+            body = await fetchResponse.json();
+            if (typeof body === 'string')
+                body = JSON.parse(body);
+        }
+        else if (constants_js_1.TEXT_CONTENT_TYPE_PATTERN.test(contentType))
+            body = await fetchResponse.text();
+        else if (constants_js_1.FORMDATA_CONTENT_TYPE_PATTERN.test(contentType))
+            body = await fetchResponse.formData();
+        else {
+            const buf = await fetchResponse.arrayBuffer();
+            if (buf.byteLength)
+                body = buf;
+        }
+        return body;
+    }
+}
+exports.HttpRequestObservable = HttpRequestObservable;

package/cjs/impl/http-request.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpRequest = void 0;
+/// <reference lib="dom" />
+const common_1 = require("@opra/common");
+/**
+ * @class HttpRequest
+ */
+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.mode = init?.mode || 'cors';
+        this.referrer = init?.referrer || '';
+        this.referrerPolicy = init?.referrerPolicy || '';
+        this.signal = init?.signal || new AbortController().signal;
+        this.body = init?.body;
+        this.url = init?.url instanceof common_1.OpraURL ? init.url : new common_1.OpraURL(init?.url);
+        this.headers = init?.headers instanceof Headers ? init.headers : new Headers(init?.headers);
+    }
+}
+exports.HttpRequest = HttpRequest;

package/cjs/impl/http-service-base.js

@@ -0,0 +1,16 @@
+"use strict";
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpServiceBase = void 0;
+const constants_js_1 = require("../constants.js");
+class HttpServiceBase {
+    constructor(client) {
+        this[_a] = {
+            resource: {},
+            node: null
+        };
+        this[constants_js_1.kClient] = client;
+    }
+}
+exports.HttpServiceBase = HttpServiceBase;
+_a = constants_js_1.kContext;

package/cjs/impl/singleton-node.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpSingletonNode = void 0;
+const putil_varhelpers_1 = require("putil-varhelpers");
+const http_request_observable_js_1 = require("./http-request-observable.js");
+/**
+ * @class HttpSingletonNode
+ */
+class HttpSingletonNode {
+    constructor(client, path) {
+        this._client = client;
+        this._path = path;
+    }
+    create(data, options) {
+        const observable = new http_request_observable_js_1.HttpRequestObservable(this._client, {
+            method: 'POST',
+            url: this._path,
+            body: data
+        });
+        if (options?.include)
+            observable.param('include', (0, putil_varhelpers_1.toArrayDef)(options.include, []).join(','));
+        if (options?.pick)
+            observable.param('pick', (0, putil_varhelpers_1.toArrayDef)(options.pick, []).join(','));
+        if (options?.omit)
+            observable.param('omit', (0, putil_varhelpers_1.toArrayDef)(options.omit, []).join(','));
+        return observable;
+    }
+    delete() {
+        return new http_request_observable_js_1.HttpRequestObservable(this._client, {
+            method: 'DELETE',
+            url: this._path
+        });
+    }
+    get(options) {
+        const observable = new http_request_observable_js_1.HttpRequestObservable(this._client, {
+            method: 'GET',
+            url: this._path
+        });
+        if (options?.include)
+            observable.param('include', (0, putil_varhelpers_1.toArrayDef)(options.include, []).join(','));
+        if (options?.pick)
+            observable.param('pick', (0, putil_varhelpers_1.toArrayDef)(options.pick, []).join(','));
+        if (options?.omit)
+            observable.param('omit', (0, putil_varhelpers_1.toArrayDef)(options.omit, []).join(','));
+        return observable;
+    }
+    update(data, options) {
+        const observable = new http_request_observable_js_1.HttpRequestObservable(this._client, {
+            method: 'PATCH',
+            url: this._path,
+            body: data
+        });
+        if (options?.include)
+            observable.param('include', (0, putil_varhelpers_1.toArrayDef)(options.include, []).join(','));
+        if (options?.pick)
+            observable.param('pick', (0, putil_varhelpers_1.toArrayDef)(options.pick, []).join(','));
+        if (options?.omit)
+            observable.param('omit', (0, putil_varhelpers_1.toArrayDef)(options.omit, []).join(','));
+        return observable;
+    }
+}
+exports.HttpSingletonNode = HttpSingletonNode;

package/cjs/index.js

@@ -1,12 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.kContext = exports.kClient = void 0;
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./client.js"), exports);
 tslib_1.__exportStar(require("./client-error.js"), exports);
-tslib_1.__exportStar(require("./collection-node.js"), exports);
-tslib_1.__exportStar(require("./http-request.js"), exports);
-tslib_1.__exportStar(require("./http-request-observable.js"), exports);
-tslib_1.__exportStar(require("./http-response.js"), exports);
-tslib_1.__exportStar(require("./http-service-base.js"), exports);
-tslib_1.__exportStar(require("./singleton-node.js"), exports);
 tslib_1.__exportStar(require("./types.js"), exports);
+tslib_1.__exportStar(require("./enums/index.js"), exports);
+tslib_1.__exportStar(require("./interfaces/index.js"), exports);
+tslib_1.__exportStar(require("./impl/collection-node.js"), exports);
+tslib_1.__exportStar(require("./impl/singleton-node.js"), exports);
+tslib_1.__exportStar(require("./impl/http-request.js"), exports);
+tslib_1.__exportStar(require("./impl/http-response.js"), exports);
+tslib_1.__exportStar(require("./impl/http-service-base.js"), exports);
+tslib_1.__exportStar(require("./impl/http-request-observable.js"), exports);
+var constants_js_1 = require("./constants.js");
+Object.defineProperty(exports, "kClient", { enumerable: true, get: function () { return constants_js_1.kClient; } });
+Object.defineProperty(exports, "kContext", { enumerable: true, get: function () { return constants_js_1.kContext; } });

package/cjs/interfaces/client-context.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/interfaces/http-event.interface.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpEventType = void 0;
+/**
+ * Type enumeration for the different kinds of `HttpEvent`.
+ */
+var HttpEventType;
+(function (HttpEventType) {
+    /**
+     * The request was sent out over the wire.
+     */
+    HttpEventType["Sent"] = "sent";
+    /**
+     * An upload progress event was received.
+     *
+     * Note: The `FetchBackend` doesn't support progress report on uploads.
+     */
+    HttpEventType["UploadProgress"] = "upload-progress";
+    /**
+     * The response status code and headers were received.
+     */
+    HttpEventType["ResponseHeader"] = "response-header";
+    /**
+     * A download progress event was received.
+     */
+    HttpEventType["DownloadProgress"] = "download-progress";
+    /**
+     * The full response including the body was received.
+     */
+    HttpEventType["Response"] = "response";
+    /**
+     * A custom event from an interceptor or a backend.
+     */
+    HttpEventType["Custom"] = "custom";
+})(HttpEventType || (exports.HttpEventType = HttpEventType = {}));

package/cjs/interfaces/http-request-defaults.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/interfaces/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./http-event.interface.js"), exports);
+tslib_1.__exportStar(require("./http-request-defaults.interface.js"), exports);

package/cjs/types.js

@@ -1,44 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpEventType = exports.HttpObserveType = void 0;
-/* **********************
- * Enums
- *********************** */
-var HttpObserveType;
-(function (HttpObserveType) {
-    HttpObserveType["Response"] = "response";
-    HttpObserveType["Body"] = "body";
-    HttpObserveType["Events"] = "events";
-})(HttpObserveType || (exports.HttpObserveType = HttpObserveType = {}));
-/**
- * Type enumeration for the different kinds of `HttpEvent`.
- */
-var HttpEventType;
-(function (HttpEventType) {
-    /**
-     * The request was sent out over the wire.
-     */
-    HttpEventType["Sent"] = "sent";
-    /**
-     * An upload progress event was received.
-     *
-     * Note: The `FetchBackend` doesn't support progress report on uploads.
-     */
-    HttpEventType["UploadProgress"] = "upload-progress";
-    /**
-     * The response status code and headers were received.
-     */
-    HttpEventType["ResponseHeader"] = "response-header";
-    /**
-     * A download progress event was received.
-     */
-    HttpEventType["DownloadProgress"] = "download-progress";
-    /**
-     * The full response including the body was received.
-     */
-    HttpEventType["Response"] = "response";
-    /**
-     * A custom event from an interceptor or a backend.
-     */
-    HttpEventType["Custom"] = "custom";
-})(HttpEventType || (exports.HttpEventType = HttpEventType = {}));