@ganeshdole/brainbox-core 0.1.0 → 0.3.0

package/dist/brainbox.d.ts

@@ -1,4 +1,4 @@
-import type { Identity } from "@ganeshdole/brainbox-shared";
+import type { Identity, ReportField } from "@ganeshdole/brainbox-shared";
 import { type Draft, type DraftOptions } from "./draft.ts";
 import type { SubmitResult, Transport } from "./transport.ts";
 export interface BrainboxOptions {
@@ -6,6 +6,9 @@ export interface BrainboxOptions {
     transport: Transport;
     /** Who is filing. Can be set later with `identify()`. */
     identity?: Identity;
+    /** Your app's own details for every report (clinic, plan, ...). Can be set
+     *  later with `setFields()`. */
+    fields?: ReportField[];
     /** Called after every successful submit. */
     onSubmitted?: (result: SubmitResult) => void;
 }
@@ -13,7 +16,9 @@ export interface BrainboxOptions {
  *  created and hands out drafts; `destroy()` undoes all of it. */
 export interface Brainbox {
     identify(identity: Identity): void;
+    /** Replaces the details sent with every report from now on. */
+    setFields(fields: ReportField[]): void;
     draft(options?: DraftOptions): Draft;
     destroy(): void;
 }
-export declare function createBrainbox({ transport, identity, onSubmitted }: BrainboxOptions): Brainbox;
+export declare function createBrainbox({ transport, identity, fields, onSubmitted }: BrainboxOptions): Brainbox;

package/dist/brainbox.js

@@ -1,17 +1,22 @@
 import { createDraft } from "./draft.js";
 import { captureErrors } from "./metadata.js";
-export function createBrainbox({ transport, identity, onSubmitted }) {
+export function createBrainbox({ transport, identity, fields, onSubmitted }) {
     let who = identity;
+    let details = fields;
     const errors = captureErrors();
     const drafts = new Set();
     return {
         identify(next) {
             who = next;
         },
+        setFields(next) {
+            details = next;
+        },
         draft(options) {
             const draft = createDraft({
                 transport,
                 identity: () => who,
+                fields: () => details,
                 consoleErrors: () => errors.snapshot(),
                 onSubmitted,
             }, options);

package/dist/draft.d.ts

@@ -1,4 +1,4 @@
-import type { Identity } from "@ganeshdole/brainbox-shared";
+import type { Identity, ReportField } from "@ganeshdole/brainbox-shared";
 import { type Annotations } from "./annotate.ts";
 import { type Mark } from "./marks.ts";
 import type { SubmitResult, Transport } from "./transport.ts";
@@ -68,6 +68,7 @@ export interface Draft {
 export interface DraftContext {
     transport: Transport;
     identity(): Identity | undefined;
+    fields(): ReportField[] | undefined;
     consoleErrors(): string[];
     onSubmitted?: (result: SubmitResult) => void;
 }

package/dist/draft.js

@@ -161,6 +161,7 @@ export function createDraft(ctx, { exclude } = {}) {
                 metadata: captureMetadata({
                     consoleErrors: ctx.consoleErrors(),
                     identity: ctx.identity(),
+                    fields: ctx.fields(),
                     selector: region?.selector,
                 }),
                 screenshot: screenshot ?? undefined,

package/dist/index.d.ts

@@ -6,4 +6,4 @@ export { canSessionRecord } from "./session.ts";
 export { preloadCapture } from "./lazy.ts";
 export { startAudioRecording, type AudioRecorder } from "./audio.ts";
 export * from "./marks.ts";
-export type { CapturedMetadata, Identity, ProjectKey, Region } from "@ganeshdole/brainbox-shared";
+export type { CapturedMetadata, Identity, ProjectKey, Region, ReportField, ReportFieldType, } from "@ganeshdole/brainbox-shared";

package/dist/metadata.d.ts

@@ -1,4 +1,4 @@
-import type { CapturedMetadata, Identity } from "@ganeshdole/brainbox-shared";
+import type { CapturedMetadata, Identity, ReportField } from "@ganeshdole/brainbox-shared";
 /** A rolling buffer of the host page's recent console errors and uncaught
  *  exceptions, owned by one `createBrainbox()` instance. */
 export interface ErrorLog {
@@ -10,8 +10,9 @@ export interface ErrorLog {
 /** Start collecting console errors into a new buffer. */
 export declare function captureErrors(max?: number): ErrorLog;
 /** Snapshot of the host page at submit time. */
-export declare function captureMetadata({ consoleErrors, identity, selector, }: {
+export declare function captureMetadata({ consoleErrors, identity, fields, selector, }: {
     consoleErrors: string[];
     identity?: Identity;
+    fields?: ReportField[];
     selector?: string;
 }): CapturedMetadata;

package/dist/metadata.js

@@ -50,7 +50,7 @@ export function captureErrors(max = MAX_ERRORS) {
     };
 }
 /** Snapshot of the host page at submit time. */
-export function captureMetadata({ consoleErrors, identity, selector, }) {
+export function captureMetadata({ consoleErrors, identity, fields, selector, }) {
     return {
         url: location.href,
         title: document.title,
@@ -62,6 +62,8 @@ export function captureMetadata({ consoleErrors, identity, selector, }) {
         selector,
         consoleErrors,
         identity,
+        // An empty list says nothing; leave it out like an unset one.
+        ...(fields?.length && { fields }),
     };
 }
 function stringify(v) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ganeshdole/brainbox-core",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "The Brainbox capture engine: screenshots, marks, session recording, console errors and a Transport that sends the report. No React, no UI.",
   "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://www.brainbox.sh",
@@ -29,7 +29,7 @@
   "dependencies": {
     "modern-screenshot": "^4.6.0",
     "rrweb": "^2.1.0",
-    "@ganeshdole/brainbox-shared": "0.1.0"
+    "@ganeshdole/brainbox-shared": "0.3.0"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",