@manuscripts/transform 1.0.1 → 1.1.0

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

@@ -623,6 +623,7 @@ class JATSExporter {
                 attribution: () => ['attrib', 0],
                 bibliography_element: () => '',
                 bibliography_item: () => '',
+                comment_list: () => '',
                 bibliography_section: (node) => [
                     'ref-list',
                     { id: normalizeID(node.attrs.id) },

package/dist/cjs/schema/index.js

@@ -41,6 +41,7 @@ const caption_1 = require("./nodes/caption");
 const caption_title_1 = require("./nodes/caption_title");
 const citation_1 = require("./nodes/citation");
 const comment_1 = require("./nodes/comment");
+const comment_list_1 = require("./nodes/comment_list");
 const cross_reference_1 = require("./nodes/cross_reference");
 const doc_1 = require("./nodes/doc");
 const equation_1 = require("./nodes/equation");
@@ -141,6 +142,7 @@ exports.schema = new prosemirror_model_1.Schema({
     },
     nodes: {
         comment: comment_1.comment,
+        comment_list: comment_list_1.commentList,
         attribution: attribution_1.attribution,
         bibliography_item: bibliography_item_1.bibliographyItem,
         bibliography_element: bibliography_element_1.bibliographyElement,

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

@@ -0,0 +1,24 @@
+"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.commentList = void 0;
+exports.commentList = {
+    content: 'comment*',
+    attrs: {
+        id: { default: '' },
+    },
+};

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

@@ -17,7 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.manuscript = void 0;
 exports.manuscript = {
-    content: '(section | sections)+',
+    content: '(section | sections)+ comment_list*',
     attrs: {
         id: { default: '' },
     },

package/dist/cjs/transformer/decode.js

@@ -98,6 +98,7 @@ class Decoder {
         }
     }
     constructor(modelMap, allowMissingElements = false) {
+        this.comments = new Map();
         this.creators = {
             [json_schema_1.ObjectTypes.BibliographyElement]: (data) => {
                 var _a;
@@ -144,12 +145,14 @@ class Decoder {
             },
             [json_schema_1.ObjectTypes.Figure]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema_1.schema.nodes.figure.create({
                     id: model._id,
                     contentType: model.contentType,
                     src: model.src,
                     position: model.position,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 });
             },
             [json_schema_1.ObjectTypes.FigureElement]: (data) => {
@@ -178,6 +181,8 @@ class Decoder {
                     figures.push(schema_1.schema.nodes.figure.createAndFill());
                 }
                 const figcaption = this.getFigcaption(model);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 const content = [...paragraphs, ...figures, figcaption];
                 const listing = this.extractListing(model);
                 if (listing) {
@@ -198,7 +203,7 @@ class Decoder {
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
                     attribution: model.attribution,
                     alternatives: model.alternatives,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, content);
             },
             [json_schema_1.ObjectTypes.Equation]: (data) => {
@@ -239,11 +244,13 @@ class Decoder {
                 const footnotesOfKind = [];
                 for (const model of this.modelMap.values()) {
                     if (isFootnote(model) && model.kind === collateByKind) {
+                        const commentNodes = this.createCommentsNode(model);
+                        commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                         const footnote = this.parseContents(model.contents || '<div></div>', undefined, this.getComments(model), {
                             topNode: schema_1.schema.nodes.footnote.create({
                                 id: model._id,
                                 kind: model.kind,
-                                comments: this.createCommentsNode(model),
+                                comments: commentNodes.map((c) => c.attrs.id),
                             }),
                         });
                         footnotesOfKind.push(footnote);
@@ -257,10 +264,12 @@ class Decoder {
             },
             [json_schema_1.ObjectTypes.Footnote]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema_1.schema.nodes.footnote.create({
                     id: model._id,
                     kind: model.kind,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 });
             },
             [json_schema_1.ObjectTypes.KeywordsElement]: (data) => {
@@ -275,13 +284,15 @@ class Decoder {
             },
             [json_schema_1.ObjectTypes.ListElement]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 switch (model.elementType) {
                     case 'ol':
                         return this.parseContents(model.contents || '<ol></ol>', undefined, this.getComments(model), {
                             topNode: schema_1.schema.nodes.ordered_list.create({
                                 id: model._id,
                                 paragraphStyle: model.paragraphStyle,
-                                comments: this.createCommentsNode(model),
+                                comments: commentNodes.map((c) => c.attrs.id),
                             }),
                         });
                     case 'ul':
@@ -297,12 +308,14 @@ class Decoder {
             },
             [json_schema_1.ObjectTypes.Listing]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema_1.schema.nodes.listing.createChecked({
                     id: model._id,
                     contents: model.contents,
                     language: model.language,
                     languageKey: model.languageKey,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 });
             },
             [json_schema_1.ObjectTypes.ListingElement]: (data) => {
@@ -322,11 +335,13 @@ class Decoder {
                     throw new errors_1.MissingElement(model.containedObjectID);
                 }
                 const figcaption = this.getFigcaption(model);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema_1.schema.nodes.listing_element.createChecked({
                     id: model._id,
                     suppressCaption: model.suppressCaption,
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, [listing, figcaption]);
             },
             [json_schema_1.ObjectTypes.MissingFigure]: (data) => {
@@ -338,12 +353,14 @@ class Decoder {
             },
             [json_schema_1.ObjectTypes.ParagraphElement]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return this.parseContents(model.contents || '<p></p>', undefined, this.getComments(model), {
                     topNode: schema_1.schema.nodes.paragraph.create({
                         id: model._id,
                         paragraphStyle: model.paragraphStyle,
                         placeholder: model.placeholderInnerHTML,
-                        comments: this.createCommentsNode(model),
+                        comments: commentNodes.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -418,6 +435,8 @@ class Decoder {
                     .map(this.creators[json_schema_1.ObjectTypes.Section]);
                 const sectionCategory = model.category || (0, section_category_1.guessSectionCategory)(elements);
                 const sectionNodeType = (0, section_category_1.chooseSectionNodeType)(sectionCategory);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 const content = (sectionLabelNode
                     ? [sectionLabelNode, sectionTitleNode]
                     : [sectionTitleNode])
@@ -429,7 +448,7 @@ class Decoder {
                     titleSuppressed: model.titleSuppressed,
                     pageBreakStyle: model.pageBreakStyle,
                     generatedLabel: model.generatedLabel,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, content);
                 if (!sectionNode) {
                     console.error(model);
@@ -439,10 +458,12 @@ class Decoder {
             },
             [json_schema_1.ObjectTypes.Table]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return this.parseContents(model.contents, undefined, this.getComments(model), {
                     topNode: schema_1.schema.nodes.table.create({
                         id: model._id,
-                        comments: this.createCommentsNode(model),
+                        comments: commentNodes.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -463,6 +484,8 @@ class Decoder {
                     throw new errors_1.MissingElement(model.containedObjectID);
                 }
                 const figcaption = this.getFigcaption(model);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 const content = [table, figcaption];
                 if (model.listingID) {
                     const listingModel = this.getModel(model.listingID);
@@ -494,7 +517,7 @@ class Decoder {
                     suppressHeader: model.suppressHeader,
                     tableStyle: model.tableStyle,
                     paragraphStyle: model.paragraphStyle,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, content);
             },
             [json_schema_1.ObjectTypes.TOCElement]: (data) => {
@@ -536,9 +559,16 @@ class Decoder {
                     id: (0, id_1.generateNodeID)(schema_1.schema.nodes.section),
                 }));
             }
+            const contents = rootSectionNodes;
+            if (this.comments.size) {
+                const comments = schema_1.schema.nodes.comment_list.createAndFill({
+                    id: (0, id_1.generateNodeID)(schema_1.schema.nodes.comment_list),
+                }, [...this.comments.values()]);
+                contents.push(comments);
+            }
             return schema_1.schema.nodes.manuscript.create({
                 id: manuscriptID || this.getManuscriptID(),
-            }, rootSectionNodes);
+            }, contents);
         };
         this.addGeneratedLabels = (sections) => {
             const nextLableCount = { Appendix: 1 };

package/dist/cjs/transformer/encode.js

@@ -501,16 +501,6 @@ const modelFromNode = (node, parent, path, priority) => {
     const model = data;
     if ((0, highlight_markers_1.isHighlightableModel)(model)) {
         (0, highlight_markers_1.extractHighlightMarkers)(model, commentAnnotationsMap);
-        if (node.attrs.comments) {
-            const commentNodes = node.attrs.comments;
-            commentNodes
-                .filter((commentNode) => !commentNode.attrs.selector)
-                .forEach((c) => {
-                const commentAnnotation = (0, builders_1.buildComment)(model._id, c.attrs.contents, c.attrs.selector);
-                commentAnnotation._id = c.attrs.id;
-                commentAnnotationsMap.set(commentAnnotation._id, commentAnnotation);
-            });
-        }
     }
     return { model, commentAnnotationsMap };
 };
@@ -528,6 +518,9 @@ const encode = (node) => {
         if ((0, schema_1.isHighlightMarkerNode)(child)) {
             return;
         }
+        if (child.type === schema_1.schema.nodes.comment_list) {
+            return;
+        }
         if (placeholders.includes(child.type.name)) {
             return;
         }
@@ -539,6 +532,14 @@ const encode = (node) => {
         commentAnnotationsMap.forEach((val, key) => models.set(key, val));
         child.forEach(addModel(path.concat(child.attrs.id), child));
     };
+    node.forEach((cNode) => {
+        if (cNode.type === schema_1.schema.nodes.comment_list) {
+            cNode.forEach((child) => {
+                const { model } = (0, exports.modelFromNode)(child, cNode, [], priority);
+                models.set(model._id, model);
+            });
+        }
+    });
     node.forEach(addModel([], node));
     return models;
 };

package/dist/cjs/transformer/node-types.js

@@ -51,6 +51,7 @@ exports.nodeTypesMap = new Map([
     [schema_1.schema.nodes.table_element, json_schema_1.ObjectTypes.TableElement],
     [schema_1.schema.nodes.toc_element, json_schema_1.ObjectTypes.TOCElement],
     [schema_1.schema.nodes.toc_section, json_schema_1.ObjectTypes.Section],
+    [schema_1.schema.nodes.comment_list, json_schema_1.ObjectTypes.MetaSection],
 ]);
 const isExecutableNodeType = (type) => (0, schema_1.hasGroup)(type, schema_1.GROUP_EXECUTABLE);
 exports.isExecutableNodeType = isExecutableNodeType;

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

@@ -616,6 +616,7 @@ export class JATSExporter {
                 attribution: () => ['attrib', 0],
                 bibliography_element: () => '',
                 bibliography_item: () => '',
+                comment_list: () => '',
                 bibliography_section: (node) => [
                     'ref-list',
                     { id: normalizeID(node.attrs.id) },

package/dist/es/schema/index.js

@@ -24,6 +24,7 @@ import { caption } from './nodes/caption';
 import { captionTitle } from './nodes/caption_title';
 import { citation } from './nodes/citation';
 import { comment } from './nodes/comment';
+import { commentList } from './nodes/comment_list';
 import { crossReference } from './nodes/cross_reference';
 import { doc } from './nodes/doc';
 import { equation } from './nodes/equation';
@@ -124,6 +125,7 @@ export const schema = new Schema({
     },
     nodes: {
         comment,
+        comment_list: commentList,
         attribution,
         bibliography_item: bibliographyItem,
         bibliography_element: bibliographyElement,

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

@@ -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.
+ */
+export const commentList = {
+    content: 'comment*',
+    attrs: {
+        id: { default: '' },
+    },
+};

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

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 export const manuscript = {
-    content: '(section | sections)+',
+    content: '(section | sections)+ comment_list*',
     attrs: {
         id: { default: '' },
     },

package/dist/es/transformer/decode.js

@@ -88,6 +88,7 @@ export class Decoder {
         }
     }
     constructor(modelMap, allowMissingElements = false) {
+        this.comments = new Map();
         this.creators = {
             [ObjectTypes.BibliographyElement]: (data) => {
                 var _a;
@@ -134,12 +135,14 @@ export class Decoder {
             },
             [ObjectTypes.Figure]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema.nodes.figure.create({
                     id: model._id,
                     contentType: model.contentType,
                     src: model.src,
                     position: model.position,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 });
             },
             [ObjectTypes.FigureElement]: (data) => {
@@ -168,6 +171,8 @@ export class Decoder {
                     figures.push(schema.nodes.figure.createAndFill());
                 }
                 const figcaption = this.getFigcaption(model);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 const content = [...paragraphs, ...figures, figcaption];
                 const listing = this.extractListing(model);
                 if (listing) {
@@ -188,7 +193,7 @@ export class Decoder {
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
                     attribution: model.attribution,
                     alternatives: model.alternatives,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, content);
             },
             [ObjectTypes.Equation]: (data) => {
@@ -229,11 +234,13 @@ export class Decoder {
                 const footnotesOfKind = [];
                 for (const model of this.modelMap.values()) {
                     if (isFootnote(model) && model.kind === collateByKind) {
+                        const commentNodes = this.createCommentsNode(model);
+                        commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                         const footnote = this.parseContents(model.contents || '<div></div>', undefined, this.getComments(model), {
                             topNode: schema.nodes.footnote.create({
                                 id: model._id,
                                 kind: model.kind,
-                                comments: this.createCommentsNode(model),
+                                comments: commentNodes.map((c) => c.attrs.id),
                             }),
                         });
                         footnotesOfKind.push(footnote);
@@ -247,10 +254,12 @@ export class Decoder {
             },
             [ObjectTypes.Footnote]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema.nodes.footnote.create({
                     id: model._id,
                     kind: model.kind,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 });
             },
             [ObjectTypes.KeywordsElement]: (data) => {
@@ -265,13 +274,15 @@ export class Decoder {
             },
             [ObjectTypes.ListElement]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 switch (model.elementType) {
                     case 'ol':
                         return this.parseContents(model.contents || '<ol></ol>', undefined, this.getComments(model), {
                             topNode: schema.nodes.ordered_list.create({
                                 id: model._id,
                                 paragraphStyle: model.paragraphStyle,
-                                comments: this.createCommentsNode(model),
+                                comments: commentNodes.map((c) => c.attrs.id),
                             }),
                         });
                     case 'ul':
@@ -287,12 +298,14 @@ export class Decoder {
             },
             [ObjectTypes.Listing]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema.nodes.listing.createChecked({
                     id: model._id,
                     contents: model.contents,
                     language: model.language,
                     languageKey: model.languageKey,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 });
             },
             [ObjectTypes.ListingElement]: (data) => {
@@ -312,11 +325,13 @@ export class Decoder {
                     throw new MissingElement(model.containedObjectID);
                 }
                 const figcaption = this.getFigcaption(model);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return schema.nodes.listing_element.createChecked({
                     id: model._id,
                     suppressCaption: model.suppressCaption,
                     suppressTitle: Boolean(model.suppressTitle === undefined ? true : model.suppressTitle),
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, [listing, figcaption]);
             },
             [ObjectTypes.MissingFigure]: (data) => {
@@ -328,12 +343,14 @@ export class Decoder {
             },
             [ObjectTypes.ParagraphElement]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return this.parseContents(model.contents || '<p></p>', undefined, this.getComments(model), {
                     topNode: schema.nodes.paragraph.create({
                         id: model._id,
                         paragraphStyle: model.paragraphStyle,
                         placeholder: model.placeholderInnerHTML,
-                        comments: this.createCommentsNode(model),
+                        comments: commentNodes.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -408,6 +425,8 @@ export class Decoder {
                     .map(this.creators[ObjectTypes.Section]);
                 const sectionCategory = model.category || guessSectionCategory(elements);
                 const sectionNodeType = chooseSectionNodeType(sectionCategory);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 const content = (sectionLabelNode
                     ? [sectionLabelNode, sectionTitleNode]
                     : [sectionTitleNode])
@@ -419,7 +438,7 @@ export class Decoder {
                     titleSuppressed: model.titleSuppressed,
                     pageBreakStyle: model.pageBreakStyle,
                     generatedLabel: model.generatedLabel,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, content);
                 if (!sectionNode) {
                     console.error(model);
@@ -429,10 +448,12 @@ export class Decoder {
             },
             [ObjectTypes.Table]: (data) => {
                 const model = data;
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 return this.parseContents(model.contents, undefined, this.getComments(model), {
                     topNode: schema.nodes.table.create({
                         id: model._id,
-                        comments: this.createCommentsNode(model),
+                        comments: commentNodes.map((c) => c.attrs.id),
                     }),
                 });
             },
@@ -453,6 +474,8 @@ export class Decoder {
                     throw new MissingElement(model.containedObjectID);
                 }
                 const figcaption = this.getFigcaption(model);
+                const commentNodes = this.createCommentsNode(model);
+                commentNodes.forEach((c) => this.comments.set(c.attrs.id, c));
                 const content = [table, figcaption];
                 if (model.listingID) {
                     const listingModel = this.getModel(model.listingID);
@@ -484,7 +507,7 @@ export class Decoder {
                     suppressHeader: model.suppressHeader,
                     tableStyle: model.tableStyle,
                     paragraphStyle: model.paragraphStyle,
-                    comments: this.createCommentsNode(model),
+                    comments: commentNodes.map((c) => c.attrs.id),
                 }, content);
             },
             [ObjectTypes.TOCElement]: (data) => {
@@ -526,9 +549,16 @@ export class Decoder {
                     id: generateNodeID(schema.nodes.section),
                 }));
             }
+            const contents = rootSectionNodes;
+            if (this.comments.size) {
+                const comments = schema.nodes.comment_list.createAndFill({
+                    id: generateNodeID(schema.nodes.comment_list),
+                }, [...this.comments.values()]);
+                contents.push(comments);
+            }
             return schema.nodes.manuscript.create({
                 id: manuscriptID || this.getManuscriptID(),
-            }, rootSectionNodes);
+            }, contents);
         };
         this.addGeneratedLabels = (sections) => {
             const nextLableCount = { Appendix: 1 };

package/dist/es/transformer/encode.js

@@ -17,7 +17,7 @@ import { DOMSerializer } from 'prosemirror-model';
 import serializeToXML from 'w3c-xmlserializer';
 import { iterateChildren } from '../lib/utils';
 import { isHighlightMarkerNode, isSectionNode, schema, } from '../schema';
-import { buildAttribution, buildComment } from './builders';
+import { buildAttribution } from './builders';
 import { extractHighlightMarkers, isHighlightableModel, } from './highlight-markers';
 import { nodeTypesMap } from './node-types';
 import { buildSectionCategory } from './section-category';
@@ -493,16 +493,6 @@ export const modelFromNode = (node, parent, path, priority) => {
     const model = data;
     if (isHighlightableModel(model)) {
         extractHighlightMarkers(model, commentAnnotationsMap);
-        if (node.attrs.comments) {
-            const commentNodes = node.attrs.comments;
-            commentNodes
-                .filter((commentNode) => !commentNode.attrs.selector)
-                .forEach((c) => {
-                const commentAnnotation = buildComment(model._id, c.attrs.contents, c.attrs.selector);
-                commentAnnotation._id = c.attrs.id;
-                commentAnnotationsMap.set(commentAnnotation._id, commentAnnotation);
-            });
-        }
     }
     return { model, commentAnnotationsMap };
 };
@@ -519,6 +509,9 @@ export const encode = (node) => {
         if (isHighlightMarkerNode(child)) {
             return;
         }
+        if (child.type === schema.nodes.comment_list) {
+            return;
+        }
         if (placeholders.includes(child.type.name)) {
             return;
         }
@@ -530,6 +523,14 @@ export const encode = (node) => {
         commentAnnotationsMap.forEach((val, key) => models.set(key, val));
         child.forEach(addModel(path.concat(child.attrs.id), child));
     };
+    node.forEach((cNode) => {
+        if (cNode.type === schema.nodes.comment_list) {
+            cNode.forEach((child) => {
+                const { model } = modelFromNode(child, cNode, [], priority);
+                models.set(model._id, model);
+            });
+        }
+    });
     node.forEach(addModel([], node));
     return models;
 };

package/dist/es/transformer/node-types.js

@@ -48,6 +48,7 @@ export const nodeTypesMap = new Map([
     [schema.nodes.table_element, ObjectTypes.TableElement],
     [schema.nodes.toc_element, ObjectTypes.TOCElement],
     [schema.nodes.toc_section, ObjectTypes.Section],
+    [schema.nodes.comment_list, ObjectTypes.MetaSection],
 ]);
 export const isExecutableNodeType = (type) => hasGroup(type, GROUP_EXECUTABLE);
 export const isElementNodeType = (type) => hasGroup(type, GROUP_ELEMENT);

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

@@ -0,0 +1,25 @@
+/*!
+ * © 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 CommentListNode extends ManuscriptNode {
+    attrs: Attrs;
+}
+export declare const commentList: NodeSpec;
+export {};

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' | 'bullet_list' | 'caption' | 'caption_title' | 'comment' | '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' | 'keywords_element' | 'keywords_section' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'missing_figure' | 'ordered_list' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'table' | 'table_body' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'text' | 'toc_element' | 'toc_section';
+export type Nodes = 'attribution' | 'bibliography_item' | 'bibliography_element' | 'bibliography_section' | 'blockquote_element' | 'bullet_list' | 'caption' | 'caption_title' | 'comment' | 'comment_list' | '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' | 'keywords_element' | 'keywords_section' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'missing_figure' | 'ordered_list' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'table' | 'table_body' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'text' | 'toc_element' | 'toc_section';
 export type ManuscriptSchema = Schema<Nodes, Marks>;
 export type ManuscriptEditorState = EditorState;
 export type ManuscriptEditorView = EditorView;

package/dist/types/transformer/decode.d.ts

@@ -23,6 +23,7 @@ export declare const isManuscriptNode: (model: ManuscriptNode | null) => model i
 export declare class Decoder {
     private readonly modelMap;
     private readonly allowMissingElements;
+    private comments;
     private creators;
     private createCommentsNode;
     private getComments;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/transform",
   "description": "ProseMirror transformer for Manuscripts applications",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "repository": "github:Atypon-OpenSource/manuscripts-transform",
   "license": "Apache-2.0",
   "main": "dist/cjs",
@@ -43,7 +43,7 @@
     "@manuscripts/data": "^0.1.12",
     "@manuscripts/eslint-config": "^0.5.1",
     "@manuscripts/examples": "^0.1.0",
-    "@manuscripts/json-schema": "^1.0.0",
+    "@manuscripts/json-schema": "^1.1.0",
     "@types/debug": "^4.1.7",
     "@types/jest": "^29.2.4",
     "@types/lodash.pickby": "^4.6.7",