@manuscripts/body-editor 1.6.20 → 1.7.0

package/dist/cjs/configs/editor-plugins.js

@@ -25,6 +25,7 @@ const prosemirror_dropcursor_1 = require("prosemirror-dropcursor");
 const prosemirror_history_1 = require("prosemirror-history");
 const prosemirror_tables_1 = require("prosemirror-tables");
 const keys_1 = __importDefault(require("../keys"));
+const affiliations_1 = __importDefault(require("../plugins/affiliations"));
 const bibliography_1 = __importDefault(require("../plugins/bibliography"));
 const comment_annotation_1 = __importDefault(require("../plugins/comment_annotation"));
 const elements_1 = __importDefault(require("../plugins/elements"));
@@ -55,6 +56,7 @@ exports.default = (props) => {
         (0, toc_1.default)(props),
         (0, bibliography_1.default)(props),
         (0, objects_1.default)(props),
+        (0, affiliations_1.default)(),
         (0, comment_annotation_1.default)(props),
         (0, paragraphs_1.default)(),
         (0, placeholder_1.default)(),

package/dist/cjs/configs/editor-views.js

@@ -18,6 +18,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const affiliation_1 = __importDefault(require("../views/affiliation"));
+const affiliations_1 = __importDefault(require("../views/affiliations"));
 const bibliography_element_editable_1 = __importDefault(require("../views/bibliography_element_editable"));
 const blockquote_element_editable_1 = __importDefault(require("../views/blockquote_element_editable"));
 const bullet_list_editable_1 = __importDefault(require("../views/bullet_list_editable"));
@@ -58,6 +60,8 @@ exports.default = (props, dispatch) => {
         citation: (0, citation_editable_1.default)(props, dispatch),
         cross_reference: (0, cross_reference_editable_1.default)(props, dispatch),
         contributors: (0, contributors_1.default)(props, dispatch),
+        affiliations: (0, affiliations_1.default)(props, dispatch),
+        affiliation: (0, affiliation_1.default)(props, dispatch),
         equation: (0, equation_editable_1.default)(props),
         equation_element: (0, equation_element_editable_1.default)(props),
         figure: (0, figure_editable_1.default)(props, dispatch),

package/dist/cjs/index.js

@@ -52,4 +52,5 @@ Object.defineProperty(exports, "commentScroll", { enumerable: true, get: functio
 Object.defineProperty(exports, "isThereSelector", { enumerable: true, get: function () { return comment_annotation_1.isThereSelector; } });
 Object.defineProperty(exports, "isHighlightComment", { enumerable: true, get: function () { return comment_annotation_1.isHighlightComment; } });
 __exportStar(require("./lib/utils"), exports);
+__exportStar(require("./lib/track-changes-utils"), exports);
 __exportStar(require("./useEditor"), exports);

package/dist/cjs/lib/track-changes-utils.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTracked = exports.getChangeClasses = exports.isPendingSetAttrs = exports.isPending = exports.isPendingInsert = exports.isDeleted = exports.isRejectedInsert = void 0;
+exports.getActualAttrs = exports.isTracked = exports.getChangeClasses = exports.isPendingSetAttrs = exports.isPending = exports.isPendingInsert = exports.isDeleted = exports.isRejectedInsert = void 0;
 function isRejectedInsert(node) {
     if (node.attrs.dataTracked) {
         const changes = node.attrs.dataTracked;
@@ -80,3 +80,13 @@ function isTracked(node) {
     return false;
 }
 exports.isTracked = isTracked;
+function getActualAttrs(node) {
+    const attrs = node.attrs;
+    if (attrs.dataTracked &&
+        attrs.dataTracked[0].status === 'rejected' &&
+        attrs.dataTracked[0].operation === 'set_attrs') {
+        return attrs.dataTracked[0].oldAttrs;
+    }
+    return attrs;
+}
+exports.getActualAttrs = getActualAttrs;

package/dist/cjs/plugins/affiliations.js

@@ -0,0 +1,118 @@
+"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.buildPluginState = exports.affiliationsKey = void 0;
+const transform_1 = require("@manuscripts/transform");
+const prosemirror_state_1 = require("prosemirror-state");
+const prosemirror_view_1 = require("prosemirror-view");
+const track_changes_utils_1 = require("../lib/track-changes-utils");
+exports.affiliationsKey = new prosemirror_state_1.PluginKey('affiliations');
+const buildPluginState = (doc) => {
+    const contributors = [];
+    const affiliations = [];
+    doc.descendants((node, pos) => {
+        if ((0, track_changes_utils_1.isDeleted)(node)) {
+            return;
+        }
+        if ((0, transform_1.isAffiliationNode)(node)) {
+            affiliations.push([node, pos]);
+        }
+        if ((0, transform_1.isContributorNode)(node)) {
+            contributors.push([node, pos]);
+        }
+    });
+    const iAffiliations = new Set();
+    contributors
+        .sort(([a], [b]) => {
+        return (Number((0, track_changes_utils_1.getActualAttrs)(a).priority) - Number((0, track_changes_utils_1.getActualAttrs)(b).priority));
+    })
+        .forEach(([author]) => {
+        (0, track_changes_utils_1.getActualAttrs)(author).affiliations.forEach((aff) => {
+            iAffiliations.add(aff);
+        });
+    });
+    const indexedAffiliationIds = new Map([...iAffiliations].map((id, i) => [id, i + 1]));
+    return {
+        indexedAffiliationIds,
+        contributors,
+        affiliations,
+    };
+};
+exports.buildPluginState = buildPluginState;
+let count = 0;
+exports.default = () => {
+    return new prosemirror_state_1.Plugin({
+        key: exports.affiliationsKey,
+        state: {
+            init(config, instance) {
+                return (0, exports.buildPluginState)(instance.doc);
+            },
+            apply(tr, value, oldState, newState) {
+                const prevPluginState = exports.affiliationsKey.getState(oldState);
+                if (!tr.docChanged && prevPluginState) {
+                    return prevPluginState;
+                }
+                else {
+                    return (0, exports.buildPluginState)(newState.doc);
+                }
+            },
+        },
+        appendTransaction(transactions, oldState, newState) {
+            const { indexedAffiliationIds } = exports.affiliationsKey.getState(newState);
+            const oldPluginState = exports.affiliationsKey.getState(oldState);
+            const { tr } = newState;
+            const affiliations = [];
+            newState.doc.descendants((node, pos) => {
+                if ((0, track_changes_utils_1.isDeleted)(node)) {
+                    return;
+                }
+                if ((0, transform_1.isAffiliationNode)(node)) {
+                    affiliations.push([node, pos]);
+                }
+            });
+            for (const [id] of oldPluginState.indexedAffiliationIds.entries()) {
+                if (!indexedAffiliationIds.has(id)) {
+                    const affiliation = affiliations.find(([node]) => node.attrs.id === id);
+                    if (affiliation && !(0, track_changes_utils_1.isPendingInsert)(affiliation[0])) {
+                        tr.delete(affiliation[1], affiliation[1] + affiliation[0].nodeSize);
+                    }
+                }
+            }
+            tr.setMeta('origin', 'affiliations');
+            return tr;
+        },
+        props: {
+            decorations: (state) => {
+                const decorations = [];
+                const allNodes = [];
+                state.doc.descendants((node, pos) => {
+                    if ((0, transform_1.isAffiliationNode)(node) || (0, transform_1.isContributorNode)(node)) {
+                        allNodes.push([node, pos]);
+                    }
+                });
+                if (allNodes.length) {
+                    allNodes.forEach(([node, pos]) => {
+                        decorations.push(prosemirror_view_1.Decoration.node(pos, pos + node.nodeSize, {}, {
+                            refresh: count++,
+                        }));
+                    });
+                }
+                return prosemirror_view_1.DecorationSet.create(state.doc, decorations);
+            },
+        },
+    });
+};

package/dist/cjs/views/affiliation.js

@@ -0,0 +1,75 @@
+"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.AffiliationView = void 0;
+const track_changes_utils_1 = require("../lib/track-changes-utils");
+const affiliations_1 = require("../plugins/affiliations");
+const base_node_view_1 = require("./base_node_view");
+const creators_1 = require("./creators");
+class AffiliationView extends base_node_view_1.BaseNodeView {
+    constructor() {
+        super(...arguments);
+        this.initialise = () => {
+            this.createDOM();
+        };
+        this.updateContents = () => {
+            var _a;
+            const attrs = this.node.attrs;
+            const pluginState = affiliations_1.affiliationsKey.getState(this.view.state);
+            this.dom.innerHTML = this.formatAddress((0, track_changes_utils_1.getActualAttrs)(this.node));
+            if (pluginState === null || pluginState === void 0 ? void 0 : pluginState.indexedAffiliationIds) {
+                const order = pluginState.indexedAffiliationIds.get(attrs.id);
+                this.dom.innerHTML = order
+                    ? `<b>${order}</b> ${this.dom.innerHTML}`
+                    : this.dom.innerHTML;
+                this.dom.setAttribute('style', 'order: ' + (order || (pluginState === null || pluginState === void 0 ? void 0 : pluginState.affiliations.length) + 1));
+            }
+            if ((_a = attrs.dataTracked) === null || _a === void 0 ? void 0 : _a.length) {
+                this.dom.setAttribute('data-track-status', attrs.dataTracked[0].status);
+                this.dom.setAttribute('data-track-op', attrs.dataTracked[0].operation);
+            }
+            else {
+                this.dom.removeAttribute('data-track-status');
+                this.dom.removeAttribute('data-track-type');
+            }
+        };
+        this.createDOM = () => {
+            this.dom = document.createElement('div');
+            this.dom.classList.add('affiliation');
+            this.dom.setAttribute('id', this.node.attrs.id);
+            this.updateContents();
+        };
+        this.ignoreMutation = () => true;
+        this.stopEvent = () => true;
+        this.formatAddress = (affiliation) => {
+            const { department, institution, addressLine1, city, county, country, postCode, } = affiliation;
+            return [
+                department,
+                institution,
+                addressLine1,
+                city,
+                county,
+                country,
+                postCode,
+            ]
+                .filter(Boolean)
+                .join(', ');
+        };
+    }
+}
+exports.AffiliationView = AffiliationView;
+exports.default = (0, creators_1.createNodeView)(AffiliationView);

package/dist/cjs/views/affiliations.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AffiliationsView = void 0;
+const block_view_1 = __importDefault(require("./block_view"));
+const creators_1 = require("./creators");
+class AffiliationsView extends block_view_1.default {
+    constructor() {
+        super(...arguments);
+        this.ignoreMutation = () => true;
+        this.stopEvent = () => true;
+        this.createElement = () => {
+            this.contentDOM = document.createElement(this.elementType);
+            this.contentDOM.className = 'block';
+            this.contentDOM.setAttribute('contenteditable', 'false');
+            this.dom.setAttribute('contenteditable', 'false');
+            this.dom.appendChild(this.contentDOM);
+        };
+    }
+}
+exports.AffiliationsView = AffiliationsView;
+exports.default = (0, creators_1.createNodeView)(AffiliationsView);

package/dist/cjs/views/contributors.js

@@ -4,32 +4,171 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContributorsView = void 0;
-const base_node_view_1 = require("./base_node_view");
+const style_guide_1 = require("@manuscripts/style-guide");
+const transform_1 = require("@manuscripts/transform");
+const track_changes_utils_1 = require("../lib/track-changes-utils");
+const affiliations_1 = require("../plugins/affiliations");
+const block_view_1 = __importDefault(require("./block_view"));
 const creators_1 = require("./creators");
 const ReactSubView_1 = __importDefault(require("./ReactSubView"));
-class ContributorsView extends base_node_view_1.BaseNodeView {
+class ContributorsView extends block_view_1.default {
     constructor() {
         super(...arguments);
         this.initialise = () => {
             this.createDOM();
+            this.createGutter('block-gutter', this.gutterButtons().filter(Boolean));
+            this.createElement();
+            this.createGutter('action-gutter', this.actionGutterButtons().filter(Boolean));
+            this.updateContents();
+        };
+        this.updateContents = () => {
+            this.updateClasses();
+            this.updateAttributes();
+            this.container.innerHTML = '';
+            this.buildAuthors();
+            this.createEditButton();
+            this.createLegend();
+        };
+        this.buildAuthors = () => {
+            var _a;
+            const authors = [];
+            const authorsWrapper = document.createElement('div');
+            authorsWrapper.classList.add('contributors-list');
+            (_a = this.node.content) === null || _a === void 0 ? void 0 : _a.forEach((node) => {
+                if ((0, transform_1.isContributorNode)(node)) {
+                    authors.push(node);
+                }
+            });
+            authors
+                .sort((a, b) => Number(a.attrs.priority) - Number(b.attrs.priority))
+                .forEach((author, i) => {
+                if ((0, track_changes_utils_1.getActualAttrs)(author).role !== 'author') {
+                    return;
+                }
+                const jointAuthors = this.isJointFirstAuthor(authors, i);
+                authorsWrapper.appendChild(this.buildAuthor(author, jointAuthors));
+            });
+            this.container.appendChild(authorsWrapper);
+        };
+        this.buildAuthor = (node, isJointFirstAuthor) => {
+            var _a;
+            const pluginState = affiliations_1.affiliationsKey.getState(this.view.state);
+            const attrs = node.attrs;
+            const displayAttr = (0, track_changes_utils_1.getActualAttrs)(node);
+            const container = document.createElement('button');
+            container.classList.add('contributor');
+            container.setAttribute('id', attrs.id);
+            container.setAttribute('contenteditable', 'false');
+            if ((_a = attrs.dataTracked) === null || _a === void 0 ? void 0 : _a.length) {
+                container.setAttribute('data-track-status', attrs.dataTracked[0].status);
+                container.setAttribute('data-track-op', attrs.dataTracked[0].operation);
+            }
+            else {
+                container.removeAttribute('data-track-status');
+                container.removeAttribute('data-track-type');
+            }
+            const can = this.props.getCapabilities();
+            const disableEditButton = !can.editMetadata;
+            const { bibliographicName, isCorresponding, email, id } = displayAttr;
+            container.addEventListener('click', (e) => {
+                e.preventDefault();
+                if (!disableEditButton) {
+                    this.props.openAuthorEditing();
+                    this.props.selectAuthorForEditing(id);
+                }
+            });
+            const name = this.buildNameLiteral(bibliographicName);
+            container.innerHTML =
+                isCorresponding && email
+                    ? `<span class="name">${name} (${email})</span>`
+                    : `<span class="name">${name}</span>`;
+            const noteText = [];
+            if (pluginState === null || pluginState === void 0 ? void 0 : pluginState.indexedAffiliationIds) {
+                displayAttr.affiliations.map((af) => {
+                    const index = pluginState === null || pluginState === void 0 ? void 0 : pluginState.indexedAffiliationIds.get(af);
+                    if (index) {
+                        noteText.push(index.toString());
+                    }
+                });
+            }
+            if (isJointFirstAuthor) {
+                container.appendChild(this.createNote('†', 'Joint contributor'));
+            }
+            if (noteText) {
+                container.appendChild(this.createNote(noteText.join(',')));
+            }
+            if (displayAttr.isCorresponding) {
+                container.appendChild(this.createNote('*', 'Corresponding author'));
+            }
+            return container;
+        };
+        this.initials = (given) => given
+            ? given
+                .trim()
+                .split(' ')
+                .map((part) => part.substr(0, 1).toUpperCase() + '.')
+                .join('')
+            : '';
+        this.buildNameLiteral = ({ given = '', family = '', suffix = '' }) => {
+            if (!given && !family) {
+                return 'Unknown Author';
+            }
+            return [this.initials(given), family, suffix]
+                .filter((part) => part)
+                .join(' ');
+        };
+        this.isJointFirstAuthor = (authors, index) => {
+            const author = index === 0 ? authors[index] : authors[index - 1];
+            return Boolean(author.attrs.isJointContributor);
+        };
+        this.createElement = () => {
+            this.inner = document.createElement('div');
+            this.inner.classList.add('authors-container', 'block');
+            this.dom.appendChild(this.inner);
+            this.container = document.createElement('div');
+            this.container.classList.add('contributors');
+            this.inner.appendChild(this.container);
         };
         this.createDOM = () => {
             this.dom = document.createElement('div');
-            this.dom.classList.add('contributors');
+            this.dom.classList.add('block-container', `block-${this.node.type.name}`);
+        };
+        this.createEditButton = () => {
             const can = this.props.getCapabilities();
-            const { components: { AuthorsInlineViewContainer }, subscribeStore, } = this.props;
-            this.metadata = (0, ReactSubView_1.default)(this.props, AuthorsInlineViewContainer, {
-                showAuthorEditButton: true,
-                disableEditButton: !can.editMetadata,
-                subscribe: subscribeStore,
-            }, this.node, this.getPos, this.view, 'metadata-container');
-            if (this.metadata) {
-                this.dom.appendChild(this.metadata);
+            const button = (0, ReactSubView_1.default)(this.props, style_guide_1.SecondaryButton, {
+                mini: true,
+                onClick: this.props.openAuthorEditing,
+                className: 'edit-authors-button',
+                disabled: !can.editMetadata,
+                children: 'Edit Authors',
+            }, this.node, this.getPos, this.view);
+            this.container.appendChild(button);
+        };
+        this.createLegend = () => {
+            const state = affiliations_1.affiliationsKey.getState(this.view.state);
+            if (state === null || state === void 0 ? void 0 : state.contributors) {
+                const isThereJointContributor = state.contributors.find(([contributor]) => contributor.attrs.isJointContributor);
+                if (isThereJointContributor) {
+                    const element = document.createElement('p');
+                    element.classList.add('contributors-legend');
+                    element.innerHTML =
+                        '<span class="symbol">†</span>These authors contributed equally to this work.';
+                    this.container.appendChild(element);
+                }
             }
         };
         this.ignoreMutation = () => true;
         this.stopEvent = () => true;
     }
+    createNote(text = '', title = '') {
+        const el = document.createElement('span');
+        el.innerHTML = text;
+        if (title) {
+            el.setAttribute('title', title);
+        }
+        el.classList.add('contributor-note');
+        return el;
+    }
 }
 exports.ContributorsView = ContributorsView;
 exports.default = (0, creators_1.createNodeView)(ContributorsView);

package/dist/cjs/views/figure_editable.js

@@ -32,6 +32,7 @@ const style_guide_1 = require("@manuscripts/style-guide");
 const react_1 = require("react");
 const react_dom_1 = __importDefault(require("react-dom"));
 const FigureDropdown_1 = require("../components/views/FigureDropdown");
+const track_changes_utils_1 = require("../lib/track-changes-utils");
 const creators_1 = require("./creators");
 const figure_1 = require("./figure");
 const figure_uploader_1 = require("./figure_uploader");
@@ -50,12 +51,8 @@ class FigureEditableView extends figure_1.FigureView {
         };
         this.updateContents = () => {
             var _a, _b;
-            let attrs = this.node.attrs;
+            const attrs = (0, track_changes_utils_1.getActualAttrs)(this.node);
             if ((_a = this.node.attrs.dataTracked) === null || _a === void 0 ? void 0 : _a.length) {
-                if (this.node.attrs.dataTracked[0].status === 'rejected' &&
-                    this.node.attrs.dataTracked[0].operation === 'set_attrs') {
-                    attrs = this.node.attrs.dataTracked[0].oldAttrs;
-                }
                 this.dom.setAttribute('data-track-status', this.node.attrs.dataTracked[0].status);
                 this.dom.setAttribute('data-track-op', this.node.attrs.dataTracked[0].operation);
             }

package/dist/cjs/views/keyword.js

@@ -19,6 +19,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KeywordView = void 0;
+const prosemirror_state_1 = require("prosemirror-state");
 const DeleteKeywordDialog_1 = require("../components/keywords/DeleteKeywordDialog");
 const track_changes_utils_1 = require("../lib/track-changes-utils");
 const base_node_view_1 = require("./base_node_view");
@@ -67,7 +68,7 @@ class KeywordView extends base_node_view_1.BaseNodeView {
             const pos = this.getPos();
             const handleDelete = () => {
                 const tr = this.view.state.tr;
-                tr.delete(pos, pos + keyword.nodeSize);
+                tr.setSelection(prosemirror_state_1.TextSelection.near(this.view.state.doc.resolve(0))).delete(pos, pos + keyword.nodeSize + 1);
                 this.view.dispatch(tr);
             };
             const componentProps = {

package/dist/es/configs/editor-plugins.js

@@ -20,6 +20,7 @@ import { dropCursor } from 'prosemirror-dropcursor';
 import { history } from 'prosemirror-history';
 import { tableEditing } from 'prosemirror-tables';
 import keys from '../keys';
+import affiliations from '../plugins/affiliations';
 import bibliography from '../plugins/bibliography';
 import comment_annotation from '../plugins/comment_annotation';
 import elements from '../plugins/elements';
@@ -50,6 +51,7 @@ export default (props) => {
         toc(props),
         bibliography(props),
         objects(props),
+        affiliations(),
         comment_annotation(props),
         paragraphs(),
         placeholder(),

package/dist/es/configs/editor-views.js

@@ -13,6 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import affiliation from '../views/affiliation';
+import affiliationsSection from '../views/affiliations';
 import bibliographyElement from '../views/bibliography_element_editable';
 import blockquoteElement from '../views/blockquote_element_editable';
 import bulletList from '../views/bullet_list_editable';
@@ -53,6 +55,8 @@ export default (props, dispatch) => {
         citation: citation(props, dispatch),
         cross_reference: crossReference(props, dispatch),
         contributors: contributorsSection(props, dispatch),
+        affiliations: affiliationsSection(props, dispatch),
+        affiliation: affiliation(props, dispatch),
         equation: equation(props),
         equation_element: equationElement(props),
         figure: figure(props, dispatch),

package/dist/es/index.js

@@ -26,4 +26,5 @@ export * from './toolbar';
 export * from './plugins/highlight';
 export { commentScroll, isThereSelector, isHighlightComment, } from './plugins/comment_annotation';
 export * from './lib/utils';
+export * from './lib/track-changes-utils';
 export * from './useEditor';

package/dist/es/lib/track-changes-utils.js

@@ -70,3 +70,12 @@ export function isTracked(node) {
     }
     return false;
 }
+export function getActualAttrs(node) {
+    const attrs = node.attrs;
+    if (attrs.dataTracked &&
+        attrs.dataTracked[0].status === 'rejected' &&
+        attrs.dataTracked[0].operation === 'set_attrs') {
+        return attrs.dataTracked[0].oldAttrs;
+    }
+    return attrs;
+}