Merge branch 'release/druxt-menu-0.21.0'

druxt · Jan 8, 2024 · 6ec4587 · 6ec4587
2 parents ef3067f + 7be612c
commit 6ec4587
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 6 deletions.
diff --git a/packages/menu/CHANGELOG.md b/packages/menu/CHANGELOG.md
@@ -1,5 +1,11 @@
 # druxt-menu
 
+## 0.21.0
+
+### Minor Changes
+
+- 26b1bc6f: feat(#684): added druxtMenu/flushEntities Vuex mutation.
+
 ## 0.20.0
 
 ### Minor Changes

diff --git a/packages/menu/package.json b/packages/menu/package.json
@@ -1,6 +1,6 @@
 {
   "name": "druxt-menu",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Drupal Menu and Menu item Druxt components, with support for the JSON:API Menu Items module.",
   "keywords": [
     "cms",

diff --git a/packages/menu/src/components/DruxtMenu.vue b/packages/menu/src/components/DruxtMenu.vue
@@ -222,6 +222,7 @@ export default {
   mounted() {
     // If logged in and statically generated, re-fetch the menu.
     if (this?.$auth?.loggedIn && this?.$store?.app?.context?.isStatic) {
+      this.$store.commit('druxtMenu/flushEntities', { prefix: this.lang })
       const settings = this.$options.druxt.settings(this, this.component.settings)
       this.$options.druxt.fetchData.call(this, settings)
     }

diff --git a/packages/menu/src/stores/menu.js b/packages/menu/src/stores/menu.js
@@ -49,7 +49,21 @@ const DruxtMenuStore = ({ store }) => {
           const entity = entities[index]
           Vue.set(state.entities[prefix], entity.id, entity)
         }
-      }
+      },
+
+      /**
+       * @name flushEntities
+       * @mutator {object} flushEntities=entities Removes JSON:API menu item entities from the Vuex state object.
+       * @param {flushEntitiesContext} context
+       *
+       * @example @lang js
+       * // Flush all menu entities.
+       * this.$store.commit('druxt/flushCollection', {})
+       */
+      flushEntities (state, { prefix }) {
+        if (!prefix || typeof state.entities !== 'object') Vue.set(state, 'entities', {})
+        if (prefix) Vue.set(state.entities, prefix, {})
+      },
     },
 
     /**
@@ -120,3 +134,16 @@ export { DruxtMenuStore }
  * @typedef {object} State
  * @property {object} entities - The Drupal JSON:API Menu Item entities.
  */
+
+/**
+ * Parameters for the `flushEntities` mutation.
+ *
+ * @typedef {object} flushEntitiesContext
+ *
+ * @param {string} [prefix] - (Optional) The JSON:API endpoint prefix or langcode.
+ *
+ * @example @lang js
+ * {
+ *   prefix: 'en'
+ * }
+ */
diff --git a/packages/menu/test/stores/menu.test.js b/packages/menu/test/stores/menu.test.js
@@ -33,4 +33,22 @@ describe('DruxtStore', () => {
     expect(store.$druxtMenu.get).toHaveBeenCalledWith('main', { test: true }, undefined)
     store.dispatch('druxtMenu/get', 'name')
   })
+
+  test('AddEntities', async () => {
+    expect(store.state.druxtMenu.entities).toStrictEqual({})
+    store.commit('druxtMenu/addEntities', { entities: [{ id: 'test' }] })
+    expect(Object.entries(store.state.druxtMenu.entities[undefined]).length).toBe(1)
+    expect(store.state.druxtMenu.entities[undefined].test).toStrictEqual({ id: 'test' })
+  })
+
+  test('flushEntities', async () => {
+    expect(store.state.druxtMenu.entities).toStrictEqual({})
+    store.commit('druxtMenu/addEntities', { entities: [{ id: 'test' }] })
+    store.commit('druxtMenu/addEntities', { entities: [{ id: 'test2' }], prefix: 'es' })
+    expect(Object.entries(store.state.druxtMenu.entities[undefined]).length).toBe(1)
+    store.commit('druxtMenu/flushEntities', { prefix: 'undefined' })
+    expect(Object.entries(store.state.druxtMenu.entities[undefined]).length).toBe(0)
+    store.commit('druxtMenu/flushEntities', {})
+    expect(Object.entries(store.state.druxtMenu.entities).length).toBe(0)
+  })
 })
diff --git a/packages/site/CHANGELOG.md b/packages/site/CHANGELOG.md
@@ -1,5 +1,12 @@
 # druxt-site
 
+## 0.14.3
+
+### Patch Changes
+
+- Updated dependencies [26b1bc6f]
+  - [email protected]
+
 ## 0.14.2
 
 ### Patch Changes

diff --git a/packages/site/package.json b/packages/site/package.json
@@ -1,6 +1,6 @@
 {
   "name": "druxt-site",
-  "version": "0.14.2",
+  "version": "0.14.3",
   "description": "Out of the box Decoupled Drupal sites with Druxt.",
   "keywords": [
     "cms",
@@ -47,7 +47,7 @@
     "druxt-blocks": "^0.17.1",
     "druxt-breadcrumb": "^0.17.1",
     "druxt-entity": "^0.28.0",
-    "druxt-menu": "^0.20.0",
+    "druxt-menu": "^0.21.0",
     "druxt-router": "^0.29.1",
     "druxt-schema": "^0.11.2",
     "druxt-views": "^0.22.0",

diff --git a/yarn.lock b/yarn.lock
@@ -11240,7 +11240,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"druxt-menu@^0.20.0, druxt-menu@workspace:packages/menu":
+"druxt-menu@^0.21.0, druxt-menu@workspace:packages/menu":
   version: 0.0.0-use.local
   resolution: "druxt-menu@workspace:packages/menu"
   dependencies:
@@ -11322,7 +11322,7 @@ __metadata:
     druxt-blocks: ^0.17.1
     druxt-breadcrumb: ^0.17.1
     druxt-entity: ^0.28.0
-    druxt-menu: ^0.20.0
+    druxt-menu: ^0.21.0
     druxt-router: ^0.29.1
     druxt-schema: ^0.11.2
     druxt-views: ^0.22.0