debugbear - npm Package Compare versions

Comparing version 2.0.13 to 2.0.14

DebugBear.ts

@@ -101,2 +101,3 @@ import { callApi } from "./callApi";
   everyNHours: number;
+  url: string;
 }
@@ -149,2 +150,17 @@
   }
+
+  async getPageMetrics(
+    projectId: string,
+    { before }: { before?: Date } = {}
+  ): Promise<{ page: PageObject; metrics: any }[]> {
+    return callApi({
+      method: "get",
+      path:
+        "/projects/" +
+        projectId +
+        "/pageMetrics" +
+        (before ? "?before=" + before.toISOString() : ""),
+      explicitApiKeyParam: this.apiKey,
+    });
+  }
 }
@@ -151,0 +167,0 @@

dist/callApi.js

 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
@@ -38,2 +39,3 @@ });
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.callApi = void 0;
 var request = require("request-promise");
@@ -40,0 +42,0 @@ function getApiBaseUrl() {

dist/DebugBear.d.ts

@@ -40,2 +40,3 @@ import { AnalysisResultObject } from "./ResponseTypes";
     everyNHours: number;
+    url: string;
 }
@@ -52,2 +53,8 @@ declare type ServerRegion = "us-east" | "us-west" | "uk" | "australia" | "japan" | "germany" | "brazil" | "finland";
     delete(projectId: string): Promise<any>;
+    getPageMetrics(projectId: string, { before }?: {
+        before?: Date;
+    }): Promise<{
+        page: PageObject;
+        metrics: any;
+    }[]>;
 }
@@ -54,0 +61,0 @@ declare class CollaboratorsApiClient {

dist/DebugBear.js

@@ -27,6 +27,7 @@ "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
@@ -63,2 +64,3 @@ });
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebugBear = void 0;
 var callApi_1 = require("./callApi");
@@ -87,3 +89,3 @@ var inferBuildInfo_1 = require("./inferBuildInfo");
     ApiClientObject.prototype.toJSON = function () {
-        return __assign({}, this, { _apiClient: undefined });
+        return __assign(__assign({}, this), { _apiClient: undefined });
     };
@@ -204,2 +206,17 @@ return ApiClientObject;
     };
+    ProjectsApiClient.prototype.getPageMetrics = function (projectId, _a) {
+        var before = (_a === void 0 ? {} : _a).before;
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_b) {
+                return [2 /*return*/, callApi_1.callApi({
+                        method: "get",
+                        path: "/projects/" +
+                            projectId +
+                            "/pageMetrics" +
+                            (before ? "?before=" + before.toISOString() : ""),
+                        explicitApiKeyParam: this.apiKey,
+                    })];
+            });
+        });
+    };
     return ProjectsApiClient;
@@ -273,3 +290,3 @@ }(ApiClientObject));
                         _b = _c.sent(), analysis = _b.analysis, resultUrl = _b.resultUrl;
-                        return [2 /*return*/, __assign({ url: resultUrl }, analysis, { __id: analysis.id, waitForResult: function () { return __awaiter(_this, void 0, void 0, function () {
+                        return [2 /*return*/, __assign(__assign({ url: resultUrl }, analysis), { __id: analysis.id, waitForResult: function () { return __awaiter(_this, void 0, void 0, function () {
                                     return __generator(this, function (_a) {
@@ -276,0 +293,0 @@ return [2 /*return*/, waitForAnalysisResult(analysis.id, this.apiKey)];

dist/getNgrokTunnelPublicUrl.js

 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
@@ -38,2 +39,3 @@ });
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.getNgrokTunnelPublicUrl = void 0;
 var request = require("request-promise");
@@ -40,0 +42,0 @@ function getNgrokTunnelPublicUrl(ngrokAdminPort) {

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.__runCli = exports.DebugBear = exports.analyzePage = void 0;
 var runCli_1 = require("./runCli");
-exports.__runCli = runCli_1.__runCli;
+Object.defineProperty(exports, "__runCli", { enumerable: true, get: function () { return runCli_1.__runCli; } });
 var DebugBear_1 = require("./DebugBear");
-exports.DebugBear = DebugBear_1.DebugBear;
+Object.defineProperty(exports, "DebugBear", { enumerable: true, get: function () { return DebugBear_1.DebugBear; } });
 function analyzePage() {
@@ -8,0 +9,0 @@ throw Error("analyzePage was removed in version 2 of the DebugBear API. Install version 0.1.12 or upgrade to v2: https://www.debugbear.com/docs/migrating-to-the-v2-api");

dist/inferBuildInfo.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.inferBuildInfo = void 0;
 var envCi = require("env-ci");
@@ -4,0 +5,0 @@ var child_process_1 = require("child_process");

dist/runCli.js

 "use strict";
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
         function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
         function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
         step((generator = generator.apply(thisArg, _arguments || [])).next());
@@ -38,2 +39,3 @@ });
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.__runCli = void 0;
 var commander = require("commander");
@@ -40,0 +42,0 @@ var lodash_1 = require("lodash");

package.json

 {
   "name": "debugbear",
-  "version": "2.0.13",
-  "description": "API/CLI for DebugBearAnalyze pages with DebugBear. Analyze pages on demand on demand or as part of your Continuous Integration process.",
+  "version": "2.0.14",
+  "description": "Use DebugBear to test web performance as part of your Continuous Integration process.",
   "main": "dist/index.js",
@@ -13,3 +13,2 @@ "scripts": {
   "dependencies": {
-    "@types/node": "^10.12.21",
     "commander": "^2.19.0",
@@ -23,3 +22,4 @@ "env-ci": "^5.0.2",
   "devDependencies": {
-    "typescript": "^3.2.4"
+    "@types/node": "^10.17.28",
+    "typescript": "^3.9.7"
   },
@@ -26,0 +26,0 @@ "bin": {

README.md

@@ -1,5 +0,10 @@
-# DebugBear CLI
+# DebugBear API + CLI
 
-This CLI allows you analyze pages you've set up on [DebugBear](https://www.debugbear.com), for example as part of your Continuous Integration process.
+Web performance monitoring with [DebugBear](https://www.debugbear.com).
 
+This API allows you to:
+- trigger tests as part of your Continuous Integration setup
+- access page metrics for your monitored pages
+- automatically create new DebugBear projects and add monitored pages
+
 ## Learn more
@@ -10,1 +15,2 @@
 - [CLI docs](https://www.debugbear.com/docs/cli)
+- [API docs](https://www.debugbear.com/docs/cli)

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

66926

increased by3.19%

Dependency count

6

decreased by-14.29%

Lines of code

1863

increased by2.59%

Number of lines in readme file

16

increased by60%

Worsened metrics

Dev dependency count

2

increased by100%

Number of low supply chain risk alerts

11

increased by57.14%

Dependency changes

• - Removed@types/node@^10.12.21

• - Removed@types/node@10.17.60(transitive)