@canner-ca/cli 0.5.6 → 0.5.7

package/README.md

@@ -76,7 +76,8 @@ canner deploy --follow
 | `canner domains verify <hostname\|id> [--slug X]` | Re-check DNS and provision TLS. |
 | `canner domains rm <hostname\|id> [--slug X]` | Detach a custom domain. |
 | `canner jobs [list] [--slug X]` | List scheduled jobs, with the header names each sends (never a value). |
-| `canner jobs create <name> (--path /api/cron [--branch BRANCH] \| --url URL) --schedule "CRON" [--header name=value] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--slug X]` | Create a job. `--path` calls a path in the project itself (its address is built from the project's own host each time, in production or, with `--branch`, on that preview); `--url` is for anything else. `--header-env x-cron-key=CRON_KEY` sends the project variable's value, read each time the job runs, so the secret is never copied. `--bearer-env CRON_SECRET` sends `Authorization: Bearer …`. With a `CRON_SECRET` variable and no Authorization header, Canner sends it automatically. |
+| `canner jobs create <name> (--path /api/cron [--branch BRANCH] \| --url URL) --schedule "CRON" [--header name=value] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--slug X]` | Create a job. `--path` calls a path in the project itself (in Git Bash on Windows write `--path //api/cron`, or Git Bash rewrites the leading slash) (its address is built from the project's own host each time, in production or, with `--branch`, on that preview); `--url` is for anything else. `--header-env x-cron-key=CRON_KEY` sends the project variable's value, read each time the job runs, so the secret is never copied. `--bearer-env CRON_SECRET` sends `Authorization: Bearer …`. With a `CRON_SECRET` variable and no Authorization header, Canner sends it automatically. |
+| `canner jobs edit <id> [--name N] [--schedule "CRON"] [--description D] [--pause \| --resume] [--path /p [--branch B \| --production] \| --url U] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--header name=value] [--remove-header name] [--clear-headers]` | Change a job in place; only the options you give change, and its run history stays. A header given by name replaces the one with that name and the others are kept. |
 | `canner jobs run <id>` / `canner jobs runs <id>` | Run a job now and show the result, or list recent runs with what to check on a failure. |
 | `canner jobs delete <id> --yes` | Delete a job and its run history. |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canner-ca/cli",
-  "version": "0.5.6",
+  "version": "0.5.7",
   "description": "Canner deploy CLI — git push from any terminal, no GitHub required",
   "type": "module",
   "bin": {

package/src/cli.mjs

@@ -28,7 +28,7 @@ import { randomUUID } from 'node:crypto';
 import { stdin as input, stdout as output } from 'node:process';
 import { create as tarCreate } from 'tar';
 
-const VERSION = '0.5.6';
+const VERSION = '0.5.7';
 const DEFAULT_API_BASE = 'https://api.canner.ca';
 const CONFIG_DIR = join(homedir(), '.canner');
 const CREDENTIALS_PATH = join(CONFIG_DIR, 'credentials');
@@ -1129,6 +1129,7 @@ const BOOLEAN_FLAGS = new Set([
   'json', 'reveal', 'sensitive', 'follow', 'dashboard', 'version', 'help',
   'replace', 'yes', 'no-wait', 'enable', 'disable', 'restore', 'download', 'rm', 'delete', 'instance', 'pitr',
   'read-only', 'read-write', 'replication', 'group', 'login', 'adopt', 'strict', 'dedicated',
+  'pause', 'resume', 'production', 'clear-headers',
 ]);
 
 const splitList = (v) => String(v).split(',').map((x) => x.trim()).filter(Boolean);
@@ -1370,6 +1371,11 @@ async function cmdBilling(args) {
 //         [--header "name=value" ...] [--header-env name=VARIABLE ...] [--bearer-env VARIABLE]
 //   (--path calls a path in the project itself: its address is built from the project's own host each time, in
 //    production or, with --branch, on that preview; --url is for anything else)
+//   canner jobs edit <id> [--name N] [--schedule "CRON"] [--description D] [--pause | --resume]
+//         [--path /p [--branch B | --production] | --url U]
+//         [--header-env name=VARIABLE ...] [--bearer-env VARIABLE] [--header name=value ...]
+//         [--remove-header name ...] [--clear-headers]
+//   (edit changes only what is given. A header given by name replaces the one with that name; the others stay.)
 //   canner jobs run <id>                                 run it now and show what came back
 //   canner jobs runs <id>                                recent runs, with what to check on a failure
 //   canner jobs delete <id> --yes
@@ -1381,6 +1387,16 @@ async function cmdBilling(args) {
 // ---------------------------------------------------------------------------
 const asList = (v) => (v === undefined || v === true ? [] : Array.isArray(v) ? v : [v]);
 
+// A path argument, as the API wants it (leading slash). Git Bash on Windows rewrites an argument that starts with
+// "/" into a Windows path (C:/Program Files/Git/api/cron) before any program sees it; say so instead of sending that.
+function pathArg(raw) {
+  const p = String(raw);
+  if (/^[A-Za-z]:[\\/]/.test(p)) {
+    die(`"${p}" is not a path in your project. Git Bash on Windows rewrites arguments that start with "/": write it with a doubled slash (--path //api/cron), or run the command with MSYS_NO_PATHCONV=1.`, 2);
+  }
+  return p.startsWith('//') && !p.startsWith('///') ? p.slice(1) : p.startsWith('/') ? p : `/${p}`;
+}
+
 function jobHeadersFromArgs(args) {
   const headers = {};
   const put = (name, value) => {
@@ -1449,7 +1465,7 @@ async function cmdJobs(args) {
     const headers = jobHeadersFromArgs(args);
     const body = await apiJSON(creds, 'POST', `/projects/${encodeURIComponent(slug)}/jobs`, {
       name, schedule: String(args.schedule),
-      ...(args.path ? { path: String(args.path), ...(args.branch ? { branch: String(args.branch) } : {}) } : { url: String(args.url) }),
+      ...(args.path ? { path: pathArg(args.path), ...(args.branch ? { branch: String(args.branch) } : {}) } : { url: String(args.url) }),
       ...(args.description ? { description: String(args.description) } : {}),
       ...(Object.keys(headers).length > 0 ? { headers } : {}),
     });
@@ -1490,6 +1506,48 @@ async function cmdJobs(args) {
     return;
   }
 
+  if (sub === 'edit' || sub === 'update') {
+    if (!args._[1]) die('usage: canner jobs edit <id> [--schedule "CRON"] [--path /p [--branch B | --production] | --url U] [--header-env name=VARIABLE] [--bearer-env VARIABLE] [--remove-header name] [--clear-headers] [--pause | --resume]', 2);
+    if (args.url && args.path) die('give either --url or --path, not both.', 2);
+    if (args.branch && args.production) die('give either --branch or --production, not both.', 2);
+    if (args.pause && args.resume) die('give either --pause or --resume, not both.', 2);
+    if ((args.branch || args.production) && args.url) die('--branch / --production go with --path.', 2);
+    const job = await findJob(creds, args._[1]);
+
+    const patchBody = {};
+    if (args.name) patchBody.name = String(args.name);
+    if (args.schedule) patchBody.schedule = String(args.schedule);
+    if (args.description !== undefined && args.description !== true) patchBody.description = String(args.description);
+    if (args.pause) patchBody.is_active = false;
+    if (args.resume) patchBody.is_active = true;
+    if (args.path) patchBody.path = pathArg(args.path);
+    if (args.url) patchBody.url = String(args.url);
+    if (args.branch) patchBody.branch = String(args.branch);
+    if (args.production) patchBody.branch = null;
+
+    // Headers: start from what the job has (references as written, literal values hidden — the server keeps
+    // a hidden value as is), drop what was asked to go, and let a header given by name replace its namesake.
+    const added = jobHeadersFromArgs(args);
+    const removed = asList(args['remove-header']).map((n) => String(n).toLowerCase());
+    if (Object.keys(added).length > 0 || removed.length > 0 || args['clear-headers']) {
+      const lower = (n) => n.toLowerCase();
+      const replaced = new Set(Object.keys(added).map(lower));
+      const kept = args['clear-headers']
+        ? {}
+        : Object.fromEntries(Object.entries(job.headers ?? {}).filter(([n]) => !replaced.has(lower(n)) && !removed.includes(lower(n))));
+      patchBody.headers = { ...kept, ...added };
+    }
+    if (Object.keys(patchBody).length === 0) die('nothing to change. Give at least one option (canner jobs edit <id> --help-style usage above).', 2);
+
+    const body = await apiJSON(creds, 'PATCH', `/projects/${encodeURIComponent(job.project_slug)}/jobs/${job.id}`, patchBody);
+    if (JSON_MODE) return emitJSON(body);
+    info(`${green('updated')} ${bold(body.job?.name ?? job.name)}`);
+    info(`  calls    ${body.job?.url ?? job.url}`);
+    info(`  headers  ${describeJobHeaders(body.job?.headers)}`);
+    for (const w of body.warnings ?? []) info(`${yellow('warning')} ${w.message}`);
+    return;
+  }
+
   if (sub === 'delete' || sub === 'rm') {
     if (!args._[1]) die('usage: canner jobs delete <id> --yes', 2);
     const job = await findJob(creds, args._[1]);
@@ -1500,7 +1558,7 @@ async function cmdJobs(args) {
     return;
   }
 
-  die('usage: canner jobs [list] | create <name> ... | run <id> | runs <id> | delete <id> --yes', 2);
+  die('usage: canner jobs [list] | create <name> ... | edit <id> ... | run <id> | runs <id> | delete <id> --yes', 2);
 }
 
 async function cmdDb(args) {
@@ -2821,11 +2879,13 @@ ${bold('Databases:')}
                        Create the primary on its own dedicated instance with
                        point-in-time recovery. If the project has no unit, this
                        buys one: it shows the price and needs --yes.
-  ${bold('jobs')} [list] | create <name> (--path /p [--branch B] | --url U) --schedule "CRON" | run <id> | runs <id> | delete <id> --yes
+  ${bold('jobs')} [list] | create <name> (--path /p [--branch B] | --url U) --schedule "CRON" | edit <id> | run <id> | runs <id> | delete <id> --yes
                        Scheduled jobs. --path calls a path in the project itself
                        (production, or a preview with --branch). A header can read a
                        project variable: --header-env x-cron-key=CRON_KEY or
-                       --bearer-env CRON_SECRET.
+                       --bearer-env CRON_SECRET. "jobs edit <id>" changes only the
+                       options you give (--schedule, --path, --header-env,
+                       --remove-header, --pause / --resume ...).
   ${bold('billing')} addons | preview <addon> <quantity>
                        See the add-ons you own and where they are assigned, and
                        preview a quantity change. Read-only; nothing is charged.