@fourlights/strapi-plugin-deep-populate 1.13.0-rc.0 → 1.14.0

package/README.md

@@ -149,7 +149,26 @@ Settings are applied in the following priority order (highest to lowest):
 
 ### Caching
 
-The plugin caches populate objects to improve performance. Cache can be disabled via the `useCache` setting.
+The plugin caches populate objects to improve performance. Cache can be disabled
+via the `useCache` setting.  Cache entires are persisted in the database and can
+become stale after content-type updates. You can use the `cacheOptions > clearCacheOnStartup` to force cache purging on server start.
+
+#### Cache Configuration
+
+```js
+// config/plugins.js
+module.exports = ({ env }) => ({
+  'deep-populate': {
+    enabled: true,
+    config: {
+      useCache: true, // Enable caching (default: true)
+      cacheOptions: {
+        clearCacheOnStartup: false, // Clear cache on server startup (default: false)
+      }
+    }
+  }
+});
+```
 
 ### Creator Fields
 
@@ -194,3 +213,30 @@ The plugin recursively:
 4. Returns a complete populate object
 
 This process handles all relation types including dynamic zones and circular references.
+
+----
+
+## Troubleshooting
+
+Due to the dynamic nature of Strapi, stuff becomes complex pretty quickly and it can sometimes become tricky to see the proverbial forest through the trees.
+In that case, feel free to open up an issue and I'll try to help you out.
+
+But first, make sure you:
+
+1. use the latest version of the plugin
+2. use the latest version of Strapi
+3. see if disabling the cache fixes the problem
+4. check if your content-types are still valid, e.g. no dynamic zones who reference deleted components etc.
+5. check you don't have attributes/relations marked as private if you expect them in the API response
+
+If that didn't fix it, open up that issue! Make sure you report the used versions (plugin & strapi) and preferably share the affected content-type definitions. Or even better, a reproduction of the problem.
+
+----
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=Four-Lights-NL/strapi-plugin-deep-populate&type=date&legend=top-left)](https://www.star-history.com/#Four-Lights-NL/strapi-plugin-deep-populate&type=date&legend=top-left)
+
+Thanks for reading and using the plugin. If you like it, consider starring it to give me a nice little dopamine hit next time I'm working on it.
+
+### Built with ☕ in [Deventer, NL](https://en.wikipedia.org/wiki/Deventer).

package/dist/server/index.js

@@ -54,6 +54,20 @@ const isEqual__default = /* @__PURE__ */ _interopDefault(isEqual);
 const merge__default = /* @__PURE__ */ _interopDefault(merge$2);
 const mergeWith__default = /* @__PURE__ */ _interopDefault(mergeWith);
 const set__default = /* @__PURE__ */ _interopDefault(set$2);
+const bootstrap = async ({ strapi: strapi2 }) => {
+  const { cacheOptions } = strapi2.config.get("plugin::deep-populate");
+  if (cacheOptions?.clearCacheOnStartup === true) {
+    try {
+      await strapi2.db.query("plugin::deep-populate.cache").deleteMany({
+        where: {
+          id: { $gt: 0 }
+        }
+      });
+    } catch (error2) {
+      strapi2.log.error("❌ Error during startup cache deletion:", error2);
+    }
+  }
+};
 const config$1 = {
   default: ({ env: env2 }) => ({ useCache: true, replaceWildcard: true, contentTypes: {} }),
   validator: (config2) => {
@@ -18508,7 +18522,7 @@ const register = async ({ strapi: strapi2 }) => {
     return result;
   });
 };
-const version = "1.13.0-rc.0";
+const version = "1.14.0";
 const name = "@fourlights/strapi-plugin-deep-populate";
 const error = (msg, context = void 0) => strapi.log.error(`[${name}] ${msg}`, context);
 const warn = (msg, context = void 0) => strapi.log.warn(`[${name}] ${msg}`, context);
@@ -18927,6 +18941,7 @@ const services = {
   cache
 };
 const index = {
+  bootstrap,
   config: config$1,
   contentTypes,
   services,

package/dist/server/index.mjs

@@ -26,6 +26,20 @@ import isEqual from "lodash/isEqual";
 import merge$2 from "lodash/merge";
 import mergeWith$1 from "lodash/mergeWith";
 import set$2 from "lodash/set";
+const bootstrap = async ({ strapi: strapi2 }) => {
+  const { cacheOptions } = strapi2.config.get("plugin::deep-populate");
+  if (cacheOptions?.clearCacheOnStartup === true) {
+    try {
+      await strapi2.db.query("plugin::deep-populate.cache").deleteMany({
+        where: {
+          id: { $gt: 0 }
+        }
+      });
+    } catch (error2) {
+      strapi2.log.error("❌ Error during startup cache deletion:", error2);
+    }
+  }
+};
 const config$1 = {
   default: ({ env: env2 }) => ({ useCache: true, replaceWildcard: true, contentTypes: {} }),
   validator: (config2) => {
@@ -18480,7 +18494,7 @@ const register = async ({ strapi: strapi2 }) => {
     return result;
   });
 };
-const version = "1.13.0-rc.0";
+const version = "1.14.0";
 const name = "@fourlights/strapi-plugin-deep-populate";
 const error = (msg, context = void 0) => strapi.log.error(`[${name}] ${msg}`, context);
 const warn = (msg, context = void 0) => strapi.log.warn(`[${name}] ${msg}`, context);
@@ -18899,6 +18913,7 @@ const services = {
   cache
 };
 const index = {
+  bootstrap,
   config: config$1,
   contentTypes,
   services,

package/dist/server/src/bootstrap.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from "@strapi/strapi";
+declare const bootstrap: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => Promise<void>;
+export default bootstrap;

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

@@ -13,8 +13,12 @@ export type ContentTypeConfig = {
     allow?: ContentTypeConfigAllow;
     deny?: ContentTypeConfigDeny;
 };
+export type CacheOptions = {
+    clearCacheOnStartup?: boolean;
+};
 export type Config = {
     useCache: boolean;
+    cacheOptions?: CacheOptions;
     replaceWildcard: boolean;
     omitEmpty?: boolean;
     localizations?: boolean;

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

@@ -1,4 +1,7 @@
 declare const _default: {
+    bootstrap: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => Promise<void>;
     config: {
         default: ({ env }: {
             env: any;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.13.0-rc.0",
+  "version": "1.14.0",
   "keywords": [
     "strapi",
     "strapi-plugin",