@manuscripts/transform 1.5.5 → 1.5.7-LEAN-3030

package/dist/es/transformer/encode.js

@@ -420,34 +420,9 @@ const encoders = {
         elementType: 'div',
         paragraphStyle: node.attrs.paragraphStyle || undefined,
     }),
-    keywords_group: (node) => ({
+    keyword_group: (node) => ({
         type: node.attrs.type,
     }),
-    keywords_section: (node, parent, path, priority) => ({
-        category: buildSectionCategory(node),
-        priority: priority.value++,
-        title: inlineContentsOfNodeType(node, node.type.schema.nodes.section_title),
-        path: path.concat([node.attrs.id]),
-        elementIDs: childElements(node)
-            .map((childNode) => childNode.attrs.id)
-            .filter((id) => id),
-    }),
-    affiliations_section: (node, parent, path, priority) => ({
-        category: buildSectionCategory(node),
-        priority: priority.value++,
-        path: path.concat([node.attrs.id]),
-        elementIDs: childElements(node)
-            .map((childNode) => childNode.attrs.id)
-            .filter((id) => id),
-    }),
-    contributors_section: (node, parent, path, priority) => ({
-        category: buildSectionCategory(node),
-        priority: priority.value++,
-        path: path.concat([node.attrs.id]),
-        elementIDs: childElements(node)
-            .map((childNode) => childNode.attrs.id)
-            .filter((id) => id),
-    }),
     missing_figure: (node) => ({
         position: node.attrs.position || undefined,
     }),
@@ -565,8 +540,17 @@ export const modelFromNode = (node, parent, path, priority) => {
     if (isHighlightableModel(model)) {
         extractHighlightMarkers(model, commentAnnotationsMap);
     }
-    return { model, commentAnnotationsMap };
+    const comments = [...commentAnnotationsMap.values()];
+    return { model, comments };
 };
+function isCoreSection(child) {
+    return (child.type === schema.nodes.abstracts ||
+        child.type === schema.nodes.body ||
+        child.type === schema.nodes.backmatter ||
+        child.type === schema.nodes.affiliations ||
+        child.type === schema.nodes.contributors ||
+        child.type === schema.nodes.keywords);
+}
 export const encode = (node) => {
     const models = new Map();
     const priority = {
@@ -574,6 +558,10 @@ export const encode = (node) => {
     };
     const placeholders = ['placeholder', 'placeholder_element'];
     const addModel = (path, parent) => (child) => {
+        if (isCoreSection(child)) {
+            child.forEach(addModel([], child));
+            return;
+        }
         if (!child.attrs.id) {
             return;
         }
@@ -586,10 +574,18 @@ export const encode = (node) => {
         if (placeholders.includes(child.type.name)) {
             return;
         }
-        const { model } = modelFromNode(child, parent, path, priority);
+        const { model, comments } = modelFromNode(child, parent, path, priority);
         if (models.has(model._id)) {
             throw Error(`Encountered duplicate ids in models map while encoding: ${model._id}`);
         }
+        comments.forEach((comment) => {
+            const proseMirrorComment = models.get(comment._id);
+            if (proseMirrorComment) {
+                ;
+                proseMirrorComment.selector = comment.selector;
+                models.set(comment._id, proseMirrorComment);
+            }
+        });
         models.set(model._id, model);
         child.forEach(addModel(path.concat(child.attrs.id), child));
     };

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

@@ -35,6 +35,6 @@ export const nodeNames = new Map([
     [schema.nodes.table_element, 'Table'],
     [schema.nodes.blockquote_element, 'Block Quote'],
     [schema.nodes.pullquote_element, 'Pull Quote'],
-    [schema.nodes.keywords_section, 'Section'],
+    [schema.nodes.keywords, 'Section'],
     [schema.nodes.toc_section, 'Section'],
 ]);

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

@@ -47,7 +47,7 @@ export const nodeTitle = (node) => {
         case nodes.section:
         case nodes.bibliography_section:
         case nodes.footnotes_section:
-        case nodes.keywords_section:
+        case nodes.keywords:
         case nodes.toc_section:
         case nodes.graphical_abstract_section:
             return snippetOfNodeType(node, nodes.section_title);

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

@@ -16,6 +16,9 @@
 import { ObjectTypes } from '@manuscripts/json-schema';
 import { GROUP_ELEMENT, GROUP_EXECUTABLE, GROUP_SECTION, hasGroup, schema, } from '../schema';
 export const nodeTypesMap = new Map([
+    [schema.nodes.abstracts, ObjectTypes.Section],
+    [schema.nodes.body, ObjectTypes.Section],
+    [schema.nodes.backmatter, ObjectTypes.Section],
     [schema.nodes.comment, ObjectTypes.CommentAnnotation],
     [schema.nodes.bibliography_item, ObjectTypes.BibliographyItem],
     [schema.nodes.bibliography_element, ObjectTypes.BibliographyElement],
@@ -37,8 +40,8 @@ export const nodeTypesMap = new Map([
     [schema.nodes.inline_equation, ObjectTypes.InlineMathFragment],
     [schema.nodes.keyword, ObjectTypes.Keyword],
     [schema.nodes.keywords_element, ObjectTypes.KeywordsElement],
-    [schema.nodes.keywords_section, ObjectTypes.Section],
-    [schema.nodes.keywords_group, ObjectTypes.KeywordGroup],
+    [schema.nodes.keywords, ObjectTypes.Section],
+    [schema.nodes.keyword_group, ObjectTypes.KeywordGroup],
     [schema.nodes.listing, ObjectTypes.Listing],
     [schema.nodes.listing_element, ObjectTypes.ListingElement],
     [schema.nodes.manuscript, ObjectTypes.Manuscript],
@@ -54,9 +57,9 @@ export const nodeTypesMap = new Map([
     [schema.nodes.affiliation, ObjectTypes.Affiliation],
     [schema.nodes.contributor, ObjectTypes.Contributor],
     [schema.nodes.table_element_footer, ObjectTypes.TableElementFooter],
+    [schema.nodes.contributors, ObjectTypes.Section],
+    [schema.nodes.affiliations, ObjectTypes.Section],
     [schema.nodes.title, ObjectTypes.Titles],
-    [schema.nodes.contributors_section, ObjectTypes.Section],
-    [schema.nodes.affiliations_section, ObjectTypes.Section],
 ]);
 export const isExecutableNodeType = (type) => hasGroup(type, GROUP_EXECUTABLE);
 export const isElementNodeType = (type) => hasGroup(type, GROUP_ELEMENT);

package/dist/es/transformer/section-category.js

@@ -19,7 +19,7 @@ import { schema } from '../schema';
 const sectionNodeTypes = [
     schema.nodes.bibliography_section,
     schema.nodes.footnotes_section,
-    schema.nodes.keywords_section,
+    schema.nodes.keywords,
     schema.nodes.section,
     schema.nodes.toc_section,
 ];
@@ -40,11 +40,11 @@ export const chooseSectionNodeType = (category) => {
         case 'MPSectionCategory:endnotes':
             return schema.nodes.footnotes_section;
         case 'MPSectionCategory:keywords':
-            return schema.nodes.keywords_section;
+            return schema.nodes.keywords;
         case 'MPSectionCategory:affiliations':
-            return schema.nodes.affiliations_section;
+            return schema.nodes.affiliations;
         case 'MPSectionCategory:contributors':
-            return schema.nodes.contributors_section;
+            return schema.nodes.contributors;
         case 'MPSectionCategory:toc':
             return schema.nodes.toc_section;
         default:
@@ -82,15 +82,15 @@ export const buildSectionCategory = (node) => {
             return 'MPSectionCategory:bibliography';
         case schema.nodes.footnotes_section:
             return 'MPSectionCategory:endnotes';
-        case schema.nodes.keywords_section:
+        case schema.nodes.keywords:
             return 'MPSectionCategory:keywords';
         case schema.nodes.toc_section:
             return 'MPSectionCategory:toc';
         case schema.nodes.graphical_abstract_section:
             return 'MPSectionCategory:abstract-graphical';
-        case schema.nodes.affiliations_section:
+        case schema.nodes.affiliations:
             return 'MPSectionCategory:affiliations';
-        case schema.nodes.contributors_section:
+        case schema.nodes.contributors:
             return 'MPSectionCategory:contributors';
         default:
             return node.attrs.category || undefined;
@@ -117,6 +117,32 @@ export const chooseSecType = (sectionCategory) => {
             return suffix;
     }
 };
+export const chooseCoreSectionBySection = (section) => {
+    switch (section) {
+        case 'MPSectionCategory:abstract':
+        case 'MPSectionCategory:abstract-teaser':
+        case 'MPSectionCategory:abstract-graphical':
+            return 'MPSectionCategory:abstracts';
+        case 'MPSectionCategory:acknowledgement':
+        case 'MPSectionCategory:availability':
+        case 'MPSectionCategory:conclusions':
+        case 'MPSectionCategory:bibliography':
+        case 'MPSectionCategory:discussion':
+        case 'MPSectionCategory:endnotes':
+        case 'MPSectionCategory:appendices':
+        case 'MPSectionCategory:competing-interests':
+        case 'MPSectionCategory:con':
+        case 'MPSectionCategory:deceased':
+        case 'MPSectionCategory:ethics-statement':
+        case 'MPSectionCategory:financial-disclosure':
+        case 'MPSectionCategory:supplementary-material':
+        case 'MPSectionCategory:supported-by':
+        case 'MPSectionCategory:abbreviations':
+        case 'MPSectionCategory:results':
+            return 'MPSectionCategory:backmatter';
+    }
+    return 'MPSectionCategory:body';
+};
 export const chooseSectionCategoryByType = (secType) => {
     switch (secType) {
         case 'abstract':

package/dist/types/lib/utils.d.ts

@@ -27,3 +27,4 @@ export declare const findParentNodeClosestToPos: ($pos: ResolvedPos, predicate:
     node: ProsemirrorNode;
 } | undefined;
 export declare const getTrimmedTextContent: (node: Element | Document, querySelector: string) => string | null | undefined;
+export declare const groupBy: <T, K extends string | number | symbol>(list: T[], getKey: (item: T) => K) => Record<K, T[]>;

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

@@ -44,7 +44,7 @@ export * from './nodes/inline_equation';
 export * from './nodes/inline_footnote';
 export * from './nodes/keyword';
 export * from './nodes/keywords_element';
-export * from './nodes/keywords_section';
+export * from './nodes/keywords';
 export * from './nodes/link';
 export * from './nodes/list';
 export * from './nodes/listing';
@@ -69,6 +69,6 @@ export * from './nodes/meta_section';
 export * from './nodes/contributor';
 export * from './nodes/table_element_footer';
 export * from './nodes/title';
-export * from './nodes/affiliations_section';
-export * from './nodes/contributors_section';
+export * from './nodes/affiliations';
+export * from './nodes/contributors';
 export declare const schema: Schema<Nodes, Marks>;

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

@@ -0,0 +1,11 @@
+import { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+interface Attrs {
+    id: string;
+}
+export interface AffiliationsNode extends ManuscriptNode {
+    attrs: Attrs;
+}
+export declare const affiliations: NodeSpec;
+export declare const isAffiliationsNode: (node: ManuscriptNode) => node is AffiliationsNode;
+export {};

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

@@ -0,0 +1,12 @@
+import { NodeSpec } from 'prosemirror-model';
+import { ManuscriptNode } from '../types';
+interface Attrs {
+    id: string;
+    contents: string;
+}
+export interface ContributorsNode extends ManuscriptNode {
+    attrs: Attrs;
+}
+export declare const contributors: NodeSpec;
+export declare const isContributorsNode: (node: ManuscriptNode) => node is ContributorsNode;
+export {};

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

@@ -0,0 +1,17 @@
+/*!
+ * © 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 declare const coreSection: NodeSpec;

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

@@ -18,7 +18,6 @@ import { ManuscriptNode } from '../types';
 import { CommentNode } from './comment';
 interface Attrs {
     id: string;
-    contents: string;
     comments?: CommentNode[];
 }
 export interface KeywordNode extends ManuscriptNode {

package/dist/types/schema/nodes/{keywords_group.d.ts → keyword_group.d.ts}

@@ -18,9 +18,9 @@ import { ManuscriptNode } from '../types';
 interface Attrs {
     id: string;
 }
-export interface KeywordsGroupNode extends ManuscriptNode {
+export interface KeywordGroupNode extends ManuscriptNode {
     attrs: Attrs;
 }
-export declare const keywordsGroup: NodeSpec;
-export declare const isKeywordsGroupNode: (node: ManuscriptNode) => node is KeywordsGroupNode;
+export declare const keywordGroup: NodeSpec;
+export declare const isKeywordGroupNode: (node: ManuscriptNode) => node is KeywordGroupNode;
 export {};

package/dist/types/schema/nodes/{keywords_section.d.ts → keywords.d.ts}

@@ -18,9 +18,9 @@ import { ManuscriptNode } from '../types';
 interface Attrs {
     id: string;
 }
-export interface KeywordsSectionNode extends ManuscriptNode {
+export interface KeywordsNode extends ManuscriptNode {
     attrs: Attrs;
 }
-export declare const keywordsSection: NodeSpec;
-export declare const isKeywordsSectionNode: (node: ManuscriptNode) => node is KeywordsSectionNode;
+export declare const keywords: NodeSpec;
+export declare const isKeywordsNode: (node: ManuscriptNode) => node is KeywordsNode;
 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' | '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' | 'keyword' | 'keywords_element' | 'keywords_group' | 'keywords_section' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'missing_figure' | 'ordered_list' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'section_title_plain' | 'table' | 'table_body' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'text' | 'toc_element' | 'toc_section' | 'affiliation' | 'meta_section' | 'contributor' | 'table_element_footer' | 'title' | 'affiliations_section' | 'contributors_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' | 'keyword' | 'keywords_element' | 'keyword_group' | 'keywords' | 'link' | 'list_item' | 'listing' | 'listing_element' | 'manuscript' | 'abstracts' | 'body' | 'backmatter' | 'missing_figure' | 'ordered_list' | 'paragraph' | 'placeholder' | 'placeholder_element' | 'pullquote_element' | 'section' | 'section_label' | 'section_title' | 'section_title_plain' | 'table' | 'table_body' | 'table_cell' | 'table_element' | 'table_row' | 'table_colgroup' | 'table_col' | 'text' | 'toc_element' | 'toc_section' | 'affiliation' | 'meta_section' | 'contributor' | 'table_element_footer' | 'title' | 'affiliations' | 'contributors';
 export type ManuscriptSchema = Schema<Nodes, Marks>;
 export type ManuscriptEditorState = EditorState;
 export type ManuscriptEditorView = EditorView;

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

@@ -25,13 +25,15 @@ export declare class Decoder {
     private readonly allowMissingElements;
     private comments;
     private creators;
+    private createTitleNode;
+    private createAffiliationsNode;
+    private createContributorsNode;
+    private createKeywordsNode;
     private createMetaSectionNode;
     private createCommentListNode;
-    private handleMissingRootSectionNodes;
-    private createAffiliationSectionNode;
-    private createContributorSectionNode;
-    private createTitleNode;
     private createRootSectionNodes;
+    private ensureCoreSectionsExist;
+    private createAndFill;
     private createCommentsNode;
     private getComments;
     private extractListing;
@@ -41,11 +43,9 @@ export declare class Decoder {
     createArticleNode: (manuscriptID?: string) => ManuscriptNode;
     addGeneratedLabels: (sections: Section[]) => Section[];
     parseContents: (contents: string, wrapper?: string, commentAnnotations?: CommentAnnotation[], options?: ParseOptions) => ManuscriptNode;
-    private getKeywords;
     private getManuscriptID;
     private getFigcaption;
     private createTable;
     private createTableElementFooter;
     private createListing;
-    private getKeywordGroups;
 }

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

@@ -20,7 +20,7 @@ export declare const inlineContents: (node: ManuscriptNode) => string;
 export declare const inlineText: (node: ManuscriptNode) => string;
 export declare const modelFromNode: (node: ManuscriptNode, parent: ManuscriptNode, path: string[], priority: PrioritizedValue) => {
     model: Model;
-    commentAnnotationsMap: Map<string, Build<CommentAnnotation>>;
+    comments: Build<CommentAnnotation>[];
 };
 interface PrioritizedValue {
     value: number;

package/dist/types/transformer/section-category.d.ts

@@ -25,6 +25,7 @@ export declare const guessSectionCategory: (elements: Element[]) => SectionCateg
 export declare const buildSectionCategory: (node: ManuscriptNode) => SectionCategory | undefined;
 export declare const chooseJatsFnType: (footnoteType: string) => string;
 export declare const chooseSecType: (sectionCategory: SectionCategory) => SecType;
+export declare const chooseCoreSectionBySection: (section: string) => string;
 export declare const chooseSectionCategoryByType: (secType: string) => SectionCategory | undefined;
 export declare const chooseSectionCategory: (section: HTMLElement) => SectionCategory | undefined;
 export declare const chooseSectionCategoryFromTitle: (title: string | null) => SectionCategory | undefined;

package/package.json

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

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

@@ -1,11 +0,0 @@
-import { NodeSpec } from 'prosemirror-model';
-import { ManuscriptNode } from '../types';
-interface Attrs {
-    id: string;
-}
-export interface AffiliationsSectionNode extends ManuscriptNode {
-    attrs: Attrs;
-}
-export declare const affiliationsSection: NodeSpec;
-export declare const isAffiliationsSectionNode: (node: ManuscriptNode) => node is AffiliationsSectionNode;
-export {};

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

@@ -1,12 +0,0 @@
-import { NodeSpec } from 'prosemirror-model';
-import { ManuscriptNode } from '../types';
-interface Attrs {
-    id: string;
-    contents: string;
-}
-export interface ContributorsSectionNode extends ManuscriptNode {
-    attrs: Attrs;
-}
-export declare const contributorsSection: NodeSpec;
-export declare const isContributorsSectionNode: (node: ManuscriptNode) => node is ContributorsSectionNode;
-export {};