@localazy/strapi-plugin 0.1.7 → 0.1.8

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/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";

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,7 @@ 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";
 
 function Download(props) {
   const { t } = useTranslation();
@@ -44,6 +45,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);
   };

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,8 @@ 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 "../../i18n";
 
@@ -45,6 +47,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 +64,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 +96,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,8 @@ 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 "../../i18n";
 
@@ -38,6 +40,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 +52,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);
   };

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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localazy/strapi-plugin",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "The official Strapi Plugin by Localazy.",
   "strapi": {
     "name": "localazy",
@@ -28,8 +28,6 @@
   },
   "dependencies": {
     "@localazy/ts-api": "^1.0.6",
-    "@strapi/design-system": "^1.0.0",
-    "@strapi/icons": "^1.0.0",
     "deep-keys": "^0.5.0",
     "i18next": "^21.6.13",
     "isomorphic-fetch": "^3.0.0",
@@ -41,7 +39,9 @@
     "styled-components": "^5.3.3"
   },
   "peerDependencies": {
-    "@strapi/strapi": "^4.0.0"
+    "@strapi/strapi": "^4.0.0",
+    "@strapi/design-system": "^1.0.0",
+    "@strapi/icons": "^1.0.0"
   },
   "devDependencies": {
     "@babel/plugin-transform-modules-commonjs": "^7.17.7",

package/server/config/index.js

@@ -1,15 +1,20 @@
 "use strict";
 
 // depending on the STRAPI_ADMIN_LOCALAZY_ENV, use the correct config
-const config =
-  process.env.STRAPI_ADMIN_LOCALAZY_ENV === "development"
-    ? require("./development/index")
-    : require("./production/index");
+let config = require("./production/index");
+
+if (process.env.STRAPI_ADMIN_LOCALAZY_ENV === "local") {
+  config = require("./local/index");
+}
+
+if (process.env.STRAPI_ADMIN_LOCALAZY_ENV === "development") {
+  config = require("./development/index");
+}
 
 module.exports = {
   default: {
     // Default plugin configuration, merged with the user configuration
     ...(config || {}),
   },
-  validator() {},
+  validator() { },
 };

package/server/config/local/index.js

@@ -0,0 +1,15 @@
+"use strict";
+
+module.exports = {
+  LOCALAZY_OAUTH_URL: "https://testing.localazy.com/oauth/authorize",
+  LOCALAZY_OAUTH_APP_CLIENT_ID: "18503917571895066465",
+  LOCALAZY_PLUGIN_CONNECTOR_API_URL: "http://localhost:3000",
+  LOCALAZY_PUBLIC_API_URL: "https://testing.localazy.com/pubapi",
+  LOCALAZY_PLUGIN_ID: "1",
+  LOCALAZY_DEFAULT_FILE_NAME: "strapi.json",
+  LOCALAZY_DEFAULT_FILE_PATH: "",
+  LOCALAZY_DEFAULT_FILE_EXTENSION: "json",
+  LOCALAZY_DEFAULT_LOCALE: "en",
+  LOCALAZY_API_USER_JWT_COOKIE_NAME: "LOCALAZY-API-USER-JWT",
+  LOCALAZY_API_USER_COOKIE_EXPIRATION: 7,
+};