@bytebrand/export-cars 1.26.1 → 1.26.3

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

@@ -1,259 +1,259 @@
-import { Injectable } from '@nestjs/common';
-
-import { get, round, toString } from 'lodash';
-import * as 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 } 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 {
-  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 = {
-      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,
-      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) : {}),
-    }));
-  }
-
-  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: this.getNum(car, 'rate.monthlyInstallment'),
-      downPayment: this.getNum(car, 'rate.firstInstallment'),
-      termLength: this.getNum(car, 'rate.paybackPeriod'),
-    };
-    const leasingIsEligible = this.isLeasingEligible(car);
-
-    const { financing: computedFinancing, leasing: computedLeasing } = this.computeFinancials(car);
-
-    // Unlike financing, the CDP never reads a pre-stored leasing.monthlyInstallment — it
-    // always computes it live from RWG + price (see fe-main SearchResultsStore/NewMainPage,
-    // same isLeasingEligible formula). The raw car.leasing.monthlyInstallment field can be
-    // stale/unset even when the CDP shows an active leasing tab, so the computed value is the
-    // one that actually matches what the customer sees.
-    const computedLeasingValues = {
-      monthlyPayment: this.getNum(computedLeasing, 'monthlyInstallment'),
-      downPayment: this.getNum(computedLeasing, 'firstInstallment'),
-      termLength: this.getNum(computedLeasing, 'paybackPeriod'),
-    };
-
-    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: this.getNum(computedFinancing, 'annualPercentageRate'),
-          finalPayment: this.getNum(computedFinancing, 'finalInstallment'),
-          totalAmount: this.getNum(computedFinancing, 'grossLoanAmount'),
-          netLoanAmount: this.getNum(computedFinancing, 'netLoanAmount'),
-        },
-      });
-    }
-
-    if (leasingIsEligible && computedLeasingValues.monthlyPayment && computedLeasing) {
-      offers.push({
-        offerType: OfferType.leasing,
-        title: `${make} ${model} leasen – z. B. ab ${this.formatEUR(computedLeasingValues.monthlyPayment)} €/Monat`,
-        description: `${make} ${model} leasen – ${computedLeasingValues.termLength} Monate Laufzeit, ` +
-          `${this.formatEUR(computedLeasingValues.downPayment)} € Anzahlung`,
-        disclaimer: OFFER_DISCLAIMER,
-        financials: {
-          ...computedLeasingValues,
-          apr: this.getNum(computedLeasing, 'annualPercentageRate'),
-          finalPayment: this.getNum(computedLeasing, 'finalInstallment'),
-          totalAmount: this.getNum(computedLeasing, 'grossLoanAmount'),
-          netLoanAmount: this.getNum(computedLeasing, 'netLoanAmount'),
-        },
-      });
-    }
-
-    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 = this.getNum(car, 'mainData.firstRegistration');
-    const mileage = this.getNum(car, 'mainData.mileage');
-    const maxAge = this.getNum(car, 'leasing.maxAge', 24);
-    const maxMileage = this.getNum(car, 'leasing.maxMileage', 1000000);
-
-    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 {
-      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`,
-    };
-  }
-
-  // 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.
-  private getNum(source: any, path: string, fallback = 0): number {
-    return get(source, path) ?? fallback;
-  }
-
-  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 = this.getNum(car, 'mainData.firstRegistration');
-    return firstRegistration ? moment(firstRegistration * 1000).format('YYYY') : moment().format('YYYY');
-  }
-
-  private getAvailability(car: DataSchemes.Car): string {
-    return get(car, 'state.isOnline', false) ? 'AVAILABLE' : 'NOT_AVAILABLE';
-  }
-
-  private getCarLink(car: DataSchemes.Car): string {
-    return `https://${this.configService.config.domain}/search/vehicle/${car._id}`;
-  }
-
-  private getPriceValue(car: DataSchemes.Car): number {
-    return round(this.getNum(car, 'price.currentSalesPrice'), 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);
-  }
-}
+import { Injectable } from '@nestjs/common';
+
+import { get, round, toString } from 'lodash';
+import * as 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 } 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 {
+  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 = {
+      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,
+      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) : {}),
+    }));
+  }
+
+  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: this.getNum(car, 'rate.monthlyInstallment'),
+      downPayment: this.getNum(car, 'rate.firstInstallment'),
+      termLength: this.getNum(car, 'rate.paybackPeriod'),
+    };
+    const leasingIsEligible = this.isLeasingEligible(car);
+
+    const { financing: computedFinancing, leasing: computedLeasing } = this.computeFinancials(car);
+
+    // Unlike financing, the CDP never reads a pre-stored leasing.monthlyInstallment — it
+    // always computes it live from RWG + price (see fe-main SearchResultsStore/NewMainPage,
+    // same isLeasingEligible formula). The raw car.leasing.monthlyInstallment field can be
+    // stale/unset even when the CDP shows an active leasing tab, so the computed value is the
+    // one that actually matches what the customer sees.
+    const computedLeasingValues = {
+      monthlyPayment: this.getNum(computedLeasing, 'monthlyInstallment'),
+      downPayment: this.getNum(computedLeasing, 'firstInstallment'),
+      termLength: this.getNum(computedLeasing, 'paybackPeriod'),
+    };
+
+    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: this.getNum(computedFinancing, 'annualPercentageRate'),
+          finalPayment: this.getNum(computedFinancing, 'finalInstallment'),
+          totalAmount: this.getNum(computedFinancing, 'grossLoanAmount'),
+          netLoanAmount: this.getNum(computedFinancing, 'netLoanAmount'),
+        },
+      });
+    }
+
+    if (leasingIsEligible && computedLeasingValues.monthlyPayment && computedLeasing) {
+      offers.push({
+        offerType: OfferType.leasing,
+        title: `${make} ${model} leasen – z. B. ab ${this.formatEUR(computedLeasingValues.monthlyPayment)} €/Monat`,
+        description: `${make} ${model} leasen – ${computedLeasingValues.termLength} Monate Laufzeit, ` +
+          `${this.formatEUR(computedLeasingValues.downPayment)} € Anzahlung`,
+        disclaimer: OFFER_DISCLAIMER,
+        financials: {
+          ...computedLeasingValues,
+          apr: this.getNum(computedLeasing, 'annualPercentageRate'),
+          finalPayment: this.getNum(computedLeasing, 'finalInstallment'),
+          totalAmount: this.getNum(computedLeasing, 'grossLoanAmount'),
+          netLoanAmount: this.getNum(computedLeasing, 'netLoanAmount'),
+        },
+      });
+    }
+
+    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 = this.getNum(car, 'mainData.firstRegistration');
+    const mileage = this.getNum(car, 'mainData.mileage');
+    const maxAge = this.getNum(car, 'leasing.maxAge', 24);
+    const maxMileage = this.getNum(car, 'leasing.maxMileage', 1000000);
+
+    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 {
+      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`,
+    };
+  }
+
+  // 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.
+  private getNum(source: any, path: string, fallback = 0): number {
+    return get(source, path) ?? fallback;
+  }
+
+  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 = this.getNum(car, 'mainData.firstRegistration');
+    return firstRegistration ? moment(firstRegistration * 1000).format('YYYY') : moment().format('YYYY');
+  }
+
+  private getAvailability(car: DataSchemes.Car): string {
+    return get(car, 'state.isOnline', false) ? 'AVAILABLE' : 'NOT_AVAILABLE';
+  }
+
+  private getCarLink(car: DataSchemes.Car): string {
+    return `https://${this.configService.config.domain}/search/vehicle/${car._id}`;
+  }
+
+  private getPriceValue(car: DataSchemes.Car): number {
+    return round(this.getNum(car, 'price.currentSalesPrice'), 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

@@ -32,7 +32,7 @@ import { ConfigService, ImagesService, MappingService } from '../services';
 import { FbEquipment } from './fb-equipment.transformer';
 import { isValidVin } from '../utils';
 import { UserService } from 'src/services';
-import { ImageType } from '../enums';
+import { Environment, ImageType } from '../enums';
 import {
   DEFAULT_ADDR1,
   DEFAULT_CITY,
@@ -84,6 +84,17 @@ export class FbTransformer {
     const autodeId = toString(get(car, '_id', ''));
     const year = this.getYear(car);
     const ownerId = get(car, 'metaData.ownerId', null);
+
+    // ADV-161-follow-up: on prod, only publish dealers listed in the meta push priority sheet
+    // (metaPushPriorityCsvUrl). Dev dealer ids don't match that prod sheet, so this stays a
+    // no-op there — every car passes through, same as before this filter existed.
+    if (this.configService.config.environment === Environment.PRODUCTION) {
+      const priorities = await this.mappingService.getMetaPushPriorityMapping();
+      if (!priorities.some(priority => priority.dealer_id === ownerId)) {
+        return null;
+      }
+    }
+
     const dealerInfo = this.getDealerItems(car);
     // console.time(`Address ${car._id}`);
     const address = await this.getAddress(car, owner);