textbrowser 0.40.0 → 0.41.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textbrowser",
-  "version": "0.40.0",
+  "version": "0.41.0",
   "description": "Multilinear text browser",
   "main": "dist/index-umd.min.js",
   "module": "resources/index.js",
@@ -39,62 +39,62 @@
     "text"
   ],
   "dependencies": {
-    "@babel/core": "^7.14.6",
-    "@babel/register": "^7.14.5",
+    "@babel/core": "^7.16.7",
+    "@babel/register": "^7.16.9",
     "@brettz9/node-static": "^0.1.1",
-    "command-line-args": "^5.1.1",
+    "command-line-args": "^5.2.0",
     "dialog-polyfill": "^0.5.6",
     "dom-parser": "^0.1.6",
     "form-serialization": "^0.11.0",
     "imf": "5.0.2",
-    "indexeddbshim": "^7.1.0",
+    "indexeddbshim": "^9.0.0",
     "jamilih": "0.54.0",
-    "jsdom": "^16.6.0",
+    "jsdom": "^19.0.0",
     "json-refs": "git+https://github.com/brettz9/json-refs.git#browser",
     "load-stylesheets": "0.10.0",
-    "node-fetch": "^2.6.1",
+    "node-fetch": "^2.6.6",
     "node-serviceworker": "^0.3.0",
-    "rtl-detect": "^1.0.3",
+    "rtl-detect": "^1.0.4",
     "simple-get-json": "8.1.1",
     "url-search-params-polyfill": "^8.1.1"
   },
   "devDependencies": {
-    "@babel/eslint-parser": "^7.14.5",
-    "@babel/plugin-proposal-object-rest-spread": "^7.14.5",
+    "@babel/eslint-parser": "^7.16.5",
+    "@babel/plugin-proposal-object-rest-spread": "^7.16.7",
     "@babel/plugin-syntax-dynamic-import": "^7.8.3",
-    "@babel/preset-env": "^7.14.5",
-    "@brettz9/eslint-plugin": "^1.0.3",
+    "@babel/preset-env": "^7.16.8",
+    "@brettz9/eslint-plugin": "^1.0.4",
     "@rollup/plugin-babel": "^5.3.0",
-    "@rollup/plugin-commonjs": "^19.0.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.0.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
     "@stadtlandnetz/rollup-plugin-postprocess": "1.1.0",
-    "ajv": "8.6.0",
+    "ajv": "8.8.2",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "chai": "^4.3.4",
-    "eslint": "^7.28.0",
-    "eslint-config-ash-nazg": "^29.17.0",
+    "eslint": "^8.6.0",
+    "eslint-config-ash-nazg": "^32.3.0",
     "eslint-config-standard": "^16.0.3",
     "eslint-plugin-array-func": "^3.1.7",
-    "eslint-plugin-compat": "^3.9.0",
+    "eslint-plugin-compat": "^4.0.1",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-html": "^6.1.2",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jsdoc": "^35.2.0",
-    "eslint-plugin-markdown": "^2.2.0",
-    "eslint-plugin-no-unsanitized": "^3.1.5",
+    "eslint-plugin-html": "^6.2.0",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jsdoc": "^37.6.1",
+    "eslint-plugin-markdown": "^2.2.1",
+    "eslint-plugin-no-unsanitized": "^4.0.1",
     "eslint-plugin-no-use-extend-native": "^0.5.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^5.1.0",
-    "eslint-plugin-radar": "^0.2.1",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-sonarjs": "^0.11.0",
     "eslint-plugin-standard": "^4.1.0",
-    "eslint-plugin-unicorn": "^33.0.1",
-    "fast-json-patch": "2.2.1",
+    "eslint-plugin-unicorn": "^40.0.0",
+    "fast-json-patch": "3.1.0",
     "json-metaschema": "1.3.0",
-    "mocha": "^9.0.0",
+    "mocha": "^9.1.3",
     "npm-run-all": "^4.1.5",
-    "open-cli": "^7.0.0",
-    "rollup": "2.51.2",
+    "open-cli": "^7.0.1",
+    "rollup": "2.63.0",
     "rollup-plugin-re": "^1.0.7",
     "rollup-plugin-terser": "^7.0.2"
   }

package/resources/index.js

@@ -137,7 +137,7 @@ async function requestPermissions (langs, l) {
         // rememberRefusal();
         resolve();
         return;
-        // eslint-disable-next-line radar/no-duplicated-branches
+        // eslint-disable-next-line sonarjs/no-duplicated-branches
       case 'default':
         resolve();
         return;
@@ -191,6 +191,8 @@ class TextBrowser {
       ? true
       : options.localizeParamNames;
     this.hideFormattingSection = Boolean(options.hideFormattingSection);
+
+    this.preferencesPlugin = options.preferencesPlugin;
     this.interlinearSeparator = options.interlinearSeparator;
     // Todo: Make these user facing options
     this.showEmptyInterlinear = options.showEmptyInterlinear;
@@ -532,7 +534,8 @@ class TextBrowser {
           lang, preferredLocale,
           fallbackLanguages,
           languageParam,
-          $p, languages
+          $p, languages,
+          preferencesPlugin: this.preferencesPlugin
         });
         return true;
       }

package/resources/templates/workDisplay.js

@@ -547,7 +547,7 @@ export default {
     languageParam, lf, paramsSetter, replaceHash,
     getFieldAliasOrNames, work,
     langs, imfl, l, localizeParamNames, namespace,
-    hideFormattingSection, groups
+    hideFormattingSection, groups, preferencesPlugin
   }) => ['div', {
     style: {textAlign: 'left'}, id: 'preferences', hidden: 'true'
   }, [
@@ -611,85 +611,10 @@ export default {
         ]];
       })]
     ]],
-    ['div', [
-      ['button', {
-        title: l('bookmark_generation_tooltip'),
-        $on: {
-          async click () { // Todo: Give option to edit (keywords and work URLs)
-            const date = Date.now();
-            const ADD_DATE = date;
-            const LAST_MODIFIED = date;
-            const blob = new Blob([
-              new XMLSerializer().serializeToString(
-                jml({$document: {
-                  $DOCTYPE: {name: 'NETSCAPE-Bookmark-file-1'},
-                  title: l('Bookmarks'),
-                  body: [
-                    ['h1', [l('Bookmarks_Menu')]],
-                    ...(await getFieldAliasOrNames()).flatMap(({groupName, worksToFields}) => {
-                      return [
-                        ['dt', [
-                          ['h3', {
-                            ADD_DATE,
-                            LAST_MODIFIED
-                          }, [
-                            groupName
-                          ]]
-                        ]],
-                        ['dl', [
-                          ['p'],
-                          ...worksToFields.map(({fieldAliasOrNames, workName, shortcut: SHORTCUTURL}) => {
-                            // Todo (low): Add anchor, etc. (until handled by `work-startEnd`); &aqdas-anchor1-1=2&anchorfield1=Paragraph
-                            // Todo: option for additional browse field groups (startEnd2, etc.)
-                            // Todo: For link text, use `heading` or `alias` from metadata files in place of workName (requires loading all metadata files though)
-                            // Todo: Make Chrome NativeExt add-on to manipulate its search engines (to read a bookmarks file from Firefox properly, i.e., including keywords) https://www.makeuseof.com/answers/export-google-chrome-search-engines-address-bar/
-
-                            const paramsCopy = paramsSetter({
-                              ...getDataForSerializingParamsAsURL(),
-                              fieldAliasOrNames,
-                              workName: work, // Delete work of current page
-                              type: 'shortcutResult'
-                            });
-                            const url = replaceHash(paramsCopy) + `&work=${workName}&${workName}-startEnd1=%s`; // %s will be escaped if set as param; also add changeable workName here
-
-                            return ['dt', [
-                              ['a', {
-                                href: url,
-                                ADD_DATE,
-                                LAST_MODIFIED,
-                                SHORTCUTURL
-                              }, [
-                                workName
-                              ]]
-                            ]];
-                          })
-                        ]]
-                      ];
-                    })
-                  ]
-                }})
-              ).replace(
-                // Chrome has a quirk that requires this (and not
-                //   just any whitespace)
-                // We're not getting the keywords with Chrome,
-                //   but at least usable for bookmarks (though
-                //   not the groups apparently)
-                /<dt>/g,
-                '\n<dt>'
-              )
-            ], {type: 'text/html'});
-            const url = window.URL.createObjectURL(blob);
-            const a = jml('a', {
-              hidden: true,
-              download: 'bookmarks.html',
-              href: url
-            }, $('#main'));
-            a.click();
-            URL.revokeObjectURL(url);
-          }
-        }
-      }, [l('Generate_bookmarks')]]
-    ]]
+    (preferencesPlugin ? preferencesPlugin({
+      $, l, jml, paramsSetter, getDataForSerializingParamsAsURL, work,
+      replaceHash, getFieldAliasOrNames
+    }) : '')
   ]],
   addBrowseFields ({browseFields, fieldInfo, ld, i, iil, $p, content}) {
     const work = $p.get('work');
@@ -830,7 +755,7 @@ export default {
     getFieldAliasOrNames,
     hideFormattingSection, $p,
     metadataObj, il, le, ld, iil, fieldMatchesLocale,
-    preferredLocale, schemaItems, content, groups
+    preferredLocale, schemaItems, content, groups, preferencesPlugin
   }) {
     const work = $p.get('work');
     const serializeParamsAsURLWithData = ({type}) => {
@@ -863,7 +788,7 @@ export default {
             languageParam, lf, paramsSetter, replaceHash,
             getFieldAliasOrNames, work,
             langs, imfl, l, localizeParamNames, namespace,
-            groups, hideFormattingSection
+            groups, hideFormattingSection, preferencesPlugin
           })
         ]],
         ['h2', [heading]],

package/resources/utils/Metadata.js

@@ -33,9 +33,14 @@ export const getMetaProp = function getMetaProp (lang, metadataObj, properties,
 //      file.anyOf.splice(1, 1, {$ref: schemaFile});
 // Todo: Allow use of dbs and fileGroup together in base directories?
 export const getMetadata = async (file, property, basePath) => {
+  const url = new URL(basePath || getCurrDir());
+  url.search = ''; // Clear out query string, e.g., `?fbclid` from Facebook
+  url.pathname = file;
+  url.hash = property ? '#/' + property : '';
+
   return (await JsonRefs
     .resolveRefsAt(
-      (basePath || getCurrDir()) + file + (property ? '#/' + property : ''),
+      url.toString(),
       {
         loaderOptions: {
           processContent (res, callback) {

package/resources/workDisplay.js

@@ -12,6 +12,7 @@ export default async function workDisplay ({
   l, languageParam,
   lang, preferredLocale, languages, fallbackLanguages, $p
 }) {
+  const {preferencesPlugin} = this;
   const langs = this.langData.languages;
 
   const fallbackDirection = this.getDirectionForLanguageCode(fallbackLanguages[0]);
@@ -41,7 +42,6 @@ export default async function workDisplay ({
       ? key => l(['params', 'indexed', key])
       : key => key;
 
-    // eslint-disable-next-line unicorn/prefer-prototype-methods -- Convenient
     const localeFromLangData = languages.localeFromLangData.bind(languages);
     const imfLang = IMF({
       locales: lang.map(localeFromLangData),
@@ -137,7 +137,8 @@ export default async function workDisplay ({
       hideFormattingSection, $p,
       metadataObj, il, le, ld, iil,
       fieldMatchesLocale,
-      preferredLocale, schemaItems, content
+      preferredLocale, schemaItems, content,
+      preferencesPlugin
     });
   }
 

package/server/main-cjs.js

@@ -13,14 +13,9 @@ function ownKeys(object, enumerableOnly) {
 
   if (Object.getOwnPropertySymbols) {
     var symbols = Object.getOwnPropertySymbols(object);
-
-    if (enumerableOnly) {
-      symbols = symbols.filter(function (sym) {
-        return Object.getOwnPropertyDescriptor(object, sym).enumerable;
-      });
-    }
-
-    keys.push.apply(keys, symbols);
+    enumerableOnly && (symbols = symbols.filter(function (sym) {
+      return Object.getOwnPropertyDescriptor(object, sym).enumerable;
+    })), keys.push.apply(keys, symbols);
   }
 
   return keys;
@@ -28,19 +23,12 @@ function ownKeys(object, enumerableOnly) {
 
 function _objectSpread2(target) {
   for (var i = 1; i < arguments.length; i++) {
-    var source = arguments[i] != null ? arguments[i] : {};
-
-    if (i % 2) {
-      ownKeys(Object(source), true).forEach(function (key) {
-        _defineProperty(target, key, source[key]);
-      });
-    } else if (Object.getOwnPropertyDescriptors) {
-      Object.defineProperties(target, Object.getOwnPropertyDescriptors(source));
-    } else {
-      ownKeys(Object(source)).forEach(function (key) {
-        Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
-      });
-    }
+    var source = null != arguments[i] ? arguments[i] : {};
+    i % 2 ? ownKeys(Object(source), !0).forEach(function (key) {
+      _defineProperty(target, key, source[key]);
+    }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) {
+      Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key));
+    });
   }
 
   return target;
@@ -772,7 +760,8 @@ var workDisplay = {
     localizeParamNames,
     namespace,
     hideFormattingSection,
-    groups
+    groups,
+    preferencesPlugin
   }) => ['div', {
     style: {
       textAlign: 'left'
@@ -839,73 +828,16 @@ var workDisplay = {
     }
 
     return ['option', atts, [imfl(['languages', lan.code])]];
-  })]]], ['div', [['button', {
-    title: l('bookmark_generation_tooltip'),
-    $on: {
-      async click() {
-        // Todo: Give option to edit (keywords and work URLs)
-        const date = Date.now();
-        const ADD_DATE = date;
-        const LAST_MODIFIED = date;
-        const blob = new Blob([new XMLSerializer().serializeToString(jamilih.jml({
-          $document: {
-            $DOCTYPE: {
-              name: 'NETSCAPE-Bookmark-file-1'
-            },
-            title: l('Bookmarks'),
-            body: [['h1', [l('Bookmarks_Menu')]], ...(await getFieldAliasOrNames()).flatMap(({
-              groupName,
-              worksToFields
-            }) => {
-              return [['dt', [['h3', {
-                ADD_DATE,
-                LAST_MODIFIED
-              }, [groupName]]]], ['dl', [['p'], ...worksToFields.map(({
-                fieldAliasOrNames,
-                workName,
-                shortcut: SHORTCUTURL
-              }) => {
-                // Todo (low): Add anchor, etc. (until handled by `work-startEnd`); &aqdas-anchor1-1=2&anchorfield1=Paragraph
-                // Todo: option for additional browse field groups (startEnd2, etc.)
-                // Todo: For link text, use `heading` or `alias` from metadata files in place of workName (requires loading all metadata files though)
-                // Todo: Make Chrome NativeExt add-on to manipulate its search engines (to read a bookmarks file from Firefox properly, i.e., including keywords) https://www.makeuseof.com/answers/export-google-chrome-search-engines-address-bar/
-                const paramsCopy = paramsSetter(_objectSpread2(_objectSpread2({}, getDataForSerializingParamsAsURL()), {}, {
-                  fieldAliasOrNames,
-                  workName: work,
-                  // Delete work of current page
-                  type: 'shortcutResult'
-                }));
-                const url = replaceHash(paramsCopy) + `&work=${workName}&${workName}-startEnd1=%s`; // %s will be escaped if set as param; also add changeable workName here
-
-                return ['dt', [['a', {
-                  href: url,
-                  ADD_DATE,
-                  LAST_MODIFIED,
-                  SHORTCUTURL
-                }, [workName]]]];
-              })]]];
-            })]
-          }
-        })).replace( // Chrome has a quirk that requires this (and not
-        //   just any whitespace)
-        // We're not getting the keywords with Chrome,
-        //   but at least usable for bookmarks (though
-        //   not the groups apparently)
-        /<dt>/g, '\n<dt>')], {
-          type: 'text/html'
-        });
-        const url = window.URL.createObjectURL(blob);
-        const a = jamilih.jml('a', {
-          hidden: true,
-          download: 'bookmarks.html',
-          href: url
-        }, jamilih.$('#main'));
-        a.click();
-        URL.revokeObjectURL(url);
-      }
-
-    }
-  }, [l('Generate_bookmarks')]]]]]],
+  })]]], preferencesPlugin ? preferencesPlugin({
+    $: jamilih.$,
+    l,
+    jml: jamilih.jml,
+    paramsSetter,
+    getDataForSerializingParamsAsURL,
+    work,
+    replaceHash,
+    getFieldAliasOrNames
+  }) : '']],
 
   addBrowseFields({
     browseFields,
@@ -1057,7 +989,8 @@ var workDisplay = {
     preferredLocale,
     schemaItems,
     content,
-    groups
+    groups,
+    preferencesPlugin
   }) {
     const work = $p.get('work');
 
@@ -1108,7 +1041,8 @@ var workDisplay = {
       localizeParamNames,
       namespace,
       groups,
-      hideFormattingSection
+      hideFormattingSection,
+      preferencesPlugin
     })]], ['h2', [heading]], ['br'], ['form', {
       id: 'browse',
       $custom: {
@@ -2182,7 +2116,12 @@ const getMetaProp = function getMetaProp(lang, metadataObj, properties, allowObj
 // Todo: Allow use of dbs and fileGroup together in base directories?
 
 const getMetadata = async (file, property, basePath) => {
-  return (await JsonRefs$1.resolveRefsAt((basePath || getCurrDir()) + file + (property ? '#/' + property : ''), {
+  const url = new URL(basePath || getCurrDir());
+  url.search = ''; // Clear out query string, e.g., `?fbclid` from Facebook
+
+  url.pathname = file;
+  url.hash = property ? '#/' + property : '';
+  return (await JsonRefs$1.resolveRefsAt(url.toString(), {
     loaderOptions: {
       processContent(res, callback) {
         callback(undefined, JSON.parse(res.text || // `.metadata` not a recognized extension, so

package/sw-sample.js

@@ -1,12 +1,11 @@
 /* eslint-env browser, serviceworker -- Service worker */
 
 import {getJSON} from './node_modules/simple-get-json/dist/index-es.js';
-import activateCallback from './node_modules/textbrowser/resources/activateCallback.js';
-import {getWorkFiles} from './node_modules/textbrowser/resources/utils/WorkInfo.js';
+import activateCallback from './node_modules/textbrowser/dist/activateCallback-es.js';
+import {getWorkFiles} from './node_modules/textbrowser/dist/WorkInfo-es.js';
 
-const CACHE_VERSION = '0.40.0';
 const CURRENT_CACHES = {
-  prefetch: 'prefetch-cache-v' + CACHE_VERSION
+  prefetch: 'prefetch-cache-v'
 };
 const minutes = 60 * 1000;
 
@@ -31,6 +30,7 @@ async function post ({type, message = type}) {
   clients.forEach((client) => {
     // Although we only need one client to which to send
     //   arguments, we want to signal phase complete to all
+    // eslint-disable-next-line unicorn/require-post-message-target-origin -- In worker
     client.postMessage({message, type});
   });
 }
@@ -50,7 +50,7 @@ function log (...messages) {
  *
  * @param {Error} error
  * @param {string[]} messages
-* @returns {Promise<void>}
+ * @returns {Promise<void>}
  */
 function logError (error, ...messages) {
   const message = messages.join(' ');
@@ -182,13 +182,15 @@ async function install (time) {
     namespace, languages, files, userStaticFiles
   } = getConfigDefaults(json);
 
-  console.log('opening cache', namespace + CURRENT_CACHES.prefetch);
+  const {version} = await getJSON('./package.json');
+
+  console.log('opening cache', namespace + CURRENT_CACHES.prefetch + version);
   const [
     cache,
     userDataFiles,
     {languages: langs}
   ] = await Promise.all([
-    caches.open(namespace + CURRENT_CACHES.prefetch),
+    caches.open(namespace + CURRENT_CACHES.prefetch + version),
     getWorkFiles(files),
     getJSON(languages)
   ]);
@@ -230,7 +232,7 @@ async function install (time) {
         return cache.put(urlToPrefetch, response);
       } catch (error) {
         logError(error, 'Not caching ' + urlToPrefetch + ' due to ' + error);
-        return Promise.reject(error);
+        throw error;
       }
     });
     await Promise.all(cachePromises);
@@ -263,8 +265,9 @@ async function activate (time) {
     caches.keys()
   ]);
   const {namespace, files, basePath} = getConfigDefaults(json);
+  const {version} = await getJSON('./package.json');
 
-  const expectedCacheNames = Object.values(CURRENT_CACHES).map((n) => namespace + n);
+  const expectedCacheNames = Object.values(CURRENT_CACHES).map((n) => namespace + n + version);
   cacheNames.map(async (cacheName) => {
     if (!expectedCacheNames.includes(cacheName)) {
       log('Activate: Deleting out of date cache:', cacheName);