@replayio/protocol - npm Package Compare versions

Comparing version 0.42.0 to 0.43.0

js/protocol/index.d.ts

@@ -161,3 +161,3 @@ export * from "./Connection";
      * A single <code>Session.findPoints</code> command will emit zero or
-     * more of these events with guaranteed ordering.
+     * more of these events, in point order.
      */
@@ -515,3 +515,4 @@ "Session.findPointsResults": {
     /**
-     * Resolve a selector to a set of points.
+     * Resolve a selector to a set of points. Zero or more <code>Session.findPointsResults</code>
+     * events will be emitted with points matching the query, in point order.
      */
@@ -527,2 +528,4 @@ "Session.findPoints": {
      * Perform an evaluation at many points throughout the recording.
+     * Zero or more <code>Session.runEvaluationResults</code> events will
+     * be emitted with results matching the query, with no ordering guarantees.
      */
@@ -529,0 +532,0 @@ "Session.runEvaluation": {

js/protocol/Recording.d.ts

@@ -1,2 +0,2 @@
-import { SessionId } from "./Session";
+import { SessionId, FocusWindowRequest } from "./Session";
 import { Proof } from "./Resource";
@@ -18,9 +18,2 @@ /**
 /**
- * Description for a range of time within a recording.
- */
-export interface TimeRange {
-    begin: TimeStamp;
-    end: TimeStamp;
-}
-/**
  * Identifier for a point within a recording at which the program state can be
@@ -164,3 +157,3 @@ * inspected. Execution points are integers encoded as base-10 numeric strings,
      */
-    focusWindow?: TimeRange;
+    focusWindow?: FocusWindowRequest;
 }
@@ -167,0 +160,0 @@ export interface createSessionResult {

js/protocol/Session.d.ts

 import { Location, EventHandlerType, PointDescription } from "./Debugger";
-import { ExecutionPoint, PointLimits, PointRange, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange, TimeStampedPoint, TimeRange } from "./Recording";
+import { ExecutionPoint, PointLimits, PointRange, TimeStamp, MouseEvent, KeyboardEvent, NavigationEvent, Annotation, TimeStampedPointRange, TimeStampedPoint } from "./Recording";
 import { Result, PauseId, CallStack, PauseData } from "./Pause";
@@ -84,2 +84,10 @@ import { CloseTimestamp } from "./Connection";
 /**
+ * The ID type for <code>Session.findPoints</code> commands.
+ */
+export declare type FindPointsId = string;
+/**
+ * The ID type for <code>Session.runEvaluation</code> commands.
+ */
+export declare type RunEvaluationId = string;
+/**
  * Describes the result of an evaluation at a particular point.
@@ -97,2 +105,19 @@ */
 }
+/**
+ * Defines the possible bias values for the focus window request.
+ */
+export declare type FocusWindowRequestBias = "begin" | "end";
+/**
+ * Description for the focus window to load within a recording.
+ */
+export interface FocusWindowRequest {
+    begin: TimeStamp;
+    end: TimeStamp;
+    /**
+     * 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 {
@@ -180,3 +205,3 @@ /**
      */
-    findPointsId: string;
+    findPointsId: FindPointsId;
     /**
@@ -206,3 +231,3 @@ * The selector to choose points.
      */
-    runEvaluationId: string;
+    runEvaluationId: RunEvaluationId;
     /**
@@ -258,3 +283,3 @@ * The selector to choose what points to evaluate at.
      */
-    range: TimeRange;
+    range: FocusWindowRequest;
 }
@@ -360,3 +385,3 @@ export interface requestFocusRangeResult {
  * A single <code>Session.findPoints</code> command will emit zero or
- * more of these events with guaranteed ordering.
+ * more of these events, in point order.
  */
@@ -367,3 +392,3 @@ export interface findPointsResults {
      */
-    findPointsId: string;
+    findPointsId: FindPointsId;
     /**
@@ -383,5 +408,5 @@ * A list of points found when searching. Guaranteed to be sorted.
      */
-    runEvaluationId: string;
+    runEvaluationId: RunEvaluationId;
     /**
-     * The list of evaluations that have just completed, sorted by point order.
+     * The list of evaluations that have just completed, with unspecified order.
      */
@@ -388,0 +413,0 @@ results: RunEvaluationResult[];

package.json

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

551855

increased by0.57%

Lines of code

12825

increased by0.41%

No dependency changes