@bridgeline-digital/hawk-app-cli 0.1.0-dev.20261020202308 → 0.1.0

package/src/login.mjs

@@ -1,166 +1,166 @@
-import { spawnSync } from 'node:child_process';
-import { existsSync, readFileSync } from 'node:fs';
-import { appendFile, writeFile } from 'node:fs/promises';
-import { join } from 'node:path';
-import { credentialsPath, removeCredential, saveCredential } from './credentials.mjs';
-import { describePlatform, resolveSettings } from './env.mjs';
-
-/** Reads a line from the terminal without echoing it. */
-export function promptHidden(
-    question,
-    {
-        input = process.stdin,
-        output = process.stdout,
-        notInteractive = '`hawk-app login` needs an interactive terminal. In CI, set HAWK_APPS_PUBLISHER_KEY as a secured variable instead.',
-    } = {},
-) {
-    if (!input.isTTY) {
-        return Promise.reject(new Error(notInteractive));
-    }
-    return new Promise((resolve, reject) => {
-        let value = '';
-        output.write(question);
-        input.setRawMode(true);
-        input.resume();
-        input.setEncoding('utf8');
-        const onData = (chunk) => {
-            for (const ch of chunk) {
-                if (ch === '\r' || ch === '\n') {
-                    finish();
-                    return resolve(value.trim());
-                }
-                if (ch === '\u0003') {
-                    finish();
-                    return reject(new Error('Cancelled.'));
-                }
-                if (ch === '\u007f' || ch === '\b') value = value.slice(0, -1);
-                else if (ch >= ' ') value += ch;
-            }
-        };
-        function finish() {
-            input.off('data', onData);
-            input.setRawMode(false);
-            input.pause();
-            output.write('\n');
-        }
-        input.on('data', onData);
-    });
-}
-
-/** Sets or replaces KEY=value lines in a .env file, keeping everything else (comments, other keys) as is. */
-export function upsertEnv(text, values) {
-    const lines = text ? text.split(/\r?\n/) : [];
-    const pending = { ...values };
-    const updated = lines.map((line) => {
-        const match = /^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=/.exec(line);
-        if (match && match[1] in pending) {
-            const next = `${match[1]}=${pending[match[1]]}`;
-            delete pending[match[1]];
-            return next;
-        }
-        return line;
-    });
-    while (updated.length && updated[updated.length - 1] === '') updated.pop();
-    for (const [key, value] of Object.entries(pending)) updated.push(`${key}=${value}`);
-    return updated.join('\n') + '\n';
-}
-
-/** Checks a key with the platform: 404 = accepted (no app by that name), 401 = rejected. */
-export async function checkKey(url, key, fetchImpl = fetch) {
-    let response;
-    try {
-        response = await fetchImpl(`${url}/publish/apps/login-check`, { headers: { Authorization: `PublisherKey ${key}` } });
-    } catch (error) {
-        return { ok: false, reason: `Could not reach ${url}: ${error.message}.` };
-    }
-    if (response.status === 401) return { ok: false, reason: 'The platform rejected the key.' };
-    if (response.status !== 404 && !response.ok) return { ok: false, reason: `Unexpected response from the platform (${response.status}).` };
-    return { ok: true };
-}
-
-const publisherOf = (key) => key.split('.')[0];
-
-/**
- * Asks for the publisher key, checks it with the platform and saves it once for this machine, so every app
- * uses it. With `local: true` it goes into this project's .env.local instead. The key never appears on
- * screen, in shell history or as a command-line argument.
- */
-export async function login({
-    dir = process.cwd(),
-    platform,
-    env,
-    local = false,
-    prompt = promptHidden,
-    fetchImpl = fetch,
-    log = console.log,
-    isIgnored = gitIgnored,
-    credentialsFile = credentialsPath(),
-}) {
-    const { url } = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
-
-    log(`Platform: ${describePlatform(url)}`);
-    const key = await prompt('Publisher key (input hidden): ');
-    if (!/^[a-z0-9-]+\.[A-Za-z0-9_-]{16,}$/.test(key)) throw new Error('That does not look like a publisher key ("<publisherId>.<secret>"). Nothing was saved.');
-    const check = await checkKey(url, key, fetchImpl);
-    if (!check.ok) throw new Error(`${check.reason} Nothing was saved.`);
-
-    if (!local) {
-        await saveCredential(credentialsFile, url, key);
-        log(`✔ Logged in to ${describePlatform(url)} as publisher "${publisherOf(key)}".`);
-        log(`  Saved for every app on this machine: ${credentialsFile}`);
-        return;
-    }
-
-    const envPath = join(dir, '.env.local');
-    const existing = existsSync(envPath) ? readFileSync(envPath, 'utf8') : '';
-    await writeFile(envPath, upsertEnv(existing, { HAWK_APPS_PLATFORM_URL: url, HAWK_APPS_PUBLISHER_KEY: key }));
-    log(`✔ Logged in to ${url} as publisher "${publisherOf(key)}" for this project only (.env.local).`);
-    if (isIgnored(dir, '.env.local') === false || (isIgnored(dir, '.env.local') === undefined && !ignoredByGitignoreFile(dir))) {
-        const gitignore = join(dir, '.gitignore');
-        const needsNewline = existsSync(gitignore) && !readFileSync(gitignore, 'utf8').endsWith('\n');
-        await appendFile(gitignore, `${needsNewline ? '\n' : ''}.env.local\n`);
-        log('  Added .env.local to .gitignore so the key is never committed.');
-    }
-}
-
-/** Shows which platform and key would be used here, and whether the platform accepts the key. */
-export async function whoami({ dir = process.cwd(), platform, env, fetchImpl = fetch, log = console.log, credentialsFile = credentialsPath() }) {
-    const settings = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
-    log(`Platform: ${describePlatform(settings.url)}  (from ${settings.urlSource})`);
-    if (!settings.key) {
-        log('✖ Not logged in. Run `npx hawk-app sso` (Bridgeline account) or `npx hawk-app login` (publisher key) once on this machine.');
-        return 1;
-    }
-    const check = await checkKey(settings.url, settings.key, fetchImpl);
-    if (!check.ok) {
-        log(`✖ ${check.reason} Key from ${settings.keySource}. Run \`npx hawk-app sso\` or \`npx hawk-app login\` again.`);
-        return 1;
-    }
-    log(`✔ Logged in as publisher "${publisherOf(settings.key)}"  (key from ${settings.keySource})`);
-    return 0;
-}
-
-/** Removes this machine's saved key for the platform. Keys in .env.local or the environment are not touched. */
-export async function logout({ dir = process.cwd(), platform, env, log = console.log, credentialsFile = credentialsPath() }) {
-    const { url } = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
-    if (await removeCredential(credentialsFile, url)) log(`✔ Logged out of ${url} on this machine.`);
-    else log(`Not logged in to ${url} on this machine.`);
-    const remaining = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
-    if (remaining.key) log(`  Note: a key is still set in ${remaining.keySource}; that one still applies here.`);
-    return 0;
-}
-
-function ignoredByGitignoreFile(dir) {
-    const path = join(dir, '.gitignore');
-    if (!existsSync(path)) return false;
-    return readFileSync(path, 'utf8')
-        .split(/\r?\n/)
-        .map((l) => l.trim())
-        .some((l) => l === '.env.local' || l === '.env*' || l === '.env.*' || l === '*.local');
-}
-
-function gitIgnored(dir, file) {
-    const result = spawnSync('git', ['check-ignore', '-q', file], { cwd: dir, stdio: 'ignore' });
-    if (result.error || result.status === 128) return undefined;
-    return result.status === 0;
-}
+import { spawnSync } from 'node:child_process';
+import { existsSync, readFileSync } from 'node:fs';
+import { appendFile, writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import { credentialsPath, removeCredential, saveCredential } from './credentials.mjs';
+import { describePlatform, resolveSettings } from './env.mjs';
+
+/** Reads a line from the terminal without echoing it. */
+export function promptHidden(
+    question,
+    {
+        input = process.stdin,
+        output = process.stdout,
+        notInteractive = '`hawk-app login` needs an interactive terminal. In CI, set HAWK_APPS_PUBLISHER_KEY as a secured variable instead.',
+    } = {},
+) {
+    if (!input.isTTY) {
+        return Promise.reject(new Error(notInteractive));
+    }
+    return new Promise((resolve, reject) => {
+        let value = '';
+        output.write(question);
+        input.setRawMode(true);
+        input.resume();
+        input.setEncoding('utf8');
+        const onData = (chunk) => {
+            for (const ch of chunk) {
+                if (ch === '\r' || ch === '\n') {
+                    finish();
+                    return resolve(value.trim());
+                }
+                if (ch === '\u0003') {
+                    finish();
+                    return reject(new Error('Cancelled.'));
+                }
+                if (ch === '\u007f' || ch === '\b') value = value.slice(0, -1);
+                else if (ch >= ' ') value += ch;
+            }
+        };
+        function finish() {
+            input.off('data', onData);
+            input.setRawMode(false);
+            input.pause();
+            output.write('\n');
+        }
+        input.on('data', onData);
+    });
+}
+
+/** Sets or replaces KEY=value lines in a .env file, keeping everything else (comments, other keys) as is. */
+export function upsertEnv(text, values) {
+    const lines = text ? text.split(/\r?\n/) : [];
+    const pending = { ...values };
+    const updated = lines.map((line) => {
+        const match = /^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=/.exec(line);
+        if (match && match[1] in pending) {
+            const next = `${match[1]}=${pending[match[1]]}`;
+            delete pending[match[1]];
+            return next;
+        }
+        return line;
+    });
+    while (updated.length && updated[updated.length - 1] === '') updated.pop();
+    for (const [key, value] of Object.entries(pending)) updated.push(`${key}=${value}`);
+    return updated.join('\n') + '\n';
+}
+
+/** Checks a key with the platform: 404 = accepted (no app by that name), 401 = rejected. */
+export async function checkKey(url, key, fetchImpl = fetch) {
+    let response;
+    try {
+        response = await fetchImpl(`${url}/publish/apps/login-check`, { headers: { Authorization: `PublisherKey ${key}` } });
+    } catch (error) {
+        return { ok: false, reason: `Could not reach ${url}: ${error.message}.` };
+    }
+    if (response.status === 401) return { ok: false, reason: 'The platform rejected the key.' };
+    if (response.status !== 404 && !response.ok) return { ok: false, reason: `Unexpected response from the platform (${response.status}).` };
+    return { ok: true };
+}
+
+const publisherOf = (key) => key.split('.')[0];
+
+/**
+ * Asks for the publisher key, checks it with the platform and saves it once for this machine, so every app
+ * uses it. With `local: true` it goes into this project's .env.local instead. The key never appears on
+ * screen, in shell history or as a command-line argument.
+ */
+export async function login({
+    dir = process.cwd(),
+    platform,
+    env,
+    local = false,
+    prompt = promptHidden,
+    fetchImpl = fetch,
+    log = console.log,
+    isIgnored = gitIgnored,
+    credentialsFile = credentialsPath(),
+}) {
+    const { url } = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
+
+    log(`Platform: ${describePlatform(url)}`);
+    const key = await prompt('Publisher key (input hidden): ');
+    if (!/^[a-z0-9-]+\.[A-Za-z0-9_-]{16,}$/.test(key)) throw new Error('That does not look like a publisher key ("<publisherId>.<secret>"). Nothing was saved.');
+    const check = await checkKey(url, key, fetchImpl);
+    if (!check.ok) throw new Error(`${check.reason} Nothing was saved.`);
+
+    if (!local) {
+        await saveCredential(credentialsFile, url, key);
+        log(`✔ Logged in to ${describePlatform(url)} as publisher "${publisherOf(key)}".`);
+        log(`  Saved for every app on this machine: ${credentialsFile}`);
+        return;
+    }
+
+    const envPath = join(dir, '.env.local');
+    const existing = existsSync(envPath) ? readFileSync(envPath, 'utf8') : '';
+    await writeFile(envPath, upsertEnv(existing, { HAWK_APPS_PLATFORM_URL: url, HAWK_APPS_PUBLISHER_KEY: key }));
+    log(`✔ Logged in to ${url} as publisher "${publisherOf(key)}" for this project only (.env.local).`);
+    if (isIgnored(dir, '.env.local') === false || (isIgnored(dir, '.env.local') === undefined && !ignoredByGitignoreFile(dir))) {
+        const gitignore = join(dir, '.gitignore');
+        const needsNewline = existsSync(gitignore) && !readFileSync(gitignore, 'utf8').endsWith('\n');
+        await appendFile(gitignore, `${needsNewline ? '\n' : ''}.env.local\n`);
+        log('  Added .env.local to .gitignore so the key is never committed.');
+    }
+}
+
+/** Shows which platform and key would be used here, and whether the platform accepts the key. */
+export async function whoami({ dir = process.cwd(), platform, env, fetchImpl = fetch, log = console.log, credentialsFile = credentialsPath() }) {
+    const settings = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
+    log(`Platform: ${describePlatform(settings.url)}  (from ${settings.urlSource})`);
+    if (!settings.key) {
+        log('✖ Not logged in. Run `npx hawk-app sso` (Bridgeline account) or `npx hawk-app login` (publisher key) once on this machine.');
+        return 1;
+    }
+    const check = await checkKey(settings.url, settings.key, fetchImpl);
+    if (!check.ok) {
+        log(`✖ ${check.reason} Key from ${settings.keySource}. Run \`npx hawk-app sso\` or \`npx hawk-app login\` again.`);
+        return 1;
+    }
+    log(`✔ Logged in as publisher "${publisherOf(settings.key)}"  (key from ${settings.keySource})`);
+    return 0;
+}
+
+/** Removes this machine's saved key for the platform. Keys in .env.local or the environment are not touched. */
+export async function logout({ dir = process.cwd(), platform, env, log = console.log, credentialsFile = credentialsPath() }) {
+    const { url } = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
+    if (await removeCredential(credentialsFile, url)) log(`✔ Logged out of ${url} on this machine.`);
+    else log(`Not logged in to ${url} on this machine.`);
+    const remaining = resolveSettings({ flagPlatform: platform, flagEnv: env, dir, credentialsFile });
+    if (remaining.key) log(`  Note: a key is still set in ${remaining.keySource}; that one still applies here.`);
+    return 0;
+}
+
+function ignoredByGitignoreFile(dir) {
+    const path = join(dir, '.gitignore');
+    if (!existsSync(path)) return false;
+    return readFileSync(path, 'utf8')
+        .split(/\r?\n/)
+        .map((l) => l.trim())
+        .some((l) => l === '.env.local' || l === '.env*' || l === '.env.*' || l === '*.local');
+}
+
+function gitIgnored(dir, file) {
+    const result = spawnSync('git', ['check-ignore', '-q', file], { cwd: dir, stdio: 'ignore' });
+    if (result.error || result.status === 128) return undefined;
+    return result.status === 0;
+}

package/src/logs.mjs

@@ -1,64 +1,64 @@
-export const FOLLOW_INTERVAL_MS = 2_000;
-const SINCE = /^\d+[mhd]$/;
-const USAGE = 'Usage: hawk-app logs <function> [--since 15m|1h|1d|<ISO time>] [--follow]';
-
-const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
-
-/**
- * `hawk-app logs <function>`: prints the function's log events (all versions), page by page. With --follow it keeps
- * polling every 2 s (with the platform's nextToken, or from the last event's time) until Ctrl+C or `signal` aborts.
- */
-export async function logsCommand({ client, manifest, name, flags = {}, sleep = wait, signal, log = console.log }) {
-    if (!name) throw new Error(USAGE);
-    const declared = manifest.functions && typeof manifest.functions === 'object' ? Object.keys(manifest.functions) : [];
-    if (!declared.includes(name)) {
-        throw new Error(`"${name}" is not a function of ${manifest.slug}${declared.length ? ` (functions: ${declared.join(', ')})` : ' (hawk-app.json declares no functions)'}.`);
-    }
-    let since = flags.since;
-    if (since !== undefined && (typeof since !== 'string' || (!SINCE.test(since) && Number.isNaN(Date.parse(since))))) {
-        throw new Error(`--since takes a duration (15m, 1h, 1d) or an ISO time, not "${since}".`);
-    }
-    const follow = !!flags.follow;
-    const platform = client();
-
-    let nextToken;
-    let printed = 0;
-    // Events already printed at the latest timestamp, so polling again from that time doesn't repeat them.
-    let lastTime;
-    let seenAtLast = new Set();
-    if (follow) log(`Following ${name} logs (Ctrl+C to stop)…`);
-
-    while (!signal?.aborted) {
-        const page = await platform.functionLogs(manifest.slug, name, { since, nextToken });
-        for (const event of page.events ?? []) {
-            const time = toIso(event.timestamp);
-            const key = `${time}\n${event.message}`;
-            if (time === lastTime && seenAtLast.has(key)) continue;
-            if (time !== lastTime) {
-                lastTime = time;
-                seenAtLast = new Set();
-            }
-            seenAtLast.add(key);
-            log(`${time}  ${String(event.message ?? '').replace(/\s+$/, '')}`);
-            printed += 1;
-        }
-        if (page.nextToken) {
-            nextToken = page.nextToken;
-            // More pages now; when following, the platform may also hand back a token to poll with.
-            if (page.events?.length || !follow) continue;
-        } else {
-            nextToken = undefined;
-            if (!follow) break;
-            if (lastTime) since = lastTime;
-        }
-        await sleep(FOLLOW_INTERVAL_MS);
-    }
-    if (!follow && !printed) log(`No log events for ${name}${since ? ` since ${since}` : ''}.`);
-    return 0;
-}
-
-function toIso(timestamp) {
-    if (typeof timestamp === 'number') return new Date(timestamp).toISOString();
-    const parsed = Date.parse(timestamp);
-    return Number.isNaN(parsed) ? String(timestamp ?? '') : new Date(parsed).toISOString();
-}
+export const FOLLOW_INTERVAL_MS = 2_000;
+const SINCE = /^\d+[mhd]$/;
+const USAGE = 'Usage: hawk-app logs <function> [--since 15m|1h|1d|<ISO time>] [--follow]';
+
+const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+/**
+ * `hawk-app logs <function>`: prints the function's log events (all versions), page by page. With --follow it keeps
+ * polling every 2 s (with the platform's nextToken, or from the last event's time) until Ctrl+C or `signal` aborts.
+ */
+export async function logsCommand({ client, manifest, name, flags = {}, sleep = wait, signal, log = console.log }) {
+    if (!name) throw new Error(USAGE);
+    const declared = manifest.functions && typeof manifest.functions === 'object' ? Object.keys(manifest.functions) : [];
+    if (!declared.includes(name)) {
+        throw new Error(`"${name}" is not a function of ${manifest.slug}${declared.length ? ` (functions: ${declared.join(', ')})` : ' (hawk-app.json declares no functions)'}.`);
+    }
+    let since = flags.since;
+    if (since !== undefined && (typeof since !== 'string' || (!SINCE.test(since) && Number.isNaN(Date.parse(since))))) {
+        throw new Error(`--since takes a duration (15m, 1h, 1d) or an ISO time, not "${since}".`);
+    }
+    const follow = !!flags.follow;
+    const platform = client();
+
+    let nextToken;
+    let printed = 0;
+    // Events already printed at the latest timestamp, so polling again from that time doesn't repeat them.
+    let lastTime;
+    let seenAtLast = new Set();
+    if (follow) log(`Following ${name} logs (Ctrl+C to stop)…`);
+
+    while (!signal?.aborted) {
+        const page = await platform.functionLogs(manifest.slug, name, { since, nextToken });
+        for (const event of page.events ?? []) {
+            const time = toIso(event.timestamp);
+            const key = `${time}\n${event.message}`;
+            if (time === lastTime && seenAtLast.has(key)) continue;
+            if (time !== lastTime) {
+                lastTime = time;
+                seenAtLast = new Set();
+            }
+            seenAtLast.add(key);
+            log(`${time}  ${String(event.message ?? '').replace(/\s+$/, '')}`);
+            printed += 1;
+        }
+        if (page.nextToken) {
+            nextToken = page.nextToken;
+            // More pages now; when following, the platform may also hand back a token to poll with.
+            if (page.events?.length || !follow) continue;
+        } else {
+            nextToken = undefined;
+            if (!follow) break;
+            if (lastTime) since = lastTime;
+        }
+        await sleep(FOLLOW_INTERVAL_MS);
+    }
+    if (!follow && !printed) log(`No log events for ${name}${since ? ` since ${since}` : ''}.`);
+    return 0;
+}
+
+function toIso(timestamp) {
+    if (typeof timestamp === 'number') return new Date(timestamp).toISOString();
+    const parsed = Date.parse(timestamp);
+    return Number.isNaN(parsed) ? String(timestamp ?? '') : new Date(parsed).toISOString();
+}