druxt 0.25.0-dev.20261022212039 → 0.25.0-dev.20261023045951

package/README.md

@@ -90,36 +90,9 @@ options list.
 ## Server cache
 
 In production, the server keeps Drupal's responses between requests for as
-long as Drupal's `Cache-Control` header allows. It keeps the JSON:API index and
-menus, and with `cache.content` every other response Druxt fetches, as
-[Caching content](#caching-content) describes. Drupal sets that header
-from the page cache maximum age (Administration > Configuration > Development >
-Performance). At the default of 0, nothing is kept. A request with an
-`Authorization` header or a Drupal session cookie never reads or fills the
-cache. The cache is off under `nuxt dev`.
-
-| Option                | Type      | Default             | Description                                                         |
-| --------------------- | --------- | ------------------- | ------------------------------------------------------------------- |
-| `cache.content`       | `boolean` | `false`             | Also keep entities, collections, views and route lookups.           |
-| `cache.maxSize`       | `number`  | `52428800` (50 MB)  | Bytes of responses kept per cache area. The least recently used go. |
-| `cache.ttl`           | `number`  |                     | Seconds a response may be kept at most. `0` keeps nothing.          |
-| `cache.secret`        | `string`  |                     | Turns on `POST /_druxt/cache/clear`.                                |
-| `cache.sessionCookie` | `string`  | `'S?SESS[0-9a-f]+'` | A pattern for the session cookie name, for a proxy that renames it. |
-
-Clear the cache from the app with `this.$store.dispatch('druxt/clearCache')`,
-or from Drupal by sending `POST /_druxt/cache/clear` with the secret in an
-`X-Druxt-Secret` header. Each Nuxt process has its own cache, so a site with
-several processes clears each one.
-
-The endpoint is server middleware, so list Druxt, or the module that adds it
-such as `druxt-site`, under `modules`. Nuxt runs `buildModules` only while it
-builds, so under `nuxt start` the endpoint would answer 404.
-
-### Caching content
-
-`cache.content` extends the cache to every other request Druxt sends Drupal:
-entities, collections, views and route lookups. A second visitor to a page
-then costs Drupal nothing until the page's lifetime runs out.
+long as Drupal's `Cache-Control` header allows: the JSON:API index and menus,
+and with `cache.content` every other response. Drupal sets that header from
+its page cache maximum age, so at the default of 0 nothing is kept.
 
 ```js
 // nuxt.config.js
@@ -130,35 +103,46 @@ export default {
 };
 ```
 
-Content changes far more often than menus, so pair it with a clear from
-Drupal, below. Without one, an edit reaches anonymous visitors only once the
-page cache maximum age has passed. Only successful responses are kept, so a
-page published after a visitor saw a 404 appears straight away. A
-`bypassCache` dispatch to the Druxt store also skips this cache and stores the
-fresh response.
-
-`cache.maxSize` counts the bytes of the stored JSON, and it applies to each
-cache area and consumer. A full cache can take about three times that in server
-memory, so size it against the memory each Nuxt process has. A response larger
-than the whole limit is not kept.
+| Option                | Type      | Default             | Description                                                                      |
+| --------------------- | --------- | ------------------- | -------------------------------------------------------------------------------- |
+| `cache.content`       | `boolean` | `false`             | Also keep entities, collections, views and route lookups.                        |
+| `cache.maxSize`       | `number`  | `52428800` (50 MB)  | Bytes of responses kept per cache area and consumer. The least recently used go. |
+| `cache.ttl`           | `number`  |                     | Seconds a response may be kept at most. `0` keeps nothing.                       |
+| `cache.secret`        | `string`  |                     | Turns on `POST /_druxt/cache/clear`.                                             |
+| `cache.sessionCookie` | `string`  | `'S?SESS[0-9a-f]+'` | A pattern for the session cookie name, for a proxy that renames it.              |
+
+- A request with an `Authorization` header or a Drupal session cookie skips
+  the cache, and `nuxt dev` runs without it.
+- Only successful responses are kept. A `bypassCache` dispatch fetches afresh
+  and stores the result.
+- A full cache area takes about three times `cache.maxSize` in server memory,
+  and a response larger than the limit is not kept.
+- Clear it with `druxt/clearCache`, or from Drupal with
+  `POST /_druxt/cache/clear` and the secret in an `X-Druxt-Secret` header.
+  Each Nuxt process has its own cache to clear.
+- The clear endpoint is server middleware, so list Druxt, or `druxt-site`,
+  under `modules`. Nuxt skips `buildModules` under `nuxt start`.
+
+The [caching guide](https://druxtjs.org/how-to/caching) covers the cache in
+more depth.
 
 ### Clearing from Drupal with Purge
 
-The [Purge](https://www.drupal.org/project/purge) module can send that request
-whenever content changes. Enable `purge`, `purge_purger_http`,
-`purge_queuer_coretags` and a processor such as `purge_processor_lateruntime`,
-then add the bundled HTTP purger:
+With `cache.content` on, an edit can take up to the page cache maximum age, or
+`cache.ttl` if that is shorter, to reach anonymous visitors, unless Drupal
+clears the cache. The
+[Purge](https://www.drupal.org/project/purge) module can send that request on
+every save. Enable `purge`, `purge_purger_http`, `purge_queuer_coretags` and
+`purge_processor_lateruntime`, then add the bundled HTTP purger:
 
 ```sh
 drush p:purger-add httpbundled
 ```
 
-Give it the method `POST`, the Nuxt host and port, the path
-`/_druxt/cache/clear`, a header `X-Druxt-Secret` with the secret, and the
-invalidation type `tag`. One save then costs one request, whatever it
-invalidates, and a request refused for a wrong secret is sent again with the
-next batch. Keep the secret out of exported configuration: set it from
-`settings.php` as a `$config` override.
+Point it at the Nuxt server's host and port, as Drupal reaches it, with the
+path `/_druxt/cache/clear`, the method `POST`, the `X-Druxt-Secret` header and
+the invalidation type `tag`. Set the secret from `settings.php` as
+a `$config` override, not in exported configuration.
 
 ## DruxtClient
 

package/dist/druxt.esm.js

@@ -553,7 +553,7 @@ const cacheClearHandler = (secret) => (req, res) => {
 };
 
 var name = "druxt";
-var version = "0.25.0-dev.20261022212039";
+var version = "0.25.0-dev.20261023045951";
 var description = "The Fully Decoupled Drupal Framework for Nuxt.js.";
 var keywords = [
 	"cms",
@@ -614,7 +614,7 @@ var dependencies = {
 };
 var devDependencies = {
 	"@storybook/addon-docs": "^6.5.16",
-	"druxt-test-utils": "0.2.16-dev.20261022212039"
+	"druxt-test-utils": "0.2.16-dev.20261023045951"
 };
 var peerDependencies = {
 	axios: ">=0.34.0",
@@ -782,6 +782,20 @@ const getDrupalJsonApiParams = (query) => {
   return new DrupalJsonApiParams().initialize(query);
 };
 
+const includePaths = (include) => (Array.isArray(include) ? include : String(include || "").split(",")).map((path) => String(path).trim()).filter((path) => path);
+const topIncludes = (include) => Array.from(new Set(includePaths(include).map((path) => path.split(".")[0])));
+const subIncludes = (include, key) => includePaths(include).filter((path) => path.startsWith(`${key}.`)).map((path) => path.slice(key.length + 1)).join(",");
+const fieldsWithIncludes = (fields, include) => Array.from(new Set([...String(fields).split(","), ...topIncludes(include)])).filter((field) => field).join(",");
+const includesFor = (include, fields, relationships = []) => {
+  if (!include || typeof fields !== "string")
+    return include;
+  const listed = fields.split(",");
+  return includePaths(include).filter((path) => {
+    const key = path.split(".")[0];
+    return listed.includes(key) || relationships.includes(key);
+  }).join(",");
+};
+
 const dehydrateResources = ({ commit, queryObject, resources, prefix }) => {
   return (resources || []).map((data) => {
     const link = decodeURI(((data.links || {}).self || {}).href || "");
@@ -955,22 +969,25 @@ const DruxtStore = ({ store }) => {
         const queryObject = getDrupalJsonApiParams(query).getQueryObject();
         queryObject.include = Array.isArray(queryObject.include) ? queryObject.include.join(",") : queryObject.include;
         if (queryObject.include && typeof (queryObject.fields || {})[type] === "string") {
-          const fields2 = queryObject.fields[type].split(",").filter((s) => s);
-          const includes = queryObject.include.split(",").filter((s) => s && !s.includes("."));
-          queryObject.fields[type] = Array.from(new Set([...fields2, ...includes])).filter((s) => s).join(",");
+          queryObject.fields[type] = fieldsWithIncludes(queryObject.fields[type], queryObject.include);
         }
+        const includeFor = (related, include) => {
+          const stored2 = ((state.resources[related.type] || {})[related.id] || {})[prefix];
+          const relationships = Object.keys(((stored2 || {}).data || {}).relationships || {});
+          return includesFor(include, (queryObject.fields || {})[related.type], relationships);
+        };
         let included = [];
         if (queryObject.include && storedResource && !bypassCache) {
-          const resources = await Promise.all(queryObject.include.split(",").filter((s) => Object.keys(storedResource.data.relationships || {}).includes(s)).map((key) => {
+          const resources = await Promise.all(topIncludes(queryObject.include).filter((s) => Object.keys(storedResource.data.relationships || {}).includes(s)).map((key) => {
             let { data } = storedResource.data.relationships[key];
             data = Array.isArray(data) ? data : [data];
-            const include = queryObject.include.split(",").filter((s) => s.startsWith(`${key}.`)).map((s) => s.slice(key.length + 1)).join(",");
+            const include = subIncludes(queryObject.include, key);
             return data.filter((o) => typeof o === "object" && o).map((o) => {
               return dispatch("getResource", {
                 id: o.id,
                 prefix,
                 type: o.type,
-                query: { ...queryObject, include }
+                query: { ...queryObject, include: includeFor(o, include) }
               });
             });
           }).flat());

package/dist/druxt.ssr.js

@@ -566,7 +566,7 @@ const cacheClearHandler = (secret) => (req, res) => {
 };
 
 var name = "druxt";
-var version = "0.25.0-dev.20261022212039";
+var version = "0.25.0-dev.20261023045951";
 var description = "The Fully Decoupled Drupal Framework for Nuxt.js.";
 var keywords = [
 	"cms",
@@ -627,7 +627,7 @@ var dependencies = {
 };
 var devDependencies = {
 	"@storybook/addon-docs": "^6.5.16",
-	"druxt-test-utils": "0.2.16-dev.20261022212039"
+	"druxt-test-utils": "0.2.16-dev.20261023045951"
 };
 var peerDependencies = {
 	axios: ">=0.34.0",
@@ -795,6 +795,20 @@ const getDrupalJsonApiParams = (query) => {
   return new drupalJsonapiParams.DrupalJsonApiParams().initialize(query);
 };
 
+const includePaths = (include) => (Array.isArray(include) ? include : String(include || "").split(",")).map((path) => String(path).trim()).filter((path) => path);
+const topIncludes = (include) => Array.from(new Set(includePaths(include).map((path) => path.split(".")[0])));
+const subIncludes = (include, key) => includePaths(include).filter((path) => path.startsWith(`${key}.`)).map((path) => path.slice(key.length + 1)).join(",");
+const fieldsWithIncludes = (fields, include) => Array.from(new Set([...String(fields).split(","), ...topIncludes(include)])).filter((field) => field).join(",");
+const includesFor = (include, fields, relationships = []) => {
+  if (!include || typeof fields !== "string")
+    return include;
+  const listed = fields.split(",");
+  return includePaths(include).filter((path) => {
+    const key = path.split(".")[0];
+    return listed.includes(key) || relationships.includes(key);
+  }).join(",");
+};
+
 const dehydrateResources = ({ commit, queryObject, resources, prefix }) => {
   return (resources || []).map((data) => {
     const link = decodeURI(((data.links || {}).self || {}).href || "");
@@ -968,22 +982,25 @@ const DruxtStore = ({ store }) => {
         const queryObject = getDrupalJsonApiParams(query).getQueryObject();
         queryObject.include = Array.isArray(queryObject.include) ? queryObject.include.join(",") : queryObject.include;
         if (queryObject.include && typeof (queryObject.fields || {})[type] === "string") {
-          const fields2 = queryObject.fields[type].split(",").filter((s) => s);
-          const includes = queryObject.include.split(",").filter((s) => s && !s.includes("."));
-          queryObject.fields[type] = Array.from(new Set([...fields2, ...includes])).filter((s) => s).join(",");
+          queryObject.fields[type] = fieldsWithIncludes(queryObject.fields[type], queryObject.include);
         }
+        const includeFor = (related, include) => {
+          const stored2 = ((state.resources[related.type] || {})[related.id] || {})[prefix];
+          const relationships = Object.keys(((stored2 || {}).data || {}).relationships || {});
+          return includesFor(include, (queryObject.fields || {})[related.type], relationships);
+        };
         let included = [];
         if (queryObject.include && storedResource && !bypassCache) {
-          const resources = await Promise.all(queryObject.include.split(",").filter((s) => Object.keys(storedResource.data.relationships || {}).includes(s)).map((key) => {
+          const resources = await Promise.all(topIncludes(queryObject.include).filter((s) => Object.keys(storedResource.data.relationships || {}).includes(s)).map((key) => {
             let { data } = storedResource.data.relationships[key];
             data = Array.isArray(data) ? data : [data];
-            const include = queryObject.include.split(",").filter((s) => s.startsWith(`${key}.`)).map((s) => s.slice(key.length + 1)).join(",");
+            const include = subIncludes(queryObject.include, key);
             return data.filter((o) => typeof o === "object" && o).map((o) => {
               return dispatch("getResource", {
                 id: o.id,
                 prefix,
                 type: o.type,
-                query: { ...queryObject, include }
+                query: { ...queryObject, include: includeFor(o, include) }
               });
             });
           }).flat());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "druxt",
-  "version": "0.25.0-dev.20261022212039",
+  "version": "0.25.0-dev.20261023045951",
   "description": "The Fully Decoupled Drupal Framework for Nuxt.js.",
   "keywords": [
     "cms",
@@ -61,7 +61,7 @@
   },
   "devDependencies": {
     "@storybook/addon-docs": "^6.5.16",
-    "druxt-test-utils": "0.2.16-dev.20261022212039"
+    "druxt-test-utils": "0.2.16-dev.20261023045951"
   },
   "peerDependencies": {
     "axios": ">=0.34.0",