strapi-plugin-navigation 2.2.14 → 2.2.16

package/README.md

@@ -122,7 +122,7 @@ Complete installation requirements are exact same as for Strapi itself and can b
 
 **Supported Strapi versions**:
 
-- Strapi v4.13.x (recently tested)
+- Strapi v4.14.x (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).
@@ -377,6 +377,73 @@ Plugin supports both **REST API** and **GraphQL API** exposed by Strapi.
 > Version `v2.0.13` introduced breaking change!
 > All responses have changed their structure. Related field will now be of type ContentType instead of Array\<ContentType\>
 
+`GET <host>/api/navigation/?locale=<locale>&orderBy=<orderBy>&orderDirection=<orderDirection>`
+
+NOTE: All params are optional
+
+**Example URL**: `https://localhost:1337/api/navigation?locale=en`
+
+**Example response body**
+
+```json
+[
+  {
+    "id": 383,
+    "name": "Floor",
+    "slug": "floor-pl",
+    "visible": true,
+    "createdAt": "2023-09-29T12:45:54.399Z",
+    "updatedAt": "2023-09-29T13:44:08.702Z",
+    "localeCode": "pl"
+  },
+  {
+    "id": 384,
+    "name": "Floor",
+    "slug": "floor-fr",
+    "visible": true,
+    "createdAt": "2023-09-29T12:45:54.399Z",
+    "updatedAt": "2023-09-29T13:44:08.725Z",
+    "localeCode": "fr"
+  },
+  {
+    "id": 382,
+    "name": "Floor",
+    "slug": "floor",
+    "visible": true,
+    "createdAt": "2023-09-29T12:45:54.173Z",
+    "updatedAt": "2023-09-29T13:44:08.747Z",
+    "localeCode": "en"
+  },
+  {
+    "id": 374,
+    "name": "Main navigation",
+    "slug": "main-navigation-pl",
+    "visible": true,
+    "createdAt": "2023-09-29T12:22:30.373Z",
+    "updatedAt": "2023-09-29T13:44:08.631Z",
+    "localeCode": "pl"
+  },
+  {
+    "id": 375,
+    "name": "Main navigation",
+    "slug": "main-navigation-fr",
+    "visible": true,
+    "createdAt": "2023-09-29T12:22:30.373Z",
+    "updatedAt": "2023-09-29T13:44:08.658Z",
+    "localeCode": "fr"
+  },
+  {
+    "id": 373,
+    "name": "Main navigation",
+    "slug": "main-navigation",
+    "visible": true,
+    "createdAt": "2023-09-29T12:22:30.356Z",
+    "updatedAt": "2023-09-29T13:44:08.680Z",
+    "localeCode": "en"
+  }
+]
+```
+
 `GET <host>/api/navigation/render/<navigationIdOrSlug>?type=<type>`
 
 Return a rendered navigation structure depends on passed type (`TREE`, `RFR` or nothing to render as `FLAT`).

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

@@ -33,6 +33,8 @@ const Stack_1 = require("@strapi/design-system/Stack");
 const Button_1 = require("@strapi/design-system/Button");
 const Check_1 = __importDefault(require("@strapi/icons/Check"));
 const More_1 = __importDefault(require("@strapi/icons/More"));
+const Information_1 = __importDefault(require("@strapi/icons/Information"));
+const Tag_1 = require("@strapi/design-system/Tag");
 const translations_1 = require("../../../../translations");
 const styles_1 = require("./styles");
 const Select_1 = require("@strapi/design-system/Select");
@@ -57,7 +59,12 @@ const NavigationHeader = ({ activeNavigation, availableNavigations, structureHas
     const passedActiveNavigation = pickDefaultLocaleNavigation({ activeNavigation, config });
     const { closeNavigationManagerModal, openNavigationManagerModal, navigationManagerModal } = (0, useNavigationManager_1.useNavigationManager)();
     const { canUpdate } = permissions;
-    return (react_1.default.createElement(Layout_1.HeaderLayout, { primaryAction: react_1.default.createElement(Stack_1.Stack, { horizontal: true, size: 2 },
+    return (react_1.default.createElement(Layout_1.HeaderLayout, { secondaryAction: react_1.default.createElement(Tag_1.Tag, { icon: react_1.default.createElement(Information_1.default, { "aria-hidden": true }) }, activeNavigation
+            ? formatMessage((0, translations_1.getTrad)('header.meta'), {
+                id: activeNavigation?.id,
+                key: activeNavigation?.slug
+            })
+            : null), primaryAction: react_1.default.createElement(Stack_1.Stack, { horizontal: true, size: 2 },
             react_1.default.createElement(Box_1.Box, { marginRight: "8px" },
                 react_1.default.createElement(Grid_1.Grid, { gap: 4 },
                     !hasLocalizations ? (react_1.default.createElement(Grid_1.GridItem, { col: 2 })) : null,

package/admin/src/pages/View/components/NavigationItemForm/utils/form.d.ts

@@ -2,21 +2,21 @@ import * as yup from "yup";
 import { NavigationItemAdditionalField } from "../../../../../../../types";
 import { RawFormPayload } from "../types";
 export declare const schemaFactory: (isSingleSelected: boolean, additionalFields: NavigationItemAdditionalField[]) => import("yup/lib/object").OptionalObjectSchema<{
-    title: yup.StringSchema<string | undefined, Record<string, any>, string | undefined>;
+    title: yup.default<string | undefined, Record<string, any>, string | undefined>;
     uiRouterKey: import("yup/lib/string").RequiredStringSchema<string | undefined, Record<string, any>>;
     type: import("yup/lib/string").RequiredStringSchema<string | undefined, Record<string, any>>;
-    path: yup.StringSchema<string | undefined, Record<string, any>, string | undefined>;
-    externalPath: yup.StringSchema<string | undefined, Record<string, any>, string | undefined>;
+    path: yup.default<string | undefined, Record<string, any>, string | undefined>;
+    externalPath: yup.default<string | undefined, Record<string, any>, string | undefined>;
     menuAttached: yup.BooleanSchema<boolean | undefined, Record<string, any>, boolean | undefined>;
     relatedType: import("yup/lib/mixed").MixedSchema<any, Record<string, any>, any>;
     related: import("yup/lib/mixed").MixedSchema<any, Record<string, any>, any>;
     additionalFields: import("yup/lib/object").OptionalObjectSchema<{}, Record<string, any>, import("yup/lib/object").TypeOfShape<{}>>;
 }, Record<string, any>, import("yup/lib/object").TypeOfShape<{
-    title: yup.StringSchema<string | undefined, Record<string, any>, string | undefined>;
+    title: yup.default<string | undefined, Record<string, any>, string | undefined>;
     uiRouterKey: import("yup/lib/string").RequiredStringSchema<string | undefined, Record<string, any>>;
     type: import("yup/lib/string").RequiredStringSchema<string | undefined, Record<string, any>>;
-    path: yup.StringSchema<string | undefined, Record<string, any>, string | undefined>;
-    externalPath: yup.StringSchema<string | undefined, Record<string, any>, string | undefined>;
+    path: yup.default<string | undefined, Record<string, any>, string | undefined>;
+    externalPath: yup.default<string | undefined, Record<string, any>, string | undefined>;
     menuAttached: yup.BooleanSchema<boolean | undefined, Record<string, any>, boolean | undefined>;
     relatedType: import("yup/lib/mixed").MixedSchema<any, Record<string, any>, any>;
     related: import("yup/lib/mixed").MixedSchema<any, Record<string, any>, any>;

package/admin/src/translations/ca.json

@@ -14,6 +14,7 @@
     "header.action.manage": "Gestionar",
     "header.action.newItem": "Element nou",
     "header.description": "Definiu la vostra navegació del lloc web",
+    "header.meta": "ID: { id }, slug: { key }",
     "header.title": "Navegació",
     "notification.error": "S'ha produït un error en processar la sol·licitud.",
     "notification.error.customField.type": "Tipus de camp personalitzat no compatible",

package/admin/src/translations/en.json

@@ -2,6 +2,7 @@
     "plugin.name": "UI Navigation",
     "header.title": "Navigation",
     "header.description": "Define your portal navigation",
+    "header.meta": "ID: { id }, slug: { key }",
     "header.action.newItem": "New Item",
     "header.action.manage": "Manage",
     "header.action.collapseAll": "Collapse All",

package/admin/src/translations/fr.json

@@ -2,6 +2,7 @@
     "plugin.name": "UI Navigation",
     "header.title": "Navigation",
     "header.description": "Définisser votre menu de navigation",
+    "header.meta": "ID: { id }, slug: { key }",
     "submit.cta.cancel": "Annuler",
     "submit.cta.save": "Sauvegarder",
     "empty": "Le menu de navigation est vide",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-navigation",
-  "version": "2.2.14",
+  "version": "2.2.16",
   "description": "Strapi - Navigation plugin",
   "strapi": {
     "name": "navigation",
@@ -15,7 +15,7 @@
   "scripts": {},
   "dependencies": {
     "@sindresorhus/slugify": "1.1.0",
-    "@strapi/utils": "^4.13.6",
+    "@strapi/utils": "^4.14.2",
     "lodash": "^4.17.21",
     "pluralize": "^8.0.0",
     "react": "^18.2.0",
@@ -49,6 +49,11 @@
       "name": "VirtusLab // Maciej Witkowski",
       "email": "mwitkowski@virtuslab.com",
       "url": "https://virtuslab.com"
+    },
+    {
+      "name": "VirtusLab // Tomasz Puch",
+      "email": "tpuch@virtuslab.com",
+      "url": "https://virtuslab.com"
     }
   ],
   "engines": {

package/server/controllers/client.js

@@ -6,6 +6,21 @@ const clientControllers = {
     getService(name = "client") {
         return (0, utils_2.getPluginService)(name);
     },
+    async readAll(ctx) {
+        const { query = {} } = ctx;
+        const { locale, orderBy, orderDirection } = query;
+        try {
+            return await this.getService().readAll({
+                locale, orderBy, orderDirection
+            });
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                return ctx.badRequest(error.message);
+            }
+            throw error;
+        }
+    },
     async render(ctx) {
         const { params, query = {} } = ctx;
         const { type, menu: menuOnly, path: rootPath, locale, populate } = query;

package/server/i18n/navigationSetupStrategy.js

@@ -4,6 +4,7 @@ exports.i18nNavigationSetupStrategy = void 0;
 const types_1 = require("../../types");
 const utils_1 = require("../utils");
 const errors_1 = require("./errors");
+const fp_1 = require("lodash/fp");
 const i18nNavigationSetupStrategy = async ({ strapi, }) => {
     const pluginStore = strapi.store({
         type: "plugin",
@@ -24,48 +25,54 @@ const i18nNavigationSetupStrategy = async ({ strapi, }) => {
                 await createDefaultI18nNavigation({ strapi, defaultLocale }),
             ];
         }
-        if (currentNavigations.some(hasNotAnyLocale)) {
-            currentNavigations = await Promise.all(currentNavigations.map(async (navigation) => {
-                return hasNotAnyLocale(navigation)
-                    ? await updateNavigation({
-                        strapi,
-                        current: navigation,
-                        payload: {
-                            localeCode: defaultLocale,
-                        },
-                        populate: utils_1.DEFAULT_POPULATE,
-                    })
-                    : navigation;
-            }));
+        const noLocaleNavigations = currentNavigations.filter(hasNotAnyLocale);
+        if (noLocaleNavigations.length) {
+            await updateNavigations({
+                strapi,
+                ids: noLocaleNavigations.map((0, fp_1.prop)("id")).reduce((acc, id) => {
+                    if (id && Number(id)) {
+                        acc.push(Number(id));
+                    }
+                    return acc;
+                }, []),
+                payload: {
+                    localeCode: defaultLocale,
+                },
+                populate: utils_1.DEFAULT_POPULATE,
+            });
+            currentNavigations = await getCurrentNavigations(strapi);
         }
-        await Promise.all(currentNavigations
-            .filter(({ localeCode }) => defaultLocale === localeCode)
-            .flatMap(async (rootNavigation) => {
-            const localizations = [
+        const navigationsToProcess = currentNavigations.filter(({ localeCode }) => defaultLocale === localeCode);
+        for (const rootNavigation of navigationsToProcess) {
+            let localizations = [
                 ...(rootNavigation.localizations ?? []).map((localization) => (0, types_1.assertEntity)(localization, "Navigation")),
                 rootNavigation,
             ];
-            for (const locale of allLocale) {
-                if (!localizations.some(({ localeCode }) => localeCode === locale)) {
-                    localizations.push(await createNavigation({
-                        strapi,
-                        payload: {
-                            localeCode: locale,
-                            slug: `${rootNavigation.slug}-${locale}`,
-                            name: rootNavigation.name,
-                            visible: true,
-                        },
-                    }));
-                }
+            const missingLocale = allLocale.filter((locale) => !localizations.some(({ localeCode }) => localeCode === locale));
+            if (missingLocale.length) {
+                const { ids } = await createNavigations({
+                    strapi,
+                    payloads: missingLocale.map((locale) => ({
+                        localeCode: locale,
+                        slug: `${rootNavigation.slug}-${locale}`,
+                        name: rootNavigation.name,
+                        visible: true,
+                    })),
+                });
+                localizations = [...(await getCurrentNavigations(strapi, ids))].concat([
+                    rootNavigation,
+                ]);
             }
-            return await Promise.all(localizations.map((current) => updateNavigation({
-                strapi,
-                current,
-                payload: {
-                    localizations: localizations.filter(({ id }) => id !== current.id),
-                },
-            })));
-        }));
+            for (const current of localizations) {
+                await updateNavigation({
+                    strapi,
+                    current,
+                    payload: {
+                        localizations: localizations.filter((localization) => localization.id !== current.id),
+                    },
+                });
+            }
+        }
     }
     else {
         if (config.pruneObsoleteI18nNavigations) {
@@ -89,13 +96,17 @@ const i18nNavigationSetupStrategy = async ({ strapi, }) => {
     return getCurrentNavigations(strapi);
 };
 exports.i18nNavigationSetupStrategy = i18nNavigationSetupStrategy;
-const getCurrentNavigations = (strapi) => strapi.plugin("navigation").service("admin").get();
+const getCurrentNavigations = (strapi, ids) => strapi.plugin("navigation").service("admin").get(ids);
 const createNavigation = ({ strapi, payload, populate, }) => strapi.query("plugin::navigation.navigation").create({
     data: {
         ...payload,
     },
     populate,
 });
+const createNavigations = ({ strapi, payloads, populate, }) => strapi.query("plugin::navigation.navigation").createMany({
+    data: payloads,
+    populate,
+});
 const updateNavigation = ({ strapi, current, payload, populate, }) => strapi.query("plugin::navigation.navigation").update({
     data: {
         ...payload,
@@ -105,10 +116,19 @@ const updateNavigation = ({ strapi, current, payload, populate, }) => strapi.que
         id: current.id,
     },
 });
+const updateNavigations = ({ strapi, ids, payload, populate, }) => strapi.query("plugin::navigation.navigation").updateMany({
+    data: payload,
+    populate,
+    where: {
+        id: {
+            $in: ids,
+        },
+    },
+});
 const deleteNavigations = ({ strapi, where, }) => strapi.query("plugin::navigation.navigation").deleteMany({
     where,
 });
-const createDefaultI18nNavigation = ({ strapi, defaultLocale }) => createNavigation({
+const createDefaultI18nNavigation = ({ strapi, defaultLocale, }) => createNavigation({
     strapi,
     payload: {
         ...utils_1.DEFAULT_NAVIGATION_ITEM,

package/server/routes/client.js

@@ -18,6 +18,14 @@ const routes = {
             config: {
                 policies: []
             }
+        },
+        {
+            method: "GET",
+            path: "/",
+            handler: "client.readAll",
+            config: {
+                policies: []
+            }
         }
     ]
 };