@manuscripts/track-changes-plugin 1.7.2 → 1.7.3

package/dist/mutate/deleteAndMergeSplitNodes.d.ts

@@ -1,53 +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 { Fragment, Node as PMNode, Schema } from 'prosemirror-model';
-import type { Transaction } from 'prosemirror-state';
-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
- *
- * The hairiest part of this whole library which does a fair bit of magic to split the inserted slice
- * into pieces that can be inserted without deleting nodes in the doc. Basically we first split the
- * inserted slice into merged pieces _if_ the slice was open on either end. Then, we iterate over the deleted
- * range and see if the node in question was completely wrapped in the range (therefore fully deleted)
- * or only partially deleted by the slice. In that case, we merge the content from the inserted slice
- * and keep the original nodes if they do not contain insert attributes.
- *
- * It is definitely a messy function but so far this seems to have been the best approach to prevent
- * deletion of nodes with open slices. Other option would be to allow the deletions to take place but that
- * requires then inserting the deleted nodes back to the doc if their deletion should be prevented, which does
- * not seem trivial either.
- *
- * @param from start of the deleted range
- * @param to end of the deleted range
- * @param gap retained content in a ReplaceAroundStep, not deleted
- * @param startDoc doc before the deletion
- * @param newTr the new track transaction
- * @param schema ProseMirror schema
- * @param deleteAttrs attributes for the dataTracked object
- * @param insertSlice the inserted slice from ReplaceStep
- * @returns mapping adjusted by the applied operations & modified insert slice
- */
-export declare function deleteAndMergeSplitNodes(from: number, to: number, gap: {
-    start: number;
-    end: number;
-} | undefined, startDoc: PMNode, newTr: Transaction, schema: Schema, trackAttrs: NewEmptyAttrs, insertSlice: ExposedSlice): {
-    sliceWasSplit: boolean;
-    newSliceContent: Fragment;
-    steps: ChangeStep[];
-};

package/dist/mutate/deleteNode.d.ts

@@ -1,36 +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 { 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
- *
- * Incase unwrapping doesn't work deletes the whole node.
- * @param node
- * @param pos
- * @param tr
- * @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): Transaction | undefined;

package/dist/mutate/deleteText.d.ts

@@ -1,33 +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 { 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
- * @returns position at the end of the possibly deleted text
- */
-export declare function deleteTextIfInserted(node: PMNode, pos: number, newTr: Transaction, schema: Schema, deleteAttrs: NewDeleteAttrs, from?: number, to?: number): number;

package/dist/mutate/mergeNode.d.ts

@@ -1,25 +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 { Node as PMNode } from 'prosemirror-model';
-import { Transaction } from 'prosemirror-state';
-/**
- * Deletes node but tries to leave its content intact by moving/wrapping it to a node before or after
- * @param node
- * @param pos
- * @param tr
- * @returns
- */
-export declare function mergeNode(node: PMNode, pos: number, tr: Transaction): Transaction | undefined;

package/dist/mutate/mergeTrackedMarks.d.ts

@@ -1,29 +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 { Node as PMNode, Schema } from 'prosemirror-model';
-import type { Transaction } from 'prosemirror-state';
-/**
- * Merges tracked marks between text nodes at a position
- *
- * Will work for any nodes that use tracked_insert or tracked_delete marks which may not be preferrable
- * if used for block nodes (since we possibly want to show the individual changed nodes).
- * Merging is done based on the userID, operation type and status.
- * @param pos
- * @param doc
- * @param newTr
- * @param schema
- */
-export declare function mergeTrackedMarks(pos: number, doc: PMNode, newTr: Transaction, schema: Schema): void;

package/dist/plugin.d.ts

@@ -1,25 +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 { Plugin, PluginKey } from 'prosemirror-state';
-import { TrackChangesOptions, TrackChangesState } from './types/track';
-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>;

package/dist/steps/trackReplaceStep.d.ts

@@ -1,21 +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 { Node as PMNode } from 'prosemirror-model';
-import type { EditorState, Transaction } from 'prosemirror-state';
-import { ReplaceStep, StepResult } from 'prosemirror-transform';
-import { NewEmptyAttrs } from '../types/track';
-import { ChangeStep } from '../types/step';
-export declare function trackReplaceStep(step: ReplaceStep, oldState: EditorState, newTr: Transaction, attrs: NewEmptyAttrs, stepResult: StepResult, currentStepDoc: PMNode): [ChangeStep[], number];

package/dist/steps/trackTransaction.d.ts

@@ -1,17 +0,0 @@
-import type { EditorState, Transaction } from 'prosemirror-state';
-/**
- * Inverts transactions to wrap their contents/operations with track data instead
- *
- * The main function of track changes that holds the most complex parts of this whole library.
- * Takes in as arguments the data from appendTransaction to reapply it with the track marks/attributes.
- * We could prevent the initial transaction from being applied all together but since invert works just
- * as well and we can use the intermediate doc for checking which nodes are changed, it's not prevented.
- *
- *
- * @param tr Original transaction
- * @param oldState State before transaction
- * @param newTr Transaction created from the new editor state
- * @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, authorID: string): Transaction;

package/dist/types/change.d.ts

@@ -1,76 +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.
- */
-export declare enum CHANGE_OPERATION {
-    insert = "insert",
-    delete = "delete",
-    set_node_attributes = "set_attrs"
-}
-export declare enum CHANGE_STATUS {
-    accepted = "accepted",
-    rejected = "rejected",
-    pending = "pending"
-}
-declare type InsertDeleteAttrs = {
-    id: string;
-    authorID: string;
-    reviewedByID: string | null;
-    operation: CHANGE_OPERATION.insert | CHANGE_OPERATION.delete;
-    status: CHANGE_STATUS;
-    createdAt: number;
-    updatedAt: number;
-};
-export 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;
-    dataTracked: TrackedAttrs;
-};
-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;
-};
-export declare type MarkChange = Change & {
-    type: 'mark-change';
-};
-export declare type TrackedChange = TextChange | NodeChange | NodeAttrChange | WrapChange | MarkChange;
-export declare type PartialChange<T extends TrackedChange> = Omit<T, 'dataTracked'> & {
-    dataTracked: Partial<TrackedAttrs>;
-};
-export declare type IncompleteChange = Omit<TrackedChange, 'dataTracked'> & {
-    dataTracked: Partial<TrackedAttrs>;
-};
-export declare type ChangeType = TrackedChange['type'];
-export {};

package/dist/types/pm.d.ts

@@ -1,27 +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 { Fragment, Node as PMNode, Slice } from 'prosemirror-model';
-import { ReplaceStep } from 'prosemirror-transform';
-export declare type ExposedReplaceStep = ReplaceStep & {
-    slice: ExposedSlice;
-};
-export declare type ExposedSlice = Slice & {
-    content: ExposedFragment;
-    insertAt(pos: number, fragment: Fragment | ExposedFragment): ExposedSlice;
-};
-export declare type ExposedFragment = Fragment & {
-    content: PMNode[];
-};

package/dist/types/track.d.ts

@@ -1,45 +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 type { PluginKey } from 'prosemirror-state';
-import { ChangeSet } from '../ChangeSet';
-import { CHANGE_OPERATION, TrackedAttrs } from './change';
-export interface TrackChangesOptions {
-    debug?: boolean;
-    userID: string;
-    skipTrsWithMetas?: (PluginKey | string)[];
-}
-export interface TrackChangesState {
-    status: TrackChangesStatus;
-    userID: string;
-    changeSet: ChangeSet;
-}
-export declare type NewEmptyAttrs = Omit<TrackedAttrs, 'id' | 'operation'>;
-export declare type NewInsertAttrs = Omit<TrackedAttrs, 'id' | 'operation'> & {
-    operation: CHANGE_OPERATION.insert;
-};
-export declare type NewDeleteAttrs = Omit<TrackedAttrs, 'id' | 'operation'> & {
-    operation: CHANGE_OPERATION.delete;
-};
-export declare type NewUpdateAttrs = Omit<TrackedAttrs, 'id' | 'operation'> & {
-    operation: CHANGE_OPERATION.set_node_attributes;
-    oldAttrs: Record<string, any>;
-};
-export declare type NewTrackedAttrs = NewInsertAttrs | NewDeleteAttrs | NewUpdateAttrs;
-export declare enum TrackChangesStatus {
-    enabled = "enabled",
-    viewSnapshots = "view-snapshots",
-    disabled = "disabled"
-}

package/dist/utils/logger.d.ts

@@ -1,27 +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 debug from 'debug';
-export declare const logger: debug.Debugger;
-export declare const log: {
-    info(str: string, obj?: any): void;
-    warn(str: string, obj?: any): void;
-    error(str: string, obj?: any): void;
-};
-/**
- * Sets debug logging enabled/disabled.
- * @param enabled
- */
-export declare const enableDebug: (enabled: boolean) => void;

package/dist/utils/uuidv4.d.ts

@@ -1,16 +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.
- */
-export declare function uuidv4(): string;