@advertising-chat/mcp 0.2.1 → 0.17.3

package/bin/tools/attributes.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.attributeTools = exports.deleteAttribute = exports.updateAttribute = exports.documentAttribute = exports.addAttribute = exports.getAttribute = exports.listAttributes = void 0;
+exports.attributeRow = attributeRow;
+/**
+ * The attribute catalog: the vocabulary rules are written in. Each agent
+ * has its own catalog; a rule can use only attributes in its agent's
+ * catalog. The agent platform registers types; marketers document what an
+ * attribute means (`document_attribute`). Input schemas come from
+ * `@advertising-chat/offer-rules`, the package the server validates with.
+ */
+const offer_rules_1 = require("@advertising-chat/offer-rules");
+const zod_1 = require("zod");
+const tool_1 = require("../tool");
+const shared_1 = require("./shared");
+const A = offer_rules_1.AttributeCreate.shape;
+const U = offer_rules_1.AttributeUpdate.shape;
+const CATALOG = 'https://docs.advertising.chat/reference/catalog/';
+const fields = {
+    key: A.key.describe('The attribute key exactly as the agent sends it on fetch requests, e.g. `data_limit_streak_months`. Unique within the agent.'),
+    type: A.type.describe('string, number, boolean, date, enum, or list. It decides how values are read and which operators a condition can use; enum needs `values`.'),
+    label: A.label.describe('What marketers call it, e.g. "Months at data limit in a row".'),
+    description: A.description.describe('What it means and how it is computed, for people and for the Assistant.'),
+    values: A.values.describe('For enum only: the allowed values, as { value, label? }.'),
+    examples: A.examples.describe('Up to 10 sample values.'),
+    source: A.source.describe('Who supplies it: agent (default), context_layer, or data_feed.'),
+};
+/** `the customer detail “Plan” (plan)`, from an entry or an input. */
+function attrName(e) {
+    const label = typeof e.label === 'string' && e.label ? e.label : undefined;
+    const key = typeof e.key === 'string' && e.key ? e.key : undefined;
+    if (label)
+        return `the customer detail ${(0, shared_1.quoted)(label, '')}`;
+    if (key)
+        return `the customer detail “${key}”`;
+    return 'this customer detail';
+}
+/** A catalog entry as the list shows it. */
+function attributeRow(e) {
+    return {
+        id: (0, shared_1.str)(e._id) ?? (0, shared_1.str)(e.id),
+        key: e.key,
+        type: e.type,
+        label: e.label,
+        status: e.status,
+        values: Array.isArray(e.values)
+            ? e.values.map((v) => v.value)
+            : undefined,
+        coverage: typeof e.coverage === 'number' ? e.coverage : undefined,
+        lastSeenAt: e.lastSeenAt,
+    };
+}
+exports.listAttributes = (0, tool_1.defineTool)({
+    name: 'list_attributes',
+    title: 'List an agent’s attributes',
+    description: `The attribute catalog of one agent: the attributes it sends on fetch requests (or will), with key, type, label, enum values, status (observed: seen but undescribed; documented; retired), coverage (share of the agent's requests in the last 7 days that carry it, 0 to 1), and lastSeenAt. A rule can only use attributes in its agent's catalog, with operators that fit their type; check here before writing an audience or exclusions condition. Reference: ${CATALOG} Maps to GET /system/offer-manager/attributes.`,
+    kind: 'read',
+    roleFloor: 'viewer',
+    capability: 'offer-manager',
+    input: {
+        application: shared_1.application,
+        status: zod_1.z
+            .enum(['observed', 'documented', 'retired'])
+            .optional()
+            .describe('Only entries with this status.'),
+    },
+    async run({ client }, args) {
+        const body = await client.get(`${shared_1.OM}/attributes`, (0, shared_1.defined)(args));
+        return (Array.isArray(body) ? body : []).map(attributeRow);
+    },
+});
+exports.getAttribute = (0, tool_1.defineTool)({
+    name: 'get_attribute',
+    title: 'Get an attribute',
+    description: 'One catalog entry with every field, including its description, examples, coverage per moment, who wrote each field (writtenBy: observed, platform, marketer), and the rules whose conditions use it (rulesUsing). Maps to GET /system/offer-manager/attributes/{id}.',
+    kind: 'read',
+    roleFloor: 'viewer',
+    capability: 'offer-manager',
+    input: { id: (0, shared_1.id)('attribute') },
+    async run({ client }, { id: attributeId }) {
+        return client.get(`${shared_1.OM}/attributes/${(0, shared_1.enc)(attributeId)}`);
+    },
+});
+exports.addAttribute = (0, tool_1.defineTool)({
+    name: 'add_attribute',
+    title: 'Add an attribute',
+    description: 'Add an attribute to an agent’s catalog, before or after the agent starts sending it, so rules can use it. The entry is documented. Until the agent sends it, a rule on it matches no one; say so, and say what the agent’s team must send. A key the catalog already has is refused (409); use document_attribute or update_attribute on that entry instead. Maps to POST /system/offer-manager/attributes.',
+    kind: 'write',
+    roleFloor: 'editor',
+    capability: 'offer-manager',
+    input: { application: shared_1.application, ...fields },
+    approval: args => `Add ${(0, shared_1.quoted)(args.label ?? args.key, 'a detail')} to this agent’s customer details, so offers can use it to choose who sees them. An audience that uses it reaches no one until the agent sends “${args.key}”.`,
+    async run({ client }, args) {
+        const parsed = offer_rules_1.AttributeCreate.safeParse((0, shared_1.defined)(args));
+        if (!parsed.success) {
+            throw new shared_1.ToolInputError(`The attribute is not valid:\n${(0, shared_1.issues)(parsed.error)}`);
+        }
+        return client.post(`${shared_1.OM}/attributes`, parsed.data);
+    },
+});
+const nullable = (s, what) => s.describe(`${what} Pass null to clear yours; the agent platform’s value, if it registered one, shows again.`);
+exports.documentAttribute = (0, tool_1.defineTool)({
+    name: 'document_attribute',
+    title: 'Document an attribute',
+    description: 'Write the marketer’s words on a catalog entry: its label, description, and examples. They are shown over what the agent platform registered, and they are what the console, rule cards, and translations call the attribute. Documenting an observed entry makes it documented. To change how values are read (type, enum values) or retire it, use update_attribute. Maps to PATCH /system/offer-manager/attributes/{id}.',
+    kind: 'write',
+    roleFloor: 'editor',
+    reader: 'get_attribute',
+    capability: 'offer-manager',
+    input: {
+        id: (0, shared_1.id)('attribute'),
+        label: nullable(U.label, 'What marketers call it, e.g. "Months at data limit in a row".'),
+        description: nullable(U.description, 'What it means and how it is computed, for people and for the Assistant.'),
+        examples: nullable(U.examples, 'Up to 10 sample values.'),
+    },
+    approval: (args, before) => {
+        const what = ['label', 'description', 'examples']
+            .filter(k => args[k] !== undefined)
+            .map(k => (k === 'label' ? 'name' : k));
+        const label = typeof args.label === 'string' && args.label !== before?.label
+            ? ` It will be called ${(0, shared_1.quoted)(args.label, '')}.`
+            : '';
+        return `Update the ${(0, shared_1.listWords)(what) || 'description'} of ${attrName(before ?? args)}.${label}`;
+    },
+    async run({ client }, args) {
+        const body = (0, shared_1.patchBody)(args);
+        const parsed = offer_rules_1.AttributeUpdate.safeParse(body);
+        if (!parsed.success) {
+            throw new shared_1.ToolInputError(`The change is not valid:\n${(0, shared_1.issues)(parsed.error)}`);
+        }
+        return client.patch(`${shared_1.OM}/attributes/${(0, shared_1.enc)(args.id)}`, parsed.data);
+    },
+});
+exports.updateAttribute = (0, tool_1.defineTool)({
+    name: 'update_attribute',
+    title: 'Update an attribute',
+    description: 'Change how a catalog entry is read: its type, enum values (null clears them), or source, or its status (documented, or retired so rules can no longer use it). For the label, description, or examples, use document_attribute. A type the agent platform registered cannot change, and a change that would break a saved rule is refused (409, naming the rules). Retiring is allowed while rules use it: get_attribute and the answer list them in rulesUsing; they keep serving as saved, but cannot be saved again until the condition is removed, so name them to the user before retiring. Maps to PATCH /system/offer-manager/attributes/{id}.',
+    kind: 'write',
+    roleFloor: 'editor',
+    reader: 'get_attribute',
+    capability: 'offer-manager',
+    input: {
+        id: (0, shared_1.id)('attribute'),
+        type: U.type.describe(fields.type.description ?? ''),
+        values: U.values.describe('For enum only: the allowed values, as { value, label? }. null clears them.'),
+        source: U.source.describe(fields.source.description ?? ''),
+        status: U.status.describe('documented, or retired: rules can no longer use it.'),
+    },
+    approval: (args, before) => {
+        const name = attrName(before ?? args);
+        const using = Array.isArray(before?.rulesUsing)
+            ? before.rulesUsing.length
+            : 0;
+        if (args.status === 'retired')
+            return `Retire ${name}: offers can no longer start using it.${using
+                ? ` ${using === 1 ? 'One audience uses it; it keeps' : `${using} audiences use it; they keep`} working as saved, but cannot be saved again until the detail is removed from ${using === 1 ? 'it' : 'them'}.`
+                : ''}`;
+        const what = [];
+        if (args.type !== undefined)
+            what.push('how its values are read');
+        if (args.values !== undefined)
+            what.push('its allowed values');
+        if (args.source !== undefined)
+            what.push('who supplies it');
+        if (args.status === 'documented')
+            what.push('its status, to documented');
+        return `Change ${(0, shared_1.listWords)(what) || 'the settings'} of ${name}.`;
+    },
+    async run({ client }, args) {
+        const body = (0, shared_1.patchBody)(args);
+        const parsed = offer_rules_1.AttributeUpdate.safeParse(body);
+        if (!parsed.success) {
+            throw new shared_1.ToolInputError(`The change is not valid:\n${(0, shared_1.issues)(parsed.error)}`);
+        }
+        return client.patch(`${shared_1.OM}/attributes/${(0, shared_1.enc)(args.id)}`, parsed.data);
+    },
+});
+exports.deleteAttribute = (0, tool_1.defineTool)({
+    name: 'delete_attribute',
+    title: 'Delete an attribute',
+    description: 'Remove an entry from an agent’s catalog. Refused (409) while a rule uses it; the error names those rules. Prefer retiring it with update_attribute. If the agent still sends the key, it returns as observed. Maps to DELETE /system/offer-manager/attributes/{id}.',
+    kind: 'destructive',
+    roleFloor: 'editor',
+    reader: 'get_attribute',
+    capability: 'offer-manager',
+    input: { id: (0, shared_1.id)('attribute') },
+    approval: (_args, before) => `Remove ${attrName(before ?? {})} from this agent’s customer details. If the agent still sends it, it comes back as seen but not described.`,
+    async run({ client }, { id: attributeId }) {
+        return client.delete(`${shared_1.OM}/attributes/${(0, shared_1.enc)(attributeId)}`);
+    },
+});
+exports.attributeTools = [
+    exports.listAttributes,
+    exports.getAttribute,
+    exports.addAttribute,
+    exports.documentAttribute,
+    exports.updateAttribute,
+    exports.deleteAttribute,
+];
+//# sourceMappingURL=attributes.js.map

package/bin/tools/attributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"attributes.js","sourceRoot":"","sources":["../../src/tools/attributes.ts"],"names":[],"mappings":";;;AAiEA,oCAaC;AA9ED;;;;;;GAMG;AACH,+DAGuC;AACvC,6BAAwB;AACxB,kCAAqC;AACrC,qCAakB;AAElB,MAAM,CAAC,GAAG,6BAAe,CAAC,KAAK,CAAC;AAChC,MAAM,CAAC,GAAG,6BAAe,CAAC,KAAK,CAAC;AAEhC,MAAM,OAAO,GAAG,kDAAkD,CAAC;AAEnE,MAAM,MAAM,GAAG;IACb,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CACjB,8HAA8H,CAC/H;IACD,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CACnB,4IAA4I,CAC7I;IACD,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CACrB,+DAA+D,CAChE;IACD,WAAW,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,CACjC,yEAAyE,CAC1E;IACD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CACvB,0DAA0D,CAC3D;IACD,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,yBAAyB,CAAC;IACxD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CACvB,gEAAgE,CACjE;CACF,CAAC;AAEF,sEAAsE;AACtE,SAAS,QAAQ,CAAC,CAAM;IACtB,MAAM,KAAK,GAAG,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,MAAM,GAAG,GAAG,OAAO,CAAC,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACnE,IAAI,KAAK;QAAE,OAAO,uBAAuB,IAAA,eAAM,EAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;IAC7D,IAAI,GAAG;QAAE,OAAO,wBAAwB,GAAG,GAAG,CAAC;IAC/C,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAED,4CAA4C;AAC5C,SAAgB,YAAY,CAAC,CAAM;IACjC,OAAO;QACL,EAAE,EAAE,IAAA,YAAG,EAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAA,YAAG,EAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,GAAG,EAAE,CAAC,CAAC,GAAG;QACV,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,MAAM,EAAE,CAAC,CAAC,MAAM;QAChB,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC;YAC7B,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;YACnC,CAAC,CAAC,SAAS;QACb,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;QACjE,UAAU,EAAE,CAAC,CAAC,UAAU;KACzB,CAAC;AACJ,CAAC;AAEY,QAAA,cAAc,GAAG,IAAA,iBAAU,EAAC;IACvC,IAAI,EAAE,iBAAiB;IACvB,KAAK,EAAE,4BAA4B;IACnC,WAAW,EAAE,scAAsc,OAAO,gDAAgD;IAC1gB,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,eAAe;IAC3B,KAAK,EAAE;QACL,WAAW,EAAX,oBAAW;QACX,MAAM,EAAE,OAAC;aACN,IAAI,CAAC,CAAC,UAAU,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;aAC3C,QAAQ,EAAE;aACV,QAAQ,CAAC,gCAAgC,CAAC;KAC9C;IACD,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,WAAE,aAAa,EAAE,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;QACjE,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IAC7D,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,YAAY,GAAG,IAAA,iBAAU,EAAC;IACrC,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,sQAAsQ;IACxQ,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,eAAe;IAC3B,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,WAAE,EAAC,WAAW,CAAC,EAAE;IAC9B,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;QACvC,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,WAAE,eAAe,IAAA,YAAG,EAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,YAAY,GAAG,IAAA,iBAAU,EAAC;IACrC,IAAI,EAAE,eAAe;IACrB,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,6YAA6Y;IAC/Y,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,eAAe;IAC3B,KAAK,EAAE,EAAE,WAAW,EAAX,oBAAW,EAAE,GAAG,MAAM,EAAE;IACjC,QAAQ,EAAE,IAAI,CAAC,EAAE,CACf,OAAO,IAAA,eAAM,EAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,mJAAmJ,IAAI,CAAC,GAAG,IAAI;IAClN,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,MAAM,MAAM,GAAG,6BAAe,CAAC,SAAS,CAAC,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,uBAAc,CACtB,gCAAgC,IAAA,eAAM,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACvD,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,WAAE,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,QAAQ,GAAG,CAAC,CAAe,EAAE,IAAY,EAAE,EAAE,CACjD,CAAC,CAAC,QAAQ,CACR,GAAG,IAAI,2FAA2F,CACnG,CAAC;AAES,QAAA,iBAAiB,GAAG,IAAA,iBAAU,EAAC;IAC1C,IAAI,EAAE,oBAAoB;IAC1B,KAAK,EAAE,uBAAuB;IAC9B,WAAW,EACT,4ZAA4Z;IAC9Z,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,MAAM,EAAE,eAAe;IACvB,UAAU,EAAE,eAAe;IAC3B,KAAK,EAAE;QACL,EAAE,EAAE,IAAA,WAAE,EAAC,WAAW,CAAC;QACnB,KAAK,EAAE,QAAQ,CACb,CAAC,CAAC,KAAK,EACP,+DAA+D,CAChE;QACD,WAAW,EAAE,QAAQ,CACnB,CAAC,CAAC,WAAW,EACb,yEAAyE,CAC1E;QACD,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE,yBAAyB,CAAC;KAC1D;IACD,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QACzB,MAAM,IAAI,GAAI,CAAC,OAAO,EAAE,aAAa,EAAE,UAAU,CAAW;aACzD,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;aAClC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,MAAM,KAAK,GACT,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,EAAE,KAAK;YAC5D,CAAC,CAAC,sBAAsB,IAAA,eAAM,EAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG;YACjD,CAAC,CAAC,EAAE,CAAC;QACT,OAAO,cAAc,IAAA,kBAAS,EAAC,IAAI,CAAC,IAAI,aAAa,OAAO,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC;IAClG,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,MAAM,IAAI,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,6BAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,uBAAc,CACtB,6BAA6B,IAAA,eAAM,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpD,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,WAAE,eAAe,IAAA,YAAG,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,eAAe,GAAG,IAAA,iBAAU,EAAC;IACxC,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,qBAAqB;IAC5B,WAAW,EACT,unBAAunB;IACznB,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,MAAM,EAAE,eAAe;IACvB,UAAU,EAAE,eAAe;IAC3B,KAAK,EAAE;QACL,EAAE,EAAE,IAAA,WAAE,EAAC,WAAW,CAAC;QACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;QACpD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CACvB,4EAA4E,CAC7E;QACD,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC;QAC1D,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CACvB,qDAAqD,CACtD;KACF;IACD,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,UAAU,CAAC;YAC7C,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM;YAC1B,CAAC,CAAC,CAAC,CAAC;QACN,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAC3B,OAAO,UAAU,IAAI,yCACnB,KAAK;gBACH,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,gCAAgC,CAAC,CAAC,CAAC,GAAG,KAAK,8BAA8B,iFAAiF,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,GAAG;gBAC5M,CAAC,CAAC,EACN,EAAE,CAAC;QACL,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAClE,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC/D,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,MAAM,KAAK,YAAY;YAAE,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QACzE,OAAO,UAAU,IAAA,kBAAS,EAAC,IAAI,CAAC,IAAI,cAAc,OAAO,IAAI,GAAG,CAAC;IACnE,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,MAAM,IAAI,GAAG,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,6BAAe,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,MAAM,IAAI,uBAAc,CACtB,6BAA6B,IAAA,eAAM,EAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CACpD,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,GAAG,WAAE,eAAe,IAAA,YAAG,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IACvE,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,eAAe,GAAG,IAAA,iBAAU,EAAC;IACxC,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,qBAAqB;IAC5B,WAAW,EACT,qQAAqQ;IACvQ,IAAI,EAAE,aAAa;IACnB,SAAS,EAAE,QAAQ;IACnB,MAAM,EAAE,eAAe;IACvB,UAAU,EAAE,eAAe;IAC3B,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,WAAE,EAAC,WAAW,CAAC,EAAE;IAC9B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAC1B,UAAU,QAAQ,CAAC,MAAM,IAAI,EAAE,CAAC,4GAA4G;IAC9I,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,WAAW,EAAE;QACvC,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,WAAE,eAAe,IAAA,YAAG,EAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAC/D,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG;IAC5B,sBAAc;IACd,oBAAY;IACZ,oBAAY;IACZ,yBAAiB;IACjB,uBAAe;IACf,uBAAe;CAChB,CAAC"}

package/bin/tools/campaigns.d.ts

@@ -0,0 +1,12 @@
+import { Doc } from './shared';
+/** What each campaign state means, for the model to relay. */
+export declare const CAMPAIGN_STATES: Record<string, string>;
+/** A campaign as the list shows it. */
+export declare function campaignRow(c: Doc): Doc;
+export declare const listCampaigns: import("../tool").AnyTool;
+export declare const getCampaign: import("../tool").AnyTool;
+export declare const requestCampaign: import("../tool").AnyTool;
+export declare const pauseCampaign: import("../tool").AnyTool;
+export declare const resumeCampaign: import("../tool").AnyTool;
+export declare const resubmitCampaign: import("../tool").AnyTool;
+export declare const campaignTools: import("../tool").AnyTool[];

package/bin/tools/campaigns.js

@@ -0,0 +1,230 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.campaignTools = exports.resubmitCampaign = exports.resumeCampaign = exports.pauseCampaign = exports.requestCampaign = exports.getCampaign = exports.listCampaigns = exports.CAMPAIGN_STATES = void 0;
+exports.campaignRow = campaignRow;
+/**
+ * Campaigns (Conversation Ads): paid traffic that starts conversations with
+ * one of the workspace's agents. A campaign is a request our team reviews.
+ * These tools do what the brand does in the console: read campaigns,
+ * request one, pause and resume it, and change and resubmit one our team
+ * rejected. A campaign's ads, other changes, and deleting it stay in the
+ * console. `/system/campaigns/campaign` needs the `advertise` capability.
+ */
+const zod_1 = require("zod");
+const tool_1 = require("../tool");
+const shared_1 = require("./shared");
+const CAMPAIGN = '/campaigns/campaign';
+/** What each campaign state means, for the model to relay. */
+exports.CAMPAIGN_STATES = {
+    pending: 'Submitted and waiting for our team’s review.',
+    active: 'Approved; serves within its dates.',
+    paused: 'Paused by the brand; resume_campaign makes it active again.',
+    rejected: 'Our team declined it; rejectionReason says why. resubmit_campaign changes what the review asks for and sends it back to review.',
+    ended: 'Its end date has passed.',
+    removed: 'Taken down; it does not return.',
+};
+/** A campaign as the list shows it. */
+function campaignRow(c) {
+    return {
+        id: (0, shared_1.str)(c._id) ?? (0, shared_1.str)(c.id),
+        name: c.name,
+        agent: (0, shared_1.refId)(c.application),
+        goal: c.goal,
+        state: c.state,
+        rejectionReason: (0, shared_1.str)(c.rejectionReason),
+        startDate: c.startDate,
+        endDate: c.endDate,
+        dailyBudget: c.dailyBudget,
+    };
+}
+exports.listCampaigns = (0, tool_1.defineTool)({
+    name: 'list_campaigns',
+    title: 'List campaigns',
+    description: `The workspace’s campaigns: id, name, the agent conversations start with, goal (conversations, leads, or sales), state, the reason when our team rejected it, dates, and daily budget. startDate and endDate are whole days in the workspace’s time zone: read only the date part (2026-11-30T00:00:00.000Z is November 30), and a campaign runs from the start of its start date through the end of its end date there; no end date means it runs until the brand pauses it. States: ${Object.entries(exports.CAMPAIGN_STATES)
+        .map(([s, m]) => `${s} (${m})`)
+        .join('; ')} Filter by \`application\` (agent) or \`state\`. Results: get_results with section campaigns. Maps to GET /system/campaigns/campaign.`,
+    kind: 'read',
+    roleFloor: 'viewer',
+    capability: 'advertise',
+    input: {
+        application: shared_1.application.optional(),
+        state: zod_1.z
+            .enum(['pending', 'active', 'paused', 'rejected', 'ended', 'removed'])
+            .optional()
+            .describe('Only campaigns in this state.'),
+        ...shared_1.listShape,
+    },
+    async run({ client }, args) {
+        const body = await client.get(CAMPAIGN, (0, shared_1.defined)(args));
+        return (0, shared_1.rows)(body).map(campaignRow);
+    },
+});
+exports.getCampaign = (0, tool_1.defineTool)({
+    name: 'get_campaign',
+    title: 'Get a campaign',
+    description: 'One campaign with every field: the agent, goal, notes for our team, state and rejectionReason, dates (startDate and endDate are whole days in the workspace’s time zone: read only the date part, and the campaign runs through the whole end date there), daily budget, countries and languages (empty means anywhere and any language), and its ads. Maps to GET /system/campaigns/campaign/{id}.',
+    kind: 'read',
+    roleFloor: 'viewer',
+    capability: 'advertise',
+    input: { id: (0, shared_1.id)('campaign') },
+    async run({ client }, { id: campaignId }) {
+        return client.get(`${CAMPAIGN}/${(0, shared_1.enc)(campaignId)}`);
+    },
+});
+// ---------------------------------------------------------------------------
+// Changes: what the brand does in the console, and nothing more.
+const GOALS = ['conversations', 'leads', 'sales'];
+const GOAL = 'What the brand wants from the conversations: conversations (as many people as possible start one), leads (people leave their details), or sales (people buy in the conversation).';
+const goal = zod_1.z.enum(GOALS).describe(GOAL);
+const day = (what) => zod_1.z
+    .string()
+    .regex(/^\d{4}-\d{2}-\d{2}$/, 'A date like 2026-11-01.')
+    .describe(`${what}, as YYYY-MM-DD: a whole day in the workspace’s time zone.`);
+const AGENT = 'The agent (application) people talk to when they tap an ad, from list_applications.';
+const dailyBudget = zod_1.z
+    .number()
+    .positive()
+    .describe('What the brand wants to spend a day, in US dollars.');
+const codes = (what, example, empty) => zod_1.z
+    .array(zod_1.z.string().regex(/^[A-Za-z]{2}$/, `Two-letter ${what} codes.`))
+    .describe(`Two-letter ${what} codes, like ${example}. Empty: ${empty}.`);
+const countries = codes('country', 'US or CA', 'anywhere');
+const languages = codes('language', 'en or es', 'any language');
+const notes = zod_1.z
+    .string()
+    .max(2000)
+    .describe('Notes for our team: who to reach, offers to mention, sites to avoid.');
+/** The words for a campaign request's fields, for approval sentences. */
+const REQUEST_WORDS = {
+    name: 'name',
+    application: 'agent',
+    goal: 'goal',
+    dailyBudget: 'daily budget',
+    startDate: 'dates',
+    endDate: 'dates',
+    countries: 'countries',
+    languages: 'languages',
+    notes: 'notes for our team',
+};
+/** `$50 a day`, or '' without a budget. */
+function budgetWords(budget) {
+    if (typeof budget !== 'number' || !Number.isFinite(budget))
+        return '';
+    const amount = budget.toLocaleString('en-US', {
+        minimumFractionDigits: Number.isInteger(budget) ? 0 : 2,
+        maximumFractionDigits: 2,
+    });
+    return `$${amount} a day`;
+}
+exports.requestCampaign = (0, tool_1.defineTool)({
+    name: 'request_campaign',
+    title: 'Request a campaign',
+    description: 'Send our team a campaign request: the agent people talk to when they tap an ad, the goal, the daily budget, the dates, where and in which languages, and notes for our team. It starts pending; our team reviews it, sets up where the ads run, and approves or rejects it with a reason. Nothing runs until it is approved. The brand adds the campaign’s ads in the console. Maps to POST /system/campaigns/campaign.',
+    kind: 'write',
+    roleFloor: 'editor',
+    capability: 'advertise',
+    input: {
+        name: zod_1.z
+            .string()
+            .min(1)
+            .max(200)
+            .describe('For the brand and our team; customers never see it.'),
+        application: shared_1.application.describe(AGENT),
+        goal: zod_1.z.enum(GOALS).optional().describe(`${GOAL} Default conversations.`),
+        dailyBudget: dailyBudget.optional(),
+        startDate: day('When it starts; default today').optional(),
+        endDate: day('When it ends; omit to run until the brand pauses it').optional(),
+        countries: countries.optional(),
+        languages: languages.optional(),
+        notes: notes.optional(),
+    },
+    approval: args => {
+        const budget = budgetWords(args.dailyBudget);
+        const dates = args.startDate
+            ? args.endDate
+                ? `from ${args.startDate} to ${args.endDate}`
+                : `from ${args.startDate}`
+            : args.endDate
+                ? `until ${args.endDate}`
+                : '';
+        const terms = [budget, dates].filter(Boolean).join(', ');
+        return `Send our team a request for the campaign ${(0, shared_1.quoted)(args.name, '')}${terms ? `, ${terms}` : ''}. Nothing runs until our team approves it.`;
+    },
+    async run({ client }, args) {
+        return client.post(CAMPAIGN, (0, shared_1.defined)(args));
+    },
+});
+exports.pauseCampaign = (0, tool_1.defineTool)({
+    name: 'pause_campaign',
+    title: 'Pause a campaign',
+    description: 'Pause an active campaign: its ads stop showing at once. Undo with resume_campaign. Only an active campaign can be paused (422 otherwise). Returns the campaign with its new state. Maps to POST /system/campaigns/campaign/{id}/pause.',
+    kind: 'write',
+    roleFloor: 'editor',
+    reader: 'get_campaign',
+    capability: 'advertise',
+    input: { id: (0, shared_1.id)('campaign') },
+    approval: (_args, before) => `Pause ${(0, shared_1.named)('campaign', before?.name)}: its ads stop showing at once. You can resume it any time.`,
+    async run({ client }, { id: campaignId }) {
+        return client.post(`${CAMPAIGN}/${(0, shared_1.enc)(campaignId)}/pause`);
+    },
+});
+exports.resumeCampaign = (0, tool_1.defineTool)({
+    name: 'resume_campaign',
+    title: 'Resume a campaign',
+    description: 'Resume a paused campaign: it is active again and its ads show from the next request, within its dates. Only a paused campaign can be resumed (422 otherwise). Returns the campaign with its new state. Maps to POST /system/campaigns/campaign/{id}/resume.',
+    kind: 'write',
+    roleFloor: 'editor',
+    reader: 'get_campaign',
+    capability: 'advertise',
+    input: { id: (0, shared_1.id)('campaign') },
+    approval: (_args, before) => `Resume ${(0, shared_1.named)('campaign', before?.name)}: its ads start showing again from the next request.`,
+    async run({ client }, { id: campaignId }) {
+        return client.post(`${CAMPAIGN}/${(0, shared_1.enc)(campaignId)}/resume`);
+    },
+});
+exports.resubmitCampaign = (0, tool_1.defineTool)({
+    name: 'resubmit_campaign',
+    title: 'Send a campaign for review again',
+    description: 'Send a campaign our team rejected back for review, after changing what the review asks for (read its rejectionReason with get_campaign). Only the fields given change; null clears the daily budget or the end date, and an empty list means anywhere or any language. It returns to pending; nothing runs until our team approves it. Only a rejected campaign can be sent again: anything else is refused before a change is made. Returns the campaign. Maps to PATCH /system/campaigns/campaign/{id} (when fields change) and POST /system/campaigns/campaign/{id}/resubmit.',
+    kind: 'write',
+    roleFloor: 'editor',
+    reader: 'get_campaign',
+    capability: 'advertise',
+    input: {
+        id: (0, shared_1.id)('campaign'),
+        name: zod_1.z.string().min(1).max(200).optional(),
+        application: shared_1.application.describe(AGENT).optional(),
+        goal: goal.optional(),
+        dailyBudget: dailyBudget.nullable().optional(),
+        startDate: day('When it starts').optional(),
+        endDate: day('When it ends').nullable().optional(),
+        countries: countries.optional(),
+        languages: languages.optional(),
+        notes: notes.optional(),
+    },
+    approval: (args, before) => {
+        const what = (0, shared_1.changedWords)(args, REQUEST_WORDS);
+        const changes = what.length ? `, with a new ${(0, shared_1.listWords)(what)}` : '';
+        return `Send ${(0, shared_1.named)('campaign', before?.name)} to our team again${changes}. Nothing runs until our team approves it.`;
+    },
+    async run({ client }, args) {
+        const path = `${CAMPAIGN}/${(0, shared_1.enc)(args.id)}`;
+        const current = await client.get(path);
+        if (current?.state !== 'rejected') {
+            throw new shared_1.ToolInputError(`Only a campaign our team rejected can be sent for review again; this one is ${(0, shared_1.str)(current?.state) ?? 'not rejected'}. Nothing was changed.`);
+        }
+        const changes = Object.keys(args).some(k => k !== 'id' && args[k] !== undefined);
+        if (changes)
+            await client.patch(path, (0, shared_1.patchBody)(args));
+        return client.post(`${path}/resubmit`);
+    },
+});
+exports.campaignTools = [
+    exports.listCampaigns,
+    exports.getCampaign,
+    exports.requestCampaign,
+    exports.pauseCampaign,
+    exports.resumeCampaign,
+    exports.resubmitCampaign,
+];
+//# sourceMappingURL=campaigns.js.map

package/bin/tools/campaigns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"campaigns.js","sourceRoot":"","sources":["../../src/tools/campaigns.ts"],"names":[],"mappings":";;;AA0CA,kCAYC;AAtDD;;;;;;;GAOG;AACH,6BAAwB;AACxB,kCAAqC;AACrC,qCAgBkB;AAElB,MAAM,QAAQ,GAAG,qBAAqB,CAAC;AAEvC,8DAA8D;AACjD,QAAA,eAAe,GAA2B;IACrD,OAAO,EAAE,8CAA8C;IACvD,MAAM,EAAE,oCAAoC;IAC5C,MAAM,EAAE,6DAA6D;IACrE,QAAQ,EACN,iIAAiI;IACnI,KAAK,EAAE,0BAA0B;IACjC,OAAO,EAAE,iCAAiC;CAC3C,CAAC;AAEF,uCAAuC;AACvC,SAAgB,WAAW,CAAC,CAAM;IAChC,OAAO;QACL,EAAE,EAAE,IAAA,YAAG,EAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAA,YAAG,EAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,KAAK,EAAE,IAAA,cAAK,EAAC,CAAC,CAAC,WAAW,CAAC;QAC3B,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,KAAK,EAAE,CAAC,CAAC,KAAK;QACd,eAAe,EAAE,IAAA,YAAG,EAAC,CAAC,CAAC,eAAe,CAAC;QACvC,SAAS,EAAE,CAAC,CAAC,SAAS;QACtB,OAAO,EAAE,CAAC,CAAC,OAAO;QAClB,WAAW,EAAE,CAAC,CAAC,WAAW;KAC3B,CAAC;AACJ,CAAC;AAEY,QAAA,aAAa,GAAG,IAAA,iBAAU,EAAC;IACtC,IAAI,EAAE,gBAAgB;IACtB,KAAK,EAAE,gBAAgB;IACvB,WAAW,EAAE,wdAAwd,MAAM,CAAC,OAAO,CACjf,uBAAe,CAChB;SACE,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC;SAC9B,IAAI,CACH,IAAI,CACL,uIAAuI;IAC1I,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE;QACL,WAAW,EAAE,oBAAW,CAAC,QAAQ,EAAE;QACnC,KAAK,EAAE,OAAC;aACL,IAAI,CAAC,CAAC,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;aACrE,QAAQ,EAAE;aACV,QAAQ,CAAC,+BAA+B,CAAC;QAC5C,GAAG,kBAAS;KACb;IACD,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;QACvD,OAAO,IAAA,aAAI,EAAC,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,WAAW,GAAG,IAAA,iBAAU,EAAC;IACpC,IAAI,EAAE,cAAc;IACpB,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACT,qYAAqY;IACvY,IAAI,EAAE,MAAM;IACZ,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,WAAE,EAAC,UAAU,CAAC,EAAE;IAC7B,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE;QACtC,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,QAAQ,IAAI,IAAA,YAAG,EAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IACtD,CAAC;CACF,CAAC,CAAC;AAEH,8EAA8E;AAC9E,iEAAiE;AAEjE,MAAM,KAAK,GAAG,CAAC,eAAe,EAAE,OAAO,EAAE,OAAO,CAAU,CAAC;AAE3D,MAAM,IAAI,GACR,mLAAmL,CAAC;AAEtL,MAAM,IAAI,GAAG,OAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAE1C,MAAM,GAAG,GAAG,CAAC,IAAY,EAAE,EAAE,CAC3B,OAAC;KACE,MAAM,EAAE;KACR,KAAK,CAAC,qBAAqB,EAAE,yBAAyB,CAAC;KACvD,QAAQ,CACP,GAAG,IAAI,4DAA4D,CACpE,CAAC;AAEN,MAAM,KAAK,GACT,qFAAqF,CAAC;AAExF,MAAM,WAAW,GAAG,OAAC;KAClB,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,QAAQ,CAAC,qDAAqD,CAAC,CAAC;AAEnE,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,KAAa,EAAE,EAAE,CAC7D,OAAC;KACE,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,cAAc,IAAI,SAAS,CAAC,CAAC;KACrE,QAAQ,CAAC,cAAc,IAAI,gBAAgB,OAAO,YAAY,KAAK,GAAG,CAAC,CAAC;AAE7E,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAC3D,MAAM,SAAS,GAAG,KAAK,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;AAEhE,MAAM,KAAK,GAAG,OAAC;KACZ,MAAM,EAAE;KACR,GAAG,CAAC,IAAI,CAAC;KACT,QAAQ,CACP,sEAAsE,CACvE,CAAC;AAEJ,yEAAyE;AACzE,MAAM,aAAa,GAA2B;IAC5C,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,OAAO;IACpB,IAAI,EAAE,MAAM;IACZ,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,OAAO;IAClB,OAAO,EAAE,OAAO;IAChB,SAAS,EAAE,WAAW;IACtB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,oBAAoB;CAC5B,CAAC;AAEF,2CAA2C;AAC3C,SAAS,WAAW,CAAC,MAAe;IAClC,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IACtE,MAAM,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAC5C,qBAAqB,EAAE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,qBAAqB,EAAE,CAAC;KACzB,CAAC,CAAC;IACH,OAAO,IAAI,MAAM,QAAQ,CAAC;AAC5B,CAAC;AAEY,QAAA,eAAe,GAAG,IAAA,iBAAU,EAAC;IACxC,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,oBAAoB;IAC3B,WAAW,EACT,yZAAyZ;IAC3Z,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE;QACL,IAAI,EAAE,OAAC;aACJ,MAAM,EAAE;aACR,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;aACR,QAAQ,CAAC,qDAAqD,CAAC;QAClE,WAAW,EAAE,oBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC;QACxC,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,GAAG,IAAI,yBAAyB,CAAC;QACzE,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,GAAG,CAAC,+BAA+B,CAAC,CAAC,QAAQ,EAAE;QAC1D,OAAO,EAAE,GAAG,CACV,qDAAqD,CACtD,CAAC,QAAQ,EAAE;QACZ,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC/B,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC/B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;KACxB;IACD,QAAQ,EAAE,IAAI,CAAC,EAAE;QACf,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS;YAC1B,CAAC,CAAC,IAAI,CAAC,OAAO;gBACZ,CAAC,CAAC,QAAQ,IAAI,CAAC,SAAS,OAAO,IAAI,CAAC,OAAO,EAAE;gBAC7C,CAAC,CAAC,QAAQ,IAAI,CAAC,SAAS,EAAE;YAC5B,CAAC,CAAC,IAAI,CAAC,OAAO;gBACZ,CAAC,CAAC,SAAS,IAAI,CAAC,OAAO,EAAE;gBACzB,CAAC,CAAC,EAAE,CAAC;QACT,MAAM,KAAK,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,OAAO,4CAA4C,IAAA,eAAM,EAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,4CAA4C,CAAC;IACnJ,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAA,gBAAO,EAAC,IAAI,CAAC,CAAC,CAAC;IAC9C,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,aAAa,GAAG,IAAA,iBAAU,EAAC;IACtC,IAAI,EAAE,gBAAgB;IACtB,KAAK,EAAE,kBAAkB;IACzB,WAAW,EACT,wOAAwO;IAC1O,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,MAAM,EAAE,cAAc;IACtB,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,WAAE,EAAC,UAAU,CAAC,EAAE;IAC7B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAC1B,SAAS,IAAA,cAAK,EAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,6DAA6D;IACvG,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE;QACtC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,IAAA,YAAG,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,cAAc,GAAG,IAAA,iBAAU,EAAC;IACvC,IAAI,EAAE,iBAAiB;IACvB,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EACT,6PAA6P;IAC/P,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,MAAM,EAAE,cAAc;IACtB,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE,EAAE,EAAE,EAAE,IAAA,WAAE,EAAC,UAAU,CAAC,EAAE;IAC7B,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,CAC1B,UAAU,IAAA,cAAK,EAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,sDAAsD;IACjG,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE;QACtC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,IAAI,IAAA,YAAG,EAAC,UAAU,CAAC,SAAS,CAAC,CAAC;IAC9D,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,gBAAgB,GAAG,IAAA,iBAAU,EAAC;IACzC,IAAI,EAAE,mBAAmB;IACzB,KAAK,EAAE,kCAAkC;IACzC,WAAW,EACT,kjBAAkjB;IACpjB,IAAI,EAAE,OAAO;IACb,SAAS,EAAE,QAAQ;IACnB,MAAM,EAAE,cAAc;IACtB,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE;QACL,EAAE,EAAE,IAAA,WAAE,EAAC,UAAU,CAAC;QAClB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;QAC3C,WAAW,EAAE,oBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;QACnD,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;QACrB,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAC9C,SAAS,EAAE,GAAG,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;QAC3C,OAAO,EAAE,GAAG,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;QAClD,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC/B,SAAS,EAAE,SAAS,CAAC,QAAQ,EAAE;QAC/B,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;KACxB;IACD,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,IAAA,qBAAY,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,IAAA,kBAAS,EAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrE,OAAO,QAAQ,IAAA,cAAK,EAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,qBAAqB,OAAO,4CAA4C,CAAC;IACzH,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,EAAE,IAAI;QACxB,MAAM,IAAI,GAAG,GAAG,QAAQ,IAAI,IAAA,YAAG,EAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,GAAG,CAAM,IAAI,CAAC,CAAC;QAC5C,IAAI,OAAO,EAAE,KAAK,KAAK,UAAU,EAAE,CAAC;YAClC,MAAM,IAAI,uBAAc,CACtB,+EAA+E,IAAA,YAAG,EAAC,OAAO,EAAE,KAAK,CAAC,IAAI,cAAc,wBAAwB,CAC7I,CAAC;QACJ,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CACpC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,CAAsB,CAAC,KAAK,SAAS,CAC9D,CAAC;QACF,IAAI,OAAO;YAAE,MAAM,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAA,kBAAS,EAAC,IAAI,CAAC,CAAC,CAAC;QACvD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,WAAW,CAAC,CAAC;IACzC,CAAC;CACF,CAAC,CAAC;AAEU,QAAA,aAAa,GAAG;IAC3B,qBAAa;IACb,mBAAW;IACX,uBAAe;IACf,qBAAa;IACb,sBAAc;IACd,wBAAgB;CACjB,CAAC"}

package/bin/tools/decisions.d.ts

@@ -0,0 +1,14 @@
+import { Doc } from './shared';
+/** Plain meanings of the pipeline stages, in pipeline order. */
+export declare const STAGE_MEANINGS: Record<string, string>;
+/** Plain meanings of the request outcomes (ads `ErrorResponse` reasons). */
+export declare const OUTCOME_MEANINGS: Record<string, string>;
+/** Plain meanings of the ads elimination reason codes. */
+export declare const REASON_MEANINGS: Record<string, string>;
+/** The trace record (ads `DecisionTraceRecord`) in Offer Manager terms. */
+export declare function explainTrace(record: Doc): Doc;
+export declare const explainDecision: import("../tool").AnyTool;
+export declare function journalRow(j: Doc): Doc;
+export declare const findRequests: import("../tool").AnyTool;
+export declare const getStats: import("../tool").AnyTool;
+export declare const decisionTools: import("../tool").AnyTool[];