druxt 0.15.0 → 0.18.0

package/dist/druxt.ssr.js

@@ -22,7 +22,7 @@ const md5__default = /*#__PURE__*/_interopDefaultLegacy(md5);
 const Vue__default = /*#__PURE__*/_interopDefaultLegacy(Vue);
 
 var name = "druxt";
-var version = "0.15.0";
+var version = "0.18.0";
 var description = "The Fully Decoupled Drupal Framework for Nuxt.js.";
 var keywords = [
 	"cms",
@@ -56,11 +56,12 @@ var main = "dist/druxt.ssr.js";
 var module$1 = "dist/druxt.esm.js";
 var files = [
 	"dist",
+	"stories",
 	"templates"
 ];
 var dependencies = {
+	"@nuxtjs/axios": "^5.13.6",
 	"@nuxtjs/proxy": "^2.1.0",
-	axios: "^0.21.1",
 	chalk: "^4.1.2",
 	deepmerge: "^4.2.2",
 	"drupal-jsonapi-params": "^1.2.1",
@@ -68,7 +69,11 @@ var dependencies = {
 	querystring: "^0.2.0",
 	scule: "^0.2.0"
 };
+var devDependencies = {
+	"@storybook/addon-docs": "^6.4.13"
+};
 var peerDependencies = {
+	axios: "*",
 	consola: "*"
 };
 var optionalDependencies = {
@@ -93,6 +98,7 @@ const meta = {
 	module: module$1,
 	files: files,
 	dependencies: dependencies,
+	devDependencies: devDependencies,
 	peerDependencies: peerDependencies,
 	optionalDependencies: optionalDependencies,
 	publishConfig: publishConfig
@@ -132,6 +138,14 @@ const DruxtNuxtModule = function(moduleOptions = {}) {
     }
     this.addModule("@nuxtjs/proxy");
   }
+  if (!options.axios) {
+    this.options.axios = {
+      baseURL: options.baseUrl,
+      proxy: !!this.options.proxy,
+      ...this.options.axios
+    };
+    this.addModule("@nuxtjs/axios");
+  }
   this.nuxt.hook("components:dirs", (dirs) => {
     dirs.push({ path: path.join(__dirname, "components") });
   });
@@ -140,6 +154,18 @@ const DruxtNuxtModule = function(moduleOptions = {}) {
     fileName: "druxt.js",
     options
   });
+  const extendPlugins = this.options.extendPlugins;
+  this.options.extendPlugins = (plugins) => {
+    plugins = typeof extendPlugins === "function" ? extendPlugins(plugins) : plugins;
+    const axiosIndex = plugins.findIndex(({ src }) => src === `${this.options.buildDir}/axios.js`);
+    const axiosPlugin = plugins[axiosIndex];
+    plugins.splice(axiosIndex, 1);
+    const druxtIndex = plugins.findIndex(({ src }) => src === `${this.options.buildDir}/druxt.js`);
+    const druxtPlugin = plugins[druxtIndex];
+    plugins.splice(druxtIndex, 1);
+    plugins = [axiosPlugin, druxtPlugin, ...plugins];
+    return plugins;
+  };
   this.addPlugin({
     src: path.resolve(__dirname, "../templates/store.js"),
     fileName: "store/druxt.js",
@@ -149,8 +175,12 @@ const DruxtNuxtModule = function(moduleOptions = {}) {
   this.options.components = (_a = this.options.components) != null ? _a : true;
   this.options.cli.badgeMessages.push(`${chalk__default['default'].blue.bold("Druxt")} @ v${meta.version}`);
   this.options.cli.badgeMessages.push(`${chalk__default['default'].bold("API:")} ${chalk__default['default'].blue.underline(options.baseUrl + options.endpoint)}`);
+  this.nuxt.hook("storybook:config", async ({ stories }) => {
+    stories.push("druxt/stories/*.stories.mdx");
+    stories.push("druxt/dist/components/*.stories.mdx");
+    stories.push("druxt/dist/components/*.stories.mjs");
+  });
 };
-DruxtNuxtModule.meta = meta;
 
 class DruxtClient {
   constructor(baseUrl, options = {}) {
@@ -160,14 +190,15 @@ class DruxtClient {
     if (!baseUrl) {
       throw new Error("The 'baseUrl' parameter is required.");
     }
-    let axiosSettings = {};
-    if (baseUrl && !(options.proxy || {}).api) {
-      axiosSettings.baseURL = baseUrl;
-    }
-    if (typeof options.axios === "object") {
-      axiosSettings = Object.assign(axiosSettings, options.axios);
+    this.axios = {};
+    if (typeof options.axios === "function") {
+      this.axios = options.axios;
+    } else {
+      this.axios = axios__default['default'].create({
+        ...options.axios || {},
+        baseURL: baseUrl
+      });
     }
-    this.axios = axios__default['default'].create(axiosSettings);
     if (options.debug) {
       const log = this.log;
       this.axios.interceptors.request.use((config) => {
@@ -219,9 +250,16 @@ class DruxtClient {
         }
       }
       if (Object.keys(permissions).length) {
-        throw new TypeError(`${res.data.meta.omitted.detail}
-
- Required permissions: ${Object.keys(permissions).join(", ")}.`);
+        const err = {
+          response: {
+            statusText: res.data.meta.omitted.detail,
+            data: {
+              errors: [{ detail: `Required permissions:
+ - ${Object.keys(permissions).join("\n - ")}` }]
+            }
+          }
+        };
+        throw err;
       }
     }
   }
@@ -241,19 +279,49 @@ class DruxtClient {
         }
       });
     } catch (err) {
-      response = (err.response || {}).data || err.message;
+      this.error(err, { url: href });
     }
     return response;
   }
+  error(err, context = {}) {
+    let { url } = context;
+    if (!url && ((err.response || {}).config || {}).url) {
+      url = err.response.config.url;
+    }
+    const title = [
+      (err.response || {}).status,
+      (err.response || {}).statusText || err.message
+    ].filter((s) => s).join(": ");
+    const meta = { url: url && [this.options.baseUrl, url].join("") };
+    let message = [title];
+    if (Object.values(meta).filter((o) => o).length) {
+      message.push(Object.entries(meta).filter(([, v]) => v).map(([key, value]) => `${key.toUpperCase()}: ${value}`).join("\n"));
+    }
+    if (((((err.response || {}).data || {}).errors || [])[0] || {}).detail) {
+      message.push(err.response.data.errors[0].detail);
+    }
+    const error = Error(message.join("\n\n"));
+    error.response = err.response;
+    error.druxt = context;
+    throw error;
+  }
+  async get(url, options) {
+    try {
+      const res = await this.axios.get(url, options);
+      this.checkPermissions(res);
+      return res;
+    } catch (err) {
+      this.error(err, { url });
+    }
+  }
   async getCollection(type, query) {
     const { href } = await this.getIndex(type);
     if (!href) {
       return false;
     }
     const url = this.buildQueryUrl(href, query);
-    const res = await this.axios.get(url);
-    this.checkPermissions(res);
-    return res.data;
+    const { data } = await this.get(url);
+    return data;
   }
   async getCollectionAll(type, query) {
     const collections = [];
@@ -273,16 +341,27 @@ class DruxtClient {
     if (this.index && resource) {
       return this.index[resource] ? this.index[resource] : false;
     }
-    let index = ((await this.axios.get(this.options.endpoint) || {}).data || {}).links;
+    const url = this.options.endpoint;
+    const { data } = await this.get(url);
+    let index = data.links;
+    if (typeof index !== "object") {
+      const err = { response: { statusText: "Invalid JSON:API endpoint" } };
+      this.error(err, { url });
+    }
     const baseUrl = this.options.baseUrl;
     index = Object.fromEntries(Object.entries(index).map(([key, value]) => {
       value.href = value.href.replace(baseUrl, "");
       return [key, value];
     }));
     if (index[this.options.jsonapiResourceConfig]) {
-      const resources = await this.axios.get(index[this.options.jsonapiResourceConfig].href);
-      for (const resourceType in resources.data.data) {
-        const resource2 = resources.data.data[resourceType];
+      let resources = [];
+      try {
+        resources = (await this.get(index[this.options.jsonapiResourceConfig].href)).data.data;
+      } catch (err) {
+        this.log.warn(err.message);
+      }
+      for (const resourceType in resources) {
+        const resource2 = resources[resourceType];
         const internal = resource2.attributes.drupal_internal__id.split("--");
         const item = {
           resourceType: resource2.attributes.resourceType,
@@ -298,11 +377,7 @@ class DruxtClient {
       }
     }
     this.index = index;
-    if (resource) {
-      const response = this.index[resource] ? this.index[resource] : false;
-      return response;
-    }
-    return this.index;
+    return resource ? this.index[resource] || false : this.index;
   }
   async getRelated(type, id, related, query) {
     if (!id || !type || !related) {
@@ -313,12 +388,8 @@ class DruxtClient {
       href = this.options.endpoint + "/" + type.replace("--", "/");
     }
     const url = this.buildQueryUrl(`${href}/${id}/${related}`, query);
-    try {
-      const related2 = await this.axios.get(url);
-      return related2.data;
-    } catch (e) {
-      return false;
-    }
+    const { data } = await this.get(url);
+    return data;
   }
   async getResource(type, id, query) {
     if (!id || !type) {
@@ -328,13 +399,9 @@ class DruxtClient {
     if (!href) {
       href = this.options.endpoint + "/" + type.replace("--", "/");
     }
-    const url = this.buildQueryUrl(`${href}/${id}`, query);
-    try {
-      const resource = await this.axios.get(url);
-      return resource.data;
-    } catch (e) {
-      return false;
-    }
+    const url = this.buildQueryUrl([href, id].join("/"), query);
+    const { data } = await this.get(url);
+    return data;
   }
   async updateResource(resource) {
     const { href } = await this.getIndex(resource.type);
@@ -350,7 +417,7 @@ class DruxtClient {
         }
       });
     } catch (err) {
-      response = (err.response || {}).data || err.message;
+      this.error(err);
     }
     return response;
   }
@@ -361,7 +428,7 @@ const getDrupalJsonApiParams = (query) => {
 };
 
 const dehydrateResources = ({ commit, queryObject, resources }) => {
-  return resources.map((data) => {
+  return (resources || []).map((data) => {
     const link = decodeURI(((data.links || {}).self || {}).href || "");
     const href = typeof (queryObject.fields || {})[data.type] === "string" ? [link.split("?")[0], `fields[${data.type}]=${queryObject.fields[data.type]}`].join("?") : link;
     commit("druxt/addResource", {
@@ -552,6 +619,8 @@ class DruxtClass {
   }
 }
 
+DruxtNuxtModule.meta = require("../package.json");
+
 exports.DruxtClass = DruxtClass;
 exports.DruxtClient = DruxtClient;
 exports.DruxtStore = DruxtStore;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "druxt",
-  "version": "0.15.0",
+  "version": "0.18.0",
   "description": "The Fully Decoupled Drupal Framework for Nuxt.js.",
   "keywords": [
     "cms",
@@ -34,11 +34,12 @@
   "module": "dist/druxt.esm.js",
   "files": [
     "dist",
+    "stories",
     "templates"
   ],
   "dependencies": {
+    "@nuxtjs/axios": "^5.13.6",
     "@nuxtjs/proxy": "^2.1.0",
-    "axios": "^0.21.1",
     "chalk": "^4.1.2",
     "deepmerge": "^4.2.2",
     "drupal-jsonapi-params": "^1.2.1",
@@ -46,7 +47,11 @@
     "querystring": "^0.2.0",
     "scule": "^0.2.0"
   },
+  "devDependencies": {
+    "@storybook/addon-docs": "^6.4.13"
+  },
   "peerDependencies": {
+    "axios": "*",
     "consola": "*"
   },
   "optionalDependencies": {

package/stories/README.stories.mdx

@@ -0,0 +1,74 @@
+import { Meta } from '@storybook/addon-docs'
+
+<Meta title="Druxt/README" />
+
+# Druxt Storybook
+
+> Druxt + @nuxtjs/Storybook
+
+The following documentation and stories are provided by
+[DruxtJS](https://druxtjs.org) and the installed Druxt modules.
+
+The stories are connected to your Drupal JSON:API via the DruxtClient; this
+allows you to test your Druxt Wrapper components using live data.
+
+- For more information, refer to the
+[Druxt Storybook guide](https://druxtjs.org/guide/storybook).
+
+---
+
+## Introduction
+
+This is a live Druxt Storybook, with autogenerated stories based on the
+configuration of your Drupal backend.
+
+---
+
+### Autogenerated stories
+
+Each Druxt module is able to use configuration from your Drupal backend to craft
+site specific stories.
+
+For instance, the DruxtEntity module will create a story for each Entity type,
+Bundle and Display mode, while the Block module will create a story for each
+backend Theme, Region and Block.
+
+Search or navigate through the Druxt components and stories in the Storybook
+sidebar.
+
+---
+
+### What is Druxt?
+
+> Drupal + Nuxt = Druxt
+
+Druxt is a framework for building Fully Decoupled Drupal and Nuxt.js
+applications and sites. It allows you to leverage the content modelling and
+management power of Drupal, and build elegant user experiences with Nuxt.js.
+
+- Find out more @ [DruxtJS.org](https://druxtjs.org)
+
+---
+
+### Druxt components
+
+Druxt components are provided by Druxt modules to provide targetted decoupled
+Drupal functionality; A **DruxtEntity** component to render Drupal Content
+entities, or a **DruxtMenu** component to render a Drupal menu, etc.
+
+- See the core Druxt components @
+  [https://druxtjs.org/api/components](https://druxtjs.org/api/components)
+
+---
+
+### Druxt Wrapper theme system
+
+Druxt components that extend the **DruxtModule** use slot based wrapper system,
+providing the frontend developer the ability to create theme templates per
+Content type, or Display mode, and many more component options depending on the
+module.
+
+The available component options are provided via the `component.options` data
+on the relevant Druxt module component.
+
+- For more information, see the [Themeing guide](https://druxtjs.org/guide/theming)

package/templates/plugin.js

@@ -1,6 +1,6 @@
 import { DruxtClient } from 'druxt'
 
-export default (context, inject) => {
+export default ({ app }, inject) => {
   const options = <%= JSON.stringify(options) %>
 
   // Disable the proxy for server side requests.
@@ -8,6 +8,15 @@ export default (context, inject) => {
     options.proxy.api = false
   }
 
+  <% if (typeof options.axios === 'object') { %>
+  // Axios settings.
+  console.warn('[druxt] Axios instance settings are deprecated, use @nuxtjs/axios module configuration instead.')
+  options.axios = <%= JSON.stringify(options.axios) %>
+  <% } else { %>
+  // Use the @nuxtjs/axios module Axios instance.
+  options.axios = app.$axios
+  <% } %>
+
   const druxt = new DruxtClient(options.baseUrl, options)
   druxt.settings = options
   inject('druxt', druxt)