strapi-plugin-navigation 2.0.2 → 2.0.3

package/README.md

@@ -81,7 +81,7 @@ Complete installation requirements are exact same as for Strapi itself and can b
 
 **Supported Strapi versions**:
 
-- Strapi v4.0.7 (recently tested)
+- Strapi v4.1.0 (recently tested)
 - Strapi v4.x
 
 > This plugin is designed for **Strapi v4** and is not working with v3.x. To get version for **Strapi v3** install version [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v3).
@@ -233,6 +233,20 @@ For any role different than **Super Admin**, to access the **Navigation panel**
 
 ## 🕸️ Public API specification
 
+### Query Params 
+
+- `type` - Enum value representing structure type of returned navigation 
+
+    **Example URL**: `https://localhost:1337/api/navigation/render/1?type=FLAT`
+
+- `menu` - Boolean value for querying only navigation items that are attached to menu should be rendered eg.
+
+    **Example URL**: `https://localhost:1337/api/navigation/render/1?menu=true`
+
+- `path` - String value for querying navigation items by its path 
+
+    **Example URL**: `https://localhost:1337/api/navigation/render/1?path=/home/about-us`
+
 ### Render
 
 `GET <host>/api/navigation/render/<idOrSlug>?type=<type>`

package/__mocks__/strapi.js

@@ -48,7 +48,7 @@ const itemModelMock = {
         id: 1,
         title: "home",
         type: "INTERNAL",
-        path: "home1",
+        path: "home",
         externalPath: null,
         uiRouterKey: "home",
         menuAttached: true,

package/admin/src/pages/View/components/NavigationItemForm/index.js

@@ -164,8 +164,8 @@ const NavigationItemForm = ({
         key: get(item, 'id'),
         metadatas: {
           intlLabel: {
-            id: label || " ",
-            defaultMessage: label || " ",
+            id: label || `${item.__collectionUid} ${item.id}`,
+            defaultMessage: label || `${item.__collectionUid} ${item.id}`,
           }
         },
         value: item.id,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-navigation",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Strapi - Navigation plugin",
   "strapi": {
     "name": "navigation",
@@ -17,7 +17,7 @@
     "test:unit": "jest --verbose --coverage"
   },
   "dependencies": {
-    "@strapi/utils": "^4.0.7",
+    "@strapi/utils": "^4.1.0",
     "uuid": "^8.3.0",
     "bad-words": "^3.0.3",
     "lodash": "^4.17.11",

package/server/controllers/navigation.js

@@ -74,13 +74,14 @@ module.exports = ({strapi}) => ({
   },
   async render(ctx) {
     const { params, query = {} } = ctx;
-    const { type, menu: menuOnly } = query;
+    const { type, menu: menuOnly, path: rootPath } = query;
     const { idOrSlug } = parseParams(params);
-    return getService().render(
+    return getService().render({
       idOrSlug,
       type,
       menuOnly,
-    );
+      rootPath
+    });
   },
   async renderChild(ctx) {
     const { params, query = {} } = ctx;

package/server/graphql/queries/render-navigation.js

@@ -5,11 +5,12 @@ module.exports = ({ strapi, nexus }) => {
 		args: {
 			navigationIdOrSlug: nonNull(stringArg()),
 			type: 'NavigationRenderType',
-			menuOnly: booleanArg()
+			menuOnly: booleanArg(),
+			path: stringArg(),
 		},
 		resolve(obj, args) {
-			const { navigationIdOrSlug, type, menuOnly } = args;
-			return strapi.plugin('navigation').service('navigation').render(navigationIdOrSlug, type, menuOnly);
+			const { navigationIdOrSlug: idOrSlug, type, menuOnly, path: rootPath } = args;
+			return strapi.plugin('navigation').service('navigation').render({idOrSlug, type, menuOnly, rootPath});
 		},
 	};
 }

package/server/services/__tests__/functions.test.js

@@ -0,0 +1,48 @@
+const { setupStrapi } = require('../../../__mocks__/strapi');
+const utilsFunctionsFactory = require('../utils/functions');
+
+describe('Utilities functions', () => {
+	beforeAll(async () => {
+		setupStrapi();
+	});
+
+	describe('Path rendering functions', () => {
+		it('Can build nested path structure', async () => {
+			const utilsFunctions = utilsFunctionsFactory({ strapi });
+			const { itemModel } = utilsFunctions.extractMeta(strapi.plugins);
+			const rootPath = '/home/side';
+			const entities = await strapi
+				.query(itemModel.uid)
+				.findMany({
+					where: {
+						master: 1
+					}
+				});
+			const nested = utilsFunctions.buildNestedPaths({ items: entities });
+
+			expect(nested.length).toBe(2);
+			expect(nested[1].path).toBe(rootPath);
+		});
+
+		it('Can filter items by path', async () => {
+			const utilsFunctions = utilsFunctionsFactory({ strapi });
+			const { itemModel } = utilsFunctions.extractMeta(strapi.plugins);
+			const rootPath = '/home/side';
+			const entities = await strapi
+				.query(itemModel.uid)
+				.findMany({
+					where: {
+						master: 1
+					}
+				});
+			const {
+				root,
+				items
+			} = utilsFunctions.filterByPath(entities, rootPath);
+
+			expect(root).toBeDefined();
+			expect(root.path).toBe(rootPath);
+			expect(items.length).toBe(1)
+		});
+	});
+});

package/server/services/__tests__/navigation.test.js

@@ -26,7 +26,7 @@ describe('Navigation services', () => {
   describe('Render navigation', () => {
     it('Can render branch in flat format', async () => {
       const service = strapi.plugin('navigation').service('navigation');
-      const result = await service.render(1);
+      const result = await service.render({ idOrSlug: 1 });
 
       expect(result).toBeDefined()
       expect(result.length).toBe(2)
@@ -34,7 +34,10 @@ describe('Navigation services', () => {
 
     it('Can render branch in tree format', async () => {
       const service = strapi.plugin('navigation').service('navigation');
-      const result = await service.render(1, "TREE");
+      const result = await service.render({
+        idOrSlug: 1,
+        type: "TREE"
+      });
 
       expect(result).toBeDefined()
       expect(result.length).toBeGreaterThan(0)
@@ -42,7 +45,10 @@ describe('Navigation services', () => {
 
     it('Can render branch in rfr format', async () => {
       const service = strapi.plugin('navigation').service('navigation');
-      const result = await service.render(1, "RFR");
+      const result = await service.render({
+        idOrSlug: 1,
+        type: "RFR"
+      });
 
       expect(result).toBeDefined()
       expect(result.length).toBeGreaterThan(0)
@@ -50,11 +56,27 @@ describe('Navigation services', () => {
 
     it('Can render only menu attached elements', async () => {
       const service = strapi.plugin('navigation').service('navigation');
-      const result = await service.render(1, "FLAT", true);
+      const result = await service.render({
+        idOrSlug: 1,
+        type: "FLAT",
+        menuOnly: true.valueOf,
+      });
 
       expect(result).toBeDefined()
       expect(result.length).toBe(1)
     });
+
+    it('Can render branch by path', async () => {
+      const service = strapi.plugin('navigation').service('navigation');
+      const result = await service.render({
+        idOrSlug: 1,
+        type: "FLAT",
+        rootPath: '/home/side'
+      });
+
+      expect(result).toBeDefined();
+      expect(result.length).toBe(1);
+    });
   });
 
   describe('Render child', () => {

package/server/services/navigation.js

@@ -66,7 +66,7 @@ module.exports = ({ strapi }) => {
     },
 
     async restart() {
-        setImmediate(() => strapi.reload());
+      setImmediate(() => strapi.reload());
     },
 
     // Get plugin config
@@ -342,20 +342,20 @@ module.exports = ({ strapi }) => {
         ...(type === renderType.FLAT ? { uiRouterKey: childUIKey } : {}),
       };
 
-      return service.renderType(type, criteria, itemCriteria, filter);
+      return service.renderType({ type, criteria, itemCriteria, filter });
     },
 
-    async render(idOrSlug, type = renderType.FLAT, menuOnly = false) {
+    async render({ idOrSlug, type = renderType.FLAT, menuOnly = false, rootPath = null }) {
       const { service } = utilsFunctions.extractMeta(strapi.plugins);
 
       const findById = !isNaN(toNumber(idOrSlug)) || isUuid(idOrSlug);
       const criteria = findById ? { id: idOrSlug } : { slug: idOrSlug };
       const itemCriteria = menuOnly ? { menuAttached: true } : {};
 
-      return service.renderType(type, criteria, itemCriteria);
+      return service.renderType({ type, criteria, itemCriteria, rootPath });
     },
 
-    async renderType(type = renderType.FLAT, criteria = {}, itemCriteria = {}, filter = null) {
+    async renderType({ type = renderType.FLAT, criteria = {}, itemCriteria = {}, filter = null, rootPath = null }) {
       const { pluginName, service, masterModel, itemModel } = utilsFunctions.extractMeta(
         strapi.plugins,
       );
@@ -393,8 +393,8 @@ module.exports = ({ strapi }) => {
             const getTemplateName = await utilsFunctions.templateNameFactory(items, strapi, contentTypes);
             const itemParser = (item, path = '', field) => {
               const isExternal = item.type === itemType.EXTERNAL;
-              const parentPath = isExternal ? undefined : `${path === '/' ? '' : path}/${item.path === '/'
-                ? ''
+              const parentPath = isExternal ? undefined : `${path === '/' ? '' : path}/${first(item.path) === '/'
+                ? item.path.substring(1)
                 : item.path}`;
               const slug = isString(parentPath) ? slugify(
                 (first(parentPath) === '/' ? parentPath.substring(1) : parentPath).replace(/\//g, '-')) : undefined;
@@ -422,9 +422,17 @@ module.exports = ({ strapi }) => {
                 }),
               };
             };
+
+            const {
+              items: itemsFilteredByPath,
+              root: rootElement,
+            } = utilsFunctions.filterByPath(items, rootPath);
+
             const treeStructure = service.renderTree({
-              items,
+              items: isNil(rootPath) ? items : itemsFilteredByPath,
               field: 'parent',
+              id: get(rootElement, 'parent.id'),
+              path: get(rootElement, 'parent.path'),
               itemParser,
             });
 
@@ -440,7 +448,7 @@ module.exports = ({ strapi }) => {
             }
             return filteredStructure;
           default:
-            return items
+            const publishedItems = items
               .filter(utilsFunctions.filterOutUnpublished)
               .map((item) => ({
                 ...item,
@@ -449,6 +457,7 @@ module.exports = ({ strapi }) => {
                 related: item.related?.map(({ localizations, ...item }) => item),
                 items: null,
               }));
+            return isNil(rootPath) ? items : utilsFunctions.filterByPath(publishedItems, rootPath).items;
         }
       }
       throw new NotFoundError();

package/server/services/utils/functions.js

@@ -6,6 +6,7 @@ const {
   find,
   isString,
   get,
+  isNil,
 } = require('lodash');
 
 const { type: itemType } = require('../../content-types/navigation-item/lifecycle');
@@ -52,6 +53,45 @@ module.exports = ({ strapi }) => {
         });
     },
 
+    buildNestedPaths({items, id = null, field = 'parent', parentPath = null}){
+      return items
+        .filter(entity => {
+          if (entity[field] == null && id === null) {
+            return true;
+          }
+          let data = entity[field];
+          if (data && typeof id === 'string') {
+            data = data.toString();
+          }
+          return (data && data === id) || (isObject(entity[field]) && (entity[field].id === id));
+        })
+        .reduce((acc, entity) => {
+          const path = `${parentPath || ''}/${entity.path}`
+          return [
+            {
+              id: entity.id,
+              parent: parentPath && {
+                id: get(entity, 'parent.id'),
+                path: parentPath,
+              },
+              path
+            },
+            ...this.buildNestedPaths({items, id: entity.id, field, parentPath: path}),
+            ...acc,
+          ];
+        }, [])
+    },
+
+    filterByPath(items, path) {
+      const itemsWithPaths = this.buildNestedPaths({ items }).filter(({path: itemPath}) => itemPath.includes(path));
+      const root = itemsWithPaths.find(({ path: itemPath }) => itemPath === path);
+
+      return {
+        root,
+        items: isNil(root) ? [] : items.filter(({ id }) => (itemsWithPaths.find(v => v.id === id))),
+      }
+    },
+
     prepareAuditLog(actions) {
       return [
         ...new Set(