@granito/ngx-hal-client
Version:
A HAL client to be used in Angular projects
95 lines • 11.7 kB
JavaScript
import { catchError, map } from 'rxjs';
import * as URI from 'uri-template';
import { HalBase, objectFrom } from './internal';
/**
* This class repesents an in-memory instance of a HAL resource.
*/
export class Resource extends HalBase {
/**
* This property is `true` when either `methods` array does not exist
* in the `self` link or the array exists and contains `PUT` string.
* It is `false` otherwise.
*/
get canUpdate() {
return this.can('PUT');
}
/**
* Follow the relation link. Returns an accessor for the resource
* or `undefined` if no such relation exists.
*
* @param rel the name of the relation link
* @param params parameters for a templated link
* @returns an accessor for the linked resource or `undefined`
*/
follow(rel, params = {}) {
const link = this._links[rel];
if (!link)
return undefined;
const uri = link.href;
return !uri ? undefined :
this.accessor(!link.templated ? uri :
URI.parse(uri).expand(params), link.methods);
}
/**
* Refresh the the resource. In other words, read the resource
* identified by `self` link.
*
* @returns an observable of the refreshed resource instance
*/
read() {
const type = this.constructor;
return this.withSelf(self => this._client.get(self).pipe(map(obj => this.instanceOf(type, obj)), catchError(this.handleError)));
}
/**
* Persit the resource. Uses `PUT` request to send the new resource
* state.
*
* @returns an observable of resource accessor
*/
update() {
return this.withSelf(self => this._client.put(self, objectFrom(this)).pipe(map(() => this.accessor(self)), catchError(this.handleError)));
}
/**
* Returns a single embedded resource or `undefined` if no such
* embedded exists. If the named resource is an array it returns
* the first element.
*
* @param type the resource type
* @param rel the name of the embedded resource
* @returns the resource or `undefined`
*/
get(type, rel) {
const obj = this._embedded[rel];
if (Array.isArray(obj)) {
const objs = obj;
const first = objs[0];
return first && this.instanceOf(type, first);
}
return obj && this.instanceOf(type, obj);
}
/**
* Returns an embedded array of resources or `undefined` if the named
* embedded does not exist. If the named resource is not an array it
* wraps the resource in an array.
*
* @param type the element resource type
* @param rel the name of the embedded resource array
* @returns the resource array or `undefined`
*/
getArray(type, rel) {
const obj = this._embedded[rel];
if (Array.isArray(obj))
return this.arrayOf(type, obj);
return obj && [this.instanceOf(type, obj)];
}
clone(override = {}) {
return new this.constructor({
...this,
...override
});
}
arrayOf(type, values) {
return values.map(obj => this.instanceOf(type, obj));
}
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"resource.js","sourceRoot":"","sources":["../../../../src/lib/resource.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,UAAU,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AACnD,OAAO,KAAK,GAAG,MAAM,cAAc,CAAC;AACpC,OAAO,EAAY,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAO3D;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,OAAO;IACjC;;;;OAIG;IACH,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,GAAW,EAAE,SAAiB,EAAE;QACnC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE9B,IAAI,CAAC,IAAI;YACL,OAAO,SAAS,CAAC;QAErB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC;QAEtB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YACrB,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBACjC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACA,MAAM,IAAI,GAAG,IAAI,CAAC,WAAyB,CAAC;QAE5C,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CACpD,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,EACtC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAC/B,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACF,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CACtE,GAAG,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAC9B,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAC/B,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,GAAG,CAAqB,IAAa,EAAE,GAAW;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEhC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,GAAe,CAAC;YAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAEtB,OAAO,KAAK,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC;QAED,OAAO,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;;;;OAQG;IACH,QAAQ,CAAqB,IAAa,EAAE,GAAW;QAEnD,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAEhC,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;YAClB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAEnC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IAC/C,CAAC;IAES,KAAK,CAAC,WAAgB,EAAE;QAC9B,OAAO,IAAK,IAAI,CAAC,WAA0B,CAAC;YACxC,GAAG,IAAI;YACP,GAAG,QAAQ;SACd,CAAC,CAAC;IACP,CAAC;IAES,OAAO,CAAqB,IAAa,EAC/C,MAAgB;QAChB,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACzD,CAAC;CACJ","sourcesContent":["import { Type } from '@angular/core';\nimport { Observable, catchError, map } from 'rxjs';\nimport * as URI from 'uri-template';\nimport { Accessor, HalBase, objectFrom } from './internal';\n\n/**\n * This type represent parameters for templated links.\n */\nexport type Params = Record<string, string | number | boolean>;\n\n/**\n * This class repesents an in-memory instance of a HAL resource.\n */\nexport class Resource extends HalBase {\n    /**\n     * This property is `true` when either `methods` array does not exist\n     * in the `self` link or the array exists and contains `PUT` string.\n     * It is `false` otherwise.\n     */\n    get canUpdate(): boolean {\n        return this.can('PUT');\n    }\n\n    /**\n     * Follow the relation link. Returns an accessor for the resource\n     * or `undefined` if no such relation exists.\n     *\n     * @param rel the name of the relation link\n     * @param params parameters for a templated link\n     * @returns an accessor for the linked resource or `undefined`\n     */\n    follow(rel: string, params: Params = {}): Accessor | undefined {\n        const link = this._links[rel];\n\n        if (!link)\n            return undefined;\n\n        const uri = link.href;\n\n        return !uri ? undefined :\n            this.accessor(!link.templated ? uri :\n                URI.parse(uri).expand(params), link.methods);\n    }\n\n    /**\n     * Refresh the the resource. In other words, read the resource\n     * identified by `self` link.\n     *\n     * @returns an observable of the refreshed resource instance\n     */\n    read(): Observable<this> {\n        const type = this.constructor as Type<this>;\n\n        return this.withSelf(self => this._client.get(self).pipe(\n            map(obj => this.instanceOf(type, obj)),\n            catchError(this.handleError)\n        ));\n    }\n\n    /**\n     * Persit the resource. Uses `PUT` request to send the new resource\n     * state.\n     *\n     * @returns an observable of resource accessor\n     */\n    update(): Observable<Accessor> {\n        return this.withSelf(self => this._client.put(self, objectFrom(this)).pipe(\n            map(() => this.accessor(self)),\n            catchError(this.handleError)\n        ));\n    }\n\n    /**\n     * Returns a single embedded resource or `undefined` if no such\n     * embedded exists. If the named resource is an array it returns\n     * the first element.\n     *\n     * @param type the resource type\n     * @param rel the name of the embedded resource\n     * @returns the resource or `undefined`\n     */\n    get<T extends Resource>(type: Type<T>, rel: string): T | undefined {\n        const obj = this._embedded[rel];\n\n        if (Array.isArray(obj)) {\n            const objs = obj as Object[];\n            const first = objs[0];\n\n            return first && this.instanceOf(type, first);\n        }\n\n        return obj && this.instanceOf(type, obj);\n    }\n\n    /**\n     * Returns an embedded array of resources or `undefined` if the named\n     * embedded does not exist. If the named resource is not an array it\n     * wraps the resource in an array.\n     *\n     * @param type the element resource type\n     * @param rel the name of the embedded resource array\n     * @returns the resource array or `undefined`\n     */\n    getArray<T extends Resource>(type: Type<T>, rel: string):\n        T[] | undefined {\n        const obj = this._embedded[rel];\n\n        if (Array.isArray(obj))\n            return this.arrayOf(type, obj);\n\n        return obj && [this.instanceOf(type, obj)];\n    }\n\n    protected clone(override: any = {}): this {\n        return new (this.constructor as Type<this>)({\n            ...this,\n            ...override\n        });\n    }\n\n    protected arrayOf<T extends Resource>(type: Type<T>,\n        values: Object[]): T[] {\n        return values.map(obj => this.instanceOf(type, obj));\n    }\n}\n"]}