@atlaskit/editor-plugin-collab-edit
Version:
Collab Edit plugin for @atlaskit/editor-core
72 lines (71 loc) • 3.81 kB
JavaScript
import { isDirtyTransaction } from '@atlaskit/editor-common/collab';
import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
import { AGENT_ATTRIBUTION_META } from '@atlaskit/editor-common/transaction-agent-attribution';
import { PluginKey } from '@atlaskit/editor-prosemirror/state';
import { AddMarkStep, RemoveMarkStep } from '@atlaskit/editor-prosemirror/transform';
import { fg } from '@atlaskit/platform-feature-flags/fg';
import { isOrganicChange } from './utils';
export const trackLastOrganicChangePluginKey = new PluginKey('collabTrackLastOrganicChangePlugin');
export const createPlugin = () => {
return new SafePlugin({
key: trackLastOrganicChangePluginKey,
state: {
init() {
return {
...(fg('confluence_ncs_step_diffing_version_history') && {
localHumanBodyChangeCount: 0
}),
lastLocalOrganicChangeAt: null,
lastRemoteOrganicChangeAt: null,
lastLocalOrganicBodyChangeAt: null,
lastRemoteOrganicBodyChangeAt: null
};
},
apply(transaction, prevPluginState) {
if (Boolean(transaction.getMeta('appendedTransaction'))) {
return prevPluginState;
}
const isRemote = Boolean(transaction.getMeta('isRemote'));
const isDocumentReplaceFromRemote = isRemote && Boolean(transaction.getMeta('replaceDocument'));
// Inline comment annotations are not considered as edits to the document body
const isAnnotationStep = !!transaction.steps.find(step => {
var _step$mark, _step$mark$type;
return (step instanceof AddMarkStep || step instanceof RemoveMarkStep) && ((_step$mark = step.mark) === null || _step$mark === void 0 ? void 0 : (_step$mark$type = _step$mark.type) === null || _step$mark$type === void 0 ? void 0 : _step$mark$type.name) === 'annotation';
});
if (isDocumentReplaceFromRemote) {
return prevPluginState;
}
if (isDirtyTransaction(transaction)) {
return prevPluginState;
}
if (isOrganicChange(transaction)) {
var _prevPluginState$loca;
if (isRemote) {
return {
...(fg('confluence_ncs_step_diffing_version_history') && {
localHumanBodyChangeCount: prevPluginState.localHumanBodyChangeCount
}),
lastLocalOrganicChangeAt: prevPluginState.lastLocalOrganicChangeAt,
lastRemoteOrganicChangeAt: Date.now(),
lastLocalOrganicBodyChangeAt: prevPluginState.lastLocalOrganicBodyChangeAt,
lastRemoteOrganicBodyChangeAt: isAnnotationStep ? prevPluginState.lastRemoteOrganicBodyChangeAt : Date.now()
};
}
// Agent transactions can be local (frontend streaming) or remote (NCS).
// Keep organic-change tracking intact for saving, but track human attribution separately.
const isAgentChange = fg('confluence_ncs_step_diffing_version_history') && Boolean(transaction.getMeta(AGENT_ATTRIBUTION_META));
return {
...(fg('confluence_ncs_step_diffing_version_history') && {
localHumanBodyChangeCount: ((_prevPluginState$loca = prevPluginState.localHumanBodyChangeCount) !== null && _prevPluginState$loca !== void 0 ? _prevPluginState$loca : 0) + (isAnnotationStep || isAgentChange ? 0 : 1)
}),
lastLocalOrganicChangeAt: Date.now(),
lastRemoteOrganicChangeAt: prevPluginState.lastRemoteOrganicChangeAt,
lastLocalOrganicBodyChangeAt: isAnnotationStep ? prevPluginState.lastLocalOrganicBodyChangeAt : Date.now(),
lastRemoteOrganicBodyChangeAt: prevPluginState.lastRemoteOrganicBodyChangeAt
};
}
return prevPluginState;
}
}
});
};