@manuscripts/transform 4.3.53 → 4.4.1

package/src/schema/nodes/table_col.ts

@@ -0,0 +1,76 @@
+/*!
+ * © 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.
+ */
+
+// adapted from 'prosemirror-tables'
+
+import { NodeSpec } from 'prosemirror-model'
+
+import { ManuscriptNode } from '../types'
+
+export interface TableColNode extends ManuscriptNode {
+  attrs: {
+    width: string
+    id: string
+  }
+}
+
+export const tableColGroup: NodeSpec = {
+  content: 'table_col+',
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'colgroup',
+    },
+  ],
+  toDOM() {
+    return ['colgroup', 0]
+  },
+}
+
+export const tableCol: NodeSpec = {
+  attrs: {
+    width: { default: '' },
+    id: { default: '' },
+  },
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'col',
+      getAttrs: (p) => {
+        const dom = p as HTMLTableColElement
+
+        return {
+          width: dom.getAttribute('width'),
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const tableColNode = node as TableColNode
+
+    const attrs: { [key: string]: string } = {}
+
+    if (tableColNode.attrs.width) {
+      attrs['width'] = tableColNode.attrs.width
+    }
+    if (tableColNode.attrs.id) {
+      attrs['id'] = tableColNode.attrs.id
+    }
+
+    return ['col', attrs]
+  },
+}

package/src/schema/nodes/table_element.ts

@@ -0,0 +1,67 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model'
+
+import { ManuscriptNode } from '../types'
+
+export interface TableAttrs {
+  id: string
+}
+
+export interface TableElementNode extends ManuscriptNode {
+  attrs: TableAttrs
+}
+
+export const tableElement: NodeSpec = {
+  content:
+    'caption_title (table | placeholder) table_colgroup? table_element_footer? alt_text long_desc (listing | placeholder)',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block element executable',
+  parseDOM: [
+    {
+      tag: 'figure.table',
+      getAttrs: (dom) => {
+        const element = dom as HTMLTableElement
+
+        return {
+          id: element.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const tableElementNode = node as TableElementNode
+
+    return [
+      'figure',
+      {
+        class: 'table', // TODO: suppress-header, suppress-footer?
+        id: tableElementNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}
+
+export const isTableElementNode = (
+  node: ManuscriptNode
+): node is TableElementNode =>
+  node.type === node.type.schema.nodes.table_element

package/src/schema/nodes/table_element_footer.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 { NodeSpec } from 'prosemirror-model'
+
+import { ManuscriptNode } from '../types'
+
+interface Attrs {
+  id: string
+}
+
+export interface TableElementFooterNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const tableElementFooter: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  content: 'general_table_footnote? footnotes_element?',
+  group: 'block element',
+  toDOM: () => ['table-wrap-foot', 0],
+}
+
+export const isTableElementFooter = (
+  node: ManuscriptNode
+): node is TableElementFooterNode =>
+  node.type === node.type.schema.nodes.table_element_footer

package/src/schema/nodes/text.ts

@@ -0,0 +1,31 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model'
+
+import { paragraph } from './paragraph'
+
+export const text: NodeSpec = {
+  group: 'inline',
+}
+
+export const textBlock: NodeSpec = {
+  ...paragraph,
+  attrs: {
+    dataTracked: { default: null },
+  },
+  group: 'block',
+}

package/src/schema/nodes/title.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.
+ */
+
+import { NodeSpec } from 'prosemirror-model'
+
+import { ManuscriptNode } from '../types'
+
+export interface TitleAttrs {
+  id: string
+  placeholder: string
+}
+
+export interface TitleNode extends ManuscriptNode {
+  attrs: TitleAttrs
+}
+
+export const title: NodeSpec = {
+  content: '(text | highlight_marker)*',
+  attrs: {
+    id: { default: '' },
+    placeholder: { default: 'Insert title here...' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  parseDOM: [{ tag: 'div' }],
+  toDOM: () => ['div', 0],
+}
+
+export const isTitleNode = (node: ManuscriptNode): node is TitleNode =>
+  node.type === node.type.schema.nodes.title

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,243 @@
+/*!
+ * © 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'
+  | 'headshot_grid'
+  | 'headshot_element'
+  | 'headshot_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()}`