@rxap/remote-method/fesm2022/rxap-remote-method-http.mjs.map

This package provides abstractions for defining and executing remote methods in Angular applications. It includes features such as automatic refreshing, proxying, and error handling. It offers a structured way to manage remote calls and their dependencies

{"version":3,"file":"rxap-remote-method-http.mjs","sources":["../../../../../packages/angular/remote-method/http/src/lib/base-http.remote-method.ts","../../../../../packages/angular/remote-method/http/src/lib/http.remote-method.ts","../../../../../packages/angular/remote-method/http/src/lib/http-remote-method.loader.ts","../../../../../packages/angular/remote-method/http/src/index.ts","../../../../../packages/angular/remote-method/http/src/rxap-remote-method-http.ts"],"sourcesContent":["import {\n  Inject,\n  Injectable,\n  Injector,\n  Optional,\n} from '@angular/core';\nimport { HttpClient, HttpHeaders, HttpParams, HttpRequest } from '@angular/common/http';\nimport {\n  BaseRemoteMethod,\n  BaseRemoteMethodMetadata,\n  REMOTE_METHOD_META_DATA,\n  RxapRemoteMethodError,\n} from '@rxap/remote-method';\nimport { hasIndexSignature } from '@rxap/utilities';\n\nexport interface HttpRemoteMethodMetadata extends BaseRemoteMethodMetadata {\n  url: string | (() => string);\n  method: 'DELETE' | 'GET' | 'HEAD' | 'JSONP' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH';\n  headers?: HttpHeaders;\n  reportProgress?: boolean;\n  params?: HttpParams;\n  responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';\n  withCredentials?: boolean;\n  timeout?: number;\n  retry?: number;\n}\n\nexport interface HttpRemoteMethodParameter<PathParams = any> {\n  headers?: HttpHeaders;\n  reportProgress?: boolean;\n  params?: HttpParams;\n  responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';\n  withCredentials?: boolean;\n  body?: any | null;\n  setHeaders?: {\n    [name: string]: string | string[];\n  };\n  setParams?: {\n    [param: string]: string;\n  };\n  pathParams?: PathParams;\n}\n\n@Injectable()\nexport abstract class BaseHttpRemoteMethod<ReturnType = any,\n  PathParams = any,\n  Parameter extends object = HttpRemoteMethodParameter<PathParams>,\n  MetaData extends HttpRemoteMethodMetadata = HttpRemoteMethodMetadata>\n  extends BaseRemoteMethod<ReturnType, Parameter, MetaData> {\n\n  public timeout = 60 * 1000;\n  protected _httpRequest!: HttpRequest<ReturnType>;\n\n  constructor(\n    @Inject(HttpClient) public readonly http: HttpClient,\n    @Inject(Injector) injector: Injector,\n    @Optional() @Inject(REMOTE_METHOD_META_DATA) metaData: any | null = null,\n  ) {\n    super(injector, metaData);\n    this.timeout = this.metadata.timeout ?? this.timeout;\n    if (http === undefined) {\n      throw new RxapRemoteMethodError(\n        'HttpClient is undefined. Ensure that the HttpClient is added to the deps property!',\n        '',\n        this.constructor.name,\n      );\n    }\n    if (!(http instanceof HttpClient)) {\n      throw new RxapRemoteMethodError(\n        'The property http is not an instance of HttpClinent. Check the deps property!',\n        '',\n        this.constructor.name,\n      );\n    }\n  }\n\n  public override init() {\n    super.init();\n    this._httpRequest = new HttpRequest<ReturnType>(\n      this.metadata.method,\n      this.getRequestUrl(),\n      null,\n      {\n        headers: this.metadata.headers,\n        reportProgress: this.metadata.reportProgress,\n        params: this.metadata.params,\n        responseType: this.metadata.responseType || 'json',\n        withCredentials: this.metadata.withCredentials,\n      },\n    );\n  }\n\n  public updateRequest(parameters: Partial<HttpRemoteMethodParameter>): HttpRequest<ReturnType> {\n    let url = this._httpRequest.url;\n\n    if (parameters && parameters['pathParams']) {\n      url = this.buildUrlWithParams(url, (parameters as any).pathParams);\n    }\n\n    return this._httpRequest.clone({\n      withCredentials: this.metadata.withCredentials,\n      ...parameters,\n      url,\n    });\n  }\n\n  public buildUrlWithParams(url: string, pathParams?: PathParams): string {\n    if (pathParams) {\n\n      if (!hasIndexSignature(pathParams)) {\n        throw new RxapRemoteMethodError(\n          `Path params for remote method '${ this.id }' has not an index signature`,\n          '',\n          this.constructor.name,\n        );\n      }\n\n      const matches = url.match(/\\{[^}]+\\}/g);\n\n      if (matches) {\n        for (const match of matches) {\n          const param = match.substr(1, match.length - 2);\n          if (pathParams[param] === undefined) {\n            throw new RxapRemoteMethodError(\n              `Path params for remote method '${ this.id }' has not a defined value for '${ param }'`,\n              '',\n              this.constructor.name,\n            );\n          }\n          url = url.replace(match, encodeURIComponent(pathParams[param]));\n        }\n      }\n    }\n\n    return url;\n  }\n\n  protected getRequestUrl(): string {\n    if (typeof this.metadata.url === 'function') {\n      return this.metadata.url();\n    }\n    return this.metadata.url;\n  }\n\n}\n\nexport interface HttpRemoteMethodMetadata extends BaseRemoteMethodMetadata {\n  url: string | (() => string);\n  method: 'DELETE' | 'GET' | 'HEAD' | 'JSONP' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH';\n  headers?: HttpHeaders;\n  reportProgress?: boolean;\n  params?: HttpParams;\n  responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';\n  withCredentials?: boolean;\n}\n\nexport interface HttpRemoteMethodParameter<PathParams = any> {\n  headers?: HttpHeaders;\n  reportProgress?: boolean;\n  params?: HttpParams;\n  responseType?: 'arraybuffer' | 'blob' | 'json' | 'text';\n  withCredentials?: boolean;\n  body?: any | null;\n  setHeaders?: {\n    [name: string]: string | string[];\n  };\n  setParams?: {\n    [param: string]: string;\n  };\n  pathParams?: PathParams;\n}\n","import { Injectable } from '@angular/core';\nimport { HttpEventType, HttpHeaderResponse, HttpProgressEvent, HttpResponse, HttpSentEvent } from '@angular/common/http';\nimport {\n  filter,\n  map,\n  retry,\n  tap,\n  timeout,\n} from 'rxjs/operators';\nimport {\n  BaseHttpRemoteMethod,\n  HttpRemoteMethodMetadata,\n  HttpRemoteMethodParameter,\n} from './base-http.remote-method';\nimport { firstValueFrom } from 'rxjs';\n\n@Injectable()\nexport class HttpRemoteMethod<ReturnType = any,\n  PathParams = any,\n  Parameter extends object = HttpRemoteMethodParameter<PathParams>,\n  MetaData extends HttpRemoteMethodMetadata = HttpRemoteMethodMetadata>\n  extends BaseHttpRemoteMethod<ReturnType, PathParams, Parameter, MetaData> {\n\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  public onSentEvent(event: HttpSentEvent): void {\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  public onHeaderResponse(event: HttpHeaderResponse): void {\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  public onResponse(event: HttpResponse<ReturnType>): void {\n  }\n\n  // eslint-disable-next-line @typescript-eslint/no-empty-function\n  public onProgressEvent(event: HttpProgressEvent): void {\n  }\n\n  // TODO : make abstract to force implementation to handel parameter transformation\n  public createHttpRequestParameters(parameters?: Parameter): Partial<HttpRemoteMethodParameter> {\n    return parameters ?? {} as any;\n  }\n\n  public transformer(response: any): ReturnType {\n    return response;\n  }\n\n  protected _call(parameters?: Parameter): Promise<ReturnType> {\n    return firstValueFrom(this.http.request<ReturnType>(this.updateRequest(this.createHttpRequestParameters(parameters)))\n                              .pipe(\n                                retry(this.metadata.retry ?? 0),\n                                tap(event => {\n                                  switch (event.type) {\n\n                                    case HttpEventType.Sent:\n                                      this.onSentEvent(event);\n                                      break;\n\n                                    case HttpEventType.Response:\n                                      this.onResponse(event);\n                                      break;\n\n                                    case HttpEventType.DownloadProgress:\n                                      this.onProgressEvent(event);\n                                      break;\n\n                                    case HttpEventType.UploadProgress:\n                                      this.onProgressEvent(event);\n                                      break;\n\n                                    case HttpEventType.ResponseHeader:\n                                      this.onHeaderResponse(event);\n                                      break;\n\n                                  }\n                                }),\n                                filter((event: any) => event instanceof HttpResponse),\n                                map((event: HttpResponse<ReturnType>) => event.body),\n                                map(body => this.transformer(body)),\n                                timeout(this.timeout),\n                              ));\n  }\n\n}\n","import {\n  BaseRemoteMethod,\n  BaseRemoteMethodMetadata,\n  RemoteMethodLoader,\n  RxapRemoteMethodError,\n} from '@rxap/remote-method';\nimport { HttpRemoteMethod } from './http.remote-method';\nimport {\n  Inject,\n  Injectable,\n  InjectFlags,\n  Injector,\n} from '@angular/core';\nimport { IdOrInstanceOrToken } from '@rxap/definition';\n\n@Injectable({ providedIn: 'root' })\nexport class HttpRemoteMethodLoader {\n\n  // Instead of extanding the RemoteMethodLoader class the RemoteMethodLoader instance\n  // will be injected, else there could be multiple instance of RemoteMethodLoader's. Then\n  // the RefreshService will not trigger a refresh for HttpRemoteMethod's\n  constructor(@Inject(RemoteMethodLoader) private readonly remoteMethodLoader: RemoteMethodLoader) {\n  }\n\n  public request$<ReturnType = any, Parameters = any, Metadata extends BaseRemoteMethodMetadata = BaseRemoteMethodMetadata>(\n    remoteMethodIdOrInstanceOrToken: IdOrInstanceOrToken<BaseRemoteMethod<ReturnType, Parameters, Metadata>>,\n    parameters: Parameters,\n    metadata?: Partial<BaseRemoteMethodMetadata>,\n    injector?: Injector,\n    notFoundValue?: BaseRemoteMethod<ReturnType, Parameters, Metadata>,\n    flags?: InjectFlags,\n  ) {\n\n    const remoteMethod = this.remoteMethodLoader.load(\n      remoteMethodIdOrInstanceOrToken,\n      metadata,\n      injector,\n      notFoundValue,\n      flags,\n    );\n\n    if (!(remoteMethod instanceof HttpRemoteMethod)) {\n      throw new RxapRemoteMethodError(`The remote method is not a HttpRemoteMethod`, '', 'HttpRemoteMethodLoader');\n    }\n\n    return remoteMethod.call(parameters);\n  }\n\n}\n","// region \nexport * from './lib/base-http.remote-method';\nexport * from './lib/http-remote-method.loader';\nexport * from './lib/http.remote-method';\n// endregion\n","/**\n * Generated bundle index. Do not edit.\n */\n\nexport * from './index';\n"],"names":[],"mappings":";;;;;;;;;;AA4CM,MAAgB,oBAIpB,SAAQ,gBAAiD,CAAA;AAKzD,IAAA,WAAA,CACsC,IAAgB,EAClC,QAAkB,EACS,WAAuB,IAAI,EAAA;AAExE,QAAA,KAAK,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAJW,IAAI,CAAA,IAAA,GAAJ,IAAI;AAJnC,QAAA,IAAA,CAAA,OAAO,GAAG,EAAE,GAAG,IAAI;AASxB,QAAA,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO;AACpD,QAAA,IAAI,IAAI,KAAK,SAAS,EAAE;AACtB,YAAA,MAAM,IAAI,qBAAqB,CAC7B,oFAAoF,EACpF,EAAE,EACF,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB;;AAEH,QAAA,IAAI,EAAE,IAAI,YAAY,UAAU,CAAC,EAAE;AACjC,YAAA,MAAM,IAAI,qBAAqB,CAC7B,+EAA+E,EAC/E,EAAE,EACF,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB;;;IAIW,IAAI,GAAA;QAClB,KAAK,CAAC,IAAI,EAAE;AACZ,QAAA,IAAI,CAAC,YAAY,GAAG,IAAI,WAAW,CACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,EACpB,IAAI,CAAC,aAAa,EAAE,EACpB,IAAI,EACJ;AACE,YAAA,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO;AAC9B,YAAA,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,cAAc;AAC5C,YAAA,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM;AAC5B,YAAA,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,YAAY,IAAI,MAAM;AAClD,YAAA,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe;AAC/C,SAAA,CACF;;AAGI,IAAA,aAAa,CAAC,UAA8C,EAAA;AACjE,QAAA,IAAI,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG;AAE/B,QAAA,IAAI,UAAU,IAAI,UAAU,CAAC,YAAY,CAAC,EAAE;YAC1C,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAG,UAAkB,CAAC,UAAU,CAAC;;AAGpE,QAAA,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC;AAC7B,YAAA,eAAe,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe;AAC9C,YAAA,GAAG,UAAU;YACb,GAAG;AACJ,SAAA,CAAC;;IAGG,kBAAkB,CAAC,GAAW,EAAE,UAAuB,EAAA;QAC5D,IAAI,UAAU,EAAE;AAEd,YAAA,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,EAAE;AAClC,gBAAA,MAAM,IAAI,qBAAqB,CAC7B,CAAmC,+BAAA,EAAA,IAAI,CAAC,EAAG,CAAA,4BAAA,CAA8B,EACzE,EAAE,EACF,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB;;YAGH,MAAM,OAAO,GAAG,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC;YAEvC,IAAI,OAAO,EAAE;AACX,gBAAA,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;AAC3B,oBAAA,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAC/C,oBAAA,IAAI,UAAU,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE;AACnC,wBAAA,MAAM,IAAI,qBAAqB,CAC7B,kCAAmC,IAAI,CAAC,EAAG,CAAmC,+BAAA,EAAA,KAAM,GAAG,EACvF,EAAE,EACF,IAAI,CAAC,WAAW,CAAC,IAAI,CACtB;;AAEH,oBAAA,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;;;;AAKrE,QAAA,OAAO,GAAG;;IAGF,aAAa,GAAA;QACrB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,KAAK,UAAU,EAAE;AAC3C,YAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;;AAE5B,QAAA,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG;;AAjGN,IAAA,SAAA,IAAA,CAAA,IAAA,GAAA,EAAA,CAAA,kBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,oBAAoB,EAU9B,IAAA,EAAA,CAAA,EAAA,KAAA,EAAA,UAAU,EACV,EAAA,EAAA,KAAA,EAAA,QAAQ,aACI,uBAAuB,EAAA,QAAA,EAAA,IAAA,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;kHAZzB,oBAAoB,EAAA,CAAA,CAAA;;2FAApB,oBAAoB,EAAA,UAAA,EAAA,CAAA;kBADzC;;0BAWI,MAAM;2BAAC,UAAU;;0BACjB,MAAM;2BAAC,QAAQ;;0BACf;;0BAAY,MAAM;2BAAC,uBAAuB;;;ACvCzC,MAAO,gBAIX,SAAQ,oBAAiE,CAAA;;AAGlE,IAAA,WAAW,CAAC,KAAoB,EAAA;;;AAIhC,IAAA,gBAAgB,CAAC,KAAyB,EAAA;;;AAI1C,IAAA,UAAU,CAAC,KAA+B,EAAA;;;AAI1C,IAAA,eAAe,CAAC,KAAwB,EAAA;;;AAIxC,IAAA,2BAA2B,CAAC,UAAsB,EAAA;QACvD,OAAO,UAAU,IAAI,EAAS;;AAGzB,IAAA,WAAW,CAAC,QAAa,EAAA;AAC9B,QAAA,OAAO,QAAQ;;AAGP,IAAA,KAAK,CAAC,UAAsB,EAAA;AACpC,QAAA,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAa,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,2BAA2B,CAAC,UAAU,CAAC,CAAC;AACzF,aAAA,IAAI,CACH,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC,EAC/B,GAAG,CAAC,KAAK,IAAG;AACV,YAAA,QAAQ,KAAK,CAAC,IAAI;gBAEhB,KAAK,aAAa,CAAC,IAAI;AACrB,oBAAA,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;oBACvB;gBAEF,KAAK,aAAa,CAAC,QAAQ;AACzB,oBAAA,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;oBACtB;gBAEF,KAAK,aAAa,CAAC,gBAAgB;AACjC,oBAAA,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;oBAC3B;gBAEF,KAAK,aAAa,CAAC,cAAc;AAC/B,oBAAA,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC;oBAC3B;gBAEF,KAAK,aAAa,CAAC,cAAc;AAC/B,oBAAA,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;oBAC5B;;SAGL,CAAC,EACF,MAAM,CAAC,CAAC,KAAU,KAAK,KAAK,YAAY,YAAY,CAAC,EACrD,GAAG,CAAC,CAAC,KAA+B,KAAK,KAAK,CAAC,IAAI,CAAC,EACpD,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,EACnC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CACtB,CAAC;;8GAhEnB,gBAAgB,EAAA,IAAA,EAAA,IAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;kHAAhB,gBAAgB,EAAA,CAAA,CAAA;;2FAAhB,gBAAgB,EAAA,UAAA,EAAA,CAAA;kBAD5B;;;MCAY,sBAAsB,CAAA;;;;AAKjC,IAAA,WAAA,CAAyD,kBAAsC,EAAA;QAAtC,IAAkB,CAAA,kBAAA,GAAlB,kBAAkB;;IAGpE,QAAQ,CACb,+BAAwG,EACxG,UAAsB,EACtB,QAA4C,EAC5C,QAAmB,EACnB,aAAkE,EAClE,KAAmB,EAAA;AAGnB,QAAA,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAC/C,+BAA+B,EAC/B,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,KAAK,CACN;AAED,QAAA,IAAI,EAAE,YAAY,YAAY,gBAAgB,CAAC,EAAE;YAC/C,MAAM,IAAI,qBAAqB,CAAC,CAAA,2CAAA,CAA6C,EAAE,EAAE,EAAE,wBAAwB,CAAC;;AAG9G,QAAA,OAAO,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC;;AA7B3B,IAAA,SAAA,IAAA,CAAA,IAAA,GAAA,EAAA,CAAA,kBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,sBAAsB,kBAKb,kBAAkB,EAAA,CAAA,EAAA,MAAA,EAAA,EAAA,CAAA,eAAA,CAAA,UAAA,EAAA,CAAA,CAAA;AAL3B,IAAA,SAAA,IAAA,CAAA,KAAA,GAAA,EAAA,CAAA,qBAAA,CAAA,EAAA,UAAA,EAAA,QAAA,EAAA,OAAA,EAAA,QAAA,EAAA,QAAA,EAAA,EAAA,EAAA,IAAA,EAAA,sBAAsB,cADT,MAAM,EAAA,CAAA,CAAA;;2FACnB,sBAAsB,EAAA,UAAA,EAAA,CAAA;kBADlC,UAAU;mBAAC,EAAE,UAAU,EAAE,MAAM,EAAE;;0BAMnB,MAAM;2BAAC,kBAAkB;;;ACrBxC;AAIA;;ACJA;;AAEG;;;;"}