@localazy/strapi-plugin 0.1.8 → 0.1.9

package/.github/workflows/.build.yml

@@ -10,20 +10,9 @@ jobs:
         run: pwd && sudo chown -R $USER:$USER ./
       - uses: actions/checkout@v2
       - name: Setup Node.js environment
-        uses: actions/setup-node@v1.4.4
+        uses: actions/setup-node@v3
         with:
-          node-version: 14.x
-      - name: Cache node modules
-        uses: actions/cache@v1
-        env:
-          cache-name: cache-node-modules
-        with:
-          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.cache-name }}-
-            ${{ runner.os }}-build-
-            ${{ runner.os }}-
+          node-version: 14.x     
       - name: Install dependencies
         run: npm ci
       - name: Run unit tests

package/admin/src/modules/plugin-settings/components/ContentTransferSetup/index.js

@@ -21,6 +21,7 @@ import hasModelChanged from "../../functions/has-model-changed";
 import buildContentTransferSetupSchema from "../../functions/build-content-transfer-setup-schema";
 import { getLocalazyIdentity } from "../../../../state/localazy-identity";
 import Tree from "../Tree";
+import ContentTransferSetupEmpty from "../ContentTransferSetupEmpty";
 
 import "../../../../i18n";
 
@@ -28,7 +29,6 @@ function ContentTransferSetup() {
   /**
    * Translation function
    */
-  // eslint-disable-next-line no-unused-vars
   const { t } = useTranslation();
 
   /**
@@ -250,6 +250,10 @@ function ContentTransferSetup() {
             shadow="tableShadow"
             hasRadius
           >
+            {!formModel.length && (
+              // empty state
+              <ContentTransferSetupEmpty />
+            )}
             {formModel.map((tree, index) => {
               return (
                 <Box
@@ -257,30 +261,37 @@ function ContentTransferSetup() {
                   key={`box_tree_${index}`}
                   marginBottom={3}
                 >
-                  <Tree onTreeItemClick={onTreeItemClick} objects={tree} />
+                  <Tree
+                    onTreeItemClick={onTreeItemClick}
+                    objects={tree}
+                    initiallyExpanded={index === 0} />
                 </Box>
               );
             })}
-            <Box
-              paddingTop={6}
-              paddingBottom={6}
-            >
-              <Divider />
-            </Box>
-            <Typography variant="omega">{t("plugin_settings.you_can_upload_download")}</Typography>
-            <Typography variant="omega" fontWeight="semiBold">{t("plugin_settings.only_text_based_content")}</Typography>
-            <br />
-            <br />
-            <Typography variant="omega">{t("plugin_settings.learn_more_in_docs_message_a")}</Typography>
-            <Typography
-              onClick={onReadDocumentationClick}
-              variant="omega"
-              fontWeight="semiBold"
-              textColor="primary600"
-              style={{ cursor: "pointer" }}
-            >
-              {t("plugin_settings.learn_more_in_docs_message_b")}
-            </Typography>
+            {!!formModel.length && (
+              <Box>
+                <Box
+                  paddingTop={6}
+                  paddingBottom={6}
+                >
+                  <Divider />
+                </Box>
+                <Typography variant="omega">{t("plugin_settings.you_can_upload_download")}</Typography>
+                <Typography variant="omega" fontWeight="semiBold">{t("plugin_settings.only_text_based_content")}</Typography>
+                <br />
+                <br />
+                <Typography variant="omega">{t("plugin_settings.learn_more_in_docs_message_a")}</Typography>
+                <Typography
+                  onClick={onReadDocumentationClick}
+                  variant="omega"
+                  fontWeight="semiBold"
+                  textColor="primary600"
+                  style={{ cursor: "pointer" }}
+                >
+                  {t("plugin_settings.learn_more_in_docs_message_b")}
+                </Typography>
+              </Box>
+            )}
           </Box>
         )
         }

package/admin/src/modules/plugin-settings/components/ContentTransferSetupEmpty/index.js

@@ -0,0 +1,86 @@
+import React from "react";
+import { useTranslation, Trans } from "react-i18next";
+import styled from 'styled-components';
+import { Typography, Flex } from "@strapi/design-system";
+import Dot from '@strapi/icons/Dot';
+
+const CustomBullet = styled(Dot)`
+  width: ${12 / 16}rem;
+  height: ${4 / 16}rem;
+  margin-right: ${4 / 16}rem;
+  * {
+    fill: ${({ theme, $active }) => ($active ? theme.colors.primary600 : theme.colors.neutral600)};
+  }
+`;
+
+function ContentTransferSetupEmpty() {
+  const { t } = useTranslation();
+
+  return (
+    <div>
+      <Typography
+        textColor="neutral600"
+        variant="beta"
+      >
+        {t("plugin_settings.there_is_nothing_to_transfer")}
+      </Typography>
+      <br />
+      <br />
+      <Typography
+        textColor="neutral600"
+        variant="omega"
+      >
+        {t("plugin_settings.please_check_that_you_have_entered_a_valid_collection")}
+      </Typography>
+      <br />
+      <Flex marginTop={1} alignItems="center">
+        <CustomBullet />
+        <Typography
+          textColor="neutral600"
+          variant="omega"
+        >
+          <Trans i18nKey="plugin_settings.step_1" components={{ 1: <Typography variant="omega" fontWeight="semiBold" /> }} />
+        </Typography>
+      </Flex>
+      <Flex marginTop={1} alignItems="center">
+        <CustomBullet />
+
+        <Typography
+          textColor="neutral600"
+          variant="omega"
+        >
+          <Trans i18nKey="plugin_settings.step_2" components={{ 1: <Typography variant="omega" fontWeight="semiBold" /> }} />
+        </Typography>
+      </Flex>
+      <Flex marginTop={1} alignItems="center">
+        <CustomBullet />
+        <Typography
+          textColor="neutral600"
+          variant="omega"
+        >
+          <Trans i18nKey="plugin_settings.step_3" components={{ 1: <Typography variant="omega" fontWeight="semiBold" /> }} />
+        </Typography>
+      </Flex>
+      <Flex marginTop={1} alignItems="center">
+        <CustomBullet />
+        <Typography
+          textColor="neutral600"
+          variant="omega"
+        >
+          <Trans i18nKey="plugin_settings.step_4" components={{ 1: <Typography variant="omega" fontWeight="semiBold" /> }} />
+        </Typography>
+      </Flex>
+      <Flex marginTop={1} alignItems="center">
+        <CustomBullet />
+        <Typography
+          textColor="neutral600"
+          variant="omega"
+        >
+          <Trans i18nKey="plugin_settings.step_5" components={{ 1: <Typography variant="omega" fontWeight="semiBold" /> }} />
+        </Typography>
+      </Flex>
+    </div >
+  );
+}
+
+export default ContentTransferSetupEmpty;

package/admin/src/modules/plugin-settings/components/Tree/index.js

@@ -1,4 +1,4 @@
-import React, { useState } from "react";
+import React, { useState, useEffect } from "react";
 import PropTypes from "prop-types";
 import { Box } from "@strapi/design-system/Box";
 import { Switch } from '@strapi/design-system/Switch';
@@ -13,6 +13,10 @@ function Tree(props) {
     props.onTreeItemClick(key, currentValue);
   };
 
+  useEffect(() => {
+    setIsExpanded(props.initiallyExpanded);
+  }, [props.initiallyExpanded]);
+
   const createTree = (name, branch, path = "") => {
     const isBranchObject = typeof branch === "object" && branch !== null;
 
@@ -115,6 +119,11 @@ function Tree(props) {
 Tree.propTypes = {
   objects: PropTypes.object.isRequired,
   onTreeItemClick: PropTypes.func.isRequired,
+  initiallyExpanded: PropTypes.bool,
+};
+
+Tree.defaultProps = {
+  initiallyExpanded: false,
 };
 
 export default Tree;

package/admin/src/modules/plugin-settings/locale/en.js

@@ -16,4 +16,11 @@ export default {
   only_text_based_content: "only text based content.",
   learn_more_in_docs_message_a: "If you want to learn more about how to setup your Content Transfer settings read the ",
   learn_more_in_docs_message_b: "Localazy documentation.",
+  there_is_nothing_to_transfer: "There is nothing to transfer.",
+  please_check_that_you_have_entered_a_valid_collection: "To finish the content transfer setup, you must enable localization for at least one Content-Type.",
+  step_1: "Go to the <1>Content-Type Builder</1>",
+  step_2: "Click on <1>Edit</1> and select the <1>Advanced Settings</1> tab",
+  step_3: "Check <1>Enable localization for this Content-Type</1>",
+  step_4: "Repeat for all Content-Types you want to translate",
+  step_5: "Return to this screen and finish the transfer setup",
 };

package/admin/src/modules/plugin-settings/services/plugin-settings-service.js

@@ -29,4 +29,27 @@ export default class PluginSettingsService {
       throw e;
     }
   }
+
+  static async getPluginSettings() {
+    try {
+      const result = await axiosInstance.get(`${BASE_PATH}/plugin-settings`);
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  static async updatePluginSettings(data) {
+    try {
+      const result = await axiosInstance.put(
+        `${BASE_PATH}/plugin-settings`,
+        data
+      );
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
 }

package/admin/src/pages/App/index.js

@@ -32,6 +32,7 @@ import {
   getLocalazyIdentity,
 } from "../../state/localazy-identity";
 import history from "../../modules/@common/utils/history";
+import PluginSettingsService from "../../modules/plugin-settings/services/plugin-settings-service";
 
 import "../../i18n";
 
@@ -89,7 +90,8 @@ function App() {
         if (!hasLocalazyIdentity()) {
           redirectToPluginRoute(PLUGIN_ROUTES.LOGIN);
         } else {
-          redirectToPluginRoute(PLUGIN_ROUTES.DOWNLOAD);
+          const lastRoute = (await PluginSettingsService.getPluginSettings()).defaultRoute || PLUGIN_ROUTES.UPLOAD;
+          redirectToPluginRoute(lastRoute);
         }
       }
     }

package/admin/src/pages/Download/index.js

@@ -18,6 +18,8 @@ import ReadDocsButton from "../../modules/localazy-upload/components/ReadDocsBut
 import "../../i18n";
 import { getLocalazyIdentity } from "../../state/localazy-identity";
 import ProductAnalyticsService from "../../modules/@common/services/product-analytics-service";
+import PluginSettingsService from "../../modules/plugin-settings/services/plugin-settings-service";
+import { PLUGIN_ROUTES } from "../../modules/@common/utils/redirect-to-plugin-route";
 
 function Download(props) {
   const { t } = useTranslation();
@@ -69,6 +71,8 @@ function Download(props) {
       setModelChanged(await hasModelChanged());
       setLocalesIncompatible(!(await areLocalesCompatible()));
 
+      PluginSettingsService.updatePluginSettings({ defaultRoute: PLUGIN_ROUTES.DOWNLOAD });
+
       setIsLoading(false);
     }
     initComponent();

package/admin/src/pages/Settings/index.js

@@ -18,6 +18,7 @@ import PrerequisitiesInfo from "../../modules/settings/components/Prerequisities
 import ProjectService from "../../modules/@common/services/project-service";
 import ProductAnalyticsService from "../../modules/@common/services/product-analytics-service";
 import formatNumber from "../../modules/@common/utils/format-number";
+import PluginSettingsService from "../../modules/plugin-settings/services/plugin-settings-service";
 
 import "../../i18n";
 
@@ -37,6 +38,9 @@ function Settings(props) {
       setIsLoading(true);
       const project = await ProjectService.getConnectedProject();
       setConnectedProject(project);
+
+      PluginSettingsService.updatePluginSettings({ defaultRoute: PLUGIN_ROUTES.SETTINGS });
+
       setIsLoading(false);
     }
 

package/admin/src/pages/Upload/index.js

@@ -23,6 +23,7 @@ import redirectToPluginRoute, {
 } from "../../modules/@common/utils/redirect-to-plugin-route";
 import { getLocalazyIdentity } from "../../state/localazy-identity";
 import ProductAnalyticsService from "../../modules/@common/services/product-analytics-service";
+import PluginSettingsService from "../../modules/plugin-settings/services/plugin-settings-service";
 
 import "../../i18n";
 
@@ -79,6 +80,8 @@ function Upload(props) {
       setModelChanged(await hasModelChanged());
       setLocalesIncompatible(!(await areLocalesCompatible(strapiDefaultLocale, localazySourceLanguage)));
 
+      PluginSettingsService.updatePluginSettings({ defaultRoute: PLUGIN_ROUTES.UPLOAD });
+
       setIsLoading(false);
     }
     initComponent();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localazy/strapi-plugin",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "The official Strapi Plugin by Localazy.",
   "strapi": {
     "name": "localazy",

package/server/controllers/plugin-settings-controller.js

@@ -14,4 +14,18 @@ module.exports = {
       .service("pluginSettingsService")
       .updateContentTransferSetup(ctx.request.body);
   },
+
+  async getPluginSettings(ctx) {
+    ctx.body = await strapi
+      .plugin("localazy")
+      .service("pluginSettingsService")
+      .getPluginSettings();
+  },
+
+  async updatePluginSettings(ctx) {
+    ctx.body = await strapi
+      .plugin("localazy")
+      .service("pluginSettingsService")
+      .updatePluginSettings(ctx.request.body);
+  }
 };

package/server/db/model/plugin-settings.js

@@ -0,0 +1,13 @@
+"use strict";
+
+const KEY = "plugin-settings";
+
+
+const emptyPluginSettings = {
+  defaultRoute: null,
+};
+
+module.exports = {
+  KEY,
+  emptyPluginSettings,
+};

package/server/routes/plugin-settings.js

@@ -19,4 +19,20 @@ module.exports = [
       policies: [],
     },
   },
+  {
+    method: "GET",
+    path: `${ROUTE_PREFIX}/plugin-settings`,
+    handler: "pluginSettingsController.getPluginSettings",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PUT",
+    path: `${ROUTE_PREFIX}/plugin-settings`,
+    handler: "pluginSettingsController.updatePluginSettings",
+    config: {
+      policies: [],
+    },
+  }
 ];

package/server/services/plugin-settings-service.js

@@ -1,17 +1,20 @@
 "use strict";
 
-const {
-  KEY,
-  emptyContentTransferSetup,
-} = require("../db/model/content-transfer-setup");
+const contentTransferSetupModel = require("../db/model/content-transfer-setup");
+
+const pluginSettingsModel = require("../db/model/plugin-settings");
+// {
+//   KEY,
+//   emptyPluginSettings,
+// } = require("../db/model/plugin-settings");
 const getStrapiStore = require("../db/model/utils/get-strapi-store");
 
 module.exports = ({ strapi }) => ({
   async getContentTransferSetup() {
     const pluginStore = getStrapiStore(strapi);
-    const setup = await pluginStore.get({ key: KEY });
+    const setup = await pluginStore.get({ key: contentTransferSetupModel.KEY });
 
-    return setup || emptyContentTransferSetup;
+    return setup || contentTransferSetupModel.emptyContentTransferSetup;
   },
 
   async updateContentTransferSetup(setup) {
@@ -21,10 +24,28 @@ module.exports = ({ strapi }) => ({
     };
     const pluginStore = getStrapiStore(strapi);
     await pluginStore.set({
-      key: KEY,
+      key: contentTransferSetupModel.KEY,
       value: newSetup,
     });
 
     return newSetup;
   },
+
+  async getPluginSettings() {
+    const pluginStore = getStrapiStore(strapi);
+    const settings = await pluginStore.get({ key: pluginSettingsModel.KEY });
+
+    return settings || pluginSettingsModel.emptyPluginSettings;
+  },
+
+  async updatePluginSettings(settings) {
+    const newSettings = settings;
+    const pluginStore = getStrapiStore(strapi);
+    await pluginStore.set({
+      key: pluginSettingsModel.KEY,
+      value: newSettings,
+    });
+
+    return newSettings;
+  },
 });