@manuscripts/track-changes-plugin 0.4.0 → 0.4.1

package/dist/mutate/deleteAndMergeSplitNodes.d.ts

@@ -15,7 +15,6 @@
  */
 import { Fragment, Node as PMNode, Schema } from 'prosemirror-model';
 import type { Transaction } from 'prosemirror-state';
-import { Mapping } from 'prosemirror-transform';
 import { ExposedSlice } from '../types/pm';
 import { NewEmptyAttrs } from '../types/track';
 import { ChangeStep } from '../types/step';
@@ -48,7 +47,7 @@ export declare function deleteAndMergeSplitNodes(from: number, to: number, gap:
     start: number;
     end: number;
 } | undefined, startDoc: PMNode, newTr: Transaction, schema: Schema, trackAttrs: NewEmptyAttrs, insertSlice: ExposedSlice): {
-    deleteMap: Mapping;
+    sliceWasSplit: boolean;
     newSliceContent: Fragment;
     steps: ChangeStep[];
 };

package/dist/mutate/deleteNode.d.ts

@@ -33,4 +33,4 @@ export declare function deleteNode(node: PMNode, pos: number, tr: Transaction):
  * @param newTr
  * @param deleteAttrs
  */
-export declare function deleteOrSetNodeDeleted(node: PMNode, pos: number, newTr: Transaction, deleteAttrs: NewDeleteAttrs): void;
+export declare function deleteOrSetNodeDeleted(node: PMNode, pos: number, newTr: Transaction, deleteAttrs: NewDeleteAttrs): Transaction | undefined;

package/dist/track/applyChanges.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Schema } from 'prosemirror-model';
+import { Transaction } from 'prosemirror-state';
+import { Mapping } from 'prosemirror-transform';
+import { TrackedChange } from '../types/change';
+/**
+ * Applies the accepted/rejected changes in the current document and sets them untracked
+ *
+ * @param tr
+ * @param schema
+ * @param changes
+ * @param deleteMap
+ */
+export declare function applyAcceptedRejectedChanges(tr: Transaction, schema: Schema, changes: TrackedChange[], deleteMap?: Mapping): Mapping;

package/dist/track/deleteNode.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Node as PMNode } from 'prosemirror-model';
+import { Transaction } from 'prosemirror-state';
+/**
+ * Deletes node but tries to leave its content intact by trying to unwrap it first
+ *
+ * Incase unwrapping doesn't work deletes the whole node.
+ * @param node
+ * @param pos
+ * @param tr
+ * @returns
+ */
+export declare function deleteNode(node: PMNode, pos: number, tr: Transaction): Transaction;

package/dist/track/findChanges.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { EditorState } from 'prosemirror-state';
+import { ChangeSet } from '../ChangeSet';
+/**
+ * Finds all changes (basically text marks or node attributes) from document
+ *
+ * This could be possibly made more efficient by only iterating the sections of doc
+ * where changes have been applied. This could attempted with eg findDiffStart
+ * but it might be less robust than just using doc.descendants
+ * @param state
+ * @returns
+ */
+export declare function findChanges(state: EditorState): ChangeSet;

package/dist/track/fixInconsistentChanges.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Schema } from 'prosemirror-model';
+import { Transaction } from 'prosemirror-state';
+import { ChangeSet } from '../ChangeSet';
+/**
+ * Iterates over a ChangeSet to check all changes have their required attributes
+ *
+ * This inconsistency might happen due to a bug in the track changes implementation or by a user somehow applying an empty insert/delete mark that doesn't contain proper data. Also this checks the track IDs for duplicates.
+ * @param changeSet
+ * @param currentUser
+ * @param newTr
+ * @param schema
+ * @return docWasChanged, a boolean
+ */
+export declare function fixInconsistentChanges(changeSet: ChangeSet, trackUserID: string, newTr: Transaction, schema: Schema): boolean;

package/dist/track/mergeNode.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Node as PMNode } from 'prosemirror-model';
+import { Transaction } from 'prosemirror-state';
+/**
+ * Deletes node but tries to leave its content intact by moving/wrapping it to a node before or after
+ * @param node
+ * @param pos
+ * @param tr
+ * @returns
+ */
+export declare function mergeNode(node: PMNode, pos: number, tr: Transaction): Transaction | undefined;

package/dist/track/node-utils.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Node as PMNode, Schema } from 'prosemirror-model';
+import { CHANGE_OPERATION, TrackedAttrs } from '../types/change';
+export declare function addTrackIdIfDoesntExist(attrs: Partial<TrackedAttrs>): Partial<TrackedAttrs>;
+export declare function getInlineNodeTrackedMarkData(node: PMNode | undefined | null, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
+    operation: CHANGE_OPERATION;
+}) | undefined;
+export declare function getNodeTrackedData(node: PMNode | undefined | null, schema: Schema): Partial<TrackedAttrs> | undefined;
+export declare function equalMarks(n1: PMNode, n2: PMNode): boolean;
+export declare function shouldMergeTrackedAttributes(left?: Partial<TrackedAttrs>, right?: Partial<TrackedAttrs>): boolean;
+export declare function getMergeableMarkTrackedAttrs(node: PMNode | undefined | null, attrs: Partial<TrackedAttrs>, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
+    operation: CHANGE_OPERATION;
+}) | null;

package/dist/track/steps/deleteAndMergeSplitNodes.d.ts

@@ -0,0 +1,53 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Fragment, Node as PMNode, Schema } from 'prosemirror-model';
+import type { Transaction } from 'prosemirror-state';
+import { Mapping } from 'prosemirror-transform';
+import { ExposedSlice } from '../../types/pm';
+import { NewEmptyAttrs } from '../../types/track';
+/**
+ * Applies deletion to the doc without actually deleting nodes that have not been inserted
+ *
+ * The hairiest part of this whole library which does a fair bit of magic to split the inserted slice
+ * into pieces that can be inserted without deleting nodes in the doc. Basically we first split the
+ * inserted slice into merged pieces _if_ the slice was open on either end. Then, we iterate over the deleted
+ * range and see if the node in question was completely wrapped in the range (therefore fully deleted)
+ * or only partially deleted by the slice. In that case, we merge the content from the inserted slice
+ * and keep the original nodes if they do not contain insert attributes.
+ *
+ * It is definitely a messy function but so far this seems to have been the best approach to prevent
+ * deletion of nodes with open slices. Other option would be to allow the deletions to take place but that
+ * requires then inserting the deleted nodes back to the doc if their deletion should be prevented, which does
+ * not seem trivial either.
+ *
+ * @param from start of the deleted range
+ * @param to end of the deleted range
+ * @param gap retained content in a ReplaceAroundStep, not deleted
+ * @param startDoc doc before the deletion
+ * @param newTr the new track transaction
+ * @param schema ProseMirror schema
+ * @param deleteAttrs attributes for the dataTracked object
+ * @param insertSlice the inserted slice from ReplaceStep
+ * @returns mapping adjusted by the applied operations & modified insert slice
+ */
+export declare function deleteAndMergeSplitNodes(from: number, to: number, gap: {
+    start: number;
+    end: number;
+} | undefined, startDoc: PMNode, newTr: Transaction, schema: Schema, trackAttrs: NewEmptyAttrs, insertSlice: ExposedSlice): {
+    deleteMap: Mapping;
+    mergedInsertPos: undefined;
+    newSliceContent: Fragment;
+};

package/dist/track/steps/mergeTrackedMarks.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Node as PMNode, Schema } from 'prosemirror-model';
+import type { Transaction } from 'prosemirror-state';
+/**
+ * Merges tracked marks between text nodes at a position
+ *
+ * Will work for any nodes that use tracked_insert or tracked_delete marks which may not be preferrable
+ * if used for block nodes (since we possibly want to show the individual changed nodes).
+ * Merging is done based on the userID, operation type and status.
+ * @param pos
+ * @param doc
+ * @param newTr
+ * @param schema
+ */
+export declare function mergeTrackedMarks(pos: number, doc: PMNode, newTr: Transaction, schema: Schema): void;

package/dist/track/steps/setFragmentAsInserted.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Fragment, Schema } from 'prosemirror-model';
+import { NewInsertAttrs } from '../../types/track';
+export declare function setFragmentAsInserted(inserted: Fragment, insertAttrs: NewInsertAttrs, schema: Schema): Fragment;

package/dist/track/steps/track-utils.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs } from '../../types/track';
+export declare function createNewInsertAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
+export declare function createNewDeleteAttrs(attrs: NewEmptyAttrs): NewDeleteAttrs;

package/dist/track/steps/trackReplaceAroundStep.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+import { ReplaceAroundStep } from 'prosemirror-transform';
+import { NewEmptyAttrs } from '../../types/track';
+export declare function trackReplaceAroundStep(step: ReplaceAroundStep, oldState: EditorState, newTr: Transaction, attrs: NewEmptyAttrs): void;

package/dist/track/steps/trackReplaceStep.d.ts

@@ -0,0 +1,4 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+import { ReplaceStep } from 'prosemirror-transform';
+import { NewEmptyAttrs } from '../../types/track';
+export declare function trackReplaceStep(step: ReplaceStep, oldState: EditorState, newTr: Transaction, attrs: NewEmptyAttrs): number;

package/dist/track/trackTransaction.d.ts

@@ -0,0 +1,17 @@
+import type { EditorState, Transaction } from 'prosemirror-state';
+/**
+ * Inverts transactions to wrap their contents/operations with track data instead
+ *
+ * The main function of track changes that holds the most complex parts of this whole library.
+ * Takes in as arguments the data from appendTransaction to reapply it with the track marks/attributes.
+ * We could prevent the initial transaction from being applied all together but since invert works just
+ * as well and we can use the intermediate doc for checking which nodes are changed, it's not prevented.
+ *
+ *
+ * @param tr Original transaction
+ * @param oldState State before transaction
+ * @param newTr Transaction created from the new editor state
+ * @param authorID User id
+ * @returns newTr that inverts the initial tr and applies track attributes/marks
+ */
+export declare function trackTransaction(tr: Transaction, oldState: EditorState, newTr: Transaction, authorID: string): Transaction;

package/dist/track/updateChangeAttrs.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Schema } from 'prosemirror-model';
+import { Transaction } from 'prosemirror-state';
+import { Mapping } from 'prosemirror-transform';
+import { IncompleteChange, TrackedAttrs, TrackedChange } from '../types/change';
+export declare function updateChangeAttrs(tr: Transaction, change: IncompleteChange, trackedAttrs: Partial<TrackedAttrs>, schema: Schema): Transaction;
+export declare function updateChangeChildrenAttributes(changes: TrackedChange[], tr: Transaction, mapping: Mapping): void;

package/dist/types/change.d.ts

@@ -41,7 +41,7 @@ declare type Change = {
     id: string;
     from: number;
     to: number;
-    attrs: TrackedAttrs;
+    dataTracked: TrackedAttrs;
 };
 export declare type TextChange = Change & {
     type: 'text-change';
@@ -66,11 +66,11 @@ export declare type MarkChange = Change & {
     type: 'mark-change';
 };
 export declare type TrackedChange = TextChange | NodeChange | NodeAttrChange | WrapChange | MarkChange;
-export declare type PartialChange<T extends TrackedChange> = Omit<T, 'attrs'> & {
-    attrs: Partial<TrackedAttrs>;
+export declare type PartialChange<T extends TrackedChange> = Omit<T, 'dataTracked'> & {
+    dataTracked: Partial<TrackedAttrs>;
 };
-export declare type IncompleteChange = Omit<TrackedChange, 'attrs'> & {
-    attrs: Partial<TrackedAttrs>;
+export declare type IncompleteChange = Omit<TrackedChange, 'dataTracked'> & {
+    dataTracked: Partial<TrackedAttrs>;
 };
 export declare type ChangeType = TrackedChange['type'];
 export {};

package/dist/types/editor.d.ts

@@ -0,0 +1,23 @@
+/*!
+ * © 2021 Atypon Systems LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { EditorState, Transaction } from 'prosemirror-state';
+import { EditorView } from 'prosemirror-view';
+export declare type Commands = {
+    [name: string]: (...args: any[]) => Command;
+};
+export declare type CommandDispatch = (tr: Transaction) => void;
+export declare type Command = (state: EditorState, dispatch?: CommandDispatch, view?: EditorView) => boolean;
+export declare type HigherOrderCommand = (command: Command) => Command;

package/dist/types/step.d.ts

@@ -40,13 +40,14 @@ export interface MergeFragmentStep {
 export interface InsertSliceStep {
     from: number;
     to: number;
+    sliceWasSplit: boolean;
     type: 'insert-slice';
     slice: ExposedSlice;
 }
 export interface UpdateNodeAttrsStep {
     pos: number;
     type: 'update-node-attrs';
-    oldAttrs: Record<string, any>;
+    node: PMNode;
     newAttrs: Record<string, any>;
 }
 export declare type ChangeStep = DeleteNodeStep | DeleteTextStep | MergeFragmentStep | InsertSliceStep | UpdateNodeAttrsStep;

package/dist/types/track.d.ts

@@ -33,7 +33,11 @@ export declare type NewInsertAttrs = Omit<TrackedAttrs, 'id' | 'operation'> & {
 export declare type NewDeleteAttrs = Omit<TrackedAttrs, 'id' | 'operation'> & {
     operation: CHANGE_OPERATION.delete;
 };
-export declare type NewTrackedAttrs = NewInsertAttrs | NewDeleteAttrs;
+export declare type NewUpdateAttrs = Omit<TrackedAttrs, 'id' | 'operation'> & {
+    operation: CHANGE_OPERATION.set_node_attributes;
+    oldAttrs: Record<string, any>;
+};
+export declare type NewTrackedAttrs = NewInsertAttrs | NewDeleteAttrs | NewUpdateAttrs;
 export declare enum TrackChangesStatus {
     enabled = "enabled",
     viewSnapshots = "view-snapshots",

package/dist/utils/track-utils.d.ts

@@ -1,18 +1,4 @@
-/*!
- * © 2021 Atypon Systems LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs } from '../types/track';
+import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs, NewUpdateAttrs } from '../types/track';
 export declare function createNewInsertAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
 export declare function createNewDeleteAttrs(attrs: NewEmptyAttrs): NewDeleteAttrs;
+export declare function createNewUpdateAttrs(attrs: NewEmptyAttrs, oldAttrs: Record<string, any>): NewUpdateAttrs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manuscripts/track-changes-plugin",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "author": "Atypon Systems LLC",
   "license": "Apache-2.0",
   "homepage": "https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/quarterback-packages/track-changes-plugin",
@@ -31,6 +31,7 @@
     "jsdom": "^19.0.0",
     "prosemirror-commands": "^1.3.0",
     "prosemirror-example-setup": "^1.2.1",
+    "prosemirror-history": "^1.3.0",
     "prosemirror-keymap": "^1.2.0",
     "prosemirror-model": "^1.18.1",
     "prosemirror-schema-list": "^1.2.0",