@dev.smartpricing/message-composer-utils 4.5.1-next.2 → 5.0.0-automations.0

package/src/types/condition.ts

@@ -0,0 +1,114 @@
+/**
+ * Conditions in the Automation Engine's shape, and the closed vocabulary the
+ * filter components and the backend share (ADR 0018). Nothing here knows
+ * about Automations: an audience page edits Conditions too.
+ */
+
+/** Every operator the Automation Engine accepts. */
+export const CONDITION_OPERATORS = [
+  "eq",
+  "neq",
+  "gt",
+  "gte",
+  "lt",
+  "lte",
+  "in",
+  "not_in",
+  "contains",
+  "exclude",
+  "exists",
+] as const;
+
+export type ConditionOperator = (typeof CONDITION_OPERATORS)[number];
+
+export const CONDITION_FIELD_TYPES = [
+  "select",
+  "multiselect",
+  "number",
+  "price",
+  "date",
+  "text",
+] as const;
+
+export type ConditionFieldType = (typeof CONDITION_FIELD_TYPES)[number];
+
+/** One test on a Trigger Event's data. `exists` takes no value. */
+export interface Condition {
+  field: string;
+  operator: ConditionOperator;
+  value?: unknown;
+}
+
+/** The operators of the field types whose values have an order. */
+const ORDERED_VALUE_OPERATORS = [
+  "eq",
+  "neq",
+  "gt",
+  "gte",
+  "lt",
+  "lte",
+  "exists",
+] as const satisfies readonly ConditionOperator[];
+
+/** The operators a Condition on a field of each type can use (ADR 0018). */
+export const CONDITION_OPERATORS_BY_FIELD_TYPE = {
+  select: ["eq", "neq", "exists"],
+  multiselect: ["in", "not_in", "exists"],
+  number: ORDERED_VALUE_OPERATORS,
+  price: ORDERED_VALUE_OPERATORS,
+  date: ORDERED_VALUE_OPERATORS,
+  text: ["eq", "neq", "contains", "exclude", "exists"],
+} as const satisfies Record<ConditionFieldType, readonly ConditionOperator[]>;
+
+export function operatorFitsFieldType(
+  operator: ConditionOperator,
+  fieldType: ConditionFieldType,
+): boolean {
+  const operators: readonly ConditionOperator[] =
+    CONDITION_OPERATORS_BY_FIELD_TYPE[fieldType];
+  return operators.includes(operator);
+}
+
+/**
+ * What a caller passes to the layer's filter components (`FiltersEditor`,
+ * `FiltersSummary`) and what they report back (ADR 0018).
+ */
+
+export type FilterOptionValue = string | number;
+
+export interface FilterOption {
+  value: FilterOptionValue;
+  label: string;
+}
+
+/** One field a Condition can test, label and options already resolved. */
+export interface FilterField {
+  /** The `field` of the Conditions on it. */
+  key: string;
+  label: string;
+  type: ConditionFieldType;
+  /** For `select` and `multiselect`. A list that is not there shows as empty. */
+  options?: FilterOption[];
+}
+
+/**
+ * Why a Condition shows as an unavailable row: its field is not in `fields`,
+ * or the editor cannot edit it (an operator or a value that does not fit the
+ * field's type, one Condition too many on a field).
+ */
+export type FilterUnavailableReason = "unknown_field" | "not_editable";
+
+/** What is wrong with a list of Conditions. The caller decides what blocks. */
+export interface FiltersReport {
+  /** The fields of the Conditions that are on none of `fields`, each once. */
+  unknownFields: string[];
+  /** Every Condition shown as an unavailable row, the unknown fields included. */
+  unavailable: { condition: Condition; reason: FilterUnavailableReason }[];
+  /** Every selected option value that is not in its field's `options`. */
+  unavailableOptions: { field: string; value: FilterOptionValue }[];
+  /**
+   * Rows with a field picked and no complete value. They are not in the
+   * emitted Conditions. Always 0 from `FiltersSummary`.
+   */
+  halfFilled: number;
+}

package/src/types/index.ts

@@ -15,3 +15,6 @@ export * from "./dynamic-values.js";
 export * from "./brand.js";
 export * from "./organization.js";
 export * from "./pagination.js";
+export * from "./automation.js";
+export * from "./condition.js";
+export * from "./automation-catalog.js";