@manuscripts/transform 4.3.52 → 4.4.0

package/src/schema/nodes/inline_equation.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 {
+  id: string
+  contents: string
+  format: string
+}
+
+export interface InlineEquationNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const inlineEquation: NodeSpec = {
+  attrs: {
+    dataTracked: { default: null },
+    id: { default: '' },
+    contents: { default: '' },
+    format: { default: '' },
+  },
+  atom: true,
+  inline: true,
+  draggable: true,
+  group: 'inline',
+  parseDOM: [
+    {
+      tag: `span.MPInlineMathFragment`,
+      getAttrs: (p) => {
+        const dom = p as HTMLElement
+        return {
+          format: dom.getAttribute('data-equation-format'),
+          id: dom.getAttribute('id'),
+          contents: dom.innerHTML,
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const inlineEquationNode = node as InlineEquationNode
+    const { id, contents, format } = inlineEquationNode.attrs
+
+    const dom = document.createElement('span')
+    dom.setAttribute('id', id)
+    dom.classList.add('MPInlineMathFragment')
+    if (format) {
+      dom.setAttribute('data-equation-format', format)
+    }
+    dom.innerHTML = contents
+    return dom
+  },
+}

package/src/schema/nodes/inline_footnote.ts

@@ -0,0 +1,66 @@
+/*!
+ * © 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
+  rids: string[]
+}
+
+export interface InlineFootnoteNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const inlineFootnote: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    rids: { default: [] },
+    dataTracked: { default: null },
+  },
+  atom: true,
+  inline: true,
+  draggable: true,
+  group: 'inline',
+  parseDOM: [
+    {
+      tag: 'span.footnote-marker',
+      getAttrs: (p) => {
+        const dom = p as HTMLSpanElement
+        return {
+          id: dom.id,
+          rids: dom.getAttribute('data-reference-id')?.split(/\s+/) || [],
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const footnoteNode = node as InlineFootnoteNode
+    const dom = document.createElement('span')
+    dom.id = footnoteNode.attrs.id
+    dom.className = 'footnote-marker'
+    dom.setAttribute('data-reference-id', footnoteNode.attrs.rids.join(' '))
+
+    return dom
+  },
+}
+
+export const isInlineFootnoteNode = (
+  node: ManuscriptNode
+): node is InlineFootnoteNode =>
+  node.type === node.type.schema.nodes.inline_footnote

package/src/schema/nodes/keyword.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 KeywordNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const keyword: NodeSpec = {
+  atom: true,
+  content: 'inline*',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'span.keyword',
+      getAttrs: (node) => {
+        const dom = node as HTMLSpanElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const keywordNode = node as KeywordNode
+    return [
+      'span',
+      {
+        class: 'keyword',
+        id: keywordNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}

package/src/schema/nodes/keyword_group.ts

@@ -0,0 +1,63 @@
+/*!
+ * © 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
+  type: string
+}
+
+export interface KeywordGroupNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const keywordGroup: NodeSpec = {
+  content: 'keyword*',
+  attrs: {
+    id: { default: '' },
+    type: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'div.keywords',
+    },
+  ],
+  toDOM: (node) => {
+    const keywordGroupNode = node as KeywordGroupNode
+
+    return [
+      'div',
+      {
+        id: keywordGroupNode.attrs.id,
+        class: 'keywords',
+        spellcheck: 'false',
+        contenteditable: false,
+      },
+      0,
+    ]
+  },
+}
+
+export const isKeywordGroupNode = (
+  node: ManuscriptNode
+): node is KeywordGroupNode =>
+  node.type === node.type.schema.nodes.keywords_group

package/src/schema/nodes/keywords.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'
+
+interface Attrs {
+  id: string
+}
+
+export interface KeywordsNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const keywords: NodeSpec = {
+  content: 'section_title (keywords_element | placeholder_element)',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'div.keywords',
+    },
+  ],
+  toDOM: (node) => {
+    const keywords = node as KeywordsNode
+
+    return [
+      'div',
+      {
+        id: keywords.attrs.id,
+        class: 'keywords',
+        spellcheck: 'false',
+        contenteditable: false,
+      },
+      0,
+    ]
+  },
+}
+
+export const isKeywordsNode = (node: ManuscriptNode): node is KeywordsNode =>
+  node.type === node.type.schema.nodes.keywords

package/src/schema/nodes/keywords_element.ts

@@ -0,0 +1,64 @@
+/*!
+ * © 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
+}
+
+export interface KeywordsElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const keywordsElement: NodeSpec = {
+  atom: true,
+  content: 'keyword_group*',
+  attrs: {
+    id: { default: '' },
+    contents: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'div.manuscript-keywords',
+      getAttrs: (div) => {
+        const dom = div as HTMLDivElement
+
+        return {
+          contents: dom.innerHTML,
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const keywordsElementNode = node as KeywordsElementNode
+
+    return [
+      'div',
+      {
+        class: 'manuscript-keywords',
+        id: keywordsElementNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}

package/src/schema/nodes/link.ts

@@ -0,0 +1,79 @@
+/*!
+ * © 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 {
+  href: string
+  title?: string
+}
+
+export interface LinkNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const link: NodeSpec = {
+  content: 'inline*',
+  attrs: {
+    href: { default: '' },
+    title: { default: '' },
+    dataTracked: { default: null },
+  },
+  inline: true,
+  group: 'inline',
+  draggable: true,
+  atom: true,
+  parseDOM: [
+    {
+      tag: 'a[href]',
+      getAttrs: (a) => {
+        const dom = a as HTMLAnchorElement
+
+        return {
+          href: dom.getAttribute('href') || '',
+          title: dom.getAttribute('title') || '',
+        }
+      },
+    },
+    {
+      tag: 'span.citation[data-href]',
+      getAttrs: (span) => {
+        const dom = span as HTMLSpanElement
+
+        return {
+          href: dom.getAttribute('data-href') || '',
+        }
+      },
+      priority: 80,
+    },
+  ],
+  toDOM: (node) => {
+    const { href, title } = node.attrs
+
+    const attrs: { [key: string]: string } = { href }
+
+    if (title) {
+      attrs.title = title
+    }
+
+    return ['a', attrs, 0]
+  },
+}
+
+export const isLinkNode = (node: ManuscriptNode): node is LinkNode =>
+  node.type === node.type.schema.nodes.link

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