textbrowser 0.40.0 → 0.41.0

package/dist/activateCallback-es.js

@@ -0,0 +1,158 @@
+/* eslint-env worker */
+
+const {ceil} = Math;
+const arrayChunk = (arr, size) => {
+  return [...Array.from({length: ceil(arr.length / size)})].map((_, i) => {
+    const offset = i * size;
+    return arr.slice(offset, offset + size);
+  });
+};
+
+// Todo: If fetching fails here (or in install), e.g., because activate event
+//          never completed
+//          to cache, de-register and re-register (?); how to detect if all
+//          files in cache?
+// Todo: Check `oldVersion` and run this first if still too old
+
+/**
+* @callback Logger
+* @param {...any} args
+* @returns {void}
+*/
+
+/**
+ * @param {PlainObject} cfg
+ * @param {string} cfg.namespace
+ * @param {string[]} cfg.files
+ * @param {Logger} cfg.log
+ * @param {string} [cfg.basePath=""]
+ * @returns {Promise<void>}
+ */
+async function activateCallback ({
+  namespace, files, log, basePath = ''
+}) {
+  // Now we know we have the files cached, we can postpone
+  //  the `indexedDB` processing (which will work offline
+  //  anyways); also important to avoid conflicts with
+  //  already-running versions upon future sw updates
+  log('Activate: Callback called');
+  const r = await fetch(files);
+  const {groups} = await r.json();
+
+  const addJSONFetch = (arr, path) => {
+    arr.push(
+      (async () => (await fetch(basePath + path)).json())()
+    );
+  };
+
+  const dataFileNames = [];
+  const dataFiles = [];
+  const schemaFiles = [];
+  const metadataFiles = [];
+  groups.forEach(
+    ({files: fileObjs, metadataBaseDirectory, schemaBaseDirectory}) => {
+      fileObjs.forEach(({file: {$ref: filePath}, metadataFile, schemaFile, name}) => {
+        // We don't i18nize the name here
+        dataFileNames.push(name);
+        addJSONFetch(dataFiles, filePath);
+        addJSONFetch(metadataFiles, metadataBaseDirectory + '/' + metadataFile);
+        addJSONFetch(schemaFiles, schemaBaseDirectory + '/' + schemaFile);
+      });
+    }
+  );
+  const promises = await Promise.all([
+    ...dataFiles, ...schemaFiles, ...metadataFiles
+  ]);
+  const chunked = arrayChunk(promises, dataFiles.length);
+  const [
+    dataFileResponses, schemaFileResponses, metadataFileResponses
+  ] = chunked;
+
+  log('Activate: Files fetched');
+  const dbName = namespace + '-textbrowser-cache-data';
+  indexedDB.deleteDatabase(dbName);
+  return new Promise((resolve, reject) => {
+    const req = indexedDB.open(dbName);
+    req.addEventListener('upgradeneeded', ({target: {result: db}}) => {
+      db.onversionchange = () => {
+        db.close();
+        const err = new Error('versionchange');
+        err.type = 'versionchange';
+        reject(err);
+      };
+      dataFileResponses.forEach(({data: tableRows}, i) => {
+        const dataFileName = dataFileNames[i];
+        const store = db.createObjectStore('files-to-cache-' + dataFileName);
+
+        const schemaFileResponse = schemaFileResponses[i];
+        const metadataFileResponse = metadataFileResponses[i];
+        const fieldItems = schemaFileResponse.items.items;
+
+        let browseFields = metadataFileResponse.table.browse_fields;
+        browseFields = Array.isArray(browseFields) ? browseFields : [browseFields];
+
+        const columnIndexes = [];
+        browseFields.forEach((browseFieldSetObj) => {
+          if (typeof browseFieldSetObj === 'string') {
+            browseFieldSetObj = {set: [browseFieldSetObj]};
+          }
+          if (!browseFieldSetObj.name) {
+            browseFieldSetObj.name = browseFieldSetObj.set.join(',');
+          }
+          const browseFieldSetName = browseFieldSetObj.name;
+          const browseFieldSetIndexes = browseFieldSetObj.set.map((browseField) => {
+            // Need to convert to columns for numbers
+            //      to become valid key paths
+            return 'c' + (
+              fieldItems.findIndex((item) => item.title === browseField)
+            );
+          });
+          columnIndexes.push(...browseFieldSetIndexes);
+
+          log(
+            'Activate: Creating index:',
+            dataFileName,
+            'browseFields-' + browseFieldSetName,
+            browseFieldSetIndexes
+          );
+
+          // No need for using `presort` as our index will sort anyways
+          store.createIndex(
+            'browseFields-' + browseFieldSetName,
+            browseFieldSetIndexes
+          );
+        });
+
+        const uniqueColumnIndexes = [...new Set(columnIndexes)];
+
+        tableRows.forEach((tableRow, j) => {
+          // Todo: Optionally send notice when complete
+          // To take advantage of indexes on our arrays, we
+          //   need to transform them to objects! See https://github.com/w3c/IndexedDB/issues/209
+          const objRow = {
+            value: tableRow
+          };
+          uniqueColumnIndexes.forEach((colIdx) => {
+            objRow[colIdx] = tableRow[colIdx.slice(1)];
+          });
+          // log('objRow', objRow);
+          store.put(objRow, j);
+        });
+      });
+    });
+    req.addEventListener('success', ({target: {result: db}}) => {
+      log('Activate: Database set-up complete', db);
+      // Todo: Replace this with `ready()` check
+      //   in calling code?
+      resolve();
+    });
+    const onerr = ({error = new Error('dbError')}) => {
+      error.type = 'dbError';
+      reject(error);
+    };
+    req.addEventListener('blocked', onerr);
+    req.addEventListener('error', onerr);
+  });
+}
+
+export { activateCallback as default };

package/dist/index-es.js

@@ -3,14 +3,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;
@@ -18,19 +13,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;
@@ -1485,15 +1473,15 @@ var number = createCommonjsModule(function (module, exports) {
         result.maximumSignificantDigits = g1.length;
       } // @@@+ case
       else if (g2 === '+') {
-          result.minimumSignificantDigits = g1.length;
-        } // .### case
-        else if (g1[0] === '#') {
-            result.maximumSignificantDigits = g1.length;
-          } // .@@## or .@@@ case
-          else {
-              result.minimumSignificantDigits = g1.length;
-              result.maximumSignificantDigits = g1.length + (typeof g2 === 'string' ? g2.length : 0);
-            }
+        result.minimumSignificantDigits = g1.length;
+      } // .### case
+      else if (g1[0] === '#') {
+        result.maximumSignificantDigits = g1.length;
+      } // .@@## or .@@@ case
+      else {
+        result.minimumSignificantDigits = g1.length;
+        result.maximumSignificantDigits = g1.length + (typeof g2 === 'string' ? g2.length : 0);
+      }
 
       return '';
     });
@@ -1733,15 +1721,15 @@ var number = createCommonjsModule(function (module, exports) {
             result.minimumFractionDigits = g1.length;
           } // .### case
           else if (g3 && g3[0] === '#') {
-              result.maximumFractionDigits = g3.length;
-            } // .00## case
-            else if (g4 && g5) {
-                result.minimumFractionDigits = g4.length;
-                result.maximumFractionDigits = g4.length + g5.length;
-              } else {
-                result.minimumFractionDigits = g1.length;
-                result.maximumFractionDigits = g1.length;
-              }
+            result.maximumFractionDigits = g3.length;
+          } // .00## case
+          else if (g4 && g5) {
+            result.minimumFractionDigits = g4.length;
+            result.maximumFractionDigits = g4.length + g5.length;
+          } else {
+            result.minimumFractionDigits = g1.length;
+            result.maximumFractionDigits = g1.length;
+          }
 
           return '';
         });
@@ -1966,14 +1954,14 @@ var parser = createCommonjsModule(function (module, exports) {
         if (char === 123
         /* `{` */
         ) {
-            var result = this.parseArgument(nestingLevel, expectingCloseTag);
+          var result = this.parseArgument(nestingLevel, expectingCloseTag);
 
-            if (result.err) {
-              return result;
-            }
+          if (result.err) {
+            return result;
+          }
 
-            elements.push(result.val);
-          } else if (char === 125
+          elements.push(result.val);
+        } else if (char === 125
         /* `}` */
         && nestingLevel > 0) {
           break;
@@ -1990,12 +1978,12 @@ var parser = createCommonjsModule(function (module, exports) {
         /* `<` */
         && !this.ignoreTag && this.peek() === 47 // char code for '/'
         ) {
-            if (expectingCloseTag) {
-              break;
-            } else {
-              return this.error(error.ErrorKind.UNMATCHED_CLOSING_TAG, createLocation(this.clonePosition(), this.clonePosition()));
-            }
-          } else if (char === 60
+          if (expectingCloseTag) {
+            break;
+          } else {
+            return this.error(error.ErrorKind.UNMATCHED_CLOSING_TAG, createLocation(this.clonePosition(), this.clonePosition()));
+          }
+        } else if (char === 60
         /* `<` */
         && !this.ignoreTag && _isAlpha(this.peek() || 0)) {
           var result = this.parseTag(nestingLevel, parentArgType);
@@ -2180,8 +2168,8 @@ var parser = createCommonjsModule(function (module, exports) {
       if (this.isEOF() || this.char() !== 39
       /* `'` */
       ) {
-          return null;
-        } // Parse escaped char following the apostrophe, or early return if there is no escaped char.
+        return null;
+      } // Parse escaped char following the apostrophe, or early return if there is no escaped char.
       // Check if is valid escaped character
 
 
@@ -2225,18 +2213,18 @@ var parser = createCommonjsModule(function (module, exports) {
         if (ch === 39
         /* `'` */
         ) {
-            if (this.peek() === 39
-            /* `'` */
-            ) {
-                codePoints.push(39); // Bump one more time because we need to skip 2 characters.
+          if (this.peek() === 39
+          /* `'` */
+          ) {
+            codePoints.push(39); // Bump one more time because we need to skip 2 characters.
 
-                this.bump();
-              } else {
-              // Optional closing apostrophe.
-              this.bump();
-              break;
-            }
+            this.bump();
           } else {
+            // Optional closing apostrophe.
+            this.bump();
+            break;
+          }
+        } else {
           codePoints.push(ch);
         }
 
@@ -2282,9 +2270,9 @@ var parser = createCommonjsModule(function (module, exports) {
       if (this.char() === 125
       /* `}` */
       ) {
-          this.bump();
-          return this.error(error.ErrorKind.EMPTY_ARGUMENT, createLocation(openingBracePosition, this.clonePosition()));
-        } // argument name
+        this.bump();
+        return this.error(error.ErrorKind.EMPTY_ARGUMENT, createLocation(openingBracePosition, this.clonePosition()));
+      } // argument name
 
 
       var value = this.parseIdentifierIfPossible().value;
@@ -2563,8 +2551,8 @@ var parser = createCommonjsModule(function (module, exports) {
       if (this.isEOF() || this.char() !== 125
       /* `}` */
       ) {
-          return this.error(error.ErrorKind.EXPECT_ARGUMENT_CLOSING_BRACE, createLocation(openingBracePosition, this.clonePosition()));
-        }
+        return this.error(error.ErrorKind.EXPECT_ARGUMENT_CLOSING_BRACE, createLocation(openingBracePosition, this.clonePosition()));
+      }
 
       this.bump(); // `}`
 
@@ -2774,10 +2762,10 @@ var parser = createCommonjsModule(function (module, exports) {
         && ch <= 57
         /* `9` */
         ) {
-            hasDigits = true;
-            decimal = decimal * 10 + (ch - 48);
-            this.bump();
-          } else {
+          hasDigits = true;
+          decimal = decimal * 10 + (ch - 48);
+          this.bump();
+        } else {
           break;
         }
       }
@@ -2861,10 +2849,10 @@ var parser = createCommonjsModule(function (module, exports) {
       if (code === 10
       /* '\n' */
       ) {
-          this.position.line += 1;
-          this.position.column = 1;
-          this.position.offset += 1;
-        } else {
+        this.position.line += 1;
+        this.position.column = 1;
+        this.position.offset += 1;
+      } else {
         this.position.column += 1; // 0 ~ 0x10000 -> unicode BMP, otherwise skip the surrogate pair.
 
         this.position.offset += code < 0x10000 ? 1 : 2;
@@ -15179,7 +15167,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.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.resolveRefsAt(url.toString(), {
     loaderOptions: {
       processContent(res, callback) {
         callback(undefined, JSON.parse(res.text || // `.metadata` not a recognized extension, so
@@ -16604,7 +16597,8 @@ var workDisplay$1 = {
     localizeParamNames,
     namespace,
     hideFormattingSection,
-    groups
+    groups,
+    preferencesPlugin
   }) => ['div', {
     style: {
       textAlign: 'left'
@@ -16671,73 +16665,16 @@ var workDisplay$1 = {
     }
 
     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(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 = jml('a', {
-          hidden: true,
-          download: 'bookmarks.html',
-          href: url
-        }, $$1('#main'));
-        a.click();
-        URL.revokeObjectURL(url);
-      }
-
-    }
-  }, [l('Generate_bookmarks')]]]]]],
+  })]]], preferencesPlugin ? preferencesPlugin({
+    $: $$1,
+    l,
+    jml,
+    paramsSetter,
+    getDataForSerializingParamsAsURL,
+    work,
+    replaceHash,
+    getFieldAliasOrNames
+  }) : '']],
 
   addBrowseFields({
     browseFields,
@@ -16889,7 +16826,8 @@ var workDisplay$1 = {
     preferredLocale,
     schemaItems,
     content,
-    groups
+    groups,
+    preferencesPlugin
   }) {
     const work = $p.get('work');
 
@@ -16940,7 +16878,8 @@ var workDisplay$1 = {
       localizeParamNames,
       namespace,
       groups,
-      hideFormattingSection
+      hideFormattingSection,
+      preferencesPlugin
     })]], ['h2', [heading]], ['br'], ['form', {
       id: 'browse',
       $custom: {
@@ -17947,6 +17886,9 @@ async function workDisplay({
   fallbackLanguages,
   $p
 }) {
+  const {
+    preferencesPlugin
+  } = this;
   const langs = this.langData.languages;
   const fallbackDirection = this.getDirectionForLanguageCode(fallbackLanguages[0]);
   const prefI18n = localStorage.getItem(this.namespace + '-localizeParamNames');
@@ -17966,8 +17908,7 @@ async function workDisplay({
     groupsToWorks
   }) {
     const il = localizeParamNames ? key => l(['params', key]) : key => key;
-    const iil = localizeParamNames ? key => l(['params', 'indexed', key]) : key => key; // eslint-disable-next-line unicorn/prefer-prototype-methods -- Convenient
-
+    const iil = localizeParamNames ? key => l(['params', 'indexed', key]) : key => key;
     const localeFromLangData = languages.localeFromLangData.bind(languages);
     const imfLang = IMF({
       locales: lang.map(localeFromLangData),
@@ -18114,7 +18055,8 @@ async function workDisplay({
       fieldMatchesLocale,
       preferredLocale,
       schemaItems,
-      content
+      content,
+      preferencesPlugin
     });
   }
 
@@ -18307,6 +18249,8 @@ Object.defineProperty(self$1, '_BIDI_RTL_LANGS', {
   /* 'فارسی', Persian */
   'glk',
   /* 'گیلکی', Gilaki */
+  'he',
+  /* 'עברית', Hebrew */
   'ku',
   /* 'Kurdî / كوردی', Kurdish */
   'mzn',
@@ -18321,8 +18265,10 @@ Object.defineProperty(self$1, '_BIDI_RTL_LANGS', {
   /* 'سنڌي', Sindhi */
   'ug',
   /* 'Uyghurche / ئۇيغۇرچە', Uyghur */
-  'ur'
+  'ur',
   /* 'اردو', Urdu */
+  'yi'
+  /* 'ייִדיש', Yiddish */
   ],
   writable: false,
   enumerable: true,
@@ -18384,8 +18330,8 @@ const setAnchor = ({
           if (i === max || // No more field sets to check
           anchors.length // Already had anchors found
           ) {
-              breakout = true;
-            }
+            breakout = true;
+          }
 
           break;
         }
@@ -19436,7 +19382,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();
@@ -19492,6 +19438,7 @@ class TextBrowser {
     this.requestPersistentStorage = options.requestPersistentStorage;
     this.localizeParamNames = options.localizeParamNames === undefined ? 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;
@@ -19863,7 +19810,8 @@ class TextBrowser {
           fallbackLanguages,
           languageParam,
           $p,
-          languages
+          languages,
+          preferencesPlugin: this.preferencesPlugin
         });
         return true;
       }
@@ -19900,4 +19848,4 @@ TextBrowser.prototype.workDisplay = workDisplay;
 TextBrowser.prototype.resultsDisplayClient = resultsDisplayClient;
 TextBrowser.prototype.getWorkFiles = getWorkFiles;
 
-export default TextBrowser;
+export { TextBrowser as default };