@atlaskit/collab-provider 14.0.0 → 14.0.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/collab-provider
 
+## 14.0.2
+
+### Patch Changes
+
+- [`34c085d24f484`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/34c085d24f484) -
+  Add new offline metadata to steps if they contain steps that were created while offline.
+- Updated dependencies
+
+## 14.0.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 14.0.0
 
 ### Patch Changes

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

@@ -1110,7 +1110,8 @@ var DocumentService = exports.DocumentService = /*#__PURE__*/function () {
         hasRecovered: this.hasRecovered,
         collabMode: this.participantsService.getCollabMode(),
         reason: reason,
-        lockSteps: this.lockSteps
+        lockSteps: this.lockSteps,
+        stepOrigins: unconfirmedStepsData.origins
       });
     }
   }]);

package/dist/cjs/provider/commit-step.js

@@ -13,6 +13,7 @@ var _const = require("../helpers/const");
 var _types = require("../types");
 var _ncsErrors = require("../errors/ncs-errors");
 var _utils = require("../helpers/utils");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 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 logger = (0, _utils.createLogger)('commit-step', 'black');
@@ -49,7 +50,8 @@ var CommitStepService = exports.CommitStepService = /*#__PURE__*/function () {
         hasRecovered = _ref.hasRecovered,
         collabMode = _ref.collabMode,
         reason = _ref.reason,
-        lockSteps = _ref.lockSteps;
+        lockSteps = _ref.lockSteps,
+        stepOrigins = _ref.stepOrigins;
       // this timer is for waiting to send the next batch in between acks from the BE
       var commitWaitTimer;
       // if publishing and not waiting for an ACK, then clear the commit timer and proceed, skipping the timer
@@ -113,6 +115,9 @@ var CommitStepService = exports.CommitStepService = /*#__PURE__*/function () {
           return step;
         });
       }
+      if ((0, _expValEquals.expValEquals)('platform_editor_offline_editing_web', 'isEnabled', true)) {
+        stepsWithClientAndUserId = this.addOfflineMetadata(stepsWithClientAndUserId, stepOrigins);
+      }
       var start = new Date().getTime();
       var ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG = 'Error while adding steps - Invalid Acknowledgement';
       var ADD_STEPS_BROADCAST_ERROR_MSG = 'Error while adding steps - Broadcast threw exception';
@@ -200,6 +205,28 @@ var CommitStepService = exports.CommitStepService = /*#__PURE__*/function () {
       }
       return false;
     }
+  }, {
+    key: "addOfflineMetadata",
+    value: function addOfflineMetadata(stepsWithClientAndUserId, origins) {
+      if (origins.some(function (s) {
+        return s.getMeta('isOffline') === true || s.getMeta('wasOffline') === true;
+      })) {
+        return stepsWithClientAndUserId.map(function (step, idx) {
+          var origin = origins[idx];
+          if (!origin) {
+            return step;
+          }
+          var createdOffline = origin.getMeta('isOffline') || origin.getMeta('wasOffline');
+          if (createdOffline === true) {
+            step.metadata = _objectSpread(_objectSpread({}, step.metadata), {}, {
+              createdOffline: createdOffline
+            });
+          }
+          return step;
+        });
+      }
+      return stepsWithClientAndUserId;
+    }
   }, {
     key: "sendSuccessAnalytics",
     value: function sendSuccessAnalytics(latency, stepsWithClientAndUserId) {

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 = "13.0.4";
+var version = exports.version = "0.0.0-development";
 var nextMajorVersion = exports.nextMajorVersion = function nextMajorVersion() {
   return [Number(version.split('.')[0]) + 1, 0, 0].join('.');
 };

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

@@ -978,7 +978,8 @@ export class DocumentService {
       hasRecovered: this.hasRecovered,
       collabMode: this.participantsService.getCollabMode(),
       reason,
-      lockSteps: this.lockSteps
+      lockSteps: this.lockSteps,
+      stepOrigins: unconfirmedStepsData.origins
     });
   }
 }

package/dist/es2019/provider/commit-step.js

@@ -3,6 +3,7 @@ import { ADD_STEPS_TYPE, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { AcknowledgementResponseTypes } from '../types';
 import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { createLogger } from '../helpers/utils';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 const logger = createLogger('commit-step', 'black');
 export const RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
 export class CommitStepService {
@@ -33,7 +34,8 @@ export class CommitStepService {
     hasRecovered,
     collabMode,
     reason,
-    lockSteps
+    lockSteps,
+    stepOrigins
   }) {
     // this timer is for waiting to send the next batch in between acks from the BE
     let commitWaitTimer;
@@ -99,6 +101,9 @@ export class CommitStepService {
         return step;
       });
     }
+    if (expValEquals('platform_editor_offline_editing_web', 'isEnabled', true)) {
+      stepsWithClientAndUserId = this.addOfflineMetadata(stepsWithClientAndUserId, stepOrigins);
+    }
     const start = new Date().getTime();
     const ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG = 'Error while adding steps - Invalid Acknowledgement';
     const ADD_STEPS_BROADCAST_ERROR_MSG = 'Error while adding steps - Broadcast threw exception';
@@ -184,6 +189,25 @@ export class CommitStepService {
     }
     return false;
   }
+  addOfflineMetadata(stepsWithClientAndUserId, origins) {
+    if (origins.some(s => s.getMeta('isOffline') === true || s.getMeta('wasOffline') === true)) {
+      return stepsWithClientAndUserId.map((step, idx) => {
+        const origin = origins[idx];
+        if (!origin) {
+          return step;
+        }
+        const createdOffline = origin.getMeta('isOffline') || origin.getMeta('wasOffline');
+        if (createdOffline === true) {
+          step.metadata = {
+            ...step.metadata,
+            createdOffline
+          };
+        }
+        return step;
+      });
+    }
+    return stepsWithClientAndUserId;
+  }
   sendSuccessAnalytics(latency, stepsWithClientAndUserId) {
     // Sample only 10% of add steps events to avoid overwhelming the analytics
     if (Math.random() < 0.1) {

package/dist/es2019/version-wrapper.js

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

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

@@ -1103,7 +1103,8 @@ export var DocumentService = /*#__PURE__*/function () {
         hasRecovered: this.hasRecovered,
         collabMode: this.participantsService.getCollabMode(),
         reason: reason,
-        lockSteps: this.lockSteps
+        lockSteps: this.lockSteps,
+        stepOrigins: unconfirmedStepsData.origins
       });
     }
   }]);

package/dist/esm/provider/commit-step.js

@@ -8,6 +8,7 @@ import { ADD_STEPS_TYPE, EVENT_ACTION, EVENT_STATUS } from '../helpers/const';
 import { AcknowledgementResponseTypes } from '../types';
 import { NCS_ERROR_CODE } from '../errors/ncs-errors';
 import { createLogger } from '../helpers/utils';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 var logger = createLogger('commit-step', 'black');
 export var RESET_READYTOCOMMIT_INTERVAL_MS = 5000;
 export var CommitStepService = /*#__PURE__*/function () {
@@ -42,7 +43,8 @@ export var CommitStepService = /*#__PURE__*/function () {
         hasRecovered = _ref.hasRecovered,
         collabMode = _ref.collabMode,
         reason = _ref.reason,
-        lockSteps = _ref.lockSteps;
+        lockSteps = _ref.lockSteps,
+        stepOrigins = _ref.stepOrigins;
       // this timer is for waiting to send the next batch in between acks from the BE
       var commitWaitTimer;
       // if publishing and not waiting for an ACK, then clear the commit timer and proceed, skipping the timer
@@ -106,6 +108,9 @@ export var CommitStepService = /*#__PURE__*/function () {
           return step;
         });
       }
+      if (expValEquals('platform_editor_offline_editing_web', 'isEnabled', true)) {
+        stepsWithClientAndUserId = this.addOfflineMetadata(stepsWithClientAndUserId, stepOrigins);
+      }
       var start = new Date().getTime();
       var ADD_STEPS_ACKNOWLEDGEMENT_ERROR_MSG = 'Error while adding steps - Invalid Acknowledgement';
       var ADD_STEPS_BROADCAST_ERROR_MSG = 'Error while adding steps - Broadcast threw exception';
@@ -193,6 +198,28 @@ export var CommitStepService = /*#__PURE__*/function () {
       }
       return false;
     }
+  }, {
+    key: "addOfflineMetadata",
+    value: function addOfflineMetadata(stepsWithClientAndUserId, origins) {
+      if (origins.some(function (s) {
+        return s.getMeta('isOffline') === true || s.getMeta('wasOffline') === true;
+      })) {
+        return stepsWithClientAndUserId.map(function (step, idx) {
+          var origin = origins[idx];
+          if (!origin) {
+            return step;
+          }
+          var createdOffline = origin.getMeta('isOffline') || origin.getMeta('wasOffline');
+          if (createdOffline === true) {
+            step.metadata = _objectSpread(_objectSpread({}, step.metadata), {}, {
+              createdOffline: createdOffline
+            });
+          }
+          return step;
+        });
+      }
+      return stepsWithClientAndUserId;
+    }
   }, {
     key: "sendSuccessAnalytics",
     value: function sendSuccessAnalytics(latency, stepsWithClientAndUserId) {

package/dist/esm/version-wrapper.js

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

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

@@ -117,6 +117,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 to?: number | undefined;
             };
             stepMetadata: {
+                createdOffline?: boolean;
                 prevStepId?: string;
                 rebased?: boolean;
                 reqId?: string;

package/dist/types/helpers/utils.d.ts

@@ -47,6 +47,7 @@ export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number |
         to?: number | undefined;
     };
     stepMetadata: {
+        createdOffline?: boolean;
         prevStepId?: string;
         rebased?: boolean;
         reqId?: string;

package/dist/types/provider/commit-step.d.ts

@@ -20,7 +20,7 @@ export declare class CommitStepService {
      * @param onErrorHandled - Callback to handle
      */
     constructor(broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, analyticsHelper: AnalyticsHelper | undefined, emit: (evt: keyof CollabEvents, data: any) => void, onErrorHandled: (error: InternalError) => void);
-    commitStepQueue({ steps, version, userId, clientId, onStepsAdded, __livePage, hasRecovered, collabMode, reason, lockSteps, }: {
+    commitStepQueue({ steps, version, userId, clientId, onStepsAdded, __livePage, hasRecovered, collabMode, reason, lockSteps, stepOrigins, }: {
         __livePage: boolean;
         clientId: number | string;
         collabMode: string;
@@ -28,11 +28,13 @@ export declare class CommitStepService {
         lockSteps: (stepOrigins?: readonly Transaction[]) => void;
         onStepsAdded: (data: StepsPayload) => void;
         reason?: GetResolvedEditorStateReason;
+        stepOrigins: readonly Transaction[];
         steps: readonly ProseMirrorStep[];
         userId: string;
         version: number;
     }): void;
     private isExpandChangeStep;
+    private addOfflineMetadata;
     private sendSuccessAnalytics;
     private sendFailureAnalytics;
     getReadyToCommitStatus(): boolean;

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

@@ -117,6 +117,7 @@ export declare class DocumentService implements DocumentServiceInterface {
                 to?: number | undefined;
             };
             stepMetadata: {
+                createdOffline?: boolean;
                 prevStepId?: string;
                 rebased?: boolean;
                 reqId?: string;

package/dist/types-ts4.5/helpers/utils.d.ts

@@ -47,6 +47,7 @@ export declare const getObfuscatedSteps: (steps: StepJson[], endIndex?: number |
         to?: number | undefined;
     };
     stepMetadata: {
+        createdOffline?: boolean;
         prevStepId?: string;
         rebased?: boolean;
         reqId?: string;

package/dist/types-ts4.5/provider/commit-step.d.ts

@@ -20,7 +20,7 @@ export declare class CommitStepService {
      * @param onErrorHandled - Callback to handle
      */
     constructor(broadcast: <K extends keyof ChannelEvent>(type: K, data: Omit<ChannelEvent[K], 'timestamp'>, callback?: Function) => void, analyticsHelper: AnalyticsHelper | undefined, emit: (evt: keyof CollabEvents, data: any) => void, onErrorHandled: (error: InternalError) => void);
-    commitStepQueue({ steps, version, userId, clientId, onStepsAdded, __livePage, hasRecovered, collabMode, reason, lockSteps, }: {
+    commitStepQueue({ steps, version, userId, clientId, onStepsAdded, __livePage, hasRecovered, collabMode, reason, lockSteps, stepOrigins, }: {
         __livePage: boolean;
         clientId: number | string;
         collabMode: string;
@@ -28,11 +28,13 @@ export declare class CommitStepService {
         lockSteps: (stepOrigins?: readonly Transaction[]) => void;
         onStepsAdded: (data: StepsPayload) => void;
         reason?: GetResolvedEditorStateReason;
+        stepOrigins: readonly Transaction[];
         steps: readonly ProseMirrorStep[];
         userId: string;
         version: number;
     }): void;
     private isExpandChangeStep;
+    private addOfflineMetadata;
     private sendSuccessAnalytics;
     private sendFailureAnalytics;
     getReadyToCommitStatus(): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/collab-provider",
-	"version": "14.0.0",
+	"version": "14.0.2",
 	"description": "A provider for collaborative editing.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -35,8 +35,8 @@
 		"@atlaskit/feature-gate-js-client": "^5.5.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.20.0",
-		"@atlaskit/react-ufo": "^4.10.0",
-		"@atlaskit/tmp-editor-statsig": "^12.31.0",
+		"@atlaskit/react-ufo": "^4.11.0",
+		"@atlaskit/tmp-editor-statsig": "^13.5.0",
 		"@atlaskit/ufo": "^0.4.0",
 		"@atlaskit/util-service-support": "^6.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -77,6 +77,6 @@
 		}
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.0.0"
+		"@atlaskit/editor-common": "^110.8.0"
 	}
 }