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

package/src/lib/server/api-v1/crm-leads.js

@@ -68,10 +68,12 @@ import { _ as _object_without_properties_loose } from "@swc/helpers/_/_object_wi
  * makes it true. A converted lead's status is fixed for the same reason.
  * Reopening an unqualified lead drops its reason, as the console does: a
  * lead being worked again is not "unqualified because …".
- */ import { checkVisitorRecordCeiling, CRM_LEAD_STATUSES, crmLeadStatus, crmMemberOption, findOrgMember, LEADS_MAX_PER_HOST, normalizeCompanyDomain, normalizeContactEmail, crmPicklistDefaultLabel, judgeCrmLeadSource, normalizeCrmLeadProfile, personKey, readMarketingBasis, soloConsentGroup } from "@aglyn/aglyn/server";
+ */ import { checkVisitorRecordCeiling, CRM_LEAD_STATUSES, crmLeadComposedName, CRM_COLLECTIONS, crmLeadStatus, crmLeadStatusLabel, CRM_LEAD_STATUS_PICKLIST, crmMemberOption, effectiveCrmLeadStatusPicklist, resolveCrmLeadStatusWrite, findOrgMember, LEADS_MAX_PER_HOST, normalizeCompanyDomain, normalizeContactEmail, crmPicklistDefaultLabel, judgeCrmLeadSource, judgeCrmPicklistValue, normalizeCrmLeadProfile, personKey, readMarketingBasis, soloConsentGroup } from "@aglyn/aglyn/server";
 import { scopeTokensForHost } from "@aglyn/aglyn/app-utils/scope-tokens";
 import { addHostLead, apiJson, ApiErrors, decodeCursor, encodeCursor, listOrgMembers, listResponse, parseLimit, restampCrmListFieldsAt } from "@aglyn/tenant-data-admin";
 import { convertHostLead } from "../convert-host-lead.js";
+import { readCrmPicklist } from "../read-picklist.js";
+import { judgeLeadPicklistPatch, namesLeadPicklist, readLeadPicklists } from "../lead-picklists.js";
 import { FieldPath, FieldValue, Timestamp } from "firebase-admin/firestore";
 import { claimWrite, orgOwnsHost, readJsonBody, requireScope } from "@aglyn/tenant-data-admin/server/api-v1-kit";
 import { CRM_ID_MAX, CRM_LABEL_MAX, CRM_TEXT_MAX, CRM_TITLE_MAX, crmCustomUpdate, crmCustomView, crmTimes, crmValidationFailed, isoFromMs, memberError, readCrmCustomBody, readOptionalText, readOrgLeadSourcePicklist, refuseUnknownKeys, updatePayload } from "./crm-shared.js";
@@ -90,8 +92,8 @@ import { CRM_ID_MAX, CRM_LABEL_MAX, CRM_TEXT_MAX, CRM_TITLE_MAX, crmCustomUpdate
     'unqualified'
 ];
 // ── The view ────────────────────────────────────────────────────────────────
-/** The lead object as published. Every writable field appears here. */ function leadView(siteId, doc) {
-    var _doc_data, _data_ownerUid, _data_notes, _data_unqualifiedReason, _data_company, _data_jobTitle, _data_phone, _data_website, _data_address, _data_leadSource, _data_convertedContactId, _data_companyId, _data_dealId;
+/** The lead object as published. Every writable field appears here. */ function leadView(siteId, doc, statuses) {
+    var _doc_data, _data_ownerUid, _data_notes, _data_unqualifiedReason, _data_company, _data_jobTitle, _data_phone, _data_website, _data_address, _data_leadSource, _data_salutation, _data_firstName, _data_lastName, _data_mobilePhone, _data_fax, _data_industry, _data_rating, _data_convertedContactId, _data_companyId, _data_dealId;
     const data = (_doc_data = doc.data()) != null ? _doc_data : {};
     // The lead's own silo — a group of one, however the org pools its
     // contacts — which is where `addHostLead` recorded the basis.
@@ -103,6 +105,8 @@ import { CRM_ID_MAX, CRM_LABEL_MAX, CRM_TEXT_MAX, CRM_TITLE_MAX, crmCustomUpdate
         email: typeof data['email'] === 'string' ? data['email'] : null,
         name: typeof data['name'] === 'string' ? data['name'] : null,
         status: crmLeadStatus(data),
+        // The org's label for the value the lead holds, of `status`'s meaning (AGL-3512).
+        statusLabel: crmLeadStatusLabel(data, statuses),
         ownerUid: (_data_ownerUid = data.ownerUid) != null ? _data_ownerUid : null,
         notes: (_data_notes = data.notes) != null ? _data_notes : null,
         unqualifiedReason: (_data_unqualifiedReason = data.unqualifiedReason) != null ? _data_unqualifiedReason : null,
@@ -114,6 +118,18 @@ import { CRM_ID_MAX, CRM_LABEL_MAX, CRM_TEXT_MAX, CRM_TITLE_MAX, crmCustomUpdate
         address: (_data_address = data.address) != null ? _data_address : null,
         tags: Array.isArray(data.tags) ? data.tags.map(String) : [],
         leadSource: (_data_leadSource = data.leadSource) != null ? _data_leadSource : null,
+        // Salesforce's standard lead fields (AGL-3513).
+        salutation: (_data_salutation = data.salutation) != null ? _data_salutation : null,
+        firstName: (_data_firstName = data.firstName) != null ? _data_firstName : null,
+        lastName: (_data_lastName = data.lastName) != null ? _data_lastName : null,
+        mobilePhone: (_data_mobilePhone = data.mobilePhone) != null ? _data_mobilePhone : null,
+        fax: (_data_fax = data.fax) != null ? _data_fax : null,
+        doNotCall: data.doNotCall === true,
+        industry: (_data_industry = data.industry) != null ? _data_industry : null,
+        rating: (_data_rating = data.rating) != null ? _data_rating : null,
+        annualRevenueCents: typeof data.annualRevenueCents === 'number' ? data.annualRevenueCents : null,
+        currency: typeof data.currency === 'string' && data.currency ? data.currency : 'usd',
+        numberOfEmployees: typeof data.numberOfEmployees === 'number' ? data.numberOfEmployees : null,
         sources: Array.isArray(data['sources']) ? data['sources'].map(String) : [],
         submissionCount: typeof data['submissionCount'] === 'number' ? data['submissionCount'] : 0,
         firstSeen: isoFromMs(data['firstSeenAtMs']),
@@ -199,14 +215,25 @@ import { CRM_ID_MAX, CRM_LABEL_MAX, CRM_TEXT_MAX, CRM_TITLE_MAX, crmCustomUpdate
     return found.uid;
 }
 // ── PATCH ───────────────────────────────────────────────────────────────────
-/** The lead's own fields, writable on a create and a PATCH alike (AGL-3231). */ const LEAD_PROFILE_KEYS = [
+/** The lead's own fields, writable on a create and a PATCH alike (AGL-3231, AGL-3513). */ const LEAD_PROFILE_KEYS = [
     'company',
     'jobTitle',
     'phone',
     'website',
     'address',
     'tags',
-    'leadSource'
+    'leadSource',
+    'salutation',
+    'firstName',
+    'lastName',
+    'mobilePhone',
+    'fax',
+    'doNotCall',
+    'industry',
+    'rating',
+    'annualRevenueCents',
+    'currency',
+    'numberOfEmployees'
 ];
 const LEAD_WRITABLE = new Set([
     'siteId',
@@ -243,14 +270,13 @@ function readLeadInput(body) {
     const profile = normalizeCrmLeadProfile(profileBody);
     Object.assign(errors, profile.errors);
     values.profile = profile.patch;
+    // A flag, sent as one: a string would otherwise read as a clear.
+    if (body.doNotCall !== undefined && body.doNotCall !== null && typeof body.doNotCall !== 'boolean') {
+        errors.doNotCall = 'Must be true or false';
+    }
     if (body.status !== undefined) {
-        if (body.status === 'qualified') {
-            errors.status = 'Not settable — a lead is qualified by converting it: POST /v1/leads/{id}/convert';
-        } else if (typeof body.status === 'string' && LEAD_PATCH_STATUSES.includes(body.status)) {
-            values.status = body.status;
-        } else {
-            errors.status = `Must be one of: ${LEAD_PATCH_STATUSES.join(', ')}`;
-        }
+        if (typeof body.status === 'string' && body.status.trim()) values.status = body.status;
+        else errors.status = 'Must be one of the organization’s lead status values, or a meaning';
     }
     const notes = readOptionalText(body, 'notes', CRM_TEXT_MAX, errors);
     if (notes !== undefined) values.notes = notes;
@@ -266,7 +292,17 @@ function readLeadInput(body) {
     var _snap_data;
     const body = await readJsonBody(request);
     const parsed = readLeadInput(body);
-    if ('errors' in parsed) return crmValidationFailed(ctx, 'lead', parsed.errors);
+    if ('errors' in parsed) {
+        // A status is judged against the org's list, so a body refused for
+        // another key still hears about its status in the same answer.
+        if (typeof body.status === 'string' && !parsed.errors.status) {
+            const judged = resolveCrmLeadStatusWrite(await readOrgLeadStatusPicklist(ctx), body.status, {
+                allowed: LEAD_PATCH_STATUSES
+            });
+            if (judged.ok === false) parsed.errors.status = judged.error;
+        }
+        return crmValidationFailed(ctx, 'lead', parsed.errors);
+    }
     const site = readLeadSite(ctx, url, body);
     if ('response' in site) return site.response;
     const ref = leadsCollection(ctx, site.siteId).doc(leadId);
@@ -294,7 +330,18 @@ function readLeadInput(body) {
     const ownerUid = await readOwner(ctx, body, errors);
     if (ownerUid) Object.assign(errors, await memberError(ctx, 'ownerUid', ownerUid));
     const current = crmLeadStatus(stored);
-    const next = status != null ? status : current;
+    /*
+   * THE ORG'S LEAD STATUSES (AGL-3512): a label or a meaning, stored as
+   * the meaning and the org's label together. Qualified is a conversion's.
+   */ const statuses = await readOrgLeadStatusPicklist(ctx);
+    const judgedStatus = status === undefined ? null : resolveCrmLeadStatusWrite(statuses, status, {
+        allowed: LEAD_PATCH_STATUSES,
+        current: stored
+    });
+    if ((judgedStatus == null ? void 0 : judgedStatus.ok) === false) {
+        errors.status = resolveCrmLeadStatusWrite(statuses, status).ok ? 'Not settable — a lead is qualified by converting it: POST /v1/leads/{id}/convert' : judgedStatus.error;
+    }
+    const next = (judgedStatus == null ? void 0 : judgedStatus.ok) ? judgedStatus.status : current;
     /*
    * A reason travels with the closed state and only with it. Sent beside
    * `status: "unqualified"` it is required; sent on its own it changes the
@@ -318,7 +365,15 @@ function readLeadInput(body) {
         if (judged.ok === false) errors.leadSource = judged.error;
         else profile.leadSource = judged.value;
     }
+    // Salutation, Industry and Rating (AGL-3513), the lead keeping its current value.
+    if (namesLeadPicklist(profile)) {
+        Object.assign(errors, judgeLeadPicklistPatch(await readLeadPicklists(ctx.firestore, ctx.orgId), profile, {
+            current: stored
+        }));
+    }
     if (Object.keys(errors).length) return crmValidationFailed(ctx, 'lead', errors);
+    // While a first or last name is set, the name is theirs (AGL-3513).
+    const composedName = crmLeadComposedName(stored, profile);
     // The org's own lead fields (AGL-3272), judged against the definitions
     // whose object is `lead` — a contact field of the same key is a
     // different field with a possibly different type.
@@ -326,8 +381,13 @@ function readLeadInput(body) {
     if (custom && 'errors' in custom) return crmValidationFailed(ctx, 'lead', custom.errors);
     const update = _extends({}, updatePayload(_extends({}, rest, {
         ownerUid
-    })), profileUpdate(profile), custom && 'values' in custom ? crmCustomUpdate(custom.values) : {});
-    if (status !== undefined && status !== current) update.status = status;
+    })), profileUpdate(profile), composedName && composedName !== stored['name'] ? {
+        name: composedName
+    } : {}, custom && 'values' in custom ? crmCustomUpdate(custom.values) : {});
+    if (judgedStatus == null ? void 0 : judgedStatus.ok) {
+        if (judgedStatus.status !== current) update.status = judgedStatus.status;
+        if (judgedStatus.statusLabel !== stored.statusLabel) update.statusLabel = judgedStatus.statusLabel;
+    }
     if (next === 'unqualified') {
         if (unqualifiedReason !== undefined) update.unqualifiedReason = unqualifiedReason;
     } else if (stored.unqualifiedReason !== undefined) {
@@ -341,10 +401,14 @@ function readLeadInput(body) {
         // What the console's Leads list searches and filters by (AGL-3321).
         await restampCrmListFieldsAt(ref, 'leads');
     }
-    return apiJson(leadView(site.siteId, await ref.get()), {
+    return apiJson(leadView(site.siteId, await ref.get(), statuses), {
         headers: ctx.headers
     });
 }
+/** The org's Lead status list (AGL-3512) — what a status write is judged against and a view labels by. */ async function readOrgLeadStatusPicklist(ctx) {
+    const snapshot = await ctx.firestore.collection('orgs').doc(ctx.orgId).collection(CRM_COLLECTIONS.picklists).doc(CRM_LEAD_STATUS_PICKLIST).get();
+    return effectiveCrmLeadStatusPicklist(snapshot.data());
+}
 // ── Create ──────────────────────────────────────────────────────────────────
 const LEAD_CREATE_STATUSES = [
     'new',
@@ -368,13 +432,18 @@ const LEAD_NAME_MAX = 120;
     if (!email) errors.email = 'Required — an email address';
     const name = readOptionalText(body, 'name', LEAD_NAME_MAX, errors);
     const notes = readOptionalText(body, 'notes', CRM_TEXT_MAX, errors);
+    // A label or a meaning of New or Working, stored as both (AGL-3512).
+    const statuses = await readOrgLeadStatusPicklist(ctx);
     let status;
     if (body.status !== undefined && body.status !== null) {
-        if (typeof body.status === 'string' && LEAD_CREATE_STATUSES.includes(body.status)) {
-            status = body.status;
-        } else {
-            errors.status = `Must be one of: ${LEAD_CREATE_STATUSES.join(', ')}`;
-        }
+        const judged = resolveCrmLeadStatusWrite(statuses, body.status, {
+            allowed: LEAD_CREATE_STATUSES
+        });
+        if (judged.ok === false) errors.status = judged.error;
+        else status = {
+            status: judged.status,
+            statusLabel: judged.statusLabel
+        };
     }
     if (body.unqualifiedReason !== undefined) {
         errors.unqualifiedReason = 'Not settable on a create — unqualify with a PATCH';
@@ -385,6 +454,9 @@ const LEAD_NAME_MAX = 120;
     }
     const profile = normalizeCrmLeadProfile(profileBody);
     Object.assign(errors, profile.errors);
+    if (body.doNotCall !== undefined && body.doNotCall !== null && typeof body.doNotCall !== 'boolean') {
+        errors.doNotCall = 'Must be true or false';
+    }
     const site = readLeadSite(ctx, url, body);
     if ('response' in site) {
         if (Object.keys(errors).length) {
@@ -406,6 +478,7 @@ const LEAD_NAME_MAX = 120;
     if ('replay' in claimed) return claimed.replay;
     const { claim } = claimed;
     try {
+        var _existing_data, _existing_data1;
         const hostRef = ctx.firestore.collection('hosts').doc(site.siteId);
         const leadsRef = leadsCollection(ctx, site.siteId);
         // Non-null by construction: the normalizer refused every address this
@@ -432,6 +505,17 @@ const LEAD_NAME_MAX = 120;
             const fallback = crmPicklistDefaultLabel(leadSources);
             if (fallback) profile.patch.leadSource = fallback;
         }
+        // Salutation, Industry and Rating (AGL-3513): a new lead starts from each list's default.
+        const picklistErrors = judgeLeadPicklistPatch(await readLeadPicklists(ctx.firestore, ctx.orgId), profile.patch, {
+            current: (_existing_data = existing.data()) != null ? _existing_data : null,
+            created
+        });
+        if (Object.keys(picklistErrors).length) {
+            await claim.release();
+            return crmValidationFailed(ctx, 'lead', picklistErrors);
+        }
+        // While a first or last name is set, the name is theirs (AGL-3513).
+        const composedName = crmLeadComposedName((_existing_data1 = existing.data()) != null ? _existing_data1 : null, profile.patch);
         if (created) {
             // What the SITE may see (AGL-3275), matching `addHostLead`'s own count:
             // an unscoped count would charge one site for a sibling's leads.
@@ -450,8 +534,8 @@ const LEAD_NAME_MAX = 120;
             hostId: site.siteId,
             lead: _extends({
                 email: email
-            }, name ? {
-                name
+            }, composedName || name ? {
+                name: composedName || name
             } : {}, {
                 source: LEAD_API_SOURCE
             })
@@ -464,8 +548,11 @@ const LEAD_NAME_MAX = 120;
                 headers: ctx.headers
             });
         }
-        const working = _extends({}, profileUpdate(profile.patch), status ? {
-            status
+        const working = _extends({}, profileUpdate(profile.patch), composedName ? {
+            name: composedName
+        } : {}, status ? {
+            status: status.status,
+            statusLabel: status.statusLabel
         } : {}, ownerUid ? {
             ownerUid
         } : {}, notes ? {
@@ -483,7 +570,7 @@ const LEAD_NAME_MAX = 120;
             // What the console's Leads list searches and filters by (AGL-3321).
             await restampCrmListFieldsAt(ref, 'leads');
         }
-        const view = leadView(site.siteId, await ref.get());
+        const view = leadView(site.siteId, await ref.get(), statuses);
         await claim.record(created ? 201 : 200, view);
         return apiJson(view, {
             status: created ? 201 : 200,
@@ -565,7 +652,8 @@ const isPlainObject = (value)=>Boolean(value) && typeof value === 'object' && !A
                     'title',
                     'amountCents',
                     'currency',
-                    'stageId'
+                    'stageId',
+                    'type'
                 ].includes(key)) {
                     errors[`deal.${key}`] = 'Not writable on a deal opened here';
                 }
@@ -594,13 +682,22 @@ const isPlainObject = (value)=>Boolean(value) && typeof value === 'object' && !A
                     stageId = deal.stageId.trim().slice(0, CRM_ID_MAX);
                 }
             }
-            if (title) plan.deal = _extends({
-                title,
-                amountCents,
-                currency
-            }, stageId ? {
-                stageId
-            } : {});
+            let type;
+            if (deal.type !== undefined && deal.type !== null) {
+                if (typeof deal.type !== 'string') errors['deal.type'] = 'Must be a string';
+                else type = deal.type.trim().slice(0, CRM_TITLE_MAX) || undefined;
+            }
+            if (title) {
+                plan.deal = _extends({
+                    title,
+                    amountCents,
+                    currency
+                }, stageId ? {
+                    stageId
+                } : {}, type ? {
+                    type
+                } : {});
+            }
         }
     }
     return Object.keys(errors).length ? {
@@ -610,6 +707,7 @@ const isPlainObject = (value)=>Boolean(value) && typeof value === 'object' && !A
     };
 }
 /** `POST /v1/leads/{id}/convert`. */ async function convertLead(request, ctx, url, leadId) {
+    var _parsed_plan_deal;
     const body = await readJsonBody(request);
     const parsed = readConvertInput(body);
     if ('errors' in parsed) return crmValidationFailed(ctx, 'conversion', parsed.errors);
@@ -618,6 +716,13 @@ const isPlainObject = (value)=>Boolean(value) && typeof value === 'object' && !A
     const errors = {};
     const ownerUid = await readOwner(ctx, body, errors);
     if (ownerUid) Object.assign(errors, await memberError(ctx, 'ownerUid', ownerUid));
+    // The deal's Type against the org's list (AGL-3516), the deal resource's rule.
+    if ((_parsed_plan_deal = parsed.plan.deal) == null ? void 0 : _parsed_plan_deal.type) {
+        var _judged_value;
+        const judged = judgeCrmPicklistValue('opportunityType', await readCrmPicklist(ctx.firestore, ctx.orgId, 'opportunityType'), parsed.plan.deal.type);
+        if (judged.ok === false) errors['deal.type'] = judged.error;
+        else parsed.plan.deal.type = (_judged_value = judged.value) != null ? _judged_value : undefined;
+    }
     if (Object.keys(errors).length) return crmValidationFailed(ctx, 'conversion', errors);
     const ref = leadsCollection(ctx, site.siteId).doc(leadId);
     if (!(await ref.get()).exists) {
@@ -663,7 +768,7 @@ const isPlainObject = (value)=>Boolean(value) && typeof value === 'object' && !A
             companyId: (_result_companyId = result.companyId) != null ? _result_companyId : null,
             dealId: (_result_dealId = result.dealId) != null ? _result_dealId : null,
             alreadyConverted: result.alreadyConverted,
-            lead: leadView(site.siteId, await ref.get())
+            lead: leadView(site.siteId, await ref.get(), await readOrgLeadStatusPicklist(ctx))
         };
         await claim.record(200, receipt);
         return apiJson(receipt, {
@@ -762,7 +867,8 @@ function decodeLeadCursor(raw) {
         if (ownerUid && data.ownerUid !== ownerUid) return false;
         return true;
     });
-    return listResponse(page.map((doc)=>leadView(site.siteId, doc)), nextCursor, ctx.headers);
+    const statuses = await readOrgLeadStatusPicklist(ctx);
+    return listResponse(page.map((doc)=>leadView(site.siteId, doc, statuses)), nextCursor, ctx.headers);
 }
 // ── Dispatch ────────────────────────────────────────────────────────────────
 export async function handleLeads(request, ctx, segments, url) {
@@ -814,7 +920,7 @@ export async function handleLeads(request, ctx, segments, url) {
                 headers: ctx.headers
             });
         }
-        return apiJson(leadView(site.siteId, snap), {
+        return apiJson(leadView(site.siteId, snap, await readOrgLeadStatusPicklist(ctx)), {
             headers: ctx.headers
         });
     }