strapi-plugin-navigation 1.1.2 → 2.0.0-beta.1

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

@@ -1,240 +0,0 @@
-/*
- *
- * Navigation View
- *
- */
-
-import React, { memo, useMemo, useState } from 'react';
-import { FormattedMessage, useIntl } from "react-intl";
-import { LoadingIndicatorPage } from "strapi-helper-plugin";
-import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
-import { faHamburger, faPlus } from "@fortawesome/free-solid-svg-icons";
-import useDataManager from "../../hooks/useDataManager";
-import { isEmpty, get } from "lodash";
-import { Header } from "@buffetjs/custom";
-import { Button, HeaderActions, Select } from "@buffetjs/core";
-import Wrapper from "../View/Wrapper";
-import EmptyView from "../../components/EmptyView";
-import HeaderForm from "./HeaderForm";
-import HeaderFormCell from "./HeaderFormCell";
-import NavigationItemPopUp from "./components/NavigationItemPopup";
-import List from "../../components/List";
-import {
-  transformItemToViewPayload,
-  transformToRESTPayload, 
-  usedContentTypes,
-  validateNavigationStructure,
-} from './utils/parsers';
-import FadedWrapper from "./FadedWrapper";
-import { getTrad, getTradId } from '../../translations';
-
-const View = () => {
-  const {
-    items: availableNavigations,
-    activeItem: activeNavigation,
-    changedActiveItem: changedActiveNavigation,
-    config,
-    navigationItemPopupOpened,
-    isLoading,
-    isLoadingForAdditionalDataToBeSet,
-    isLoadingForSubmit,
-    handleChangeNavigationItemPopupVisibility,
-    handleChangeSelection,
-    handleChangeNavigationData,
-    handleResetNavigationData,
-    handleSubmitNavigation,
-    getContentTypeItems,
-    error
-  } = useDataManager();
-  const [activeNavigationItem, setActiveNavigationItemState] = useState({});
-  const { formatMessage } = useIntl();
-
-  const options = availableNavigations.map((item) => ({
-    value: item.id,
-    label: item.name,
-  }));
-
-  const structureHasErrors = !validateNavigationStructure((changedActiveNavigation || {}).items);
-  const navigationSelectValue = get(activeNavigation, "id", null);
-  const actions = [
-    {
-      label: formatMessage(getTrad('submit.cta.cancel')),
-      onClick: () => isLoadingForSubmit ? null : handleResetNavigationData(),
-      color: "cancel",
-      type: "button",
-    },
-    {
-      label: formatMessage(getTrad('submit.cta.save')),
-      onClick: () =>
-        isLoadingForSubmit || structureHasErrors ? null : handleSubmitNavigation(formatMessage, transformToRESTPayload(changedActiveNavigation, config)),
-      color: "success",
-      type: "submit",
-      isLoading: isLoadingForSubmit,
-      disabled: structureHasErrors,
-    },
-  ];
-
-  const pullUsedContentTypeItem = (items = []) =>
-    items.reduce((prev, curr) =>
-        [...prev, curr.relatedRef ? {
-          __collectionName: curr.relatedRef.__collectionName,
-          id: curr.relatedRef.id
-        } : undefined, ...pullUsedContentTypeItem(curr.items)].filter(item => item)
-      , []);
-  const usedContentTypeItems = pullUsedContentTypeItem((changedActiveNavigation || {}).items);
-
-  const changeNavigationItemPopupState = (visible, editedItem = {}) => {
-    setActiveNavigationItemState(editedItem);
-    handleChangeNavigationItemPopupVisibility(visible);
-  };
-
-  const addNewNavigationItem = (
-    e,
-    viewId = null,
-    isMenuAllowedLevel = true,
-    levelPath = '',
-    parentAttachedToMenu = true,
-  ) => {
-    e.preventDefault();
-    e.stopPropagation();
-    changeNavigationItemPopupState(true, {
-      viewParentId: viewId,
-      isMenuAllowedLevel,
-      levelPath,
-      parentAttachedToMenu,
-    });
-  };
-
-  const editNavigationItem = (
-    e,
-    item,
-    levelPath = '',
-    parentAttachedToMenu = true,
-  ) => {
-    e.preventDefault();
-    e.stopPropagation();
-    changeNavigationItemPopupState(true, {
-      ...item,
-      levelPath,
-      parentAttachedToMenu,
-    });
-  };
-
-  const restoreNavigationItem = (e, item) => {
-    e.preventDefault();
-    e.stopPropagation();
-
-    handleSubmitNavigationItem({
-      ...item,
-      removed: false,
-    });
-  };
-
-  const reOrderNavigationItem = (e, item, moveBy = 0) => {
-    e.preventDefault();
-    e.stopPropagation();
-
-    handleSubmitNavigationItem({
-      ...item,
-      order: item.order + (moveBy * 1.5),
-    });
-  }
-
-  const onPopUpClose = (e) => {
-    e.preventDefault();
-    e.stopPropagation();
-    changeNavigationItemPopupState(false);
-  };
-
-  const handleSubmitNavigationItem = (payload) => {
-    const changedStructure = {
-      ...changedActiveNavigation,
-      items: transformItemToViewPayload(payload, changedActiveNavigation.items, config),
-    };
-    handleChangeNavigationData(changedStructure, true);
-  };
-
-  const usedContentTypesData = useMemo(
-    () => changedActiveNavigation ? usedContentTypes(changedActiveNavigation.items) : [],
-    [changedActiveNavigation],
-  );
-
-  return (
-    <div className="container-fluid">
-      <div className="row">
-        <Wrapper className="col-md-12">
-          <HeaderForm>
-            <HeaderFormCell>
-              <Header
-                title={{
-                  label: formatMessage(getTrad('header.title')),
-                }}
-                content={formatMessage(getTrad('header.description'))}
-              />
-            </HeaderFormCell>
-            { options && (options.length > 1) && (<HeaderFormCell>
-              <Select
-                name="activeNavigation"
-                onChange={({ target: { value } }) =>
-                  handleChangeSelection(value)
-                }
-                options={options}
-                value={navigationSelectValue}
-              />
-            </HeaderFormCell>) }
-            <HeaderFormCell align="right" fill>
-              <HeaderActions actions={actions} />
-            </HeaderFormCell>
-          </HeaderForm>
-          <FadedWrapper>
-            {isLoading && <LoadingIndicatorPage />}
-            {changedActiveNavigation && (
-              <>
-                {isEmpty(changedActiveNavigation.items || []) && (
-                  <EmptyView>
-                    <FontAwesomeIcon icon={faHamburger} size="5x" />
-                    <FormattedMessage id={getTradId('empty')} />
-                    <Button
-                      color="primary"
-                      icon={<FontAwesomeIcon icon={faPlus} />}
-                      label={formatMessage(getTrad('empty.cta'))}
-                      onClick={addNewNavigationItem}
-                    />
-                  </EmptyView>
-                )}
-                {!isEmpty(changedActiveNavigation.items || []) && (
-                  <List
-                    items={changedActiveNavigation.items || []}
-                    onItemClick={editNavigationItem}
-                    onItemReOrder={reOrderNavigationItem}
-                    onItemRestoreClick={restoreNavigationItem}
-                    onItemLevelAddClick={addNewNavigationItem}
-                    root
-                    error={error}
-                    allowedLevels={config.allowedLevels}
-                    contentTypes={config.contentTypes}
-                    isParentAttachedToMenu={true}
-                    contentTypesNameFields={config.contentTypesNameFields}
-                  />
-                )}
-              </>
-            )}
-          </FadedWrapper>
-          <NavigationItemPopUp
-            isOpen={navigationItemPopupOpened}
-            isLoading={isLoadingForAdditionalDataToBeSet}
-            data={activeNavigationItem}
-            config={config}
-            usedContentTypesData={usedContentTypesData}
-            usedContentTypeItems={usedContentTypeItems}
-            getContentTypeItems={getContentTypeItems}
-            onSubmit={handleSubmitNavigationItem}
-            onClose={onPopUpClose}
-          />
-        </Wrapper>
-      </div>
-    </div>
-  );
-};
-
-export default memo(View);

package/admin/src/lifecycles.js

@@ -1,3 +0,0 @@
-function lifecycles() {}
-
-export default lifecycles;

package/admin/src/permissions.js

@@ -1,14 +0,0 @@
-const pluginPermissions = {
-  // This permission regards the main component (App) and is used to tell
-  // If the plugin link should be displayed in the menu
-  // And also if the plugin is accessible. This use case is found when a user types the url of the
-  // plugin directly in the browser
-  main: [
-    { action: "plugins::navigation.read", subject: null },
-    { action: "plugins::navigation.update", subject: null },
-  ],
-  open: [{ action: "plugins::navigation.read", subject: null }],
-  update: [{ action: "plugins::navigation.update", subject: null }],
-};
-
-export default pluginPermissions;

package/config/functions/bootstrap.js

@@ -1,138 +0,0 @@
-const { isEmpty, get, last } = require('lodash');
-
-const saveJSONParse = (value) => {
-  try {
-    return JSON.parse(value).map((_) => ({ ..._, id: _._id }));
-  } catch (e) {
-    return null;
-  }
-};
-
-const getDefaultConnectionName = (strapi) => strapi.config.get('database.defaultConnection');
-
-const isMongo = (strapi) => {
-  const connectionName = getDefaultConnectionName(strapi);
-  return strapi.config.get(`database.connections.${connectionName}.connector`).includes('mongo');
-};
-
-const getNavigationMorphData = (strapi) => {
-  const connectionName = getDefaultConnectionName(strapi);
-  const { [connectionName]: knex } = strapi.connections;
-  return knex.schema.hasTable('navigations_items_morph').then((exist)=> exist ?  knex('navigations_items_morph').select('*') : []);
-};
-
-const getNavigationItemsModel = (strapi) => strapi.query('navigationitem', 'navigation');
-
-const getRelatedModel = (strapi) => strapi.query('navigations_items_related', 'navigation');
-
-const createRelatedData = (relatedModel, navigationItemsModel, items) => ({
-  field,
-  order,
-  related_id,
-  related_type,
-  navigations_items_id,
-}) => {
-  const item = items.find(item => item.id === navigations_items_id);
-  const modelUID = get(strapi.query(related_type), 'model.uid');
-  if (item && modelUID) {
-    const relatedData = {
-      field,
-      order,
-      related_id,
-      related_type: modelUID,
-      master: get(item.master, 'id', item.master),
-    };
-    return relatedModel.create(relatedData)
-      .then(
-        ({ id }) => navigationItemsModel.update({ id: navigations_items_id }, { related: id }),
-      );
-  }
-  return Promise.resolve();
-};
-
-const migrateNavigationItemsSQL = async (strapi) => {
-  const morphData = await getNavigationMorphData(strapi);
-  if (morphData.length) {
-    const relatedModel = getRelatedModel(strapi);
-    const navigationItemsModel = getNavigationItemsModel(strapi);
-    const items = await navigationItemsModel.find({});
-    await Promise.all(morphData.map(createRelatedData(relatedModel, navigationItemsModel, items)));
-  }
-};
-
-const migrateNavigationItemsMongo = async (strapi) => {
-  const navigationItemsModel = getNavigationItemsModel(strapi);
-  const connectionName = getDefaultConnectionName(strapi);
-  const models = strapi.connections[connectionName].models;
-  const items = (await models.NavigationNavigationitem.find({}))
-    // workaround to change type from object to int
-    .map(_ => ({ ..._.toObject(), related: last(saveJSONParse(get(_.errors, 'related.properties.value', null))) }))
-    .filter(_ => _.related);
-
-  if (items.length) {
-    await Promise.all(items.map(item => {
-      const data = {
-        related_id: item.related.ref,
-        related_type: models[item.related.kind].uid,
-        field: item.related.field,
-        order: 1,
-        master: item.master,
-      };
-      return getRelatedModel(strapi)
-        .create(data)
-        .then(result => navigationItemsModel.update({ id: item.id }, { related: [result.id] }));
-    }));
-
-  }
-};
-
-module.exports = async () => {
-  // Check if the plugin users-permissions is installed because the navigation needs it
-  if (Object.keys(strapi.plugins).indexOf('users-permissions') === -1) {
-    throw new Error(
-      'In order to make the navigation plugin work the users-permissions plugin is required',
-    );
-  }
-
-  // Add permissions
-  const actions = [
-    {
-      section: 'plugins',
-      displayName: 'Access the Navigation',
-      uid: 'read',
-      pluginName: 'navigation',
-    },
-    {
-      section: 'plugins',
-      displayName: 'Ability to change the Navigation',
-      uid: 'update',
-      pluginName: 'navigation',
-    },
-  ];
-
-  const navigations = await strapi
-    .query('navigation', 'navigation')
-    .find();
-  if (isEmpty(navigations)) {
-    await strapi
-      .query('navigation', 'navigation')
-      .create({
-        name: 'Main navigation',
-        slug: 'main-navigation',
-        visible: true,
-      });
-  }
-  const relatedModel = getRelatedModel(global.strapi);
-  const isMigrated = !!(await relatedModel.count({}));
-  if (!isMigrated) {
-    const isMongoDB = isMongo(global.strapi);
-    if (isMongoDB) {
-      await migrateNavigationItemsMongo(global.strapi);
-    } else {
-      await migrateNavigationItemsSQL(global.strapi);
-    }
-  }
-
-  const { actionProvider } = strapi.admin.services.permission;
-  await actionProvider.registerMany(actions);
-};

package/config/routes.json

@@ -1,60 +0,0 @@
-{
-  "routes": [
-    {
-      "method": "GET",
-      "path": "/",
-      "handler": "navigation.get",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "POST",
-      "path": "/",
-      "handler": "navigation.post",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/config",
-      "handler": "navigation.config",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/:id",
-      "handler": "navigation.getById",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "PUT",
-      "path": "/:id",
-      "handler": "navigation.put",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/render/:idOrSlug",
-      "handler": "navigation.render",
-      "config": {
-        "policies": []
-      }
-    },
-    {
-      "method": "GET",
-      "path": "/render/:idOrSlug/:childUIKey",
-      "handler": "navigation.renderChild",
-      "config": {
-        "policies": []
-      }
-    }
-  ]
-}

package/config/schema.graphql.js

@@ -1,204 +0,0 @@
-const NAVIGATION_DATE = `
-# SQL
-  created_at: String
-  updated_at: String
-# MONGO
-  createdAt: String
-  updatedAt: String
-`;
-
-const NAVIGATION_USER = `
-# SQL
- created_by: String
- updated_by: String
-# MONGO
- createdBy: String
- updatedBy: String
-`;
-
-const NAVIGATION = `
- id: String!
- name: String!
- slug: String!
- visible: Boolean!
-`;
-
-const getContentTypesNamesFields = () => {
-  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('plugins.navigation.gql.navigationItemRelated');
-  if (related) {
-    return related;
-  }
-  return `
-    type NavigationRelated { 
-      id: Int
-      title: String
-      name: String
-    }
-  `;
-};
-
-module.exports = {
-  // language=GraphQL
-  definition: `
-  enum NavigationRenderType {
-      FLAT,
-      TREE,
-      RFR
-  }
-  
-  ${getNavigationRelated()}
-
-
-  type NavigationItem { 
-    id: Int!
-    title: String!
-    type: String!
-    path: String
-    externalPath: String
-    uiRouterKey: String!
-    menuAttached: Boolean!
-    order: Int!
-    parent: Int
-    master: Int
-    items: [NavigationItem]
-    related: NavigationRelated
-    audience: [String]
-    ${NAVIGATION_DATE}
-    ${NAVIGATION_USER}
-  }
-
-  type Navigation { 
-    ${NAVIGATION}
-  }
-  
-  type NavigationDetails { 
-    ${NAVIGATION}  
-    items: [NavigationItem]!
-  }
-  
-  
-  type ContentTypesNameFields { 
-    default: [String!]!
-    ${getContentTypesNamesFields()}
-  }
-
-  type ContentTypes { 
-    uid: String!
-    name: String!
-    isSingle: Boolean!
-    collectionName: String!
-    contentTypeName: String!
-    label: String!
-    relatedField: String!
-    labelSingular: String!
-    endpoint: String!
-    available: Boolean!
-    visible: Boolean!
-  }
-
-  type NavigationConfig { 
-    allowedLevels: Int
-    availableAudience: [NavigationAudience]!
-    additionalFields: [String]!
-    contentTypesNameFields: ContentTypesNameFields
-    contentTypes: [ContentTypes] 
-  }
-
-  input CreateNavigationRelated {
-    ref: String!
-    field: String!
-    refId: String!
-  }
-  
-  input CreateNavigationItem {
-    title: String!
-    type: String!
-    path: String
-    externalPath: String
-    uiRouterKey: String!
-    menuAttached: Boolean!
-    order: Int!
-    parent: Int
-    master: Int
-    items: [CreateNavigationItem]
-    audience: [String]
-    related: CreateNavigationRelated
-  }
-
-  input CreateNavigation {
-    name: String!
-    items: [CreateNavigationItem]!
-  }
-  `,
-  query: `
-    renderNavigation(navigationIdOrSlug: String!, type: NavigationRenderType, menuOnly: Boolean): [NavigationItem]!
-    renderNavigationChild(id: String!, childUIKey: String!, type: NavigationRenderType, menuOnly: Boolean): [NavigationItem]!
-    getNavigation: [Navigation]!
-    configNavigation: NavigationConfig
-    getByIdNavigation(id: String!): NavigationItem
-  `,
-  type: {},
-  mutation: `
-    navigationCreate(newNavigation: CreateNavigation!): Navigation!
-    navigationUpdate(id: String!, navigation: CreateNavigation!): Navigation!
-  `,
-  resolver: {
-    Query: {
-      renderNavigation: {
-        resolverOf: 'plugins::navigation.navigation.render',
-        resolver(obj, options) {
-          const { navigationIdOrSlug, type, menuOnly } = options;
-          return strapi.plugins.navigation.services.navigation.render(navigationIdOrSlug, type, menuOnly);
-        },
-      },
-      renderNavigationChild: {
-        resolverOf: 'plugins::navigation.navigation.renderChild',
-        async resolver(obj, options) {
-          const { id, childUIKey, type, menuOnly } = options;
-          return strapi.plugins.navigation.services.navigation.renderChildren(id, childUIKey, type, menuOnly);
-        },
-      },
-      getNavigation: {
-        resolverOf: 'plugins::navigation.navigation.get',
-        resolver() {
-          return strapi.plugins.navigation.services.navigation.get();
-        },
-      },
-      configNavigation: {
-        resolverOf: 'plugins::navigation.navigation.config',
-        resolver() {
-          return strapi.plugins.navigation.services.navigation.config();
-        },
-      },
-      getByIdNavigation: {
-        resolverOf: 'plugins::navigation.navigation.getById',
-        async resolver(obj, options) {
-          const { id } = options;
-          return strapi.plugins.navigation.services.navigation.getById(id);
-        },
-      },
-    },
-    Mutation: {
-      navigationCreate: {
-        resolverOf: 'plugins::navigation.navigation.post',
-        resolver(obj, options) {
-          const { newNavigation } = options;
-          return strapi.plugins.navigation.services.navigation.post(newNavigation);
-        },
-      },
-      navigationUpdate: {
-        resolverOf: 'plugins::navigation.navigation.put',
-        resolver(obj, options) {
-          const { id, navigation } = options;
-          return  strapi.plugins.navigation.services.navigation.put(id, navigation);
-        },
-      },
-    },
-  },
-};
-

package/examples/audit-log-integrations.js.md

@@ -1,38 +0,0 @@
-```javascript
-const { Base, AvailableAction } = require('strapi-plugin-audit-log');
-
-class Navigation extends Base {
-  constructor(strapi, user) {
-    super(strapi, user);
-
-    this.once('onChangeNavigation', ({ actionType, oldEntity, newEntity }) => {
-      this.actionType = actionType;
-      this.add('beforeUpdate', oldEntity);
-      this.add('afterUpdate', newEntity);
-    });
-  }
-
-  async run(method, ctx, config) {
-    const data = this.sanitize(this.entities);
-    switch (method) {
-      case 'POST':
-      case 'PUT': {
-        const { beforeUpdate, afterUpdate } = data;
-        if (beforeUpdate && afterUpdate) {
-          const diffs = this.getDiff(beforeUpdate, afterUpdate);
-          return this.save(
-            ctx.params.id,
-            this.actionType || AvailableAction.UPDATE,
-            config.pluginName,
-            diffs,
-          );
-        }
-        break;
-      }
-    }
-    return Promise.resolve();
-  }
-}
-
-module.exports = Navigation;
-```