1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782 |
- /**
- * @license Angular v16.2.9
- * (c) 2010-2022 Google LLC. https://angular.io/
- * License: MIT
- */
- import * as i0 from '@angular/core';
- import { Injectable, inject, NgZone, InjectionToken, ɵInitialRenderPendingTasks, Inject, ɵRuntimeError, PLATFORM_ID, makeEnvironmentProviders, NgModule, TransferState, makeStateKey, ɵENABLED_SSR_FEATURES, APP_BOOTSTRAP_LISTENER, ApplicationRef } from '@angular/core';
- import { of, Observable, from } from 'rxjs';
- import { concatMap, filter, map, finalize, switchMap, tap, first } from 'rxjs/operators';
- import * as i1 from '@angular/common';
- import { DOCUMENT, ɵparseCookieValue } from '@angular/common';
- /**
- * Transforms an `HttpRequest` into a stream of `HttpEvent`s, one of which will likely be a
- * `HttpResponse`.
- *
- * `HttpHandler` is injectable. When injected, the handler instance dispatches requests to the
- * first interceptor in the chain, which dispatches to the second, etc, eventually reaching the
- * `HttpBackend`.
- *
- * In an `HttpInterceptor`, the `HttpHandler` parameter is the next interceptor in the chain.
- *
- * @publicApi
- */
- class HttpHandler {
- }
- /**
- * A final `HttpHandler` which will dispatch the request via browser HTTP APIs to a backend.
- *
- * Interceptors sit between the `HttpClient` interface and the `HttpBackend`.
- *
- * When injected, `HttpBackend` dispatches requests directly to the backend, without going
- * through the interceptor chain.
- *
- * @publicApi
- */
- class HttpBackend {
- }
- /**
- * Represents the header configuration options for an HTTP request.
- * Instances are immutable. Modifying methods return a cloned
- * instance with the change. The original object is never changed.
- *
- * @publicApi
- */
- class HttpHeaders {
- /** Constructs a new HTTP header object with the given values.*/
- constructor(headers) {
- /**
- * Internal map of lowercased header names to the normalized
- * form of the name (the form seen first).
- */
- this.normalizedNames = new Map();
- /**
- * Queued updates to be materialized the next initialization.
- */
- this.lazyUpdate = null;
- if (!headers) {
- this.headers = new Map();
- }
- else if (typeof headers === 'string') {
- this.lazyInit = () => {
- this.headers = new Map();
- headers.split('\n').forEach(line => {
- const index = line.indexOf(':');
- if (index > 0) {
- const name = line.slice(0, index);
- const key = name.toLowerCase();
- const value = line.slice(index + 1).trim();
- this.maybeSetNormalizedName(name, key);
- if (this.headers.has(key)) {
- this.headers.get(key).push(value);
- }
- else {
- this.headers.set(key, [value]);
- }
- }
- });
- };
- }
- else if (typeof Headers !== 'undefined' && headers instanceof Headers) {
- this.headers = new Map();
- headers.forEach((values, name) => {
- this.setHeaderEntries(name, values);
- });
- }
- else {
- this.lazyInit = () => {
- if (typeof ngDevMode === 'undefined' || ngDevMode) {
- assertValidHeaders(headers);
- }
- this.headers = new Map();
- Object.entries(headers).forEach(([name, values]) => {
- this.setHeaderEntries(name, values);
- });
- };
- }
- }
- /**
- * Checks for existence of a given header.
- *
- * @param name The header name to check for existence.
- *
- * @returns True if the header exists, false otherwise.
- */
- has(name) {
- this.init();
- return this.headers.has(name.toLowerCase());
- }
- /**
- * Retrieves the first value of a given header.
- *
- * @param name The header name.
- *
- * @returns The value string if the header exists, null otherwise
- */
- get(name) {
- this.init();
- const values = this.headers.get(name.toLowerCase());
- return values && values.length > 0 ? values[0] : null;
- }
- /**
- * Retrieves the names of the headers.
- *
- * @returns A list of header names.
- */
- keys() {
- this.init();
- return Array.from(this.normalizedNames.values());
- }
- /**
- * Retrieves a list of values for a given header.
- *
- * @param name The header name from which to retrieve values.
- *
- * @returns A string of values if the header exists, null otherwise.
- */
- getAll(name) {
- this.init();
- return this.headers.get(name.toLowerCase()) || null;
- }
- /**
- * Appends a new value to the existing set of values for a header
- * and returns them in a clone of the original instance.
- *
- * @param name The header name for which to append the values.
- * @param value The value to append.
- *
- * @returns A clone of the HTTP headers object with the value appended to the given header.
- */
- append(name, value) {
- return this.clone({ name, value, op: 'a' });
- }
- /**
- * Sets or modifies a value for a given header in a clone of the original instance.
- * If the header already exists, its value is replaced with the given value
- * in the returned object.
- *
- * @param name The header name.
- * @param value The value or values to set or override for the given header.
- *
- * @returns A clone of the HTTP headers object with the newly set header value.
- */
- set(name, value) {
- return this.clone({ name, value, op: 's' });
- }
- /**
- * Deletes values for a given header in a clone of the original instance.
- *
- * @param name The header name.
- * @param value The value or values to delete for the given header.
- *
- * @returns A clone of the HTTP headers object with the given value deleted.
- */
- delete(name, value) {
- return this.clone({ name, value, op: 'd' });
- }
- maybeSetNormalizedName(name, lcName) {
- if (!this.normalizedNames.has(lcName)) {
- this.normalizedNames.set(lcName, name);
- }
- }
- init() {
- if (!!this.lazyInit) {
- if (this.lazyInit instanceof HttpHeaders) {
- this.copyFrom(this.lazyInit);
- }
- else {
- this.lazyInit();
- }
- this.lazyInit = null;
- if (!!this.lazyUpdate) {
- this.lazyUpdate.forEach(update => this.applyUpdate(update));
- this.lazyUpdate = null;
- }
- }
- }
- copyFrom(other) {
- other.init();
- Array.from(other.headers.keys()).forEach(key => {
- this.headers.set(key, other.headers.get(key));
- this.normalizedNames.set(key, other.normalizedNames.get(key));
- });
- }
- clone(update) {
- const clone = new HttpHeaders();
- clone.lazyInit =
- (!!this.lazyInit && this.lazyInit instanceof HttpHeaders) ? this.lazyInit : this;
- clone.lazyUpdate = (this.lazyUpdate || []).concat([update]);
- return clone;
- }
- applyUpdate(update) {
- const key = update.name.toLowerCase();
- switch (update.op) {
- case 'a':
- case 's':
- let value = update.value;
- if (typeof value === 'string') {
- value = [value];
- }
- if (value.length === 0) {
- return;
- }
- this.maybeSetNormalizedName(update.name, key);
- const base = (update.op === 'a' ? this.headers.get(key) : undefined) || [];
- base.push(...value);
- this.headers.set(key, base);
- break;
- case 'd':
- const toDelete = update.value;
- if (!toDelete) {
- this.headers.delete(key);
- this.normalizedNames.delete(key);
- }
- else {
- let existing = this.headers.get(key);
- if (!existing) {
- return;
- }
- existing = existing.filter(value => toDelete.indexOf(value) === -1);
- if (existing.length === 0) {
- this.headers.delete(key);
- this.normalizedNames.delete(key);
- }
- else {
- this.headers.set(key, existing);
- }
- }
- break;
- }
- }
- setHeaderEntries(name, values) {
- const headerValues = (Array.isArray(values) ? values : [values]).map((value) => value.toString());
- const key = name.toLowerCase();
- this.headers.set(key, headerValues);
- this.maybeSetNormalizedName(name, key);
- }
- /**
- * @internal
- */
- forEach(fn) {
- this.init();
- Array.from(this.normalizedNames.keys())
- .forEach(key => fn(this.normalizedNames.get(key), this.headers.get(key)));
- }
- }
- /**
- * Verifies that the headers object has the right shape: the values
- * must be either strings, numbers or arrays. Throws an error if an invalid
- * header value is present.
- */
- function assertValidHeaders(headers) {
- for (const [key, value] of Object.entries(headers)) {
- if (!(typeof value === 'string' || typeof value === 'number') && !Array.isArray(value)) {
- throw new Error(`Unexpected value of the \`${key}\` header provided. ` +
- `Expecting either a string, a number or an array, but got: \`${value}\`.`);
- }
- }
- }
- /**
- * Provides encoding and decoding of URL parameter and query-string values.
- *
- * Serializes and parses URL parameter keys and values to encode and decode them.
- * If you pass URL query parameters without encoding,
- * the query parameters can be misinterpreted at the receiving end.
- *
- *
- * @publicApi
- */
- class HttpUrlEncodingCodec {
- /**
- * Encodes a key name for a URL parameter or query-string.
- * @param key The key name.
- * @returns The encoded key name.
- */
- encodeKey(key) {
- return standardEncoding(key);
- }
- /**
- * Encodes the value of a URL parameter or query-string.
- * @param value The value.
- * @returns The encoded value.
- */
- encodeValue(value) {
- return standardEncoding(value);
- }
- /**
- * Decodes an encoded URL parameter or query-string key.
- * @param key The encoded key name.
- * @returns The decoded key name.
- */
- decodeKey(key) {
- return decodeURIComponent(key);
- }
- /**
- * Decodes an encoded URL parameter or query-string value.
- * @param value The encoded value.
- * @returns The decoded value.
- */
- decodeValue(value) {
- return decodeURIComponent(value);
- }
- }
- function paramParser(rawParams, codec) {
- const map = new Map();
- if (rawParams.length > 0) {
- // The `window.location.search` can be used while creating an instance of the `HttpParams` class
- // (e.g. `new HttpParams({ fromString: window.location.search })`). The `window.location.search`
- // may start with the `?` char, so we strip it if it's present.
- const params = rawParams.replace(/^\?/, '').split('&');
- params.forEach((param) => {
- const eqIdx = param.indexOf('=');
- const [key, val] = eqIdx == -1 ?
- [codec.decodeKey(param), ''] :
- [codec.decodeKey(param.slice(0, eqIdx)), codec.decodeValue(param.slice(eqIdx + 1))];
- const list = map.get(key) || [];
- list.push(val);
- map.set(key, list);
- });
- }
- return map;
- }
- /**
- * Encode input string with standard encodeURIComponent and then un-encode specific characters.
- */
- const STANDARD_ENCODING_REGEX = /%(\d[a-f0-9])/gi;
- const STANDARD_ENCODING_REPLACEMENTS = {
- '40': '@',
- '3A': ':',
- '24': '$',
- '2C': ',',
- '3B': ';',
- '3D': '=',
- '3F': '?',
- '2F': '/',
- };
- function standardEncoding(v) {
- return encodeURIComponent(v).replace(STANDARD_ENCODING_REGEX, (s, t) => STANDARD_ENCODING_REPLACEMENTS[t] ?? s);
- }
- function valueToString(value) {
- return `${value}`;
- }
- /**
- * An HTTP request/response body that represents serialized parameters,
- * per the MIME type `application/x-www-form-urlencoded`.
- *
- * This class is immutable; all mutation operations return a new instance.
- *
- * @publicApi
- */
- class HttpParams {
- constructor(options = {}) {
- this.updates = null;
- this.cloneFrom = null;
- this.encoder = options.encoder || new HttpUrlEncodingCodec();
- if (!!options.fromString) {
- if (!!options.fromObject) {
- throw new Error(`Cannot specify both fromString and fromObject.`);
- }
- this.map = paramParser(options.fromString, this.encoder);
- }
- else if (!!options.fromObject) {
- this.map = new Map();
- Object.keys(options.fromObject).forEach(key => {
- const value = options.fromObject[key];
- // convert the values to strings
- const values = Array.isArray(value) ? value.map(valueToString) : [valueToString(value)];
- this.map.set(key, values);
- });
- }
- else {
- this.map = null;
- }
- }
- /**
- * Reports whether the body includes one or more values for a given parameter.
- * @param param The parameter name.
- * @returns True if the parameter has one or more values,
- * false if it has no value or is not present.
- */
- has(param) {
- this.init();
- return this.map.has(param);
- }
- /**
- * Retrieves the first value for a parameter.
- * @param param The parameter name.
- * @returns The first value of the given parameter,
- * or `null` if the parameter is not present.
- */
- get(param) {
- this.init();
- const res = this.map.get(param);
- return !!res ? res[0] : null;
- }
- /**
- * Retrieves all values for a parameter.
- * @param param The parameter name.
- * @returns All values in a string array,
- * or `null` if the parameter not present.
- */
- getAll(param) {
- this.init();
- return this.map.get(param) || null;
- }
- /**
- * Retrieves all the parameters for this body.
- * @returns The parameter names in a string array.
- */
- keys() {
- this.init();
- return Array.from(this.map.keys());
- }
- /**
- * Appends a new value to existing values for a parameter.
- * @param param The parameter name.
- * @param value The new value to add.
- * @return A new body with the appended value.
- */
- append(param, value) {
- return this.clone({ param, value, op: 'a' });
- }
- /**
- * Constructs a new body with appended values for the given parameter name.
- * @param params parameters and values
- * @return A new body with the new value.
- */
- appendAll(params) {
- const updates = [];
- Object.keys(params).forEach(param => {
- const value = params[param];
- if (Array.isArray(value)) {
- value.forEach(_value => {
- updates.push({ param, value: _value, op: 'a' });
- });
- }
- else {
- updates.push({ param, value: value, op: 'a' });
- }
- });
- return this.clone(updates);
- }
- /**
- * Replaces the value for a parameter.
- * @param param The parameter name.
- * @param value The new value.
- * @return A new body with the new value.
- */
- set(param, value) {
- return this.clone({ param, value, op: 's' });
- }
- /**
- * Removes a given value or all values from a parameter.
- * @param param The parameter name.
- * @param value The value to remove, if provided.
- * @return A new body with the given value removed, or with all values
- * removed if no value is specified.
- */
- delete(param, value) {
- return this.clone({ param, value, op: 'd' });
- }
- /**
- * Serializes the body to an encoded string, where key-value pairs (separated by `=`) are
- * separated by `&`s.
- */
- toString() {
- this.init();
- return this.keys()
- .map(key => {
- const eKey = this.encoder.encodeKey(key);
- // `a: ['1']` produces `'a=1'`
- // `b: []` produces `''`
- // `c: ['1', '2']` produces `'c=1&c=2'`
- return this.map.get(key).map(value => eKey + '=' + this.encoder.encodeValue(value))
- .join('&');
- })
- // filter out empty values because `b: []` produces `''`
- // which results in `a=1&&c=1&c=2` instead of `a=1&c=1&c=2` if we don't
- .filter(param => param !== '')
- .join('&');
- }
- clone(update) {
- const clone = new HttpParams({ encoder: this.encoder });
- clone.cloneFrom = this.cloneFrom || this;
- clone.updates = (this.updates || []).concat(update);
- return clone;
- }
- init() {
- if (this.map === null) {
- this.map = new Map();
- }
- if (this.cloneFrom !== null) {
- this.cloneFrom.init();
- this.cloneFrom.keys().forEach(key => this.map.set(key, this.cloneFrom.map.get(key)));
- this.updates.forEach(update => {
- switch (update.op) {
- case 'a':
- case 's':
- const base = (update.op === 'a' ? this.map.get(update.param) : undefined) || [];
- base.push(valueToString(update.value));
- this.map.set(update.param, base);
- break;
- case 'd':
- if (update.value !== undefined) {
- let base = this.map.get(update.param) || [];
- const idx = base.indexOf(valueToString(update.value));
- if (idx !== -1) {
- base.splice(idx, 1);
- }
- if (base.length > 0) {
- this.map.set(update.param, base);
- }
- else {
- this.map.delete(update.param);
- }
- }
- else {
- this.map.delete(update.param);
- break;
- }
- }
- });
- this.cloneFrom = this.updates = null;
- }
- }
- }
- /**
- * A token used to manipulate and access values stored in `HttpContext`.
- *
- * @publicApi
- */
- class HttpContextToken {
- constructor(defaultValue) {
- this.defaultValue = defaultValue;
- }
- }
- /**
- * Http context stores arbitrary user defined values and ensures type safety without
- * actually knowing the types. It is backed by a `Map` and guarantees that keys do not clash.
- *
- * This context is mutable and is shared between cloned requests unless explicitly specified.
- *
- * @usageNotes
- *
- * ### Usage Example
- *
- * ```typescript
- * // inside cache.interceptors.ts
- * export const IS_CACHE_ENABLED = new HttpContextToken<boolean>(() => false);
- *
- * export class CacheInterceptor implements HttpInterceptor {
- *
- * intercept(req: HttpRequest<any>, delegate: HttpHandler): Observable<HttpEvent<any>> {
- * if (req.context.get(IS_CACHE_ENABLED) === true) {
- * return ...;
- * }
- * return delegate.handle(req);
- * }
- * }
- *
- * // inside a service
- *
- * this.httpClient.get('/api/weather', {
- * context: new HttpContext().set(IS_CACHE_ENABLED, true)
- * }).subscribe(...);
- * ```
- *
- * @publicApi
- */
- class HttpContext {
- constructor() {
- this.map = new Map();
- }
- /**
- * Store a value in the context. If a value is already present it will be overwritten.
- *
- * @param token The reference to an instance of `HttpContextToken`.
- * @param value The value to store.
- *
- * @returns A reference to itself for easy chaining.
- */
- set(token, value) {
- this.map.set(token, value);
- return this;
- }
- /**
- * Retrieve the value associated with the given token.
- *
- * @param token The reference to an instance of `HttpContextToken`.
- *
- * @returns The stored value or default if one is defined.
- */
- get(token) {
- if (!this.map.has(token)) {
- this.map.set(token, token.defaultValue());
- }
- return this.map.get(token);
- }
- /**
- * Delete the value associated with the given token.
- *
- * @param token The reference to an instance of `HttpContextToken`.
- *
- * @returns A reference to itself for easy chaining.
- */
- delete(token) {
- this.map.delete(token);
- return this;
- }
- /**
- * Checks for existence of a given token.
- *
- * @param token The reference to an instance of `HttpContextToken`.
- *
- * @returns True if the token exists, false otherwise.
- */
- has(token) {
- return this.map.has(token);
- }
- /**
- * @returns a list of tokens currently stored in the context.
- */
- keys() {
- return this.map.keys();
- }
- }
- /**
- * Determine whether the given HTTP method may include a body.
- */
- function mightHaveBody(method) {
- switch (method) {
- case 'DELETE':
- case 'GET':
- case 'HEAD':
- case 'OPTIONS':
- case 'JSONP':
- return false;
- default:
- return true;
- }
- }
- /**
- * Safely assert whether the given value is an ArrayBuffer.
- *
- * In some execution environments ArrayBuffer is not defined.
- */
- function isArrayBuffer(value) {
- return typeof ArrayBuffer !== 'undefined' && value instanceof ArrayBuffer;
- }
- /**
- * Safely assert whether the given value is a Blob.
- *
- * In some execution environments Blob is not defined.
- */
- function isBlob(value) {
- return typeof Blob !== 'undefined' && value instanceof Blob;
- }
- /**
- * Safely assert whether the given value is a FormData instance.
- *
- * In some execution environments FormData is not defined.
- */
- function isFormData(value) {
- return typeof FormData !== 'undefined' && value instanceof FormData;
- }
- /**
- * Safely assert whether the given value is a URLSearchParams instance.
- *
- * In some execution environments URLSearchParams is not defined.
- */
- function isUrlSearchParams(value) {
- return typeof URLSearchParams !== 'undefined' && value instanceof URLSearchParams;
- }
- /**
- * An outgoing HTTP request with an optional typed body.
- *
- * `HttpRequest` represents an outgoing request, including URL, method,
- * headers, body, and other request configuration options. Instances should be
- * assumed to be immutable. To modify a `HttpRequest`, the `clone`
- * method should be used.
- *
- * @publicApi
- */
- class HttpRequest {
- constructor(method, url, third, fourth) {
- this.url = url;
- /**
- * The request body, or `null` if one isn't set.
- *
- * Bodies are not enforced to be immutable, as they can include a reference to any
- * user-defined data type. However, interceptors should take care to preserve
- * idempotence by treating them as such.
- */
- this.body = null;
- /**
- * Whether this request should be made in a way that exposes progress events.
- *
- * Progress events are expensive (change detection runs on each event) and so
- * they should only be requested if the consumer intends to monitor them.
- *
- * Note: The `FetchBackend` doesn't support progress report on uploads.
- */
- this.reportProgress = false;
- /**
- * Whether this request should be sent with outgoing credentials (cookies).
- */
- this.withCredentials = false;
- /**
- * The expected response type of the server.
- *
- * This is used to parse the response appropriately before returning it to
- * the requestee.
- */
- this.responseType = 'json';
- this.method = method.toUpperCase();
- // Next, need to figure out which argument holds the HttpRequestInit
- // options, if any.
- let options;
- // Check whether a body argument is expected. The only valid way to omit
- // the body argument is to use a known no-body method like GET.
- if (mightHaveBody(this.method) || !!fourth) {
- // Body is the third argument, options are the fourth.
- this.body = (third !== undefined) ? third : null;
- options = fourth;
- }
- else {
- // No body required, options are the third argument. The body stays null.
- options = third;
- }
- // If options have been passed, interpret them.
- if (options) {
- // Normalize reportProgress and withCredentials.
- this.reportProgress = !!options.reportProgress;
- this.withCredentials = !!options.withCredentials;
- // Override default response type of 'json' if one is provided.
- if (!!options.responseType) {
- this.responseType = options.responseType;
- }
- // Override headers if they're provided.
- if (!!options.headers) {
- this.headers = options.headers;
- }
- if (!!options.context) {
- this.context = options.context;
- }
- if (!!options.params) {
- this.params = options.params;
- }
- }
- // If no headers have been passed in, construct a new HttpHeaders instance.
- if (!this.headers) {
- this.headers = new HttpHeaders();
- }
- // If no context have been passed in, construct a new HttpContext instance.
- if (!this.context) {
- this.context = new HttpContext();
- }
- // If no parameters have been passed in, construct a new HttpUrlEncodedParams instance.
- if (!this.params) {
- this.params = new HttpParams();
- this.urlWithParams = url;
- }
- else {
- // Encode the parameters to a string in preparation for inclusion in the URL.
- const params = this.params.toString();
- if (params.length === 0) {
- // No parameters, the visible URL is just the URL given at creation time.
- this.urlWithParams = url;
- }
- else {
- // Does the URL already have query parameters? Look for '?'.
- const qIdx = url.indexOf('?');
- // There are 3 cases to handle:
- // 1) No existing parameters -> append '?' followed by params.
- // 2) '?' exists and is followed by existing query string ->
- // append '&' followed by params.
- // 3) '?' exists at the end of the url -> append params directly.
- // This basically amounts to determining the character, if any, with
- // which to join the URL and parameters.
- const sep = qIdx === -1 ? '?' : (qIdx < url.length - 1 ? '&' : '');
- this.urlWithParams = url + sep + params;
- }
- }
- }
- /**
- * Transform the free-form body into a serialized format suitable for
- * transmission to the server.
- */
- serializeBody() {
- // If no body is present, no need to serialize it.
- if (this.body === null) {
- return null;
- }
- // Check whether the body is already in a serialized form. If so,
- // it can just be returned directly.
- if (isArrayBuffer(this.body) || isBlob(this.body) || isFormData(this.body) ||
- isUrlSearchParams(this.body) || typeof this.body === 'string') {
- return this.body;
- }
- // Check whether the body is an instance of HttpUrlEncodedParams.
- if (this.body instanceof HttpParams) {
- return this.body.toString();
- }
- // Check whether the body is an object or array, and serialize with JSON if so.
- if (typeof this.body === 'object' || typeof this.body === 'boolean' ||
- Array.isArray(this.body)) {
- return JSON.stringify(this.body);
- }
- // Fall back on toString() for everything else.
- return this.body.toString();
- }
- /**
- * Examine the body and attempt to infer an appropriate MIME type
- * for it.
- *
- * If no such type can be inferred, this method will return `null`.
- */
- detectContentTypeHeader() {
- // An empty body has no content type.
- if (this.body === null) {
- return null;
- }
- // FormData bodies rely on the browser's content type assignment.
- if (isFormData(this.body)) {
- return null;
- }
- // Blobs usually have their own content type. If it doesn't, then
- // no type can be inferred.
- if (isBlob(this.body)) {
- return this.body.type || null;
- }
- // Array buffers have unknown contents and thus no type can be inferred.
- if (isArrayBuffer(this.body)) {
- return null;
- }
- // Technically, strings could be a form of JSON data, but it's safe enough
- // to assume they're plain strings.
- if (typeof this.body === 'string') {
- return 'text/plain';
- }
- // `HttpUrlEncodedParams` has its own content-type.
- if (this.body instanceof HttpParams) {
- return 'application/x-www-form-urlencoded;charset=UTF-8';
- }
- // Arrays, objects, boolean and numbers will be encoded as JSON.
- if (typeof this.body === 'object' || typeof this.body === 'number' ||
- typeof this.body === 'boolean') {
- return 'application/json';
- }
- // No type could be inferred.
- return null;
- }
- clone(update = {}) {
- // For method, url, and responseType, take the current value unless
- // it is overridden in the update hash.
- const method = update.method || this.method;
- const url = update.url || this.url;
- const responseType = update.responseType || this.responseType;
- // The body is somewhat special - a `null` value in update.body means
- // whatever current body is present is being overridden with an empty
- // body, whereas an `undefined` value in update.body implies no
- // override.
- const body = (update.body !== undefined) ? update.body : this.body;
- // Carefully handle the boolean options to differentiate between
- // `false` and `undefined` in the update args.
- const withCredentials = (update.withCredentials !== undefined) ? update.withCredentials : this.withCredentials;
- const reportProgress = (update.reportProgress !== undefined) ? update.reportProgress : this.reportProgress;
- // Headers and params may be appended to if `setHeaders` or
- // `setParams` are used.
- let headers = update.headers || this.headers;
- let params = update.params || this.params;
- // Pass on context if needed
- const context = update.context ?? this.context;
- // Check whether the caller has asked to add headers.
- if (update.setHeaders !== undefined) {
- // Set every requested header.
- headers =
- Object.keys(update.setHeaders)
- .reduce((headers, name) => headers.set(name, update.setHeaders[name]), headers);
- }
- // Check whether the caller has asked to set params.
- if (update.setParams) {
- // Set every requested param.
- params = Object.keys(update.setParams)
- .reduce((params, param) => params.set(param, update.setParams[param]), params);
- }
- // Finally, construct the new HttpRequest using the pieces from above.
- return new HttpRequest(method, url, body, {
- params,
- headers,
- context,
- reportProgress,
- responseType,
- withCredentials,
- });
- }
- }
- /**
- * Type enumeration for the different kinds of `HttpEvent`.
- *
- * @publicApi
- */
- var HttpEventType;
- (function (HttpEventType) {
- /**
- * The request was sent out over the wire.
- */
- HttpEventType[HttpEventType["Sent"] = 0] = "Sent";
- /**
- * An upload progress event was received.
- *
- * Note: The `FetchBackend` doesn't support progress report on uploads.
- */
- HttpEventType[HttpEventType["UploadProgress"] = 1] = "UploadProgress";
- /**
- * The response status code and headers were received.
- */
- HttpEventType[HttpEventType["ResponseHeader"] = 2] = "ResponseHeader";
- /**
- * A download progress event was received.
- */
- HttpEventType[HttpEventType["DownloadProgress"] = 3] = "DownloadProgress";
- /**
- * The full response including the body was received.
- */
- HttpEventType[HttpEventType["Response"] = 4] = "Response";
- /**
- * A custom event from an interceptor or a backend.
- */
- HttpEventType[HttpEventType["User"] = 5] = "User";
- })(HttpEventType || (HttpEventType = {}));
- /**
- * Base class for both `HttpResponse` and `HttpHeaderResponse`.
- *
- * @publicApi
- */
- class HttpResponseBase {
- /**
- * Super-constructor for all responses.
- *
- * The single parameter accepted is an initialization hash. Any properties
- * of the response passed there will override the default values.
- */
- constructor(init, defaultStatus = 200 /* HttpStatusCode.Ok */, defaultStatusText = 'OK') {
- // If the hash has values passed, use them to initialize the response.
- // Otherwise use the default values.
- this.headers = init.headers || new HttpHeaders();
- this.status = init.status !== undefined ? init.status : defaultStatus;
- this.statusText = init.statusText || defaultStatusText;
- this.url = init.url || null;
- // Cache the ok value to avoid defining a getter.
- this.ok = this.status >= 200 && this.status < 300;
- }
- }
- /**
- * A partial HTTP response which only includes the status and header data,
- * but no response body.
- *
- * `HttpHeaderResponse` is a `HttpEvent` available on the response
- * event stream, only when progress events are requested.
- *
- * @publicApi
- */
- class HttpHeaderResponse extends HttpResponseBase {
- /**
- * Create a new `HttpHeaderResponse` with the given parameters.
- */
- constructor(init = {}) {
- super(init);
- this.type = HttpEventType.ResponseHeader;
- }
- /**
- * Copy this `HttpHeaderResponse`, overriding its contents with the
- * given parameter hash.
- */
- clone(update = {}) {
- // Perform a straightforward initialization of the new HttpHeaderResponse,
- // overriding the current parameters with new ones if given.
- return new HttpHeaderResponse({
- headers: update.headers || this.headers,
- status: update.status !== undefined ? update.status : this.status,
- statusText: update.statusText || this.statusText,
- url: update.url || this.url || undefined,
- });
- }
- }
- /**
- * A full HTTP response, including a typed response body (which may be `null`
- * if one was not returned).
- *
- * `HttpResponse` is a `HttpEvent` available on the response event
- * stream.
- *
- * @publicApi
- */
- class HttpResponse extends HttpResponseBase {
- /**
- * Construct a new `HttpResponse`.
- */
- constructor(init = {}) {
- super(init);
- this.type = HttpEventType.Response;
- this.body = init.body !== undefined ? init.body : null;
- }
- clone(update = {}) {
- return new HttpResponse({
- body: (update.body !== undefined) ? update.body : this.body,
- headers: update.headers || this.headers,
- status: (update.status !== undefined) ? update.status : this.status,
- statusText: update.statusText || this.statusText,
- url: update.url || this.url || undefined,
- });
- }
- }
- /**
- * A response that represents an error or failure, either from a
- * non-successful HTTP status, an error while executing the request,
- * or some other failure which occurred during the parsing of the response.
- *
- * Any error returned on the `Observable` response stream will be
- * wrapped in an `HttpErrorResponse` to provide additional context about
- * the state of the HTTP layer when the error occurred. The error property
- * will contain either a wrapped Error object or the error response returned
- * from the server.
- *
- * @publicApi
- */
- class HttpErrorResponse extends HttpResponseBase {
- constructor(init) {
- // Initialize with a default status of 0 / Unknown Error.
- super(init, 0, 'Unknown Error');
- this.name = 'HttpErrorResponse';
- /**
- * Errors are never okay, even when the status code is in the 2xx success range.
- */
- this.ok = false;
- // If the response was successful, then this was a parse error. Otherwise, it was
- // a protocol-level failure of some sort. Either the request failed in transit
- // or the server returned an unsuccessful status code.
- if (this.status >= 200 && this.status < 300) {
- this.message = `Http failure during parsing for ${init.url || '(unknown url)'}`;
- }
- else {
- this.message = `Http failure response for ${init.url || '(unknown url)'}: ${init.status} ${init.statusText}`;
- }
- this.error = init.error || null;
- }
- }
- /**
- * Constructs an instance of `HttpRequestOptions<T>` from a source `HttpMethodOptions` and
- * the given `body`. This function clones the object and adds the body.
- *
- * Note that the `responseType` *options* value is a String that identifies the
- * single data type of the response.
- * A single overload version of the method handles each response type.
- * The value of `responseType` cannot be a union, as the combined signature could imply.
- *
- */
- function addBody(options, body) {
- return {
- body,
- headers: options.headers,
- context: options.context,
- observe: options.observe,
- params: options.params,
- reportProgress: options.reportProgress,
- responseType: options.responseType,
- withCredentials: options.withCredentials,
- };
- }
- /**
- * Performs HTTP requests.
- * This service is available as an injectable class, with methods to perform HTTP requests.
- * Each request method has multiple signatures, and the return type varies based on
- * the signature that is called (mainly the values of `observe` and `responseType`).
- *
- * Note that the `responseType` *options* value is a String that identifies the
- * single data type of the response.
- * A single overload version of the method handles each response type.
- * The value of `responseType` cannot be a union, as the combined signature could imply.
- *
- * @usageNotes
- * Sample HTTP requests for the [Tour of Heroes](/tutorial/tour-of-heroes/toh-pt0) application.
- *
- * ### HTTP Request Example
- *
- * ```
- * // GET heroes whose name contains search term
- * searchHeroes(term: string): observable<Hero[]>{
- *
- * const params = new HttpParams({fromString: 'name=term'});
- * return this.httpClient.request('GET', this.heroesUrl, {responseType:'json', params});
- * }
- * ```
- *
- * Alternatively, the parameter string can be used without invoking HttpParams
- * by directly joining to the URL.
- * ```
- * this.httpClient.request('GET', this.heroesUrl + '?' + 'name=term', {responseType:'json'});
- * ```
- *
- *
- * ### JSONP Example
- * ```
- * requestJsonp(url, callback = 'callback') {
- * return this.httpClient.jsonp(this.heroesURL, callback);
- * }
- * ```
- *
- * ### PATCH Example
- * ```
- * // PATCH one of the heroes' name
- * patchHero (id: number, heroName: string): Observable<{}> {
- * const url = `${this.heroesUrl}/${id}`; // PATCH api/heroes/42
- * return this.httpClient.patch(url, {name: heroName}, httpOptions)
- * .pipe(catchError(this.handleError('patchHero')));
- * }
- * ```
- *
- * @see [HTTP Guide](guide/understanding-communicating-with-http)
- * @see [HTTP Request](api/common/http/HttpRequest)
- *
- * @publicApi
- */
- class HttpClient {
- constructor(handler) {
- this.handler = handler;
- }
- /**
- * Constructs an observable for a generic HTTP request that, when subscribed,
- * fires the request through the chain of registered interceptors and on to the
- * server.
- *
- * You can pass an `HttpRequest` directly as the only parameter. In this case,
- * the call returns an observable of the raw `HttpEvent` stream.
- *
- * Alternatively you can pass an HTTP method as the first parameter,
- * a URL string as the second, and an options hash containing the request body as the third.
- * See `addBody()`. In this case, the specified `responseType` and `observe` options determine the
- * type of returned observable.
- * * The `responseType` value determines how a successful response body is parsed.
- * * If `responseType` is the default `json`, you can pass a type interface for the resulting
- * object as a type parameter to the call.
- *
- * The `observe` value determines the return type, according to what you are interested in
- * observing.
- * * An `observe` value of events returns an observable of the raw `HttpEvent` stream, including
- * progress events by default.
- * * An `observe` value of response returns an observable of `HttpResponse<T>`,
- * where the `T` parameter depends on the `responseType` and any optionally provided type
- * parameter.
- * * An `observe` value of body returns an observable of `<T>` with the same `T` body type.
- *
- */
- request(first, url, options = {}) {
- let req;
- // First, check whether the primary argument is an instance of `HttpRequest`.
- if (first instanceof HttpRequest) {
- // It is. The other arguments must be undefined (per the signatures) and can be
- // ignored.
- req = first;
- }
- else {
- // It's a string, so it represents a URL. Construct a request based on it,
- // and incorporate the remaining arguments (assuming `GET` unless a method is
- // provided.
- // Figure out the headers.
- let headers = undefined;
- if (options.headers instanceof HttpHeaders) {
- headers = options.headers;
- }
- else {
- headers = new HttpHeaders(options.headers);
- }
- // Sort out parameters.
- let params = undefined;
- if (!!options.params) {
- if (options.params instanceof HttpParams) {
- params = options.params;
- }
- else {
- params = new HttpParams({ fromObject: options.params });
- }
- }
- // Construct the request.
- req = new HttpRequest(first, url, (options.body !== undefined ? options.body : null), {
- headers,
- context: options.context,
- params,
- reportProgress: options.reportProgress,
- // By default, JSON is assumed to be returned for all calls.
- responseType: options.responseType || 'json',
- withCredentials: options.withCredentials,
- });
- }
- // Start with an Observable.of() the initial request, and run the handler (which
- // includes all interceptors) inside a concatMap(). This way, the handler runs
- // inside an Observable chain, which causes interceptors to be re-run on every
- // subscription (this also makes retries re-run the handler, including interceptors).
- const events$ = of(req).pipe(concatMap((req) => this.handler.handle(req)));
- // If coming via the API signature which accepts a previously constructed HttpRequest,
- // the only option is to get the event stream. Otherwise, return the event stream if
- // that is what was requested.
- if (first instanceof HttpRequest || options.observe === 'events') {
- return events$;
- }
- // The requested stream contains either the full response or the body. In either
- // case, the first step is to filter the event stream to extract a stream of
- // responses(s).
- const res$ = events$.pipe(filter((event) => event instanceof HttpResponse));
- // Decide which stream to return.
- switch (options.observe || 'body') {
- case 'body':
- // The requested stream is the body. Map the response stream to the response
- // body. This could be done more simply, but a misbehaving interceptor might
- // transform the response body into a different format and ignore the requested
- // responseType. Guard against this by validating that the response is of the
- // requested type.
- switch (req.responseType) {
- case 'arraybuffer':
- return res$.pipe(map((res) => {
- // Validate that the body is an ArrayBuffer.
- if (res.body !== null && !(res.body instanceof ArrayBuffer)) {
- throw new Error('Response is not an ArrayBuffer.');
- }
- return res.body;
- }));
- case 'blob':
- return res$.pipe(map((res) => {
- // Validate that the body is a Blob.
- if (res.body !== null && !(res.body instanceof Blob)) {
- throw new Error('Response is not a Blob.');
- }
- return res.body;
- }));
- case 'text':
- return res$.pipe(map((res) => {
- // Validate that the body is a string.
- if (res.body !== null && typeof res.body !== 'string') {
- throw new Error('Response is not a string.');
- }
- return res.body;
- }));
- case 'json':
- default:
- // No validation needed for JSON responses, as they can be of any type.
- return res$.pipe(map((res) => res.body));
- }
- case 'response':
- // The response stream was requested directly, so return it.
- return res$;
- default:
- // Guard against new future observe types being added.
- throw new Error(`Unreachable: unhandled observe type ${options.observe}}`);
- }
- }
- /**
- * Constructs an observable that, when subscribed, causes the configured
- * `DELETE` request to execute on the server. See the individual overloads for
- * details on the return type.
- *
- * @param url The endpoint URL.
- * @param options The HTTP options to send with the request.
- *
- */
- delete(url, options = {}) {
- return this.request('DELETE', url, options);
- }
- /**
- * Constructs an observable that, when subscribed, causes the configured
- * `GET` request to execute on the server. See the individual overloads for
- * details on the return type.
- */
- get(url, options = {}) {
- return this.request('GET', url, options);
- }
- /**
- * Constructs an observable that, when subscribed, causes the configured
- * `HEAD` request to execute on the server. The `HEAD` method returns
- * meta information about the resource without transferring the
- * resource itself. See the individual overloads for
- * details on the return type.
- */
- head(url, options = {}) {
- return this.request('HEAD', url, options);
- }
- /**
- * Constructs an `Observable` that, when subscribed, causes a request with the special method
- * `JSONP` to be dispatched via the interceptor pipeline.
- * The [JSONP pattern](https://en.wikipedia.org/wiki/JSONP) works around limitations of certain
- * API endpoints that don't support newer,
- * and preferable [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) protocol.
- * JSONP treats the endpoint API as a JavaScript file and tricks the browser to process the
- * requests even if the API endpoint is not located on the same domain (origin) as the client-side
- * application making the request.
- * The endpoint API must support JSONP callback for JSONP requests to work.
- * The resource API returns the JSON response wrapped in a callback function.
- * You can pass the callback function name as one of the query parameters.
- * Note that JSONP requests can only be used with `GET` requests.
- *
- * @param url The resource URL.
- * @param callbackParam The callback function name.
- *
- */
- jsonp(url, callbackParam) {
- return this.request('JSONP', url, {
- params: new HttpParams().append(callbackParam, 'JSONP_CALLBACK'),
- observe: 'body',
- responseType: 'json',
- });
- }
- /**
- * Constructs an `Observable` that, when subscribed, causes the configured
- * `OPTIONS` request to execute on the server. This method allows the client
- * to determine the supported HTTP methods and other capabilities of an endpoint,
- * without implying a resource action. See the individual overloads for
- * details on the return type.
- */
- options(url, options = {}) {
- return this.request('OPTIONS', url, options);
- }
- /**
- * Constructs an observable that, when subscribed, causes the configured
- * `PATCH` request to execute on the server. See the individual overloads for
- * details on the return type.
- */
- patch(url, body, options = {}) {
- return this.request('PATCH', url, addBody(options, body));
- }
- /**
- * Constructs an observable that, when subscribed, causes the configured
- * `POST` request to execute on the server. The server responds with the location of
- * the replaced resource. See the individual overloads for
- * details on the return type.
- */
- post(url, body, options = {}) {
- return this.request('POST', url, addBody(options, body));
- }
- /**
- * Constructs an observable that, when subscribed, causes the configured
- * `PUT` request to execute on the server. The `PUT` method replaces an existing resource
- * with a new set of values.
- * See the individual overloads for details on the return type.
- */
- put(url, body, options = {}) {
- return this.request('PUT', url, addBody(options, body));
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClient, deps: [{ token: HttpHandler }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClient }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClient, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: HttpHandler }]; } });
- const XSSI_PREFIX$1 = /^\)\]\}',?\n/;
- const REQUEST_URL_HEADER = `X-Request-URL`;
- /**
- * Determine an appropriate URL for the response, by checking either
- * response url or the X-Request-URL header.
- */
- function getResponseUrl$1(response) {
- if (response.url) {
- return response.url;
- }
- // stored as lowercase in the map
- const xRequestUrl = REQUEST_URL_HEADER.toLocaleLowerCase();
- return response.headers.get(xRequestUrl);
- }
- /**
- * Uses `fetch` to send requests to a backend server.
- *
- * This `FetchBackend` requires the support of the
- * [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) which is available on all
- * supported browsers and on Node.js v18 or later.
- *
- * @see {@link HttpHandler}
- *
- * @publicApi
- * @developerPreview
- */
- class FetchBackend {
- constructor() {
- // We need to bind the native fetch to its context or it will throw an "illegal invocation"
- this.fetchImpl = inject(FetchFactory, { optional: true })?.fetch ?? fetch.bind(globalThis);
- this.ngZone = inject(NgZone);
- }
- handle(request) {
- return new Observable(observer => {
- const aborter = new AbortController();
- this.doRequest(request, aborter.signal, observer)
- .then(noop, error => observer.error(new HttpErrorResponse({ error })));
- return () => aborter.abort();
- });
- }
- async doRequest(request, signal, observer) {
- const init = this.createRequestInit(request);
- let response;
- try {
- const fetchPromise = this.fetchImpl(request.urlWithParams, { signal, ...init });
- // Make sure Zone.js doesn't trigger false-positive unhandled promise
- // error in case the Promise is rejected synchronously. See function
- // description for additional information.
- silenceSuperfluousUnhandledPromiseRejection(fetchPromise);
- // Send the `Sent` event before awaiting the response.
- observer.next({ type: HttpEventType.Sent });
- response = await fetchPromise;
- }
- catch (error) {
- observer.error(new HttpErrorResponse({
- error,
- status: error.status ?? 0,
- statusText: error.statusText,
- url: request.urlWithParams,
- headers: error.headers,
- }));
- return;
- }
- const headers = new HttpHeaders(response.headers);
- const statusText = response.statusText;
- const url = getResponseUrl$1(response) ?? request.urlWithParams;
- let status = response.status;
- let body = null;
- if (request.reportProgress) {
- observer.next(new HttpHeaderResponse({ headers, status, statusText, url }));
- }
- if (response.body) {
- // Read Progress
- const contentLength = response.headers.get('content-length');
- const chunks = [];
- const reader = response.body.getReader();
- let receivedLength = 0;
- let decoder;
- let partialText;
- // We have to check whether the Zone is defined in the global scope because this may be called
- // when the zone is nooped.
- const reqZone = typeof Zone !== 'undefined' && Zone.current;
- // Perform response processing outside of Angular zone to
- // ensure no excessive change detection runs are executed
- // Here calling the async ReadableStreamDefaultReader.read() is responsible for triggering CD
- await this.ngZone.runOutsideAngular(async () => {
- while (true) {
- const { done, value } = await reader.read();
- if (done) {
- break;
- }
- chunks.push(value);
- receivedLength += value.length;
- if (request.reportProgress) {
- partialText = request.responseType === 'text' ?
- (partialText ?? '') + (decoder ??= new TextDecoder).decode(value, { stream: true }) :
- undefined;
- const reportProgress = () => observer.next({
- type: HttpEventType.DownloadProgress,
- total: contentLength ? +contentLength : undefined,
- loaded: receivedLength,
- partialText,
- });
- reqZone ? reqZone.run(reportProgress) : reportProgress();
- }
- }
- });
- // Combine all chunks.
- const chunksAll = this.concatChunks(chunks, receivedLength);
- try {
- body = this.parseBody(request, chunksAll);
- }
- catch (error) {
- // Body loading or parsing failed
- observer.error(new HttpErrorResponse({
- error,
- headers: new HttpHeaders(response.headers),
- status: response.status,
- statusText: response.statusText,
- url: getResponseUrl$1(response) ?? request.urlWithParams,
- }));
- return;
- }
- }
- // Same behavior as the XhrBackend
- if (status === 0) {
- status = body ? 200 /* HttpStatusCode.Ok */ : 0;
- }
- // ok determines whether the response will be transmitted on the event or
- // error channel. Unsuccessful status codes (not 2xx) will always be errors,
- // but a successful status code can still result in an error if the user
- // asked for JSON data and the body cannot be parsed as such.
- const ok = status >= 200 && status < 300;
- if (ok) {
- observer.next(new HttpResponse({
- body,
- headers,
- status,
- statusText,
- url,
- }));
- // The full body has been received and delivered, no further events
- // are possible. This request is complete.
- observer.complete();
- }
- else {
- observer.error(new HttpErrorResponse({
- error: body,
- headers,
- status,
- statusText,
- url,
- }));
- }
- }
- parseBody(request, binContent) {
- switch (request.responseType) {
- case 'json':
- // stripping the XSSI when present
- const text = new TextDecoder().decode(binContent).replace(XSSI_PREFIX$1, '');
- return text === '' ? null : JSON.parse(text);
- case 'text':
- return new TextDecoder().decode(binContent);
- case 'blob':
- return new Blob([binContent]);
- case 'arraybuffer':
- return binContent.buffer;
- }
- }
- createRequestInit(req) {
- // We could share some of this logic with the XhrBackend
- const headers = {};
- const credentials = req.withCredentials ? 'include' : undefined;
- // Setting all the requested headers.
- req.headers.forEach((name, values) => (headers[name] = values.join(',')));
- // Add an Accept header if one isn't present already.
- headers['Accept'] ??= 'application/json, text/plain, */*';
- // Auto-detect the Content-Type header if one isn't present already.
- if (!headers['Content-Type']) {
- const detectedType = req.detectContentTypeHeader();
- // Sometimes Content-Type detection fails.
- if (detectedType !== null) {
- headers['Content-Type'] = detectedType;
- }
- }
- return {
- body: req.serializeBody(),
- method: req.method,
- headers,
- credentials,
- };
- }
- concatChunks(chunks, totalLength) {
- const chunksAll = new Uint8Array(totalLength);
- let position = 0;
- for (const chunk of chunks) {
- chunksAll.set(chunk, position);
- position += chunk.length;
- }
- return chunksAll;
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: FetchBackend, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: FetchBackend }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: FetchBackend, decorators: [{
- type: Injectable
- }] });
- /**
- * Abstract class to provide a mocked implementation of `fetch()`
- */
- class FetchFactory {
- }
- function noop() { }
- /**
- * Zone.js treats a rejected promise that has not yet been awaited
- * as an unhandled error. This function adds a noop `.then` to make
- * sure that Zone.js doesn't throw an error if the Promise is rejected
- * synchronously.
- */
- function silenceSuperfluousUnhandledPromiseRejection(promise) {
- promise.then(noop, noop);
- }
- function interceptorChainEndFn(req, finalHandlerFn) {
- return finalHandlerFn(req);
- }
- /**
- * Constructs a `ChainedInterceptorFn` which adapts a legacy `HttpInterceptor` to the
- * `ChainedInterceptorFn` interface.
- */
- function adaptLegacyInterceptorToChain(chainTailFn, interceptor) {
- return (initialRequest, finalHandlerFn) => interceptor.intercept(initialRequest, {
- handle: (downstreamRequest) => chainTailFn(downstreamRequest, finalHandlerFn),
- });
- }
- /**
- * Constructs a `ChainedInterceptorFn` which wraps and invokes a functional interceptor in the given
- * injector.
- */
- function chainedInterceptorFn(chainTailFn, interceptorFn, injector) {
- // clang-format off
- return (initialRequest, finalHandlerFn) => injector.runInContext(() => interceptorFn(initialRequest, downstreamRequest => chainTailFn(downstreamRequest, finalHandlerFn)));
- // clang-format on
- }
- /**
- * A multi-provider token that represents the array of registered
- * `HttpInterceptor` objects.
- *
- * @publicApi
- */
- const HTTP_INTERCEPTORS = new InjectionToken(ngDevMode ? 'HTTP_INTERCEPTORS' : '');
- /**
- * A multi-provided token of `HttpInterceptorFn`s.
- */
- const HTTP_INTERCEPTOR_FNS = new InjectionToken(ngDevMode ? 'HTTP_INTERCEPTOR_FNS' : '');
- /**
- * A multi-provided token of `HttpInterceptorFn`s that are only set in root.
- */
- const HTTP_ROOT_INTERCEPTOR_FNS = new InjectionToken(ngDevMode ? 'HTTP_ROOT_INTERCEPTOR_FNS' : '');
- /**
- * Creates an `HttpInterceptorFn` which lazily initializes an interceptor chain from the legacy
- * class-based interceptors and runs the request through it.
- */
- function legacyInterceptorFnFactory() {
- let chain = null;
- return (req, handler) => {
- if (chain === null) {
- const interceptors = inject(HTTP_INTERCEPTORS, { optional: true }) ?? [];
- // Note: interceptors are wrapped right-to-left so that final execution order is
- // left-to-right. That is, if `interceptors` is the array `[a, b, c]`, we want to
- // produce a chain that is conceptually `c(b(a(end)))`, which we build from the inside
- // out.
- chain = interceptors.reduceRight(adaptLegacyInterceptorToChain, interceptorChainEndFn);
- }
- const pendingTasks = inject(ɵInitialRenderPendingTasks);
- const taskId = pendingTasks.add();
- return chain(req, handler).pipe(finalize(() => pendingTasks.remove(taskId)));
- };
- }
- class HttpInterceptorHandler extends HttpHandler {
- constructor(backend, injector) {
- super();
- this.backend = backend;
- this.injector = injector;
- this.chain = null;
- this.pendingTasks = inject(ɵInitialRenderPendingTasks);
- }
- handle(initialRequest) {
- if (this.chain === null) {
- const dedupedInterceptorFns = Array.from(new Set([
- ...this.injector.get(HTTP_INTERCEPTOR_FNS),
- ...this.injector.get(HTTP_ROOT_INTERCEPTOR_FNS, []),
- ]));
- // Note: interceptors are wrapped right-to-left so that final execution order is
- // left-to-right. That is, if `dedupedInterceptorFns` is the array `[a, b, c]`, we want to
- // produce a chain that is conceptually `c(b(a(end)))`, which we build from the inside
- // out.
- this.chain = dedupedInterceptorFns.reduceRight((nextSequencedFn, interceptorFn) => chainedInterceptorFn(nextSequencedFn, interceptorFn, this.injector), interceptorChainEndFn);
- }
- const taskId = this.pendingTasks.add();
- return this.chain(initialRequest, downstreamRequest => this.backend.handle(downstreamRequest))
- .pipe(finalize(() => this.pendingTasks.remove(taskId)));
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpInterceptorHandler, deps: [{ token: HttpBackend }, { token: i0.EnvironmentInjector }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpInterceptorHandler }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpInterceptorHandler, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: HttpBackend }, { type: i0.EnvironmentInjector }]; } });
- // Every request made through JSONP needs a callback name that's unique across the
- // whole page. Each request is assigned an id and the callback name is constructed
- // from that. The next id to be assigned is tracked in a global variable here that
- // is shared among all applications on the page.
- let nextRequestId = 0;
- /**
- * When a pending <script> is unsubscribed we'll move it to this document, so it won't be
- * executed.
- */
- let foreignDocument;
- // Error text given when a JSONP script is injected, but doesn't invoke the callback
- // passed in its URL.
- const JSONP_ERR_NO_CALLBACK = 'JSONP injected script did not invoke callback.';
- // Error text given when a request is passed to the JsonpClientBackend that doesn't
- // have a request method JSONP.
- const JSONP_ERR_WRONG_METHOD = 'JSONP requests must use JSONP request method.';
- const JSONP_ERR_WRONG_RESPONSE_TYPE = 'JSONP requests must use Json response type.';
- // Error text given when a request is passed to the JsonpClientBackend that has
- // headers set
- const JSONP_ERR_HEADERS_NOT_SUPPORTED = 'JSONP requests do not support headers.';
- /**
- * DI token/abstract type representing a map of JSONP callbacks.
- *
- * In the browser, this should always be the `window` object.
- *
- *
- */
- class JsonpCallbackContext {
- }
- /**
- * Factory function that determines where to store JSONP callbacks.
- *
- * Ordinarily JSONP callbacks are stored on the `window` object, but this may not exist
- * in test environments. In that case, callbacks are stored on an anonymous object instead.
- *
- *
- */
- function jsonpCallbackContext() {
- if (typeof window === 'object') {
- return window;
- }
- return {};
- }
- /**
- * Processes an `HttpRequest` with the JSONP method,
- * by performing JSONP style requests.
- * @see {@link HttpHandler}
- * @see {@link HttpXhrBackend}
- *
- * @publicApi
- */
- class JsonpClientBackend {
- constructor(callbackMap, document) {
- this.callbackMap = callbackMap;
- this.document = document;
- /**
- * A resolved promise that can be used to schedule microtasks in the event handlers.
- */
- this.resolvedPromise = Promise.resolve();
- }
- /**
- * Get the name of the next callback method, by incrementing the global `nextRequestId`.
- */
- nextCallback() {
- return `ng_jsonp_callback_${nextRequestId++}`;
- }
- /**
- * Processes a JSONP request and returns an event stream of the results.
- * @param req The request object.
- * @returns An observable of the response events.
- *
- */
- handle(req) {
- // Firstly, check both the method and response type. If either doesn't match
- // then the request was improperly routed here and cannot be handled.
- if (req.method !== 'JSONP') {
- throw new Error(JSONP_ERR_WRONG_METHOD);
- }
- else if (req.responseType !== 'json') {
- throw new Error(JSONP_ERR_WRONG_RESPONSE_TYPE);
- }
- // Check the request headers. JSONP doesn't support headers and
- // cannot set any that were supplied.
- if (req.headers.keys().length > 0) {
- throw new Error(JSONP_ERR_HEADERS_NOT_SUPPORTED);
- }
- // Everything else happens inside the Observable boundary.
- return new Observable((observer) => {
- // The first step to make a request is to generate the callback name, and replace the
- // callback placeholder in the URL with the name. Care has to be taken here to ensure
- // a trailing &, if matched, gets inserted back into the URL in the correct place.
- const callback = this.nextCallback();
- const url = req.urlWithParams.replace(/=JSONP_CALLBACK(&|$)/, `=${callback}$1`);
- // Construct the <script> tag and point it at the URL.
- const node = this.document.createElement('script');
- node.src = url;
- // A JSONP request requires waiting for multiple callbacks. These variables
- // are closed over and track state across those callbacks.
- // The response object, if one has been received, or null otherwise.
- let body = null;
- // Whether the response callback has been called.
- let finished = false;
- // Set the response callback in this.callbackMap (which will be the window
- // object in the browser. The script being loaded via the <script> tag will
- // eventually call this callback.
- this.callbackMap[callback] = (data) => {
- // Data has been received from the JSONP script. Firstly, delete this callback.
- delete this.callbackMap[callback];
- // Set state to indicate data was received.
- body = data;
- finished = true;
- };
- // cleanup() is a utility closure that removes the <script> from the page and
- // the response callback from the window. This logic is used in both the
- // success, error, and cancellation paths, so it's extracted out for convenience.
- const cleanup = () => {
- // Remove the <script> tag if it's still on the page.
- if (node.parentNode) {
- node.parentNode.removeChild(node);
- }
- // Remove the response callback from the callbackMap (window object in the
- // browser).
- delete this.callbackMap[callback];
- };
- // onLoad() is the success callback which runs after the response callback
- // if the JSONP script loads successfully. The event itself is unimportant.
- // If something went wrong, onLoad() may run without the response callback
- // having been invoked.
- const onLoad = (event) => {
- // We wrap it in an extra Promise, to ensure the microtask
- // is scheduled after the loaded endpoint has executed any potential microtask itself,
- // which is not guaranteed in Internet Explorer and EdgeHTML. See issue #39496
- this.resolvedPromise.then(() => {
- // Cleanup the page.
- cleanup();
- // Check whether the response callback has run.
- if (!finished) {
- // It hasn't, something went wrong with the request. Return an error via
- // the Observable error path. All JSONP errors have status 0.
- observer.error(new HttpErrorResponse({
- url,
- status: 0,
- statusText: 'JSONP Error',
- error: new Error(JSONP_ERR_NO_CALLBACK),
- }));
- return;
- }
- // Success. body either contains the response body or null if none was
- // returned.
- observer.next(new HttpResponse({
- body,
- status: 200 /* HttpStatusCode.Ok */,
- statusText: 'OK',
- url,
- }));
- // Complete the stream, the response is over.
- observer.complete();
- });
- };
- // onError() is the error callback, which runs if the script returned generates
- // a Javascript error. It emits the error via the Observable error channel as
- // a HttpErrorResponse.
- const onError = (error) => {
- cleanup();
- // Wrap the error in a HttpErrorResponse.
- observer.error(new HttpErrorResponse({
- error,
- status: 0,
- statusText: 'JSONP Error',
- url,
- }));
- };
- // Subscribe to both the success (load) and error events on the <script> tag,
- // and add it to the page.
- node.addEventListener('load', onLoad);
- node.addEventListener('error', onError);
- this.document.body.appendChild(node);
- // The request has now been successfully sent.
- observer.next({ type: HttpEventType.Sent });
- // Cancellation handler.
- return () => {
- if (!finished) {
- this.removeListeners(node);
- }
- // And finally, clean up the page.
- cleanup();
- };
- });
- }
- removeListeners(script) {
- // Issue #34818
- // Changing <script>'s ownerDocument will prevent it from execution.
- // https://html.spec.whatwg.org/multipage/scripting.html#execute-the-script-block
- if (!foreignDocument) {
- foreignDocument = this.document.implementation.createHTMLDocument();
- }
- foreignDocument.adoptNode(script);
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: JsonpClientBackend, deps: [{ token: JsonpCallbackContext }, { token: DOCUMENT }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: JsonpClientBackend }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: JsonpClientBackend, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: JsonpCallbackContext }, { type: undefined, decorators: [{
- type: Inject,
- args: [DOCUMENT]
- }] }]; } });
- /**
- * Identifies requests with the method JSONP and shifts them to the `JsonpClientBackend`.
- */
- function jsonpInterceptorFn(req, next) {
- if (req.method === 'JSONP') {
- return inject(JsonpClientBackend).handle(req);
- }
- // Fall through for normal HTTP requests.
- return next(req);
- }
- /**
- * Identifies requests with the method JSONP and
- * shifts them to the `JsonpClientBackend`.
- *
- * @see {@link HttpInterceptor}
- *
- * @publicApi
- */
- class JsonpInterceptor {
- constructor(injector) {
- this.injector = injector;
- }
- /**
- * Identifies and handles a given JSONP request.
- * @param initialRequest The outgoing request object to handle.
- * @param next The next interceptor in the chain, or the backend
- * if no interceptors remain in the chain.
- * @returns An observable of the event stream.
- */
- intercept(initialRequest, next) {
- return this.injector.runInContext(() => jsonpInterceptorFn(initialRequest, downstreamRequest => next.handle(downstreamRequest)));
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: JsonpInterceptor, deps: [{ token: i0.EnvironmentInjector }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: JsonpInterceptor }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: JsonpInterceptor, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: i0.EnvironmentInjector }]; } });
- const XSSI_PREFIX = /^\)\]\}',?\n/;
- /**
- * Determine an appropriate URL for the response, by checking either
- * XMLHttpRequest.responseURL or the X-Request-URL header.
- */
- function getResponseUrl(xhr) {
- if ('responseURL' in xhr && xhr.responseURL) {
- return xhr.responseURL;
- }
- if (/^X-Request-URL:/m.test(xhr.getAllResponseHeaders())) {
- return xhr.getResponseHeader('X-Request-URL');
- }
- return null;
- }
- /**
- * Uses `XMLHttpRequest` to send requests to a backend server.
- * @see {@link HttpHandler}
- * @see {@link JsonpClientBackend}
- *
- * @publicApi
- */
- class HttpXhrBackend {
- constructor(xhrFactory) {
- this.xhrFactory = xhrFactory;
- }
- /**
- * Processes a request and returns a stream of response events.
- * @param req The request object.
- * @returns An observable of the response events.
- */
- handle(req) {
- // Quick check to give a better error message when a user attempts to use
- // HttpClient.jsonp() without installing the HttpClientJsonpModule
- if (req.method === 'JSONP') {
- throw new ɵRuntimeError(-2800 /* RuntimeErrorCode.MISSING_JSONP_MODULE */, (typeof ngDevMode === 'undefined' || ngDevMode) &&
- `Cannot make a JSONP request without JSONP support. To fix the problem, either add the \`withJsonpSupport()\` call (if \`provideHttpClient()\` is used) or import the \`HttpClientJsonpModule\` in the root NgModule.`);
- }
- // Check whether this factory has a special function to load an XHR implementation
- // for various non-browser environments. We currently limit it to only `ServerXhr`
- // class, which needs to load an XHR implementation.
- const xhrFactory = this.xhrFactory;
- const source = xhrFactory.ɵloadImpl ? from(xhrFactory.ɵloadImpl()) : of(null);
- return source.pipe(switchMap(() => {
- // Everything happens on Observable subscription.
- return new Observable((observer) => {
- // Start by setting up the XHR object with request method, URL, and withCredentials
- // flag.
- const xhr = xhrFactory.build();
- xhr.open(req.method, req.urlWithParams);
- if (req.withCredentials) {
- xhr.withCredentials = true;
- }
- // Add all the requested headers.
- req.headers.forEach((name, values) => xhr.setRequestHeader(name, values.join(',')));
- // Add an Accept header if one isn't present already.
- if (!req.headers.has('Accept')) {
- xhr.setRequestHeader('Accept', 'application/json, text/plain, */*');
- }
- // Auto-detect the Content-Type header if one isn't present already.
- if (!req.headers.has('Content-Type')) {
- const detectedType = req.detectContentTypeHeader();
- // Sometimes Content-Type detection fails.
- if (detectedType !== null) {
- xhr.setRequestHeader('Content-Type', detectedType);
- }
- }
- // Set the responseType if one was requested.
- if (req.responseType) {
- const responseType = req.responseType.toLowerCase();
- // JSON responses need to be processed as text. This is because if the server
- // returns an XSSI-prefixed JSON response, the browser will fail to parse it,
- // xhr.response will be null, and xhr.responseText cannot be accessed to
- // retrieve the prefixed JSON data in order to strip the prefix. Thus, all JSON
- // is parsed by first requesting text and then applying JSON.parse.
- xhr.responseType = ((responseType !== 'json') ? responseType : 'text');
- }
- // Serialize the request body if one is present. If not, this will be set to null.
- const reqBody = req.serializeBody();
- // If progress events are enabled, response headers will be delivered
- // in two events - the HttpHeaderResponse event and the full HttpResponse
- // event. However, since response headers don't change in between these
- // two events, it doesn't make sense to parse them twice. So headerResponse
- // caches the data extracted from the response whenever it's first parsed,
- // to ensure parsing isn't duplicated.
- let headerResponse = null;
- // partialFromXhr extracts the HttpHeaderResponse from the current XMLHttpRequest
- // state, and memoizes it into headerResponse.
- const partialFromXhr = () => {
- if (headerResponse !== null) {
- return headerResponse;
- }
- const statusText = xhr.statusText || 'OK';
- // Parse headers from XMLHttpRequest - this step is lazy.
- const headers = new HttpHeaders(xhr.getAllResponseHeaders());
- // Read the response URL from the XMLHttpResponse instance and fall back on the
- // request URL.
- const url = getResponseUrl(xhr) || req.url;
- // Construct the HttpHeaderResponse and memoize it.
- headerResponse =
- new HttpHeaderResponse({ headers, status: xhr.status, statusText, url });
- return headerResponse;
- };
- // Next, a few closures are defined for the various events which XMLHttpRequest can
- // emit. This allows them to be unregistered as event listeners later.
- // First up is the load event, which represents a response being fully available.
- const onLoad = () => {
- // Read response state from the memoized partial data.
- let { headers, status, statusText, url } = partialFromXhr();
- // The body will be read out if present.
- let body = null;
- if (status !== 204 /* HttpStatusCode.NoContent */) {
- // Use XMLHttpRequest.response if set, responseText otherwise.
- body = (typeof xhr.response === 'undefined') ? xhr.responseText : xhr.response;
- }
- // Normalize another potential bug (this one comes from CORS).
- if (status === 0) {
- status = !!body ? 200 /* HttpStatusCode.Ok */ : 0;
- }
- // ok determines whether the response will be transmitted on the event or
- // error channel. Unsuccessful status codes (not 2xx) will always be errors,
- // but a successful status code can still result in an error if the user
- // asked for JSON data and the body cannot be parsed as such.
- let ok = status >= 200 && status < 300;
- // Check whether the body needs to be parsed as JSON (in many cases the browser
- // will have done that already).
- if (req.responseType === 'json' && typeof body === 'string') {
- // Save the original body, before attempting XSSI prefix stripping.
- const originalBody = body;
- body = body.replace(XSSI_PREFIX, '');
- try {
- // Attempt the parse. If it fails, a parse error should be delivered to the
- // user.
- body = body !== '' ? JSON.parse(body) : null;
- }
- catch (error) {
- // Since the JSON.parse failed, it's reasonable to assume this might not have
- // been a JSON response. Restore the original body (including any XSSI prefix)
- // to deliver a better error response.
- body = originalBody;
- // If this was an error request to begin with, leave it as a string, it
- // probably just isn't JSON. Otherwise, deliver the parsing error to the user.
- if (ok) {
- // Even though the response status was 2xx, this is still an error.
- ok = false;
- // The parse error contains the text of the body that failed to parse.
- body = { error, text: body };
- }
- }
- }
- if (ok) {
- // A successful response is delivered on the event stream.
- observer.next(new HttpResponse({
- body,
- headers,
- status,
- statusText,
- url: url || undefined,
- }));
- // The full body has been received and delivered, no further events
- // are possible. This request is complete.
- observer.complete();
- }
- else {
- // An unsuccessful request is delivered on the error channel.
- observer.error(new HttpErrorResponse({
- // The error in this case is the response body (error from the server).
- error: body,
- headers,
- status,
- statusText,
- url: url || undefined,
- }));
- }
- };
- // The onError callback is called when something goes wrong at the network level.
- // Connection timeout, DNS error, offline, etc. These are actual errors, and are
- // transmitted on the error channel.
- const onError = (error) => {
- const { url } = partialFromXhr();
- const res = new HttpErrorResponse({
- error,
- status: xhr.status || 0,
- statusText: xhr.statusText || 'Unknown Error',
- url: url || undefined,
- });
- observer.error(res);
- };
- // The sentHeaders flag tracks whether the HttpResponseHeaders event
- // has been sent on the stream. This is necessary to track if progress
- // is enabled since the event will be sent on only the first download
- // progress event.
- let sentHeaders = false;
- // The download progress event handler, which is only registered if
- // progress events are enabled.
- const onDownProgress = (event) => {
- // Send the HttpResponseHeaders event if it hasn't been sent already.
- if (!sentHeaders) {
- observer.next(partialFromXhr());
- sentHeaders = true;
- }
- // Start building the download progress event to deliver on the response
- // event stream.
- let progressEvent = {
- type: HttpEventType.DownloadProgress,
- loaded: event.loaded,
- };
- // Set the total number of bytes in the event if it's available.
- if (event.lengthComputable) {
- progressEvent.total = event.total;
- }
- // If the request was for text content and a partial response is
- // available on XMLHttpRequest, include it in the progress event
- // to allow for streaming reads.
- if (req.responseType === 'text' && !!xhr.responseText) {
- progressEvent.partialText = xhr.responseText;
- }
- // Finally, fire the event.
- observer.next(progressEvent);
- };
- // The upload progress event handler, which is only registered if
- // progress events are enabled.
- const onUpProgress = (event) => {
- // Upload progress events are simpler. Begin building the progress
- // event.
- let progress = {
- type: HttpEventType.UploadProgress,
- loaded: event.loaded,
- };
- // If the total number of bytes being uploaded is available, include
- // it.
- if (event.lengthComputable) {
- progress.total = event.total;
- }
- // Send the event.
- observer.next(progress);
- };
- // By default, register for load and error events.
- xhr.addEventListener('load', onLoad);
- xhr.addEventListener('error', onError);
- xhr.addEventListener('timeout', onError);
- xhr.addEventListener('abort', onError);
- // Progress events are only enabled if requested.
- if (req.reportProgress) {
- // Download progress is always enabled if requested.
- xhr.addEventListener('progress', onDownProgress);
- // Upload progress depends on whether there is a body to upload.
- if (reqBody !== null && xhr.upload) {
- xhr.upload.addEventListener('progress', onUpProgress);
- }
- }
- // Fire the request, and notify the event stream that it was fired.
- xhr.send(reqBody);
- observer.next({ type: HttpEventType.Sent });
- // This is the return from the Observable function, which is the
- // request cancellation handler.
- return () => {
- // On a cancellation, remove all registered event listeners.
- xhr.removeEventListener('error', onError);
- xhr.removeEventListener('abort', onError);
- xhr.removeEventListener('load', onLoad);
- xhr.removeEventListener('timeout', onError);
- if (req.reportProgress) {
- xhr.removeEventListener('progress', onDownProgress);
- if (reqBody !== null && xhr.upload) {
- xhr.upload.removeEventListener('progress', onUpProgress);
- }
- }
- // Finally, abort the in-flight request.
- if (xhr.readyState !== xhr.DONE) {
- xhr.abort();
- }
- };
- });
- }));
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXhrBackend, deps: [{ token: i1.XhrFactory }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXhrBackend }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXhrBackend, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: i1.XhrFactory }]; } });
- const XSRF_ENABLED = new InjectionToken('XSRF_ENABLED');
- const XSRF_DEFAULT_COOKIE_NAME = 'XSRF-TOKEN';
- const XSRF_COOKIE_NAME = new InjectionToken('XSRF_COOKIE_NAME', {
- providedIn: 'root',
- factory: () => XSRF_DEFAULT_COOKIE_NAME,
- });
- const XSRF_DEFAULT_HEADER_NAME = 'X-XSRF-TOKEN';
- const XSRF_HEADER_NAME = new InjectionToken('XSRF_HEADER_NAME', {
- providedIn: 'root',
- factory: () => XSRF_DEFAULT_HEADER_NAME,
- });
- /**
- * Retrieves the current XSRF token to use with the next outgoing request.
- *
- * @publicApi
- */
- class HttpXsrfTokenExtractor {
- }
- /**
- * `HttpXsrfTokenExtractor` which retrieves the token from a cookie.
- */
- class HttpXsrfCookieExtractor {
- constructor(doc, platform, cookieName) {
- this.doc = doc;
- this.platform = platform;
- this.cookieName = cookieName;
- this.lastCookieString = '';
- this.lastToken = null;
- /**
- * @internal for testing
- */
- this.parseCount = 0;
- }
- getToken() {
- if (this.platform === 'server') {
- return null;
- }
- const cookieString = this.doc.cookie || '';
- if (cookieString !== this.lastCookieString) {
- this.parseCount++;
- this.lastToken = ɵparseCookieValue(cookieString, this.cookieName);
- this.lastCookieString = cookieString;
- }
- return this.lastToken;
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXsrfCookieExtractor, deps: [{ token: DOCUMENT }, { token: PLATFORM_ID }, { token: XSRF_COOKIE_NAME }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXsrfCookieExtractor }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXsrfCookieExtractor, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: undefined, decorators: [{
- type: Inject,
- args: [DOCUMENT]
- }] }, { type: undefined, decorators: [{
- type: Inject,
- args: [PLATFORM_ID]
- }] }, { type: undefined, decorators: [{
- type: Inject,
- args: [XSRF_COOKIE_NAME]
- }] }]; } });
- function xsrfInterceptorFn(req, next) {
- const lcUrl = req.url.toLowerCase();
- // Skip both non-mutating requests and absolute URLs.
- // Non-mutating requests don't require a token, and absolute URLs require special handling
- // anyway as the cookie set
- // on our origin is not the same as the token expected by another origin.
- if (!inject(XSRF_ENABLED) || req.method === 'GET' || req.method === 'HEAD' ||
- lcUrl.startsWith('http://') || lcUrl.startsWith('https://')) {
- return next(req);
- }
- const token = inject(HttpXsrfTokenExtractor).getToken();
- const headerName = inject(XSRF_HEADER_NAME);
- // Be careful not to overwrite an existing header of the same name.
- if (token != null && !req.headers.has(headerName)) {
- req = req.clone({ headers: req.headers.set(headerName, token) });
- }
- return next(req);
- }
- /**
- * `HttpInterceptor` which adds an XSRF token to eligible outgoing requests.
- */
- class HttpXsrfInterceptor {
- constructor(injector) {
- this.injector = injector;
- }
- intercept(initialRequest, next) {
- return this.injector.runInContext(() => xsrfInterceptorFn(initialRequest, downstreamRequest => next.handle(downstreamRequest)));
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXsrfInterceptor, deps: [{ token: i0.EnvironmentInjector }], target: i0.ɵɵFactoryTarget.Injectable }); }
- static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXsrfInterceptor }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpXsrfInterceptor, decorators: [{
- type: Injectable
- }], ctorParameters: function () { return [{ type: i0.EnvironmentInjector }]; } });
- /**
- * Identifies a particular kind of `HttpFeature`.
- *
- * @publicApi
- */
- var HttpFeatureKind;
- (function (HttpFeatureKind) {
- HttpFeatureKind[HttpFeatureKind["Interceptors"] = 0] = "Interceptors";
- HttpFeatureKind[HttpFeatureKind["LegacyInterceptors"] = 1] = "LegacyInterceptors";
- HttpFeatureKind[HttpFeatureKind["CustomXsrfConfiguration"] = 2] = "CustomXsrfConfiguration";
- HttpFeatureKind[HttpFeatureKind["NoXsrfProtection"] = 3] = "NoXsrfProtection";
- HttpFeatureKind[HttpFeatureKind["JsonpSupport"] = 4] = "JsonpSupport";
- HttpFeatureKind[HttpFeatureKind["RequestsMadeViaParent"] = 5] = "RequestsMadeViaParent";
- HttpFeatureKind[HttpFeatureKind["Fetch"] = 6] = "Fetch";
- })(HttpFeatureKind || (HttpFeatureKind = {}));
- function makeHttpFeature(kind, providers) {
- return {
- ɵkind: kind,
- ɵproviders: providers,
- };
- }
- /**
- * Configures Angular's `HttpClient` service to be available for injection.
- *
- * By default, `HttpClient` will be configured for injection with its default options for XSRF
- * protection of outgoing requests. Additional configuration options can be provided by passing
- * feature functions to `provideHttpClient`. For example, HTTP interceptors can be added using the
- * `withInterceptors(...)` feature.
- *
- * @see {@link withInterceptors}
- * @see {@link withInterceptorsFromDi}
- * @see {@link withXsrfConfiguration}
- * @see {@link withNoXsrfProtection}
- * @see {@link withJsonpSupport}
- * @see {@link withRequestsMadeViaParent}
- * @see {@link withFetch}
- */
- function provideHttpClient(...features) {
- if (ngDevMode) {
- const featureKinds = new Set(features.map(f => f.ɵkind));
- if (featureKinds.has(HttpFeatureKind.NoXsrfProtection) &&
- featureKinds.has(HttpFeatureKind.CustomXsrfConfiguration)) {
- throw new Error(ngDevMode ?
- `Configuration error: found both withXsrfConfiguration() and withNoXsrfProtection() in the same call to provideHttpClient(), which is a contradiction.` :
- '');
- }
- }
- const providers = [
- HttpClient,
- HttpXhrBackend,
- HttpInterceptorHandler,
- { provide: HttpHandler, useExisting: HttpInterceptorHandler },
- { provide: HttpBackend, useExisting: HttpXhrBackend },
- {
- provide: HTTP_INTERCEPTOR_FNS,
- useValue: xsrfInterceptorFn,
- multi: true,
- },
- { provide: XSRF_ENABLED, useValue: true },
- { provide: HttpXsrfTokenExtractor, useClass: HttpXsrfCookieExtractor },
- ];
- for (const feature of features) {
- providers.push(...feature.ɵproviders);
- }
- return makeEnvironmentProviders(providers);
- }
- /**
- * Adds one or more functional-style HTTP interceptors to the configuration of the `HttpClient`
- * instance.
- *
- * @see {@link HttpInterceptorFn}
- * @see {@link provideHttpClient}
- * @publicApi
- */
- function withInterceptors(interceptorFns) {
- return makeHttpFeature(HttpFeatureKind.Interceptors, interceptorFns.map(interceptorFn => {
- return {
- provide: HTTP_INTERCEPTOR_FNS,
- useValue: interceptorFn,
- multi: true,
- };
- }));
- }
- const LEGACY_INTERCEPTOR_FN = new InjectionToken('LEGACY_INTERCEPTOR_FN');
- /**
- * Includes class-based interceptors configured using a multi-provider in the current injector into
- * the configured `HttpClient` instance.
- *
- * Prefer `withInterceptors` and functional interceptors instead, as support for DI-provided
- * interceptors may be phased out in a later release.
- *
- * @see {@link HttpInterceptor}
- * @see {@link HTTP_INTERCEPTORS}
- * @see {@link provideHttpClient}
- */
- function withInterceptorsFromDi() {
- // Note: the legacy interceptor function is provided here via an intermediate token
- // (`LEGACY_INTERCEPTOR_FN`), using a pattern which guarantees that if these providers are
- // included multiple times, all of the multi-provider entries will have the same instance of the
- // interceptor function. That way, the `HttpINterceptorHandler` will dedup them and legacy
- // interceptors will not run multiple times.
- return makeHttpFeature(HttpFeatureKind.LegacyInterceptors, [
- {
- provide: LEGACY_INTERCEPTOR_FN,
- useFactory: legacyInterceptorFnFactory,
- },
- {
- provide: HTTP_INTERCEPTOR_FNS,
- useExisting: LEGACY_INTERCEPTOR_FN,
- multi: true,
- }
- ]);
- }
- /**
- * Customizes the XSRF protection for the configuration of the current `HttpClient` instance.
- *
- * This feature is incompatible with the `withNoXsrfProtection` feature.
- *
- * @see {@link provideHttpClient}
- */
- function withXsrfConfiguration({ cookieName, headerName }) {
- const providers = [];
- if (cookieName !== undefined) {
- providers.push({ provide: XSRF_COOKIE_NAME, useValue: cookieName });
- }
- if (headerName !== undefined) {
- providers.push({ provide: XSRF_HEADER_NAME, useValue: headerName });
- }
- return makeHttpFeature(HttpFeatureKind.CustomXsrfConfiguration, providers);
- }
- /**
- * Disables XSRF protection in the configuration of the current `HttpClient` instance.
- *
- * This feature is incompatible with the `withXsrfConfiguration` feature.
- *
- * @see {@link provideHttpClient}
- */
- function withNoXsrfProtection() {
- return makeHttpFeature(HttpFeatureKind.NoXsrfProtection, [
- {
- provide: XSRF_ENABLED,
- useValue: false,
- },
- ]);
- }
- /**
- * Add JSONP support to the configuration of the current `HttpClient` instance.
- *
- * @see {@link provideHttpClient}
- */
- function withJsonpSupport() {
- return makeHttpFeature(HttpFeatureKind.JsonpSupport, [
- JsonpClientBackend,
- { provide: JsonpCallbackContext, useFactory: jsonpCallbackContext },
- { provide: HTTP_INTERCEPTOR_FNS, useValue: jsonpInterceptorFn, multi: true },
- ]);
- }
- /**
- * Configures the current `HttpClient` instance to make requests via the parent injector's
- * `HttpClient` instead of directly.
- *
- * By default, `provideHttpClient` configures `HttpClient` in its injector to be an independent
- * instance. For example, even if `HttpClient` is configured in the parent injector with
- * one or more interceptors, they will not intercept requests made via this instance.
- *
- * With this option enabled, once the request has passed through the current injector's
- * interceptors, it will be delegated to the parent injector's `HttpClient` chain instead of
- * dispatched directly, and interceptors in the parent configuration will be applied to the request.
- *
- * If there are several `HttpClient` instances in the injector hierarchy, it's possible for
- * `withRequestsMadeViaParent` to be used at multiple levels, which will cause the request to
- * "bubble up" until either reaching the root level or an `HttpClient` which was not configured with
- * this option.
- *
- * @see {@link provideHttpClient}
- * @developerPreview
- */
- function withRequestsMadeViaParent() {
- return makeHttpFeature(HttpFeatureKind.RequestsMadeViaParent, [
- {
- provide: HttpBackend,
- useFactory: () => {
- const handlerFromParent = inject(HttpHandler, { skipSelf: true, optional: true });
- if (ngDevMode && handlerFromParent === null) {
- throw new Error('withRequestsMadeViaParent() can only be used when the parent injector also configures HttpClient');
- }
- return handlerFromParent;
- },
- },
- ]);
- }
- /**
- * Configures the current `HttpClient` instance to make requests using the fetch API.
- *
- * This `FetchBackend` requires the support of the Fetch API which is available on all evergreen
- * browsers and on NodeJS from v18 onward.
- *
- * Note: The Fetch API doesn't support progress report on uploads.
- *
- * @publicApi
- * @developerPreview
- */
- function withFetch() {
- if ((typeof ngDevMode === 'undefined' || ngDevMode) && typeof fetch !== 'function') {
- // TODO: Create a runtime error
- // TODO: Use ENVIRONMENT_INITIALIZER to contextualize the error message (browser or server)
- throw new Error('The `withFetch` feature of HttpClient requires the `fetch` API to be available. ' +
- 'If you run the code in a Node environment, make sure you use Node v18.10 or later.');
- }
- return makeHttpFeature(HttpFeatureKind.Fetch, [
- FetchBackend,
- { provide: HttpBackend, useExisting: FetchBackend },
- ]);
- }
- /**
- * Configures XSRF protection support for outgoing requests.
- *
- * For a server that supports a cookie-based XSRF protection system,
- * use directly to configure XSRF protection with the correct
- * cookie and header names.
- *
- * If no names are supplied, the default cookie name is `XSRF-TOKEN`
- * and the default header name is `X-XSRF-TOKEN`.
- *
- * @publicApi
- */
- class HttpClientXsrfModule {
- /**
- * Disable the default XSRF protection.
- */
- static disable() {
- return {
- ngModule: HttpClientXsrfModule,
- providers: [
- withNoXsrfProtection().ɵproviders,
- ],
- };
- }
- /**
- * Configure XSRF protection.
- * @param options An object that can specify either or both
- * cookie name or header name.
- * - Cookie name default is `XSRF-TOKEN`.
- * - Header name default is `X-XSRF-TOKEN`.
- *
- */
- static withOptions(options = {}) {
- return {
- ngModule: HttpClientXsrfModule,
- providers: withXsrfConfiguration(options).ɵproviders,
- };
- }
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientXsrfModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
- static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.2.9", ngImport: i0, type: HttpClientXsrfModule }); }
- static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientXsrfModule, providers: [
- HttpXsrfInterceptor,
- { provide: HTTP_INTERCEPTORS, useExisting: HttpXsrfInterceptor, multi: true },
- { provide: HttpXsrfTokenExtractor, useClass: HttpXsrfCookieExtractor },
- withXsrfConfiguration({
- cookieName: XSRF_DEFAULT_COOKIE_NAME,
- headerName: XSRF_DEFAULT_HEADER_NAME,
- }).ɵproviders,
- { provide: XSRF_ENABLED, useValue: true },
- ] }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientXsrfModule, decorators: [{
- type: NgModule,
- args: [{
- providers: [
- HttpXsrfInterceptor,
- { provide: HTTP_INTERCEPTORS, useExisting: HttpXsrfInterceptor, multi: true },
- { provide: HttpXsrfTokenExtractor, useClass: HttpXsrfCookieExtractor },
- withXsrfConfiguration({
- cookieName: XSRF_DEFAULT_COOKIE_NAME,
- headerName: XSRF_DEFAULT_HEADER_NAME,
- }).ɵproviders,
- { provide: XSRF_ENABLED, useValue: true },
- ],
- }]
- }] });
- /**
- * Configures the [dependency injector](guide/glossary#injector) for `HttpClient`
- * with supporting services for XSRF. Automatically imported by `HttpClientModule`.
- *
- * You can add interceptors to the chain behind `HttpClient` by binding them to the
- * multiprovider for built-in [DI token](guide/glossary#di-token) `HTTP_INTERCEPTORS`.
- *
- * @publicApi
- */
- class HttpClientModule {
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
- static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.2.9", ngImport: i0, type: HttpClientModule }); }
- static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientModule, providers: [
- provideHttpClient(withInterceptorsFromDi()),
- ] }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientModule, decorators: [{
- type: NgModule,
- args: [{
- /**
- * Configures the [dependency injector](guide/glossary#injector) where it is imported
- * with supporting services for HTTP communications.
- */
- providers: [
- provideHttpClient(withInterceptorsFromDi()),
- ],
- }]
- }] });
- /**
- * Configures the [dependency injector](guide/glossary#injector) for `HttpClient`
- * with supporting services for JSONP.
- * Without this module, Jsonp requests reach the backend
- * with method JSONP, where they are rejected.
- *
- * @publicApi
- */
- class HttpClientJsonpModule {
- static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientJsonpModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
- static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.2.9", ngImport: i0, type: HttpClientJsonpModule }); }
- static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientJsonpModule, providers: [
- withJsonpSupport().ɵproviders,
- ] }); }
- }
- i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.9", ngImport: i0, type: HttpClientJsonpModule, decorators: [{
- type: NgModule,
- args: [{
- providers: [
- withJsonpSupport().ɵproviders,
- ],
- }]
- }] });
- const CACHE_STATE = new InjectionToken(ngDevMode ? 'HTTP_TRANSFER_STATE_CACHE_STATE' : '');
- /**
- * A list of allowed HTTP methods to cache.
- */
- const ALLOWED_METHODS = ['GET', 'HEAD'];
- function transferCacheInterceptorFn(req, next) {
- const { isCacheActive } = inject(CACHE_STATE);
- // Stop using the cache if the application has stabilized, indicating initial rendering
- // is complete.
- if (!isCacheActive || !ALLOWED_METHODS.includes(req.method)) {
- // Cache is no longer active or method is not HEAD or GET.
- // Pass the request through.
- return next(req);
- }
- const transferState = inject(TransferState);
- const storeKey = makeCacheKey(req);
- const response = transferState.get(storeKey, null);
- if (response) {
- // Request found in cache. Respond using it.
- let body = response.body;
- switch (response.responseType) {
- case 'arraybuffer':
- body = new TextEncoder().encode(response.body).buffer;
- break;
- case 'blob':
- body = new Blob([response.body]);
- break;
- }
- return of(new HttpResponse({
- body,
- headers: new HttpHeaders(response.headers),
- status: response.status,
- statusText: response.statusText,
- url: response.url,
- }));
- }
- // Request not found in cache. Make the request and cache it.
- return next(req).pipe(tap((event) => {
- if (event instanceof HttpResponse) {
- transferState.set(storeKey, {
- body: event.body,
- headers: getHeadersMap(event.headers),
- status: event.status,
- statusText: event.statusText,
- url: event.url || '',
- responseType: req.responseType,
- });
- }
- }));
- }
- function getHeadersMap(headers) {
- const headersMap = {};
- for (const key of headers.keys()) {
- const values = headers.getAll(key);
- if (values !== null) {
- headersMap[key] = values;
- }
- }
- return headersMap;
- }
- function makeCacheKey(request) {
- // make the params encoded same as a url so it's easy to identify
- const { params, method, responseType, url } = request;
- const encodedParams = params.keys().sort().map((k) => `${k}=${params.getAll(k)}`).join('&');
- const key = method + '.' + responseType + '.' + url + '?' + encodedParams;
- const hash = generateHash(key);
- return makeStateKey(hash);
- }
- /**
- * A method that returns a hash representation of a string using a variant of DJB2 hash
- * algorithm.
- *
- * This is the same hashing logic that is used to generate component ids.
- */
- function generateHash(value) {
- let hash = 0;
- for (const char of value) {
- hash = Math.imul(31, hash) + char.charCodeAt(0) << 0;
- }
- // Force positive number hash.
- // 2147483647 = equivalent of Integer.MAX_VALUE.
- hash += 2147483647 + 1;
- return hash.toString();
- }
- /**
- * Returns the DI providers needed to enable HTTP transfer cache.
- *
- * By default, when using server rendering, requests are performed twice: once on the server and
- * other one on the browser.
- *
- * When these providers are added, requests performed on the server are cached and reused during the
- * bootstrapping of the application in the browser thus avoiding duplicate requests and reducing
- * load time.
- *
- */
- function withHttpTransferCache() {
- return [
- {
- provide: CACHE_STATE,
- useFactory: () => {
- inject(ɵENABLED_SSR_FEATURES).add('httpcache');
- return { isCacheActive: true };
- }
- },
- {
- provide: HTTP_ROOT_INTERCEPTOR_FNS,
- useValue: transferCacheInterceptorFn,
- multi: true,
- deps: [TransferState, CACHE_STATE]
- },
- {
- provide: APP_BOOTSTRAP_LISTENER,
- multi: true,
- useFactory: () => {
- const appRef = inject(ApplicationRef);
- const cacheState = inject(CACHE_STATE);
- return () => {
- appRef.isStable.pipe(first((isStable) => isStable)).toPromise().then(() => {
- cacheState.isCacheActive = false;
- });
- };
- }
- }
- ];
- }
- // This file is not used to build this module. It is only used during editing
- /**
- * Generated bundle index. Do not edit.
- */
- export { FetchBackend, HTTP_INTERCEPTORS, HttpBackend, HttpClient, HttpClientJsonpModule, HttpClientModule, HttpClientXsrfModule, HttpContext, HttpContextToken, HttpErrorResponse, HttpEventType, HttpFeatureKind, HttpHandler, HttpHeaderResponse, HttpHeaders, HttpParams, HttpRequest, HttpResponse, HttpResponseBase, HttpUrlEncodingCodec, HttpXhrBackend, HttpXsrfTokenExtractor, JsonpClientBackend, JsonpInterceptor, provideHttpClient, withFetch, withInterceptors, withInterceptorsFromDi, withJsonpSupport, withNoXsrfProtection, withRequestsMadeViaParent, withXsrfConfiguration, HttpInterceptorHandler as ɵHttpInterceptingHandler, HttpInterceptorHandler as ɵHttpInterceptorHandler, withHttpTransferCache as ɵwithHttpTransferCache };
- //# sourceMappingURL=http.mjs.map
|