@recordreplay/protocol - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

js/client/build/client.d.ts

@@ -1,2 +0,2 @@
-import { metadataChange, uploadedData, sessionError, getDescriptionParameters, getMetadataParameters, setMetadataParameters, metadataStartListeningParameters, metadataStopListeningParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters } from "../../protocol/Recording";
+import { uploadedData, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters } from "../../protocol/Recording";
 import { setAccessTokenParameters } from "../../protocol/Authentication";
@@ -22,7 +22,2 @@ import { missingRegions, unprocessedRegions, mouseEvents, loadedRegions, ensureProcessedParameters, findMouseEventsParameters, getEndpointParameters, createPauseParameters, releasePauseParameters, listenForLoadChangesParameters, loadRegionParameters, unloadRegionParameters } from "../../protocol/Session";
         /**
-         * Describes a change to an entry in a recording's metadata.
-         */
-        addMetadataChangeListener: (listener: (parameters: metadataChange) => void) => void;
-        removeMetadataChangeListener: () => void | undefined;
-        /**
          * Describes how much of a recording's data has been uploaded to the cloud service.
@@ -42,20 +37,2 @@ */
         /**
-         * Get an entry in a recording's metadata key/value store.
-         */
-        getMetadata: (parameters: getMetadataParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Recording").getMetadataResult>;
-        /**
-         * Set an entry in a recording's metadata.
-         */
-        setMetadata: (parameters: setMetadataParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Recording").setMetadataResult>;
-        /**
-         * Listen for changes to an entry in a recording's metadata. When listening,
-         * <code>metadataChange</code> events will be emitted whenever the entry's
-         * value changes.
-         */
-        metadataStartListening: (parameters: metadataStartListeningParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Recording").metadataStartListeningResult>;
-        /**
-         * Stop listening for changes to an entry in a recording's metadata.
-         */
-        metadataStopListening: (parameters: metadataStopListeningParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Recording").metadataStopListeningResult>;
-        /**
          * Create a session for inspecting a recording. This command does not return
@@ -419,4 +396,3 @@ * until the recording's contents have been fully received. If the contents
      *
-     * <br><br>Currently, analyses can only be applied to one session/recording.
-     * This restriction will be relaxed in the future.
+     * <br><br>All commands and events in this domain must include a <code>sessionId</code>.
      */
@@ -482,3 +458,2 @@ Analysis: {
          * are found. Does not return until events for all points have been emitted.
-         * Can only be used after the analysis has started running.
          */
@@ -485,0 +460,0 @@ findAnalysisPoints: (parameters: findAnalysisPointsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Analysis").findAnalysisPointsResult>;

js/client/build/client.js

@@ -13,9 +13,2 @@ "use strict";
             /**
-             * Describes a change to an entry in a recording's metadata.
-             */
-            addMetadataChangeListener: function (listener) {
-                return _this.genericClient.addEventListener("Recording.metadataChange", listener);
-            },
-            removeMetadataChangeListener: function () { var _a, _b; return (_b = (_a = _this.genericClient).removeEventListener) === null || _b === void 0 ? void 0 : _b.call(_a, "Recording.metadataChange"); },
-            /**
              * Describes how much of a recording's data has been uploaded to the cloud service.
@@ -41,28 +34,2 @@ */
             /**
-             * Get an entry in a recording's metadata key/value store.
-             */
-            getMetadata: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Recording.getMetadata", parameters, sessionId, pauseId);
-            },
-            /**
-             * Set an entry in a recording's metadata.
-             */
-            setMetadata: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Recording.setMetadata", parameters, sessionId, pauseId);
-            },
-            /**
-             * Listen for changes to an entry in a recording's metadata. When listening,
-             * <code>metadataChange</code> events will be emitted whenever the entry's
-             * value changes.
-             */
-            metadataStartListening: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Recording.metadataStartListening", parameters, sessionId, pauseId);
-            },
-            /**
-             * Stop listening for changes to an entry in a recording's metadata.
-             */
-            metadataStopListening: function (parameters, sessionId, pauseId) {
-                return _this.genericClient.sendCommand("Recording.metadataStopListening", parameters, sessionId, pauseId);
-            },
-            /**
              * Create a session for inspecting a recording. This command does not return
@@ -544,4 +511,3 @@ * until the recording's contents have been fully received. If the contents
          *
-         * <br><br>Currently, analyses can only be applied to one session/recording.
-         * This restriction will be relaxed in the future.
+         * <br><br>All commands and events in this domain must include a <code>sessionId</code>.
          */
@@ -629,3 +595,2 @@ this.Analysis = {
              * are found. Does not return until events for all points have been emitted.
-             * Can only be used after the analysis has started running.
              */
@@ -632,0 +597,0 @@ findAnalysisPoints: function (parameters, sessionId, pauseId) {

js/protocol/Analysis.d.ts

 import { TimeStampedPoint, ExecutionPoint } from "./Recording";
-import { SessionId } from "./Session";
 import { PauseId } from "./Pause";
@@ -14,6 +13,2 @@ import { PointDescription, Location, SourceId, SourceLocation } from "./Debugger";
     /**
-     * Associated session ID for the current execution point.
-     */
-    sessionId: SessionId;
-    /**
      * Pause ID created for the current execution point.
@@ -83,6 +78,2 @@ */
     /**
-     * Session containing the source.
-     */
-    sessionId: SessionId;
-    /**
      * Location to apply the analysis to.
@@ -105,6 +96,2 @@ */
     /**
-     * Associated session.
-     */
-    sessionId: SessionId;
-    /**
      * Source to look for function entry points in.
@@ -130,6 +117,2 @@ */
     /**
-     * Associated session.
-     */
-    sessionId: SessionId;
-    /**
      * Maximum number of points to apply the analysis to.
@@ -147,6 +130,2 @@ */
     /**
-     * Associated session.
-     */
-    sessionId: SessionId;
-    /**
      * Type of event whose handler calls the analysis should be applied to.
@@ -163,6 +142,2 @@ */
     analysisId: AnalysisId;
-    /**
-     * Associated session.
-     */
-    sessionId: SessionId;
 }
@@ -169,0 +144,0 @@ export interface addExceptionPointsResult {

js/protocol/index.d.ts

@@ -13,3 +13,3 @@ export * from "./Recording";
 export * from "./Internal";
-import { metadataChange, uploadedData, sessionError, getDescriptionParameters, getDescriptionResult, getMetadataParameters, getMetadataResult, setMetadataParameters, setMetadataResult, metadataStartListeningParameters, metadataStartListeningResult, metadataStopListeningParameters, metadataStopListeningResult, createSessionParameters, createSessionResult, releaseSessionParameters, releaseSessionResult, processRecordingParameters, processRecordingResult } from "./Recording";
+import { uploadedData, sessionError, getDescriptionParameters, getDescriptionResult, createSessionParameters, createSessionResult, releaseSessionParameters, releaseSessionResult, processRecordingParameters, processRecordingResult } from "./Recording";
 import { setAccessTokenParameters, setAccessTokenResult } from "./Authentication";
@@ -28,9 +28,2 @@ import { missingRegions, unprocessedRegions, mouseEvents, loadedRegions, ensureProcessedParameters, ensureProcessedResult, findMouseEventsParameters, findMouseEventsResult, getEndpointParameters, getEndpointResult, createPauseParameters, createPauseResult, releasePauseParameters, releasePauseResult, listenForLoadChangesParameters, listenForLoadChangesResult, loadRegionParameters, loadRegionResult, unloadRegionParameters, unloadRegionResult } from "./Session";
     /**
-     * Describes a change to an entry in a recording's metadata.
-     */
-    "Recording.metadataChange": {
-        parameters: metadataChange;
-        sessionId: false;
-    };
-    /**
      * Describes how much of a recording's data has been uploaded to the cloud service.
@@ -104,3 +97,3 @@ */
         parameters: analysisResult;
-        sessionId: false;
+        sessionId: true;
     };
@@ -114,3 +107,3 @@ /**
         parameters: analysisError;
-        sessionId: false;
+        sessionId: true;
     };
@@ -122,3 +115,3 @@ /**
         parameters: analysisPoints;
-        sessionId: false;
+        sessionId: true;
     };
@@ -141,44 +134,2 @@ }
     /**
-     * Get an entry in a recording's metadata key/value store.
-     */
-    "Recording.getMetadata": {
-        parameters: getMetadataParameters;
-        result: getMetadataResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
-     * Set an entry in a recording's metadata.
-     */
-    "Recording.setMetadata": {
-        parameters: setMetadataParameters;
-        result: setMetadataResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
-     * Listen for changes to an entry in a recording's metadata. When listening,
-     * <code>metadataChange</code> events will be emitted whenever the entry's
-     * value changes.
-     */
-    "Recording.metadataStartListening": {
-        parameters: metadataStartListeningParameters;
-        result: metadataStartListeningResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
-     * Stop listening for changes to an entry in a recording's metadata.
-     */
-    "Recording.metadataStopListening": {
-        parameters: metadataStopListeningParameters;
-        result: metadataStopListeningResult;
-        sessionId: false;
-        pauseId: false;
-        binary: false;
-    };
-    /**
      * Create a session for inspecting a recording. This command does not return
@@ -743,3 +694,3 @@ * until the recording's contents have been fully received. If the contents
         result: createAnalysisResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -754,3 +705,3 @@ binary: false;
         result: addLocationResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -765,3 +716,3 @@ binary: false;
         result: addFunctionEntryPointsResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -776,3 +727,3 @@ binary: false;
         result: addRandomPointsResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -787,3 +738,3 @@ binary: false;
         result: addEventHandlerEntryPointsResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -798,3 +749,3 @@ binary: false;
         result: addExceptionPointsResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -812,3 +763,3 @@ binary: false;
         result: runAnalysisResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -825,3 +776,3 @@ binary: false;
         result: releaseAnalysisResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -834,3 +785,2 @@ binary: false;
      * are found. Does not return until events for all points have been emitted.
-     * Can only be used after the analysis has started running.
      */
@@ -840,3 +790,3 @@ "Analysis.findAnalysisPoints": {
         result: findAnalysisPointsResult;
-        sessionId: false;
+        sessionId: true;
         pauseId: false;
@@ -843,0 +793,0 @@ binary: false;

js/protocol/Recording.d.ts

@@ -84,79 +84,2 @@ import { SessionId } from "./Session";
 }
-export interface getMetadataParameters {
-    /**
-     * Associated recording ID.
-     */
-    recordingId: RecordingId;
-    /**
-     * Key for the metadata being accessed.
-     */
-    key: string;
-}
-export interface getMetadataResult {
-    /**
-     * Any value associated with the recording and key.
-     */
-    value?: string;
-}
-export interface setMetadataParameters {
-    /**
-     * Associated recording ID.
-     */
-    recordingId: RecordingId;
-    /**
-     * Key for the entry being set.
-     */
-    key: string;
-    /**
-     * Value to associate with the recording and key, omitted to delete the
-     * key's entry.
-     */
-    newValue?: string;
-    /**
-     * Expected current value for the key's entry.
-     */
-    oldValue?: string;
-}
-export interface setMetadataResult {
-    /**
-     * Whether the assignment was performed. The assignment will not be
-     * performed if the <code>oldValue</code> parameter did not match the
-     * current value of the key's entry.
-     */
-    updated: boolean;
-    /**
-     * Current value of the key's entry. If the update was performed, this
-     * equals the <code>newValue</code> parameter. Otherwise, this will <b>not</b>
-     * equal the <code>oldValue</code> parameter.
-     */
-    currentValue?: string;
-}
-export interface metadataStartListeningParameters {
-    /**
-     * Associated recording ID.
-     */
-    recordingId: RecordingId;
-    /**
-     * Key for the metadata entry to listen to.
-     */
-    key: string;
-}
-export interface metadataStartListeningResult {
-    /**
-     * Current value for the entry, as for <code>getMetadata</code>.
-     */
-    value?: string;
-}
-export interface metadataStopListeningParameters {
-    /**
-     * Associated recording ID.
-     */
-    recordingId: RecordingId;
-    /**
-     * Key for the metadata entry to listen to.
-     */
-    key: string;
-}
-export interface metadataStopListeningResult {
-}
 export interface createSessionParameters {
@@ -188,19 +111,2 @@ /**
 /**
- * Describes a change to an entry in a recording's metadata.
- */
-export interface metadataChange {
-    /**
-     * Associated recording ID.
-     */
-    recordingId: RecordingId;
-    /**
-     * Key for the metadata entry which changed.
-     */
-    key: string;
-    /**
-     * New value of the metadata entry.
-     */
-    newValue?: string;
-}
-/**
  * Describes how much of a recording's data has been uploaded to the cloud service.
@@ -207,0 +113,0 @@ */

package.json

 {
   "name": "@recordreplay/protocol",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Definition of the protocol used by the Record Replay web service",
@@ -5,0 +5,0 @@ "author": "",

README.md

@@ -6,3 +6,3 @@ # Protocol
 
-Publishing a new version of the protocol to NPM is as simple as bumping the version, logging in, and publishing. 
+Publishing a new version of the protocol to NPM is as simple as bumping the version, logging in, and publishing. To bump the version, change "version" in package.json and package-lock.json.
 
@@ -9,0 +9,0 @@ ```

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

180054

decreased by-4.33%

Lines of code

4685

decreased by-4.7%

No dependency changes