druxt-menu 0.13.0 → 0.14.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # druxt-menu
2
2
 
3
+ ## 0.14.3
4
+
5
+ ### Patch Changes
6
+
7
+ - 631598d: Removed debug code
8
+
9
+ ## 0.14.1
10
+
11
+ ### Patch Changes
12
+
13
+ - ee15810: Fixed bug when menu endpoint fails
14
+ - Updated dependencies [4504a2f]
15
+ - druxt@0.12.0
16
+ - druxt-blocks@0.13.1
17
+
18
+ ## 0.14.0
19
+
20
+ ### Minor Changes
21
+
22
+ - dae345e: Added module level options
23
+ - 8d28c18: Updated storybook integration
24
+
25
+ ### Patch Changes
26
+
27
+ - Updated dependencies [dae345e]
28
+ - druxt-blocks@0.13.0
29
+ - druxt@0.11.0
30
+
3
31
  ## 0.13.0
4
32
 
5
33
  ### Minor Changes
package/README.md CHANGED
@@ -5,22 +5,18 @@
5
5
  [![Known Vulnerabilities](https://snyk.io/test/github/druxt/druxt-menu/badge.svg?targetFile=package.json)](https://snyk.io/test/github/druxt/druxt-menu?targetFile=package.json)
6
6
  [![codecov](https://codecov.io/gh/druxt/druxt-menu/branch/develop/graph/badge.svg)](https://codecov.io/gh/druxt/druxt-menu)
7
7
 
8
-
9
8
  > Drupal Menu and Menu item Druxt components, with support for the JSON:API Menu Items module.
10
9
 
11
-
12
10
  ## Links
13
11
 
14
12
  - DruxtJS: https://druxtjs.org
15
- - Documentation: https://menu.druxtjs.org/
13
+ - Documentation: https://druxtjs.org/modules/menu
16
14
  - Community Discord server: https://discord.druxtjs.org
17
15
 
18
-
19
16
  ## Install
20
17
 
21
18
  `$ npm install druxt-menu`
22
19
 
23
-
24
20
  ### Nuxt.js
25
21
 
26
22
  Add module to `nuxt.config.js`
@@ -40,7 +36,6 @@ module.exports = {
40
36
  }
41
37
  ```
42
38
 
43
-
44
39
  ## Usgae
45
40
 
46
41
  ### DruxtMenu component
@@ -51,10 +46,9 @@ The DruxtMenu component inteligentally loads in your Drupal menu using the built
51
46
  <DruxtMenu name="main" :depth="1" />
52
47
  ```
53
48
 
54
- ![Example DruxtMenu component](https://raw.githubusercontent.com/druxt/druxt-menu/HEAD/docs/images/druxt-menu.png)
55
-
56
- See the [DruxtMenu API Documentation](https://menu.druxtjs.org/api/components/DruxtMenu.html) for more information.
49
+ ![Example DruxtMenu component](https://druxtjs.org/images/druxt-menu.png)
57
50
 
51
+ See the [DruxtMenu API Documentation](https://druxtjs.org/api/packages/menu/components/DruxtMenu) for more information.
58
52
 
59
53
  ### Theming
60
54
 
@@ -76,8 +70,7 @@ The module also provides Wrapper components with scoped slots for theming:
76
70
  </template>
77
71
  ```
78
72
 
79
- See the [Druxt Theming guide](https://druxtjs.org/guide/theming.html) for more information.
80
-
73
+ See the [Druxt Theming guide](https://druxtjs.org/guide/theming) for more information.
81
74
 
82
75
  ## Options
83
76
 
@@ -91,7 +84,6 @@ These options are specific to this module.
91
84
  | `menu.query.fields` | `string[]` | No | `false` | An array of fields to filter all JSON:API Menu queries. |
92
85
  | `menu.query.requiredOnly` | `boolean` | No | `false` | Whether to automatically filter to module defined minimum required fields. |
93
86
 
94
-
95
87
  ### Base Druxt options
96
88
 
97
89
  These options are available to all Druxt modules.
@@ -0,0 +1,15 @@
1
+ import DruxtMenu from './DruxtMenu.vue'
2
+
3
+ export default {
4
+ title: 'Druxt/Menu/DruxtMenu',
5
+ component: DruxtMenu
6
+ }
7
+
8
+ const Template = (args, { argTypes }) => ({
9
+ components: { DruxtMenu },
10
+ props: Object.keys(argTypes),
11
+ template: `<DruxtMenu v-bind="$props" />`
12
+ })
13
+
14
+ export const Default = Template.bind({})
15
+ Default.storyName = 'DruxtMenu'
@@ -13,9 +13,9 @@ async function DruxtMenuStorybook({ stories }) {
13
13
  for (const menu of collection.data) {
14
14
  const name = menu.attributes.drupal_internal__id;
15
15
  const { description, label } = menu.attributes;
16
- const title = titleFn(["Druxt Menu", label]);
16
+ const title = titleFn(["Druxt", "Menu", label]);
17
17
  addTemplate({
18
- src: resolve(__dirname, "../nuxt/druxt-menu.stories.js"),
18
+ src: resolve(__dirname, "../templates/druxt-menu.stories.js"),
19
19
  fileName: `stories/druxt-menu.${name}.stories.js`,
20
20
  options: { description, label, name, title }
21
21
  });
@@ -24,30 +24,36 @@ async function DruxtMenuStorybook({ stories }) {
24
24
  stories.push(resolve(options.buildDir, "./stories/druxt-menu.*.stories.js"));
25
25
  }
26
26
 
27
- const DruxtMenuNuxtModule = function() {
28
- if (typeof this.options === "undefined" || !this.options.druxt) {
29
- throw new TypeError("Druxt settings missing.");
30
- }
31
- const options = this.options.druxt;
27
+ const DruxtMenuNuxtModule = function(moduleOptions = {}) {
28
+ const options = {
29
+ baseUrl: moduleOptions.baseUrl,
30
+ ...(this.options || {}).druxt || {},
31
+ menu: {
32
+ ...((this.options || {}).druxt || {}).menu,
33
+ ...moduleOptions
34
+ }
35
+ };
32
36
  this.nuxt.hook("components:dirs", (dirs) => {
33
37
  dirs.push({ path: join(__dirname, "components") });
34
38
  dirs.push({ path: join(__dirname, "components/blocks") });
35
39
  });
36
40
  this.addPlugin({
37
- src: resolve(__dirname, "../nuxt/plugin.js"),
41
+ src: resolve(__dirname, "../templates/plugin.js"),
38
42
  fileName: "druxt-menu.js",
39
43
  options
40
44
  });
41
45
  this.options.store = true;
42
46
  this.addPlugin({
43
- src: resolve(__dirname, "../nuxt/store.js"),
47
+ src: resolve(__dirname, "../templates/store.js"),
44
48
  fileName: "store/druxt-menu.js",
45
49
  options
46
50
  });
47
51
  this.nuxt.hook("storybook:config", async ({ stories }) => {
52
+ stories.push("druxt-menu/dist/components/*.stories.mjs");
48
53
  await DruxtMenuStorybook.call(this, { stories });
49
54
  });
50
55
  };
56
+ DruxtMenuNuxtModule.meta = require("../package.json");
51
57
 
52
58
  class DruxtMenu {
53
59
  constructor(baseUrl, options = {}) {
@@ -112,7 +118,12 @@ class DruxtMenu {
112
118
  query.addFilter("parent", settings.parent);
113
119
  }
114
120
  const entities = [];
115
- const collections = await this.druxt.getCollectionAll(menuItemsResource, query);
121
+ let collections = [];
122
+ try {
123
+ collections = await this.druxt.getCollectionAll(menuItemsResource, query);
124
+ } catch (e) {
125
+ return { entities };
126
+ }
116
127
  for (const collection of collections) {
117
128
  for (const entity of collection.data) {
118
129
  entities.push({
@@ -17,9 +17,9 @@ async function DruxtMenuStorybook({ stories }) {
17
17
  for (const menu of collection.data) {
18
18
  const name = menu.attributes.drupal_internal__id;
19
19
  const { description, label } = menu.attributes;
20
- const title = titleFn(["Druxt Menu", label]);
20
+ const title = titleFn(["Druxt", "Menu", label]);
21
21
  addTemplate({
22
- src: path.resolve(__dirname, "../nuxt/druxt-menu.stories.js"),
22
+ src: path.resolve(__dirname, "../templates/druxt-menu.stories.js"),
23
23
  fileName: `stories/druxt-menu.${name}.stories.js`,
24
24
  options: { description, label, name, title }
25
25
  });
@@ -28,30 +28,36 @@ async function DruxtMenuStorybook({ stories }) {
28
28
  stories.push(path.resolve(options.buildDir, "./stories/druxt-menu.*.stories.js"));
29
29
  }
30
30
 
31
- const DruxtMenuNuxtModule = function() {
32
- if (typeof this.options === "undefined" || !this.options.druxt) {
33
- throw new TypeError("Druxt settings missing.");
34
- }
35
- const options = this.options.druxt;
31
+ const DruxtMenuNuxtModule = function(moduleOptions = {}) {
32
+ const options = {
33
+ baseUrl: moduleOptions.baseUrl,
34
+ ...(this.options || {}).druxt || {},
35
+ menu: {
36
+ ...((this.options || {}).druxt || {}).menu,
37
+ ...moduleOptions
38
+ }
39
+ };
36
40
  this.nuxt.hook("components:dirs", (dirs) => {
37
41
  dirs.push({ path: path.join(__dirname, "components") });
38
42
  dirs.push({ path: path.join(__dirname, "components/blocks") });
39
43
  });
40
44
  this.addPlugin({
41
- src: path.resolve(__dirname, "../nuxt/plugin.js"),
45
+ src: path.resolve(__dirname, "../templates/plugin.js"),
42
46
  fileName: "druxt-menu.js",
43
47
  options
44
48
  });
45
49
  this.options.store = true;
46
50
  this.addPlugin({
47
- src: path.resolve(__dirname, "../nuxt/store.js"),
51
+ src: path.resolve(__dirname, "../templates/store.js"),
48
52
  fileName: "store/druxt-menu.js",
49
53
  options
50
54
  });
51
55
  this.nuxt.hook("storybook:config", async ({ stories }) => {
56
+ stories.push("druxt-menu/dist/components/*.stories.mjs");
52
57
  await DruxtMenuStorybook.call(this, { stories });
53
58
  });
54
59
  };
60
+ DruxtMenuNuxtModule.meta = require("../package.json");
55
61
 
56
62
  class DruxtMenu {
57
63
  constructor(baseUrl, options = {}) {
@@ -116,7 +122,12 @@ class DruxtMenu {
116
122
  query.addFilter("parent", settings.parent);
117
123
  }
118
124
  const entities = [];
119
- const collections = await this.druxt.getCollectionAll(menuItemsResource, query);
125
+ let collections = [];
126
+ try {
127
+ collections = await this.druxt.getCollectionAll(menuItemsResource, query);
128
+ } catch (e) {
129
+ return { entities };
130
+ }
120
131
  for (const collection of collections) {
121
132
  for (const entity of collection.data) {
122
133
  entities.push({
package/package.json CHANGED
@@ -1,16 +1,33 @@
1
1
  {
2
2
  "name": "druxt-menu",
3
- "version": "0.13.0",
3
+ "version": "0.14.3",
4
4
  "description": "Drupal Menu and Menu item Druxt components, with support for the JSON:API Menu Items module.",
5
5
  "keywords": [
6
- "menu",
7
- "menus",
6
+ "cms",
7
+ "decoupled",
8
8
  "drupal",
9
9
  "druxt",
10
- "nuxt"
10
+ "druxtjs",
11
+ "headless",
12
+ "jsonapi",
13
+ "json:api",
14
+ "menu",
15
+ "menus",
16
+ "nuxt",
17
+ "nuxtjs",
18
+ "module",
19
+ "storybook",
20
+ "vue"
11
21
  ],
22
+ "homepage": "https://druxtjs.org",
23
+ "bugs": {
24
+ "url": "https://github.com/druxt/druxt.js/issues"
25
+ },
26
+ "repository": {
27
+ "type": "git",
28
+ "url": "git+https://github.com/druxt/druxt.js"
29
+ },
12
30
  "license": "MIT",
13
- "author": "Stuart Clark <stuart@realityloop.com> (realityloop.com)",
14
31
  "exports": {
15
32
  ".": {
16
33
  "require": "./dist/druxt-menu.ssr.js",
@@ -22,13 +39,13 @@
22
39
  "module": "dist/druxt-menu.esm.js",
23
40
  "files": [
24
41
  "dist",
25
- "nuxt"
42
+ "templates"
26
43
  ],
27
44
  "dependencies": {
28
45
  "deepmerge": "^4.2.2",
29
46
  "drupal-jsonapi-params": "^1.1.12",
30
- "druxt": "^0.10.0",
31
- "druxt-blocks": "^0.12.0"
47
+ "druxt": "^0.12.0",
48
+ "druxt-blocks": "^0.13.1"
32
49
  },
33
50
  "optionalDependencies": {
34
51
  "vue": "^2.6.14",
File without changes
File without changes
File without changes