@ngrx/data 15.2.1 → 15.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngrx/data",
-  "version": "15.2.1",
+  "version": "15.3.0",
   "description": "API management for NgRx",
   "repository": {
     "type": "git",
@@ -22,9 +22,9 @@
   "peerDependencies": {
     "@angular/common": "^15.0.0",
     "@angular/core": "^15.0.0",
-    "@ngrx/store": "15.2.1",
-    "@ngrx/effects": "15.2.1",
-    "@ngrx/entity": "15.2.1",
+    "@ngrx/store": "15.3.0",
+    "@ngrx/effects": "15.3.0",
+    "@ngrx/entity": "15.3.0",
     "rxjs": "^6.5.3 || ^7.5.0"
   },
   "schematics": "./schematics/collection.json",

package/schematics-core/utility/libs-version.js

@@ -1,5 +1,5 @@
 "use strict";
 exports.__esModule = true;
 exports.platformVersion = void 0;
-exports.platformVersion = '^15.2.1';
+exports.platformVersion = '^15.3.0';
 //# sourceMappingURL=libs-version.js.map

package/schematics-core/utility/libs-version.js.map

@@ -1 +1 @@
-{"version":3,"file":"libs-version.js","sourceRoot":"","sources":["../../../../../modules/data/schematics-core/utility/libs-version.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG,SAAS,CAAC","sourcesContent":["export const platformVersion = '^15.2.1';\n"]}
+{"version":3,"file":"libs-version.js","sourceRoot":"","sources":["../../../../../modules/data/schematics-core/utility/libs-version.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG,SAAS,CAAC","sourcesContent":["export const platformVersion = '^15.3.0';\n"]}

package/src/actions/entity-action.d.ts

@@ -1,6 +1,7 @@
 import { Action } from '@ngrx/store';
 import { EntityOp } from './entity-op';
 import { MergeStrategy } from './merge-strategy';
+import { HttpOptions } from '../dataservices/interfaces';
 /** Action concerning an entity collection. */
 export interface EntityAction<P = any> extends Action {
     readonly type: string;
@@ -15,6 +16,8 @@ export interface EntityActionOptions {
     readonly mergeStrategy?: MergeStrategy;
     /** The tag to use in the action's type. The entityName if no tag specified. */
     readonly tag?: string;
+    /** Options that will be passed to the dataService http request. Allows setting of Query Parameters and Headers */
+    readonly httpOptions?: HttpOptions;
     /**
      * The action was determined (usually by a reducer) to be in error.
      * Downstream effects should not process but rather treat it as an error.

package/src/dataservices/default-data.service.d.ts

@@ -2,7 +2,7 @@ import { HttpClient } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import { Update } from '@ngrx/entity';
 import { DefaultDataServiceConfig } from './default-data-service-config';
-import { EntityCollectionDataService, HttpMethods, QueryParams } from './interfaces';
+import { EntityCollectionDataService, HttpMethods, HttpOptions, QueryParams } from './interfaces';
 import { HttpUrlGenerator } from './http-url-generator';
 import * as i0 from "@angular/core";
 /**
@@ -24,15 +24,16 @@ export declare class DefaultDataService<T> implements EntityCollectionDataServic
     protected trailingSlashEndpoints: boolean;
     get name(): string;
     constructor(entityName: string, http: HttpClient, httpUrlGenerator: HttpUrlGenerator, config?: DefaultDataServiceConfig);
-    add(entity: T): Observable<T>;
-    delete(key: number | string): Observable<number | string>;
-    getAll(): Observable<T[]>;
-    getById(key: number | string): Observable<T>;
-    getWithQuery(queryParams: QueryParams | string): Observable<T[]>;
-    update(update: Update<T>): Observable<T>;
-    upsert(entity: T): Observable<T>;
+    add(entity: T, options?: HttpOptions): Observable<T>;
+    delete(key: number | string, options?: HttpOptions): Observable<number | string>;
+    getAll(options?: HttpOptions): Observable<T[]>;
+    getById(key: number | string, options?: HttpOptions): Observable<T>;
+    getWithQuery(queryParams: QueryParams | string | undefined, options?: HttpOptions): Observable<T[]>;
+    update(update: Update<T>, options?: HttpOptions): Observable<T>;
+    upsert(entity: T, options?: HttpOptions): Observable<T>;
     protected execute(method: HttpMethods, url: string, data?: any, // data, error, or undefined/null
-    options?: any): Observable<any>;
+    options?: any, // options or undefined/null
+    httpOptions?: HttpOptions): Observable<any>;
     private handleError;
     private handleDelete404;
 }

package/src/dataservices/interfaces.d.ts

@@ -3,13 +3,13 @@ import { Update } from '@ngrx/entity';
 /** A service that performs REST-like HTTP data operations for an entity collection */
 export interface EntityCollectionDataService<T> {
     readonly name: string;
-    add(entity: T): Observable<T>;
-    delete(id: number | string): Observable<number | string>;
-    getAll(): Observable<T[]>;
-    getById(id: any): Observable<T>;
-    getWithQuery(params: QueryParams | string): Observable<T[]>;
-    update(update: Update<T>): Observable<T>;
-    upsert(entity: T): Observable<T>;
+    add(entity: T, httpOptions?: HttpOptions): Observable<T>;
+    delete(id: number | string, httpOptions?: HttpOptions): Observable<number | string>;
+    getAll(httpOptions?: HttpOptions): Observable<T[]>;
+    getById(id: any, httpOptions?: HttpOptions): Observable<T>;
+    getWithQuery(params: QueryParams | string, httpOptions?: HttpOptions): Observable<T[]>;
+    update(update: Update<T>, httpOptions?: HttpOptions): Observable<T>;
+    upsert(entity: T, httpOptions?: HttpOptions): Observable<T>;
 }
 export declare type HttpMethods = 'DELETE' | 'GET' | 'POST' | 'PUT';
 export interface RequestData {
@@ -20,9 +20,42 @@ export interface RequestData {
 }
 /**
  * A key/value map of parameters to be turned into an HTTP query string
- * Same as HttpClient's HttpParamsOptions which is NOT exported at package level
+ * Same as HttpClient's HttpParamsOptions which at the time of writing was
+ * NOT exported at package level
  * https://github.com/angular/angular/issues/22013
+ *
+ * @deprecated Use HttpOptions instead. getWithQuery still accepts QueryParams as its
+ * first argument, but HttpOptions.httpParams uses Angular's own HttpParamsOptions which
+ * HttpClient accepts as an argument.
  */
 export interface QueryParams {
-    [name: string]: string | string[];
+    [name: string]: string | number | boolean | ReadonlyArray<string | number | boolean>;
+}
+/**
+ * Options that adhere to the constructor arguments for HttpParams and
+ * HttpHeaders.
+ */
+export interface HttpOptions {
+    httpParams?: HttpParams;
+    httpHeaders?: HttpHeaders;
+}
+/**
+ * Type that adheres to angular's Http Headers
+ */
+export declare type HttpHeaders = string | {
+    [p: string]: string | string[];
+};
+/**
+ * Options that partially adheres to angular's HttpParamsOptions. The non-serializable encoder property is omitted.
+ */
+export declare interface HttpParams {
+    /**
+     * String representation of the HTTP parameters in URL-query-string format.
+     * Mutually exclusive with `fromObject`.
+     */
+    fromString?: string;
+    /** Object map of the HTTP parameters. Mutually exclusive with `fromString`. */
+    fromObject?: {
+        [param: string]: string | number | boolean | ReadonlyArray<string | number | boolean>;
+    };
 }