peekable 0.3.0 → 0.4.0

package/README.md

@@ -13,11 +13,18 @@ npm install -g peekable
 ## First Run
 
 ```bash
-peekable register --name "Your Name" --email "you@example.com" --invite-code "your-invite-code"
+peekable register your-invite-code
 peekable init
 peekable create "My first review"
 ```
 
+Got your invite code some other way (support, a paid plan) and it isn't tied to an
+email on file? Use the legacy form:
+
+```bash
+peekable register --name "Your Name" --email "you@example.com" --invite-code "your-invite-code"
+```
+
 `peekable create` prints a session ID and share URL. Use the session ID with one
 of the publish commands below.
 

package/dist/commands/register.js

@@ -3,14 +3,29 @@ import { writeConfig, readConfig, DEFAULT_SERVER_URL } from "../config.js";
 import { apiNoAuth } from "../api.js";
 import { CommandFailure, printCommandError } from "../command-error.js";
 import { runWithTelemetry } from "../telemetry.js";
+const USAGE_FORMS = [
+    `  peekable register <code>`,
+    `  peekable register --name "Your Name" --email "you@example.com" --invite-code "your-invite-code"`,
+].join("\n");
 export const registerCommand = new Command("register")
     .description("Register for an API key")
-    .requiredOption("--name <name>", "Your display name")
-    .requiredOption("--email <email>", "Your email address")
+    .argument("[code]", "Invite code from your email")
+    .option("--name <name>", "Your display name")
+    .option("--email <email>", "Your email address")
     .option("--invite-code <code>", "Beta invite code")
     .option("--url <url>", "Server URL", DEFAULT_SERVER_URL)
     .option("--json", "Output JSON")
-    .action(async (opts) => {
+    .addHelpText("after", `
+Examples:
+  peekable register your-invite-code
+  peekable register --invite-code your-invite-code
+  peekable register --name "Your Name" --email "you@example.com" --invite-code "your-invite-code"
+
+The invite code may also come from PEEKABLE_INVITE_CODE. --email is required
+only when no invite code is given (or when your code needs an email on file,
+e.g. codes issued by support or paid checkout).
+`)
+    .action(async (code, opts) => {
     await runWithTelemetry("register", async () => {
         const existing = readConfig();
         if (existing) {
@@ -23,38 +38,64 @@ export const registerCommand = new Command("register")
             }
             throw new CommandFailure("Already registered.");
         }
+        const flagCode = typeof opts.inviteCode === "string" ? opts.inviteCode : undefined;
+        if (code && flagCode && code !== flagCode) {
+            const message = `Conflicting invite codes: got "${code}" positionally and "${flagCode}" via --invite-code. Pass the code once.`;
+            if (opts.json) {
+                console.log(JSON.stringify({ error: message }));
+            }
+            else {
+                console.error(message);
+            }
+            throw new CommandFailure("Conflicting invite codes.");
+        }
+        const inviteCode = code ?? flagCode ?? process.env.PEEKABLE_INVITE_CODE;
+        if (!inviteCode && !opts.email) {
+            const message = "An invite code or --email is required.";
+            if (opts.json) {
+                console.log(JSON.stringify({ error: message }));
+            }
+            else {
+                console.error(message);
+                console.error("");
+                console.error("Usage:");
+                console.error(USAGE_FORMS);
+            }
+            throw new CommandFailure("Missing invite code or email.");
+        }
         try {
-            const inviteCode = typeof opts.inviteCode === "string"
-                ? opts.inviteCode
-                : process.env.PEEKABLE_INVITE_CODE;
-            const body = {
-                name: opts.name,
-                email: opts.email,
-            };
-            if (inviteCode) {
+            const body = {};
+            if (opts.name)
+                body.name = opts.name;
+            if (opts.email)
+                body.email = opts.email;
+            if (inviteCode)
                 body.invite_code = inviteCode;
-            }
-            const data = await apiNoAuth(opts.url, "POST", "/register", {
-                ...body,
-            });
+            const data = await apiNoAuth(opts.url, "POST", "/register", body);
             writeConfig({
                 url: opts.url,
                 api_key: data.api_key,
-                name: opts.name,
+                name: data.name,
             });
             if (opts.json) {
                 console.log(JSON.stringify({
                     api_key: data.api_key,
                     url: opts.url,
-                    name: opts.name,
+                    name: data.name,
                     plan_state: data.plan_state ?? null,
                     trial_ends_at: data.trial_ends_at ?? null,
                     days_remaining: data.days_remaining ?? null,
                     invite_source: data.invite_source ?? null,
+                    email_masked: data.email_masked ?? null,
                 }));
             }
             else {
-                console.log(`Registered as ${opts.name}.`);
+                if (data.email_masked) {
+                    console.log(`Registered as ${data.name} (${data.email_masked}).`);
+                }
+                else {
+                    console.log(`Registered as ${data.name}.`);
+                }
                 console.log(`API key saved to ~/.peekable/config.json`);
                 console.log("Peekable CLI sends anonymous usage/failure telemetry to improve reliability. Opt out: PEEKABLE_NO_TELEMETRY=1");
                 if (data.invite_source === "trial") {

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const CLI_VERSION = "0.3.0";
+export declare const CLI_VERSION = "0.4.0";

package/dist/version.js

@@ -1 +1 @@
-export const CLI_VERSION = "0.3.0";
+export const CLI_VERSION = "0.4.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "peekable",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "type": "module",
   "description": "Share HTML mockups with collaborators — CLI for peekable-server",
   "bin": {