@atlaskit/editor-plugin-collab-edit 23.0.0 → 23.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "23.0.0",
+	"version": "23.0.2",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,17 +28,16 @@
 		"@atlaskit/editor-plugin-feature-flags": "^21.0.0",
 		"@atlaskit/editor-prosemirror": "^9.0.0",
 		"@atlaskit/editor-shared-styles": "^4.3.0",
-		"@atlaskit/frontend-utilities": "^5.0.0",
 		"@atlaskit/platform-feature-experiments": "^0.3.0",
 		"@atlaskit/platform-feature-flags": "^2.2.0",
 		"@atlaskit/prosemirror-collab": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^209.0.0",
-		"@atlaskit/tokens": "^20.0.0",
+		"@atlaskit/tmp-editor-statsig": "^211.0.0",
+		"@atlaskit/tokens": "^20.1.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^126.0.0",
+		"@atlaskit/editor-common": "^126.1.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0"
 	},
@@ -49,6 +48,10 @@
 		"wait-for-expect": "^1.2.0"
 	},
 	"platform-feature-flags": {
+		"platform_editor_ai_collapse_streaming_steps": {
+			"type": "boolean",
+			"referenceOnly": true
+		},
 		"confluence_ncs_step_diffing_version_history": {
 			"type": "boolean",
 			"referenceOnly": true

package/tsconfig.typecheck-typecheck-dev.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"7.0.2","errors":true,"root":["./docs/0-intro.tsx"],"packageJsons":["../../../../node_modules/@types/prop-types/package.json","../../../../node_modules/@types/react/package.json","../../../../node_modules/csstype/package.json","../../../../node_modules/prop-types/package.json","../../../../node_modules/react/package.json","../../../build/website/docs/package.json","../../design-system/tokens/package.json","../editor-common/package.json","./package.json"],"missingPackageJsons":["../../../../node_modules/@atlaskit/editor-common/doc-utils/package.json","../../../node_modules/@atlaskit/docs/package.json","../../../node_modules/@atlaskit/editor-common/doc-utils/package.json","../../../node_modules/@atlaskit/editor-common/package.json","../../../node_modules/@atlaskit/tokens/package.json","../../../node_modules/react/package.json"]}

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

@@ -1,82 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.updateNcsSessionStepMetrics = exports.updateNcsActiveSessions = exports.getNcsSessionStepMetrics = void 0;
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-var _ncsStepMetrics = require("@atlaskit/editor-common/ncs-step-metrics");
-var _StorageClient = require("@atlaskit/frontend-utilities/StorageClient");
-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; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-var storageClient = new _StorageClient.StorageClient(_ncsStepMetrics.NCS_STORAGE.NCS_STORAGE_CLIENT_KEY);
-
-/**
- * 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.
- */
-var getNcsSessionStepMetrics = exports.getNcsSessionStepMetrics = function getNcsSessionStepMetrics(metrics, sessionId, steps) {
-  var _metrics$sessionId;
-  var current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
-    ncsSessionId: sessionId,
-    totalStepSize: 0,
-    numberOfSteps: 0,
-    maxStepSize: 0,
-    stepSizeSumForP90: []
-  };
-  steps.forEach(function (step) {
-    var stepSize = JSON.stringify(step).length;
-    current.totalStepSize += stepSize;
-    current.numberOfSteps += 1;
-    current.maxStepSize = Math.max(current.maxStepSize, stepSize || 0);
-    current.stepSizeSumForP90.push(stepSize || 0);
-  });
-  return current;
-};
-
-/**
- * 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
- */
-var updateNcsActiveSessions = exports.updateNcsActiveSessions = function updateNcsActiveSessions(sessionId) {
-  var currentActiveSessions = JSON.parse(storageClient.getItem(_ncsStepMetrics.NCS_STORAGE.NCS_ACTIVE_SESSIONS) || '{}');
-  if (!currentActiveSessions[sessionId]) {
-    storageClient.setItemWithExpiry(_ncsStepMetrics.NCS_STORAGE.NCS_ACTIVE_SESSIONS, JSON.stringify(_objectSpread(_objectSpread({}, currentActiveSessions), {}, (0, _defineProperty2.default)({}, sessionId, true))));
-  }
-};
-// delete this function when cleaning up platform_editor_remove_collab_step_metrics
-/**
- * Updates the step session metrics in local storage for a given session ID.
- * It calculates the metrics based on the provided steps and updates the storage.
- *
- * @param api - The API to access the collab edit plugin.
- * @param steps - The steps to calculate the metrics from.
- * @return void
- */
-var updateNcsSessionStepMetrics = exports.updateNcsSessionStepMetrics = function updateNcsSessionStepMetrics(_ref) {
-  var _api$collabEdit;
-  var api = _ref.api,
-    steps = _ref.steps;
-  var sessionId = api === null || api === void 0 || (_api$collabEdit = api.collabEdit) === null || _api$collabEdit === void 0 || (_api$collabEdit = _api$collabEdit.sharedState.currentState()) === null || _api$collabEdit === void 0 ? void 0 : _api$collabEdit.sessionId;
-  if (!sessionId) {
-    return;
-  }
-  var existingMetrics = JSON.parse(storageClient.getItem(_ncsStepMetrics.NCS_STORAGE.NCS_SESSION_STEP_METRICS) || '{}');
-  var ncsSessionStepMetrics = getNcsSessionStepMetrics(existingMetrics, sessionId, steps);
-  storageClient.setItemWithExpiry(_ncsStepMetrics.NCS_STORAGE.NCS_SESSION_STEP_METRICS, JSON.stringify(_objectSpread(_objectSpread({}, existingMetrics), {}, (0, _defineProperty2.default)({}, sessionId, ncsSessionStepMetrics))));
-  updateNcsActiveSessions(sessionId);
-};

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

@@ -1,79 +0,0 @@
-import { NCS_STORAGE } from '@atlaskit/editor-common/ncs-step-metrics';
-import { StorageClient } from '@atlaskit/frontend-utilities/StorageClient';
-const storageClient = new StorageClient(NCS_STORAGE.NCS_STORAGE_CLIENT_KEY);
-
-/**
- * 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 const getNcsSessionStepMetrics = (metrics, sessionId, steps) => {
-  var _metrics$sessionId;
-  const current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
-    ncsSessionId: sessionId,
-    totalStepSize: 0,
-    numberOfSteps: 0,
-    maxStepSize: 0,
-    stepSizeSumForP90: []
-  };
-  steps.forEach(step => {
-    const stepSize = JSON.stringify(step).length;
-    current.totalStepSize += stepSize;
-    current.numberOfSteps += 1;
-    current.maxStepSize = Math.max(current.maxStepSize, stepSize || 0);
-    current.stepSizeSumForP90.push(stepSize || 0);
-  });
-  return current;
-};
-
-/**
- * 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 const updateNcsActiveSessions = sessionId => {
-  const currentActiveSessions = JSON.parse(storageClient.getItem(NCS_STORAGE.NCS_ACTIVE_SESSIONS) || '{}');
-  if (!currentActiveSessions[sessionId]) {
-    storageClient.setItemWithExpiry(NCS_STORAGE.NCS_ACTIVE_SESSIONS, JSON.stringify({
-      ...currentActiveSessions,
-      [sessionId]: true
-    }));
-  }
-};
-// delete this function when cleaning up platform_editor_remove_collab_step_metrics
-/**
- * Updates the step session metrics in local storage for a given session ID.
- * It calculates the metrics based on the provided steps and updates the storage.
- *
- * @param api - The API to access the collab edit plugin.
- * @param steps - The steps to calculate the metrics from.
- * @return void
- */
-export const updateNcsSessionStepMetrics = ({
-  api,
-  steps
-}) => {
-  var _api$collabEdit, _api$collabEdit$share;
-  const sessionId = api === null || api === void 0 ? void 0 : (_api$collabEdit = api.collabEdit) === null || _api$collabEdit === void 0 ? void 0 : (_api$collabEdit$share = _api$collabEdit.sharedState.currentState()) === null || _api$collabEdit$share === void 0 ? void 0 : _api$collabEdit$share.sessionId;
-  if (!sessionId) {
-    return;
-  }
-  const existingMetrics = JSON.parse(storageClient.getItem(NCS_STORAGE.NCS_SESSION_STEP_METRICS) || '{}');
-  const ncsSessionStepMetrics = getNcsSessionStepMetrics(existingMetrics, sessionId, steps);
-  storageClient.setItemWithExpiry(NCS_STORAGE.NCS_SESSION_STEP_METRICS, JSON.stringify({
-    ...existingMetrics,
-    [sessionId]: ncsSessionStepMetrics
-  }));
-  updateNcsActiveSessions(sessionId);
-};

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

@@ -1,75 +0,0 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-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; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-import { NCS_STORAGE } from '@atlaskit/editor-common/ncs-step-metrics';
-import { StorageClient } from '@atlaskit/frontend-utilities/StorageClient';
-var storageClient = new StorageClient(NCS_STORAGE.NCS_STORAGE_CLIENT_KEY);
-
-/**
- * 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 var getNcsSessionStepMetrics = function getNcsSessionStepMetrics(metrics, sessionId, steps) {
-  var _metrics$sessionId;
-  var current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
-    ncsSessionId: sessionId,
-    totalStepSize: 0,
-    numberOfSteps: 0,
-    maxStepSize: 0,
-    stepSizeSumForP90: []
-  };
-  steps.forEach(function (step) {
-    var stepSize = JSON.stringify(step).length;
-    current.totalStepSize += stepSize;
-    current.numberOfSteps += 1;
-    current.maxStepSize = Math.max(current.maxStepSize, stepSize || 0);
-    current.stepSizeSumForP90.push(stepSize || 0);
-  });
-  return current;
-};
-
-/**
- * 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 var updateNcsActiveSessions = function updateNcsActiveSessions(sessionId) {
-  var currentActiveSessions = JSON.parse(storageClient.getItem(NCS_STORAGE.NCS_ACTIVE_SESSIONS) || '{}');
-  if (!currentActiveSessions[sessionId]) {
-    storageClient.setItemWithExpiry(NCS_STORAGE.NCS_ACTIVE_SESSIONS, JSON.stringify(_objectSpread(_objectSpread({}, currentActiveSessions), {}, _defineProperty({}, sessionId, true))));
-  }
-};
-// delete this function when cleaning up platform_editor_remove_collab_step_metrics
-/**
- * Updates the step session metrics in local storage for a given session ID.
- * It calculates the metrics based on the provided steps and updates the storage.
- *
- * @param api - The API to access the collab edit plugin.
- * @param steps - The steps to calculate the metrics from.
- * @return void
- */
-export var updateNcsSessionStepMetrics = function updateNcsSessionStepMetrics(_ref) {
-  var _api$collabEdit;
-  var api = _ref.api,
-    steps = _ref.steps;
-  var sessionId = api === null || api === void 0 || (_api$collabEdit = api.collabEdit) === null || _api$collabEdit === void 0 || (_api$collabEdit = _api$collabEdit.sharedState.currentState()) === null || _api$collabEdit === void 0 ? void 0 : _api$collabEdit.sessionId;
-  if (!sessionId) {
-    return;
-  }
-  var existingMetrics = JSON.parse(storageClient.getItem(NCS_STORAGE.NCS_SESSION_STEP_METRICS) || '{}');
-  var ncsSessionStepMetrics = getNcsSessionStepMetrics(existingMetrics, sessionId, steps);
-  storageClient.setItemWithExpiry(NCS_STORAGE.NCS_SESSION_STEP_METRICS, JSON.stringify(_objectSpread(_objectSpread({}, existingMetrics), {}, _defineProperty({}, sessionId, ncsSessionStepMetrics))));
-  updateNcsActiveSessions(sessionId);
-};

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

@@ -1,48 +0,0 @@
-import type { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
-import type { Step } from '@atlaskit/editor-prosemirror/transform-override';
-import type { CollabEditPlugin } from '../collabEditPluginType';
-type StepSessionMetrics = {
-    maxStepSize: number;
-    numberOfSteps: number;
-    stepSizeSumForP90: number[];
-    totalStepSize: 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 getNcsSessionStepMetrics: (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 updateNcsActiveSessions: (sessionId: string) => void;
-type UpdateNcsSessionStepMetricProps = {
-    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
-    steps: Step[];
-};
-/**
- * Updates the step session metrics in local storage for a given session ID.
- * It calculates the metrics based on the provided steps and updates the storage.
- *
- * @param api - The API to access the collab edit plugin.
- * @param steps - The steps to calculate the metrics from.
- * @return void
- */
-export declare const updateNcsSessionStepMetrics: ({ api, steps, }: UpdateNcsSessionStepMetricProps) => void;
-export {};