@rapidmx/crm-plugin 0.1.0

package/dist/lib/purge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"purge.js","sourceRoot":"","sources":["../../src/purge.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E;;;;;;;;;;GAUG;AAaH,+FAA+F;AAC/F,MAAM,eAAgB,SAAQ,KAAK;IAC/B,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAClC,CAAC;CACJ;AAED,uFAAuF;AACvF,KAAK,UAAU,QAAQ,CAAC,UAAe,EAAE,KAAqC;IAC1E,IAAI,IAA+B,CAAC;IACpC,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QACzB,IAAI,GAAG,MAAM,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IACzG,CAAC;SAAM,CAAC;QACJ,MAAM,MAAM,GAAQ,UAAU,CAAC,iBAAiB,EAAE,CAAC;QACnD,IAAI,CAAC;YACD,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBACvC,OAAO,EAAE,CAAC;YACd,CAAC;YACD,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YACxE,MAAM,KAAK,GAAW,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAClE,IAAI,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,UAAU,MAAM,CAAC,SAAS,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC;QAC/E,CAAC;gBAAS,CAAC;YACP,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QAC3B,CAAC;IACL,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC;AAChH,CAAC;AAED,gFAAgF;AAChF,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,GAAiB;IAC3C,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,wBAAwB,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACvG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAC3E,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACpC,MAAM,IAAI,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,oFAAoF,CAAC,CAAC;IAClI,CAAC;IACD,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,IAAI,CAAC;YACD,MAAM,GAAG,CAAC,SAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1C,CAAC;IACL,CAAC;IACD,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,IAAI,eAAe,CAAC,oBAAoB,MAAM,CAAC,MAAM,OAAO,IAAI,CAAC,MAAM,sBAAsB,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1I,CAAC;IACD,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,IAAI,CAAC,MAAM,oBAAoB,CAAC,CAAC;AACjE,CAAC"}

package/dist/lib/routes/BaseAnalyticsRoute.js

@@ -0,0 +1,217 @@
+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 { CrmObjectType, DealStatus, EngagementType, SendStatus, SubscriptionStatus, TimelineKind, WorkspaceAction, } from "../models/types.js";
+import { badRequest } from "../util/Validation.js";
+import { CrmRouteBase } from "./CrmRouteBase.js";
+const { Get, Param, Query, User: AuthUser } = RouteDecorators;
+/** The most rows one report reads of one kind, so a report on a busy workspace stays bounded. */
+export const MAX_REPORT_ROWS = 200000;
+const PAGE = 1000;
+/** `date` as its UTC day, `YYYY-MM-DD`. */
+function day(date) {
+    return new Date(date).toISOString().slice(0, 10);
+}
+/** Every day of the last `count` days, oldest first, ending today (UTC). */
+export function lastDays(count, now = new Date()) {
+    return Array.from({ length: count }, (_value, index) => day(new Date(now.getTime() - (count - 1 - index) * 86400000)));
+}
+/**
+ * A workspace's reports (`/api/mail/crm/analytics`), each over the last `days` (1 to 365, 30 by default), by UTC day:
+ * - `GET /:workspaceUid/email` - messages sent, opened, clicked, replied to, bounced and unsubscribed from, per day and in all, and
+ * the recipient domains mailed most (`EmailReport`). Opens by machines don't count.
+ * - `GET /:workspaceUid/growth` - new contacts, subscribes and unsubscribes per day, and each list's subscribers now (`GrowthReport`).
+ * - `GET /:workspaceUid/sales?pipelineUid=` - deals created, won (and their value) and lost per day, and what is open (`SalesReport`).
+ *
+ * Reports read at most `MAX_REPORT_ROWS` rows of each kind.
+ */
+export class BaseAnalyticsRoute extends CrmRouteBase {
+    readDays(query) {
+        const days = Number(query?.days ?? 30);
+        if (!Number.isInteger(days) || days < 1 || days > 365) {
+            throw badRequest("'days' must be a whole number from 1 to 365.");
+        }
+        return days;
+    }
+    /** Every row of `repo` matching `query`, in uid order, at most `MAX_REPORT_ROWS`. */
+    async all(repo, query) {
+        const rows = [];
+        let after;
+        while (rows.length < MAX_REPORT_ROWS) {
+            const page = await repo.find({ ...query, ...(after ? { uid: ModelUtils.literal(after, "gt") } : {}), sort: { uid: "ASC" } }, { ignoreACL: true, limit: PAGE, skipCache: true });
+            rows.push(...page);
+            if (page.length < PAGE) {
+                break;
+            }
+            after = page[page.length - 1].uid;
+        }
+        return rows;
+    }
+    async email(workspaceUid, query, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const count = this.readDays(query);
+        const dates = lastDays(count);
+        const since = new Date(`${dates[0]}T00:00:00.000Z`);
+        const events = await this.all(await this.repo("engagementEvent"), {
+            workspaceUid: ModelUtils.literal(workspaceUid),
+            occurredAt: ModelUtils.literal(since, "gte"),
+        });
+        const keys = {
+            [EngagementType.SENT]: "sent",
+            [EngagementType.OPENED]: "opened",
+            [EngagementType.CLICKED]: "clicked",
+            [EngagementType.REPLIED]: "replied",
+            [EngagementType.BOUNCED]: "bounced",
+            [EngagementType.UNSUBSCRIBED]: "unsubscribed",
+        };
+        // Each message counts once per thing per day, and once per thing in the totals.
+        const perDay = new Map();
+        const overall = new Map();
+        for (const event of events) {
+            if (event.data?.machine) {
+                continue;
+            }
+            const dayKey = `${day(event.occurredAt)}|${event.type}`;
+            perDay.set(dayKey, (perDay.get(dayKey) ?? new Set()).add(event.sendUid));
+            overall.set(event.type, (overall.get(event.type) ?? new Set()).add(event.sendUid));
+        }
+        const days = dates.map((date) => {
+            const entry = { date, sent: 0, opened: 0, clicked: 0, replied: 0, bounced: 0, unsubscribed: 0 };
+            for (const [type, key] of Object.entries(keys)) {
+                entry[key] = perDay.get(`${date}|${type}`)?.size ?? 0;
+            }
+            return entry;
+        });
+        const total = (type) => overall.get(type)?.size ?? 0;
+        const sends = await this.all(await this.repo("outboundSend"), {
+            workspaceUid: ModelUtils.literal(workspaceUid),
+            status: ModelUtils.literal(SendStatus.SENT),
+            sentAt: ModelUtils.literal(since, "gte"),
+        });
+        const domains = new Map();
+        for (const send of sends) {
+            const domain = send.email.slice(send.email.lastIndexOf("@") + 1);
+            const entry = domains.get(domain) ?? { domain, sent: 0, opened: 0, clicked: 0 };
+            entry.sent++;
+            entry.opened += send.firstOpenedAt && !send.machineOpen ? 1 : 0;
+            entry.clicked += send.firstClickedAt ? 1 : 0;
+            domains.set(domain, entry);
+        }
+        return {
+            days,
+            totals: {
+                sent: total(EngagementType.SENT),
+                opened: total(EngagementType.OPENED),
+                clicked: total(EngagementType.CLICKED),
+                replied: total(EngagementType.REPLIED),
+                bounced: total(EngagementType.BOUNCED),
+                unsubscribed: total(EngagementType.UNSUBSCRIBED),
+                complained: total(EngagementType.COMPLAINED),
+            },
+            domains: [...domains.values()].sort((a, b) => b.sent - a.sent || a.domain.localeCompare(b.domain)).slice(0, 10),
+        };
+    }
+    async growth(workspaceUid, query, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const dates = lastDays(this.readDays(query));
+        const since = new Date(`${dates[0]}T00:00:00.000Z`);
+        const scope = { workspaceUid: ModelUtils.literal(workspaceUid) };
+        const contactRepo = await this.repo("contact");
+        const created = await this.all(contactRepo, { ...scope, dateCreated: ModelUtils.literal(since, "gte") });
+        const changes = await this.all(await this.repo("timelineEvent"), {
+            ...scope,
+            subjectType: ModelUtils.literal(CrmObjectType.CONTACT),
+            kind: ModelUtils.literal([TimelineKind.SUBSCRIBED, TimelineKind.UNSUBSCRIBED], "in"),
+            occurredAt: ModelUtils.literal(since, "gte"),
+        });
+        const days = dates.map((date) => ({
+            date,
+            contacts: created.filter((contact) => day(contact.dateCreated) === date).length,
+            subscribed: changes.filter((entry) => entry.kind === TimelineKind.SUBSCRIBED && day(entry.occurredAt) === date).length,
+            unsubscribed: changes.filter((entry) => entry.kind === TimelineKind.UNSUBSCRIBED && day(entry.occurredAt) === date).length,
+        }));
+        const lists = await (await this.repo("mailingList")).find({ ...scope, sort: { name: "ASC" } }, { ignoreACL: true, limit: 200, skipCache: true });
+        const subscriptions = await this.repo("subscription");
+        return {
+            days,
+            contacts: await contactRepo.count(scope, { ignoreACL: true, skipCache: true }),
+            lists: await Promise.all(lists.map(async (list) => ({
+                uid: list.uid,
+                name: list.name,
+                subscribed: await subscriptions.count({ listUid: ModelUtils.literal(list.uid), status: ModelUtils.literal(SubscriptionStatus.SUBSCRIBED) }, { ignoreACL: true, skipCache: true }),
+            }))),
+        };
+    }
+    async sales(workspaceUid, query, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const dates = lastDays(this.readDays(query));
+        const since = new Date(`${dates[0]}T00:00:00.000Z`);
+        const pipelineUid = query?.pipelineUid;
+        const scope = {
+            workspaceUid: ModelUtils.literal(workspaceUid),
+            ...(typeof pipelineUid === "string" && pipelineUid && pipelineUid.length <= 64 ? { pipelineUid: ModelUtils.literal(pipelineUid) } : {}),
+        };
+        const deals = await this.repo("deal");
+        const created = await this.all(deals, { ...scope, dateCreated: ModelUtils.literal(since, "gte") });
+        const closed = await this.all(deals, { ...scope, closedAt: ModelUtils.literal(since, "gte") });
+        const open = await this.all(deals, { ...scope, status: ModelUtils.literal(DealStatus.OPEN) });
+        const won = closed.filter((deal) => deal.status === DealStatus.WON);
+        return {
+            days: dates.map((date) => {
+                const wonToday = won.filter((deal) => day(deal.closedAt) === date);
+                return {
+                    date,
+                    created: created.filter((deal) => day(deal.dateCreated) === date).length,
+                    won: wonToday.length,
+                    wonAmount: wonToday.reduce((sum, deal) => sum + deal.amount, 0),
+                    lost: closed.filter((deal) => deal.status === DealStatus.LOST && day(deal.closedAt) === date).length,
+                };
+            }),
+            open: { count: open.length, amount: open.reduce((sum, deal) => sum + deal.amount, 0) },
+            won: { count: won.length, amount: won.reduce((sum, deal) => sum + deal.amount, 0) },
+            lost: closed.filter((deal) => deal.status === DealStatus.LOST).length,
+        };
+    }
+}
+__decorate([
+    Get("/:workspaceUid/email"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Query()),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAnalyticsRoute.prototype, "email", null);
+__decorate([
+    Get("/:workspaceUid/growth"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Query()),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAnalyticsRoute.prototype, "growth", null);
+__decorate([
+    Get("/:workspaceUid/sales"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Query()),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAnalyticsRoute.prototype, "sales", null);
+//# sourceMappingURL=BaseAnalyticsRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseAnalyticsRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseAnalyticsRoute.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,EAEH,aAAa,EAEb,UAAU,EAEV,cAAc,EAGd,UAAU,EAEV,kBAAkB,EAElB,YAAY,EACZ,eAAe,GAClB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;AAE9D,iGAAiG;AACjG,MAAM,CAAC,MAAM,eAAe,GAAG,MAAO,CAAC;AACvC,MAAM,IAAI,GAAG,IAAI,CAAC;AAiDlB,2CAA2C;AAC3C,SAAS,GAAG,CAAC,IAAmB;IAC5B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACrD,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,QAAQ,CAAC,KAAa,EAAE,MAAY,IAAI,IAAI,EAAE;IAC1D,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,QAAU,CAAC,CAAC,CAAC,CAAC;AAC7H,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,OAAgB,kBAAmB,SAAQ,YAAY;IACjD,QAAQ,CAAC,KAA0C;QACvD,MAAM,IAAI,GAAW,MAAM,CAAC,KAAK,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,GAAG,GAAG,EAAE,CAAC;YACpD,MAAM,UAAU,CAAC,8CAA8C,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,qFAAqF;IAC7E,KAAK,CAAC,GAAG,CAA4B,IAAkB,EAAE,KAA8B;QAC3F,MAAM,IAAI,GAAQ,EAAE,CAAC;QACrB,IAAI,KAAyB,CAAC;QAC9B,OAAO,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE,CAAC;YACnC,MAAM,IAAI,GAAQ,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACrL,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;YACnB,IAAI,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,CAAC;gBACrB,MAAM;YACV,CAAC;YACD,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC;QACtC,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;IAGY,AAAN,KAAK,CAAC,KAAK,CAAwB,YAAoB,EAAW,KAA0C,EAAY,IAAc;QACzI,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,KAAK,GAAW,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAa,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,KAAK,GAAS,IAAI,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAsB,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAkB,iBAAiB,CAAC,EAAE;YAClG,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC;YAC9C,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SAC/C,CAAC,CAAC;QACH,MAAM,IAAI,GAAkE;YACxE,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM;YAC7B,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,QAAQ;YACjC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,SAAS;YACnC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,SAAS;YACnC,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,SAAS;YACnC,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,cAAc;SAChD,CAAC;QACF,gFAAgF;QAChF,MAAM,MAAM,GAA6B,IAAI,GAAG,EAAE,CAAC;QACnD,MAAM,OAAO,GAA6B,IAAI,GAAG,EAAE,CAAC;QACpD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC;gBACtB,SAAS;YACb,CAAC;YACD,MAAM,MAAM,GAAW,GAAG,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC;YAChE,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YACzE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,IAAI,GAAe,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,MAAM,KAAK,GAAa,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;YAC1G,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7C,KAAK,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;YAC1D,CAAC;YACD,OAAO,KAAK,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,CAAC,IAAoB,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,CAAC;QACrE,MAAM,KAAK,GAAmB,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAe,cAAc,CAAC,EAAE;YACxF,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC;YAC9C,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;YAC3C,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SAC3C,CAAC,CAAC;QACH,MAAM,OAAO,GAAmF,IAAI,GAAG,EAAE,CAAC;QAC1G,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACvB,MAAM,MAAM,GAAW,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YACzE,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YAChF,KAAK,CAAC,IAAI,EAAE,CAAC;YACb,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChE,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,OAAO;YACH,IAAI;YACJ,MAAM,EAAE;gBACJ,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC;gBAChC,MAAM,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC;gBACpC,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC;gBACtC,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC;gBACtC,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC;gBACtC,YAAY,EAAE,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC;gBAChD,UAAU,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC;aAC/C;YACD,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;SAClH,CAAC;IACN,CAAC;IAGY,AAAN,KAAK,CAAC,MAAM,CAAwB,YAAoB,EAAW,KAA0C,EAAY,IAAc;QAC1I,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,KAAK,GAAa,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACvD,MAAM,KAAK,GAAS,IAAI,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACjE,MAAM,WAAW,GAA0B,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC;QAClF,MAAM,OAAO,GAAiB,MAAM,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACvH,MAAM,OAAO,GAAoB,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAgB,eAAe,CAAC,EAAE;YAC7F,GAAG,KAAK;YACR,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC;YACtD,IAAI,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC;YACpF,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC;SAC/C,CAAC,CAAC;QACH,MAAM,IAAI,GAAgB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3C,IAAI;YACJ,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM;YAC/E,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,UAAU,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM;YACtH,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC,YAAY,IAAI,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM;SAC7H,CAAC,CAAC,CAAC;QACJ,MAAM,KAAK,GAAkB,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAc,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7K,MAAM,aAAa,GAA4B,MAAM,IAAI,CAAC,IAAI,CAAe,cAAc,CAAC,CAAC;QAC7F,OAAO;YACH,IAAI;YACJ,QAAQ,EAAE,MAAM,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;YAC9E,KAAK,EAAE,MAAM,OAAO,CAAC,GAAG,CACpB,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;gBACvB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,UAAU,EAAE,MAAM,aAAa,CAAC,KAAK,CACjC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE,EACpG,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CACvC;aACJ,CAAC,CAAC,CACN;SACJ,CAAC;IACN,CAAC;IAGY,AAAN,KAAK,CAAC,KAAK,CAAwB,YAAoB,EAAW,KAA0C,EAAY,IAAc;QACzI,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,KAAK,GAAa,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACvD,MAAM,KAAK,GAAS,IAAI,IAAI,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAC1D,MAAM,WAAW,GAAY,KAAK,EAAE,WAAW,CAAC;QAChD,MAAM,KAAK,GAA4B;YACnC,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC;YAC9C,GAAG,CAAC,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC1I,CAAC;QACF,MAAM,KAAK,GAAoB,MAAM,IAAI,CAAC,IAAI,CAAO,MAAM,CAAC,CAAC;QAC7D,MAAM,OAAO,GAAW,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QAC3G,MAAM,MAAM,GAAW,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;QACvG,MAAM,IAAI,GAAW,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtG,MAAM,GAAG,GAAW,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,GAAG,CAAC,CAAC;QAC5E,OAAO;YACH,IAAI,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;gBACrB,MAAM,QAAQ,GAAW,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,QAAS,CAAC,KAAK,IAAI,CAAC,CAAC;gBAC5E,OAAO;oBACH,IAAI;oBACJ,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM;oBACxE,GAAG,EAAE,QAAQ,CAAC,MAAM;oBACpB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;oBAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC,QAAS,CAAC,KAAK,IAAI,CAAC,CAAC,MAAM;iBACxG,CAAC;YACN,CAAC,CAAC;YACF,IAAI,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE;YACtF,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE;YACnF,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM;SACxE,CAAC;IACN,CAAC;CACJ;AAtIgB;IADZ,GAAG,CAAC,sBAAsB,CAAC;IACR,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAwB,WAAA,KAAK,EAAE,CAAA;IAA8C,WAAA,QAAQ,CAAA;;;;+CA+D7H;AAGY;IADZ,GAAG,CAAC,uBAAuB,CAAC;IACR,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAwB,WAAA,KAAK,EAAE,CAAA;IAA8C,WAAA,QAAQ,CAAA;;;;gDAmC9H;AAGY;IADZ,GAAG,CAAC,sBAAsB,CAAC;IACR,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAwB,WAAA,KAAK,EAAE,CAAA;IAA8C,WAAA,QAAQ,CAAA;;;;+CA6B7H"}

package/dist/lib/routes/BaseApiKeyRoute.js

@@ -0,0 +1,76 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import * as crypto from "crypto";
+import { ApiKeyScope, WorkspaceAction } from "../models/types.js";
+import { badRequest, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+/** How many API keys one workspace may have. */
+export const MAX_API_KEYS = 20;
+/** A new API key: `crm_` and 32 random bytes, base64url. */
+export function newApiKey() {
+    return `crm_${crypto.randomBytes(32).toString("base64url")}`;
+}
+/** What an API key is stored as. */
+export function hashApiKey(key) {
+    return crypto.createHash("sha256").update(key).digest("hex");
+}
+/**
+ * A workspace's integration API keys (`/api/mail/crm/api-keys`) - see `BaseWorkspaceRecordRoute` for the endpoints; they take
+ * `MANAGE`. A key is answered in full once, when it is created (`key`); only its SHA-256 is kept. A key can be renamed and its
+ * `scopes` changed; deleting it revokes it. See `BaseIntegrationRoute` for what keys call.
+ */
+export class BaseApiKeyRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "apiKey";
+        this.pushType = "CrmApiKey";
+        this.writeAction = WorkspaceAction.MANAGE;
+        this.maxRecords = MAX_API_KEYS;
+    }
+    async readCreate(body, context) {
+        const key = newApiKey();
+        this.issued = key;
+        return {
+            name: readText(body, "name", { required: true }),
+            prefix: key.slice(0, 12),
+            hash: hashApiKey(key),
+            scopes: this.readScopes(body) ?? Object.values(ApiKeyScope),
+            createdByUserUid: context.user.uid,
+        };
+    }
+    async readUpdate(body) {
+        const fields = {};
+        const name = readText(body, "name");
+        if (name === null) {
+            throw badRequest("'name' is required.");
+        }
+        if (name !== undefined) {
+            fields.name = name;
+        }
+        const scopes = this.readScopes(body);
+        if (scopes) {
+            fields.scopes = scopes;
+        }
+        return fields;
+    }
+    readScopes(body) {
+        if (body.scopes === undefined) {
+            return undefined;
+        }
+        if (!Array.isArray(body.scopes) || body.scopes.length === 0 || body.scopes.some((scope) => !Object.values(ApiKeyScope).includes(scope))) {
+            throw badRequest(`'scopes' must list some of: ${Object.values(ApiKeyScope).join(", ")}.`);
+        }
+        return [...new Set(body.scopes)];
+    }
+    async toViews(records) {
+        return records.map(({ hash: _hash, ...record }) => JSON.parse(JSON.stringify(record)));
+    }
+    async create(workspaceUid, body, user) {
+        this.issued = undefined;
+        const view = await super.create(workspaceUid, body, user);
+        return { ...view, key: this.issued };
+    }
+}
+//# sourceMappingURL=BaseApiKeyRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseApiKeyRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseApiKeyRoute.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,OAAO,EAAU,WAAW,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AAEvF,gDAAgD;AAChD,MAAM,CAAC,MAAM,YAAY,GAAG,EAAE,CAAC;AAE/B,4DAA4D;AAC5D,MAAM,UAAU,SAAS;IACrB,OAAO,OAAO,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;AACjE,CAAC;AAED,oCAAoC;AACpC,MAAM,UAAU,UAAU,CAAC,GAAW;IAClC,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACjE,CAAC;AAKD;;;;GAIG;AACH,MAAM,OAAgB,eAAgB,SAAQ,wBAA4C;IAA1F;;QACuB,UAAK,GAAG,QAAiB,CAAC;QAC1B,aAAQ,GAAW,WAAW,CAAC;QACtB,gBAAW,GAAoB,eAAe,CAAC,MAAM,CAAC;QACtD,eAAU,GAAW,YAAY,CAAC;IAoDlE,CAAC;IA/Ca,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,GAAG,GAAW,SAAS,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC;QAClB,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE;YACjD,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;YACxB,IAAI,EAAE,UAAU,CAAC,GAAG,CAAC;YACrB,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;YAC3D,gBAAgB,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;SACrC,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B;QACpD,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,MAAM,IAAI,GAA8B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC/D,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAChB,MAAM,UAAU,CAAC,qBAAqB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACrB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,MAAM,MAAM,GAA8B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,UAAU,CAAC,IAA6B;QAC5C,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,QAAQ,CAAC,KAAoB,CAAC,CAAC,EAAE,CAAC;YACrJ,MAAM,UAAU,CAAC,+BAA+B,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9F,CAAC;QACD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAuB,CAAC,CAAC,CAAC;IACtD,CAAC;IAEkB,KAAK,CAAC,OAAO,CAAC,OAAiB;QAC9C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC3F,CAAC;IAEe,KAAK,CAAC,MAAM,CAAC,YAAoB,EAAE,IAAa,EAAE,IAAc;QAC5E,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC;QACxB,MAAM,IAAI,GAAe,MAAM,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACtE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;IACzC,CAAC;CACJ"}

package/dist/lib/routes/BaseAutomationRoute.js

@@ -0,0 +1,316 @@
+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 { AutomationEngine } from "../automation/Engine.js";
+import { NodeType, validateForPublish, validateGraph } from "../automation/Graph.js";
+import { CrmEventType } from "../automation/Events.js";
+import { validateFilter } from "../filters/Filter.js";
+import { AutomationReentry, AutomationStatus, CrmObjectType, EnrollmentState, PropertyType, WorkspaceAction, } from "../models/types.js";
+import { contactFilterFields } from "../segments/Segments.js";
+import { badRequest, readEnum, readPaging, readText, requireObject } from "../util/Validation.js";
+import { notFound } from "../util/WorkspaceAccess.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+const { Get, Param, Post, User: AuthUser } = RouteDecorators;
+/** How many automations one workspace may have. */
+export const MAX_AUTOMATIONS = 200;
+/** How many contacts one request may enroll by hand. */
+export const MAX_MANUAL_ENROLL = 500;
+/** A new automation's draft: a trigger, waiting to be set up. */
+function starterGraph() {
+    return { nodes: [{ id: "trigger", type: NodeType.TRIGGER, config: { event: CrmEventType.LIST_SUBSCRIBED } }], edges: [] };
+}
+/**
+ * A workspace's automations (`/api/mail/crm/automations`) - see `BaseWorkspaceRecordRoute` for the endpoints; the draft `graph`,
+ * `reentry` and `goalFilter` change with `PUT` - plus:
+ * - `POST /:workspaceUid/:uid/publish` - checks the draft (`validateForPublish()` and that everything it names exists) and makes it
+ * the version new enrollments go through; the automation becomes active.
+ * - `POST /:workspaceUid/:uid/pause` and `.../resume`.
+ * - `POST /:workspaceUid/:uid/enroll` - `{ contactUids }`: puts contacts in by hand (an active automation, as its re-entry rule allows).
+ * - `GET /:workspaceUid/:uid/report` - `AutomationReport`.
+ * - `POST /:workspaceUid/:uid/enrollments` - `{ state?, contactUid?, limit?, page? }` to a page of enrollments.
+ * - `POST /:workspaceUid/:uid/enrollments/:enrollmentUid/exit` - takes one contact out.
+ */
+export class BaseAutomationRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "automation";
+        this.pushType = "CrmAutomation";
+        this.sortFields = ["name"];
+        this.maxRecords = MAX_AUTOMATIONS;
+    }
+    async readCreate(body, context) {
+        return {
+            name: readText(body, "name", { required: true }),
+            description: readText(body, "description", { max: 2000 }) ?? undefined,
+            status: AutomationStatus.DRAFT,
+            graph: body.graph === undefined ? starterGraph() : validateGraph(body.graph),
+            reentry: readEnum(body, "reentry", Object.values(AutomationReentry)) ?? AutomationReentry.NEVER,
+            ...(body.goalFilter !== undefined && body.goalFilter !== null ? { goalFilter: await this.readContactFilter(context.workspaceUid, body.goalFilter) } : {}),
+            createdByUserUid: context.user.uid,
+        };
+    }
+    async readUpdate(body, _existing, context) {
+        const fields = {};
+        const name = readText(body, "name");
+        if (name === null) {
+            throw badRequest("'name' is required.");
+        }
+        if (name !== undefined) {
+            fields.name = name;
+        }
+        if (body.description !== undefined) {
+            fields.description = readText(body, "description", { max: 2000 });
+        }
+        if (body.graph !== undefined) {
+            fields.graph = validateGraph(body.graph);
+        }
+        const reentry = readEnum(body, "reentry", Object.values(AutomationReentry));
+        if (reentry) {
+            fields.reentry = reentry;
+        }
+        if (body.goalFilter !== undefined) {
+            fields.goalFilter = body.goalFilter === null ? null : await this.readContactFilter(context.workspaceUid, body.goalFilter);
+        }
+        return fields;
+    }
+    async readContactFilter(workspaceUid, raw) {
+        return validateFilter(raw, await contactFilterFields(this.repos(), workspaceUid, true));
+    }
+    async afterDelete(record) {
+        for (const name of ["automationVersion", "enrollment"]) {
+            await (await this.repo(name)).truncate({ automationUid: ModelUtils.literal(record.uid) }, { ignoreACL: true, skipPush: true });
+        }
+    }
+    async requireAutomation(user, workspaceUid, uid, action) {
+        await this.requireAccess(user, workspaceUid, action);
+        return await this.requireRecord(workspaceUid, uid);
+    }
+    /** Refuses (400) a published graph naming something the workspace doesn't have. */
+    async checkReferences(automation, references) {
+        const workspaceUid = automation.workspaceUid;
+        const exists = async (name, uid) => {
+            const record = await (await this.repo(name)).findOne(uid, { ignoreACL: true, skipCache: true });
+            return record?.workspaceUid === workspaceUid;
+        };
+        const checks = [
+            [references.templates, (uid) => exists("template", uid), "an email template"],
+            [references.senders, (uid) => exists("workspaceSender", uid), "a sender"],
+            [references.lists, async (uid) => !!(await this.findList(workspaceUid, uid)), "a list"],
+            [references.forms, (uid) => exists("form", uid), "a form"],
+            [references.segments, (uid) => exists("segment", uid), "a segment"],
+            [references.automations, async (uid) => uid !== automation.uid && (await exists("automation", uid)), "another automation"],
+            [references.members, async (uid) => !!(await this.findMember(workspaceUid, uid)), "a member of the workspace"],
+            [references.pipelines, (uid) => exists("pipeline", uid), "a pipeline"],
+            [references.webhooks, (uid) => exists("webhookEndpoint", uid), "a webhook"],
+        ];
+        for (const [uids, check, noun] of checks) {
+            for (const uid of uids) {
+                if (!(await check(uid))) {
+                    throw badRequest(`A step names ${noun} that doesn't exist: ${uid}.`);
+                }
+            }
+        }
+        const definitions = await this.repo("propertyDefinition");
+        for (const key of references.dateProperties) {
+            const definition = (await definitions.find({ workspaceUid: ModelUtils.literal(workspaceUid), objectType: ModelUtils.literal(CrmObjectType.CONTACT), key: ModelUtils.literal(key) }, { ignoreACL: true, limit: 1, skipCache: true }))[0];
+            if (definition?.type !== PropertyType.DATE) {
+                throw badRequest(`The trigger's date must be a contact date property; '${key}' isn't one.`);
+            }
+        }
+        for (const filter of references.filters) {
+            await this.readContactFilter(workspaceUid, filter);
+        }
+    }
+    async publish(workspaceUid, uid, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.WRITE);
+        const graph = validateGraph(automation.graph);
+        await this.checkReferences(automation, validateForPublish(graph));
+        const versions = await this.repo("automationVersion");
+        const count = await versions.count({ automationUid: ModelUtils.literal(automation.uid) }, { ignoreACL: true, skipCache: true });
+        const version = await versions.create(new this.classes.automationVersion({ workspaceUid, automationUid: automation.uid, versionNumber: count + 1, graph, publishedByUserUid: user.uid }), { ignoreACL: true, skipPush: true });
+        return await this.transition(automation, { status: AutomationStatus.ACTIVE, publishedVersionUid: version.uid, publishedAt: new Date() });
+    }
+    async pause(workspaceUid, uid, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.WRITE);
+        if (automation.status !== AutomationStatus.ACTIVE) {
+            throw badRequest("Only an active automation can be paused.");
+        }
+        return await this.transition(automation, { status: AutomationStatus.PAUSED });
+    }
+    async resume(workspaceUid, uid, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.WRITE);
+        if (automation.status !== AutomationStatus.PAUSED) {
+            throw badRequest("Only a paused automation can be resumed.");
+        }
+        return await this.transition(automation, { status: AutomationStatus.ACTIVE });
+    }
+    async enroll(workspaceUid, uid, body, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.WRITE);
+        const request = requireObject(body);
+        if (!Array.isArray(request.contactUids) || request.contactUids.length === 0 || request.contactUids.length > MAX_MANUAL_ENROLL) {
+            throw badRequest(`'contactUids' must be a list of 1 to ${MAX_MANUAL_ENROLL} contact uids.`);
+        }
+        if (automation.status !== AutomationStatus.ACTIVE) {
+            throw badRequest("Contacts can only be put into an active automation.");
+        }
+        const version = (await (await this.repo("automationVersion")).findOne(automation.publishedVersionUid, { ignoreACL: true }));
+        const contacts = await (await this.repo("contact")).find({ workspaceUid: ModelUtils.literal(workspaceUid), uid: ModelUtils.literal(request.contactUids.filter((entry) => typeof entry === "string"), "in") }, { ignoreACL: true, limit: MAX_MANUAL_ENROLL, skipCache: true });
+        const engine = new AutomationEngine({ repos: this.repos(), classes: this.classes, logger: this.logger });
+        let enrolled = 0;
+        for (const contact of contacts) {
+            enrolled += (await engine.enroll(automation, version, contact.uid, CrmEventType.MANUAL)) ? 1 : 0;
+        }
+        return { enrolled };
+    }
+    async report(workspaceUid, uid, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.READ);
+        const enrollments = await this.repo("enrollment");
+        const scope = { automationUid: ModelUtils.literal(automation.uid) };
+        const states = {};
+        for (const state of Object.values(EnrollmentState)) {
+            states[state] = await enrollments.count({ ...scope, state: ModelUtils.literal(state) }, { ignoreACL: true, skipCache: true });
+        }
+        const nodes = {};
+        const version = automation.publishedVersionUid
+            ? await (await this.repo("automationVersion")).findOne(automation.publishedVersionUid, { ignoreACL: true })
+            : undefined;
+        const sends = await this.repo("outboundSend");
+        for (const node of version?.graph?.nodes ?? []) {
+            nodes[node.id] = {
+                current: await enrollments.count({ ...scope, currentNodeId: ModelUtils.literal(node.id), state: ModelUtils.literal([EnrollmentState.ACTIVE, EnrollmentState.WAITING], "in") }, { ignoreACL: true, skipCache: true }),
+            };
+            if (node.type === NodeType.SEND_EMAIL) {
+                const count = async (extra) => await sends.count({ sourceUid: ModelUtils.literal(automation.uid), nodeId: ModelUtils.literal(node.id), ...extra }, { ignoreACL: true, skipCache: true });
+                const notNull = () => ModelUtils.literal(null, "ne");
+                nodes[node.id].sent = await count({ sentAt: notNull() });
+                nodes[node.id].opened = await count({ firstOpenedAt: notNull(), machineOpen: ModelUtils.literal(false) });
+                nodes[node.id].clicked = await count({ firstClickedAt: notNull() });
+                nodes[node.id].replied = await count({ repliedAt: notNull() });
+            }
+        }
+        return { states, nodes };
+    }
+    async enrollments(workspaceUid, uid, body, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.READ);
+        const request = body === undefined ? {} : requireObject(body);
+        const paging = readPaging(request.limit, request.page);
+        const state = readEnum(request, "state", Object.values(EnrollmentState));
+        const contactUid = readText(request, "contactUid", { max: 64 });
+        const query = {
+            automationUid: ModelUtils.literal(automation.uid),
+            ...(state ? { state: ModelUtils.literal(state) } : {}),
+            ...(contactUid ? { contactUid: ModelUtils.literal(contactUid) } : {}),
+        };
+        const repo = await this.repo("enrollment");
+        const total = await repo.count(query, { ignoreACL: true, skipCache: true });
+        const items = await repo.find({ ...query, sort: { enteredAt: "DESC" } }, { ignoreACL: true, limit: paging.limit, page: paging.page, skipCache: true });
+        const contacts = items.length === 0
+            ? []
+            : await (await this.repo("contact")).find({ uid: ModelUtils.literal([...new Set(items.map((item) => item.contactUid))], "in") }, { ignoreACL: true, limit: items.length, skipCache: true });
+        return {
+            items: items.map((item) => ({ ...JSON.parse(JSON.stringify(item)), email: contacts.find((contact) => contact.uid === item.contactUid)?.email })),
+            total,
+        };
+    }
+    async exitEnrollment(workspaceUid, uid, enrollmentUid, user) {
+        const automation = await this.requireAutomation(user, workspaceUid, uid, WorkspaceAction.WRITE);
+        const repo = await this.repo("enrollment");
+        const enrollment = typeof enrollmentUid === "string" && enrollmentUid.length <= 64 ? await repo.findOne(enrollmentUid, { ignoreACL: true, skipCache: true }) : undefined;
+        if (!enrollment || enrollment.automationUid !== automation.uid) {
+            throw notFound();
+        }
+        if (enrollment.state !== EnrollmentState.ACTIVE && enrollment.state !== EnrollmentState.WAITING) {
+            throw badRequest("Only a contact still in the automation can be taken out.");
+        }
+        const updated = await repo.update({ uid: enrollment.uid, version: enrollment.version, state: EnrollmentState.EXITED, finishedAt: new Date(), waitFor: null, error: "Taken out by a member." }, enrollment, { ignoreACL: true, skipPush: true });
+        return JSON.parse(JSON.stringify(updated));
+    }
+    async transition(automation, changes) {
+        const updated = await (await this.records()).update({ ...changes, uid: automation.uid, version: automation.version }, automation, {
+            ignoreACL: true,
+            skipPush: true,
+        });
+        const view = JSON.parse(JSON.stringify(updated));
+        this.notify(automation.workspaceUid, this.pushType, "update", view);
+        return view;
+    }
+}
+__decorate([
+    Post("/:workspaceUid/:uid/publish"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "publish", null);
+__decorate([
+    Post("/:workspaceUid/:uid/pause"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "pause", null);
+__decorate([
+    Post("/:workspaceUid/:uid/resume"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "resume", null);
+__decorate([
+    Post("/:workspaceUid/:uid/enroll"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(3, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "enroll", null);
+__decorate([
+    Get("/:workspaceUid/:uid/report"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "report", null);
+__decorate([
+    Post("/:workspaceUid/:uid/enrollments"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(3, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "enrollments", null);
+__decorate([
+    Post("/:workspaceUid/:uid/enrollments/:enrollmentUid/exit"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Param("uid")),
+    __param(2, Param("enrollmentUid")),
+    __param(3, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, String, Object]),
+    __metadata("design:returntype", Promise)
+], BaseAutomationRoute.prototype, "exitEnrollment", null);
+//# sourceMappingURL=BaseAutomationRoute.js.map