@ngrx/data 15.2.1 → 15.4.0

package/fesm2020/ngrx-data.mjs

@@ -1,8 +1,8 @@
 import * as i0 from '@angular/core';
-import { Injectable, InjectionToken, Optional, Inject, ENVIRONMENT_INITIALIZER, inject, makeEnvironmentProviders, NgModule } from '@angular/core';
+import { Injectable, InjectionToken, isDevMode, Optional, Inject, ENVIRONMENT_INITIALIZER, inject, makeEnvironmentProviders, NgModule } from '@angular/core';
 import { filter, map, delay, timeout, catchError, shareReplay, take, mergeMap, withLatestFrom, concatMap } from 'rxjs/operators';
 import * as i1 from '@angular/common/http';
-import { HttpParams } from '@angular/common/http';
+import { HttpParams, HttpHeaders } from '@angular/common/http';
 import * as i4 from 'rxjs';
 import { throwError, of, race, asyncScheduler, merge } from 'rxjs';
 import { createEntityAdapter } from '@ngrx/entity';
@@ -700,72 +700,109 @@ class DefaultDataService {
     get name() {
         return this._name;
     }
-    add(entity) {
+    add(entity, options) {
         const entityOrError = entity || new Error(`No "${this.entityName}" entity to add`);
-        return this.execute('POST', this.entityUrl, entityOrError);
+        return this.execute('POST', this.entityUrl, entityOrError, null, options);
     }
-    delete(key) {
+    delete(key, options) {
         let err;
         if (key == null) {
             err = new Error(`No "${this.entityName}" key to delete`);
         }
-        return this.execute('DELETE', this.entityUrl + key, err).pipe(
+        return this.execute('DELETE', this.entityUrl + key, err, null, options).pipe(
         // forward the id of deleted entity as the result of the HTTP DELETE
         map((result) => key));
     }
-    getAll() {
-        return this.execute('GET', this.entitiesUrl);
+    getAll(options) {
+        return this.execute('GET', this.entitiesUrl, null, options);
     }
-    getById(key) {
+    getById(key, options) {
         let err;
         if (key == null) {
             err = new Error(`No "${this.entityName}" key to get`);
         }
-        return this.execute('GET', this.entityUrl + key, err);
+        return this.execute('GET', this.entityUrl + key, err, null, options);
     }
-    getWithQuery(queryParams) {
+    getWithQuery(queryParams, options) {
         const qParams = typeof queryParams === 'string'
             ? { fromString: queryParams }
             : { fromObject: queryParams };
         const params = new HttpParams(qParams);
-        return this.execute('GET', this.entitiesUrl, undefined, { params });
+        return this.execute('GET', this.entitiesUrl, undefined, { params }, options);
     }
-    update(update) {
+    update(update, options) {
         const id = update && update.id;
         const updateOrError = id == null
             ? new Error(`No "${this.entityName}" update data or id`)
             : update.changes;
-        return this.execute('PUT', this.entityUrl + id, updateOrError);
+        return this.execute('PUT', this.entityUrl + id, updateOrError, null, options);
     }
     // Important! Only call if the backend service supports upserts as a POST to the target URL
-    upsert(entity) {
+    upsert(entity, options) {
         const entityOrError = entity || new Error(`No "${this.entityName}" entity to upsert`);
-        return this.execute('POST', this.entityUrl, entityOrError);
+        return this.execute('POST', this.entityUrl, entityOrError, null, options);
     }
     execute(method, url, data, // data, error, or undefined/null
-    options) {
-        const req = { method, url, data, options };
+    options, // options or undefined/null
+    httpOptions // these override any options passed via options
+    ) {
+        let entityActionHttpClientOptions = undefined;
+        if (httpOptions) {
+            entityActionHttpClientOptions = {
+                headers: httpOptions?.httpHeaders
+                    ? new HttpHeaders(httpOptions?.httpHeaders)
+                    : undefined,
+                params: httpOptions?.httpParams
+                    ? new HttpParams(httpOptions?.httpParams)
+                    : undefined,
+            };
+        }
+        // Now we may have:
+        // options: containing headers, params, or any other allowed http options already in angular's api
+        // entityActionHttpClientOptions: headers and params in angular's api
+        // We therefore need to merge these so that the action ones override the
+        // existing keys where applicable.
+        // If any options have been specified, pass them to http client. Note
+        // the new http options, if specified, will override any options passed
+        // from the deprecated options parameter
+        let mergedOptions = undefined;
+        if (options || entityActionHttpClientOptions) {
+            if (isDevMode() && options && entityActionHttpClientOptions) {
+                console.warn('@ngrx/data: options.httpParams will be merged with queryParams when both are are provided to getWithQuery(). In the event of a conflict HttpOptions.httpParams will override queryParams`. The queryParams parameter of getWithQuery() will be removed in next major release.');
+            }
+            mergedOptions = {
+                ...options,
+                headers: entityActionHttpClientOptions?.headers ?? options?.headers,
+                params: entityActionHttpClientOptions?.params ?? options?.params,
+            };
+        }
+        const req = {
+            method,
+            url,
+            data,
+            options: mergedOptions,
+        };
         if (data instanceof Error) {
             return this.handleError(req)(data);
         }
         let result$;
         switch (method) {
             case 'DELETE': {
-                result$ = this.http.delete(url, options);
+                result$ = this.http.delete(url, mergedOptions);
                 if (this.saveDelay) {
                     result$ = result$.pipe(delay(this.saveDelay));
                 }
                 break;
             }
             case 'GET': {
-                result$ = this.http.get(url, options);
+                result$ = this.http.get(url, mergedOptions);
                 if (this.getDelay) {
                     result$ = result$.pipe(delay(this.getDelay));
                 }
                 break;
             }
             case 'POST': {
-                result$ = this.http.post(url, data, options);
+                result$ = this.http.post(url, data, mergedOptions);
                 if (this.saveDelay) {
                     result$ = result$.pipe(delay(this.saveDelay));
                 }
@@ -773,7 +810,7 @@ class DefaultDataService {
             }
             // N.B.: It must return an Update<T>
             case 'PUT': {
-                result$ = this.http.put(url, data, options);
+                result$ = this.http.put(url, data, mergedOptions);
                 if (this.saveDelay) {
                     result$ = result$.pipe(delay(this.saveDelay));
                 }
@@ -2069,23 +2106,23 @@ class EntityEffects {
         }
     }
     callDataService(action) {
-        const { entityName, entityOp, data } = action.payload;
+        const { entityName, entityOp, data, httpOptions } = action.payload;
         const service = this.dataService.getService(entityName);
         switch (entityOp) {
             case EntityOp.QUERY_ALL:
             case EntityOp.QUERY_LOAD:
-                return service.getAll();
+                return service.getAll(httpOptions);
             case EntityOp.QUERY_BY_KEY:
-                return service.getById(data);
+                return service.getById(data, httpOptions);
             case EntityOp.QUERY_MANY:
-                return service.getWithQuery(data);
+                return service.getWithQuery(data, httpOptions);
             case EntityOp.SAVE_ADD_ONE:
-                return service.add(data);
+                return service.add(data, httpOptions);
             case EntityOp.SAVE_DELETE_ONE:
-                return service.delete(data);
+                return service.delete(data, httpOptions);
             case EntityOp.SAVE_UPDATE_ONE:
                 const { id, changes } = data; // data must be Update<T>
-                return service.update(data).pipe(map((updatedEntity) => {
+                return service.update(data, httpOptions).pipe(map((updatedEntity) => {
                     // Return an Update<T> with updated entity data.
                     // If server returned entity data, merge with the changes that were sent
                     // and set the 'changed' flag to true.
@@ -2099,7 +2136,7 @@ class EntityEffects {
                     return responseData;
                 }));
             case EntityOp.SAVE_UPSERT_ONE:
-                return service.upsert(data).pipe(map((upsertedEntity) => {
+                return service.upsert(data, httpOptions).pipe(map((upsertedEntity) => {
                     const hasData = upsertedEntity && Object.keys(upsertedEntity).length > 0;
                     return hasData ? upsertedEntity : data; // ensure a returned entity value.
                 }));
@@ -4966,4 +5003,3 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.0.0", ngImpor
 
 export { ChangeSetItemFactory, ChangeSetOperation, ChangeType, ClearCollections, CorrelationIdGenerator, DataServiceError, DefaultDataService, DefaultDataServiceConfig, DefaultDataServiceFactory, DefaultHttpUrlGenerator, DefaultLogger, DefaultPersistenceResultHandler, DefaultPluralizer, ENTITY_CACHE_META_REDUCERS, ENTITY_CACHE_NAME, ENTITY_CACHE_NAME_TOKEN, ENTITY_CACHE_SELECTOR_TOKEN, ENTITY_COLLECTION_META_REDUCERS, ENTITY_METADATA_TOKEN, EntityActionFactory, EntityActionGuard, EntityCacheAction, EntityCacheDataService, EntityCacheDispatcher, EntityCacheEffects, EntityCacheReducerFactory, EntityChangeTrackerBase, EntityCollectionCreator, EntityCollectionReducerFactory, EntityCollectionReducerMethods, EntityCollectionReducerMethodsFactory, EntityCollectionReducerRegistry, EntityCollectionServiceBase, EntityCollectionServiceElementsFactory, EntityCollectionServiceFactory, EntityDataModule, EntityDataModuleWithoutEffects, EntityDataService, EntityDefinitionService, EntityDispatcherBase, EntityDispatcherDefaultOptions, EntityDispatcherFactory, EntityEffects, EntityHttpResourceUrls, EntityOp, EntitySelectors$Factory, EntitySelectorsFactory, EntityServices, EntityServicesBase, EntityServicesElements, HttpUrlGenerator, INITIAL_ENTITY_CACHE_STATE, LoadCollections, Logger, MergeQuerySet, MergeStrategy, OP_ERROR, OP_SUCCESS, PLURAL_NAMES_TOKEN, PersistanceCanceled, PersistenceResultHandler, Pluralizer, PropsFilterFnFactory, SaveEntities, SaveEntitiesCancel, SaveEntitiesCanceled, SaveEntitiesError, SaveEntitiesSuccess, SetEntityCache, changeSetItemFactory, createEmptyEntityCollection, createEntityCacheSelector, createEntityDefinition, defaultSelectId, entityCacheSelectorProvider, excludeEmptyChangeSetItems, flattenArgs, getGuid, getGuidComb, guidComparer, makeErrorOp, makeSuccessOp, normalizeRoot, ofEntityOp, ofEntityType, persistOps, provideEntityData, toUpdateFactory, withEffects };
 //# sourceMappingURL=ngrx-data.mjs.map
-//# sourceMappingURL=ngrx-data.mjs.map