@bytebrand/export-cars 1.24.1 → 1.26.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bytebrand/export-cars",
-  "version": "1.24.1",
+  "version": "1.26.0",
   "description": "",
   "author": "bytebrand",
   "license": "UNLICENSED",

package/src/constants/fb.constants.ts

@@ -8,12 +8,17 @@ export const TIMESTAMP_FIRST_YEAR = 1970;
 export const META_PUSH_PRIORITY_STANDARD = 'standard';
 export const META_PUSH_PRIORITY_ALLOWED_VALUES = ['dealer_priority_1', 'dealer_priority_2'];
 
+// Values must match Meta's Automotive Model Ads offer_type enum exactly (lease/finance/cash) —
+// the old 'financing'/'leasing'/'buy' values are not recognized by the AMA Vehicle Offers Feed.
 export enum OfferType {
-  financing = 'financing',
-  leasing = 'leasing',
-  buy = 'buy',
+  financing = 'finance',
+  leasing = 'lease',
+  buy = 'cash',
 }
 
+export const AMOUNT_QUALIFIER_APR = 'APR';
+export const TERM_QUALIFIER_MONTHS = 'months';
+
 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, ' +

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

@@ -1,5 +1,6 @@
 import { Injectable } from '@nestjs/common';
 import { ModuleRef } from '@nestjs/core';
+import { basename } from 'path';
 
 import { CronicleUtils } from '@bytebrand/cronicle-helper';
 import { FsChunkInterface } from '@bytebrand/chunkable';
@@ -24,8 +25,9 @@ export class FacebookShopExporter implements Exporter {
     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 selfUrl = `https://ftp.${this.configService.config.domain}/feeds/${basename(fileXml)}`;
+    const facebookShopXmlBuilder = new FacebookShopXmlBuilder(fileXml);
+    await facebookShopXmlBuilder.buildStart(selfUrl);
 
     const facebookShopTransformer = await this.moduleRef.create(FacebookShopTransformer);
 
@@ -45,13 +47,13 @@ export class FacebookShopExporter implements Exporter {
         }
 
         for (const item of items) {
-          await facebookShopXmkBuilder.addItem(item);
+          await facebookShopXmlBuilder.addItem(item);
         }
         this.carService.counter.countCar(data.images);
       }
     });
 
-    await facebookShopXmkBuilder.buildEnd();
+    await facebookShopXmlBuilder.buildEnd();
 
     console.log(this.carService.counter.getCountedCars());
   }

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

@@ -1,46 +1,59 @@
-import { escape, isNumber, isString } from 'lodash';
-import { XMLBuilderBase } from '@bytebrand/cronicle-helper';
-import { FacebookShopItem, FacebookShopTag } from '../interfaces';
-
-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) {
-      item += this.buildTagElement(tag, car[tag]);
-    }
-    item += '</item>';
-
-    await this.write(item);
-  }
-
-  buildTagElement(tag: string, params: FacebookShopTag) {
-    // getElement() treats falsy values as "missing" — stringify numbers first so a
-    // legitimate 0 (e.g. down_payment/apr) still renders instead of an empty tag.
-    let value = params.value;
-    if (isString(value)) {
-      value = escape(value);
-    } else if (isNumber(value)) {
-      value = String(value);
-    }
-    if (params.isGoogle) {
-      return this.getElement(`g:${tag}`, value);
-    }
-    return this.getElement(tag, value);
-  }
-
-  async buildEnd(): Promise<void> {
-    await this.write('\n</channel>\n</rss>\n');
-    await this.end();
-  }
-}
+import { escape, isNil, isNumber, isString } from 'lodash';
+import { XMLBuilderBase } from '@bytebrand/cronicle-helper';
+import { FacebookShopItem } from '../interfaces';
+
+const MAX_IMAGES = 2;
+
+export class FacebookShopXmlBuilder extends XMLBuilderBase {
+  // No xmlns:g / g: prefixes here — that namespace belongs to the old Google Merchant /
+  // Facebook Shop product-catalog schema. Meta's Automotive Model Ads Vehicle Offers Feed
+  // uses plain, undecorated tag names (see facebook-shop.builder field reference above).
+  async buildStart(selfUrl?: string): Promise<void> {
+    await this.write(
+      '<?xml version="1.0" encoding="utf-8"?>\n<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">' +
+        '\n<channel>\n<title>auto.de Vehicle Offers Feed</title>' +
+        '\n<description>Automotive Model Ads Vehicle Offers Feed für auto.de</description>' +
+        '\n<link>https://www.auto.de/</link>' +
+        `\n<atom:link href="${escape(selfUrl)}" rel="self" type="application/rss+xml" />\n`,
+    );
+  }
+
+  async addItem(car: FacebookShopItem): Promise<void> {
+    let item = '\n<item>\n';
+
+    const { image, ...tags } = car;
+
+    for (const [tag, value] of Object.entries(tags)) {
+      item += this.buildTagElement(tag, value);
+    }
+
+    item += image
+      .slice(0, MAX_IMAGES)
+      .map((url: string) => `<image><url>${escape(url)}</url></image>\n`)
+      .join('');
+
+    item += '</item>';
+
+    await this.write(item);
+  }
+
+  private buildTagElement(tag: string, value: unknown): string {
+    if (isNil(value) || value === '') {
+      return '';
+    }
+    // getElement() treats falsy values as "missing" — stringify numbers first so a
+    // legitimate 0 (e.g. downpayment/term_length) still renders instead of an empty tag.
+    if (isString(value)) {
+      return this.getElement(tag, escape(value));
+    }
+    if (isNumber(value)) {
+      return this.getElement(tag, String(value));
+    }
+    return this.getElement(tag, value);
+  }
+
+  async buildEnd(): Promise<void> {
+    await this.write('\n</channel>\n</rss>\n');
+    await this.end();
+  }
+}

package/src/formats/fb-xml.builder.ts

@@ -16,8 +16,8 @@ export class FbXmlBuilder extends XMLBuilderBase {
         if (key === 'description') {
           return this.getDescriptionElement(key, data);
         }
-        if (key === 'additional_image_link' && Array.isArray(data)) {
-          return data.map((value: string) => this.getElement(key, value, true)).join('');
+        if (key === 'image' && Array.isArray(data)) {
+          return this.getElementsArray(key, data.map((url: string) => ({ url })));
         }
         if (key === 'vehicle_specifications' && Array.isArray(data)) {
           // getElement() treats falsy values as "missing" — stringify so a legitimate 0

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

@@ -207,6 +207,7 @@ export interface GoogleXmlItem {
   identifier_exists: string,
   ads_redirect?: string;
   "certified_pre-owned"?: boolean;
+  user_id?: string;
   custom_label_0?: string;
   custom_label_1?: string,
   custom_label_2?: string,
@@ -345,46 +346,33 @@ export interface dealerItem {
   };
 }
 
+// Field set matches Meta's Automotive Model Ads "Vehicle Offers Feed File" reference
+// (https://developers.facebook.com/documentation/ads-commerce/marketing-api/auto-ads/reference#vehicle-offers-feed-file).
+// custom_label_4 is not part of that reference but is kept per ADV-159/161 (dealer push
+// priority) — Meta ignores catalog fields it doesn't recognize rather than rejecting the feed.
 export interface FacebookShopItem {
-  id: FacebookShopTag;
-  vehicle_id: FacebookShopTag;
-  title: FacebookShopTag;
-  description: FacebookShopTag;
-  availability: FacebookShopTag;
-  condition: FacebookShopTag;
-  price: FacebookShopTag;
-  link: FacebookShopTag;
-  image_link: FacebookShopTag;
-  additional_image_link: 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;
+  vehicle_offer_id: string;
+  make: string;
+  model: string;
+  year: string;
+  offer_type: string;
+  title: string;
+  offer_description: string;
+  url: string;
+  offer_disclaimer?: string;
+  image: string[];
 
-  quantity_to_sell_on_facebook: FacebookShopTag;
-  google_product_category: FacebookShopTag;
-  sale_price: FacebookShopTag;
-  status: FacebookShopTag;
-  color: FacebookShopTag;
-  product_type: FacebookShopTag;
-}
+  price: string;
+  availability: string;
+  exterior_color: string;
+  custom_label_4: string;
 
-export interface FacebookShopTag {
-  isGoogle: boolean;
-  value: any;
+  amount_price?: string;
+  amount_percentage?: string;
+  amount_qualifier?: string;
+  term_length?: number;
+  term_qualifier?: string;
+  downpayment?: string;
 }
 
 export interface TrovitXmlItem {

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

@@ -9,13 +9,15 @@ 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 { FacebookShopItem } from '../interfaces';
 import { ConfigService, ImagesService, MappingService } from '../services';
 import {
+  AMOUNT_QUALIFIER_APR,
   META_PUSH_PRIORITY_ALLOWED_VALUES,
   META_PUSH_PRIORITY_STANDARD,
   OFFER_DISCLAIMER,
   OfferType,
+  TERM_QUALIFIER_MONTHS,
 } from '../constants/fb.constants';
 
 interface OfferFinancials {
@@ -77,36 +79,26 @@ export class FacebookShopTransformer {
     }
 
     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),
+      make,
+      model,
+      year: this.getYear(car),
+      url: this.getCarLink(car),
+      image: imageLinks.slice(0, 2), // main + 2nd image, per ticket
+      price: `${price} EUR`,
+      availability: this.getAvailability(car),
+      exterior_color: this.getColor(car),
+      custom_label_4: customLabel4,
     };
 
     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) } : {}),
+      vehicle_offer_id: `${vehicleId}_${offer.offerType}`,
+      title: offer.title,
+      offer_description: offer.description,
+      offer_type: offer.offerType,
+      ...(offer.disclaimer ? { offer_disclaimer: offer.disclaimer } : {}),
       ...(offer.financials ? this.financialTags(offer.financials) : {}),
-    } as FacebookShopItem));
+    }));
   }
 
   private buildOffers(car: DataSchemes.Car, common: { make: string; model: string; price: number }): Offer[] {
@@ -213,20 +205,15 @@ export class FacebookShopTransformer {
 
   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),
+      amount_price: `${financials.monthlyPayment} EUR`,
+      amount_percentage: String(financials.apr),
+      amount_qualifier: AMOUNT_QUALIFIER_APR,
+      term_length: financials.termLength,
+      term_qualifier: TERM_QUALIFIER_MONTHS,
+      downpayment: `${financials.downPayment} EUR`,
     };
   }
 
-  private tag(value: any, isGoogle: boolean): FacebookShopTag {
-    return { value, isGoogle };
-  }
-
   // lodash's get() only falls back to the default for an *undefined* path — an explicit
   // `null` stored on the Car document (a common Mongo pattern for "not set") passes
   // straight through and ends up rendering as an empty XML tag. Coalesce it here instead.
@@ -250,14 +237,8 @@ export class FacebookShopTransformer {
     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 getAvailability(car: DataSchemes.Car): string {
+    return get(car, 'state.isOnline', false) ? 'AVAILABLE' : 'NOT_AVAILABLE';
   }
 
   private getCarLink(car: DataSchemes.Car): string {

package/src/transformers/fb.transformer.ts

@@ -106,8 +106,7 @@ export class FbTransformer {
       make: toString(get(car, 'mainData.make', '')),
       model: toString(get(car, 'mainData.model', '')),
       trim: this.getTrim(car),
-      image_link: image_links[0],
-      additional_image_link: image_links.slice(1, 21), // Meta allows max 20 additional images
+      image: image_links.slice(0, 20), // Meta caps the whole image array at 20 items
       year: toString(year),
       mileage: {
         value: this.getMileage(car),
@@ -121,7 +120,7 @@ export class FbTransformer {
       price: this.getPrice(car),
       exterior_color: this.getExteriorColor(car),
       interior_color: this.getInteriorColor(car),
-      condition: this.mapCondition(car),
+      state_of_vehicle: this.mapCondition(car),
       energy_efficiency_class_eu: this.getEnergyEfficiencyClass(car),
       vehicle_specifications: this.getVehicleSpecifications(car),
     };
@@ -395,16 +394,16 @@ export class FbTransformer {
 
   private mapCondition(car: DataSchemes.Car): string {
     const available = {
-      selector_condition_new: 'new',
-      selector_condition_used: 'used',
-      selector_unknown: 'used',
+      selector_condition_new: 'New',
+      selector_condition_used: 'Used',
+      selector_unknown: 'Used',
     };
     const condition = get(car, 'mainData.condition', 'selector_unknown');
     return get(available, condition);
   }
 
   private mapAvailability(car: DataSchemes.Car): string {
-    return get(car, 'state.isOnline', false) ? 'in stock' : 'out of stock';
+    return get(car, 'state.isOnline', false) ? 'available' : 'not_available';
   }
 
   private getEnergyEfficiencyClass(car: DataSchemes.Car): string {

package/src/transformers/google.transformer.ts

@@ -1,13 +1,17 @@
-import { escape, get, isNumber, join, round, toSafeInteger, toString, trim, truncate } from 'lodash';
+import { escape, get, includes, isNumber, join, round, toSafeInteger, toString, trim, truncate } from 'lodash';
 import { CarDescriptionFactory, DescriptionTypeEnum } from '@bytebrand/car-description';
 import { DataSchemes } from '@bytebrand/car-schema';
 import { TranslatorExtended } from '@bytebrand/schema-tools';
 import { de, deVehicleDetailsPage, deVehicleProps } from '@bytebrand/i18n-dictionaries';
 import { ImboImageResponseInterface } from '@bytebrand/chunkable';
 import { Injectable } from '@nestjs/common';
-import { ConfigService, ImagesService, TransformerService, UserService } from '../services';
+import { ConfigService, ImagesService, MappingService, TransformerService, UserService } from '../services';
 import { GoogleXmlItem } from '../interfaces';
 import { isValidVin } from '../utils';
+import {
+  META_PUSH_PRIORITY_ALLOWED_VALUES,
+  META_PUSH_PRIORITY_STANDARD,
+} from '../constants/fb.constants';
 
 const GOOGLE_MAX_TRIM_LENGTH = 50;
 const TIMESTAMP_FIRST_YEAR = 1970;
@@ -21,6 +25,7 @@ export class GoogleTransformer {
     private configService: ConfigService,
     private imageService: ImagesService,
     private readonly transformService: TransformerService,
+    private readonly mappingService: MappingService,
   ) {
     const dict = { ...de, ...deVehicleProps, ...deVehicleDetailsPage };
     this.translator = new TranslatorExtended(dict);
@@ -50,6 +55,8 @@ export class GoogleTransformer {
       ...transformedImages.feat
     ]
 
+    const ownerId = get(car, 'metaData.ownerId', null);
+
     const item: GoogleXmlItem = {
       google_product_category: '916',
       vehicle_fulfillment: {
@@ -92,11 +99,12 @@ export class GoogleTransformer {
       description: this.processText((await this.getDescription(car))),
       identifier_exists: 'yes',
       availability: 'in_stock',
+      user_id: ownerId,
+      custom_label_4: await this.getMetaPushPriority(ownerId),
       // custom_label_0: '',
       // custom_label_1: '',
       // custom_label_2: '',
       // custom_label_3: '',
-      // custom_label_4: '',
 
       // availability: this.getAvailability(car),
       // sale_price: this.getPrice(car),
@@ -131,6 +139,13 @@ export class GoogleTransformer {
     return item;
   }
 
+  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 includes(META_PUSH_PRIORITY_ALLOWED_VALUES, value) ? value : META_PUSH_PRIORITY_STANDARD;
+  }
+
   private checkCarValidity(car: DataSchemes.Car, images: ImboImageResponseInterface[]) {
     if (images.length === 0)
       return false