pim-import 5.0.0 → 5.0.2

package/src/pim/methods/subfamilies.ts

@@ -1,706 +0,0 @@
-import { getOtherCatalogData } from "../endpoints";
-import {
-  updateEntry,
-  createEntryWithId,
-  getEnvironmentDefaultLocaleCode,
-  getEntryByID,
-  getEntryByCode,
-  getAllEntries,
-  cfLocales,
-  addToRelationFields,
-  addFieldValue,
-} from "../../libs/contentful";
-import { log, serverUtils } from "../../libs/logs";
-import type {
-  Entry,
-  CreateEntryProps,
-} from "contentful-management/dist/typings/entities/entry";
-import {
-  CollectionSubFamilies,
-  PagedCollectionEntity,
-} from "../../resources/CollectionSubFamilies";
-import {
-  sleep,
-  getPimTranslations,
-  stringToSlug,
-  sanitizeValue,
-  getLocalISOTime,
-  capitalizeFirstLetter,
-  keysToLowerCase,
-} from "../../utils";
-import {
-  PaginationResults,
-  CfLocalizedEntryField,
-  AvailableCatalogs,
-  CfSys,
-} from "../../types";
-import { updateSubFamiliesRelToEntry, getCategoryTopicCode } from "./catalogs";
-import { pageResponse } from "../../algolia/families";
-import { addDesignerData } from "./designers";
-import { setHideInRegionField } from "./products";
-
-const getComponentModelPagesData = async (
-  componentID: string,
-  topicSubFamily: Entry,
-  componentModule: Entry | null
-) => {
-  const componentData: CreateEntryProps = {
-    fields: componentModule?.fields || {},
-  };
-
-  componentData.fields = await addFieldValue(
-    componentData,
-    "internalName",
-    componentID
-  );
-
-  // modelPages relations
-  const topicModels = await getAllEntries(
-    "topicModel",
-    "sys",
-    "fields.subFamily.sys.id",
-    topicSubFamily.sys.id
-  );
-  for (const topicModel of topicModels) {
-    componentData.fields = await addToRelationFields(
-      componentData,
-      "modelPages",
-      `${topicModel.sys.id}_PAGE`,
-      true
-    );
-  }
-
-  return componentData;
-};
-
-const addComponentModelPages = async (
-  topicSubFamily: Entry
-): Promise<Entry> => {
-  const componentID = `CC_${topicSubFamily.sys.id}`;
-  const componentContentType = "componentModelPages";
-  let componentModule = await getEntryByID(componentID, componentContentType);
-
-  const componentData = await getComponentModelPagesData(
-    componentID,
-    topicSubFamily,
-    componentModule
-  );
-
-  if (componentModule) {
-    log(
-      `Update ${componentContentType} for the ${topicSubFamily.sys.id} subfamily page`
-    );
-    componentModule = await updateEntry(
-      componentModule,
-      componentData,
-      componentModule.isPublished()
-    );
-  } else {
-    log(
-      `Add ${componentContentType} for the ${topicSubFamily.sys.id} subfamily page`
-    );
-    componentModule = await createEntryWithId(
-      componentContentType,
-      componentID,
-      componentData
-    );
-    componentModule = await componentModule.publish();
-  }
-
-  return componentModule;
-};
-
-const getSubFamilyPageData = async (
-  names: CfLocalizedEntryField,
-  slugs: CfLocalizedEntryField,
-  pageId: string,
-  subFamilyEntry: Entry,
-  subFamilyPageEntry: Entry
-): Promise<CreateEntryProps> => {
-  const defEnvLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const pageData: CreateEntryProps = {
-    fields: subFamilyPageEntry?.fields || {},
-  };
-
-  pageData.fields.title = names;
-  pageData.fields.slug = slugs;
-
-  pageData.fields = await addFieldValue(pageData, "internalName", pageId);
-  pageData.fields = await addFieldValue(pageData, "type", "CatalogSubFamily");
-
-  // Topic
-  pageData.fields = await addToRelationFields(
-    pageData,
-    "topic",
-    subFamilyEntry.sys.id
-  );
-
-  // Contents - Component Model Pages
-  const componentModelPages = await addComponentModelPages(subFamilyEntry);
-  pageData.fields = await addToRelationFields(
-    pageData,
-    "contents",
-    componentModelPages.sys.id,
-    true
-  );
-
-  const destinations =
-    subFamilyEntry?.fields?.destinations?.[defEnvLocaleCode] || [];
-  pageData.fields = await setHideInRegionField(destinations, pageData);
-
-  return pageData;
-};
-
-export const getSubFamilyPageSlugs = async (
-  catalogPage: Entry,
-  categoryPage: Entry,
-  subFamilyEntry: Entry
-): Promise<CfLocalizedEntryField> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const slugs: CfLocalizedEntryField = {};
-  for (const locale of cfLocales) {
-    let slugPrefix = "";
-    if (catalogPage?.fields?.slug) {
-      slugPrefix +=
-        (catalogPage.fields.slug[locale] ||
-          catalogPage.fields.slug[defaultEnvironmentLocaleCode]) + "-";
-    }
-    if (categoryPage?.fields?.slug) {
-      slugPrefix +=
-        (categoryPage.fields.slug[locale] ||
-          categoryPage.fields.slug[defaultEnvironmentLocaleCode]) + "-";
-    }
-    slugs[locale] = stringToSlug(
-      `${slugPrefix}${
-        subFamilyEntry.fields.name[locale] ||
-        subFamilyEntry.fields.name[defaultEnvironmentLocaleCode]
-      }`.toLowerCase()
-    );
-  }
-
-  return slugs;
-};
-
-/**
- * Create or update subFamily page
- *
- * create/update page content
- * - internalName
- * - contentModules:
- * -- topicSubFamily
- * - regions
- * - sites
- *
- * create/update page
- * - internalName
- * - type: 'CatalogSubFamily'
- * - content:
- * -- pageContent
- *
- * @param subFamilyEntry
- * @returns
- */
-export const createOrUpdatePage = async (
-  subFamilyEntry: Entry
-): Promise<Entry> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const pageId = `${subFamilyEntry.sys.id}_PAGE`;
-  const names: CfLocalizedEntryField = {};
-
-  for (const locale of cfLocales) {
-    names[locale] =
-      subFamilyEntry.fields.name[locale] ||
-      subFamilyEntry.fields.name[defaultEnvironmentLocaleCode];
-  }
-
-  // Catalog page
-  let catalogPage: Entry = {} as Entry;
-  const catalogEntryId =
-    subFamilyEntry?.fields?.catalog?.[defaultEnvironmentLocaleCode]?.sys?.id;
-  if (catalogEntryId) {
-    log(
-      `Add ${catalogEntryId} catalog page slug to ${subFamilyEntry.sys.id} subfamily page slug`
-    );
-    catalogPage = await getEntryByID(`${catalogEntryId}_PAGE`, "page");
-    if (!catalogPage) {
-      log(`No catalog page found with page id: ${catalogEntryId}_PAGE`, "WARN");
-    }
-  } else {
-    log(`No catalog found with id: ${catalogEntryId}`, "WARN");
-  }
-
-  // Category page
-  let categoryPage: Entry = {} as Entry;
-  const categoryEntryId =
-    subFamilyEntry?.fields?.category?.[defaultEnvironmentLocaleCode]?.sys?.id;
-  if (categoryEntryId) {
-    log(
-      `Add ${categoryEntryId} category page slug to ${subFamilyEntry.sys.id} subfamily page slug`
-    );
-    categoryPage = await getEntryByID(`${categoryEntryId}_PAGE`, "page");
-    if (!categoryPage) {
-      log(
-        `No category page found with page id: ${categoryEntryId}_PAGE`,
-        "WARN"
-      );
-    }
-  } else {
-    log(`No category found with id: ${categoryEntryId}`, "WARN");
-  }
-
-  const slugs = await getSubFamilyPageSlugs(
-    catalogPage,
-    categoryPage,
-    subFamilyEntry
-  );
-
-  // PAGE
-  let subFamilyPageEntry: Entry = await getEntryByID(pageId, "page");
-  const pageData: CreateEntryProps = await getSubFamilyPageData(
-    names,
-    slugs,
-    pageId,
-    subFamilyEntry,
-    subFamilyPageEntry
-  );
-  if (subFamilyPageEntry) {
-    log(`subFamily page ${pageId} already exists. Updating...`);
-    subFamilyPageEntry = await updateEntry(
-      subFamilyPageEntry,
-      pageData,
-      subFamilyPageEntry.isPublished()
-    );
-  } else {
-    log(`subFamily page ${pageId} not exists. Create new entry with data`);
-    subFamilyPageEntry = await createEntryWithId("page", pageId, pageData);
-  }
-
-  return subFamilyPageEntry;
-};
-
-const getTopicSubFamilyData = async (
-  subFamily: PagedCollectionEntity,
-  catalog: AvailableCatalogs,
-  topicSubFamily: Entry
-) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const data: CreateEntryProps = {
-    fields: topicSubFamily?.fields || {},
-  };
-  data.fields.name = getPimTranslations(subFamily.data);
-  data.fields = await addFieldValue(data, "code", subFamily.data.code);
-  data.fields = await addFieldValue(data, "priority", subFamily.priority);
-  data.fields.description = getPimTranslations(subFamily, "description1");
-
-  // Catalog
-  const catalogEntry = await getEntryByCode(
-    subFamily.catalogCode,
-    "topicCatalog",
-    "sys,fields.code"
-  );
-  // Catalogs
-  log(`set ${catalogEntry.sys.id} catalog relation with current subfamily`);
-  data.fields = await addToRelationFields(
-    data,
-    "catalog",
-    catalogEntry?.sys?.id
-  );
-
-  if (!catalogEntry) {
-    log(`catalog with code ${subFamily.catalogCode} not found`, "WARN");
-  }
-
-  // Category
-  const categoryTopicCode = getCategoryTopicCode(
-    subFamily.categoryCode,
-    catalog
-  );
-  const categoryEntry = await getEntryByCode(
-    categoryTopicCode,
-    "topicCategory",
-    "sys,fields.code"
-  );
-
-  log(`set ${categoryEntry.sys.id} category relation with current subfamily`);
-  data.fields = await addToRelationFields(
-    data,
-    "category",
-    categoryEntry.sys.id
-  );
-
-  if (!categoryEntry) {
-    log(`category with code ${categoryTopicCode} not found`, "WARN");
-  }
-
-  // Parent Families
-  if (subFamily?.parentFamily?.data?.code) {
-    let familyEntry = await getEntryByCode(
-      subFamily.parentFamily.data.code,
-      "topicFamily",
-      "sys,fields"
-    );
-    if (familyEntry) {
-      log(
-        `set ${familyEntry.sys.id} parentFamily relation with current subfamily`
-      );
-      data.fields = await addToRelationFields(
-        data,
-        "parentFamily",
-        familyEntry.sys.id,
-        false
-      );
-
-      // Family catalogs
-      log(
-        `set ${catalogEntry.sys.id} catalog relation with family ${familyEntry.sys.id}`
-      );
-      familyEntry.fields = await addToRelationFields(
-        familyEntry,
-        "catalogs",
-        catalogEntry.sys.id,
-        true
-      );
-      // Family categories
-      log(
-        `set ${categoryEntry.sys.id} category relation with family ${familyEntry.sys.id}`
-      );
-      familyEntry.fields = await addToRelationFields(
-        familyEntry,
-        "categories",
-        categoryEntry.sys.id,
-        true
-      );
-
-      familyEntry = await familyEntry.update();
-    } else {
-      log(
-        `topicFamily with code ${subFamily.parentFamily.data.code} not found`,
-        "WARN"
-      );
-    }
-  } else {
-    log(
-      `parentFamily of ${subFamily.data.code} subFamily not found on PIM`,
-      "WARN"
-    );
-  }
-
-  // Designer
-  if (subFamily?.designers) {
-    const designer = subFamily.designers[0];
-    if (designer?.code) {
-      log(`set ${designer.code} designer relation`);
-      data.fields = await addDesignerData(data, designer);
-    } else {
-      log(`no designer found`, "WARN");
-      if (data.fields.designer?.[defaultEnvironmentLocaleCode]) {
-        log(
-          `remove old designer relation with ${data.fields.designer?.[defaultEnvironmentLocaleCode].sys.id}`
-        );
-        data.fields.designer = {};
-      }
-    }
-  }
-
-  // Destinations
-  if (subFamily?.destinations?.length) {
-    log(`set destinations`);
-    data.fields = await addFieldValue(
-      data,
-      "destinations",
-      subFamily.destinations
-    );
-  } else {
-    log(`destinations not found`, "WARN");
-  }
-
-  // lastPimSyncDate
-  data.fields = await addFieldValue(data, "lastPimSyncDate", getLocalISOTime());
-
-  return data;
-};
-
-/**
- * Import subFamily
- *
- * create/update topicSubFamily
- * - name
- * - code
- * - catalog
- * - parentFamily
- * - lastPimSyncDate
- *
- * @param subFamily
- * @returns
- */
-const importSubFamily = async (
-  subFamily: PagedCollectionEntity,
-  catalog: AvailableCatalogs
-) => {
-  const code = `${subFamily.data.code}`;
-  let topicSubFamily: Entry = await getEntryByID(code, "topicSubFamily");
-  log(`importSubFamily ${code} to catalog ${catalog}`, "INFO");
-
-  const topicSubFamilyData: CreateEntryProps = await getTopicSubFamilyData(
-    subFamily,
-    catalog,
-    topicSubFamily
-  );
-  if (topicSubFamily) {
-    log(`The topicSubFamily ${code} already exists. Updating...`);
-    topicSubFamily = await updateEntry(
-      topicSubFamily,
-      topicSubFamilyData,
-      topicSubFamily.isPublished()
-    );
-  } else {
-    log(`The topicSubFamily ${code} not exists. Creating...`);
-    topicSubFamily = await createEntryWithId(
-      "topicSubFamily",
-      code,
-      topicSubFamilyData
-    );
-  }
-
-  // Add subFamily to categoryEntry subFamilies relation field
-  if (subFamily.categoryCode) {
-    const categoryTopicCode = getCategoryTopicCode(
-      subFamily.categoryCode,
-      catalog
-    );
-    const categoryEntry = await getEntryByCode(
-      categoryTopicCode,
-      "topicCategory"
-    );
-    if (categoryEntry) {
-      log(
-        `Add topicSubFamily ${code} to subFamilies relation field of ${subFamily.categoryCode} category`
-      );
-      const subFamiliesFieldKey =
-        "subFamilies" + capitalizeFirstLetter(catalog);
-      await updateSubFamiliesRelToEntry(
-        categoryEntry,
-        [code],
-        subFamiliesFieldKey
-      );
-    } else {
-      log(`Category with code ${subFamily.categoryCode} not found`);
-    }
-  }
-
-  return topicSubFamily;
-};
-
-/**
- * Import subfamilies
- *
- * @param {number} offset Default 0
- * @param {number} limit Range 0-50. Default 50
- * @returns {object}
- */
-export const importSubFamilies = async (
-  offset: number = 0,
-  limit: number = 50,
-  catalog: AvailableCatalogs
-): Promise<PaginationResults> => {
-  log(`importSubFamilies - offset: ${offset}, limit: ${limit}`, "INFO");
-  const subFamilies = await getOtherCatalogData<CollectionSubFamilies>(
-    "subfamilies",
-    offset,
-    limit
-  );
-  const total = subFamilies?.pagedCollection?.length || 0;
-
-  if (subFamilies?.pagedCollection?.length) {
-    log(`Import ${total} subFamilies`);
-    let count = offset;
-    let current: number = 0;
-    for (const subFamily of subFamilies.pagedCollection) {
-      log(`${++count} of ${subFamilies.totalCount}`);
-
-      if (subFamily.catalogCode !== catalog) {
-        log(
-          `The ${subFamily.data.code} subfamily does not belong to the ${catalog} catalog and will not be imported`
-        );
-        continue;
-      }
-
-      if (!sanitizeValue(subFamily.data.code)) {
-        log(`The  subfamily code ${subFamily.data.code} is not valid`, "WARN");
-        continue;
-      }
-
-      const topicSubFamily = await importSubFamily(subFamily, catalog);
-
-      await createOrUpdatePage(topicSubFamily);
-
-      if (serverUtils) {
-        serverUtils.log(subFamily.data.code);
-        const progress = Math.floor(
-          (++current / subFamilies.pagedCollection.length) * 100
-        );
-        serverUtils.updateProgress(progress);
-      }
-
-      // Max 7 calls per seconds
-      if (count % 2 === 0 && count < subFamilies.totalCount) {
-        await sleep(1000);
-      }
-    }
-  } else {
-    log(`No subFamilies found`);
-  }
-
-  const nextOffset = Number(offset) + Number(limit);
-
-  if (serverUtils) {
-    serverUtils.updateProgress(100);
-  }
-
-  return {
-    offset: nextOffset,
-    limit: Number(limit),
-    completed: nextOffset >= subFamilies.totalCount,
-    total: subFamilies.totalCount,
-  };
-};
-
-export const getSubFamilyRelatedDetails = async (topicSubFamily: Entry) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const catalogEntryId =
-    topicSubFamily?.fields?.catalog?.[defaultEnvironmentLocaleCode]?.sys?.id;
-  if (!catalogEntryId) {
-    log(
-      `catalogEntryId not found to ${topicSubFamily.sys.id} subFamilyEntry`,
-      "WARN"
-    );
-  }
-  const parentFamilyEntryId =
-    topicSubFamily?.fields?.parentFamily?.[defaultEnvironmentLocaleCode]?.sys
-      ?.id;
-  if (!parentFamilyEntryId) {
-    log(
-      `parentFamilyEntryId not found to ${topicSubFamily.sys.id} subFamilyEntry`,
-      "WARN"
-    );
-  }
-  const categoryEntryId =
-    topicSubFamily?.fields?.category?.[defaultEnvironmentLocaleCode]?.sys?.id;
-  if (!categoryEntryId) {
-    log(
-      `categoryEntryId not found to ${topicSubFamily.sys.id} subFamilyEntry`,
-      "WARN"
-    );
-  }
-  const subFamilyCatalogPage: any = catalogEntryId
-    ? await getEntryByID(`${catalogEntryId}_PAGE`, "page", "fields.slug")
-    : {};
-  const subFamilyFamilyPage: any = parentFamilyEntryId
-    ? await getEntryByID(`${parentFamilyEntryId}_PAGE`, "page", "fields.slug")
-    : {};
-  const subFamilyCategoryPage: any = categoryEntryId
-    ? await getEntryByID(`${categoryEntryId}_PAGE`, "page", "fields.slug")
-    : {};
-
-  return {
-    catalogPageSlugs: keysToLowerCase(subFamilyCatalogPage?.fields?.slug) || {},
-    familyPageSlugs: keysToLowerCase(subFamilyFamilyPage?.fields?.slug) || {},
-    categoryPageSlugs:
-      keysToLowerCase(subFamilyCategoryPage?.fields?.slug) || {},
-  };
-};
-
-export const getSubFamilyPageSlugWithDetails = async (
-  subFamilyEntry: Entry
-): Promise<pageResponse> => {
-  const subFamilyEntryId = subFamilyEntry?.sys?.id;
-  if (!subFamilyEntryId) {
-    log(`Invalid subFamilyEntry`, "ERROR");
-  }
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const catalogEntryId =
-    subFamilyEntry?.fields?.catalog?.[defaultEnvironmentLocaleCode]?.sys?.id;
-  if (!catalogEntryId) {
-    log(
-      `catalogEntryId not found to ${subFamilyEntryId} subFamilyEntry`,
-      "WARN"
-    );
-  }
-  const parentFamilyEntryId =
-    subFamilyEntry?.fields?.parentFamily?.[defaultEnvironmentLocaleCode]?.sys
-      ?.id;
-  if (!parentFamilyEntryId) {
-    log(
-      `parentFamilyEntryId not found to ${subFamilyEntryId} subFamilyEntry`,
-      "WARN"
-    );
-  }
-  const categoryEntryId =
-    subFamilyEntry?.fields?.category?.[defaultEnvironmentLocaleCode]?.sys?.id;
-  if (!categoryEntryId) {
-    log(
-      `categoryEntryId not found to ${subFamilyEntryId} subFamilyEntry`,
-      "WARN"
-    );
-  }
-
-  // Return subFamily page slug
-  const subFamilyPageId = `${subFamilyEntryId}_PAGE`;
-  const subFamilyPage = await getEntryByID(subFamilyPageId, "page");
-  const details = await getSubFamilyRelatedDetails(subFamilyEntry);
-  if (subFamilyPage) {
-    return {
-      slugs: subFamilyPage?.fields?.slug,
-      type: subFamilyPage?.fields?.type?.[defaultEnvironmentLocaleCode],
-      details,
-    };
-  } else {
-    log(`The subFamilyPage with id "${subFamilyPageId}" not found`, "WARN");
-  }
-
-  return null;
-};
-
-/**
- * Update or Create the componentModelPages of specific subFamilyPage by subfamily entry
- * This method is used by models import
- *
- * @param subFamilyEntry
- * @returns
- */
-export const updateComponentModelPagesToSubFamilyPage = async (
-  subFamilyEntry: Entry
-) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const pageId = `${subFamilyEntry.sys.id}_PAGE`;
-  let subFamilyPageEntry: Entry = await getEntryByID(pageId, "page");
-
-  if (!subFamilyPageEntry) {
-    log(`${pageId} subFamily page not found`);
-  } else {
-    const componentModelPages = await addComponentModelPages(subFamilyEntry);
-    const pageData: CreateEntryProps = {
-      fields: subFamilyPageEntry?.fields || {},
-    };
-    if (
-      !pageData.fields.contents ||
-      !pageData.fields.contents[defaultEnvironmentLocaleCode].find(
-        (item: CfSys) => item.sys.id === componentModelPages.sys.id
-      )
-    ) {
-      pageData.fields = await addToRelationFields(
-        pageData,
-        "contents",
-        componentModelPages.sys.id,
-        true
-      );
-      subFamilyPageEntry = await updateEntry(
-        subFamilyPageEntry,
-        pageData,
-        subFamilyPageEntry.isPublished()
-      );
-    }
-  }
-
-  return subFamilyPageEntry;
-};