@replayio/protocol - npm Package Compare versions

Comparing version 0.41.0 to 0.42.0

js/protocol/Debugger.d.ts

@@ -245,2 +245,9 @@ import { TimeStampedPoint, PointRange, ExecutionPoint } from "./Recording";
 }
+export interface mapExpressionToGeneratedScopeParameters {
+    expression: string;
+    location: Location;
+}
+export interface mapExpressionToGeneratedScopeResult {
+    expression: string;
+}
 export interface getPossibleBreakpointsParameters {
@@ -247,0 +254,0 @@ /**

js/protocol/index.d.ts

@@ -20,5 +20,5 @@ export * from "./Connection";
 import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
-import { mayDestroy, willDestroy, mouseEvents, keyboardEvents, navigationEvents, annotations, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, findKeyboardEventsParameters, findKeyboardEventsResult, findNavigationEventsParameters, findNavigationEventsResult, findAnnotationsParameters, findAnnotationsResult, getAnnotationKindsParameters, getAnnotationKindsResult, getEndpointParameters, getEndpointResult, getPointNearTimeParameters, getPointNearTimeResult, getPointsBoundingTimeParameters, getPointsBoundingTimeResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, 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, 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 { paintPoints, findPaintsParameters, findPaintsResult, getPaintContentsParameters, getPaintContentsResult, getDevicePixelRatioParameters, getDevicePixelRatioResult } from "./Graphics";
-import { newSource, sourceContentsInfo, sourceContentsChunk, searchSourceContentsMatches, functionsMatches, findSourcesParameters, findSourcesResult, streamSourceContentsParameters, streamSourceContentsResult, getSourceContentsParameters, getSourceContentsResult, getSourceMapParameters, getSourceMapResult, getScopeMapParameters, getScopeMapResult, 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";
+import { newSource, 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";
 import { newMessage, findMessagesParameters, findMessagesResult, findMessagesInRangeParameters, findMessagesInRangeResult } from "./Console";
@@ -30,3 +30,3 @@ 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";
 import { requestBodyData, responseBodyData, requests, getRequestBodyParameters, getRequestBodyResult, getResponseBodyParameters, getResponseBodyResult, findRequestsParameters, findRequestsResult } from "./Network";
-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 { 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, evaluatePrivilegedParameters, evaluatePrivilegedResult } from "./Target";
 import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, finishRecordingParameters, finishRecordingResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, reportCrashParameters, reportCrashResult } from "./Internal";
@@ -161,2 +161,20 @@ interface Events {
     /**
+     * Inform clients of points matching the query.
+     * A single <code>Session.findPoints</code> command will emit zero or
+     * more of these events with guaranteed ordering.
+     */
+    "Session.findPointsResults": {
+        parameters: findPointsResults;
+        sessionId: true;
+    };
+    /**
+     * Inform the client that some subset of the point evaluations has completed.
+     * Note: No event ordering of these responses is enforced, results will be sent
+     * as soon as they are available.
+     */
+    "Session.runEvaluationResults": {
+        parameters: runEvaluationResults;
+        sessionId: true;
+    };
+    /**
      * Describes the regions of the recording which are loading or loaded.
@@ -499,2 +517,22 @@ */
     /**
+     * Resolve a selector to a set of points.
+     */
+    "Session.findPoints": {
+        parameters: findPointsParameters;
+        result: findPointsResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
+     * Perform an evaluation at many points throughout the recording.
+     */
+    "Session.runEvaluation": {
+        parameters: runEvaluationParameters;
+        result: runEvaluationResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Listen for changes in the loading status of parts of the recording.
@@ -646,2 +684,14 @@ * Does not return until the session has been released. Before returning,
     /**
+     * Given a JS expression, parse it and make a best-effort attempt to rewrite
+     * variable references from the names present in the given location's scope
+     * to ones that are present in the underlying content scripts.
+     */
+    "Debugger.mapExpressionToGeneratedScope": {
+        parameters: mapExpressionToGeneratedScopeParameters;
+        result: mapExpressionToGeneratedScopeResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Get a compact representation of the locations where breakpoints can be set
@@ -1460,2 +1510,13 @@ * in a region of a source.
     /**
+     * Evaluate a string in an application specific environment with privileged
+     * access to inspect the runtime's state.
+     */
+    "Target.evaluatePrivileged": {
+        parameters: evaluatePrivilegedParameters;
+        result: evaluatePrivilegedResult;
+        sessionId: false;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Create a new recording.
@@ -1462,0 +1523,0 @@ */

js/protocol/Recording.d.ts

@@ -32,2 +32,15 @@ import { SessionId } from "./Session";
 /**
+ * A range limit between two optional execution points in a recording.
+ */
+export interface PointLimits {
+    /**
+     * An inclusive start point.
+     */
+    begin?: ExecutionPoint;
+    /**
+     * An exclusive end point.
+     */
+    end?: ExecutionPoint;
+}
+/**
  * A range between two execution points in a recording.
@@ -34,0 +47,0 @@ */

js/protocol/Session.d.ts

@@ -0,4 +1,5 @@
+import { Location, EventHandlerType, PointDescription } from "./Debugger";
+import { ExecutionPoint, PointLimits, PointRange, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange, TimeStampedPoint, TimeRange } from "./Recording";
+import { Result, PauseId, CallStack, PauseData } from "./Pause";
 import { CloseTimestamp } from "./Connection";
-import { MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange, TimeStampedPoint, ExecutionPoint, TimeRange } from "./Recording";
-import { PauseId, CallStack, PauseData } from "./Pause";
 /**
@@ -14,2 +15,83 @@ * Unique identifier for a session which a recording has been loaded into.
 export declare type ProcessingLevel = "basic";
+/**
+ * Select every point where a source location executes.
+ */
+export interface PointLocationSelector {
+    kind: "location";
+    /**
+     * Location to search for.
+     */
+    location: Location;
+    /**
+     * Limit the points to only those with this point on-stack.
+     */
+    onStackFrame?: ExecutionPoint;
+}
+/**
+ * Select the entry point of every handler for an event.
+ */
+export interface EventHandlerEntrypointSelector {
+    kind: "event-handlers";
+    /**
+     * Type of event whose handler calls should be selected.
+     */
+    eventType: EventHandlerType;
+}
+/**
+ * Select every point where an exception is thrown.
+ */
+export interface ExceptionPointSelector {
+    kind: "exceptions";
+}
+/**
+ * Select a specific set of points.
+ */
+export interface PointListSelector {
+    kind: "points";
+    /**
+     * Points to select.
+     */
+    points: ExecutionPoint[];
+}
+/**
+ * All the supported selector types.
+ */
+export declare type PointSelector = PointLocationSelector | EventHandlerEntrypointSelector | ExceptionPointSelector | PointListSelector;
+/**
+ * Describes filtering limits on a list of points.
+ */
+export interface PointPageLimits extends PointLimits {
+    /**
+     * The maximum number of points to include in the results,
+     * counting from the earliest point forward.
+     */
+    maxCount?: number;
+}
+/**
+ * Describes the recording range that was considered when running
+ * a point-centric query on a recording.
+ */
+export interface PointPage extends PointRange {
+    /**
+     * Indicates that there are no further expected results before the first point.
+     */
+    hasPrevious: boolean;
+    /**
+     * Indicates that there are no further expected results after the last point.
+     */
+    hasNext: boolean;
+}
+/**
+ * Describes the result of an evaluation at a particular point.
+ */
+export interface RunEvaluationResult extends Result {
+    /**
+     * The point where the evaluation occurred.
+     */
+    point: PointDescription;
+    /**
+     * The id of the pause created during execution.
+     */
+    pauseId: PauseId;
+}
 export interface ensureProcessedParameters {
@@ -93,2 +175,74 @@ /**
 }
+export interface findPointsParameters {
+    /**
+     * The ID of the findPoints results.
+     */
+    findPointsId: string;
+    /**
+     * The selector to choose points.
+     * This selector will run with additional limits provided by:
+     *  * The 'pointLimits' argument.
+     *  * The current focus window range.
+     *  * The backend's implicit maximum point limit.
+     */
+    pointSelector: PointSelector;
+    /**
+     * A page description to limit the point selector to a given recording range.
+     */
+    pointLimits?: PointPageLimits;
+}
+export interface findPointsResult {
+    /**
+     * A page value describing the range of the recording that was considered
+     * during searching.
+     */
+    pointPage: PointPage;
+}
+export interface runEvaluationParameters {
+    /**
+     * The ID of the evaluation.
+     */
+    runEvaluationId: string;
+    /**
+     * The selector to choose what points to evaluate at.
+     * This selector will run with additional limits provided by:
+     *  * The 'pointLimits' argument.
+     *  * The current focus window range.
+     *  * The backend's implicit maximum point limit.
+     */
+    pointSelector: PointSelector;
+    /**
+     * A page description to limit the point selector to a given recording range.
+     */
+    pointLimits?: PointPageLimits;
+    /**
+     * The expression to evaluate.
+     */
+    expression: string;
+    /**
+     * The index of the frame to evaluate in, with negative values wrapping
+     * back around. Omitted to evaluate in the global scope.
+     * Examples:
+     *  0 -> The shallowest frame's scope, i.e. the frame with no parent.
+     *  N-1 or -1 -> The frame scope that is currently executing.
+     *  Omitted -> The global scope.
+     */
+    frameIndex?: number;
+    /**
+     * By default the result value will be returned as a "full" preview and
+     * nested values will canOverflow and so on. This may be set to true to
+     * request that the backend attempt to expand the properties of the
+     * returned result to also be full previews.
+     * This is only a best effort and the backend does not guarantee that
+     * all properties will have been expanded.
+     */
+    fullReturnedPropertyPreview?: boolean;
+}
+export interface runEvaluationResult {
+    /**
+     * A page value describing the range of the recording that was considered
+     * during evaluation.
+     */
+    pointPage: PointPage;
+}
 export interface listenForLoadChangesParameters {
@@ -201,2 +355,32 @@ }
 /**
+ * Inform clients of points matching the query.
+ * A single <code>Session.findPoints</code> command will emit zero or
+ * more of these events with guaranteed ordering.
+ */
+export interface findPointsResults {
+    /**
+     * The ID of the find that these points apply to.
+     */
+    findPointsId: string;
+    /**
+     * A list of points found when searching. Guaranteed to be sorted.
+     */
+    points: PointDescription[];
+}
+/**
+ * Inform the client that some subset of the point evaluations has completed.
+ * Note: No event ordering of these responses is enforced, results will be sent
+ * as soon as they are available.
+ */
+export interface runEvaluationResults {
+    /**
+     * The ID of the evaluation that these results apply to.
+     */
+    runEvaluationId: string;
+    /**
+     * The list of evaluations that have just completed, sorted by point order.
+     */
+    results: RunEvaluationResult[];
+}
+/**
  * Describes the regions of the recording which are loading or loaded.
@@ -203,0 +387,0 @@ */

js/protocol/Target.d.ts

@@ -166,1 +166,18 @@ import { SameLineSourceLocations, Location, SourceId, SourceLocation } from "./Debugger";
 }
+export interface evaluatePrivilegedParameters {
+    /**
+     * Expression to evaluate.
+     */
+    expression: string;
+    /**
+     * Whether side effects are allowed during this evaluation, per
+     * RecordReplayAllowSideEffects().
+     */
+    allowSideEffects: boolean;
+}
+export interface evaluatePrivilegedResult {
+    /**
+     * Result of the evaluation, must be JSON-stringifiable.
+     */
+    result: any;
+}

package.json

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

548751

increased by5.56%

Lines of code

12773

increased by5.54%

No dependency changes