@manuscripts/transform 4.3.53 → 4.4.0

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,
+      },
+    ]
+  },
+}

package/src/schema/nodes/pullquote_element.ts

@@ -0,0 +1,81 @@
+/*!
+ * © 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 PullquoteElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const pullquoteElement: NodeSpec = {
+  content: 'quote_image? text_block+ attribution',
+  attrs: {
+    id: { default: '' },
+    placeholder: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block element',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'aside.pullquote',
+      getAttrs: (aside) => {
+        const dom = aside as HTMLElement
+
+        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 pullquoteElementNode = node as PullquoteElementNode
+
+    const attrs: { [key: string]: string } = {}
+
+    if (pullquoteElementNode.attrs.id) {
+      attrs.id = pullquoteElementNode.attrs.id
+    }
+
+    attrs.class = 'pullquote'
+
+    if (pullquoteElementNode.attrs.placeholder) {
+      attrs['data-placeholder-text'] = pullquoteElementNode.attrs.placeholder
+    }
+
+    return ['aside', attrs, 0]
+  },
+}
+
+export const isPullquoteElement = (
+  node: ManuscriptNode
+): node is PullquoteElementNode =>
+  node.type === node.type.schema.nodes.pullquote_element

package/src/schema/nodes/quote_image.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'
+
+export interface QuoteImageAttrs {
+  id: string
+  src: string
+  type: string
+}
+
+export interface QuoteImageNode extends ManuscriptNode {
+  attrs: QuoteImageAttrs
+}
+
+export const quoteImage: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    src: { default: '' },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block',
+  parseDOM: [
+    {
+      tag: 'figure',
+      context: 'pullquote_element/',
+      getAttrs: (dom) => {
+        const element = dom as HTMLElement
+
+        return {
+          id: element.getAttribute('id'),
+          src: element.getAttribute('src'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const imageNode = node as QuoteImageNode
+
+    return [
+      'figure',
+      {
+        class: 'pullquote-figure',
+        id: imageNode.attrs.id,
+      },
+    ]
+  },
+}

package/src/schema/nodes/section.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
+  category: string
+}
+
+export interface SectionNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const section: NodeSpec = {
+  // NOTE: the schema needs paragraphs to be the default type, so they must explicitly come first
+  content: 'section_label? section_title (paragraph | element)* sections*',
+  attrs: {
+    id: { default: '' },
+    category: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block sections',
+  selectable: false,
+  parseDOM: [
+    {
+      tag: 'section',
+      getAttrs: (dom) => {
+        const element = dom as HTMLElement
+
+        return {
+          id: element.getAttribute('id') || '',
+          category: element.getAttribute('data-category') || '',
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const sectionNode = node as SectionNode
+
+    const { id, category } = sectionNode.attrs
+
+    const attrs: { [key: string]: string } = { id }
+
+    if (category) {
+      attrs['data-category'] = node.attrs.category
+    }
+
+    return ['section', attrs, 0]
+  },
+}
+
+export const isSectionNode = (node: ManuscriptNode): node is SectionNode =>
+  node.type === node.type.schema.nodes.section

package/src/schema/nodes/section_label.ts

@@ -0,0 +1,39 @@
+/*!
+ * © 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 SectionLabelNode extends ManuscriptNode {
+  attrs: Record<string, unknown>
+}
+
+export const sectionLabel: NodeSpec = {
+  content: 'inline*',
+  group: 'block',
+  attrs: { dataTracked: { default: null } },
+  selectable: false,
+  parseDOM: [{ tag: 'label' }],
+  toDOM() {
+    return ['label', 0]
+  },
+}
+
+export const isSectionLabelNode = (
+  node: ManuscriptNode
+): node is SectionLabelNode =>
+  node.type === node.type.schema.nodes.section_label