feat(js): make check-ins client public (#1456)

Author: subzero10

packages/js/scripts/copy-typedefs.js

@@ -13,7 +13,7 @@ function copyFileSync( source, target ) {
  }
  }
 
- fs.writeFileSync(targetFile, fs.readFileSync(source, 'utf8').replace(/'\.\//g, '\'./types/'));
+ fs.writeFileSync(targetFile, fs.readFileSync(source, 'utf8'));
 }
 
 function copyFolderRecursiveSync( source, target ) {

packages/js/src/server.ts

@@ -186,4 +186,7 @@ singleton.setNotifier(NOTIFIER)
 
 export { Types } from '@honeybadger-io/core'
 
+export { CheckInsClient, CheckIn } from './server/check-ins-manager'
+export { ServerTransport } from './server/transport'
+
 export default singleton

packages/js/src/server/check-ins-manager/index.ts

@@ -1,8 +1,11 @@
 import { Util, Types, Defaults } from '@honeybadger-io/core'
 import { CheckInsClient } from './client'
 import { CheckInsConfig } from './types'
-import { ServerTransport } from '../transport';
-import { CheckIn } from './check-in';
+import { ServerTransport } from '../transport'
+import { CheckIn } from './check-in'
+
+export { CheckInsClient } from './client'
+export { CheckIn } from './check-in'
 
 export class CheckInsManager {
 

packages/js/src/server/check-ins-manager/types.ts

@@ -31,7 +31,7 @@ export type CheckInDto = {
 
  /**
  * The amount of time to allow a job to not report before it's reported as missing.
- * Valid values are the same as the report_report field.
+ * Valid values are the same as the reportPeriod field.
  */
  gracePeriod?: string
 

packages/js/test-d/server.test-d.tsx

@@ -1,4 +1,5 @@
-import Honeybadger from '../dist/server/honeybadger'
+import { Defaults } from '@honeybadger-io/core'
+import Honeybadger, { CheckInsClient, CheckIn, ServerTransport } from '../dist/server/honeybadger'
 
 Honeybadger.configure({
  debug: false,
@@ -40,4 +41,33 @@ const client2 = Honeybadger.factory()
 client2.beforeNotify(() => {
  console.log('Notifying')
 })
-client2.notify('test')
+client2.notify('test');
+
+(async function () {
+ const checkInsClient = new CheckInsClient({
+ apiKey: 'project api key',
+ appEndpoint: Defaults.CONFIG.appEndpoint,
+ personalAuthToken: 'personal auth token',
+ logger: console
+ }, new ServerTransport())
+
+ await checkInsClient.get('project id', 'check-in id')
+
+ await checkInsClient.create('project id', new CheckIn({
+ name: 'a simple check-in',
+ slug: 'simple-check-in',
+ scheduleType: 'simple',
+ reportPeriod: '1 day',
+ gracePeriod: '5 minutes',
+ }))
+
+ await checkInsClient.create('project id', new CheckIn({
+ name: 'a cron check-in',
+ slug: 'cron-check-in',
+ scheduleType: 'cron',
+ cronSchedule: '* * * * 5',
+ cronTimezone: 'UTC',
+ gracePeriod: '5 minutes',
+ }))
+})()
+