@manuscripts/track-changes-plugin 2.0.13 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/README.md +3 -3
  2. package/dist/cjs/ChangeSet.js +27 -8
  3. package/dist/cjs/change-steps/processChangeSteps.js +1 -1
  4. package/dist/cjs/changes/applyChanges.js +26 -12
  5. package/dist/cjs/changes/findChanges.js +16 -0
  6. package/dist/cjs/changes/revertChange.js +3 -3
  7. package/dist/cjs/changes/updateChangeAttrs.js +27 -0
  8. package/dist/cjs/compute/nodeHelpers.js +11 -0
  9. package/dist/cjs/mutate/deleteAndMergeSplitNodes.js +2 -1
  10. package/dist/cjs/steps/trackMarkSteps.js +140 -0
  11. package/dist/cjs/steps/trackReplaceAroundStep.js +3 -3
  12. package/dist/cjs/steps/trackReplaceStep.js +3 -3
  13. package/dist/cjs/steps/trackTransaction.js +14 -2
  14. package/dist/cjs/steps/utils.js +70 -0
  15. package/dist/cjs/utils/track-utils.js +28 -51
  16. package/dist/cjs/utils/uuidv4.js +3 -0
  17. package/dist/es/ChangeSet.js +27 -8
  18. package/dist/es/change-steps/processChangeSteps.js +1 -1
  19. package/dist/es/changes/applyChanges.js +26 -11
  20. package/dist/es/changes/findChanges.js +17 -1
  21. package/dist/es/changes/revertChange.js +3 -3
  22. package/dist/es/changes/updateChangeAttrs.js +27 -0
  23. package/dist/es/compute/nodeHelpers.js +10 -0
  24. package/dist/es/mutate/deleteAndMergeSplitNodes.js +2 -1
  25. package/dist/es/steps/trackMarkSteps.js +134 -0
  26. package/dist/es/steps/trackReplaceAroundStep.js +1 -1
  27. package/dist/es/steps/trackReplaceStep.js +1 -1
  28. package/dist/es/steps/trackTransaction.js +14 -2
  29. package/dist/es/steps/utils.js +62 -0
  30. package/dist/es/utils/track-utils.js +24 -45
  31. package/dist/es/utils/uuidv4.js +3 -0
  32. package/dist/types/ChangeSet.d.ts +5 -2
  33. package/dist/types/changes/applyChanges.d.ts +1 -2
  34. package/dist/types/compute/nodeHelpers.d.ts +2 -1
  35. package/dist/types/steps/trackMarkSteps.d.ts +8 -0
  36. package/dist/types/steps/utils.d.ts +28 -0
  37. package/dist/types/types/change.d.ts +4 -1
  38. package/dist/types/utils/track-utils.d.ts +7 -14
  39. package/package.json +1 -1
@@ -39,51 +39,6 @@ export function createNewUpdateAttrs(attrs, oldAttrs) {
39
39
  export function createNewStructureAttrs(attrs) {
40
40
  return Object.assign(Object.assign({}, attrs), { operation: CHANGE_OPERATION.structure });
41
41
  }
42
- export const isSplitStep = (step, selection, uiEvent) => {
43
- var _a, _b, _c, _d;
44
- const { from, to, slice } = step;
45
- if (from !== to ||
46
- slice.content.childCount < 2 ||
47
- (((_a = slice.content.firstChild) === null || _a === void 0 ? void 0 : _a.isInline) && ((_b = slice.content.lastChild) === null || _b === void 0 ? void 0 : _b.isInline))) {
48
- return false;
49
- }
50
- const { $anchor: { parentOffset: startOffset }, $head: { parentOffset: endOffset }, $from, } = selection;
51
- const parentSize = $from.node().content.size;
52
- if (uiEvent === 'paste') {
53
- return !((startOffset === 0 && endOffset === 0) ||
54
- (startOffset === parentSize && endOffset === parentSize));
55
- }
56
- const { content: { firstChild, lastChild }, openStart, openEnd, } = slice;
57
- if ((((_c = window.event) === null || _c === void 0 ? void 0 : _c.code) === 'Enter' || ((_d = window.event) === null || _d === void 0 ? void 0 : _d.code) === 'NumpadEnter') &&
58
- (firstChild === null || firstChild === void 0 ? void 0 : firstChild.type.name) === 'list_item') {
59
- return !(parentSize === startOffset && parentSize === endOffset) && (lastChild === null || lastChild === void 0 ? void 0 : lastChild.type.name) === 'list_item';
60
- }
61
- return (openStart === openEnd &&
62
- firstChild.type === lastChild.type &&
63
- firstChild.inlineContent &&
64
- lastChild.inlineContent &&
65
- !(startOffset === parentSize && endOffset === parentSize));
66
- };
67
- export const isWrapStep = (step) => step.from === step.gapFrom &&
68
- step.to === step.gapTo &&
69
- step.slice.openStart === 0 &&
70
- step.slice.openEnd === 0;
71
- export const isLiftStep = (step) => {
72
- if (step.from < step.gapFrom &&
73
- step.to > step.gapTo &&
74
- step.slice.size === 0 &&
75
- step.gapTo - step.gapFrom > 0) {
76
- return true;
77
- }
78
- return false;
79
- };
80
- export function stepIsLift(gap, node, to) {
81
- return gap.start < gap.end && gap.insert === 0 && gap.end === to && !node.isText;
82
- }
83
- export const isStructureSteps = (tr) => tr.getMeta(TrackChangesAction.structuralChangeAction) &&
84
- tr.steps.length === 2 &&
85
- tr.steps[0] instanceof ReplaceStep &&
86
- tr.steps[1] instanceof ReplaceStep;
87
42
  export const trFromHistory = (tr) => Object.keys(tr.meta).find((s) => s.startsWith('history$'));
88
43
  export const HasMoveOperations = (tr) => {
89
44
  const movingAssoc = new Map();
@@ -236,3 +191,27 @@ export const updateBlockNodesAttrs = (fragment, predicate) => {
236
191
  });
237
192
  return Fragment.fromArray(updatedNodes);
238
193
  };
194
+ export function isValidTrackableMark(mark) {
195
+ var _a, _b;
196
+ const spec = mark.type.spec;
197
+ const name = mark.type.name;
198
+ if (!name.startsWith('tracked_') &&
199
+ ((_a = spec.attrs) === null || _a === void 0 ? void 0 : _a.dataTracked) &&
200
+ typeof ((_b = spec.attrs) === null || _b === void 0 ? void 0 : _b.dataTracked) === 'object') {
201
+ return true;
202
+ }
203
+ return false;
204
+ }
205
+ export function excludeFromTracked(dataTracked, changeIdToExclude) {
206
+ if (!dataTracked) {
207
+ return null;
208
+ }
209
+ const newDataTracked = dataTracked.filter((c) => c.id !== changeIdToExclude);
210
+ return newDataTracked.length ? newDataTracked : null;
211
+ }
212
+ export function isInlineMarkChange(change) {
213
+ if (change.type == 'mark-change') {
214
+ return change.nodeType.isInline || change.nodeType.isText;
215
+ }
216
+ return false;
217
+ }
@@ -1,4 +1,7 @@
1
1
  export function uuidv4() {
2
+ if (typeof crypto !== 'undefined' && crypto.randomUUID) {
3
+ return crypto.randomUUID();
4
+ }
2
5
  return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
3
6
  const r = (Math.random() * 16) | 0, v = c == 'x' ? r : (r & 0x3) | 0x8;
4
7
  return v.toString(16);
@@ -1,4 +1,4 @@
1
- import { IncompleteChange, NodeAttrChange, NodeChange, ReferenceChange, RootChanges, TextChange, TrackedAttrs, TrackedChange } from './types/change';
1
+ import { IncompleteChange, MarkChange, NodeAttrChange, NodeChange, ReferenceChange, RootChanges, TextChange, TrackedAttrs, TrackedChange } from './types/change';
2
2
  export declare class ChangeSet {
3
3
  #private;
4
4
  constructor(changes?: (TrackedChange | IncompleteChange)[]);
@@ -22,12 +22,15 @@ export declare class ChangeSet {
22
22
  index: number;
23
23
  root: NodeChange;
24
24
  } | undefined;
25
- canJoinAdjacentInlineChanges(change: TrackedChange, index: number): boolean | undefined;
25
+ areMatchingWrapOperations(c1: TrackedChange, c2: TrackedChange): boolean;
26
+ areMatchingMarkOperations(c1: TrackedChange, c2: TrackedChange): boolean;
27
+ canJoinAdjacentInlineChanges(change: TrackedChange, index: number): boolean;
26
28
  joinRelatedStructuralChanges(rootNodes: RootChanges, change: TrackedChange): true | undefined;
27
29
  static flattenTreeToIds(changes: TrackedChange[]): string[];
28
30
  static shouldDeleteChange(change: TrackedChange): boolean;
29
31
  static isValidDataTracked(dataTracked?: Partial<TrackedAttrs>): boolean;
30
32
  static isTextChange(change: TrackedChange): change is TextChange;
33
+ static isMarkChange(change: TrackedChange): change is MarkChange;
31
34
  static isNodeChange(change: TrackedChange): change is NodeChange;
32
35
  static isNodeAttrChange(change: TrackedChange): change is NodeAttrChange;
33
36
  static isReferenceChange(change: TrackedChange): change is ReferenceChange;
@@ -2,6 +2,5 @@ import { Schema } from 'prosemirror-model';
2
2
  import { Transaction } from 'prosemirror-state';
3
3
  import { Mapping } from 'prosemirror-transform';
4
4
  import { ChangeSet } from '../ChangeSet';
5
- import { TrackedAttrs, TrackedChange } from '../types/change';
6
- export declare function getUpdatedDataTracked(dataTracked: TrackedAttrs[] | null, changeId: string): TrackedAttrs[] | null;
5
+ import { TrackedChange } from '../types/change';
7
6
  export declare function applyAcceptedRejectedChanges(tr: Transaction, schema: Schema, changes: TrackedChange[], changeSet: ChangeSet, deleteMap?: Mapping): Mapping;
@@ -1,10 +1,11 @@
1
- import { Node as PMNode, Schema } from 'prosemirror-model';
1
+ import { Mark, Node as PMNode, Schema } from 'prosemirror-model';
2
2
  import { CHANGE_OPERATION, TrackedAttrs } from '../types/change';
3
3
  export declare function addTrackIdIfDoesntExist(attrs: Partial<TrackedAttrs>): Partial<TrackedAttrs>;
4
4
  export declare function getTextNodeTrackedMarkData(node: PMNode | undefined | null, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
5
5
  operation: CHANGE_OPERATION;
6
6
  }) | undefined;
7
7
  export declare function getBlockInlineTrackedData(node: PMNode): Partial<TrackedAttrs>[] | undefined;
8
+ export declare function getMarkTrackedData(node: PMNode | undefined | null): Map<Mark, Partial<TrackedAttrs>[]>;
8
9
  export declare function getNodeTrackedData(node: PMNode | undefined | null, schema: Schema): Partial<TrackedAttrs>[] | undefined;
9
10
  export declare function equalMarks(n1: PMNode, n2: PMNode): boolean;
10
11
  export declare function shouldMergeTrackedAttributes(left?: Partial<TrackedAttrs>, right?: Partial<TrackedAttrs>): boolean;
@@ -0,0 +1,8 @@
1
+ import { Node as PMNode } from 'prosemirror-model';
2
+ import { Transaction } from 'prosemirror-state';
3
+ import { AddMarkStep, AddNodeMarkStep, RemoveMarkStep, RemoveNodeMarkStep } from 'prosemirror-transform';
4
+ import { NewEmptyAttrs } from '../types/track';
5
+ export declare function trackRemoveMarkStep(step: RemoveMarkStep, emptyAttrs: NewEmptyAttrs, newTr: Transaction, doc: PMNode): void;
6
+ export declare function trackRemoveNodeMarkStep(step: RemoveNodeMarkStep, emptyAttrs: NewEmptyAttrs, newTr: Transaction, doc: PMNode): void;
7
+ export declare function trackAddMarkStep(step: AddMarkStep, emptyAttrs: NewEmptyAttrs, newTr: Transaction, doc: PMNode): void;
8
+ export declare function trackAddNodeMarkStep(step: AddNodeMarkStep, emptyAttrs: NewEmptyAttrs, newTr: Transaction, stepDoc: PMNode): void;
@@ -0,0 +1,28 @@
1
+ /*!
2
+ * © 2023 Atypon Systems LLC
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+ import { Node as PMNode, Slice } from 'prosemirror-model';
17
+ import { Selection, Transaction } from 'prosemirror-state';
18
+ import { ReplaceAroundStep, ReplaceStep } from 'prosemirror-transform';
19
+ export declare const isSplitStep: (step: ReplaceStep, selection: Selection, uiEvent: string) => boolean;
20
+ export declare const isWrapStep: (step: ReplaceAroundStep) => boolean;
21
+ export declare const isLiftStep: (step: ReplaceAroundStep) => boolean;
22
+ export declare function stepIsLift(gap: {
23
+ start: number;
24
+ end: number;
25
+ slice: Slice;
26
+ insert: number;
27
+ }, node: PMNode, to: number): boolean;
28
+ export declare const isStructureSteps: (tr: Transaction) => any;
@@ -13,7 +13,7 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { Node, NodeType } from 'prosemirror-model';
16
+ import { Mark, Node, NodeType } from 'prosemirror-model';
17
17
  export declare enum CHANGE_OPERATION {
18
18
  insert = "insert",
19
19
  delete = "delete",
@@ -95,6 +95,9 @@ export type ReferenceChange = Change & {
95
95
  };
96
96
  export type MarkChange = Change & {
97
97
  type: 'mark-change';
98
+ nodeType: NodeType;
99
+ mark: Mark;
100
+ node: Node;
98
101
  };
99
102
  export type TrackedChange = TextChange | NodeChange | NodeAttrChange | WrapChange | ReferenceChange | MarkChange;
100
103
  export type PartialChange<T extends TrackedChange> = Omit<T, 'dataTracked'> & {
@@ -1,7 +1,7 @@
1
- import { Attrs, Fragment, Node as PMNode, Slice } from 'prosemirror-model';
2
- import { Selection, Transaction } from 'prosemirror-state';
3
- import { ReplaceAroundStep, ReplaceStep, Step } from 'prosemirror-transform';
4
- import { CHANGE_OPERATION, TrackedAttrs } from '../types/change';
1
+ import { Attrs, Fragment, Mark, Node as PMNode } from 'prosemirror-model';
2
+ import { Transaction } from 'prosemirror-state';
3
+ import { ReplaceStep, Step } from 'prosemirror-transform';
4
+ import { CHANGE_OPERATION, TrackedAttrs, TrackedChange } from '../types/change';
5
5
  import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs, NewMoveAttrs, NewReferenceAttrs, NewSplitNodeAttrs, NewUpdateAttrs } from '../types/track';
6
6
  export declare function createNewInsertAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
7
7
  export declare function createNewWrapAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
@@ -11,16 +11,6 @@ export declare function createNewDeleteAttrs(attrs: NewEmptyAttrs): NewDeleteAtt
11
11
  export declare function createNewMoveAttrs(attrs: NewEmptyAttrs, indentationType?: 'indent' | 'unindent'): NewMoveAttrs;
12
12
  export declare function createNewUpdateAttrs(attrs: NewEmptyAttrs, oldAttrs: Record<string, any>): NewUpdateAttrs;
13
13
  export declare function createNewStructureAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
14
- export declare const isSplitStep: (step: ReplaceStep, selection: Selection, uiEvent: string) => boolean;
15
- export declare const isWrapStep: (step: ReplaceAroundStep) => boolean;
16
- export declare const isLiftStep: (step: ReplaceAroundStep) => boolean;
17
- export declare function stepIsLift(gap: {
18
- start: number;
19
- end: number;
20
- slice: Slice;
21
- insert: number;
22
- }, node: PMNode, to: number): boolean;
23
- export declare const isStructureSteps: (tr: Transaction) => any;
24
14
  export declare const trFromHistory: (tr: Transaction) => string | undefined;
25
15
  export declare const HasMoveOperations: (tr: Transaction) => Map<ReplaceStep, string>;
26
16
  export declare const isPendingChange: (trackedAttrs: TrackedAttrs[] | undefined, operation: CHANGE_OPERATION) => boolean;
@@ -29,3 +19,6 @@ export declare const isDirectPendingMoveDeletion: (step: ReplaceStep, doc: PMNod
29
19
  export declare const handleDirectPendingMoveDeletions: (tr: Transaction, newTr: Transaction, movingSteps: Map<ReplaceStep, string>) => void;
30
20
  export declare const filterMeaninglessMoveSteps: (tr: Transaction, movingSteps: Map<ReplaceStep, string>) => Step[];
31
21
  export declare const updateBlockNodesAttrs: (fragment: Fragment, predicate: (attrs: Attrs, node: PMNode) => Attrs) => Fragment;
22
+ export declare function isValidTrackableMark(mark: Mark): boolean;
23
+ export declare function excludeFromTracked(dataTracked: TrackedAttrs[] | null, changeIdToExclude: string): TrackedAttrs[] | null;
24
+ export declare function isInlineMarkChange(change: TrackedChange): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@manuscripts/track-changes-plugin",
3
- "version": "2.0.13",
3
+ "version": "2.1.1",
4
4
  "author": "Atypon Systems LLC",
5
5
  "license": "Apache-2.0",
6
6
  "homepage": "https://github.com/Atypon-OpenSource/manuscripts-track-changes-plugin",