@shipvo/cli 0.1.4 → 0.1.6

package/dist/preview.js

@@ -4,6 +4,8 @@ import { spawn } from "node:child_process";
 import { existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync } from "node:fs";
 import { join, relative, sep, extname } from "node:path";
 import { args as parse, loadConfig } from "./config.js";
+import { spawnBin } from "./spawn-bin.js";
+import { RECORDER_JS } from "./preview-recorder.js";
 const API = "https://here.now/api/v1";
 const CLIENT = "shipvo/cli";
 const TYPES = {
@@ -72,8 +74,8 @@ export function collectFiles(dir) {
     walk(dir);
     return out;
 }
-/** The page people open: the app in an Android or iPhone frame, with skin, size and theme switches and a back control. */
-export function framePage(name) {
+/** The page people open: the app in an Android or iPhone frame, with skin, size and theme switches, a back control and a recorder panel. */
+export function framePage(name, appId = name) {
     const title = name.replace(/[<>&"']/g, "");
     return `<!doctype html>
 <html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,viewport-fit=cover">
@@ -85,7 +87,7 @@ body.dark{background:#15171a;color:#eee}
 .bar{display:flex;gap:8px;justify-content:center;align-items:center;padding:10px;flex-wrap:wrap}
 .bar button,.back{font:inherit;padding:6px 12px;border:1px solid #888;border-radius:8px;background:transparent;color:inherit;cursor:pointer}
 .bar button[aria-pressed=true]{background:#2563eb;border-color:#2563eb;color:#fff}
-.stage{display:flex;justify-content:center;padding:0 10px 20px}
+.stage{display:flex;justify-content:center;align-items:flex-start;gap:16px;padding:0 10px 20px;flex-wrap:wrap}
 .device{display:flex;flex-direction:column;background:#000;color:#fff;border-radius:28px;box-shadow:0 8px 30px #0005;overflow:hidden;width:360px;max-width:100%;box-sizing:border-box;padding:0 6px}
 .device[data-skin=iphone]{border-radius:44px;padding:0 10px}
 .status{display:flex;justify-content:space-between;align-items:center;height:28px;padding:0 14px;font-size:12px;flex:none}
@@ -103,42 +105,138 @@ iframe{border:0;background:#fff;width:100%;flex:1;min-height:0;display:block}
 .device[data-skin=iphone] .back::after{content:"";position:absolute;left:0;right:0;top:50%;height:5px;margin-top:-2px;border-radius:3px;background:#fff}
 .back:focus-visible{outline:2px solid #fff;outline-offset:2px}
 .device[data-skin=android] .back{border:0}
+.side{max-width:360px;margin:0 auto 20px;padding:0 10px;box-sizing:border-box}
+.side h2{font-size:14px;margin:0 0 6px}.side ol{padding-left:20px;margin:6px 0}.side li{margin-bottom:6px}.side small{opacity:.7}
+.side button,.side input{font:inherit}
+.side input{width:100%;box-sizing:border-box;min-height:36px;background:transparent;color:inherit;border:1px solid #888;border-radius:6px;padding:4px 8px;margin:4px 0}
+body.dark .side input{background:#15171a;color:#eee}body.dark .side small{opacity:.85}
+.fab{position:fixed;right:12px;bottom:12px;z-index:10;min-width:44px;min-height:44px;padding:8px 14px;font:inherit;border:1px solid #888;border-radius:22px;background:#fff;color:#111;cursor:pointer;box-shadow:0 2px 8px #0004}
+.fab[aria-pressed=true]{background:#2563eb;border-color:#2563eb;color:#fff}
+.fab:focus-visible{outline:3px solid #f59e0b;outline-offset:2px}
+body.dark .fab{background:#2a2d31;color:#eee}body.dark .fab[aria-pressed=true]{background:#2563eb;color:#fff}
+.device{position:relative}
+#pin{position:absolute;inset:0;display:none;cursor:crosshair;background:#2563eb22;z-index:5}
+#pin.on{display:block}
+#pin .hint{position:absolute;left:8px;right:8px;top:8px;padding:6px 8px;border-radius:6px;background:#111;color:#fff;font-size:13px;text-align:center}
 .note{text-align:center;opacity:.7;padding:0 12px 16px}
-@media (max-width:500px){.bar,.note{display:none}.stage{padding:0}.device{padding:0!important;width:100vw!important;height:100vh!important;height:100dvh!important;border-radius:0!important;box-shadow:none}}
+.recp a{color:inherit;text-decoration:underline}body.dark .recp a{color:#93c5fd}.recp button:focus-visible,.bar button:focus-visible,.recp a:focus-visible{outline:2px solid #60a5fa;outline-offset:2px}
+.recp{max-width:520px;margin:0 auto;padding:0 12px 24px;text-align:center}.recp p{opacity:.8}.recp button{font:inherit;padding:6px 12px;border:1px solid #888;border-radius:8px;background:transparent;color:inherit;cursor:pointer}
+.panel{width:280px;max-width:100%;box-sizing:border-box;display:grid;gap:10px;padding:12px;border:1px solid #8886;border-radius:12px}
+.panel h2{font-size:15px;margin:0}.panel fieldset{border:0;margin:0;padding:0;display:grid;gap:6px}.panel legend{font-weight:600;padding:0 0 4px}
+.panel .row{display:flex;gap:6px;flex-wrap:wrap}.panel input,.panel select,.panel button{font:inherit;padding:5px 8px;border:1px solid #888;border-radius:8px;background:transparent;color:inherit;min-width:0}
+body.dark .panel select,body.dark .panel option{background:#15171a;color:#eee}.panel button[aria-pressed=true]{background:#2563eb;border-color:#2563eb;color:#fff}.panel input{flex:1 1 80px}.panel button{cursor:pointer}.panel .sim{opacity:.7;font-size:12px;margin:0}
+@media (max-width:500px){.bar,.note{display:none}.stage{padding:0;display:block}.panel{width:auto;margin:10px;max-width:none}.device{padding:0!important;width:100vw!important;height:100vh!important;height:100dvh!important;border-radius:0!important;box-shadow:none}}
 </style></head><body>
 <div class="bar" role="toolbar" aria-label="Preview options">
 <button data-skin="android" aria-pressed="true">Android</button><button data-skin="iphone" aria-pressed="false">iPhone</button>
 <button data-size="phone" aria-pressed="true">Phone</button><button data-size="large" aria-pressed="false">Large phone</button><button data-size="tablet" aria-pressed="false">Tablet</button>
 <button id="theme" aria-pressed="false">Dark</button></div>
+<button id="comment" class="fab" aria-pressed="false">Comment</button>
 <div class="stage"><div class="device" id="device" data-skin="android" style="width:360px;height:760px">
 <div class="status" id="status"><span id="clock">9:41</span><span class="notch"></span><span class="icons" id="icons">&#9679;&#9679; 5G 100%</span></div>
-<iframe id="app" src="app.html" title="${title}"></iframe>
+<iframe id="app" src="app.html" title="${title}"></iframe><div id="pin" role="button" tabindex="0" aria-label="Tap where the problem is, or press Enter to mark the centre of the device"><span class="hint">Tap where the problem is. Press Escape to cancel.</span></div>
 <div class="nav"><button class="back" id="back" aria-label="Back" title="Back">&#9664; Back</button></div>
-</div></div>
+</div>
+<aside class="panel" id="device-panel" aria-label="Device controls"><h2>Device</h2>
+<fieldset><legend>Location</legend><div class="row"><select data-control="location-list" aria-label="Place"><option value="4.0511,9.7679">Douala</option><option value="48.8566,2.3522">Paris</option><option value="40.7128,-74.006">New York</option><option value="-1.2921,36.8219">Nairobi</option></select><button data-control="location-set">Set</button></div>
+<div class="row"><input data-control="lat" placeholder="Latitude" inputmode="decimal" aria-label="Latitude"><input data-control="lng" placeholder="Longitude" inputmode="decimal" aria-label="Longitude"><button data-control="coords-set">Go</button></div></fieldset>
+<fieldset><legend>Camera</legend><div class="row"><select data-control="camera-list" aria-label="Barcode"><option value="ean13|6181234567890">EAN-13 6181234567890</option><option value="qr|https://example.com">QR https://example.com</option><option value="none|">Nothing in view</option></select><button data-control="camera-set">Show</button></div></fieldset>
+<fieldset><legend>Fingerprint / Face ID</legend><div class="row"><button data-control="bio-success">Match</button><button data-control="bio-fail">No match</button></div></fieldset>
+<fieldset><legend>Payment</legend><div class="row"><button data-control="pay-approve">Approve</button><button data-control="pay-decline">Decline</button></div></fieldset>
+<fieldset><legend>Network</legend><div class="row"><button data-control="net-online">Online</button><button data-control="net-slow">Slow</button><button data-control="net-offline">Offline</button></div></fieldset>
+<fieldset><legend>Push notification</legend><input data-control="push-title" placeholder="Title" aria-label="Title"><input data-control="push-body" placeholder="Body" aria-label="Body"><button data-control="push-send">Send</button></fieldset>
+<p class="sim" id="panel-status" role="status">All device events here are simulated.</p></aside>
+</div>
+<div class="side" id="side"><h2>Comments (<span id="count">0</span>)</h2>
+<form id="noteform" hidden><label for="notetext">Note for the point you tapped</label><br><input id="notetext"> <button type="submit">Save</button></form><span id="notesaved" role="status"></span>
+<ol id="notelist"></ol>
+<button id="export">Export comments.json</button>
+<p><small>Notes live in this browser until you export them. Nothing is uploaded.</small></p></div>
 <p class="note">${title}: simulated device, public preview. System sheets such as permissions and payments are simulated.</p>
-<script>
+<script data-notes>
+(function(){
+var KEY="shipvo-preview-comments",steps=[],pending=null,notes=[];
+function $(id){return document.getElementById(id)}
+try{notes=JSON.parse(localStorage.getItem(KEY)||"[]");if(!Array.isArray(notes))notes=[]}catch(e){notes=[]}
+function save(){try{localStorage.setItem(KEY,JSON.stringify(notes))}catch(e){}}
+function esc(t){return String(t).replace(/[&<>"']/g,function(c){return"&#"+c.charCodeAt(0)+";"})}
+function screenName(){try{var w=$("app").contentWindow,t=w.document.title,r=w.location.pathname+(w.location.hash||"");return t?t+" ("+r+")":r}catch(e){return"unknown"}}
+function step(text){steps.push(text)}
+function add(note,x,y){var n={note:String(note),x:Math.round(x),y:Math.round(y),screen:screenName(),steps:steps.slice()};notes.push(n);save();render();return n}
+function exportJson(){return JSON.stringify(notes,null,2)}
+function render(){var l=$("notelist"),c=$("count");if(c)c.textContent=notes.length;if(l)l.innerHTML=notes.map(function(n){return"<li>"+esc(n.note)+"<br><small>"+esc(n.screen)+" at "+Number(n.x)+","+Number(n.y)+", "+(n.steps||[]).length+" steps</small></li>"}).join("")}
+function download(){var b=new Blob([exportJson()],{type:"application/json"}),u=URL.createObjectURL(b),a=document.createElement("a");a.href=u;a.download="comments.json";document.body.appendChild(a);a.click();document.body.removeChild(a);URL.revokeObjectURL(u)}
+function label(e){var t=e.getAttribute&&(e.getAttribute("aria-label")||e.textContent)||"";return String(t).trim().slice(0,40)}
+var seen=typeof WeakSet==="function"?new WeakSet():null;
+function watch(){try{var d=$("app").contentWindow.document;if(seen){if(seen.has(d))return;seen.add(d)}d.addEventListener("click",function(ev){var e=ev.target,k=e&&e.closest&&e.closest("button,[role=button],a,input");step("tap "+(k?label(k)||"control":"screen"))},true)}catch(e){}}
+function setMode(on,refocus){var p=$("pin"),b=$("comment");if(p)p.className=on?"on":"";if(b){b.setAttribute("aria-pressed",on);if(refocus&&b.focus)b.focus()}if(on&&p&&p.focus)p.focus()}
+var cb=$("comment");if(cb)cb.onclick=function(){setMode($("pin").className!=="on")};
+function place(x,y){pending={x:x,y:y};setMode(false);$("noteform").hidden=false;if($("notetext").focus)$("notetext").focus()}
+var pin=$("pin");if(pin){pin.onclick=function(ev){var r=pin.getBoundingClientRect?pin.getBoundingClientRect():{left:0,top:0};place(ev.clientX-r.left,ev.clientY-r.top)};
+pin.onkeydown=function(ev){if(ev.key==="Enter"||ev.key===" "){if(ev.preventDefault)ev.preventDefault();var r=pin.getBoundingClientRect?pin.getBoundingClientRect():{width:0,height:0};place((r.width||0)/2,(r.height||0)/2)}}}
+var fm=$("noteform");if(fm)fm.onsubmit=function(ev){if(ev&&ev.preventDefault)ev.preventDefault();var t=$("notetext");if(pending&&t.value.trim()){add(t.value.trim(),pending.x,pending.y)}t.value="";pending=null;fm.hidden=true;var st=$("notesaved");if(st)st.textContent="Saved";setMode(false,true);return false};
+if(document.addEventListener)document.addEventListener("keydown",function(ev){if(ev.key==="Escape"){var was=$("pin")&&$("pin").className==="on",f=$("noteform");if(was||(f&&!f.hidden)){if(f)f.hidden=true;pending=null;setMode(false,true)}}});
+var ex=$("export");if(ex)ex.onclick=download;
+var bk=$("back");if(bk&&bk.addEventListener)bk.addEventListener("click",function(){step("back")});
+var ap=$("app");if(ap){if(ap.addEventListener)ap.addEventListener("load",watch);watch()}
+window.shipvoNotes={add:add,step:step,list:function(){return notes.slice()},exportJson:exportJson,download:download};
+render();
+})();
+</script>
+<section class="recp" aria-label="Recorder"><p id="honesty">This is the app's web build on Shipvo's simulated device, measured against Android and iOS in <a href="https://github.com/shipvo/shipvo/blob/main/docs/parity-results.md">docs/parity-results.md</a>. Native-only UI can differ.</p>
+<button id="rec" aria-pressed="false">Record</button> <button id="dl" disabled>Download test</button> <span id="stepcount" aria-live="polite">0 steps</span></section>
+<script>${RECORDER_JS}
+var APP=${JSON.stringify(appId).replace(/</g, "\\u003c")},TITLE=${JSON.stringify(title).replace(/</g, "\\u003c")},recording=false;
+function step(s){if(recording){shipvoSteps.push(s);document.getElementById("stepcount").textContent=shipvoSteps.length+(shipvoSteps.length===1?" step":" steps");document.getElementById("dl").disabled=false}}
+document.getElementById("app").addEventListener("load",function(){shipvoAttach(this,step)});
+(function(a){if(a.contentDocument&&a.contentDocument.readyState==="complete")shipvoAttach(a,step)})(document.getElementById("app"));
+document.getElementById("rec").onclick=function(){recording=!recording;if(recording){shipvoSteps.length=0;document.getElementById("stepcount").textContent="0 steps";document.getElementById("dl").disabled=true}this.setAttribute("aria-pressed",recording)};
+document.getElementById("dl").onclick=function(){var a=document.createElement("a");a.href=URL.createObjectURL(new Blob([shipvoExport(APP,shipvoSteps,TITLE)],{type:"text/typescript"}));a.download="recorded-session.test.ts";a.click()};
 var SIZES={phone:[360,760],large:[412,892],tablet:[820,1180]},IPHONE={phone:[390,844],large:[430,932],tablet:[820,1180]};
 var skin="android",size="phone",d=document.getElementById("device"),f=document.getElementById("app"),bk=document.getElementById("back");
 function pressed(sel,val,key){document.querySelectorAll(sel).forEach(function(o){o.setAttribute("aria-pressed",o.dataset[key]===val)})}
 function apply(){var s=(skin==="iphone"?IPHONE:SIZES)[size];d.dataset.skin=skin;d.style.width=s[0]+"px";d.style.height=s[1]+"px";bk.innerHTML=skin==="iphone"?"Back":"&#9664; Back";bk.setAttribute("aria-label","Back");document.getElementById("icons").innerHTML=skin==="iphone"?"5G &#9646; 100%":"&#9679;&#9679; 5G 100%";pressed("[data-skin]",skin,"skin");pressed("[data-size]",size,"size")}
-document.querySelectorAll("[data-skin]").forEach(function(b){b.onclick=function(){skin=b.dataset.skin;apply()}});
-document.querySelectorAll("[data-size]").forEach(function(b){b.onclick=function(){size=b.dataset.size;apply()}});
+document.querySelectorAll("[data-skin]").forEach(function(b){b.onclick=function(){step({action:"note",text:"panel: skin set to "+b.dataset.skin});skin=b.dataset.skin;apply()}});
+document.querySelectorAll("[data-size]").forEach(function(b){b.onclick=function(){step({action:"note",text:"panel: size set to "+b.dataset.size});size=b.dataset.size;apply()}});
 // Back does what the simulator's back action does: press the screen's Back button, else go back in history.
 function goBack(){var w=f.contentWindow;try{var doc=w&&w.document;if(!doc)return;var els=doc.querySelectorAll("button,[role=button],a");for(var i=0;i<els.length;i++){var e=els[i],t=(e.getAttribute("aria-label")||e.textContent||"").trim();if(t==="Back"){e.click();return}}w.history.back()}catch(x){}}
 bk.onclick=goBack;
-var t=document.getElementById("theme");t.onclick=function(){var k=!document.body.classList.contains("dark");document.body.classList.toggle("dark",k);t.setAttribute("aria-pressed",k);t.textContent=k?"Light":"Dark";f.style.colorScheme=k?"dark":"light"};
+var t=document.getElementById("theme");t.onclick=function(){step({action:"note",text:"panel: theme toggled"});var k=!document.body.classList.contains("dark");document.body.classList.toggle("dark",k);t.setAttribute("aria-pressed",k);t.textContent=k?"Light":"Dark";f.style.colorScheme=k?"dark":"light"};
+var P=document.getElementById("panel-status");
+function pnSay(m){P.textContent=m+" (simulated)"}
+function pnDev(){var d=f.contentWindow&&f.contentWindow.__pnDevice;if(!d){pnSay("The app is still loading");return null}return d}
+function pnNum(c){var v=pnVal(c).trim();return v===""?NaN:Number(v)}
+function pnVal(c){return document.querySelector('[data-control="'+c+'"]').value}
+function pnSet(patch,msg){var d=pnDev();if(d){d.set(patch);step({action:"set_device",device:patch});pnSay(msg)}}
+var pnDelay=0;
+function pnSlow(){var w=f.contentWindow;if(!w||w.__pnSlow||!w.fetch)return;w.__pnSlow=1;var o=w.fetch.bind(w);w.fetch=function(){var a=arguments;return new Promise(function(r){setTimeout(r,pnDelay)}).then(function(){return o.apply(null,a)})}}
+var A={
+"location-set":function(){var v=pnVal("location-list").split(",");pnSet({location:{latitude:+v[0],longitude:+v[1],accuracy:20}},"Location set")},
+"coords-set":function(){var a=pnNum("lat"),o=pnNum("lng");if(!(a>=-90&&a<=90&&o>=-180&&o<=180)){pnSay("Enter latitude -90 to 90 and longitude -180 to 180");return}pnSet({location:{latitude:a,longitude:o,accuracy:20}},"Location set")},
+"camera-set":function(){var v=pnVal("camera-list").split("|");pnSet({camera:{barcode:v[0]==="none"?null:{type:v[0],data:v.slice(1).join("|")}}},"Camera shows "+(v[0]==="none"?"nothing":v[0]))},
+"bio-success":function(){pnSet({biometrics:{nextResult:"success"}},"Fingerprint and Face ID match from now on")},
+"bio-fail":function(){pnSet({biometrics:{nextResult:"fail"}},"Fingerprint and Face ID do not match from now on")},
+"pay-approve":function(){pnSet({payment:{nextResult:"approve"}},"Payments are approved from now on")},
+"pay-decline":function(){pnSet({payment:{nextResult:"decline"}},"Payments are declined from now on")},
+"net-online":function(){pnDelay=0;pnSet({online:true},"Network online")},
+"net-slow":function(){if(!pnDev())return;pnDelay=1500;pnSlow();pnSet({online:true},"Network slow (requests wait 1.5 s)")},
+"net-offline":function(){pnDelay=0;pnSet({online:false},"Network offline")},
+"push-send":function(){var d=pnDev();if(!d)return;var t=pnVal("push-title")||"Notification",b=pnVal("push-body");var ok=d.push({title:t,body:b})!==null;if(ok)step({action:"note",text:"panel: push sent"});pnSay(ok?"Push sent":"Not delivered: the app has not been granted notification permission")}
+};
+var pnGroups=[["bio-success","bio-fail"],["pay-approve","pay-decline"],["net-online","net-slow","net-offline"]];
+document.querySelectorAll("[data-control]").forEach(function(e){var c=e.dataset.control;if(A[c])e.onclick=function(){A[c]();pnGroups.forEach(function(g){if(g.indexOf(c)<0)return;g.forEach(function(k){var b=document.querySelector('[data-control="'+k+'"]');if(b.setAttribute)b.setAttribute("aria-pressed",k===c)})})}});
 apply();
 </script></body></html>
 `;
 }
 /** Puts the frame page at index.html and the app's own entry at app.html (its asset paths are absolute, so it stays at the site root). */
-export function wrapBuild(buildDir, name) {
+export function wrapBuild(buildDir, name, appId = name) {
     const files = collectFiles(buildDir).filter((f) => f.path !== "index.html");
     const entry = join(buildDir, "index.html");
     if (!existsSync(entry))
         throw new Error("The web build has no index.html. Run `npx expo export --platform web` and check it works.");
     files.push({ path: "app.html", bytes: new Uint8Array(readFileSync(entry)), contentType: typeOf("x.html") });
-    files.push({ path: "index.html", bytes: new TextEncoder().encode(framePage(name)), contentType: typeOf("x.html") });
+    files.push({ path: "index.html", bytes: new TextEncoder().encode(framePage(name, appId)), contentType: typeOf("x.html") });
     return files;
 }
 const realSleep = (ms) => new Promise((r) => setTimeout(r, ms));
@@ -205,11 +303,12 @@ export async function publishToHereNow(files, o = {}) {
     const warnings = (done.warnings ?? []).map((w) => (typeof w === "string" ? w : JSON.stringify(w)));
     return { url: done.siteUrl ?? created.siteUrl, claimUrl: created.claimUrl ?? null, expiresAt: created.expiresAt ?? null, files: files.length, warnings };
 }
-function build(root, out) {
+export function build(root, out) {
     rmSync(out, { recursive: true, force: true });
     mkdirSync(join(root, ".shipvo"), { recursive: true });
     return new Promise((resolve, reject) => {
-        const p = spawn("npx", ["expo", "export", "--platform", "web", "--clear", "--output-dir", out], { cwd: root, env: { ...process.env, PN_SIM: "1" }, stdio: ["ignore", "ignore", "inherit"] });
+        const call = spawnBin("npx", ["expo", "export", "--platform", "web", "--clear", "--output-dir", out]);
+        const p = spawn(call.command, call.args, { cwd: root, shell: call.shell, env: { ...process.env, PN_SIM: "1" }, stdio: ["ignore", "ignore", "inherit"] });
         p.on("error", reject);
         p.on("exit", (c) => (c === 0 ? resolve() : reject(new Error(`The web build failed (exit ${c}). Run \`npx expo export --platform web\` to see why.`))));
     });
@@ -226,7 +325,7 @@ export async function runPreview(root, o = {}) {
     const dir = o.buildDir ?? join(root, ".shipvo", "preview-build");
     if (!o.skipBuild)
         await build(root, dir);
-    return publishToHereNow(wrapBuild(dir, cfg.name), o);
+    return publishToHereNow(wrapBuild(dir, cfg.name, cfg.appId), o);
 }
 export async function preview(argv) {
     const a = parse(argv);

package/dist/promote.d.ts

@@ -1,7 +1,7 @@
 import { kv as kvFor } from "./config.js";
 type Store = Pick<ReturnType<typeof kvFor>, "get" | "put">;
 export declare const PROMOTE_FLAGS: string[];
-export declare const PROMOTE_HELP = "Usage: shipvo promote [flags]\n\nWiden a staged release to more bands. The release number, bundle and patches stay the same; the pointer is signed again.\n\nFlags (write a value after a space, not =):\n  --to b1,b2                   Bands to write (default: every band with no pointer for this release)\n                               Bands that already hold a newer release are always skipped\n  --platform android|ios|all   Platform to promote (default android)\n  --dry-run                    Print the plan, write nothing\n  --force                      Promote even if the release is halted or has reverts\n  --help                       Show this help\n";
+export declare const PROMOTE_HELP = "Usage: shipvo promote [flags]\n\nWiden a staged release to more bands. The release number, bundle and patches stay the same; the pointer is signed again.\n\nFlags (write a value after a space, not =):\n  --to b1,b2                   Bands to write (default: every band with no pointer for this release)\n                               Bands that already hold a newer release are always skipped\n  --platform android|ios|all   Platform to promote (default android)\n  --dry-run                    Print the plan, write nothing\n  --report <file>              Test report from shipvo test --report (default shipvo-test-report.json if it exists)\n                               A report for this release with failing flows blocks promote\n  --json                       Print one JSON envelope on stdout; text goes to stderr\n  --force                      Promote even if the release is halted, has reverts or has a failing test report\n  --help                       Show this help\n";
 export declare function promote(argv: string[], deps?: {
     kv?: Store;
     fetchFn?: typeof fetch;

package/dist/promote.js

@@ -1,11 +1,13 @@
 // `shipvo promote`: widen a staged release to more bands. Reads the pointer on the narrowest band that has one,
 // and writes the same release (same bundle, hashes and patches) to the other bands with a fresh issued_at and signature.
+import { existsSync, readFileSync } from "node:fs";
 import { signBytes } from "./index.js";
-import { args as parse, kv as kvFor, loadConfig, seed } from "./config.js";
+import { CliFailure, UsageError, runJson } from "./json-out.js";
+import { args as parse, hasStore, kv as kvFor, loadConfig, offlineKv, seed } from "./config.js";
 const BANDS = ["b0", "b1", "b2"];
 const REVERT_EVENTS = ["rolled_back", "crash_loop_revert"];
 const pointerKey = (app, major, band, pf) => (pf === "ios" ? `p/${app}/${major}/ios/${band}` : `p/${app}/${major}/${band}`);
-export const PROMOTE_FLAGS = ["to", "platform", "dry-run", "force"];
+export const PROMOTE_FLAGS = ["to", "platform", "dry-run", "force", "report", "json"];
 export const PROMOTE_HELP = `Usage: shipvo promote [flags]
 
 Widen a staged release to more bands. The release number, bundle and patches stay the same; the pointer is signed again.
@@ -15,7 +17,10 @@ Flags (write a value after a space, not =):
                                Bands that already hold a newer release are always skipped
   --platform android|ios|all   Platform to promote (default android)
   --dry-run                    Print the plan, write nothing
-  --force                      Promote even if the release is halted or has reverts
+  --report <file>              Test report from shipvo test --report (default shipvo-test-report.json if it exists)
+                               A report for this release with failing flows blocks promote
+  --json                       Print one JSON envelope on stdout; text goes to stderr
+  --force                      Promote even if the release is halted, has reverts or has a failing test report
   --help                       Show this help
 `;
 function checkFlags(argv, known) {
@@ -23,31 +28,44 @@ function checkFlags(argv, known) {
     if (bad.length) {
         const eq = bad.find((x) => x.includes("="));
         const hint = eq ? ` Write "${eq.replace("=", " ")}" (a space, not =).` : "";
-        throw new Error(`Unknown flag ${bad.join(", ")}.${hint} Known flags: ${known.map((k) => "--" + k).join(" ")}`);
+        throw new UsageError(`Unknown flag ${bad.join(", ")}.${hint} Known flags: ${known.map((k) => "--" + k).join(" ")}`);
     }
 }
+const STATUS = [{ command: "shipvo status --json", why: "See how the release does on phones." }];
 export async function promote(argv, deps = {}) {
     if (argv.includes("--help") || argv.includes("-h")) {
         console.log(PROMOTE_HELP);
         return;
     }
+    if (argv.includes("--json"))
+        return runJson(() => promoteRun(argv, deps), [{ command: "shipvo doctor --json", why: "Check your setup." }, ...STATUS]);
+    await promoteRun(argv, deps);
+}
+async function promoteRun(argv, deps) {
     checkFlags(argv, PROMOTE_FLAGS);
     const a = parse(argv), cfg = loadConfig();
     const dry = a["dry-run"] !== undefined, force = a.force !== undefined;
     const p = (a.platform || "android").toLowerCase();
     if (p !== "android" && p !== "ios" && p !== "all")
-        throw new Error(`--platform must be android, ios or all (got "${a.platform}")`);
+        throw new UsageError(`--platform must be android, ios or all (got "${a.platform}")`);
     const platforms = p === "all" ? ["android", "ios"] : [p];
     if (a.to === "true")
-        throw new Error("--to needs bands: pass --to b1,b2");
+        throw new UsageError("--to needs bands: pass --to b1,b2");
     const explicit = a.to ? a.to.split(",").map((s) => s.trim()).filter(Boolean) : null;
     if (explicit) {
         const bad = explicit.filter((b) => !BANDS.includes(b));
         if (bad.length)
-            throw new Error(`Unknown band ${bad.join(", ")}. Bands are ${BANDS.join(", ")}.`);
+            throw new UsageError(`Unknown band ${bad.join(", ")}. Bands are ${BANDS.join(", ")}.`);
     }
+    if (a.report === "true")
+        throw new UsageError("--report needs a file name: pass --report <file>");
+    const reportFile = a.report ?? (existsSync("shipvo-test-report.json") ? "shipvo-test-report.json" : null);
     const APP = cfg.appId, MAJOR = cfg.shellMajor;
-    const store = deps.kv ?? kvFor(cfg);
+    // A dry run with no login and no Cloudflare keys reads the files `shipvo publish --dry-run` wrote.
+    const offline = !deps.kv && dry && !hasStore();
+    const store = deps.kv ?? (offline ? offlineKv() : kvFor(cfg));
+    if (offline)
+        console.log("Offline rehearsal: reading pointers from .shipvo/dry-run (written by shipvo publish --dry-run). No login used, nothing is sent.");
     // Read every source pointer before touching the network or writing anything.
     const plans = [];
     for (const pf of platforms) {
@@ -68,17 +86,38 @@ export async function promote(argv, deps = {}) {
             catch { /* unreadable pointer: skip */ }
         }
         if (!body)
-            throw new Error(`No ${pf} pointer found on any band. Run shipvo publish --bands b0 first.`);
+            throw new CliFailure(`No ${pf} pointer found on any band. Run shipvo publish --bands b0 first.`, "no_pointer", 1, [{ command: "shipvo publish --bands b0 --json", why: "Publish to the first cohort." }]);
         const release = body.release;
         if (explicit && explicit.length && explicit.every((b) => b === from))
-            throw new Error(`${from} is the source band (release ${release}). Pass --to with a different band.`);
+            throw new UsageError(`${from} is the source band (release ${release}). Pass --to with a different band.`);
         // Never write an older release over a newer one: promote widens, it does not downgrade. --force does not change this.
         const cand = (explicit ?? BANDS).filter((b) => b !== from && (explicit || have.get(b) !== release));
         const newer = cand.filter((b) => (have.get(b) ?? 0) > release).map((b) => [b, have.get(b)]);
         const targets = cand.filter((b) => !((have.get(b) ?? 0) > release));
         plans.push({ pf, release, from, body, targets, newer });
     }
-    if (!force) {
+    if (reportFile) {
+        let rep;
+        try {
+            rep = JSON.parse(readFileSync(reportFile, "utf8"));
+        }
+        catch (e) {
+            throw new CliFailure(`Could not read the test report ${reportFile} (${e instanceof Error ? e.message : String(e)}).`, "report_unreadable", 1, [{ command: "shipvo test --report shipvo-test-report.json --json", why: "Write a fresh test report." }]);
+        }
+        const rel = rep.release == null ? null : String(rep.release);
+        const failing = (Array.isArray(rep.flows) ? rep.flows : []).filter((f) => f.status === "failed").map((f) => f.name ?? "(unnamed flow)");
+        const mine = plans.filter((x) => String(x.release) === rel);
+        if (mine.length && failing.length) {
+            const msg = `Test report ${reportFile} has ${failing.length} failing flow${failing.length === 1 ? "" : "s"} for release ${mine[0].release}: ${failing.join(", ")}.`;
+            if (!force)
+                throw new CliFailure(`${msg} Fix them and run shipvo test --report again, or pass --force to promote anyway.`, "tests_failed", 1, [{ command: `shipvo test --report ${reportFile} --json`, why: "Run the flows again after the fix." }]);
+            console.log(`${msg} Overridden by --force.`);
+        }
+        else if (!mine.length) {
+            console.log(`Warning: test report ${reportFile} is for ${rel === null ? "no release" : `release ${rel}`}, not release ${plans.map((x) => x.release).join(", ")}. It is stale and was not used.`);
+        }
+    }
+    if (!force && !offline) {
         const base = cfg.controlPlane.replace(/\/$/, "");
         let data;
         try {
@@ -88,18 +127,20 @@ export async function promote(argv, deps = {}) {
             data = (await r.json());
         }
         catch (e) {
-            throw new Error(`Could not read the release status from ${base} (${e instanceof Error ? e.message : String(e)}). Try again, or pass --force to promote without the check.`);
+            throw new CliFailure(`Could not read the release status from ${base} (${e instanceof Error ? e.message : String(e)}). Try again, or pass --force to promote without the check.`, "remote_failed", 1, [{ command: "shipvo doctor --json", why: "Check the control plane." }]);
         }
         for (const { release } of plans) {
             if (data.halted && typeof data.halted === "object" && data.halted.release === release)
-                throw new Error(`Release ${release} is halted. Publish a new release or run shipvo rollback, or pass --force to promote it anyway.`);
+                throw new CliFailure(`Release ${release} is halted. Publish a new release or run shipvo rollback, or pass --force to promote it anyway.`, "blocked", 1, STATUS);
             const ev = data.releases?.find((r) => r.release === release)?.events ?? {};
             const n = REVERT_EVENTS.reduce((s, k) => s + (ev[k] ?? 0), 0);
             if (n > 0)
-                throw new Error(`Release ${release} has ${n} reported revert${n === 1 ? "" : "s"}. Check shipvo status, publish a fix, or pass --force to promote it anyway.`);
+                throw new CliFailure(`Release ${release} has ${n} reported revert${n === 1 ? "" : "s"}. Check shipvo status, publish a fix, or pass --force to promote it anyway.`, "blocked", 1, STATUS);
         }
     }
+    const result = [];
     for (const { pf, release, from, body, targets, newer } of plans) {
+        result.push({ platform: pf, release, from, bands: targets, skipped_newer: newer.map(([band, release]) => ({ band, release })) });
         for (const [b, r] of newer)
             console.log(`Skipped ${b} (${pf}): it already has release ${r}, which is newer than ${release}.`);
         if (!targets.length && newer.length) {
@@ -123,4 +164,12 @@ export async function promote(argv, deps = {}) {
     }
     if (dry)
         console.log("Dry run: nothing was written.");
+    const count = result.reduce((n, r) => n + r.bands.length, 0);
+    const data = { dry_run: dry, promoted: result };
+    if (count === 0)
+        return { code: "nothing_to_promote", summary: "Nothing to promote: no band needs this release.", data, next: STATUS };
+    const list = result.map((r) => `${r.platform} release ${r.release} to ${r.bands.join(", ")}`).join("; ");
+    if (dry)
+        return { code: "dry_run", summary: `Would promote ${list}. Nothing was written.`, data, next: [{ command: `shipvo promote ${argv.filter((x) => x !== "--dry-run").join(" ")}`.trim(), why: "Do the promote." }] };
+    return { code: "promoted", summary: `Promoted ${list}.`, data, next: STATUS };
 }

package/dist/publish.d.ts

@@ -1,11 +1,23 @@
-export declare const PUBLISH_HELP = "Usage: shipvo publish [flags]\n\nBuild, sign and publish an over-the-air release.\n\nFlags (write a value after a space, not =; on/off flags can be bare, or true/false):\n  --bands b0,b1,b2             Cohorts to publish to (default b0,b1,b2)\n  --platform android|ios|all   Platform to publish (default android)\n  --release N                  Release number (default: the next one)\n  --min-shell X.Y.Z            Oldest app shell that can run this release (default: version in app.json)\n  --hermes-bytecode-version V  Refuse bundles built for another Hermes version, for example 96 or 96,98\n  --max-bases N                How many older releases to build patches from (default 6)\n  --skip-export               Reuse the last build in dist-ota/\n  --skip-web                  Do not publish the web copy for the simulator\n  --dry-run                    Build and sign, write files locally, send nothing\n  --out <dir>                  Where --dry-run writes files (default .shipvo/dry-run)\n  --help                       Show this help\n";
+import path from "node:path";
+/** True when `file` is strictly inside `root`. Uses the platform's separator, so it works with Windows paths too. */
+export declare function isInside(root: string, file: string, p?: typeof path.posix): boolean;
+export declare const PUBLISH_HELP = "Usage: shipvo publish [flags]\n\nBuild, sign and publish an over-the-air release.\n\nFlags (write a value after a space, not =; on/off flags can be bare, or true/false):\n  --bands b0,b1,b2             Cohorts to publish to (default b0,b1,b2)\n  --platform android|ios|all   Platform to publish (default android)\n  --release N                  Release number (default: the next one)\n  --min-shell X.Y.Z            Oldest app shell that can run this release (default: version in app.json)\n  --hermes-bytecode-version V  Refuse bundles built for another Hermes version, for example 96 or 96,98\n  --max-bases N                How many older releases to build patches from (default 6)\n  --skip-export               Reuse the last build in dist-ota/\n  --skip-web                  Do not publish the web copy for the simulator\n  --dry-run                    Build and sign, write files locally, send nothing\n  --dry-run-policy             Check the policy in shipvo.json for these --bands, print the result, publish nothing\n  --out <dir>                  Where --dry-run writes files (default .shipvo/dry-run)\n  --json                       Print one JSON envelope on stdout; text and build output go to stderr\n  --help                       Show this help\n";
 export declare function publish(argv: string[]): Promise<void>;
+/** The publish result in plain words. `--json` carries the full detail. */
+export declare function publishedSummary(release: number, bands: string[]): string;
+/** The rollback result in plain words. */
+export declare function rolledBackSummary(to: number, release: number): string;
 /** Bytes in plain units: KB below 1 MB, so a small bundle never reads as 0.00 MB. */
 export declare function formatSize(bytes: number): string;
 /** The dry-run result in plain words. `info` says what happened with patches on Android. */
 export declare function dryRunSummary(release: number, bytes: number, outDir: string, info?: {
     bases: number;
-    bsdiff: boolean;
     patches: number;
 }): string;
+/** The line for a listing file that is not there. It says the file is optional and what to do. */
+export declare function missingListingNote(file: string, name: string): string;
+/** Upload one listing file to the store prefix. A missing file prints a note and returns null. */
+export declare function uploadListingFile(kv: {
+    put: (k: string, b: BodyInit, m: string) => Promise<unknown>;
+}, store: string, file: string, name: string): Promise<string | null>;
 export declare function rollback(argv: string[]): Promise<void>;