@localazy/strapi-plugin 0.1.0

package/.babelrc

@@ -0,0 +1,7 @@
+{
+  "env": {
+    "test": {
+      "plugins": ["@babel/plugin-transform-modules-commonjs"]
+    }
+  }
+}

package/.eslintrc

@@ -0,0 +1,7 @@
+{
+  // "extends": "@strapi-community",
+  "env": {
+    "jest/globals": true
+  },
+  "plugins": ["jest"]
+}

package/.github/workflows/.build.yml

@@ -0,0 +1,39 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  execute:
+    runs-on: [self-hosted, Linux, aws]
+    env:
+      INPUT_TOKEN: ""
+    steps:
+      - name: Set work folder permissions
+        run: pwd && sudo chown -R $USER:$USER ./
+      - uses: actions/checkout@v2
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v1.4.4
+        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 }}-
+      - name: Install dependencies
+        run: npm ci
+      - name: Run linter
+        run: npm run lint
+      - name: Run unit tests
+        run: npm run test
+      - name: Build project
+        run: npm run build
+      - name: Publish to npm
+        uses: JS-DevTools/npm-publish@v1
+        if: github.ref == 'refs/heads/master'
+        with:
+          token: ${{ secrets.NPM_AUTH_TOKEN }}

package/.nvmrc

@@ -0,0 +1 @@
+14

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Localazy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,40 @@
+# The Official Strapi Plugin by Localazy
+
+### The Official Strapi Plugin by Localazy
+
+Manage your multilingual content with ease. Upload your content in default language to Localazy. Let us translate your content for you, use machine translation or let your translators do it for you. Download translated content back to Strapi and feel the seamless experience of multilingual content.
+
+### General information
+
+This repository contains all the code needed to run the Official Strapi Plugin by Localazy.
+
+### Use plugin in a clean project locally
+
+Besides installing the plugin via `npm`, you can also use it in a project locally. Assuming you have a (clean) Strapi project set up, do:
+
+1. Copy the whole contents.
+2. Paste it into `./src/plugin/localazy` folder of your project (path from project root).
+3. Create `./config/plugins.js` file (path from project root).
+4. Add the following contents to `./config/plugins.js` file:
+
+```
+module.exports = {
+  localazy: {
+    enabled: true,
+    resolve: "./src/plugins/localazy",
+    config: {
+      default: () => ({}),the user configuration is valid
+      validator: () => {},
+    },
+  },
+};
+
+```
+
+5. Run the project. Plugin will be available in the admin.
+
+### Tests
+
+To run tests, run `npm run test` command. To watch tests, run `npm run test:watch` command.
+
+In case you have an access, you might also want to check the README file located in development project root for more information on tests debugging.

package/admin/src/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "@strapi-community/admin"
+}

package/admin/src/components/Initializer/index.js

@@ -0,0 +1,26 @@
+/**
+ *
+ * Initializer
+ *
+ */
+
+import { useEffect, useRef } from "react";
+import PropTypes from "prop-types";
+import pluginId from "../../pluginId";
+
+function Initializer({ setPlugin }) {
+  const ref = useRef();
+  ref.current = setPlugin;
+
+  useEffect(() => {
+    ref.current(pluginId);
+  }, []);
+
+  return null;
+}
+
+Initializer.propTypes = {
+  setPlugin: PropTypes.func.isRequired,
+};
+
+export default Initializer;

package/admin/src/components/PluginIcon/index.js

@@ -0,0 +1,14 @@
+/**
+ *
+ * PluginIcon
+ *
+ */
+
+import React from "react";
+import Localazy from "../../modules/@common/components/Icons/Localazy";
+
+function PluginIcon() {
+  return <Localazy />;
+}
+
+export default PluginIcon;

package/admin/src/i18n.js

@@ -0,0 +1,37 @@
+import i18n from "i18next";
+import { initReactI18next } from "react-i18next";
+
+import en_common from "./modules/@common/locale/en";
+import en_login from "./modules/login/locale/en";
+import en_settings from "./modules/settings/locale/en";
+import en_download from "./modules/localazy-download/locale/en";
+import en_upload from "./modules/localazy-upload/locale/en";
+import en_plugin_settings from "./modules/plugin-settings/locale/en";
+
+i18n
+  // detect user language
+  // pass the i18n instance to react-i18next.
+  .use(initReactI18next)
+  // init i18next
+  // for all options read: https://www.i18next.com/overview/configuration-options
+  .init({
+    debug: process.env.STRAPI_ADMIN_LOCALAZY_ENV === "development",
+    fallbackLng: "en",
+    interpolation: {
+      escapeValue: false, // not needed for react as it escapes by default
+    },
+    resources: {
+      en: {
+        translation: {
+          common: en_common,
+          login: en_login,
+          settings: en_settings,
+          download: en_download,
+          upload: en_upload,
+          plugin_settings: en_plugin_settings,
+        },
+      },
+    },
+  });
+
+export default i18n;

package/admin/src/index.js

@@ -0,0 +1,106 @@
+import { prefixPluginTranslations } from "@strapi/helper-plugin";
+import pluginPkg from "../../package.json";
+import pluginId from "./pluginId";
+import Initializer from "./components/Initializer";
+import PluginIcon from "./components/PluginIcon";
+
+const name = pluginPkg.strapi.name;
+const SETTINGS_SETUP = [
+  {
+    sectionId: `${pluginId}-settings`,
+    intlId: `localazy_settings`,
+    sectionDefaultLabel: "Localazy Settings",
+    links: [
+      {
+        linkId: `${pluginId}-settings-content-transfer-setup`,
+        intlId: `content_transfer_setup`,
+        defaultLabel: "Content Transfer Setup",
+        to: `/settings/${pluginId}/content-transfer-setup`,
+        Component: async () => {
+          const component = await import("./pages/PluginSettings");
+
+          return component;
+        },
+        permissions: [
+          // TODO: only allow access to this page if the user has the right permissions
+        ],
+      },
+    ],
+  },
+];
+
+export default {
+  register(app) {
+    app.addMenuLink({
+      to: `/plugins/${pluginId}`,
+      icon: PluginIcon,
+      intlLabel: {
+        id: `${pluginId}.plugin.name`,
+        defaultMessage: name,
+      },
+      Component: async () => {
+        const component = await import("./pages/Index");
+
+        return component;
+      },
+      permissions: [
+        // Uncomment to set the permissions of the plugin here
+        // {
+        //   action: '', // the action name should be plugin::plugin-name.actionType
+        //   subject: null,
+        // },
+      ],
+    });
+    app.createSettingSection(
+      {
+        id: SETTINGS_SETUP[0].sectionId,
+        intlLabel: {
+          id: SETTINGS_SETUP[0].intlId,
+          defaultMessage: SETTINGS_SETUP[0].sectionDefaultLabel,
+        },
+      },
+      [
+        // links
+        {
+          id: SETTINGS_SETUP[0].links[0].linkId,
+          intlLabel: {
+            id: SETTINGS_SETUP[0].links[0].intlId,
+            defaultMessage: SETTINGS_SETUP[0].links[0].defaultLabel,
+          },
+          to: SETTINGS_SETUP[0].links[0].to,
+          Component: SETTINGS_SETUP[0].links[0].Component,
+          permissions: SETTINGS_SETUP[0].links[0].permissions,
+        },
+      ]
+    );
+    app.registerPlugin({
+      id: pluginId,
+      initializer: Initializer,
+      isReady: false,
+      name,
+    });
+  },
+
+  bootstrap() { },
+  async registerTrads({ locales }) {
+    const importedTrads = await Promise.all(
+      locales.map((locale) => {
+        return import(`./translations/${locale}.json`)
+          .then(({ default: data }) => {
+            return {
+              data: prefixPluginTranslations(data, pluginId),
+              locale,
+            };
+          })
+          .catch(() => {
+            return {
+              data: {},
+              locale,
+            };
+          });
+      })
+    );
+
+    return Promise.resolve(importedTrads);
+  },
+};

package/admin/src/modules/@common/components/Icons/Localazy/index.js

@@ -0,0 +1,12 @@
+import React from "react";
+
+function Localazy() {
+  return (
+    <svg width="24" height="24" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
+      <path d="M16.4517 2.56643L16.3247 2.87501L15.5632 4.67576H7.49071C7.18595 4.67576 6.98278 4.98434 7.1013 5.26333L9.05259 9.91314C9.12031 10.0695 9.27269 10.171 9.442 10.171H12.6211C12.9216 10.171 13.1247 10.4753 13.0147 10.7501L12.8919 11.046L12.1353 12.8468H10.9192C10.6187 12.8468 10.4113 13.1553 10.5298 13.4343L13.8229 21.2925C13.9626 21.6265 13.7171 21.9942 13.353 21.9942H11.3256C11.1224 21.9942 10.9362 21.8716 10.8557 21.6814L3.1056 3.17091C2.8728 2.61293 3.27915 2 3.88443 2H16.0538C16.3501 2 16.5533 2.29167 16.4517 2.56643Z" />
+      <path d="M17.2937 13.5315L21.0354 4.63345C21.2724 4.07548 20.8619 3.45832 20.2566 3.46255L17.2267 3.46255L16.4794 5.23793C16.4794 5.24638 16.4752 5.25484 16.4709 5.26329L16.4709 5.26329L16.3482 5.55074C16.2297 5.82973 16.4371 6.1383 16.7376 6.1383H16.8069C17.1074 6.1383 17.3148 6.44688 17.1963 6.72587L15.2408 11.3757C15.1773 11.5321 15.0207 11.6335 14.8514 11.6335H13.7902L12.9112 13.7217C12.7927 14.0007 13.0001 14.3093 13.3006 14.3093H16.1212C16.6334 14.3093 17.0947 14.0007 17.2937 13.5315Z" />
+    </svg>
+  );
+}
+
+export default Localazy;

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

@@ -0,0 +1,46 @@
+/*
+ *
+ * SideNav
+ *
+ */
+
+import React from "react";
+import {
+  SubNav,
+  SubNavHeader,
+  SubNavSection,
+  SubNavSections,
+  SubNavLink,
+} from "@strapi/design-system/SubNav";
+import { useTranslation } from "react-i18next";
+import { NavLink } from "react-router-dom";
+import getNav from "../../utils/get-nav";
+
+function SideNav() {
+  const { t } = useTranslation();
+
+  const navigation = getNav();
+
+  return (
+    <SubNav ariaLabel={t("common.localazy_plugin")}>
+      <SubNavHeader label={t("common.localazy_plugin")} />
+      <SubNavSections>
+        <SubNavSection label={t("common.navigation")}>
+          {navigation.map((navItem) => (
+            <SubNavLink
+              as={NavLink}
+              to={navItem.to}
+              active={navItem.active}
+              icon={navItem.icon || ""}
+              key={navItem.id}
+            >
+              {navItem.label}
+            </SubNavLink>
+          ))}
+        </SubNavSection>
+      </SubNavSections>
+    </SubNav>
+  );
+}
+
+export default SideNav;

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

@@ -0,0 +1,54 @@
+import React, { useState, useEffect } from "react";
+import PropTypes from "prop-types";
+import { Alert } from "@strapi/design-system/Alert";
+import { useTranslation } from "react-i18next";
+import { Box } from "@strapi/design-system/Box";
+import "../../../../i18n";
+
+function TransferReport(props) {
+  const { t } = useTranslation();
+
+  const [reportLocal, setReportLocal] = useState(props.report);
+
+  const onCloseItem = (index) => {
+    const newReportLocal = reportLocal;
+    newReportLocal.splice(index, 1);
+
+    setReportLocal([...newReportLocal]);
+  };
+
+  useEffect(() => {
+    setReportLocal(props.report);
+  }, [props.report]);
+
+  if (!reportLocal) {
+    return null;
+  }
+
+  return (
+    reportLocal.map((item, index) => {
+      return (
+        <Box
+          // eslint-disable-next-line react/no-array-index-key
+          key={item}
+          marginTop={4}
+          marginBottom={4}
+        >
+          <Alert
+            key={item}
+            onClose={() => onCloseItem(index)}
+            closeLabel={t("upload.close")}
+            variant="default"
+          >
+            {item}
+          </Alert>
+        </Box>)
+    })
+  );
+}
+
+TransferReport.propTypes = {
+  report: PropTypes.array.isRequired,
+};
+
+export default TransferReport;

package/admin/src/modules/@common/locale/en.js

@@ -0,0 +1,13 @@
+export default {
+  localazy_plugin: "Localazy",
+  localazy_plugin_hand: "Localazy 👋",
+  localazy_plugin_description: "An official Strapi plugin by Localazy.",
+  navigation: "Navigation",
+  upload_to_localazy: "Upload to Localazy",
+  download_to_strapi: "Download to Strapi",
+  settings: "Overview",
+  loading_content: "Loading content...",
+  report_will_be_available_after_an_action:
+    "Report will be available after performing an action...",
+  report: "Report",
+};

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

@@ -0,0 +1,15 @@
+/* eslint-disable no-useless-catch */
+import createAxiosInstance from "../../../utils/createAxiosInstance";
+
+const axiosInstance = createAxiosInstance("/i18n");
+export default class I18nService {
+  static async getLocales() {
+    try {
+      const result = await axiosInstance.get(`/locales`);
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
+}

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

@@ -0,0 +1,15 @@
+/* eslint-disable no-useless-catch */
+import createAxiosInstance from "../../../utils/createAxiosInstance";
+
+const axiosInstance = createAxiosInstance();
+export default class ProjectService {
+  static async getConnectedProject() {
+    try {
+      const result = await axiosInstance.get(`/project`);
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
+}

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

@@ -0,0 +1,38 @@
+/* eslint-disable no-useless-catch */
+import createAxiosInstance from "../../../utils/createAxiosInstance";
+
+const BASE_PATH = "/user";
+const axiosInstance = createAxiosInstance();
+export default class UserService {
+  static async generateKeys() {
+    try {
+      const result = await axiosInstance.get(`${BASE_PATH}/token`);
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  static async continuousPoll(token) {
+    try {
+      const result = await axiosInstance.post(`${BASE_PATH}/token`, {
+        token,
+      });
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
+
+  static async deleteToken() {
+    try {
+      const result = await axiosInstance.delete(`${BASE_PATH}/token`);
+
+      return result.data;
+    } catch (e) {
+      throw e;
+    }
+  }
+}

package/admin/src/modules/@common/utils/are-locales-compatible.js

@@ -0,0 +1,42 @@
+import I18nService from "../services/i18n-service";
+import ProjectService from "../services/project-service";
+import { isoLocalazyToStrapi } from "./iso-locales-utils";
+
+export default async (defaultLocale = null, sourceLanguage = null) => {
+  try {
+    if (!defaultLocale) {
+      const locales = await I18nService.getLocales();
+      defaultLocale = locales.find((locale) => !!locale.isDefault);
+    }
+
+    if (!defaultLocale) {
+      return false;
+    }
+
+    if (!sourceLanguage) {
+      const connectedProject = await ProjectService.getConnectedProject();
+
+      if (!connectedProject) {
+        return false;
+      }
+
+      const sourceLanguageId = connectedProject.sourceLanguage;
+      sourceLanguage = connectedProject.languages.find(
+        (language) => language.id === sourceLanguageId
+      );
+    }
+
+    if (!sourceLanguage) {
+      return false;
+    }
+
+    const defaultLocaleCode = defaultLocale.code;
+    const sourceLanguageStrapiCode = isoLocalazyToStrapi(sourceLanguage.code);
+
+    return defaultLocaleCode === sourceLanguageStrapiCode;
+  } catch (e) {
+    console.error(e.message);
+
+    return false;
+  }
+};

package/admin/src/modules/@common/utils/functions/flatten-deep.js

@@ -0,0 +1,23 @@
+import each from "lodash-es/each";
+import isObject from "lodash-es/isObject";
+import isArray from "lodash-es/isArray";
+
+export default function flattenObject(obj, delimiter) {
+  const delim = delimiter || '.';
+  const nobj = {};
+
+  each(obj, (val, key) => {
+    // ensure is JSON key-value map, not array
+    if (isObject(val) && !isArray(val)) {
+      // union the returned result by concat all keys
+      const strip = flattenObject(val, delim);
+      each(strip, (v, k) => {
+        nobj[key + delim + k] = v;
+      })
+    } else {
+      nobj[key] = val;
+    }
+  });
+
+  return nobj;
+}

package/admin/src/modules/@common/utils/get-default-locale.js

@@ -0,0 +1,32 @@
+import I18nService from "../services/i18n-service";
+import ProjectService from "../services/project-service";
+
+export async function getStrapiDefaultLocale() {
+  const locales = await I18nService.getLocales();
+  const defaultLocale = locales.find((locale) => !!locale.isDefault);
+
+  if (!defaultLocale) {
+    return null;
+  }
+
+  return defaultLocale;
+}
+
+export async function getLocalazySourceLanguage() {
+  const connectedProject = await ProjectService.getConnectedProject();
+
+  if (!connectedProject) {
+    return null;
+  }
+
+  const sourceLanguageId = connectedProject.sourceLanguage;
+  const sourceLanguage = connectedProject.languages.find(
+    (language) => language.id === sourceLanguageId
+  );
+
+  if (!sourceLanguage) {
+    return null;
+  }
+
+  return sourceLanguage;
+}

package/admin/src/modules/@common/utils/get-header-subtitle.js

@@ -0,0 +1,21 @@
+import { useLocation } from "react-router-dom";
+import getNav from "./get-nav";
+import pluginId from "../../../pluginId";
+
+export default (location = null) => {
+  if (!location) {
+    location = useLocation();
+  }
+  // segment after pluginId
+  const pluginSegment = location.pathname.split(`/${pluginId}/`)[1];
+
+  if (!pluginSegment) {
+    return "";
+  }
+  const navigation = getNav();
+  const currentNavItem = navigation.find((navItem) =>
+    pluginSegment.includes(navItem.id)
+  );
+
+  return currentNavItem?.description || "";
+};

package/admin/src/modules/@common/utils/get-header-title.js

@@ -0,0 +1,24 @@
+import { useLocation } from "react-router-dom";
+import getNav from "./get-nav";
+import pluginId from "../../../pluginId";
+import i18n from "../../../i18n";
+
+const t = i18n.t;
+
+export default (location = null) => {
+  if (!location) {
+    location = useLocation();
+  }
+  // segment after pluginId
+  const pluginSegment = location.pathname.split(`/${pluginId}/`)[1];
+
+  if (!pluginSegment) {
+    return t("common.localazy_plugin_hand");
+  }
+  const navigation = getNav();
+  const currentNavItem = navigation.find((navItem) =>
+    pluginSegment.includes(navItem.id)
+  );
+
+  return currentNavItem?.label || t("common.localazy_plugin_hand");
+};