@listmonk-ops/automation

High-level operational workflows on top of @listmonk-ops/openapi.

This package is designed for automation and orchestration use-cases:

• campaign preflight checks
• deliverability guard evaluation
• template registry sync/promotion/rollback
• segment drift snapshot and comparison
• subscriber hygiene targeting
• daily digest generation

Installation

npm install @listmonk-ops/automation @listmonk-ops/openapi

Quick Start

import {
	createListmonkClient,
	createListmonkClientFromEnv,
} from "@listmonk-ops/openapi";
import {
	runCampaignPreflight,
	evaluateDeliverabilityGuard,
	generateDailyDigest,
} from "@listmonk-ops/automation";

const client =
	process.env.LISTMONK_URL && process.env.LISTMONK_USERNAME
		? createListmonkClientFromEnv()
		: createListmonkClient({
				baseUrl: "http://localhost:9000",
				username: "admin",
				password: "listmonk",
			});

const preflight = await runCampaignPreflight(client, 42, {
	checkLinks: true,
	maxAudience: 150_000,
});

const guard = await evaluateDeliverabilityGuard(client, preflight, {
	maxFailChecks: 0,
	maxWarnChecks: 2,
	requireAllPassChecks: ["subject_present", "body_present", "target_lists"],
});

const digest = await generateDailyDigest(client);

console.log(preflight.summary, guard.allowLaunch, digest.generatedAt);

Persistent Store Paths

Default local stores are under ~/.listmonk-ops/ops.

• LISTMONK_OPS_SEGMENT_STORE: override segment drift snapshot store path
• LISTMONK_OPS_TEMPLATE_REGISTRY: override template registry store path

Call getOpsStorePaths() to inspect resolved paths.