@rapidmx/crm-plugin 0.1.0

package/dist/lib/routes/BaseScoringRuleRoute.js

@@ -0,0 +1,146 @@
+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 { ScoringActivity, ScoringKind, WorkspaceAction } from "../models/types.js";
+import { scoreWorkspace } from "../scoring/Scoring.js";
+import { readSegmentFilter } from "../segments/Segments.js";
+import { badRequest, readBoolean, readEnum, readNumber, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+const { Param, Post, User: AuthUser } = RouteDecorators;
+/** How many scoring rules one workspace may have. */
+export const MAX_SCORING_RULES = 50;
+/** How often the workspace's bookkeeping is retried when another write to it got there first. */
+const WORKSPACE_ATTEMPTS = 5;
+/**
+ * A workspace's lead scoring rules (`/api/mail/crm/scoring-rules`) - see `BaseWorkspaceRecordRoute` for the endpoints; changing them
+ * takes `MANAGE` - plus `POST /:workspaceUid/recalculate`, which scores every contact now (`{ changed }`).
+ *
+ * A contact's `score` is the sum of the enabled rules' points: a **property** rule gives its points to the contacts its filter matches
+ * (the same filters as segments, but not naming segments), an **activity** rule gives its points for each time a contact did something
+ * - opened, clicked, replied, bounced, submitted a form, subscribed, unsubscribed - in its last `withinDays`, up to `maxPoints`.
+ * `ScoringJob` rescores a workspace soon after its rules change, and regularly after that (activity windows move).
+ */
+export class BaseScoringRuleRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "scoringRule";
+        this.pushType = "CrmScoringRule";
+        this.writeAction = WorkspaceAction.MANAGE;
+        this.sortFields = ["name"];
+        this.maxRecords = MAX_SCORING_RULES;
+    }
+    async readCreate(body, context) {
+        const kind = readEnum(body, "kind", Object.values(ScoringKind), { required: true });
+        return {
+            name: readText(body, "name", { required: true }),
+            enabled: readBoolean(body, "enabled") ?? true,
+            kind,
+            ...(await this.readRule(kind, body, context.workspaceUid, true)),
+        };
+    }
+    async readUpdate(body, existing, context) {
+        if (body.kind !== undefined && body.kind !== existing.kind) {
+            throw badRequest("A rule's kind can't change; make a new rule.");
+        }
+        const fields = await this.readRule(existing.kind, body, context.workspaceUid, false);
+        const name = readText(body, "name");
+        if (name === null) {
+            throw badRequest("'name' is required.");
+        }
+        if (name !== undefined) {
+            fields.name = name;
+        }
+        const enabled = readBoolean(body, "enabled");
+        if (enabled !== undefined) {
+            fields.enabled = enabled;
+        }
+        return fields;
+    }
+    /** The fields of a rule of `kind` in `body`: all of them when `creating`, else those given. */
+    async readRule(kind, body, workspaceUid, creating) {
+        const fields = {};
+        const points = readNumber(body, "points", { integer: true, min: -100, max: 100 });
+        if (points === null || (creating && points === undefined)) {
+            throw badRequest("'points' is required.");
+        }
+        if (points !== undefined) {
+            fields.points = points;
+        }
+        if (kind === ScoringKind.PROPERTY) {
+            if (creating || body.filter !== undefined) {
+                fields.filter = await readSegmentFilter(this.repos(), workspaceUid, body.filter);
+            }
+            return fields;
+        }
+        const activity = readEnum(body, "activity", Object.values(ScoringActivity), { required: creating });
+        if (activity) {
+            fields.activity = activity;
+        }
+        for (const [field, max] of [
+            ["maxPoints", 10000],
+            ["withinDays", 3650],
+        ]) {
+            const value = readNumber(body, field, { integer: true, min: 1, max });
+            if (value !== undefined) {
+                fields[field] = value;
+            }
+        }
+        return fields;
+    }
+    async afterWrite(record) {
+        await this.touchWorkspace(record.workspaceUid);
+    }
+    async afterDelete(record) {
+        await this.touchWorkspace(record.workspaceUid);
+    }
+    /** Marks the workspace's scores out of date and counts its rules, so `ScoringJob` rescores it (and to 0, with none left). */
+    async touchWorkspace(workspaceUid) {
+        const scoringRules = await (await this.records()).count({ workspaceUid: ModelUtils.literal(workspaceUid) }, { ignoreACL: true, skipCache: true });
+        await this.updateWorkspace(workspaceUid, { scoringRules, scoringDirty: true });
+    }
+    async updateWorkspace(workspaceUid, changes) {
+        const repo = await this.repo("workspace");
+        for (let attempt = 1;; attempt++) {
+            const workspace = await this.requireWorkspaceRecord(workspaceUid);
+            try {
+                await repo.update({ ...changes, uid: workspace.uid, version: workspace.version }, workspace, { ignoreACL: true, skipPush: true });
+                return;
+            }
+            catch (err) {
+                if (attempt >= WORKSPACE_ATTEMPTS || !/version/i.test(err?.message ?? "")) {
+                    throw err;
+                }
+            }
+        }
+    }
+    async recalculate(workspaceUid, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.MANAGE);
+        const rules = await (await this.records()).find({ workspaceUid: ModelUtils.literal(workspaceUid) }, { ignoreACL: true, limit: MAX_SCORING_RULES, skipCache: true });
+        const changed = await scoreWorkspace(this.repos(), workspaceUid, rules);
+        await this.updateWorkspace(workspaceUid, { scoringDirty: false, scoredAt: new Date() });
+        return { changed };
+    }
+}
+__decorate([
+    Post("/:workspaceUid/recalculate"),
+    __param(0, Param("workspaceUid")),
+    __param(1, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], BaseScoringRuleRoute.prototype, "recalculate", null);
+//# sourceMappingURL=BaseScoringRuleRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseScoringRuleRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseScoringRuleRoute.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,EAAE,eAAe,EAAE,WAAW,EAA0B,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC3G,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AACvF,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;AAExD,qDAAqD;AACrD,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAEpC,iGAAiG;AACjG,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAE7B;;;;;;;;GAQG;AACH,MAAM,OAAgB,oBAAqB,SAAQ,wBAAqC;IAAxF;;QACuB,UAAK,GAAG,aAAsB,CAAC;QAC/B,aAAQ,GAAW,gBAAgB,CAAC;QAC3B,gBAAW,GAAoB,eAAe,CAAC,MAAM,CAAC;QACtD,eAAU,GAAsB,CAAC,MAAM,CAAC,CAAC;QACzC,eAAU,GAAW,iBAAiB,CAAC;IAoGvE,CAAC;IAlGa,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,IAAI,GAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE,CAAC;QAClG,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE;YACjD,OAAO,EAAE,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,IAAI;YAC7C,IAAI;YACJ,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;SACnE,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAAqB,EAAE,OAAqB;QAClG,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;YACzD,MAAM,UAAU,CAAC,8CAA8C,CAAC,CAAC;QACrE,CAAC;QACD,MAAM,MAAM,GAA4B,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QAC9G,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,OAAO,GAAwB,WAAW,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAClE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,+FAA+F;IACvF,KAAK,CAAC,QAAQ,CAAC,IAAiB,EAAE,IAA6B,EAAE,YAAoB,EAAE,QAAiB;QAC5G,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,MAAM,MAAM,GAA8B,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC;QAC7G,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,IAAI,MAAM,KAAK,SAAS,CAAC,EAAE,CAAC;YACxD,MAAM,UAAU,CAAC,uBAAuB,CAAC,CAAC;QAC9C,CAAC;QACD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,CAAC;QACD,IAAI,IAAI,KAAK,WAAW,CAAC,QAAQ,EAAE,CAAC;YAChC,IAAI,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;gBACxC,MAAM,CAAC,MAAM,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;YACrF,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC;QACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;QACpG,IAAI,QAAQ,EAAE,CAAC;YACX,MAAM,CAAC,QAAQ,GAAG,QAAQ,CAAC;QAC/B,CAAC;QACD,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI;YACvB,CAAC,WAAW,EAAE,KAAM,CAAC;YACrB,CAAC,YAAY,EAAE,IAAI,CAAC;SACd,EAAE,CAAC;YACT,MAAM,KAAK,GAA8B,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;YACjG,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC1B,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEkB,KAAK,CAAC,UAAU,CAAC,MAAmB;QACnD,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAEkB,KAAK,CAAC,WAAW,CAAC,MAAmB;QACpD,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;IAED,6HAA6H;IACrH,KAAK,CAAC,cAAc,CAAC,YAAoB;QAC7C,MAAM,YAAY,GAAW,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1J,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IACnF,CAAC;IAEO,KAAK,CAAC,eAAe,CAAC,YAAoB,EAAE,OAA2B;QAC3E,MAAM,IAAI,GAAyB,MAAM,IAAI,CAAC,IAAI,CAAY,WAAW,CAAC,CAAC;QAC3E,KAAK,IAAI,OAAO,GAAG,CAAC,GAAI,OAAO,EAAE,EAAE,CAAC;YAChC,MAAM,SAAS,GAAc,MAAM,IAAI,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAC;YAC7E,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;gBAClI,OAAO;YACX,CAAC;YAAC,OAAO,GAAQ,EAAE,CAAC;gBAChB,IAAI,OAAO,IAAI,kBAAkB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;oBACxE,MAAM,GAAG,CAAC;gBACd,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAGY,AAAN,KAAK,CAAC,WAAW,CAAwB,YAAoB,EAAY,IAAc;QAC1F,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;QACrE,MAAM,KAAK,GAAkB,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACnL,MAAM,OAAO,GAAW,MAAM,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QAChF,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;QACxF,OAAO,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;CACJ;AAPgB;IADZ,IAAI,CAAC,4BAA4B,CAAC;IACT,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAwB,WAAA,QAAQ,CAAA;;;;uDAM9E"}

package/dist/lib/routes/BaseSegmentRoute.js

@@ -0,0 +1,136 @@
+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 { SegmentKind, WorkspaceAction } from "../models/types.js";
+import { SEGMENTS_KEY, matchingContacts, readSegmentFilter, recordSegmentEvents, refreshSegment } from "../segments/Segments.js";
+import { badRequest, readEnum, readText, requireObject } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+const { Param, Post, User: AuthUser } = RouteDecorators;
+/** How many segments one workspace may have. */
+export const MAX_SEGMENTS = 200;
+/** How many contacts a preview shows. */
+const PREVIEW_SIZE = 10;
+/**
+ * A workspace's segments (`/api/mail/crm/segments`) - see `BaseWorkspaceRecordRoute` for the endpoints - plus:
+ * - `POST /:workspaceUid/preview` - `{ filter }` to `{ count, capped, contacts }`: how many contacts a filter matches now, and the
+ * first few, for the segment editor.
+ * - `POST /:workspaceUid/:uid/refresh` - works the members out again now (a static segment's only way to change).
+ *
+ * Members are worked out when a segment is created and whenever its filter or kind changes; `SegmentRefreshJob` keeps dynamic ones
+ * current after that. A segment's filter may not name segments.
+ */
+export class BaseSegmentRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "segment";
+        this.pushType = "CrmSegment";
+        this.sortFields = ["name", "memberCount"];
+        this.maxRecords = MAX_SEGMENTS;
+    }
+    async readCreate(body, context) {
+        return {
+            name: readText(body, "name", { required: true }),
+            description: readText(body, "description", { max: 2000 }) ?? undefined,
+            kind: readEnum(body, "kind", Object.values(SegmentKind)) ?? SegmentKind.DYNAMIC,
+            filter: await readSegmentFilter(this.repos(), context.workspaceUid, body.filter),
+            memberCount: 0,
+            capped: false,
+            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 });
+        }
+        const kind = readEnum(body, "kind", Object.values(SegmentKind));
+        if (kind) {
+            fields.kind = kind;
+        }
+        if (body.filter !== undefined) {
+            fields.filter = await readSegmentFilter(this.repos(), context.workspaceUid, body.filter);
+        }
+        return fields;
+    }
+    /** A new segment, or one whose filter or kind changed, gets its members at once. */
+    async afterWrite(record, before) {
+        if (!before || JSON.stringify(before.filter) !== JSON.stringify(record.filter) || before.kind !== record.kind) {
+            return await this.refresh(record);
+        }
+    }
+    async afterDelete(record) {
+        await (await this.repo("propertyValue")).truncate({ workspaceUid: ModelUtils.literal(record.workspaceUid), key: ModelUtils.literal(SEGMENTS_KEY), stringValue: ModelUtils.literal(record.uid) }, { ignoreACL: true });
+    }
+    /**
+     * Works `segment`'s members out and saves the counts. Returns the segment as saved. With `events`, who entered and left is
+     * recorded for automations - not on a segment's first working out, or everyone in it would count as just entered.
+     */
+    async refresh(segment, events = false) {
+        const { counts, entered, left } = await refreshSegment(this.repos(), this.classes, segment);
+        if (events) {
+            await recordSegmentEvents(this.repos(), this.classes, segment, entered, left, this.logger);
+        }
+        const records = await this.records();
+        const current = (await records.findOne(segment.uid, { ignoreACL: true, skipCache: true }));
+        return await records.update({ ...counts, uid: current.uid, version: current.version }, current, { ignoreACL: true, skipPush: true });
+    }
+    async preview(workspaceUid, body, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const filter = await readSegmentFilter(this.repos(), workspaceUid, requireObject(body).filter);
+        const { uids, capped } = await matchingContacts(this.repos(), workspaceUid, filter);
+        const sample = uids.length === 0
+            ? []
+            : await (await this.repo("contact")).find({ uid: ModelUtils.literal(uids.slice(0, PREVIEW_SIZE), "in"), sort: { email: "ASC" } }, { ignoreACL: true, limit: PREVIEW_SIZE, skipCache: true });
+        return {
+            count: uids.length,
+            capped,
+            contacts: sample.map(({ uid, email, firstName, lastName }) => ({ uid, email, firstName, lastName })),
+        };
+    }
+    async refreshNow(workspaceUid, uid, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.WRITE);
+        const saved = await this.refresh(await this.requireRecord(workspaceUid, uid), true);
+        const view = JSON.parse(JSON.stringify(saved));
+        this.notify(workspaceUid, this.pushType, "update", view);
+        return view;
+    }
+}
+__decorate([
+    Post("/:workspaceUid/preview"),
+    __param(0, Param("workspaceUid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseSegmentRoute.prototype, "preview", null);
+__decorate([
+    Post("/:workspaceUid/:uid/refresh"),
+    __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)
+], BaseSegmentRoute.prototype, "refreshNow", null);
+//# sourceMappingURL=BaseSegmentRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseSegmentRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseSegmentRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAGtE,OAAO,EAAuB,WAAW,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACvF,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACjI,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AACvF,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;AAExD,gDAAgD;AAChD,MAAM,CAAC,MAAM,YAAY,GAAG,GAAG,CAAC;AAEhC,yCAAyC;AACzC,MAAM,YAAY,GAAG,EAAE,CAAC;AAExB;;;;;;;;GAQG;AACH,MAAM,OAAgB,gBAAiB,SAAQ,wBAAiC;IAAhF;;QACuB,UAAK,GAAG,SAAkB,CAAC;QAC3B,aAAQ,GAAW,YAAY,CAAC;QACvB,eAAU,GAAsB,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACxD,eAAU,GAAW,YAAY,CAAC;IA+FlE,CAAC;IA7Fa,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE;YACjD,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,IAAI,SAAS;YACtE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,WAAW,CAAC,OAAO;YAC/E,MAAM,EAAE,MAAM,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC;YAChF,WAAW,EAAE,CAAC;YACd,MAAM,EAAE,KAAK;YACb,gBAAgB,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG;SACrC,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,SAAkB,EAAE,OAAqB;QAC/F,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,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,WAAW,GAAG,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,CAAC;QACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QAChE,IAAI,IAAI,EAAE,CAAC;YACP,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,MAAM,GAAG,MAAM,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC7F,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,oFAAoF;IACjE,KAAK,CAAC,UAAU,CAAC,MAAe,EAAE,MAA2B;QAC5E,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,CAAC,IAAI,EAAE,CAAC;YAC5G,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;IAEkB,KAAK,CAAC,WAAW,CAAC,MAAe;QAChD,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAC7C,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAC7I,EAAE,SAAS,EAAE,IAAI,EAAE,CACtB,CAAC;IACN,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,OAAO,CAAC,OAAgB,EAAE,SAAkB,KAAK;QAC3D,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC5F,IAAI,MAAM,EAAE,CAAC;YACT,MAAM,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/F,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,OAAO,GAAY,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAE,CAAC;QACrG,OAAO,MAAM,OAAO,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;IACzI,CAAC;IAGY,AAAN,KAAK,CAAC,OAAO,CACO,YAAoB,EAC3C,IAAa,EACH,IAAc;QAExB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,MAAM,GAAe,MAAM,iBAAiB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;QAC3G,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;QACpF,MAAM,MAAM,GACR,IAAI,CAAC,MAAM,KAAK,CAAC;YACb,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC,CAAC,IAAI,CAC/C,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EACtF,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,IAAI,EAAE,CAC5D,CAAC;QACZ,OAAO;YACH,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,MAAM;YACN,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,CAAC;SACvG,CAAC;IACN,CAAC;IAGY,AAAN,KAAK,CAAC,UAAU,CAAwB,YAAoB,EAAgB,GAAW,EAAY,IAAc;QACpH,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACpE,MAAM,KAAK,GAAY,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;QAC7F,MAAM,IAAI,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA9BgB;IADZ,IAAI,CAAC,wBAAwB,CAAC;IAE1B,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAErB,WAAA,QAAQ,CAAA;;;;+CAiBZ;AAGY;IADZ,IAAI,CAAC,6BAA6B,CAAC;IACX,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAwB,WAAA,KAAK,CAAC,KAAK,CAAC,CAAA;IAAe,WAAA,QAAQ,CAAA;;;;kDAMxG"}

package/dist/lib/routes/BaseSubscriptionRoute.js

@@ -0,0 +1,92 @@
+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); }
+};
+import { ModelUtils, RouteDecorators } from "@rapidrest/service-core";
+import { SubscriptionStatus, WorkspaceAction } from "../models/types.js";
+import { badRequest, readPaging, requireObject } from "../util/Validation.js";
+import { CrmRouteBase } from "./CrmRouteBase.js";
+const { Get, Param, Post, Query, User: AuthUser } = RouteDecorators;
+/** How many contacts one subscription request may change. */
+export const MAX_SUBSCRIPTION_BATCH = 500;
+/**
+ * Contacts' subscriptions to a workspace's lists (`/api/mail/crm/subscriptions`):
+ * - `GET /:workspaceUid` - subscriptions, newest first, narrowed by `listUid`, `contactUid` and `status`.
+ * - `POST /:workspaceUid` - `{ listUid, contactUids, status }` subscribes (`subscribed`) or unsubscribes (`unsubscribed`) up to
+ * `MAX_SUBSCRIPTION_BATCH` contacts at once, as a member (source `manual`). A member can't make a subscription pending: only a
+ * form's double opt-in does that.
+ *
+ * Reading takes `READ` on the workspace, changing `WRITE`.
+ */
+export class BaseSubscriptionRoute extends CrmRouteBase {
+    async list(workspaceUid, query, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.READ);
+        const paging = readPaging(query?.limit, query?.page, 500);
+        const conditions = { workspaceUid: ModelUtils.literal(workspaceUid), sort: { dateCreated: "DESC" } };
+        for (const field of ["listUid", "contactUid"]) {
+            const value = query?.[field];
+            if (typeof value === "string" && value.length > 0 && value.length <= 64) {
+                conditions[field] = ModelUtils.literal(value);
+            }
+        }
+        if (Object.values(SubscriptionStatus).includes(query?.status)) {
+            conditions.status = ModelUtils.literal(query.status);
+        }
+        const subscriptions = await (await this.repo("subscription")).find(conditions, {
+            ignoreACL: true,
+            limit: paging.limit,
+            page: paging.page,
+            skipCache: true,
+        });
+        return JSON.parse(JSON.stringify(subscriptions));
+    }
+    async change(workspaceUid, body, user) {
+        await this.requireAccess(user, workspaceUid, WorkspaceAction.WRITE);
+        const request = requireObject(body);
+        if (!(await this.findList(workspaceUid, request.listUid))) {
+            throw badRequest("'listUid' must be a list of the workspace.");
+        }
+        const status = request.status;
+        if (status !== SubscriptionStatus.SUBSCRIBED && status !== SubscriptionStatus.UNSUBSCRIBED) {
+            throw badRequest("'status' must be subscribed or unsubscribed.");
+        }
+        const uids = request.contactUids;
+        if (!Array.isArray(uids) || uids.length === 0 || uids.length > MAX_SUBSCRIPTION_BATCH || uids.some((uid) => typeof uid !== "string")) {
+            throw badRequest(`'contactUids' must be a list of 1 to ${MAX_SUBSCRIPTION_BATCH} contact uids.`);
+        }
+        const contacts = await (await this.repo("contact")).find({ workspaceUid: ModelUtils.literal(workspaceUid), uid: ModelUtils.literal([...new Set(uids)], "in") }, { ignoreACL: true, limit: MAX_SUBSCRIPTION_BATCH, skipCache: true });
+        for (const contact of contacts) {
+            await this.setSubscription(workspaceUid, request.listUid, contact.uid, status, {
+                source: "manual",
+                actorUserUid: user.uid.toLowerCase(),
+            });
+        }
+        return { changed: contacts.length };
+    }
+}
+__decorate([
+    Get("/:workspaceUid"),
+    __param(0, Param("workspaceUid")),
+    __param(1, Query()),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseSubscriptionRoute.prototype, "list", null);
+__decorate([
+    Post("/:workspaceUid"),
+    __param(0, Param("workspaceUid")),
+    __param(2, AuthUser),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object, Object]),
+    __metadata("design:returntype", Promise)
+], BaseSubscriptionRoute.prototype, "change", null);
+//# sourceMappingURL=BaseSubscriptionRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseSubscriptionRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseSubscriptionRoute.ts"],"names":[],"mappings":";;;;;;;;;;;;AAKA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAA4B,kBAAkB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACnG,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,eAAe,CAAC;AAEpE,6DAA6D;AAC7D,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAE1C;;;;;;;;GAQG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,YAAY;IAE/C,AAAN,KAAK,CAAC,IAAI,CACU,YAAoB,EAClC,KAA0C,EACzC,IAAc;QAExB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACnE,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAC1D,MAAM,UAAU,GAA4B,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,CAAC;QAC9H,KAAK,MAAM,KAAK,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAC;YAC5C,MAAM,KAAK,GAAY,KAAK,EAAE,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;gBACtE,UAAU,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC;QACL,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,MAA4B,CAAC,EAAE,CAAC;YAClF,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,KAAM,CAAC,MAAM,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM,aAAa,GAAmB,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAe,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE;YACzG,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;IACrD,CAAC;IAGY,AAAN,KAAK,CAAC,MAAM,CAAwB,YAAoB,EAAE,IAAa,EAAY,IAAc;QACpG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,YAAY,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACpE,MAAM,OAAO,GAA4B,aAAa,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;YACxD,MAAM,UAAU,CAAC,4CAA4C,CAAC,CAAC;QACnE,CAAC;QACD,MAAM,MAAM,GAAY,OAAO,CAAC,MAAM,CAAC;QACvC,IAAI,MAAM,KAAK,kBAAkB,CAAC,UAAU,IAAI,MAAM,KAAK,kBAAkB,CAAC,YAAY,EAAE,CAAC;YACzF,MAAM,UAAU,CAAC,8CAA8C,CAAC,CAAC;QACrE,CAAC;QACD,MAAM,IAAI,GAAY,OAAO,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,sBAAsB,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,EAAE,CAAC;YACnI,MAAM,UAAU,CAAC,wCAAwC,sBAAsB,gBAAgB,CAAC,CAAC;QACrG,CAAC;QACD,MAAM,QAAQ,GAAiB,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAa,SAAS,CAAC,CAAC,CAAC,IAAI,CAC9E,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,IAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EACjH,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,sBAAsB,EAAE,SAAS,EAAE,IAAI,EAAE,CACtE,CAAC;QACF,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,eAAe,CAAC,YAAY,EAAE,OAAO,CAAC,OAAiB,EAAE,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE;gBACrF,MAAM,EAAE,QAAQ;gBAChB,YAAY,EAAE,IAAK,CAAC,GAAG,CAAC,WAAW,EAAE;aACxC,CAAC,CAAC;QACP,CAAC;QACD,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;IACxC,CAAC;CACJ;AArDgB;IADZ,GAAG,CAAC,gBAAgB,CAAC;IAEjB,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IACrB,WAAA,KAAK,EAAE,CAAA;IACP,WAAA,QAAQ,CAAA;;;;iDAqBZ;AAGY;IADZ,IAAI,CAAC,gBAAgB,CAAC;IACF,WAAA,KAAK,CAAC,cAAc,CAAC,CAAA;IAAuC,WAAA,QAAQ,CAAA;;;;mDAyBxF"}

package/dist/lib/routes/BaseSuppressionRoute.js

@@ -0,0 +1,48 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils } from "@rapidrest/service-core";
+import { SuppressionReason, WorkspaceAction } from "../models/types.js";
+import { MAX_LONG_TEXT, badRequest, conflict, readEmail, readEnum, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+/**
+ * A workspace's suppression list (`/api/mail/crm/suppressions`) - see `BaseWorkspaceRecordRoute` for the endpoints: addresses no
+ * campaign or automation ever mails, whatever lists they are on. Bounces and spam complaints add to it on their own (Phase 4); a
+ * member with `MANAGE` adds and removes addresses by hand. `GET /:workspaceUid` takes `email` to look one address up. Only an
+ * entry's note can change.
+ */
+export class BaseSuppressionRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "suppression";
+        this.pushType = "CrmSuppression";
+        this.writeAction = WorkspaceAction.MANAGE;
+        this.sortFields = ["email", "reason"];
+    }
+    async readCreate(body, context) {
+        const email = readEmail(body, "email", { required: true });
+        const existing = await (await this.records()).find({ workspaceUid: ModelUtils.literal(context.workspaceUid), email: ModelUtils.literal(email) }, { ignoreACL: true, limit: 1, skipCache: true });
+        if (existing.length > 0) {
+            throw conflict(`${email} is already suppressed.`);
+        }
+        return {
+            email,
+            reason: readEnum(body, "reason", Object.values(SuppressionReason)) ?? SuppressionReason.MANUAL,
+            note: readText(body, "note", { max: MAX_LONG_TEXT }) ?? undefined,
+        };
+    }
+    async readUpdate(body, existing) {
+        if ((body.email !== undefined && body.email !== existing.email) || (body.reason !== undefined && body.reason !== existing.reason)) {
+            throw badRequest("Only a suppression's note can change.");
+        }
+        const note = readText(body, "note", { max: MAX_LONG_TEXT });
+        return note === undefined ? {} : { note: note };
+    }
+    listQuery(query) {
+        return typeof query.email === "string" && query.email.length > 0 && query.email.length <= 254
+            ? { email: ModelUtils.literal(query.email.trim().toLowerCase()) }
+            : {};
+    }
+}
+//# sourceMappingURL=BaseSuppressionRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseSuppressionRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseSuppressionRoute.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAe,iBAAiB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC3G,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AAEvF;;;;;GAKG;AACH,MAAM,OAAgB,oBAAqB,SAAQ,wBAAqC;IAAxF;;QACuB,UAAK,GAAG,aAAsB,CAAC;QAC/B,aAAQ,GAAW,gBAAgB,CAAC;QAC3B,gBAAW,GAAoB,eAAe,CAAC,MAAM,CAAC;QACtD,eAAU,GAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IA+BpF,CAAC;IA7Ba,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,KAAK,GAAW,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE,CAAC;QACpE,MAAM,QAAQ,GAAkB,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CAC7D,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,EAC5F,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CACjD,CAAC;QACF,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,QAAQ,CAAC,GAAG,KAAK,yBAAyB,CAAC,CAAC;QACtD,CAAC;QACD,OAAO;YACH,KAAK;YACL,MAAM,EAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,IAAI,iBAAiB,CAAC,MAAM;YAC9F,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,IAAI,SAAS;SACpE,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAAqB;QAC3E,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAChI,MAAM,UAAU,CAAC,uCAAuC,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,IAAI,GAA8B,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;QACvF,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAc,EAAE,CAAC;IAC9D,CAAC;IAEkB,SAAS,CAAC,KAA8B;QACvD,OAAO,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,IAAI,GAAG;YACzF,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE;YACjE,CAAC,CAAC,EAAE,CAAC;IACb,CAAC;CACJ"}