@bicharts/chart-host 0.5.106 → 0.5.107

package/dist/index.mjs

@@ -649,6 +649,140 @@ function askApplyImprovements(container, reason, opts = {}) {
   });
 }
 
+// src/productFeedback.ts
+var PRODUCT_FEEDBACK_MAX_CHARS = 2e3;
+var PRODUCT_FEEDBACK_MIN_CHARS = 3;
+function normaliseProductFeedbackText(raw, maxChars = PRODUCT_FEEDBACK_MAX_CHARS) {
+  const s2 = String(raw ?? "").replace(/\r\n?/g, "\n").replace(/[\u0000-\u0008\u000B\u000C\u000E-\u001F\u007F]/g, "").split("\n").map((line) => line.replace(/[ \t]+$/, "")).join("\n").replace(/\n{3,}/g, "\n\n").trim();
+  return s2.length > maxChars ? s2.slice(0, maxChars).trimEnd() : s2;
+}
+function productFeedbackSendable(raw, maxChars = PRODUCT_FEEDBACK_MAX_CHARS) {
+  return normaliseProductFeedbackText(raw, maxChars).length >= PRODUCT_FEEDBACK_MIN_CHARS;
+}
+function buildProductFeedbackPayload(input) {
+  const id = input.identity ?? {};
+  return {
+    text: normaliseProductFeedbackText(input.text),
+    host: input.host,
+    surface: input.surface || "landing",
+    clientVersion: input.clientVersion || "",
+    correlationId: input.correlationId || "",
+    clientId: id.clientId || "",
+    licenseKey: id.licenseKey || "",
+    licensee: id.licensee || "",
+    secretKey: id.secretKey || "",
+    freemiumKey: id.freemiumKey || "",
+    linkNonce: id.linkNonce || "",
+    instanceKey: id.instanceKey || ""
+  };
+}
+var DEFAULT_TEXT2 = {
+  label: "Your suggestions",
+  placeholder: "An idea, a missing chart, or something that got in your way",
+  hint: "Sent to our team. It is never used to draw a chart.",
+  send: "Send",
+  sending: "Sending...",
+  sent: "Thank you - your suggestion was sent.",
+  failed: "Your suggestion could not be sent. It is still in the box - please try again."
+};
+function mountProductFeedbackBox(container, opts) {
+  const doc = container.ownerDocument ?? document;
+  const text = { ...DEFAULT_TEXT2, ...opts.text ?? {} };
+  const maxChars = Math.max(PRODUCT_FEEDBACK_MIN_CHARS, Math.floor(opts.maxChars ?? PRODUCT_FEEDBACK_MAX_CHARS));
+  const wrap = doc.createElement("div");
+  wrap.className = "bic-product-feedback" + (opts.className ? " " + opts.className : "");
+  const inputId = "bic-product-feedback-" + ++mounted;
+  const label = doc.createElement("label");
+  label.className = "bic-product-feedback-label";
+  label.htmlFor = inputId;
+  label.textContent = text.label;
+  const input = doc.createElement("textarea");
+  input.className = "bic-product-feedback-input";
+  input.id = inputId;
+  input.rows = 2;
+  input.maxLength = maxChars;
+  input.placeholder = text.placeholder;
+  input.setAttribute("aria-describedby", inputId + "-hint");
+  const hint = doc.createElement("div");
+  hint.className = "bic-product-feedback-hint";
+  hint.id = inputId + "-hint";
+  hint.textContent = text.hint;
+  const row = doc.createElement("div");
+  row.className = "bic-product-feedback-row";
+  const button = doc.createElement("button");
+  button.type = "button";
+  button.className = "bic-product-feedback-send";
+  button.textContent = text.send;
+  const status = doc.createElement("span");
+  status.className = "bic-product-feedback-status";
+  status.setAttribute("role", "status");
+  status.setAttribute("aria-live", "polite");
+  row.append(button, status);
+  wrap.append(label, input, hint, row);
+  container.appendChild(wrap);
+  let sending = false;
+  const sync = () => {
+    button.disabled = sending || !productFeedbackSendable(input.value, maxChars);
+  };
+  const onInput = () => {
+    if (!sending && status.textContent) {
+      status.textContent = "";
+      status.removeAttribute("data-state");
+    }
+    sync();
+  };
+  const onClick = async () => {
+    if (sending || !productFeedbackSendable(input.value, maxChars)) return;
+    const message = normaliseProductFeedbackText(input.value, maxChars);
+    sending = true;
+    sync();
+    button.textContent = text.sending;
+    status.textContent = "";
+    status.removeAttribute("data-state");
+    let result;
+    let failure = "";
+    try {
+      result = await opts.send(message);
+      if (!result?.ok) failure = result?.message || "not sent";
+    } catch (e2) {
+      result = { ok: false };
+      failure = String(e2?.message ?? e2);
+    }
+    sending = false;
+    button.textContent = text.send;
+    if (result?.ok) {
+      input.value = "";
+      status.textContent = result.message || text.sent;
+      status.setAttribute("data-state", "sent");
+      safely(() => opts.onSent?.());
+    } else {
+      status.textContent = result?.message || text.failed;
+      status.setAttribute("data-state", "failed");
+      safely(() => opts.onFailed?.(failure));
+    }
+    sync();
+  };
+  input.addEventListener("input", onInput);
+  button.addEventListener("click", onClick);
+  sync();
+  safely(() => opts.onShown?.());
+  return {
+    element: wrap,
+    destroy() {
+      input.removeEventListener("input", onInput);
+      button.removeEventListener("click", onClick);
+      wrap.remove();
+    }
+  };
+}
+var mounted = 0;
+function safely(fn) {
+  try {
+    fn();
+  } catch {
+  }
+}
+
 // src/qualifyGroups.ts
 function newQualifyGroupState() {
   return { preview: false, previewClosed: false, projected: false, notRecommended: false, rankedSeen: false };
@@ -2282,6 +2416,8 @@ export {
   PILL_MIN_ALPHA,
   PILL_MIN_COVERAGE,
   PILL_OPAQUE_ALPHA,
+  PRODUCT_FEEDBACK_MAX_CHARS,
+  PRODUCT_FEEDBACK_MIN_CHARS,
   QUALIFY_REFUSAL_UNSPECIFIED,
   ROW_IDX_ATTR,
   SAME_SHADE_DELTA_E,
@@ -2303,6 +2439,7 @@ export {
   blankRenderFlag,
   buildPalette,
   buildPaletteFromSeed,
+  buildProductFeedbackPayload,
   buildRenderPayload,
   buildReviewWire,
   canConfirmLaunch,
@@ -2362,11 +2499,13 @@ export {
   loadGeo,
   markerArmedBlind,
   measureContainerBoxes,
+  mountProductFeedbackBox,
   needsScroll,
   newQualifyGroupState,
   newQualifyRefusalGroupState,
   noopViewStateProvider,
   normaliseAggregation,
+  normaliseProductFeedbackText,
   normalizeFilterTerm,
   orderMostDistinct,
   orderRefusalsForDisplay,
@@ -2381,6 +2520,7 @@ export {
   planFrameGrow,
   planTrivialChart,
   pollGiveUpKeepsMarker,
+  productFeedbackSendable,
   qualifyAuto,
   qualifyCancel,
   qualifyFailureFallsOpen,

package/dist/types/index.d.ts

@@ -12,6 +12,7 @@ export { planTrivialChart, compileTrivialSource, type TrivialPlan, type TrivialS
 export { captureSvgSnapshot, svgToDataUrl, svgNaturalSize, rasterizeSvgToPngDataUrl, type SnapshotOptions } from "./snapshot";
 export { shouldReview, buildReviewWire, bareBase64, actionFor, type ReviewGate, type ReviewWire, type ReviewVerdict, type ReviewAction } from "./review";
 export { askApplyImprovements, type ReviewDialogOptions, type ReviewDialogText } from "./reviewDialog";
+export { mountProductFeedbackBox, normaliseProductFeedbackText, productFeedbackSendable, buildProductFeedbackPayload, PRODUCT_FEEDBACK_MAX_CHARS, PRODUCT_FEEDBACK_MIN_CHARS, type ProductFeedbackBox, type ProductFeedbackBoxOptions, type ProductFeedbackText, type ProductFeedbackSendResult, type ProductFeedbackPayload, type ProductFeedbackIdentity, type ProductFeedbackHost, } from "./productFeedback";
 export { qualifyGroupHeadingFor, newQualifyGroupState, type QualifyGroupRow, type QualifyGroupState, type QualifyGroupHeading, orderRefusalsForDisplay, refusalIsSelectable, hasRefusalsToShow, qualifyRefusalHeadingFor, newQualifyRefusalGroupState, qualifyRefusalReason, QUALIFY_REFUSAL_UNSPECIFIED, type QualifyRefusalRow, type QualifyRefusalGroupState, type QualifyRefusalHeading, } from "./qualifyGroups";
 export { qualifyPick, qualifyAuto, qualifyCancel, launchGenerates, launchFavorStyle, chooserFitsViewport, shouldOpenChooserOnGenerate, shouldOpenInlineChooserOnGenerate, canConfirmLaunch, confirmLaunch, qualifyFailureFallsOpen, CHOOSER_MIN_WIDTH_PX, CHOOSER_MIN_HEIGHT_PX, type QualifyLaunchOutcome, type ChooserGateInput, } from "./qualifyLaunch";
 export { normalizeFilterTerm, filterQualifyRows, readQualifyChartRow, readQualifyRefusalRow, filterFitsChooser, listNeedsFilter, qualifyFilterGate, inlineFilterGate, FILTER_MIN_TERM_CHARS, FILTER_ROW_PX, FILTER_MIN_WIDTH_PX, FILTER_MIN_HEIGHT_PX, INLINE_FILTER_MIN_ROWS, computeQualifyFilterView, qualifyFilterCountText, type QualifyFilterTier, type QualifyFilterResult, type QualifyFilterRead, type QualifyFilterGateReason, type QualifyFilterGateInput, type QualifyFilterRow, type QualifyFilterGroup, type QualifyFilterView, type QualifyFilterNoteKind, } from "./qualifyFilter";

package/dist/types/productFeedback.d.ts

@@ -0,0 +1,88 @@
+/** The longest message a host will send. Mirrored by the service's own cap. */
+export declare const PRODUCT_FEEDBACK_MAX_CHARS = 2000;
+/** Below this there is nothing a person could act on ("ok", "hi"). */
+export declare const PRODUCT_FEEDBACK_MIN_CHARS = 3;
+/** Which host a message came from. The service files it under that host. */
+export type ProductFeedbackHost = "PBI" | "EXCEL";
+/**
+ * Clean a typed message for sending: control characters other than line breaks and tabs removed,
+ * trailing spaces on each line removed, runs of blank lines collapsed to one, trimmed, and capped.
+ * Pure, so every host sends the same bytes for the same keystrokes.
+ */
+export declare function normaliseProductFeedbackText(raw: string | null | undefined, maxChars?: number): string;
+/** True when a message is long enough to send. */
+export declare function productFeedbackSendable(raw: string | null | undefined, maxChars?: number): boolean;
+/** The credentials a host already holds, forwarded so the service can attach an account when there is one. The
+ *  service resolves identity itself; nothing here names an account. Absent fields are sent empty. */
+export interface ProductFeedbackIdentity {
+    licenseKey?: string;
+    licensee?: string;
+    secretKey?: string;
+    freemiumKey?: string;
+    linkNonce?: string;
+    instanceKey?: string;
+    clientId?: string;
+}
+export interface ProductFeedbackPayload {
+    text: string;
+    host: ProductFeedbackHost;
+    surface: string;
+    clientVersion: string;
+    correlationId: string;
+    clientId: string;
+    licenseKey: string;
+    licensee: string;
+    secretKey: string;
+    freemiumKey: string;
+    linkNonce: string;
+    instanceKey: string;
+}
+/** The request body every host sends (before its own encoding and signing). */
+export declare function buildProductFeedbackPayload(input: {
+    text: string;
+    host: ProductFeedbackHost;
+    surface?: string;
+    clientVersion: string;
+    correlationId: string;
+    identity?: ProductFeedbackIdentity;
+}): ProductFeedbackPayload;
+/** What a host's send callback reports. `message` is shown to the reader when present. */
+export interface ProductFeedbackSendResult {
+    ok: boolean;
+    message?: string;
+}
+/** The words a reader sees. Hosts localize; every field has an English default. */
+export interface ProductFeedbackText {
+    label?: string;
+    placeholder?: string;
+    hint?: string;
+    send?: string;
+    sending?: string;
+    sent?: string;
+    failed?: string;
+}
+export interface ProductFeedbackBoxOptions {
+    /** Delivers the cleaned text. Resolve { ok: false } (or throw) on failure; the box keeps the text either way. */
+    send: (text: string) => Promise<ProductFeedbackSendResult>;
+    text?: ProductFeedbackText;
+    /** Added to the wrapper so the host can skin it; the structure stays the same. */
+    className?: string;
+    maxChars?: number;
+    /** Called once, when the box is mounted - the host's "shown" counter. */
+    onShown?: () => void;
+    /** Called after a successful send - the host's "sent" counter. */
+    onSent?: () => void;
+    /** Called after a failed send, with what failed, so the host can log it. */
+    onFailed?: (reason: string) => void;
+}
+export interface ProductFeedbackBox {
+    element: HTMLElement;
+    /** Removes the box and its listeners. */
+    destroy(): void;
+}
+/**
+ * Build the box inside `container`. The wrapper carries `bic-product-feedback` (plus the host's
+ * class); the textarea, button and status line carry `bic-product-feedback-input`, `-send` and
+ * `-status`, so hosts and tests can find them without depending on the order of elements.
+ */
+export declare function mountProductFeedbackBox(container: HTMLElement, opts: ProductFeedbackBoxOptions): ProductFeedbackBox;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bicharts/chart-host",
-  "version": "0.5.106",
+  "version": "0.5.107",
   "description": "Run a BIC-generated D3 chart in any web host: compiles the generated render() function, applies the shared option defaults, resolves mark clicks (through tooltip overlays), owns the selection affordance, and translates row indices between cross-filtered charts. The same contract the BIC Power BI visual implements, minus Power BI. React bindings at @bicharts/chart-host/react.",
   "license": "Apache-2.0",
   "type": "module",