@manuscripts/body-editor 3.12.67 → 3.13.0

package/src/selection.ts

@@ -0,0 +1,112 @@
+/*!
+ * © 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 {
+  CHANGE_OPERATION,
+  trackChangesPluginKey,
+  TrackedChange,
+} from '@manuscripts/track-changes-plugin'
+import { ManuscriptEditorState } from '@manuscripts/transform'
+import { Node, ResolvedPos } from 'prosemirror-model'
+import { NodeSelection, Selection } from 'prosemirror-state'
+import { Mappable } from 'prosemirror-transform'
+
+import { isTextSelection } from './commands'
+
+interface NodesSelectionJSON {
+  type: 'inlineNodes' | 'nodes'
+  startNode: ResolvedPos
+  endNode: ResolvedPos
+}
+
+/**
+ * Selecting multiple inline nodes without moving selection cursor
+ */
+export class InlineNodesSelection extends Selection {
+  public $startNode: ResolvedPos
+  public $endNode: ResolvedPos
+
+  constructor($from: ResolvedPos, $to: ResolvedPos) {
+    super($to, $to)
+    this.$startNode = $from
+    this.$endNode = $to
+  }
+
+  eq(selection: Selection): boolean {
+    return (
+      selection instanceof NodesSelection &&
+      selection.$startNode.pos == this.$startNode.pos &&
+      selection.$endNode.pos == this.$endNode.pos
+    )
+  }
+
+  map(doc: Node, mapping: Mappable): Selection {
+    const $from = doc.resolve(mapping.map(this.$startNode.pos))
+    const $to = doc.resolve(mapping.map(this.$endNode.pos))
+    return new NodesSelection($from, $to)
+  }
+
+  toJSON(): NodesSelectionJSON {
+    return {
+      type: 'inlineNodes',
+      startNode: this.$startNode,
+      endNode: this.$endNode,
+    }
+  }
+}
+
+export class NodesSelection extends NodeSelection {
+  public $startNode: ResolvedPos
+  public $endNode: ResolvedPos
+
+  constructor($from: ResolvedPos, $to: ResolvedPos) {
+    super($from)
+    this.$startNode = $from
+    this.$endNode = $to
+  }
+
+  toJSON(): NodesSelectionJSON {
+    return {
+      type: 'nodes',
+      startNode: this.$startNode,
+      endNode: this.$endNode,
+    }
+  }
+}
+
+export const getSelectionChangeGroup = (state: ManuscriptEditorState) => {
+  const selection = state.selection
+  const $pos = isTextSelection(selection)
+    ? selection.$cursor
+    : (selection instanceof NodesSelection ||
+        selection instanceof InlineNodesSelection) &&
+      selection.$from
+  if ($pos) {
+    return (
+      trackChangesPluginKey
+        .getState(state)
+        ?.changeSet.groupChanges.find((c) => isPositionAtRange(c, $pos.pos)) ||
+      []
+    )
+  }
+  return []
+}
+
+// check if position is at the range of group changes
+const isPositionAtRange = (changes: TrackedChange[], pos: number) =>
+  (changes.length > 1 ||
+    changes[0].dataTracked.operation === CHANGE_OPERATION.structure) &&
+  pos >= changes[0].from &&
+  pos <= changes[changes.length - 1].to

package/src/testing/default-capabilities.ts

@@ -0,0 +1,48 @@
+/*!
+ * © 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 { Capabilities } from '../lib/capabilities'
+
+export const defaultCapabilities: Capabilities = {
+  /* track changes */
+  handleSuggestion: true,
+  editWithoutTracking: true,
+  rejectOwnSuggestion: true,
+
+  /* comments */
+  handleOwnComments: true,
+  handleOthersComments: true,
+  resolveOwnComment: true,
+  resolveOthersComment: true,
+  createComment: true,
+
+  /* file handling */
+  downloadFiles: true,
+  changeDesignation: true,
+  moveFile: true,
+  replaceFile: true,
+  uploadFile: true,
+  detachFile: true,
+  setMainManuscript: true,
+
+  /* editor */
+  editArticle: true,
+  formatArticle: true,
+  editMetadata: true,
+  editCitationsAndRefs: true,
+  seeEditorToolbar: true,
+  seeReferencesButtons: true,
+}

package/src/testing/default-editor-data.ts

@@ -0,0 +1,73 @@
+/*!
+ * © 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,
+} from '@manuscripts/transform'
+import { createBrowserHistory } from 'history'
+
+import { EditorProps } from '../configs/ManuscriptsEditor'
+import { PopperManager } from '../lib/popper'
+import { defaultCapabilities } from './default-capabilities'
+import emptyEditorDocJson from './empty-editor-doc.json'
+import sectionCategories from './section-categories.json'
+
+export const defaultEditorProps: EditorProps = {
+  attributes: {
+    class: 'manuscript-editor',
+    dir: 'ltr',
+    lang: 'en-GB',
+    spellcheck: 'true',
+    tabindex: '2',
+  },
+  doc: schema.nodeFromJSON(emptyEditorDocJson) as ActualManuscriptNode,
+  locale: 'en-GB',
+  popper: new PopperManager(),
+  projectID: 'test-project-id',
+  getCurrentUser: () => ({
+    _id: 'test-user-profile-1-id',
+    userID: '',
+  }),
+  // @ts-ignore
+  history: createBrowserHistory(),
+  theme: {},
+  getFiles: () => [],
+  fileManagement: {
+    // @ts-ignore
+    upload: () => {}, // eslint-disable-line @typescript-eslint/no-empty-function
+    download: () => {}, // eslint-disable-line @typescript-eslint/no-empty-function
+  },
+  getCapabilities: () => ({
+    ...defaultCapabilities,
+    editWithoutTracking: true,
+  }),
+  cslProps: {
+    style: '',
+    locale: '',
+  },
+  setComment: () => undefined,
+  setSelectedComment: () => undefined,
+  setEditorSelectedSuggestion: () => undefined,
+  sectionCategories: new Map(
+    sectionCategories.map((category: SectionCategory) => [
+      category.id,
+      category,
+    ])
+  ),
+  fetchOEmbedHtml: async () => undefined,
+}

package/src/testing/empty-editor-doc.json

@@ -0,0 +1,62 @@
+{
+  "type": "manuscript",
+  "attrs": {
+    "id": "MPManuscript:D1797375-EF63-49AF-B140-04B2FA6B8365"
+  },
+  "content": [
+    {
+      "type": "abstracts",
+      "attrs": {
+        "id": ""
+      },
+      "content": []
+    },
+    {
+      "type": "body",
+      "attrs": {
+        "id": "MPSection:5346C94F-8C83-4585-811E-2209C269ED71"
+      },
+      "content": [
+        {
+          "type": "section",
+          "attrs": {
+            "id": "MPSection:5346C94F-8C83-4585-811E-2209C269ED71",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title"
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "MPParagraphElement:08E4B001-BB01-4666-9E33-9355AEC3CFC3",
+                "placeholder": ""
+              },
+              "content": [
+                {
+                  "type": "text",
+                  "text": "test"
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "backmatter",
+      "attrs": {
+        "id": "MPSection:05EA736A-BBE3-4904-B2F5-59E861208BA9"
+      }
+    },
+    {
+      "type": "comments",
+      "attrs": {
+        "id": ""
+      },
+      "content": []
+    }
+  ]
+}

package/src/testing/polyfill-dom.ts

@@ -0,0 +1,43 @@
+/*!
+ * © 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.
+ */
+
+/**
+ * Extra methods to polyfill parts of the DOM not covered by jest-prosemirror and jsdom.
+ *
+ * jest-prosemirror implements these polyfills by default
+ * https://github.com/remirror/remirror/blob/8a6524a8da1a48b85fdde8f1c8b62375fbd5a318/packages/jest-remirror/src/jsdom-polyfills.ts
+ */
+import { vi } from 'vitest'
+
+export function polyfillDom() {
+  window.scrollBy = vi.fn()
+
+  // This could return a null but ProseMirror expects an object causing an error otherwise.
+  // @ts-ignore
+  document.getSelection = vi.fn(() => ({
+    anchorNode: null,
+    anchorOffset: 0,
+    baseNode: null,
+    baseOffset: 0,
+    extentNode: null,
+    extentOffset: 0,
+    focusNode: null,
+    focusOffset: 0,
+    isCollapsed: true,
+    rangeCount: 0,
+    type: 'None',
+  }))
+}

package/src/testing/section-categories.json

@@ -0,0 +1,161 @@
+[
+  {
+    "id": "abstract",
+    "titles": ["Abstract"],
+    "synonyms": ["abstract"],
+    "group": "abstracts",
+    "isUnique": false
+  },
+  {
+    "id": "acknowledgements",
+    "synonyms": ["acknowledgements", "acknowledgments"],
+    "titles": ["Acknowledgements"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "appendices",
+    "titles": ["Appendices"],
+    "synonyms": ["appendices"],
+    "isUnique": false
+  },
+  {
+    "id": "availability",
+    "titles": ["Availability"],
+    "synonyms": ["availability", "data-availability", "data availability"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "coi-statement",
+    "synonyms": [
+      "coi-statement",
+      "competing-interests",
+      "conflict",
+      "conflict of interest",
+      "competing interests"
+    ],
+    "label": "Conflict of Interest",
+    "titles": ["Conflict of Interest Statement","COI Statement", "Competing Interests"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "con",
+    "synonyms": ["con"],
+    "titles": ["Contributed-by information"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "conclusions",
+    "synonyms": ["conclusions"],
+    "titles": ["Conclusions"],
+    "group": "body",
+    "isUnique": false
+  },
+  {
+    "id": "deceased",
+    "titles": ["Deceased"],
+    "synonyms": ["deceased"],
+    "isUnique": false
+  },
+  {
+    "id": "discussion",
+    "synonyms": ["discussion"],
+    "titles": ["Discussion"],
+    "group": "body",
+    "isUnique": false
+  },
+  {
+    "id": "equal",
+    "titles": ["Equal"],
+    "synonyms": ["equal"],
+    "isUnique": false
+  },
+  {
+    "id": "ethics-statement",
+    "synonyms": ["ethics-statement"],
+    "titles": ["Ethics Statement"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "financial-disclosure",
+    "synonyms": ["financial-disclosure", "funding information"],
+    "titles": ["Financial Disclosure"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "abstract-teaser",
+    "titles": ["Abstract Teaser"],
+    "synonyms": ["abstract-teaser"],
+    "isUnique": false
+  },
+  {
+    "id": "intro",
+    "synonyms": ["intro", "introduction"],
+    "titles": ["Introduction"],
+    "group": "body",
+    "isUnique": false
+  },
+  {
+    "id": "methods",
+    "synonyms": [
+      "materials",
+      "methods",
+      "materials and methods",
+      "materials & methods"
+    ],
+    "titles": ["Materials & Methods"],
+    "group": "body",
+    "isUnique": false
+  },
+  {
+    "id": "present-address",
+    "titles": ["Present Address"],
+    "synonyms": ["present-address"],
+    "isUnique": false
+  },
+  {
+    "id": "presented-at",
+    "titles": ["Presented at"],
+    "synonyms": ["presented-at"],
+    "isUnique": false
+  },
+  {
+    "id": "previously-at",
+    "titles": ["Previously at"],
+    "synonyms": ["previously-at"],
+    "isUnique": false
+  },
+  {
+    "id": "results",
+    "synonyms": ["results"],
+    "titles": ["Results"],
+    "group": "body",
+    "isUnique": false
+  },
+  {
+    "id": "review",
+    "titles": ["Review"],
+    "synonyms": [],
+    "group": "body",
+    "isUnique": false
+  },
+  {
+    "id": "supplementary-material",
+    "synonyms": ["supplementary-material"],
+    "titles": ["Supplementary Material"],
+    "group": "backmatter",
+    "isUnique": true
+  },
+  {
+    "id": "supported-by",
+    "synonyms": ["supported-by"],
+    "titles": ["Supported By"],
+    "group": "backmatter",
+    "isUnique": true
+  }
+]

package/src/testing/setup-editor.ts

@@ -0,0 +1,55 @@
+/*!
+ * © 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 { ProsemirrorTestChain, TestEditorView } from 'jest-prosemirror'
+import { EditorState } from 'prosemirror-state'
+import { EditorView } from 'prosemirror-view'
+
+import createPlugins from '../configs/editor-plugins'
+import createNodeViews from '../configs/editor-views'
+import { defaultEditorProps } from './default-editor-data'
+import { polyfillDom } from './polyfill-dom'
+
+export function parseDoc(json: { [key: string]: unknown }) {
+  return schema.nodeFromJSON(json)
+}
+
+export function setupEditor() {
+  polyfillDom()
+
+  const props = { ...defaultEditorProps }
+  const { doc } = props
+  const place = document.body.appendChild(document.createElement('div'))
+  const state = EditorState.create({
+    doc,
+    schema,
+    plugins: createPlugins(props),
+  })
+  const view = new EditorView(place, {
+    state,
+    scrollMargin: {
+      top: 100,
+      bottom: 100,
+      left: 0,
+      right: 0,
+    },
+    handleScrollToSelection: () => true,
+    nodeViews: createNodeViews(props, () => {}), // eslint-disable-line @typescript-eslint/no-empty-function
+  })
+
+  return ProsemirrorTestChain.of(view as TestEditorView)
+}

package/src/tests.ts

@@ -0,0 +1,42 @@
+/*!
+ * © 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 { TextDecoder, TextEncoder } from 'util'
+import { v4 as uuid } from 'uuid'
+import { expect, vi } from 'vitest'
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+expect.addSnapshotSerializer(require('jest-prosemirror/serializer'))
+
+process.env.API_BASE_URL = 'https://127.0.0.1/'
+
+const supportedCommands: string[] = []
+
+Object.defineProperty(document, 'queryCommandSupported', {
+  value: (cmd: string) => supportedCommands.includes(cmd),
+})
+
+Object.defineProperty(document, 'execCommand', {
+  value: (cmd: string) => supportedCommands.includes(cmd),
+})
+
+if (!window.URL.createObjectURL) {
+  Object.defineProperty(window.URL, 'createObjectURL', {
+    value: vi.fn(() => 'blob:https://localhost/' + uuid()),
+  })
+}
+
+Object.assign(global, { TextDecoder, TextEncoder })