@opra/client 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Panates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @opra/client
+
+OPRA client package.

package/cjs/client-error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientError = void 0;
+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;
+        }
+    }
+}
+exports.ClientError = ClientError;

package/cjs/client.js

@@ -0,0 +1,96 @@
+"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/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./client.js"), exports);
+tslib_1.__exportStar(require("./response.js"), exports);
+tslib_1.__exportStar(require("./types.js"), exports);
+tslib_1.__exportStar(require("./services/collection-service.js"), exports);
+tslib_1.__exportStar(require("./services/singleton-service.js"), exports);

package/cjs/observable-promise.js

@@ -0,0 +1,10 @@
+"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/package.json

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

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

@@ -0,0 +1,22 @@
+"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

@@ -0,0 +1,14 @@
+"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

@@ -0,0 +1,22 @@
+"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

@@ -0,0 +1,46 @@
+"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

@@ -0,0 +1,14 @@
+"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

@@ -0,0 +1,22 @@
+"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

@@ -0,0 +1,22 @@
+"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/response.js

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

package/cjs/services/collection-service.js

@@ -0,0 +1,192 @@
+"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

@@ -0,0 +1,43 @@
+"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/cjs/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+// export type CollectionCreateRequestOptions = CollectionCreateQueryOptions & CommonRequestOptions;
+// export type CollectionDeleteRequestOptions = CommonRequestOptions;
+// export type CollectionDeleteManyRequestOptions = CollectionDeleteManyQueryOptions & CommonRequestOptions;
+// export type CollectionGetRequestOptions = CollectionGetQueryOptions & CommonRequestOptions;
+// export type CollectionUpdateRequestOptions = CollectionUpdateQueryOptions & CommonRequestOptions;
+// export type CollectionUpdateManyRequestOptions = CollectionUpdateManyQueryOptions & CommonRequestOptions;
+// export type CollectionSearchRequestOptions = CollectionSearchQueryOptions & CommonRequestOptions;
+//
+// export type SingletonGetRequestOptions = SingletonGetQueryOptions & CommonRequestOptions;

package/esm/client-error.d.ts

@@ -0,0 +1,11 @@
+import { ErrorIssue } from '@opra/exception';
+export declare class ClientError extends Error {
+    cause?: Error | undefined;
+    issues: ErrorIssue[];
+    status?: number;
+    constructor(init: {
+        message: string;
+        issues?: ErrorIssue[];
+        status?: number;
+    }, cause?: Error | undefined);
+}

package/esm/client-error.js

@@ -0,0 +1,16 @@
+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/client.d.ts

@@ -0,0 +1,25 @@
+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>;
+}