pim-import 4.3.0 → 4.4.0

package/src/algolia/subModels.ts

@@ -23,8 +23,8 @@ import {
   getLocalISOTime,
   secondBetweenTwoDate,
   capitalizeFirstLetter,
-  keysToLowerCase,
   addProductFieldValueCodesByPimDetails,
+  getAllTranslations,
 } from "../utils";
 import productFieldsRequiredData from "../pim/data/productFields.json";
 import { getWrapperImgixFields } from "../libs/imgix";
@@ -154,8 +154,7 @@ const getObject = async (
   const catalogs = await getTopicDetails(
     topicSubModelWithFields,
     "catalog",
-    "topicCatalog",
-    true
+    "topicCatalog"
   );
   const catalog = catalogs?.[0];
   let productFields = [];
@@ -179,8 +178,7 @@ const getObject = async (
   const productLines = await getTopicDetails(
     topicSubModelWithFields,
     "productLine",
-    "topicProductLine",
-    true
+    "topicProductLine"
   );
   const productLine = productLines?.[0];
 
@@ -188,8 +186,7 @@ const getObject = async (
   const parentModels = await getTopicDetails(
     topicSubModelWithFields,
     "parentModel",
-    "topicModel",
-    true
+    "topicModel"
   );
   const parentModel = parentModels?.[0];
 
@@ -198,7 +195,6 @@ const getObject = async (
     topicSubModelWithFields,
     "subFamily",
     "topicSubFamily",
-    true,
     false,
     true,
     true
@@ -219,11 +215,15 @@ const getObject = async (
 
   const record: AlgoliaSubModelRecord = {
     objectID: topicSubModelWithFields.sys.id,
-    names: keysToLowerCase(topicSubModelWithFields?.fields?.name) || {},
+    names: await getAllTranslations(
+      topicSubModelWithFields?.fields?.name || {}
+    ),
     code:
       topicSubModelWithFields?.fields?.code?.[defaultEnvironmentLocaleCode] ||
       "",
-    description: topicSubModelWithFields?.fields?.description || {},
+    description: await getAllTranslations(
+      topicSubModelWithFields?.fields?.description || {}
+    ),
     thumbnailImgix,
     catalog,
     productLine,

package/src/index.ts

@@ -44,7 +44,7 @@ export {
   removeAllProductModelProductRelations,
   getProductPageIdByCode,
 } from "./pim/methods/products";
-export { publishAllDraftProducts } from "./pim/methods/bulkPublish";
+export { publishAllProductDrafts } from "./pim/methods/bulkPublish";
 // export {
 //   createOrUpdateCatalogPages,
 //   createOrUpdateCatalogPageByCode,

package/src/libs/contentful-cda.ts

@@ -6,7 +6,11 @@ import {
   AssetPropFieldsWithoutLocaleKey,
   OtherFilters,
 } from "../types";
-import { getPimTranslations, keysToLowerCase } from "../utils";
+import {
+  getPimTranslations,
+  keysToLowerCase,
+  getAllTranslations,
+} from "../utils";
 import { log } from "./logs";
 const contentful = require("contentful");
 
@@ -255,16 +259,15 @@ export const getEntryImageDetails = async (entry: Entry, fieldKey: string) => {
  * @param topicEntry
  * @param fieldKey
  * @param contentType
- * @param lowerCaseKeys Default false
  * @param showRelatedEntities Default false
  * @param isCatalogEntry Default true
+ * @param skipPageSlugs Default false
  * @returns
  */
 export const getTopicDetails = async (
   topicEntry: Entry,
   fieldKey: string,
   contentType: string,
-  lowerCaseKeys: boolean = false,
   showRelatedEntities: boolean = false,
   isCatalogEntry: boolean = true,
   skipPageSlugs: boolean = false
@@ -302,10 +305,7 @@ export const getTopicDetails = async (
     if (entries) {
       for (const entry of entries) {
         const data: TopicDetailsResponse = {
-          names:
-            entry?.fields?.name && lowerCaseKeys
-              ? keysToLowerCase(entry.fields.name)
-              : {},
+          names: await getAllTranslations(entry?.fields?.name || {}),
           code: entry?.fields?.code?.[defEnvLocaleCode],
         };
         if (!skipPageSlugs) {
@@ -316,10 +316,7 @@ export const getTopicDetails = async (
           } else {
             entryPage = await getTopicPage(entry.sys.id);
           }
-          data.slugs =
-            entryPage?.fields?.slug && lowerCaseKeys
-              ? keysToLowerCase(entryPage.fields.slug)
-              : {};
+          data.slugs = await getAllTranslations(entryPage?.fields?.slug || {});
         }
 
         if (contentType === "topicSubFamily" && showRelatedEntities) {
@@ -377,10 +374,15 @@ export const getSubFamilySlugDetails = async (topicSubFamily: Entry) => {
     : {};
 
   return {
-    catalogPageSlugs: keysToLowerCase(subFamilyCatalogPage?.fields?.slug) || {},
-    familyPageSlugs: keysToLowerCase(subFamilyFamilyPage?.fields?.slug) || {},
-    categoryPageSlugs:
-      keysToLowerCase(subFamilyCategoryPage?.fields?.slug) || {},
+    catalogPageSlugs: await getAllTranslations(
+      subFamilyCatalogPage?.fields?.slug || {}
+    ),
+    familyPageSlugs: await getAllTranslations(
+      subFamilyFamilyPage?.fields?.slug || {}
+    ),
+    categoryPageSlugs: await getAllTranslations(
+      subFamilyCategoryPage?.fields?.slug || {}
+    ),
   };
 };
 

package/src/libs/contentful.ts

@@ -31,6 +31,7 @@ import {
   getPimTranslations,
   keysToLowerCase,
   replaceAll,
+  getAllTranslations,
 } from "../utils";
 import { getSubFamilySlugDetails } from "../pim/methods/subfamilies";
 import { removeProductObject } from "../algolia/products";
@@ -1094,18 +1095,18 @@ export const addFieldValue = async (
  * @param topicEntry
  * @param fieldKey
  * @param contentType
- * @param lowerCaseKeys Default false
  * @param showRelatedEntities Default false
  * @param isCatalogEntry Default true
+ * @param skipPageSlugs Default false
  * @returns
  */
 export const getTopicDetails = async (
   topicEntry: Entry,
   fieldKey: string,
   contentType: string,
-  lowerCaseKeys: boolean = false,
   showRelatedEntities: boolean = false,
-  isCatalogEntry: boolean = true
+  isCatalogEntry: boolean = true,
+  skipPageSlugs: boolean = false
 ): Promise<TopicDetailsResponse[]> => {
   const defEnvLocaleCode = await getEnvironmentDefaultLocaleCode();
   const isHasToManyField = Array.isArray(
@@ -1138,36 +1139,26 @@ export const getTopicDetails = async (
     );
 
     if (entries) {
-      let count = 0;
       for (const entry of entries) {
-        let entryPage: any = {};
-        if (isCatalogEntry) {
-          const entryPageId = `${entry.sys.id}_PAGE`;
-          entryPage = await getEntryByID(entryPageId, "page", "fields.slug");
-        } else {
-          entryPage = await getTopicPage(entry.sys.id);
-        }
-
         const data: TopicDetailsResponse = {
-          names:
-            entry?.fields?.name && lowerCaseKeys
-              ? keysToLowerCase(entry.fields.name)
-              : {},
+          names: await getAllTranslations(entry?.fields?.name || {}),
           code: entry?.fields?.code?.[defEnvLocaleCode],
-          slugs:
-            entryPage?.fields?.slug && lowerCaseKeys
-              ? keysToLowerCase(entryPage.fields.slug)
-              : {},
         };
+        if (!skipPageSlugs) {
+          let entryPage: any = {};
+          if (isCatalogEntry) {
+            const entryPageId = `${entry.sys.id}_PAGE`;
+            entryPage = await getEntryByID(entryPageId, "page", "fields.slug");
+          } else {
+            entryPage = await getTopicPage(entry.sys.id);
+          }
+          data.slugs = await getAllTranslations(entryPage?.fields?.slug || {});
+        }
 
         if (contentType === "topicSubFamily" && showRelatedEntities) {
           data.details = await getSubFamilySlugDetails(entry);
         }
 
-        if (++count > 0 && count % 7 === 0) {
-          await sleep(2000, true);
-        }
-
         items.push(data);
       }
     }

package/src/libs/imgix.ts

@@ -9,7 +9,7 @@ import {
 import axios from "@atoms-studio/axios";
 import https from "https";
 import mime from "mime-types";
-import { basename } from "../utils";
+import { basename, getAllTranslations } from "../utils";
 
 let imgix: ImgixAPI;
 export const getImgix = () => {
@@ -204,9 +204,11 @@ export const getWrapperImgixFields = async (wrapperImgixId: string) => {
     focalPoint:
       wrapperImgix?.fields?.focalPoint?.[defaultEnvironmentLocaleCode]
         ?.focalPoint || {},
-    altText: wrapperImgix?.fields?.altText || {},
-    caption: wrapperImgix?.fields?.caption || {},
-    hoverTitle: wrapperImgix?.fields?.hoverTitle || {},
+    altText: await getAllTranslations(wrapperImgix?.fields?.altText || {}),
+    caption: await getAllTranslations(wrapperImgix?.fields?.caption || {}),
+    hoverTitle: await getAllTranslations(
+      wrapperImgix?.fields?.hoverTitle || {}
+    ),
     forceHoverTitle:
       !!wrapperImgix?.fields?.forceHoverTitle?.[defaultEnvironmentLocaleCode],
   };

package/src/pim/methods/bulkPublish.ts

@@ -5,7 +5,7 @@ import {
   getEntryByID,
   getEnvironment,
 } from "../../libs/contentful";
-import { log } from "../../libs/logs";
+import { log, serverUtils } from "../../libs/logs";
 import { getProductPageIdByCode } from "./products";
 import { reindexProduct } from "../../algolia/products";
 
@@ -194,21 +194,22 @@ export const publishTopicProduct = async (productEntry: Entry) => {
   await productEntry.publish();
 };
 
-export const publishAllDraftProducts = async (
+export const publishAllProductDrafts = async (
   filters: { catalog?: AvailableCatalogs; family?: string },
-  skip: number = 0,
   limit: number = 100
 ) => {
-  log(
-    `publishAllDraftProductsByCatalog catalog: ${filters?.catalog} family: ${filters?.family} skip: ${skip} limit: ${limit}`
-  );
+  let logMsg = `publishAllProductDrafts catalog: ${filters?.catalog} family: ${filters?.family} limit: ${limit}`;
+  log(logMsg);
+  if (serverUtils) {
+    serverUtils.log(logMsg);
+  }
   const env = await getEnvironment();
   const defEnvLocaleCode = await getEnvironmentDefaultLocaleCode();
 
   const opts: any = {
     content_type: "topicProduct",
     limit,
-    skip,
+    skip: 0,
     locale: defEnvLocaleCode,
     "sys.archivedAt[exists]": false,
     "sys.publishedAt[exists]": false,
@@ -222,26 +223,44 @@ export const publishAllDraftProducts = async (
   }
   const { items, total } = await env.getEntries(opts);
 
-  let count = skip;
+  let count = 0;
   for (const item of items) {
-    log(`${++count} of ${limit} - total: ${total}`);
+    logMsg = `${++count} of ${limit} - total: ${total}`;
+    log(logMsg);
+    if (serverUtils) {
+      serverUtils.log(logMsg);
+    }
     if (["0000000-TEST"].includes(item.sys.id)) {
-      log(`Skip product test ${item.sys.id}`);
+      logMsg = `Skip product test ${item.sys.id}`;
     } else {
       try {
-        log(`Publishing product: ${item.sys.id}`);
+        logMsg = `Publishing product: ${item.sys.id}`;
+        if (serverUtils) {
+          serverUtils.log(logMsg);
+        }
         await publishTopicProduct(item);
-        log(`Reindex product: ${item.sys.id}`);
+        logMsg = `Reindex product: ${item.sys.id}`;
+        if (serverUtils) {
+          serverUtils.log(logMsg);
+        }
         await reindexProduct(item.sys.id, true);
+
+        if (serverUtils) {
+          const progress = Math.floor((count / items.length) * 100);
+          serverUtils.updateProgress(progress);
+        }
       } catch (err) {
-        log(`Publish entry ${item.sys.id} failed`);
+        logMsg = `Publish entry ${item.sys.id} failed`;
+        if (serverUtils) {
+          serverUtils.log(logMsg);
+        }
       }
     }
   }
-  const completed = Number(skip) + Number(limit) >= total;
-  if (!completed) {
-    publishAllDraftProducts(filters, 0, limit);
-  } else {
-    log("Completed!");
-  }
+
+  const completed = Number(limit) >= total;
+  return {
+    completed,
+    total,
+  };
 };

package/src/utils.ts

@@ -8,6 +8,7 @@ import {
 } from "./types";
 import { AssetsEntity } from "./resources/ProductDetails";
 import { log } from "./libs/logs";
+import { cfLocales, getEnvironmentDefaultLocaleCode } from "./libs/contentful";
 
 /**
  * Merge two objects
@@ -326,3 +327,24 @@ export const replaceAll = (original: string, from: string, to: string) => {
   const regExp = new RegExp(from, "g");
   return original.replace(regExp, to);
 };
+
+/**
+ * Get all locale translations
+ *
+ *
+ * @param {object} values
+ *
+ * @example getAllTranslations({en:foo}) => {en:foo, it: foo, de: foo...}
+ *
+ * @returns
+ */
+export const getAllTranslations = async (values: any) => {
+  const defaultLocale = await getEnvironmentDefaultLocaleCode();
+
+  const newValue: any = {};
+  for (const locale of cfLocales) {
+    newValue[locale] = values?.[locale] || values[defaultLocale] || "";
+  }
+
+  return keysToLowerCase(newValue);
+};

package/types/index.d.ts

@@ -9,7 +9,7 @@ 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, } from "./pim/methods/products";
-export { publishAllDraftProducts } from "./pim/methods/bulkPublish";
+export { publishAllProductDrafts } from "./pim/methods/bulkPublish";
 export { resetIndexSettings } from "./algolia/config";
 export { reindexFamilies, reindexFamily, removeFamilyObject, } from "./algolia/families";
 export { reindexSubFamilies, reindexSubFamily, removeSubFamilyObject, } from "./algolia/subFamilies";

package/types/libs/contentful-cda.d.ts

@@ -8,7 +8,7 @@ export declare const getEntryByID: (entryID: string, contentTypeId: string, sele
 export declare const getAllEntries: (contentType: string, select?: string | undefined, filterKey?: string | undefined, filterValue?: string | undefined, limit?: number, otherFilters?: OtherFilters[] | undefined, include?: number) => Promise<Entry[]>;
 export declare const getAssetDetails: (assetId: string) => Promise<AssetPropFieldsWithoutLocaleKey>;
 export declare const getEntryImageDetails: (entry: Entry, fieldKey: string) => Promise<string>;
-export declare const getTopicDetails: (topicEntry: Entry, fieldKey: string, contentType: string, lowerCaseKeys?: boolean, showRelatedEntities?: boolean, isCatalogEntry?: boolean, skipPageSlugs?: boolean) => Promise<TopicDetailsResponse[]>;
+export declare const getTopicDetails: (topicEntry: Entry, fieldKey: string, contentType: string, showRelatedEntities?: boolean, isCatalogEntry?: boolean, skipPageSlugs?: boolean) => Promise<TopicDetailsResponse[]>;
 export declare const getSubFamilySlugDetails: (topicSubFamily: Entry) => Promise<{
     catalogPageSlugs: any;
     familyPageSlugs: any;

package/types/libs/contentful.d.ts

@@ -47,7 +47,7 @@ export declare const deleteEntries: (contentType: string, catalogCode?: Availabl
 export declare const addToRelationFields: (entry: Entry | any, fieldKey: string, entrySysIdValue: string, manyReferences?: boolean, resetOldValues?: boolean, linkType?: "Asset" | "Entry") => Promise<Entry>;
 export declare const removeFromRelationFields: (entry: Entry | any, fieldKey: string, entrySysIdValue: string, manyReferences?: boolean) => Promise<any>;
 export declare const addFieldValue: (entry: Entry | any, fieldKey: string, fieldValue: any, manyReferences?: boolean) => Promise<any>;
-export declare const getTopicDetails: (topicEntry: Entry, fieldKey: string, contentType: string, lowerCaseKeys?: boolean, showRelatedEntities?: boolean, isCatalogEntry?: boolean) => Promise<TopicDetailsResponse[]>;
+export declare const getTopicDetails: (topicEntry: Entry, fieldKey: string, contentType: string, showRelatedEntities?: boolean, isCatalogEntry?: boolean, skipPageSlugs?: boolean) => Promise<TopicDetailsResponse[]>;
 export declare const getAssetDetails: (assetId: string) => Promise<AssetPropFields>;
 export declare const getEntryImageDetails: (entry: Entry, fieldKey: string) => Promise<string>;
 export declare const getDictionaryJson: () => Promise<any>;

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

@@ -1,7 +1,10 @@
 import { AvailableCatalogs } from "../../types";
 import type { Entry } from "contentful-management/dist/typings/entities/entry";
 export declare const publishTopicProduct: (productEntry: Entry) => Promise<void>;
-export declare const publishAllDraftProducts: (filters: {
+export declare const publishAllProductDrafts: (filters: {
     catalog?: AvailableCatalogs;
     family?: string;
-}, skip?: number, limit?: number) => Promise<void>;
+}, limit?: number) => Promise<{
+    completed: boolean;
+    total: number;
+}>;

package/types/utils.d.ts

@@ -17,3 +17,4 @@ export declare const capitalizeFirstLetter: (text: string) => string;
 export declare const keysToLowerCase: (obj: any, includeNestedKeys?: boolean) => any;
 export declare const addProductFieldValueCodesByPimDetails: (pimDetails: any, productFields: any, fieldKey: string, fieldParentKey?: string | undefined) => string[];
 export declare const replaceAll: (original: string, from: string, to: string) => string;
+export declare const getAllTranslations: (values: any) => Promise<any>;