@scadable/wizard 0.1.0 → 0.1.2

package/dist/cli.js

@@ -169,19 +169,36 @@ function parseArgs(argv) {
   return args;
 }
 var HELP = `
-${pc.bold("@scadable/wizard")} - wire your SCADABLE privacy policy into this repo.
+${pc.bgCyan(pc.black(" SCADABLE "))} ${pc.bold("privacy wizard")}
+Add a live privacy page to your app in about 20 seconds. Commit, deploy, done.
 
 ${pc.bold("Usage")}
   npx @scadable/wizard@latest --token <TEMP_TOKEN> [options]
 
+${pc.dim("Get your token from Settings in the SCADABLE app, then paste the whole command here.")}
+
 ${pc.bold("Options")}
   --token <token>   Install token from the SCADABLE app (required).
   --api <url>       API base. Default ${DEFAULT_API}.
-  --dry-run         Show the plan, write nothing.
-  --yes, -y         Skip confirmation prompts (non-interactive).
-  --patch <file>    Patch an existing file instead of creating a new page.
+  --dry-run         Preview the plan without writing anything.
+  --yes, -y         Skip the prompts (non-interactive).
+  --patch <file>    Add the policy to an existing page instead of creating one.
   --help, -h        Show this help.
+
+${pc.dim("Your code stays private: only package.json and folder names are read.")}
 `;
+var BANNER = [
+  "     _______.  ______     ___       _______       ___      .______    __       _______ ",
+  "    /       | /      |   /   \\     |       \\     /   \\     |   _  \\  |  |     |   ____|",
+  "   |   (----`|  ,----'  /  ^  \\    |  .--.  |   /  ^  \\    |  |_)  | |  |     |  |__   ",
+  "    \\   \\    |  |      /  /_\\  \\   |  |  |  |  /  /_\\  \\   |   _  <  |  |     |   __|  ",
+  ".----)   |   |  `----./  _____  \\  |  '--'  | /  _____  \\  |  |_)  | |  `----.|  |____ ",
+  "|_______/     \\______/__/     \\__\\ |_______/ /__/     \\__\\ |______/  |_______||_______|"
+];
+function printBanner() {
+  for (const line of BANNER) console.log(pc.cyan(line));
+  console.log("");
+}
 function fail(message) {
   log.error(message);
   process.exit(1);
@@ -201,12 +218,12 @@ function showPlan(installCmd, edits, deterministic) {
   const blocks = [`${pc.bold("Install")}
   ${pc.cyan(installCmd)}`];
   for (const edit of edits) {
-    const verb = edit.action === "patch" ? "Patch" : "Create";
+    const verb = edit.action === "patch" ? "Update" : "Create";
     blocks.push(`${pc.bold(`${verb} ${edit.path}`)}
 ${previewContents(edit.contents)}`);
   }
-  const source = deterministic ? pc.dim("Plan is deterministic (template-based).") : pc.dim("Plan was generated for your repo.");
-  note(blocks.join("\n\n") + "\n\n" + source, "Plan");
+  const source = deterministic ? pc.dim("Built from a vetted template. Same result every time.") : pc.dim("Tailored to your project.");
+  note(blocks.join("\n\n") + "\n\n" + source, "Here's the plan");
 }
 async function main() {
   const args = parseArgs(process.argv.slice(2));
@@ -214,56 +231,63 @@ async function main() {
     console.log(HELP);
     return;
   }
-  intro(pc.bgCyan(pc.black(" SCADABLE privacy wizard ")));
+  printBanner();
+  intro(`${pc.bgCyan(pc.black(" SCADABLE "))} ${pc.bold("privacy wizard")}`);
+  log.message(pc.dim("Setting up your privacy page. About 20 seconds."));
   if (!args.token) {
-    fail("Missing --token. Open Settings in the SCADABLE app and copy the install command.");
+    fail(
+      "No install token yet. Open Settings in SCADABLE, then copy and paste the whole install command."
+    );
   }
   const token = args.token;
   const api = args.api.replace(/\/$/, "");
   const cwd = process.cwd();
   const spin = spinner();
-  spin.start("Verifying your install token");
+  spin.start("Checking your install token");
   let session;
   try {
     session = await getSession(api, token);
   } catch (err) {
-    spin.stop("Token check failed");
+    spin.stop("Token check failed", 2);
     if (err instanceof WizardApiError && err.status === 401) {
       fail(
-        "Your install token expired. Reopen Settings in the SCADABLE app and copy a fresh command."
+        "That install token has expired. Reopen Settings in SCADABLE and copy a fresh install command, then run it again."
       );
     }
     if (err instanceof WizardNetworkError) {
-      fail(`Could not reach the SCADABLE API at ${api}. ${reason(err)}`);
+      fail(`Could not reach SCADABLE at ${api}. Check your connection and try again.`);
     }
     fail(`Could not verify your token: ${reason(err)}`);
   }
-  spin.stop(`Connected to ${pc.bold(session.scope_name)} (${session.domain})`);
+  spin.stop(`Connected to ${pc.bold(session.scope_name)} ${pc.dim(`(${session.domain})`)}`);
+  spin.start("Reading your project");
   let ctx;
   try {
     ctx = detectRepo(cwd);
   } catch (err) {
+    spin.stop("Could not read your project", 2);
     fail(reason(err));
   }
+  spin.stop(`Found ${pc.bold(ctx.framework)}`);
+  log.message(pc.dim("Only package.json and folder names were read. Your code stays on your machine."));
   if (ctx.warning) log.warn(ctx.warning);
   let mode = "create";
   let target;
   if (args.patch) {
     const abs = resolve(cwd, args.patch);
     if (!existsSync3(abs)) {
-      fail(`--patch file not found: ${args.patch}`);
+      fail(`Could not find the file to patch: ${args.patch}`);
     }
     const contents = readFileSync2(abs, "utf8");
     if (looksLikeSecret(contents)) {
       fail(
-        `Refusing to upload ${args.patch}: it looks like it contains secrets. Drop --patch to create a fresh privacy page instead.`
+        `Not uploading ${args.patch}: it looks like it holds secrets. Drop --patch and the wizard will create a fresh privacy page instead.`
       );
     }
     mode = "patch";
     target = { path: args.patch, contents };
   }
-  log.info(`Detected ${pc.bold(ctx.framework)} (mode: ${mode})`);
-  spin.start("Building your install plan");
+  spin.start("Building your plan");
   let plan;
   try {
     plan = await postPlan(api, token, {
@@ -274,12 +298,12 @@ async function main() {
       target
     });
   } catch (err) {
-    spin.stop("Could not build a plan");
+    spin.stop("Could not build a plan", 2);
     if (err instanceof WizardApiError && err.status === 503) {
-      fail("SCADABLE could not generate a plan right now (model unavailable). Try again shortly.");
+      fail("SCADABLE is busy and could not build your plan right now. Give it a moment and try again.");
     }
     if (err instanceof WizardNetworkError) {
-      fail(`Could not reach the SCADABLE API at ${api}. ${reason(err)}`);
+      fail(`Could not reach SCADABLE at ${api}. Check your connection and try again.`);
     }
     fail(`Could not build a plan: ${reason(err)}`);
   }
@@ -287,50 +311,80 @@ async function main() {
   const pm = detectPackageManager(cwd);
   const packages = resolvePackages(plan.install);
   const installCmd = formatInstall(pm, packages);
+  const liveUrl = `${api}/policy/${plan.public_id}`;
   showPlan(installCmd, plan.edits, plan.deterministic);
   if (args.dryRun) {
-    outro(pc.dim("Dry run complete. Nothing was written."));
+    log.message(`${pc.dim("Your page would live at")} ${pc.cyan(liveUrl)}`);
+    outro(pc.dim("Dry run. Nothing was written. Run again without --dry-run to set it up."));
     return;
   }
   if (!args.yes) {
-    const ok = await confirm({ message: "Apply this plan?" });
+    const ok = await confirm({
+      message: "Set up your privacy page?",
+      active: "Yes, do it",
+      inactive: "Not now",
+      initialValue: true
+    });
     if (isCancel(ok) || !ok) {
-      cancel("No changes made.");
+      cancel("No problem. Nothing was changed. Run this again whenever you are ready.");
       process.exit(0);
     }
   }
-  spin.start(`Installing with ${pm}`);
+  spin.start("Installing @scadable/privacy");
   try {
     runInstall(cwd, pm, packages);
-    spin.stop("Dependency installed");
+    spin.stop(`Installed @scadable/privacy ${pc.dim(`(${pm})`)}`);
   } catch (err) {
-    spin.stop("Install failed");
+    spin.stop("Install failed", 2);
     fail(`Could not run "${installCmd}": ${reason(err)}`);
   }
+  const toWrite = [];
   for (const edit of plan.edits) {
     const abs = resolve(cwd, edit.path);
     if (edit.action === "create" && existsSync3(abs) && !args.yes) {
-      const overwrite = await confirm({ message: `${edit.path} already exists. Overwrite it?` });
+      const overwrite = await confirm({
+        message: `${edit.path} already exists. Replace it?`,
+        active: "Replace it",
+        inactive: "Keep mine",
+        initialValue: false
+      });
       if (isCancel(overwrite) || !overwrite) {
-        log.warn(`Skipped ${edit.path}`);
+        log.warn(`Kept your existing ${edit.path}`);
         continue;
       }
     }
+    toWrite.push(edit);
+  }
+  spin.start("Writing your privacy page");
+  for (const edit of toWrite) {
     writeEdit(cwd, edit);
-    log.success(`${edit.action === "patch" ? "Patched" : "Wrote"} ${edit.path}`);
   }
-  spin.start("Finishing setup");
+  spin.stop(toWrite.length ? "Privacy page written" : "Nothing new to write");
+  spin.start("Finishing up");
   try {
     await postComplete(api, token);
-    spin.stop("Marked connected");
+    spin.stop("Connected to SCADABLE");
   } catch (err) {
-    spin.stop("Setup written, but could not notify SCADABLE");
-    log.warn(`The files are in place, but marking the connection failed: ${reason(err)}`);
+    spin.stop("Files are in place, but could not reach SCADABLE to finish", 1);
+    log.warn(`Your files are written. Marking the connection failed: ${reason(err)}`);
   }
-  outro(
-    `${pc.green("Done.")} ${plan.route_hint}
-  ${pc.dim("Public id:")} ${plan.public_id}`
-  );
+  const payoff = [
+    `${pc.bold("Next:")} commit and deploy. That's it.`,
+    `  ${pc.cyan('git add -A && git commit -m "Add privacy policy"')}`,
+    `  ${pc.dim("then push, or run your usual deploy")}`,
+    ``,
+    `${pc.bold("Where it lives")}`,
+    `  ${pc.dim("Page  ")} ${pc.cyan(plan.route_hint)}`,
+    `  ${pc.dim("Live  ")} ${pc.cyan(liveUrl)}`,
+    ``,
+    pc.dim("It stays current. Update your policy in SCADABLE and every page"),
+    pc.dim("updates automatically. No redeploy."),
+    ``,
+    pc.dim("Using a Content-Security-Policy? Add api.scadable.com to connect-src"),
+    pc.dim("so the page can refresh live (it falls back to the saved copy if not).")
+  ].join("\n");
+  note(payoff, pc.green("Your privacy page is ready"));
+  outro(`${pc.green("Done.")} ${pc.dim("Commit and deploy, and you are live.")}`);
 }
 main().catch((err) => {
   log.error(reason(err));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scadable/wizard",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "The SCADABLE setup wizard. Wires SCADABLE into your codebase (privacy policy now, more to come).",
   "license": "MIT",
   "type": "module",