@modusoperandi/licit 1.0.3 → 1.0.5

package/index.d.ts

@@ -1,165 +1,165 @@
-// from "./isEditorStateEmpty"
-import { EditorState, Plugin } from 'prosemirror-state';
-import { Node, Schema } from 'prosemirror-model';
-import { Transform } from 'prosemirror-transform';
-import { EditorView } from 'prosemirror-view';
-import * as React from 'react';
-
-export default function isEditorStateEmpty(editorState: EditorState): boolean;
-
-// from "./ui/uuid";
-export default function uuid(): string;
-
-// from './client/Licit.js';
-
-export type DataType = Readonly<{
-  JSON: symbol;
-  HTML: symbol;
-}>;
-
-export class Licit extends React.Component<any, any> {
-  runtime: any;
-
-  constructor(props: any, context: any);
-
-  /**
-   * Provides access to prosemirror view.
-   */
-  get editorView(): EditorView;
-
-  initialize(props: any);
-
-  initEditorState(plugins: Array<Plugin>, dataType: DataType, data: any);
-
-  getEffectivePlugins(
-    schema: Schema,
-    defaultPlugins: Array<Plugin>,
-    plugins: Array<Plugin>
-  ): { plugins: Array<Plugin>; schema: Schema; pasteJSONPlugin: Plugin };
-
-  onReady(state: EditorState);
-
-  showAlert();
-
-  resetCounters(transaction: Transform);
-
-  setCounterFlags(transaction: Transform, reset: boolean);
-
-  getDeletedArtifactIds();
-
-  isNodeHasAttribute(node: Node, attrName: string);
-
-  getDocument(content: any, editorState: EditorState, dataType: DataType);
-
-  insertJSON(json: { [key: string]: any } | string): void;
-
-  setContent(content: any, dataType: DataType): void;
-
-  hasDataChanged(nextData: any, nextDataType: DataType);
-
-  changeContent(data: any, dataType: DataType);
-
-  shouldComponentUpdate(nextProps: any, nextState: any);
-
-  setDocID(nextState: any);
-
-  render(): React.ReactElement<any>;
-
-  _onChange(data: { state: EditorState; transaction: Transform }): void;
-
-  closeOpenedPopupModels();
-
-  _onReady(editorView: EditorView): void;
-
-  /**
-   * LICIT properties:
-   *  docID {number} [0] Collaborative Doument ID
-   *  debug {boolean} [false] To enable/disable ProseMirror Debug Tools, available only in development.
-   *  width {string} [100%] Width of the editor.
-   *  height {height} [100%] Height of the editor.
-   *  readOnly {boolean} [false] To enable/disable editing mode.
-   *  onChange {@callback} [null] Fires after each significant change.
-   *      @param data {JSON} Modified document data.
-   *  onReady {@callback} [null] Fires when the editor is fully ready.
-   *      @param ref {LICIT} Rerefence of the editor.
-   *  data {JSON} [null] Document data to be loaded into the editor.
-   *  disabled {boolean} [false] Disable the editor.
-   *  embedded {boolean} [false] Disable/Enable inline behaviour.
-   */
-  setProps(props: any): void;
-
-  exportPDF();
-
-  goToEnd(): void;
-}
-
-// from './Types';
-export type NodeSpec = {
-  attrs?: { [key: string]: any };
-  content?: string;
-  draggable?: boolean;
-  group?: string;
-  inline?: boolean;
-  name?: string;
-  parseDOM?: Array<any>;
-  toDOM?: (node: any) => Array<any>;
-};
-
-export type MarkSpec = {
-  attrs?: { [key: string]: any };
-  name?: string;
-  parseDOM: Array<any>;
-  toDOM: (node: any) => Array<any>;
-};
-
-export type EditorProps = {
-  // TODO: Fill the interface.
-  // https://github.com/ProseMirror/prosemirror-view/blob/master/src/index.js
-};
-
-export type DirectEditorProps = EditorProps & {
-  // TODO: Fill the interface.
-  // https://github.com/ProseMirror/prosemirror-view/blob/master/src/index.js
-};
-
-export type RenderCommentProps = {
-  commentThreadId: string;
-  isActive: boolean;
-  requestCommentThreadDeletion: Function;
-  requestCommentThreadReflow: Function;
-};
-
-export type ImageLike = {
-  height: number;
-  id: string;
-  src: string;
-  width: number;
-};
-
-export type EditorRuntime = {
-  // Image Proxy
-  canProxyImageSrc?: (src: string) => boolean;
-  getProxyImageSrc?: (src: string) => string;
-
-  // Image Upload
-  canUploadImage?: () => boolean;
-  uploadImage?: (obj: Blob) => Promise<ImageLike>;
-
-  // Comments
-  canComment?: () => boolean;
-  createCommentThreadID?: () => string;
-  renderComment?: (
-    props: RenderCommentProps
-  ) => React.ReactElement<any> | undefined;
-
-  // External HTML
-  canLoadHTML?: () => boolean;
-  loadHTML?: () => Promise<string>;
-};
-
-// from './client/http';
-export function GET(url);
-export function POST(url, body, type);
-export function PUT(url, body, type);
-export function DELETE(url, type);
-export function PATCH(url, body, type);
+// from "./isEditorStateEmpty"
+import { EditorState, Plugin } from 'prosemirror-state';
+import { Node, Schema } from 'prosemirror-model';
+import { Transform } from 'prosemirror-transform';
+import { EditorView } from 'prosemirror-view';
+import * as React from 'react';
+
+export default function isEditorStateEmpty(editorState: EditorState): boolean;
+
+// from "./ui/uuid";
+export default function uuid(): string;
+
+// from './client/Licit.js';
+
+export type DataType = Readonly<{
+  JSON: symbol;
+  HTML: symbol;
+}>;
+
+export class Licit extends React.Component<any, any> {
+  runtime: any;
+
+  constructor(props: any, context: any);
+
+  /**
+   * Provides access to prosemirror view.
+   */
+  get editorView(): EditorView;
+
+  initialize(props: any);
+
+  initEditorState(plugins: Array<Plugin>, dataType: DataType, data: any);
+
+  getEffectivePlugins(
+    schema: Schema,
+    defaultPlugins: Array<Plugin>,
+    plugins: Array<Plugin>
+  ): { plugins: Array<Plugin>; schema: Schema; pasteJSONPlugin: Plugin };
+
+  onReady(state: EditorState);
+
+  showAlert();
+
+  resetCounters(transaction: Transform);
+
+  setCounterFlags(transaction: Transform, reset: boolean);
+
+  getDeletedArtifactIds();
+
+  isNodeHasAttribute(node: Node, attrName: string);
+
+  getDocument(content: any, editorState: EditorState, dataType: DataType);
+
+  insertJSON(json: { [key: string]: any } | string): void;
+
+  setContent(content: any, dataType: DataType): void;
+
+  hasDataChanged(nextData: any, nextDataType: DataType);
+
+  changeContent(data: any, dataType: DataType);
+
+  shouldComponentUpdate(nextProps: any, nextState: any);
+
+  setDocID(nextState: any);
+
+  render(): React.ReactElement<any>;
+
+  _onChange(data: { state: EditorState; transaction: Transform }): void;
+
+  closeOpenedPopupModels();
+
+  _onReady(editorView: EditorView): void;
+
+  /**
+   * LICIT properties:
+   *  docID {number} [0] Collaborative Doument ID
+   *  debug {boolean} [false] To enable/disable ProseMirror Debug Tools, available only in development.
+   *  width {string} [100%] Width of the editor.
+   *  height {height} [100%] Height of the editor.
+   *  readOnly {boolean} [false] To enable/disable editing mode.
+   *  onChange {@callback} [null] Fires after each significant change.
+   *      @param data {JSON} Modified document data.
+   *  onReady {@callback} [null] Fires when the editor is fully ready.
+   *      @param ref {LICIT} Rerefence of the editor.
+   *  data {JSON} [null] Document data to be loaded into the editor.
+   *  disabled {boolean} [false] Disable the editor.
+   *  embedded {boolean} [false] Disable/Enable inline behaviour.
+   */
+  setProps(props: any): void;
+
+  exportPDF();
+
+  goToEnd(): void;
+}
+
+// from './Types';
+export type NodeSpec = {
+  attrs?: { [key: string]: any };
+  content?: string;
+  draggable?: boolean;
+  group?: string;
+  inline?: boolean;
+  name?: string;
+  parseDOM?: Array<any>;
+  toDOM?: (node: any) => Array<any>;
+};
+
+export type MarkSpec = {
+  attrs?: { [key: string]: any };
+  name?: string;
+  parseDOM: Array<any>;
+  toDOM: (node: any) => Array<any>;
+};
+
+export type EditorProps = {
+  // TODO: Fill the interface.
+  // https://github.com/ProseMirror/prosemirror-view/blob/master/src/index.js
+};
+
+export type DirectEditorProps = EditorProps & {
+  // TODO: Fill the interface.
+  // https://github.com/ProseMirror/prosemirror-view/blob/master/src/index.js
+};
+
+export type RenderCommentProps = {
+  commentThreadId: string;
+  isActive: boolean;
+  requestCommentThreadDeletion: Function;
+  requestCommentThreadReflow: Function;
+};
+
+export type ImageLike = {
+  height: number;
+  id: string;
+  src: string;
+  width: number;
+};
+
+export type EditorRuntime = {
+  // Image Proxy
+  canProxyImageSrc?: (src: string) => boolean;
+  getProxyImageSrc?: (src: string) => string;
+
+  // Image Upload
+  canUploadImage?: () => boolean;
+  uploadImage?: (obj: Blob) => Promise<ImageLike>;
+
+  // Comments
+  canComment?: () => boolean;
+  createCommentThreadID?: () => string;
+  renderComment?: (
+    props: RenderCommentProps
+  ) => React.ReactElement<any> | undefined;
+
+  // External HTML
+  canLoadHTML?: () => boolean;
+  loadHTML?: () => Promise<string>;
+};
+
+// from './client/http';
+export function GET(url);
+export function POST(url, body, type);
+export function PUT(url, body, type);
+export function DELETE(url, type);
+export function PATCH(url, body, type);

package/index.js.flow

@@ -1,10 +1,10 @@
-// @flow
-
-export { EditorState } from 'prosemirror-state';
-export { default as isEditorStateEmpty } from './isEditorStateEmpty';
-export { default as uuid } from './ui/uuid';
-// [FS] IRAD-978 2020-06-05
-// Export Licit as a component
-export { default as Licit, DataType } from './client/Licit.js';
-// export { ImageLike, EditorRuntime } from './Types'; //Flow garbles these types beyond use for now
-export { GET, POST, DELETE, PATCH } from './client/http';
+// @flow
+
+export { EditorState } from 'prosemirror-state';
+export { default as isEditorStateEmpty } from './isEditorStateEmpty';
+export { default as uuid } from './ui/uuid';
+// [FS] IRAD-978 2020-06-05
+// Export Licit as a component
+export { default as Licit, DataType } from './client/Licit.js';
+// export { ImageLike, EditorRuntime } from './Types'; //Flow garbles these types beyond use for now
+export { GET, POST, DELETE, PATCH } from './client/http';

package/insertTable.js.flow

@@ -1,56 +1,56 @@
-// @flow
-
-import { Fragment, Schema } from 'prosemirror-model';
-import { TextSelection } from 'prosemirror-state';
-import { Transform } from 'prosemirror-transform';
-
-import { PARAGRAPH, TABLE, TABLE_CELL, TABLE_ROW } from './NodeNames.js';
-
-// const ZERO_WIDTH_SPACE_CHAR = '\u200b';
-
-export default function insertTable(
-  tr: Transform,
-  schema: Schema,
-  rows: number,
-  cols: number
-): Transform {
-  if (!tr.selection || !tr.doc) {
-    return tr;
-  }
-  const { from, to } = tr.selection;
-  if (from !== to) {
-    return tr;
-  }
-
-  const { nodes } = schema;
-  const cell = nodes[TABLE_CELL];
-  const paragraph = nodes[PARAGRAPH];
-  const row = nodes[TABLE_ROW];
-  const table = nodes[TABLE];
-  if (!(cell && paragraph && row && table)) {
-    return tr;
-  }
-
-  const rowNodes = [];
-  for (let rr = 0; rr < rows; rr++) {
-    const cellNodes = [];
-    for (let cc = 0; cc < cols; cc++) {
-      // [FS] IRAD-950 2020-05-25
-      // Fix:Extra arrow key required for cell navigation using arrow right/Left
-      const cellNode = cell.create(
-        undefined,
-        Fragment.fromArray([paragraph.create()])
-      );
-      cellNodes.push(cellNode);
-    }
-    const rowNode = row.create({}, Fragment.from(cellNodes));
-    rowNodes.push(rowNode);
-  }
-  const tableNode = table.create({}, Fragment.from(rowNodes));
-  tr = tr.insert(from, Fragment.from(tableNode));
-
-  const selection = TextSelection.create(tr.doc, from + 5, from + 5);
-
-  tr = tr.setSelection(selection);
-  return tr;
-}
+// @flow
+
+import { Fragment, Schema } from 'prosemirror-model';
+import { TextSelection } from 'prosemirror-state';
+import { Transform } from 'prosemirror-transform';
+
+import { PARAGRAPH, TABLE, TABLE_CELL, TABLE_ROW } from './NodeNames.js';
+
+// const ZERO_WIDTH_SPACE_CHAR = '\u200b';
+
+export default function insertTable(
+  tr: Transform,
+  schema: Schema,
+  rows: number,
+  cols: number
+): Transform {
+  if (!tr.selection || !tr.doc) {
+    return tr;
+  }
+  const { from, to } = tr.selection;
+  if (from !== to) {
+    return tr;
+  }
+
+  const { nodes } = schema;
+  const cell = nodes[TABLE_CELL];
+  const paragraph = nodes[PARAGRAPH];
+  const row = nodes[TABLE_ROW];
+  const table = nodes[TABLE];
+  if (!(cell && paragraph && row && table)) {
+    return tr;
+  }
+
+  const rowNodes = [];
+  for (let rr = 0; rr < rows; rr++) {
+    const cellNodes = [];
+    for (let cc = 0; cc < cols; cc++) {
+      // [FS] IRAD-950 2020-05-25
+      // Fix:Extra arrow key required for cell navigation using arrow right/Left
+      const cellNode = cell.create(
+        undefined,
+        Fragment.fromArray([paragraph.create()])
+      );
+      cellNodes.push(cellNode);
+    }
+    const rowNode = row.create({}, Fragment.from(cellNodes));
+    rowNodes.push(rowNode);
+  }
+  const tableNode = table.create({}, Fragment.from(rowNodes));
+  tr = tr.insert(from, Fragment.from(tableNode));
+
+  const selection = TextSelection.create(tr.doc, from + 5, from + 5);
+
+  tr = tr.setSelection(selection);
+  return tr;
+}

package/isEditorStateEmpty.js.flow

@@ -1,32 +1,32 @@
-// @flow
-
-import { EditorState } from 'prosemirror-state';
-
-const ZERO_WIDTH_SPACE_CHAR = '\u200b';
-
-export default function isEditorStateEmpty(editorState: EditorState): boolean {
-  const { doc } = editorState;
-  const { nodeSize } = doc;
-  if (nodeSize < 2) {
-    const text = doc.textContent;
-    return !text || text === ' ';
-  } else if (nodeSize < 10) {
-    let isEmpty = true;
-    doc.nodesBetween(0, doc.nodeSize - 2, (node, ii) => {
-      if (isEmpty) {
-        const nodeType = node.type;
-        if (nodeType.isText) {
-          const text = doc.textContent;
-          isEmpty = !text || text === ' ' || text === ZERO_WIDTH_SPACE_CHAR;
-        } else if (nodeType.isAtom) {
-          // e.g. Image, Video...etc.
-          isEmpty = false;
-        }
-      }
-      return isEmpty;
-    });
-    return isEmpty;
-  } else {
-    return false;
-  }
-}
+// @flow
+
+import { EditorState } from 'prosemirror-state';
+
+const ZERO_WIDTH_SPACE_CHAR = '\u200b';
+
+export default function isEditorStateEmpty(editorState: EditorState): boolean {
+  const { doc } = editorState;
+  const { nodeSize } = doc;
+  if (nodeSize < 2) {
+    const text = doc.textContent;
+    return !text || text === ' ';
+  } else if (nodeSize < 10) {
+    let isEmpty = true;
+    doc.nodesBetween(0, doc.nodeSize - 2, (node, ii) => {
+      if (isEmpty) {
+        const nodeType = node.type;
+        if (nodeType.isText) {
+          const text = doc.textContent;
+          isEmpty = !text || text === ' ' || text === ZERO_WIDTH_SPACE_CHAR;
+        } else if (nodeType.isAtom) {
+          // e.g. Image, Video...etc.
+          isEmpty = false;
+        }
+      }
+      return isEmpty;
+    });
+    return isEmpty;
+  } else {
+    return false;
+  }
+}

package/isTableNode.js.flow

@@ -1,15 +1,15 @@
-// @flow
-
-import { Node } from 'prosemirror-model';
-
-import { TABLE, TABLE_CELL, TABLE_HEADER, TABLE_ROW } from './NodeNames';
-
-export default function isTableNode(node: Node): boolean {
-  const name = node instanceof Node ? node.type.name : null;
-  return (
-    name === TABLE ||
-    name === TABLE_ROW ||
-    name === TABLE_HEADER ||
-    name === TABLE_CELL
-  );
-}
+// @flow
+
+import { Node } from 'prosemirror-model';
+
+import { TABLE, TABLE_CELL, TABLE_HEADER, TABLE_ROW } from './NodeNames';
+
+export default function isTableNode(node: Node): boolean {
+  const name = node instanceof Node ? node.type.name : null;
+  return (
+    name === TABLE ||
+    name === TABLE_ROW ||
+    name === TABLE_HEADER ||
+    name === TABLE_CELL
+  );
+}

package/joinDown.js.flow

@@ -1,27 +1,27 @@
-// @flow
-// https://github.com/ProseMirror/prosemirror-commands/blob/master/src/commands.js
-
-import { NodeSelection } from 'prosemirror-state';
-import { Transform } from 'prosemirror-transform';
-import { canJoin } from 'prosemirror-transform';
-import { joinPoint } from 'prosemirror-transform';
-
-// Join the selected block, or the closest ancestor of the selection
-// that can be joined, with the sibling after it.
-export default function joinDown(tr: Transform): Transform {
-  const sel = tr.selection;
-  let point;
-  if (sel instanceof NodeSelection) {
-    if (sel.node.isTextblock || !canJoin(tr.doc, sel.to)) {
-      return tr;
-    }
-    point = sel.to;
-  } else {
-    point = joinPoint(tr.doc, sel.to, 1);
-    if (point === null || point === undefined) {
-      return tr;
-    }
-  }
-  tr = tr.join(point);
-  return tr;
-}
+// @flow
+// https://github.com/ProseMirror/prosemirror-commands/blob/master/src/commands.js
+
+import { NodeSelection } from 'prosemirror-state';
+import { Transform } from 'prosemirror-transform';
+import { canJoin } from 'prosemirror-transform';
+import { joinPoint } from 'prosemirror-transform';
+
+// Join the selected block, or the closest ancestor of the selection
+// that can be joined, with the sibling after it.
+export default function joinDown(tr: Transform): Transform {
+  const sel = tr.selection;
+  let point;
+  if (sel instanceof NodeSelection) {
+    if (sel.node.isTextblock || !canJoin(tr.doc, sel.to)) {
+      return tr;
+    }
+    point = sel.to;
+  } else {
+    point = joinPoint(tr.doc, sel.to, 1);
+    if (point === null || point === undefined) {
+      return tr;
+    }
+  }
+  tr = tr.join(point);
+  return tr;
+}