@replayio/protocol - npm Package Compare versions

Comparing version 0.39.0 to 0.40.0

js/client/build/client.d.ts

@@ -7,3 +7,3 @@ import { mayDisconnect, willDisconnect } from "../../protocol/Connection";
 import { paintPoints, findPaintsParameters, getPaintContentsParameters, getDevicePixelRatioParameters } from "../../protocol/Graphics";
-import { newSource, sourceContentsInfo, sourceContentsChunk, searchSourceContentsMatches, functionsMatches, findSourcesParameters, streamSourceContentsParameters, getSourceContentsParameters, getSourceMapParameters, getScopeMapParameters, getPossibleBreakpointsParameters, getHitCountsParameters, getEventHandlerCountParameters, getEventHandlerCountsParameters, getAllEventHandlerCountsParameters, searchSourceContentsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters, searchFunctionsParameters } from "../../protocol/Debugger";
+import { newSource, sourceContentsInfo, sourceContentsChunk, searchSourceContentsMatches, functionsMatches, findSourcesParameters, streamSourceContentsParameters, getSourceContentsParameters, getSourceMapParameters, getScopeMapParameters, getPossibleBreakpointsParameters, getHitCountsParameters, getEventHandlerCountParameters, getEventHandlerCountsParameters, getAllEventHandlerCountsParameters, searchSourceContentsParameters, getMappedLocationParameters, setBreakpointParameters, removeBreakpointParameters, findResumeTargetParameters, findRewindTargetParameters, findReverseStepOverTargetParameters, findStepOverTargetParameters, findStepInTargetParameters, findStepOutTargetParameters, blackboxSourceParameters, unblackboxSourceParameters, searchFunctionsParameters, getSourceOutlineParameters } from "../../protocol/Debugger";
 import { newMessage, findMessagesParameters, findMessagesInRangeParameters } from "../../protocol/Console";
@@ -482,2 +482,6 @@ import { evaluateInFrameParameters, evaluateInGlobalParameters, getObjectPropertyParameters, callFunctionParameters, callObjectPropertyParameters, getObjectPreviewParameters, getScopeParameters, getTopFrameParameters, getAllFramesParameters, getFrameArgumentsParameters, getFrameStepsParameters, getExceptionValueParameters } from "../../protocol/Pause";
         searchFunctions: (parameters: searchFunctionsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Debugger").searchFunctionsResult>;
+        /**
+         * Get a description of all functions and classes in a source.
+         */
+        getSourceOutline: (parameters: getSourceOutlineParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Debugger").getSourceOutlineResult>;
     };
@@ -484,0 +488,0 @@ /**

js/protocol/Debugger.d.ts

@@ -162,2 +162,33 @@ import { TimeStampedPoint, PointRange, ExecutionPoint } from "./Recording";
 export declare type PersistentObjectId = string;
+export interface SourceLocationRange {
+    begin: SourceLocation;
+    end: SourceLocation;
+}
+export interface SymbolOutline {
+    /**
+     * The name of the function or class, this may be inferred from an assignment.
+     */
+    name?: string;
+    location: SourceLocationRange;
+}
+export interface FunctionOutline extends SymbolOutline {
+    /**
+     * Descriptions of parameters, in the simplest case these are just the
+     * parameter names but they could also be more complex to describe
+     * destructuring or rest parameters and default values.
+     */
+    parameters: string[];
+    /**
+     * The location where the function's body begins.
+     */
+    body?: SourceLocation;
+    /**
+     * The name of the class in which the function is defined (this doesn't
+     * necessarily imply that the function is a method of the class).
+     */
+    className?: string;
+}
+export interface ClassOutline extends SymbolOutline {
+    parent?: SymbolOutline;
+}
 export interface findSourcesParameters {
@@ -466,2 +497,9 @@ }
 }
+export interface getSourceOutlineParameters {
+    sourceId: SourceId;
+}
+export interface getSourceOutlineResult {
+    classes: ClassOutline[];
+    functions: FunctionOutline[];
+}
 /**
@@ -468,0 +506,0 @@ * Describes a source in the recording.

js/protocol/index.d.ts

@@ -22,3 +22,3 @@ export * from "./Connection";
 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 } from "./Debugger";
+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 { newMessage, findMessagesParameters, findMessagesResult, findMessagesInRangeParameters, findMessagesInRangeResult } from "./Console";
@@ -851,2 +851,12 @@ 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";
     /**
+     * Get a description of all functions and classes in a source.
+     */
+    "Debugger.getSourceOutline": {
+        parameters: getSourceOutlineParameters;
+        result: getSourceOutlineResult;
+        sessionId: true;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Find all messages in the recording. Does not return until the recording is
@@ -853,0 +863,0 @@ * fully processed. Before returning, <code>newMessage</code> events will be

package.json

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

519362

increased by1.16%

Lines of code

12108

increased by1.26%

No dependency changes