@replayio/protocol - npm Package Compare versions

Comparing version 0.31.0 to 0.31.1

js/client/build/client.d.ts

 import { mayDisconnect, willDisconnect } from "../../protocol/Connection";
-import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording";
+import { uploadedData, awaitingSourcemaps, sessionError, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording";
 import { tokenParameters, existsParameters, createParameters } from "../../protocol/Resource";
@@ -15,3 +15,3 @@ import { setAccessTokenParameters } from "../../protocol/Authentication";
 import { getCapabilitiesParameters, convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, convertFunctionOffsetsToLocationsParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, getStackFunctionIDsParameters, currentGeneratorIdParameters, topFrameLocationParameters, getCurrentNetworkRequestEventParameters, getCurrentNetworkStreamDataParameters, getPossibleBreakpointsForMultipleSourcesParameters } from "../../protocol/Target";
-import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, finishRecordingParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, reportCrashParameters } from "../../protocol/Internal";
+import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, finishRecordingParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, reportCrashParameters } from "../../protocol/Internal";
 import { GenericProtocolClient } from "../generic";
@@ -40,3 +40,3 @@ export declare class ProtocolClient {
         addMayDisconnectListener: (listener: (parameters: mayDisconnect) => void) => void;
-        removeMayDisconnectListener: () => void | undefined;
+        removeMayDisconnectListener: (listener?: ((parameters: mayDisconnect) => void) | undefined) => void | undefined;
         /**
@@ -56,3 +56,3 @@ * Notify clients if the backend expects to explicitly disconnect a socket with
         addWillDisconnectListener: (listener: (parameters: willDisconnect) => void) => void;
-        removeWillDisconnectListener: () => void | undefined;
+        removeWillDisconnectListener: (listener?: ((parameters: willDisconnect) => void) | undefined) => void | undefined;
     };
@@ -67,3 +67,3 @@ /**
         addUploadedDataListener: (listener: (parameters: uploadedData) => void) => void;
-        removeUploadedDataListener: () => void | undefined;
+        removeUploadedDataListener: (listener?: ((parameters: uploadedData) => void) | undefined) => void | undefined;
         /**
@@ -74,3 +74,3 @@ * Emitted during 'createSession' if all recording data has been received, but
         addAwaitingSourcemapsListener: (listener: (parameters: awaitingSourcemaps) => void) => void;
-        removeAwaitingSourcemapsListener: () => void | undefined;
+        removeAwaitingSourcemapsListener: (listener?: ((parameters: awaitingSourcemaps) => void) | undefined) => void | undefined;
         /**
@@ -80,8 +80,4 @@ * Emitted when a session has died due to a server side problem.
         addSessionErrorListener: (listener: (parameters: sessionError) => void) => void;
-        removeSessionErrorListener: () => void | undefined;
+        removeSessionErrorListener: (listener?: ((parameters: sessionError) => void) | undefined) => void | undefined;
         /**
-         * Get a description of a recording.
-         */
-        getDescription: (parameters: getDescriptionParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Recording").getDescriptionResult>;
-        /**
          * Create a session for inspecting a recording. This command does not return
@@ -179,3 +175,3 @@ * until the recording's contents have been fully received, unless
         addMayDestroyListener: (listener: (parameters: mayDestroy) => void) => void;
-        removeMayDestroyListener: () => void | undefined;
+        removeMayDestroyListener: (listener?: ((parameters: mayDestroy) => void) | undefined) => void | undefined;
         /**
@@ -198,3 +194,3 @@ * Notify clients if the backend expects to explicitly destroy a session with
         addWillDestroyListener: (listener: (parameters: willDestroy) => void) => void;
-        removeWillDestroyListener: () => void | undefined;
+        removeWillDestroyListener: (listener?: ((parameters: willDestroy) => void) | undefined) => void | undefined;
         /**
@@ -204,3 +200,3 @@ * Event describing regions of the recording that have not been uploaded.
         addMissingRegionsListener: (listener: (parameters: missingRegions) => void) => void;
-        removeMissingRegionsListener: () => void | undefined;
+        removeMissingRegionsListener: (listener?: ((parameters: missingRegions) => void) | undefined) => void | undefined;
         /**
@@ -210,3 +206,3 @@ * Event describing regions of the recording that have not been processed.
         addUnprocessedRegionsListener: (listener: (parameters: unprocessedRegions) => void) => void;
-        removeUnprocessedRegionsListener: () => void | undefined;
+        removeUnprocessedRegionsListener: (listener?: ((parameters: unprocessedRegions) => void) | undefined) => void | undefined;
         /**
@@ -216,3 +212,3 @@ * Describes some mouse events that occur in the recording.
         addMouseEventsListener: (listener: (parameters: mouseEvents) => void) => void;
-        removeMouseEventsListener: () => void | undefined;
+        removeMouseEventsListener: (listener?: ((parameters: mouseEvents) => void) | undefined) => void | undefined;
         /**
@@ -222,3 +218,3 @@ * Describes some keyboard events that occur in the recording.
         addKeyboardEventsListener: (listener: (parameters: keyboardEvents) => void) => void;
-        removeKeyboardEventsListener: () => void | undefined;
+        removeKeyboardEventsListener: (listener?: ((parameters: keyboardEvents) => void) | undefined) => void | undefined;
         /**
@@ -228,3 +224,3 @@ * Describes some navigate events that occur in the recording.
         addNavigationEventsListener: (listener: (parameters: navigationEvents) => void) => void;
-        removeNavigationEventsListener: () => void | undefined;
+        removeNavigationEventsListener: (listener?: ((parameters: navigationEvents) => void) | undefined) => void | undefined;
         /**
@@ -234,3 +230,3 @@ * Describes some annotations in the recording.
         addAnnotationsListener: (listener: (parameters: annotations) => void) => void;
-        removeAnnotationsListener: () => void | undefined;
+        removeAnnotationsListener: (listener?: ((parameters: annotations) => void) | undefined) => void | undefined;
         /**
@@ -240,3 +236,3 @@ * Describes the regions of the recording which are loading or loaded.
         addLoadedRegionsListener: (listener: (parameters: loadedRegions) => void) => void;
-        removeLoadedRegionsListener: () => void | undefined;
+        removeLoadedRegionsListener: (listener?: ((parameters: loadedRegions) => void) | undefined) => void | undefined;
         /**
@@ -246,3 +242,3 @@ * Placeholder event for metrics being emitted.
         addNewMetricListener: (listener: (parameters: newMetric) => void) => void;
-        removeNewMetricListener: () => void | undefined;
+        removeNewMetricListener: (listener?: ((parameters: newMetric) => void) | undefined) => void | undefined;
         /**
@@ -254,3 +250,3 @@ * An event indicating that something happened in a way that is not yet officially
         addExperimentalEventListener: (listener: (parameters: experimentalEvent) => void) => void;
-        removeExperimentalEventListener: () => void | undefined;
+        removeExperimentalEventListener: (listener?: ((parameters: experimentalEvent) => void) | undefined) => void | undefined;
         /**
@@ -357,3 +353,3 @@ * Does not return until the recording is fully processed. Before returning,
         addPaintPointsListener: (listener: (parameters: paintPoints) => void) => void;
-        removePaintPointsListener: () => void | undefined;
+        removePaintPointsListener: (listener?: ((parameters: paintPoints) => void) | undefined) => void | undefined;
         /**
@@ -364,3 +360,3 @@ * Describes the next fragment of playback video data, as part of the response
         addPlaybackVideoFragmentListener: (listener: (parameters: playbackVideoFragment) => void) => void;
-        removePlaybackVideoFragmentListener: () => void | undefined;
+        removePlaybackVideoFragmentListener: (listener?: ((parameters: playbackVideoFragment) => void) | undefined) => void | undefined;
         /**
@@ -402,7 +398,7 @@ * Find all points in the recording at which paints occurred. Does not return
         addNewSourceListener: (listener: (parameters: newSource) => void) => void;
-        removeNewSourceListener: () => void | undefined;
+        removeNewSourceListener: (listener?: ((parameters: newSource) => void) | undefined) => void | undefined;
         addSearchSourceContentsMatchesListener: (listener: (parameters: searchSourceContentsMatches) => void) => void;
-        removeSearchSourceContentsMatchesListener: () => void | undefined;
+        removeSearchSourceContentsMatchesListener: (listener?: ((parameters: searchSourceContentsMatches) => void) | undefined) => void | undefined;
         addFunctionsMatchesListener: (listener: (parameters: functionsMatches) => void) => void;
-        removeFunctionsMatchesListener: () => void | undefined;
+        removeFunctionsMatchesListener: (listener?: ((parameters: functionsMatches) => void) | undefined) => void | undefined;
         /**
@@ -504,3 +500,3 @@ * Find all sources in the recording. Does not return until the recording is
         addNewMessageListener: (listener: (parameters: newMessage) => void) => void;
-        removeNewMessageListener: () => void | undefined;
+        removeNewMessageListener: (listener?: ((parameters: newMessage) => void) | undefined) => void | undefined;
         /**
@@ -665,3 +661,3 @@ * Find all messages in the recording. Does not return until the recording is
         addAnalysisResultListener: (listener: (parameters: analysisResult) => void) => void;
-        removeAnalysisResultListener: () => void | undefined;
+        removeAnalysisResultListener: (listener?: ((parameters: analysisResult) => void) | undefined) => void | undefined;
         /**
@@ -673,3 +669,3 @@ * Describes an error that occurred when running an analysis mapper or reducer
         addAnalysisErrorListener: (listener: (parameters: analysisError) => void) => void;
-        removeAnalysisErrorListener: () => void | undefined;
+        removeAnalysisErrorListener: (listener?: ((parameters: analysisError) => void) | undefined) => void | undefined;
         /**
@@ -679,3 +675,3 @@ * Describes some points at which an analysis will run.
         addAnalysisPointsListener: (listener: (parameters: analysisPoints) => void) => void;
-        removeAnalysisPointsListener: () => void | undefined;
+        removeAnalysisPointsListener: (listener?: ((parameters: analysisPoints) => void) | undefined) => void | undefined;
         /**
@@ -745,3 +741,3 @@ * Start specifying a new analysis.
         addRequestBodyDataListener: (listener: (parameters: requestBodyData) => void) => void;
-        removeRequestBodyDataListener: () => void | undefined;
+        removeRequestBodyDataListener: (listener?: ((parameters: requestBodyData) => void) | undefined) => void | undefined;
         /**
@@ -752,3 +748,3 @@ * Emit data about a response body as it is processed.
         addResponseBodyDataListener: (listener: (parameters: responseBodyData) => void) => void;
-        removeResponseBodyDataListener: () => void | undefined;
+        removeResponseBodyDataListener: (listener?: ((parameters: responseBodyData) => void) | undefined) => void | undefined;
         /**
@@ -762,3 +758,3 @@ * Describe some requests that were dispatched by the recording.
         addRequestsListener: (listener: (parameters: requests) => void) => void;
-        removeRequestsListener: () => void | undefined;
+        removeRequestsListener: (listener?: ((parameters: requests) => void) | undefined) => void | undefined;
         /**
@@ -897,6 +893,2 @@ * Query the recording for all of the parts of this request body.
         /**
-         * Add metadata about a recording.
-         */
-        addRecordingDescription: (parameters: addRecordingDescriptionParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").addRecordingDescriptionResult>;
-        /**
          * Indicate that all data for the given recording has been sent and the recording
@@ -903,0 +895,0 @@ * can be marked ready and complete. If this is not sent, the recording will be

js/client/generic.d.ts

 import { CommandMethods, CommandParams, CommandResult, EventMethods, EventParams } from "../protocol";
 export interface GenericProtocolClient {
-    addEventListener<M extends EventMethods>(event: M, listener: (params: EventParams<M>) => void): void;
-    removeEventListener?(event: EventMethods): void;
-    sendCommand<M extends CommandMethods>(method: M, params: CommandParams<M>, sessionId?: string, pauseId?: string): Promise<CommandResult<M>>;
+    addEventListener: <M extends EventMethods>(event: M, listener: (params: EventParams<M>) => void) => void;
+    removeEventListener?: <M extends EventMethods>(event: M, listener?: (params: EventParams<M>) => void) => void;
+    sendCommand: <M extends CommandMethods>(method: M, params: CommandParams<M>, sessionId?: string, pauseId?: string) => Promise<CommandResult<M>>;
 }

js/client/index.js

@@ -5,3 +5,7 @@ "use strict";
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -8,0 +12,0 @@ if (k2 === undefined) k2 = k;

js/client/simple.d.ts

@@ -30,3 +30,3 @@ import { CommandMethods, CommandParams, CommandResult, EventMethods, EventParams } from "../protocol";
     addEventListener<M extends EventMethods>(event: M, listener: (params: EventParams<M>) => void): void;
-    removeEventListener(event: EventMethods): void;
+    removeEventListener<M extends EventMethods>(event: M, listener?: (params: EventParams<M>) => void): void;
     sendCommand<M extends CommandMethods>(method: M, params: CommandParams<M>, sessionId?: string, pauseId?: string): Promise<CommandResult<M>>;
@@ -33,0 +33,0 @@ private onMessage;

js/client/simple.js

@@ -64,3 +64,6 @@ "use strict";
     };
-    SimpleProtocolClient.prototype.removeEventListener = function (event) {
+    SimpleProtocolClient.prototype.removeEventListener = function (event, listener) {
+        if (listener && listener !== this.eventListeners[event]) {
+            return;
+        }
         delete this.eventListeners[event];
@@ -102,3 +105,3 @@ };
             else {
-                this.log("No handler for event: " + JSON.stringify(msg));
+                this.log("No handler for event: ".concat(JSON.stringify(msg)));
             }
@@ -105,0 +108,0 @@ }

js/index.js

@@ -5,3 +5,7 @@ "use strict";
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -8,0 +12,0 @@ if (k2 === undefined) k2 = k;

js/protocol/index.d.ts

@@ -17,3 +17,3 @@ export * from "./Connection";
 import { mayDisconnect, willDisconnect } from "./Connection";
-import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, getDescriptionResult, createSessionParameters, createSessionResult, releaseSessionParameters, releaseSessionResult, processRecordingParameters, processRecordingResult, addSourceMapParameters, addSourceMapResult, addOriginalSourceParameters, addOriginalSourceResult } from "./Recording";
+import { uploadedData, awaitingSourcemaps, sessionError, createSessionParameters, createSessionResult, releaseSessionParameters, releaseSessionResult, processRecordingParameters, processRecordingResult, addSourceMapParameters, addSourceMapResult, addOriginalSourceParameters, addOriginalSourceResult } from "./Recording";
 import { tokenParameters, tokenResult, existsParameters, existsResult, createParameters, createResult } from "./Resource";
@@ -31,3 +31,3 @@ import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
 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 { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, finishRecordingParameters, finishRecordingResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, reportCrashParameters, reportCrashResult } from "./Internal";
+import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, finishRecordingParameters, finishRecordingResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, reportCrashParameters, reportCrashResult } from "./Internal";
 interface Events {
@@ -291,12 +291,2 @@ /**
     /**
-     * Get a description of a recording.
-     */
-    "Recording.getDescription": {
-        parameters: getDescriptionParameters;
-        result: getDescriptionResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
      * Create a session for inspecting a recording. This command does not return
@@ -1469,12 +1459,2 @@ * until the recording's contents have been fully received, unless
     /**
-     * Add metadata about a recording.
-     */
-    "Internal.addRecordingDescription": {
-        parameters: addRecordingDescriptionParameters;
-        result: addRecordingDescriptionResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
      * Indicate that all data for the given recording has been sent and the recording
@@ -1481,0 +1461,0 @@ * can be marked ready and complete. If this is not sent, the recording will be

js/protocol/index.js

 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
@@ -6,0 +10,0 @@ if (k2 === undefined) k2 = k;

js/protocol/Internal.d.ts

@@ -1,2 +0,2 @@
-import { RecordingId, BuildId, TimeStamp } from "./Recording";
+import { RecordingId, BuildId } from "./Recording";
 /**
@@ -76,22 +76,2 @@ * Metadata that can be associated with a recording.
 }
-export interface addRecordingDescriptionParameters {
-    /**
-     * ID of the recording being described.
-     */
-    recordingId: RecordingId;
-    /**
-     * Total byte length of the recording.
-     */
-    length: number;
-    /**
-     * Duration of the entire recording.
-     */
-    duration: TimeStamp;
-    /**
-     * Any command line arguments associated with the recording.
-     */
-    commandLineArguments?: string[];
-}
-export interface addRecordingDescriptionResult {
-}
 export interface finishRecordingParameters {
@@ -98,0 +78,0 @@ /**

js/protocol/Recording.d.ts

@@ -132,18 +132,2 @@ import { SessionId } from "./Session";
 export declare type SourceMapTargetHash = string;
-export interface getDescriptionParameters {
-    /**
-     * Recording to get the description for.
-     */
-    recordingId: RecordingId;
-}
-export interface getDescriptionResult {
-    /**
-     * Duration of the recording.
-     */
-    duration: TimeStamp;
-    /**
-     * Byte length of the recording.
-     */
-    length: number;
-}
 export interface createSessionParameters {
@@ -150,0 +134,0 @@ /**

package.json

 {
   "name": "@replayio/protocol",
-  "version": "0.31.0",
+  "version": "0.31.1",
   "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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

505053

decreased by-0.4%

Lines of code

11768

decreased by-0.96%

No dependency changes