@manuscripts/transform 1.2.4-LEAN-2066 → 1.2.5

package/dist/es/transformer/encode.js

@@ -16,7 +16,7 @@
 import { DOMSerializer } from 'prosemirror-model';
 import serializeToXML from 'w3c-xmlserializer';
 import { iterateChildren } from '../lib/utils';
-import { isHighlightMarkerNode, isSectionNode, schema, } from '../schema';
+import { hasGroup, isHighlightMarkerNode, isSectionNode, schema, } from '../schema';
 import { buildAttribution } from './builders';
 import { extractHighlightMarkers, isHighlightableModel, } from './highlight-markers';
 import { nodeTypesMap } from './node-types';
@@ -154,6 +154,15 @@ const childElements = (node) => {
     });
     return nodes;
 };
+const sectionChildElementIds = (node) => {
+    const nodes = [];
+    node.forEach((childNode) => {
+        if (!hasGroup(childNode.type, 'sections')) {
+            nodes.push(childNode);
+        }
+    });
+    return nodes.map((childNode) => childNode.attrs.id).filter((id) => id);
+};
 const attributeOfNodeType = (node, type, attribute) => {
     for (const child of iterateChildren(node)) {
         if (child.type.name === type) {
@@ -393,21 +402,18 @@ const encoders = {
         SVGGlyphs: svgDefs(node.attrs.SVGRepresentation),
     }),
     keyword: (node, parent) => ({
-        containedGroup: parent.attrs.id,
+        containerID: parent.attrs.id,
         name: keywordContents(node),
     }),
     keywords_element: (node) => ({
-        contents: '<div></div>',
+        contents: elementContents(node),
         elementType: 'div',
         paragraphStyle: node.attrs.paragraphStyle || undefined,
     }),
-    keywords_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),
+        title: inlineContentsOfNodeType(node, node.type.schema.nodes.section_title_plain),
         path: path.concat([node.attrs.id]),
         elementIDs: childElements(node)
             .map((childNode) => childNode.attrs.id)
@@ -444,9 +450,7 @@ const encoders = {
         label: inlineContentsOfNodeType(node, node.type.schema.nodes.section_label) ||
             undefined,
         path: path.concat([node.attrs.id]),
-        elementIDs: childElements(node)
-            .map((childNode) => childNode.attrs.id)
-            .filter((id) => id),
+        elementIDs: sectionChildElementIds(node),
         titleSuppressed: node.attrs.titleSuppressed || undefined,
         generatedLabel: node.attrs.generatedLabel || undefined,
         pageBreakStyle: node.attrs.pageBreakStyle || undefined,

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

@@ -38,7 +38,6 @@ export const nodeTypesMap = new Map([
     [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.listing, ObjectTypes.Listing],
     [schema.nodes.listing_element, ObjectTypes.ListingElement],
     [schema.nodes.manuscript, ObjectTypes.Manuscript],

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

@@ -50,4 +50,3 @@ export const isManuscript = hasObjectType(ObjectTypes.Manuscript);
 export const isTable = hasObjectType(ObjectTypes.Table);
 export const isUserProfile = hasObjectType(ObjectTypes.UserProfile);
 export const isCommentAnnotation = hasObjectType(ObjectTypes.CommentAnnotation);
-export const isKeyword = hasObjectType(ObjectTypes.Keyword);

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

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { ObjectTypes } from '@manuscripts/json-schema';
+import sectionCategories from '@manuscripts/data/dist/shared/section-categories.json';
+import { ObjectTypes, } from '@manuscripts/json-schema';
 import { schema } from '../schema';
 const sectionNodeTypes = [
     schema.nodes.bibliography_section,
@@ -22,6 +23,17 @@ const sectionNodeTypes = [
     schema.nodes.section,
     schema.nodes.toc_section,
 ];
+const sectionCategoriesMap = new Map(sectionCategories.map((section) => [
+    section._id,
+    section,
+]));
+export const getSectionTitles = (sectionCategory) => {
+    const category = sectionCategoriesMap.get(sectionCategory);
+    if (category) {
+        return category.titles.length ? category.titles : [' '];
+    }
+    throw new Error(`${sectionCategory} not found in section categories`);
+};
 export const isAnySectionNode = (node) => sectionNodeTypes.includes(node.type);
 export const chooseSectionNodeType = (category) => {
     switch (category) {
@@ -152,6 +164,12 @@ export const chooseSectionCategoryByType = (secType) => {
             return 'MPSectionCategory:supported-by';
         case 'ethics-statement':
             return 'MPSectionCategory:ethics-statement';
+        case 'body':
+            return 'MPSectionCategory:body';
+        case 'backmatter':
+            return 'MPSectionCategory:backmatter';
+        case 'abstracts':
+            return 'MPSectionCategory:abstracts';
         default:
             return undefined;
     }

package/dist/types/jats/importer/jats-body-transformations.d.ts

@@ -22,11 +22,16 @@ export declare const jatsBodyTransformations: {
     createFootnotes(footnoteGroups: Element[], createElement: (tagName: string) => HTMLElement): HTMLElement;
     createAppendixSection(app: Element, createElement: (tagName: string) => HTMLElement): HTMLElement;
     createFloatsGroupSection(floatsGroup: Element, createElement: (tagName: string) => HTMLElement): HTMLElement;
+    moveAbstractsIntoContainer(doc: Document, abstractsContainer: Element, createElement: (tagName: string) => HTMLElement): void;
+    wrapBodySections(doc: Document, bodyContainer: Element): void;
+    moveBackSectionsIntoContainer(doc: Document, backmatterContainer: Element): void;
+    moveAcknowledgmentsIntoContainer(doc: Document, backmatterContainer: Element, createElement: (tagName: string) => HTMLElement): void;
+    moveAppendicesIntoContainer(doc: Document, backmatterContainer: Element, createElement: (tagName: string) => HTMLElement): void;
+    moveBibliographyIntoContainer(doc: Document, backmatterContainer: Element, references: BibliographyItem[] | null, createElement: (tagName: string) => HTMLElement): void;
     moveSectionsToBody(doc: Document, body: Element, references: BibliographyItem[] | null, createElement: (tagName: string) => HTMLElement): void;
-    mapFootnotesToSections(doc: Document, body: Element, createElement: (tagName: string) => HTMLElement): void;
+    mapFootnotesToSections(doc: Document, backmatterContainer: Element, createElement: (tagName: string) => HTMLElement): void;
     moveCaptionsToEnd(body: Element): void;
     moveTableFooterToEnd(body: Element): void;
     moveFloatsGroupToBody(doc: Document, body: Element, createElement: (tagName: string) => HTMLElement): void;
     moveBlockNodesFromParagraph(doc: Document, body: Element, createElement: (tagName: string) => HTMLElement): void;
-    moveKeywordsToBody(document: Document, body: Element, createElement: (tagName: string) => HTMLElement): void;
 };

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

@@ -13,7 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Journal } from '@manuscripts/json-schema';
+import { Journal, Keyword, KeywordGroup } from '@manuscripts/json-schema';
+import { Build } from '../../transformer/builders';
 export declare const jatsFrontParser: {
     parseCounts(counts: Element | null | undefined): {
         wordCount: number | undefined;
@@ -27,6 +28,10 @@ export declare const jatsFrontParser: {
         }[] | undefined;
     } | undefined;
     parseJournal(journalMeta: Element | null): Partial<Journal>;
+    parseKeywords(keywordGroupNodes?: NodeListOf<Element> | null): {
+        groups: Build<KeywordGroup>[];
+        keywords: Build<Keyword>[];
+    };
     parseDates(historyNode: Element | null): {
         acceptanceDate?: number | undefined;
         correctionDate?: number | undefined;
@@ -35,18 +40,18 @@ export declare const jatsFrontParser: {
         revisionReceiveDate?: number | undefined;
         receiveDate?: number | undefined;
     } | undefined;
-    parseSupplements(supplementNodes: Element[] | null): import("../../transformer/builders").Build<import("@manuscripts/json-schema").Supplement>[];
+    parseSupplements(supplementNodes: Element[] | null): Build<import("@manuscripts/json-schema").Supplement>[];
     parseAffiliationNodes(affiliationNodes: Element[]): {
-        affiliations: import("../../transformer/builders").Build<import("@manuscripts/json-schema").Affiliation>[];
+        affiliations: Build<import("@manuscripts/json-schema").Affiliation>[];
         affiliationIDs: Map<string, string>;
     };
     parseFootnoteNodes(footnoteNodes: Element[]): {
-        footnotes: import("../../transformer/builders").Build<import("@manuscripts/json-schema").Footnote>[];
+        footnotes: Build<import("@manuscripts/json-schema").Footnote>[];
         footnoteIDs: Map<string, string>;
     };
     parseCorrespNodes(correspNodes: Element[]): {
-        correspondingList: import("../../transformer/builders").Build<import("@manuscripts/json-schema").Corresponding>[];
+        correspondingList: Build<import("@manuscripts/json-schema").Corresponding>[];
         correspondingIDs: Map<string, string>;
     };
-    parseAuthorNodes(authorNodes: Element[], affiliationIDs: Map<string, string>, footnoteIDs: Map<string, string>, correspondingIDs: Map<string, string>): import("../../transformer/builders").Build<import("@manuscripts/json-schema").Contributor>[];
+    parseAuthorNodes(authorNodes: Element[], affiliationIDs: Map<string, string>, footnoteIDs: Map<string, string>, correspondingIDs: Map<string, string>): Build<import("@manuscripts/json-schema").Contributor>[];
 };

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

@@ -63,6 +63,8 @@ export declare class JATSExporter {
     private fixBody;
     private changeTag;
     private fixTable;
+    private unwrapBody;
+    private removeBackContainer;
     private moveAbstracts;
     private moveSectionsToBack;
     sectionToFootnote: (section: Element, fnType: string) => HTMLElement;

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';
+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_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';
 export type ManuscriptSchema = Schema<Nodes, Marks>;
 export type ManuscriptEditorState = EditorState;
 export type ManuscriptEditorView = EditorView;

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

@@ -37,5 +37,4 @@ export declare class Decoder {
     private getKeywords;
     private getManuscriptID;
     private getFigcaption;
-    private getKeywordGroups;
 }

package/dist/types/transformer/object-types.d.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { CommentAnnotation, Figure, Keyword, Manuscript, Model, ObjectTypes, Table } from '@manuscripts/json-schema';
+import { CommentAnnotation, Figure, Manuscript, Model, ObjectTypes, Table } from '@manuscripts/json-schema';
 import { ManuscriptModel, UserProfileWithAvatar } from './models';
 export declare enum ExtraObjectTypes {
     PlaceholderElement = "MPPlaceholderElement"
@@ -27,4 +27,3 @@ export declare const isManuscript: (model: Model) => model is Manuscript;
 export declare const isTable: (model: Model) => model is Table;
 export declare const isUserProfile: (model: Model) => model is UserProfileWithAvatar;
 export declare const isCommentAnnotation: (model: Model) => model is CommentAnnotation;
-export declare const isKeyword: (model: Model) => model is Keyword;

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

@@ -15,9 +15,10 @@
  */
 import { Element } from '@manuscripts/json-schema';
 import { ManuscriptNode, ManuscriptNodeType } from '../schema';
+export declare const getSectionTitles: (sectionCategory: SectionCategory) => string[];
 export declare const isAnySectionNode: (node: ManuscriptNode) => boolean;
-export type SectionCategory = 'MPSectionCategory:abstract' | 'MPSectionCategory:abstract-teaser' | 'MPSectionCategory:abstract-graphical' | 'MPSectionCategory:acknowledgement' | 'MPSectionCategory:availability' | 'MPSectionCategory:bibliography' | 'MPSectionCategory:conclusions' | 'MPSectionCategory:discussion' | 'MPSectionCategory:endnotes' | 'MPSectionCategory:introduction' | 'MPSectionCategory:keywords' | 'MPSectionCategory:materials-method' | 'MPSectionCategory:results' | 'MPSectionCategory:toc' | 'MPSectionCategory:floating-element' | 'MPSectionCategory:appendices' | 'MPSectionCategory:competing-interests' | 'MPSectionCategory:financial-disclosure' | 'MPSectionCategory:con' | 'MPSectionCategory:deceased' | 'MPSectionCategory:equal' | 'MPSectionCategory:present-address' | 'MPSectionCategory:presented-at' | 'MPSectionCategory:previously-at' | 'MPSectionCategory:supplementary-material' | 'MPSectionCategory:supported-by' | 'MPSectionCategory:ethics-statement';
-export type SecType = 'abstract' | 'abstract-teaser' | 'abstract-graphical' | 'acknowledgments' | 'availability' | 'bibliography' | 'conclusions' | 'data-availability' | 'discussion' | 'endnotes' | 'intro' | 'keywords' | 'materials' | 'methods' | 'results' | 'toc' | 'floating-element' | 'appendices' | 'competing-interests' | 'financial-disclosure' | 'con' | 'deceased' | 'equal' | 'present-address' | 'presented-at' | 'previously-at' | 'supplementary-material' | 'supported-by' | 'ethics-statement';
+export type SectionCategory = 'MPSectionCategory:abstract' | 'MPSectionCategory:abstract-teaser' | 'MPSectionCategory:abstract-graphical' | 'MPSectionCategory:acknowledgement' | 'MPSectionCategory:availability' | 'MPSectionCategory:bibliography' | 'MPSectionCategory:conclusions' | 'MPSectionCategory:discussion' | 'MPSectionCategory:endnotes' | 'MPSectionCategory:introduction' | 'MPSectionCategory:keywords' | 'MPSectionCategory:materials-method' | 'MPSectionCategory:results' | 'MPSectionCategory:toc' | 'MPSectionCategory:floating-element' | 'MPSectionCategory:appendices' | 'MPSectionCategory:competing-interests' | 'MPSectionCategory:financial-disclosure' | 'MPSectionCategory:con' | 'MPSectionCategory:deceased' | 'MPSectionCategory:equal' | 'MPSectionCategory:present-address' | 'MPSectionCategory:presented-at' | 'MPSectionCategory:previously-at' | 'MPSectionCategory:supplementary-material' | 'MPSectionCategory:supported-by' | 'MPSectionCategory:ethics-statement' | 'MPSectionCategory:body' | 'MPSectionCategory:abstracts' | 'MPSectionCategory:backmatter';
+export type SecType = 'abstract' | 'abstract-teaser' | 'abstract-graphical' | 'acknowledgments' | 'availability' | 'bibliography' | 'conclusions' | 'data-availability' | 'discussion' | 'endnotes' | 'intro' | 'keywords' | 'materials' | 'methods' | 'results' | 'toc' | 'floating-element' | 'appendices' | 'competing-interests' | 'financial-disclosure' | 'con' | 'deceased' | 'equal' | 'present-address' | 'presented-at' | 'previously-at' | 'supplementary-material' | 'supported-by' | 'ethics-statement' | 'abstracts' | 'body' | 'backmatter';
 export declare const chooseSectionNodeType: (category?: SectionCategory) => ManuscriptNodeType;
 export declare const chooseSectionLableName: (type?: SecType) => string;
 export declare const guessSectionCategory: (elements: Element[]) => SectionCategory | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/transform",
   "description": "ProseMirror transformer for Manuscripts applications",
-  "version": "1.2.4-LEAN-2066",
+  "version": "1.2.5",
   "repository": "github:Atypon-OpenSource/manuscripts-transform",
   "license": "Apache-2.0",
   "main": "dist/cjs",
@@ -29,7 +29,7 @@
     "version": "yarn build"
   },
   "dependencies": {
-    "@manuscripts/json-schema": "^2.0.1",
+    "@manuscripts/json-schema": "^2.0.2",
     "debug": "^4.3.4",
     "jszip": "^3.10.1",
     "mathjax-full": "^3.2.2",

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

@@ -1,48 +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.isKeywordsGroupNode = exports.keywordsGroup = void 0;
-exports.keywordsGroup = {
-    content: 'keyword*',
-    attrs: {
-        id: { default: '' },
-        type: { default: '' },
-        dataTracked: { default: null },
-    },
-    group: 'block',
-    selectable: false,
-    parseDOM: [
-        {
-            tag: 'div.keywords',
-        },
-    ],
-    toDOM: (node) => {
-        const keywordsGroupNode = node;
-        return [
-            'div',
-            {
-                id: keywordsGroupNode.attrs.id,
-                class: 'keywords',
-                spellcheck: 'false',
-                contenteditable: false,
-            },
-            0,
-        ];
-    },
-};
-const isKeywordsGroupNode = (node) => node.type === node.type.schema.nodes.keywords_group;
-exports.isKeywordsGroupNode = isKeywordsGroupNode;

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

@@ -1,44 +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 keywordsGroup = {
-    content: 'keyword*',
-    attrs: {
-        id: { default: '' },
-        type: { default: '' },
-        dataTracked: { default: null },
-    },
-    group: 'block',
-    selectable: false,
-    parseDOM: [
-        {
-            tag: 'div.keywords',
-        },
-    ],
-    toDOM: (node) => {
-        const keywordsGroupNode = node;
-        return [
-            'div',
-            {
-                id: keywordsGroupNode.attrs.id,
-                class: 'keywords',
-                spellcheck: 'false',
-                contenteditable: false,
-            },
-            0,
-        ];
-    },
-};
-export const isKeywordsGroupNode = (node) => node.type === node.type.schema.nodes.keywords_group;

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

@@ -1,26 +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';
-interface Attrs {
-    id: string;
-}
-export interface KeywordsGroupNode extends ManuscriptNode {
-    attrs: Attrs;
-}
-export declare const keywordsGroup: NodeSpec;
-export declare const isKeywordsGroupNode: (node: ManuscriptNode) => node is KeywordsGroupNode;
-export {};