@recordreplay/protocol - npm Package Compare versions

Comparing version 0.17.0 to 0.18.0

js/client/build/client.d.ts

 import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording";
 import { tokenParameters, existsParameters, createParameters } from "../../protocol/Resource";
 import { setAccessTokenParameters } from "../../protocol/Authentication";
-import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getEndpointParameters, createPauseParameters, releasePauseParameters, listenForLoadChangesParameters, loadRegionParameters, unloadRegionParameters, getBuildIdParameters } from "../../protocol/Session";
+import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, newMetric, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getEndpointParameters, createPauseParameters, releasePauseParameters, listenForLoadChangesParameters, loadRegionParameters, unloadRegionParameters, getBuildIdParameters } from "../../protocol/Session";
 import { paintPoints, playbackVideoFragment, findPaintsParameters, getPlaybackVideoParameters, getPaintContentsParameters, getDevicePixelRatioParameters } from "../../protocol/Graphics";
@@ -13,3 +13,3 @@ import { newSource, searchSourceContentsMatches, functionsMatches, findSourcesParameters, getSourceContentsParameters, getPossibleBreakpointsParameters, searchSourceContentsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters, searchFunctionsParameters } from "../../protocol/Debugger";
 import { requestBodyData, responseBodyData, requests, getRequestBodyParameters, getResponseBodyParameters, findRequestsParameters } from "../../protocol/Network";
-import { convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, convertFunctionOffsetsToLocationsParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, getStackFunctionIDsParameters, currentGeneratorIdParameters, topFrameLocationParameters, getCurrentNetworkRequestEventParameters, getCurrentNetworkStreamDataParameters } from "../../protocol/Target";
+import { getCapabilitiesParameters, convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, convertFunctionOffsetsToLocationsParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, getStackFunctionIDsParameters, currentGeneratorIdParameters, topFrameLocationParameters, getCurrentNetworkRequestEventParameters, getCurrentNetworkStreamDataParameters, getPossibleBreakpointsForMultipleSourcesParameters } from "../../protocol/Target";
 import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, finishRecordingParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, reportCrashParameters } from "../../protocol/Internal";
@@ -154,2 +154,7 @@ import { GenericProtocolClient } from "../generic";
         /**
+         * Placeholder event for metrics being emitted.
+         */
+        addNewMetricListener: (listener: (parameters: newMetric) => void) => void;
+        removeNewMetricListener: () => void | undefined;
+        /**
          * Does not return until the recording is fully processed. Before returning,
@@ -635,2 +640,6 @@ * <code>missingRegions</code> and <code>unprocessedRegions</code> events will
         /**
+         * Query the target for general information about what capabilities it supports.
+         */
+        getCapabilities: (parameters: getCapabilitiesParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Target").getCapabilitiesResult>;
+        /**
          * Get the function ID / offset to use for a source location, if there is one.
@@ -706,2 +715,9 @@ */
         getCurrentNetworkStreamData: (parameters: getCurrentNetworkStreamDataParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Target").getCurrentNetworkStreamDataResult>;
+        /**
+         * This command is used, when supported by the target runtime, to collect all
+         * possible breakpoints for all sources of a given region in one batch. This is
+         * an optimization over sending one Debugger.getPossibleBreakpoints command for
+         * each source.
+         */
+        getPossibleBreakpointsForMultipleSources: (parameters: getPossibleBreakpointsForMultipleSourcesParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Target").getPossibleBreakpointsForMultipleSourcesResult>;
     };
@@ -708,0 +724,0 @@ /**

js/client/build/client.js

@@ -182,2 +182,9 @@ "use strict";
             /**
+             * Placeholder event for metrics being emitted.
+             */
+            addNewMetricListener: function (listener) {
+                return _this.genericClient.addEventListener("Session.newMetric", listener);
+            },
+            removeNewMetricListener: function () { var _a, _b; return (_b = (_a = _this.genericClient).removeEventListener) === null || _b === void 0 ? void 0 : _b.call(_a, "Session.newMetric"); },
+            /**
              * Does not return until the recording is fully processed. Before returning,
@@ -825,2 +832,8 @@ * <code>missingRegions</code> and <code>unprocessedRegions</code> events will
             /**
+             * Query the target for general information about what capabilities it supports.
+             */
+            getCapabilities: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Target.getCapabilities", parameters, sessionId, pauseId);
+            },
+            /**
              * Get the function ID / offset to use for a source location, if there is one.
@@ -926,2 +939,11 @@ */
             },
+            /**
+             * This command is used, when supported by the target runtime, to collect all
+             * possible breakpoints for all sources of a given region in one batch. This is
+             * an optimization over sending one Debugger.getPossibleBreakpoints command for
+             * each source.
+             */
+            getPossibleBreakpointsForMultipleSources: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Target.getPossibleBreakpointsForMultipleSources", parameters, sessionId, pauseId);
+            },
         };
@@ -928,0 +950,0 @@ /**

js/protocol/index.d.ts

@@ -18,3 +18,3 @@ export * from "./Recording";
 import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
-import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findKeyboardEventsParameters, findKeyboardEventsResult, findNavigationEventsParameters, findNavigationEventsResult, findAnnotationsParameters, findAnnotationsResult, getEndpointParameters, getEndpointResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, listenForLoadChangesParameters, listenForLoadChangesResult, loadRegionParameters, loadRegionResult, unloadRegionParameters, unloadRegionResult, getBuildIdParameters, getBuildIdResult } from "./Session";
+import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, newMetric, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findKeyboardEventsParameters, findKeyboardEventsResult, findNavigationEventsParameters, findNavigationEventsResult, findAnnotationsParameters, findAnnotationsResult, getEndpointParameters, getEndpointResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, listenForLoadChangesParameters, listenForLoadChangesResult, loadRegionParameters, loadRegionResult, unloadRegionParameters, unloadRegionResult, getBuildIdParameters, getBuildIdResult } from "./Session";
 import { paintPoints, playbackVideoFragment, findPaintsParameters, findPaintsResult, getPlaybackVideoParameters, getPlaybackVideoResult, getPaintContentsParameters, getPaintContentsResult, getDevicePixelRatioParameters, getDevicePixelRatioResult } from "./Graphics";
@@ -28,3 +28,3 @@ import { newSource, searchSourceContentsMatches, functionsMatches, findSourcesParameters, findSourcesResult, getSourceContentsParameters, getSourceContentsResult, getPossibleBreakpointsParameters, getPossibleBreakpointsResult, searchSourceContentsParameters, searchSourceContentsResult, getMappedLocationParameters, getMappedLocationResult, setBreakpointParameters, setBreakpointResult, removeBreakpointParameters, removeBreakpointResult, findResumeTargetParameters, findResumeTargetResult, findRewindTargetParameters, findRewindTargetResult, findReverseStepOverTargetParameters, findReverseStepOverTargetResult, findStepOverTargetParameters, findStepOverTargetResult, findStepInTargetParameters, findStepInTargetResult, findStepOutTargetParameters, findStepOutTargetResult, blackboxSourceParameters, blackboxSourceResult, unblackboxSourceParameters, unblackboxSourceResult, searchFunctionsParameters, searchFunctionsResult } from "./Debugger";
 import { requestBodyData, responseBodyData, requests, getRequestBodyParameters, getRequestBodyResult, getResponseBodyParameters, getResponseBodyResult, findRequestsParameters, findRequestsResult } from "./Network";
-import { convertLocationToFunctionOffsetParameters, convertLocationToFunctionOffsetResult, convertFunctionOffsetToLocationParameters, convertFunctionOffsetToLocationResult, convertFunctionOffsetsToLocationsParameters, convertFunctionOffsetsToLocationsResult, getStepOffsetsParameters, getStepOffsetsResult, getHTMLSourceParameters, getHTMLSourceResult, getFunctionsInRangeParameters, getFunctionsInRangeResult, getSourceMapURLParameters, getSourceMapURLResult, getSheetSourceMapURLParameters, getSheetSourceMapURLResult, getCurrentMessageContentsParameters, getCurrentMessageContentsResult, countStackFramesParameters, countStackFramesResult, getStackFunctionIDsParameters, getStackFunctionIDsResult, currentGeneratorIdParameters, currentGeneratorIdResult, topFrameLocationParameters, topFrameLocationResult, getCurrentNetworkRequestEventParameters, getCurrentNetworkRequestEventResult, getCurrentNetworkStreamDataParameters, getCurrentNetworkStreamDataResult } from "./Target";
+import { getCapabilitiesParameters, getCapabilitiesResult, convertLocationToFunctionOffsetParameters, convertLocationToFunctionOffsetResult, convertFunctionOffsetToLocationParameters, convertFunctionOffsetToLocationResult, convertFunctionOffsetsToLocationsParameters, convertFunctionOffsetsToLocationsResult, getStepOffsetsParameters, getStepOffsetsResult, getHTMLSourceParameters, getHTMLSourceResult, getFunctionsInRangeParameters, getFunctionsInRangeResult, getSourceMapURLParameters, getSourceMapURLResult, getSheetSourceMapURLParameters, getSheetSourceMapURLResult, getCurrentMessageContentsParameters, getCurrentMessageContentsResult, countStackFramesParameters, countStackFramesResult, getStackFunctionIDsParameters, getStackFunctionIDsResult, currentGeneratorIdParameters, currentGeneratorIdResult, topFrameLocationParameters, topFrameLocationResult, getCurrentNetworkRequestEventParameters, getCurrentNetworkRequestEventResult, getCurrentNetworkStreamDataParameters, getCurrentNetworkStreamDataResult, getPossibleBreakpointsForMultipleSourcesParameters, getPossibleBreakpointsForMultipleSourcesResult } from "./Target";
 import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, finishRecordingParameters, finishRecordingResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, reportCrashParameters, reportCrashResult } from "./Internal";
@@ -104,2 +104,9 @@ interface Events {
     /**
+     * Placeholder event for metrics being emitted.
+     */
+    "Session.newMetric": {
+        parameters: newMetric;
+        sessionId: true;
+    };
+    /**
      * Describes some points in the recording at which paints occurred. No paint
@@ -1063,2 +1070,12 @@ * will occur for the recording's beginning execution point.
     /**
+     * Query the target for general information about what capabilities it supports.
+     */
+    "Target.getCapabilities": {
+        parameters: getCapabilitiesParameters;
+        result: getCapabilitiesResult;
+        sessionId: false;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Get the function ID / offset to use for a source location, if there is one.
@@ -1225,2 +1242,15 @@ */
     /**
+     * This command is used, when supported by the target runtime, to collect all
+     * possible breakpoints for all sources of a given region in one batch. This is
+     * an optimization over sending one Debugger.getPossibleBreakpoints command for
+     * each source.
+     */
+    "Target.getPossibleBreakpointsForMultipleSources": {
+        parameters: getPossibleBreakpointsForMultipleSourcesParameters;
+        result: getPossibleBreakpointsForMultipleSourcesResult;
+        sessionId: false;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Create a new recording.
@@ -1227,0 +1257,0 @@ */

js/protocol/Pause.d.ts

@@ -375,2 +375,9 @@ import { MappedLocation, PointDescription } from "./Debugger";
     /**
+     * Execute the expression without side-effects. Usage of this parameter
+     * will result in an error response if the target has not opted in to the
+     * 'pureEval' capability. If a target has not opted in, it may assume
+     * that this parameter will always be false.
+     */
+    pure?: boolean;
+    /**
      * Whether to perform the evaluation in the context of the original
@@ -392,2 +399,9 @@ * scope chain for the frame.
     expression: string;
+    /**
+     * Execute the expression without side-effects. Usage of this parameter
+     * will result in an error response if the target has not opted in to the
+     * 'pureEval' capability. If a target has not opted in, it may assume
+     * that this parameter will always be false.
+     */
+    pure?: boolean;
 }
@@ -394,0 +408,0 @@ export interface evaluateInGlobalResult {

js/protocol/Session.d.ts

@@ -165,1 +165,7 @@ import { TimeRange, TimeStampedPointRange, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPoint, ExecutionPoint } from "./Recording";
 }
+/**
+ * Placeholder event for metrics being emitted.
+ */
+export interface newMetric {
+    data: any;
+}

js/protocol/Target.d.ts

@@ -1,2 +0,2 @@
-import { Location, SourceId, SourceLocation } from "./Debugger";
+import { SameLineSourceLocations, Location, SourceId, SourceLocation } from "./Debugger";
 import { ObjectId, Value } from "./Pause";
@@ -6,2 +6,12 @@ import { MessageSource, MessageLevel } from "./Console";
 /**
+ * The various capabilities supported by a target.
+ */
+export interface Capabilities {
+    /**
+     * True if the target supports the 'pure' parameter. If this is not set,
+     * attempts at pure evaluation will not pass the command to the target.
+     */
+    pureEval?: boolean;
+}
+/**
  * Represents the data pieces returned from a network stream. Always "data" for now
@@ -20,2 +30,11 @@ * but we'll likely add more in the future to support Websockets.
 }
+export interface PossibleBreakpointsForSource {
+    sourceId: SourceId;
+    lineLocations: SameLineSourceLocations[];
+}
+export interface getCapabilitiesParameters {
+}
+export interface getCapabilitiesResult {
+    capabilities: Capabilities;
+}
 export interface convertLocationToFunctionOffsetParameters {
@@ -143,1 +162,7 @@ location: Location;
 }
+export interface getPossibleBreakpointsForMultipleSourcesParameters {
+    sourceIds: SourceId[];
+}
+export interface getPossibleBreakpointsForMultipleSourcesResult {
+    possibleBreakpoints: PossibleBreakpointsForSource[];
+}

package.json

 {
   "name": "@recordreplay/protocol",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "description": "Definition of the protocol used by the Record Replay web service",
@@ -5,0 +5,0 @@ "author": "",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

453795

increased by2.1%

Lines of code

10752

increased by1.88%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes