@manuscripts/body-editor 3.12.67 → 3.13.0

package/src/lib/__tests__/__fixtures__/doc.json

@@ -0,0 +1,388 @@
+{
+  "type": "manuscript",
+  "attrs": {
+    "id": "manuscript",
+    "doi": "",
+    "prototype": "",
+    "primaryLanguageCode": "",
+    "articleType": "research-article"
+  },
+  "content": [
+    {
+      "type": "title",
+      "attrs": {
+        "id": "titles",
+        "placeholder": "Insert title here..."
+      }
+    },
+    {
+      "type": "abstracts"
+    },
+    {
+      "type": "body",
+      "content": [
+        {
+          "type": "section",
+          "attrs": {
+            "id": "empty-section-1",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "An empty section"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "empty-section-2",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "An empty section"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "empty-section-3",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "An empty section"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "section-with-empty-paragraphs-1",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "A section containing empty paragraphs"
+                }
+              ]
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "empty-paragraph-1",
+                "placeholder": ""
+              }
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "empty-paragraph-2",
+                "placeholder": ""
+              }
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "section-with-empty-paragraphs-2",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "A section containing empty paragraphs"
+                }
+              ]
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "empty-paragraph-3",
+                "placeholder": ""
+              }
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "empty-paragraph-4",
+                "placeholder": ""
+              }
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "section-with-empty-paragraphs-3",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "A section containing empty paragraphs"
+                }
+              ]
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "empty-paragraph-5",
+                "placeholder": ""
+              }
+            },
+            {
+              "type": "paragraph",
+              "attrs": {
+                "id": "empty-paragraph-6",
+                "paragraphStyle": "",
+                "placeholder": ""
+              }
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "section-with-list",
+            "category": "",
+            "titleSuppressed": false
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "A section containing a list"
+                }
+              ]
+            },
+            {
+              "type": "list",
+              "attrs": {
+                "id": "list",
+                "listStyleType": "order"
+              },
+              "content": [
+                {
+                  "type": "list_item",
+                  "attrs": {
+                    "placeholder": "List item"
+                  },
+                  "content": [
+                    {
+                      "type": "paragraph",
+                      "attrs": {
+                        "placeholder": ""
+                      },
+                      "content": [
+                        {
+                          "type": "text",
+                          "text": "Test "
+                        },
+                        {
+                          "type": "inline_equation",
+                          "attrs": {
+                            "contents": "",
+                            "format": null
+                          }
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "section-with-figure",
+            "category": ""
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "A section containing a figure"
+                }
+              ]
+            },
+            {
+              "type": "figure_element",
+              "attrs": {
+                "id": "figure-element",
+                "label": ""
+              },
+              "content": [
+                {
+                  "type": "figure",
+                  "attrs": {
+                    "id": "figure",
+                    "src": "",
+                    "contentType": ""
+                  }
+                },
+                {
+                  "type": "caption",
+                  "attrs": {
+                    "placeholder": "Caption..."
+                  },
+                  "content": [{ "type": "text_block" }]
+                },
+                {
+                  "type": "alt_text"
+                },
+                {
+                  "type": "long_desc"
+                },
+                {
+                  "type": "listing",
+                  "attrs": {
+                    "contents": "",
+                    "language": "",
+                    "languageKey": "null",
+                    "isExpanded": false,
+                    "isExecuting": false
+                  }
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "section",
+          "attrs": {
+            "id": "section-with-table",
+            "category": "",
+            "dataTracked": null
+          },
+          "content": [
+            {
+              "type": "section_title",
+              "content": [
+                {
+                  "type": "text",
+                  "text": "A section containing a table"
+                }
+              ]
+            },
+            {
+              "type": "table_element",
+              "attrs": {
+                "id": "table-element",
+                "label": "",
+                "dataTracked": null
+              },
+              "content": [
+                {
+                  "type": "caption_title",
+                  "attrs": {
+                    "placeholder": "Title..."
+                  }
+                },
+                {
+                  "type": "table",
+                  "attrs": {
+                    "id": "table",
+                    "dataTracked": null
+                  },
+                  "content": [
+                    {
+                      "type": "table_row",
+                      "attrs": {
+                        "dataTracked": null
+                      },
+                      "content": [
+                        {
+                          "type": "table_cell",
+                          "content": [
+                            {
+                              "type": "text_block",
+                              "content": [
+                                {
+                                  "type": "text",
+                                  "text": "Text"
+                                }
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                  ]
+                },
+                {
+                  "type": "alt_text"
+                },
+                {
+                  "type": "long_desc"
+                },
+                {
+                  "type": "listing",
+                  "attrs": {
+                    "contents": "",
+                    "language": "",
+                    "languageKey": "null",
+                    "isExpanded": false,
+                    "isExecuting": false
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "backmatter",
+      "attrs": {
+        "placeholder": " "
+      }
+    },
+    {
+      "type": "comments"
+    }
+  ]
+}

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

@@ -0,0 +1,24 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`transformPasted handler > transform-pasted 1`] = `
+Object {
+  "content": Array [
+    Object {
+      "attrs": Object {
+        "dataTracked": null,
+        "id": null,
+        "placeholder": "",
+      },
+      "content": Array [
+        Object {
+          "text": "These rhythmic patterns then sum together to create the signals that muscles need to carry out the movements.",
+          "type": "text",
+        },
+      ],
+      "type": "paragraph",
+    },
+  ],
+  "openEnd": 1,
+  "openStart": 1,
+}
+`;

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

@@ -0,0 +1,202 @@
+/*!
+ * © 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 {
+  AffiliationAttrs,
+  affiliationLabel,
+  authorComparator,
+  ContributorAttrs,
+  initials,
+} from '../authors'
+
+describe('authorComparator', () => {
+  it('should sort authors based on priority', () => {
+    const contribs: ContributorAttrs[] = [
+      {
+        id: 'MPContributor:x',
+        priority: 1,
+        role: 'author',
+        affiliationIDs: [],
+        degrees: [],
+        isCorresponding: false,
+        isJointContributor: false,
+        ORCID: '',
+        email: '',
+        correspIDs: [],
+        footnoteIDs: [],
+        prefix: '',
+      },
+      {
+        id: 'MPContributor:y',
+        priority: 0,
+        role: 'author',
+        affiliationIDs: [],
+        degrees: [],
+        isCorresponding: false,
+        isJointContributor: false,
+        ORCID: '',
+        email: '',
+        correspIDs: [],
+        footnoteIDs: [],
+        prefix: '',
+      },
+      {
+        id: 'MPContributor:z',
+        priority: 2,
+        role: 'author',
+        affiliationIDs: [],
+        degrees: [],
+        isCorresponding: false,
+        isJointContributor: false,
+        ORCID: '',
+        email: '',
+        correspIDs: [],
+        footnoteIDs: [],
+        prefix: '',
+      },
+    ]
+    contribs.sort(authorComparator)
+    expect(contribs.map((c) => c.id)).toEqual([
+      'MPContributor:y',
+      'MPContributor:x',
+      'MPContributor:z',
+    ])
+  })
+})
+
+describe('initials', () => {
+  it('initials exist when "given" is present with more than one given name', () => {
+    const contributor = {
+      given: 'Derek Gilbert',
+      family: 'Dilbert',
+    } as ContributorAttrs
+    expect(initials(contributor)).toEqual('D.G.')
+  })
+
+  it('initials empty when no given name is present', () => {
+    const contributor = {
+      family: 'Dilbert',
+    } as ContributorAttrs
+    expect(initials(contributor)).toEqual('')
+  })
+
+  it('initials empty when given name is empty string', () => {
+    const contributor = {
+      family: 'Dilbert',
+      given: '',
+    } as ContributorAttrs
+    expect(initials(contributor)).toEqual('')
+  })
+
+  it('ignore extra white space', () => {
+    const contributor = {
+      given: 'Derek ',
+      family: 'Dilbert',
+    } as ContributorAttrs
+    expect(initials(contributor)).toEqual('D.')
+  })
+})
+
+describe('affiliationLabel', () => {
+  const affiliation: AffiliationAttrs = {
+    id: 'MPAffiliation:aff-1',
+    addressLine1: '',
+    addressLine2: '',
+    addressLine3: '',
+    city: '',
+    country: 'United Kingdom',
+    county: '',
+    department: 'Dept of Examples',
+    email: {
+      href: '',
+      text: '',
+    },
+    institution: 'University of Examples',
+    postCode: '',
+    priority: 0,
+  }
+
+  it('should return the institution name and department', () => {
+    const result = affiliationLabel(affiliation)
+    expect(result).toEqual('University of Examples (Dept of Examples)')
+  })
+
+  it('should exclude the department if it is not present', () => {
+    const affiliation: AffiliationAttrs = {
+      id: 'MPAffiliation:aff-1',
+      addressLine1: '',
+      addressLine2: '',
+      addressLine3: '',
+      city: '',
+      country: 'United Kingdom',
+      county: '',
+      department: '',
+      email: {
+        href: '',
+        text: '',
+      },
+      institution: 'University of Examples',
+      postCode: '',
+      priority: 0,
+    }
+    const result = affiliationLabel(affiliation)
+    expect(result).toEqual('University of Examples')
+  })
+
+  it('should handle a missing institution', () => {
+    const affiliation: AffiliationAttrs = {
+      id: 'MPAffiliation:aff-1',
+      addressLine1: '',
+      addressLine2: '',
+      addressLine3: '',
+      city: '',
+      country: 'United Kingdom',
+      county: '',
+      department: 'Dept of Examples',
+      email: {
+        href: '',
+        text: '',
+      },
+      institution: '',
+      postCode: '',
+      priority: 0,
+    }
+    const result = affiliationLabel(affiliation)
+    expect(result).toEqual('(unknown institution)')
+  })
+
+  it('should have a generic label if both institution and department are missing', () => {
+    const affiliation: AffiliationAttrs = {
+      id: 'MPAffiliation:aff-1',
+      addressLine1: '',
+      addressLine2: '',
+      addressLine3: '',
+      city: '',
+      country: 'United Kingdom',
+      county: '',
+      department: '',
+      email: {
+        href: '',
+        text: '',
+      },
+      institution: '',
+      postCode: '',
+      priority: 0,
+    }
+    const result = affiliationLabel(affiliation)
+    expect(result).toEqual('(unknown institution)')
+  })
+})

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

@@ -0,0 +1,46 @@
+/*!
+ * © 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 * as lib from '../helpers'
+
+describe('mergeSimilarItems', () => {
+  it('should not change the array if no items are similar', () => {
+    const merger = lib.mergeSimilarItems<string>(
+      (a, b) => a === b,
+      (a, b) => `${a}-${b}`
+    )
+    const init = ['one', 'two']
+    expect(merger(init)).toEqual(init)
+  })
+
+  it('should collapse any items that are similar', () => {
+    const merger = lib.mergeSimilarItems<string>(
+      () => true,
+      (a, b) => `${a}-${b}`
+    )
+    const init = ['one', 'two']
+    expect(merger(init)).toEqual(['one-two'])
+  })
+
+  it('should be able to collapse multiple items', () => {
+    const merger = lib.mergeSimilarItems<number>(
+      (a, b) => !!(a % 2) && !!(b % 2),
+      (a) => a
+    )
+    const init = [1, 2, 3, 4, 5, 6, 7, 8, 9]
+    expect(merger(init)).toEqual([1, 2, 4, 6, 8])
+  })
+})