angular-odata/esm2022/lib/resources/types/reference.mjs

Client side OData typescript library for Angular

import { map } from 'rxjs/operators';
import { $ID, $REF, ODATA_ID } from '../../constants';
import { PathSegment } from '../../types';
import { ODataResource } from '../resource';
export class ODataReferenceResource extends ODataResource {
    //#region Factory
    static factory(api, { segments }) {
        segments.add(PathSegment.reference, $REF);
        return new ODataReferenceResource(api, { segments });
    }
    clone() {
        return super.clone();
    }
    //#endregion
    //#region Requests
    post(target, options) {
        return super.post({ [ODATA_ID]: target.endpointUrl({ params: false }) }, options);
    }
    put(target, options) {
        return super.put({ [ODATA_ID]: target.endpointUrl({ params: false }) }, options);
    }
    delete({ etag, target, ...options } = {}) {
        if (target) {
            options.params = { [$ID]: target.endpointUrl({ params: false }) };
        }
        return super.delete({ etag, ...options });
    }
    //#endregion
    //#region Shortcuts for collections
    /**
     * Add the given target to the collection.
     * @param target The target resource
     * @param options Options for the request
     * @returns Observable of the response
     */
    add(target, options) {
        return this.post(target, options);
    }
    /**
     * Remove the given target from the collection.
     * @param target The target resource
     * @param options Options for the request
     * @returns Observable of the response
     */
    remove(target, options) {
        return this.delete({ target, ...options });
    }
    //#region
    //#region Shortcuts for single
    /**
     * Set the reference to the given target.
     * @param target The target resource
     * @param options Options for the request
     * @returns Observable of the response
     */
    set(target, options) {
        return this.put(target, options);
    }
    /**
     * Unset the reference to the given target.
     * @param options Options for the request.
     * @returns Observable of the response
     */
    unset(options) {
        return this.delete(options);
    }
    fetch(options = {}) {
        return this.get(options);
    }
    /**
     * Fetch the entity
     * @param options Options for the request
     * @returns The entity
     */
    fetchEntity(options = {}) {
        return this.fetch({ responseType: 'entity', ...options }).pipe(map(({ entity }) => entity));
    }
    /**
     * Fetch entities
     * @param options Options for the request
     * @returns The entities
     */
    fetchEntities(options = {}) {
        return this.fetch({ responseType: 'entities', ...options }).pipe(map(({ entities }) => entities));
    }
}
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"reference.js","sourceRoot":"","sources":["../../../../../../projects/angular-odata/src/lib/resources/types/reference.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAe,MAAM,aAAa,CAAC;AAEvD,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAS5C,MAAM,OAAO,sBAA0B,SAAQ,aAAgB;IAC7D,iBAAiB;IACjB,MAAM,CAAC,OAAO,CACZ,GAAa,EACb,EAAE,QAAQ,EAAmC;QAE7C,QAAQ,CAAC,GAAG,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC1C,OAAO,IAAI,sBAAsB,CAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1D,CAAC;IAEQ,KAAK;QACZ,OAAO,KAAK,CAAC,KAAK,EAA+B,CAAC;IACpD,CAAC;IACD,YAAY;IAEZ,kBAAkB;IACC,IAAI,CACrB,MAAgC,EAChC,OAAsB;QAEtB,OAAO,KAAK,CAAC,IAAI,CACf,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,EACrD,OAAO,CACR,CAAC;IACJ,CAAC;IAEkB,GAAG,CACpB,MAAgC,EAChC,OAAsB;QAEtB,OAAO,KAAK,CAAC,GAAG,CACd,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,EACrD,OAAO,CACR,CAAC;IACJ,CAAC;IAEkB,MAAM,CAAC,EACxB,IAAI,EACJ,MAAM,EACN,GAAG,OAAO,KAIO,EAAE;QACnB,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;QACpE,CAAC;QACD,OAAO,KAAK,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;IACD,YAAY;IAEZ,mCAAmC;IACnC;;;;;OAKG;IACH,GAAG,CACD,MAAgC,EAChC,OAAsB;QAEtB,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACH,MAAM,CACJ,MAAiC,EACjC,OAAsB;QAEtB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,SAAS;IAET,8BAA8B;IAC9B;;;;;OAKG;IACH,GAAG,CACD,MAAgC,EAChC,OAAsB;QAEtB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAsB;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAmBD,KAAK,CACH,UAGM,EAAE;QAER,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,WAAW,CACT,UAEI,EAAE;QAEN,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,IAAI,CAC5D,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,CAC5B,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,aAAa,CACX,UAEI,EAAE;QAEN,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC,IAAI,CAC9D,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,CAChC,CAAC;IACJ,CAAC;CAEF","sourcesContent":["import { Observable } from 'rxjs';\nimport { map } from 'rxjs/operators';\nimport { ODataApi } from '../../api';\nimport { $ID, $REF, ODATA_ID } from '../../constants';\nimport { PathSegment, QueryOption } from '../../types';\nimport { ODataPathSegments } from '../path';\nimport { ODataResource } from '../resource';\nimport { ODataEntities, ODataEntity } from '../response';\nimport { ODataEntityResource } from './entity';\nimport {\n  ODataEntitiesOptions,\n  ODataEntityOptions,\n  ODataOptions,\n} from './options';\n\nexport class ODataReferenceResource<T> extends ODataResource<T> {\n  //#region Factory\n  static factory<P>(\n    api: ODataApi,\n    { segments }: { segments: ODataPathSegments },\n  ) {\n    segments.add(PathSegment.reference, $REF);\n    return new ODataReferenceResource<P>(api, { segments });\n  }\n\n  override clone(): ODataReferenceResource<T> {\n    return super.clone() as ODataReferenceResource<T>;\n  }\n  //#endregion\n\n  //#region Requests\n  protected override post(\n    target: ODataEntityResource<any>,\n    options?: ODataOptions,\n  ): Observable<any> {\n    return super.post(\n      { [ODATA_ID]: target.endpointUrl({ params: false }) },\n      options,\n    );\n  }\n\n  protected override put(\n    target: ODataEntityResource<any>,\n    options?: ODataOptions,\n  ): Observable<any> {\n    return super.put(\n      { [ODATA_ID]: target.endpointUrl({ params: false }) },\n      options,\n    );\n  }\n\n  protected override delete({\n    etag,\n    target,\n    ...options\n  }: {\n    etag?: string;\n    target?: ODataEntityResource<any>;\n  } & ODataOptions = {}): Observable<any> {\n    if (target) {\n      options.params = { [$ID]: target.endpointUrl({ params: false }) };\n    }\n    return super.delete({ etag, ...options });\n  }\n  //#endregion\n\n  //#region Shortcuts for collections\n  /**\n   * Add the given target to the collection.\n   * @param target The target resource\n   * @param options Options for the request\n   * @returns Observable of the response\n   */\n  add(\n    target: ODataEntityResource<any>,\n    options?: ODataOptions,\n  ): Observable<any> {\n    return this.post(target, options);\n  }\n\n  /**\n   * Remove the given target from the collection.\n   * @param target The target resource\n   * @param options Options for the request\n   * @returns Observable of the response\n   */\n  remove(\n    target?: ODataEntityResource<any>,\n    options?: ODataOptions,\n  ): Observable<any> {\n    return this.delete({ target, ...options });\n  }\n  //#region\n\n  //#region Shortcuts for single\n  /**\n   * Set the reference to the given target.\n   * @param target The target resource\n   * @param options Options for the request\n   * @returns Observable of the response\n   */\n  set(\n    target: ODataEntityResource<any>,\n    options?: ODataOptions,\n  ): Observable<any> {\n    return this.put(target, options);\n  }\n\n  /**\n   * Unset the reference to the given target.\n   * @param options Options for the request.\n   * @returns Observable of the response\n   */\n  unset(options?: ODataOptions): Observable<any> {\n    return this.delete(options);\n  }\n  //#endregion\n\n  //#region Fetch\n  /**\n   * Fetch entity / entities\n   * @param options Options for the request\n   * @return An observable of the entity or entities with annotations\n   */\n  fetch(\n    options?: ODataEntityOptions & {\n      bodyQueryOptions?: QueryOption[];\n    },\n  ): Observable<ODataEntity<T>>;\n  fetch(\n    options?: ODataEntitiesOptions & {\n      bodyQueryOptions?: QueryOption[];\n    },\n  ): Observable<ODataEntities<T>>;\n  fetch(\n    options: ODataEntityOptions &\n      ODataEntitiesOptions & {\n        bodyQueryOptions?: QueryOption[];\n      } = {},\n  ): Observable<any> {\n    return this.get(options);\n  }\n\n  /**\n   * Fetch the entity\n   * @param options Options for the request\n   * @returns The entity\n   */\n  fetchEntity(\n    options: ODataOptions & {\n      bodyQueryOptions?: QueryOption[];\n    } = {},\n  ): Observable<T | null> {\n    return this.fetch({ responseType: 'entity', ...options }).pipe(\n      map(({ entity }) => entity),\n    );\n  }\n\n  /**\n   * Fetch entities\n   * @param options Options for the request\n   * @returns The entities\n   */\n  fetchEntities(\n    options: ODataOptions & {\n      bodyQueryOptions?: QueryOption[];\n    } = {},\n  ): Observable<T[] | null> {\n    return this.fetch({ responseType: 'entities', ...options }).pipe(\n      map(({ entities }) => entities),\n    );\n  }\n  //#endregion\n}\n"]}