@atlaskit/collab-provider 10.8.0 → 10.9.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @atlaskit/collab-provider
 
+## 10.9.0
+
+### Minor Changes
+
+- [#120472](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/120472)
+  [`73c800ab5f2fc`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/73c800ab5f2fc) -
+  ED-26766 update adf-schema from 47.2.1 to 47.6.0 and adf-schema-json from 1.27.0 to 1.31.0
+
+### Patch Changes
+
+- Updated dependencies
+
+## 10.8.1
+
+### Patch Changes
+
+- [#120905](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/120905)
+  [`4194ea903d7d6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/4194ea903d7d6) -
+  Refactor step merging while offline.
+
 ## 10.8.0
 
 ### Minor Changes

package/dist/cjs/document/document-service.js

@@ -10,19 +10,20 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _throttle = _interopRequireDefault(require("lodash/throttle"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
-var _const = require("../helpers/const");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
+var _state = require("@atlaskit/editor-prosemirror/state");
 var _editorJsonTransformer = require("@atlaskit/editor-json-transformer");
-var _throttle = _interopRequireDefault(require("lodash/throttle"));
+var _const = require("../helpers/const");
 var _performance = require("../analytics/performance");
 var _internalErrors = require("../errors/internal-errors");
 var _utils = require("../helpers/utils");
 var _provider = require("../provider");
 var _commitStep = require("../provider/commit-step");
+var _customErrors = require("../errors/custom-errors");
 var _catchupv = require("./catchupv2");
 var _stepQueueState = require("./step-queue-state");
-var _customErrors = require("../errors/custom-errors");
 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 CATCHUP_THROTTLE = 1 * 1000; // 1 second
@@ -384,7 +385,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
-                triggeredByCatchup: targetClientId ? true : false
+                triggeredByCatchup: !!targetClientId
               });
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
@@ -424,7 +425,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 useReconcile: useReconcile,
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
-                triggeredByCatchup: targetClientId ? true : false
+                triggeredByCatchup: !!targetClientId
               });
               _context3.next = 41;
               break;
@@ -436,7 +437,7 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
                 useReconcile: useReconcile,
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
-                triggeredByCatchup: targetClientId ? true : false
+                triggeredByCatchup: !!targetClientId
               });
               (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 || _this$analyticsHelper17.sendErrorEvent(_context3.t1, "Error while reinitialising document. Use Reconcile: ".concat(useReconcile));
               _this.onErrorHandled({
@@ -935,12 +936,18 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       // we need to lock them to ensure they don't get
       // mutated in: `packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts`
       if ((0, _platformFeatureFlags.fg)('platform_editor_merge_unconfirmed_steps')) {
-        unconfirmedStepsData.steps.forEach(function (s) {
-          if (isLockable(s)) {
-            var _s$lockStep;
-            (_s$lockStep = s.lockStep) === null || _s$lockStep === void 0 || _s$lockStep.call(s);
+        unconfirmedStepsData.origins.forEach(function (origin) {
+          if (origin instanceof _state.Transaction) {
+            return origin.setMeta('mergeIsLocked', true);
           }
         });
+        var offlineSteps = unconfirmedStepsData === null || unconfirmedStepsData === void 0 ? void 0 : unconfirmedStepsData.origins.some(function (tr) {
+          var _tr$getMeta;
+          return tr instanceof _state.Transaction ? (_tr$getMeta = tr.getMeta('isOffline')) !== null && _tr$getMeta !== void 0 ? _tr$getMeta : false : false;
+        });
+        if (offlineSteps) {
+          return;
+        }
       }
 
       // Avoid reference issues using a
@@ -967,7 +974,4 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
       });
     }
   }]);
-}(); // Based on: packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts
-function isLockable(step) {
-  return (step === null || step === void 0 ? void 0 : step.lockStep) !== undefined;
-}
+}();

package/dist/cjs/version-wrapper.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = exports.nextMajorVersion = exports.name = void 0;
 var name = exports.name = "@atlaskit/collab-provider";
-var version = exports.version = "10.8.0";
+var version = exports.version = "10.9.0";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/es2019/document/document-service.js

@@ -1,17 +1,18 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import throttle from 'lodash/throttle';
 import { fg } from '@atlaskit/platform-feature-flags';
-import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { getCollabState, sendableSteps } from '@atlaskit/prosemirror-collab';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
-import throttle from 'lodash/throttle';
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
 import { createLogger, getDocAdfWithObfuscationFromJSON, getObfuscatedSteps, getStepUGCFreeDetails, sleep } from '../helpers/utils';
 import { MAX_STEP_REJECTED_ERROR, MAX_STEP_REJECTED_ERROR_AGGRESSIVE } from '../provider';
 import { commitStepQueue } from '../provider/commit-step';
+import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 import { catchupv2 } from './catchupv2';
 import { StepQueueState } from './step-queue-state';
-import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 const CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 const noop = () => {};
@@ -346,7 +347,7 @@ export class DocumentService {
               hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
               clientId: this.clientId,
               targetClientId,
-              triggeredByCatchup: targetClientId ? true : false
+              triggeredByCatchup: !!targetClientId
             });
             if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
               this.applyLocalSteps(unconfirmedSteps);
@@ -373,7 +374,7 @@ export class DocumentService {
           useReconcile,
           clientId: this.clientId,
           targetClientId,
-          triggeredByCatchup: targetClientId ? true : false
+          triggeredByCatchup: !!targetClientId
         });
       } catch (restoreError) {
         var _this$analyticsHelper16, _this$analyticsHelper17;
@@ -382,7 +383,7 @@ export class DocumentService {
           useReconcile,
           clientId: this.clientId,
           targetClientId,
-          triggeredByCatchup: targetClientId ? true : false
+          triggeredByCatchup: !!targetClientId
         });
         (_this$analyticsHelper17 = this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 ? void 0 : _this$analyticsHelper17.sendErrorEvent(restoreError, `Error while reinitialising document. Use Reconcile: ${useReconcile}`);
         this.onErrorHandled({
@@ -806,12 +807,18 @@ export class DocumentService {
     // we need to lock them to ensure they don't get
     // mutated in: `packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts`
     if (fg('platform_editor_merge_unconfirmed_steps')) {
-      unconfirmedStepsData.steps.forEach(s => {
-        if (isLockable(s)) {
-          var _s$lockStep;
-          (_s$lockStep = s.lockStep) === null || _s$lockStep === void 0 ? void 0 : _s$lockStep.call(s);
+      unconfirmedStepsData.origins.forEach(origin => {
+        if (origin instanceof Transaction) {
+          return origin.setMeta('mergeIsLocked', true);
         }
       });
+      const offlineSteps = unconfirmedStepsData === null || unconfirmedStepsData === void 0 ? void 0 : unconfirmedStepsData.origins.some(tr => {
+        var _tr$getMeta;
+        return tr instanceof Transaction ? (_tr$getMeta = tr.getMeta('isOffline')) !== null && _tr$getMeta !== void 0 ? _tr$getMeta : false : false;
+      });
+      if (offlineSteps) {
+        return;
+      }
     }
 
     // Avoid reference issues using a
@@ -837,10 +844,4 @@ export class DocumentService {
       forcePublish
     });
   }
-}
-
-// Based on: packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts
-
-function isLockable(step) {
-  return (step === null || step === void 0 ? void 0 : step.lockStep) !== undefined;
 }

package/dist/es2019/version-wrapper.js

@@ -1,5 +1,5 @@
 export const name = "@atlaskit/collab-provider";
-export const version = "10.8.0";
+export const version = "10.9.0";
 export const nextMajorVersion = () => {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/esm/document/document-service.js

@@ -5,19 +5,20 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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 throttle from 'lodash/throttle';
 import { fg } from '@atlaskit/platform-feature-flags';
-import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { getCollabState, sendableSteps } from '@atlaskit/prosemirror-collab';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import { JSONTransformer } from '@atlaskit/editor-json-transformer';
-import throttle from 'lodash/throttle';
+import { ACK_MAX_TRY, EVENT_ACTION, EVENT_STATUS, CatchupEventReason } from '../helpers/const';
 import { MEASURE_NAME, startMeasure, stopMeasure } from '../analytics/performance';
 import { INTERNAL_ERROR_CODE } from '../errors/internal-errors';
 import { createLogger, getDocAdfWithObfuscationFromJSON, getObfuscatedSteps, getStepUGCFreeDetails, sleep } from '../helpers/utils';
 import { MAX_STEP_REJECTED_ERROR, MAX_STEP_REJECTED_ERROR_AGGRESSIVE } from '../provider';
 import { commitStepQueue } from '../provider/commit-step';
+import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 import { catchupv2 } from './catchupv2';
 import { StepQueueState } from './step-queue-state';
-import { CantSyncUpError, UpdateDocumentError } from '../errors/custom-errors';
 var CATCHUP_THROTTLE = 1 * 1000; // 1 second
 
 var noop = function noop() {};
@@ -377,7 +378,7 @@ export var DocumentService = /*#__PURE__*/function () {
                 hasTitle: !!(metadata !== null && metadata !== void 0 && metadata.title),
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
-                triggeredByCatchup: targetClientId ? true : false
+                triggeredByCatchup: !!targetClientId
               });
               if (unconfirmedSteps !== null && unconfirmedSteps !== void 0 && unconfirmedSteps.length) {
                 _this.applyLocalSteps(unconfirmedSteps);
@@ -417,7 +418,7 @@ export var DocumentService = /*#__PURE__*/function () {
                 useReconcile: useReconcile,
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
-                triggeredByCatchup: targetClientId ? true : false
+                triggeredByCatchup: !!targetClientId
               });
               _context3.next = 41;
               break;
@@ -429,7 +430,7 @@ export var DocumentService = /*#__PURE__*/function () {
                 useReconcile: useReconcile,
                 clientId: _this.clientId,
                 targetClientId: targetClientId,
-                triggeredByCatchup: targetClientId ? true : false
+                triggeredByCatchup: !!targetClientId
               });
               (_this$analyticsHelper17 = _this.analyticsHelper) === null || _this$analyticsHelper17 === void 0 || _this$analyticsHelper17.sendErrorEvent(_context3.t1, "Error while reinitialising document. Use Reconcile: ".concat(useReconcile));
               _this.onErrorHandled({
@@ -928,12 +929,18 @@ export var DocumentService = /*#__PURE__*/function () {
       // we need to lock them to ensure they don't get
       // mutated in: `packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts`
       if (fg('platform_editor_merge_unconfirmed_steps')) {
-        unconfirmedStepsData.steps.forEach(function (s) {
-          if (isLockable(s)) {
-            var _s$lockStep;
-            (_s$lockStep = s.lockStep) === null || _s$lockStep === void 0 || _s$lockStep.call(s);
+        unconfirmedStepsData.origins.forEach(function (origin) {
+          if (origin instanceof Transaction) {
+            return origin.setMeta('mergeIsLocked', true);
           }
         });
+        var offlineSteps = unconfirmedStepsData === null || unconfirmedStepsData === void 0 ? void 0 : unconfirmedStepsData.origins.some(function (tr) {
+          var _tr$getMeta;
+          return tr instanceof Transaction ? (_tr$getMeta = tr.getMeta('isOffline')) !== null && _tr$getMeta !== void 0 ? _tr$getMeta : false : false;
+        });
+        if (offlineSteps) {
+          return;
+        }
       }
 
       // Avoid reference issues using a
@@ -960,10 +967,4 @@ export var DocumentService = /*#__PURE__*/function () {
       });
     }
   }]);
-}();
-
-// Based on: packages/editor/editor-plugin-collab-edit/src/pm-plugins/mergeUnconfirmed.ts
-
-function isLockable(step) {
-  return (step === null || step === void 0 ? void 0 : step.lockStep) !== undefined;
-}
+}();

package/dist/esm/version-wrapper.js

@@ -1,5 +1,5 @@
 export var name = "@atlaskit/collab-provider";
-export var version = "10.8.0";
+export var version = "10.9.0";
 export var nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

package/dist/types/document/document-service.d.ts

@@ -1,11 +1,12 @@
 import type { ResolvedEditorState, SyncUpErrorFunction, CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
-import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import type AnalyticsHelper from '../analytics/analytics-helper';
-import { CatchupEventReason } from '../helpers/const';
-import type { MetadataService } from '../metadata/metadata-service';
-import type { Catchupv2Response, ChannelEvent, ReconcileResponse, ReconnectionMetadata, StepsPayload } from '../types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+import type { Catchupv2Response, ChannelEvent, ReconcileResponse, ReconnectionMetadata, StepsPayload } from '../types';
+import type { MetadataService } from '../metadata/metadata-service';
+import { CatchupEventReason } from '../helpers/const';
+import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 import type { ParticipantsService } from '../participants/participants-service';
 import { type DocumentServiceInterface } from './interface-document-service';

package/dist/types-ts4.5/document/document-service.d.ts

@@ -1,11 +1,12 @@
 import type { ResolvedEditorState, SyncUpErrorFunction, CollabEvents, CollabInitPayload } from '@atlaskit/editor-common/collab';
-import type { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
-import type AnalyticsHelper from '../analytics/analytics-helper';
-import { CatchupEventReason } from '../helpers/const';
-import type { MetadataService } from '../metadata/metadata-service';
-import type { Catchupv2Response, ChannelEvent, ReconcileResponse, ReconnectionMetadata, StepsPayload } from '../types';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+import { Step as ProseMirrorStep } from '@atlaskit/editor-prosemirror/transform';
+import type { EditorState } from '@atlaskit/editor-prosemirror/state';
+import { Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { JSONDocNode } from '@atlaskit/editor-json-transformer';
+import type { Catchupv2Response, ChannelEvent, ReconcileResponse, ReconnectionMetadata, StepsPayload } from '../types';
+import type { MetadataService } from '../metadata/metadata-service';
+import { CatchupEventReason } from '../helpers/const';
+import type AnalyticsHelper from '../analytics/analytics-helper';
 import type { InternalError } from '../errors/internal-errors';
 import type { ParticipantsService } from '../participants/participants-service';
 import { type DocumentServiceInterface } from './interface-document-service';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "10.8.0",
+	"version": "10.9.0",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -32,16 +32,16 @@
 		"./version-wrapper": "./src/version-wrapper.ts"
 	},
 	"dependencies": {
-		"@atlaskit/adf-utils": "^19.18.0",
+		"@atlaskit/adf-utils": "^19.19.0",
 		"@atlaskit/analytics-gas-types": "^5.1.0",
 		"@atlaskit/analytics-listeners": "^9.0.0",
-		"@atlaskit/editor-common": "^100.4.0",
-		"@atlaskit/editor-json-transformer": "^8.23.0",
+		"@atlaskit/editor-common": "^100.5.0",
+		"@atlaskit/editor-json-transformer": "^8.24.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/feature-gate-js-client": "^4.26.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/prosemirror-collab": "^0.14.0",
-		"@atlaskit/react-ufo": "^3.1.0",
+		"@atlaskit/prosemirror-collab": "^0.15.0",
+		"@atlaskit/react-ufo": "^3.2.0",
 		"@atlaskit/ufo": "^0.4.0",
 		"@atlaskit/util-service-support": "^6.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -65,7 +65,7 @@
 		}
 	},
 	"devDependencies": {
-		"@atlaskit/adf-schema": "^47.2.1",
+		"@atlaskit/adf-schema": "^47.6.0",
 		"@atlassian/feature-flags-test-utils": "^0.3.0",
 		"typescript": "~5.4.2"
 	},