@adcp/client 4.0.2 → 4.1.0

package/dist/lib/utils/deprecation.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * Deprecation warning utility for backward-compat shims.
+ *
+ * Each key is warned once per process lifetime to avoid log spam.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.warnOnce = warnOnce;
+exports.resetWarnings = resetWarnings;
+const warned = new Set();
+function warnOnce(key, message) {
+    if (!warned.has(key)) {
+        warned.add(key);
+        console.warn(`[@adcp/client] DEPRECATED: ${message}`);
+    }
+}
+/**
+ * Reset all deprecation warnings. Only useful in tests.
+ */
+function resetWarnings() {
+    warned.clear();
+}
+//# sourceMappingURL=deprecation.js.map

package/dist/lib/utils/deprecation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecation.js","sourceRoot":"","sources":["../../../src/lib/utils/deprecation.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAIH,4BAKC;AAKD,sCAEC;AAdD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAU,CAAC;AAEjC,SAAgB,QAAQ,CAAC,GAAW,EAAE,OAAe;IACnD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,OAAO,CAAC,IAAI,CAAC,8BAA8B,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAgB,aAAa;IAC3B,MAAM,CAAC,KAAK,EAAE,CAAC;AACjB,CAAC"}

package/dist/lib/utils/request-normalizer.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Request parameter normalization for backward compatibility.
+ *
+ * Converts deprecated field names and shapes so callers written against
+ * earlier schema versions keep working. Each conversion emits a one-time
+ * deprecation warning via warnOnce().
+ */
+/**
+ * Normalize a single package's params for backward compatibility.
+ *
+ * Handles:
+ * - optimization_goal (scalar) → optimization_goals (array)
+ * - catalog (scalar object) → catalogs (array)
+ */
+export declare function normalizePackageParams(pkg: any): any;
+/**
+ * Normalize request params for backward compatibility.
+ *
+ * Infers missing fields that can be derived from deprecated params so callers
+ * written against older schema versions keep working.
+ */
+export declare function normalizeRequestParams(taskType: string, params: any): any;
+//# sourceMappingURL=request-normalizer.d.ts.map

package/dist/lib/utils/request-normalizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-normalizer.d.ts","sourceRoot":"","sources":["../../../src/lib/utils/request-normalizer.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAuBpD;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,GAAG,CAqFzE"}

package/dist/lib/utils/request-normalizer.js

@@ -0,0 +1,119 @@
+"use strict";
+/**
+ * Request parameter normalization for backward compatibility.
+ *
+ * Converts deprecated field names and shapes so callers written against
+ * earlier schema versions keep working. Each conversion emits a one-time
+ * deprecation warning via warnOnce().
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizePackageParams = normalizePackageParams;
+exports.normalizeRequestParams = normalizeRequestParams;
+const compat_1 = require("../types/compat");
+const deprecation_1 = require("./deprecation");
+/**
+ * Normalize a single package's params for backward compatibility.
+ *
+ * Handles:
+ * - optimization_goal (scalar) → optimization_goals (array)
+ * - catalog (scalar object) → catalogs (array)
+ */
+function normalizePackageParams(pkg) {
+    if (!pkg || typeof pkg !== 'object')
+        return pkg;
+    const normalized = { ...pkg };
+    // optimization_goal (scalar) → optimization_goals (array)
+    if (normalized.optimization_goal && !normalized.optimization_goals?.length) {
+        (0, deprecation_1.warnOnce)('optimization_goal', 'PackageRequest.optimization_goal is deprecated. Use optimization_goals (array) instead.');
+        normalized.optimization_goals = [normalized.optimization_goal];
+    }
+    delete normalized.optimization_goal;
+    // catalog (scalar) → catalogs (array)
+    if (normalized.catalog && !normalized.catalogs?.length) {
+        (0, deprecation_1.warnOnce)('catalog', 'PackageRequest.catalog is deprecated. Use catalogs (array) instead.');
+        normalized.catalogs = [normalized.catalog];
+    }
+    delete normalized.catalog;
+    return normalized;
+}
+/**
+ * Normalize request params for backward compatibility.
+ *
+ * Infers missing fields that can be derived from deprecated params so callers
+ * written against older schema versions keep working.
+ */
+function normalizeRequestParams(taskType, params) {
+    if (!params) {
+        return params;
+    }
+    let normalized = { ...params };
+    // ── Universal shims (all tools) ──
+    // Always delete deprecated fields, even when the new field already exists,
+    // to prevent Zod strict validation failures on unknown keys.
+    // account_id (bare string) → account: { account_id }
+    if (typeof normalized.account_id === 'string' && !normalized.account) {
+        (0, deprecation_1.warnOnce)('account_id', 'account_id is deprecated. Use account: { account_id } instead.');
+        normalized.account = { account_id: normalized.account_id };
+    }
+    delete normalized.account_id;
+    // campaign_ref → buyer_campaign_ref
+    if (normalized.campaign_ref && !normalized.buyer_campaign_ref) {
+        (0, deprecation_1.warnOnce)('campaign_ref', 'campaign_ref is deprecated. Use buyer_campaign_ref instead.');
+        normalized.buyer_campaign_ref = normalized.campaign_ref;
+    }
+    delete normalized.campaign_ref;
+    // ── brand_manifest → brand (get_products, create_media_buy) ──
+    // update_media_buy has no brand field in either v2 or v3 — excluded deliberately.
+    // brand takes precedence if both are supplied.
+    if (taskType === 'get_products' || taskType === 'create_media_buy') {
+        if (normalized.brand_manifest && !normalized.brand) {
+            const brand = (0, compat_1.brandManifestToBrandReference)(normalized.brand_manifest);
+            if (brand) {
+                normalized.brand = brand;
+            }
+        }
+        delete normalized.brand_manifest;
+    }
+    // ── Package normalization (create_media_buy, update_media_buy) ──
+    if ((taskType === 'create_media_buy' || taskType === 'update_media_buy') && Array.isArray(normalized.packages)) {
+        normalized.packages = normalized.packages.map(normalizePackageParams);
+    }
+    // ── activate_signal: deployments → destinations ──
+    if (taskType === 'activate_signal') {
+        if (normalized.deployments && !normalized.destinations) {
+            (0, deprecation_1.warnOnce)('deployments', 'deployments is deprecated. Use destinations instead.');
+            normalized.destinations = normalized.deployments;
+        }
+        delete normalized.deployments;
+    }
+    // ── get_signals: deliver_to → destinations ──
+    if (taskType === 'get_signals') {
+        if (normalized.deliver_to && !normalized.destinations) {
+            (0, deprecation_1.warnOnce)('deliver_to', 'deliver_to is deprecated. Use destinations and countries instead.');
+            normalized.destinations = normalized.deliver_to;
+        }
+        delete normalized.deliver_to;
+    }
+    // ── get_products-specific normalization ──
+    if (taskType === 'get_products') {
+        // Infer buying_mode from brief presence if not supplied
+        if (!normalized.buying_mode) {
+            normalized.buying_mode = normalized.brief ? 'brief' : 'wholesale';
+        }
+        // Strip removed v2 fields that would fail strict validation
+        for (const removed of ['feedback', 'product_ids', 'proposal_id']) {
+            if (removed in normalized) {
+                (0, deprecation_1.warnOnce)(`get_products.${removed}`, `GetProductsRequest.${removed} has been removed in v3.`);
+                delete normalized[removed];
+            }
+        }
+        // Convert legacy product_selectors (v3 beta / v2 era) → catalog so strict validation passes.
+        // catalog takes precedence if both are supplied.
+        if (normalized.product_selectors && !normalized.catalog) {
+            normalized.catalog = (0, compat_1.promotedProductsToCatalog)(normalized.product_selectors);
+        }
+        delete normalized.product_selectors;
+    }
+    return normalized;
+}
+//# sourceMappingURL=request-normalizer.js.map

package/dist/lib/utils/request-normalizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-normalizer.js","sourceRoot":"","sources":["../../../src/lib/utils/request-normalizer.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAYH,wDAuBC;AAQD,wDAqFC;AA9HD,4CAA2F;AAC3F,+CAAyC;AAEzC;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,GAAQ;IAC7C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,GAAG,CAAC;IAEhD,MAAM,UAAU,GAAG,EAAE,GAAG,GAAG,EAAE,CAAC;IAE9B,0DAA0D;IAC1D,IAAI,UAAU,CAAC,iBAAiB,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,MAAM,EAAE,CAAC;QAC3E,IAAA,sBAAQ,EACN,mBAAmB,EACnB,yFAAyF,CAC1F,CAAC;QACF,UAAU,CAAC,kBAAkB,GAAG,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,UAAU,CAAC,iBAAiB,CAAC;IAEpC,sCAAsC;IACtC,IAAI,UAAU,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC;QACvD,IAAA,sBAAQ,EAAC,SAAS,EAAE,qEAAqE,CAAC,CAAC;QAC3F,UAAU,CAAC,QAAQ,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,UAAU,CAAC,OAAO,CAAC;IAE1B,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,sBAAsB,CAAC,QAAgB,EAAE,MAAW;IAClE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,UAAU,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;IAE/B,oCAAoC;IACpC,2EAA2E;IAC3E,6DAA6D;IAE7D,qDAAqD;IACrD,IAAI,OAAO,UAAU,CAAC,UAAU,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QACrE,IAAA,sBAAQ,EAAC,YAAY,EAAE,gEAAgE,CAAC,CAAC;QACzF,UAAU,CAAC,OAAO,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,UAAU,EAAE,CAAC;IAC7D,CAAC;IACD,OAAO,UAAU,CAAC,UAAU,CAAC;IAE7B,oCAAoC;IACpC,IAAI,UAAU,CAAC,YAAY,IAAI,CAAC,UAAU,CAAC,kBAAkB,EAAE,CAAC;QAC9D,IAAA,sBAAQ,EAAC,cAAc,EAAE,6DAA6D,CAAC,CAAC;QACxF,UAAU,CAAC,kBAAkB,GAAG,UAAU,CAAC,YAAY,CAAC;IAC1D,CAAC;IACD,OAAO,UAAU,CAAC,YAAY,CAAC;IAE/B,gEAAgE;IAChE,kFAAkF;IAClF,+CAA+C;IAC/C,IAAI,QAAQ,KAAK,cAAc,IAAI,QAAQ,KAAK,kBAAkB,EAAE,CAAC;QACnE,IAAI,UAAU,CAAC,cAAc,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;YACnD,MAAM,KAAK,GAAG,IAAA,sCAA6B,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;YACvE,IAAI,KAAK,EAAE,CAAC;gBACV,UAAU,CAAC,KAAK,GAAG,KAAK,CAAC;YAC3B,CAAC;QACH,CAAC;QACD,OAAO,UAAU,CAAC,cAAc,CAAC;IACnC,CAAC;IAED,mEAAmE;IACnE,IAAI,CAAC,QAAQ,KAAK,kBAAkB,IAAI,QAAQ,KAAK,kBAAkB,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/G,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IACpD,IAAI,QAAQ,KAAK,iBAAiB,EAAE,CAAC;QACnC,IAAI,UAAU,CAAC,WAAW,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;YACvD,IAAA,sBAAQ,EAAC,aAAa,EAAE,sDAAsD,CAAC,CAAC;YAChF,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,WAAW,CAAC;QACnD,CAAC;QACD,OAAO,UAAU,CAAC,WAAW,CAAC;IAChC,CAAC;IAED,+CAA+C;IAC/C,IAAI,QAAQ,KAAK,aAAa,EAAE,CAAC;QAC/B,IAAI,UAAU,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,YAAY,EAAE,CAAC;YACtD,IAAA,sBAAQ,EAAC,YAAY,EAAE,mEAAmE,CAAC,CAAC;YAC5F,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,UAAU,CAAC;QAClD,CAAC;QACD,OAAO,UAAU,CAAC,UAAU,CAAC;IAC/B,CAAC;IAED,4CAA4C;IAC5C,IAAI,QAAQ,KAAK,cAAc,EAAE,CAAC;QAChC,wDAAwD;QACxD,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;YAC5B,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC;QACpE,CAAC;QAED,4DAA4D;QAC5D,KAAK,MAAM,OAAO,IAAI,CAAC,UAAU,EAAE,aAAa,EAAE,aAAa,CAAU,EAAE,CAAC;YAC1E,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;gBAC1B,IAAA,sBAAQ,EAAC,gBAAgB,OAAO,EAAE,EAAE,sBAAsB,OAAO,0BAA0B,CAAC,CAAC;gBAC7F,OAAQ,UAAkB,CAAC,OAAO,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,6FAA6F;QAC7F,iDAAiD;QACjD,IAAI,UAAU,CAAC,iBAAiB,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YACxD,UAAU,CAAC,OAAO,GAAG,IAAA,kCAAyB,EAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;QAC/E,CAAC;QACD,OAAO,UAAU,CAAC,iBAAiB,CAAC;IACtC,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adcp/client",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "AdCP client library with protocol support for MCP and A2A, includes testing framework",
   "main": "dist/lib/index.js",
   "types": "dist/lib/index.d.ts",