glib-web 2.3.0 → 2.3.1

package/components/fields/richText.vue

@@ -1,8 +1,8 @@
 <template>
   <div :style="$styles()" :class="$classes()">
     <v-tabs v-model="mode" fixed-tabs>
-      <v-tab>Editor</v-tab>
-      <v-tab>Code</v-tab>
+      <v-tab @click="onRichTextClicked">Editor</v-tab>
+      <v-tab @click="onRawTextClicked">Code</v-tab>
     </v-tabs>
 
     <v-progress-linear v-if="showProgress" v-model="progress.value" />
@@ -11,22 +11,22 @@
     <VueEditor
       v-if="!rawMode"
       id="rich-editor"
-      v-model="htmlValue"
+      v-model="richEditorValue"
       :editor-toolbar="customToolbar"
       use-custom-image-handler
-      @text-change="onEditorChange"
+      @text-change="onRichTextEditorChanged"
       @image-added="uploadImage"
+      :editorOptions="editorSettings"
     />
     <!-- Hide these fields but don't remove them because these are the values that will get submitted. -->
     <div :style="{ display: rawMode ? 'block' : 'none' }">
       <v-textarea
         id="raw-editor"
-        v-model="producedValue"
-        :name="spec.name"
+        v-model="rawEditorValue"
         :style="$styles()"
         :class="$classes()"
         :outlined="$classes().includes('outlined')"
-        @input="onCodeChange"
+        @input="onRawTextEditorChanged"
       ></v-textarea>
       <v-text-field
         v-for="(imageKey, index) in imageKeys"
@@ -39,6 +39,7 @@
         :value="images[imageKey]"
       />
     </div>
+    <input type="hidden" :name="spec.name" :value="producedValue" />
   </div>
 </template>
 
@@ -47,29 +48,156 @@ import Uploader from "../../utils/uploader";
 import { VueEditor, Quill } from "vue2-editor";
 import TurndownService from "turndown";
 import { gfm } from "turndown-plugin-gfm";
+import eventFiltering from "../../utils/eventFiltering";
+import QuillImageDropAndPaste from "quill-image-drop-and-paste";
+import bus from "../../utils/eventBus";
+
+Quill.register("modules/imageDropAndPaste", QuillImageDropAndPaste);
+
+var ImageBlot = Quill.import("formats/image");
+ImageBlot.sanitize = function (url) {
+  return url;
+};
+
+class Parser {
+  static markdownToHtml(data) {
+    return Utils.format.markdownForEditor(data);
+  }
+
+  static htmlToMarkdown(data) {
+    const turndownService = new TurndownService({ headingStyle: "atx" });
+    turndownService.use(gfm);
+    turndownService.addRule("strikethrough", {
+      filter: ["del", "s", "strike"],
+      replacement: function (content) {
+        return "~~" + content + "~~";
+      },
+    });
+
+    turndownService.addRule("codeblock", {
+      filter: ["pre"],
+      replacement: function (content) {
+        return "```\n" + content + "```";
+      },
+    });
+    return turndownService.turndown(data);
+  }
+}
+
+class TextEditor {
+  constructor(context) {
+    this.context = context;
+  }
+
+  // input and output should be either 'html' or 'markdown'
+  producedValue(data, input, output) {
+    if (output == "markdown") {
+      return this.markdownValue(this.replaceWithFakeImage(data), input);
+    } else if (output == "html") {
+      return this.replaceWithFakeImage(this.htmlValue(data, input));
+    }
+  }
+
+  markdownValue(data, input = "html") {
+    if (input == "html") {
+      return Parser.htmlToMarkdown(data);
+    } else if (input == "markdown") {
+      return data;
+    }
+  }
+
+  htmlValue(data, input) {
+    if (input == "html") {
+      return data;
+    } else if (input == "markdown") {
+      return Parser.markdownToHtml(data);
+    }
+  }
+
+  markdownValueWithRealImage(data, input) {
+    return this.markdownValue(this.replaceWithRealImage(data), input);
+  }
+
+  htmlValueWithRealImage(data, input) {
+    return this.htmlValue(this.replaceWithRealImage(data), input);
+  }
+
+  // replace {{image1}} to real image1 url
+  replaceWithRealImage(html) {
+    const vm = this.context;
+    return html.replace(/\{\{image([0-9]+)\}\}/g, function (_, index) {
+      const image = vm.spec.images[index - 1];
+      if (
+        image &&
+        vm.$type.isString(image.value) &&
+        vm.$type.isString(image.fileUrl)
+      ) {
+        const url = image.fileUrl;
+        const key = url.hashCode().toString();
+        vm.images[key] = image.value;
+        return url;
+      }
+      return "{{IMAGE_NOT_FOUND}}";
+    });
+  }
+
+  // replace image1 url with {{image1}}
+  replaceWithFakeImage(html) {
+    const vm = this.context;
+    let index = 0;
+    vm.imageKeys.clear();
+    return html.replace(/src="([^"]+)"|\!\[\]\((.+)\)/g, function (_, g1, g2) {
+      var imageValue = g1 || g2;
+      // It seems that quill encodes '&' in the URL to '&amp;' which would screw up key matching.
+      var decodedValue = imageValue.replace(/&amp;/g, "&");
+      const key = decodedValue.hashCode().toString();
+      vm.imageKeys.push(key);
+      if (g1) {
+        return `src="{{image${++index}}}"`;
+      } else {
+        return `{{image${++index}}}`;
+      }
+    });
+  }
+}
 
 export default {
   components: { VueEditor },
   props: {
-    spec: { type: Object, required: true }
+    spec: { type: Object, required: true },
   },
   data: () => ({
     customToolbar: [
       ["bold", "italic", "strike"],
       [{ header: 1 }, { header: 2 }, { header: 3 }],
       [{ list: "ordered" }, { list: "bullet" }],
-      ["image", "link"]
+      ["image", "link"],
     ],
-    htmlValue: "",
-    cleanValue: null,
+    editorSettings: {
+      modules: {
+        imageDropAndPaste: {
+          // add an custom image handler
+          handler: function (imageDataUrl, type, imageData) {
+            bus.$emit("richText/dropOrPaste", {
+              file: imageData.toFile(),
+              editor: this.quill,
+              cursorLocation: this.getIndex(),
+            });
+          },
+        },
+      },
+    },
+    richEditorValue: "",
+    rawEditorValue: "",
     producedValue: "",
     images: {},
     imageKeys: [],
     progress: { value: -1 },
     imageUploader: {},
-    produce: null,
+    textEditor: null,
     mode: null,
-    turndownService: new TurndownService({ headingStyle: "atx" })
+    produce: null,
+    accept: null,
   }),
   computed: {
     showProgress() {
@@ -77,88 +205,37 @@ export default {
     },
     rawMode() {
       return this.mode == 1;
-    }
-  },
-  watch: {
-    cleanValue(val, oldVal) {
-      if (oldVal == null) {
-        // Don't update `producedValue` if this is first-time initialization to preserve the original value.
-        return;
-      }
-      switch (this.produce) {
-        case "html":
-          this.producedValue = val;
-          break;
-        case "markdown":
-          this.producedValue = this.turndownService.turndown(val);
-          break;
-        default:
-          console.log(`Unsupported format: ${this.produce}`);
-      }
     },
-    producedValue(val) {
-      switch (this.produce) {
-        case "html":
-          this.htmlValue = val;
-          break;
-        case "markdown":
-          this.htmlValue = this.toHtmlValue(val);
-          break;
-        default:
-          console.log(`Unsupported format: ${this.produce}`);
-      }
-    }
   },
+  watch: {},
   mounted() {
-    this.registerScrollEvent();
+    bus.$on("richText/dropOrPaste", ({ file, editor, cursorLocation }) =>
+      this.uploadImage(file, editor, cursorLocation)
+    );
   },
   methods: {
     $ready() {
       this.produce = this.spec.produce || "markdown";
+      this.accept = this.spec.accept || "markdown";
 
-      this.turndownService.use(gfm);
-      this.turndownService.addRule("strikethrough", {
-        filter: ["del", "s", "strike"],
-        replacement: function(content) {
-          return "~~" + content + "~~";
-        }
-      });
-
-      this.turndownService.addRule("codeblock", {
-        filter: ["pre"],
-        replacement: function(content) {
-          return "```\n" + content + "```";
-        }
-      });
-
+      this.textEditor = new TextEditor(this);
       this.imageUploader = this.spec.imageUploader;
 
-      // Convert initial markdown value to html for displaying.
-      this.producedValue = this.spec.value || "";
-      this.htmlValue = this.toHtmlValue(this.producedValue);
-    },
-    toHtmlValue(producedValue) {
-      const vm = this;
-      var value = producedValue.replace(/\{\{image([0-9]+)\}\}/g, function(
-        _,
-        index
-      ) {
-        const image = vm.spec.images[index - 1];
-        if (
-          image &&
-          vm.$type.isString(image.value) &&
-          vm.$type.isString(image.fileUrl)
-        ) {
-          const url = image.fileUrl;
-          const key = url.hashCode().toString();
-          vm.images[key] = image.value;
-          return url;
-        }
-        return "{{IMAGE_NOT_FOUND}}";
-      });
-      return this.produce == "markdown" ? Utils.format.markdown(value) : value;
+      this.richEditorValue = this.textEditor.htmlValueWithRealImage(
+        this.spec.value,
+        this.accept
+      );
+      this.rawEditorValue = this.textEditor.markdownValueWithRealImage(
+        this.spec.value,
+        this.accept
+      );
+      this.producedValue = this.textEditor.producedValue(
+        this.spec.value,
+        this.accept,
+        this.produce
+      );
     },
-    uploadImage: function(file, editor, cursorLocation) {
+    uploadImage: function (file, editor, cursorLocation) {
       let vm = this;
       const uploaderSpec = this.imageUploader;
       // const input = this.$refs.directUploadFile
@@ -175,6 +252,7 @@ export default {
         upload.start((error, blob) => {
           if (error) {
             // Handle the error
+            console.error(error);
           } else {
             vm.insertImage(file, editor, cursorLocation, blob);
           }
@@ -184,17 +262,43 @@ export default {
         });
       }
     },
-    onEditorChange() {
-      this.separateOutImages();
-      this.onCodeChange();
+    onRichTextClicked() {
+      this.richEditorValue = this.textEditor.htmlValue(
+        this.rawEditorValue,
+        "markdown"
+      );
+    },
+    onRawTextClicked() {
+      this.rawEditorValue = this.textEditor.markdownValue(
+        this.richEditorValue,
+        "html"
+      );
     },
-    onCodeChange() {
-      Utils.type.ifObject(this.spec.onChange, onChange => {
+    onRichTextEditorChanged: eventFiltering.debounce(function () {
+      this.producedValue = this.textEditor.producedValue(
+        this.richEditorValue,
+        "html",
+        this.produce
+      );
+
+      this.onChange(this.producedValue);
+    }),
+    onRawTextEditorChanged: eventFiltering.debounce(function () {
+      this.producedValue = this.textEditor.producedValue(
+        this.rawEditorValue,
+        "markdown",
+        this.produce
+      );
+
+      this.onChange(this.producedValue);
+    }),
+    onChange(producedValue) {
+      Utils.type.ifObject(this.spec.onChange, (onChange) => {
         this.$nextTick(() => {
           const params = {
             [this.spec.paramNameForFormData || "formData"]: {
-              [this.fieldName]: this.fieldModel
-            }
+              [this.fieldName]: producedValue,
+            },
           };
 
           const data = Object.assign({}, onChange, params);
@@ -202,32 +306,16 @@ export default {
         });
       });
     },
-    separateOutImages: function() {
-      const vm = this;
-      var index = 0;
-      vm.imageKeys.clear();
-      // TODO: Fix to avoid replacing <video src="">
-      this.cleanValue = this.htmlValue.replace(/src="([^"]+)"/g, function(
-        _,
-        imageValue
-      ) {
-        // It seems that quill encodes '&' in the URL to '&amp;' which would screw up key matching.
-        var decodedValue = imageValue.replace(/&amp;/g, "&");
-        const key = decodedValue.hashCode().toString();
-        vm.imageKeys.push(key);
-        return `src="{{image${++index}}}"`;
-      });
-    },
-    insertImage: function(file, Editor, cursorLocation, blob) {
+    insertImage: function (file, Editor, cursorLocation, blob) {
       let vm = this;
       var reader = new FileReader();
-      reader.onload = function(e) {
+      reader.onload = function (e) {
         // vm.fileUrl = e.target.result;
         if (file.type.indexOf("image") !== -1) {
           var image = new Image();
-          image.src = e.target.result;
+          image.src = URL.createObjectURL(file);
 
-          image.onload = function() {
+          image.onload = function () {
             Editor.insertEmbed(cursorLocation, "image", image.src);
           };
 
@@ -238,7 +326,7 @@ export default {
       reader.readAsDataURL(file);
       vm.progress.value = -1;
     },
-    updateToolbar: function(wrapper, toolbar, container) {
+    updateToolbar: function (wrapper, toolbar, container) {
       if (wrapper.scrollTop >= container.offsetTop) {
         toolbar.classList.add("sticky");
         toolbar.style.top = `${wrapper.offsetTop}px`;
@@ -251,7 +339,7 @@ export default {
         toolbar.style.width = "auto";
       }
     },
-    registerScrollEvent: function() {
+    registerScrollEvent: function () {
       const wrapper = document.querySelector(".v-dialog") || window;
       const toolbar = this.$el.querySelector(".ql-toolbar");
       const container = this.$el.querySelector(".ql-container");
@@ -264,8 +352,8 @@ export default {
           this.updateToolbar(wrapper, toolbar, container)
         );
       }
-    }
-  }
+    },
+  },
 };
 </script>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glib-web",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -21,6 +21,7 @@
     "marked": "^4.0.0",
     "phoenix": "^1.5.3",
     "push.js": "^1.0.12",
+    "quill-image-drop-and-paste": "^1.2.14",
     "turndown": "^7.1.1",
     "turndown-plugin-gfm": "^1.0.2",
     "vue": "2.6.14",
@@ -29,8 +30,8 @@
     "vue-social-sharing": "^3.0.9",
     "vue-youtube": "^1.4.0",
     "vue2-editor": "^2.9.1",
-    "vue2-google-maps": "^0.10.6",
     "vue2-gmap-custom-marker": "^6.1.1",
+    "vue2-google-maps": "^0.10.6",
     "vuedraggable": "^2.24.1",
     "vuetify": "2.3.9"
   },
@@ -43,6 +44,7 @@
     "eslint-plugin-prettier": "^3.1.1",
     "eslint-plugin-vue": "^5.2.3",
     "eslint-plugin-vuetify": "^1.0.0-beta.3",
-    "prettier": "^1.18.2"
+    "prettier": "^1.18.2",
+    "typescript": "^4.9.5"
   }
 }

package/tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}

package/utils/format.js

@@ -1,8 +1,30 @@
 import { marked } from "marked";
 
 export default class {
+  static markdownForEditor(text) {
+
+    const renderer = {
+      listitem(text, task, checked) {
+        return `<li>${text.replace(/\<p\>|\<\/p\>/g, "")}</li>`
+      },
+      list(body, ordered, start) {
+        if (ordered) {
+          return `<ol>${body}</ol>`
+        } else {
+          return `<ul>${body}</ul>`
+        }
+      }
+    };
+
+    marked.use({ renderer });
+
+    return marked.parse(
+      text, { break: true }
+    );
+  }
+
   static markdown(text) {
-    return marked(text);
+    return marked.parse(text)
   }
 
   static local_iso8601(date) {