strapi-plugin-populate-all 1.4.1 → 1.5.0

package/README.md

@@ -51,4 +51,4 @@ module.exports = {
 - The plugin provides a global middleware that intercepts requests with `?populate=all` and rewrites the query to trigger recursive population.
 - In the background, it builds a standard Strapi populate query as described in the [Strapi documentation](https://docs.strapi.io/cms/api/rest/populate-select).
 - You can control which relations are included using the relations config option.
-- Inside the document API, you can set `populate: '*'` and `populateAll: true` to make it work
+- Inside the document API, you can set `populate: '*'` and `_q: "populate-all"` to make it work ("populate-all" can be anywhere inside `_q`, we detect it via .includes)

package/dist/server/index.js

@@ -1,4 +1,39 @@
 "use strict";
+const PLUGIN_QUERY_DOCUMENT_TAG = "populate-all";
+const config = {
+  default: {
+    relations: true
+  },
+  validator(config2 = {}) {
+    for (const [key, value] of Object.entries(config2)) {
+      switch (key) {
+        case "cache": {
+          const isBoolean = typeof value === "boolean";
+          if (!isBoolean) {
+            throw new Error(
+              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported is boolean.`
+            );
+          }
+          break;
+        }
+        case "relations": {
+          const isBoolean = typeof value === "boolean";
+          const isArrayOfStrings = Array.isArray(value) && value?.every((relation) => typeof relation === "string");
+          if (!(isBoolean || isArrayOfStrings)) {
+            throw new Error(
+              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported are boolean or Array of strings.`
+            );
+          }
+          break;
+        }
+        default:
+          strapi.log.warn(
+            `[populate-all] unknown config "${key}" provided. This config will be ignored.`
+          );
+      }
+    }
+  }
+};
 const queryCache = {};
 const getPopulateQuery = (modelUid, parentsModelUids = []) => {
   try {
@@ -86,7 +121,7 @@ const bootstrap = ({ strapi: strapi2 }) => {
   strapi2.db.lifecycles.subscribe((event) => {
     try {
       if (event.action === "beforeFindMany" || event.action === "beforeFindOne") {
-        if (strapi2.requestContext.get()?.query?.populateAll) {
+        if (event.params._q?.includes(PLUGIN_QUERY_DOCUMENT_TAG)) {
           strapi2.log.debug(
             `[populate-all] recursively populate ${event.model.uid}`
           );
@@ -94,6 +129,12 @@ const bootstrap = ({ strapi: strapi2 }) => {
           if (populateQuery?.populate) {
             event.params.populate = populateQuery.populate;
           }
+          const query = event.params._q.replace(PLUGIN_QUERY_DOCUMENT_TAG, "");
+          if (query.length > 0) {
+            event.params._q = query;
+          } else {
+            delete event.params._q;
+          }
         }
       }
     } catch (error) {
@@ -103,40 +144,6 @@ const bootstrap = ({ strapi: strapi2 }) => {
     }
   });
 };
-const config = {
-  default: {
-    relations: true
-  },
-  validator(config2 = {}) {
-    for (const [key, value] of Object.entries(config2)) {
-      switch (key) {
-        case "cache": {
-          const isBoolean = typeof value === "boolean";
-          if (!isBoolean) {
-            throw new Error(
-              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported is boolean.`
-            );
-          }
-          break;
-        }
-        case "relations": {
-          const isBoolean = typeof value === "boolean";
-          const isArrayOfStrings = Array.isArray(value) && value?.every((relation) => typeof relation === "string");
-          if (!(isBoolean || isArrayOfStrings)) {
-            throw new Error(
-              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported are boolean or Array of strings.`
-            );
-          }
-          break;
-        }
-        default:
-          strapi.log.warn(
-            `[populate-all] unknown config "${key}" provided. This config will be ignored.`
-          );
-      }
-    }
-  }
-};
 const middlewares = {
   /**
    * This is a global middleware to add support for the custom query param `?populate=all`.
@@ -145,9 +152,12 @@ const middlewares = {
    * The bootstrap script later picks up `?populateAll=true` to apply the desired populate logic.
    */
   populateAll: async (ctx, next) => {
+    if (ctx.query.populateAll && ctx.query.populateAll !== "false" || ctx.query.populateAll === null) {
+      ctx.query._q = [ctx.query._q || "", PLUGIN_QUERY_DOCUMENT_TAG].join("");
+    }
     if (ctx.query.populate === "all") {
       ctx.query.populate = void 0;
-      ctx.query.populateAll = true;
+      ctx.query._q = [ctx.query._q || "", PLUGIN_QUERY_DOCUMENT_TAG].join("");
     }
     await next();
   }

package/dist/server/index.mjs

@@ -1,3 +1,38 @@
+const PLUGIN_QUERY_DOCUMENT_TAG = "populate-all";
+const config = {
+  default: {
+    relations: true
+  },
+  validator(config2 = {}) {
+    for (const [key, value] of Object.entries(config2)) {
+      switch (key) {
+        case "cache": {
+          const isBoolean = typeof value === "boolean";
+          if (!isBoolean) {
+            throw new Error(
+              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported is boolean.`
+            );
+          }
+          break;
+        }
+        case "relations": {
+          const isBoolean = typeof value === "boolean";
+          const isArrayOfStrings = Array.isArray(value) && value?.every((relation) => typeof relation === "string");
+          if (!(isBoolean || isArrayOfStrings)) {
+            throw new Error(
+              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported are boolean or Array of strings.`
+            );
+          }
+          break;
+        }
+        default:
+          strapi.log.warn(
+            `[populate-all] unknown config "${key}" provided. This config will be ignored.`
+          );
+      }
+    }
+  }
+};
 const queryCache = {};
 const getPopulateQuery = (modelUid, parentsModelUids = []) => {
   try {
@@ -85,7 +120,7 @@ const bootstrap = ({ strapi: strapi2 }) => {
   strapi2.db.lifecycles.subscribe((event) => {
     try {
       if (event.action === "beforeFindMany" || event.action === "beforeFindOne") {
-        if (strapi2.requestContext.get()?.query?.populateAll) {
+        if (event.params._q?.includes(PLUGIN_QUERY_DOCUMENT_TAG)) {
           strapi2.log.debug(
             `[populate-all] recursively populate ${event.model.uid}`
           );
@@ -93,6 +128,12 @@ const bootstrap = ({ strapi: strapi2 }) => {
           if (populateQuery?.populate) {
             event.params.populate = populateQuery.populate;
           }
+          const query = event.params._q.replace(PLUGIN_QUERY_DOCUMENT_TAG, "");
+          if (query.length > 0) {
+            event.params._q = query;
+          } else {
+            delete event.params._q;
+          }
         }
       }
     } catch (error) {
@@ -102,40 +143,6 @@ const bootstrap = ({ strapi: strapi2 }) => {
     }
   });
 };
-const config = {
-  default: {
-    relations: true
-  },
-  validator(config2 = {}) {
-    for (const [key, value] of Object.entries(config2)) {
-      switch (key) {
-        case "cache": {
-          const isBoolean = typeof value === "boolean";
-          if (!isBoolean) {
-            throw new Error(
-              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported is boolean.`
-            );
-          }
-          break;
-        }
-        case "relations": {
-          const isBoolean = typeof value === "boolean";
-          const isArrayOfStrings = Array.isArray(value) && value?.every((relation) => typeof relation === "string");
-          if (!(isBoolean || isArrayOfStrings)) {
-            throw new Error(
-              `[populate-all] config "${key}" of type ${typeof value} is not valid. Supported are boolean or Array of strings.`
-            );
-          }
-          break;
-        }
-        default:
-          strapi.log.warn(
-            `[populate-all] unknown config "${key}" provided. This config will be ignored.`
-          );
-      }
-    }
-  }
-};
 const middlewares = {
   /**
    * This is a global middleware to add support for the custom query param `?populate=all`.
@@ -144,9 +151,12 @@ const middlewares = {
    * The bootstrap script later picks up `?populateAll=true` to apply the desired populate logic.
    */
   populateAll: async (ctx, next) => {
+    if (ctx.query.populateAll && ctx.query.populateAll !== "false" || ctx.query.populateAll === null) {
+      ctx.query._q = [ctx.query._q || "", PLUGIN_QUERY_DOCUMENT_TAG].join("");
+    }
     if (ctx.query.populate === "all") {
       ctx.query.populate = void 0;
-      ctx.query.populateAll = true;
+      ctx.query._q = [ctx.query._q || "", PLUGIN_QUERY_DOCUMENT_TAG].join("");
     }
     await next();
   }

package/dist/server/src/config/index.d.ts

@@ -1,3 +1,4 @@
+export declare const PLUGIN_QUERY_DOCUMENT_TAG = "populate-all";
 declare const _default: {
     default: {
         relations: boolean;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.4.1",
+  "version": "1.5.0",
   "name": "strapi-plugin-populate-all",
   "description": "A lightweight plugin to recursively populate nested data in RESTful API requests",
   "keywords": [],