@koda-sl/baker-cli 0.333.0 → 0.335.0

package/dist/cli.js

@@ -1887,7 +1887,78 @@ var audienceCreateSchema = z3.object({
       message: `${p.audienceType} audiences need a raw source config (use --file)`
     });
   }
-});
+  if (!isList && p.raw) {
+    for (const message of retargetingConfigProblems(p.raw)) {
+      ctx.addIssue({ code: "custom", path: ["raw"], message: `${p.audienceType} source config: ${message}` });
+    }
+  }
+});
+var ENGAGEMENT_LOOKBACK_DAYS = [7, 14, 28, 30, 60, 90, 180, 365];
+var WEBSITE_LOOKBACK_DAYS = ENGAGEMENT_LOOKBACK_DAYS.filter((days) => days >= 14 && days <= 180);
+var EVENT_LOOKBACK_DAYS = [730];
+var WEBSITE_SOURCE_PLATFORM = "LINKEDIN_WEBSITE_RETARGETING";
+var TRIGGER_SOURCE_TYPE_BY_PLATFORM = { [WEBSITE_SOURCE_PLATFORM]: "WEBSITE" };
+function lookbackDaysFor(sourcePlatform) {
+  if (sourcePlatform === WEBSITE_SOURCE_PLATFORM) {
+    return WEBSITE_LOOKBACK_DAYS;
+  }
+  return sourcePlatform === "EVENT_PAGES" ? EVENT_LOOKBACK_DAYS : ENGAGEMENT_LOOKBACK_DAYS;
+}
+var ENGAGEMENT_TRIGGER_URN = /^urn:li:dmpEngagementTrigger:\(urn:li:dmpEngagementSourceType:([A-Z_]+),([A-Z_]+)\)$/;
+var RETARGETING_EXAMPLE = '{"sourcePlatform":"VIDEO_ADS","type":"USER","engagementRules":[{"engagementSource":"urn:li:sponsoredCampaign:123","engagementTrigger":"urn:li:dmpEngagementTrigger:(urn:li:dmpEngagementSourceType:VIDEO_ADS,FIRST_QUARTILE)","timeFrame":{"timeSpan":{"duration":90,"unit":"DAY"}}}]}';
+var engagementRuleSchema = z3.object({
+  engagementSource: z3.string().regex(/^urn:li:[A-Za-z]+:\S+$/, "engagementSource must be a URN (urn:li:\u2026)"),
+  engagementTrigger: z3.string().regex(
+    ENGAGEMENT_TRIGGER_URN,
+    "engagementTrigger must be urn:li:dmpEngagementTrigger:(urn:li:dmpEngagementSourceType:<SOURCE>,<TRIGGER>)"
+  ),
+  timeFrame: z3.object({
+    timeSpan: z3.object({ duration: z3.number().int().positive(), unit: z3.literal("DAY") })
+  })
+}).passthrough();
+var engagementRulesSchema = z3.array(engagementRuleSchema).min(1);
+function retargetingConfigProblems(raw) {
+  const problems = [];
+  const sourcePlatform = typeof raw.sourcePlatform === "string" ? raw.sourcePlatform.trim() : "";
+  if (!sourcePlatform) {
+    problems.push("missing sourcePlatform");
+  }
+  if (raw.type !== "USER") {
+    problems.push('type must be "USER" \u2014 LinkedIn only attaches engagement rules to USER segments');
+  }
+  const rules = engagementRulesSchema.safeParse(raw.engagementRules);
+  if (!rules.success) {
+    const detail = rules.error.issues.map((issue) => issue.message).join("; ");
+    problems.push(
+      `engagementRules needs at least one source rule (engagementSource, engagementTrigger, timeFrame) \u2014 ${detail}. e.g. ${RETARGETING_EXAMPLE}`
+    );
+    return problems;
+  }
+  const allowed = lookbackDaysFor(sourcePlatform);
+  const expectedTriggerSource = TRIGGER_SOURCE_TYPE_BY_PLATFORM[sourcePlatform] ?? sourcePlatform;
+  for (const rule of rules.data) {
+    const triggerSource = ENGAGEMENT_TRIGGER_URN.exec(rule.engagementTrigger)?.[1];
+    if (sourcePlatform && triggerSource !== expectedTriggerSource) {
+      problems.push(
+        `engagementTrigger ${rule.engagementTrigger} is a ${triggerSource} trigger, not ${expectedTriggerSource}`
+      );
+    }
+    const days = rule.timeFrame.timeSpan.duration;
+    if (!allowed.includes(days)) {
+      problems.push(`lookback ${days} days is not offered for ${sourcePlatform} \u2014 use ${allowed.join(", ")}`);
+    }
+  }
+  const shapes = new Set(rules.data.map((rule) => `${rule.engagementTrigger}|${rule.timeFrame.timeSpan.duration}`));
+  if (shapes.size > 1) {
+    problems.push("every engagement rule on one audience must use the same trigger and lookback");
+  }
+  const sources = rules.data.map((rule) => rule.engagementSource);
+  const repeated = [...new Set(sources.filter((source, index) => sources.indexOf(source) !== index))];
+  if (repeated.length > 0) {
+    problems.push(`each engagementSource can appear in only one rule: ${repeated.join(", ")}`);
+  }
+  return problems;
+}
 var audienceUploadListSchema = z3.object({
   segment: parentRefSchema,
   listColumns: z3.array(z3.string().min(1)).optional(),
@@ -4918,7 +4989,15 @@ var scheduledEffectSchema = z13.object({
   op: effectOpSchema,
   staged: z13.boolean(),
   name: z13.string(),
-  summary: z13.string().nullable()
+  summary: z13.string().nullable(),
+  /**
+   * What the publish did with this op, or null while it is still staged. `op`
+   * is what was asked for; this is whether it happened — a task whose schedule
+   * could not be saved still reads `op: "created"`.
+   */
+  outcome: z13.enum(["applied", "failed", "skipped"]).nullable(),
+  /** Why it failed or was skipped, or how it was applied differently (e.g. switched off). */
+  reason: z13.string().nullable()
 });
 var tagEffectSchema = z13.object({
   op: effectOpSchema,
@@ -19929,7 +20008,11 @@ registerSchema({
     name: { type: "string", description: "Audience name (\u2264100 chars)", required: true },
     type: { type: "string", description: "company-list|user-list|retargeting|engagement", required: true },
     "list-file": { type: "string", description: "CSV file with the list rows", required: false },
-    file: { type: "string", description: "JSON raw source config for retargeting/engagement", required: false }
+    file: {
+      type: "string",
+      description: "JSON raw source config for retargeting/engagement \u2014 sourcePlatform, type USER, and engagementRules (engagementSource, engagementTrigger, timeFrame)",
+      required: false
+    }
   }
 });
 registerSchema({
@@ -20681,7 +20764,10 @@ Example: baker ads linkedin audiences create --name "ABM Tier-1" --type company-
     name: { type: "string", description: "Audience name (\u2264100 chars)" },
     type: { type: "string", description: AUDIENCE_TYPES2.join("|") },
     "list-file": { type: "string", description: "CSV file with the list rows (header row required)" },
-    file: { type: "string", description: "JSON file with a raw source config (retargeting/engagement)" }
+    file: {
+      type: "string",
+      description: 'JSON file with a raw source config (retargeting/engagement) \u2014 sourcePlatform, type USER and at least one engagementRules entry, e.g. {"sourcePlatform":"VIDEO_ADS","type":"USER","engagementRules":[{"engagementSource":"urn:li:sponsoredCampaign:123","engagementTrigger":"urn:li:dmpEngagementTrigger:(urn:li:dmpEngagementSourceType:VIDEO_ADS,FIRST_QUARTILE)","timeFrame":{"timeSpan":{"duration":90,"unit":"DAY"}}}]}'
+    }
   },
   run: async ({ args: args5 }) => {
     const accountId = bareAccountId(args5);
@@ -22365,6 +22451,10 @@ function renderOutcome2(data, lines) {
   lines.push(`LinkedIn Ads \u2014 published \xB7 ${summary || `${data.count} op(s)`} \xB7 ${data.mode}`);
   for (const op of data.ops ?? []) {
     const status = op.result?.status;
+    if (status === "applied" && op.result?.error) {
+      lines.push(`  \u26A0 ${op.summary} \u2014 applied in part: ${op.result.error}`);
+      continue;
+    }
     if (status !== "failed" && status !== "skipped") {
       continue;
     }