@manuscripts/track-changes-plugin 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [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.

package/README.md

@@ -0,0 +1,168 @@
+# @manuscripts/track-changes-plugin
+
+This is a ProseMirror plugin that tracks inserts/deletes to nodes and text.
+
+It uses node attributes inside `dataTracked` object to persist changes for both block and inline nodes and `tracked_insert` & `tracked_delete` marks for text. An example implementation can be found inside the `examples-packages/schema` package. In addition to `dataTracked`, `tracked_insert` and `tracked_delete` code_blocks marks were altered to include track marks: `marks: 'tracked_insert tracked_delete'`. If you have multiple versions of prosemirror packages, ensure that track-changes' dependencies `prosemirror-model` and `prosemirror-transform` are aliased/deduped to same instance. `prosemirror-state` and `prosemirror-view` are only used at type level.
+
+This library replaces a previous implementation based on commits as in https://prosemirror.net/examples/track/ which proved unreliable due to non-idempotent nature of transactions when rebased as well as the inability to transition to Yjs syncing. `prosemirror-changeset` was also trialed but it had similar problems and was deemed hard to extend to include tracking formatting changes.
+
+On a more detailed level, this plugin checks every transaction in an `appendTransaction` hook for any modifications to the document (`tr.docChanged`). If they exist, it prevents that transaction from happening by inverting it and reapplying it with deletions and insertions wrapped in track attributes/marks. It can be bybassed by using `TrackActions.skipTrack` action or by setting `skipTrsWithMetas?: (PluginKey | string)[]` option to skip all transactions based on their meta fields, such as `ySyncPluginKey`. This prevents race conditions where appendTransactions keep firing between 2 or more plugins. `prosemirror-history` transactions are skipped by default.
+
+On every transaction prevented, ChangeSet is generated which contains all the changes found from the document. `tr.setMeta('origin', trackChangesPluginKey)` is applied to id the transaction. Whole document is currently being iterated which may be somewhat inefficient on larger docs. The changes are stored as a flat list yet due to the hierarchy of the changes, a `changeTree` property is generated which wraps all changes within a node change as its children. This is especially helpful when inserting/deleting nodes that require multiple children that are irrelevant to the user. Currently, they are still shown in the example UI but future enhancements will probably hide them. Granular controls are however at times needed when some of the changes can be considered separate or non-contiguous.
+
+Yjs collaboration works without further integration with this attribute & mark based approach. However, due to missing feature-parity with Yjs documents and ProseMirror documents it currently does not behave consistently. Notably, Yjs snapshots do not show node attributes which makes using them for viewing snapshots insufficient. Yjs nodes can't also contain marks but this was circumvented by using node attributes for inline nodes too.
+
+The plugin also includes logging using `debug` library that can be toggled with either passing `debug?: boolean` option or executing `enableDebug(enabled: boolean)`.
+
+CKEditor and Fiduswriter served as its inspiration but everything was written from scratch. Also, this library is open-sourced under the Apache 2 license.
+
+## API
+
+As copied from the source.
+
+```ts
+export const trackChangesPluginKey = new PluginKey<TrackChangesState, any>('track-changes')
+
+/**
+ * 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 const trackChangesPlugin = (opts?: TrackChangesOptions) => Plugin<TrackChangesState, any>
+
+export interface TrackChangesOptions {
+  debug?: boolean
+  userID: string
+  skipTrsWithMetas?: (PluginKey | string)[]
+}
+export interface TrackChangesState {
+  status: TrackChangesStatus
+  userID: string
+  changeSet: ChangeSet
+}
+export enum TrackChangesStatus {
+  enabled = 'enabled',
+  viewSnapshots = 'view-snapshots',
+  disabled = 'disabled',
+}
+
+export const enableDebug = (enabled: boolean) => void
+```
+
+### Commands
+
+```ts
+/**
+ * Sets track-changes plugin's status to any of: 'enabled' 'disabled' 'viewSnapshots'. Passing undefined will
+ * set 'enabled' status to 'disabled' and 'disabled' | 'viewSnapshots' status to 'enabled'.
+ *
+ * In disabled view, the plugin is completely inactive and changes are not updated anymore.
+ * In viewSnasphots state, editor is set uneditable by editable prop that allows only selection changes
+ * to the document.
+ * @param status
+ */
+export const setTrackingStatus = (status?: TrackChangesStatus) => Command
+
+/**
+ * Appends a transaction to set change attributes/marks' statuses to any of: 'pending' 'accepted' 'rejected'.
+ * @param status
+ * @param ids
+ */
+export const setChangeStatuses = (status: CHANGE_STATUS, ids: string[]) => Command
+
+/**
+ * Sets track-changes plugin's userID.
+ * @param userID
+ */
+export const setUserID = (userID: string) => Command
+
+/**
+ * Appends a transaction that applies all 'accepted' and 'rejected' changes to the document.
+ */
+export const applyAndRemoveChanges = () => Command
+
+/**
+ * Runs `findChanges` to iterate over the document to collect changes into a new ChangeSet.
+ */
+export const refreshChanges = () => Command
+```
+
+### Actions
+
+Actions are used to access/set transaction meta fields. I don't think you ever would need to use other than `TrackChangesAction.skipTrack` but they are all exposed, nonetheless.
+
+```ts
+export type TrackChangesActionParams = {
+  [TrackChangesAction.skipTrack]: boolean
+  [TrackChangesAction.setUserID]: string
+  [TrackChangesAction.setPluginStatus]: TrackChangesStatus
+  [TrackChangesAction.setChangeStatuses]: {
+    status: CHANGE_STATUS
+    ids: string[]
+  }
+  [TrackChangesAction.updateChanges]: string[]
+  [TrackChangesAction.refreshChanges]: boolean
+  [TrackChangesAction.applyAndRemoveChanges]: boolean
+}
+/**
+ * Gets the value of a meta field, action payload, of a defined track-changes action.
+ * @param tr
+ * @param action
+ */
+export function getAction<K extends keyof TrackChangesActionParams>(tr: Transaction, action: K) {
+  return tr.getMeta(action) as TrackChangesActionParams[K] | undefined
+}
+
+/**
+ * Use this function to set meta keys to transactions that are consumed by the track-changes-plugin.
+ * For example, you can skip tracking of a transaction with setAction(tr, TrackChangesAction.skipTrack, true)
+ * @param tr
+ * @param action
+ * @param payload
+ */
+export function setAction<K extends keyof TrackChangesActionParams>(
+  tr: Transaction,
+  action: K,
+  payload: TrackChangesActionParams[K]
+) {
+  return tr.setMeta(action, payload)
+}
+```
+
+### Types
+
+Can be found in `./src/types` and `./src/ChangeSet.ts`
+
+## Feature summary
+
+- tracks block, inline, atom node inserts & deletes as `dataTracked` attribute objects
+- tracks text insert & delete as `tracked_insert` and `tracked_delete` marks
+- joins track marks based on `userID`, `operation` and `status`, uses the oldest `createdAt` value as timestamp
+- allows deletes of block nodes & text if operation is `inserted`
+- does not diff operations next to each other eg `(ins aasdf)(del asdf)` is not reduced to `ins a`
+- does not track block node attribute updates
+- does not track mark inserts & deletes
+- does not track ReplaceAroundSteps
+- has probably bugs regarding the edge cases around copy-pasting complicated slices
+
+## Roadmap
+
+- track block node attribute updates, they currently go undetected
+- test copy-pasting works (slices with varying open endedness)
+- test for race conditions
+- refactor unused code, add better comments
+- more thorough tests
+- track ReplaceAroundSteps
+- track formatting changes, basically handle AddMarkStep and RemoveMarkSteps
+
+## Related reading
+
+- https://ckeditor.com/docs/ckeditor5/latest/features/collaboration/track-changes/track-changes.html
+- https://ckeditor.com/blog/ckeditor-5-comparing-revision-history-with-track-changes/
+- https://github.com/fiduswriter/fiduswriter
+- https://www.ncbi.nlm.nih.gov/books/NBK159965/
+- https://teemukoivisto.github.io/prosemirror-track-changes-example/
+- https://demos.yjs.dev/prosemirror-versions/prosemirror-versions.html
+- https://slab.com/blog/announcing-delta-for-elixir/
+- https://www.inkandswitch.com/peritext/

package/dist/ChangeSet.d.ts

@@ -0,0 +1,73 @@
+/*!
+ * © 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 { NodeChange, IncompleteChange, TextChange, TrackedAttrs, TrackedChange } from './types/change';
+/**
+ * ChangeSet is a data structure to contain the tracked changes with some utility methods and computed
+ * values to allow easier operability.
+ */
+export declare class ChangeSet {
+    #private;
+    constructor(changes?: (TrackedChange | IncompleteChange)[]);
+    /**
+     * List of all the valid TrackedChanges. This prevents for example changes with duplicate ids being shown
+     * in the UI, causing errors.
+     */
+    get changes(): TrackedChange[];
+    get invalidChanges(): (TrackedChange | IncompleteChange)[];
+    /**
+     * List of 1-level nested changes where the top-most node change contains all the changes within its start
+     * and end position. This is useful for showing the changes as groups in the UI.
+     */
+    get changeTree(): TrackedChange[];
+    get pending(): TrackedChange[];
+    get accepted(): TrackedChange[];
+    get rejected(): TrackedChange[];
+    get textChanges(): TrackedChange[];
+    get nodeChanges(): TrackedChange[];
+    get isEmpty(): boolean;
+    /**
+     * Used to determine whether `fixInconsistentChanges` has to be executed to replace eg duplicate ids or
+     * changes that are missing attributes.
+     */
+    get hasInconsistentData(): boolean;
+    get hasDuplicateIds(): boolean;
+    get hasIncompleteAttrs(): boolean;
+    get(id: string): TrackedChange | IncompleteChange | undefined;
+    getIn(ids: string[]): (TrackedChange | IncompleteChange)[];
+    getNotIn(ids: string[]): (TrackedChange | IncompleteChange)[];
+    /**
+     * Flattens a changeTree into a list of IDs
+     * @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
+     */
+    static shouldDeleteChange(change: TrackedChange): boolean;
+    /**
+     * Checks whether change attributes contain all TrackedAttrs keys with non-undefined values
+     * @param attrs
+     */
+    static isValidTrackedAttrs(attrs?: Partial<TrackedAttrs>): boolean;
+    static isTextChange(change: TrackedChange): change is TextChange;
+    static isNodeChange(change: TrackedChange): change is NodeChange;
+}

package/dist/actions.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 { Transaction } from 'prosemirror-state';
+import { CHANGE_STATUS } from './types/change';
+import { TrackChangesStatus } from './types/track';
+export declare enum TrackChangesAction {
+    skipTrack = "track-changes-skip-tracking",
+    setUserID = "track-changes-set-user-id",
+    setPluginStatus = "track-changes-set-track-status",
+    setChangeStatuses = "track-changes-set-change-statuses",
+    updateChanges = "track-changes-update-changes",
+    refreshChanges = "track-changes-refresh-changes",
+    applyAndRemoveChanges = "track-changes-apply-remove-changes"
+}
+export declare type TrackChangesActionParams = {
+    [TrackChangesAction.skipTrack]: boolean;
+    [TrackChangesAction.setUserID]: string;
+    [TrackChangesAction.setPluginStatus]: TrackChangesStatus;
+    [TrackChangesAction.setChangeStatuses]: {
+        status: CHANGE_STATUS;
+        ids: string[];
+    };
+    [TrackChangesAction.updateChanges]: string[];
+    [TrackChangesAction.refreshChanges]: boolean;
+    [TrackChangesAction.applyAndRemoveChanges]: boolean;
+};
+/**
+ * Gets the value of a meta field, action payload, of a defined track-changes action.
+ * @param tr
+ * @param action
+ */
+export declare function getAction<K extends keyof TrackChangesActionParams>(tr: Transaction, action: K): TrackChangesActionParams[K] | undefined;
+/**
+ * Use this function to set meta keys to transactions that are consumed by the track-changes-plugin.
+ * For example, you can skip tracking of a transaction with setAction(tr, TrackChangesAction.skipTrack, true)
+ * @param tr
+ * @param action
+ * @param payload
+ */
+export declare function setAction<K extends keyof TrackChangesActionParams>(tr: Transaction, action: K, payload: TrackChangesActionParams[K]): Transaction<any>;

package/dist/commands.d.ts

@@ -0,0 +1,51 @@
+/*!
+ * © 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 { 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
+ * set 'enabled' status to 'disabled' and 'disabled' | 'viewSnapshots' status to 'enabled'.
+ *
+ * In disabled view, the plugin is completely inactive and changes are not updated anymore.
+ * In viewSnasphots state, editor is set uneditable by editable prop that allows only selection changes
+ * to the document.
+ * @param status
+ */
+export declare const setTrackingStatus: (status?: TrackChangesStatus | undefined) => Command;
+/**
+ * Appends a transaction to set change attributes/marks' statuses to any of: 'pending' 'accepted' 'rejected'.
+ * @param status
+ * @param ids
+ */
+export declare const setChangeStatuses: (status: CHANGE_STATUS, ids: string[]) => Command;
+/**
+ * Sets track-changes plugin's userID.
+ * @param userID
+ */
+export declare const setUserID: (userID: string) => Command;
+/**
+ * Appends a transaction that applies all 'accepted' and 'rejected' changes to the document.
+ */
+export declare const applyAndRemoveChanges: () => Command;
+/**
+ * Runs `findChanges` to iterate over the document to collect changes into a new ChangeSet.
+ */
+export declare const refreshChanges: () => Command;
+/**
+ * Adds track attributes for a block node. For testing puroses
+ */
+export declare const setParagraphTestAttribute: (val?: string) => Command;

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * © 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.
+ */
+export { trackChangesPluginKey, trackChangesPlugin } from './plugin';
+export * from './actions';
+export * as trackCommands from './commands';
+export { enableDebug } from './utils/logger';
+export { ChangeSet } from './ChangeSet';
+export * from './types/change';
+export * from './types/track';