@lhremote/core 0.1.0 → 0.2.0

package/dist/formats/campaign-format.js

@@ -0,0 +1,225 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (C) 2026 Oleksii PELYKH
+import { parse as parseYaml, stringify as stringifyYaml } from "yaml";
+import { errorMessage } from "../utils/error-message.js";
+import { FormatError } from "./errors.js";
+/** Current version of the campaign document format. */
+const CURRENT_VERSION = "1";
+/**
+ * Thrown when a campaign document fails structural validation.
+ */
+export class CampaignFormatError extends FormatError {
+    constructor(message) {
+        super(message);
+        this.name = "CampaignFormatError";
+    }
+}
+// ---------------------------------------------------------------------------
+// Parse
+// ---------------------------------------------------------------------------
+/**
+ * Parse a YAML string into a CampaignConfig.
+ *
+ * @throws {CampaignFormatError} if the YAML is malformed or the document
+ *   fails structural validation.
+ */
+export function parseCampaignYaml(yamlString) {
+    let doc;
+    try {
+        doc = parseYaml(yamlString);
+    }
+    catch (error) {
+        const message = errorMessage(error);
+        throw new CampaignFormatError(`Invalid YAML: ${message}`);
+    }
+    return parseCampaignDocument(doc);
+}
+/**
+ * Parse a JSON string into a CampaignConfig.
+ *
+ * @throws {CampaignFormatError} if the JSON is malformed or the document
+ *   fails structural validation.
+ */
+export function parseCampaignJson(jsonString) {
+    let doc;
+    try {
+        doc = JSON.parse(jsonString);
+    }
+    catch (error) {
+        const message = errorMessage(error);
+        throw new CampaignFormatError(`Invalid JSON: ${message}`);
+    }
+    return parseCampaignDocument(doc);
+}
+// ---------------------------------------------------------------------------
+// Serialize
+// ---------------------------------------------------------------------------
+/**
+ * Serialize a campaign and its actions to a YAML string.
+ */
+export function serializeCampaignYaml(campaign, actions) {
+    const doc = toCampaignDocument(campaign, actions);
+    return stringifyYaml(doc);
+}
+/**
+ * Serialize a campaign and its actions to a JSON string.
+ */
+export function serializeCampaignJson(campaign, actions) {
+    const doc = toCampaignDocument(campaign, actions);
+    return JSON.stringify(doc, null, 2) + "\n";
+}
+// ---------------------------------------------------------------------------
+// Internal: parse
+// ---------------------------------------------------------------------------
+function parseCampaignDocument(doc) {
+    if (doc === null || typeof doc !== "object") {
+        throw new CampaignFormatError("Campaign document must be an object");
+    }
+    const obj = doc;
+    // Version
+    if (!("version" in obj) || obj["version"] === undefined) {
+        throw new CampaignFormatError("Missing required field: version");
+    }
+    if (String(obj["version"]) !== CURRENT_VERSION) {
+        throw new CampaignFormatError(`Unsupported version: ${String(obj["version"])} (expected ${CURRENT_VERSION})`);
+    }
+    // Name
+    if (!("name" in obj) || typeof obj["name"] !== "string" || obj["name"].trim() === "") {
+        throw new CampaignFormatError("Missing or empty required field: name");
+    }
+    const name = obj["name"].trim();
+    // Description
+    const description = "description" in obj && typeof obj["description"] === "string"
+        ? obj["description"]
+        : undefined;
+    // Settings (campaign-level defaults)
+    const settings = parseDocumentSettings(obj["settings"]);
+    // Actions
+    if (!("actions" in obj) || obj["actions"] === undefined) {
+        throw new CampaignFormatError("Missing required field: actions");
+    }
+    if (!Array.isArray(obj["actions"])) {
+        throw new CampaignFormatError("Invalid field: actions must be an array");
+    }
+    if (obj["actions"].length === 0) {
+        throw new CampaignFormatError("Actions array must not be empty");
+    }
+    const actions = obj["actions"].map((raw, index) => parseDocumentAction(raw, index, settings));
+    const config = { name, actions };
+    if (description !== undefined) {
+        config.description = description;
+    }
+    return config;
+}
+function parseDocumentSettings(raw) {
+    if (raw === null || raw === undefined) {
+        return {};
+    }
+    if (Array.isArray(raw) || typeof raw !== "object") {
+        throw new CampaignFormatError("Invalid field: settings must be an object");
+    }
+    const obj = raw;
+    const settings = {};
+    if ("cooldownMs" in obj && typeof obj["cooldownMs"] === "number" && Number.isFinite(obj["cooldownMs"])) {
+        settings.cooldownMs = obj["cooldownMs"];
+    }
+    if ("maxActionsPerRun" in obj && typeof obj["maxActionsPerRun"] === "number" && Number.isFinite(obj["maxActionsPerRun"])) {
+        settings.maxActionsPerRun = obj["maxActionsPerRun"];
+    }
+    return settings;
+}
+function parseDocumentAction(raw, index, defaults) {
+    if (raw === null || typeof raw !== "object") {
+        throw new CampaignFormatError(`Action at index ${String(index)} must be an object`);
+    }
+    const obj = raw;
+    if (!("type" in obj) || typeof obj["type"] !== "string" || obj["type"].trim() === "") {
+        throw new CampaignFormatError(`Action at index ${String(index)} is missing required field: type`);
+    }
+    const actionType = obj["type"].trim();
+    const actionSettings = "config" in obj && obj["config"] !== null && typeof obj["config"] === "object" && !Array.isArray(obj["config"])
+        ? obj["config"]
+        : undefined;
+    const action = {
+        name: actionType,
+        actionType,
+    };
+    if (actionSettings !== undefined) {
+        action.actionSettings = actionSettings;
+    }
+    // Apply coolDown: per-action override > campaign-level default
+    const coolDown = getFiniteNumberField(obj, "cooldownMs") ?? defaults.cooldownMs;
+    if (coolDown !== undefined) {
+        action.coolDown = coolDown;
+    }
+    // Apply maxActionResultsPerIteration: per-action > campaign-level
+    const maxActions = getFiniteNumberField(obj, "maxActionsPerRun") ?? defaults.maxActionsPerRun;
+    if (maxActions !== undefined) {
+        action.maxActionResultsPerIteration = maxActions;
+    }
+    return action;
+}
+function getFiniteNumberField(obj, key) {
+    if (key in obj && typeof obj[key] === "number" && Number.isFinite(obj[key])) {
+        return obj[key];
+    }
+    return undefined;
+}
+// ---------------------------------------------------------------------------
+// Internal: serialize
+// ---------------------------------------------------------------------------
+function toCampaignDocument(campaign, actions) {
+    // Extract common settings first so we know what goes at campaign-level
+    const commonSettings = extractCommonSettings(actions);
+    const docActions = actions.map((a) => {
+        const docAction = { type: a.config.actionType };
+        const settings = a.config.actionSettings;
+        if (settings !== undefined && Object.keys(settings).length > 0) {
+            docAction.config = settings;
+        }
+        // Emit per-action settings when they differ from campaign-level defaults
+        const coolDown = a.config.coolDown;
+        if (commonSettings?.cooldownMs === undefined && Number.isFinite(coolDown)) {
+            docAction.cooldownMs = coolDown;
+        }
+        const maxResults = a.config.maxActionResultsPerIteration;
+        if (commonSettings?.maxActionsPerRun === undefined && Number.isFinite(maxResults)) {
+            docAction.maxActionsPerRun = maxResults;
+        }
+        return docAction;
+    });
+    const doc = {
+        version: CURRENT_VERSION,
+        name: campaign.name,
+        actions: docActions,
+    };
+    if (campaign.description !== null) {
+        doc.description = campaign.description;
+    }
+    if (commonSettings !== undefined) {
+        doc.settings = commonSettings;
+    }
+    return doc;
+}
+function extractCommonSettings(actions) {
+    if (actions.length === 0)
+        return undefined;
+    const first = actions[0];
+    if (first === undefined)
+        return undefined;
+    const coolDown = first.config.coolDown;
+    const maxResults = first.config.maxActionResultsPerIteration;
+    const allSameCoolDown = actions.every((a) => a.config.coolDown === coolDown);
+    const allSameMaxResults = actions.every((a) => a.config.maxActionResultsPerIteration === maxResults);
+    if (!allSameCoolDown && !allSameMaxResults)
+        return undefined;
+    const settings = {};
+    if (allSameCoolDown) {
+        settings.cooldownMs = coolDown;
+    }
+    if (allSameMaxResults) {
+        settings.maxActionsPerRun = maxResults;
+    }
+    return settings;
+}
+//# sourceMappingURL=campaign-format.js.map

package/dist/formats/campaign-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-format.js","sourceRoot":"","sources":["../../src/formats/campaign-format.ts"],"names":[],"mappings":"AAAA,yCAAyC;AACzC,oCAAoC;AAEpC,OAAO,EAAE,KAAK,IAAI,SAAS,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAOzD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,uDAAuD;AACvD,MAAM,eAAe,GAAG,GAAG,CAAC;AA6B5B;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAClD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AAED,8EAA8E;AAC9E,QAAQ;AACR,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,IAAI,mBAAmB,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAY,CAAC;IAC1C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,IAAI,mBAAmB,CAAC,iBAAiB,OAAO,EAAE,CAAC,CAAC;IAC5D,CAAC;IACD,OAAO,qBAAqB,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC;AAED,8EAA8E;AAC9E,YAAY;AACZ,8EAA8E;AAE9E;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAkB,EAClB,OAAyB;IAEzB,MAAM,GAAG,GAAG,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClD,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAkB,EAClB,OAAyB;IAEzB,MAAM,GAAG,GAAG,kBAAkB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAClD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;AAC7C,CAAC;AAED,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E,SAAS,qBAAqB,CAAC,GAAY;IACzC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5C,MAAM,IAAI,mBAAmB,CAAC,qCAAqC,CAAC,CAAC;IACvE,CAAC;IAED,MAAM,GAAG,GAAG,GAA8B,CAAC;IAE3C,UAAU;IACV,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;QACxD,MAAM,IAAI,mBAAmB,CAAC,iCAAiC,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,eAAe,EAAE,CAAC;QAC/C,MAAM,IAAI,mBAAmB,CAC3B,wBAAwB,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,cAAc,eAAe,GAAG,CAC/E,CAAC;IACJ,CAAC;IAED,OAAO;IACP,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrF,MAAM,IAAI,mBAAmB,CAAC,uCAAuC,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IAEhC,cAAc;IACd,MAAM,WAAW,GACf,aAAa,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,QAAQ;QAC5D,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC;QACpB,CAAC,CAAC,SAAS,CAAC;IAEhB,qCAAqC;IACrC,MAAM,QAAQ,GAAG,qBAAqB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IAExD,UAAU;IACV,IAAI,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;QACxD,MAAM,IAAI,mBAAmB,CAAC,iCAAiC,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,mBAAmB,CAAC,yCAAyC,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,MAAM,IAAI,mBAAmB,CAAC,iCAAiC,CAAC,CAAC;IACnE,CAAC;IAED,MAAM,OAAO,GAA4B,GAAG,CAAC,SAAS,CAAe,CAAC,GAAG,CACvE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAC1D,CAAC;IAEF,MAAM,MAAM,GAAmB,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACjD,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,qBAAqB,CAC5B,GAAY;IAEZ,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAClD,MAAM,IAAI,mBAAmB,CAAC,2CAA2C,CAAC,CAAC;IAC7E,CAAC;IAED,MAAM,GAAG,GAAG,GAA8B,CAAC;IAC3C,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAE9C,IAAI,YAAY,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,YAAY,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;QACvG,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,kBAAkB,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,kBAAkB,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC;QACzH,QAAQ,CAAC,gBAAgB,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,mBAAmB,CAC1B,GAAY,EACZ,KAAa,EACb,QAAkC;IAElC,IAAI,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC5C,MAAM,IAAI,mBAAmB,CAC3B,mBAAmB,MAAM,CAAC,KAAK,CAAC,oBAAoB,CACrD,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,GAA8B,CAAC;IAE3C,IAAI,CAAC,CAAC,MAAM,IAAI,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACrF,MAAM,IAAI,mBAAmB,CAC3B,mBAAmB,MAAM,CAAC,KAAK,CAAC,kCAAkC,CACnE,CAAC;IACJ,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;IACtC,MAAM,cAAc,GAClB,QAAQ,IAAI,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,OAAO,GAAG,CAAC,QAAQ,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC7G,CAAC,CAAE,GAAG,CAAC,QAAQ,CAA6B;QAC5C,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,MAAM,GAAyB;QACnC,IAAI,EAAE,UAAU;QAChB,UAAU;KACX,CAAC;IAEF,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;IACzC,CAAC;IAED,+DAA+D;IAC/D,MAAM,QAAQ,GAAG,oBAAoB,CAAC,GAAG,EAAE,YAAY,CAAC,IAAI,QAAQ,CAAC,UAAU,CAAC;IAChF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED,kEAAkE;IAClE,MAAM,UAAU,GACd,oBAAoB,CAAC,GAAG,EAAE,kBAAkB,CAAC,IAAI,QAAQ,CAAC,gBAAgB,CAAC;IAC7E,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,CAAC,4BAA4B,GAAG,UAAU,CAAC;IACnD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,oBAAoB,CAC3B,GAA4B,EAC5B,GAAW;IAEX,IAAI,GAAG,IAAI,GAAG,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC5E,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,8EAA8E;AAC9E,sBAAsB;AACtB,8EAA8E;AAE9E,SAAS,kBAAkB,CACzB,QAAkB,EAClB,OAAyB;IAEzB,uEAAuE;IACvE,MAAM,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAEtD,MAAM,UAAU,GAA6B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC7D,MAAM,SAAS,GAA2B,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QACxE,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC;QAEzC,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/D,SAAS,CAAC,MAAM,GAAG,QAAQ,CAAC;QAC9B,CAAC;QAED,yEAAyE;QACzE,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QACnC,IAAI,cAAc,EAAE,UAAU,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1E,SAAS,CAAC,UAAU,GAAG,QAAQ,CAAC;QAClC,CAAC;QACD,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC,4BAA4B,CAAC;QACzD,IAAI,cAAc,EAAE,gBAAgB,KAAK,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YAClF,SAAS,CAAC,gBAAgB,GAAG,UAAU,CAAC;QAC1C,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAqB;QAC5B,OAAO,EAAE,eAAe;QACxB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,OAAO,EAAE,UAAU;KACpB,CAAC;IAEF,IAAI,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QAClC,GAAG,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;IACzC,CAAC;IAED,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;QACjC,GAAG,CAAC,QAAQ,GAAG,cAAc,CAAC;IAChC,CAAC;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,qBAAqB,CAC5B,OAAyB;IAEzB,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAE3C,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAE1C,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;IACvC,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,4BAA4B,CAAC;IAE7D,MAAM,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;IAC7E,MAAM,iBAAiB,GAAG,OAAO,CAAC,KAAK,CACrC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,4BAA4B,KAAK,UAAU,CAC5D,CAAC;IAEF,IAAI,CAAC,eAAe,IAAI,CAAC,iBAAiB;QAAE,OAAO,SAAS,CAAC;IAE7D,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,IAAI,eAAe,EAAE,CAAC;QACpB,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC;IACjC,CAAC;IACD,IAAI,iBAAiB,EAAE,CAAC;QACtB,QAAQ,CAAC,gBAAgB,GAAG,UAAU,CAAC;IACzC,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/dist/formats/campaign-format.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=campaign-format.test.d.ts.map

package/dist/formats/campaign-format.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaign-format.test.d.ts","sourceRoot":"","sources":["../../src/formats/campaign-format.test.ts"],"names":[],"mappings":""}

package/dist/formats/campaign-format.test.js

@@ -0,0 +1,442 @@
+// SPDX-License-Identifier: AGPL-3.0-only
+// Copyright (C) 2026 Oleksii PELYKH
+import { describe, expect, it } from "vitest";
+import { CampaignFormatError, parseCampaignJson, parseCampaignYaml, serializeCampaignJson, serializeCampaignYaml, } from "./campaign-format.js";
+const MINIMAL_YAML = `
+version: "1"
+name: "Test Campaign"
+actions:
+  - type: VisitAndExtract
+`;
+const FULL_YAML = `
+version: "1"
+name: "Outreach Campaign"
+description: "A test campaign"
+settings:
+  cooldownMs: 30000
+  maxActionsPerRun: 5
+actions:
+  - type: VisitAndExtract
+    config:
+      extractCurrentOrganizations: true
+  - type: MessageToPerson
+    config:
+      messageTemplate: "Hi {firstName}"
+`;
+const MOCK_CAMPAIGN = {
+    id: 1,
+    name: "Test Campaign",
+    description: "Test description",
+    state: "paused",
+    liAccountId: 1,
+    isPaused: true,
+    isArchived: false,
+    isValid: true,
+    createdAt: "2025-01-15T00:00:00Z",
+};
+const MOCK_ACTIONS = [
+    {
+        id: 10,
+        campaignId: 1,
+        name: "Visit & Extract",
+        description: null,
+        config: {
+            id: 100,
+            actionType: "VisitAndExtract",
+            actionSettings: { extractCurrentOrganizations: true },
+            coolDown: 60000,
+            maxActionResultsPerIteration: 10,
+            isDraft: false,
+        },
+        versionId: 1000,
+    },
+    {
+        id: 11,
+        campaignId: 1,
+        name: "Message",
+        description: null,
+        config: {
+            id: 101,
+            actionType: "MessageToPerson",
+            actionSettings: { messageTemplate: "Hi {firstName}" },
+            coolDown: 60000,
+            maxActionResultsPerIteration: 10,
+            isDraft: false,
+        },
+        versionId: 1001,
+    },
+];
+describe("parseCampaignYaml", () => {
+    it("parses minimal valid YAML", () => {
+        const config = parseCampaignYaml(MINIMAL_YAML);
+        expect(config.name).toBe("Test Campaign");
+        expect(config.description).toBeUndefined();
+        expect(config.actions).toHaveLength(1);
+        expect(config.actions[0]?.actionType).toBe("VisitAndExtract");
+    });
+    it("parses full YAML with settings and description", () => {
+        const config = parseCampaignYaml(FULL_YAML);
+        expect(config.name).toBe("Outreach Campaign");
+        expect(config.description).toBe("A test campaign");
+        expect(config.actions).toHaveLength(2);
+        expect(config.actions[0]?.actionType).toBe("VisitAndExtract");
+        expect(config.actions[0]?.actionSettings).toEqual({ extractCurrentOrganizations: true });
+        expect(config.actions[1]?.actionType).toBe("MessageToPerson");
+        expect(config.actions[1]?.actionSettings).toEqual({
+            messageTemplate: "Hi {firstName}",
+        });
+    });
+    it("applies campaign-level settings as action defaults", () => {
+        const config = parseCampaignYaml(FULL_YAML);
+        expect(config.actions[0]?.coolDown).toBe(30000);
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBe(5);
+        expect(config.actions[1]?.coolDown).toBe(30000);
+        expect(config.actions[1]?.maxActionResultsPerIteration).toBe(5);
+    });
+    it("allows per-action overrides of settings", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+settings:
+  cooldownMs: 30000
+  maxActionsPerRun: 5
+actions:
+  - type: VisitAndExtract
+    cooldownMs: 10000
+    maxActionsPerRun: 20
+`;
+        const config = parseCampaignYaml(yaml);
+        expect(config.actions[0]?.coolDown).toBe(10000);
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBe(20);
+    });
+    it("derives action name from type", () => {
+        const config = parseCampaignYaml(MINIMAL_YAML);
+        expect(config.actions[0]?.name).toBe("VisitAndExtract");
+    });
+    it("does not set coolDown/maxActionResultsPerIteration when no settings", () => {
+        const config = parseCampaignYaml(MINIMAL_YAML);
+        expect(config.actions[0]?.coolDown).toBeUndefined();
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBeUndefined();
+    });
+    it("throws CampaignFormatError for missing version", () => {
+        const yaml = `
+name: "Test"
+actions:
+  - type: VisitAndExtract
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Missing required field: version");
+    });
+    it("throws CampaignFormatError for wrong version", () => {
+        const yaml = `
+version: "2"
+name: "Test"
+actions:
+  - type: VisitAndExtract
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Unsupported version: 2");
+    });
+    it("throws CampaignFormatError for missing name", () => {
+        const yaml = `
+version: "1"
+actions:
+  - type: VisitAndExtract
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Missing or empty required field: name");
+    });
+    it("throws CampaignFormatError for empty name", () => {
+        const yaml = `
+version: "1"
+name: ""
+actions:
+  - type: VisitAndExtract
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Missing or empty required field: name");
+    });
+    it("throws CampaignFormatError for missing actions", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Missing required field: actions");
+    });
+    it("throws CampaignFormatError for non-array actions", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+actions: "visit"
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Invalid field: actions must be an array");
+    });
+    it("throws CampaignFormatError for non-object settings", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+settings: "fast"
+actions:
+  - type: VisitAndExtract
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Invalid field: settings must be an object");
+    });
+    it("throws CampaignFormatError for array settings", () => {
+        const json = JSON.stringify({
+            version: "1",
+            name: "Test",
+            settings: [1, 2, 3],
+            actions: [{ type: "VisitAndExtract" }],
+        });
+        expect(() => parseCampaignJson(json)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignJson(json)).toThrow("Invalid field: settings must be an object");
+    });
+    it("ignores non-numeric cooldownMs in settings", () => {
+        const json = JSON.stringify({
+            version: "1",
+            name: "Test",
+            settings: { cooldownMs: null, maxActionsPerRun: 5 },
+            actions: [{ type: "VisitAndExtract" }],
+        });
+        const config = parseCampaignJson(json);
+        expect(config.actions[0]?.coolDown).toBeUndefined();
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBe(5);
+    });
+    it("ignores NaN and Infinity in settings via YAML", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+settings:
+  cooldownMs: .nan
+  maxActionsPerRun: .inf
+actions:
+  - type: VisitAndExtract
+`;
+        const config = parseCampaignYaml(yaml);
+        expect(config.actions[0]?.coolDown).toBeUndefined();
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBeUndefined();
+    });
+    it("ignores array config in actions", () => {
+        const json = JSON.stringify({
+            version: "1",
+            name: "Test",
+            actions: [{ type: "VisitAndExtract", config: [1, 2, 3] }],
+        });
+        const config = parseCampaignJson(json);
+        expect(config.actions[0]?.actionSettings).toBeUndefined();
+    });
+    it("throws CampaignFormatError for empty actions array", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+actions: []
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Actions array must not be empty");
+    });
+    it("throws CampaignFormatError for action without type", () => {
+        const yaml = `
+version: "1"
+name: "Test"
+actions:
+  - config:
+      extractCurrentOrganizations: true
+`;
+        expect(() => parseCampaignYaml(yaml)).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml(yaml)).toThrow("Action at index 0 is missing required field: type");
+    });
+    it("throws CampaignFormatError for invalid YAML syntax", () => {
+        expect(() => parseCampaignYaml("{{invalid")).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml("{{invalid")).toThrow("Invalid YAML");
+    });
+    it("throws CampaignFormatError for non-object document", () => {
+        expect(() => parseCampaignYaml("just a string")).toThrow(CampaignFormatError);
+        expect(() => parseCampaignYaml("just a string")).toThrow("Campaign document must be an object");
+    });
+});
+describe("parseCampaignJson", () => {
+    it("parses valid JSON", () => {
+        const json = JSON.stringify({
+            version: "1",
+            name: "Test Campaign",
+            actions: [{ type: "VisitAndExtract" }],
+        });
+        const config = parseCampaignJson(json);
+        expect(config.name).toBe("Test Campaign");
+        expect(config.actions).toHaveLength(1);
+        expect(config.actions[0]?.actionType).toBe("VisitAndExtract");
+    });
+    it("throws CampaignFormatError for invalid JSON syntax", () => {
+        expect(() => parseCampaignJson("{invalid}")).toThrow(CampaignFormatError);
+        expect(() => parseCampaignJson("{invalid}")).toThrow("Invalid JSON");
+    });
+    it("throws CampaignFormatError for invalid document structure", () => {
+        expect(() => parseCampaignJson('"just a string"')).toThrow(CampaignFormatError);
+    });
+});
+describe("serializeCampaignYaml", () => {
+    it("serializes campaign with uniform settings to campaign-level", () => {
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        expect(yaml).toContain("version:");
+        expect(yaml).toContain('name: Test Campaign');
+        expect(yaml).toContain("description: Test description");
+        expect(yaml).toContain("cooldownMs: 60000");
+        expect(yaml).toContain("maxActionsPerRun: 10");
+        expect(yaml).toContain("type: VisitAndExtract");
+        expect(yaml).toContain("type: MessageToPerson");
+    });
+    it("serializes campaign with varied settings as per-action overrides", () => {
+        const action0 = MOCK_ACTIONS[0];
+        const action1 = MOCK_ACTIONS[1];
+        const variedActions = [
+            {
+                ...action0,
+                config: { ...action0.config, coolDown: 30000 },
+            },
+            {
+                ...action1,
+                config: { ...action1.config, coolDown: 60000 },
+            },
+        ];
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, variedActions);
+        // cooldownMs should NOT be at campaign-level settings since they differ
+        // but maxActionsPerRun is still uniform so should be in settings
+        expect(yaml).toContain("maxActionsPerRun: 10");
+        // per-action cooldownMs should be present
+        expect(yaml).toContain("cooldownMs: 30000");
+        expect(yaml).toContain("cooldownMs: 60000");
+    });
+    it("includes description when non-null", () => {
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        expect(yaml).toContain("description: Test description");
+    });
+    it("omits description when null", () => {
+        const campaign = { ...MOCK_CAMPAIGN, description: null };
+        const yaml = serializeCampaignYaml(campaign, MOCK_ACTIONS);
+        expect(yaml).not.toContain("description:");
+    });
+    it("omits empty actionSettings from config", () => {
+        const action0 = MOCK_ACTIONS[0];
+        const actions = [
+            {
+                ...action0,
+                config: { ...action0.config, actionSettings: {} },
+            },
+        ];
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, actions);
+        expect(yaml).not.toContain("config:");
+    });
+    it("includes non-empty actionSettings as config", () => {
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        expect(yaml).toContain("extractCurrentOrganizations: true");
+        expect(yaml).toContain("messageTemplate:");
+    });
+});
+describe("serializeCampaignJson", () => {
+    it("serializes to pretty-printed JSON", () => {
+        const json = serializeCampaignJson(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        expect(() => JSON.parse(json)).not.toThrow();
+        const doc = JSON.parse(json);
+        expect(doc["version"]).toBe("1");
+        expect(doc["name"]).toBe("Test Campaign");
+    });
+    it("produces valid JSON that round-trips through parseCampaignJson", () => {
+        const json = serializeCampaignJson(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        const config = parseCampaignJson(json);
+        expect(config.name).toBe("Test Campaign");
+        expect(config.description).toBe("Test description");
+        expect(config.actions).toHaveLength(2);
+        expect(config.actions[0]?.actionType).toBe("VisitAndExtract");
+        expect(config.actions[1]?.actionType).toBe("MessageToPerson");
+    });
+});
+describe("round-trip", () => {
+    it("YAML: serialize → parse preserves campaign data", () => {
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        const config = parseCampaignYaml(yaml);
+        expect(config.name).toBe("Test Campaign");
+        expect(config.description).toBe("Test description");
+        expect(config.actions).toHaveLength(2);
+        expect(config.actions[0]?.actionType).toBe("VisitAndExtract");
+        expect(config.actions[0]?.actionSettings).toEqual({ extractCurrentOrganizations: true });
+        expect(config.actions[0]?.coolDown).toBe(60000);
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBe(10);
+        expect(config.actions[1]?.actionType).toBe("MessageToPerson");
+        expect(config.actions[1]?.actionSettings).toEqual({
+            messageTemplate: "Hi {firstName}",
+        });
+    });
+    it("JSON: serialize → parse preserves campaign data", () => {
+        const json = serializeCampaignJson(MOCK_CAMPAIGN, MOCK_ACTIONS);
+        const config = parseCampaignJson(json);
+        expect(config.name).toBe("Test Campaign");
+        expect(config.description).toBe("Test description");
+        expect(config.actions).toHaveLength(2);
+        expect(config.actions[0]?.actionType).toBe("VisitAndExtract");
+        expect(config.actions[0]?.actionSettings).toEqual({ extractCurrentOrganizations: true });
+        expect(config.actions[1]?.actionType).toBe("MessageToPerson");
+    });
+    it("YAML: serialize → parse preserves varied per-action settings", () => {
+        const action0 = MOCK_ACTIONS[0];
+        const action1 = MOCK_ACTIONS[1];
+        const variedActions = [
+            {
+                ...action0,
+                config: { ...action0.config, coolDown: 30000, maxActionResultsPerIteration: 5 },
+            },
+            {
+                ...action1,
+                config: { ...action1.config, coolDown: 60000, maxActionResultsPerIteration: 20 },
+            },
+        ];
+        const yaml = serializeCampaignYaml(MOCK_CAMPAIGN, variedActions);
+        const config = parseCampaignYaml(yaml);
+        expect(config.actions[0]?.coolDown).toBe(30000);
+        expect(config.actions[0]?.maxActionResultsPerIteration).toBe(5);
+        expect(config.actions[1]?.coolDown).toBe(60000);
+        expect(config.actions[1]?.maxActionResultsPerIteration).toBe(20);
+    });
+    it("parse → serialize → parse produces identical config", () => {
+        const config1 = parseCampaignYaml(FULL_YAML);
+        // Create a mock campaign and actions from parsed config to simulate DB state
+        const campaign = {
+            id: 1,
+            name: config1.name,
+            description: config1.description ?? null,
+            state: "active",
+            liAccountId: 1,
+            isPaused: false,
+            isArchived: false,
+            isValid: true,
+            createdAt: "2025-01-15T00:00:00Z",
+        };
+        const actions = config1.actions.map((a, i) => ({
+            id: i + 1,
+            campaignId: 1,
+            name: a.name,
+            description: null,
+            config: {
+                id: i + 100,
+                actionType: a.actionType,
+                actionSettings: a.actionSettings ?? {},
+                coolDown: a.coolDown ?? 60000,
+                maxActionResultsPerIteration: a.maxActionResultsPerIteration ?? 10,
+                isDraft: false,
+            },
+            versionId: i + 1000,
+        }));
+        const yaml = serializeCampaignYaml(campaign, actions);
+        const config2 = parseCampaignYaml(yaml);
+        expect(config2.name).toBe(config1.name);
+        expect(config2.description).toBe(config1.description);
+        expect(config2.actions).toHaveLength(config1.actions.length);
+        for (let i = 0; i < config1.actions.length; i++) {
+            expect(config2.actions[i]?.actionType).toBe(config1.actions[i]?.actionType);
+            expect(config2.actions[i]?.actionSettings).toEqual(config1.actions[i]?.actionSettings);
+        }
+    });
+});
+//# sourceMappingURL=campaign-format.test.js.map