@fourlights/strapi-plugin-deep-populate 1.3.0 → 1.4.0

package/README.md

@@ -12,6 +12,7 @@ It does not impose a limit on the level of nesting and can cache the populate ob
 - Handles circular references and edge cases
 - Includes caching for improved performance
 - Honors `populateCreatorFields` setting
+- Supports optional allow/deny lists for specific relations or components during population
 
 ## Installation
 
@@ -72,7 +73,36 @@ The plugin caches populate objects to improve performance. Cache can be disabled
 
 The plugin automatically populates `createdBy` and `updatedBy` fields when `populateCreatorFields` is enabled in the content-type configuration.
 
-## How It Works
+### Allow / Deny Lists
+
+Sometimes you may want to restrict the nested population of certain relations or components. For example if you have a `Page` contentType where a deeply nested `Link` component has a relation to another `Page`.
+In those situations you can use the allow or deny lists to control where the plugin should stop resolving nested relations.
+
+```ts
+// config/plugins.js
+module.exports = ({ env }) => ({
+  'deep-populate': {
+    enabled: true,
+    config: {
+      useCache: true,
+      replaceWildcard: true,
+      
+      contentTypes: {
+        'api::page.page': {
+          deny: {
+            relations: ['api::page.page']  // prevent resolving nested pages when populating a page
+            // alternatively we could have denied the link component in this case
+            // components: ['shared.link']
+          }
+        }
+      }
+    }
+  }
+});
+```
+---
+
+## How The Plugin Works
 
 The plugin recursively:
 1. Traverses the content-type schema