@bytebrand/export-cars 1.26.38 → 1.26.39

package/package.json

@@ -1,65 +1,65 @@
-{
-  "name": "@bytebrand/export-cars",
-  "version": "1.26.38",
-  "description": "",
-  "author": "bytebrand",
-  "license": "UNLICENSED",
-  "scripts": {
-    "prebuild": "rimraf dist",
-    "build": "nest build",
-    "prepublishOnly": "npm run build",
-    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
-    "lint": "eslint -c .eslintrc.js --ext .ts src/",
-    "start:dev": "nest start --watch",
-    "test": "ts-node --transpile-only test/google-feed-envkv.test.ts && ts-node --transpile-only test/google-feed-item-row.test.ts && ts-node --transpile-only test/publication-gate.test.ts && ts-node --transpile-only test/images-regression.test.ts && ts-node --transpile-only test/clean-images.test.ts && ts-node --transpile-only test/image-url-validator.test.ts && ts-node --transpile-only test/openai-image-fields.test.ts && ts-node --transpile-only test/openai-ads-mapping.test.ts && ts-node --transpile-only test/openai-ads-feed-run.test.ts && ts-node --transpile-only test/openai-ads-finance.test.ts && ts-node --transpile-only test/openai-ads-price-cap.test.ts && ts-node --transpile-only test/meinstadt-mapping.test.ts && ts-node --transpile-only test/meinstadt-feed-run.test.ts && ts-node --transpile-only test/autouncle-mapping.test.ts && ts-node --transpile-only test/autouncle-feed-run.test.ts && ts-node --transpile-only test/criteo-images.test.ts"
-  },
-  "dependencies": {
-    "@bytebrand/autode-request": "^1.19.2",
-    "@bytebrand/bigquery-logger": "^2.1.2",
-    "@bytebrand/car-basic-data-scope": "^9.11.24",
-    "@bytebrand/car-description": "^1.17.20",
-    "@bytebrand/car-schema": "^3.14.15",
-    "@bytebrand/chunkable": "^5.19.8",
-    "@bytebrand/cronicle-helper": "^1.21.8",
-    "@bytebrand/fe-financing": "^5.14.19",
-    "@bytebrand/i18n-dictionaries": "^1.5.0",
-    "@bytebrand/import-helper": "^0.45.0",
-    "@bytebrand/schema-tools": "^3.18.8",
-    "@bytebrand/zipper": "^2.2.0",
-    "@nestjs/cache-manager": "^2.1.0",
-    "@nestjs/common": "^10.2.7",
-    "@nestjs/core": "^10.2.7",
-    "adm-zip": "0.5.5",
-    "axios": "^1.5.1",
-    "bottleneck": "^2.19.5",
-    "cache-manager": "^5.2.4",
-    "csv-write-stream": "^2.0.0",
-    "google-spreadsheet": "^3.3.0",
-    "lodash": "^4.17.21",
-    "moment": "^2.29.4",
-    "nest-commander": "~3.15.0",
-    "reflect-metadata": "^0.1.13",
-    "vin-generator": "^1.0.1"
-  },
-  "devDependencies": {
-    "@nestjs/cli": "^10.1.18",
-    "@types/google-spreadsheet": "^3.3.0",
-    "@types/inquirer": "^8.2.4",
-    "@types/lodash": "^4.14.186",
-    "@types/node": "^16.18.58",
-    "@typescript-eslint/eslint-plugin": "^6.8.0",
-    "@typescript-eslint/parser": "^6.8.0",
-    "eslint": "^8.0.1",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "gts": "^3.1.1",
-    "prettier": "^2.3.2",
-    "ts-node": "^10.0.0",
-    "tsconfig-paths": "4.1.0",
-    "typescript": "^5.2.2"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "gitHead": "e827f35865032821bf3a081f03a026d3d3f8a540"
-}
+{
+  "name": "@bytebrand/export-cars",
+  "version": "1.26.39",
+  "description": "",
+  "author": "bytebrand",
+  "license": "UNLICENSED",
+  "scripts": {
+    "prebuild": "rimraf dist",
+    "build": "nest build",
+    "prepublishOnly": "npm run build",
+    "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
+    "lint": "eslint -c .eslintrc.js --ext .ts src/",
+    "start:dev": "nest start --watch",
+    "test": "ts-node --transpile-only test/google-feed-envkv.test.ts && ts-node --transpile-only test/google-feed-item-row.test.ts && ts-node --transpile-only test/publication-gate.test.ts && ts-node --transpile-only test/images-regression.test.ts && ts-node --transpile-only test/clean-images.test.ts && ts-node --transpile-only test/image-url-validator.test.ts && ts-node --transpile-only test/openai-image-fields.test.ts && ts-node --transpile-only test/openai-ads-mapping.test.ts && ts-node --transpile-only test/openai-ads-feed-run.test.ts && ts-node --transpile-only test/openai-ads-finance.test.ts && ts-node --transpile-only test/openai-ads-price-cap.test.ts && ts-node --transpile-only test/meinstadt-mapping.test.ts && ts-node --transpile-only test/meinstadt-feed-run.test.ts && ts-node --transpile-only test/autouncle-mapping.test.ts && ts-node --transpile-only test/autouncle-feed-run.test.ts && ts-node --transpile-only test/criteo-images.test.ts && ts-node --transpile-only test/criteo-mapping.test.ts"
+  },
+  "dependencies": {
+    "@bytebrand/autode-request": "^1.19.2",
+    "@bytebrand/bigquery-logger": "^2.1.2",
+    "@bytebrand/car-basic-data-scope": "^9.11.24",
+    "@bytebrand/car-description": "^1.17.20",
+    "@bytebrand/car-schema": "^3.14.15",
+    "@bytebrand/chunkable": "^5.19.8",
+    "@bytebrand/cronicle-helper": "^1.21.8",
+    "@bytebrand/fe-financing": "^5.14.19",
+    "@bytebrand/i18n-dictionaries": "^1.5.0",
+    "@bytebrand/import-helper": "^0.45.0",
+    "@bytebrand/schema-tools": "^3.18.8",
+    "@bytebrand/zipper": "^2.2.0",
+    "@nestjs/cache-manager": "^2.1.0",
+    "@nestjs/common": "^10.2.7",
+    "@nestjs/core": "^10.2.7",
+    "adm-zip": "0.5.5",
+    "axios": "^1.5.1",
+    "bottleneck": "^2.19.5",
+    "cache-manager": "^5.2.4",
+    "csv-write-stream": "^2.0.0",
+    "google-spreadsheet": "^3.3.0",
+    "lodash": "^4.17.21",
+    "moment": "^2.29.4",
+    "nest-commander": "~3.15.0",
+    "reflect-metadata": "^0.1.13",
+    "vin-generator": "^1.0.1"
+  },
+  "devDependencies": {
+    "@nestjs/cli": "^10.1.18",
+    "@types/google-spreadsheet": "^3.3.0",
+    "@types/inquirer": "^8.2.4",
+    "@types/lodash": "^4.14.186",
+    "@types/node": "^16.18.58",
+    "@typescript-eslint/eslint-plugin": "^6.8.0",
+    "@typescript-eslint/parser": "^6.8.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "gts": "^3.1.1",
+    "prettier": "^2.3.2",
+    "ts-node": "^10.0.0",
+    "tsconfig-paths": "4.1.0",
+    "typescript": "^5.2.2"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "gitHead": "e827f35865032821bf3a081f03a026d3d3f8a540"
+}

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

@@ -152,10 +152,10 @@ export interface CriteoXmlItem {
   brand: any;
   price: string;
   sale_price: string;
-  energy_efficiency_class: string;
+  energy_efficiency_class?: string;
   color: string;
-  installment: { paybackPeriod: any; monthlyInstallment: any };
-  custom_label_0: string;
+  installment?: { paybackPeriod: number; monthlyInstallment: number };
+  custom_label_0?: string;
 }
 
 export interface GoogleXmlItem {

package/src/transformers/criteo.transformer.ts

@@ -1,4 +1,4 @@
-import { escape, get, join, round, toString, trim } from 'lodash';
+import { get, join, round, toString, trim } from 'lodash';
 import { CarDescriptionFactory, DescriptionTypeEnum } from '@bytebrand/car-description';
 import { DataSchemes } from '@bytebrand/car-schema';
 import { TranslatorExtended } from '@bytebrand/schema-tools';
@@ -34,6 +34,11 @@ export class CriteoTransformer {
 			return null;
 		}
 
+		const energyClass = this.getEnergyClass(car);
+		const installment = this.getInstallment(car);
+
+		// Unknown energy class and a missing rate leave their elements out of the item,
+		// instead of sending "default" or a "0 EUR" monthly rate.
 		return {
 			id: carId,
 			title: this.getTitle(car),
@@ -47,17 +52,20 @@ export class CriteoTransformer {
 			brand: get(car, 'mainData.make', ''),
 			price: this.getRetailPrice(car),
 			sale_price: this.getPrice(car),
-			energy_efficiency_class: this.getEnergyClass(car),
+			...(energyClass ? { energy_efficiency_class: energyClass } : {}),
 			color: this.getColor(car),
-			installment: this.getInstallment(car),
-			custom_label_0: `${this.getInstallment(car)} EUR mtl.`,
+			...(installment
+				? { installment, custom_label_0: `${installment.monthlyInstallment} EUR mtl.` }
+				: {}),
 		};
 	}
 
+	// No HTML escaping here: GoogleXmlBuilder escapes every value for XML.
+	// Escaping twice turned "cee'd" into "cee'd".
 	private getTitle(car: DataSchemes.Car): string {
 		const model = toString(get(car, 'mainData.model', ''));
 
-		return trim(escape(join([this.getBrand(car), model], ' ')));
+		return trim(join([this.getBrand(car), model], ' '));
 	}
 
 	private async getDescription(car: DataSchemes.Car): Promise<string> {
@@ -143,16 +151,20 @@ export class CriteoTransformer {
 			selector_energyEfficiencyClass_e: 'E',
 			selector_energyEfficiencyClass_f: 'F',
 			selector_energyEfficiencyClass_g: 'G',
-			selector_unknown: 'default',
 		};
 		// ADV-187: canonical CO2-derived WLTP class, not the unvalidated legacy NEFZ class.
-		const energyClass = get(car, 'environmentEmissions.wltpEnergyEfficiencyClass', 'selector_unknown');
+		// Unknown or unmapped class -> undefined, so the element is left out.
+		const energyClass = get(car, 'environmentEmissions.wltpEnergyEfficiencyClass');
 		return get(available, energyClass);
 	}
 
-	private getInstallment(car: DataSchemes.Car) {
-		const monthlyInstallment = round(get(car, 'rate.monthlyInstallment', null));
-		const paybackPeriod = round(get(car, 'rate.paybackPeriod', null));
+	// A rate is sent only when the car has a real one: both values present and above zero.
+	private getInstallment(car: DataSchemes.Car): CriteoXmlItem['installment'] | undefined {
+		const monthlyInstallment = round(Number(get(car, 'rate.monthlyInstallment')));
+		const paybackPeriod = round(Number(get(car, 'rate.paybackPeriod')));
+		if (!(monthlyInstallment > 0) || !(paybackPeriod > 0)) {
+			return undefined;
+		}
 
 		return {
 			paybackPeriod,

package/test/criteo-mapping.test.ts

@@ -0,0 +1,122 @@
+// Run: npm test (ts-node, no test framework needed)
+// ADV-319: Criteo item mapping bugs found in the DEV feed of 27.10.2026.
+// - custom_label_0 was "[object Object] EUR mtl." for every car;
+// - a car without a rate got "<g:months>0</g:months><g:amount>0 EUR</g:amount>";
+// - a title with an apostrophe was escaped twice ("cee&amp;#39;d");
+// - an unknown energy class was sent as the literal "default".
+import * as assert from 'node:assert/strict';
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+import { CriteoTransformer } from '../src/transformers/criteo.transformer';
+import { GoogleXmlBuilder } from '../src/formats/google-xml.builder';
+
+const IMAGE = 'https://images.autode-dev.de/generated_images/0/0/0/00000000-0000-4000-8000-000000000001/criteo-Test.jpg';
+
+const baseCar = (patch: any = {}): any => ({
+  _id: '00000000-0000-4000-8000-000000000001',
+  mainData: { make: 'Volkswagen', model: 'Golf', condition: 'selector_condition_used', category: 'selector_category_limousine' },
+  price: { currentSalesPrice: 19990 },
+  offer: { availabilityMode: 'selector_availabilityMode_always' },
+  environmentEmissions: { wltpEnergyEfficiencyClass: 'selector_energyEfficiencyClass_d' },
+  rate: { monthlyInstallment: 164.6, paybackPeriod: 60 },
+  metaData: { ownerId: 'test-dealer', imagesCount: 5 },
+  ...patch,
+});
+
+const transformer = new CriteoTransformer(
+  {} as any,
+  { config: { isCriteo: true, imageType: 'marketing', domain: 'autode-dev.de' } } as any,
+  { getImages: async () => [IMAGE] } as any,
+);
+
+const renderItem = async (item: any): Promise<string> => {
+  const file = path.join(fs.mkdtempSync(path.join(os.tmpdir(), 'criteo-mapping-')), 'feed.xml');
+  const builder = new GoogleXmlBuilder(file);
+  await builder.buildStart('autode-dev.de');
+  await builder.addItem(item);
+  await builder.buildEnd();
+  return fs.readFileSync(file, 'utf8');
+};
+
+const tests: Array<[string, () => Promise<void>]> = [
+  ['custom_label_0 carries the rounded monthly rate, installment keeps months and amount', async () => {
+    const item = await transformer.transform({ car: baseCar(), images: [] });
+    assert.equal(item?.custom_label_0, '165 EUR mtl.');
+    assert.deepEqual(item?.installment, { paybackPeriod: 60, monthlyInstallment: 165 });
+    const xml = await renderItem(item);
+    assert.match(xml, /<g:months>60<\/g:months>/);
+    assert.match(xml, /<g:amount>165 EUR<\/g:amount>/);
+    assert.ok(!xml.includes('[object Object]'));
+  }],
+  ['car without a rate has no installment and no custom_label_0', async () => {
+    for (const rate of [undefined, null, {}, { monthlyInstallment: 0, paybackPeriod: 0 }, { monthlyInstallment: 199 }, { paybackPeriod: 48 }]) {
+      const item = await transformer.transform({ car: baseCar({ rate }), images: [] });
+      assert.ok(item, `item for rate ${JSON.stringify(rate)}`);
+      assert.ok(!('installment' in item), `installment for rate ${JSON.stringify(rate)}`);
+      assert.ok(!('custom_label_0' in item), `custom_label_0 for rate ${JSON.stringify(rate)}`);
+      const xml = await renderItem(item);
+      assert.ok(!xml.includes('g:installment') && !xml.includes('g:custom_label_0'));
+    }
+  }],
+  ['title with an apostrophe is escaped once, by the XML builder', async () => {
+    const item = await transformer.transform({
+      car: baseCar({ mainData: { make: 'Kia', model: "cee'd", condition: 'selector_condition_used' } }),
+      images: [],
+    });
+    assert.equal(item?.title, "Kia cee'd");
+    const xml = await renderItem(item);
+    assert.match(xml, /<g:title>Kia cee&apos;d<\/g:title>/);
+    assert.ok(!xml.includes('&amp;#39;'));
+  }],
+  ['title keeps the Mercedes / VW brand aliases (ACF-6332, ACF-6534)', async () => {
+    const vw = await transformer.transform({ car: baseCar(), images: [] });
+    assert.equal(vw?.title, 'VW Golf');
+    assert.equal(vw?.brand, 'Volkswagen');
+    const mb = await transformer.transform({
+      car: baseCar({ mainData: { make: 'Mercedes-Benz', model: 'A 180', condition: 'selector_condition_used' } }),
+      images: [],
+    });
+    assert.equal(mb?.title, 'Mercedes A 180');
+  }],
+  ['known energy class is sent, unknown or missing class leaves the element out', async () => {
+    const known = await transformer.transform({ car: baseCar(), images: [] });
+    assert.equal(known?.energy_efficiency_class, 'D');
+    for (const environmentEmissions of [{ wltpEnergyEfficiencyClass: 'selector_unknown' }, {}, undefined]) {
+      const item = await transformer.transform({ car: baseCar({ environmentEmissions }), images: [] });
+      assert.ok(item && !('energy_efficiency_class' in item));
+      const xml = await renderItem(item);
+      assert.ok(!xml.includes('g:energy_efficiency_class') && !xml.includes('>default<'));
+    }
+  }],
+  ['unchanged legacy fields: id, link params, price, condition, availability', async () => {
+    const item = await transformer.transform({ car: baseCar(), images: [] });
+    assert.equal(item?.id, '00000000-0000-4000-8000-000000000001');
+    assert.equal(
+      item?.link,
+      'https://www.autode-dev.de/search/vehicle/00000000-0000-4000-8000-000000000001?source=criteo&medium=cpc&campaign=retargeting',
+    );
+    assert.equal(item?.price, '19990 EUR');
+    assert.equal(item?.sale_price, '19990 EUR');
+    assert.equal(item?.condition, 'Gebraucht');
+    assert.equal(item?.availability, 'Sofort');
+    assert.deepEqual(Object.keys(item as any), [
+      'id', 'title', 'description', 'google_product_category', 'product_type', 'link', 'image_link', 'condition',
+      'availability', 'brand', 'price', 'sale_price', 'energy_efficiency_class', 'color', 'installment', 'custom_label_0',
+    ]);
+  }],
+];
+
+(async () => {
+  let failed = 0;
+  for (const [name, fn] of tests) {
+    try {
+      await fn();
+      console.log(`ok   ${name}`);
+    } catch (e) {
+      failed += 1;
+      console.error(`FAIL ${name}\n     ${e.message}`);
+    }
+  }
+  if (failed) process.exit(1);
+})();