@manuscripts/body-editor 3.12.66 → 3.13.0

package/src/plugins/detect-inconsistency/validators.ts

@@ -0,0 +1,283 @@
+/*!
+ * © 2025 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 {
+  BibliographyItemAttrs,
+  ManuscriptNode,
+  nodeNames,
+  schema,
+  Target,
+} from '@manuscripts/transform'
+import { Decoration } from 'prosemirror-view'
+
+import { EditorProps } from '../../configs/ManuscriptsEditor'
+import { allowedHref } from '../../lib/url'
+import { isChildOfNodeTypes } from '../../lib/utils'
+import { FootnotesElementState } from '../footnotes'
+import { createDecoration, Inconsistency } from './detect-inconsistency-utils'
+
+export type ValidatorContext = {
+  pluginStates: {
+    affiliations: Map<string, number> | undefined
+    bibliography: Map<string, BibliographyItemAttrs> | undefined
+    objects: Map<string, Target> | undefined
+    footnotes: Map<string, string> | undefined
+    footnotesElements: Map<string, FootnotesElementState> | undefined
+  }
+  showDecorations: boolean
+  selectedPos: number | null
+  decorations: Decoration[]
+  props: EditorProps
+  doc: ManuscriptNode
+}
+
+export type NodeValidator = (
+  node: ManuscriptNode,
+  pos: number,
+  context: ValidatorContext
+) => Inconsistency[]
+
+const getNodeDescription = (node: ManuscriptNode): string => {
+  return nodeNames.get(node.type) || node.type?.name || 'node'
+}
+
+const createWarning = (
+  node: ManuscriptNode,
+  pos: number,
+  category: Inconsistency['category'],
+  severity: Inconsistency['severity'],
+  customNodeDescription?: string
+): Inconsistency => {
+  const nodeDescription = customNodeDescription || getNodeDescription(node)
+  const message = (() => {
+    switch (node.type) {
+      case schema.nodes.figure_element:
+      case schema.nodes.image_element:
+        return 'Has no uploaded file'
+      case schema.nodes.embed:
+        return 'Has no link or uploaded file'
+      case schema.nodes.link:
+        return 'Url is empty'
+      case schema.nodes.footnote:
+        return 'Is not used'
+      case schema.nodes.affiliation:
+        return 'Is not corresponding to any Author'
+      default:
+        return category === 'empty-content'
+          ? 'Is empty'
+          : 'Has no linked reference'
+    }
+  })()
+
+  return {
+    type: 'warning',
+    category,
+    severity,
+    message,
+    nodeDescription,
+    node,
+    pos,
+  }
+}
+
+const validateTitle: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  const isEmpty = node.content.size === 0
+
+  if (isEmpty) {
+    const inconsistency = createWarning(node, pos, 'empty-content', 'error')
+    inconsistencies.push(inconsistency)
+
+    if (context.showDecorations) {
+      context.decorations.push(createDecoration(node, pos, context.selectedPos))
+    }
+  }
+
+  return inconsistencies
+}
+
+const validateCrossReference: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  const figures = Array.from(context.pluginStates.objects?.keys() ?? [])
+
+  const isInFigures = node.attrs.rids.every((rid: string) =>
+    figures.includes(rid)
+  )
+
+  if (!isInFigures) {
+    const inconsistency = createWarning(node, pos, 'missing-reference', 'error')
+    inconsistencies.push(inconsistency)
+
+    if (context.showDecorations) {
+      context.decorations.push(createDecoration(node, pos, context.selectedPos))
+    }
+  }
+
+  return inconsistencies
+}
+
+const validateCitation: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+
+  if (context.pluginStates.bibliography) {
+    const isInBibliography = node.attrs.rids.every((rid: string) =>
+      context.pluginStates.bibliography?.get(rid)
+    )
+
+    if (!isInBibliography || node.attrs.rids.length === 0) {
+      const inconsistency = createWarning(
+        node,
+        pos,
+        'missing-reference',
+        'error'
+      )
+      inconsistencies.push(inconsistency)
+
+      if (context.showDecorations) {
+        context.decorations.push(
+          createDecoration(node, pos, context.selectedPos)
+        )
+      }
+    }
+  }
+
+  return inconsistencies
+}
+
+const validateInlineFootnote: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  if (context.pluginStates.footnotes) {
+    const isInFootnote = node.attrs.rids.every((rid: string) =>
+      context.pluginStates.footnotes?.get(rid)
+    )
+
+    if (!isInFootnote) {
+      const inconsistency = createWarning(
+        node,
+        pos,
+        'missing-reference',
+        'error'
+      )
+      inconsistencies.push(inconsistency)
+
+      if (context.showDecorations) {
+        context.decorations.push(
+          createDecoration(node, pos, context.selectedPos)
+        )
+      }
+    }
+  }
+
+  return inconsistencies
+}
+
+const validateFigure: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  const files = new Set(context.props.getFiles().map((f) => f.id))
+
+  if (!files.has(node.attrs.src)) {
+    const inconsistency = createWarning(node, pos, 'missing-reference', 'error')
+    inconsistencies.push(inconsistency)
+  }
+
+  return inconsistencies
+}
+
+const validateMedia: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  const files = new Set(context.props.getFiles().map((f) => f.id))
+
+  if (!(files.has(node.attrs.href) || allowedHref(node.attrs.href))) {
+    const inconsistency = createWarning(node, pos, 'missing-reference', 'error')
+    inconsistencies.push(inconsistency)
+  }
+
+  return inconsistencies
+}
+
+const validateLink: NodeValidator = (node, pos) => {
+  const inconsistencies: Inconsistency[] = []
+
+  if (!allowedHref(node.attrs.href)) {
+    const inconsistency = createWarning(node, pos, 'missing-reference', 'error')
+    inconsistencies.push(inconsistency)
+  }
+
+  return inconsistencies
+}
+
+const validateFootnote: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  const id = context.pluginStates.footnotes?.get(node.attrs.id)
+  const footnoteState = id
+    ? context.pluginStates.footnotesElements?.get(id)
+    : undefined
+
+  const unused = footnoteState?.unusedFootnoteIDs?.has(node.attrs.id)
+
+  if (unused) {
+    const isTableFootnote = isChildOfNodeTypes(context.doc, pos, [
+      schema.nodes.table_element,
+    ])
+
+    const inconsistency = createWarning(
+      node,
+      pos,
+      'not-used',
+      'warning',
+      isTableFootnote ? 'table_footnote' : undefined
+    )
+    inconsistencies.push(inconsistency)
+  }
+
+  return inconsistencies
+}
+
+const validateAffiliation: NodeValidator = (node, pos, context) => {
+  const inconsistencies: Inconsistency[] = []
+  const unused = !context.pluginStates.affiliations?.get(node.attrs.id)
+
+  if (unused) {
+    // Use the start position of the parent 'affiliations' node instead of the individual
+    // 'affiliation' node position because the DOM for individual affiliation nodes is
+    // rendered manually inside AffiliationsView. ProseMirror decorations only apply to
+    // nodes that it directly renders in the document DOM, so to ensure the warning
+    // decoration appears (or can be scrolled to), we must attach it to the parent node.
+    const $pos = context.doc.resolve(pos)
+    const affiliationsNodePos = $pos.before($pos.depth)
+    const inconsistency = createWarning(
+      node,
+      affiliationsNodePos,
+      'not-used',
+      'warning'
+    )
+    inconsistencies.push(inconsistency)
+  }
+
+  return inconsistencies
+}
+
+export const validators: Record<string, NodeValidator> = {
+  [schema.nodes.title.name]: validateTitle,
+  [schema.nodes.cross_reference.name]: validateCrossReference,
+  [schema.nodes.citation.name]: validateCitation,
+  [schema.nodes.inline_footnote.name]: validateInlineFootnote,
+  [schema.nodes.figure.name]: validateFigure,
+  [schema.nodes.embed.name]: validateMedia,
+  [schema.nodes.link.name]: validateLink,
+  [schema.nodes.footnote.name]: validateFootnote,
+  [schema.nodes.affiliation.name]: validateAffiliation,
+}

package/src/plugins/doi.ts

@@ -0,0 +1,66 @@
+/*!
+ * © 2024 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 } from 'prosemirror-model'
+import { Plugin } from 'prosemirror-state'
+import { Decoration, DecorationSet } from 'prosemirror-view'
+
+export default () => {
+  return new Plugin({
+    state: {
+      init(_, { doc }) {
+        if (doc.attrs.doi) {
+          const decorations = createDecoration(doc)
+          return DecorationSet.create(doc, decorations)
+        }
+      },
+      apply(tr, oldDecorationSet, oldState, newState) {
+        if (tr.docChanged && newState.doc.attrs.doi) {
+          const decorations = createDecoration(newState.doc)
+          return DecorationSet.create(newState.doc, decorations)
+        }
+        return oldDecorationSet
+      },
+    },
+    props: {
+      decorations(state) {
+        return this.getState(state)
+      },
+    },
+  })
+}
+
+function getPosition(doc: Node) {
+  const positions: number[] = []
+  const possibleNodesTypes = ['keywords', 'supplements', 'abstracts', 'body']
+  doc.descendants((node, pos) => {
+    if (possibleNodesTypes.includes(node.type.name)) {
+      positions.push(pos)
+    }
+  })
+  const position = positions.length === 0 ? 0 : Math.min(...positions)
+  return position
+}
+
+function createDecoration(doc: Node) {
+  const decoration = Decoration.widget(getPosition(doc), () => {
+    const doiContainer = document.createElement('div')
+    doiContainer.classList.add('doi-container', 'block')
+    doiContainer.innerHTML = `<p>DOI: https://doi.org/${doc.attrs.doi}</p>`
+    return doiContainer
+  })
+  return [decoration]
+}

package/src/plugins/editor-props.ts

@@ -0,0 +1,39 @@
+/*!
+ * © 2024 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 { ManuscriptEditorState } from '@manuscripts/transform'
+import { Plugin, PluginKey } from 'prosemirror-state'
+
+import { EditorProps } from '../configs/ManuscriptsEditor'
+
+export const editorPropsKey = new PluginKey<EditorProps>('editor-props')
+
+export default (props: EditorProps) => {
+  return new Plugin<EditorProps>({
+    key: editorPropsKey,
+    state: {
+      init: () => {
+        return props
+      },
+      apply: () => {
+        return props
+      },
+    },
+  })
+}
+
+export const getEditorProps = (state: ManuscriptEditorState) => {
+  return editorPropsKey.getState(state) as EditorProps
+}

package/src/plugins/elements.ts

@@ -0,0 +1,60 @@
+/*!
+ * © 2019 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 { isSectionNodeType, schema } from '@manuscripts/transform'
+import { Plugin } from 'prosemirror-state'
+import { Decoration, DecorationSet } from 'prosemirror-view'
+
+/**
+ * This plugin simply sets `element: true` in a Decoration spec for each element (a non-section node that is a child of a section).
+ * `createNodeOrElementView` uses this to decide whether to create a NodeView or just a regular DOM element.
+ * This is useful for paragraphs and lists, for example, which may be nested inside top-level elements of the same node type.
+ */
+export default () => {
+  return new Plugin<null>({
+    props: {
+      decorations: (state) => {
+        const { section } = state.schema.nodes
+
+        const decorations: Decoration[] = []
+
+        // TODO: only calculate these when something changes
+
+        state.doc.descendants((node, pos, parent) => {
+          if (
+            parent &&
+            (isSectionNodeType(parent.type) ||
+              parent.type === schema.nodes.body) &&
+            node.type !== section
+          ) {
+            decorations.push(
+              Decoration.node(
+                pos,
+                pos + node.nodeSize,
+                {},
+                {
+                  element: true,
+                }
+              )
+            )
+          }
+        })
+
+        return DecorationSet.create(state.doc, decorations)
+      },
+    },
+  })
+}