@manuscripts/transform 4.3.52 → 4.4.0

package/src/schema/nodes/figure.ts

@@ -0,0 +1,65 @@
+/*!
+ * © 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 FigureAttrs {
+  id: string
+  src: string
+  type: string
+}
+
+export interface FigureNode extends ManuscriptNode {
+  attrs: FigureAttrs
+}
+
+export const figure: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    src: { default: '' },
+    type: { default: '' },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'figure',
+      context: 'figure_element/',
+      getAttrs: (dom) => {
+        const element = dom as HTMLElement
+
+        return {
+          id: element.getAttribute('id'),
+          src: element.getAttribute('src'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const figureNode = node as FigureNode
+
+    return [
+      'figure',
+      {
+        class: 'figure',
+        id: figureNode.attrs.id,
+      },
+    ]
+  },
+}

package/src/schema/nodes/figure_element.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 { NodeSpec } from 'prosemirror-model'
+
+import { ManuscriptNode } from '../types'
+import { AttributionNode } from './attribution'
+
+export interface FigureElementAttrs {
+  id: string
+  attribution?: AttributionNode
+}
+
+export interface FigureElementNode extends ManuscriptNode {
+  attrs: FigureElementAttrs
+}
+
+export const figureElement: NodeSpec = {
+  content:
+    '(paragraph | figure | missing_figure | placeholder)+ attribution* caption alt_text long_desc (listing | placeholder)',
+  attrs: {
+    id: { default: '' },
+    attribution: { default: undefined },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block element executable',
+  parseDOM: [
+    {
+      tag: 'figure.figure-group',
+      getAttrs: (p) => {
+        const dom = p as HTMLElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const figureElementNode = node as FigureElementNode
+
+    const { id } = figureElementNode.attrs
+
+    const attrs: { [key: string]: string } = {}
+
+    const classes: string[] = ['figure-group']
+
+    attrs.class = classes.join(' ')
+
+    attrs.id = id
+
+    return ['figure', attrs, 0]
+  },
+}
+
+export const isFigureElementNode = (
+  node: ManuscriptNode
+): node is FigureElementNode =>
+  node.type === node.type.schema.nodes.figure_element

package/src/schema/nodes/footnote.ts

@@ -0,0 +1,95 @@
+/*!
+ * © 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'
+
+type Kind = 'footnote' | 'endnote'
+
+// const placeholderText: { [key in Kind]: string } = {
+//   endnote: 'Endnote',
+//   footnote: 'Footnote',
+// }
+
+interface Attrs {
+  id: string
+  kind: Kind
+  placeholder?: string
+}
+
+export interface FootnoteNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const footnote: NodeSpec = {
+  group: 'block',
+  content: 'paragraph+',
+  attrs: {
+    id: { default: '' },
+    kind: { default: 'footnote' },
+    placeholder: { default: '' },
+    dataTracked: { default: null },
+  },
+  parseDOM: [
+    {
+      tag: 'div.footnote-text', // TODO: footnote-contents wrapper?
+      getAttrs: (p) => {
+        const dom = p as HTMLDivElement
+
+        const attrs: Partial<Attrs> = {
+          id: dom.getAttribute('id') || undefined,
+          kind: (dom.getAttribute('data-kind') || 'footnote') as Kind,
+        }
+
+        const placeholder = dom.getAttribute('data-placeholder-text')
+
+        if (placeholder) {
+          attrs.placeholder = placeholder
+        }
+
+        return attrs
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const footnoteNode = node as FootnoteNode
+
+    // TODO: footnote-contents wrapper?
+
+    // TODO: default kind
+    const { kind, placeholder, id } = footnoteNode.attrs
+
+    const attrs: Record<string, string> = { class: 'footnote-text', id: '' }
+
+    if (kind) {
+      attrs['data-kind'] = kind
+    }
+
+    if (id) {
+      attrs.id = id
+    }
+
+    if (placeholder) {
+      attrs['data-placeholder-text'] = placeholder
+    }
+
+    return ['div', attrs, 0]
+  },
+}
+
+export const isFootnoteNode = (node: ManuscriptNode): node is FootnoteNode =>
+  node.type === node.type.schema.nodes.footnote

package/src/schema/nodes/footnotes_element.ts

@@ -0,0 +1,69 @@
+/*!
+ * © 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
+  kind?: string
+}
+
+export interface FootnotesElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const footnotesElement: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    kind: { default: 'footnote' },
+    dataTracked: { default: null },
+  },
+  content: 'footnote*',
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'div.footnotes', // TODO: endnotes?
+      getAttrs: (p) => {
+        const dom = p as HTMLDivElement
+
+        return {
+          kind: dom.getAttribute('data-kind') || 'footnote',
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const footnotesElementNode = node as FootnotesElementNode
+
+    const { id, kind } = footnotesElementNode.attrs
+
+    const attrs: Record<string, string> = { class: 'footnotes', id }
+
+    if (kind) {
+      attrs['data-kind'] = kind
+    }
+
+    return ['div', attrs, 0]
+  },
+}
+
+export const isFootnotesElementNode = (
+  node: ManuscriptNode
+): node is FootnotesElementNode =>
+  node.type === node.type.schema.nodes.footnotes_element

package/src/schema/nodes/footnotes_section.ts

@@ -0,0 +1,61 @@
+/*!
+ * © 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
+}
+
+// TODO: endnotes section?
+
+export interface FootnotesSectionNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const footnotesSection: NodeSpec = {
+  content: 'section_title footnotes_element?',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block sections',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'section.footnotes',
+    },
+  ],
+  toDOM: (node) => {
+    const footnotesSectionNode = node as FootnotesSectionNode
+
+    return [
+      'section',
+      {
+        id: footnotesSectionNode.attrs.id,
+        class: 'footnotes',
+      },
+      0,
+    ]
+  },
+}
+
+export const isFootnotesSectionNode = (
+  node: ManuscriptNode
+): node is FootnotesSectionNode =>
+  node.type === node.type.schema.nodes.footnotes_section

package/src/schema/nodes/general_table_footnote.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 GeneralTableFootnoteNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const generalTableFootnote: NodeSpec = {
+  content: 'paragraph*',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  toDOM: () => ['div', { class: 'general-table-footnote' }, 0],
+}
+
+export const isGeneralTableFootnoteNode = (
+  node: ManuscriptNode
+): node is GeneralTableFootnoteNode =>
+  node.type === node.type.schema.nodes.general_table_footnote

package/src/schema/nodes/graphical_abstract_section.ts

@@ -0,0 +1,62 @@
+/*!
+ * © 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 GraphicalAbstractSectionAttrs {
+  id: string
+  category: string
+}
+
+export interface GraphicalAbstractSectionNode extends ManuscriptNode {
+  attrs: GraphicalAbstractSectionAttrs
+}
+
+export const graphicalAbstractSection: NodeSpec = {
+  content: 'section_title (figure_element | placeholder)', // does it need perhaps a special view that limits the figure content? Ask Nick?
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+    category: { default: '' },
+  },
+  group: 'block sections',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'section.graphical-abstract',
+    },
+  ],
+  toDOM: (node) => {
+    const graphicalAbstractSectionNode = node as GraphicalAbstractSectionNode
+
+    return [
+      'section',
+      {
+        id: graphicalAbstractSectionNode.attrs.id,
+        class: 'graphical-abstract',
+        spellcheck: 'false',
+      },
+      0,
+    ]
+  },
+}
+
+export const isGraphicalAbstractSectionNode = (
+  node: ManuscriptNode
+): node is GraphicalAbstractSectionNode =>
+  node.type === node.type.schema.nodes.graphical_abstract_section

package/src/schema/nodes/hard_break.ts

@@ -0,0 +1,36 @@
+/*!
+ * © 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 HardBreakNode extends ManuscriptNode {
+  attrs: Record<string, unknown>
+}
+
+export const hardBreak: NodeSpec = {
+  inline: true,
+  group: 'inline',
+  selectable: false,
+  attrs: {
+    dataTracked: { default: null },
+  },
+  parseDOM: [{ tag: 'br' }],
+  toDOM() {
+    return ['br']
+  },
+}

package/src/schema/nodes/hero_image.ts

@@ -0,0 +1,46 @@
+/*!
+ * © 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 { ManuscriptNode } from '../types'
+
+export interface HeroImageNode extends ManuscriptNode {
+  attrs: {
+    id: string
+  }
+}
+
+export const heroImage: NodeSpec = {
+  content: 'figure? alt_text long_desc',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  toDOM: (node) => {
+    return [
+      'div',
+      {
+        class: 'hero_image',
+        id: node.attrs.id,
+      },
+    ]
+  },
+}
+
+export const isHeroImageNode = (node: ManuscriptNode): node is HeroImageNode =>
+  node.type === node.type.schema.nodes.hero_image

package/src/schema/nodes/highlight_marker.ts

@@ -0,0 +1,68 @@
+/*!
+ * © 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 {
+  //TODO rename to rid
+  id: string
+  position: string
+}
+
+export interface HighlightMarkerNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const highlightMarker: NodeSpec = {
+  inline: true,
+  group: 'inline',
+  // draggable: true,
+  atom: true,
+  attrs: {
+    id: { default: '' },
+    position: { default: '' },
+  },
+  parseDOM: [
+    {
+      tag: 'span.highlight-marker',
+      getAttrs: (p) => {
+        const dom = p as HTMLSpanElement
+
+        return {
+          id: dom.getAttribute('id'),
+          position: dom.getAttribute('data-position'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const highlightMarkerNode = node as HighlightMarkerNode
+
+    const dom = document.createElement('span')
+    dom.className = 'highlight-marker'
+    dom.setAttribute('id', highlightMarkerNode.attrs.id)
+    dom.setAttribute('data-position', highlightMarkerNode.attrs.position)
+
+    return dom
+  },
+}
+
+export const isHighlightMarkerNode = (
+  node: ManuscriptNode
+): node is HighlightMarkerNode =>
+  node.type === node.type.schema.nodes.highlight_marker

package/src/schema/nodes/image_element.ts

@@ -0,0 +1,49 @@
+/*!
+ * © 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 { NodeSpec } from 'prosemirror-model'
+
+import { ManuscriptNode } from '../types'
+
+export interface ImageElementNode extends ManuscriptNode {
+  attrs: {
+    id: string
+    extLink?: string
+  }
+}
+
+export const imageElement: NodeSpec = {
+  content: 'figure? caption alt_text long_desc',
+  attrs: {
+    id: { default: '' },
+    extLink: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  toDOM: (node) => {
+    return [
+      'div',
+      {
+        class: 'image_element',
+        id: node.attrs.id,
+      },
+    ]
+  },
+}
+
+export const isImageElementNode = (
+  node: ManuscriptNode
+): node is ImageElementNode =>
+  node.type === node.type.schema.nodes.image_element