@modusoperandi/licit 0.13.1 → 0.13.2

package/src/convertFromJSON.js

@@ -1,78 +1,78 @@
-// @flow
-
-import { Schema } from 'prosemirror-model';
-import { EditorState } from 'prosemirror-state';
-import { Plugin } from 'prosemirror-state';
-import createEmptyEditorState from './createEmptyEditorState';
-
-export default function convertFromJSON(
-  json: Object | string,
-  schema: ?Schema,
-  defaultSchema: Schema,
-  plugins: ?Array<Plugin>,
-  defaultPlugins: Array<Plugin>
-): EditorState {
-  let editorSchema = schema || defaultSchema;
-
-  // [FS][IRAD-???? 2020-08-17]
-  // Loads plugins and its corresponding schema in editor
-  const effectivePlugins = defaultPlugins;
-
-  if (plugins) {
-    for (const p of plugins) {
-      if (!effectivePlugins.includes(p)) {
-        effectivePlugins.push(p);
-        if (p.getEffectiveSchema) {
-          editorSchema = p.getEffectiveSchema(editorSchema);
-        }
-
-        if (p.initKeyCommands) {
-          effectivePlugins.push(p.initKeyCommands());
-        }
-      }
-    }
-  }
-  if (typeof json === 'string') {
-    try {
-      json = JSON.parse(json);
-    } catch (ex) {
-      console.error('convertFromJSON:', ex);
-      // [FS] IRAD-1455 2021-06-16
-      // Use the effectivePlugins, editor hangs, b'coz of missing default core plugins
-      return createEmptyEditorState(
-        schema,
-        defaultSchema,
-        plugins,
-        defaultPlugins
-      );
-    }
-  }
-
-  if (!json || typeof json !== 'object') {
-    console.error('convertFromJSON: invalid object', json);
-    // [FS] IRAD-1455 2021-06-16
-    // Use the effectivePlugins, editor hangs, b'coz of missing default core plugins
-    return createEmptyEditorState(
-      schema,
-      defaultSchema,
-      plugins,
-      defaultPlugins
-    );
-  }
-
-  // [FS] IRAD-1067 2020-09-19
-  // Handle gracefully when error thrown on invalid json
-  let doc = null;
-
-  try {
-    doc = editorSchema.nodeFromJSON(json);
-  } catch (error) {
-    return null;
-  }
-
-  return EditorState.create({
-    doc: doc,
-    schema: editorSchema,
-    plugins: effectivePlugins,
-  });
-}
+// @flow
+
+import { Schema } from 'prosemirror-model';
+import { EditorState } from 'prosemirror-state';
+import { Plugin } from 'prosemirror-state';
+import createEmptyEditorState from './createEmptyEditorState';
+
+export default function convertFromJSON(
+  json: Object | string,
+  schema: ?Schema,
+  defaultSchema: Schema,
+  plugins: ?Array<Plugin>,
+  defaultPlugins: Array<Plugin>
+): EditorState {
+  let editorSchema = schema || defaultSchema;
+
+  // [FS][IRAD-???? 2020-08-17]
+  // Loads plugins and its corresponding schema in editor
+  const effectivePlugins = defaultPlugins;
+
+  if (plugins) {
+    for (const p of plugins) {
+      if (!effectivePlugins.includes(p)) {
+        effectivePlugins.push(p);
+        if (p.getEffectiveSchema) {
+          editorSchema = p.getEffectiveSchema(editorSchema);
+        }
+
+        if (p.initKeyCommands) {
+          effectivePlugins.push(p.initKeyCommands());
+        }
+      }
+    }
+  }
+  if (typeof json === 'string') {
+    try {
+      json = JSON.parse(json);
+    } catch (ex) {
+      console.error('convertFromJSON:', ex);
+      // [FS] IRAD-1455 2021-06-16
+      // Use the effectivePlugins, editor hangs, b'coz of missing default core plugins
+      return createEmptyEditorState(
+        schema,
+        defaultSchema,
+        plugins,
+        defaultPlugins
+      );
+    }
+  }
+
+  if (!json || typeof json !== 'object') {
+    console.error('convertFromJSON: invalid object', json);
+    // [FS] IRAD-1455 2021-06-16
+    // Use the effectivePlugins, editor hangs, b'coz of missing default core plugins
+    return createEmptyEditorState(
+      schema,
+      defaultSchema,
+      plugins,
+      defaultPlugins
+    );
+  }
+
+  // [FS] IRAD-1067 2020-09-19
+  // Handle gracefully when error thrown on invalid json
+  let doc = null;
+
+  try {
+    doc = editorSchema.nodeFromJSON(json);
+  } catch (error) {
+    return null;
+  }
+
+  return EditorState.create({
+    doc: doc,
+    schema: editorSchema,
+    plugins: effectivePlugins,
+  });
+}

package/src/convertToCSSPTValue.js

@@ -1,22 +1,22 @@
-// @flow
-
-const SIZE_PATTERN = /([\d\.]+)(px|pt)/i;
-
-export const PX_TO_PT_RATIO = 0.75292857;
-export const PT_TO_PX_RATIO = 1 / PX_TO_PT_RATIO;
-
-export default function convertToCSSPTValue(styleValue: string): number {
-  const matches = styleValue.match(SIZE_PATTERN);
-  if (!matches) {
-    return 0;
-  }
-  let value = parseFloat(matches[1]);
-  const unit = matches[2];
-  if (!value || !unit) {
-    return 0;
-  }
-  if (unit === 'px') {
-    value = PX_TO_PT_RATIO * value;
-  }
-  return value;
-}
+// @flow
+
+const SIZE_PATTERN = /([\d\.]+)(px|pt)/i;
+
+export const PX_TO_PT_RATIO = 0.75292857;
+export const PT_TO_PX_RATIO = 1 / PX_TO_PT_RATIO;
+
+export default function convertToCSSPTValue(styleValue: string): number {
+  const matches = styleValue.match(SIZE_PATTERN);
+  if (!matches) {
+    return 0;
+  }
+  let value = parseFloat(matches[1]);
+  const unit = matches[2];
+  if (!value || !unit) {
+    return 0;
+  }
+  if (unit === 'px') {
+    value = PX_TO_PT_RATIO * value;
+  }
+  return value;
+}

package/src/convertToJSON.js

@@ -1,7 +1,7 @@
-// @flow
-
-import { EditorState } from 'prosemirror-state';
-
-export default function convertToJSON(editorState: EditorState): Object {
-  return editorState.doc.toJSON();
-}
+// @flow
+
+import { EditorState } from 'prosemirror-state';
+
+export default function convertToJSON(editorState: EditorState): Object {
+  return editorState.doc.toJSON();
+}

package/src/createCommand.js

@@ -1,40 +1,40 @@
-// @flow
-
-import { EditorState } from 'prosemirror-state';
-import { Transform } from 'prosemirror-transform';
-import { EditorView } from 'prosemirror-view';
-
-import { UICommand } from '@modusoperandi/licit-doc-attrs-step';
-
-type ExecuteCall = (
-  state: EditorState,
-  dispatch?: ?(tr: Transform) => void,
-  view?: ?EditorView
-) => boolean;
-
-export default function createCommand(execute: ExecuteCall): UICommand {
-  class CustomCommand extends UICommand {
-    isEnabled = (state: EditorState): boolean => {
-      return this.execute(state);
-    };
-
-    execute = (
-      state: EditorState,
-      dispatch: ?(tr: Transform) => void,
-      view: ?EditorView
-    ): boolean => {
-      const tr = state.tr;
-      let endTr = tr;
-      execute(
-        state,
-        (nextTr) => {
-          endTr = nextTr;
-          dispatch && dispatch(endTr);
-        },
-        view
-      );
-      return endTr.docChanged || tr !== endTr;
-    };
-  }
-  return new CustomCommand();
-}
+// @flow
+
+import { EditorState } from 'prosemirror-state';
+import { Transform } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+
+import { UICommand } from '@modusoperandi/licit-doc-attrs-step';
+
+type ExecuteCall = (
+  state: EditorState,
+  dispatch?: ?(tr: Transform) => void,
+  view?: ?EditorView
+) => boolean;
+
+export default function createCommand(execute: ExecuteCall): UICommand {
+  class CustomCommand extends UICommand {
+    isEnabled = (state: EditorState): boolean => {
+      return this.execute(state);
+    };
+
+    execute = (
+      state: EditorState,
+      dispatch: ?(tr: Transform) => void,
+      view: ?EditorView
+    ): boolean => {
+      const tr = state.tr;
+      let endTr = tr;
+      execute(
+        state,
+        (nextTr) => {
+          endTr = nextTr;
+          dispatch && dispatch(endTr);
+        },
+        view
+      );
+      return endTr.docChanged || tr !== endTr;
+    };
+  }
+  return new CustomCommand();
+}

package/src/createEditorKeyMap.js

@@ -1,94 +1,94 @@
-// @flow
-
-import { EditorState } from 'prosemirror-state';
-import { Transform } from 'prosemirror-transform';
-import { EditorView } from 'prosemirror-view';
-
-import * as EditorCommands from './EditorCommands';
-import * as EditorKeyMap from './EditorKeyMap';
-import { UICommand } from '@modusoperandi/licit-doc-attrs-step';
-import type {
-  UserKeyCommand,
-  UserKeyMap,
-} from '@modusoperandi/licit-doc-attrs-step';
-
-const {
-  KEY_BACK_DELETE,
-  KEY_FORWARD_DELETE,
-  // [FS][07-MAY-2020][IRAD-956]
-  // KEY_INSERT_NEW_LINE_IN_BLOCKQUOTE,
-  KEY_INSERT_NEW_LINE_IN_LIST_ITEM,
-  KEY_REDO,
-  KEY_SPLIT_LIST_ITEM,
-  KEY_TAB_SHIFT,
-  KEY_TAB,
-  KEY_TOGGLE_BOLD,
-  KEY_TOGGLE_ITALIC,
-  KEY_TOGGLE_UNDERLINE,
-  KEY_UNDO,
-} = EditorKeyMap;
-
-const {
-  // [FS][07-MAY-2020][IRAD-956]
-  // BLOCKQUOTE_INSERT_NEW_LINE,
-  EM,
-  HISTORY_REDO,
-  HISTORY_UNDO,
-  INDENT_LESS,
-  INDENT_MORE,
-  LIST_ITEM_INSERT_NEW_LINE,
-  LIST_ITEM_MERGE_DOWN,
-  LIST_ITEM_MERGE_UP,
-  LIST_SPLIT,
-  TABLE_MOVE_TO_NEXT_CELL,
-  TABLE_MOVE_TO_PREV_CELL,
-  TEXT_INSERT_TAB_SPACE,
-  STRONG,
-  UNDERLINE,
-} = EditorCommands;
-
-function bindCommands(...commands: Array<UICommand>): UserKeyCommand {
-  return function (
-    state: EditorState,
-    dispatch: ?(tr: Transform) => void,
-    view: ?EditorView
-  ): boolean {
-    return commands.some((cmd) => {
-      if (cmd.isEnabled(state, view, '')) {
-        cmd.execute(state, dispatch, view);
-        return true;
-      }
-      return false;
-    });
-  };
-}
-
-export default function createEditorKeyMap(): UserKeyMap {
-  const result = {
-    [KEY_BACK_DELETE.common]: LIST_ITEM_MERGE_UP.execute,
-    [KEY_FORWARD_DELETE.common]: LIST_ITEM_MERGE_DOWN.execute,
-    [KEY_REDO.common]: HISTORY_REDO.execute,
-    [KEY_SPLIT_LIST_ITEM.common]: LIST_SPLIT.execute,
-    [KEY_TAB.common]: bindCommands(
-      TABLE_MOVE_TO_NEXT_CELL,
-      TEXT_INSERT_TAB_SPACE,
-      INDENT_MORE
-    ),
-    [KEY_TAB_SHIFT.common]: bindCommands(
-      TABLE_MOVE_TO_PREV_CELL,
-      TEXT_INSERT_TAB_SPACE,
-      INDENT_LESS
-    ),
-    [KEY_TOGGLE_BOLD.common]: STRONG.execute,
-    [KEY_TOGGLE_ITALIC.common]: EM.execute,
-    [KEY_TOGGLE_UNDERLINE.common]: UNDERLINE.execute,
-    [KEY_UNDO.common]: HISTORY_UNDO.execute,
-    // [FS][07-MAY-2020][IRAD-956]
-    // [KEY_INSERT_NEW_LINE_IN_BLOCKQUOTE.common]:
-    //   BLOCKQUOTE_INSERT_NEW_LINE.execute,
-    [KEY_INSERT_NEW_LINE_IN_LIST_ITEM.common]:
-      LIST_ITEM_INSERT_NEW_LINE.execute,
-  };
-
-  return result;
-}
+// @flow
+
+import { EditorState } from 'prosemirror-state';
+import { Transform } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+
+import * as EditorCommands from './EditorCommands';
+import * as EditorKeyMap from './EditorKeyMap';
+import { UICommand } from '@modusoperandi/licit-doc-attrs-step';
+import type {
+  UserKeyCommand,
+  UserKeyMap,
+} from '@modusoperandi/licit-doc-attrs-step';
+
+const {
+  KEY_BACK_DELETE,
+  KEY_FORWARD_DELETE,
+  // [FS][07-MAY-2020][IRAD-956]
+  // KEY_INSERT_NEW_LINE_IN_BLOCKQUOTE,
+  KEY_INSERT_NEW_LINE_IN_LIST_ITEM,
+  KEY_REDO,
+  KEY_SPLIT_LIST_ITEM,
+  KEY_TAB_SHIFT,
+  KEY_TAB,
+  KEY_TOGGLE_BOLD,
+  KEY_TOGGLE_ITALIC,
+  KEY_TOGGLE_UNDERLINE,
+  KEY_UNDO,
+} = EditorKeyMap;
+
+const {
+  // [FS][07-MAY-2020][IRAD-956]
+  // BLOCKQUOTE_INSERT_NEW_LINE,
+  EM,
+  HISTORY_REDO,
+  HISTORY_UNDO,
+  INDENT_LESS,
+  INDENT_MORE,
+  LIST_ITEM_INSERT_NEW_LINE,
+  LIST_ITEM_MERGE_DOWN,
+  LIST_ITEM_MERGE_UP,
+  LIST_SPLIT,
+  TABLE_MOVE_TO_NEXT_CELL,
+  TABLE_MOVE_TO_PREV_CELL,
+  TEXT_INSERT_TAB_SPACE,
+  STRONG,
+  UNDERLINE,
+} = EditorCommands;
+
+function bindCommands(...commands: Array<UICommand>): UserKeyCommand {
+  return function (
+    state: EditorState,
+    dispatch: ?(tr: Transform) => void,
+    view: ?EditorView
+  ): boolean {
+    return commands.some((cmd) => {
+      if (cmd.isEnabled(state, view, '')) {
+        cmd.execute(state, dispatch, view);
+        return true;
+      }
+      return false;
+    });
+  };
+}
+
+export default function createEditorKeyMap(): UserKeyMap {
+  const result = {
+    [KEY_BACK_DELETE.common]: LIST_ITEM_MERGE_UP.execute,
+    [KEY_FORWARD_DELETE.common]: LIST_ITEM_MERGE_DOWN.execute,
+    [KEY_REDO.common]: HISTORY_REDO.execute,
+    [KEY_SPLIT_LIST_ITEM.common]: LIST_SPLIT.execute,
+    [KEY_TAB.common]: bindCommands(
+      TABLE_MOVE_TO_NEXT_CELL,
+      TEXT_INSERT_TAB_SPACE,
+      INDENT_MORE
+    ),
+    [KEY_TAB_SHIFT.common]: bindCommands(
+      TABLE_MOVE_TO_PREV_CELL,
+      TEXT_INSERT_TAB_SPACE,
+      INDENT_LESS
+    ),
+    [KEY_TOGGLE_BOLD.common]: STRONG.execute,
+    [KEY_TOGGLE_ITALIC.common]: EM.execute,
+    [KEY_TOGGLE_UNDERLINE.common]: UNDERLINE.execute,
+    [KEY_UNDO.common]: HISTORY_UNDO.execute,
+    // [FS][07-MAY-2020][IRAD-956]
+    // [KEY_INSERT_NEW_LINE_IN_BLOCKQUOTE.common]:
+    //   BLOCKQUOTE_INSERT_NEW_LINE.execute,
+    [KEY_INSERT_NEW_LINE_IN_LIST_ITEM.common]:
+      LIST_ITEM_INSERT_NEW_LINE.execute,
+  };
+
+  return result;
+}

package/src/createEmptyEditorState.js

@@ -1,41 +1,35 @@
-// @flow
-
-import { Schema } from 'prosemirror-model';
-import { EditorState } from 'prosemirror-state';
-import { Plugin } from 'prosemirror-state';
-import DefaultEditorPlugins from './buildEditorPlugins';
-
-import convertFromJSON from './convertFromJSON';
-import EditorSchema from './EditorSchema';
-
-export const EMPTY_DOC_JSON = {
-  type: 'doc',
-  content: [
-    {
-      type: 'paragraph',
-      content: [
-        {
-          type: 'text',
-          text: ' ',
-        },
-      ],
-    },
-  ],
-};
-
-export default function createEmptyEditorState(
-  schema: ?Schema,
-  defaultSchema: ?Schema,
-  plugins: ?Array<Plugin>,
-  defaultPlugins: ?Array<Plugin>
-): EditorState {
-  const newSchema = schema || (defaultSchema ? defaultSchema : EditorSchema);
-  // TODO: Check if schema support doc and paragraph nodes.
-  return convertFromJSON(
-    EMPTY_DOC_JSON,
-    schema,
-    defaultSchema ? defaultSchema : EditorSchema,
-    plugins,
-    defaultPlugins ? defaultPlugins : new DefaultEditorPlugins(newSchema).get()
-  );
-}
+// @flow
+
+import { Schema } from 'prosemirror-model';
+import { EditorState } from 'prosemirror-state';
+import { Plugin } from 'prosemirror-state';
+import DefaultEditorPlugins from './buildEditorPlugins';
+
+import convertFromJSON from './convertFromJSON';
+import EditorSchema from './EditorSchema';
+
+export const EMPTY_DOC_JSON = {
+  type: 'doc',
+  content: [
+    {
+      type: 'paragraph'
+    },// [FS] IRAD-1710 2022-03-04 - No text content needed
+  ],
+};
+
+export default function createEmptyEditorState(
+  schema: ?Schema,
+  defaultSchema: ?Schema,
+  plugins: ?Array<Plugin>,
+  defaultPlugins: ?Array<Plugin>
+): EditorState {
+  const newSchema = schema || (defaultSchema ? defaultSchema : EditorSchema);
+  // TODO: Check if schema support doc and paragraph nodes.
+  return convertFromJSON(
+    EMPTY_DOC_JSON,
+    schema,
+    defaultSchema ? defaultSchema : EditorSchema,
+    plugins,
+    defaultPlugins ? defaultPlugins : new DefaultEditorPlugins(newSchema).get()
+  );
+}