feat: check-ins configuration api (#1241)

packages/core/src/types.ts

@@ -124,7 +124,7 @@ export type ProcessStats = {
 }
 
 export type TransportOptions = {
-  method: 'GET' | 'POST',
+  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE',
   headers?: Record<string, number | string | string[] | undefined>,
   endpoint: string,
   maxObjectDepth?: number,
@@ -162,7 +162,8 @@ export type NoticeTransportPayload = {
 }
 
 export interface Transport {
-  send(options: TransportOptions, payload?: NoticeTransportPayload | undefined): Promise<{ statusCode: number; body: string; }>
+  defaultHeaders: () => Record<string, string>
+  send<T>(options: TransportOptions, payload?: T): Promise<{ statusCode: number; body: string; }>
 }
 
 export interface HoneybadgerStore {

packages/core/src/util.ts

@@ -1,5 +1,4 @@
 import * as stackTraceParser from 'stacktrace-parser'
-import { Client } from './client'
 import {
   Logger, BacktraceFrame, Notice, Noticeable, BeforeNotifyHandler, AfterNotifyHandler, Config, BrowserConfig
 } from './types'
@@ -290,7 +289,7 @@ export function sanitize(obj, maxDepth = 8) {
   return safeSerialize(obj)
 }
 
-export function logger(client: Client): Logger {
+export function logger(client: { config: { debug: boolean; logger: Logger; } }): Logger {
   const log = (method: string) => {
     return function (...args: unknown[]) {
       if (method === 'debug') {

packages/core/test/helpers.ts

@@ -1,5 +1,5 @@
 import { Client as BaseClient } from '../src/client'
-import { Config, Logger, Notice, Noticeable, Transport, TransportOptions, NoticeTransportPayload, UserFeedbackFormOptions } from '../src/types'
+import { Config, Logger, Notice, Noticeable, Transport, TransportOptions, UserFeedbackFormOptions } from '../src/types'
 
 export function nullLogger(): Logger {
   return {
@@ -12,7 +12,10 @@ export function nullLogger(): Logger {
 }
 
 export class TestTransport implements Transport {
-  send(_options: TransportOptions, _payload: NoticeTransportPayload): Promise<{ statusCode: number; body: string }> {
+  defaultHeaders(): Record<string, string> {
+    return {};
+  }
+  send<T>(_options: TransportOptions, _payload: T): Promise<{ statusCode: number; body: string }> {
     return Promise.resolve({ body: JSON.stringify({ id: 'uuid' }), statusCode: 201 });
   }
 }

packages/js/examples/checkins-manager/honeybadger.config.js

@@ -0,0 +1,20 @@
+module.exports = {
+  personalAuthToken: process.env.HONEYBADGER_PERSONAL_AUTH_TOKEN,
+  checkins: [
+    {
+      name: 'Weekly Exports',
+      slug: 'weekly-exports-custom-slug',
+      projectId: process.env.HONEYBADGER_PROJECT_ID,
+      scheduleType: 'simple',
+      reportPeriod: '1 week',
+      gracePeriod: '10 minutes'
+    },
+    {
+      name: 'Hourly Notifications',
+      projectId: process.env.HONEYBADGER_PROJECT_ID,
+      scheduleType: 'simple',
+      reportPeriod: '1 hour',
+      gracePeriod: '5 minutes'
+    }
+  ]
+}

packages/js/examples/checkins-manager/index.mjs

@@ -0,0 +1,4 @@
+import Honeybadger from '@honeybadger-io/js'
+
+console.log('Hello from checkins-manager')
+console.log(Honeybadger.config)

packages/js/examples/checkins-manager/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "checkins-manager",
+  "version": "1.0.0",
+  "description": "an example that demonstrates checkins configuration api",
+  "main": "index.mjs",
+  "scripts": {
+    "start": "node index.mjs",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@honeybadger-io/js": "file:../.."
+  },
+  "author": "",
+  "license": "ISC"
+}