@rapidmx/crm-plugin 0.1.0

package/dist/types/jobs/CrmImportJob.d.ts

@@ -0,0 +1,44 @@
+import { BackgroundService, NotificationUtils, ObjectFactory } from "@rapidrest/service-core";
+import type { BlobStore } from "@rapidmx/restapi";
+import { CrmModelClasses } from "../models/CrmModelClasses.js";
+/**
+ * Imports queued CSV imports (`BaseImportRoute`): each row becomes a create or update through the contact or company route's own
+ * `importRow()`, so it gets exactly the checks and side effects an API request would (tags, custom properties, the timeline). A row
+ * that fails is counted as skipped with its reason (the first `MAX_IMPORT_ERRORS` are kept) and the import carries on.
+ *
+ * **One replica per import.** An import is claimed with a version-checked update that sets it `RUNNING` with a lease; progress is saved
+ * (and the lease renewed) every `PROGRESS_EVERY` rows the same way, so a replica that loses the row to another stops. An import whose
+ * lease ran out - its replica died - is claimed again and resumes after the last saved row; after `max_attempts` claims it fails.
+ *
+ * Concrete subclasses supply the backend's model classes and route classes.
+ */
+export declare abstract class CrmImportJob extends BackgroundService {
+    protected abstract classes: CrmModelClasses;
+    protected abstract contactRouteClass: any;
+    protected abstract companyRouteClass: any;
+    protected _objectFactory?: ObjectFactory;
+    protected blobStore?: BlobStore;
+    protected notificationUtils?: NotificationUtils;
+    protected scheduleExpr: string;
+    protected leaseSeconds: number;
+    protected maxAttempts: number;
+    protected logger?: any;
+    private repos?;
+    private routes;
+    get schedule(): string | undefined;
+    start(): void;
+    stop(): void;
+    run(): Promise<void>;
+    private repo;
+    /** The contact or company route that writes an import's rows. */
+    private route;
+    /** Takes `candidate` for this replica, or `undefined` when another took it first. An import claimed too often fails instead. */
+    private claim;
+    /** Imports every row after `processedRows`, saving progress as it goes. */
+    private process;
+    /** The workspace's company named `name` (the first found), created when there is none. */
+    private companyByName;
+    /** Saves `fields` onto the import with a version check; `undefined` when another replica changed it first. */
+    private save;
+    private publish;
+}

package/dist/types/jobs/CrmJobBase.d.ts

@@ -0,0 +1,26 @@
+import { BackgroundService, NotificationUtils, ObjectFactory, RepoUtils } from "@rapidrest/service-core";
+import { CrmModelClasses, CrmModelName, CrmRepos } from "../models/CrmModelClasses.js";
+/**
+ * What the CRM's background jobs share: the backend's model classes and repositories, the key links are signed with, the public site,
+ * and pushing changes to a workspace's open pages. A subclass supplies `schedule` (from its own setting) and `run()`.
+ */
+export declare abstract class CrmJobBase extends BackgroundService {
+    protected abstract classes: CrmModelClasses;
+    protected _objectFactory?: ObjectFactory;
+    protected notificationUtils?: NotificationUtils;
+    protected publicUrl: string;
+    protected configuredTokenSecret: string;
+    protected logger?: any;
+    private crmRepos?;
+    private cachedTokenSecret?;
+    start(): void;
+    stop(): void;
+    protected repos(): CrmRepos;
+    protected repo<T = any>(name: CrmModelName): Promise<RepoUtils<T & any>>;
+    /** The key tokens and tracking links are signed with - the same the routes use. */
+    protected tokenSecret(): Promise<string>;
+    /** An absolute link under `mail:crm:public_url`. */
+    protected publicLink(path: string): string;
+    /** Tells the workspace's open pages that a record changed. */
+    protected notify(workspaceUid: string, type: string, data: unknown): void;
+}

package/dist/types/jobs/CrmMailEventJob.d.ts

@@ -0,0 +1,102 @@
+import { ConnectionManager } from "@rapidrest/service-core";
+import { CrmJobBase } from "./CrmJobBase.js";
+/**
+ * The part of `@rapidmx/restapi`'s mail event stream this job reads - the same Redis stream (`MAIL_EVENT_STREAM_KEY`) and entry format
+ * (`MessageDeliveredEvent`, JSON in the `event` field). Kept here, not imported, until the plugin depends on a restapi release that
+ * exports the stream (0.27): then this job becomes a `MailEventConsumer` subclass and these types go.
+ */
+export declare const MAIL_EVENT_STREAM_KEY = "rapidmx:mail-events";
+/** A bounce's recipient group, as restapi's `DsnParser` reports it. */
+export interface DeliveryStatusRecipient {
+    finalRecipient: string;
+    status?: string;
+    outcome: "delivered" | "delayed" | "soft_bounce" | "hard_bounce";
+}
+/** restapi's `message.delivered` event: a message filed into a mailbox. */
+export interface MessageDeliveredEvent {
+    type: "message.delivered";
+    occurredAt: string;
+    mailboxUid: string;
+    messageUid: string;
+    envelopeTo: string[];
+    fromAddress?: string;
+    subject?: string;
+    messageId?: string;
+    inReplyTo?: string;
+    references: string[];
+    autoSubmitted?: string;
+    precedence?: string;
+    deliveryStatusReport?: {
+        originalMessageId?: string;
+        recipients: DeliveryStatusRecipient[];
+    };
+    feedbackReport?: {
+        feedbackType: string;
+        originalMessageId?: string;
+    };
+}
+/** restapi's `message.sent` event: a message sent from a mailbox. */
+export interface MessageSentEvent {
+    type: "message.sent";
+    occurredAt: string;
+    mailboxUid?: string;
+    messageUid?: string;
+    messageId: string;
+    recipients: string[];
+}
+/** The Redis commands the job uses. */
+export interface StreamRedis {
+    xGroupCreate(key: string, group: string, id: string, options?: any): Promise<unknown>;
+    xReadGroup(group: string, consumer: string, streams: {
+        key: string;
+        id: string;
+    }, options?: any): Promise<any>;
+    xAck(key: string, group: string, id: string | string[]): Promise<number>;
+    xAutoClaim(key: string, group: string, consumer: string, minIdleTime: number, start: string, options?: any): Promise<any>;
+}
+/**
+ * Learns what became of CRM messages from the mail the workspaces' sender mailboxes receive, read from restapi's mail event stream
+ * as the consumer group `crm-plugin` (one replica handles each event; a replica that fails leaves it to be claimed again):
+ * - **Bounces** (a delivery status report) of a CRM message - found by its bounce address (`verpAddress()`) or the returned
+ * `Message-ID` - record a hard or soft bounce; a hard one suppresses the address.
+ * - **Complaints** (an abuse feedback report) of one record a complaint and suppress the address.
+ * - **Replies** - a message whose `In-Reply-To`/`References` names a CRM message - record a reply. Automatic mail (`Auto-Submitted`,
+ * `Precedence: bulk`...) is not a reply.
+ *
+ * Only reports and replies filed into the mailbox of the message's own sender count, so nobody can forge engagement by mailing some
+ * other mailbox. Without an `events` Redis datastore, the job does nothing.
+ */
+export declare abstract class CrmMailEventJob extends CrmJobBase {
+    protected connectionManager?: ConnectionManager;
+    protected datastoreName: string;
+    protected scheduleExpr: string;
+    protected readonly consumerGroup: string;
+    protected readonly consumerName: string;
+    protected batchSize: number;
+    protected maxBatchesPerRun: number;
+    protected retryAfterMs: number;
+    private groupReady;
+    get schedule(): string | undefined;
+    /** The stream's Redis client, if there is one. */
+    protected redis(): StreamRedis | undefined;
+    run(): Promise<void>;
+    /** Handles one entry and acknowledges it - unless handling throws, which leaves it to be retried. */
+    private dispatch;
+    /** Records what `event` says about CRM messages, if anything - see the class comment. Idempotent. */
+    handle(event: MessageDeliveredEvent): Promise<void>;
+    /** Logs a message a logging sender's mailbox sent to contacts (`WorkspaceSender.logEmail`) on their timelines. */
+    handleSent(event: MessageSentEvent): Promise<void>;
+    /**
+     * Adds a timeline entry for each of `addresses` that is a contact of a workspace whose sender with mailbox `mailboxUid` logs email -
+     * once per message and contact (`refUid`), however often the event comes.
+     */
+    private logEmail;
+    /**
+     * The CRM message a bounce, report or reply filed into `mailboxUid` is about - by its token, else by one of `messageIds` - if that
+     * message was sent from a sender whose mailbox is `mailboxUid`.
+     */
+    private findSend;
+    /** Whether `send` went out from a sender whose mailbox is `mailboxUid`. */
+    private sentFrom;
+    private recorder;
+}

package/dist/types/jobs/DateTriggerJob.d.ts

@@ -0,0 +1,21 @@
+import { CrmJobBase } from "./CrmJobBase.js";
+/** The most date values one automation's daily check reads. */
+export declare const MAX_DATE_SCAN = 200000;
+/**
+ * Puts contacts into automations whose trigger is a date (`date.reached`): a contact's custom date property or its own
+ * `dateCreated`/`lastEngagedAt`, on the day - or `offsetDays` before or after it - once or every year.
+ *
+ * Each active automation is checked once a day, from its trigger's `hour` in its workspace's time zone: the run claims the day by
+ * stamping `Automation.dateCheckedOn` (version-checked, so one replica does it), then reads the contacts whose date falls on it and
+ * enrolls those matching the trigger's contact filter - as the automation's re-entry rule allows. A day missed (the automation was
+ * paused, or no replica ran) isn't made up.
+ */
+export declare abstract class DateTriggerJob extends CrmJobBase {
+    protected scheduleExpr: string;
+    get schedule(): string | undefined;
+    run(now?: Date): Promise<void>;
+    /** The contacts of the workspace whose date makes `trigger` fire on `today` (`YYYY-MM-DD`, in `timeZone`). */
+    private contactsOn;
+    /** Every row of `repo` matching `query`, in uid order, at most `MAX_DATE_SCAN`. */
+    private all;
+}

package/dist/types/jobs/ScoringJob.d.ts

@@ -0,0 +1,13 @@
+import { CrmJobBase } from "./CrmJobBase.js";
+/**
+ * Keeps lead scores current (`scoreWorkspace()`): rescores a workspace soon after its scoring rules change (`scoringDirty`), and
+ * every `mail:crm:jobs:scoring:interval_seconds` while it has rules, since activity rules count within moving windows. A workspace
+ * is claimed by stamping `scoredAt` (version-checked); a rule changed while it is scored marks it dirty again for the next run.
+ */
+export declare abstract class ScoringJob extends CrmJobBase {
+    protected scheduleExpr: string;
+    protected intervalSeconds: number;
+    protected batchSize: number;
+    get schedule(): string | undefined;
+    run(): Promise<void>;
+}

package/dist/types/jobs/SegmentRefreshJob.d.ts

@@ -0,0 +1,16 @@
+import { Segment } from "../models/types.js";
+import { CrmJobBase } from "./CrmJobBase.js";
+/**
+ * Keeps dynamic segments current: every run refreshes (`refreshSegment()`) the segments last refreshed longer than
+ * `mail:crm:jobs:segments:refresh_seconds` ago, oldest first. A segment is claimed by stamping its `refreshedAt` (version-checked), so
+ * replicas share the work without refreshing one segment twice. `membersChanged()` is told who entered and left.
+ */
+export declare abstract class SegmentRefreshJob extends CrmJobBase {
+    protected scheduleExpr: string;
+    protected refreshSeconds: number;
+    protected batchSize: number;
+    get schedule(): string | undefined;
+    run(): Promise<void>;
+    /** Records who entered and left a segment in a refresh, for automations. */
+    protected membersChanged(segment: Segment, entered: string[], left: string[]): Promise<void>;
+}

package/dist/types/jobs/SendDispatchJob.d.ts

@@ -0,0 +1,52 @@
+import { RateLimiter } from "@rapidrest/service-core";
+import type { MailTransport } from "@rapidmx/restapi";
+import { CrmJobBase } from "./CrmJobBase.js";
+/** How long a stopped workspace's messages wait before they are looked at again. */
+export declare const STOPPED_RETRY_MS: number;
+/**
+ * Sends queued campaign messages (`OutboundSend`s the `CampaignJob` created): renders each for its contact (`CampaignRenderer`) and
+ * hands it to the mail transport.
+ *
+ * - **Throughput** is capped across replicas at `mail:crm:send_rate_per_minute` (a shared `RateLimiter` counter); a run stops at the cap
+ * and the next carries on.
+ * - **One replica per message**: a message is claimed with a version-checked update that leases it; a replica that dies mid-send
+ * leaves the lease to run out, and the message is sent again (at least once).
+ * - **Last-moment checks**: a message whose contact has gone, unsubscribed from the campaign's lists or all email, bounced or was
+ * suppressed since is `suppressed`, not sent. A paused campaign's messages wait; a cancelled one's are dropped. A workspace whose
+ * sending an administrator stopped (`Workspace.sendingDisabled`) keeps its messages queued, looked at again every `STOPPED_RETRY_MS`.
+ * - **Failures**: a temporary refusal is retried with backoff (up to `max_attempts`); a permanent one fails the message, and a
+ * refusal of the address itself (a `5.1.x` status) counts as a hard bounce - suppressing it.
+ */
+export declare abstract class SendDispatchJob extends CrmJobBase {
+    protected mailTransport?: MailTransport;
+    protected rateLimiter?: RateLimiter;
+    protected scheduleExpr: string;
+    protected batchSize: number;
+    protected leaseSeconds: number;
+    protected maxAttempts: number;
+    protected ratePerMinute: number;
+    protected verp: boolean;
+    get schedule(): string | undefined;
+    run(): Promise<void>;
+    /** Whether an administrator stopped the workspace's sending. */
+    private sendingStopped;
+    /** Sends one message if it may go. `false` stops the run (the rate cap was reached). */
+    private dispatch;
+    /**
+     * What `send` was sent for, as a campaign: its campaign, or - for an automation's message - one made up of the message's own
+     * template and sender, tracked, and always going out. `undefined` when the campaign or automation is gone. Reads each once a run.
+     */
+    private sourceOf;
+    /** Takes `candidate` for this replica, or `undefined` when another took it first. */
+    private claim;
+    /**
+     * The contact of `send` if they may still be mailed: active, not suppressed, and still on one of the campaign's lists (an
+     * automation's message goes to its contact whatever their lists).
+     */
+    private eligibleContact;
+    /** A failed attempt: retried later with backoff while `temporary` and attempts remain, else the message fails. */
+    private failed;
+    /** Saves `changes` on a claimed message and releases its lease. */
+    private finish;
+    private recorder;
+}

package/dist/types/jobs/TaskReminderJob.d.ts

@@ -0,0 +1,12 @@
+import { CrmJobBase } from "./CrmJobBase.js";
+/**
+ * Reminds members of their tasks: once an open task with an assignee is due within `mail:crm:jobs:reminders:lead_minutes`, its
+ * assignee gets a `CrmTaskDue` push message (the web client shows it), once - the task is stamped `remindedAt` (version-checked, so
+ * one replica sends it). A task given a new due date or assignee is reminded again.
+ */
+export declare abstract class TaskReminderJob extends CrmJobBase {
+    protected scheduleExpr: string;
+    protected leadMinutes: number;
+    get schedule(): string | undefined;
+    run(): Promise<void>;
+}

package/dist/types/jobs/WebhookDeliveryJob.d.ts

@@ -0,0 +1,22 @@
+import { WebhookPoster } from "../webhooks/Webhooks.js";
+import { CrmJobBase } from "./CrmJobBase.js";
+/** Failed deliveries in a row after which an endpoint is switched off. */
+export declare const MAX_ENDPOINT_FAILURES = 20;
+/**
+ * Posts queued webhook deliveries: each is leased (version-checked), posted (`postWebhook()` - public addresses only, signed), and
+ * marked delivered on a 2xx answer. Anything else is retried with backoff (1, 2, 4... minutes) up to `max_attempts`, then failed. An
+ * endpoint that fails `MAX_ENDPOINT_FAILURES` deliveries in a row is switched off, its queued deliveries failed. Deliveries older than
+ * `retention_days` are deleted.
+ */
+export declare abstract class WebhookDeliveryJob extends CrmJobBase {
+    protected scheduleExpr: string;
+    protected maxAttempts: number;
+    protected retentionDays: number;
+    /** How a webhook is posted - a seam for tests. */
+    protected post: WebhookPoster;
+    get schedule(): string | undefined;
+    run(): Promise<void>;
+    /** Posts one delivery and records what came of it on it and its endpoint. Returns the endpoint as saved. */
+    private deliver;
+    private finish;
+}

package/dist/types/jobs/mongo/AutomationRunJobMongo.d.ts

@@ -0,0 +1,7 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { AutomationRunJob } from "../AutomationRunJob.js";
+/** `AutomationRunJob` on a Mongo deployment. */
+export declare class AutomationRunJobMongo extends AutomationRunJob {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+}

package/dist/types/jobs/mongo/AutomationTriggerJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { AutomationTriggerJob } from "../AutomationTriggerJob.js";
+/** `AutomationTriggerJob` on a Mongo deployment. */
+export declare class AutomationTriggerJobMongo extends AutomationTriggerJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/CampaignJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { CampaignJob } from "../CampaignJob.js";
+/** `CampaignJob` on a Mongo deployment. */
+export declare class CampaignJobMongo extends CampaignJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/CrmImportJobMongo.d.ts

@@ -0,0 +1,8 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { CrmImportJob } from "../CrmImportJob.js";
+/** `CrmImportJob` on a Mongo deployment. */
+export declare class CrmImportJobMongo extends CrmImportJob {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+    protected companyRouteClass: any;
+}

package/dist/types/jobs/mongo/CrmMailEventJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { CrmMailEventJob } from "../CrmMailEventJob.js";
+/** `CrmMailEventJob` on a Mongo deployment. */
+export declare class CrmMailEventJobMongo extends CrmMailEventJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/DateTriggerJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { DateTriggerJob } from "../DateTriggerJob.js";
+/** `DateTriggerJob` on a Mongo deployment. */
+export declare class DateTriggerJobMongo extends DateTriggerJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/ScoringJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { ScoringJob } from "../ScoringJob.js";
+/** `ScoringJob` on a Mongo deployment. */
+export declare class ScoringJobMongo extends ScoringJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/SegmentRefreshJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { SegmentRefreshJob } from "../SegmentRefreshJob.js";
+/** `SegmentRefreshJob` on a Mongo deployment. */
+export declare class SegmentRefreshJobMongo extends SegmentRefreshJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/SendDispatchJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { SendDispatchJob } from "../SendDispatchJob.js";
+/** `SendDispatchJob` on a Mongo deployment. */
+export declare class SendDispatchJobMongo extends SendDispatchJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/TaskReminderJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { TaskReminderJob } from "../TaskReminderJob.js";
+/** `TaskReminderJob` on a Mongo deployment. */
+export declare class TaskReminderJobMongo extends TaskReminderJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/mongo/WebhookDeliveryJobMongo.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { WebhookDeliveryJob } from "../WebhookDeliveryJob.js";
+/** `WebhookDeliveryJob` on a Mongo deployment. */
+export declare class WebhookDeliveryJobMongo extends WebhookDeliveryJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/AutomationRunJobSQL.d.ts

@@ -0,0 +1,7 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { AutomationRunJob } from "../AutomationRunJob.js";
+/** `AutomationRunJob` on a SQL deployment. */
+export declare class AutomationRunJobSQL extends AutomationRunJob {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+}

package/dist/types/jobs/sql/AutomationTriggerJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { AutomationTriggerJob } from "../AutomationTriggerJob.js";
+/** `AutomationTriggerJob` on a SQL deployment. */
+export declare class AutomationTriggerJobSQL extends AutomationTriggerJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/CampaignJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { CampaignJob } from "../CampaignJob.js";
+/** `CampaignJob` on a SQL deployment. */
+export declare class CampaignJobSQL extends CampaignJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/CrmImportJobSQL.d.ts

@@ -0,0 +1,8 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { CrmImportJob } from "../CrmImportJob.js";
+/** `CrmImportJob` on a SQL deployment. */
+export declare class CrmImportJobSQL extends CrmImportJob {
+    protected classes: CrmModelClasses;
+    protected contactRouteClass: any;
+    protected companyRouteClass: any;
+}

package/dist/types/jobs/sql/CrmMailEventJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { CrmMailEventJob } from "../CrmMailEventJob.js";
+/** `CrmMailEventJob` on a SQL deployment. */
+export declare class CrmMailEventJobSQL extends CrmMailEventJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/DateTriggerJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { DateTriggerJob } from "../DateTriggerJob.js";
+/** `DateTriggerJob` on a SQL deployment. */
+export declare class DateTriggerJobSQL extends DateTriggerJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/ScoringJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { ScoringJob } from "../ScoringJob.js";
+/** `ScoringJob` on a SQL deployment. */
+export declare class ScoringJobSQL extends ScoringJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/SegmentRefreshJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { SegmentRefreshJob } from "../SegmentRefreshJob.js";
+/** `SegmentRefreshJob` on a SQL deployment. */
+export declare class SegmentRefreshJobSQL extends SegmentRefreshJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/SendDispatchJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { SendDispatchJob } from "../SendDispatchJob.js";
+/** `SendDispatchJob` on a SQL deployment. */
+export declare class SendDispatchJobSQL extends SendDispatchJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/TaskReminderJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { TaskReminderJob } from "../TaskReminderJob.js";
+/** `TaskReminderJob` on a SQL deployment. */
+export declare class TaskReminderJobSQL extends TaskReminderJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/jobs/sql/WebhookDeliveryJobSQL.d.ts

@@ -0,0 +1,6 @@
+import type { CrmModelClasses } from "../../models/CrmModelClasses.js";
+import { WebhookDeliveryJob } from "../WebhookDeliveryJob.js";
+/** `WebhookDeliveryJob` on a SQL deployment. */
+export declare class WebhookDeliveryJobSQL extends WebhookDeliveryJob {
+    protected classes: CrmModelClasses;
+}

package/dist/types/models/CrmModelClasses.d.ts

@@ -0,0 +1,63 @@
+import { BaseEntity, ObjectFactory, type RepoFindOptions, RepoUtils, SimpleEntity } from "@rapidrest/service-core";
+/**
+ * The concrete (Mongo or SQL) class of every model the CRM routes and jobs read and write - `MONGO_MODELS` or `SQL_MODELS`. A route or
+ * job is backend-agnostic code plus one of these, so its concrete subclasses are one line each.
+ */
+export interface CrmModelClasses {
+    workspace: any;
+    workspaceMember: any;
+    workspaceSender: any;
+    contact: any;
+    company: any;
+    propertyDefinition: any;
+    propertyValue: any;
+    note: any;
+    task: any;
+    timelineEvent: any;
+    import: any;
+    mailingList: any;
+    subscription: any;
+    suppression: any;
+    form: any;
+    setting: any;
+    template: any;
+    savedBlock: any;
+    campaign: any;
+    outboundSend: any;
+    engagementEvent: any;
+    segment: any;
+    scoringRule: any;
+    automation: any;
+    automationVersion: any;
+    enrollment: any;
+    crmEvent: any;
+    pipeline: any;
+    deal: any;
+    webhookEndpoint: any;
+    webhookDelivery: any;
+    apiKey: any;
+    /** `@rapidmx/restapi`'s `Mailbox`. */
+    mailbox: any;
+}
+/** The name of one of `CrmModelClasses`. */
+export type CrmModelName = keyof CrmModelClasses;
+/**
+ * `RepoUtils` whose `find()` pages the same way on both backends. On MongoDB `RepoUtils.find()` takes the page size from its options'
+ * `limit`, but on SQL from the *query's* `limit` (falling back to 100) - so a caller paging by the options alone silently got 100 rows
+ * a page on SQL. This copies the options' `limit` into the query when the query has none.
+ *
+ * It also makes every sorted query's order total by adding `uid` as a last sort key, so records with equal sort values (created in the
+ * same millisecond, the same score) come back in the same order on every page instead of repeating or going missing between pages.
+ */
+export declare class CrmRepoUtils<T extends BaseEntity | SimpleEntity> extends RepoUtils<T> {
+    find(query: any, options?: RepoFindOptions): Promise<T[]>;
+}
+/** Creates (once each, on first use) the `RepoUtils` (`CrmRepoUtils`) of every model in a `CrmModelClasses`. */
+export declare class CrmRepos {
+    private readonly objectFactory;
+    readonly classes: CrmModelClasses;
+    private readonly repos;
+    constructor(objectFactory: ObjectFactory, classes: CrmModelClasses);
+    /** The `RepoUtils` of `name`'s model. */
+    get<T = any>(name: CrmModelName): Promise<RepoUtils<T & any>>;
+}

package/dist/types/models/mongo/ApiKeyMongo.d.ts

@@ -0,0 +1,19 @@
+import { BaseMongoEntity } from "@rapidrest/service-core";
+import { ApiKey, ApiKeyScope } from "../types.js";
+/**
+ * Implementation of the `ApiKey` interface for storage in a MongoDB database. If SQL is desired, please use
+ * `models.sql.ApiKeySQL` instead.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class ApiKeyMongo extends BaseMongoEntity implements ApiKey {
+    workspaceUid: string;
+    name: string;
+    prefix: string;
+    hash: string;
+    scopes: ApiKeyScope[];
+    lastUsedAt?: Date;
+    revokedAt?: Date;
+    createdByUserUid: string;
+    constructor(other?: Partial<ApiKeyMongo>);
+}

package/dist/types/models/mongo/AutomationMongo.d.ts

@@ -0,0 +1,22 @@
+import { BaseMongoEntity } from "@rapidrest/service-core";
+import { Automation, AutomationReentry, AutomationStatus } from "../types.js";
+/**
+ * Implementation of the `Automation` interface for storage in a MongoDB database. If SQL is desired, please use
+ * `models.sql.AutomationSQL` instead.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class AutomationMongo extends BaseMongoEntity implements Automation {
+    workspaceUid: string;
+    name: string;
+    description?: string;
+    status: AutomationStatus;
+    graph: unknown;
+    reentry: AutomationReentry;
+    goalFilter?: unknown;
+    publishedVersionUid?: string;
+    publishedAt?: Date;
+    createdByUserUid: string;
+    dateCheckedOn?: string;
+    constructor(other?: Partial<AutomationMongo>);
+}

package/dist/types/models/mongo/AutomationVersionMongo.d.ts

@@ -0,0 +1,16 @@
+import { BaseMongoEntity } from "@rapidrest/service-core";
+import { AutomationVersion } from "../types.js";
+/**
+ * Implementation of the `AutomationVersion` interface for storage in a MongoDB database. If SQL is desired, please use
+ * `models.sql.AutomationVersionSQL` instead.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export declare class AutomationVersionMongo extends BaseMongoEntity implements AutomationVersion {
+    workspaceUid: string;
+    automationUid: string;
+    versionNumber: number;
+    graph: unknown;
+    publishedByUserUid: string;
+    constructor(other?: Partial<AutomationVersionMongo>);
+}