@rapidmx/crm-plugin 0.1.0

package/dist/lib/routes/BaseContactRoute.js

@@ -0,0 +1,162 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils } from "@rapidrest/service-core";
+import { CONTACT_EXPORT_FIELDS, CONTACT_FIELDS } from "../filters/fields.js";
+import { CrmObjectType, EmailStatus, LifecycleStage } from "../models/types.js";
+import { badRequest, conflict, normalizeDomain, readEmail, readEnum, readNumber, readTags, readText } from "../util/Validation.js";
+import { IMPORT_FIELDS } from "../util/ImportMapping.js";
+import { BaseTaggedRecordRoute } from "./BaseTaggedRecordRoute.js";
+import { DEAL_CONTACTS_KEY } from "./BaseDealRoute.js";
+/** How many contacts one workspace may have. */
+export const MAX_CONTACTS = 1000000;
+/**
+ * A workspace's contacts (`/api/mail/crm/contacts`) - see `BaseWorkspaceRecordRoute` for the endpoints and `BaseTaggedRecordRoute`
+ * for tags, custom properties, filters, bulk actions and export.
+ *
+ * A contact is unique by email address within its workspace (409 on a duplicate). A new contact given no company is linked to the
+ * workspace's company whose `domain` matches its email address, when there is one. Deleting a contact erases what the CRM holds
+ * about the person (its values, notes and timeline).
+ */
+export class BaseContactRoute extends BaseTaggedRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "contact";
+        this.pushType = "CrmContact";
+        this.objectType = CrmObjectType.CONTACT;
+        this.recordFields = CONTACT_FIELDS;
+        this.textFields = ["email", "firstName", "lastName"];
+        this.exportFields = CONTACT_EXPORT_FIELDS;
+        this.noun = "contact";
+        this.sortFields = ["email", "firstName", "lastName", "score", "lifecycleStage", "lastEngagedAt"];
+        this.maxRecords = MAX_CONTACTS;
+        this.importFields = IMPORT_FIELDS[CrmObjectType.CONTACT];
+    }
+    async findExisting(workspaceUid, body) {
+        const email = body.email;
+        if (typeof email !== "string" || email.trim().length === 0) {
+            return undefined;
+        }
+        const matches = await (await this.records()).find({ workspaceUid: ModelUtils.literal(workspaceUid), email: ModelUtils.literal(email.trim().toLowerCase()) }, { ignoreACL: true, limit: 1, skipCache: true });
+        return matches[0];
+    }
+    async readCreate(body, context) {
+        await this.readPropertyWrites(body, context.workspaceUid);
+        const fields = await this.readFields(body, context, undefined);
+        fields.email = readEmail(body, "email", { required: true });
+        await this.requireUniqueEmail(context.workspaceUid, fields.email, undefined);
+        fields.source ?? (fields.source = "manual");
+        if (fields.companyUid === undefined) {
+            fields.companyUid = await this.companyForEmail(context.workspaceUid, fields.email);
+        }
+        return fields;
+    }
+    async readUpdate(body, existing, context) {
+        await this.readPropertyWrites(body, context.workspaceUid);
+        const fields = await this.readFields(body, context, existing);
+        const email = readEmail(body, "email");
+        if (email === null) {
+            throw badRequest("'email' is required.");
+        }
+        if (email !== undefined && email !== existing.email) {
+            await this.requireUniqueEmail(context.workspaceUid, email, existing.uid);
+            fields.email = email;
+        }
+        return fields;
+    }
+    /** Every field but `email`, as given (`undefined` when absent, `null` to clear). */
+    async readFields(body, context, _existing) {
+        const fields = {};
+        for (const field of ["firstName", "lastName", "phone", "jobTitle", "leadStatus", "source"]) {
+            const value = readText(body, field);
+            if (value !== undefined) {
+                fields[field] = value;
+            }
+        }
+        const lifecycleStage = readEnum(body, "lifecycleStage", Object.values(LifecycleStage));
+        if (lifecycleStage) {
+            fields.lifecycleStage = lifecycleStage;
+        }
+        const emailStatus = readEnum(body, "emailStatus", Object.values(EmailStatus));
+        if (emailStatus) {
+            fields.emailStatus = emailStatus;
+        }
+        const score = readNumber(body, "score", { integer: true, min: -1000000, max: 1000000 });
+        if (score !== undefined) {
+            fields.score = score ?? 0;
+        }
+        const tags = readTags(body);
+        if (tags !== undefined) {
+            fields.tags = tags;
+        }
+        if (body.ownerUserUid !== undefined) {
+            fields.ownerUserUid = await this.requireMemberUid(context.workspaceUid, readText(body, "ownerUserUid", { max: 128 }), "ownerUserUid");
+        }
+        if (body.companyUid !== undefined) {
+            const companyUid = readText(body, "companyUid", { max: 64 });
+            if (companyUid) {
+                const company = await (await this.repo("company")).findOne(companyUid, { ignoreACL: true });
+                if (!company || company.workspaceUid !== context.workspaceUid) {
+                    throw badRequest("'companyUid' must be a company of the workspace.");
+                }
+            }
+            fields.companyUid = companyUid;
+        }
+        return fields;
+    }
+    /** Refuses (409) an email address another contact of the workspace already has. */
+    async requireUniqueEmail(workspaceUid, email, exceptUid) {
+        const matches = await (await this.records()).find({ workspaceUid: ModelUtils.literal(workspaceUid), email: ModelUtils.literal(email) }, { ignoreACL: true, limit: 2, skipCache: true });
+        if (matches.some((match) => match.uid !== exceptUid)) {
+            throw conflict(`There is already a contact with the address ${email}.`);
+        }
+    }
+    /** The uid of the workspace's company whose domain is `email`'s, when exactly one has it. */
+    async companyForEmail(workspaceUid, email) {
+        const domain = normalizeDomain(email);
+        if (!domain) {
+            return undefined;
+        }
+        const companies = await (await this.repo("company")).find({ workspaceUid: ModelUtils.literal(workspaceUid), domain: ModelUtils.literal(domain) }, { ignoreACL: true, limit: 2, skipCache: true });
+        return companies.length === 1 ? companies[0].uid : undefined;
+    }
+    /**
+     * Deleting contacts deletes their subscriptions (their `lists` values go with the rest of their values), the messages sent to
+     * them and what came of those - nothing personal stays behind in campaign statistics - and their runs through automations.
+     */
+    async deleteRelated(uids, workspaceUid) {
+        await super.deleteRelated(uids, workspaceUid);
+        if (uids.length > 0) {
+            await this.removeFromDeals(uids, workspaceUid);
+            for (const name of ["subscription", "outboundSend", "engagementEvent", "enrollment", "crmEvent"]) {
+                await (await this.repo(name)).truncate({ workspaceUid: ModelUtils.literal(workspaceUid), contactUid: ModelUtils.literal(uids, "in") }, { ignoreACL: true, skipPush: true });
+            }
+        }
+    }
+    /** Takes deleted contacts off the deals they were on. */
+    async removeFromDeals(uids, workspaceUid) {
+        const values = await this.repo("propertyValue");
+        const scope = { workspaceUid: ModelUtils.literal(workspaceUid), objectType: ModelUtils.literal(CrmObjectType.DEAL), key: ModelUtils.literal(DEAL_CONTACTS_KEY) };
+        const rows = await values.find({ ...scope, stringValue: ModelUtils.literal(uids, "in") }, { ignoreACL: true, limit: 10000, skipCache: true });
+        const deals = await this.repo("deal");
+        for (const dealUid of new Set(rows.map((row) => row.objectUid))) {
+            const deal = await deals.findOne(dealUid, { ignoreACL: true, skipCache: true });
+            if (deal) {
+                await deals.update({ uid: deal.uid, version: deal.version, contactUids: deal.contactUids.filter((uid) => !uids.includes(uid)) }, deal, {
+                    ignoreACL: true,
+                    skipPush: true,
+                });
+            }
+        }
+        if (rows.length > 0) {
+            await values.truncate({ ...scope, stringValue: ModelUtils.literal(uids, "in") }, { ignoreACL: true });
+        }
+    }
+    listQuery(query) {
+        return typeof query.companyUid === "string" && query.companyUid.length > 0 && query.companyUid.length <= 64
+            ? { companyUid: ModelUtils.literal(query.companyUid) }
+            : {};
+    }
+}
+//# sourceMappingURL=BaseContactRoute.js.map

package/dist/lib/routes/BaseContactRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseContactRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseContactRoute.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAa,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAA0B,aAAa,EAAQ,WAAW,EAAE,cAAc,EAAiB,MAAM,oBAAoB,CAAC;AAC7H,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACnI,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAEvD,gDAAgD;AAChD,MAAM,CAAC,MAAM,YAAY,GAAG,OAAO,CAAC;AAEpC;;;;;;;GAOG;AACH,MAAM,OAAgB,gBAAiB,SAAQ,qBAAiC;IAAhF;;QACuB,UAAK,GAAG,SAAkB,CAAC;QAC3B,aAAQ,GAAW,YAAY,CAAC;QAChC,eAAU,GAAkB,aAAa,CAAC,OAAO,CAAC;QAClD,iBAAY,GAAG,cAAc,CAAC;QAC9B,eAAU,GAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QACnE,iBAAY,GAAsB,qBAAqB,CAAC;QACxD,SAAI,GAAW,SAAS,CAAC;QAChB,eAAU,GAAsB,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,gBAAgB,EAAE,eAAe,CAAC,CAAC;QAC/G,eAAU,GAAW,YAAY,CAAC;QAC9C,iBAAY,GAAgD,aAAa,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;IAmJrH,CAAC;IAjJa,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,IAA6B;QAC5E,MAAM,KAAK,GAAY,IAAI,CAAC,KAAK,CAAC;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAiB,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAC3D,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,EACzG,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CACjD,CAAC;QACF,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QACpF,MAAM,CAAC,KAAK,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE,CAAC;QAC7D,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC7E,MAAM,CAAC,MAAM,KAAb,MAAM,CAAC,MAAM,GAAK,QAAQ,EAAC;QAC3B,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAAoB,EAAE,OAAqB;QACjG,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAwB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACnF,MAAM,KAAK,GAA8B,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAClE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,UAAU,CAAC,sBAAsB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;YAClD,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;YACzE,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,oFAAoF;IAC5E,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB,EAAE,SAAiC;QAC5G,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,KAAK,IAAI,CAAC,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC;YACzF,MAAM,KAAK,GAA8B,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC/D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC1B,CAAC;QACL,CAAC;QACD,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,EAAE,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;QACvF,IAAI,cAAc,EAAE,CAAC;YACjB,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC;QAC3C,CAAC;QACD,MAAM,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9E,IAAI,WAAW,EAAE,CAAC;YACd,MAAM,CAAC,WAAW,GAAG,WAAW,CAAC;QACrC,CAAC;QACD,MAAM,KAAK,GAA8B,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QACnH,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,GAAG,KAAK,IAAI,CAAC,CAAC;QAC9B,CAAC;QACD,MAAM,IAAI,GAAyB,QAAQ,CAAC,IAAI,CAAC,CAAC;QAClD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,IAAI,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,cAAc,CAAC,CAAC;QAC1I,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,UAAU,GAA8B,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC;YACxF,IAAI,UAAU,EAAE,CAAC;gBACb,MAAM,OAAO,GAA2B,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChI,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,YAAY,KAAK,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC5D,MAAM,UAAU,CAAC,kDAAkD,CAAC,CAAC;gBACzE,CAAC;YACL,CAAC;YACD,MAAM,CAAC,UAAU,GAAG,UAAU,CAAC;QACnC,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,mFAAmF;IAC3E,KAAK,CAAC,kBAAkB,CAAC,YAAoB,EAAE,KAAa,EAAE,SAA6B;QAC/F,MAAM,OAAO,GAAiB,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAC3D,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EACpF,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CACjD,CAAC;QACF,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,SAAS,CAAC,EAAE,CAAC;YACnD,MAAM,QAAQ,CAAC,+CAA+C,KAAK,GAAG,CAAC,CAAC;QAC5E,CAAC;IACL,CAAC;IAED,6FAA6F;IACrF,KAAK,CAAC,eAAe,CAAC,YAAoB,EAAE,KAAa;QAC7D,MAAM,MAAM,GAAuB,eAAe,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,SAAS,GAAiB,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC,CAAC,IAAI,CAC/E,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EACtF,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CACjD,CAAC;QACF,OAAO,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IACjE,CAAC;IAED;;;OAGG;IACgB,KAAK,CAAC,aAAa,CAAC,IAAc,EAAE,YAAoB;QACvE,MAAM,KAAK,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;YAC/C,KAAK,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,iBAAiB,EAAE,YAAY,EAAE,UAAU,CAAU,EAAE,CAAC;gBACxG,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAClC,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAC9F,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CACtC,CAAC;YACN,CAAC;QACL,CAAC;IACL,CAAC;IAED,yDAAyD;IACjD,KAAK,CAAC,eAAe,CAAC,IAAc,EAAE,YAAoB;QAC9D,MAAM,MAAM,GAA6B,MAAM,IAAI,CAAC,IAAI,CAAgB,eAAe,CAAC,CAAC;QACzF,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjK,MAAM,IAAI,GAAoB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,KAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChK,MAAM,KAAK,GAAoB,MAAM,IAAI,CAAC,IAAI,CAAO,MAAM,CAAC,CAAC;QAC7D,KAAK,MAAM,OAAO,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC9D,MAAM,IAAI,GAAqB,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAClG,IAAI,IAAI,EAAE,CAAC;gBACP,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,IAAI,EAAE;oBACnI,SAAS,EAAE,IAAI;oBACf,QAAQ,EAAE,IAAI;iBACjB,CAAC,CAAC;YACP,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAClB,MAAM,MAAM,CAAC,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1G,CAAC;IACL,CAAC;IAEkB,SAAS,CAAC,KAA8B;QACvD,OAAO,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,IAAI,EAAE;YACvG,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE;YACtD,CAAC,CAAC,EAAE,CAAC;IACb,CAAC;CACJ"}

package/dist/lib/routes/BaseCrmAdminRoute.js

@@ -0,0 +1,108 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils, RouteDecorators } from "@rapidrest/service-core";
+import { CampaignStatus, SendStatus } from "../models/types.js";
+import { badRequest, readBoolean, readPaging, requireObject } from "../util/Validation.js";
+import { forbidden, notFound } from "../util/WorkspaceAccess.js";
+import { CrmRouteBase } from "./CrmRouteBase.js";
+const { Get, Param, Put, Query, User: AuthUser } = RouteDecorators;
+/**
+ * The deployment administration of the CRM (`/api/mail/crm/admin`), for callers holding a trusted role (`trusted_roles`, `admin` by
+ * default) - they need no membership of any workspace, and see no workspace's contents:
+ * - `GET /stats` - `AdminStats`.
+ * - `GET /workspaces?limit=&page=` - every workspace with its size (`AdminWorkspace`), newest first (`limit` up to 100, 50 by default).
+ * - `PUT /workspaces/:workspaceUid` - `{ sendingDisabled }`: stops (or lets go again) a workspace's campaign and automation email,
+ * the abuse kill switch. Stopped messages stay queued.
+ */
+export class BaseCrmAdminRoute extends CrmRouteBase {
+    requireAdmin(user) {
+        if (!user?.roles?.some((role) => this.trustedRoles.includes(role))) {
+            throw forbidden();
+        }
+    }
+    async stats(user) {
+        this.requireAdmin(user);
+        const options = { ignoreACL: true, skipCache: true };
+        const sends = await this.repo("outboundSend");
+        return {
+            workspaces: await (await this.repo("workspace")).count({}, options),
+            contacts: await (await this.repo("contact")).count({}, options),
+            sentLastDay: await sends.count({ sentAt: ModelUtils.literal(new Date(Date.now() - 86400000), "gte") }, options),
+            queued: await sends.count({ status: ModelUtils.literal(SendStatus.QUEUED) }, options),
+        };
+    }
+    async workspaces(query, user) {
+        this.requireAdmin(user);
+        const paging = readPaging(query?.limit, query?.page, 100);
+        const repo = await this.repo("workspace");
+        const options = { ignoreACL: true, skipCache: true };
+        const workspaces = await repo.find({ sort: { dateCreated: "DESC" } }, { ...options, limit: paging.limit, page: paging.page });
+        const items = [];
+        for (const workspace of workspaces) {
+            const scope = { workspaceUid: ModelUtils.literal(workspace.uid) };
+            items.push({
+                uid: workspace.uid,
+                name: workspace.name,
+                dateCreated: new Date(workspace.dateCreated).toISOString(),
+                members: await (await this.repo("workspaceMember")).count(scope, options),
+                contacts: await (await this.repo("contact")).count(scope, options),
+                campaignsSent: await (await this.repo("campaign")).count({ ...scope, status: ModelUtils.literal(CampaignStatus.SENT) }, options),
+                sendingDisabled: !!workspace.sendingDisabled,
+            });
+        }
+        return { items, total: await repo.count({}, options) };
+    }
+    async setWorkspace(workspaceUid, body, user) {
+        this.requireAdmin(user);
+        const sendingDisabled = readBoolean(requireObject(body), "sendingDisabled");
+        if (sendingDisabled === undefined) {
+            throw badRequest("'sendingDisabled' is required.");
+        }
+        const repo = await this.repo("workspace");
+        const workspace = await repo.findOne(workspaceUid, { ignoreACL: true, skipCache: true });
+        if (!workspace) {
+            throw notFound();
+        }
+        await repo.update({ uid: workspace.uid, version: workspace.version, sendingDisabled }, workspace, { ignoreACL: true, skipPush: true });
+        this.logger?.info(`CrmAdmin: ${user.uid} ${sendingDisabled ? "stopped" : "restored"} the email of workspace ${workspace.uid}.`);
+        return { uid: workspace.uid, sendingDisabled };
+    }
+}
+__decorate([
+    Get("/stats"),
+    __param(0, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], BaseCrmAdminRoute.prototype, "stats", null);
+__decorate([
+    Get("/workspaces"),
+    __param(0, Query()),
+    __param(1, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseCrmAdminRoute.prototype, "workspaces", null);
+__decorate([
+    Put("/workspaces/:workspaceUid"),
+    __param(0, Param("workspaceUid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseCrmAdminRoute.prototype, "setWorkspace", null);
+//# sourceMappingURL=BaseCrmAdminRoute.js.map

package/dist/lib/routes/BaseCrmAdminRoute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseCrmAdminRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseCrmAdminRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAa,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAEjF,OAAO,EAAY,cAAc,EAA4B,UAAU,EAA8B,MAAM,oBAAoB,CAAC;AAChI,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC3F,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;AAuBnE;;;;;;;GAOG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,YAAY;IAChD,YAAY,CAAC,IAAyB;QAC1C,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACjE,MAAM,SAAS,EAAE,CAAC;QACtB,CAAC;IACL,CAAC;IAGY,AAAN,KAAK,CAAC,KAAK,CAAW,IAAc;QACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,OAAO,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QACrD,MAAM,KAAK,GAA4B,MAAM,IAAI,CAAC,IAAI,CAAe,cAAc,CAAC,CAAC;QACrF,OAAO;YACH,UAAU,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAY,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC;YAC9E,QAAQ,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC;YAC3E,WAAW,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,QAAU,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC;YACjH,MAAM,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC;SACxF,CAAC;IACN,CAAC;IAGY,AAAN,KAAK,CAAC,UAAU,CAAU,KAA0C,EAAY,IAAc;QACjG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAyB,MAAM,IAAI,CAAC,IAAI,CAAY,WAAW,CAAC,CAAC;QAC3E,MAAM,OAAO,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QACrD,MAAM,UAAU,GAAgB,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAC3I,MAAM,KAAK,GAAqB,EAAE,CAAC;QACnC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;YACjC,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;YAClE,KAAK,CAAC,IAAI,CAAC;gBACP,GAAG,EAAE,SAAS,CAAC,GAAG;gBAClB,IAAI,EAAE,SAAS,CAAC,IAAI;gBACpB,WAAW,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE;gBAC1D,OAAO,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAkB,iBAAiB,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC1F,QAAQ,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC;gBAC9E,aAAa,EAAE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAW,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,OAAO,CAAC;gBAC1I,eAAe,EAAE,CAAC,CAAC,SAAS,CAAC,eAAe;aAC/C,CAAC,CAAC;QACP,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC;IAC3D,CAAC;IAGY,AAAN,KAAK,CAAC,YAAY,CAAwB,YAAoB,EAAE,IAAa,EAAY,IAAc;QAC1G,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACxB,MAAM,eAAe,GAAwB,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;QACjG,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;YAChC,MAAM,UAAU,CAAC,gCAAgC,CAAC,CAAC;QACvD,CAAC;QACD,MAAM,IAAI,GAAyB,MAAM,IAAI,CAAC,IAAI,CAAY,WAAW,CAAC,CAAC;QAC3E,MAAM,SAAS,GAA0B,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAChH,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,MAAM,QAAQ,EAAE,CAAC;QACrB,CAAC;QACD,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QACvI,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,aAAa,IAAK,CAAC,GAAG,IAAI,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,2BAA2B,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC;QACjI,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,eAAe,EAAE,CAAC;IACnD,CAAC;CACJ;AAnDgB;IADZ,GAAG,CAAC,QAAQ,CAAC;IACM,WAAA,QAAQ,CAAA;;;;8CAU3B;AAGY;IADZ,GAAG,CAAC,aAAa,CAAC;IACM,WAAA,KAAK,EAAE,CAAA;IAA8C,WAAA,QAAQ,CAAA;;;;mDAoBrF;AAGY;IADZ,GAAG,CAAC,2BAA2B,CAAC;IACN,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAuC,WAAA,QAAQ,CAAA;;;;qDAc9F"}

package/dist/lib/routes/BaseDealRoute.js

@@ -0,0 +1,312 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils, RouteDecorators } from "@rapidrest/service-core";
+import { CrmEventType, recordCrmEvent } from "../automation/Events.js";
+import { CrmObjectType, DealStatus, StageKind, TimelineKind, WorkspaceAction, } from "../models/types.js";
+import { writeValues } from "../util/PropertyValues.js";
+import { badRequest, readDate, readNumber, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+const { Get, Param, Query, User: AuthUser } = RouteDecorators;
+/** How many deals one workspace may have, and contacts one deal. */
+export const MAX_DEALS = 50000;
+export const MAX_DEAL_CONTACTS = 20;
+/** The `PropertyValue` key a deal's contacts are mirrored under (object type `deal`). */
+export const DEAL_CONTACTS_KEY = "contacts";
+/** How many moves a deal's history keeps. */
+const HISTORY_SIZE = 100;
+/**
+ * A workspace's deals (`/api/mail/crm/deals`) - see `BaseWorkspaceRecordRoute` for the endpoints; `GET /:workspaceUid` takes
+ * `pipelineUid`, `stageId`, `status`, `ownerUserUid`, `companyUid` and `contactUid` - plus
+ * `GET /:workspaceUid/forecast?pipelineUid=&days=` (`Forecast`, over the last `days`, 90 by default).
+ *
+ * A deal's `status` follows its stage's kind; moving it records the move in `stageHistory`, `closedAt` when it is won or lost, and
+ * the move on its timeline and its contacts', and tells automations (`deal.stage_changed`, `deal.won`, `deal.lost`, per contact).
+ */
+export class BaseDealRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "deal";
+        this.pushType = "CrmDeal";
+        this.sortFields = ["name", "amount", "expectedCloseDate", "stageChangedAt"];
+        this.maxRecords = MAX_DEALS;
+    }
+    async readCreate(body, context) {
+        const pipeline = await this.requirePipeline(context.workspaceUid, body.pipelineUid);
+        const stage = this.requireStage(pipeline, body.stageId ?? pipeline.stages[0].id);
+        const now = new Date();
+        return {
+            name: readText(body, "name", { required: true }),
+            amount: readNumber(body, "amount", { min: 0, max: 1e12 }) ?? 0,
+            currency: this.readCurrency(body) ?? "USD",
+            pipelineUid: pipeline.uid,
+            stageId: stage.id,
+            status: statusOf(stage),
+            ...(stage.kind !== StageKind.OPEN ? { closedAt: now } : {}),
+            stageChangedAt: now,
+            stageHistory: [{ stageId: stage.id, at: now, userUid: context.user.uid || undefined }],
+            ...(await this.readLinks(body, context.workspaceUid)),
+            createdByUserUid: context.user.uid,
+        };
+    }
+    async readUpdate(body, existing, context) {
+        const fields = await this.readLinks(body, context.workspaceUid);
+        const name = readText(body, "name");
+        if (name === null) {
+            throw badRequest("'name' is required.");
+        }
+        if (name !== undefined) {
+            fields.name = name;
+        }
+        const amount = readNumber(body, "amount", { min: 0, max: 1e12 });
+        if (amount !== undefined) {
+            fields.amount = amount ?? 0;
+        }
+        const currency = this.readCurrency(body);
+        if (currency) {
+            fields.currency = currency;
+        }
+        if (body.pipelineUid !== undefined || body.stageId !== undefined) {
+            const pipeline = await this.requirePipeline(context.workspaceUid, body.pipelineUid ?? existing.pipelineUid);
+            const moving = pipeline.uid !== existing.pipelineUid;
+            const stage = this.requireStage(pipeline, body.stageId ?? (moving ? pipeline.stages[0].id : existing.stageId));
+            if (moving || stage.id !== existing.stageId) {
+                const now = new Date();
+                const change = { stageId: stage.id, at: now, userUid: context.user.uid || undefined };
+                Object.assign(fields, {
+                    pipelineUid: pipeline.uid,
+                    stageId: stage.id,
+                    status: statusOf(stage),
+                    stageChangedAt: now,
+                    stageHistory: [...(existing.stageHistory ?? []), change].slice(-HISTORY_SIZE),
+                    closedAt: stage.kind === StageKind.OPEN ? null : now,
+                    ...(stage.kind !== StageKind.LOST ? { lostReason: null } : {}),
+                });
+            }
+        }
+        return fields;
+    }
+    /** The owner, contacts, company, expected close date and lost reason of a request. */
+    async readLinks(body, workspaceUid) {
+        const fields = {};
+        if (body.ownerUserUid !== undefined) {
+            if (body.ownerUserUid !== null && !(await this.findMember(workspaceUid, String(body.ownerUserUid)))) {
+                throw badRequest("'ownerUserUid' must be a member of the workspace.");
+            }
+            fields.ownerUserUid = body.ownerUserUid;
+        }
+        if (body.contactUids !== undefined) {
+            if (!Array.isArray(body.contactUids) || body.contactUids.length > MAX_DEAL_CONTACTS || body.contactUids.some((uid) => typeof uid !== "string")) {
+                throw badRequest(`'contactUids' must be a list of at most ${MAX_DEAL_CONTACTS} contact uids.`);
+            }
+            const uids = [...new Set(body.contactUids)];
+            const found = uids.length === 0
+                ? []
+                : await (await this.repo("contact")).find({ workspaceUid: ModelUtils.literal(workspaceUid), uid: ModelUtils.literal(uids, "in") }, { ignoreACL: true, limit: uids.length, skipCache: true });
+            if (found.length !== uids.length) {
+                throw badRequest("'contactUids' must hold contacts of the workspace.");
+            }
+            fields.contactUids = uids;
+        }
+        if (body.companyUid !== undefined) {
+            if (body.companyUid !== null) {
+                const company = typeof body.companyUid === "string" && body.companyUid.length <= 64
+                    ? await (await this.repo("company")).findOne(body.companyUid, { ignoreACL: true, skipCache: true })
+                    : undefined;
+                if (company?.workspaceUid !== workspaceUid) {
+                    throw badRequest("'companyUid' must be a company of the workspace.");
+                }
+            }
+            fields.companyUid = body.companyUid;
+        }
+        const expectedCloseDate = readDate(body, "expectedCloseDate");
+        if (expectedCloseDate !== undefined) {
+            fields.expectedCloseDate = expectedCloseDate;
+        }
+        if (body.lostReason !== undefined) {
+            fields.lostReason = readText(body, "lostReason", { max: 1000 });
+        }
+        return fields;
+    }
+    readCurrency(body) {
+        if (body.currency === undefined) {
+            return undefined;
+        }
+        if (typeof body.currency !== "string" || !/^[A-Za-z]{3}$/.test(body.currency)) {
+            throw badRequest("'currency' must be a three-letter currency code such as USD.");
+        }
+        return body.currency.toUpperCase();
+    }
+    async requirePipeline(workspaceUid, uid) {
+        const repo = await this.repo("pipeline");
+        const pipeline = uid === undefined || uid === null
+            ? (await repo.find({ workspaceUid: ModelUtils.literal(workspaceUid), isDefault: ModelUtils.literal(true) }, { ignoreACL: true, limit: 1, skipCache: true }))[0]
+            : typeof uid === "string" && uid.length <= 64
+                ? await repo.findOne(uid, { ignoreACL: true, skipCache: true })
+                : undefined;
+        if (pipeline?.workspaceUid !== workspaceUid) {
+            throw badRequest("'pipelineUid' must be a pipeline of the workspace.");
+        }
+        return pipeline;
+    }
+    requireStage(pipeline, stageId) {
+        const stage = pipeline.stages.find((entry) => entry.id === stageId);
+        if (!stage) {
+            throw badRequest("'stageId' must be a stage of the pipeline.");
+        }
+        return stage;
+    }
+    listQuery(query) {
+        const conditions = {};
+        for (const field of ["pipelineUid", "stageId", "status", "ownerUserUid", "companyUid"]) {
+            const value = query[field];
+            if (typeof value === "string" && value.length > 0 && value.length <= 64) {
+                conditions[field] = ModelUtils.literal(value);
+            }
+        }
+        return conditions;
+    }
+    /** `GET /:workspaceUid?contactUid=` - the deals of a contact, through the `contacts` values. */
+    async list(workspaceUid, query, user) {
+        const contactUid = query?.contactUid;
+        if (typeof contactUid !== "string" || contactUid.length === 0 || contactUid.length > 64) {
+            return await super.list(workspaceUid, query, user);
+        }
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const rows = await (await this.repo("propertyValue")).find({
+            workspaceUid: ModelUtils.literal(workspaceUid),
+            objectType: ModelUtils.literal(CrmObjectType.DEAL),
+            key: ModelUtils.literal(DEAL_CONTACTS_KEY),
+            stringValue: ModelUtils.literal(contactUid),
+        }, { ignoreACL: true, limit: 500, skipCache: true });
+        if (rows.length === 0) {
+            return [];
+        }
+        const deals = await (await this.records()).find({ uid: ModelUtils.literal(rows.map((row) => row.objectUid), "in"), sort: { dateCreated: "DESC" } }, { ignoreACL: true, limit: rows.length, skipCache: true });
+        return JSON.parse(JSON.stringify(deals));
+    }
+    /** Keeps the `contacts` values in step, and records a new deal or a move on the timelines and for automations. */
+    async afterWrite(record, before, body, context) {
+        if (!before || body.contactUids !== undefined) {
+            await writeValues(await this.repo("propertyValue"), this.classes.propertyValue, { workspaceUid: record.workspaceUid, objectType: CrmObjectType.DEAL, objectUid: record.uid }, DEAL_CONTACTS_KEY, record.contactUids.map((uid) => ({ stringValue: uid })));
+        }
+        const moved = !!before && (before.stageId !== record.stageId || before.pipelineUid !== record.pipelineUid);
+        if (before && !moved) {
+            return;
+        }
+        const pipeline = await (await this.repo("pipeline")).findOne(record.pipelineUid, { ignoreACL: true });
+        const stageName = pipeline?.stages.find((stage) => stage.id === record.stageId)?.name ?? "a stage";
+        const kind = !before
+            ? TimelineKind.DEAL_CREATED
+            : record.status === DealStatus.WON
+                ? TimelineKind.DEAL_WON
+                : record.status === DealStatus.LOST
+                    ? TimelineKind.DEAL_LOST
+                    : TimelineKind.DEAL_STAGE_CHANGED;
+        const summary = !before ? `Created the deal "${record.name}" in ${stageName}` : `Moved the deal "${record.name}" to ${stageName}`;
+        const actorUserUid = context.user.uid || undefined;
+        for (const subject of [{ subjectType: CrmObjectType.DEAL, subjectUid: record.uid }, ...record.contactUids.map((uid) => ({ subjectType: CrmObjectType.CONTACT, subjectUid: uid }))]) {
+            await this.addTimeline({ workspaceUid: record.workspaceUid, ...subject, kind, summary, actorUserUid, data: { dealUid: record.uid, stageId: record.stageId }, refUid: record.uid });
+        }
+        const eventType = !before
+            ? CrmEventType.DEAL_CREATED
+            : record.status === DealStatus.WON
+                ? CrmEventType.DEAL_WON
+                : record.status === DealStatus.LOST
+                    ? CrmEventType.DEAL_LOST
+                    : CrmEventType.DEAL_STAGE_CHANGED;
+        for (const contactUid of record.contactUids) {
+            await recordCrmEvent(this.repos(), this.classes, {
+                workspaceUid: record.workspaceUid,
+                type: eventType,
+                contactUid,
+                data: { dealUid: record.uid, pipelineUid: record.pipelineUid, stageId: record.stageId, fromStageId: before?.stageId },
+            }, this.logger);
+        }
+    }
+    async afterDelete(record) {
+        await (await this.repo("propertyValue")).truncate({ objectType: ModelUtils.literal(CrmObjectType.DEAL), objectUid: ModelUtils.literal(record.uid) }, { ignoreACL: true });
+        const scope = { subjectType: ModelUtils.literal(CrmObjectType.DEAL), subjectUid: ModelUtils.literal(record.uid) };
+        for (const name of ["note", "timelineEvent"]) {
+            await (await this.repo(name)).truncate(scope, { ignoreACL: true, skipPush: true });
+        }
+        // Its tasks stay, no longer about anything.
+        const tasks = await this.repo("task");
+        for (const task of await tasks.find(scope, { ignoreACL: true, limit: 1000, skipCache: true })) {
+            await tasks.update({ uid: task.uid, version: task.version, subjectType: null, subjectUid: null }, task, { ignoreACL: true, skipPush: true });
+        }
+    }
+    async forecast(workspaceUid, query, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const pipeline = await this.requirePipeline(workspaceUid, query?.pipelineUid);
+        const days = Number(query?.days ?? 90);
+        if (!Number.isInteger(days) || days < 1 || days > 3650) {
+            throw badRequest("'days' must be a whole number from 1 to 3650.");
+        }
+        const since = new Date(Date.now() - days * 86400000);
+        const deals = await (await this.records()).find({
+            pipelineUid: ModelUtils.literal(pipeline.uid),
+            $or: [{ status: ModelUtils.literal(DealStatus.OPEN) }, { closedAt: ModelUtils.literal(since, "gte") }],
+        }, { ignoreACL: true, limit: MAX_DEALS, skipCache: true });
+        const stages = pipeline.stages
+            .filter((stage) => stage.kind === StageKind.OPEN)
+            .map((stage) => {
+            const here = deals.filter((deal) => deal.stageId === stage.id && deal.status === DealStatus.OPEN);
+            const amount = here.reduce((sum, deal) => sum + deal.amount, 0);
+            return { stageId: stage.id, count: here.length, amount, weighted: (amount * stage.probability) / 100 };
+        });
+        const total = (status) => {
+            const matching = deals.filter((deal) => deal.status === status && status !== DealStatus.OPEN);
+            return { count: matching.length, amount: matching.reduce((sum, deal) => sum + deal.amount, 0) };
+        };
+        const won = total(DealStatus.WON);
+        const lost = total(DealStatus.LOST);
+        const wonDeals = deals.filter((deal) => deal.status === DealStatus.WON);
+        return {
+            stages,
+            open: {
+                count: stages.reduce((sum, stage) => sum + stage.count, 0),
+                amount: stages.reduce((sum, stage) => sum + stage.amount, 0),
+                weighted: stages.reduce((sum, stage) => sum + stage.weighted, 0),
+            },
+            won,
+            lost,
+            ...(won.count + lost.count > 0 ? { winRate: won.count / (won.count + lost.count) } : {}),
+            ...(wonDeals.length > 0
+                ? {
+                    averageDaysToWin: 
+                    // A deal created already won closes a moment before the datastore stamps its creation.
+                    wonDeals.reduce((sum, deal) => sum + Math.max(0, new Date(deal.closedAt).getTime() - new Date(deal.dateCreated).getTime()) / 86400000, 0) /
+                        wonDeals.length,
+                }
+                : {}),
+        };
+    }
+}
+__decorate([
+    Get("/:workspaceUid/forecast"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Query()),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseDealRoute.prototype, "forecast", null);
+/** A deal's status in `stage`. */
+function statusOf(stage) {
+    return stage.kind === StageKind.WON ? DealStatus.WON : stage.kind === StageKind.LOST ? DealStatus.LOST : DealStatus.OPEN;
+}
+//# sourceMappingURL=BaseDealRoute.js.map