@manuscripts/body-editor 3.14.0 → 3.15.0

package/dist/es/plugins/cross-references.js

@@ -13,13 +13,62 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { schema } from '@manuscripts/transform';
+import { schema, } from '@manuscripts/transform';
+import { trackChangesPluginKey } from '@manuscripts/track-changes-plugin';
 import { isEqual } from 'lodash';
-import { Plugin } from 'prosemirror-state';
+import { NodeSelection, Plugin } from 'prosemirror-state';
 import { Decoration, DecorationSet } from 'prosemirror-view';
+import { openCrossRefWarningModal } from '../components/cross-ref-check-modal/openModal';
 import { objectsKey } from './objects';
+let modalActive = false;
+let modalElement = null;
 export default () => {
+    let view = null;
     return new Plugin({
+        view(editorView) {
+            view = editorView;
+            return {
+                update(v) {
+                    view = v;
+                },
+                destroy() {
+                    view = null;
+                },
+            };
+        },
+        filterTransaction(tr, state) {
+            if (!view ||
+                !tr.docChanged ||
+                tr.getMeta(trackChangesPluginKey) ||
+                tr.getMeta('addToHistory') === false) {
+                return true;
+            }
+            if (modalActive) {
+                return false;
+            }
+            const targets = objectsKey.getState(state);
+            const xrefGroups = createXrefGroups(targets, state.doc, tr.doc);
+            if (xrefGroups.length === 0) {
+                return true;
+            }
+            modalActive = true;
+            const cleanup = () => {
+                modalActive = false;
+                if (modalElement) {
+                    modalElement.classList.remove('modal-bottom');
+                    modalElement.remove();
+                    modalElement = null;
+                }
+            };
+            const deletedIds = new Set(xrefGroups.map((g) => g.referenced.attrs.id));
+            const onClose = () => {
+                cleanup();
+            };
+            if (view) {
+                modalElement = openCrossRefWarningModal(view, xrefGroups, onConfirmCreator(view, cleanup, deletedIds, tr), onClose, selectAndScrollToCreator(view));
+            }
+            return false;
+        },
         state: {
             init() {
                 return DecorationSet.empty;
@@ -53,3 +102,114 @@ function createDecorations(doc) {
     });
     return decorations;
 }
+function createXrefGroups(targets, stateDoc, resultDoc) {
+    const newIds = new Set();
+    const xrefRids = new Set();
+    const xrefGroups = [];
+    resultDoc.descendants((node) => {
+        if (node.attrs.id) {
+            newIds.add(node.attrs.id);
+        }
+        if (node.type === schema.nodes.cross_reference) {
+            for (const rid of node.attrs.rids) {
+                xrefRids.add(rid);
+            }
+        }
+    });
+    const orphanedRids = new Set();
+    for (const rid of xrefRids) {
+        if (!newIds.has(rid)) {
+            orphanedRids.add(rid);
+        }
+    }
+    if (orphanedRids.size === 0) {
+        return [];
+    }
+    const referencedNodes = new Map();
+    const xrefsByRid = new Map();
+    stateDoc.descendants((node, pos) => {
+        const id = node.attrs.id;
+        if (id && orphanedRids.has(id)) {
+            referencedNodes.set(id, node);
+        }
+        if (node.type === schema.nodes.cross_reference) {
+            for (const rid of node.attrs.rids) {
+                if (orphanedRids.has(rid)) {
+                    let entries = xrefsByRid.get(rid);
+                    if (!entries) {
+                        entries = [];
+                        xrefsByRid.set(rid, entries);
+                    }
+                    entries.push([node, stateDoc.resolve(pos)]);
+                }
+            }
+        }
+    });
+    for (const [id, referenced] of referencedNodes) {
+        const xrefs = xrefsByRid.get(id);
+        if (xrefs?.length) {
+            const label = targets.get(referenced.attrs.id)?.label || '';
+            xrefGroups.push({ referenced, label, xrefs });
+        }
+    }
+    return xrefGroups;
+}
+const onConfirmCreator = (view, cleanup, deletedIds, tr) => () => {
+    cleanup();
+    if (!view) {
+        return;
+    }
+    const newTr = view.state.tr;
+    for (const step of tr.steps) {
+        const result = step.apply(newTr.doc);
+        if (result.failed) {
+            console.warn('Cross-ref deletion warning: could not replay step —', result.failed);
+            return;
+        }
+        newTr.step(step);
+    }
+    const xrefPositions = [];
+    newTr.doc.descendants((node, pos) => {
+        if (node.type === schema.nodes.cross_reference) {
+            const rids = node.attrs.rids;
+            if (rids.some((rid) => deletedIds.has(rid))) {
+                xrefPositions.push({ from: pos, to: pos + node.nodeSize });
+            }
+        }
+    });
+    for (let i = xrefPositions.length - 1; i >= 0; i--) {
+        const { from, to } = xrefPositions[i];
+        newTr.delete(from, to);
+    }
+    view.dispatch(newTr);
+};
+const selectAndScrollToCreator = (view) => ($pos) => {
+    if (!view) {
+        return;
+    }
+    const selTr = view.state.tr;
+    selTr.setSelection(NodeSelection.create(view.state.doc, $pos.pos));
+    view.focus();
+    view.dispatch(selTr);
+    let scrollable = view.dom.parentElement;
+    while (scrollable != null &&
+        scrollable.scrollHeight <= scrollable.clientHeight) {
+        scrollable = scrollable.parentElement;
+    }
+    if (!scrollable) {
+        return;
+    }
+    const coords = view.coordsAtPos($pos.pos);
+    const containerRect = scrollable.getBoundingClientRect();
+    const offsetInContainer = coords.top - containerRect.top + scrollable.scrollTop;
+    const containerHeight = scrollable.clientHeight;
+    const scrollTo = offsetInContainer - containerHeight * 0.75;
+    if (scrollTo < 0) {
+        modalElement?.classList.add('modal-bottom');
+        scrollable.scrollTo({ top: 0, behavior: 'smooth' });
+    }
+    else {
+        modalElement?.classList.remove('modal-bottom');
+        scrollable.scrollTo({ top: scrollTo, behavior: 'smooth' });
+    }
+};

package/dist/es/versions.js

@@ -1,2 +1,2 @@
-export const VERSION = '3.14.0';
+export const VERSION = '3.15.0';
 export const MATHJAX_VERSION = '3.2.2';

package/dist/types/components/authors-affiliations/AuthorsAndAffiliationsModals.d.ts

@@ -26,4 +26,4 @@ export interface AuthorsAndAffiliationsModalsProps {
     addNewAffiliation?: boolean;
 }
 export declare const AuthorsAndAffiliationsModals: React.FC<AuthorsAndAffiliationsModalsProps>;
-export declare const openAuthorsAndAffiliationsModals: (pos: number, view: ManuscriptEditorView | EditorView | undefined, initialModal: "authors" | "affiliations") => void;
+export declare const openAuthorsAndAffiliationsModals: (pos: number, view: ManuscriptEditorView | EditorView | undefined, initialModal: "authors" | "affiliations") => HTMLDivElement | undefined;

package/dist/types/components/cross-ref-check-modal/CrossRefWarningModal.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * © 2026 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 { ManuscriptNode } from '@manuscripts/transform';
+import React from 'react';
+import { ResolvedPos } from 'prosemirror-model';
+export type XrefGroup = {
+    referenced: ManuscriptNode;
+    label: string;
+    xrefs: [ManuscriptNode, ResolvedPos][];
+};
+export declare const CrossRefWarningModal: React.FC<{
+    onClose: () => void;
+    xrefs: XrefGroup[];
+    onConfirm: () => void;
+    selectAndScrollTo: ($pos: ResolvedPos) => void;
+}>;

package/dist/types/components/cross-ref-check-modal/openModal.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * © 2026 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 { ManuscriptEditorView } from '@manuscripts/transform';
+import { ResolvedPos } from 'prosemirror-model';
+import { XrefGroup } from './CrossRefWarningModal';
+export declare const openCrossRefWarningModal: (view: ManuscriptEditorView, xrefGroups: XrefGroup[], onConfirm: () => void, onClose: () => void, selectAndScrollTo: ($pos: ResolvedPos) => void) => HTMLDivElement;

package/dist/types/versions.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.14.0";
+export declare const VERSION = "3.15.0";
 export declare const MATHJAX_VERSION = "3.2.2";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/body-editor",
   "description": "Prosemirror components for editing and viewing manuscripts",
-  "version": "3.14.0",
+  "version": "3.15.0",
   "repository": "github:Atypon-OpenSource/manuscripts-body-editor",
   "license": "Apache-2.0",
   "main": "dist/cjs",

package/src/components/authors-affiliations/AuthorsAndAffiliationsModals.tsx

@@ -167,4 +167,6 @@ export const openAuthorsAndAffiliationsModals = (
   )
   view.focus()
   document.body.appendChild(dialog)
+  // @TODO refactor to allow cleaning it up
+  return dialog
 }

package/src/components/cross-ref-check-modal/CrossRefWarningModal.tsx

@@ -0,0 +1,223 @@
+/*!
+ * © 2026 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 { ManuscriptNode } from '@manuscripts/transform'
+import React, { useState } from 'react'
+
+import {
+  AttentionOrangeIcon,
+  CloseButton,
+  ModalContainer,
+  ModalHeader,
+  PrimaryButton,
+  StyledModal,
+  TertiaryButton,
+  TextButton,
+} from '@manuscripts/style-guide'
+import { ResolvedPos } from 'prosemirror-model'
+import { startCase } from 'lodash'
+import styled from 'styled-components'
+
+export type XrefGroup = {
+  referenced: ManuscriptNode
+  label: string
+  xrefs: [ManuscriptNode, ResolvedPos][]
+}
+
+export const CrossRefWarningModal: React.FC<{
+  onClose: () => void
+  xrefs: XrefGroup[]
+  onConfirm: () => void
+  selectAndScrollTo: ($pos: ResolvedPos) => void
+}> = ({ onClose, xrefs, onConfirm, selectAndScrollTo }) => {
+  const [isOpen, setIsOpen] = useState(true)
+  const handleClose = () => {
+    setIsOpen(false)
+    onClose()
+  }
+
+  return (
+    <Modal
+      isOpen={isOpen}
+      onRequestClose={() => handleClose()}
+      shouldCloseOnOverlayClick={false}
+      hideOverlay={true}
+    >
+      <Container data-cy="cross-reference-warning-modal">
+        <ModalHeader>
+          <CloseButton
+            onClick={() => handleClose()}
+            data-cy="modal-close-button"
+          />
+        </ModalHeader>
+        <Body>
+          <Title>
+            <AttentionOrangeIcon width={24} height={22} /> Delete referenced
+            content?
+          </Title>
+          <p>You are deleting content referenced elsewhere in the document:</p>
+          <ScrolableItems>
+            {xrefs.map((group, i) => (
+              <XrefGroupDisplay
+                key={i}
+                group={group}
+                selectAndScrollTo={selectAndScrollTo}
+              />
+            ))}
+          </ScrolableItems>
+          <Actions>
+            <TertiaryButton type="button" onClick={() => handleClose()}>
+              Cancel
+            </TertiaryButton>
+            <PrimaryButton
+              $danger={true}
+              type="button"
+              onClick={() => {
+                onConfirm()
+                setIsOpen(false)
+              }}
+            >
+              Delete & remove citation
+            </PrimaryButton>
+          </Actions>
+        </Body>
+      </Container>
+    </Modal>
+  )
+}
+
+const XrefGroupDisplay: React.FC<{
+  group: XrefGroup
+  selectAndScrollTo: ($pos: ResolvedPos) => void
+}> = ({ group, selectAndScrollTo }) => {
+  return (
+    <div>
+      <h3>{group.label}</h3>
+      <ReferencesList>
+        {group.xrefs.map(([, pos], i) => {
+          return (
+            <li key={i}>
+              <TextButton onClick={() => selectAndScrollTo(pos)}>
+                {`${startCase(pos.parent.type.name)} - ${pos.parent.textContent}`}
+              </TextButton>
+            </li>
+          )
+        })}
+      </ReferencesList>
+    </div>
+  )
+}
+
+const Container = styled(ModalContainer)`
+  position: absolute;
+  top: 1rem;
+  left: 50%;
+  right: 0;
+  max-height: calc(50vh - 2rem);
+  min-height: 280px;
+  transform: translate(-50%, 0);
+  max-width: 480px;
+  transition:
+    top 0.2s,
+    transform 0.2s;
+`
+
+// since we need to scroll inside the editor when this dialog is active, we can't use dialog.showModal()
+// so we recreate the appearance using classic position:fixed/after approach.
+// While showModal doesn't block scrolling - it doesn't allow to focus on the editor and that kills the scrollIntoView
+const Modal = styled(StyledModal)`
+  position: fixed;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+  z-index: 1100;
+  color: #6e6e6e;
+  margin: auto;
+
+  &.modal-bottom ${Container} {
+    top: calc(100% - 2rem);
+    transform: translate(-50%, -100%);
+  }
+
+  &:after {
+    content: '';
+    display: block;
+    position: fixed;
+    z-index: -1;
+    left: 0;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    background: rgba(0, 0, 0, 0.2);
+  }
+  h3 {
+    font-size: 16px;
+    margin: 0.5em 0;
+  }
+  p {
+    margin: 0.5em 0;
+  }
+`
+
+const Body = styled.div`
+  margin: 1.5rem;
+  display: flex;
+  flex-flow: column;
+`
+
+const Title = styled.h2`
+  font-size: 18px;
+  font-weight: 700;
+  line-height: 1.5;
+  margin: 0;
+  color: #353535;
+  svg {
+    vertical-align: text-top;
+  }
+`
+
+const ReferencesList = styled.ul`
+  padding: 8px;
+  margin-left: 0;
+  list-style: none;
+  background: #f2f2f2;
+  border: 1px solid #e2e2e2;
+  border-radius: 3px;
+
+  ${TextButton} {
+    margin-left: 0;
+    text-decoration: underline;
+    &:hover {
+      text-decoration: none;
+    }
+    display: block;
+    max-width: 100%;
+    overflow: hidden;
+    color: #353535;
+    text-overflow: ellipsis;
+  }
+`
+
+const Actions = styled.footer`
+  text-align: right;
+  padding-top: 1rem;
+`
+const ScrolableItems = styled.div`
+  max-height: 16vh;
+  min-height: 100px;
+  overflow-y: auto;
+`

package/src/components/cross-ref-check-modal/openModal.ts

@@ -0,0 +1,50 @@
+/*!
+ * © 2026 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 { ManuscriptEditorView } from '@manuscripts/transform'
+import { ResolvedPos } from 'prosemirror-model'
+
+import { getEditorProps } from '../../plugins/editor-props'
+import ReactSubView from '../../views/ReactSubView'
+import { CrossRefWarningModal, XrefGroup } from './CrossRefWarningModal'
+
+export const openCrossRefWarningModal = (
+  view: ManuscriptEditorView,
+  xrefGroups: XrefGroup[],
+  onConfirm: () => void,
+  onClose: () => void,
+  selectAndScrollTo: ($pos: ResolvedPos) => void
+): HTMLDivElement => {
+  const { state } = view
+  const props = getEditorProps(state)
+  const componentProps = {
+    xrefs: xrefGroups,
+    onConfirm,
+    onClose,
+    selectAndScrollTo,
+  }
+
+  const dialog = ReactSubView(
+    props,
+    CrossRefWarningModal,
+    componentProps,
+    state.doc,
+    () => 0,
+    view
+  )
+  document.body.appendChild(dialog)
+  return dialog
+}