@rapidmx/crm-plugin 0.1.0

package/dist/lib/routes/BaseListRoute.js

@@ -0,0 +1,89 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils } from "@rapidrest/service-core";
+import { SubscriptionStatus, WorkspaceAction } from "../models/types.js";
+import { MAX_LONG_TEXT, badRequest, readBoolean, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+import { LISTS_KEY } from "./CrmRouteBase.js";
+/** How many lists one workspace may have. */
+export const MAX_LISTS = 500;
+/**
+ * A workspace's mailing lists (`/api/mail/crm/lists`) - see `BaseWorkspaceRecordRoute` for the endpoints. Creating, changing and
+ * deleting a list takes `MANAGE`. A list with double opt-in needs a sender for its confirmation emails. Deleting a list deletes its
+ * subscriptions.
+ */
+export class BaseListRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "mailingList";
+        this.pushType = "CrmMailingList";
+        this.writeAction = WorkspaceAction.MANAGE;
+        this.sortFields = ["name"];
+        this.maxRecords = MAX_LISTS;
+    }
+    async readCreate(body, context) {
+        const fields = await this.readFields(body, context, undefined);
+        fields.publicName ?? (fields.publicName = fields.name);
+        return fields;
+    }
+    async readUpdate(body, existing, context) {
+        return await this.readFields(body, context, existing);
+    }
+    async readFields(body, context, existing) {
+        const fields = {};
+        const name = readText(body, "name", { required: !existing });
+        if (name === null) {
+            throw badRequest("'name' is required.");
+        }
+        if (name !== undefined) {
+            fields.name = name;
+        }
+        const publicName = readText(body, "publicName");
+        if (publicName !== undefined) {
+            // Cleared: subscribers see the list's own name.
+            fields.publicName = publicName ?? name ?? existing?.name;
+        }
+        for (const field of ["description", "publicDescription"]) {
+            const value = readText(body, field, { max: MAX_LONG_TEXT });
+            if (value !== undefined) {
+                fields[field] = value;
+            }
+        }
+        for (const field of ["doubleOptIn", "visible"]) {
+            const value = readBoolean(body, field);
+            if (value !== undefined) {
+                fields[field] = value;
+            }
+        }
+        if (body.senderUid !== undefined) {
+            fields.senderUid = body.senderUid === null || body.senderUid === "" ? null : await this.requireSender(context.workspaceUid, body.senderUid);
+        }
+        const doubleOptIn = fields.doubleOptIn ?? existing?.doubleOptIn ?? false;
+        const senderUid = "senderUid" in fields ? fields.senderUid : existing?.senderUid;
+        if (doubleOptIn && !senderUid) {
+            throw badRequest("A list with double opt-in needs a 'senderUid' to send its confirmation emails from.");
+        }
+        return fields;
+    }
+    async toViews(records) {
+        const repo = await this.repo("subscription");
+        const views = [];
+        for (const record of records) {
+            const count = async (status) => await repo.count({ listUid: ModelUtils.literal(record.uid), status: ModelUtils.literal(status) }, { ignoreACL: true, skipCache: true });
+            views.push({
+                ...JSON.parse(JSON.stringify(record)),
+                subscribedCount: await count(SubscriptionStatus.SUBSCRIBED),
+                pendingCount: await count(SubscriptionStatus.PENDING),
+            });
+        }
+        return views;
+    }
+    async afterDelete(record, context) {
+        const scope = { workspaceUid: ModelUtils.literal(context.workspaceUid) };
+        await (await this.repo("subscription")).truncate({ ...scope, listUid: ModelUtils.literal(record.uid) }, { ignoreACL: true, skipPush: true });
+        await (await this.repo("propertyValue")).truncate({ ...scope, key: ModelUtils.literal(LISTS_KEY), stringValue: ModelUtils.literal(record.uid) }, { ignoreACL: true, skipPush: true });
+    }
+}
+//# sourceMappingURL=BaseListRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseListRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseListRoute.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,kBAAkB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtF,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAE9C,6CAA6C;AAC7C,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAC;AAQ7B;;;;GAIG;AACH,MAAM,OAAgB,aAAc,SAAQ,wBAAsD;IAAlG;;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,SAAS,CAAC;IAwE/D,CAAC;IAtEa,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,MAAM,GAAyB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QACrF,MAAM,CAAC,UAAU,KAAjB,MAAM,CAAC,UAAU,GAAK,MAAM,CAAC,IAAI,EAAC;QAClC,OAAO,MAAM,CAAC;IAClB,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAAqB,EAAE,OAAqB;QAClG,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB,EAAE,QAAiC;QAC5G,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,MAAM,IAAI,GAA8B,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACxF,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,UAAU,GAA8B,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QAC3E,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC3B,gDAAgD;YAChD,MAAM,CAAC,UAAU,GAAG,UAAU,IAAI,IAAI,IAAI,QAAQ,EAAE,IAAI,CAAC;QAC7D,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,CAAC,aAAa,EAAE,mBAAmB,CAAC,EAAE,CAAC;YACvD,MAAM,KAAK,GAA8B,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;YACvF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC1B,CAAC;QACL,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,CAAC,aAAa,EAAE,SAAS,CAAC,EAAE,CAAC;YAC7C,MAAM,KAAK,GAAwB,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;YAC5D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YAC1B,CAAC;QACL,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,KAAK,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAChJ,CAAC;QACD,MAAM,WAAW,GAAa,MAAM,CAAC,WAAmC,IAAI,QAAQ,EAAE,WAAW,IAAI,KAAK,CAAC;QAC3G,MAAM,SAAS,GAAY,WAAW,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE,SAAS,CAAC;QAC1F,IAAI,WAAW,IAAI,CAAC,SAAS,EAAE,CAAC;YAC5B,MAAM,UAAU,CAAC,qFAAqF,CAAC,CAAC;QAC5G,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEkB,KAAK,CAAC,OAAO,CAAC,OAAsB;QACnD,MAAM,IAAI,GAAmB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7D,MAAM,KAAK,GAAsB,EAAE,CAAC;QACpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,KAAK,GAAG,KAAK,EAAE,MAA0B,EAAmB,EAAE,CAChE,MAAM,IAAI,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5I,KAAK,CAAC,IAAI,CAAC;gBACP,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACrC,eAAe,EAAE,MAAM,KAAK,CAAC,kBAAkB,CAAC,UAAU,CAAC;gBAC3D,YAAY,EAAE,MAAM,KAAK,CAAC,kBAAkB,CAAC,OAAO,CAAC;aACxD,CAAC,CAAC;QACP,CAAC;QACD,OAAO,KAAK,CAAC;IACjB,CAAC;IAEkB,KAAK,CAAC,WAAW,CAAC,MAAmB,EAAE,OAAqB;QAC3E,MAAM,KAAK,GAAG,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QACzE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,GAAG,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7I,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAC7C,EAAE,GAAG,KAAK,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAC7F,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CACtC,CAAC;IACN,CAAC;CACJ"}

package/dist/lib/routes/BaseNoteRoute.js

@@ -0,0 +1,69 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils } from "@rapidrest/service-core";
+import { TimelineKind } from "../models/types.js";
+import { MAX_LONG_TEXT, badRequest, readBoolean, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+/**
+ * Notes on contacts and companies (`/api/mail/crm/notes`) - see `BaseWorkspaceRecordRoute` for the endpoints. `GET /:workspaceUid`
+ * takes `subjectUid` to list one record's notes. A new note also goes on its record's timeline; deleting it takes it off.
+ */
+export class BaseNoteRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "note";
+        this.pushType = "CrmNote";
+    }
+    async readCreate(body, context) {
+        const subject = await this.requireSubject(context.workspaceUid, body.subjectType, body.subjectUid);
+        return {
+            ...subject,
+            body: readText(body, "body", { required: true, max: MAX_LONG_TEXT }),
+            pinned: readBoolean(body, "pinned") ?? false,
+            authorUserUid: context.user.uid.toLowerCase(),
+        };
+    }
+    async readUpdate(body, existing) {
+        if ((body.subjectType !== undefined && body.subjectType !== existing.subjectType) ||
+            (body.subjectUid !== undefined && body.subjectUid !== existing.subjectUid)) {
+            throw badRequest("A note can't move to another record.");
+        }
+        const fields = {};
+        const text = readText(body, "body", { max: MAX_LONG_TEXT });
+        if (text === null) {
+            throw badRequest("'body' is required.");
+        }
+        if (text !== undefined) {
+            fields.body = text;
+        }
+        const pinned = readBoolean(body, "pinned");
+        if (pinned !== undefined) {
+            fields.pinned = pinned;
+        }
+        return fields;
+    }
+    async afterWrite(record, before, _body, context) {
+        if (!before) {
+            await this.addTimeline({
+                workspaceUid: context.workspaceUid,
+                subjectType: record.subjectType,
+                subjectUid: record.subjectUid,
+                kind: TimelineKind.NOTE,
+                summary: record.body.length > 200 ? `${record.body.slice(0, 197)}...` : record.body,
+                actorUserUid: record.authorUserUid,
+                refUid: record.uid,
+            });
+        }
+    }
+    async afterDelete(record, context) {
+        await (await this.repo("timelineEvent")).truncate({ workspaceUid: ModelUtils.literal(context.workspaceUid), refUid: ModelUtils.literal(record.uid) }, { ignoreACL: true, skipPush: true });
+    }
+    listQuery(query) {
+        return typeof query.subjectUid === "string" && query.subjectUid.length > 0 && query.subjectUid.length <= 64
+            ? { subjectUid: ModelUtils.literal(query.subjectUid) }
+            : {};
+    }
+}
+//# sourceMappingURL=BaseNoteRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BaseNoteRoute.js","sourceRoot":"","sources":["../../../src/routes/BaseNoteRoute.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,EAAW,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACzF,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AAEvF;;;GAGG;AACH,MAAM,OAAgB,aAAc,SAAQ,wBAAiC;IAA7E;;QACuB,UAAK,GAAG,MAAe,CAAC;QACxB,aAAQ,GAAW,SAAS,CAAC;IA4DpD,CAAC;IA1Da,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,YAAY,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACnG,OAAO;YACH,GAAG,OAAO;YACV,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,aAAa,EAAE,CAAE;YACrE,MAAM,EAAE,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,KAAK;YAC5C,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE;SAChD,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAAiB;QACvE,IACI,CAAC,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,QAAQ,CAAC,WAAW,CAAC;YAC7E,CAAC,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,QAAQ,CAAC,UAAU,CAAC,EAC5E,CAAC;YACC,MAAM,UAAU,CAAC,sCAAsC,CAAC,CAAC;QAC7D,CAAC;QACD,MAAM,MAAM,GAAqB,EAAE,CAAC;QACpC,MAAM,IAAI,GAA8B,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,CAAC;QACvF,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,GAAwB,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAChE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEkB,KAAK,CAAC,UAAU,CAAC,MAAe,EAAE,MAA2B,EAAE,KAA8B,EAAE,OAAqB;QACnI,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,IAAI,CAAC,WAAW,CAAC;gBACnB,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,IAAI,EAAE,YAAY,CAAC,IAAI;gBACvB,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI;gBACnF,YAAY,EAAE,MAAM,CAAC,aAAa;gBAClC,MAAM,EAAE,MAAM,CAAC,GAAG;aACrB,CAAC,CAAC;QACP,CAAC;IACL,CAAC;IAEkB,KAAK,CAAC,WAAW,CAAC,MAAe,EAAE,OAAqB;QACvE,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAC7C,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAClG,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CACtC,CAAC;IACN,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/BasePipelineRoute.js

@@ -0,0 +1,149 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import * as crypto from "crypto";
+import { ModelUtils } from "@rapidrest/service-core";
+import { StageKind, WorkspaceAction } from "../models/types.js";
+import { badRequest, isObject, readBoolean, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+/** How many pipelines one workspace may have, and stages one pipeline. */
+export const MAX_PIPELINES = 20;
+export const MAX_STAGES = 20;
+/** The stages a workspace's first pipeline starts with. */
+export function defaultStages() {
+    const stage = (name, probability, kind = StageKind.OPEN) => ({ id: crypto.randomUUID(), name, probability, kind });
+    return [
+        stage("Qualified", 10),
+        stage("Meeting booked", 30),
+        stage("Proposal sent", 60),
+        stage("Negotiation", 80),
+        stage("Won", 100, StageKind.WON),
+        stage("Lost", 0, StageKind.LOST),
+    ];
+}
+/**
+ * A workspace's sales pipelines (`/api/mail/crm/pipelines`) - see `BaseWorkspaceRecordRoute` for the endpoints; changing them takes
+ * `MANAGE`. A workspace with none gets a default one ("Sales") the first time its pipelines are listed.
+ *
+ * A pipeline's `stages` are replaced as a whole: each keeps its `id` (a new one gets one), and a stage that still holds deals can't be
+ * removed. A pipeline needs a won and a lost stage, and one that holds deals can't be deleted. One pipeline is the default.
+ */
+export class BasePipelineRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "pipeline";
+        this.pushType = "CrmPipeline";
+        this.writeAction = WorkspaceAction.MANAGE;
+        this.sortFields = ["name"];
+        this.maxRecords = MAX_PIPELINES;
+    }
+    async readCreate(body, context) {
+        const count = await (await this.records()).count({ workspaceUid: ModelUtils.literal(context.workspaceUid) }, { ignoreACL: true, skipCache: true });
+        return {
+            name: readText(body, "name", { required: true }),
+            stages: body.stages === undefined ? defaultStages() : this.readStages(body.stages, []),
+            isDefault: count === 0 || readBoolean(body, "isDefault") === true,
+        };
+    }
+    async readUpdate(body, existing) {
+        const fields = {};
+        const name = readText(body, "name");
+        if (name === null) {
+            throw badRequest("'name' is required.");
+        }
+        if (name !== undefined) {
+            fields.name = name;
+        }
+        if (body.stages !== undefined) {
+            const stages = this.readStages(body.stages, existing.stages);
+            for (const removed of existing.stages.filter((stage) => !stages.some((entry) => entry.id === stage.id))) {
+                const count = await (await this.repo("deal")).count({ pipelineUid: ModelUtils.literal(existing.uid), stageId: ModelUtils.literal(removed.id) }, { ignoreACL: true, skipCache: true });
+                if (count > 0) {
+                    throw badRequest(`The stage "${removed.name}" still has ${count} deals: move them first.`);
+                }
+            }
+            fields.stages = stages;
+        }
+        if (readBoolean(body, "isDefault") === true) {
+            fields.isDefault = true;
+        }
+        return fields;
+    }
+    /** `raw` as a pipeline's stages: known ids kept, new ones given one; a won and a lost stage required. */
+    readStages(raw, current) {
+        if (!Array.isArray(raw) || raw.length < 2 || raw.length > MAX_STAGES) {
+            throw badRequest(`'stages' must be a list of 2 to ${MAX_STAGES} stages.`);
+        }
+        const ids = new Set();
+        const stages = raw.map((entry, index) => {
+            const where = `Stage ${index + 1}`;
+            if (!isObject(entry)) {
+                throw badRequest(`${where} must be an object.`);
+            }
+            const known = typeof entry.id === "string" && current.some((stage) => stage.id === entry.id);
+            const id = known ? entry.id : crypto.randomUUID();
+            if (ids.has(id)) {
+                throw badRequest(`${where} repeats another stage.`);
+            }
+            ids.add(id);
+            const kind = entry.kind ?? StageKind.OPEN;
+            if (!Object.values(StageKind).includes(kind)) {
+                throw badRequest(`${where}'s kind must be open, won or lost.`);
+            }
+            const probability = entry.probability ?? (kind === StageKind.WON ? 100 : kind === StageKind.LOST ? 0 : 50);
+            if (typeof probability !== "number" || !Number.isInteger(probability) || probability < 0 || probability > 100) {
+                throw badRequest(`${where}'s probability must be a whole number from 0 to 100.`);
+            }
+            const rottingDays = entry.rottingDays;
+            if (rottingDays !== undefined && rottingDays !== null && (typeof rottingDays !== "number" || !Number.isInteger(rottingDays) || rottingDays < 1 || rottingDays > 365)) {
+                throw badRequest(`${where}'s rotting days must be a whole number from 1 to 365.`);
+            }
+            return {
+                id,
+                name: readText(entry, "name", { required: true, max: 100 }),
+                probability,
+                kind: kind,
+                ...(typeof rottingDays === "number" ? { rottingDays } : {}),
+            };
+        });
+        if (!stages.some((stage) => stage.kind === StageKind.WON) || !stages.some((stage) => stage.kind === StageKind.LOST)) {
+            throw badRequest("A pipeline needs a won stage and a lost stage.");
+        }
+        if (!stages.some((stage) => stage.kind === StageKind.OPEN)) {
+            throw badRequest("A pipeline needs at least one open stage.");
+        }
+        return stages;
+    }
+    /** A new default takes over from the old one. */
+    async afterWrite(record) {
+        if (!record.isDefault) {
+            return;
+        }
+        const repo = await this.records();
+        for (const other of await repo.find({ workspaceUid: ModelUtils.literal(record.workspaceUid), isDefault: ModelUtils.literal(true) }, { ignoreACL: true, limit: MAX_PIPELINES, skipCache: true })) {
+            if (other.uid !== record.uid) {
+                await repo.update({ uid: other.uid, version: other.version, isDefault: false }, other, { ignoreACL: true, skipPush: true });
+            }
+        }
+    }
+    async beforeDelete(record) {
+        const count = await (await this.repo("deal")).count({ pipelineUid: ModelUtils.literal(record.uid) }, { ignoreACL: true, skipCache: true });
+        if (count > 0) {
+            throw badRequest(`The pipeline still has ${count} deals: move or delete them first.`);
+        }
+        if (record.isDefault) {
+            throw badRequest("Make another pipeline the default before deleting this one.");
+        }
+    }
+    /** A workspace's pipelines, making it a default one ("Sales") if it has none. */
+    async list(workspaceUid, query, user) {
+        const pipelines = await super.list(workspaceUid, query, user);
+        if (pipelines.length > 0 || (query?.page !== undefined && query.page !== "0")) {
+            return pipelines;
+        }
+        const created = await (await this.records()).create(new this.classes.pipeline({ workspaceUid, name: "Sales", stages: defaultStages(), isDefault: true }), { ignoreACL: true, skipPush: true });
+        return [JSON.parse(JSON.stringify(created))];
+    }
+}
+//# sourceMappingURL=BasePipelineRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BasePipelineRoute.js","sourceRoot":"","sources":["../../../src/routes/BasePipelineRoute.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,UAAU,EAAa,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAiC,SAAS,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACpF,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AAEvF,0EAA0E;AAC1E,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAChC,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC;AAE7B,2DAA2D;AAC3D,MAAM,UAAU,aAAa;IACzB,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,WAAmB,EAAE,OAAkB,SAAS,CAAC,IAAI,EAAiB,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7J,OAAO;QACH,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QACtB,KAAK,CAAC,gBAAgB,EAAE,EAAE,CAAC;QAC3B,KAAK,CAAC,eAAe,EAAE,EAAE,CAAC;QAC1B,KAAK,CAAC,aAAa,EAAE,EAAE,CAAC;QACxB,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;QAChC,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,SAAS,CAAC,IAAI,CAAC;KACnC,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACH,MAAM,OAAgB,iBAAkB,SAAQ,wBAAkC;IAAlF;;QACuB,UAAK,GAAG,UAAmB,CAAC;QAC5B,aAAQ,GAAW,aAAa,CAAC;QACxB,gBAAW,GAAoB,eAAe,CAAC,MAAM,CAAC;QACtD,eAAU,GAAsB,CAAC,MAAM,CAAC,CAAC;QACzC,eAAU,GAAW,aAAa,CAAC;IA2HnE,CAAC;IAzHa,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,KAAK,GAAW,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3J,OAAO;YACH,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE;YACjD,MAAM,EAAE,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACtF,SAAS,EAAE,KAAK,KAAK,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI;SACpE,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAAkB;QACxE,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,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAoB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;YAC9E,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBACtG,MAAM,KAAK,GAAW,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAC7D,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,EAC1F,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CACvC,CAAC;gBACF,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;oBACZ,MAAM,UAAU,CAAC,cAAc,OAAO,CAAC,IAAI,eAAe,KAAK,0BAA0B,CAAC,CAAC;gBAC/F,CAAC;YACL,CAAC;YACD,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;QAC3B,CAAC;QACD,IAAI,WAAW,CAAC,IAAI,EAAE,WAAW,CAAC,KAAK,IAAI,EAAE,CAAC;YAC1C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,yGAAyG;IACjG,UAAU,CAAC,GAAY,EAAE,OAAwB;QACrD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YACnE,MAAM,UAAU,CAAC,mCAAmC,UAAU,UAAU,CAAC,CAAC;QAC9E,CAAC;QACD,MAAM,GAAG,GAAgB,IAAI,GAAG,EAAE,CAAC;QACnC,MAAM,MAAM,GAAqB,GAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACpE,MAAM,KAAK,GAAW,SAAS,KAAK,GAAG,CAAC,EAAE,CAAC;YAC3C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnB,MAAM,UAAU,CAAC,GAAG,KAAK,qBAAqB,CAAC,CAAC;YACpD,CAAC;YACD,MAAM,KAAK,GAAY,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC;YACtG,MAAM,EAAE,GAAW,KAAK,CAAC,CAAC,CAAE,KAAK,CAAC,EAAa,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;YACtE,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBACd,MAAM,UAAU,CAAC,GAAG,KAAK,yBAAyB,CAAC,CAAC;YACxD,CAAC;YACD,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACZ,MAAM,IAAI,GAAY,KAAK,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC;YACnD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAiB,CAAC,EAAE,CAAC;gBACxD,MAAM,UAAU,CAAC,GAAG,KAAK,oCAAoC,CAAC,CAAC;YACnE,CAAC;YACD,MAAM,WAAW,GAAY,KAAK,CAAC,WAAW,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACpH,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,WAAW,GAAG,CAAC,IAAI,WAAW,GAAG,GAAG,EAAE,CAAC;gBAC5G,MAAM,UAAU,CAAC,GAAG,KAAK,sDAAsD,CAAC,CAAC;YACrF,CAAC;YACD,MAAM,WAAW,GAAY,KAAK,CAAC,WAAW,CAAC;YAC/C,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,IAAI,CAAC,OAAO,WAAW,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,WAAW,GAAG,CAAC,IAAI,WAAW,GAAG,GAAG,CAAC,EAAE,CAAC;gBACnK,MAAM,UAAU,CAAC,GAAG,KAAK,uDAAuD,CAAC,CAAC;YACtF,CAAC;YACD,OAAO;gBACH,EAAE;gBACF,IAAI,EAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,CAAE;gBAC5D,WAAW;gBACX,IAAI,EAAE,IAAiB;gBACvB,GAAG,CAAC,OAAO,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC9D,CAAC;QACN,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YAClH,MAAM,UAAU,CAAC,gDAAgD,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACzD,MAAM,UAAU,CAAC,2CAA2C,CAAC,CAAC;QAClE,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,iDAAiD;IAC9B,KAAK,CAAC,UAAU,CAAC,MAAgB;QAChD,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,GAAwB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACvD,KAAK,MAAM,KAAK,IAAI,MAAM,IAAI,CAAC,IAAI,CAC/B,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,SAAS,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAC9F,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,CAC7D,EAAE,CAAC;YACA,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBAC3B,MAAM,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC;YAChI,CAAC;QACL,CAAC;IACL,CAAC;IAEkB,KAAK,CAAC,YAAY,CAAC,MAAgB;QAClD,MAAM,KAAK,GAAW,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAO,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACzJ,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACZ,MAAM,UAAU,CAAC,0BAA0B,KAAK,oCAAoC,CAAC,CAAC;QAC1F,CAAC;QACD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,UAAU,CAAC,6DAA6D,CAAC,CAAC;QACpF,CAAC;IACL,CAAC;IAED,iFAAiF;IACjE,KAAK,CAAC,IAAI,CAAC,YAAoB,EAAE,KAA0C,EAAE,IAAc;QACvG,MAAM,SAAS,GAAe,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YAC5E,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAa,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CACzD,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,EACpG,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CACtC,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IACjD,CAAC;CACJ"}

package/dist/lib/routes/BasePropertyDefinitionRoute.js

@@ -0,0 +1,140 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils } from "@rapidrest/service-core";
+import { COMPANY_FIELDS, CONTACT_FIELDS } from "../filters/fields.js";
+import { CrmObjectType, PropertyType, WorkspaceAction } from "../models/types.js";
+import { TAGS_KEY } from "../util/PropertyValues.js";
+import { MAX_LONG_TEXT, badRequest, conflict, readEnum, readText } from "../util/Validation.js";
+import { BaseWorkspaceRecordRoute } from "./BaseWorkspaceRecordRoute.js";
+/** A property key: a lowercase letter, then lowercase letters, digits and underscores. */
+const KEY_PATTERN = /^[a-z][a-z0-9_]{0,63}$/;
+/** How many options a select property may have, and how long one may be. */
+export const MAX_OPTIONS = 200;
+export const MAX_OPTION_LENGTH = 100;
+/** How many custom properties one workspace may define. */
+export const MAX_PROPERTY_DEFINITIONS = 500;
+/** Keys a custom property may never have: the record's own fields and the names the API uses around them. */
+const RESERVED_KEYS = new Set([
+    ...Object.keys(CONTACT_FIELDS),
+    ...Object.keys(COMPANY_FIELDS),
+    TAGS_KEY,
+    "lists",
+    "segments",
+    "company",
+    "uid",
+    "version",
+    "properties",
+    "workspaceuid",
+]);
+/**
+ * A workspace's custom properties (`/api/mail/crm/properties`) - see `BaseWorkspaceRecordRoute` for the endpoints. Defining them takes
+ * `MANAGE` (a workspace admin). A property's `objectType`, `key` and `type` are fixed once created; its label, options, group and
+ * description can change. Deleting one deletes every value of it.
+ */
+export class BasePropertyDefinitionRoute extends BaseWorkspaceRecordRoute {
+    constructor() {
+        super(...arguments);
+        this.model = "propertyDefinition";
+        this.pushType = "CrmPropertyDefinition";
+        this.writeAction = WorkspaceAction.MANAGE;
+        this.maxRecords = MAX_PROPERTY_DEFINITIONS;
+    }
+    async readCreate(body, context) {
+        const objectType = readEnum(body, "objectType", Object.values(CrmObjectType), { required: true });
+        const key = body.key;
+        if (typeof key !== "string" || !KEY_PATTERN.test(key) || RESERVED_KEYS.has(key.toLowerCase())) {
+            throw badRequest("'key' must be lowercase letters, digits and underscores starting with a letter, and not a built-in field.");
+        }
+        const type = readEnum(body, "type", Object.values(PropertyType), { required: true });
+        const existing = await (await this.records()).find({ workspaceUid: ModelUtils.literal(context.workspaceUid), objectType: ModelUtils.literal(objectType), key: ModelUtils.literal(key) }, { ignoreACL: true, limit: 1, skipCache: true });
+        if (existing.length > 0) {
+            throw conflict(`There is already a ${objectType} property '${key}'.`);
+        }
+        return {
+            objectType,
+            key,
+            type,
+            label: readText(body, "label", { required: true }),
+            options: this.readOptions(body, type, true) ?? [],
+            group: readText(body, "group") ?? undefined,
+            description: readText(body, "description", { max: MAX_LONG_TEXT }) ?? undefined,
+        };
+    }
+    async readUpdate(body, existing) {
+        for (const field of ["objectType", "key", "type"]) {
+            if (body[field] !== undefined && body[field] !== existing[field]) {
+                throw badRequest(`A property's '${field}' can't change.`);
+            }
+        }
+        const fields = {};
+        const label = readText(body, "label");
+        if (label === null) {
+            throw badRequest("'label' is required.");
+        }
+        if (label !== undefined) {
+            fields.label = label;
+        }
+        const options = this.readOptions(body, existing.type, false);
+        if (options !== undefined) {
+            fields.options = options;
+        }
+        for (const [field, max] of [
+            ["group", undefined],
+            ["description", MAX_LONG_TEXT],
+        ]) {
+            const value = readText(body, field, { max });
+            if (value !== undefined) {
+                fields[field] = value;
+            }
+        }
+        return fields;
+    }
+    /** The options of a select or multi-select property (required on create), each `{ value, label }` with unique values. */
+    readOptions(body, type, required) {
+        const isSelect = type === PropertyType.SELECT || type === PropertyType.MULTI_SELECT;
+        const raw = body.options;
+        if (raw === undefined) {
+            if (required && isSelect) {
+                throw badRequest("A select property needs 'options'.");
+            }
+            return undefined;
+        }
+        if (!isSelect) {
+            throw badRequest("Only a select or multi-select property has 'options'.");
+        }
+        if (!Array.isArray(raw) || raw.length === 0 || raw.length > MAX_OPTIONS) {
+            throw badRequest(`'options' must be a list of 1 to ${MAX_OPTIONS} options.`);
+        }
+        const options = [];
+        for (const entry of raw) {
+            const value = typeof entry === "string" ? entry : entry?.value;
+            const label = typeof entry === "string" ? entry : (entry?.label ?? entry?.value);
+            if (typeof value !== "string" ||
+                typeof label !== "string" ||
+                value.trim().length === 0 ||
+                value.length > MAX_OPTION_LENGTH ||
+                label.trim().length === 0 ||
+                label.length > MAX_OPTION_LENGTH) {
+                throw badRequest(`Each option must be { value, label } of 1 to ${MAX_OPTION_LENGTH} characters.`);
+            }
+            if (options.some((option) => option.value === value.trim())) {
+                throw badRequest(`The option '${value.trim()}' is listed twice.`);
+            }
+            options.push({ value: value.trim(), label: label.trim() });
+        }
+        return options;
+    }
+    async afterDelete(record, context) {
+        await (await this.repo("propertyValue")).truncate({
+            workspaceUid: ModelUtils.literal(context.workspaceUid),
+            objectType: ModelUtils.literal(record.objectType),
+            key: ModelUtils.literal(record.key),
+        }, { ignoreACL: true, skipPush: true });
+    }
+    listQuery(query) {
+        return Object.values(CrmObjectType).includes(query.objectType) ? { objectType: ModelUtils.literal(query.objectType) } : {};
+    }
+}
+//# sourceMappingURL=BasePropertyDefinitionRoute.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BasePropertyDefinitionRoute.js","sourceRoot":"","sources":["../../../src/routes/BasePropertyDefinitionRoute.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,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAAE,aAAa,EAAsC,YAAY,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACtH,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAChG,OAAO,EAAE,wBAAwB,EAAgB,MAAM,+BAA+B,CAAC;AAEvF,0FAA0F;AAC1F,MAAM,WAAW,GAAG,wBAAwB,CAAC;AAE7C,4EAA4E;AAC5E,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,CAAC;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC,2DAA2D;AAC3D,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAE5C,6GAA6G;AAC7G,MAAM,aAAa,GAAwB,IAAI,GAAG,CAAC;IAC/C,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;IAC9B,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC;IAC9B,QAAQ;IACR,OAAO;IACP,UAAU;IACV,SAAS;IACT,KAAK;IACL,SAAS;IACT,YAAY;IACZ,cAAc;CACjB,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,OAAgB,2BAA4B,SAAQ,wBAA4C;IAAtG;;QACuB,UAAK,GAAG,oBAA6B,CAAC;QACtC,aAAQ,GAAW,uBAAuB,CAAC;QAClC,gBAAW,GAAoB,eAAe,CAAC,MAAM,CAAC;QACtD,eAAU,GAAW,wBAAwB,CAAC;IA6G9E,CAAC;IA3Ga,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,OAAqB;QAC3E,MAAM,UAAU,GAAkB,QAAQ,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE,CAAC;QAClH,MAAM,GAAG,GAAY,IAAI,CAAC,GAAG,CAAC;QAC9B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC5F,MAAM,UAAU,CAAC,2GAA2G,CAAC,CAAC;QAClI,CAAC;QACD,MAAM,IAAI,GAAiB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE,CAAC;QACpG,MAAM,QAAQ,GAAyB,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,CACpE,EAAE,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,EACpI,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,sBAAsB,UAAU,cAAc,GAAG,IAAI,CAAC,CAAC;QAC1E,CAAC;QACD,OAAO;YACH,UAAU;YACV,GAAG;YACH,IAAI;YACJ,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAE;YACnD,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;YACjD,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,SAAS;YAC3C,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE,aAAa,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,CAAC,IAAI,SAAS;SAClF,CAAC;IACN,CAAC;IAES,KAAK,CAAC,UAAU,CAAC,IAA6B,EAAE,QAA4B;QAClF,KAAK,MAAM,KAAK,IAAI,CAAC,YAAY,EAAE,KAAK,EAAE,MAAM,CAAU,EAAE,CAAC;YACzD,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/D,MAAM,UAAU,CAAC,iBAAiB,KAAK,iBAAiB,CAAC,CAAC;YAC9D,CAAC;QACL,CAAC;QACD,MAAM,MAAM,GAAgC,EAAE,CAAC;QAC/C,MAAM,KAAK,GAA8B,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACjE,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,UAAU,CAAC,sBAAsB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,CAAC;QACD,MAAM,OAAO,GAAiC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QAC3F,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,CAAC;QACD,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI;YACvB,CAAC,OAAO,EAAE,SAAS,CAAC;YACpB,CAAC,aAAa,EAAE,aAAa,CAAC;SACxB,EAAE,CAAC;YACT,MAAM,KAAK,GAA8B,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YACxE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACrB,MAAc,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;YACnC,CAAC;QACL,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,yHAAyH;IACjH,WAAW,CAAC,IAA6B,EAAE,IAAkB,EAAE,QAAiB;QACpF,MAAM,QAAQ,GAAY,IAAI,KAAK,YAAY,CAAC,MAAM,IAAI,IAAI,KAAK,YAAY,CAAC,YAAY,CAAC;QAC7F,MAAM,GAAG,GAAY,IAAI,CAAC,OAAO,CAAC;QAClC,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YACpB,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAAC;gBACvB,MAAM,UAAU,CAAC,oCAAoC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,UAAU,CAAC,uDAAuD,CAAC,CAAC;QAC9E,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,WAAW,EAAE,CAAC;YACtE,MAAM,UAAU,CAAC,oCAAoC,WAAW,WAAW,CAAC,CAAC;QACjF,CAAC;QACD,MAAM,OAAO,GAAqB,EAAE,CAAC;QACrC,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;YACtB,MAAM,KAAK,GAAY,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC;YACxE,MAAM,KAAK,GAAY,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,IAAI,KAAK,EAAE,KAAK,CAAC,CAAC;YAC1F,IACI,OAAO,KAAK,KAAK,QAAQ;gBACzB,OAAO,KAAK,KAAK,QAAQ;gBACzB,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;gBACzB,KAAK,CAAC,MAAM,GAAG,iBAAiB;gBAChC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC;gBACzB,KAAK,CAAC,MAAM,GAAG,iBAAiB,EAClC,CAAC;gBACC,MAAM,UAAU,CAAC,gDAAgD,iBAAiB,cAAc,CAAC,CAAC;YACtG,CAAC;YACD,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC1D,MAAM,UAAU,CAAC,eAAe,KAAK,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;YACtE,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,OAAO,OAAO,CAAC;IACnB,CAAC;IAEkB,KAAK,CAAC,WAAW,CAAC,MAA0B,EAAE,OAAqB;QAClF,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAC7C;YACI,YAAY,EAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;YACtD,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC;YACjD,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;SACtC,EACD,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CACtC,CAAC;IACN,CAAC;IAEkB,SAAS,CAAC,KAA8B;QACvD,OAAO,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,UAA2B,CAAC,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAChJ,CAAC;CACJ"}