@recordreplay/protocol - npm Package Compare versions

Comparing version 0.19.0 to 0.21.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, newMetric, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getEndpointParameters, createPauseParameters, releasePauseParameters, listenForLoadChangesParameters, loadRegionParameters, unloadRegionParameters, getBuildIdParameters } from "../../protocol/Session";
+import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, newMetric, experimentalEvent, 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";
-import { newSource, searchSourceContentsMatches, functionsMatches, findSourcesParameters, getSourceContentsParameters, getSourceMapParameters, getPossibleBreakpointsParameters, searchSourceContentsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters, searchFunctionsParameters } from "../../protocol/Debugger";
+import { newSource, searchSourceContentsMatches, functionsMatches, findSourcesParameters, getSourceContentsParameters, getSourceMapParameters, getPossibleBreakpointsParameters, getHitCountsParameters, searchSourceContentsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters, searchFunctionsParameters } from "../../protocol/Debugger";
 import { newMessage, findMessagesParameters } from "../../protocol/Console";
@@ -158,2 +158,9 @@ import { evaluateInFrameParameters, evaluateInGlobalParameters, getObjectPropertyParameters, callFunctionParameters, callObjectPropertyParameters, getObjectPreviewParameters, getScopeParameters, getTopFrameParameters, getAllFramesParameters, getFrameArgumentsParameters, getFrameStepsParameters, getExceptionValueParameters } from "../../protocol/Pause";
         /**
+         * An event indicating that something happened in a way that is not yet officially
+         * supported in the protocol. This will only be emitted for sessions which
+         * specified experimental settings when they were created.
+         */
+        addExperimentalEventListener: (listener: (parameters: experimentalEvent) => void) => void;
+        removeExperimentalEventListener: () => void | undefined;
+        /**
          * Does not return until the recording is fully processed. Before returning,
@@ -309,2 +316,6 @@ * <code>missingRegions</code> and <code>unprocessedRegions</code> events will
         getPossibleBreakpoints: (parameters: getPossibleBreakpointsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Debugger").getPossibleBreakpointsResult>;
+        /**
+         * Get a HitCount object for each of the given locations in the given sourceId.
+         */
+        getHitCounts: (parameters: getHitCountsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Debugger").getHitCountsResult>;
         searchSourceContents: (parameters: searchSourceContentsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Debugger").searchSourceContentsResult>;
@@ -311,0 +322,0 @@ /**

js/client/build/client.js

@@ -189,2 +189,11 @@ "use strict";
             /**
+             * An event indicating that something happened in a way that is not yet officially
+             * supported in the protocol. This will only be emitted for sessions which
+             * specified experimental settings when they were created.
+             */
+            addExperimentalEventListener: function (listener) {
+                return _this.genericClient.addEventListener("Session.experimentalEvent", listener);
+            },
+            removeExperimentalEventListener: function () { var _a, _b; return (_b = (_a = _this.genericClient).removeEventListener) === null || _b === void 0 ? void 0 : _b.call(_a, "Session.experimentalEvent"); },
+            /**
              * Does not return until the recording is fully processed. Before returning,
@@ -390,2 +399,8 @@ * <code>missingRegions</code> and <code>unprocessedRegions</code> events will
             },
+            /**
+             * Get a HitCount object for each of the given locations in the given sourceId.
+             */
+            getHitCounts: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Debugger.getHitCounts", parameters, sessionId, pauseId);
+            },
             searchSourceContents: function (parameters, sessionId, pauseId) {
@@ -392,0 +407,0 @@ return _this.genericClient.sendCommand("Debugger.searchSourceContents", parameters, sessionId, pauseId);

js/protocol/Debugger.d.ts

@@ -33,2 +33,16 @@ import { TimeStampedPoint, ExecutionPoint } from "./Recording";
 export declare type ContentType = "text/javascript" | "text/html";
+/**
+ * A combination of a location and the number of times that location was hit
+ * during the execution of the currently loaded regions.
+ */
+export interface HitCount {
+    /**
+     * Location of the hits.
+     */
+    location: Location;
+    /**
+     * Number of times this location was hit in loaded regions.
+     */
+    hits: number;
+}
 export interface SearchSourceContentsMatch {
@@ -177,2 +191,24 @@ location: Location;
 }
+export interface getHitCountsParameters {
+    /**
+     * Locations for which to retrieve hit counts. Can be chained with the
+     * return value of `Debugger.getPossibleBreakpoints`.
+     */
+    locations: SameLineSourceLocations[];
+    /**
+     * Source to return breakpoint locations for.
+     */
+    sourceId: string;
+    /**
+     * Max number of hit counts to report for each location. For locations with
+     * many hits, reducing this number will make the command run faster.
+     */
+    maxHits?: number;
+}
+export interface getHitCountsResult {
+    /**
+     * Hit counts for the given locations.
+     */
+    hits: HitCount[];
+}
 export interface searchSourceContentsParameters {
@@ -179,0 +215,0 @@ searchId: string;

js/protocol/index.d.ts

@@ -18,5 +18,5 @@ export * from "./Recording";
 import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
-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 { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, newMetric, experimentalEvent, 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";
-import { newSource, searchSourceContentsMatches, functionsMatches, findSourcesParameters, findSourcesResult, getSourceContentsParameters, getSourceContentsResult, getSourceMapParameters, getSourceMapResult, 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 { newSource, searchSourceContentsMatches, functionsMatches, findSourcesParameters, findSourcesResult, getSourceContentsParameters, getSourceContentsResult, getSourceMapParameters, getSourceMapResult, getPossibleBreakpointsParameters, getPossibleBreakpointsResult, getHitCountsParameters, getHitCountsResult, 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 { newMessage, findMessagesParameters, findMessagesResult } from "./Console";
@@ -110,2 +110,11 @@ import { evaluateInFrameParameters, evaluateInFrameResult, evaluateInGlobalParameters, evaluateInGlobalResult, getObjectPropertyParameters, getObjectPropertyResult, callFunctionParameters, callFunctionResult, callObjectPropertyParameters, callObjectPropertyResult, getObjectPreviewParameters, getObjectPreviewResult, getScopeParameters, getScopeResult, getTopFrameParameters, getTopFrameResult, getAllFramesParameters, getAllFramesResult, getFrameArgumentsParameters, getFrameArgumentsResult, getFrameStepsParameters, getFrameStepsResult, getExceptionValueParameters, getExceptionValueResult } from "./Pause";
     /**
+     * An event indicating that something happened in a way that is not yet officially
+     * supported in the protocol. This will only be emitted for sessions which
+     * specified experimental settings when they were created.
+     */
+    "Session.experimentalEvent": {
+        parameters: experimentalEvent;
+        sessionId: true;
+    };
+    /**
      * Describes some points in the recording at which paints occurred. No paint
@@ -552,2 +561,12 @@ * will occur for the recording's beginning execution point.
     };
+    /**
+     * Get a HitCount object for each of the given locations in the given sourceId.
+     */
+    "Debugger.getHitCounts": {
+        parameters: getHitCountsParameters;
+        result: getHitCountsResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
     "Debugger.searchSourceContents": {
@@ -554,0 +573,0 @@ parameters: searchSourceContentsParameters;

js/protocol/Internal.d.ts

@@ -30,2 +30,7 @@ import { RecordingId, BuildId, TimeStamp } from "./Recording";
     /**
+     * Identifier for the recording. Must be a version 4 UUID. If not specified,
+     * a new ID will be created.
+     */
+    recordingId?: RecordingId;
+    /**
      * The backend will accept all recording data until it gets an
@@ -43,3 +48,4 @@ * `Internal.finishRecording` command or the connection closes. Partial
     /**
-     * Identifier for the recording.
+     * Identifier for the recording. Matches the input `recordingId` if it was
+     * specified.
      */
@@ -46,0 +52,0 @@ recordingId: RecordingId;

js/protocol/Session.d.ts

@@ -171,1 +171,16 @@ import { TimeRange, TimeStampedPointRange, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPoint, ExecutionPoint } from "./Recording";
 }
+/**
+ * An event indicating that something happened in a way that is not yet officially
+ * supported in the protocol. This will only be emitted for sessions which
+ * specified experimental settings when they were created.
+ */
+export interface experimentalEvent {
+    /**
+     * Kind of the event.
+     */
+    kind: string;
+    /**
+     * Any associated data for the event.
+     */
+    data?: any;
+}

package.json

 {
   "name": "@recordreplay/protocol",
-  "version": "0.19.0",
+  "version": "0.21.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

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

463528

increased by1.72%

Lines of code

10980

increased by1.64%

No dependency changes