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

package/server/utils/__tests__/populate-create-update-entry-with-base-entry.test.js

@@ -8,6 +8,8 @@ const simpleMenuEmptyModel = require("../../tests/fixtures/populate-create-updat
 const sampleJSONModel = require("../../tests/fixtures/populate-create-update-entry-with-base-entry-sample-json");
 const cookbookModel = require("../../tests/fixtures/populate-create-update-entry-with-base-entry-cookbook");
 const cookbookEmptyRecipesModel = require("../../tests/fixtures/populate-create-update-entry-with-base-entry-cookbook-empty-recipes");
+const sampleJSONWithDZsModel = require("../../tests/fixtures/populate-create-update-entry-with-base-entry-sample-json-dz");
+const lessonWithDZsModel = require("../../tests/fixtures/populate-create-update-entry-with-base-entry-lesson-dz");
 
 const populateCreateUpdateEntryWithBaseEntry = require("../populate-create-update-entry-with-base-entry");
 
@@ -849,4 +851,289 @@ describe("populate-create-update-entry-with-base-entry.js", () => {
 
     expect(populatedEntry).toEqual(expected);
   });
+
+  it("should populate a 'sample-json' including DZs correctly", async () => {
+    const populatedEntry = await populateCreateUpdateEntryWithBaseEntry(
+      allModels,
+      sampleJSONWithDZsModel.updateEntry,
+      sampleJSONWithDZsModel.baseEntry,
+      sampleJSONWithDZsModel.fullyPopulatedLocalizedEntry,
+      sampleJSONWithDZsModel.uid,
+      sampleJSONWithDZsModel.locale,
+    );
+
+    const expected = {
+      id: 24,
+      purpose: "Bar",
+      data: {
+        bar: "baz",
+      },
+      dynamic_property: [
+        {
+          id: 170,
+          image_title: "Nějaký název obrázku",
+          image_description: "Nějaký popis obrázku",
+          image: {
+            id: 11,
+            name: "heather-ford-G4LFhuLXhLE-unsplash.jpg",
+            alternativeText: "heather-ford-G4LFhuLXhLE-unsplash.jpg",
+            caption: "heather-ford-G4LFhuLXhLE-unsplash.jpg",
+            width: 6127,
+            height: 3844,
+            formats: {
+              thumbnail: {
+                name: "thumbnail_heather-ford-G4LFhuLXhLE-unsplash.jpg",
+                hash: "thumbnail_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f",
+                ext: ".jpg",
+                mime: "image/jpeg",
+                path: null,
+                width: 245,
+                height: 154,
+                size: 9.54,
+                url: "/uploads/thumbnail_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f.jpg",
+              },
+              large: {
+                name: "large_heather-ford-G4LFhuLXhLE-unsplash.jpg",
+                hash: "large_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f",
+                ext: ".jpg",
+                mime: "image/jpeg",
+                path: null,
+                width: 1000,
+                height: 628,
+                size: 117.56,
+                url: "/uploads/large_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f.jpg",
+              },
+              medium: {
+                name: "medium_heather-ford-G4LFhuLXhLE-unsplash.jpg",
+                hash: "medium_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f",
+                ext: ".jpg",
+                mime: "image/jpeg",
+                path: null,
+                width: 750,
+                height: 471,
+                size: 66.32,
+                url: "/uploads/medium_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f.jpg",
+              },
+              small: {
+                name: "small_heather-ford-G4LFhuLXhLE-unsplash.jpg",
+                hash: "small_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f",
+                ext: ".jpg",
+                mime: "image/jpeg",
+                path: null,
+                width: 500,
+                height: 314,
+                size: 31.42,
+                url: "/uploads/small_heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f.jpg",
+              },
+            },
+            hash: "heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f",
+            ext: ".jpg",
+            mime: "image/jpeg",
+            size: 6971.47,
+            url: "/uploads/heather_ford_G4_L_Fhu_L_Xh_LE_unsplash_7a2c2cac8f.jpg",
+            previewUrl: null,
+            provider: "local",
+            provider_metadata: null,
+          },
+          __component: "food.gallery-item",
+        },
+        {
+          id: 191,
+          name: "Přísada I",
+          amount: null,
+          unit: null,
+          is_required: true,
+          __component: "food.recipe-ingredient",
+        },
+        {
+          id: 36,
+          name: "První položka CB",
+          recipe: null,
+          estimated_cook_time: "00:03:00.000",
+          difficulty: "beginner",
+          author_name: "Já",
+          gallery: [
+            {
+              id: 171,
+              image_title: "Obrázek G Jedna",
+              image_description: "Obrázek G Popis Jedna",
+            },
+            {
+              id: 172,
+              image_title: "Img G Two",
+              image_description: "Img G Desc Two",
+            },
+          ],
+          ingredients: [
+            {
+              id: 193,
+              name: "První Ingr DZ",
+              amount: null,
+              unit: null,
+              is_required: true,
+            },
+          ],
+          __component: "food.cookbook-item",
+        },
+        {
+          id: 192,
+          name: "Druhá přísada",
+          amount: null,
+          unit: null,
+          is_required: true,
+          __component: "food.recipe-ingredient",
+        },
+      ],
+      repeatable_component_property: [
+        {
+          id: 61,
+          name: "Položka 1",
+          price: 1,
+          currency: "CZK",
+          description: "Nějaký popis",
+          is_available: null,
+          food_gallery: null,
+        },
+        {
+          id: 62,
+          name: "Položka 2",
+          price: 2,
+          currency: "CZK",
+          description: "Nějaký další popis",
+          is_available: null,
+          food_gallery: [
+            {
+              id: 6,
+              name: "rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+              alternativeText: "rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+              caption: "rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+              width: 2268,
+              height: 4032,
+              formats: {
+                thumbnail: {
+                  name: "thumbnail_rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+                  hash: "thumbnail_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea",
+                  ext: ".jpg",
+                  mime: "image/jpeg",
+                  path: null,
+                  width: 88,
+                  height: 156,
+                  size: 5.35,
+                  url: "/uploads/thumbnail_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea.jpg",
+                },
+                large: {
+                  name: "large_rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+                  hash: "large_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea",
+                  ext: ".jpg",
+                  mime: "image/jpeg",
+                  path: null,
+                  width: 563,
+                  height: 1000,
+                  size: 108.15,
+                  url: "/uploads/large_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea.jpg",
+                },
+                medium: {
+                  name: "medium_rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+                  hash: "medium_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea",
+                  ext: ".jpg",
+                  mime: "image/jpeg",
+                  path: null,
+                  width: 422,
+                  height: 750,
+                  size: 65.52,
+                  url: "/uploads/medium_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea.jpg",
+                },
+                small: {
+                  name: "small_rodrigo-dos-reis-h3AkzboxK4Q-unsplash.jpg",
+                  hash: "small_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea",
+                  ext: ".jpg",
+                  mime: "image/jpeg",
+                  path: null,
+                  width: 281,
+                  height: 500,
+                  size: 34.23,
+                  url: "/uploads/small_rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea.jpg",
+                },
+              },
+              hash: "rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea",
+              ext: ".jpg",
+              mime: "image/jpeg",
+              size: 1081.59,
+              url: "/uploads/rodrigo_dos_reis_h3_Akzbox_K4_Q_unsplash_d17e795cea.jpg",
+              previewUrl: null,
+              provider: "local",
+              provider_metadata: null,
+            },
+          ],
+        },
+      ],
+    };
+
+    expect(populatedEntry).toEqual(expected);
+  });
+
+  it("should populate a 'lesson' including DZs correctly", async () => {
+    const populatedEntry = await populateCreateUpdateEntryWithBaseEntry(
+      allModels,
+      lessonWithDZsModel.updateEntry,
+      lessonWithDZsModel.baseEntry,
+      lessonWithDZsModel.fullyPopulatedLocalizedEntry,
+      lessonWithDZsModel.uid,
+      lessonWithDZsModel.locale,
+    );
+
+    const expected = {
+      id: 4,
+      title: "Test: Sčítání",
+      start_time: "2022-10-01T13:00:00.000Z",
+      duration: "02:00:00.000",
+      description: "Otestujte si své dovednosti, které jsme se naučili v předchozí lekci.",
+      lesson_type: [
+        {
+          id: 2,
+          title: "Vyberte správnou odpověď",
+          questions: [
+            {
+              id: 4,
+              question: "1 + 1 = ",
+              is_active: true,
+              question_number: 1,
+            },
+            {
+              id: 5,
+              question: "5 + 15 = ",
+              is_active: false,
+              question_number: 2,
+            },
+            {
+              id: 6,
+              question: "Kolik pohárů je na fotce?",
+              is_active: false,
+              question_number: 3,
+            },
+          ],
+          answers: [
+            {
+              id: 4,
+              question_number: 1,
+              correct_answer: "2",
+            },
+            {
+              id: 5,
+              question_number: 2,
+              correct_answer: "20",
+            },
+            {
+              id: 6,
+              question_number: 3,
+              correct_answer: "15",
+            },
+          ],
+          __component: "lesson.quiz",
+        },
+      ],
+    };
+
+    expect(populatedEntry).toEqual(expected);
+  });
 });

package/server/utils/build-populate.js

@@ -30,6 +30,11 @@ const buildPopulate = (models, modelUid) => {
           : `${attributeName}`;
         const innerModelUid = attribute.component;
         buildPopulateStep(models, innerModelUid, newPrefix);
+      } else if (attribute.type === "dynamiczone") {
+        const key = prefix
+          ? `${prefix}.${attributeName}.populate`
+          : `${attributeName}.populate`;
+        keys.push(key);
       }
     }
 

package/server/utils/model-utils.js

@@ -15,6 +15,10 @@ const isComponent = (attributeObj) => {
   return attributeObj.type === "component";
 };
 
+const isDynamicZone = (attributeObj) => {
+  return attributeObj.type === "dynamiczone";
+}
+
 const isRepeatable = (attributeObj) => {
   return isComponent(attributeObj) && !!attributeObj.repeatable;
 };
@@ -32,6 +36,7 @@ const findModel = (models, uid) => {
 module.exports = {
   getAttribute,
   isComponent,
+  isDynamicZone,
   isRepeatable,
   isRelation,
   findModel,

package/server/utils/omit-deep.js

@@ -11,6 +11,13 @@ function omitDeep(collection, excludeKeys) {
     }
   }
 
+  if (Array.isArray(collection)) {
+    const clonedData = [];
+    for (const collectionItem of collection) {
+      clonedData.push(cloneDeepWith(collectionItem, omitFn));
+    }
+    return clonedData;
+  }
   return cloneDeepWith(collection, omitFn);
 }
 

package/server/utils/parsed-localazy-entry-to-create-entry.js

@@ -3,7 +3,7 @@
 const set = require("lodash/set");
 const get = require("lodash/get");
 const resetArrayKeysDeep = require("./reset-array-keys-deep");
-const { getAttribute, isComponent, isRepeatable, findModel } = require("./model-utils");
+const { getAttribute, isComponent, isDynamicZone, isRepeatable, findModel } = require("./model-utils");
 
 const parsedLocalazyEntryToCreateEntry = (
   models,
@@ -14,6 +14,7 @@ const parsedLocalazyEntryToCreateEntry = (
 ) => {
   const createEntry = {};
   const repeatableComponentsKeystoFilter = [];
+  const dynamicZoneComponentKeys = [];
 
   const toCreateEntry = (
     entry,
@@ -23,7 +24,8 @@ const parsedLocalazyEntryToCreateEntry = (
     key = "",
     prefix = "",
     component = "",
-    isRepeatableComponent = false
+    isRepeatableComponent = false,
+    isDZ = false,
   ) => {
     if (Array.isArray(entry)) {
       // is array
@@ -47,6 +49,33 @@ const parsedLocalazyEntryToCreateEntry = (
           if (component && !isRepeatableComponent) {
             toCreateEntry(value, model, baseEntry, `${prefix}`, `${prefix}`);
           }
+
+          if (!component && isRepeatableComponent) {
+            // used for indices filtering in dynamic zones
+            if (!repeatableComponentsKeystoFilter.includes(prefix)) {
+              repeatableComponentsKeystoFilter.push(prefix);
+            }
+            const baseEntryRepeatableItemId = parseInt(baseEntryItemId);
+            const baseEntryRepeateableGroup = get(baseEntry, prefix);
+            if (baseEntryRepeateableGroup !== undefined) {
+              const localizedEntryRepeatableItemPosition = baseEntryRepeateableGroup.findIndex((repeatableItem) => !!repeatableItem && repeatableItem.id === baseEntryRepeatableItemId);
+              if (localizedEntryRepeatableItemPosition > -1) {
+                const dzEntry = get(baseEntry, prefix).find((v) => v.id === baseEntryRepeatableItemId);
+                const dzEntryComponent = dzEntry.__component;
+                const dzEntryComponentModel = findModel(models, dzEntryComponent);
+                toCreateEntry(
+                  value,
+                  dzEntryComponentModel,
+                  baseEntry,
+                  localizedEntryRepeatableItemPosition,
+                  `${prefix}.${localizedEntryRepeatableItemPosition}`,
+                  dzEntryComponent,
+                  true,
+                  true,
+                );
+              }
+            }
+          }
         }
       });
     } else {
@@ -89,12 +118,37 @@ const parsedLocalazyEntryToCreateEntry = (
               false
             );
           }
+        } else if (isDynamicZone(attribute)) {
+          // behaves sort of like repeatable component
+          const newPrefix = prefix
+            ? `${prefix}.${objectKey}`
+            : `${objectKey}`;
+          toCreateEntry(
+            value,
+            null, // model is evaluated later as it's dynamic (DZ)
+            baseEntry,
+            objectKey,
+            newPrefix,
+            "", // component is computed later as it's dynamic (DZ)
+            true,
+            true,
+          );
         } else {
           const newPrefix = prefix ? `${prefix}.${objectKey}` : `${objectKey}`;
           set(createEntry, newPrefix, value);
 
           if (component) {
-            set(createEntry, `${prefix}.__component`, component);
+            const componentKeyToSet = `${prefix}.__component`;
+            set(createEntry, componentKeyToSet, component);
+
+            if (isDZ) {
+              const isKeyAdded = (typeof dynamicZoneComponentKeys.find((v) => v.key === componentKeyToSet) !== "undefined");
+              if (!isKeyAdded)
+                dynamicZoneComponentKeys.push({
+                  key: componentKeyToSet,
+                  component,
+                });
+            }
           }
           // is not component
         }
@@ -109,7 +163,7 @@ const parsedLocalazyEntryToCreateEntry = (
   }
 
   resetArrayKeysDeep(createEntry, repeatableComponentsKeystoFilter);
-  return createEntry;
+  return { createEntry, dynamicZoneComponentKeys };
 };
 
 module.exports = parsedLocalazyEntryToCreateEntry;

package/server/utils/parsed-localazy-entry-to-update-entry.js

@@ -4,6 +4,7 @@ const merge = require("lodash/merge");
 const parsedLocalazyEntryToCreateEntry = require("./parsed-localazy-entry-to-create-entry");
 const omitDeep = require("./omit-deep");
 const populateCreateUpdateEntryWithBaseEntry = require("./populate-create-update-entry-with-base-entry");
+const { set } = require("lodash");
 
 const parsedLocalazyEntryToUpdateEntry = async (
   allModels,
@@ -14,7 +15,7 @@ const parsedLocalazyEntryToUpdateEntry = async (
   uid,
   locale
 ) => {
-  const createEntry = parsedLocalazyEntryToCreateEntry(
+  const { createEntry, dynamicZoneComponentKeys } = parsedLocalazyEntryToCreateEntry(
     allModels,
     localazyEntry,
     baseEntry,
@@ -33,6 +34,10 @@ const parsedLocalazyEntryToUpdateEntry = async (
     "updatedBy",
     "publishedAt",
   ]);
+  // set dynamic zone compoonent keys again
+  dynamicZoneComponentKeys.forEach((v) => {
+    set(updateEntry, v.key, v.component);
+  });
 
   const filteredBaseEntry = omitDeep(baseEntry, [
     // "__component", // do not omit the __component

package/server/utils/pick-deep.js

@@ -0,0 +1,22 @@
+"use strict";
+const isObject = require("lodash/isObject");
+const set = require("lodash/set");
+const includes = require("lodash/includes");
+
+const deepLodashPick = (obj, keys, newObj = {}, path = []) => {
+  for (let k in obj) {
+    const value = obj[k];
+
+    if (isObject(value)) {
+      path.push(k);
+      deepLodashPick(value, keys, newObj, path);
+      path.pop();
+    } else if (includes(keys, k)) {
+      set(newObj, [...path, k], value);
+    }
+  }
+
+  return newObj;
+}
+
+module.exports = deepLodashPick;

package/server/utils/pick-entries.js

@@ -1,12 +1,97 @@
 "use strict";
 
-const pickEntries = (flatten, pickPaths) => {
+const map = require("lodash/map");
+const pickDeep = require("./pick-deep");
+const flattenObject = require("./flatten-object");
+
+const isDynamicZoneKey = (key, transferSetupModel) => {
+  const matches = key.match(/\[\d+\]+/g);
+
+  if (matches.length < 2) {
+    return false;
+  }
+
+  const dynamicPropertyEntryIdWithSquareBrackets = matches[1];
+  const dynamicPropertyNamePart = key.split(".").find((s, index) => index > 1 && s.includes(dynamicPropertyEntryIdWithSquareBrackets));
+  const dynamicPropertyName = dynamicPropertyNamePart.replace(dynamicPropertyEntryIdWithSquareBrackets, "");
+
+  return Array.isArray(transferSetupModel[dynamicPropertyName]);
+};
+
+const getDynamicZoneEntryId = (key, transferSetupModel) => {
+  if (!isDynamicZoneKey(key, transferSetupModel)) {
+    return undefined;
+  }
+
+  const matches = key.match(/\[\d+\]+/g);
+  // remove square brackets
+  const id = matches[1].replace(/[\[\]']+/g, '');
+  return id;
+}
+
+const doesPickPathsIncludeTheComponent = (pickPaths, dzParameterKey) => {
+  return pickPaths.some((pp) => pp.includes(dzParameterKey));
+}
+
+const pickEntries = (flatten, pickPaths, transferSetupModel) => {
+  // * dynamic zones properties must! always be in 1st level (not in component; Strapi restrictions)
+
+  const dzEntryIdComponentMap = {};
+  const flattenComponentProps = Object.fromEntries(Object.entries(flatten).filter(([key]) => key.includes('__component')));
+
+  const pickedDeep = pickDeep(transferSetupModel, ["__component__"]);
+  const flattenedPickedDeep = flattenObject(pickedDeep);
+  map(flattenedPickedDeep, (v, i) => {
+    const newI = i.replace(".__component__", "");
+    flattenedPickedDeep[newI] = v;
+    delete flattenedPickedDeep[i];
+  });
+
+  Object.keys(flattenComponentProps).map((key) => {
+    if (!isDynamicZoneKey(key, transferSetupModel)) {
+      return;
+    }
+
+    const entryId = getDynamicZoneEntryId(key, transferSetupModel);
+    dzEntryIdComponentMap[entryId] = {
+      component: flattenComponentProps[key],
+      key: Object.keys(flattenedPickedDeep).find((fpdk) => flattenedPickedDeep[fpdk] === flattenComponentProps[key]),
+    };
+  });
+
   const pickedEntries = {};
-  Object.keys(flatten).forEach((key) => {
+  const mappedPickPaths = pickPaths.map((pickPath) => pickPath.replace(/\[\d+\]/g, ""));
+
+  // filter out "__component"
+  const filteredFlatten = Object.fromEntries(Object.entries(flatten).filter(([key]) => !key.includes('__component')));
+  Object.keys(filteredFlatten).forEach((key) => {
+    // decide whether it is a dynamic zone
+    // handle dynamic zones, in case of similarly-named fields across more components
+    const isDynamicZone = isDynamicZoneKey(key, transferSetupModel);
+    if (isDynamicZone) {
+      const dzEntryId = getDynamicZoneEntryId(key, transferSetupModel);
+      const dzParameterKey = dzEntryIdComponentMap[dzEntryId].key;
+
+      if (!doesPickPathsIncludeTheComponent(pickPaths, dzParameterKey)) {
+        return;
+      }
+    }
+
     const filteredKey = key.replace(/\[\d+\]/g, "");
-    // const filteredKey = key.replace(/\d|[[\]]+/g, "");
-    if (pickPaths.includes(filteredKey)) {
-      pickedEntries[key] = flatten[key];
+    if (mappedPickPaths.includes(filteredKey)) {
+      if (isDynamicZone) {
+        const dzEntryId = getDynamicZoneEntryId(key, transferSetupModel);
+        const dzParameterKey = dzEntryIdComponentMap[dzEntryId].key;
+
+        const dzParameterName = dzParameterKey.substring(0, dzParameterKey.indexOf('['));
+        const toBeReplaced = `${dzParameterName}[${dzEntryId}]`;
+        const dzParameterComponent = dzEntryIdComponentMap[dzEntryId].component;
+        const componentAddition = `${dzParameterName}[${dzEntryId};${dzParameterComponent}]`;
+        const replacedKey = key.replace(toBeReplaced, componentAddition);
+        pickedEntries[replacedKey] = flatten[key];
+      } else {
+        pickedEntries[key] = flatten[key];
+      }
     }
   });
   return pickedEntries;