@localazy/strapi-plugin 0.1.9 → 0.1.11-rc.0

package/.eslintrc

@@ -1,7 +1,11 @@
 {
   // "extends": "@strapi-community",
   "env": {
-    "jest/globals": true
+    "jest/globals": true,
+    "es6": true
   },
-  "plugins": ["jest"]
+  "plugins": ["jest"],
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  }
 }

package/.nvmrc

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

package/admin/src/modules/@common/models/supported-content-type-fields.js

@@ -0,0 +1,8 @@
+const SUPPORTED_CONTENT_TYPE_FIELDS = [
+  "string",
+  "text",
+  "richtext",
+  "email",
+];
+
+export default SUPPORTED_CONTENT_TYPE_FIELDS;

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

@@ -30,6 +30,7 @@ function Tree(props) {
 
             const hasTruthyValue = Object.values(flattened).some(v => v);
             const hasFalsyValue = Object.values(flattened).some(v => !v && v !== null);
+            const hasAllNullValue = Object.values(flattened).every(v => v === null);
 
             if (key === "__model__") {
               return false;
@@ -45,6 +46,7 @@ function Tree(props) {
               >
                 {isSubbranchObject && (
                   <Checkbox
+                    disabled={hasAllNullValue}
                     checked={hasTruthyValue && !hasFalsyValue}
                     indeterminate={hasTruthyValue && hasFalsyValue}
                     onChange={() => onTreeItemClick(flattenedKeys, hasTruthyValue && !hasFalsyValue)}

package/admin/src/modules/plugin-settings/utils/get-filtered-models-schemas.js

@@ -1,9 +1,9 @@
+import baseSupportedContentTypeFields from "../../@common/models/supported-content-type-fields";
+
 const SUPPORTED_CONTENT_TYPE_FIELDS = [
-  "string",
-  "text",
-  "richtext",
-  // "relation", // relation cannot be supported field type
+  ...baseSupportedContentTypeFields,
   "component",
+  // "relation", // relation cannot be supported field type
 ];
 
 export default (models) => {

package/admin/src/modules/plugin-settings/utils/get-models-tree.js

@@ -1,3 +1,5 @@
+import SUPPORTED_CONTENT_TYPE_FIELDS from "../../@common/models/supported-content-type-fields";
+
 /**
  * Supported kinds of models are expected by the function, needs to be checked before calling the function
  */
@@ -27,7 +29,7 @@ const getModelsTree = (allModels, localizableModels = []) => {
           ),
         };
       } else if (
-        ["string", "text", "richtext"].includes(attributes[attribute].type)
+        SUPPORTED_CONTENT_TYPE_FIELDS.includes(attributes[attribute].type)
       ) {
         // field might not be localizable
         if (isComponentAttributes) {

package/package.json

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

package/server/bootstrap.js

@@ -1,5 +1,19 @@
 "use strict";
 
-module.exports = () => {
+const getFullPopulateObject = require('./utils/get-full-populate-object')
+
+module.exports = ({ strapi }) => {
   // bootstrap phase
+  // Subscribe to the lifecycles that we are intrested in.
+  strapi.db.lifecycles.subscribe((event) => {
+    if (event.action === 'beforeFindMany' || event.action === 'beforeFindOne') {
+      const populate = event.params?.populate;
+
+      if (populate && populate[0] === 'deep') {
+        const depth = populate[1] ?? 5
+        const modelObject = getFullPopulateObject(event.model.uid, depth);
+        event.params.populate = modelObject.populate
+      }
+    }
+  });
 };

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

@@ -4,6 +4,7 @@ const flattenObject = require("../utils/flatten-object");
 const {
   getCollectionsNames,
   findSetupModelByCollectionName,
+  findSetupModelByCollectionUid,
   isCollectionTransferEnabled,
   getPickPaths,
 } = require("../utils/transfer-setup-utils");
@@ -13,10 +14,9 @@ const {
   isoLocalazyToStrapi,
   isoStrapiToLocalazy,
 } = require("../utils/iso-locales-utils");
-const parsedLocalazyEntryToCreateEntry = require("../utils/parsed-localazy-entry-to-create-entry");
-const parsedLocalazyEntryToUpdateEntry = require("../utils/parsed-localazy-entry-to-update-entry");
+const shouldSetDownloadedProperty = require("../functions/should-set-downloaded-property");
 const set = require("lodash/set");
-const merge = require("lodash/merge");
+const isEmpty = require("lodash/isEmpty");
 
 module.exports = {
   async upload(ctx) {
@@ -159,7 +159,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
@@ -175,6 +177,14 @@ module.exports = {
     const LocalazyDownloadService = strapi
       .plugin("localazy")
       .service("localazyDownloadService");
+    const strapiLocalazyI18nService = strapi
+      .plugin("localazy")
+      .service("strapiLocalazyI18nService");
+
+    const contentTransferSetup = await strapi
+      .plugin("localazy")
+      .service("pluginSettingsService")
+      .getContentTransferSetup();
 
     const user = await LocalazyUserService.getUser();
 
@@ -307,6 +317,7 @@ module.exports = {
      * Parse Localazy content
      */
     const parsedLocalazyContent = {};
+    const strapiContentTypesModels = await StrapiService.getModels();
     for (const [isoLocalazy, keys] of Object.entries(localazyContent)) {
       const isoStrapi = isoLocalazyToStrapi(isoLocalazy);
       if (!isoStrapi) {
@@ -321,21 +332,29 @@ module.exports = {
         const value = localazyEntry.value;
 
         const parsedKey = StrapiI18nService.parseLocalazyKey(key);
-        const setKey = [
-          isoStrapi,
-          parsedKey.uid,
-          parsedKey.id,
-          ...parsedKey.rest,
-        ];
-
-        set(parsedLocalazyContent, setKey, value);
+
+        const modelContentTransferSetup = findSetupModelByCollectionUid(
+          contentTransferSetup,
+          strapiContentTypesModels,
+          parsedKey.uid
+        );
+
+        if (shouldSetDownloadedProperty(modelContentTransferSetup, parsedKey.rest)) {
+          const setKey = [
+            isoStrapi,
+            parsedKey.uid,
+            parsedKey.id,
+            ...parsedKey.rest,
+          ];
+
+          set(parsedLocalazyContent, setKey, value);
+        }
       }
     }
 
     /**
      * Iterate over parsed Localazy content and insert/update content in Strapi
      */
-    const strapiContentTypesModels = await StrapiService.getModels();
     for (const [isoStrapi, contentTypes] of Object.entries(
       parsedLocalazyContent
     )) {
@@ -358,16 +377,11 @@ module.exports = {
             /**
              * Get original source language entry
              */
-            const populate = await StrapiService.getPopulateObject(uid);
-            const baseEntryDeep = await strapi.entityService.findOne(uid, id, {
-              populate,
-            });
-            let baseEntry = await strapi.entityService.findOne(uid, id, {
-              populate: "*",
+            const baseEntry = await strapi.entityService.findOne(uid, id, {
+              populate: "deep",
             });
-            baseEntry = merge(baseEntry, baseEntryDeep);
 
-            if (!baseEntry) {
+            if (isEmpty(baseEntry)) {
               const message = `Source language entry ${uid}[${id}] does not exist anymore, skipping...`;
               throw new Error(message);
             }
@@ -391,19 +405,15 @@ module.exports = {
             if (!baseEntryCurrentLanguageLocalizationInfo) {
               // create new entry
               try {
-                const createEntry = parsedLocalazyEntryToCreateEntry(
+                const createdEntry = await strapiLocalazyI18nService.createEntry(
+                  ctx,
+                  uid,
                   strapiContentTypesModels,
                   translatedModel,
-                  uid,
-                  isoStrapi
+                  baseEntry,
+                  isoStrapi,
                 );
-                const createdEntry =
-                  await StrapiI18nService.createLocalizationForAnExistingEntry(
-                    ctx,
-                    uid,
-                    baseEntry,
-                    createEntry
-                  );
+
                 messageReport.push(
                   `Created new entry ${uid}[${createdEntry.id}] in language ${isoStrapi}`
                 );
@@ -419,28 +429,16 @@ module.exports = {
               try {
                 const localizedEntryId =
                   baseEntryCurrentLanguageLocalizationInfo.id;
-                const populate = await StrapiService.getPopulateObject(uid); // not needed anymore here
-                const localizedEntry = await strapi.entityService.findOne(
+
+                const updatedEntry = await strapiLocalazyI18nService.updateEntry(
                   uid,
                   localizedEntryId,
-                  {
-                    populate,
-                  }
-                );
-
-                const updateEntry = parsedLocalazyEntryToUpdateEntry(
                   strapiContentTypesModels,
                   translatedModel,
-                  localizedEntry,
-                  uid
+                  baseEntry,
+                  isoStrapi,
                 );
 
-                const updatedEntry =
-                  await StrapiI18nService.updateLocalizationForAnExistingEntry(
-                    uid,
-                    localizedEntryId,
-                    updateEntry
-                  );
                 messageReport.push(
                   `Updated ${uid}[${updatedEntry.id}] (${isoStrapi})`
                 );

package/server/functions/should-set-downloaded-property.js

@@ -0,0 +1,16 @@
+const get = require("lodash/get");
+
+const shouldSetDownloadedProperty = (
+  modelContentTransferSetup,
+  parsedKeyRest,
+) => {
+  if (!modelContentTransferSetup.__model__) {
+    return false;
+  }
+
+  const filteredParsedKeyRest = parsedKeyRest
+    .filter((partialKey) => isNaN(parseInt(partialKey)));
+  return !!get(modelContentTransferSetup, filteredParsedKeyRest);
+};
+
+module.exports = shouldSetDownloadedProperty;

package/server/models/supported-content-type-fields.js

@@ -0,0 +1,8 @@
+const SUPPORTED_CONTENT_TYPE_FIELDS = [
+  "string",
+  "text",
+  "richtext",
+  "email",
+];
+
+module.exports = SUPPORTED_CONTENT_TYPE_FIELDS;

package/server/services/index.js

@@ -8,6 +8,7 @@ const localazyUploadService = require("./localazy-upload-service");
 const localazyDownloadService = require("./localazy-download-service");
 const localazyPubApiService = require("./localazy-pubapi-service");
 const strapiI18nService = require("./strapi-i18n-service");
+const strapiLocalazyI18nService = require("./strapi-localazy-i18n-service");
 
 module.exports = {
   localazyUserService,
@@ -18,4 +19,5 @@ module.exports = {
   localazyDownloadService,
   localazyPubApiService,
   strapiI18nService,
+  strapiLocalazyI18nService,
 };

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

@@ -3,6 +3,7 @@
 const { isoLocalazyToStrapi } = require("../utils/iso-locales-utils.js");
 const intlDisplayName = require("../utils/intl-display-name.js");
 const merge = require("lodash/merge");
+const cloneDeep = require("lodash/cloneDeep");
 const omitDeep = require("../utils/omit-deep.js");
 
 module.exports = ({ strapi }) => ({
@@ -79,7 +80,7 @@ module.exports = ({ strapi }) => ({
       // this might not be localizable (then method is missing, skip)
       const contentTypeController = strapi.controller(uid);
       const newLocalizationCtx = { ...ctx };
-      newLocalizationCtx.is = () => false; // else throws an error in createLocalization
+      newLocalizationCtx.is = () => false; // ! else throws an error in createLocalization
       newLocalizationCtx.params.id = baseEntry.id;
 
       const newEntryLocale = newEntry.locale;
@@ -87,7 +88,7 @@ module.exports = ({ strapi }) => ({
         "locale",
         "id",
         "createdAt",
-        "publishedAt", // sets as draft (no timestamp)
+        "publishedAt", // * sets as draft (no timestamp)
         "updatedAt",
       ]);
       filteredNewEntry.locale = newEntryLocale;
@@ -101,7 +102,7 @@ module.exports = ({ strapi }) => ({
         baseEntry.id,
         newEntryLocale
       );
-      const mergedEntry = merge(baseEntry, insertedEntry);
+      const mergedEntry = merge(cloneDeep(baseEntry), insertedEntry);
 
       return mergedEntry;
     } catch (e) {

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

@@ -0,0 +1,104 @@
+"use strict";
+
+const parsedLocalazyEntryToCreateEntry = require("../utils/parsed-localazy-entry-to-create-entry");
+const parsedLocalazyEntryToUpdateEntry = require("../utils/parsed-localazy-entry-to-update-entry");
+
+module.exports = ({ strapi }) => ({
+  async createEntry(
+    ctx,
+    uid,
+    strapiContentTypesModels,
+    translatedModel,
+    baseEntry,
+    isoStrapi,
+  ) {
+    // * The entry will be created and then updated as the structures differ
+    // * It's one extra database call, but the complexity of recursive code to maintain does worth it
+
+    // Strapi i18n Service
+    const StrapiI18nService = strapi
+      .plugin("localazy")
+      .service("strapiI18nService");
+
+    const createEntry = parsedLocalazyEntryToCreateEntry(
+      strapiContentTypesModels,
+      translatedModel,
+      baseEntry,
+      uid,
+      isoStrapi,
+    );
+
+    const createdEntry =
+      await StrapiI18nService.createLocalizationForAnExistingEntry(
+        ctx,
+        uid,
+        baseEntry,
+        createEntry,
+      );
+
+    await this.updateEntry(
+      uid,
+      createdEntry.id,
+      strapiContentTypesModels,
+      translatedModel,
+      baseEntry,
+      isoStrapi,
+    );
+
+    return createdEntry;
+  },
+
+  async updateEntry(
+    uid,
+    localizedEntryId,
+    strapiContentTypesModels,
+    translatedModel,
+    baseEntry,
+    isoStrapi,
+  ) {
+    // Strapi Service
+    const StrapiService = strapi
+      .plugin("localazy")
+      .service("strapiService");
+
+    // Strapi i18n Service
+    const StrapiI18nService = strapi
+      .plugin("localazy")
+      .service("strapiI18nService");
+
+    const populate = await StrapiService.getPopulateObject(uid);
+    const localizedEntry = await strapi.entityService.findOne(
+      uid,
+      localizedEntryId,
+      {
+        populate,
+      }
+    );
+
+    const fullyPopulatedLocalizedEntry = await strapi.entityService.findOne(
+      uid,
+      localizedEntryId,
+      {
+        populate: "deep",
+      }
+    );
+
+    const updateEntry = await parsedLocalazyEntryToUpdateEntry(
+      strapiContentTypesModels,
+      translatedModel,
+      fullyPopulatedLocalizedEntry,
+      localizedEntry,
+      baseEntry,
+      uid,
+      isoStrapi
+    );
+
+    const updatedEntry = await StrapiI18nService.updateLocalizationForAnExistingEntry(
+      uid,
+      localizedEntryId,
+      updateEntry
+    );
+
+    return updatedEntry;
+  }
+});