druxt 0.19.1 → 0.20.0

package/dist/components/DruxtModule.vue

@@ -40,6 +40,11 @@ export default {
   props: {
     /**
      * The resource langcode.
+     *
+     * @example
+     * <DruxtModule langcode="en" />
+     *
+     * @type {string}
      */
     langcode: {
       type: String,
@@ -47,9 +52,15 @@ export default {
     },
 
     /**
-     * The module value.
+     * The module component model value.
+     *
+     * Used to bypass the Drupal JSON:API fetch, setting the module data
+     * directly.
+     *
+     * @example
+     * <DruxtModule v-model="{ foo: bar }" />
      *
-     * @type {(Array|Boolean|Date|Number|Object|String)}
+     * @type {*}
      * @model
      */
     value: {
@@ -71,7 +82,7 @@ export default {
      *   }"
      * />
      *
-     * @type {(Boolean|Object)}
+     * @type {(boolean|object)}
      */
     wrapper: {
       type: [Boolean, Object],

package/dist/druxt.esm.js

@@ -1,6 +1,6 @@
 import chalk from 'chalk';
 import { DrupalJsonApiParams } from 'drupal-jsonapi-params';
-import { join, resolve } from 'path';
+import { join, resolve, normalize } from 'path';
 import axios from 'axios';
 import { stringify } from 'querystring';
 import consola from 'consola';
@@ -135,7 +135,6 @@ class DruxtClient {
   async get(url, options) {
     try {
       const res = await this.axios.get(url, options);
-      this.checkPermissions(res);
       return res;
     } catch (err) {
       this.error(err, { url });
@@ -251,7 +250,7 @@ class DruxtClient {
 }
 
 var name = "druxt";
-var version = "0.19.1";
+var version = "0.20.0";
 var description = "The Fully Decoupled Drupal Framework for Nuxt.js.";
 var keywords = [
 	"cms",
@@ -285,7 +284,6 @@ var main = "dist/druxt.ssr.js";
 var module = "dist/druxt.esm.js";
 var files = [
 	"dist",
-	"stories",
 	"templates"
 ];
 var dependencies = {
@@ -340,6 +338,8 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
     ...moduleOptions,
     ...(this.options || {}).druxt
   };
+  this.options.baseUrl = options.baseUrl = options.baseUrl.endsWith("/") ? options.baseUrl.slice(0, -1) : options.baseUrl;
+  this.options.endpoint = options.endpoint = options.endpoint.startsWith("/") ? options.endpoint : `/${options.endpoint}`;
   const druxt = new DruxtClient(options.baseUrl, {
     ...options,
     proxy: { ...options.proxy || {}, api: false }
@@ -349,7 +349,7 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
     if ((options.proxy || {}).api) {
       proxies[options.endpoint] = options.baseUrl;
       const languageResourceType = "configurable_language--configurable_language";
-      if (await druxt.getIndex(languageResourceType)) {
+      if ((await druxt.getIndex(languageResourceType) || {}).href) {
         const query = new DrupalJsonApiParams().addFields(languageResourceType, ["drupal_internal__id"]);
         const languages = (await druxt.getCollectionAll(languageResourceType, query) || []).map((o) => o.data).flat().filter((o) => !["und", "zxx"].includes(((o || {}).attributes || {}).drupal_internal__id)).map((o) => o.attributes.drupal_internal__id);
         for (const langcode of languages) {
@@ -365,13 +365,13 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
     if (this.options.proxy) {
       if (Array.isArray(this.options.proxy)) {
         this.options.proxy = [
-          ...Object.keys(proxies).map((path) => `${options.baseUrl}${path}`),
-          ...this.options.proxy
+          ...this.options.proxy,
+          ...Object.keys(proxies).map((path) => `${options.baseUrl}${path}`)
         ];
       } else {
         this.options.proxy = {
-          ...proxies,
-          ...this.options.proxy
+          ...this.options.proxy,
+          ...proxies
         };
       }
     } else {
@@ -398,10 +398,10 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
   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 axiosIndex = plugins.findIndex(({ src }) => src === normalize(`${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 druxtIndex = plugins.findIndex(({ src }) => src === normalize(`${this.options.buildDir}/druxt.js`));
     const druxtPlugin = plugins[druxtIndex];
     plugins.splice(druxtIndex, 1);
     plugins = [axiosPlugin, druxtPlugin, ...plugins];
@@ -416,10 +416,23 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
   this.options.components = (_a = this.options.components) != null ? _a : true;
   this.options.cli.badgeMessages.push(`${chalk.blue.bold("Druxt")} @ v${meta.version}`);
   this.options.cli.badgeMessages.push(`${chalk.bold("API:")} ${chalk.blue.underline(options.baseUrl + options.endpoint)}`);
+  const self = this;
   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");
+    self.addTemplate({
+      src: resolve(__dirname, "../templates/stories/README.stories.mdx"),
+      fileName: "stories/druxt-README.stories.mdx"
+    });
+    stories.push(resolve(self.options.buildDir, "./stories/druxt-README.stories.mdx"));
+    self.addTemplate({
+      src: resolve(__dirname, "../templates/stories/druxt-module.stories.mdx"),
+      fileName: "stories/druxt-module.stories.mdx"
+    });
+    stories.push(resolve(self.options.buildDir, "./stories/druxt-module.stories.mdx"));
+    self.addTemplate({
+      src: resolve(__dirname, "../templates/stories/druxt-debug.stories.js"),
+      fileName: "stories/druxt-debug.stories.js"
+    });
+    stories.push(resolve(self.options.buildDir, "./stories/druxt-debug.stories.js"));
   });
 };
 

package/dist/druxt.ssr.js

@@ -148,7 +148,6 @@ class DruxtClient {
   async get(url, options) {
     try {
       const res = await this.axios.get(url, options);
-      this.checkPermissions(res);
       return res;
     } catch (err) {
       this.error(err, { url });
@@ -264,7 +263,7 @@ class DruxtClient {
 }
 
 var name = "druxt";
-var version = "0.19.1";
+var version = "0.20.0";
 var description = "The Fully Decoupled Drupal Framework for Nuxt.js.";
 var keywords = [
 	"cms",
@@ -298,7 +297,6 @@ var main = "dist/druxt.ssr.js";
 var module$1 = "dist/druxt.esm.js";
 var files = [
 	"dist",
-	"stories",
 	"templates"
 ];
 var dependencies = {
@@ -353,6 +351,8 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
     ...moduleOptions,
     ...(this.options || {}).druxt
   };
+  this.options.baseUrl = options.baseUrl = options.baseUrl.endsWith("/") ? options.baseUrl.slice(0, -1) : options.baseUrl;
+  this.options.endpoint = options.endpoint = options.endpoint.startsWith("/") ? options.endpoint : `/${options.endpoint}`;
   const druxt = new DruxtClient(options.baseUrl, {
     ...options,
     proxy: { ...options.proxy || {}, api: false }
@@ -362,7 +362,7 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
     if ((options.proxy || {}).api) {
       proxies[options.endpoint] = options.baseUrl;
       const languageResourceType = "configurable_language--configurable_language";
-      if (await druxt.getIndex(languageResourceType)) {
+      if ((await druxt.getIndex(languageResourceType) || {}).href) {
         const query = new drupalJsonapiParams.DrupalJsonApiParams().addFields(languageResourceType, ["drupal_internal__id"]);
         const languages = (await druxt.getCollectionAll(languageResourceType, query) || []).map((o) => o.data).flat().filter((o) => !["und", "zxx"].includes(((o || {}).attributes || {}).drupal_internal__id)).map((o) => o.attributes.drupal_internal__id);
         for (const langcode of languages) {
@@ -378,13 +378,13 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
     if (this.options.proxy) {
       if (Array.isArray(this.options.proxy)) {
         this.options.proxy = [
-          ...Object.keys(proxies).map((path) => `${options.baseUrl}${path}`),
-          ...this.options.proxy
+          ...this.options.proxy,
+          ...Object.keys(proxies).map((path) => `${options.baseUrl}${path}`)
         ];
       } else {
         this.options.proxy = {
-          ...proxies,
-          ...this.options.proxy
+          ...this.options.proxy,
+          ...proxies
         };
       }
     } else {
@@ -411,10 +411,10 @@ const DruxtNuxtModule = async function(moduleOptions = {}) {
   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 axiosIndex = plugins.findIndex(({ src }) => src === path.normalize(`${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 druxtIndex = plugins.findIndex(({ src }) => src === path.normalize(`${this.options.buildDir}/druxt.js`));
     const druxtPlugin = plugins[druxtIndex];
     plugins.splice(druxtIndex, 1);
     plugins = [axiosPlugin, druxtPlugin, ...plugins];
@@ -429,10 +429,23 @@ const DruxtNuxtModule = async 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)}`);
+  const self = this;
   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");
+    self.addTemplate({
+      src: path.resolve(__dirname, "../templates/stories/README.stories.mdx"),
+      fileName: "stories/druxt-README.stories.mdx"
+    });
+    stories.push(path.resolve(self.options.buildDir, "./stories/druxt-README.stories.mdx"));
+    self.addTemplate({
+      src: path.resolve(__dirname, "../templates/stories/druxt-module.stories.mdx"),
+      fileName: "stories/druxt-module.stories.mdx"
+    });
+    stories.push(path.resolve(self.options.buildDir, "./stories/druxt-module.stories.mdx"));
+    self.addTemplate({
+      src: path.resolve(__dirname, "../templates/stories/druxt-debug.stories.js"),
+      fileName: "stories/druxt-debug.stories.js"
+    });
+    stories.push(path.resolve(self.options.buildDir, "./stories/druxt-debug.stories.js"));
   });
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "druxt",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "The Fully Decoupled Drupal Framework for Nuxt.js.",
   "keywords": [
     "cms",
@@ -34,7 +34,6 @@
   "module": "dist/druxt.esm.js",
   "files": [
     "dist",
-    "stories",
     "templates"
   ],
   "dependencies": {

package/{dist/components/DruxtDebug.stories.mjs → templates/stories/druxt-debug.stories.js}

@@ -1,4 +1,4 @@
-import DruxtDebug from './DruxtDebug.vue'
+import DruxtDebug from 'druxt/dist/components/DruxtDebug.vue'
 
 export default {
   title: 'Druxt/DruxtDebug',
@@ -27,7 +27,9 @@ Json.args = {
 }
 Json.parameters = {
   docs: {
-    storyDescription: 'The **json** prop takes any data and runs it through a basic JSON formatter for improved readability.',
+    description: {
+      story: 'The **json** prop takes any data and runs it through a basic JSON formatter for improved readability.',
+    },
     source: {
       code: '<DruxtDebug :json="entity" open>Debug information</DruxtDebug>'
     },
@@ -40,7 +42,9 @@ Summary.args = {
 }
 Summary.parameters = {
   docs: {
-    storyDescription: 'The **summary** prop can be used to provide a quick explanation of the debug component.',
+    description: {
+      story: 'The **summary** prop can be used to provide a quick explanation of the debug component.',
+    },
     source: {
       code: `<DruxtDebug summary="${Summary.args.sumary}">Debug information</DruxtDebug>`
     },

package/{dist/components/DruxtModule.stories.mdx → templates/stories/druxt-module.stories.mdx}

@@ -102,7 +102,7 @@ Druxt module.
 import DruxtModule from 'druxt/dist/components/DruxtModule.vue'
 export default {
   name: 'MyModule',
-  extends: DruxtModule
+  extends: DruxtModule,
   druxt: {
     async fetchConfig() {
       // Load configuration data here.
@@ -113,7 +113,7 @@ export default {
     // Build nested arrays of component options based on the context.
     componentOptions: (context) => ([['default']]),
     // Map props data from the context.
-    propsData: (context) => ({ ...context }),
+    propsData: (context) => ({}),
     // Build slots render arrays.
     slots(h) {
       return {