@replayio/protocol - npm Package Compare versions

Comparing version 0.54.1 to 0.55.0

js/client/build/client.d.ts

@@ -5,3 +5,3 @@ import { mayDisconnect, willDisconnect } from "../../protocol/Connection";
 import { setAccessTokenParameters } from "../../protocol/Authentication";
-import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, findPointsResults, runEvaluationResults, loadedRegions, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getAnnotationKindsParameters, hasAnnotationKindParameters, getEndpointParameters, getPointNearTimeParameters, getPointsBoundingTimeParameters, createPauseParameters, releasePauseParameters, findPointsParameters, runEvaluationParameters, listenForLoadChangesParameters, requestFocusRangeParameters, getFocusWindowParameters, getBuildIdParameters } from "../../protocol/Session";
+import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, findPointsResults, runEvaluationResults, loadedRegions, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getAnnotationKindsParameters, hasAnnotationKindParameters, getEndpointParameters, getPointNearTimeParameters, getPointsBoundingTimeParameters, createPauseParameters, releasePauseParameters, findPointsParameters, runEvaluationParameters, listenForLoadChangesParameters, requestFocusRangeParameters, requestFocusWindowParameters, getFocusWindowParameters, getBuildIdParameters } from "../../protocol/Session";
 import { paintPoints, findPaintsParameters, getPaintContentsParameters, getDevicePixelRatioParameters } from "../../protocol/Graphics";
@@ -325,2 +325,15 @@ import { newSource, newSources, sourceContentsInfo, sourceContentsChunk, searchSourceContentsMatches, functionsMatches, findSourcesParameters, streamSourceContentsParameters, getSourceContentsParameters, getSourceMapParameters, getScopeMapParameters, mapExpressionToGeneratedScopeParameters, getPossibleBreakpointsParameters, getHitCountsParameters, getEventHandlerCountParameters, getEventHandlerCountsParameters, getAllEventHandlerCountsParameters, searchSourceContentsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters, searchFunctionsParameters, getSourceOutlineParameters } from "../../protocol/Debugger";
         requestFocusRange: (parameters: requestFocusRangeParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").requestFocusRangeResult>;
+        /**
+         * Request to load a range between two execution points. This command will unload
+         * areas outside of the requested range.
+         *
+         * After this command returns, any future commands that are sent will use the
+         * new loading range, and might need to wait until it finishes loading
+         * before they return.
+         *
+         * Commands which are sent before this returns or which were still in progress
+         * when this was sent may use either the earlier loaded range, the newly
+         * loaded range, or some combination of the two.
+         */
+        requestFocusWindow: (parameters: requestFocusWindowParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").requestFocusWindowResult>;
         getFocusWindow: (parameters: getFocusWindowParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").getFocusWindowResult>;
@@ -327,0 +340,0 @@ /**

js/protocol/index.d.ts

@@ -19,3 +19,3 @@ export * from "./Connection";
 import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
-import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, findPointsResults, runEvaluationResults, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findKeyboardEventsParameters, findKeyboardEventsResult, findNavigationEventsParameters, findNavigationEventsResult, findAnnotationsParameters, findAnnotationsResult, getAnnotationKindsParameters, getAnnotationKindsResult, hasAnnotationKindParameters, hasAnnotationKindResult, getEndpointParameters, getEndpointResult, getPointNearTimeParameters, getPointNearTimeResult, getPointsBoundingTimeParameters, getPointsBoundingTimeResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, findPointsParameters, findPointsResult, runEvaluationParameters, runEvaluationResult, listenForLoadChangesParameters, listenForLoadChangesResult, requestFocusRangeParameters, requestFocusRangeResult, getFocusWindowParameters, getFocusWindowResult, getBuildIdParameters, getBuildIdResult } from "./Session";
+import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, findPointsResults, runEvaluationResults, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findKeyboardEventsParameters, findKeyboardEventsResult, findNavigationEventsParameters, findNavigationEventsResult, findAnnotationsParameters, findAnnotationsResult, getAnnotationKindsParameters, getAnnotationKindsResult, hasAnnotationKindParameters, hasAnnotationKindResult, getEndpointParameters, getEndpointResult, getPointNearTimeParameters, getPointNearTimeResult, getPointsBoundingTimeParameters, getPointsBoundingTimeResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, findPointsParameters, findPointsResult, runEvaluationParameters, runEvaluationResult, listenForLoadChangesParameters, listenForLoadChangesResult, requestFocusRangeParameters, requestFocusRangeResult, requestFocusWindowParameters, requestFocusWindowResult, getFocusWindowParameters, getFocusWindowResult, getBuildIdParameters, getBuildIdResult } from "./Session";
 import { paintPoints, findPaintsParameters, findPaintsResult, getPaintContentsParameters, getPaintContentsResult, getDevicePixelRatioParameters, getDevicePixelRatioResult } from "./Graphics";
@@ -566,2 +566,21 @@ import { newSource, newSources, sourceContentsInfo, sourceContentsChunk, searchSourceContentsMatches, functionsMatches, findSourcesParameters, findSourcesResult, streamSourceContentsParameters, streamSourceContentsResult, getSourceContentsParameters, getSourceContentsResult, getSourceMapParameters, getSourceMapResult, getScopeMapParameters, getScopeMapResult, mapExpressionToGeneratedScopeParameters, mapExpressionToGeneratedScopeResult, getPossibleBreakpointsParameters, getPossibleBreakpointsResult, getHitCountsParameters, getHitCountsResult, getEventHandlerCountParameters, getEventHandlerCountResult, getEventHandlerCountsParameters, getEventHandlerCountsResult, getAllEventHandlerCountsParameters, getAllEventHandlerCountsResult, 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, getSourceOutlineParameters, getSourceOutlineResult } from "./Debugger";
     };
+    /**
+     * Request to load a range between two execution points. This command will unload
+     * areas outside of the requested range.
+     *
+     * After this command returns, any future commands that are sent will use the
+     * new loading range, and might need to wait until it finishes loading
+     * before they return.
+     *
+     * Commands which are sent before this returns or which were still in progress
+     * when this was sent may use either the earlier loaded range, the newly
+     * loaded range, or some combination of the two.
+     */
+    "Session.requestFocusWindow": {
+        parameters: requestFocusWindowParameters;
+        result: requestFocusWindowResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
     "Session.getFocusWindow": {
@@ -568,0 +587,0 @@ parameters: getFocusWindowParameters;

js/protocol/Recording.d.ts

@@ -1,2 +0,2 @@
-import { SessionId, FocusWindowRequest } from "./Session";
+import { SessionId, FocusWindowRequest, PointRangeFocusRequest } from "./Session";
 import { Proof } from "./Resource";
@@ -154,5 +154,10 @@ /**
     /**
-     * Range to load.
+     * Range to load, specified by timestamps
      */
     focusWindow?: FocusWindowRequest;
+    /**
+     * Initial focus window to request the backend to load. Overrides the <code>focusWindow</code> field
+     * if it is also set.
+     */
+    focusRequest?: PointRangeFocusRequest;
 }
@@ -159,0 +164,0 @@ export interface createSessionResult {

js/protocol/Session.d.ts

 import { Location, EventHandlerType, PointDescription } from "./Debugger";
-import { ExecutionPoint, PointLimits, PointRange, TimeStamp, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange, TimeStampedPoint } from "./Recording";
+import { ExecutionPoint, PointLimits, PointRange, TimeStamp, TimeStampedPoint, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange } from "./Recording";
 import { Result, PauseId } from "./Pause";
@@ -161,2 +161,22 @@ import { CloseTimestamp } from "./Connection";
 }
+/**
+ * Description for the focus window to load within a recording, specified with
+ * timestamped points.
+ */
+export interface PointRangeFocusRequest {
+    /**
+     * The earliest point to be loaded. Defaults to the first point in the recording.
+     */
+    begin?: TimeStampedPoint;
+    /**
+     * The latest point to be loaded. Defaults to the last point in the recording.
+     */
+    end?: TimeStampedPoint;
+    /**
+     * Request a particular bias for how the window should be selected,
+     * in cases where the server opts to load a window that is smaller
+     * than the requested time range. Defaults to "end".
+     */
+    bias?: FocusWindowRequestBias;
+}
 export interface ensureProcessedParameters {
@@ -375,2 +395,14 @@ /**
 }
+export interface requestFocusWindowParameters {
+    /**
+     * Description of the focus window requested.
+     */
+    request: PointRangeFocusRequest;
+}
+export interface requestFocusWindowResult {
+    /**
+     * The focus window that was applied.
+     */
+    window: TimeStampedPointRange;
+}
 export interface getFocusWindowParameters {
@@ -377,0 +409,0 @@ }

package.json

 {
   "name": "@replayio/protocol",
-  "version": "0.54.1",
+  "version": "0.55.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

541072

increased by1.27%

Lines of code

12529

increased by1.08%

No dependency changes