react-os-shell 0.2.47 → 0.2.48

package/dist/index.d.ts

@@ -351,6 +351,35 @@ declare function NotificationBell({ useUnreadCount, list, markRead, markAllRead,
  * The Provider is mounted once at the App root.
  */
 type ReportType = 'bug' | 'suggestion';
+/** Extra select-style field the consumer can inject into the bug-report
+ *  dialog (e.g. a "module" picker that the consumer's submit callback
+ *  forwards to its API). Rendered above the description textarea so
+ *  reporters confirm or override before submitting. The shell stays
+ *  generic — it knows nothing about what the field actually means. */
+interface BugReportExtraSelectField {
+    /** Stable key — used as the form-field name and as the lookup key
+     *  in the submission payload's `extras` map. */
+    key: string;
+    /** Visible label above the select. */
+    label: string;
+    type: 'select';
+    /** Choices rendered in the dropdown, in order. */
+    options: {
+        value: string;
+        label: string;
+    }[];
+    /** Initial value. Either a literal or a function called with the
+     *  open-dialog context (current URL, the pending report type) so the
+     *  consumer can auto-detect from where the user is when the dialog
+     *  opens. */
+    defaultValue?: string | ((ctx: {
+        url: string;
+        reportType: ReportType;
+    }) => string);
+    /** Optional helper text shown beneath the select. */
+    hint?: string;
+}
+type BugReportExtraField = BugReportExtraSelectField;
 interface BugReportSubmission {
     description: string;
     reportType: ReportType;
@@ -359,6 +388,9 @@ interface BugReportSubmission {
      *  they passed into `openBugReportDialog`. May be null if the original
      *  capture failed and the user submitted without uploading a fallback. */
     screenshot: Blob | null;
+    /** Map of consumer-supplied extra-field values keyed by field.key. Empty
+     *  object when no extras were declared. */
+    extras: Record<string, string>;
 }
 /** Generic bug-report record shape consumed by the shell's list/detail UI. */
 interface BugReport {
@@ -384,11 +416,19 @@ interface BugReportSubmitPayload {
     userAgent: string;
     viewport: string;
     reportType: ReportType;
+    /** Values for any consumer-declared `extraFields` (keyed by field.key).
+     *  Always present; empty object when no extras were declared. */
+    extras: Record<string, string>;
 }
 /** Config bundle for the bug-report subsystem. Consumer-supplied; the shell
  *  never calls a hardcoded URL. */
 interface BugReportConfig {
     submit: (p: BugReportSubmitPayload) => Promise<unknown>;
+    /** Extra fields to render inside the bug-report dialog above the
+     *  description textarea. Keeps the consumer's domain-specific
+     *  metadata (e.g. "which module is this report about?") in the same
+     *  one-step submit flow without forking the shell dialog. */
+    extraFields?: BugReportExtraField[];
     /** Fetcher for the admin Bug Reports list. Receives query-string-shaped
      *  params (e.g. `is_resolved=false`); paginated response. When omitted the
      *  Bug Reports list page is unavailable. */
@@ -730,4 +770,4 @@ declare function useNewHotkey(callback: () => void): void;
  */
 declare function useEditHotkey(callback: (() => void) | null): void;
 
-export { ALT, ALT_SHIFT_D, ALT_SHIFT_E, ALT_SHIFT_N, type BugReport, type BugReportConfig, BugReportConfigProvider, BugReportDetail, BugReportProvider, type BugReportSubmission, type BugReportSubmitPayload, CMD_A, CMD_DOT, CMD_ENTER, CMD_K, CMD_S, CancelButton, type ChangelogEntry, ConfirmProvider, CopyButton, Customization, Desktop, type DesktopHostConfig, DesktopHostProvider, DocFavStar, ENTER, type EntityFetcher, GLASS_DIVIDER, GLASS_INPUT_BG, GlobalSearch, Layout, type LayoutProps, MOD, Modal, ModalActions, NotificationBell, type NotificationsConfig, PopupMenu, PopupMenuDivider, PopupMenuItem, PopupMenuLabel, SHIFT, type SearchConfig, type SearchProvider, type SearchResult, type SemanticGroup, type ShellAuth, ShellAuthProvider, ShellEntityFetcherProvider, type ShellNotification, type ShellPrefsAdapter, ShellPrefsProvider, ShortcutHelp, StartMenu, StatusBadge, StatusBadgeProvider, type StickyEntityRef, type StickyResolver, VERSION, WindowManagerProvider, WindowRegistry, WindowTitle, confirm, confirmDestructive, createWindowRegistry, formatDate, glassStyle, isMac, openBugReportDialog, prompt, reportBug, setShellApiClient, setShellAuthBridge, setShellNavIcons, setWindowDefaultPosition, toast, useBugReport, useClickOutside, useDesktopHost, useEditHotkey, useLocalStoragePrefs, useModalActive, useNewHotkey, useShellAuth, useShellEntityFetcher, useShellPrefs, useWidgetSettings, useWindowManager, useWindowMenuItem, useWindowTitle };
+export { ALT, ALT_SHIFT_D, ALT_SHIFT_E, ALT_SHIFT_N, type BugReport, type BugReportConfig, BugReportConfigProvider, BugReportDetail, type BugReportExtraField, type BugReportExtraSelectField, BugReportProvider, type BugReportSubmission, type BugReportSubmitPayload, CMD_A, CMD_DOT, CMD_ENTER, CMD_K, CMD_S, CancelButton, type ChangelogEntry, ConfirmProvider, CopyButton, Customization, Desktop, type DesktopHostConfig, DesktopHostProvider, DocFavStar, ENTER, type EntityFetcher, GLASS_DIVIDER, GLASS_INPUT_BG, GlobalSearch, Layout, type LayoutProps, MOD, Modal, ModalActions, NotificationBell, type NotificationsConfig, PopupMenu, PopupMenuDivider, PopupMenuItem, PopupMenuLabel, type ReportType, SHIFT, type SearchConfig, type SearchProvider, type SearchResult, type SemanticGroup, type ShellAuth, ShellAuthProvider, ShellEntityFetcherProvider, type ShellNotification, type ShellPrefsAdapter, ShellPrefsProvider, ShortcutHelp, StartMenu, StatusBadge, StatusBadgeProvider, type StickyEntityRef, type StickyResolver, VERSION, WindowManagerProvider, WindowRegistry, WindowTitle, confirm, confirmDestructive, createWindowRegistry, formatDate, glassStyle, isMac, openBugReportDialog, prompt, reportBug, setShellApiClient, setShellAuthBridge, setShellNavIcons, setWindowDefaultPosition, toast, useBugReport, useClickOutside, useDesktopHost, useEditHotkey, useLocalStoragePrefs, useModalActive, useNewHotkey, useShellAuth, useShellEntityFetcher, useShellPrefs, useWidgetSettings, useWindowManager, useWindowMenuItem, useWindowTitle };

package/dist/index.js

@@ -483,18 +483,37 @@ function BugReportProvider({ children }) {
   const [previewUrl, setPreviewUrl] = useState(null);
   const [description, setDescription] = useState("");
   const [reportType, setReportType] = useState("bug");
+  const [extras, setExtras] = useState({});
   const [annotating, setAnnotating] = useState(false);
   const resolveRef = useRef();
+  const config = useContext(BugReportContext);
+  const extraFields = config?.extraFields ?? [];
   const openFn = useCallback((s) => {
     setScreenshot(s);
     setDescription("");
     setReportType("bug");
+    const seeded = {};
+    const ctx = { url: window.location.href, reportType: "bug" };
+    for (const f of extraFields) {
+      if (typeof f.defaultValue === "function") {
+        try {
+          seeded[f.key] = f.defaultValue(ctx) ?? "";
+        } catch {
+          seeded[f.key] = f.options[0]?.value ?? "";
+        }
+      } else if (typeof f.defaultValue === "string") {
+        seeded[f.key] = f.defaultValue;
+      } else {
+        seeded[f.key] = f.options[0]?.value ?? "";
+      }
+    }
+    setExtras(seeded);
     setAnnotating(false);
     setOpen(true);
     return new Promise((resolve) => {
       resolveRef.current = resolve;
     });
-  }, []);
+  }, [extraFields]);
   useEffect(() => {
     globalOpen = openFn;
   }, [openFn]);
@@ -510,7 +529,7 @@ function BugReportProvider({ children }) {
   const handleSubmit = () => {
     setAnnotating(false);
     setOpen(false);
-    resolveRef.current?.({ description: description.trim(), reportType, screenshot });
+    resolveRef.current?.({ description: description.trim(), reportType, screenshot, extras });
   };
   const handleCancel = () => {
     setAnnotating(false);
@@ -572,6 +591,20 @@ function BugReportProvider({ children }) {
               /* @__PURE__ */ jsx("p", { className: "mt-1 text-[11px] text-gray-400", children: "Click Annotate to mark up the screenshot before sending." })
             ] }),
             !previewUrl && /* @__PURE__ */ jsx(UploadDropZone, { onSelect: (blob) => setScreenshot(blob) }),
+            extraFields.length > 0 && /* @__PURE__ */ jsx("div", { className: "mt-4 space-y-3", children: extraFields.map((f) => /* @__PURE__ */ jsxs("div", { children: [
+              /* @__PURE__ */ jsx("label", { htmlFor: `bug-report-extra-${f.key}`, className: "block text-sm font-medium text-gray-700", children: f.label }),
+              /* @__PURE__ */ jsx(
+                "select",
+                {
+                  id: `bug-report-extra-${f.key}`,
+                  value: extras[f.key] ?? "",
+                  onChange: (e) => setExtras((prev) => ({ ...prev, [f.key]: e.target.value })),
+                  className: "mt-1 block w-full rounded-md border border-gray-300 bg-white px-3 py-2 text-sm focus:border-blue-500 focus:ring-1 focus:ring-blue-500 focus:outline-none",
+                  children: f.options.map((o) => /* @__PURE__ */ jsx("option", { value: o.value, children: o.label }, o.value))
+                }
+              ),
+              f.hint && /* @__PURE__ */ jsx("p", { className: "mt-1 text-[11px] text-gray-500", children: f.hint })
+            ] }, f.key)) }),
             /* @__PURE__ */ jsxs("label", { className: "mt-4 block text-sm font-medium text-gray-700", children: [
               isBug ? "What went wrong?" : "What's your suggestion?",
               /* @__PURE__ */ jsx("span", { className: "font-normal text-gray-400 ml-1", children: "(optional)" })
@@ -862,7 +895,7 @@ function StatusBadge({ status }) {
 }
 
 // src/version.ts
-var VERSION = "0.2.47" ;
+var VERSION = "0.2.48" ;
 var APP_VERSION = VERSION;
 
 // src/changelog.ts
@@ -909,7 +942,8 @@ async function reportBug(submit) {
       url: window.location.href,
       userAgent: navigator.userAgent,
       viewport: `${window.innerWidth}x${window.innerHeight}`,
-      reportType: submission.reportType
+      reportType: submission.reportType,
+      extras: submission.extras ?? {}
     });
     toast_default.success(submission.reportType === "bug" ? "Bug sent to admins." : "Suggestion sent to admins.");
   } catch (err) {