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

package/src/config.mjs

@@ -1,148 +1,148 @@
-import { CLIENT_ID } from './clients.mjs';
-import { CONFIG_KEY, configValueError } from './manifest.mjs';
-
-const USAGE = `Usage:
-  hawk-app config list [--client <id>]
-  hawk-app config set <key> <value> [--client <id>]
-  hawk-app config unset <key> [--client <id>]`;
-
-/**
- * `hawk-app config …`: the app's config values (declared in "config" in hawk-app.json), set for the whole app (global)
- * or one client (`--client`). Values apply within about 30 seconds, without a deploy or approval, and are not secret:
- * they reach the app's browser code. `client` is a factory, so a usage mistake shows before any login check.
- */
-export async function configCommand({ client, manifest, sub, args = [], flags = {}, log = console.log }) {
-    const slug = manifest.slug;
-    // A bare --client (no id after it) is a mistake, never the global value.
-    const clientId = Object.hasOwn(flags, 'client') ? checkClient(flags.client) : null;
-    const layer = clientId ? `client ${clientId}` : 'global';
-    switch (sub) {
-        case 'list': {
-            const { keys = [] } = await call(() => client().getConfig(slug), slug);
-            const localKeys = declared(manifest);
-            if (!keys.length) {
-                log(`${slug} has no config keys on the platform. Declare them in "config" in hawk-app.json and deploy (or \`hawk-app register\`).`);
-            } else {
-                log(`${keys.length} config key${keys.length === 1 ? '' : 's'} for ${slug}${clientId ? `, client ${clientId}` : ''} (values are not secret: they reach the browser):`);
-                for (const k of keys) {
-                    const head = k.declared === false ? `(not declared: its values are ignored; hawk-app config unset ${k.key} deletes them)` :`${k.type}  ${k.default === null || k.default === undefined ? 'no default' : `default ${formatValue(k.default)}`}`;
-                    log(`  ${k.key}  ${head}`);
-                    const rows = [['global', k.global], ...(k.clients ?? []).filter((c) => !clientId || c.clientId === clientId).map((c) => [c.clientId, c])];
-                    if (clientId && !rows.some(([id]) => id === clientId)) rows.push([clientId, null]);
-                    const width = Math.max(...rows.map(([id]) => id.length));
-                    for (const [id, stored] of rows) log(`    ${id.padEnd(width)}  ${describeStored(stored)}`);
-                }
-            }
-            const missing = [...localKeys.keys()].filter((key) => !keys.some((k) => k.key === key));
-            for (const key of missing) log(`! ${key} is in hawk-app.json but not on the platform yet: deploy (or \`hawk-app register\`) to declare it.`);
-            return 0;
-        }
-
-        case 'set': {
-            const [key, raw] = args;
-            if (!key || raw === undefined) throw new Error(USAGE);
-            const declaration = local(manifest, key);
-            const value = parseValue(key, declaration.type, raw);
-            await write(client, slug, key, value, clientId);
-            log(`✔ Set ${key} for ${slug} (${layer}): ${formatValue(value)}. It applies within about 30 seconds, without a deploy.`);
-            return 0;
-        }
-
-        case 'unset': {
-            const [key] = args;
-            if (!key) throw new Error(USAGE);
-            if (!CONFIG_KEY.test(key)) throw new Error(`"${key}" is not a valid config key: a letter, then letters, digits and "_" (at most 64 characters).`);
-            await write(client, slug, key, null, clientId);
-            log(
-                `✔ Cleared ${key} for ${slug} (${layer}). ${clientId ? `${clientId} now gets the global value, else the default.` : "Clients without their own value now get the default."}`,
-            );
-            return 0;
-        }
-
-        default:
-            throw new Error(sub ? `Unknown config command "${sub}".\n${USAGE}` : USAGE);
-    }
-}
-
-function checkClient(id) {
-    if (typeof id !== 'string' || !id) throw new Error(`--client needs a client id, e.g. --client e3141.\n${USAGE}`);
-    if (!CLIENT_ID.test(id)) throw new Error(`"${id}" is not a valid client id: 1-100 letters, digits, "_", "." or "-" (e.g. e3141).`);
-    return id;
-}
-
-/** Key → declaration, from the local hawk-app.json. */
-function declared(manifest) {
-    const config = manifest.config && typeof manifest.config === 'object' && !Array.isArray(manifest.config) ? manifest.config : {};
-    return new Map(Object.entries(config).filter(([, d]) => d && typeof d === 'object'));
-}
-
-function local(manifest, key) {
-    const declaration = declared(manifest).get(key);
-    if (!declaration) throw new Error(`${key} isn't declared in hawk-app.json: add it to "config" with its type (e.g. "${key}": { "type": "string" }), then deploy.`);
-    return declaration;
-}
-
-/** The command-line text as a value of the key's declared type, checked like the platform checks it. */
-export function parseValue(key, type, raw) {
-    let value;
-    switch (type) {
-        case 'string':
-            value = raw;
-            break;
-        case 'number':
-            value = raw.trim() === '' ? NaN : Number(raw);
-            if (!Number.isFinite(value)) throw new Error(`${key} is a number: "${raw}" isn't one.`);
-            break;
-        case 'boolean':
-            if (raw !== 'true' && raw !== 'false') throw new Error(`${key} is a boolean: use true or false, not "${raw}".`);
-            value = raw === 'true';
-            break;
-        case 'emails':
-            value = raw.split(',').map((a) => a.trim()).filter(Boolean);
-            break;
-        case 'json':
-            try {
-                value = JSON.parse(raw);
-            } catch (error) {
-                throw new Error(`${key} is JSON, but "${raw}" isn't valid JSON (${error.message}). Quote it for your shell, e.g. '{"a":1}'.`);
-            }
-            break;
-        default:
-            throw new Error(`${key} has no valid type in hawk-app.json ("${type}"): run \`hawk-app validate\`.`);
-    }
-    const problem = configValueError(type, value, key);
-    if (problem) throw new Error(problem);
-    return value;
-}
-
-async function write(client, slug, key, value, clientId) {
-    try {
-        return await call(() => client().setConfig(slug, key, value, clientId), slug);
-    } catch (error) {
-        if (error.data?.code === 'config_key_not_declared') {
-            throw new Error(`${key} isn't declared on the platform: deploy (or \`hawk-app register\`) hawk-app.json with it in "config" first.`);
-        }
-        throw error;
-    }
-}
-
-async function call(fn, slug) {
-    try {
-        return await fn();
-    } catch (error) {
-        if (error.data?.code === 'app_not_found') throw new Error(`${slug} isn't on the platform yet: \`npm run app:dev\` or \`npm run app:deploy\` adds it.`);
-        throw error;
-    }
-}
-
-function describeStored(stored) {
-    if (!stored) return 'not set';
-    const when = stored.updatedAt ? `  (${stored.updatedAt.slice(0, 16).replace('T', ' ')}${stored.updatedBy ? ` by ${stored.updatedBy}` : ''})` : '';
-    return `${formatValue(stored.value)}${stored.valid === false ? '  ! invalid for its type: ignored' : ''}${when}`;
-}
-
-/** A value for the terminal: emails as a list, the rest as JSON, cut at 100 characters. */
-function formatValue(value) {
-    const text = Array.isArray(value) && value.every((v) => typeof v === 'string' && v.includes('@')) && value.length ? value.join(', ') : JSON.stringify(value);
-    return text.length > 100 ? `${text.slice(0, 99)}…` : text;
-}
+import { CLIENT_ID } from './clients.mjs';
+import { CONFIG_KEY, configValueError } from './manifest.mjs';
+
+const USAGE = `Usage:
+  hawk-app config list [--client <id>]
+  hawk-app config set <key> <value> [--client <id>]
+  hawk-app config unset <key> [--client <id>]`;
+
+/**
+ * `hawk-app config …`: the app's config values (declared in "config" in hawk-app.json), set for the whole app (global)
+ * or one client (`--client`). Values apply within about 30 seconds, without a deploy or approval, and are not secret:
+ * they reach the app's browser code. `client` is a factory, so a usage mistake shows before any login check.
+ */
+export async function configCommand({ client, manifest, sub, args = [], flags = {}, log = console.log }) {
+    const slug = manifest.slug;
+    // A bare --client (no id after it) is a mistake, never the global value.
+    const clientId = Object.hasOwn(flags, 'client') ? checkClient(flags.client) : null;
+    const layer = clientId ? `client ${clientId}` : 'global';
+    switch (sub) {
+        case 'list': {
+            const { keys = [] } = await call(() => client().getConfig(slug), slug);
+            const localKeys = declared(manifest);
+            if (!keys.length) {
+                log(`${slug} has no config keys on the platform. Declare them in "config" in hawk-app.json and deploy (or \`hawk-app register\`).`);
+            } else {
+                log(`${keys.length} config key${keys.length === 1 ? '' : 's'} for ${slug}${clientId ? `, client ${clientId}` : ''} (values are not secret: they reach the browser):`);
+                for (const k of keys) {
+                    const head = k.declared === false ? `(not declared: its values are ignored; hawk-app config unset ${k.key} deletes them)` :`${k.type}  ${k.default === null || k.default === undefined ? 'no default' : `default ${formatValue(k.default)}`}`;
+                    log(`  ${k.key}  ${head}`);
+                    const rows = [['global', k.global], ...(k.clients ?? []).filter((c) => !clientId || c.clientId === clientId).map((c) => [c.clientId, c])];
+                    if (clientId && !rows.some(([id]) => id === clientId)) rows.push([clientId, null]);
+                    const width = Math.max(...rows.map(([id]) => id.length));
+                    for (const [id, stored] of rows) log(`    ${id.padEnd(width)}  ${describeStored(stored)}`);
+                }
+            }
+            const missing = [...localKeys.keys()].filter((key) => !keys.some((k) => k.key === key));
+            for (const key of missing) log(`! ${key} is in hawk-app.json but not on the platform yet: deploy (or \`hawk-app register\`) to declare it.`);
+            return 0;
+        }
+
+        case 'set': {
+            const [key, raw] = args;
+            if (!key || raw === undefined) throw new Error(USAGE);
+            const declaration = local(manifest, key);
+            const value = parseValue(key, declaration.type, raw);
+            await write(client, slug, key, value, clientId);
+            log(`✔ Set ${key} for ${slug} (${layer}): ${formatValue(value)}. It applies within about 30 seconds, without a deploy.`);
+            return 0;
+        }
+
+        case 'unset': {
+            const [key] = args;
+            if (!key) throw new Error(USAGE);
+            if (!CONFIG_KEY.test(key)) throw new Error(`"${key}" is not a valid config key: a letter, then letters, digits and "_" (at most 64 characters).`);
+            await write(client, slug, key, null, clientId);
+            log(
+                `✔ Cleared ${key} for ${slug} (${layer}). ${clientId ? `${clientId} now gets the global value, else the default.` : "Clients without their own value now get the default."}`,
+            );
+            return 0;
+        }
+
+        default:
+            throw new Error(sub ? `Unknown config command "${sub}".\n${USAGE}` : USAGE);
+    }
+}
+
+function checkClient(id) {
+    if (typeof id !== 'string' || !id) throw new Error(`--client needs a client id, e.g. --client e3141.\n${USAGE}`);
+    if (!CLIENT_ID.test(id)) throw new Error(`"${id}" is not a valid client id: 1-100 letters, digits, "_", "." or "-" (e.g. e3141).`);
+    return id;
+}
+
+/** Key → declaration, from the local hawk-app.json. */
+function declared(manifest) {
+    const config = manifest.config && typeof manifest.config === 'object' && !Array.isArray(manifest.config) ? manifest.config : {};
+    return new Map(Object.entries(config).filter(([, d]) => d && typeof d === 'object'));
+}
+
+function local(manifest, key) {
+    const declaration = declared(manifest).get(key);
+    if (!declaration) throw new Error(`${key} isn't declared in hawk-app.json: add it to "config" with its type (e.g. "${key}": { "type": "string" }), then deploy.`);
+    return declaration;
+}
+
+/** The command-line text as a value of the key's declared type, checked like the platform checks it. */
+export function parseValue(key, type, raw) {
+    let value;
+    switch (type) {
+        case 'string':
+            value = raw;
+            break;
+        case 'number':
+            value = raw.trim() === '' ? NaN : Number(raw);
+            if (!Number.isFinite(value)) throw new Error(`${key} is a number: "${raw}" isn't one.`);
+            break;
+        case 'boolean':
+            if (raw !== 'true' && raw !== 'false') throw new Error(`${key} is a boolean: use true or false, not "${raw}".`);
+            value = raw === 'true';
+            break;
+        case 'emails':
+            value = raw.split(',').map((a) => a.trim()).filter(Boolean);
+            break;
+        case 'json':
+            try {
+                value = JSON.parse(raw);
+            } catch (error) {
+                throw new Error(`${key} is JSON, but "${raw}" isn't valid JSON (${error.message}). Quote it for your shell, e.g. '{"a":1}'.`);
+            }
+            break;
+        default:
+            throw new Error(`${key} has no valid type in hawk-app.json ("${type}"): run \`hawk-app validate\`.`);
+    }
+    const problem = configValueError(type, value, key);
+    if (problem) throw new Error(problem);
+    return value;
+}
+
+async function write(client, slug, key, value, clientId) {
+    try {
+        return await call(() => client().setConfig(slug, key, value, clientId), slug);
+    } catch (error) {
+        if (error.data?.code === 'config_key_not_declared') {
+            throw new Error(`${key} isn't declared on the platform: deploy (or \`hawk-app register\`) hawk-app.json with it in "config" first.`);
+        }
+        throw error;
+    }
+}
+
+async function call(fn, slug) {
+    try {
+        return await fn();
+    } catch (error) {
+        if (error.data?.code === 'app_not_found') throw new Error(`${slug} isn't on the platform yet: \`npm run app:dev\` or \`npm run app:deploy\` adds it.`);
+        throw error;
+    }
+}
+
+function describeStored(stored) {
+    if (!stored) return 'not set';
+    const when = stored.updatedAt ? `  (${stored.updatedAt.slice(0, 16).replace('T', ' ')}${stored.updatedBy ? ` by ${stored.updatedBy}` : ''})` : '';
+    return `${formatValue(stored.value)}${stored.valid === false ? '  ! invalid for its type: ignored' : ''}${when}`;
+}
+
+/** A value for the terminal: emails as a list, the rest as JSON, cut at 100 characters. */
+function formatValue(value) {
+    const text = Array.isArray(value) && value.every((v) => typeof v === 'string' && v.includes('@')) && value.length ? value.join(', ') : JSON.stringify(value);
+    return text.length > 100 ? `${text.slice(0, 99)}…` : text;
+}