mailery 0.1.0 → 0.1.1

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, N as NormalizedEvent, c as Mailer, T as TemplateDoc, d as SuppressionScope } from './null-7gnz1V98.cjs';
-export { e as AuditLogDoc, B as BroadcastDoc, f as BroadcastStatus, g as CircuitBreakerThresholds, h as Collections, i as ContactTagDoc, E as EventDoc, F as FlowDoc, j as FlowGoal, k as FlowRunDoc, l as FlowRunStatus, m as FlowStep, n as FlowVersionDoc, H as HealthDoc, o as HealthStatus, L as LeadDoc, p as MailerConfig, q as NullProvider, O as OutboxDoc, P as Predicate, R as RedisOptions, r as SegmentDefinition, s as SegmentFilter, t as SendDoc, u as SendStatus, v as SubscriptionDoc, w as SubscriptionStatus, x as SuppressionDoc, y as SuppressionReason, z as TemplateKind, D as TemplateVersionDoc, W as WebhookEventDoc, G as ensureIndexes, I as getCollections } from './null-7gnz1V98.cjs';
+import { C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, N as NormalizedEvent, c as Mailer, T as TemplateDoc, d as SuppressionScope, F as FlowStep, e as SegmentFilter, P as Predicate } from './null-sygex0Ru.cjs';
+export { f as AuditLogDoc, B as BroadcastDoc, g as BroadcastStatus, h as CircuitBreakerThresholds, i as Collections, j as ContactTagDoc, E as EventDoc, k as FlowDoc, l as FlowGoal, m as FlowRunDoc, n as FlowRunStatus, o as FlowVersionDoc, H as HealthDoc, p as HealthStatus, L as LeadDoc, q as MailerConfig, r as NullProvider, O as OutboxDoc, R as RedisOptions, s as SegmentDefinition, t as SendDoc, u as SendStatus, v as SubscriptionDoc, w as SubscriptionStatus, x as SuppressionDoc, y as SuppressionReason, z as TemplateKind, D as TemplateVersionDoc, W as WebhookEventDoc, G as ensureIndexes, I as getCollections } from './null-sygex0Ru.cjs';
 import { Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -235,9 +235,57 @@ declare function verifyUnsubscribeToken(token: string, secret: string, now?: Dat
  */
 declare function sha256Hex(input: string): string;
 
+/**
+ * Enumerable option lists for the union types in `./types.ts`. Used by the
+ * admin client to render dropdowns + by tooling to enumerate the surface.
+ *
+ * Kept in `shared/` so the client and server agree on the canonical labels +
+ * default constructors. Pure data + pure functions — no React, no DOM.
+ */
+
+interface FlowStepKindOption {
+    value: FlowStep['type'];
+    label: string;
+    /** Icon name from the client's icon set (lookup at render time). */
+    icon: string;
+    /** Visual class on the canvas chip. */
+    iconClass: string;
+    /** One-line description for tooltips / docs generation. */
+    description: string;
+}
+declare const FLOW_STEP_KINDS: readonly FlowStepKindOption[];
+declare function defaultFlowStep(type: FlowStep['type']): FlowStep;
+type PredicateKind = 'hasTag' | 'notHasTag' | 'fieldEquals' | 'fieldExists' | 'hasFiredEvent' | 'notHasFiredEvent' | 'subscriptionStatus' | 'hasOpened' | 'hasClicked' | 'hasOpenedExcludingBots' | 'hasClickedExcludingBots' | 'openedAtLeastN' | 'clickedAtLeastN';
+interface PredicateKindOption {
+    value: PredicateKind;
+    label: string;
+    /** True when this predicate's signal is noisy (Apple MPP, bot prefetch). */
+    noisy?: boolean;
+}
+declare const PREDICATE_KINDS: readonly PredicateKindOption[];
+/** Identify which kind of predicate this object is (or null for composites/unknown). */
+declare function predicateKind(p: Predicate | null | undefined): PredicateKind | null;
+declare function defaultPredicate(kind: PredicateKind): Predicate;
+type SegmentFilterKind = SegmentFilter['kind'];
+interface SegmentFilterKindOption {
+    value: SegmentFilterKind;
+    label: string;
+    /** Where the filter is evaluated: host-side via adapter, or mailer-side post-filter. */
+    side: 'host' | 'mailer' | 'composite';
+}
+declare const SEGMENT_FILTER_KINDS: readonly SegmentFilterKindOption[];
+declare function defaultSegmentFilter(kind: SegmentFilterKind): SegmentFilter;
+interface DedupePolicyOption {
+    value: 'once-per-contact' | 'once-per-day' | 'every-time';
+    label: string;
+    description: string;
+    derivedKeyShape: string;
+}
+declare const DEDUPE_POLICIES: readonly DedupePolicyOption[];
+
 /**
  * Public exports for the `mailery` package.
  */
 declare const VERSION = "0.1.0";
 
-export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, type PublicRouterOptions, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, compileTemplate, createAdminRouter, createPublicRouter, derivePlaintext, renderTemplate, sha256Hex, signUnsubscribeToken, verifyUnsubscribeToken };
+export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, DEDUPE_POLICIES, type DedupePolicyOption, FLOW_STEP_KINDS, FlowStep, type FlowStepKindOption, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, PREDICATE_KINDS, Predicate, type PredicateKind, type PredicateKindOption, type PublicRouterOptions, SEGMENT_FILTER_KINDS, SegmentFilter, type SegmentFilterKind, type SegmentFilterKindOption, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, compileTemplate, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, predicateKind, renderTemplate, sha256Hex, signUnsubscribeToken, verifyUnsubscribeToken };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, N as NormalizedEvent, c as Mailer, T as TemplateDoc, d as SuppressionScope } from './null-7gnz1V98.js';
-export { e as AuditLogDoc, B as BroadcastDoc, f as BroadcastStatus, g as CircuitBreakerThresholds, h as Collections, i as ContactTagDoc, E as EventDoc, F as FlowDoc, j as FlowGoal, k as FlowRunDoc, l as FlowRunStatus, m as FlowStep, n as FlowVersionDoc, H as HealthDoc, o as HealthStatus, L as LeadDoc, p as MailerConfig, q as NullProvider, O as OutboxDoc, P as Predicate, R as RedisOptions, r as SegmentDefinition, s as SegmentFilter, t as SendDoc, u as SendStatus, v as SubscriptionDoc, w as SubscriptionStatus, x as SuppressionDoc, y as SuppressionReason, z as TemplateKind, D as TemplateVersionDoc, W as WebhookEventDoc, G as ensureIndexes, I as getCollections } from './null-7gnz1V98.js';
+import { C as ContactAdapter, a as Contact, A as AdapterFilter, M as MailProvider, S as SendArgs, b as SendResult, N as NormalizedEvent, c as Mailer, T as TemplateDoc, d as SuppressionScope, F as FlowStep, e as SegmentFilter, P as Predicate } from './null-sygex0Ru.js';
+export { f as AuditLogDoc, B as BroadcastDoc, g as BroadcastStatus, h as CircuitBreakerThresholds, i as Collections, j as ContactTagDoc, E as EventDoc, k as FlowDoc, l as FlowGoal, m as FlowRunDoc, n as FlowRunStatus, o as FlowVersionDoc, H as HealthDoc, p as HealthStatus, L as LeadDoc, q as MailerConfig, r as NullProvider, O as OutboxDoc, R as RedisOptions, s as SegmentDefinition, t as SendDoc, u as SendStatus, v as SubscriptionDoc, w as SubscriptionStatus, x as SuppressionDoc, y as SuppressionReason, z as TemplateKind, D as TemplateVersionDoc, W as WebhookEventDoc, G as ensureIndexes, I as getCollections } from './null-sygex0Ru.js';
 import { Db, Filter } from 'mongodb';
 import { Request, Router } from 'express';
 import Handlebars from 'handlebars';
@@ -235,9 +235,57 @@ declare function verifyUnsubscribeToken(token: string, secret: string, now?: Dat
  */
 declare function sha256Hex(input: string): string;
 
+/**
+ * Enumerable option lists for the union types in `./types.ts`. Used by the
+ * admin client to render dropdowns + by tooling to enumerate the surface.
+ *
+ * Kept in `shared/` so the client and server agree on the canonical labels +
+ * default constructors. Pure data + pure functions — no React, no DOM.
+ */
+
+interface FlowStepKindOption {
+    value: FlowStep['type'];
+    label: string;
+    /** Icon name from the client's icon set (lookup at render time). */
+    icon: string;
+    /** Visual class on the canvas chip. */
+    iconClass: string;
+    /** One-line description for tooltips / docs generation. */
+    description: string;
+}
+declare const FLOW_STEP_KINDS: readonly FlowStepKindOption[];
+declare function defaultFlowStep(type: FlowStep['type']): FlowStep;
+type PredicateKind = 'hasTag' | 'notHasTag' | 'fieldEquals' | 'fieldExists' | 'hasFiredEvent' | 'notHasFiredEvent' | 'subscriptionStatus' | 'hasOpened' | 'hasClicked' | 'hasOpenedExcludingBots' | 'hasClickedExcludingBots' | 'openedAtLeastN' | 'clickedAtLeastN';
+interface PredicateKindOption {
+    value: PredicateKind;
+    label: string;
+    /** True when this predicate's signal is noisy (Apple MPP, bot prefetch). */
+    noisy?: boolean;
+}
+declare const PREDICATE_KINDS: readonly PredicateKindOption[];
+/** Identify which kind of predicate this object is (or null for composites/unknown). */
+declare function predicateKind(p: Predicate | null | undefined): PredicateKind | null;
+declare function defaultPredicate(kind: PredicateKind): Predicate;
+type SegmentFilterKind = SegmentFilter['kind'];
+interface SegmentFilterKindOption {
+    value: SegmentFilterKind;
+    label: string;
+    /** Where the filter is evaluated: host-side via adapter, or mailer-side post-filter. */
+    side: 'host' | 'mailer' | 'composite';
+}
+declare const SEGMENT_FILTER_KINDS: readonly SegmentFilterKindOption[];
+declare function defaultSegmentFilter(kind: SegmentFilterKind): SegmentFilter;
+interface DedupePolicyOption {
+    value: 'once-per-contact' | 'once-per-day' | 'every-time';
+    label: string;
+    description: string;
+    derivedKeyShape: string;
+}
+declare const DEDUPE_POLICIES: readonly DedupePolicyOption[];
+
 /**
  * Public exports for the `mailery` package.
  */
 declare const VERSION = "0.1.0";
 
-export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, type PublicRouterOptions, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, compileTemplate, createAdminRouter, createPublicRouter, derivePlaintext, renderTemplate, sha256Hex, signUnsubscribeToken, verifyUnsubscribeToken };
+export { AdapterFilter, type AdminRouterOptions, Contact, ContactAdapter, DEDUPE_POLICIES, type DedupePolicyOption, FLOW_STEP_KINDS, FlowStep, type FlowStepKindOption, MailProvider, Mailer, MongoContactAdapter, type MongoContactAdapterOptions, NormalizedEvent, PREDICATE_KINDS, Predicate, type PredicateKind, type PredicateKindOption, type PublicRouterOptions, SEGMENT_FILTER_KINDS, SegmentFilter, type SegmentFilterKind, type SegmentFilterKindOption, SendArgs, SendGridProvider, type SendGridProviderOptions, SendResult, SuppressionScope, TemplateDoc, VERSION, applyTracking, compileTemplate, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, predicateKind, renderTemplate, sha256Hex, signUnsubscribeToken, verifyUnsubscribeToken };

package/dist/index.js

@@ -3662,9 +3662,161 @@ function lowercaseHeaders(h) {
   return out;
 }
 
+// src/shared/options.ts
+var FLOW_STEP_KINDS = [
+  { value: "wait", label: "Wait", icon: "Clock", iconClass: "wait", description: "Pause the run for a duration before continuing." },
+  { value: "condition", label: "Condition", icon: "Branch", iconClass: "condition", description: "Evaluate a predicate. Exit or skip on false." },
+  { value: "branch", label: "Branch", icon: "Branch", iconClass: "condition", description: "Evaluate a predicate. Recurse into one of two sub-lists." },
+  { value: "send", label: "Send", icon: "Mail", iconClass: "send", description: "Send a template to the contact." },
+  { value: "tag", label: "Tag", icon: "Tag", iconClass: "tag", description: "Add or remove tags on the contact." },
+  { value: "fire_event", label: "Fire event", icon: "Activity", iconClass: "send", description: "Insert a synthetic event (cross-flow handoff)." },
+  { value: "webhook", label: "Webhook", icon: "Webhook", iconClass: "tag", description: "POST to an external URL." },
+  { value: "exit", label: "Exit", icon: "Exit", iconClass: "exit", description: "End the run with an optional reason." }
+];
+function defaultFlowStep(type) {
+  switch (type) {
+    case "wait":
+      return { type: "wait", value: 1, unit: "days" };
+    case "condition":
+      return { type: "condition", test: { hasTag: "engaged" }, ifFalse: "exit" };
+    case "branch":
+      return { type: "branch", test: { hasTag: "vip" }, ifTrueSteps: [], ifFalseSteps: [] };
+    case "send":
+      return { type: "send", templateSlug: "" };
+    case "tag":
+      return { type: "tag", addTags: [], removeTags: [] };
+    case "fire_event":
+      return { type: "fire_event", eventName: "" };
+    case "webhook":
+      return { type: "webhook", url: "", method: "POST" };
+    case "exit":
+      return { type: "exit" };
+  }
+}
+var PREDICATE_KINDS = [
+  { value: "hasTag", label: "has tag" },
+  { value: "notHasTag", label: "does NOT have tag" },
+  { value: "fieldEquals", label: "field equals" },
+  { value: "fieldExists", label: "field exists" },
+  { value: "hasFiredEvent", label: "fired event" },
+  { value: "notHasFiredEvent", label: "has NOT fired event" },
+  { value: "subscriptionStatus", label: "subscription status" },
+  { value: "hasOpened", label: "opened", noisy: true },
+  { value: "hasClicked", label: "clicked", noisy: true },
+  { value: "hasOpenedExcludingBots", label: "opened (excl. bots)" },
+  { value: "hasClickedExcludingBots", label: "clicked (excl. bots)" },
+  { value: "openedAtLeastN", label: "opened at least N" },
+  { value: "clickedAtLeastN", label: "clicked at least N" }
+];
+function predicateKind(p) {
+  if (!p) return null;
+  for (const k of PREDICATE_KINDS) {
+    if (k.value in p) return k.value;
+  }
+  return null;
+}
+function defaultPredicate(kind) {
+  switch (kind) {
+    case "hasTag":
+      return { hasTag: "engaged" };
+    case "notHasTag":
+      return { notHasTag: "cold" };
+    case "fieldEquals":
+      return { fieldEquals: { field: "tier", value: "Pro" } };
+    case "fieldExists":
+      return { fieldExists: "tier" };
+    case "hasFiredEvent":
+      return { hasFiredEvent: "Activated app" };
+    case "notHasFiredEvent":
+      return { notHasFiredEvent: "Cancelled" };
+    case "subscriptionStatus":
+      return { subscriptionStatus: "subscribed" };
+    case "hasOpened":
+      return { hasOpened: { sinceFlowStart: true } };
+    case "hasClicked":
+      return { hasClicked: { sinceFlowStart: true } };
+    case "hasOpenedExcludingBots":
+      return { hasOpenedExcludingBots: { sinceFlowStart: true } };
+    case "hasClickedExcludingBots":
+      return { hasClickedExcludingBots: { sinceFlowStart: true } };
+    case "openedAtLeastN":
+      return { openedAtLeastN: { count: 1, withinDays: 7 } };
+    case "clickedAtLeastN":
+      return { clickedAtLeastN: { count: 1, withinDays: 7 } };
+  }
+}
+var SEGMENT_FILTER_KINDS = [
+  { value: "subscriptionStatus", label: "Subscription status", side: "mailer" },
+  { value: "hasTag", label: "Has tag", side: "host" },
+  { value: "notHasTag", label: "Does NOT have tag", side: "host" },
+  { value: "fieldEquals", label: "Field equals", side: "host" },
+  { value: "fieldIn", label: "Field in list", side: "host" },
+  { value: "fieldExists", label: "Field exists", side: "host" },
+  { value: "firedEvent", label: "Fired event", side: "mailer" },
+  { value: "notFiredEvent", label: "Has NOT fired event", side: "mailer" },
+  { value: "subscribedAfter", label: "Subscribed after", side: "mailer" },
+  { value: "subscribedBefore", label: "Subscribed before", side: "mailer" },
+  { value: "opened", label: "Opened", side: "mailer" },
+  { value: "notOpened", label: "Did NOT open", side: "mailer" },
+  { value: "any", label: "Any of (OR)", side: "composite" },
+  { value: "not", label: "NOT", side: "composite" }
+];
+function defaultSegmentFilter(kind) {
+  switch (kind) {
+    case "subscriptionStatus":
+      return { kind: "subscriptionStatus", equals: "subscribed" };
+    case "hasTag":
+      return { kind: "hasTag", tag: "" };
+    case "notHasTag":
+      return { kind: "notHasTag", tag: "" };
+    case "fieldEquals":
+      return { kind: "fieldEquals", field: "", value: "" };
+    case "fieldIn":
+      return { kind: "fieldIn", field: "", values: [] };
+    case "fieldExists":
+      return { kind: "fieldExists", field: "" };
+    case "firedEvent":
+      return { kind: "firedEvent", eventName: "", withinDays: 30 };
+    case "notFiredEvent":
+      return { kind: "notFiredEvent", eventName: "", withinDays: 90 };
+    case "subscribedAfter":
+      return { kind: "subscribedAfter", date: new Date(Date.now() - 30 * 864e5) };
+    case "subscribedBefore":
+      return { kind: "subscribedBefore", date: /* @__PURE__ */ new Date() };
+    case "opened":
+      return { kind: "opened", withinDays: 14 };
+    case "notOpened":
+      return { kind: "notOpened", withinDays: 14 };
+    case "any":
+      return { kind: "any", filters: [] };
+    case "not":
+      return { kind: "not", filter: { kind: "hasTag", tag: "" } };
+  }
+}
+var DEDUPE_POLICIES = [
+  {
+    value: "once-per-contact",
+    label: "Once per contact",
+    description: "Lifecycle markers (Created, Activated)",
+    derivedKeyShape: "${externalId}:${eventName}"
+  },
+  {
+    value: "once-per-day",
+    label: "Once per day",
+    description: "Daily behaviors (Viewed Storyboard)",
+    derivedKeyShape: "${externalId}:${eventName}:${YYYY-MM-DD}"
+  },
+  {
+    value: "every-time",
+    label: "Every time",
+    description: "True every-occurrence events (Imported)",
+    derivedKeyShape: "${externalId}:${eventName}:${UUIDv4}"
+  }
+];
+
 // src/server/index.ts
 var VERSION = "0.1.0";
 
-export { Mailer, MongoContactAdapter, NullProvider, SendGridProvider, VERSION, applyTracking, compileTemplate, createAdminRouter, createPublicRouter, derivePlaintext, ensureIndexes, getCollections, renderTemplate, sha256Hex, signUnsubscribeToken, verifyUnsubscribeToken };
+export { DEDUPE_POLICIES, FLOW_STEP_KINDS, Mailer, MongoContactAdapter, NullProvider, PREDICATE_KINDS, SEGMENT_FILTER_KINDS, SendGridProvider, VERSION, applyTracking, compileTemplate, createAdminRouter, createPublicRouter, defaultFlowStep, defaultPredicate, defaultSegmentFilter, derivePlaintext, ensureIndexes, getCollections, predicateKind, renderTemplate, sha256Hex, signUnsubscribeToken, verifyUnsubscribeToken };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map