@rapidmx/crm-plugin 0.1.0

package/dist/lib/automation/Graph.js

@@ -0,0 +1,296 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { badRequest, isObject } from "../util/Validation.js";
+import { readDateTrigger } from "./Dates.js";
+import { CrmEventType } from "./Events.js";
+/** What an automation step does. */
+export var NodeType;
+(function (NodeType) {
+    NodeType["TRIGGER"] = "trigger";
+    NodeType["DELAY"] = "delay";
+    NodeType["WAIT"] = "wait";
+    NodeType["CONDITION"] = "condition";
+    NodeType["SPLIT"] = "split";
+    NodeType["SEND_EMAIL"] = "send_email";
+    NodeType["SET_FIELD"] = "set_field";
+    NodeType["ADD_TAG"] = "add_tag";
+    NodeType["REMOVE_TAG"] = "remove_tag";
+    NodeType["SUBSCRIBE"] = "subscribe";
+    NodeType["UNSUBSCRIBE"] = "unsubscribe";
+    NodeType["CREATE_TASK"] = "create_task";
+    NodeType["NOTIFY"] = "notify";
+    NodeType["ENROLL"] = "enroll";
+    NodeType["WEBHOOK"] = "webhook";
+    NodeType["EXIT"] = "exit";
+})(NodeType || (NodeType = {}));
+/** The events a trigger can start from. */
+export const TRIGGER_EVENTS = Object.values(CrmEventType);
+/** The events a wait can wait for: something done with a message an earlier step sent. */
+export const WAIT_EVENTS = [CrmEventType.EMAIL_OPENED, CrmEventType.EMAIL_CLICKED, CrmEventType.EMAIL_REPLIED];
+/** The contact fields a `set_field` step may set. */
+export const SETTABLE_FIELDS = ["lifecycleStage", "leadStatus", "ownerUserUid"];
+/** Units of time a delay or a wait's timeout counts in, in milliseconds. */
+export const TIME_UNITS = { minutes: 60000, hours: 3600000, days: 86400000 };
+/** The ports out of each node type. */
+export const PORTS = {
+    [NodeType.TRIGGER]: ["next"],
+    [NodeType.DELAY]: ["next"],
+    [NodeType.WAIT]: ["matched", "timeout"],
+    [NodeType.CONDITION]: ["yes", "no"],
+    [NodeType.SPLIT]: ["a", "b"],
+    [NodeType.SEND_EMAIL]: ["next"],
+    [NodeType.SET_FIELD]: ["next"],
+    [NodeType.ADD_TAG]: ["next"],
+    [NodeType.REMOVE_TAG]: ["next"],
+    [NodeType.SUBSCRIBE]: ["next"],
+    [NodeType.UNSUBSCRIBE]: ["next"],
+    [NodeType.CREATE_TASK]: ["next"],
+    [NodeType.NOTIFY]: ["next"],
+    [NodeType.ENROLL]: ["next"],
+    [NodeType.WEBHOOK]: ["next"],
+    [NodeType.EXIT]: [],
+};
+/** How big a graph may get. */
+export const MAX_NODES = 200;
+const MAX_CONFIG_BYTES = 64 * 1024;
+const ID = /^[A-Za-z0-9_-]{1,64}$/;
+/**
+ * `raw` as an automation graph, checked for shape only - node ids, types, edges between existing nodes on the ports their type has,
+ * one edge per port - so a half-built draft can be saved. `validateForPublish()` checks the rest.
+ */
+export function validateGraph(raw) {
+    if (!isObject(raw) || !Array.isArray(raw.nodes) || !Array.isArray(raw.edges)) {
+        throw badRequest("'graph' must be { nodes, edges }.");
+    }
+    if (raw.nodes.length > MAX_NODES || raw.edges.length > MAX_NODES * 2) {
+        throw badRequest(`An automation may have at most ${MAX_NODES} steps.`);
+    }
+    const nodes = [];
+    const ids = new Set();
+    for (const entry of raw.nodes) {
+        if (!isObject(entry) || typeof entry.id !== "string" || !ID.test(entry.id) || ids.has(entry.id)) {
+            throw badRequest("Each step needs a unique id of letters, digits, '-' or '_'.");
+        }
+        if (!Object.values(NodeType).includes(entry.type)) {
+            throw badRequest(`Step ${entry.id} has an unknown type.`);
+        }
+        const config = entry.config ?? {};
+        if (!isObject(config) || JSON.stringify(config).length > MAX_CONFIG_BYTES) {
+            throw badRequest(`Step ${entry.id}'s settings must be an object.`);
+        }
+        ids.add(entry.id);
+        nodes.push({ id: entry.id, type: entry.type, config });
+    }
+    const edges = [];
+    const used = new Set();
+    for (const entry of raw.edges) {
+        if (!isObject(entry) || typeof entry.from !== "string" || typeof entry.to !== "string" || !ids.has(entry.from) || !ids.has(entry.to)) {
+            throw badRequest("Each connection must join two steps of the automation.");
+        }
+        const from = nodes.find((node) => node.id === entry.from);
+        const port = typeof entry.port === "string" ? entry.port : "next";
+        if (!PORTS[from.type].includes(port) || used.has(`${entry.from}|${port}`)) {
+            throw badRequest(`Step ${entry.from} can't have that connection.`);
+        }
+        used.add(`${entry.from}|${port}`);
+        edges.push({ from: entry.from, to: entry.to, port });
+    }
+    return { nodes, edges };
+}
+/** The node `port` of `nodeId` leads to, if any. */
+export function nextNode(graph, nodeId, port = "next") {
+    return graph.edges.find((edge) => edge.from === nodeId && edge.port === port)?.to;
+}
+function text(config, field, where, max = 256) {
+    const value = config[field];
+    if (typeof value !== "string" || value.trim() === "" || value.length > max) {
+        throw badRequest(`${where}: '${field}' is required.`);
+    }
+    return value;
+}
+function positive(config, field, where, max) {
+    const value = config[field];
+    if (typeof value !== "number" || !Number.isInteger(value) || value < 1 || value > max) {
+        throw badRequest(`${where}: '${field}' must be a whole number from 1 to ${max}.`);
+    }
+    return value;
+}
+function unit(config, field, where) {
+    if (typeof config[field] !== "string" || !(String(config[field]) in TIME_UNITS)) {
+        throw badRequest(`${where}: '${field}' must be minutes, hours or days.`);
+    }
+}
+/**
+ * Checks that `graph` can be published: one trigger that nothing leads back to, every step reachable from it, every step's settings
+ * complete, every wait waiting on a message an earlier step sends, and no loop that doesn't pass a delay or a wait (a contact would
+ * spin through it). Returns what the settings refer to, for the caller to check.
+ */
+export function validateForPublish(graph) {
+    const triggers = graph.nodes.filter((node) => node.type === NodeType.TRIGGER);
+    if (triggers.length !== 1) {
+        throw badRequest("An automation needs exactly one trigger.");
+    }
+    const trigger = triggers[0];
+    if (graph.edges.some((edge) => edge.to === trigger.id)) {
+        throw badRequest("Nothing can lead back to the trigger.");
+    }
+    const reachable = new Set([trigger.id]);
+    const queue = [trigger.id];
+    while (queue.length > 0) {
+        const current = queue.shift();
+        for (const edge of graph.edges.filter((entry) => entry.from === current && !reachable.has(entry.to))) {
+            reachable.add(edge.to);
+            queue.push(edge.to);
+        }
+    }
+    const orphan = graph.nodes.find((node) => !reachable.has(node.id));
+    if (orphan) {
+        throw badRequest(`Step ${orphan.id} can't be reached from the trigger.`);
+    }
+    if (!nextNode(graph, trigger.id)) {
+        throw badRequest("The trigger must lead somewhere.");
+    }
+    checkLoops(graph);
+    const references = { templates: new Set(), senders: new Set(), lists: new Set(), forms: new Set(), segments: new Set(), automations: new Set(), members: new Set(), pipelines: new Set(), webhooks: new Set(), dateProperties: new Set(), filters: [] };
+    for (const node of graph.nodes) {
+        const where = `Step ${node.id}`;
+        const config = node.config;
+        switch (node.type) {
+            case NodeType.TRIGGER: {
+                if (!TRIGGER_EVENTS.includes(config.event)) {
+                    throw badRequest(`${where}: choose what starts the automation.`);
+                }
+                for (const [field, set] of [
+                    ["listUid", references.lists],
+                    ["formUid", references.forms],
+                    ["segmentUid", references.segments],
+                    ["pipelineUid", references.pipelines],
+                ]) {
+                    if (config[field] !== undefined && config[field] !== null && config[field] !== "") {
+                        set.add(text(config, field, where, 64));
+                    }
+                }
+                if (config.event === CrmEventType.DATE_REACHED) {
+                    const { field } = readDateTrigger(config, where);
+                    if (field.startsWith("properties.")) {
+                        references.dateProperties.add(field.slice("properties.".length));
+                    }
+                }
+                if (config.filter !== undefined && config.filter !== null) {
+                    references.filters.push(config.filter);
+                }
+                break;
+            }
+            case NodeType.DELAY:
+                positive(config, "amount", where, 365);
+                unit(config, "unit", where);
+                break;
+            case NodeType.WAIT: {
+                if (!WAIT_EVENTS.includes(config.event)) {
+                    throw badRequest(`${where}: choose what to wait for.`);
+                }
+                const sendNodeId = text(config, "sendNodeId", where, 64);
+                const send = graph.nodes.find((entry) => entry.id === sendNodeId);
+                if (send?.type !== NodeType.SEND_EMAIL || !ancestors(graph, node.id).has(sendNodeId)) {
+                    throw badRequest(`${where}: it must wait on an email sent by an earlier step.`);
+                }
+                positive(config, "timeoutAmount", where, 365);
+                unit(config, "timeoutUnit", where);
+                break;
+            }
+            case NodeType.CONDITION:
+                if (config.filter === undefined || config.filter === null) {
+                    throw badRequest(`${where}: add the conditions to check.`);
+                }
+                references.filters.push(config.filter);
+                break;
+            case NodeType.SPLIT:
+                positive(config, "percent", where, 99);
+                break;
+            case NodeType.SEND_EMAIL:
+                references.templates.add(text(config, "templateUid", where, 64));
+                references.senders.add(text(config, "senderUid", where, 64));
+                if (config.subject !== undefined && config.subject !== null && config.subject !== "") {
+                    text(config, "subject", where, 998);
+                }
+                break;
+            case NodeType.SET_FIELD:
+                if (!SETTABLE_FIELDS.includes(config.field)) {
+                    throw badRequest(`${where}: choose the field to set.`);
+                }
+                if (config.value !== null && typeof config.value !== "string") {
+                    throw badRequest(`${where}: 'value' must be text, or null to clear the field.`);
+                }
+                break;
+            case NodeType.ADD_TAG:
+            case NodeType.REMOVE_TAG:
+                text(config, "tag", where, 64);
+                break;
+            case NodeType.SUBSCRIBE:
+            case NodeType.UNSUBSCRIBE:
+                references.lists.add(text(config, "listUid", where, 64));
+                break;
+            case NodeType.CREATE_TASK:
+                text(config, "title", where, 256);
+                if (config.dueInDays !== undefined && config.dueInDays !== null) {
+                    positive(config, "dueInDays", where, 365);
+                }
+                if (config.assigneeUserUid) {
+                    references.members.add(text(config, "assigneeUserUid", where, 64));
+                }
+                break;
+            case NodeType.NOTIFY:
+                references.members.add(text(config, "userUid", where, 64));
+                text(config, "message", where, 1000);
+                break;
+            case NodeType.ENROLL:
+                references.automations.add(text(config, "automationUid", where, 64));
+                break;
+            case NodeType.WEBHOOK:
+                references.webhooks.add(text(config, "endpointUid", where, 64));
+                break;
+            default:
+                // EXIT has nothing to set.
+                break;
+        }
+    }
+    return references;
+}
+/** Every node from which `nodeId` can be reached. */
+function ancestors(graph, nodeId) {
+    const found = new Set();
+    const queue = [nodeId];
+    while (queue.length > 0) {
+        const current = queue.shift();
+        for (const edge of graph.edges.filter((entry) => entry.to === current && !found.has(entry.from))) {
+            found.add(edge.from);
+            queue.push(edge.from);
+        }
+    }
+    return found;
+}
+/** Refuses a loop with no delay or wait on it: with those taken out, the graph must have no cycle. */
+function checkLoops(graph) {
+    const pausing = new Set(graph.nodes.filter((node) => node.type === NodeType.DELAY || node.type === NodeType.WAIT).map((node) => node.id));
+    const state = new Map();
+    const visit = (nodeId) => {
+        state.set(nodeId, "visiting");
+        for (const edge of graph.edges.filter((entry) => entry.from === nodeId && !pausing.has(entry.to))) {
+            if (state.get(edge.to) === "visiting") {
+                throw badRequest(`Steps ${edge.from} and ${edge.to} loop without a delay or a wait.`);
+            }
+            if (!state.has(edge.to)) {
+                visit(edge.to);
+            }
+        }
+        state.set(nodeId, "done");
+    };
+    for (const node of graph.nodes) {
+        if (!pausing.has(node.id) && !state.has(node.id)) {
+            visit(node.id);
+        }
+    }
+}
+//# sourceMappingURL=Graph.js.map

package/dist/lib/automation/Graph.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Graph.js","sourceRoot":"","sources":["../../../src/automation/Graph.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,mEAAmE;AACnE,mCAAmC;AACnC,+EAA+E;AAC/E,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C,oCAAoC;AACpC,MAAM,CAAN,IAAY,QAiBX;AAjBD,WAAY,QAAQ;IAChB,+BAAmB,CAAA;IACnB,2BAAe,CAAA;IACf,yBAAa,CAAA;IACb,mCAAuB,CAAA;IACvB,2BAAe,CAAA;IACf,qCAAyB,CAAA;IACzB,mCAAuB,CAAA;IACvB,+BAAmB,CAAA;IACnB,qCAAyB,CAAA;IACzB,mCAAuB,CAAA;IACvB,uCAA2B,CAAA;IAC3B,uCAA2B,CAAA;IAC3B,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;IACjB,+BAAmB,CAAA;IACnB,yBAAa,CAAA;AACjB,CAAC,EAjBW,QAAQ,KAAR,QAAQ,QAiBnB;AAqBD,2CAA2C;AAC3C,MAAM,CAAC,MAAM,cAAc,GAA4B,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;AAEnF,0FAA0F;AAC1F,MAAM,CAAC,MAAM,WAAW,GAA4B,CAAC,YAAY,CAAC,YAAY,EAAE,YAAY,CAAC,aAAa,EAAE,YAAY,CAAC,aAAa,CAAC,CAAC;AAExI,qDAAqD;AACrD,MAAM,CAAC,MAAM,eAAe,GAAsB,CAAC,gBAAgB,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;AAEnG,4EAA4E;AAC5E,MAAM,CAAC,MAAM,UAAU,GAAqC,EAAE,OAAO,EAAE,KAAM,EAAE,KAAK,EAAE,OAAS,EAAE,IAAI,EAAE,QAAU,EAAE,CAAC;AAEpH,uCAAuC;AACvC,MAAM,CAAC,MAAM,KAAK,GAAkD;IAChE,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAC5B,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC;IAC1B,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;IACvC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;IACnC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;IAC5B,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC;IAC/B,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC;IAC9B,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAC5B,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC;IAC/B,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC;IAC9B,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC;IAChC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,MAAM,CAAC;IAChC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC;IAC3B,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC;IAC3B,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC;IAC5B,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE;CACtB,CAAC;AAEF,+BAA+B;AAC/B,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAC;AAC7B,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,CAAC;AACnC,MAAM,EAAE,GAAG,uBAAuB,CAAC;AAEnC;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,GAAY;IACtC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;QAC3E,MAAM,UAAU,CAAC,mCAAmC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,SAAS,GAAG,CAAC,EAAE,CAAC;QACnE,MAAM,UAAU,CAAC,kCAAkC,SAAS,SAAS,CAAC,CAAC;IAC3E,CAAC;IACD,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,MAAM,GAAG,GAAgB,IAAI,GAAG,EAAE,CAAC;IACnC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,KAAkB,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YAC9F,MAAM,UAAU,CAAC,6DAA6D,CAAC,CAAC;QACpF,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAgB,CAAC,EAAE,CAAC;YAC5D,MAAM,UAAU,CAAC,QAAQ,KAAK,CAAC,EAAE,uBAAuB,CAAC,CAAC;QAC9D,CAAC;QACD,MAAM,MAAM,GAAY,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;YACxE,MAAM,UAAU,CAAC,QAAQ,KAAK,CAAC,EAAE,gCAAgC,CAAC,CAAC;QACvE,CAAC;QACD,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAgB,EAAE,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC;IACD,MAAM,KAAK,GAAqB,EAAE,CAAC;IACnC,MAAM,IAAI,GAAgB,IAAI,GAAG,EAAE,CAAC;IACpC,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,KAAkB,EAAE,CAAC;QACzC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YACnI,MAAM,UAAU,CAAC,wDAAwD,CAAC,CAAC;QAC/E,CAAC;QACD,MAAM,IAAI,GAAmB,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,KAAK,CAAC,IAAI,CAAE,CAAC;QAC3E,MAAM,IAAI,GAAW,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;QAC1E,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;YACxE,MAAM,UAAU,CAAC,QAAQ,KAAK,CAAC,IAAI,8BAA8B,CAAC,CAAC;QACvE,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACzD,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,QAAQ,CAAC,KAAsB,EAAE,MAAc,EAAE,OAAe,MAAM;IAClF,OAAO,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,EAAE,CAAC;AACtF,CAAC;AAmBD,SAAS,IAAI,CAAC,MAA+B,EAAE,KAAa,EAAE,KAAa,EAAE,MAAc,GAAG;IAC1F,MAAM,KAAK,GAAY,MAAM,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;QACzE,MAAM,UAAU,CAAC,GAAG,KAAK,MAAM,KAAK,gBAAgB,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,QAAQ,CAAC,MAA+B,EAAE,KAAa,EAAE,KAAa,EAAE,GAAW;IACxF,MAAM,KAAK,GAAY,MAAM,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACpF,MAAM,UAAU,CAAC,GAAG,KAAK,MAAM,KAAK,sCAAsC,GAAG,GAAG,CAAC,CAAC;IACtF,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,SAAS,IAAI,CAAC,MAA+B,EAAE,KAAa,EAAE,KAAa;IACvE,IAAI,OAAO,MAAM,CAAC,KAAK,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC;QAC9E,MAAM,UAAU,CAAC,GAAG,KAAK,MAAM,KAAK,mCAAmC,CAAC,CAAC;IAC7E,CAAC;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAsB;IACrD,MAAM,QAAQ,GAAqB,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,OAAO,CAAC,CAAC;IAChG,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,UAAU,CAAC,0CAA0C,CAAC,CAAC;IACjE,CAAC;IACD,MAAM,OAAO,GAAmB,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5C,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QACrD,MAAM,UAAU,CAAC,uCAAuC,CAAC,CAAC;IAC9D,CAAC;IACD,MAAM,SAAS,GAAgB,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;IACrD,MAAM,KAAK,GAAa,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,OAAO,GAAW,KAAK,CAAC,KAAK,EAAG,CAAC;QACvC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YACnG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxB,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAA+B,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/F,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,UAAU,CAAC,QAAQ,MAAM,CAAC,EAAE,qCAAqC,CAAC,CAAC;IAC7E,CAAC;IACD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;QAC/B,MAAM,UAAU,CAAC,kCAAkC,CAAC,CAAC;IACzD,CAAC;IACD,UAAU,CAAC,KAAK,CAAC,CAAC;IAElB,MAAM,UAAU,GAAoB,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,KAAK,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,WAAW,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,EAAE,IAAI,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,GAAG,EAAE,EAAE,QAAQ,EAAE,IAAI,GAAG,EAAE,EAAE,cAAc,EAAE,IAAI,GAAG,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC;IACzQ,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC7B,MAAM,KAAK,GAAW,QAAQ,IAAI,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,MAAM,GAA4B,IAAI,CAAC,MAAM,CAAC;QACpD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YAChB,KAAK,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpB,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAqB,CAAC,EAAE,CAAC;oBACzD,MAAM,UAAU,CAAC,GAAG,KAAK,sCAAsC,CAAC,CAAC;gBACrE,CAAC;gBACD,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI;oBACvB,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC;oBAC7B,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC;oBAC7B,CAAC,YAAY,EAAE,UAAU,CAAC,QAAQ,CAAC;oBACnC,CAAC,aAAa,EAAE,UAAU,CAAC,SAAS,CAAC;iBAC/B,EAAE,CAAC;oBACT,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC;wBAChF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC5C,CAAC;gBACL,CAAC;gBACD,IAAI,MAAM,CAAC,KAAK,KAAK,YAAY,CAAC,YAAY,EAAE,CAAC;oBAC7C,MAAM,EAAE,KAAK,EAAE,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oBACjD,IAAI,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,EAAE,CAAC;wBAClC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;oBACrE,CAAC;gBACL,CAAC;gBACD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;oBACxD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBAC3C,CAAC;gBACD,MAAM;YACV,CAAC;YACD,KAAK,QAAQ,CAAC,KAAK;gBACf,QAAQ,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBACvC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;gBAC5B,MAAM;YACV,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjB,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAqB,CAAC,EAAE,CAAC;oBACtD,MAAM,UAAU,CAAC,GAAG,KAAK,4BAA4B,CAAC,CAAC;gBAC3D,CAAC;gBACD,MAAM,UAAU,GAAW,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBACjE,MAAM,IAAI,GAA+B,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,UAAU,CAAC,CAAC;gBAC9F,IAAI,IAAI,EAAE,IAAI,KAAK,QAAQ,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;oBACnF,MAAM,UAAU,CAAC,GAAG,KAAK,qDAAqD,CAAC,CAAC;gBACpF,CAAC;gBACD,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAC9C,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,CAAC,CAAC;gBACnC,MAAM;YACV,CAAC;YACD,KAAK,QAAQ,CAAC,SAAS;gBACnB,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;oBACxD,MAAM,UAAU,CAAC,GAAG,KAAK,gCAAgC,CAAC,CAAC;gBAC/D,CAAC;gBACD,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;gBACvC,MAAM;YACV,KAAK,QAAQ,CAAC,KAAK;gBACf,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBACvC,MAAM;YACV,KAAK,QAAQ,CAAC,UAAU;gBACpB,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBACjE,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC7D,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,KAAK,IAAI,IAAI,MAAM,CAAC,OAAO,KAAK,EAAE,EAAE,CAAC;oBACnF,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBACxC,CAAC;gBACD,MAAM;YACV,KAAK,QAAQ,CAAC,SAAS;gBACnB,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAe,CAAC,EAAE,CAAC;oBACpD,MAAM,UAAU,CAAC,GAAG,KAAK,4BAA4B,CAAC,CAAC;gBAC3D,CAAC;gBACD,IAAI,MAAM,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBAC5D,MAAM,UAAU,CAAC,GAAG,KAAK,qDAAqD,CAAC,CAAC;gBACpF,CAAC;gBACD,MAAM;YACV,KAAK,QAAQ,CAAC,OAAO,CAAC;YACtB,KAAK,QAAQ,CAAC,UAAU;gBACpB,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC/B,MAAM;YACV,KAAK,QAAQ,CAAC,SAAS,CAAC;YACxB,KAAK,QAAQ,CAAC,WAAW;gBACrB,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBACzD,MAAM;YACV,KAAK,QAAQ,CAAC,WAAW;gBACrB,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAClC,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;oBAC9D,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;gBAC9C,CAAC;gBACD,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;oBACzB,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBACvE,CAAC;gBACD,MAAM;YACV,KAAK,QAAQ,CAAC,MAAM;gBAChB,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBAC3D,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;gBACrC,MAAM;YACV,KAAK,QAAQ,CAAC,MAAM;gBAChB,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBACrE,MAAM;YACV,KAAK,QAAQ,CAAC,OAAO;gBACjB,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;gBAChE,MAAM;YACV;gBACI,2BAA2B;gBAC3B,MAAM;QACd,CAAC;IACL,CAAC;IACD,OAAO,UAAU,CAAC;AACtB,CAAC;AAED,qDAAqD;AACrD,SAAS,SAAS,CAAC,KAAsB,EAAE,MAAc;IACrD,MAAM,KAAK,GAAgB,IAAI,GAAG,EAAE,CAAC;IACrC,MAAM,KAAK,GAAa,CAAC,MAAM,CAAC,CAAC;IACjC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,OAAO,GAAW,KAAK,CAAC,KAAK,EAAG,CAAC;QACvC,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAC/F,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,sGAAsG;AACtG,SAAS,UAAU,CAAC,KAAsB;IACtC,MAAM,OAAO,GAAgB,IAAI,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACvJ,MAAM,KAAK,GAAqC,IAAI,GAAG,EAAE,CAAC;IAC1D,MAAM,KAAK,GAAG,CAAC,MAAc,EAAQ,EAAE;QACnC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;YAChG,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,UAAU,EAAE,CAAC;gBACpC,MAAM,UAAU,CAAC,SAAS,IAAI,CAAC,IAAI,QAAQ,IAAI,CAAC,EAAE,kCAAkC,CAAC,CAAC;YAC1F,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;gBACtB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnB,CAAC;QACL,CAAC;QACD,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9B,CAAC,CAAC;IACF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;YAC/C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnB,CAAC;IACL,CAAC;AACL,CAAC"}

package/dist/lib/filters/Filter.js

@@ -0,0 +1,343 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2026 Jean-Philippe Steinmetz. All rights reserved.
+// SPDX-License-Identifier: MPL-2.0
+///////////////////////////////////////////////////////////////////////////////
+import { ModelUtils } from "@rapidrest/service-core";
+import { CrmObjectType, PropertyType } from "../models/types.js";
+import { badRequest, isObject, parseDate } from "../util/Validation.js";
+/** How deep groups may nest, and how many conditions and groups one filter may have. */
+export const MAX_FILTER_DEPTH = 5;
+export const MAX_FILTER_NODES = 50;
+/** How many values an `in`/`notIn` list may have. */
+export const MAX_FILTER_LIST = 200;
+/** How many records a condition on a custom property or tag may match before the filter is refused as too broad. */
+export const MAX_VALUE_MATCHES = 20000;
+const OPS = [
+    "eq",
+    "ne",
+    "contains",
+    "notContains",
+    "startsWith",
+    "gt",
+    "gte",
+    "lt",
+    "lte",
+    "between",
+    "in",
+    "notIn",
+    "isSet",
+    "isNotSet",
+];
+/** Which comparisons each value type allows. */
+const OPS_BY_TYPE = {
+    "string": ["eq", "ne", "contains", "notContains", "startsWith", "in", "notIn", "isSet", "isNotSet"],
+    "number": ["eq", "ne", "gt", "gte", "lt", "lte", "between", "in", "notIn", "isSet", "isNotSet"],
+    date: ["gt", "gte", "lt", "lte", "between", "isSet", "isNotSet"],
+    "boolean": ["eq", "ne", "isSet", "isNotSet"],
+};
+/** The comparisons allowed on a multi-valued field. */
+const MULTI_OPS = ["eq", "ne", "in", "notIn", "isSet", "isNotSet"];
+/** The comparisons that match what the positive form of the same comparison doesn't. */
+const NEGATED = { ne: "eq", notIn: "in", notContains: "contains", isNotSet: "isSet" };
+/** The `PropertyValue` column a value of `type` is stored in. */
+export function valueColumn(type) {
+    return type === "date" ? "dateValue" : type === "string" ? "stringValue" : "numberValue";
+}
+/** The filter value type a custom property's values are compared as. */
+export function propertyValueType(type) {
+    switch (type) {
+        case PropertyType.NUMBER:
+            return "number";
+        case PropertyType.DATE:
+            return "date";
+        case PropertyType.BOOLEAN:
+            return "boolean";
+        default:
+            return "string";
+    }
+}
+/**
+ * Every field a filter on `objectType` records may name: the record's own `fields`, `tags`, `lists` and `segments` for contacts (the
+ * uids of the lists they are subscribed to and the segments they are in), and `properties.<key>` for each of the workspace's custom property `definitions` of that type.
+ */
+export function filterFields(fields, definitions, objectType) {
+    const result = { ...fields, tags: { type: "string", stored: "values", multi: true, key: "tags" } };
+    if (objectType === CrmObjectType.CONTACT) {
+        result.lists = { type: "string", stored: "values", multi: true, key: "lists" };
+        result.segments = { type: "string", stored: "values", multi: true, key: "segments" };
+    }
+    for (const definition of definitions) {
+        if (definition.objectType !== objectType) {
+            continue;
+        }
+        result[`properties.${definition.key}`] = {
+            type: propertyValueType(definition.type),
+            stored: "values",
+            multi: definition.type === PropertyType.MULTI_SELECT,
+            key: definition.key,
+            options: definition.type === PropertyType.SELECT || definition.type === PropertyType.MULTI_SELECT
+                ? definition.options.map((option) => option.value)
+                : undefined,
+        };
+    }
+    return result;
+}
+/** One value of `field`'s type, or a 400 naming `where`. */
+function coerceValue(field, raw, where) {
+    switch (field.type) {
+        case "number":
+            if (typeof raw === "number" && Number.isFinite(raw)) {
+                return raw;
+            }
+            throw badRequest(`${where} needs a number.`);
+        case "date": {
+            const date = parseDate(raw);
+            if (date) {
+                return date;
+            }
+            throw badRequest(`${where} needs a date.`);
+        }
+        case "boolean":
+            if (typeof raw === "boolean") {
+                return raw;
+            }
+            throw badRequest(`${where} needs true or false.`);
+        default: {
+            if (typeof raw !== "string" || raw.length === 0 || raw.length > 256) {
+                throw badRequest(`${where} needs text of 1 to 256 characters.`);
+            }
+            // Tags are stored lowercase; other text is compared as stored, and text matches ignore case anyway.
+            const value = field.key === "tags" ? raw.trim().toLowerCase() : raw;
+            if (field.options && !field.options.includes(value)) {
+                throw badRequest(`${where} must be one of: ${field.options.join(", ")}.`);
+            }
+            return value;
+        }
+    }
+}
+/**
+ * Checks `node` against `fields` and returns it normalized: every condition's value coerced to its field's type (dates as `Date`s,
+ * tags lowercased), and nothing but `field`/`op`/`value` and `and`/`or` kept. A malformed filter, an unknown field, a comparison
+ * the field's type doesn't allow, or one that's too big is a 400.
+ */
+export function validateFilter(node, fields) {
+    let count = 0;
+    const visit = (current, depth) => {
+        if (++count > MAX_FILTER_NODES) {
+            throw badRequest(`A filter may have at most ${MAX_FILTER_NODES} conditions and groups.`);
+        }
+        if (!isObject(current)) {
+            throw badRequest("Each part of a filter must be an object.");
+        }
+        if ("and" in current || "or" in current) {
+            const op = "and" in current ? "and" : "or";
+            const children = current[op];
+            if (("and" in current && "or" in current) || !Array.isArray(children) || children.length === 0) {
+                throw badRequest("A filter group must have a non-empty 'and' or 'or' list, and not both.");
+            }
+            if (depth >= MAX_FILTER_DEPTH) {
+                throw badRequest(`Filter groups may nest at most ${MAX_FILTER_DEPTH} deep.`);
+            }
+            return { [op]: children.map((child) => visit(child, depth + 1)) };
+        }
+        const fieldName = current.field;
+        const op = current.op;
+        if (typeof fieldName !== "string" || !Object.prototype.hasOwnProperty.call(fields, fieldName)) {
+            throw badRequest(`A filter names an unknown field: ${JSON.stringify(fieldName)}.`);
+        }
+        const field = fields[fieldName];
+        const where = `The '${fieldName}' filter`;
+        if (typeof op !== "string" || !OPS.includes(op)) {
+            throw badRequest(`${where} has an unknown comparison: ${JSON.stringify(op)}.`);
+        }
+        const allowed = field.multi ? MULTI_OPS : OPS_BY_TYPE[field.type];
+        if (!allowed.includes(op)) {
+            throw badRequest(`${where} can't use '${op}'; it can use: ${allowed.join(", ")}.`);
+        }
+        const condition = { field: fieldName, op: op };
+        if (op === "isSet" || op === "isNotSet") {
+            return condition;
+        }
+        if (op === "in" || op === "notIn" || op === "between") {
+            const list = current.value;
+            if (!Array.isArray(list) || list.length === 0 || list.length > MAX_FILTER_LIST || (op === "between" && list.length !== 2)) {
+                throw badRequest(op === "between" ? `${where} needs [low, high].` : `${where} needs a list of 1 to ${MAX_FILTER_LIST} values.`);
+            }
+            condition.value = list.map((entry) => coerceValue(field, entry, where));
+            return condition;
+        }
+        condition.value = coerceValue(field, current.value, where);
+        return condition;
+    };
+    return visit(node, 0);
+}
+/** A glob-safe copy of `text` for a `like()` match: `*` and `?` (the glob wildcards) and parentheses removed. */
+function globText(text) {
+    return text.replace(/[*?()]/g, "");
+}
+/** The query value for one comparison against a column, in `ModelUtils.buildSearchQuery()`'s form. */
+function columnPredicate(op, value) {
+    switch (op) {
+        case "eq":
+            return ModelUtils.literal(value);
+        case "ne":
+            return ModelUtils.literal(value, "ne");
+        case "gt":
+        case "gte":
+        case "lt":
+        case "lte":
+            return ModelUtils.literal(value, op);
+        case "between":
+            return ModelUtils.literal(value, "range");
+        case "in":
+            return ModelUtils.literal(value, "in");
+        case "notIn":
+            return ModelUtils.literal(value, "nin");
+        case "contains":
+            return `like(*${globText(String(value))}*)`;
+        case "startsWith":
+            return `like(${globText(String(value))}*)`;
+        case "isSet":
+            return ModelUtils.literal(null, "ne");
+        default:
+            // isNotSet
+            return ModelUtils.literal(null);
+    }
+}
+/** A value no record's `uid` can have, for a condition that matches no record. */
+const NO_UID = "~none~";
+/** The uids of every record of the context's workspace matching `query` on `repo`, by `field`, or a 400 when there are too many. */
+async function matchingUids(repo, query, field) {
+    const uids = new Set();
+    for (let page = 0;; page++) {
+        const rows = await repo.find(query, { ignoreACL: true, limit: 1000, page, skipCache: true });
+        for (const row of rows) {
+            uids.add(row[field]);
+        }
+        if (uids.size > MAX_VALUE_MATCHES) {
+            throw badRequest(`A filter condition matches more than ${MAX_VALUE_MATCHES} records; narrow it down.`);
+        }
+        if (rows.length < 1000) {
+            return [...uids];
+        }
+    }
+}
+/** `{ uid: in(uids) }` - or `nin` when `negated` - with an empty list compiled to "matches nothing" (or "everything"). */
+function uidCondition(uids, negated) {
+    if (uids.length === 0) {
+        return negated ? { uid: ModelUtils.literal(NO_UID, "ne") } : { uid: ModelUtils.literal(NO_UID) };
+    }
+    return { uid: ModelUtils.literal(uids, negated ? "nin" : "in") };
+}
+/**
+ * Compiles a validated filter (`validateFilter()`) into a query `RepoUtils.find()`/`count()` runs on both Mongo and SQL: record fields
+ * become column comparisons combined with `$and`/`$or`. A condition on a custom property or tag is resolved first against the
+ * `PropertyValue` rows (with an index) to the uids of the records it matches, and becomes `uid in (...)`. A negated condition on
+ * one (`ne`, `notIn`, `isNotSet`) - and `notContains` on a record's own text, which SQL can't express - becomes `uid not in` the
+ * records matching its positive form, so a record with no value at all counts as "not equal".
+ *
+ * The result doesn't restrict the workspace - `workspaceQuery()` adds that.
+ */
+export async function compileFilter(node, fields, context) {
+    if ("and" in node || "or" in node) {
+        const op = node.and ? "and" : "or";
+        const children = [];
+        for (const child of (node.and ?? node.or)) {
+            children.push(await compileFilter(child, fields, context));
+        }
+        return { [op === "and" ? "$and" : "$or"]: children };
+    }
+    const condition = node;
+    const field = fields[condition.field];
+    const positive = NEGATED[condition.op] ?? condition.op;
+    const negated = positive !== condition.op;
+    if (field.stored === "record") {
+        if (condition.op !== "notContains") {
+            return { [condition.field]: columnPredicate(condition.op, condition.value) };
+        }
+        const containing = await matchingUids(context.recordRepo, { workspaceUid: ModelUtils.literal(context.workspaceUid), [condition.field]: columnPredicate("contains", condition.value) }, "uid");
+        return uidCondition(containing, true);
+    }
+    const column = valueColumn(field.type);
+    const query = {
+        workspaceUid: ModelUtils.literal(context.workspaceUid),
+        objectType: ModelUtils.literal(context.objectType),
+        key: ModelUtils.literal(field.key),
+    };
+    if (positive !== "isSet") {
+        // A boolean is stored as 1 or 0.
+        const value = field.type === "boolean" ? (condition.value ? 1 : 0) : condition.value;
+        query[column] = columnPredicate(positive, value);
+    }
+    return uidCondition(await matchingUids(context.valueRepo, query, "objectUid"), negated);
+}
+/** `filter` limited to `workspaceUid`'s records: `{ workspaceUid, $and: [filter] }`, or just the workspace with no filter. */
+export function workspaceQuery(workspaceUid, filter) {
+    const query = { workspaceUid: ModelUtils.literal(workspaceUid) };
+    if (filter && Object.keys(filter).length > 0) {
+        query.$and = [filter];
+    }
+    return query;
+}
+/**
+ * Whether `record` (with its custom property values and tags in `values`, keyed by `PropertyValue.key`) matches a validated filter -
+ * the same answer `compileFilter()`'s query gives, for checking one record without a query (automation conditions, segment
+ * membership). Text comparisons ignore case like the query's `like()` does; `eq` on text is exact, as it is in the query.
+ */
+export function evaluateFilter(node, fields, record, values) {
+    if ("and" in node || "or" in node) {
+        return node.and
+            ? node.and.every((child) => evaluateFilter(child, fields, record, values))
+            : node.or.some((child) => evaluateFilter(child, fields, record, values));
+    }
+    const condition = node;
+    const field = fields[condition.field];
+    const present = field.stored === "values"
+        ? [...(values[field.key] ?? [])]
+        : record[condition.field] === undefined || record[condition.field] === null
+            ? []
+            : [record[condition.field]];
+    const positive = NEGATED[condition.op] ?? condition.op;
+    const matched = present.some((value) => compareValue(field, positive, value, condition.value));
+    const result = positive === "isSet" ? present.length > 0 : matched;
+    return positive === condition.op ? result : !result;
+}
+/** A stored value as what it is compared as: dates as milliseconds, booleans as 1 or 0. */
+function comparable(field, value) {
+    if (field.type === "date") {
+        return parseDate(value)?.getTime();
+    }
+    if (field.type === "boolean") {
+        return value === true || value === 1 ? 1 : 0;
+    }
+    return value;
+}
+/** Whether one stored value satisfies a positive comparison. */
+function compareValue(field, op, stored, operand) {
+    const value = comparable(field, stored);
+    const target = Array.isArray(operand) ? operand.map((entry) => comparable(field, entry)) : comparable(field, operand);
+    switch (op) {
+        case "eq":
+            return value === target;
+        case "gt":
+            return value > target;
+        case "gte":
+            return value >= target;
+        case "lt":
+            return value < target;
+        case "lte":
+            return value <= target;
+        case "between":
+            return value >= target[0] && value <= target[1];
+        case "in":
+            return target.includes(value);
+        case "contains":
+            return typeof value === "string" && value.toLowerCase().includes(globText(String(operand)).toLowerCase());
+        case "startsWith":
+            return typeof value === "string" && value.toLowerCase().startsWith(globText(String(operand)).toLowerCase());
+        default:
+            // isSet: any value at all
+            return true;
+    }
+}
+//# sourceMappingURL=Filter.js.map