@aglyn/plugins-outreach 1.0.0-beta.195 → 1.0.0-beta.197

package/src/lib/enrollment/step-overrides.js

@@ -0,0 +1,140 @@
+import { _ as _extends } from "@swc/helpers/_/_extends";
+/**
+ * @license
+ * Copyright 2026 Aglyn LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */ /**
+ * WHAT A REQUEST MAY STORE AS ONE PERSON'S COPY OF A STEP (AGL-3324).
+ *
+ * The enroll route, the preview route and the curate-save route all take
+ * the console's `OutreachStepOverrideRequest`, and all three read it the
+ * same way: a step index that names an EMAIL step of the sequence, a body,
+ * a subject only where the email starts a thread, and the validator's
+ * verdict on each. A request that names a task step, a step the sequence
+ * does not have, or the same step twice is refused whole — nothing here is
+ * guessed, because what is read here is what gets sent.
+ *
+ * The prompt and the model ride through untouched, for the audit log; who
+ * confirmed and when are the route's to stamp, never the request's to
+ * claim.
+ */ import { CRM_EMAIL_BODY_MAX } from "@aglyn/aglyn/app-utils/crm";
+import { hasOutreachValidationErrors, isInThreadEmailStep, validateOutreachCuratedStep } from "../engine/sequence-validation.js";
+import { OUTREACH_STEP_OVERRIDE_SOURCES } from "../model/outreach.types.js";
+/** The most of a prompt an override keeps for the audit log. */ export const OUTREACH_OVERRIDE_PROMPT_MAX = 12000;
+/**
+ * One override request as a stored override, before the caller's stamp.
+ * `null` when the request is not one.
+ */ export function readOutreachStepOverrideRequest(raw, steps) {
+    if (!raw || typeof raw !== 'object') return {
+        refusal: 'A curated step is an object.'
+    };
+    const entry = raw;
+    const stepIndex = Number(entry['stepIndex']);
+    const step = Number.isInteger(stepIndex) && stepIndex >= 0 ? steps[stepIndex] : undefined;
+    if ((step == null ? void 0 : step.kind) !== 'email') {
+        return {
+            refusal: 'A curated step names one of the sequence’s email steps.'
+        };
+    }
+    const startsThread = !isInThreadEmailStep(steps, stepIndex);
+    const body = typeof entry['body'] === 'string' ? entry['body'].replace(/\r\n?/g, '\n') : '';
+    const subject = startsThread && typeof entry['subject'] === 'string' ? entry['subject'] : undefined;
+    const source = entry['source'];
+    if (!OUTREACH_STEP_OVERRIDE_SOURCES.includes(source)) {
+        return {
+            refusal: 'A curated step says who wrote it: the AI, or the member.'
+        };
+    }
+    const issues = validateOutreachCuratedStep({
+        subject,
+        body,
+        startsThread
+    }, `stepOverrides.${stepIndex}`);
+    const prompt = typeof entry['prompt'] === 'string' ? entry['prompt'].slice(0, OUTREACH_OVERRIDE_PROMPT_MAX) : '';
+    const model = typeof entry['model'] === 'string' ? entry['model'].trim().slice(0, 200) : '';
+    return {
+        stepIndex,
+        issues,
+        override: _extends({}, subject !== undefined ? {
+            subject: subject.replace(/\s+/g, ' ').trim()
+        } : {}, {
+            body: body.slice(0, CRM_EMAIL_BODY_MAX),
+            source: source
+        }, source === 'ai' && entry['edited'] === true ? {
+            edited: true
+        } : {}, source === 'ai' && prompt ? {
+            prompt
+        } : {}, source === 'ai' && model ? {
+            model
+        } : {})
+    };
+}
+/**
+ * Every override a request carries, read and validated, and stamped with
+ * who confirmed them and when. An empty or absent list reads as no
+ * overrides and no issues.
+ */ export function readOutreachStepOverrideRequests(raw, steps, stamp) {
+    const list = Array.isArray(raw) ? raw : [];
+    const overrides = {};
+    const issues = [];
+    for (const entry of list){
+        const read = readOutreachStepOverrideRequest(entry, steps);
+        if ('refusal' in read) return {
+            overrides: {},
+            issues: [],
+            refusal: read.refusal
+        };
+        if (overrides[String(read.stepIndex)]) {
+            return {
+                overrides: {},
+                issues: [],
+                refusal: 'A step is curated once per person.'
+            };
+        }
+        issues.push(...read.issues);
+        overrides[String(read.stepIndex)] = _extends({}, read.override, {
+            draftedAtMs: stamp.nowMs,
+            draftedByUid: stamp.uid
+        });
+    }
+    return {
+        overrides,
+        issues,
+        refusal: null
+    };
+}
+/** Whether a read carries an error that keeps its overrides from being stored. */ export function outreachStepOverridesRefused(read) {
+    return read.refusal !== null || hasOutreachValidationErrors(read.issues);
+}
+/** The requests' shape, for a caller that builds one from stored overrides. */ export function outreachStepOverrideRequests(overrides) {
+    return Object.entries(overrides != null ? overrides : {}).map(([key, override])=>{
+        var _override_body;
+        return _extends({
+            stepIndex: Number(key)
+        }, typeof override.subject === 'string' ? {
+            subject: override.subject
+        } : {}, {
+            body: (_override_body = override.body) != null ? _override_body : '',
+            source: override.source
+        }, override.edited ? {
+            edited: true
+        } : {}, override.prompt ? {
+            prompt: override.prompt
+        } : {}, override.model ? {
+            model: override.model
+        } : {});
+    }).sort((a, b)=>a.stepIndex - b.stepIndex);
+}
+
+//# sourceMappingURL=step-overrides.js.map

package/src/lib/enrollment/step-overrides.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/enrollment/step-overrides.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * WHAT A REQUEST MAY STORE AS ONE PERSON'S COPY OF A STEP (AGL-3324).\n *\n * The enroll route, the preview route and the curate-save route all take\n * the console's `OutreachStepOverrideRequest`, and all three read it the\n * same way: a step index that names an EMAIL step of the sequence, a body,\n * a subject only where the email starts a thread, and the validator's\n * verdict on each. A request that names a task step, a step the sequence\n * does not have, or the same step twice is refused whole — nothing here is\n * guessed, because what is read here is what gets sent.\n *\n * The prompt and the model ride through untouched, for the audit log; who\n * confirmed and when are the route's to stamp, never the request's to\n * claim.\n */\n\nimport { CRM_EMAIL_BODY_MAX } from '@aglyn/aglyn/app-utils/crm'\nimport {\n  hasOutreachValidationErrors,\n  isInThreadEmailStep,\n  validateOutreachCuratedStep,\n  type OutreachValidationIssue,\n} from '../engine/sequence-validation'\nimport type { OutreachStepOverrideRequest } from '../model/outreach-api'\nimport {\n  OUTREACH_STEP_OVERRIDE_SOURCES,\n  type OutreachSequenceStep,\n  type OutreachStepOverride,\n  type OutreachStepOverrides,\n} from '../model/outreach.types'\n\n/** The most of a prompt an override keeps for the audit log. */\nexport const OUTREACH_OVERRIDE_PROMPT_MAX = 12_000\n\nexport interface OutreachStepOverrideRead {\n  /** The overrides as they would be stored, keyed by step index, stamped by the caller. */\n  overrides: OutreachStepOverrides\n  /** Every issue, each path prefixed `stepOverrides.<index>`. */\n  issues: OutreachValidationIssue[]\n  /** Why the request could not be read at all, in a sentence; `null` when it could. */\n  refusal: string | null\n}\n\n/**\n * One override request as a stored override, before the caller's stamp.\n * `null` when the request is not one.\n */\nexport function readOutreachStepOverrideRequest(\n  raw: unknown,\n  steps: readonly OutreachSequenceStep[],\n): { stepIndex: number; override: Omit<OutreachStepOverride, 'draftedAtMs' | 'draftedByUid'>; issues: OutreachValidationIssue[] } | { refusal: string } {\n  if (!raw || typeof raw !== 'object') return { refusal: 'A curated step is an object.' }\n  const entry = raw as Record<string, unknown>\n  const stepIndex = Number(entry['stepIndex'])\n  const step = Number.isInteger(stepIndex) && stepIndex >= 0 ? steps[stepIndex] : undefined\n  if (step?.kind !== 'email') {\n    return { refusal: 'A curated step names one of the sequence’s email steps.' }\n  }\n  const startsThread = !isInThreadEmailStep(steps, stepIndex)\n  const body = typeof entry['body'] === 'string' ? entry['body'].replace(/\\r\\n?/g, '\\n') : ''\n  const subject = startsThread && typeof entry['subject'] === 'string' ? entry['subject'] : undefined\n  const source = entry['source']\n  if (!(OUTREACH_STEP_OVERRIDE_SOURCES as readonly unknown[]).includes(source)) {\n    return { refusal: 'A curated step says who wrote it: the AI, or the member.' }\n  }\n  const issues = validateOutreachCuratedStep({ subject, body, startsThread }, `stepOverrides.${stepIndex}`)\n  const prompt = typeof entry['prompt'] === 'string' ? entry['prompt'].slice(0, OUTREACH_OVERRIDE_PROMPT_MAX) : ''\n  const model = typeof entry['model'] === 'string' ? entry['model'].trim().slice(0, 200) : ''\n  return {\n    stepIndex,\n    issues,\n    override: {\n      ...(subject !== undefined ? { subject: subject.replace(/\\s+/g, ' ').trim() } : {}),\n      body: body.slice(0, CRM_EMAIL_BODY_MAX),\n      source: source as OutreachStepOverride['source'],\n      ...(source === 'ai' && entry['edited'] === true ? { edited: true } : {}),\n      ...(source === 'ai' && prompt ? { prompt } : {}),\n      ...(source === 'ai' && model ? { model } : {}),\n    },\n  }\n}\n\n/**\n * Every override a request carries, read and validated, and stamped with\n * who confirmed them and when. An empty or absent list reads as no\n * overrides and no issues.\n */\nexport function readOutreachStepOverrideRequests(\n  raw: unknown,\n  steps: readonly OutreachSequenceStep[],\n  stamp: { uid: string; nowMs: number },\n): OutreachStepOverrideRead {\n  const list = Array.isArray(raw) ? (raw as unknown[]) : []\n  const overrides: OutreachStepOverrides = {}\n  const issues: OutreachValidationIssue[] = []\n  for (const entry of list) {\n    const read = readOutreachStepOverrideRequest(entry, steps)\n    if ('refusal' in read) return { overrides: {}, issues: [], refusal: read.refusal }\n    if (overrides[String(read.stepIndex)]) {\n      return { overrides: {}, issues: [], refusal: 'A step is curated once per person.' }\n    }\n    issues.push(...read.issues)\n    overrides[String(read.stepIndex)] = {\n      ...read.override,\n      draftedAtMs: stamp.nowMs,\n      draftedByUid: stamp.uid,\n    }\n  }\n  return { overrides, issues, refusal: null }\n}\n\n/** Whether a read carries an error that keeps its overrides from being stored. */\nexport function outreachStepOverridesRefused(read: OutreachStepOverrideRead): boolean {\n  return read.refusal !== null || hasOutreachValidationErrors(read.issues)\n}\n\n/** The requests' shape, for a caller that builds one from stored overrides. */\nexport function outreachStepOverrideRequests(\n  overrides: OutreachStepOverrides | null | undefined,\n): OutreachStepOverrideRequest[] {\n  return Object.entries(overrides ?? {})\n    .map(([key, override]) => ({\n      stepIndex: Number(key),\n      ...(typeof override.subject === 'string' ? { subject: override.subject } : {}),\n      body: override.body ?? '',\n      source: override.source,\n      ...(override.edited ? { edited: true } : {}),\n      ...(override.prompt ? { prompt: override.prompt } : {}),\n      ...(override.model ? { model: override.model } : {}),\n    }))\n    .sort((a, b) => a.stepIndex - b.stepIndex)\n}\n"],"names":["CRM_EMAIL_BODY_MAX","hasOutreachValidationErrors","isInThreadEmailStep","validateOutreachCuratedStep","OUTREACH_STEP_OVERRIDE_SOURCES","OUTREACH_OVERRIDE_PROMPT_MAX","readOutreachStepOverrideRequest","raw","steps","refusal","entry","stepIndex","Number","step","isInteger","undefined","kind","startsThread","body","replace","subject","source","includes","issues","prompt","slice","model","trim","override","edited","readOutreachStepOverrideRequests","stamp","list","Array","isArray","overrides","read","String","push","draftedAtMs","nowMs","draftedByUid","uid","outreachStepOverridesRefused","outreachStepOverrideRequests","Object","entries","map","key","sort","a","b"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;CAcC,GAED,SAASA,kBAAkB,QAAQ,6BAA4B;AAC/D,SACEC,2BAA2B,EAC3BC,mBAAmB,EACnBC,2BAA2B,QAEtB,mCAA+B;AAEtC,SACEC,8BAA8B,QAIzB,6BAAyB;AAEhC,8DAA8D,GAC9D,OAAO,MAAMC,+BAA+B,MAAM;AAWlD;;;CAGC,GACD,OAAO,SAASC,gCACdC,GAAY,EACZC,KAAsC;IAEtC,IAAI,CAACD,OAAO,OAAOA,QAAQ,UAAU,OAAO;QAAEE,SAAS;IAA+B;IACtF,MAAMC,QAAQH;IACd,MAAMI,YAAYC,OAAOF,KAAK,CAAC,YAAY;IAC3C,MAAMG,OAAOD,OAAOE,SAAS,CAACH,cAAcA,aAAa,IAAIH,KAAK,CAACG,UAAU,GAAGI;IAChF,IAAIF,CAAAA,wBAAAA,KAAMG,IAAI,MAAK,SAAS;QAC1B,OAAO;YAAEP,SAAS;QAA0D;IAC9E;IACA,MAAMQ,eAAe,CAACf,oBAAoBM,OAAOG;IACjD,MAAMO,OAAO,OAAOR,KAAK,CAAC,OAAO,KAAK,WAAWA,KAAK,CAAC,OAAO,CAACS,OAAO,CAAC,UAAU,QAAQ;IACzF,MAAMC,UAAUH,gBAAgB,OAAOP,KAAK,CAAC,UAAU,KAAK,WAAWA,KAAK,CAAC,UAAU,GAAGK;IAC1F,MAAMM,SAASX,KAAK,CAAC,SAAS;IAC9B,IAAI,CAAC,AAACN,+BAAsDkB,QAAQ,CAACD,SAAS;QAC5E,OAAO;YAAEZ,SAAS;QAA2D;IAC/E;IACA,MAAMc,SAASpB,4BAA4B;QAAEiB;QAASF;QAAMD;IAAa,GAAG,CAAC,cAAc,EAAEN,WAAW;IACxG,MAAMa,SAAS,OAAOd,KAAK,CAAC,SAAS,KAAK,WAAWA,KAAK,CAAC,SAAS,CAACe,KAAK,CAAC,GAAGpB,gCAAgC;IAC9G,MAAMqB,QAAQ,OAAOhB,KAAK,CAAC,QAAQ,KAAK,WAAWA,KAAK,CAAC,QAAQ,CAACiB,IAAI,GAAGF,KAAK,CAAC,GAAG,OAAO;IACzF,OAAO;QACLd;QACAY;QACAK,UAAU,aACJR,YAAYL,YAAY;YAAEK,SAASA,QAAQD,OAAO,CAAC,QAAQ,KAAKQ,IAAI;QAAG,IAAI,CAAC;YAChFT,MAAMA,KAAKO,KAAK,CAAC,GAAGzB;YACpBqB,QAAQA;WACJA,WAAW,QAAQX,KAAK,CAAC,SAAS,KAAK,OAAO;YAAEmB,QAAQ;QAAK,IAAI,CAAC,GAClER,WAAW,QAAQG,SAAS;YAAEA;QAAO,IAAI,CAAC,GAC1CH,WAAW,QAAQK,QAAQ;YAAEA;QAAM,IAAI,CAAC;IAEhD;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASI,iCACdvB,GAAY,EACZC,KAAsC,EACtCuB,KAAqC;IAErC,MAAMC,OAAOC,MAAMC,OAAO,CAAC3B,OAAQA,MAAoB,EAAE;IACzD,MAAM4B,YAAmC,CAAC;IAC1C,MAAMZ,SAAoC,EAAE;IAC5C,KAAK,MAAMb,SAASsB,KAAM;QACxB,MAAMI,OAAO9B,gCAAgCI,OAAOF;QACpD,IAAI,aAAa4B,MAAM,OAAO;YAAED,WAAW,CAAC;YAAGZ,QAAQ,EAAE;YAAEd,SAAS2B,KAAK3B,OAAO;QAAC;QACjF,IAAI0B,SAAS,CAACE,OAAOD,KAAKzB,SAAS,EAAE,EAAE;YACrC,OAAO;gBAAEwB,WAAW,CAAC;gBAAGZ,QAAQ,EAAE;gBAAEd,SAAS;YAAqC;QACpF;QACAc,OAAOe,IAAI,IAAIF,KAAKb,MAAM;QAC1BY,SAAS,CAACE,OAAOD,KAAKzB,SAAS,EAAE,GAAG,aAC/ByB,KAAKR,QAAQ;YAChBW,aAAaR,MAAMS,KAAK;YACxBC,cAAcV,MAAMW,GAAG;;IAE3B;IACA,OAAO;QAAEP;QAAWZ;QAAQd,SAAS;IAAK;AAC5C;AAEA,gFAAgF,GAChF,OAAO,SAASkC,6BAA6BP,IAA8B;IACzE,OAAOA,KAAK3B,OAAO,KAAK,QAAQR,4BAA4BmC,KAAKb,MAAM;AACzE;AAEA,6EAA6E,GAC7E,OAAO,SAASqB,6BACdT,SAAmD;IAEnD,OAAOU,OAAOC,OAAO,CAACX,oBAAAA,YAAa,CAAC,GACjCY,GAAG,CAAC,CAAC,CAACC,KAAKpB,SAAS;YAGbA;eAHmB;YACzBjB,WAAWC,OAAOoC;WACd,OAAOpB,SAASR,OAAO,KAAK,WAAW;YAAEA,SAASQ,SAASR,OAAO;QAAC,IAAI,CAAC;YAC5EF,IAAI,GAAEU,iBAAAA,SAASV,IAAI,YAAbU,iBAAiB;YACvBP,QAAQO,SAASP,MAAM;WACnBO,SAASC,MAAM,GAAG;YAAEA,QAAQ;QAAK,IAAI,CAAC,GACtCD,SAASJ,MAAM,GAAG;YAAEA,QAAQI,SAASJ,MAAM;QAAC,IAAI,CAAC,GACjDI,SAASF,KAAK,GAAG;YAAEA,OAAOE,SAASF,KAAK;QAAC,IAAI,CAAC;OAEnDuB,IAAI,CAAC,CAACC,GAAGC,IAAMD,EAAEvC,SAAS,GAAGwC,EAAExC,SAAS;AAC7C"}

package/src/lib/model/outreach-api.d.ts

@@ -24,11 +24,12 @@
  * surface that names no site.
  */
 import type { OutreachComposeError } from '../engine/compose';
+import type { OutreachValidationIssue } from '../engine/sequence-validation';
 import type { OutreachComplianceIssue } from './compliance-settings';
-import type { OutreachAttestationKind, OutreachComplianceSettingsDocument, OutreachDoNotContactDomainEntry, OutreachEnrollment, OutreachSequence } from './outreach.types';
+import type { OutreachAttestationKind, OutreachComplianceSettingsDocument, OutreachDoNotContactDomainEntry, OutreachEnrollment, OutreachSequence, OutreachStepOverrideSource } from './outreach.types';
 import type { OutreachSequenceDraft, OutreachSequenceIssue } from './sequence-draft';
 /** Every reason these routes refuse with, for a caller to branch on. */
-export type OutreachRouteRefusalReason = 'unauthenticated' | 'email-unverified' | 'org-required' | 'not-a-member' | 'not-org-wide' | 'permission' | 'entitlement' | 'method-not-allowed' | 'invalid-request' | 'invalid-domain' | 'invalid-settings' | 'invalid-sequence' | 'sequence-not-found' | 'sequence-archived' | 'sequence-not-active' | 'activation-refused' | 'delete-refused' | 'mailbox-unavailable' | 'enrollment-not-found' | 'transition-refused' | 'view-not-found' | 'view-unsupported' | 'contact-not-found' | 'link-domain-refused';
+export type OutreachRouteRefusalReason = 'unauthenticated' | 'email-unverified' | 'org-required' | 'not-a-member' | 'not-org-wide' | 'permission' | 'entitlement' | 'method-not-allowed' | 'invalid-request' | 'invalid-domain' | 'invalid-settings' | 'invalid-sequence' | 'sequence-not-found' | 'sequence-archived' | 'sequence-not-active' | 'activation-refused' | 'delete-refused' | 'mailbox-unavailable' | 'enrollment-not-found' | 'transition-refused' | 'view-not-found' | 'view-unsupported' | 'contact-not-found' | 'link-domain-refused' | 'rate-limited' | 'google-unavailable' | 'curation-unavailable' | 'curation-refused' | 'invalid-override';
 /** A refusal, in the one shape every route answers with. */
 export interface OutreachRouteRefusal {
     /** A sentence written for the person reading it. */
@@ -166,12 +167,32 @@ export interface OutreachEnrollPreviewResponse {
     /** True when the source named more people than one enrollment reads. */
     truncated: boolean;
 }
+/**
+ * One person's confirmed copy of one step, as the console sends it
+ * (AGL-3324): what the member read and ticked the confirmation for. The
+ * route validates it again and stamps who and when.
+ */
+export interface OutreachStepOverrideRequest {
+    stepIndex: number;
+    /** Read only where the email starts a thread. */
+    subject?: string;
+    body: string;
+    source: OutreachStepOverrideSource;
+    /** An AI draft the member changed before confirming it. */
+    edited?: boolean;
+    /** The prompt the AI was given, returned by the draft route, for the audit log. */
+    prompt?: string;
+    /** The model that drafted it, returned by the draft route. */
+    model?: string;
+}
 /** One person to enroll, with what the rep supplied for them: a contact by id, or a lead by key. */
 export interface OutreachEnrollPersonRequest {
     contactId?: string;
     leadId?: string;
     personalLine?: string;
     attestations?: OutreachAttestationKind[];
+    /** The steps the member curated for this person before enrolling them (AGL-3324). */
+    stepOverrides?: OutreachStepOverrideRequest[];
 }
 /** `POST outreach/enroll` — the gates are checked again, here, before anything is written. */
 export interface OutreachEnrollRequest {
@@ -295,6 +316,8 @@ export interface OutreachPreviewRequest {
     personalLine?: string;
     /** Which step; the first email when absent. */
     stepIndex?: number;
+    /** The person's copies of steps as the dialog holds them (AGL-3324), so the preview shows the curated version. */
+    stepOverrides?: OutreachStepOverrideRequest[];
 }
 export interface OutreachPreviewResponse {
     ok: true;
@@ -306,4 +329,68 @@ export interface OutreachPreviewResponse {
     /** Why it could not be written, when it could not. */
     error: OutreachComposeError | null;
 }
+/**
+ * `POST outreach/steps/test` — one step of a saved sequence, rendered
+ * exactly as `outreach/preview` renders it (the same person, personal
+ * line and step) and sent through the sequence's mailbox to the member.
+ */
+export interface OutreachStepTestRequest extends OutreachPreviewRequest {
+    /** Where the test goes; the member's own address when absent or empty. */
+    to?: string;
+}
+export interface OutreachStepTestResponse {
+    ok: true;
+    stepIndex: number;
+    /** The address the test went to. */
+    sentTo: string;
+    /** The subject as sent, `[Test]` prefix included. */
+    subject: string;
+    sentAtMs: number;
+    /** How many tests the mailbox has sent on its local day, this one included. */
+    testsToday: number;
+}
+/**
+ * `POST outreach/curate/draft` — this person's own copies of the sequence's
+ * email steps, drafted by the workspace's AI. Names EITHER a person about to
+ * be enrolled (the sequence, a contact or a lead, the personal line the rep
+ * is writing) OR an enrollment, whose next email step is drafted. Nothing is
+ * stored: the answer is what the member reads before confirming.
+ */
+export interface OutreachCurateDraftRequest {
+    orgId: string;
+    sequenceId?: string;
+    contactId?: string;
+    leadId?: string;
+    personalLine?: string;
+    enrollmentId?: string;
+    /** Which email steps; every email step for a person to enroll, the next one for an enrollment, when absent. */
+    stepIndexes?: number[];
+}
+/** One drafted step, with what the validator said about it. */
+export interface OutreachCurateDraft {
+    stepIndex: number;
+    /** `null` for an in-thread email, which is sent as `Re:` the thread's subject. */
+    subject: string | null;
+    body: string;
+    /** Errors and warnings; a draft with an error cannot be confirmed as it stands. */
+    issues: OutreachValidationIssue[];
+}
+export interface OutreachCurateDraftResponse {
+    ok: true;
+    drafts: OutreachCurateDraft[];
+    /** The prompt the AI was given and the model that answered, for the override's audit record. */
+    prompt: string;
+    model: string;
+}
+/** `POST outreach/curate/save` — stores a confirmed copy of one step on an enrollment, or clears it with `override: null`. */
+export interface OutreachCurateSaveRequest {
+    orgId: string;
+    enrollmentId: string;
+    stepIndex: number;
+    override: Omit<OutreachStepOverrideRequest, 'stepIndex'> | null;
+}
+export interface OutreachCurateSaveResponse {
+    ok: true;
+    enrollment: OutreachEnrollment;
+}
 export {};

package/src/lib/model/outreach-api.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/model/outreach-api.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * THE CONTRACT OF OUTREACH'S SETTINGS, SEQUENCE AND ENROLLMENT ROUTES\n * (AGL-2980): what the console sends, what the routes answer, and every\n * reason one refuses. Client-safe — types and the batch limit only.\n *\n * Every request names its organization (`orgId`, in the query of a `GET`\n * and the JSON body of a `POST`): the routes serve an organization-level\n * surface that names no site.\n */\n\nimport type { OutreachComposeError } from '../engine/compose'\nimport type { OutreachComplianceIssue } from './compliance-settings'\nimport type {\n  OutreachAttestationKind,\n  OutreachComplianceSettingsDocument,\n  OutreachDoNotContactDomainEntry,\n  OutreachEnrollment,\n  OutreachSequence,\n} from './outreach.types'\nimport type { OutreachSequenceDraft, OutreachSequenceIssue } from './sequence-draft'\n\n/** Every reason these routes refuse with, for a caller to branch on. */\nexport type OutreachRouteRefusalReason =\n  | 'unauthenticated'\n  | 'email-unverified'\n  | 'org-required'\n  | 'not-a-member'\n  | 'not-org-wide'\n  | 'permission'\n  | 'entitlement'\n  | 'method-not-allowed'\n  | 'invalid-request'\n  | 'invalid-domain'\n  | 'invalid-settings'\n  | 'invalid-sequence'\n  | 'sequence-not-found'\n  | 'sequence-archived'\n  | 'sequence-not-active'\n  | 'activation-refused'\n  | 'delete-refused'\n  | 'mailbox-unavailable'\n  | 'enrollment-not-found'\n  | 'transition-refused'\n  | 'view-not-found'\n  | 'view-unsupported'\n  | 'contact-not-found'\n  | 'link-domain-refused'\n\n/** A refusal, in the one shape every route answers with. */\nexport interface OutreachRouteRefusal {\n  /** A sentence written for the person reading it. */\n  error: string\n  reason: OutreachRouteRefusalReason\n  /** The field-level reasons behind an `invalid-*` or `activation-refused` refusal. */\n  issues?: ReadonlyArray<OutreachComplianceIssue | OutreachSequenceIssue>\n}\n\n/*==========================================\n * COMPLIANCE SETTINGS\n *==========================================*/\n\n/** `GET outreach/settings?orgId` — and the answer to a save. */\nexport interface OutreachSettingsResponse {\n  ok: true\n  settings: OutreachComplianceSettingsDocument\n}\n\n/** `POST outreach/settings` */\nexport interface OutreachSettingsSaveRequest {\n  orgId: string\n  legalName: string\n  brandName: string\n  postalAddress: string\n  allowedCountries: string[]\n}\n\n/** The answer to a save: the settings as stored, and whether anything changed. */\nexport interface OutreachSettingsSaveResponse extends OutreachSettingsResponse {\n  changed: boolean\n}\n\n/*==========================================\n * SEQUENCES\n *==========================================*/\n\n/** `POST outreach/sequences/save` — a new sequence without `sequenceId`, an edit with one. */\nexport interface OutreachSequenceSaveRequest {\n  orgId: string\n  sequenceId?: string\n  sequence: OutreachSequenceDraft\n}\n\nexport interface OutreachSequenceSaveResponse {\n  ok: true\n  sequence: OutreachSequence\n  created: boolean\n  /** What the save allowed but probably isn't what was meant. */\n  warnings: OutreachSequenceIssue[]\n}\n\n/** What `outreach/sequences/status` does to a sequence. */\nexport type OutreachSequenceAction = 'activate' | 'pause' | 'archive'\n\n/** `POST outreach/sequences/status` */\nexport interface OutreachSequenceStatusRequest {\n  orgId: string\n  sequenceId: string\n  action: OutreachSequenceAction\n}\n\nexport interface OutreachSequenceStatusResponse {\n  ok: true\n  sequence: OutreachSequence\n  /** The open enrollments an archive stopped; `0` for anything else. */\n  stoppedEnrollments: number\n}\n\n/** `POST outreach/sequences/delete` — a draft nobody was ever enrolled in. */\nexport interface OutreachSequenceDeleteRequest {\n  orgId: string\n  sequenceId: string\n}\n\n/*==========================================\n * ENROLLING\n *==========================================*/\n\n/** The most people one preview or one enroll reads. */\nexport const OUTREACH_ENROLL_BATCH_MAX = 50\n\n/**\n * Which CRM record a person to enroll is (AGL-3234): a contact by its\n * document id, or a lead the sequence's site holds by its person key.\n */\nexport type OutreachPersonRef = { kind: 'contact'; id: string } | { kind: 'lead'; id: string }\n\n/**\n * Where the people to enroll come from: a saved Contacts or Leads view,\n * contacts picked by search, or leads picked from the sequence's site.\n */\nexport type OutreachEnrollSource =\n  | { kind: 'view'; viewId: string }\n  | { kind: 'contacts'; contactIds: string[] }\n  | { kind: 'leads'; leadIds: string[] }\n\n/** `POST outreach/enroll/preview` */\nexport interface OutreachEnrollPreviewRequest {\n  orgId: string\n  sequenceId: string\n  source: OutreachEnrollSource\n}\n\n/**\n * Where one person stands:\n *\n * - `eligible` — enrolled on Confirm as they are;\n * - `needs_confirmation` — enrolled once the rep writes the personal line\n *   and ticks the attestations `requires` names;\n * - `blocked` — refused whatever the rep confirms, for the `blocks` given.\n */\nexport type OutreachEnrollPreviewStatus = 'eligible' | 'needs_confirmation' | 'blocked'\n\n/** One reason a person can't be enrolled, in a sentence a rep can act on. */\nexport interface OutreachEnrollBlock {\n  code: string\n  reason: string\n}\n\nexport interface OutreachEnrollPreviewPerson {\n  /** The key the dialog and the confirm name this person by: the record's own id. */\n  personId: string\n  /** The record the person is (AGL-3234). */\n  target: 'contact' | 'lead'\n  /** The contact's id; `''` for a lead. */\n  contactId: string\n  /** The lead's person key; `null` for a contact. */\n  leadId: string | null\n  name: string\n  /** The address the steps would go to, or `null` when the contact has none. */\n  email: string | null\n  /** No inbound capture behind them — the heavier rules apply. */\n  cold: boolean\n  /** ISO-3166-1 alpha-2, when anything names one. */\n  country: string | null\n  status: OutreachEnrollPreviewStatus\n  /** Why a `blocked` person is refused; empty otherwise. */\n  blocks: OutreachEnrollBlock[]\n  /** What the rep must supply before a `needs_confirmation` person is enrolled. */\n  requires: {\n    personalLine: boolean\n    attestations: OutreachAttestationKind[]\n  }\n}\n\nexport interface OutreachEnrollPreviewResponse {\n  ok: true\n  people: OutreachEnrollPreviewPerson[]\n  /** Everyone the source named, before the batch limit. */\n  total: number\n  /** True when the source named more people than one enrollment reads. */\n  truncated: boolean\n}\n\n/** One person to enroll, with what the rep supplied for them: a contact by id, or a lead by key. */\nexport interface OutreachEnrollPersonRequest {\n  contactId?: string\n  leadId?: string\n  personalLine?: string\n  attestations?: OutreachAttestationKind[]\n}\n\n/** `POST outreach/enroll` — the gates are checked again, here, before anything is written. */\nexport interface OutreachEnrollRequest {\n  orgId: string\n  sequenceId: string\n  people: OutreachEnrollPersonRequest[]\n}\n\ninterface OutreachEnrollOutcomePerson {\n  personId: string\n  target: 'contact' | 'lead'\n  contactId: string\n  leadId: string | null\n  email: string | null\n}\n\nexport type OutreachEnrollOutcome =\n  | (OutreachEnrollOutcomePerson & { outcome: 'enrolled'; enrollmentId: string })\n  | (OutreachEnrollOutcomePerson & { outcome: 'blocked'; blocks: OutreachEnrollBlock[] })\n\nexport interface OutreachEnrollResponse {\n  ok: true\n  results: OutreachEnrollOutcome[]\n  enrolled: number\n}\n\n/*==========================================\n * ENROLLMENTS\n *==========================================*/\n\n/** What a member may do to one enrollment. */\nexport type OutreachEnrollmentAction = 'pause' | 'resume' | 'stop' | 'do_not_contact'\n\n/** `POST outreach/enrollments/action` */\nexport interface OutreachEnrollmentActionRequest {\n  orgId: string\n  enrollmentId: string\n  action: OutreachEnrollmentAction\n  /** Why, for a stop or a do-not-contact. */\n  detail?: string\n}\n\nexport interface OutreachEnrollmentActionResponse {\n  ok: true\n  /** False when the enrollment was already where the action would put it. */\n  changed: boolean\n  enrollment: OutreachEnrollment\n  /** Other open enrollments of the same address a do-not-contact stopped. */\n  stoppedOthers: number\n}\n\n/*==========================================\n * DO NOT CONTACT: DOMAINS (AGL-3244)\n *==========================================*/\n\n/** `GET outreach/do-not-contact/domains?orgId` — and the answer to a change. */\nexport interface OutreachDoNotContactDomainsResponse {\n  ok: true\n  /** Every domain on the list, alphabetically. */\n  domains: OutreachDoNotContactDomainEntry[]\n}\n\n/** `POST outreach/do-not-contact/domains` */\nexport interface OutreachDoNotContactDomainRequest {\n  orgId: string\n  action: 'add' | 'remove'\n  /** The domain, or an address at it. */\n  domain: string\n  /** Why, for an add. */\n  detail?: string\n}\n\n/** The answer to a change: the list as it stands, and whether anything changed. */\nexport interface OutreachDoNotContactDomainResponse extends OutreachDoNotContactDomainsResponse {\n  changed: boolean\n  /** The domain as the list spells it. */\n  domain: string\n}\n\n/*==========================================\n * LINK DOMAINS (AGL-3306)\n *==========================================*/\n\n/** Where a mailbox domain's click-tracking host stands. */\nexport type OutreachLinkDomainStatus = 'not-set-up' | 'requested' | 'records-issued' | 'verified' | 'failed'\n\n/** One DNS record the member publishes, as the sending-domain cards print them. */\nexport interface OutreachLinkDomainRecord {\n  type: string\n  name: string\n  value: string\n  required: boolean\n  note: string\n}\n\n/**\n * One sending domain of the organization's connected mailboxes, and its\n * `links.` host: what tracked links in mail from it read now, and what is\n * left to do for them to read `https://links.<domain>/<id>`.\n */\nexport interface OutreachLinkDomain {\n  /** The mailboxes' sending domain. */\n  domain: string\n  /** `links.<domain>`. */\n  host: string\n  status: OutreachLinkDomainStatus\n  /** The records to publish; empty until the host is set up. */\n  records: OutreachLinkDomainRecord[]\n  /** Why it is not verified, in a sentence; `null` when nothing is wrong. */\n  detail: string | null\n  /** How a tracked link in mail from this domain starts today. */\n  linkPrefix: string | null\n  checkedAtMs: number | null\n  verifiedAtMs: number | null\n}\n\n/** `GET outreach/link-domains?orgId` */\nexport interface OutreachLinkDomainsResponse {\n  ok: true\n  domains: OutreachLinkDomain[]\n  /** Whether the member may set a host up, check it, or remove it. */\n  canManage: boolean\n}\n\n/** `POST outreach/link-domains` */\nexport interface OutreachLinkDomainRequest {\n  orgId: string\n  domain: string\n  action: 'set-up' | 'check' | 'remove'\n}\n\nexport interface OutreachLinkDomainResponse extends OutreachLinkDomainsResponse {\n  /** The domain the action was for. */\n  domain: string\n}\n\n/*==========================================\n * PREVIEW\n *==========================================*/\n\n/** `POST outreach/preview` — one email of a saved sequence, as a person would get it. */\nexport interface OutreachPreviewRequest {\n  orgId: string\n  sequenceId: string\n  /** The contact to write it to; a sample person when absent. */\n  contactId?: string\n  /** Or a lead the sequence's site holds (AGL-3234), written to as the contact it would be. */\n  leadId?: string\n  personalLine?: string\n  /** Which step; the first email when absent. */\n  stepIndex?: number\n}\n\nexport interface OutreachPreviewResponse {\n  ok: true\n  stepIndex: number\n  subject: string\n  /** The plain text, footer included. */\n  text: string\n  unresolvedFields: string[]\n  /** Why it could not be written, when it could not. */\n  error: OutreachComposeError | null\n}\n"],"names":["OUTREACH_ENROLL_BATCH_MAX"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;CAQC,GAmHD;;4CAE4C,GAE5C,qDAAqD,GACrD,OAAO,MAAMA,4BAA4B,GAAE"}
+{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/model/outreach-api.ts"],"sourcesContent":["/**\n * @license\n * Copyright 2026 Aglyn LLC\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *   http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\n/**\n * THE CONTRACT OF OUTREACH'S SETTINGS, SEQUENCE AND ENROLLMENT ROUTES\n * (AGL-2980): what the console sends, what the routes answer, and every\n * reason one refuses. Client-safe — types and the batch limit only.\n *\n * Every request names its organization (`orgId`, in the query of a `GET`\n * and the JSON body of a `POST`): the routes serve an organization-level\n * surface that names no site.\n */\n\nimport type { OutreachComposeError } from '../engine/compose'\nimport type { OutreachValidationIssue } from '../engine/sequence-validation'\nimport type { OutreachComplianceIssue } from './compliance-settings'\nimport type {\n  OutreachAttestationKind,\n  OutreachComplianceSettingsDocument,\n  OutreachDoNotContactDomainEntry,\n  OutreachEnrollment,\n  OutreachSequence,\n  OutreachStepOverrideSource,\n} from './outreach.types'\nimport type { OutreachSequenceDraft, OutreachSequenceIssue } from './sequence-draft'\n\n/** Every reason these routes refuse with, for a caller to branch on. */\nexport type OutreachRouteRefusalReason =\n  | 'unauthenticated'\n  | 'email-unverified'\n  | 'org-required'\n  | 'not-a-member'\n  | 'not-org-wide'\n  | 'permission'\n  | 'entitlement'\n  | 'method-not-allowed'\n  | 'invalid-request'\n  | 'invalid-domain'\n  | 'invalid-settings'\n  | 'invalid-sequence'\n  | 'sequence-not-found'\n  | 'sequence-archived'\n  | 'sequence-not-active'\n  | 'activation-refused'\n  | 'delete-refused'\n  | 'mailbox-unavailable'\n  | 'enrollment-not-found'\n  | 'transition-refused'\n  | 'view-not-found'\n  | 'view-unsupported'\n  | 'contact-not-found'\n  | 'link-domain-refused'\n  | 'rate-limited'\n  | 'google-unavailable'\n  | 'curation-unavailable'\n  | 'curation-refused'\n  | 'invalid-override'\n\n/** A refusal, in the one shape every route answers with. */\nexport interface OutreachRouteRefusal {\n  /** A sentence written for the person reading it. */\n  error: string\n  reason: OutreachRouteRefusalReason\n  /** The field-level reasons behind an `invalid-*` or `activation-refused` refusal. */\n  issues?: ReadonlyArray<OutreachComplianceIssue | OutreachSequenceIssue>\n}\n\n/*==========================================\n * COMPLIANCE SETTINGS\n *==========================================*/\n\n/** `GET outreach/settings?orgId` — and the answer to a save. */\nexport interface OutreachSettingsResponse {\n  ok: true\n  settings: OutreachComplianceSettingsDocument\n}\n\n/** `POST outreach/settings` */\nexport interface OutreachSettingsSaveRequest {\n  orgId: string\n  legalName: string\n  brandName: string\n  postalAddress: string\n  allowedCountries: string[]\n}\n\n/** The answer to a save: the settings as stored, and whether anything changed. */\nexport interface OutreachSettingsSaveResponse extends OutreachSettingsResponse {\n  changed: boolean\n}\n\n/*==========================================\n * SEQUENCES\n *==========================================*/\n\n/** `POST outreach/sequences/save` — a new sequence without `sequenceId`, an edit with one. */\nexport interface OutreachSequenceSaveRequest {\n  orgId: string\n  sequenceId?: string\n  sequence: OutreachSequenceDraft\n}\n\nexport interface OutreachSequenceSaveResponse {\n  ok: true\n  sequence: OutreachSequence\n  created: boolean\n  /** What the save allowed but probably isn't what was meant. */\n  warnings: OutreachSequenceIssue[]\n}\n\n/** What `outreach/sequences/status` does to a sequence. */\nexport type OutreachSequenceAction = 'activate' | 'pause' | 'archive'\n\n/** `POST outreach/sequences/status` */\nexport interface OutreachSequenceStatusRequest {\n  orgId: string\n  sequenceId: string\n  action: OutreachSequenceAction\n}\n\nexport interface OutreachSequenceStatusResponse {\n  ok: true\n  sequence: OutreachSequence\n  /** The open enrollments an archive stopped; `0` for anything else. */\n  stoppedEnrollments: number\n}\n\n/** `POST outreach/sequences/delete` — a draft nobody was ever enrolled in. */\nexport interface OutreachSequenceDeleteRequest {\n  orgId: string\n  sequenceId: string\n}\n\n/*==========================================\n * ENROLLING\n *==========================================*/\n\n/** The most people one preview or one enroll reads. */\nexport const OUTREACH_ENROLL_BATCH_MAX = 50\n\n/**\n * Which CRM record a person to enroll is (AGL-3234): a contact by its\n * document id, or a lead the sequence's site holds by its person key.\n */\nexport type OutreachPersonRef = { kind: 'contact'; id: string } | { kind: 'lead'; id: string }\n\n/**\n * Where the people to enroll come from: a saved Contacts or Leads view,\n * contacts picked by search, or leads picked from the sequence's site.\n */\nexport type OutreachEnrollSource =\n  | { kind: 'view'; viewId: string }\n  | { kind: 'contacts'; contactIds: string[] }\n  | { kind: 'leads'; leadIds: string[] }\n\n/** `POST outreach/enroll/preview` */\nexport interface OutreachEnrollPreviewRequest {\n  orgId: string\n  sequenceId: string\n  source: OutreachEnrollSource\n}\n\n/**\n * Where one person stands:\n *\n * - `eligible` — enrolled on Confirm as they are;\n * - `needs_confirmation` — enrolled once the rep writes the personal line\n *   and ticks the attestations `requires` names;\n * - `blocked` — refused whatever the rep confirms, for the `blocks` given.\n */\nexport type OutreachEnrollPreviewStatus = 'eligible' | 'needs_confirmation' | 'blocked'\n\n/** One reason a person can't be enrolled, in a sentence a rep can act on. */\nexport interface OutreachEnrollBlock {\n  code: string\n  reason: string\n}\n\nexport interface OutreachEnrollPreviewPerson {\n  /** The key the dialog and the confirm name this person by: the record's own id. */\n  personId: string\n  /** The record the person is (AGL-3234). */\n  target: 'contact' | 'lead'\n  /** The contact's id; `''` for a lead. */\n  contactId: string\n  /** The lead's person key; `null` for a contact. */\n  leadId: string | null\n  name: string\n  /** The address the steps would go to, or `null` when the contact has none. */\n  email: string | null\n  /** No inbound capture behind them — the heavier rules apply. */\n  cold: boolean\n  /** ISO-3166-1 alpha-2, when anything names one. */\n  country: string | null\n  status: OutreachEnrollPreviewStatus\n  /** Why a `blocked` person is refused; empty otherwise. */\n  blocks: OutreachEnrollBlock[]\n  /** What the rep must supply before a `needs_confirmation` person is enrolled. */\n  requires: {\n    personalLine: boolean\n    attestations: OutreachAttestationKind[]\n  }\n}\n\nexport interface OutreachEnrollPreviewResponse {\n  ok: true\n  people: OutreachEnrollPreviewPerson[]\n  /** Everyone the source named, before the batch limit. */\n  total: number\n  /** True when the source named more people than one enrollment reads. */\n  truncated: boolean\n}\n\n/**\n * One person's confirmed copy of one step, as the console sends it\n * (AGL-3324): what the member read and ticked the confirmation for. The\n * route validates it again and stamps who and when.\n */\nexport interface OutreachStepOverrideRequest {\n  stepIndex: number\n  /** Read only where the email starts a thread. */\n  subject?: string\n  body: string\n  source: OutreachStepOverrideSource\n  /** An AI draft the member changed before confirming it. */\n  edited?: boolean\n  /** The prompt the AI was given, returned by the draft route, for the audit log. */\n  prompt?: string\n  /** The model that drafted it, returned by the draft route. */\n  model?: string\n}\n\n/** One person to enroll, with what the rep supplied for them: a contact by id, or a lead by key. */\nexport interface OutreachEnrollPersonRequest {\n  contactId?: string\n  leadId?: string\n  personalLine?: string\n  attestations?: OutreachAttestationKind[]\n  /** The steps the member curated for this person before enrolling them (AGL-3324). */\n  stepOverrides?: OutreachStepOverrideRequest[]\n}\n\n/** `POST outreach/enroll` — the gates are checked again, here, before anything is written. */\nexport interface OutreachEnrollRequest {\n  orgId: string\n  sequenceId: string\n  people: OutreachEnrollPersonRequest[]\n}\n\ninterface OutreachEnrollOutcomePerson {\n  personId: string\n  target: 'contact' | 'lead'\n  contactId: string\n  leadId: string | null\n  email: string | null\n}\n\nexport type OutreachEnrollOutcome =\n  | (OutreachEnrollOutcomePerson & { outcome: 'enrolled'; enrollmentId: string })\n  | (OutreachEnrollOutcomePerson & { outcome: 'blocked'; blocks: OutreachEnrollBlock[] })\n\nexport interface OutreachEnrollResponse {\n  ok: true\n  results: OutreachEnrollOutcome[]\n  enrolled: number\n}\n\n/*==========================================\n * ENROLLMENTS\n *==========================================*/\n\n/** What a member may do to one enrollment. */\nexport type OutreachEnrollmentAction = 'pause' | 'resume' | 'stop' | 'do_not_contact'\n\n/** `POST outreach/enrollments/action` */\nexport interface OutreachEnrollmentActionRequest {\n  orgId: string\n  enrollmentId: string\n  action: OutreachEnrollmentAction\n  /** Why, for a stop or a do-not-contact. */\n  detail?: string\n}\n\nexport interface OutreachEnrollmentActionResponse {\n  ok: true\n  /** False when the enrollment was already where the action would put it. */\n  changed: boolean\n  enrollment: OutreachEnrollment\n  /** Other open enrollments of the same address a do-not-contact stopped. */\n  stoppedOthers: number\n}\n\n/*==========================================\n * DO NOT CONTACT: DOMAINS (AGL-3244)\n *==========================================*/\n\n/** `GET outreach/do-not-contact/domains?orgId` — and the answer to a change. */\nexport interface OutreachDoNotContactDomainsResponse {\n  ok: true\n  /** Every domain on the list, alphabetically. */\n  domains: OutreachDoNotContactDomainEntry[]\n}\n\n/** `POST outreach/do-not-contact/domains` */\nexport interface OutreachDoNotContactDomainRequest {\n  orgId: string\n  action: 'add' | 'remove'\n  /** The domain, or an address at it. */\n  domain: string\n  /** Why, for an add. */\n  detail?: string\n}\n\n/** The answer to a change: the list as it stands, and whether anything changed. */\nexport interface OutreachDoNotContactDomainResponse extends OutreachDoNotContactDomainsResponse {\n  changed: boolean\n  /** The domain as the list spells it. */\n  domain: string\n}\n\n/*==========================================\n * LINK DOMAINS (AGL-3306)\n *==========================================*/\n\n/** Where a mailbox domain's click-tracking host stands. */\nexport type OutreachLinkDomainStatus = 'not-set-up' | 'requested' | 'records-issued' | 'verified' | 'failed'\n\n/** One DNS record the member publishes, as the sending-domain cards print them. */\nexport interface OutreachLinkDomainRecord {\n  type: string\n  name: string\n  value: string\n  required: boolean\n  note: string\n}\n\n/**\n * One sending domain of the organization's connected mailboxes, and its\n * `links.` host: what tracked links in mail from it read now, and what is\n * left to do for them to read `https://links.<domain>/<id>`.\n */\nexport interface OutreachLinkDomain {\n  /** The mailboxes' sending domain. */\n  domain: string\n  /** `links.<domain>`. */\n  host: string\n  status: OutreachLinkDomainStatus\n  /** The records to publish; empty until the host is set up. */\n  records: OutreachLinkDomainRecord[]\n  /** Why it is not verified, in a sentence; `null` when nothing is wrong. */\n  detail: string | null\n  /** How a tracked link in mail from this domain starts today. */\n  linkPrefix: string | null\n  checkedAtMs: number | null\n  verifiedAtMs: number | null\n}\n\n/** `GET outreach/link-domains?orgId` */\nexport interface OutreachLinkDomainsResponse {\n  ok: true\n  domains: OutreachLinkDomain[]\n  /** Whether the member may set a host up, check it, or remove it. */\n  canManage: boolean\n}\n\n/** `POST outreach/link-domains` */\nexport interface OutreachLinkDomainRequest {\n  orgId: string\n  domain: string\n  action: 'set-up' | 'check' | 'remove'\n}\n\nexport interface OutreachLinkDomainResponse extends OutreachLinkDomainsResponse {\n  /** The domain the action was for. */\n  domain: string\n}\n\n/*==========================================\n * PREVIEW\n *==========================================*/\n\n/** `POST outreach/preview` — one email of a saved sequence, as a person would get it. */\nexport interface OutreachPreviewRequest {\n  orgId: string\n  sequenceId: string\n  /** The contact to write it to; a sample person when absent. */\n  contactId?: string\n  /** Or a lead the sequence's site holds (AGL-3234), written to as the contact it would be. */\n  leadId?: string\n  personalLine?: string\n  /** Which step; the first email when absent. */\n  stepIndex?: number\n  /** The person's copies of steps as the dialog holds them (AGL-3324), so the preview shows the curated version. */\n  stepOverrides?: OutreachStepOverrideRequest[]\n}\n\nexport interface OutreachPreviewResponse {\n  ok: true\n  stepIndex: number\n  subject: string\n  /** The plain text, footer included. */\n  text: string\n  unresolvedFields: string[]\n  /** Why it could not be written, when it could not. */\n  error: OutreachComposeError | null\n}\n\n/*==========================================\n * A TEST OF ONE STEP (AGL-3325)\n *==========================================*/\n\n/**\n * `POST outreach/steps/test` — one step of a saved sequence, rendered\n * exactly as `outreach/preview` renders it (the same person, personal\n * line and step) and sent through the sequence's mailbox to the member.\n */\nexport interface OutreachStepTestRequest extends OutreachPreviewRequest {\n  /** Where the test goes; the member's own address when absent or empty. */\n  to?: string\n}\n\nexport interface OutreachStepTestResponse {\n  ok: true\n  stepIndex: number\n  /** The address the test went to. */\n  sentTo: string\n  /** The subject as sent, `[Test]` prefix included. */\n  subject: string\n  sentAtMs: number\n  /** How many tests the mailbox has sent on its local day, this one included. */\n  testsToday: number\n}\n\n/*==========================================\n * CURATING (AGL-3324)\n *==========================================*/\n\n/**\n * `POST outreach/curate/draft` — this person's own copies of the sequence's\n * email steps, drafted by the workspace's AI. Names EITHER a person about to\n * be enrolled (the sequence, a contact or a lead, the personal line the rep\n * is writing) OR an enrollment, whose next email step is drafted. Nothing is\n * stored: the answer is what the member reads before confirming.\n */\nexport interface OutreachCurateDraftRequest {\n  orgId: string\n  sequenceId?: string\n  contactId?: string\n  leadId?: string\n  personalLine?: string\n  enrollmentId?: string\n  /** Which email steps; every email step for a person to enroll, the next one for an enrollment, when absent. */\n  stepIndexes?: number[]\n}\n\n/** One drafted step, with what the validator said about it. */\nexport interface OutreachCurateDraft {\n  stepIndex: number\n  /** `null` for an in-thread email, which is sent as `Re:` the thread's subject. */\n  subject: string | null\n  body: string\n  /** Errors and warnings; a draft with an error cannot be confirmed as it stands. */\n  issues: OutreachValidationIssue[]\n}\n\nexport interface OutreachCurateDraftResponse {\n  ok: true\n  drafts: OutreachCurateDraft[]\n  /** The prompt the AI was given and the model that answered, for the override's audit record. */\n  prompt: string\n  model: string\n}\n\n/** `POST outreach/curate/save` — stores a confirmed copy of one step on an enrollment, or clears it with `override: null`. */\nexport interface OutreachCurateSaveRequest {\n  orgId: string\n  enrollmentId: string\n  stepIndex: number\n  override: Omit<OutreachStepOverrideRequest, 'stepIndex'> | null\n}\n\nexport interface OutreachCurateSaveResponse {\n  ok: true\n  enrollment: OutreachEnrollment\n}\n"],"names":["OUTREACH_ENROLL_BATCH_MAX"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;CAQC,GA0HD;;4CAE4C,GAE5C,qDAAqD,GACrD,OAAO,MAAMA,4BAA4B,GAAE"}

package/src/lib/model/outreach.types.d.ts

@@ -128,6 +128,12 @@ export interface OutreachMailboxDailyHealth {
     sent: number;
     bounces: number;
     replies: number;
+    /**
+     * Tests of a sequence step sent to a member (AGL-3325). Counted apart from
+     * `sent`: a test is a real Gmail send, so it spends the account's own
+     * limits, but it is not a person emailed and never moves the daily cap.
+     */
+    tests?: number;
 }
 /**
  * The counters a mailbox's sending is judged by.
@@ -512,6 +518,31 @@ export interface OutreachAttestation {
 export type OutreachAttestations = Partial<Record<OutreachAttestationKind, OutreachAttestation>>;
 /** The longest personal line an enrollment keeps: one sentence, not a letter. */
 export declare const OUTREACH_PERSONAL_LINE_MAX = 300;
+/** Who wrote the override: the AI, or the member by hand. */
+export declare const OUTREACH_STEP_OVERRIDE_SOURCES: readonly ["ai", "member"];
+export type OutreachStepOverrideSource = (typeof OUTREACH_STEP_OVERRIDE_SOURCES)[number];
+/** One person's own copy of one step. */
+export interface OutreachStepOverride {
+    /** The subject, merge fields allowed; absent keeps the step's own. Not read on an in-thread email. */
+    subject?: string;
+    /** The plain-text body, merge fields allowed; absent keeps the step's own (or its template's). */
+    body?: string;
+    source: OutreachStepOverrideSource;
+    /** When the member confirmed it — the moment it was stored, never before. */
+    draftedAtMs: number;
+    /** The member who confirmed it. */
+    draftedByUid?: string;
+    /** An AI draft the member changed before confirming it. */
+    edited?: boolean;
+    /** The prompt the AI was given, for the audit log; absent on a member's own words. */
+    prompt?: string;
+    /** The model that drafted it, for the audit log. */
+    model?: string;
+}
+/** The overrides an enrollment carries, keyed by the step's index as text. */
+export type OutreachStepOverrides = Record<string, OutreachStepOverride>;
+/** The sentence a member ticks before a curated draft is stored — a fourth attestation. */
+export declare const OUTREACH_CURATION_CONFIRMATION_LABEL = "I've read this draft, and it goes out to this person as written";
 /**
  * Which CRM record an enrollment names (AGL-3234). A person is a LEAD until
  * somebody qualifies them and a CONTACT after, and a sequence works either:
@@ -612,6 +643,12 @@ export interface OutreachEnrollment extends OutreachTimestamps {
      * in it, and one it leaves keeps what it was credited with.
      */
     campaignIds?: string[];
+    /**
+     * This person's own copies of steps (AGL-3324), by step index. Absent on
+     * an enrollment nobody curated, which sends the sequence's steps as
+     * written; a step without an entry sends the same.
+     */
+    stepOverrides?: OutreachStepOverrides;
 }
 /** A sending run's claim on one enrollment's step (AGL-2981). */
 export interface OutreachSendClaim {
@@ -652,6 +689,11 @@ export interface OutreachStepRecord {
      * read afterwards for what it actually offered them.
      */
     links?: string[];
+    /**
+     * The email went out as this person's curated copy (AGL-3324), and who
+     * wrote it. Absent on a step sent as the sequence wrote it.
+     */
+    curated?: OutreachStepOverrideSource;
 }
 /**
  * What every Outreach email's footer says about who sent it — the

package/src/lib/model/outreach.types.js

@@ -234,6 +234,24 @@ export const OUTREACH_TASK_KIND_LABELS = {
     verified_deliverable: 'This address was verified as deliverable'
 };
 /** The longest personal line an enrollment keeps: one sentence, not a letter. */ export const OUTREACH_PERSONAL_LINE_MAX = 300;
+/*==========================================
+ * CURATED STEPS (AGL-3324).
+ *
+ * A step is one template for everyone, plus the personal line. Curating
+ * rewrites ONE person's copy of a step — drafted by the workspace's AI from
+ * their record and the step's own body as the skeleton, or written by the
+ * member — and keeps it on the enrollment, never on the sequence. The send
+ * job reads the override in place of the step's subject and body; the
+ * tokens, the footer, the click tracking and the plain-text rules still
+ * apply to it exactly as they apply to the step.
+ *
+ * Nothing is stored that a member has not read: a draft lands on the
+ * enrollment only when the member confirms it, with who and when.
+ *==========================================*/ /** Who wrote the override: the AI, or the member by hand. */ export const OUTREACH_STEP_OVERRIDE_SOURCES = [
+    'ai',
+    'member'
+];
+/** The sentence a member ticks before a curated draft is stored — a fourth attestation. */ export const OUTREACH_CURATION_CONFIRMATION_LABEL = "I've read this draft, and it goes out to this person as written";
 /**
  * Which CRM record an enrollment names (AGL-3234). A person is a LEAD until
  * somebody qualifies them and a CONTACT after, and a sequence works either: