@aglyn/plugins-outreach 1.0.0-beta.220 → 1.0.0-beta.222

package/src/lib/testing/stand-in-record-system.js

@@ -0,0 +1,243 @@
+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.
+ */ import { personKey } from "@aglyn/aglyn/app-utils/person-key";
+import { scopeTokensForHost, seenOnlyThroughGrant, visibleToHost } from "@aglyn/aglyn/app-utils/scope-tokens";
+import { registerPluginPersonRecords } from "@aglyn/aglyn/plugin-manager/plugin-person-records";
+import { registerPluginRecordEmailStateWriter } from "@aglyn/aglyn/plugin-manager/plugin-record-email-state";
+import { registerPluginRecordIndex } from "@aglyn/aglyn/plugin-manager/plugin-record-index";
+import { FieldValue } from "firebase-admin/firestore";
+const KIND_STORED_IN = {
+    contact: 'contacts',
+    lead: 'leads'
+};
+const email = (value)=>{
+    const text = String(value != null ? value : '').trim().toLowerCase();
+    return text.includes('@') ? text : null;
+};
+export function standInRecordSystem(options) {
+    const org = (orgId)=>options.firestore().collection('orgs').doc(orgId);
+    const person = (kind, snapshot)=>{
+        var _snapshot_data;
+        const data = (_snapshot_data = snapshot.data()) != null ? _snapshot_data : {};
+        return {
+            kind,
+            id: snapshot.id,
+            email: email(data['email']),
+            data
+        };
+    };
+    const leadStatus = (lead)=>{
+        var _lead_status;
+        return String((_lead_status = lead['status']) != null ? _lead_status : 'new');
+    };
+    const moveLeads = async (request, from, to)=>{
+        let moved = 0;
+        for (const address of request.emails){
+            const key = personKey(address);
+            if (!key) continue;
+            const ref = org(request.orgId).collection('leads').doc(key);
+            const lead = (await ref.get()).data();
+            if (!lead || lead['convertedContactId']) continue;
+            if (!visibleToHost(lead['visibleTo'], request.hostId)) continue;
+            if (!from.includes(leadStatus(lead))) continue;
+            await ref.set({
+                status: to
+            }, {
+                merge: true
+            });
+            moved += 1;
+        }
+        return {
+            records: moved
+        };
+    };
+    registerPluginPersonRecords({
+        async find (request) {
+            var _request_orgId;
+            const address = email(request.email);
+            const orgId = String((_request_orgId = request.orgId) != null ? _request_orgId : '');
+            if (!address || !orgId) return null;
+            const found = (await org(orgId).collection('contacts').where('email', '==', address).limit(1).get()).docs[0];
+            if (found) {
+                const visible = !request.onlyVisibleToSite || visibleToHost(found.get('visibleTo'), String(request.hostId));
+                return visible ? person('contact', found) : null;
+            }
+            if (!request.anyKind) return null;
+            const lead = await org(orgId).collection('leads').doc(String(personKey(address))).get();
+            return lead.exists ? person('lead', lead) : null;
+        },
+        async read (request) {
+            return Promise.all(request.records.map(async (record)=>{
+                const collection = KIND_STORED_IN[record.kind];
+                if (!collection || !record.id) return null;
+                const snapshot = await org(request.orgId).collection(collection).doc(record.id).get();
+                return snapshot.exists ? person(record.kind, snapshot) : null;
+            }));
+        },
+        async fileUnder (request) {
+            var _ref;
+            const collection = KIND_STORED_IN[request.record.kind];
+            if (!collection) return {
+                filed: false
+            };
+            const ref = org(String(request.orgId)).collection(collection).doc(request.record.id);
+            if (!(await ref.get()).exists) return {
+                filed: false
+            };
+            const field = request.record.kind === 'lead' ? `${request.containerKind}Ids` : `facets.${(_ref = options.groupIdForHost == null ? void 0 : options.groupIdForHost.call(options, request.hostId)) != null ? _ref : request.hostId}.${request.containerKind}Ids`;
+            await ref.update({
+                [field]: FieldValue.arrayUnion(...request.ids)
+            });
+            return {
+                filed: true
+            };
+        },
+        async peopleInView (request) {
+            var _ref, _ref1;
+            const view = (await org(request.orgId).collection('crmViews').doc(request.viewId).get()).data();
+            if (!view || view['shared'] !== true && view['ownerUid'] !== request.viewerUid) {
+                return {
+                    ok: false,
+                    reason: 'not-found'
+                };
+            }
+            if (view['section'] === 'leads') {
+                var _ref2;
+                var _filters_find;
+                const filters = Array.isArray(view['filters']) ? view['filters'] : [];
+                const wanted = String((_ref2 = (_filters_find = filters.find((clause)=>clause['field'] === 'status')) == null ? void 0 : _filters_find['value']) != null ? _ref2 : 'open');
+                const window = await org(request.orgId).collection('leads').where('visibleTo', 'array-contains-any', scopeTokensForHost(request.hostId)).orderBy('lastSeenAtMs', 'desc').limit(201).get();
+                const matching = window.docs.slice(0, 200).filter((doc)=>{
+                    var _doc_data;
+                    const lead = (_doc_data = doc.data()) != null ? _doc_data : {};
+                    if (seenOnlyThroughGrant(lead, request.hostId)) return false;
+                    if (wanted === 'all') return true;
+                    if (wanted === 'open') {
+                        return [
+                            'new',
+                            'nurturing',
+                            'working'
+                        ].includes(leadStatus(lead)) && !lead['convertedContactId'];
+                    }
+                    return leadStatus(lead) === wanted;
+                });
+                return {
+                    ok: true,
+                    people: matching.slice(0, request.limit).map((doc)=>({
+                            kind: 'lead',
+                            id: doc.id
+                        })),
+                    total: matching.length,
+                    truncated: matching.length > request.limit || window.docs.length > 200
+                };
+            }
+            if (view['section'] !== 'contacts') return {
+                ok: false,
+                reason: 'not-people'
+            };
+            const unsupported = (_ref = options.unsupported == null ? void 0 : options.unsupported.call(options, Array.isArray(view['filters']) ? view['filters'] : [])) != null ? _ref : [];
+            if (unsupported.length) return {
+                ok: false,
+                reason: 'unsupported',
+                unsupported
+            };
+            const { emails, complete } = (_ref1 = options.viewEmails == null ? void 0 : options.viewEmails.call(options, request.viewId)) != null ? _ref1 : {
+                emails: [],
+                complete: true
+            };
+            const ordered = [
+                ...new Set(emails)
+            ].sort();
+            const ids = new Set();
+            for (const address of ordered.slice(0, request.limit)){
+                const found = (await org(request.orgId).collection('contacts').where('email', '==', address).limit(1).get()).docs[0];
+                if (found && visibleToHost(found.get('visibleTo'), request.hostId)) ids.add(found.id);
+            }
+            return {
+                ok: true,
+                people: [
+                    ...ids
+                ].map((id)=>({
+                        kind: 'contact',
+                        id
+                    })),
+                total: ordered.length,
+                truncated: ordered.length > request.limit || !complete
+            };
+        },
+        async wroteIn (request) {
+            return Promise.all(request.records.map(async (record)=>{
+                const field = record.kind === 'contact' ? 'contactId' : record.kind === 'lead' ? 'leadId' : null;
+                if (!field || !record.id) return null;
+                const found = await org(request.orgId).collection('crmActivities').where(field, '==', record.id).where('direction', '==', 'inbound').limit(1).get();
+                return !found.empty;
+            }));
+        }
+    }, {
+        pluginId: 'record-system'
+    });
+    const index = (collection, facts)=>({
+            async list () {
+                return {
+                    records: [],
+                    truncated: false
+                };
+            },
+            async get (request) {
+                var _data_name;
+                if (!request.orgId) return null;
+                const snapshot = await org(request.orgId).collection(collection).doc(request.id).get();
+                const data = snapshot.data();
+                return data ? {
+                    id: snapshot.id,
+                    name: String((_data_name = data['name']) != null ? _data_name : '') || snapshot.id,
+                    facts: facts(data)
+                } : null;
+            }
+        });
+    registerPluginRecordIndex('company', index('companies', (data)=>_extends({}, data)), {
+        pluginId: 'record-system'
+    });
+    registerPluginRecordIndex('messageTemplate', index('crmEmailTemplates', (data)=>{
+        var _data_subject, _data_body;
+        return {
+            kind: data['kind'] === 'snippet' ? 'snippet' : 'template',
+            subject: String((_data_subject = data['subject']) != null ? _data_subject : ''),
+            body: String((_data_body = data['body']) != null ? _data_body : '')
+        };
+    }), {
+        pluginId: 'record-system'
+    });
+    registerPluginRecordEmailStateWriter({
+        async stamp () {
+            return {
+                records: 0
+            };
+        },
+        reached: (request)=>moveLeads(request, [
+                'new'
+            ], 'nurturing'),
+        replied: (request)=>moveLeads(request, [
+                'new',
+                'nurturing'
+            ], 'working')
+    }, {
+        pluginId: 'record-system'
+    });
+}
+
+//# sourceMappingURL=stand-in-record-system.js.map

package/src/lib/testing/stand-in-record-system.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/outreach/src/lib/testing/stand-in-record-system.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 { personKey } from '@aglyn/aglyn/app-utils/person-key'\nimport { scopeTokensForHost, seenOnlyThroughGrant, visibleToHost } from '@aglyn/aglyn/app-utils/scope-tokens'\nimport {\n  registerPluginPersonRecords,\n  type PluginPersonRecord,\n} from '@aglyn/aglyn/plugin-manager/plugin-person-records'\nimport { registerPluginRecordEmailStateWriter } from '@aglyn/aglyn/plugin-manager/plugin-record-email-state'\nimport { registerPluginRecordIndex } from '@aglyn/aglyn/plugin-manager/plugin-record-index'\nimport { FieldValue } from 'firebase-admin/firestore'\n\n/**\n * A plugin that keeps people, standing in for the one that does (AGL-3080).\n *\n * Sequences read the people a rep enrolls, the company each works for, the\n * templates a step sends and the saved views people are taken from — and\n * tell the record system when a lead was mailed or wrote back — through the\n * core's seams (`plugin-person-records`, `plugin-record-index`,\n * `plugin-record-email-state`), importing no record system. Their specs\n * stand an owner up the way the loader would, over the spec's own Firestore\n * — the in-memory double or the emulator. One plugin may not import another,\n * which is why this is here rather than borrowed from the CRM.\n *\n * It imitates the owner's storage as the CRM keeps it (contacts, leads keyed\n * by the person, companies, saved views, templates, the activity log) so a\n * spec seeds documents the way it always has. That the real owner answers\n * the same is held by the CRM's own `person-records.spec.ts`,\n * `crm-record-indexes.spec.ts` and `lead-nurturing.spec.ts`.\n */\n\ntype Firestore = FirebaseFirestore.Firestore\ntype Data = Record<string, unknown>\n\nconst KIND_STORED_IN: Readonly<Record<string, string>> = { contact: 'contacts', lead: 'leads' }\n\nconst email = (value: unknown): string | null => {\n  const text = String(value ?? '').trim().toLowerCase()\n  return text.includes('@') ? text : null\n}\n\nexport interface StandInRecordSystemOptions {\n  firestore: () => Firestore\n  /** What the dynamic-list sweep reads out of a saved Contacts view, by view id. */\n  viewEmails?: (viewId: string) => { emails: string[]; complete: boolean }\n  /**\n   * The clauses of a saved Contacts view that only the list itself can\n   * apply, named as the owner names them; none by default. A view with any\n   * is refused whole, as the owner refuses it.\n   */\n  unsupported?: (filters: readonly Data[]) => string[]\n  /** The consent group a site files a contact's facet under. The site alone by default. */\n  groupIdForHost?: (hostId: string) => string\n}\n\nexport function standInRecordSystem(options: StandInRecordSystemOptions): void {\n  const org = (orgId: string) => options.firestore().collection('orgs').doc(orgId)\n  const person = (kind: string, snapshot: FirebaseFirestore.DocumentSnapshot): PluginPersonRecord => {\n    const data = (snapshot.data() ?? {}) as Data\n    return { kind, id: snapshot.id, email: email(data['email']), data }\n  }\n  const leadStatus = (lead: Data) => String(lead['status'] ?? 'new')\n  const moveLeads = async (\n    request: { orgId: string; hostId: string; emails: readonly string[] },\n    from: readonly string[],\n    to: string,\n  ) => {\n    let moved = 0\n    for (const address of request.emails) {\n      const key = personKey(address)\n      if (!key) continue\n      const ref = org(request.orgId).collection('leads').doc(key)\n      const lead = (await ref.get()).data() as Data | undefined\n      if (!lead || lead['convertedContactId']) continue\n      if (!visibleToHost(lead['visibleTo'] as string[] | undefined, request.hostId)) continue\n      if (!from.includes(leadStatus(lead))) continue\n      await ref.set({ status: to }, { merge: true })\n      moved += 1\n    }\n    return { records: moved }\n  }\n\n  registerPluginPersonRecords(\n    {\n      async find(request) {\n        const address = email(request.email)\n        const orgId = String(request.orgId ?? '')\n        if (!address || !orgId) return null\n        const found = (await org(orgId).collection('contacts').where('email', '==', address).limit(1).get()).docs[0]\n        if (found) {\n          const visible =\n            !request.onlyVisibleToSite ||\n            visibleToHost(found.get('visibleTo') as string[] | undefined, String(request.hostId))\n          return visible ? person('contact', found) : null\n        }\n        if (!request.anyKind) return null\n        const lead = await org(orgId).collection('leads').doc(String(personKey(address))).get()\n        return lead.exists ? person('lead', lead) : null\n      },\n      async read(request) {\n        return Promise.all(\n          request.records.map(async (record) => {\n            const collection = KIND_STORED_IN[record.kind]\n            if (!collection || !record.id) return null\n            const snapshot = await org(request.orgId).collection(collection).doc(record.id).get()\n            return snapshot.exists ? person(record.kind, snapshot) : null\n          }),\n        )\n      },\n      async fileUnder(request) {\n        const collection = KIND_STORED_IN[request.record.kind]\n        if (!collection) return { filed: false }\n        const ref = org(String(request.orgId)).collection(collection).doc(request.record.id)\n        if (!(await ref.get()).exists) return { filed: false }\n        const field =\n          request.record.kind === 'lead'\n            ? `${request.containerKind}Ids`\n            : `facets.${options.groupIdForHost?.(request.hostId) ?? request.hostId}.${request.containerKind}Ids`\n        await ref.update({ [field]: FieldValue.arrayUnion(...request.ids) })\n        return { filed: true }\n      },\n      async peopleInView(request) {\n        const view = (await org(request.orgId).collection('crmViews').doc(request.viewId).get()).data() as\n          | Data\n          | undefined\n        if (!view || (view['shared'] !== true && view['ownerUid'] !== request.viewerUid)) {\n          return { ok: false, reason: 'not-found' }\n        }\n        if (view['section'] === 'leads') {\n          const filters = Array.isArray(view['filters']) ? (view['filters'] as Data[]) : []\n          const wanted = String(filters.find((clause) => clause['field'] === 'status')?.['value'] ?? 'open')\n          const window = await org(request.orgId)\n            .collection('leads')\n            .where('visibleTo', 'array-contains-any', scopeTokensForHost(request.hostId))\n            .orderBy('lastSeenAtMs', 'desc')\n            .limit(201)\n            .get()\n          const matching = window.docs.slice(0, 200).filter((doc) => {\n            const lead = (doc.data() ?? {}) as Data\n            if (seenOnlyThroughGrant(lead, request.hostId)) return false\n            if (wanted === 'all') return true\n            if (wanted === 'open') {\n              return ['new', 'nurturing', 'working'].includes(leadStatus(lead)) && !lead['convertedContactId']\n            }\n            return leadStatus(lead) === wanted\n          })\n          return {\n            ok: true,\n            people: matching.slice(0, request.limit).map((doc) => ({ kind: 'lead', id: doc.id })),\n            total: matching.length,\n            truncated: matching.length > request.limit || window.docs.length > 200,\n          }\n        }\n        if (view['section'] !== 'contacts') return { ok: false, reason: 'not-people' }\n        const unsupported = options.unsupported?.(Array.isArray(view['filters']) ? (view['filters'] as Data[]) : []) ?? []\n        if (unsupported.length) return { ok: false, reason: 'unsupported', unsupported }\n        const { emails, complete } = options.viewEmails?.(request.viewId) ?? { emails: [], complete: true }\n        const ordered = [...new Set(emails)].sort()\n        const ids = new Set<string>()\n        for (const address of ordered.slice(0, request.limit)) {\n          const found = (await org(request.orgId).collection('contacts').where('email', '==', address).limit(1).get())\n            .docs[0]\n          if (found && visibleToHost(found.get('visibleTo') as string[] | undefined, request.hostId)) ids.add(found.id)\n        }\n        return {\n          ok: true,\n          people: [...ids].map((id) => ({ kind: 'contact', id })),\n          total: ordered.length,\n          truncated: ordered.length > request.limit || !complete,\n        }\n      },\n      async wroteIn(request) {\n        return Promise.all(\n          request.records.map(async (record) => {\n            const field = record.kind === 'contact' ? 'contactId' : record.kind === 'lead' ? 'leadId' : null\n            if (!field || !record.id) return null\n            const found = await org(request.orgId)\n              .collection('crmActivities')\n              .where(field, '==', record.id)\n              .where('direction', '==', 'inbound')\n              .limit(1)\n              .get()\n            return !found.empty\n          }),\n        )\n      },\n    },\n    { pluginId: 'record-system' },\n  )\n\n  const index = (collection: string, facts: (data: Data) => Data) => ({\n    async list() {\n      return { records: [], truncated: false }\n    },\n    async get(request: { orgId?: string | null; id: string }) {\n      if (!request.orgId) return null\n      const snapshot = await org(request.orgId).collection(collection).doc(request.id).get()\n      const data = snapshot.data() as Data | undefined\n      return data ? { id: snapshot.id, name: String(data['name'] ?? '') || snapshot.id, facts: facts(data) } : null\n    },\n  })\n  registerPluginRecordIndex('company', index('companies', (data) => ({ ...data })), { pluginId: 'record-system' })\n  registerPluginRecordIndex(\n    'messageTemplate',\n    index('crmEmailTemplates', (data) => ({\n      kind: data['kind'] === 'snippet' ? 'snippet' : 'template',\n      subject: String(data['subject'] ?? ''),\n      body: String(data['body'] ?? ''),\n    })),\n    { pluginId: 'record-system' },\n  )\n\n  registerPluginRecordEmailStateWriter(\n    {\n      async stamp() {\n        return { records: 0 }\n      },\n      reached: (request) => moveLeads(request, ['new'], 'nurturing'),\n      replied: (request) => moveLeads(request, ['new', 'nurturing'], 'working'),\n    },\n    { pluginId: 'record-system' },\n  )\n}\n"],"names":["personKey","scopeTokensForHost","seenOnlyThroughGrant","visibleToHost","registerPluginPersonRecords","registerPluginRecordEmailStateWriter","registerPluginRecordIndex","FieldValue","KIND_STORED_IN","contact","lead","email","value","text","String","trim","toLowerCase","includes","standInRecordSystem","options","org","orgId","firestore","collection","doc","person","kind","snapshot","data","id","leadStatus","moveLeads","request","from","to","moved","address","emails","key","ref","get","hostId","set","status","merge","records","find","found","where","limit","docs","visible","onlyVisibleToSite","anyKind","exists","read","Promise","all","map","record","fileUnder","filed","field","containerKind","groupIdForHost","update","arrayUnion","ids","peopleInView","view","viewId","viewerUid","ok","reason","filters","Array","isArray","wanted","clause","window","orderBy","matching","slice","filter","people","total","length","truncated","unsupported","complete","viewEmails","ordered","Set","sort","add","wroteIn","empty","pluginId","index","facts","list","name","subject","body","stamp","reached","replied"],"mappings":";AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,SAAS,QAAQ,oCAAmC;AAC7D,SAASC,kBAAkB,EAAEC,oBAAoB,EAAEC,aAAa,QAAQ,sCAAqC;AAC7G,SACEC,2BAA2B,QAEtB,oDAAmD;AAC1D,SAASC,oCAAoC,QAAQ,wDAAuD;AAC5G,SAASC,yBAAyB,QAAQ,kDAAiD;AAC3F,SAASC,UAAU,QAAQ,2BAA0B;AAwBrD,MAAMC,iBAAmD;IAAEC,SAAS;IAAYC,MAAM;AAAQ;AAE9F,MAAMC,QAAQ,CAACC;IACb,MAAMC,OAAOC,OAAOF,gBAAAA,QAAS,IAAIG,IAAI,GAAGC,WAAW;IACnD,OAAOH,KAAKI,QAAQ,CAAC,OAAOJ,OAAO;AACrC;AAgBA,OAAO,SAASK,oBAAoBC,OAAmC;IACrE,MAAMC,MAAM,CAACC,QAAkBF,QAAQG,SAAS,GAAGC,UAAU,CAAC,QAAQC,GAAG,CAACH;IAC1E,MAAMI,SAAS,CAACC,MAAcC;YACdA;QAAd,MAAMC,QAAQD,iBAAAA,SAASC,IAAI,cAAbD,iBAAmB,CAAC;QAClC,OAAO;YAAED;YAAMG,IAAIF,SAASE,EAAE;YAAElB,OAAOA,MAAMiB,IAAI,CAAC,QAAQ;YAAGA;QAAK;IACpE;IACA,MAAME,aAAa,CAACpB;YAAsBA;eAAPI,QAAOJ,eAAAA,IAAI,CAAC,SAAS,YAAdA,eAAkB;;IAC5D,MAAMqB,YAAY,OAChBC,SACAC,MACAC;QAEA,IAAIC,QAAQ;QACZ,KAAK,MAAMC,WAAWJ,QAAQK,MAAM,CAAE;YACpC,MAAMC,MAAMtC,UAAUoC;YACtB,IAAI,CAACE,KAAK;YACV,MAAMC,MAAMnB,IAAIY,QAAQX,KAAK,EAAEE,UAAU,CAAC,SAASC,GAAG,CAACc;YACvD,MAAM5B,OAAO,AAAC,CAAA,MAAM6B,IAAIC,GAAG,EAAC,EAAGZ,IAAI;YACnC,IAAI,CAAClB,QAAQA,IAAI,CAAC,qBAAqB,EAAE;YACzC,IAAI,CAACP,cAAcO,IAAI,CAAC,YAAY,EAA0BsB,QAAQS,MAAM,GAAG;YAC/E,IAAI,CAACR,KAAKhB,QAAQ,CAACa,WAAWpB,QAAQ;YACtC,MAAM6B,IAAIG,GAAG,CAAC;gBAAEC,QAAQT;YAAG,GAAG;gBAAEU,OAAO;YAAK;YAC5CT,SAAS;QACX;QACA,OAAO;YAAEU,SAASV;QAAM;IAC1B;IAEA/B,4BACE;QACE,MAAM0C,MAAKd,OAAO;gBAEKA;YADrB,MAAMI,UAAUzB,MAAMqB,QAAQrB,KAAK;YACnC,MAAMU,QAAQP,QAAOkB,iBAAAA,QAAQX,KAAK,YAAbW,iBAAiB;YACtC,IAAI,CAACI,WAAW,CAACf,OAAO,OAAO;YAC/B,MAAM0B,QAAQ,AAAC,CAAA,MAAM3B,IAAIC,OAAOE,UAAU,CAAC,YAAYyB,KAAK,CAAC,SAAS,MAAMZ,SAASa,KAAK,CAAC,GAAGT,GAAG,EAAC,EAAGU,IAAI,CAAC,EAAE;YAC5G,IAAIH,OAAO;gBACT,MAAMI,UACJ,CAACnB,QAAQoB,iBAAiB,IAC1BjD,cAAc4C,MAAMP,GAAG,CAAC,cAAsC1B,OAAOkB,QAAQS,MAAM;gBACrF,OAAOU,UAAU1B,OAAO,WAAWsB,SAAS;YAC9C;YACA,IAAI,CAACf,QAAQqB,OAAO,EAAE,OAAO;YAC7B,MAAM3C,OAAO,MAAMU,IAAIC,OAAOE,UAAU,CAAC,SAASC,GAAG,CAACV,OAAOd,UAAUoC,WAAWI,GAAG;YACrF,OAAO9B,KAAK4C,MAAM,GAAG7B,OAAO,QAAQf,QAAQ;QAC9C;QACA,MAAM6C,MAAKvB,OAAO;YAChB,OAAOwB,QAAQC,GAAG,CAChBzB,QAAQa,OAAO,CAACa,GAAG,CAAC,OAAOC;gBACzB,MAAMpC,aAAaf,cAAc,CAACmD,OAAOjC,IAAI,CAAC;gBAC9C,IAAI,CAACH,cAAc,CAACoC,OAAO9B,EAAE,EAAE,OAAO;gBACtC,MAAMF,WAAW,MAAMP,IAAIY,QAAQX,KAAK,EAAEE,UAAU,CAACA,YAAYC,GAAG,CAACmC,OAAO9B,EAAE,EAAEW,GAAG;gBACnF,OAAOb,SAAS2B,MAAM,GAAG7B,OAAOkC,OAAOjC,IAAI,EAAEC,YAAY;YAC3D;QAEJ;QACA,MAAMiC,WAAU5B,OAAO;;YACrB,MAAMT,aAAaf,cAAc,CAACwB,QAAQ2B,MAAM,CAACjC,IAAI,CAAC;YACtD,IAAI,CAACH,YAAY,OAAO;gBAAEsC,OAAO;YAAM;YACvC,MAAMtB,MAAMnB,IAAIN,OAAOkB,QAAQX,KAAK,GAAGE,UAAU,CAACA,YAAYC,GAAG,CAACQ,QAAQ2B,MAAM,CAAC9B,EAAE;YACnF,IAAI,CAAC,AAAC,CAAA,MAAMU,IAAIC,GAAG,EAAC,EAAGc,MAAM,EAAE,OAAO;gBAAEO,OAAO;YAAM;YACrD,MAAMC,QACJ9B,QAAQ2B,MAAM,CAACjC,IAAI,KAAK,SACpB,GAAGM,QAAQ+B,aAAa,CAAC,GAAG,CAAC,GAC7B,CAAC,OAAO,UAAE5C,QAAQ6C,cAAc,oBAAtB7C,QAAQ6C,cAAc,MAAtB7C,SAAyBa,QAAQS,MAAM,oBAAKT,QAAQS,MAAM,CAAC,CAAC,EAAET,QAAQ+B,aAAa,CAAC,GAAG,CAAC;YACxG,MAAMxB,IAAI0B,MAAM,CAAC;gBAAE,CAACH,MAAM,EAAEvD,WAAW2D,UAAU,IAAIlC,QAAQmC,GAAG;YAAE;YAClE,OAAO;gBAAEN,OAAO;YAAK;QACvB;QACA,MAAMO,cAAapC,OAAO;;YACxB,MAAMqC,OAAO,AAAC,CAAA,MAAMjD,IAAIY,QAAQX,KAAK,EAAEE,UAAU,CAAC,YAAYC,GAAG,CAACQ,QAAQsC,MAAM,EAAE9B,GAAG,EAAC,EAAGZ,IAAI;YAG7F,IAAI,CAACyC,QAASA,IAAI,CAAC,SAAS,KAAK,QAAQA,IAAI,CAAC,WAAW,KAAKrC,QAAQuC,SAAS,EAAG;gBAChF,OAAO;oBAAEC,IAAI;oBAAOC,QAAQ;gBAAY;YAC1C;YACA,IAAIJ,IAAI,CAAC,UAAU,KAAK,SAAS;;oBAETK;gBADtB,MAAMA,UAAUC,MAAMC,OAAO,CAACP,IAAI,CAAC,UAAU,IAAKA,IAAI,CAAC,UAAU,GAAc,EAAE;gBACjF,MAAMQ,SAAS/D,iBAAO4D,gBAAAA,QAAQ5B,IAAI,CAAC,CAACgC,SAAWA,MAAM,CAAC,QAAQ,KAAK,8BAA7CJ,aAAwD,CAAC,QAAQ,oBAAI;gBAC3F,MAAMK,SAAS,MAAM3D,IAAIY,QAAQX,KAAK,EACnCE,UAAU,CAAC,SACXyB,KAAK,CAAC,aAAa,sBAAsB/C,mBAAmB+B,QAAQS,MAAM,GAC1EuC,OAAO,CAAC,gBAAgB,QACxB/B,KAAK,CAAC,KACNT,GAAG;gBACN,MAAMyC,WAAWF,OAAO7B,IAAI,CAACgC,KAAK,CAAC,GAAG,KAAKC,MAAM,CAAC,CAAC3D;wBACnCA;oBAAd,MAAMd,QAAQc,YAAAA,IAAII,IAAI,cAARJ,YAAc,CAAC;oBAC7B,IAAItB,qBAAqBQ,MAAMsB,QAAQS,MAAM,GAAG,OAAO;oBACvD,IAAIoC,WAAW,OAAO,OAAO;oBAC7B,IAAIA,WAAW,QAAQ;wBACrB,OAAO;4BAAC;4BAAO;4BAAa;yBAAU,CAAC5D,QAAQ,CAACa,WAAWpB,UAAU,CAACA,IAAI,CAAC,qBAAqB;oBAClG;oBACA,OAAOoB,WAAWpB,UAAUmE;gBAC9B;gBACA,OAAO;oBACLL,IAAI;oBACJY,QAAQH,SAASC,KAAK,CAAC,GAAGlD,QAAQiB,KAAK,EAAES,GAAG,CAAC,CAAClC,MAAS,CAAA;4BAAEE,MAAM;4BAAQG,IAAIL,IAAIK,EAAE;wBAAC,CAAA;oBAClFwD,OAAOJ,SAASK,MAAM;oBACtBC,WAAWN,SAASK,MAAM,GAAGtD,QAAQiB,KAAK,IAAI8B,OAAO7B,IAAI,CAACoC,MAAM,GAAG;gBACrE;YACF;YACA,IAAIjB,IAAI,CAAC,UAAU,KAAK,YAAY,OAAO;gBAAEG,IAAI;gBAAOC,QAAQ;YAAa;YAC7E,MAAMe,sBAAcrE,QAAQqE,WAAW,oBAAnBrE,QAAQqE,WAAW,MAAnBrE,SAAsBwD,MAAMC,OAAO,CAACP,IAAI,CAAC,UAAU,IAAKA,IAAI,CAAC,UAAU,GAAc,EAAE,oBAAK,EAAE;YAClH,IAAImB,YAAYF,MAAM,EAAE,OAAO;gBAAEd,IAAI;gBAAOC,QAAQ;gBAAee;YAAY;YAC/E,MAAM,EAAEnD,MAAM,EAAEoD,QAAQ,EAAE,YAAGtE,QAAQuE,UAAU,oBAAlBvE,QAAQuE,UAAU,MAAlBvE,SAAqBa,QAAQsC,MAAM,qBAAK;gBAAEjC,QAAQ,EAAE;gBAAEoD,UAAU;YAAK;YAClG,MAAME,UAAU;mBAAI,IAAIC,IAAIvD;aAAQ,CAACwD,IAAI;YACzC,MAAM1B,MAAM,IAAIyB;YAChB,KAAK,MAAMxD,WAAWuD,QAAQT,KAAK,CAAC,GAAGlD,QAAQiB,KAAK,EAAG;gBACrD,MAAMF,QAAQ,AAAC,CAAA,MAAM3B,IAAIY,QAAQX,KAAK,EAAEE,UAAU,CAAC,YAAYyB,KAAK,CAAC,SAAS,MAAMZ,SAASa,KAAK,CAAC,GAAGT,GAAG,EAAC,EACvGU,IAAI,CAAC,EAAE;gBACV,IAAIH,SAAS5C,cAAc4C,MAAMP,GAAG,CAAC,cAAsCR,QAAQS,MAAM,GAAG0B,IAAI2B,GAAG,CAAC/C,MAAMlB,EAAE;YAC9G;YACA,OAAO;gBACL2C,IAAI;gBACJY,QAAQ;uBAAIjB;iBAAI,CAACT,GAAG,CAAC,CAAC7B,KAAQ,CAAA;wBAAEH,MAAM;wBAAWG;oBAAG,CAAA;gBACpDwD,OAAOM,QAAQL,MAAM;gBACrBC,WAAWI,QAAQL,MAAM,GAAGtD,QAAQiB,KAAK,IAAI,CAACwC;YAChD;QACF;QACA,MAAMM,SAAQ/D,OAAO;YACnB,OAAOwB,QAAQC,GAAG,CAChBzB,QAAQa,OAAO,CAACa,GAAG,CAAC,OAAOC;gBACzB,MAAMG,QAAQH,OAAOjC,IAAI,KAAK,YAAY,cAAciC,OAAOjC,IAAI,KAAK,SAAS,WAAW;gBAC5F,IAAI,CAACoC,SAAS,CAACH,OAAO9B,EAAE,EAAE,OAAO;gBACjC,MAAMkB,QAAQ,MAAM3B,IAAIY,QAAQX,KAAK,EAClCE,UAAU,CAAC,iBACXyB,KAAK,CAACc,OAAO,MAAMH,OAAO9B,EAAE,EAC5BmB,KAAK,CAAC,aAAa,MAAM,WACzBC,KAAK,CAAC,GACNT,GAAG;gBACN,OAAO,CAACO,MAAMiD,KAAK;YACrB;QAEJ;IACF,GACA;QAAEC,UAAU;IAAgB;IAG9B,MAAMC,QAAQ,CAAC3E,YAAoB4E,QAAiC,CAAA;YAClE,MAAMC;gBACJ,OAAO;oBAAEvD,SAAS,EAAE;oBAAE0C,WAAW;gBAAM;YACzC;YACA,MAAM/C,KAAIR,OAA8C;oBAIRJ;gBAH9C,IAAI,CAACI,QAAQX,KAAK,EAAE,OAAO;gBAC3B,MAAMM,WAAW,MAAMP,IAAIY,QAAQX,KAAK,EAAEE,UAAU,CAACA,YAAYC,GAAG,CAACQ,QAAQH,EAAE,EAAEW,GAAG;gBACpF,MAAMZ,OAAOD,SAASC,IAAI;gBAC1B,OAAOA,OAAO;oBAAEC,IAAIF,SAASE,EAAE;oBAAEwE,MAAMvF,QAAOc,aAAAA,IAAI,CAAC,OAAO,YAAZA,aAAgB,OAAOD,SAASE,EAAE;oBAAEsE,OAAOA,MAAMvE;gBAAM,IAAI;YAC3G;QACF,CAAA;IACAtB,0BAA0B,WAAW4F,MAAM,aAAa,CAACtE,OAAU,aAAKA,QAAU;QAAEqE,UAAU;IAAgB;IAC9G3F,0BACE,mBACA4F,MAAM,qBAAqB,CAACtE;YAEVA,eACHA;eAHuB;YACpCF,MAAME,IAAI,CAAC,OAAO,KAAK,YAAY,YAAY;YAC/C0E,SAASxF,QAAOc,gBAAAA,IAAI,CAAC,UAAU,YAAfA,gBAAmB;YACnC2E,MAAMzF,QAAOc,aAAAA,IAAI,CAAC,OAAO,YAAZA,aAAgB;QAC/B;QACA;QAAEqE,UAAU;IAAgB;IAG9B5F,qCACE;QACE,MAAMmG;YACJ,OAAO;gBAAE3D,SAAS;YAAE;QACtB;QACA4D,SAAS,CAACzE,UAAYD,UAAUC,SAAS;gBAAC;aAAM,EAAE;QAClD0E,SAAS,CAAC1E,UAAYD,UAAUC,SAAS;gBAAC;gBAAO;aAAY,EAAE;IACjE,GACA;QAAEiE,UAAU;IAAgB;AAEhC"}

package/src/lib/transfer/do-not-contact-transfer.d.ts

@@ -0,0 +1,129 @@
+/**
+ * @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 TransferCatalogInput, type TransferLockedRule } from '@aglyn/aglyn/data-transfer';
+import type { PluginTransferResource, TransferRecordsHooks } from '@aglyn/aglyn/plugin-manager/plugin-transfer-resources';
+import { type OutreachMembership } from '../engine/outreach-access';
+/**
+ * THE DO-NOT-CONTACT LIST AS A FILE: `outreach.do-not-contact`, an
+ * organization's addresses and domains that no sequence emails.
+ *
+ * ## One file, two collections
+ *
+ * A row is one entry, and its Entry cell says which kind: an email address
+ * goes to `orgs/{orgId}/outreachDoNotContact/{key}`, anything else that reads
+ * as a domain to `orgs/{orgId}/outreachDoNotContactDomains/{domain}`. The
+ * Aglyn ID names the kind too — `domain:<domain>` or `address:<key>` — so a
+ * re-imported export finds its entries by id.
+ *
+ * ## Only ever added to
+ *
+ * Every entry is written once and never edited (the store's `create()`), and
+ * the first reason an entry was added is the record of why it is there. An
+ * import keeps that: a row that finds an entry already on the list is
+ * skipped whatever the wizard's policy says (`plan` forces it), and only the
+ * entries an import ADDED are taken off again by its undo.
+ *
+ * ## Addresses go in and never come out
+ *
+ * An address entry stores the address's fingerprint, never the address, so
+ * the list keeps a promise not to email someone without holding who they
+ * are. An export therefore reads domains only: an address cannot be read
+ * back out of its fingerprint.
+ *
+ * ## The same door as the Compliance page
+ *
+ * Every hook asks what the route gate asks — a member of this organization
+ * with reach over all of it, holding Use Sequences, in a workspace whose plan
+ * includes Sequences — through the same verdicts (`engine/outreach-access.ts`).
+ * A plan refuses every row for a member who would be refused, `apply` asks
+ * again before it writes, a read answers nothing, and undo stops. Writes go
+ * through the store's own adders, as a member's would: reason `manual`,
+ * source `member`, the member as `addedByUid`. Each written chunk files one
+ * line in the organization's activity log, as the page's add does per entry.
+ */
+/** The fields' ids. */
+export declare const OUTREACH_DNC_FIELDS: {
+    readonly entry: "entry";
+    readonly kind: "kind";
+    readonly note: "note";
+    readonly reason: "reason";
+    readonly source: "source";
+    readonly addedByUid: "addedByUid";
+    readonly addedAt: "addedAt";
+    readonly sequenceId: "sequenceId";
+};
+/** Why a file never changes an entry already on the list. */
+export declare const OUTREACH_DNC_ADD_ONLY_REASON = "The do-not-contact list only grows from a file: an entry already on it is left as it is.";
+/** The activity lines an import and its undo file, one per chunk written or reverted. */
+export declare const OUTREACH_DO_NOT_CONTACT_IMPORT_ACTIVITY: {
+    readonly add: (counts: EntryCounts) => string;
+    readonly undo: (counts: EntryCounts) => string;
+};
+/** How many of each kind a chunk wrote or removed. */
+export interface EntryCounts {
+    domains: number;
+    addresses: number;
+}
+/** The entry a cell or an id names: an address, by its key, or a domain. */
+export type OutreachDoNotContactTarget = {
+    kind: 'address';
+    id: string;
+    key: string;
+    email: string | null;
+} | {
+    kind: 'domain';
+    id: string;
+    domain: string;
+};
+/**
+ * The entry a cell names, or `null` for a value that is neither an address
+ * nor a domain. An address-looking value that is not a usable address is
+ * refused rather than read as its domain: a typo in one address must not
+ * block a whole company.
+ */
+export declare function outreachDoNotContactTarget(value: unknown): OutreachDoNotContactTarget | null;
+/** The entry an Aglyn ID names, or `null`. */
+export declare function outreachDoNotContactTargetFromId(id: unknown): OutreachDoNotContactTarget | null;
+/** The resource's catalog, the same for every organization. */
+export declare function outreachDoNotContactCatalog(): TransferCatalogInput;
+/** Note is written with a new entry and never onto one already on the list. */
+export declare const OUTREACH_DNC_LOCKED_RULES: readonly TransferLockedRule[];
+export interface OutreachDoNotContactTransferDeps {
+    firestore: FirebaseFirestore.Firestore;
+    now?: () => number;
+    /** The member's standing in the organization, as the route gate resolves it. */
+    resolveOrgPermissions(uid: string, context: {
+        orgId: string;
+    }): Promise<OutreachMembership>;
+    /** The organization document, or `null` when there is none. */
+    readOrg(orgId: string): Promise<Record<string, unknown> | null>;
+    logOrgActivity(orgId: string, actor: {
+        uid: string | null;
+        email?: string | null;
+    }, action: string, target: {
+        type: 'org';
+        id: string;
+    }): Promise<void>;
+}
+/** The hooks this resource answers, every one present. */
+export type OutreachDoNotContactTransferResource = PluginTransferResource & Required<Pick<TransferRecordsHooks, 'fields' | 'count' | 'readPage' | 'lookup' | 'plan' | 'lockedRules' | 'apply' | 'revert'>>;
+/**
+ * The do-not-contact list's server half. Specs pass an in-memory Firestore;
+ * the console's declarations pass the Admin SDK's and the platform's
+ * membership, organization and activity readers.
+ */
+export declare function createOutreachDoNotContactTransferResource(deps: OutreachDoNotContactTransferDeps): OutreachDoNotContactTransferResource;