@bytebrand/export-cars 1.7.1 → 1.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytebrand/export-cars",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "",
   "author": "bytebrand",
   "license": "UNLICENSED",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=14.0.0"
   },
-  "gitHead": "576796025589c6f58778c40db7429e15926edfa1"
+  "gitHead": "b7be73fdc44db2ae19fef0b970b05b90ff6a0b7a"
 }

package/src/configs/facebook-shop.config.ts

@@ -0,0 +1,14 @@
+import { Params } from '../interfaces/params.interface';
+import { Config } from './config';
+import { ExportType, FileType } from '../enums';
+
+export class FacebookShopConfig extends Config {
+  constructor(params: Params) {
+    super(params);
+    this.pathesConfig.localConvertedDirectory = `resources/${ExportType.FACEBOOK_SHOP}-export`;
+    this.imageUrl = this.environmentConfig[params.environment].baseImageUrl;
+    this.outputFiles = [
+      `${this.pathesConfig.localConvertedDirectory}/api_export_cars_${ExportType.FACEBOOK_SHOP}.${FileType.XML}`,
+    ];
+  }
+}

package/src/configs/index.ts

@@ -14,3 +14,4 @@ export * from './meinstadt.config';
 export * from './ooyyo.config';
 export * from './yescar.config';
 export * from './autoboerse.config';
+export * from './facebook-shop.config';

package/src/enums/export-type.enum.ts

@@ -1,7 +1,7 @@
 export enum ExportType {
   /**
-  * @deprecated
-  */
+   * @deprecated
+   */
   YESCAR = 'yescar',
   MARKTDE = 'marktde',
   EAUTO = 'eauto',
@@ -12,16 +12,17 @@ export enum ExportType {
   OOYYO = 'ooyyo',
   MEINSTADT = 'meinstadt',
   /**
-  * @deprecated
-  */
+   * @deprecated
+   */
   BY_OWNER = 'by-owner',
   AUTOUNCLE = 'autouncle',
   /**
-  * @deprecated
-  */
+   * @deprecated
+   */
   AS24 = 'as24',
   ALLESKRALLE = 'alleskralle',
   DASPARKING = 'dasparking',
   KLEINANZEIGE_FOCUS = 'kleinanzeigefocus',
   CRITEO = 'criteo',
+  FACEBOOK_SHOP = 'facebookshop',
 }

package/src/enums/index.ts

@@ -1,2 +1,3 @@
 export * from './file-types.enum';
 export * from './export-type.enum';
+export * from './environment.enum';

package/src/export.schema.ts

@@ -16,7 +16,8 @@ import {
   KleinanzeigeFocusConfig,
   AutoboerseConfig,
   ByOwnerConfig,
-  CriteoConfig
+  FacebookShopConfig,
+  CriteoConfig,
 } from './configs';
 import {
   As24Exporter,
@@ -29,10 +30,10 @@ import {
   MobileExporter,
   OoyyoExporter,
   ModixExporter,
-  RubrikkExporter
+  RubrikkExporter,
+  FacebookShopExporter,
 } from './exporters';
 
-
 export const exportSchema = {
   [ExportType.EAUTO]: {
     config: EautoConfig,
@@ -98,4 +99,8 @@ export const exportSchema = {
     config: CriteoConfig,
     exporter: GoogleExporter,
   },
+  [ExportType.FACEBOOK_SHOP]: {
+    config: FacebookShopConfig,
+    exporter: FacebookShopExporter,
+  },
 };

package/src/exporters/facebook-shop.exporter.ts

@@ -0,0 +1,51 @@
+import { Injectable } from '@nestjs/common';
+import { ModuleRef } from '@nestjs/core';
+
+import { CronicleUtils } from '@bytebrand/cronicle-helper';
+import { FsChunkInterface } from '@bytebrand/chunkable';
+
+import { CarService, ConfigService, LoaderService, RulesService } from '../services';
+import { Exporter } from '../interfaces/exporter.interface';
+import { FacebookShopTransformer } from '../transformers';
+import { FacebookShopXmlBuilder } from '../formats';
+
+@Injectable()
+export class FacebookShopExporter implements Exporter {
+  constructor(
+    private carService: CarService,
+    private configService: ConfigService,
+    private loaderService: LoaderService,
+    private moduleRef: ModuleRef,
+    private rulesService: RulesService,
+  ) {}
+
+  async export(): Promise<void> {
+    const [fileXml] = this.configService.config.outputFiles;
+    await CronicleUtils.ensureDir(this.configService.config.pathesConfig.localConvertedDirectory);
+    await CronicleUtils.emptyDir(this.configService.config.pathesConfig.localConvertedDirectory);
+
+    const facebookShopXmkBuilder = new FacebookShopXmlBuilder(fileXml);
+    await facebookShopXmkBuilder.buildStart();
+
+    const facebookShopTransformer = await this.moduleRef.create(FacebookShopTransformer);
+
+    await this.loaderService.process(async (chunk: FsChunkInterface) => {
+      const chunkData = chunk.data.filter(car => this.carService.filterCar(car, this.rulesService.rules));
+
+      if (chunk && chunkData) {
+        for (let i = 0; i < chunk.data.length; i += 1) {
+          const data = chunk.data[i];
+
+          const transformedCar = await facebookShopTransformer.transform(data);
+
+          await facebookShopXmkBuilder.addItem(transformedCar);
+          this.carService.counter.countCar(data.images);
+        }
+      }
+    });
+
+    await facebookShopXmkBuilder.buildEnd();
+
+    console.log(this.carService.counter.getCountedCars());
+  }
+}

package/src/exporters/fb.exporter.ts

@@ -1,5 +1,5 @@
 import { Injectable } from '@nestjs/common';
-import { CarService, RulesService, LoaderService, ConfigService, UserService } from '../services';
+import { CarService, RulesService, LoaderService, ConfigService } from '../services';
 import { FsChunkInterface } from '@bytebrand/chunkable';
 import { Exporter } from '../interfaces/exporter.interface';
 import { CronicleUtils } from '@bytebrand/cronicle-helper';
@@ -17,7 +17,7 @@ export class FbExporter implements Exporter {
     private rulesService: RulesService,
     private loaderService: LoaderService,
     private moduleRef: ModuleRef,
-  ) { }
+  ) {}
 
   async export(): Promise<void> {
     const [fileName] = this.configService.config.outputFiles;
@@ -36,7 +36,7 @@ export class FbExporter implements Exporter {
         const ownerId = get(data.car, 'metaData.ownerId', null);
         const owner = await this.carService.getOwner(ownerId);
         const car = await fbTransformer.transform({ owner, ...data });
-        
+
         await fbXmlBuilder.addItem(car as FbXmlItem);
         this.carService.counter.countCar(data.images);
       }

package/src/exporters/index.ts

@@ -9,3 +9,4 @@ export * from './mobile.exporter';
 export * from './modix.exporter';
 export * from './ooyyo.exporter';
 export * from './rubrikk.exporter';
+export * from './facebook-shop.exporter';

package/src/exporters/modix.exporter.ts

@@ -1,4 +1,4 @@
-import { Inject, Injectable } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
 
 import { CronicleUtils, ImportOrigins } from '@bytebrand/cronicle-helper';
@@ -10,7 +10,6 @@ import { Exporter } from '../interfaces/exporter.interface';
 import { ModixTransformer } from '../transformers';
 import { ModixXmlBuilder } from '../formats';
 
-
 @Injectable()
 export class ModixExporter implements Exporter {
   constructor(
@@ -38,16 +37,18 @@ export class ModixExporter implements Exporter {
         for (let i = 0; i < chunk.data.length; i += 1) {
           const data = chunk.data[i];
 
-          const transformedCar = await modixTransformer.transform(data, mappingBuilder.getMappingRules({ reversTransforming: true }));
+          const transformedCar = await modixTransformer.transform(
+            data,
+            mappingBuilder.getMappingRules({ reversTransforming: true }),
+          );
           await modixXmlBuilder.addItem(transformedCar);
 
           this.carService.counter.countCar(data.images);
         }
-
       }
     });
 
     await modixXmlBuilder.buildEnd();
-    console.log(this.carService.counter.getCountedCars())
+    console.log(this.carService.counter.getCountedCars());
   }
 }

package/src/formats/facebook-shop.builder.ts

@@ -0,0 +1,69 @@
+import { XMLBuilderBase } from '@bytebrand/cronicle-helper';
+import { FacebookShopItem, FacebookShopTag } from '../interfaces';
+import { Description, DescriptionValue } from '../interfaces/description.interface';
+import { isNotEmptyArray } from '../utils/validator.utils';
+
+export class FacebookShopXmlBuilder extends XMLBuilderBase {
+  async buildStart(): Promise<void> {
+    await this.write(
+      '<?xml version="1.0" encoding="utf-8"?>\n<rss version="2.0" xmlns:g="http://base.google.com/ns/1.0" xmlns:atom="http://www.w3.org/2005/Atom">' +
+        '\n<channel>\n<title>Produkt für auto.de</title>\n<description>Produkt für auto.de</description> \n<link>https://www.auto.de/</link>\n' +
+        '<atom:link href="https://www.mydealsshop.foo/pages/test-feed" rel="self" type="application/rss+xml" />\n',
+    );
+  }
+
+  async addItem(car: FacebookShopItem): Promise<void> {
+    let item = '\n<item>\n';
+
+    const tags = Object.keys(car);
+
+    for (const tag of tags) {
+      if (tag === 'description') {
+        item += this.getDescriptionElement(tag, car[tag].value);
+      } else {
+        item += this.buildTagElement(tag, car[tag]);
+      }
+    }
+    item += '</item>';
+
+    await this.write(item);
+  }
+
+  buildTagElement(tag: string, params: FacebookShopTag) {
+    if (params.isGoogle) {
+      return this.getElement(`g:${tag}`, params.value);
+    }
+    return this.getElement(tag, params.value);
+  }
+  private getDescriptionElement(rootTag: string, descriptionBlocks: Description[]): string {
+    const description: string = descriptionBlocks
+      .map(({ title, values }: Description) => {
+        if (values) {
+          return `${title}\n${this.buildDescriptionValues(values)} `;
+        }
+        return '';
+      })
+      .join('\n');
+    return `<${rootTag}>${description}</${rootTag}>`;
+  }
+
+  private buildDescriptionValues(values: DescriptionValue[]): string {
+    const validValues = [];
+
+    values.forEach(element => {
+      const filteredValues = element.value.filter(el => el);
+      if (isNotEmptyArray(filteredValues)) validValues.push(element);
+    });
+
+    return validValues
+      .map(({ title, value }: DescriptionValue) => {
+        return `${title}: ${value.join(', ')}`;
+      })
+      .join(';\n');
+  }
+
+  async buildEnd(): Promise<void> {
+    await this.write('\n</channel>\n</rss>\n');
+    await this.end();
+  }
+}

package/src/formats/index.ts

@@ -1,2 +1,3 @@
 export * from './rubrikk-xml.builder';
 export * from './modix-xml.builder';
+export * from './facebook-shop.builder';

package/src/interfaces/export-item.interface.ts

@@ -1,6 +1,7 @@
 import { DataSchemes } from '@bytebrand/car-schema';
 
 import { IModixWrapItem } from './autoborse.intreface';
+import { Description } from './description.interface';
 
 export interface FbXmlItem {
   url: string;
@@ -279,3 +280,28 @@ export interface dealerItem {
     vatid: IModixWrapItem;
   };
 }
+
+export interface FacebookShopItem {
+  id: FacebookShopTag;
+  title: FacebookShopTag;
+  description: { value: Description[]; isGoogle: boolean };
+  availability: FacebookShopTag;
+  condition: FacebookShopTag;
+  price: FacebookShopTag;
+  link: FacebookShopTag;
+  image_link: FacebookShopTag;
+  additional_image_link: FacebookShopTag;
+  brand: FacebookShopTag;
+
+  quantity_to_sell_on_facebook: FacebookShopTag;
+  google_product_category: FacebookShopTag;
+  sale_price: FacebookShopTag;
+  status: FacebookShopTag;
+  color: FacebookShopTag;
+  product_type: FacebookShopTag;
+}
+
+export interface FacebookShopTag {
+  isGoogle: boolean;
+  value: any;
+}

package/src/interfaces/params.interface.ts

@@ -1,5 +1,4 @@
-import { Environment } from '../enums/environment.enum';
-import { ExportType } from '../enums/export-type.enum';
+import { ExportType, Environment } from '../enums';
 
 export interface Params {
   environment: Environment;

package/src/transformers/autouncle.transformer.ts

@@ -5,7 +5,7 @@ import * as moment from 'moment';
 import { DataSchemes } from '@bytebrand/car-schema';
 import { DePostalCodesService } from '@bytebrand/car-basic-data-scope';
 import { DePostalCodesEntryInterface } from '@bytebrand/car-basic-data-scope/dist/interfaces/DePostalCodesInterface';
-import { ConfigService } from '../services/config.service';
+import { ConfigService } from '../services';
 import { Injectable } from '@nestjs/common';
 import { DEFAULT_ADDR1, DEFAULT_CITY, DEFAULT_ZIP, MIN_MILEAGES } from '../constants/autouncle.contants';
 import { AutouncleJsonItem } from '../interfaces';

package/src/transformers/facebook-shop.transformer.ts

@@ -0,0 +1,94 @@
+import { Injectable } from '@nestjs/common';
+
+import { escape, get, join, round, toString, trim } from 'lodash';
+
+import { de, deVehicleDetailsPage, deVehicleProps } from '@bytebrand/i18n-dictionaries';
+import { TranslatorExtended } from '@bytebrand/schema-tools';
+import { DataSchemes } from '@bytebrand/car-schema';
+
+import { FacebookShopItem } from '../interfaces';
+import { ConfigService } from '../services';
+import { Description } from '../interfaces/description.interface';
+import { FbDescription } from './fb-description.transformer';
+import { FbEquipment } from './fb-equipment.transformer';
+
+@Injectable()
+export class FacebookShopTransformer {
+  private translator: TranslatorExtended;
+
+  constructor(private readonly configService: ConfigService) {
+    const dict = { ...de, ...deVehicleProps, ...deVehicleDetailsPage };
+    this.translator = new TranslatorExtended(dict);
+  }
+
+  async transform({ car }: { car: DataSchemes.Car }): Promise<FacebookShopItem> {
+    return {
+      id: { value: get(car, 'metaData.vehicleId'), isGoogle: true },
+      title: { value: this.getTitle(car), isGoogle: true },
+      description: { value: this.getDescription(car), isGoogle: true },
+      availability: { value: 'in stock', isGoogle: true },
+      condition: { value: this.getCondition(car), isGoogle: true },
+      price: { value: this.getPrice(car), isGoogle: true },
+      link: { value: this.getCarLink(car), isGoogle: true },
+      image_link: { value: this.getImageLink(car), isGoogle: true },
+      brand: { value: get(car, 'mainData.make', ''), isGoogle: true },
+      additional_image_link: { value: this.getImageLink(car), isGoogle: false },
+      quantity_to_sell_on_facebook: { value: 1, isGoogle: true },
+      google_product_category: { value: '916', isGoogle: true },
+      sale_price: { value: this.getPrice(car), isGoogle: true },
+      status: { value: 'active', isGoogle: true },
+      color: { value: this.getColor(car), isGoogle: false },
+      product_type: {
+        value: 'Vehicles &amp; Parts > Vehicles > Motor Vehicles > Cars, Trucks &amp; Vans',
+        isGoogle: true,
+      },
+    };
+  }
+
+  private getTitle(car: DataSchemes.Car): string {
+    const year = toString(get(car, 'mainData.constructionYear', ''));
+    const make = toString(get(car, 'mainData.make', ''));
+    const model = toString(get(car, 'mainData.model', ''));
+    const subModel = toString(get(car, 'mainData.subModel', ''));
+    return trim(escape(join([year, make, model, subModel], ' ')));
+  }
+
+  private getCondition(car: DataSchemes.Car): string {
+    const available = {
+      selector_condition_new: 'New',
+      selector_condition_used: 'Used',
+      selector_unknown: 'New',
+    };
+    const condition = get(car, 'mainData.condition', 'selector_unknown');
+    return get(available, condition);
+  }
+
+  private getCarLink(car: DataSchemes.Car): string {
+    return `https://${this.configService.config.domain}/search/vehicle/${car._id}`;
+  }
+
+  private getPrice(car: DataSchemes.Car): string {
+    const price = get(car, 'price.currentSalesPrice', 0);
+    return `${round(price, 2)} EUR`;
+  }
+
+  private getColor(car: DataSchemes.Car): string {
+    let colorSelection = get(car, 'exterior.exteriorColor', 'selector_unknown');
+    if (!colorSelection || colorSelection === 'selector_unknown') {
+      colorSelection = 'selector_unknown';
+    }
+    return this.translator.translateVal(colorSelection);
+  }
+
+  private getDescription(car: DataSchemes.Car): Description[] {
+    return FbDescription.create(car, this.translator, new FbEquipment()).getDescriptionArray();
+  }
+
+  //todo: move to image service
+  private getImageLink(car: DataSchemes.Car): string {
+    const mainImageId = get(car, 'metaData.mainImageId', '');
+    return mainImageId
+      ? `${this.configService.config.baseImageUrl}/carimage/${car._id}/${mainImageId}/large-cached.webp`
+      : `${this.configService.config.baseImageUrl}/carimage/noimage/7pNvWELuWhZX/large-cached.jpeg`;
+  }
+}

package/src/transformers/index.ts

@@ -1,2 +1,3 @@
 export * from './rubrikk.transformer';
 export * from './modix.transformer';
+export * from './facebook-shop.transformer';

package/src/transformers/meinstadt.transformer.ts

@@ -3,7 +3,7 @@ import { DataSchemes } from '@bytebrand/car-schema';
 
 import { de } from '@bytebrand/i18n-dictionaries';
 import { Injectable } from '@nestjs/common';
-import { ConfigService } from '../services/config.service';
+import { ConfigService } from '../services';
 import { MeinstadtJsonItem } from '../interfaces';
 
 @Injectable()
@@ -73,8 +73,7 @@ export class MeinstadtTransformer {
   private getDescription(car: DataSchemes.Car): string {
     const usageType = get(car, 'offer.offerDescription', null);
     if (usageType) {
-      const afterFromatting = usageType.replace(/\\/g, ',').replace(/\\/g, ',').replace(/,,/g, ',');
-      return afterFromatting;
+      return usageType.replace(/\\/g, ',').replace(/\\/g, ',').replace(/,,/g, ',');
     } else return null;
   }
 }

package/src/transformers/modix.transformer.ts

@@ -12,7 +12,7 @@ import { DataSchemes } from '@bytebrand/car-schema';
 import { imageItem, IModixWrapItem, ModixXmlItem } from '../interfaces';
 import { isNotEmptyArray, isValidVin } from '../utils/validator.utils';
 import { CategoryList } from '../constants/modix/category.constant';
-import { ConfigService } from '../services/config.service';
+import { ConfigService } from '../services';
 import {
   BodyColorList,
   VehicleClassList,
@@ -23,18 +23,17 @@ import {
   UsageTypeList,
 } from '../constants';
 
-
-
 @Injectable()
 export class ModixTransformer {
-  constructor(private readonly configService: ConfigService) { }
-
-  async transform(chunkData: { car: DataSchemes.Car; images: ImboImageResponseInterface[]; }, mappingRules: MappingRulesInterface[]): Promise<ModixXmlItem> {
+  constructor(private readonly configService: ConfigService) {}
 
+  async transform(
+    chunkData: { car: DataSchemes.Car; images: ImboImageResponseInterface[] },
+    mappingRules: MappingRulesInterface[],
+  ): Promise<ModixXmlItem> {
     const { car, images } = chunkData;
     // await this.buildOptions(car, mappingRules);
     return {
-
       //Main data
       maindata: {
         category: this.getCategoryData(car),
@@ -211,8 +210,17 @@ export class ModixTransformer {
     return { url, imageList };
   }
 
-  private async buildOptions(car: DataSchemes.Car, mappingRules: MappingRulesInterface[]): Promise<Omit<DataSchemes.Car, 'state'>> {
-    const transformer = TransformerFactory.createTransformer(ImportOrigins.MODIX, car, { importSelectorMappingLog: () => { } } as any, [{ make: 'make', model: 'model' }], ['alt_model']);
+  private async buildOptions(
+    car: DataSchemes.Car,
+    mappingRules: MappingRulesInterface[],
+  ): Promise<Omit<DataSchemes.Car, 'state'>> {
+    const transformer = TransformerFactory.createTransformer(
+      ImportOrigins.MODIX,
+      car,
+      { importSelectorMappingLog: () => {} } as any,
+      [{ make: 'make', model: 'model' }],
+      ['alt_model'],
+    );
     const { car: transformedCar } = await transformer.transform(mappingRules);
 
     return omit(transformedCar, ['state']);