@mailmodo/cli 0.0.48 → 0.0.49-beta.pr51.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/commands/edit/index.js +1 -0
- package/dist/commands/init/index.d.ts +1 -0
- package/dist/commands/init/index.js +10 -6
- package/dist/commands/logs/index.js +2 -1
- package/dist/lib/base-command.d.ts +24 -0
- package/dist/lib/base-command.js +30 -1
- package/dist/lib/messages.d.ts +27 -0
- package/dist/lib/messages.js +57 -0
- package/oclif.manifest.json +54 -54
- package/package.json +1 -1
|
@@ -49,6 +49,7 @@ export default class Edit extends BaseCommand {
|
|
|
49
49
|
async runEditStep(ctx, changeDescription, flags) {
|
|
50
50
|
const response = await this.withApiSpinner({ json: flags.json, text: ' Applying AI edits...' }, () => this.callEditApi(changeDescription, ctx.email, ctx.templateHtml));
|
|
51
51
|
if (!response.ok) {
|
|
52
|
+
this.handleAiQuotaError(response, 'edit');
|
|
52
53
|
this.handleApiError(response);
|
|
53
54
|
}
|
|
54
55
|
const updated = response.data;
|
|
@@ -64,6 +64,7 @@ export default class Init extends BaseCommand {
|
|
|
64
64
|
url: productUrl,
|
|
65
65
|
}));
|
|
66
66
|
if (!analysisResponse.ok) {
|
|
67
|
+
this.handleAiQuotaError(analysisResponse, 'init');
|
|
67
68
|
this.handleApiError(analysisResponse);
|
|
68
69
|
}
|
|
69
70
|
const analysis = analysisResponse.data;
|
|
@@ -154,12 +155,7 @@ export default class Init extends BaseCommand {
|
|
|
154
155
|
},
|
|
155
156
|
};
|
|
156
157
|
await saveYaml(yamlConfig);
|
|
157
|
-
|
|
158
|
-
const monthlyCap = billingStatus?.cap?.inBlocks;
|
|
159
|
-
if (monthlyCap !== null && monthlyCap !== undefined) {
|
|
160
|
-
yamlConfig.project.monthlyCap = monthlyCap;
|
|
161
|
-
await saveYaml(yamlConfig);
|
|
162
|
-
}
|
|
158
|
+
await this.persistMonthlyCap(yamlConfig);
|
|
163
159
|
const templateSaves = analysisPayload.recommendedEmails.flatMap((rec, index) => {
|
|
164
160
|
const generated = generatedEmails[index];
|
|
165
161
|
const saves = [];
|
|
@@ -184,6 +180,14 @@ export default class Init extends BaseCommand {
|
|
|
184
180
|
this.log(` Created ${chalk.green('mailmodo.yaml')} + ${chalk.green(String(emailConfigs.length))} email templates in ${chalk.green('/mailmodo')}\n`);
|
|
185
181
|
this.log(` Run ${chalk.cyan("'mailmodo emails'")} to review.\n`);
|
|
186
182
|
}
|
|
183
|
+
async persistMonthlyCap(yamlConfig) {
|
|
184
|
+
const billingStatus = await this.fetchBillingStatus();
|
|
185
|
+
const monthlyCap = billingStatus?.cap?.inBlocks;
|
|
186
|
+
if (monthlyCap !== null && monthlyCap !== undefined) {
|
|
187
|
+
yamlConfig.project.monthlyCap = monthlyCap;
|
|
188
|
+
await saveYaml(yamlConfig);
|
|
189
|
+
}
|
|
190
|
+
}
|
|
187
191
|
async confirmOverwriteIfNeeded(flags) {
|
|
188
192
|
const existing = await loadYaml();
|
|
189
193
|
if (!existing)
|
|
@@ -57,7 +57,8 @@ export default class Logs extends BaseCommand {
|
|
|
57
57
|
const contact = entry.contact || '';
|
|
58
58
|
this.log(` ${time}${templateId}${status}${contact}`);
|
|
59
59
|
if (entry.reason) {
|
|
60
|
-
|
|
60
|
+
const label = entry.status === 'skipped' ? 'condition not met' : 'reason';
|
|
61
|
+
this.log(` ${' '.repeat(52)}${chalk.dim(`(${label}: ${entry.reason})`)}`);
|
|
61
62
|
}
|
|
62
63
|
}
|
|
63
64
|
const totalPages = Math.ceil(total / limit);
|
|
@@ -2,6 +2,11 @@ import { Command } from '@oclif/core';
|
|
|
2
2
|
import { ApiClient, type ApiRequestDebugInfo } from './api-client.js';
|
|
3
3
|
import { type MailmodoConfig } from './config.js';
|
|
4
4
|
import { type MailmodoYaml } from './yaml-config.js';
|
|
5
|
+
/**
|
|
6
|
+
* Kind of AI quota that was exhausted. Drives both the headline default
|
|
7
|
+
* message and the follow-up tip pointing the user at the next-best action.
|
|
8
|
+
*/
|
|
9
|
+
export type AiQuotaFeature = 'edit' | 'init';
|
|
5
10
|
export interface BillingCapUpdateResult {
|
|
6
11
|
autoChargeBlockCount?: number;
|
|
7
12
|
capBlocks: number;
|
|
@@ -76,6 +81,25 @@ export declare abstract class BaseCommand extends Command {
|
|
|
76
81
|
error?: string;
|
|
77
82
|
status: number;
|
|
78
83
|
}): never;
|
|
84
|
+
/**
|
|
85
|
+
* Intercepts a 429 "Monthly quota exhausted" response from an AI rate-limited
|
|
86
|
+
* endpoint (analyze for `init`, email edit for `edit`) and exits with a
|
|
87
|
+
* feature-specific message that includes the server's error text, the reset
|
|
88
|
+
* date, optional retry hint, and the next-best action. Returns without
|
|
89
|
+
* exiting when the response is not a 429 so callers can fall through to
|
|
90
|
+
* `handleApiError` for non-quota failures.
|
|
91
|
+
*
|
|
92
|
+
* @param {{ status: number; error?: string; data?: unknown; debug?: ApiRequestDebugInfo }} response - The failed API response.
|
|
93
|
+
* Must carry the parsed JSON body (`data`) so reset/retry fields can be surfaced.
|
|
94
|
+
* @param {AiQuotaFeature} feature - Which AI quota was hit. Drives the default headline + tip
|
|
95
|
+
* shown when the server omits an explicit `error` string.
|
|
96
|
+
*/
|
|
97
|
+
protected handleAiQuotaError(response: {
|
|
98
|
+
data?: unknown;
|
|
99
|
+
debug?: ApiRequestDebugInfo;
|
|
100
|
+
error?: string;
|
|
101
|
+
status: number;
|
|
102
|
+
}, feature: AiQuotaFeature): void;
|
|
79
103
|
protected collectDomainSetupInputs(yamlConfig: MailmodoYaml, skipPrompts: boolean): Promise<{
|
|
80
104
|
address: string;
|
|
81
105
|
domain: string;
|
package/dist/lib/base-command.js
CHANGED
|
@@ -5,7 +5,7 @@ import ora from 'ora';
|
|
|
5
5
|
import { ApiClient } from './api-client.js';
|
|
6
6
|
import { loadConfig } from './config.js';
|
|
7
7
|
import { API_ENDPOINTS } from './constants.js';
|
|
8
|
-
import { ERRORS, INFO, PROMPTS, recordLabel, VALIDATION } from './messages.js';
|
|
8
|
+
import { ERRORS, INFO, PROMPTS, quotaExhaustedMessage, recordLabel, VALIDATION, } from './messages.js';
|
|
9
9
|
import { loadYaml, saveYaml } from './yaml-config.js';
|
|
10
10
|
export const FREE_TIER = 'free';
|
|
11
11
|
/**
|
|
@@ -107,6 +107,35 @@ export class BaseCommand extends Command {
|
|
|
107
107
|
}
|
|
108
108
|
this.error(this.formatApiFailure(response.error || ERRORS.UNEXPECTED_API, response));
|
|
109
109
|
}
|
|
110
|
+
/**
|
|
111
|
+
* Intercepts a 429 "Monthly quota exhausted" response from an AI rate-limited
|
|
112
|
+
* endpoint (analyze for `init`, email edit for `edit`) and exits with a
|
|
113
|
+
* feature-specific message that includes the server's error text, the reset
|
|
114
|
+
* date, optional retry hint, and the next-best action. Returns without
|
|
115
|
+
* exiting when the response is not a 429 so callers can fall through to
|
|
116
|
+
* `handleApiError` for non-quota failures.
|
|
117
|
+
*
|
|
118
|
+
* @param {{ status: number; error?: string; data?: unknown; debug?: ApiRequestDebugInfo }} response - The failed API response.
|
|
119
|
+
* Must carry the parsed JSON body (`data`) so reset/retry fields can be surfaced.
|
|
120
|
+
* @param {AiQuotaFeature} feature - Which AI quota was hit. Drives the default headline + tip
|
|
121
|
+
* shown when the server omits an explicit `error` string.
|
|
122
|
+
*/
|
|
123
|
+
handleAiQuotaError(response, feature) {
|
|
124
|
+
if (response.status !== 429)
|
|
125
|
+
return;
|
|
126
|
+
const body = (response.data ?? {});
|
|
127
|
+
const isInit = feature === 'init';
|
|
128
|
+
const message = quotaExhaustedMessage({
|
|
129
|
+
defaultMessage: isInit
|
|
130
|
+
? ERRORS.QUOTA_INIT_DEFAULT
|
|
131
|
+
: ERRORS.QUOTA_EDIT_DEFAULT,
|
|
132
|
+
limitReset: body.limitReset,
|
|
133
|
+
retryAfter: body.retryAfter,
|
|
134
|
+
serverError: typeof body.error === 'string' ? body.error : undefined,
|
|
135
|
+
tip: isInit ? ERRORS.QUOTA_INIT_TIP : ERRORS.QUOTA_EDIT_TIP,
|
|
136
|
+
});
|
|
137
|
+
this.error(this.formatApiFailure(message, response));
|
|
138
|
+
}
|
|
110
139
|
async collectDomainSetupInputs(yamlConfig, skipPrompts) {
|
|
111
140
|
if (skipPrompts) {
|
|
112
141
|
const domain = yamlConfig.project?.domain || '';
|
package/dist/lib/messages.d.ts
CHANGED
|
@@ -19,6 +19,10 @@ export declare const ERRORS: {
|
|
|
19
19
|
readonly INVALID_API_KEY: `Invalid API key. Run ${string} to re-authenticate.`;
|
|
20
20
|
readonly NOT_LOGGED_IN: `Not logged in. Run ${string} to authenticate.`;
|
|
21
21
|
readonly NO_YAML: `No mailmodo.yaml found. Run ${string} first.`;
|
|
22
|
+
readonly QUOTA_EDIT_DEFAULT: "Edit limit reached for this month.";
|
|
23
|
+
readonly QUOTA_EDIT_TIP: "AI edits are limited to 50 per account per month. Manually edit the template file under ./mailmodo to make further changes.";
|
|
24
|
+
readonly QUOTA_INIT_DEFAULT: "Regeneration limit reached.";
|
|
25
|
+
readonly QUOTA_INIT_TIP: `Regenerations are limited to 5 per account per month. Run ${string} to modify individual emails instead.`;
|
|
22
26
|
readonly RATE_LIMIT: "Rate limit exceeded. Please try again later.";
|
|
23
27
|
readonly UNEXPECTED_API: "An unexpected API error occurred.";
|
|
24
28
|
};
|
|
@@ -37,3 +41,26 @@ export declare const INFO: {
|
|
|
37
41
|
};
|
|
38
42
|
export declare function yamlParseError(detail: string): string;
|
|
39
43
|
export declare function recordLabel(index: number): string;
|
|
44
|
+
/**
|
|
45
|
+
* Parses an ISO-8601 timestamp into a `YYYY-MM-DD` date string.
|
|
46
|
+
* Returns the raw input if parsing fails so the original value is preserved.
|
|
47
|
+
*/
|
|
48
|
+
export declare function formatQuotaResetDate(value?: string): string | undefined;
|
|
49
|
+
/**
|
|
50
|
+
* Formats a `retry-after` value (seconds) into a short, human-readable hint
|
|
51
|
+
* suitable for appending to a 429 error message.
|
|
52
|
+
*/
|
|
53
|
+
export declare function formatRetryAfter(seconds?: number): string | undefined;
|
|
54
|
+
/**
|
|
55
|
+
* Builds the multi-line message printed when an AI quota (init regeneration or
|
|
56
|
+
* edit) is exhausted. `serverError` is the message returned by the API; the
|
|
57
|
+
* default text is used when the server omits it. The tip lists the next action
|
|
58
|
+
* the user can take (e.g. switch from init to edit).
|
|
59
|
+
*/
|
|
60
|
+
export declare function quotaExhaustedMessage(input: {
|
|
61
|
+
defaultMessage: string;
|
|
62
|
+
limitReset?: string;
|
|
63
|
+
retryAfter?: number;
|
|
64
|
+
serverError?: string;
|
|
65
|
+
tip: string;
|
|
66
|
+
}): string;
|
package/dist/lib/messages.js
CHANGED
|
@@ -20,6 +20,10 @@ export const ERRORS = {
|
|
|
20
20
|
INVALID_API_KEY: `Invalid API key. Run ${chalk.cyan('mailmodo login')} to re-authenticate.`,
|
|
21
21
|
NOT_LOGGED_IN: `Not logged in. Run ${chalk.cyan('mailmodo login')} to authenticate.`,
|
|
22
22
|
NO_YAML: `No mailmodo.yaml found. Run ${chalk.cyan('mailmodo init')} first.`,
|
|
23
|
+
QUOTA_EDIT_DEFAULT: 'Edit limit reached for this month.',
|
|
24
|
+
QUOTA_EDIT_TIP: 'AI edits are limited to 50 per account per month. Manually edit the template file under ./mailmodo to make further changes.',
|
|
25
|
+
QUOTA_INIT_DEFAULT: 'Regeneration limit reached.',
|
|
26
|
+
QUOTA_INIT_TIP: `Regenerations are limited to 5 per account per month. Run ${chalk.cyan('mailmodo edit <id>')} to modify individual emails instead.`,
|
|
23
27
|
RATE_LIMIT: 'Rate limit exceeded. Please try again later.',
|
|
24
28
|
UNEXPECTED_API: 'An unexpected API error occurred.',
|
|
25
29
|
};
|
|
@@ -42,3 +46,56 @@ export function recordLabel(index) {
|
|
|
42
46
|
const labels = ['DKIM', 'DMARC', 'Return Path'];
|
|
43
47
|
return labels[index] || `Record ${index + 1}`;
|
|
44
48
|
}
|
|
49
|
+
/**
|
|
50
|
+
* Parses an ISO-8601 timestamp into a `YYYY-MM-DD` date string.
|
|
51
|
+
* Returns the raw input if parsing fails so the original value is preserved.
|
|
52
|
+
*/
|
|
53
|
+
export function formatQuotaResetDate(value) {
|
|
54
|
+
if (!value)
|
|
55
|
+
return undefined;
|
|
56
|
+
const parsed = new Date(value);
|
|
57
|
+
if (Number.isNaN(parsed.getTime()))
|
|
58
|
+
return value;
|
|
59
|
+
const year = parsed.getUTCFullYear();
|
|
60
|
+
const month = String(parsed.getUTCMonth() + 1).padStart(2, '0');
|
|
61
|
+
const day = String(parsed.getUTCDate()).padStart(2, '0');
|
|
62
|
+
return `${year}-${month}-${day}`;
|
|
63
|
+
}
|
|
64
|
+
/**
|
|
65
|
+
* Formats a `retry-after` value (seconds) into a short, human-readable hint
|
|
66
|
+
* suitable for appending to a 429 error message.
|
|
67
|
+
*/
|
|
68
|
+
export function formatRetryAfter(seconds) {
|
|
69
|
+
if (typeof seconds !== 'number' || !Number.isFinite(seconds) || seconds <= 0)
|
|
70
|
+
return undefined;
|
|
71
|
+
if (seconds < 60)
|
|
72
|
+
return `${Math.round(seconds)} seconds`;
|
|
73
|
+
const minutes = Math.round(seconds / 60);
|
|
74
|
+
if (minutes < 60)
|
|
75
|
+
return `${minutes} minutes`;
|
|
76
|
+
const hours = Math.round(seconds / 3600);
|
|
77
|
+
if (hours < 24)
|
|
78
|
+
return `${hours} hours`;
|
|
79
|
+
const days = Math.round(seconds / 86_400);
|
|
80
|
+
return `${days} days`;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Builds the multi-line message printed when an AI quota (init regeneration or
|
|
84
|
+
* edit) is exhausted. `serverError` is the message returned by the API; the
|
|
85
|
+
* default text is used when the server omits it. The tip lists the next action
|
|
86
|
+
* the user can take (e.g. switch from init to edit).
|
|
87
|
+
*/
|
|
88
|
+
export function quotaExhaustedMessage(input) {
|
|
89
|
+
const headline = input.serverError || input.defaultMessage;
|
|
90
|
+
const lines = [headline];
|
|
91
|
+
const resetDate = formatQuotaResetDate(input.limitReset);
|
|
92
|
+
if (resetDate && !headline.includes(resetDate)) {
|
|
93
|
+
lines.push(`Resets on ${resetDate}.`);
|
|
94
|
+
}
|
|
95
|
+
const retryHint = formatRetryAfter(input.retryAfter);
|
|
96
|
+
if (retryHint) {
|
|
97
|
+
lines.push(`Try again in ${retryHint}.`);
|
|
98
|
+
}
|
|
99
|
+
lines.push('', input.tip);
|
|
100
|
+
return lines.join('\n');
|
|
101
|
+
}
|
package/oclif.manifest.json
CHANGED
|
@@ -365,45 +365,6 @@
|
|
|
365
365
|
"index.js"
|
|
366
366
|
]
|
|
367
367
|
},
|
|
368
|
-
"login": {
|
|
369
|
-
"aliases": [],
|
|
370
|
-
"args": {},
|
|
371
|
-
"description": "Authenticate with Mailmodo using your API key",
|
|
372
|
-
"examples": [
|
|
373
|
-
"<%= config.bin %> login",
|
|
374
|
-
"MAILMODO_API_KEY=YOUR_API_KEY <%= config.bin %> login"
|
|
375
|
-
],
|
|
376
|
-
"flags": {
|
|
377
|
-
"json": {
|
|
378
|
-
"description": "Output as JSON",
|
|
379
|
-
"name": "json",
|
|
380
|
-
"allowNo": false,
|
|
381
|
-
"type": "boolean"
|
|
382
|
-
},
|
|
383
|
-
"yes": {
|
|
384
|
-
"char": "y",
|
|
385
|
-
"description": "Skip confirmation prompts",
|
|
386
|
-
"name": "yes",
|
|
387
|
-
"allowNo": false,
|
|
388
|
-
"type": "boolean"
|
|
389
|
-
}
|
|
390
|
-
},
|
|
391
|
-
"hasDynamicHelp": false,
|
|
392
|
-
"hiddenAliases": [],
|
|
393
|
-
"id": "login",
|
|
394
|
-
"pluginAlias": "@mailmodo/cli",
|
|
395
|
-
"pluginName": "@mailmodo/cli",
|
|
396
|
-
"pluginType": "core",
|
|
397
|
-
"strict": true,
|
|
398
|
-
"enableJsonFlag": false,
|
|
399
|
-
"isESM": true,
|
|
400
|
-
"relativePath": [
|
|
401
|
-
"dist",
|
|
402
|
-
"commands",
|
|
403
|
-
"login",
|
|
404
|
-
"index.js"
|
|
405
|
-
]
|
|
406
|
-
},
|
|
407
368
|
"logout": {
|
|
408
369
|
"aliases": [],
|
|
409
370
|
"args": {},
|
|
@@ -570,6 +531,53 @@
|
|
|
570
531
|
"index.js"
|
|
571
532
|
]
|
|
572
533
|
},
|
|
534
|
+
"settings": {
|
|
535
|
+
"aliases": [],
|
|
536
|
+
"args": {},
|
|
537
|
+
"description": "View and update project settings",
|
|
538
|
+
"examples": [
|
|
539
|
+
"<%= config.bin %> settings",
|
|
540
|
+
"<%= config.bin %> settings --set brand_color=#0F3460",
|
|
541
|
+
"<%= config.bin %> settings --json"
|
|
542
|
+
],
|
|
543
|
+
"flags": {
|
|
544
|
+
"json": {
|
|
545
|
+
"description": "Output as JSON",
|
|
546
|
+
"name": "json",
|
|
547
|
+
"allowNo": false,
|
|
548
|
+
"type": "boolean"
|
|
549
|
+
},
|
|
550
|
+
"yes": {
|
|
551
|
+
"char": "y",
|
|
552
|
+
"description": "Skip confirmation prompts",
|
|
553
|
+
"name": "yes",
|
|
554
|
+
"allowNo": false,
|
|
555
|
+
"type": "boolean"
|
|
556
|
+
},
|
|
557
|
+
"set": {
|
|
558
|
+
"description": "Set a setting (format: key=value)",
|
|
559
|
+
"name": "set",
|
|
560
|
+
"hasDynamicHelp": false,
|
|
561
|
+
"multiple": false,
|
|
562
|
+
"type": "option"
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
"hasDynamicHelp": false,
|
|
566
|
+
"hiddenAliases": [],
|
|
567
|
+
"id": "settings",
|
|
568
|
+
"pluginAlias": "@mailmodo/cli",
|
|
569
|
+
"pluginName": "@mailmodo/cli",
|
|
570
|
+
"pluginType": "core",
|
|
571
|
+
"strict": true,
|
|
572
|
+
"enableJsonFlag": false,
|
|
573
|
+
"isESM": true,
|
|
574
|
+
"relativePath": [
|
|
575
|
+
"dist",
|
|
576
|
+
"commands",
|
|
577
|
+
"settings",
|
|
578
|
+
"index.js"
|
|
579
|
+
]
|
|
580
|
+
},
|
|
573
581
|
"status": {
|
|
574
582
|
"aliases": [],
|
|
575
583
|
"args": {},
|
|
@@ -609,14 +617,13 @@
|
|
|
609
617
|
"index.js"
|
|
610
618
|
]
|
|
611
619
|
},
|
|
612
|
-
"
|
|
620
|
+
"login": {
|
|
613
621
|
"aliases": [],
|
|
614
622
|
"args": {},
|
|
615
|
-
"description": "
|
|
623
|
+
"description": "Authenticate with Mailmodo using your API key",
|
|
616
624
|
"examples": [
|
|
617
|
-
"<%= config.bin %>
|
|
618
|
-
"<%= config.bin %>
|
|
619
|
-
"<%= config.bin %> settings --json"
|
|
625
|
+
"<%= config.bin %> login",
|
|
626
|
+
"MAILMODO_API_KEY=YOUR_API_KEY <%= config.bin %> login"
|
|
620
627
|
],
|
|
621
628
|
"flags": {
|
|
622
629
|
"json": {
|
|
@@ -631,18 +638,11 @@
|
|
|
631
638
|
"name": "yes",
|
|
632
639
|
"allowNo": false,
|
|
633
640
|
"type": "boolean"
|
|
634
|
-
},
|
|
635
|
-
"set": {
|
|
636
|
-
"description": "Set a setting (format: key=value)",
|
|
637
|
-
"name": "set",
|
|
638
|
-
"hasDynamicHelp": false,
|
|
639
|
-
"multiple": false,
|
|
640
|
-
"type": "option"
|
|
641
641
|
}
|
|
642
642
|
},
|
|
643
643
|
"hasDynamicHelp": false,
|
|
644
644
|
"hiddenAliases": [],
|
|
645
|
-
"id": "
|
|
645
|
+
"id": "login",
|
|
646
646
|
"pluginAlias": "@mailmodo/cli",
|
|
647
647
|
"pluginName": "@mailmodo/cli",
|
|
648
648
|
"pluginType": "core",
|
|
@@ -652,10 +652,10 @@
|
|
|
652
652
|
"relativePath": [
|
|
653
653
|
"dist",
|
|
654
654
|
"commands",
|
|
655
|
-
"
|
|
655
|
+
"login",
|
|
656
656
|
"index.js"
|
|
657
657
|
]
|
|
658
658
|
}
|
|
659
659
|
},
|
|
660
|
-
"version": "0.0.
|
|
660
|
+
"version": "0.0.49-beta.pr51.78"
|
|
661
661
|
}
|