@localazy/strapi-plugin 0.1.4 → 0.1.7

package/README.md

@@ -1,11 +1,7 @@
-# The Official Strapi Localization Plugin by Localazy
-
-### The Official Strapi Localization Plugin by Localazy
+## The Official Strapi Localization Plugin by Localazy
 
 Strapi localization doesn't have to be a headache! Install the Strapi localization plugin and seamlessly translate your content into multiple languages with [Localazy](https://localazy.com).
 
-![The Official Strapi Localization Plugin by Localazy](https://directus9.localazy.com/assets/e08d0418-5669-4255-9c2c-f5cc6e403edd)
-
 ### Manage your multilingual content with ease.
 1. [Sign up](https://localazy.com/register?ref=strapi_marketplace) & Upload your content to Localazy.
 2. Translate your content with machine translation assistance, or let the Localazy Continuous Localization Team translate your content for you. You can also quickly pre-translate everything in bulk or invite your translators.
@@ -13,15 +9,17 @@ Strapi localization doesn't have to be a headache! Install the Strapi localizati
 
 Learn more in the [Strapi + Localazy tutorial](https://localazy.com/blog/how-to-strapi-localization-with-localazy#getting-started-with-strapi-localization).
 
-### General information
-
-This repository contains all the code needed to run the Strapi Localization Plugin by Localazy.
+## Setup
 
 ### Install plugin via NPM
 
 The plugin is available on [NPM](https://www.npmjs.com/package/@localazy/strapi-plugin).
 You can also follow the installation commands located in your Strapi project Marketplace. This is the recommended approach.
 
+```
+npm install @localazy/strapi-plugin
+```
+
 ### 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:
@@ -47,12 +45,10 @@ module.exports = {
 
 5. Run the project. The plugin will be available in the admin.
 
-### Tests
+## 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.
-
-### Support
+## Support
 - If you encounter any issues or have questions, please contact us at [team@localazy.com](mailto:team@localazy.com).
 - Join the [Localazy Discord](https://discord.gg/CAVhHrh) to discuss all things localization.

package/admin/src/modules/@common/utils/__tests__/iso-locales-utils.test.js

@@ -0,0 +1,102 @@
+const { isoStrapiToLocalazy, isoLocalazyToStrapi } = require("../iso-locales-utils");
+
+describe("iso-locales-utils.js", () => {
+  describe("transform Strapi ISO to Localazy ISO", () => {
+    it("should transform codes containing lang only", () => {
+      // setup
+      const input = ["en", "fr", "de", "es", "it", "ja", "ko", "pt", "ru", "zh"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = input;
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-region", () => {
+      // setup
+      const input = ["en-US", "fr-CA", "de-DE", "es-ES", "it-IT", "ja-JP", "ko-KR", "pt-BR", "ru-RU", "zh-CN"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = ["en_US", "fr_CA", "de_DE", "es_ES", "it_IT", "ja_JP", "ko_KR", "pt_BR", "ru_RU", "zh_CN"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script", () => {
+      // setup
+      const input = ["en-Latn", "fr-Latn", "de-Latn", "es-Latn", "it-Latn", "ja-Latn", "ko-Latn", "pt-Latn", "ru-Latn", "zh-Latn"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = ["en#Latn", "fr#Latn", "de#Latn", "es#Latn", "it#Latn", "ja#Latn", "ko#Latn", "pt#Latn", "ru#Latn", "zh#Latn"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script-region", () => {
+      // setup
+      const input = ["en-Latn-US", "fr-Latn-CA", "de-Latn-DE", "es-Latn-ES", "it-Latn-IT", "ja-Latn-JP", "ko-Latn-KR", "pt-Latn-BR", "ru-Latn-RU", "zh-Hant-CN"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = ["en_US#Latn", "fr_CA#Latn", "de_DE#Latn", "es_ES#Latn", "it_IT#Latn", "ja_JP#Latn", "ko_KR#Latn", "pt_BR#Latn", "ru_RU#Latn", "zh_CN#Hant"];
+      expect(output).toEqual(expected);
+    });
+  });
+
+  describe("transform Strapi ISO to Localazy ISO", () => {
+    it("should transform codes containing lang only", () => {
+      // setup
+      const input = ["en", "fr", "de", "es", "it", "ja", "ko", "pt", "ru", "zh"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+
+      // verify
+      const expected = input;
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-region", () => {
+      // setup
+      const input = ["en_US", "fr_CA", "de_DE", "es_ES", "it_IT", "ja_JP", "ko_KR", "pt_BR", "ru_RU", "zh_CN"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+
+      // verify
+      const expected = ["en-US", "fr-CA", "de-DE", "es-ES", "it-IT", "ja-JP", "ko-KR", "pt-BR", "ru-RU", "zh-CN"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script", () => {
+      // setup
+      const input = ["en#Latn", "fr#Latn", "de#Latn", "es#Latn", "it#Latn", "ja#Latn", "ko#Latn", "pt#Latn", "ru#Latn", "zh#Latn"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+
+      // verify
+      const expected = ["en-Latn", "fr-Latn", "de-Latn", "es-Latn", "it-Latn", "ja-Latn", "ko-Latn", "pt-Latn", "ru-Latn", "zh-Latn"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script-region", () => {
+      // setup
+      const input = ["en_US#Latn", "fr_CA#Latn", "de_DE#Latn", "es_ES#Latn", "it_IT#Latn", "ja_JP#Latn", "ko_KR#Latn", "pt_BR#Latn", "ru_RU#Latn", "zh_CN#Hant"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+      // verify
+      const expected = ["en-Latn-US", "fr-Latn-CA", "de-Latn-DE", "es-Latn-ES", "it-Latn-IT", "ja-Latn-JP", "ko-Latn-KR", "pt-Latn-BR", "ru-Latn-RU", "zh-Hant-CN"];
+      expect(output).toEqual(expected);
+    });
+  });
+});

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

@@ -3,7 +3,31 @@ export const isoStrapiToLocalazy = (isoStrapi) => {
     return null;
   }
 
-  return isoStrapi.replace("_", "-");
+  const split = isoStrapi.split("-");
+  const language = split[0];
+
+  const hasRegionAndScript = split.length === 3;
+
+  if (hasRegionAndScript) {
+    const script = split[1];
+    const region = split[2];
+
+    return `${language}_${region}#${script}`;
+  }
+
+  const hasPossiblyRegion = split.length === 2;
+
+  if (hasPossiblyRegion) {
+    const regionOrScript = split[1];
+
+    // is it script - the way Strapi resolves that
+    const isItRegion = regionOrScript.toUpperCase() === regionOrScript;
+
+    // it is region; otherwise it is script
+    return isItRegion ? `${language}_${regionOrScript}` : `${language}#${regionOrScript}`;
+  }
+
+  return isoStrapi.replace("-", "_");
 };
 
 export const isoLocalazyToStrapi = (isoLocalazy) => {
@@ -11,5 +35,24 @@ export const isoLocalazyToStrapi = (isoLocalazy) => {
     return null;
   }
 
-  return isoLocalazy.replace("-", "_");
+  const scriptIndex = isoLocalazy.indexOf("#");
+  const hasScript = scriptIndex > -1;
+
+  if (hasScript) {
+    const script = isoLocalazy.substring(scriptIndex + 1);
+    const isoLocalazyWithoutScript = isoLocalazy.substring(0, scriptIndex);
+    const split = isoLocalazyWithoutScript.split("_");
+    const language = split[0];
+    const region = split[1];
+
+    if (!region) {
+      return `${language}-${script}`;
+    }
+
+    const isoStrapi = `${language}-${script}-${region.toUpperCase()}`;
+
+    return isoStrapi;
+  }
+
+  return isoLocalazy.replace("_", "-");
 };

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

@@ -115,7 +115,7 @@ function Download(props) {
             >
               <Divider />
             </Box>
-            <Box marginTop={4}>
+            <Box marginTop={2}>
               <Flex gap="2">
                 <Button variant="secondary" onClick={onTranslateInLocalazyClick}>
                   {t("download.translate_in_localazy")}

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

@@ -49,11 +49,21 @@ function Login(props) {
       <HeaderLayout
         title={props.title}
         subtitle={props.subtitle}
-        as="h2"
+        as="h1"
       />
       {props.isLoading && (<Loader>{t("common.loading_content")}</Loader>)}
       {!props.isLoading && (
-        <Box paddingLeft={10}>
+        <Box
+          marginLeft={10}
+          marginRight={10}
+          background="neutral0"
+          paddingTop={6}
+          paddingRight={7}
+          paddingBottom={6}
+          paddingLeft={7}
+          hasRadius
+          shadow="tableShadow"
+        >
           <Box>
             <Typography variant="epsilon" textColor="neutral600">
               {t("common.localazy_plugin_description")}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@localazy/strapi-plugin",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "description": "The official Strapi Plugin by Localazy.",
   "strapi": {
     "name": "localazy",
@@ -52,8 +52,8 @@
     "jest": "^27.5.1"
   },
   "author": {
-    "name": "David Vaclavek",
-    "email": "david@localazy.com",
+    "name": "Localazy",
+    "email": "team@localazy.com",
     "url": "https://localazy.com"
   },
   "maintainers": [

package/server/config/development/index.js

@@ -2,8 +2,8 @@
 
 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_OAUTH_APP_CLIENT_ID: "18503917571895066466",
+  LOCALAZY_PLUGIN_CONNECTOR_API_URL: "https://testing.localazy.com/plugin-connector",
   LOCALAZY_PUBLIC_API_URL: "https://testing.localazy.com/pubapi",
   LOCALAZY_PLUGIN_ID: "1",
   LOCALAZY_DEFAULT_FILE_NAME: "strapi.json",

package/server/controllers/localazy-transfer-controller.js

@@ -25,7 +25,9 @@ module.exports = {
       const messageReport = [];
 
       // Strapi Service
-      const StrapiService = strapi.plugin("localazy").service("strapiService");
+      const StrapiService = strapi
+        .plugin("localazy")
+        .service("strapiService");
 
       // Strapi i18n Service
       const StrapiI18nService = strapi

package/server/services/strapi-i18n-service.js

@@ -13,17 +13,18 @@ module.exports = ({ strapi }) => ({
   async createStrapiLocale(ctx, isoLocalazy) {
     try {
       const isoStrapi = isoLocalazyToStrapi(isoLocalazy);
-      const localeName = intlDisplayName(isoLocalazy);
+      let localeName = intlDisplayName(isoStrapi);
 
       if (!localeName || !isoStrapi) {
         throw new Error("Invalid locale");
       }
+      localeName = `${localeName} (${isoStrapi})`;
 
       const newLocaleCtx = { ...ctx };
       newLocaleCtx.request.body = {
         isDefault: false,
         code: isoStrapi,
-        name: localeName,
+        name: localeName.substring(0, 50), // limit name to 50 characters (given by Strapi)
       };
 
       await strapi
@@ -39,7 +40,6 @@ module.exports = ({ strapi }) => ({
   parseLocalazyKey(key) {
     const split = key.split(/\.|\[|\]/);
     const filteredSplit = split.filter((item) => item !== "");
-    // return split;
 
     return {
       uid: `${filteredSplit[0]}.${filteredSplit[1]}`,

package/server/utils/__tests__/iso-locales-utils.test.js

@@ -0,0 +1,104 @@
+"use strict";
+
+const { isoStrapiToLocalazy, isoLocalazyToStrapi } = require("../iso-locales-utils.js");
+
+describe("iso-locales-utils.js", () => {
+  describe("transform Strapi ISO to Localazy ISO", () => {
+    it("should transform codes containing lang only", () => {
+      // setup
+      const input = ["en", "fr", "de", "es", "it", "ja", "ko", "pt", "ru", "zh"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = input;
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-region", () => {
+      // setup
+      const input = ["en-US", "fr-CA", "de-DE", "es-ES", "it-IT", "ja-JP", "ko-KR", "pt-BR", "ru-RU", "zh-CN"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = ["en_US", "fr_CA", "de_DE", "es_ES", "it_IT", "ja_JP", "ko_KR", "pt_BR", "ru_RU", "zh_CN"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script", () => {
+      // setup
+      const input = ["en-Latn", "fr-Latn", "de-Latn", "es-Latn", "it-Latn", "ja-Latn", "ko-Latn", "pt-Latn", "ru-Latn", "zh-Latn"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = ["en#Latn", "fr#Latn", "de#Latn", "es#Latn", "it#Latn", "ja#Latn", "ko#Latn", "pt#Latn", "ru#Latn", "zh#Latn"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script-region", () => {
+      // setup
+      const input = ["en-Latn-US", "fr-Latn-CA", "de-Latn-DE", "es-Latn-ES", "it-Latn-IT", "ja-Latn-JP", "ko-Latn-KR", "pt-Latn-BR", "ru-Latn-RU", "zh-Hant-CN"];
+
+      // execute
+      const output = input.map((item) => isoStrapiToLocalazy(item));
+
+      // verify
+      const expected = ["en_US#Latn", "fr_CA#Latn", "de_DE#Latn", "es_ES#Latn", "it_IT#Latn", "ja_JP#Latn", "ko_KR#Latn", "pt_BR#Latn", "ru_RU#Latn", "zh_CN#Hant"];
+      expect(output).toEqual(expected);
+    });
+  });
+
+  describe("transform Strapi ISO to Localazy ISO", () => {
+    it("should transform codes containing lang only", () => {
+      // setup
+      const input = ["en", "fr", "de", "es", "it", "ja", "ko", "pt", "ru", "zh"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+
+      // verify
+      const expected = input;
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-region", () => {
+      // setup
+      const input = ["en_US", "fr_CA", "de_DE", "es_ES", "it_IT", "ja_JP", "ko_KR", "pt_BR", "ru_RU", "zh_CN"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+
+      // verify
+      const expected = ["en-US", "fr-CA", "de-DE", "es-ES", "it-IT", "ja-JP", "ko-KR", "pt-BR", "ru-RU", "zh-CN"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script", () => {
+      // setup
+      const input = ["en#Latn", "fr#Latn", "de#Latn", "es#Latn", "it#Latn", "ja#Latn", "ko#Latn", "pt#Latn", "ru#Latn", "zh#Latn"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+
+      // verify
+      const expected = ["en-Latn", "fr-Latn", "de-Latn", "es-Latn", "it-Latn", "ja-Latn", "ko-Latn", "pt-Latn", "ru-Latn", "zh-Latn"];
+      expect(output).toEqual(expected);
+    });
+
+    it("should transform codes containing lang-script-region", () => {
+      // setup
+      const input = ["en_US#Latn", "fr_CA#Latn", "de_DE#Latn", "es_ES#Latn", "it_IT#Latn", "ja_JP#Latn", "ko_KR#Latn", "pt_BR#Latn", "ru_RU#Latn", "zh_CN#Hant"];
+
+      // execute
+      const output = input.map((item) => isoLocalazyToStrapi(item));
+      // verify
+      const expected = ["en-Latn-US", "fr-Latn-CA", "de-Latn-DE", "es-Latn-ES", "it-Latn-IT", "ja-Latn-JP", "ko-Latn-KR", "pt-Latn-BR", "ru-Latn-RU", "zh-Hant-CN"];
+      expect(output).toEqual(expected);
+    });
+  });
+});

package/server/utils/intl-display-name.js

@@ -1,7 +1,4 @@
-const { isoStrapiToLocalazy } = require("./iso-locales-utils.js");
-
-module.exports = (isoCode) => {
-  const isoDashed = isoStrapiToLocalazy(isoCode);
+module.exports = (isoStrapi) => {
   let languageNames = new Intl.DisplayNames(["en"], { type: "language" });
-  return languageNames.of(isoDashed);
+  return languageNames.of(isoStrapi);
 };

package/server/utils/iso-locales-utils.js

@@ -5,7 +5,28 @@ const isoStrapiToLocalazy = (isoStrapi) => {
     return null;
   }
 
-  return isoStrapi.replace("_", "-");
+  const split = isoStrapi.split("-");
+  const language = split[0];
+
+  const hasRegionAndScript = split.length === 3;
+  if (hasRegionAndScript) {
+    const script = split[1];
+    const region = split[2];
+    return `${language}_${region}#${script}`;
+  }
+
+  const hasPossiblyRegion = split.length === 2;
+  if (hasPossiblyRegion) {
+    const regionOrScript = split[1];
+
+    // is it script - the way Strapi resolves that
+    const isItRegion = regionOrScript.toUpperCase() === regionOrScript;
+
+    // it is region; otherwise it is script
+    return isItRegion ? `${language}_${regionOrScript}` : `${language}#${regionOrScript}`;
+  }
+
+  return isoStrapi.replace("-", "_");
 };
 
 const isoLocalazyToStrapi = (isoLocalazy) => {
@@ -13,7 +34,24 @@ const isoLocalazyToStrapi = (isoLocalazy) => {
     return null;
   }
 
-  return isoLocalazy.replace("-", "_");
+  const scriptIndex = isoLocalazy.indexOf("#");
+  const hasScript = scriptIndex > -1;
+  if (hasScript) {
+    const script = isoLocalazy.substring(scriptIndex + 1);
+    const isoLocalazyWithoutScript = isoLocalazy.substring(0, scriptIndex);
+    const split = isoLocalazyWithoutScript.split("_");
+    const language = split[0];
+    const region = split[1];
+
+    if (!region) {
+      return `${language}-${script}`;
+    }
+
+    const isoStrapi = `${language}-${script}-${region.toUpperCase()}`;
+    return isoStrapi;
+  }
+
+  return isoLocalazy.replace("_", "-");
 };
 
 module.exports = {