pim-import 2.77.0 → 2.78.2

package/src/libs/contentful.ts

@@ -28,9 +28,11 @@ import {
   secondBetweenTwoDate,
   getPimTranslations,
   keysToLowerCase,
+  replaceAll,
 } from "../utils";
 import { getSubFamilySlugDetails } from "../pim/methods/subfamilies";
 import { removeProductObject } from "../algolia/products";
+import { GenericData } from "../resources/ProductDetails";
 
 export type Config = {
   accessToken: string;
@@ -1386,3 +1388,59 @@ export const archiveEntry = async (
 
   return entry;
 };
+
+/**
+ * Format designer data field
+ *
+ * @param designer
+ * @returns
+ */
+export const getDesignerData = async (designer: GenericData) => {
+  const data: CreateEntryProps = {
+    fields: {
+      name: {},
+      code: {},
+    },
+  };
+
+  data.fields.name = getPimTranslations(designer);
+  data.fields = await addFieldValue(data, "code", designer.code);
+
+  return data;
+};
+
+export const addDesignerData = async (
+  data: any,
+  designer: GenericData,
+  manyReferences: boolean = false
+) => {
+  const designerId = replaceAll(designer.code, ",", "_");
+  log(`Set designer relation: ${designer.code}`);
+  let designerEntry: Entry = await getEntryByCode(
+    designer.code,
+    "topicDesigner",
+    "sys"
+  );
+
+  if (!designerEntry) {
+    log(`${designer.code} designer not found, creating it...`);
+    const designerData = await getDesignerData(designer);
+    designerEntry = await createEntryWithId(
+      "topicDesigner",
+      designerId,
+      designerData,
+      true
+    );
+  } else {
+    log(`${designerId} designer already exists`);
+  }
+
+  data.fields = await addToRelationFields(
+    data,
+    manyReferences ? "designers" : "designer",
+    designerEntry.sys.id,
+    manyReferences
+  );
+
+  return data.fields;
+};

package/src/pim/methods/products.ts

@@ -1,7 +1,6 @@
 import {
   ProductDetails,
   AssetsEntity,
-  GenericData,
   ColourVariant,
 } from "../../resources/ProductDetails";
 import { AllProductsEntry } from "../../resources/AllProducts";
@@ -32,6 +31,7 @@ import {
   getDictionaryJson,
   getAllEntries,
   archiveEntry,
+  addDesignerData,
 } from "../../libs/contentful";
 import type {
   Entry,
@@ -47,7 +47,6 @@ import {
   sanitizeValue,
   getPimTranslations,
   basename,
-  replaceAll,
 } from "../../utils";
 import {
   saveAllProductsToS3,
@@ -581,20 +580,6 @@ const getProductAssets = async (
   return assets;
 };
 
-const getDesignerData = async (designer: GenericData) => {
-  const data: CreateEntryProps = {
-    fields: {
-      name: {},
-      code: {},
-    },
-  };
-
-  data.fields.name = getPimTranslations(designer);
-  data.fields = await addFieldValue(data, "code", designer.code);
-
-  return data;
-};
-
 const getProductData = async (
   productEntry: Entry,
   productDetails: ProductDetails
@@ -931,33 +916,13 @@ const getProductData = async (
   // designers
   if (productDetails.designers) {
     for (const designer of productDetails.designers) {
-      const designerId = replaceAll(designer.code, ",", "_");
-      log(`Set designer relation: ${designer.code}`);
-      let designerEntry: Entry = await getEntryByCode(
-        designer.code,
-        "topicDesigner",
-        "sys"
-      );
-
-      if (!designerEntry) {
-        log(`${designer.code} designer not found, creating it...`);
-        const designerData = await getDesignerData(designer);
-        designerEntry = await createEntryWithId(
-          "topicDesigner",
-          designerId,
-          designerData,
-          true
-        );
-      } else {
-        log(`${designerId} designer already exists`);
-      }
-
-      data.fields = await addToRelationFields(
-        data,
-        "designers",
-        designerEntry.sys.id,
-        true
-      );
+      data.fields = await addDesignerData(data, designer, true);
+    }
+  } else {
+    log(`No designers found`, "WARN");
+    if (data.fields.designers?.[defaultEnvironmentLocaleCode]) {
+      log(`remove old designers relation`);
+      data.fields.designers = [];
     }
   }
 

package/src/pim/methods/subfamilies.ts

@@ -9,6 +9,7 @@ import {
   cfLocales,
   addToRelationFields,
   addFieldValue,
+  addDesignerData,
 } from "../../libs/contentful";
 import { log } from "../../libs/logs";
 import type {
@@ -276,6 +277,7 @@ const getTopicSubFamilyData = async (
   catalog: AvailableCatalogs,
   topicSubFamily: Entry
 ) => {
+  const defaultEnvironmentLocaleCode = await getEnvironmentDefaultLocaleCode();
   const data: CreateEntryProps = {
     fields: topicSubFamily?.fields || {},
   };
@@ -377,6 +379,23 @@ const getTopicSubFamilyData = async (
     );
   }
 
+  // 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 = {};
+      }
+    }
+  }
+
   // lastPimSyncDate
   data.fields = await addFieldValue(data, "lastPimSyncDate", getLocalISOTime());
 

package/src/resources/CollectionSubFamilies.ts

@@ -5,12 +5,12 @@ export interface CollectionSubFamilies {
   pagedCollection?: PagedCollectionEntity[] | null;
 }
 export interface PagedCollectionEntity {
-  data: Data;
+  data: GenericData;
   priority?: number;
   catalogCode: string;
   categoryCode: string;
   parentFamily: ParentFamily;
-  designers?: null[] | null;
+  designers?: GenericData[] | null;
   relatedProducts?: string[] | null;
   description1_en?: string;
   description1_en_us?: string;
@@ -23,10 +23,10 @@ export interface PagedCollectionEntity {
   description1_da?: string;
   description1_ru?: string;
 }
-export interface Data {
+export interface GenericData {
   code: string;
   value_en: string;
-  value_en_US: string;
+  value_en_US?: string;
   value_it: string;
   value_es: string;
   value_de: string;
@@ -39,6 +39,6 @@ export interface Data {
 }
 export interface OthersData {}
 export interface ParentFamily {
-  data: Data;
-  designers?: null[] | null;
+  data: GenericData;
+  designers?: GenericData[] | null;
 }

package/src/resources/ProductDetails.ts

@@ -99,7 +99,7 @@ export interface GenericData {
   image?: null;
   imageAlternative?: null;
   value_en: string;
-  value_en_US?: null;
+  value_en_US?: string;
   value_it: string;
   value_es: string;
   value_de: string;

package/tsconfig.json

@@ -10,7 +10,8 @@
     // "allowJs": true,                             /* Allow javascript files to be compiled. */
     // "checkJs": true,                             /* Report errors in .js files. */
     // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-    //"declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    "declarationDir": "./types",
     //"declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
     "sourceMap": true,                           /* Generates corresponding '.map' file. */
     // "outFile": "./",                             /* Concatenate and emit output to single file. */

package/types/algolia/clean.d.ts

@@ -0,0 +1,10 @@
+import { AvailableCatalogs, AvailableEntryStatus } from "../types";
+import { AvailableIndicesKey } from "./config";
+export declare const removeRecordsByStatus: (indexKey: AvailableIndicesKey, offset?: number, limit?: number, status?: AvailableEntryStatus, catalogCode?: AvailableCatalogs | undefined) => Promise<false | {
+    objectIds: string[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;

package/types/algolia/config.d.ts

@@ -0,0 +1,96 @@
+export declare type AvailableIndicesKey = "products" | "families" | "subFamilies" | "subModels" | "models" | "downloads" | "projects" | "stories" | "pressReviews" | "pressRelease" | "news";
+export declare const getClient: () => import("algoliasearch").SearchClient;
+export declare const getIndicesSettings: () => {
+    products: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+        };
+    };
+    families: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+        };
+    };
+    subFamilies: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+        };
+    };
+    subModels: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+        };
+    };
+    models: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+        };
+    };
+    downloads: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+            replicas: string[];
+        };
+    };
+    projects: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+            ranking: string[];
+            replicas: string[];
+        };
+    };
+    stories: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+            ranking: string[];
+            replicas: string[];
+        };
+    };
+    pressReviews: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+            ranking: string[];
+            replicas: never[];
+        };
+    };
+    pressRelease: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+            ranking: string[];
+            replicas: never[];
+        };
+    };
+    news: {
+        name: string | undefined;
+        settings: {
+            attributesForFaceting: string[];
+            searchableAttributes: string[];
+            ranking: string[];
+            replicas: never[];
+        };
+    };
+};
+export declare const getIndexConfig: (indexKey: AvailableIndicesKey) => any;
+export declare const getIndex: (indexKey: AvailableIndicesKey) => import("algoliasearch").SearchIndex;
+export declare const resetIndexSettings: (indexKey: AvailableIndicesKey) => import("algoliasearch").SearchIndex;
+export declare const removeIndexObject: (objectId: string, indexKey: AvailableIndicesKey) => Promise<void>;

package/types/algolia/downloads.d.ts

@@ -0,0 +1,36 @@
+import { CfLocalizedEntryField, TopicDetailsResponse, WrapperImageFields } from "../types";
+export declare type AlgoliaDownloadRecord = {
+    objectID: string;
+    name?: CfLocalizedEntryField;
+    thumbnailImgix?: WrapperImageFields | {};
+    assets?: {};
+    catalogs?: TopicDetailsResponse[];
+    category?: TopicDetailsResponse;
+    brand?: string;
+    type?: string;
+    lastSyncDate?: string;
+};
+export declare const getAssetsByComponentAssetIds: (componentAssetIds: string[]) => Promise<any>;
+export declare const reindexDownload: (topicDownloadId: string) => Promise<false | {
+    objectID: string;
+    name?: Partial<Record<import("../types").ContentfulLocale, string | null>> | undefined;
+    thumbnailImgix?: {} | WrapperImageFields | undefined;
+    assets?: {} | undefined;
+    catalogs?: TopicDetailsResponse[] | undefined;
+    category?: TopicDetailsResponse | undefined;
+    brand?: string | undefined;
+    type?: string | undefined;
+    lastSyncDate?: string | undefined;
+    taskID: number;
+}>;
+export declare const reindexDownloads: (offset?: number, limit?: number, filterKey?: string, filterValue?: string) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const removeDownloadObject: (objectId: string) => Promise<void>;

package/types/algolia/families.d.ts

@@ -0,0 +1,48 @@
+import { CfLocalizedEntryField, TopicDetailsResponse, TopicProductFieldsResponse, WrapperImageFields, AvailableCatalogs } from "../types";
+export declare type pageResponse = {
+    slugs: {};
+    type: string;
+    details?: {};
+} | null;
+export declare type AlgoliaFamilyRecord = {
+    objectID: string;
+    names: CfLocalizedEntryField;
+    code: string;
+    thumbnailImgix: WrapperImageFields | {};
+    fullScreenImageImgix: WrapperImageFields | {};
+    slugs: {} | null;
+    slugType: string | null;
+    catalogs: TopicDetailsResponse[];
+    categories: TopicDetailsResponse[];
+    productFields: TopicProductFieldsResponse[];
+    isNew: boolean;
+    priority: number;
+    lastSyncDate: string;
+};
+export declare const reindexFamilies: (offset?: number, limit?: number, catalogCode?: AvailableCatalogs | undefined) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const reindexFamily: (topicFamilyEntryId: string) => Promise<{
+    objectID: string;
+    names: CfLocalizedEntryField;
+    code: string;
+    thumbnailImgix: WrapperImageFields | {};
+    fullScreenImageImgix: WrapperImageFields | {};
+    slugs: {} | null;
+    slugType: string | null;
+    catalogs: TopicDetailsResponse[];
+    categories: TopicDetailsResponse[];
+    productFields: TopicProductFieldsResponse[];
+    isNew: boolean;
+    priority: number;
+    lastSyncDate: string;
+    taskID: number;
+}>;
+export declare const removeFamilyObject: (objectId: string) => Promise<void>;

package/types/algolia/models.d.ts

@@ -0,0 +1,31 @@
+import { TopicDetailsResponse, AvailableCatalogs, WrapperImageFields } from "../types";
+export declare const reindexModel: (topicModelId: string) => Promise<{
+    objectID: string;
+    names?: Partial<Record<import("../types").ContentfulLocale, string | null>> | undefined;
+    code?: string | undefined;
+    slugs?: {} | undefined;
+    description?: string | undefined;
+    autodescription?: string | undefined;
+    thumbnailImgix?: {} | WrapperImageFields | undefined;
+    productFieldFilter?: string | undefined;
+    productLine?: TopicDetailsResponse | undefined;
+    catalog?: TopicDetailsResponse | undefined;
+    subFamily?: TopicDetailsResponse | undefined;
+    isNew?: boolean | undefined;
+    priority?: number | undefined;
+    colors?: string[] | undefined;
+    designer?: TopicDetailsResponse | undefined;
+    lastSyncDate?: string | undefined;
+    taskID: number;
+}>;
+export declare const reindexModels: (offset?: number, limit?: number, catalogCode?: AvailableCatalogs | undefined) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const removeModelObject: (topicModelId: string) => Promise<void>;

package/types/algolia/news.d.ts

@@ -0,0 +1,33 @@
+import { CfLocalizedEntryField, WrapperImageFields } from "../types";
+export declare type AlgoliaPostRecord = {
+    objectID: string;
+    name?: CfLocalizedEntryField;
+    slugs?: {};
+    previewExcerpt?: string;
+    thumbnailImageImgix?: WrapperImageFields | {};
+    fullScreenImageImgix?: WrapperImageFields | {};
+    visualizationDate?: string;
+    lastSyncDate?: string;
+};
+export declare const reindexPost: (topicNewsId: string) => Promise<false | {
+    objectID: string;
+    name?: Partial<Record<import("../types").ContentfulLocale, string | null>> | undefined;
+    slugs?: {} | undefined;
+    previewExcerpt?: string | undefined;
+    thumbnailImageImgix?: {} | WrapperImageFields | undefined;
+    fullScreenImageImgix?: {} | WrapperImageFields | undefined;
+    visualizationDate?: string | undefined;
+    lastSyncDate?: string | undefined;
+    taskID: number;
+}>;
+export declare const reindexPosts: (offset?: number, limit?: number, filterKey?: string, filterValue?: string) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const removePostObject: (objectId: string) => Promise<void>;

package/types/algolia/pipedreamReindex.d.ts

@@ -0,0 +1,4 @@
+import { AvailableCatalogs } from "src/types";
+declare type AvailablreReindexType = "reindexFamilies" | "reindexSubFamilies";
+export declare const pipedreamReindex: (reindexType: AvailablreReindexType, catalogCode: AvailableCatalogs) => Promise<void>;
+export {};

package/types/algolia/pressRelease.d.ts

@@ -0,0 +1,33 @@
+import { CfLocalizedEntryField, WrapperImageFields, TopicDetailsResponse } from "../types";
+export declare type AlgoliaPressReleaseRecord = {
+    objectID: string;
+    name?: CfLocalizedEntryField;
+    description?: string;
+    thumbnailImgix?: WrapperImageFields | {};
+    lastSyncDate?: string;
+    category?: TopicDetailsResponse;
+    assets?: {};
+    visualizationDate?: string;
+};
+export declare const reindexPressRelease: (topicPressReleaseId: string) => Promise<false | {
+    objectID: string;
+    name?: Partial<Record<import("../types").ContentfulLocale, string | null>> | undefined;
+    description?: string | undefined;
+    thumbnailImgix?: {} | WrapperImageFields | undefined;
+    lastSyncDate?: string | undefined;
+    category?: TopicDetailsResponse | undefined;
+    assets?: {} | undefined;
+    visualizationDate?: string | undefined;
+    taskID: number;
+}>;
+export declare const reindexPressReleases: (offset?: number, limit?: number, filterKey?: string, filterValue?: string) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const removePressReleaseObject: (objectId: string) => Promise<void>;

package/types/algolia/pressReview.d.ts

@@ -0,0 +1,33 @@
+import { CfLocalizedEntryField, WrapperImageFields } from "../types";
+export declare type AlgoliaPressReviewRecord = {
+    objectID: string;
+    name?: CfLocalizedEntryField;
+    yearOfRelease?: string;
+    monthOfRelease?: string;
+    country?: string;
+    thumbnailImgix?: WrapperImageFields | {};
+    asset?: {};
+    lastSyncDate?: string;
+};
+export declare const reindexPressReview: (topicPressReviewId: string) => Promise<false | {
+    objectID: string;
+    name?: Partial<Record<import("../types").ContentfulLocale, string | null>> | undefined;
+    yearOfRelease?: string | undefined;
+    monthOfRelease?: string | undefined;
+    country?: string | undefined;
+    thumbnailImgix?: {} | WrapperImageFields | undefined;
+    asset?: {} | undefined;
+    lastSyncDate?: string | undefined;
+    taskID: number;
+}>;
+export declare const reindexPressReviews: (offset?: number, limit?: number, filterKey?: string, filterValue?: string) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const removePressReviewObject: (objectId: string) => Promise<void>;

package/types/algolia/products.d.ts

@@ -0,0 +1,75 @@
+import { CfLocalizedEntryField, TopicDetailsResponse, WrapperImageFields } from "../types";
+export declare type AlgoliaProductRecord = {
+    objectID: string;
+    name?: string;
+    names?: CfLocalizedEntryField;
+    code?: string;
+    slugs?: {};
+    description?: {};
+    excerpt?: {};
+    autoDescription?: string;
+    thumbnailImgix?: WrapperImageFields | {};
+    catalogs?: TopicDetailsResponse[];
+    categoriesArchitectural?: TopicDetailsResponse[];
+    categoriesOutdoor?: TopicDetailsResponse[];
+    categoriesDecorative?: TopicDetailsResponse[];
+    families?: TopicDetailsResponse[];
+    subFamiliesArchitectural?: TopicDetailsResponse[];
+    subFamiliesOutdoor?: TopicDetailsResponse[];
+    subFamiliesDecorative?: TopicDetailsResponse[];
+    modelsArchitectural?: TopicDetailsResponse[];
+    modelsOutdoor?: TopicDetailsResponse[];
+    modelsDecorative?: TopicDetailsResponse[];
+    subModelsArchitectural?: TopicDetailsResponse[];
+    subModelsOutdoor?: TopicDetailsResponse[];
+    subModelsDecorative?: TopicDetailsResponse[];
+    productLine?: TopicDetailsResponse;
+    productSubLine?: TopicDetailsResponse;
+    designers?: TopicDetailsResponse[];
+    designYear?: string;
+    productFields?: any;
+    lastSyncDate?: string;
+};
+export declare const reindexProduct: (topicProductId: string, generatePdf?: boolean) => Promise<false | {
+    objectID: string;
+    name?: string | undefined;
+    names?: Partial<Record<import("../types").ContentfulLocale, string | null>> | undefined;
+    code?: string | undefined;
+    slugs?: {} | undefined;
+    description?: {} | undefined;
+    excerpt?: {} | undefined;
+    autoDescription?: string | undefined;
+    thumbnailImgix?: {} | WrapperImageFields | undefined;
+    catalogs?: TopicDetailsResponse[] | undefined;
+    categoriesArchitectural?: TopicDetailsResponse[] | undefined;
+    categoriesOutdoor?: TopicDetailsResponse[] | undefined;
+    categoriesDecorative?: TopicDetailsResponse[] | undefined;
+    families?: TopicDetailsResponse[] | undefined;
+    subFamiliesArchitectural?: TopicDetailsResponse[] | undefined;
+    subFamiliesOutdoor?: TopicDetailsResponse[] | undefined;
+    subFamiliesDecorative?: TopicDetailsResponse[] | undefined;
+    modelsArchitectural?: TopicDetailsResponse[] | undefined;
+    modelsOutdoor?: TopicDetailsResponse[] | undefined;
+    modelsDecorative?: TopicDetailsResponse[] | undefined;
+    subModelsArchitectural?: TopicDetailsResponse[] | undefined;
+    subModelsOutdoor?: TopicDetailsResponse[] | undefined;
+    subModelsDecorative?: TopicDetailsResponse[] | undefined;
+    productLine?: TopicDetailsResponse | undefined;
+    productSubLine?: TopicDetailsResponse | undefined;
+    designers?: TopicDetailsResponse[] | undefined;
+    designYear?: string | undefined;
+    productFields?: any;
+    lastSyncDate?: string | undefined;
+    taskID: number;
+}>;
+export declare const reindexProducts: (filterKey: string, filterValue: string, offset?: number, limit?: number, lastPimSyncDateGte?: string | undefined, generatePdf?: boolean) => Promise<{
+    taskIDs: number[];
+    objectIDs: string[];
+    objects: Readonly<Record<string, any>>[];
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath?: string | undefined;
+    total?: number | undefined;
+}>;
+export declare const removeProductObject: (topicProductId: string) => Promise<void>;