@bytebrand/export-cars 1.22.30 → 1.23.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytebrand/export-cars",
-  "version": "1.22.30",
+  "version": "1.23.0",
   "description": "",
   "author": "bytebrand",
   "license": "UNLICENSED",
@@ -19,6 +19,7 @@
     "@bytebrand/car-schema": "^3.14.15",
     "@bytebrand/chunkable": "^5.19.8",
     "@bytebrand/cronicle-helper": "^1.21.8",
+    "@bytebrand/fe-financing": "^5.14.10",
     "@bytebrand/i18n-dictionaries": "^1.5.0",
     "@bytebrand/import-helper": "^0.45.0",
     "@bytebrand/schema-tools": "^3.18.8",

package/src/constants/fb.constants.ts

@@ -6,4 +6,17 @@ export const DEFAULT_CITY = 'Sandersdorf-Brehna';
 export const DEFAULT_ADDR1 = 'Max-Planck-Str. 19';
 export const TIMESTAMP_FIRST_YEAR = 1970;
 export const META_PUSH_PRIORITY_STANDARD = 'standard';
-export const META_PUSH_PRIORITY_ALLOWED_VALUES = ['user_priority_1', 'user_priority_2'];
+export const META_PUSH_PRIORITY_ALLOWED_VALUES = ['dealer_priority_1', 'dealer_priority_2'];
+
+export enum OfferType {
+  financing = 'financing',
+  leasing = 'leasing',
+  buy = 'buy',
+}
+
+export const OFFER_DISCLAIMER = 'Für Ihre Finanzierungswünsche stellen wir eine Bonitätsanfrage. Bonität ' +
+  'vorausgesetzt, ist dies ein repräsentatives Berechnungsbeispiel gem. der Angaben, welches 2/3 aller Kunden, ' +
+  'im Sinne des § 17a Abs. 4 PAngV, erhalten. Dieses freibleibende Angebot der Santander Consumer Bank AG, ' +
+  'Santander-Platz 1, 41061 Mönchengladbach wird vermittelt durch die auto.de GmbH, Max-Planck-Str. 19, 06796 ' +
+  'Sandersdorf-Brehna, die als ungebundener Vermittler nicht beratend tätig ist. Irrtümer vorbehalten. Preise ' +
+  'ggf. inkl. MwSt.';

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

@@ -36,10 +36,17 @@ export class FacebookShopExporter implements Exporter {
         const data = chunk.data[i];
 
         // console.time(`Transform ${data.car._id}`);
-        const transformedCar = await facebookShopTransformer.transform(data);
+        const items = await facebookShopTransformer.transform(data);
         // console.timeEnd(`Transform ${data.car._id}`);
 
-        await facebookShopXmkBuilder.addItem(transformedCar);
+        if (!items.length) {
+          console.log(`Skip car ${data.car._id} because it has no real images`);
+          continue;
+        }
+
+        for (const item of items) {
+          await facebookShopXmkBuilder.addItem(item);
+        }
         this.carService.counter.countCar(data.images);
       }
     });

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

@@ -1,7 +1,6 @@
+import { escape, isString } from 'lodash';
 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> {
@@ -18,11 +17,7 @@ export class FacebookShopXmlBuilder extends XMLBuilderBase {
     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 += this.buildTagElement(tag, car[tag]);
     }
     item += '</item>';
 
@@ -30,36 +25,11 @@ export class FacebookShopXmlBuilder extends XMLBuilderBase {
   }
 
   buildTagElement(tag: string, params: FacebookShopTag) {
+    const value = isString(params.value) ? escape(params.value) : params.value;
     if (params.isGoogle) {
-      return this.getElement(`g:${tag}`, params.value);
+      return this.getElement(`g:${tag}`, 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');
+    return this.getElement(tag, value);
   }
 
   async buildEnd(): Promise<void> {

package/src/interfaces/dealers-mapping.interface.ts

@@ -7,7 +7,7 @@ export interface DealersMapping {
 }
 
 export interface MetaPushPriorityMapping {
-  user_id: string;
+  dealer_id: string;
   meta_push_priority: string;
   comment?: string;
 }

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

@@ -1,7 +1,6 @@
 import { DataSchemes } from '@bytebrand/car-schema';
 
 import { IAtributeWrapItem } from './atributes-wrap-item.intreface';
-import { Description } from './description.interface';
 
 export interface FbXmlItem {
   url: string;
@@ -348,15 +347,32 @@ export interface dealerItem {
 
 export interface FacebookShopItem {
   id: FacebookShopTag;
+  vehicle_id: FacebookShopTag;
   title: FacebookShopTag;
-  description: { value: Description[]; isGoogle: boolean };
+  description: FacebookShopTag;
   availability: FacebookShopTag;
   condition: FacebookShopTag;
   price: FacebookShopTag;
   link: FacebookShopTag;
   image_link: FacebookShopTag;
   additional_image_link: FacebookShopTag;
-  brand: FacebookShopTag;
+  make: FacebookShopTag;
+  model: FacebookShopTag;
+  year: FacebookShopTag;
+
+  user_id: FacebookShopTag;
+  custom_label_4: FacebookShopTag;
+  dealer_privacy_policy_url: FacebookShopTag;
+
+  offer_type: FacebookShopTag;
+  offer_disclaimer?: FacebookShopTag;
+  monthly_payment?: FacebookShopTag;
+  down_payment?: FacebookShopTag;
+  term_length?: FacebookShopTag;
+  apr?: FacebookShopTag;
+  final_payment?: FacebookShopTag;
+  total_amount?: FacebookShopTag;
+  net_loan_amount?: FacebookShopTag;
 
   quantity_to_sell_on_facebook: FacebookShopTag;
   google_product_category: FacebookShopTag;

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

@@ -1,93 +1,265 @@
-import { Injectable } from '@nestjs/common';
-
-import { escape, get, join, round, toString, trim } from 'lodash';
-
-import { de, deVehicleDetailsPage, deVehicleProps } from '@bytebrand/i18n-dictionaries';
-import { ImboImageResponseInterface } from '@bytebrand/chunkable';
-import { TranslatorExtended } from '@bytebrand/schema-tools';
-import { DataSchemes } from '@bytebrand/car-schema';
-
-import { FacebookShopItem } from '../interfaces';
-import { ConfigService, ImagesService } 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, private readonly imageService: ImagesService) {
-    const dict = { ...de, ...deVehicleProps, ...deVehicleDetailsPage };
-    this.translator = new TranslatorExtended(dict);
-  }
-
-  async transform({
-    car,
-    images,
-  }: {
-    car: DataSchemes.Car;
-    images: ImboImageResponseInterface[];
-  }): Promise<FacebookShopItem> {
-    const imageLinks = await this.imageService.getImages(car, images, this.configService.config.imageType, false);
-
-    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: imageLinks[0], isGoogle: true },
-      brand: { value: get(car, 'mainData.make', ''), isGoogle: true },
-      additional_image_link: { value: imageLinks[0], 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 make = toString(get(car, 'mainData.make', ''));
-    const model = toString(get(car, 'mainData.model', ''));
-    return trim(escape(join([make, model], ' ')));
-  }
-
-  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();
-  }
-}
+import { Injectable } from '@nestjs/common';
+
+import { get, round, toString } from 'lodash';
+import moment from 'moment';
+
+import { de, deVehicleDetailsPage, deVehicleProps } from '@bytebrand/i18n-dictionaries';
+import { ImboImageResponseInterface } from '@bytebrand/chunkable';
+import { TranslatorExtended } from '@bytebrand/schema-tools';
+import { DataSchemes } from '@bytebrand/car-schema';
+import { getComputedFinancing, normalizeRateObject } from '@bytebrand/fe-financing';
+
+import { FacebookShopItem, FacebookShopTag } from '../interfaces';
+import { ConfigService, ImagesService, MappingService } from '../services';
+import {
+  META_PUSH_PRIORITY_ALLOWED_VALUES,
+  META_PUSH_PRIORITY_STANDARD,
+  OFFER_DISCLAIMER,
+  OfferType,
+} from '../constants/fb.constants';
+
+interface OfferFinancials {
+  monthlyPayment: number;
+  downPayment: number;
+  termLength: number;
+  apr: number;
+  finalPayment: number;
+  totalAmount: number;
+  netLoanAmount: number;
+}
+
+interface Offer {
+  offerType: OfferType;
+  title: string;
+  description: string;
+  disclaimer?: string;
+  financials?: OfferFinancials;
+}
+
+const DE_LOCALE = 'de-DE';
+
+@Injectable()
+export class FacebookShopTransformer {
+  private translator: TranslatorExtended;
+
+  constructor(
+    private readonly configService: ConfigService,
+    private readonly imageService: ImagesService,
+    private readonly mappingService: MappingService,
+  ) {
+    const dict = { ...de, ...deVehicleProps, ...deVehicleDetailsPage };
+    this.translator = new TranslatorExtended(dict);
+  }
+
+  async transform({
+    car,
+    images,
+  }: {
+    car: DataSchemes.Car;
+    images: ImboImageResponseInterface[];
+  }): Promise<FacebookShopItem[]> {
+    // ignoreDefImages=true: cars with no real photos must be excluded, not padded with placeholders.
+    const imageLinks = await this.imageService.getImages(car, images, this.configService.config.imageType, true);
+    if (!imageLinks.length) {
+      return [];
+    }
+
+    const vehicleId = toString(get(car, 'metaData.vehicleId', car._id));
+    const make = toString(get(car, 'mainData.make', ''));
+    const model = toString(get(car, 'mainData.model', ''));
+    const price = this.getPriceValue(car);
+    const ownerId = get(car, 'metaData.ownerId', null);
+    const customLabel4 = await this.getMetaPushPriority(ownerId);
+
+    const offers = this.buildOffers(car, { make, model, price });
+    if (!offers.length) {
+      return [];
+    }
+
+    const base = {
+      vehicle_id: this.tag(vehicleId, true),
+      availability: this.tag('in stock', true),
+      condition: this.tag(this.getCondition(car), true),
+      price: this.tag(`${price} EUR`, true),
+      sale_price: this.tag(`${price} EUR`, true),
+      link: this.tag(this.getCarLink(car), true),
+      image_link: this.tag(imageLinks[0], true),
+      additional_image_link: this.tag(imageLinks[0], false),
+      make: this.tag(make, false),
+      model: this.tag(model, false),
+      year: this.tag(this.getYear(car), false),
+      user_id: this.tag(ownerId, false),
+      custom_label_4: this.tag(customLabel4, false),
+      dealer_privacy_policy_url: this.tag('https://www.auto.de/einwilligungserklaerung/', false),
+      quantity_to_sell_on_facebook: this.tag(1, true),
+      google_product_category: this.tag('916', true),
+      status: this.tag('active', true),
+      color: this.tag(this.getColor(car), false),
+      product_type: this.tag('Vehicles & Parts > Vehicles > Motor Vehicles > Cars, Trucks & Vans', true),
+    };
+
+    return offers.map((offer): FacebookShopItem => ({
+      ...base,
+      id: this.tag(`${vehicleId}_${offer.offerType}`, true),
+      title: this.tag(offer.title, true),
+      description: this.tag(offer.description, true),
+      offer_type: this.tag(offer.offerType, false),
+      ...(offer.disclaimer ? { offer_disclaimer: this.tag(offer.disclaimer, false) } : {}),
+      ...(offer.financials ? this.financialTags(offer.financials) : {}),
+    } as FacebookShopItem));
+  }
+
+  private buildOffers(car: DataSchemes.Car, common: { make: string; model: string; price: number }): Offer[] {
+    const offers: Offer[] = [];
+    const { make, model, price } = common;
+
+    // Read the raw, already-persisted rate/leasing values before normalizeRateObject
+    // mutates car.rate — these three fields must come straight from the Car object,
+    // matching exactly what the CDP displays (per ticket: data.rate.*/data.leasing.*).
+    const offersFinancing = get(car, 'rate.offersFinancing') !== false;
+    const rawFinancing = {
+      monthlyPayment: get(car, 'rate.monthlyInstallment', 0),
+      downPayment: get(car, 'rate.firstInstallment', 0),
+      termLength: get(car, 'rate.paybackPeriod', 0),
+    };
+    const rawLeasing = {
+      monthlyPayment: get(car, 'leasing.monthlyInstallment', 0),
+      downPayment: get(car, 'leasing.firstInstallment', 0),
+      termLength: get(car, 'leasing.paybackPeriod', 0),
+    };
+    const leasingIsEligible = this.isLeasingEligible(car);
+
+    const { financing: computedFinancing, leasing: computedLeasing } = this.computeFinancials(car);
+
+    if (offersFinancing && rawFinancing.monthlyPayment && computedFinancing) {
+      offers.push({
+        offerType: OfferType.financing,
+        title: `${make} ${model} finanzieren – z. B. ab ${this.formatEUR(rawFinancing.monthlyPayment)} €/Monat`,
+        description: `${make} ${model} finanzieren – ${rawFinancing.termLength} Monate Laufzeit, ` +
+          `${this.formatEUR(rawFinancing.downPayment)} € Anzahlung`,
+        disclaimer: OFFER_DISCLAIMER,
+        financials: {
+          ...rawFinancing,
+          apr: get(computedFinancing, 'annualPercentageRate', 0),
+          finalPayment: get(computedFinancing, 'finalInstallment', 0),
+          totalAmount: get(computedFinancing, 'grossLoanAmount', 0),
+          netLoanAmount: get(computedFinancing, 'netLoanAmount', 0),
+        },
+      });
+    }
+
+    if (leasingIsEligible && rawLeasing.monthlyPayment && computedLeasing) {
+      offers.push({
+        offerType: OfferType.leasing,
+        title: `${make} ${model} leasen – z. B. ab ${this.formatEUR(rawLeasing.monthlyPayment)} €/Monat`,
+        description: `${make} ${model} leasen – ${rawLeasing.termLength} Monate Laufzeit, ` +
+          `${this.formatEUR(rawLeasing.downPayment)} € Anzahlung`,
+        disclaimer: OFFER_DISCLAIMER,
+        financials: {
+          ...rawLeasing,
+          apr: get(computedLeasing, 'annualPercentageRate', 0),
+          finalPayment: get(computedLeasing, 'finalInstallment', 0),
+          totalAmount: get(computedLeasing, 'grossLoanAmount', 0),
+          netLoanAmount: get(computedLeasing, 'netLoanAmount', 0),
+        },
+      });
+    }
+
+    offers.push({
+      offerType: OfferType.buy,
+      title: `${make} ${model} kaufen – jetzt für ${this.formatEUR(price)} €`,
+      description: `${make} ${model} kaufen – jetzt für ${this.formatEUR(price)} €`,
+    });
+
+    return offers;
+  }
+
+  // Runs the same normalizeRateObject + getComputedFinancing pipeline the CDP uses, so
+  // apr/final_payment/total_amount/net_loan_amount (not stored anywhere on the Car object)
+  // match exactly what the customer sees when they click through from the ad.
+  private computeFinancials(car: DataSchemes.Car): { financing?: Record<string, any>; leasing?: Record<string, any> } {
+    try {
+      const normalized = normalizeRateObject(car);
+      if (!get(normalized, 'rate.financing')) {
+        return {};
+      }
+      const computed = getComputedFinancing(normalized.rate as any);
+      return { financing: computed.financing, leasing: computed.leasing };
+    } catch (error) {
+      console.error(error);
+      return {};
+    }
+  }
+
+  // Mirrors getLeasing.ts's isLeasingActive: same car ages out of leasing eligibility once
+  // it's older than leasing.maxAge months or past leasing.maxMileage km.
+  private isLeasingEligible(car: DataSchemes.Car): boolean {
+    const firstRegistration = get(car, 'mainData.firstRegistration', 0) as number;
+    const mileage = get(car, 'mainData.mileage', 0) as number;
+    const maxAge = get(car, 'leasing.maxAge', 24) as number;
+    const maxMileage = get(car, 'leasing.maxMileage', 1000000) as number;
+
+    const registrationMs = firstRegistration ? firstRegistration * 1000 : Date.now();
+    const maxCarAge = new Date().setMonth(new Date().getMonth() - maxAge);
+
+    return registrationMs > maxCarAge && maxMileage > mileage;
+  }
+
+  private financialTags(financials: OfferFinancials): Partial<FacebookShopItem> {
+    return {
+      monthly_payment: this.tag(financials.monthlyPayment, false),
+      down_payment: this.tag(financials.downPayment, false),
+      term_length: this.tag(financials.termLength, false),
+      apr: this.tag(financials.apr, false),
+      final_payment: this.tag(financials.finalPayment, false),
+      total_amount: this.tag(financials.totalAmount, false),
+      net_loan_amount: this.tag(financials.netLoanAmount, false),
+    };
+  }
+
+  private tag(value: any, isGoogle: boolean): FacebookShopTag {
+    return { value, isGoogle };
+  }
+
+  private formatEUR(value: number): string {
+    return Math.round(value || 0).toLocaleString(DE_LOCALE);
+  }
+
+  private async getMetaPushPriority(ownerId: string): Promise<string> {
+    const priorities = await this.mappingService.getMetaPushPriorityMapping();
+    const entry = priorities.find(priority => priority.dealer_id === ownerId);
+    const value = get(entry, 'meta_push_priority', '');
+    return META_PUSH_PRIORITY_ALLOWED_VALUES.includes(value) ? value : META_PUSH_PRIORITY_STANDARD;
+  }
+
+  private getYear(car: DataSchemes.Car): string {
+    const firstRegistration = get(car, 'mainData.firstRegistration', 0) as number;
+    return firstRegistration ? moment(firstRegistration * 1000).format('YYYY') : moment().format('YYYY');
+  }
+
+  private getCondition(car: DataSchemes.Car): string {
+    const available = {
+      selector_condition_new: 'new',
+      selector_condition_used: 'used',
+      selector_unknown: 'used',
+    };
+    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 getPriceValue(car: DataSchemes.Car): number {
+    return round(get(car, 'price.currentSalesPrice', 0), 2);
+  }
+
+  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);
+  }
+}

package/src/transformers/fb.transformer.ts

@@ -166,7 +166,7 @@ export class FbTransformer {
 
   private async getMetaPushPriority(ownerId: string): Promise<string> {
     const priorities = await this.mappingService.getMetaPushPriorityMapping();
-    const entry = priorities.find(priority => priority.user_id === ownerId);
+    const entry = priorities.find(priority => priority.dealer_id === ownerId);
     const value = get(entry, 'meta_push_priority', '');
     return includes(META_PUSH_PRIORITY_ALLOWED_VALUES, value) ? value : META_PUSH_PRIORITY_STANDARD;
   }