Initial commit

Author: niteshgourest

.DS_Store

@@ -0,0 +1,26 @@
+
+# Contributions
+
+Thank you for considering contributing to **strapi-plugin-nested-populator**! Your support and contributions are invaluable to us and help make this project even better.
+
+## Ways to Contribute
+
+You can contribute in the following ways:
+
+1. **Reporting Bugs**: If you encounter any bugs or issues, please report them by opening an issue on our [GitHub repository](https://github.com/encoresky/strapi-plugin-nested-populator/issues). Include as much detail as possible, including steps to reproduce the issue and any relevant screenshots or error messages.
+
+2. **Suggesting Features**: If you have a feature request or idea for improving the project, feel free to open an issue with the label "feature request" and describe your suggestion in detail.
+
+3. **Improving Documentation**: You can help us by improving the documentation, fixing typos, or expanding sections that you think need more explanation.
+
+4. **Submitting Pull Requests**: We welcome code contributions! If you want to implement a feature or fix a bug, feel free to submit a pull request. Make sure to follow the guidelines below
+
+## Pull Request Guidelines
+
+To ensure a smooth contribution process, please follow these guidelines
+
+- Fork the repository and create your branch from the main branch.
+- Ensure that your code follows the project’s coding style and conventions.
+- Test your changes thoroughly and include tests for new features or bug fixes.
+- Write clear commit messages and provide a detailed description of your pull request.
+- Make sure your pull request passes all CI checks.

CONTRIBUTION.md

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

LICENSE

@@ -1 +1,58 @@
-# strapi-plugin-nested-populator
+# Strapi plugin nested populator
+Unleash the full potential of your Strapi content with nested, customizable population!
+
+## Features
+
+  - Effortlessly populate nested content structures via REST API
+  - Customize population depth on-the-fly
+  - Works seamlessly with all collections and single types
+  - Simple installation and configuration
+
+## Installation
+
+`npm install strapi-plugin-nested-populator`
+
+`yarn add strapi-plugin-nested-populator`
+
+
+## Usages
+
+  - Deep populate with default depth
+
+    `/api/pages?customPopulate=nested`
+
+  - Specify custom depth
+
+    `/api/pages?customPopulate=nested&customDepth=4`
+
+## Good to know
+
+  - Default maximum depth: 6 levels
+  - Compatible with findOne and findMany methods
+  - Depth easily customizable via API parameters or plugin configuration
+
+## Configuration
+
+Tailor the default depth to your needs by editing `config/plugins.js`
+
+```
+module.exports = ({ env }) => ({
+  'strapi-plugin-nested-populator': {
+    config: {
+      defaultDepth: 4, // Default is 6
+    }
+  },
+});
+```
+
+## Keywords
+
+strapi, strapi plugin, populate, strapi populate, custom populate, depth, custom depth, deep populate, nested, nested fetch, nested populate
+
+## Contributing
+
+We welcome contributions! Feel free to open issues or submit pull requests to help improve this plugin.
+
+## License
+
+[MIT](https://github.com/encoresky/strapi-plugin-nested-populator/blob/main/LICENSE)

README.md

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = {
+  default: {
+    defaultDepth: 6,
+    skipCreatorFields: true,
+  },
+  validator: () => { },
+};

main/.DS_Store

@@ -0,0 +1,29 @@
+'use strict';
+
+const { buildPopulateTree } = require('./utils');
+
+module.exports = ({ strapi }) => {
+  // Subscribe to the relevant lifecycle events.
+  strapi.db.lifecycles.subscribe((event) => {
+    const { action, params, model } = event;
+
+    // Only proceed for 'beforeFindMany' or 'beforeFindOne' actions.
+    if (action === 'beforeFindMany' || action === 'beforeFindOne') {
+      const { customPopulate, customDepth } = params || {};
+
+      // Get the default depth from plugin config, fallback to 5 if undefined.
+      const defaultDepth = strapi
+        .plugin('strapi-plugin-nested-populator')
+        ?.config('defaultDepth') || 5;
+
+      // Apply population logic if 'nested' population is requested.
+      if (customPopulate === 'nested') {
+        const depth = customDepth > 0 ? customDepth : defaultDepth;
+        const modelObject = buildPopulateTree(model.uid, depth, []);
+
+        // Update the event params with the computed population object.
+        params.populate = modelObject.populate;
+      }
+    }
+  });
+};

main/configuration/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const bootstrap = require('./framework');
+const config = require('./configuration')
+
+module.exports = {
+  bootstrap,
+  config
+};

main/framework.js

@@ -0,0 +1,73 @@
+const { isEmpty, merge } = require("lodash/fp");
+
+const extractModelAttributes = (model) => {
+  // Remove 'related' field for 'upload.file', return other attributes.
+  if (model.uid === "plugin::upload.file") {
+    const { related, ...attributes } = model.attributes;
+    return attributes;
+  }
+  return model.attributes;
+};
+
+const buildPopulateTree = (modelUid, maxDepth = 20, ignore = []) => {
+  const skipCreatorFields = strapi
+    .plugin('strapi-plugin-nested-populator')
+    ?.config('skipCreatorFields');
+
+  // Base conditions to terminate recursion.
+  if (maxDepth <= 1) return true;
+  if (modelUid === "admin::user" && skipCreatorFields) return undefined;
+
+  const populate = {};
+  const model = strapi.getModel(modelUid);
+
+  // Add model's collection name to ignore list if not already present.
+  if (!ignore.includes(model.collectionName)) {
+    ignore.push(model.collectionName);
+  }
+
+  for (const [key, value] of Object.entries(extractModelAttributes(model))) {
+    if (ignore.includes(key)) continue;
+
+    if (value) {
+      switch (value.type) {
+        case "component":
+          populate[key] = buildPopulateTree(value.component, maxDepth - 1);
+          break;
+
+        case "dynamiczone":
+          const dynamicPopulate = value.components.reduce((acc, comp) => {
+            const componentPopulate = buildPopulateTree(comp, maxDepth - 1);
+            return componentPopulate === true ? acc : merge(acc, componentPopulate);
+          }, {});
+          populate[key] = isEmpty(dynamicPopulate) ? true : dynamicPopulate;
+          break;
+
+        case "relation":
+          const relationPopulate = buildPopulateTree(
+            value.target,
+            key === "localizations" && maxDepth > 2 ? 1 : maxDepth - 1,
+            ignore
+          );
+          if (relationPopulate) {
+            populate[key] = relationPopulate;
+          }
+          break;
+
+        case "media":
+          populate[key] = true;
+          break;
+
+        default:
+          break;
+      }
+    }
+  }
+
+  // Return the full populate object or true if no populates were added.
+  return isEmpty(populate) ? true : { populate };
+};
+
+module.exports = {
+  buildPopulateTree
+};

main/index.js

@@ -0,0 +1,28 @@
+{
+  "name": "strapi-plugin-nested-populator",
+  "version": "1.0.0",
+  "description": "Strapi plugin that populates nested content structures via REST API",
+  "strapi": {
+    "name": "strapi-plugin-nested-populator",
+    "description": "Api helper to populate nested content structures.",
+    "kind": "plugin"
+  },
+  "dependencies": {},
+  "author": {
+    "name": "EncoreSky Technologies"
+  },
+  "maintainers": [
+    {
+      "name": "EncoreSky Technologies"
+    }
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/encoresky/strapi-plugin-nested-populator"
+  },
+  "engines": {
+    "node": ">=14.19.1 <=20.x.x",
+    "npm": ">=6.0.0"
+  },
+  "license": "MIT"
+}