@manuscripts/track-changes-plugin 0.1.1 → 0.4.0

package/dist/{track/steps → mutate}/deleteAndMergeSplitNodes.d.ts

@@ -16,8 +16,9 @@
 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 { ExposedSlice } from '../types/pm';
+import { NewEmptyAttrs } from '../types/track';
+import { ChangeStep } from '../types/step';
 /**
  * Applies deletion to the doc without actually deleting nodes that have not been inserted
  *
@@ -48,6 +49,6 @@ export declare function deleteAndMergeSplitNodes(from: number, to: number, gap:
     end: number;
 } | undefined, startDoc: PMNode, newTr: Transaction, schema: Schema, trackAttrs: NewEmptyAttrs, insertSlice: ExposedSlice): {
     deleteMap: Mapping;
-    mergedInsertPos: undefined;
     newSliceContent: Fragment;
+    steps: ChangeStep[];
 };

package/dist/{track → mutate}/deleteNode.d.ts

@@ -15,6 +15,7 @@
  */
 import { Node as PMNode } from 'prosemirror-model';
 import { Transaction } from 'prosemirror-state';
+import { NewDeleteAttrs } from '../types/track';
 /**
  * Deletes node but tries to leave its content intact by trying to unwrap it first
  *
@@ -25,3 +26,11 @@ import { Transaction } from 'prosemirror-state';
  * @returns
  */
 export declare function deleteNode(node: PMNode, pos: number, tr: Transaction): Transaction;
+/**
+ * Deletes inserted block or inline node, otherwise adds `dataTracked` object with CHANGE_STATUS 'deleted'
+ * @param node
+ * @param pos
+ * @param newTr
+ * @param deleteAttrs
+ */
+export declare function deleteOrSetNodeDeleted(node: PMNode, pos: number, newTr: Transaction, deleteAttrs: NewDeleteAttrs): void;

package/dist/mutate/deleteText.d.ts

@@ -0,0 +1,32 @@
+/*!
+ * © 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';
+import { NewDeleteAttrs } from '../types/track';
+/**
+ * Deletes inserted text directly, otherwise wraps it with tracked_delete mark
+ *
+ * This would work for general inline nodes too, but since node marks don't work properly
+ * with Yjs, attributes are used instead.
+ * @param node
+ * @param pos
+ * @param newTr
+ * @param schema
+ * @param deleteAttrs
+ * @param from
+ * @param to
+ */
+export declare function deleteTextIfInserted(node: PMNode, pos: number, newTr: Transaction, schema: Schema, deleteAttrs: NewDeleteAttrs, from?: number, to?: number): number;

package/dist/{track → mutate}/mergeNode.d.ts

@@ -22,4 +22,4 @@ import { Transaction } from 'prosemirror-state';
  * @param tr
  * @returns
  */
-export declare function mergeNode(node: PMNode, pos: number, tr: Transaction): Transaction<any> | undefined;
+export declare function mergeNode(node: PMNode, pos: number, tr: Transaction): Transaction | undefined;

package/dist/{track/steps → steps}/trackReplaceAroundStep.d.ts

@@ -1,4 +1,5 @@
 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;
+import { NewEmptyAttrs } from '../types/track';
+import { ChangeStep } from '../types/step';
+export declare function trackReplaceAroundStep(step: ReplaceAroundStep, oldState: EditorState, newTr: Transaction, attrs: NewEmptyAttrs): ChangeStep[];

package/dist/{track/steps → steps}/trackReplaceStep.d.ts

@@ -1,4 +1,5 @@
 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;
+import { NewEmptyAttrs } from '../types/track';
+import { ChangeStep } from '../types/step';
+export declare function trackReplaceStep(step: ReplaceStep, oldState: EditorState, newTr: Transaction, attrs: NewEmptyAttrs): [ChangeStep[], number];

package/dist/{track → steps}/trackTransaction.d.ts

@@ -11,7 +11,7 @@ import type { EditorState, Transaction } from 'prosemirror-state';
  * @param tr Original transaction
  * @param oldState State before transaction
  * @param newTr Transaction created from the new editor state
- * @param userID User id
+ * @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, userID: string): Transaction;
+export declare function trackTransaction(tr: Transaction, oldState: EditorState, newTr: Transaction, authorID: string): Transaction;

package/dist/types/change.d.ts

@@ -16,25 +16,28 @@
 export declare enum CHANGE_OPERATION {
     insert = "insert",
     delete = "delete",
-    set_node_attributes = "set_node_attributes",
-    wrap_with_node = "wrap_with_node",
-    unwrap_from_node = "unwrap_from_node",
-    add_mark = "add_mark",
-    remove_mark = "remove_mark"
+    set_node_attributes = "set_attrs"
 }
 export declare enum CHANGE_STATUS {
     accepted = "accepted",
     rejected = "rejected",
     pending = "pending"
 }
-export interface TrackedAttrs {
+declare type InsertDeleteAttrs = {
     id: string;
-    userID: string;
-    operation: CHANGE_OPERATION;
+    authorID: string;
+    reviewedByID: string | null;
+    operation: CHANGE_OPERATION.insert | CHANGE_OPERATION.delete;
     status: CHANGE_STATUS;
     createdAt: number;
-}
-export declare type Change = {
+    updatedAt: number;
+};
+declare type UpdateAttrs = Omit<InsertDeleteAttrs, 'operation'> & {
+    operation: CHANGE_OPERATION.set_node_attributes;
+    oldAttrs: Record<string, any>;
+};
+export declare type TrackedAttrs = InsertDeleteAttrs | UpdateAttrs;
+declare type Change = {
     id: string;
     from: number;
     to: number;
@@ -42,12 +45,19 @@ export declare type Change = {
 };
 export declare type TextChange = Change & {
     type: 'text-change';
+    text: string;
 };
 export declare type NodeChange = Change & {
     type: 'node-change';
     nodeType: string;
     children: TrackedChange[];
 };
+export declare type NodeAttrChange = Change & {
+    type: 'node-attr-change';
+    nodeType: string;
+    oldAttrs: Record<string, any>;
+    newAttrs: Record<string, any>;
+};
 export declare type WrapChange = Change & {
     type: 'wrap-change';
     wrapperNode: string;
@@ -55,7 +65,7 @@ export declare type WrapChange = Change & {
 export declare type MarkChange = Change & {
     type: 'mark-change';
 };
-export declare type TrackedChange = TextChange | NodeChange | WrapChange | MarkChange;
+export declare type TrackedChange = TextChange | NodeChange | NodeAttrChange | WrapChange | MarkChange;
 export declare type PartialChange<T extends TrackedChange> = Omit<T, 'attrs'> & {
     attrs: Partial<TrackedAttrs>;
 };
@@ -63,3 +73,4 @@ export declare type IncompleteChange = Omit<TrackedChange, 'attrs'> & {
     attrs: Partial<TrackedAttrs>;
 };
 export declare type ChangeType = TrackedChange['type'];
+export {};

package/dist/types/step.d.ts

@@ -0,0 +1,52 @@
+/*!
+ * © 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 './pm';
+export interface DeleteNodeStep {
+    pos: number;
+    nodeEnd: number;
+    type: 'delete-node';
+    node: PMNode;
+}
+export interface DeleteTextStep {
+    pos: number;
+    from: number;
+    to: number;
+    type: 'delete-text';
+    node: PMNode;
+}
+export interface MergeFragmentStep {
+    pos: number;
+    mergePos: number;
+    from: number;
+    to: number;
+    type: 'merge-fragment';
+    node: PMNode;
+    fragment: ExposedFragment;
+}
+export interface InsertSliceStep {
+    from: number;
+    to: number;
+    type: 'insert-slice';
+    slice: ExposedSlice;
+}
+export interface UpdateNodeAttrsStep {
+    pos: number;
+    type: 'update-node-attrs';
+    oldAttrs: Record<string, any>;
+    newAttrs: Record<string, any>;
+}
+export declare type ChangeStep = DeleteNodeStep | DeleteTextStep | MergeFragmentStep | InsertSliceStep | UpdateNodeAttrsStep;

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

@@ -13,7 +13,6 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs } from '../../types/track';
-export declare function createNewEmptyAttrs(userID: string, createdAt: number): NewEmptyAttrs;
+import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs } from '../types/track';
 export declare function createNewInsertAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
 export declare function createNewDeleteAttrs(attrs: NewEmptyAttrs): NewDeleteAttrs;

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@manuscripts/track-changes-plugin",
-  "version": "0.1.1",
+  "version": "0.4.0",
   "author": "Atypon Systems LLC",
   "license": "Apache-2.0",
   "homepage": "https://github.com/Atypon-OpenSource/manuscripts-quarterback/tree/main/quarterback-packages/track-changes-plugin",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "type": "module",
   "types": "dist/index.d.ts",
   "exports": {
     "./package.json": "./package.json",
     "./src/styles.css": "./src/styles.css",
-    ".": "./dist/index.es.js"
+    ".": "./dist/index.js"
   },
   "files": [
     "dist",
@@ -21,7 +21,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@manuscripts/manuscript-transform": "^0.49.1",
+    "@manuscripts/manuscript-transform": "^0.49.4",
     "@rollup/plugin-commonjs": "^22.0.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "27.5.1",
@@ -36,7 +36,7 @@
     "prosemirror-schema-list": "^1.2.0",
     "prosemirror-state": "^1.4.1",
     "prosemirror-transform": "^1.6.0",
-    "prosemirror-view": "^1.26.2",
+    "prosemirror-view": "^1.27.0",
     "rollup": "^2.74.0",
     "rollup-plugin-typescript2": "^0.31.2",
     "ts-jest": "27.1.4",

package/dist/types/editor.d.ts

@@ -1,23 +0,0 @@
-/*!
- * © 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;