@manuscripts/transform 4.3.53 → 4.4.1

package/src/transformer/index.ts

@@ -0,0 +1,21 @@
+/*!
+ * © 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 './id'
+export * from './node-names'
+export * from './node-title'
+export * from './node-types'
+export * from './node-validator'

package/src/transformer/node-names.ts

@@ -0,0 +1,75 @@
+/*!
+ * © 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 '../schema'
+import { ManuscriptNodeType } from '../schema/types'
+
+export const nodeNames: Map<ManuscriptNodeType, string> = new Map([
+  [schema.nodes.title, 'Title'],
+  [schema.nodes.contributor, 'Author'],
+  [schema.nodes.keywords, 'Keywords'],
+  [schema.nodes.keyword, 'Keyword'],
+  [schema.nodes.bibliography_element, 'Bibliography'],
+  [schema.nodes.bibliography_item, 'Reference'],
+  [schema.nodes.bibliography_section, 'Section'],
+  [schema.nodes.citation, 'Citation'],
+  [schema.nodes.listing_element, 'Listing'],
+  [schema.nodes.cross_reference, 'Cross Reference'],
+  [schema.nodes.equation_element, 'Equation'],
+  [schema.nodes.figure_element, 'Figure'],
+  [schema.nodes.image_element, 'Image'],
+  [schema.nodes.hero_image, 'Hero Image'],
+  [schema.nodes.headshot_grid, 'Headshot Panel'],
+  [schema.nodes.headshot_element, 'Headshot'],
+  [schema.nodes.table_element, 'Table'],
+  [schema.nodes.table_cell, 'Table Cell'],
+  [schema.nodes.table_col, 'Table Column'],
+  [schema.nodes.table_row, 'Table Row'],
+  [schema.nodes.table_header, 'Table Header'],
+  [schema.nodes.general_table_footnote, 'General Table note'],
+  [schema.nodes.table_element_footer, 'Table Footer'],
+  [schema.nodes.embed, 'Media'],
+  [schema.nodes.equation, 'Equation'],
+  [schema.nodes.inline_equation, 'Inline Equation'],
+  [schema.nodes.inline_footnote, 'Footnote Reference'],
+  [schema.nodes.footnote, 'Footnote'],
+  [schema.nodes.footnotes_element, 'Notes'],
+  [schema.nodes.footnotes_section, 'Footnotes Section'],
+  [schema.nodes.list, 'List'],
+  [schema.nodes.list_item, 'List Item'],
+  [schema.nodes.manuscript, 'Manuscript'],
+  [schema.nodes.paragraph, 'Paragraph'],
+  [schema.nodes.text_block, 'Paragraph'],
+  [schema.nodes.section, 'Section'],
+  [schema.nodes.graphical_abstract_section, 'Graphical Abstract'],
+  [schema.nodes.trans_abstract, 'Trans Abstract'],
+  [schema.nodes.trans_graphical_abstract, 'Trans Graphical Abstract'],
+  [schema.nodes.section_title, 'Section Title'],
+  [schema.nodes.section_title_plain, 'Section Title'],
+  [schema.nodes.table, 'Table'],
+  [schema.nodes.table_element, 'Table'],
+  [schema.nodes.blockquote_element, 'Block Quote'],
+  [schema.nodes.pullquote_element, 'Pull Quote'],
+  [schema.nodes.box_element, 'Box'],
+  [schema.nodes.supplements, 'Supplements'],
+  [schema.nodes.attachments, 'Main Document'],
+])
+
+export const typeName = (type: ManuscriptNodeType) =>
+  type.name
+    .split('_')
+    .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
+    .join('')

package/src/transformer/node-title.ts

@@ -0,0 +1,116 @@
+/*!
+ * © 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 { NodeType } from 'prosemirror-model'
+
+import { iterateChildren } from '../lib/utils'
+import { isHighlightMarkerNode, schema } from '../schema'
+import { ManuscriptNode, ManuscriptNodeType } from '../schema/types'
+import { nodeNames } from './node-names'
+
+const textSnippet = (node: ManuscriptNode, max = 100) => {
+  let text = ''
+
+  node.forEach((child) => {
+    if (child.isText) {
+      text += child.text
+    } else if (isHighlightMarkerNode(node)) {
+      text += ''
+    } else if (node.type === schema.nodes.headshot_element) {
+      if (child.type === schema.nodes.caption_title) {
+        text += child.textContent
+      }
+    } else {
+      text += ' '
+    }
+  })
+
+  return text.substring(0, max)
+}
+
+const snippetOfNodeType = (
+  node: ManuscriptNode,
+  nodeType: ManuscriptNodeType
+) => {
+  for (const child of iterateChildren(node, true)) {
+    if (child.type === nodeType) {
+      return textSnippet(child)
+    }
+  }
+
+  return null
+}
+
+export const nodeTitle = (node: ManuscriptNode) => {
+  const nodes = schema.nodes
+
+  switch (node.type) {
+    case nodes.manuscript:
+      return snippetOfNodeType(node, nodes.title)
+
+    case nodes.section:
+    case nodes.bibliography_section:
+    case nodes.footnotes_section:
+    case nodes.keywords:
+    case nodes.graphical_abstract_section:
+    case nodes.trans_graphical_abstract:
+      return snippetOfNodeType(node, nodes.section_title)
+
+    case nodes.footnotes_element:
+      return node.attrs.collateByKind === 'footnote' ? 'Footnotes' : 'Endnotes' // TODO
+
+    case nodes.list:
+    case nodes.blockquote_element:
+    case nodes.footnote:
+    case nodes.pullquote_element:
+      return snippetOfNodeType(node, nodes.paragraph)
+
+    case nodes.embed:
+    case nodes.figure_element:
+    case nodes.table_element:
+    case nodes.equation_element:
+    case nodes.listing_element:
+    case nodes.multi_graphic_figure_element:
+    case nodes.image_element:
+    case nodes.hero_image:
+    case nodes.headshot_grid:
+    case nodes.box_element:
+    case nodes.supplements:
+    case nodes.attachments:
+      return ''
+
+    default:
+      return textSnippet(node)
+  }
+}
+
+export const nodeTitlePlaceholder = (nodeType: NodeType) => {
+  const nodes = schema.nodes
+
+  switch (nodeType) {
+    case nodes.manuscript:
+      return 'Untitled Manuscript'
+
+    case nodes.section:
+      return 'Untitled Section'
+
+    case nodes.bibliography_section:
+      return 'Bibliography'
+
+    default:
+      return nodeNames.get(nodeType) || ''
+  }
+}

package/src/transformer/node-types.ts

@@ -0,0 +1,39 @@
+/*!
+ * © 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 {
+  GROUP_ELEMENT,
+  GROUP_EXECUTABLE,
+  GROUP_SECTION,
+  hasGroup,
+  ManuscriptNode,
+  ManuscriptNodeType,
+  Nodes,
+} from '../schema'
+
+export const isExecutableNodeType = (type: ManuscriptNodeType) =>
+  hasGroup(type, GROUP_EXECUTABLE)
+
+export const isElementNodeType = (type: ManuscriptNodeType) =>
+  hasGroup(type, GROUP_ELEMENT)
+
+export const isSectionNodeType = (type: ManuscriptNodeType) =>
+  hasGroup(type, GROUP_SECTION)
+
+export const isNodeType = <T extends ManuscriptNode>(
+  node: ManuscriptNode,
+  type: Nodes
+): node is T => node.type === node.type.schema.nodes[type]

package/src/transformer/node-validator.ts

@@ -0,0 +1,82 @@
+/*!
+ * © 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 { Node, NodeType } from 'prosemirror-model'
+import { findChildrenByType } from 'prosemirror-utils'
+
+import { TitleNode } from '../schema'
+
+export interface ValidationError {
+  code: string
+  id?: string
+}
+
+export interface ValidationResult {
+  isValid: boolean
+  errors: ValidationError[]
+}
+
+export const VALIDATION_ERROR_CODES = {
+  EMPTY_TITLE: 'EMPTY_TITLE',
+} as const
+
+const validateTitleNode = (node: TitleNode): ValidationError[] => {
+  const errors: ValidationError[] = []
+  if (!node.textContent) {
+    errors.push({
+      code: VALIDATION_ERROR_CODES.EMPTY_TITLE,
+      id: node.attrs.id,
+    })
+  }
+  return errors
+}
+
+const validateNode = (
+  nodeType: NodeType,
+  node: Node,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  doc: Node
+): ValidationError[] => {
+  switch (nodeType.name) {
+    case 'title':
+      return validateTitleNode(node as TitleNode)
+    default:
+      return []
+  }
+}
+
+export const validateManuscriptNode = (doc: Node): ValidationResult => {
+  const schema = doc.type.schema
+  const validatableTypes = ['title']
+  const errors: ValidationError[] = []
+
+  validatableTypes.forEach((typeName) => {
+    const nodeType = schema.nodes[typeName]
+    if (nodeType) {
+      const nodes = findChildrenByType(doc, nodeType).map(
+        (result) => result.node
+      )
+      nodes.forEach((node) => {
+        const nodeErrors = validateNode(nodeType, node, doc)
+        errors.push(...nodeErrors)
+      })
+    }
+  })
+
+  return {
+    isValid: errors.length === 0,
+    errors,
+  }
+}

package/src/types.ts

@@ -0,0 +1,25 @@
+/*!
+ * © 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 type JSONProsemirrorNode = {
+  type: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  attrs: { [key: string]: any }
+  content?: JSONProsemirrorNode[]
+  text?: string
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  marks?: Array<{ type: string; attrs?: Record<string, any> }>
+}

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = "4.4.1";