strapi-plugin-navigation 2.0.4 → 2.0.7

package/admin/src/translations/en.json

@@ -3,6 +3,8 @@
 	"header.title": "Navigation",
 	"header.description": "Define your portal navigation",
 	"header.action.newItem": "New Item",
+	"header.action.collapseAll": "Collapse All",
+	"header.action.expandAll": "Expand All",
 	"submit.cta.cancel": "Cancel",
 	"submit.cta.save": "Save",
 	"empty": "Your navigation is empty",
@@ -20,12 +22,14 @@
 	"popup.item.form.externalPath.placeholder": "Link to the external source",
 	"popup.item.form.externalPath.validation.type": "This value is not a proper url.",
 	"popup.item.form.menuAttached.label": "Attach to menu",
-	"popup.item.form.type.label": "Internal link",
+	"popup.item.form.type.label": "Navigation item type",
 	"popup.item.form.type.internal.label": "Internal source",
 	"popup.item.form.type.external.label": "External source",
+	"popup.item.form.type.wrapper.label": "Wrapper element",
 	"popup.item.form.type.external.description": "Output path: {value}",
 	"popup.item.form.audience.label": "Audience",
 	"popup.item.form.audience.placeholder": "Select audience...",
+	"popup.item.form.audience.empty": "There are no more audiences",
 	"popup.item.form.relatedSection.label": "Relation to",
 	"popup.item.form.relatedType.label": "Content Type",
 	"popup.item.form.relatedType.placeholder": "Select content type...",
@@ -43,6 +47,7 @@
 	"notification.navigation.item.relation": "Entity relation does not exist!",
 	"notification.navigation.item.relation.status.draft": "draft",
 	"notification.navigation.item.relation.status.published": "published",
+	"pages.main.search.placeholder": "Type to start searching...",
 	"pages.settings.general.title": "General settings",
 	"pages.settings.additional.title": "Additional settings",
 	"pages.settings.nameField.title": "Content types settings",
@@ -80,10 +85,17 @@
 	"pages.settings.form.nameField.label": "Name fields",
 	"pages.settings.form.nameField.placeholder": "Select at least one or leave empty to apply defaults",
 	"pages.settings.form.nameField.hint": "If left empty name field is going to take following ordered fields: \"title\", \"subject\" and \"name\"",
+	"pages.settings.form.nameField.empty": "This content type doesn't have any string attributes",
+	"pages.settings.form.populate.label": "Fields to populate",
+	"pages.settings.form.populate.placeholder": "Select at least one or leave empty to disable populating relation fields",
+	"pages.settings.form.populate.hint": "Selected relation fields will be populated inside API responses",
+	"pages.settings.form.populate.empty": "This content type doesn't have any relation fields",
+	"pages.settings.form.contentTypesSettings.label": "Content types",
+	"pages.settings.form.contentTypesSettings.tooltip": "Custom configuration per content type",
 	"components.navigationItem.action.newItem": "Add nested item",
 	"components.navigationItem.badge.removed": "Removed",
-	"components.navigationItem.badge.draft": "{type}: Draft",
-	"components.navigationItem.badge.published": "{type}: Published",
+	"components.navigationItem.badge.draft": "Draft",
+	"components.navigationItem.badge.published": "Published",
 	"components.confirmation.dialog.button.cancel": "Cancel",
 	"components.confirmation.dialog.button.confirm": "Confirm",
 	"components.confirmation.dialog.description": "Do you want to continue?",

package/admin/src/utils/index.js

@@ -3,7 +3,7 @@ import { isString } from 'lodash';
 
 import pluginId from '../pluginId';
 
-const getMessage = (input, defaultMessage = '', inPluginScope = true) => {
+export const getMessage = (input, defaultMessage = '', inPluginScope = true) => {
     const { formatMessage } = useIntl();
     let formattedId = ''
     if (isString(input)) {
@@ -17,4 +17,6 @@ const getMessage = (input, defaultMessage = '', inPluginScope = true) => {
     }, input?.props || undefined)
 };
 
-export { getMessage };
+export const ItemTypes = {
+    NAVIGATION_ITEM: 'navigationItem'
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-navigation",
-  "version": "2.0.4",
+  "version": "2.0.7",
   "description": "Strapi - Navigation plugin",
   "strapi": {
     "name": "navigation",
@@ -17,9 +17,8 @@
     "test:unit": "jest --verbose --coverage"
   },
   "dependencies": {
-    "@strapi/utils": "^4.1.0",
+    "@strapi/utils": "^4.1.5",
     "uuid": "^8.3.0",
-    "bad-words": "^3.0.3",
     "lodash": "^4.17.11",
     "react": "^16.9.0",
     "react-dom": "^16.9.0",

package/server/bootstrap.js

@@ -42,30 +42,11 @@ module.exports = async ({ strapi }) => {
   }
   
   // Initialize configuration
-  const pluginStore = strapi.store({
-    environment: '',
-    type: 'plugin',
-    name: 'navigation',
-  });
-
-  const config = await pluginStore.get({ key: 'config' });
-  const pluginDefaultConfig = await strapi.plugin('navigation').config
-  const defaultConfigValue = {
-    additionalFields: pluginDefaultConfig('additionalFields'),
-    contentTypes: pluginDefaultConfig('contentTypes'),
-    contentTypesNameFields: pluginDefaultConfig('contentTypesNameFields'),
-    allowedLevels: pluginDefaultConfig('allowedLevels'),
-    gql: pluginDefaultConfig('gql'),
-  }
-  
-  if (!config) {
-    pluginStore.set({
-      key: 'config', value: defaultConfigValue
-    });
-  }
+  const config = await strapi.plugin('navigation').service('navigation').setDefaultConfig()
 
+  // Initialize graphql configuration
   if (strapi.plugin('graphql')) {
     const graphqlConfiguration = require('./graphql')
-    await graphqlConfiguration({ strapi, config: config || defaultConfigValue });
+    await graphqlConfiguration({ strapi, config });
   }
 };

package/server/config/index.js

@@ -3,6 +3,7 @@ module.exports = {
 		additionalFields: [],
 		contentTypes: [],
 		contentTypesNameFields: {},
+		contentTypesPopulate: {},
 		allowedLevels: 2
 	}
 }

package/server/config.js

@@ -3,6 +3,7 @@ module.exports = {
 		additionalFields: [],
 		contentTypes: [],
 		contentTypesNameFields: {},
+		contentTypesPopulate: {},
 		allowedLevels: 2
 	}
 }

package/server/content-types/navigation-item/lifecycle.js

@@ -10,6 +10,7 @@ module.exports = {
   type: {
     INTERNAL: 'INTERNAL',
     EXTERNAL: 'EXTERNAL',
+    WRAPPER: 'WRAPPER',
   },
   additionalFields: {
     AUDIENCE: 'audience',

package/server/content-types/navigation-item/schema.json

@@ -37,7 +37,8 @@
       "type": "enumeration",
       "enum": [
         "INTERNAL",
-        "EXTERNAL"
+        "EXTERNAL",
+        "WRAPPER"
       ],
       "default": "INTERNAL",
       "configurable": false
@@ -65,6 +66,11 @@
       "default": 0,
       "configurable": false
     },
+    "collapsed": {
+      "type": "boolean",
+      "default": false,
+      "configurable": false
+    },
     "related": {
       "type": "relation",
       "relation": "oneToOne",

package/server/graphql/types/content-types-name-fields.js

@@ -1,8 +1,8 @@
-module.exports = ({ nexus }) => nexus.objectType({
+module.exports = ({ nexus, strapi }) => nexus.objectType({
   name: "ContentTypesNameFields",
   async definition(t) {
 		t.nonNull.list.nonNull.string("default")
-		const pluginStore = strapi.store({ type: 'plugin', name: 'navigation' });
+		const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore();
 		const config = await pluginStore.get({ key: 'config' });
 		const contentTypesNameFields = config.contentTypesNameFields;
 		Object.keys(contentTypesNameFields || {}).forEach(key => t.nonNull.list.string(key))

package/server/graphql/types/navigation-item.js

@@ -13,7 +13,7 @@ module.exports = ({ nexus }) =>
 			t.int("parent")
 			t.int("master")
 			t.list.field("items", { type: 'NavigationItem' })
-			t.list.field("related", { type: 'NavigationRelated' })
+			t.field("related", { type: 'NavigationRelated' })
 			t.list.string("audience")
 			// SQL
 			t.string("created_at")

package/server/services/navigation.js

@@ -72,10 +72,11 @@ module.exports = ({ strapi }) => {
     // Get plugin config
     async config(viaSettingsPage = false) {
       const { audienceModel, service } = utilsFunctions.extractMeta(strapi.plugins);
-      const pluginStore = await strapi.store({ type: 'plugin', name: 'navigation' });
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
       const config = await pluginStore.get({ key: 'config' });
       const additionalFields = config.additionalFields;
       const contentTypesNameFields = config.contentTypesNameFields;
+      const contentTypesPopulate = config.contentTypesPopulate;
       const allowedLevels = config.allowedLevels;
       const isGQLPluginEnabled = !isNil(strapi.plugin('graphql'));
 
@@ -86,6 +87,9 @@ module.exports = ({ strapi }) => {
           default: contentTypesNameFieldsDefaults,
           ...(isObject(contentTypesNameFields) ? contentTypesNameFields : {}),
         },
+        contentTypesPopulate: {
+          ...(isObject(contentTypesPopulate) ? contentTypesPopulate : {}),
+        },
         allowedLevels,
         additionalFields,
         isGQLPluginEnabled: viaSettingsPage ? isGQLPluginEnabled : undefined,
@@ -111,28 +115,42 @@ module.exports = ({ strapi }) => {
     },
 
     async updateConfig(newConfig) {
-      const pluginStore = await strapi.store({ type: 'plugin', name: 'navigation' });
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
       await pluginStore.set({ key: 'config', value: newConfig });
     },
 
+    async getPluginStore() {
+      return await strapi.store({ type: 'plugin', name: 'navigation' });
+    },
+
+    async setDefaultConfig() {
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
+      const config = await pluginStore.get({ key: 'config' });
+      const pluginDefaultConfig = await strapi.plugin('navigation').config
+
+      // If new value gets introduced to the config it either is read from plugin store or from default plugin config
+      // This is fix for backwards compatibility and migration of config to newer version of the plugin
+      const defaultConfigValue = {
+        additionalFields: get(config, 'additionalFields', pluginDefaultConfig('additionalFields')),
+        contentTypes: get(config, 'contentTypes', pluginDefaultConfig('contentTypes')),
+        contentTypesNameFields: get(config, 'contentTypesNameFields',  pluginDefaultConfig('contentTypesNameFields')),
+        contentTypesPopulate: get(config, 'contentTypesPopulate',  pluginDefaultConfig('contentTypesPopulate')),
+        allowedLevels: get(config, 'allowedLevels',  pluginDefaultConfig('allowedLevels')),
+        gql: get(config, 'gql',  pluginDefaultConfig('gql')),
+      }
+      pluginStore.set({ key: 'config', value: defaultConfigValue });
+
+      return defaultConfigValue;
+    },
+
     async restoreConfig() {
-      const pluginStore = await strapi.store({ type: 'plugin', name: 'navigation' });
-      const defaultConfig = await strapi.plugin('navigation').config
-
-      await pluginStore.delete({ key: 'config' })
-      await pluginStore.set({
-        key: 'config', value: {
-          additionalFields: defaultConfig('additionalFields'),
-          contentTypes: defaultConfig('contentTypes'),
-          contentTypesNameFields: defaultConfig('contentTypesNameFields'),
-          allowedLevels: defaultConfig('allowedLevels'),
-          gql: defaultConfig('gql'),
-        }
-      });
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
+      await pluginStore.delete({ key: 'config' });
+      await strapi.plugin('navigation').service('navigation').setDefaultConfig();
     },
 
     async configContentTypes() {
-      const pluginStore = strapi.store({ type: 'plugin', name: 'navigation' });
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
       const config = await pluginStore.get({ key: 'config' });
       const eligibleContentTypes =
         await Promise.all(
@@ -212,6 +230,8 @@ module.exports = ({ strapi }) => {
     },
 
     async getRelatedItems(entityItems) {
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
+      const config = await pluginStore.get({ key: 'config' });
       const relatedTypes = new Set(entityItems.flatMap((item) => get(item.related, 'related_type')));
       const groupedItems = Array.from(relatedTypes).filter((relatedType) => relatedType).reduce(
         (acc, relatedType) => Object.assign(acc, {
@@ -233,8 +253,9 @@ module.exports = ({ strapi }) => {
                   .query(model)
                   .findMany({
                     where: {
-                      id: { $in: map(related, 'related_id') }
-                    }
+                      id: { $in: map(related, 'related_id') },
+                    },
+                    populate: config.contentTypesPopulate[model] || []
                   });
                 return relationData
                   .flatMap(_ =>
@@ -264,8 +285,12 @@ module.exports = ({ strapi }) => {
     },
 
     async getContentTypeItems(model) {
+      const pluginStore = await strapi.plugin('navigation').service('navigation').getPluginStore()
+      const config = await pluginStore.get({ key: 'config' });
       try {
-        const contentTypeItems = await strapi.query(model).findMany()
+        const contentTypeItems = await strapi.query(model).findMany({
+          populate: config.contentTypesPopulate[model] || []
+        })
         return contentTypeItems;
       } catch (err) {
         return [];

package/server/services/utils/functions.js

@@ -213,7 +213,7 @@ module.exports = ({ strapi }) => {
           false;
         return item.type === itemType.INTERNAL ? isRelatedDefinedAndPublished : true;
       }
-      return (item.type === itemType.EXTERNAL) || relatedItem;
+      return (item.type !== itemType.INTERNAL) || relatedItem;
     },
   };
 }