@opra/client 0.7.0 → 0.8.0

package/cjs/http/utils/merge-raw-http-requests.util.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeRawHttpRequests = void 0;
-const common_1 = require("@opra/common");
-function mergeRawHttpRequests(target, ...other) {
-    let params;
-    const arr = [target, ...other];
-    let headers;
-    for (let i = arr.length - 1; i >= 0; i--) {
-        const o = arr[i];
-        if (o?.headers) {
-            headers = headers || {};
-            Object.assign(headers, (0, common_1.normalizeHeaders)(o.headers));
-        }
-    }
-    for (const o of arr) {
-        if (!o)
-            continue;
-        Object.assign(target, o);
-        if (o?.params) {
-            params = params || new common_1.OpraURLSearchParams();
-            o.params.forEach((v, n) => params?.append(n, v));
-        }
-    }
-    target.headers = headers;
-    target.params = params;
-    return target;
-}
-exports.mergeRawHttpRequests = mergeRawHttpRequests;

package/cjs/index.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./http/http-client.js"), exports);
-tslib_1.__exportStar(require("./http/http-request.js"), exports);
-tslib_1.__exportStar(require("./http/http-response.js"), exports);
-tslib_1.__exportStar(require("./http/http-collection-service.js"), exports);
-tslib_1.__exportStar(require("./http/http-singleton-service.js"), exports);
-tslib_1.__exportStar(require("./http/http-types.js"), exports);
-tslib_1.__exportStar(require("./types.js"), exports);
-tslib_1.__exportStar(require("./client-error.js"), exports);
-tslib_1.__exportStar(require("./http/requests/batch-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-create-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-delete-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-delete-many-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-get-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-search-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-update-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/collection-update-many-request.js"), exports);
-tslib_1.__exportStar(require("./http/requests/http-singleton-get-request.js"), exports);

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

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

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

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

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/types.js

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

package/esm/client-error.js

@@ -1,16 +0,0 @@
-export class ClientError extends Error {
-    cause;
-    issues;
-    status;
-    constructor(init, cause) {
-        super(init.message);
-        this.cause = cause;
-        this.issues = init.issues || [];
-        this.status = init.status;
-        if (cause) {
-            this.cause = cause;
-            if (cause.stack)
-                this.stack = cause.stack;
-        }
-    }
-}

package/esm/constants.js

@@ -1,3 +0,0 @@
-export const JSON_CONTENT_TYPE_PATTERN = /^application\/([\w-]+\+)?\bjson\b/i;
-export const TEXT_CONTENT_TYPE_PATTERN = /^text\/.*$/i;
-export const FORMDATA_CONTENT_TYPE_PATTERN = /^multipart\/\bform-data\b/i;

package/esm/http/http-client.js

@@ -1,160 +0,0 @@
-import { isReadable, isReadableStream, joinPath, OpraDocument } from '@opra/common';
-import { ClientError } from '../client-error.js';
-import { FORMDATA_CONTENT_TYPE_PATTERN, JSON_CONTENT_TYPE_PATTERN, TEXT_CONTENT_TYPE_PATTERN } from '../constants.js';
-import { HttpCollectionService } from './http-collection-service.js';
-import { HttpSingletonService } from './http-singleton-service.js';
-import { BatchRequest } from './requests/batch-request.js';
-import { mergeRawHttpRequests } from './utils/merge-raw-http-requests.util.js';
-const documentCache = new Map();
-const documentResolverCaches = new Map();
-export class OpraHttpClient {
-    _serviceUrl;
-    _metadata;
-    defaults;
-    constructor(serviceUrl, options) {
-        this._serviceUrl = serviceUrl;
-        this._metadata = options?.document;
-        if (!this._metadata) {
-            const document = documentCache.get(this.serviceUrl.toLowerCase());
-            if (document)
-                this._metadata = document;
-        }
-        this.defaults = options?.defaults || {};
-    }
-    get serviceUrl() {
-        return this._serviceUrl;
-    }
-    get initialized() {
-        return !!this._metadata;
-    }
-    get metadata() {
-        this._assertMetadata();
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        return this._metadata;
-    }
-    async init(forceRefresh) {
-        if (!forceRefresh && this.initialized)
-            return;
-        const cacheName = this.serviceUrl.toLowerCase();
-        let promise = documentResolverCaches.get(cacheName);
-        if (promise) {
-            await promise;
-            return;
-        }
-        promise = this._resolveMetadata();
-        documentResolverCaches.set(cacheName, promise);
-        return promise
-            .catch(() => void 0)
-            .finally(() => documentResolverCaches.delete(cacheName));
-    }
-    batch(requests) {
-        this._assertMetadata();
-        return new BatchRequest(req => this._handleRequest(req), requests);
-    }
-    collection(name) {
-        this._assertMetadata();
-        // If name argument is a class, we extract name from the class
-        if (typeof name === 'function')
-            name = name.name;
-        const resource = this.metadata.getCollectionResource(name);
-        return new HttpCollectionService(resource, req => this._handleRequest(req));
-    }
-    singleton(name) {
-        this._assertMetadata();
-        // If name argument is a class, we extract name from the class
-        if (typeof name === 'function')
-            name = name.name;
-        const resource = this.metadata.getSingletonResource(name);
-        return new HttpSingletonService(resource, req => this._handleRequest(req));
-    }
-    async _resolveMetadata() {
-        const resp = await this._handleRequest({
-            method: 'GET',
-            path: '/$metadata',
-            headers: { 'accept': 'application/json' }
-        });
-        this._metadata = new OpraDocument(resp.data);
-    }
-    async _handleRequest(req) {
-        mergeRawHttpRequests(req, this.defaults);
-        let url = joinPath(this.serviceUrl, req.path);
-        if (req.params)
-            url += '?' + req.params.toString();
-        if (req.body) {
-            if (typeof req.body === 'object') {
-                if (!(isReadable(req.body) || isReadableStream(req.body) || Buffer.isBuffer(req.body))) {
-                    if (!req.headers?.['content-type']) {
-                        req.headers = req.headers || {};
-                        req.headers['content-type'] = 'application/json';
-                    }
-                    req.body = JSON.stringify(req.body);
-                }
-            }
-        }
-        return this._fetch(url, req);
-    }
-    async _fetch(url, req) {
-        const resp = await fetch(url, req);
-        let data;
-        if (resp.body) {
-            if (JSON_CONTENT_TYPE_PATTERN.test(resp.headers.get('Content-Type') || '')) {
-                data = await resp.json();
-                if (typeof data === 'string')
-                    data = JSON.parse(data);
-            }
-            else if (TEXT_CONTENT_TYPE_PATTERN.test(resp.headers.get('Content-Type') || ''))
-                data = await resp.text();
-            else if (FORMDATA_CONTENT_TYPE_PATTERN.test(resp.headers.get('Content-Type') || ''))
-                data = await resp.formData();
-            else
-                data = await resp.arrayBuffer();
-        }
-        if (resp.status >= 400 && resp.status < 600) {
-            throw new ClientError({
-                message: resp.status + ' ' + resp.statusText,
-                status: resp.status,
-                issues: data?.errors
-            });
-        }
-        const out = {
-            get headers() {
-                return resp.headers;
-            },
-            get ok() {
-                return resp.ok;
-            },
-            get redirected() {
-                return resp.redirected;
-            },
-            get status() {
-                return resp.status;
-            },
-            get statusText() {
-                return resp.statusText;
-            },
-            get type() {
-                return resp.type;
-            },
-            get url() {
-                return resp.url;
-            },
-            get contentId() {
-                return resp.headers.get('Content-ID');
-            },
-            get data() {
-                return data;
-            }
-        };
-        return out;
-    }
-    _assertMetadata() {
-        if (!this._metadata)
-            throw new Error('You must call init() to before using the client instance');
-    }
-    static async create(serviceUrl, options) {
-        const client = new this(serviceUrl, options);
-        if (!client._metadata)
-            await client.init();
-        return client;
-    }
-}

package/esm/http/http-collection-service.js

@@ -1,36 +0,0 @@
-import { CollectionCreateRequest } from './requests/collection-create-request.js';
-import { CollectionDeleteManyRequest } from './requests/collection-delete-many-request.js';
-import { CollectionDeleteRequest } from './requests/collection-delete-request.js';
-import { CollectionGetRequest } from './requests/collection-get-request.js';
-import { CollectionSearchRequest } from './requests/collection-search-request.js';
-import { CollectionUpdateManyRequest } from './requests/collection-update-many-request.js';
-import { CollectionUpdateRequest } from './requests/collection-update-request.js';
-export class HttpCollectionService {
-    resource;
-    _handler;
-    constructor(resource, _handler) {
-        this.resource = resource;
-        this._handler = _handler;
-    }
-    create(data, options) {
-        return new CollectionCreateRequest(this._handler, this.resource, data, options);
-    }
-    delete(keyValue, options) {
-        return new CollectionDeleteRequest(this._handler, this.resource, keyValue, options);
-    }
-    deleteMany(options) {
-        return new CollectionDeleteManyRequest(this._handler, this.resource, options);
-    }
-    get(keyValue, options) {
-        return new CollectionGetRequest(this._handler, this.resource, keyValue, options);
-    }
-    search(options) {
-        return new CollectionSearchRequest(this._handler, this.resource, options);
-    }
-    update(keyValue, data, options) {
-        return new CollectionUpdateRequest(this._handler, this.resource, keyValue, data, options);
-    }
-    updateMany(data, options) {
-        return new CollectionUpdateManyRequest(this._handler, this.resource, data, options);
-    }
-}

package/esm/http/http-request.js

@@ -1,62 +0,0 @@
-import { Observable } from 'rxjs';
-import { uid } from '@opra/common';
-export class HttpRequest extends Observable {
-    _handler;
-    options;
-    contentId;
-    _promise;
-    _headers;
-    constructor(_handler, options = {}) {
-        super((subscriber) => {
-            if (options.observe === 'response') {
-                this.fetch().then(v => {
-                    subscriber.next(v);
-                    subscriber.complete();
-                }).catch(e => subscriber.error(e));
-                return;
-            }
-            this.resolve().then(v => {
-                subscriber.next(v);
-                subscriber.complete();
-            }).catch(e => subscriber.error(e));
-        });
-        this._handler = _handler;
-        this.options = options;
-        this.contentId = uid(6);
-        this.options = options;
-    }
-    header(name, value) {
-        this._headers = this._headers || {};
-        this._headers[name] = value;
-        return this;
-    }
-    /**
-     * Sends the request
-     */
-    async fetch() {
-        const promise = this._promise || (this._promise = new Promise((resolve, reject) => {
-            setTimeout(() => {
-                this._execute().then(resolve).catch(reject);
-            }, 0);
-        }));
-        return await promise;
-    }
-    /**
-     * Sends the request and returns response data
-     */
-    async resolve() {
-        const resp = await this.fetch();
-        return resp.data;
-    }
-    with(cb) {
-        cb(this);
-        return this;
-    }
-    binding() {
-        return {};
-    }
-    async _execute() {
-        const req = this.prepare();
-        return await this._handler(req);
-    }
-}

package/esm/http/http-response.js

@@ -1 +0,0 @@
-export {};

package/esm/http/http-singleton-service.js

@@ -1,12 +0,0 @@
-import { HttpSingletonGetRequest } from './requests/http-singleton-get-request.js';
-export class HttpSingletonService {
-    resource;
-    _handler;
-    constructor(resource, _handler) {
-        this.resource = resource;
-        this._handler = _handler;
-    }
-    get(options) {
-        return new HttpSingletonGetRequest(this._handler, this.resource, options);
-    }
-}

package/esm/http/http-types.js

@@ -1 +0,0 @@
-export {};

package/esm/http/requests/batch-request.js

@@ -1,76 +0,0 @@
-import { BatchMultipart } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class BatchRequest extends HttpRequest {
-    _handler;
-    requests;
-    options;
-    _results = new WeakMap();
-    _listeners = new Set();
-    constructor(_handler, requests, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.requests = requests;
-        this.options = options;
-        requests.forEach(request => {
-            // Overwrite the _execute method
-            Object.defineProperty(request, '_execute', {
-                writable: true,
-                enumerable: false,
-                configurable: true,
-                value: () => {
-                    return new Promise((resolve, reject) => {
-                        const x = this._results.get(request);
-                        if (x) {
-                            if (x.error)
-                                return reject(x.error);
-                            return resolve(x.response);
-                        }
-                        const callback = (error, response) => {
-                            this._listeners.delete(callback);
-                            if (error)
-                                return reject(error);
-                            resolve(response);
-                        };
-                        this._listeners.add(callback);
-                    });
-                }
-            });
-        });
-    }
-    prepare() {
-        const batch = this._buildBatchMultipart(this);
-        const headers = {
-            'content-type': 'multipart/mixed;boundary=' + batch.boundary
-        };
-        return mergeRawHttpRequests({
-            method: 'POST',
-            path: '/$batch',
-            headers,
-            body: batch.stream()
-        }, this.options.http);
-    }
-    _buildBatchMultipart(batch) {
-        const multipart = new BatchMultipart();
-        for (const req of batch.requests) {
-            const prepared = req.prepare();
-            if (req instanceof BatchRequest) {
-                const subMultipart = this._buildBatchMultipart(req);
-                multipart.addBatch(subMultipart);
-                continue;
-            }
-            multipart.addRequestPart({
-                method: prepared.method,
-                url: prepared.path,
-                headers: prepared.headers,
-                data: prepared.body
-            });
-        }
-        return multipart;
-    }
-    async _execute() {
-        const req = this.prepare();
-        const resp = await this._handler(req);
-        return resp;
-    }
-}

package/esm/http/requests/collection-create-request.js

@@ -1,31 +0,0 @@
-import { OpraURLSearchParams } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionCreateRequest extends HttpRequest {
-    _handler;
-    resource;
-    data;
-    options;
-    constructor(_handler, resource, data, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.data = data;
-        this.options = options;
-    }
-    prepare() {
-        const searchParams = new OpraURLSearchParams();
-        if (this.options.include)
-            searchParams.set('$include', this.options.include);
-        if (this.options.pick)
-            searchParams.set('$pick', this.options.pick);
-        if (this.options.omit)
-            searchParams.set('$omit', this.options.omit);
-        return mergeRawHttpRequests({
-            method: 'POST',
-            path: this.resource.name,
-            params: searchParams,
-            body: this.data,
-        }, this.options.http);
-    }
-}

package/esm/http/requests/collection-delete-many-request.js

@@ -1,24 +0,0 @@
-import { OpraURLSearchParams, } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionDeleteManyRequest extends HttpRequest {
-    _handler;
-    resource;
-    options;
-    constructor(_handler, resource, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.options = options;
-    }
-    prepare() {
-        const searchParams = new OpraURLSearchParams();
-        if (this.options.filter)
-            searchParams.set('$filter', this.options.filter);
-        return mergeRawHttpRequests({
-            method: 'DELETE',
-            path: this.resource.name,
-            params: searchParams,
-        }, this.options.http);
-    }
-}

package/esm/http/requests/collection-delete-request.js

@@ -1,25 +0,0 @@
-import { OpraURLPath } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionDeleteRequest extends HttpRequest {
-    _handler;
-    resource;
-    keyValue;
-    options;
-    constructor(_handler, resource, keyValue, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.keyValue = keyValue;
-        this.options = options;
-    }
-    prepare() {
-        if (this.keyValue == null || this.keyValue === '')
-            throw new TypeError('Key value required to perform "delete" request');
-        const path = new OpraURLPath({ resource: this.resource.name, key: this.keyValue });
-        return mergeRawHttpRequests({
-            method: 'DELETE',
-            path: path.toString(),
-        }, this.options.http);
-    }
-}

package/esm/http/requests/collection-get-request.js

@@ -1,33 +0,0 @@
-import { OpraURLPath, OpraURLSearchParams, } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionGetRequest extends HttpRequest {
-    _handler;
-    resource;
-    keyValue;
-    options;
-    constructor(_handler, resource, keyValue, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.keyValue = keyValue;
-        this.options = options;
-    }
-    prepare() {
-        if (this.keyValue == null || this.keyValue === '')
-            throw new TypeError('Key value required to perform "get" request');
-        const path = new OpraURLPath({ resource: this.resource.name, key: this.keyValue });
-        const searchParams = new OpraURLSearchParams();
-        if (this.options.include)
-            searchParams.set('$include', this.options.include);
-        if (this.options.pick)
-            searchParams.set('$pick', this.options.pick);
-        if (this.options.omit)
-            searchParams.set('$omit', this.options.omit);
-        return mergeRawHttpRequests({
-            method: 'GET',
-            path: path.toString(),
-            params: searchParams
-        }, this.options.http);
-    }
-}

package/esm/http/requests/collection-search-request.js

@@ -1,40 +0,0 @@
-import { OpraURLSearchParams, } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionSearchRequest extends HttpRequest {
-    _handler;
-    resource;
-    options;
-    constructor(_handler, resource, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.options = options;
-    }
-    prepare() {
-        const searchParams = new OpraURLSearchParams();
-        if (this.options.include)
-            searchParams.set('$include', this.options.include);
-        if (this.options.pick)
-            searchParams.set('$pick', this.options.pick);
-        if (this.options.omit)
-            searchParams.set('$omit', this.options.omit);
-        if (this.options.sort)
-            searchParams.set('$sort', this.options.sort);
-        if (this.options.filter)
-            searchParams.set('$filter', this.options.filter);
-        if (this.options.limit != null)
-            searchParams.set('$limit', this.options.limit);
-        if (this.options.skip != null)
-            searchParams.set('$skip', this.options.skip);
-        if (this.options.count != null)
-            searchParams.set('$count', this.options.count);
-        if (this.options.distinct != null)
-            searchParams.set('$distinct', this.options.distinct);
-        return mergeRawHttpRequests({
-            method: 'GET',
-            path: this.resource.name,
-            params: searchParams
-        }, this.options.http);
-    }
-}

package/esm/http/requests/collection-update-many-request.js

@@ -1,27 +0,0 @@
-import { OpraURLSearchParams, } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionUpdateManyRequest extends HttpRequest {
-    _handler;
-    resource;
-    data;
-    options;
-    constructor(_handler, resource, data, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.data = data;
-        this.options = options;
-    }
-    prepare() {
-        const searchParams = new OpraURLSearchParams();
-        if (this.options.filter)
-            searchParams.set('$filter', this.options.filter);
-        return mergeRawHttpRequests({
-            method: 'PATCH',
-            path: this.resource.name,
-            params: searchParams,
-            body: this.data
-        }, this.options.http);
-    }
-}

package/esm/http/requests/collection-update-request.js

@@ -1,36 +0,0 @@
-import { OpraURLPath, OpraURLSearchParams, } from '@opra/common';
-import { HttpRequest } from '../http-request.js';
-import { mergeRawHttpRequests } from '../utils/merge-raw-http-requests.util.js';
-export class CollectionUpdateRequest extends HttpRequest {
-    _handler;
-    resource;
-    keyValue;
-    data;
-    options;
-    constructor(_handler, resource, keyValue, data, options = {}) {
-        super(_handler, options);
-        this._handler = _handler;
-        this.resource = resource;
-        this.keyValue = keyValue;
-        this.data = data;
-        this.options = options;
-    }
-    prepare() {
-        if (this.keyValue == null || this.keyValue === '')
-            throw new TypeError('Key value required to perform "get" request');
-        const path = new OpraURLPath({ resource: this.resource.name, key: this.keyValue });
-        const searchParams = new OpraURLSearchParams();
-        if (this.options.include)
-            searchParams.set('$include', this.options.include);
-        if (this.options.pick)
-            searchParams.set('$pick', this.options.pick);
-        if (this.options.omit)
-            searchParams.set('$omit', this.options.omit);
-        return mergeRawHttpRequests({
-            method: 'PATCH',
-            path: path.toString(),
-            params: searchParams,
-            body: this.data
-        }, this.options.http);
-    }
-}