@replayio/protocol - npm Package Compare versions

Comparing version 0.59.0 to 0.60.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, processingProgress, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getAnnotationKindsParameters, hasAnnotationKindParameters, getEndpointParameters, getPointNearTimeParameters, getPointsBoundingTimeParameters, createPauseParameters, releasePauseParameters, findPointsParameters, runEvaluationParameters, listenForLoadChangesParameters, listenForProcessingProgressParameters, requestFocusRangeParameters, requestFocusWindowParameters, getFocusWindowParameters, getBuildIdParameters } from "../../protocol/Session";
+import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, findPointsResults, runEvaluationResults, loadedRegions, processingProgress, ensureProcessedParameters, findMouseEventsParameters, findKeyboardEventsParameters, findNavigationEventsParameters, findAnnotationsParameters, getAnnotationKindsParameters, hasAnnotationKindParameters, getEndpointParameters, getPointNearTimeParameters, getPointsBoundingTimeParameters, createPauseParameters, releasePauseParameters, findPointsParameters, runEvaluationParameters, getPointStackParameters, listenForLoadChangesParameters, listenForProcessingProgressParameters, requestFocusRangeParameters, requestFocusWindowParameters, getFocusWindowParameters, getBuildIdParameters } from "../../protocol/Session";
 import { paintPoints, findPaintsParameters, getPaintContentsParameters, getDevicePixelRatioParameters } from "../../protocol/Graphics";
@@ -305,2 +305,13 @@ 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";
         /**
+         * Builds a callstack-analogous structure starting from the input point.
+         *
+         * NOTE: This result is built from our ExecutionPoint dataset, and is
+         * thus different from Pause.getAllFrames in two important ways:
+         *  1. It does not require the creation of a Pause, making it much faster.
+         *  2. The stack entries represent known points in our dataset, but we don't
+         *     have ExecutionPoints for every possible location, so any frame
+         *     entries will be the closest point available in the callee frame.
+         */
+        getPointStack: (parameters: getPointStackParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").getPointStackResult>;
+        /**
          * Listen for changes in the loading status of parts of the recording.
@@ -307,0 +318,0 @@ * Does not return until the session has been released. Before returning,

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, processingProgress, 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, listenForProcessingProgressParameters, listenForProcessingProgressResult, requestFocusRangeParameters, requestFocusRangeResult, requestFocusWindowParameters, requestFocusWindowResult, getFocusWindowParameters, getFocusWindowResult, getBuildIdParameters, getBuildIdResult } from "./Session";
+import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, findPointsResults, runEvaluationResults, loadedRegions, processingProgress, 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, getPointStackParameters, getPointStackResult, listenForLoadChangesParameters, listenForLoadChangesResult, listenForProcessingProgressParameters, listenForProcessingProgressResult, requestFocusRangeParameters, requestFocusRangeResult, requestFocusWindowParameters, requestFocusWindowResult, getFocusWindowParameters, getFocusWindowResult, getBuildIdParameters, getBuildIdResult } from "./Session";
 import { paintPoints, findPaintsParameters, findPaintsResult, getPaintContentsParameters, getPaintContentsResult, getDevicePixelRatioParameters, getDevicePixelRatioResult } from "./Graphics";
@@ -536,2 +536,19 @@ 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";
     /**
+     * Builds a callstack-analogous structure starting from the input point.
+     *
+     * NOTE: This result is built from our ExecutionPoint dataset, and is
+     * thus different from Pause.getAllFrames in two important ways:
+     *  1. It does not require the creation of a Pause, making it much faster.
+     *  2. The stack entries represent known points in our dataset, but we don't
+     *     have ExecutionPoints for every possible location, so any frame
+     *     entries will be the closest point available in the callee frame.
+     */
+    "Session.getPointStack": {
+        parameters: getPointStackParameters;
+        result: getPointStackResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Listen for changes in the loading status of parts of the recording.
@@ -538,0 +555,0 @@ * Does not return until the session has been released. Before returning,

js/protocol/Session.d.ts

@@ -1,2 +0,2 @@
-import { Location, EventHandlerType, PointDescription } from "./Debugger";
+import { Location, EventHandlerType, PointDescription, MappedLocation } from "./Debugger";
 import { ExecutionPoint, PointLimits, TimeStamp, TimeStampedPoint, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange } from "./Recording";
@@ -149,2 +149,15 @@ import { Result, PauseId } from "./Pause";
 /**
+ * A descriptor of a point along with basic frame data.
+ */
+export interface PointStackFrame {
+    /**
+     * A point in a frame.
+     */
+    point: PointDescription;
+    /**
+     * The location of the function containing the point.
+     */
+    functionLocation: MappedLocation;
+}
+/**
  * Defines the possible bias values for the focus window request.
@@ -391,2 +404,28 @@ */
 }
+export interface getPointStackParameters {
+    /**
+     * Point to begin traversal at.
+     */
+    point: ExecutionPoint;
+    /**
+     * The max number of entries to return.
+     * NOTE: This field is required because:
+     *  1. This takes time to compute, so we recommend that clients progressively
+     *     load groups of stack frames.
+     *  2. The depth of the stack can't be known ahead of time, so it is best
+     *     if clients set realistic limits on how many entries to request.
+     */
+    maxCount: number;
+}
+export interface getPointStackResult {
+    /**
+     * The list of frames, which may be empty.
+     */
+    frames: PointStackFrame[];
+    /**
+     * If the focus window excluded data that was necessary to determine
+     * whether or not further frames exist, this  will be set.
+     */
+    hitFocusBegin: boolean;
+}
 export interface listenForLoadChangesParameters {
@@ -393,0 +432,0 @@ }

package.json

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

553556

increased by1.19%

Lines of code

12782

increased by1.03%

No dependency changes