pim-import 5.0.0 → 5.0.2

package/src/algolia/families.ts

@@ -1,652 +0,0 @@
-/**
- * Families index
- */
-import {
-  getClient,
-  getEnvironmentDefaultLocaleCode,
-  getEntryByID,
-  getAllEntries,
-  getTopicDetails,
-} from "../libs/contentful-cda";
-import {
-  CfLocalizedEntryField,
-  TopicDetailsResponse,
-  AlgoliaPaginateRecords,
-  TopicProductFieldsResponse,
-  CfSys,
-  WrapperImageFields,
-  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,
-  keysToLowerCase,
-  addProductFieldValueCodesByPimDetails,
-  getCertificationFilters,
-} from "../utils";
-import { getSubFamilyPageSlugWithDetails } from "../pim/methods/subfamilies";
-import { getWrapperImgixFields } from "../libs/imgix";
-
-export type pageResponse = {
-  slugs: {};
-  type: string;
-  details?: {};
-} | null;
-
-export type AlgoliaFamilyRecord = {
-  objectID: string;
-  names: CfLocalizedEntryField;
-  code: string;
-  thumbnailImgix: WrapperImageFields | {};
-  thumbnailImgixPortrait?: WrapperImageFields | {};
-  thumbnailStillLifeImgix?: WrapperImageFields | {};
-  thumbnailStillLifeImgixPortrait?: WrapperImageFields | {};
-  fullScreenImageImgix: WrapperImageFields | {};
-  slugs: {} | null;
-  slugType: string | null;
-  // slugDetails: {} | null;
-  catalogs: TopicDetailsResponse[];
-  parentFamily?: TopicDetailsResponse;
-  categories: TopicDetailsResponse[];
-  productFields: TopicProductFieldsResponse[];
-  productFieldsUs: TopicProductFieldsResponse[];
-  isNew: boolean;
-  priority: number;
-  destinations?: string[];
-  lastSyncDate: string;
-};
-
-const indexKey: AvailableIndicesKey = "families";
-
-const getFamilyPage = async (topicFamily: Entry): Promise<pageResponse> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const familyPage = await getEntryByID(`${topicFamily.sys.id}_PAGE`, "page");
-  if (!familyPage) {
-    log(`${topicFamily.sys.id}_PAGE not found`, "WARN");
-    return {
-      slugs: {},
-      type: "",
-      details: {},
-    };
-  }
-
-  // check if family page has many relations with subFamily pages
-  const componentSubFamilyPages = familyPage.fields.contents?.[
-    defaultEnvironmentLocaleCode
-  ].find((item: CfSys) => item.sys.id === `CC_${topicFamily.sys.id}`);
-  const componentSubFamilyPagesEntry = await getEntryByID(
-    `${componentSubFamilyPages?.sys?.id}`,
-    "componentSubFamilyPages",
-    "fields.subfamilyPages"
-  );
-
-  const subFamilyPageIds =
-    componentSubFamilyPagesEntry?.fields?.subfamilyPages?.[
-      defaultEnvironmentLocaleCode
-    ].map((item: CfSys) => item.sys.id);
-
-  if (subFamilyPageIds?.length === 1) {
-    // Return subFamily or model page slug
-    const subFamilyPageId = subFamilyPageIds[0];
-
-    // 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) {
-      // 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
-    const subFamilyEntry = await getEntryByID(
-      subFamilyPageId.replace("_PAGE", ""),
-      "topicSubFamily",
-      "sys,fields.catalog,fields.category,fields.parentFamily"
-    );
-    if (subFamilyEntry) {
-      const subFamilyPageSlugWithDetails =
-        await getSubFamilyPageSlugWithDetails(subFamilyEntry);
-      if (subFamilyPageSlugWithDetails) {
-        return subFamilyPageSlugWithDetails;
-      }
-    } else {
-      log(
-        `${subFamilyPageId.replace("_PAGE", "")} subFamilyEntry not found`,
-        "WARN"
-      );
-    }
-  }
-
-  // Return Family page slug
-  if (familyPage) {
-    return {
-      slugs: familyPage?.fields?.slug,
-      type: familyPage?.fields?.type?.[defaultEnvironmentLocaleCode],
-      // details: {},
-    };
-  } else {
-    log(
-      `The familyPage with id "${topicFamily.sys.id}_PAGE" not found`,
-      "WARN"
-    );
-  }
-
-  // if it doesn't find any slugs
-  return null;
-};
-
-const getProductFields = async (
-  topicFamily: Entry,
-  destination: "PROFESSIONAL_GLOBAL" | "PROFESSIONAL_US" = "PROFESSIONAL_GLOBAL"
-): Promise<any> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const topicProductEntries = await getAllEntries(
-    "topicProduct",
-    "sys,fields.productFields",
-    "fields.families.sys.id[in]",
-    `${topicFamily.sys.id}`,
-    50,
-    [{ key: "fields.destinations[in]", value: destination }]
-  );
-  if (!topicProductEntries?.length) {
-    log(`No products founded for family ${topicFamily.sys.id}`, "WARN");
-    return false;
-  } else {
-    log(`${topicProductEntries?.length} products founded`);
-  }
-
-  let productFields: any = {};
-  productFields.availableTo = [];
-  productFields.totalProducts = topicProductEntries.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"
-      );
-
-      // 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"
-      );
-
-      // 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"
-      );
-
-      // IP
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "ipRating",
-        "marking"
-      );
-
-      // SHAPE
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "shapes",
-        "physical"
-      );
-
-      // CERTIFICATIONS
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "certifications"
-      );
-
-      // LOCATIONS [Has many]
-      productFields = addProductFieldValueCodesByPimDetails(
-        pimDetails,
-        productFields,
-        "locations"
-      );
-
-      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
-        );
-      }
-
-      if (!productFields?.filterableCertifications) {
-        productFields.filterableCertifications = {};
-      }
-
-      productFields.filterableCertifications.enecCertified =
-        !!pimDetails.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 (topicFamily: Entry): Promise<AlgoliaFamilyRecord> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  log(`Get details of the ${topicFamily.sys.id} topicFamily`);
-  const topicFamilyWithFields = await getEntryByID(
-    topicFamily.sys.id,
-    "topicFamily"
-  );
-
-  log(`Get page details...`);
-  const page = await getFamilyPage(topicFamilyWithFields);
-  log(`Slugs type: ${page?.type}`);
-
-  log(`Get catalogs details...`);
-  const catalogs = await getTopicDetails(
-    topicFamilyWithFields,
-    "catalogs",
-    "topicCatalog"
-  );
-  log(`${catalogs?.length} catalogs founded`);
-
-  log(`Get categories details...`);
-  const categories = await getTopicDetails(
-    topicFamilyWithFields,
-    "categories",
-    "topicCategory"
-  );
-  log(`${categories?.length} categories founded`);
-
-  log(`Get productFields details...`);
-  const productFields = await getProductFields(topicFamily);
-  log(`Get productFieldsUs details...`);
-  const productFieldsUs = await getProductFields(
-    topicFamily,
-    "PROFESSIONAL_US"
-  );
-
-  const isNew: boolean =
-    topicFamilyWithFields?.fields?.isNew?.[defaultEnvironmentLocaleCode] ||
-    false;
-
-  log(`Get thumbnail imgix details...`);
-  let thumbnailImgix = {};
-  const thumbnailImgixWrapperImgixID =
-    topicFamilyWithFields?.fields?.thumbnailImgix?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (thumbnailImgixWrapperImgixID) {
-    thumbnailImgix = await getWrapperImgixFields(thumbnailImgixWrapperImgixID);
-  } else {
-    log(`No thumbnail imgix found`, "WARN");
-  }
-
-  log(`Get full screen imgix details...`);
-  let fullScreenImageImgix = {};
-  const fullScreenImageImgixWrapperImgixID =
-    topicFamilyWithFields?.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 =
-    topicFamilyWithFields?.fields?.priority?.[defaultEnvironmentLocaleCode] ||
-    0;
-
-  // Single record
-  const record: AlgoliaFamilyRecord = {
-    objectID: topicFamilyWithFields.sys.id,
-    names: keysToLowerCase(topicFamilyWithFields?.fields?.name) || {},
-    code:
-      topicFamilyWithFields?.fields?.code?.[defaultEnvironmentLocaleCode] || {},
-    thumbnailImgix,
-    fullScreenImageImgix,
-    slugs: keysToLowerCase(page?.slugs) || {},
-    slugType: page?.type || "",
-    // slugDetails: page?.details || {},
-    catalogs,
-    categories,
-    productFields,
-    productFieldsUs,
-    priority,
-    isNew,
-    destinations:
-      topicFamilyWithFields?.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: "topicFamily",
-    limit,
-    skip: offset,
-    select: "sys",
-  };
-  if (catalogCode) {
-    opts["fields.catalogs.sys.id[in]"] = catalogCode;
-  }
-  const { items, total } = await client.withAllLocales.getEntries(opts);
-
-  const objects: AlgoliaFamilyRecord[] = [];
-  let count: number = Number(offset);
-  let current: number = 0;
-  for (const topicFamily of items) {
-    log(`${++count} of ${total}`, "INFO");
-    const timeStart = new Date();
-    const record = await getObject(topicFamily);
-    const timeEnd = new Date();
-    const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-    log(`Execution time: ${seconds} seconds`);
-    objects.push(record);
-    if (serverUtils) {
-      serverUtils.log(topicFamily.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 reindexFamilies = async (
-  offset: number = 0,
-  limit: number = 50,
-  catalogCode?: AvailableCatalogs
-) => {
-  const timeStart = new Date();
-  log(`reindexFamilies - offset: ${offset} limit: ${limit} `);
-  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 reindexFamily = async (topicFamilyEntryId: string) => {
-  const timeStart = new Date();
-
-  log(`reindexFamily - entryId: ${topicFamilyEntryId} `);
-
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  // Get single object data
-  const topicFamily = await getEntryByID(topicFamilyEntryId, "topicFamily");
-
-  const index = getIndex(indexKey);
-  let record = null;
-  if (!topicFamily) {
-    log(
-      `No topicFamily found with id ${topicFamilyEntryId}. Delete object if exists`,
-      "WARN"
-    );
-    record = await index.deleteObject(topicFamilyEntryId);
-    return { ...record };
-  }
-
-  const object = await getObject(topicFamily);
-
-  // Save record to Algolia
-  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 removeFamilyObject = async (objectId: string) => {
-  return removeIndexObject(objectId, indexKey);
-};