@aglyn/plugins-outreach 1.0.0-beta.143

package/src/lib/model/sequence-draft.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/model/sequence-draft.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 * A SEQUENCE AS THE EDITOR HOLDS IT (AGL-2980).\n *\n * The editor builds a draft, the save route reads the draft it was sent\n * through the same reader, and the engine's validator judges both — so the\n * issues the editor shows beside a field are the ones the route would\n * refuse the save with. Client-safe.\n *\n * ## Once someone is enrolled, the steps they stand on stay put\n *\n * An enrollment points at its next step by POSITION (`stepIndex`), and it\n * was enrolled into a site's CRM from one mailbox. So after the first\n * enrollment, a save may edit any step's wording and delay and may add\n * steps at the end, but may not remove, reorder or change the kind of a\n * step that already exists, and may not move the sequence to another site\n * or mailbox: each of those would send an enrolled person a step they were\n * never going to get, from an address they never heard from. A new\n * sequence is the way to change them.\n *==========================================*/\n\nimport {\n  readOutreachSequenceSettings,\n  type OutreachValidationIssue,\n  type OutreachValidationCode,\n} from '../engine/sequence-validation'\nimport {\n  type OutreachEmailStep,\n  type OutreachMailbox,\n  type OutreachSendWindow,\n  type OutreachSequence,\n  type OutreachSequenceSettings,\n  type OutreachSequenceStep,\n  type OutreachTaskKind,\n  type OutreachTaskStep,\n} from './outreach.types'\n\n/** A sequence as the editor holds it and the save route receives it. */\nexport interface OutreachSequenceDraft {\n  name: string\n  /** The site whose CRM the enrolled people are records of. */\n  hostId: string\n  /** `''` until a mailbox is chosen. */\n  mailboxId: string\n  steps: OutreachSequenceStep[]\n  settings: OutreachSequenceSettings\n}\n\n/** The most steps a draft is read with; the validator refuses past the real limit. */\nconst STEPS_READ_MAX = 20\n\n/** The delay a new email after the first starts with, in business days. */\nexport const OUTREACH_DEFAULT_FOLLOW_UP_DAYS = 3\n\nconst text = (value: unknown): string => (typeof value === 'string' ? value : '')\n\n/** A whole number, or `NaN` for anything else, so the validator names it. */\nconst wholeNumber = (value: unknown): number => {\n  const number = typeof value === 'number' ? value : Number(text(value) || NaN)\n  return Number.isInteger(number) ? number : Number.NaN\n}\n\nfunction readWindow(value: unknown): OutreachSendWindow | null {\n  if (!value || typeof value !== 'object') return null\n  const raw = value as Record<string, unknown>\n  return {\n    days: Array.isArray(raw['days']) ? raw['days'].map((day) => wholeNumber(day)) : [],\n    startMinute: wholeNumber(raw['startMinute']),\n    endMinute: wholeNumber(raw['endMinute']),\n  }\n}\n\nfunction readStep(value: unknown): OutreachSequenceStep {\n  const raw = (value && typeof value === 'object' ? value : {}) as Record<string, unknown>\n  const id = text(raw['id']).trim().slice(0, 64)\n  const delayBusinessDays = wholeNumber(raw['delayBusinessDays'])\n  if (raw['kind'] === 'email') {\n    const templateId = text(raw['templateId']).trim()\n    const step: OutreachEmailStep = {\n      id,\n      kind: 'email',\n      delayBusinessDays,\n      subject: text(raw['subject']),\n      replyInThread: raw['replyInThread'] !== false,\n      body: text(raw['body']),\n      templateId: templateId || null,\n    }\n    return step\n  }\n  if (raw['kind'] === 'task') {\n    const step: OutreachTaskStep = {\n      id,\n      kind: 'task',\n      taskKind: text(raw['taskKind']) as OutreachTaskKind,\n      title: text(raw['title']),\n      delayBusinessDays,\n    }\n    return step\n  }\n  // Neither kind: kept, so the validator can say \"a step is an email or a\n  // task\" beside it rather than the step silently disappearing.\n  return { id, kind: text(raw['kind']) } as unknown as OutreachSequenceStep\n}\n\n/**\n * A draft read out of anything — a request body, a stored sequence — with\n * every field the model does not name left behind and every value coerced\n * to its type. Nothing is judged here; that is the validator's.\n */\nexport function readOutreachSequenceDraft(input: unknown): OutreachSequenceDraft {\n  const raw = (input && typeof input === 'object' ? input : {}) as Record<string, unknown>\n  const settings = readOutreachSequenceSettings(\n    (raw['settings'] && typeof raw['settings'] === 'object'\n      ? raw['settings']\n      : {}) as Record<string, unknown>,\n  )\n  return {\n    name: text(raw['name']).replace(/\\s+/g, ' ').trim(),\n    hostId: text(raw['hostId']).trim(),\n    mailboxId: text(raw['mailboxId']).trim(),\n    steps: (Array.isArray(raw['steps']) ? raw['steps'] : []).slice(0, STEPS_READ_MAX).map(readStep),\n    settings: {\n      ...settings,\n      window: readWindow((raw['settings'] as Record<string, unknown> | undefined)?.['window']),\n    },\n  }\n}\n\n/** The draft a stored sequence opens as in the editor. */\nexport function outreachSequenceDraftOf(\n  sequence: Pick<OutreachSequence, 'name' | 'hostId' | 'mailboxId' | 'steps' | 'settings'>,\n): OutreachSequenceDraft {\n  return readOutreachSequenceDraft(sequence)\n}\n\n/** A step id nothing else in the sequence carries. */\nexport function newOutreachStepId(\n  steps: readonly Pick<OutreachSequenceStep, 'id'>[] = [],\n  random: () => number = Math.random,\n): string {\n  const taken = new Set(steps.map((step) => step.id))\n  for (let attempt = 0; ; attempt += 1) {\n    const drawn = `step-${Math.floor(random() * 36 ** 6).toString(36).padStart(6, '0')}`\n    // A source that keeps answering the same number still ends: the attempt\n    // count makes the id unique once the draws stop being.\n    const id = attempt < 4 ? drawn : `${drawn}-${attempt}`\n    if (!taken.has(id)) return id\n  }\n}\n\n/**\n * A new email step for the end of `steps`: the first email waits for the\n * next opening; a later one waits a few business days and replies in the\n * thread the first started.\n */\nexport function newOutreachEmailStep(\n  steps: readonly OutreachSequenceStep[],\n  random?: () => number,\n): OutreachEmailStep {\n  const follows = steps.some((step) => step.kind === 'email')\n  return {\n    id: newOutreachStepId(steps, random),\n    kind: 'email',\n    delayBusinessDays: follows ? OUTREACH_DEFAULT_FOLLOW_UP_DAYS : 0,\n    subject: '',\n    replyInThread: true,\n    body: '',\n    templateId: null,\n  }\n}\n\n/** A new task step for the end of `steps`, titled for its kind. */\nexport function newOutreachTaskStep(\n  steps: readonly OutreachSequenceStep[],\n  taskKind: OutreachTaskKind,\n  random?: () => number,\n): OutreachTaskStep {\n  const titles: Record<OutreachTaskKind, string> = {\n    linkedin: 'Connect on LinkedIn',\n    call: 'Call',\n    todo: '',\n  }\n  return {\n    id: newOutreachStepId(steps, random),\n    kind: 'task',\n    taskKind,\n    title: titles[taskKind] ?? '',\n    delayBusinessDays: 1,\n  }\n}\n\n/** A new sequence: one email, for `hostId`, sending to the countries given. */\nexport function emptyOutreachSequenceDraft(input: {\n  hostId: string\n  mailboxId?: string\n  allowedCountries: readonly string[]\n  random?: () => number\n}): OutreachSequenceDraft {\n  return {\n    name: '',\n    hostId: input.hostId,\n    mailboxId: input.mailboxId ?? '',\n    steps: [newOutreachEmailStep([], input.random)],\n    settings: {\n      window: null,\n      allowedCountries: [...input.allowedCountries],\n      allowCustomers: false,\n    },\n  }\n}\n\n/** The issues a save can be refused with beyond the engine's own. */\nexport type OutreachSequenceIssueCode =\n  | OutreachValidationCode\n  | 'steps_locked'\n  | 'host_locked'\n  | 'mailbox_locked'\n  | 'host_unknown'\n  | 'mailbox_unknown'\n  | 'mailbox_not_yours'\n  | 'mailbox_not_sending'\n  | 'country_not_in_org'\n\nexport interface OutreachSequenceIssue extends Omit<OutreachValidationIssue, 'code'> {\n  code: OutreachSequenceIssueCode\n}\n\n/**\n * What a save may not change once someone is enrolled — see the module\n * note. `previous` is the stored sequence; `next` the draft being saved.\n */\nexport function outreachEnrolledSequenceIssues(\n  previous: Pick<OutreachSequenceDraft, 'hostId' | 'mailboxId' | 'steps'>,\n  next: Pick<OutreachSequenceDraft, 'hostId' | 'mailboxId' | 'steps'>,\n): OutreachSequenceIssue[] {\n  const issues: OutreachSequenceIssue[] = []\n  const locked = (path: string, code: OutreachSequenceIssueCode, message: string) =>\n    issues.push({ path, code, message, severity: 'error' })\n  const kept = previous.steps.every(\n    (step, index) => next.steps[index]?.id === step.id && next.steps[index]?.kind === step.kind,\n  )\n  if (!kept) {\n    locked(\n      'steps',\n      'steps_locked',\n      \"People are enrolled in this sequence, so its steps can't be removed, reordered or changed to another kind. Edit their wording, add steps at the end, or start a new sequence.\",\n    )\n  }\n  if (previous.hostId !== next.hostId) {\n    locked('hostId', 'host_locked', \"People are enrolled from this site's CRM, so the site can't change.\")\n  }\n  if (previous.mailboxId !== next.mailboxId) {\n    locked(\n      'mailboxId',\n      'mailbox_locked',\n      \"People are enrolled from this mailbox, so it can't change. Start a new sequence to send from another.\",\n    )\n  }\n  return issues\n}\n\n/**\n * Whether a sequence's mailbox can send right now, as activation asks it:\n * `none` when no mailbox is chosen, `gone` when it was disconnected or is\n * not this organization's, `paused` or `reconnect_required` while it is\n * connected but not sending, and `sending` when it is connected.\n */\nexport type OutreachSequenceMailboxState =\n  | 'none'\n  | 'gone'\n  | 'paused'\n  | 'reconnect_required'\n  | 'sending'\n\nexport function outreachSequenceMailboxState(\n  mailboxId: string,\n  mailbox: Pick<OutreachMailbox, 'status'> | null | undefined,\n): OutreachSequenceMailboxState {\n  if (!mailboxId) return 'none'\n  if (!mailbox || mailbox.status === 'disconnected') return 'gone'\n  if (mailbox.status === 'paused' || mailbox.status === 'reconnect_required') {\n    return mailbox.status\n  }\n  return 'sending'\n}\n\n/** What activation refuses with for each mailbox that cannot send. */\nconst MAILBOX_ACTIVATION_ISSUES: Record<\n  Exclude<OutreachSequenceMailboxState, 'sending'>,\n  { code: OutreachSequenceIssueCode; message: string }\n> = {\n  none: {\n    code: 'mailbox_required',\n    message: 'Choose the mailbox this sequence sends from before activating it.',\n  },\n  gone: {\n    code: 'mailbox_unknown',\n    message: \"This sequence's mailbox is no longer connected. Choose another before activating it.\",\n  },\n  paused: {\n    code: 'mailbox_not_sending',\n    message: \"This sequence's mailbox is paused. Resume it in Mailboxes, then activate the sequence.\",\n  },\n  reconnect_required: {\n    code: 'mailbox_not_sending',\n    message:\n      \"Google stopped accepting this sequence's mailbox. Reconnect it in Mailboxes, then activate the sequence.\",\n  },\n}\n\n/**\n * Why a sequence cannot be activated on its mailbox, or `null` when it can\n * (AGL-2980). A sequence is activated only onto a mailbox that is sending:\n * connected, not paused, and not waiting for its member to reconnect it —\n * whether or not its steps include an email, because every step's due time\n * is read in the mailbox's timezone and sending hours.\n *\n * The status route refuses with it, and the sequence page shows it beside\n * a disabled Activate button, so the page says why before anyone clicks.\n */\nexport function outreachMailboxActivationIssue(\n  mailboxId: string,\n  mailbox: Pick<OutreachMailbox, 'status'> | null | undefined,\n): OutreachSequenceIssue | null {\n  const state = outreachSequenceMailboxState(mailboxId, mailbox)\n  if (state === 'sending') return null\n  const { code, message } = MAILBOX_ACTIVATION_ISSUES[state]\n  return { path: 'mailboxId', code, message, severity: 'error' }\n}\n"],"names":["readOutreachSequenceSettings","STEPS_READ_MAX","OUTREACH_DEFAULT_FOLLOW_UP_DAYS","text","value","wholeNumber","number","Number","NaN","isInteger","readWindow","raw","days","Array","isArray","map","day","startMinute","endMinute","readStep","id","trim","slice","delayBusinessDays","templateId","step","kind","subject","replyInThread","body","taskKind","title","readOutreachSequenceDraft","input","settings","name","replace","hostId","mailboxId","steps","window","outreachSequenceDraftOf","sequence","newOutreachStepId","random","Math","taken","Set","attempt","drawn","floor","toString","padStart","has","newOutreachEmailStep","follows","some","newOutreachTaskStep","titles","linkedin","call","todo","emptyOutreachSequenceDraft","allowedCountries","allowCustomers","outreachEnrolledSequenceIssues","previous","next","issues","locked","path","code","message","push","severity","kept","every","index","outreachSequenceMailboxState","mailbox","status","MAILBOX_ACTIVATION_ISSUES","none","gone","paused","reconnect_required","outreachMailboxActivationIssue","state"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;;;;;;4CAkB4C,GAE5C,SACEA,4BAA4B,QAGvB,mCAA+B;AAuBtC,oFAAoF,GACpF,MAAMC,iBAAiB;AAEvB,yEAAyE,GACzE,OAAO,MAAMC,kCAAkC,EAAC;AAEhD,MAAMC,OAAO,CAACC,QAA4B,OAAOA,UAAU,WAAWA,QAAQ;AAE9E,2EAA2E,GAC3E,MAAMC,cAAc,CAACD;IACnB,MAAME,SAAS,OAAOF,UAAU,WAAWA,QAAQG,OAAOJ,KAAKC,UAAUI;IACzE,OAAOD,OAAOE,SAAS,CAACH,UAAUA,SAASC,OAAOC,GAAG;AACvD;AAEA,SAASE,WAAWN,KAAc;IAChC,IAAI,CAACA,SAAS,OAAOA,UAAU,UAAU,OAAO;IAChD,MAAMO,MAAMP;IACZ,OAAO;QACLQ,MAAMC,MAAMC,OAAO,CAACH,GAAG,CAAC,OAAO,IAAIA,GAAG,CAAC,OAAO,CAACI,GAAG,CAAC,CAACC,MAAQX,YAAYW,QAAQ,EAAE;QAClFC,aAAaZ,YAAYM,GAAG,CAAC,cAAc;QAC3CO,WAAWb,YAAYM,GAAG,CAAC,YAAY;IACzC;AACF;AAEA,SAASQ,SAASf,KAAc;IAC9B,MAAMO,MAAOP,SAAS,OAAOA,UAAU,WAAWA,QAAQ,CAAC;IAC3D,MAAMgB,KAAKjB,KAAKQ,GAAG,CAAC,KAAK,EAAEU,IAAI,GAAGC,KAAK,CAAC,GAAG;IAC3C,MAAMC,oBAAoBlB,YAAYM,GAAG,CAAC,oBAAoB;IAC9D,IAAIA,GAAG,CAAC,OAAO,KAAK,SAAS;QAC3B,MAAMa,aAAarB,KAAKQ,GAAG,CAAC,aAAa,EAAEU,IAAI;QAC/C,MAAMI,OAA0B;YAC9BL;YACAM,MAAM;YACNH;YACAI,SAASxB,KAAKQ,GAAG,CAAC,UAAU;YAC5BiB,eAAejB,GAAG,CAAC,gBAAgB,KAAK;YACxCkB,MAAM1B,KAAKQ,GAAG,CAAC,OAAO;YACtBa,YAAYA,cAAc;QAC5B;QACA,OAAOC;IACT;IACA,IAAId,GAAG,CAAC,OAAO,KAAK,QAAQ;QAC1B,MAAMc,OAAyB;YAC7BL;YACAM,MAAM;YACNI,UAAU3B,KAAKQ,GAAG,CAAC,WAAW;YAC9BoB,OAAO5B,KAAKQ,GAAG,CAAC,QAAQ;YACxBY;QACF;QACA,OAAOE;IACT;IACA,wEAAwE;IACxE,8DAA8D;IAC9D,OAAO;QAAEL;QAAIM,MAAMvB,KAAKQ,GAAG,CAAC,OAAO;IAAE;AACvC;AAEA;;;;CAIC,GACD,OAAO,SAASqB,0BAA0BC,KAAc;QAc9BtB;IAbxB,MAAMA,MAAOsB,SAAS,OAAOA,UAAU,WAAWA,QAAQ,CAAC;IAC3D,MAAMC,WAAWlC,6BACdW,GAAG,CAAC,WAAW,IAAI,OAAOA,GAAG,CAAC,WAAW,KAAK,WAC3CA,GAAG,CAAC,WAAW,GACf,CAAC;IAEP,OAAO;QACLwB,MAAMhC,KAAKQ,GAAG,CAAC,OAAO,EAAEyB,OAAO,CAAC,QAAQ,KAAKf,IAAI;QACjDgB,QAAQlC,KAAKQ,GAAG,CAAC,SAAS,EAAEU,IAAI;QAChCiB,WAAWnC,KAAKQ,GAAG,CAAC,YAAY,EAAEU,IAAI;QACtCkB,OAAO,AAAC1B,CAAAA,MAAMC,OAAO,CAACH,GAAG,CAAC,QAAQ,IAAIA,GAAG,CAAC,QAAQ,GAAG,EAAE,AAAD,EAAGW,KAAK,CAAC,GAAGrB,gBAAgBc,GAAG,CAACI;QACtFe,UAAU,aACLA;YACHM,QAAQ9B,YAAYC,gBAAAA,GAAG,CAAC,WAAW,qBAAhB,AAACA,aAAyD,CAAC,SAAS;;IAE3F;AACF;AAEA,wDAAwD,GACxD,OAAO,SAAS8B,wBACdC,QAAwF;IAExF,OAAOV,0BAA0BU;AACnC;AAEA,oDAAoD,GACpD,OAAO,SAASC,kBACdJ,QAAqD,EAAE,EACvDK,SAAuBC,KAAKD,MAAM;IAElC,MAAME,QAAQ,IAAIC,IAAIR,MAAMxB,GAAG,CAAC,CAACU,OAASA,KAAKL,EAAE;IACjD,IAAK,IAAI4B,UAAU,IAAKA,WAAW,EAAG;QACpC,MAAMC,QAAQ,CAAC,KAAK,EAAEJ,KAAKK,KAAK,CAACN,WAAW,MAAM,GAAGO,QAAQ,CAAC,IAAIC,QAAQ,CAAC,GAAG,MAAM;QACpF,wEAAwE;QACxE,uDAAuD;QACvD,MAAMhC,KAAK4B,UAAU,IAAIC,QAAQ,GAAGA,MAAM,CAAC,EAAED,SAAS;QACtD,IAAI,CAACF,MAAMO,GAAG,CAACjC,KAAK,OAAOA;IAC7B;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASkC,qBACdf,KAAsC,EACtCK,MAAqB;IAErB,MAAMW,UAAUhB,MAAMiB,IAAI,CAAC,CAAC/B,OAASA,KAAKC,IAAI,KAAK;IACnD,OAAO;QACLN,IAAIuB,kBAAkBJ,OAAOK;QAC7BlB,MAAM;QACNH,mBAAmBgC,UAAUrD,kCAAkC;QAC/DyB,SAAS;QACTC,eAAe;QACfC,MAAM;QACNL,YAAY;IACd;AACF;AAEA,iEAAiE,GACjE,OAAO,SAASiC,oBACdlB,KAAsC,EACtCT,QAA0B,EAC1Bc,MAAqB;QAWZc;IATT,MAAMA,SAA2C;QAC/CC,UAAU;QACVC,MAAM;QACNC,MAAM;IACR;IACA,OAAO;QACLzC,IAAIuB,kBAAkBJ,OAAOK;QAC7BlB,MAAM;QACNI;QACAC,KAAK,GAAE2B,mBAAAA,MAAM,CAAC5B,SAAS,YAAhB4B,mBAAoB;QAC3BnC,mBAAmB;IACrB;AACF;AAEA,6EAA6E,GAC7E,OAAO,SAASuC,2BAA2B7B,KAK1C;QAIcA;IAHb,OAAO;QACLE,MAAM;QACNE,QAAQJ,MAAMI,MAAM;QACpBC,SAAS,GAAEL,mBAAAA,MAAMK,SAAS,YAAfL,mBAAmB;QAC9BM,OAAO;YAACe,qBAAqB,EAAE,EAAErB,MAAMW,MAAM;SAAE;QAC/CV,UAAU;YACRM,QAAQ;YACRuB,kBAAkB;mBAAI9B,MAAM8B,gBAAgB;aAAC;YAC7CC,gBAAgB;QAClB;IACF;AACF;AAkBA;;;CAGC,GACD,OAAO,SAASC,+BACdC,QAAuE,EACvEC,IAAmE;IAEnE,MAAMC,SAAkC,EAAE;IAC1C,MAAMC,SAAS,CAACC,MAAcC,MAAiCC,UAC7DJ,OAAOK,IAAI,CAAC;YAAEH;YAAMC;YAAMC;YAASE,UAAU;QAAQ;IACvD,MAAMC,OAAOT,SAAS3B,KAAK,CAACqC,KAAK,CAC/B,CAACnD,MAAMoD;YAAUV,mBAAqCA;eAArCA,EAAAA,oBAAAA,KAAK5B,KAAK,CAACsC,MAAM,qBAAjBV,kBAAmB/C,EAAE,MAAKK,KAAKL,EAAE,IAAI+C,EAAAA,qBAAAA,KAAK5B,KAAK,CAACsC,MAAM,qBAAjBV,mBAAmBzC,IAAI,MAAKD,KAAKC,IAAI;;IAE7F,IAAI,CAACiD,MAAM;QACTN,OACE,SACA,gBACA;IAEJ;IACA,IAAIH,SAAS7B,MAAM,KAAK8B,KAAK9B,MAAM,EAAE;QACnCgC,OAAO,UAAU,eAAe;IAClC;IACA,IAAIH,SAAS5B,SAAS,KAAK6B,KAAK7B,SAAS,EAAE;QACzC+B,OACE,aACA,kBACA;IAEJ;IACA,OAAOD;AACT;AAeA,OAAO,SAASU,6BACdxC,SAAiB,EACjByC,OAA2D;IAE3D,IAAI,CAACzC,WAAW,OAAO;IACvB,IAAI,CAACyC,WAAWA,QAAQC,MAAM,KAAK,gBAAgB,OAAO;IAC1D,IAAID,QAAQC,MAAM,KAAK,YAAYD,QAAQC,MAAM,KAAK,sBAAsB;QAC1E,OAAOD,QAAQC,MAAM;IACvB;IACA,OAAO;AACT;AAEA,oEAAoE,GACpE,MAAMC,4BAGF;IACFC,MAAM;QACJX,MAAM;QACNC,SAAS;IACX;IACAW,MAAM;QACJZ,MAAM;QACNC,SAAS;IACX;IACAY,QAAQ;QACNb,MAAM;QACNC,SAAS;IACX;IACAa,oBAAoB;QAClBd,MAAM;QACNC,SACE;IACJ;AACF;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASc,+BACdhD,SAAiB,EACjByC,OAA2D;IAE3D,MAAMQ,QAAQT,6BAA6BxC,WAAWyC;IACtD,IAAIQ,UAAU,WAAW,OAAO;IAChC,MAAM,EAAEhB,IAAI,EAAEC,OAAO,EAAE,GAAGS,yBAAyB,CAACM,MAAM;IAC1D,OAAO;QAAEjB,MAAM;QAAaC;QAAMC;QAASE,UAAU;IAAQ;AAC/D"}

package/src/lib/model/step-preview.d.ts

@@ -0,0 +1,45 @@
+/**
+ * @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.
+ */
+import type { CrmMergeContext } from '@aglyn/aglyn/app-utils/crm-email-templates';
+import { type OutreachComposeResult } from '../engine/compose';
+import type { OutreachOrgSettings, OutreachSequenceStep } from './outreach.types';
+/** The person a preview is written to when it names no contact. */
+export declare const OUTREACH_SAMPLE_PERSON: {
+    readonly name: "Casey Morgan";
+    readonly email: "casey.morgan@example.com";
+    readonly companyName: "Example Co";
+    readonly jobTitle: "Head of Operations";
+    readonly personalLine: "I saw Example Co just opened its second location.";
+};
+/** The merge context of the sample person, from the sender and site given. */
+export declare function outreachSampleMergeContext(input: {
+    sender?: CrmMergeContext['sender'];
+    siteName?: string | null;
+}): CrmMergeContext;
+export interface OutreachStepPreviewInput {
+    steps: readonly OutreachSequenceStep[];
+    stepIndex: number;
+    orgSettings: Pick<OutreachOrgSettings, 'legalName' | 'brandName' | 'postalAddress'> | null;
+    merge: CrmMergeContext;
+    /** The recipient's address. */
+    email: string;
+    personalLine: string;
+    /** The CRM template's body, when the step names a template. */
+    templateBody?: string | null;
+}
+/** The step's email, or why it can't be written — see the module note. */
+export declare function previewOutreachStep(input: OutreachStepPreviewInput): OutreachComposeResult;

package/src/lib/model/step-preview.js

@@ -0,0 +1,98 @@
+/**
+ * @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.
+ */ /*==========================================
+ * ONE STEP'S EMAIL, AS A PERSON WOULD GET IT (AGL-2980).
+ *
+ * The editor's live preview and the preview route both show an email
+ * before anyone is sent it, and both write it with the engine's own
+ * composer — the merge, the footer, the threading — so what the rep reads
+ * is what the runtime would send. Client-safe.
+ *
+ * A step later in the thread is sent as `Re:` the thread's subject, and the
+ * composer refuses to write one without a thread to answer. A preview has
+ * no thread, so it lends the composer one: the subject the thread would
+ * have been started with, rendered for the same person, and a placeholder
+ * message id that never leaves the preview.
+ *==========================================*/ import { resolveCrmMergeFields } from "@aglyn/aglyn/app-utils/crm-email-templates";
+import { composeOutreachEmail } from "../engine/compose.js";
+import { isInThreadEmailStep } from "../engine/sequence-validation.js";
+/** The holder id the sample person's facet is filed under. */ const SAMPLE_GROUP = 'outreach-preview';
+/** The person a preview is written to when it names no contact. */ export const OUTREACH_SAMPLE_PERSON = {
+    name: 'Casey Morgan',
+    email: 'casey.morgan@example.com',
+    companyName: 'Example Co',
+    jobTitle: 'Head of Operations',
+    personalLine: 'I saw Example Co just opened its second location.'
+};
+/** The merge context of the sample person, from the sender and site given. */ export function outreachSampleMergeContext(input) {
+    var _input_sender, _input_siteName;
+    return {
+        contact: {
+            name: OUTREACH_SAMPLE_PERSON.name,
+            email: OUTREACH_SAMPLE_PERSON.email,
+            facets: {
+                [SAMPLE_GROUP]: {
+                    companyName: OUTREACH_SAMPLE_PERSON.companyName,
+                    jobTitle: OUTREACH_SAMPLE_PERSON.jobTitle
+                }
+            }
+        },
+        contactGroupId: SAMPLE_GROUP,
+        sender: (_input_sender = input.sender) != null ? _input_sender : null,
+        site: {
+            name: (_input_siteName = input.siteName) != null ? _input_siteName : ''
+        }
+    };
+}
+/** The placeholder a preview lends the composer as the thread's last message. */ const PREVIEW_MESSAGE_ID = '<preview@outreach.invalid>';
+/** The step's email, or why it can't be written — see the module note. */ export function previewOutreachStep(input) {
+    var _input_templateBody;
+    const steps = [
+        ...input.steps
+    ];
+    let threadSubject = null;
+    if (isInThreadEmailStep(steps, input.stepIndex)) {
+        // The thread was started by the latest email before this one that did
+        // not itself reply in a thread.
+        for(let index = input.stepIndex - 1; index >= 0; index -= 1){
+            const step = steps[index];
+            if ((step == null ? void 0 : step.kind) === 'email' && !isInThreadEmailStep(steps, index)) {
+                threadSubject = resolveCrmMergeFields(step.subject, input.merge).text.trim() || null;
+                break;
+            }
+        }
+    }
+    return composeOutreachEmail({
+        sequence: {
+            steps
+        },
+        enrollment: {
+            email: input.email,
+            stepIndex: input.stepIndex,
+            personalLine: input.personalLine,
+            threadSubject,
+            messageIds: threadSubject ? [
+                PREVIEW_MESSAGE_ID
+            ] : [],
+            gmailThreadId: threadSubject ? 'preview' : null
+        },
+        orgSettings: input.orgSettings,
+        merge: input.merge,
+        templateBody: (_input_templateBody = input.templateBody) != null ? _input_templateBody : null
+    });
+}
+
+//# sourceMappingURL=step-preview.js.map

package/src/lib/model/step-preview.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/model/step-preview.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 * ONE STEP'S EMAIL, AS A PERSON WOULD GET IT (AGL-2980).\n *\n * The editor's live preview and the preview route both show an email\n * before anyone is sent it, and both write it with the engine's own\n * composer — the merge, the footer, the threading — so what the rep reads\n * is what the runtime would send. Client-safe.\n *\n * A step later in the thread is sent as `Re:` the thread's subject, and the\n * composer refuses to write one without a thread to answer. A preview has\n * no thread, so it lends the composer one: the subject the thread would\n * have been started with, rendered for the same person, and a placeholder\n * message id that never leaves the preview.\n *==========================================*/\n\nimport type { CrmMergeContext } from '@aglyn/aglyn/app-utils/crm-email-templates'\nimport { resolveCrmMergeFields } from '@aglyn/aglyn/app-utils/crm-email-templates'\nimport { composeOutreachEmail, type OutreachComposeResult } from '../engine/compose'\nimport { isInThreadEmailStep } from '../engine/sequence-validation'\nimport type { OutreachOrgSettings, OutreachSequenceStep } from './outreach.types'\n\n/** The holder id the sample person's facet is filed under. */\nconst SAMPLE_GROUP = 'outreach-preview'\n\n/** The person a preview is written to when it names no contact. */\nexport const OUTREACH_SAMPLE_PERSON = {\n  name: 'Casey Morgan',\n  email: 'casey.morgan@example.com',\n  companyName: 'Example Co',\n  jobTitle: 'Head of Operations',\n  personalLine: 'I saw Example Co just opened its second location.',\n} as const\n\n/** The merge context of the sample person, from the sender and site given. */\nexport function outreachSampleMergeContext(input: {\n  sender?: CrmMergeContext['sender']\n  siteName?: string | null\n}): CrmMergeContext {\n  return {\n    contact: {\n      name: OUTREACH_SAMPLE_PERSON.name,\n      email: OUTREACH_SAMPLE_PERSON.email,\n      facets: {\n        [SAMPLE_GROUP]: {\n          companyName: OUTREACH_SAMPLE_PERSON.companyName,\n          jobTitle: OUTREACH_SAMPLE_PERSON.jobTitle,\n        },\n      },\n    },\n    contactGroupId: SAMPLE_GROUP,\n    sender: input.sender ?? null,\n    site: { name: input.siteName ?? '' },\n  }\n}\n\n/** The placeholder a preview lends the composer as the thread's last message. */\nconst PREVIEW_MESSAGE_ID = '<preview@outreach.invalid>'\n\nexport interface OutreachStepPreviewInput {\n  steps: readonly OutreachSequenceStep[]\n  stepIndex: number\n  orgSettings: Pick<OutreachOrgSettings, 'legalName' | 'brandName' | 'postalAddress'> | null\n  merge: CrmMergeContext\n  /** The recipient's address. */\n  email: string\n  personalLine: string\n  /** The CRM template's body, when the step names a template. */\n  templateBody?: string | null\n}\n\n/** The step's email, or why it can't be written — see the module note. */\nexport function previewOutreachStep(input: OutreachStepPreviewInput): OutreachComposeResult {\n  const steps = [...input.steps]\n  let threadSubject: string | null = null\n  if (isInThreadEmailStep(steps, input.stepIndex)) {\n    // The thread was started by the latest email before this one that did\n    // not itself reply in a thread.\n    for (let index = input.stepIndex - 1; index >= 0; index -= 1) {\n      const step = steps[index]\n      if (step?.kind === 'email' && !isInThreadEmailStep(steps, index)) {\n        threadSubject = resolveCrmMergeFields(step.subject, input.merge).text.trim() || null\n        break\n      }\n    }\n  }\n  return composeOutreachEmail({\n    sequence: { steps },\n    enrollment: {\n      email: input.email,\n      stepIndex: input.stepIndex,\n      personalLine: input.personalLine,\n      threadSubject,\n      messageIds: threadSubject ? [PREVIEW_MESSAGE_ID] : [],\n      gmailThreadId: threadSubject ? 'preview' : null,\n    },\n    orgSettings: input.orgSettings,\n    merge: input.merge,\n    templateBody: input.templateBody ?? null,\n  })\n}\n"],"names":["resolveCrmMergeFields","composeOutreachEmail","isInThreadEmailStep","SAMPLE_GROUP","OUTREACH_SAMPLE_PERSON","name","email","companyName","jobTitle","personalLine","outreachSampleMergeContext","input","contact","facets","contactGroupId","sender","site","siteName","PREVIEW_MESSAGE_ID","previewOutreachStep","steps","threadSubject","stepIndex","index","step","kind","subject","merge","text","trim","sequence","enrollment","messageIds","gmailThreadId","orgSettings","templateBody"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;;;;;;;4CAa4C,GAG5C,SAASA,qBAAqB,QAAQ,6CAA4C;AAClF,SAASC,oBAAoB,QAAoC,uBAAmB;AACpF,SAASC,mBAAmB,QAAQ,mCAA+B;AAGnE,4DAA4D,GAC5D,MAAMC,eAAe;AAErB,iEAAiE,GACjE,OAAO,MAAMC,yBAAyB;IACpCC,MAAM;IACNC,OAAO;IACPC,aAAa;IACbC,UAAU;IACVC,cAAc;AAChB,EAAU;AAEV,4EAA4E,GAC5E,OAAO,SAASC,2BAA2BC,KAG1C;QAaWA,eACMA;IAbhB,OAAO;QACLC,SAAS;YACPP,MAAMD,uBAAuBC,IAAI;YACjCC,OAAOF,uBAAuBE,KAAK;YACnCO,QAAQ;gBACN,CAACV,aAAa,EAAE;oBACdI,aAAaH,uBAAuBG,WAAW;oBAC/CC,UAAUJ,uBAAuBI,QAAQ;gBAC3C;YACF;QACF;QACAM,gBAAgBX;QAChBY,MAAM,GAAEJ,gBAAAA,MAAMI,MAAM,YAAZJ,gBAAgB;QACxBK,MAAM;YAAEX,IAAI,GAAEM,kBAAAA,MAAMM,QAAQ,YAAdN,kBAAkB;QAAG;IACrC;AACF;AAEA,+EAA+E,GAC/E,MAAMO,qBAAqB;AAc3B,wEAAwE,GACxE,OAAO,SAASC,oBAAoBR,KAA+B;QA0BjDA;IAzBhB,MAAMS,QAAQ;WAAIT,MAAMS,KAAK;KAAC;IAC9B,IAAIC,gBAA+B;IACnC,IAAInB,oBAAoBkB,OAAOT,MAAMW,SAAS,GAAG;QAC/C,sEAAsE;QACtE,gCAAgC;QAChC,IAAK,IAAIC,QAAQZ,MAAMW,SAAS,GAAG,GAAGC,SAAS,GAAGA,SAAS,EAAG;YAC5D,MAAMC,OAAOJ,KAAK,CAACG,MAAM;YACzB,IAAIC,CAAAA,wBAAAA,KAAMC,IAAI,MAAK,WAAW,CAACvB,oBAAoBkB,OAAOG,QAAQ;gBAChEF,gBAAgBrB,sBAAsBwB,KAAKE,OAAO,EAAEf,MAAMgB,KAAK,EAAEC,IAAI,CAACC,IAAI,MAAM;gBAChF;YACF;QACF;IACF;IACA,OAAO5B,qBAAqB;QAC1B6B,UAAU;YAAEV;QAAM;QAClBW,YAAY;YACVzB,OAAOK,MAAML,KAAK;YAClBgB,WAAWX,MAAMW,SAAS;YAC1Bb,cAAcE,MAAMF,YAAY;YAChCY;YACAW,YAAYX,gBAAgB;gBAACH;aAAmB,GAAG,EAAE;YACrDe,eAAeZ,gBAAgB,YAAY;QAC7C;QACAa,aAAavB,MAAMuB,WAAW;QAC9BP,OAAOhB,MAAMgB,KAAK;QAClBQ,YAAY,GAAExB,sBAAAA,MAAMwB,YAAY,YAAlBxB,sBAAsB;IACtC;AACF"}

package/src/lib/model/stored-records.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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.
+ */
+import { type OutreachEnrollment, type OutreachMailbox, type OutreachSequence } from './outreach.types';
+/** A stored sequence in its model shape, or `null` for no document. */
+export declare function readStoredOutreachSequence(id: string, data: Record<string, unknown> | undefined): OutreachSequence | null;
+/** A stored enrollment in its model shape, or `null` for no document. */
+export declare function readStoredOutreachEnrollment(id: string, data: Record<string, unknown> | undefined): OutreachEnrollment | null;
+/** A stored mailbox with its id, or `null` for no document. */
+export declare function readStoredOutreachMailbox(id: string, data: Record<string, unknown> | undefined): OutreachMailbox | null;

package/src/lib/model/stored-records.js

@@ -0,0 +1,84 @@
+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.
+ */ /**
+ * A stored Outreach document read back into its model shape (AGL-2980),
+ * for the server's routes and the console's listeners alike. Client-safe.
+ *
+ * Read DEFENSIVELY, a field at a time, because the readers act on what they
+ * read: a sequence's steps are what gets sent, and an enrollment's status is
+ * what decides whether it is sent at all.
+ */ import { readOutreachSequenceDraft } from "./sequence-draft.js";
+import { OUTREACH_ENROLLMENT_STATUSES, OUTREACH_SEQUENCE_STATUSES, OUTREACH_STOP_REASONS } from "./outreach.types.js";
+const text = (value)=>typeof value === 'string' ? value : '';
+const ms = (value)=>typeof value === 'number' && Number.isFinite(value) ? value : null;
+const texts = (value)=>Array.isArray(value) ? value.filter((entry)=>typeof entry === 'string') : [];
+/** A stored sequence in its model shape, or `null` for no document. */ export function readStoredOutreachSequence(id, data) {
+    var _ms, _ms1;
+    if (!data) return null;
+    const draft = readOutreachSequenceDraft(data);
+    const status = data['status'];
+    return _extends({
+        id
+    }, draft, {
+        status: OUTREACH_SEQUENCE_STATUSES.includes(status) ? status : 'draft',
+        createdAtMs: (_ms = ms(data['createdAtMs'])) != null ? _ms : 0,
+        updatedAtMs: (_ms1 = ms(data['updatedAtMs'])) != null ? _ms1 : 0
+    });
+}
+/** A stored enrollment in its model shape, or `null` for no document. */ export function readStoredOutreachEnrollment(id, data) {
+    var _ms, _ms1;
+    if (!data) return null;
+    const status = data['status'];
+    const stopReason = data['stopReason'];
+    const stepIndex = Number(data['stepIndex']);
+    return _extends({}, data, {
+        id,
+        sequenceId: text(data['sequenceId']),
+        contactId: text(data['contactId']),
+        contactName: text(data['contactName']),
+        email: text(data['email']),
+        hostId: text(data['hostId']),
+        mailboxId: text(data['mailboxId']),
+        stepIndex: Number.isInteger(stepIndex) && stepIndex >= 0 ? stepIndex : 0,
+        nextDueAtMs: ms(data['nextDueAtMs']),
+        // A status the model does not name is read as stopped: nothing sends
+        // from a document nobody can say the state of.
+        status: OUTREACH_ENROLLMENT_STATUSES.includes(status) ? status : 'stopped',
+        stopReason: OUTREACH_STOP_REASONS.includes(stopReason) ? stopReason : null,
+        stopDetail: typeof data['stopDetail'] === 'string' ? data['stopDetail'] : null,
+        stoppedAtMs: ms(data['stoppedAtMs']),
+        stoppedByUid: typeof data['stoppedByUid'] === 'string' ? data['stoppedByUid'] : null,
+        personalLine: text(data['personalLine']),
+        cold: data['cold'] === true,
+        enrolledByUid: text(data['enrolledByUid']),
+        gmailThreadId: typeof data['gmailThreadId'] === 'string' ? data['gmailThreadId'] : null,
+        gmailThreadIds: texts(data['gmailThreadIds']),
+        threadSubject: typeof data['threadSubject'] === 'string' ? data['threadSubject'] : null,
+        messageIds: texts(data['messageIds']),
+        lastSentAtMs: ms(data['lastSentAtMs']),
+        createdAtMs: (_ms = ms(data['createdAtMs'])) != null ? _ms : 0,
+        updatedAtMs: (_ms1 = ms(data['updatedAtMs'])) != null ? _ms1 : 0
+    });
+}
+/** A stored mailbox with its id, or `null` for no document. */ export function readStoredOutreachMailbox(id, data) {
+    if (!data) return null;
+    return _extends({}, data, {
+        id
+    });
+}
+
+//# sourceMappingURL=stored-records.js.map

package/src/lib/model/stored-records.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/model/stored-records.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 * A stored Outreach document read back into its model shape (AGL-2980),\n * for the server's routes and the console's listeners alike. Client-safe.\n *\n * Read DEFENSIVELY, a field at a time, because the readers act on what they\n * read: a sequence's steps are what gets sent, and an enrollment's status is\n * what decides whether it is sent at all.\n */\n\nimport { readOutreachSequenceDraft } from './sequence-draft'\nimport {\n  OUTREACH_ENROLLMENT_STATUSES,\n  OUTREACH_SEQUENCE_STATUSES,\n  OUTREACH_STOP_REASONS,\n  type OutreachEnrollment,\n  type OutreachEnrollmentStatus,\n  type OutreachMailbox,\n  type OutreachSequence,\n  type OutreachSequenceStatus,\n  type OutreachStopReason,\n} from './outreach.types'\n\nconst text = (value: unknown): string =>\n  typeof value === 'string' ? value : ''\nconst ms = (value: unknown): number | null =>\n  typeof value === 'number' && Number.isFinite(value) ? value : null\nconst texts = (value: unknown): string[] =>\n  Array.isArray(value)\n    ? value.filter((entry): entry is string => typeof entry === 'string')\n    : []\n\n/** A stored sequence in its model shape, or `null` for no document. */\nexport function readStoredOutreachSequence(\n  id: string,\n  data: Record<string, unknown> | undefined,\n): OutreachSequence | null {\n  if (!data) return null\n  const draft = readOutreachSequenceDraft(data)\n  const status = data['status']\n  return {\n    id,\n    ...draft,\n    status: (OUTREACH_SEQUENCE_STATUSES as readonly unknown[]).includes(status)\n      ? (status as OutreachSequenceStatus)\n      : 'draft',\n    createdAtMs: ms(data['createdAtMs']) ?? 0,\n    updatedAtMs: ms(data['updatedAtMs']) ?? 0,\n  }\n}\n\n/** A stored enrollment in its model shape, or `null` for no document. */\nexport function readStoredOutreachEnrollment(\n  id: string,\n  data: Record<string, unknown> | undefined,\n): OutreachEnrollment | null {\n  if (!data) return null\n  const status = data['status']\n  const stopReason = data['stopReason']\n  const stepIndex = Number(data['stepIndex'])\n  return {\n    ...(data as unknown as OutreachEnrollment),\n    id,\n    sequenceId: text(data['sequenceId']),\n    contactId: text(data['contactId']),\n    contactName: text(data['contactName']),\n    email: text(data['email']),\n    hostId: text(data['hostId']),\n    mailboxId: text(data['mailboxId']),\n    stepIndex: Number.isInteger(stepIndex) && stepIndex >= 0 ? stepIndex : 0,\n    nextDueAtMs: ms(data['nextDueAtMs']),\n    // A status the model does not name is read as stopped: nothing sends\n    // from a document nobody can say the state of.\n    status: (OUTREACH_ENROLLMENT_STATUSES as readonly unknown[]).includes(\n      status,\n    )\n      ? (status as OutreachEnrollmentStatus)\n      : 'stopped',\n    stopReason: (OUTREACH_STOP_REASONS as readonly unknown[]).includes(\n      stopReason,\n    )\n      ? (stopReason as OutreachStopReason)\n      : null,\n    stopDetail:\n      typeof data['stopDetail'] === 'string' ? data['stopDetail'] : null,\n    stoppedAtMs: ms(data['stoppedAtMs']),\n    stoppedByUid:\n      typeof data['stoppedByUid'] === 'string' ? data['stoppedByUid'] : null,\n    personalLine: text(data['personalLine']),\n    cold: data['cold'] === true,\n    enrolledByUid: text(data['enrolledByUid']),\n    gmailThreadId:\n      typeof data['gmailThreadId'] === 'string' ? data['gmailThreadId'] : null,\n    gmailThreadIds: texts(data['gmailThreadIds']),\n    threadSubject:\n      typeof data['threadSubject'] === 'string' ? data['threadSubject'] : null,\n    messageIds: texts(data['messageIds']),\n    lastSentAtMs: ms(data['lastSentAtMs']),\n    createdAtMs: ms(data['createdAtMs']) ?? 0,\n    updatedAtMs: ms(data['updatedAtMs']) ?? 0,\n  }\n}\n\n/** A stored mailbox with its id, or `null` for no document. */\nexport function readStoredOutreachMailbox(\n  id: string,\n  data: Record<string, unknown> | undefined,\n): OutreachMailbox | null {\n  if (!data) return null\n  return { ...(data as unknown as OutreachMailbox), id }\n}\n"],"names":["readOutreachSequenceDraft","OUTREACH_ENROLLMENT_STATUSES","OUTREACH_SEQUENCE_STATUSES","OUTREACH_STOP_REASONS","text","value","ms","Number","isFinite","texts","Array","isArray","filter","entry","readStoredOutreachSequence","id","data","draft","status","includes","createdAtMs","updatedAtMs","readStoredOutreachEnrollment","stopReason","stepIndex","sequenceId","contactId","contactName","email","hostId","mailboxId","isInteger","nextDueAtMs","stopDetail","stoppedAtMs","stoppedByUid","personalLine","cold","enrolledByUid","gmailThreadId","gmailThreadIds","threadSubject","messageIds","lastSentAtMs","readStoredOutreachMailbox"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED;;;;;;;CAOC,GAED,SAASA,yBAAyB,QAAQ,sBAAkB;AAC5D,SACEC,4BAA4B,EAC5BC,0BAA0B,EAC1BC,qBAAqB,QAOhB,sBAAkB;AAEzB,MAAMC,OAAO,CAACC,QACZ,OAAOA,UAAU,WAAWA,QAAQ;AACtC,MAAMC,KAAK,CAACD,QACV,OAAOA,UAAU,YAAYE,OAAOC,QAAQ,CAACH,SAASA,QAAQ;AAChE,MAAMI,QAAQ,CAACJ,QACbK,MAAMC,OAAO,CAACN,SACVA,MAAMO,MAAM,CAAC,CAACC,QAA2B,OAAOA,UAAU,YAC1D,EAAE;AAER,qEAAqE,GACrE,OAAO,SAASC,2BACdC,EAAU,EACVC,IAAyC;QAW1BV,KACAA;IAVf,IAAI,CAACU,MAAM,OAAO;IAClB,MAAMC,QAAQjB,0BAA0BgB;IACxC,MAAME,SAASF,IAAI,CAAC,SAAS;IAC7B,OAAO;QACLD;OACGE;QACHC,QAAQ,AAAChB,2BAAkDiB,QAAQ,CAACD,UAC/DA,SACD;QACJE,WAAW,GAAEd,MAAAA,GAAGU,IAAI,CAAC,cAAc,aAAtBV,MAA2B;QACxCe,WAAW,GAAEf,OAAAA,GAAGU,IAAI,CAAC,cAAc,aAAtBV,OAA2B;;AAE5C;AAEA,uEAAuE,GACvE,OAAO,SAASgB,6BACdP,EAAU,EACVC,IAAyC;QA4C1BV,KACAA;IA3Cf,IAAI,CAACU,MAAM,OAAO;IAClB,MAAME,SAASF,IAAI,CAAC,SAAS;IAC7B,MAAMO,aAAaP,IAAI,CAAC,aAAa;IACrC,MAAMQ,YAAYjB,OAAOS,IAAI,CAAC,YAAY;IAC1C,OAAO,aACDA;QACJD;QACAU,YAAYrB,KAAKY,IAAI,CAAC,aAAa;QACnCU,WAAWtB,KAAKY,IAAI,CAAC,YAAY;QACjCW,aAAavB,KAAKY,IAAI,CAAC,cAAc;QACrCY,OAAOxB,KAAKY,IAAI,CAAC,QAAQ;QACzBa,QAAQzB,KAAKY,IAAI,CAAC,SAAS;QAC3Bc,WAAW1B,KAAKY,IAAI,CAAC,YAAY;QACjCQ,WAAWjB,OAAOwB,SAAS,CAACP,cAAcA,aAAa,IAAIA,YAAY;QACvEQ,aAAa1B,GAAGU,IAAI,CAAC,cAAc;QACnC,qEAAqE;QACrE,+CAA+C;QAC/CE,QAAQ,AAACjB,6BAAoDkB,QAAQ,CACnED,UAEGA,SACD;QACJK,YAAY,AAACpB,sBAA6CgB,QAAQ,CAChEI,cAEGA,aACD;QACJU,YACE,OAAOjB,IAAI,CAAC,aAAa,KAAK,WAAWA,IAAI,CAAC,aAAa,GAAG;QAChEkB,aAAa5B,GAAGU,IAAI,CAAC,cAAc;QACnCmB,cACE,OAAOnB,IAAI,CAAC,eAAe,KAAK,WAAWA,IAAI,CAAC,eAAe,GAAG;QACpEoB,cAAchC,KAAKY,IAAI,CAAC,eAAe;QACvCqB,MAAMrB,IAAI,CAAC,OAAO,KAAK;QACvBsB,eAAelC,KAAKY,IAAI,CAAC,gBAAgB;QACzCuB,eACE,OAAOvB,IAAI,CAAC,gBAAgB,KAAK,WAAWA,IAAI,CAAC,gBAAgB,GAAG;QACtEwB,gBAAgB/B,MAAMO,IAAI,CAAC,iBAAiB;QAC5CyB,eACE,OAAOzB,IAAI,CAAC,gBAAgB,KAAK,WAAWA,IAAI,CAAC,gBAAgB,GAAG;QACtE0B,YAAYjC,MAAMO,IAAI,CAAC,aAAa;QACpC2B,cAAcrC,GAAGU,IAAI,CAAC,eAAe;QACrCI,WAAW,GAAEd,MAAAA,GAAGU,IAAI,CAAC,cAAc,aAAtBV,MAA2B;QACxCe,WAAW,GAAEf,OAAAA,GAAGU,IAAI,CAAC,cAAc,aAAtBV,OAA2B;;AAE5C;AAEA,6DAA6D,GAC7D,OAAO,SAASsC,0BACd7B,EAAU,EACVC,IAAyC;IAEzC,IAAI,CAACA,MAAM,OAAO;IAClB,OAAO,aAAMA;QAAqCD;;AACpD"}

package/src/lib/plugin.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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.
+ */
+/**
+ * The console half of this plugin (AGL-2974), named in `plugins.config.json`
+ * as `console`. Console and console API only, like the CRM: a sequence has no
+ * canvas element, so there is no site bundle and no tenant half.
+ *
+ * THE NAME PEOPLE READ IS "SEQUENCES" (AGL-3199); the plugin id, the lib, the
+ * package, the flag, the entitlement, the permission, the collections and the
+ * API prefix all stay `outreach`. Renaming those would move stored data and
+ * break the unsubscribe links already sent, and no reader sees them.
+ *
+ * ONE ORGANIZATION-LEVEL SURFACE. Sequences are a rep's work across every site
+ * the organization sells for, sent from that rep's own mailbox, so they live
+ * beside the organization's other tabs rather than under a site. It is
+ * declared in `orgNavItems`, which the console serves at
+ * `/[orgSlug]/outreach/<section>` through its generic org route.
+ *
+ * THREE GATES, each answered by the shell, never by this page:
+ *
+ * - the RELEASE flag `release_outreach`, reached through the nav item's
+ *   `navTabId` — off by default, so only staff preview it;
+ * - the ENTITLEMENT `features.outreach`, which no plan carries, so an
+ *   organization has it only through its per-org override;
+ * - the PERMISSION `outreach.use`, which owners and admins hold by default.
+ *
+ * The org tab strip hides the tab unless all three hold. A deep link is
+ * answered by the route with the refusal that applies, and the words for the
+ * entitlement one are this extension's own: the shell's derived sentence
+ * calls a feature no plan carries "a paid add-on", which this is not.
+ */
+export declare function registerOutreachConsole(): void;

package/src/lib/plugin.js

@@ -0,0 +1,86 @@
+/**
+ * @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.
+ */ import { registerConsoleExtension, registerPluginPermissions } from "@aglyn/aglyn";
+import { mdiEmailFastOutline } from "@aglyn/shared-data-mdi";
+import { lazy } from "react";
+import { OUTREACH_CONSOLE_SECTIONS } from "./components/outreach-console-sections.js";
+import { OUTREACH_PERMISSIONS, OUTREACH_PLUGIN_ID, OUTREACH_USE_PERMISSION } from "./constants/bundle-common.js";
+/** Code-split: the hub only loads when opened. */ const OutreachConsolePage = lazy(()=>import("./components/outreach-console-page.js"));
+/**
+ * The console half of this plugin (AGL-2974), named in `plugins.config.json`
+ * as `console`. Console and console API only, like the CRM: a sequence has no
+ * canvas element, so there is no site bundle and no tenant half.
+ *
+ * THE NAME PEOPLE READ IS "SEQUENCES" (AGL-3199); the plugin id, the lib, the
+ * package, the flag, the entitlement, the permission, the collections and the
+ * API prefix all stay `outreach`. Renaming those would move stored data and
+ * break the unsubscribe links already sent, and no reader sees them.
+ *
+ * ONE ORGANIZATION-LEVEL SURFACE. Sequences are a rep's work across every site
+ * the organization sells for, sent from that rep's own mailbox, so they live
+ * beside the organization's other tabs rather than under a site. It is
+ * declared in `orgNavItems`, which the console serves at
+ * `/[orgSlug]/outreach/<section>` through its generic org route.
+ *
+ * THREE GATES, each answered by the shell, never by this page:
+ *
+ * - the RELEASE flag `release_outreach`, reached through the nav item's
+ *   `navTabId` — off by default, so only staff preview it;
+ * - the ENTITLEMENT `features.outreach`, which no plan carries, so an
+ *   organization has it only through its per-org override;
+ * - the PERMISSION `outreach.use`, which owners and admins hold by default.
+ *
+ * The org tab strip hides the tab unless all three hold. A deep link is
+ * answered by the route with the refusal that applies, and the words for the
+ * entitlement one are this extension's own: the shell's derived sentence
+ * calls a feature no plan carries "a paid add-on", which this is not.
+ */ export function registerOutreachConsole() {
+    registerPluginPermissions(OUTREACH_PERMISSIONS);
+    registerConsoleExtension({
+        pluginId: OUTREACH_PLUGIN_ID,
+        displayName: 'Sequences',
+        permission: OUTREACH_USE_PERMISSION,
+        featureFlag: 'outreach',
+        upgradeNotice: {
+            message: "Sequences isn't available to this workspace yet."
+        },
+        orgNavItems: [
+            {
+                label: 'Sequences',
+                // The URL slug stays `outreach`: it is the plugin id the console
+                // resolves the surface by, and `PLUGIN_TITLES` carries the name.
+                href: '/outreach',
+                sections: OUTREACH_CONSOLE_SECTIONS,
+                // The release flag's tab id: `release_outreach` names it, and the org
+                // strip hides the tab from customers while the flag is off.
+                navTabId: 'nav-tab-org-outreach',
+                icon: {
+                    path: mdiEmailFastOutline.path
+                },
+                header: {
+                    title: 'Sequences',
+                    icon: {
+                        path: mdiEmailFastOutline.path
+                    },
+                    docsTopic: 'sequences'
+                },
+                Component: OutreachConsolePage
+            }
+        ]
+    });
+}
+
+//# sourceMappingURL=plugin.js.map

package/src/lib/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../libs/plugins/outreach/src/lib/plugin.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\nimport {\n  registerConsoleExtension,\n  registerPluginPermissions,\n} from '@aglyn/aglyn'\nimport { mdiEmailFastOutline } from '@aglyn/shared-data-mdi'\nimport { lazy } from 'react'\nimport { OUTREACH_CONSOLE_SECTIONS } from './components/outreach-console-sections'\nimport {\n  OUTREACH_PERMISSIONS,\n  OUTREACH_PLUGIN_ID,\n  OUTREACH_USE_PERMISSION,\n} from './constants/bundle-common'\n\n/** Code-split: the hub only loads when opened. */\nconst OutreachConsolePage = lazy(\n  () => import('./components/outreach-console-page'),\n)\n\n/**\n * The console half of this plugin (AGL-2974), named in `plugins.config.json`\n * as `console`. Console and console API only, like the CRM: a sequence has no\n * canvas element, so there is no site bundle and no tenant half.\n *\n * THE NAME PEOPLE READ IS \"SEQUENCES\" (AGL-3199); the plugin id, the lib, the\n * package, the flag, the entitlement, the permission, the collections and the\n * API prefix all stay `outreach`. Renaming those would move stored data and\n * break the unsubscribe links already sent, and no reader sees them.\n *\n * ONE ORGANIZATION-LEVEL SURFACE. Sequences are a rep's work across every site\n * the organization sells for, sent from that rep's own mailbox, so they live\n * beside the organization's other tabs rather than under a site. It is\n * declared in `orgNavItems`, which the console serves at\n * `/[orgSlug]/outreach/<section>` through its generic org route.\n *\n * THREE GATES, each answered by the shell, never by this page:\n *\n * - the RELEASE flag `release_outreach`, reached through the nav item's\n *   `navTabId` — off by default, so only staff preview it;\n * - the ENTITLEMENT `features.outreach`, which no plan carries, so an\n *   organization has it only through its per-org override;\n * - the PERMISSION `outreach.use`, which owners and admins hold by default.\n *\n * The org tab strip hides the tab unless all three hold. A deep link is\n * answered by the route with the refusal that applies, and the words for the\n * entitlement one are this extension's own: the shell's derived sentence\n * calls a feature no plan carries \"a paid add-on\", which this is not.\n */\nexport function registerOutreachConsole(): void {\n  registerPluginPermissions(OUTREACH_PERMISSIONS)\n  registerConsoleExtension({\n    pluginId: OUTREACH_PLUGIN_ID,\n    displayName: 'Sequences',\n    permission: OUTREACH_USE_PERMISSION,\n    featureFlag: 'outreach',\n    upgradeNotice: {\n      message: \"Sequences isn't available to this workspace yet.\",\n    },\n    orgNavItems: [\n      {\n        label: 'Sequences',\n        // The URL slug stays `outreach`: it is the plugin id the console\n        // resolves the surface by, and `PLUGIN_TITLES` carries the name.\n        href: '/outreach',\n        sections: OUTREACH_CONSOLE_SECTIONS,\n        // The release flag's tab id: `release_outreach` names it, and the org\n        // strip hides the tab from customers while the flag is off.\n        navTabId: 'nav-tab-org-outreach',\n        icon: { path: mdiEmailFastOutline.path },\n        header: {\n          title: 'Sequences',\n          icon: { path: mdiEmailFastOutline.path },\n          docsTopic: 'sequences',\n        },\n        Component: OutreachConsolePage,\n      },\n    ],\n  })\n}\n"],"names":["registerConsoleExtension","registerPluginPermissions","mdiEmailFastOutline","lazy","OUTREACH_CONSOLE_SECTIONS","OUTREACH_PERMISSIONS","OUTREACH_PLUGIN_ID","OUTREACH_USE_PERMISSION","OutreachConsolePage","registerOutreachConsole","pluginId","displayName","permission","featureFlag","upgradeNotice","message","orgNavItems","label","href","sections","navTabId","icon","path","header","title","docsTopic","Component"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SACEA,wBAAwB,EACxBC,yBAAyB,QACpB,eAAc;AACrB,SAASC,mBAAmB,QAAQ,yBAAwB;AAC5D,SAASC,IAAI,QAAQ,QAAO;AAC5B,SAASC,yBAAyB,QAAQ,4CAAwC;AAClF,SACEC,oBAAoB,EACpBC,kBAAkB,EAClBC,uBAAuB,QAClB,+BAA2B;AAElC,gDAAgD,GAChD,MAAMC,sBAAsBL,KAC1B,IAAM,MAAM,CAAC;AAGf;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BC,GACD,OAAO,SAASM;IACdR,0BAA0BI;IAC1BL,yBAAyB;QACvBU,UAAUJ;QACVK,aAAa;QACbC,YAAYL;QACZM,aAAa;QACbC,eAAe;YACbC,SAAS;QACX;QACAC,aAAa;YACX;gBACEC,OAAO;gBACP,iEAAiE;gBACjE,iEAAiE;gBACjEC,MAAM;gBACNC,UAAUf;gBACV,sEAAsE;gBACtE,4DAA4D;gBAC5DgB,UAAU;gBACVC,MAAM;oBAAEC,MAAMpB,oBAAoBoB,IAAI;gBAAC;gBACvCC,QAAQ;oBACNC,OAAO;oBACPH,MAAM;wBAAEC,MAAMpB,oBAAoBoB,IAAI;oBAAC;oBACvCG,WAAW;gBACb;gBACAC,WAAWlB;YACb;SACD;IACH;AACF"}

package/src/lib/routes/enroll-routes.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @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.
+ */
+import type { PluginWebApiHandler } from '@aglyn/aglyn/server';
+import { type OutreachRouteDeps } from './route-deps';
+import { type OutreachRouteExtraPermission } from './route-gate';
+/**
+ * ENROLLING PEOPLE IN A SEQUENCE (AGL-2980): `outreach/enroll/preview` and
+ * `outreach/enroll`.
+ *
+ * The preview reads the people a saved Contacts view or a search named —
+ * at most {@link OUTREACH_ENROLL_BATCH_MAX} — and says where each stands:
+ * eligible, blocked with the gate's own sentence, or waiting on the rep for
+ * a personal line and the attestations only they can make. Confirm reads
+ * everything again and asks the gates again with what the rep supplied,
+ * because a preview is a picture of a moment: someone can unsubscribe
+ * between the two, and a request can claim anything. Nothing the preview
+ * answered is trusted by the enroll.
+ *
+ * Both read the CRM's people, so both ask for `data.manage` beside
+ * `outreach.use` — the permission the contacts' own rules read with, so
+ * Outreach is no side door into the address book.
+ *
+ * Only an ACTIVE sequence takes people: enrolling schedules the first step
+ * in the mailbox's hours, and a draft's steps and a paused sequence's timing
+ * are not yet what will be sent.
+ */
+/** The permission enrolling reads the CRM with. */
+export declare const OUTREACH_READS_PEOPLE: OutreachRouteExtraPermission;
+/** Everything enrolling reaches beyond the routes' own dependencies. */
+export interface OutreachEnrollRouteDeps extends OutreachRouteDeps {
+    /**
+     * The addresses a saved Contacts view selects among one site's contacts,
+     * read the way the dynamic-list sweep reads one, and whether the read
+     * reached the whole view before its budget.
+     */
+    crmViewEmails(input: {
+        hostId: string;
+        viewId: string;
+    }): Promise<{
+        emails: string[];
+        complete: boolean;
+    }>;
+}
+export interface OutreachEnrollRoutes {
+    preview: PluginWebApiHandler;
+    confirm: PluginWebApiHandler;
+}
+/** The activity line an enroll writes. */
+export declare function outreachEnrolledActivity(count: number): string;
+export declare function createOutreachEnrollRoutes(deps: OutreachEnrollRouteDeps): OutreachEnrollRoutes;