pim-import 4.33.2 → 4.34.1

package/src/pim/methods/products.ts

@@ -61,6 +61,7 @@ import {
   getDefaultWrapperImgixAttributesByPimUrl,
   getImgixPimUrlByOriginPath,
   getOriginPathByPimUrl,
+  purgeImageCacheByUrl,
 } from "../../libs/imgix";
 import { generatePDFByUrl } from "../../libs/pdf";
 import { reindexProduct } from "../../algolia/products";
@@ -1856,173 +1857,183 @@ const productAudit = async (
         log(err);
       }
     }
-    for (const item of audit?.catalogs) {
-      if (!item?.where) {
-        log(
-          `catalogs.where field not exists. Product: ${audit.product} `,
-          "WARN"
-        );
-      } else {
-        let edit = false;
-        if (item?.catalogCode) {
-          productEntry.fields = await removeFromRelationFields(
-            productEntry,
-            "catalogs",
-            item.catalogCode,
-            true
-          );
-          log(`edit catalogs`);
-          edit = true;
-        }
-        if (item?.categoryCode) {
-          const categoriesFieldKey =
-            "categories" + capitalizeFirstLetter(item.where);
-          productEntry.fields = await removeFromRelationFields(
-            productEntry,
-            categoriesFieldKey,
-            item.categoryCode,
-            true
-          );
-          log(`edit ${categoriesFieldKey}`);
-          edit = true;
-        }
-        if (item?.subfamilyCode) {
-          const subFamiliesFieldKey =
-            "subFamilies" + capitalizeFirstLetter(item.where);
-          productEntry.fields = await removeFromRelationFields(
-            productEntry,
-            subFamiliesFieldKey,
-            item.subfamilyCode,
-            true
-          );
-          log(`edit ${subFamiliesFieldKey}`);
-          edit = true;
-        }
-        if (item?.models) {
-          const modelsFieldKey = "models" + capitalizeFirstLetter(item.where);
-          productEntry.fields = await removeFromRelationFields(
-            productEntry,
-            modelsFieldKey,
-            item.models,
-            true
-          );
-          log(`edit ${modelsFieldKey}`);
-          edit = true;
-        }
-        if (item?.subModels) {
-          const subModelsFieldKey =
-            "subModels" + capitalizeFirstLetter(item.where);
-          productEntry.fields = await removeFromRelationFields(
-            productEntry,
-            subModelsFieldKey,
-            item.subModels,
-            true
+    if (audit?.catalogs) {
+      for (const item of audit?.catalogs) {
+        if (!item?.where) {
+          log(
+            `catalogs.where field not exists. Product: ${audit.product} `,
+            "WARN"
           );
-          log(`edit ${subModelsFieldKey}`);
-          edit = true;
-        }
+        } else {
+          let edit = false;
+          if (item?.catalogCode) {
+            productEntry.fields = await removeFromRelationFields(
+              productEntry,
+              "catalogs",
+              item.catalogCode,
+              true
+            );
+            log(`edit catalogs`);
+            edit = true;
+          }
+          if (item?.categoryCode) {
+            const categoriesFieldKey =
+              "categories" + capitalizeFirstLetter(item.where);
+            productEntry.fields = await removeFromRelationFields(
+              productEntry,
+              categoriesFieldKey,
+              item.categoryCode,
+              true
+            );
+            log(`edit ${categoriesFieldKey}`);
+            edit = true;
+          }
+          if (item?.subfamilyCode) {
+            const subFamiliesFieldKey =
+              "subFamilies" + capitalizeFirstLetter(item.where);
+            productEntry.fields = await removeFromRelationFields(
+              productEntry,
+              subFamiliesFieldKey,
+              item.subfamilyCode,
+              true
+            );
+            log(`edit ${subFamiliesFieldKey}`);
+            edit = true;
+          }
+          if (item?.models) {
+            const modelsFieldKey = "models" + capitalizeFirstLetter(item.where);
+            productEntry.fields = await removeFromRelationFields(
+              productEntry,
+              modelsFieldKey,
+              item.models,
+              true
+            );
+            log(`edit ${modelsFieldKey}`);
+            edit = true;
+          }
+          if (item?.subModels) {
+            const subModelsFieldKey =
+              "subModels" + capitalizeFirstLetter(item.where);
+            productEntry.fields = await removeFromRelationFields(
+              productEntry,
+              subModelsFieldKey,
+              item.subModels,
+              true
+            );
+            log(`edit ${subModelsFieldKey}`);
+            edit = true;
+          }
 
-        const objectFieldsRelations: any = {
-          ACCESSORIES: "accessories",
-          SPARE_PARTS: "spareparts",
-          BULBS: "bulbs",
-        };
-
-        for (const objectFieldsRelationKey of Object.keys(
-          objectFieldsRelations
-        )) {
-          if (item.where === objectFieldsRelationKey) {
-            log(`Remove ${objectFieldsRelationKey} relations`);
-            const codes = item.codes?.split(",") ?? [];
-            if (codes.length) {
-              const fieldKey = objectFieldsRelations[objectFieldsRelationKey];
-              const lengthBefore =
-                productEntry.fields?.[fieldKey]?.[defaultEnvironmentLocaleCode]
-                  .length;
-
-              // Remove from the main product field
-              productEntry.fields = await removeFromFieldObject(
-                productEntry,
-                fieldKey,
-                codes
-              );
-              // Remove from the codes of field
-              await removeProductFromAllOfRelationFields(
-                productEntry.sys.id,
-                fieldKey,
-                codes
-              );
+          const objectFieldsRelations: any = {
+            ACCESSORIES: "accessories",
+            SPARE_PARTS: "spareparts",
+            BULBS: "bulbs",
+          };
 
-              const lengthAfter =
-                productEntry.fields?.[fieldKey]?.[defaultEnvironmentLocaleCode]
-                  .length;
-              if (lengthBefore !== lengthAfter) {
-                log(
-                  `edit field ${fieldKey} lengthBefore: ${lengthBefore} lengthAfter: ${lengthAfter}`
+          for (const objectFieldsRelationKey of Object.keys(
+            objectFieldsRelations
+          )) {
+            if (item.where === objectFieldsRelationKey) {
+              log(`Remove ${objectFieldsRelationKey} relations`);
+              const codes = item.codes?.split(",") ?? [];
+              if (codes.length) {
+                const fieldKey = objectFieldsRelations[objectFieldsRelationKey];
+                const lengthBefore =
+                  productEntry.fields?.[fieldKey]?.[
+                    defaultEnvironmentLocaleCode
+                  ].length;
+
+                // Remove from the main product field
+                productEntry.fields = await removeFromFieldObject(
+                  productEntry,
+                  fieldKey,
+                  codes
                 );
-                edit = true;
-              } else {
-                log(`No valid ${objectFieldsRelationKey} to remove found`);
+                // Remove from the codes of field
+                await removeProductFromAllOfRelationFields(
+                  productEntry.sys.id,
+                  fieldKey,
+                  codes
+                );
+
+                const lengthAfter =
+                  productEntry.fields?.[fieldKey]?.[
+                    defaultEnvironmentLocaleCode
+                  ].length;
+                if (lengthBefore !== lengthAfter) {
+                  log(
+                    `edit field ${fieldKey} lengthBefore: ${lengthBefore} lengthAfter: ${lengthAfter}`
+                  );
+                  edit = true;
+                } else {
+                  log(`No valid ${objectFieldsRelationKey} to remove found`);
+                }
               }
             }
           }
-        }
 
-        if (item.where === "DESIGNERS" && item?.codes) {
-          const lengthBefore =
-            productEntry.fields?.designer?.[defaultEnvironmentLocaleCode]
-              .length;
-          const designers = item.codes.split(",");
-          for (const designer of designers) {
-            log(
-              `Remove ${designer} designer to ${productEntry.sys.id} product if exists`
-            );
-            productEntry.fields = await removeFromRelationFields(
-              productEntry,
-              "designer",
-              designer,
-              false
-            );
-          }
+          if (item.where === "DESIGNERS" && item?.codes) {
+            const lengthBefore =
+              productEntry.fields?.designer?.[defaultEnvironmentLocaleCode]
+                .length;
+            const designers = item.codes.split(",");
+            for (const designer of designers) {
+              log(
+                `Remove ${designer} designer to ${productEntry.sys.id} product if exists`
+              );
+              productEntry.fields = await removeFromRelationFields(
+                productEntry,
+                "designer",
+                designer,
+                false
+              );
+            }
 
-          if (
-            lengthBefore !==
-            productEntry.fields?.designer?.[defaultEnvironmentLocaleCode].length
-          ) {
-            log(`edit designer`);
-            edit = true;
-          } else {
-            log(`No valid designer to remove found`);
+            if (
+              lengthBefore !==
+              productEntry.fields?.designer?.[defaultEnvironmentLocaleCode]
+                .length
+            ) {
+              log(`edit designer`);
+              edit = true;
+            } else {
+              log(`No valid designer to remove found`);
+            }
           }
-        }
 
-        if (edit) {
-          // lastPimSyncDate
-          productEntry.fields = await addFieldValue(
-            productEntry,
-            "lastPimSyncDate",
-            getLocalISOTime()
-          );
-          try {
-            log(`update ${productEntry.sys.id}`);
-            productEntry = await productEntry.update();
-            if (productEntry.isPublished()) {
-              try {
-                productEntry = await productEntry.publish();
-              } catch (err: any) {
-                log(`Cannot publish entry ${productEntry.sys.id}.`);
-                log(err);
+          if (edit) {
+            // lastPimSyncDate
+            productEntry.fields = await addFieldValue(
+              productEntry,
+              "lastPimSyncDate",
+              getLocalISOTime()
+            );
+            try {
+              log(`update ${productEntry.sys.id}`);
+              productEntry = await productEntry.update();
+              if (productEntry.isPublished()) {
+                try {
+                  productEntry = await productEntry.publish();
+                } catch (err: any) {
+                  log(`Cannot publish entry ${productEntry.sys.id}.`);
+                  log(err);
+                }
               }
+            } catch (err: any) {
+              log(`Cannot update entry ${productEntry.sys.id}.`);
+              log(err);
             }
-          } catch (err: any) {
-            log(`Cannot update entry ${productEntry.sys.id}.`);
-            log(err);
+          } else {
+            log(`No valid editable criteria found`);
+            console.log(productEntry.sys.id, "audit", audit);
           }
-        } else {
-          log(`No valid editable criteria found`);
-          console.log(productEntry.sys.id, "audit", audit);
         }
       }
+    } else {
+      log(
+        `No catalogs field found in the audit ${audit.product} product`,
+        "WARN"
+      );
     }
   } else {
     log(`It has not yet been defined how to process the state ${audit.what}`);
@@ -3242,3 +3253,45 @@ export const populateDestinations = async (offset: number, limit: number) => {
 
   return { completed: !total || total === count + offset, offset, limit };
 };
+
+export const purgeProductThumbCacheByProductCodes = async (
+  productCodes: string[]
+) => {
+  const defEnvLocaleCode = await getEnvironmentDefaultLocaleCode();
+
+  const productEntries = await getAllEntriesByCodes(
+    productCodes,
+    "topicProduct",
+    "sys,fields.thumbnailImgix"
+  );
+
+  let count: number = 0;
+  const total: number = productEntries.length;
+  for (const productEntry of productEntries) {
+    log(`${++count} of ${total}`);
+    const thumbEntryId =
+      productEntry.fields?.thumbnailImgix?.[defEnvLocaleCode]?.sys?.id;
+
+    if (thumbEntryId) {
+      let wrapperImgix = await getEntryByID(
+        thumbEntryId,
+        "wrapperImgix",
+        "sys,fields"
+      );
+      if (wrapperImgix) {
+        const imgixUrl =
+          wrapperImgix.fields?.imgixData?.[defEnvLocaleCode]?.url;
+        if (imgixUrl) {
+          log(`Cleaning cache for ${imgixUrl}`);
+          await purgeImageCacheByUrl(imgixUrl);
+        } else {
+          log(`No imgixUrl found in ${thumbEntryId} id`, "WARN");
+        }
+      } else {
+        log(`No wrapperImgix found with ${thumbEntryId} id`, "WARN");
+      }
+    } else {
+      log(`No thumbEntryId found in ${productEntry.sys.id}`, "WARN");
+    }
+  }
+};

package/types/index.d.ts

@@ -8,7 +8,7 @@ export { importModels } from "./pim/methods/models";
 export { importSubModels } from "./pim/methods/submodels";
 export { importSubFamilies } from "./pim/methods/subfamilies";
 export { importFamilies } from "./pim/methods/families";
-export { importProductByCode, setProductsRelationships, setProductRelationships, getAllProductEntriesByCatalog, audit, generateTechSpecPdf, setProductsAutodescription, getProductAutodescription, setProductAutodescriptionByTopicId, removeProductFromColorVariantsByProductLine, removeAllProductModelProductRelations, getProductPageIdByCode, reimportAuditProducts, populateDestinations, } from "./pim/methods/products";
+export { importProductByCode, setProductsRelationships, setProductRelationships, getAllProductEntriesByCatalog, audit, generateTechSpecPdf, setProductsAutodescription, getProductAutodescription, setProductAutodescriptionByTopicId, removeProductFromColorVariantsByProductLine, removeAllProductModelProductRelations, getProductPageIdByCode, reimportAuditProducts, populateDestinations, purgeProductThumbCacheByProductCodes, } from "./pim/methods/products";
 export { publishAllProductDrafts } from "./pim/methods/bulkPublish";
 export { getIndex } from "./algolia/config";
 export { reindexFamilies, reindexFamily, removeFamilyObject, } from "./algolia/families";

package/types/libs/imgix.d.ts

@@ -13,3 +13,4 @@ export declare const getDefaultWrapperImgixAttributesByPimUrl: (pimUrl: string)
 export declare const getWrapperImgixFields: (wrapperImgixId: string) => Promise<{}>;
 export declare const getWrapperImgixAttributesByAsset: (imgixAttributes: ImgixAttributes) => Promise<ImgixData>;
 export declare const uploadAssetByUrl: (url: string) => Promise<ImgixData | undefined>;
+export declare const purgeImageCacheByUrl: (url: string) => Promise<void>;

package/types/pim/methods/products.d.ts

@@ -72,3 +72,4 @@ export declare const populateDestinations: (offset: number, limit: number) => Pr
     offset: number;
     limit: number;
 }>;
+export declare const purgeProductThumbCacheByProductCodes: (productCodes: string[]) => Promise<void>;