@aglyn/plugins-crm 1.0.0-beta.221 → 1.0.0-beta.223

package/src/lib/model/crm-record-counts.js

@@ -0,0 +1,54 @@
+/**
+ * @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 { CAPTURED_BY_HOST_FIELD } from "@aglyn/aglyn/app-utils/marketing-consent";
+import { registerPluginRecordCountSource } from "@aglyn/aglyn/plugin-manager/plugin-record-counts";
+import { collection, query, where } from "firebase/firestore";
+import { BUNDLE_ID } from "../constants/bundle-common.js";
+/**
+ * The leads a site CAPTURED (AGL-3275), counted for another plugin's figure
+ * (AGL-3080). A lead is one document per person under the organization,
+ * stamped in `capturedByHostIds` with every site that met them — so this is
+ * exactly the population a site's own lead outcomes are drawn from.
+ *
+ * Not `visibleTo`: that also names the sites a consent group shares a person
+ * with. The price is that a collaborator scoped to one site cannot run the
+ * count — the rules prove a lead read by `visibleTo` — and the reader
+ * withholds the figure for them.
+ */ export const leadRecordCountSource = {
+    query (firestore, request) {
+        if (!request.orgId || !request.hostId) return null;
+        return query(collection(firestore, 'orgs', request.orgId, 'leads'), where(CAPTURED_BY_HOST_FIELD, 'array-contains', request.hostId));
+    }
+};
+/**
+ * The organization's contacts — ONE row per person for every site in it, so
+ * the count crosses sites, which the reader is told.
+ */ export const contactRecordCountSource = {
+    query (firestore, request) {
+        return request.orgId ? collection(firestore, 'orgs', request.orgId, 'contacts') : null;
+    },
+    crossesSites: true
+};
+/** Called from the console registrar, owner named for a spec that calls it directly. */ export function registerCrmRecordCounts() {
+    registerPluginRecordCountSource('lead', leadRecordCountSource, {
+        pluginId: BUNDLE_ID
+    });
+    registerPluginRecordCountSource('contact', contactRecordCountSource, {
+        pluginId: BUNDLE_ID
+    });
+}
+
+//# sourceMappingURL=crm-record-counts.js.map

package/src/lib/model/crm-record-counts.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/crm/src/lib/model/crm-record-counts.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 { CAPTURED_BY_HOST_FIELD } from '@aglyn/aglyn/app-utils/marketing-consent'\nimport {\n  registerPluginRecordCountSource,\n  type PluginRecordCountSource,\n} from '@aglyn/aglyn/plugin-manager/plugin-record-counts'\nimport { collection, query, where } from 'firebase/firestore'\nimport { BUNDLE_ID } from '../constants/bundle-common'\n\n/**\n * The leads a site CAPTURED (AGL-3275), counted for another plugin's figure\n * (AGL-3080). A lead is one document per person under the organization,\n * stamped in `capturedByHostIds` with every site that met them — so this is\n * exactly the population a site's own lead outcomes are drawn from.\n *\n * Not `visibleTo`: that also names the sites a consent group shares a person\n * with. The price is that a collaborator scoped to one site cannot run the\n * count — the rules prove a lead read by `visibleTo` — and the reader\n * withholds the figure for them.\n */\nexport const leadRecordCountSource: PluginRecordCountSource = {\n  query(firestore, request) {\n    if (!request.orgId || !request.hostId) return null\n    return query(\n      collection(firestore, 'orgs', request.orgId, 'leads'),\n      where(CAPTURED_BY_HOST_FIELD, 'array-contains', request.hostId),\n    )\n  },\n}\n\n/**\n * The organization's contacts — ONE row per person for every site in it, so\n * the count crosses sites, which the reader is told.\n */\nexport const contactRecordCountSource: PluginRecordCountSource = {\n  query(firestore, request) {\n    return request.orgId ? collection(firestore, 'orgs', request.orgId, 'contacts') : null\n  },\n  crossesSites: true,\n}\n\n/** Called from the console registrar, owner named for a spec that calls it directly. */\nexport function registerCrmRecordCounts(): void {\n  registerPluginRecordCountSource('lead', leadRecordCountSource, { pluginId: BUNDLE_ID })\n  registerPluginRecordCountSource('contact', contactRecordCountSource, { pluginId: BUNDLE_ID })\n}\n"],"names":["CAPTURED_BY_HOST_FIELD","registerPluginRecordCountSource","collection","query","where","BUNDLE_ID","leadRecordCountSource","firestore","request","orgId","hostId","contactRecordCountSource","crossesSites","registerCrmRecordCounts","pluginId"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,sBAAsB,QAAQ,2CAA0C;AACjF,SACEC,+BAA+B,QAE1B,mDAAkD;AACzD,SAASC,UAAU,EAAEC,KAAK,EAAEC,KAAK,QAAQ,qBAAoB;AAC7D,SAASC,SAAS,QAAQ,gCAA4B;AAEtD;;;;;;;;;;CAUC,GACD,OAAO,MAAMC,wBAAiD;IAC5DH,OAAMI,SAAS,EAAEC,OAAO;QACtB,IAAI,CAACA,QAAQC,KAAK,IAAI,CAACD,QAAQE,MAAM,EAAE,OAAO;QAC9C,OAAOP,MACLD,WAAWK,WAAW,QAAQC,QAAQC,KAAK,EAAE,UAC7CL,MAAMJ,wBAAwB,kBAAkBQ,QAAQE,MAAM;IAElE;AACF,EAAC;AAED;;;CAGC,GACD,OAAO,MAAMC,2BAAoD;IAC/DR,OAAMI,SAAS,EAAEC,OAAO;QACtB,OAAOA,QAAQC,KAAK,GAAGP,WAAWK,WAAW,QAAQC,QAAQC,KAAK,EAAE,cAAc;IACpF;IACAG,cAAc;AAChB,EAAC;AAED,sFAAsF,GACtF,OAAO,SAASC;IACdZ,gCAAgC,QAAQK,uBAAuB;QAAEQ,UAAUT;IAAU;IACrFJ,gCAAgC,WAAWU,0BAA0B;QAAEG,UAAUT;IAAU;AAC7F"}

package/src/lib/model/crm-record-lists.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 PluginRecordListSource } from '@aglyn/aglyn/plugin-manager/plugin-record-lists';
+export declare const savedViewRecordListSource: PluginRecordListSource;
+export declare const messageTemplateRecordListSource: PluginRecordListSource;
+export declare const contactRecordListSource: PluginRecordListSource;
+export declare const leadRecordListSource: PluginRecordListSource;
+/** Called from the console registrar, owner named for a spec that calls it directly. */
+export declare function registerCrmRecordLists(): void;

package/src/lib/model/crm-record-lists.js

@@ -0,0 +1,161 @@
+/**
+ * @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 { contactDisplayName, normalizeContactEmail } from "@aglyn/aglyn/app-utils/contacts";
+import { CRM_COLLECTIONS, crmLeadDisplayName, crmViewIsListed, isCrmLeadOpen, normalizeCrmViewFilters } from "@aglyn/aglyn/app-utils/crm";
+import { CRM_EMAIL_TEMPLATES_LIMIT, crmEmailTemplateIsListed, normalizeCrmEmailTemplate } from "@aglyn/aglyn/app-utils/crm-email-templates";
+import { dynamicListDimensionsForCrmView } from "@aglyn/aglyn/app-utils/dynamic-list-rule";
+import { nameSearchToken } from "@aglyn/aglyn/app-utils/name-search";
+import { scopeTokensForHost, visibleToHost } from "@aglyn/aglyn/app-utils/scope-tokens";
+import { registerPluginRecordListSource } from "@aglyn/aglyn/plugin-manager/plugin-record-lists";
+import { collection, limit, orderBy, query, where } from "firebase/firestore";
+import { BUNDLE_ID } from "../constants/bundle-common.js";
+/**
+ * The CRM's records, FOUND in the console for another plugin's picker
+ * (AGL-3080) — a sales sequence choosing whom to enroll and what to send —
+ * through `plugin-record-lists`, so the reader never learns where the CRM
+ * keeps any of it or which rule its security rules hold a query to.
+ *
+ * Four kinds, each org-scoped (`orgId` required) and each the query the
+ * CRM's own console reads the same records by:
+ *
+ * `savedView` — the saved views of the Contacts and Leads lists this member
+ * may list: their own and the shared ones. Facts:
+ * `{ recordKind: 'contact' | 'lead', takeable: boolean }`. `takeable` is
+ * whether the view can be taken whole as an audience: a Leads view narrows by
+ * status alone, which is always applied; a Contacts view filtering on
+ * something only the list itself can apply is not, because dropping that
+ * filter would take more people than the view shows.
+ *
+ * `messageTemplate` — the email templates and snippets this member may list,
+ * written for the whole organization or for the named site. Facts:
+ * `{ kind: 'template' | 'snippet', subject, body }`.
+ *
+ * `contact` — a SEARCH of the site's contacts: by address when the text is
+ * one, otherwise by a word of the name. None with nothing typed. Named as the
+ * site's consent group knows them. Facts: `{ email }`.
+ *
+ * `lead` — the site's most recently seen leads, newest first. Facts:
+ * `{ email, open }`, `open` being a lead nobody has closed or converted.
+ */ const named = (value)=>typeof value === 'string' ? value.trim() : '';
+export const savedViewRecordListSource = {
+    query (firestore, request) {
+        if (!request.orgId) return null;
+        return query(collection(firestore, 'orgs', request.orgId, CRM_COLLECTIONS.views), where('section', 'in', [
+            'contacts',
+            'leads'
+        ]), orderBy('name'), limit(request.limit));
+    },
+    record (id, data, request) {
+        var _data_ownerUid, _ref;
+        const name = named(data['name']);
+        if (!name) return null;
+        // A colleague's private view is theirs.
+        if (!crmViewIsListed({
+            shared: data['shared'] === true,
+            ownerUid: String((_data_ownerUid = data['ownerUid']) != null ? _data_ownerUid : '')
+        }, (_ref = request == null ? void 0 : request.viewerUid) != null ? _ref : null)) {
+            return null;
+        }
+        const leads = data['section'] === 'leads';
+        const takeable = leads || dynamicListDimensionsForCrmView(normalizeCrmViewFilters(data['filters'])).unsupported.length === 0;
+        return {
+            id,
+            name,
+            facts: {
+                recordKind: leads ? 'lead' : 'contact',
+                takeable
+            }
+        };
+    }
+};
+export const messageTemplateRecordListSource = {
+    query (firestore, request) {
+        if (!request.orgId) return null;
+        return query(collection(firestore, 'orgs', request.orgId, CRM_COLLECTIONS.emailTemplates), orderBy('name'), limit(Math.min(request.limit, CRM_EMAIL_TEMPLATES_LIMIT)));
+    },
+    record (id, data, request) {
+        var _ref;
+        const template = normalizeCrmEmailTemplate(data);
+        if (!template.name) return null;
+        // The team's and this member's own, written for the organization or the site.
+        if (!crmEmailTemplateIsListed(template, (_ref = request == null ? void 0 : request.viewerUid) != null ? _ref : null)) return null;
+        if ((request == null ? void 0 : request.hostId) && !visibleToHost(template.visibleTo, request.hostId)) return null;
+        return {
+            id,
+            name: template.name,
+            facts: {
+                kind: template.kind,
+                subject: template.subject,
+                body: template.body
+            }
+        };
+    }
+};
+export const contactRecordListSource = {
+    query (firestore, request) {
+        if (!request.orgId || !request.hostId) return null;
+        const email = normalizeContactEmail(request.search);
+        const token = email ? '' : nameSearchToken(request.search);
+        if (!email && !token) return null;
+        const contacts = collection(firestore, 'orgs', request.orgId, 'contacts');
+        return email ? query(contacts, where('email', '==', email), limit(request.limit)) : query(contacts, where('nameTokens', 'array-contains', token), orderBy('nameLower'), limit(request.limit));
+    },
+    record (id, data, request) {
+        const hostId = request == null ? void 0 : request.hostId;
+        if (hostId && !visibleToHost(data['visibleTo'], hostId)) return null;
+        const email = normalizeContactEmail(data['email']);
+        const name = contactDisplayName(data, (request == null ? void 0 : request.consentGroupId) || hostId || '').trim() || email || '';
+        if (!name) return null;
+        return {
+            id,
+            name,
+            facts: {
+                email
+            }
+        };
+    }
+};
+export const leadRecordListSource = {
+    query (firestore, request) {
+        if (!request.orgId || !request.hostId) return null;
+        // The org collection, narrowed to the site (AGL-3275) — unscoped it would
+        // offer one agency client another client's people.
+        return query(collection(firestore, 'orgs', request.orgId, 'leads'), where('visibleTo', 'array-contains-any', scopeTokensForHost(request.hostId)), orderBy('lastSeenAtMs', 'desc'), limit(request.limit));
+    },
+    record (id, data) {
+        const name = crmLeadDisplayName(data);
+        if (!name) return null;
+        return {
+            id,
+            name,
+            facts: {
+                email: normalizeContactEmail(data['email']),
+                open: isCrmLeadOpen(data) && !data['convertedContactId']
+            }
+        };
+    }
+};
+/** Called from the console registrar, owner named for a spec that calls it directly. */ export function registerCrmRecordLists() {
+    const owner = {
+        pluginId: BUNDLE_ID
+    };
+    registerPluginRecordListSource('savedView', savedViewRecordListSource, owner);
+    registerPluginRecordListSource('messageTemplate', messageTemplateRecordListSource, owner);
+    registerPluginRecordListSource('contact', contactRecordListSource, owner);
+    registerPluginRecordListSource('lead', leadRecordListSource, owner);
+}
+
+//# sourceMappingURL=crm-record-lists.js.map

package/src/lib/model/crm-record-lists.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../../../../libs/plugins/crm/src/lib/model/crm-record-lists.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 { contactDisplayName, normalizeContactEmail } from '@aglyn/aglyn/app-utils/contacts'\nimport {\n  CRM_COLLECTIONS,\n  crmLeadDisplayName,\n  crmViewIsListed,\n  isCrmLeadOpen,\n  normalizeCrmViewFilters,\n} from '@aglyn/aglyn/app-utils/crm'\nimport {\n  CRM_EMAIL_TEMPLATES_LIMIT,\n  crmEmailTemplateIsListed,\n  normalizeCrmEmailTemplate,\n} from '@aglyn/aglyn/app-utils/crm-email-templates'\nimport { dynamicListDimensionsForCrmView } from '@aglyn/aglyn/app-utils/dynamic-list-rule'\nimport { nameSearchToken } from '@aglyn/aglyn/app-utils/name-search'\nimport { scopeTokensForHost, visibleToHost } from '@aglyn/aglyn/app-utils/scope-tokens'\nimport {\n  registerPluginRecordListSource,\n  type PluginRecordListSource,\n} from '@aglyn/aglyn/plugin-manager/plugin-record-lists'\nimport { collection, limit, orderBy, query, where } from 'firebase/firestore'\nimport { BUNDLE_ID } from '../constants/bundle-common'\n\n/**\n * The CRM's records, FOUND in the console for another plugin's picker\n * (AGL-3080) — a sales sequence choosing whom to enroll and what to send —\n * through `plugin-record-lists`, so the reader never learns where the CRM\n * keeps any of it or which rule its security rules hold a query to.\n *\n * Four kinds, each org-scoped (`orgId` required) and each the query the\n * CRM's own console reads the same records by:\n *\n * `savedView` — the saved views of the Contacts and Leads lists this member\n * may list: their own and the shared ones. Facts:\n * `{ recordKind: 'contact' | 'lead', takeable: boolean }`. `takeable` is\n * whether the view can be taken whole as an audience: a Leads view narrows by\n * status alone, which is always applied; a Contacts view filtering on\n * something only the list itself can apply is not, because dropping that\n * filter would take more people than the view shows.\n *\n * `messageTemplate` — the email templates and snippets this member may list,\n * written for the whole organization or for the named site. Facts:\n * `{ kind: 'template' | 'snippet', subject, body }`.\n *\n * `contact` — a SEARCH of the site's contacts: by address when the text is\n * one, otherwise by a word of the name. None with nothing typed. Named as the\n * site's consent group knows them. Facts: `{ email }`.\n *\n * `lead` — the site's most recently seen leads, newest first. Facts:\n * `{ email, open }`, `open` being a lead nobody has closed or converted.\n */\n\nconst named = (value: unknown): string => (typeof value === 'string' ? value.trim() : '')\n\nexport const savedViewRecordListSource: PluginRecordListSource = {\n  query(firestore, request) {\n    if (!request.orgId) return null\n    return query(\n      collection(firestore, 'orgs', request.orgId, CRM_COLLECTIONS.views),\n      where('section', 'in', ['contacts', 'leads']),\n      orderBy('name'),\n      limit(request.limit),\n    )\n  },\n  record(id, data, request) {\n    const name = named(data['name'])\n    if (!name) return null\n    // A colleague's private view is theirs.\n    if (\n      !crmViewIsListed(\n        { shared: data['shared'] === true, ownerUid: String(data['ownerUid'] ?? '') },\n        request?.viewerUid ?? null,\n      )\n    ) {\n      return null\n    }\n    const leads = data['section'] === 'leads'\n    const takeable =\n      leads || dynamicListDimensionsForCrmView(normalizeCrmViewFilters(data['filters'])).unsupported.length === 0\n    return { id, name, facts: { recordKind: leads ? 'lead' : 'contact', takeable } }\n  },\n}\n\nexport const messageTemplateRecordListSource: PluginRecordListSource = {\n  query(firestore, request) {\n    if (!request.orgId) return null\n    return query(\n      collection(firestore, 'orgs', request.orgId, CRM_COLLECTIONS.emailTemplates),\n      orderBy('name'),\n      limit(Math.min(request.limit, CRM_EMAIL_TEMPLATES_LIMIT)),\n    )\n  },\n  record(id, data, request) {\n    const template = normalizeCrmEmailTemplate(data)\n    if (!template.name) return null\n    // The team's and this member's own, written for the organization or the site.\n    if (!crmEmailTemplateIsListed(template, request?.viewerUid ?? null)) return null\n    if (request?.hostId && !visibleToHost(template.visibleTo, request.hostId)) return null\n    return {\n      id,\n      name: template.name,\n      facts: { kind: template.kind, subject: template.subject, body: template.body },\n    }\n  },\n}\n\nexport const contactRecordListSource: PluginRecordListSource = {\n  query(firestore, request) {\n    if (!request.orgId || !request.hostId) return null\n    const email = normalizeContactEmail(request.search)\n    const token = email ? '' : nameSearchToken(request.search)\n    if (!email && !token) return null\n    const contacts = collection(firestore, 'orgs', request.orgId, 'contacts')\n    return email\n      ? query(contacts, where('email', '==', email), limit(request.limit))\n      : query(contacts, where('nameTokens', 'array-contains', token), orderBy('nameLower'), limit(request.limit))\n  },\n  record(id, data, request) {\n    const hostId = request?.hostId\n    if (hostId && !visibleToHost(data['visibleTo'] as string[] | undefined, hostId)) return null\n    const email = normalizeContactEmail(data['email'])\n    const name = contactDisplayName(data, request?.consentGroupId || hostId || '').trim() || email || ''\n    if (!name) return null\n    return { id, name, facts: { email } }\n  },\n}\n\nexport const leadRecordListSource: PluginRecordListSource = {\n  query(firestore, request) {\n    if (!request.orgId || !request.hostId) return null\n    // The org collection, narrowed to the site (AGL-3275) — unscoped it would\n    // offer one agency client another client's people.\n    return query(\n      collection(firestore, 'orgs', request.orgId, 'leads'),\n      where('visibleTo', 'array-contains-any', scopeTokensForHost(request.hostId)),\n      orderBy('lastSeenAtMs', 'desc'),\n      limit(request.limit),\n    )\n  },\n  record(id, data) {\n    const name = crmLeadDisplayName(data)\n    if (!name) return null\n    return {\n      id,\n      name,\n      facts: {\n        email: normalizeContactEmail(data['email']),\n        open: isCrmLeadOpen(data as never) && !data['convertedContactId'],\n      },\n    }\n  },\n}\n\n/** Called from the console registrar, owner named for a spec that calls it directly. */\nexport function registerCrmRecordLists(): void {\n  const owner = { pluginId: BUNDLE_ID }\n  registerPluginRecordListSource('savedView', savedViewRecordListSource, owner)\n  registerPluginRecordListSource('messageTemplate', messageTemplateRecordListSource, owner)\n  registerPluginRecordListSource('contact', contactRecordListSource, owner)\n  registerPluginRecordListSource('lead', leadRecordListSource, owner)\n}\n"],"names":["contactDisplayName","normalizeContactEmail","CRM_COLLECTIONS","crmLeadDisplayName","crmViewIsListed","isCrmLeadOpen","normalizeCrmViewFilters","CRM_EMAIL_TEMPLATES_LIMIT","crmEmailTemplateIsListed","normalizeCrmEmailTemplate","dynamicListDimensionsForCrmView","nameSearchToken","scopeTokensForHost","visibleToHost","registerPluginRecordListSource","collection","limit","orderBy","query","where","BUNDLE_ID","named","value","trim","savedViewRecordListSource","firestore","request","orgId","views","record","id","data","name","shared","ownerUid","String","viewerUid","leads","takeable","unsupported","length","facts","recordKind","messageTemplateRecordListSource","emailTemplates","Math","min","template","hostId","visibleTo","kind","subject","body","contactRecordListSource","email","search","token","contacts","consentGroupId","leadRecordListSource","open","registerCrmRecordLists","owner","pluginId"],"mappings":"AAAA;;;;;;;;;;;;;;;CAeC,GAED,SAASA,kBAAkB,EAAEC,qBAAqB,QAAQ,kCAAiC;AAC3F,SACEC,eAAe,EACfC,kBAAkB,EAClBC,eAAe,EACfC,aAAa,EACbC,uBAAuB,QAClB,6BAA4B;AACnC,SACEC,yBAAyB,EACzBC,wBAAwB,EACxBC,yBAAyB,QACpB,6CAA4C;AACnD,SAASC,+BAA+B,QAAQ,2CAA0C;AAC1F,SAASC,eAAe,QAAQ,qCAAoC;AACpE,SAASC,kBAAkB,EAAEC,aAAa,QAAQ,sCAAqC;AACvF,SACEC,8BAA8B,QAEzB,kDAAiD;AACxD,SAASC,UAAU,EAAEC,KAAK,EAAEC,OAAO,EAAEC,KAAK,EAAEC,KAAK,QAAQ,qBAAoB;AAC7E,SAASC,SAAS,QAAQ,gCAA4B;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BC,GAED,MAAMC,QAAQ,CAACC,QAA4B,OAAOA,UAAU,WAAWA,MAAMC,IAAI,KAAK;AAEtF,OAAO,MAAMC,4BAAoD;IAC/DN,OAAMO,SAAS,EAAEC,OAAO;QACtB,IAAI,CAACA,QAAQC,KAAK,EAAE,OAAO;QAC3B,OAAOT,MACLH,WAAWU,WAAW,QAAQC,QAAQC,KAAK,EAAEzB,gBAAgB0B,KAAK,GAClET,MAAM,WAAW,MAAM;YAAC;YAAY;SAAQ,GAC5CF,QAAQ,SACRD,MAAMU,QAAQV,KAAK;IAEvB;IACAa,QAAOC,EAAE,EAAEC,IAAI,EAAEL,OAAO;YAMkCK;QALxD,MAAMC,OAAOX,MAAMU,IAAI,CAAC,OAAO;QAC/B,IAAI,CAACC,MAAM,OAAO;QAClB,wCAAwC;QACxC,IACE,CAAC5B,gBACC;YAAE6B,QAAQF,IAAI,CAAC,SAAS,KAAK;YAAMG,UAAUC,QAAOJ,iBAAAA,IAAI,CAAC,WAAW,YAAhBA,iBAAoB;QAAI,WAC5EL,2BAAAA,QAASU,SAAS,mBAAI,OAExB;YACA,OAAO;QACT;QACA,MAAMC,QAAQN,IAAI,CAAC,UAAU,KAAK;QAClC,MAAMO,WACJD,SAAS3B,gCAAgCJ,wBAAwByB,IAAI,CAAC,UAAU,GAAGQ,WAAW,CAACC,MAAM,KAAK;QAC5G,OAAO;YAAEV;YAAIE;YAAMS,OAAO;gBAAEC,YAAYL,QAAQ,SAAS;gBAAWC;YAAS;QAAE;IACjF;AACF,EAAC;AAED,OAAO,MAAMK,kCAA0D;IACrEzB,OAAMO,SAAS,EAAEC,OAAO;QACtB,IAAI,CAACA,QAAQC,KAAK,EAAE,OAAO;QAC3B,OAAOT,MACLH,WAAWU,WAAW,QAAQC,QAAQC,KAAK,EAAEzB,gBAAgB0C,cAAc,GAC3E3B,QAAQ,SACRD,MAAM6B,KAAKC,GAAG,CAACpB,QAAQV,KAAK,EAAET;IAElC;IACAsB,QAAOC,EAAE,EAAEC,IAAI,EAAEL,OAAO;;QACtB,MAAMqB,WAAWtC,0BAA0BsB;QAC3C,IAAI,CAACgB,SAASf,IAAI,EAAE,OAAO;QAC3B,8EAA8E;QAC9E,IAAI,CAACxB,yBAAyBuC,kBAAUrB,2BAAAA,QAASU,SAAS,mBAAI,OAAO,OAAO;QAC5E,IAAIV,CAAAA,2BAAAA,QAASsB,MAAM,KAAI,CAACnC,cAAckC,SAASE,SAAS,EAAEvB,QAAQsB,MAAM,GAAG,OAAO;QAClF,OAAO;YACLlB;YACAE,MAAMe,SAASf,IAAI;YACnBS,OAAO;gBAAES,MAAMH,SAASG,IAAI;gBAAEC,SAASJ,SAASI,OAAO;gBAAEC,MAAML,SAASK,IAAI;YAAC;QAC/E;IACF;AACF,EAAC;AAED,OAAO,MAAMC,0BAAkD;IAC7DnC,OAAMO,SAAS,EAAEC,OAAO;QACtB,IAAI,CAACA,QAAQC,KAAK,IAAI,CAACD,QAAQsB,MAAM,EAAE,OAAO;QAC9C,MAAMM,QAAQrD,sBAAsByB,QAAQ6B,MAAM;QAClD,MAAMC,QAAQF,QAAQ,KAAK3C,gBAAgBe,QAAQ6B,MAAM;QACzD,IAAI,CAACD,SAAS,CAACE,OAAO,OAAO;QAC7B,MAAMC,WAAW1C,WAAWU,WAAW,QAAQC,QAAQC,KAAK,EAAE;QAC9D,OAAO2B,QACHpC,MAAMuC,UAAUtC,MAAM,SAAS,MAAMmC,QAAQtC,MAAMU,QAAQV,KAAK,KAChEE,MAAMuC,UAAUtC,MAAM,cAAc,kBAAkBqC,QAAQvC,QAAQ,cAAcD,MAAMU,QAAQV,KAAK;IAC7G;IACAa,QAAOC,EAAE,EAAEC,IAAI,EAAEL,OAAO;QACtB,MAAMsB,SAAStB,2BAAAA,QAASsB,MAAM;QAC9B,IAAIA,UAAU,CAACnC,cAAckB,IAAI,CAAC,YAAY,EAA0BiB,SAAS,OAAO;QACxF,MAAMM,QAAQrD,sBAAsB8B,IAAI,CAAC,QAAQ;QACjD,MAAMC,OAAOhC,mBAAmB+B,MAAML,CAAAA,2BAAAA,QAASgC,cAAc,KAAIV,UAAU,IAAIzB,IAAI,MAAM+B,SAAS;QAClG,IAAI,CAACtB,MAAM,OAAO;QAClB,OAAO;YAAEF;YAAIE;YAAMS,OAAO;gBAAEa;YAAM;QAAE;IACtC;AACF,EAAC;AAED,OAAO,MAAMK,uBAA+C;IAC1DzC,OAAMO,SAAS,EAAEC,OAAO;QACtB,IAAI,CAACA,QAAQC,KAAK,IAAI,CAACD,QAAQsB,MAAM,EAAE,OAAO;QAC9C,0EAA0E;QAC1E,mDAAmD;QACnD,OAAO9B,MACLH,WAAWU,WAAW,QAAQC,QAAQC,KAAK,EAAE,UAC7CR,MAAM,aAAa,sBAAsBP,mBAAmBc,QAAQsB,MAAM,IAC1E/B,QAAQ,gBAAgB,SACxBD,MAAMU,QAAQV,KAAK;IAEvB;IACAa,QAAOC,EAAE,EAAEC,IAAI;QACb,MAAMC,OAAO7B,mBAAmB4B;QAChC,IAAI,CAACC,MAAM,OAAO;QAClB,OAAO;YACLF;YACAE;YACAS,OAAO;gBACLa,OAAOrD,sBAAsB8B,IAAI,CAAC,QAAQ;gBAC1C6B,MAAMvD,cAAc0B,SAAkB,CAACA,IAAI,CAAC,qBAAqB;YACnE;QACF;IACF;AACF,EAAC;AAED,sFAAsF,GACtF,OAAO,SAAS8B;IACd,MAAMC,QAAQ;QAAEC,UAAU3C;IAAU;IACpCN,+BAA+B,aAAaU,2BAA2BsC;IACvEhD,+BAA+B,mBAAmB6B,iCAAiCmB;IACnFhD,+BAA+B,WAAWuC,yBAAyBS;IACnEhD,+BAA+B,QAAQ6C,sBAAsBG;AAC/D"}

package/src/lib/model/crm-reports.d.ts

@@ -30,7 +30,8 @@
  * needs "now" is handed it.
  */
 import type { ContactFacet, ContactSource } from '@aglyn/aglyn/app-utils/contacts';
-import { type ContactLifecycleStage, type CrmActivity, type CrmActivityKind, type CrmDeal, type CrmDealStage, type CrmLeadFields, type CrmLeadStatus, type CrmPipeline, type CrmTask } from '@aglyn/aglyn/app-utils/crm';
+import { type ContactLifecycleStage, type CrmActivity, type CrmActivityKind, type CrmDeal, type CrmDealStage, type CrmLeadFields, type CrmLeadStatus, type CrmPicklist, type CrmPipeline, type CrmTask } from '@aglyn/aglyn/app-utils/crm';
+import { type LeadSourceDirection } from './lead-source-direction';
 /**
  * The periods a report can be read over.
  *
@@ -161,7 +162,7 @@ export interface PipelineTotals {
         amountCents: number;
     };
 }
-type PipelineDeal = Pick<CrmDeal, 'status' | 'stageId' | 'amountCents'>;
+type PipelineDeal = Pick<CrmDeal, 'status' | 'stageId' | 'amountCents'> & Partial<Pick<CrmDeal, 'probability'>>;
 /**
  * What a pipeline holds, by stage.
  *
@@ -223,7 +224,7 @@ export interface CloseMonthForecast {
     later: ForecastCell;
     total: ForecastCell;
 }
-type ForecastDeal = Pick<CrmDeal, 'status' | 'pipelineId' | 'stageId' | 'amountCents' | 'expectedCloseAtMs'>;
+type ForecastDeal = Pick<CrmDeal, 'status' | 'pipelineId' | 'stageId' | 'amountCents' | 'expectedCloseAtMs'> & Partial<Pick<CrmDeal, 'probability' | 'forecastCategory'>>;
 /**
  * The open pipeline laid out by the month each deal is expected to close
  * (AGL-2620): per pipeline, one cell per month for the next
@@ -247,6 +248,32 @@ type ForecastDeal = Pick<CrmDeal, 'status' | 'pipelineId' | 'stageId' | 'amountC
 export declare function forecastByCloseMonth(deals: readonly ForecastDeal[], pipelines: ReadonlyArray<Pick<CrmPipeline, 'name' | 'stages' | 'archivedAt'> & {
     $id: string;
 }>, nowMs: number, months?: number): CloseMonthForecast;
+/**
+ * The rows of the forecast by category (AGL-3516), in the order Salesforce's
+ * forecast reads them: what is still in play from least to most certain,
+ * then what has closed. Omitted is not a forecast row — a deal put there
+ * is one the team chose to leave out — and is reported beside it.
+ */
+export declare const FORECAST_CATEGORY_ROWS: readonly ["pipeline", "bestCase", "commit", "closed"];
+export interface CategoryForecast {
+    /** One cell per {@link FORECAST_CATEGORY_ROWS} entry, every one present. */
+    rows: Record<(typeof FORECAST_CATEGORY_ROWS)[number], ForecastCell>;
+    /** Open deals left out of the forecast on purpose. */
+    omitted: ForecastCell;
+    /** Every row added up — what the forecast forecasts. */
+    total: ForecastCell;
+}
+/**
+ * The forecast by category (AGL-3516): the OPEN deals by the category each
+ * stands in — its own, else its stage's ({@link dealForecastCategory}) —
+ * weighted as everywhere else, and the WON deals the caller read as
+ * Closed, at full value because they have closed. An open deal somebody
+ * put in Closed joins that row at its weighted value — it is still open,
+ * so it is not counted as revenue. A lost deal is never a forecast.
+ */
+export declare function forecastByCategory(openDeals: readonly ForecastDeal[], wonDeals: ReadonlyArray<Pick<CrmDeal, 'status' | 'amountCents'>>, pipelines: ReadonlyArray<Pick<CrmPipeline, 'stages'> & {
+    $id: string;
+}>): CategoryForecast;
 /**
  * How many of a list share each key, most common first.
  *
@@ -464,4 +491,47 @@ export interface OwnerOutcomeRow {
  * the uid, so two renders of one window draw one order.
  */
 export declare function wonLostByOwner(won: readonly OwnerOutcomeDeal[], lost: readonly OwnerOutcomeDeal[]): OwnerOutcomeRow[];
+/** A lead as the lead source tally reads it. */
+type LeadSourceLead = Pick<CrmLeadFields, 'status' | 'leadSource'>;
+/** The key a lead with no lead source is tallied under. */
+export declare const LEAD_SOURCE_NONE_KEY = "";
+export interface LeadSourceRow {
+    /** The label as the org's list spells it, as the lead holds it when unlisted, `''` for none. */
+    label: string;
+    /** The value's group in the org's list; `null` for none, an ungrouped value or an unlisted one. */
+    direction: LeadSourceDirection | null;
+    /** Whether the org's list holds the value at all. */
+    listed: boolean;
+    leads: number;
+    /** Of those, the ones qualified — converted to a contact. */
+    qualified: number;
+    /** `qualified / leads`, 0–1. */
+    rate: number;
+}
+export interface LeadSourceDirectionRow {
+    /** `null` is Unspecified: no lead source, or one in no group. */
+    direction: LeadSourceDirection | null;
+    leads: number;
+    qualified: number;
+    rate: number;
+}
+export interface LeadSourceBreakdown {
+    /** One row per value any lead holds, in the order the org keeps its list; unlisted after, none last. */
+    rows: LeadSourceRow[];
+    /** Inbound, Outbound and Unspecified, each present even at zero. */
+    directions: LeadSourceDirectionRow[];
+    total: number;
+    qualified: number;
+}
+/**
+ * The period's leads by their lead source, and by the direction each
+ * source's group gives it.
+ *
+ * Grouped through the org's EFFECTIVE list as it stands now: two spellings
+ * of one value are one row, a value is listed under the group it is in
+ * today, and a label the list no longer holds stays a row of its own rather
+ * than being folded into another. Qualified is the conversion the Lead
+ * funnel counts — a lead the conversion closed as a contact.
+ */
+export declare function leadsByLeadSource(leads: readonly LeadSourceLead[], picklist: CrmPicklist): LeadSourceBreakdown;
 export {};

package/src/lib/model/crm-reports.js

@@ -28,7 +28,8 @@
  * Pure data module: no Firestore, no React, no clock — every function that
  * needs "now" is handed it.
  */ import { _ as _extends } from "@swc/helpers/_/_extends";
-import { CONTACT_LIFECYCLE_STAGES, CONTACT_LIFECYCLE_STAGE_LABELS, CRM_ACTIVITY_KINDS, CRM_LEAD_STATUSES, crmLeadStatus, dealStageById, isCrmActivityKind, isPipelineArchived, weightedDealAmountCents } from "@aglyn/aglyn/app-utils/crm";
+import { CONTACT_LIFECYCLE_STAGES, CONTACT_LIFECYCLE_STAGE_LABELS, CRM_ACTIVITY_KINDS, CRM_LEAD_STATUSES, crmLeadStatus, crmPicklistRank, crmPicklistValueByLabel, dealForecastCategory, dealStageById, isCrmActivityKind, isPipelineArchived, weightedDealAmountCents } from "@aglyn/aglyn/app-utils/crm";
+import { leadSourceDirectionOf } from "./lead-source-direction.js";
 const DAY_MS = 24 * 60 * 60 * 1000;
 const WEEK_MS = 7 * DAY_MS;
 /**
@@ -360,6 +361,59 @@ function addToCell(cell, amountCents, weightedCents) {
     ];
     return totals;
 }
+/**
+ * The rows of the forecast by category (AGL-3516), in the order Salesforce's
+ * forecast reads them: what is still in play from least to most certain,
+ * then what has closed. Omitted is not a forecast row — a deal put there
+ * is one the team chose to leave out — and is reported beside it.
+ */ export const FORECAST_CATEGORY_ROWS = [
+    'pipeline',
+    'bestCase',
+    'commit',
+    'closed'
+];
+/**
+ * The forecast by category (AGL-3516): the OPEN deals by the category each
+ * stands in — its own, else its stage's ({@link dealForecastCategory}) —
+ * weighted as everywhere else, and the WON deals the caller read as
+ * Closed, at full value because they have closed. An open deal somebody
+ * put in Closed joins that row at its weighted value — it is still open,
+ * so it is not counted as revenue. A lost deal is never a forecast.
+ */ export function forecastByCategory(openDeals, wonDeals, pipelines) {
+    const forecast = {
+        rows: {
+            pipeline: emptyCell(),
+            bestCase: emptyCell(),
+            commit: emptyCell(),
+            closed: emptyCell()
+        },
+        omitted: emptyCell(),
+        total: emptyCell()
+    };
+    for (const deal of openDeals){
+        var _deal_amountCents;
+        if (deal.status !== 'open') continue;
+        const pipeline = pipelines.find((entry)=>entry.$id === deal.pipelineId);
+        const stage = dealStageById(pipeline, deal.stageId);
+        const amount = Math.max(0, Math.round(Number((_deal_amountCents = deal.amountCents) != null ? _deal_amountCents : 0) || 0));
+        const weighted = weightedDealAmountCents(deal, stage);
+        const category = dealForecastCategory(deal, stage);
+        if (category === 'omitted') {
+            addToCell(forecast.omitted, amount, weighted);
+            continue;
+        }
+        addToCell(forecast.rows[category], amount, weighted);
+        addToCell(forecast.total, amount, weighted);
+    }
+    for (const deal of wonDeals){
+        var _deal_amountCents1;
+        if (deal.status !== 'won') continue;
+        const amount = Math.max(0, Math.round(Number((_deal_amountCents1 = deal.amountCents) != null ? _deal_amountCents1 : 0) || 0));
+        addToCell(forecast.rows.closed, amount, amount);
+        addToCell(forecast.total, amount, amount);
+    }
+    return forecast;
+}
 /**
  * How many of a list share each key, most common first.
  *
@@ -663,5 +717,70 @@ export const LEAD_NO_REASON_LABEL = 'No reason given';
             winRate: row.closed ? row.won / row.closed : null
         })).sort((a, b)=>b.closed - a.closed || b.won - a.won || a.uid.localeCompare(b.uid));
 }
+/** The key a lead with no lead source is tallied under. */ export const LEAD_SOURCE_NONE_KEY = '';
+/**
+ * The period's leads by their lead source, and by the direction each
+ * source's group gives it.
+ *
+ * Grouped through the org's EFFECTIVE list as it stands now: two spellings
+ * of one value are one row, a value is listed under the group it is in
+ * today, and a label the list no longer holds stays a row of its own rather
+ * than being folded into another. Qualified is the conversion the Lead
+ * funnel counts — a lead the conversion closed as a contact.
+ */ export function leadsByLeadSource(leads, picklist) {
+    const rows = new Map();
+    const directions = new Map([
+        'inbound',
+        'outbound',
+        null
+    ].map((direction)=>[
+            direction,
+            {
+                direction,
+                leads: 0,
+                qualified: 0,
+                rate: 0
+            }
+        ]));
+    let qualified = 0;
+    for (const lead of leads){
+        var _lead_leadSource, _ref, _rows_get;
+        const isQualified = crmLeadStatus(lead) === 'qualified';
+        if (isQualified) qualified += 1;
+        const held = String((_lead_leadSource = lead.leadSource) != null ? _lead_leadSource : '').replace(/\s+/g, ' ').trim();
+        const value = held ? crmPicklistValueByLabel(picklist, held) : null;
+        const label = (_ref = value == null ? void 0 : value.label) != null ? _ref : held;
+        const key = label.toLowerCase();
+        const direction = held ? leadSourceDirectionOf(picklist, held) : null;
+        const row = (_rows_get = rows.get(key)) != null ? _rows_get : {
+            label,
+            direction,
+            listed: Boolean(value),
+            leads: 0,
+            qualified: 0,
+            rate: 0
+        };
+        row.leads += 1;
+        if (isQualified) row.qualified += 1;
+        rows.set(key, row);
+        const tally = directions.get(direction);
+        tally.leads += 1;
+        if (isQualified) tally.qualified += 1;
+    }
+    const rate = (row)=>_extends({}, row, {
+            rate: row.leads > 0 ? row.qualified / row.leads : 0
+        });
+    const rank = (row)=>row.label === LEAD_SOURCE_NONE_KEY ? Number.MAX_SAFE_INTEGER : crmPicklistRank(picklist, row.label);
+    return {
+        rows: [
+            ...rows.values()
+        ].map(rate).sort((a, b)=>rank(a) - rank(b) || a.label.localeCompare(b.label)),
+        directions: [
+            ...directions.values()
+        ].map(rate),
+        total: leads.length,
+        qualified
+    };
+}
 
 //# sourceMappingURL=crm-reports.js.map