@atlaskit/editor-plugin-collab-edit 3.9.0 → 3.9.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 3.9.1
+
+### Patch Changes
+
+- [#161924](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/161924)
+  [`ff6dfb15ac9cf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ff6dfb15ac9cf) -
+  [EDITOR 752] Add Tests
+- Updated dependencies
+
 ## 3.9.0
 
 ### Minor Changes

package/dist/cjs/pm-plugins/actions.js

@@ -11,8 +11,7 @@ var _state = require("@atlaskit/editor-prosemirror/state");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
 var _utils = require("./utils");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 // Ignored via go/ees005
 // eslint-disable-next-line import/no-namespace
 

package/dist/cjs/pm-plugins/main/index.js

@@ -14,8 +14,7 @@ var _analytics2 = require("../analytics");
 var _initialize = require("../events/initialize");
 var _pluginKey = require("./plugin-key");
 var _pluginState = require("./plugin-state");
-function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
-function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 // It is important to get all steps in that package
 
 // Ignored via go/ees005

package/dist/cjs/pm-plugins/track-step-metrics.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateStepSessionMetrics = void 0;
+exports.updateStepSessionMetrics = exports.updateActiveSessions = exports.getStepSessionMetrics = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _frontendUtilities = require("@atlaskit/frontend-utilities");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -23,7 +23,7 @@ var storageClient = new _frontendUtilities.StorageClient(STORAGE_CLIENT_KEY);
  * @param steps - The steps to calculate the metrics from.
  * @returns The updated step session metrics for the given session ID.
  */
-var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, steps) {
+var getStepSessionMetrics = exports.getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, steps) {
   var _metrics$sessionId;
   var current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
     totalStepSize: 0,
@@ -51,8 +51,8 @@ var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, s
  * @param sessionId - The session ID to check or update in local storage.
  * @returns void
  */
-var updateActiveSessions = function updateActiveSessions(sessionId) {
-  var currentActiveSessions = JSON.parse(storageClient.getItem('activeSessions') || '{}');
+var updateActiveSessions = exports.updateActiveSessions = function updateActiveSessions(sessionId) {
+  var currentActiveSessions = JSON.parse(storageClient.getItem('ncsActiveSessions') || '{}');
   if (!currentActiveSessions[sessionId]) {
     storageClient.setItemWithExpiry('ncsActiveSessions', JSON.stringify(_objectSpread(_objectSpread({}, currentActiveSessions), {}, (0, _defineProperty2.default)({}, sessionId, true))));
   }

package/dist/es2019/pm-plugins/track-step-metrics.js

@@ -13,7 +13,7 @@ const storageClient = new StorageClient(STORAGE_CLIENT_KEY);
  * @param steps - The steps to calculate the metrics from.
  * @returns The updated step session metrics for the given session ID.
  */
-const getStepSessionMetrics = (metrics, sessionId, steps) => {
+export const getStepSessionMetrics = (metrics, sessionId, steps) => {
   var _metrics$sessionId;
   const current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
     totalStepSize: 0,
@@ -41,8 +41,8 @@ const getStepSessionMetrics = (metrics, sessionId, steps) => {
  * @param sessionId - The session ID to check or update in local storage.
  * @returns void
  */
-const updateActiveSessions = sessionId => {
-  const currentActiveSessions = JSON.parse(storageClient.getItem('activeSessions') || '{}');
+export const updateActiveSessions = sessionId => {
+  const currentActiveSessions = JSON.parse(storageClient.getItem('ncsActiveSessions') || '{}');
   if (!currentActiveSessions[sessionId]) {
     storageClient.setItemWithExpiry('ncsActiveSessions', JSON.stringify({
       ...currentActiveSessions,

package/dist/esm/pm-plugins/track-step-metrics.js

@@ -16,7 +16,7 @@ var storageClient = new StorageClient(STORAGE_CLIENT_KEY);
  * @param steps - The steps to calculate the metrics from.
  * @returns The updated step session metrics for the given session ID.
  */
-var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, steps) {
+export var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, steps) {
   var _metrics$sessionId;
   var current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
     totalStepSize: 0,
@@ -44,8 +44,8 @@ var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, s
  * @param sessionId - The session ID to check or update in local storage.
  * @returns void
  */
-var updateActiveSessions = function updateActiveSessions(sessionId) {
-  var currentActiveSessions = JSON.parse(storageClient.getItem('activeSessions') || '{}');
+export var updateActiveSessions = function updateActiveSessions(sessionId) {
+  var currentActiveSessions = JSON.parse(storageClient.getItem('ncsActiveSessions') || '{}');
   if (!currentActiveSessions[sessionId]) {
     storageClient.setItemWithExpiry('ncsActiveSessions', JSON.stringify(_objectSpread(_objectSpread({}, currentActiveSessions), {}, _defineProperty({}, sessionId, true))));
   }

package/dist/types/pm-plugins/track-step-metrics.d.ts

@@ -1,6 +1,37 @@
 import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import { CollabEditPlugin } from '../collabEditPluginType';
+type StepSessionMetrics = {
+    totalStepSize: number;
+    numberOfSteps: number;
+    maxStepSize: number;
+    stepSizeSumForP90: number[];
+};
+/**
+ * Gets the current step session metrics for a given session ID
+ * If the session ID does not exist, it initializes a new metrics object.
+ * It calculates the total size of the steps, the number of steps,
+ * the maximum step size, and the sum of step sizes for P90 calculation.
+ *
+ * @param metrics - The existing metrics object from local storage.
+ * @param sessionId - The session ID for which to get the metrics.
+ * @param steps - The steps to calculate the metrics from.
+ * @returns The updated step session metrics for the given session ID.
+ */
+export declare const getStepSessionMetrics: (metrics: {
+    [sessionId: string]: StepSessionMetrics;
+}, sessionId: string, steps: Step[]) => StepSessionMetrics;
+/**
+ * Gets the current active sessions from local storage
+ * If the session ID does not exist, it initializes a new active session.
+ *
+ * This is used in the ncsStepMetricsPlugin to determine if the session is still active
+ * before sending the ncs steps analytics event.
+ *
+ * @param sessionId - The session ID to check or update in local storage.
+ * @returns void
+ */
+export declare const updateActiveSessions: (sessionId: string) => void;
 type UpdateStepSessionMetricProps = {
     api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
     steps: Step[];

package/dist/types-ts4.5/pm-plugins/track-step-metrics.d.ts

@@ -1,6 +1,37 @@
 import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import { Step } from '@atlaskit/editor-prosemirror/transform';
+import type { Step } from '@atlaskit/editor-prosemirror/transform';
 import { CollabEditPlugin } from '../collabEditPluginType';
+type StepSessionMetrics = {
+    totalStepSize: number;
+    numberOfSteps: number;
+    maxStepSize: number;
+    stepSizeSumForP90: number[];
+};
+/**
+ * Gets the current step session metrics for a given session ID
+ * If the session ID does not exist, it initializes a new metrics object.
+ * It calculates the total size of the steps, the number of steps,
+ * the maximum step size, and the sum of step sizes for P90 calculation.
+ *
+ * @param metrics - The existing metrics object from local storage.
+ * @param sessionId - The session ID for which to get the metrics.
+ * @param steps - The steps to calculate the metrics from.
+ * @returns The updated step session metrics for the given session ID.
+ */
+export declare const getStepSessionMetrics: (metrics: {
+    [sessionId: string]: StepSessionMetrics;
+}, sessionId: string, steps: Step[]) => StepSessionMetrics;
+/**
+ * Gets the current active sessions from local storage
+ * If the session ID does not exist, it initializes a new active session.
+ *
+ * This is used in the ncsStepMetricsPlugin to determine if the session is still active
+ * before sending the ncs steps analytics event.
+ *
+ * @param sessionId - The session ID to check or update in local storage.
+ * @returns void
+ */
+export declare const updateActiveSessions: (sessionId: string) => void;
 type UpdateStepSessionMetricProps = {
     api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
     steps: Step[];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "3.9.0",
+	"version": "3.9.1",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",