@honeybadger-io/js 3.2.7 → 4.0.0-beta.0

package/dist/server/types/core/client.d.ts

@@ -11,6 +11,14 @@ export default class Client {
     setContext(context: Record<string, unknown>): Client;
     resetContext(context?: Record<string, unknown>): Client;
     clear(): Client;
-    notify(notice: Noticeable, name?: string | Partial<Notice>, extra?: Partial<Notice>): Record<string, unknown> | false | unknown;
+    notify(noticeable: Noticeable, name?: string | Partial<Notice>, extra?: Partial<Notice>): boolean;
+    /**
+     * An async version of {@link notify} that resolves only after the notice has been reported to Honeybadger.
+     * Implemented using the {@link afterNotify} hook.
+     * Rejects if for any reason the report failed to be reported.
+     * Useful in serverless environments (AWS Lambda).
+     */
+    notifyAsync(noticeable: Noticeable, name?: string | Partial<Notice>, extra?: Partial<Notice>): Promise<void>;
+    protected makeNotice(noticeable: Noticeable, name?: string | Partial<Notice>, extra?: Partial<Notice>): Notice | null;
     addBreadcrumb(message: string, opts?: Record<string, unknown>): Client;
 }

package/dist/server/types/core/error.d.ts

@@ -0,0 +1,3 @@
+export default class NotifyError extends Error {
+    constructor(message: any);
+}

package/dist/server/types/core/types.d.ts

@@ -16,7 +16,6 @@ export interface Config {
     component?: string;
     action?: string;
     revision?: string;
-    disabled: boolean;
     debug: boolean;
     reportData: boolean;
     breadcrumbsEnabled: boolean | {
@@ -33,13 +32,13 @@ export interface Config {
     enableUnhandledRejection: boolean;
     filters: string[];
     __plugins: Plugin[];
-    tags: any;
+    tags: unknown;
 }
 export interface BeforeNotifyHandler {
-    (notice: Notice): boolean | void;
+    (notice?: Notice): boolean | void;
 }
 export interface AfterNotifyHandler {
-    (error: any, notice: Notice): boolean | void;
+    (error: any, notice?: Notice): boolean | void;
 }
 export interface Plugin {
     load(client: Client): void;
@@ -67,6 +66,7 @@ export interface Notice {
     details: Record<string, Record<string, unknown>>;
     __breadcrumbs: BreadcrumbRecord[];
     afterNotify?: AfterNotifyHandler;
+    [key: string]: unknown;
 }
 export declare type Noticeable = string | Error | Partial<Notice>;
 export interface BacktraceFrame {
@@ -74,6 +74,7 @@ export interface BacktraceFrame {
     method: string;
     number: number;
     column: number;
+    source?: Record<string, string>;
 }
 export interface BreadcrumbRecord {
     category: string;

package/dist/server/types/core/util.d.ts

@@ -5,8 +5,9 @@ export declare function mergeNotice(notice1: Partial<Notice>, notice2: Partial<N
 export declare function objectIsEmpty(obj: any): boolean;
 export declare function objectIsExtensible(obj: any): boolean;
 export declare function makeBacktrace(stack: string, shift?: number): BacktraceFrame[];
-export declare function runBeforeNotifyHandlers(notice: any, handlers: BeforeNotifyHandler[]): boolean;
-export declare function runAfterNotifyHandlers(notice: any, handlers: AfterNotifyHandler[], error?: any): boolean;
+export declare function getSourceForBacktrace(backtrace: BacktraceFrame[], getSourceFileHandler: (path: string, cb: (fileContent: string) => void) => void, cb: (sourcePerTrace: Record<string, string>[]) => void): void;
+export declare function runBeforeNotifyHandlers(notice: Notice | null, handlers: BeforeNotifyHandler[]): boolean;
+export declare function runAfterNotifyHandlers(notice: Notice | null, handlers: AfterNotifyHandler[], error?: Error): boolean;
 export declare function newObject<T>(obj: T): T | Record<string, unknown>;
 export declare function sanitize(obj: any, maxDepth?: number): any;
 export declare function logger(client: Client): Logger;
@@ -27,3 +28,4 @@ export declare function generateStackTrace(): string;
 export declare function filter(obj: Record<string, unknown>, filters: string[]): Record<string, unknown>;
 export declare function filterUrl(url: string, filters: string[]): string;
 export declare function formatCGIData(vars: Record<string, unknown>, prefix?: string): Record<string, unknown>;
+export declare function clone<T>(obj: T): T;

package/dist/server/types/server/aws_lambda.d.ts

@@ -0,0 +1,9 @@
+import { Handler, Callback, Context } from 'aws-lambda';
+export declare type SyncHandler<TEvent = any, TResult = any> = (event: TEvent, context: Context, callback: Callback<TResult>) => void;
+export declare type AsyncHandler<TEvent = any, TResult = any> = (event: TEvent, context: Context) => Promise<TResult>;
+export declare function lambdaHandler<TEvent = any, TResult = any>(handler: Handler<TEvent, TResult>): Handler<TEvent, TResult>;
+/**
+ * Removes AWS Lambda default listener that
+ * exits the process before letting us report to honeybadger.
+ */
+export declare function removeAwsDefaultUncaughtExceptionListener(): void;

package/dist/server/types/server/middleware.d.ts

@@ -1,6 +1,4 @@
 import { NextFunction, Request, Response } from 'express';
-declare function requestHandler(req: Request, res: Response, next: NextFunction): void;
-declare function errorHandler(err: any, req: Request, _res: Response, next: NextFunction): unknown;
-declare type LambdaHandler = (event: unknown, context: unknown, callback: unknown) => void | Promise<unknown>;
-declare function lambdaHandler(handler: LambdaHandler): LambdaHandler;
-export { errorHandler, requestHandler, lambdaHandler };
+import { Noticeable } from '../core/types';
+export declare function requestHandler(req: Request, res: Response, next: NextFunction): void;
+export declare function errorHandler(err: Noticeable, req: Request, _res: Response, next: NextFunction): unknown;

package/dist/server/types/server/util.d.ts

@@ -1,2 +1,9 @@
 export declare function fatallyLogAndExit(err: Error): never;
 export declare function getStats(cb: (stats: Record<string, unknown>) => void): void;
+/**
+ * Get source file if possible, used to build `notice.backtrace.source`
+ *
+ * @param path to source code
+ * @param cb callback with fileContent
+ */
+export declare function getSourceFile(path: string, cb: (fileContent: string) => void): void;

package/dist/server/types/server.d.ts

@@ -1,6 +1,7 @@
 import Client from './core/client';
 import { Config } from './core/types';
-import { errorHandler, requestHandler, lambdaHandler } from './server/middleware';
+import { errorHandler, requestHandler } from './server/middleware';
+import { lambdaHandler } from './server/aws_lambda';
 declare class Honeybadger extends Client {
     errorHandler: typeof errorHandler;
     requestHandler: typeof requestHandler;

package/honeybadger.d.ts

@@ -1,3 +1,4 @@
+/* eslint-disable import/no-unresolved */
 // Type definitions for honeybadger.js
 // Project: https://github.com/honeybadger-io/honeybadger-js
 import Server from './dist/server/types/server'
@@ -5,4 +6,4 @@ import Browser from './dist/browser/types/browser'
 
 type Honeybadger = typeof Server & typeof Browser;
 declare const Honeybadger: Honeybadger;
-export = Honeybadger;
+export = Honeybadger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@honeybadger-io/js",
-  "version": "3.2.7",
+  "version": "4.0.0-beta.0",
   "license": "MIT",
   "homepage": "https://github.com/honeybadger-io/honeybadger-js",
   "author": {
@@ -37,38 +37,40 @@
     "test:integration:browserstack": "npm run test:integration",
     "test:integration:headless": "HEADLESS=1 npm run test:integration",
     "tsd": "npm run build && tsd",
+    "lint": "npx eslint .",
     "build": "rollup -c && node ./scripts/copy-typedefs.js",
     "release": "shipjs prepare"
   },
   "dependencies": {
-    "@types/express": "^4.17.13",
     "stacktrace-parser": "^0.1.10"
   },
   "devDependencies": {
-    "@rollup/plugin-node-resolve": "^13.0.4",
+    "@rollup/plugin-node-resolve": "^13.0.6",
     "@rollup/plugin-replace": "^3.0.0",
-    "@rollup/plugin-typescript": "^8.2.5",
-    "@types/jest": "^27.0.2",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "axios": ">=0.21.4",
-    "concurrently": "^6.2.1",
-    "eslint": "^8.0.0",
-    "eslint-plugin-import": "^2.24.1",
-    "eslint-plugin-jest": "^25.0.1",
-    "eslint-plugin-promise": "^5.1.0",
+    "@rollup/plugin-typescript": "^8.3.0",
+    "@types/aws-lambda": "^8.10.89",
+    "@types/express": "^4.17.13",
+    "@types/jest": "^27.0.3",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.6.0",
+    "axios": ">=0.24.0",
+    "concurrently": "^7.0.0",
+    "eslint": "^8.4.1",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-jest": "^26.0.0",
+    "eslint-plugin-promise": "^6.0.0",
     "express": "^4.17.1",
-    "jest": "^27.0.6",
-    "nock": "^13.1.2",
-    "rollup": "^2.56.2",
+    "jest": "^27.4.4",
+    "nock": "^13.2.1",
+    "rollup": "^2.61.1",
     "rollup-plugin-uglify": "^6.0.2",
-    "shipjs": "0.24.0",
-    "sinon": "^11.1.2",
+    "shipjs": "0.24.2",
+    "sinon": "^13.0.1",
     "supertest": "^6.1.6",
-    "ts-jest": "^27.0.5",
-    "tsd": "^0.18.0",
+    "ts-jest": "^27.1.1",
+    "tsd": "^0.19.0",
     "tslib": "^2.3.1",
-    "typescript": "^4.3.5"
+    "typescript": "^4.5.3"
   },
   "readmeFilename": "README.md",
   "files": [