@localazy/strapi-plugin 0.1.7 → 0.1.10

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/.nvmrc

@@ -1 +1 @@
-14
+16

package/admin/src/modules/@common/components/PluginPageLoader/index.js

@@ -0,0 +1,22 @@
+import React from "react";
+import { Flex } from '@strapi/design-system/Flex';
+import { Loader } from "@strapi/design-system/Loader";
+import { useTranslation } from "react-i18next";
+
+import "../../../../i18n";
+
+function PluginPageLoader() {
+  const { t } = useTranslation();
+
+  return (
+    <Flex
+      marginTop={10}
+      alignItems="center"
+      justifyContent="center"
+    >
+      <Loader>{t("common.loading_content")}</Loader>
+    </Flex>
+  )
+}
+
+export default PluginPageLoader;

package/admin/src/modules/@common/services/product-analytics-service.js

@@ -0,0 +1,67 @@
+import AnalyticsService from "../../../plugins/analytics-service";
+
+export default class ProductAnalyticsService {
+  static async trackAppConnected(userId, project, params = {}) {
+    try {
+      const data = this.buildData(userId, "Strapi Connected", project, params);
+      await AnalyticsService.trackEvent(data.event, {
+        ...data.data,
+        userId,
+        category: "Project",
+      });
+    } catch (e) {
+      console.warn(e);
+    }
+  }
+
+  static async trackAppDisconnected(userId, project, params = {}) {
+    try {
+      const data = this.buildData(userId, "Strapi Disconnected", project, params);
+      await AnalyticsService.trackEvent(data.event, {
+        ...data.data,
+        userId,
+        category: "Project",
+      });
+    } catch (e) {
+      console.warn(e);
+    }
+  }
+
+  static async trackUploadToLocalazy(userId, project, params = {}) {
+    try {
+      const data = this.buildData(userId, "Strapi Upload", project, params);
+      await AnalyticsService.trackEvent(data.event, {
+        ...data.data,
+        userId,
+        category: "Project",
+      });
+    } catch (e) {
+      console.warn(e);
+    }
+  }
+
+  static async trackDownloadToStrapi(userId, project, params = {}) {
+    try {
+      const data = this.buildData(userId, "Strapi Download", project, params);
+      await AnalyticsService.trackEvent(data.event, {
+        ...data.data,
+        userId,
+        category: "Project",
+      });
+    } catch (e) {
+      console.warn(e);
+    }
+  }
+
+  static buildData(userId, event, project, params) {
+    return {
+      event,
+      data: {
+        "User Id": userId,
+        "Project Id": project.id,
+        "Project Name": project.name,
+        ...params,
+      },
+    };
+  }
+}

package/admin/src/modules/@common/utils/format-number.js

@@ -0,0 +1 @@
+export default (value, options = undefined) => new Intl.NumberFormat("en-GB", options).format(value);

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

@@ -12,8 +12,8 @@ import { ThemeProvider } from "@strapi/design-system/ThemeProvider";
 import { lightTheme } from "@strapi/design-system/themes";
 import { Box } from "@strapi/design-system/Box";
 import { Layout } from "@strapi/design-system/Layout";
-import { Loader } from "@strapi/design-system/Loader";
 import { useTranslation } from "react-i18next";
+import Loader from "../../modules/@common/components/PluginPageLoader";
 import pluginId from "../../pluginId";
 import Download from "../Download";
 import Settings from "../Settings";
@@ -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

@@ -5,11 +5,11 @@ import { Button } from "@strapi/design-system/Button";
 import DownloadIcon from "@strapi/icons/Download";
 import { Box } from "@strapi/design-system/Box";
 import { Alert } from "@strapi/design-system/Alert";
-import { Loader } from "@strapi/design-system/Loader";
 import { useTranslation } from "react-i18next";
 import { Flex } from '@strapi/design-system/Flex';
 import { Divider } from '@strapi/design-system/Divider';
 import { Typography } from "@strapi/design-system/Typography";
+import Loader from "../../modules/@common/components/PluginPageLoader";
 import LocalazyDownloadService from "../../modules/localazy-download/services/localazy-download-service";
 import areLocalesCompatible from "../../modules/@common/utils/are-locales-compatible";
 import hasModelChanged from "../../modules/plugin-settings/functions/has-model-changed";
@@ -17,6 +17,9 @@ import TransferReport from "../../modules/@common/components/TransferReport";
 import ReadDocsButton from "../../modules/localazy-upload/components/ReadDocsButton";
 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();
@@ -44,6 +47,16 @@ function Download(props) {
     setIsDownloading(true);
     const result = await LocalazyDownloadService.download();
     setDownloadResult(result);
+
+    // track download
+    ProductAnalyticsService.trackDownloadToStrapi(
+      localazyIdentity.user.id,
+      localazyIdentity.project,
+      {
+        "Target Languages Codes": "all",
+      }
+    );
+
     setIsDownloading(false);
     setshowDownloadFinishedModal(true);
   };
@@ -58,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/Login/index.js

@@ -6,19 +6,20 @@
 
 import React from "react";
 import PropTypes from "prop-types";
-import { Loader } from "@strapi/design-system/Loader";
 import { Link } from "@strapi/design-system/Link";
 import { useHistory } from "react-router-dom";
 import { useTranslation } from "react-i18next";
 import { HeaderLayout } from "@strapi/design-system/Layout";
 import { Box } from "@strapi/design-system/Box";
 import { Typography } from "@strapi/design-system/Typography";
+import Loader from "../../modules/@common/components/PluginPageLoader";
 import { setLocalazyIdentity } from "../../state/localazy-identity";
 import LocalazyUserService from "../../modules/user/services/localazy-user-service";
 import LoginButton from "../../modules/login/components/LoginButton";
 import redirectToPluginRoute, {
   PLUGIN_ROUTES,
 } from "../../modules/@common/utils/redirect-to-plugin-route";
+import ProductAnalyticsService from "../../modules/@common/services/product-analytics-service";
 
 import "../../i18n";
 
@@ -40,6 +41,12 @@ function Login(props) {
     setLocalazyIdentity(result);
 
     if (result.accessToken) {
+      // track user login
+      ProductAnalyticsService.trackAppConnected(
+        result.user.id,
+        result.project,
+      );
+
       redirectToPluginRoute(PLUGIN_ROUTES.DOWNLOAD, history);
     }
   };

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

@@ -1,12 +1,12 @@
 import React, { useEffect, useState } from "react";
 import PropTypes from "prop-types";
-import { Loader } from "@strapi/design-system/Loader";
 import { HeaderLayout } from "@strapi/design-system/Layout";
 import { Box } from "@strapi/design-system/Box";
 import { useHistory } from "react-router-dom";
 import { useTranslation } from "react-i18next";
 import { Grid } from '@strapi/design-system/Grid';
 import { Divider } from '@strapi/design-system/Divider';
+import Loader from "../../modules/@common/components/PluginPageLoader";
 import LogoutButton from "../../modules/login/components/LogoutButton";
 import redirectToPluginRoute, {
   PLUGIN_ROUTES,
@@ -16,6 +16,9 @@ import OverviewItem from "../../modules/settings/components/OverviewItem";
 import OverviewItemLink from "../../modules/settings/components/OverviewItemLink";
 import PrerequisitiesInfo from "../../modules/settings/components/PrerequisitiesInfo";
 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";
 
@@ -35,6 +38,9 @@ function Settings(props) {
       setIsLoading(true);
       const project = await ProjectService.getConnectedProject();
       setConnectedProject(project);
+
+      PluginSettingsService.updatePluginSettings({ defaultRoute: PLUGIN_ROUTES.SETTINGS });
+
       setIsLoading(false);
     }
 
@@ -45,6 +51,12 @@ function Settings(props) {
    * On logout action
    */
   const onLoggedOut = () => {
+    // track user logout
+    ProductAnalyticsService.trackAppDisconnected(
+      localazyIdentity.user.id,
+      localazyIdentity.project,
+    );
+
     redirectToPluginRoute(PLUGIN_ROUTES.LOGIN, history);
   };
 
@@ -56,7 +68,9 @@ function Settings(props) {
         primaryAction={<LogoutButton onResultFetched={onLoggedOut} />}
         as="h2"
       />
-      {(props.isLoading || isLoading) && (<Loader>{t("common.loading_content")}</Loader>)}
+      {(props.isLoading || isLoading) && (
+        <Loader>{t("common.loading_content")}</Loader>
+      )}
       {!(props.isLoading || isLoading) && (
         <Box paddingRight={10} paddingLeft={10}>
           <Box
@@ -86,7 +100,7 @@ function Settings(props) {
               <OverviewItem
                 label={t("settings.remaining_organization_keys")}
                 value={
-                  connectedProject.organization.availableKeys - connectedProject.organization.usedKeys
+                  formatNumber(connectedProject.organization.availableKeys - connectedProject.organization.usedKeys)
                 }
               />
               <OverviewItemLink

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

@@ -9,7 +9,7 @@ import { Button } from "@strapi/design-system/Button";
 import UploadIcon from "@strapi/icons/Upload";
 import { Box } from "@strapi/design-system/Box";
 import { Alert } from "@strapi/design-system/Alert";
-import { Loader } from "@strapi/design-system/Loader";
+import Loader from "../../modules/@common/components/PluginPageLoader";
 import LocalazyUploadService from "../../modules/localazy-upload/services/localazy-upload-service";
 import areLocalesCompatible from "../../modules/@common/utils/are-locales-compatible";
 import { getStrapiDefaultLocale, getLocalazySourceLanguage } from "../../modules/@common/utils/get-default-locale";
@@ -21,6 +21,9 @@ import ReadDocsButton from "../../modules/localazy-upload/components/ReadDocsBut
 import redirectToPluginRoute, {
   PLUGIN_ROUTES,
 } 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";
 
@@ -38,6 +41,7 @@ function Upload(props) {
   const [isUploading, setIsUploading] = useState(false);
   const [strapiDefaultLocale, setStrapiDefaultLocale] = useState(null);
   const [localazySourceLanguage, setLocalazySourceLanguage] = useState(null);
+  const [localazyIdentity] = getLocalazyIdentity();
 
   const onChangeSettingsClick = () => {
     redirectToPluginRoute(PLUGIN_ROUTES.CONTENT_TRANSFER_SETUP);
@@ -49,6 +53,16 @@ function Upload(props) {
     setIsUploading(true);
     const result = await LocalazyUploadService.upload();
     setUploadResult(result);
+
+    // track upload
+    ProductAnalyticsService.trackUploadToLocalazy(
+      localazyIdentity.user.id,
+      localazyIdentity.project,
+      {
+        "Source Language Code": localazySourceLanguage.code,
+      }
+    );
+
     setIsUploading(false);
     setShowUploadFinishedModal(true);
   };
@@ -66,6 +80,8 @@ function Upload(props) {
       setModelChanged(await hasModelChanged());
       setLocalesIncompatible(!(await areLocalesCompatible(strapiDefaultLocale, localazySourceLanguage)));
 
+      PluginSettingsService.updatePluginSettings({ defaultRoute: PLUGIN_ROUTES.UPLOAD });
+
       setIsLoading(false);
     }
     initComponent();

package/admin/src/plugins/analytics-service.js

@@ -0,0 +1,14 @@
+import createPluginConnectorAxiosInstance from "../utils/createPluginConnectorAxiosInstance";
+
+const ANALYTICS_PATH = "/analytics";
+const axiosInstance = createPluginConnectorAxiosInstance();
+export default class AnalyticsService {
+  static async trackEvent(event, data) {
+    const result = await axiosInstance.post(`${ANALYTICS_PATH}/track`, {
+      event,
+      ...data,
+    });
+
+    return result.data;
+  }
+}

package/admin/src/utils/createPluginConnectorAxiosInstance.js

@@ -0,0 +1,45 @@
+/**
+ * axios with plugin connector config.
+ */
+
+import axios from "axios";
+import { config } from "../../../server";
+
+const BASE_PLUGIN_PATH = config.default.LOCALAZY_PLUGIN_CONNECTOR_API_URL;
+
+const createPluginConnectorAxiosInstance = (baseUrl = null) => {
+  if (baseUrl === null) {
+    baseUrl = `${BASE_PLUGIN_PATH}`;
+  }
+
+  const instance = axios.create({
+    baseURL: baseUrl,
+  });
+
+  instance.interceptors.request.use(
+    async (config) => {
+      config.headers = {
+        Accept: "application/json",
+        "Content-Type": "application/json",
+        // Strapi plugin id in terms of plugin connector
+        "X-Localazy-Plugin-Id": 1,
+      };
+
+      return config;
+    },
+    (error) => {
+      Promise.reject(error);
+    }
+  );
+
+  instance.interceptors.response.use(
+    (response) => response,
+    (error) => {
+      throw error;
+    }
+  );
+
+  return instance;
+};
+
+export default createPluginConnectorAxiosInstance;