@manuscripts/body-editor 3.12.66 → 3.13.0

package/src/lib/__tests__/paste.test.ts

@@ -0,0 +1,57 @@
+/*!
+ * © 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 { schema } from '@manuscripts/transform'
+import { Slice } from 'prosemirror-model'
+
+import { transformPasted } from '../paste'
+
+test('transformPasted handler', () => {
+  const slice = Slice.fromJSON(schema, {
+    content: [
+      {
+        type: 'paragraph',
+        attrs: {},
+        content: [{ type: 'hard_break' }],
+      },
+      {
+        type: 'paragraph',
+        attrs: {
+          id: 'p-1',
+        },
+        content: [
+          {
+            type: 'text',
+            text: 'These rhythmic patterns then sum together to create the signals that muscles need to carry out the movements.',
+          },
+        ],
+      },
+    ],
+    openStart: 1,
+    openEnd: 1,
+  })
+
+  expect(slice.content.childCount).toBe(2)
+  expect(slice.content.child(1).attrs.id).toBe('p-1')
+
+  const result = transformPasted(slice)
+
+  expect(result.content.childCount).toBe(1)
+  expect(result.content.size).toBe(111)
+  expect(slice.content.child(0).attrs.id).toBeNull()
+
+  expect(result).toMatchSnapshot('transform-pasted')
+})

package/src/lib/__tests__/plugins.test.ts

@@ -0,0 +1,176 @@
+/*!
+ * © 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 {
+  ActualManuscriptNode,
+  schema,
+  SectionCategory,
+  UserProfile,
+} from '@manuscripts/transform'
+import { createMemoryHistory } from 'history'
+import { EditorState } from 'prosemirror-state'
+import { EditorView } from 'prosemirror-view'
+
+import plugins from '../../configs/editor-plugins'
+import { EditorProps } from '../../configs/ManuscriptsEditor'
+import { defaultCapabilities } from '../../testing/default-capabilities'
+import sectionCategories from '../../testing/section-categories.json'
+import { PopperManager } from '../popper'
+import { getMatchingDescendant } from '../utils'
+import jsonDoc from './__fixtures__/doc.json'
+const userProfile: UserProfile = {
+  _id: 'MPUserProfile:1',
+  userID: 'MPUser:1',
+}
+
+const history = createMemoryHistory()
+
+const buildProps = (doc: ActualManuscriptNode): EditorProps => ({
+  doc,
+  locale: 'en-US',
+  popper: new PopperManager(),
+  projectID: '',
+  getCurrentUser: () => userProfile,
+  history,
+  setComment: () => undefined,
+  setSelectedComment: () => undefined,
+  setEditorSelectedSuggestion: () => undefined,
+  theme: {},
+  getFiles: () => [],
+  fileManagement: {
+    download: () => undefined, // eslint-disable-line @typescript-eslint/no-empty-function
+    //@ts-ignore
+    upload: () => undefined, // eslint-disable-line @typescript-eslint/no-empty-function
+  },
+  getCapabilities: () => defaultCapabilities,
+  cslProps: {
+    style: '',
+    locale: '',
+  },
+  sectionCategories: new Map(
+    sectionCategories.map((category: SectionCategory) => [
+      category.id,
+      category,
+    ])
+  ),
+  fetchOEmbedHtml: async () => undefined,
+})
+
+describe('editor view', () => {
+  const doc = schema.nodeFromJSON(jsonDoc) as ActualManuscriptNode
+  beforeAll(() => {
+    const root = document.createElement('div')
+    root.id = 'root'
+    window.document.body.appendChild(root)
+  })
+
+  test('loads without plugins', () => {
+    const state = EditorState.create({
+      doc,
+      schema,
+    })
+
+    const view = new EditorView(null, { state })
+
+    view.dispatch(view.state.tr.setMeta('update', true)) // trigger plugins
+
+    const emptySection = view.state.doc.child(2).child(0)
+    expect(emptySection.attrs.id).toBe('empty-section-1')
+    expect(emptySection.childCount).toBe(1)
+
+    const sectionWithEmptyParagraphs = view.state.doc.child(2).child(3)
+    expect(sectionWithEmptyParagraphs.attrs.id).toBe(
+      'section-with-empty-paragraphs-1'
+    )
+    expect(sectionWithEmptyParagraphs.childCount).toBe(3)
+
+    const sectionWithList = view.state.doc.child(2).child(6)
+    expect(sectionWithList.attrs.id).toBe('section-with-list')
+    expect(sectionWithList.childCount).toBe(2)
+  })
+
+  test('loads with plugins', () => {
+    const state = EditorState.create({
+      doc,
+      schema,
+      plugins: plugins(buildProps(doc)),
+    })
+
+    const view = new EditorView(null, { state })
+
+    view.dispatch(view.state.tr.setMeta('INIT', true)) // trigger plugins
+
+    const sectionWithEmptyParagraphs = view.state.doc.child(2).child(3)
+    expect(sectionWithEmptyParagraphs.attrs.id).toBe(
+      'section-with-empty-paragraphs-1'
+    )
+    expect(sectionWithEmptyParagraphs.childCount).toBe(2)
+    expect(sectionWithEmptyParagraphs.content.child(0).type).toBe(
+      schema.nodes.section_title
+    )
+    expect(sectionWithEmptyParagraphs.content.child(1).type).toBe(
+      schema.nodes.paragraph
+    )
+    expect(sectionWithEmptyParagraphs.content.child(1).textContent).toBe('')
+
+    const sectionWithList = view.state.doc.child(2).child(6)
+    expect(sectionWithList.attrs.id).toBe('section-with-list')
+    expect(sectionWithList.childCount).toBe(2)
+    expect(sectionWithList.content.child(0).type).toBe(
+      sectionWithList.type.schema.nodes.section_title
+    )
+
+    const orderedList = sectionWithList.content.child(1)
+    expect(orderedList.type).toBe(sectionWithList.type.schema.nodes.list)
+    expect(orderedList.textContent).toBe('Test ')
+
+    const inlineEquation = getMatchingDescendant(
+      orderedList,
+      (node) => node.type === node.type.schema.nodes.inline_equation
+    )
+
+    expect(inlineEquation).not.toBeUndefined()
+
+    const sectionWithFigure = view.state.doc.child(2).child(7)
+    expect(sectionWithFigure.attrs.id).toBe('section-with-figure')
+    expect(sectionWithFigure.childCount).toBe(2)
+    expect(sectionWithFigure.content.child(0).type).toBe(
+      schema.nodes.section_title
+    )
+
+    const figureElement = sectionWithFigure.content.child(1)
+    expect(figureElement.childCount).toBe(5)
+    expect(figureElement.type).toBe(schema.nodes.figure_element)
+    expect(figureElement.content.child(0).type).toBe(schema.nodes.figure)
+    expect(figureElement.content.child(1).type).toBe(schema.nodes.caption)
+
+    const sectionWithTable = view.state.doc.child(2).child(8)
+    expect(sectionWithTable.attrs.id).toBe('section-with-table')
+    expect(sectionWithTable.childCount).toBe(2)
+    expect(sectionWithTable.content.child(0).type).toBe(
+      sectionWithTable.type.schema.nodes.section_title
+    )
+
+    const tableElement = sectionWithTable.content.child(1)
+    expect(tableElement.childCount).toBe(5)
+    expect(tableElement.type).toBe(tableElement.type.schema.nodes.table_element)
+    expect(tableElement.content.child(0).type).toBe(
+      tableElement.type.schema.nodes.caption_title
+    )
+    expect(tableElement.content.child(1).type).toBe(
+      tableElement.type.schema.nodes.table
+    )
+  })
+})

package/src/lib/__tests__/url.test.ts

@@ -0,0 +1,31 @@
+/*!
+ * © 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 { allowedHref } from '../url'
+
+describe('url', () => {
+  test('allows valid protocols', () => {
+    expect(allowedHref('http://example.com')).toBe(true)
+    expect(allowedHref('https://example.com')).toBe(true)
+    expect(allowedHref('ftp://example.com')).toBe(true)
+    expect(allowedHref(' http://example.com')).toBe(true) // leading space
+  })
+
+  test('rejects invalid protocols', () => {
+    expect(allowedHref('javascript:alert("hi")')).toBe(false)
+    expect(allowedHref('httpp://example.com')).toBe(false)
+  })
+})

package/src/lib/array-reducer.ts

@@ -0,0 +1,68 @@
+/*!
+ * © 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 { Attrs } from 'prosemirror-model'
+
+export type Update<T> = {
+  type: 'update'
+  items: T[]
+}
+
+export type Delete<T> = {
+  type: 'delete'
+  item: T
+}
+
+export type Set<T> = {
+  type: 'set'
+  state: T[]
+}
+
+export type Action<T> = Update<T> | Delete<T> | Set<T>
+
+export const arrayReducer = <T>(
+  isEqual: (a: T, b: T) => boolean = (a, b) => a === b
+) => {
+  return (state: T[], action: Action<T>): T[] => {
+    const handleUpdate = (state: T[], items: T[]): T[] => {
+      const copy = [...state]
+      items.forEach((item) => {
+        const index = copy.findIndex((i) => isEqual(item, i))
+        if (index >= 0) {
+          copy[index] = item
+        } else {
+          copy.push(item)
+        }
+      })
+      return copy
+    }
+    const handleDelete = (state: T[], item: T): T[] => {
+      return state.filter((i) => !isEqual(item, i))
+    }
+
+    switch (action.type) {
+      case 'update':
+        return handleUpdate(state, action.items)
+      case 'delete':
+        return handleDelete(state, action.item)
+      case 'set':
+        return action.state
+    }
+  }
+}
+
+export const attrsReducer = <T extends Attrs>() =>
+  arrayReducer<T>((a, b) => a.id === b.id)

package/src/lib/authors-and-affiliations.ts

@@ -0,0 +1,81 @@
+/*!
+ * © 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 {
+  generateNodeID,
+  ManuscriptEditorView,
+  ManuscriptNodeType,
+  schema,
+} from '@manuscripts/transform'
+import { Attrs } from 'prosemirror-model'
+
+import { AffiliationAttrs, ContributorAttrs } from './authors'
+import { findInsertionPosition } from './utils'
+import { findChildByType, updateNodeAttrs } from './view'
+
+function insertNode(
+  parentType: ManuscriptNodeType,
+  childType: ManuscriptNodeType
+) {
+  return (view: ManuscriptEditorView, attrs: Attrs) => {
+    const parent = findChildByType(view, parentType)
+    let tr = view.state.tr
+
+    if (parent) {
+      tr = tr.insert(parent.pos + 1, childType.create(attrs))
+    } else {
+      const insertPos = findInsertionPosition(parentType, view.state.doc)
+      const wrapper = parentType.create({
+        id: generateNodeID(parentType),
+      })
+      tr = tr
+        .insert(insertPos, wrapper)
+        .insert(insertPos + 1, childType.create(attrs))
+    }
+
+    view.dispatch(tr)
+  }
+}
+
+function upsertNode<T extends Attrs>(
+  nodeType: ManuscriptNodeType,
+  insertFn: (view: ManuscriptEditorView, attrs: T) => void
+) {
+  return (view: ManuscriptEditorView, attrs: T) => {
+    if (!updateNodeAttrs(view, nodeType, attrs)) {
+      insertFn(view, attrs)
+    }
+  }
+}
+
+const insertAuthorNode = insertNode(
+  schema.nodes.contributors,
+  schema.nodes.contributor
+)
+const insertAffiliationNode = insertNode(
+  schema.nodes.affiliations,
+  schema.nodes.affiliation
+)
+
+export const upsertAuthor = upsertNode<ContributorAttrs>(
+  schema.nodes.contributor,
+  insertAuthorNode
+)
+
+export const upsertAffiliation = upsertNode<AffiliationAttrs>(
+  schema.nodes.affiliation,
+  insertAffiliationNode
+)

package/src/lib/authors.ts

@@ -0,0 +1,67 @@
+/*!
+ * © 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 { AffiliationNode, ContributorNode } from '@manuscripts/transform'
+
+import { TrackableAttributes } from '../types'
+
+export type AffiliationAttrs = TrackableAttributes<AffiliationNode>
+export type ContributorAttrs = TrackableAttributes<ContributorNode>
+
+export const affiliationLabel = (affiliation: AffiliationAttrs) => {
+  const institution = affiliation.institution
+  if (!institution) {
+    return '(unknown institution)'
+  }
+  const department = affiliation.department
+  return department ? `${institution} (${department})`.trim() : institution
+}
+
+export const affiliationName = (affiliation: AffiliationAttrs) => {
+  return [
+    affiliation.department,
+    affiliation.institution,
+    affiliation.addressLine1,
+    affiliation.city,
+    affiliation.county,
+    affiliation.country,
+    affiliation.postCode,
+  ]
+    .filter(Boolean)
+    .join(', ')
+}
+
+export const authorLabel = (author: ContributorAttrs) => {
+  const parts = [
+    author.prefix,
+    author.family ? initials(author) : author.given,
+    author.family,
+    author.suffix,
+  ].filter(Boolean)
+  return parts.length ? parts.join(' ') : 'Unknown Author'
+}
+
+export const initials = (contributor: ContributorAttrs): string =>
+  contributor.given
+    ? contributor.given
+        .trim()
+        .split(' ')
+        .map((part) => part.substring(0, 1).toUpperCase() + '.')
+        .join('')
+    : ''
+
+export const authorComparator = (a: ContributorAttrs, b: ContributorAttrs) =>
+  a.priority - b.priority

package/src/lib/capabilities.ts

@@ -0,0 +1,55 @@
+/*!
+ * © 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.
+ */
+
+export type Capabilities = {
+  /* track changes */
+  handleSuggestion: boolean
+  editWithoutTracking: boolean
+  rejectOwnSuggestion: boolean
+
+  /* comments */
+  handleOwnComments: boolean
+  resolveOwnComment: boolean
+  handleOthersComments: boolean
+  resolveOthersComment: boolean
+  createComment: boolean
+
+  /* file handling */
+  downloadFiles: boolean
+  changeDesignation: boolean
+  moveFile: boolean
+  replaceFile: boolean
+  uploadFile: boolean
+  detachFile: boolean
+  setMainManuscript: boolean
+
+  /* editor */
+  formatArticle: boolean
+  editArticle: boolean
+  editMetadata: boolean
+  editCitationsAndRefs: boolean
+  seeEditorToolbar: boolean
+  seeReferencesButtons: boolean
+}
+
+export enum Actions {
+  // proceed = 'proceed',
+  updateAttachment = 'update-attachment',
+  updateDueDate = 'update-due-date',
+  addNote = 'add-note',
+  setMainManuscript = 'set-main-manuscript',
+  editWithoutTracking = 'edit-without-tracking',
+}

package/src/lib/codemirror.ts

@@ -0,0 +1,37 @@
+/*!
+ * © 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 'codemirror/addon/display/placeholder'
+import 'codemirror/lib/codemirror.css'
+
+import CodeMirror from 'codemirror'
+
+type CreateEditor = (
+  options: CodeMirror.EditorConfiguration
+) => Promise<CodeMirror.Editor>
+
+export const createEditor: CreateEditor = async (options) => {
+  return CodeMirror(
+    () => {
+      // no-op
+    },
+    {
+      ...options,
+      lineNumbers: true,
+      lineWrapping: true,
+    }
+  )
+}

package/src/lib/comments.ts

@@ -0,0 +1,123 @@
+/*!
+ * © 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 {
+  CommentNode,
+  HighlightMarkerNode,
+  ManuscriptNode,
+} from '@manuscripts/transform'
+import { NodeWithPos } from 'prosemirror-utils'
+import { EditorView } from 'prosemirror-view'
+
+import { addNodeComment } from '../commands'
+
+export type CommentAttrs = CommentNode['attrs']
+export type HighlightMarkerAttrs = HighlightMarkerNode['attrs']
+
+export type Comment = NodeComment | InlineComment
+
+export type NodeComment = {
+  key: CommentKey
+  node: CommentNode
+  pos: number
+  target: NodeWithPos
+}
+
+export type InlineComment = {
+  key: CommentKey
+  node: CommentNode
+  pos: number
+  target: NodeWithPos
+  range: CommentRange
+}
+
+export type CommentRange = {
+  pos: number
+  size: number
+}
+
+export type CommentKey = string
+
+export type CommentSelection = {
+  key: CommentKey
+  id: string
+  isNew: boolean
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const isNodeComment = (c: any): c is NodeComment => !c.range
+
+export const isReply = (comment: Comment) =>
+  comment.node.attrs.target?.startsWith('MPComment')
+
+export const getCommentKey = (
+  comment: CommentAttrs,
+  range: CommentRange | undefined,
+  target: ManuscriptNode
+): CommentKey => {
+  if (!range) {
+    return target.attrs.id
+  } else if (!range.size) {
+    return `${target.attrs.id}-${range.pos}`
+  } else {
+    return comment.id
+  }
+}
+
+export const getCommentRange = (comment: CommentAttrs) => {
+  if (!comment.selector) {
+    return
+  }
+  return {
+    pos: comment.selector.from,
+    size: comment.selector.to - comment.selector.from,
+  }
+}
+
+export const createCommentMarker = (
+  tagName: string,
+  key: CommentKey,
+  count?: number
+) => {
+  const element = document.createElement(tagName)
+  element.id = getMarkerID(key)
+  element.dataset.key = key
+  element.classList.add('comment-marker')
+  element.tabIndex = 0
+
+  if (count && count > 1) {
+    element.dataset.count = String(count)
+  }
+
+  element.innerHTML = `
+<svg width="16" height="13" viewBox="0 0 16 13" fill="none" xmlns="http://www.w3.org/2000/svg">
+    <path d="M4.0625 2.9375V7.3125L1.4375 11.6875H12.8125C13.7794 11.6875 14.5625 10.9044 14.5625 9.9375V2.9375C14.5625 1.97062 13.7794 1.1875 12.8125 1.1875H5.8125C4.84562 1.1875 4.0625 1.97062 4.0625 2.9375Z"
+          fill="#FFFCDB" stroke="#FFBD26" stroke-width="1.5" stroke-miterlimit="10" stroke-linecap="round" stroke-linejoin="round"/>
+    <path d="M6.6875 4.6875H11.9375" stroke="#FFBD26" stroke-width="1.5" stroke-miterlimit="10" stroke-linecap="round" stroke-linejoin="round"/>
+    <path d="M6.6875 8.1875H9.3125" stroke="#FFBD26" stroke-width="1.5" stroke-miterlimit="10" stroke-linecap="round" stroke-linejoin="round"/>
+</svg>
+    `
+  return element
+}
+
+const getMarkerID = (id: string) => {
+  return `${id}-comment-marker`
+}
+
+export const handleComment = (node: ManuscriptNode, view: EditorView): void => {
+  const { state } = view
+
+  addNodeComment(node, state, view.dispatch)
+}