@modusoperandi/licit 1.0.0 → 1.0.2

package/index.d.ts

@@ -1,6 +1,165 @@
-export { EditorState } from "prosemirror-state";
-export { default as isEditorStateEmpty } from "./isEditorStateEmpty";
-export { default as uuid } from "./ui/uuid";
-export { default as Licit, DataType } from "./client/Licit.js";
-export { ImageLike, EditorRuntime } from "./Types";
-export { GET, POST, DELETE, PATCH } from "./client/http";
+// 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

@@ -4,5 +4,5 @@ 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';
+// export { ImageLike, EditorRuntime } from './Types'; //Flow garbles these types beyond use for now
 export { GET, POST, DELETE, PATCH } from './client/http';

package/index.js.flow

@@ -6,5 +6,5 @@ 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';
+// export { ImageLike, EditorRuntime } from './Types'; //Flow garbles these types beyond use for now
 export { GET, POST, DELETE, PATCH } from './client/http';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modusoperandi/licit",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "subversion": "1",
   "description": "Rich text editor built with React and ProseMirror",
@@ -57,7 +57,7 @@
     "@babel/preset-react": "^7.18.6",
     "@cyclonedx/cyclonedx-npm": "^1.11.0",
     "babel-jest": "^29.2.0",
-    "babel-loader": "^8.2.5",
+    "babel-loader": "^9.1.3",
     "babel-plugin-flow-react-proptypes": "^26.0.0",
     "babel-plugin-transform-react-remove-prop-types": "^0.4.24",
     "clean-webpack-plugin": "^4.0.0",
@@ -75,22 +75,26 @@
     "flow-bin": "^0.228.0",
     "flow-copy-source": "^2.0.9",
     "flow-webpack-plugin": "^1.2.0",
-    "html-loader": "^1.1.0",
+    "html-loader": "^5.0.0",
     "html-webpack-inline-source-plugin": "1.0.0-beta.2",
     "html-webpack-plugin": "^5.5.0",
-    "husky": "^8.0.1",
+    "husky": "^9.0.10",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.2.0",
     "jest-environment-jsdom": "^29.3.1",
-    "jest-prosemirror": "^1.0.3",
+    "jest-junit": "^14.0.1",
+    "jest-prosemirror": "^2.1.5",
     "jest-sonar-reporter": "^2.0.0",
     "lint-staged": "^13.0.3",
     "mkdirp": "^3.0.1",
     "prettier": "^2.1.2",
     "stylelint": "^15.6.0",
-    "stylelint-config-standard": "^33.0.0",
+    "stylelint-config-standard": "^34.0.0",
     "stylelint-prettier": "^3.0.0",
-    "terser-webpack-plugin": "^3.1.0",
+    "terser-webpack-plugin": "^5.3.10",
+    "ts-jest": "^29.1.2",
+    "ts-loader": "^9.5.0",
+    "ts-node": "^10.9.2",
     "webpack": "^5.74.0",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.11.1",
@@ -99,6 +103,7 @@
   "dependencies": {
     "@cfaester/enzyme-adapter-react-18": "^0.7.1",
     "body-parser": "^1.19.0",
+    "browserkeymap": "^2.0.2",
     "cors": "^2.8.5",
     "express": "^4.17.1",
     "flatted": "^3.1.0",
@@ -115,7 +120,8 @@
     "resize-observer-polyfill": "^1.5.1",
     "smooth-scroll-into-view-if-needed": "^1.1.28",
     "style-loader": "^3.3.3",
-    "url": "^0.11.0"
+    "url": "^0.11.0",
+    "webfontloader": "^1.6.28"
   },
   "peerDependencies": {
     "@modusoperandi/licit-ui-commands": "^1.0.0",

package/patchStyleElements.js.flow

@@ -97,7 +97,7 @@ export default function patchStyleElements(doc: Document): void {
   // Sort selector by
   selectorTextToCSSTexts
     .sort(sortBySpecificity)
-    .reduce(buildElementToCSSTexts.bind(null, doc), new Map<any, any>())
+    .reduce(buildElementToCSSTexts.bind(null, doc), new Map())
     .forEach(applyInlineStyleSheetCSSTexts);
 }
 

package/ui/ResizeObserver.js.flow

@@ -7,14 +7,14 @@ import nullthrows from 'nullthrows';
 // https://github.com/que-etc/resize-observer-polyfill/blob/master/src/index.js.flow
 
 type ClientRectLikeReadOnly = {
-  +x: number,
-  +y: number,
-  +width: number,
-  +height: number,
-  +top: number,
-  +right: number,
-  +bottom: number,
-  +left: number,
+  x: number,
+  y: number,
+  width: number,
+  height: number,
+  top: number,
+  right: number,
+  bottom: number,
+  left: number,
 };
 
 type ResizeCallback = (r: ResizeObserverEntry) => void;
@@ -29,13 +29,13 @@ type Entries = $ReadOnlyArray<ResizeObserverEntry>;
 //   `ResizeObserver.unobserve(element)`
 
 export type ResizeObserverEntry = {
-  +target: Element,
-  +contentRect: ClientRectLikeReadOnly,
+  target: Element,
+  contentRect: ClientRectLikeReadOnly,
 };
 
 let instance: ?ResizeObserver = null;
 
-const nodesObserving: Map<Element, Array<ResizeCallback>> = new Map<any, any>();
+const nodesObserving: Map<Element, Array<ResizeCallback>> = new Map();
 
 function onResizeObserve(entries: Entries): void {
   entries.forEach(handleResizeObserverEntry);

package/ui/injectStyleSheet.js.flow

@@ -2,7 +2,7 @@
 
 import url from 'url';
 
-const addedElements = new Map<any, any>();
+const addedElements = new Map();
 
 function createElement(tag: string, attrs: Object): Element {
   const el: any = document.createElement(tag);