This commit is contained in:
2025-01-04 00:34:03 +01:00
parent 41829408dc
commit 0ca14bbc19
18111 changed files with 1871397 additions and 0 deletions

View File

@@ -0,0 +1,155 @@
'use strict';
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
Object.defineProperty(exports, '__esModule', {
value: true
});
var prosemirrorState = require('prosemirror-state');
var Rebaseable = _createClass(function Rebaseable(step, inverted, origin) {
_classCallCheck(this, Rebaseable);
this.step = step;
this.inverted = inverted;
this.origin = origin;
});
function rebaseSteps(steps, over, transform) {
for (var i = steps.length - 1; i >= 0; i--) {
transform.step(steps[i].inverted);
}
for (var _i = 0; _i < over.length; _i++) {
transform.step(over[_i]);
}
var result = [];
for (var _i2 = 0, mapFrom = steps.length; _i2 < steps.length; _i2++) {
var mapped = steps[_i2].step.map(transform.mapping.slice(mapFrom));
mapFrom--;
if (mapped && !transform.maybeStep(mapped).failed) {
transform.mapping.setMirror(mapFrom, transform.steps.length - 1);
result.push(new Rebaseable(mapped, mapped.invert(transform.docs[transform.docs.length - 1]), steps[_i2].origin));
}
}
return result;
}
var CollabState = _createClass(function CollabState(version, unconfirmed) {
_classCallCheck(this, CollabState);
this.version = version;
this.unconfirmed = unconfirmed;
});
function unconfirmedFrom(transform) {
var result = [];
for (var i = 0; i < transform.steps.length; i++) {
result.push(new Rebaseable(transform.steps[i], transform.steps[i].invert(transform.docs[i]), transform));
}
return result;
}
var collabKey = new prosemirrorState.PluginKey("collab");
function collab() {
var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
var conf = {
version: config.version || 0,
clientID: config.clientID == null ? Math.floor(Math.random() * 0xFFFFFFFF) : config.clientID
};
return new prosemirrorState.Plugin({
key: collabKey,
state: {
init: function init() {
return new CollabState(conf.version, []);
},
apply: function apply(tr, collab) {
var newState = tr.getMeta(collabKey);
if (newState) return newState;
if (tr.docChanged) return new CollabState(collab.version, collab.unconfirmed.concat(unconfirmedFrom(tr)));
return collab;
}
},
config: conf,
historyPreserveItems: true
});
}
function receiveTransaction(state, steps, clientIDs) {
var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
var collabState = collabKey.getState(state);
var version = collabState.version + steps.length;
var ourID = collabKey.get(state).spec.config.clientID;
var ours = 0;
while (ours < clientIDs.length && clientIDs[ours] == ourID) {
++ours;
}
var unconfirmed = collabState.unconfirmed.slice(ours);
steps = ours ? steps.slice(ours) : steps;
if (!steps.length) return state.tr.setMeta(collabKey, new CollabState(version, unconfirmed));
var nUnconfirmed = unconfirmed.length;
var tr = state.tr;
if (nUnconfirmed) {
unconfirmed = rebaseSteps(unconfirmed, steps, tr);
} else {
for (var i = 0; i < steps.length; i++) {
tr.step(steps[i]);
}
unconfirmed = [];
}
var newCollabState = new CollabState(version, unconfirmed);
if (options && options.mapSelectionBackward && state.selection instanceof prosemirrorState.TextSelection) {
tr.setSelection(prosemirrorState.TextSelection.between(tr.doc.resolve(tr.mapping.map(state.selection.anchor, -1)), tr.doc.resolve(tr.mapping.map(state.selection.head, -1)), -1));
tr.updated &= ~1;
}
return tr.setMeta("rebased", nUnconfirmed).setMeta("addToHistory", false).setMeta(collabKey, newCollabState);
}
function sendableSteps(state) {
var collabState = collabKey.getState(state);
if (collabState.unconfirmed.length == 0) return null;
return {
version: collabState.version,
steps: collabState.unconfirmed.map(function (s) {
return s.step;
}),
clientID: collabKey.get(state).spec.config.clientID,
get origins() {
return this._origins || (this._origins = collabState.unconfirmed.map(function (s) {
return s.origin;
}));
}
};
}
function getVersion(state) {
return collabKey.getState(state).version;
}
exports.collab = collab;
exports.getVersion = getVersion;
exports.rebaseSteps = rebaseSteps;
exports.receiveTransaction = receiveTransaction;
exports.sendableSteps = sendableSteps;

View File

@@ -0,0 +1,60 @@
import { Plugin, EditorState, Transaction } from 'prosemirror-state';
import { Step } from 'prosemirror-transform';
declare type CollabConfig = {
/**
The starting version number of the collaborative editing.
Defaults to 0.
*/
version?: number;
/**
This client's ID, used to distinguish its changes from those of
other clients. Defaults to a random 32-bit number.
*/
clientID?: number | string;
};
/**
Creates a plugin that enables the collaborative editing framework
for the editor.
*/
declare function collab(config?: CollabConfig): Plugin;
/**
Create a transaction that represents a set of new steps received from
the authority. Applying this transaction moves the state forward to
adjust to the authority's view of the document.
*/
declare function receiveTransaction(state: EditorState, steps: readonly Step[], clientIDs: readonly (string | number)[], options?: {
/**
When enabled (the default is `false`), if the current
selection is a [text selection](https://prosemirror.net/docs/ref/#state.TextSelection), its
sides are mapped with a negative bias for this transaction, so
that content inserted at the cursor ends up after the cursor.
Users usually prefer this, but it isn't done by default for
reasons of backwards compatibility.
*/
mapSelectionBackward?: boolean;
}): Transaction;
/**
Provides data describing the editor's unconfirmed steps, which need
to be sent to the central authority. Returns null when there is
nothing to send.
`origins` holds the _original_ transactions that produced each
steps. This can be useful for looking up time stamps and other
metadata for the steps, but note that the steps may have been
rebased, whereas the origin transactions are still the old,
unchanged objects.
*/
declare function sendableSteps(state: EditorState): {
version: number;
steps: readonly Step[];
clientID: number | string;
origins: readonly Transaction[];
} | null;
/**
Get the version up to which the collab plugin has synced with the
central authority.
*/
declare function getVersion(state: EditorState): number;
export { collab, getVersion, receiveTransaction, sendableSteps };

View File

@@ -0,0 +1,156 @@
import { PluginKey, Plugin, TextSelection } from 'prosemirror-state';
class Rebaseable {
constructor(step, inverted, origin) {
this.step = step;
this.inverted = inverted;
this.origin = origin;
}
}
/**
Undo a given set of steps, apply a set of other steps, and then
redo them @internal
*/
function rebaseSteps(steps, over, transform) {
for (let i = steps.length - 1; i >= 0; i--)
transform.step(steps[i].inverted);
for (let i = 0; i < over.length; i++)
transform.step(over[i]);
let result = [];
for (let i = 0, mapFrom = steps.length; i < steps.length; i++) {
let mapped = steps[i].step.map(transform.mapping.slice(mapFrom));
mapFrom--;
if (mapped && !transform.maybeStep(mapped).failed) {
transform.mapping.setMirror(mapFrom, transform.steps.length - 1);
result.push(new Rebaseable(mapped, mapped.invert(transform.docs[transform.docs.length - 1]), steps[i].origin));
}
}
return result;
}
// This state field accumulates changes that have to be sent to the
// central authority in the collaborating group and makes it possible
// to integrate changes made by peers into our local document. It is
// defined by the plugin, and will be available as the `collab` field
// in the resulting editor state.
class CollabState {
constructor(
// The version number of the last update received from the central
// authority. Starts at 0 or the value of the `version` property
// in the option object, for the editor's value when the option
// was enabled.
version,
// The local steps that havent been successfully sent to the
// server yet.
unconfirmed) {
this.version = version;
this.unconfirmed = unconfirmed;
}
}
function unconfirmedFrom(transform) {
let result = [];
for (let i = 0; i < transform.steps.length; i++)
result.push(new Rebaseable(transform.steps[i], transform.steps[i].invert(transform.docs[i]), transform));
return result;
}
const collabKey = new PluginKey("collab");
/**
Creates a plugin that enables the collaborative editing framework
for the editor.
*/
function collab(config = {}) {
let conf = {
version: config.version || 0,
clientID: config.clientID == null ? Math.floor(Math.random() * 0xFFFFFFFF) : config.clientID
};
return new Plugin({
key: collabKey,
state: {
init: () => new CollabState(conf.version, []),
apply(tr, collab) {
let newState = tr.getMeta(collabKey);
if (newState)
return newState;
if (tr.docChanged)
return new CollabState(collab.version, collab.unconfirmed.concat(unconfirmedFrom(tr)));
return collab;
}
},
config: conf,
// This is used to notify the history plugin to not merge steps,
// so that the history can be rebased.
historyPreserveItems: true
});
}
/**
Create a transaction that represents a set of new steps received from
the authority. Applying this transaction moves the state forward to
adjust to the authority's view of the document.
*/
function receiveTransaction(state, steps, clientIDs, options = {}) {
// Pushes a set of steps (received from the central authority) into
// the editor state (which should have the collab plugin enabled).
// Will recognize its own changes, and confirm unconfirmed steps as
// appropriate. Remaining unconfirmed steps will be rebased over
// remote steps.
let collabState = collabKey.getState(state);
let version = collabState.version + steps.length;
let ourID = collabKey.get(state).spec.config.clientID;
// Find out which prefix of the steps originated with us
let ours = 0;
while (ours < clientIDs.length && clientIDs[ours] == ourID)
++ours;
let unconfirmed = collabState.unconfirmed.slice(ours);
steps = ours ? steps.slice(ours) : steps;
// If all steps originated with us, we're done.
if (!steps.length)
return state.tr.setMeta(collabKey, new CollabState(version, unconfirmed));
let nUnconfirmed = unconfirmed.length;
let tr = state.tr;
if (nUnconfirmed) {
unconfirmed = rebaseSteps(unconfirmed, steps, tr);
}
else {
for (let i = 0; i < steps.length; i++)
tr.step(steps[i]);
unconfirmed = [];
}
let newCollabState = new CollabState(version, unconfirmed);
if (options && options.mapSelectionBackward && state.selection instanceof TextSelection) {
tr.setSelection(TextSelection.between(tr.doc.resolve(tr.mapping.map(state.selection.anchor, -1)), tr.doc.resolve(tr.mapping.map(state.selection.head, -1)), -1));
tr.updated &= ~1;
}
return tr.setMeta("rebased", nUnconfirmed).setMeta("addToHistory", false).setMeta(collabKey, newCollabState);
}
/**
Provides data describing the editor's unconfirmed steps, which need
to be sent to the central authority. Returns null when there is
nothing to send.
`origins` holds the _original_ transactions that produced each
steps. This can be useful for looking up time stamps and other
metadata for the steps, but note that the steps may have been
rebased, whereas the origin transactions are still the old,
unchanged objects.
*/
function sendableSteps(state) {
let collabState = collabKey.getState(state);
if (collabState.unconfirmed.length == 0)
return null;
return {
version: collabState.version,
steps: collabState.unconfirmed.map(s => s.step),
clientID: collabKey.get(state).spec.config.clientID,
get origins() {
return this._origins || (this._origins = collabState.unconfirmed.map(s => s.origin));
}
};
}
/**
Get the version up to which the collab plugin has synced with the
central authority.
*/
function getVersion(state) {
return collabKey.getState(state).version;
}
export { collab, getVersion, rebaseSteps, receiveTransaction, sendableSteps };