3.0.0

Author: d34dman

CHANGELOG.md

@@ -1,18 +1,29 @@
 # Changelog
 
+## 3.0.0
+
+### Major Changes
+
+- - **BREAKING CHANGE**: Changed internal properties and methods from `private` to `protected` to enable inheritance scenarios
+    - `data` property is now accessible to subclasses for query state management
+    - `qsOptions` property is now accessible to subclasses for query string options
+    - `config` property is now accessible to subclasses for configuration settings
+    - `generateKeyName` method is now accessible to subclasses
+    - `getIndexId` method is now accessible to subclasses
+    - This change affects consumers who subclass `DrupalJsonApiParams`
+
 ## 2.3.2
 
 ### Patch Changes
 
 - Fixed return for custom params method [#44](https://github.com/d34dman/drupal-jsonapi-params/pull/44).
 
-
 ## 2.3.1
 
 ### Patch Changes
 
 - Dev dependency update.
-  
+
 ## 2.3.0
 
 ### Minor Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "drupal-jsonapi-params",
-  "version": "2.3.2",
+  "version": "3.0.0",
   "description": "Drupal JSON-API params",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

src/__tests__/CustomParam.test.ts

@@ -9,7 +9,7 @@ test('Custom parameters', () => {
   expect(api.getQueryString({ encode: false })).toBe('foo[bar]=baz&bar[0]=a&bar[1]=b&bar[2]=c');
   api.clear();
   expect(api.getQueryString()).toBe('');
-  expect(api.addCustomParam({ foo: 'bar' })).toBeInstanceOf(DrupalJsonApiParams)
+  expect(api.addCustomParam({ foo: 'bar' })).toBeInstanceOf(DrupalJsonApiParams);
 });
 
 test("Nova's Ark with custom params", () => {

src/index.ts

@@ -60,7 +60,6 @@ export interface DrupalJsonApiParamsInterface {
   getQueryObject(): object;
 }
 export class DrupalJsonApiParams implements DrupalJsonApiParamsInterface {
-
   protected data: DrupalJsonApiParamsStore = {
     filter: {},
     include: [],
@@ -395,19 +394,19 @@ export class DrupalJsonApiParams implements DrupalJsonApiParamsInterface {
    */
   public getQueryObject(): ParamBag<any> {
     const foo: ParamBag<any> = JSON.parse(JSON.stringify(this.data));
-  
+
     if (this.data.include.length > 0) {
-      foo.include = this.data.include.join(",");
+      foo.include = this.data.include.join(',');
     } else {
       delete foo.include;
     }
-  
+
     if (this.data.sort.length > 0) {
-      foo.sort = this.data.sort.join(",");
+      foo.sort = this.data.sort.join(',');
     } else {
       delete foo.sort;
     }
-  
+
     return foo;
   }