@adcp/sdk 14.0.0-rc.37 → 14.0.0-rc.39

package/dist/lib/media-buy/mutations.js

@@ -0,0 +1,525 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var mutations_exports = {};
+__export(mutations_exports, {
+  decomposeUpdateMediaBuy: () => decomposeUpdateMediaBuy,
+  getActionForMutation: () => getActionForMutation,
+  hasUnmappedMutation: () => hasUnmappedMutation,
+  mutationShapeIssue: () => mutationShapeIssue
+});
+module.exports = __toCommonJS(mutations_exports);
+var import_errors = require('../errors/index.js');
+var import_update_fields = require('./update-fields.generated.js');
+const BUDGET_EQUAL_TOLERANCE = 5e-3;
+function getActionForMutation(currentBuy, request) {
+  return decomposeUpdateMediaBuy(currentBuy, request).actions;
+}
+function decomposeUpdateMediaBuy(currentBuy, request) {
+  const shapeIssue = mutationShapeIssue(request);
+  if (shapeIssue)
+    throw new import_errors.ValidationError(
+      shapeIssue,
+      void 0,
+      "Invalid mutation field shape. Validate the request against the selected wire schema."
+    );
+  const mutations = [];
+  const currentPackages = /* @__PURE__ */ new Map();
+  for (const pkg of currentBuy.packages ?? []) {
+    if (pkg.package_id) currentPackages.set(pkg.package_id, pkg);
+  }
+  const push = (mutation) => {
+    mutations.push(mutation);
+  };
+  const budgetMutation = (from, to, field, path = field, package_id) => {
+    const action = to === null && typeof from === "number" && Number.isFinite(from) ? "increase_budget" : from === null && typeof to === "number" && Number.isFinite(to) && field.endsWith("daily_budget_cap") ? "decrease_budget" : typeof from !== "number" || !Number.isFinite(from) || typeof to !== "number" || !Number.isFinite(to) ? "update_budget" : to > from ? "increase_budget" : to < from ? "decrease_budget" : "reallocate_budget";
+    push({ action, field, path, from, to, scope: package_id ? "package" : "buy", ...package_id && { package_id } });
+  };
+  if (request.total_budget !== void 0)
+    budgetMutation(
+      typeof currentBuy.total_budget === "object" ? currentBuy.total_budget?.amount : currentBuy.total_budget,
+      request.total_budget.amount,
+      "total_budget.amount"
+    );
+  if (request.daily_budget_cap !== void 0)
+    budgetMutation(currentBuy.daily_budget_cap, request.daily_budget_cap, "daily_budget_cap");
+  if (request.paused !== void 0) {
+    push({
+      action: request.paused === false ? "resume" : "pause",
+      field: "paused",
+      path: "paused",
+      scope: "buy",
+      to: request.paused
+    });
+  }
+  if (request.canceled !== void 0) {
+    push({
+      action: "cancel",
+      field: "canceled",
+      path: "canceled",
+      scope: "buy",
+      to: request.canceled
+    });
+  }
+  if (request.cancellation_reason !== void 0) {
+    push({
+      action: "cancel",
+      field: "cancellation_reason",
+      path: "cancellation_reason",
+      scope: "buy",
+      to: request.cancellation_reason
+    });
+  }
+  if (request.start_time !== void 0) {
+    push({
+      action: "update_flight_dates",
+      direction: "shift",
+      field: "start_time",
+      path: "start_time",
+      scope: "buy",
+      from: currentBuy.start_time,
+      to: request.start_time
+    });
+  }
+  if (request.end_time !== void 0) {
+    const pick = resolveFlightEndDirection(currentBuy, request, "end_time");
+    push({
+      ...pick,
+      field: "end_time",
+      path: "end_time",
+      scope: "buy",
+      from: currentBuy.end_time,
+      to: request.end_time
+    });
+  }
+  if (request.frequency_cap !== void 0) {
+    const frequencyCapActions = import_update_fields.ACTIONS_BY_FIELD["frequency_cap"];
+    const frequencyCapAction = frequencyCapActions?.length === 1 ? frequencyCapActions[0] : void 0;
+    if (frequencyCapAction) {
+      push({
+        action: frequencyCapAction,
+        field: "frequency_cap",
+        path: "frequency_cap",
+        scope: "buy",
+        to: request.frequency_cap
+      });
+    }
+  }
+  if (request.new_packages !== void 0 && request.new_packages.length > 0) {
+    push({
+      action: "add_packages",
+      field: "new_packages",
+      path: "new_packages",
+      scope: "packages",
+      to: request.new_packages
+    });
+  }
+  if (request.packages) {
+    const budgetPick = resolveBudgetDirection(currentBuy, request);
+    const completeBudgetBaselines = new Set(request.packages.map((pkg) => pkg.package_id)).size === request.packages.length && new Set((currentBuy.packages ?? []).map((pkg) => pkg.package_id)).size === (currentBuy.packages ?? []).length && request.packages.every(
+      (pkg) => pkg.budget === void 0 || Number.isFinite(pkg.budget) && Number.isFinite(currentPackages.get(pkg.package_id)?.budget)
+    );
+    const packageEndPick = resolveFlightEndDirection(currentBuy, request, "packages[].end_time");
+    request.packages.forEach((pkg, index) => {
+      const currentPkg = currentPackages.get(pkg.package_id);
+      const base = {
+        scope: "package",
+        package_id: pkg.package_id,
+        package_index: index
+      };
+      if (pkg.canceled !== void 0) {
+        push({
+          action: "remove_packages",
+          field: "packages[].canceled",
+          path: `packages[${index}].canceled`,
+          ...base,
+          to: pkg.canceled
+        });
+      }
+      if (pkg.paused !== void 0)
+        push({
+          action: pkg.paused ? "pause" : "resume",
+          field: "packages[].paused",
+          path: `packages[${index}].paused`,
+          ...base,
+          from: currentPkg?.paused,
+          to: pkg.paused
+        });
+      if (pkg.cancellation_reason !== void 0)
+        push({
+          action: "remove_packages",
+          field: "packages[].cancellation_reason",
+          path: `packages[${index}].cancellation_reason`,
+          ...base,
+          to: pkg.cancellation_reason
+        });
+      if (pkg.budget !== void 0) {
+        push({
+          ...currentBuy.accepted_proposal?.commercial_terms?.change_terms === void 0 ? budgetPick : budgetPick.action === "reallocate_budget" && completeBudgetBaselines && typeof pkg.budget === "number" ? budgetPick : pkg.budget === null && Number.isFinite(currentPkg?.budget) ? { action: "increase_budget", direction: "increase" } : typeof currentPkg?.budget !== "number" || !Number.isFinite(currentPkg.budget) || typeof pkg.budget !== "number" || !Number.isFinite(pkg.budget) ? { action: "update_budget" } : pkg.budget > currentPkg.budget ? { action: "increase_budget", direction: "increase" } : pkg.budget < currentPkg.budget ? { action: "decrease_budget", direction: "decrease" } : budgetPick,
+          field: "packages[].budget",
+          path: `packages[${index}].budget`,
+          ...base,
+          from: currentPkg?.budget,
+          to: pkg.budget
+        });
+      }
+      if (pkg.daily_budget_cap !== void 0)
+        budgetMutation(
+          currentPkg?.daily_budget_cap,
+          pkg.daily_budget_cap,
+          "packages[].daily_budget_cap",
+          `packages[${index}].daily_budget_cap`,
+          pkg.package_id
+        );
+      if (pkg.pacing !== void 0) {
+        push({
+          action: "update_pacing",
+          field: "packages[].pacing",
+          path: `packages[${index}].pacing`,
+          ...base,
+          to: pkg.pacing
+        });
+      }
+      if (pkg.start_time !== void 0) {
+        push({
+          action: "update_flight_dates",
+          direction: "shift",
+          field: "packages[].start_time",
+          path: `packages[${index}].start_time`,
+          ...base,
+          from: currentPkg?.start_time,
+          to: pkg.start_time
+        });
+      }
+      if (pkg.end_time !== void 0) {
+        push({
+          ...currentBuy.accepted_proposal?.commercial_terms?.change_terms !== void 0 && !request.start_time && !request.packages?.some((p) => p.start_time !== void 0) ? !Number.isFinite(Date.parse(currentPkg?.end_time ?? "")) ? { action: "update_dates" } : {
+            action: Date.parse(pkg.end_time) > Date.parse(currentPkg.end_time) ? "extend_flight" : Date.parse(pkg.end_time) < Date.parse(currentPkg.end_time) ? "shorten_flight" : "update_flight_dates"
+          } : packageEndPick,
+          field: "packages[].end_time",
+          path: `packages[${index}].end_time`,
+          ...base,
+          from: currentPkg?.end_time,
+          to: pkg.end_time
+        });
+      }
+      if (pkg.creative_assignments !== void 0) {
+        push({
+          action: Array.isArray(pkg.creative_assignments) && pkg.creative_assignments.length === 0 ? "remove_creative" : "update_creative_assignments",
+          field: "packages[].creative_assignments",
+          path: `packages[${index}].creative_assignments`,
+          ...base,
+          to: pkg.creative_assignments
+        });
+      }
+      if (pkg.creatives !== void 0) {
+        push({
+          action: "replace_creative",
+          field: "packages[].creatives",
+          path: `packages[${index}].creatives`,
+          ...base,
+          to: pkg.creatives
+        });
+      }
+      if (pkg.keyword_targets_add !== void 0) {
+        push({
+          action: "update_targeting",
+          field: "packages[].keyword_targets_add",
+          path: `packages[${index}].keyword_targets_add`,
+          ...base,
+          to: pkg.keyword_targets_add
+        });
+      }
+      if (pkg.keyword_targets_remove !== void 0) {
+        push({
+          action: "update_targeting",
+          field: "packages[].keyword_targets_remove",
+          path: `packages[${index}].keyword_targets_remove`,
+          ...base,
+          to: pkg.keyword_targets_remove
+        });
+      }
+      if (pkg.negative_keywords_add !== void 0) {
+        push({
+          action: "update_targeting",
+          field: "packages[].negative_keywords_add",
+          path: `packages[${index}].negative_keywords_add`,
+          ...base,
+          to: pkg.negative_keywords_add
+        });
+      }
+      if (pkg.negative_keywords_remove !== void 0) {
+        push({
+          action: "update_targeting",
+          field: "packages[].negative_keywords_remove",
+          path: `packages[${index}].negative_keywords_remove`,
+          ...base,
+          to: pkg.negative_keywords_remove
+        });
+      }
+      if (pkg.targeting_overlay !== void 0) {
+        const overlayKeys = Object.keys(pkg.targeting_overlay);
+        if (Object.hasOwn(pkg.targeting_overlay, "frequency_cap")) {
+          push({
+            action: "update_frequency_caps",
+            field: "packages[].targeting_overlay.frequency_cap",
+            path: `packages[${index}].targeting_overlay.frequency_cap`,
+            ...base,
+            to: pkg.targeting_overlay.frequency_cap
+          });
+        }
+        if (overlayKeys.length === 0 || overlayKeys.some((key) => key !== "frequency_cap")) {
+          push({
+            action: "update_targeting",
+            field: "packages[].targeting_overlay",
+            path: `packages[${index}].targeting_overlay`,
+            ...base,
+            to: pkg.targeting_overlay
+          });
+        }
+      }
+    });
+  }
+  const addMetadataFields = (value, prefix, index, package_id) => {
+    for (const [key, to] of Object.entries(value)) {
+      const field = prefix + key;
+      if (field === "packages[].targeting_overlay") continue;
+      if (to === void 0 || mutations.some((m) => m.field === field && m.package_id === package_id)) continue;
+      const actions = Object.hasOwn(import_update_fields.ACTIONS_BY_FIELD, field) ? import_update_fields.ACTIONS_BY_FIELD[field] : void 0;
+      if (actions?.length !== 1) continue;
+      const from = index === void 0 ? currentBuy[key] : currentPackages.get(package_id)?.[key];
+      push({
+        action: actions[0],
+        field,
+        path: index === void 0 ? key : `packages[${index}].${key}`,
+        scope: index === void 0 ? "buy" : "package",
+        from,
+        to,
+        ...package_id && { package_id, package_index: index }
+      });
+    }
+  };
+  addMetadataFields(request, "");
+  request.packages?.forEach((pkg, i) => addMetadataFields(pkg, "packages[].", i, pkg.package_id));
+  if (currentBuy.accepted_proposal?.commercial_terms?.change_terms !== void 0) {
+    const canonicalFields = {
+      reporting_webhook: "update_reporting_webhook",
+      budget_cap_timezone: "update_pacing",
+      "packages[].keyword_targets_add": "update_keywords",
+      "packages[].keyword_targets_remove": "update_keywords",
+      "packages[].negative_keywords_add": "update_keywords",
+      "packages[].negative_keywords_remove": "update_keywords",
+      "packages[].catalog_ids": "update_catalog_assignments",
+      // canonical control shape
+      "packages[].catalogs": "update_catalog_assignments",
+      // legacy update shape
+      "packages[].bid_price": "update_bidding",
+      "packages[].optimization_goals": "update_optimization_goals",
+      "packages[].impressions": "update_impression_goal",
+      "packages[].min_spend_target": "update_spend_target"
+    };
+    for (const mutation of mutations)
+      if (Object.hasOwn(canonicalFields, mutation.field)) mutation.action = canonicalFields[mutation.field];
+    const addCanonical = (values, index) => {
+      for (const [key, to] of Object.entries(values)) {
+        const field = index === void 0 ? key : `packages[].${key}`;
+        const path = index === void 0 ? key : `packages[${index}].${key}`;
+        if (to === void 0 || !Object.hasOwn(canonicalFields, field) || mutations.some((m) => m.path === path))
+          continue;
+        const package_id = index === void 0 ? void 0 : request.packages[index].package_id;
+        push({
+          action: canonicalFields[field],
+          field,
+          path,
+          scope: index === void 0 ? "buy" : "package",
+          to,
+          ...package_id && { package_id, package_index: index },
+          from: index === void 0 ? currentBuy[key] : currentPackages.get(package_id)?.[key]
+        });
+      }
+    };
+    addCanonical(request);
+    request.packages?.forEach((pkg, index) => addCanonical(pkg, index));
+  }
+  return {
+    mutations,
+    actions: aggregateResolvedActions(mutations),
+    touched_fields: uniqueFields(mutations)
+  };
+}
+function aggregateResolvedActions(mutations) {
+  const resolved = /* @__PURE__ */ new Map();
+  for (const mutation of mutations) {
+    const existing = resolved.get(mutation.action);
+    if (existing) {
+      if (existing.direction === void 0 && mutation.direction !== void 0) {
+        existing.direction = mutation.direction;
+      }
+      if (!existing.touched_fields.includes(mutation.field)) {
+        existing.touched_fields.push(mutation.field);
+      }
+      continue;
+    }
+    resolved.set(mutation.action, {
+      action: mutation.action,
+      direction: mutation.direction,
+      touched_fields: [mutation.field]
+    });
+  }
+  return [...resolved.values()];
+}
+function uniqueFields(mutations) {
+  const fields = [];
+  for (const mutation of mutations) {
+    if (!fields.includes(mutation.field)) fields.push(mutation.field);
+  }
+  return fields;
+}
+function resolveBudgetDirection(currentBuy, request) {
+  const currentByPkg = /* @__PURE__ */ new Map();
+  for (const pkg of currentBuy.packages ?? []) {
+    if (pkg.package_id && typeof pkg.budget === "number") {
+      currentByPkg.set(pkg.package_id, pkg.budget);
+    }
+  }
+  let currentTotal = 0;
+  let proposedTotal = 0;
+  let sawIncrease = false;
+  let sawDecrease = false;
+  for (const pkg of request.packages ?? []) {
+    if (typeof pkg.budget !== "number") continue;
+    const prev = currentByPkg.get(pkg.package_id);
+    if (prev === void 0) {
+      sawIncrease = true;
+      proposedTotal += pkg.budget;
+      continue;
+    }
+    currentTotal += prev;
+    proposedTotal += pkg.budget;
+    if (pkg.budget > prev) sawIncrease = true;
+    if (pkg.budget < prev) sawDecrease = true;
+  }
+  const tolerance = currentBuy.accepted_proposal?.commercial_terms?.change_terms !== void 0 ? Number.EPSILON * Math.max(1, Math.abs(proposedTotal), Math.abs(currentTotal)) : BUDGET_EQUAL_TOLERANCE;
+  if (sawIncrease && sawDecrease && Math.abs(proposedTotal - currentTotal) < tolerance) {
+    return { action: "reallocate_budget", direction: "reallocate" };
+  }
+  if (proposedTotal > currentTotal) return { action: "increase_budget", direction: "increase" };
+  if (proposedTotal < currentTotal) return { action: "decrease_budget", direction: "decrease" };
+  return { action: "reallocate_budget", direction: "reallocate" };
+}
+function resolveFlightEndDirection(currentBuy, request, field) {
+  if (request.start_time !== void 0) {
+    return { action: "update_flight_dates", direction: "shift" };
+  }
+  const packageStartTouched = (request.packages ?? []).some((pkg) => pkg.start_time !== void 0);
+  if (packageStartTouched) {
+    return { action: "update_flight_dates", direction: "shift" };
+  }
+  if (field === "end_time") {
+    const currentEnd = currentBuy.end_time;
+    const proposedEnd = request.end_time;
+    if (currentEnd && proposedEnd) {
+      const cur = Date.parse(currentEnd);
+      const next = Date.parse(proposedEnd);
+      if (!Number.isNaN(cur) && !Number.isNaN(next)) {
+        if (next > cur) return { action: "extend_flight", direction: "extend" };
+        if (next < cur) return { action: "shorten_flight", direction: "shorten" };
+      }
+    }
+    return { action: "update_flight_dates", direction: "shift" };
+  }
+  let extending = false;
+  let shortening = false;
+  const currentByPkg = /* @__PURE__ */ new Map();
+  for (const pkg of currentBuy.packages ?? []) {
+    if (pkg.package_id) currentByPkg.set(pkg.package_id, pkg.end_time);
+  }
+  for (const pkg of request.packages ?? []) {
+    if (!pkg.end_time) continue;
+    const prev = currentByPkg.get(pkg.package_id);
+    if (!prev) {
+      extending = true;
+      continue;
+    }
+    const cur = Date.parse(prev);
+    const next = Date.parse(pkg.end_time);
+    if (Number.isNaN(cur) || Number.isNaN(next)) continue;
+    if (next > cur) extending = true;
+    if (next < cur) shortening = true;
+  }
+  if (extending && !shortening) return { action: "extend_flight", direction: "extend" };
+  if (shortening && !extending) return { action: "shorten_flight", direction: "shorten" };
+  return { action: "update_flight_dates", direction: "shift" };
+}
+function hasUnmappedMutation(request, decomposition) {
+  const envelope = /* @__PURE__ */ new Set([
+    "media_buy_id",
+    "account",
+    "revision",
+    "idempotency_key",
+    "adcp_version",
+    "adcp_major_version",
+    "context_id",
+    "context",
+    "governance_context",
+    "push_notification_config"
+  ]);
+  const paths = decomposition.mutations.map((m) => m.path);
+  const covered = (path) => paths.some((p) => p === path || p.startsWith(`${path}.`));
+  return Object.entries(request).some(
+    ([key, value]) => value !== void 0 && key !== "packages" && !(key === "new_packages" && Array.isArray(value) && value.length === 0) && !envelope.has(key) && !covered(key)
+  ) || !!request.new_packages?.some(
+    (pkg) => pkg !== null && typeof pkg === "object" && "ext" in pkg && pkg.ext !== void 0
+  ) || !!request.packages?.some(
+    (pkg, index) => Object.entries(pkg).some(
+      ([key, value]) => value !== void 0 && !["package_id", "context"].includes(key) && !covered(`packages[${index}].${key}`)
+    )
+  );
+}
+function mutationShapeIssue(request) {
+  const record = (v) => !!v && typeof v === "object" && !Array.isArray(v);
+  if (!record(request)) return "request";
+  if (request.total_budget !== void 0 && (!record(request.total_budget) || typeof request.total_budget.amount !== "number" || !Number.isFinite(request.total_budget.amount) || typeof request.total_budget.currency !== "string"))
+    return "total_budget";
+  if (request.paused !== void 0 && typeof request.paused !== "boolean") return "paused";
+  if (request.canceled !== void 0 && request.canceled !== true) return "canceled";
+  for (const key of ["packages", "new_packages"]) {
+    if (request[key] === void 0) continue;
+    if (!Array.isArray(request[key])) return key;
+    for (const [index, pkg] of request[key].entries()) {
+      if (!record(pkg)) return `${key}[${index}]`;
+      if (key === "new_packages") continue;
+      if (pkg.paused !== void 0 && typeof pkg.paused !== "boolean") return `packages[${index}].paused`;
+      if (pkg.canceled !== void 0 && pkg.canceled !== true) return `packages[${index}].canceled`;
+      if (pkg.targeting_overlay !== void 0 && !record(pkg.targeting_overlay))
+        return `packages[${index}].targeting_overlay`;
+      if (pkg.creatives !== void 0 && (!Array.isArray(pkg.creatives) || !pkg.creatives.length))
+        return `packages[${index}].creatives`;
+      if (pkg.creative_assignments !== void 0 && !Array.isArray(pkg.creative_assignments))
+        return `packages[${index}].creative_assignments`;
+    }
+  }
+  return void 0;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  decomposeUpdateMediaBuy,
+  getActionForMutation,
+  hasUnmappedMutation,
+  mutationShapeIssue
+});