@picked/svelte 0.0.1-dev.1793923852884 → 0.0.1-dev.1793933802654

package/dist/plugins/devtools/derive/issue-report/issue-report.d.ts

@@ -0,0 +1,255 @@
+/**
+ * @file A reviewer's report of an issue: what it says, the session it was filed from, and the
+ * markdown body a tracker shows. A sink maps the report onto its tracker.
+ */
+import type { JsonValue } from '@picked/client';
+/** What a report is about. */
+export type IssueKind = 'bug' | 'improvement' | 'feature';
+/** Every kind, in the order the form offers them. */
+export declare const ISSUE_KINDS: readonly {
+    value: IssueKind;
+    label: string;
+}[];
+/** How soon a report needs attention. A sink maps it onto its tracker's own scale. */
+export type IssuePriority = 'none' | 'low' | 'medium' | 'high' | 'urgent';
+/** Every priority, lowest first, in the order the form offers them. */
+export declare const ISSUE_PRIORITIES: readonly {
+    value: IssuePriority;
+    label: string;
+}[];
+/** A file sent with a report. */
+export interface IssueAttachment {
+    filename: string;
+    contentType: string;
+    /** The file's bytes, base64-encoded, with no `data:` prefix. */
+    data: string;
+    /** The file's size in bytes. */
+    size: number;
+}
+/** Where the visitor was when a report was made. Versioned, so a reader can rebuild the session. */
+export interface IssueContext {
+    v: 1;
+    /** When the context was taken, as an ISO 8601 time. */
+    capturedAt: string;
+    /** The page's path, without its host or query. Empty once the reviewer removes it. */
+    pagePath: string;
+    /** Which configuration the page runs: the published one, or a preview's draft. */
+    workspace: 'published' | 'draft';
+    experience: {
+        key: string;
+        name: string;
+    } | null;
+    step: {
+        key: string;
+        name: string;
+        inTransit: boolean;
+    } | null;
+    /** The steps moved on from, oldest first. */
+    route: {
+        experienceKey: string;
+        stepKey: string;
+        stepName: string;
+    }[];
+    /** The responses, by field key, with personal values hidden. */
+    responses: Record<string, JsonValue>;
+    /** The keys whose values `responses` hides. */
+    hidden: string[];
+    /** The persona the reviewer walks through as. */
+    persona: {
+        id: string;
+        name: string;
+    } | null;
+    /** Facts the site adds, such as a scenario key. */
+    site: Record<string, JsonValue>;
+}
+/** What a reviewer reports, ready for a sink. */
+export interface IssueReport {
+    v: 1;
+    title: string;
+    description: string;
+    kind: IssueKind;
+    priority: IssuePriority;
+    labels: string[];
+    attachments: IssueAttachment[];
+    context: IssueContext;
+    /** The description, a readable context and the context as a JSON block, in markdown. */
+    body: string;
+}
+/** What a sink hands back once a report is filed. */
+export interface IssueReceipt {
+    /** The tracker's name for the issue, such as `ENG-123`. */
+    reference: string | null;
+    /** Where the issue can be opened. */
+    url: string | null;
+}
+/** Files a report and resolves with its receipt; rejects when it was not filed. */
+export type IssueSink = (report: IssueReport) => Promise<IssueReceipt>;
+/** What a hidden response reads as. */
+export declare const HIDDEN_VALUES: {
+    readonly email: '[hidden email]';
+    readonly phone: '[hidden phone number]';
+    readonly date: '[hidden date]';
+    readonly details: '[hidden details]';
+};
+/** The longest title a report takes. */
+export declare const MAX_TITLE_LENGTH = 256;
+/** The longest description a report takes. */
+export declare const MAX_DESCRIPTION_LENGTH = 10000;
+/** File types a report can carry: raster images, PDF and plain text, none of which runs script. */
+export declare const ATTACHMENT_TYPES: readonly string[];
+/** The most a report carries in files, each one and all together. */
+export declare const MAX_ATTACHMENT_BYTES: number;
+/**
+ * A response as a report shows it by default. Text that reads as an email, a phone number or a
+ * date is hidden, and so is anything structured, which tends to hold a person's details.
+ *
+ * @param {unknown} value - The response.
+ * @returns {JsonValue | undefined} The value to send, or `undefined` for one that cannot be sent.
+ * @example maskValue({ name: 'Ann' }) // '[hidden details]'
+ */
+export declare function maskValue(value: unknown): JsonValue | undefined;
+/**
+ * Whether a value is one a report can carry as JSON.
+ *
+ * @param {unknown} value - The value to test.
+ * @returns {boolean} `true` for text, finite numbers, booleans, `null`, and arrays or plain objects of those.
+ * @example isJsonValue({ a: [1, 'b'] }) // true
+ */
+export declare function isJsonValue(value: unknown): value is JsonValue;
+/** What a report's context is built from. */
+export interface ContextInput {
+    capturedAt: Date;
+    pagePath: string;
+    workspace: 'published' | 'draft';
+    /** The journey in front of the reviewer. */
+    journey: {
+        experienceKey: string;
+        experienceName: string;
+        stepKey: string | null;
+        stepName: string | null;
+        inTransit: boolean;
+    } | null;
+    /** The steps moved on from, oldest first. */
+    route: readonly {
+        journey: string;
+        screen: string;
+        screenName: string;
+    }[];
+    responses: Readonly<Record<string, unknown>>;
+    /** Keys that code commits, which a report leaves out. */
+    codeOwned: ReadonlySet<string>;
+    persona: {
+        id: string;
+        name: string;
+    } | null;
+    site: Readonly<Record<string, unknown>>;
+    /**
+     * Decides each response's value. An answer that is not JSON, such as `undefined`, leaves the
+     * response out. Defaults to {@link maskValue}.
+     */
+    redact: ((key: string, value: unknown) => unknown) | null;
+}
+/**
+ * Builds a report's context: where the visitor is, how they got there, and their responses with
+ * personal values hidden.
+ *
+ * @param {ContextInput} input - The session, as the devtools read it.
+ * @returns {IssueContext} The context.
+ * @example buildIssueContext({ ...input, responses: { email: 'ann@example.com' } }).hidden // ['email']
+ */
+export declare function buildIssueContext(input: ContextInput): IssueContext;
+/** A part of the context the reviewer can see, and remove before sending. */
+export type ContextRowId = 'experience' | 'step' | 'page' | 'route' | 'responses' | 'persona' | 'site';
+/** One line of the context a report carries. */
+export interface ContextRow {
+    id: ContextRowId;
+    label: string;
+    value: string;
+}
+/**
+ * The parts of a context, as lines a reviewer reads. A part with nothing in it has no line.
+ *
+ * @param {IssueContext} context - The context.
+ * @returns {ContextRow[]} The lines, in reading order.
+ * @example contextRows(context)[0] // { id: 'experience', label: 'Experience', value: 'Funnel' }
+ */
+export declare function contextRows(context: IssueContext): ContextRow[];
+/**
+ * A set with a value added, or taken out when it is already there.
+ *
+ * @param {ReadonlySet<T>} set - The set.
+ * @param {T} value - The value to toggle.
+ * @returns {ReadonlySet<T>} A new set; the given one is left as it is.
+ * @template T
+ * @example toggled(new Set(['a']), 'a').size // 0
+ */
+export declare function toggled<T>(set: ReadonlySet<T>, value: T): ReadonlySet<T>;
+/**
+ * A context without the parts the reviewer removed.
+ *
+ * @param {IssueContext} context - The context.
+ * @param {ReadonlySet<ContextRowId>} removed - The parts to leave out.
+ * @returns {IssueContext} The context, emptied of each removed part.
+ * @example withoutRows(context, new Set(['responses'])).responses // {}
+ */
+export declare function withoutRows(context: IssueContext, removed: ReadonlySet<ContextRowId>): IssueContext;
+/**
+ * A report's markdown body: the description, the context as lines, then the context as a JSON
+ * block a reader can rebuild the session from.
+ *
+ * @param {string} description - What the reviewer wrote.
+ * @param {IssueContext} context - The context the report carries.
+ * @returns {string} The body.
+ * @example renderIssueBody('The button is grey.', context).startsWith('The button is grey.') // true
+ */
+export declare function renderIssueBody(description: string, context: IssueContext): string;
+/** What the reviewer filled in. */
+export interface IssueDraft {
+    title: string;
+    description: string;
+    kind: IssueKind;
+    priority: IssuePriority;
+    labels: readonly string[];
+    attachments: readonly IssueAttachment[];
+}
+/**
+ * Why a draft cannot be sent yet, or `null` when it can.
+ *
+ * @param {Pick<IssueDraft, 'title' | 'description'>} draft - The draft.
+ * @returns {string | null} The problem, in words the reviewer reads.
+ * @example draftProblem({ title: '', description: '' }) // 'Give the issue a title.'
+ */
+export declare function draftProblem(draft: Pick<IssueDraft, 'title' | 'description'>): string | null;
+/**
+ * Builds the report a sink files.
+ *
+ * @param {IssueDraft} draft - What the reviewer filled in.
+ * @param {IssueContext} context - The context, without the parts the reviewer removed.
+ * @returns {IssueReport} The report, with its markdown body.
+ * @example buildIssueReport(draft, context).body
+ */
+export declare function buildIssueReport(draft: IssueDraft, context: IssueContext): IssueReport;
+/**
+ * Why a file cannot go with a report, or `null` when it can.
+ *
+ * @param {{ name: string; type: string; size: number }} file - The file.
+ * @param {string} file.name - Its name.
+ * @param {string} file.type - Its media type.
+ * @param {number} file.size - Its size in bytes.
+ * @param {readonly IssueAttachment[]} attached - The files already attached.
+ * @returns {string | null} The problem, in words the reviewer reads.
+ * @example attachmentProblem({ name: 'logo.svg', type: 'image/svg+xml', size: 10 }, [])
+ */
+export declare function attachmentProblem(file: {
+    name: string;
+    type: string;
+    size: number;
+}, attached: readonly IssueAttachment[]): string | null;
+/**
+ * Reads a sink's answer as a receipt. A sink that answers nothing usable still filed the report.
+ *
+ * @param {unknown} value - What the sink resolved with.
+ * @returns {IssueReceipt} The reference and link it named, each `null` when absent.
+ * @example readReceipt({ identifier: 'ENG-1', url: 'https://…' }) // { reference: 'ENG-1', url: 'https://…' }
+ */
+export declare function readReceipt(value: unknown): IssueReceipt;

package/dist/plugins/devtools/derive/issue-report/issue-report.js

@@ -0,0 +1,2 @@
+var e=[{value:`bug`,label:`Bug`},{value:`improvement`,label:`Improvement`},{value:`feature`,label:`Feature`}],t=[{value:`none`,label:`No priority`},{value:`low`,label:`Low`},{value:`medium`,label:`Medium`},{value:`high`,label:`High`},{value:`urgent`,label:`Urgent`}],n={email:`[hidden email]`,phone:`[hidden phone number]`,date:`[hidden date]`,details:`[hidden details]`},r=256,i=1e4,a=[`image/png`,`image/jpeg`,`image/gif`,`image/webp`,`application/pdf`,`text/plain`,`text/csv`,`application/json`],o=3145728,s=/^\+?[\d\s().-]+$/,c=/^\d{1,4}[-/.]\d{1,2}[-/.]\d{1,4}/;function l(e){return[...e].filter(e=>e>=`0`&&e<=`9`).length}function u(e){let t=e.split(`@`);if(t.length!==2||/\s/.test(e))return!1;let[n=``,r=``]=t,i=r.indexOf(`.`);return n!==``&&i>0&&i<r.length-1}function d(e){let t=e.trim();return u(t)?n.email:c.test(t)?n.date:s.test(t)&&l(t)>=8?n.phone:e}function f(e){if(e===null||typeof e==`boolean`)return e;if(typeof e==`number`)return Number.isFinite(e)?e:void 0;if(typeof e==`string`)return d(e);if(Array.isArray(e)){let t=e.map(e=>typeof e==`object`?void 0:f(e));return t.every(e=>e!==void 0)?t:n.details}return typeof e==`object`?n.details:void 0}function p(e){return e===null||typeof e==`string`||typeof e==`boolean`?!0:typeof e==`number`?Number.isFinite(e):Array.isArray(e)?e.every(p):typeof e==`object`&&Object.values(e).every(p)}function m(e){let t={},n=[];for(let[r,i]of Object.entries(e.responses)){if(e.codeOwned.has(r))continue;let a=e.redact?e.redact(r,i):f(i);p(a)&&(t[r]=a,JSON.stringify(a)!==JSON.stringify(i)&&n.push(r))}let r={};for(let[t,n]of Object.entries(e.site))p(n)&&(r[t]=n);let{journey:i}=e;return{v:1,capturedAt:e.capturedAt.toISOString(),pagePath:e.pagePath,workspace:e.workspace,experience:i?{key:i.experienceKey,name:i.experienceName}:null,step:i?.stepKey==null?null:{key:i.stepKey,name:i.stepName??i.stepKey,inTransit:i.inTransit},route:e.route.map(e=>({experienceKey:e.journey,stepKey:e.screen,stepName:e.screenName})),responses:t,hidden:n,persona:e.persona,site:r}}function h(e){return typeof e==`string`?e:JSON.stringify(e)}function g(e){let t=[];if(e.experience&&t.push({id:`experience`,label:`Experience`,value:e.experience.name}),e.step){let n=e.step.inTransit?` (moving on from it)`:``;t.push({id:`step`,label:`Step`,value:`${e.step.name}${n}`})}if(e.pagePath){let n=e.workspace===`draft`?`, draft configuration`:``;t.push({id:`page`,label:`Page`,value:`${e.pagePath}${n}`})}return t}function _(e){let t=[];if(e.route.length>0){let n=e.route.length===1?`1 step`:`${e.route.length} steps`;t.push({id:`route`,label:`Route`,value:`${n} before this one`})}let n=Object.keys(e.responses).length;if(n>0){let r=n===1?`1 response`:`${n} responses`,i=e.hidden.length>0?`, ${e.hidden.length} hidden`:``;t.push({id:`responses`,label:`Responses`,value:`${r}${i}`})}e.persona&&t.push({id:`persona`,label:`Persona`,value:e.persona.name});let r=Object.entries(e.site);if(r.length>0){let e=r.map(([e,t])=>`${e}: ${h(t)}`).join(`, `);t.push({id:`site`,label:`Site`,value:e})}return t}function v(e){return[...g(e),..._(e)]}function y(e,t){return e.has(t)?new Set([...e].filter(e=>e!==t)):new Set([...e,t])}function b(e,t){return{...e,experience:t.has(`experience`)?null:e.experience,step:t.has(`step`)?null:e.step,pagePath:t.has(`page`)?``:e.pagePath,route:t.has(`route`)?[]:e.route,responses:t.has(`responses`)?{}:e.responses,hidden:t.has(`responses`)?[]:e.hidden,persona:t.has(`persona`)?null:e.persona,site:t.has(`site`)?{}:e.site}}function x(e,t){let n=e.trim(),r=v(t).map(e=>`- **${e.label}:** ${e.value}`);return[...n?[n,``,`---`,``]:[],`### Context`,``,...r.length>0?r:[`- Nothing about the session was included.`],`- **Captured:** ${t.capturedAt}`,``,`**Debug context:**`,``,"```json",JSON.stringify(t,null,2),"```"].join(`
+`)}function S(e){return e.title.trim()===``?`Give the issue a title.`:e.title.length>256?`Keep the title under 256 characters.`:e.description.length>1e4?`Keep the description under ${i.toLocaleString(`en`)} characters.`:null}function C(e,t){return{v:1,title:e.title.trim(),description:e.description.trim(),kind:e.kind,priority:e.priority,labels:[...new Set(e.labels.map(e=>e.trim()).filter(Boolean))],attachments:[...e.attachments],context:t,body:x(e.description,t)}}function w(e,t){return a.includes(e.type)?e.size>3145728?`"${e.name}" is over 3 MB.`:t.reduce((e,t)=>e+t.size,e.size)>3145728?`A report carries at most 3 MB of files.`:null:`"${e.name}" can't go with a report. Attach an image, a PDF, or a text, CSV or JSON file.`}function T(e){if(typeof e!=`object`||!e)return{reference:null,url:null};let{reference:t,identifier:n,id:r,url:i}=Object.fromEntries(Object.entries(e)),a=[t,n,r].find(e=>typeof e==`string`);return{reference:typeof a==`string`&&a!==``?a:null,url:typeof i==`string`&&/^https?:\/\//.test(i)?i:null}}export{a as ATTACHMENT_TYPES,n as HIDDEN_VALUES,e as ISSUE_KINDS,t as ISSUE_PRIORITIES,o as MAX_ATTACHMENT_BYTES,i as MAX_DESCRIPTION_LENGTH,r as MAX_TITLE_LENGTH,w as attachmentProblem,m as buildIssueContext,C as buildIssueReport,v as contextRows,S as draftProblem,p as isJsonValue,f as maskValue,T as readReceipt,x as renderIssueBody,y as toggled,b as withoutRows};

package/dist/plugins/devtools/derive/plain-language/index.d.ts

@@ -1,3 +1,3 @@
 /** @file Public entrypoint for the review tools' vocabulary contract. */
-export { NODE_LABELS, TAB_INTROS, ADVANCED_LABEL, TAB_LABELS, configSourceLabel, deslug, screenName, } from './plain-language';
+export { NODE_LABELS, TAB_INTROS, ADVANCED_LABEL, REPORT_ISSUE_INTRO, REPORT_ISSUE_LABEL, REPORT_ISSUE_TAB, TAB_LABELS, configSourceLabel, deslug, screenName, } from './plain-language';
 export type { ReviewTabId } from './plain-language';

package/dist/plugins/devtools/derive/plain-language/index.js

@@ -1 +1 @@
-export{ADVANCED_LABEL,NODE_LABELS,TAB_INTROS,TAB_LABELS,configSourceLabel,deslug,screenName}from"./plain-language.js";
+export{ADVANCED_LABEL,NODE_LABELS,REPORT_ISSUE_INTRO,REPORT_ISSUE_LABEL,REPORT_ISSUE_TAB,TAB_INTROS,TAB_LABELS,configSourceLabel,deslug,screenName}from"./plain-language.js";

package/dist/plugins/devtools/derive/plain-language/plain-language.d.ts

@@ -61,6 +61,12 @@ export declare const TAB_LABELS: {
 export type ReviewTabId = keyof typeof TAB_LABELS;
 /** The name of the folding sidebar group that holds the SDK's own screens. */
 export declare const ADVANCED_LABEL = "Advanced";
+/** The id of the tab the bug icon at the sidebar's foot opens. */
+export declare const REPORT_ISSUE_TAB = "report-issue";
+/** The Report an issue tab's name. */
+export declare const REPORT_ISSUE_LABEL = "Report an issue";
+/** The Report an issue tab's one-sentence purpose. */
+export declare const REPORT_ISSUE_INTRO = "Tell the team what is wrong or what to change. Where you are in the experience goes with it.";
 /** The one-sentence purpose each tab leads with. Kept together so the tone stays consistent. */
 export declare const TAB_INTROS: {
     readonly guide: 'How to use each tab. Open a tab straight from its section.';

package/dist/plugins/devtools/derive/plain-language/plain-language.js

@@ -1 +1 @@
-var e={origin:`Origin`,step:`Step`,condition:`Condition`,action:`Action`,experience:`Opens another experience`};function t(e){let t=e.replace(/[-_]+/g,` `).trim();return t.length===0?e:t.charAt(0).toUpperCase()+t.slice(1)}function n(e,n){let r=e?.trim();return r!==void 0&&r.length>0?r:n!==void 0&&n.length>0?t(n):`Untitled step`}function r(e){return e!==void 0&&e.length>0?`Viewing unpublished changes`:`Viewing published content`}var i={guide:`How to use`,session:`This session`,answers:`Responses`,journey:`Experiences`,personas:`Personas & Scenarios`,variations:`Feature flags`},a=`Advanced`,o={guide:`How to use each tab. Open a tab straight from its section.`,session:`Where you are right now, and your responses on each step. Start here if something looks wrong.`,answers:`Every field this experience can ask for, and the responses given. Change one to see what the visitor would see.`,journey:`Every experience on this site: the route each can take, with yours marked, and where and when it shows. Go back to any step you have already visited.`,personas:`Visitors and situations to try this experience as. Walk through as one, or jump to a step on its route.`,variations:`The feature flags running on this site. Force a variant to review it, then copy the link to show someone else exactly what you saw.`};export{a as ADVANCED_LABEL,e as NODE_LABELS,o as TAB_INTROS,i as TAB_LABELS,r as configSourceLabel,t as deslug,n as screenName};
+var e={origin:`Origin`,step:`Step`,condition:`Condition`,action:`Action`,experience:`Opens another experience`};function t(e){let t=e.replace(/[-_]+/g,` `).trim();return t.length===0?e:t.charAt(0).toUpperCase()+t.slice(1)}function n(e,n){let r=e?.trim();return r!==void 0&&r.length>0?r:n!==void 0&&n.length>0?t(n):`Untitled step`}function r(e){return e!==void 0&&e.length>0?`Viewing unpublished changes`:`Viewing published content`}var i={guide:`How to use`,session:`This session`,answers:`Responses`,journey:`Experiences`,personas:`Personas & Scenarios`,variations:`Feature flags`},a=`Advanced`,o=`report-issue`,s=`Report an issue`,c=`Tell the team what is wrong or what to change. Where you are in the experience goes with it.`,l={guide:`How to use each tab. Open a tab straight from its section.`,session:`Where you are right now, and your responses on each step. Start here if something looks wrong.`,answers:`Every field this experience can ask for, and the responses given. Change one to see what the visitor would see.`,journey:`Every experience on this site: the route each can take, with yours marked, and where and when it shows. Go back to any step you have already visited.`,personas:`Visitors and situations to try this experience as. Walk through as one, or jump to a step on its route.`,variations:`The feature flags running on this site. Force a variant to review it, then copy the link to show someone else exactly what you saw.`};export{a as ADVANCED_LABEL,e as NODE_LABELS,c as REPORT_ISSUE_INTRO,s as REPORT_ISSUE_LABEL,o as REPORT_ISSUE_TAB,l as TAB_INTROS,i as TAB_LABELS,r as configSourceLabel,t as deslug,n as screenName};

package/dist/plugins/devtools/index.d.ts

@@ -1,8 +1,11 @@
-/** @file Public entrypoint for the Svelte devtools plugin — the plugin factory, session access and consumer-facing types. */
+/** @file Public entrypoint for the Svelte devtools plugin — the plugin factory, session access, the issue sinks and consumer-facing types. */
 export { svelteDevtoolsPlugin } from './plugin';
 export { getDevtoolsSession } from './session-access';
+export { siteEndpoint } from './review/issues/site-endpoint';
+export type { SiteEndpointOptions } from './review/issues/site-endpoint';
 export type * from './plugin';
 export type * from './options';
 export type { CustomTool, CustomToolGuide, CustomToolIcon, CustomToolPlacement, } from './customTools';
 export type { DevtoolsSession } from './session-access';
 export type { PersonaDefinition, PersonaSetup } from './derive/personas';
+export type { IssueAttachment, IssueContext, IssueKind, IssuePriority, IssueReceipt, IssueReport, IssueSink, } from './derive/issue-report';

package/dist/plugins/devtools/index.js

@@ -1 +1 @@
-import{svelteDevtoolsPlugin as e}from"./plugin.js";import{getDevtoolsSession as t}from"./session-access.js";export{t as getDevtoolsSession,e as svelteDevtoolsPlugin};
+import{svelteDevtoolsPlugin as e}from"./plugin.js";import{getDevtoolsSession as t}from"./session-access.js";import{siteEndpoint as n}from"./review/issues/site-endpoint.js";export{t as getDevtoolsSession,n as siteEndpoint,e as svelteDevtoolsPlugin};

package/dist/plugins/devtools/options.d.ts

@@ -1,5 +1,6 @@
 /** @file The devtools plugin's options, and how the devtools panel reads them back off the client. */
-import type { FieldValue, Picked } from '@picked/client';
+import type { FieldValue, JsonValue, Picked } from '@picked/client';
+import { type IssueContext, type IssueReceipt, type IssueReport, type IssueSink } from './derive/issue-report';
 import { type Persona, type PersonaDefinition } from './derive/personas';
 export { DEVTOOLS_EXPERIENCE_KEY } from './constants';
 /** The corner the floating devtools button sits in. */
@@ -69,6 +70,27 @@ export interface DevtoolsGuide {
     sections?: readonly DevtoolsGuideSection[];
     fixes?: readonly DevtoolsGuideFix[];
 }
+/** How Report an issue files reports, and what each one carries. */
+export interface IssueReportingOptions {
+    /** Files a report, such as `siteEndpoint('/api/report-issue')` posting it to the site's server. */
+    sink: IssueSink;
+    /** Labels each report starts with, from its context. The reviewer can drop any of them. */
+    labels?: (context: IssueContext) => readonly string[];
+    /** Facts about the site each report carries, such as a scenario key. */
+    context?: (client: Picked) => Readonly<Record<string, JsonValue>>;
+    /**
+     * Decides each response's value in a report; `undefined` leaves the response out. Without it,
+     * text that reads as an email, a phone number or a date is hidden, and so is anything structured.
+     */
+    redact?: (key: string, value: unknown) => JsonValue | undefined;
+}
+/** The Report an issue options, with every site hook guarded. */
+export interface ResolvedIssueOptions {
+    sink: (report: IssueReport) => Promise<IssueReceipt>;
+    labels: (context: IssueContext) => string[];
+    context: (client: Picked) => Record<string, unknown>;
+    redact: ((key: string, value: unknown) => unknown) | null;
+}
 /** The options read by the devtools panel, as passed to `svelteDevtoolsPlugin`. */
 export interface DevtoolsPanelOptions {
     /**
@@ -104,6 +126,11 @@ export interface DevtoolsPanelOptions {
     personas?: readonly PersonaDefinition[] | (() => Promise<readonly PersonaDefinition[]>);
     /** How loading a persona walks an experience. */
     personaWalk?: PersonaWalkOptions;
+    /**
+     * Where Report an issue sends reports. Without it, the bug icon at the sidebar's foot opens a
+     * page that says how to set reports up.
+     */
+    issues?: IssueReportingOptions;
 }
 /** The devtools options with every default applied. */
 export interface ResolvedDevtoolsOptions {
@@ -126,6 +153,8 @@ export interface ResolvedDevtoolsOptions {
         responses: Readonly<Record<string, FieldValue>>;
         handoffs: Readonly<Record<string, string>>;
     };
+    /** `null` while the site has not set reports up. */
+    issues: ResolvedIssueOptions | null;
 }
 /** Every corner the floating button can sit in. */
 export declare const LAUNCHER_POSITIONS: readonly LauncherPosition[];

package/dist/plugins/devtools/options.js

@@ -1 +1 @@
-import{DEVTOOLS_EXPERIENCE_KEY as e,DEVTOOLS_PLUGIN_NAME as t}from"./constants.js";import{readAnswers as n,sitePersonas as r}from"./derive/personas/personas.js";var i=[`top-left`,`top-right`,`bottom-left`,`bottom-right`];function a(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function o(e){return Array.isArray(e)?e.filter(e=>typeof e==`string`):[]}function s(e){if(!a(e))return{};let t={};for(let[n,r]of Object.entries(e))typeof r==`string`&&(t[n]=r);return t}function c(e){return i.some(t=>t===e)}function l(e){if(!a(e))return null;let{id:t,title:n,steps:r,notes:i}=e;return typeof t!=`string`||typeof n!=`string`||!Array.isArray(r)?null:{id:t,title:n,steps:o(r),notes:o(i)}}function u(e){if(!a(e))return null;let{problem:t,fix:n}=e;return typeof t!=`string`||typeof n!=`string`?null:{problem:t,fix:n}}function d(e){if(!a(e))return null;let{label:t,run:n}=e;return typeof t!=`string`||typeof n!=`function`?null:{label:t,run:e=>{Reflect.apply(n,void 0,[e])}}}function f(e){if(typeof e!=`function`){let t=r(e);return()=>Promise.resolve(t)}let t=null;return()=>(t??=Promise.resolve().then(()=>Reflect.apply(e,void 0,[])).then(e=>r(e)).catch(()=>[]),t)}function p(r){let i=r.getPluginConfig(t).options,p=a(i)?i:{},m=a(p.guide)?p.guide:{},h=a(p.launcher)?p.launcher:{},g=a(p.personaWalk)?p.personaWalk:{},_=p.environmentLabel;return{readOnly:p.readOnly===!0,environmentLabel:typeof _==`string`&&_.length>0?_:void 0,hiddenExperienceKeys:new Set([e,...o(p.hiddenExperienceKeys)]),experiencePrecedence:o(p.experiencePrecedence),codeOwnedFields:new Set(o(p.codeOwnedFields)),responseFollowUp:d(p.responseFollowUp),guide:{sections:(Array.isArray(m.sections)?m.sections:[]).map(l).filter(e=>e!==null),fixes:(Array.isArray(m.fixes)?m.fixes:[]).map(u).filter(e=>e!==null)},launcher:{position:c(h.position)?h.position:`bottom-right`,autoHide:typeof h.autoHide!=`boolean`||h.autoHide},personas:f(p.personas),personaWalk:{selfAdvancingSteps:new Set(o(g.selfAdvancingSteps)),responses:n(g.responses),handoffs:s(g.handoffs)}}}export{e as DEVTOOLS_EXPERIENCE_KEY,i as LAUNCHER_POSITIONS,p as readDevtoolsOptions};
+import{DEVTOOLS_EXPERIENCE_KEY as e,DEVTOOLS_PLUGIN_NAME as t}from"./constants.js";import{readReceipt as n}from"./derive/issue-report/issue-report.js";import{readAnswers as r,sitePersonas as i}from"./derive/personas/personas.js";var a=[`top-left`,`top-right`,`bottom-left`,`bottom-right`];function o(e){return typeof e==`object`&&!!e&&!Array.isArray(e)}function s(e){return Array.isArray(e)?e.filter(e=>typeof e==`string`):[]}function c(e){if(!o(e))return{};let t={};for(let[n,r]of Object.entries(e))typeof r==`string`&&(t[n]=r);return t}function l(e){return a.some(t=>t===e)}function u(e){if(!o(e))return null;let{id:t,title:n,steps:r,notes:i}=e;return typeof t!=`string`||typeof n!=`string`||!Array.isArray(r)?null:{id:t,title:n,steps:s(r),notes:s(i)}}function d(e){if(!o(e))return null;let{problem:t,fix:n}=e;return typeof t!=`string`||typeof n!=`string`?null:{problem:t,fix:n}}function f(e){if(!o(e))return null;let{label:t,run:n}=e;return typeof t!=`string`||typeof n!=`function`?null:{label:t,run:e=>{Reflect.apply(n,void 0,[e])}}}function p(e){if(typeof e!=`function`){let t=i(e);return()=>Promise.resolve(t)}let t=null;return()=>(t??=Promise.resolve().then(()=>Reflect.apply(e,void 0,[])).then(e=>i(e)).catch(()=>[]),t)}function m(e,t){if(typeof e==`function`)try{return Reflect.apply(e,void 0,t)}catch{return}}function h(e){if(!o(e))return null;let{sink:t,labels:r,context:i,redact:a}=e;return typeof t==`function`?{sink:async e=>n(await Reflect.apply(t,void 0,[e])),labels:e=>s(m(r,[e])),context:e=>{let t=m(i,[e]);return o(t)?t:{}},redact:typeof a==`function`?(e,t)=>m(a,[e,t]):null}:null}function g(n){let i=n.getPluginConfig(t).options,a=o(i)?i:{},m=o(a.guide)?a.guide:{},g=o(a.launcher)?a.launcher:{},_=o(a.personaWalk)?a.personaWalk:{},v=a.environmentLabel;return{readOnly:a.readOnly===!0,environmentLabel:typeof v==`string`&&v.length>0?v:void 0,hiddenExperienceKeys:new Set([e,...s(a.hiddenExperienceKeys)]),experiencePrecedence:s(a.experiencePrecedence),codeOwnedFields:new Set(s(a.codeOwnedFields)),responseFollowUp:f(a.responseFollowUp),guide:{sections:(Array.isArray(m.sections)?m.sections:[]).map(u).filter(e=>e!==null),fixes:(Array.isArray(m.fixes)?m.fixes:[]).map(d).filter(e=>e!==null)},launcher:{position:l(g.position)?g.position:`bottom-right`,autoHide:typeof g.autoHide!=`boolean`||g.autoHide},personas:p(a.personas),personaWalk:{selfAdvancingSteps:new Set(s(_.selfAdvancingSteps)),responses:r(_.responses),handoffs:c(_.handoffs)},issues:h(a.issues)}}export{e as DEVTOOLS_EXPERIENCE_KEY,a as LAUNCHER_POSITIONS,g as readDevtoolsOptions};

package/dist/plugins/devtools/review/index.d.ts

@@ -1,6 +1,6 @@
 /**
- * @file The review tabs' panels: How to use, This session, Responses, Flow, Personas & Scenarios
- * and Feature flags.
+ * @file The review tabs' panels: How to use, This session, Responses, Experiences, Personas &
+ * Scenarios, Feature flags, and Report an issue.
  */
 export { default as GuidePanel } from './guide/GuidePanel.svelte';
 export { default as SessionPanel } from './session/SessionPanel.svelte';
@@ -8,3 +8,4 @@ export { default as AnswersPanel } from './answers/AnswersPanel.svelte';
 export { default as JourneyPanel } from './journey/JourneyPanel.svelte';
 export { default as PersonasPanel } from './personas/PersonasPanel.svelte';
 export { default as VariationsPanel } from './variations/VariationsPanel.svelte';
+export { default as ReportIssuePanel } from './issues/ReportIssuePanel.svelte';

package/dist/plugins/devtools/review/index.js

@@ -1 +1 @@
-import e from"./guide/GuidePanel.svelte";import t from"./session/SessionPanel.svelte";import n from"./answers/AnswersPanel.svelte";import r from"./journey/JourneyPanel.svelte";import i from"./personas/PersonasPanel.svelte";import a from"./variations/VariationsPanel.svelte";export{n as AnswersPanel,e as GuidePanel,r as JourneyPanel,i as PersonasPanel,t as SessionPanel,a as VariationsPanel};
+import e from"./guide/GuidePanel.svelte";import t from"./session/SessionPanel.svelte";import n from"./answers/AnswersPanel.svelte";import r from"./journey/JourneyPanel.svelte";import i from"./personas/PersonasPanel.svelte";import a from"./variations/VariationsPanel.svelte";import o from"./issues/ReportIssuePanel.svelte";export{n as AnswersPanel,e as GuidePanel,r as JourneyPanel,i as PersonasPanel,o as ReportIssuePanel,t as SessionPanel,a as VariationsPanel};