@recordreplay/protocol - npm Package Compare versions

Comparing version 0.9.0 to 0.10.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, annotations, loadedRegions, ensureProcessedParameters, findMouseEventsParameters, findAnnotationsParameters, getEndpointParameters, createPauseParameters, releasePauseParameters, listenForLoadChangesParameters, loadRegionParameters, unloadRegionParameters, getBuildIdParameters } from "../../protocol/Session";
+import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, annotations, loadedRegions, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findAnnotationsParameters, getEndpointParameters, createPauseParameters, releasePauseParameters, listenForLoadChangesParameters, loadRegionParameters, unloadRegionParameters, getBuildIdParameters } from "../../protocol/Session";
 import { paintPoints, playbackVideoFragment, findPaintsParameters, getPlaybackVideoParameters, getPaintContentsParameters, getDevicePixelRatioParameters } from "../../protocol/Graphics";
@@ -11,3 +11,3 @@ import { newSource, findSourcesParameters, getSourceContentsParameters, getPossibleBreakpointsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters } from "../../protocol/Debugger";
 import { getComputedStyleParameters, getAppliedRulesParameters } from "../../protocol/CSS";
-import { analysisResult, analysisError, analysisPoints, createAnalysisParameters, addLocationParameters, addFunctionEntryPointsParameters, addRandomPointsParameters, addEventHandlerEntryPointsParameters, addExceptionPointsParameters, runAnalysisParameters, releaseAnalysisParameters, findAnalysisPointsParameters } from "../../protocol/Analysis";
+import { analysisResult, analysisError, analysisPoints, createAnalysisParameters, addLocationParameters, addFunctionEntryPointsParameters, addRandomPointsParameters, addEventHandlerEntryPointsParameters, addExceptionPointsParameters, addPointsParameters, runAnalysisParameters, releaseAnalysisParameters, findAnalysisPointsParameters } from "../../protocol/Analysis";
 import { convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, getStackFunctionIDsParameters, currentGeneratorIdParameters, topFrameLocationParameters } from "../../protocol/Target";
@@ -133,2 +133,7 @@ import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, labelTestSessionParameters, reportCrashParameters } from "../../protocol/Internal";
         /**
+         * Describes some keyboard events that occur in the recording.
+         */
+        addKeyboardEventsListener: (listener: (parameters: keyboardEvents) => void) => void;
+        removeKeyboardEventsListener: () => void | undefined;
+        /**
          * Describes some annotations in the recording.
@@ -166,2 +171,9 @@ */
         /**
+         * Find all points in the recording at which a keyboard event occurred.
+         * Does not return until the recording is fully processed. Before returning,
+         * <code>keyboardEvents</code> events will be periodically emitted. The union
+         * of all these events describes all keyboard events in the recording.
+         */
+        findKeyboardEvents: (parameters: findKeyboardEventsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").findKeyboardEventsResult>;
+        /**
          * Find all points in the recording at which an annotation was added via the
@@ -530,2 +542,6 @@ * RecordReplayOnAnnotation driver API. Does not return until the recording
         /**
+         * Apply the analysis to a specific set of points.
+         */
+        addPoints: (parameters: addPointsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Analysis").addPointsResult>;
+        /**
          * Run the analysis. After this is called, <code>analysisResult</code> and/or
@@ -532,0 +548,0 @@ * <code>analysisError</code> events will be emitted as results are gathered.

js/client/build/client.js

@@ -154,2 +154,9 @@ "use strict";
             /**
+             * Describes some keyboard events that occur in the recording.
+             */
+            addKeyboardEventsListener: function (listener) {
+                return _this.genericClient.addEventListener("Session.keyboardEvents", listener);
+            },
+            removeKeyboardEventsListener: function () { var _a, _b; return (_b = (_a = _this.genericClient).removeEventListener) === null || _b === void 0 ? void 0 : _b.call(_a, "Session.keyboardEvents"); },
+            /**
              * Describes some annotations in the recording.
@@ -195,2 +202,11 @@ */
             /**
+             * Find all points in the recording at which a keyboard event occurred.
+             * Does not return until the recording is fully processed. Before returning,
+             * <code>keyboardEvents</code> events will be periodically emitted. The union
+             * of all these events describes all keyboard events in the recording.
+             */
+            findKeyboardEvents: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Session.findKeyboardEvents", parameters, sessionId, pauseId);
+            },
+            /**
              * Find all points in the recording at which an annotation was added via the
@@ -685,2 +701,8 @@ * RecordReplayOnAnnotation driver API. Does not return until the recording
             /**
+             * Apply the analysis to a specific set of points.
+             */
+            addPoints: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Analysis.addPoints", parameters, sessionId, pauseId);
+            },
+            /**
              * Run the analysis. After this is called, <code>analysisResult</code> and/or
@@ -687,0 +709,0 @@ * <code>analysisError</code> events will be emitted as results are gathered.

js/protocol/Analysis.d.ts

@@ -140,2 +140,14 @@ import { TimeStampedPoint, ExecutionPoint } from "./Recording";
 }
+export interface addPointsParameters {
+    /**
+     * Associated analysis.
+     */
+    analysisId: AnalysisId;
+    /**
+     * Points to apply the analysis to.
+     */
+    points: ExecutionPoint[];
+}
+export interface addPointsResult {
+}
 export interface runAnalysisParameters {
@@ -142,0 +154,0 @@ /**

js/protocol/index.d.ts

@@ -17,3 +17,3 @@ export * from "./Recording";
 import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
-import { missingRegions, unprocessedRegions, mouseEvents, annotations, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findAnnotationsParameters, findAnnotationsResult, getEndpointParameters, getEndpointResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, listenForLoadChangesParameters, listenForLoadChangesResult, loadRegionParameters, loadRegionResult, unloadRegionParameters, unloadRegionResult, getBuildIdParameters, getBuildIdResult } from "./Session";
+import { missingRegions, unprocessedRegions, mouseEvents, keyboardEvents, annotations, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findKeyboardEventsParameters, findKeyboardEventsResult, 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";
@@ -25,3 +25,3 @@ import { newSource, findSourcesParameters, findSourcesResult, getSourceContentsParameters, getSourceContentsResult, getPossibleBreakpointsParameters, getPossibleBreakpointsResult, getMappedLocationParameters, getMappedLocationResult, setBreakpointParameters, setBreakpointResult, removeBreakpointParameters, removeBreakpointResult, findResumeTargetParameters, findResumeTargetResult, findRewindTargetParameters, findRewindTargetResult, findReverseStepOverTargetParameters, findReverseStepOverTargetResult, findStepOverTargetParameters, findStepOverTargetResult, findStepInTargetParameters, findStepInTargetResult, findStepOutTargetParameters, findStepOutTargetResult, blackboxSourceParameters, blackboxSourceResult, unblackboxSourceParameters, unblackboxSourceResult } from "./Debugger";
 import { getComputedStyleParameters, getComputedStyleResult, getAppliedRulesParameters, getAppliedRulesResult } from "./CSS";
-import { analysisResult, analysisError, analysisPoints, createAnalysisParameters, createAnalysisResult, addLocationParameters, addLocationResult, addFunctionEntryPointsParameters, addFunctionEntryPointsResult, addRandomPointsParameters, addRandomPointsResult, addEventHandlerEntryPointsParameters, addEventHandlerEntryPointsResult, addExceptionPointsParameters, addExceptionPointsResult, runAnalysisParameters, runAnalysisResult, releaseAnalysisParameters, releaseAnalysisResult, findAnalysisPointsParameters, findAnalysisPointsResult } from "./Analysis";
+import { analysisResult, analysisError, analysisPoints, createAnalysisParameters, createAnalysisResult, addLocationParameters, addLocationResult, addFunctionEntryPointsParameters, addFunctionEntryPointsResult, addRandomPointsParameters, addRandomPointsResult, addEventHandlerEntryPointsParameters, addEventHandlerEntryPointsResult, addExceptionPointsParameters, addExceptionPointsResult, addPointsParameters, addPointsResult, runAnalysisParameters, runAnalysisResult, releaseAnalysisParameters, releaseAnalysisResult, findAnalysisPointsParameters, findAnalysisPointsResult } from "./Analysis";
 import { convertLocationToFunctionOffsetParameters, convertLocationToFunctionOffsetResult, convertFunctionOffsetToLocationParameters, convertFunctionOffsetToLocationResult, getStepOffsetsParameters, getStepOffsetsResult, getHTMLSourceParameters, getHTMLSourceResult, getFunctionsInRangeParameters, getFunctionsInRangeResult, getSourceMapURLParameters, getSourceMapURLResult, getSheetSourceMapURLParameters, getSheetSourceMapURLResult, getCurrentMessageContentsParameters, getCurrentMessageContentsResult, countStackFramesParameters, countStackFramesResult, getStackFunctionIDsParameters, getStackFunctionIDsResult, currentGeneratorIdParameters, currentGeneratorIdResult, topFrameLocationParameters, topFrameLocationResult } from "./Target";
@@ -74,2 +74,9 @@ import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, labelTestSessionParameters, labelTestSessionResult, reportCrashParameters, reportCrashResult } from "./Internal";
     /**
+     * Describes some keyboard events that occur in the recording.
+     */
+    "Session.keyboardEvents": {
+        parameters: keyboardEvents;
+        sessionId: true;
+    };
+    /**
      * Describes some annotations in the recording.
@@ -295,2 +302,15 @@ */
     /**
+     * Find all points in the recording at which a keyboard event occurred.
+     * Does not return until the recording is fully processed. Before returning,
+     * <code>keyboardEvents</code> events will be periodically emitted. The union
+     * of all these events describes all keyboard events in the recording.
+     */
+    "Session.findKeyboardEvents": {
+        parameters: findKeyboardEventsParameters;
+        result: findKeyboardEventsResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Find all points in the recording at which an annotation was added via the
@@ -891,2 +911,12 @@ * RecordReplayOnAnnotation driver API. Does not return until the recording
     /**
+     * Apply the analysis to a specific set of points.
+     */
+    "Analysis.addPoints": {
+        parameters: addPointsParameters;
+        result: addPointsResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Run the analysis. After this is called, <code>analysisResult</code> and/or
@@ -893,0 +923,0 @@ * <code>analysisError</code> events will be emitted as results are gathered.

js/protocol/Internal.d.ts

@@ -28,3 +28,3 @@ import { RecordingId, BuildId, TimeStamp } from "./Recording";
     recordingData: RecordingData;
-    authId: string;
+    authId?: string;
 }
@@ -31,0 +31,0 @@ export interface setRecordingMetadataResult {

js/protocol/Recording.d.ts

@@ -69,2 +69,23 @@ import { SessionId } from "./Session";
 /**
+ * A keyboard event that occurs somewhere in a recording.
+ */
+export interface KeyboardEvent extends TimeStampedPoint {
+    /**
+     * Kind of mouse event.
+     */
+    kind: KeyboardEventKind;
+    /**
+     * The DOM-spec key representing the key being pressed. See
+     * https://www.w3.org/TR/uievents-code/ for more information.
+     * Note: Depending on the platform being recorded, not all key events may be recordable.
+     */
+    key: string;
+}
+/**
+ * Kinds of keyboard events described in a recording.
+ * Note: Platforms should prefer to record key down/up events if possible, but keypress
+ * is provided as a simpler fallback for platforms unable to track down/up events.
+ */
+export declare type KeyboardEventKind = "keydown" | "keyup" | "keypress";
+/**
  * An annotation that was added to a recording.
@@ -71,0 +92,0 @@ */

js/protocol/Session.d.ts

@@ -1,2 +0,2 @@
-import { TimeRange, TimeStampedPointRange, MouseEvent, Annotation, TimeStampedPoint, ExecutionPoint } from "./Recording";
+import { TimeRange, TimeStampedPointRange, MouseEvent, KeyboardEvent, Annotation, TimeStampedPoint, ExecutionPoint } from "./Recording";
 import { PauseId, CallStack, PauseData } from "./Pause";
@@ -29,2 +29,6 @@ /**
 }
+export interface findKeyboardEventsParameters {
+}
+export interface findKeyboardEventsResult {
+}
 export interface findAnnotationsParameters {
@@ -127,2 +131,8 @@ }
 /**
+ * Describes some keyboard events that occur in the recording.
+ */
+export interface keyboardEvents {
+    events: KeyboardEvent[];
+}
+/**
  * Describes some annotations in the recording.
@@ -129,0 +139,0 @@ */

package.json

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

208103

increased by2.37%

Lines of code

5310

increased by2.14%

No dependency changes