strapi-plugin-navigation 1.1.0 → 1.1.4

package/README.md

@@ -23,6 +23,11 @@ A plugin for [Strapi Headless CMS](https://github.com/strapi/strapi) that provid
 
 <img src="public/assets/preview.png" alt="UI preview" />
 
+### ⚙️ Versions
+
+- **Strapi v4** - [v2.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation)
+- **Strapi v3** - (current) - [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-navigation/tree/strapi-v3)
+
 ### ⏳ Installation
 
 (Use **yarn** to install this plugin within your Strapi project (recommended). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)
@@ -73,40 +78,22 @@ Complete installation requirements are exact same as for Strapi itself and can b
 
 ## Content Type model relation to Navigation Item
 
-To enable Content Type to work with Navigation Item, you've to add following field to your model `*.settings.json`:
-
-```
-    "navigation": {
-      "model": "navigationitem",
-      "plugin": "navigation",
-      "via": "related",
-      "configurable": false,
-      "hidden": true
-    }
-```
-
-inside the `attributes` section like in example below:
-
-```
-    "attributes": {
-        ...,
-        "navigation": {
-            "model": "navigationitem",
-            "plugin": "navigation",
-            "via": "related",
-            "configurable": false,
-            "hidden": true
-        },
-        ...
-    },
+We can define in `config/plugins.js`
+```js
+  navigation: {
+    ...
+    relatedContentTypes: [
+      'application::pages.pages'
+    ],
+    ...
+  },
 ```
 
 ## Configuration
-To setup the plugin properly we recommend to put following snippet as part of `config/custom.js` or `config/<env>/custom.js` file. If you've got already configurations for other plugins stores by this way, use just the `navigation` part within exising `plugins` item.
+To setup the plugin properly we recommend to put following snippet as part of `config/plugins.js` or `config/<env>/plugins.js` file. If you've got already configurations for other plugins stores by this way, use just the `navigation` part within exising `plugins` item.
 
 ```js
     ...
-    plugins: {
       navigation: {
         additionalFields: ['audience'],
         allowedLevels: 2,
@@ -116,7 +103,6 @@ To setup the plugin properly we recommend to put following snippet as part of `c
         },
         gql: { ... }
       },
-    },
     ...
 ```
 
@@ -427,7 +413,8 @@ For general help using Strapi, please refer to [the official Strapi documentatio
 - [Slack](http://slack.strapi.io) We're present on official Strapi slack workspace. Look for @cyp3r and DM.
 - [Slack - VirtusLab Open Source](https://virtuslab-oss.slack.com) We're present on a public channel #strapi-molecules
 - [GitHub](https://github.com/VirtusLab/strapi-plugin-navigation/issues) (Bug reports, Contributions, Questions and Discussions)
+- [E-mail](mailto:strapi@virtuslab.com) - we will respond back as soon as possible
 
 ## License
 
-[MIT License](LICENSE.md) Copyright (c) 2021 [VirtusLab Sp. z o.o.](https://virtuslab.com/) &amp; [Strapi Solutions](https://strapi.io/).
+[MIT License](LICENSE.md) Copyright (c) [VirtusLab Sp. z o.o.](https://virtuslab.com/) &amp; [Strapi Solutions](https://strapi.io/).

package/admin/src/containers/DataManagerProvider/index.js

@@ -36,7 +36,6 @@ const DataManagerProvider = ({ children }) => {
   const [reducerState, dispatch] = useReducer(reducer, initialState, init);
   const {
     autoReload,
-    emitEvent,
     currentEnvironment,
     formatMessage,
   } = useGlobalContext();
@@ -195,47 +194,36 @@ const DataManagerProvider = ({ children }) => {
   };
 
   const handleChangeNavigationPopupVisibility = (visible) => {
-    emitEvent("willChangeNavigationPopupVisibility");
     dispatch({
       type: CHANGE_NAVIGATION_POPUP_VISIBILITY,
       navigationPopupOpened: visible,
     });
-    emitEvent("didChangeNavigationPopupVisibility");
-    emitEvent(`navigationPopup${visible ? "Visible" : "Hidden"}`);
   };
 
   const handleChangeNavigationItemPopupVisibility = (visible) => {
-    emitEvent("willChangeNavigationItemPopupVisibility");
     dispatch({
       type: CHANGE_NAVIGATION_ITEM_POPUP_VISIBILITY,
       navigationItemPopupOpened: visible,
     });
-    emitEvent("didChangeNavigationItemPopupVisibility");
-    emitEvent(`navigationItemPopup${visible ? "Visible" : "Hidden"}`);
   };
 
   const handleChangeNavigationData = (payload, forceClosePopups) => {
-    emitEvent("willChangeNavigationData");
     dispatch({
       type: CHANGE_NAVIGATION_DATA,
       changedActiveItem: payload,
       forceClosePopups,
     });
-    emitEvent("didChangeNavigationData");
   };
 
   const handleResetNavigationData = () => {
-    emitEvent("willResetNavigationChanges");
     dispatch({ 
       type: RESET_NAVIGATION_DATA,
       activeItem,
     });
-    emitEvent("didResetNavigationChanges");
   };
 
   const handleSubmitNavigation = async (formatMessage, payload = {}) => {
     try {
-      emitEvent("willSubmitNavigation");
       dispatch({
         type: SUBMIT_NAVIGATION,
       });
@@ -255,7 +243,6 @@ const DataManagerProvider = ({ children }) => {
           items: prepareItemToViewPayload(navigation.items, null, config),
         },
       });
-      emitEvent("didSubmitNavigation");
 
       strapi.notification.success(getTradId('notification.navigation.submit'));
     } catch (err) {
@@ -264,7 +251,6 @@ const DataManagerProvider = ({ children }) => {
         error: err.response.payload.data
       });
       console.error({ err: err.response });
-      emitEvent('didNotSubmitNavigation');
       if (err.response.payload.data && err.response.payload.data.errorTitles) {
         return strapi.notification.error(
           formatMessage(

package/admin/src/containers/View/utils/parsers.js

@@ -252,7 +252,7 @@ export const extractRelatedItemLabel = (item = {}, fields = {}, config = {}) =>
   const { __collectionName } = item;
   const contentType = contentTypes.find(_ => _.uid === __collectionName)
   const { default: defaultFields = [] } = fields;
-  return get(fields, `${contentType ? contentType.collectionName : ''}`, defaultFields).map((_) => item[_]).filter((_) => _)[0] || '';
+  return get(fields, `${contentType ? contentType.collectionName : __collectionName}`, defaultFields).map((_) => item[_]).filter((_) => _)[0] || '';
 };
 
 export const usedContentTypes = (items = []) => items.flatMap(

package/config/schema.graphql.js

@@ -1,4 +1,3 @@
-const {get} = require('lodash');
 const NAVIGATION_DATE = `
 # SQL
   created_at: String
@@ -25,12 +24,12 @@ const NAVIGATION = `
 `;
 
 const getContentTypesNamesFields = () => {
-  const contentTypesNameFields = strapi.config.get('custom.plugins.navigation.contentTypesNameFields');
+  const contentTypesNameFields = strapi.config.get('plugins.navigation.contentTypesNameFields');
   return Object.keys(contentTypesNameFields || {}).map(key => `${key}: [String]!`).join('\n');
 };
 
 const getNavigationRelated = () => {
-  const related = strapi.config.get('custom.plugins.navigation.gql.navigationItemRelated');
+  const related = strapi.config.get('plugins.navigation.gql.navigationItemRelated');
   if (related) {
     return related;
   }
@@ -67,7 +66,7 @@ module.exports = {
     parent: Int
     master: Int
     items: [NavigationItem]
-    related: NavigationRelated
+    related: [NavigationRelated]
     audience: [String]
     ${NAVIGATION_DATE}
     ${NAVIGATION_USER}
@@ -149,6 +148,11 @@ module.exports = {
     navigationUpdate(id: String!, navigation: CreateNavigation!): Navigation!
   `,
   resolver: {
+    NavigationRelated: {
+      __resolveType: (data) => {
+        return strapi.contentTypes[data.__contentType]?.globalId
+      }
+    },
     Query: {
       renderNavigation: {
         resolverOf: 'plugins::navigation.navigation.render',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-navigation",
-  "version": "1.1.0",
+  "version": "1.1.4",
   "description": "Strapi - Navigation plugin",
   "strapi": {
     "name": "Navigation",
@@ -27,8 +27,8 @@
     "reactstrap": "8.4.1",
     "redux-saga": "^0.16.0",
     "request": "^2.83.0",
-    "strapi-helper-plugin": "3.6.5",
-    "strapi-utils": "3.6.5",
+    "strapi-helper-plugin": "3.6.8",
+    "strapi-utils": "3.6.8",
     "uuidv4": "^6.2.6",
     "slugify": "^1.4.5",
     "pluralize": "^8.0.0"
@@ -40,6 +40,9 @@
     "jest-styled-components": "^7.0.2",
     "codecov": "^3.7.2"
   },
+  "peerDependencies": {
+    "strapi": "3.x"
+  },
   "author": {
     "name": "VirtusLab // Mateusz Ziarko",
     "email": "mziarko@virtuslab.com",

package/services/navigation.js

@@ -36,9 +36,9 @@ const contentTypesNameFieldsDefaults = [
   'subject',
   'name',
 ];
-const contentTypesNameFields = get(
+const getContentTypesNameFields = () => get(
   strapi.config,
-  'custom.plugins.navigation.contentTypesNameFields',
+  'plugins.navigation.contentTypesNameFields',
   {},
 );
 
@@ -51,15 +51,15 @@ module.exports = {
   // Get plugin configuration
   async config() {
     const { pluginName, service, audienceModel } = utilsFunctions.extractMeta(strapi.plugins);
-    const additionalFields = get(strapi.config, 'custom.plugins.navigation.additionalFields', []);
+    const additionalFields = get(strapi.config, 'plugins.navigation.additionalFields', []);
     let extendedResult = {};
     const result = {
       contentTypes: await service.configContentTypes(),
       contentTypesNameFields: {
         default: contentTypesNameFieldsDefaults,
-        ...(isObject(contentTypesNameFields) ? contentTypesNameFields : {}),
+        ...getContentTypesNameFields(),
       },
-      allowedLevels: get(strapi.config, 'custom.plugins.navigation.allowedLevels'),
+      allowedLevels: get(strapi.config, 'plugins.navigation.allowedLevels'),
       additionalFields,
     };
 
@@ -185,7 +185,8 @@ module.exports = {
         _limit: -1,
         _sort: 'order:asc',
       });
-    const entities = await this.getRelatedItems(entityItems);
+    let entities = await this.getRelatedItems(entityItems);
+    entities = entities.map((_) => sanitizeEntity(_, { model: itemModel }));
     return {
       ...sanitizeEntity(entity,
         { model: masterModel },
@@ -301,7 +302,8 @@ module.exports = {
       if (!entities) {
         return [];
       }
-      const items = await this.getRelatedItems(entities);
+      let items = await this.getRelatedItems(entities);
+      items = items.map((_) => sanitizeEntity(_, { model: itemModel }));
       const { contentTypes, contentTypesNameFields } = await service.config();
 
       switch (type?.toLowerCase()) {
@@ -327,7 +329,7 @@ module.exports = {
               external: isExternal,
               related: isExternal || !lastRelated ? undefined : {
                 ...lastRelated,
-                __templateName: getTemplateName(lastRelated.relatedType, lastRelated.id),
+                __templateName: getTemplateName(lastRelated.relatedType || lastRelated.__contentType, lastRelated.id),
               },
               audience: !isEmpty(item.audience) ? item.audience.map(aItem => aItem.key) : undefined,
               items: isExternal ? undefined : service.renderTree({