@manuscripts/transform 4.3.53 → 4.4.0

package/src/schema/nodes/section_title.ts

@@ -0,0 +1,58 @@
+/*!
+ * © 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 SectionTitleNode extends ManuscriptNode {
+  attrs: Record<string, unknown>
+}
+
+export const sectionTitle: NodeSpec = {
+  content: '(text | highlight_marker)*',
+  marks:
+    'italic superscript subscript smallcaps bold tracked_insert tracked_delete',
+  group: 'block',
+  attrs: { dataTracked: { default: null } },
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'h1',
+    },
+    {
+      tag: 'h2',
+    },
+    {
+      tag: 'h3',
+    },
+    {
+      tag: 'h4',
+    },
+    {
+      tag: 'h5',
+    },
+    {
+      tag: 'h6',
+    },
+  ],
+  toDOM: () => ['h1', 0],
+}
+
+export const isSectionTitleNode = (
+  node: ManuscriptNode
+): node is SectionTitleNode =>
+  node.type === node.type.schema.nodes.section_title

package/src/schema/nodes/subtitle.ts

@@ -0,0 +1,40 @@
+/*!
+ * © 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 SubtitleAttrs {
+  id: string
+}
+
+export interface SubtitleNode extends ManuscriptNode {
+  attrs: SubtitleAttrs
+}
+
+export const subtitle: NodeSpec = {
+  content: '(text | highlight_marker)*',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  toDOM: () => ['div', 0],
+}
+
+export const isSubtitleNode = (node: ManuscriptNode): node is SubtitleNode =>
+  node.type === node.type.schema.nodes.subtitle

package/src/schema/nodes/subtitles.ts

@@ -0,0 +1,51 @@
+/*!
+ * © 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 SubtitlesAttrs {
+  id: string
+}
+
+export interface SubtitlesNode extends ManuscriptNode {
+  attrs: SubtitlesAttrs
+}
+
+export const subtitles: NodeSpec = {
+  content: 'subtitle*',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block sections',
+  selectable: false,
+  toDOM: (node) => {
+    const subtitlesNode = node as SubtitlesNode
+    return [
+      'section',
+      {
+        id: subtitlesNode.attrs.id,
+        class: 'subtitles',
+      },
+      0,
+    ]
+  },
+}
+
+export const isSubtitlesNode = (node: ManuscriptNode): node is SubtitlesNode =>
+  node.type === node.type.schema.nodes.subtitles

package/src/schema/nodes/supplement.ts

@@ -0,0 +1,77 @@
+/*!
+ * © 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 SupplementAttrs {
+  id: string
+  href: string
+  mimeType: string
+  mimeSubType: string
+}
+
+export interface SupplementNode extends ManuscriptNode {
+  attrs: SupplementAttrs
+}
+
+export const supplement: NodeSpec = {
+  content: 'caption_title caption',
+  attrs: {
+    id: { default: '' },
+    href: { default: '' },
+    mimeType: { default: '' },
+    mimeSubType: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'div.supplement',
+      getAttrs: (dom) => {
+        const el = dom as HTMLElement
+        const id = el.getAttribute('id')
+        const href = el.getAttribute('href')
+        const mimeType = el.getAttribute('mimeType')
+        const mimeSubType = el.getAttribute('mimeSubType')
+        const title = el.textContent
+        return {
+          id,
+          href,
+          mimeType,
+          mimeSubType,
+          title,
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const supplement = node as SupplementNode
+
+    return [
+      'div',
+      {
+        id: supplement.attrs.id,
+        class: 'Supplement',
+        href: node.attrs.href,
+        mimeType: node.attrs.mimeType,
+        mimeSubType: node.attrs.mimeSubType,
+        title: node.attrs.title,
+      },
+    ]
+  },
+}

package/src/schema/nodes/supplements.ts

@@ -0,0 +1,60 @@
+/*!
+ * © 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 SupplementsNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const supplements: NodeSpec = {
+  content: 'section_title supplement*',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'div.supplements',
+    },
+  ],
+  toDOM: (node) => {
+    const supplements = node as SupplementsNode
+
+    return [
+      'div',
+      {
+        id: supplements.attrs.id,
+        class: 'supplements',
+        spellcheck: 'false',
+        contenteditable: false,
+      },
+      0,
+    ]
+  },
+}
+
+export const isSupplementsNode = (
+  node: ManuscriptNode
+): node is SupplementsNode => node.type === node.type.schema.nodes.supplements

package/src/schema/nodes/table.ts

@@ -0,0 +1,144 @@
+/*!
+ * © 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 {
+  CellAttributes,
+  MutableAttrs,
+  TableNodes,
+  tableNodes as createTableNodes,
+  TableNodesOptions,
+} from 'prosemirror-tables'
+
+type getFromDOM = (dom: HTMLElement) => unknown
+type setDOMAttr = (value: unknown, attrs: MutableAttrs) => void
+
+function createCellAttribute(
+  attributeName: string,
+  defaultValue: unknown = null,
+  customGetFromDOM?: getFromDOM,
+  customSetDOMAttr?: setDOMAttr
+): CellAttributes {
+  return {
+    default: defaultValue,
+    getFromDOM(dom) {
+      if (customGetFromDOM) {
+        return customGetFromDOM(dom)
+      }
+      return dom.getAttribute(attributeName)
+    },
+    setDOMAttr(value, attrs) {
+      if (customSetDOMAttr) {
+        customSetDOMAttr(value, attrs)
+      } else if (value) {
+        attrs[attributeName] = value
+      }
+    },
+  }
+}
+
+const tableOptions: TableNodesOptions = {
+  cellContent: 'text_block+',
+  cellAttributes: {
+    placeholder: createCellAttribute(
+      'data-placeholder-text',
+      'Data',
+      (dom) => dom.getAttribute('data-placeholder-text') || ''
+    ),
+    valign: createCellAttribute('valign'),
+    align: createCellAttribute('align'),
+    scope: createCellAttribute('scope'),
+    style: createCellAttribute('style'),
+    colspan: createCellAttribute(
+      'colspan',
+      1,
+      (dom) => Number(dom.getAttribute('colspan') || 1),
+      (value, attrs) => {
+        if (value && value !== 1) {
+          attrs['colspan'] = String(value)
+        }
+      }
+    ),
+    rowspan: createCellAttribute(
+      'rowspan',
+      1,
+      (dom) => Number(dom.getAttribute('rowspan') || 1),
+      (value, attrs) => {
+        if (value && value !== 1) {
+          attrs['rowspan'] = String(value)
+        }
+      }
+    ),
+  },
+}
+
+const tableNodes: TableNodes = createTableNodes(tableOptions)
+
+// this is based on prsemirror-tables schema with our added attributes
+export const table: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  content: 'table_row+',
+  tableRole: 'table',
+  isolating: true,
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'table',
+      getAttrs: (p) => {
+        const dom = p as HTMLElement
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM(node) {
+    return [
+      'table',
+      {
+        id: node.attrs.id,
+      },
+      ['tbody', 0],
+    ]
+  },
+}
+export const tableRow: NodeSpec = {
+  ...tableNodes.table_row,
+  attrs: {
+    ...tableNodes.table_row.attrs,
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+}
+export const tableCell: NodeSpec = {
+  ...tableNodes.table_cell,
+  attrs: {
+    ...tableNodes.table_cell.attrs,
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+}
+export const tableHeader: NodeSpec = {
+  ...tableNodes.table_header,
+  attrs: {
+    ...tableNodes.table_header.attrs,
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+}

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