@manuscripts/track-changes-plugin 0.3.0 → 0.4.2

package/dist/ChangeSet.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { NodeChange, IncompleteChange, TextChange, TrackedAttrs, TrackedChange } from './types/change';
+import { NodeChange, IncompleteChange, TextChange, TrackedAttrs, TrackedChange, NodeAttrChange } from './types/change';
 /**
  * ChangeSet is a data structure to contain the tracked changes with some utility methods and computed
  * values to allow easier operability.
@@ -37,6 +37,8 @@ export declare class ChangeSet {
     get rejected(): TrackedChange[];
     get textChanges(): TrackedChange[];
     get nodeChanges(): TrackedChange[];
+    get nodeAttrChanges(): TrackedChange[];
+    get bothNodeChanges(): TrackedChange[];
     get isEmpty(): boolean;
     /**
      * Used to determine whether `fixInconsistentChanges` has to be executed to replace eg duplicate ids or
@@ -53,11 +55,6 @@ export declare class ChangeSet {
      * @param changes
      */
     static flattenTreeToIds(changes: TrackedChange[]): string[];
-    /**
-     * Determines whether a change should not be deleted when applying it to the document.
-     * @param change
-     */
-    static shouldNotDelete(change: TrackedChange): boolean;
     /**
      * Determines whether a change should be deleted when applying it to the document.
      * @param change
@@ -65,9 +62,10 @@ export declare class ChangeSet {
     static shouldDeleteChange(change: TrackedChange): boolean;
     /**
      * Checks whether change attributes contain all TrackedAttrs keys with non-undefined values
-     * @param attrs
+     * @param dataTracked
      */
-    static isValidTrackedAttrs(attrs?: Partial<TrackedAttrs>): boolean;
+    static isValidDataTracked(dataTracked?: Partial<TrackedAttrs>): boolean;
     static isTextChange(change: TrackedChange): change is TextChange;
     static isNodeChange(change: TrackedChange): change is NodeChange;
+    static isNodeAttrChange(change: TrackedChange): change is NodeAttrChange;
 }

package/dist/{track/steps/track-utils.d.ts → change-steps/diffChangeSteps.d.ts}

@@ -13,6 +13,7 @@
  * 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;
+import { Schema } from 'prosemirror-model';
+import type { Transaction } from 'prosemirror-state';
+import { ChangeStep, InsertSliceStep } from '../types/step';
+export declare function diffChangeSteps(deleted: ChangeStep[], inserted: InsertSliceStep[], newTr: Transaction, schema: Schema): ChangeStep[];

package/dist/change-steps/matchInserted.d.ts

@@ -0,0 +1,3 @@
+import { ExposedFragment } from '../types/pm';
+import { ChangeStep } from '../types/step';
+export declare function matchInserted(matchedDeleted: number, deleted: ChangeStep[], inserted: ExposedFragment): [number, ChangeStep[]];

package/dist/change-steps/processChangeSteps.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 type { Transaction } from 'prosemirror-state';
+import { Mapping } from 'prosemirror-transform';
+import { ChangeStep } from '../types/step';
+import { NewEmptyAttrs } from '../types/track';
+export declare function processChangeSteps(changes: ChangeStep[], startPos: number, newTr: Transaction, emptyAttrs: NewEmptyAttrs, schema: Schema): [Mapping, number];

package/dist/{track → changes}/fixInconsistentChanges.d.ts

@@ -26,4 +26,4 @@ import { ChangeSet } from '../ChangeSet';
  * @param schema
  * @return docWasChanged, a boolean
  */
-export declare function fixInconsistentChanges(changeSet: ChangeSet, trackUserID: string, newTr: Transaction, schema: Schema): boolean;
+export declare function fixInconsistentChanges(changeSet: ChangeSet, currentUserID: string, newTr: Transaction, schema: Schema): boolean;

package/dist/commands.d.ts

@@ -13,8 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Command } from 'prosemirror-state';
 import { CHANGE_STATUS } from './types/change';
-import type { Command } from './types/editor';
 import { TrackChangesStatus } from './types/track';
 /**
  * Sets track-changes plugin's status to any of: 'enabled' 'disabled' 'viewSnapshots'. Passing undefined will

package/dist/{track/node-utils.d.ts → compute/nodeHelpers.d.ts}

@@ -16,10 +16,11 @@
 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"> & {
+export declare function getTextNodeTrackedMarkData(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 getBlockInlineTrackedData(node: PMNode): Partial<TrackedAttrs>[] | 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"> & {

package/dist/{track/steps → compute}/setFragmentAsInserted.d.ts

@@ -14,5 +14,5 @@
  * limitations under the License.
  */
 import { Fragment, Schema } from 'prosemirror-model';
-import { NewInsertAttrs } from '../../types/track';
+import { NewInsertAttrs } from '../types/track';
 export declare function setFragmentAsInserted(inserted: Fragment, insertAttrs: NewInsertAttrs, schema: Schema): Fragment;

package/dist/compute/splitSliceIntoMergedParts.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * © 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 { ExposedFragment, ExposedSlice } from '../types/pm';
+/**
+ * Filters merged nodes from an open insertSlice to manually merge them to prevent unwanted deletions
+ *
+ * So instead of joining the slice by its open sides, possibly deleting previous nodes, we can push the
+ * changed content manually inside the merged nodes.
+ * Eg. instead of doing `|<p>asdf</p><p>|bye</p>` automatically, we extract the merged nodes first:
+ * {
+ *  updatedSliceNodes: [<p>asdf</p>],
+ *  firstMergedNode: <p>bye</p>,
+ *  lastMergedNode: undefined,
+ * }
+ * @param insertSlice inserted slice
+ */
+export declare function splitSliceIntoMergedParts(insertSlice: ExposedSlice, mergeEqualSides?: boolean): {
+    updatedSliceNodes: PMNode[];
+    firstMergedNode: {
+        mergedNodeContent: ExposedFragment;
+        unmergedContent: ExposedFragment | undefined;
+    } | undefined;
+    lastMergedNode: {
+        mergedNodeContent: ExposedFragment;
+        unmergedContent: ExposedFragment | undefined;
+    } | undefined;
+};