@recordreplay/protocol - npm Package Compare versions

Comparing version 0.8.1 to 0.8.2

js/client/build/client.d.ts

@@ -1,2 +0,2 @@
-import { uploadedData, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording";
+import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording";
 import { tokenParameters, existsParameters, createParameters } from "../../protocol/Resource";
@@ -12,4 +12,4 @@ import { setAccessTokenParameters } from "../../protocol/Authentication";
 import { analysisResult, analysisError, analysisPoints, createAnalysisParameters, addLocationParameters, addFunctionEntryPointsParameters, addRandomPointsParameters, addEventHandlerEntryPointsParameters, addExceptionPointsParameters, runAnalysisParameters, releaseAnalysisParameters, findAnalysisPointsParameters } from "../../protocol/Analysis";
-import { convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, currentGeneratorIdParameters, topFrameLocationParameters } from "../../protocol/Target";
-import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, hasResourceParameters, addResourceParameters, addRecordingResourceParameters, echoParameters, labelTestSessionParameters, getRecordingsParameters, reportCrashParameters } from "../../protocol/Internal";
+import { convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, getStackFunctionIDsParameters, currentGeneratorIdParameters, topFrameLocationParameters } from "../../protocol/Target";
+import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, labelTestSessionParameters, reportCrashParameters } from "../../protocol/Internal";
 import { GenericProtocolClient } from "../generic";
@@ -29,2 +29,8 @@ export declare class ProtocolClient {
         /**
+         * Emitted during 'createSession' if all recording data has been received, but
+         * sourcemaps are still pending.
+         */
+        addAwaitingSourcemapsListener: (listener: (parameters: awaitingSourcemaps) => void) => void;
+        removeAwaitingSourcemapsListener: () => void | undefined;
+        /**
          * Emitted when a session has died due to a server side problem.
@@ -577,2 +583,7 @@ */
         /**
+         * Get the IDs of the functions for all stack frames, ordered from topmost to
+         * bottommost.
+         */
+        getStackFunctionIDs: (parameters: getStackFunctionIDsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Target").getStackFunctionIDsResult>;
+        /**
          * If the topmost frame on the stack is a generator frame which can be popped
@@ -617,14 +628,11 @@ * and pushed on the stack repeatedly, return a unique ID for the frame which
         /**
-         * Determine whether a resource is known to the cloud service.
+         * Lock a given recording so that sessions will not be created
+         * until the lock has been removed.
          */
-        hasResource: (parameters: hasResourceParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").hasResourceResult>;
+        beginRecordingResourceUpload: (parameters: beginRecordingResourceUploadParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").beginRecordingResourceUploadResult>;
         /**
-         * Upload a resource's contents to the cloud service.
+         * Unlock a lock so that sessions may be created.
          */
-        addResource: (parameters: addResourceParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").addResourceResult>;
+        endRecordingResourceUpload: (parameters: endRecordingResourceUploadParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").endRecordingResourceUploadResult>;
         /**
-         * Associate a resource with a recording.
-         */
-        addRecordingResource: (parameters: addRecordingResourceParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").addRecordingResourceResult>;
-        /**
          * For testing network issues.
@@ -638,6 +646,2 @@ */
         /**
-         * Get the user's recordings
-         */
-        getRecordings: (parameters: getRecordingsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").getRecordingsResult>;
-        /**
          * Report information about a crash while recording.
@@ -644,0 +648,0 @@ */

js/client/build/client.js

@@ -20,2 +20,10 @@ "use strict";
             /**
+             * Emitted during 'createSession' if all recording data has been received, but
+             * sourcemaps are still pending.
+             */
+            addAwaitingSourcemapsListener: function (listener) {
+                return _this.genericClient.addEventListener("Recording.awaitingSourcemaps", listener);
+            },
+            removeAwaitingSourcemapsListener: function () { var _a, _b; return (_b = (_a = _this.genericClient).removeEventListener) === null || _b === void 0 ? void 0 : _b.call(_a, "Recording.awaitingSourcemaps"); },
+            /**
              * Emitted when a session has died due to a server side problem.
@@ -754,2 +762,9 @@ */
             /**
+             * Get the IDs of the functions for all stack frames, ordered from topmost to
+             * bottommost.
+             */
+            getStackFunctionIDs: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Target.getStackFunctionIDs", parameters, sessionId, pauseId);
+            },
+            /**
              * If the topmost frame on the stack is a generator frame which can be popped
@@ -806,20 +821,15 @@ * and pushed on the stack repeatedly, return a unique ID for the frame which
             /**
-             * Determine whether a resource is known to the cloud service.
+             * Lock a given recording so that sessions will not be created
+             * until the lock has been removed.
              */
-            hasResource: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Internal.hasResource", parameters, sessionId, pauseId);
+            beginRecordingResourceUpload: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Internal.beginRecordingResourceUpload", parameters, sessionId, pauseId);
             },
             /**
-             * Upload a resource's contents to the cloud service.
+             * Unlock a lock so that sessions may be created.
              */
-            addResource: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Internal.addResource", parameters, sessionId, pauseId);
+            endRecordingResourceUpload: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Internal.endRecordingResourceUpload", parameters, sessionId, pauseId);
             },
             /**
-             * Associate a resource with a recording.
-             */
-            addRecordingResource: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Internal.addRecordingResource", parameters, sessionId, pauseId);
-            },
-            /**
              * For testing network issues.
@@ -837,8 +847,2 @@ */
             /**
-             * Get the user's recordings
-             */
-            getRecordings: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Internal.getRecordings", parameters, sessionId, pauseId);
-            },
-            /**
              * Report information about a crash while recording.
@@ -845,0 +849,0 @@ */

js/client/generic.js

 "use strict";
-/* Copyright 2020 Record Replay Inc. */
+/* Copyright 2021 Record Replay Inc. */
 Object.defineProperty(exports, "__esModule", { value: true });

js/client/index.js

 "use strict";
-/* Copyright 2020 Record Replay Inc. */
+/* Copyright 2021 Record Replay Inc. */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -4,0 +4,0 @@ if (k2 === undefined) k2 = k;

js/client/simple.js

 "use strict";
-/* Copyright 2020 Record Replay Inc. */
+/* Copyright 2021 Record Replay Inc. */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
@@ -4,0 +4,0 @@ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }

js/index.js

 "use strict";
-/* Copyright 2020 Record Replay Inc. */
+/* Copyright 2021 Record Replay Inc. */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
@@ -4,0 +4,0 @@ if (k2 === undefined) k2 = k;

js/protocol/Debugger.d.ts

@@ -19,3 +19,4 @@ import { TimeStampedPoint, ExecutionPoint } from "./Recording";
  *   The source map and its sources must have been
- *   associated with the recording via <code>Internal.addRecordingResource</code>.
+ *   associated with the recording via <code>Recording.addSourceMap</code> and
+ *   <code>Recording.addOriginalSource</code>.
  * <br><code>prettyPrinted</code>: An original source which was produced by pretty
@@ -22,0 +23,0 @@ *   printing the associated generated source. Pretty printed sources will

js/protocol/index.d.ts

@@ -14,3 +14,3 @@ export * from "./Recording";
 export * from "./Internal";
-import { uploadedData, sessionError, getDescriptionParameters, getDescriptionResult, createSessionParameters, createSessionResult, releaseSessionParameters, releaseSessionResult, processRecordingParameters, processRecordingResult, addSourceMapParameters, addSourceMapResult, addOriginalSourceParameters, addOriginalSourceResult } from "./Recording";
+import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, getDescriptionResult, createSessionParameters, createSessionResult, releaseSessionParameters, releaseSessionResult, processRecordingParameters, processRecordingResult, addSourceMapParameters, addSourceMapResult, addOriginalSourceParameters, addOriginalSourceResult } from "./Recording";
 import { tokenParameters, tokenResult, existsParameters, existsResult, createParameters, createResult } from "./Resource";
@@ -26,4 +26,4 @@ import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
 import { analysisResult, analysisError, analysisPoints, createAnalysisParameters, createAnalysisResult, addLocationParameters, addLocationResult, addFunctionEntryPointsParameters, addFunctionEntryPointsResult, addRandomPointsParameters, addRandomPointsResult, addEventHandlerEntryPointsParameters, addEventHandlerEntryPointsResult, addExceptionPointsParameters, addExceptionPointsResult, runAnalysisParameters, runAnalysisResult, releaseAnalysisParameters, releaseAnalysisResult, findAnalysisPointsParameters, findAnalysisPointsResult } from "./Analysis";
-import { convertLocationToFunctionOffsetParameters, convertLocationToFunctionOffsetResult, convertFunctionOffsetToLocationParameters, convertFunctionOffsetToLocationResult, getStepOffsetsParameters, getStepOffsetsResult, getHTMLSourceParameters, getHTMLSourceResult, getFunctionsInRangeParameters, getFunctionsInRangeResult, getSourceMapURLParameters, getSourceMapURLResult, getSheetSourceMapURLParameters, getSheetSourceMapURLResult, getCurrentMessageContentsParameters, getCurrentMessageContentsResult, countStackFramesParameters, countStackFramesResult, currentGeneratorIdParameters, currentGeneratorIdResult, topFrameLocationParameters, topFrameLocationResult } from "./Target";
-import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, hasResourceParameters, hasResourceResult, addResourceParameters, addResourceResult, addRecordingResourceParameters, addRecordingResourceResult, echoParameters, echoResult, labelTestSessionParameters, labelTestSessionResult, getRecordingsParameters, getRecordingsResult, reportCrashParameters, reportCrashResult } from "./Internal";
+import { convertLocationToFunctionOffsetParameters, convertLocationToFunctionOffsetResult, convertFunctionOffsetToLocationParameters, convertFunctionOffsetToLocationResult, getStepOffsetsParameters, getStepOffsetsResult, getHTMLSourceParameters, getHTMLSourceResult, getFunctionsInRangeParameters, getFunctionsInRangeResult, getSourceMapURLParameters, getSourceMapURLResult, getSheetSourceMapURLParameters, getSheetSourceMapURLResult, getCurrentMessageContentsParameters, getCurrentMessageContentsResult, countStackFramesParameters, countStackFramesResult, getStackFunctionIDsParameters, getStackFunctionIDsResult, currentGeneratorIdParameters, currentGeneratorIdResult, topFrameLocationParameters, topFrameLocationResult } from "./Target";
+import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, labelTestSessionParameters, labelTestSessionResult, reportCrashParameters, reportCrashResult } from "./Internal";
 interface Events {
@@ -38,2 +38,10 @@ /**
     /**
+     * Emitted during 'createSession' if all recording data has been received, but
+     * sourcemaps are still pending.
+     */
+    "Recording.awaitingSourcemaps": {
+        parameters: awaitingSourcemaps;
+        sessionId: false;
+    };
+    /**
      * Emitted when a session has died due to a server side problem.
@@ -1001,2 +1009,13 @@ */
     /**
+     * Get the IDs of the functions for all stack frames, ordered from topmost to
+     * bottommost.
+     */
+    "Target.getStackFunctionIDs": {
+        parameters: getStackFunctionIDsParameters;
+        result: getStackFunctionIDsResult;
+        sessionId: false;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * If the topmost frame on the stack is a generator frame which can be popped
@@ -1070,7 +1089,8 @@ * and pushed on the stack repeatedly, return a unique ID for the frame which
     /**
-     * Determine whether a resource is known to the cloud service.
+     * Lock a given recording so that sessions will not be created
+     * until the lock has been removed.
      */
-    "Internal.hasResource": {
-        parameters: hasResourceParameters;
-        result: hasResourceResult;
+    "Internal.beginRecordingResourceUpload": {
+        parameters: beginRecordingResourceUploadParameters;
+        result: beginRecordingResourceUploadResult;
         sessionId: false;
@@ -1081,7 +1101,7 @@ pauseId: false;
     /**
-     * Upload a resource's contents to the cloud service.
+     * Unlock a lock so that sessions may be created.
      */
-    "Internal.addResource": {
-        parameters: addResourceParameters;
-        result: addResourceResult;
+    "Internal.endRecordingResourceUpload": {
+        parameters: endRecordingResourceUploadParameters;
+        result: endRecordingResourceUploadResult;
         sessionId: false;
@@ -1092,12 +1112,2 @@ pauseId: false;
     /**
-     * Associate a resource with a recording.
-     */
-    "Internal.addRecordingResource": {
-        parameters: addRecordingResourceParameters;
-        result: addRecordingResourceResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
      * For testing network issues.
@@ -1123,12 +1133,2 @@ */
     /**
-     * Get the user's recordings
-     */
-    "Internal.getRecordings": {
-        parameters: getRecordingsParameters;
-        result: getRecordingsResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
      * Report information about a crash while recording.
@@ -1135,0 +1135,0 @@ */

js/protocol/Internal.d.ts

 import { RecordingId, BuildId, TimeStamp } from "./Recording";
-import { MimeType } from "./Graphics";
 import { SessionId } from "./Session";
 /**
- * Information about a file based resource. Currently, resources are used for
- * source maps and original sources.
- */
-export interface Resource {
-    /**
-     * URL of the resource.
-     */
-    url: string;
-    /**
-     * Checksum of the resource's contents.
-     */
-    checksum: string;
-}
-/**
  * Metadata that can be associated with a recording.
@@ -79,10 +64,2 @@ */
     /**
-     * Mime type for graphics data at the end of the recording.
-     */
-    lastScreenMimeType?: MimeType;
-    /**
-     * Raw graphics data for the end of the recording.
-     */
-    lastScreenData?: string;
-    /**
      * Any command line arguments associated with the recording.
@@ -94,37 +71,21 @@ */
 }
-export interface hasResourceParameters {
+export interface beginRecordingResourceUploadParameters {
     /**
-     * Resource to look for.
+     * ID of the recording.
      */
-    resource: Resource;
+    recordingId: RecordingId;
 }
-export interface hasResourceResult {
+export interface beginRecordingResourceUploadResult {
     /**
-     * Whether the resource's contents are known.
+     * An identifier for the lock, in order to unlock.
      */
-    known: boolean;
+    key: string;
 }
-export interface addResourceParameters {
+export interface endRecordingResourceUploadParameters {
     /**
-     * Resource to add.
-     */
-    resource: Resource;
-    /**
-     * Text contents of the resource.
-     */
-    contents: string;
-}
-export interface addResourceResult {
-}
-export interface addRecordingResourceParameters {
-    /**
      * ID of the recording.
      */
-    recordingId: RecordingId;
-    /**
-     * Resource which the recording is associated with.
-     */
-    resource: Resource;
+    key: string;
 }
-export interface addRecordingResourceResult {
+export interface endRecordingResourceUploadResult {
 }
@@ -150,8 +111,2 @@ export interface echoParameters {
 }
-export interface getRecordingsParameters {
-    authId: string;
-}
-export interface getRecordingsResult {
-    recordings: any[];
-}
 export interface reportCrashParameters {
@@ -158,0 +113,0 @@ data: any;

js/protocol/Pause.d.ts

@@ -37,2 +37,3 @@ import { MappedLocation, PointDescription } from "./Debugger";
      * For non-object values that are valid JSON values.
+     * Long strings may be truncated.
      */
@@ -168,3 +169,4 @@ value?: any;
     /**
-     * Set if there are additional contents not in this preview.
+     * Set if there are additional contents not in this preview which can be
+     * obtained by getting a "full" preview.
      */
@@ -335,3 +337,4 @@ overflow?: boolean;
  *   If there are too many properties, some may be omitted and the preview will overflow.
- * <br><code>full</code>: Generate a non-overflowing preview with all properties.
+ * <br><code>full</code>: Generate a non-overflowing preview with as many properties as possible.
+ *   For very large objects, some properties may be omitted from the result.
  * <br><br>
@@ -338,0 +341,0 @@ */

js/protocol/Recording.d.ts

 import { SessionId } from "./Session";
-import { ScreenShot } from "./Graphics";
 import { Proof } from "./Resource";
@@ -100,10 +99,2 @@ /**
     length: number;
-    /**
-     * Painted graphics at the end of the recording.
-     */
-    lastScreen?: ScreenShot;
-    /**
-     * Any command line arguments associated with the recording.
-     */
-    commandLineArguments?: string[];
 }
@@ -208,2 +199,12 @@ export interface createSessionParameters {
 /**
+ * Emitted during 'createSession' if all recording data has been received, but
+ * sourcemaps are still pending.
+ */
+export interface awaitingSourcemaps {
+    /**
+     * Recording being described.
+     */
+    recordingId: RecordingId;
+}
+/**
  * Emitted when a session has died due to a server side problem.
@@ -210,0 +211,0 @@ */

js/protocol/Target.d.ts

@@ -74,2 +74,7 @@ import { Location, SourceId, SourceLocation } from "./Debugger";
 }
+export interface getStackFunctionIDsParameters {
+}
+export interface getStackFunctionIDsResult {
+    frameFunctions: string[];
+}
 export interface currentGeneratorIdParameters {
@@ -76,0 +81,0 @@ }

package.json

 {
   "name": "@recordreplay/protocol",
-  "version": "0.8.1",
+  "version": "0.8.2",
   "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

199640

increased by0.18%

Worsened metrics

Lines of code

5143

decreased by-0.54%

No dependency changes