@aglyn/plugins-crm 1.0.0 → 1.2.0

package/src/lib/server/api-v1/contacts.js

@@ -15,7 +15,7 @@ import { _ as _extends } from "@swc/helpers/_/_extends";
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ import { nameSearchFields } from "@aglyn/aglyn/app-utils/name-search";
-import { CAPTURED_BY_HOST_FIELD, composeContactName, CONTACT_BIRTHDATE_REFUSAL, CONTACT_COMPANY_IDS_FIELD, CONTACT_EXTRA_PHONE_FIELDS, CONTACT_FACETS_FIELD, CONTACT_FIELDS_MAX_PER_ORG, CONTACT_LIFECYCLE_STAGES, CONTACT_NAME_PART_MAX, consentGroupForHost, contactFacetPath, createResourceUid, CRM_COLLECTIONS, CRM_LEAD_SOURCE_PICKLIST, CRM_MEDIA_IDS_MAX, CRM_SALUTATION_PICKLIST, isContactLifecycleStage, judgeCrmPicklistValue, MARKETING_CONSENT_BY_HOST_FIELD, marketingConsentFieldsForGroup, marketingConsentHostIds, normalizeAddress, normalizeContactBirthdate, normalizeContactEmail, normalizeCrmMediaIds, normalizePhone, ORG_SCOPE_TOKEN, planContactCompanyLink, readContactCompanyLink, readContactCustomInput, readContactFacet, soloConsentGroup } from "@aglyn/aglyn/server";
+import { CAPTURED_BY_HOST_FIELD, composeContactName, CONTACT_BIRTHDATE_REFUSAL, CONTACT_COMPANY_IDS_FIELD, CONTACT_EXTRA_PHONE_FIELDS, CONTACT_FACETS_FIELD, ORG_CONTACT_HOLDER_ID, CONTACT_FIELDS_MAX_PER_ORG, CONTACT_LIFECYCLE_STAGES, CONTACT_NAME_PART_MAX, consentGroupForHost, crmDefaultScopeOf, crmScopeTokens, contactFacetPath, createResourceUid, CRM_COLLECTIONS, CRM_LEAD_SOURCE_PICKLIST, CRM_MEDIA_IDS_MAX, CRM_SALUTATION_PICKLIST, isContactLifecycleStage, judgeCrmPicklistValue, MARKETING_CONSENT_BY_HOST_FIELD, marketingConsentFieldsForGroup, marketingConsentHostIds, normalizeAddress, normalizeContactBirthdate, normalizeContactEmail, normalizeCrmMediaIds, normalizePhone, ORG_SCOPE_TOKEN, planContactCompanyLink, readContactCompanyLink, readContactCustomInput, readContactFacet, soloConsentGroup } from "@aglyn/aglyn/server";
 import { ApiErrors, apiJson, contactCompanyMirrorValue, crmRecordsQuotaForOrg, listResponse, restampCrmListFieldsAt, settleCompanyContactsCounts } from "@aglyn/tenant-data-admin";
 import { claimWrite, orgOwnsHost, paginate, readJsonBody, requireScope, serialize } from "@aglyn/tenant-data-admin/server/api-v1-kit";
 // The leaf, so a spec that stands a partial barrel in still reaches it.
@@ -163,12 +163,13 @@ function contactCrmProfile(data, groupId) {
  * @param groupId - the holder whose CRM profile to publish, or `null` for
  *   the union — see {@link contactCrmProfile}.
  */ function contactView(doc, groupId = null) {
-    var _doc_data, _data_email, _data_name, _data_tags, _data_notes, _serialize, _serialize1;
+    var _doc_data, _data_name, _data_tags, _data_notes, _serialize, _serialize1;
     const data = (_doc_data = doc.data()) != null ? _doc_data : {};
     return _extends({
         id: doc.id,
         object: 'contact',
-        email: (_data_email = data.email) != null ? _data_email : null,
+        // Blank in the store so a sort lists them; no address to an integrator.
+        email: data.email || null,
         name: (_data_name = data.name) != null ? _data_name : null,
         tags: (_data_tags = data.tags) != null ? _data_tags : [],
         notes: (_data_notes = data.notes) != null ? _data_notes : null
@@ -259,9 +260,13 @@ function readContactInput(body, { partial }) {
         // The SAME normalizer every capture point uses. Re-implementing the
         // check here would let the API accept an address `upsertHostContact`
         // would reject, and the two would then disagree about who is a duplicate.
-        const email = normalizeContactEmail(body.email);
-        if (!email) errors.email = 'A valid email address is required';
-        else values.email = email;
+        // Optional (AGL-4122): an address that was sent still has to be one, and
+        // a person with none is named below instead.
+        if (body.email !== undefined && body.email !== null && body.email !== '') {
+            const email = normalizeContactEmail(body.email);
+            if (!email) errors.email = 'A valid email address is required';
+            else values.email = email;
+        }
     }
     if (body.name !== undefined) {
         var _body_name;
@@ -449,9 +454,16 @@ function readContactInput(body, { partial }) {
    * sites is this write made on behalf of — and an integrator should not
    * learn two names for it. Beside a refusal the site is accepted, since the
    * refusal still applies to every site and the site now names the facet.
-   */ if (writesCrm && !values.consentSiteId) {
+   */ if (writesCrm && !values.consentSiteId && partial) {
         errors.consentSiteId = 'Required with a CRM profile field — name the site whose profile of this person to write';
     }
+    /*
+   * WHO THIS IS (AGL-4122). A contact needs no address, so a create needs
+   * something else to call them by. With no site and no address the profile is
+   * the organization's own, and nothing here narrows that.
+   */ if (!partial && !values.email && !values.name && !values.crm.phone && !values.crm.mobilePhone && !values.crm.firstName && !values.crm.lastName && !errors.email) {
+        errors.email = 'Send an email, a name or a phone number';
+    }
     if (values.marketingConsent === false && values.consentSiteId && !writesCrm) {
         errors.consentSiteId = 'Not accepted with marketingConsent: false — a refusal applies to every site';
     }
@@ -580,10 +592,11 @@ function readContactInput(body, { partial }) {
     // The holder's name is the first and last names' when either was given.
     const composed = composeContactName(crm.firstName, crm.lastName);
     if (composed) stored['name'] = composed;
-    const group = consentGroupForHost(ctx.org, siteId);
+    // The person's holder, or the organization when no site was named (AGL-4122).
+    const groupId = siteId ? consentGroupForHost(ctx.org, siteId).groupId : ORG_CONTACT_HOLDER_ID;
     return _extends({
         [CONTACT_FACETS_FIELD]: {
-            [group.groupId]: _extends({
+            [groupId]: _extends({
                 sources: {
                     api: true
                 },
@@ -717,10 +730,11 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
  * taking-and-releasing on a genuine refusal. AGL-2278 applies it to the two
  * older creates.
  *
- * `visibleTo` is stamped with `ORG_SCOPE_TOKEN`, as capture does. A contact
- * written without it matches no `array-contains-any` and is therefore visible
- * on NO site (AGL-1044) — the API would create data nobody can see, which is
- * worse than refusing.
+ * `visibleTo` is stamped with `ORG_SCOPE_TOKEN`, as capture does — or, in an
+ * org that keeps each site's records apart, the named site's group, which
+ * that org must then name. A contact written without one matches no
+ * `array-contains-any` and is therefore visible on NO site (AGL-1044) — the
+ * API would create data nobody can see, which is worse than refusing.
  */ async function createContact(request, ctx) {
     // Validation stays above the claim, as `createRecord` argues: a
     // deterministic 400 must never take the key at all, so an integrator fixes
@@ -747,6 +761,25 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
             headers: ctx.headers
         });
     }
+    /*
+   * Who may see the new contact: the whole org, unless the org keeps each
+   * site's records apart — then the named site's group, and a contact named
+   * by no site has nowhere to belong. A deterministic 400, so above the claim.
+   */ const orgDocument = ctx.org;
+    const keepsSitesApart = crmDefaultScopeOf(orgDocument) === 'host';
+    if (keepsSitesApart && !consentSiteId) {
+        return ApiErrors.badRequest({
+            message: 'Contact failed validation',
+            code: 'validation_failed',
+            fields: {
+                consentSiteId: "Required — this organization keeps each site's records apart, so name the site this contact belongs to"
+            },
+            headers: ctx.headers
+        });
+    }
+    const visibleTo = keepsSitesApart && consentSiteId ? crmScopeTokens(orgDocument, consentGroupForHost(orgDocument, consentSiteId)) : [
+        ORG_SCOPE_TOKEN
+    ];
     // Judged against the org's definitions, above the claim like every other
     // deterministic 400: an unknown key is named, never dropped (AGL-2601).
     const custom = parsed.values.custom ? readContactCustomInput(parsed.values.custom, await readOrgContactFieldDefinitions(ctx)) : null;
@@ -780,16 +813,20 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
     if ('replay' in claimed) return claimed.replay;
     const { claim } = claimed;
     try {
+        var _docs_;
         // Through the org's address index (AGL-2633): an address a merge folded
         // into another record is that record's, and a create on it would mint
         // the duplicate the merge removed.
-        const existing = await findContactByEmail(collection, email);
+        // With no address the number is who they are, and with neither nobody is:
+        // two blank emails are not the same person (AGL-4122).
+        const phone = crm.phone || crm.mobilePhone || '';
+        const existing = email ? await findContactByEmail(collection, email) : phone ? (_docs_ = (await collection.where('phone', '==', phone).limit(1).get()).docs[0]) != null ? _docs_ : null : null;
         if (existing) {
             // Released: the conflict clears if that contact is deleted or merged
             // upstream, and the retry that should then succeed must not replay it.
             await claim.release();
             return ApiErrors.conflict({
-                message: `A contact with this email already exists (${existing.id}). Update it instead.`,
+                message: `A contact with this ${email ? 'email' : 'phone number'} already exists (${existing.id}). Update it instead.`,
                 code: 'contact_exists',
                 headers: ctx.headers
             });
@@ -813,8 +850,11 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
         }
         const id = createResourceUid();
         await collection.doc(id).create(_extends({
-            email
-        }, canonicalName ? nameSearchFields(canonicalName) : {}, {
+            // Blank rather than absent, so a sort by email still lists them.
+            email: email != null ? email : ''
+        }, !email && phone ? {
+            phone
+        } : {}, canonicalName ? nameSearchFields(canonicalName) : {}, {
             tags: tags != null ? tags : []
         }, notes ? {
             notes
@@ -826,7 +866,7 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
             ] : []
         }, marketingConsent === false ? {
             marketingConsent: false
-        } : {}, consentSiteId ? contactCrmCreateFields(ctx, crm, consentSiteId) : {}, {
+        } : {}, contactCrmCreateFields(ctx, crm, consentSiteId), {
             // `sources.api` — a first-class provenance value beside `form`,
             // `member`, `order` and `booking`, so a merchant reading the console
             // can see which people an integration put there.
@@ -838,9 +878,7 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
             // "No next activity" filter asks as `null` (AGL-3321).
             nextTaskAtMs: null,
             // AGL-1044/AGL-1037: without this the contact matches no scoped read.
-            visibleTo: [
-                ORG_SCOPE_TOKEN
-            ],
+            visibleTo,
             createdAt: Timestamp.now(),
             updatedAt: Timestamp.now()
         }));
@@ -849,14 +887,14 @@ const contactsCollection = (ctx)=>ctx.firestore.collection('orgs').doc(ctx.orgId
         await restampCrmListFieldsAt(collection.doc(id), 'contacts');
         // The address's domain, checked after the response (AGL-3328): a domain
         // that takes no mail makes the new contact read "Would bounce".
-        scheduleCapturedEmailCheck({
+        if (email) scheduleCapturedEmailCheck({
             orgId: ctx.orgId,
             email
         });
         // The company the body named has one more contact naming it (AGL-2613);
         // a fresh row's plan is the trivial one, and `crmRefErrors` has already
         // required the company to exist.
-        if (consentSiteId && crm.companyId) {
+        if (crm.companyId) {
             await settleCompanyContactsCounts(companiesCollection(ctx), planContactCompanyLink({
                 companyId: null,
                 companyIds: [],