@manuscripts/body-editor 3.4.0 → 3.4.2

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

@@ -82,7 +82,7 @@ exports.default = (props) => {
         (0, doi_1.default)(),
         (0, section_category_1.default)(props),
         (0, cross_references_1.default)(),
-        (0, detect_inconsistency_1.default)(),
+        (0, detect_inconsistency_1.default)(props),
         (0, search_replace_1.default)(),
         (0, lock_body_1.default)(),
         (0, alt_titles_1.default)(),

package/dist/cjs/plugins/detect-inconsistency/detect-inconsistency-utils.js

@@ -33,7 +33,7 @@ const createDecoration = (node, pos, selectedPos) => {
     });
 };
 exports.createDecoration = createDecoration;
-const buildPluginState = (state, showDecorations) => {
+const buildPluginState = (state, props, showDecorations) => {
     const inconsistencies = [];
     const decorations = [];
     const selection = state.selection;
@@ -50,6 +50,7 @@ const buildPluginState = (state, showDecorations) => {
         showDecorations,
         selectedPos,
         decorations,
+        props,
     };
     state.doc.descendants((node, pos) => {
         const validator = validators_1.validators[node.type.name];

package/dist/cjs/plugins/detect-inconsistency/index.js

@@ -20,16 +20,16 @@ const prosemirror_state_1 = require("prosemirror-state");
 const prosemirror_view_1 = require("prosemirror-view");
 const detect_inconsistency_utils_1 = require("./detect-inconsistency-utils");
 exports.detectInconsistencyKey = new prosemirror_state_1.PluginKey('detectInconsistency');
-exports.default = () => {
+exports.default = (props) => {
     return new prosemirror_state_1.Plugin({
         key: exports.detectInconsistencyKey,
         state: {
-            init: (_, state) => (0, detect_inconsistency_utils_1.buildPluginState)(state, false),
+            init: (_, state) => (0, detect_inconsistency_utils_1.buildPluginState)(state, props, false),
             apply: (tr, value, newState) => {
                 const showDecorations = tr.getMeta(exports.detectInconsistencyKey) !== undefined
                     ? tr.getMeta(exports.detectInconsistencyKey)
                     : value.showDecorations;
-                return (0, detect_inconsistency_utils_1.buildPluginState)(newState, showDecorations);
+                return (0, detect_inconsistency_utils_1.buildPluginState)(newState, props, showDecorations);
             },
         },
         props: {

package/dist/cjs/plugins/detect-inconsistency/validators.js

@@ -17,13 +17,28 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validators = void 0;
 const transform_1 = require("@manuscripts/transform");
+const url_1 = require("../../lib/url");
 const detect_inconsistency_utils_1 = require("./detect-inconsistency-utils");
 const getNodeDescription = (node) => {
     return transform_1.nodeNames.get(node.type) || node.type?.name || 'node';
 };
 const createWarning = (node, pos, category, severity) => {
     const nodeDescription = getNodeDescription(node);
-    const message = category === 'empty-content' ? `Is empty` : `Has no linked reference`;
+    const message = (() => {
+        switch (node.type) {
+            case transform_1.schema.nodes.figure_element:
+            case transform_1.schema.nodes.image_element:
+                return 'Has no uploaded file';
+            case transform_1.schema.nodes.embed:
+                return 'Has no link or uploaded file';
+            case transform_1.schema.nodes.link:
+                return 'Url is empty';
+            default:
+                return category === 'empty-content'
+                    ? `Is empty`
+                    : `Has no linked reference`;
+        }
+    })();
     return {
         type: 'warning',
         category,
@@ -87,9 +102,38 @@ const validateInlineFootnote = (node, pos, context) => {
     }
     return inconsistencies;
 };
+const validateFigure = (node, pos, context) => {
+    const inconsistencies = [];
+    const files = new Set(context.props.getFiles().map((f) => f.id));
+    if (!files.has(node.attrs.src)) {
+        const inconsistency = createWarning(node, pos, 'missing-reference', 'error');
+        inconsistencies.push(inconsistency);
+    }
+    return inconsistencies;
+};
+const validateMedia = (node, pos, context) => {
+    const inconsistencies = [];
+    const files = new Set(context.props.getFiles().map((f) => f.id));
+    if (!(files.has(node.attrs.href) || (0, url_1.allowedHref)(node.attrs.href))) {
+        const inconsistency = createWarning(node, pos, 'missing-reference', 'error');
+        inconsistencies.push(inconsistency);
+    }
+    return inconsistencies;
+};
+const validateLink = (node, pos) => {
+    const inconsistencies = [];
+    if (!(0, url_1.allowedHref)(node.attrs.href)) {
+        const inconsistency = createWarning(node, pos, 'missing-reference', 'error');
+        inconsistencies.push(inconsistency);
+    }
+    return inconsistencies;
+};
 exports.validators = {
     [transform_1.schema.nodes.title.name]: validateTitle,
     [transform_1.schema.nodes.cross_reference.name]: validateCrossReference,
     [transform_1.schema.nodes.citation.name]: validateCitation,
     [transform_1.schema.nodes.inline_footnote.name]: validateInlineFootnote,
+    [transform_1.schema.nodes.figure.name]: validateFigure,
+    [transform_1.schema.nodes.embed.name]: validateMedia,
+    [transform_1.schema.nodes.link.name]: validateLink,
 };

package/dist/cjs/versions.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MATHJAX_VERSION = exports.VERSION = void 0;
-exports.VERSION = '3.4.0';
+exports.VERSION = '3.4.2';
 exports.MATHJAX_VERSION = '3.2.2';

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

@@ -77,7 +77,7 @@ export default (props) => {
         doi(),
         section_category(props),
         cross_references(),
-        detect_inconsistency(),
+        detect_inconsistency(props),
         search_replace(),
         lock_body(),
         alt_titles(),

package/dist/es/plugins/detect-inconsistency/detect-inconsistency-utils.js

@@ -29,7 +29,7 @@ export const createDecoration = (node, pos, selectedPos) => {
         'data-inconsistency-type': 'warning',
     });
 };
-export const buildPluginState = (state, showDecorations) => {
+export const buildPluginState = (state, props, showDecorations) => {
     const inconsistencies = [];
     const decorations = [];
     const selection = state.selection;
@@ -46,6 +46,7 @@ export const buildPluginState = (state, showDecorations) => {
         showDecorations,
         selectedPos,
         decorations,
+        props,
     };
     state.doc.descendants((node, pos) => {
         const validator = validators[node.type.name];

package/dist/es/plugins/detect-inconsistency/index.js

@@ -17,16 +17,16 @@ import { Plugin, PluginKey } from 'prosemirror-state';
 import { DecorationSet } from 'prosemirror-view';
 import { buildPluginState } from './detect-inconsistency-utils';
 export const detectInconsistencyKey = new PluginKey('detectInconsistency');
-export default () => {
+export default (props) => {
     return new Plugin({
         key: detectInconsistencyKey,
         state: {
-            init: (_, state) => buildPluginState(state, false),
+            init: (_, state) => buildPluginState(state, props, false),
             apply: (tr, value, newState) => {
                 const showDecorations = tr.getMeta(detectInconsistencyKey) !== undefined
                     ? tr.getMeta(detectInconsistencyKey)
                     : value.showDecorations;
-                return buildPluginState(newState, showDecorations);
+                return buildPluginState(newState, props, showDecorations);
             },
         },
         props: {

package/dist/es/plugins/detect-inconsistency/validators.js

@@ -14,13 +14,28 @@
  * limitations under the License.
  */
 import { nodeNames, schema, } from '@manuscripts/transform';
+import { allowedHref } from '../../lib/url';
 import { createDecoration } from './detect-inconsistency-utils';
 const getNodeDescription = (node) => {
     return nodeNames.get(node.type) || node.type?.name || 'node';
 };
 const createWarning = (node, pos, category, severity) => {
     const nodeDescription = getNodeDescription(node);
-    const message = category === 'empty-content' ? `Is empty` : `Has no linked reference`;
+    const message = (() => {
+        switch (node.type) {
+            case schema.nodes.figure_element:
+            case schema.nodes.image_element:
+                return 'Has no uploaded file';
+            case schema.nodes.embed:
+                return 'Has no link or uploaded file';
+            case schema.nodes.link:
+                return 'Url is empty';
+            default:
+                return category === 'empty-content'
+                    ? `Is empty`
+                    : `Has no linked reference`;
+        }
+    })();
     return {
         type: 'warning',
         category,
@@ -84,9 +99,38 @@ const validateInlineFootnote = (node, pos, context) => {
     }
     return inconsistencies;
 };
+const validateFigure = (node, pos, context) => {
+    const inconsistencies = [];
+    const files = new Set(context.props.getFiles().map((f) => f.id));
+    if (!files.has(node.attrs.src)) {
+        const inconsistency = createWarning(node, pos, 'missing-reference', 'error');
+        inconsistencies.push(inconsistency);
+    }
+    return inconsistencies;
+};
+const validateMedia = (node, pos, context) => {
+    const inconsistencies = [];
+    const files = new Set(context.props.getFiles().map((f) => f.id));
+    if (!(files.has(node.attrs.href) || allowedHref(node.attrs.href))) {
+        const inconsistency = createWarning(node, pos, 'missing-reference', 'error');
+        inconsistencies.push(inconsistency);
+    }
+    return inconsistencies;
+};
+const validateLink = (node, pos) => {
+    const inconsistencies = [];
+    if (!allowedHref(node.attrs.href)) {
+        const inconsistency = createWarning(node, pos, 'missing-reference', 'error');
+        inconsistencies.push(inconsistency);
+    }
+    return inconsistencies;
+};
 export const validators = {
     [schema.nodes.title.name]: validateTitle,
     [schema.nodes.cross_reference.name]: validateCrossReference,
     [schema.nodes.citation.name]: validateCitation,
     [schema.nodes.inline_footnote.name]: validateInlineFootnote,
+    [schema.nodes.figure.name]: validateFigure,
+    [schema.nodes.embed.name]: validateMedia,
+    [schema.nodes.link.name]: validateLink,
 };

package/dist/es/versions.js

@@ -1,2 +1,2 @@
-export const VERSION = '3.4.0';
+export const VERSION = '3.4.2';
 export const MATHJAX_VERSION = '3.2.2';

package/dist/types/plugins/detect-inconsistency/detect-inconsistency-utils.d.ts

@@ -15,6 +15,7 @@
  */
 import { ManuscriptEditorState, ManuscriptNode } from '@manuscripts/transform';
 import { Decoration, DecorationSet } from 'prosemirror-view';
+import { EditorProps } from '../../configs/ManuscriptsEditor';
 export type Inconsistency = {
     type: 'warning';
     category: 'missing-reference' | 'empty-content';
@@ -30,4 +31,4 @@ export type PluginState = {
     showDecorations: boolean;
 };
 export declare const createDecoration: (node: ManuscriptNode, pos: number, selectedPos: number | null) => Decoration;
-export declare const buildPluginState: (state: ManuscriptEditorState, showDecorations: boolean) => PluginState;
+export declare const buildPluginState: (state: ManuscriptEditorState, props: EditorProps, showDecorations: boolean) => PluginState;

package/dist/types/plugins/detect-inconsistency/index.d.ts

@@ -14,8 +14,9 @@
  * limitations under the License.
  */
 import { Plugin, PluginKey } from 'prosemirror-state';
+import { EditorProps } from '../../configs/ManuscriptsEditor';
 import { PluginState } from './detect-inconsistency-utils';
 export { Inconsistency } from './detect-inconsistency-utils';
 export declare const detectInconsistencyKey: PluginKey<PluginState>;
-declare const _default: () => Plugin<PluginState>;
+declare const _default: (props: EditorProps) => Plugin<PluginState>;
 export default _default;

package/dist/types/plugins/detect-inconsistency/validators.d.ts

@@ -15,6 +15,7 @@
  */
 import { BibliographyItemAttrs, ManuscriptNode, Target } from '@manuscripts/transform';
 import { Decoration } from 'prosemirror-view';
+import { EditorProps } from '../../configs/ManuscriptsEditor';
 import { Inconsistency } from './detect-inconsistency-utils';
 export type ValidatorContext = {
     pluginStates: {
@@ -25,6 +26,7 @@ export type ValidatorContext = {
     showDecorations: boolean;
     selectedPos: number | null;
     decorations: Decoration[];
+    props: EditorProps;
 };
 export type NodeValidator = (node: ManuscriptNode, pos: number, context: ValidatorContext) => Inconsistency[];
 export declare const validators: Record<string, NodeValidator>;

package/dist/types/versions.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.4.0";
+export declare const VERSION = "3.4.2";
 export declare const MATHJAX_VERSION = "3.2.2";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@manuscripts/body-editor",
   "description": "Prosemirror components for editing and viewing manuscripts",
-  "version": "3.4.0",
+  "version": "3.4.2",
   "repository": "github:Atypon-OpenSource/manuscripts-body-editor",
   "license": "Apache-2.0",
   "main": "dist/cjs",
@@ -38,7 +38,7 @@
     "@citation-js/plugin-ris": "0.7.18",
     "@iarna/word-count": "1.1.2",
     "@manuscripts/json-schema": "2.2.12",
-    "@manuscripts/style-guide": "3.2.1",
+    "@manuscripts/style-guide": "3.2.2",
     "@manuscripts/track-changes-plugin": "2.0.10",
     "@manuscripts/transform": "4.2.13",
     "@popperjs/core": "2.11.8",