Merge pull request #111 from data-provider/release

Release v2.2.2

Author: javierbrea

CHANGELOG.md

@@ -10,6 +10,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 ### Removed
 
+## [2.2.2] - 2020-12-27
+
+### Added
+- docs(readme): Add example about using default tag
+
+### Changed
+- chore(deps): Update dependencies
+- refactor: Use baseTags getter to define base tag (#109)
+
 ## [2.2.1] - 2020-12-14
 
 ### Added

README.md

@@ -122,6 +122,21 @@ userPreferences.query({ prop: "cookiesAccepted" }).delete()
 userPreferences.delete();
 ```
 
+## Tags
+
+Providers created with this addon will have automatically the `browser-storage` tag, so you can select all of them together using the `providers` methods as in:
+
+```javascript
+import { providers } from "@data-provider/core";
+
+providers.getByTag("browser-storage").cleanCache();
+```
+
+Apart of this common tag, each different type of `browser-storage` origin also has next tags:
+
+* `LocalStorage`: "local-storage"
+* `SessionStorage`: "session-storage"
+
 ## Contributing
 
 Contributors are welcome.

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@data-provider/browser-storage",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Data Provider addon providing localStorage and sessionStorage origins",
   "keywords": [
     "data-provider",
@@ -43,7 +43,7 @@
   "devDependencies": {
     "@babel/core": "7.12.3",
     "@babel/preset-env": "7.12.1",
-    "@data-provider/core": "2.8.2",
+    "@data-provider/core": "2.9.0",
     "@rollup/plugin-babel": "5.2.2",
     "@rollup/plugin-commonjs": "17.0.0",
     "@rollup/plugin-json": "4.1.0",

package.json

@@ -1,6 +1,6 @@
 sonar.organization=data-provider
 sonar.projectKey=data-provider-browser-storage
-sonar.projectVersion=2.2.1
+sonar.projectVersion=2.2.2
 
 sonar.sources=src,test
 sonar.exclusions=node_modules/**

sonar-project.properties

@@ -10,9 +10,14 @@ Unless required by applicable law or agreed to in writing, software distributed
 */
 
 import { Storage } from "./Storage";
+import { TAG, LOCAL_TAG } from "./tags";
 
 export class LocalStorage extends Storage {
   constructor(id, options, query) {
     super(id, { ...options, storageKey: "localStorage" }, query);
   }
+
+  get baseTags() {
+    return [TAG, LOCAL_TAG];
+  }
 }

src/LocalStorage.js

@@ -10,9 +10,14 @@ Unless required by applicable law or agreed to in writing, software distributed
 */
 
 import { Storage } from "./Storage";
+import { TAG, SESSION_TAG } from "./tags";
 
 export class SessionStorage extends Storage {
   constructor(id, options, query) {
     super(id, { ...options, storageKey: "sessionStorage" }, query);
   }
+
+  get baseTags() {
+    return [TAG, SESSION_TAG];
+  }
 }

src/SessionStorage.js

@@ -13,12 +13,6 @@ Unless required by applicable law or agreed to in writing, software distributed
 
 import { Provider } from "@data-provider/core";
 
-const TAG = "browser-storage";
-const storageKeysTags = {
-  localStorage: "local-storage",
-  sessionStorage: "session-storage",
-};
-
 class StorageMock {
   constructor() {
     this._value = "{}";
@@ -49,10 +43,7 @@ class StorageErrorMock {
 
 export class Storage extends Provider {
   constructor(id, options, query) {
-    const tags = options.tags ? [...options.tags] : [];
-    tags.unshift(storageKeysTags[options.storageKey]);
-    tags.unshift(TAG);
-    const extendedOptions = { ...options, tags };
+    const extendedOptions = { ...options };
     if (!query) {
       extendedOptions.parentId = id;
     }

src/Storage.js

@@ -0,0 +1,3 @@
+export const TAG = "browser-storage";
+export const LOCAL_TAG = "local-storage";
+export const SESSION_TAG = "session-storage";