@opra/client 0.4.0 → 0.6.0

package/cjs/client.js

@@ -1,96 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpraClient = void 0;
-const tslib_1 = require("tslib");
-const axios_1 = tslib_1.__importDefault(require("axios"));
-const common_1 = require("@opra/common");
-const schema_1 = require("@opra/schema");
-const url_1 = require("@opra/url");
-const client_error_js_1 = require("./client-error.js");
-const collection_service_js_1 = require("./services/collection-service.js");
-const singleton_service_js_1 = require("./services/singleton-service.js");
-class OpraClient {
-    serviceUrl;
-    options;
-    _metadata;
-    constructor(serviceUrl, options) {
-        this.options = { ...options };
-        this.serviceUrl = (0, url_1.normalizePath)(serviceUrl);
-    }
-    get metadata() {
-        return this._metadata;
-    }
-    collection(name, options) {
-        const resource = this.metadata.getCollectionResource(name);
-        const commonOptions = {
-            headers: this.options.defaultHeaders,
-            validateStatus: this.options.validateStatus,
-            ...options,
-        };
-        return new collection_service_js_1.CollectionService(this.serviceUrl, this.metadata, (req) => this._send(req, commonOptions), resource);
-    }
-    singleton(name, options) {
-        const resource = this.metadata.getSingletonResource(name);
-        const commonOptions = {
-            headers: this.options.defaultHeaders,
-            validateStatus: this.options.validateStatus,
-            ...options,
-        };
-        return new singleton_service_js_1.SingletonService(this.serviceUrl, this.metadata, (req) => this._send(req, commonOptions), resource);
-    }
-    async _send(req, options) {
-        const axiosInstance = this._createAxiosInstance(options);
-        const resp = await axiosInstance.request({ ...req, validateStatus: undefined });
-        const validateStatus = options?.validateStatus;
-        if ((validateStatus === true && !(resp.status >= 200 && resp.status < 300)) ||
-            (typeof validateStatus === 'function' && !validateStatus(resp.status))) {
-            throw new client_error_js_1.ClientError({
-                message: resp.statusText,
-                status: resp.status,
-                issues: resp.data.errors
-            });
-        }
-        const rawHeaders = (typeof resp.headers.toJSON === 'function'
-            ? resp.headers.toJSON()
-            : { ...resp.headers });
-        const headers = new common_1.ResponsiveMap(rawHeaders);
-        return {
-            status: resp.status,
-            statusText: resp.statusText,
-            data: resp.data,
-            rawHeaders,
-            headers
-        };
-    }
-    _createAxiosInstance(options) {
-        const axiosInstance = axios_1.default.create();
-        axiosInstance.defaults.adapter = this.options.adapter;
-        axiosInstance.defaults.headers.common = { ...options?.headers, ...this.options.defaultHeaders };
-        if (options?.validateStatus != null) {
-            if (options.validateStatus === false)
-                axiosInstance.defaults.validateStatus = () => true;
-            else if (typeof options.validateStatus === 'function')
-                axiosInstance.defaults.validateStatus = options.validateStatus;
-        }
-        else if (this.options.validateStatus != null) {
-            if (this.options.validateStatus === false)
-                axiosInstance.defaults.validateStatus = () => true;
-            else if (typeof this.options.validateStatus === 'function')
-                axiosInstance.defaults.validateStatus = this.options.validateStatus;
-        }
-        return axiosInstance;
-    }
-    async _fetchMetadata() {
-        const resp = await this._send({
-            method: 'GET',
-            url: (0, url_1.joinPath)(this.serviceUrl || '/', '$metadata'),
-        }, { validateStatus: true });
-        this._metadata = new schema_1.OpraDocument(resp.data);
-    }
-    static async create(serviceUrl, options) {
-        const client = new this(serviceUrl, options);
-        await client._fetchMetadata();
-        return client;
-    }
-}
-exports.OpraClient = OpraClient;

package/cjs/observable-promise.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.observablePromise = void 0;
-const rxjs_1 = require("rxjs");
-function observablePromise(promise) {
-    const observable = (0, rxjs_1.from)(promise);
-    observable.then = (...args) => promise.then(...args);
-    return observable;
-}
-exports.observablePromise = observablePromise;

package/cjs/requests/collection-create-request.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionCreateRequest = void 0;
-class CollectionCreateRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    omit(...fields) {
-        this._options.omit = fields.flat();
-        return this;
-    }
-    pick(...fields) {
-        this._options.pick = fields.flat();
-        return this;
-    }
-    include(...fields) {
-        this._options.include = fields.flat();
-        return this;
-    }
-}
-exports.CollectionCreateRequest = CollectionCreateRequest;

package/cjs/requests/collection-delete-many-request.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionDeleteManyRequest = void 0;
-class CollectionDeleteManyRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    filter(value) {
-        this._options.filter = value;
-        return this;
-    }
-}
-exports.CollectionDeleteManyRequest = CollectionDeleteManyRequest;

package/cjs/requests/collection-get-request.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionGetRequest = void 0;
-class CollectionGetRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    omit(...fields) {
-        this._options.omit = fields.flat();
-        return this;
-    }
-    pick(...fields) {
-        this._options.pick = fields.flat();
-        return this;
-    }
-    include(...fields) {
-        this._options.include = fields.flat();
-        return this;
-    }
-}
-exports.CollectionGetRequest = CollectionGetRequest;

package/cjs/requests/collection-search-request.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionSearchRequest = void 0;
-class CollectionSearchRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    omit(...fields) {
-        this._options.omit = fields.flat();
-        return this;
-    }
-    pick(...fields) {
-        this._options.pick = fields.flat();
-        return this;
-    }
-    include(...fields) {
-        this._options.include = fields.flat();
-        return this;
-    }
-    limit(value) {
-        this._options.limit = value;
-        return this;
-    }
-    skip(value) {
-        this._options.skip = value;
-        return this;
-    }
-    count(value = true) {
-        this._options.count = value;
-        return this;
-    }
-    distinct(value) {
-        this._options.distinct = value;
-        return this;
-    }
-    sort(...fields) {
-        this._options.sort = fields.flat();
-        return this;
-    }
-    filter(value) {
-        this._options.filter = value;
-        return this;
-    }
-}
-exports.CollectionSearchRequest = CollectionSearchRequest;

package/cjs/requests/collection-update-many-request.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionUpdateManyRequest = void 0;
-class CollectionUpdateManyRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    filter(value) {
-        this._options.filter = value;
-        return this;
-    }
-}
-exports.CollectionUpdateManyRequest = CollectionUpdateManyRequest;

package/cjs/requests/collection-update-request.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionUpdateRequest = void 0;
-class CollectionUpdateRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    omit(...fields) {
-        this._options.omit = fields.flat();
-        return this;
-    }
-    pick(...fields) {
-        this._options.pick = fields.flat();
-        return this;
-    }
-    include(...fields) {
-        this._options.include = fields.flat();
-        return this;
-    }
-}
-exports.CollectionUpdateRequest = CollectionUpdateRequest;

package/cjs/requests/singleton-get-request.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SingletonGetRequest = void 0;
-class SingletonGetRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    omit(...fields) {
-        this._options.omit = fields.flat();
-        return this;
-    }
-    pick(...fields) {
-        this._options.pick = fields.flat();
-        return this;
-    }
-    include(...fields) {
-        this._options.include = fields.flat();
-        return this;
-    }
-}
-exports.SingletonGetRequest = SingletonGetRequest;

package/cjs/services/collection-service.js

@@ -1,192 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CollectionService = void 0;
-const url_1 = require("@opra/url");
-const observable_promise_js_1 = require("../observable-promise.js");
-const collection_create_request_js_1 = require("../requests/collection-create-request.js");
-const collection_delete_many_request_js_1 = require("../requests/collection-delete-many-request.js");
-const collection_get_request_js_1 = require("../requests/collection-get-request.js");
-const collection_search_request_js_1 = require("../requests/collection-search-request.js");
-const collection_update_many_request_js_1 = require("../requests/collection-update-many-request.js");
-const collection_update_request_js_1 = require("../requests/collection-update-request.js");
-class CollectionService {
-    _serviceUrl;
-    _document;
-    _handler;
-    _resource;
-    constructor(_serviceUrl, _document, _handler, _resource) {
-        this._serviceUrl = _serviceUrl;
-        this._document = _document;
-        this._handler = _handler;
-        this._resource = _resource;
-    }
-    create(data, options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new collection_create_request_js_1.CollectionCreateRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareCreateRequest(data, requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    delete(keyValue) {
-        const req = this._prepareDeleteRequest(keyValue);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    deleteMany(options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new collection_delete_many_request_js_1.CollectionDeleteManyRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareDeleteManyRequest(requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    get(keyValue, options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new collection_get_request_js_1.CollectionGetRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareGetRequest(keyValue, requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    search(options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new collection_search_request_js_1.CollectionSearchRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareSearchRequest(requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    update(keyValue, data, options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new collection_update_request_js_1.CollectionUpdateRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareUpdateRequest(keyValue, data, requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    updateMany(data, options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new collection_update_many_request_js_1.CollectionUpdateManyRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareUpdateManyRequest(data, requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    _prepareCreateRequest(data, options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        if (options.include)
-            url.searchParams.set('$include', options.include);
-        if (options.pick)
-            url.searchParams.set('$pick', options.pick);
-        if (options.omit)
-            url.searchParams.set('$omit', options.omit);
-        return {
-            method: 'POST',
-            url: url.address,
-            data,
-            params: url.searchParams
-        };
-    }
-    _prepareDeleteRequest(keyValue) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        url.path.get(url.path.size - 1).key = keyValue;
-        return {
-            method: 'DELETE',
-            url: url.address,
-            params: url.searchParams
-        };
-    }
-    _prepareDeleteManyRequest(options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        if (options.filter)
-            url.searchParams.set('$filter', options.filter);
-        return {
-            method: 'DELETE',
-            url: url.address,
-            params: url.searchParams
-        };
-    }
-    _prepareGetRequest(keyValue, options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        url.path.get(url.path.size - 1).key = keyValue;
-        if (options.include)
-            url.searchParams.set('$include', options.include);
-        if (options.pick)
-            url.searchParams.set('$pick', options.pick);
-        if (options.omit)
-            url.searchParams.set('$omit', options.omit);
-        return {
-            method: 'GET',
-            url: url.address,
-            params: url.searchParams
-        };
-    }
-    _prepareSearchRequest(options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        if (options.include)
-            url.searchParams.set('$include', options.include);
-        if (options.pick)
-            url.searchParams.set('$pick', options.pick);
-        if (options.omit)
-            url.searchParams.set('$omit', options.omit);
-        if (options.sort)
-            url.searchParams.set('$sort', options.sort);
-        if (options.filter)
-            url.searchParams.set('$filter', options.filter);
-        if (options.limit != null)
-            url.searchParams.set('$limit', options.limit);
-        if (options.skip != null)
-            url.searchParams.set('$skip', options.skip);
-        if (options.count != null)
-            url.searchParams.set('$count', options.count);
-        if (options.distinct != null)
-            url.searchParams.set('$distinct', options.distinct);
-        return {
-            method: 'GET',
-            url: url.address,
-            params: url.searchParams
-        };
-    }
-    _prepareUpdateRequest(keyValue, data, options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        url.path.get(url.path.size - 1).key = keyValue;
-        if (options.include)
-            url.searchParams.set('$include', options.include);
-        if (options.pick)
-            url.searchParams.set('$pick', options.pick);
-        if (options.omit)
-            url.searchParams.set('$omit', options.omit);
-        return {
-            method: 'PATCH',
-            url: url.address,
-            data,
-            params: url.searchParams
-        };
-    }
-    _prepareUpdateManyRequest(data, options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        if (options.filter)
-            url.searchParams.set('$filter', options.filter);
-        return {
-            method: 'PATCH',
-            url: url.address,
-            data,
-            params: url.searchParams
-        };
-    }
-}
-exports.CollectionService = CollectionService;

package/cjs/services/singleton-service.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SingletonService = void 0;
-const url_1 = require("@opra/url");
-const observable_promise_js_1 = require("../observable-promise.js");
-const singleton_get_request_js_1 = require("../requests/singleton-get-request.js");
-class SingletonService {
-    _serviceUrl;
-    _document;
-    _handler;
-    _resource;
-    constructor(_serviceUrl, _document, _handler, _resource) {
-        this._serviceUrl = _serviceUrl;
-        this._document = _document;
-        this._handler = _handler;
-        this._resource = _resource;
-    }
-    get(options) {
-        const requestOptions = options && typeof options === 'object' ? options : {};
-        const requestWrapper = new singleton_get_request_js_1.SingletonGetRequest(requestOptions);
-        if (typeof options === 'function')
-            options(requestWrapper);
-        const req = this._prepareGetRequest(requestOptions);
-        const promise = this._handler(req);
-        return (0, observable_promise_js_1.observablePromise)(promise);
-    }
-    _prepareGetRequest(options) {
-        const url = new url_1.OpraURL(this._serviceUrl);
-        url.path.join(this._resource.name);
-        if (options.include)
-            url.searchParams.set('$include', options.include);
-        if (options.pick)
-            url.searchParams.set('$pick', options.pick);
-        if (options.omit)
-            url.searchParams.set('$omit', options.omit);
-        return {
-            method: 'GET',
-            url: url.address,
-            params: url.searchParams
-        };
-    }
-}
-exports.SingletonService = SingletonService;

package/esm/client.d.ts

@@ -1,25 +0,0 @@
-import { AxiosAdapter, AxiosInstance, AxiosRequestConfig } from 'axios';
-import { OpraDocument } from '@opra/schema';
-import { OpraResponse } from './response.js';
-import { CollectionService } from './services/collection-service.js';
-import { SingletonService } from './services/singleton-service.js';
-import { CommonRequestOptions } from './types.js';
-export interface OpraClientOptions {
-    adapter?: AxiosAdapter;
-    resetCache?: boolean;
-    defaultHeaders?: Record<string, string>;
-    validateStatus?: boolean | ((status: number) => boolean);
-}
-export declare class OpraClient {
-    serviceUrl: string;
-    options: OpraClientOptions;
-    protected _metadata: OpraDocument;
-    protected constructor(serviceUrl: string, options?: OpraClientOptions);
-    get metadata(): OpraDocument;
-    collection<T = any, TResponse extends OpraResponse<T> = OpraResponse<T>>(name: string, options?: CommonRequestOptions): CollectionService<T, TResponse>;
-    singleton<T = any, TResponse extends OpraResponse<T> = OpraResponse<T>>(name: string, options?: CommonRequestOptions): SingletonService<T, TResponse>;
-    protected _send(req: AxiosRequestConfig, options?: CommonRequestOptions): Promise<OpraResponse>;
-    protected _createAxiosInstance(options?: CommonRequestOptions): AxiosInstance;
-    protected _fetchMetadata(): Promise<void>;
-    static create(serviceUrl: string, options?: OpraClientOptions): Promise<OpraClient>;
-}

package/esm/client.js

@@ -1,91 +0,0 @@
-import axios from 'axios';
-import { ResponsiveMap } from '@opra/common';
-import { OpraDocument } from '@opra/schema';
-import { joinPath, normalizePath } from '@opra/url';
-import { ClientError } from './client-error.js';
-import { CollectionService } from './services/collection-service.js';
-import { SingletonService } from './services/singleton-service.js';
-export class OpraClient {
-    serviceUrl;
-    options;
-    _metadata;
-    constructor(serviceUrl, options) {
-        this.options = { ...options };
-        this.serviceUrl = normalizePath(serviceUrl);
-    }
-    get metadata() {
-        return this._metadata;
-    }
-    collection(name, options) {
-        const resource = this.metadata.getCollectionResource(name);
-        const commonOptions = {
-            headers: this.options.defaultHeaders,
-            validateStatus: this.options.validateStatus,
-            ...options,
-        };
-        return new CollectionService(this.serviceUrl, this.metadata, (req) => this._send(req, commonOptions), resource);
-    }
-    singleton(name, options) {
-        const resource = this.metadata.getSingletonResource(name);
-        const commonOptions = {
-            headers: this.options.defaultHeaders,
-            validateStatus: this.options.validateStatus,
-            ...options,
-        };
-        return new SingletonService(this.serviceUrl, this.metadata, (req) => this._send(req, commonOptions), resource);
-    }
-    async _send(req, options) {
-        const axiosInstance = this._createAxiosInstance(options);
-        const resp = await axiosInstance.request({ ...req, validateStatus: undefined });
-        const validateStatus = options?.validateStatus;
-        if ((validateStatus === true && !(resp.status >= 200 && resp.status < 300)) ||
-            (typeof validateStatus === 'function' && !validateStatus(resp.status))) {
-            throw new ClientError({
-                message: resp.statusText,
-                status: resp.status,
-                issues: resp.data.errors
-            });
-        }
-        const rawHeaders = (typeof resp.headers.toJSON === 'function'
-            ? resp.headers.toJSON()
-            : { ...resp.headers });
-        const headers = new ResponsiveMap(rawHeaders);
-        return {
-            status: resp.status,
-            statusText: resp.statusText,
-            data: resp.data,
-            rawHeaders,
-            headers
-        };
-    }
-    _createAxiosInstance(options) {
-        const axiosInstance = axios.create();
-        axiosInstance.defaults.adapter = this.options.adapter;
-        axiosInstance.defaults.headers.common = { ...options?.headers, ...this.options.defaultHeaders };
-        if (options?.validateStatus != null) {
-            if (options.validateStatus === false)
-                axiosInstance.defaults.validateStatus = () => true;
-            else if (typeof options.validateStatus === 'function')
-                axiosInstance.defaults.validateStatus = options.validateStatus;
-        }
-        else if (this.options.validateStatus != null) {
-            if (this.options.validateStatus === false)
-                axiosInstance.defaults.validateStatus = () => true;
-            else if (typeof this.options.validateStatus === 'function')
-                axiosInstance.defaults.validateStatus = this.options.validateStatus;
-        }
-        return axiosInstance;
-    }
-    async _fetchMetadata() {
-        const resp = await this._send({
-            method: 'GET',
-            url: joinPath(this.serviceUrl || '/', '$metadata'),
-        }, { validateStatus: true });
-        this._metadata = new OpraDocument(resp.data);
-    }
-    static async create(serviceUrl, options) {
-        const client = new this(serviceUrl, options);
-        await client._fetchMetadata();
-        return client;
-    }
-}

package/esm/observable-promise.d.ts

@@ -1,2 +0,0 @@
-import { ObservablePromiseLike } from './types.js';
-export declare function observablePromise<T>(promise: Promise<T>): ObservablePromiseLike<T>;

package/esm/observable-promise.js

@@ -1,6 +0,0 @@
-import { from } from 'rxjs';
-export function observablePromise(promise) {
-    const observable = from(promise);
-    observable.then = (...args) => promise.then(...args);
-    return observable;
-}

package/esm/requests/collection-create-request.d.ts

@@ -1,8 +0,0 @@
-import { CollectionCreateQueryOptions } from '@opra/schema';
-export declare class CollectionCreateRequest {
-    protected _options: CollectionCreateQueryOptions;
-    constructor(_options?: CollectionCreateQueryOptions);
-    omit(...fields: (string | string[])[]): this;
-    pick(...fields: (string | string[])[]): this;
-    include(...fields: (string | string[])[]): this;
-}

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

@@ -1,18 +0,0 @@
-export class CollectionCreateRequest {
-    _options;
-    constructor(_options = {}) {
-        this._options = _options;
-    }
-    omit(...fields) {
-        this._options.omit = fields.flat();
-        return this;
-    }
-    pick(...fields) {
-        this._options.pick = fields.flat();
-        return this;
-    }
-    include(...fields) {
-        this._options.include = fields.flat();
-        return this;
-    }
-}