@manuscripts/transform 4.3.52 → 4.4.0

package/src/schema/nodes/caption_title.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 CaptionTitleNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const captionTitle: NodeSpec = {
+  content: 'inline*',
+  group: 'block',
+  selectable: false,
+  isolating: true,
+  attrs: {
+    placeholder: { default: 'Title...' },
+    dataTracked: { default: null },
+  },
+  parseDOM: [
+    {
+      tag: 'label',
+      getAttrs: (node) => {
+        const dom = node as HTMLSpanElement
+
+        return {
+          placeholder: dom.getAttribute('data-placeholder-text'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const captionTitleNode = node as CaptionTitleNode
+
+    const attrs: { [key: string]: string } = {}
+
+    attrs.class = 'caption-title'
+
+    if (captionTitleNode.attrs.placeholder) {
+      attrs['data-placeholder-text'] = captionTitleNode.attrs.placeholder
+    }
+
+    if (!captionTitleNode.textContent) {
+      attrs.class = `${attrs.class} placeholder`
+    }
+
+    return ['label', attrs, 0]
+  },
+}

package/src/schema/nodes/citation.ts

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

package/src/schema/nodes/comment.ts

@@ -0,0 +1,50 @@
+/*!
+ * © 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 CommentAttrs {
+  id: string
+  contents: string
+  target: string
+  selector: { from: number; to: number }
+  resolved?: boolean
+  userID: string
+  timestamp: number
+  originalText?: string
+}
+
+export interface CommentNode extends ManuscriptNode {
+  attrs: CommentAttrs
+}
+
+export const comment: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    contents: { default: '' },
+    target: { default: '' },
+    selector: { default: undefined },
+    resolved: { default: false },
+    userID: { default: '' },
+    timestamp: { default: 0 },
+    originalText: { default: '' },
+  },
+}
+
+export const isCommentNode = (node: ManuscriptNode): node is CommentNode =>
+  node.type === node.type.schema.nodes.comment

package/src/schema/nodes/comments.ts

@@ -0,0 +1,28 @@
+/*!
+ * © 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 comments: NodeSpec = {
+  content: 'comment*',
+  attrs: {
+    id: { default: '' },
+  },
+  toDOM: () => ['div', { class: 'comments' }, 0],
+}

package/src/schema/nodes/contributor.ts

@@ -0,0 +1,87 @@
+/*!
+ * © 2023 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 { CreditVocabTerm } from '../../lib/credit-roles'
+import { ManuscriptNode } from '../types'
+
+export type CreditRole = {
+  vocabTerm: CreditVocabTerm
+}
+
+export interface ContributorAttrs {
+  id: string
+  role: string
+  correspIDs: string[]
+  affiliationIDs: string[]
+  footnoteIDs: string[]
+  given?: string
+  family?: string
+  prefix?: string
+  suffix?: string
+  email?: string
+  ORCID?: string
+  degrees: string[]
+  isAuthenticated?: boolean
+  isCorresponding: boolean
+  priority: number
+  isJointContributor: boolean
+  creditRoles?: CreditRole[]
+}
+
+export interface ContributorNode extends ManuscriptNode {
+  attrs: ContributorAttrs
+}
+
+export const contributor: NodeSpec = {
+  content: 'inline*',
+  atom: true,
+  attrs: {
+    id: { default: '' },
+    role: { default: '' },
+    correspIDs: { default: [] },
+    affiliationIDs: { default: [] },
+    footnoteIDs: { default: [] },
+    given: { default: undefined },
+    family: { default: undefined },
+    prefix: { default: undefined },
+    suffix: { default: undefined },
+    degrees: { default: [] },
+    email: { default: undefined },
+    ORCID: { default: undefined },
+    isAuthenticated: { default: false },
+    isCorresponding: { default: false },
+    isJointContributor: { default: false },
+    priority: { default: undefined },
+    creditRoles: { default: [] },
+    dataTracked: { default: null },
+    contents: { default: '' },
+  },
+  group: 'block',
+  toDOM: (node) => {
+    const contributorNode = node as ContributorNode
+    return [
+      'div',
+      {
+        class: 'contributor',
+        id: contributorNode.attrs.id,
+      },
+    ]
+  },
+}
+export const isContributorNode = (
+  node: ManuscriptNode
+): node is ContributorNode => node.type === node.type.schema.nodes.contributor

package/src/schema/nodes/contributors.ts

@@ -0,0 +1,40 @@
+/*!
+ * © 2023 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'
+
+// This node has no representation in json-schema
+// It exists for the purpose of styling in the UI
+
+interface Attrs {
+  id: string
+}
+
+export interface ContributorsNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const contributors: NodeSpec = {
+  content: 'contributor*',
+  attrs: {
+    id: { default: '' },
+  },
+  group: 'block',
+  selectable: false,
+  toDOM: () => ['div', { class: 'contributors' }, 0],
+}

package/src/schema/nodes/core_section.ts

@@ -0,0 +1,27 @@
+/*!
+ * © 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'
+
+export const coreSection: NodeSpec = {
+  content: 'sections*',
+  atom: true,
+  attrs: {
+    id: { default: '' },
+  },
+  group: 'block',
+  toDOM: () => ['section', 0],
+}

package/src/schema/nodes/corresp.ts

@@ -0,0 +1,49 @@
+/*!
+ * © 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
+  label?: string
+}
+
+export interface CorrespNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const corresp: NodeSpec = {
+  content: 'inline*',
+  attrs: {
+    id: { default: '' },
+    label: { default: undefined },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  toDOM: (node) => {
+    return [
+      'div',
+      {
+        class: 'corresp',
+        id: node.attrs.id,
+      },
+      0,
+    ]
+  },
+}
+export const isCorrespNode = (node: ManuscriptNode): node is CorrespNode =>
+  node.type === node.type.schema.nodes.corresp

package/src/schema/nodes/cross_reference.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 {
+  rids: string[]
+  label: string
+}
+
+export interface CrossReferenceNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const crossReference: NodeSpec = {
+  inline: true,
+  group: 'inline',
+  draggable: true,
+  atom: true,
+  attrs: {
+    rids: { default: [] },
+    label: { default: '' },
+    dataTracked: { default: null },
+  },
+  parseDOM: [
+    {
+      tag: 'span.cross-reference',
+      getAttrs: (p) => {
+        const dom = p as HTMLSpanElement
+
+        return {
+          rids: dom.getAttribute('data-reference-id')?.split(/\s+/) || [],
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const crossReferenceNode = node as CrossReferenceNode
+
+    return [
+      'span',
+      {
+        class: 'cross-reference',
+        'data-reference-id': crossReferenceNode.attrs.rids.join(' '),
+      },
+      crossReferenceNode.attrs.label,
+    ]
+  },
+}

package/src/schema/nodes/doc.ts

@@ -0,0 +1,21 @@
+/*!
+ * © 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'
+
+export const doc: NodeSpec = {
+  content: 'manuscript',
+}

package/src/schema/nodes/embed.ts

@@ -0,0 +1,55 @@
+/*!
+ * © 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'
+
+export interface EmbedAttrs {
+  id: string
+  href: string
+  mimetype: string
+  mimeSubtype: string
+}
+
+export interface EmbedNode extends ManuscriptNode {
+  attrs: EmbedAttrs
+}
+
+export const embed: NodeSpec = {
+  content: 'caption_title caption alt_text long_desc',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+    href: { default: undefined },
+    mimetype: { default: undefined },
+    mimeSubtype: { default: undefined },
+    longDesc: { default: '' },
+  },
+  group: 'block element',
+  toDOM: (node) => {
+    return [
+      'div',
+      {
+        class: 'embed',
+        id: node.attrs.id,
+      },
+    ]
+  },
+}
+
+export const isEmbedNode = (node: ManuscriptNode): node is EmbedNode =>
+  node.type === node.type.schema.nodes.embed

package/src/schema/nodes/equation.ts

@@ -0,0 +1,65 @@
+/*!
+ * © 2023 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
+  format: string
+  contents: string
+}
+
+export interface EquationNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const equation: NodeSpec = {
+  attrs: {
+    id: { default: '' },
+    contents: { default: '' },
+    format: { default: '' },
+    dataTracked: { default: null },
+  },
+  group: 'block',
+  parseDOM: [
+    {
+      tag: `div.MPEquation`,
+      getAttrs: (p) => {
+        const htmlEl = p as HTMLElement
+        return {
+          id: htmlEl.getAttribute('id'),
+          format: htmlEl.getAttribute('data-equation-format'),
+          contents: htmlEl.innerHTML,
+        }
+      },
+    },
+  ],
+  toDOM: (node: ManuscriptNode) => {
+    const equationNode = node as EquationNode
+    const { id, contents, format } = equationNode.attrs
+
+    const dom = document.createElement('div')
+    dom.setAttribute('id', id)
+    if (format) {
+      dom.setAttribute('data-equation-format', format)
+    }
+    dom.innerHTML = contents
+
+    return dom
+  },
+}

package/src/schema/nodes/equation_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 EquationElementNode extends ManuscriptNode {
+  attrs: Attrs
+}
+
+export const equationElement: NodeSpec = {
+  content: '(equation | placeholder)',
+  attrs: {
+    id: { default: '' },
+    dataTracked: { default: null },
+  },
+  selectable: false,
+  group: 'block element',
+  parseDOM: [
+    {
+      tag: 'div.equation',
+      getAttrs: (p) => {
+        const dom = p as HTMLElement
+
+        return {
+          id: dom.getAttribute('id'),
+        }
+      },
+    },
+  ],
+  toDOM: (node) => {
+    const equationElementNode = node as EquationElementNode
+
+    return [
+      'div',
+      {
+        class: 'equation',
+        id: equationElementNode.attrs.id,
+      },
+      0,
+    ]
+  },
+}