@mailmodo/cli 0.0.2-beta.pr4.6 → 0.0.3-beta.pr5.7

package/dist/commands/billing/index.d.ts

@@ -0,0 +1,26 @@
+import { BaseCommand } from '../../lib/base-command.js';
+export default class Billing extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        cap: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        status: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    /**
+     * Retrieves and displays the current billing status including card info,
+     * block usage, spending total, AI generation limits, and optionally
+     * opens Stripe Checkout if no card is on file.
+     */
+    private showStatus;
+    /**
+     * Updates the monthly block spending cap. This limits how many 10k-email
+     * blocks will be auto-charged per billing cycle.
+     *
+     * @param {number} cap - The maximum number of blocks per month.
+     * @param {boolean} jsonOutput - Whether to output JSON instead of formatted text.
+     */
+    private setCap;
+}

package/dist/commands/billing/index.js

@@ -0,0 +1,92 @@
+import { Flags } from '@oclif/core';
+import chalk from 'chalk';
+import open from 'open';
+import { BaseCommand } from '../../lib/base-command.js';
+import { API_ENDPOINTS } from '../../lib/constants.js';
+export default class Billing extends BaseCommand {
+    static description = 'View billing status, manage payment, and set spending cap';
+    static examples = [
+        '<%= config.bin %> billing',
+        '<%= config.bin %> billing --status',
+        '<%= config.bin %> billing --cap 5',
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        cap: Flags.integer({ description: 'Set monthly block cap (max blocks to auto-charge)' }),
+        status: Flags.boolean({ default: false, description: 'Show billing status only' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Billing);
+        await this.ensureAuth();
+        if (flags.cap !== undefined) {
+            await this.setCap(flags.cap, flags.json);
+            return;
+        }
+        await this.showStatus(flags.json);
+    }
+    /**
+     * Retrieves and displays the current billing status including card info,
+     * block usage, spending total, AI generation limits, and optionally
+     * opens Stripe Checkout if no card is on file.
+     */
+    async showStatus(jsonOutput) {
+        const response = await this.apiClient.get(API_ENDPOINTS.BILLING_STATUS);
+        if (!response.ok) {
+            this.handleApiError(response);
+        }
+        const { data } = response;
+        if (jsonOutput) {
+            this.log(JSON.stringify(data, null, 2));
+            return;
+        }
+        this.log('');
+        if (data.cardOnFile) {
+            this.log(`  Card:         ${data.cardSummary || 'Card on file'}`);
+        }
+        else {
+            this.log(`  Card:         ${chalk.yellow('No card on file')}`);
+        }
+        if (data.freeExhausted) {
+            this.log(`  Free tier:    ${chalk.dim('exhausted')}`);
+        }
+        else {
+            this.log(`  Free tier:    active`);
+        }
+        this.log(`  Current block: ${data.currentBlockUsed ?? 0} / 10,000 used`);
+        this.log(`  Blocks used:  ${data.blocksUsed ?? 0}  ($${data.totalSpent || '0'} total)`);
+        this.log(`  Monthly cap:  ${data.cap ?? 'not set'} blocks${data.cap ? ` ($${data.cap * 19} max/month)` : ''}`);
+        if (data.aiRemaining) {
+            this.log(`\n  AI generation:`);
+            this.log(`    Init uses remaining:  ${data.aiRemaining.inits}/5 this month`);
+            this.log(`    Edit uses remaining:  ${data.aiRemaining.edits}/50 this month`);
+        }
+        if (!data.cardOnFile && data.freeExhausted && data.checkoutUrl) {
+            this.log(`\n  ${chalk.yellow('Free tier exhausted.')} Opening payment page...\n`);
+            try {
+                await open(data.checkoutUrl);
+            }
+            catch {
+                this.log(`  Visit: ${chalk.cyan(data.checkoutUrl)}`);
+            }
+        }
+        this.log('');
+    }
+    /**
+     * Updates the monthly block spending cap. This limits how many 10k-email
+     * blocks will be auto-charged per billing cycle.
+     *
+     * @param {number} cap - The maximum number of blocks per month.
+     * @param {boolean} jsonOutput - Whether to output JSON instead of formatted text.
+     */
+    async setCap(cap, jsonOutput) {
+        const response = await this.apiClient.patch(API_ENDPOINTS.BILLING_CAP, { cap });
+        if (!response.ok) {
+            this.handleApiError(response);
+        }
+        if (jsonOutput) {
+            this.log(JSON.stringify({ cap, maxMonthlySpend: `$${cap * 19}`, status: 'updated' }, null, 2));
+            return;
+        }
+        this.log(`\n  ${chalk.green('✓')} Cap set to ${chalk.bold(String(cap))} blocks ($${cap * 19} max/month).\n`);
+    }
+}

package/dist/commands/contacts/index.d.ts

@@ -0,0 +1,32 @@
+import { BaseCommand } from '../../lib/base-command.js';
+export default class Contacts extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        delete: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        export: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        search: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    /**
+     * Displays aggregate contact counts: total, active, unsubscribed, bounced.
+     */
+    private showSummary;
+    /**
+     * Looks up a single contact by email address and displays their
+     * status, properties, and pending emails.
+     */
+    private searchContact;
+    /**
+     * Triggers a CSV export of all contacts. The API returns a download URL
+     * for the generated file.
+     */
+    private exportContacts;
+    /**
+     * Performs a GDPR-compliant hard delete of a contact and all their
+     * send history. Requires confirmation unless --yes flag is used.
+     */
+    private deleteContact;
+}

package/dist/commands/contacts/index.js

@@ -0,0 +1,134 @@
+import { Flags } from '@oclif/core';
+import { confirm } from '@inquirer/prompts';
+import chalk from 'chalk';
+import { BaseCommand } from '../../lib/base-command.js';
+import { API_ENDPOINTS } from '../../lib/constants.js';
+export default class Contacts extends BaseCommand {
+    static description = 'Manage contacts — search, export, or delete';
+    static examples = [
+        '<%= config.bin %> contacts',
+        '<%= config.bin %> contacts --search sarah@example.com',
+        '<%= config.bin %> contacts --export',
+        '<%= config.bin %> contacts --delete sarah@example.com',
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        delete: Flags.string({ description: 'GDPR hard delete a contact by email' }),
+        export: Flags.boolean({ default: false, description: 'Export all contacts as CSV' }),
+        search: Flags.string({ description: 'Search for a contact by email' }),
+    };
+    async run() {
+        const { flags } = await this.parse(Contacts);
+        await this.ensureAuth();
+        if (flags.search) {
+            await this.searchContact(flags.search, flags.json);
+            return;
+        }
+        if (flags.export) {
+            await this.exportContacts(flags.json);
+            return;
+        }
+        if (flags.delete) {
+            await this.deleteContact(flags.delete, flags.json, flags.yes);
+            return;
+        }
+        await this.showSummary(flags.json);
+    }
+    /**
+     * Displays aggregate contact counts: total, active, unsubscribed, bounced.
+     */
+    async showSummary(jsonOutput) {
+        const response = await this.apiClient.get(API_ENDPOINTS.CONTACTS);
+        if (!response.ok) {
+            this.handleApiError(response);
+        }
+        const { data } = response;
+        if (jsonOutput) {
+            this.log(JSON.stringify(data, null, 2));
+            return;
+        }
+        this.log(`\n  Total: ${chalk.bold(String(data.total ?? 0))}  ` +
+            `Active: ${chalk.green(String(data.active ?? 0))}  ` +
+            `Unsubscribed: ${chalk.yellow(String(data.unsubscribed ?? 0))}  ` +
+            `Bounced: ${chalk.red(String(data.bounced ?? 0))}\n`);
+    }
+    /**
+     * Looks up a single contact by email address and displays their
+     * status, properties, and pending emails.
+     */
+    async searchContact(email, jsonOutput) {
+        const response = await this.apiClient.get(`${API_ENDPOINTS.CONTACTS}/${encodeURIComponent(email)}`);
+        if (!response.ok) {
+            if (response.status === 404) {
+                if (jsonOutput) {
+                    this.log(JSON.stringify({ email, error: 'Contact not found' }, null, 2));
+                }
+                else {
+                    this.log(`\n  Contact '${email}' not found.\n`);
+                }
+                return;
+            }
+            this.handleApiError(response);
+        }
+        const contact = response.data;
+        if (jsonOutput) {
+            this.log(JSON.stringify(contact, null, 2));
+            return;
+        }
+        this.log(`\n  ${chalk.bold('Email:')}       ${contact.email}`);
+        this.log(`  ${chalk.bold('Status:')}      ${contact.status}`);
+        this.log(`  ${chalk.bold('Added:')}       ${contact.added}`);
+        this.log(`  ${chalk.bold('Next email:')}  ${contact.nextEmail || 'None'}`);
+        if (contact.properties && Object.keys(contact.properties).length > 0) {
+            this.log(`  ${chalk.bold('Properties:')}`);
+            for (const [key, value] of Object.entries(contact.properties)) {
+                this.log(`    ${key}: ${String(value)}`);
+            }
+        }
+        this.log('');
+    }
+    /**
+     * Triggers a CSV export of all contacts. The API returns a download URL
+     * for the generated file.
+     */
+    async exportContacts(jsonOutput) {
+        const response = await this.apiClient.get(API_ENDPOINTS.CONTACTS_EXPORT);
+        if (!response.ok) {
+            this.handleApiError(response);
+        }
+        if (jsonOutput) {
+            this.log(JSON.stringify(response.data, null, 2));
+            return;
+        }
+        this.log(`\n  ${chalk.green('✓')} Contact export started.`);
+        if (response.data?.downloadUrl) {
+            this.log(`  Download: ${chalk.cyan(response.data.downloadUrl)}`);
+        }
+        this.log('');
+    }
+    /**
+     * Performs a GDPR-compliant hard delete of a contact and all their
+     * send history. Requires confirmation unless --yes flag is used.
+     */
+    async deleteContact(email, jsonOutput, skipConfirm) {
+        if (!skipConfirm) {
+            const confirmed = await confirm({
+                default: false,
+                message: `Permanently delete ${email} and all their data? This cannot be undone.`,
+            });
+            if (!confirmed) {
+                this.log('\n  Delete cancelled.\n');
+                return;
+            }
+        }
+        const response = await this.apiClient.delete(`${API_ENDPOINTS.CONTACTS}/${encodeURIComponent(email)}`);
+        if (!response.ok) {
+            this.handleApiError(response);
+        }
+        if (jsonOutput) {
+            this.log(JSON.stringify({ deleted: true, email }, null, 2));
+            return;
+        }
+        this.log(`\n  ${chalk.green('✓')} Contact ${email} permanently deleted.\n`);
+    }
+}

package/dist/commands/deploy/index.d.ts

@@ -0,0 +1,25 @@
+import { BaseCommand } from '../../lib/base-command.js';
+export default class Deploy extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    /**
+     * Interactive domain setup flow. Collects domain, sender email, and business
+     * address from the user, then calls the API to get DNS records to configure.
+     * Polls for verification when the user indicates they've added the records.
+     *
+     * @returns {Promise<boolean>} true if domain was verified, false if skipped.
+     */
+    private runDomainSetup;
+    /**
+     * Calls the domain verification API endpoint and reports pass/fail
+     * status for each DNS record (SPF, DKIM, DMARC).
+     *
+     * @returns {Promise<boolean>} true if all records pass.
+     */
+    private verifyDomain;
+}

package/dist/commands/deploy/index.js

@@ -0,0 +1,194 @@
+import { confirm, input } from '@inquirer/prompts';
+import chalk from 'chalk';
+import { BaseCommand } from '../../lib/base-command.js';
+import { API_ENDPOINTS, DNS_GUIDE_URL } from '../../lib/constants.js';
+import { saveYaml } from '../../lib/yaml-config.js';
+export default class Deploy extends BaseCommand {
+    static description = 'Deploy email sequences and verify sending domain';
+    static examples = [
+        '<%= config.bin %> deploy',
+        '<%= config.bin %> deploy --yes',
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+    };
+    async run() {
+        const { flags } = await this.parse(Deploy);
+        await this.ensureAuth();
+        const yamlConfig = await this.ensureYaml();
+        const domainVerify = await this.apiClient.get(API_ENDPOINTS.DOMAIN_VERIFY);
+        const domainVerified = domainVerify.ok &&
+            domainVerify.data?.spf === 'pass' &&
+            domainVerify.data?.dkim === 'pass' &&
+            domainVerify.data?.dmarc === 'pass';
+        if (!domainVerified) {
+            if (!flags.json) {
+                this.log(`\n  No sending domain verified yet.`);
+                this.log(`  You need to verify a domain before sending emails.`);
+                this.log(`  This is a one-time setup. Takes about 5 minutes.\n`);
+            }
+            if (!flags.yes) {
+                const setupNow = await confirm({ default: true, message: 'Set up your sending domain now?' });
+                if (!setupNow) {
+                    this.log(`\n  Sequences saved but ${chalk.yellow('NOT deployed')}.`);
+                    this.log(`  Emails will not send until your domain is verified.`);
+                    this.log(`  When ready, run: ${chalk.cyan('mailmodo domain')}`);
+                    this.log(`  Then: ${chalk.cyan('mailmodo deploy')}\n`);
+                    return;
+                }
+            }
+            const completed = await this.runDomainSetup(yamlConfig, flags);
+            if (!completed)
+                return;
+        }
+        if (!flags.json) {
+            this.log(`\n  ${chalk.green('✓')} Domain: ${yamlConfig.project?.domain || 'verified'}\n`);
+            this.log(`  Deploying:`);
+            for (const email of yamlConfig.emails) {
+                this.log(`  ${chalk.green('+')} ${email.id.padEnd(24)} ${email.trigger}`);
+            }
+            this.log('');
+        }
+        if (!flags.yes) {
+            const proceed = await confirm({
+                default: true,
+                message: `Deploy ${yamlConfig.emails.length} emails?`,
+            });
+            if (!proceed) {
+                this.log('\n  Deploy cancelled.\n');
+                return;
+            }
+        }
+        const response = await this.apiClient.post(API_ENDPOINTS.SEQUENCES, {
+            emails: yamlConfig.emails,
+            project: yamlConfig.project,
+        });
+        if (!response.ok) {
+            this.handleApiError(response);
+        }
+        if (flags.json) {
+            this.log(JSON.stringify({
+                deployed: true,
+                emailsLive: yamlConfig.emails.length,
+                sdkSnippet: response.data?.sdkSnippet,
+            }, null, 2));
+            return;
+        }
+        this.log(`  ${chalk.green('Deployed.')} Emails are live.\n`);
+        this.log(`  ${'─'.repeat(53)}`);
+        this.log(`  ${chalk.bold('ADD THIS TO YOUR APP (one-time only):')}`);
+        this.log(`  ${'─'.repeat(53)}\n`);
+        this.log(`  ${chalk.cyan('npm install @mailmodo/sdk')}\n`);
+        this.log(`  ${chalk.dim("import { track, identify } from '@mailmodo/sdk'")}\n`);
+        this.log(`  ${chalk.dim('// On user signup:')}`);
+        this.log(`  ${chalk.dim("track('user.signup', { email, first_name, app_url })")}\n`);
+        this.log(`  ${chalk.dim('// When user creates a project:')}`);
+        this.log(`  ${chalk.dim("identify(email, { has_created_project: true })")}\n`);
+        this.log(`  ${chalk.dim('// On trial expiry:')}`);
+        this.log(`  ${chalk.dim("track('user.trial_expiry', { email, first_name })")}\n`);
+        this.log(`  Full SDK docs: ${chalk.cyan('mailmodo.com/docs/sdk')}\n`);
+        this.log(`  ${'─'.repeat(53)}\n`);
+    }
+    /**
+     * Interactive domain setup flow. Collects domain, sender email, and business
+     * address from the user, then calls the API to get DNS records to configure.
+     * Polls for verification when the user indicates they've added the records.
+     *
+     * @returns {Promise<boolean>} true if domain was verified, false if skipped.
+     */
+    async runDomainSetup(yamlConfig, flags) {
+        let domain;
+        let senderEmail;
+        let address;
+        if (flags.yes) {
+            domain = yamlConfig.project?.domain || '';
+            senderEmail = yamlConfig.project?.fromEmail || '';
+            address = yamlConfig.project?.address || '';
+        }
+        else {
+            this.log(`\n  ${'─'.repeat(53)}`);
+            this.log(`  ${chalk.bold('DOMAIN SETUP')}`);
+            this.log(`  ${'─'.repeat(53)}\n`);
+            domain = await input({
+                message: 'What domain will you send from?',
+                validate: (v) => (v?.trim() ? true : 'Domain is required'),
+            });
+            senderEmail = await input({
+                message: 'Sender email address:',
+                validate: (v) => (v?.includes('@') ? true : 'Please enter a valid email'),
+            });
+            address = await input({
+                message: 'Business address (required by law for email footers):',
+                validate: (v) => (v?.trim() ? true : 'Address is required'),
+            });
+        }
+        const domainResponse = await this.apiClient.post(API_ENDPOINTS.DOMAIN, {
+            address,
+            domain,
+            fromEmail: senderEmail,
+        });
+        if (!domainResponse.ok) {
+            this.handleApiError(domainResponse);
+        }
+        yamlConfig.project.domain = domain;
+        yamlConfig.project.fromEmail = senderEmail;
+        yamlConfig.project.address = address;
+        await saveYaml(yamlConfig);
+        const dnsRecords = domainResponse.data?.dnsRecords || [];
+        if (!flags.json) {
+            this.log(`\n  Add these ${dnsRecords.length} DNS records to your domain provider:\n`);
+            for (const [i, record] of dnsRecords.entries()) {
+                this.log(`  ${chalk.bold(`RECORD ${i + 1}`)}`);
+                this.log(`  Type:   ${record.type}`);
+                this.log(`  Host:   ${record.host}`);
+                this.log(`  Value:  ${record.value}\n`);
+            }
+            this.log(`  DNS changes take 5–30 minutes to propagate.`);
+            this.log(`  Full guide: ${chalk.cyan(DNS_GUIDE_URL)}\n`);
+        }
+        if (flags.yes) {
+            return this.verifyDomain(flags.json);
+        }
+        const action = await input({
+            default: '',
+            message: "Press Enter once you've added the records, or 'skip' to do this later.",
+        });
+        if (action.toLowerCase() === 'skip') {
+            this.log(`\n  Sequences saved but ${chalk.yellow('NOT deployed')}.`);
+            this.log(`  When ready, run: ${chalk.cyan('mailmodo domain')}`);
+            this.log(`  Then: ${chalk.cyan('mailmodo deploy')}\n`);
+            return false;
+        }
+        return this.verifyDomain(flags.json);
+    }
+    /**
+     * Calls the domain verification API endpoint and reports pass/fail
+     * status for each DNS record (SPF, DKIM, DMARC).
+     *
+     * @returns {Promise<boolean>} true if all records pass.
+     */
+    async verifyDomain(jsonOutput) {
+        if (!jsonOutput) {
+            this.log(`\n  Checking DNS...`);
+        }
+        const verify = await this.apiClient.get(API_ENDPOINTS.DOMAIN_VERIFY);
+        if (!verify.ok) {
+            this.handleApiError(verify);
+        }
+        const { dkim, dmarc, spf } = verify.data;
+        const allPassed = spf === 'pass' && dkim === 'pass' && dmarc === 'pass';
+        if (!jsonOutput) {
+            this.log(`  SPF    ${spf === 'pass' ? chalk.green('✓') : chalk.red('✗')}`);
+            this.log(`  DKIM   ${dkim === 'pass' ? chalk.green('✓') : chalk.red('✗')}`);
+            this.log(`  DMARC  ${dmarc === 'pass' ? chalk.green('✓') : chalk.red('✗')}`);
+            if (allPassed) {
+                this.log(`\n  ${chalk.green('Domain verified.')} Continuing deploy...\n`);
+            }
+            else {
+                this.log(`\n  ${chalk.yellow('Some records failed.')} Fix them and run ${chalk.cyan('mailmodo domain --verify')}.`);
+                this.log(`  Help: ${chalk.cyan(DNS_GUIDE_URL)}\n`);
+            }
+        }
+        return allPassed;
+    }
+}

package/dist/commands/domain/index.d.ts

@@ -0,0 +1,27 @@
+import { BaseCommand } from '../../lib/base-command.js';
+export default class Domain extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        status: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        verify: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    /**
+     * Interactive domain setup: collects domain, sender email, and business address,
+     * then calls the API to retrieve the required DNS records.
+     */
+    private setupDomain;
+    /**
+     * Calls the domain verification API and displays pass/fail for each DNS record.
+     */
+    private verifyDomain;
+    /**
+     * Displays domain health metrics including verification status,
+     * bounce rate, and spam complaint rate.
+     */
+    private showDomainStatus;
+    private recordLabel;
+}