@manuscripts/transform 4.3.33 → 4.3.34

package/dist/cjs/jats/exporter/jats-exporter.js

@@ -168,6 +168,21 @@ class JATSExporter {
                 element.appendChild(this.serializeNode(childNode));
             }
         };
+        this.appendChildrenNodeOfType = (element, node, type) => {
+            const children = this.getChildrenOfType(type, node);
+            children.map((childNode) => element.appendChild(this.serializeNode(childNode)));
+        };
+        this.appendCaption = (element, node) => {
+            const caption = this.createElement('caption');
+            this.appendChildNodeOfType(caption, node, schema_1.schema.nodes.caption_title);
+            const captionNode = this.getChildrenOfType(schema_1.schema.nodes.caption, node)[0];
+            if (captionNode && captionNode.content.size > 2) {
+                this.appendChildrenNodeOfType(caption, captionNode, schema_1.schema.nodes.text_block);
+            }
+            if (caption.children.length > 0) {
+                element.appendChild(caption);
+            }
+        };
         this.initCiteprocEngine = (csl) => {
             const bibitems = new Map();
             const citations = new Map();
@@ -286,7 +301,7 @@ class JATSExporter {
                 supplementaryMaterial.setAttributeNS(xml_1.XLINK_NAMESPACE, 'href', node.attrs.href ?? '');
                 supplementaryMaterial.setAttribute('mimetype', node.attrs.mimeType ?? '');
                 supplementaryMaterial.setAttribute('mime-subtype', node.attrs.mimeSubType ?? '');
-                this.appendChildNodeOfType(supplementaryMaterial, node, schema_1.schema.nodes.figcaption);
+                this.appendCaption(supplementaryMaterial, node);
                 articleMeta.append(supplementaryMaterial);
             });
             const history = articleMeta.querySelector('history') || this.createElement('history');
@@ -495,7 +510,7 @@ class JATSExporter {
                     appendLabels(mediaElement, node);
                     this.appendChildNodeOfType(mediaElement, node, schema_1.schema.nodes.alt_text);
                     this.appendChildNodeOfType(mediaElement, node, schema_1.schema.nodes.long_desc);
-                    this.appendChildNodeOfType(mediaElement, node, schema_1.schema.nodes.figcaption);
+                    this.appendCaption(mediaElement, node);
                     return mediaElement;
                 },
                 awards: () => ['funding-group', 0],
@@ -610,15 +625,10 @@ class JATSExporter {
                 equation_element: (node) => {
                     const eqElement = this.createElement('disp-formula');
                     eqElement.setAttribute('id', normalizeID(node.attrs.id));
+                    appendLabels(eqElement, node);
                     processChildNodes(eqElement, node, schema_1.schema.nodes.equation);
                     return eqElement;
                 },
-                figcaption: (node) => {
-                    if (!node.textContent) {
-                        return '';
-                    }
-                    return ['caption', 0];
-                },
                 figure: (node) => createGraphic(node),
                 figure_element: (node) => createFigureElement(node, node.type.schema.nodes.figure),
                 footnote: (node) => {
@@ -862,8 +872,8 @@ class JATSExporter {
                 const element = createElement(node, 'boxed-text');
                 appendLabels(element, node);
                 const child = node.firstChild;
-                if (child?.type === schema_1.schema.nodes.figcaption) {
-                    this.appendChildNodeOfType(element, node, node.type.schema.nodes.figcaption);
+                if (child?.type === schema_1.schema.nodes.caption_title) {
+                    this.appendCaption(element, node);
                 }
                 processChildNodes(element, node, node.type.schema.nodes.section);
                 return element;
@@ -885,6 +895,7 @@ class JATSExporter {
                     const extLink = this.appendElement(graphicElement, 'ext-link');
                     extLink.setAttributeNS(xml_1.XLINK_NAMESPACE, 'href', node.attrs.extLink);
                 }
+                this.appendCaption(graphicElement, node);
                 this.appendChildNodeOfType(graphicElement, node, schema_1.schema.nodes.alt_text);
                 this.appendChildNodeOfType(graphicElement, node, schema_1.schema.nodes.long_desc);
                 return graphicElement;
@@ -909,7 +920,7 @@ class JATSExporter {
                     element.setAttribute('fig-type', figType);
                 }
                 appendLabels(element, node);
-                this.appendChildNodeOfType(element, node, node.type.schema.nodes.figcaption);
+                this.appendCaption(element, node);
                 this.appendChildNodeOfType(element, node, schema_1.schema.nodes.alt_text);
                 this.appendChildNodeOfType(element, node, schema_1.schema.nodes.long_desc);
                 this.appendChildNodeOfType(element, node, node.type.schema.nodes.footnotes_element);
@@ -943,7 +954,7 @@ class JATSExporter {
                 const nodeName = 'table-wrap';
                 const element = createElement(node, nodeName);
                 appendLabels(element, node);
-                this.appendChildNodeOfType(element, node, schema_1.schema.nodes.figcaption);
+                this.appendCaption(element, node);
                 this.appendChildNodeOfType(element, node, schema_1.schema.nodes.alt_text);
                 this.appendChildNodeOfType(element, node, schema_1.schema.nodes.long_desc);
                 appendTable(element, node);

package/dist/cjs/jats/exporter/labels.js

@@ -52,7 +52,7 @@ const buildTargets = (iterator) => {
             }
             if (node.type === schema_1.schema.nodes.box_element) {
                 const child = node.firstChild;
-                if (!child || child.type !== schema_1.schema.nodes.figcaption) {
+                if (!child || child.type !== schema_1.schema.nodes.caption_title) {
                     return;
                 }
             }

package/dist/cjs/jats/importer/jats-dom-parser.js

@@ -160,6 +160,11 @@ class JATSDOMParser {
             }
             return prosemirror_model_1.Fragment.from(content);
         };
+        this.getCaptionContent = (node) => {
+            const element = node;
+            const content = Array.from(element.querySelectorAll('p')).map((paragraph) => this.parse(paragraph, { topNode: this.schema.nodes.text_block.create() }));
+            return prosemirror_model_1.Fragment.from(content.length > 0 ? content : this.schema.nodes.text_block.create());
+        };
         this.parseRefPages = (element) => {
             const fpage = (0, utils_1.getTrimmedTextContent)(element, 'fpage');
             const lpage = (0, utils_1.getTrimmedTextContent)(element, 'lpage');
@@ -458,41 +463,34 @@ class JATSDOMParser {
                 node: 'hard_break',
             },
             {
-                tag: 'caption',
-                node: 'figcaption',
-                context: 'figure/',
+                tag: 'caption > p',
+                context: 'table_element/',
+                ignore: true,
+            },
+            {
+                tag: 'caption > title',
+                node: 'caption_title',
             },
             {
                 tag: 'caption',
-                node: 'figcaption',
-                context: 'figure_element/|table_element/|embed/|supplement/|box_element/',
-                getContent: (node, schema) => {
-                    const element = node;
-                    const content = [];
-                    const title = element.querySelector('title');
-                    if (title) {
-                        const captionTitle = schema.nodes.caption_title.create();
-                        content.push(this.parse(title, { topNode: captionTitle }));
-                    }
-                    const paragraphs = element.querySelectorAll('p');
-                    if (paragraphs.length) {
-                        const figcaption = schema.nodes.caption.create();
-                        for (const paragraph of paragraphs) {
-                            content.push(this.parse(paragraph, { topNode: figcaption }));
-                        }
-                    }
-                    return prosemirror_model_1.Fragment.from(content);
-                },
+                node: 'caption',
+                context: 'image_element/|figure_element/',
+                getContent: this.getCaptionContent,
             },
             {
                 tag: 'caption',
-                node: 'figcaption',
-                context: 'box_element/',
-                getAttrs: (node) => {
+                node: 'caption',
+                context: 'listing_element/|embed/|supplement/',
+                getContent: (node) => {
                     const element = node;
-                    return {
-                        id: element.getAttribute('id'),
-                    };
+                    const title = element.querySelector('title');
+                    const caption_title = title
+                        ? this.parse(title, {
+                            topNode: this.schema.nodes.caption_title.create(),
+                        })
+                        : this.schema.nodes.caption_title.create();
+                    const caption = this.schema.nodes.caption.create(undefined, this.getCaptionContent(node));
+                    return prosemirror_model_1.Fragment.from([caption_title, caption]);
                 },
             },
             {
@@ -627,7 +625,12 @@ class JATSDOMParser {
             {
                 tag: 'graphic',
                 node: 'image_element',
-                getContent: this.getFigContent,
+                getContent: (node) => {
+                    const element = node;
+                    const caption = this.schema.nodes.caption.create(undefined, this.getCaptionContent(node));
+                    const fig = this.getFigContent(element).content;
+                    return prosemirror_model_1.Fragment.from([...fig.slice(0, 1), caption, ...fig.slice(1)]);
+                },
                 getAttrs: this.getFigAttrs,
             },
             {
@@ -921,11 +924,6 @@ class JATSDOMParser {
                 node: 'section_title',
                 context: 'section/|footnotes_section/|bibliography_section/|keywords/|supplements/|author_notes/|graphical_abstract_section/|trans_abstract/|trans_graphical_abstract/',
             },
-            {
-                tag: 'title',
-                node: 'caption_title',
-                context: 'figcaption/',
-            },
             {
                 tag: 'tr',
                 node: 'table_row',

package/dist/cjs/jats/importer/jats-transformations.js

@@ -36,10 +36,12 @@ const addMissingCaptions = (doc, createElement) => {
                 ? element.appendChild(caption)
                 : element.prepend(caption);
         }
-        if (!caption.querySelector('title')) {
+        if (!caption.querySelector('title') && element.nodeName !== 'fig') {
             caption.prepend(createElement('title'));
         }
-        if (!caption.querySelector('p') && element.nodeName !== 'boxed-text') {
+        if (!caption.querySelector('p') &&
+            element.nodeName !== 'boxed-text' &&
+            element.nodeName !== 'table-wrap') {
             caption.appendChild(createElement('p'));
         }
     }

package/dist/cjs/schema/index.js

@@ -65,7 +65,6 @@ const doc_1 = require("./nodes/doc");
 const embed_1 = require("./nodes/embed");
 const equation_1 = require("./nodes/equation");
 const equation_element_1 = require("./nodes/equation_element");
-const figcaption_1 = require("./nodes/figcaption");
 const figure_1 = require("./nodes/figure");
 const figure_element_1 = require("./nodes/figure_element");
 const footnote_1 = require("./nodes/footnote");
@@ -140,7 +139,6 @@ __exportStar(require("./nodes/doc"), exports);
 __exportStar(require("./nodes/embed"), exports);
 __exportStar(require("./nodes/equation"), exports);
 __exportStar(require("./nodes/equation_element"), exports);
-__exportStar(require("./nodes/figcaption"), exports);
 __exportStar(require("./nodes/figure"), exports);
 __exportStar(require("./nodes/figure_element"), exports);
 __exportStar(require("./nodes/footnote"), exports);
@@ -219,7 +217,6 @@ exports.schema = new prosemirror_model_1.Schema({
         doc: doc_1.doc,
         equation: equation_1.equation,
         equation_element: equation_element_1.equationElement,
-        figcaption: figcaption_1.figcaption,
         figure: figure_1.figure,
         figure_element: figure_element_1.figureElement,
         footnote: footnote_1.footnote,

package/dist/cjs/schema/migration/migration-scripts/4.3.28.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../../index");
+const CONFIG = {
+    figure_element: { caption: 'required', location: { before: 'alt_text' } },
+    table_element: { title: 'required', location: { pos: 'start' } },
+    image_element: { caption: 'required', location: { before: 'alt_text' } },
+    listing_element: {
+        title: 'required',
+        caption: 'required',
+        location: { pos: 'end' },
+    },
+    supplement: {
+        title: 'required',
+        caption: 'required',
+        location: { pos: 'start' },
+    },
+    embed: { title: 'required', caption: 'required', location: { pos: 'start' } },
+    box_element: {
+        title: 'optional',
+        caption: 'optional',
+        location: { pos: 'start' },
+    },
+};
+class Migration4328 {
+    constructor() {
+        this.fromVersion = '4.3.27';
+        this.toVersion = '4.3.28';
+    }
+    migrateNode(node) {
+        const config = CONFIG[node.type];
+        if (!node.content || !config) {
+            return node;
+        }
+        const figCaption = node.content.find((n) => n.type === 'figcaption');
+        const foundTitle = (figCaption?.content || []).find((n) => n.type === 'caption_title');
+        const foundCaption = (figCaption?.content || []).filter((node) => node.type === 'caption')
+            .reduce((caption, { content }) => ({
+            ...caption,
+            content: [
+                ...(caption.content || []),
+                { type: 'text_block', content, attrs: {} },
+            ],
+        }), { type: 'caption', content: [], attrs: {} });
+        const cleanContent = node.content.filter((n) => n.type !== 'figcaption');
+        const placeholderTitle = index_1.schema.nodes.caption_title.create().toJSON();
+        const placeholderCaption = index_1.schema.nodes.caption.create().toJSON();
+        const captionGroup = [];
+        if (config.title === 'required' ||
+            (config.title === 'optional' && foundTitle)) {
+            captionGroup.push(foundTitle || placeholderTitle);
+        }
+        if (config.caption === 'required' ||
+            (config.caption === 'optional' && foundCaption)) {
+            captionGroup.push(foundCaption || placeholderCaption);
+        }
+        if (config.location.pos === 'start') {
+            cleanContent.unshift(...captionGroup);
+        }
+        else if (config.location.pos === 'end') {
+            cleanContent.push(...captionGroup);
+        }
+        else if (config.location.before) {
+            const idx = cleanContent.findIndex((n) => n.type === config.location.before);
+            cleanContent.splice(idx === -1 ? cleanContent.length : idx, 0, ...captionGroup);
+        }
+        return { ...node, content: cleanContent };
+    }
+}
+exports.default = Migration4328;

package/dist/cjs/schema/migration/migration-scripts/index.js

@@ -30,6 +30,7 @@ const _3_0_56_1 = __importDefault(require("./3.0.56"));
 const _4_2_13_1 = __importDefault(require("./4.2.13"));
 const _4_2_15_1 = __importDefault(require("./4.2.15"));
 const _4_3_23_1 = __importDefault(require("./4.3.23"));
+const _4_3_28_1 = __importDefault(require("./4.3.28"));
 const migrations = [
     new _1_2_5_1.default(),
     new _2_3_22_1.default(),
@@ -43,5 +44,6 @@ const migrations = [
     new _4_2_13_1.default(),
     new _4_2_15_1.default(),
     new _4_3_23_1.default(),
+    new _4_3_28_1.default(),
 ];
 exports.default = migrations;

package/dist/cjs/schema/nodes/box_element.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.box_element = void 0;
 exports.box_element = {
-    content: 'figcaption? section?',
+    content: 'caption_title? caption? section?',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/cjs/schema/nodes/caption.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.caption = void 0;
 exports.caption = {
-    content: 'inline*',
+    content: 'text_block+',
     attrs: {
         placeholder: { default: 'Caption...' },
         dataTracked: { default: null },

package/dist/cjs/schema/nodes/caption_title.js

@@ -20,6 +20,7 @@ exports.captionTitle = {
     content: 'inline*',
     group: 'block',
     selectable: false,
+    isolating: true,
     attrs: {
         placeholder: { default: 'Title...' },
         dataTracked: { default: null },

package/dist/cjs/schema/nodes/embed.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isEmbedNode = exports.embed = void 0;
 exports.embed = {
-    content: 'figcaption alt_text long_desc',
+    content: 'caption_title caption alt_text long_desc',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/cjs/schema/nodes/figure_element.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isFigureElementNode = exports.figureElement = void 0;
 exports.figureElement = {
-    content: '(paragraph | figure | missing_figure | placeholder)+ attribution*  figcaption alt_text long_desc (listing | placeholder)',
+    content: '(paragraph | figure | missing_figure | placeholder)+ attribution* caption alt_text long_desc (listing | placeholder)',
     attrs: {
         id: { default: '' },
         attribution: { default: undefined },

package/dist/cjs/schema/nodes/image_element.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isImageElementNode = exports.imageElement = void 0;
 exports.imageElement = {
-    content: 'figure? alt_text long_desc',
+    content: 'figure? caption alt_text long_desc',
     attrs: {
         id: { default: '' },
         extLink: { default: '' },

package/dist/cjs/schema/nodes/listing_element.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.listingElement = void 0;
 exports.listingElement = {
-    content: '(listing | placeholder) figcaption',
+    content: '(listing | placeholder) caption_title caption',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/cjs/schema/nodes/supplement.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.supplement = void 0;
 exports.supplement = {
-    content: 'figcaption?',
+    content: 'caption_title caption',
     attrs: {
         id: { default: '' },
         href: { default: '' },

package/dist/cjs/schema/nodes/table_element.js

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isTableElementNode = exports.tableElement = void 0;
 exports.tableElement = {
-    content: 'figcaption?  (table | placeholder) table_colgroup? table_element_footer? alt_text long_desc (listing | placeholder)',
+    content: 'caption_title (table | placeholder) table_colgroup? table_element_footer? alt_text long_desc (listing | placeholder)',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = "4.3.33";
+exports.VERSION = "4.3.34";

package/dist/es/jats/exporter/jats-exporter.js

@@ -128,6 +128,21 @@ export class JATSExporter {
                 element.appendChild(this.serializeNode(childNode));
             }
         };
+        this.appendChildrenNodeOfType = (element, node, type) => {
+            const children = this.getChildrenOfType(type, node);
+            children.map((childNode) => element.appendChild(this.serializeNode(childNode)));
+        };
+        this.appendCaption = (element, node) => {
+            const caption = this.createElement('caption');
+            this.appendChildNodeOfType(caption, node, schema.nodes.caption_title);
+            const captionNode = this.getChildrenOfType(schema.nodes.caption, node)[0];
+            if (captionNode && captionNode.content.size > 2) {
+                this.appendChildrenNodeOfType(caption, captionNode, schema.nodes.text_block);
+            }
+            if (caption.children.length > 0) {
+                element.appendChild(caption);
+            }
+        };
         this.initCiteprocEngine = (csl) => {
             const bibitems = new Map();
             const citations = new Map();
@@ -246,7 +261,7 @@ export class JATSExporter {
                 supplementaryMaterial.setAttributeNS(XLINK_NAMESPACE, 'href', node.attrs.href ?? '');
                 supplementaryMaterial.setAttribute('mimetype', node.attrs.mimeType ?? '');
                 supplementaryMaterial.setAttribute('mime-subtype', node.attrs.mimeSubType ?? '');
-                this.appendChildNodeOfType(supplementaryMaterial, node, schema.nodes.figcaption);
+                this.appendCaption(supplementaryMaterial, node);
                 articleMeta.append(supplementaryMaterial);
             });
             const history = articleMeta.querySelector('history') || this.createElement('history');
@@ -455,7 +470,7 @@ export class JATSExporter {
                     appendLabels(mediaElement, node);
                     this.appendChildNodeOfType(mediaElement, node, schema.nodes.alt_text);
                     this.appendChildNodeOfType(mediaElement, node, schema.nodes.long_desc);
-                    this.appendChildNodeOfType(mediaElement, node, schema.nodes.figcaption);
+                    this.appendCaption(mediaElement, node);
                     return mediaElement;
                 },
                 awards: () => ['funding-group', 0],
@@ -570,15 +585,10 @@ export class JATSExporter {
                 equation_element: (node) => {
                     const eqElement = this.createElement('disp-formula');
                     eqElement.setAttribute('id', normalizeID(node.attrs.id));
+                    appendLabels(eqElement, node);
                     processChildNodes(eqElement, node, schema.nodes.equation);
                     return eqElement;
                 },
-                figcaption: (node) => {
-                    if (!node.textContent) {
-                        return '';
-                    }
-                    return ['caption', 0];
-                },
                 figure: (node) => createGraphic(node),
                 figure_element: (node) => createFigureElement(node, node.type.schema.nodes.figure),
                 footnote: (node) => {
@@ -822,8 +832,8 @@ export class JATSExporter {
                 const element = createElement(node, 'boxed-text');
                 appendLabels(element, node);
                 const child = node.firstChild;
-                if (child?.type === schema.nodes.figcaption) {
-                    this.appendChildNodeOfType(element, node, node.type.schema.nodes.figcaption);
+                if (child?.type === schema.nodes.caption_title) {
+                    this.appendCaption(element, node);
                 }
                 processChildNodes(element, node, node.type.schema.nodes.section);
                 return element;
@@ -845,6 +855,7 @@ export class JATSExporter {
                     const extLink = this.appendElement(graphicElement, 'ext-link');
                     extLink.setAttributeNS(XLINK_NAMESPACE, 'href', node.attrs.extLink);
                 }
+                this.appendCaption(graphicElement, node);
                 this.appendChildNodeOfType(graphicElement, node, schema.nodes.alt_text);
                 this.appendChildNodeOfType(graphicElement, node, schema.nodes.long_desc);
                 return graphicElement;
@@ -869,7 +880,7 @@ export class JATSExporter {
                     element.setAttribute('fig-type', figType);
                 }
                 appendLabels(element, node);
-                this.appendChildNodeOfType(element, node, node.type.schema.nodes.figcaption);
+                this.appendCaption(element, node);
                 this.appendChildNodeOfType(element, node, schema.nodes.alt_text);
                 this.appendChildNodeOfType(element, node, schema.nodes.long_desc);
                 this.appendChildNodeOfType(element, node, node.type.schema.nodes.footnotes_element);
@@ -903,7 +914,7 @@ export class JATSExporter {
                 const nodeName = 'table-wrap';
                 const element = createElement(node, nodeName);
                 appendLabels(element, node);
-                this.appendChildNodeOfType(element, node, schema.nodes.figcaption);
+                this.appendCaption(element, node);
                 this.appendChildNodeOfType(element, node, schema.nodes.alt_text);
                 this.appendChildNodeOfType(element, node, schema.nodes.long_desc);
                 appendTable(element, node);

package/dist/es/jats/exporter/labels.js

@@ -49,7 +49,7 @@ export const buildTargets = (iterator) => {
             }
             if (node.type === schema.nodes.box_element) {
                 const child = node.firstChild;
-                if (!child || child.type !== schema.nodes.figcaption) {
+                if (!child || child.type !== schema.nodes.caption_title) {
                     return;
                 }
             }

package/dist/es/jats/importer/jats-dom-parser.js

@@ -157,6 +157,11 @@ export class JATSDOMParser {
             }
             return Fragment.from(content);
         };
+        this.getCaptionContent = (node) => {
+            const element = node;
+            const content = Array.from(element.querySelectorAll('p')).map((paragraph) => this.parse(paragraph, { topNode: this.schema.nodes.text_block.create() }));
+            return Fragment.from(content.length > 0 ? content : this.schema.nodes.text_block.create());
+        };
         this.parseRefPages = (element) => {
             const fpage = getTrimmedTextContent(element, 'fpage');
             const lpage = getTrimmedTextContent(element, 'lpage');
@@ -455,41 +460,34 @@ export class JATSDOMParser {
                 node: 'hard_break',
             },
             {
-                tag: 'caption',
-                node: 'figcaption',
-                context: 'figure/',
+                tag: 'caption > p',
+                context: 'table_element/',
+                ignore: true,
+            },
+            {
+                tag: 'caption > title',
+                node: 'caption_title',
             },
             {
                 tag: 'caption',
-                node: 'figcaption',
-                context: 'figure_element/|table_element/|embed/|supplement/|box_element/',
-                getContent: (node, schema) => {
-                    const element = node;
-                    const content = [];
-                    const title = element.querySelector('title');
-                    if (title) {
-                        const captionTitle = schema.nodes.caption_title.create();
-                        content.push(this.parse(title, { topNode: captionTitle }));
-                    }
-                    const paragraphs = element.querySelectorAll('p');
-                    if (paragraphs.length) {
-                        const figcaption = schema.nodes.caption.create();
-                        for (const paragraph of paragraphs) {
-                            content.push(this.parse(paragraph, { topNode: figcaption }));
-                        }
-                    }
-                    return Fragment.from(content);
-                },
+                node: 'caption',
+                context: 'image_element/|figure_element/',
+                getContent: this.getCaptionContent,
             },
             {
                 tag: 'caption',
-                node: 'figcaption',
-                context: 'box_element/',
-                getAttrs: (node) => {
+                node: 'caption',
+                context: 'listing_element/|embed/|supplement/',
+                getContent: (node) => {
                     const element = node;
-                    return {
-                        id: element.getAttribute('id'),
-                    };
+                    const title = element.querySelector('title');
+                    const caption_title = title
+                        ? this.parse(title, {
+                            topNode: this.schema.nodes.caption_title.create(),
+                        })
+                        : this.schema.nodes.caption_title.create();
+                    const caption = this.schema.nodes.caption.create(undefined, this.getCaptionContent(node));
+                    return Fragment.from([caption_title, caption]);
                 },
             },
             {
@@ -624,7 +622,12 @@ export class JATSDOMParser {
             {
                 tag: 'graphic',
                 node: 'image_element',
-                getContent: this.getFigContent,
+                getContent: (node) => {
+                    const element = node;
+                    const caption = this.schema.nodes.caption.create(undefined, this.getCaptionContent(node));
+                    const fig = this.getFigContent(element).content;
+                    return Fragment.from([...fig.slice(0, 1), caption, ...fig.slice(1)]);
+                },
                 getAttrs: this.getFigAttrs,
             },
             {
@@ -918,11 +921,6 @@ export class JATSDOMParser {
                 node: 'section_title',
                 context: 'section/|footnotes_section/|bibliography_section/|keywords/|supplements/|author_notes/|graphical_abstract_section/|trans_abstract/|trans_graphical_abstract/',
             },
-            {
-                tag: 'title',
-                node: 'caption_title',
-                context: 'figcaption/',
-            },
             {
                 tag: 'tr',
                 node: 'table_row',

package/dist/es/jats/importer/jats-transformations.js

@@ -33,10 +33,12 @@ export const addMissingCaptions = (doc, createElement) => {
                 ? element.appendChild(caption)
                 : element.prepend(caption);
         }
-        if (!caption.querySelector('title')) {
+        if (!caption.querySelector('title') && element.nodeName !== 'fig') {
             caption.prepend(createElement('title'));
         }
-        if (!caption.querySelector('p') && element.nodeName !== 'boxed-text') {
+        if (!caption.querySelector('p') &&
+            element.nodeName !== 'boxed-text' &&
+            element.nodeName !== 'table-wrap') {
             caption.appendChild(createElement('p'));
         }
     }

package/dist/es/schema/index.js

@@ -48,7 +48,6 @@ import { doc } from './nodes/doc';
 import { embed } from './nodes/embed';
 import { equation } from './nodes/equation';
 import { equationElement } from './nodes/equation_element';
-import { figcaption } from './nodes/figcaption';
 import { figure } from './nodes/figure';
 import { figureElement } from './nodes/figure_element';
 import { footnote } from './nodes/footnote';
@@ -123,7 +122,6 @@ export * from './nodes/doc';
 export * from './nodes/embed';
 export * from './nodes/equation';
 export * from './nodes/equation_element';
-export * from './nodes/figcaption';
 export * from './nodes/figure';
 export * from './nodes/figure_element';
 export * from './nodes/footnote';
@@ -202,7 +200,6 @@ export const schema = new Schema({
         doc,
         equation,
         equation_element: equationElement,
-        figcaption,
         figure,
         figure_element: figureElement,
         footnote,

package/dist/es/schema/migration/migration-scripts/4.3.28.js

@@ -0,0 +1,68 @@
+import { schema } from '../../index';
+const CONFIG = {
+    figure_element: { caption: 'required', location: { before: 'alt_text' } },
+    table_element: { title: 'required', location: { pos: 'start' } },
+    image_element: { caption: 'required', location: { before: 'alt_text' } },
+    listing_element: {
+        title: 'required',
+        caption: 'required',
+        location: { pos: 'end' },
+    },
+    supplement: {
+        title: 'required',
+        caption: 'required',
+        location: { pos: 'start' },
+    },
+    embed: { title: 'required', caption: 'required', location: { pos: 'start' } },
+    box_element: {
+        title: 'optional',
+        caption: 'optional',
+        location: { pos: 'start' },
+    },
+};
+class Migration4328 {
+    constructor() {
+        this.fromVersion = '4.3.27';
+        this.toVersion = '4.3.28';
+    }
+    migrateNode(node) {
+        const config = CONFIG[node.type];
+        if (!node.content || !config) {
+            return node;
+        }
+        const figCaption = node.content.find((n) => n.type === 'figcaption');
+        const foundTitle = (figCaption?.content || []).find((n) => n.type === 'caption_title');
+        const foundCaption = (figCaption?.content || []).filter((node) => node.type === 'caption')
+            .reduce((caption, { content }) => ({
+            ...caption,
+            content: [
+                ...(caption.content || []),
+                { type: 'text_block', content, attrs: {} },
+            ],
+        }), { type: 'caption', content: [], attrs: {} });
+        const cleanContent = node.content.filter((n) => n.type !== 'figcaption');
+        const placeholderTitle = schema.nodes.caption_title.create().toJSON();
+        const placeholderCaption = schema.nodes.caption.create().toJSON();
+        const captionGroup = [];
+        if (config.title === 'required' ||
+            (config.title === 'optional' && foundTitle)) {
+            captionGroup.push(foundTitle || placeholderTitle);
+        }
+        if (config.caption === 'required' ||
+            (config.caption === 'optional' && foundCaption)) {
+            captionGroup.push(foundCaption || placeholderCaption);
+        }
+        if (config.location.pos === 'start') {
+            cleanContent.unshift(...captionGroup);
+        }
+        else if (config.location.pos === 'end') {
+            cleanContent.push(...captionGroup);
+        }
+        else if (config.location.before) {
+            const idx = cleanContent.findIndex((n) => n.type === config.location.before);
+            cleanContent.splice(idx === -1 ? cleanContent.length : idx, 0, ...captionGroup);
+        }
+        return { ...node, content: cleanContent };
+    }
+}
+export default Migration4328;

package/dist/es/schema/migration/migration-scripts/index.js

@@ -25,6 +25,7 @@ import Migration3056 from './3.0.56';
 import Migration4213 from './4.2.13';
 import Migration4215 from './4.2.15';
 import Migration4323 from './4.3.23';
+import Migration4328 from './4.3.28';
 const migrations = [
     new Migration125(),
     new Migration2322(),
@@ -38,5 +39,6 @@ const migrations = [
     new Migration4213(),
     new Migration4215(),
     new Migration4323(),
+    new Migration4328(),
 ];
 export default migrations;

package/dist/es/schema/nodes/box_element.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const box_element = {
-    content: 'figcaption? section?',
+    content: 'caption_title? caption? section?',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/es/schema/nodes/caption.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const caption = {
-    content: 'inline*',
+    content: 'text_block+',
     attrs: {
         placeholder: { default: 'Caption...' },
         dataTracked: { default: null },

package/dist/es/schema/nodes/caption_title.js

@@ -17,6 +17,7 @@ export const captionTitle = {
     content: 'inline*',
     group: 'block',
     selectable: false,
+    isolating: true,
     attrs: {
         placeholder: { default: 'Title...' },
         dataTracked: { default: null },

package/dist/es/schema/nodes/embed.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const embed = {
-    content: 'figcaption alt_text long_desc',
+    content: 'caption_title caption alt_text long_desc',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/es/schema/nodes/figure_element.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const figureElement = {
-    content: '(paragraph | figure | missing_figure | placeholder)+ attribution*  figcaption alt_text long_desc (listing | placeholder)',
+    content: '(paragraph | figure | missing_figure | placeholder)+ attribution* caption alt_text long_desc (listing | placeholder)',
     attrs: {
         id: { default: '' },
         attribution: { default: undefined },

package/dist/es/schema/nodes/image_element.js

@@ -1,5 +1,5 @@
 export const imageElement = {
-    content: 'figure? alt_text long_desc',
+    content: 'figure? caption alt_text long_desc',
     attrs: {
         id: { default: '' },
         extLink: { default: '' },

package/dist/es/schema/nodes/listing_element.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const listingElement = {
-    content: '(listing | placeholder) figcaption',
+    content: '(listing | placeholder) caption_title caption',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/es/schema/nodes/supplement.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const supplement = {
-    content: 'figcaption?',
+    content: 'caption_title caption',
     attrs: {
         id: { default: '' },
         href: { default: '' },

package/dist/es/schema/nodes/table_element.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const tableElement = {
-    content: 'figcaption?  (table | placeholder) table_colgroup? table_element_footer? alt_text long_desc (listing | placeholder)',
+    content: 'caption_title (table | placeholder) table_colgroup? table_element_footer? alt_text long_desc (listing | placeholder)',
     attrs: {
         id: { default: '' },
         dataTracked: { default: null },

package/dist/es/version.js

@@ -1 +1 @@
-export const VERSION = "4.3.33";
+export const VERSION = "4.3.34";

package/dist/types/jats/exporter/jats-exporter.d.ts

@@ -43,6 +43,8 @@ export declare class JATSExporter {
     protected getChildrenOfType<T extends ManuscriptNode>(type: NodeType, node?: ManuscriptNode): T[];
     serializeToJATS: (manuscriptNode: ManuscriptNode, options: ExportOptions) => Promise<string>;
     private appendChildNodeOfType;
+    private appendChildrenNodeOfType;
+    protected appendCaption: (element: HTMLElement, node: ManuscriptNode) => void;
     private initCiteprocEngine;
     private nodeFromJATS;
     protected rewriteIDs: (generator?: IDGenerator) => Promise<void>;

package/dist/types/jats/importer/jats-dom-parser.d.ts

@@ -21,6 +21,7 @@ export declare class JATSDOMParser {
     private getDateContent;
     private getIssuedDateContent;
     private getFigContent;
+    private getCaptionContent;
     private parseRefPages;
     private parseRef;
     private nodes;

package/dist/types/schema/index.d.ts

@@ -46,7 +46,6 @@ export * from './nodes/doc';
 export * from './nodes/embed';
 export * from './nodes/equation';
 export * from './nodes/equation_element';
-export * from './nodes/figcaption';
 export * from './nodes/figure';
 export * from './nodes/figure_element';
 export * from './nodes/footnote';

package/dist/types/schema/migration/migration-scripts/4.3.28.d.ts

@@ -0,0 +1,8 @@
+import { JSONProsemirrorNode } from '../../../types';
+import { MigrationScript } from '../migration-script';
+declare class Migration4328 implements MigrationScript {
+    fromVersion: string;
+    toVersion: string;
+    migrateNode(node: JSONProsemirrorNode): JSONProsemirrorNode;
+}
+export default Migration4328;

package/dist/types/schema/migration/migration-scripts/index.d.ts

@@ -25,5 +25,6 @@ import Migration3056 from './3.0.56';
 import Migration4213 from './4.2.13';
 import Migration4215 from './4.2.15';
 import Migration4323 from './4.3.23';
-declare const migrations: (Migration125 | Migration2322 | Migration3012 | Migration3021 | Migration3030 | Migration3031 | Migration3041 | Migration3055 | Migration3056 | Migration4213 | Migration4215 | Migration4323)[];
+import Migration4328 from './4.3.28';
+declare const migrations: (Migration125 | Migration2322 | Migration3012 | Migration3021 | Migration3030 | Migration3031 | Migration3041 | Migration3055 | Migration3056 | Migration4213 | Migration4215 | Migration4323 | Migration4328)[];
 export default migrations;

package/dist/types/schema/types.d.ts

@@ -17,7 +17,7 @@ import { Fragment, Mark as ProsemirrorMark, MarkType, Node as ProsemirrorNode, N
 import { EditorState, NodeSelection, Plugin, TextSelection, Transaction } from 'prosemirror-state';
 import { EditorView, NodeView } from 'prosemirror-view';
 export type Marks = 'bold' | 'code' | 'italic' | 'smallcaps' | 'strikethrough' | 'styled' | 'subscript' | 'superscript' | 'underline' | 'tracked_insert' | 'tracked_delete';
-export type Nodes = 'attribution' | 'bibliography_item' | 'bibliography_element' | 'bibliography_section' | 'blockquote_element' | 'quote_image' | 'list' | 'caption' | 'caption_title' | 'comment' | 'comments' | 'citation' | 'cross_reference' | 'doc' | 'equation' | 'equation_element' | 'figcaption' | 'figure' | 'graphical_abstract_section' | 'figure_element' | 'footnote' | 'footnotes_element' | 'footnotes_section' | 'hard_break' | 'highlight_marker' | 'inline_equation' | 'inline_footnote' | 'keyword' | 'keywords_element' | 'keyword_group' | 'keywords' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'abstracts' | 'body' | 'backmatter' | 'missing_figure' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'section_title_plain' | 'table' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'table_header' | 'text' | 'text_block' | 'affiliation' | 'contributor' | 'table_element_footer' | 'title' | 'affiliations' | 'contributors' | 'supplements' | 'supplement' | 'author_notes' | 'corresp' | 'general_table_footnote' | 'box_element' | 'awards' | 'award' | 'embed' | 'image_element' | 'attachment' | 'attachments' | 'alt_title' | 'alt_text' | 'alt_titles' | 'long_desc' | 'hero_image' | 'trans_abstract' | 'trans_graphical_abstract' | 'subtitle' | 'subtitles';
+export type Nodes = 'attribution' | 'bibliography_item' | 'bibliography_element' | 'bibliography_section' | 'blockquote_element' | 'quote_image' | 'list' | 'caption' | 'caption_title' | 'comment' | 'comments' | 'citation' | 'cross_reference' | 'doc' | 'equation' | 'equation_element' | 'figure' | 'graphical_abstract_section' | 'figure_element' | 'footnote' | 'footnotes_element' | 'footnotes_section' | 'hard_break' | 'highlight_marker' | 'inline_equation' | 'inline_footnote' | 'keyword' | 'keywords_element' | 'keyword_group' | 'keywords' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'abstracts' | 'body' | 'backmatter' | 'missing_figure' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'section_title_plain' | 'table' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'table_header' | 'text' | 'text_block' | 'affiliation' | 'contributor' | 'table_element_footer' | 'title' | 'affiliations' | 'contributors' | 'supplements' | 'supplement' | 'author_notes' | 'corresp' | 'general_table_footnote' | 'box_element' | 'awards' | 'award' | 'embed' | 'image_element' | 'attachment' | 'attachments' | 'alt_title' | 'alt_text' | 'alt_titles' | 'long_desc' | 'hero_image' | 'trans_abstract' | 'trans_graphical_abstract' | 'subtitle' | 'subtitles';
 export type ManuscriptSchema = Schema<Nodes, Marks>;
 export type ManuscriptEditorState = EditorState;
 export type ManuscriptEditorView = EditorView;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "4.3.33";
+export declare const VERSION = "4.3.34";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/transform",
   "description": "ProseMirror transformer for Manuscripts applications",
-  "version": "4.3.33",
+  "version": "4.3.34",
   "repository": "github:Atypon-OpenSource/manuscripts-transform",
   "license": "Apache-2.0",
   "main": "dist/cjs",

package/dist/cjs/schema/nodes/figcaption.js

@@ -1,31 +0,0 @@
-"use strict";
-/*!
- * © 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.figcaption = void 0;
-exports.figcaption = {
-    content: 'caption_title? caption*',
-    group: 'block',
-    attrs: { dataTracked: { default: null } },
-    isolating: true,
-    selectable: false,
-    parseDOM: [
-        {
-            tag: 'figcaption',
-        },
-    ],
-    toDOM: () => ['figcaption', 0],
-};

package/dist/es/schema/nodes/figcaption.js

@@ -1,28 +0,0 @@
-/*!
- * © 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.
- */
-export const figcaption = {
-    content: 'caption_title? caption*',
-    group: 'block',
-    attrs: { dataTracked: { default: null } },
-    isolating: true,
-    selectable: false,
-    parseDOM: [
-        {
-            tag: 'figcaption',
-        },
-    ],
-    toDOM: () => ['figcaption', 0],
-};

package/dist/types/schema/nodes/figcaption.d.ts

@@ -1,21 +0,0 @@
-/*!
- * © 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 FigCaptionNode extends ManuscriptNode {
-    attrs: Record<string, unknown>;
-}
-export declare const figcaption: NodeSpec;