UNPKG

@granito/ngx-hal-client

Version:

A HAL client to be used in Angular projects

112 lines 13.3 kB
import { catchError, map, throwError } from 'rxjs'; import { Accessor, HalError, objectFrom } from './internal'; const self = 'self'; /** * The common base for resource and accessor. */ export class HalBase { /** * The URI of `self` link. */ get self() { return this._links[self]?.href; } /** * This property is `true` when either `methods` array does not exist * in the `self` link or the array exists and contains `POST` string. * It is `false` otherwise. */ get canCreate() { return this.can('POST'); } /** * This property is `true` when either `methods` array does not exist * in the `self` link or the array exists and contains `GET` string. * It is `false` otherwise. */ get canRead() { return this.can('GET'); } /** * This property is `true` when either `methods` array does not exist * in the `self` link or the array exists and contains `DELETE` * string. It is `false` otherwise. */ get canDelete() { return this.can('DELETE'); } /** * @param obj the object used to assign the properties */ constructor(obj) { this._links = {}; this._embedded = {}; Object.assign(this, obj); } /** * Create a new resource in the collection identified by `self` link. * It makes a `POST` call to the URI in `self` link and returns an * observable for the call. The observable normally emits an accessor * for the newly created resource or `undefined` if `Location` header * was not returned by the call. * * @param obj the payload for the `POST` method call * @returns an observable of the resource's accessor */ create(obj) { return this.withSelf(self => this._client.post(self, objectFrom(obj), { observe: 'response' }).pipe(map(response => response.headers.get('Location') || undefined), map(location => !location ? undefined : this.accessor(location)), catchError(this.handleError))); } /** * Delete the resource identified by `self` link. * * @returns an observable that emits next signal on successful delete */ delete() { return this.withSelf(self => this._client.delete(self).pipe(map(() => undefined), catchError(this.handleError))); } withSelf(func) { const self = this.self; if (!self) return throwError(() => new HalError({ message: 'no valid "self" relation' })); return func(self); } accessor(href, methods) { return this.instanceOf(Accessor, { _links: { self: { href, methods } } }); } instanceOf(type, obj) { return new type({ ...obj, _client: this._client }); } handleError(err) { if (err.error instanceof Event) return throwError(() => new HalError({ message: err.message, path: err.url })); return throwError(() => new HalError({ message: err.message, status: err.status, error: err.statusText, path: err.url, ...err.error })); } can(method) { const methods = this._links[self]?.methods; if (!Array.isArray(methods)) return true; return !!methods.find(m => typeof m === 'string' && m.toUpperCase() === method); } } //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"hal-base.js","sourceRoot":"","sources":["../../../../src/lib/hal-base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAc,UAAU,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,MAAM,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE5D,MAAM,IAAI,GAAG,MAAM,CAAC;AAUpB;;GAEG;AACH,MAAM,OAAgB,OAAO;IAOzB;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,YAAY,GAAW;QAzCJ,WAAM,GAAmC,EAAE,CAAC;QAE5C,cAAS,GAAqC,EAAE,CAAC;QAwChE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,GAAQ;QACX,OAAO,IAAI,CAAC,QAAQ,CAChB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC,EAAE;YAC7C,OAAO,EAAE,UAAU;SACtB,CAAC,CAAC,IAAI,CACH,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,SAAS,CAAC,EAC9D,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAChE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAC/B,CACJ,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,MAAM;QACF,OAAO,IAAI,CAAC,QAAQ,CAChB,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAClC,GAAG,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,EACpB,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAC/B,CACJ,CAAC;IACN,CAAC;IAES,QAAQ,CAAI,IAAoC;QACtD,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAEvB,IAAI,CAAC,IAAI;YACL,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC;gBACjC,OAAO,EAAE,0BAA0B;aACtC,CAAC,CAAC,CAAC;QAER,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAES,QAAQ,CAAC,IAAY,EAAE,OAAkB;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;YAC7B,MAAM,EAAE;gBACJ,IAAI,EAAE;oBACF,IAAI;oBACJ,OAAO;iBACV;aACJ;SACJ,CAAC,CAAC;IACP,CAAC;IAES,UAAU,CAAI,IAAa,EAAE,GAAW;QAC9C,OAAO,IAAI,IAAI,CAAC,EAAE,GAAG,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACvD,CAAC;IAES,WAAW,CAAC,GAAsB;QACxC,IAAI,GAAG,CAAC,KAAK,YAAY,KAAK;YAC1B,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC;gBACjC,OAAO,EAAE,GAAG,CAAC,OAAO;gBACpB,IAAI,EAAE,GAAG,CAAC,GAAG;aAChB,CAAC,CAAC,CAAC;QAER,OAAO,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,QAAQ,CAAC;YACjC,OAAO,EAAE,GAAG,CAAC,OAAO;YACpB,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,KAAK,EAAE,GAAG,CAAC,UAAU;YACrB,IAAI,EAAE,GAAG,CAAC,GAAG;YACb,GAAG,GAAG,CAAC,KAAK;SACf,CAAC,CAAC,CAAC;IACR,CAAC;IAES,GAAG,CAAC,MAAc;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;QAE3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;YACvB,OAAO,IAAI,CAAC;QAEhB,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ;YAC5C,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,CAAC;IACpC,CAAC;CACJ","sourcesContent":["import { HttpClient, HttpErrorResponse } from '@angular/common/http';\nimport { Type } from '@angular/core';\nimport { Observable, catchError, map, throwError } from 'rxjs';\nimport { Accessor, HalError, objectFrom } from './internal';\n\nconst self = 'self';\n\ninterface Link {\n    href: string;\n\n    templated?: boolean;\n\n    methods?: string[];\n}\n\n/**\n * The common base for resource and accessor.\n */\nexport abstract class HalBase {\n    protected readonly _client!: HttpClient;\n\n    protected readonly _links: Readonly<Record<string, Link>> = {};\n\n    protected readonly _embedded: Readonly<Record<string, Object>> = {};\n\n    /**\n     * The URI of `self` link.\n     */\n    get self(): string {\n        return this._links[self]?.href;\n    }\n\n    /**\n     * This property is `true` when either `methods` array does not exist\n     * in the `self` link or the array exists and contains `POST` string.\n     * It is `false` otherwise.\n     */\n    get canCreate(): boolean {\n        return this.can('POST');\n    }\n\n    /**\n     * This property is `true` when either `methods` array does not exist\n     * in the `self` link or the array exists and contains `GET` string.\n     * It is `false` otherwise.\n     */\n    get canRead(): boolean {\n        return this.can('GET');\n    }\n\n    /**\n     * This property is `true` when either `methods` array does not exist\n     * in the `self` link or the array exists and contains `DELETE`\n     * string. It is `false` otherwise.\n     */\n    get canDelete(): boolean {\n        return this.can('DELETE');\n    }\n\n    /**\n     * @param obj the object used to assign the properties\n     */\n    constructor(obj: Object) {\n        Object.assign(this, obj);\n    }\n\n    /**\n     * Create a new resource in the collection identified by `self` link.\n     * It makes a `POST` call to the URI in `self` link and returns an\n     * observable for the call. The observable normally emits an accessor\n     * for the newly created resource or `undefined` if `Location` header\n     * was not returned by the call.\n     *\n     * @param obj the payload for the `POST` method call\n     * @returns an observable of the resource's accessor\n     */\n    create(obj: any): Observable<Accessor | undefined> {\n        return this.withSelf(\n            self => this._client.post(self, objectFrom(obj), {\n                observe: 'response'\n            }).pipe(\n                map(response => response.headers.get('Location') || undefined),\n                map(location => !location ? undefined : this.accessor(location)),\n                catchError(this.handleError)\n            )\n        );\n    }\n\n    /**\n     * Delete the resource identified by `self` link.\n     *\n     * @returns an observable that emits next signal on successful delete\n     */\n    delete(): Observable<void> {\n        return this.withSelf(\n            self => this._client.delete(self).pipe(\n                map(() => undefined),\n                catchError(this.handleError)\n            )\n        );\n    }\n\n    protected withSelf<T>(func: (uri: string) => Observable<T>): Observable<T> {\n        const self = this.self;\n\n        if (!self)\n            return throwError(() => new HalError({\n                message: 'no valid \"self\" relation'\n            }));\n\n        return func(self);\n    }\n\n    protected accessor(href: string, methods?: string[]): Accessor {\n        return this.instanceOf(Accessor, {\n            _links: {\n                self: {\n                    href,\n                    methods\n                }\n            }\n        });\n    }\n\n    protected instanceOf<T>(type: Type<T>, obj: Object): T {\n        return new type({ ...obj, _client: this._client });\n    }\n\n    protected handleError(err: HttpErrorResponse): Observable<never> {\n        if (err.error instanceof Event)\n            return throwError(() => new HalError({\n                message: err.message,\n                path: err.url\n            }));\n\n        return throwError(() => new HalError({\n            message: err.message,\n            status: err.status,\n            error: err.statusText,\n            path: err.url,\n            ...err.error\n        }));\n    }\n\n    protected can(method: string): boolean {\n        const methods = this._links[self]?.methods;\n\n        if (!Array.isArray(methods))\n            return true;\n\n        return !!methods.find(m => typeof m === 'string' &&\n            m.toUpperCase() === method);\n    }\n}\n"]}