@manuscripts/transform 4.3.52 → 4.4.0

package/src/schema/nodes/author_notes.ts

@@ -0,0 +1,44 @@
+/*!
+ * © 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 AuthorNotesNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const authorNotes: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  content: 'section_title (corresp | footnote | paragraph)+',
+  group: 'block element',
+  toDOM: (node) => [
+    'div',
+    {
+      class: 'author-notes',
+      id: node.attrs.id,
+    },
+    0,
+  ],
+}

package/src/schema/nodes/award.ts

@@ -0,0 +1,52 @@
+/*!
+ * © 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'
+
+interface Attrs {
+  id: string
+  recipient: string
+  code: string
+  source: string
+}
+
+export interface AwardNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const award: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    recipient: { default: undefined },
+    code: { default: undefined },
+    source: { default: undefined },
+    dataTracked: { default: null },
+  },
+  toDOM: (node) => {
+    return [
+      'div',
+      {
+        class: 'award',
+        id: node.attrs.id,
+      },
+    ]
+  },
+}
+
+export const isAwardNode = (node: ManuscriptNode): node is AwardNode =>
+  node.type === node.type.schema.nodes.award

package/src/schema/nodes/awards.ts

@@ -0,0 +1,45 @@
+/*!
+ * © 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'
+
+interface Attrs {
+  id: string
+}
+
+export interface AwardsNode extends ManuscriptNode {
+  attrs: Attrs
+}
+export const awards: NodeSpec = {
+  content: 'award*',
+  attrs: {
+    id: { default: '' },
+  },
+  toDOM: (node) => {
+    return [
+      'div',
+      {
+        class: 'awards',
+        id: node.attrs.id,
+      },
+    ]
+  },
+}
+
+export const isAwardsNode = (node: ManuscriptNode): node is AwardsNode =>
+  node.type === node.type.schema.nodes.awards

package/src/schema/nodes/backmatter.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'
+
+// This node has no representation in json-schema
+// It exists for the purpose of styling in the UI
+
+export const backmatter: NodeSpec = {
+  content: 'sections*',
+  attrs: {
+    id: { default: '' },
+    placeholder: { default: ' ' },
+  },
+  group: 'block element',
+  parseDOM: [{ tag: 'div.backmatter' }],
+  toDOM: () => ['div', { class: 'backmatter' }, 0],
+}

package/src/schema/nodes/bibliography_element.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'
+
+interface Attrs {
+  id: string
+}
+
+export interface BibliographyElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const bibliographyElement: NodeSpec = {
+  content: 'bibliography_item*',
+  attrs: {
+    id: { default: '' },
+    contents: { default: '' },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block element',
+  parseDOM: [
+    {
+      tag: 'div.csl-bib-body',
+      getAttrs: () => {
+        return {
+          contents: '',
+        }
+      },
+    },
+  ],
+  toDOM: () => {
+    const dom = document.createElement('div')
+    dom.className = 'csl-bib-body'
+    return dom
+  },
+}
+
+export const isBibliographyElementNode = (
+  node: ManuscriptNode
+): node is BibliographyElementNode =>
+  node.type === node.type.schema.nodes.bibliography_element

package/src/schema/nodes/bibliography_item.ts

@@ -0,0 +1,108 @@
+/*!
+ * © 2022 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 BibliographyItemType =
+  | 'article-journal' //journal
+  | 'book'
+  | 'chapter'
+  | 'confproc'
+  | 'thesis'
+  | 'webpage'
+  | 'other'
+  | 'standard'
+  | 'dataset'
+  | 'preprint'
+  | 'literal'
+
+export interface BibliographyItemAttrs {
+  id: string
+  type: BibliographyItemType
+  author?: CSL.Person[]
+  issued?: CSL.Date
+  'container-title'?: string
+  volume?: string
+  issue?: string
+  supplement?: string
+  page?: string
+  title?: string
+  literal?: string
+  std?: string
+  'collection-title'?: string
+  edition?: string
+  'publisher-place'?: string
+  publisher?: string
+  event?: string
+  'event-place'?: string
+  'event-date'?: CSL.Date
+  institution?: string
+  editor?: CSL.Person[]
+  locator?: string
+  URL?: string
+  'number-of-pages'?: string
+  accessed?: CSL.Date // date-in-citation
+  DOI?: string
+  comment?: string
+}
+
+export interface BibliographyItemNode extends ManuscriptNode {
+  attrs: BibliographyItemAttrs
+}
+
+export const bibliographyItem: NodeSpec = {
+  // this is to help the prosemirror decoration to reach HTML of this node
+  attrs: {
+    id: { default: '' },
+    type: { default: undefined },
+    author: { default: undefined },
+    DOI: { default: undefined },
+    issued: { default: undefined },
+    'container-title': { default: undefined },
+    volume: { default: undefined },
+    issue: { default: undefined },
+    supplement: { default: undefined },
+    page: { default: undefined },
+    title: { default: undefined },
+    literal: { default: undefined },
+    std: { default: undefined },
+    'collection-title': { default: undefined },
+    edition: { default: undefined },
+    publisher: { default: undefined }, //publisher-name
+    'publisher-place': { default: undefined }, //publisher-loc
+    event: { default: undefined }, //conf-name
+    'event-place': { default: undefined }, //conf-loc
+    'event-date': { default: undefined }, //conf-date
+    institution: { default: undefined },
+    editor: { default: undefined },
+    locator: { default: undefined },
+    'number-of-pages': { default: undefined }, //size @unit=pages
+    pubIDs: { default: undefined },
+    accessed: { default: undefined },
+    URL: { default: undefined },
+    comment: { default: undefined },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block',
+}
+
+export const isBibliographyItemNode = (
+  node: ManuscriptNode
+): node is BibliographyItemNode =>
+  node.type === node.type.schema.nodes.bibliography_item

package/src/schema/nodes/bibliography_section.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 BibliographySectionNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const bibliographySection: NodeSpec = {
+  content: 'section_title bibliography_element',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block sections',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'section.bibliography',
+    },
+  ],
+  toDOM: (node) => {
+    const bibliographySectionNode = node as BibliographySectionNode
+
+    return [
+      'section',
+      {
+        id: bibliographySectionNode.attrs.id,
+        class: 'bibliography',
+        spellcheck: 'false',
+      },
+      0,
+    ]
+  },
+}
+
+export const isBibliographySectionNode = (
+  node: ManuscriptNode
+): node is BibliographySectionNode =>
+  node.type === node.type.schema.nodes.bibliography_section

package/src/schema/nodes/blockquote_element.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 {
+  id: string
+  placeholder: string
+}
+
+export interface BlockquoteElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const blockquoteElement: NodeSpec = {
+  content: 'text_block+ attribution',
+  attrs: {
+    id: { default: '' },
+    placeholder: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'blockquote',
+      getAttrs: (blockquote) => {
+        const dom = blockquote as HTMLQuoteElement
+
+        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 blockquoteElementNode = node as BlockquoteElementNode
+
+    const attrs: { [key: string]: string } = {}
+
+    if (blockquoteElementNode.attrs.id) {
+      attrs.id = blockquoteElementNode.attrs.id
+    }
+
+    if (blockquoteElementNode.attrs.placeholder) {
+      attrs['data-placeholder-text'] = blockquoteElementNode.attrs.placeholder
+    }
+
+    return ['blockquote', attrs, 0]
+  },
+}
+
+export const isBlockquoteElement = (
+  node: ManuscriptNode
+): node is BlockquoteElementNode =>
+  node.type === node.type.schema.nodes.blockquote_element

package/src/schema/nodes/body.ts

@@ -0,0 +1,29 @@
+/*!
+ * © 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'
+
+// This node has no representation in json-schema
+// It exists for the purpose of styling in the UI
+
+export const body: NodeSpec = {
+  content: 'element* sections*',
+  attrs: {
+    id: { default: '' },
+  },
+  group: 'block',
+  toDOM: () => ['div', { class: 'body' }, 0],
+}

package/src/schema/nodes/box_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 BoxElementAttrs {
+  id: string
+}
+
+export interface BoxElementNode extends ManuscriptNode {
+  attrs: BoxElementAttrs
+}
+
+export const box_element: NodeSpec = {
+  content: 'caption_title? caption? section?',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'div.boxed-text',
+      getAttrs: (p) => {
+        const dom = p as HTMLParagraphElement
+
+        const attrs: Partial<BoxElementAttrs> = {
+          id: dom.getAttribute('id') || undefined,
+        }
+        return attrs
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const boxElementNode = node as BoxElementNode
+
+    const attrs: { [key: string]: string } = {}
+
+    if (boxElementNode.attrs.id) {
+      attrs.id = boxElementNode.attrs.id
+    }
+
+    return [
+      'div',
+      {
+        class: 'boxed-text',
+        ...attrs,
+      },
+    ]
+  },
+}

package/src/schema/nodes/caption.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'
+
+interface Attrs {
+  placeholder: string
+}
+
+export interface CaptionNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const caption: NodeSpec = {
+  content: 'text_block+',
+  attrs: {
+    placeholder: { default: 'Caption...' },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  isolating: true,
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'p',
+      getAttrs: (node) => {
+        const dom = node as HTMLParagraphElement
+
+        return {
+          placeholder: dom.getAttribute('data-placeholder-text'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const captionNode = node as CaptionNode
+
+    const attrs: { [key: string]: string } = {}
+
+    attrs.class = 'caption-description'
+
+    if (captionNode.attrs.placeholder) {
+      attrs['data-placeholder-text'] = captionNode.attrs.placeholder
+    }
+
+    if (!captionNode.textContent) {
+      attrs.class = `${attrs.class} placeholder`
+    }
+
+    return ['p', attrs, 0]
+  },
+}