@manuscripts/body-editor 1.7.5 → 1.7.6-LEAN-3342-0

package/dist/cjs/commands.js

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateCommentAnnotationState = exports.addComment = exports.deleteHighlightMarkers = exports.insertHighlight = exports.createAndFillTableElement = exports.selectAllIsolating = exports.ignoreAtomBlockNodeForward = exports.isAtEndOfTextBlock = exports.ignoreAtomBlockNodeBackward = exports.isTextSelection = exports.isAtStartOfTextBlock = exports.ifInTableBody = exports.insertTOCSection = exports.insertBibliographySection = exports.insertList = exports.insertSection = exports.insertGraphicalAbstract = exports.insertInlineFootnote = exports.insertInlineEquation = exports.insertCrossReference = exports.insertInlineCitation = exports.insertLink = exports.insertSectionLabel = exports.insertBreak = exports.deleteBlock = exports.insertBlock = exports.insertFileAsFigure = exports.createBlock = exports.createSelection = exports.canInsert = exports.blockActive = exports.isNodeSelection = exports.markActive = void 0;
+exports.insertTableFootnote = exports.updateCommentAnnotationState = exports.addComment = exports.deleteHighlightMarkers = exports.insertHighlight = exports.createAndFillTableElement = exports.selectAllIsolating = exports.ignoreAtomBlockNodeForward = exports.isAtEndOfTextBlock = exports.ignoreAtomBlockNodeBackward = exports.isTextSelection = exports.isAtStartOfTextBlock = exports.ifInTableBody = exports.insertTOCSection = exports.insertBibliographySection = exports.insertList = exports.insertSection = exports.insertGraphicalAbstract = exports.insertInlineFootnote = exports.insertInlineEquation = exports.insertCrossReference = exports.insertInlineCitation = exports.insertLink = exports.insertSectionLabel = exports.insertBreak = exports.deleteBlock = exports.insertBlock = exports.insertFileAsFigure = exports.insertGeneralFootnote = exports.createBlock = exports.createSelection = exports.canInsert = exports.blockActive = exports.isNodeSelection = exports.markActive = void 0;
 const json_schema_1 = require("@manuscripts/json-schema");
 const track_changes_plugin_1 = require("@manuscripts/track-changes-plugin");
 const transform_1 = require("@manuscripts/transform");
@@ -122,6 +122,29 @@ const createBlock = (nodeType, position, state, dispatch) => {
     }
 };
 exports.createBlock = createBlock;
+const insertGeneralFootnote = (tableNode, position, state, dispatch, tableElementFooter, view) => {
+    var _a;
+    const generalNote = state.schema.nodes.paragraph.create();
+    const tr = state.tr;
+    const pos = (tableElementFooter === null || tableElementFooter === void 0 ? void 0 : tableElementFooter.length)
+        ? position + tableElementFooter[0].pos + 2
+        : position + (((_a = tableNode.content.firstChild) === null || _a === void 0 ? void 0 : _a.nodeSize) || 0);
+    if (tableElementFooter === null || tableElementFooter === void 0 ? void 0 : tableElementFooter.length) {
+        tr.insert(pos, generalNote);
+    }
+    else {
+        const tableElementFooter = transform_1.schema.nodes.table_element_footer.create({
+            id: (0, transform_1.generateID)(json_schema_1.ObjectTypes.TableElementFooter),
+        }, [generalNote]);
+        tr.insert(pos, tableElementFooter);
+    }
+    if (dispatch && pos) {
+        const selection = (0, exports.createSelection)(state.schema.nodes.paragraph, pos, tr.doc);
+        view === null || view === void 0 ? void 0 : view.focus();
+        dispatch(tr.setSelection(selection).scrollIntoView());
+    }
+};
+exports.insertGeneralFootnote = insertGeneralFootnote;
 const insertFileAsFigure = (file, state, dispatch) => {
     const position = findBlockInsertPosition(state);
     if (position === null || !dispatch) {
@@ -688,3 +711,41 @@ const updateCommentAnnotationState = (state, dispatch) => {
     }
 };
 exports.updateCommentAnnotationState = updateCommentAnnotationState;
+const insertTableFootnote = (node, position, state, dispatch) => {
+    var _a;
+    const footnote = state.schema.nodes.footnote.createAndFill({
+        id: (0, transform_1.generateID)(json_schema_1.ObjectTypes.Footnote),
+        kind: 'footnote',
+    });
+    const insertedAt = state.selection.to;
+    const inlineFootnotes = (0, prosemirror_utils_1.findChildrenByType)(node, transform_1.schema.nodes.inline_footnote);
+    const inlineFootnoteNode = state.schema.nodes.inline_footnote.create({
+        rids: [footnote.attrs.id],
+        contents: inlineFootnotes.length + 1,
+    });
+    const tr = state.tr;
+    tr.insert(insertedAt, inlineFootnoteNode);
+    const footnoteElement = state.schema.nodes.footnotes_element.create({}, footnote);
+    const tableElementFooter = (0, prosemirror_utils_1.findChildrenByType)(node, transform_1.schema.nodes.table_element_footer);
+    let insertionPos;
+    if (tableElementFooter.length) {
+        const pos = tableElementFooter[0].pos;
+        insertionPos = position + pos + tableElementFooter[0].node.nodeSize + 1;
+        tr.insert(insertionPos, footnoteElement);
+    }
+    else {
+        const tableSize = (_a = node.content.firstChild) === null || _a === void 0 ? void 0 : _a.nodeSize;
+        if (tableSize) {
+            insertionPos = position + tableSize + 2;
+            const tableElementFooter = transform_1.schema.nodes.table_element_footer.create({
+                id: (0, transform_1.generateID)(json_schema_1.ObjectTypes.TableElementFooter),
+            }, [footnoteElement]);
+            tr.insert(insertionPos, tableElementFooter);
+        }
+    }
+    if (dispatch && insertionPos) {
+        const nodeSelection = prosemirror_state_1.NodeSelection.create(tr.doc, insertionPos);
+        dispatch(tr.setSelection(nodeSelection));
+    }
+};
+exports.insertTableFootnote = insertTableFootnote;

package/dist/cjs/lib/context-menu.js

@@ -17,6 +17,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContextMenu = exports.sectionLevel = void 0;
 const transform_1 = require("@manuscripts/transform");
+const prosemirror_utils_1 = require("prosemirror-utils");
 const commands_1 = require("../commands");
 const popper_1 = require("./popper");
 const popper = new popper_1.PopperManager();
@@ -134,6 +135,7 @@ class ContextMenu {
             this.addPopperEventListeners();
         };
         this.showEditMenu = (target) => {
+            var _a;
             const menu = document.createElement('div');
             menu.className = 'menu';
             const $pos = this.resolvePos();
@@ -164,6 +166,33 @@ class ContextMenu {
                     }));
                 }));
             }
+            if (type === transform_1.schema.nodes.table_element) {
+                const tableElementFooter = (0, prosemirror_utils_1.findChildrenByType)(this.node, transform_1.schema.nodes.table_element_footer);
+                const hasGeneralNote = tableElementFooter.length &&
+                    ((_a = tableElementFooter[0].node.firstChild) === null || _a === void 0 ? void 0 : _a.type) === transform_1.schema.nodes.paragraph;
+                if (!hasGeneralNote) {
+                    menu.appendChild(this.createMenuSection((section) => {
+                        section.appendChild(this.createMenuItem('Add General Note', () => {
+                            const { state, dispatch } = this.view;
+                            (0, commands_1.insertGeneralFootnote)(this.node, this.getPos(), state, dispatch, tableElementFooter, this.view);
+                        }));
+                    }));
+                }
+            }
+            if (type === transform_1.schema.nodes.table_element) {
+                const isInTable = (0, prosemirror_utils_1.hasParentNodeOfType)(transform_1.schema.nodes.table)(this.view.state.selection);
+                if (isInTable) {
+                    menu.appendChild(this.createMenuSection((section) => {
+                        section.appendChild(this.createMenuItem('Add Reference Note', () => {
+                            const footnotesElement = (0, prosemirror_utils_1.findChildrenByType)(this.node, transform_1.schema.nodes.footnotes_element);
+                            if (!footnotesElement.length) {
+                                const { state, dispatch } = this.view;
+                                (0, commands_1.insertTableFootnote)(this.node, this.getPos(), state, dispatch);
+                            }
+                        }));
+                    }));
+                }
+            }
             if (!readonlyTypes.includes(type) &&
                 !readonlyTypes.includes($pos.parent.type)) {
                 menu.appendChild(this.createMenuSection((section) => {

package/dist/cjs/plugins/footnotes/index.js

@@ -22,6 +22,7 @@ const prosemirror_state_1 = require("prosemirror-state");
 const prosemirror_utils_1 = require("prosemirror-utils");
 const prosemirror_view_1 = require("prosemirror-view");
 const utils_1 = require("../../lib/utils");
+const placeholder_1 = require("../placeholder");
 exports.footnotesKey = new prosemirror_state_1.PluginKey('footnotes');
 const buildPluginState = (doc) => {
     const nodes = [];
@@ -101,9 +102,10 @@ exports.default = () => {
                 }
                 const { labels } = exports.footnotesKey.getState(state);
                 state.doc.descendants((node, pos) => {
-                    if (labels) {
-                        if ((0, transform_1.isFootnoteNode)(node)) {
-                            const id = node.attrs.id;
+                    var _a, _b;
+                    if ((0, transform_1.isFootnoteNode)(node)) {
+                        const id = node.attrs.id;
+                        if (labels) {
                             const label = labels.get(id);
                             if (label) {
                                 decorations.push(prosemirror_view_1.Decoration.widget(pos + 2, labelWidget(label, id), {
@@ -111,12 +113,20 @@ exports.default = () => {
                                 }));
                             }
                         }
+                        if (!((_a = node.firstChild) === null || _a === void 0 ? void 0 : _a.textContent)) {
+                            decorations.push(prosemirror_view_1.Decoration.widget(pos + 2, (0, placeholder_1.placeholderWidget)('Add new note here')));
+                        }
                     }
                     if (node.type === transform_1.schema.nodes.footnotes_element) {
                         decorations.push(prosemirror_view_1.Decoration.node(pos, pos + node.nodeSize, {
                             class: 'footnote-element',
                         }));
                     }
+                    if (node.type === transform_1.schema.nodes.table_element_footer) {
+                        if (((_b = node.firstChild) === null || _b === void 0 ? void 0 : _b.type) === transform_1.schema.nodes.paragraph) {
+                            decorations.push(prosemirror_view_1.Decoration.widget(pos + 2, (0, placeholder_1.placeholderWidget)('Add general note here')));
+                        }
+                    }
                 });
                 return prosemirror_view_1.DecorationSet.create(state.doc, decorations);
             },

package/dist/cjs/plugins/placeholder.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.placeholderWidget = void 0;
 const prosemirror_state_1 = require("prosemirror-state");
 const prosemirror_view_1 = require("prosemirror-view");
 const placeholderWidget = (placeholder) => (view, getPos) => {
@@ -27,6 +28,7 @@ const placeholderWidget = (placeholder) => (view, getPos) => {
     });
     return element;
 };
+exports.placeholderWidget = placeholderWidget;
 exports.default = () => new prosemirror_state_1.Plugin({
     props: {
         decorations: (state) => {
@@ -38,7 +40,7 @@ exports.default = () => new prosemirror_state_1.Plugin({
                     node.type.isBlock &&
                     node.childCount === 0) {
                     if (node.type === node.type.schema.nodes.paragraph) {
-                        decorations.push(prosemirror_view_1.Decoration.widget(pos + 1, placeholderWidget(placeholder)));
+                        decorations.push(prosemirror_view_1.Decoration.widget(pos + 1, (0, exports.placeholderWidget)(placeholder)));
                     }
                     else {
                         decorations.push(prosemirror_view_1.Decoration.node(pos, pos + node.nodeSize, {

package/dist/es/commands.js

@@ -113,6 +113,28 @@ export const createBlock = (nodeType, position, state, dispatch) => {
         dispatch(tr.setSelection(selection).scrollIntoView());
     }
 };
+export const insertGeneralFootnote = (tableNode, position, state, dispatch, tableElementFooter, view) => {
+    var _a;
+    const generalNote = state.schema.nodes.paragraph.create();
+    const tr = state.tr;
+    const pos = (tableElementFooter === null || tableElementFooter === void 0 ? void 0 : tableElementFooter.length)
+        ? position + tableElementFooter[0].pos + 2
+        : position + (((_a = tableNode.content.firstChild) === null || _a === void 0 ? void 0 : _a.nodeSize) || 0);
+    if (tableElementFooter === null || tableElementFooter === void 0 ? void 0 : tableElementFooter.length) {
+        tr.insert(pos, generalNote);
+    }
+    else {
+        const tableElementFooter = schema.nodes.table_element_footer.create({
+            id: generateID(ObjectTypes.TableElementFooter),
+        }, [generalNote]);
+        tr.insert(pos, tableElementFooter);
+    }
+    if (dispatch && pos) {
+        const selection = createSelection(state.schema.nodes.paragraph, pos, tr.doc);
+        view === null || view === void 0 ? void 0 : view.focus();
+        dispatch(tr.setSelection(selection).scrollIntoView());
+    }
+};
 export const insertFileAsFigure = (file, state, dispatch) => {
     const position = findBlockInsertPosition(state);
     if (position === null || !dispatch) {
@@ -652,3 +674,40 @@ export const updateCommentAnnotationState = (state, dispatch) => {
         dispatch(tr);
     }
 };
+export const insertTableFootnote = (node, position, state, dispatch) => {
+    var _a;
+    const footnote = state.schema.nodes.footnote.createAndFill({
+        id: generateID(ObjectTypes.Footnote),
+        kind: 'footnote',
+    });
+    const insertedAt = state.selection.to;
+    const inlineFootnotes = findChildrenByType(node, schema.nodes.inline_footnote);
+    const inlineFootnoteNode = state.schema.nodes.inline_footnote.create({
+        rids: [footnote.attrs.id],
+        contents: inlineFootnotes.length + 1,
+    });
+    const tr = state.tr;
+    tr.insert(insertedAt, inlineFootnoteNode);
+    const footnoteElement = state.schema.nodes.footnotes_element.create({}, footnote);
+    const tableElementFooter = findChildrenByType(node, schema.nodes.table_element_footer);
+    let insertionPos;
+    if (tableElementFooter.length) {
+        const pos = tableElementFooter[0].pos;
+        insertionPos = position + pos + tableElementFooter[0].node.nodeSize + 1;
+        tr.insert(insertionPos, footnoteElement);
+    }
+    else {
+        const tableSize = (_a = node.content.firstChild) === null || _a === void 0 ? void 0 : _a.nodeSize;
+        if (tableSize) {
+            insertionPos = position + tableSize + 2;
+            const tableElementFooter = schema.nodes.table_element_footer.create({
+                id: generateID(ObjectTypes.TableElementFooter),
+            }, [footnoteElement]);
+            tr.insert(insertionPos, tableElementFooter);
+        }
+    }
+    if (dispatch && insertionPos) {
+        const nodeSelection = NodeSelection.create(tr.doc, insertionPos);
+        dispatch(tr.setSelection(nodeSelection));
+    }
+};

package/dist/es/lib/context-menu.js

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 import { isInBibliographySection, nodeNames, schema, } from '@manuscripts/transform';
-import { addComment, createBlock } from '../commands';
+import { findChildrenByType, hasParentNodeOfType } from 'prosemirror-utils';
+import { addComment, createBlock, insertGeneralFootnote, insertTableFootnote, } from '../commands';
 import { PopperManager } from './popper';
 const popper = new PopperManager();
 const listTypes = [schema.nodes.ordered_list, schema.nodes.bullet_list];
@@ -130,6 +131,7 @@ export class ContextMenu {
             this.addPopperEventListeners();
         };
         this.showEditMenu = (target) => {
+            var _a;
             const menu = document.createElement('div');
             menu.className = 'menu';
             const $pos = this.resolvePos();
@@ -160,6 +162,33 @@ export class ContextMenu {
                     }));
                 }));
             }
+            if (type === schema.nodes.table_element) {
+                const tableElementFooter = findChildrenByType(this.node, schema.nodes.table_element_footer);
+                const hasGeneralNote = tableElementFooter.length &&
+                    ((_a = tableElementFooter[0].node.firstChild) === null || _a === void 0 ? void 0 : _a.type) === schema.nodes.paragraph;
+                if (!hasGeneralNote) {
+                    menu.appendChild(this.createMenuSection((section) => {
+                        section.appendChild(this.createMenuItem('Add General Note', () => {
+                            const { state, dispatch } = this.view;
+                            insertGeneralFootnote(this.node, this.getPos(), state, dispatch, tableElementFooter, this.view);
+                        }));
+                    }));
+                }
+            }
+            if (type === schema.nodes.table_element) {
+                const isInTable = hasParentNodeOfType(schema.nodes.table)(this.view.state.selection);
+                if (isInTable) {
+                    menu.appendChild(this.createMenuSection((section) => {
+                        section.appendChild(this.createMenuItem('Add Reference Note', () => {
+                            const footnotesElement = findChildrenByType(this.node, schema.nodes.footnotes_element);
+                            if (!footnotesElement.length) {
+                                const { state, dispatch } = this.view;
+                                insertTableFootnote(this.node, this.getPos(), state, dispatch);
+                            }
+                        }));
+                    }));
+                }
+            }
             if (!readonlyTypes.includes(type) &&
                 !readonlyTypes.includes($pos.parent.type)) {
                 menu.appendChild(this.createMenuSection((section) => {

package/dist/es/plugins/footnotes/index.js

@@ -19,6 +19,7 @@ import { NodeSelection, Plugin, PluginKey } from 'prosemirror-state';
 import { hasParentNodeOfType } from 'prosemirror-utils';
 import { Decoration, DecorationSet } from 'prosemirror-view';
 import { findParentNodeWithIdValue } from '../../lib/utils';
+import { placeholderWidget } from '../placeholder';
 export const footnotesKey = new PluginKey('footnotes');
 export const buildPluginState = (doc) => {
     const nodes = [];
@@ -97,9 +98,10 @@ export default () => {
                 }
                 const { labels } = footnotesKey.getState(state);
                 state.doc.descendants((node, pos) => {
-                    if (labels) {
-                        if (isFootnoteNode(node)) {
-                            const id = node.attrs.id;
+                    var _a, _b;
+                    if (isFootnoteNode(node)) {
+                        const id = node.attrs.id;
+                        if (labels) {
                             const label = labels.get(id);
                             if (label) {
                                 decorations.push(Decoration.widget(pos + 2, labelWidget(label, id), {
@@ -107,12 +109,20 @@ export default () => {
                                 }));
                             }
                         }
+                        if (!((_a = node.firstChild) === null || _a === void 0 ? void 0 : _a.textContent)) {
+                            decorations.push(Decoration.widget(pos + 2, placeholderWidget('Add new note here')));
+                        }
                     }
                     if (node.type === schema.nodes.footnotes_element) {
                         decorations.push(Decoration.node(pos, pos + node.nodeSize, {
                             class: 'footnote-element',
                         }));
                     }
+                    if (node.type === schema.nodes.table_element_footer) {
+                        if (((_b = node.firstChild) === null || _b === void 0 ? void 0 : _b.type) === schema.nodes.paragraph) {
+                            decorations.push(Decoration.widget(pos + 2, placeholderWidget('Add general note here')));
+                        }
+                    }
                 });
                 return DecorationSet.create(state.doc, decorations);
             },

package/dist/es/plugins/placeholder.js

@@ -15,7 +15,7 @@
  */
 import { Plugin, TextSelection } from 'prosemirror-state';
 import { Decoration, DecorationSet } from 'prosemirror-view';
-const placeholderWidget = (placeholder) => (view, getPos) => {
+export const placeholderWidget = (placeholder) => (view, getPos) => {
     const element = document.createElement('span');
     element.className = 'placeholder-text';
     element.textContent = placeholder;

package/dist/types/commands.d.ts

@@ -18,6 +18,7 @@ import { FileAttachment } from '@manuscripts/style-guide';
 import { ManuscriptEditorState, ManuscriptEditorView, ManuscriptMarkType, ManuscriptNode, ManuscriptNodeType, ManuscriptTransaction } from '@manuscripts/transform';
 import { ResolvedPos } from 'prosemirror-model';
 import { Command, NodeSelection, Selection, TextSelection, Transaction } from 'prosemirror-state';
+import { NodeWithPos } from 'prosemirror-utils';
 import { EditorAction } from './types';
 export type Dispatch = (tr: ManuscriptTransaction) => void;
 export declare const markActive: (type: ManuscriptMarkType) => (state: ManuscriptEditorState) => boolean;
@@ -26,6 +27,7 @@ export declare const blockActive: (type: ManuscriptNodeType) => (state: Manuscri
 export declare const canInsert: (type: ManuscriptNodeType) => (state: ManuscriptEditorState) => boolean;
 export declare const createSelection: (nodeType: ManuscriptNodeType, position: number, doc: ManuscriptNode) => Selection;
 export declare const createBlock: (nodeType: ManuscriptNodeType, position: number, state: ManuscriptEditorState, dispatch?: Dispatch) => void;
+export declare const insertGeneralFootnote: (tableNode: ManuscriptNode, position: number, state: ManuscriptEditorState, dispatch?: Dispatch, tableElementFooter?: NodeWithPos[], view?: ManuscriptEditorView) => void;
 export declare const insertFileAsFigure: (file: FileAttachment, state: ManuscriptEditorState, dispatch?: Dispatch) => boolean;
 export declare const insertBlock: (nodeType: ManuscriptNodeType) => (state: ManuscriptEditorState, dispatch?: Dispatch) => boolean;
 export declare const deleteBlock: (typeToDelete: string) => (state: ManuscriptEditorState, dispatch?: Dispatch) => boolean;
@@ -54,3 +56,4 @@ export declare const deleteHighlightMarkers: (rid: string) => Command;
 export declare function addComment(state: ManuscriptEditorState, dispatch?: Dispatch): boolean;
 export declare function addComment(state: ManuscriptEditorState, dispatch?: Dispatch, viewNode?: ManuscriptNode, resolvePos?: ResolvedPos): boolean;
 export declare const updateCommentAnnotationState: (state: ManuscriptEditorState, dispatch?: Dispatch) => void;
+export declare const insertTableFootnote: (node: ManuscriptNode, position: number, state: ManuscriptEditorState, dispatch?: Dispatch) => void;

package/dist/types/plugins/placeholder.d.ts

@@ -13,6 +13,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { ManuscriptEditorView } from '@manuscripts/transform';
 import { Plugin } from 'prosemirror-state';
+export declare const placeholderWidget: (placeholder: string) => (view: ManuscriptEditorView, getPos: () => number | undefined) => HTMLSpanElement;
 declare const _default: () => Plugin<null>;
 export default _default;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/body-editor",
   "description": "Prosemirror components for editing and viewing manuscripts",
-  "version": "1.7.5",
+  "version": "1.7.6-LEAN-3342-0",
   "repository": "github:Atypon-OpenSource/manuscripts-body-editor",
   "license": "Apache-2.0",
   "main": "dist/cjs",
@@ -109,4 +109,4 @@
   "resolutions": {
     "@types/react": "^17.0.2"
   }
-}
+}

package/styles/Editor.css

@@ -546,6 +546,7 @@
 }
 
 .ProseMirror .placeholder-text {
+  font-style: italic;
   color: #c9c9c9;
   margin: 0;
 }