feat: collect user feedback

.github/workflows/cdn-publish.yml

@@ -8,9 +8,6 @@ jobs:
     steps:
       - name: Git Checkout
         uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-          ref: master
 
       - name: Setup Node
         uses: actions/setup-node@v3

packages/core/src/client.ts

@@ -22,7 +22,7 @@ import {
   Notice,
   Noticeable,
   HoneybadgerStore,
-  BacktraceFrame, Transport, NoticeTransportPayload
+  BacktraceFrame, Transport, NoticeTransportPayload, UserFeedbackForOptions
 } from './types'
 import { GlobalStore } from './store';
 
@@ -87,6 +87,8 @@ export abstract class Client {
 
   protected abstract checkIn(id: string): Promise<void>
 
+  protected abstract showUserFeedbackForm(options: UserFeedbackForOptions): Promise<void>
+
   getVersion(): string {
     return notifier.version
   }

packages/core/src/types.ts

@@ -187,3 +187,21 @@ export type StoreContents = {
   context: Record<string, unknown>,
   breadcrumbs: BreadcrumbRecord[]
 }
+
+export type UserFeedbackForOptions = {
+  onLoad?: () => void;
+  messages?: {
+    heading?: string;
+    explanation?: string;
+    thanks?: string;
+  }
+  buttons?: {
+    submit?: string;
+    cancel?: string;
+  };
+  labels?: {
+    name?: string;
+    email?: string;
+    comment?: string;
+  };
+}

packages/core/test/helpers.ts

@@ -1,6 +1,6 @@
 import { Client as BaseClient } from '../src/client'
-import { Config, Logger, Notice, Noticeable, Transport, TransportOptions, NoticeTransportPayload } from '../src/types'
-import { runAfterNotifyHandlers } from '../src/util';
+import { Config, Logger, Notice, Noticeable, Transport, TransportOptions, NoticeTransportPayload, UserFeedbackForOptions } from '../src/types'
+import { runAfterNotifyHandlers } from '../src/util'
 
 export function nullLogger(): Logger {
   return {
@@ -27,6 +27,10 @@ export class TestClient extends BaseClient {
     throw new Error('Method not implemented.');
   }
 
+  protected showUserFeedbackForm(_options: UserFeedbackForOptions): Promise<void> {
+    throw new Error('Method not implemented.');
+  }
+
   constructor(opts: Partial<Config>, transport: Transport) {
     super(opts, transport);
   }