@manuscripts/body-editor 3.12.67 → 3.13.0

package/src/configs/ManuscriptsEditor.ts

@@ -0,0 +1,140 @@
+/*!
+ * © 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 'prosemirror-view/style/prosemirror.css'
+
+import {
+  ManuscriptNode,
+  ManuscriptNodeType,
+  schema,
+  SectionCategory,
+  UserProfile,
+} from '@manuscripts/transform'
+import { EditorState } from 'prosemirror-state'
+import { EditorView } from 'prosemirror-view'
+import { Location, NavigateFunction } from 'react-router-dom'
+import { DefaultTheme } from 'styled-components'
+
+import { CollabProvider } from '../classes/collabProvider'
+import { clipboardParser } from '../clipboard'
+import { Dispatch } from '../commands'
+import { Language } from '../lib/languages'
+import { Capabilities } from '../lib/capabilities'
+import { transformCopied } from '../lib/copy'
+import { FileAttachment, FileManagement } from '../lib/files'
+import { handleScrollToSelectedTarget } from '../lib/helpers'
+import { handlePaste, transformPasted, transformPastedHTML } from '../lib/paste'
+import { INIT_META } from '../lib/plugins'
+import { PopperManager } from '../lib/popper'
+import plugins from './editor-plugins'
+import views from './editor-views'
+
+export type FetchOEmbedHtml = (
+  url: string,
+  maxWidth: number,
+  maxHeight: number
+) => Promise<string | undefined>
+
+export type CSLProps = {
+  style?: string
+  locale?: string
+}
+
+export interface EditorProps {
+  attributes?: { [key: string]: string }
+  locale: string
+  theme: DefaultTheme
+  getCurrentUser: () => UserProfile
+
+  projectID: string
+  doc: ManuscriptNode
+  getFiles: () => FileAttachment[]
+  fileManagement: FileManagement
+
+  popper: PopperManager
+
+  getCapabilities: () => Capabilities
+  userID: string
+  debug: boolean
+  cslProps: CSLProps
+  languages: Language[]
+  sectionCategories: Map<string, SectionCategory>
+  collabProvider?: CollabProvider
+  navigate: NavigateFunction
+  location: Location
+  isComparingMode?: boolean
+  dispatch?: Dispatch
+  onEditorClick: (event: Event) => void
+  lockBody: boolean
+  isViewingMode?: boolean
+  hiddenNodeTypes?: ManuscriptNodeType[] | undefined
+  fetchOEmbedHtml: FetchOEmbedHtml
+}
+
+export type ExternalProps = Omit<EditorProps, 'popper' | 'dispatch'>
+
+export const createEditorState = (props: EditorProps) =>
+  EditorState.create({
+    doc: props.doc,
+    schema,
+    plugins: plugins(props),
+  })
+
+export const createEditorView = (
+  props: EditorProps,
+  root: HTMLElement,
+  state: EditorState,
+  dispatch: Dispatch
+) => {
+  const view = new EditorView(root, {
+    state,
+    editable: () => props.getCapabilities().editArticle,
+    scrollMargin: {
+      top: 100,
+      bottom: 100,
+      left: 0,
+      right: 0,
+    },
+    dispatchTransaction: dispatch,
+    nodeViews: views(props, dispatch),
+    attributes: props.attributes,
+    transformPastedHTML,
+    transformPasted,
+    handlePaste,
+    clipboardParser,
+    handleScrollToSelection: handleScrollToSelectedTarget,
+    transformCopied,
+    handleClickOn: (view, pos, node, nodePos, event) => {
+      props.onEditorClick(event)
+      // This to prevent changing editor selection when clicking on table cell context menu button
+      if (
+        event?.target &&
+        (event.target as HTMLElement).classList.contains(
+          'table-context-menu-button'
+        )
+      ) {
+        return true
+      }
+    },
+  })
+
+  // running an init transaction allowing plugins to caught up with the document for the first time
+  const tr = view.state.tr.setMeta(INIT_META, true)
+
+  const nextState = view.state.apply(tr)
+  view.updateState(nextState)
+  return view
+}

package/src/configs/editor-plugins.ts

@@ -0,0 +1,119 @@
+/*!
+ * © 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 'prosemirror-gapcursor/style/gapcursor.css'
+import 'prosemirror-tables/style/tables.css'
+
+import {
+  trackChangesPlugin,
+  TrackChangesStatus,
+} from '@manuscripts/track-changes-plugin'
+import { collab } from 'prosemirror-collab'
+import { dropCursor } from 'prosemirror-dropcursor'
+import { history } from 'prosemirror-history'
+import { tableEditing } from 'prosemirror-tables'
+
+import keys from '../keys'
+import accessibility_element from '../plugins/accessibility_element'
+import add_subtitle from '../plugins/add-subtitle'
+import affiliations from '../plugins/affiliations'
+import alt_titles from '../plugins/alt-titles'
+import bibliography from '../plugins/bibliography'
+import comments from '../plugins/comments'
+import cross_references from '../plugins/cross-references'
+import detect_inconsistency from '../plugins/detect-inconsistency'
+import doi from '../plugins/doi'
+import editorProps from '../plugins/editor-props'
+import elements from '../plugins/elements'
+import footnotes from '../plugins/footnotes'
+import link from '../plugins/link'
+import lock_body from '../plugins/lock-body'
+import move_node from '../plugins/move-node'
+import objects from '../plugins/objects'
+import paragraphs from '../plugins/paragraphs'
+import persist from '../plugins/persist'
+import persistent_cursor from '../plugins/persistent-cursor'
+import placeholder from '../plugins/placeholder'
+import prevent_empty from '../plugins/prevent-empty'
+import search_replace from '../plugins/search-replace'
+import section_title from '../plugins/section_title'
+import section_category from '../plugins/section_category'
+import selected_suggestion from '../plugins/selected-suggestion'
+import table_editing_fix from '../plugins/tables-cursor-fix'
+import translations from '../plugins/translations'
+import rules from '../rules'
+import { EditorProps } from './ManuscriptsEditor'
+
+export default (props: EditorProps) => {
+  const allPlugins = [
+    rules,
+    ...keys,
+    dropCursor(),
+    history(),
+    trackChangesPlugin({
+      userID: props.userID,
+      debug: props.debug,
+      initialStatus:
+        props.isViewingMode || props.isComparingMode
+          ? TrackChangesStatus.viewSnapshots
+          : props.getCapabilities().editWithoutTracking
+            ? TrackChangesStatus.disabled
+            : TrackChangesStatus.enabled,
+    }),
+    section_title(),
+    table_editing_fix(),
+    elements(),
+    persist(),
+    bibliography(props),
+    objects(),
+    affiliations(),
+    comments(),
+    paragraphs(),
+    placeholder(),
+    add_subtitle(props),
+    translations(props),
+    tableEditing(),
+    selected_suggestion(),
+    footnotes(props),
+    editorProps(props),
+    doi(),
+    section_category(props),
+    cross_references(),
+    detect_inconsistency(props),
+    search_replace(),
+    lock_body(),
+    alt_titles(),
+    accessibility_element(),
+    prevent_empty(),
+    move_node(),
+    link(),
+  ]
+
+  // @ts-ignore
+  if (!window.Cypress) {
+    allPlugins.push(persistent_cursor())
+    // this is a temporal workaround until cypress tests are switched to working with prosemirrors selection instead of browsers direct selection
+    // this plugin is incompatible with current implementation of our tests in cypress,
+    // which relies on browser native Selection.AddRange and Range APIs
+  } else {
+    console.warn('Skipping cursor imitation plugin for automated testing runs.')
+  }
+  if (props.collabProvider) {
+    allPlugins.push(collab({ version: props.collabProvider.currentVersion }))
+  }
+
+  return allPlugins
+}

package/src/configs/editor-views.ts

@@ -0,0 +1,139 @@
+/*!
+ * © 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 { ManuscriptNodeView, Nodes } from '@manuscripts/transform'
+
+import { Dispatch } from '../commands'
+import { NodeViewCreator } from '../types'
+import abstracts from '../views/abstracts'
+import accessibilityElement from '../views/accessibility_element'
+import affiliations from '../views/affiliations'
+import alt_title from '../views/alt_title'
+import alt_titles_section from '../views/alt_titles_section'
+import attachment from '../views/attachment'
+import attachments from '../views/attachments'
+import authorNotes from '../views/author_notes'
+import award from '../views/award'
+import awards from '../views/awards'
+import bibliographyElement from '../views/bibliography_element'
+import blockquoteElement from '../views/blockquote_element_editable'
+import boxElement from '../views/box_element'
+import caption from '../views/caption'
+import captionTitle from '../views/caption_title'
+import citation from '../views/citation_editable'
+import contributors from '../views/contributors'
+import crossReference from '../views/cross_reference_editable'
+import embed from '../views/embed'
+import empty from '../views/empty'
+import equation from '../views/equation_editable'
+import equationElement from '../views/equation_element_editable'
+import figure from '../views/figure_editable'
+import figureElement from '../views/figure_element_editable'
+import footnote from '../views/footnote'
+import footnotesElement from '../views/footnotes_element'
+import generalTableFootnote from '../views/general_table_footnote'
+import heroImage from '../views/hero_image_editable'
+import imageElement from '../views/image_element_editable'
+import inlineEquation from '../views/inline_equation_editable'
+import inlineFootnote from '../views/inline_footnote_editable'
+import keyword from '../views/keyword'
+import keywordGroup from '../views/keyword_group'
+import link from '../views/link_editable'
+import list from '../views/list'
+import list_item from '../views/list_item'
+import paragraph from '../views/paragraph_editable'
+import placeholder from '../views/placeholder'
+import placeholderElement from '../views/placeholder_element_editable'
+import pullquoteElement from '../views/pullquote_element_editable'
+import quoteImage from '../views/quote_image_editable'
+import section from '../views/section'
+import sectionLabel from '../views/section_label'
+import sectionTitle from '../views/section_title_editable'
+import subtitle from '../views/subtitle_editable'
+import subtitles from '../views/subtitles_editable'
+import supplement from '../views/supplement_editable'
+import supplements from '../views/supplements_editable'
+import tableCell from '../views/table_cell'
+import tableElement from '../views/table_element_editable'
+import tableElementFooter from '../views/table_element_footer'
+import title from '../views/title_editable'
+import transAbstract from '../views/translated_abstract_editable'
+import transGraphicalAbstract from '../views/trans_graphical_abstract_editable'
+import { EditorProps } from './ManuscriptsEditor'
+
+export default (
+  props: EditorProps,
+  dispatch: Dispatch
+): Partial<Record<Nodes, NodeViewCreator<ManuscriptNodeView>>> => {
+  return {
+    title: title(props, dispatch),
+    subtitles: subtitles(props, dispatch),
+    subtitle: subtitle(props, dispatch),
+    alt_title: alt_title(props),
+    alt_titles: alt_titles_section(props),
+    bibliography_element: bibliographyElement(props, dispatch),
+    blockquote_element: blockquoteElement(props),
+    quote_image: quoteImage(props, dispatch),
+    box_element: boxElement(props),
+    caption_title: captionTitle(props),
+    caption: caption(props),
+    citation: citation(props, dispatch),
+    cross_reference: crossReference(props, dispatch),
+    contributors: contributors(props, dispatch),
+    affiliations: affiliations(props, dispatch),
+    embed: embed(props, dispatch),
+    equation: equation(props),
+    equation_element: equationElement(props),
+    figure: figure(props, dispatch),
+    figure_element: figureElement(props, dispatch),
+    image_element: imageElement(props, dispatch),
+    footnote: footnote(props),
+    footnotes_element: footnotesElement(props),
+    general_table_footnote: generalTableFootnote(props, dispatch),
+    inline_equation: inlineEquation(props),
+    inline_footnote: inlineFootnote(props, dispatch),
+    keyword: keyword(props, dispatch),
+    keyword_group: keywordGroup(props, dispatch),
+    link: link(props, dispatch),
+    list: list(props),
+    list_item: list_item(props),
+    paragraph: paragraph(props),
+    placeholder: placeholder(props),
+    placeholder_element: placeholderElement(props),
+    section: section(props),
+    graphical_abstract_section: section(props),
+    pullquote_element: pullquoteElement(props),
+    section_title: sectionTitle(props),
+    section_label: sectionLabel(props),
+    table_element: tableElement(props),
+    table_cell: tableCell(props),
+    table_header: tableCell(props),
+    table_element_footer: tableElementFooter(props),
+    comments: empty('comments'),
+    supplements: supplements(props, dispatch),
+    supplement: supplement(props, dispatch),
+    author_notes: authorNotes(props, dispatch),
+    awards: awards(props, dispatch),
+    award: award(props, dispatch),
+    long_desc: accessibilityElement(props, dispatch),
+    alt_text: accessibilityElement(props, dispatch),
+    hero_image: heroImage(props, dispatch),
+    abstracts: abstracts(props),
+    trans_abstract: transAbstract(props),
+    trans_graphical_abstract: transGraphicalAbstract(props),
+    attachment: attachment(props, dispatch),
+    attachments: attachments(props, dispatch),
+  }
+}

package/src/icons.ts

@@ -0,0 +1,62 @@
+/*!
+ * © 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 {
+  AddAuthorIcon,
+  AlertIcon,
+  ArrowDownCircleIcon,
+  ArrowUpIcon,
+  DeleteIcon,
+  DraggableIcon,
+  EditIcon,
+  FileCorruptedIcon,
+  FileMainDocumentIcon,
+  ImageDefaultIcon,
+  ImageLeftIcon,
+  ImageRightIcon,
+  LinkIcon,
+  LockIcon,
+  ORCIDIcon as ORCID,
+  PlusIcon,
+  ScrollIcon,
+  SectionCategoryIcon,
+  TickIcon,
+  TranslateIcon,
+} from '@manuscripts/style-guide'
+import React, { createElement } from 'react'
+import { renderToStaticMarkup } from 'react-dom/server'
+
+const renderIcon = (c: React.FC) => renderToStaticMarkup(createElement(c))
+
+export const addAuthorIcon = renderIcon(AddAuthorIcon)
+export const arrowDown = renderIcon(ArrowDownCircleIcon)
+export const arrowUp = renderIcon(ArrowUpIcon)
+export const alertIcon = renderIcon(AlertIcon)
+export const deleteIcon = renderIcon(DeleteIcon)
+export const editIcon = renderIcon(EditIcon)
+export const sectionCategoryIcon = renderIcon(SectionCategoryIcon)
+export const scrollIcon = renderIcon(ScrollIcon)
+export const lockIcon = renderIcon(LockIcon)
+export const plusIcon = renderIcon(PlusIcon)
+export const imageRightIcon = renderIcon(ImageRightIcon)
+export const imageLeftIcon = renderIcon(ImageLeftIcon)
+export const imageDefaultIcon = renderIcon(ImageDefaultIcon)
+export const fileCorruptedIcon = renderIcon(FileCorruptedIcon)
+export const draggableIcon = renderIcon(DraggableIcon)
+export const translateIcon = renderIcon(TranslateIcon)
+export const linkIcon = renderIcon(LinkIcon)
+export const fileMainDocumentIcon = renderIcon(FileMainDocumentIcon)
+export const tickIcon = renderIcon(TickIcon)
+export const ORCIDIcon = renderIcon(ORCID)

package/src/index.ts

@@ -0,0 +1,65 @@
+/*!
+ * © 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.
+ */
+
+export * from './commands'
+export { ManuscriptOutline } from './components/outline/ManuscriptOutline'
+export { OutlineItemIcon } from './components/outline/Outline'
+export { TypeSelector } from './components/toolbar/type-selector/TypeSelector'
+export { default as LanguageDropdown } from './components/LanguageDropdown'
+export {
+  KeyboardShortcutsModal,
+  openKeyboardShortcuts,
+} from './components/keyboard-shortcuts-modal/KeyboardShortcutsModal'
+export * from './components/toolbar/ListMenuItem'
+export * from './components/toolbar/InsertTableDialog'
+export * from './menus'
+export { CollabProvider } from './classes/collabProvider'
+export { PopperManager } from './lib/popper'
+export * from './toolbar'
+export * from './lib/capabilities'
+export * from './lib/navigation-utils'
+export * from './lib/comments'
+export * from './lib/files'
+export * from './lib/footnotes'
+export * from './lib/template'
+export * from './lib/doc'
+export * from './lib/media'
+export type { FetchOEmbedHtml } from './configs/ManuscriptsEditor'
+export * from './plugins/comments'
+export { selectedSuggestionKey } from './plugins/selected-suggestion'
+export * from './selection'
+export * from './lib/utils'
+export * from './lib/track-changes-utils'
+export * from './useEditor'
+export * from './lib/math'
+export * from './lib/get-media-type'
+export { objectsKey as objectsPluginKey } from './plugins/objects'
+export { footnotesKey as footnotesPluginKey } from './plugins/footnotes'
+export { bibliographyKey as bibliographyPluginKey } from './plugins/bibliography'
+export {
+  searchReplaceKey as searchReplacePluginKey,
+  SearchReplacePluginState,
+} from './plugins/search-replace'
+export { detectInconsistencyKey as detectInconsistencyPluginKey } from './plugins/detect-inconsistency'
+export { getNewMatch, getClosestMatch } from './plugins/search-replace/lib'
+export { metadata, bibliographyItemTypes } from './lib/references'
+export {
+  authorLabel,
+  affiliationLabel,
+  AffiliationAttrs,
+  ContributorAttrs,
+} from './lib/authors'
+export type { Inconsistency } from './plugins/detect-inconsistency'

package/src/keys/highlight.ts

@@ -0,0 +1,65 @@
+/*!
+ * © 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 {
+  isHighlightMarkerNode,
+  ManuscriptEditorState,
+} from '@manuscripts/transform'
+import { Selection } from 'prosemirror-state'
+
+import { Dispatch, isTextSelection } from '../commands'
+import { EditorAction } from '../types'
+
+const skipHighlightNode =
+  (dir: number): EditorAction =>
+  (state: ManuscriptEditorState, dispatch?: Dispatch) => {
+    const { selection, tr } = state
+
+    if (isTextSelection(selection)) {
+      const { $anchor, $cursor } = selection
+
+      if ($cursor) {
+        const adjacentNode = dir === -1 ? $cursor.nodeBefore : $cursor.nodeAfter
+
+        if (adjacentNode && isHighlightMarkerNode(adjacentNode)) {
+          const $adjacentPos = tr.doc.resolve($anchor.pos + dir)
+
+          const adjacentSelection = Selection.findFrom($adjacentPos, dir, true)
+
+          if (adjacentSelection) {
+            // TODO: handle multiple adjacent markers
+
+            tr.setSelection(adjacentSelection)
+
+            if (dispatch) {
+              dispatch(tr)
+            }
+          }
+        }
+      }
+    }
+
+    return false
+  }
+
+const highlightKeymap: { [key: string]: EditorAction } = {
+  Backspace: skipHighlightNode(-1),
+  Delete: skipHighlightNode(1),
+  ArrowLeft: skipHighlightNode(-1),
+  ArrowRight: skipHighlightNode(1),
+}
+
+export default highlightKeymap

package/src/keys/index.ts

@@ -0,0 +1,33 @@
+/*!
+ * © 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 { baseKeymap } from 'prosemirror-commands'
+import { keymap } from 'prosemirror-keymap'
+
+import highlightKeymap from './highlight'
+import keywordKeymap from './keyword'
+import listKeymap from './list'
+import miscKeymap from './misc'
+import titleKeymap from './title'
+
+export default [
+  keymap(keywordKeymap),
+  keymap(listKeymap),
+  keymap(titleKeymap),
+  keymap(miscKeymap),
+  keymap(baseKeymap),
+  keymap(highlightKeymap),
+]