@manuscripts/transform 4.3.53 → 4.4.1

package/src/schema/nodes/list.ts

@@ -0,0 +1,134 @@
+/*!
+ * © 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 type ListStyleType =
+  | 'simple'
+  | 'bullet'
+  | 'order'
+  | 'alpha-lower'
+  | 'alpha-upper'
+  | 'roman-lower'
+  | 'roman-upper'
+
+export interface ListAttrs {
+  id: string
+  listStyleType: ListStyleType
+}
+
+export interface ListNode extends ManuscriptNode {
+  attrs: ListAttrs
+}
+
+export const list: NodeSpec = {
+  content: 'list_item+',
+  group: 'block list element',
+  attrs: {
+    id: { default: '' },
+    listStyleType: { default: null },
+    dataTracked: { default: null },
+  },
+  parseDOM: [
+    {
+      tag: 'ul',
+      getAttrs: (p) => {
+        const dom = p as HTMLUListElement
+
+        return {
+          id: dom.getAttribute('id'),
+          listStyleType: dom.getAttribute('list-type'),
+        }
+      },
+    },
+    {
+      tag: 'ol',
+      getAttrs: (p) => {
+        const dom = p as HTMLOListElement
+
+        return {
+          id: dom.getAttribute('id'),
+          listStyleType: dom.getAttribute('list-type'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const list = node as ListNode
+    return [
+      'ul',
+      {
+        id: list.attrs.id,
+        'list-type': list.attrs.listStyleType,
+      },
+      0,
+    ]
+  },
+}
+
+export interface ListItemNode extends ManuscriptNode {
+  attrs: {
+    placeholder: string
+    id: string
+  }
+}
+
+export const listItem: NodeSpec = {
+  // NOTE: can't mix inline (text) and block content (list)
+  // content: 'paragraph list+',
+  content: 'paragraph? (paragraph | list)+',
+  group: 'block',
+  defining: true,
+  attrs: {
+    placeholder: { default: 'List item' },
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  parseDOM: [
+    {
+      tag: 'li',
+      getAttrs: (p) => {
+        const dom = p as HTMLLIElement
+
+        return {
+          placeholder: dom.getAttribute('data-placeholder-text') || '',
+          id: dom.getAttribute('id') || '',
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const listItemNode = node as ListItemNode
+
+    const attrs: { [key: string]: string } = {}
+
+    if (listItemNode.attrs.placeholder) {
+      attrs['data-placeholder-text'] = listItemNode.attrs.placeholder
+    }
+    if (listItemNode.attrs.id) {
+      attrs['id'] = listItemNode.attrs.id
+    }
+
+    return ['li', attrs, 0]
+  },
+}
+
+export const isListNode = (node: ManuscriptNode): node is ListNode => {
+  const { nodes } = node.type.schema
+
+  return node.type === nodes.list
+}

package/src/schema/nodes/listing.ts

@@ -0,0 +1,91 @@
+/*!
+ * © 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
+  contents: string
+  language: string
+  languageKey: string
+  isExpanded: boolean
+  isExecuting: boolean
+}
+
+export interface ListingNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const listing: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    contents: { default: '' },
+    language: { default: '' },
+    languageKey: { default: 'null' },
+    isExpanded: { default: false },
+    isExecuting: { default: false },
+    // placeholder: { default: 'Click to edit listing' },
+    dataTracked: { default: null },
+  },
+  draggable: false,
+  selectable: false,
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'pre.MPListing',
+      preserveWhitespace: 'full',
+      getAttrs: (p) => {
+        const node = p as HTMLPreElement
+
+        return {
+          contents: node.textContent, // TODO: innerText?
+          language: node.getAttribute('language'),
+          languageKey: node.getAttribute('languageKey'),
+        }
+      },
+      priority: 100,
+    },
+    {
+      tag: 'pre',
+      preserveWhitespace: 'full',
+      getAttrs: (p) => {
+        const node = p as HTMLPreElement
+
+        return {
+          contents: node.getAttribute('code') || node.textContent,
+          languageKey: node.getAttribute('language'),
+        }
+      },
+      priority: 90,
+    },
+  ],
+  toDOM: (node) => {
+    const listingNode = node as ListingNode
+
+    const dom = document.createElement('div')
+    dom.setAttribute('id', listingNode.attrs.id)
+    dom.setAttribute('data-language', listingNode.attrs.language)
+    dom.setAttribute('data-languageKey', listingNode.attrs.languageKey)
+    dom.textContent = listingNode.attrs.contents
+
+    return dom
+  },
+}
+
+export const isListingNode = (node: ManuscriptNode): node is ListingNode =>
+  node.type === node.type.schema.nodes.listing

package/src/schema/nodes/listing_element.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
+}
+
+export interface ListingElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const listingElement: NodeSpec = {
+  content: '(listing | placeholder) caption_title caption',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'figure.listing',
+      getAttrs: (p) => {
+        const dom = p as HTMLElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const listingElementNode = node as ListingElementNode
+
+    return [
+      'figure',
+      {
+        class: 'listing', // TODO: suppress-caption?
+        id: listingElementNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}

package/src/schema/nodes/long_desc.ts

@@ -0,0 +1,36 @@
+/*!
+ * © 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 type { NodeSpec } from 'prosemirror-model'
+
+import type { ManuscriptNode } from '../types'
+
+export interface LongDescAttrs {
+  id: string
+}
+
+export interface LongDescNode extends ManuscriptNode {
+  attrs: LongDescAttrs
+}
+
+export const longDesc: NodeSpec = {
+  content: 'text*',
+  attrs: {
+    id: { default: '' },
+  },
+  parseDOM: [{ tag: 'div' }],
+  toDOM: () => ['div', 0],
+}

package/src/schema/nodes/manuscript.ts

@@ -0,0 +1,86 @@
+/*!
+ * © 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 ActualManuscriptNode extends ManuscriptNode {
+  attrs: ManuscriptAttrs
+}
+
+export interface ManuscriptAttrs {
+  id: string
+  doi: string
+  articleType: string
+  prototype: string
+  primaryLanguageCode: string
+  acceptanceDate?: number
+  correctionDate?: number
+  retractionDate?: number
+  revisionRequestDate?: number
+  revisionReceiveDate?: number
+  receiveDate?: number
+}
+
+// The direct children of this node do not have a json-schema representation
+// They exist for the purpose of styling in the UI
+
+export const manuscript: NodeSpec = {
+  content:
+    'title subtitles? alt_titles? contributors? affiliations? author_notes? awards? keywords? abstracts body backmatter supplements? hero_image? comments attachments?',
+  attrs: {
+    id: { default: '' },
+    doi: { default: '' },
+    prototype: { default: '' },
+    primaryLanguageCode: { default: '' },
+    articleType: { default: '' },
+    acceptanceDate: { default: undefined },
+    correctionDate: { default: undefined },
+    retractionDate: { default: undefined },
+    revisionRequestDate: { default: undefined },
+    revisionReceiveDate: { default: undefined },
+    receiveDate: { default: undefined },
+  },
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'article',
+      getAttrs: (p) => {
+        const dom = p as HTMLElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const manuscriptNode = node as ActualManuscriptNode
+
+    return [
+      'article',
+      {
+        id: manuscriptNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}
+
+export const isManuscriptNode = (
+  node: ManuscriptNode
+): node is ManuscriptNode => node.type === node.type.schema.nodes.manuscript

package/src/schema/nodes/missing_figure.ts

@@ -0,0 +1,59 @@
+/*!
+ * © 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 MissingFigureNode extends ManuscriptNode {
+  attrs: {
+    id: string
+  }
+}
+
+export const missingFigure: NodeSpec = {
+  attrs: {
+    id: { 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'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const missingFigureNode = node as MissingFigureNode
+
+    return [
+      'figure',
+      {
+        class: 'figure',
+        id: missingFigureNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}

package/src/schema/nodes/paragraph.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'
+
+interface Attrs {
+  id: string
+  placeholder: string
+}
+
+export interface ParagraphNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const paragraph: NodeSpec = {
+  content: 'inline*',
+  attrs: {
+    id: { default: '' },
+    placeholder: { default: '' }, // TODO: 'List item' if inside a list
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'p',
+      getAttrs: (p) => {
+        const dom = p as HTMLParagraphElement
+
+        const attrs: Partial<Attrs> = {
+          id: dom.getAttribute('id') || undefined,
+        }
+
+        const placeholder = dom.getAttribute('data-placeholder-text')
+
+        if (placeholder) {
+          attrs.placeholder = placeholder
+        }
+
+        return attrs
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const paragraphNode = node as ParagraphNode
+
+    const attrs: { [key: string]: string } = {}
+
+    if (paragraphNode.attrs.id) {
+      attrs.id = paragraphNode.attrs.id
+    }
+
+    if (paragraphNode.attrs.placeholder) {
+      attrs['data-placeholder-text'] = paragraphNode.attrs.placeholder
+    }
+
+    return ['p', attrs, 0]
+  },
+}
+
+export const isParagraphNode = (node: ManuscriptNode): node is ParagraphNode =>
+  node.type === node.type.schema.nodes.paragraph

package/src/schema/nodes/placeholder.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'
+
+interface Attrs {
+  id: string
+  label: string
+}
+
+export interface PlaceholderNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const placeholder: NodeSpec = {
+  atom: true,
+  selectable: false,
+  attrs: {
+    id: { default: '' },
+    label: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'div.placeholder',
+      getAttrs: (p) => {
+        const dom = p as HTMLDivElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const placeholderNode = node as PlaceholderNode
+
+    return [
+      'div',
+      {
+        class: 'placeholder-item',
+        id: placeholderNode.attrs.id,
+      },
+    ]
+  },
+}

package/src/schema/nodes/placeholder_element.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 PlaceholderElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const placeholderElement: NodeSpec = {
+  atom: true,
+  selectable: false,
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  parseDOM: [
+    {
+      tag: 'div.placeholder-element',
+      getAttrs: (p) => {
+        const dom = p as HTMLDivElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const placeholderElementNode = node as PlaceholderElementNode
+
+    return [
+      'div',
+      {
+        class: 'placeholder-element',
+        id: placeholderElementNode.attrs.id,
+      },
+    ]
+  },
+}