strapi-plugin-navigation 2.1.0 → 2.2.0

package/admin/src/utils/index.js

@@ -1,43 +1,20 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorStatusResourceFor = exports.resolvedResourceFor = exports.ResourceState = exports.ItemTypes = exports.getMessage = void 0;
-const react_intl_1 = require("react-intl");
-const lodash_1 = require("lodash");
-const pluginId_1 = __importDefault(require("../pluginId"));
-const getMessage = (input, defaultMessage = '', inPluginScope = true) => {
-    const { formatMessage } = (0, react_intl_1.useIntl)();
-    let formattedId = '';
-    if ((0, lodash_1.isString)(input)) {
-        formattedId = input;
-    }
-    else {
-        formattedId = input?.id;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    return formatMessage({
-        id: `${inPluginScope ? pluginId_1.default : 'app.components'}.${formattedId}`,
-        defaultMessage,
-    }, input?.props || undefined);
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.getMessage = getMessage;
-exports.ItemTypes = {
-    NAVIGATION_ITEM: 'navigationItem'
-};
-exports.ResourceState = {
-    RESOLVED: 'RESOLVED',
-    LOADING: 'LOADING',
-    ERROR: 'ERROR',
-};
-const resolvedResourceFor = (value) => ({
-    type: exports.ResourceState.RESOLVED,
-    value,
-});
-exports.resolvedResourceFor = resolvedResourceFor;
-const errorStatusResourceFor = (errors) => ({
-    type: exports.ResourceState.ERROR,
-    errors,
-});
-exports.errorStatusResourceFor = errorStatusResourceFor;
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./functions"), exports);
+__exportStar(require("./api"), exports);
+__exportStar(require("./enums"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-navigation",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Strapi - Navigation plugin",
   "strapi": {
     "name": "navigation",
@@ -14,8 +14,8 @@
   },
   "scripts": {},
   "dependencies": {
-    "@strapi/utils": "^4.2.0",
-    "uuid": "^8.3.0",
+    "@sindresorhus/slugify": "1.1.0",
+    "@strapi/utils": "^4.3.0",
     "lodash": "^4.17.11",
     "pluralize": "^8.0.0",
     "react": "^16.9.0",
@@ -27,7 +27,7 @@
     "reactstrap": "8.4.1",
     "redux-saga": "^0.16.0",
     "request": "^2.83.0",
-    "slugify": "^1.4.5"
+    "uuid": "^8.3.0"
   },
   "devDependencies": {},
   "peerDependencies": {
@@ -56,7 +56,7 @@
     }
   ],
   "engines": {
-    "node": ">=14.19.1 <=17.x.x",
+    "node": ">=14.19.3 <=17.x.x",
     "npm": ">=7.x.x"
   },
   "nodemonConfig": {

package/server/config/index.js

@@ -18,15 +18,17 @@ __exportStar(require("./setupStrategy"), exports);
 const config = {
     default: {
         additionalFields: [],
+        allowedLevels: 2,
         contentTypes: [],
         contentTypesNameFields: {},
         contentTypesPopulate: {},
-        allowedLevels: 2,
-        i18nEnabled: false,
-        pruneObsoleteI18nNavigations: false,
         gql: {
-            navigationItemRelated: []
+            navigationItemRelated: [],
         },
+        i18nEnabled: false,
+        pathDefaultFields: {},
+        pruneObsoleteI18nNavigations: false,
+        slugify: {},
     },
 };
 exports.default = config;

package/server/config/setupStrategy.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configSetupStrategy = void 0;
+const lodash_1 = require("lodash");
 const types_1 = require("../../types");
+const utils_1 = require("../utils");
 const configSetupStrategy = async ({ strapi }) => {
     const pluginStore = strapi.store({
         type: "plugin",
@@ -21,9 +23,12 @@ const configSetupStrategy = async ({ strapi }) => {
         allowedLevels: getWithFallback("allowedLevels"),
         gql: getWithFallback("gql"),
         i18nEnabled: hasI18nPlugin && getWithFallback("i18nEnabled"),
+        slugify: (0, lodash_1.pick)(getWithFallback("slugify"), validSlugifyFields),
         pruneObsoleteI18nNavigations: false,
+        pathDefaultFields: getWithFallback("pathDefaultFields"),
     };
-    pluginStore.set({
+    (0, utils_1.validateAdditionalFields)(config.additionalFields);
+    await pluginStore.set({
         key: "config",
         value: config,
     });
@@ -35,4 +40,11 @@ const getWithFallbackFactory = (config, fallback) => (key) => {
     (0, types_1.assertNotEmpty)(value, new Error(`[Navigation] Config "${key}" is undefined`));
     return value;
 };
+const validSlugifyFields = [
+    "separator",
+    "lowercase",
+    "decamelize",
+    "customReplacements",
+    "preserveLeadingUnderscore",
+];
 //# sourceMappingURL=setupStrategy.js.map

package/server/content-types/index.d.ts

@@ -25,13 +25,6 @@ declare const _default: {
         };
     };
     navigation: {
-        lifecycle: {
-            renderType: {
-                FLAT: string;
-                TREE: string;
-                RFR: string;
-            };
-        };
         schema: {
             collectionName: string;
             info: {
@@ -87,19 +80,6 @@ declare const _default: {
         };
     };
     "navigation-item": {
-        lifecycle: {
-            type: {
-                INTERNAL: string;
-                EXTERNAL: string;
-                WRAPPER: string;
-            };
-            additionalFields: {
-                AUDIENCE: string;
-            };
-            lifecycles: {
-                afterFind(results: any): void;
-            };
-        };
         schema: {
             collectionName: string;
             info: {
@@ -193,15 +173,15 @@ declare const _default: {
                     relation: string;
                     target: string;
                 };
+                additionalFields: {
+                    type: string;
+                    require: boolean;
+                    default: {};
+                };
             };
         };
     };
     "navigations-items-related": {
-        lifecycle: {
-            lifecycles: {
-                afterFind(results: any): void;
-            };
-        };
         schema: {
             collectionName: string;
             info: {

package/server/content-types/navigation/index.d.ts

@@ -1,11 +1,4 @@
 declare const _default: {
-    lifecycle: {
-        renderType: {
-            FLAT: string;
-            TREE: string;
-            RFR: string;
-        };
-    };
     schema: {
         collectionName: string;
         info: {

package/server/content-types/navigation/index.js

@@ -4,9 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const schema_1 = __importDefault(require("./schema"));
-const lifecycle_1 = __importDefault(require("./lifecycle"));
 exports.default = {
-    lifecycle: lifecycle_1.default,
     schema: schema_1.default
 };
 //# sourceMappingURL=index.js.map

package/server/content-types/navigation-item/index.d.ts

@@ -1,17 +1,4 @@
 declare const _default: {
-    lifecycle: {
-        type: {
-            INTERNAL: string;
-            EXTERNAL: string;
-            WRAPPER: string;
-        };
-        additionalFields: {
-            AUDIENCE: string;
-        };
-        lifecycles: {
-            afterFind(results: any): void;
-        };
-    };
     schema: {
         collectionName: string;
         info: {
@@ -105,6 +92,11 @@ declare const _default: {
                 relation: string;
                 target: string;
             };
+            additionalFields: {
+                type: string;
+                require: boolean;
+                default: {};
+            };
         };
     };
 };

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

@@ -4,9 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const schema_1 = __importDefault(require("./schema"));
-const lifecycle_1 = __importDefault(require("./lifecycle"));
 exports.default = {
-    lifecycle: lifecycle_1.default,
     schema: schema_1.default
 };
 //# sourceMappingURL=index.js.map

package/server/content-types/navigation-item/schema.d.ts

@@ -91,6 +91,11 @@ declare const _default: {
             relation: string;
             target: string;
         };
+        additionalFields: {
+            type: string;
+            require: boolean;
+            default: {};
+        };
     };
 };
 export default _default;

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

@@ -96,6 +96,11 @@ exports.default = {
             type: "relation",
             relation: "oneToMany",
             target: "plugin::navigation.audience"
+        },
+        additionalFields: {
+            type: "json",
+            require: false,
+            default: {},
         }
     }
 };

package/server/content-types/navigations-items-related/index.d.ts

@@ -1,9 +1,4 @@
 declare const _default: {
-    lifecycle: {
-        lifecycles: {
-            afterFind(results: any): void;
-        };
-    };
     schema: {
         collectionName: string;
         info: {

package/server/content-types/navigations-items-related/index.js

@@ -4,9 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const schema_1 = __importDefault(require("./schema"));
-const lifecycle_1 = __importDefault(require("./lifecycle"));
 exports.default = {
-    lifecycle: lifecycle_1.default,
     schema: schema_1.default
 };
 //# sourceMappingURL=index.js.map

package/server/controllers/admin.js

@@ -33,7 +33,7 @@ const adminControllers = {
             return {};
         }
         catch (error) {
-            console.log(error);
+            console.error(error);
             if (error instanceof NavigationError_1.NavigationError) {
                 return (0, utils_3.errorHandler)(ctx)(error);
             }

package/server/controllers/client.js

@@ -8,7 +8,7 @@ const clientControllers = {
     },
     async render(ctx) {
         const { params, query = {} } = ctx;
-        const { type, menu: menuOnly, path: rootPath, locale } = query;
+        const { type, menu: menuOnly, path: rootPath, locale, populate } = query;
         const { idOrSlug } = (0, utils_2.parseParams)(params);
         try {
             return await this.getService().render({
@@ -17,6 +17,7 @@ const clientControllers = {
                 menuOnly,
                 rootPath,
                 locale,
+                populate
             });
         }
         catch (error) {

package/server/graphql/types/navigation-item.d.ts

@@ -1,5 +1,6 @@
-declare function _exports({ nexus }: {
+declare function _exports({ nexus, config }: {
     nexus: any;
+    config: any;
 }): any;
 export = _exports;
 //# sourceMappingURL=navigation-item.d.ts.map

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

@@ -1,5 +1,5 @@
 "use strict";
-module.exports = ({ nexus }) => nexus.objectType({
+module.exports = ({ nexus, config }) => nexus.objectType({
     name: "NavigationItem",
     definition(t) {
         t.nonNull.int("id");
@@ -14,7 +14,6 @@ module.exports = ({ nexus }) => nexus.objectType({
         t.int("master");
         t.list.field("items", { type: 'NavigationItem' });
         t.field("related", { type: 'NavigationItemRelatedData' });
-        t.list.string("audience");
         t.string("created_at");
         t.string("updated_at");
         t.string("created_by");
@@ -23,6 +22,31 @@ module.exports = ({ nexus }) => nexus.objectType({
         t.string("updatedAt");
         t.string("createdBy");
         t.string("updatedBy");
+        config.additionalFields.forEach(field => {
+            if (field !== 'audience') {
+                if (field.enabled) {
+                    switch (field.type) {
+                        case 'string':
+                            t.string(field.name);
+                            break;
+                        case 'boolean':
+                            t.boolean(field.name);
+                            break;
+                        case 'select':
+                            if (field.multi)
+                                t.list.string(field.name);
+                            else
+                                t.string(field.name);
+                            break;
+                        default:
+                            throw new Error(`Type "${JSON.stringify(field.type)}" is unsupported by custom fields`);
+                    }
+                }
+            }
+            else {
+                t.list.string("audience");
+            }
+        });
     }
 });
 //# sourceMappingURL=navigation-item.js.map

package/server/index.d.ts

@@ -28,13 +28,6 @@ declare const _default: {
             };
         };
         navigation: {
-            lifecycle: {
-                renderType: {
-                    FLAT: string;
-                    TREE: string;
-                    RFR: string;
-                };
-            };
             schema: {
                 collectionName: string;
                 info: {
@@ -90,19 +83,6 @@ declare const _default: {
             };
         };
         "navigation-item": {
-            lifecycle: {
-                type: {
-                    INTERNAL: string;
-                    EXTERNAL: string;
-                    WRAPPER: string;
-                };
-                additionalFields: {
-                    AUDIENCE: string;
-                };
-                lifecycles: {
-                    afterFind(results: any): void;
-                };
-            };
             schema: {
                 collectionName: string;
                 info: {
@@ -196,15 +176,15 @@ declare const _default: {
                         relation: string;
                         target: string;
                     };
+                    additionalFields: {
+                        type: string;
+                        require: boolean;
+                        default: {};
+                    };
                 };
             };
         };
         "navigations-items-related": {
-            lifecycle: {
-                lifecycles: {
-                    afterFind(results: any): void;
-                };
-            };
             schema: {
                 collectionName: string;
                 info: {

package/server/services/admin.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@strapi/utils");
-const slugify_1 = __importDefault(require("slugify"));
+const slugify_1 = __importDefault(require("@sindresorhus/slugify"));
 const lodash_1 = require("lodash");
 const utils_2 = require("../utils");
 const i18n_1 = require("../i18n");
@@ -12,13 +12,15 @@ const NavigationError_1 = require("../../utils/NavigationError");
 const adminService = ({ strapi }) => ({
     async config(viaSettingsPage = false) {
         const commonService = (0, utils_2.getPluginService)('common');
-        const { audienceModel } = (0, utils_2.extractMeta)(strapi.plugins);
+        const { audienceModel } = (0, utils_2.getPluginModels)();
         const pluginStore = await commonService.getPluginStore();
         const config = await pluginStore.get({ key: 'config' });
         const additionalFields = config.additionalFields;
         const contentTypesNameFields = config.contentTypesNameFields;
         const contentTypesPopulate = config.contentTypesPopulate;
+        const pathDefaultFields = config.pathDefaultFields;
         const allowedLevels = config.allowedLevels;
+        const slugify = config.slugify;
         const isGQLPluginEnabled = !(0, lodash_1.isNil)(strapi.plugin('graphql'));
         let extendedResult = {
             allowedContentTypes: utils_2.ALLOWED_CONTENT_TYPES,
@@ -31,18 +33,20 @@ const adminService = ({ strapi }) => ({
                 default: utils_2.CONTENT_TYPES_NAME_FIELDS_DEFAULTS,
                 ...((0, lodash_1.isObject)(contentTypesNameFields) ? contentTypesNameFields : {}),
             },
-            contentTypesPopulate: {
-                ...((0, lodash_1.isObject)(contentTypesPopulate) ? contentTypesPopulate : {}),
-            },
+            contentTypesPopulate: (0, lodash_1.isObject)(contentTypesPopulate) ? contentTypesPopulate : {},
+            pathDefaultFields: (0, lodash_1.isObject)(pathDefaultFields) ? pathDefaultFields : {},
             allowedLevels,
-            additionalFields,
+            additionalFields: viaSettingsPage
+                ? additionalFields
+                : additionalFields.filter(field => typeof field === 'string' || (0, lodash_1.get)(field, 'enabled', false)),
             gql: {
                 navigationItemRelated: configContentTypes.map(({ labelSingular }) => labelSingular.replace(/\s+/g, ''))
             },
             isGQLPluginEnabled: viaSettingsPage ? isGQLPluginEnabled : undefined,
+            slugify,
         };
         const i18nConfig = await (0, i18n_1.addI18NConfigFields)({ strapi, viaSettingsPage, previousConfig: {} });
-        if (additionalFields.includes(utils_2.ADDITIONAL_FIELDS.AUDIENCE)) {
+        if (additionalFields.includes('audience')) {
             const audienceItems = await strapi
                 .query(audienceModel.uid)
                 .findMany({
@@ -60,7 +64,7 @@ const adminService = ({ strapi }) => ({
         };
     },
     async get() {
-        const { masterModel } = (0, utils_2.extractMeta)(strapi.plugins);
+        const { masterModel } = (0, utils_2.getPluginModels)();
         const entities = await strapi
             .query(masterModel.uid)
             .findMany({
@@ -71,7 +75,7 @@ const adminService = ({ strapi }) => ({
     },
     async getById(id) {
         const commonService = (0, utils_2.getPluginService)('common');
-        const { masterModel, itemModel } = (0, utils_2.extractMeta)(strapi.plugins);
+        const { masterModel, itemModel } = (0, utils_2.getPluginModels)();
         const entity = await strapi
             .query(masterModel.uid)
             .findOne({ where: { id }, populate: utils_2.DEFAULT_POPULATE });
@@ -95,11 +99,12 @@ const adminService = ({ strapi }) => ({
         const commonService = (0, utils_2.getPluginService)('common');
         const adminService = (0, utils_2.getPluginService)('admin');
         const { enabled: i18nEnabled, defaultLocale } = await (0, i18n_1.getI18nStatus)({ strapi });
-        const { masterModel } = (0, utils_2.extractMeta)(strapi.plugins);
+        const { slugify: customSlugifyConfig } = await adminService.config(false);
+        const { masterModel } = (0, utils_2.getPluginModels)();
         const { name, visible } = payload;
         const data = {
             name,
-            slug: (0, slugify_1.default)(name).toLowerCase(),
+            slug: (0, slugify_1.default)(name, customSlugifyConfig).toLowerCase(),
             visible,
         };
         const existingEntity = await strapi
@@ -122,13 +127,14 @@ const adminService = ({ strapi }) => ({
         const adminService = (0, utils_2.getPluginService)('admin');
         const commonService = (0, utils_2.getPluginService)('common');
         const { enabled: i18nEnabled } = await (0, i18n_1.getI18nStatus)({ strapi });
-        const { masterModel } = (0, utils_2.extractMeta)(strapi.plugins);
+        const { slugify: customSlugifyConfig } = await adminService.config(false);
+        const { masterModel } = (0, utils_2.getPluginModels)();
         const { name, visible } = payload;
         const existingEntity = await adminService.getById(id);
         const detailsHaveChanged = existingEntity.name !== name || existingEntity.visible !== visible;
         if (detailsHaveChanged) {
             const newName = detailsHaveChanged ? name : existingEntity.name;
-            const newSlug = detailsHaveChanged ? (0, slugify_1.default)(name).toLowerCase() : existingEntity.slug;
+            const newSlug = detailsHaveChanged ? (0, slugify_1.default)(name, customSlugifyConfig).toLowerCase() : existingEntity.slug;
             await strapi.query(masterModel.uid).update({
                 where: { id },
                 data: {
@@ -165,7 +171,7 @@ const adminService = ({ strapi }) => ({
         return result;
     },
     async delete(id, auditLog) {
-        const { masterModel } = (0, utils_2.extractMeta)(strapi.plugins);
+        const { masterModel } = (0, utils_2.getPluginModels)();
         const adminService = (0, utils_2.getPluginService)('admin');
         const entity = await adminService.getById(id);
         const { enabled: i18nEnabled } = await (0, i18n_1.getI18nStatus)({ strapi });
@@ -195,7 +201,13 @@ const adminService = ({ strapi }) => ({
     async updateConfig(newConfig) {
         const commonService = (0, utils_2.getPluginService)('common');
         const pluginStore = await commonService.getPluginStore();
+        const config = await pluginStore.get({ key: 'config' });
+        (0, utils_2.validateAdditionalFields)(newConfig.additionalFields);
         await pluginStore.set({ key: 'config', value: newConfig });
+        const removedFields = (0, lodash_1.differenceBy)(config.additionalFields, newConfig.additionalFields, 'name').filter(i => i !== 'audience');
+        if (!(0, lodash_1.isEmpty)(removedFields)) {
+            await commonService.pruneCustomFields(removedFields);
+        }
     },
     async fillFromOtherLocale({ target, source, auditLog }) {
         const { enabled } = await (0, i18n_1.getI18nStatus)({ strapi });