pim-import 5.0.1 → 5.0.2

package/src/algolia/subFamilies.ts

@@ -1,709 +0,0 @@
-/**
- * SubFamilies index
- */
-import {
-  getClient,
-  getEnvironmentDefaultLocaleCode,
-  getEntryByID,
-  getAllEntries,
-  getTopicDetails,
-} from "../libs/contentful-cda";
-import { AlgoliaPaginateRecords, AvailableCatalogs } from "../types";
-import type { Entry } from "contentful-management/dist/typings/entities/entry";
-import { log, serverUtils } from "../libs/logs";
-import { getIndex, AvailableIndicesKey, removeIndexObject } from "./config";
-import {
-  getLocalISOTime,
-  sanitizeValue,
-  secondBetweenTwoDate,
-  addProductFieldValueCodesByPimDetails,
-  getCertificationFilters,
-  capitalizeFirstLetter,
-  getAllTranslations,
-} from "../utils";
-import { getWrapperImgixFields } from "../libs/imgix";
-import { AlgoliaFamilyRecord, pageResponse } from "./families";
-import { getSubFamilyPageSlugWithDetails } from "../pim/methods/subfamilies";
-// import fs from "fs";
-
-const indexKey: AvailableIndicesKey = "subFamilies";
-
-const getSubFamilyPage = async (
-  topicSubFamily: Entry
-): Promise<pageResponse> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const subFamilyPage = await getEntryByID(
-    `${topicSubFamily.sys.id}_PAGE`,
-    "page"
-  );
-  if (!subFamilyPage) {
-    log(`${topicSubFamily.sys.id}_PAGE not found`, "WARN");
-    return {
-      slugs: {},
-      type: "",
-      // details: {},
-    };
-  }
-
-  const subFamilyPageId = subFamilyPage.sys.id;
-
-  // check if subFamily has many relations with model
-  log(`check if subFamily has many relations with model`);
-  const client = await getClient();
-  const { items: modelEntries } = await client.withAllLocales.getEntries({
-    content_type: "topicModel",
-    "fields.subFamily.sys.id": subFamilyPageId.replace("_PAGE", ""),
-    limit: 2,
-    select: "sys,fields.catalog,fields.subFamily",
-  });
-
-  if (modelEntries?.length === 1) {
-    log(`Return model page slug`);
-    // Return model page slug
-    const modelEntry = modelEntries[0];
-    const modelPageId = `${modelEntry.sys.id}_PAGE`;
-    const modelPage = await getEntryByID(
-      modelPageId,
-      "page",
-      "fields.slug,fields.type"
-    );
-
-    // const catalogEntryId =
-    //   modelEntry?.fields?.catalog?.[defaultEnvironmentLocaleCode]?.sys?.id;
-    // const modelCatalogPage: any = catalogEntryId
-    //   ? await getEntryByID(`${catalogEntryId}_PAGE`, "page", "fields.slug")
-    //   : {};
-    // const subFamilyEntryId =
-    //   modelEntry?.fields?.subFamily?.[defaultEnvironmentLocaleCode]?.sys?.id;
-    // const modelCatalogSubFamilyPage: any = subFamilyEntryId
-    //   ? await getEntryByID(`${subFamilyEntryId}_PAGE`, "page", "fields.slug")
-    //   : {};
-    if (modelPage) {
-      return {
-        slugs: modelPage?.fields?.slug,
-        type: modelPage?.fields?.type?.[defaultEnvironmentLocaleCode],
-        // details: {
-        //   catalogPageSlugs:
-        //     keysToLowerCase(modelCatalogPage?.fields?.slug) || {},
-        //   subFamilyPageSlugs:
-        //     keysToLowerCase(modelCatalogSubFamilyPage?.fields?.slug) || {},
-        // },
-      };
-    } else {
-      log(`The modelPage with id "${modelPageId}" not found`, "WARN");
-    }
-  }
-
-  // Return SubFamily page slug
-  if (subFamilyPage) {
-    log(`Return SubFamily page slug`);
-    return getSubFamilyPageSlugWithDetails(topicSubFamily);
-  } else {
-    log(
-      `The subFamilyPage with id "${topicSubFamily.sys.id}_PAGE" not found`,
-      "WARN"
-    );
-  }
-
-  // if it doesn't find any slugs
-  log(`slug not found`, "WARN");
-  return null;
-};
-
-const getProductFields = async (
-  topicSubFamily: Entry,
-  destination: "PROFESSIONAL_GLOBAL" | "PROFESSIONAL_US" = "PROFESSIONAL_GLOBAL"
-): Promise<any> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const catalogName = capitalizeFirstLetter(
-    (
-      topicSubFamily.fields.catalog?.[defaultEnvironmentLocaleCode]?.sys.id ||
-      ""
-    ).toLowerCase()
-  );
-  if (!catalogName) {
-    log(`Cannot find catalog name`, "WARN");
-    return {};
-  }
-
-  const fieldName = `subFamilies${catalogName}`;
-
-  const topicProductEntries = await getAllEntries(
-    "topicProduct",
-    "sys,fields.productFields",
-    `fields.${fieldName}.sys.id[in]`,
-    `${topicSubFamily.sys.id}`,
-    50,
-    [{ key: "fields.destinations[in]", value: destination }]
-  );
-  if (!topicProductEntries?.length) {
-    log(`No products founded for subFamily ${topicSubFamily.sys.id}`, "WARN");
-    return false;
-  } else {
-    log(`${topicProductEntries?.length} products founded`);
-  }
-
-  let productFields: any = {};
-  productFields.availableTo = [];
-  const allDestinations =
-    topicSubFamily?.fields?.destinations?.[defaultEnvironmentLocaleCode] || [];
-  productFields.totalProducts = {};
-  for (const destination of allDestinations) {
-    productFields.totalProducts[destination] = topicProductEntries.filter(
-      (topicProductEntry) =>
-        topicProductEntry?.fields?.productFields?.[
-          defaultEnvironmentLocaleCode
-        ]?.destinations?.find(
-          (productDestination: any) => productDestination.code === destination
-        )
-    ).length;
-  }
-
-  for (const topicProduct of topicProductEntries) {
-    if (topicProduct?.fields?.productFields?.[defaultEnvironmentLocaleCode]) {
-      const pimDetails =
-        topicProduct?.fields?.productFields?.[defaultEnvironmentLocaleCode];
-
-      // AVAILABLE TO
-      if (
-        pimDetails.visibleToShop &&
-        !productFields.availableTo.includes("visibleToShop")
-      ) {
-        productFields.availableTo.push("visibleToShop");
-      }
-      if (
-        pimDetails.quickDelivery &&
-        !productFields.availableTo.includes("quickDelivery")
-      ) {
-        productFields.availableTo.push("quickDelivery");
-      }
-
-      if (!productFields?.certification) {
-        productFields.certification = [];
-      }
-
-      // CERTIFICATION - ENEC | PIM certification->enec
-      if (
-        pimDetails?.certification?.enec?.code &&
-        sanitizeValue(pimDetails.certification.enec.code) &&
-        productFields?.certification.indexOf("ENEC") === -1
-      ) {
-        productFields.certification.push("ENEC");
-      }
-      // CERTIFICATION - UL | PIM certification->ul
-      if (
-        pimDetails?.certification?.ul?.code &&
-        sanitizeValue(pimDetails.certification.ul.code) &&
-        productFields?.certification.indexOf("UL") === -1
-      ) {
-        productFields.certification.push("UL");
-      }
-
-      // MOUNTINGS [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "mountings"
-      );
-
-      // LOCATIONS [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "locations"
-      );
-
-      // ORINTATIONS [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "orientations",
-        "physical"
-      );
-
-      // LENGTH (MM)
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "length",
-        "physical"
-      );
-
-      // LENGTH (IN)
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "length_us",
-        "physical"
-      );
-
-      // SHAPE
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "shapes",
-        "physical"
-      );
-
-      // POWER (W) | PIM wPower
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "wPower",
-        "electrical"
-      );
-
-      // System flux (lm) | PIM realNetFlow
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "realNetFlow",
-        "photometric"
-      );
-
-      // CCT (K) [Only one] | PIM temperatureColor
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "temperatureColor",
-        "photometric"
-      );
-
-      // CRI> [Only one]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "cri",
-        "photometric"
-      );
-
-      // Dimmable| PIM dimming [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "dimming",
-        "electrical"
-      );
-
-      // | PIM bucketColours [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "bucketColours"
-      );
-
-      // DRIVER TYPE | PIM powerSupplyType [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "powerSupplyType",
-        "electrical"
-      );
-
-      // LIGHTING DISTRIBUTIONS | PIM powerSupplyType [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "lightingDistributions",
-        "optical"
-      );
-
-      // OPTICAL TYPE [Only one]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "opticalType",
-        "optical"
-      );
-
-      // MARKETS [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "markets"
-      );
-
-      // UPGRADE
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "upgrade"
-      );
-
-      // CERTIFICATIONS;
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "certifications"
-      );
-
-      // EXTERNAL IP
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "externalIp",
-        "marking"
-      );
-
-      // INTERNAL IP
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "ipCategory",
-        "marking"
-      );
-
-      // IP
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "ipRating",
-        "marking"
-      );
-
-      // MARKINGS
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "markings",
-        "marking"
-      );
-
-      // log(`Get certificationFilters details...`);
-      productFields.certificationFilters = getCertificationFilters(pimDetails);
-
-      // log(`Get filterableCertifications details...`);
-      const filterableCertificationsFields = ["enec", "ul", "certificates"];
-      for (const filterableCertificationsField of filterableCertificationsFields) {
-        productFields = addProductFieldValueCodesByPimDetails(
-          pimDetails,
-          productFields,
-          filterableCertificationsField,
-          "certification",
-          "filterableCertifications",
-          false,
-          true
-        );
-      }
-
-      if (!productFields?.certification) {
-        productFields.certification = {};
-      }
-
-      productFields.certification.enecCertified =
-        !!productFields.certification?.enecCertified;
-
-      // DESTINATIONS
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "destinations"
-      );
-    }
-  }
-
-  return productFields;
-};
-
-const isObjectToDelete = (
-  object: any,
-  defaultEnvironmentLocaleCode: string
-) => {
-  return (
-    !object?.productFields || !object?.slugs?.[defaultEnvironmentLocaleCode]
-  );
-};
-
-const getObject = async (
-  topicSubFamily: Entry
-): Promise<AlgoliaFamilyRecord> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  log(`Get details of the ${topicSubFamily.sys.id} topicSubFamily`);
-  const topicSubFamilyWithFields = await getEntryByID(
-    topicSubFamily.sys.id,
-    "topicSubFamily"
-  );
-
-  log(`Get page details...`);
-  const page = await getSubFamilyPage(topicSubFamilyWithFields);
-  log(`Slugs type: ${page?.type}`);
-
-  log(`Get catalogs details...`);
-  const catalogs = await getTopicDetails(
-    topicSubFamilyWithFields,
-    "catalog",
-    "topicCatalog"
-  );
-  log(`${catalogs?.length} catalogs founded`);
-
-  log(`Get categories details...`);
-  const categories = await getTopicDetails(
-    topicSubFamilyWithFields,
-    "category",
-    "topicCategory"
-  );
-  log(`${categories?.length} categories founded`);
-
-  log(`Get family details...`);
-  const families = await getTopicDetails(
-    topicSubFamilyWithFields,
-    "parentFamily",
-    "topicFamily"
-  );
-  const parentFamily = families?.[0];
-  log(`${parentFamily?.code} family founded`);
-
-  log(`Get productFields details...`);
-  const productFields = await getProductFields(topicSubFamilyWithFields);
-  log(`Get productFieldsUs details...`);
-  const productFieldsUs = await getProductFields(
-    topicSubFamilyWithFields,
-    "PROFESSIONAL_US"
-  );
-
-  const isNew: boolean =
-    topicSubFamilyWithFields?.fields?.isNew?.[defaultEnvironmentLocaleCode] ||
-    false;
-
-  log(`Get thumbnail imgix details...`);
-  let thumbnailImgix = {};
-  const thumbnailImgixWrapperImgixID =
-    topicSubFamilyWithFields?.fields?.thumbnailImgix?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (thumbnailImgixWrapperImgixID) {
-    thumbnailImgix = await getWrapperImgixFields(thumbnailImgixWrapperImgixID);
-  } else {
-    log(`No thumbnail imgix found`, "WARN");
-  }
-
-  log(`Get thumbnail imgix portrait details...`);
-  let thumbnailImgixPortrait = {};
-  const thumbnailImgixPortraitWrapperImgixID =
-    topicSubFamilyWithFields?.fields?.thumbnailImgixPortrait?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (thumbnailImgixPortraitWrapperImgixID) {
-    thumbnailImgixPortrait = await getWrapperImgixFields(
-      thumbnailImgixPortraitWrapperImgixID
-    );
-  } else {
-    log(`No thumbnail imgix portrait found`, "WARN");
-  }
-
-  log(`Get thumbnail still life imgix details...`);
-  let thumbnailStillLifeImgix = {};
-  const thumbnailStillLifeImgixWrapperImgixID =
-    topicSubFamilyWithFields?.fields?.thumbnailStillLifeImgix?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (thumbnailStillLifeImgixWrapperImgixID) {
-    thumbnailStillLifeImgix = await getWrapperImgixFields(
-      thumbnailStillLifeImgixWrapperImgixID
-    );
-  } else {
-    log(`No thumbnail still life imgix found`, "WARN");
-  }
-
-  log(`Get thumbnail still life imgix portrait details...`);
-  let thumbnailStillLifeImgixPortrait = {};
-  const thumbnailStillLifeImgixPortraitWrapperImgixID =
-    topicSubFamilyWithFields?.fields?.thumbnailStillLifeImgixPortrait?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (thumbnailStillLifeImgixPortraitWrapperImgixID) {
-    thumbnailStillLifeImgixPortrait = await getWrapperImgixFields(
-      thumbnailStillLifeImgixPortraitWrapperImgixID
-    );
-  } else {
-    log(`No thumbnail still life imgix portrait found`, "WARN");
-  }
-
-  log(`Get full screen imgix details...`);
-  let fullScreenImageImgix = {};
-  const fullScreenImageImgixWrapperImgixID =
-    topicSubFamilyWithFields?.fields?.fullScreenImageImgix?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (fullScreenImageImgixWrapperImgixID) {
-    fullScreenImageImgix = await getWrapperImgixFields(
-      fullScreenImageImgixWrapperImgixID
-    );
-  } else {
-    log(`No full screen imgix found`, "WARN");
-  }
-
-  log(`Get priority details...`);
-  const priority =
-    topicSubFamilyWithFields?.fields?.priority?.[
-      defaultEnvironmentLocaleCode
-    ] || 0;
-
-  // Single record
-  const record: AlgoliaFamilyRecord = {
-    objectID: topicSubFamilyWithFields.sys.id,
-    names: await getAllTranslations(
-      topicSubFamilyWithFields?.fields?.name || {}
-    ),
-    code:
-      topicSubFamilyWithFields?.fields?.code?.[defaultEnvironmentLocaleCode] ||
-      "",
-    thumbnailImgix,
-    thumbnailImgixPortrait,
-    thumbnailStillLifeImgix,
-    thumbnailStillLifeImgixPortrait,
-    fullScreenImageImgix,
-    slugs: await getAllTranslations(page?.slugs || {}),
-    slugType: page?.type || "",
-    // slugDetails: await getAllTranslations(page?.details || {}),
-    catalogs,
-    categories,
-    parentFamily,
-    productFields,
-    productFieldsUs,
-    priority,
-    isNew,
-    destinations:
-      topicSubFamilyWithFields?.fields?.destinations?.[
-        defaultEnvironmentLocaleCode
-      ] || [],
-    lastSyncDate: getLocalISOTime(),
-  };
-
-  return record;
-};
-
-const getObjects = async (
-  offset: number,
-  limit: number,
-  catalogCode?: AvailableCatalogs
-): Promise<AlgoliaPaginateRecords> => {
-  const client = await getClient();
-
-  const opts: any = {
-    content_type: "topicSubFamily",
-    limit,
-    skip: offset,
-    select: "sys",
-  };
-  if (catalogCode) {
-    opts["fields.catalog.sys.id"] = catalogCode;
-  }
-  const { items, total } = await client.withAllLocales.getEntries(opts);
-
-  const objects: AlgoliaFamilyRecord[] = [];
-  let count: number = Number(offset);
-  let current: number = 0;
-  for (const topicSubFamily of items) {
-    log(`${++count} of ${total}`, "INFO");
-    const timeStart = new Date();
-    const record = await getObject(topicSubFamily);
-    const timeEnd = new Date();
-    const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-    log(`Execution time: ${seconds} seconds`);
-    objects.push(record);
-    if (serverUtils) {
-      serverUtils.log(topicSubFamily.sys.id);
-      const progress = Math.floor((++current / items.length) * 100);
-      serverUtils.updateProgress(progress);
-    }
-  }
-
-  return {
-    objects,
-    offset: Number(offset) + Number(limit),
-    limit: Number(limit),
-    completed: count >= total, // if is true the import is completed
-    total,
-  };
-};
-
-export const reindexSubFamilies = async (
-  offset: number = 0,
-  limit: number = 50,
-  catalogCode?: AvailableCatalogs
-) => {
-  const timeStart = new Date();
-  log(
-    `reindexSubFamilies - offset: ${offset} limit: ${limit} catalog: ${catalogCode}`
-  );
-
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const records = await getObjects(offset, limit, catalogCode);
-  const objectsToSave = records.objects.filter(
-    (object) => !isObjectToDelete(object, defaultEnvironmentLocaleCode)
-  );
-  const objectIdsToDelete = records.objects
-    .filter((object) => isObjectToDelete(object, defaultEnvironmentLocaleCode))
-    .map((object) => object.objectID);
-
-  // Save records to Algolia
-  const index = getIndex(indexKey);
-  log(`Save ${objectsToSave.length} objects to ${index.indexName} index`);
-  const savedObjectIDs = await index.saveObjects(objectsToSave);
-  log(
-    `Delete ${objectIdsToDelete.length} objects from ${index.indexName} index`
-  );
-  const deletedObjectIDs = await index.deleteObjects(objectIdsToDelete);
-
-  const timeEnd = new Date();
-  const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-  log(`Execution time: ${seconds} seconds`);
-
-  return {
-    ...records,
-    savedObjectIDs: savedObjectIDs.objectIDs,
-    deletedObjectIDs: deletedObjectIDs.objectIDs,
-  };
-};
-
-export const reindexSubFamily = async (topicSubFamilyEntryId: string) => {
-  const timeStart = new Date();
-
-  log(`reindexSubFamily - entryId: ${topicSubFamilyEntryId} `);
-
-  // Get single object data
-  const topicSubFamily = await getEntryByID(
-    topicSubFamilyEntryId,
-    "topicSubFamily"
-  );
-
-  const index = getIndex(indexKey);
-  let record = null;
-  if (!topicSubFamily?.sys?.id) {
-    log(
-      `No topicSubFamily with id ${topicSubFamilyEntryId} found. Delete object if exists`,
-      "WARN"
-    );
-    record = await index.deleteObject(topicSubFamilyEntryId);
-    return { ...record };
-  }
-
-  const object = await getObject(topicSubFamily);
-
-  // @ts-ignore
-  // const jsonString = JSON.stringify(object, null, 2);
-  // fs.writeFile(`${topicSubFamily?.sys?.id}.json`, jsonString, (err: any) => {
-  //   if (err) throw err;
-  //   console.log("The file has been saved!");
-  // });
-
-  // Save record to Algolia
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  if (!isObjectToDelete(object, defaultEnvironmentLocaleCode)) {
-    log(`Save object`);
-    record = await index.saveObject(object);
-  } else {
-    log(`Delete object`);
-    record = await index.deleteObject(object.objectID);
-  }
-  const timeEnd = new Date();
-  const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-  log(`Execution time: ${seconds} seconds`);
-
-  return { ...record, ...object };
-};
-
-export const removeSubFamilyObject = async (objectId: string) => {
-  return removeIndexObject(objectId, indexKey);
-};