@bytebrand/export-cars 1.26.27 → 1.26.29

package/schema/feed-items.json

@@ -1,122 +1,134 @@
-[
-  {
-    "name": "partitionDay",
-    "type": "DATE",
-    "mode": "NULLABLE",
-    "description": "UTC day of exportedAt; the table is partitioned by it"
-  },
-  {
-    "name": "exportedAt",
-    "type": "TIMESTAMP",
-    "mode": "NULLABLE",
-    "description": "Start of the export run (same for every row of a run)"
-  },
-  {
-    "name": "feed",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "Feed the item was written to ('google')"
-  },
-  {
-    "name": "runId",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "Cronicle job id of the run"
-  },
-  {
-    "name": "itemId",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:id> = CBD _id"
-  },
-  {
-    "name": "vehicleId",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "metaData.vehicleId"
-  },
-  {
-    "name": "make",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:brand> as sent"
-  },
-  {
-    "name": "model",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:model> as sent"
-  },
-  {
-    "name": "condition",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:condition> as sent"
-  },
-  {
-    "name": "fuel",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "consumption.fuel selector"
-  },
-  {
-    "name": "hybridPlugin",
-    "type": "BOOLEAN",
-    "mode": "NULLABLE",
-    "description": "engineData.hybridPlugin, null when unset"
-  },
-  {
-    "name": "engine",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:engine> as sent"
-  },
-  {
-    "name": "electricRange",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:electric_range> as sent, null when omitted"
-  },
-  {
-    "name": "fuelConsumption",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:fuel_consumption> as sent, null when omitted"
-  },
-  {
-    "name": "fuelConsumptionDischarged",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:fuel_consumption_discharged_battery> as sent, null when omitted"
-  },
-  {
-    "name": "energyConsumption",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:energy_consumption> as sent, null when omitted"
-  },
-  {
-    "name": "co2Emissions",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:co2_emissions> as sent, null when omitted"
-  },
-  {
-    "name": "rangeSourceField",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "Car field electric_range came from: battery.wltpRange / battery.wltpTotalRange / battery.batteryRangeElectric"
-  },
-  {
-    "name": "price",
-    "type": "FLOAT",
-    "mode": "NULLABLE",
-    "description": "<g:price> amount as sent (EUR)"
-  },
-  {
-    "name": "availability",
-    "type": "STRING",
-    "mode": "NULLABLE",
-    "description": "<g:availability> as sent"
-  }
-]
+[
+  {
+    "name": "partitionDay",
+    "type": "DATE",
+    "mode": "NULLABLE",
+    "description": "UTC day of exportedAt; the table is partitioned by it"
+  },
+  {
+    "name": "exportedAt",
+    "type": "TIMESTAMP",
+    "mode": "NULLABLE",
+    "description": "Start of the export run (same for every row of a run)"
+  },
+  {
+    "name": "feed",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "Feed the item was written to ('google')"
+  },
+  {
+    "name": "runId",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "Cronicle job id of the run"
+  },
+  {
+    "name": "itemId",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:id> = CBD _id"
+  },
+  {
+    "name": "vehicleId",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "metaData.vehicleId"
+  },
+  {
+    "name": "make",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:brand> as sent"
+  },
+  {
+    "name": "model",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:model> as sent"
+  },
+  {
+    "name": "condition",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:condition> as sent"
+  },
+  {
+    "name": "fuel",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "consumption.fuel selector"
+  },
+  {
+    "name": "hybridPlugin",
+    "type": "BOOLEAN",
+    "mode": "NULLABLE",
+    "description": "engineData.hybridPlugin, null when unset"
+  },
+  {
+    "name": "engine",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:engine> as sent"
+  },
+  {
+    "name": "electricRange",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:electric_range> as sent, null when omitted"
+  },
+  {
+    "name": "fuelConsumption",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:fuel_consumption> as sent, null when omitted"
+  },
+  {
+    "name": "fuelConsumptionDischarged",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:fuel_consumption_discharged_battery> as sent, null when omitted"
+  },
+  {
+    "name": "energyConsumption",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:energy_consumption> as sent, null when omitted"
+  },
+  {
+    "name": "co2Emissions",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:co2_emissions> as sent, null when omitted"
+  },
+  {
+    "name": "rangeSourceField",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "Car field electric_range came from: battery.wltpRange / battery.wltpTotalRange / battery.batteryRangeElectric"
+  },
+  {
+    "name": "price",
+    "type": "FLOAT",
+    "mode": "NULLABLE",
+    "description": "<g:price> amount as sent (EUR)"
+  },
+  {
+    "name": "availability",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "<g:availability> as sent"
+  },
+  {
+    "name": "publicationGate",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "EnVKV C8 gate mode of the run (audit / enforce), null when off"
+  },
+  {
+    "name": "estimatedAttributes",
+    "type": "STRING",
+    "mode": "NULLABLE",
+    "description": "Comma-separated EnVKV attributes whose value CBD estimated; left out of the item in enforce mode"
+  }
+]

package/src/configs/config.ts

@@ -1,97 +1,99 @@
-import { Environment, ExportType, ImageType } from '../enums';
-import { FeedItemsBigQueryTarget, Params } from '../interfaces/params.interface';
-
-export class Config {
-  apikey: string;
-  campaign: string;
-  userActionsUrl: string;
-  marketingImageConfigId: number;
-  upaUrl: string;
-  imboUrl: string;
-  imageUrl: string;
-  baseImageUrl: string;
-  marketingImageUrl: string;
-  metaAiaImageUrl: string;
-  imageType: ImageType;
-  downloadImage: boolean;
-  isNewCar: boolean;
-  isCriteo: boolean;
-  exportType: ExportType;
-  domain: string;
-  input: {
-    stringIN: string;
-    numberIN: string;
-    dateIN: string;
-  };
-  // When set, CarService.filterCar exports a car only if price.currentSalesPrice
-  // is a valid number in (0, maxCurrentSalesPrice] — missing/invalid price means
-  // the car is not exported. Unset = no price cap for this export type.
-  maxCurrentSalesPrice?: number;
-  pathesConfig: {
-    localDirectory: string;
-    localConvertedDirectory: string;
-    baseFileName: string;
-  };
-  outputFiles: string[];
-  cpc: string;
-  mappingSpreadsheetId: string;
-  mappingSpreadsheetTitle: string;
-  dealersSpreadsheetId: string;
-  dealersSpreadsheetTitle: string;
-  metaPushPriorityCsvUrl: string;
-  // Cronicle job id of the run (set by ExportRunner), stored with the feed item rows.
-  runId?: string;
-  // Set only when the job configures the feed items BigQuery table; unset = no BigQuery calls.
-  feedItemsBigQuery?: FeedItemsBigQueryTarget;
-
-  protected environmentConfig = {
-    [Environment.DEVELOP]: {
-      domain: 'autode-dev.de',
-      fbMarketingImageId: 8,
-      criteoMarketingImagesConfigId: 12,
-      localConvertedDirectory: 'resources/csv_dev',
-      remoteDirectory: 'import_dev',
-      imageUrl: 'https://images.autode-dev.de/cache_test',
-      baseImageUrl: 'https://images.autode-dev.de',
-    },
-    [Environment.PRODUCTION]: {
-      domain: 'auto.de',
-      fbMarketingImageId: 1,
-      criteoMarketingImagesConfigId: 3,
-      localConvertedDirectory: 'resources/csv_prod',
-      remoteDirectory: 'import',
-      imageUrl: 'https://images.auto.de/generated_images',
-      baseImageUrl: 'https://images.auto.de',
-    },
-  };
-
-  constructor(params: Params) {
-    this.apikey = params.apikey;
-    this.exportType = params.exportType;
-    this.cpc = params.cpc;
-    this.domain = this.environmentConfig[params.environment].domain;
-    this.baseImageUrl = this.environmentConfig[params.environment].baseImageUrl;
-    this.marketingImageUrl = this.environmentConfig[params.environment].imageUrl;
-    this.mappingSpreadsheetId = '147qz9sTgs1wi13ua8YKa0IgfxAn1X_qH6LkGnAnzeyY';
-    this.dealersSpreadsheetId = '1gWrcA-uRTpna1h66Mbe2Y7NA0tIhlUaQXBcS4a_UzOw';
-    this.dealersSpreadsheetTitle = 'dealers_mapping';
-    this.metaPushPriorityCsvUrl = params.metaPushPriorityCsvUrl;
-    this.userActionsUrl = `https://www.${this.domain}/service/user-actions`;
-    this.imboUrl = `https://www.${this.domain}/service/image-imbo`;
-    this.imageUrl = `https://images.${this.domain}`;
-    // Same FTP_ROOT (/generated_images) image-generator's MetaAiaImagesService saves to —
-    // independent of marketingImageUrl, which points legacy fb/criteo channels at their own path.
-    this.metaAiaImageUrl = `${this.imageUrl}/generated_images`;
-    this.upaUrl = `https://www.${this.domain}/service/user-profile-admin`;
-    this.input = {
-      stringIN: params.String,
-      numberIN: params.Number,
-      dateIN: params.Date,
-    };
-    this.pathesConfig = {
-      localDirectory: 'resources/cars-export',
-      localConvertedDirectory: 'resources/default-export',
-      baseFileName: 'cars',
-    };
-  }
-}
+import { Environment, ExportType, ImageType } from '../enums';
+import { FeedItemsBigQueryTarget, Params, PublicationGateConfig } from '../interfaces/params.interface';
+
+export class Config {
+  apikey: string;
+  campaign: string;
+  userActionsUrl: string;
+  marketingImageConfigId: number;
+  upaUrl: string;
+  imboUrl: string;
+  imageUrl: string;
+  baseImageUrl: string;
+  marketingImageUrl: string;
+  metaAiaImageUrl: string;
+  imageType: ImageType;
+  downloadImage: boolean;
+  isNewCar: boolean;
+  isCriteo: boolean;
+  exportType: ExportType;
+  domain: string;
+  input: {
+    stringIN: string;
+    numberIN: string;
+    dateIN: string;
+  };
+  // When set, CarService.filterCar exports a car only if price.currentSalesPrice
+  // is a valid number in (0, maxCurrentSalesPrice] — missing/invalid price means
+  // the car is not exported. Unset = no price cap for this export type.
+  maxCurrentSalesPrice?: number;
+  pathesConfig: {
+    localDirectory: string;
+    localConvertedDirectory: string;
+    baseFileName: string;
+  };
+  outputFiles: string[];
+  cpc: string;
+  mappingSpreadsheetId: string;
+  mappingSpreadsheetTitle: string;
+  dealersSpreadsheetId: string;
+  dealersSpreadsheetTitle: string;
+  metaPushPriorityCsvUrl: string;
+  // Cronicle job id of the run (set by ExportRunner), stored with the feed item rows.
+  runId?: string;
+  // Set only when the job configures the feed items BigQuery table; unset = no BigQuery calls.
+  feedItemsBigQuery?: FeedItemsBigQueryTarget;
+  // EnVKV C8 publication gate of the Google feed; unset = off.
+  publicationGate?: PublicationGateConfig;
+
+  protected environmentConfig = {
+    [Environment.DEVELOP]: {
+      domain: 'autode-dev.de',
+      fbMarketingImageId: 8,
+      criteoMarketingImagesConfigId: 12,
+      localConvertedDirectory: 'resources/csv_dev',
+      remoteDirectory: 'import_dev',
+      imageUrl: 'https://images.autode-dev.de/cache_test',
+      baseImageUrl: 'https://images.autode-dev.de',
+    },
+    [Environment.PRODUCTION]: {
+      domain: 'auto.de',
+      fbMarketingImageId: 1,
+      criteoMarketingImagesConfigId: 3,
+      localConvertedDirectory: 'resources/csv_prod',
+      remoteDirectory: 'import',
+      imageUrl: 'https://images.auto.de/generated_images',
+      baseImageUrl: 'https://images.auto.de',
+    },
+  };
+
+  constructor(params: Params) {
+    this.apikey = params.apikey;
+    this.exportType = params.exportType;
+    this.cpc = params.cpc;
+    this.domain = this.environmentConfig[params.environment].domain;
+    this.baseImageUrl = this.environmentConfig[params.environment].baseImageUrl;
+    this.marketingImageUrl = this.environmentConfig[params.environment].imageUrl;
+    this.mappingSpreadsheetId = '147qz9sTgs1wi13ua8YKa0IgfxAn1X_qH6LkGnAnzeyY';
+    this.dealersSpreadsheetId = '1gWrcA-uRTpna1h66Mbe2Y7NA0tIhlUaQXBcS4a_UzOw';
+    this.dealersSpreadsheetTitle = 'dealers_mapping';
+    this.metaPushPriorityCsvUrl = params.metaPushPriorityCsvUrl;
+    this.userActionsUrl = `https://www.${this.domain}/service/user-actions`;
+    this.imboUrl = `https://www.${this.domain}/service/image-imbo`;
+    this.imageUrl = `https://images.${this.domain}`;
+    // Same FTP_ROOT (/generated_images) image-generator's MetaAiaImagesService saves to —
+    // independent of marketingImageUrl, which points legacy fb/criteo channels at their own path.
+    this.metaAiaImageUrl = `${this.imageUrl}/generated_images`;
+    this.upaUrl = `https://www.${this.domain}/service/user-profile-admin`;
+    this.input = {
+      stringIN: params.String,
+      numberIN: params.Number,
+      dateIN: params.Date,
+    };
+    this.pathesConfig = {
+      localDirectory: 'resources/cars-export',
+      localConvertedDirectory: 'resources/default-export',
+      baseFileName: 'cars',
+    };
+  }
+}

package/src/configs/google.config.ts

@@ -1,26 +1,41 @@
-import { ExportType, FileType, ImageType } from 'src/enums';
-import { resolveMaxFeedSalesPrice } from '../constants/feed-price.constants';
-import { Params } from '../interfaces/params.interface';
-import { Config } from './config';
-
-const trimmed = (value: unknown): string => (typeof value === 'string' ? value.trim() : '');
-
-export class GoogleConfig extends Config {
-  constructor(params: Params) {
-    super(params);
-    this.pathesConfig.localConvertedDirectory = `resources/${ExportType.GOOGLE}-export`;
-    this.imageType = ImageType.default;
-    this.maxCurrentSalesPrice = resolveMaxFeedSalesPrice(params.maxCurrentSalesPrice);
-    const feedItemsBigQuery = {
-      project: trimmed(params.feedItemsBqProject),
-      dataset: trimmed(params.feedItemsBqDataset),
-      table: trimmed(params.feedItemsBqTable),
-    };
-    if (feedItemsBigQuery.project && feedItemsBigQuery.dataset && feedItemsBigQuery.table) {
-      this.feedItemsBigQuery = feedItemsBigQuery;
-    }
-    this.outputFiles = [
-      `${this.pathesConfig.localConvertedDirectory}/api_export_cars_${ExportType.GOOGLE}.${FileType.XML}`,
-    ];
-  }
-}
+import { ExportType, FileType, ImageType } from 'src/enums';
+import { resolveMaxFeedSalesPrice } from '../constants/feed-price.constants';
+import { Params, PublicationGateConfig } from '../interfaces/params.interface';
+import { Config } from './config';
+
+const trimmed = (value: unknown): string => (typeof value === 'string' ? value.trim() : '');
+
+export class GoogleConfig extends Config {
+  constructor(params: Params) {
+    super(params);
+    this.pathesConfig.localConvertedDirectory = `resources/${ExportType.GOOGLE}-export`;
+    this.imageType = ImageType.default;
+    this.maxCurrentSalesPrice = resolveMaxFeedSalesPrice(params.maxCurrentSalesPrice);
+    const feedItemsBigQuery = {
+      project: trimmed(params.feedItemsBqProject),
+      dataset: trimmed(params.feedItemsBqDataset),
+      table: trimmed(params.feedItemsBqTable),
+    };
+    if (feedItemsBigQuery.project && feedItemsBigQuery.dataset && feedItemsBigQuery.table) {
+      this.feedItemsBigQuery = feedItemsBigQuery;
+    }
+    const gateMode = trimmed(params.publicationGate).toLowerCase();
+    if (gateMode === 'audit' || gateMode === 'enforce') {
+      const gate = {
+        mode: gateMode as PublicationGateConfig['mode'],
+        project: trimmed(params.publicationGateBqProject),
+        dataset: trimmed(params.publicationGateBqDataset),
+        table: trimmed(params.publicationGateBqTable),
+      };
+      if (!gate.project || !gate.dataset || !gate.table) {
+        throw new Error(`publicationGate=${gateMode} needs publicationGateBqProject, publicationGateBqDataset and publicationGateBqTable`);
+      }
+      this.publicationGate = gate;
+    } else if (gateMode && gateMode !== 'off') {
+      throw new Error(`publicationGate must be off, audit or enforce, got "${gateMode}"`);
+    }
+    this.outputFiles = [
+      `${this.pathesConfig.localConvertedDirectory}/api_export_cars_${ExportType.GOOGLE}.${FileType.XML}`,
+    ];
+  }
+}

package/src/configs/index.ts

@@ -20,3 +20,4 @@ export * from './mitula.config';
 export * from './awin.config';
 export * from './evium.config';
 export * from './santander.config';
+export * from './openai-ads.config';

package/src/configs/openai-ads.config.ts

@@ -0,0 +1,70 @@
+import { toNumber } from 'lodash';
+
+import { ExportType, FileType, ImageType } from '../enums';
+import { Params } from '../interfaces/params.interface';
+import { FeedGuardOptions } from '../services/feed-guard';
+import { Config } from './config';
+
+const text = (value: unknown): string => (typeof value === 'string' ? value.trim() : '');
+
+const positiveNumber = (value: unknown, fallback: number): number => {
+  const parsed = toNumber(text(value));
+  return text(value) && Number.isFinite(parsed) && parsed > 0 ? parsed : fallback;
+};
+
+// Defaults sized for prod (~45k online cars, ~27k in the Google feed on 25.08). DEV (a few hundred
+// cars) needs smaller minimums via the Cronicle params.
+export const OPENAI_ADS_DEFAULTS = {
+  sellerName: 'auto.de',
+  retentionDays: 15,
+  imageConcurrency: 16,
+  minSourceItems: 1000,
+  minPublishedItems: 500,
+  maxDropPercent: 20,
+  maxSourceAgeHours: 26,
+  maxStaleHours: 48,
+};
+
+/**
+ * OpenAI ChatGPT Ads vehicle product feed (ADV-335): OpenAI-format CSV, clean ADV-336 images.
+ * Dry-run is the default: the file goes to resources/openai_ads-dryrun and nothing reads it.
+ * Only openAiAdsDryRun=false writes resources/openai_ads-export, the directory a transport step
+ * (hosted URL / SFTP, not part of this exporter) may publish from. Each mode has its own state
+ * (ledger, last good counts), so dry-runs never touch what was sent to OpenAI.
+ */
+export class OpenAiAdsConfig extends Config {
+  dryRun: boolean;
+  sellerName: string;
+  retentionDays: number;
+  imageConcurrency: number;
+  stateDir: string;
+  feedGuard: FeedGuardOptions;
+
+  constructor(params: Params) {
+    super(params);
+    this.dryRun = text(params.openAiAdsDryRun).toLowerCase() !== 'false';
+    const mode = this.dryRun ? 'dryrun' : 'export';
+    this.pathesConfig.localConvertedDirectory = `resources/${ExportType.OPENAI_ADS}-${mode}`;
+    this.stateDir = `resources/${ExportType.OPENAI_ADS}-state/${mode}`;
+    this.imageType = ImageType.clean;
+    this.sellerName = text(params.openAiAdsSellerName) || OPENAI_ADS_DEFAULTS.sellerName;
+    this.retentionDays = positiveNumber(params.openAiAdsRetentionDays, OPENAI_ADS_DEFAULTS.retentionDays);
+    this.imageConcurrency = positiveNumber(params.openAiAdsImageConcurrency, OPENAI_ADS_DEFAULTS.imageConcurrency);
+    // Shared price cap stays opt-in here (open question to Marketing): only an explicit
+    // maxCurrentSalesPrice param applies it, no 80k default as for Google/Meta.
+    const cap = positiveNumber(params.maxCurrentSalesPrice, 0);
+    this.maxCurrentSalesPrice = cap || undefined;
+    this.feedGuard = {
+      stateDir: this.stateDir,
+      minSourceItems: positiveNumber(params.feedGuardMinSourceItems, OPENAI_ADS_DEFAULTS.minSourceItems),
+      minPublishedItems: positiveNumber(params.feedGuardMinPublishedItems, OPENAI_ADS_DEFAULTS.minPublishedItems),
+      maxDropPercent: positiveNumber(params.feedGuardMaxDropPercent, OPENAI_ADS_DEFAULTS.maxDropPercent),
+      maxSourceAgeHours: positiveNumber(params.feedGuardMaxSourceAgeHours, OPENAI_ADS_DEFAULTS.maxSourceAgeHours),
+      maxStaleHours: positiveNumber(params.feedGuardMaxStaleHours, OPENAI_ADS_DEFAULTS.maxStaleHours),
+      acceptDrop: text(params.feedGuardAcceptDrop).toLowerCase() === 'true',
+    };
+    this.outputFiles = [
+      `${this.pathesConfig.localConvertedDirectory}/api_export_cars_${ExportType.OPENAI_ADS}.${FileType.CSV}`,
+    ];
+  }
+}

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

@@ -30,4 +30,6 @@ export enum ExportType {
   AWIN = 'awin',
   SANTANDER = 'santander',
   EVIUM = 'evium',
+  // ChatGPT Ads product feed (ADV-335)
+  OPENAI_ADS = 'openai_ads',
 }

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

@@ -1,4 +1,9 @@
 export enum ImageType {
   default = 'default',
   marketing = 'marketing',
+  /**
+   * ADV-336: real photos only, explicit JPEG, 3/4 exterior hero first, then the remaining
+   * exterior and interior views — no feature close-ups, no marketing overlays, no placeholders.
+   */
+  clean = 'clean',
 }