runcloud 0.2.178 → 0.2.180

package/dist/commands/domains.js

@@ -1,6 +1,6 @@
 import { stdin as input, stdout as output } from 'node:process';
 import { createInterface } from 'node:readline/promises';
-import { ApiClient, friendlyApiError } from '../api.js';
+import { ApiClient, ApiError, friendlyApiError } from '../api.js';
 import { requireCredentials, resolveProject } from '../config.js';
 export function renderPendingRegistration(order) {
     const action = `run \`newly domains connect-registered ${order.domain}\``;
@@ -27,9 +27,9 @@ export function summarizeDomain(candidate) {
     return `${name}  ${state}${pricing}${reason}`;
 }
 export function renderProjectDomain(domain) {
-    return `${domain.id}  ${domain.hostname}  ${domain.status}  ${domain.ownership_mode}`;
+    return `${domain.id}  ${domain.hostname}  ${domain.status}  ${domain.ownership_mode}  email: ${domain.email_status ?? 'not set up'}`;
 }
-async function confirm(prompt) {
+export async function confirm(prompt) {
     const rl = createInterface({ input, output });
     try {
         const answer = (await rl.question(`${prompt} Type "yes" to continue: `)).trim().toLowerCase();
@@ -116,7 +116,16 @@ export async function runDomainStatus(client, projectId, hostnameOrId, log = con
     }
     if (!domain)
         throw new Error('Domain not found.');
-    const refreshed = await client.post(`/projects/${projectId}/domains/${domain.id}/refresh`, {});
+    let refreshed;
+    try {
+        refreshed = await client.post(`/projects/${projectId}/domains/${domain.id}/refresh`, {});
+    }
+    catch (e) {
+        if (!(e instanceof ApiError && e.status === 403))
+            throw e;
+        log(renderProjectDomain(domain));
+        return;
+    }
     log(renderProjectDomain(refreshed.domain));
     if (refreshed.dns_instructions)
         log(JSON.stringify(refreshed.dns_instructions, null, 2));

package/dist/commands/email.js

@@ -1,13 +1,263 @@
-export const EMAIL_RETIRED_MESSAGE = '`newly email` was retired: it never had a server to talk to. ' +
-    'There is no CLI replacement; send mail from your API service with your own provider.';
+import { readFileSync, mkdtempSync, writeFileSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { ApiClient, ApiError, friendlyApiError } from '../api.js';
+import { requireCredentials, resolveProject } from '../config.js';
+import { confirm } from './domains.js';
+export const ASK_USER_TO_SEND = 'Ask the user to review and send it in Newly';
+export const NEEDS_TERMINAL = 'Sending needs you at a terminal. Review and send it in Newly instead.';
+const stdinIsTty = () => Boolean(process.stdin.isTTY);
+const base = (projectId) => `/projects/${projectId}/email`;
+const show = (log, value) => log(JSON.stringify(value, null, 2));
+const campaignLine = (c) => `${c.id}  ${c.status}  ${c.name}`;
+export async function runEmailSettings(client, projectId, opts, log = console.log) {
+    const body = {
+        ...(opts.senderName !== undefined && { sender_name: opts.senderName }),
+        ...(opts.postalAddress !== undefined && { postal_address: opts.postalAddress }),
+        ...(opts.replyTo !== undefined && { reply_to: opts.replyTo }),
+    };
+    show(log, Object.keys(body).length
+        ? await client.put(`${base(projectId)}/settings`, body)
+        : await client.get(`${base(projectId)}/settings`));
+}
+export async function runContactsCount(client, projectId, log = console.log) {
+    show(log, await client.get(`${base(projectId)}/contacts/counts`));
+}
+export async function runContactsList(client, projectId, opts, log = console.log) {
+    const params = new URLSearchParams();
+    if (opts.status)
+        params.set('status', opts.status);
+    if (opts.q)
+        params.set('q', opts.q);
+    const query = params.toString();
+    show(log, await client.get(`${base(projectId)}/contacts${query ? `?${query}` : ''}`));
+}
+export async function runCampaignList(client, projectId, log = console.log) {
+    const { campaigns = [] } = (await client.get(`${base(projectId)}/campaigns`));
+    log(campaigns.length ? campaigns.map(campaignLine).join('\n') : 'No campaigns.');
+}
+function readHtml(path) {
+    try {
+        return readFileSync(path, 'utf8');
+    }
+    catch {
+        throw new Error(`Could not read ${path}`);
+    }
+}
+export async function runCampaignDraft(client, projectId, opts, log = console.log) {
+    const body = {
+        ...(opts.name !== undefined && { name: opts.name }),
+        ...(opts.subject !== undefined && { subject: opts.subject }),
+        ...(opts.previewText !== undefined && { preview_text: opts.previewText }),
+        ...(opts.topic !== undefined && { topic_key: opts.topic }),
+        ...(opts.htmlFile !== undefined && { html: readHtml(opts.htmlFile) }),
+    };
+    if (!opts.id && !opts.name)
+        throw new Error('A new campaign needs --name.');
+    const saved = (opts.id
+        ? await client.patch(`${base(projectId)}/campaigns/${opts.id}`, body)
+        : await client.post(`${base(projectId)}/campaigns`, body));
+    log(campaignLine(saved));
+}
+export async function runCampaignPreview(client, projectId, id, log = console.log) {
+    const campaign = (await client.get(`${base(projectId)}/campaigns/${id}`));
+    const file = join(mkdtempSync(join(tmpdir(), 'newly-campaign-')), 'preview.html');
+    writeFileSync(file, campaign.html);
+    log(file);
+}
+export async function runCampaignTest(client, projectId, id, log = console.log) {
+    await client.post(`${base(projectId)}/campaigns/${id}/test`, {});
+    log('Test email sent to your account address.');
+}
+export async function runCampaignStatus(client, projectId, id, log = console.log) {
+    const campaign = (await client.get(`${base(projectId)}/campaigns/${id}`));
+    const estimate = (await client.get(`${base(projectId)}/campaigns/${id}/estimate`));
+    log(campaignLine(campaign));
+    show(log, { estimate });
+}
+async function confirmedPost(client, projectId, id, action, extra, verb, log, confirmFn, isTty) {
+    if (!isTty())
+        throw new Error(NEEDS_TERMINAL);
+    const campaign = (await client.get(`${base(projectId)}/campaigns/${id}`));
+    const estimate = (await client.get(`${base(projectId)}/campaigns/${id}/estimate`));
+    log(`${campaign.name}: ${estimate.recipients} recipients, ${estimate.credits} credits.`);
+    if (!(await confirmFn(`${verb} "${campaign.name}"?`))) {
+        log('Cancelled.');
+        return;
+    }
+    const result = (await client.post(`${base(projectId)}/campaigns/${id}/${action}`, {
+        ...extra,
+        expected_updated_at: campaign.updated_at,
+    }));
+    log(campaignLine(result));
+}
+export const runCampaignSend = (client, projectId, id, log = console.log, confirmFn = confirm, isTty = stdinIsTty) => confirmedPost(client, projectId, id, 'send', {}, 'Send', log, confirmFn, isTty);
+export const runCampaignSchedule = (client, projectId, id, opts, log = console.log, confirmFn = confirm, isTty = stdinIsTty) => confirmedPost(client, projectId, id, 'schedule', { at: opts.at, timezone: opts.timezone ?? Intl.DateTimeFormat().resolvedOptions().timeZone }, `Schedule for ${opts.at}`, log, confirmFn, isTty);
+export const USER_SESSION_ONLY = 'This needs a signed-in user session. Ask the user to do it in Newly.';
+const PENDING_NOTE = 'Newly checks every minute; this usually takes 5 to 30 minutes after the records are added.';
+const relativeName = (name, root) => name === root ? '@' : name.endsWith(`.${root}`) ? name.slice(0, -root.length - 1) : name;
+function recordLine(r, root) {
+    const content = r.type === 'TXT' ? r.content.replace(/^"(.*)"$/, '$1') : r.content;
+    const value = r.priority === undefined ? content : `${r.priority} ${content}`;
+    const note = r.optional ? '  (optional, you already have one)' : '';
+    return `  ${r.type}  ${r.name}  (relative: ${relativeName(r.name, root)})  ${value}${note}`;
+}
+function domainLines(d) {
+    const status = d.status ?? 'pending';
+    const head = `${d.hostname}  ${d.kind}  ${status}`;
+    if (d.kind !== 'own' || status === 'verified')
+        return [head];
+    return [
+        head,
+        ...(d.reason ? [`  ${d.reason.replace(/ Press Check now.*/i, '')}`] : []),
+        ...(d.records ?? []).map((r) => recordLine(r, d.root_domain)),
+    ];
+}
+const RECORDS_POLL_MS = 3_000;
+const RECORDS_POLL_TRIES = 10;
+const realSleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+async function waitForRecords(client, projectId, claim, sleep) {
+    let d = claim;
+    for (let i = 0; i < RECORDS_POLL_TRIES && !d.records && d.status !== 'verified' && d.status !== 'failed'; i++) {
+        await sleep(RECORDS_POLL_MS);
+        const { domains = [] } = (await client.get(`${base(projectId)}/domains`));
+        d = domains.find((x) => x.id === claim.id) ?? d;
+    }
+    return d;
+}
+export async function runEmailDomainAdd(client, projectId, hostname, log = console.log, sleep = realSleep) {
+    const claim = (await client.post(`${base(projectId)}/domains`, { hostname }));
+    if (claim.kind === 'managed') {
+        log(`Newly manages DNS for ${claim.hostname}, so email is set up automatically. There is nothing to add.`);
+        return;
+    }
+    if (claim.status === 'verified') {
+        log(`${claim.hostname} is verified. Email sends from it.`);
+        return;
+    }
+    if (!claim.records)
+        log(`Preparing the DNS records for ${claim.hostname}...`);
+    const d = await waitForRecords(client, projectId, claim, sleep);
+    if (d.status === 'failed' && d.reason)
+        log(d.reason.replace(/ Press Check now.*/i, ''));
+    if (!d.records) {
+        log('The records are not ready yet. Run "newly email domain status" in a minute to see them.');
+        return;
+    }
+    log(`Add these DNS records at your DNS provider for ${d.hostname}:`);
+    log(d.records.map((r) => recordLine(r, d.root_domain)).join('\n'));
+    log(`Status: ${d.status ?? 'pending'}. ${PENDING_NOTE}`);
+}
+export async function runEmailDomainStatus(client, projectId, log = console.log) {
+    const { domains = [] } = (await client.get(`${base(projectId)}/domains`));
+    log(domains.length ? domains.flatMap(domainLines).join('\n') : 'No email domains.');
+}
+export function emailDomainErrorMessage(e) {
+    return e instanceof ApiError && e.status === 403 ? USER_SESSION_ONLY : friendlyApiError(e);
+}
+export function emailErrorMessage(e, isSend = false) {
+    return isSend && e instanceof ApiError && e.status === 403 ? ASK_USER_TO_SEND : friendlyApiError(e);
+}
 export function registerEmail(program) {
-    program
-        .command('email')
-        .description('Retired: send mail from your API service instead')
-        .allowUnknownOption()
-        .allowExcessArguments()
-        .action(() => {
-        console.error(EMAIL_RETIRED_MESSAGE);
-        process.exitCode = 1;
-    });
+    const email = program.command('email').description('Marketing email: settings, contacts and campaigns');
+    const run = (fn, isSend = false) => async (opts) => {
+        try {
+            const creds = requireCredentials();
+            await fn(new ApiClient(creds.apiUrl, creds.token), resolveProject(process.cwd(), opts.project));
+        }
+        catch (e) {
+            console.error(emailErrorMessage(e, isSend));
+            process.exitCode = 1;
+        }
+    };
+    const project = '--project <id>';
+    const projectHelp = 'project id (defaults to the linked directory)';
+    email
+        .command('settings')
+        .option(project, projectHelp)
+        .option('--sender-name <name>')
+        .option('--postal-address <address>')
+        .option('--reply-to <email>')
+        .description('Show email settings, or update them when a flag is given')
+        .action((opts) => run((c, p) => runEmailSettings(c, p, opts))(opts));
+    const contacts = email.command('contacts').description('Marketing contacts');
+    contacts
+        .command('count')
+        .option(project, projectHelp)
+        .action((opts) => run((c, p) => runContactsCount(c, p))(opts));
+    contacts
+        .command('list')
+        .option(project, projectHelp)
+        .option('--status <status>')
+        .option('--q <text>', 'search by email')
+        .action((opts) => run((c, p) => runContactsList(c, p, opts))(opts));
+    const campaign = email.command('campaign').description('Draft, preview, test and send campaigns');
+    campaign
+        .command('list')
+        .option(project, projectHelp)
+        .action((opts) => run((c, p) => runCampaignList(c, p))(opts));
+    campaign
+        .command('draft')
+        .option(project, projectHelp)
+        .option('--id <id>', 'edit this draft instead of creating one')
+        .option('--name <name>')
+        .option('--subject <subject>')
+        .option('--preview-text <text>')
+        .option('--topic <key>')
+        .option('--html-file <path>')
+        .description('Create a draft campaign, or update one with --id')
+        .action((opts) => run((c, p) => runCampaignDraft(c, p, opts))(opts));
+    campaign
+        .command('preview')
+        .argument('<id>')
+        .option(project, projectHelp)
+        .description('Write the campaign HTML to a temp file and print its path')
+        .action((id, opts) => run((c, p) => runCampaignPreview(c, p, id))(opts));
+    campaign
+        .command('test')
+        .argument('<id>')
+        .option(project, projectHelp)
+        .description('Send a test email to your own account address')
+        .action((id, opts) => run((c, p) => runCampaignTest(c, p, id))(opts));
+    campaign
+        .command('status')
+        .argument('<id>')
+        .option(project, projectHelp)
+        .action((id, opts) => run((c, p) => runCampaignStatus(c, p, id))(opts));
+    campaign
+        .command('send')
+        .argument('<id>')
+        .option(project, projectHelp)
+        .description('Send a campaign now (needs a terminal and confirmation)')
+        .action((id, opts) => run((c, p) => runCampaignSend(c, p, id), true)(opts));
+    campaign
+        .command('schedule')
+        .argument('<id>')
+        .requiredOption('--at <iso>', 'ISO date and time')
+        .option('--timezone <iana>', 'IANA timezone (defaults to this machine)')
+        .option(project, projectHelp)
+        .description('Schedule a campaign (needs a terminal and confirmation)')
+        .action((id, opts) => run((c, p) => runCampaignSchedule(c, p, id, opts), true)(opts));
+    const domain = email.command('domain').description('Send email from a domain you own');
+    const runDomain = (fn) => async (opts) => {
+        try {
+            const creds = requireCredentials();
+            await fn(new ApiClient(creds.apiUrl, creds.token), resolveProject(process.cwd(), opts.project));
+        }
+        catch (e) {
+            console.error(emailDomainErrorMessage(e));
+            process.exitCode = 1;
+        }
+    };
+    domain
+        .command('add')
+        .argument('<hostname>')
+        .option(project, projectHelp)
+        .description('Claim a domain and print the DNS records to add')
+        .action((hostname, opts) => runDomain((c, p) => runEmailDomainAdd(c, p, hostname))(opts));
+    domain
+        .command('status')
+        .option(project, projectHelp)
+        .description('List email domains and the records still to add')
+        .action((opts) => runDomain((c, p) => runEmailDomainStatus(c, p))(opts));
 }

package/dist/commands/github.js

@@ -0,0 +1,61 @@
+import { ApiClient, ApiError, friendlyApiError } from '../api.js';
+import { requireCredentials, resolveProject } from '../config.js';
+export async function getGithubStatus(client, projectId) {
+    return (await client.get(`/projects/${encodeURIComponent(projectId)}/github/status?ahead=1`));
+}
+export async function pullGithubBranch(client, projectId, branch) {
+    await client.post(`/projects/${encodeURIComponent(projectId)}/git/branches/${encodeURIComponent(branch)}/push`);
+}
+export function formatGithubBranches(status) {
+    if (!status.connected)
+        return 'This project is not linked to a GitHub repository.';
+    const repo = `${status.owner}/${status.name}`;
+    if (status.ahead === undefined)
+        return `Linked to ${repo}, but GitHub could not be read right now. Try again shortly.`;
+    if (status.ahead.length === 0)
+        return `Linked to ${repo}. Newly has every GitHub branch at its current tip.`;
+    return [
+        `Linked to ${repo}. On GitHub, not yet in Newly at their current tip:`,
+        ...status.ahead.map((b) => `  ${b}`),
+        'Bring one in with: newly github pull <branch>',
+    ].join('\n');
+}
+export function registerGithub(program) {
+    const github = program
+        .command('github')
+        .description("Work with the project's linked GitHub repository");
+    const run = (action) => async (opts) => {
+        try {
+            const creds = requireCredentials();
+            const projectId = resolveProject(process.cwd(), opts.project);
+            await action(new ApiClient(creds.apiUrl, creds.token), projectId);
+        }
+        catch (e) {
+            console.error(friendlyApiError(e));
+            process.exitCode = 1;
+        }
+    };
+    github
+        .command('branches')
+        .description('List GitHub branches that Newly does not have yet (or has at an older tip)')
+        .option('--project <id>', 'project id (defaults to the linked directory)')
+        .action(run(async (client, projectId) => {
+        console.log(formatGithubBranches(await getGithubStatus(client, projectId)));
+    }));
+    github
+        .command('pull <branch>')
+        .description('Bring one GitHub branch into Newly (a two-way sync of that branch) so it can be fetched and checked out')
+        .option('--project <id>', 'project id (defaults to the linked directory)')
+        .action((branch, opts) => run(async (client, projectId) => {
+        try {
+            await pullGithubBranch(client, projectId, branch);
+        }
+        catch (e) {
+            if (e instanceof ApiError && e.status === 403) {
+                throw new Error(`Pulling ${branch} needs a project admin. Ask the user to pull it from the GitHub pane in the Deploy tab.`);
+            }
+            throw e;
+        }
+        console.log(`${branch} is in Newly, synced both ways with GitHub. Run: git fetch origin ${branch} && git checkout ${branch}`);
+    })(opts));
+}

package/dist/index.js

@@ -10,6 +10,7 @@ import { registerPull } from './commands/pull.js';
 import { registerDeploy } from './commands/deploy.js';
 import { registerMisc } from './commands/misc.js';
 import { registerStack } from './commands/stack.js';
+import { registerGithub } from './commands/github.js';
 import { registerCreds } from './commands/creds.js';
 import { registerBuild } from './commands/build.js';
 import { registerServices } from './commands/services.js';
@@ -37,6 +38,7 @@ registerDeploy(program);
 registerAi(program);
 registerMisc(program);
 registerStack(program);
+registerGithub(program);
 registerCreds(program);
 registerBuild(program);
 registerServices(program);

package/dist/version.js

@@ -1 +1 @@
-export const CLI_VERSION = '0.2.178';
+export const CLI_VERSION = '0.2.180';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runcloud",
-  "version": "0.2.178",
+  "version": "0.2.180",
   "description": "Create and control run.cloud remote mobile simulators and cloud sandboxes",
   "license": "Apache-2.0",
   "keywords": [