@manuscripts/track-changes-plugin 0.0.4 → 0.3.0

package/dist/plugin.d.ts

@@ -15,11 +15,11 @@
  */
 import { Plugin, PluginKey } from 'prosemirror-state';
 import { TrackChangesOptions, TrackChangesState } from './types/track';
-export declare const trackChangesPluginKey: PluginKey<TrackChangesState, any>;
+export declare const trackChangesPluginKey: PluginKey<TrackChangesState>;
 /**
  * The ProseMirror plugin needed to enable track-changes.
  *
  * Accepts an empty options object as an argument but note that this uses 'anonymous:Anonymous' as the default userID.
  * @param opts
  */
-export declare const trackChangesPlugin: (opts?: TrackChangesOptions) => Plugin<TrackChangesState, any>;
+export declare const trackChangesPlugin: (opts?: TrackChangesOptions) => Plugin<TrackChangesState>;

package/dist/track/deleteNode.d.ts

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

package/dist/track/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/node-utils.d.ts

@@ -14,21 +14,14 @@
  * limitations under the License.
  */
 import { Node as PMNode, Schema } from 'prosemirror-model';
-import { Transaction } from 'prosemirror-state';
 import { CHANGE_OPERATION, TrackedAttrs } from '../types/change';
 export declare function addTrackIdIfDoesntExist(attrs: Partial<TrackedAttrs>): Partial<TrackedAttrs>;
-/**
- * Not in use, maybe for ReplaceAroundSteps but we'll see
- * @param pos
- * @param tr
- */
-export declare function liftNode(pos: number, tr: Transaction): Transaction<any> | undefined;
-export declare function getInlineNodeTrackedMarkData(node: PMNode | undefined | null, schema: Schema): {
+export declare function getInlineNodeTrackedMarkData(node: PMNode | undefined | null, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
     operation: CHANGE_OPERATION;
-} | undefined;
+}) | 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): {
+export declare function getMergeableMarkTrackedAttrs(node: PMNode | undefined | null, attrs: Partial<TrackedAttrs>, schema: Schema): (Omit<Partial<TrackedAttrs>, "operation"> & {
     operation: CHANGE_OPERATION;
-} | null;
+}) | null;

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

@@ -49,5 +49,5 @@ export declare function deleteAndMergeSplitNodes(from: number, to: number, gap:
 } | undefined, startDoc: PMNode, newTr: Transaction, schema: Schema, trackAttrs: NewEmptyAttrs, insertSlice: ExposedSlice): {
     deleteMap: Mapping;
     mergedInsertPos: undefined;
-    newSliceContent: Fragment<any>;
+    newSliceContent: Fragment;
 };

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

@@ -15,4 +15,4 @@
  */
 import { Fragment, Schema } from 'prosemirror-model';
 import { NewInsertAttrs } from '../../types/track';
-export declare function setFragmentAsInserted(inserted: Fragment, insertAttrs: NewInsertAttrs, schema: Schema): Fragment<any>;
+export declare function setFragmentAsInserted(inserted: Fragment, insertAttrs: NewInsertAttrs, schema: Schema): Fragment;

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

@@ -14,6 +14,5 @@
  * limitations under the License.
  */
 import { NewDeleteAttrs, NewEmptyAttrs, NewInsertAttrs } from '../../types/track';
-export declare function createNewEmptyAttrs(userID: string, createdAt: number): NewEmptyAttrs;
 export declare function createNewInsertAttrs(attrs: NewEmptyAttrs): NewInsertAttrs;
 export declare function createNewDeleteAttrs(attrs: NewEmptyAttrs): NewDeleteAttrs;

package/dist/track/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<any>;
+export declare function trackTransaction(tr: Transaction, oldState: EditorState, newTr: Transaction, authorID: string): Transaction;

package/dist/types/change.d.ts

@@ -29,10 +29,12 @@ export declare enum CHANGE_STATUS {
 }
 export interface TrackedAttrs {
     id: string;
-    userID: string;
+    authorID: string;
+    reviewedByID: string | null;
     operation: CHANGE_OPERATION;
     status: CHANGE_STATUS;
     createdAt: number;
+    updatedAt: number;
 }
 export declare type Change = {
     id: string;
@@ -42,6 +44,7 @@ export declare type Change = {
 };
 export declare type TextChange = Change & {
     type: 'text-change';
+    text: string;
 };
 export declare type NodeChange = Change & {
     type: 'node-change';

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "@manuscripts/track-changes-plugin",
-  "version": "0.0.4",
+  "version": "0.3.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,30 +21,25 @@
     "access": "public"
   },
   "devDependencies": {
+    "@manuscripts/manuscript-transform": "^0.49.4",
     "@rollup/plugin-commonjs": "^22.0.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "27.5.1",
     "@types/node": "^17.0.35",
-    "@types/prosemirror-commands": "^1.0.4",
-    "@types/prosemirror-model": "^1.16.2",
-    "@types/prosemirror-schema-list": "^1.0.3",
-    "@types/prosemirror-state": "^1.3.0",
-    "@types/prosemirror-transform": "^1.4.1",
-    "@types/prosemirror-view": "^1.23.3",
-    "jest": "28.1.0",
-    "jest-environment-jsdom": "28.1.0",
+    "jest": "27.5.1",
+    "jest-environment-jsdom": "27.5.1",
     "jsdom": "^19.0.0",
-    "prosemirror-commands": "^1.2.2",
-    "prosemirror-example-setup": "^1.1.2",
-    "prosemirror-keymap": "^1.1.5",
-    "prosemirror-model": "^1.16.1",
-    "prosemirror-schema-list": "^1.1.6",
-    "prosemirror-state": "^1.3.4",
-    "prosemirror-transform": "^1.4.2",
-    "prosemirror-view": "^1.23.13",
+    "prosemirror-commands": "^1.3.0",
+    "prosemirror-example-setup": "^1.2.1",
+    "prosemirror-keymap": "^1.2.0",
+    "prosemirror-model": "^1.18.1",
+    "prosemirror-schema-list": "^1.2.0",
+    "prosemirror-state": "^1.4.1",
+    "prosemirror-transform": "^1.6.0",
+    "prosemirror-view": "^1.26.2",
     "rollup": "^2.74.0",
     "rollup-plugin-typescript2": "^0.31.2",
-    "ts-jest": "28.0.2",
+    "ts-jest": "27.1.4",
     "tslib": "^2.4.0",
     "typescript": "^4.6.4"
   },
@@ -62,6 +57,7 @@
     "watch": "rollup -cw",
     "test": "jest --runInBand",
     "format": "prettier --write \"*.+(js|json|yml|yaml|ts|md|graphql|mdx)\" src/ test/",
+    "typecheck": "tsc --project tsconfig.test.json --noEmit",
     "lint": "eslint --cache --ext .js,.ts, ./src ./test",
     "lint:fix": "eslint --fix --ext .js,.ts, ./src ./test"
   }