@manuscripts/transform 4.3.52 → 4.4.0

package/src/schema/nodes/trans_abstract.ts

@@ -0,0 +1,58 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model'
+
+import { schema } from '../index'
+import type { ManuscriptNode } from '../types'
+
+export interface TransAbstractAttrs {
+  id: string
+  lang: string
+  category: string
+}
+
+export interface TransAbstractNode extends ManuscriptNode {
+  attrs: TransAbstractAttrs
+}
+
+export const transAbstract: NodeSpec = {
+  content: 'section_title (paragraph | element)* sections*',
+  attrs: {
+    id: { default: '' },
+    lang: { default: '' },
+    category: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block sections',
+  selectable: false,
+  toDOM: (node) => {
+    const { id, lang } = node.attrs
+    return [
+      'section',
+      {
+        id,
+        lang,
+        class: 'trans-abstract',
+      },
+      0,
+    ]
+  },
+}
+
+export const isTransAbstractNode = (
+  node: ManuscriptNode
+): node is TransAbstractNode => node.type === schema.nodes.trans_abstract

package/src/schema/nodes/trans_graphical_abstract.ts

@@ -0,0 +1,67 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model'
+
+import { schema } from '../index'
+import type { ManuscriptNode } from '../types'
+
+export interface TransGraphicalAbstractAttrs {
+  id: string
+  lang: string
+  category: string
+}
+
+export interface TransGraphicalAbstractNode extends ManuscriptNode {
+  attrs: TransGraphicalAbstractAttrs
+}
+
+export const transGraphicalAbstract: NodeSpec = {
+  content: 'section_title (figure_element | placeholder)',
+  attrs: {
+    id: { default: '' },
+    lang: { default: '' },
+    category: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block sections',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'section.trans-graphical-abstract',
+    },
+  ],
+  toDOM: (node) => {
+    const transGraphicalAbstractNode = node as TransGraphicalAbstractNode
+    const { id, lang } = transGraphicalAbstractNode.attrs
+
+    return [
+      'section',
+      {
+        id,
+        lang,
+        class: 'trans-graphical-abstract',
+        spellcheck: 'false',
+      },
+      0,
+    ]
+  },
+}
+
+export const isTransGraphicalAbstractNode = (
+  node: ManuscriptNode
+): node is TransGraphicalAbstractNode =>
+  node.type === schema.nodes.trans_graphical_abstract

package/src/schema/types.ts

@@ -0,0 +1,240 @@
+/*!
+ * © 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 {
+  Fragment,
+  Mark as ProsemirrorMark,
+  MarkType,
+  Node as ProsemirrorNode,
+  NodeSpec,
+  NodeType,
+  ParseRule,
+  ResolvedPos,
+  Schema,
+  Slice,
+} from 'prosemirror-model'
+import {
+  EditorState,
+  NodeSelection,
+  Plugin,
+  TextSelection,
+  Transaction,
+} from 'prosemirror-state'
+import { EditorView, NodeView } from 'prosemirror-view'
+
+export type Marks =
+  | 'bold'
+  | 'code'
+  | 'italic'
+  | 'smallcaps'
+  | 'strikethrough'
+  | 'styled'
+  | 'subscript'
+  | 'superscript'
+  | 'underline'
+  | 'tracked_insert'
+  | 'tracked_delete'
+
+export type Nodes =
+  | 'attribution'
+  | 'bibliography_item'
+  | 'bibliography_element'
+  | 'bibliography_section'
+  | 'blockquote_element'
+  | 'quote_image'
+  | 'list'
+  | 'caption'
+  | 'caption_title'
+  | 'comment'
+  | 'comments'
+  | 'citation'
+  | 'cross_reference'
+  | 'doc'
+  | 'equation'
+  | 'equation_element'
+  | 'figure'
+  | 'graphical_abstract_section'
+  | 'figure_element'
+  | 'footnote'
+  | 'footnotes_element'
+  | 'footnotes_section'
+  | 'hard_break'
+  | 'highlight_marker'
+  | 'inline_equation'
+  | 'inline_footnote'
+  | 'keyword'
+  | 'keywords_element'
+  | 'keyword_group'
+  | 'keywords'
+  | 'link'
+  | 'list_item'
+  | 'listing'
+  | 'listing_element'
+  | 'manuscript'
+  | 'abstracts'
+  | 'body'
+  | 'backmatter'
+  | 'missing_figure'
+  | 'paragraph'
+  | 'placeholder'
+  | 'placeholder_element'
+  | 'pullquote_element'
+  | 'section'
+  | 'section_label'
+  | 'section_title'
+  | 'section_title_plain'
+  | 'table'
+  | 'table_cell'
+  | 'table_element'
+  | 'table_row'
+  | 'table_colgroup'
+  | 'table_col'
+  | 'table_header'
+  | 'text'
+  | 'text_block'
+  | 'affiliation'
+  | 'contributor'
+  | 'table_element_footer'
+  | 'title'
+  | 'affiliations'
+  | 'contributors'
+  | 'supplements'
+  | 'supplement'
+  | 'author_notes'
+  | 'corresp'
+  | 'general_table_footnote'
+  | 'box_element'
+  | 'awards'
+  | 'award'
+  | 'embed'
+  | 'image_element'
+  | 'attachment'
+  | 'attachments'
+  | 'alt_title'
+  | 'alt_text'
+  | 'alt_titles'
+  | 'long_desc'
+  | 'hero_image'
+  | 'trans_abstract'
+  | 'trans_graphical_abstract'
+  | 'subtitle'
+  | 'subtitles'
+
+export type ManuscriptSchema = Schema<Nodes, Marks>
+
+export type ManuscriptEditorState = EditorState
+export type ManuscriptEditorView = EditorView
+export type ManuscriptFragment = Fragment
+export type ManuscriptMark = ProsemirrorMark
+export type ManuscriptNode = ProsemirrorNode
+export type ManuscriptNodeSelection = NodeSelection
+export type ManuscriptTextSelection = TextSelection
+export type ManuscriptMarkType = MarkType
+export type ManuscriptNodeType = NodeType
+export type ManuscriptNodeView = NodeView
+export type ManuscriptResolvedPos = ResolvedPos
+export type ManuscriptPlugin = Plugin
+export type ManuscriptSlice = Slice
+export type ManuscriptTransaction = Transaction
+
+export interface TableNodeSpec extends NodeSpec {
+  tableRole: string
+}
+
+export type DataTrackedAttrs = {
+  id: string
+  status: string
+  operation: string
+  userID: string
+  createdAt: number
+}
+
+export type SectionGroup =
+  | 'abstracts'
+  | 'body'
+  | 'backmatter'
+  | 'abstracts-graphic'
+
+export type SectionCategory = {
+  id: string
+  synonyms: string[]
+  label?: string // for display menu purposes, if not provided, the first title will be used
+  titles: [string, ...string[]]
+  group?: SectionGroup
+  isUnique: boolean
+}
+
+export type ManuscriptTemplate = {
+  _id: string
+  bundle: string
+  title: string
+  sectionCategories: SectionCategory[]
+  articleType: string
+  hiddenNodeTypes?: string[]
+}
+
+export interface UserProfile {
+  _id: string
+  userID: string
+  given?: string
+  family?: string
+}
+
+export interface Project {
+  _id: string
+  owners: string[]
+  writers: string[]
+  editors?: string[]
+  annotators?: string[]
+  proofers?: string[]
+  viewers: string[]
+  updatedAt: number
+}
+
+export interface Bundle {
+  _id: string
+  csl: {
+    _id: string
+  }
+}
+
+export enum ManuscriptActions {
+  handleSuggestion = 'handleSuggestion',
+  rejectOwnSuggestion = 'rejectOwnSuggestion',
+  handleOwnComments = 'handleOwnComments',
+  handleOthersComments = 'handleOthersComments',
+  resolveOwnComment = 'resolveOwnComment',
+  resolveOthersComment = 'resolveOthersComment',
+  createComment = 'createComment',
+  canEditFiles = 'canEditFiles',
+  editArticle = 'editArticle',
+  formatArticle = 'formatArticle',
+  editMetadata = 'editMetadata',
+  editCitationsAndRefs = 'editCitationsAndRefs',
+  seeEditorToolbar = 'seeEditorToolbar',
+  seeReferencesButtons = 'seeReferencesButtons',
+}
+
+export type MarkRule = ParseRule & { mark: Marks | null }
+
+export type NodeRule = ParseRule & { node?: Nodes | null }
+
+export function isNodeOfType<T extends ManuscriptNode>(
+  node: ManuscriptNode,
+  type: NodeType
+): node is T {
+  return node.type === type
+}

package/src/tests.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 { v4 as uuid } from 'uuid'
+
+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()),
+  })
+}

package/src/transformer/id.ts

@@ -0,0 +1,23 @@
+/*!
+ * © 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 { v4 as uuid } from 'uuid'
+
+import { ManuscriptNodeType } from '../schema'
+import { typeName } from './node-names'
+
+export const generateNodeID = (type: ManuscriptNodeType) =>
+  `MP${typeName(type)}:${uuid()}`

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,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 { 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.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,111 @@
+/*!
+ * © 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 {
+      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.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]