pim-import 5.0.0 → 5.0.2

package/src/algolia/projects.ts

@@ -1,339 +0,0 @@
-import { log } from "../libs/logs";
-import {
-  getClient,
-  getEnvironmentDefaultLocaleCode,
-  getEntryByID,
-  getTopicPage,
-} from "../libs/contentful-cda";
-import { cfLocales } from "../libs/contentful";
-import { getIndex, AvailableIndicesKey, removeIndexObject } from "./config";
-import {
-  getAllTranslations,
-  getLocalISOTime,
-  secondBetweenTwoDate,
-} from "../utils";
-import type { Entry } from "contentful-management/dist/typings/entities/entry";
-import {
-  CfLocalizedEntryField,
-  AlgoliaPaginateRecords,
-  WrapperImageFields,
-} from "../types";
-import { getWrapperImgixFields } from "../libs/imgix";
-
-const indexKey: AvailableIndicesKey = "projects";
-
-export type AlgoliaProjectRecord = {
-  objectID: string;
-  name?: CfLocalizedEntryField;
-  slugs?: {};
-  isProtected?: boolean;
-  isBespoke?: boolean;
-  categories?: string[];
-  categoriesLocalized?: {};
-  applications?: string[];
-  locations?: string[];
-  thumbnailImgix?: WrapperImageFields | {};
-  fullPageImageImgix?: WrapperImageFields | {};
-  locationLabel?: string;
-  casambiUsed?: boolean;
-  visualizationDate?: string;
-  location?: {};
-  lastSyncDate?: string;
-  hideInRegions?: string[];
-};
-
-const isObjectToDelete = (
-  object: any,
-  defaultEnvironmentLocaleCode: string
-) => {
-  return !object?.slugs?.[defaultEnvironmentLocaleCode];
-};
-
-const getObject = async (
-  topicProject: Entry
-): Promise<AlgoliaProjectRecord> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  log(`Sync the ${topicProject.sys.id} topicProject...`);
-  let topicProjectWithFields: Entry = topicProject;
-
-  if (!topicProjectWithFields?.fields) {
-    log(`Get the ${topicProject.sys.id} topicProject details...`);
-    topicProjectWithFields = await getEntryByID(
-      topicProject.sys.id,
-      "topicProject"
-    );
-  }
-
-  if (!topicProjectWithFields) {
-    log(`The topicProject ${topicProject.sys.id} not found`, "WARN");
-
-    const recordFail: AlgoliaProjectRecord = {
-      objectID: topicProject?.sys?.id,
-    };
-
-    return recordFail; // return objectID to delete the record if it exists
-  }
-
-  log(`Get page details...`);
-  const page = await getTopicPage(
-    topicProject.sys.id,
-    "fields.slug,fields.protected,fields.hideInRegions"
-  );
-
-  if (!page) {
-    log(`The topicProject page ${topicProject.sys.id} not found`, "WARN");
-
-    const recordFail: AlgoliaProjectRecord = {
-      objectID: topicProject?.sys?.id,
-    };
-
-    return recordFail; // return objectID to delete the record if it exists
-  }
-
-  const slugs = await getAllTranslations(page?.fields.slug || {});
-  const isProtected = !!page?.fields?.protected?.[defaultEnvironmentLocaleCode];
-
-  log(`Get thumbnail imgix details...`);
-  let thumbnailImgix = {};
-  const thumbnailImgixWrapperImgixID =
-    topicProjectWithFields?.fields?.thumbnailImgix?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (thumbnailImgixWrapperImgixID) {
-    thumbnailImgix = await getWrapperImgixFields(thumbnailImgixWrapperImgixID);
-  } else {
-    log(`No thumbnail imgix found`, "WARN");
-  }
-
-  log(`Get fullPageImage imgix details...`);
-  let fullPageImageImgix = {};
-  const fullPageImageImgixWrapperImgixID =
-    topicProjectWithFields?.fields?.fullPageImageImgix?.[
-      defaultEnvironmentLocaleCode
-    ]?.sys.id;
-  if (fullPageImageImgixWrapperImgixID) {
-    fullPageImageImgix = await getWrapperImgixFields(
-      fullPageImageImgixWrapperImgixID
-    );
-  } else {
-    log(`No fullPageImage imgix found`, "WARN");
-  }
-
-  log(`Get categories details...`);
-  const categories: string[] = [];
-  const categoriesLocalized: any = {};
-  const categoriesIDs = topicProjectWithFields?.fields?.categories?.[
-    defaultEnvironmentLocaleCode
-  ]?.map((category: Entry) => category.sys.id);
-  if (categoriesIDs?.length) {
-    for (const categoryID of categoriesIDs) {
-      const category = await getEntryByID(
-        categoryID,
-        "topicProjectCategory",
-        "fields.title"
-      );
-      categories.push(
-        category?.fields?.title?.[defaultEnvironmentLocaleCode] || ""
-      );
-      for (const locale of cfLocales) {
-        if (!categoriesLocalized?.locale) categoriesLocalized[locale] = [];
-
-        categoriesLocalized[locale].push(
-          category?.fields?.title?.[locale] ||
-            category?.fields?.title?.[defaultEnvironmentLocaleCode]
-        );
-      }
-    }
-  } else {
-    log(`No categories found`, "WARN");
-  }
-
-  log(`Get location details...`);
-  let location = {};
-  if (
-    topicProjectWithFields?.fields?.location?.[defaultEnvironmentLocaleCode]
-  ) {
-    location =
-      topicProjectWithFields?.fields?.location?.[defaultEnvironmentLocaleCode];
-  } else {
-    log(`No location found`, "WARN");
-  }
-
-  log(`Get hideInRegions details...`);
-  const hideInRegions =
-    page.fields.hideInRegions?.[defaultEnvironmentLocaleCode].map(
-      (item: Entry) => item.sys.id
-    ) || [];
-
-  // Single record
-  const record: AlgoliaProjectRecord = {
-    objectID: topicProjectWithFields.sys.id,
-    name:
-      topicProjectWithFields?.fields?.title?.[defaultEnvironmentLocaleCode] ||
-      "",
-    slugs,
-    isProtected,
-    isBespoke:
-      !!topicProjectWithFields?.fields?.isBespokeProject?.[
-        defaultEnvironmentLocaleCode
-      ],
-    categories,
-    categoriesLocalized,
-    applications:
-      topicProjectWithFields?.fields?.applications?.[
-        defaultEnvironmentLocaleCode
-      ] || [],
-    locations:
-      topicProjectWithFields?.fields?.locations?.[
-        defaultEnvironmentLocaleCode
-      ] || [],
-    locationLabel:
-      topicProjectWithFields?.fields?.locationLabel?.[
-        defaultEnvironmentLocaleCode
-      ] || "",
-    casambiUsed:
-      !!topicProjectWithFields?.fields?.casambiUseInThisProject?.[
-        defaultEnvironmentLocaleCode
-      ],
-    thumbnailImgix,
-    fullPageImageImgix,
-    visualizationDate:
-      topicProjectWithFields?.fields?.visualizationDate?.[
-        defaultEnvironmentLocaleCode
-      ] || "",
-    location,
-    hideInRegions,
-    lastSyncDate: getLocalISOTime(),
-  };
-
-  return record;
-};
-
-export const reindexProject = async (topicProjectId: string) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const timeStart = new Date();
-
-  log(`reindexProject - entryId: ${topicProjectId} `);
-
-  const topicProject = await getEntryByID(topicProjectId, "topicProject");
-
-  const index = getIndex(indexKey);
-  let record = null;
-  if (!topicProject) {
-    log(
-      `No topicProjectId found with id ${topicProjectId}. Delete object if exists`,
-      "WARN"
-    );
-    record = await index.deleteObject(topicProjectId);
-    return { ...record };
-  }
-
-  const object = await getObject(topicProject);
-
-  // 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 };
-};
-
-/**
- * Get Objects
- *
- * @param offset
- * @param limit
- * @param filterKey
- * @param filterValue
- * @returns
- */
-const getObjects = async (
-  offset: number,
-  limit: number,
-  filterKey?: string,
-  filterValue?: string
-): Promise<AlgoliaPaginateRecords> => {
-  const client = await getClient();
-
-  const opts: any = {
-    content_type: "topicProject",
-    limit,
-    skip: offset,
-    // select: "",
-  };
-  if (filterKey && filterValue) {
-    opts[filterKey] = filterValue;
-  }
-  const { items, total } = await client.withAllLocales.getEntries(opts);
-
-  const objects: AlgoliaProjectRecord[] = [];
-  let count: number = Number(offset);
-  for (const topicProduct of items) {
-    log(`${++count} of ${total}`, "INFO");
-    const timeStart = new Date();
-    const record = await getObject(topicProduct);
-    const timeEnd = new Date();
-    const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-    log(`Execution time: ${seconds} seconds`);
-    objects.push(record);
-  }
-
-  return {
-    objects,
-    offset: Number(offset) + Number(limit),
-    limit: Number(limit),
-    completed: count >= total, // if is true the import is completed
-    total,
-  };
-};
-
-export const reindexProjects = async (
-  offset: number = 0,
-  limit: number = 50,
-  filterKey: string = "",
-  filterValue: string = ""
-) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const timeStart = new Date();
-  log(
-    `reindexProjects - filterKey: ${filterKey} filterValue: ${filterValue} offset: ${offset} limit: ${limit} `
-  );
-
-  const records = await getObjects(offset, limit, filterKey, filterValue);
-  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 removeProjectObject = async (objectId: string) => {
-  return removeIndexObject(objectId, indexKey);
-};

package/src/algolia/stories.ts

@@ -1,347 +0,0 @@
-import { log } from "../libs/logs";
-import {
-  getClient,
-  getEnvironmentDefaultLocaleCode,
-  getEntryByID,
-  getTopicPage,
-} from "../libs/contentful-cda";
-import { getIndex, AvailableIndicesKey, removeIndexObject } from "./config";
-import {
-  getAllTranslations,
-  getLocalISOTime,
-  secondBetweenTwoDate,
-} from "../utils";
-import type { Entry } from "contentful-management/dist/typings/entities/entry";
-import {
-  CfLocalizedEntryField,
-  AlgoliaPaginateRecords,
-  WrapperImageFields,
-} from "../types";
-import { getWrapperImgixFields } from "../libs/imgix";
-import removeMd from "remove-markdown";
-
-const indexKey: AvailableIndicesKey = "stories";
-
-export type AlgoliaStoryRecord = {
-  objectID: string;
-  name?: CfLocalizedEntryField;
-  excerpt?: CfLocalizedEntryField;
-  previewExcerpt?: CfLocalizedEntryField;
-  description?: CfLocalizedEntryField;
-  slugs?: {};
-  isProtected?: boolean;
-  fullScreenImageImgix?: WrapperImageFields | {};
-  previewImagesImgix?: any;
-  video?: {};
-  category?: {};
-  previewLayout?: string;
-  visualizationDate?: string;
-  lastSyncDate?: string;
-  hideInRegions?: string[];
-};
-
-const isObjectToDelete = (
-  object: any,
-  defaultEnvironmentLocaleCode: string
-) => {
-  return !object?.slugs?.[defaultEnvironmentLocaleCode];
-};
-
-const getObject = async (topicStory: Entry): Promise<AlgoliaStoryRecord> => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  log(`Sync the ${topicStory.sys.id} topicStory...`);
-  let topicStoryWithFields: Entry = topicStory;
-
-  const emptyLocalizedField: CfLocalizedEntryField = {
-    [defaultEnvironmentLocaleCode]: "",
-  };
-
-  if (!topicStoryWithFields?.fields) {
-    log(`Get the ${topicStory.sys.id} topicStory details...`);
-    topicStoryWithFields = await getEntryByID(topicStory.sys.id, "topicStory");
-  }
-
-  if (!topicStoryWithFields) {
-    log(`The topicStory ${topicStory.sys.id} not found`, "WARN");
-
-    const recordFail: AlgoliaStoryRecord = {
-      objectID: topicStory?.sys?.id,
-    };
-
-    return recordFail; // return objectID to delete the record if it exists
-  }
-
-  log(`Get page details...`);
-  const page = await getTopicPage(
-    topicStory.sys.id,
-    "fields.slug,fields.protected,fields.hideInRegions"
-  );
-
-  if (!page) {
-    log(`The topicStory page ${topicStory.sys.id} not found`, "WARN");
-
-    const recordFail: AlgoliaStoryRecord = {
-      objectID: topicStory?.sys?.id,
-    };
-
-    return recordFail; // return objectID to delete the record if it exists
-  }
-
-  const slugs = await getAllTranslations(page?.fields.slug || {});
-  const isProtected = !!page?.fields?.protected?.[defaultEnvironmentLocaleCode];
-
-  log(`Get Full Screen Image Imgix details...`);
-  let fullScreenImageImgix = {};
-  const fullScreenImageImgixWrapperImgixID =
-    topicStory?.fields?.fullScreenImageImgix?.[defaultEnvironmentLocaleCode]
-      ?.sys.id;
-  if (fullScreenImageImgixWrapperImgixID) {
-    fullScreenImageImgix = await getWrapperImgixFields(
-      fullScreenImageImgixWrapperImgixID
-    );
-  } else {
-    log(`No Full Screen Image Imgix found`, "WARN");
-  }
-
-  log(`Get Preview Images Imgix details...`);
-  const previewImagesImgix = [];
-  if (topicStory?.fields?.previewImagesImgix?.[defaultEnvironmentLocaleCode]) {
-    for (const previewImageImgix of topicStory.fields.previewImagesImgix[
-      defaultEnvironmentLocaleCode
-    ]) {
-      const previewImagesImgixWrapperImgixID = previewImageImgix?.sys.id;
-      if (previewImagesImgixWrapperImgixID) {
-        const currentPreviewImagesImgix = await getWrapperImgixFields(
-          previewImagesImgixWrapperImgixID
-        );
-        previewImagesImgix.push(currentPreviewImagesImgix);
-      }
-    }
-  } else {
-    log(`No Preview Images Imgix found`, "WARN");
-  }
-
-  log(`Get videoId details...`);
-  let video = {};
-  if (topicStory.fields?.video?.[defaultEnvironmentLocaleCode]?.sys?.id) {
-    const componentVideo = await getEntryByID(
-      topicStory.fields.video[defaultEnvironmentLocaleCode].sys.id,
-      "componentVideo"
-    );
-    let posterImage = {};
-    if (
-      componentVideo?.fields?.posterImgix?.[defaultEnvironmentLocaleCode]?.sys
-        ?.id
-    ) {
-      const posterImgixId =
-        componentVideo?.fields?.posterImgix?.[defaultEnvironmentLocaleCode]?.sys
-          .id;
-      posterImage = await getWrapperImgixFields(posterImgixId);
-    }
-    video = {
-      id: componentVideo?.fields?.videoId?.[defaultEnvironmentLocaleCode] || "",
-      type: componentVideo?.fields?.type?.[defaultEnvironmentLocaleCode] || "",
-      posterImage,
-    };
-  } else {
-    log(`No videoId found`, "WARN");
-  }
-
-  log(`Get category details...`);
-  let category = {};
-  if (topicStory.fields?.category?.[defaultEnvironmentLocaleCode]?.sys?.id) {
-    const categoryEntry = await getEntryByID(
-      topicStory.fields.category[defaultEnvironmentLocaleCode].sys.id,
-      "topicStoryCategory"
-    );
-    if (categoryEntry) {
-      category = {
-        sysId: topicStory.fields.category[defaultEnvironmentLocaleCode].sys.id,
-        title: await getAllTranslations(categoryEntry?.fields?.title || {}),
-        priority: await getAllTranslations(
-          categoryEntry?.fields?.priority || {}
-        ),
-      };
-    } else {
-      log(`No categoryEntry found`, "WARN");
-    }
-  } else {
-    log(`No category found`, "WARN");
-  }
-
-  const clearExcerpt = {};
-  for (const locale in topicStoryWithFields?.fields?.excerpt) {
-    if (topicStoryWithFields?.fields?.excerpt?.[locale]) {
-      (clearExcerpt as any)[locale] = removeMd(
-        topicStoryWithFields?.fields?.excerpt?.[locale]
-      );
-    }
-  }
-
-  log(`Get hideInRegions details...`);
-  const hideInRegions =
-    page.fields.hideInRegions?.[defaultEnvironmentLocaleCode].map(
-      (item: Entry) => item.sys.id
-    ) || [];
-
-  // Single record
-  const record: AlgoliaStoryRecord = {
-    objectID: topicStoryWithFields.sys.id,
-    name: await getAllTranslations(
-      topicStoryWithFields?.fields?.title || emptyLocalizedField
-    ),
-    excerpt: await getAllTranslations(
-      topicStoryWithFields?.fields?.excerpt ? clearExcerpt : emptyLocalizedField
-    ),
-    description: await getAllTranslations(
-      topicStoryWithFields?.fields?.description || emptyLocalizedField
-    ),
-    slugs,
-    isProtected,
-    fullScreenImageImgix,
-    previewImagesImgix,
-    video,
-    category,
-    previewLayout:
-      topicStoryWithFields?.fields?.previewLayout?.[
-        defaultEnvironmentLocaleCode
-      ] || "",
-    visualizationDate:
-      topicStoryWithFields?.fields?.visualizationDate?.[
-        defaultEnvironmentLocaleCode
-      ] || "",
-    hideInRegions,
-    lastSyncDate: getLocalISOTime(),
-  };
-
-  return record;
-};
-
-export const reindexStory = async (topicStoryId: string) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const timeStart = new Date();
-
-  log(`reindexStory - entryId: ${topicStoryId} `);
-
-  const topicStory = await getEntryByID(topicStoryId, "topicStory");
-
-  const index = getIndex(indexKey);
-  let record = null;
-  if (!topicStory) {
-    log(
-      `No topicStoryId found with id ${topicStoryId}. Delete object if exists`,
-      "WARN"
-    );
-    record = await index.deleteObject(topicStoryId);
-    return { ...record };
-  }
-
-  const object = await getObject(topicStory);
-
-  // Save record to Algolia
-  if (!isObjectToDelete(object, defaultEnvironmentLocaleCode)) {
-    log(`Save object to ${index.indexName} index`);
-    record = await index.saveObject(object);
-  } else {
-    log(`Delete object from ${index.indexName} index`);
-    record = await index.deleteObject(object.objectID);
-  }
-  const timeEnd = new Date();
-  const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-  log(`Execution time: ${seconds} seconds`);
-
-  return { ...record, ...object };
-};
-
-/**
- * Get Objects
- *
- * @param offset
- * @param limit
- * @param filterKey
- * @param filterValue
- * @returns
- */
-const getObjects = async (
-  offset: number,
-  limit: number,
-  filterKey?: string,
-  filterValue?: string
-): Promise<AlgoliaPaginateRecords> => {
-  const client = await getClient();
-
-  const opts: any = {
-    content_type: "topicStory",
-    limit,
-    skip: offset,
-    // select: "",
-  };
-  if (filterKey && filterValue) {
-    opts[filterKey] = filterValue;
-  }
-  const { items, total } = await client.withAllLocales.getEntries(opts);
-
-  const objects: AlgoliaStoryRecord[] = [];
-  let count: number = Number(offset);
-  for (const topicStory of items) {
-    log(`${++count} of ${total}`, "INFO");
-    const timeStart = new Date();
-    const record = await getObject(topicStory);
-    const timeEnd = new Date();
-    const seconds = secondBetweenTwoDate(timeStart, timeEnd);
-    log(`Execution time: ${seconds} seconds`);
-    objects.push(record);
-  }
-
-  return {
-    objects,
-    offset: Number(offset) + Number(limit),
-    limit: Number(limit),
-    completed: count >= total, // if is true the import is completed
-    total,
-  };
-};
-
-export const reindexStories = async (
-  offset: number = 0,
-  limit: number = 50,
-  filterKey: string = "",
-  filterValue: string = ""
-) => {
-  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
-  const timeStart = new Date();
-  log(
-    `reindexStories - filterKey: ${filterKey} filterValue: ${filterValue} offset: ${offset} limit: ${limit} `
-  );
-
-  const records = await getObjects(offset, limit, filterKey, filterValue);
-  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 removeStoryObject = async (objectId: string) => {
-  return removeIndexObject(objectId, indexKey);
-};