@myna-sh/cli 0.15.0 → 0.16.0

package/dist/main.js

@@ -701,7 +701,7 @@ var ManagementClient = class {
    */
   reports = {
     list: (project, opts = {}) => {
-      const { board, status, type, priority, assignee, labels, q, since, ...rest } = opts;
+      const { board, status, type, priority, assignee, labels, q, since, reporter, property, ...rest } = opts;
       return this.page(`/projects/${enc(project)}/reports`, rest, {
         board,
         status: Array.isArray(status) ? status.join(",") : status,
@@ -710,7 +710,9 @@ var ManagementClient = class {
         assignee,
         labels: labels?.join(","),
         q,
-        since
+        since,
+        reporter,
+        property
       });
     },
     get: (project, report, signal) => this.get(
@@ -766,13 +768,7 @@ var ManagementClient = class {
       void 0,
       signal
     ),
-    /** What publishing this report to a board would expose. Read before moving. */
-    exposure: (project, report, board, signal) => this.get(
-      `/projects/${enc(project)}/reports/${enc(String(report))}/exposure`,
-      { board },
-      signal
-    ),
-    /** Move between boards. A public destination needs `confirm: true`. */
+    /** Move a report to another board. Ordinary triage; every board is private. */
     move: (project, report, body) => this.mutate(
       "POST",
       `/projects/${enc(project)}/reports/${enc(String(report))}/move`,
@@ -806,14 +802,58 @@ var ManagementClient = class {
    *
    * Unlike every other credential here, one of these is *meant* to be readable
    * by every visitor to a customer's page. What makes that safe lives on the
-   * server: the key may only file on one board, only from an origin the project
-   * registered, and only within its own rate and quota budget.
+   * server: the key can only file a report and read back what the presenting
+   * reporter wrote, only from an origin the project registered, and only within
+   * its own rate and quota budget.
+   *
+   * Both `rotate` calls return the new secret and leave the old one working for
+   * 24 hours, so a frontend can be rebuilt and redeployed in between.
    */
   ingestKeys = {
     list: (project, signal) => this.get(`/projects/${enc(project)}/ingest-keys`, void 0, signal),
     create: (project, body) => this.mutate("POST", `/projects/${enc(project)}/ingest-keys`, body),
+    rotate: (project, key) => this.mutate(
+      "POST",
+      `/projects/${enc(project)}/ingest-keys/${enc(key)}/rotate`
+    ),
+    rotateIdentitySecret: (project, key) => this.mutate(
+      "POST",
+      `/projects/${enc(project)}/ingest-keys/${enc(key)}/rotate-identity-secret`
+    ),
     revoke: (project, key) => this.mutate("DELETE", `/projects/${enc(project)}/ingest-keys/${enc(key)}`)
   };
+  // --- Feedback: reporters --------------------------------------------------
+  /**
+   * The people who filed the reports.
+   *
+   * `verified` is the only field Myna stands behind: a signature the project's
+   * own backend produced. `properties` is what that backend said about its own
+   * user — true of their system, not checked here.
+   */
+  reporters = {
+    list: (project, opts = {}) => {
+      const { q, blocked, ...rest } = opts;
+      return this.page(`/projects/${enc(project)}/reporters`, rest, {
+        q,
+        blocked: blocked === void 0 ? void 0 : String(blocked)
+      });
+    },
+    /** By id (`rpr_…`), by the customer's own user id, or by email. */
+    get: (project, reporter, signal) => this.get(
+      `/projects/${enc(project)}/reporters/${enc(reporter)}`,
+      void 0,
+      signal
+    ),
+    /**
+     * Block or unblock. Blocking stops notifications and closes read-back; it
+     * never deletes what they already filed.
+     */
+    setBlocked: (project, reporter, body) => this.mutate(
+      "PATCH",
+      `/projects/${enc(project)}/reporters/${enc(reporter)}`,
+      body
+    )
+  };
   // --- Declared external checks ---------------------------------------------
   checks = {
     list: (project, signal) => this.get(`/projects/${enc(project)}/checks`, void 0, signal),
@@ -3141,7 +3181,7 @@ function registerFeedback(program) {
       );
     })
   );
-  boards.command("create").description("Create a board").requiredOption("--key <key>", "lowercase key, e.g. qa").requiredOption("--name <name>", "display name").option("--type <type>", "bug | qa | feedback | feature_request", "bug").option("--description <text>", "what this board is for").option("--guidance <text>", "how reports here should be triaged and answered").action(
+  boards.command("create").description("Create a board").requiredOption("--key <key>", "lowercase key, e.g. qa").requiredOption("--name <name>", "display name").option("--type <type>", "bug | qa | feedback | feature_request", "bug").option("--description <text>", "what this board is for").option("--guidance <text>", "how reports here should be triaged and answered").option("--app-url <url>", "where your product shows these reports; linked from notification emails").option("--require-identity", "refuse submissions that carry no server-signed identity").action(
     handle(async (ctx, _args, opts) => {
       const project = ctx.requireProject();
       const board = await ctx.management().boards.create(project, {
@@ -3149,30 +3189,31 @@ function registerFeedback(program) {
         name: opts.name,
         type: opts.type,
         description: opts.description,
-        guidance: opts.guidance
+        guidance: opts.guidance,
+        appUrl: opts.appUrl,
+        requireIdentity: opts.requireIdentity
       });
       emit(board, () => diag(`Created board ${board.key} (${board.id}).`));
     })
   );
-  boards.command("update").description("Change a board's name, visibility, or voting").argument("<board>", "board key or id").option("--name <name>", "display name").option("--description <text>", "what this board is for").option("--guidance <text>", "how reports here should be triaged and answered").option("--visibility <visibility>", "private | public").option("--voting", "let readers of a public board vote").option("--no-voting", "turn voting off").action(
+  boards.command("update").description("Change a board's name, app URL, or identity requirement").argument("<board>", "board key or id").option("--name <name>", "display name").option("--description <text>", "what this board is for").option("--guidance <text>", "how reports here should be triaged and answered").option("--app-url <url>", "where your product shows these reports; 'none' to clear it").option("--require-identity", "refuse submissions that carry no server-signed identity").option("--no-require-identity", "accept unsigned submissions").action(
     handle(async (ctx, args, opts) => {
       const project = ctx.requireProject();
-      const visibility = opts.visibility;
-      if (visibility && visibility !== "private" && visibility !== "public") {
-        throw new Error(`--visibility must be private or public (got "${visibility}").`);
-      }
+      const appUrl = opts.appUrl;
       const board = await ctx.management().boards.update(project, args[0], {
         name: opts.name,
         description: opts.description,
         guidance: opts.guidance,
-        visibility,
-        votingEnabled: opts.voting
+        // `none` clears it. An empty string would fail URL validation, and
+        // omitting the flag has to keep meaning "leave it alone".
+        appUrl: appUrl === void 0 ? void 0 : appUrl === "none" ? null : appUrl,
+        requireIdentity: opts.requireIdentity
       });
       emit(board, () => {
         diag(`Updated board ${board.key}.`);
-        if (visibility === "public") {
+        if (board.requireIdentity && !board.appUrl) {
           diag(
-            `It is now public: every report on it is readable by anyone, and that cannot be undone for reports people have already seen.`
+            `This board requires a signed identity but names no --app-url, so notification emails carry the update with no link back.`
           );
         }
       });
@@ -3186,7 +3227,7 @@ function registerFeedback(program) {
     })
   );
   const reports = feedback.command("reports").description("Read and act on reports");
-  reports.command("list").description("List reports, most recently active first").option("--board <key>", "only this board").option("--status <list>", "comma-separated statuses").option("--type <type>", "bug | qa | feedback | feature_request").option("--priority <priority>", "low | normal | high | urgent").option("--assignee <userId>", "only reports assigned to this user").option("--labels <list>", "comma-separated labels; matches any").option("-q, --query <text>", "full-text search over title and body").option("--since <iso>", "only reports active at or after this time").option("--limit <n>", "page size", "25").action(
+  reports.command("list").description("List reports, most recently active first").option("--board <key>", "only this board").option("--status <list>", "comma-separated statuses").option("--type <type>", "bug | qa | feedback | feature_request").option("--priority <priority>", "low | normal | high | urgent").option("--assignee <userId>", "only reports assigned to this user").option("--labels <list>", "comma-separated labels; matches any").option("-q, --query <text>", "full-text search over title and body").option("--since <iso>", "only reports active at or after this time").option("--reporter <ref>", "a reporter's external id or email address").option("--property <key:value>", "match a reporter property, e.g. plan:enterprise").option("--limit <n>", "page size", "25").action(
     handle(async (ctx, _args, opts) => {
       const project = ctx.requireProject();
       const page = await ctx.management().reports.list(project, {
@@ -3198,6 +3239,8 @@ function registerFeedback(program) {
         labels: opts.labels?.split(","),
         q: opts.query,
         since: opts.since,
+        reporter: opts.reporter,
+        property: opts.property,
         limit: Number(opts.limit)
       });
       emit(
@@ -3359,50 +3402,13 @@ Timeline:`);
       );
     })
   );
-  reports.command("exposure").description("Show exactly what publishing a report to a board would expose").argument("<report>", "report id, number, or #number").requiredOption("--board <key>", "destination board").action(
-    handle(async (ctx, args, opts) => {
-      const project = ctx.requireProject();
-      const e = await ctx.management().reports.exposure(project, args[0], opts.board);
-      emit(e, () => {
-        diag(`Moving to "${e.board.key}" (${e.board.visibility}) would make this readable by anyone:`);
-        diag(`
-  ${e.willBePublic.title}`);
-        if (e.willBePublic.body) diag(`
-${e.willBePublic.body}`);
-        if (e.willBePublic.comments.length > 0) {
-          diag(`
-Public replies (${e.willBePublic.comments.length}):`);
-          for (const c of e.willBePublic.comments) diag(`  ${c.author}: ${c.body}`);
-        }
-        if (e.willBePublic.attachments.length > 0) {
-          diag(`
-Attachments:`);
-          for (const a of e.willBePublic.attachments) diag(`  ${a.filename} (${a.kind}, ${a.byteSize} bytes)`);
-        }
-        if (e.willBePublic.context) diag(`
-Environment: ${JSON.stringify(e.willBePublic.context)}`);
-        diag(`
-Stays private: ${e.willStayPrivate.internalComments} internal note(s)` + (e.willStayPrivate.reporterEmail ? `, the reporter's email` : ""));
-        for (const w of e.warnings) diag(`
-  ! ${w}`);
-        diag(`
-Publish with: myna feedback reports move ${args[0]} --board ${opts.board} --confirm`);
-      });
-    })
-  );
-  reports.command("move").description("Move a report to another board").argument("<report>", "report id, number, or #number").requiredOption("--board <key>", "destination board").option("--confirm", "required when the destination is public; run `exposure` first").action(
+  reports.command("move").description("Move a report to another board").argument("<report>", "report id, number, or #number").requiredOption("--board <key>", "destination board").action(
     handle(async (ctx, args, opts) => {
       const project = ctx.requireProject();
-      const result = await ctx.management().reports.move(project, args[0], {
-        board: opts.board,
-        confirm: Boolean(opts.confirm)
+      const report = await ctx.management().reports.move(project, args[0], {
+        board: opts.board
       });
-      emit(
-        result,
-        () => diag(
-          result.isPublic ? `#${result.number} is now public on ${result.board}.` : `#${result.number} moved to ${result.board}.`
-        )
-      );
+      emit(report, () => diag(`#${report.number} moved to ${report.boardKey}.`));
     })
   );
   reports.command("link").description("Point a report at a commit, pull request, entry, or release").argument("<report>", "report id, number, or #number").requiredOption("--kind <kind>", "commit | pull_request | entry | release | url").requiredOption("--value <value>", "the sha, URL, id, or release number").option("--title <text>", "label for the link").action(
@@ -3457,15 +3463,18 @@ Publish with: myna feedback reports move ${args[0]} --board ${opts.board} --conf
         () => table(rows, [
           { header: "ID", value: (k) => k.id },
           { header: "NAME", value: (k) => k.name },
-          { header: "BOARD", value: (k) => k.boardKey },
+          { header: "BOARD", value: (k) => k.boardKey ?? "any" },
           { header: "SIGNED ID", value: (k) => k.hasIdentitySecret ? "yes" : "no" },
           { header: "LAST USED", value: (k) => k.lastUsedAt ?? "never" },
-          { header: "STATE", value: (k) => k.revokedAt ? "revoked" : "live" }
+          {
+            header: "STATE",
+            value: (k) => k.revokedAt ? "revoked" : k.previousSecretExpiresAt ? "rotating" : "live"
+          }
         ])
       );
     })
   );
-  keys.command("create").description("Create a publishable ingest key").requiredOption("--name <name>", "what this key is for").requiredOption("--board <key>", "board it may file on").option("--signed-identity", "also mint a server-side secret for signed identify").action(
+  keys.command("create").description("Create a publishable ingest key").requiredOption("--name <name>", "what this key is for").option("--board <key>", "restrict it to one board; omit to accept any board on the project").option("--signed-identity", "also mint a server-side secret for signed identify").action(
     handle(async (ctx, _args, opts) => {
       const project = ctx.requireProject();
       const created = await ctx.management().ingestKeys.create(project, {
@@ -3474,13 +3483,18 @@ Publish with: myna feedback reports move ${args[0]} --board ${opts.board} --conf
         withIdentitySecret: Boolean(opts.signedIdentity)
       });
       emit(created, () => {
-        diag(`Created ingest key ${created.id} for board ${created.boardKey}.`);
+        diag(
+          created.boardKey ? `Created ingest key ${created.id} for board ${created.boardKey}.` : `Created ingest key ${created.id} for any board on this project.`
+        );
         diag(``);
         diag(`  ${created.key}`);
         diag(``);
         diag(`This key is publishable \u2014 it is designed to sit in your browser bundle.`);
-        diag(`It can only file a report on ${created.boardKey}, and only from an origin`);
-        diag(`registered on this project. Add yours with: myna projects update --origins`);
+        diag(
+          created.boardKey ? `It can only file on ${created.boardKey} and read back what the presenting reporter wrote.` : `It can file on any board on this project and read back what the presenting reporter wrote.`
+        );
+        diag(`Requests are refused from any origin the project has not registered.`);
+        diag(`Add yours with: myna projects update --origins`);
         if (created.identitySecret) {
           diag(``);
           diag(`Identity signing secret (shown once \u2014 keep it on your server):`);
@@ -3488,15 +3502,115 @@ Publish with: myna feedback reports move ${args[0]} --board ${opts.board} --conf
           diag(`  ${created.identitySecret}`);
           diag(``);
           diag(`Sign a user id with HMAC-SHA256 and pass it as identify.signature.`);
+          diag(`signIdentity in @myna-sh/sdk/feedback/server does it for you.`);
         }
       });
     })
   );
+  keys.command("rotate").description("Mint a new secret, leaving the old one live for 24 hours").argument("<key>", "ingest key id").option("--identity-secret", "rotate the identity signing secret instead of the key").action(
+    handle(async (ctx, args, opts) => {
+      const project = ctx.requireProject();
+      const keyId = args[0];
+      if (opts.identitySecret) {
+        const rotated2 = await ctx.management().ingestKeys.rotateIdentitySecret(project, keyId);
+        emit(rotated2, () => {
+          diag(`Rotated the identity secret on ${rotated2.id} (shown once):`);
+          diag(``);
+          diag(`  ${rotated2.identitySecret}`);
+          diag(``);
+          diag(`The old secret keeps verifying until ${rotated2.previousIdentitySecretExpiresAt}.`);
+        });
+        return;
+      }
+      const rotated = await ctx.management().ingestKeys.rotate(project, keyId);
+      emit(rotated, () => {
+        diag(`Rotated ${rotated.id} (shown once):`);
+        diag(``);
+        diag(`  ${rotated.key}`);
+        diag(``);
+        diag(`The old key keeps working until ${rotated.previousSecretExpiresAt}. Deploy before then.`);
+      });
+    })
+  );
   keys.command("revoke").description("Revoke an ingest key").argument("<key>", "ingest key id").action(
     handle(async (ctx, args) => {
       const project = ctx.requireProject();
       const result = await ctx.management().ingestKeys.revoke(project, args[0]);
-      emit(result, () => diag(`Revoked ${args[0]}. Sites using it can no longer submit.`));
+      emit(
+        result,
+        () => diag(
+          `Revoked ${args[0]}. Sites using it can no longer submit, including a secret mid-rotation.`
+        )
+      );
+    })
+  );
+  const people = feedback.command("people").description("The reporters who filed the reports");
+  people.command("list").description("List reporters, most recent first").option("-q, --query <text>", "match an email, name, or external id").option("--blocked", "only blocked reporters").option("--limit <n>", "page size", "25").action(
+    handle(async (ctx, _args, opts) => {
+      const project = ctx.requireProject();
+      const page = await ctx.management().reporters.list(project, {
+        q: opts.query,
+        blocked: opts.blocked ? true : void 0,
+        limit: Number(opts.limit)
+      });
+      emit(
+        { data: page.data, nextCursor: page.nextCursor },
+        () => table(page.data, [
+          { header: "ID", value: (r) => r.id },
+          { header: "WHO", value: (r) => r.displayName ?? r.email ?? r.externalId ?? "\u2014" },
+          { header: "EXTERNAL", value: (r) => r.externalId ?? "\u2014" },
+          { header: "VERIFIED", value: (r) => r.verified ? "yes" : "no" },
+          { header: "REPORTS", value: (r) => String(r.reportCount) },
+          { header: "LAST SEEN", value: (r) => r.lastSeenAt ?? "never" },
+          { header: "STATE", value: (r) => r.blocked ? "blocked" : "active" }
+        ])
+      );
+    })
+  );
+  people.command("show").description("One reporter and everything they have filed").argument("<reporter>", "reporter id, your own user id, or an email address").action(
+    handle(async (ctx, args) => {
+      const project = ctx.requireProject();
+      const r = await ctx.management().reporters.get(project, args[0]);
+      emit(r, () => {
+        diag(`${r.displayName ?? r.email ?? r.externalId ?? r.id}`);
+        diag(
+          `${r.verified ? "verified" : "unverified"} \xB7 ${r.reportCount} report(s)` + (r.blocked ? " \xB7 blocked" : "")
+        );
+        if (r.email) diag(`email: ${r.email}`);
+        if (r.externalId) diag(`your id: ${r.externalId}`);
+        if (r.properties && Object.keys(r.properties).length > 0) {
+          diag(`
+Properties (from your application):`);
+          for (const [k, v] of Object.entries(r.properties)) diag(`  ${k}: ${JSON.stringify(v)}`);
+        }
+        if (r.reports.length > 0) {
+          diag(``);
+          table(r.reports, [
+            { header: "#", value: (x) => String(x.number) },
+            { header: "TITLE", value: (x) => x.title },
+            { header: "BOARD", value: (x) => x.boardKey },
+            { header: "STATUS", value: (x) => x.status },
+            { header: "ACTIVITY", value: (x) => x.lastActivityAt }
+          ]);
+        }
+      });
+    })
+  );
+  people.command("block").description("Stop a reporter filing, reading back, or being notified").argument("<reporter>", "reporter id, your own user id, or an email address").action(
+    handle(async (ctx, args) => {
+      const project = ctx.requireProject();
+      const r = await ctx.management().reporters.setBlocked(project, args[0], { blocked: true });
+      emit(
+        r,
+        () => diag(`Blocked ${r.displayName ?? r.email ?? r.id}. What they already filed is untouched.`)
+      );
+    })
+  );
+  people.command("unblock").description("Let a blocked reporter back in").argument("<reporter>", "reporter id, your own user id, or an email address").action(
+    handle(async (ctx, args) => {
+      const project = ctx.requireProject();
+      const r = await ctx.management().reporters.setBlocked(project, args[0], { blocked: false });
+      emit(r, () => diag(`Unblocked ${r.displayName ?? r.email ?? r.id}.`));
     })
   );
   const attachments = feedback.command("attachments").description("Evidence attached to a report");
@@ -3683,9 +3797,7 @@ var ID_PREFIXES = {
   reportAttachment: "rat",
   reportAttachmentUpload: "rau",
   reportLink: "rlk",
-  ingestKey: "ing",
-  reporterToken: "rtk",
-  reportVote: "rvt"
+  ingestKey: "ing"
 };
 var PREFIX_SET = new Set(Object.values(ID_PREFIXES));
 
@@ -3782,7 +3894,18 @@ var REPORT_LIMITS = {
   labelsPerReport: 20,
   labelChars: 40,
   /** Serialized `context`, which a developer supplies and we do not police. */
-  contextBytes: 16 * 1024
+  contextBytes: 16 * 1024,
+  /**
+   * Serialized reporter `properties`, and how many keys they may have.
+   *
+   * Properties are the customer's own facts about their own user — plan, seat
+   * count, the tenant they belong to — sent with a signed identity so a triager
+   * can tell an enterprise regression from a hobbyist's. Bounded because they
+   * are replaced wholesale on every submission and read on every inbox filter,
+   * not because 33 keys would be wrong to want.
+   */
+  reporterPropertyBytes: 4 * 1024,
+  reporterPropertyKeys: 32
 };
 
 // ../shared/dist/rank.js
@@ -5452,7 +5575,7 @@ function installCommand(manager, version) {
 }
 
 // src/version.ts
-var VERSION = true ? "0.15.0" : "0.0.0-dev";
+var VERSION = true ? "0.16.0" : "0.0.0-dev";
 var IS_RELEASE_BUILD = true;
 
 // src/commands/doctor.ts